avcodec: add CODEC_CAP_DELAY note to avcodec_decode_audio3() documentation
authorJustin Ruggles <justin.ruggles@gmail.com>
Sun, 25 Sep 2011 21:09:57 +0000 (17:09 -0400)
committerJustin Ruggles <justin.ruggles@gmail.com>
Thu, 20 Oct 2011 17:30:08 +0000 (13:30 -0400)
libavcodec/avcodec.h

index 623da5e..a5fd2e7 100644 (file)
@@ -3832,6 +3832,10 @@ int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options)
  * samples should be 16 byte aligned unless the CPU doesn't need it
  * (AltiVec and SSE do).
  *
+ * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
+ * between input and output, these need to be fed with avpkt->data=NULL,
+ * avpkt->size=0 at the end to return the remaining frames.
+ *
  * @param avctx the codec context
  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
  * @param[in,out] frame_size_ptr the output buffer size in bytes