eval: add gt(), gte(), lt() and lte() fate tests
[ffmpeg.git] / 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, e_isinf,
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_isinf:  return e->value * !!isinf(eval_expr(p, e->param[0]));
152         case e_floor:  return e->value * floor(eval_expr(p, e->param[0]));
153         case e_ceil :  return e->value * ceil (eval_expr(p, e->param[0]));
154         case e_trunc:  return e->value * trunc(eval_expr(p, e->param[0]));
155         case e_sqrt:   return e->value * sqrt (eval_expr(p, e->param[0]));
156         case e_not:    return e->value * eval_expr(p, e->param[0]) == 0;
157         case e_while: {
158             double d = NAN;
159             while (eval_expr(p, e->param[0]))
160                 d=eval_expr(p, e->param[1]);
161             return d;
162         }
163         default: {
164             double d = eval_expr(p, e->param[0]);
165             double d2 = eval_expr(p, e->param[1]);
166             switch (e->type) {
167                 case e_mod: return e->value * (d - floor(d/d2)*d2);
168                 case e_max: return e->value * (d >  d2 ?   d : d2);
169                 case e_min: return e->value * (d <  d2 ?   d : d2);
170                 case e_eq:  return e->value * (d == d2 ? 1.0 : 0.0);
171                 case e_gt:  return e->value * (d >  d2 ? 1.0 : 0.0);
172                 case e_gte: return e->value * (d >= d2 ? 1.0 : 0.0);
173                 case e_pow: return e->value * pow(d, d2);
174                 case e_mul: return e->value * (d * d2);
175                 case e_div: return e->value * (d / d2);
176                 case e_add: return e->value * (d + d2);
177                 case e_last:return e->value * d2;
178                 case e_st : return e->value * (p->var[av_clip(d, 0, VARS-1)]= d2);
179             }
180         }
181     }
182     return NAN;
183 }
184
185 static int parse_expr(AVExpr **e, Parser *p);
186
187 void av_expr_free(AVExpr *e)
188 {
189     if (!e) return;
190     av_expr_free(e->param[0]);
191     av_expr_free(e->param[1]);
192     av_freep(&e);
193 }
194
195 static int parse_primary(AVExpr **e, Parser *p)
196 {
197     AVExpr *d = av_mallocz(sizeof(AVExpr));
198     char *next = p->s, *s0 = p->s;
199     int ret, i;
200
201     if (!d)
202         return AVERROR(ENOMEM);
203
204     /* number */
205     d->value = av_strtod(p->s, &next);
206     if (next != p->s) {
207         d->type = e_value;
208         p->s= next;
209         *e = d;
210         return 0;
211     }
212     d->value = 1;
213
214     /* named constants */
215     for (i=0; p->const_names && p->const_names[i]; i++) {
216         if (strmatch(p->s, p->const_names[i])) {
217             p->s+= strlen(p->const_names[i]);
218             d->type = e_const;
219             d->a.const_index = i;
220             *e = d;
221             return 0;
222         }
223     }
224
225     p->s= strchr(p->s, '(');
226     if (p->s==NULL) {
227         av_log(p, AV_LOG_ERROR, "Undefined constant or missing '(' in '%s'\n", s0);
228         p->s= next;
229         av_expr_free(d);
230         return AVERROR(EINVAL);
231     }
232     p->s++; // "("
233     if (*next == '(') { // special case do-nothing
234         av_freep(&d);
235         if ((ret = parse_expr(&d, p)) < 0)
236             return ret;
237         if (p->s[0] != ')') {
238             av_log(p, AV_LOG_ERROR, "Missing ')' in '%s'\n", s0);
239             av_expr_free(d);
240             return AVERROR(EINVAL);
241         }
242         p->s++; // ")"
243         *e = d;
244         return 0;
245     }
246     if ((ret = parse_expr(&(d->param[0]), p)) < 0) {
247         av_expr_free(d);
248         return ret;
249     }
250     if (p->s[0]== ',') {
251         p->s++; // ","
252         parse_expr(&d->param[1], p);
253     }
254     if (p->s[0] != ')') {
255         av_log(p, AV_LOG_ERROR, "Missing ')' or too many args in '%s'\n", s0);
256         av_expr_free(d);
257         return AVERROR(EINVAL);
258     }
259     p->s++; // ")"
260
261     d->type = e_func0;
262          if (strmatch(next, "sinh"  )) d->a.func0 = sinh;
263     else if (strmatch(next, "cosh"  )) d->a.func0 = cosh;
264     else if (strmatch(next, "tanh"  )) d->a.func0 = tanh;
265     else if (strmatch(next, "sin"   )) d->a.func0 = sin;
266     else if (strmatch(next, "cos"   )) d->a.func0 = cos;
267     else if (strmatch(next, "tan"   )) d->a.func0 = tan;
268     else if (strmatch(next, "atan"  )) d->a.func0 = atan;
269     else if (strmatch(next, "asin"  )) d->a.func0 = asin;
270     else if (strmatch(next, "acos"  )) d->a.func0 = acos;
271     else if (strmatch(next, "exp"   )) d->a.func0 = exp;
272     else if (strmatch(next, "log"   )) d->a.func0 = log;
273     else if (strmatch(next, "abs"   )) d->a.func0 = fabs;
274     else if (strmatch(next, "squish")) d->type = e_squish;
275     else if (strmatch(next, "gauss" )) d->type = e_gauss;
276     else if (strmatch(next, "mod"   )) d->type = e_mod;
277     else if (strmatch(next, "max"   )) d->type = e_max;
278     else if (strmatch(next, "min"   )) d->type = e_min;
279     else if (strmatch(next, "eq"    )) d->type = e_eq;
280     else if (strmatch(next, "gte"   )) d->type = e_gte;
281     else if (strmatch(next, "gt"    )) d->type = e_gt;
282     else if (strmatch(next, "lte"   )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gte; }
283     else if (strmatch(next, "lt"    )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gt; }
284     else if (strmatch(next, "ld"    )) d->type = e_ld;
285     else if (strmatch(next, "isnan" )) d->type = e_isnan;
286     else if (strmatch(next, "isinf" )) d->type = e_isinf;
287     else if (strmatch(next, "st"    )) d->type = e_st;
288     else if (strmatch(next, "while" )) d->type = e_while;
289     else if (strmatch(next, "floor" )) d->type = e_floor;
290     else if (strmatch(next, "ceil"  )) d->type = e_ceil;
291     else if (strmatch(next, "trunc" )) d->type = e_trunc;
292     else if (strmatch(next, "sqrt"  )) d->type = e_sqrt;
293     else if (strmatch(next, "not"   )) d->type = e_not;
294     else {
295         for (i=0; p->func1_names && p->func1_names[i]; i++) {
296             if (strmatch(next, p->func1_names[i])) {
297                 d->a.func1 = p->funcs1[i];
298                 d->type = e_func1;
299                 *e = d;
300                 return 0;
301             }
302         }
303
304         for (i=0; p->func2_names && p->func2_names[i]; i++) {
305             if (strmatch(next, p->func2_names[i])) {
306                 d->a.func2 = p->funcs2[i];
307                 d->type = e_func2;
308                 *e = d;
309                 return 0;
310             }
311         }
312
313         av_log(p, AV_LOG_ERROR, "Unknown function in '%s'\n", s0);
314         av_expr_free(d);
315         return AVERROR(EINVAL);
316     }
317
318     *e = d;
319     return 0;
320 }
321
322 static AVExpr *new_eval_expr(int type, int value, AVExpr *p0, AVExpr *p1)
323 {
324     AVExpr *e = av_mallocz(sizeof(AVExpr));
325     if (!e)
326         return NULL;
327     e->type     =type   ;
328     e->value    =value  ;
329     e->param[0] =p0     ;
330     e->param[1] =p1     ;
331     return e;
332 }
333
334 static int parse_pow(AVExpr **e, Parser *p, int *sign)
335 {
336     *sign= (*p->s == '+') - (*p->s == '-');
337     p->s += *sign&1;
338     return parse_primary(e, p);
339 }
340
341 static int parse_factor(AVExpr **e, Parser *p)
342 {
343     int sign, sign2, ret;
344     AVExpr *e0, *e1, *e2;
345     if ((ret = parse_pow(&e0, p, &sign)) < 0)
346         return ret;
347     while(p->s[0]=='^'){
348         e1 = e0;
349         p->s++;
350         if ((ret = parse_pow(&e2, p, &sign2)) < 0) {
351             av_expr_free(e1);
352             return ret;
353         }
354         e0 = new_eval_expr(e_pow, 1, e1, e2);
355         if (!e0) {
356             av_expr_free(e1);
357             av_expr_free(e2);
358             return AVERROR(ENOMEM);
359         }
360         if (e0->param[1]) e0->param[1]->value *= (sign2|1);
361     }
362     if (e0) e0->value *= (sign|1);
363
364     *e = e0;
365     return 0;
366 }
367
368 static int parse_term(AVExpr **e, Parser *p)
369 {
370     int ret;
371     AVExpr *e0, *e1, *e2;
372     if ((ret = parse_factor(&e0, p)) < 0)
373         return ret;
374     while (p->s[0]=='*' || p->s[0]=='/') {
375         int c= *p->s++;
376         e1 = e0;
377         if ((ret = parse_factor(&e2, p)) < 0) {
378             av_expr_free(e1);
379             return ret;
380         }
381         e0 = new_eval_expr(c == '*' ? e_mul : e_div, 1, e1, e2);
382         if (!e0) {
383             av_expr_free(e1);
384             av_expr_free(e2);
385             return AVERROR(ENOMEM);
386         }
387     }
388     *e = e0;
389     return 0;
390 }
391
392 static int parse_subexpr(AVExpr **e, Parser *p)
393 {
394     int ret;
395     AVExpr *e0, *e1, *e2;
396     if ((ret = parse_term(&e0, p)) < 0)
397         return ret;
398     while (*p->s == '+' || *p->s == '-') {
399         e1 = e0;
400         if ((ret = parse_term(&e2, p)) < 0) {
401             av_expr_free(e1);
402             return ret;
403         }
404         e0 = new_eval_expr(e_add, 1, e1, e2);
405         if (!e0) {
406             av_expr_free(e1);
407             av_expr_free(e2);
408             return AVERROR(ENOMEM);
409         }
410     };
411
412     *e = e0;
413     return 0;
414 }
415
416 static int parse_expr(AVExpr **e, Parser *p)
417 {
418     int ret;
419     AVExpr *e0, *e1, *e2;
420     if (p->stack_index <= 0) //protect against stack overflows
421         return AVERROR(EINVAL);
422     p->stack_index--;
423
424     if ((ret = parse_subexpr(&e0, p)) < 0)
425         return ret;
426     while (*p->s == ';') {
427         p->s++;
428         e1 = e0;
429         if ((ret = parse_subexpr(&e2, p)) < 0) {
430             av_expr_free(e1);
431             return ret;
432         }
433         e0 = new_eval_expr(e_last, 1, e1, e2);
434         if (!e0) {
435             av_expr_free(e1);
436             av_expr_free(e2);
437             return AVERROR(ENOMEM);
438         }
439     };
440
441     p->stack_index++;
442     *e = e0;
443     return 0;
444 }
445
446 static int verify_expr(AVExpr *e)
447 {
448     if (!e) return 0;
449     switch (e->type) {
450         case e_value:
451         case e_const: return 1;
452         case e_func0:
453         case e_func1:
454         case e_squish:
455         case e_ld:
456         case e_gauss:
457         case e_isnan:
458         case e_isinf:
459         case e_floor:
460         case e_ceil:
461         case e_trunc:
462         case e_sqrt:
463         case e_not:
464             return verify_expr(e->param[0]);
465         default: return verify_expr(e->param[0]) && verify_expr(e->param[1]);
466     }
467 }
468
469 int av_expr_parse(AVExpr **expr, const char *s,
470                   const char * const *const_names,
471                   const char * const *func1_names, double (* const *funcs1)(void *, double),
472                   const char * const *func2_names, double (* const *funcs2)(void *, double, double),
473                   int log_offset, void *log_ctx)
474 {
475     Parser p = { 0 };
476     AVExpr *e = NULL;
477     char *w = av_malloc(strlen(s) + 1);
478     char *wp = w;
479     const char *s0 = s;
480     int ret = 0;
481
482     if (!w)
483         return AVERROR(ENOMEM);
484
485     while (*s)
486         if (!isspace(*s++)) *wp++ = s[-1];
487     *wp++ = 0;
488
489     p.class      = &class;
490     p.stack_index=100;
491     p.s= w;
492     p.const_names = const_names;
493     p.funcs1      = funcs1;
494     p.func1_names = func1_names;
495     p.funcs2      = funcs2;
496     p.func2_names = func2_names;
497     p.log_offset = log_offset;
498     p.log_ctx    = log_ctx;
499
500     if ((ret = parse_expr(&e, &p)) < 0)
501         goto end;
502     if (*p.s) {
503         av_expr_free(e);
504         av_log(&p, AV_LOG_ERROR, "Invalid chars '%s' at the end of expression '%s'\n", p.s, s0);
505         ret = AVERROR(EINVAL);
506         goto end;
507     }
508     if (!verify_expr(e)) {
509         av_expr_free(e);
510         ret = AVERROR(EINVAL);
511         goto end;
512     }
513     *expr = e;
514 end:
515     av_free(w);
516     return ret;
517 }
518
519 double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
520 {
521     Parser p = { 0 };
522
523     p.const_values = const_values;
524     p.opaque     = opaque;
525     return eval_expr(&p, e);
526 }
527
528 int av_expr_parse_and_eval(double *d, const char *s,
529                            const char * const *const_names, const double *const_values,
530                            const char * const *func1_names, double (* const *funcs1)(void *, double),
531                            const char * const *func2_names, double (* const *funcs2)(void *, double, double),
532                            void *opaque, int log_offset, void *log_ctx)
533 {
534     AVExpr *e = NULL;
535     int ret = av_expr_parse(&e, s, const_names, func1_names, funcs1, func2_names, funcs2, log_offset, log_ctx);
536
537     if (ret < 0) {
538         *d = NAN;
539         return ret;
540     }
541     *d = av_expr_eval(e, const_values, opaque);
542     av_expr_free(e);
543     return isnan(*d) ? AVERROR(EINVAL) : 0;
544 }
545
546 #ifdef TEST
547 #undef printf
548 #include <string.h>
549
550 static const double const_values[] = {
551     M_PI,
552     M_E,
553     0
554 };
555
556 static const char *const const_names[] = {
557     "PI",
558     "E",
559     0
560 };
561
562 int main(int argc, char **argv)
563 {
564     int i;
565     double d;
566     const char **expr, *exprs[] = {
567         "",
568         "1;2",
569         "-20",
570         "-PI",
571         "+PI",
572         "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
573         "80G/80Gi",
574         "1k",
575         "1Gi",
576         "1gi",
577         "1GiFoo",
578         "1k+1k",
579         "1Gi*3foo",
580         "foo",
581         "foo(",
582         "foo()",
583         "foo)",
584         "sin",
585         "sin(",
586         "sin()",
587         "sin)",
588         "sin 10",
589         "sin(1,2,3)",
590         "sin(1 )",
591         "1",
592         "1foo",
593         "bar + PI + E + 100f*2 + foo",
594         "13k + 12f - foo(1, 2)",
595         "1gi",
596         "1Gi",
597         "st(0, 123)",
598         "st(1, 123); ld(1)",
599         "lte(0, 1)",
600         "lte(1, 1)",
601         "lte(1, 0)",
602         "lt(0, 1)",
603         "lt(1, 1)",
604         "gt(1, 0)",
605         "gt(2, 7)",
606         "gte(122, 122)",
607         /* compute 1+2+...+N */
608         "st(0, 1); while(lte(ld(0), 100), st(1, ld(1)+ld(0));st(0, ld(0)+1)); ld(1)",
609         /* compute Fib(N) */
610         "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)",
611         "while(0, 10)",
612         "st(0, 1); while(lte(ld(0),100), st(1, ld(1)+ld(0)); st(0, ld(0)+1))",
613         "isnan(1)",
614         "isnan(NAN)",
615         "isnan(INF)",
616         "isinf(1)",
617         "isinf(NAN)",
618         "isinf(INF)",
619         "floor(NAN)",
620         "floor(123.123)",
621         "floor(-123.123)",
622         "trunc(123.123)",
623         "trunc(-123.123)",
624         "ceil(123.123)",
625         "ceil(-123.123)",
626         "sqrt(1764)",
627         "isnan(sqrt(-1))",
628         "not(1)",
629         "not(NAN)",
630         "not(0)",
631         NULL
632     };
633
634     for (expr = exprs; *expr; expr++) {
635         printf("Evaluating '%s'\n", *expr);
636         av_expr_parse_and_eval(&d, *expr,
637                                const_names, const_values,
638                                NULL, NULL, NULL, NULL, NULL, 0, NULL);
639         printf("'%s' -> %f\n\n", *expr, d);
640     }
641
642     av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
643                            const_names, const_values,
644                            NULL, NULL, NULL, NULL, NULL, 0, NULL);
645     printf("%f == 12.7\n", d);
646     av_expr_parse_and_eval(&d, "80G/80Gi",
647                            const_names, const_values,
648                            NULL, NULL, NULL, NULL, NULL, 0, NULL);
649     printf("%f == 0.931322575\n", d);
650
651     if (argc > 1 && !strcmp(argv[1], "-t")) {
652         for (i = 0; i < 1050; i++) {
653             START_TIMER;
654             av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
655                                    const_names, const_values,
656                                    NULL, NULL, NULL, NULL, NULL, 0, NULL);
657             STOP_TIMER("av_expr_parse_and_eval");
658         }
659     }
660
661     return 0;
662 }
663 #endif