[FFmpeg-cvslog] lavf: properly document the distinction between flags and ctx_flags

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Thu May  1 10:03:54 2014 +0200| [a738540366c9b114949b7914c0d08e2c28982cfb] | committer: Anton Khirnov

lavf: properly document the distinction between flags and ctx_flags

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

 libavformat/avformat.h |   10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 02ee6ba..1ce3eba 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -927,7 +927,11 @@ typedef struct AVFormatContext {
     AVIOContext *pb;
 
     /* stream info */
-    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
+    /**
+     * Flags signalling stream properties. A combination of AVFMTCTX_*.
+     * Set by libavformat.
+     */
+    int ctx_flags;
 
     /**
      * Number of elements in AVFormatContext.streams.
@@ -985,6 +989,10 @@ typedef struct AVFormatContext {
     unsigned int packet_size;
     int max_delay;
 
+    /**
+     * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
+     * Set by the user before avformat_open_input() / avformat_write_header().
+     */
     int flags;
 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.