From b453924f3c63ee212c397410266fdbb1ffb8f2aa Mon Sep 17 00:00:00 2001 From: Stefano Sabatini Date: Sat, 21 Jun 2008 09:15:49 +0000 Subject: [PATCH] Extend documentation for AVOption. Originally committed as revision 13854 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavcodec/opt.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/libavcodec/opt.h b/libavcodec/opt.h index e6d1cd56d0..1fecb51098 100644 --- a/libavcodec/opt.h +++ b/libavcodec/opt.h @@ -52,12 +52,20 @@ typedef struct AVOption { * @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 @@ typedef struct AVOption { #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;