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