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>
This commit is contained in:
Martin Storsjö 2015-04-02 15:17:01 +03:00
parent 31048d48b0
commit 5637ff0121
1 changed files with 7 additions and 2 deletions

View File

@ -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)