avcodec: try to document timebase a bit more
authorMichael Niedermayer <michael@niedermayer.cc>
Sat, 5 Mar 2016 12:29:16 +0000 (13:29 +0100)
committerMichael Niedermayer <michael@niedermayer.cc>
Mon, 7 Mar 2016 22:00:50 +0000 (23:00 +0100)
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavcodec/avcodec.h

index e249e65..d676c57 100644 (file)
@@ -1669,7 +1669,15 @@ typedef struct AVCodecContext {
      * timebase should be 1/framerate and timestamp increments should be
      * identically 1.
      * This often, but not always is the inverse of the frame rate or field rate
-     * for video.
+     * for video. 1/time_base is not the average frame rate if the frame rate is not
+     * constant.
+     *
+     * Like containers, elementary streams also can store timestamps, 1/time_base
+     * is the unit in which these timestamps are specified.
+     * As example of such codec time base see ISO/IEC 14496-2:2001(E)
+     * vop_time_increment_resolution and fixed_vop_rate
+     * (fixed_vop_rate == 0 implies that it is different from the framerate)
+     *
      * - encoding: MUST be set by user.
      * - decoding: the use of this field for decoding is deprecated.
      *             Use framerate instead.