SSR(1)

📦
version 0.6.1 · 3 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 SSR(1) — the binaural renderer, bestie edition 💖

okay so this is the manual page for SSR, and it lives in section 1 of the manual (User Commands, iykyk). it's basically the group chat of spatial audio. let's go 🎀

✨ NAME ✨

SSR — manual page for the binaural renderer 🦋

✨ SYNOPSIS ✨

ssr-binaural [OPTIONS] <scene-file>

✨ DESCRIPTION ✨

so the SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction that ships with a whole variety of rendering algorithms. it's giving main character energy for your ears, no cap 💅

✨ OPTIONS ✨

🎧 Renderer-specific options:

  • --hrirs=FILE — load HRIRs for the binaural renderer from FILE 💖
  • --hrir-size=N — truncate those HRIRs down to length N
  • --prefilter=FILE — load the WFS prefilter from FILE
  • -o, --ambisonics-order=VALUE — the ambisonics order to use for AAP (default: maximum, because why not go all in ✨)
  • --in-phase-rendering — use in-phase rendering for the AAP renderer

🔊 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 🔥

⚙️ General options:

  • -c, --config=FILE — read configuration from FILE
  • -s, --setup=FILE — load 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!) 😭
  • --loop — loop all audio files 🔁
  • --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 IP server (not enabled at compile time!) 💀
  • -I, --no-ip-server — don't start IP server (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 🫶
  • --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 👋
  • -v, --verbose — increase verbosity level (up to -vvv)
  • -V, --version — show version information and exit
not me clocking that a bunch of these are literally disabled or not enabled at compile time. if you try them and nothing happens, that's why, bestie — it's not you, it's the build 😭

👑 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 🐛

found a bug? spill 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.

no warranty bestie, we said what we said 💅

and that's the whole thing! this page is from SoundScape Renderer 0.6.1, dated July 2023, and it's the SSR(1) manual page for the binaural renderer. slay, go render something gorgeous ✨🎀🦋

📦 where this page comes from