libao documentation |
libao version 1.0.0 - 20100325 |
libao Drivers
Libao supports both live output drivers and file output
drivers. Live output drivers send audio data to sound cards and sound
daemons. File output drivers write audio to disk using a particular
file format (such as WAV, AU, etc.). You must invoke the
ao_open_????() function that corresponds to the type of driver you are
using, but otherwise live and file drivers are treated identically in
libao.
Driver options may be passed to the drivers via the
*options argument to ao_open_live() and ao_open_file(), or they may be set in the
configuration file as name=value
pairs.
Options understood by all Drivers
- "debug" - (value not required) Requests driver print detailed
debugging information.
- "matrix" - Set an output channel mapping similar to the use of the
matrix field in ao_sample_format. The specified
matrix overrides the backend's native channel ordering/numbering. The
channel numbering used by the driver does not necessarily reflect the
physical ordering; for example, the fourth PulseAudio channel is
always 'Center' by default whether the channel physically exists or not.
- "quiet" - (value not required) Requests the driver print no output
whatsoever, even in the event of error.
- "verbose" - (value not required) Requests that the driver print
more detailed information concerning normal operation.
Live Output Drivers
aixs
IBM AIX sound driver. According to the author, "tested on AIX 5.1 with
the Crystal chipsets only (found as internal audio in the 7043-140 and
on the MCA adapter DFE5 (7-6)), but it should work with other AIX
releases and the ACPA also."
Option keys:
- "dev" - The audio device for the sound card. By default, the
driver tries "/dev/baud0/1" (device for MCA machines with the Crystal
chipset). Other possible devices are "/dev/paud0/1" for PCI machines
with the Crystal chipset, and "/dev/acpa0/1" for MCA machines with the
ACPA.
alsa
Advanced Linux Sound Architecture (API versions 0.9.x/1.x.x; earlier
API versions are now deprecated).
Option keys:
- "buffer_time" - Override the default hardware buffer size (in
milliseconds).
- "dev" - ALSA device label to use. Examples include "hw:0" for the
first soundcard and "hw:1" for the second. The alsa driver normally
chooses one of "surround71", "surround51", "surround40" or "default"
automatically depending on number of output channels.
- "period_time" - Override the default hardware period size (in
microseconds).
- "use_mmap" - set to "yes" or "no" to override the compiled-in
default to use or not use mmap device access. In
the past, some buggy alsa drivers have behaved
better when not using mmap access at the penalty
of slightly higher CPU usage.
arts
aRts Sound Daemon live output driver.
Option keys:
- "multi" - set to "yes" to allow opening the aRts playback device
for multiply concurrent playback. Although the driver works properly
in multi mode, it is known to occasionally crash the aRts server
itself. Default behavior is "no".
esd
ESounD audio driver. Although declining in poularity, this sound
daemon is still used on some Linux systems. It permits multiple
programs to play sound simultaneously and sound to be sent to
networked computers.
Option keys:
- "host" - The hostname where esd is running. By default sound is
played on the local host. A port number can be specified after a
colon, as in "whizbang.com:555".
irix
IRIX audio driver. This was inherited from the original
libao, but has not been tested. Use at your own risk. (Better yet,
fix it! I don't have access to an IRIX system.)
macosx
MacOS X AUHAL live output driver. This driver supports MacOS X 10.5
and later (10.4 and earlier uses an earlier, incompatable interface).
Option keys:
- "buffer_time" - Set the hardware buffer size to the equivalent of
value milliseconds.
nas
Network Audio System live output driver.
Option keys:
- "buf_size" - Set size of audio buffer on server in bytes.
- "host" - Set location of NAS server; See nas(1) for format.
null
Null driver. This is just a test device which does not write the
audio data anywhere.
oss
Open Sound System driver. This is the audio system for
older Linux and FreeBSD as well as some other UNIX-like systems.
Option keys:
- "dsp" - The dsp device. By default, the driver tries
"/dev/sound/dsp", followed by "/dev/dsp".
pulse
PulseAudio live audio sound driver. Pulse is a sound server daemon
used by the modern Gnome desktop on UNIX-like systems.
Option keys:
- "server" - Specifies Pulseaudio server to use.
- "sink" - Specifies Pulseaudio sink to use.
roar
Roar Audio live audio sound driver.
Option keys:
- "host" - Specifies Roar server to use.
sndio
SNDIO is the modern audio interface used by OpenBSD.
Option keys:
- "dev" - Specifies audio device to use.
sun
Sun audio driver. This is the audio system for NetBSD, OpenBSD, and
Solaris.
Option keys:
- "dev" - The audio device for the sound card. By default, the
driver tries "/dev/audio".
wmm
Windows MMSound output driver for Win98 and later.
Option keys:
- "dev" - Selects audio device to use for playback by device name.
- "id" - Selects audio device to use for playback by device id (card number).
File Output Drivers
au
Sun audio file driver. Writes a .au file from audio output. This
driver can write usable data to unseekable files (like standard out),
which the wav driver cannot do.
raw
Raw sample driver. Writes the sound to disk in uncompressed,
headerless form using the byte order specified.
Option keys:
- "byteorder" - Byte order used in the output. Use "native" for
native machine byte order, "big" for big-endian order, and "little"
for little-endian order. By default this is "native".
wav
Windows 'WAV' sound file output. Because of the way WAV files are
structured, this driver cannot correct files unless the target file is
seekable. Writing WAVs to stdout will result in broken files. Use
either the raw or the au driver instead.
Default Driver Detection
In the absence of configuration files to
explicit identify a default driver, the library will try to detect a
suitable default driver. It does this by testing every available live
output driver (using ao_plugin_test()) and finding the
driver with the highest priority (see the ao_info struct) that works. Drivers with
priority 0, such as the null and file output drivers, are never
selected as the default.
The ranking system currently used is:
Priority | Drivers |
50 | pulse, roar |
45 | arts* |
40 | esd |
35 | alsa |
30 | macosx, sndio |
20 | aixs, oss, irix, sun, wmm |
15 | arts* |
10 | nas |
0 | null, all file output |
*arts priority depends on whether or not the arts install was built
with HAVE_ARTS_SUSPENDED; when present, the default aRts
priority is 45, else it is 15.
Clearly, any ranking scheme will fail to make everybody happy. For
such cases, the configuration files can be
easily used to define an appropriate default output device.
Adding debug to the libao configuration file on a line by itself will
cause libao to print what static and dynamic drivers are available for
use, as well as print the testing order.
copyright © 2001-2003 Stan Seibert, 2010 Monty |
xiph.org monty@xiph.org |
libao documentation |
libao version 1.0.0 - 20100325 |