ref: cc71cded7690c1fb0912c8e54919cf3462f521d6
parent: c40d5004dd7211d836ac89862f29342668a4d88f
author: Gregory Maxwell <[email protected]>
date: Wed Sep 19 05:43:52 EDT 2012
Replace 'maximum frame size' with 'maximum packet duration' in the docs. This could be confusing/misleading.
--- a/include/opus.h
+++ b/include/opus.h
@@ -447,7 +447,7 @@
* @param [out] pcm <tt>opus_int16*</tt>: Output signal (interleaved if 2 channels). length
* is frame_size*channels*sizeof(opus_int16)
* @param [in] frame_size Number of samples per channel of available space in \a pcm.
- * If this is less than the maximum frame size (120 ms), this function will
+ * If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will
* not be capable of decoding some packets.
* @param [in] decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band forward error correction data be
* decoded. If no such data is available, the frame is decoded as if it were lost.
@@ -468,8 +468,9 @@
* @param [in] len <tt>opus_int32</tt>: Number of bytes in payload
* @param [out] pcm <tt>float*</tt>: Output signal (interleaved if 2 channels). length
* is frame_size*channels*sizeof(float)
- * @param [in] frame_size Number of samples per channel of available space in *pcm,
- * if less than the maximum frame size (120ms) some frames can not be decoded
+ * @param [in] frame_size Number of samples per channel of available space in \a pcm.
+ * If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will
+ * not be capable of decoding some packets.
* @param [in] decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band forward error correction data be
* decoded. If no such data is available the frame is decoded as if it were lost.
* @returns Number of decoded samples or @ref opus_errorcodes
--- a/include/opus_multistream.h
+++ b/include/opus_multistream.h
@@ -535,8 +535,8 @@
* samples.
* @param frame_size <tt>int</tt>: The number of samples per channel of
* available space in \a pcm.
- * If this is less than the maximum frame size
- * (120 ms), this function will not be capable
+ * If this is less than the maximum packet duration
+ * (120 ms; 5760 for 48kHz), this function will not be capable
* of decoding some packets.
* @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band
* forward error correction data be decoded.
@@ -568,8 +568,8 @@
* samples.
* @param frame_size <tt>int</tt>: The number of samples per channel of
* available space in \a pcm.
- * If this is less than the maximum frame size
- * (120 ms), this function will not be capable
+ * If this is less than the maximum packet duration
+ * (120 ms; 5760 for 48kHz), this function will not be capable
* of decoding some packets.
* @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band
* forward error correction data be decoded.