summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTakashi Iwai <tiwai@suse.de>2006-04-06 17:37:13 +0200
committerTakashi Iwai <tiwai@suse.de>2006-04-06 17:37:13 +0200
commit74bdac50b257b986cea38a2c08134c430fc5654f (patch)
tree5e30207026f4f777edb21f6bd729087f5e0a3c4c /doc
parent423a6f3c7be331984ec74587bf278204d19a4467 (diff)
Add samplerate rate converter plugin
Added a rate converter pluging using libsamplerate. The plugin is built only when libsamplerate is detected by configure. See doc/samplerate.txt for usage. This plugin is released under GPL (to follow the license of libsamplerate), not LGPL.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/samplerate.txt30
2 files changed, 31 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index dfb40b3..5a3b4a3 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,2 +1,2 @@
EXTRA_DIST = README-pcm-oss README-jack README-polyp \
- upmix.txt vdownmix.txt
+ upmix.txt vdownmix.txt samplerate.txt
diff --git a/doc/samplerate.txt b/doc/samplerate.txt
new file mode 100644
index 0000000..4c4fcfb
--- /dev/null
+++ b/doc/samplerate.txt
@@ -0,0 +1,30 @@
+Rate Converter Plugin Using Libsamplerate
+=========================================
+
+The plugin in rate subdirectory is an external rate converter using
+libsamplerate by Erik de Castro Lopo. You can use this rate converter
+plugin by defining a rate PCM with "converter" parameter, such as:
+
+ pcm.my_rate {
+ type rate
+ slave.pcm "hw"
+ converter "samplerate"
+ }
+
+The plug plugin has also a similar field, "rate_converter".
+
+Or, more easily, define a global variable "defaults.pcm.rate_converter",
+which is used as the default converter type by plug and rate plugins:
+
+ defaults.pcm.rate_converter "samplerate"
+
+Write the above in your ~/.asoundrc or /etc/asound.conf.
+
+The following converter types are available:
+
+ - samplerate_best Use SRC_SINC_BEST_QUALITY
+ - samplerate_medium Use SRC_SINC_MEDIUM_QUALITY
+ - samplerate Use SRC_SINC_FASTEST
+ - samplerate_order Use SRC_ZERO_ORDER_HOLD
+ - samplerate_linear Use SRC_LINEAR
+