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