[libav-commits] avcodec: attempt to clarify the CODEC_CAP_DELAY documentation

Justin Ruggles git at libav.org
Sat Jan 7 20:32:47 CET 2012


Module: libav
Branch: master
Commit: 3f6aa85ed45c2e6d52c2d11fc7f41bf732d10c29

Author:    Justin Ruggles <justin.ruggles at gmail.com>
Committer: Justin Ruggles <justin.ruggles at gmail.com>
Date:      Sat Jan  7 11:25:04 2012 -0500

avcodec: attempt to clarify the CODEC_CAP_DELAY documentation

---

 libavcodec/avcodec.h |   18 +++++++++++++++---
 1 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index c38bd27..c195ad5 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -725,10 +725,22 @@ typedef struct RcOverride{
 /* Codec can export data for HW decoding (XvMC). */
 #define CODEC_CAP_HWACCEL         0x0010
 /**
- * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
+ * Encoder or decoder requires flushing with NULL input at the end in order to
+ * give the complete and correct output.
+ *
+ * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
+ *       with NULL data. The user can still send NULL data to the public encode
+ *       or decode function, but libavcodec will not pass it along to the codec
+ *       unless this flag is set.
+ *
+ * Decoders:
+ * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
- * returns frames. If this is not set, the codec is guaranteed to never be fed
- * with NULL data.
+ * returns frames.
+ *
+ * Encoders:
+ * The encoder needs to be fed with NULL data at the end of encoding until the
+ * encoder no longer returns data.
  */
 #define CODEC_CAP_DELAY           0x0020
 /**



More information about the libav-commits mailing list