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>
31 #include "channel_layout.h"
36 #include "parseutils.h"
38 #include "mathematics.h"
40 #include "samplefmt.h"
45 const AVOption *av_opt_next(const void *obj, const AVOption *last)
50 class = *(const AVClass**)obj;
51 if (!last && class && class->option && class->option[0].name)
53 if (last && last[1].name)
58 static int read_number(const AVOption *o, const void *dst, double *num, int *den, int64_t *intnum)
61 case AV_OPT_TYPE_FLAGS:
62 *intnum = *(unsigned int*)dst;
64 case AV_OPT_TYPE_PIXEL_FMT:
65 *intnum = *(enum AVPixelFormat *)dst;
67 case AV_OPT_TYPE_SAMPLE_FMT:
68 *intnum = *(enum AVSampleFormat *)dst;
70 case AV_OPT_TYPE_BOOL:
72 *intnum = *(int *)dst;
74 case AV_OPT_TYPE_CHANNEL_LAYOUT:
75 case AV_OPT_TYPE_DURATION:
76 case AV_OPT_TYPE_INT64:
77 case AV_OPT_TYPE_UINT64:
78 *intnum = *(int64_t *)dst;
80 case AV_OPT_TYPE_FLOAT:
83 case AV_OPT_TYPE_DOUBLE:
84 *num = *(double *)dst;
86 case AV_OPT_TYPE_RATIONAL:
87 *intnum = ((AVRational *)dst)->num;
88 *den = ((AVRational *)dst)->den;
90 case AV_OPT_TYPE_CONST:
91 *num = o->default_val.dbl;
94 return AVERROR(EINVAL);
97 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
99 if (o->type != AV_OPT_TYPE_FLAGS &&
100 (!den || o->max * den < num * intnum || o->min * den > num * intnum)) {
101 num = den ? num * intnum / den : (num && intnum ? INFINITY : NAN);
102 av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range [%g - %g]\n",
103 num, o->name, o->min, o->max);
104 return AVERROR(ERANGE);
106 if (o->type == AV_OPT_TYPE_FLAGS) {
107 double d = num*intnum/den;
108 if (d < -1.5 || d > 0xFFFFFFFF+0.5 || (llrint(d*256) & 255)) {
109 av_log(obj, AV_LOG_ERROR,
110 "Value %f for parameter '%s' is not a valid set of 32bit integer flags\n",
111 num*intnum/den, o->name);
112 return AVERROR(ERANGE);
117 case AV_OPT_TYPE_PIXEL_FMT:
118 *(enum AVPixelFormat *)dst = llrint(num / den) * intnum;
120 case AV_OPT_TYPE_SAMPLE_FMT:
121 *(enum AVSampleFormat *)dst = llrint(num / den) * intnum;
123 case AV_OPT_TYPE_BOOL:
124 case AV_OPT_TYPE_FLAGS:
125 case AV_OPT_TYPE_INT:
126 *(int *)dst = llrint(num / den) * intnum;
128 case AV_OPT_TYPE_DURATION:
129 case AV_OPT_TYPE_CHANNEL_LAYOUT:
130 case AV_OPT_TYPE_INT64:{
131 double d = num / den;
132 if (intnum == 1 && d == (double)INT64_MAX) {
133 *(int64_t *)dst = INT64_MAX;
135 *(int64_t *)dst = llrint(d) * intnum;
137 case AV_OPT_TYPE_UINT64:{
138 double d = num / den;
139 // We must special case uint64_t here as llrint() does not support values
140 // outside the int64_t range and there is no portable function which does
141 // "INT64_MAX + 1ULL" is used as it is representable exactly as IEEE double
142 // while INT64_MAX is not
143 if (intnum == 1 && d == (double)UINT64_MAX) {
144 *(uint64_t *)dst = UINT64_MAX;
145 } else if (d > INT64_MAX + 1ULL) {
146 *(uint64_t *)dst = (llrint(d - (INT64_MAX + 1ULL)) + (INT64_MAX + 1ULL))*intnum;
148 *(uint64_t *)dst = llrint(d) * intnum;
151 case AV_OPT_TYPE_FLOAT:
152 *(float *)dst = num * intnum / den;
154 case AV_OPT_TYPE_DOUBLE:
155 *(double *)dst = num * intnum / den;
157 case AV_OPT_TYPE_RATIONAL:
158 case AV_OPT_TYPE_VIDEO_RATE:
159 if ((int) num == num)
160 *(AVRational *)dst = (AVRational) { num *intnum, den };
162 *(AVRational *)dst = av_d2q(num * intnum / den, 1 << 24);
165 return AVERROR(EINVAL);
170 static int hexchar2int(char c) {
171 if (c >= '0' && c <= '9')
173 if (c >= 'a' && c <= 'f')
175 if (c >= 'A' && c <= 'F')
180 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
182 int *lendst = (int *)(dst + 1);
189 if (!val || !(len = strlen(val)))
193 return AVERROR(EINVAL);
196 ptr = bin = av_malloc(len);
198 return AVERROR(ENOMEM);
200 int a = hexchar2int(*val++);
201 int b = hexchar2int(*val++);
202 if (a < 0 || b < 0) {
204 return AVERROR(EINVAL);
206 *ptr++ = (a << 4) | b;
214 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
217 *dst = av_strdup(val);
218 return *dst ? 0 : AVERROR(ENOMEM);
221 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
222 opt->type == AV_OPT_TYPE_UINT64 || \
223 opt->type == AV_OPT_TYPE_CONST || \
224 opt->type == AV_OPT_TYPE_FLAGS || \
225 opt->type == AV_OPT_TYPE_INT) \
226 ? opt->default_val.i64 \
227 : opt->default_val.dbl)
229 static int set_string_number(void *obj, void *target_obj, const AVOption *o, const char *val, void *dst)
235 if (sscanf(val, "%d%*1[:/]%d%c", &num, &den, &c) == 2) {
236 if ((ret = write_number(obj, o, dst, 1, den, num)) >= 0)
248 if (o->type == AV_OPT_TYPE_FLAGS) {
249 if (*val == '+' || *val == '-')
251 for (; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
257 const AVOption *o_named = av_opt_find(target_obj, i ? buf : val, o->unit, 0, 0);
260 double const_values[64];
261 const char * const_names[64];
262 if (o_named && o_named->type == AV_OPT_TYPE_CONST)
263 d = DEFAULT_NUMVAL(o_named);
266 for (o_named = NULL; o_named = av_opt_next(target_obj, o_named); ) {
267 if (o_named->type == AV_OPT_TYPE_CONST &&
269 !strcmp(o_named->unit, o->unit)) {
270 if (ci + 6 >= FF_ARRAY_ELEMS(const_values)) {
271 av_log(obj, AV_LOG_ERROR, "const_values array too small for %s\n", o->unit);
272 return AVERROR_PATCHWELCOME;
274 const_names [ci ] = o_named->name;
275 const_values[ci++] = DEFAULT_NUMVAL(o_named);
279 const_names [ci ] = "default";
280 const_values[ci++] = DEFAULT_NUMVAL(o);
281 const_names [ci ] = "max";
282 const_values[ci++] = o->max;
283 const_names [ci ] = "min";
284 const_values[ci++] = o->min;
285 const_names [ci ] = "none";
286 const_values[ci++] = 0;
287 const_names [ci ] = "all";
288 const_values[ci++] = ~0;
289 const_names [ci] = NULL;
290 const_values[ci] = 0;
292 res = av_expr_parse_and_eval(&d, i ? buf : val, const_names,
293 const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
295 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
300 if (o->type == AV_OPT_TYPE_FLAGS) {
301 read_number(o, dst, NULL, NULL, &intnum);
303 d = intnum | (int64_t)d;
305 d = intnum &~(int64_t)d;
308 if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
316 static int set_string_image_size(void *obj, const AVOption *o, const char *val, int *dst)
320 if (!val || !strcmp(val, "none")) {
325 ret = av_parse_video_size(dst, dst + 1, val);
327 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as image size\n", val);
331 static int set_string_video_rate(void *obj, const AVOption *o, const char *val, AVRational *dst)
335 ret = AVERROR(EINVAL);
337 ret = av_parse_video_rate(dst, val);
340 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as video rate\n", val);
344 static int set_string_color(void *obj, const AVOption *o, const char *val, uint8_t *dst)
351 ret = av_parse_color(dst, val, -1, obj);
353 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as color\n", val);
359 static const char *get_bool_name(int val)
363 return val ? "true" : "false";
366 static int set_string_bool(void *obj, const AVOption *o, const char *val, int *dst)
373 if (!strcmp(val, "auto")) {
375 } else if (av_match_name(val, "true,y,yes,enable,enabled,on")) {
377 } else if (av_match_name(val, "false,n,no,disable,disabled,off")) {
381 n = strtol(val, &end, 10);
382 if (val + strlen(val) != end)
386 if (n < o->min || n > o->max)
393 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as boolean\n", val);
394 return AVERROR(EINVAL);
397 static int set_string_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst,
398 int fmt_nb, int ((*get_fmt)(const char *)), const char *desc)
402 if (!val || !strcmp(val, "none")) {
408 fmt = strtol(val, &tail, 0);
409 if (*tail || (unsigned)fmt >= fmt_nb) {
410 av_log(obj, AV_LOG_ERROR,
411 "Unable to parse option value \"%s\" as %s\n", val, desc);
412 return AVERROR(EINVAL);
417 min = FFMAX(o->min, -1);
418 max = FFMIN(o->max, fmt_nb-1);
420 // hack for compatibility with old ffmpeg
421 if(min == 0 && max == 0) {
426 if (fmt < min || fmt > max) {
427 av_log(obj, AV_LOG_ERROR,
428 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
429 fmt, o->name, desc, min, max);
430 return AVERROR(ERANGE);
437 static int set_string_pixel_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
439 return set_string_fmt(obj, o, val, dst,
440 AV_PIX_FMT_NB, av_get_pix_fmt, "pixel format");
443 static int set_string_sample_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
445 return set_string_fmt(obj, o, val, dst,
446 AV_SAMPLE_FMT_NB, av_get_sample_fmt, "sample format");
449 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
452 void *dst, *target_obj;
453 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
454 if (!o || !target_obj)
455 return AVERROR_OPTION_NOT_FOUND;
456 if (!val && (o->type != AV_OPT_TYPE_STRING &&
457 o->type != AV_OPT_TYPE_PIXEL_FMT && o->type != AV_OPT_TYPE_SAMPLE_FMT &&
458 o->type != AV_OPT_TYPE_IMAGE_SIZE && o->type != AV_OPT_TYPE_VIDEO_RATE &&
459 o->type != AV_OPT_TYPE_DURATION && o->type != AV_OPT_TYPE_COLOR &&
460 o->type != AV_OPT_TYPE_CHANNEL_LAYOUT && o->type != AV_OPT_TYPE_BOOL))
461 return AVERROR(EINVAL);
463 if (o->flags & AV_OPT_FLAG_READONLY)
464 return AVERROR(EINVAL);
466 dst = ((uint8_t *)target_obj) + o->offset;
468 case AV_OPT_TYPE_BOOL:
469 return set_string_bool(obj, o, val, dst);
470 case AV_OPT_TYPE_STRING:
471 return set_string(obj, o, val, dst);
472 case AV_OPT_TYPE_BINARY:
473 return set_string_binary(obj, o, val, dst);
474 case AV_OPT_TYPE_FLAGS:
475 case AV_OPT_TYPE_INT:
476 case AV_OPT_TYPE_INT64:
477 case AV_OPT_TYPE_UINT64:
478 case AV_OPT_TYPE_FLOAT:
479 case AV_OPT_TYPE_DOUBLE:
480 case AV_OPT_TYPE_RATIONAL:
481 return set_string_number(obj, target_obj, o, val, dst);
482 case AV_OPT_TYPE_IMAGE_SIZE:
483 return set_string_image_size(obj, o, val, dst);
484 case AV_OPT_TYPE_VIDEO_RATE: {
486 ret = set_string_video_rate(obj, o, val, &tmp);
489 return write_number(obj, o, dst, 1, tmp.den, tmp.num);
491 case AV_OPT_TYPE_PIXEL_FMT:
492 return set_string_pixel_fmt(obj, o, val, dst);
493 case AV_OPT_TYPE_SAMPLE_FMT:
494 return set_string_sample_fmt(obj, o, val, dst);
495 case AV_OPT_TYPE_DURATION:
500 if ((ret = av_parse_time(dst, val, 1)) < 0)
501 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as duration\n", val);
505 case AV_OPT_TYPE_COLOR:
506 return set_string_color(obj, o, val, dst);
507 case AV_OPT_TYPE_CHANNEL_LAYOUT:
508 if (!val || !strcmp(val, "none")) {
511 int64_t cl = av_get_channel_layout(val);
513 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as channel layout\n", val);
514 ret = AVERROR(EINVAL);
516 *(int64_t *)dst = cl;
522 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
523 return AVERROR(EINVAL);
526 #define OPT_EVAL_NUMBER(name, opttype, vartype) \
527 int av_opt_eval_ ## name(void *obj, const AVOption *o, \
528 const char *val, vartype *name ## _out) \
530 if (!o || o->type != opttype || o->flags & AV_OPT_FLAG_READONLY) \
531 return AVERROR(EINVAL); \
532 return set_string_number(obj, obj, o, val, name ## _out); \
535 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
536 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
537 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
538 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
539 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
540 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
542 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
545 void *dst, *target_obj;
546 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
548 if (!o || !target_obj)
549 return AVERROR_OPTION_NOT_FOUND;
551 if (o->flags & AV_OPT_FLAG_READONLY)
552 return AVERROR(EINVAL);
554 dst = ((uint8_t *)target_obj) + o->offset;
555 return write_number(obj, o, dst, num, den, intnum);
558 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
560 return set_number(obj, name, 1, 1, val, search_flags);
563 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
565 return set_number(obj, name, val, 1, 1, search_flags);
568 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
570 return set_number(obj, name, val.num, val.den, 1, search_flags);
573 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
576 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
581 if (!o || !target_obj)
582 return AVERROR_OPTION_NOT_FOUND;
584 if (o->type != AV_OPT_TYPE_BINARY || o->flags & AV_OPT_FLAG_READONLY)
585 return AVERROR(EINVAL);
587 ptr = len ? av_malloc(len) : NULL;
589 return AVERROR(ENOMEM);
591 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
592 lendst = (int *)(dst + 1);
598 memcpy(ptr, val, len);
603 int av_opt_set_image_size(void *obj, const char *name, int w, int h, int search_flags)
606 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
608 if (!o || !target_obj)
609 return AVERROR_OPTION_NOT_FOUND;
610 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
611 av_log(obj, AV_LOG_ERROR,
612 "The value set by option '%s' is not an image size.\n", o->name);
613 return AVERROR(EINVAL);
616 av_log(obj, AV_LOG_ERROR,
617 "Invalid negative size value %dx%d for size '%s'\n", w, h, o->name);
618 return AVERROR(EINVAL);
620 *(int *)(((uint8_t *)target_obj) + o->offset) = w;
621 *(int *)(((uint8_t *)target_obj+sizeof(int)) + o->offset) = h;
625 int av_opt_set_video_rate(void *obj, const char *name, AVRational val, int search_flags)
628 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
630 if (!o || !target_obj)
631 return AVERROR_OPTION_NOT_FOUND;
632 if (o->type != AV_OPT_TYPE_VIDEO_RATE) {
633 av_log(obj, AV_LOG_ERROR,
634 "The value set by option '%s' is not a video rate.\n", o->name);
635 return AVERROR(EINVAL);
637 if (val.num <= 0 || val.den <= 0)
638 return AVERROR(EINVAL);
639 return set_number(obj, name, val.num, val.den, 1, search_flags);
642 static int set_format(void *obj, const char *name, int fmt, int search_flags,
643 enum AVOptionType type, const char *desc, int nb_fmts)
646 const AVOption *o = av_opt_find2(obj, name, NULL, 0,
647 search_flags, &target_obj);
650 if (!o || !target_obj)
651 return AVERROR_OPTION_NOT_FOUND;
652 if (o->type != type) {
653 av_log(obj, AV_LOG_ERROR,
654 "The value set by option '%s' is not a %s format", name, desc);
655 return AVERROR(EINVAL);
658 min = FFMAX(o->min, -1);
659 max = FFMIN(o->max, nb_fmts-1);
661 if (fmt < min || fmt > max) {
662 av_log(obj, AV_LOG_ERROR,
663 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
664 fmt, name, desc, min, max);
665 return AVERROR(ERANGE);
667 *(int *)(((uint8_t *)target_obj) + o->offset) = fmt;
671 int av_opt_set_pixel_fmt(void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
673 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_PIXEL_FMT, "pixel", AV_PIX_FMT_NB);
676 int av_opt_set_sample_fmt(void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
678 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_SAMPLE_FMT, "sample", AV_SAMPLE_FMT_NB);
681 int av_opt_set_channel_layout(void *obj, const char *name, int64_t cl, int search_flags)
684 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
686 if (!o || !target_obj)
687 return AVERROR_OPTION_NOT_FOUND;
688 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
689 av_log(obj, AV_LOG_ERROR,
690 "The value set by option '%s' is not a channel layout.\n", o->name);
691 return AVERROR(EINVAL);
693 *(int64_t *)(((uint8_t *)target_obj) + o->offset) = cl;
697 int av_opt_set_dict_val(void *obj, const char *name, const AVDictionary *val,
702 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
704 if (!o || !target_obj)
705 return AVERROR_OPTION_NOT_FOUND;
706 if (o->flags & AV_OPT_FLAG_READONLY)
707 return AVERROR(EINVAL);
709 dst = (AVDictionary **)(((uint8_t *)target_obj) + o->offset);
711 av_dict_copy(dst, val, 0);
716 static void format_duration(char *buf, size_t size, int64_t d)
720 av_assert0(size >= 25);
721 if (d < 0 && d != INT64_MIN) {
727 snprintf(buf, size, "INT64_MAX");
728 else if (d == INT64_MIN)
729 snprintf(buf, size, "INT64_MIN");
730 else if (d > (int64_t)3600*1000000)
731 snprintf(buf, size, "%"PRId64":%02d:%02d.%06d", d / 3600000000,
732 (int)((d / 60000000) % 60),
733 (int)((d / 1000000) % 60),
735 else if (d > 60*1000000)
736 snprintf(buf, size, "%d:%02d.%06d",
738 (int)((d / 1000000) % 60),
741 snprintf(buf, size, "%d.%06d",
744 e = buf + strlen(buf);
745 while (e > buf && e[-1] == '0')
747 if (e > buf && e[-1] == '.')
751 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
753 void *dst, *target_obj;
754 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
755 uint8_t *bin, buf[128];
759 if (!o || !target_obj || (o->offset<=0 && o->type != AV_OPT_TYPE_CONST))
760 return AVERROR_OPTION_NOT_FOUND;
762 dst = (uint8_t *)target_obj + o->offset;
766 case AV_OPT_TYPE_BOOL:
767 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(get_bool_name(*(int *)dst), "invalid"));
769 case AV_OPT_TYPE_FLAGS:
770 ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);
772 case AV_OPT_TYPE_INT:
773 ret = snprintf(buf, sizeof(buf), "%d", *(int *)dst);
775 case AV_OPT_TYPE_INT64:
776 ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t *)dst);
778 case AV_OPT_TYPE_UINT64:
779 ret = snprintf(buf, sizeof(buf), "%"PRIu64, *(uint64_t *)dst);
781 case AV_OPT_TYPE_FLOAT:
782 ret = snprintf(buf, sizeof(buf), "%f", *(float *)dst);
784 case AV_OPT_TYPE_DOUBLE:
785 ret = snprintf(buf, sizeof(buf), "%f", *(double *)dst);
787 case AV_OPT_TYPE_VIDEO_RATE:
788 case AV_OPT_TYPE_RATIONAL:
789 ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational *)dst)->num, ((AVRational *)dst)->den);
791 case AV_OPT_TYPE_CONST:
792 ret = snprintf(buf, sizeof(buf), "%f", o->default_val.dbl);
794 case AV_OPT_TYPE_STRING:
795 if (*(uint8_t **)dst) {
796 *out_val = av_strdup(*(uint8_t **)dst);
797 } else if (search_flags & AV_OPT_ALLOW_NULL) {
801 *out_val = av_strdup("");
803 return *out_val ? 0 : AVERROR(ENOMEM);
804 case AV_OPT_TYPE_BINARY:
805 if (!*(uint8_t **)dst && (search_flags & AV_OPT_ALLOW_NULL)) {
809 len = *(int *)(((uint8_t *)dst) + sizeof(uint8_t *));
810 if ((uint64_t)len * 2 + 1 > INT_MAX)
811 return AVERROR(EINVAL);
812 if (!(*out_val = av_malloc(len * 2 + 1)))
813 return AVERROR(ENOMEM);
818 bin = *(uint8_t **)dst;
819 for (i = 0; i < len; i++)
820 snprintf(*out_val + i * 2, 3, "%02X", bin[i]);
822 case AV_OPT_TYPE_IMAGE_SIZE:
823 ret = snprintf(buf, sizeof(buf), "%dx%d", ((int *)dst)[0], ((int *)dst)[1]);
825 case AV_OPT_TYPE_PIXEL_FMT:
826 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_pix_fmt_name(*(enum AVPixelFormat *)dst), "none"));
828 case AV_OPT_TYPE_SAMPLE_FMT:
829 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_sample_fmt_name(*(enum AVSampleFormat *)dst), "none"));
831 case AV_OPT_TYPE_DURATION:
832 i64 = *(int64_t *)dst;
833 format_duration(buf, sizeof(buf), i64);
834 ret = strlen(buf); // no overflow possible, checked by an assert
836 case AV_OPT_TYPE_COLOR:
837 ret = snprintf(buf, sizeof(buf), "0x%02x%02x%02x%02x",
838 (int)((uint8_t *)dst)[0], (int)((uint8_t *)dst)[1],
839 (int)((uint8_t *)dst)[2], (int)((uint8_t *)dst)[3]);
841 case AV_OPT_TYPE_CHANNEL_LAYOUT:
842 i64 = *(int64_t *)dst;
843 ret = snprintf(buf, sizeof(buf), "0x%"PRIx64, i64);
846 return AVERROR(EINVAL);
849 if (ret >= sizeof(buf))
850 return AVERROR(EINVAL);
851 *out_val = av_strdup(buf);
852 return *out_val ? 0 : AVERROR(ENOMEM);
855 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum,
858 void *dst, *target_obj;
859 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
860 if (!o || !target_obj)
863 dst = ((uint8_t *)target_obj) + o->offset;
865 if (o_out) *o_out= o;
867 return read_number(o, dst, num, den, intnum);
875 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
881 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
883 *out_val = num * intnum / den;
887 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
893 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
895 *out_val = num * intnum / den;
899 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
905 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
908 if (num == 1.0 && (int)intnum == intnum)
909 *out_val = (AVRational){intnum, den};
911 *out_val = av_d2q(num*intnum/den, 1<<24);
915 int av_opt_get_image_size(void *obj, const char *name, int search_flags, int *w_out, int *h_out)
917 void *dst, *target_obj;
918 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
919 if (!o || !target_obj)
920 return AVERROR_OPTION_NOT_FOUND;
921 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
922 av_log(obj, AV_LOG_ERROR,
923 "The value for option '%s' is not an image size.\n", name);
924 return AVERROR(EINVAL);
927 dst = ((uint8_t*)target_obj) + o->offset;
928 if (w_out) *w_out = *(int *)dst;
929 if (h_out) *h_out = *((int *)dst+1);
933 int av_opt_get_video_rate(void *obj, const char *name, int search_flags, AVRational *out_val)
939 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
942 if (num == 1.0 && (int)intnum == intnum)
943 *out_val = (AVRational) { intnum, den };
945 *out_val = av_d2q(num * intnum / den, 1 << 24);
949 static int get_format(void *obj, const char *name, int search_flags, int *out_fmt,
950 enum AVOptionType type, const char *desc)
952 void *dst, *target_obj;
953 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
954 if (!o || !target_obj)
955 return AVERROR_OPTION_NOT_FOUND;
956 if (o->type != type) {
957 av_log(obj, AV_LOG_ERROR,
958 "The value for option '%s' is not a %s format.\n", desc, name);
959 return AVERROR(EINVAL);
962 dst = ((uint8_t*)target_obj) + o->offset;
963 *out_fmt = *(int *)dst;
967 int av_opt_get_pixel_fmt(void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
969 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_PIXEL_FMT, "pixel");
972 int av_opt_get_sample_fmt(void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
974 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_SAMPLE_FMT, "sample");
977 int av_opt_get_channel_layout(void *obj, const char *name, int search_flags, int64_t *cl)
979 void *dst, *target_obj;
980 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
981 if (!o || !target_obj)
982 return AVERROR_OPTION_NOT_FOUND;
983 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
984 av_log(obj, AV_LOG_ERROR,
985 "The value for option '%s' is not a channel layout.\n", name);
986 return AVERROR(EINVAL);
989 dst = ((uint8_t*)target_obj) + o->offset;
990 *cl = *(int64_t *)dst;
994 int av_opt_get_dict_val(void *obj, const char *name, int search_flags, AVDictionary **out_val)
998 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
1000 if (!o || !target_obj)
1001 return AVERROR_OPTION_NOT_FOUND;
1002 if (o->type != AV_OPT_TYPE_DICT)
1003 return AVERROR(EINVAL);
1005 src = *(AVDictionary **)(((uint8_t *)target_obj) + o->offset);
1006 av_dict_copy(out_val, src, 0);
1011 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
1013 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
1014 const AVOption *flag = av_opt_find(obj, flag_name,
1015 field ? field->unit : NULL, 0, 0);
1018 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
1019 av_opt_get_int(obj, field_name, 0, &res) < 0)
1021 return res & flag->default_val.i64;
1024 static void log_value(void *av_log_obj, int level, double d)
1027 av_log(av_log_obj, level, "INT_MAX");
1028 } else if (d == INT_MIN) {
1029 av_log(av_log_obj, level, "INT_MIN");
1030 } else if (d == UINT32_MAX) {
1031 av_log(av_log_obj, level, "UINT32_MAX");
1032 } else if (d == (double)INT64_MAX) {
1033 av_log(av_log_obj, level, "I64_MAX");
1034 } else if (d == INT64_MIN) {
1035 av_log(av_log_obj, level, "I64_MIN");
1036 } else if (d == FLT_MAX) {
1037 av_log(av_log_obj, level, "FLT_MAX");
1038 } else if (d == FLT_MIN) {
1039 av_log(av_log_obj, level, "FLT_MIN");
1040 } else if (d == -FLT_MAX) {
1041 av_log(av_log_obj, level, "-FLT_MAX");
1042 } else if (d == -FLT_MIN) {
1043 av_log(av_log_obj, level, "-FLT_MIN");
1044 } else if (d == DBL_MAX) {
1045 av_log(av_log_obj, level, "DBL_MAX");
1046 } else if (d == DBL_MIN) {
1047 av_log(av_log_obj, level, "DBL_MIN");
1048 } else if (d == -DBL_MAX) {
1049 av_log(av_log_obj, level, "-DBL_MAX");
1050 } else if (d == -DBL_MIN) {
1051 av_log(av_log_obj, level, "-DBL_MIN");
1053 av_log(av_log_obj, level, "%g", d);
1057 static const char *get_opt_const_name(void *obj, const char *unit, int64_t value)
1059 const AVOption *opt = NULL;
1063 while ((opt = av_opt_next(obj, opt)))
1064 if (opt->type == AV_OPT_TYPE_CONST && !strcmp(opt->unit, unit) &&
1065 opt->default_val.i64 == value)
1070 static char *get_opt_flags_string(void *obj, const char *unit, int64_t value)
1072 const AVOption *opt = NULL;
1078 while ((opt = av_opt_next(obj, opt))) {
1079 if (opt->type == AV_OPT_TYPE_CONST && !strcmp(opt->unit, unit) &&
1080 opt->default_val.i64 & value) {
1082 av_strlcatf(flags, sizeof(flags), "+");
1083 av_strlcatf(flags, sizeof(flags), "%s", opt->name);
1087 return av_strdup(flags);
1091 static void opt_list(void *obj, void *av_log_obj, const char *unit,
1092 int req_flags, int rej_flags)
1094 const AVOption *opt = NULL;
1098 while ((opt = av_opt_next(obj, opt))) {
1099 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
1102 /* Don't print CONST's on level one.
1103 * Don't print anything but CONST's on level two.
1104 * Only print items from the requested unit.
1106 if (!unit && opt->type == AV_OPT_TYPE_CONST)
1108 else if (unit && opt->type != AV_OPT_TYPE_CONST)
1110 else if (unit && opt->type == AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
1112 else if (unit && opt->type == AV_OPT_TYPE_CONST)
1113 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
1115 av_log(av_log_obj, AV_LOG_INFO, " %s%-17s ",
1116 (opt->flags & AV_OPT_FLAG_FILTERING_PARAM) ? "" : "-",
1119 switch (opt->type) {
1120 case AV_OPT_TYPE_FLAGS:
1121 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<flags>");
1123 case AV_OPT_TYPE_INT:
1124 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int>");
1126 case AV_OPT_TYPE_INT64:
1127 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int64>");
1129 case AV_OPT_TYPE_UINT64:
1130 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<uint64>");
1132 case AV_OPT_TYPE_DOUBLE:
1133 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<double>");
1135 case AV_OPT_TYPE_FLOAT:
1136 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<float>");
1138 case AV_OPT_TYPE_STRING:
1139 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<string>");
1141 case AV_OPT_TYPE_RATIONAL:
1142 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<rational>");
1144 case AV_OPT_TYPE_BINARY:
1145 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<binary>");
1147 case AV_OPT_TYPE_IMAGE_SIZE:
1148 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<image_size>");
1150 case AV_OPT_TYPE_VIDEO_RATE:
1151 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<video_rate>");
1153 case AV_OPT_TYPE_PIXEL_FMT:
1154 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<pix_fmt>");
1156 case AV_OPT_TYPE_SAMPLE_FMT:
1157 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<sample_fmt>");
1159 case AV_OPT_TYPE_DURATION:
1160 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<duration>");
1162 case AV_OPT_TYPE_COLOR:
1163 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<color>");
1165 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1166 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<channel_layout>");
1168 case AV_OPT_TYPE_BOOL:
1169 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<boolean>");
1171 case AV_OPT_TYPE_CONST:
1173 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "");
1176 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
1177 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
1178 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_FILTERING_PARAM)? 'F' : '.');
1179 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
1180 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
1181 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
1182 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_EXPORT) ? 'X' : '.');
1183 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_READONLY) ? 'R' : '.');
1184 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_BSF_PARAM) ? 'B' : '.');
1187 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
1189 if (av_opt_query_ranges(&r, obj, opt->name, AV_OPT_SEARCH_FAKE_OBJ) >= 0) {
1190 switch (opt->type) {
1191 case AV_OPT_TYPE_INT:
1192 case AV_OPT_TYPE_INT64:
1193 case AV_OPT_TYPE_UINT64:
1194 case AV_OPT_TYPE_DOUBLE:
1195 case AV_OPT_TYPE_FLOAT:
1196 case AV_OPT_TYPE_RATIONAL:
1197 for (i = 0; i < r->nb_ranges; i++) {
1198 av_log(av_log_obj, AV_LOG_INFO, " (from ");
1199 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_min);
1200 av_log(av_log_obj, AV_LOG_INFO, " to ");
1201 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_max);
1202 av_log(av_log_obj, AV_LOG_INFO, ")");
1206 av_opt_freep_ranges(&r);
1209 if (opt->type != AV_OPT_TYPE_CONST &&
1210 opt->type != AV_OPT_TYPE_BINARY &&
1211 !((opt->type == AV_OPT_TYPE_COLOR ||
1212 opt->type == AV_OPT_TYPE_IMAGE_SIZE ||
1213 opt->type == AV_OPT_TYPE_STRING ||
1214 opt->type == AV_OPT_TYPE_VIDEO_RATE) &&
1215 !opt->default_val.str)) {
1216 av_log(av_log_obj, AV_LOG_INFO, " (default ");
1217 switch (opt->type) {
1218 case AV_OPT_TYPE_BOOL:
1219 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(get_bool_name(opt->default_val.i64), "invalid"));
1221 case AV_OPT_TYPE_FLAGS: {
1222 char *def_flags = get_opt_flags_string(obj, opt->unit, opt->default_val.i64);
1224 av_log(av_log_obj, AV_LOG_INFO, "%s", def_flags);
1225 av_freep(&def_flags);
1227 av_log(av_log_obj, AV_LOG_INFO, "%"PRIX64, opt->default_val.i64);
1231 case AV_OPT_TYPE_DURATION: {
1233 format_duration(buf, sizeof(buf), opt->default_val.i64);
1234 av_log(av_log_obj, AV_LOG_INFO, "%s", buf);
1237 case AV_OPT_TYPE_INT:
1238 case AV_OPT_TYPE_UINT64:
1239 case AV_OPT_TYPE_INT64: {
1240 const char *def_const = get_opt_const_name(obj, opt->unit, opt->default_val.i64);
1242 av_log(av_log_obj, AV_LOG_INFO, "%s", def_const);
1244 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.i64);
1247 case AV_OPT_TYPE_DOUBLE:
1248 case AV_OPT_TYPE_FLOAT:
1249 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.dbl);
1251 case AV_OPT_TYPE_RATIONAL: {
1252 AVRational q = av_d2q(opt->default_val.dbl, INT_MAX);
1253 av_log(av_log_obj, AV_LOG_INFO, "%d/%d", q.num, q.den); }
1255 case AV_OPT_TYPE_PIXEL_FMT:
1256 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_pix_fmt_name(opt->default_val.i64), "none"));
1258 case AV_OPT_TYPE_SAMPLE_FMT:
1259 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_sample_fmt_name(opt->default_val.i64), "none"));
1261 case AV_OPT_TYPE_COLOR:
1262 case AV_OPT_TYPE_IMAGE_SIZE:
1263 case AV_OPT_TYPE_STRING:
1264 case AV_OPT_TYPE_VIDEO_RATE:
1265 av_log(av_log_obj, AV_LOG_INFO, "\"%s\"", opt->default_val.str);
1267 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1268 av_log(av_log_obj, AV_LOG_INFO, "0x%"PRIx64, opt->default_val.i64);
1271 av_log(av_log_obj, AV_LOG_INFO, ")");
1274 av_log(av_log_obj, AV_LOG_INFO, "\n");
1275 if (opt->unit && opt->type != AV_OPT_TYPE_CONST)
1276 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
1280 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
1285 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass **)obj)->class_name);
1287 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
1292 void av_opt_set_defaults(void *s)
1294 av_opt_set_defaults2(s, 0, 0);
1297 void av_opt_set_defaults2(void *s, int mask, int flags)
1299 const AVOption *opt = NULL;
1300 while ((opt = av_opt_next(s, opt))) {
1301 void *dst = ((uint8_t*)s) + opt->offset;
1303 if ((opt->flags & mask) != flags)
1306 if (opt->flags & AV_OPT_FLAG_READONLY)
1309 switch (opt->type) {
1310 case AV_OPT_TYPE_CONST:
1311 /* Nothing to be done here */
1313 case AV_OPT_TYPE_BOOL:
1314 case AV_OPT_TYPE_FLAGS:
1315 case AV_OPT_TYPE_INT:
1316 case AV_OPT_TYPE_INT64:
1317 case AV_OPT_TYPE_UINT64:
1318 case AV_OPT_TYPE_DURATION:
1319 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1320 case AV_OPT_TYPE_PIXEL_FMT:
1321 case AV_OPT_TYPE_SAMPLE_FMT:
1322 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1324 case AV_OPT_TYPE_DOUBLE:
1325 case AV_OPT_TYPE_FLOAT: {
1327 val = opt->default_val.dbl;
1328 write_number(s, opt, dst, val, 1, 1);
1331 case AV_OPT_TYPE_RATIONAL: {
1333 val = av_d2q(opt->default_val.dbl, INT_MAX);
1334 write_number(s, opt, dst, 1, val.den, val.num);
1337 case AV_OPT_TYPE_COLOR:
1338 set_string_color(s, opt, opt->default_val.str, dst);
1340 case AV_OPT_TYPE_STRING:
1341 set_string(s, opt, opt->default_val.str, dst);
1343 case AV_OPT_TYPE_IMAGE_SIZE:
1344 set_string_image_size(s, opt, opt->default_val.str, dst);
1346 case AV_OPT_TYPE_VIDEO_RATE:
1347 set_string_video_rate(s, opt, opt->default_val.str, dst);
1349 case AV_OPT_TYPE_BINARY:
1350 set_string_binary(s, opt, opt->default_val.str, dst);
1352 case AV_OPT_TYPE_DICT:
1353 /* Cannot set defaults for these types */
1356 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n",
1357 opt->type, opt->name);
1363 * Store the value in the field in ctx that is named like key.
1364 * ctx must be an AVClass context, storing is done using AVOptions.
1366 * @param buf the string to parse, buf will be updated to point at the
1367 * separator just after the parsed key/value pair
1368 * @param key_val_sep a 0-terminated list of characters used to
1369 * separate key from value
1370 * @param pairs_sep a 0-terminated list of characters used to separate
1371 * two pairs from each other
1372 * @return 0 if the key/value pair has been successfully parsed and
1373 * set, or a negative value corresponding to an AVERROR code in case
1375 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
1376 * the error code issued by av_opt_set() if the key/value pair
1379 static int parse_key_value_pair(void *ctx, const char **buf,
1380 const char *key_val_sep, const char *pairs_sep)
1382 char *key = av_get_token(buf, key_val_sep);
1387 return AVERROR(ENOMEM);
1389 if (*key && strspn(*buf, key_val_sep)) {
1391 val = av_get_token(buf, pairs_sep);
1394 return AVERROR(ENOMEM);
1397 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
1399 return AVERROR(EINVAL);
1402 av_log(ctx, AV_LOG_DEBUG, "Setting entry with key '%s' to value '%s'\n", key, val);
1404 ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
1405 if (ret == AVERROR_OPTION_NOT_FOUND)
1406 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
1413 int av_set_options_string(void *ctx, const char *opts,
1414 const char *key_val_sep, const char *pairs_sep)
1422 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
1433 #define WHITESPACES " \n\t\r"
1435 static int is_key_char(char c)
1437 return (unsigned)((c | 32) - 'a') < 26 ||
1438 (unsigned)(c - '0') < 10 ||
1439 c == '-' || c == '_' || c == '/' || c == '.';
1443 * Read a key from a string.
1445 * The key consists of is_key_char characters and must be terminated by a
1446 * character from the delim string; spaces are ignored.
1448 * @return 0 for success (even with ellipsis), <0 for failure
1450 static int get_key(const char **ropts, const char *delim, char **rkey)
1452 const char *opts = *ropts;
1453 const char *key_start, *key_end;
1455 key_start = opts += strspn(opts, WHITESPACES);
1456 while (is_key_char(*opts))
1459 opts += strspn(opts, WHITESPACES);
1460 if (!*opts || !strchr(delim, *opts))
1461 return AVERROR(EINVAL);
1463 if (!(*rkey = av_malloc(key_end - key_start + 1)))
1464 return AVERROR(ENOMEM);
1465 memcpy(*rkey, key_start, key_end - key_start);
1466 (*rkey)[key_end - key_start] = 0;
1471 int av_opt_get_key_value(const char **ropts,
1472 const char *key_val_sep, const char *pairs_sep,
1474 char **rkey, char **rval)
1477 char *key = NULL, *val;
1478 const char *opts = *ropts;
1480 if ((ret = get_key(&opts, key_val_sep, &key)) < 0 &&
1481 !(flags & AV_OPT_FLAG_IMPLICIT_KEY))
1482 return AVERROR(EINVAL);
1483 if (!(val = av_get_token(&opts, pairs_sep))) {
1485 return AVERROR(ENOMEM);
1493 int av_opt_set_from_string(void *ctx, const char *opts,
1494 const char *const *shorthand,
1495 const char *key_val_sep, const char *pairs_sep)
1498 const char *dummy_shorthand = NULL;
1499 char *av_uninit(parsed_key), *av_uninit(value);
1505 shorthand = &dummy_shorthand;
1508 ret = av_opt_get_key_value(&opts, key_val_sep, pairs_sep,
1509 *shorthand ? AV_OPT_FLAG_IMPLICIT_KEY : 0,
1510 &parsed_key, &value);
1512 if (ret == AVERROR(EINVAL))
1513 av_log(ctx, AV_LOG_ERROR, "No option name near '%s'\n", opts);
1515 av_log(ctx, AV_LOG_ERROR, "Unable to parse '%s': %s\n", opts,
1523 while (*shorthand) /* discard all remaining shorthand */
1526 key = *(shorthand++);
1529 av_log(ctx, AV_LOG_DEBUG, "Setting '%s' to value '%s'\n", key, value);
1530 if ((ret = av_opt_set(ctx, key, value, 0)) < 0) {
1531 if (ret == AVERROR_OPTION_NOT_FOUND)
1532 av_log(ctx, AV_LOG_ERROR, "Option '%s' not found\n", key);
1534 av_free(parsed_key);
1539 av_free(parsed_key);
1545 void av_opt_free(void *obj)
1547 const AVOption *o = NULL;
1548 while ((o = av_opt_next(obj, o))) {
1550 case AV_OPT_TYPE_STRING:
1551 case AV_OPT_TYPE_BINARY:
1552 av_freep((uint8_t *)obj + o->offset);
1555 case AV_OPT_TYPE_DICT:
1556 av_dict_free((AVDictionary **)(((uint8_t *)obj) + o->offset));
1565 int av_opt_set_dict2(void *obj, AVDictionary **options, int search_flags)
1567 AVDictionaryEntry *t = NULL;
1568 AVDictionary *tmp = NULL;
1574 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
1575 ret = av_opt_set(obj, t->key, t->value, search_flags);
1576 if (ret == AVERROR_OPTION_NOT_FOUND)
1577 ret = av_dict_set(&tmp, t->key, t->value, 0);
1579 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
1585 av_dict_free(options);
1590 int av_opt_set_dict(void *obj, AVDictionary **options)
1592 return av_opt_set_dict2(obj, options, 0);
1595 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
1596 int opt_flags, int search_flags)
1598 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
1601 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
1602 int opt_flags, int search_flags, void **target_obj)
1605 const AVOption *o = NULL;
1615 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
1616 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
1617 const AVClass *child = NULL;
1618 while (child = av_opt_child_class_next(c, child))
1619 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
1623 while (child = av_opt_child_next(obj, child))
1624 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
1629 while (o = av_opt_next(obj, o)) {
1630 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
1631 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
1632 (unit && o->type == AV_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)))) {
1634 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
1645 void *av_opt_child_next(void *obj, void *prev)
1647 const AVClass *c = *(AVClass **)obj;
1649 return c->child_next(obj, prev);
1653 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
1655 if (parent->child_class_next)
1656 return parent->child_class_next(prev);
1660 void *av_opt_ptr(const AVClass *class, void *obj, const char *name)
1662 const AVOption *opt= av_opt_find2(&class, name, NULL, 0, AV_OPT_SEARCH_FAKE_OBJ, NULL);
1665 return (uint8_t*)obj + opt->offset;
1668 static int opt_size(enum AVOptionType type)
1671 case AV_OPT_TYPE_BOOL:
1672 case AV_OPT_TYPE_INT:
1673 case AV_OPT_TYPE_FLAGS:
1675 case AV_OPT_TYPE_DURATION:
1676 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1677 case AV_OPT_TYPE_INT64:
1678 case AV_OPT_TYPE_UINT64:
1679 return sizeof(int64_t);
1680 case AV_OPT_TYPE_DOUBLE:
1681 return sizeof(double);
1682 case AV_OPT_TYPE_FLOAT:
1683 return sizeof(float);
1684 case AV_OPT_TYPE_STRING:
1685 return sizeof(uint8_t*);
1686 case AV_OPT_TYPE_VIDEO_RATE:
1687 case AV_OPT_TYPE_RATIONAL:
1688 return sizeof(AVRational);
1689 case AV_OPT_TYPE_BINARY:
1690 return sizeof(uint8_t*) + sizeof(int);
1691 case AV_OPT_TYPE_IMAGE_SIZE:
1692 return sizeof(int[2]);
1693 case AV_OPT_TYPE_PIXEL_FMT:
1694 return sizeof(enum AVPixelFormat);
1695 case AV_OPT_TYPE_SAMPLE_FMT:
1696 return sizeof(enum AVSampleFormat);
1697 case AV_OPT_TYPE_COLOR:
1700 return AVERROR(EINVAL);
1703 int av_opt_copy(void *dst, const void *src)
1705 const AVOption *o = NULL;
1710 return AVERROR(EINVAL);
1712 c = *(AVClass **)src;
1713 if (!c || c != *(AVClass **)dst)
1714 return AVERROR(EINVAL);
1716 while ((o = av_opt_next(src, o))) {
1717 void *field_dst = (uint8_t *)dst + o->offset;
1718 void *field_src = (uint8_t *)src + o->offset;
1719 uint8_t **field_dst8 = (uint8_t **)field_dst;
1720 uint8_t **field_src8 = (uint8_t **)field_src;
1722 if (o->type == AV_OPT_TYPE_STRING) {
1723 if (*field_dst8 != *field_src8)
1724 av_freep(field_dst8);
1725 *field_dst8 = av_strdup(*field_src8);
1726 if (*field_src8 && !*field_dst8)
1727 ret = AVERROR(ENOMEM);
1728 } else if (o->type == AV_OPT_TYPE_BINARY) {
1729 int len = *(int *)(field_src8 + 1);
1730 if (*field_dst8 != *field_src8)
1731 av_freep(field_dst8);
1732 *field_dst8 = av_memdup(*field_src8, len);
1733 if (len && !*field_dst8) {
1734 ret = AVERROR(ENOMEM);
1737 *(int *)(field_dst8 + 1) = len;
1738 } else if (o->type == AV_OPT_TYPE_CONST) {
1740 } else if (o->type == AV_OPT_TYPE_DICT) {
1741 AVDictionary **sdict = (AVDictionary **) field_src;
1742 AVDictionary **ddict = (AVDictionary **) field_dst;
1743 if (*sdict != *ddict)
1744 av_dict_free(ddict);
1746 av_dict_copy(ddict, *sdict, 0);
1747 if (av_dict_count(*sdict) != av_dict_count(*ddict))
1748 ret = AVERROR(ENOMEM);
1750 int size = opt_size(o->type);
1754 memcpy(field_dst, field_src, size);
1760 int av_opt_query_ranges(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1763 const AVClass *c = *(AVClass**)obj;
1764 int (*callback)(AVOptionRanges **, void *obj, const char *key, int flags) = NULL;
1766 if (c->version > (52 << 16 | 11 << 8))
1767 callback = c->query_ranges;
1770 callback = av_opt_query_ranges_default;
1772 ret = callback(ranges_arg, obj, key, flags);
1774 if (!(flags & AV_OPT_MULTI_COMPONENT_RANGE))
1776 (*ranges_arg)->nb_components = ret;
1781 int av_opt_query_ranges_default(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1783 AVOptionRanges *ranges = av_mallocz(sizeof(*ranges));
1784 AVOptionRange **range_array = av_mallocz(sizeof(void*));
1785 AVOptionRange *range = av_mallocz(sizeof(*range));
1786 const AVOption *field = av_opt_find(obj, key, NULL, 0, flags);
1791 if (!ranges || !range || !range_array || !field) {
1792 ret = AVERROR(ENOMEM);
1796 ranges->range = range_array;
1797 ranges->range[0] = range;
1798 ranges->nb_ranges = 1;
1799 ranges->nb_components = 1;
1800 range->is_range = 1;
1801 range->value_min = field->min;
1802 range->value_max = field->max;
1804 switch (field->type) {
1805 case AV_OPT_TYPE_BOOL:
1806 case AV_OPT_TYPE_INT:
1807 case AV_OPT_TYPE_INT64:
1808 case AV_OPT_TYPE_UINT64:
1809 case AV_OPT_TYPE_PIXEL_FMT:
1810 case AV_OPT_TYPE_SAMPLE_FMT:
1811 case AV_OPT_TYPE_FLOAT:
1812 case AV_OPT_TYPE_DOUBLE:
1813 case AV_OPT_TYPE_DURATION:
1814 case AV_OPT_TYPE_COLOR:
1815 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1817 case AV_OPT_TYPE_STRING:
1818 range->component_min = 0;
1819 range->component_max = 0x10FFFF; // max unicode value
1820 range->value_min = -1;
1821 range->value_max = INT_MAX;
1823 case AV_OPT_TYPE_RATIONAL:
1824 range->component_min = INT_MIN;
1825 range->component_max = INT_MAX;
1827 case AV_OPT_TYPE_IMAGE_SIZE:
1828 range->component_min = 0;
1829 range->component_max = INT_MAX/128/8;
1830 range->value_min = 0;
1831 range->value_max = INT_MAX/8;
1833 case AV_OPT_TYPE_VIDEO_RATE:
1834 range->component_min = 1;
1835 range->component_max = INT_MAX;
1836 range->value_min = 1;
1837 range->value_max = INT_MAX;
1840 ret = AVERROR(ENOSYS);
1844 *ranges_arg = ranges;
1849 av_free(range_array);
1853 void av_opt_freep_ranges(AVOptionRanges **rangesp)
1856 AVOptionRanges *ranges = *rangesp;
1861 for (i = 0; i < ranges->nb_ranges * ranges->nb_components; i++) {
1862 AVOptionRange *range = ranges->range[i];
1864 av_freep(&range->str);
1865 av_freep(&ranges->range[i]);
1868 av_freep(&ranges->range);
1872 int av_opt_is_set_to_default(void *obj, const AVOption *o)
1883 return AVERROR(EINVAL);
1885 dst = ((uint8_t*)obj) + o->offset;
1888 case AV_OPT_TYPE_CONST:
1890 case AV_OPT_TYPE_BOOL:
1891 case AV_OPT_TYPE_FLAGS:
1892 case AV_OPT_TYPE_PIXEL_FMT:
1893 case AV_OPT_TYPE_SAMPLE_FMT:
1894 case AV_OPT_TYPE_INT:
1895 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1896 case AV_OPT_TYPE_DURATION:
1897 case AV_OPT_TYPE_INT64:
1898 case AV_OPT_TYPE_UINT64:
1899 read_number(o, dst, NULL, NULL, &i64);
1900 return o->default_val.i64 == i64;
1901 case AV_OPT_TYPE_STRING:
1902 str = *(char **)dst;
1903 if (str == o->default_val.str) //2 NULLs
1905 if (!str || !o->default_val.str) //1 NULL
1907 return !strcmp(str, o->default_val.str);
1908 case AV_OPT_TYPE_DOUBLE:
1909 read_number(o, dst, &d, NULL, NULL);
1910 return o->default_val.dbl == d;
1911 case AV_OPT_TYPE_FLOAT:
1912 read_number(o, dst, &d, NULL, NULL);
1913 f = o->default_val.dbl;
1916 case AV_OPT_TYPE_RATIONAL:
1917 q = av_d2q(o->default_val.dbl, INT_MAX);
1918 return !av_cmp_q(*(AVRational*)dst, q);
1919 case AV_OPT_TYPE_BINARY: {
1924 int opt_size = *(int *)((void **)dst + 1);
1925 void *opt_ptr = *(void **)dst;
1926 if (!opt_size && (!o->default_val.str || !strlen(o->default_val.str)))
1928 if (!opt_size || !o->default_val.str || !strlen(o->default_val.str ))
1930 if (opt_size != strlen(o->default_val.str) / 2)
1932 ret = set_string_binary(NULL, NULL, o->default_val.str, &tmp.data);
1934 ret = !memcmp(opt_ptr, tmp.data, tmp.size);
1938 case AV_OPT_TYPE_DICT:
1939 /* Binary and dict have not default support yet. Any pointer is not default. */
1940 return !!(*(void **)dst);
1941 case AV_OPT_TYPE_IMAGE_SIZE:
1942 if (!o->default_val.str || !strcmp(o->default_val.str, "none"))
1944 else if ((ret = av_parse_video_size(&w, &h, o->default_val.str)) < 0)
1946 return (w == *(int *)dst) && (h == *((int *)dst+1));
1947 case AV_OPT_TYPE_VIDEO_RATE:
1948 q = (AVRational){0, 0};
1949 if (o->default_val.str) {
1950 if ((ret = av_parse_video_rate(&q, o->default_val.str)) < 0)
1953 return !av_cmp_q(*(AVRational*)dst, q);
1954 case AV_OPT_TYPE_COLOR: {
1955 uint8_t color[4] = {0, 0, 0, 0};
1956 if (o->default_val.str) {
1957 if ((ret = av_parse_color(color, o->default_val.str, -1, NULL)) < 0)
1960 return !memcmp(color, dst, sizeof(color));
1963 av_log(obj, AV_LOG_WARNING, "Not supported option type: %d, option name: %s\n", o->type, o->name);
1966 return AVERROR_PATCHWELCOME;
1969 int av_opt_is_set_to_default_by_name(void *obj, const char *name, int search_flags)
1974 return AVERROR(EINVAL);
1975 o = av_opt_find2(obj, name, NULL, 0, search_flags, &target);
1977 return AVERROR_OPTION_NOT_FOUND;
1978 return av_opt_is_set_to_default(target, o);
1981 int av_opt_serialize(void *obj, int opt_flags, int flags, char **buffer,
1982 const char key_val_sep, const char pairs_sep)
1984 const AVOption *o = NULL;
1988 const char special_chars[] = {pairs_sep, key_val_sep, '\0'};
1990 if (pairs_sep == '\0' || key_val_sep == '\0' || pairs_sep == key_val_sep ||
1991 pairs_sep == '\\' || key_val_sep == '\\') {
1992 av_log(obj, AV_LOG_ERROR, "Invalid separator(s) found.");
1993 return AVERROR(EINVAL);
1996 if (!obj || !buffer)
1997 return AVERROR(EINVAL);
2000 av_bprint_init(&bprint, 64, AV_BPRINT_SIZE_UNLIMITED);
2002 while (o = av_opt_next(obj, o)) {
2003 if (o->type == AV_OPT_TYPE_CONST)
2005 if ((flags & AV_OPT_SERIALIZE_OPT_FLAGS_EXACT) && o->flags != opt_flags)
2007 else if (((o->flags & opt_flags) != opt_flags))
2009 if (flags & AV_OPT_SERIALIZE_SKIP_DEFAULTS && av_opt_is_set_to_default(obj, o) > 0)
2011 if ((ret = av_opt_get(obj, o->name, 0, &buf)) < 0) {
2012 av_bprint_finalize(&bprint, NULL);
2017 av_bprint_append_data(&bprint, &pairs_sep, 1);
2018 av_bprint_escape(&bprint, o->name, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
2019 av_bprint_append_data(&bprint, &key_val_sep, 1);
2020 av_bprint_escape(&bprint, buf, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
2024 av_bprint_finalize(&bprint, buffer);