commit 74d43f0a3650c3122f6ec985a815f790f85e8000
author Jean-Marc Valin <jmvalin@jmvalin.ca> Mon Mar 18 17:05:43 2013 -0400
committer Jean-Marc Valin <jmvalin@jmvalin.ca> Mon Mar 18 17:06:43 2013 -0400
tree 69ee4184f305c4e082716ae33d48fa8b5b998d8e
parent 99e8a9352b5af79b10673d3f2e15d1dde047b35f

Minor soft clipping doc fix

include/opus.h

diff --git a/include/opus.h b/include/opus.h
index f3f2eda..a87a445 100644
--- a/include/opus.h
+++ b/include/opus.h
@@ -601,7 +601,7 @@
   * @param [in,out] pcm <tt>float*</tt>: Input PCM and modified PCM
   * @param [in] frame_size <tt>int</tt> Number of samples per channel to process
   * @param [in] channels <tt>int</tt>: Number of channels
-  * @param [in,out] softclip_mem <tt>float*</tt>: State memory for the soft clipping process
+  * @param [in,out] softclip_mem <tt>float*</tt>: State memory for the soft clipping process (one float per channel, initialized to zero)
   */
 OPUS_EXPORT void opus_pcm_soft_clip(float *pcm, int frame_size, int channels, float *softclip_mem);