lavc: extend / update the [coded_]{width,height} doxy
authorAnton Khirnov <anton@khirnov.net>
Fri, 22 Mar 2013 07:20:27 +0000 (08:20 +0100)
committerAnton Khirnov <anton@khirnov.net>
Wed, 10 Apr 2013 18:54:22 +0000 (20:54 +0200)
libavcodec/avcodec.h

index 316d30a..84a6859 100644 (file)
@@ -1148,16 +1148,20 @@ typedef struct AVCodecContext {
     /**
      * picture width / height.
      * - encoding: MUST be set by user.
     /**
      * 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;
 
     /**
      */
     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
      * - 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;
 
      */
     int coded_width, coded_height;