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"
41 //FIXME order them and do a bin search
42 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags)
44 const AVOption *o = NULL;
46 while ((o = av_next_option(v, o))) {
47 if (!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags)
54 #if FF_API_OLD_AVOPTIONS
55 const AVOption *av_next_option(void *obj, const AVOption *last)
57 return av_opt_next(obj, last);
61 const AVOption *av_opt_next(void *obj, const AVOption *last)
63 AVClass *class = *(AVClass**)obj;
64 if (!last && class->option && class->option[0].name)
66 if (last && last[1].name) return ++last;
70 static int read_number(const AVOption *o, void *dst, double *num, int *den, int64_t *intnum)
73 case AV_OPT_TYPE_FLAGS: *intnum = *(unsigned int*)dst;return 0;
74 case AV_OPT_TYPE_INT: *intnum = *(int *)dst;return 0;
75 case AV_OPT_TYPE_INT64: *intnum = *(int64_t *)dst;return 0;
76 case AV_OPT_TYPE_FLOAT: *num = *(float *)dst;return 0;
77 case AV_OPT_TYPE_DOUBLE: *num = *(double *)dst;return 0;
78 case AV_OPT_TYPE_RATIONAL: *intnum = ((AVRational*)dst)->num;
79 *den = ((AVRational*)dst)->den;
81 case AV_OPT_TYPE_CONST: *num = o->default_val.dbl; return 0;
83 return AVERROR(EINVAL);
86 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
88 if (o->max*den < num*intnum || o->min*den > num*intnum) {
89 av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range [%g - %g]\n",
90 num*intnum/den, o->name, o->min, o->max);
91 return AVERROR(ERANGE);
95 case AV_OPT_TYPE_FLAGS:
96 case AV_OPT_TYPE_INT: *(int *)dst= llrint(num/den)*intnum; break;
97 case AV_OPT_TYPE_INT64: *(int64_t *)dst= llrint(num/den)*intnum; break;
98 case AV_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
99 case AV_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
100 case AV_OPT_TYPE_RATIONAL:
101 if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
102 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
105 return AVERROR(EINVAL);
110 static const double const_values[] = {
117 static const char * const const_names[] = {
124 static int hexchar2int(char c) {
125 if (c >= '0' && c <= '9') return c - '0';
126 if (c >= 'a' && c <= 'f') return c - 'a' + 10;
127 if (c >= 'A' && c <= 'F') return c - 'A' + 10;
131 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
133 int *lendst = (int *)(dst + 1);
135 int len = strlen(val);
141 return AVERROR(EINVAL);
144 ptr = bin = av_malloc(len);
146 int a = hexchar2int(*val++);
147 int b = hexchar2int(*val++);
148 if (a < 0 || b < 0) {
150 return AVERROR(EINVAL);
152 *ptr++ = (a << 4) | b;
160 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
163 *dst = av_strdup(val);
167 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
168 opt->type == AV_OPT_TYPE_CONST || \
169 opt->type == AV_OPT_TYPE_FLAGS || \
170 opt->type == AV_OPT_TYPE_INT) ? \
171 opt->default_val.i64 : opt->default_val.dbl)
173 static int set_string_number(void *obj, const AVOption *o, const char *val, void *dst)
175 int ret = 0, notfirst = 0;
183 if (*val == '+' || *val == '-')
186 for (i = 0; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
191 const AVOption *o_named = av_opt_find(obj, buf, o->unit, 0, 0);
192 if (o_named && o_named->type == AV_OPT_TYPE_CONST)
193 d = DEFAULT_NUMVAL(o_named);
194 else if (!strcmp(buf, "default")) d = DEFAULT_NUMVAL(o);
195 else if (!strcmp(buf, "max" )) d = o->max;
196 else if (!strcmp(buf, "min" )) d = o->min;
197 else if (!strcmp(buf, "none" )) d = 0;
198 else if (!strcmp(buf, "all" )) d = ~0;
200 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
202 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
207 if (o->type == AV_OPT_TYPE_FLAGS) {
208 read_number(o, dst, NULL, NULL, &intnum);
209 if (cmd == '+') d = intnum | (int64_t)d;
210 else if (cmd == '-') d = intnum &~(int64_t)d;
212 read_number(o, dst, &num, &den, &intnum);
213 if (cmd == '+') d = notfirst*num*intnum/den + d;
214 else if (cmd == '-') d = notfirst*num*intnum/den - d;
217 if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
228 #if FF_API_OLD_AVOPTIONS
229 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
231 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
234 return av_opt_set(obj, name, val, 0);
238 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
241 void *dst, *target_obj;
242 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
243 if (!o || !target_obj)
244 return AVERROR_OPTION_NOT_FOUND;
245 if (!val && (o->type != AV_OPT_TYPE_STRING &&
246 o->type != AV_OPT_TYPE_PIXEL_FMT && o->type != AV_OPT_TYPE_SAMPLE_FMT &&
247 o->type != AV_OPT_TYPE_IMAGE_SIZE))
248 return AVERROR(EINVAL);
250 dst = ((uint8_t*)target_obj) + o->offset;
252 case AV_OPT_TYPE_STRING: return set_string(obj, o, val, dst);
253 case AV_OPT_TYPE_BINARY: return set_string_binary(obj, o, val, dst);
254 case AV_OPT_TYPE_FLAGS:
255 case AV_OPT_TYPE_INT:
256 case AV_OPT_TYPE_INT64:
257 case AV_OPT_TYPE_FLOAT:
258 case AV_OPT_TYPE_DOUBLE:
259 case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, o, val, dst);
260 case AV_OPT_TYPE_IMAGE_SIZE:
261 if (!val || !strcmp(val, "none")) {
262 *(int *)dst = *((int *)dst + 1) = 0;
265 ret = av_parse_video_size(dst, ((int *)dst) + 1, val);
267 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as image size\n", val);
269 case AV_OPT_TYPE_PIXEL_FMT:
270 if (!val || !strcmp(val, "none")) {
271 ret = AV_PIX_FMT_NONE;
273 ret = av_get_pix_fmt(val);
274 if (ret == AV_PIX_FMT_NONE) {
276 ret = strtol(val, &tail, 0);
277 if (*tail || (unsigned)ret >= AV_PIX_FMT_NB) {
278 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as pixel format\n", val);
279 return AVERROR(EINVAL);
283 *(enum AVPixelFormat *)dst = ret;
285 case AV_OPT_TYPE_SAMPLE_FMT:
286 if (!val || !strcmp(val, "none")) {
287 ret = AV_SAMPLE_FMT_NONE;
289 ret = av_get_sample_fmt(val);
290 if (ret == AV_SAMPLE_FMT_NONE) {
292 ret = strtol(val, &tail, 0);
293 if (*tail || (unsigned)ret >= AV_SAMPLE_FMT_NB) {
294 av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\" as sample format\n", val);
295 return AVERROR(EINVAL);
299 *(enum AVSampleFormat *)dst = ret;
303 av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
304 return AVERROR(EINVAL);
307 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
308 int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
310 if (!o || o->type != opttype)\
311 return AVERROR(EINVAL);\
312 return set_string_number(obj, o, val, name ## _out);\
315 OPT_EVAL_NUMBER(flags, AV_OPT_TYPE_FLAGS, int)
316 OPT_EVAL_NUMBER(int, AV_OPT_TYPE_INT, int)
317 OPT_EVAL_NUMBER(int64, AV_OPT_TYPE_INT64, int64_t)
318 OPT_EVAL_NUMBER(float, AV_OPT_TYPE_FLOAT, float)
319 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE, double)
320 OPT_EVAL_NUMBER(q, AV_OPT_TYPE_RATIONAL, AVRational)
322 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
325 void *dst, *target_obj;
326 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
328 if (!o || !target_obj)
329 return AVERROR_OPTION_NOT_FOUND;
331 dst = ((uint8_t*)target_obj) + o->offset;
332 return write_number(obj, o, dst, num, den, intnum);
335 #if FF_API_OLD_AVOPTIONS
336 const AVOption *av_set_double(void *obj, const char *name, double n)
338 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
339 if (set_number(obj, name, n, 1, 1, 0) < 0)
344 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
346 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
347 if (set_number(obj, name, n.num, n.den, 1, 0) < 0)
352 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
354 const AVOption *o = av_opt_find(obj, name, NULL, 0, 0);
355 if (set_number(obj, name, 1, 1, n, 0) < 0)
361 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
363 return set_number(obj, name, 1, 1, val, search_flags);
366 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
368 return set_number(obj, name, val, 1, 1, search_flags);
371 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
373 return set_number(obj, name, val.num, val.den, 1, search_flags);
376 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
379 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
384 if (!o || !target_obj)
385 return AVERROR_OPTION_NOT_FOUND;
387 if (o->type != AV_OPT_TYPE_BINARY)
388 return AVERROR(EINVAL);
390 ptr = av_malloc(len);
392 return AVERROR(ENOMEM);
394 dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
395 lendst = (int *)(dst + 1);
400 memcpy(ptr, val, len);
405 #if FF_API_OLD_AVOPTIONS
408 * @param buf a buffer which is used for returning non string values as strings, can be NULL
409 * @param buf_len allocated length in bytes of buf
411 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
413 const AVOption *o = av_opt_find(obj, name, NULL, 0, AV_OPT_SEARCH_CHILDREN);
419 if (o->type != AV_OPT_TYPE_STRING && (!buf || !buf_len))
422 dst= ((uint8_t*)obj) + o->offset;
423 if (o_out) *o_out= o;
426 case AV_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
427 case AV_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
428 case AV_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
429 case AV_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
430 case AV_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
431 case AV_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
432 case AV_OPT_TYPE_CONST: snprintf(buf, buf_len, "%f" , o->default_val.dbl);break;
433 case AV_OPT_TYPE_STRING: return *(void**)dst;
434 case AV_OPT_TYPE_BINARY:
435 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
436 if (len >= (buf_len + 1)/2) return NULL;
437 bin = *(uint8_t**)dst;
438 for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
440 default: return NULL;
446 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
448 void *dst, *target_obj;
449 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
450 uint8_t *bin, buf[128];
453 if (!o || !target_obj || (o->offset<=0 && o->type != AV_OPT_TYPE_CONST))
454 return AVERROR_OPTION_NOT_FOUND;
456 dst = (uint8_t*)target_obj + o->offset;
460 case AV_OPT_TYPE_FLAGS: ret = snprintf(buf, sizeof(buf), "0x%08X", *(int *)dst);break;
461 case AV_OPT_TYPE_INT: ret = snprintf(buf, sizeof(buf), "%d" , *(int *)dst);break;
462 case AV_OPT_TYPE_INT64: ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
463 case AV_OPT_TYPE_FLOAT: ret = snprintf(buf, sizeof(buf), "%f" , *(float *)dst);break;
464 case AV_OPT_TYPE_DOUBLE: ret = snprintf(buf, sizeof(buf), "%f" , *(double *)dst);break;
465 case AV_OPT_TYPE_RATIONAL: ret = snprintf(buf, sizeof(buf), "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
466 case AV_OPT_TYPE_CONST: ret = snprintf(buf, sizeof(buf), "%f" , o->default_val.dbl);break;
467 case AV_OPT_TYPE_STRING:
469 *out_val = av_strdup(*(uint8_t**)dst);
471 *out_val = av_strdup("");
473 case AV_OPT_TYPE_BINARY:
474 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
475 if ((uint64_t)len*2 + 1 > INT_MAX)
476 return AVERROR(EINVAL);
477 if (!(*out_val = av_malloc(len*2 + 1)))
478 return AVERROR(ENOMEM);
479 bin = *(uint8_t**)dst;
480 for (i = 0; i < len; i++)
481 snprintf(*out_val + i*2, 3, "%02X", bin[i]);
483 case AV_OPT_TYPE_IMAGE_SIZE:
484 ret = snprintf(buf, sizeof(buf), "%dx%d", ((int *)dst)[0], ((int *)dst)[1]);
486 case AV_OPT_TYPE_PIXEL_FMT:
487 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_pix_fmt_name(*(enum AVPixelFormat *)dst), "none"));
489 case AV_OPT_TYPE_SAMPLE_FMT:
490 ret = snprintf(buf, sizeof(buf), "%s", (char *)av_x_if_null(av_get_sample_fmt_name(*(enum AVSampleFormat *)dst), "none"));
493 return AVERROR(EINVAL);
496 if (ret >= sizeof(buf))
497 return AVERROR(EINVAL);
498 *out_val = av_strdup(buf);
502 static int get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum,
505 void *dst, *target_obj;
506 const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
507 if (!o || !target_obj)
510 dst = ((uint8_t*)target_obj) + o->offset;
512 if (o_out) *o_out= o;
514 return read_number(o, dst, num, den, intnum);
521 #if FF_API_OLD_AVOPTIONS
522 double av_get_double(void *obj, const char *name, const AVOption **o_out)
528 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
530 return num*intnum/den;
533 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
539 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
540 return (AVRational){0, 0};
541 if (num == 1.0 && (int)intnum == intnum)
542 return (AVRational){intnum, den};
544 return av_d2q(num*intnum/den, 1<<24);
547 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
553 if (get_number(obj, name, o_out, &num, &den, &intnum, 0) < 0)
555 return num*intnum/den;
559 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
565 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
567 *out_val = num*intnum/den;
571 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
577 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
579 *out_val = num*intnum/den;
583 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
589 if ((ret = get_number(obj, name, NULL, &num, &den, &intnum, search_flags)) < 0)
592 if (num == 1.0 && (int)intnum == intnum)
593 *out_val = (AVRational){intnum, den};
595 *out_val = av_d2q(num*intnum/den, 1<<24);
599 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
601 const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
602 const AVOption *flag = av_opt_find(obj, flag_name,
603 field ? field->unit : NULL, 0, 0);
606 if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
607 av_opt_get_int(obj, field_name, 0, &res) < 0)
609 return res & flag->default_val.i64;
612 static void opt_list(void *obj, void *av_log_obj, const char *unit,
613 int req_flags, int rej_flags)
615 const AVOption *opt=NULL;
617 while ((opt = av_opt_next(obj, opt))) {
618 if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
621 /* Don't print CONST's on level one.
622 * Don't print anything but CONST's on level two.
623 * Only print items from the requested unit.
625 if (!unit && opt->type==AV_OPT_TYPE_CONST)
627 else if (unit && opt->type!=AV_OPT_TYPE_CONST)
629 else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
631 else if (unit && opt->type == AV_OPT_TYPE_CONST)
632 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
634 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
637 case AV_OPT_TYPE_FLAGS:
638 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
640 case AV_OPT_TYPE_INT:
641 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
643 case AV_OPT_TYPE_INT64:
644 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
646 case AV_OPT_TYPE_DOUBLE:
647 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
649 case AV_OPT_TYPE_FLOAT:
650 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
652 case AV_OPT_TYPE_STRING:
653 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
655 case AV_OPT_TYPE_RATIONAL:
656 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
658 case AV_OPT_TYPE_BINARY:
659 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
661 case AV_OPT_TYPE_IMAGE_SIZE:
662 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<image_size>");
664 case AV_OPT_TYPE_PIXEL_FMT:
665 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<pix_fmt>");
667 case AV_OPT_TYPE_SAMPLE_FMT:
668 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<sample_fmt>");
670 case AV_OPT_TYPE_CONST:
672 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
675 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
676 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
677 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_FILTERING_PARAM)? 'F' : '.');
678 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
679 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
680 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
683 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
684 av_log(av_log_obj, AV_LOG_INFO, "\n");
685 if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
686 opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
691 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
696 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
698 opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
703 void av_opt_set_defaults(void *s)
705 #if FF_API_OLD_AVOPTIONS
706 av_opt_set_defaults2(s, 0, 0);
709 void av_opt_set_defaults2(void *s, int mask, int flags)
712 const AVOption *opt = NULL;
713 while ((opt = av_opt_next(s, opt)) != NULL) {
714 #if FF_API_OLD_AVOPTIONS
715 if ((opt->flags & mask) != flags)
719 case AV_OPT_TYPE_CONST:
720 /* Nothing to be done here */
722 case AV_OPT_TYPE_FLAGS:
723 case AV_OPT_TYPE_INT:
724 case AV_OPT_TYPE_INT64:
725 av_opt_set_int(s, opt->name, opt->default_val.i64, 0);
727 case AV_OPT_TYPE_DOUBLE:
728 case AV_OPT_TYPE_FLOAT: {
730 val = opt->default_val.dbl;
731 av_opt_set_double(s, opt->name, val, 0);
734 case AV_OPT_TYPE_RATIONAL: {
736 val = av_d2q(opt->default_val.dbl, INT_MAX);
737 av_opt_set_q(s, opt->name, val, 0);
740 case AV_OPT_TYPE_STRING:
741 case AV_OPT_TYPE_IMAGE_SIZE:
742 case AV_OPT_TYPE_PIXEL_FMT:
743 case AV_OPT_TYPE_SAMPLE_FMT:
744 av_opt_set(s, opt->name, opt->default_val.str, 0);
746 case AV_OPT_TYPE_BINARY:
747 /* Cannot set default for binary */
750 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
756 * Store the value in the field in ctx that is named like key.
757 * ctx must be an AVClass context, storing is done using AVOptions.
759 * @param buf the string to parse, buf will be updated to point at the
760 * separator just after the parsed key/value pair
761 * @param key_val_sep a 0-terminated list of characters used to
762 * separate key from value
763 * @param pairs_sep a 0-terminated list of characters used to separate
764 * two pairs from each other
765 * @return 0 if the key/value pair has been successfully parsed and
766 * set, or a negative value corresponding to an AVERROR code in case
768 * AVERROR(EINVAL) if the key/value pair cannot be parsed,
769 * the error code issued by av_opt_set() if the key/value pair
772 static int parse_key_value_pair(void *ctx, const char **buf,
773 const char *key_val_sep, const char *pairs_sep)
775 char *key = av_get_token(buf, key_val_sep);
779 if (*key && strspn(*buf, key_val_sep)) {
781 val = av_get_token(buf, pairs_sep);
783 av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
785 return AVERROR(EINVAL);
788 av_log(ctx, AV_LOG_DEBUG, "Setting entry with key '%s' to value '%s'\n", key, val);
790 ret = av_opt_set(ctx, key, val, 0);
791 if (ret == AVERROR_OPTION_NOT_FOUND)
792 av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
799 int av_set_options_string(void *ctx, const char *opts,
800 const char *key_val_sep, const char *pairs_sep)
808 if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
819 #define WHITESPACES " \n\t"
821 static int is_key_char(char c)
823 return (unsigned)((c | 32) - 'a') < 26 ||
824 (unsigned)(c - '0') < 10 ||
825 c == '-' || c == '_' || c == '/' || c == '.';
829 * Read a key from a string.
831 * The key consists of is_key_char characters and must be terminated by a
832 * character from the delim string; spaces are ignored.
834 * @return 0 for success (even with ellipsis), <0 for failure
836 static int get_key(const char **ropts, const char *delim, char **rkey)
838 const char *opts = *ropts;
839 const char *key_start, *key_end;
841 key_start = opts += strspn(opts, WHITESPACES);
842 while (is_key_char(*opts))
845 opts += strspn(opts, WHITESPACES);
846 if (!*opts || !strchr(delim, *opts))
847 return AVERROR(EINVAL);
849 if (!(*rkey = av_malloc(key_end - key_start + 1)))
850 return AVERROR(ENOMEM);
851 memcpy(*rkey, key_start, key_end - key_start);
852 (*rkey)[key_end - key_start] = 0;
857 int av_opt_get_key_value(const char **ropts,
858 const char *key_val_sep, const char *pairs_sep,
860 char **rkey, char **rval)
863 char *key = NULL, *val;
864 const char *opts = *ropts;
866 if ((ret = get_key(&opts, key_val_sep, &key)) < 0 &&
867 !(flags & AV_OPT_FLAG_IMPLICIT_KEY))
868 return AVERROR(EINVAL);
869 if (!(val = av_get_token(&opts, pairs_sep))) {
871 return AVERROR(ENOMEM);
879 int av_opt_set_from_string(void *ctx, const char *opts,
880 const char *const *shorthand,
881 const char *key_val_sep, const char *pairs_sep)
884 const char *dummy_shorthand = NULL;
885 char *av_uninit(parsed_key), *av_uninit(value);
891 shorthand = &dummy_shorthand;
894 ret = av_opt_get_key_value(&opts, key_val_sep, pairs_sep,
895 *shorthand ? AV_OPT_FLAG_IMPLICIT_KEY : 0,
896 &parsed_key, &value);
898 if (ret == AVERROR(EINVAL))
899 av_log(ctx, AV_LOG_ERROR, "No option name near '%s'\n", opts);
901 av_log(ctx, AV_LOG_ERROR, "Unable to parse '%s': %s\n", opts,
909 while (*shorthand) /* discard all remaining shorthand */
912 key = *(shorthand++);
915 av_log(ctx, AV_LOG_DEBUG, "Setting '%s' to value '%s'\n", key, value);
916 if ((ret = av_opt_set(ctx, key, value, 0)) < 0) {
917 if (ret == AVERROR_OPTION_NOT_FOUND)
918 av_log(ctx, AV_LOG_ERROR, "Option '%s' not found\n", key);
931 void av_opt_free(void *obj)
933 const AVOption *o = NULL;
934 while ((o = av_opt_next(obj, o)))
935 if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
936 av_freep((uint8_t *)obj + o->offset);
939 int av_opt_set_dict(void *obj, AVDictionary **options)
941 AVDictionaryEntry *t = NULL;
942 AVDictionary *tmp = NULL;
945 while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
946 ret = av_opt_set(obj, t->key, t->value, 0);
947 if (ret == AVERROR_OPTION_NOT_FOUND)
948 av_dict_set(&tmp, t->key, t->value, 0);
950 av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
955 av_dict_free(options);
960 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
961 int opt_flags, int search_flags)
963 return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
966 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
967 int opt_flags, int search_flags, void **target_obj)
970 const AVOption *o = NULL;
977 if (search_flags & AV_OPT_SEARCH_CHILDREN) {
978 if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
979 const AVClass *child = NULL;
980 while (child = av_opt_child_class_next(c, child))
981 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
985 while (child = av_opt_child_next(obj, child))
986 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
991 while (o = av_opt_next(obj, o)) {
992 if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
993 ((!unit && o->type != AV_OPT_TYPE_CONST) ||
994 (unit && o->type == AV_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)))) {
996 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
1007 void *av_opt_child_next(void *obj, void *prev)
1009 const AVClass *c = *(AVClass**)obj;
1011 return c->child_next(obj, prev);
1015 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
1017 if (parent->child_class_next)
1018 return parent->child_class_next(prev);
1022 void *av_opt_ptr(const AVClass *class, void *obj, const char *name)
1024 const AVOption *opt= av_opt_find2(&class, name, NULL, 0, AV_OPT_SEARCH_FAKE_OBJ, NULL);
1027 return (uint8_t*)obj + opt->offset;
1034 typedef struct TestContext
1036 const AVClass *class;
1041 AVRational rational;
1043 enum AVPixelFormat pix_fmt;
1044 enum AVSampleFormat sample_fmt;
1047 #define OFFSET(x) offsetof(TestContext, x)
1049 #define TEST_FLAG_COOL 01
1050 #define TEST_FLAG_LAME 02
1051 #define TEST_FLAG_MU 04
1053 static const AVOption test_options[]= {
1054 {"num", "set num", OFFSET(num), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 100 },
1055 {"toggle", "set toggle", OFFSET(toggle), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1 },
1056 {"rational", "set rational", OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0}, 0, 10 },
1057 {"string", "set string", OFFSET(string), AV_OPT_TYPE_STRING, {0}, CHAR_MIN, CHAR_MAX },
1058 {"flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, INT_MAX, 0, "flags" },
1059 {"cool", "set cool flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_COOL}, INT_MIN, INT_MAX, 0, "flags" },
1060 {"lame", "set lame flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_LAME}, INT_MIN, INT_MAX, 0, "flags" },
1061 {"mu", "set mu flag ", 0, AV_OPT_TYPE_CONST, {.i64 = TEST_FLAG_MU}, INT_MIN, INT_MAX, 0, "flags" },
1062 {"size", "set size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,{0}, 0, 0 },
1063 {"pix_fmt", "set pixfmt", OFFSET(pix_fmt), AV_OPT_TYPE_PIXEL_FMT,{0}, 0, 0 },
1064 {"sample_fmt", "set samplefmt", OFFSET(sample_fmt), AV_OPT_TYPE_SAMPLE_FMT,{0}, 0, 0 },
1068 static const char *test_get_name(void *ctx)
1073 static const AVClass test_class = {
1083 printf("\nTesting av_set_options_string()\n");
1085 TestContext test_ctx = { 0 };
1086 const char *options[] = {
1102 "flags=+mu-lame : num=42: toggle=0",
1103 "num=42 : string=blahblah",
1104 "rational=0 : rational=1/2 : rational=1/-1",
1117 test_ctx.class = &test_class;
1118 av_opt_set_defaults(&test_ctx);
1119 test_ctx.string = av_strdup("default");
1121 av_log_set_level(AV_LOG_DEBUG);
1123 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1124 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1125 if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
1126 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1129 av_freep(&test_ctx.string);
1132 printf("\nTesting av_opt_set_from_string()\n");
1134 TestContext test_ctx = { 0 };
1135 const char *options[] = {
1143 " 5 : hello : size = pal ",
1144 "a_very_long_option_name_that_will_need_to_be_ellipsized_around_here=42"
1146 const char *shorthand[] = { "num", "string", NULL };
1148 test_ctx.class = &test_class;
1149 av_opt_set_defaults(&test_ctx);
1150 test_ctx.string = av_strdup("default");
1152 av_log_set_level(AV_LOG_DEBUG);
1154 for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
1155 av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
1156 if (av_opt_set_from_string(&test_ctx, options[i], shorthand, "=", ":") < 0)
1157 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
1160 av_freep(&test_ctx.string);