3 * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * @author Michael Niedermayer <michaelni@gmx.at>
32 //FIXME order them and do a bin search
33 const AVOption
*av_find_opt(void *v
, const char *name
, const char *unit
, int mask
, int flags
){
34 AVClass
*c
= *(AVClass
**)v
; //FIXME silly way of storing AVClass
35 const AVOption
*o
= c
->option
;
37 for(;o
&& o
->name
; o
++){
38 if(!strcmp(o
->name
, name
) && (!unit
|| (o
->unit
&& !strcmp(o
->unit
, unit
))) && (o
->flags
& mask
) == flags
)
44 const AVOption
*av_next_option(void *obj
, const AVOption
*last
){
45 if(last
&& last
[1].name
) return ++last
;
46 else if(last
) return NULL
;
47 else return (*(AVClass
**)obj
)->option
;
50 static const AVOption
*av_set_number(void *obj
, const char *name
, double num
, int den
, int64_t intnum
){
51 const AVOption
*o
= av_find_opt(obj
, name
, NULL
, 0, 0);
53 if(!o
|| o
->offset
<=0)
56 if(o
->max
*den
< num
*intnum
|| o
->min
*den
> num
*intnum
) {
57 av_log(NULL
, AV_LOG_ERROR
, "Value %lf for parameter '%s' out of range.\n", num
, name
);
61 dst
= ((uint8_t*)obj
) + o
->offset
;
64 case FF_OPT_TYPE_FLAGS
:
65 case FF_OPT_TYPE_INT
: *(int *)dst
= llrint(num
/den
)*intnum
; break;
66 case FF_OPT_TYPE_INT64
: *(int64_t *)dst
= llrint(num
/den
)*intnum
; break;
67 case FF_OPT_TYPE_FLOAT
: *(float *)dst
= num
*intnum
/den
; break;
68 case FF_OPT_TYPE_DOUBLE
:*(double *)dst
= num
*intnum
/den
; break;
69 case FF_OPT_TYPE_RATIONAL
:
70 if((int)num
== num
) *(AVRational
*)dst
= (AVRational
){num
*intnum
, den
};
71 else *(AVRational
*)dst
= av_d2q(num
*intnum
/den
, 1<<24);
79 static const AVOption
*set_all_opt(void *v
, const char *unit
, double d
){
80 AVClass
*c
= *(AVClass
**)v
; //FIXME silly way of storing AVClass
81 const AVOption
*o
= c
->option
;
82 const AVOption
*ret
=NULL
;
84 for(;o
&& o
->name
; o
++){
85 if(o
->type
!= FF_OPT_TYPE_CONST
&& o
->unit
&& !strcmp(o
->unit
, unit
)){
87 if(o
->type
== FF_OPT_TYPE_FLAGS
)
88 tmp
= av_get_int(v
, o
->name
, NULL
) | (int64_t)d
;
90 av_set_number(v
, o
->name
, tmp
, 1, 1);
97 static const double const_values
[]={
104 static const char * const const_names
[]={
111 static int hexchar2int(char c
) {
112 if (c
>= '0' && c
<= '9') return c
- '0';
113 if (c
>= 'a' && c
<= 'f') return c
- 'a' + 10;
114 if (c
>= 'A' && c
<= 'F') return c
- 'A' + 10;
118 const AVOption
*av_set_string2(void *obj
, const char *name
, const char *val
, int alloc
){
119 const AVOption
*o
= av_find_opt(obj
, name
, NULL
, 0, 0);
120 if(o
&& o
->offset
==0 && o
->type
== FF_OPT_TYPE_CONST
&& o
->unit
){
121 return set_all_opt(obj
, o
->unit
, o
->default_val
);
123 if(!o
|| !val
|| o
->offset
<=0)
125 if(o
->type
== FF_OPT_TYPE_BINARY
){
126 uint8_t **dst
= (uint8_t **)(((uint8_t*)obj
) + o
->offset
);
127 int *lendst
= (int *)(dst
+ 1);
129 int len
= strlen(val
);
132 if (len
& 1) return NULL
;
134 ptr
= bin
= av_malloc(len
);
136 int a
= hexchar2int(*val
++);
137 int b
= hexchar2int(*val
++);
138 if (a
< 0 || b
< 0) {
142 *ptr
++ = (a
<< 4) | b
;
148 if(o
->type
!= FF_OPT_TYPE_STRING
){
155 const char *error
= NULL
;
157 if(*val
== '+' || *val
== '-')
160 for(i
=0; i
<sizeof(buf
)-1 && val
[i
] && val
[i
]!='+' && val
[i
]!='-'; i
++)
164 d
= ff_eval2(buf
, const_values
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
, &error
);
166 const AVOption
*o_named
= av_find_opt(obj
, buf
, o
->unit
, 0, 0);
167 if(o_named
&& o_named
->type
== FF_OPT_TYPE_CONST
)
168 d
= o_named
->default_val
;
169 else if(!strcmp(buf
, "default")) d
= o
->default_val
;
170 else if(!strcmp(buf
, "max" )) d
= o
->max
;
171 else if(!strcmp(buf
, "min" )) d
= o
->min
;
172 else if(!strcmp(buf
, "none" )) d
= 0;
173 else if(!strcmp(buf
, "all" )) d
= ~0;
176 av_log(NULL
, AV_LOG_ERROR
, "Unable to parse option value \"%s\": %s\n", val
, error
);
180 if(o
->type
== FF_OPT_TYPE_FLAGS
){
181 if (cmd
=='+') d
= av_get_int(obj
, name
, NULL
) | (int64_t)d
;
182 else if(cmd
=='-') d
= av_get_int(obj
, name
, NULL
) &~(int64_t)d
;
184 if (cmd
=='+') d
= notfirst
*av_get_double(obj
, name
, NULL
) + d
;
185 else if(cmd
=='-') d
= notfirst
*av_get_double(obj
, name
, NULL
) - d
;
188 if (!av_set_number(obj
, name
, d
, 1, 1))
199 av_free(*(void**)(((uint8_t*)obj
) + o
->offset
));
203 memcpy(((uint8_t*)obj
) + o
->offset
, &val
, sizeof(val
));
207 const AVOption
*av_set_string(void *obj
, const char *name
, const char *val
){
208 return av_set_string2(obj
, name
, val
, 0);
211 const AVOption
*av_set_double(void *obj
, const char *name
, double n
){
212 return av_set_number(obj
, name
, n
, 1, 1);
215 const AVOption
*av_set_q(void *obj
, const char *name
, AVRational n
){
216 return av_set_number(obj
, name
, n
.num
, n
.den
, 1);
219 const AVOption
*av_set_int(void *obj
, const char *name
, int64_t n
){
220 return av_set_number(obj
, name
, 1, 1, n
);
225 * @param buf a buffer which is used for returning non string values as strings, can be NULL
226 * @param buf_len allocated length in bytes of buf
228 const char *av_get_string(void *obj
, const char *name
, const AVOption
**o_out
, char *buf
, int buf_len
){
229 const AVOption
*o
= av_find_opt(obj
, name
, NULL
, 0, 0);
233 if(!o
|| o
->offset
<=0)
235 if(o
->type
!= FF_OPT_TYPE_STRING
&& (!buf
|| !buf_len
))
238 dst
= ((uint8_t*)obj
) + o
->offset
;
242 case FF_OPT_TYPE_FLAGS
: snprintf(buf
, buf_len
, "0x%08X",*(int *)dst
);break;
243 case FF_OPT_TYPE_INT
: snprintf(buf
, buf_len
, "%d" , *(int *)dst
);break;
244 case FF_OPT_TYPE_INT64
: snprintf(buf
, buf_len
, "%"PRId64
, *(int64_t*)dst
);break;
245 case FF_OPT_TYPE_FLOAT
: snprintf(buf
, buf_len
, "%f" , *(float *)dst
);break;
246 case FF_OPT_TYPE_DOUBLE
: snprintf(buf
, buf_len
, "%f" , *(double *)dst
);break;
247 case FF_OPT_TYPE_RATIONAL
: snprintf(buf
, buf_len
, "%d/%d", ((AVRational
*)dst
)->num
, ((AVRational
*)dst
)->den
);break;
248 case FF_OPT_TYPE_STRING
: return *(void**)dst
;
249 case FF_OPT_TYPE_BINARY
:
250 len
= *(int*)(((uint8_t *)dst
) + sizeof(uint8_t *));
251 if(len
>= (buf_len
+ 1)/2) return NULL
;
252 bin
= *(uint8_t**)dst
;
253 for(i
= 0; i
< len
; i
++) snprintf(buf
+ i
*2, 3, "%02X", bin
[i
]);
255 default: return NULL
;
260 static int av_get_number(void *obj
, const char *name
, const AVOption
**o_out
, double *num
, int *den
, int64_t *intnum
){
261 const AVOption
*o
= av_find_opt(obj
, name
, NULL
, 0, 0);
263 if(!o
|| o
->offset
<=0)
266 dst
= ((uint8_t*)obj
) + o
->offset
;
271 case FF_OPT_TYPE_FLAGS
: *intnum
= *(unsigned int*)dst
;return 0;
272 case FF_OPT_TYPE_INT
: *intnum
= *(int *)dst
;return 0;
273 case FF_OPT_TYPE_INT64
: *intnum
= *(int64_t*)dst
;return 0;
274 case FF_OPT_TYPE_FLOAT
: *num
= *(float *)dst
;return 0;
275 case FF_OPT_TYPE_DOUBLE
: *num
= *(double *)dst
;return 0;
276 case FF_OPT_TYPE_RATIONAL
: *intnum
= ((AVRational
*)dst
)->num
;
277 *den
= ((AVRational
*)dst
)->den
;
285 double av_get_double(void *obj
, const char *name
, const AVOption
**o_out
){
290 av_get_number(obj
, name
, o_out
, &num
, &den
, &intnum
);
291 return num
*intnum
/den
;
294 AVRational
av_get_q(void *obj
, const char *name
, const AVOption
**o_out
){
299 av_get_number(obj
, name
, o_out
, &num
, &den
, &intnum
);
300 if(num
== 1.0 && (int)intnum
== intnum
)
301 return (AVRational
){intnum
, den
};
303 return av_d2q(num
*intnum
/den
, 1<<24);
306 int64_t av_get_int(void *obj
, const char *name
, const AVOption
**o_out
){
311 av_get_number(obj
, name
, o_out
, &num
, &den
, &intnum
);
312 return num
*intnum
/den
;
315 static void opt_list(void *obj
, void *av_log_obj
, const char *unit
)
317 const AVOption
*opt
=NULL
;
319 while((opt
= av_next_option(obj
, opt
))){
320 if(!(opt
->flags
& (AV_OPT_FLAG_ENCODING_PARAM
|AV_OPT_FLAG_DECODING_PARAM
)))
323 /* Don't print CONST's on level one.
324 * Don't print anything but CONST's on level two.
325 * Only print items from the requested unit.
327 if (!unit
&& opt
->type
==FF_OPT_TYPE_CONST
)
329 else if (unit
&& opt
->type
!=FF_OPT_TYPE_CONST
)
331 else if (unit
&& opt
->type
==FF_OPT_TYPE_CONST
&& strcmp(unit
, opt
->unit
))
333 else if (unit
&& opt
->type
== FF_OPT_TYPE_CONST
)
334 av_log(av_log_obj
, AV_LOG_INFO
, " %-15s ", opt
->name
);
336 av_log(av_log_obj
, AV_LOG_INFO
, "-%-17s ", opt
->name
);
340 case FF_OPT_TYPE_FLAGS
:
341 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<flags>" );
343 case FF_OPT_TYPE_INT
:
344 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<int>" );
346 case FF_OPT_TYPE_INT64
:
347 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<int64>" );
349 case FF_OPT_TYPE_DOUBLE
:
350 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<double>" );
352 case FF_OPT_TYPE_FLOAT
:
353 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<float>" );
355 case FF_OPT_TYPE_STRING
:
356 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<string>" );
358 case FF_OPT_TYPE_RATIONAL
:
359 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<rational>" );
361 case FF_OPT_TYPE_BINARY
:
362 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "<binary>" );
364 case FF_OPT_TYPE_CONST
:
366 av_log( av_log_obj
, AV_LOG_INFO
, "%-7s ", "" );
369 av_log(av_log_obj
, AV_LOG_INFO
, "%c", (opt
->flags
& AV_OPT_FLAG_ENCODING_PARAM
) ? 'E' : '.');
370 av_log(av_log_obj
, AV_LOG_INFO
, "%c", (opt
->flags
& AV_OPT_FLAG_DECODING_PARAM
) ? 'D' : '.');
371 av_log(av_log_obj
, AV_LOG_INFO
, "%c", (opt
->flags
& AV_OPT_FLAG_VIDEO_PARAM
) ? 'V' : '.');
372 av_log(av_log_obj
, AV_LOG_INFO
, "%c", (opt
->flags
& AV_OPT_FLAG_AUDIO_PARAM
) ? 'A' : '.');
373 av_log(av_log_obj
, AV_LOG_INFO
, "%c", (opt
->flags
& AV_OPT_FLAG_SUBTITLE_PARAM
) ? 'S' : '.');
376 av_log(av_log_obj
, AV_LOG_INFO
, " %s", opt
->help
);
377 av_log(av_log_obj
, AV_LOG_INFO
, "\n");
378 if (opt
->unit
&& opt
->type
!= FF_OPT_TYPE_CONST
) {
379 opt_list(obj
, av_log_obj
, opt
->unit
);
384 int av_opt_show(void *obj
, void *av_log_obj
){
388 av_log(av_log_obj
, AV_LOG_INFO
, "%s AVOptions:\n", (*(AVClass
**)obj
)->class_name
);
390 opt_list(obj
, av_log_obj
, NULL
);
395 /** Set the values of the AVCodecContext or AVFormatContext structure.
396 * They are set to the defaults specified in the according AVOption options
397 * array default_val field.
399 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
401 void av_opt_set_defaults2(void *s
, int mask
, int flags
)
403 const AVOption
*opt
= NULL
;
404 while ((opt
= av_next_option(s
, opt
)) != NULL
) {
405 if((opt
->flags
& mask
) != flags
)
408 case FF_OPT_TYPE_CONST
:
409 /* Nothing to be done here */
411 case FF_OPT_TYPE_FLAGS
:
412 case FF_OPT_TYPE_INT
: {
414 val
= opt
->default_val
;
415 av_set_int(s
, opt
->name
, val
);
418 case FF_OPT_TYPE_FLOAT
: {
420 val
= opt
->default_val
;
421 av_set_double(s
, opt
->name
, val
);
424 case FF_OPT_TYPE_RATIONAL
: {
426 val
= av_d2q(opt
->default_val
, INT_MAX
);
427 av_set_q(s
, opt
->name
, val
);
430 case FF_OPT_TYPE_STRING
:
431 case FF_OPT_TYPE_BINARY
:
432 /* Cannot set default for string as default_val is of type * double */
435 av_log(s
, AV_LOG_DEBUG
, "AVOption type %d of option %s not implemented yet\n", opt
->type
, opt
->name
);
440 void av_opt_set_defaults(void *s
){
441 av_opt_set_defaults2(s
, 0, 0);