avcodec: add some documentation to the AVProducerReferenceTime struct

Signed-off-by: James Almer <jamrial@gmail.com>

1 files changed, 8 insertions, 0 deletions

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 82dce38bb8..894a9e5565 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1194,7 +1194,15 @@ typedef struct AVCPBProperties {
     uint64_t vbv_delay;
 } AVCPBProperties;
 
+/**
+ * This structure supplies correlation between a packet timestamp and a wall clock
+ * production time. The definition follows the Producer Reference Time ('prft')
+ * as defined in ISO/IEC 14496-12
+ */
 typedef struct AVProducerReferenceTime {
+    /**
+     * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
+     */
     int64_t wallclock;
     int flags;
 } AVProducerReferenceTime;