Add README

Add README for jack and oss plugins.

4 files changed, 83 insertions, 0 deletions

diff --git a/pcm/jack/Makefile.am b/pcm/jack/Makefile.am
index 63dc500..e71ce65 100644
--- a/pcm/jack/Makefile.am
+++ b/pcm/jack/Makefile.am
@@ -6,3 +6,5 @@ AM_CFLAGS = -Wall -g @ALSA_CFLAGS@ @JACK_CFLAGS@
 libasound_module_pcm_jack_la_SOURCES = pcm_jack.c
 libasound_module_pcm_jack_la_LDFLAGS = -module -avoid-version -export-dynamic
 libasound_module_pcm_jack_la_LIBADD = @ALSA_LIBS@ @JACK_LIBS@
+
+EXTRA_DIST = README
diff --git a/pcm/jack/README b/pcm/jack/README
new file mode 100644
index 0000000..4579174
--- /dev/null
+++ b/pcm/jack/README
@@ -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/pcm/oss/Makefile.am b/pcm/oss/Makefile.am
index ac38a87..c907231 100644
--- a/pcm/oss/Makefile.am
+++ b/pcm/oss/Makefile.am
@@ -6,3 +6,5 @@ AM_CFLAGS = -Wall -g @ALSA_CFLAGS@
 libasound_module_pcm_oss_la_SOURCES = pcm_oss.c
 libasound_module_pcm_oss_la_LDFLAGS = -module -avoid-version -export-dynamic
 libasound_module_pcm_oss_la_LIBADD = @ALSA_LIBS@
+
+EXTRA_DIST = README
diff --git a/pcm/oss/README b/pcm/oss/README
new file mode 100644
index 0000000..42b73cb
--- /dev/null
+++ b/pcm/oss/README
@@ -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.