1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH SSR "1" "February 2023" "SoundScape Renderer 0.6.0" "User Commands"
.SH NAME
SSR \- manual page for the generic renderer
.SH SYNOPSIS
.B ssr-generic
[\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.
|