SSR(1)

📦 version 0.6.1, in arch rolling

💖 SSR(1) — the manual page for the generic renderer, bestie edition 💖

okay so you opened the manual for SSR (that's the User Commands section of the manual, btw, page 1, we love a section 1) and honestly? you're about to have the best time. sit down, hydrate, let's go 🫶

✨ NAME ✨

SSR — the manual page for the generic renderer. that's it, that's the name, she's simple and she serves 💅

🌸 SYNOPSIS 🌸

ssr-generic [OPTIONS] <scene-file>

like. give her options and a scene file. she'll handle the rest, no cap ✨

🦋 DESCRIPTION 🦋

okay so the SoundScape Renderer (SSR, that's her government name) is a tool for real-time spatial audio reproduction, and she provides a whole variety of rendering algorithms. it's giving main character energy for your ears, fr fr 🌈

💅 OPTIONS 💅

🎀 Renderer-specific options:

  • --hrirs=FILE — load HRIRs for the binaural renderer from FILE. binaural bestie behaviour 🎧
  • --hrir-size=N — truncate those HRIRs to length N. snip snip ✂️
  • --prefilter=FILE — load the WFS prefilter from FILE. very prefiltered of you.
  • -o, --ambisonics-order=VALUE — ambisonics order to use for AAP. default is maximum, because she's an overachiever 💫
  • --in-phase-rendering — use in-phase rendering for the AAP renderer. phase? in. iconic.

🧚 JACK options:

  • -n, --name=NAME — set the JACK client name to NAME. name your child 👶
  • --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. wheeeee 🎡

⭐ General options:

  • -c, --config=FILE — read configuration from FILE. config bestie 📄
  • -s, --setup=FILE — load the reproduction setup from FILE. set the stage, periodt 🎭
  • --threads=N — number of audio threads. default: auto, because she's mysterious like that 🧵
  • -r, --record=FILE — record the audio output of the renderer to FILE. yes bestie, we're filming this 📹
  • --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. forever and ever and ever 🔁
  • --master-volume-correction=VALUE — correction of the master volume in dB. default: 0 dB. volume? corrected. 💅
  • --auto-rotation — auto-rotate sound sources' orientation toward the reference. she's turning, she's looking at you 👀
  • --no-auto-rotation — don't auto-rotate sound sources' orientation toward the reference. she's minding her business 🙈
  • -i, --ip-server — start IP server. > ⚠️ not enabled at compile time! 😭
  • -I, --no-ip-server — don't start IP server. this is the default ✅
  • --websocket-server — start WebSocket server. > ⚠️ not enabled at compile time! 😭
  • --no-websocket-server — don't start WebSocket server. default ✅
  • --fudi-server — start FUDI server. > ⚠️ not enabled at compile time! 😭
  • --no-fudi-server — don't start FUDI server. default ✅
  • --follow — wait for another SSR instance to connect. bestie where are you 👯
  • --no-follow — don't follow another SSR instance. default ✅
  • -g, --gui — start GUI. > ⚠️ not enabled at compile time! 😭
  • -G, --no-gui — don't start GUI. default ✅
  • -t, --tracker=TYPE — select head tracker. possible value(s): fastrak patriot razor 🧭
  • --tracker-port=PORT — port name/number of head tracker, e.g. /dev/ttyS1 🔌
  • -T, --no-tracker — don't use a head tracker. default ✅
  • -h, --help — show help and exit. we love a lil help 🙋
  • -v, --verbose — increase verbosity level (up to -vvv). she's talkative, and honestly? same 🗣️
  • -V, --version — show version information and exit. tell me who you are 💌

👑 AUTHOR 👑

okay so the whole cast list, because everyone ate:

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 something cursed? tell the devs, they wanna know:

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, no warranty bestie 🫶)

and that's the whole page!! this was SoundScape Renderer 0.6.1, dated July 2023, and she's still that girl. mwah 💋✨

📦 where this page comes from