SSR(1)

📦 version 0.6.1, in arch rolling

✨ SSR(1) — the manual page for the BRS renderer ✨

okay bestie, sit down, hydrate, and let me tell you about SSR — short for the SoundScape Renderer, and yes she's a User Commands girlie in section 1 💅

🎀 NAME 🎀

SSR — manual page for the BRS renderer. that's it, that's the name, no notes 🫶

🌸 SYNOPSIS 🌸

ssr-brs [OPTIONS] <scene-file>

so like, options first, then the scene file. the scene file is not optional, she's the main character 💖

🦋 DESCRIPTION 🦋

The SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction, and she provides a whole variety of rendering algorithms. it's giving audio science, it's giving spatialized excellence, it's giving "how did they do that" ✨

💅 OPTIONS 💅

🔥 Renderer-specific options:

  • --hrirs=FILE — Load HRIRs for the binaural renderer from FILE. binaural bestie behavior fr fr
  • --hrir-size=N — Truncate HRIRs to length N. cutting them off at exactly N, no cap
  • --prefilter=FILE — Load the WFS prefilter from FILE
  • -o, --ambisonics-order=VALUE — Ambisonics order to use for AAP (default: maximum). default is literally "go as high as you can" 👑
  • --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. zoom zoom 🏎️

⭐ 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). she just knows
  • -r, --record=FILE — Record the audio output of the renderer to FILE
  • --decay-exponent=VALUE — Exponent that determines the amplitude decay (default: 1). > ⚠️ heads up: this one is disabled at compile time! so she might just... not be there 😭
  • --loop — Loop all audio files. infinite vibes, periodt
  • --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 (this is the default)
  • --websocket-server — Start WebSocket server. > ⚠️ not enabled at compile time!
  • --no-websocket-server — Don't start WebSocket server (this is the default)
  • --fudi-server — Start FUDI server. > ⚠️ not enabled at compile time!
  • --no-fudi-server — Don't start FUDI server (this is the default)
  • --follow — Wait for another SSR instance to connect. friend-shaped 🫶
  • --no-follow — Don't follow another SSR instance (this is the default)
  • -g, --gui — Start GUI. > ⚠️ not enabled at compile time!
  • -G, --no-gui — Don't start GUI (this is the 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 (this is the default)
  • -h, --help — Show help and exit. our saving grace honestly 🙈
  • -v, --verbose — Increase verbosity level (up to -vvv). stack them like bracelets ✨
  • -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 😭

found something cursed? tell the girlies:

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.

⚠️ not even kidding on that NO WARRANTY part — she said what she said 💀

and that's the whole page bestie!! this is SoundScape Renderer 0.6.1, dated July 2023, living her best life in section SSR(1) of the manual 💖✨ go make something sound spatially gorgeous, mwah 🎀🦋

📦 where this page comes from