.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH SSR "1" "July 2023" "SoundScape Renderer 0.6.1" "User Commands"
.SH NAME
SSR \- manual page for the AAP renderer
.SH SYNOPSIS
.B ssr-aap
[\fI\,OPTIONS\/\fR] \fI\,<scene-file>\/\fR
.SH DESCRIPTION
The SoundScape Renderer (SSR) is a tool for real\-time spatial audio reproduction
providing a variety of rendering algorithms.
.SH OPTIONS
.SS "Renderer-specific options:"
.TP
\fB\-\-hrirs\fR=\fI\,FILE\/\fR
Load HRIRs for binaural renderer from FILE
.TP
\fB\-\-hrir\-size\fR=\fI\,N\/\fR
Truncate HRIRs to length N
.TP
\fB\-\-prefilter\fR=\fI\,FILE\/\fR
Load WFS prefilter from FILE
.TP
\fB\-o\fR, \fB\-\-ambisonics\-order\fR=\fI\,VALUE\/\fR
Ambisonics order to use for AAP (default: maximum)
.TP
\fB\-\-in\-phase\-rendering\fR
Use in\-phase rendering for AAP renderer
.SS "JACK options:"
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,NAME\/\fR
Set JACK client name to NAME
.TP
\fB\-\-input\-prefix\fR=\fI\,PREFIX\/\fR
Input port prefix (default: "system:capture_")
.TP
\fB\-\-output\-prefix\fR=\fI\,PREFIX\/\fR
Output port prefix (default: "system:playback_")
.TP
\fB\-f\fR, \fB\-\-freewheel\fR
Use JACK in freewheeling mode
.SS "General options:"
.TP
\fB\-c\fR, \fB\-\-config\fR=\fI\,FILE\/\fR
Read configuration from FILE
.TP
\fB\-s\fR, \fB\-\-setup\fR=\fI\,FILE\/\fR
Load reproduction setup from FILE
.TP
\fB\-\-threads\fR=\fI\,N\/\fR
Number of audio threads (default: auto)
.TP
\fB\-r\fR, \fB\-\-record\fR=\fI\,FILE\/\fR
Record the audio output of the renderer to FILE
.TP
\fB\-\-decay\-exponent\fR=\fI\,VALUE\/\fR
Exponent that determines the amplitude decay (default: 1)
(disabled at compile time!)
.TP
\fB\-\-loop\fR
Loop all audio files
.TP
\fB\-\-master\-volume\-correction\fR=\fI\,VALUE\/\fR
Correction of the master volume in dB (default: 0 dB)
.TP
\fB\-\-auto\-rotation\fR Auto\-rotate sound sources' orientation toward the
reference
.TP
\fB\-\-no\-auto\-rotation\fR
Don't auto\-rotate sound sources' orientation toward the
reference
.TP
\fB\-i\fR, \fB\-\-ip\-server\fR
Start IP server (not enabled at compile time!)
.TP
\fB\-I\fR, \fB\-\-no\-ip\-server\fR
Don't start IP server (default)
.TP
\fB\-\-websocket\-server\fR
Start WebSocket server (not enabled at compile time!)
.TP
\fB\-\-no\-websocket\-server\fR
Don't start WebSocket server (default)
.TP
\fB\-\-fudi\-server\fR
Start FUDI server (not enabled at compile time!)
.TP
\fB\-\-no\-fudi\-server\fR
Don't start FUDI server (default)
.TP
\fB\-\-follow\fR
Wait for another SSR instance to connect
.TP
\fB\-\-no\-follow\fR
Don't follow another SSR instance (default)
.TP
\fB\-g\fR, \fB\-\-gui\fR
Start GUI (not enabled at compile time!)
.TP
\fB\-G\fR, \fB\-\-no\-gui\fR
Don't start GUI (default)
.TP
\fB\-t\fR, \fB\-\-tracker\fR=\fI\,TYPE\/\fR
Select head tracker, possible value(s):
fastrak patriot razor
.TP
\fB\-\-tracker\-port\fR=\fI\,PORT\/\fR
Port name/number of head tracker, e.g. \fI\,/dev/ttyS1\/\fP
.TP
\fB\-T\fR, \fB\-\-no\-tracker\fR
Don't use a head tracker (default)
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase verbosity level (up to \fB\-vvv\fR)
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version information and exit
.SH AUTHOR
.SS "Written by:"
.IP
Matthias Geier, Jens Ahrens
.SS "Scientific supervision:"
.IP
Sascha Spors
.SS "Contributions by:"
.IP
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
.SS "GUI design:"
.IP
Katharina Bredies, Jonas Loh, Jens Ahrens
.SS "Logo design:"
.IP
Fabian Hemmert
.SH "REPORTING BUGS"
Report bugs to: <ssr@spatialaudio.net>
.br
SSR home page: <http://spatialaudio.net/ssr/>
.SH COPYRIGHT
Copyright \(co 2016 Division of Applied Acoustics, Chalmers University of Technology
.br
Copyright \(co 2014 Institut für Nachrichtentechnik, Universität Rostock
.br
Copyright \(co 2012 Quality & Usability Lab, Telekom Innovation Laboratories, TU Berlin
.PP
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.