summaryrefslogtreecommitdiff
path: root/libavcodec
diff options
context:
space:
mode:
authorJustin Ruggles <justin.ruggles@gmail.com>2011-09-25 17:09:57 -0400
committerJustin Ruggles <justin.ruggles@gmail.com>2011-10-20 13:30:08 -0400
commit68d3aec819138183cedb11cd2783a830bc3a3866 (patch)
tree94e544f0a2d2ff2a0a28ac67570a7d38c724cbf4 /libavcodec
parent352fc5f1286bff600890903bf4a1eb0ce0842fdc (diff)
avcodec: add CODEC_CAP_DELAY note to avcodec_decode_audio3() documentation
Diffstat (limited to 'libavcodec')
-rw-r--r--libavcodec/avcodec.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 623da5e166..a5fd2e7386 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