Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.xiph.org/xiph/opus.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Marc Valin <jmvalin@jmvalin.ca>2013-03-19 01:05:43 +0400
committerJean-Marc Valin <jmvalin@jmvalin.ca>2013-03-19 01:06:43 +0400
commit74d43f0a3650c3122f6ec985a815f790f85e8000 (patch)
tree69ee4184f305c4e082716ae33d48fa8b5b998d8e /include
parent99e8a9352b5af79b10673d3f2e15d1dde047b35f (diff)
Minor soft clipping doc fix
Diffstat (limited to 'include')
-rw-r--r--include/opus.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/opus.h b/include/opus.h
index f3f2eda5..a87a4456 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);