3 * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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>
36 //FIXME order them and do a bin search
37 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags)
39 AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
40 const AVOption *o= c->option;
42 for (; o && o->name; o++) {
43 if (!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags)
50 const AVOption *av_next_option(void *obj, const AVOption *last)
52 if (last && last[1].name) return ++last;
53 else if (last) return NULL;
54 else return (*(AVClass**)obj)->option;
57 static int av_set_number2(void *obj, const char *name, double num, int den, int64_t intnum, const AVOption **o_out)
59 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
63 if (!o || o->offset<=0)
64 return AVERROR_OPTION_NOT_FOUND;
66 if (o->max*den < num*intnum || o->min*den > num*intnum) {
67 av_log(obj, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range\n", num, name);
68 return AVERROR(ERANGE);
71 dst= ((uint8_t*)obj) + o->offset;
74 case FF_OPT_TYPE_FLAGS:
75 case FF_OPT_TYPE_INT: *(int *)dst= llrint(num/den)*intnum; break;
76 case FF_OPT_TYPE_INT64: *(int64_t *)dst= llrint(num/den)*intnum; break;
77 case FF_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
78 case FF_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
79 case FF_OPT_TYPE_RATIONAL:
80 if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
81 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
84 return AVERROR(EINVAL);
89 static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum)
91 const AVOption *o = NULL;
92 if (av_set_number2(obj, name, num, den, intnum, &o) < 0)
98 static const double const_values[] = {
105 static const char * const const_names[] = {
112 static int hexchar2int(char c) {
113 if (c >= '0' && c <= '9') return c - '0';
114 if (c >= 'a' && c <= 'f') return c - 'a' + 10;
115 if (c >= 'A' && c <= 'F') return c - 'A' + 10;
119 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
122 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
126 return AVERROR_OPTION_NOT_FOUND;
127 if (!val || o->offset<=0)
128 return AVERROR(EINVAL);
130 if (o->type == FF_OPT_TYPE_BINARY) {
131 uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
132 int *lendst = (int *)(dst + 1);
134 int len = strlen(val);
137 if (len & 1) return AVERROR(EINVAL);
139 ptr = bin = av_malloc(len);
141 int a = hexchar2int(*val++);
142 int b = hexchar2int(*val++);
143 if (a < 0 || b < 0) {
145 return AVERROR(EINVAL);
147 *ptr++ = (a << 4) | b;
153 if (o->type != FF_OPT_TYPE_STRING) {
161 if (*val == '+' || *val == '-')
164 for (i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
169 const AVOption *o_named = av_opt_find(obj, buf, o->unit, 0, 0);
170 if (o_named && o_named->type == FF_OPT_TYPE_CONST)
171 d= o_named->default_val.dbl;
172 else if (!strcmp(buf, "default")) d= o->default_val.dbl;
173 else if (!strcmp(buf, "max" )) d= o->max;
174 else if (!strcmp(buf, "min" )) d= o->min;
175 else if (!strcmp(buf, "none" )) d= 0;
176 else if (!strcmp(buf, "all" )) d= ~0;
178 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
180 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
185 if (o->type == FF_OPT_TYPE_FLAGS) {
186 if (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
187 else if (cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
189 if (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
190 else if (cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
193 if ((ret = av_set_number2(obj, name, d, 1, 1, o_out)) < 0)
203 av_free(*(void**)(((uint8_t*)obj) + o->offset));
207 memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
211 const AVOption *av_set_double(void *obj, const char *name, double n)
213 return av_set_number(obj, name, n, 1, 1);
216 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
218 return av_set_number(obj, name, n.num, n.den, 1);
221 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
223 return av_set_number(obj, name, 1, 1, n);
228 * @param buf a buffer which is used for returning non string values as strings, can be NULL
229 * @param buf_len allocated length in bytes of buf
231 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
233 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
237 if (!o || o->offset<=0)
239 if (o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
242 dst= ((uint8_t*)obj) + o->offset;
243 if (o_out) *o_out= o;
246 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
247 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
248 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
249 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
250 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
251 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
252 case FF_OPT_TYPE_STRING: return *(void**)dst;
253 case FF_OPT_TYPE_BINARY:
254 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
255 if (len >= (buf_len + 1)/2) return NULL;
256 bin = *(uint8_t**)dst;
257 for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
259 default: return NULL;
264 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum)
266 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
268 if (!o || o->offset<=0)
271 dst= ((uint8_t*)obj) + o->offset;
273 if (o_out) *o_out= o;
276 case FF_OPT_TYPE_FLAGS: *intnum= *(unsigned int*)dst;return 0;
277 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
278 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
279 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
280 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
281 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
282 *den = ((AVRational*)dst)->den;
290 double av_get_double(void *obj, const char *name, const AVOption **o_out)
296 if (get_number(obj, name, o_out, &num, &den, &intnum) < 0)
298 return num*intnum/den;
301 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
307 if (get_number(obj, name, o_out, &num, &den, &intnum) < 0)
308 return (AVRational){0, 0};
309 if (num == 1.0 && (int)intnum == intnum)
310 return (AVRational){intnum, den};
312 return av_d2q(num*intnum/den, 1<<24);
315 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
321 if (get_number(obj, name, o_out, &num, &den, &intnum) < 0)
323 return num*intnum/den;
326 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
328 const AVOption *field = av_find_opt(obj, field_name, NULL, 0, 0);
329 const AVOption *flag = av_find_opt(obj, flag_name, NULL, 0, 0);
331 if (!field || !flag || flag->type != FF_OPT_TYPE_CONST)
333 return av_get_int(obj, field_name, NULL) & (int) flag->default_val.dbl;
336 static void opt_list(void *obj, void *av_log_obj, const char *unit,
337 int req_flags, int rej_flags)
339 const AVOption *opt=NULL;
341 while ((opt= av_next_option(obj, opt))) {
342 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
345 /* Don't print CONST's on level one.
346 * Don't print anything but CONST's on level two.
347 * Only print items from the requested unit.
349 if (!unit && opt->type==FF_OPT_TYPE_CONST)
351 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
353 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
355 else if (unit && opt->type == FF_OPT_TYPE_CONST)
356 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
358 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
361 case FF_OPT_TYPE_FLAGS:
362 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
364 case FF_OPT_TYPE_INT:
365 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
367 case FF_OPT_TYPE_INT64:
368 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
370 case FF_OPT_TYPE_DOUBLE:
371 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
373 case FF_OPT_TYPE_FLOAT:
374 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
376 case FF_OPT_TYPE_STRING:
377 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
379 case FF_OPT_TYPE_RATIONAL:
380 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
382 case FF_OPT_TYPE_BINARY:
383 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
385 case FF_OPT_TYPE_CONST:
387 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
390 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
391 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
392 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
393 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
394 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
397 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
398 av_log(av_log_obj, AV_LOG_INFO, "\n");
399 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
400 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
405 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
410 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
412 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
417 void av_opt_set_defaults(void *s)
419 #if FF_API_OLD_AVOPTIONS
420 av_opt_set_defaults2(s, 0, 0);
423 void av_opt_set_defaults2(void *s, int mask, int flags)
426 const AVOption *opt = NULL;
427 while ((opt = av_next_option(s, opt)) != NULL) {
428 #if FF_API_OLD_AVOPTIONS
429 if ((opt->flags & mask) != flags)
433 case FF_OPT_TYPE_CONST:
434 /* Nothing to be done here */
436 case FF_OPT_TYPE_FLAGS:
437 case FF_OPT_TYPE_INT: {
439 val = opt->default_val.dbl;
440 av_set_int(s, opt->name, val);
443 case FF_OPT_TYPE_INT64:
444 if ((double)(opt->default_val.dbl+0.6) == opt->default_val.dbl)
445 av_log(s, AV_LOG_DEBUG, "loss of precision in default of %s\n", opt->name);
446 av_set_int(s, opt->name, opt->default_val.dbl);
448 case FF_OPT_TYPE_DOUBLE:
449 case FF_OPT_TYPE_FLOAT: {
451 val = opt->default_val.dbl;
452 av_set_double(s, opt->name, val);
455 case FF_OPT_TYPE_RATIONAL: {
457 val = av_d2q(opt->default_val.dbl, INT_MAX);
458 av_set_q(s, opt->name, val);
461 case FF_OPT_TYPE_STRING:
462 av_set_string3(s, opt->name, opt->default_val.str, 1, NULL);
464 case FF_OPT_TYPE_BINARY:
465 /* Cannot set default for binary */
468 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
474 * Store the value in the field in ctx that is named like key.
475 * ctx must be an AVClass context, storing is done using AVOptions.
477 * @param buf the string to parse, buf will be updated to point at the
478 * separator just after the parsed key/value pair
479 * @param key_val_sep a 0-terminated list of characters used to
480 * separate key from value
481 * @param pairs_sep a 0-terminated list of characters used to separate
482 * two pairs from each other
483 * @return 0 if the key/value pair has been successfully parsed and
484 * set, or a negative value corresponding to an AVERROR code in case
486 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
487 * the error code issued by av_set_string3() if the key/value pair
490 static int parse_key_value_pair(void *ctx, const char **buf,
491 const char *key_val_sep, const char *pairs_sep)
493 char *key = av_get_token(buf, key_val_sep);
497 if (*key && strspn(*buf, key_val_sep)) {
499 val = av_get_token(buf, pairs_sep);
501 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
503 return AVERROR(EINVAL);
506 av_log(ctx, AV_LOG_DEBUG, "Setting value '%s' for key '%s'\n", val, key);
508 ret = av_set_string3(ctx, key, val, 1, NULL);
509 if (ret == AVERROR_OPTION_NOT_FOUND)
510 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
517 int av_set_options_string(void *ctx, const char *opts,
518 const char *key_val_sep, const char *pairs_sep)
523 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
534 void av_opt_free(void *obj)
536 const AVOption *o = NULL;
537 while ((o = av_next_option(obj, o)))
538 if (o->type == FF_OPT_TYPE_STRING || o->type == FF_OPT_TYPE_BINARY)
539 av_freep((uint8_t *)obj + o->offset);
542 int av_opt_set_dict(void *obj, AVDictionary **options)
544 AVDictionaryEntry *t = NULL;
545 AVDictionary *tmp = NULL;
548 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
549 ret = av_set_string3(obj, t->key, t->value, 1, NULL);
550 if (ret == AVERROR_OPTION_NOT_FOUND)
551 av_dict_set(&tmp, t->key, t->value, 0);
553 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
558 av_dict_free(options);
563 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
564 int opt_flags, int search_flags)
566 AVClass *c = *(AVClass**)obj;
567 const AVOption *o = NULL;
569 if (c->opt_find && search_flags & AV_OPT_SEARCH_CHILDREN &&
570 (o = c->opt_find(obj, name, unit, opt_flags, search_flags)))
573 while (o = av_next_option(obj, o)) {
574 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
575 ((!unit && o->type != FF_OPT_TYPE_CONST) ||
576 (unit && o->unit && !strcmp(o->unit, unit))))
586 typedef struct TestContext
588 const AVClass *class;
596 #define OFFSET(x) offsetof(TestContext, x)
598 #define TEST_FLAG_COOL 01
599 #define TEST_FLAG_LAME 02
600 #define TEST_FLAG_MU 04
602 static const AVOption test_options[]= {
603 {"num", "set num", OFFSET(num), FF_OPT_TYPE_INT, {0}, 0, 100 },
604 {"toggle", "set toggle", OFFSET(toggle), FF_OPT_TYPE_INT, {0}, 0, 1 },
605 {"rational", "set rational", OFFSET(rational), FF_OPT_TYPE_RATIONAL, {0}, 0, 10 },
606 {"string", "set string", OFFSET(string), FF_OPT_TYPE_STRING, {0}, CHAR_MIN, CHAR_MAX },
607 {"flags", "set flags", OFFSET(flags), FF_OPT_TYPE_FLAGS, {0}, 0, INT_MAX, 0, "flags" },
608 {"cool", "set cool flag ", 0, FF_OPT_TYPE_CONST, {TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
609 {"lame", "set lame flag ", 0, FF_OPT_TYPE_CONST, {TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
610 {"mu", "set mu flag ", 0, FF_OPT_TYPE_CONST, {TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
614 static const char *test_get_name(void *ctx)
619 static const AVClass test_class = {
629 printf("\nTesting av_set_options_string()\n");
631 TestContext test_ctx;
632 const char *options[] = {
648 "flags=+mu-lame : num=42: toggle=0",
649 "num=42 : string=blahblah",
650 "rational=0 : rational=1/2 : rational=1/-1",
654 test_ctx.class = &test_class;
655 av_opt_set_defaults(&test_ctx);
656 test_ctx.string = av_strdup("default");
658 av_log_set_level(AV_LOG_DEBUG);
660 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
661 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
662 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
663 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);