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