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 e5db83c..6963bda 100644 (file)
--- 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 {