Author: stefano Date: Sat Jun 21 11:15:49 2008 New Revision: 13854 Log: Extend documentation for AVOption. Modified: trunk/libavcodec/opt.h Modified: trunk/libavcodec/opt.h ============================================================================== --- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -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;
On Sat, Jun 21, 2008 at 11:15:49AM +0200, stefano wrote:
Log: Extend documentation for AVOption.
--- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -52,12 +52,20 @@ typedef struct AVOption { + + /** + * The offset relative to the context structure where the option + * value is stored. It should be 0 for named constant.
constantS Please review your patches/commits for plural 's' and third person singular 's' mistakes, you skip them regularly.
+ /** + * the default value for non-constant and value for constant scalars + */ double default_val;
I don't understand. s/value for// ? Diego
On date Sunday 2008-06-22 13:50:31 +0200, Diego Biurrun wrote:
On Sat, Jun 21, 2008 at 11:15:49AM +0200, stefano wrote:
Log: Extend documentation for AVOption.
--- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -52,12 +52,20 @@ typedef struct AVOption { + + /** + * The offset relative to the context structure where the option + * value is stored. It should be 0 for named constant.
constantS
Please review your patches/commits for plural 's' and third person singular 's' mistakes, you skip them regularly.
Yes, and sorry for that.
+ /** + * the default value for non-constant and value for constant scalars + */ double default_val;
I don't understand. s/value for// ?
That string has been suggested by MN, yes it's a little terse but I think the meaning is this: the default value for non-constant scalar options, here "default" is specified because the value itself may change, and value for constant scalar options, in this case "default" isn't necessary since the option has a constant value. I'll commit the typo fixes if you don't have any other comments on this. Regards.
On date Sunday 2008-06-22 14:44:42 +0200, Stefano Sabatini wrote:
On date Sunday 2008-06-22 13:50:31 +0200, Diego Biurrun wrote:
On Sat, Jun 21, 2008 at 11:15:49AM +0200, stefano wrote:
Log: Extend documentation for AVOption.
--- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -52,12 +52,20 @@ typedef struct AVOption { + + /** + * The offset relative to the context structure where the option + * value is stored. It should be 0 for named constant.
constantS
Please review your patches/commits for plural 's' and third person singular 's' mistakes, you skip them regularly.
Yes, and sorry for that.
+ /** + * the default value for non-constant and value for constant scalars + */ double default_val;
I don't understand. s/value for// ?
That string has been suggested by MN, yes it's a little terse but I think the meaning is this:
the default value for non-constant scalar options, here "default" is specified because the value itself may change, and value for constant scalar options, in this case "default" isn't necessary since the option has a constant value.
I'll commit the typo fixes if you don't have any other comments on this.
Fixed and applied. Regards.
On Sun, Jun 22, 2008 at 02:44:42PM +0200, Stefano Sabatini wrote:
On date Sunday 2008-06-22 13:50:31 +0200, Diego Biurrun wrote:
On Sat, Jun 21, 2008 at 11:15:49AM +0200, stefano wrote:
Log: Extend documentation for AVOption.
--- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -52,12 +52,20 @@ typedef struct AVOption { + + /** + * the default value for non-constant and value for constant scalars + */ double default_val;
I don't understand. s/value for// ?
That string has been suggested by MN, yes it's a little terse but I think the meaning is this:
the default value for non-constant scalar options, here "default" is specified because the value itself may change, and value for constant scalar options, in this case "default" isn't necessary since the option has a constant value.
I think the current description is misleading. At the very least, it confused me. I would suggest just default value for scalar options It is kind of implied that constant options are immutable while others are not... Diego
On date Tuesday 2008-06-24 11:18:32 +0200, Diego Biurrun wrote:
On Sun, Jun 22, 2008 at 02:44:42PM +0200, Stefano Sabatini wrote:
On date Sunday 2008-06-22 13:50:31 +0200, Diego Biurrun wrote:
On Sat, Jun 21, 2008 at 11:15:49AM +0200, stefano wrote:
Log: Extend documentation for AVOption.
--- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -52,12 +52,20 @@ typedef struct AVOption { + + /** + * the default value for non-constant and value for constant scalars + */ double default_val;
I don't understand. s/value for// ?
That string has been suggested by MN, yes it's a little terse but I think the meaning is this:
the default value for non-constant scalar options, here "default" is specified because the value itself may change, and value for constant scalar options, in this case "default" isn't necessary since the option has a constant value.
I think the current description is misleading. At the very least, it confused me. I would suggest just
default value for scalar options
It is kind of implied that constant options are immutable while others are not...
OK with me, I'll apply after three days if no one has other comments. Regards.
On date Tuesday 2008-06-24 23:53:58 +0200, Stefano Sabatini wrote:
On date Tuesday 2008-06-24 11:18:32 +0200, Diego Biurrun wrote:
On Sun, Jun 22, 2008 at 02:44:42PM +0200, Stefano Sabatini wrote:
On date Sunday 2008-06-22 13:50:31 +0200, Diego Biurrun wrote:
On Sat, Jun 21, 2008 at 11:15:49AM +0200, stefano wrote:
Log: Extend documentation for AVOption.
--- trunk/libavcodec/opt.h (original) +++ trunk/libavcodec/opt.h Sat Jun 21 11:15:49 2008 @@ -52,12 +52,20 @@ typedef struct AVOption { + + /** + * the default value for non-constant and value for constant scalars + */ double default_val;
I don't understand. s/value for// ?
That string has been suggested by MN, yes it's a little terse but I think the meaning is this:
the default value for non-constant scalar options, here "default" is specified because the value itself may change, and value for constant scalar options, in this case "default" isn't necessary since the option has a constant value.
I think the current description is misleading. At the very least, it confused me. I would suggest just
default value for scalar options
It is kind of implied that constant options are immutable while others are not...
OK with me, I'll apply after three days if no one has other comments.
Applied.
participants (3)
-
diego＠biurrun.de -
stefano.sabatini-lala＠poste.it -
subversion＠mplayerhq.hu