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