ssr-binaural.nox1
Manual page for the binaural renderer
Usage
ssr-binaural [OPTIONS]
<scene-file>
Overview
The SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction providing a variety of rendering algorithms.
Options
Renderer-specific options:
-
--hrirs=FILE -
Load HRIRs for binaural renderer from FILE
-
--hrir-size=N -
Truncate HRIRs to length N
-
--prefilter=FILE -
Load WFS prefilter from FILE
-
-o, --ambisonics-order=VALUE -
Ambisonics order to use for AAP (default: maximum)
-
--in-phase-rendering -
Use in-phase rendering for AAP renderer
JACK options:
-
-n, --name=NAME -
Set 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-rotationAuto-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
History
- Debian 13 (Trixie): the text shown here
- Debian 12 (Bookworm)
- Debian 11 (Bullseye)
- Debian 10 (Buster)
- Debian 9 (Stretch)
- Debian 8 (Jessie)
--decay-exponent since Debian 10 (Buster);
--follow since Debian 12 (Bookworm);
--fudi-server since Debian 12 (Bookworm);
--no-auto-rotation since Debian 10 (Buster);
--no-follow since Debian 12 (Bookworm);
--no-fudi-server since Debian 12 (Bookworm);
--no-websocket-server since Debian 12 (Bookworm);
--websocket-server since Debian 12 (Bookworm).
--end-of-message-character until Debian 11 (Bullseye).