2 * Copyright (c) 2002-2006 Michael Niedermayer <michaelni@gmx.at>
3 * Copyright (c) 2006 Oded Shimon <ods15@ods15.dyndns.org>
5 * This file is part of FFmpeg.
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.
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.
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
24 * simple arithmetic expression evaluator.
26 * see http://joe.hotchkiss.com/programming/eval/eval.html
34 #include "mathematics.h"
36 typedef struct Parser {
40 const double *const_values;
41 const char * const *const_names; // NULL terminated
42 double (* const *funcs1)(void *, double a); // NULL terminated
43 const char * const *func1_names; // NULL terminated
44 double (* const *funcs2)(void *, double a, double b); // NULL terminated
45 const char * const *func2_names; // NULL terminated
53 static const AVClass class = { "Eval", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(Parser,log_offset), offsetof(Parser,log_ctx) };
55 static const int8_t si_prefixes['z' - 'E' + 1] = {
87 double av_strtod(const char *numstr, char **tail)
91 if(numstr[0]=='0' && (numstr[1]|0x20)=='x') {
92 d = strtoul(numstr, &next, 16);
94 d = strtod(numstr, &next);
95 /* if parsing succeeded, check for and interpret postfixes */
97 if (*next >= 'E' && *next <= 'z') {
98 int e= si_prefixes[*next - 'E'];
100 if (next[1] == 'i') {
115 /* if requested, fill in tail with the position after the last parsed
122 #define IS_IDENTIFIER_CHAR(c) ((c) - '0' <= 9U || (c) - 'a' <= 25U || (c) - 'A' <= 25U || (c) == '_')
124 static int strmatch(const char *s, const char *prefix)
127 for (i=0; prefix[i]; i++) {
128 if (prefix[i] != s[i]) return 0;
130 /* return 1 only if the s identifier is terminated */
131 return !IS_IDENTIFIER_CHAR(s[i]);
136 e_value, e_const, e_func0, e_func1, e_func2,
137 e_squish, e_gauss, e_ld, e_isnan, e_isinf,
138 e_mod, e_max, e_min, e_eq, e_gt, e_gte,
139 e_pow, e_mul, e_div, e_add,
140 e_last, e_st, e_while, e_taylor, e_root, e_floor, e_ceil, e_trunc,
141 e_sqrt, e_not, e_random, e_hypot, e_gcd,
144 double value; // is sign in other types
147 double (*func0)(double);
148 double (*func1)(void *, double);
149 double (*func2)(void *, double, double);
151 struct AVExpr *param[3];
155 static double eval_expr(Parser *p, AVExpr *e)
158 case e_value: return e->value;
159 case e_const: return e->value * p->const_values[e->a.const_index];
160 case e_func0: return e->value * e->a.func0(eval_expr(p, e->param[0]));
161 case e_func1: return e->value * e->a.func1(p->opaque, eval_expr(p, e->param[0]));
162 case e_func2: return e->value * e->a.func2(p->opaque, eval_expr(p, e->param[0]), eval_expr(p, e->param[1]));
163 case e_squish: return 1/(1+exp(4*eval_expr(p, e->param[0])));
164 case e_gauss: { double d = eval_expr(p, e->param[0]); return exp(-d*d/2)/sqrt(2*M_PI); }
165 case e_ld: return e->value * p->var[av_clip(eval_expr(p, e->param[0]), 0, VARS-1)];
166 case e_isnan: return e->value * !!isnan(eval_expr(p, e->param[0]));
167 case e_isinf: return e->value * !!isinf(eval_expr(p, e->param[0]));
168 case e_floor: return e->value * floor(eval_expr(p, e->param[0]));
169 case e_ceil : return e->value * ceil (eval_expr(p, e->param[0]));
170 case e_trunc: return e->value * trunc(eval_expr(p, e->param[0]));
171 case e_sqrt: return e->value * sqrt (eval_expr(p, e->param[0]));
172 case e_not: return e->value * (eval_expr(p, e->param[0]) == 0);
173 case e_if: return e->value * ( eval_expr(p, e->param[0]) ? eval_expr(p, e->param[1]) : 0);
174 case e_ifnot: return e->value * (!eval_expr(p, e->param[0]) ? eval_expr(p, e->param[1]) : 0);
176 int idx= av_clip(eval_expr(p, e->param[0]), 0, VARS-1);
177 uint64_t r= isnan(p->var[idx]) ? 0 : p->var[idx];
178 r= r*1664525+1013904223;
180 return e->value * (r * (1.0/UINT64_MAX));
184 while (eval_expr(p, e->param[0]))
185 d=eval_expr(p, e->param[1]);
189 double t = 1, d = 0, v;
190 double x = eval_expr(p, e->param[1]);
191 int id = e->param[2] ? av_clip(eval_expr(p, e->param[2]), 0, VARS-1) : 0;
193 double var0 = p->var[id];
194 for(i=0; i<1000; i++) {
197 v = eval_expr(p, e->param[0]);
208 double low = -1, high = -1, v, low_v = -DBL_MAX, high_v = DBL_MAX;
209 double var0 = p->var[0];
210 double x_max = eval_expr(p, e->param[1]);
211 for(i=-1; i<1024; i++) {
213 p->var[0] = av_reverse[i&255]*x_max/255;
215 p->var[0] = x_max*pow(0.9, i-255);
216 if (i&1) p->var[0] *= -1;
217 if (i&2) p->var[0] += low;
218 else p->var[0] += high;
220 v = eval_expr(p, e->param[0]);
221 if (v<=0 && v>low_v) {
225 if (v>=0 && v<high_v) {
229 if (low>=0 && high>=0){
230 for (j=0; j<1000; j++) {
231 p->var[0] = (low+high)*0.5;
232 if (low == p->var[0] || high == p->var[0])
234 v = eval_expr(p, e->param[0]);
235 if (v<=0) low = p->var[0];
236 if (v>=0) high= p->var[0];
246 return -low_v<high_v ? low : high;
249 double d = eval_expr(p, e->param[0]);
250 double d2 = eval_expr(p, e->param[1]);
252 case e_mod: return e->value * (d - floor(d/d2)*d2);
253 case e_gcd: return e->value * av_gcd(d,d2);
254 case e_max: return e->value * (d > d2 ? d : d2);
255 case e_min: return e->value * (d < d2 ? d : d2);
256 case e_eq: return e->value * (d == d2 ? 1.0 : 0.0);
257 case e_gt: return e->value * (d > d2 ? 1.0 : 0.0);
258 case e_gte: return e->value * (d >= d2 ? 1.0 : 0.0);
259 case e_pow: return e->value * pow(d, d2);
260 case e_mul: return e->value * (d * d2);
261 case e_div: return e->value * ((!CONFIG_FTRAPV || d2 ) ? (d / d2) : d * INFINITY);
262 case e_add: return e->value * (d + d2);
263 case e_last:return e->value * d2;
264 case e_st : return e->value * (p->var[av_clip(d, 0, VARS-1)]= d2);
265 case e_hypot:return e->value * (sqrt(d*d + d2*d2));
272 static int parse_expr(AVExpr **e, Parser *p);
274 void av_expr_free(AVExpr *e)
277 av_expr_free(e->param[0]);
278 av_expr_free(e->param[1]);
279 av_expr_free(e->param[2]);
284 static int parse_primary(AVExpr **e, Parser *p)
286 AVExpr *d = av_mallocz(sizeof(AVExpr));
287 char *next = p->s, *s0 = p->s;
291 return AVERROR(ENOMEM);
294 d->value = av_strtod(p->s, &next);
303 /* named constants */
304 for (i=0; p->const_names && p->const_names[i]; i++) {
305 if (strmatch(p->s, p->const_names[i])) {
306 p->s+= strlen(p->const_names[i]);
308 d->a.const_index = i;
313 for (i = 0; i < FF_ARRAY_ELEMS(constants); i++) {
314 if (strmatch(p->s, constants[i].name)) {
315 p->s += strlen(constants[i].name);
317 d->value = constants[i].value;
323 p->s= strchr(p->s, '(');
325 av_log(p, AV_LOG_ERROR, "Undefined constant or missing '(' in '%s'\n", s0);
328 return AVERROR(EINVAL);
331 if (*next == '(') { // special case do-nothing
333 if ((ret = parse_expr(&d, p)) < 0)
335 if (p->s[0] != ')') {
336 av_log(p, AV_LOG_ERROR, "Missing ')' in '%s'\n", s0);
338 return AVERROR(EINVAL);
344 if ((ret = parse_expr(&(d->param[0]), p)) < 0) {
350 parse_expr(&d->param[1], p);
354 parse_expr(&d->param[2], p);
356 if (p->s[0] != ')') {
357 av_log(p, AV_LOG_ERROR, "Missing ')' or too many args in '%s'\n", s0);
359 return AVERROR(EINVAL);
364 if (strmatch(next, "sinh" )) d->a.func0 = sinh;
365 else if (strmatch(next, "cosh" )) d->a.func0 = cosh;
366 else if (strmatch(next, "tanh" )) d->a.func0 = tanh;
367 else if (strmatch(next, "sin" )) d->a.func0 = sin;
368 else if (strmatch(next, "cos" )) d->a.func0 = cos;
369 else if (strmatch(next, "tan" )) d->a.func0 = tan;
370 else if (strmatch(next, "atan" )) d->a.func0 = atan;
371 else if (strmatch(next, "asin" )) d->a.func0 = asin;
372 else if (strmatch(next, "acos" )) d->a.func0 = acos;
373 else if (strmatch(next, "exp" )) d->a.func0 = exp;
374 else if (strmatch(next, "log" )) d->a.func0 = log;
375 else if (strmatch(next, "abs" )) d->a.func0 = fabs;
376 else if (strmatch(next, "squish")) d->type = e_squish;
377 else if (strmatch(next, "gauss" )) d->type = e_gauss;
378 else if (strmatch(next, "mod" )) d->type = e_mod;
379 else if (strmatch(next, "max" )) d->type = e_max;
380 else if (strmatch(next, "min" )) d->type = e_min;
381 else if (strmatch(next, "eq" )) d->type = e_eq;
382 else if (strmatch(next, "gte" )) d->type = e_gte;
383 else if (strmatch(next, "gt" )) d->type = e_gt;
384 else if (strmatch(next, "lte" )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gte; }
385 else if (strmatch(next, "lt" )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gt; }
386 else if (strmatch(next, "ld" )) d->type = e_ld;
387 else if (strmatch(next, "isnan" )) d->type = e_isnan;
388 else if (strmatch(next, "isinf" )) d->type = e_isinf;
389 else if (strmatch(next, "st" )) d->type = e_st;
390 else if (strmatch(next, "while" )) d->type = e_while;
391 else if (strmatch(next, "taylor")) d->type = e_taylor;
392 else if (strmatch(next, "root" )) d->type = e_root;
393 else if (strmatch(next, "floor" )) d->type = e_floor;
394 else if (strmatch(next, "ceil" )) d->type = e_ceil;
395 else if (strmatch(next, "trunc" )) d->type = e_trunc;
396 else if (strmatch(next, "sqrt" )) d->type = e_sqrt;
397 else if (strmatch(next, "not" )) d->type = e_not;
398 else if (strmatch(next, "pow" )) d->type = e_pow;
399 else if (strmatch(next, "random")) d->type = e_random;
400 else if (strmatch(next, "hypot" )) d->type = e_hypot;
401 else if (strmatch(next, "gcd" )) d->type = e_gcd;
402 else if (strmatch(next, "if" )) d->type = e_if;
403 else if (strmatch(next, "ifnot" )) d->type = e_ifnot;
405 for (i=0; p->func1_names && p->func1_names[i]; i++) {
406 if (strmatch(next, p->func1_names[i])) {
407 d->a.func1 = p->funcs1[i];
414 for (i=0; p->func2_names && p->func2_names[i]; i++) {
415 if (strmatch(next, p->func2_names[i])) {
416 d->a.func2 = p->funcs2[i];
423 av_log(p, AV_LOG_ERROR, "Unknown function in '%s'\n", s0);
425 return AVERROR(EINVAL);
432 static AVExpr *new_eval_expr(int type, int value, AVExpr *p0, AVExpr *p1)
434 AVExpr *e = av_mallocz(sizeof(AVExpr));
444 static int parse_pow(AVExpr **e, Parser *p, int *sign)
446 *sign= (*p->s == '+') - (*p->s == '-');
448 return parse_primary(e, p);
451 static int parse_factor(AVExpr **e, Parser *p)
453 int sign, sign2, ret;
454 AVExpr *e0, *e1, *e2;
455 if ((ret = parse_pow(&e0, p, &sign)) < 0)
460 if ((ret = parse_pow(&e2, p, &sign2)) < 0) {
464 e0 = new_eval_expr(e_pow, 1, e1, e2);
468 return AVERROR(ENOMEM);
470 if (e0->param[1]) e0->param[1]->value *= (sign2|1);
472 if (e0) e0->value *= (sign|1);
478 static int parse_term(AVExpr **e, Parser *p)
481 AVExpr *e0, *e1, *e2;
482 if ((ret = parse_factor(&e0, p)) < 0)
484 while (p->s[0]=='*' || p->s[0]=='/') {
487 if ((ret = parse_factor(&e2, p)) < 0) {
491 e0 = new_eval_expr(c == '*' ? e_mul : e_div, 1, e1, e2);
495 return AVERROR(ENOMEM);
502 static int parse_subexpr(AVExpr **e, Parser *p)
505 AVExpr *e0, *e1, *e2;
506 if ((ret = parse_term(&e0, p)) < 0)
508 while (*p->s == '+' || *p->s == '-') {
510 if ((ret = parse_term(&e2, p)) < 0) {
514 e0 = new_eval_expr(e_add, 1, e1, e2);
518 return AVERROR(ENOMEM);
526 static int parse_expr(AVExpr **e, Parser *p)
529 AVExpr *e0, *e1, *e2;
530 if (p->stack_index <= 0) //protect against stack overflows
531 return AVERROR(EINVAL);
534 if ((ret = parse_subexpr(&e0, p)) < 0)
536 while (*p->s == ';') {
539 if ((ret = parse_subexpr(&e2, p)) < 0) {
543 e0 = new_eval_expr(e_last, 1, e1, e2);
547 return AVERROR(ENOMEM);
556 static int verify_expr(AVExpr *e)
561 case e_const: return 1;
575 return verify_expr(e->param[0]) && !e->param[1];
577 return verify_expr(e->param[0]) && verify_expr(e->param[1])
578 && (!e->param[2] || verify_expr(e->param[2]));
579 default: return verify_expr(e->param[0]) && verify_expr(e->param[1]) && !e->param[2];
583 int av_expr_parse(AVExpr **expr, const char *s,
584 const char * const *const_names,
585 const char * const *func1_names, double (* const *funcs1)(void *, double),
586 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
587 int log_offset, void *log_ctx)
591 char *w = av_malloc(strlen(s) + 1);
597 return AVERROR(ENOMEM);
600 if (!isspace(*s++)) *wp++ = s[-1];
606 p.const_names = const_names;
608 p.func1_names = func1_names;
610 p.func2_names = func2_names;
611 p.log_offset = log_offset;
614 if ((ret = parse_expr(&e, &p)) < 0)
618 av_log(&p, AV_LOG_ERROR, "Invalid chars '%s' at the end of expression '%s'\n", p.s, s0);
619 ret = AVERROR(EINVAL);
622 if (!verify_expr(e)) {
624 ret = AVERROR(EINVAL);
627 e->var= av_mallocz(sizeof(double) *VARS);
634 double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
639 p.const_values = const_values;
641 return eval_expr(&p, e);
644 int av_expr_parse_and_eval(double *d, const char *s,
645 const char * const *const_names, const double *const_values,
646 const char * const *func1_names, double (* const *funcs1)(void *, double),
647 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
648 void *opaque, int log_offset, void *log_ctx)
651 int ret = av_expr_parse(&e, s, const_names, func1_names, funcs1, func2_names, funcs2, log_offset, log_ctx);
657 *d = av_expr_eval(e, const_values, opaque);
659 return isnan(*d) ? AVERROR(EINVAL) : 0;
662 #if FF_API_OLD_EVAL_NAMES
664 int av_parse_expr(AVExpr **expr, const char *s,
665 const char * const *const_names,
666 const char * const *func1_names, double (* const *funcs1)(void *, double),
667 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
668 int log_offset, void *log_ctx)
670 return av_expr_parse(expr, s, const_names, func1_names, funcs1, func2_names, funcs2,
671 log_offset, log_ctx);
674 double av_eval_expr(AVExpr *e, const double *const_values, void *opaque)
676 return av_expr_eval(e, const_values, opaque);
679 int av_parse_and_eval_expr(double *res, const char *s,
680 const char * const *const_names, const double *const_values,
681 const char * const *func1_names, double (* const *funcs1)(void *, double),
682 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
683 void *opaque, int log_offset, void *log_ctx)
685 return av_expr_parse_and_eval(res, s, const_names, const_values, func1_names, funcs1, func2_names, funcs2,
686 opaque, log_offset, log_ctx);
689 void av_free_expr(AVExpr *e)
694 #endif /* FF_API_OLD_EVAL_NAMES */
701 static const double const_values[] = {
707 static const char *const const_names[] = {
713 int main(int argc, char **argv)
717 const char **expr, *exprs[] = {
723 "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
744 "bar + PI + E + 100f*2 + foo",
745 "13k + 12f - foo(1, 2)",
758 /* compute 1+2+...+N */
759 "st(0, 1); while(lte(ld(0), 100), st(1, ld(1)+ld(0));st(0, ld(0)+1)); ld(1)",
761 "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)",
763 "st(0, 1); while(lte(ld(0),100), st(1, ld(1)+ld(0)); st(0, ld(0)+1))",
788 "ifnot(1, NaN) + if(0, 1)",
790 "taylor(eq(mod(ld(1),4),1)-eq(mod(ld(1),4),3), PI/2, 1)",
791 "root(sin(ld(0))-1, 2)",
792 "root(sin(ld(0))+6+sin(ld(0)/12)-log(ld(0)), 100)",
796 for (expr = exprs; *expr; expr++) {
797 printf("Evaluating '%s'\n", *expr);
798 av_expr_parse_and_eval(&d, *expr,
799 const_names, const_values,
800 NULL, NULL, NULL, NULL, NULL, 0, NULL);
802 printf("'%s' -> nan\n\n", *expr);
804 printf("'%s' -> %f\n\n", *expr, d);
807 av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
808 const_names, const_values,
809 NULL, NULL, NULL, NULL, NULL, 0, NULL);
810 printf("%f == 12.7\n", d);
811 av_expr_parse_and_eval(&d, "80G/80Gi",
812 const_names, const_values,
813 NULL, NULL, NULL, NULL, NULL, 0, NULL);
814 printf("%f == 0.931322575\n", d);
816 if (argc > 1 && !strcmp(argv[1], "-t")) {
817 for (i = 0; i < 1050; i++) {
819 av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
820 const_names, const_values,
821 NULL, NULL, NULL, NULL, NULL, 0, NULL);
822 STOP_TIMER("av_expr_parse_and_eval");