diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 03902d035c627c334ecd99b53667edd619c77223..fd49442ed5ee573ac3f3c7764242d9402c5c5ea3 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;