eden-emu/opus
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Replace 'maximum frame size' with 'maximum packet duration' in the docs.

Browse source 
This could be confusing/misleading.
This commit is contained in:
Gregory Maxwell 2012-09-19 09:43:52 -04:00
parent c40d5004dd
commit cc71cded76
2 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/opus.h
View file

@ -447,7 +447,7 @@ OPUS_EXPORT int opus_decoder_init(
* @param [out] pcm <tt>opus_int16*</tt>: Output signal (interleaved if 2 channels). length * @param [out] pcm <tt>opus_int16*</tt>: Output signal (interleaved if 2 channels). length
* is frame_size*channels*sizeof(opus_int16) * is frame_size*channels*sizeof(opus_int16)
* @param [in] frame_size Number of samples per channel of available space in \a pcm. * @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. * 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 * @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. * decoded. If no such data is available, the frame is decoded as if it were lost.
@ -468,8 +468,9 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode(
* @param [in] len <tt>opus_int32</tt>: Number of bytes in payload * @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 * @param [out] pcm <tt>float*</tt>: Output signal (interleaved if 2 channels). length
* is frame_size*channels*sizeof(float) * is frame_size*channels*sizeof(float)
* @param [in] frame_size Number of samples per channel of available space in *pcm, * @param [in] frame_size Number of samples per channel of available space in \a pcm.
* if less than the maximum frame size (120ms) some frames can not be decoded * 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 * @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. * 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 * @returns Number of decoded samples or @ref opus_errorcodes

8
include/opus_multistream.h
View file

@ -535,8 +535,8 @@ OPUS_EXPORT int opus_multistream_decoder_init(
* samples. * samples.
* @param frame_size <tt>int</tt>: The number of samples per channel of * @param frame_size <tt>int</tt>: The number of samples per channel of
* available space in \a pcm. * available space in \a pcm.
* If this is less than the maximum frame size * If this is less than the maximum packet duration
* (120 ms), this function will not be capable * (120 ms; 5760 for 48kHz), this function will not be capable
* of decoding some packets. * of decoding some packets.
* @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band * @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band
* forward error correction data be decoded. * forward error correction data be decoded.
@ -568,8 +568,8 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_decode(
* samples. * samples.
* @param frame_size <tt>int</tt>: The number of samples per channel of * @param frame_size <tt>int</tt>: The number of samples per channel of
* available space in \a pcm. * available space in \a pcm.
* If this is less than the maximum frame size * If this is less than the maximum packet duration
* (120 ms), this function will not be capable * (120 ms; 5760 for 48kHz), this function will not be capable
* of decoding some packets. * of decoding some packets.
* @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band * @param decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band
* forward error correction data be decoded. * forward error correction data be decoded.