From f6e76ba476939c4b92da5608d33aa5aebdcbeebc Mon Sep 17 00:00:00 2001
From: Michael Niedermayer <michaelni@gmx.at>
Date: Fri, 23 May 2008 17:56:45 +0000
Subject: [PATCH] Document pts/dts.
Originally committed as revision 13265 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
libavformat/avformat.h | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 03902d035c6..fd49442ed5e 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -44,8 +44,23 @@
/* packet functions */
typedef struct AVPacket {
- int64_t pts; ///< presentation time stamp in time_base units
- int64_t dts; ///< decompression time stamp in time_base units
+ /**
+ * Presentation time stamp in time_base units.
+ * This is the time at which the decompressed packet will be presented
+ * to the user.
+ * Can be AV_NOPTS_VALUE if it is not stored in the file.
+ * pts MUST be larger or equal to dts as presentation can not happen before
+ * decompression, unless one wants to view hex dumps. Some formats misuse
+ * the terms dts and pts/cts to mean something different, these timestamps
+ * must be converted to true pts/dts before they are stored in AVPacket.
+ */
+ int64_t pts;
+ /**
+ * Decompression time stamp in time_base units.
+ * This is the time at which the packet is decompressed.
+ * Can be AV_NOPTS_VALUE if it is not stored in the file.
+ */
+ int64_t dts;
uint8_t *data;
int size;
int stream_index;
--
GitLab