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>
35 #include "parseutils.h"
37 #include "mathematics.h"
38 #include "samplefmt.h"
43 //FIXME order them and do a bin search
44 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags)
46 const AVOption *o = NULL;
48 while ((o = av_next_option(v, o))) {
49 if (!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags)
56 #if FF_API_OLD_AVOPTIONS
57 const AVOption *av_next_option(void *obj, const AVOption *last)
59 return av_opt_next(obj, last);
63 const AVOption *av_opt_next(void *obj, const AVOption *last)
65 AVClass *class = *(AVClass**)obj;
66 if (!last && class->option && class->option[0].name)
68 if (last && last[1].name)
73 static int read_number(const AVOption *o, void *dst, double *num, int *den, int64_t *intnum)
76 case AV_OPT_TYPE_FLAGS: *intnum = *(unsigned int*)dst;return 0;
77 case AV_OPT_TYPE_PIXEL_FMT:
78 case AV_OPT_TYPE_SAMPLE_FMT:
79 case AV_OPT_TYPE_INT: *intnum = *(int *)dst;return 0;
80 case AV_OPT_TYPE_INT64: *intnum = *(int64_t *)dst;return 0;
81 case AV_OPT_TYPE_FLOAT: *num = *(float *)dst;return 0;
82 case AV_OPT_TYPE_DOUBLE: *num = *(double *)dst;return 0;
83 case AV_OPT_TYPE_RATIONAL: *intnum = ((AVRational*)dst)->num;
84 *den = ((AVRational*)dst)->den;
86 case AV_OPT_TYPE_CONST: *num = o->default_val.dbl; return 0;
88 return AVERROR(EINVAL);
91 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
93 if (o->max*den < num*intnum || o->min*den > num*intnum) {
94 av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range [%g - %g]\n",
95 num*intnum/den, o->name, o->min, o->max);
96 return AVERROR(ERANGE);
100 case AV_OPT_TYPE_FLAGS:
101 case AV_OPT_TYPE_PIXEL_FMT:
102 case AV_OPT_TYPE_SAMPLE_FMT:
103 case AV_OPT_TYPE_INT: *(int *)dst= llrint(num/den)*intnum; break;
104 case AV_OPT_TYPE_INT64: *(int64_t *)dst= llrint(num/den)*intnum; break;
105 case AV_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
106 case AV_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
107 case AV_OPT_TYPE_RATIONAL:
108 if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
109 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
112 return AVERROR(EINVAL);
117 static const double const_values[] = {
124 static const char * const const_names[] = {
131 static int hexchar2int(char c) {
132 if (c >= '0' && c <= '9') return c - '0';
133 if (c >= 'a' && c <= 'f') return c - 'a' + 10;
134 if (c >= 'A' && c <= 'F') return c - 'A' + 10;
138 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
140 int *lendst = (int *)(dst + 1);
142 int len = strlen(val);
148 return AVERROR(EINVAL);
151 ptr = bin = av_malloc(len);
153 int a = hexchar2int(*val++);
154 int b = hexchar2int(*val++);
155 if (a < 0 || b < 0) {
157 return AVERROR(EINVAL);
159 *ptr++ = (a << 4) | b;
167 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
170 *dst = av_strdup(val);
174 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
175 opt->type == AV_OPT_TYPE_CONST || \
176 opt->type == AV_OPT_TYPE_FLAGS || \
177 opt->type == AV_OPT_TYPE_INT) ? \
178 opt->default_val.i64 : opt->default_val.dbl)
180 static int set_string_number(void *obj, const AVOption *o, const char *val, void *dst)
182 int ret = 0, notfirst = 0;
191 if (*val == '+' || *val == '-') {
192 if (o->type == AV_OPT_TYPE_FLAGS)
198 for (; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
203 const AVOption *o_named = av_opt_find(obj, buf, o->unit, 0, 0);
204 if (o_named && o_named->type == AV_OPT_TYPE_CONST)
205 d = DEFAULT_NUMVAL(o_named);
206 else if (!strcmp(buf, "default")) d = DEFAULT_NUMVAL(o);
207 else if (!strcmp(buf, "max" )) d = o->max;
208 else if (!strcmp(buf, "min" )) d = o->min;
209 else if (!strcmp(buf, "none" )) d = 0;
210 else if (!strcmp(buf, "all" )) d = ~0;
212 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
214 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
219 if (o->type == AV_OPT_TYPE_FLAGS) {
220 read_number(o, dst, NULL, NULL, &intnum);
221 if (cmd == '+') d = intnum | (int64_t)d;
222 else if (cmd == '-') d = intnum &~(int64_t)d;
224 read_number(o, dst, &num, &den, &intnum);
225 if (cmd == '+') d = notfirst*num*intnum/den + d;
226 else if (cmd == '-') d = notfirst*num*intnum/den - d;
229 if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
240 #if FF_API_OLD_AVOPTIONS
241 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
243 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
246 return av_opt_set(obj, name, val, 0);
250 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
253 void *dst, *target_obj;
254 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
255 if (!o || !target_obj)
256 return AVERROR_OPTION_NOT_FOUND;
257 if (!val && (o->type != AV_OPT_TYPE_STRING &&
258 o->type != AV_OPT_TYPE_PIXEL_FMT && o->type != AV_OPT_TYPE_SAMPLE_FMT &&
259 o->type != AV_OPT_TYPE_IMAGE_SIZE))
260 return AVERROR(EINVAL);
262 dst = ((uint8_t*)target_obj) + o->offset;
264 case AV_OPT_TYPE_STRING: return set_string(obj, o, val, dst);
265 case AV_OPT_TYPE_BINARY: return set_string_binary(obj, o, val, dst);
266 case AV_OPT_TYPE_FLAGS:
267 case AV_OPT_TYPE_INT:
268 case AV_OPT_TYPE_INT64:
269 case AV_OPT_TYPE_FLOAT:
270 case AV_OPT_TYPE_DOUBLE:
271 case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, o, val, dst);
272 case AV_OPT_TYPE_IMAGE_SIZE:
273 if (!val || !strcmp(val, "none")) {
274 *(int *)dst = *((int *)dst + 1) = 0;
277 ret = av_parse_video_size(dst, ((int *)dst) + 1, val);
279 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as image size\n", val);
281 case AV_OPT_TYPE_PIXEL_FMT:
282 if (!val || !strcmp(val, "none")) {
283 ret = AV_PIX_FMT_NONE;
285 ret = av_get_pix_fmt(val);
286 if (ret == AV_PIX_FMT_NONE) {
288 ret = strtol(val, &tail, 0);
289 if (*tail || (unsigned)ret >= AV_PIX_FMT_NB) {
290 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as pixel format\n", val);
291 return AVERROR(EINVAL);
295 *(enum AVPixelFormat *)dst = ret;
297 case AV_OPT_TYPE_SAMPLE_FMT:
298 if (!val || !strcmp(val, "none")) {
299 ret = AV_SAMPLE_FMT_NONE;
301 ret = av_get_sample_fmt(val);
302 if (ret == AV_SAMPLE_FMT_NONE) {
304 ret = strtol(val, &tail, 0);
305 if (*tail || (unsigned)ret >= AV_SAMPLE_FMT_NB) {
306 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as sample format\n", val);
307 return AVERROR(EINVAL);
311 *(enum AVSampleFormat *)dst = ret;
315 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
316 return AVERROR(EINVAL);
319 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
320 int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
322 if (!o || o->type != opttype)\
323 return AVERROR(EINVAL);\
324 return set_string_number(obj, o, val, name ## _out);\
327 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
328 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
329 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
330 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
331 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
332 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
334 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
337 void *dst, *target_obj;
338 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
340 if (!o || !target_obj)
341 return AVERROR_OPTION_NOT_FOUND;
343 dst = ((uint8_t*)target_obj) + o->offset;
344 return write_number(obj, o, dst, num, den, intnum);
347 #if FF_API_OLD_AVOPTIONS
348 const AVOption *av_set_double(void *obj, const char *name, double n)
350 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
351 if (set_number(obj, name, n, 1, 1, 0) < 0)
356 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
358 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
359 if (set_number(obj, name, n.num, n.den, 1, 0) < 0)
364 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
366 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
367 if (set_number(obj, name, 1, 1, n, 0) < 0)
373 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
375 return set_number(obj, name, 1, 1, val, search_flags);
378 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
380 return set_number(obj, name, val, 1, 1, search_flags);
383 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
385 return set_number(obj, name, val.num, val.den, 1, search_flags);
388 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
391 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
396 if (!o || !target_obj)
397 return AVERROR_OPTION_NOT_FOUND;
399 if (o->type != AV_OPT_TYPE_BINARY)
400 return AVERROR(EINVAL);
402 ptr = av_malloc(len);
404 return AVERROR(ENOMEM);
406 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
407 lendst = (int *)(dst + 1);
412 memcpy(ptr, val, len);
417 int av_opt_set_image_size(void *obj, const char *name, int w, int h, int search_flags)
420 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
422 if (!o || !target_obj)
423 return AVERROR_OPTION_NOT_FOUND;
424 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
425 av_log(obj, AV_LOG_ERROR,
426 "The value set by option '%s' is not an image size.\n", o->name);
427 return AVERROR(EINVAL);
430 av_log(obj, AV_LOG_ERROR,
431 "Invalid negative size value %dx%d for size '%s'\n", w, h, o->name);
432 return AVERROR(EINVAL);
434 *(int *)(((uint8_t *)target_obj) + o->offset) = w;
435 *(int *)(((uint8_t *)target_obj+sizeof(int)) + o->offset) = h;
439 static int set_format(void *obj, const char *name, int fmt, int search_flags,
440 enum AVOptionType type, const char *desc, int nb_fmts)
443 const AVOption *o = av_opt_find2(obj, name, NULL, 0,
444 search_flags, &target_obj);
446 const AVClass *class = *(AVClass **)obj;
448 if (!o || !target_obj)
449 return AVERROR_OPTION_NOT_FOUND;
450 if (o->type != type) {
451 av_log(obj, AV_LOG_ERROR,
452 "The value set by option '%s' is not a %s format", name, desc);
453 return AVERROR(EINVAL);
456 #if LIBAVUTIL_VERSION_MAJOR < 53
457 if (class->version && class->version < AV_VERSION_INT(52, 11, 100)) {
463 min = FFMIN(o->min, -1);
464 max = FFMAX(o->max, nb_fmts-1);
466 if (fmt < min || fmt > max) {
467 av_log(obj, AV_LOG_ERROR,
468 "Value %d for parameter '%s' out of %s format range [%d - %d]\n",
469 fmt, name, desc, min, max);
470 return AVERROR(ERANGE);
472 *(int *)(((uint8_t *)target_obj) + o->offset) = fmt;
476 int av_opt_set_pixel_fmt(void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
478 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_PIXEL_FMT, "pixel", AV_PIX_FMT_NB);
481 int av_opt_set_sample_fmt(void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
483 return set_format(obj, name, fmt, search_flags, AV_OPT_TYPE_SAMPLE_FMT, "sample", AV_SAMPLE_FMT_NB);
486 #if FF_API_OLD_AVOPTIONS
489 * @param buf a buffer which is used for returning non string values as strings, can be NULL
490 * @param buf_len allocated length in bytes of buf
492 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
494 const AVOption *o = av_opt_find(obj, name, NULL, 0, AV_OPT_SEARCH_CHILDREN);
500 if (o->type != AV_OPT_TYPE_STRING && (!buf || !buf_len))
503 dst= ((uint8_t*)obj) + o->offset;
504 if (o_out) *o_out= o;
507 case AV_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
508 case AV_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
509 case AV_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
510 case AV_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
511 case AV_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
512 case AV_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
513 case AV_OPT_TYPE_CONST: snprintf(buf, buf_len, "%f" , o->default_val.dbl);break;
514 case AV_OPT_TYPE_STRING: return *(void**)dst;
515 case AV_OPT_TYPE_BINARY:
516 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
517 if (len >= (buf_len + 1)/2) return NULL;
518 bin = *(uint8_t**)dst;
519 for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
521 default: return NULL;
527 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
529 void *dst, *target_obj;
530 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
531 uint8_t *bin, buf[128];
534 if (!o || !target_obj || (o->offset<=0 && o->type != AV_OPT_TYPE_CONST))
535 return AVERROR_OPTION_NOT_FOUND;
537 dst = (uint8_t*)target_obj + o->offset;
541 case AV_OPT_TYPE_FLAGS: ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);break;
542 case AV_OPT_TYPE_INT: ret = snprintf(buf, sizeof(buf), "%d" , *(int *)dst);break;
543 case AV_OPT_TYPE_INT64: ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
544 case AV_OPT_TYPE_FLOAT: ret = snprintf(buf, sizeof(buf), "%f" , *(float *)dst);break;
545 case AV_OPT_TYPE_DOUBLE: ret = snprintf(buf, sizeof(buf), "%f" , *(double *)dst);break;
546 case AV_OPT_TYPE_RATIONAL: ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
547 case AV_OPT_TYPE_CONST: ret = snprintf(buf, sizeof(buf), "%f" , o->default_val.dbl);break;
548 case AV_OPT_TYPE_STRING:
550 *out_val = av_strdup(*(uint8_t**)dst);
552 *out_val = av_strdup("");
554 case AV_OPT_TYPE_BINARY:
555 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
556 if ((uint64_t)len*2 + 1 > INT_MAX)
557 return AVERROR(EINVAL);
558 if (!(*out_val = av_malloc(len*2 + 1)))
559 return AVERROR(ENOMEM);
560 bin = *(uint8_t**)dst;
561 for (i = 0; i < len; i++)
562 snprintf(*out_val + i*2, 3, "%02X", bin[i]);
564 case AV_OPT_TYPE_IMAGE_SIZE:
565 ret = snprintf(buf, sizeof(buf), "%dx%d", ((int *)dst)[0], ((int *)dst)[1]);
567 case AV_OPT_TYPE_PIXEL_FMT:
568 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_pix_fmt_name(*(enum AVPixelFormat *)dst), "none"));
570 case AV_OPT_TYPE_SAMPLE_FMT:
571 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_sample_fmt_name(*(enum AVSampleFormat *)dst), "none"));
574 return AVERROR(EINVAL);
577 if (ret >= sizeof(buf))
578 return AVERROR(EINVAL);
579 *out_val = av_strdup(buf);
583 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum,
586 void *dst, *target_obj;
587 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
588 if (!o || !target_obj)
591 dst = ((uint8_t*)target_obj) + o->offset;
593 if (o_out) *o_out= o;
595 return read_number(o, dst, num, den, intnum);
602 #if FF_API_OLD_AVOPTIONS
603 double av_get_double(void *obj, const char *name, const AVOption **o_out)
609 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
611 return num*intnum/den;
614 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
620 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
621 return (AVRational){0, 0};
622 if (num == 1.0 && (int)intnum == intnum)
623 return (AVRational){intnum, den};
625 return av_d2q(num*intnum/den, 1<<24);
628 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
634 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
636 return num*intnum/den;
640 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
646 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
648 *out_val = num*intnum/den;
652 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
658 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
660 *out_val = num*intnum/den;
664 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
670 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
673 if (num == 1.0 && (int)intnum == intnum)
674 *out_val = (AVRational){intnum, den};
676 *out_val = av_d2q(num*intnum/den, 1<<24);
680 int av_opt_get_image_size(void *obj, const char *name, int search_flags, int *w_out, int *h_out)
682 void *dst, *target_obj;
683 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
684 if (!o || !target_obj)
685 return AVERROR_OPTION_NOT_FOUND;
686 if (o->type != AV_OPT_TYPE_IMAGE_SIZE) {
687 av_log(obj, AV_LOG_ERROR,
688 "The value for option '%s' is not an image size.\n", name);
689 return AVERROR(EINVAL);
692 dst = ((uint8_t*)target_obj) + o->offset;
693 if (w_out) *w_out = *(int *)dst;
694 if (h_out) *h_out = *((int *)dst+1);
698 static int get_format(void *obj, const char *name, int search_flags, int *out_fmt,
699 enum AVOptionType type, const char *desc)
701 void *dst, *target_obj;
702 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
703 if (!o || !target_obj)
704 return AVERROR_OPTION_NOT_FOUND;
705 if (o->type != type) {
706 av_log(obj, AV_LOG_ERROR,
707 "The value for option '%s' is not a %s format.\n", desc, name);
708 return AVERROR(EINVAL);
711 dst = ((uint8_t*)target_obj) + o->offset;
712 *out_fmt = *(int *)dst;
716 int av_opt_get_pixel_fmt(void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
718 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_PIXEL_FMT, "pixel");
721 int av_opt_get_sample_fmt(void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
723 return get_format(obj, name, search_flags, out_fmt, AV_OPT_TYPE_SAMPLE_FMT, "sample");
726 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
728 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
729 const AVOption *flag = av_opt_find(obj, flag_name,
730 field ? field->unit : NULL, 0, 0);
733 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
734 av_opt_get_int(obj, field_name, 0, &res) < 0)
736 return res & flag->default_val.i64;
739 static void log_value(void *av_log_obj, int level, double d)
742 av_log(av_log_obj, level, "INT_MAX");
743 } else if (d == INT_MIN) {
744 av_log(av_log_obj, level, "INT_MIN");
745 } else if (d == (double)INT64_MAX) {
746 av_log(av_log_obj, level, "I64_MAX");
747 } else if (d == INT64_MIN) {
748 av_log(av_log_obj, level, "I64_MIN");
749 } else if (d == FLT_MAX) {
750 av_log(av_log_obj, level, "FLT_MAX");
751 } else if (d == FLT_MIN) {
752 av_log(av_log_obj, level, "FLT_MIN");
754 av_log(av_log_obj, level, "%g", d);
758 static void opt_list(void *obj, void *av_log_obj, const char *unit,
759 int req_flags, int rej_flags)
761 const AVOption *opt=NULL;
765 while ((opt = av_opt_next(obj, opt))) {
766 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
769 /* Don't print CONST's on level one.
770 * Don't print anything but CONST's on level two.
771 * Only print items from the requested unit.
773 if (!unit && opt->type==AV_OPT_TYPE_CONST)
775 else if (unit && opt->type!=AV_OPT_TYPE_CONST)
777 else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
779 else if (unit && opt->type == AV_OPT_TYPE_CONST)
780 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
782 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
785 case AV_OPT_TYPE_FLAGS:
786 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<flags>");
788 case AV_OPT_TYPE_INT:
789 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int>");
791 case AV_OPT_TYPE_INT64:
792 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<int64>");
794 case AV_OPT_TYPE_DOUBLE:
795 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<double>");
797 case AV_OPT_TYPE_FLOAT:
798 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<float>");
800 case AV_OPT_TYPE_STRING:
801 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<string>");
803 case AV_OPT_TYPE_RATIONAL:
804 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<rational>");
806 case AV_OPT_TYPE_BINARY:
807 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<binary>");
809 case AV_OPT_TYPE_IMAGE_SIZE:
810 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<image_size>");
812 case AV_OPT_TYPE_PIXEL_FMT:
813 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<pix_fmt>");
815 case AV_OPT_TYPE_SAMPLE_FMT:
816 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "<sample_fmt>");
818 case AV_OPT_TYPE_CONST:
820 av_log(av_log_obj, AV_LOG_INFO, "%-12s ", "");
823 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
824 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
825 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_FILTERING_PARAM)? 'F' : '.');
826 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
827 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
828 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
831 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
833 if (av_opt_query_ranges(&r, obj, opt->name, AV_OPT_SEARCH_FAKE_OBJ) >= 0) {
835 case AV_OPT_TYPE_INT:
836 case AV_OPT_TYPE_INT64:
837 case AV_OPT_TYPE_DOUBLE:
838 case AV_OPT_TYPE_FLOAT:
839 case AV_OPT_TYPE_RATIONAL:
840 for (i = 0; i < r->nb_ranges; i++) {
841 av_log(av_log_obj, AV_LOG_INFO, " (from ");
842 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_min);
843 av_log(av_log_obj, AV_LOG_INFO, " to ");
844 log_value(av_log_obj, AV_LOG_INFO, r->range[i]->value_max);
845 av_log(av_log_obj, AV_LOG_INFO, ")");
849 av_opt_freep_ranges(&r);
852 av_log(av_log_obj, AV_LOG_INFO, "\n");
853 if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
854 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
859 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
864 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
866 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
871 void av_opt_set_defaults(void *s)
873 #if FF_API_OLD_AVOPTIONS
874 av_opt_set_defaults2(s, 0, 0);
877 void av_opt_set_defaults2(void *s, int mask, int flags)
880 const AVClass *class = *(AVClass **)s;
881 const AVOption *opt = NULL;
882 while ((opt = av_opt_next(s, opt)) != NULL) {
883 #if FF_API_OLD_AVOPTIONS
884 if ((opt->flags & mask) != flags)
888 case AV_OPT_TYPE_CONST:
889 /* Nothing to be done here */
891 case AV_OPT_TYPE_FLAGS:
892 case AV_OPT_TYPE_INT:
893 case AV_OPT_TYPE_INT64:
894 av_opt_set_int(s, opt->name, opt->default_val.i64, 0);
896 case AV_OPT_TYPE_DOUBLE:
897 case AV_OPT_TYPE_FLOAT: {
899 val = opt->default_val.dbl;
900 av_opt_set_double(s, opt->name, val, 0);
903 case AV_OPT_TYPE_RATIONAL: {
905 val = av_d2q(opt->default_val.dbl, INT_MAX);
906 av_opt_set_q(s, opt->name, val, 0);
909 case AV_OPT_TYPE_STRING:
910 case AV_OPT_TYPE_IMAGE_SIZE:
911 av_opt_set(s, opt->name, opt->default_val.str, 0);
913 case AV_OPT_TYPE_PIXEL_FMT:
914 #if LIBAVUTIL_VERSION_MAJOR < 53
915 if (class->version && class->version < AV_VERSION_INT(52, 10, 100))
916 av_opt_set(s, opt->name, opt->default_val.str, 0);
919 av_opt_set_pixel_fmt(s, opt->name, opt->default_val.i64, 0);
921 case AV_OPT_TYPE_SAMPLE_FMT:
922 #if LIBAVUTIL_VERSION_MAJOR < 53
923 if (class->version && class->version < AV_VERSION_INT(52, 10, 100))
924 av_opt_set(s, opt->name, opt->default_val.str, 0);
927 av_opt_set_sample_fmt(s, opt->name, opt->default_val.i64, 0);
929 case AV_OPT_TYPE_BINARY:
930 /* Cannot set default for binary */
933 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
939 * Store the value in the field in ctx that is named like key.
940 * ctx must be an AVClass context, storing is done using AVOptions.
942 * @param buf the string to parse, buf will be updated to point at the
943 * separator just after the parsed key/value pair
944 * @param key_val_sep a 0-terminated list of characters used to
945 * separate key from value
946 * @param pairs_sep a 0-terminated list of characters used to separate
947 * two pairs from each other
948 * @return 0 if the key/value pair has been successfully parsed and
949 * set, or a negative value corresponding to an AVERROR code in case
951 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
952 * the error code issued by av_opt_set() if the key/value pair
955 static int parse_key_value_pair(void *ctx, const char **buf,
956 const char *key_val_sep, const char *pairs_sep)
958 char *key = av_get_token(buf, key_val_sep);
962 if (*key && strspn(*buf, key_val_sep)) {
964 val = av_get_token(buf, pairs_sep);
966 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
968 return AVERROR(EINVAL);
971 av_log(ctx, AV_LOG_DEBUG, "Setting entry with key '%s' to value '%s'\n", key, val);
973 ret = av_opt_set(ctx, key, val, 0);
974 if (ret == AVERROR_OPTION_NOT_FOUND)
975 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
982 int av_set_options_string(void *ctx, const char *opts,
983 const char *key_val_sep, const char *pairs_sep)
991 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
1002 #define WHITESPACES " \n\t"
1004 static int is_key_char(char c)
1006 return (unsigned)((c | 32) - 'a') < 26 ||
1007 (unsigned)(c - '0') < 10 ||
1008 c == '-' || c == '_' || c == '/' || c == '.';
1012 * Read a key from a string.
1014 * The key consists of is_key_char characters and must be terminated by a
1015 * character from the delim string; spaces are ignored.
1017 * @return 0 for success (even with ellipsis), <0 for failure
1019 static int get_key(const char **ropts, const char *delim, char **rkey)
1021 const char *opts = *ropts;
1022 const char *key_start, *key_end;
1024 key_start = opts += strspn(opts, WHITESPACES);
1025 while (is_key_char(*opts))
1028 opts += strspn(opts, WHITESPACES);
1029 if (!*opts || !strchr(delim, *opts))
1030 return AVERROR(EINVAL);
1032 if (!(*rkey = av_malloc(key_end - key_start + 1)))
1033 return AVERROR(ENOMEM);
1034 memcpy(*rkey, key_start, key_end - key_start);
1035 (*rkey)[key_end - key_start] = 0;
1040 int av_opt_get_key_value(const char **ropts,
1041 const char *key_val_sep, const char *pairs_sep,
1043 char **rkey, char **rval)
1046 char *key = NULL, *val;
1047 const char *opts = *ropts;
1049 if ((ret = get_key(&opts, key_val_sep, &key)) < 0 &&
1050 !(flags & AV_OPT_FLAG_IMPLICIT_KEY))
1051 return AVERROR(EINVAL);
1052 if (!(val = av_get_token(&opts, pairs_sep))) {
1054 return AVERROR(ENOMEM);
1062 int av_opt_set_from_string(void *ctx, const char *opts,
1063 const char *const *shorthand,
1064 const char *key_val_sep, const char *pairs_sep)
1067 const char *dummy_shorthand = NULL;
1068 char *av_uninit(parsed_key), *av_uninit(value);
1074 shorthand = &dummy_shorthand;
1077 ret = av_opt_get_key_value(&opts, key_val_sep, pairs_sep,
1078 *shorthand ? AV_OPT_FLAG_IMPLICIT_KEY : 0,
1079 &parsed_key, &value);
1081 if (ret == AVERROR(EINVAL))
1082 av_log(ctx, AV_LOG_ERROR, "No option name near '%s'\n", opts);
1084 av_log(ctx, AV_LOG_ERROR, "Unable to parse '%s': %s\n", opts,
1092 while (*shorthand) /* discard all remaining shorthand */
1095 key = *(shorthand++);
1098 av_log(ctx, AV_LOG_DEBUG, "Setting '%s' to value '%s'\n", key, value);
1099 if ((ret = av_opt_set(ctx, key, value, 0)) < 0) {
1100 if (ret == AVERROR_OPTION_NOT_FOUND)
1101 av_log(ctx, AV_LOG_ERROR, "Option '%s' not found\n", key);
1103 av_free(parsed_key);
1108 av_free(parsed_key);
1114 void av_opt_free(void *obj)
1116 const AVOption *o = NULL;
1117 while ((o = av_opt_next(obj, o)))
1118 if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
1119 av_freep((uint8_t *)obj + o->offset);
1122 int av_opt_set_dict(void *obj, AVDictionary **options)
1124 AVDictionaryEntry *t = NULL;
1125 AVDictionary *tmp = NULL;
1128 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
1129 ret = av_opt_set(obj, t->key, t->value, 0);
1130 if (ret == AVERROR_OPTION_NOT_FOUND)
1131 av_dict_set(&tmp, t->key, t->value, 0);
1133 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
1138 av_dict_free(options);
1143 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
1144 int opt_flags, int search_flags)
1146 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
1149 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
1150 int opt_flags, int search_flags, void **target_obj)
1153 const AVOption *o = NULL;
1160 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
1161 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
1162 const AVClass *child = NULL;
1163 while (child = av_opt_child_class_next(c, child))
1164 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
1168 while (child = av_opt_child_next(obj, child))
1169 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
1174 while (o = av_opt_next(obj, o)) {
1175 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
1176 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
1177 (unit && o->type == AV_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)))) {
1179 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
1190 void *av_opt_child_next(void *obj, void *prev)
1192 const AVClass *c = *(AVClass**)obj;
1194 return c->child_next(obj, prev);
1198 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
1200 if (parent->child_class_next)
1201 return parent->child_class_next(prev);
1205 void *av_opt_ptr(const AVClass *class, void *obj, const char *name)
1207 const AVOption *opt= av_opt_find2(&class, name, NULL, 0, AV_OPT_SEARCH_FAKE_OBJ, NULL);
1210 return (uint8_t*)obj + opt->offset;
1213 int av_opt_query_ranges(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1215 const AVClass *c = *(AVClass**)obj;
1216 int (*callback)(AVOptionRanges **, void *obj, const char *key, int flags) = NULL;
1218 if (c->version > (52 << 16 | 11 << 8))
1219 callback = c->query_ranges;
1222 callback = av_opt_query_ranges_default;
1224 return callback(ranges_arg, obj, key, flags);
1227 int av_opt_query_ranges_default(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
1229 AVOptionRanges *ranges = av_mallocz(sizeof(*ranges));
1230 AVOptionRange **range_array = av_mallocz(sizeof(void*));
1231 AVOptionRange *range = av_mallocz(sizeof(*range));
1232 const AVOption *field = av_opt_find(obj, key, NULL, 0, flags);
1237 if (!ranges || !range || !range_array || !field) {
1238 ret = AVERROR(ENOMEM);
1242 ranges->range = range_array;
1243 ranges->range[0] = range;
1244 ranges->nb_ranges = 1;
1245 range->is_range = 1;
1246 range->value_min = field->min;
1247 range->value_max = field->max;
1249 switch (field->type) {
1250 case AV_OPT_TYPE_INT:
1251 case AV_OPT_TYPE_INT64:
1252 case AV_OPT_TYPE_PIXEL_FMT:
1253 case AV_OPT_TYPE_SAMPLE_FMT:
1254 case AV_OPT_TYPE_FLOAT:
1255 case AV_OPT_TYPE_DOUBLE:
1257 case AV_OPT_TYPE_STRING:
1258 range->component_min = 0;
1259 range->component_max = 0x10FFFF; // max unicode value
1260 range->value_min = -1;
1261 range->value_max = INT_MAX;
1263 case AV_OPT_TYPE_RATIONAL:
1264 range->component_min = INT_MIN;
1265 range->component_max = INT_MAX;
1267 case AV_OPT_TYPE_IMAGE_SIZE:
1268 range->component_min = 0;
1269 range->component_max = INT_MAX/128/8;
1270 range->value_min = 0;
1271 range->value_max = INT_MAX/8;
1274 ret = AVERROR(ENOSYS);
1278 *ranges_arg = ranges;
1283 av_free(range_array);
1287 void av_opt_freep_ranges(AVOptionRanges **rangesp)
1290 AVOptionRanges *ranges = *rangesp;
1292 for (i = 0; i < ranges->nb_ranges; i++) {
1293 AVOptionRange *range = ranges->range[i];
1294 av_freep(&range->str);
1295 av_freep(&ranges->range[i]);
1297 av_freep(&ranges->range);
1303 typedef struct TestContext
1305 const AVClass *class;
1310 AVRational rational;
1312 enum AVPixelFormat pix_fmt;
1313 enum AVSampleFormat sample_fmt;
1316 #define OFFSET(x) offsetof(TestContext, x)
1318 #define TEST_FLAG_COOL 01
1319 #define TEST_FLAG_LAME 02
1320 #define TEST_FLAG_MU 04
1322 static const AVOption test_options[]= {
1323 {"num", "set num", OFFSET(num), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100 },
1324 {"toggle", "set toggle", OFFSET(toggle), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1 },
1325 {"rational", "set rational", OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0}, 0, 10 },
1326 {"string", "set string", OFFSET(string), AV_OPT_TYPE_STRING, {0}, CHAR_MIN, CHAR_MAX },
1327 {"flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, INT_MAX, 0, "flags" },
1328 {"cool", "set cool flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
1329 {"lame", "set lame flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
1330 {"mu", "set mu flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
1331 {"size", "set size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,{0}, 0, 0 },
1332 {"pix_fmt", "set pixfmt", OFFSET(pix_fmt), AV_OPT_TYPE_PIXEL_FMT, {.i64 = AV_PIX_FMT_NONE}, -1, AV_PIX_FMT_NB-1},
1333 {"sample_fmt", "set samplefmt", OFFSET(sample_fmt), AV_OPT_TYPE_SAMPLE_FMT, {.i64 = AV_SAMPLE_FMT_NONE}, -1, AV_SAMPLE_FMT_NB-1},
1337 static const char *test_get_name(void *ctx)
1342 static const AVClass test_class = {
1352 printf("\nTesting av_set_options_string()\n");
1354 TestContext test_ctx = { 0 };
1355 const char *options[] = {
1371 "flags=+mu-lame : num=42: toggle=0",
1372 "num=42 : string=blahblah",
1373 "rational=0 : rational=1/2 : rational=1/-1",
1386 test_ctx.class = &test_class;
1387 av_opt_set_defaults(&test_ctx);
1388 test_ctx.string = av_strdup("default");
1390 av_log_set_level(AV_LOG_DEBUG);
1392 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1393 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1394 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
1395 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1398 av_freep(&test_ctx.string);
1401 printf("\nTesting av_opt_set_from_string()\n");
1403 TestContext test_ctx = { 0 };
1404 const char *options[] = {
1412 " 5 : hello : size = pal ",
1413 "a_very_long_option_name_that_will_need_to_be_ellipsized_around_here=42"
1415 const char *shorthand[] = { "num", "string", NULL };
1417 test_ctx.class = &test_class;
1418 av_opt_set_defaults(&test_ctx);
1419 test_ctx.string = av_strdup("default");
1421 av_log_set_level(AV_LOG_DEBUG);
1423 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1424 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1425 if (av_opt_set_from_string(&test_ctx, options[i], shorthand, "=", ":") < 0)
1426 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1429 av_freep(&test_ctx.string);