diff mbox series

[FFmpeg-devel,6/7] lavc: expand doxy for AV_CODEC_FLAG_RECON_FRAME

Message ID 20230324091451.20895-6-anton@khirnov.net
State Accepted
Commit 83eb52323c5a2664a9802cb8fc3fc2784c733dfb
Headers show
Series [FFmpeg-devel,RFC,1/7] lavc/mpegvideo_enc: support AV_CODEC_CAP_ENCODER_RECON_FRAME | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Anton Khirnov March 24, 2023, 9:14 a.m. UTC 
---
 libavcodec/avcodec.h | 9 +++++++++
 1 file changed, 9 insertions(+)
diff mbox series

Patch

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)
 /**