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