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