From: Tilghman Lesher <tilghman@meg.abyt.es>
Date: Mon, 24 Nov 2008 21:52:34 +0000 (+0000)
Subject: Add a bit of documentation (thanks, I-MOD) on what the silence threshold
X-Git-Tag: 1.6.2.0-beta1~785
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=455284ebc1ac276f5d7a93c636ca18530628d14c;p=thirdparty%2Fasterisk.git

Add a bit of documentation (thanks, I-MOD) on what the silence threshold
constant actually does and what values are valid for it.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@158857 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/main/dsp.c b/main/dsp.c
index e5db83cd55..6963bda2c2 100644
--- a/main/dsp.c
+++ b/main/dsp.c
@@ -105,6 +105,13 @@ static struct progress {
 	{ GSAMP_SIZE_UK, { 400 } },                                	/*!< UK */
 };
 
+/*!\brief This value is the minimum threshold, calculated by averaging all
+ * of the samples within a frame, for which a frame is determined to either
+ * be silence (below the threshold) or noise (above the threshold).  Please
+ * note that while the default threshold is an even exponent of 2, there is
+ * no requirement that it be so.  The threshold will accept any value between
+ * 0 and 32767.
+ */
 #define DEFAULT_THRESHOLD	512
 
 enum busy_detect {