[FFmpeg-cvslog] lavc: Improve documentation for rc_max_rate and bit_rate.

[Carl Eugen Hoyos]

ffmpeg | branch: master | Carl Eugen Hoyos <cehoyos at ag.or.at> | Sun Jul 19 22:31:23 2015 +0200| [d8d2f934bd008c1db585bd0487d2084689ae8ba5] | committer: Michael Niedermayer

lavc: Improve documentation for rc_max_rate and bit_rate.

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

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

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

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index ad2f5b5..62205c9 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1311,7 +1311,8 @@ typedef struct AVCodecContext {
     /**
      * the average bitrate
      * - encoding: Set by user; unused for constant quantizer encoding.
-     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
+     * - decoding: Set by user, may be overwritten by libavcodec
+     *             if this info is available in the stream
      */
     int bit_rate;
 
@@ -2349,7 +2350,7 @@ typedef struct AVCodecContext {
     /**
      * maximum bitrate
      * - encoding: Set by user.
-     * - decoding: Set by libavcodec.
+     * - decoding: Set by user, may be overwritten by libavcodec.
      */
     int rc_max_rate;