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 -h, --help
52 Show command help.
53 -k n, --skip n
55 Skip the first 'n' seconds. 'n' may also be in minutes:seconds
56 or hours:minutes:seconds form.
57 -K n, --end n
59 Stops playing 'n' seconds from the start of the stream. 'n' may
60 also have the same format as used in the --skip option.
61 -o option[:value], --device-option option[:value]
63 Sets the option option to value for the preceding device. See
64 DEVICES for a list of valid options for each device.
65 -q, --quiet
67 Quiet mode. No messages are displayed.
68 -V, --version
70 Display version information.
71 -v, --verbose
73 Increase verbosity.
74 -x n, --nth
76 Play every 'n'th decoded block. Has the effect of playing audio
77 at 'n' times faster than normal speed.
78 -y n, --ntimes
80 Repeat every played block 'n' times. Has the effect of playing
81 audio 'n' times slower than normal speed. May be with -x for
82 interesting fractional speeds.
83 -r, --repeat
85 Repeat playlist indefinitely.
86 -z, --shuffle
88 Play files in pseudo-random order.
89 -Z, --random
91 Play files in pseudo-random order forever.
92
95 ogg123 supports a variety of audio output devices through libao. Only
96 those devices supported by the target platform will be available. The
97 -f option may only be used with devices that write to files.
98 Options supported by all devices:
100 debug Turn on debugging output [if any] for a chosen driver.
102 matrix:value
104 Force a specific output channel ordering for a given
105 device. value is a comma seperated list of AO style
106 channel names, eg, L,R,C,LFE,BL,BR,SL,SR.
107 verbose
109 Turn on verbose output for a chosen driver. the -v option
110 will also set the driver verbose option.
111 quiet Force chosen driver to be completely silent. Even errors
113 will not produce any output. -q will also set the driver
114 quiet option.
115 aixs AIX live output driver. Options:
118 dev:value
120 Set AIX output device to value
121 alsa Advanced Linux Sound Architecture live output driver. Options:
124 buffer_time:value
126 Override the default hardware buffer size (in millisec‐
127 onds).
128 dev:value
130 ALSA device label to use. Examples include "hw:0" for the
131 first soundcard and "hw:1" for the second. The alsa
132 driver normally chooses one of "surround71", "sur‐
133 round51", "surround40" or "default" automatically depend‐
134 ing on number of output channels. For more information,
135 see http://alsa.opensrc.org/ALSA+device+labels
136 period_time:value
138 Override the default hardware period size (in microsec‐
139 onds).
140 period_time:value
142 Override the default hardware period size (in microsec‐
143 onds).
144 use_mmap:value
146 value is set to "yes" or "no" to override the compiled-in
147 default to use or not use mmap device access. In the
148 past, some buggy alsa drivers have behaved better when
149 not using mmap access at the penalty of slightly higher
150 CPU usage.
151 arts aRts Sound Daemon live output driver. Options:
154 multi:value
156 value is set to "yes" or "no" to allow opening the aRts
157 playback device for multiply concurrent playback.
158 Although the driver works properly in multi mode, it is
159 known to occasionally crash the aRts server itself.
160 Default behavior is "no".
161 au Sun audio file output. Writes the audio samples in AU format.
164 The AU format supports writing to unseekable files like standard
165 out. In such circumstances, the AU header will specify the sam‐
166 ple format, but not the length of the recording.
167 esd Enlightened Sound Daemon live output. Options:
170 host:value
172 value specifies the hostname where esd is running. This
173 can include a port number after a colon, as in
174 "whizbang.com:555". (Default = localhost)
175 irix IRIX live output audio driver.
178 macosx MacOS X 'AUHAL' live output driver. This driver supports MacOS
181 X 10.5 and later (10.4 and earlier uses an earlier, incompatable
182 interface). Options:
183 buffer_time:value
185 Set the hardware buffer size to the equivalent of value
186 milliseconds.
187 nas Network Audio Server live output driver. Options:
190 buf_size:value
192 Set size of audio buffer on server in bytes.
193 host:value
195 Set location of NAS server; See nas(1) for format.
196 null Null driver. All audio data is discarded. (Note: Audio data is
199 not written to /dev/null !) You could use this driver to test
200 raw decoding speed without output overhead.
201 oss Open Sound System driver for Linux and FreeBSD, versions 2, 3
204 and 4. Options:
205 dsp:value
207 DSP device for soundcard. Defaults to /dev/dsp.
208 pulse Pulseaudio live audio sound driver. Options:
211 server:value
213 Specifies location of remote or alternate Pulseaudio
214 server.
215 sink:value
217 Specifies a non-default Pulseaudio sink for audio stream.
218 raw Raw file output. Writes raw audio samples to a file. Options:
221 byteorder:value
223 Chooses big endian ("big"), little endian ("little"), or
224 native ("native") byte order. Default is native order.
225 roar Roar Audio Daemon live output driver. Options:
228 host:value
230 Specifies location of remote Roar server to use.
231 sndio OpenBSD SNDIO live output driver. Options:
234 dev:value
236 Specifies audio device to use for playback.
237 sun Sun Audio live output driver for NetBSD, OpenBSD, and Solaris.
240 Options:
241 dev:value
243 Audio device for soundcard. Defaults to /dev/audio.
244 wav WAV file output. Writes the sound data to disk in uncompressed
248 form. If multiple files are played, all of them will be con‐
249 catenated into the same WAV file. WAV files cannot be written
250 to unseekable files, such as standard out. Use the AU format
251 instead.
252 wmm Windows MultiMedia live output driver for Win98 and later.
255 Options:
256 dev:value
258 Selects audio device to use for playback by device name.
259 id:value
261 Selects audio device to use for playback by device id
262 (card number).
263
266 The ogg123 command line is fairly flexible, perhaps confusingly so.
267 Here are some sample command lines and an explanation of what they do.
268 Play on the default soundcard:
270 ogg123 test.ogg
271 Play all of the files in the directory ~/music and its subdirectories.
273 ogg123 ~/music
274 Play a file using the OSS driver:
276 ogg123 -d oss test.ogg
277 Pass the "dsp" option to the OSS driver:
279 ogg123 -d oss -o dsp:/dev/mydsp
280 Use the ESD driver
282 ogg123 -d esd test.ogg
283 Use the WAV driver with the output file, "test.wav":
285 ogg123 -d wav -f test.wav test.ogg
286 Listen to a file while you write it to a WAV file:
288 ogg123 -d oss -d wav -f test.wav test.ogg
289 Note that options apply to the device declared to the left:
291 ogg123 -d oss -o dsp:/dev/mydsp -d raw -f test2.raw -o byte‐
292 order:big test.ogg
293 Stress test your harddrive:
295 ogg123 -d oss -d wav -f 1.wav -d wav -f 2.wav -d wav -f 3.wav -d
296 wav -f 4.wav -d wav -f 5.wav test.ogg
297 Create an echo effect with esd and a slow computer:
299 ogg123 -d esd -d esd test.ogg
300
302 You can abort ogg123 at any time by pressing Ctrl-C. If you are play‐
303 ing multiple files, this will stop the current file and begin playing
304 the next one. If you want to abort playing immediately instead of
305 skipping to the next file, press Ctrl-C within the first second of the
306 playback of a new file.
307 Note that the result of pressing Ctrl-C might not be audible immedi‐
309 ately, due to audio data buffering in the audio device. This delay is
310 system dependent, but it is usually not more than one or two seconds.
311
314 /etc/libao.conf
315 Can be used to set the default output device for all libao pro‐
316 grams.
317 ~/.libao
320 Per-user config file to override the system wide output device
321 settings.
322
324 Piped WAV files may cause strange behavior in other programs. This is
325 because WAV files store the data length in the header. However, the
326 output driver does not know the length when it writes the header, and
327 there is no value that means "length unknown". Use the raw or au out‐
328 put driver if you need to use ogg123 in a pipe.
329
332 Program Authors:
333 Kenneth Arnold <kcarnold-xiph@arnoldnet.net>
334 Stan Seibert <volsung@xiph.org>
335 Manpage Author:
338 Stan Seibert <volsung@xiph.org>
339
342 libao.conf(5), oggenc(1), vorbiscomment(1), ogginfo(1)
343Xiph.Org Foundation 2010 March 24 ogg123(1)