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