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 if (fmt < min || fmt > max) {
331 av_log(obj, AV_LOG_ERROR,
332 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
333 fmt, o->name, desc, min, max);
334 return AVERROR(ERANGE);
341 static int set_string_pixel_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
343 return set_string_fmt(obj, o, val, dst,
344 AV_PIX_FMT_NB, av_get_pix_fmt, "pixel format");
347 static int set_string_sample_fmt(void *obj, const AVOption *o, const char *val, uint8_t *dst)
349 return set_string_fmt(obj, o, val, dst,
350 AV_SAMPLE_FMT_NB, av_get_sample_fmt, "sample format");
353 #if FF_API_OLD_AVOPTIONS
354 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
356 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
359 return av_opt_set(obj, name, val, 0);
363 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
366 void *dst, *target_obj;
367 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
368 if (!o || !target_obj)
369 return AVERROR_OPTION_NOT_FOUND;
370 if (!val && (o->type != AV_OPT_TYPE_STRING &&
371 o->type != AV_OPT_TYPE_PIXEL_FMT && o->type != AV_OPT_TYPE_SAMPLE_FMT &&
372 o->type != AV_OPT_TYPE_IMAGE_SIZE && o->type != AV_OPT_TYPE_VIDEO_RATE &&
373 o->type != AV_OPT_TYPE_DURATION && o->type != AV_OPT_TYPE_COLOR &&
374 o->type != AV_OPT_TYPE_CHANNEL_LAYOUT))
375 return AVERROR(EINVAL);
377 if (o->flags & AV_OPT_FLAG_READONLY)
378 return AVERROR(EINVAL);
380 dst = ((uint8_t*)target_obj) + o->offset;
382 case AV_OPT_TYPE_STRING: return set_string(obj, o, val, dst);
383 case AV_OPT_TYPE_BINARY: return set_string_binary(obj, o, val, dst);
384 case AV_OPT_TYPE_FLAGS:
385 case AV_OPT_TYPE_INT:
386 case AV_OPT_TYPE_INT64:
387 case AV_OPT_TYPE_FLOAT:
388 case AV_OPT_TYPE_DOUBLE:
389 case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, target_obj, o, val, dst);
390 case AV_OPT_TYPE_IMAGE_SIZE: return set_string_image_size(obj, o, val, dst);
391 case AV_OPT_TYPE_VIDEO_RATE: return set_string_video_rate(obj, o, val, dst);
392 case AV_OPT_TYPE_PIXEL_FMT: return set_string_pixel_fmt(obj, o, val, dst);
393 case AV_OPT_TYPE_SAMPLE_FMT: return set_string_sample_fmt(obj, o, val, dst);
394 case AV_OPT_TYPE_DURATION:
399 if ((ret = av_parse_time(dst, val, 1)) < 0)
400 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as duration\n", val);
404 case AV_OPT_TYPE_COLOR: return set_string_color(obj, o, val, dst);
405 case AV_OPT_TYPE_CHANNEL_LAYOUT:
406 if (!val || !strcmp(val, "none")) {
409 #if FF_API_GET_CHANNEL_LAYOUT_COMPAT
410 int64_t cl = ff_get_channel_layout(val, 0);
412 int64_t cl = av_get_channel_layout(val);
415 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as channel layout\n", val);
416 ret = AVERROR(EINVAL);
418 *(int64_t *)dst = cl;
424 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
425 return AVERROR(EINVAL);
428 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
429 int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
431 if (!o || o->type != opttype || o->flags & AV_OPT_FLAG_READONLY)\
432 return AVERROR(EINVAL);\
433 return set_string_number(obj, obj, o, val, name ## _out);\
436 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
437 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
438 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
439 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
440 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
441 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
443 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
446 void *dst, *target_obj;
447 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
449 if (!o || !target_obj)
450 return AVERROR_OPTION_NOT_FOUND;
452 if (o->flags & AV_OPT_FLAG_READONLY)
453 return AVERROR(EINVAL);
455 dst = ((uint8_t*)target_obj) + o->offset;
456 return write_number(obj, o, dst, num, den, intnum);
459 #if FF_API_OLD_AVOPTIONS
460 const AVOption *av_set_double(void *obj, const char *name, double n)
462 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
463 if (set_number(obj, name, n, 1, 1, 0) < 0)
468 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
470 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
471 if (set_number(obj, name, n.num, n.den, 1, 0) < 0)
476 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
478 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
479 if (set_number(obj, name, 1, 1, n, 0) < 0)
485 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
487 return set_number(obj, name, 1, 1, val, search_flags);
490 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
492 return set_number(obj, name, val, 1, 1, search_flags);
495 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
497 return set_number(obj, name, val.num, val.den, 1, search_flags);
500 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
503 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
508 if (!o || !target_obj)
509 return AVERROR_OPTION_NOT_FOUND;
511 if (o->type != AV_OPT_TYPE_BINARY || o->flags & AV_OPT_FLAG_READONLY)
512 return AVERROR(EINVAL);
514 ptr = len ? av_malloc(len) : NULL;
516 return AVERROR(ENOMEM);
518 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
519 lendst = (int *)(dst + 1);
525 memcpy(ptr, val, len);
530 int av_opt_set_image_size(void *obj, const char *name, int w, int h, int search_flags)
533 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
535 if (!o || !target_obj)
536 return AVERROR_OPTION_NOT_FOUND;
537 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
538 av_log(obj, AV_LOG_ERROR,
539 "The value set by option '%s' is not an image size.\n", o->name);
540 return AVERROR(EINVAL);
543 av_log(obj, AV_LOG_ERROR,
544 "Invalid negative size value %dx%d for size '%s'\n", w, h, o->name);
545 return AVERROR(EINVAL);
547 *(int *)(((uint8_t *)target_obj) + o->offset) = w;
548 *(int *)(((uint8_t *)target_obj+sizeof(int)) + o->offset) = h;
552 int av_opt_set_video_rate(void *obj, const char *name, AVRational val, int search_flags)
555 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
557 if (!o || !target_obj)
558 return AVERROR_OPTION_NOT_FOUND;
559 if (o->type != AV_OPT_TYPE_VIDEO_RATE) {
560 av_log(obj, AV_LOG_ERROR,
561 "The value set by option '%s' is not a video rate.\n", o->name);
562 return AVERROR(EINVAL);
564 if (val.num <= 0 || val.den <= 0)
565 return AVERROR(EINVAL);
566 return set_number(obj, name, val.num, val.den, 1, search_flags);
569 static int set_format(void *obj, const char *name, int fmt, int search_flags,
570 enum AVOptionType type, const char *desc, int nb_fmts)
573 const AVOption *o = av_opt_find2(obj, name, NULL, 0,
574 search_flags, &target_obj);
576 const AVClass *class = *(AVClass **)obj;
578 if (!o || !target_obj)
579 return AVERROR_OPTION_NOT_FOUND;
580 if (o->type != type) {
581 av_log(obj, AV_LOG_ERROR,
582 "The value set by option '%s' is not a %s format", name, desc);
583 return AVERROR(EINVAL);
586 #if LIBAVUTIL_VERSION_MAJOR < 54
587 if (class->version && class->version < AV_VERSION_INT(52, 11, 100)) {
593 min = FFMAX(o->min, -1);
594 max = FFMIN(o->max, nb_fmts-1);
596 if (fmt < min || fmt > max) {
597 av_log(obj, AV_LOG_ERROR,
598 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
599 fmt, name, desc, min, max);
600 return AVERROR(ERANGE);
602 *(int *)(((uint8_t *)target_obj) + o->offset) = fmt;
606 int av_opt_set_pixel_fmt(void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
608 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_PIXEL_FMT, "pixel", AV_PIX_FMT_NB);
611 int av_opt_set_sample_fmt(void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
613 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_SAMPLE_FMT, "sample", AV_SAMPLE_FMT_NB);
616 int av_opt_set_channel_layout(void *obj, const char *name, int64_t cl, int search_flags)
619 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
621 if (!o || !target_obj)
622 return AVERROR_OPTION_NOT_FOUND;
623 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
624 av_log(obj, AV_LOG_ERROR,
625 "The value set by option '%s' is not a channel layout.\n", o->name);
626 return AVERROR(EINVAL);
628 *(int *)(((int64_t *)target_obj) + o->offset) = cl;
632 #if FF_API_OLD_AVOPTIONS
635 * @param buf a buffer which is used for returning non string values as strings, can be NULL
636 * @param buf_len allocated length in bytes of buf
638 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
640 const AVOption *o = av_opt_find(obj, name, NULL, 0, AV_OPT_SEARCH_CHILDREN);
646 if (o->type != AV_OPT_TYPE_STRING && (!buf || !buf_len))
649 dst= ((uint8_t*)obj) + o->offset;
650 if (o_out) *o_out= o;
653 case AV_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
654 case AV_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
655 case AV_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
656 case AV_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
657 case AV_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
658 case AV_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
659 case AV_OPT_TYPE_CONST: snprintf(buf, buf_len, "%f" , o->default_val.dbl);break;
660 case AV_OPT_TYPE_STRING: return *(void**)dst;
661 case AV_OPT_TYPE_BINARY:
662 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
663 if (len >= (buf_len + 1)/2) return NULL;
664 bin = *(uint8_t**)dst;
665 for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
667 default: return NULL;
673 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
675 void *dst, *target_obj;
676 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
677 uint8_t *bin, buf[128];
681 if (!o || !target_obj || (o->offset<=0 && o->type != AV_OPT_TYPE_CONST))
682 return AVERROR_OPTION_NOT_FOUND;
684 dst = (uint8_t*)target_obj + o->offset;
688 case AV_OPT_TYPE_FLAGS: ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);break;
689 case AV_OPT_TYPE_INT: ret = snprintf(buf, sizeof(buf), "%d" , *(int *)dst);break;
690 case AV_OPT_TYPE_INT64: ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
691 case AV_OPT_TYPE_FLOAT: ret = snprintf(buf, sizeof(buf), "%f" , *(float *)dst);break;
692 case AV_OPT_TYPE_DOUBLE: ret = snprintf(buf, sizeof(buf), "%f" , *(double *)dst);break;
693 case AV_OPT_TYPE_VIDEO_RATE:
694 case AV_OPT_TYPE_RATIONAL: ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
695 case AV_OPT_TYPE_CONST: ret = snprintf(buf, sizeof(buf), "%f" , o->default_val.dbl);break;
696 case AV_OPT_TYPE_STRING:
698 *out_val = av_strdup(*(uint8_t**)dst);
700 *out_val = av_strdup("");
702 case AV_OPT_TYPE_BINARY:
703 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
704 if ((uint64_t)len*2 + 1 > INT_MAX)
705 return AVERROR(EINVAL);
706 if (!(*out_val = av_malloc(len*2 + 1)))
707 return AVERROR(ENOMEM);
708 bin = *(uint8_t**)dst;
709 for (i = 0; i < len; i++)
710 snprintf(*out_val + i*2, 3, "%02X", bin[i]);
712 case AV_OPT_TYPE_IMAGE_SIZE:
713 ret = snprintf(buf, sizeof(buf), "%dx%d", ((int *)dst)[0], ((int *)dst)[1]);
715 case AV_OPT_TYPE_PIXEL_FMT:
716 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_pix_fmt_name(*(enum AVPixelFormat *)dst), "none"));
718 case AV_OPT_TYPE_SAMPLE_FMT:
719 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_sample_fmt_name(*(enum AVSampleFormat *)dst), "none"));
721 case AV_OPT_TYPE_DURATION:
722 i64 = *(int64_t *)dst;
723 ret = snprintf(buf, sizeof(buf), "%"PRIi64"d:%02d:%02d.%06d",
724 i64 / 3600000000, (int)((i64 / 60000000) % 60),
725 (int)((i64 / 1000000) % 60), (int)(i64 % 1000000));
727 case AV_OPT_TYPE_COLOR:
728 ret = snprintf(buf, sizeof(buf), "0x%02x%02x%02x%02x", ((int *)dst)[0], ((int *)dst)[1], ((int *)dst)[2], ((int *)dst)[3]);
730 case AV_OPT_TYPE_CHANNEL_LAYOUT:
731 i64 = *(int64_t *)dst;
732 ret = snprintf(buf, sizeof(buf), "0x%"PRIx64, i64);
735 return AVERROR(EINVAL);
738 if (ret >= sizeof(buf))
739 return AVERROR(EINVAL);
740 *out_val = av_strdup(buf);
744 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum,
747 void *dst, *target_obj;
748 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
749 if (!o || !target_obj)
752 dst = ((uint8_t*)target_obj) + o->offset;
754 if (o_out) *o_out= o;
756 return read_number(o, dst, num, den, intnum);
763 #if FF_API_OLD_AVOPTIONS
764 double av_get_double(void *obj, const char *name, const AVOption **o_out)
770 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
772 return num*intnum/den;
775 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
781 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
782 return (AVRational){0, 0};
783 if (num == 1.0 && (int)intnum == intnum)
784 return (AVRational){intnum, den};
786 return av_d2q(num*intnum/den, 1<<24);
789 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
795 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
797 return num*intnum/den;
801 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
807 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
809 *out_val = num*intnum/den;
813 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
819 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
821 *out_val = num*intnum/den;
825 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
831 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
834 if (num == 1.0 && (int)intnum == intnum)
835 *out_val = (AVRational){intnum, den};
837 *out_val = av_d2q(num*intnum/den, 1<<24);
841 int av_opt_get_image_size(void *obj, const char *name, int search_flags, int *w_out, int *h_out)
843 void *dst, *target_obj;
844 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
845 if (!o || !target_obj)
846 return AVERROR_OPTION_NOT_FOUND;
847 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
848 av_log(obj, AV_LOG_ERROR,
849 "The value for option '%s' is not an image size.\n", name);
850 return AVERROR(EINVAL);
853 dst = ((uint8_t*)target_obj) + o->offset;
854 if (w_out) *w_out = *(int *)dst;
855 if (h_out) *h_out = *((int *)dst+1);
859 int av_opt_get_video_rate(void *obj, const char *name, int search_flags, AVRational *out_val)
865 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
868 if (num == 1.0 && (int)intnum == intnum)
869 *out_val = (AVRational){intnum, den};
871 *out_val = av_d2q(num*intnum/den, 1<<24);
875 static int get_format(void *obj, const char *name, int search_flags, int *out_fmt,
876 enum AVOptionType type, const char *desc)
878 void *dst, *target_obj;
879 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
880 if (!o || !target_obj)
881 return AVERROR_OPTION_NOT_FOUND;
882 if (o->type != type) {
883 av_log(obj, AV_LOG_ERROR,
884 "The value for option '%s' is not a %s format.\n", desc, name);
885 return AVERROR(EINVAL);
888 dst = ((uint8_t*)target_obj) + o->offset;
889 *out_fmt = *(int *)dst;
893 int av_opt_get_pixel_fmt(void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
895 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_PIXEL_FMT, "pixel");
898 int av_opt_get_sample_fmt(void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
900 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_SAMPLE_FMT, "sample");
903 int av_opt_get_channel_layout(void *obj, const char *name, int search_flags, int64_t *cl)
905 void *dst, *target_obj;
906 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
907 if (!o || !target_obj)
908 return AVERROR_OPTION_NOT_FOUND;
909 if (o->type != AV_OPT_TYPE_CHANNEL_LAYOUT) {
910 av_log(obj, AV_LOG_ERROR,
911 "The value for option '%s' is not a channel layout.\n", name);
912 return AVERROR(EINVAL);
915 dst = ((uint8_t*)target_obj) + o->offset;
916 *cl = *(int64_t *)dst;
920 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
922 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
923 const AVOption *flag = av_opt_find(obj, flag_name,
924 field ? field->unit : NULL, 0, 0);
927 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
928 av_opt_get_int(obj, field_name, 0, &res) < 0)
930 return res & flag->default_val.i64;
933 static void log_value(void *av_log_obj, int level, double d)
936 av_log(av_log_obj, level, "INT_MAX");
937 } else if (d == INT_MIN) {
938 av_log(av_log_obj, level, "INT_MIN");
939 } else if (d == UINT32_MAX) {
940 av_log(av_log_obj, level, "UINT32_MAX");
941 } else if (d == (double)INT64_MAX) {
942 av_log(av_log_obj, level, "I64_MAX");
943 } else if (d == INT64_MIN) {
944 av_log(av_log_obj, level, "I64_MIN");
945 } else if (d == FLT_MAX) {
946 av_log(av_log_obj, level, "FLT_MAX");
947 } else if (d == FLT_MIN) {
948 av_log(av_log_obj, level, "FLT_MIN");
949 } else if (d == -FLT_MAX) {
950 av_log(av_log_obj, level, "-FLT_MAX");
951 } else if (d == -FLT_MIN) {
952 av_log(av_log_obj, level, "-FLT_MIN");
953 } else if (d == DBL_MAX) {
954 av_log(av_log_obj, level, "DBL_MAX");
955 } else if (d == DBL_MIN) {
956 av_log(av_log_obj, level, "DBL_MIN");
957 } else if (d == -DBL_MAX) {
958 av_log(av_log_obj, level, "-DBL_MAX");
959 } else if (d == -DBL_MIN) {
960 av_log(av_log_obj, level, "-DBL_MIN");
962 av_log(av_log_obj, level, "%g", d);
966 static void opt_list(void *obj, void *av_log_obj, const char *unit,
967 int req_flags, int rej_flags)
969 const AVOption *opt=NULL;
973 while ((opt = av_opt_next(obj, opt))) {
974 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
977 /* Don't print CONST's on level one.
978 * Don't print anything but CONST's on level two.
979 * Only print items from the requested unit.
981 if (!unit && opt->type==AV_OPT_TYPE_CONST)
983 else if (unit && opt->type!=AV_OPT_TYPE_CONST)
985 else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
987 else if (unit && opt->type == AV_OPT_TYPE_CONST)
988 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
990 av_log(av_log_obj, AV_LOG_INFO, " %s%-17s ",
991 (opt->flags & AV_OPT_FLAG_FILTERING_PARAM) ? "" : "-",
995 case AV_OPT_TYPE_FLAGS:
996 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<flags>");
998 case AV_OPT_TYPE_INT:
999 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int>");
1001 case AV_OPT_TYPE_INT64:
1002 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int64>");
1004 case AV_OPT_TYPE_DOUBLE:
1005 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<double>");
1007 case AV_OPT_TYPE_FLOAT:
1008 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<float>");
1010 case AV_OPT_TYPE_STRING:
1011 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<string>");
1013 case AV_OPT_TYPE_RATIONAL:
1014 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<rational>");
1016 case AV_OPT_TYPE_BINARY:
1017 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<binary>");
1019 case AV_OPT_TYPE_IMAGE_SIZE:
1020 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<image_size>");
1022 case AV_OPT_TYPE_VIDEO_RATE:
1023 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<video_rate>");
1025 case AV_OPT_TYPE_PIXEL_FMT:
1026 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<pix_fmt>");
1028 case AV_OPT_TYPE_SAMPLE_FMT:
1029 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<sample_fmt>");
1031 case AV_OPT_TYPE_DURATION:
1032 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<duration>");
1034 case AV_OPT_TYPE_COLOR:
1035 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<color>");
1037 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1038 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<channel_layout>");
1040 case AV_OPT_TYPE_CONST:
1042 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "");
1045 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
1046 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
1047 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_FILTERING_PARAM)? 'F' : '.');
1048 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
1049 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
1050 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
1051 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_EXPORT) ? 'X' : '.');
1052 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_READONLY) ? 'R' : '.');
1055 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
1057 if (av_opt_query_ranges(&r, obj, opt->name, AV_OPT_SEARCH_FAKE_OBJ) >= 0) {
1058 switch (opt->type) {
1059 case AV_OPT_TYPE_INT:
1060 case AV_OPT_TYPE_INT64:
1061 case AV_OPT_TYPE_DOUBLE:
1062 case AV_OPT_TYPE_FLOAT:
1063 case AV_OPT_TYPE_RATIONAL:
1064 for (i = 0; i < r->nb_ranges; i++) {
1065 av_log(av_log_obj, AV_LOG_INFO, " (from ");
1066 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_min);
1067 av_log(av_log_obj, AV_LOG_INFO, " to ");
1068 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_max);
1069 av_log(av_log_obj, AV_LOG_INFO, ")");
1073 av_opt_freep_ranges(&r);
1076 if (opt->type != AV_OPT_TYPE_CONST &&
1077 opt->type != AV_OPT_TYPE_BINARY &&
1078 !((opt->type == AV_OPT_TYPE_COLOR ||
1079 opt->type == AV_OPT_TYPE_IMAGE_SIZE ||
1080 opt->type == AV_OPT_TYPE_STRING ||
1081 opt->type == AV_OPT_TYPE_VIDEO_RATE) &&
1082 !opt->default_val.str)) {
1083 av_log(av_log_obj, AV_LOG_INFO, " (default ");
1084 switch (opt->type) {
1085 case AV_OPT_TYPE_FLAGS:
1086 av_log(av_log_obj, AV_LOG_INFO, "%"PRIX64, opt->default_val.i64);
1088 case AV_OPT_TYPE_DURATION:
1089 case AV_OPT_TYPE_INT:
1090 case AV_OPT_TYPE_INT64:
1091 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.i64);
1093 case AV_OPT_TYPE_DOUBLE:
1094 case AV_OPT_TYPE_FLOAT:
1095 log_value(av_log_obj, AV_LOG_INFO, opt->default_val.dbl);
1097 case AV_OPT_TYPE_RATIONAL: {
1098 AVRational q = av_d2q(opt->default_val.dbl, INT_MAX);
1099 av_log(av_log_obj, AV_LOG_INFO, "%d/%d", q.num, q.den); }
1101 case AV_OPT_TYPE_PIXEL_FMT:
1102 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_pix_fmt_name(opt->default_val.i64), "none"));
1104 case AV_OPT_TYPE_SAMPLE_FMT:
1105 av_log(av_log_obj, AV_LOG_INFO, "%s", (char *)av_x_if_null(av_get_sample_fmt_name(opt->default_val.i64), "none"));
1107 case AV_OPT_TYPE_COLOR:
1108 case AV_OPT_TYPE_IMAGE_SIZE:
1109 case AV_OPT_TYPE_STRING:
1110 case AV_OPT_TYPE_VIDEO_RATE:
1111 av_log(av_log_obj, AV_LOG_INFO, "\"%s\"", opt->default_val.str);
1113 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1114 av_log(av_log_obj, AV_LOG_INFO, "0x%"PRIx64, opt->default_val.i64);
1117 av_log(av_log_obj, AV_LOG_INFO, ")");
1120 av_log(av_log_obj, AV_LOG_INFO, "\n");
1121 if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
1122 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
1127 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
1132 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
1134 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
1139 void av_opt_set_defaults(void *s)
1141 #if FF_API_OLD_AVOPTIONS
1142 av_opt_set_defaults2(s, 0, 0);
1145 void av_opt_set_defaults2(void *s, int mask, int flags)
1148 const AVClass *class = *(AVClass **)s;
1149 const AVOption *opt = NULL;
1150 while ((opt = av_opt_next(s, opt)) != NULL) {
1151 void *dst = ((uint8_t*)s) + opt->offset;
1152 #if FF_API_OLD_AVOPTIONS
1153 if ((opt->flags & mask) != flags)
1157 if (opt->flags & AV_OPT_FLAG_READONLY)
1160 switch (opt->type) {
1161 case AV_OPT_TYPE_CONST:
1162 /* Nothing to be done here */
1164 case AV_OPT_TYPE_FLAGS:
1165 case AV_OPT_TYPE_INT:
1166 case AV_OPT_TYPE_INT64:
1167 case AV_OPT_TYPE_DURATION:
1168 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1169 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1171 case AV_OPT_TYPE_DOUBLE:
1172 case AV_OPT_TYPE_FLOAT: {
1174 val = opt->default_val.dbl;
1175 write_number(s, opt, dst, val, 1, 1);
1178 case AV_OPT_TYPE_RATIONAL: {
1180 val = av_d2q(opt->default_val.dbl, INT_MAX);
1181 write_number(s, opt, dst, 1, val.den, val.num);
1184 case AV_OPT_TYPE_COLOR:
1185 set_string_color(s, opt, opt->default_val.str, dst);
1187 case AV_OPT_TYPE_STRING:
1188 set_string(s, opt, opt->default_val.str, dst);
1190 case AV_OPT_TYPE_IMAGE_SIZE:
1191 set_string_image_size(s, opt, opt->default_val.str, dst);
1193 case AV_OPT_TYPE_VIDEO_RATE:
1194 set_string_video_rate(s, opt, opt->default_val.str, dst);
1196 case AV_OPT_TYPE_PIXEL_FMT:
1197 #if LIBAVUTIL_VERSION_MAJOR < 54
1198 if (class->version && class->version < AV_VERSION_INT(52, 10, 100))
1199 av_opt_set(s, opt->name, opt->default_val.str, 0);
1202 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1204 case AV_OPT_TYPE_SAMPLE_FMT:
1205 #if LIBAVUTIL_VERSION_MAJOR < 54
1206 if (class->version && class->version < AV_VERSION_INT(52, 10, 100))
1207 av_opt_set(s, opt->name, opt->default_val.str, 0);
1210 write_number(s, opt, dst, 1, 1, opt->default_val.i64);
1212 case AV_OPT_TYPE_BINARY:
1213 /* Cannot set default for binary */
1216 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
1222 * Store the value in the field in ctx that is named like key.
1223 * ctx must be an AVClass context, storing is done using AVOptions.
1225 * @param buf the string to parse, buf will be updated to point at the
1226 * separator just after the parsed key/value pair
1227 * @param key_val_sep a 0-terminated list of characters used to
1228 * separate key from value
1229 * @param pairs_sep a 0-terminated list of characters used to separate
1230 * two pairs from each other
1231 * @return 0 if the key/value pair has been successfully parsed and
1232 * set, or a negative value corresponding to an AVERROR code in case
1234 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
1235 * the error code issued by av_opt_set() if the key/value pair
1238 static int parse_key_value_pair(void *ctx, const char **buf,
1239 const char *key_val_sep, const char *pairs_sep)
1241 char *key = av_get_token(buf, key_val_sep);
1246 return AVERROR(ENOMEM);
1248 if (*key && strspn(*buf, key_val_sep)) {
1250 val = av_get_token(buf, pairs_sep);
1253 return AVERROR(ENOMEM);
1256 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
1258 return AVERROR(EINVAL);
1261 av_log(ctx, AV_LOG_DEBUG, "Setting entry with key '%s' to value '%s'\n", key, val);
1263 ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
1264 if (ret == AVERROR_OPTION_NOT_FOUND)
1265 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
1272 int av_set_options_string(void *ctx, const char *opts,
1273 const char *key_val_sep, const char *pairs_sep)
1281 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
1292 #define WHITESPACES " \n\t"
1294 static int is_key_char(char c)
1296 return (unsigned)((c | 32) - 'a') < 26 ||
1297 (unsigned)(c - '0') < 10 ||
1298 c == '-' || c == '_' || c == '/' || c == '.';
1302 * Read a key from a string.
1304 * The key consists of is_key_char characters and must be terminated by a
1305 * character from the delim string; spaces are ignored.
1307 * @return 0 for success (even with ellipsis), <0 for failure
1309 static int get_key(const char **ropts, const char *delim, char **rkey)
1311 const char *opts = *ropts;
1312 const char *key_start, *key_end;
1314 key_start = opts += strspn(opts, WHITESPACES);
1315 while (is_key_char(*opts))
1318 opts += strspn(opts, WHITESPACES);
1319 if (!*opts || !strchr(delim, *opts))
1320 return AVERROR(EINVAL);
1322 if (!(*rkey = av_malloc(key_end - key_start + 1)))
1323 return AVERROR(ENOMEM);
1324 memcpy(*rkey, key_start, key_end - key_start);
1325 (*rkey)[key_end - key_start] = 0;
1330 int av_opt_get_key_value(const char **ropts,
1331 const char *key_val_sep, const char *pairs_sep,
1333 char **rkey, char **rval)
1336 char *key = NULL, *val;
1337 const char *opts = *ropts;
1339 if ((ret = get_key(&opts, key_val_sep, &key)) < 0 &&
1340 !(flags & AV_OPT_FLAG_IMPLICIT_KEY))
1341 return AVERROR(EINVAL);
1342 if (!(val = av_get_token(&opts, pairs_sep))) {
1344 return AVERROR(ENOMEM);
1352 int av_opt_set_from_string(void *ctx, const char *opts,
1353 const char *const *shorthand,
1354 const char *key_val_sep, const char *pairs_sep)
1357 const char *dummy_shorthand = NULL;
1358 char *av_uninit(parsed_key), *av_uninit(value);
1364 shorthand = &dummy_shorthand;
1367 ret = av_opt_get_key_value(&opts, key_val_sep, pairs_sep,
1368 *shorthand ? AV_OPT_FLAG_IMPLICIT_KEY : 0,
1369 &parsed_key, &value);
1371 if (ret == AVERROR(EINVAL))
1372 av_log(ctx, AV_LOG_ERROR, "No option name near '%s'\n", opts);
1374 av_log(ctx, AV_LOG_ERROR, "Unable to parse '%s': %s\n", opts,
1382 while (*shorthand) /* discard all remaining shorthand */
1385 key = *(shorthand++);
1388 av_log(ctx, AV_LOG_DEBUG, "Setting '%s' to value '%s'\n", key, value);
1389 if ((ret = av_opt_set(ctx, key, value, 0)) < 0) {
1390 if (ret == AVERROR_OPTION_NOT_FOUND)
1391 av_log(ctx, AV_LOG_ERROR, "Option '%s' not found\n", key);
1393 av_free(parsed_key);
1398 av_free(parsed_key);
1404 void av_opt_free(void *obj)
1406 const AVOption *o = NULL;
1407 while ((o = av_opt_next(obj, o)))
1408 if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
1409 av_freep((uint8_t *)obj + o->offset);
1412 int av_opt_set_dict(void *obj, AVDictionary **options)
1414 AVDictionaryEntry *t = NULL;
1415 AVDictionary *tmp = NULL;
1418 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
1419 ret = av_opt_set(obj, t->key, t->value, 0);
1420 if (ret == AVERROR_OPTION_NOT_FOUND)
1421 av_dict_set(&tmp, t->key, t->value, 0);
1423 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
1428 av_dict_free(options);
1433 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
1434 int opt_flags, int search_flags)
1436 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
1439 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
1440 int opt_flags, int search_flags, void **target_obj)
1443 const AVOption *o = NULL;
1453 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
1454 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
1455 const AVClass *child = NULL;
1456 while (child = av_opt_child_class_next(c, child))
1457 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
1461 while (child = av_opt_child_next(obj, child))
1462 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
1467 while (o = av_opt_next(obj, o)) {
1468 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
1469 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
1470 (unit && o->type == AV_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)))) {
1472 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
1483 void *av_opt_child_next(void *obj, void *prev)
1485 const AVClass *c = *(AVClass**)obj;
1487 return c->child_next(obj, prev);
1491 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
1493 if (parent->child_class_next)
1494 return parent->child_class_next(prev);
1498 void *av_opt_ptr(const AVClass *class, void *obj, const char *name)
1500 const AVOption *opt= av_opt_find2(&class, name, NULL, 0, AV_OPT_SEARCH_FAKE_OBJ, NULL);
1503 return (uint8_t*)obj + opt->offset;
1506 int av_opt_query_ranges(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1508 const AVClass *c = *(AVClass**)obj;
1509 int (*callback)(AVOptionRanges **, void *obj, const char *key, int flags) = NULL;
1511 if (c->version > (52 << 16 | 11 << 8))
1512 callback = c->query_ranges;
1515 callback = av_opt_query_ranges_default;
1517 return callback(ranges_arg, obj, key, flags);
1520 int av_opt_query_ranges_default(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1522 AVOptionRanges *ranges = av_mallocz(sizeof(*ranges));
1523 AVOptionRange **range_array = av_mallocz(sizeof(void*));
1524 AVOptionRange *range = av_mallocz(sizeof(*range));
1525 const AVOption *field = av_opt_find(obj, key, NULL, 0, flags);
1530 if (!ranges || !range || !range_array || !field) {
1531 ret = AVERROR(ENOMEM);
1535 ranges->range = range_array;
1536 ranges->range[0] = range;
1537 ranges->nb_ranges = 1;
1538 range->is_range = 1;
1539 range->value_min = field->min;
1540 range->value_max = field->max;
1542 switch (field->type) {
1543 case AV_OPT_TYPE_INT:
1544 case AV_OPT_TYPE_INT64:
1545 case AV_OPT_TYPE_PIXEL_FMT:
1546 case AV_OPT_TYPE_SAMPLE_FMT:
1547 case AV_OPT_TYPE_FLOAT:
1548 case AV_OPT_TYPE_DOUBLE:
1549 case AV_OPT_TYPE_DURATION:
1550 case AV_OPT_TYPE_COLOR:
1551 case AV_OPT_TYPE_CHANNEL_LAYOUT:
1553 case AV_OPT_TYPE_STRING:
1554 range->component_min = 0;
1555 range->component_max = 0x10FFFF; // max unicode value
1556 range->value_min = -1;
1557 range->value_max = INT_MAX;
1559 case AV_OPT_TYPE_RATIONAL:
1560 range->component_min = INT_MIN;
1561 range->component_max = INT_MAX;
1563 case AV_OPT_TYPE_IMAGE_SIZE:
1564 range->component_min = 0;
1565 range->component_max = INT_MAX/128/8;
1566 range->value_min = 0;
1567 range->value_max = INT_MAX/8;
1569 case AV_OPT_TYPE_VIDEO_RATE:
1570 range->component_min = 1;
1571 range->component_max = INT_MAX;
1572 range->value_min = 1;
1573 range->value_max = INT_MAX;
1576 ret = AVERROR(ENOSYS);
1580 *ranges_arg = ranges;
1585 av_free(range_array);
1589 void av_opt_freep_ranges(AVOptionRanges **rangesp)
1592 AVOptionRanges *ranges = *rangesp;
1594 for (i = 0; i < ranges->nb_ranges; i++) {
1595 AVOptionRange *range = ranges->range[i];
1596 av_freep(&range->str);
1597 av_freep(&ranges->range[i]);
1599 av_freep(&ranges->range);
1605 typedef struct TestContext
1607 const AVClass *class;
1612 AVRational rational;
1613 AVRational video_rate;
1615 enum AVPixelFormat pix_fmt;
1616 enum AVSampleFormat sample_fmt;
1619 int64_t channel_layout;
1622 #define OFFSET(x) offsetof(TestContext, x)
1624 #define TEST_FLAG_COOL 01
1625 #define TEST_FLAG_LAME 02
1626 #define TEST_FLAG_MU 04
1628 static const AVOption test_options[]= {
1629 {"num", "set num", OFFSET(num), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100 },
1630 {"toggle", "set toggle", OFFSET(toggle), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1 },
1631 {"rational", "set rational", OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0}, 0, 10 },
1632 {"string", "set string", OFFSET(string), AV_OPT_TYPE_STRING, {.str = "default"}, CHAR_MIN, CHAR_MAX },
1633 {"flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, INT_MAX, 0, "flags" },
1634 {"cool", "set cool flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
1635 {"lame", "set lame flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
1636 {"mu", "set mu flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
1637 {"size", "set size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,{0}, 0, 0 },
1638 {"pix_fmt", "set pixfmt", OFFSET(pix_fmt), AV_OPT_TYPE_PIXEL_FMT, {.i64 = AV_PIX_FMT_NONE}, -1, INT_MAX},
1639 {"sample_fmt", "set samplefmt", OFFSET(sample_fmt), AV_OPT_TYPE_SAMPLE_FMT, {.i64 = AV_SAMPLE_FMT_NONE}, -1, INT_MAX},
1640 {"video_rate", "set videorate", OFFSET(video_rate), AV_OPT_TYPE_VIDEO_RATE, {.str = "25"}, 0, 0 },
1641 {"duration", "set duration", OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX},
1642 {"color", "set color", OFFSET(color), AV_OPT_TYPE_COLOR, {.str = "pink"}, 0, 0},
1643 {"cl", "set channel layout", OFFSET(channel_layout), AV_OPT_TYPE_CHANNEL_LAYOUT, {.i64 = AV_CH_LAYOUT_HEXAGONAL}, 0, INT64_MAX},
1647 static const char *test_get_name(void *ctx)
1652 static const AVClass test_class = {
1662 printf("\nTesting av_set_options_string()\n");
1664 TestContext test_ctx = { 0 };
1665 static const char * const options[] = {
1681 "flags=+mu-lame : num=42: toggle=0",
1682 "num=42 : string=blahblah",
1683 "rational=0 : rational=1/2 : rational=1/-1",
1696 "video_rate=30000/1001",
1697 "video_rate=30/1.001",
1701 "duration=1\\:23\\:45.67",
1705 "cl=stereo+downmix",
1709 test_ctx.class = &test_class;
1710 av_opt_set_defaults(&test_ctx);
1712 av_log_set_level(AV_LOG_DEBUG);
1714 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1715 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1716 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
1717 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1720 av_opt_free(&test_ctx);
1723 printf("\nTesting av_opt_set_from_string()\n");
1725 TestContext test_ctx = { 0 };
1726 static const char * const options[] = {
1734 " 5 : hello : size = pal ",
1735 "a_very_long_option_name_that_will_need_to_be_ellipsized_around_here=42"
1737 static const char * const shorthand[] = { "num", "string", NULL };
1739 test_ctx.class = &test_class;
1740 av_opt_set_defaults(&test_ctx);
1742 av_log_set_level(AV_LOG_DEBUG);
1744 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1745 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1746 if (av_opt_set_from_string(&test_ctx, options[i], shorthand, "=", ":") < 0)
1747 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1750 av_opt_free(&test_ctx);