SSR(1)

📦 version 0.6.1, in arch rolling

✨ SSR — bestie edition ✨

okay so this is the SSR(1) manual page, from the User Commands section of the manual, and yes we are doing this together, grab a snack 🍓

💖 NAME 💖

SSR — the manual page for the VBAP renderer 🎀

🌸 SYNOPSIS 🌸

ssr-vbap [OPTIONS] <scene-file>

🦋 DESCRIPTION 🦋

The SoundScape Renderer (aka SSR) is a tool for real-time spatial audio reproduction, and it comes with a whole variety of rendering algorithms. it's giving audio girlboss, fr fr 💅

👑 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 — like, the most) ⭐
  • --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 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!) 💀
  • --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 ℹ️

🫶 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

the whole squad ate, no cap 👑

🐛 REPORTING BUGS 🐛

  • 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. 😭 yeah bestie they really said no warranty, read it and weep

and that's the whole page!! this was SoundScape Renderer 0.6.1, from July 2023, filed under SSR(1) — mwah, iconic, periodt 💜✨🎀

📦 where this page comes from