diff options
| author | Jean-Marc Valin <jmvalin@jmvalin.ca> | 2012-12-04 15:07:45 -0500 |
|---|---|---|
| committer | Jean-Marc Valin <jmvalin@jmvalin.ca> | 2012-12-04 15:07:45 -0500 |
| commit | 7fcd66c40d0257796c912a6f500a98cbea89e704 (patch) | |
| tree | fd4f7464453c559e34ad0080ba114bef0a4d5363 /include | |
| parent | 124f69b00ca3dae73b1815985b0a83c30934afa6 (diff) | |
| download | libopus-7fcd66c40d0257796c912a6f500a98cbea89e704.tar.gz | |
Changes the PLC behaviour and fixes the FEC behaviour on concatenated packets
PLC and FEC now return exactly the number of samples specified for the
buffer rather than (usually) returning the size of the last packet.
Doc and tests are updated accordingly.
Diffstat (limited to 'include')
| -rw-r--r-- | include/opus.h | 10 | ||||
| -rw-r--r-- | include/opus_multistream.h | 14 |
2 files changed, 20 insertions, 4 deletions
diff --git a/include/opus.h b/include/opus.h index ccf3e201..623662d5 100644 --- a/include/opus.h +++ b/include/opus.h @@ -451,7 +451,10 @@ OPUS_EXPORT int opus_decoder_init( * 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 packet duration (120ms; 5760 for 48kHz), this function will - * not be capable of decoding some packets. + * not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), + * then frame_size needs to be exactly the duration of audio that is missing, otherwise the + * decoder will not be in the optimal state to decode the next incoming packet. For the PLC and + * FEC cases, frame_size <b>must</b> be a multiple of 2.5 ms. * @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 @@ -473,7 +476,10 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode( * is frame_size*channels*sizeof(float) * @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. + * not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), + * then frame_size needs to be exactly the duration of audio that is missing, otherwise the + * decoder will not be in the optimal state to decode the next incoming packet. For the PLC and + * FEC cases, frame_size <b>must</b> be a multiple of 2.5 ms. * @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 diff --git a/include/opus_multistream.h b/include/opus_multistream.h index bd816b45..658067f7 100644 --- a/include/opus_multistream.h +++ b/include/opus_multistream.h @@ -541,7 +541,12 @@ OPUS_EXPORT int opus_multistream_decoder_init( * available space in \a pcm. * If this is less than the maximum packet duration * (120 ms; 5760 for 48kHz), this function will not be capable - * of decoding some packets. + * of decoding some packets. In the case of PLC (data==NULL) + * or FEC (decode_fec=1), then frame_size needs to be exactly + * the duration of audio that is missing, otherwise the + * decoder will not be in the optimal state to decode the + * next incoming packet. For the PLC and FEC cases, frame_size + * <b>must</b> be a multiple of 2.5 ms. * @param 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 @@ -574,7 +579,12 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_decode( * available space in \a pcm. * If this is less than the maximum packet duration * (120 ms; 5760 for 48kHz), this function will not be capable - * of decoding some packets. + * of decoding some packets. In the case of PLC (data==NULL) + * or FEC (decode_fec=1), then frame_size needs to be exactly + * the duration of audio that is missing, otherwise the + * decoder will not be in the optimal state to decode the + * next incoming packet. For the PLC and FEC cases, frame_size + * <b>must</b> be a multiple of 2.5 ms. * @param 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 |