From 967923abd15b58a0029c36e5a0be7de108b0deb7 Mon Sep 17 00:00:00 2001
From: Anton Khirnov <anton@khirnov.net>
Date: Thu, 15 Mar 2012 11:27:47 +0100
Subject: [PATCH] lavf doxy: expand AVStream.codec doxy.
---
libavformat/avformat.h | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 98cfee11739..cd7ece8458f 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
--
GitLab