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 write_number(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);
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 double const_values[] = {
96 static const char * const const_names[] = {
103 static int hexchar2int(char c) {
104 if (c >= '0' && c <= '9') return c - '0';
105 if (c >= 'a' && c <= 'f') return c - 'a' + 10;
106 if (c >= 'A' && c <= 'F') return c - 'A' + 10;
110 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
112 int *lendst = (int *)(dst + 1);
114 int len = strlen(val);
120 return AVERROR(EINVAL);
123 ptr = bin = av_malloc(len);
125 int a = hexchar2int(*val++);
126 int b = hexchar2int(*val++);
127 if (a < 0 || b < 0) {
129 return AVERROR(EINVAL);
131 *ptr++ = (a << 4) | b;
139 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
142 *dst = av_strdup(val);
146 static int set_string_number(void *obj, const AVOption *o, const char *val, void *dst)
148 int ret = 0, notfirst = 0;
155 if (*val == '+' || *val == '-')
158 for (i = 0; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
163 const AVOption *o_named = av_opt_find(obj, buf, o->unit, 0, 0);
164 if (o_named && o_named->type == FF_OPT_TYPE_CONST)
165 d = o_named->default_val.dbl;
166 else if (!strcmp(buf, "default")) d = o->default_val.dbl;
167 else if (!strcmp(buf, "max" )) d = o->max;
168 else if (!strcmp(buf, "min" )) d = o->min;
169 else if (!strcmp(buf, "none" )) d = 0;
170 else if (!strcmp(buf, "all" )) d = ~0;
172 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
174 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
179 if (o->type == FF_OPT_TYPE_FLAGS) {
180 if (cmd == '+') d = av_get_int(obj, o->name, NULL) | (int64_t)d;
181 else if (cmd == '-') d = av_get_int(obj, o->name, NULL) &~(int64_t)d;
183 if (cmd == '+') d = notfirst*av_get_double(obj, o->name, NULL) + d;
184 else if (cmd == '-') d = notfirst*av_get_double(obj, o->name, NULL) - d;
187 if ((ret = write_number(obj, o->name, d, 1, 1, NULL)) < 0)
198 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
200 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
205 return AVERROR_OPTION_NOT_FOUND;
207 return AVERROR(EINVAL);
209 dst = ((uint8_t*)obj) + o->offset;
211 case FF_OPT_TYPE_STRING: return set_string(obj, o, val, dst);
212 case FF_OPT_TYPE_BINARY: return set_string_binary(obj, o, val, dst);
213 case FF_OPT_TYPE_FLAGS:
214 case FF_OPT_TYPE_INT:
215 case FF_OPT_TYPE_INT64:
216 case FF_OPT_TYPE_FLOAT:
217 case FF_OPT_TYPE_DOUBLE:
218 case FF_OPT_TYPE_RATIONAL: return set_string_number(obj, o, val, dst);
221 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
222 return AVERROR(EINVAL);
225 static const AVOption *set_number(void *obj, const char *name, double num, int den, int64_t intnum)
227 const AVOption *o = NULL;
228 if (write_number(obj, name, num, den, intnum, &o) < 0)
234 const AVOption *av_set_double(void *obj, const char *name, double n)
236 return set_number(obj, name, n, 1, 1);
239 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
241 return set_number(obj, name, n.num, n.den, 1);
244 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
246 return set_number(obj, name, 1, 1, n);
251 * @param buf a buffer which is used for returning non string values as strings, can be NULL
252 * @param buf_len allocated length in bytes of buf
254 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
256 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
262 if (o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
265 dst= ((uint8_t*)obj) + o->offset;
266 if (o_out) *o_out= o;
269 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
270 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
271 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
272 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
273 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
274 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
275 case FF_OPT_TYPE_STRING: return *(void**)dst;
276 case FF_OPT_TYPE_BINARY:
277 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
278 if (len >= (buf_len + 1)/2) return NULL;
279 bin = *(uint8_t**)dst;
280 for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
282 default: return NULL;
287 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum)
289 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
294 dst= ((uint8_t*)obj) + o->offset;
296 if (o_out) *o_out= o;
299 case FF_OPT_TYPE_FLAGS: *intnum= *(unsigned int*)dst;return 0;
300 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
301 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
302 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
303 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
304 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
305 *den = ((AVRational*)dst)->den;
313 double av_get_double(void *obj, const char *name, const AVOption **o_out)
319 if (get_number(obj, name, o_out, &num, &den, &intnum) < 0)
321 return num*intnum/den;
324 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
330 if (get_number(obj, name, o_out, &num, &den, &intnum) < 0)
331 return (AVRational){0, 0};
332 if (num == 1.0 && (int)intnum == intnum)
333 return (AVRational){intnum, den};
335 return av_d2q(num*intnum/den, 1<<24);
338 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
344 if (get_number(obj, name, o_out, &num, &den, &intnum) < 0)
346 return num*intnum/den;
349 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
351 const AVOption *field = av_find_opt(obj, field_name, NULL, 0, 0);
352 const AVOption *flag = av_find_opt(obj, flag_name, NULL, 0, 0);
354 if (!field || !flag || flag->type != FF_OPT_TYPE_CONST)
356 return av_get_int(obj, field_name, NULL) & (int) flag->default_val.dbl;
359 static void opt_list(void *obj, void *av_log_obj, const char *unit,
360 int req_flags, int rej_flags)
362 const AVOption *opt=NULL;
364 while ((opt= av_next_option(obj, opt))) {
365 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
368 /* Don't print CONST's on level one.
369 * Don't print anything but CONST's on level two.
370 * Only print items from the requested unit.
372 if (!unit && opt->type==FF_OPT_TYPE_CONST)
374 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
376 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
378 else if (unit && opt->type == FF_OPT_TYPE_CONST)
379 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
381 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
384 case FF_OPT_TYPE_FLAGS:
385 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
387 case FF_OPT_TYPE_INT:
388 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
390 case FF_OPT_TYPE_INT64:
391 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
393 case FF_OPT_TYPE_DOUBLE:
394 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
396 case FF_OPT_TYPE_FLOAT:
397 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
399 case FF_OPT_TYPE_STRING:
400 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
402 case FF_OPT_TYPE_RATIONAL:
403 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
405 case FF_OPT_TYPE_BINARY:
406 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
408 case FF_OPT_TYPE_CONST:
410 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
413 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
414 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
415 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
416 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
417 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
420 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
421 av_log(av_log_obj, AV_LOG_INFO, "\n");
422 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
423 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
428 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
433 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
435 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
440 void av_opt_set_defaults(void *s)
442 #if FF_API_OLD_AVOPTIONS
443 av_opt_set_defaults2(s, 0, 0);
446 void av_opt_set_defaults2(void *s, int mask, int flags)
449 const AVOption *opt = NULL;
450 while ((opt = av_next_option(s, opt)) != NULL) {
451 #if FF_API_OLD_AVOPTIONS
452 if ((opt->flags & mask) != flags)
456 case FF_OPT_TYPE_CONST:
457 /* Nothing to be done here */
459 case FF_OPT_TYPE_FLAGS:
460 case FF_OPT_TYPE_INT: {
462 val = opt->default_val.dbl;
463 av_set_int(s, opt->name, val);
466 case FF_OPT_TYPE_INT64:
467 if ((double)(opt->default_val.dbl+0.6) == opt->default_val.dbl)
468 av_log(s, AV_LOG_DEBUG, "loss of precision in default of %s\n", opt->name);
469 av_set_int(s, opt->name, opt->default_val.dbl);
471 case FF_OPT_TYPE_DOUBLE:
472 case FF_OPT_TYPE_FLOAT: {
474 val = opt->default_val.dbl;
475 av_set_double(s, opt->name, val);
478 case FF_OPT_TYPE_RATIONAL: {
480 val = av_d2q(opt->default_val.dbl, INT_MAX);
481 av_set_q(s, opt->name, val);
484 case FF_OPT_TYPE_STRING:
485 av_set_string3(s, opt->name, opt->default_val.str, 1, NULL);
487 case FF_OPT_TYPE_BINARY:
488 /* Cannot set default for binary */
491 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
497 * Store the value in the field in ctx that is named like key.
498 * ctx must be an AVClass context, storing is done using AVOptions.
500 * @param buf the string to parse, buf will be updated to point at the
501 * separator just after the parsed key/value pair
502 * @param key_val_sep a 0-terminated list of characters used to
503 * separate key from value
504 * @param pairs_sep a 0-terminated list of characters used to separate
505 * two pairs from each other
506 * @return 0 if the key/value pair has been successfully parsed and
507 * set, or a negative value corresponding to an AVERROR code in case
509 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
510 * the error code issued by av_set_string3() if the key/value pair
513 static int parse_key_value_pair(void *ctx, const char **buf,
514 const char *key_val_sep, const char *pairs_sep)
516 char *key = av_get_token(buf, key_val_sep);
520 if (*key && strspn(*buf, key_val_sep)) {
522 val = av_get_token(buf, pairs_sep);
524 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
526 return AVERROR(EINVAL);
529 av_log(ctx, AV_LOG_DEBUG, "Setting value '%s' for key '%s'\n", val, key);
531 ret = av_set_string3(ctx, key, val, 1, NULL);
532 if (ret == AVERROR_OPTION_NOT_FOUND)
533 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
540 int av_set_options_string(void *ctx, const char *opts,
541 const char *key_val_sep, const char *pairs_sep)
546 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
557 void av_opt_free(void *obj)
559 const AVOption *o = NULL;
560 while ((o = av_next_option(obj, o)))
561 if (o->type == FF_OPT_TYPE_STRING || o->type == FF_OPT_TYPE_BINARY)
562 av_freep((uint8_t *)obj + o->offset);
565 int av_opt_set_dict(void *obj, AVDictionary **options)
567 AVDictionaryEntry *t = NULL;
568 AVDictionary *tmp = NULL;
571 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
572 ret = av_set_string3(obj, t->key, t->value, 1, NULL);
573 if (ret == AVERROR_OPTION_NOT_FOUND)
574 av_dict_set(&tmp, t->key, t->value, 0);
576 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
581 av_dict_free(options);
586 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
587 int opt_flags, int search_flags)
589 AVClass *c = *(AVClass**)obj;
590 const AVOption *o = NULL;
592 if (c->opt_find && search_flags & AV_OPT_SEARCH_CHILDREN &&
593 (o = c->opt_find(obj, name, unit, opt_flags, search_flags)))
596 while (o = av_next_option(obj, o)) {
597 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
598 ((!unit && o->type != FF_OPT_TYPE_CONST) ||
599 (unit && o->unit && !strcmp(o->unit, unit))))
609 typedef struct TestContext
611 const AVClass *class;
619 #define OFFSET(x) offsetof(TestContext, x)
621 #define TEST_FLAG_COOL 01
622 #define TEST_FLAG_LAME 02
623 #define TEST_FLAG_MU 04
625 static const AVOption test_options[]= {
626 {"num", "set num", OFFSET(num), FF_OPT_TYPE_INT, {0}, 0, 100 },
627 {"toggle", "set toggle", OFFSET(toggle), FF_OPT_TYPE_INT, {0}, 0, 1 },
628 {"rational", "set rational", OFFSET(rational), FF_OPT_TYPE_RATIONAL, {0}, 0, 10 },
629 {"string", "set string", OFFSET(string), FF_OPT_TYPE_STRING, {0}, CHAR_MIN, CHAR_MAX },
630 {"flags", "set flags", OFFSET(flags), FF_OPT_TYPE_FLAGS, {0}, 0, INT_MAX, 0, "flags" },
631 {"cool", "set cool flag ", 0, FF_OPT_TYPE_CONST, {TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
632 {"lame", "set lame flag ", 0, FF_OPT_TYPE_CONST, {TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
633 {"mu", "set mu flag ", 0, FF_OPT_TYPE_CONST, {TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
637 static const char *test_get_name(void *ctx)
642 static const AVClass test_class = {
652 printf("\nTesting av_set_options_string()\n");
654 TestContext test_ctx;
655 const char *options[] = {
671 "flags=+mu-lame : num=42: toggle=0",
672 "num=42 : string=blahblah",
673 "rational=0 : rational=1/2 : rational=1/-1",
677 test_ctx.class = &test_class;
678 av_opt_set_defaults(&test_ctx);
679 test_ctx.string = av_strdup("default");
681 av_log_set_level(AV_LOG_DEBUG);
683 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
684 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
685 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
686 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);