Mercurial > libavcodec.hg
changeset 7086:18279e49cd4a libavcodec
Extend documentation for AVOption.
| author | stefano |
|---|---|
| date | Sat, 21 Jun 2008 09:15:49 +0000 |
| parents | f55f71e2be57 |
| children | 9c0f579ebb6b |
| files | opt.h |
| diffstat | 1 files changed, 17 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/opt.h Fri Jun 20 20:46:07 2008 +0000 +++ b/opt.h Sat Jun 21 09:15:49 2008 +0000 @@ -52,12 +52,20 @@ * @todo What about other languages? */ 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; + /** + * the default value for non-constant and value for constant scalars + */ double default_val; - double min; - double max; + double min; ///< minimum valid value for the option + double max; ///< maximum valid value for the option int flags; #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 @@ #define AV_OPT_FLAG_VIDEO_PARAM 16 #define AV_OPT_FLAG_SUBTITLE_PARAM 32 //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; } AVOption;