SSR(1)

📦 version 0.6.1, in arch rolling

✨ SSR(1) — the WFS renderer glow-up ✨

okay so bestie, welcome to the manual page for SSR, from the User Commands section of your friendly neighbourhood manual. she's giving real-time spatial audio, she's giving renderer energy, and she's about to be explained to you line by line. no skipping, no skimming, we're doing this properly 💅

🦋 NAME

SSR — the manual page for the WFS renderer 🎀

🌸 SYNOPSIS

ssr-wfs [OPTIONS] <scene-file>

like. that's it. that's the whole vibe. you give her options and a scene file and she goes ✨

💖 DESCRIPTION

The SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction, and she provides a whole variety of rendering algorithms. yes queen, plural algorithms, she contains multitudes 💜

✨ OPTIONS ✨

okay this is the long part but stay with me, every single one matters, no cap.

🎧 Renderer-specific options

  • --hrirs=FILE — Load HRIRs for the binaural renderer from FILE. headphone girlies rise 🎀
  • --hrir-size=N — Truncate those HRIRs to length N. snip snip ✂️
  • --prefilter=FILE — Load the WFS prefilter from FILE.
  • -o, --ambisonics-order=VALUE — the Ambisonics order to use for AAP (default: maximum). like, the max, obviously.
  • --in-phase-rendering — Use in-phase rendering for the AAP renderer. in phase, in sync, in her main character era 🫶

🔊 JACK options

  • -n, --name=NAME — Set the JACK client name to NAME.
  • --input-prefix=PREFIX — Input port prefix (default: "system:capture_").
  • --output-prefix=PREFIX — Output port prefix (default: "system:playback_").
  • -f, --freewheel — Use JACK in freewheeling mode. wheels off, vibes on 🔥

💫 General options

  • -c, --config=FILE — Read configuration from FILE.
  • -s, --setup=FILE — Load the reproduction setup from FILE.
  • --threads=N — Number of audio threads (default: auto).
  • -r, --record=FILE — Record the audio output of the renderer to FILE.
  • --decay-exponent=VALUE — Exponent that determines the amplitude decay (default: 1). ⚠️ disabled at compile time! so like, don't get attached.
  • --loop — Loop all audio files. forever and ever and ever 🔁
  • --master-volume-correction=VALUE — Correction of the master volume in dB (default: 0 dB).
  • --auto-rotation — Auto-rotate sound sources' orientation toward the reference.
  • --no-auto-rotation — Don't auto-rotate sound sources' orientation toward the reference.
  • -i, --ip-server — Start the IP server. (not enabled at compile time!)
  • -I, --no-ip-server — Don't start the IP server (this is the default).
  • --websocket-server — Start the WebSocket server. (not enabled at compile time!)
  • --no-websocket-server — Don't start the WebSocket server (default).
  • --fudi-server — Start the FUDI server. (not enabled at compile time!)
  • --no-fudi-server — Don't start the FUDI server (default).
  • --follow — Wait for another SSR instance to connect. bestie behaviour fr fr 🫶
  • --no-follow — Don't follow another SSR instance (default).
  • -g, --gui — Start the GUI. (not enabled at compile time!)
  • -G, --no-gui — Don't start the GUI (default).
  • -t, --tracker=TYPE — Select the head tracker. possible value(s): fastrak patriot razor
  • --tracker-port=PORT — Port name/number of the head tracker, e.g. /dev/ttyS1
  • -T, --no-tracker — Don't use a head tracker (default).
  • -h, --help — Show help and exit. she's helping 🥺
  • -v, --verbose — Increase verbosity level (up to -vvv). the way you can just keep adding v's... iconic.
  • -V, --version — Show version information and exit.

👑 AUTHOR

Written by:

  • Matthias Geier, Jens Ahrens

Scientific supervision:

  • Sascha Spors

Contributions by:

  • Peter Bartz, Florian Hinterleitner, Torben Hohn, Christoph Hohnerlein, Christoph Hold, Lukas Kaser, André Möhl, Till Rettberg, David Runge, Fiete Winter, IOhannes m zmölnig

GUI design:

  • Katharina Bredies, Jonas Loh, Jens Ahrens

Logo design:

  • Fabian Hemmert

look at that roster. a whole squad. the avengers of spatial audio 💜

🐛 REPORTING BUGS

found a bug? don't be shy, tell the girlies:

  • Copyright © 2016 Division of Applied Acoustics, Chalmers University of Technology
  • Copyright © 2014 Institut für Nachrichtentechnik, Universität Rostock
  • Copyright © 2012 Quality & Usability Lab, Telekom Innovation Laboratories, TU Berlin

License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it.

There is NO WARRANTY, to the extent permitted by law. read it and weep bestie, she said what she said 💀

and that's the whole page!! this was SoundScape Renderer 0.6.1, brought to you by July 2023, and you just read the entire SSR(1) manual like the absolute legend you are. go render something spatial. mwah 🫶💖✨

📦 where this page comes from