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>
30 #include "channel_layout.h"
36 #include "parseutils.h"
38 #include "mathematics.h"
39 #include "samplefmt.h"
44 //FIXME order them and do a bin search
45 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags)
47 const AVOption *o = NULL;
49 while ((o = av_next_option(v, o))) {
50 if (!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags)
57 #if FF_API_OLD_AVOPTIONS
58 const AVOption *av_next_option(void *obj, const AVOption *last)
60 return av_opt_next(obj, last);
64 const AVOption *av_opt_next(void *obj, const AVOption *last)
66 AVClass *class = *(AVClass**)obj;
67 if (!last && class && class->option && class->option[0].name)
69 if (last && last[1].name)
74 static int read_number(const AVOption *o, void *dst, double *num, int *den, int64_t *intnum)
77 case AV_OPT_TYPE_FLAGS: *intnum = *(unsigned int*)dst;return 0;
78 case AV_OPT_TYPE_PIXEL_FMT:
79 case AV_OPT_TYPE_SAMPLE_FMT:
80 case AV_OPT_TYPE_INT: *intnum = *(int *)dst;return 0;
81 case AV_OPT_TYPE_CHANNEL_LAYOUT:
82 case AV_OPT_TYPE_DURATION:
83 case AV_OPT_TYPE_INT64: *intnum = *(int64_t *)dst;return 0;
84 case AV_OPT_TYPE_FLOAT: *num = *(float *)dst;return 0;
85 case AV_OPT_TYPE_DOUBLE: *num = *(double *)dst;return 0;
86 case AV_OPT_TYPE_RATIONAL: *intnum = ((AVRational*)dst)->num;
87 *den = ((AVRational*)dst)->den;
89 case AV_OPT_TYPE_CONST: *num = o->default_val.dbl; return 0;
91 return AVERROR(EINVAL);
94 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
96 if (o->type != AV_OPT_TYPE_FLAGS &&
97 (o->max * den < num * intnum || o->min * den > num * intnum)) {
98 av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range [%g - %g]\n",
99 num*intnum/den, o->name, o->min, o->max);
100 return AVERROR(ERANGE);
102 if (o->type == AV_OPT_TYPE_FLAGS) {
103 double d = num*intnum/den;
104 if (d < -1.5 || d > 0xFFFFFFFF+0.5 || (llrint(d*256) & 255)) {
105 av_log(obj, AV_LOG_ERROR,
106 "Value %f for parameter '%s' is not a valid set of 32bit integer flags\n",
107 num*intnum/den, o->name);
108 return AVERROR(ERANGE);
113 case AV_OPT_TYPE_FLAGS:
114 case AV_OPT_TYPE_PIXEL_FMT:
115 case AV_OPT_TYPE_SAMPLE_FMT:
116 case AV_OPT_TYPE_INT: *(int *)dst= llrint(num/den)*intnum; break;
117 case AV_OPT_TYPE_DURATION:
118 case AV_OPT_TYPE_CHANNEL_LAYOUT:
119 case AV_OPT_TYPE_INT64: *(int64_t *)dst= llrint(num/den)*intnum; break;
120 case AV_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
121 case AV_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
122 case AV_OPT_TYPE_RATIONAL:
123 if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
124 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
127 return AVERROR(EINVAL);
132 static const double const_values[] = {
139 static const char * const const_names[] = {
146 static int hexchar2int(char c) {
147 if (c >= '0' && c <= '9') return c - '0';
148 if (c >= 'a' && c <= 'f') return c - 'a' + 10;
149 if (c >= 'A' && c <= 'F') return c - 'A' + 10;
153 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
155 int *lendst = (int *)(dst + 1);
157 int len = strlen(val);
163 return AVERROR(EINVAL);
166 ptr = bin = av_malloc(len);
168 int a = hexchar2int(*val++);
169 int b = hexchar2int(*val++);
170 if (a < 0 || b < 0) {
172 return AVERROR(EINVAL);
174 *ptr++ = (a << 4) | b;
182 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
185 *dst = av_strdup(val);
189 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
190 opt->type == AV_OPT_TYPE_CONST || \
191 opt->type == AV_OPT_TYPE_FLAGS || \
192 opt->type == AV_OPT_TYPE_INT) ? \
193 opt->default_val.i64 : opt->default_val.dbl)
195 static int set_string_number(void *obj, void *target_obj, const AVOption *o, const char *val, void *dst)
197 int ret = 0, notfirst = 0;
201 if (sscanf(val, "%d%*1[:/]%d%c", &num, &den, &c) == 2) {
202 if ((ret = write_number(obj, o, dst, 1, den, num)) >= 0)
215 if (*val == '+' || *val == '-') {
216 if (o->type == AV_OPT_TYPE_FLAGS)
222 for (; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
227 const AVOption *o_named = av_opt_find(target_obj, buf, o->unit, 0, 0);
228 if (o_named && o_named->type == AV_OPT_TYPE_CONST)
229 d = DEFAULT_NUMVAL(o_named);
230 else if (!strcmp(buf, "default")) d = DEFAULT_NUMVAL(o);
231 else if (!strcmp(buf, "max" )) d = o->max;
232 else if (!strcmp(buf, "min" )) d = o->min;
233 else if (!strcmp(buf, "none" )) d = 0;
234 else if (!strcmp(buf, "all" )) d = ~0;
236 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
238 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
243 if (o->type == AV_OPT_TYPE_FLAGS) {
244 read_number(o, dst, NULL, NULL, &intnum);
245 if (cmd == '+') d = intnum | (int64_t)d;
246 else if (cmd == '-') d = intnum &~(int64_t)d;
248 read_number(o, dst, &num, &den, &intnum);
249 if (cmd == '+') d = notfirst*num*intnum/den + d;
250 else if (cmd == '-') d = notfirst*num*intnum/den - d;
253 if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
264 static int set_string_image_size(void *obj, const AVOption *o, const char *val, int *dst)
268 if (!val || !strcmp(val, "none")) {
273 ret = av_parse_video_size(dst, dst + 1, val);
275 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as image size\n", val);
279 static int set_string_video_rate(void *obj, const AVOption *o, const char *val, AVRational *dst)
283 ret = AVERROR(EINVAL);
285 ret = av_parse_video_rate(dst, val);
288 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as video rate\n", val);
292 static int set_string_color(void *obj, const AVOption *o, const char *val, uint8_t *dst)
299 ret = av_parse_color(dst, val, -1, obj);
301 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as color\n", val);
307 static int set_string_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst,
308 int fmt_nb, int ((*get_fmt)(const char *)), const char *desc)
312 if (!val || !strcmp(val, "none")) {
318 fmt = strtol(val, &tail, 0);
319 if (*tail || (unsigned)fmt >= fmt_nb) {
320 av_log(obj, AV_LOG_ERROR,
321 "Unable to parse option value \"%s\" as %s\n", val, desc);
322 return AVERROR(EINVAL);
327 min = FFMAX(o->min, -1);
328 max = FFMIN(o->max, fmt_nb-1);
330 // hack for compatibility with old ffmpeg
331 if(min == 0 && max == 0) {
336 if (fmt < min || fmt > max) {
337 av_log(obj, AV_LOG_ERROR,
338 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
339 fmt, o->name, desc, min, max);
340 return AVERROR(ERANGE);
347 static int set_string_pixel_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
349 return set_string_fmt(obj, o, val, dst,
350 AV_PIX_FMT_NB, av_get_pix_fmt, "pixel format");
353 static int set_string_sample_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
355 return set_string_fmt(obj, o, val, dst,
356 AV_SAMPLE_FMT_NB, av_get_sample_fmt, "sample format");
359 #if FF_API_OLD_AVOPTIONS
360 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
362 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
365 return av_opt_set(obj, name, val, 0);
369 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
372 void *dst, *target_obj;
373 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
374 if (!o || !target_obj)
375 return AVERROR_OPTION_NOT_FOUND;
376 if (!val && (o->type != AV_OPT_TYPE_STRING &&
377 o->type != AV_OPT_TYPE_PIXEL_FMT && o->type != AV_OPT_TYPE_SAMPLE_FMT &&
378 o->type != AV_OPT_TYPE_IMAGE_SIZE && o->type != AV_OPT_TYPE_VIDEO_RATE &&
379 o->type != AV_OPT_TYPE_DURATION && o->type != AV_OPT_TYPE_COLOR &&
380 o->type != AV_OPT_TYPE_CHANNEL_LAYOUT))
381 return AVERROR(EINVAL);
383 if (o->flags & AV_OPT_FLAG_READONLY)
384 return AVERROR(EINVAL);
386 dst = ((uint8_t*)target_obj) + o->offset;
388 case AV_OPT_TYPE_STRING: return set_string(obj, o, val, dst);
389 case AV_OPT_TYPE_BINARY: return set_string_binary(obj, o, val, dst);
390 case AV_OPT_TYPE_FLAGS:
391 case AV_OPT_TYPE_INT:
392 case AV_OPT_TYPE_INT64:
393 case AV_OPT_TYPE_FLOAT:
394 case AV_OPT_TYPE_DOUBLE:
395 case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, target_obj, o, val, dst);
396 case AV_OPT_TYPE_IMAGE_SIZE: return set_string_image_size(obj, o, val, dst);
397 case AV_OPT_TYPE_VIDEO_RATE: return set_string_video_rate(obj, o, val, dst);
398 case AV_OPT_TYPE_PIXEL_FMT: return set_string_pixel_fmt(obj, o, val, dst);
399 case AV_OPT_TYPE_SAMPLE_FMT: return set_string_sample_fmt(obj, o, val, dst);
400 case AV_OPT_TYPE_DURATION:
405 if ((ret = av_parse_time(dst, val, 1)) < 0)
406 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as duration\n", val);
410 case AV_OPT_TYPE_COLOR: return set_string_color(obj, o, val, dst);
411 case AV_OPT_TYPE_CHANNEL_LAYOUT:
412 if (!val || !strcmp(val, "none")) {
415 #if FF_API_GET_CHANNEL_LAYOUT_COMPAT
416 int64_t cl = ff_get_channel_layout(val, 0);
418 int64_t cl = av_get_channel_layout(val);
421 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as channel layout\n", val);
422 ret = AVERROR(EINVAL);
424 *(int64_t *)dst = cl;
430 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
431 return AVERROR(EINVAL);
434 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
435 int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
437 if (!o || o->type != opttype || o->flags & AV_OPT_FLAG_READONLY)\
438 return AVERROR(EINVAL);\
439 return set_string_number(obj, obj, o, val, name ## _out);\
442 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
443 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
444 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
445 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
446 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
447 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
449 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
452 void *dst, *target_obj;
453 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
455 if (!o || !target_obj)
456 return AVERROR_OPTION_NOT_FOUND;
458 if (o->flags & AV_OPT_FLAG_READONLY)
459 return AVERROR(EINVAL);
461 dst = ((uint8_t*)target_obj) + o->offset;
462 return write_number(obj, o, dst, num, den, intnum);
465 #if FF_API_OLD_AVOPTIONS
466 const AVOption *av_set_double(void *obj, const char *name, double n)
468 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
469 if (set_number(obj, name, n, 1, 1, 0) < 0)
474 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
476 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
477 if (set_number(obj, name, n.num, n.den, 1, 0) < 0)
482 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
484 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
485 if (set_number(obj, name, 1, 1, n, 0) < 0)
491 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
493 return set_number(obj, name, 1, 1, val, search_flags);
496 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
498 return set_number(obj, name, val, 1, 1, search_flags);
501 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
503 return set_number(obj, name, val.num, val.den, 1, search_flags);
506 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
509 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
514 if (!o || !target_obj)
515 return AVERROR_OPTION_NOT_FOUND;
517 if (o->type != AV_OPT_TYPE_BINARY || o->flags & AV_OPT_FLAG_READONLY)
518 return AVERROR(EINVAL);
520 ptr = len ? av_malloc(len) : NULL;
522 return AVERROR(ENOMEM);
524 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
525 lendst = (int *)(dst + 1);
531 memcpy(ptr, val, len);
536 int av_opt_set_image_size(void *obj, const char *name, int w, int h, int search_flags)
539 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
541 if (!o || !target_obj)
542 return AVERROR_OPTION_NOT_FOUND;
543 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
544 av_log(obj, AV_LOG_ERROR,
545 "The value set by option '%s' is not an image size.\n", o->name);
546 return AVERROR(EINVAL);
549 av_log(obj, AV_LOG_ERROR,
550 "Invalid negative size value %dx%d for size '%s'\n", w, h, o->name);
551 return AVERROR(EINVAL);
553 *(int *)(((uint8_t *)target_obj) + o->offset) = w;
554 *(int *)(((uint8_t *)target_obj+sizeof(int)) + o->offset) = h;
558 int av_opt_set_video_rate(void *obj, const char *name, AVRational val, int search_flags)
561 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
563 if (!o || !target_obj)
564 return AVERROR_OPTION_NOT_FOUND;
565 if (o->type != AV_OPT_TYPE_VIDEO_RATE) {
566 av_log(obj, AV_LOG_ERROR,
567 "The value set by option '%s' is not a video rate.\n", o->name);
568 return AVERROR(EINVAL);
570 if (val.num <= 0 || val.den <= 0)
571 return AVERROR(EINVAL);
572 return set_number(obj, name, val.num, val.den, 1, search_flags);
575 static int set_format(void *obj, const char *name, int fmt, int search_flags,
576 enum AVOptionType type, const char *desc, int nb_fmts)
579 const AVOption *o = av_opt_find2(obj, name, NULL, 0,
580 search_flags, &target_obj);
582 const AVClass *class = *(AVClass **)obj;
584 if (!o || !target_obj)
585 return AVERROR_OPTION_NOT_FOUND;
586 if (o->type != type) {
587 av_log(obj, AV_LOG_ERROR,
588 "The value set by option '%s' is not a %s format", name, desc);
589 return AVERROR(EINVAL);
592 #if LIBAVUTIL_VERSION_MAJOR < 54
593 if (class->version && class->version < AV_VERSION_INT(52, 11, 100)) {
599 min = FFMAX(o->min, -1);
600 max = FFMIN(o->max, nb_fmts-1);
602 if (fmt < min || fmt > max) {
603 av_log(obj, AV_LOG_ERROR,
604 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
605 fmt, name, desc, min, max);
606 return AVERROR(ERANGE);
608 *(int *)(((uint8_t *)target_obj) + o->offset) = fmt;
612 int av_opt_set_pixel_fmt(void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
614 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_PIXEL_FMT, "pixel", AV_PIX_FMT_NB);
617 int av_opt_set_sample_fmt(void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
619 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_SAMPLE_FMT, "sample", AV_SAMPLE_FMT_NB);
622 int av_opt_set_channel_layout(void *obj, const char *name, int64_t cl, int search_flags)
625 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
627 if (!o || !target_obj)
628 return AVERROR_OPTION_NOT_FOUND;
629 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
630 av_log(obj, AV_LOG_ERROR,
631 "The value set by option '%s' is not a channel layout.\n", o->name);
632 return AVERROR(EINVAL);
634 *(int *)(((int64_t *)target_obj) + o->offset) = cl;
638 #if FF_API_OLD_AVOPTIONS
641 * @param buf a buffer which is used for returning non string values as strings, can be NULL
642 * @param buf_len allocated length in bytes of buf
644 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
646 const AVOption *o = av_opt_find(obj, name, NULL, 0, AV_OPT_SEARCH_CHILDREN);
652 if (o->type != AV_OPT_TYPE_STRING && (!buf || !buf_len))
655 dst= ((uint8_t*)obj) + o->offset;
656 if (o_out) *o_out= o;
659 case AV_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
660 case AV_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
661 case AV_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
662 case AV_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
663 case AV_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
664 case AV_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
665 case AV_OPT_TYPE_CONST: snprintf(buf, buf_len, "%f" , o->default_val.dbl);break;
666 case AV_OPT_TYPE_STRING: return *(void**)dst;
667 case AV_OPT_TYPE_BINARY:
668 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
669 if (len >= (buf_len + 1)/2) return NULL;
670 bin = *(uint8_t**)dst;
671 for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
673 default: return NULL;
679 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
681 void *dst, *target_obj;
682 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
683 uint8_t *bin, buf[128];
687 if (!o || !target_obj || (o->offset<=0 && o->type != AV_OPT_TYPE_CONST))
688 return AVERROR_OPTION_NOT_FOUND;
690 dst = (uint8_t*)target_obj + o->offset;
694 case AV_OPT_TYPE_FLAGS: ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);break;
695 case AV_OPT_TYPE_INT: ret = snprintf(buf, sizeof(buf), "%d" , *(int *)dst);break;
696 case AV_OPT_TYPE_INT64: ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
697 case AV_OPT_TYPE_FLOAT: ret = snprintf(buf, sizeof(buf), "%f" , *(float *)dst);break;
698 case AV_OPT_TYPE_DOUBLE: ret = snprintf(buf, sizeof(buf), "%f" , *(double *)dst);break;
699 case AV_OPT_TYPE_VIDEO_RATE:
700 case AV_OPT_TYPE_RATIONAL: ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
701 case AV_OPT_TYPE_CONST: ret = snprintf(buf, sizeof(buf), "%f" , o->default_val.dbl);break;
702 case AV_OPT_TYPE_STRING:
704 *out_val = av_strdup(*(uint8_t**)dst);
706 *out_val = av_strdup("");
708 case AV_OPT_TYPE_BINARY:
709 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
710 if ((uint64_t)len*2 + 1 > INT_MAX)
711 return AVERROR(EINVAL);
712 if (!(*out_val = av_malloc(len*2 + 1)))
713 return AVERROR(ENOMEM);
714 bin = *(uint8_t**)dst;
715 for (i = 0; i < len; i++)
716 snprintf(*out_val + i*2, 3, "%02X", bin[i]);
718 case AV_OPT_TYPE_IMAGE_SIZE:
719 ret = snprintf(buf, sizeof(buf), "%dx%d", ((int *)dst)[0], ((int *)dst)[1]);
721 case AV_OPT_TYPE_PIXEL_FMT:
722 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_pix_fmt_name(*(enum AVPixelFormat *)dst), "none"));
724 case AV_OPT_TYPE_SAMPLE_FMT:
725 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_sample_fmt_name(*(enum AVSampleFormat *)dst), "none"));
727 case AV_OPT_TYPE_DURATION:
728 i64 = *(int64_t *)dst;
729 ret = snprintf(buf, sizeof(buf), "%"PRIi64"d:%02d:%02d.%06d",
730 i64 / 3600000000, (int)((i64 / 60000000) % 60),
731 (int)((i64 / 1000000) % 60), (int)(i64 % 1000000));
733 case AV_OPT_TYPE_COLOR:
734 ret = snprintf(buf, sizeof(buf), "0x%02x%02x%02x%02x", ((int *)dst)[0], ((int *)dst)[1], ((int *)dst)[2], ((int *)dst)[3]);
736 case AV_OPT_TYPE_CHANNEL_LAYOUT:
737 i64 = *(int64_t *)dst;
738 ret = snprintf(buf, sizeof(buf), "0x%"PRIx64, i64);
741 return AVERROR(EINVAL);
744 if (ret >= sizeof(buf))
745 return AVERROR(EINVAL);
746 *out_val = av_strdup(buf);
750 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum,
753 void *dst, *target_obj;
754 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
755 if (!o || !target_obj)
758 dst = ((uint8_t*)target_obj) + o->offset;
760 if (o_out) *o_out= o;
762 return read_number(o, dst, num, den, intnum);
769 #if FF_API_OLD_AVOPTIONS
770 double av_get_double(void *obj, const char *name, const AVOption **o_out)
776 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
778 return num*intnum/den;
781 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
787 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
788 return (AVRational){0, 0};
789 if (num == 1.0 && (int)intnum == intnum)
790 return (AVRational){intnum, den};
792 return av_d2q(num*intnum/den, 1<<24);
795 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
801 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
803 return num*intnum/den;
807 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
813 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
815 *out_val = num*intnum/den;
819 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
825 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
827 *out_val = num*intnum/den;
831 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
837 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
840 if (num == 1.0 && (int)intnum == intnum)
841 *out_val = (AVRational){intnum, den};
843 *out_val = av_d2q(num*intnum/den, 1<<24);
847 int av_opt_get_image_size(void *obj, const char *name, int search_flags, int *w_out, int *h_out)
849 void *dst, *target_obj;
850 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
851 if (!o || !target_obj)
852 return AVERROR_OPTION_NOT_FOUND;
853 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
854 av_log(obj, AV_LOG_ERROR,
855 "The value for option '%s' is not an image size.\n", name);
856 return AVERROR(EINVAL);
859 dst = ((uint8_t*)target_obj) + o->offset;
860 if (w_out) *w_out = *(int *)dst;
861 if (h_out) *h_out = *((int *)dst+1);
865 int av_opt_get_video_rate(void *obj, const char *name, int search_flags, AVRational *out_val)
871 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
874 if (num == 1.0 && (int)intnum == intnum)
875 *out_val = (AVRational){intnum, den};
877 *out_val = av_d2q(num*intnum/den, 1<<24);
881 static int get_format(void *obj, const char *name, int search_flags, int *out_fmt,
882 enum AVOptionType type, const char *desc)
884 void *dst, *target_obj;
885 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
886 if (!o || !target_obj)
887 return AVERROR_OPTION_NOT_FOUND;
888 if (o->type != type) {
889 av_log(obj, AV_LOG_ERROR,
890 "The value for option '%s' is not a %s format.\n", desc, name);
891 return AVERROR(EINVAL);
894 dst = ((uint8_t*)target_obj) + o->offset;
895 *out_fmt = *(int *)dst;
899 int av_opt_get_pixel_fmt(void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
901 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_PIXEL_FMT, "pixel");
904 int av_opt_get_sample_fmt(void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
906 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_SAMPLE_FMT, "sample");
909 int av_opt_get_channel_layout(void *obj, const char *name, int search_flags, int64_t *cl)
911 void *dst, *target_obj;
912 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
913 if (!o || !target_obj)
914 return AVERROR_OPTION_NOT_FOUND;
915 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
916 av_log(obj, AV_LOG_ERROR,
917 "The value for option '%s' is not a channel layout.\n", name);
918 return AVERROR(EINVAL);
921 dst = ((uint8_t*)target_obj) + o->offset;
922 *cl = *(int64_t *)dst;
926 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
928 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
929 const AVOption *flag = av_opt_find(obj, flag_name,
930 field ? field->unit : NULL, 0, 0);
933 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
934 av_opt_get_int(obj, field_name, 0, &res) < 0)
936 return res & flag->default_val.i64;
939 static void log_value(void *av_log_obj, int level, double d)
942 av_log(av_log_obj, level, "INT_MAX");
943 } else if (d == INT_MIN) {
944 av_log(av_log_obj, level, "INT_MIN");
945 } else if (d == UINT32_MAX) {
946 av_log(av_log_obj, level, "UINT32_MAX");
947 } else if (d == (double)INT64_MAX) {
948 av_log(av_log_obj, level, "I64_MAX");
949 } else if (d == INT64_MIN) {
950 av_log(av_log_obj, level, "I64_MIN");
951 } else if (d == FLT_MAX) {
952 av_log(av_log_obj, level, "FLT_MAX");
953 } else if (d == FLT_MIN) {
954 av_log(av_log_obj, level, "FLT_MIN");
955 } else if (d == -FLT_MAX) {
956 av_log(av_log_obj, level, "-FLT_MAX");
957 } else if (d == -FLT_MIN) {
958 av_log(av_log_obj, level, "-FLT_MIN");
959 } else if (d == DBL_MAX) {
960 av_log(av_log_obj, level, "DBL_MAX");
961 } else if (d == DBL_MIN) {
962 av_log(av_log_obj, level, "DBL_MIN");
963 } else if (d == -DBL_MAX) {
964 av_log(av_log_obj, level, "-DBL_MAX");
965 } else if (d == -DBL_MIN) {
966 av_log(av_log_obj, level, "-DBL_MIN");
968 av_log(av_log_obj, level, "%g", d);
972 static void opt_list(void *obj, void *av_log_obj, const char *unit,
973 int req_flags, int rej_flags)
975 const AVOption *opt=NULL;
979 while ((opt = av_opt_next(obj, opt))) {
980 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
983 /* Don't print CONST's on level one.
984 * Don't print anything but CONST's on level two.
985 * Only print items from the requested unit.
987 if (!unit && opt->type==AV_OPT_TYPE_CONST)
989 else if (unit && opt->type!=AV_OPT_TYPE_CONST)
991 else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
993 else if (unit && opt->type == AV_OPT_TYPE_CONST)
994 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
996 av_log(av_log_obj, AV_LOG_INFO, " %s%-17s ",
997 (opt->flags & AV_OPT_FLAG_FILTERING_PARAM) ? "" : "-",
1000 switch (opt->type) {
1001 case AV_OPT_TYPE_FLAGS:
1002 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<flags>");
1004 case AV_OPT_TYPE_INT:
1005 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int>");
1007 case AV_OPT_TYPE_INT64:
1008 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int64>");
1010 case AV_OPT_TYPE_DOUBLE:
1011 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<double>");
1013 case AV_OPT_TYPE_FLOAT:
1014 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<float>");
1016 case AV_OPT_TYPE_STRING:
1017 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<string>");
1019 case AV_OPT_TYPE_RATIONAL:
1020 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<rational>");
1022 case AV_OPT_TYPE_BINARY:
1023 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<binary>");
1025 case AV_OPT_TYPE_IMAGE_SIZE:
1026 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<image_size>");
1028 case AV_OPT_TYPE_VIDEO_RATE:
1029 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<video_rate>");
1031 case AV_OPT_TYPE_PIXEL_FMT:
1032 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<pix_fmt>");
1034 case AV_OPT_TYPE_SAMPLE_FMT:
1035 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<sample_fmt>");
1037 case AV_OPT_TYPE_DURATION:
1038 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<duration>");
1040 case AV_OPT_TYPE_COLOR:
1041 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<color>");
1043 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1044 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<channel_layout>");
1046 case AV_OPT_TYPE_CONST:
1048 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "");
1051 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
1052 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
1053 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_FILTERING_PARAM)? 'F' : '.');
1054 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
1055 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
1056 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
1057 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_EXPORT) ? 'X' : '.');
1058 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_READONLY) ? 'R' : '.');
1061 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
1063 if (av_opt_query_ranges(&r, obj, opt->name, AV_OPT_SEARCH_FAKE_OBJ) >= 0) {
1064 switch (opt->type) {
1065 case AV_OPT_TYPE_INT:
1066 case AV_OPT_TYPE_INT64:
1067 case AV_OPT_TYPE_DOUBLE:
1068 case AV_OPT_TYPE_FLOAT:
1069 case AV_OPT_TYPE_RATIONAL:
1070 for (i = 0; i < r->nb_ranges; i++) {
1071 av_log(av_log_obj, AV_LOG_INFO, " (from ");
1072 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_min);
1073 av_log(av_log_obj, AV_LOG_INFO, " to ");
1074 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_max);
1075 av_log(av_log_obj, AV_LOG_INFO, ")");
1079 av_opt_freep_ranges(&r);
1082 if (opt->type != AV_OPT_TYPE_CONST &&
1083 opt->type != AV_OPT_TYPE_BINARY &&
1084 !((opt->type == AV_OPT_TYPE_COLOR ||
1085 opt->type == AV_OPT_TYPE_IMAGE_SIZE ||
1086 opt->type == AV_OPT_TYPE_STRING ||
1087 opt->type == AV_OPT_TYPE_VIDEO_RATE) &&
1088 !opt->default_val.str)) {
1089 av_log(av_log_obj, AV_LOG_INFO, " (default ");
1090 switch (opt->type) {
1091 case AV_OPT_TYPE_FLAGS:
1092 av_log(av_log_obj, AV_LOG_INFO, "%"PRIX64, opt->default_val.i64);
1094 case AV_OPT_TYPE_DURATION:
1095 case AV_OPT_TYPE_INT:
1096 case AV_OPT_TYPE_INT64:
1097 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.i64);
1099 case AV_OPT_TYPE_DOUBLE:
1100 case AV_OPT_TYPE_FLOAT:
1101 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.dbl);
1103 case AV_OPT_TYPE_RATIONAL: {
1104 AVRational q = av_d2q(opt->default_val.dbl, INT_MAX);
1105 av_log(av_log_obj, AV_LOG_INFO, "%d/%d", q.num, q.den); }
1107 case AV_OPT_TYPE_PIXEL_FMT:
1108 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_pix_fmt_name(opt->default_val.i64), "none"));
1110 case AV_OPT_TYPE_SAMPLE_FMT:
1111 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_sample_fmt_name(opt->default_val.i64), "none"));
1113 case AV_OPT_TYPE_COLOR:
1114 case AV_OPT_TYPE_IMAGE_SIZE:
1115 case AV_OPT_TYPE_STRING:
1116 case AV_OPT_TYPE_VIDEO_RATE:
1117 av_log(av_log_obj, AV_LOG_INFO, "\"%s\"", opt->default_val.str);
1119 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1120 av_log(av_log_obj, AV_LOG_INFO, "0x%"PRIx64, opt->default_val.i64);
1123 av_log(av_log_obj, AV_LOG_INFO, ")");
1126 av_log(av_log_obj, AV_LOG_INFO, "\n");
1127 if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
1128 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
1133 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
1138 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
1140 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
1145 void av_opt_set_defaults(void *s)
1147 #if FF_API_OLD_AVOPTIONS
1148 av_opt_set_defaults2(s, 0, 0);
1151 void av_opt_set_defaults2(void *s, int mask, int flags)
1154 const AVClass *class = *(AVClass **)s;
1155 const AVOption *opt = NULL;
1156 while ((opt = av_opt_next(s, opt)) != NULL) {
1157 void *dst = ((uint8_t*)s) + opt->offset;
1158 #if FF_API_OLD_AVOPTIONS
1159 if ((opt->flags & mask) != flags)
1163 if (opt->flags & AV_OPT_FLAG_READONLY)
1166 switch (opt->type) {
1167 case AV_OPT_TYPE_CONST:
1168 /* Nothing to be done here */
1170 case AV_OPT_TYPE_FLAGS:
1171 case AV_OPT_TYPE_INT:
1172 case AV_OPT_TYPE_INT64:
1173 case AV_OPT_TYPE_DURATION:
1174 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1175 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1177 case AV_OPT_TYPE_DOUBLE:
1178 case AV_OPT_TYPE_FLOAT: {
1180 val = opt->default_val.dbl;
1181 write_number(s, opt, dst, val, 1, 1);
1184 case AV_OPT_TYPE_RATIONAL: {
1186 val = av_d2q(opt->default_val.dbl, INT_MAX);
1187 write_number(s, opt, dst, 1, val.den, val.num);
1190 case AV_OPT_TYPE_COLOR:
1191 set_string_color(s, opt, opt->default_val.str, dst);
1193 case AV_OPT_TYPE_STRING:
1194 set_string(s, opt, opt->default_val.str, dst);
1196 case AV_OPT_TYPE_IMAGE_SIZE:
1197 set_string_image_size(s, opt, opt->default_val.str, dst);
1199 case AV_OPT_TYPE_VIDEO_RATE:
1200 set_string_video_rate(s, opt, opt->default_val.str, dst);
1202 case AV_OPT_TYPE_PIXEL_FMT:
1203 #if LIBAVUTIL_VERSION_MAJOR < 54
1204 if (class->version && class->version < AV_VERSION_INT(52, 10, 100))
1205 av_opt_set(s, opt->name, opt->default_val.str, 0);
1208 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1210 case AV_OPT_TYPE_SAMPLE_FMT:
1211 #if LIBAVUTIL_VERSION_MAJOR < 54
1212 if (class->version && class->version < AV_VERSION_INT(52, 10, 100))
1213 av_opt_set(s, opt->name, opt->default_val.str, 0);
1216 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1218 case AV_OPT_TYPE_BINARY:
1219 /* Cannot set default for binary */
1222 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
1228 * Store the value in the field in ctx that is named like key.
1229 * ctx must be an AVClass context, storing is done using AVOptions.
1231 * @param buf the string to parse, buf will be updated to point at the
1232 * separator just after the parsed key/value pair
1233 * @param key_val_sep a 0-terminated list of characters used to
1234 * separate key from value
1235 * @param pairs_sep a 0-terminated list of characters used to separate
1236 * two pairs from each other
1237 * @return 0 if the key/value pair has been successfully parsed and
1238 * set, or a negative value corresponding to an AVERROR code in case
1240 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
1241 * the error code issued by av_opt_set() if the key/value pair
1244 static int parse_key_value_pair(void *ctx, const char **buf,
1245 const char *key_val_sep, const char *pairs_sep)
1247 char *key = av_get_token(buf, key_val_sep);
1252 return AVERROR(ENOMEM);
1254 if (*key && strspn(*buf, key_val_sep)) {
1256 val = av_get_token(buf, pairs_sep);
1259 return AVERROR(ENOMEM);
1262 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
1264 return AVERROR(EINVAL);
1267 av_log(ctx, AV_LOG_DEBUG, "Setting entry with key '%s' to value '%s'\n", key, val);
1269 ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
1270 if (ret == AVERROR_OPTION_NOT_FOUND)
1271 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
1278 int av_set_options_string(void *ctx, const char *opts,
1279 const char *key_val_sep, const char *pairs_sep)
1287 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
1298 #define WHITESPACES " \n\t"
1300 static int is_key_char(char c)
1302 return (unsigned)((c | 32) - 'a') < 26 ||
1303 (unsigned)(c - '0') < 10 ||
1304 c == '-' || c == '_' || c == '/' || c == '.';
1308 * Read a key from a string.
1310 * The key consists of is_key_char characters and must be terminated by a
1311 * character from the delim string; spaces are ignored.
1313 * @return 0 for success (even with ellipsis), <0 for failure
1315 static int get_key(const char **ropts, const char *delim, char **rkey)
1317 const char *opts = *ropts;
1318 const char *key_start, *key_end;
1320 key_start = opts += strspn(opts, WHITESPACES);
1321 while (is_key_char(*opts))
1324 opts += strspn(opts, WHITESPACES);
1325 if (!*opts || !strchr(delim, *opts))
1326 return AVERROR(EINVAL);
1328 if (!(*rkey = av_malloc(key_end - key_start + 1)))
1329 return AVERROR(ENOMEM);
1330 memcpy(*rkey, key_start, key_end - key_start);
1331 (*rkey)[key_end - key_start] = 0;
1336 int av_opt_get_key_value(const char **ropts,
1337 const char *key_val_sep, const char *pairs_sep,
1339 char **rkey, char **rval)
1342 char *key = NULL, *val;
1343 const char *opts = *ropts;
1345 if ((ret = get_key(&opts, key_val_sep, &key)) < 0 &&
1346 !(flags & AV_OPT_FLAG_IMPLICIT_KEY))
1347 return AVERROR(EINVAL);
1348 if (!(val = av_get_token(&opts, pairs_sep))) {
1350 return AVERROR(ENOMEM);
1358 int av_opt_set_from_string(void *ctx, const char *opts,
1359 const char *const *shorthand,
1360 const char *key_val_sep, const char *pairs_sep)
1363 const char *dummy_shorthand = NULL;
1364 char *av_uninit(parsed_key), *av_uninit(value);
1370 shorthand = &dummy_shorthand;
1373 ret = av_opt_get_key_value(&opts, key_val_sep, pairs_sep,
1374 *shorthand ? AV_OPT_FLAG_IMPLICIT_KEY : 0,
1375 &parsed_key, &value);
1377 if (ret == AVERROR(EINVAL))
1378 av_log(ctx, AV_LOG_ERROR, "No option name near '%s'\n", opts);
1380 av_log(ctx, AV_LOG_ERROR, "Unable to parse '%s': %s\n", opts,
1388 while (*shorthand) /* discard all remaining shorthand */
1391 key = *(shorthand++);
1394 av_log(ctx, AV_LOG_DEBUG, "Setting '%s' to value '%s'\n", key, value);
1395 if ((ret = av_opt_set(ctx, key, value, 0)) < 0) {
1396 if (ret == AVERROR_OPTION_NOT_FOUND)
1397 av_log(ctx, AV_LOG_ERROR, "Option '%s' not found\n", key);
1399 av_free(parsed_key);
1404 av_free(parsed_key);
1410 void av_opt_free(void *obj)
1412 const AVOption *o = NULL;
1413 while ((o = av_opt_next(obj, o)))
1414 if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
1415 av_freep((uint8_t *)obj + o->offset);
1418 int av_opt_set_dict2(void *obj, AVDictionary **options, int search_flags)
1420 AVDictionaryEntry *t = NULL;
1421 AVDictionary *tmp = NULL;
1427 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
1428 ret = av_opt_set(obj, t->key, t->value, search_flags);
1429 if (ret == AVERROR_OPTION_NOT_FOUND)
1430 av_dict_set(&tmp, t->key, t->value, 0);
1432 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
1437 av_dict_free(options);
1442 int av_opt_set_dict(void *obj, AVDictionary **options)
1444 return av_opt_set_dict2(obj, options, 0);
1447 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
1448 int opt_flags, int search_flags)
1450 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
1453 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
1454 int opt_flags, int search_flags, void **target_obj)
1457 const AVOption *o = NULL;
1467 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
1468 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
1469 const AVClass *child = NULL;
1470 while (child = av_opt_child_class_next(c, child))
1471 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
1475 while (child = av_opt_child_next(obj, child))
1476 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
1481 while (o = av_opt_next(obj, o)) {
1482 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
1483 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
1484 (unit && o->type == AV_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)))) {
1486 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
1497 void *av_opt_child_next(void *obj, void *prev)
1499 const AVClass *c = *(AVClass**)obj;
1501 return c->child_next(obj, prev);
1505 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
1507 if (parent->child_class_next)
1508 return parent->child_class_next(prev);
1512 void *av_opt_ptr(const AVClass *class, void *obj, const char *name)
1514 const AVOption *opt= av_opt_find2(&class, name, NULL, 0, AV_OPT_SEARCH_FAKE_OBJ, NULL);
1517 return (uint8_t*)obj + opt->offset;
1520 static int opt_size(enum AVOptionType type)
1523 case AV_OPT_TYPE_INT:
1524 case AV_OPT_TYPE_FLAGS: return sizeof(int);
1525 case AV_OPT_TYPE_DURATION:
1526 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1527 case AV_OPT_TYPE_INT64: return sizeof(int64_t);
1528 case AV_OPT_TYPE_DOUBLE: return sizeof(double);
1529 case AV_OPT_TYPE_FLOAT: return sizeof(float);
1530 case AV_OPT_TYPE_STRING: return sizeof(uint8_t*);
1531 case AV_OPT_TYPE_VIDEO_RATE:
1532 case AV_OPT_TYPE_RATIONAL: return sizeof(AVRational);
1533 case AV_OPT_TYPE_BINARY: return sizeof(uint8_t*) + sizeof(int);
1534 case AV_OPT_TYPE_IMAGE_SIZE:return sizeof(int[2]);
1535 case AV_OPT_TYPE_PIXEL_FMT: return sizeof(enum AVPixelFormat);
1536 case AV_OPT_TYPE_SAMPLE_FMT:return sizeof(enum AVSampleFormat);
1537 case AV_OPT_TYPE_COLOR: return 4;
1542 int av_opt_copy(void *dst, void *src)
1544 const AVOption *o = NULL;
1551 c = *(AVClass**)src;
1552 if (*(AVClass**)dst && c != *(AVClass**)dst)
1553 return AVERROR(EINVAL);
1555 while ((o = av_opt_next(src, o))) {
1556 void *field_dst = ((uint8_t*)dst) + o->offset;
1557 void *field_src = ((uint8_t*)src) + o->offset;
1558 uint8_t **field_dst8 = (uint8_t**)field_dst;
1559 uint8_t **field_src8 = (uint8_t**)field_src;
1561 if (o->type == AV_OPT_TYPE_STRING) {
1562 set_string(dst, o, *field_src8, field_dst8);
1563 if (*field_src8 && !*field_dst8)
1564 ret = AVERROR(ENOMEM);
1565 } else if (o->type == AV_OPT_TYPE_BINARY) {
1566 int len = *(int*)(field_src8 + 1);
1567 if (*field_dst8 != *field_src8)
1568 av_freep(field_dst8);
1569 *field_dst8 = av_memdup(*field_src8, len);
1570 if (len && !*field_dst8) {
1571 ret = AVERROR(ENOMEM);
1574 *(int*)(field_dst8 + 1) = len;
1575 } else if (o->type == AV_OPT_TYPE_CONST) {
1578 memcpy(field_dst, field_src, opt_size(o->type));
1584 int av_opt_query_ranges(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1587 const AVClass *c = *(AVClass**)obj;
1588 int (*callback)(AVOptionRanges **, void *obj, const char *key, int flags) = NULL;
1590 if (c->version > (52 << 16 | 11 << 8))
1591 callback = c->query_ranges;
1594 callback = av_opt_query_ranges_default;
1596 ret = callback(ranges_arg, obj, key, flags);
1598 if (!(flags & AV_OPT_MULTI_COMPONENT_RANGE))
1600 (*ranges_arg)->nb_components = ret;
1605 int av_opt_query_ranges_default(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1607 AVOptionRanges *ranges = av_mallocz(sizeof(*ranges));
1608 AVOptionRange **range_array = av_mallocz(sizeof(void*));
1609 AVOptionRange *range = av_mallocz(sizeof(*range));
1610 const AVOption *field = av_opt_find(obj, key, NULL, 0, flags);
1615 if (!ranges || !range || !range_array || !field) {
1616 ret = AVERROR(ENOMEM);
1620 ranges->range = range_array;
1621 ranges->range[0] = range;
1622 ranges->nb_ranges = 1;
1623 ranges->nb_components = 1;
1624 range->is_range = 1;
1625 range->value_min = field->min;
1626 range->value_max = field->max;
1628 switch (field->type) {
1629 case AV_OPT_TYPE_INT:
1630 case AV_OPT_TYPE_INT64:
1631 case AV_OPT_TYPE_PIXEL_FMT:
1632 case AV_OPT_TYPE_SAMPLE_FMT:
1633 case AV_OPT_TYPE_FLOAT:
1634 case AV_OPT_TYPE_DOUBLE:
1635 case AV_OPT_TYPE_DURATION:
1636 case AV_OPT_TYPE_COLOR:
1637 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1639 case AV_OPT_TYPE_STRING:
1640 range->component_min = 0;
1641 range->component_max = 0x10FFFF; // max unicode value
1642 range->value_min = -1;
1643 range->value_max = INT_MAX;
1645 case AV_OPT_TYPE_RATIONAL:
1646 range->component_min = INT_MIN;
1647 range->component_max = INT_MAX;
1649 case AV_OPT_TYPE_IMAGE_SIZE:
1650 range->component_min = 0;
1651 range->component_max = INT_MAX/128/8;
1652 range->value_min = 0;
1653 range->value_max = INT_MAX/8;
1655 case AV_OPT_TYPE_VIDEO_RATE:
1656 range->component_min = 1;
1657 range->component_max = INT_MAX;
1658 range->value_min = 1;
1659 range->value_max = INT_MAX;
1662 ret = AVERROR(ENOSYS);
1666 *ranges_arg = ranges;
1671 av_free(range_array);
1675 void av_opt_freep_ranges(AVOptionRanges **rangesp)
1678 AVOptionRanges *ranges = *rangesp;
1683 for (i = 0; i < ranges->nb_ranges * ranges->nb_components; i++) {
1684 AVOptionRange *range = ranges->range[i];
1686 av_freep(&range->str);
1687 av_freep(&ranges->range[i]);
1690 av_freep(&ranges->range);
1696 typedef struct TestContext
1698 const AVClass *class;
1703 AVRational rational;
1704 AVRational video_rate;
1706 enum AVPixelFormat pix_fmt;
1707 enum AVSampleFormat sample_fmt;
1710 int64_t channel_layout;
1713 #define OFFSET(x) offsetof(TestContext, x)
1715 #define TEST_FLAG_COOL 01
1716 #define TEST_FLAG_LAME 02
1717 #define TEST_FLAG_MU 04
1719 static const AVOption test_options[]= {
1720 {"num", "set num", OFFSET(num), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100 },
1721 {"toggle", "set toggle", OFFSET(toggle), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1 },
1722 {"rational", "set rational", OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0}, 0, 10 },
1723 {"string", "set string", OFFSET(string), AV_OPT_TYPE_STRING, {.str = "default"}, CHAR_MIN, CHAR_MAX },
1724 {"flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, INT_MAX, 0, "flags" },
1725 {"cool", "set cool flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
1726 {"lame", "set lame flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
1727 {"mu", "set mu flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
1728 {"size", "set size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,{0}, 0, 0 },
1729 {"pix_fmt", "set pixfmt", OFFSET(pix_fmt), AV_OPT_TYPE_PIXEL_FMT, {.i64 = AV_PIX_FMT_NONE}, -1, INT_MAX},
1730 {"sample_fmt", "set samplefmt", OFFSET(sample_fmt), AV_OPT_TYPE_SAMPLE_FMT, {.i64 = AV_SAMPLE_FMT_NONE}, -1, INT_MAX},
1731 {"video_rate", "set videorate", OFFSET(video_rate), AV_OPT_TYPE_VIDEO_RATE, {.str = "25"}, 0, 0 },
1732 {"duration", "set duration", OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX},
1733 {"color", "set color", OFFSET(color), AV_OPT_TYPE_COLOR, {.str = "pink"}, 0, 0},
1734 {"cl", "set channel layout", OFFSET(channel_layout), AV_OPT_TYPE_CHANNEL_LAYOUT, {.i64 = AV_CH_LAYOUT_HEXAGONAL}, 0, INT64_MAX},
1738 static const char *test_get_name(void *ctx)
1743 static const AVClass test_class = {
1753 printf("\nTesting av_set_options_string()\n");
1755 TestContext test_ctx = { 0 };
1756 static const char * const options[] = {
1772 "flags=+mu-lame : num=42: toggle=0",
1773 "num=42 : string=blahblah",
1774 "rational=0 : rational=1/2 : rational=1/-1",
1787 "video_rate=30000/1001",
1788 "video_rate=30/1.001",
1792 "duration=1\\:23\\:45.67",
1796 "cl=stereo+downmix",
1800 test_ctx.class = &test_class;
1801 av_opt_set_defaults(&test_ctx);
1803 av_log_set_level(AV_LOG_DEBUG);
1805 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1806 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1807 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
1808 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1811 av_opt_free(&test_ctx);
1814 printf("\nTesting av_opt_set_from_string()\n");
1816 TestContext test_ctx = { 0 };
1817 static const char * const options[] = {
1825 " 5 : hello : size = pal ",
1826 "a_very_long_option_name_that_will_need_to_be_ellipsized_around_here=42"
1828 static const char * const shorthand[] = { "num", "string", NULL };
1830 test_ctx.class = &test_class;
1831 av_opt_set_defaults(&test_ctx);
1833 av_log_set_level(AV_LOG_DEBUG);
1835 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1836 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1837 if (av_opt_set_from_string(&test_ctx, options[i], shorthand, "=", ":") < 0)
1838 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1841 av_opt_free(&test_ctx);