diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 1 | ||||
-rw-r--r-- | doc/README-jack | 46 | ||||
-rw-r--r-- | doc/README-pcm-oss | 33 |
3 files changed, 80 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..a431171 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1 @@ +EXTRA_DIST = README-pcm-oss diff --git a/doc/README-jack b/doc/README-jack new file mode 100644 index 0000000..4579174 --- /dev/null +++ b/doc/README-jack @@ -0,0 +1,46 @@ +JACK <--> ALSA PCM plugin +========================= + +This plugin converts the ALSA API over JACK (Jack Audio Connection +Kit, http://jackit.sf.net) API. ALSA native applications can work +transparently together with jackd for both playback and capture. + + ALSA apps (playback) -> ALSA-lib -> JACK plugin -> JACK deamon + ALSA apps (capture) <- ALSA-lib <- JACK plugin <- JACK daemon + +This plugin provides the PCM type "jack". The typical configuration +looks like below: + + pcm.jack { + type jack + playback_ports { + 0 alsa_pcm:playback_1 + 1 alsa_pcm:playback_1 + } + capture_ports { + 0 alsa_pcm:capture_1 + 1 alsa_pcm:pcapture_1 + } + } + +Put the above to ~/.asoundrc (or /etc/asound.conf), and use "jack" PCM +with your ALSA apps. For example, + + % aplay -Djack foo.wav + +The jack plugin can have two config options: playback_ports and +capture_ports. Both are compound type config, including the following +format: + { + channel port-name + channel port-name + ... + } +The first argument is the channel number (zero-based) and the second +is the corresponding JACK port name. + +The plugin is installed in /usr/lib/alsa-lib directory as default, +which is the default search path of additional plugins for alsa-lib. +On a 64bit system like x86-64, the proper prefix option (typically, +--prefix=/usr/lib64) must be given to configure script. + diff --git a/doc/README-pcm-oss b/doc/README-pcm-oss new file mode 100644 index 0000000..42b73cb --- /dev/null +++ b/doc/README-pcm-oss @@ -0,0 +1,33 @@ +OSS <--> ALSA PCM plugin +======================== + +This plugin converts the ALSA API over OSS API. With this plugin, +ALSA native apps can run on OSS drivers. + +This plugin provides the PCM type "oss". The typical configuration +looks like below: + + pcm.oss { + type oss + device /dev/dsp + } + +Put the above to ~/.asoundrc (or /etc/asound.conf), and use "oss" PCM +with your ALSA apps. For example, + + % aplay -Doss foo.wav + +For playing arbitrary formats, you should use "plug" layer together, + + % aplay -Dplug:oss foo.wav + +The oss plugin can have an option: device. This specifies the device +file path of OSS to open. If not given, /dev/dsp is used. + +The function supported by this plugin is limited. For example, you +cannot use dmix together with this plugin. Don't expect too much :) + +The plugin is installed in /usr/lib/alsa-lib directory as default, +which is the default search path of additional plugins for alsa-lib. +On a 64bit system like x86-64, the proper prefix option (typically, +--prefix=/usr/lib64) must be given to configure script. |