# HG changeset patch
# User michael
# Date 1211565405 0
# Node ID 8bec7ae8f0bb70c0b6fae61b4168cacf93815580
# Parent  74e2cfc79cda340337fac21c132a16e321032681
Document pts/dts.

diff -r 74e2cfc79cda -r 8bec7ae8f0bb avformat.h
--- a/avformat.h	Fri May 23 17:52:42 2008 +0000
+++ b/avformat.h	Fri May 23 17:56:45 2008 +0000
@@ -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;