From 74d43f0a3650c3122f6ec985a815f790f85e8000 Mon Sep 17 00:00:00 2001
From: Jean-Marc Valin <jmvalin@jmvalin.ca>
Date: Mon, 18 Mar 2013 17:05:43 -0400
Subject: [PATCH] Minor soft clipping doc fix

---
 include/opus.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/opus.h b/include/opus.h
index f3f2eda5c..a87a44562 100644
--- a/include/opus.h
+++ b/include/opus.h
@@ -601,7 +601,7 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_nb_samples(const OpusDe
   * @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);
 
-- 
GitLab