[asterisk-commits] tilghman: trunk r158857 - /trunk/main/dsp.c

[SVN commits to the Asterisk project]

Author: tilghman
Date: Mon Nov 24 15:52:34 2008
New Revision: 158857

URL: http://svn.digium.com/view/asterisk?view=rev&rev=158857
Log:
Add a bit of documentation (thanks, I-MOD) on what the silence threshold
constant actually does and what values are valid for it.

Modified:
    trunk/main/dsp.c

Modified: trunk/main/dsp.c
URL: http://svn.digium.com/view/asterisk/trunk/main/dsp.c?view=diff&rev=158857&r1=158856&r2=158857
==============================================================================
--- trunk/main/dsp.c (original)
+++ trunk/main/dsp.c Mon Nov 24 15:52:34 2008
@@ -105,6 +105,13 @@
 	{ 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 {