update to use Speex 1.1.x features and doc cleanups (issue #4755)

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6426 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 53 insertions, 12 deletions

diff --git a/configs/codecs.conf.sample b/configs/codecs.conf.sample
index ec3c496e3..6918b2907 100755
--- a/configs/codecs.conf.sample
+++ b/configs/codecs.conf.sample
@@ -1,21 +1,62 @@
 [speex]
-;0-10
+; CBR encoding quality [0..10]
+; used only when vbr = false
 quality => 3
-;0-10
-complexity => 4
-; true / false
+
+; codec complexity [0..10]
+; tradeoff between cpu/quality
+complexity => 2
+
+; perceptual enhancement [true / false]
+; improves clarity of decoded speech
 enhancement => true
-; true / false
-vad => false
-; true / false
-vbr => false
-; 0 = off, otherwise, target bitrate in bps
+
+; voice activity detection [true / false]
+; reduces bitrate when no voice detected, used only for CBR (implicit in VBR/ABR)
+vad => true
+
+; variable bit rate [true / false]
+; uses bit rate proportionate to voice complexity
+vbr => true
+
+; available bit rate [bps, 0 = off]
+; encoding quality modulated to match this target bit rate
+; not recommended with dtx or pp_vad - may cause bandwidth spikes
 abr => 0
-;0-10
-vbr_quality => 5
-; true / false
+
+; VBR encoding quality [0-10]
+; floating-point values allowed
+vbr_quality => 4
+
+; discontinuous transmission [true / false]
+; stops transmitting completely when silence is detected
+; pp_vad is far more effective but more CPU intensive
 dtx => false
 
+; preprocessor configuration
+; these options only affect Speex v1.1.8 or newer
+
+; enable preprocessor [true / false]
+; allows dsp functionality below but incurs CPU overhead
+preprocess => false
+
+; preproc voice activity detection [true / false]
+; more advanced equivalent of DTX, based on voice frequencies
+pp_vad => false
+
+; preproc automatic gain control [true / false]
+pp_agc => false
+pp_agc_level => 8000
+
+; preproc denoiser [true / false]
+pp_denoise => false
+
+; preproc dereverb [true / false]
+pp_dereverb => false
+pp_dereverb_decay => 0.4
+pp_dereverb_level => 0.3
+
+
 [plc]
 ; for all codecs which do not support native PLC
 ; this determines whether to perform generic PLC