vorbis-tools/ogg123/ogg123.1

   1 .\" Process this file with
   2 .\" groff -man -Tascii ogg123.1
   3 .\"
   4 .TH ogg123 1 "2003 September 1" "Xiph.Org Foundation" "Vorbis Tools"
   5
   6 .SH NAME
   7 ogg123 \- plays Ogg Vorbis files
   8
   9 .SH SYNOPSIS
  10 .B ogg123
  11 [
  12 .B -vqrzZVh
  13 ] [
  14 .B -k
  15 .I seconds
  16 ] [
  17 .B -x
  18 .I nth
  19 ] [
  20 .B -y
  21 .I ntimes
  22 ] [
  23 .B -b
  24 .I buffer_size
  25 ] [
  26 .B -d
  27 .I driver
  28 [
  29 .B -o
  30 .I option:value
  31 ]
  32 [
  33 .B -f
  34 .I filename
  35 ] ]
  36 .I file
  37 .B ...
  38 |
  39 .I directory
  40 .B ...
  41 |
  42 .I URL
  43 .B ...
  44
  45 .SH DESCRIPTION
  46 .B ogg123
  47 reads Ogg Vorbis audio files and decodes them to the devices specified
  48 on the command line.  By default,
  49 .B ogg123
  50 writes to the standard sound device, but output can be sent to any
  51 number of devices.  Files can be read from the file system, or URLs
  52 can be streamed via HTTP.  If a directory is given, all of the files in
  53 it or its subdirectories will be played.
  54
  55 .SH OPTIONS
  56 .IP "--audio-buffer n"
  57 Use an output audio buffer of approximately 'n' kilobytes.
  58 .IP "-@ playlist, --list playlist"
  59 Play all of the files named in the file 'playlist'.  The playlist should have
  60 one filename, directory name, or URL per line.  Blank lines are permitted.
  61 Directories will be treated in the same way as on the command line.
  62 .IP "-b n, --buffer n"
  63 Use an input buffer of approximately 'n' kilobytes.  HTTP-only option.
  64 .IP "-p n, --prebuffer n"
  65 Prebuffer 'n' percent of the input buffer.  Playback won't begin until
  66 this prebuffer is complete.  HTTP-only option.
  67 .IP "-d device, --device device"
  68 Specify output device.  See
  69 .B DEVICES
  70 section for a list of devices.  Any number of devices may be specified.
  71 .IP "-f filename, --file filename"
  72 Specify output file for file devices.  The filename "-" writes to standard
  73 out.  If the file already exists,
  74 .B ogg123
  75 will overwrite it.
  76 .IP "-h, --help"
  77 Show command help.
  78 .IP "-k n, --skip n"
  79 Skip the first 'n' seconds.  'n' may also be in minutes:seconds or
  80 hours:minutes:seconds form.
  81 .IP "-K n, --end n"
  82 Stops playing 'n' seconds from the start of the stream.  'n' may also have the
  83 same format as used in the
  84 .I --skip
  85 option.
  86 .IP "-o option:value, --device-option option:value"
  87 Assigns the option
  88 .I option
  89 to
  90 .I value
  91 for the preceding device.  See
  92 .B DEVICES
  93 for a list of valid options for each device.
  94 .IP "-q, --quiet"
  95 Quiet mode.  No messages are displayed.
  96 .IP "-V, --version"
  97 Display version information.
  98 .IP "-v, --verbose"
  99 Increase verbosity.
 100 .IP "-x n, --nth"
 101 Play every 'n'th decoded block.  Has the effect of playing audio at 'n' times
 102 faster than normal speed.
 103 .IP "-y n, --ntimes"
 104 Repeat every played block 'n' times.  Has the effect of playing audio 'n'
 105 times slower than normal speed.  May be with -x for interesting fractional
 106 speeds.
 107 .IP "-r, --repeat"
 108 Repeat playlist indefinitely.
 109 .IP "-z, --shuffle"
 110 Play files in pseudo-random order.
 111 .IP "-Z, --random"
 112 Play files in pseudo-random order forever.
 113
 114 .SH DEVICES
 115
 116 .B ogg123
 117 supports a variety of audio output devices through libao.  Only those
 118 devices supported by the target platform will be available.  The
 119 .B -f
 120 option may only be used with devices that write to files.
 121
 122 .IP null
 123 Null driver.  All audio data is discarded.  (Note: Audio data is not
 124 written to
 125 .B /dev/null
 126 !)  You could use this driver to test raw decoding speed without
 127 output overhead.
 128
 129 .IP alsa
 130 Advanced Linux Sound Architecture.
 131 .RS
 132 Options:
 133 .RS
 134 .IP dev
 135 ALSA device label to use. The system default is used by default.
 136 Examples include "plughw:0,0" for the first soundcard, and "plughw:1,0" for
 137 the second. For more information, see
 138 http://alsa.opensrc.org/ALSA+device+labels
 139 .IP buf_size
 140 Override the default buffer size (in bytes).
 141 .RE
 142 .RE
 143
 144 .IP arts
 145 aRts Sound Daemon.
 146
 147 .IP esd
 148 Enlightened Sound Daemon.
 149 .RS
 150 Options:
 151 .RS
 152 .IP host
 153 The hostname where esd is running.  This can include a port number
 154 after a colon, as in "whizbang.com:555".  (Default = localhost)
 155 .RE
 156 .RE
 157
 158 .IP irix
 159 IRIX audio driver.
 160
 161 .IP oss
 162 Open Sound System driver for Linux and FreeBSD.
 163 .RS
 164 Options:
 165 .RS
 166 .IP dsp
 167 DSP device for soundcard.  Defaults to
 168 .B /dev/dsp.
 169 .RE
 170 .RE
 171
 172 .IP sun
 173 Sun Audio driver for NetBSD, OpenBSD, and Solaris.
 174 .RS
 175 Options:
 176 .RS
 177 .IP dev
 178 Audio device for soundcard.  Defaults to
 179 .B /dev/audio.
 180 .RE
 181 .RE
 182
 183 .IP au
 184 Sun audio file output.  Writes the audio samples in AU format.  The AU
 185 format supports writing to unseekable files, like standard out.  In
 186 such circumstances, the AU header will specify the sample format, but
 187 not the length of the recording.
 188
 189 .IP raw
 190 Raw sample output.  Writes raw audio samples to a file.
 191 .RS
 192 Options:
 193 .RS
 194 .IP byteorder
 195 Choose big endian, little endian, or native byte order.  (Default = "native")
 196 .RE
 197 .RE
 198
 199 .IP wav
 200 WAV file output.  Writes the sound data to disk in uncompressed form.
 201 If multiple files are played, all of them will be concatenated into
 202 the same WAV file.  WAV files cannot be written to unseekable files,
 203 such as standard out.  Use the AU format instead.
 204
 205
 206 .SH EXAMPLES
 207
 208 The
 209 .B ogg123
 210 command line is fairly flexible, perhaps confusingly so.  Here are
 211 some sample command lines and an explanation of what they do.
 212 .PP
 213
 214 Play on the default soundcard:
 215 .RS
 216 .B ogg123 test.ogg
 217 .RE
 218 .PP
 219
 220 Play all of the files in the directory ~/music and its subdirectories.
 221 .RS
 222 .B ogg123 ~/music
 223 .RE
 224 .PP
 225
 226 Play a file using the OSS driver:
 227 .RS
 228 .B ogg123 -d oss test.ogg
 229 .RE
 230 .PP
 231
 232 Pass the "dsp" option to the OSS driver:
 233 .RS
 234 .B ogg123 -d oss -o dsp:/dev/mydsp
 235 .RE
 236 .PP
 237
 238 Use the ESD driver
 239 .RS
 240 .B ogg123 -d esd test.ogg
 241 .RE
 242 .PP
 243
 244 Use the WAV driver with the output file, "test.wav":
 245 .RS
 246 .B ogg123 -d wav -f test.wav test.ogg
 247 .RE
 248 .PP
 249
 250 Listen to a file while you write it to a WAV file:
 251 .RS
 252 .B ogg123 -d oss -d wav -f test.wav test.ogg
 253 .RE
 254 .PP
 255
 256 Note that options apply to the device declared to the left:
 257 .RS
 258 .B ogg123 -d oss -o dsp:/dev/mydsp -d raw -f test2.raw -o byteorder:big test.ogg
 259 .RE
 260 .PP
 261
 262 Stress test your harddrive:
 263 .RS
 264 .B ogg123 -d oss -d wav -f 1.wav -d wav -f 2.wav -d wav -f 3.wav -d wav -f 4.wav -d wav -f 5.wav  test.ogg
 265 .RE
 266 .PP
 267
 268 Create an echo effect with esd and a slow computer:
 269 .RS
 270 .B ogg123 -d esd -d esd test.ogg
 271 .RE
 272 .PP
 273
 274 .SH INTERRUPT
 275 You can abort
 276 .B ogg123
 277 at any time by pressing Ctrl-C.  If you are playing multiple
 278 files, this will stop the current file and begin playing the
 279 next one.  If you want to abort playing immediately instead
 280 of skipping to the next file, press Ctrl-C within the first
 281 second of the playback of a new file.
 282 .P
 283 Note that the result of pressing Ctrl-C might not be audible
 284 immediately, due to audio data buffering in the audio device.
 285 This delay is system dependent, but it is usually not more
 286 than one or two seconds.
 287
 288 .SH FILES
 289
 290 .TP
 291 /etc/libao.conf
 292 Can be used to set the default output device for all libao programs.
 293
 294 .TP
 295 ~/.libao
 296 Per-user config file to override the system wide output device settings.
 297 .PP
 298
 299 .SH BUGS
 300
 301 Piped WAV files may cause strange behavior in other programs.  This is
 302 because WAV files store the data length in the header.  However, the
 303 output driver does not know the length when it writes the header, and
 304 there is no value that means "length unknown".  Use the raw or au
 305 output driver if you need to use ogg123 in a pipe.
 306
 307 .SH AUTHORS
 308
 309 .TP
 310 Program Authors:
 311 .br
 312 Kenneth Arnold <kcarnold-xiph@arnoldnet.net>
 313 .br
 314 Stan Seibert <volsung@xiph.org>
 315 .br
 316
 317 .TP
 318 Manpage Author:
 319 .br
 320 Stan Seibert <volsung@xiph.org>
 321
 322 .SH "SEE ALSO"
 323
 324 .PP
 325 \fBlibao.conf\fR(5), \fBoggenc\fR(1), \fBvorbiscomment\fR(1), \fBogginfo\fR(1)
 326