avoptions: Support getting flag values using av_get_int
[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 "opt.h"
31 #include "eval.h"
32
33 //FIXME order them and do a bin search
34 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags)
35 {
36     const AVOption *o = NULL;
37
38     while ((o = av_next_option(v, o))) {
39         if (!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags)
40             return o;
41     }
42     return NULL;
43 }
44
45 const AVOption *av_next_option(void *obj, const AVOption *last)
46 {
47     if (last && last[1].name) return ++last;
48     else if (last)            return NULL;
49     else                      return (*(AVClass**)obj)->option;
50 }
51
52 static int av_set_number2(void *obj, const char *name, double num, int den, int64_t intnum, const AVOption **o_out)
53 {
54     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
55     void *dst;
56     if (o_out)
57         *o_out= o;
58     if (!o || o->offset<=0)
59         return AVERROR_OPTION_NOT_FOUND;
60
61     if (o->max*den < num*intnum || o->min*den > num*intnum) {
62         av_log(obj, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range\n", num, name);
63         return AVERROR(ERANGE);
64     }
65
66     dst= ((uint8_t*)obj) + o->offset;
67
68     switch (o->type) {
69     case FF_OPT_TYPE_FLAGS:
70     case FF_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
71     case FF_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
72     case FF_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
73     case FF_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
74     case FF_OPT_TYPE_RATIONAL:
75         if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
76         else                 *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
77         break;
78     default:
79         return AVERROR(EINVAL);
80     }
81     return 0;
82 }
83
84 static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum)
85 {
86     const AVOption *o = NULL;
87     if (av_set_number2(obj, name, num, den, intnum, &o) < 0)
88         return NULL;
89     else
90         return o;
91 }
92
93 static const double const_values[] = {
94     M_PI,
95     M_E,
96     FF_QP2LAMBDA,
97     0
98 };
99
100 static const char * const const_names[] = {
101     "PI",
102     "E",
103     "QP2LAMBDA",
104     0
105 };
106
107 static int hexchar2int(char c) {
108     if (c >= '0' && c <= '9') return c - '0';
109     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
110     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
111     return -1;
112 }
113
114 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
115 {
116     int ret;
117     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
118     if (o_out)
119         *o_out = o;
120     if (!o)
121         return AVERROR_OPTION_NOT_FOUND;
122     if ((!val && o->type != FF_OPT_TYPE_STRING) || o->offset<=0)
123         return AVERROR(EINVAL);
124
125     if (o->type == FF_OPT_TYPE_BINARY) {
126         uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
127         int *lendst = (int *)(dst + 1);
128         uint8_t *bin, *ptr;
129         int len = strlen(val);
130         av_freep(dst);
131         *lendst = 0;
132         if (len & 1) return AVERROR(EINVAL);
133         len /= 2;
134         ptr = bin = av_malloc(len);
135         while (*val) {
136             int a = hexchar2int(*val++);
137             int b = hexchar2int(*val++);
138             if (a < 0 || b < 0) {
139                 av_free(bin);
140                 return AVERROR(EINVAL);
141             }
142             *ptr++ = (a << 4) | b;
143         }
144         *dst = bin;
145         *lendst = len;
146         return 0;
147     }
148     if (o->type != FF_OPT_TYPE_STRING) {
149         int notfirst=0;
150         for (;;) {
151             int i;
152             char buf[256];
153             int cmd=0;
154             double d;
155
156             if (*val == '+' || *val == '-')
157                 cmd= *(val++);
158
159             for (i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
160                 buf[i]= val[i];
161             buf[i]=0;
162
163             {
164                 const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
165                 if (o_named && o_named->type == FF_OPT_TYPE_CONST)
166                     d= o_named->default_val.dbl;
167                 else if (!strcmp(buf, "default")) d= o->default_val.dbl;
168                 else if (!strcmp(buf, "max"    )) d= o->max;
169                 else if (!strcmp(buf, "min"    )) d= o->min;
170                 else if (!strcmp(buf, "none"   )) d= 0;
171                 else if (!strcmp(buf, "all"    )) d= ~0;
172                 else {
173                     int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
174                     if (res < 0) {
175                         av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
176                         return res;
177                     }
178                 }
179             }
180             if (o->type == FF_OPT_TYPE_FLAGS) {
181                 if      (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
182                 else if (cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
183             } else {
184                 if      (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
185                 else if (cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
186             }
187
188             if ((ret = av_set_number2(obj, name, d, 1, 1, o_out)) < 0)
189                 return ret;
190             val+= i;
191             if (!*val)
192                 return 0;
193             notfirst=1;
194         }
195         return AVERROR(EINVAL);
196     }
197
198     if (alloc) {
199         av_free(*(void**)(((uint8_t*)obj) + o->offset));
200         val= av_strdup(val);
201     }
202
203     memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
204     return 0;
205 }
206
207 const AVOption *av_set_double(void *obj, const char *name, double n)
208 {
209     return av_set_number(obj, name, n, 1, 1);
210 }
211
212 const AVOption *av_set_q(void *obj, const char *name, AVRational n)
213 {
214     return av_set_number(obj, name, n.num, n.den, 1);
215 }
216
217 const AVOption *av_set_int(void *obj, const char *name, int64_t n)
218 {
219     return av_set_number(obj, name, 1, 1, n);
220 }
221
222 /**
223  *
224  * @param buf a buffer which is used for returning non string values as strings, can be NULL
225  * @param buf_len allocated length in bytes of buf
226  */
227 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
228 {
229     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
230     void *dst;
231     uint8_t *bin;
232     int len, i;
233     if (!o || o->offset<=0)
234         return NULL;
235     if (o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
236         return NULL;
237
238     dst= ((uint8_t*)obj) + o->offset;
239     if (o_out) *o_out= o;
240
241     switch (o->type) {
242     case FF_OPT_TYPE_FLAGS:     snprintf(buf, buf_len, "0x%08X",*(int    *)dst);break;
243     case FF_OPT_TYPE_INT:       snprintf(buf, buf_len, "%d" , *(int    *)dst);break;
244     case FF_OPT_TYPE_INT64:     snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
245     case FF_OPT_TYPE_FLOAT:     snprintf(buf, buf_len, "%f" , *(float  *)dst);break;
246     case FF_OPT_TYPE_DOUBLE:    snprintf(buf, buf_len, "%f" , *(double *)dst);break;
247     case FF_OPT_TYPE_RATIONAL:  snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
248     case FF_OPT_TYPE_STRING:    return *(void**)dst;
249     case FF_OPT_TYPE_BINARY:
250         len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
251         if (len >= (buf_len + 1)/2) return NULL;
252         bin = *(uint8_t**)dst;
253         for (i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
254         break;
255     default: return NULL;
256     }
257     return buf;
258 }
259
260 static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum)
261 {
262     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
263     void *dst;
264     if (!o || (o->offset<=0 && o->type != FF_OPT_TYPE_CONST))
265         goto error;
266
267     dst= ((uint8_t*)obj) + o->offset;
268
269     if (o_out) *o_out= o;
270
271     switch (o->type) {
272     case FF_OPT_TYPE_FLAGS:     *intnum= *(unsigned int*)dst;return 0;
273     case FF_OPT_TYPE_INT:       *intnum= *(int    *)dst;return 0;
274     case FF_OPT_TYPE_INT64:     *intnum= *(int64_t*)dst;return 0;
275     case FF_OPT_TYPE_FLOAT:     *num=    *(float  *)dst;return 0;
276     case FF_OPT_TYPE_DOUBLE:    *num=    *(double *)dst;return 0;
277     case FF_OPT_TYPE_RATIONAL:  *intnum= ((AVRational*)dst)->num;
278                                 *den   = ((AVRational*)dst)->den;
279                                                         return 0;
280     case FF_OPT_TYPE_CONST:     *intnum= o->default_val.dbl;return 0;
281     }
282 error:
283     *den=*intnum=0;
284     return -1;
285 }
286
287 double av_get_double(void *obj, const char *name, const AVOption **o_out)
288 {
289     int64_t intnum=1;
290     double num=1;
291     int den=1;
292
293     av_get_number(obj, name, o_out, &num, &den, &intnum);
294     return num*intnum/den;
295 }
296
297 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out)
298 {
299     int64_t intnum=1;
300     double num=1;
301     int den=1;
302
303     av_get_number(obj, name, o_out, &num, &den, &intnum);
304     if (num == 1.0 && (int)intnum == intnum)
305         return (AVRational){intnum, den};
306     else
307         return av_d2q(num*intnum/den, 1<<24);
308 }
309
310 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out)
311 {
312     int64_t intnum=1;
313     double num=1;
314     int den=1;
315
316     av_get_number(obj, name, o_out, &num, &den, &intnum);
317     return num*intnum/den;
318 }
319
320 static void opt_list(void *obj, void *av_log_obj, const char *unit,
321                      int req_flags, int rej_flags)
322 {
323     const AVOption *opt=NULL;
324
325     while ((opt= av_next_option(obj, opt))) {
326         if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
327             continue;
328
329         /* Don't print CONST's on level one.
330          * Don't print anything but CONST's on level two.
331          * Only print items from the requested unit.
332          */
333         if (!unit && opt->type==FF_OPT_TYPE_CONST)
334             continue;
335         else if (unit && opt->type!=FF_OPT_TYPE_CONST)
336             continue;
337         else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
338             continue;
339         else if (unit && opt->type == FF_OPT_TYPE_CONST)
340             av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
341         else
342             av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
343
344         switch (opt->type) {
345             case FF_OPT_TYPE_FLAGS:
346                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
347                 break;
348             case FF_OPT_TYPE_INT:
349                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
350                 break;
351             case FF_OPT_TYPE_INT64:
352                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
353                 break;
354             case FF_OPT_TYPE_DOUBLE:
355                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
356                 break;
357             case FF_OPT_TYPE_FLOAT:
358                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
359                 break;
360             case FF_OPT_TYPE_STRING:
361                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
362                 break;
363             case FF_OPT_TYPE_RATIONAL:
364                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
365                 break;
366             case FF_OPT_TYPE_BINARY:
367                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
368                 break;
369             case FF_OPT_TYPE_CONST:
370             default:
371                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
372                 break;
373         }
374         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
375         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
376         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
377         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
378         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
379
380         if (opt->help)
381             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
382         av_log(av_log_obj, AV_LOG_INFO, "\n");
383         if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
384             opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
385         }
386     }
387 }
388
389 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
390 {
391     if (!obj)
392         return -1;
393
394     av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
395
396     opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
397
398     return 0;
399 }
400
401 /** Set the values of the AVCodecContext or AVFormatContext structure.
402  * They are set to the defaults specified in the according AVOption options
403  * array default_val field.
404  *
405  * @param s AVCodecContext or AVFormatContext for which the defaults will be set
406  */
407 void av_opt_set_defaults2(void *s, int mask, int flags)
408 {
409     const AVOption *opt = NULL;
410     while ((opt = av_next_option(s, opt)) != NULL) {
411         if ((opt->flags & mask) != flags)
412             continue;
413         switch (opt->type) {
414             case FF_OPT_TYPE_CONST:
415                 /* Nothing to be done here */
416             break;
417             case FF_OPT_TYPE_FLAGS:
418             case FF_OPT_TYPE_INT: {
419                 int val;
420                 val = opt->default_val.dbl;
421                 av_set_int(s, opt->name, val);
422             }
423             break;
424             case FF_OPT_TYPE_INT64:
425                 if ((double)(opt->default_val.dbl+0.6) == opt->default_val.dbl)
426                     av_log(s, AV_LOG_DEBUG, "loss of precision in default of %s\n", opt->name);
427                 av_set_int(s, opt->name, opt->default_val.dbl);
428             break;
429             case FF_OPT_TYPE_DOUBLE:
430             case FF_OPT_TYPE_FLOAT: {
431                 double val;
432                 val = opt->default_val.dbl;
433                 av_set_double(s, opt->name, val);
434             }
435             break;
436             case FF_OPT_TYPE_RATIONAL: {
437                 AVRational val;
438                 val = av_d2q(opt->default_val.dbl, INT_MAX);
439                 av_set_q(s, opt->name, val);
440             }
441             break;
442             case FF_OPT_TYPE_STRING:
443             case FF_OPT_TYPE_BINARY:
444                 /* Cannot set default for string as default_val is of type * double */
445             break;
446             default:
447                 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
448         }
449     }
450 }
451
452 void av_opt_set_defaults(void *s)
453 {
454     av_opt_set_defaults2(s, 0, 0);
455 }
456
457 /**
458  * Store the value in the field in ctx that is named like key.
459  * ctx must be an AVClass context, storing is done using AVOptions.
460  *
461  * @param buf the string to parse, buf will be updated to point at the
462  * separator just after the parsed key/value pair
463  * @param key_val_sep a 0-terminated list of characters used to
464  * separate key from value
465  * @param pairs_sep a 0-terminated list of characters used to separate
466  * two pairs from each other
467  * @return 0 if the key/value pair has been successfully parsed and
468  * set, or a negative value corresponding to an AVERROR code in case
469  * of error:
470  * AVERROR(EINVAL) if the key/value pair cannot be parsed,
471  * the error code issued by av_set_string3() if the key/value pair
472  * cannot be set
473  */
474 static int parse_key_value_pair(void *ctx, const char **buf,
475                                 const char *key_val_sep, const char *pairs_sep)
476 {
477     char *key = av_get_token(buf, key_val_sep);
478     char *val;
479     int ret;
480
481     if (*key && strspn(*buf, key_val_sep)) {
482         (*buf)++;
483         val = av_get_token(buf, pairs_sep);
484     } else {
485         av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
486         av_free(key);
487         return AVERROR(EINVAL);
488     }
489
490     av_log(ctx, AV_LOG_DEBUG, "Setting value '%s' for key '%s'\n", val, key);
491
492     ret = av_set_string3(ctx, key, val, 1, NULL);
493     if (ret == AVERROR_OPTION_NOT_FOUND)
494         av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
495
496     av_free(key);
497     av_free(val);
498     return ret;
499 }
500
501 int av_set_options_string(void *ctx, const char *opts,
502                           const char *key_val_sep, const char *pairs_sep)
503 {
504     int ret, count = 0;
505
506     while (*opts) {
507         if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
508             return ret;
509         count++;
510
511         if (*opts)
512             opts++;
513     }
514
515     return count;
516 }
517
518 #ifdef TEST
519
520 #undef printf
521
522 typedef struct TestContext
523 {
524     const AVClass *class;
525     int num;
526     int toggle;
527     char *string;
528     int flags;
529     AVRational rational;
530 } TestContext;
531
532 #define OFFSET(x) offsetof(TestContext, x)
533
534 #define TEST_FLAG_COOL 01
535 #define TEST_FLAG_LAME 02
536 #define TEST_FLAG_MU   04
537
538 static const AVOption test_options[]= {
539 {"num",      "set num",        OFFSET(num),      FF_OPT_TYPE_INT,      0,              0,        100                 },
540 {"toggle",   "set toggle",     OFFSET(toggle),   FF_OPT_TYPE_INT,      0,              0,        1                   },
541 {"rational", "set rational",   OFFSET(rational), FF_OPT_TYPE_RATIONAL, 0,              0,        10                  },
542 {"string",   "set string",     OFFSET(string),   FF_OPT_TYPE_STRING,   0,              CHAR_MIN, CHAR_MAX            },
543 {"flags",    "set flags",      OFFSET(flags),    FF_OPT_TYPE_FLAGS,    0,              0,        INT_MAX, 0, "flags" },
544 {"cool",     "set cool flag ", 0,                FF_OPT_TYPE_CONST,    TEST_FLAG_COOL, INT_MIN,  INT_MAX, 0, "flags" },
545 {"lame",     "set lame flag ", 0,                FF_OPT_TYPE_CONST,    TEST_FLAG_LAME, INT_MIN,  INT_MAX, 0, "flags" },
546 {"mu",       "set mu flag ",   0,                FF_OPT_TYPE_CONST,    TEST_FLAG_MU,   INT_MIN,  INT_MAX, 0, "flags" },
547 {NULL},
548 };
549
550 static const char *test_get_name(void *ctx)
551 {
552     return "test";
553 }
554
555 static const AVClass test_class = {
556     "TestContext",
557     test_get_name,
558     test_options
559 };
560
561 int main(void)
562 {
563     int i;
564
565     printf("\nTesting av_set_options_string()\n");
566     {
567         TestContext test_ctx;
568         const char *options[] = {
569             "",
570             ":",
571             "=",
572             "foo=:",
573             ":=foo",
574             "=foo",
575             "foo=",
576             "foo",
577             "foo=val",
578             "foo==val",
579             "toggle=:",
580             "string=:",
581             "toggle=1 : foo",
582             "toggle=100",
583             "toggle==1",
584             "flags=+mu-lame : num=42: toggle=0",
585             "num=42 : string=blahblah",
586             "rational=0 : rational=1/2 : rational=1/-1",
587             "rational=-1/0",
588         };
589
590         test_ctx.class = &test_class;
591         av_opt_set_defaults2(&test_ctx, 0, 0);
592         test_ctx.string = av_strdup("default");
593
594         av_log_set_level(AV_LOG_DEBUG);
595
596         for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
597             av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
598             if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
599                 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
600             printf("\n");
601         }
602     }
603
604     return 0;
605 }
606
607 #endif