avcodec/h264dec: More elaborate documentation for frame_recovered

Signed-off-by: Michael Niedermayer <[email protected]>

1 files changed, 11 insertions, 1 deletions

diff --git a/libavcodec/h264dec.h b/libavcodec/h264dec.h
index b0c54ad82f..ede5195172 100644
--- a/libavcodec/h264dec.h
+++ b/libavcodec/h264dec.h
@@ -524,7 +524,17 @@ typedef struct H264Context {
  */
 #define FRAME_RECOVERED_HEURISTIC  (1 << 2)
 
-    int frame_recovered;    ///< Initial frame has been completely recovered
+    /**
+     * Initial frame has been completely recovered.
+     *
+     * Once this is set, all following decoded as well as displayed frames will be marked as recovered
+     * If a frame is marked as recovered frame_recovered will be set once this frame is output and thus
+     * all subsequently output fraames are also marked as recovered
+     *
+     * In effect, if you want all subsequent DECODED frames marked as recovered, set frame_recovered
+     * If you want all subsequent DISPAYED frames marked as recovered, set the frame->recovered
+     */
+    int frame_recovered;
 
     int has_recovery_point;