[FFmpeg-cvslog] lavf/utils: document AVIndexEntry.timestamp

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michaelni at gmx.at> | Thu Oct  6 20:20:43 2011 +0200| [f7fbbf466f5c923e366b03d78bae0f4f64f013fa] | committer: Michael Niedermayer

lavf/utils: document AVIndexEntry.timestamp

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

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

 libavformat/avformat.h |    7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 728dd66..c785a13 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -469,7 +469,12 @@ enum AVStreamParseType {
 
 typedef struct AVIndexEntry {
     int64_t pos;
-    int64_t timestamp;
+    int64_t timestamp;        /**<
+                               * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
+                               * when seeking to this entry. That means preferable PTS on keyframe based formats.
+                               * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
+                               * is known
+                               */
 #define AVINDEX_KEYFRAME 0x0001
     int flags:2;
     int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).