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