[FFmpeg-cvslog] libavcodec: Clarify the documentation of the internal codec capability flags

[Martin Storsjö]

ffmpeg | branch: master | Martin Storsjö <martin at martin.st> | Thu Apr  2 15:17:01 2015 +0300| [5637ff01218a44fcc1fff9b4382a15a6470abcc9] | committer: Martin Storsjö

libavcodec: Clarify the documentation of the internal codec capability flags

The previous documentation was very vague and almost misleading.

Signed-off-by: Martin Storsjö <martin at martin.st>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=5637ff01218a44fcc1fff9b4382a15a6470abcc9
---

 libavcodec/internal.h |    9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/libavcodec/internal.h b/libavcodec/internal.h
index a681329..5aa7712 100644
--- a/libavcodec/internal.h
+++ b/libavcodec/internal.h
@@ -34,11 +34,16 @@
 #include "config.h"
 
 /**
- * Codec is thread safe.
+ * The codec does not modify any global variables in the init function,
+ * allowing to call the init function without locking any global mutexes.
  */
 #define FF_CODEC_CAP_INIT_THREADSAFE        (1 << 0)
 /**
- * Codec cleans up memory on init failure.
+ * The codec allows calling the close function for deallocation even if
+ * the init function returned a failure. Without this capability flag, a
+ * codec does such cleanup internally when returning failures from the
+ * init function and does not expect the close function to be called at
+ * all.
  */
 #define FF_CODEC_CAP_INIT_CLEANUP           (1 << 1)