1ogg123(1) Vorbis Tools ogg123(1)
2
6 ogg123 - plays Ogg Vorbis files
7
10 ogg123 [ -vqrzZVh ] [ -k seconds ] [ -x nth ] [ -y ntimes ] [ -b buf‐
11 fer_size ] [ -d driver [ -o option:value ] [ -f filename ] ] file ...
12 | directory ... | URL ...
13
16 ogg123 reads Ogg Vorbis audio files and decodes them to the devices
17 specified on the command line. By default, ogg123 writes to the stan‐
18 dard sound device, but output can be sent to any number of devices.
19 Files can be read from the file system, or URLs can be streamed via
20 HTTP. If a directory is given, all of the files in it or its subdirec‐
21 tories will be played.
22
25 --audio-buffer n
26 Use an output audio buffer of approximately 'n' kilobytes.
27 -@ playlist, --list playlist
29 Play all of the files named in the file 'playlist'. The
30 playlist should have one filename, directory name, or URL per
31 line. Blank lines are permitted. Directories will be treated
32 in the same way as on the command line.
33 -b n, --buffer n
35 Use an input buffer of approximately 'n' kilobytes. HTTP-only
36 option.
37 -p n, --prebuffer n
39 Prebuffer 'n' percent of the input buffer. Playback won't begin
40 until this prebuffer is complete. HTTP-only option.
41 -d device, --device device
43 Specify output device. See DEVICES section for a list of
44 devices. Any number of devices may be specified.
45 -f filename, --file filename
47 Specify output file for file devices. The filename "-" writes
48 to standard out. If the file already exists, ogg123 will over‐
49 write it.
50 -c c, --config c
52 Config options from command-line.
53 -l s, --delay s
55 Set termination timeout in milliseconds. ogg123 will skip to the
56 next song on SIGINT (Ctrl-C), and will terminate if two SIGINTs
57 are received within the specified timeout 's'. (default 500)
58 -h, --help
60 Show command help.
61 -k n, --skip n
63 Skip the first 'n' seconds. 'n' may also be in minutes:seconds
64 or hours:minutes:seconds form.
65 -K n, --end n
67 Stops playing 'n' seconds from the start of the stream. 'n' may
68 also have the same format as used in the --skip option.
69 -o option[:value], --device-option option[:value]
71 Sets the option option to value for the preceding device. See
72 DEVICES for a list of valid options for each device.
73 -q, --quiet
75 Quiet mode. No messages are displayed.
76 -V, --version
78 Display version information.
79 -v, --verbose
81 Increase verbosity.
82 -x n, --nth
84 Play every 'n'th decoded block. Has the effect of playing audio
85 at 'n' times faster than normal speed.
86 -y n, --ntimes
88 Repeat every played block 'n' times. Has the effect of playing
89 audio 'n' times slower than normal speed. May be with -x for
90 interesting fractional speeds.
91 -r, --repeat
93 Repeat playlist indefinitely.
94 -R, --remote
96 Use remote control interface.
97 -z, --shuffle
99 Play files in pseudo-random order.
100 -Z, --random
102 Play files in pseudo-random order forever.
103
106 ogg123 supports a variety of audio output devices through libao. Only
107 those devices supported by the target platform will be available. The
108 -f option may only be used with devices that write to files.
109 Options supported by all devices:
111 debug Turn on debugging output [if any] for a chosen driver.
113 matrix:value
115 Force a specific output channel ordering for a given
116 device. value is a comma seperated list of AO style
117 channel names, eg, L,R,C,LFE,BL,BR,SL,SR.
118 verbose
120 Turn on verbose output for a chosen driver. the -v option
121 will also set the driver verbose option.
122 quiet Force chosen driver to be completely silent. Even errors
124 will not produce any output. -q will also set the driver
125 quiet option.
126 aixs AIX live output driver. Options:
129 dev:value
131 Set AIX output device to value
132 alsa Advanced Linux Sound Architecture live output driver. Options:
135 buffer_time:value
137 Override the default hardware buffer size (in millisec‐
138 onds).
139 dev:value
141 ALSA device label to use. Examples include "hw:0" for the
142 first soundcard and "hw:1" for the second. The alsa
143 driver normally chooses one of "surround71", "sur‐
144 round51", "surround40" or "default" automatically depend‐
145 ing on number of output channels. For more information,
146 see http://alsa.opensrc.org/ALSA+device+labels
147 period_time:value
149 Override the default hardware period size (in microsec‐
150 onds).
151 period_time:value
153 Override the default hardware period size (in microsec‐
154 onds).
155 use_mmap:value
157 value is set to "yes" or "no" to override the compiled-in
158 default to use or not use mmap device access. In the
159 past, some buggy alsa drivers have behaved better when
160 not using mmap access at the penalty of slightly higher
161 CPU usage.
162 arts aRts Sound Daemon live output driver. Options:
165 multi:value
167 value is set to "yes" or "no" to allow opening the aRts
168 playback device for multiply concurrent playback.
169 Although the driver works properly in multi mode, it is
170 known to occasionally crash the aRts server itself.
171 Default behavior is "no".
172 au Sun audio file output. Writes the audio samples in AU format.
175 The AU format supports writing to unseekable files like standard
176 out. In such circumstances, the AU header will specify the sam‐
177 ple format, but not the length of the recording.
178 esd Enlightened Sound Daemon live output. Options:
181 host:value
183 value specifies the hostname where esd is running. This
184 can include a port number after a colon, as in
185 "whizbang.com:555". (Default = localhost)
186 irix IRIX live output audio driver.
189 macosx MacOS X 'AUHAL' live output driver. This driver supports MacOS
192 X 10.5 and later (10.4 and earlier uses an earlier, incompatable
193 interface). Options:
194 buffer_time:value
196 Set the hardware buffer size to the equivalent of value
197 milliseconds.
198 nas Network Audio Server live output driver. Options:
201 buf_size:value
203 Set size of audio buffer on server in bytes.
204 host:value
206 Set location of NAS server; See nas(1) for format.
207 null Null driver. All audio data is discarded. (Note: Audio data is
210 not written to /dev/null !) You could use this driver to test
211 raw decoding speed without output overhead.
212 oss Open Sound System driver for Linux and FreeBSD, versions 2, 3
215 and 4. Options:
216 dsp:value
218 DSP device for soundcard. Defaults to /dev/dsp.
219 pulse Pulseaudio live audio sound driver. Options:
222 server:value
224 Specifies location of remote or alternate Pulseaudio
225 server.
226 sink:value
228 Specifies a non-default Pulseaudio sink for audio stream.
229 raw Raw file output. Writes raw audio samples to a file. Options:
232 byteorder:value
234 Chooses big endian ("big"), little endian ("little"), or
235 native ("native") byte order. Default is native order.
236 roar Roar Audio Daemon live output driver. Options:
239 host:value
241 Specifies location of remote Roar server to use.
242 sndio OpenBSD SNDIO live output driver. Options:
245 dev:value
247 Specifies audio device to use for playback.
248 sun Sun Audio live output driver for NetBSD, OpenBSD, and Solaris.
251 Options:
252 dev:value
254 Audio device for soundcard. Defaults to /dev/audio.
255 wav WAV file output. Writes the sound data to disk in uncompressed
259 form. If multiple files are played, all of them will be con‐
260 catenated into the same WAV file. WAV files cannot be written
261 to unseekable files, such as standard out. Use the AU format
262 instead.
263 wmm Windows MultiMedia live output driver for Win98 and later.
266 Options:
267 dev:value
269 Selects audio device to use for playback by device name.
270 id:value
272 Selects audio device to use for playback by device id
273 (card number).
274
277 The ogg123 command line is fairly flexible, perhaps confusingly so.
278 Here are some sample command lines and an explanation of what they do.
279 Play on the default soundcard:
281 ogg123 test.ogg
282 Play all of the files in the directory ~/music and its subdirectories.
284 ogg123 ~/music
285 Play a file using the OSS driver:
287 ogg123 -d oss test.ogg
288 Pass the "dsp" option to the OSS driver:
290 ogg123 -d oss -o dsp:/dev/mydsp
291 Use the ESD driver
293 ogg123 -d esd test.ogg
294 Use the WAV driver with the output file, "test.wav":
296 ogg123 -d wav -f test.wav test.ogg
297 Listen to a file while you write it to a WAV file:
299 ogg123 -d oss -d wav -f test.wav test.ogg
300 Note that options apply to the device declared to the left:
302 ogg123 -d oss -o dsp:/dev/mydsp -d raw -f test2.raw -o byte‐
303 order:big test.ogg
304 Stress test your harddrive:
306 ogg123 -d oss -d wav -f 1.wav -d wav -f 2.wav -d wav -f 3.wav -d
307 wav -f 4.wav -d wav -f 5.wav test.ogg
308 Create an echo effect with esd and a slow computer:
310 ogg123 -d esd -d esd test.ogg
311
313 You can abort ogg123 at any time by pressing Ctrl-C. If you are play‐
314 ing multiple files, this will stop the current file and begin playing
315 the next one. If you want to abort playing immediately instead of
316 skipping to the next file, press Ctrl-C within the first second of the
317 playback of a new file.
318 Note that the result of pressing Ctrl-C might not be audible immedi‐
320 ately, due to audio data buffering in the audio device. This delay is
321 system dependent, but it is usually not more than one or two seconds.
322
325 /etc/libao.conf
326 Can be used to set the default output device for all libao pro‐
327 grams.
328 ~/.libao
331 Per-user config file to override the system wide output device
332 settings.
333
335 Piped WAV files may cause strange behavior in other programs. This is
336 because WAV files store the data length in the header. However, the
337 output driver does not know the length when it writes the header, and
338 there is no value that means "length unknown". Use the raw or au out‐
339 put driver if you need to use ogg123 in a pipe.
340
343 Program Authors:
344 Kenneth Arnold <kcarnold-xiph@arnoldnet.net>
345 Stan Seibert <volsung@xiph.org>
346 Manpage Author:
349 Stan Seibert <volsung@xiph.org>
350
353 libao.conf(5), oggenc(1), vorbiscomment(1), ogginfo(1)
354Xiph.Org Foundation 2010 March 24 ogg123(1)