SSR(1)

📦 version 0.6.1, in arch rolling

💖 SSR — the manual page for the DCA renderer 💖

okay bestie, so you found yourself a page from User Commands (section 1, obvs) and it's about SSR, aka the DCA renderer. buckle up, this is gonna be fun. 🦋

✨ SYNOPSIS ✨

ssr-dca [OPTIONS] <scene-file>

like, that's the whole vibe. options, then a scene file, and then the magic happens. periodt. 💅

🌸 DESCRIPTION 🌸

So the SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction, and it comes with a whole variety of rendering algorithms. it's giving "audio wizardry but make it open source". no cap. ✨

👑 OPTIONS 👑

🎀 Renderer-specific options

these are the ones that make the renderer do renderer things. very main character.

  • --hrirs=FILE — load HRIRs for the binaural renderer from FILE. yes, it wants a file. give it the file. 🍓
  • --hrir-size=N — truncate those HRIRs down to length N. snip snip ✂️
  • --prefilter=FILE — load the WFS prefilter from FILE.
  • -o, --ambisonics-order=VALUE — which ambisonics order should we use for AAP? defaults to the maximum, because why not go big. 🔥
  • --in-phase-rendering — use in-phase rendering for the AAP renderer. iconic behaviour honestly.

🌈 JACK options

talking to JACK, as one does.

  • -n, --name=NAME — set the JACK client name to NAME. name your child. 💜
  • --input-prefix=PREFIX — input port prefix. default is "system:capture_".
  • --output-prefix=PREFIX — output port prefix. default is "system:playback_".
  • -f, --freewheel — use JACK in freewheeling mode. weeeee 🎢

⭐ General options

the everything-else section. so many options. obsessed.

  • -c, --config=FILE — read configuration from FILE.
  • -s, --setup=FILE — load the reproduction setup from FILE.
  • --threads=N — number of audio threads. default is auto, so it just figures it out itself. queen behaviour. 👑
  • -r, --record=FILE — record the audio output of the renderer to FILE.
  • --decay-exponent=VALUE — exponent that determines the amplitude decay. default is 1.
⚠️ heads up bestie: this one is disabled at compile time! so like, don't get your hopes up. 💀
  • --loop — loop all audio files. round and round and round. 🔁
  • --master-volume-correction=VALUE — correction of the master volume in dB. default is 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. (the hater option, we love her) 🙈
  • -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. this is the default.
  • --fudi-server — start the FUDI server.
⚠️ not enabled at compile time!
  • --no-fudi-server — don't start the FUDI server. this is the default.
  • --follow — wait for another SSR instance to connect. it's giving loyal. 🫶
  • --no-follow — don't follow another SSR instance. this is the default.
  • -g, --gui — start the GUI.
⚠️ not enabled at compile time!
  • -G, --no-gui — don't start the GUI. this is the default.
  • -t, --tracker=TYPE — select a head tracker. possible value(s): fastrak, patriot, razor. pick your fighter. 🥊
  • --tracker-port=PORT — port name/number of the head tracker, e.g. /dev/ttyS1.
  • -T, --no-tracker — don't use a head tracker. this is the default.
  • -h, --help — show help and exit. (hi, then bye 👋)
  • -v, --verbose — increase verbosity level. you can go up to -vvv, so like, maximum yapping. 🗣️
  • -V, --version — show version information and exit.

🧚 AUTHOR 🧚

all the legends who made this happen. give them their flowers. 💐

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

🐛 REPORTING BUGS 🐛

found a bug? spill. do NOT keep it to yourself, that's not the vibe. 🫶

the legal bit, but make it cute. (still legal tho, so read it fr fr)

  • 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. like, none. zero. nada. 😭

and that's the whole page bestie!! this was SoundScape Renderer 0.6.1, dated July 2023, and it lives in section SSR(1) of the manual. slay, go render some spatial audio, you got this 💅✨🎀

📦 where this page comes from