Commit | Line | Data |
---|---|---|
9086a105 | 1 | .\" |
ba32e50c | 2 | .\" Copyright (C) 2007-2009, 2013 Richard Kettlewell |
9086a105 | 3 | .\" |
e7eb3a27 | 4 | .\" This program is free software: you can redistribute it and/or modify |
9086a105 | 5 | .\" it under the terms of the GNU General Public License as published by |
e7eb3a27 | 6 | .\" the Free Software Foundation, either version 3 of the License, or |
9086a105 | 7 | .\" (at your option) any later version. |
e7eb3a27 RK |
8 | .\" |
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. | |
13 | .\" | |
9086a105 | 14 | .\" You should have received a copy of the GNU General Public License |
e7eb3a27 | 15 | .\" along with this program. If not, see <http://www.gnu.org/licenses/>. |
9086a105 RK |
16 | .\" |
17 | .TH disorder-playrtp 1 | |
18 | .SH NAME | |
19 | disorder-playrtp \- play DisOrder network broadcasts | |
20 | .SH SYNOPSIS | |
0d350ff0 | 21 | .B disorder\-playrtp |
9086a105 | 22 | .RI [ OPTIONS ] |
0d350ff0 | 23 | .RB [ \-\- ] |
c897bb65 | 24 | .RI [[ ADDRESS ] |
18e5cbdc | 25 | .IR PORT ] |
9086a105 | 26 | .SH DESCRIPTION |
0d350ff0 | 27 | \fBdisorder\-playrtp\fR plays a network broadcast sent from the specified |
9086a105 | 28 | address. |
f2a6202f | 29 | .PP |
c897bb65 | 30 | If neither an address nor port are specified then the local DisOrder |
6fba990c RK |
31 | configuration is consulted to find the server and the server is asked where the |
32 | RTP stream is. | |
33 | .PP | |
34 | If just a port is specified then the RTP stream is assumed to be unicast or | |
35 | broadcast to that port. | |
36 | .PP | |
c897bb65 RK |
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. | |
169f1a6f MW |
39 | .PP |
40 | Alternatively, the | |
41 | .I ADDRESS | |
42 | can start with a | |
43 | .RB ` \- ', | |
44 | in which case | |
45 | .B disorder-playrtp | |
46 | will request a dedicated unicast stream from the server. The | |
47 | .RB ` \- ' | |
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. | |
9086a105 | 50 | .SH OPTIONS |
b6579a61 | 51 | .TP |
ba32e50c RK |
52 | .B \-\-api\fR, -\fB-A\fR \fIAPI\fR |
53 | Select the playback API. | |
54 | The possibilities are, depending on platform and compilation options: | |
55 | .RS 8 | |
b6579a61 | 56 | .TP |
de0ef46e RK |
57 | .B pulseaudio |
58 | PulseAudio. | |
59 | .TP | |
ba32e50c RK |
60 | .B alsa |
61 | ALSA. | |
62 | Linux only. | |
b6579a61 | 63 | .TP |
ba32e50c RK |
64 | .B oss |
65 | OSS. | |
66 | .TP | |
67 | .B coreaudio | |
68 | Core Audio. | |
69 | OS X only. | |
70 | .TP | |
71 | .B command | |
72 | Pipe audio to a command. | |
73 | .RE | |
74 | .IP | |
75 | The default is the first of the possibilities above that is supported. | |
9086a105 | 76 | .TP |
0d350ff0 | 77 | .B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR |
c0c23a60 | 78 | Specifies the audio device to use. |
f5fd9a6b RK |
79 | See |
80 | .B "DEVICE NAMES" | |
81 | below for more information. | |
9086a105 | 82 | .TP |
e979b844 RK |
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. | |
89 | .IP | |
90 | .B \-\-device | |
c4e0bd8e | 91 | is redundant with this option, but you might want to set |
287ad384 | 92 | .BR \-\-pause\-mode . |
e979b844 RK |
93 | .IP |
94 | As an example, | |
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: | |
98 | .IP | |
99 | .B "sox -c2 -traw -r44100 -s -w dump dump.wav" | |
100 | .TP | |
287ad384 RK |
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 | |
105 | control. | |
106 | .TP | |
0d350ff0 | 107 | .B \-\-config \fIPATH\fR, \fB\-C \fIPATH |
af52ec84 | 108 | Set the system configuration file. |
c0c23a60 | 109 | The default is |
8ab2aa9f MW |
110 | given by the |
111 | .B DISORDER_CONFIG | |
112 | environment variable, defaulting to | |
b6579a61 RK |
113 | .IR pkgconfdir/config . |
114 | .TP | |
af52ec84 MW |
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 . | |
121 | .TP | |
0d350ff0 | 122 | .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH |
c0c23a60 RK |
123 | Set the control socket. |
124 | Normally this would not be used manually. | |
b6579a61 | 125 | .TP |
0d350ff0 | 126 | .B \-\-help\fR, \fB\-h |
f2a6202f RK |
127 | Display a usage message. |
128 | .TP | |
0d350ff0 | 129 | .B \-\-version\fR, \fB\-V |
f2a6202f RK |
130 | Display version number. |
131 | .SS "Buffer Control Options" | |
132 | You shouldn't need to use these options. | |
7edc7e42 | 133 | Their effects are subject to change between version without warning. |
0e72bf84 | 134 | You should consult the source code for details of their effects. |
f2a6202f | 135 | .TP |
0d350ff0 | 136 | .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR |
c0c23a60 | 137 | Specifies the buffer low watermark in frames. |
7edc7e42 | 138 | This also acts as the target buffer occupancy. |
14b5913c MW |
139 | The default is taken from the |
140 | .B rtp_minbuffer | |
141 | configuration parameter. | |
9086a105 | 142 | .TP |
0d350ff0 | 143 | .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR |
c0c23a60 RK |
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. | |
0e72bf84 | 147 | The default is twice the \fB\-\-min\fR value. |
14b5913c MW |
148 | The default is taken from the |
149 | .B rtp_maxbuffer | |
150 | configuration parameter. | |
9086a105 | 151 | .TP |
0d350ff0 | 152 | .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR |
c0c23a60 | 153 | Specifies socket receive buffer size. |
0e72bf84 RK |
154 | The default is not to change the buffer size, i.e. you get whatever the |
155 | local operating system chooses. | |
c0c23a60 | 156 | The buffer size will not be reduced below the operating system's default. |
14b5913c MW |
157 | The default is taken from the |
158 | .B rtp_rcvbuf | |
159 | configuration parameter. | |
7edc7e42 RK |
160 | .TP |
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). | |
ba32e50c RK |
166 | .SS "Deprecated Options" |
167 | These options may be removed in a future version. | |
168 | Use \fB\-\-api\fR instead. | |
169 | .TP | |
170 | .B \-\-alsa\fR, \fB\-a | |
171 | Use ALSA to play sound. | |
172 | Only available on Linux. | |
173 | .TP | |
174 | .B \-\-oss\fR, \fB\-o | |
175 | Use OSS to play sound. | |
176 | Only available on Linux and FreeBSD. | |
177 | .TP | |
178 | .B \-\-core\-audio\fR, \fB\-c | |
179 | Use Core Audio to play sound. | |
180 | Only available on Macs. | |
b6579a61 RK |
181 | .SH "REMOTE CONTROL" |
182 | The | |
0d350ff0 | 183 | .B \-\-socket |
b6579a61 | 184 | option is used by Disobedience to control a background |
0d350ff0 | 185 | .B disorder\-playrtp |
c0c23a60 RK |
186 | daemon. |
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: | |
b6579a61 RK |
190 | .TP |
191 | .B stop | |
192 | Causes | |
0d350ff0 | 193 | .B disorder\-playrtp |
b6579a61 RK |
194 | to terminate. |
195 | .TP | |
196 | .B query | |
197 | Causes the string "running" to be sent back. | |
af21fb6b MW |
198 | .TP |
199 | .B getvol | |
200 | Print the left and right volume levels, | |
201 | as two decimal integers between 0 and 100, | |
202 | separated by a space. | |
203 | .TP | |
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 | |
208 | .B getvol | |
209 | above. | |
b6579a61 | 210 | .PP |
c0c23a60 RK |
211 | Other commands are ignored. |
212 | After the first command the connection is closed. | |
b6579a61 RK |
213 | Only one connection at a time will be serviced. |
214 | .PP | |
215 | This protocol is not guaranteed to be stable. | |
f5fd9a6b RK |
216 | .SH "DEVICE NAMES" |
217 | .SS "Core Audio" | |
218 | On a Mac, the device name can either be the human-readable name of the desired | |
219 | output or its UID. | |
220 | To get a list of the human-readable names, visit System Preferences -> Sound; | |
221 | the Type column has the name you want. | |
222 | .PP | |
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. | |
9086a105 | 226 | .SH "SEE ALSO" |
b6579a61 | 227 | .BR disobedience (1), |
9086a105 RK |
228 | .BR disorder_config (5), |
229 | .BR disorderd (8) | |
230 | .\" Local Variables: | |
231 | .\" mode:nroff | |
232 | .\" fill-column:79 | |
233 | .\" End: |