[FFmpeg-cvslog] lavc: clarify the meaning of AVCodecContext.frame_number.

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Thu Mar  1 12:25:50 2012 +0100| [c179c9e19d3b3a8bb98fcc65d2da1caa293f7919] | committer: Anton Khirnov

lavc: clarify the meaning of AVCodecContext.frame_number.

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

 libavcodec/avcodec.h |   12 +++++++++++-
 1 files changed, 11 insertions(+), 1 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 798cac6..19f114f 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1972,7 +1972,17 @@ typedef struct AVCodecContext {
      * Samples per packet, initialized when calling 'init'.
      */
     int frame_size;
-    int frame_number;   ///< audio or video frame number
+
+    /**
+     * Frame counter, set by libavcodec.
+     *
+     * - decoding: total number of frames returned from the decoder so far.
+     * - encoding: total number of frames passed to the encoder so far.
+     *
+     *   @note the counter is not incremented if encoding/decoding resulted in
+     *   an error.
+     */
+    int frame_number;
 
     /**
      * number of bytes per packet if constant and known or 0