chiark - git - mdw - disorder/blob - doc/disorder-playrtp.1.in

   1 .\"
   2 .\" Copyright (C) 2007-2009 Richard Kettlewell
   3 .\"
   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.
   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 .\"
  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/>.
  16 .\"
  17 .TH disorder-playrtp 1
  18 .SH NAME
  19 disorder-playrtp \- play DisOrder network broadcasts
  20 .SH SYNOPSIS
  21 .B disorder\-playrtp
  22 .RI [ OPTIONS ]
  23 .RB [ \-\- ]
  24 .RI [[ ADDRESS ]
  25 .IR PORT ]
  26 .SH DESCRIPTION
  27 \fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
  28 address.
  29 .PP
  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
  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
  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.
  39 .SH OPTIONS
  40 The default sound API is the first of the ones listed below that are available.
  41 Usually this implies ALSA under Linux and Core Audio under OS X.
  42 .TP
  43 .B \-\-alsa\fR, \fB\-a
  44 Use ALSA to play sound.
  45 Only available on Linux.
  46 .TP
  47 .B \-\-oss\fR, \fB\-o
  48 Use OSS to play sound.
  49 Only available on Linux and FreeBSD.
  50 .TP
  51 .B \-\-core\-audio\fR, \fB\-c
  52 Use Core Audio to play sound.
  53 Only available on Macs.
  54 .TP
  55 .B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
  56 Specifies the audio device to use.
  57 See
  58 .B "DEVICE NAMES"
  59 below for more information.
  60 .TP
  61 .B \-\-command \fICOMMAND\fR, \fB-e \fICOMMAND\fR
  62 Instead of sending to a physical audio device, invoke \fICOMMAND\fR using the
  63 shell and write audio samples to its standard input.
  64 Currently the input will be 44100KHz 16-bit signed stereo samples.
  65 If \fICOMMAND\fR exits it is re-executed; any samples that had been written to
  66 the pipe but not processed by the previous instance will be lost.
  67 .IP
  68 .B \-\-device
  69 is redundant with this option, but you might want to set
  70 .BR \-\-pause\-mode .
  71 .IP
  72 As an example,
  73 .B "-e \(aqcat > dump\(aq"
  74 would log audio data to a file for later processing.
  75 You could convert it to another format with, for instance:
  76 .IP
  77 .B "sox -c2 -traw -r44100 -s -w dump dump.wav"
  78 .TP
  79 .B \-\-pause\-mode \fIMODE\fR, \fB-P \fIMODE
  80 Set the pause mode for \fB\-\-command\fR to either \fBsilence\fR (the default), in
  81 which pauses are represented by sending silent samples, or \fBsuspend\fR, in which
  82 writes to  the subprocess are suspended, requiring it to infer a pause from flow
  83 control.
  84 .TP
  85 .B \-\-config \fIPATH\fR, \fB\-C \fIPATH
  86 Set the configuration file.
  87 The default is
  88 .IR pkgconfdir/config .
  89 .TP
  90 .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
  91 Set the control socket.
  92 Normally this would not be used manually.
  93 .TP
  94 .B \-\-help\fR, \fB\-h
  95 Display a usage message.
  96 .TP
  97 .B \-\-version\fR, \fB\-V
  98 Display version number.
  99 .SS "Buffer Control Options"
 100 You shouldn't need to use these options.
 101 .TP
 102 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
 103 Specifies the buffer low watermark in frames.
 104 If the number of frames falls below this value then playing will be
 105 stopped until the buffer fills up.
 106 .TP
 107 .B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
 108 Specifies the buffer high watermark in frames.
 109 Once there are this many frames in the buffer, playing will be (re-)started.
 110 .TP
 111 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
 112 Specifies the maximum buffer size in frames.
 113 If there are this many frames in the buffer then reading from the
 114 network socket will be suspended.
 115 The default is four times the \fB\-\-buffer\fR value.
 116 .TP
 117 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
 118 Specifies socket receive buffer size.
 119 The default is 131072 (128Kbytes).
 120 The buffer size will not be reduced below the operating system's default.
 121 .SH "REMOTE CONTROL"
 122 The
 123 .B \-\-socket
 124 option is used by Disobedience to control a background
 125 .B disorder\-playrtp
 126 daemon.
 127 The socket will be created as a UNIX domain stream socket.
 128 When a connection is received a single line is read from it.
 129 The following commands are known:
 130 .TP
 131 .B stop
 132 Causes
 133 .B disorder\-playrtp
 134 to terminate.
 135 .TP
 136 .B query
 137 Causes the string "running" to be sent back.
 138 .PP
 139 Other commands are ignored.
 140 After the first command the connection is closed.
 141 Only one connection at a time will be serviced.
 142 .PP
 143 This protocol is not guaranteed to be stable.
 144 .SH "DEVICE NAMES"
 145 .SS "Core Audio"
 146 On a Mac, the device name can either be the human-readable name of the desired
 147 output or its UID.
 148 To get a list of the human-readable names, visit System Preferences -> Sound;
 149 the Type column has the name you want.
 150 .PP
 151 For example, you might use "Built-in Output" for the built-in speaker
 152 or "Built-in Line Output" if you have connected external speakers.
 153 Remember to quote the name.
 154 .SH "SEE ALSO"
 155 .BR disobedience (1),
 156 .BR disorder_config (5),
 157 .BR disorderd (8)
 158 .\" Local Variables:
 159 .\" mode:nroff
 160 .\" fill-column:79
 161 .\" End: