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