Document the need of buf=NULL buf_size=0 at the end to obtain all frames.
authorMichael Niedermayer <michaelni@gmx.at>
Wed, 7 Jan 2009 19:55:08 +0000 (19:55 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Wed, 7 Jan 2009 19:55:08 +0000 (19:55 +0000)
Originally committed as revision 16482 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/avcodec.h

index 40dc4ac..3d3e244 100644 (file)
@@ -2797,6 +2797,9 @@ int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
  * the linesize is not a multiple of 16 then there's no sense in aligning the
  * start of the buffer to 16.
  *
+ * @note Some codecs have a delay between input and output, these need to be
+ * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
+ *
  * @param avctx the codec context
  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  * @param[in] buf the input buffer