From 5637ff01218a44fcc1fff9b4382a15a6470abcc9 Mon Sep 17 00:00:00 2001 From: Martin Storsjö Date: Thu, 2 Apr 2015 15:17:01 +0300 Subject: libavcodec: Clarify the documentation of the internal codec capability flags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The previous documentation was very vague and almost misleading. Signed-off-by: Martin Storsjö --- libavcodec/internal.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'libavcodec') diff --git a/libavcodec/internal.h b/libavcodec/internal.h index a681329f20..5aa77129a2 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) -- cgit v1.2.3