diff options
| author | Martin Storsjö <martin@martin.st> | 2015-04-02 15:17:01 +0300 |
|---|---|---|
| committer | Martin Storsjö <martin@martin.st> | 2015-04-05 20:47:50 +0300 |
| commit | 5637ff01218a44fcc1fff9b4382a15a6470abcc9 (patch) | |
| tree | c5cb7a4d129ba58c8d119f4880c1f9d2bce2cd30 | |
| parent | 31048d48b0410b9cfb6023054d81e627d01be342 (diff) | |
| download | ffmpeg-5637ff01218a44fcc1fff9b4382a15a6470abcc9.tar.gz | |
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@martin.st>
| -rw-r--r-- | libavcodec/internal.h | 9 |
1 files changed, 7 insertions, 2 deletions
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) |