summaryrefslogtreecommitdiff
path: root/libavformat
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2012-03-15 11:27:47 +0100
committerAnton Khirnov <anton@khirnov.net>2012-03-26 10:59:43 +0200
commit967923abd15b58a0029c36e5a0be7de108b0deb7 (patch)
tree272fd3d6846f1894f3c7597e7b85376759bf81e1 /libavformat
parente44ada129c4c39852d5b178bf9a553b39f32655c (diff)
lavf doxy: expand AVStream.codec doxy.
Diffstat (limited to 'libavformat')
-rw-r--r--libavformat/avformat.h13
1 files changed, 12 insertions, 1 deletions
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