changeset 11822:8cd526e30b06 libavcodec

Document the frames returned by the decoder better.
author michael
date Thu, 03 Jun 2010 21:53:41 +0000
parents 9f7414707aa8
children c9ef45275db0
files avcodec.h
diffstat 1 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/avcodec.h	Thu Jun 03 20:47:59 2010 +0000
+++ b/avcodec.h	Thu Jun 03 21:53:41 2010 +0000
@@ -3501,6 +3501,11 @@
  * @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