X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavcodec%2Fthread.h;h=205e45035d105672b77d5fbe04d7df472bbafac2;hb=e098fba5d9c9d52aaddd83e63dd910ff20b841d2;hp=9cfb31d5a12f6fdf435a85dbac0392f1eebe4338;hpb=14d5e214bfb56f08b1d34d13758c1e56a59c8c99;p=ffmpeg

diff --git a/libavcodec/thread.h b/libavcodec/thread.h
index 9cfb31d5a12..205e45035d1 100644
--- a/libavcodec/thread.h
+++ b/libavcodec/thread.h
@@ -31,17 +31,20 @@
 #include "avcodec.h"
 
 /**
- * Waits for decoding threads to finish and resets internal
- * state. Called by avcodec_flush_buffers().
+ * Wait for decoding threads to finish and reset internal state.
+ * Called by avcodec_flush_buffers().
  *
  * @param avctx The context.
  */
 void ff_thread_flush(AVCodecContext *avctx);
 
 /**
- * Submits a new frame to a decoding thread.
+ * Submit a new frame to a decoding thread.
  * Returns the next available frame in picture. *got_picture_ptr
  * will be 0 if none is available.
+ * The return value on success is the size of the consumed packet for
+ * compatiblity with avcodec_decode_video2(). This means the decoder
+ * has to consume the full packet.
  *
  * Parameters are the same as avcodec_decode_video2().
  */
@@ -59,8 +62,7 @@ int ff_thread_decode_frame(AVCodecContext *avctx, AVFrame *picture,
 void ff_thread_finish_setup(AVCodecContext *avctx);
 
 /**
- * Notifies later decoding threads when part of their reference picture
- * is ready.
+ * Notify later decoding threads when part of their reference picture is ready.
  * Call this when some part of the picture is finished decoding.
  * Later calls with lower values of progress have no effect.
  *
@@ -72,7 +74,7 @@ void ff_thread_finish_setup(AVCodecContext *avctx);
 void ff_thread_report_progress(AVFrame *f, int progress, int field);
 
 /**
- * Waits for earlier decoding threads to finish reference pictures
+ * Wait for earlier decoding threads to finish reference pictures.
  * Call this before accessing some part of a picture, with a given
  * value for progress, and it will return after the responsible decoding
  * thread calls ff_thread_report_progress() with the same or