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