diff mbox series

[FFmpeg-devel] lavu/frame: extend AVFrame.opaque documentation

Message ID 20210126155954.912-1-anton@khirnov.net
State New
Headers show
Series [FFmpeg-devel] lavu/frame: extend AVFrame.opaque documentation
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Anton Khirnov Jan. 26, 2021, 3:59 p.m. UTC
---
 libavutil/frame.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/libavutil/frame.h b/libavutil/frame.h
index 392315f40f..f3e664bbc9 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -437,7 +437,12 @@  typedef struct AVFrame {
     int quality;
 
     /**
-     * for some private data of the user
+     * Frame owner's private data.
+     *
+     * This field may be set by the code that allocates/owns the frame data.
+     * It is then not touched by any library functions, except:
+     * - it is copied to other references by av_frame_ref()
+     * - it is set to NULL when the frame is cleared by av_frame_unref()
      */
     void *opaque;