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

This commit is contained in:
Anton Khirnov
2013-03-22 08:20:27 +01:00
parent 20429ba96e
commit 2d6edb2b7e

View File

@@ -1148,16 +1148,20 @@ typedef struct AVCodecContext {
/** /**
* picture width / height. * picture width / height.
* - encoding: MUST be set by user. * - encoding: MUST be set by user.
* - decoding: Set by libavcodec. * - decoding: May be set by the user before opening the decoder if known e.g.
* Note: For compatibility it is possible to set this instead of * from the container. Some decoders will require the dimensions
* coded_width/height before decoding. * 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;