ffmpeg/FFmpeg
1
0
Fork 0
mirror of https://git.ffmpeg.org/ffmpeg.git synced 2024-09-20 05:16:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Extend documentation for AVOption.

Browse Source 
Originally committed as revision 13854 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Stefano Sabatini 2008-06-21 09:15:49 +00:00
parent f8b06be970
commit b453924f3c
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
libavcodec/opt.h
View File

@ -52,12 +52,20 @@ typedef struct AVOption {
* @todo What about other languages? * @todo What about other languages?
*/ */
const char *help; const char *help;
int offset; ///< offset to context structure where the parsed value should be stored
/**
* The offset relative to the context structure where the option
* value is stored. It should be 0 for named constant.
*/
int offset;
enum AVOptionType type; enum AVOptionType type;
/**
* the default value for non-constant and value for constant scalars
*/
double default_val; double default_val;
double min; double min; ///< minimum valid value for the option
double max; double max; ///< maximum valid value for the option
int flags; int flags;
#define AV_OPT_FLAG_ENCODING_PARAM 1 ///< a generic parameter which can be set by the user for muxing or encoding #define AV_OPT_FLAG_ENCODING_PARAM 1 ///< a generic parameter which can be set by the user for muxing or encoding
@ -67,6 +75,12 @@ typedef struct AVOption {
#define AV_OPT_FLAG_VIDEO_PARAM 16 #define AV_OPT_FLAG_VIDEO_PARAM 16
#define AV_OPT_FLAG_SUBTITLE_PARAM 32 #define AV_OPT_FLAG_SUBTITLE_PARAM 32
//FIXME think about enc-audio, ... style flags //FIXME think about enc-audio, ... style flags
/**
* The logical unit to which the option belongs. Non-constant
* options and corresponding named constants share the same
* unit. May be NULL.
*/
const char *unit; const char *unit;
} AVOption; } AVOption;