From 9a4eb9e7e5b8b9487c1ca1790e2276685c928598 Mon Sep 17 00:00:00 2001 From: Takashi Iwai Date: Wed, 7 Mar 2007 18:16:30 +0100 Subject: Add documentation for speex rate plugin Added the documentation for speex rate plugin. From: Jean-Marc Valin --- doc/Makefile.am | 3 ++- doc/speexrate.txt | 29 +++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 doc/speexrate.txt (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 5eda3bd..41a7ebe 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,2 +1,3 @@ EXTRA_DIST = README-pcm-oss README-jack README-pulse README-maemo \ - upmix.txt vdownmix.txt samplerate.txt a52.txt lavcrate.txt + upmix.txt vdownmix.txt samplerate.txt a52.txt lavcrate.txt \ + speexrate.txt diff --git a/doc/speexrate.txt b/doc/speexrate.txt new file mode 100644 index 0000000..9f86e03 --- /dev/null +++ b/doc/speexrate.txt @@ -0,0 +1,29 @@ +Rate Converter Plugin Using Speex Resampler +=========================================== + +The plugin in rate subdirectory is an external rate converter using +the Speex resampler (aka Public Parrot Hack) by Jean-Marc Valin. 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 "speexrate" + } + +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 "speexrate" + +Write the above in your ~/.asoundrc or /etc/asound.conf. + +The following converter types are available: + + - speexrate_best Use quality 10 (equivalent to SRC_SINC_BEST_QUALITY) + - speexrate_medium Use quality 5 (equivalent to SRC_SINC_MEDIUM_QUALITY) + - speexrate Use quality 3 (equivalent to SRC_SINC_FASTEST) + -- cgit