]> git.sesse.net Git - ffmpeg/blob - libavutil/eval.c
opt/eval: Include mathematics.h for NAN/INFINITY
[ffmpeg] / libavutil / eval.c
1 /*
2  * Copyright (c) 2002-2006 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (c) 2006 Oded Shimon <ods15@ods15.dyndns.org>
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  * simple arithmetic expression evaluator.
25  *
26  * see http://joe.hotchkiss.com/programming/eval/eval.html
27  */
28
29 #include "avutil.h"
30 #include "eval.h"
31 #include "log.h"
32 #include "mathematics.h"
33
34 typedef struct Parser {
35     const AVClass *class;
36     int stack_index;
37     char *s;
38     const double *const_values;
39     const char * const *const_names;          // NULL terminated
40     double (* const *funcs1)(void *, double a);           // NULL terminated
41     const char * const *func1_names;          // NULL terminated
42     double (* const *funcs2)(void *, double a, double b); // NULL terminated
43     const char * const *func2_names;          // NULL terminated
44     void *opaque;
45     int log_offset;
46     void *log_ctx;
47 #define VARS 10
48     double var[VARS];
49 } Parser;
50
51 static const AVClass class = { "Eval", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(Parser,log_offset), offsetof(Parser,log_ctx) };
52
53 static const int8_t si_prefixes['z' - 'E' + 1] = {
54     ['y'-'E']= -24,
55     ['z'-'E']= -21,
56     ['a'-'E']= -18,
57     ['f'-'E']= -15,
58     ['p'-'E']= -12,
59     ['n'-'E']= - 9,
60     ['u'-'E']= - 6,
61     ['m'-'E']= - 3,
62     ['c'-'E']= - 2,
63     ['d'-'E']= - 1,
64     ['h'-'E']=   2,
65     ['k'-'E']=   3,
66     ['K'-'E']=   3,
67     ['M'-'E']=   6,
68     ['G'-'E']=   9,
69     ['T'-'E']=  12,
70     ['P'-'E']=  15,
71     ['E'-'E']=  18,
72     ['Z'-'E']=  21,
73     ['Y'-'E']=  24,
74 };
75
76 double av_strtod(const char *numstr, char **tail)
77 {
78     double d;
79     char *next;
80     d = strtod(numstr, &next);
81     /* if parsing succeeded, check for and interpret postfixes */
82     if (next!=numstr) {
83         if (*next >= 'E' && *next <= 'z') {
84             int e= si_prefixes[*next - 'E'];
85             if (e) {
86                 if (next[1] == 'i') {
87                     d*= pow( 2, e/0.3);
88                     next+=2;
89                 } else {
90                     d*= pow(10, e);
91                     next++;
92                 }
93             }
94         }
95
96         if (*next=='B') {
97             d*=8;
98             next++;
99         }
100     }
101     /* if requested, fill in tail with the position after the last parsed
102        character */
103     if (tail)
104         *tail = next;
105     return d;
106 }
107
108 #define IS_IDENTIFIER_CHAR(c) ((c) - '0' <= 9U || (c) - 'a' <= 25U || (c) - 'A' <= 25U || (c) == '_')
109
110 static int strmatch(const char *s, const char *prefix)
111 {
112     int i;
113     for (i=0; prefix[i]; i++) {
114         if (prefix[i] != s[i]) return 0;
115     }
116     /* return 1 only if the s identifier is terminated */
117     return !IS_IDENTIFIER_CHAR(s[i]);
118 }
119
120 struct AVExpr {
121     enum {
122         e_value, e_const, e_func0, e_func1, e_func2,
123         e_squish, e_gauss, e_ld, e_isnan,
124         e_mod, e_max, e_min, e_eq, e_gt, e_gte,
125         e_pow, e_mul, e_div, e_add,
126         e_last, e_st, e_while, e_floor, e_ceil, e_trunc,
127         e_sqrt, e_not,
128     } type;
129     double value; // is sign in other types
130     union {
131         int const_index;
132         double (*func0)(double);
133         double (*func1)(void *, double);
134         double (*func2)(void *, double, double);
135     } a;
136     struct AVExpr *param[2];
137 };
138
139 static double eval_expr(Parser *p, AVExpr *e)
140 {
141     switch (e->type) {
142         case e_value:  return e->value;
143         case e_const:  return e->value * p->const_values[e->a.const_index];
144         case e_func0:  return e->value * e->a.func0(eval_expr(p, e->param[0]));
145         case e_func1:  return e->value * e->a.func1(p->opaque, eval_expr(p, e->param[0]));
146         case e_func2:  return e->value * e->a.func2(p->opaque, eval_expr(p, e->param[0]), eval_expr(p, e->param[1]));
147         case e_squish: return 1/(1+exp(4*eval_expr(p, e->param[0])));
148         case e_gauss: { double d = eval_expr(p, e->param[0]); return exp(-d*d/2)/sqrt(2*M_PI); }
149         case e_ld:     return e->value * p->var[av_clip(eval_expr(p, e->param[0]), 0, VARS-1)];
150         case e_isnan:  return e->value * !!isnan(eval_expr(p, e->param[0]));
151         case e_floor:  return e->value * floor(eval_expr(p, e->param[0]));
152         case e_ceil :  return e->value * ceil (eval_expr(p, e->param[0]));
153         case e_trunc:  return e->value * trunc(eval_expr(p, e->param[0]));
154         case e_sqrt:   return e->value * sqrt (eval_expr(p, e->param[0]));
155         case e_not:    return e->value * eval_expr(p, e->param[0]) == 0;
156         case e_while: {
157             double d = NAN;
158             while (eval_expr(p, e->param[0]))
159                 d=eval_expr(p, e->param[1]);
160             return d;
161         }
162         default: {
163             double d = eval_expr(p, e->param[0]);
164             double d2 = eval_expr(p, e->param[1]);
165             switch (e->type) {
166                 case e_mod: return e->value * (d - floor(d/d2)*d2);
167                 case e_max: return e->value * (d >  d2 ?   d : d2);
168                 case e_min: return e->value * (d <  d2 ?   d : d2);
169                 case e_eq:  return e->value * (d == d2 ? 1.0 : 0.0);
170                 case e_gt:  return e->value * (d >  d2 ? 1.0 : 0.0);
171                 case e_gte: return e->value * (d >= d2 ? 1.0 : 0.0);
172                 case e_pow: return e->value * pow(d, d2);
173                 case e_mul: return e->value * (d * d2);
174                 case e_div: return e->value * (d / d2);
175                 case e_add: return e->value * (d + d2);
176                 case e_last:return e->value * d2;
177                 case e_st : return e->value * (p->var[av_clip(d, 0, VARS-1)]= d2);
178             }
179         }
180     }
181     return NAN;
182 }
183
184 static int parse_expr(AVExpr **e, Parser *p);
185
186 void av_expr_free(AVExpr *e)
187 {
188     if (!e) return;
189     av_expr_free(e->param[0]);
190     av_expr_free(e->param[1]);
191     av_freep(&e);
192 }
193
194 static int parse_primary(AVExpr **e, Parser *p)
195 {
196     AVExpr *d = av_mallocz(sizeof(AVExpr));
197     char *next = p->s, *s0 = p->s;
198     int ret, i;
199
200     if (!d)
201         return AVERROR(ENOMEM);
202
203     /* number */
204     d->value = av_strtod(p->s, &next);
205     if (next != p->s) {
206         d->type = e_value;
207         p->s= next;
208         *e = d;
209         return 0;
210     }
211     d->value = 1;
212
213     /* named constants */
214     for (i=0; p->const_names && p->const_names[i]; i++) {
215         if (strmatch(p->s, p->const_names[i])) {
216             p->s+= strlen(p->const_names[i]);
217             d->type = e_const;
218             d->a.const_index = i;
219             *e = d;
220             return 0;
221         }
222     }
223
224     p->s= strchr(p->s, '(');
225     if (p->s==NULL) {
226         av_log(p, AV_LOG_ERROR, "Undefined constant or missing '(' in '%s'\n", s0);
227         p->s= next;
228         av_expr_free(d);
229         return AVERROR(EINVAL);
230     }
231     p->s++; // "("
232     if (*next == '(') { // special case do-nothing
233         av_freep(&d);
234         if ((ret = parse_expr(&d, p)) < 0)
235             return ret;
236         if (p->s[0] != ')') {
237             av_log(p, AV_LOG_ERROR, "Missing ')' in '%s'\n", s0);
238             av_expr_free(d);
239             return AVERROR(EINVAL);
240         }
241         p->s++; // ")"
242         *e = d;
243         return 0;
244     }
245     if ((ret = parse_expr(&(d->param[0]), p)) < 0) {
246         av_expr_free(d);
247         return ret;
248     }
249     if (p->s[0]== ',') {
250         p->s++; // ","
251         parse_expr(&d->param[1], p);
252     }
253     if (p->s[0] != ')') {
254         av_log(p, AV_LOG_ERROR, "Missing ')' or too many args in '%s'\n", s0);
255         av_expr_free(d);
256         return AVERROR(EINVAL);
257     }
258     p->s++; // ")"
259
260     d->type = e_func0;
261          if (strmatch(next, "sinh"  )) d->a.func0 = sinh;
262     else if (strmatch(next, "cosh"  )) d->a.func0 = cosh;
263     else if (strmatch(next, "tanh"  )) d->a.func0 = tanh;
264     else if (strmatch(next, "sin"   )) d->a.func0 = sin;
265     else if (strmatch(next, "cos"   )) d->a.func0 = cos;
266     else if (strmatch(next, "tan"   )) d->a.func0 = tan;
267     else if (strmatch(next, "atan"  )) d->a.func0 = atan;
268     else if (strmatch(next, "asin"  )) d->a.func0 = asin;
269     else if (strmatch(next, "acos"  )) d->a.func0 = acos;
270     else if (strmatch(next, "exp"   )) d->a.func0 = exp;
271     else if (strmatch(next, "log"   )) d->a.func0 = log;
272     else if (strmatch(next, "abs"   )) d->a.func0 = fabs;
273     else if (strmatch(next, "squish")) d->type = e_squish;
274     else if (strmatch(next, "gauss" )) d->type = e_gauss;
275     else if (strmatch(next, "mod"   )) d->type = e_mod;
276     else if (strmatch(next, "max"   )) d->type = e_max;
277     else if (strmatch(next, "min"   )) d->type = e_min;
278     else if (strmatch(next, "eq"    )) d->type = e_eq;
279     else if (strmatch(next, "gte"   )) d->type = e_gte;
280     else if (strmatch(next, "gt"    )) d->type = e_gt;
281     else if (strmatch(next, "lte"   )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gt; }
282     else if (strmatch(next, "lt"    )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gte; }
283     else if (strmatch(next, "ld"    )) d->type = e_ld;
284     else if (strmatch(next, "isnan" )) d->type = e_isnan;
285     else if (strmatch(next, "st"    )) d->type = e_st;
286     else if (strmatch(next, "while" )) d->type = e_while;
287     else if (strmatch(next, "floor" )) d->type = e_floor;
288     else if (strmatch(next, "ceil"  )) d->type = e_ceil;
289     else if (strmatch(next, "trunc" )) d->type = e_trunc;
290     else if (strmatch(next, "sqrt"  )) d->type = e_sqrt;
291     else if (strmatch(next, "not"   )) d->type = e_not;
292     else {
293         for (i=0; p->func1_names && p->func1_names[i]; i++) {
294             if (strmatch(next, p->func1_names[i])) {
295                 d->a.func1 = p->funcs1[i];
296                 d->type = e_func1;
297                 *e = d;
298                 return 0;
299             }
300         }
301
302         for (i=0; p->func2_names && p->func2_names[i]; i++) {
303             if (strmatch(next, p->func2_names[i])) {
304                 d->a.func2 = p->funcs2[i];
305                 d->type = e_func2;
306                 *e = d;
307                 return 0;
308             }
309         }
310
311         av_log(p, AV_LOG_ERROR, "Unknown function in '%s'\n", s0);
312         av_expr_free(d);
313         return AVERROR(EINVAL);
314     }
315
316     *e = d;
317     return 0;
318 }
319
320 static AVExpr *new_eval_expr(int type, int value, AVExpr *p0, AVExpr *p1)
321 {
322     AVExpr *e = av_mallocz(sizeof(AVExpr));
323     if (!e)
324         return NULL;
325     e->type     =type   ;
326     e->value    =value  ;
327     e->param[0] =p0     ;
328     e->param[1] =p1     ;
329     return e;
330 }
331
332 static int parse_pow(AVExpr **e, Parser *p, int *sign)
333 {
334     *sign= (*p->s == '+') - (*p->s == '-');
335     p->s += *sign&1;
336     return parse_primary(e, p);
337 }
338
339 static int parse_factor(AVExpr **e, Parser *p)
340 {
341     int sign, sign2, ret;
342     AVExpr *e0, *e1, *e2;
343     if ((ret = parse_pow(&e0, p, &sign)) < 0)
344         return ret;
345     while(p->s[0]=='^'){
346         e1 = e0;
347         p->s++;
348         if ((ret = parse_pow(&e2, p, &sign2)) < 0) {
349             av_expr_free(e1);
350             return ret;
351         }
352         e0 = new_eval_expr(e_pow, 1, e1, e2);
353         if (!e0) {
354             av_expr_free(e1);
355             av_expr_free(e2);
356             return AVERROR(ENOMEM);
357         }
358         if (e0->param[1]) e0->param[1]->value *= (sign2|1);
359     }
360     if (e0) e0->value *= (sign|1);
361
362     *e = e0;
363     return 0;
364 }
365
366 static int parse_term(AVExpr **e, Parser *p)
367 {
368     int ret;
369     AVExpr *e0, *e1, *e2;
370     if ((ret = parse_factor(&e0, p)) < 0)
371         return ret;
372     while (p->s[0]=='*' || p->s[0]=='/') {
373         int c= *p->s++;
374         e1 = e0;
375         if ((ret = parse_factor(&e2, p)) < 0) {
376             av_expr_free(e1);
377             return ret;
378         }
379         e0 = new_eval_expr(c == '*' ? e_mul : e_div, 1, e1, e2);
380         if (!e0) {
381             av_expr_free(e1);
382             av_expr_free(e2);
383             return AVERROR(ENOMEM);
384         }
385     }
386     *e = e0;
387     return 0;
388 }
389
390 static int parse_subexpr(AVExpr **e, Parser *p)
391 {
392     int ret;
393     AVExpr *e0, *e1, *e2;
394     if ((ret = parse_term(&e0, p)) < 0)
395         return ret;
396     while (*p->s == '+' || *p->s == '-') {
397         e1 = e0;
398         if ((ret = parse_term(&e2, p)) < 0) {
399             av_expr_free(e1);
400             return ret;
401         }
402         e0 = new_eval_expr(e_add, 1, e1, e2);
403         if (!e0) {
404             av_expr_free(e1);
405             av_expr_free(e2);
406             return AVERROR(ENOMEM);
407         }
408     };
409
410     *e = e0;
411     return 0;
412 }
413
414 static int parse_expr(AVExpr **e, Parser *p)
415 {
416     int ret;
417     AVExpr *e0, *e1, *e2;
418     if (p->stack_index <= 0) //protect against stack overflows
419         return AVERROR(EINVAL);
420     p->stack_index--;
421
422     if ((ret = parse_subexpr(&e0, p)) < 0)
423         return ret;
424     while (*p->s == ';') {
425         p->s++;
426         e1 = e0;
427         if ((ret = parse_subexpr(&e2, p)) < 0) {
428             av_expr_free(e1);
429             return ret;
430         }
431         e0 = new_eval_expr(e_last, 1, e1, e2);
432         if (!e0) {
433             av_expr_free(e1);
434             av_expr_free(e2);
435             return AVERROR(ENOMEM);
436         }
437     };
438
439     p->stack_index++;
440     *e = e0;
441     return 0;
442 }
443
444 static int verify_expr(AVExpr *e)
445 {
446     if (!e) return 0;
447     switch (e->type) {
448         case e_value:
449         case e_const: return 1;
450         case e_func0:
451         case e_func1:
452         case e_squish:
453         case e_ld:
454         case e_gauss:
455         case e_isnan:
456         case e_floor:
457         case e_ceil:
458         case e_trunc:
459         case e_sqrt:
460         case e_not:
461             return verify_expr(e->param[0]);
462         default: return verify_expr(e->param[0]) && verify_expr(e->param[1]);
463     }
464 }
465
466 int av_expr_parse(AVExpr **expr, const char *s,
467                   const char * const *const_names,
468                   const char * const *func1_names, double (* const *funcs1)(void *, double),
469                   const char * const *func2_names, double (* const *funcs2)(void *, double, double),
470                   int log_offset, void *log_ctx)
471 {
472     Parser p = { 0 };
473     AVExpr *e = NULL;
474     char *w = av_malloc(strlen(s) + 1);
475     char *wp = w;
476     const char *s0 = s;
477     int ret = 0;
478
479     if (!w)
480         return AVERROR(ENOMEM);
481
482     while (*s)
483         if (!isspace(*s++)) *wp++ = s[-1];
484     *wp++ = 0;
485
486     p.class      = &class;
487     p.stack_index=100;
488     p.s= w;
489     p.const_names = const_names;
490     p.funcs1      = funcs1;
491     p.func1_names = func1_names;
492     p.funcs2      = funcs2;
493     p.func2_names = func2_names;
494     p.log_offset = log_offset;
495     p.log_ctx    = log_ctx;
496
497     if ((ret = parse_expr(&e, &p)) < 0)
498         goto end;
499     if (*p.s) {
500         av_expr_free(e);
501         av_log(&p, AV_LOG_ERROR, "Invalid chars '%s' at the end of expression '%s'\n", p.s, s0);
502         ret = AVERROR(EINVAL);
503         goto end;
504     }
505     if (!verify_expr(e)) {
506         av_expr_free(e);
507         ret = AVERROR(EINVAL);
508         goto end;
509     }
510     *expr = e;
511 end:
512     av_free(w);
513     return ret;
514 }
515
516 double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
517 {
518     Parser p = { 0 };
519
520     p.const_values = const_values;
521     p.opaque     = opaque;
522     return eval_expr(&p, e);
523 }
524
525 int av_expr_parse_and_eval(double *d, const char *s,
526                            const char * const *const_names, const double *const_values,
527                            const char * const *func1_names, double (* const *funcs1)(void *, double),
528                            const char * const *func2_names, double (* const *funcs2)(void *, double, double),
529                            void *opaque, int log_offset, void *log_ctx)
530 {
531     AVExpr *e = NULL;
532     int ret = av_expr_parse(&e, s, const_names, func1_names, funcs1, func2_names, funcs2, log_offset, log_ctx);
533
534     if (ret < 0) {
535         *d = NAN;
536         return ret;
537     }
538     *d = av_expr_eval(e, const_values, opaque);
539     av_expr_free(e);
540     return isnan(*d) ? AVERROR(EINVAL) : 0;
541 }
542
543 #ifdef TEST
544 #undef printf
545 #include <string.h>
546
547 static const double const_values[] = {
548     M_PI,
549     M_E,
550     0
551 };
552
553 static const char *const const_names[] = {
554     "PI",
555     "E",
556     0
557 };
558
559 int main(int argc, char **argv)
560 {
561     int i;
562     double d;
563     const char **expr, *exprs[] = {
564         "",
565         "1;2",
566         "-20",
567         "-PI",
568         "+PI",
569         "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
570         "80G/80Gi",
571         "1k",
572         "1Gi",
573         "1gi",
574         "1GiFoo",
575         "1k+1k",
576         "1Gi*3foo",
577         "foo",
578         "foo(",
579         "foo()",
580         "foo)",
581         "sin",
582         "sin(",
583         "sin()",
584         "sin)",
585         "sin 10",
586         "sin(1,2,3)",
587         "sin(1 )",
588         "1",
589         "1foo",
590         "bar + PI + E + 100f*2 + foo",
591         "13k + 12f - foo(1, 2)",
592         "1gi",
593         "1Gi",
594         "st(0, 123)",
595         "st(1, 123); ld(1)",
596         /* compute 1+2+...+N */
597         "st(0, 1); while(lte(ld(0), 100), st(1, ld(1)+ld(0));st(0, ld(0)+1)); ld(1)",
598         /* compute Fib(N) */
599         "st(1, 1); st(2, 2); st(0, 1); while(lte(ld(0),10), st(3, ld(1)+ld(2)); st(1, ld(2)); st(2, ld(3)); st(0, ld(0)+1)); ld(3)",
600         "while(0, 10)",
601         "st(0, 1); while(lte(ld(0),100), st(1, ld(1)+ld(0)); st(0, ld(0)+1))",
602         "isnan(1)",
603         "isnan(NAN)",
604         "floor(NAN)",
605         "floor(123.123)",
606         "floor(-123.123)",
607         "trunc(123.123)",
608         "trunc(-123.123)",
609         "ceil(123.123)",
610         "ceil(-123.123)",
611         "sqrt(1764)",
612         "isnan(sqrt(-1))",
613         "not(1)",
614         "not(NAN)",
615         "not(0)",
616         NULL
617     };
618
619     for (expr = exprs; *expr; expr++) {
620         printf("Evaluating '%s'\n", *expr);
621         av_expr_parse_and_eval(&d, *expr,
622                                const_names, const_values,
623                                NULL, NULL, NULL, NULL, NULL, 0, NULL);
624         printf("'%s' -> %f\n\n", *expr, d);
625     }
626
627     av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
628                            const_names, const_values,
629                            NULL, NULL, NULL, NULL, NULL, 0, NULL);
630     printf("%f == 12.7\n", d);
631     av_expr_parse_and_eval(&d, "80G/80Gi",
632                            const_names, const_values,
633                            NULL, NULL, NULL, NULL, NULL, 0, NULL);
634     printf("%f == 0.931322575\n", d);
635
636     if (argc > 1 && !strcmp(argv[1], "-t")) {
637         for (i = 0; i < 1050; i++) {
638             START_TIMER;
639             av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
640                                    const_names, const_values,
641                                    NULL, NULL, NULL, NULL, NULL, 0, NULL);
642             STOP_TIMER("av_expr_parse_and_eval");
643         }
644     }
645
646     return 0;
647 }
648 #endif