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)
318 static int set_string_image_size(void *obj, const AVOption *o, const char *val, int *dst)
322 if (!val || !strcmp(val, "none")) {
327 ret = av_parse_video_size(dst, dst + 1, val);
329 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as image size\n", val);
333 static int set_string_video_rate(void *obj, const AVOption *o, const char *val, AVRational *dst)
337 ret = AVERROR(EINVAL);
339 ret = av_parse_video_rate(dst, val);
342 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as video rate\n", val);
346 static int set_string_color(void *obj, const AVOption *o, const char *val, uint8_t *dst)
353 ret = av_parse_color(dst, val, -1, obj);
355 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as color\n", val);
361 static const char *get_bool_name(int val)
365 return val ? "true" : "false";
368 static int set_string_bool(void *obj, const AVOption *o, const char *val, int *dst)
375 if (!strcmp(val, "auto")) {
377 } else if (av_match_name(val, "true,y,yes,enable,enabled,on")) {
379 } else if (av_match_name(val, "false,n,no,disable,disabled,off")) {
383 n = strtol(val, &end, 10);
384 if (val + strlen(val) != end)
388 if (n < o->min || n > o->max)
395 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as boolean\n", val);
396 return AVERROR(EINVAL);
399 static int set_string_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst,
400 int fmt_nb, int ((*get_fmt)(const char *)), const char *desc)
404 if (!val || !strcmp(val, "none")) {
410 fmt = strtol(val, &tail, 0);
411 if (*tail || (unsigned)fmt >= fmt_nb) {
412 av_log(obj, AV_LOG_ERROR,
413 "Unable to parse option value \"%s\" as %s\n", val, desc);
414 return AVERROR(EINVAL);
419 min = FFMAX(o->min, -1);
420 max = FFMIN(o->max, fmt_nb-1);
422 // hack for compatibility with old ffmpeg
423 if(min == 0 && max == 0) {
428 if (fmt < min || fmt > max) {
429 av_log(obj, AV_LOG_ERROR,
430 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
431 fmt, o->name, desc, min, max);
432 return AVERROR(ERANGE);
439 static int set_string_pixel_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
441 return set_string_fmt(obj, o, val, dst,
442 AV_PIX_FMT_NB, av_get_pix_fmt, "pixel format");
445 static int set_string_sample_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
447 return set_string_fmt(obj, o, val, dst,
448 AV_SAMPLE_FMT_NB, av_get_sample_fmt, "sample format");
451 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
454 void *dst, *target_obj;
455 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
456 if (!o || !target_obj)
457 return AVERROR_OPTION_NOT_FOUND;
458 if (!val && (o->type != AV_OPT_TYPE_STRING &&
459 o->type != AV_OPT_TYPE_PIXEL_FMT && o->type != AV_OPT_TYPE_SAMPLE_FMT &&
460 o->type != AV_OPT_TYPE_IMAGE_SIZE && o->type != AV_OPT_TYPE_VIDEO_RATE &&
461 o->type != AV_OPT_TYPE_DURATION && o->type != AV_OPT_TYPE_COLOR &&
462 o->type != AV_OPT_TYPE_CHANNEL_LAYOUT && o->type != AV_OPT_TYPE_BOOL))
463 return AVERROR(EINVAL);
465 if (o->flags & AV_OPT_FLAG_READONLY)
466 return AVERROR(EINVAL);
468 dst = ((uint8_t *)target_obj) + o->offset;
470 case AV_OPT_TYPE_BOOL:
471 return set_string_bool(obj, o, val, dst);
472 case AV_OPT_TYPE_STRING:
473 return set_string(obj, o, val, dst);
474 case AV_OPT_TYPE_BINARY:
475 return set_string_binary(obj, o, val, dst);
476 case AV_OPT_TYPE_FLAGS:
477 case AV_OPT_TYPE_INT:
478 case AV_OPT_TYPE_INT64:
479 case AV_OPT_TYPE_UINT64:
480 case AV_OPT_TYPE_FLOAT:
481 case AV_OPT_TYPE_DOUBLE:
482 case AV_OPT_TYPE_RATIONAL:
483 return set_string_number(obj, target_obj, o, val, dst);
484 case AV_OPT_TYPE_IMAGE_SIZE:
485 return set_string_image_size(obj, o, val, dst);
486 case AV_OPT_TYPE_VIDEO_RATE: {
488 ret = set_string_video_rate(obj, o, val, &tmp);
491 return write_number(obj, o, dst, 1, tmp.den, tmp.num);
493 case AV_OPT_TYPE_PIXEL_FMT:
494 return set_string_pixel_fmt(obj, o, val, dst);
495 case AV_OPT_TYPE_SAMPLE_FMT:
496 return set_string_sample_fmt(obj, o, val, dst);
497 case AV_OPT_TYPE_DURATION:
502 if ((ret = av_parse_time(dst, val, 1)) < 0)
503 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as duration\n", val);
507 case AV_OPT_TYPE_COLOR:
508 return set_string_color(obj, o, val, dst);
509 case AV_OPT_TYPE_CHANNEL_LAYOUT:
510 if (!val || !strcmp(val, "none")) {
513 int64_t cl = av_get_channel_layout(val);
515 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as channel layout\n", val);
516 ret = AVERROR(EINVAL);
518 *(int64_t *)dst = cl;
524 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
525 return AVERROR(EINVAL);
528 #define OPT_EVAL_NUMBER(name, opttype, vartype) \
529 int av_opt_eval_ ## name(void *obj, const AVOption *o, \
530 const char *val, vartype *name ## _out) \
532 if (!o || o->type != opttype || o->flags & AV_OPT_FLAG_READONLY) \
533 return AVERROR(EINVAL); \
534 return set_string_number(obj, obj, o, val, name ## _out); \
537 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
538 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
539 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
540 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
541 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
542 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
544 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
547 void *dst, *target_obj;
548 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
550 if (!o || !target_obj)
551 return AVERROR_OPTION_NOT_FOUND;
553 if (o->flags & AV_OPT_FLAG_READONLY)
554 return AVERROR(EINVAL);
556 dst = ((uint8_t *)target_obj) + o->offset;
557 return write_number(obj, o, dst, num, den, intnum);
560 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
562 return set_number(obj, name, 1, 1, val, search_flags);
565 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
567 return set_number(obj, name, val, 1, 1, search_flags);
570 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
572 return set_number(obj, name, val.num, val.den, 1, search_flags);
575 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
578 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
583 if (!o || !target_obj)
584 return AVERROR_OPTION_NOT_FOUND;
586 if (o->type != AV_OPT_TYPE_BINARY || o->flags & AV_OPT_FLAG_READONLY)
587 return AVERROR(EINVAL);
589 ptr = len ? av_malloc(len) : NULL;
591 return AVERROR(ENOMEM);
593 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
594 lendst = (int *)(dst + 1);
600 memcpy(ptr, val, len);
605 int av_opt_set_image_size(void *obj, const char *name, int w, int h, int search_flags)
608 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
610 if (!o || !target_obj)
611 return AVERROR_OPTION_NOT_FOUND;
612 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
613 av_log(obj, AV_LOG_ERROR,
614 "The value set by option '%s' is not an image size.\n", o->name);
615 return AVERROR(EINVAL);
618 av_log(obj, AV_LOG_ERROR,
619 "Invalid negative size value %dx%d for size '%s'\n", w, h, o->name);
620 return AVERROR(EINVAL);
622 *(int *)(((uint8_t *)target_obj) + o->offset) = w;
623 *(int *)(((uint8_t *)target_obj+sizeof(int)) + o->offset) = h;
627 int av_opt_set_video_rate(void *obj, const char *name, AVRational val, int search_flags)
630 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
632 if (!o || !target_obj)
633 return AVERROR_OPTION_NOT_FOUND;
634 if (o->type != AV_OPT_TYPE_VIDEO_RATE) {
635 av_log(obj, AV_LOG_ERROR,
636 "The value set by option '%s' is not a video rate.\n", o->name);
637 return AVERROR(EINVAL);
639 if (val.num <= 0 || val.den <= 0)
640 return AVERROR(EINVAL);
641 return set_number(obj, name, val.num, val.den, 1, search_flags);
644 static int set_format(void *obj, const char *name, int fmt, int search_flags,
645 enum AVOptionType type, const char *desc, int nb_fmts)
648 const AVOption *o = av_opt_find2(obj, name, NULL, 0,
649 search_flags, &target_obj);
652 if (!o || !target_obj)
653 return AVERROR_OPTION_NOT_FOUND;
654 if (o->type != type) {
655 av_log(obj, AV_LOG_ERROR,
656 "The value set by option '%s' is not a %s format", name, desc);
657 return AVERROR(EINVAL);
660 min = FFMAX(o->min, -1);
661 max = FFMIN(o->max, nb_fmts-1);
663 if (fmt < min || fmt > max) {
664 av_log(obj, AV_LOG_ERROR,
665 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
666 fmt, name, desc, min, max);
667 return AVERROR(ERANGE);
669 *(int *)(((uint8_t *)target_obj) + o->offset) = fmt;
673 int av_opt_set_pixel_fmt(void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
675 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_PIXEL_FMT, "pixel", AV_PIX_FMT_NB);
678 int av_opt_set_sample_fmt(void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
680 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_SAMPLE_FMT, "sample", AV_SAMPLE_FMT_NB);
683 int av_opt_set_channel_layout(void *obj, const char *name, int64_t cl, int search_flags)
686 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
688 if (!o || !target_obj)
689 return AVERROR_OPTION_NOT_FOUND;
690 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
691 av_log(obj, AV_LOG_ERROR,
692 "The value set by option '%s' is not a channel layout.\n", o->name);
693 return AVERROR(EINVAL);
695 *(int64_t *)(((uint8_t *)target_obj) + o->offset) = cl;
699 int av_opt_set_dict_val(void *obj, const char *name, const AVDictionary *val,
704 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
706 if (!o || !target_obj)
707 return AVERROR_OPTION_NOT_FOUND;
708 if (o->flags & AV_OPT_FLAG_READONLY)
709 return AVERROR(EINVAL);
711 dst = (AVDictionary **)(((uint8_t *)target_obj) + o->offset);
713 av_dict_copy(dst, val, 0);
718 static void format_duration(char *buf, size_t size, int64_t d)
722 av_assert0(size >= 25);
723 if (d < 0 && d != INT64_MIN) {
729 snprintf(buf, size, "INT64_MAX");
730 else if (d == INT64_MIN)
731 snprintf(buf, size, "INT64_MIN");
732 else if (d > (int64_t)3600*1000000)
733 snprintf(buf, size, "%"PRId64":%02d:%02d.%06d", d / 3600000000,
734 (int)((d / 60000000) % 60),
735 (int)((d / 1000000) % 60),
737 else if (d > 60*1000000)
738 snprintf(buf, size, "%d:%02d.%06d",
740 (int)((d / 1000000) % 60),
743 snprintf(buf, size, "%d.%06d",
746 e = buf + strlen(buf);
747 while (e > buf && e[-1] == '0')
749 if (e > buf && e[-1] == '.')
753 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
755 void *dst, *target_obj;
756 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
757 uint8_t *bin, buf[128];
761 if (!o || !target_obj || (o->offset<=0 && o->type != AV_OPT_TYPE_CONST))
762 return AVERROR_OPTION_NOT_FOUND;
764 dst = (uint8_t *)target_obj + o->offset;
768 case AV_OPT_TYPE_BOOL:
769 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(get_bool_name(*(int *)dst), "invalid"));
771 case AV_OPT_TYPE_FLAGS:
772 ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);
774 case AV_OPT_TYPE_INT:
775 ret = snprintf(buf, sizeof(buf), "%d", *(int *)dst);
777 case AV_OPT_TYPE_INT64:
778 ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t *)dst);
780 case AV_OPT_TYPE_UINT64:
781 ret = snprintf(buf, sizeof(buf), "%"PRIu64, *(uint64_t *)dst);
783 case AV_OPT_TYPE_FLOAT:
784 ret = snprintf(buf, sizeof(buf), "%f", *(float *)dst);
786 case AV_OPT_TYPE_DOUBLE:
787 ret = snprintf(buf, sizeof(buf), "%f", *(double *)dst);
789 case AV_OPT_TYPE_VIDEO_RATE:
790 case AV_OPT_TYPE_RATIONAL:
791 ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational *)dst)->num, ((AVRational *)dst)->den);
793 case AV_OPT_TYPE_CONST:
794 ret = snprintf(buf, sizeof(buf), "%f", o->default_val.dbl);
796 case AV_OPT_TYPE_STRING:
797 if (*(uint8_t **)dst) {
798 *out_val = av_strdup(*(uint8_t **)dst);
799 } else if (search_flags & AV_OPT_ALLOW_NULL) {
803 *out_val = av_strdup("");
805 return *out_val ? 0 : AVERROR(ENOMEM);
806 case AV_OPT_TYPE_BINARY:
807 if (!*(uint8_t **)dst && (search_flags & AV_OPT_ALLOW_NULL)) {
811 len = *(int *)(((uint8_t *)dst) + sizeof(uint8_t *));
812 if ((uint64_t)len * 2 + 1 > INT_MAX)
813 return AVERROR(EINVAL);
814 if (!(*out_val = av_malloc(len * 2 + 1)))
815 return AVERROR(ENOMEM);
820 bin = *(uint8_t **)dst;
821 for (i = 0; i < len; i++)
822 snprintf(*out_val + i * 2, 3, "%02X", bin[i]);
824 case AV_OPT_TYPE_IMAGE_SIZE:
825 ret = snprintf(buf, sizeof(buf), "%dx%d", ((int *)dst)[0], ((int *)dst)[1]);
827 case AV_OPT_TYPE_PIXEL_FMT:
828 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_pix_fmt_name(*(enum AVPixelFormat *)dst), "none"));
830 case AV_OPT_TYPE_SAMPLE_FMT:
831 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_sample_fmt_name(*(enum AVSampleFormat *)dst), "none"));
833 case AV_OPT_TYPE_DURATION:
834 i64 = *(int64_t *)dst;
835 format_duration(buf, sizeof(buf), i64);
836 ret = strlen(buf); // no overflow possible, checked by an assert
838 case AV_OPT_TYPE_COLOR:
839 ret = snprintf(buf, sizeof(buf), "0x%02x%02x%02x%02x",
840 (int)((uint8_t *)dst)[0], (int)((uint8_t *)dst)[1],
841 (int)((uint8_t *)dst)[2], (int)((uint8_t *)dst)[3]);
843 case AV_OPT_TYPE_CHANNEL_LAYOUT:
844 i64 = *(int64_t *)dst;
845 ret = snprintf(buf, sizeof(buf), "0x%"PRIx64, i64);
848 return AVERROR(EINVAL);
851 if (ret >= sizeof(buf))
852 return AVERROR(EINVAL);
853 *out_val = av_strdup(buf);
854 return *out_val ? 0 : AVERROR(ENOMEM);
857 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum,
860 void *dst, *target_obj;
861 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
862 if (!o || !target_obj)
865 dst = ((uint8_t *)target_obj) + o->offset;
867 if (o_out) *o_out= o;
869 return read_number(o, dst, num, den, intnum);
877 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
883 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
885 *out_val = num * intnum / den;
889 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
895 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
897 *out_val = num * intnum / den;
901 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
907 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
910 if (num == 1.0 && (int)intnum == intnum)
911 *out_val = (AVRational){intnum, den};
913 *out_val = av_d2q(num*intnum/den, 1<<24);
917 int av_opt_get_image_size(void *obj, const char *name, int search_flags, int *w_out, int *h_out)
919 void *dst, *target_obj;
920 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
921 if (!o || !target_obj)
922 return AVERROR_OPTION_NOT_FOUND;
923 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
924 av_log(obj, AV_LOG_ERROR,
925 "The value for option '%s' is not an image size.\n", name);
926 return AVERROR(EINVAL);
929 dst = ((uint8_t*)target_obj) + o->offset;
930 if (w_out) *w_out = *(int *)dst;
931 if (h_out) *h_out = *((int *)dst+1);
935 int av_opt_get_video_rate(void *obj, const char *name, int search_flags, AVRational *out_val)
941 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
944 if (num == 1.0 && (int)intnum == intnum)
945 *out_val = (AVRational) { intnum, den };
947 *out_val = av_d2q(num * intnum / den, 1 << 24);
951 static int get_format(void *obj, const char *name, int search_flags, int *out_fmt,
952 enum AVOptionType type, const char *desc)
954 void *dst, *target_obj;
955 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
956 if (!o || !target_obj)
957 return AVERROR_OPTION_NOT_FOUND;
958 if (o->type != type) {
959 av_log(obj, AV_LOG_ERROR,
960 "The value for option '%s' is not a %s format.\n", desc, name);
961 return AVERROR(EINVAL);
964 dst = ((uint8_t*)target_obj) + o->offset;
965 *out_fmt = *(int *)dst;
969 int av_opt_get_pixel_fmt(void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
971 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_PIXEL_FMT, "pixel");
974 int av_opt_get_sample_fmt(void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
976 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_SAMPLE_FMT, "sample");
979 int av_opt_get_channel_layout(void *obj, const char *name, int search_flags, int64_t *cl)
981 void *dst, *target_obj;
982 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
983 if (!o || !target_obj)
984 return AVERROR_OPTION_NOT_FOUND;
985 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
986 av_log(obj, AV_LOG_ERROR,
987 "The value for option '%s' is not a channel layout.\n", name);
988 return AVERROR(EINVAL);
991 dst = ((uint8_t*)target_obj) + o->offset;
992 *cl = *(int64_t *)dst;
996 int av_opt_get_dict_val(void *obj, const char *name, int search_flags, AVDictionary **out_val)
1000 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
1002 if (!o || !target_obj)
1003 return AVERROR_OPTION_NOT_FOUND;
1004 if (o->type != AV_OPT_TYPE_DICT)
1005 return AVERROR(EINVAL);
1007 src = *(AVDictionary **)(((uint8_t *)target_obj) + o->offset);
1008 av_dict_copy(out_val, src, 0);
1013 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
1015 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
1016 const AVOption *flag = av_opt_find(obj, flag_name,
1017 field ? field->unit : NULL, 0, 0);
1020 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
1021 av_opt_get_int(obj, field_name, 0, &res) < 0)
1023 return res & flag->default_val.i64;
1026 static void log_value(void *av_log_obj, int level, double d)
1029 av_log(av_log_obj, level, "INT_MAX");
1030 } else if (d == INT_MIN) {
1031 av_log(av_log_obj, level, "INT_MIN");
1032 } else if (d == UINT32_MAX) {
1033 av_log(av_log_obj, level, "UINT32_MAX");
1034 } else if (d == (double)INT64_MAX) {
1035 av_log(av_log_obj, level, "I64_MAX");
1036 } else if (d == INT64_MIN) {
1037 av_log(av_log_obj, level, "I64_MIN");
1038 } else if (d == FLT_MAX) {
1039 av_log(av_log_obj, level, "FLT_MAX");
1040 } else if (d == FLT_MIN) {
1041 av_log(av_log_obj, level, "FLT_MIN");
1042 } else if (d == -FLT_MAX) {
1043 av_log(av_log_obj, level, "-FLT_MAX");
1044 } else if (d == -FLT_MIN) {
1045 av_log(av_log_obj, level, "-FLT_MIN");
1046 } else if (d == DBL_MAX) {
1047 av_log(av_log_obj, level, "DBL_MAX");
1048 } else if (d == DBL_MIN) {
1049 av_log(av_log_obj, level, "DBL_MIN");
1050 } else if (d == -DBL_MAX) {
1051 av_log(av_log_obj, level, "-DBL_MAX");
1052 } else if (d == -DBL_MIN) {
1053 av_log(av_log_obj, level, "-DBL_MIN");
1055 av_log(av_log_obj, level, "%g", d);
1059 static const char *get_opt_const_name(void *obj, const char *unit, int64_t value)
1061 const AVOption *opt = NULL;
1065 while ((opt = av_opt_next(obj, opt)))
1066 if (opt->type == AV_OPT_TYPE_CONST && !strcmp(opt->unit, unit) &&
1067 opt->default_val.i64 == value)
1072 static char *get_opt_flags_string(void *obj, const char *unit, int64_t value)
1074 const AVOption *opt = NULL;
1080 while ((opt = av_opt_next(obj, opt))) {
1081 if (opt->type == AV_OPT_TYPE_CONST && !strcmp(opt->unit, unit) &&
1082 opt->default_val.i64 & value) {
1084 av_strlcatf(flags, sizeof(flags), "+");
1085 av_strlcatf(flags, sizeof(flags), "%s", opt->name);
1089 return av_strdup(flags);
1093 static void opt_list(void *obj, void *av_log_obj, const char *unit,
1094 int req_flags, int rej_flags)
1096 const AVOption *opt = NULL;
1100 while ((opt = av_opt_next(obj, opt))) {
1101 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
1104 /* Don't print CONST's on level one.
1105 * Don't print anything but CONST's on level two.
1106 * Only print items from the requested unit.
1108 if (!unit && opt->type == AV_OPT_TYPE_CONST)
1110 else if (unit && opt->type != AV_OPT_TYPE_CONST)
1112 else if (unit && opt->type == AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
1114 else if (unit && opt->type == AV_OPT_TYPE_CONST)
1115 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
1117 av_log(av_log_obj, AV_LOG_INFO, " %s%-17s ",
1118 (opt->flags & AV_OPT_FLAG_FILTERING_PARAM) ? "" : "-",
1121 switch (opt->type) {
1122 case AV_OPT_TYPE_FLAGS:
1123 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<flags>");
1125 case AV_OPT_TYPE_INT:
1126 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int>");
1128 case AV_OPT_TYPE_INT64:
1129 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int64>");
1131 case AV_OPT_TYPE_UINT64:
1132 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<uint64>");
1134 case AV_OPT_TYPE_DOUBLE:
1135 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<double>");
1137 case AV_OPT_TYPE_FLOAT:
1138 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<float>");
1140 case AV_OPT_TYPE_STRING:
1141 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<string>");
1143 case AV_OPT_TYPE_RATIONAL:
1144 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<rational>");
1146 case AV_OPT_TYPE_BINARY:
1147 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<binary>");
1149 case AV_OPT_TYPE_IMAGE_SIZE:
1150 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<image_size>");
1152 case AV_OPT_TYPE_VIDEO_RATE:
1153 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<video_rate>");
1155 case AV_OPT_TYPE_PIXEL_FMT:
1156 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<pix_fmt>");
1158 case AV_OPT_TYPE_SAMPLE_FMT:
1159 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<sample_fmt>");
1161 case AV_OPT_TYPE_DURATION:
1162 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<duration>");
1164 case AV_OPT_TYPE_COLOR:
1165 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<color>");
1167 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1168 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<channel_layout>");
1170 case AV_OPT_TYPE_BOOL:
1171 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<boolean>");
1173 case AV_OPT_TYPE_CONST:
1175 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "");
1178 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
1179 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
1180 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_FILTERING_PARAM)? 'F' : '.');
1181 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
1182 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
1183 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
1184 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_EXPORT) ? 'X' : '.');
1185 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_READONLY) ? 'R' : '.');
1188 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
1190 if (av_opt_query_ranges(&r, obj, opt->name, AV_OPT_SEARCH_FAKE_OBJ) >= 0) {
1191 switch (opt->type) {
1192 case AV_OPT_TYPE_INT:
1193 case AV_OPT_TYPE_INT64:
1194 case AV_OPT_TYPE_UINT64:
1195 case AV_OPT_TYPE_DOUBLE:
1196 case AV_OPT_TYPE_FLOAT:
1197 case AV_OPT_TYPE_RATIONAL:
1198 for (i = 0; i < r->nb_ranges; i++) {
1199 av_log(av_log_obj, AV_LOG_INFO, " (from ");
1200 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_min);
1201 av_log(av_log_obj, AV_LOG_INFO, " to ");
1202 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_max);
1203 av_log(av_log_obj, AV_LOG_INFO, ")");
1207 av_opt_freep_ranges(&r);
1210 if (opt->type != AV_OPT_TYPE_CONST &&
1211 opt->type != AV_OPT_TYPE_BINARY &&
1212 !((opt->type == AV_OPT_TYPE_COLOR ||
1213 opt->type == AV_OPT_TYPE_IMAGE_SIZE ||
1214 opt->type == AV_OPT_TYPE_STRING ||
1215 opt->type == AV_OPT_TYPE_VIDEO_RATE) &&
1216 !opt->default_val.str)) {
1217 av_log(av_log_obj, AV_LOG_INFO, " (default ");
1218 switch (opt->type) {
1219 case AV_OPT_TYPE_BOOL:
1220 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(get_bool_name(opt->default_val.i64), "invalid"));
1222 case AV_OPT_TYPE_FLAGS: {
1223 char *def_flags = get_opt_flags_string(obj, opt->unit, opt->default_val.i64);
1225 av_log(av_log_obj, AV_LOG_INFO, "%s", def_flags);
1226 av_freep(&def_flags);
1228 av_log(av_log_obj, AV_LOG_INFO, "%"PRIX64, opt->default_val.i64);
1232 case AV_OPT_TYPE_DURATION: {
1234 format_duration(buf, sizeof(buf), opt->default_val.i64);
1235 av_log(av_log_obj, AV_LOG_INFO, "%s", buf);
1238 case AV_OPT_TYPE_INT:
1239 case AV_OPT_TYPE_UINT64:
1240 case AV_OPT_TYPE_INT64: {
1241 const char *def_const = get_opt_const_name(obj, opt->unit, opt->default_val.i64);
1243 av_log(av_log_obj, AV_LOG_INFO, "%s", def_const);
1245 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.i64);
1248 case AV_OPT_TYPE_DOUBLE:
1249 case AV_OPT_TYPE_FLOAT:
1250 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.dbl);
1252 case AV_OPT_TYPE_RATIONAL: {
1253 AVRational q = av_d2q(opt->default_val.dbl, INT_MAX);
1254 av_log(av_log_obj, AV_LOG_INFO, "%d/%d", q.num, q.den); }
1256 case AV_OPT_TYPE_PIXEL_FMT:
1257 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_pix_fmt_name(opt->default_val.i64), "none"));
1259 case AV_OPT_TYPE_SAMPLE_FMT:
1260 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_sample_fmt_name(opt->default_val.i64), "none"));
1262 case AV_OPT_TYPE_COLOR:
1263 case AV_OPT_TYPE_IMAGE_SIZE:
1264 case AV_OPT_TYPE_STRING:
1265 case AV_OPT_TYPE_VIDEO_RATE:
1266 av_log(av_log_obj, AV_LOG_INFO, "\"%s\"", opt->default_val.str);
1268 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1269 av_log(av_log_obj, AV_LOG_INFO, "0x%"PRIx64, opt->default_val.i64);
1272 av_log(av_log_obj, AV_LOG_INFO, ")");
1275 av_log(av_log_obj, AV_LOG_INFO, "\n");
1276 if (opt->unit && opt->type != AV_OPT_TYPE_CONST)
1277 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
1281 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
1286 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass **)obj)->class_name);
1288 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
1293 void av_opt_set_defaults(void *s)
1295 av_opt_set_defaults2(s, 0, 0);
1298 void av_opt_set_defaults2(void *s, int mask, int flags)
1300 const AVOption *opt = NULL;
1301 while ((opt = av_opt_next(s, opt))) {
1302 void *dst = ((uint8_t*)s) + opt->offset;
1304 if ((opt->flags & mask) != flags)
1307 if (opt->flags & AV_OPT_FLAG_READONLY)
1310 switch (opt->type) {
1311 case AV_OPT_TYPE_CONST:
1312 /* Nothing to be done here */
1314 case AV_OPT_TYPE_BOOL:
1315 case AV_OPT_TYPE_FLAGS:
1316 case AV_OPT_TYPE_INT:
1317 case AV_OPT_TYPE_INT64:
1318 case AV_OPT_TYPE_UINT64:
1319 case AV_OPT_TYPE_DURATION:
1320 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1321 case AV_OPT_TYPE_PIXEL_FMT:
1322 case AV_OPT_TYPE_SAMPLE_FMT:
1323 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1325 case AV_OPT_TYPE_DOUBLE:
1326 case AV_OPT_TYPE_FLOAT: {
1328 val = opt->default_val.dbl;
1329 write_number(s, opt, dst, val, 1, 1);
1332 case AV_OPT_TYPE_RATIONAL: {
1334 val = av_d2q(opt->default_val.dbl, INT_MAX);
1335 write_number(s, opt, dst, 1, val.den, val.num);
1338 case AV_OPT_TYPE_COLOR:
1339 set_string_color(s, opt, opt->default_val.str, dst);
1341 case AV_OPT_TYPE_STRING:
1342 set_string(s, opt, opt->default_val.str, dst);
1344 case AV_OPT_TYPE_IMAGE_SIZE:
1345 set_string_image_size(s, opt, opt->default_val.str, dst);
1347 case AV_OPT_TYPE_VIDEO_RATE:
1348 set_string_video_rate(s, opt, opt->default_val.str, dst);
1350 case AV_OPT_TYPE_BINARY:
1351 set_string_binary(s, opt, opt->default_val.str, dst);
1353 case AV_OPT_TYPE_DICT:
1354 /* Cannot set defaults for these types */
1357 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n",
1358 opt->type, opt->name);
1364 * Store the value in the field in ctx that is named like key.
1365 * ctx must be an AVClass context, storing is done using AVOptions.
1367 * @param buf the string to parse, buf will be updated to point at the
1368 * separator just after the parsed key/value pair
1369 * @param key_val_sep a 0-terminated list of characters used to
1370 * separate key from value
1371 * @param pairs_sep a 0-terminated list of characters used to separate
1372 * two pairs from each other
1373 * @return 0 if the key/value pair has been successfully parsed and
1374 * set, or a negative value corresponding to an AVERROR code in case
1376 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
1377 * the error code issued by av_opt_set() if the key/value pair
1380 static int parse_key_value_pair(void *ctx, const char **buf,
1381 const char *key_val_sep, const char *pairs_sep)
1383 char *key = av_get_token(buf, key_val_sep);
1388 return AVERROR(ENOMEM);
1390 if (*key && strspn(*buf, key_val_sep)) {
1392 val = av_get_token(buf, pairs_sep);
1395 return AVERROR(ENOMEM);
1398 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
1400 return AVERROR(EINVAL);
1403 av_log(ctx, AV_LOG_DEBUG, "Setting entry with key '%s' to value '%s'\n", key, val);
1405 ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
1406 if (ret == AVERROR_OPTION_NOT_FOUND)
1407 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
1414 int av_set_options_string(void *ctx, const char *opts,
1415 const char *key_val_sep, const char *pairs_sep)
1423 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
1434 #define WHITESPACES " \n\t\r"
1436 static int is_key_char(char c)
1438 return (unsigned)((c | 32) - 'a') < 26 ||
1439 (unsigned)(c - '0') < 10 ||
1440 c == '-' || c == '_' || c == '/' || c == '.';
1444 * Read a key from a string.
1446 * The key consists of is_key_char characters and must be terminated by a
1447 * character from the delim string; spaces are ignored.
1449 * @return 0 for success (even with ellipsis), <0 for failure
1451 static int get_key(const char **ropts, const char *delim, char **rkey)
1453 const char *opts = *ropts;
1454 const char *key_start, *key_end;
1456 key_start = opts += strspn(opts, WHITESPACES);
1457 while (is_key_char(*opts))
1460 opts += strspn(opts, WHITESPACES);
1461 if (!*opts || !strchr(delim, *opts))
1462 return AVERROR(EINVAL);
1464 if (!(*rkey = av_malloc(key_end - key_start + 1)))
1465 return AVERROR(ENOMEM);
1466 memcpy(*rkey, key_start, key_end - key_start);
1467 (*rkey)[key_end - key_start] = 0;
1472 int av_opt_get_key_value(const char **ropts,
1473 const char *key_val_sep, const char *pairs_sep,
1475 char **rkey, char **rval)
1478 char *key = NULL, *val;
1479 const char *opts = *ropts;
1481 if ((ret = get_key(&opts, key_val_sep, &key)) < 0 &&
1482 !(flags & AV_OPT_FLAG_IMPLICIT_KEY))
1483 return AVERROR(EINVAL);
1484 if (!(val = av_get_token(&opts, pairs_sep))) {
1486 return AVERROR(ENOMEM);
1494 int av_opt_set_from_string(void *ctx, const char *opts,
1495 const char *const *shorthand,
1496 const char *key_val_sep, const char *pairs_sep)
1499 const char *dummy_shorthand = NULL;
1500 char *av_uninit(parsed_key), *av_uninit(value);
1506 shorthand = &dummy_shorthand;
1509 ret = av_opt_get_key_value(&opts, key_val_sep, pairs_sep,
1510 *shorthand ? AV_OPT_FLAG_IMPLICIT_KEY : 0,
1511 &parsed_key, &value);
1513 if (ret == AVERROR(EINVAL))
1514 av_log(ctx, AV_LOG_ERROR, "No option name near '%s'\n", opts);
1516 av_log(ctx, AV_LOG_ERROR, "Unable to parse '%s': %s\n", opts,
1524 while (*shorthand) /* discard all remaining shorthand */
1527 key = *(shorthand++);
1530 av_log(ctx, AV_LOG_DEBUG, "Setting '%s' to value '%s'\n", key, value);
1531 if ((ret = av_opt_set(ctx, key, value, 0)) < 0) {
1532 if (ret == AVERROR_OPTION_NOT_FOUND)
1533 av_log(ctx, AV_LOG_ERROR, "Option '%s' not found\n", key);
1535 av_free(parsed_key);
1540 av_free(parsed_key);
1546 void av_opt_free(void *obj)
1548 const AVOption *o = NULL;
1549 while ((o = av_opt_next(obj, o))) {
1551 case AV_OPT_TYPE_STRING:
1552 case AV_OPT_TYPE_BINARY:
1553 av_freep((uint8_t *)obj + o->offset);
1556 case AV_OPT_TYPE_DICT:
1557 av_dict_free((AVDictionary **)(((uint8_t *)obj) + o->offset));
1566 int av_opt_set_dict2(void *obj, AVDictionary **options, int search_flags)
1568 AVDictionaryEntry *t = NULL;
1569 AVDictionary *tmp = NULL;
1575 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
1576 ret = av_opt_set(obj, t->key, t->value, search_flags);
1577 if (ret == AVERROR_OPTION_NOT_FOUND)
1578 ret = av_dict_set(&tmp, t->key, t->value, 0);
1580 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
1586 av_dict_free(options);
1591 int av_opt_set_dict(void *obj, AVDictionary **options)
1593 return av_opt_set_dict2(obj, options, 0);
1596 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
1597 int opt_flags, int search_flags)
1599 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
1602 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
1603 int opt_flags, int search_flags, void **target_obj)
1606 const AVOption *o = NULL;
1616 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
1617 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
1618 const AVClass *child = NULL;
1619 while (child = av_opt_child_class_next(c, child))
1620 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
1624 while (child = av_opt_child_next(obj, child))
1625 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
1630 while (o = av_opt_next(obj, o)) {
1631 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
1632 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
1633 (unit && o->type == AV_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)))) {
1635 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
1646 void *av_opt_child_next(void *obj, void *prev)
1648 const AVClass *c = *(AVClass **)obj;
1650 return c->child_next(obj, prev);
1654 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
1656 if (parent->child_class_next)
1657 return parent->child_class_next(prev);
1661 void *av_opt_ptr(const AVClass *class, void *obj, const char *name)
1663 const AVOption *opt= av_opt_find2(&class, name, NULL, 0, AV_OPT_SEARCH_FAKE_OBJ, NULL);
1666 return (uint8_t*)obj + opt->offset;
1669 static int opt_size(enum AVOptionType type)
1672 case AV_OPT_TYPE_BOOL:
1673 case AV_OPT_TYPE_INT:
1674 case AV_OPT_TYPE_FLAGS:
1676 case AV_OPT_TYPE_DURATION:
1677 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1678 case AV_OPT_TYPE_INT64:
1679 case AV_OPT_TYPE_UINT64:
1680 return sizeof(int64_t);
1681 case AV_OPT_TYPE_DOUBLE:
1682 return sizeof(double);
1683 case AV_OPT_TYPE_FLOAT:
1684 return sizeof(float);
1685 case AV_OPT_TYPE_STRING:
1686 return sizeof(uint8_t*);
1687 case AV_OPT_TYPE_VIDEO_RATE:
1688 case AV_OPT_TYPE_RATIONAL:
1689 return sizeof(AVRational);
1690 case AV_OPT_TYPE_BINARY:
1691 return sizeof(uint8_t*) + sizeof(int);
1692 case AV_OPT_TYPE_IMAGE_SIZE:
1693 return sizeof(int[2]);
1694 case AV_OPT_TYPE_PIXEL_FMT:
1695 return sizeof(enum AVPixelFormat);
1696 case AV_OPT_TYPE_SAMPLE_FMT:
1697 return sizeof(enum AVSampleFormat);
1698 case AV_OPT_TYPE_COLOR:
1701 return AVERROR(EINVAL);
1704 int av_opt_copy(void *dst, const void *src)
1706 const AVOption *o = NULL;
1711 return AVERROR(EINVAL);
1713 c = *(AVClass **)src;
1714 if (!c || c != *(AVClass **)dst)
1715 return AVERROR(EINVAL);
1717 while ((o = av_opt_next(src, o))) {
1718 void *field_dst = (uint8_t *)dst + o->offset;
1719 void *field_src = (uint8_t *)src + o->offset;
1720 uint8_t **field_dst8 = (uint8_t **)field_dst;
1721 uint8_t **field_src8 = (uint8_t **)field_src;
1723 if (o->type == AV_OPT_TYPE_STRING) {
1724 if (*field_dst8 != *field_src8)
1725 av_freep(field_dst8);
1726 *field_dst8 = av_strdup(*field_src8);
1727 if (*field_src8 && !*field_dst8)
1728 ret = AVERROR(ENOMEM);
1729 } else if (o->type == AV_OPT_TYPE_BINARY) {
1730 int len = *(int *)(field_src8 + 1);
1731 if (*field_dst8 != *field_src8)
1732 av_freep(field_dst8);
1733 *field_dst8 = av_memdup(*field_src8, len);
1734 if (len && !*field_dst8) {
1735 ret = AVERROR(ENOMEM);
1738 *(int *)(field_dst8 + 1) = len;
1739 } else if (o->type == AV_OPT_TYPE_CONST) {
1741 } else if (o->type == AV_OPT_TYPE_DICT) {
1742 AVDictionary **sdict = (AVDictionary **) field_src;
1743 AVDictionary **ddict = (AVDictionary **) field_dst;
1744 if (*sdict != *ddict)
1745 av_dict_free(ddict);
1747 av_dict_copy(ddict, *sdict, 0);
1748 if (av_dict_count(*sdict) != av_dict_count(*ddict))
1749 ret = AVERROR(ENOMEM);
1751 int size = opt_size(o->type);
1755 memcpy(field_dst, field_src, size);
1761 int av_opt_query_ranges(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1764 const AVClass *c = *(AVClass**)obj;
1765 int (*callback)(AVOptionRanges **, void *obj, const char *key, int flags) = NULL;
1767 if (c->version > (52 << 16 | 11 << 8))
1768 callback = c->query_ranges;
1771 callback = av_opt_query_ranges_default;
1773 ret = callback(ranges_arg, obj, key, flags);
1775 if (!(flags & AV_OPT_MULTI_COMPONENT_RANGE))
1777 (*ranges_arg)->nb_components = ret;
1782 int av_opt_query_ranges_default(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1784 AVOptionRanges *ranges = av_mallocz(sizeof(*ranges));
1785 AVOptionRange **range_array = av_mallocz(sizeof(void*));
1786 AVOptionRange *range = av_mallocz(sizeof(*range));
1787 const AVOption *field = av_opt_find(obj, key, NULL, 0, flags);
1792 if (!ranges || !range || !range_array || !field) {
1793 ret = AVERROR(ENOMEM);
1797 ranges->range = range_array;
1798 ranges->range[0] = range;
1799 ranges->nb_ranges = 1;
1800 ranges->nb_components = 1;
1801 range->is_range = 1;
1802 range->value_min = field->min;
1803 range->value_max = field->max;
1805 switch (field->type) {
1806 case AV_OPT_TYPE_BOOL:
1807 case AV_OPT_TYPE_INT:
1808 case AV_OPT_TYPE_INT64:
1809 case AV_OPT_TYPE_UINT64:
1810 case AV_OPT_TYPE_PIXEL_FMT:
1811 case AV_OPT_TYPE_SAMPLE_FMT:
1812 case AV_OPT_TYPE_FLOAT:
1813 case AV_OPT_TYPE_DOUBLE:
1814 case AV_OPT_TYPE_DURATION:
1815 case AV_OPT_TYPE_COLOR:
1816 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1818 case AV_OPT_TYPE_STRING:
1819 range->component_min = 0;
1820 range->component_max = 0x10FFFF; // max unicode value
1821 range->value_min = -1;
1822 range->value_max = INT_MAX;
1824 case AV_OPT_TYPE_RATIONAL:
1825 range->component_min = INT_MIN;
1826 range->component_max = INT_MAX;
1828 case AV_OPT_TYPE_IMAGE_SIZE:
1829 range->component_min = 0;
1830 range->component_max = INT_MAX/128/8;
1831 range->value_min = 0;
1832 range->value_max = INT_MAX/8;
1834 case AV_OPT_TYPE_VIDEO_RATE:
1835 range->component_min = 1;
1836 range->component_max = INT_MAX;
1837 range->value_min = 1;
1838 range->value_max = INT_MAX;
1841 ret = AVERROR(ENOSYS);
1845 *ranges_arg = ranges;
1850 av_free(range_array);
1854 void av_opt_freep_ranges(AVOptionRanges **rangesp)
1857 AVOptionRanges *ranges = *rangesp;
1862 for (i = 0; i < ranges->nb_ranges * ranges->nb_components; i++) {
1863 AVOptionRange *range = ranges->range[i];
1865 av_freep(&range->str);
1866 av_freep(&ranges->range[i]);
1869 av_freep(&ranges->range);
1873 int av_opt_is_set_to_default(void *obj, const AVOption *o)
1884 return AVERROR(EINVAL);
1886 dst = ((uint8_t*)obj) + o->offset;
1889 case AV_OPT_TYPE_CONST:
1891 case AV_OPT_TYPE_BOOL:
1892 case AV_OPT_TYPE_FLAGS:
1893 case AV_OPT_TYPE_PIXEL_FMT:
1894 case AV_OPT_TYPE_SAMPLE_FMT:
1895 case AV_OPT_TYPE_INT:
1896 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1897 case AV_OPT_TYPE_DURATION:
1898 case AV_OPT_TYPE_INT64:
1899 case AV_OPT_TYPE_UINT64:
1900 read_number(o, dst, NULL, NULL, &i64);
1901 return o->default_val.i64 == i64;
1902 case AV_OPT_TYPE_STRING:
1903 str = *(char **)dst;
1904 if (str == o->default_val.str) //2 NULLs
1906 if (!str || !o->default_val.str) //1 NULL
1908 return !strcmp(str, o->default_val.str);
1909 case AV_OPT_TYPE_DOUBLE:
1910 read_number(o, dst, &d, NULL, NULL);
1911 return o->default_val.dbl == d;
1912 case AV_OPT_TYPE_FLOAT:
1913 read_number(o, dst, &d, NULL, NULL);
1914 f = o->default_val.dbl;
1917 case AV_OPT_TYPE_RATIONAL:
1918 q = av_d2q(o->default_val.dbl, INT_MAX);
1919 return !av_cmp_q(*(AVRational*)dst, q);
1920 case AV_OPT_TYPE_BINARY: {
1925 int opt_size = *(int *)((void **)dst + 1);
1926 void *opt_ptr = *(void **)dst;
1927 if (!opt_size && (!o->default_val.str || !strlen(o->default_val.str)))
1929 if (!opt_size || !o->default_val.str || !strlen(o->default_val.str ))
1931 if (opt_size != strlen(o->default_val.str) / 2)
1933 ret = set_string_binary(NULL, NULL, o->default_val.str, &tmp.data);
1935 ret = !memcmp(opt_ptr, tmp.data, tmp.size);
1939 case AV_OPT_TYPE_DICT:
1940 /* Binary and dict have not default support yet. Any pointer is not default. */
1941 return !!(*(void **)dst);
1942 case AV_OPT_TYPE_IMAGE_SIZE:
1943 if (!o->default_val.str || !strcmp(o->default_val.str, "none"))
1945 else if ((ret = av_parse_video_size(&w, &h, o->default_val.str)) < 0)
1947 return (w == *(int *)dst) && (h == *((int *)dst+1));
1948 case AV_OPT_TYPE_VIDEO_RATE:
1949 q = (AVRational){0, 0};
1950 if (o->default_val.str) {
1951 if ((ret = av_parse_video_rate(&q, o->default_val.str)) < 0)
1954 return !av_cmp_q(*(AVRational*)dst, q);
1955 case AV_OPT_TYPE_COLOR: {
1956 uint8_t color[4] = {0, 0, 0, 0};
1957 if (o->default_val.str) {
1958 if ((ret = av_parse_color(color, o->default_val.str, -1, NULL)) < 0)
1961 return !memcmp(color, dst, sizeof(color));
1964 av_log(obj, AV_LOG_WARNING, "Not supported option type: %d, option name: %s\n", o->type, o->name);
1967 return AVERROR_PATCHWELCOME;
1970 int av_opt_is_set_to_default_by_name(void *obj, const char *name, int search_flags)
1975 return AVERROR(EINVAL);
1976 o = av_opt_find2(obj, name, NULL, 0, search_flags, &target);
1978 return AVERROR_OPTION_NOT_FOUND;
1979 return av_opt_is_set_to_default(target, o);
1982 int av_opt_serialize(void *obj, int opt_flags, int flags, char **buffer,
1983 const char key_val_sep, const char pairs_sep)
1985 const AVOption *o = NULL;
1989 const char special_chars[] = {pairs_sep, key_val_sep, '\0'};
1991 if (pairs_sep == '\0' || key_val_sep == '\0' || pairs_sep == key_val_sep ||
1992 pairs_sep == '\\' || key_val_sep == '\\') {
1993 av_log(obj, AV_LOG_ERROR, "Invalid separator(s) found.");
1994 return AVERROR(EINVAL);
1997 if (!obj || !buffer)
1998 return AVERROR(EINVAL);
2001 av_bprint_init(&bprint, 64, AV_BPRINT_SIZE_UNLIMITED);
2003 while (o = av_opt_next(obj, o)) {
2004 if (o->type == AV_OPT_TYPE_CONST)
2006 if ((flags & AV_OPT_SERIALIZE_OPT_FLAGS_EXACT) && o->flags != opt_flags)
2008 else if (((o->flags & opt_flags) != opt_flags))
2010 if (flags & AV_OPT_SERIALIZE_SKIP_DEFAULTS && av_opt_is_set_to_default(obj, o) > 0)
2012 if ((ret = av_opt_get(obj, o->name, 0, &buf)) < 0) {
2013 av_bprint_finalize(&bprint, NULL);
2018 av_bprint_append_data(&bprint, &pairs_sep, 1);
2019 av_bprint_escape(&bprint, o->name, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
2020 av_bprint_append_data(&bprint, &key_val_sep, 1);
2021 av_bprint_escape(&bprint, buf, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
2025 av_bprint_finalize(&bprint, buffer);