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