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