SSR(1)

📦 version 0.6.1, in arch rolling

✨ SSR(1) — the manual page, but make it cute ✨

okay bestie, gather round, because this is the SoundScape Renderer manual page (that's the User Commands one, section 1, iykyk) and we're about to make spatial audio make sense. 💖

🌸 NAME 🌸

SSR — the manual page for the AAP renderer. that's it, that's the name, short and iconic. 💅

🎀 SYNOPSIS 🎀

ssr-aap [OPTIONS] <scene-file>

so you run ssr-aap, you throw some OPTIONS at it if you're feeling spicy, and you hand it a <scene-file>. that's the whole ritual. 🦋

🌈 DESCRIPTION 🌈

The SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction, and it provides a whole variety of rendering algorithms. basically: it makes sound go places in space, live, as it happens. main character energy fr fr. 👑

✨ OPTIONS ✨

🍓 Renderer-specific options:

  • --hrirs=FILE — load HRIRs for the binaural renderer from FILE. yes, HRIRs, the binaural besties. 🎧
  • --hrir-size=N — truncate those HRIRs to length N. snip snip. ✂️
  • --prefilter=FILE — load the WFS prefilter from FILE. give the wave field synthesis its lil pre-game. 💜
  • -o, --ambisonics-order=VALUE — the ambisonics order to use for AAP. default is maximum, because why not go all the way. 🔥
  • --in-phase-rendering — use in-phase rendering for the AAP renderer. phase-aligned, as it should be. ✨

🧚 JACK options:

  • -n, --name=NAME — set the JACK client name to NAME. name your baby. 🍼
  • --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. zoom zoom, no clock, we're vibing. 🏎️

⭐ 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. let the machine decide, trust. 🤖
  • -r, --record=FILE — record the audio output of the renderer to FILE. capture the moment, bestie. ⏺️
  • --decay-exponent=VALUE — exponent that determines the amplitude decay. default: 1.
⚠️ heads up: this one is disabled at compile time! 💀
  • --loop — loop all audio files. all of them. on repeat. 🔁
  • --master-volume-correction=VALUE — correction of the master volume in dB. default: 0 dB. 🎚️
  • --auto-rotation — auto-rotate sound sources' orientation toward the reference. spinny spinny. 🌀
  • --no-auto-rotation — don't auto-rotate sound sources' orientation toward the reference. no spinny spinny. 🚫
  • -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. friendship era. 🫶
  • --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 the 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. we love a helpful king. 👑
  • -v, --verbose — increase the verbosity level (up to -vvv). more words, more truth. 🗣️
  • -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 🖼️

🐛 REPORTING BUGS 🐛

ngl if you find a bug, tell them, they wanna know, no gatekeeping. 🫶

  • 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. fr fr, read the fine print bestie. 💀

and that's the whole page, slay. this was SoundScape Renderer version 0.6.1, from July 2023, and yeah the manual page is literally called SSR(1). periodt. 💅✨

📦 where this page comes from