[FFmpeg-cvslog] lavc: extend / update the [coded_]{width, height} doxy

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Fri Mar 22 08:20:27 2013 +0100| [2d6edb2b7ebc400d1a4fd5b95a30e4b4415b94f9] | committer: Anton Khirnov

lavc: extend / update the [coded_]{width,height} doxy

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

 libavcodec/avcodec.h |   14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 316d30a..84a6859 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1148,16 +1148,20 @@ typedef struct AVCodecContext {
     /**
      * picture width / height.
      * - encoding: MUST be set by user.
-     * - decoding: Set by libavcodec.
-     * Note: For compatibility it is possible to set this instead of
-     * coded_width/height before decoding.
+     * - decoding: May be set by the user before opening the decoder if known e.g.
+     *             from the container. Some decoders will require the dimensions
+     *             to be set by the caller. During decoding, the decoder may
+     *             overwrite those values as required.
      */
     int width, height;
 
     /**
-     * Bitstream width / height, may be different from width/height.
+     * Bitstream width / height, may be different from width/height e.g. when
+     * the decoded frame is cropped before being output.
      * - encoding: unused
-     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
+     * - decoding: May be set by the user before opening the decoder if known
+     *             e.g. from the container. During decoding, the decoder may
+     *             overwrite those values as required.
      */
     int coded_width, coded_height;