2 .\" Copyright (C) 2007-2009, 2013 Richard Kettlewell
4 .\" This program is free software: you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation, either version 3 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU General Public License for more details.
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
17 .TH disorder-playrtp 1
19 disorder-playrtp \- play DisOrder network broadcasts
27 \fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
30 If neither an address nor port are specified then the local DisOrder
31 configuration is consulted to find the server and the server is asked where the
34 If just a port is specified then the RTP stream is assumed to be unicast or
35 broadcast to that port.
37 If an address and a port are specified then the RTP stream is assumed to be
38 multicast to that group address and port.
46 will request a dedicated unicast stream from the server. The
48 may be followed by an optional port, or address/port pair, which will be the
49 local address/port to bind to and announce to the server.
52 .B \-\-api\fR, -\fB-A\fR \fIAPI\fR
53 Select the playback API.
54 The possibilities are, depending on platform and compilation options:
72 Pipe audio to a command.
75 The default is the first of the possibilities above that is supported.
77 .B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
78 Specifies the audio device to use.
81 below for more information.
83 .B \-\-command \fICOMMAND\fR, \fB-e \fICOMMAND\fR
84 Instead of sending to a physical audio device, invoke \fICOMMAND\fR using the
85 shell and write audio samples to its standard input.
86 Currently the input will be 44100KHz 16-bit signed stereo samples.
87 If \fICOMMAND\fR exits it is re-executed; any samples that had been written to
88 the pipe but not processed by the previous instance will be lost.
91 is redundant with this option, but you might want to set
95 .B "-e \(aqcat > dump\(aq"
96 would log audio data to a file for later processing.
97 You could convert it to another format with, for instance:
99 .B "sox -c2 -traw -r44100 -s -w dump dump.wav"
101 .B \-\-pause\-mode \fIMODE\fR, \fB-P \fIMODE
102 Set the pause mode for \fB\-\-command\fR to either \fBsilence\fR (the default), in
103 which pauses are represented by sending silent samples, or \fBsuspend\fR, in which
104 writes to the subprocess are suspended, requiring it to infer a pause from flow
107 .B \-\-config \fIPATH\fR, \fB\-C \fIPATH
108 Set the system configuration file.
112 environment variable, defaulting to
113 .IR pkgconfdir/config .
115 .B \-\-user-config \fIPATH\fR, \fB\-u \fIPATH
116 Set the user configuration file.
117 THe default is given by the
118 .B DISORDER_USERCONFIG
119 environment variable, defaulting to
120 .IR $HOME/.disorder/passwd .
122 .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
123 Set the control socket.
124 Normally this would not be used manually.
126 .B \-\-help\fR, \fB\-h
127 Display a usage message.
129 .B \-\-version\fR, \fB\-V
130 Display version number.
131 .SS "Buffer Control Options"
132 You shouldn't need to use these options.
133 Their effects are subject to change between version without warning.
134 You should consult the source code for details of their effects.
136 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
137 Specifies the buffer low watermark in frames.
138 This also acts as the target buffer occupancy.
139 The default is taken from the
141 configuration parameter.
143 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
144 Specifies the maximum buffer size in frames.
145 If there are this many frames in the buffer then reading from the
146 network socket will be suspended.
147 The default is twice the \fB\-\-min\fR value.
148 The default is taken from the
150 configuration parameter.
152 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
153 Specifies socket receive buffer size.
154 The default is not to change the buffer size, i.e. you get whatever the
155 local operating system chooses.
156 The buffer size will not be reduced below the operating system's default.
157 The default is taken from the
159 configuration parameter.
161 .B \-\-monitor\fR, \fB\-M
162 Periodically report how close to the buffer low watermark the buffer is.
163 If you have trouble with poor playback quality, enable this option to see if
164 the buffer is emptying out (or overfilling, though there are measures to
165 prevent that from happening).
166 .SS "Deprecated Options"
167 These options may be removed in a future version.
168 Use \fB\-\-api\fR instead.
170 .B \-\-alsa\fR, \fB\-a
171 Use ALSA to play sound.
172 Only available on Linux.
174 .B \-\-oss\fR, \fB\-o
175 Use OSS to play sound.
176 Only available on Linux and FreeBSD.
178 .B \-\-core\-audio\fR, \fB\-c
179 Use Core Audio to play sound.
180 Only available on Macs.
184 option is used by Disobedience to control a background
187 The socket will be created as a UNIX domain stream socket.
188 When a connection is received a single line is read from it.
189 The following commands are known:
197 Causes the string "running" to be sent back.
200 Print the left and right volume levels,
201 as two decimal integers between 0 and 100,
202 separated by a space.
204 .BI "setvol " left " " right
205 Set the left and right volume levels to the given decimal values,
206 which should be between 0 and 100;
207 echo back the new values as for
211 Other commands are ignored.
212 After the first command the connection is closed.
213 Only one connection at a time will be serviced.
215 This protocol is not guaranteed to be stable.
218 On a Mac, the device name can either be the human-readable name of the desired
220 To get a list of the human-readable names, visit System Preferences -> Sound;
221 the Type column has the name you want.
223 For example, you might use "Built-in Output" for the built-in speaker
224 or "Built-in Line Output" if you have connected external speakers.
225 Remember to quote the name.
227 .BR disobedience (1),
228 .BR disorder_config (5),