]> git.sesse.net Git - ffmpeg/blob - libavutil/opt.c
opt: check the return values of av_get_token for ENOMEM.
[ffmpeg] / libavutil / opt.c
1 /*
2  * AVOptions
3  * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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.
11  *
12  * Libav 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.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * AVOptions
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include "avutil.h"
29 #include "avstring.h"
30 #include "common.h"
31 #include "opt.h"
32 #include "eval.h"
33 #include "dict.h"
34 #include "log.h"
35 #include "mathematics.h"
36
37 const AVOption *av_opt_next(void *obj, const AVOption *last)
38 {
39     AVClass *class = *(AVClass**)obj;
40     if (!last && class->option && class->option[0].name)
41         return class->option;
42     if (last && last[1].name)
43         return ++last;
44     return NULL;
45 }
46
47 static int read_number(const AVOption *o, void *dst, double *num, int *den, int64_t *intnum)
48 {
49     switch (o->type) {
50     case AV_OPT_TYPE_FLAGS:     *intnum = *(unsigned int*)dst;return 0;
51     case AV_OPT_TYPE_INT:       *intnum = *(int         *)dst;return 0;
52     case AV_OPT_TYPE_INT64:     *intnum = *(int64_t     *)dst;return 0;
53     case AV_OPT_TYPE_FLOAT:     *num    = *(float       *)dst;return 0;
54     case AV_OPT_TYPE_DOUBLE:    *num    = *(double      *)dst;return 0;
55     case AV_OPT_TYPE_RATIONAL:  *intnum = ((AVRational*)dst)->num;
56                                 *den    = ((AVRational*)dst)->den;
57                                                         return 0;
58     }
59     return AVERROR(EINVAL);
60 }
61
62 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
63 {
64     if (o->max*den < num*intnum || o->min*den > num*intnum) {
65         av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range\n",
66                num*intnum/den, o->name);
67         return AVERROR(ERANGE);
68     }
69
70     switch (o->type) {
71     case AV_OPT_TYPE_FLAGS:
72     case AV_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
73     case AV_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
74     case AV_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
75     case AV_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
76     case AV_OPT_TYPE_RATIONAL:
77         if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
78         else                 *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
79         break;
80     default:
81         return AVERROR(EINVAL);
82     }
83     return 0;
84 }
85
86 static const double const_values[] = {
87     M_PI,
88     M_E,
89     FF_QP2LAMBDA,
90     0
91 };
92
93 static const char * const const_names[] = {
94     "PI",
95     "E",
96     "QP2LAMBDA",
97     0
98 };
99
100 static int hexchar2int(char c) {
101     if (c >= '0' && c <= '9') return c - '0';
102     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
103     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
104     return -1;
105 }
106
107 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
108 {
109     int *lendst = (int *)(dst + 1);
110     uint8_t *bin, *ptr;
111     int len = strlen(val);
112
113     av_freep(dst);
114     *lendst = 0;
115
116     if (len & 1)
117         return AVERROR(EINVAL);
118     len /= 2;
119
120     ptr = bin = av_malloc(len);
121     while (*val) {
122         int a = hexchar2int(*val++);
123         int b = hexchar2int(*val++);
124         if (a < 0 || b < 0) {
125             av_free(bin);
126             return AVERROR(EINVAL);
127         }
128         *ptr++ = (a << 4) | b;
129     }
130     *dst = bin;
131     *lendst = len;
132
133     return 0;
134 }
135
136 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
137 {
138     av_freep(dst);
139     *dst = av_strdup(val);
140     return 0;
141 }
142
143 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
144                               opt->type == AV_OPT_TYPE_CONST || \
145                               opt->type == AV_OPT_TYPE_FLAGS || \
146                               opt->type == AV_OPT_TYPE_INT) ? \
147                              opt->default_val.i64 : opt->default_val.dbl)
148
149 static int set_string_number(void *obj, void *target_obj, const AVOption *o, const char *val, void *dst)
150 {
151     int ret = 0, notfirst = 0;
152     for (;;) {
153         int i, den = 1;
154         char buf[256];
155         int cmd = 0;
156         double d, num = 1;
157         int64_t intnum = 1;
158
159         i = 0;
160         if (*val == '+' || *val == '-') {
161             if (o->type == AV_OPT_TYPE_FLAGS)
162                 cmd = *(val++);
163             else if (!notfirst)
164                 buf[i++] = *val;
165         }
166
167         for (; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
168             buf[i] = val[i];
169         buf[i] = 0;
170
171         {
172             const AVOption *o_named = av_opt_find(target_obj, buf, o->unit, 0, 0);
173             if (o_named && o_named->type == AV_OPT_TYPE_CONST)
174                 d = DEFAULT_NUMVAL(o_named);
175             else if (!strcmp(buf, "default")) d = DEFAULT_NUMVAL(o);
176             else if (!strcmp(buf, "max"    )) d = o->max;
177             else if (!strcmp(buf, "min"    )) d = o->min;
178             else if (!strcmp(buf, "none"   )) d = 0;
179             else if (!strcmp(buf, "all"    )) d = ~0;
180             else {
181                 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
182                 if (res < 0) {
183                     av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
184                     return res;
185                 }
186             }
187         }
188         if (o->type == AV_OPT_TYPE_FLAGS) {
189             read_number(o, dst, NULL, NULL, &intnum);
190             if      (cmd == '+') d = intnum | (int64_t)d;
191             else if (cmd == '-') d = intnum &~(int64_t)d;
192         } else {
193             read_number(o, dst, &num, &den, &intnum);
194             if      (cmd == '+') d = notfirst*num*intnum/den + d;
195             else if (cmd == '-') d = notfirst*num*intnum/den - d;
196         }
197
198         if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
199             return ret;
200         val += i;
201         if (!*val)
202             return 0;
203         notfirst = 1;
204     }
205
206     return 0;
207 }
208
209 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
210 {
211     void *dst, *target_obj;
212     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
213     if (!o || !target_obj)
214         return AVERROR_OPTION_NOT_FOUND;
215     if (!val)
216         return AVERROR(EINVAL);
217
218     dst = ((uint8_t*)target_obj) + o->offset;
219     switch (o->type) {
220     case AV_OPT_TYPE_STRING:   return set_string(obj, o, val, dst);
221     case AV_OPT_TYPE_BINARY:   return set_string_binary(obj, o, val, dst);
222     case AV_OPT_TYPE_FLAGS:
223     case AV_OPT_TYPE_INT:
224     case AV_OPT_TYPE_INT64:
225     case AV_OPT_TYPE_FLOAT:
226     case AV_OPT_TYPE_DOUBLE:
227     case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, target_obj, o, val, dst);
228     }
229
230     av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
231     return AVERROR(EINVAL);
232 }
233
234 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
235     int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
236     {\
237         if (!o || o->type != opttype)\
238             return AVERROR(EINVAL);\
239         return set_string_number(obj, obj, o, val, name ## _out);\
240     }
241
242 OPT_EVAL_NUMBER(flags,  AV_OPT_TYPE_FLAGS,    int)
243 OPT_EVAL_NUMBER(int,    AV_OPT_TYPE_INT,      int)
244 OPT_EVAL_NUMBER(int64,  AV_OPT_TYPE_INT64,    int64_t)
245 OPT_EVAL_NUMBER(float,  AV_OPT_TYPE_FLOAT,    float)
246 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE,   double)
247 OPT_EVAL_NUMBER(q,      AV_OPT_TYPE_RATIONAL, AVRational)
248
249 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
250                                   int search_flags)
251 {
252     void *dst, *target_obj;
253     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
254
255     if (!o || !target_obj)
256         return AVERROR_OPTION_NOT_FOUND;
257
258     dst = ((uint8_t*)target_obj) + o->offset;
259     return write_number(obj, o, dst, num, den, intnum);
260 }
261
262 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
263 {
264     return set_number(obj, name, 1, 1, val, search_flags);
265 }
266
267 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
268 {
269     return set_number(obj, name, val, 1, 1, search_flags);
270 }
271
272 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
273 {
274     return set_number(obj, name, val.num, val.den, 1, search_flags);
275 }
276
277 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
278 {
279     void *target_obj;
280     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
281     uint8_t *ptr;
282     uint8_t **dst;
283     int *lendst;
284
285     if (!o || !target_obj)
286         return AVERROR_OPTION_NOT_FOUND;
287
288     if (o->type != AV_OPT_TYPE_BINARY)
289         return AVERROR(EINVAL);
290
291     ptr = av_malloc(len);
292     if (!ptr)
293         return AVERROR(ENOMEM);
294
295     dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
296     lendst = (int *)(dst + 1);
297
298     av_free(*dst);
299     *dst = ptr;
300     *lendst = len;
301     memcpy(ptr, val, len);
302
303     return 0;
304 }
305
306 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
307 {
308     void *dst, *target_obj;
309     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
310     uint8_t *bin, buf[128];
311     int len, i, ret;
312
313     if (!o || !target_obj)
314         return AVERROR_OPTION_NOT_FOUND;
315
316     dst = (uint8_t*)target_obj + o->offset;
317
318     buf[0] = 0;
319     switch (o->type) {
320     case AV_OPT_TYPE_FLAGS:     ret = snprintf(buf, sizeof(buf), "0x%08X",  *(int    *)dst);break;
321     case AV_OPT_TYPE_INT:       ret = snprintf(buf, sizeof(buf), "%d" ,     *(int    *)dst);break;
322     case AV_OPT_TYPE_INT64:     ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
323     case AV_OPT_TYPE_FLOAT:     ret = snprintf(buf, sizeof(buf), "%f" ,     *(float  *)dst);break;
324     case AV_OPT_TYPE_DOUBLE:    ret = snprintf(buf, sizeof(buf), "%f" ,     *(double *)dst);break;
325     case AV_OPT_TYPE_RATIONAL:  ret = snprintf(buf, sizeof(buf), "%d/%d",   ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
326     case AV_OPT_TYPE_STRING:
327         if (*(uint8_t**)dst)
328             *out_val = av_strdup(*(uint8_t**)dst);
329         else
330             *out_val = av_strdup("");
331         return 0;
332     case AV_OPT_TYPE_BINARY:
333         len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
334         if ((uint64_t)len*2 + 1 > INT_MAX)
335             return AVERROR(EINVAL);
336         if (!(*out_val = av_malloc(len*2 + 1)))
337             return AVERROR(ENOMEM);
338         bin = *(uint8_t**)dst;
339         for (i = 0; i < len; i++)
340             snprintf(*out_val + i*2, 3, "%02X", bin[i]);
341         return 0;
342     default:
343         return AVERROR(EINVAL);
344     }
345
346     if (ret >= sizeof(buf))
347         return AVERROR(EINVAL);
348     *out_val = av_strdup(buf);
349     return 0;
350 }
351
352 static int get_number(void *obj, const char *name, double *num, int *den, int64_t *intnum,
353                       int search_flags)
354 {
355     void *dst, *target_obj;
356     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
357     if (!o || !target_obj)
358         goto error;
359
360     dst = ((uint8_t*)target_obj) + o->offset;
361
362     return read_number(o, dst, num, den, intnum);
363
364 error:
365     *den=*intnum=0;
366     return -1;
367 }
368
369 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
370 {
371     int64_t intnum = 1;
372     double     num = 1;
373     int   ret, den = 1;
374
375     if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
376         return ret;
377     *out_val = num*intnum/den;
378     return 0;
379 }
380
381 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
382 {
383     int64_t intnum = 1;
384     double     num = 1;
385     int   ret, den = 1;
386
387     if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
388         return ret;
389     *out_val = num*intnum/den;
390     return 0;
391 }
392
393 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
394 {
395     int64_t intnum = 1;
396     double     num = 1;
397     int   ret, den = 1;
398
399     if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
400         return ret;
401
402     if (num == 1.0 && (int)intnum == intnum)
403         *out_val = (AVRational){intnum, den};
404     else
405         *out_val = av_d2q(num*intnum/den, 1<<24);
406     return 0;
407 }
408
409 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
410 {
411     const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
412     const AVOption *flag  = av_opt_find(obj, flag_name,
413                                         field ? field->unit : NULL, 0, 0);
414     int64_t res;
415
416     if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
417         av_opt_get_int(obj, field_name, 0, &res) < 0)
418         return 0;
419     return res & flag->default_val.i64;
420 }
421
422 static void opt_list(void *obj, void *av_log_obj, const char *unit,
423                      int req_flags, int rej_flags)
424 {
425     const AVOption *opt=NULL;
426
427     while ((opt = av_opt_next(obj, opt))) {
428         if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
429             continue;
430
431         /* Don't print CONST's on level one.
432          * Don't print anything but CONST's on level two.
433          * Only print items from the requested unit.
434          */
435         if (!unit && opt->type==AV_OPT_TYPE_CONST)
436             continue;
437         else if (unit && opt->type!=AV_OPT_TYPE_CONST)
438             continue;
439         else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
440             continue;
441         else if (unit && opt->type == AV_OPT_TYPE_CONST)
442             av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
443         else
444             av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
445
446         switch (opt->type) {
447             case AV_OPT_TYPE_FLAGS:
448                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
449                 break;
450             case AV_OPT_TYPE_INT:
451                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
452                 break;
453             case AV_OPT_TYPE_INT64:
454                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
455                 break;
456             case AV_OPT_TYPE_DOUBLE:
457                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
458                 break;
459             case AV_OPT_TYPE_FLOAT:
460                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
461                 break;
462             case AV_OPT_TYPE_STRING:
463                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
464                 break;
465             case AV_OPT_TYPE_RATIONAL:
466                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
467                 break;
468             case AV_OPT_TYPE_BINARY:
469                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
470                 break;
471             case AV_OPT_TYPE_CONST:
472             default:
473                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
474                 break;
475         }
476         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
477         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
478         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
479         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
480         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
481
482         if (opt->help)
483             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
484         av_log(av_log_obj, AV_LOG_INFO, "\n");
485         if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
486             opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
487         }
488     }
489 }
490
491 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
492 {
493     if (!obj)
494         return -1;
495
496     av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
497
498     opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
499
500     return 0;
501 }
502
503 void av_opt_set_defaults(void *s)
504 {
505     const AVOption *opt = NULL;
506     while ((opt = av_opt_next(s, opt)) != NULL) {
507         switch (opt->type) {
508             case AV_OPT_TYPE_CONST:
509                 /* Nothing to be done here */
510             break;
511             case AV_OPT_TYPE_FLAGS:
512             case AV_OPT_TYPE_INT:
513             case AV_OPT_TYPE_INT64:
514                 av_opt_set_int(s, opt->name, opt->default_val.i64, 0);
515             break;
516             case AV_OPT_TYPE_DOUBLE:
517             case AV_OPT_TYPE_FLOAT: {
518                 double val;
519                 val = opt->default_val.dbl;
520                 av_opt_set_double(s, opt->name, val, 0);
521             }
522             break;
523             case AV_OPT_TYPE_RATIONAL: {
524                 AVRational val;
525                 val = av_d2q(opt->default_val.dbl, INT_MAX);
526                 av_opt_set_q(s, opt->name, val, 0);
527             }
528             break;
529             case AV_OPT_TYPE_STRING:
530                 av_opt_set(s, opt->name, opt->default_val.str, 0);
531                 break;
532             case AV_OPT_TYPE_BINARY:
533                 /* Cannot set default for binary */
534             break;
535             default:
536                 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
537         }
538     }
539 }
540
541 /**
542  * Store the value in the field in ctx that is named like key.
543  * ctx must be an AVClass context, storing is done using AVOptions.
544  *
545  * @param buf the string to parse, buf will be updated to point at the
546  * separator just after the parsed key/value pair
547  * @param key_val_sep a 0-terminated list of characters used to
548  * separate key from value
549  * @param pairs_sep a 0-terminated list of characters used to separate
550  * two pairs from each other
551  * @return 0 if the key/value pair has been successfully parsed and
552  * set, or a negative value corresponding to an AVERROR code in case
553  * of error:
554  * AVERROR(EINVAL) if the key/value pair cannot be parsed,
555  * the error code issued by av_opt_set() if the key/value pair
556  * cannot be set
557  */
558 static int parse_key_value_pair(void *ctx, const char **buf,
559                                 const char *key_val_sep, const char *pairs_sep)
560 {
561     char *key = av_get_token(buf, key_val_sep);
562     char *val;
563     int ret;
564
565     if (!key)
566         return AVERROR(ENOMEM);
567
568     if (*key && strspn(*buf, key_val_sep)) {
569         (*buf)++;
570         val = av_get_token(buf, pairs_sep);
571         if (!val) {
572             av_freep(&key);
573             return AVERROR(ENOMEM);
574         }
575     } else {
576         av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
577         av_free(key);
578         return AVERROR(EINVAL);
579     }
580
581     av_log(ctx, AV_LOG_DEBUG, "Setting value '%s' for key '%s'\n", val, key);
582
583     ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
584     if (ret == AVERROR_OPTION_NOT_FOUND)
585         av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
586
587     av_free(key);
588     av_free(val);
589     return ret;
590 }
591
592 int av_set_options_string(void *ctx, const char *opts,
593                           const char *key_val_sep, const char *pairs_sep)
594 {
595     int ret, count = 0;
596
597     if (!opts)
598         return 0;
599
600     while (*opts) {
601         if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
602             return ret;
603         count++;
604
605         if (*opts)
606             opts++;
607     }
608
609     return count;
610 }
611
612 void av_opt_free(void *obj)
613 {
614     const AVOption *o = NULL;
615     while ((o = av_opt_next(obj, o)))
616         if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
617             av_freep((uint8_t *)obj + o->offset);
618 }
619
620 int av_opt_set_dict(void *obj, AVDictionary **options)
621 {
622     AVDictionaryEntry *t = NULL;
623     AVDictionary    *tmp = NULL;
624     int ret = 0;
625
626     while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
627         ret = av_opt_set(obj, t->key, t->value, 0);
628         if (ret == AVERROR_OPTION_NOT_FOUND)
629             av_dict_set(&tmp, t->key, t->value, 0);
630         else if (ret < 0) {
631             av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
632             break;
633         }
634         ret = 0;
635     }
636     av_dict_free(options);
637     *options = tmp;
638     return ret;
639 }
640
641 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
642                             int opt_flags, int search_flags)
643 {
644     return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
645 }
646
647 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
648                              int opt_flags, int search_flags, void **target_obj)
649 {
650     const AVClass  *c = *(AVClass**)obj;
651     const AVOption *o = NULL;
652
653     if (search_flags & AV_OPT_SEARCH_CHILDREN) {
654         if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
655             const AVClass *child = NULL;
656             while (child = av_opt_child_class_next(c, child))
657                 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
658                     return o;
659         } else {
660             void *child = NULL;
661             while (child = av_opt_child_next(obj, child))
662                 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
663                     return o;
664         }
665     }
666
667     while (o = av_opt_next(obj, o)) {
668         if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
669             ((!unit && o->type != AV_OPT_TYPE_CONST) ||
670              (unit  && o->unit && !strcmp(o->unit, unit)))) {
671             if (target_obj) {
672                 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
673                     *target_obj = obj;
674                 else
675                     *target_obj = NULL;
676             }
677             return o;
678         }
679     }
680     return NULL;
681 }
682
683 void *av_opt_child_next(void *obj, void *prev)
684 {
685     const AVClass *c = *(AVClass**)obj;
686     if (c->child_next)
687         return c->child_next(obj, prev);
688     return NULL;
689 }
690
691 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
692 {
693     if (parent->child_class_next)
694         return parent->child_class_next(prev);
695     return NULL;
696 }
697
698 #ifdef TEST
699
700 typedef struct TestContext
701 {
702     const AVClass *class;
703     int num;
704     int toggle;
705     char *string;
706     int flags;
707     AVRational rational;
708 } TestContext;
709
710 #define OFFSET(x) offsetof(TestContext, x)
711
712 #define TEST_FLAG_COOL 01
713 #define TEST_FLAG_LAME 02
714 #define TEST_FLAG_MU   04
715
716 static const AVOption test_options[]= {
717 {"num",      "set num",        OFFSET(num),      AV_OPT_TYPE_INT,      {.i64 = 0},       0,        100                 },
718 {"toggle",   "set toggle",     OFFSET(toggle),   AV_OPT_TYPE_INT,      {.i64 = 0},       0,        1                   },
719 {"rational", "set rational",   OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0},  0,        10                  },
720 {"string",   "set string",     OFFSET(string),   AV_OPT_TYPE_STRING,   {0},              CHAR_MIN, CHAR_MAX            },
721 {"flags",    "set flags",      OFFSET(flags),    AV_OPT_TYPE_FLAGS,    {.i64 = 0},       0,        INT_MAX, 0, "flags" },
722 {"cool",     "set cool flag ", 0,                AV_OPT_TYPE_CONST,    {.i64 = TEST_FLAG_COOL}, INT_MIN,  INT_MAX, 0, "flags" },
723 {"lame",     "set lame flag ", 0,                AV_OPT_TYPE_CONST,    {.i64 = TEST_FLAG_LAME}, INT_MIN,  INT_MAX, 0, "flags" },
724 {"mu",       "set mu flag ",   0,                AV_OPT_TYPE_CONST,    {.i64 = TEST_FLAG_MU},   INT_MIN,  INT_MAX, 0, "flags" },
725 {NULL},
726 };
727
728 static const char *test_get_name(void *ctx)
729 {
730     return "test";
731 }
732
733 static const AVClass test_class = {
734     "TestContext",
735     test_get_name,
736     test_options
737 };
738
739 int main(void)
740 {
741     int i;
742
743     printf("\nTesting av_set_options_string()\n");
744     {
745         TestContext test_ctx;
746         const char *options[] = {
747             "",
748             ":",
749             "=",
750             "foo=:",
751             ":=foo",
752             "=foo",
753             "foo=",
754             "foo",
755             "foo=val",
756             "foo==val",
757             "toggle=:",
758             "string=:",
759             "toggle=1 : foo",
760             "toggle=100",
761             "toggle==1",
762             "flags=+mu-lame : num=42: toggle=0",
763             "num=42 : string=blahblah",
764             "rational=0 : rational=1/2 : rational=1/-1",
765             "rational=-1/0",
766         };
767
768         test_ctx.class = &test_class;
769         av_opt_set_defaults(&test_ctx);
770         test_ctx.string = av_strdup("default");
771
772         av_log_set_level(AV_LOG_DEBUG);
773
774         for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
775             av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
776             if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
777                 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
778             printf("\n");
779         }
780     }
781
782     return 0;
783 }
784
785 #endif