[FFmpeg-cvslog] lavc: expand doxy for AV_CODEC_FLAG_RECON_FRAME

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Fri Mar 24 10:03:39 2023 +0100| [83eb52323c5a2664a9802cb8fc3fc2784c733dfb] | committer: Anton Khirnov

lavc: expand doxy for AV_CODEC_FLAG_RECON_FRAME

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

 libavcodec/avcodec.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index d1bcb3026c..7a6eb4c0e2 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -239,6 +239,15 @@ typedef struct RcOverride{
  *
  * Should only be used with encoders flagged with the
  * @ref AV_CODEC_CAP_ENCODER_RECON_FRAME capability.
+ *
+ * @note
+ * Each reconstructed frame returned by the encoder corresponds to the last
+ * encoded packet, i.e. the frames are returned in coded order rather than
+ * presentation order.
+ *
+ * @note
+ * Frame parameters (like pixel format or dimensions) do not have to match the
+ * AVCodecContext values. Make sure to use the values from the returned frame.
  */
 #define AV_CODEC_FLAG_RECON_FRAME     (1 <<  6)
 /**