From: Anton Khirnov <anton@khirnov.net>
Date: Thu, 15 Mar 2012 10:27:47 +0000 (+0100)
Subject: lavf doxy: expand AVStream.codec doxy.
X-Git-Tag: android-x86-4.4-r1~8529^2~2445
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=967923abd15b58a0029c36e5a0be7de108b0deb7;p=android-x86%2Fexternal-ffmpeg.git

lavf doxy: expand AVStream.codec doxy.
---

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 98cfee1173..cd7ece8458 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -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