[FFmpeg-devel] [PATCH] avcodec: document convergence_duration abuse for subtitles.

[Nicolas George]

Signed-off-by: Nicolas George <nicolas.george at normalesup.org>
---
 libavcodec/avcodec.h |    5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index d9da2ad..24bdd37 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -889,6 +889,8 @@ typedef struct AVPacket {
     /**
      * Duration of this packet in AVStream->time_base units, 0 if unknown.
      * Equals next_pts - this_pts in presentation order.
+     * For subtitles streams, the duration, if any, is stored in the
+     * convergence_duration field to avoid overflows.
      */
     int   duration;
     void  (*destruct)(struct AVPacket *);
@@ -911,6 +913,9 @@ typedef struct AVPacket {
      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
      * essential for some types of subtitle streams to ensure that all
      * subtitles are correctly displayed after seeking.
+     *
+     * For subtitles streams, the value of this field is simply the
+     * duration, if any, to avoid overflows.
      */
     int64_t convergence_duration;
 } AVPacket;
-- 
1.7.10