SSR(1) User Commands SSR(1)

SSR - manual page for the binaural renderer

ssr-binaural [OPTIONS] <scene-file>

The SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction providing a variety of rendering algorithms.

Load HRIRs for binaural renderer from FILE
Truncate HRIRs to length N
Load WFS prefilter from FILE
-o, --ambisonics-order=VALUE
Ambisonics order to use for AAP (default: maximum)
Use in-phase rendering for AAP renderer

-n, --name=NAME
Set JACK client name to NAME
Input port prefix (default: "system:capture_")
Output port prefix (default: "system:playback_")
-f, --freewheel
Use JACK in freewheeling mode

-c, --config=FILE
Read configuration from FILE
-s, --setup=FILE
Load reproduction setup from FILE
Number of audio threads (default: auto)
-r, --record=FILE
Record the audio output of the renderer to FILE
Exponent that determines the amplitude decay (default: 1)
Loop all audio files
Correction of the master volume in dB (default: 0 dB)

--auto-rotation Auto-rotate sound sources' orientation toward the reference

Don't auto-rotate sound sources' orientation toward the reference
-i, --ip-server[=PORT]
Start IP server (default on), a port number can be specified (default 4711)
-I, --no-ip-server
Don't start IP server
ASCII code for character to end messages with (default 0 = binary zero)
-g, --gui
Start GUI (default)
-G, --no-gui
Don't start GUI
-t, --tracker=TYPE
Select head tracker, possible value(s): fastrak patriot vrpn razor
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

Matthias Geier, Jens Ahrens

Sascha Spors

Peter Bartz, Florian Hinterleitner, Torben Hohn, Christoph Hohnerlein, Christoph Hold, Lukas Kaser, André Möhl, Till Rettberg, David Runge, Fiete Winter

Katharina Bredies, Jonas Loh, Jens Ahrens

Fabian Hemmert

Report bugs to: <>
SSR home page:

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
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

November 2018 SSR (SoundScape Renderer) 0.5.0