From 3bc4e21b7b434906f119eeb2fd955f400222c1ee Mon Sep 17 00:00:00 2001 From: Michael Niedermayer Date: Thu, 3 Jun 2010 21:53:41 +0000 Subject: [PATCH] Document the frames returned by the decoder better. Originally committed as revision 23456 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavcodec/avcodec.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index b37329d35c..c6a1bc3278 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -3501,6 +3501,11 @@ attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *pi * @param[out] picture The AVFrame in which the decoded video frame will be stored. * Use avcodec_alloc_frame to get an AVFrame, the codec will * allocate memory for the actual bitmap. + * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit. + * with overridden get/release_buffer() the user decides into what buffer the decoder + * decodes and the decoder tells the user once it does not need the data anymore, + * the user app can at this point free/reuse/keep the memory as it sees fit. + * * @param[in] avpkt The input AVpacket containing the input buffer. * You can create such packet with av_init_packet() and by then setting * data and size, some decoders might in addition need other fields like