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