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