[FFmpeg-cvslog] avcodec: add CODEC_CAP_DELAY note to avcodec_decode_audio3() documentation

[Justin Ruggles]

ffmpeg | branch: master | Justin Ruggles <justin.ruggles at gmail.com> | Sun Sep 25 17:09:57 2011 -0400| [68d3aec819138183cedb11cd2783a830bc3a3866] | committer: Justin Ruggles

avcodec: add CODEC_CAP_DELAY note to avcodec_decode_audio3() documentation

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=68d3aec819138183cedb11cd2783a830bc3a3866
---

 libavcodec/avcodec.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 623da5e..a5fd2e7 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -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