1ogg123(1)                        Vorbis Tools                        ogg123(1)
2
3
4

NAME

6       ogg123 - plays Ogg Vorbis files
7
8

SYNOPSIS

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
14

DESCRIPTION

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
23

OPTIONS

25       --audio-buffer n
26              Use an output audio buffer of approximately 'n' kilobytes.
27
28       -@ 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
34       -b n, --buffer n
35              Use an input buffer of approximately 'n' kilobytes.
36
37       -p n, --prebuffer n
38              Prebuffer 'n' percent of the input buffer.  Playback won't begin
39              until this prebuffer is complete.
40
41       -d device, --device device
42              Specify output device.   See  DEVICES  section  for  a  list  of
43              devices.  Any number of devices may be specified.
44
45       -f filename, --file filename
46              Specify  output  file for file devices.  The filename "-" writes
47              to standard out.  If the file already exists, ogg123 will  over‐
48              write it.
49
50       -h, --help
51              Show command help.
52
53       -k n, --skip n
54              Skip  the first 'n' seconds.  'n' may also be in minutes:seconds
55              or hours:minutes:seconds form.
56
57       -K n, --end n
58              Stops playing 'n' seconds from the start of the stream.  'n' may
59              also have the same format as used in the --skip option.
60
61       -o option:value, --device-option option:value
62              Assigns  the  option  option  to value for the preceding device.
63              See DEVICES for a list of valid options for each device.
64
65       -q, --quiet
66              Quiet mode.  No messages are displayed.
67
68       -V, --version
69              Display version information.
70
71       -v, --verbose
72              Increase verbosity.
73
74       -x n, --nth
75              Play every 'n'th decoded block.  Has the effect of playing audio
76              at 'n' times faster than normal speed.
77
78       -y n, --ntimes
79              Repeat  every played block 'n' times.  Has the effect of playing
80              audio 'n' times slower than normal speed.  May be  with  -x  for
81              interesting fractional speeds.
82
83       -r, --repeat
84              Repeat playlist indefinitely.
85
86       -z, --shuffle
87              Play files in pseudo-random order.
88
89       -Z, --random
90              Play files in pseudo-random order forever.
91
92

DEVICES

94       ogg123  supports a variety of audio output devices through libao.  Only
95       those devices supported by the target platform will be available.   The
96       -f option may only be used with devices that write to files.
97
98
99       null   Null driver.  All audio data is discarded.  (Note: Audio data is
100              not written to /dev/null !)  You could use this driver  to  test
101              raw decoding speed without output overhead.
102
103
104       alsa   Advanced Linux Sound Architecture.
105              Options:
106
107                     dev    ALSA  device  label  to use. The system default is
108                            used by default.   Examples  include  "plughw:0,0"
109                            for  the first soundcard, and "plughw:1,0" for the
110                            second.     For     more     information,      see
111                            http://alsa.opensrc.org/ALSA+device+labels
112
113                     buf_size
114                            Override the default buffer size (in bytes).
115
116
117       arts   aRts Sound Daemon.
118
119
120       esd    Enlightened Sound Daemon.
121              Options:
122
123                     host   The  hostname  where  esd  is  running.   This can
124                            include  a  port  number  after  a  colon,  as  in
125                            "whizbang.com:555".  (Default = localhost)
126
127
128       irix   IRIX audio driver.
129
130
131       oss    Open Sound System driver for Linux and FreeBSD.
132              Options:
133
134                     dsp    DSP device for soundcard.  Defaults to /dev/dsp.
135
136
137       sun    Sun Audio driver for NetBSD, OpenBSD, and Solaris.
138              Options:
139
140                     dev    Audio   device   for   soundcard.    Defaults   to
141                            /dev/audio.
142
143
144       au     Sun audio file output.  Writes the audio samples in  AU  format.
145              The  AU  format supports writing to unseekable files, like stan‐
146              dard out.  In such circumstances, the AU header will specify the
147              sample format, but not the length of the recording.
148
149
150       raw    Raw sample output.  Writes raw audio samples to a file.
151              Options:
152
153                     byteorder
154                            Choose  big  endian, little endian, or native byte
155                            order.  (Default = "native")
156
157
158       wav    WAV file output.  Writes the sound data to disk in  uncompressed
159              form.   If  multiple  files are played, all of them will be con‐
160              catenated into the same WAV file.  WAV files cannot  be  written
161              to  unseekable  files,  such as standard out.  Use the AU format
162              instead.
163
164
165

EXAMPLES

167       The ogg123 command line is fairly  flexible,  perhaps  confusingly  so.
168       Here are some sample command lines and an explanation of what they do.
169
170       Play on the default soundcard:
171              ogg123 test.ogg
172
173       Play all of the files in the directory ~/music and its subdirectories.
174              ogg123 ~/music
175
176       Play a file using the OSS driver:
177              ogg123 -d oss test.ogg
178
179       Pass the "dsp" option to the OSS driver:
180              ogg123 -d oss -o dsp:/dev/mydsp
181
182       Use the ESD driver
183              ogg123 -d esd test.ogg
184
185       Use the WAV driver with the output file, "test.wav":
186              ogg123 -d wav -f test.wav test.ogg
187
188       Listen to a file while you write it to a WAV file:
189              ogg123 -d oss -d wav -f test.wav test.ogg
190
191       Note that options apply to the device declared to the left:
192              ogg123  -d  oss  -o  dsp:/dev/mydsp -d raw -f test2.raw -o byte‐
193              order:big test.ogg
194
195       Stress test your harddrive:
196              ogg123 -d oss -d wav -f 1.wav -d wav -f 2.wav -d wav -f 3.wav -d
197              wav -f 4.wav -d wav -f 5.wav test.ogg
198
199       Create an echo effect with esd and a slow computer:
200              ogg123 -d esd -d esd test.ogg
201

INTERRUPT

203       You  can abort ogg123 at any time by pressing Ctrl-C.  If you are play‐
204       ing multiple files, this will stop the current file and  begin  playing
205       the  next  one.   If  you  want to abort playing immediately instead of
206       skipping to the next file, press Ctrl-C within the first second of  the
207       playback of a new file.
208
209       Note  that  the  result of pressing Ctrl-C might not be audible immedi‐
210       ately, due to audio data buffering in the audio device.  This delay  is
211       system dependent, but it is usually not more than one or two seconds.
212
213

FILES

215       /etc/libao.conf
216              Can  be used to set the default output device for all libao pro‐
217              grams.
218
219
220       ~/.libao
221              Per-user config file to override the system wide  output  device
222              settings.
223

BUGS

225       Piped  WAV files may cause strange behavior in other programs.  This is
226       because WAV files store the data length in the  header.   However,  the
227       output  driver  does not know the length when it writes the header, and
228       there is no value that means "length unknown".  Use the raw or au  out‐
229       put driver if you need to use ogg123 in a pipe.
230
231

AUTHORS

233       Program Authors:
234              Kenneth Arnold <kcarnold-xiph@arnoldnet.net>
235              Stan Seibert <volsung@xiph.org>
236
237
238       Manpage Author:
239              Stan Seibert <volsung@xiph.org>
240
241

SEE ALSO

243       libao.conf(5), oggenc(1), vorbiscomment(1), ogginfo(1)
244
245
246
247
248Xiph.org Foundation            2003 September 1                      ogg123(1)
Impressum