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
33 typedef struct Parser {
37 const double *const_values;
38 const char * const *const_names; // NULL terminated
39 double (* const *funcs1)(void *, double a); // NULL terminated
40 const char * const *func1_names; // NULL terminated
41 double (* const *funcs2)(void *, double a, double b); // NULL terminated
42 const char * const *func2_names; // NULL terminated
50 static const AVClass class = { "Eval", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(Parser,log_offset), offsetof(Parser,log_ctx) };
52 static const int8_t si_prefixes['z' - 'E' + 1] = {
84 double av_strtod(const char *numstr, char **tail)
88 if(numstr[0]=='0' && (numstr[1]|0x20)=='x') {
89 d = strtoul(numstr, &next, 16);
91 d = strtod(numstr, &next);
92 /* if parsing succeeded, check for and interpret postfixes */
94 if (*next >= 'E' && *next <= 'z') {
95 int e= si_prefixes[*next - 'E'];
112 /* if requested, fill in tail with the position after the last parsed
119 #define IS_IDENTIFIER_CHAR(c) ((c) - '0' <= 9U || (c) - 'a' <= 25U || (c) - 'A' <= 25U || (c) == '_')
121 static int strmatch(const char *s, const char *prefix)
124 for (i=0; prefix[i]; i++) {
125 if (prefix[i] != s[i]) return 0;
127 /* return 1 only if the s identifier is terminated */
128 return !IS_IDENTIFIER_CHAR(s[i]);
133 e_value, e_const, e_func0, e_func1, e_func2,
134 e_squish, e_gauss, e_ld, e_isnan,
135 e_mod, e_max, e_min, e_eq, e_gt, e_gte,
136 e_pow, e_mul, e_div, e_add,
137 e_last, e_st, e_while, e_floor, e_ceil, e_trunc,
138 e_sqrt, e_not, e_random, e_hypot, e_gcd,
140 double value; // is sign in other types
143 double (*func0)(double);
144 double (*func1)(void *, double);
145 double (*func2)(void *, double, double);
147 struct AVExpr *param[2];
151 static double eval_expr(Parser *p, AVExpr *e)
154 case e_value: return e->value;
155 case e_const: return e->value * p->const_values[e->a.const_index];
156 case e_func0: return e->value * e->a.func0(eval_expr(p, e->param[0]));
157 case e_func1: return e->value * e->a.func1(p->opaque, eval_expr(p, e->param[0]));
158 case e_func2: return e->value * e->a.func2(p->opaque, eval_expr(p, e->param[0]), eval_expr(p, e->param[1]));
159 case e_squish: return 1/(1+exp(4*eval_expr(p, e->param[0])));
160 case e_gauss: { double d = eval_expr(p, e->param[0]); return exp(-d*d/2)/sqrt(2*M_PI); }
161 case e_ld: return e->value * p->var[av_clip(eval_expr(p, e->param[0]), 0, VARS-1)];
162 case e_isnan: return e->value * !!isnan(eval_expr(p, e->param[0]));
163 case e_floor: return e->value * floor(eval_expr(p, e->param[0]));
164 case e_ceil : return e->value * ceil (eval_expr(p, e->param[0]));
165 case e_trunc: return e->value * trunc(eval_expr(p, e->param[0]));
166 case e_sqrt: return e->value * sqrt (eval_expr(p, e->param[0]));
167 case e_not: return e->value * (eval_expr(p, e->param[0]) == 0);
169 int idx= av_clip(eval_expr(p, e->param[0]), 0, VARS-1);
170 uint64_t r= isnan(p->var[idx]) ? 0 : p->var[idx];
171 r= r*1664525+1013904223;
173 return e->value * (r * (1.0/UINT64_MAX));
177 while (eval_expr(p, e->param[0]))
178 d=eval_expr(p, e->param[1]);
182 double d = eval_expr(p, e->param[0]);
183 double d2 = eval_expr(p, e->param[1]);
185 case e_mod: return e->value * (d - floor(d/d2)*d2);
186 case e_gcd: return e->value * av_gcd(d,d2);
187 case e_max: return e->value * (d > d2 ? d : d2);
188 case e_min: return e->value * (d < d2 ? d : d2);
189 case e_eq: return e->value * (d == d2 ? 1.0 : 0.0);
190 case e_gt: return e->value * (d > d2 ? 1.0 : 0.0);
191 case e_gte: return e->value * (d >= d2 ? 1.0 : 0.0);
192 case e_pow: return e->value * pow(d, d2);
193 case e_mul: return e->value * (d * d2);
194 case e_div: return e->value * (d / d2);
195 case e_add: return e->value * (d + d2);
196 case e_last:return e->value * d2;
197 case e_st : return e->value * (p->var[av_clip(d, 0, VARS-1)]= d2);
198 case e_hypot:return e->value * (sqrt(d*d + d2*d2));
205 static int parse_expr(AVExpr **e, Parser *p);
207 void av_expr_free(AVExpr *e)
210 av_expr_free(e->param[0]);
211 av_expr_free(e->param[1]);
216 static int parse_primary(AVExpr **e, Parser *p)
218 AVExpr *d = av_mallocz(sizeof(AVExpr));
219 char *next = p->s, *s0 = p->s;
223 return AVERROR(ENOMEM);
226 d->value = av_strtod(p->s, &next);
235 /* named constants */
236 for (i=0; p->const_names && p->const_names[i]; i++) {
237 if (strmatch(p->s, p->const_names[i])) {
238 p->s+= strlen(p->const_names[i]);
240 d->a.const_index = i;
245 for (i = 0; i < FF_ARRAY_ELEMS(constants); i++) {
246 if (strmatch(p->s, constants[i].name)) {
247 p->s += strlen(constants[i].name);
249 d->value = constants[i].value;
255 p->s= strchr(p->s, '(');
257 av_log(p, AV_LOG_ERROR, "Undefined constant or missing '(' in '%s'\n", s0);
260 return AVERROR(EINVAL);
263 if (*next == '(') { // special case do-nothing
265 if ((ret = parse_expr(&d, p)) < 0)
267 if (p->s[0] != ')') {
268 av_log(p, AV_LOG_ERROR, "Missing ')' in '%s'\n", s0);
270 return AVERROR(EINVAL);
276 if ((ret = parse_expr(&(d->param[0]), p)) < 0) {
282 parse_expr(&d->param[1], p);
284 if (p->s[0] != ')') {
285 av_log(p, AV_LOG_ERROR, "Missing ')' or too many args in '%s'\n", s0);
287 return AVERROR(EINVAL);
292 if (strmatch(next, "sinh" )) d->a.func0 = sinh;
293 else if (strmatch(next, "cosh" )) d->a.func0 = cosh;
294 else if (strmatch(next, "tanh" )) d->a.func0 = tanh;
295 else if (strmatch(next, "sin" )) d->a.func0 = sin;
296 else if (strmatch(next, "cos" )) d->a.func0 = cos;
297 else if (strmatch(next, "tan" )) d->a.func0 = tan;
298 else if (strmatch(next, "atan" )) d->a.func0 = atan;
299 else if (strmatch(next, "asin" )) d->a.func0 = asin;
300 else if (strmatch(next, "acos" )) d->a.func0 = acos;
301 else if (strmatch(next, "exp" )) d->a.func0 = exp;
302 else if (strmatch(next, "log" )) d->a.func0 = log;
303 else if (strmatch(next, "abs" )) d->a.func0 = fabs;
304 else if (strmatch(next, "squish")) d->type = e_squish;
305 else if (strmatch(next, "gauss" )) d->type = e_gauss;
306 else if (strmatch(next, "mod" )) d->type = e_mod;
307 else if (strmatch(next, "max" )) d->type = e_max;
308 else if (strmatch(next, "min" )) d->type = e_min;
309 else if (strmatch(next, "eq" )) d->type = e_eq;
310 else if (strmatch(next, "gte" )) d->type = e_gte;
311 else if (strmatch(next, "gt" )) d->type = e_gt;
312 else if (strmatch(next, "lte" )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gt; }
313 else if (strmatch(next, "lt" )) { AVExpr *tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gte; }
314 else if (strmatch(next, "ld" )) d->type = e_ld;
315 else if (strmatch(next, "isnan" )) d->type = e_isnan;
316 else if (strmatch(next, "st" )) d->type = e_st;
317 else if (strmatch(next, "while" )) d->type = e_while;
318 else if (strmatch(next, "floor" )) d->type = e_floor;
319 else if (strmatch(next, "ceil" )) d->type = e_ceil;
320 else if (strmatch(next, "trunc" )) d->type = e_trunc;
321 else if (strmatch(next, "sqrt" )) d->type = e_sqrt;
322 else if (strmatch(next, "not" )) d->type = e_not;
323 else if (strmatch(next, "pow" )) d->type = e_pow;
324 else if (strmatch(next, "random")) d->type = e_random;
325 else if (strmatch(next, "hypot" )) d->type = e_hypot;
326 else if (strmatch(next, "gcd" )) d->type = e_gcd;
328 for (i=0; p->func1_names && p->func1_names[i]; i++) {
329 if (strmatch(next, p->func1_names[i])) {
330 d->a.func1 = p->funcs1[i];
337 for (i=0; p->func2_names && p->func2_names[i]; i++) {
338 if (strmatch(next, p->func2_names[i])) {
339 d->a.func2 = p->funcs2[i];
346 av_log(p, AV_LOG_ERROR, "Unknown function in '%s'\n", s0);
348 return AVERROR(EINVAL);
355 static AVExpr *new_eval_expr(int type, int value, AVExpr *p0, AVExpr *p1)
357 AVExpr *e = av_mallocz(sizeof(AVExpr));
367 static int parse_pow(AVExpr **e, Parser *p, int *sign)
369 *sign= (*p->s == '+') - (*p->s == '-');
371 return parse_primary(e, p);
374 static int parse_factor(AVExpr **e, Parser *p)
376 int sign, sign2, ret;
377 AVExpr *e0, *e1, *e2;
378 if ((ret = parse_pow(&e0, p, &sign)) < 0)
383 if ((ret = parse_pow(&e2, p, &sign2)) < 0) {
387 e0 = new_eval_expr(e_pow, 1, e1, e2);
391 return AVERROR(ENOMEM);
393 if (e0->param[1]) e0->param[1]->value *= (sign2|1);
395 if (e0) e0->value *= (sign|1);
401 static int parse_term(AVExpr **e, Parser *p)
404 AVExpr *e0, *e1, *e2;
405 if ((ret = parse_factor(&e0, p)) < 0)
407 while (p->s[0]=='*' || p->s[0]=='/') {
410 if ((ret = parse_factor(&e2, p)) < 0) {
414 e0 = new_eval_expr(c == '*' ? e_mul : e_div, 1, e1, e2);
418 return AVERROR(ENOMEM);
425 static int parse_subexpr(AVExpr **e, Parser *p)
428 AVExpr *e0, *e1, *e2;
429 if ((ret = parse_term(&e0, p)) < 0)
431 while (*p->s == '+' || *p->s == '-') {
433 if ((ret = parse_term(&e2, p)) < 0) {
437 e0 = new_eval_expr(e_add, 1, e1, e2);
441 return AVERROR(ENOMEM);
449 static int parse_expr(AVExpr **e, Parser *p)
452 AVExpr *e0, *e1, *e2;
453 if (p->stack_index <= 0) //protect against stack overflows
454 return AVERROR(EINVAL);
457 if ((ret = parse_subexpr(&e0, p)) < 0)
459 while (*p->s == ';') {
462 if ((ret = parse_subexpr(&e2, p)) < 0) {
466 e0 = new_eval_expr(e_last, 1, e1, e2);
470 return AVERROR(ENOMEM);
479 static int verify_expr(AVExpr *e)
484 case e_const: return 1;
497 return verify_expr(e->param[0]);
498 default: return verify_expr(e->param[0]) && verify_expr(e->param[1]);
502 int av_expr_parse(AVExpr **expr, const char *s,
503 const char * const *const_names,
504 const char * const *func1_names, double (* const *funcs1)(void *, double),
505 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
506 int log_offset, void *log_ctx)
510 char *w = av_malloc(strlen(s) + 1);
516 return AVERROR(ENOMEM);
519 if (!isspace(*s++)) *wp++ = s[-1];
525 p.const_names = const_names;
527 p.func1_names = func1_names;
529 p.func2_names = func2_names;
530 p.log_offset = log_offset;
533 if ((ret = parse_expr(&e, &p)) < 0)
537 av_log(&p, AV_LOG_ERROR, "Invalid chars '%s' at the end of expression '%s'\n", p.s, s0);
538 ret = AVERROR(EINVAL);
541 if (!verify_expr(e)) {
543 ret = AVERROR(EINVAL);
546 e->var= av_mallocz(sizeof(double) *VARS);
553 double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
558 p.const_values = const_values;
560 return eval_expr(&p, e);
563 int av_expr_parse_and_eval(double *d, const char *s,
564 const char * const *const_names, const double *const_values,
565 const char * const *func1_names, double (* const *funcs1)(void *, double),
566 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
567 void *opaque, int log_offset, void *log_ctx)
570 int ret = av_expr_parse(&e, s, const_names, func1_names, funcs1, func2_names, funcs2, log_offset, log_ctx);
576 *d = av_expr_eval(e, const_values, opaque);
578 return isnan(*d) ? AVERROR(EINVAL) : 0;
581 #if FF_API_OLD_EVAL_NAMES
583 int av_parse_expr(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)
589 return av_expr_parse(expr, s, const_names, func1_names, funcs1, func2_names, funcs2,
590 log_offset, log_ctx);
593 double av_eval_expr(AVExpr *e, const double *const_values, void *opaque)
595 return av_expr_eval(e, const_values, opaque);
598 int av_parse_and_eval_expr(double *res, const char *s,
599 const char * const *const_names, const double *const_values,
600 const char * const *func1_names, double (* const *funcs1)(void *, double),
601 const char * const *func2_names, double (* const *funcs2)(void *, double, double),
602 void *opaque, int log_offset, void *log_ctx)
604 return av_expr_parse_and_eval(res, s, const_names, const_values, func1_names, funcs1, func2_names, funcs2,
605 opaque, log_offset, log_ctx);
608 void av_free_expr(AVExpr *e)
613 #endif /* FF_API_OLD_EVAL_NAMES */
620 static double const_values[] = {
626 static const char *const_names[] = {
632 int main(int argc, char **argv)
636 const char **expr, *exprs[] = {
642 "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
663 "bar + PI + E + 100f*2 + foo",
664 "13k + 12f - foo(1, 2)",
669 /* compute 1+2+...+N */
670 "st(0, 1); while(lte(ld(0), 100), st(1, ld(1)+ld(0));st(0, ld(0)+1)); ld(1)",
672 "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)",
674 "st(0, 1); while(lte(ld(0),100), st(1, ld(1)+ld(0)); st(0, ld(0)+1))",
696 for (expr = exprs; *expr; expr++) {
697 printf("Evaluating '%s'\n", *expr);
698 av_expr_parse_and_eval(&d, *expr,
699 const_names, const_values,
700 NULL, NULL, NULL, NULL, NULL, 0, NULL);
702 printf("'%s' -> nan\n\n", *expr);
704 printf("'%s' -> %f\n\n", *expr, d);
708 av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
709 const_names, const_values,
710 NULL, NULL, NULL, NULL, NULL, 0, NULL);
711 printf("%f == 12.7\n", d);
712 av_expr_parse_and_eval(&d, "80G/80Gi",
713 const_names, const_values,
714 NULL, NULL, NULL, NULL, NULL, 0, NULL);
715 printf("%f == 0.931322575\n", d);
717 if (argc > 1 && !strcmp(argv[1], "-t")) {
718 for (i = 0; i < 1050; i++) {
720 av_expr_parse_and_eval(&d, "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
721 const_names, const_values,
722 NULL, NULL, NULL, NULL, NULL, 0, NULL);
723 STOP_TIMER("av_expr_parse_and_eval");