Mercurial > libavcodec.hg

comparison opt.h @ 7086:18279e49cd4a libavcodec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Extend documentation for AVOption.
author stefano
date Sat, 21 Jun 2008 09:15:49 +0000
parents fa39bba4c8a4
children 07172377ec9f
comparison
equal deleted inserted replaced
7085:f55f71e2be57 7086:18279e49cd4a
50 /** 50 /**
51 * short English help text 51 * short English help text
52 * @todo What about other languages? 52 * @todo What about other languages?
53 */ 53 */
54 const char *help; 54 const char *help;
55 int offset; ///< offset to context structure where the parsed value should be stored 55
56 /**
57 * The offset relative to the context structure where the option
58 * value is stored. It should be 0 for named constant.
59 */
60 int offset;
56 enum AVOptionType type; 61 enum AVOptionType type;
57 62
63 /**
64 * the default value for non-constant and value for constant scalars
65 */
58 double default_val; 66 double default_val;
59 double min; 67 double min; ///< minimum valid value for the option
60 double max; 68 double max; ///< maximum valid value for the option
61 69
62 int flags; 70 int flags;
63 #define AV_OPT_FLAG_ENCODING_PARAM 1 ///< a generic parameter which can be set by the user for muxing or encoding 71 #define AV_OPT_FLAG_ENCODING_PARAM 1 ///< a generic parameter which can be set by the user for muxing or encoding
64 #define AV_OPT_FLAG_DECODING_PARAM 2 ///< a generic parameter which can be set by the user for demuxing or decoding 72 #define AV_OPT_FLAG_DECODING_PARAM 2 ///< a generic parameter which can be set by the user for demuxing or decoding
65 #define AV_OPT_FLAG_METADATA 4 ///< some data extracted or inserted into the file like title, comment, ... 73 #define AV_OPT_FLAG_METADATA 4 ///< some data extracted or inserted into the file like title, comment, ...
66 #define AV_OPT_FLAG_AUDIO_PARAM 8 74 #define AV_OPT_FLAG_AUDIO_PARAM 8
67 #define AV_OPT_FLAG_VIDEO_PARAM 16 75 #define AV_OPT_FLAG_VIDEO_PARAM 16
68 #define AV_OPT_FLAG_SUBTITLE_PARAM 32 76 #define AV_OPT_FLAG_SUBTITLE_PARAM 32
69 //FIXME think about enc-audio, ... style flags 77 //FIXME think about enc-audio, ... style flags
78
79 /**
80 * The logical unit to which the option belongs. Non-constant
81 * options and corresponding named constants share the same
82 * unit. May be NULL.
83 */
70 const char *unit; 84 const char *unit;
71 } AVOption; 85 } AVOption;
72 86
73 87
74 const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags); 88 const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags);