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>
35 #include "mathematics.h"
37 const AVOption *av_opt_next(void *obj, const AVOption *last)
39 AVClass *class = *(AVClass**)obj;
40 if (!last && class->option && class->option[0].name)
42 if (last && last[1].name)
47 static int read_number(const AVOption *o, void *dst, double *num, int *den, int64_t *intnum)
50 case AV_OPT_TYPE_FLAGS: *intnum = *(unsigned int*)dst;return 0;
51 case AV_OPT_TYPE_INT: *intnum = *(int *)dst;return 0;
52 case AV_OPT_TYPE_INT64: *intnum = *(int64_t *)dst;return 0;
53 case AV_OPT_TYPE_FLOAT: *num = *(float *)dst;return 0;
54 case AV_OPT_TYPE_DOUBLE: *num = *(double *)dst;return 0;
55 case AV_OPT_TYPE_RATIONAL: *intnum = ((AVRational*)dst)->num;
56 *den = ((AVRational*)dst)->den;
59 return AVERROR(EINVAL);
62 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
64 if (o->max*den < num*intnum || o->min*den > num*intnum) {
65 av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range\n",
66 num*intnum/den, o->name);
67 return AVERROR(ERANGE);
71 case AV_OPT_TYPE_FLAGS:
72 case AV_OPT_TYPE_INT: *(int *)dst= llrint(num/den)*intnum; break;
73 case AV_OPT_TYPE_INT64: *(int64_t *)dst= llrint(num/den)*intnum; break;
74 case AV_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
75 case AV_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
76 case AV_OPT_TYPE_RATIONAL:
77 if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
78 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
81 return AVERROR(EINVAL);
86 static const double const_values[] = {
93 static const char * const const_names[] = {
100 static int hexchar2int(char c) {
101 if (c >= '0' && c <= '9') return c - '0';
102 if (c >= 'a' && c <= 'f') return c - 'a' + 10;
103 if (c >= 'A' && c <= 'F') return c - 'A' + 10;
107 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
109 int *lendst = (int *)(dst + 1);
111 int len = strlen(val);
117 return AVERROR(EINVAL);
120 ptr = bin = av_malloc(len);
122 int a = hexchar2int(*val++);
123 int b = hexchar2int(*val++);
124 if (a < 0 || b < 0) {
126 return AVERROR(EINVAL);
128 *ptr++ = (a << 4) | b;
136 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
139 *dst = av_strdup(val);
143 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
144 opt->type == AV_OPT_TYPE_CONST || \
145 opt->type == AV_OPT_TYPE_FLAGS || \
146 opt->type == AV_OPT_TYPE_INT) ? \
147 opt->default_val.i64 : opt->default_val.dbl)
149 static int set_string_number(void *obj, void *target_obj, const AVOption *o, const char *val, void *dst)
151 int ret = 0, notfirst = 0;
160 if (*val == '+' || *val == '-') {
161 if (o->type == AV_OPT_TYPE_FLAGS)
167 for (; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
172 const AVOption *o_named = av_opt_find(target_obj, buf, o->unit, 0, 0);
173 if (o_named && o_named->type == AV_OPT_TYPE_CONST)
174 d = DEFAULT_NUMVAL(o_named);
175 else if (!strcmp(buf, "default")) d = DEFAULT_NUMVAL(o);
176 else if (!strcmp(buf, "max" )) d = o->max;
177 else if (!strcmp(buf, "min" )) d = o->min;
178 else if (!strcmp(buf, "none" )) d = 0;
179 else if (!strcmp(buf, "all" )) d = ~0;
181 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
183 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
188 if (o->type == AV_OPT_TYPE_FLAGS) {
189 read_number(o, dst, NULL, NULL, &intnum);
190 if (cmd == '+') d = intnum | (int64_t)d;
191 else if (cmd == '-') d = intnum &~(int64_t)d;
193 read_number(o, dst, &num, &den, &intnum);
194 if (cmd == '+') d = notfirst*num*intnum/den + d;
195 else if (cmd == '-') d = notfirst*num*intnum/den - d;
198 if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
209 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
211 void *dst, *target_obj;
212 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
213 if (!o || !target_obj)
214 return AVERROR_OPTION_NOT_FOUND;
216 return AVERROR(EINVAL);
218 dst = ((uint8_t*)target_obj) + o->offset;
220 case AV_OPT_TYPE_STRING: return set_string(obj, o, val, dst);
221 case AV_OPT_TYPE_BINARY: return set_string_binary(obj, o, val, dst);
222 case AV_OPT_TYPE_FLAGS:
223 case AV_OPT_TYPE_INT:
224 case AV_OPT_TYPE_INT64:
225 case AV_OPT_TYPE_FLOAT:
226 case AV_OPT_TYPE_DOUBLE:
227 case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, target_obj, o, val, dst);
230 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
231 return AVERROR(EINVAL);
234 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
235 int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
237 if (!o || o->type != opttype)\
238 return AVERROR(EINVAL);\
239 return set_string_number(obj, obj, o, val, name ## _out);\
242 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
243 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
244 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
245 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
246 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
247 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
249 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
252 void *dst, *target_obj;
253 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
255 if (!o || !target_obj)
256 return AVERROR_OPTION_NOT_FOUND;
258 dst = ((uint8_t*)target_obj) + o->offset;
259 return write_number(obj, o, dst, num, den, intnum);
262 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
264 return set_number(obj, name, 1, 1, val, search_flags);
267 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
269 return set_number(obj, name, val, 1, 1, search_flags);
272 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
274 return set_number(obj, name, val.num, val.den, 1, search_flags);
277 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
280 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
285 if (!o || !target_obj)
286 return AVERROR_OPTION_NOT_FOUND;
288 if (o->type != AV_OPT_TYPE_BINARY)
289 return AVERROR(EINVAL);
291 ptr = av_malloc(len);
293 return AVERROR(ENOMEM);
295 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
296 lendst = (int *)(dst + 1);
301 memcpy(ptr, val, len);
306 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
308 void *dst, *target_obj;
309 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
310 uint8_t *bin, buf[128];
313 if (!o || !target_obj)
314 return AVERROR_OPTION_NOT_FOUND;
316 dst = (uint8_t*)target_obj + o->offset;
320 case AV_OPT_TYPE_FLAGS: ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);break;
321 case AV_OPT_TYPE_INT: ret = snprintf(buf, sizeof(buf), "%d" , *(int *)dst);break;
322 case AV_OPT_TYPE_INT64: ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
323 case AV_OPT_TYPE_FLOAT: ret = snprintf(buf, sizeof(buf), "%f" , *(float *)dst);break;
324 case AV_OPT_TYPE_DOUBLE: ret = snprintf(buf, sizeof(buf), "%f" , *(double *)dst);break;
325 case AV_OPT_TYPE_RATIONAL: ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
326 case AV_OPT_TYPE_STRING:
328 *out_val = av_strdup(*(uint8_t**)dst);
330 *out_val = av_strdup("");
332 case AV_OPT_TYPE_BINARY:
333 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
334 if ((uint64_t)len*2 + 1 > INT_MAX)
335 return AVERROR(EINVAL);
336 if (!(*out_val = av_malloc(len*2 + 1)))
337 return AVERROR(ENOMEM);
338 bin = *(uint8_t**)dst;
339 for (i = 0; i < len; i++)
340 snprintf(*out_val + i*2, 3, "%02X", bin[i]);
343 return AVERROR(EINVAL);
346 if (ret >= sizeof(buf))
347 return AVERROR(EINVAL);
348 *out_val = av_strdup(buf);
352 static int get_number(void *obj, const char *name, double *num, int *den, int64_t *intnum,
355 void *dst, *target_obj;
356 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
357 if (!o || !target_obj)
360 dst = ((uint8_t*)target_obj) + o->offset;
362 return read_number(o, dst, num, den, intnum);
369 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
375 if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
377 *out_val = num*intnum/den;
381 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
387 if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
389 *out_val = num*intnum/den;
393 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
399 if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
402 if (num == 1.0 && (int)intnum == intnum)
403 *out_val = (AVRational){intnum, den};
405 *out_val = av_d2q(num*intnum/den, 1<<24);
409 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
411 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
412 const AVOption *flag = av_opt_find(obj, flag_name,
413 field ? field->unit : NULL, 0, 0);
416 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
417 av_opt_get_int(obj, field_name, 0, &res) < 0)
419 return res & flag->default_val.i64;
422 static void opt_list(void *obj, void *av_log_obj, const char *unit,
423 int req_flags, int rej_flags)
425 const AVOption *opt=NULL;
427 while ((opt = av_opt_next(obj, opt))) {
428 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
431 /* Don't print CONST's on level one.
432 * Don't print anything but CONST's on level two.
433 * Only print items from the requested unit.
435 if (!unit && opt->type==AV_OPT_TYPE_CONST)
437 else if (unit && opt->type!=AV_OPT_TYPE_CONST)
439 else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
441 else if (unit && opt->type == AV_OPT_TYPE_CONST)
442 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
444 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
447 case AV_OPT_TYPE_FLAGS:
448 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
450 case AV_OPT_TYPE_INT:
451 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
453 case AV_OPT_TYPE_INT64:
454 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
456 case AV_OPT_TYPE_DOUBLE:
457 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
459 case AV_OPT_TYPE_FLOAT:
460 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
462 case AV_OPT_TYPE_STRING:
463 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
465 case AV_OPT_TYPE_RATIONAL:
466 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
468 case AV_OPT_TYPE_BINARY:
469 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
471 case AV_OPT_TYPE_CONST:
473 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
476 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
477 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
478 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
479 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
480 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
483 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
484 av_log(av_log_obj, AV_LOG_INFO, "\n");
485 if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
486 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
491 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
496 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
498 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
503 void av_opt_set_defaults(void *s)
505 const AVOption *opt = NULL;
506 while ((opt = av_opt_next(s, opt)) != NULL) {
508 case AV_OPT_TYPE_CONST:
509 /* Nothing to be done here */
511 case AV_OPT_TYPE_FLAGS:
512 case AV_OPT_TYPE_INT:
513 case AV_OPT_TYPE_INT64:
514 av_opt_set_int(s, opt->name, opt->default_val.i64, 0);
516 case AV_OPT_TYPE_DOUBLE:
517 case AV_OPT_TYPE_FLOAT: {
519 val = opt->default_val.dbl;
520 av_opt_set_double(s, opt->name, val, 0);
523 case AV_OPT_TYPE_RATIONAL: {
525 val = av_d2q(opt->default_val.dbl, INT_MAX);
526 av_opt_set_q(s, opt->name, val, 0);
529 case AV_OPT_TYPE_STRING:
530 av_opt_set(s, opt->name, opt->default_val.str, 0);
532 case AV_OPT_TYPE_BINARY:
533 /* Cannot set default for binary */
536 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
542 * Store the value in the field in ctx that is named like key.
543 * ctx must be an AVClass context, storing is done using AVOptions.
545 * @param buf the string to parse, buf will be updated to point at the
546 * separator just after the parsed key/value pair
547 * @param key_val_sep a 0-terminated list of characters used to
548 * separate key from value
549 * @param pairs_sep a 0-terminated list of characters used to separate
550 * two pairs from each other
551 * @return 0 if the key/value pair has been successfully parsed and
552 * set, or a negative value corresponding to an AVERROR code in case
554 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
555 * the error code issued by av_opt_set() if the key/value pair
558 static int parse_key_value_pair(void *ctx, const char **buf,
559 const char *key_val_sep, const char *pairs_sep)
561 char *key = av_get_token(buf, key_val_sep);
566 return AVERROR(ENOMEM);
568 if (*key && strspn(*buf, key_val_sep)) {
570 val = av_get_token(buf, pairs_sep);
573 return AVERROR(ENOMEM);
576 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
578 return AVERROR(EINVAL);
581 av_log(ctx, AV_LOG_DEBUG, "Setting value '%s' for key '%s'\n", val, key);
583 ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
584 if (ret == AVERROR_OPTION_NOT_FOUND)
585 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
592 int av_set_options_string(void *ctx, const char *opts,
593 const char *key_val_sep, const char *pairs_sep)
601 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
612 void av_opt_free(void *obj)
614 const AVOption *o = NULL;
615 while ((o = av_opt_next(obj, o)))
616 if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
617 av_freep((uint8_t *)obj + o->offset);
620 int av_opt_set_dict(void *obj, AVDictionary **options)
622 AVDictionaryEntry *t = NULL;
623 AVDictionary *tmp = NULL;
626 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
627 ret = av_opt_set(obj, t->key, t->value, 0);
628 if (ret == AVERROR_OPTION_NOT_FOUND)
629 av_dict_set(&tmp, t->key, t->value, 0);
631 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
636 av_dict_free(options);
641 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
642 int opt_flags, int search_flags)
644 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
647 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
648 int opt_flags, int search_flags, void **target_obj)
650 const AVClass *c = *(AVClass**)obj;
651 const AVOption *o = NULL;
653 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
654 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
655 const AVClass *child = NULL;
656 while (child = av_opt_child_class_next(c, child))
657 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
661 while (child = av_opt_child_next(obj, child))
662 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
667 while (o = av_opt_next(obj, o)) {
668 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
669 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
670 (unit && o->unit && !strcmp(o->unit, unit)))) {
672 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
683 void *av_opt_child_next(void *obj, void *prev)
685 const AVClass *c = *(AVClass**)obj;
687 return c->child_next(obj, prev);
691 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
693 if (parent->child_class_next)
694 return parent->child_class_next(prev);
700 typedef struct TestContext
702 const AVClass *class;
710 #define OFFSET(x) offsetof(TestContext, x)
712 #define TEST_FLAG_COOL 01
713 #define TEST_FLAG_LAME 02
714 #define TEST_FLAG_MU 04
716 static const AVOption test_options[]= {
717 {"num", "set num", OFFSET(num), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100 },
718 {"toggle", "set toggle", OFFSET(toggle), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1 },
719 {"rational", "set rational", OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0}, 0, 10 },
720 {"string", "set string", OFFSET(string), AV_OPT_TYPE_STRING, {0}, CHAR_MIN, CHAR_MAX },
721 {"flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, INT_MAX, 0, "flags" },
722 {"cool", "set cool flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
723 {"lame", "set lame flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
724 {"mu", "set mu flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
728 static const char *test_get_name(void *ctx)
733 static const AVClass test_class = {
743 printf("\nTesting av_set_options_string()\n");
745 TestContext test_ctx;
746 const char *options[] = {
762 "flags=+mu-lame : num=42: toggle=0",
763 "num=42 : string=blahblah",
764 "rational=0 : rational=1/2 : rational=1/-1",
768 test_ctx.class = &test_class;
769 av_opt_set_defaults(&test_ctx);
770 test_ctx.string = av_strdup("default");
772 av_log_set_level(AV_LOG_DEBUG);
774 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
775 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
776 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
777 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);