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