lavf doxy: expand AVStream.codec doxy.
authorAnton Khirnov <anton@khirnov.net>
Thu, 15 Mar 2012 10:27:47 +0000 (11:27 +0100)
committerAnton Khirnov <anton@khirnov.net>
Mon, 26 Mar 2012 08:59:43 +0000 (10:59 +0200)
libavformat/avformat.h

index 98cfee1..cd7ece8 100644 (file)
@@ -610,7 +610,18 @@ typedef struct AVStream {
      * encoding: set by the user
      */
     int id;
-    AVCodecContext *codec; /**< codec context */
+    /**
+     * Codec context associated with this stream. Allocated and freed by
+     * libavformat.
+     *
+     * - decoding: The demuxer exports codec information stored in the headers
+     *             here.
+     * - encoding: The user sets codec information, the muxer writes it to the
+     *             output. Mandatory fields as specified in AVCodecContext
+     *             documentation must be set even if this AVCodecContext is
+     *             not actually used for encoding.
+     */
+    AVCodecContext *codec;
     /**
      * Real base framerate of the stream.
      * This is the lowest framerate with which all timestamps can be