Browse code

lavc: Improve documentation for rc_max_rate and bit_rate.

Both may be set by user (libavformat) on decoding.

Carl Eugen Hoyos authored on 2015/07/20 05:31:23
Showing 1 changed files
... ...
@@ -1311,7 +1311,8 @@ typedef struct AVCodecContext {
1311 1311
     /**
1312 1312
      * the average bitrate
1313 1313
      * - encoding: Set by user; unused for constant quantizer encoding.
1314
-     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1314
+     * - decoding: Set by user, may be overwritten by libavcodec
1315
+     *             if this info is available in the stream
1315 1316
      */
1316 1317
     int bit_rate;
1317 1318
 
... ...
@@ -2349,7 +2350,7 @@ typedef struct AVCodecContext {
2349 2349
     /**
2350 2350
      * maximum bitrate
2351 2351
      * - encoding: Set by user.
2352
-     * - decoding: Set by libavcodec.
2352
+     * - decoding: Set by user, may be overwritten by libavcodec.
2353 2353
      */
2354 2354
     int rc_max_rate;
2355 2355