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
29 #include "libavutil/avutil.h"
32 typedef struct Parser {
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
49 static const AVClass class = { "Eval", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(Parser,log_offset), offsetof(Parser,log_ctx) };
51 static const int8_t si_prefixes['z' - 'E' + 1] = {
74 double av_strtod(const char *numstr, char **tail)
78 d = strtod(numstr, &next);
79 /* if parsing succeeded, check for and interpret postfixes */
81 if (*next >= 'E' && *next <= 'z') {
82 int e= si_prefixes[*next - 'E'];
99 /* if requested, fill in tail with the position after the last parsed
106 #define IS_IDENTIFIER_CHAR(c) ((c) - '0' <= 9U || (c) - 'a' <= 25U || (c) - 'A' <= 25U || (c) == '_')
108 static int strmatch(const char *s, const char *prefix)
111 for (i=0; prefix[i]; i++) {
112 if (prefix[i] != s[i]) return 0;
114 /* return 1 only if the s identifier is terminated */
115 return !IS_IDENTIFIER_CHAR(s[i]);
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,
127 double value; // is sign in other types
130 double (*func0)(double);
131 double (*func1)(void *, double);
132 double (*func2)(void *, double, double);
134 struct AVExpr *param[2];
137 static double eval_expr(Parser *p, AVExpr *e)
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]));
155 while (eval_expr(p, e->param[0]))
156 d=eval_expr(p, e->param[1]);
160 double d = eval_expr(p, e->param[0]);
161 double d2 = eval_expr(p, e->param[1]);
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);
181 static int parse_expr(AVExpr **e, Parser *p);
183 void av_expr_free(AVExpr *e)
186 av_expr_free(e->param[0]);
187 av_expr_free(e->param[1]);
191 static int parse_primary(AVExpr **e, Parser *p)
193 AVExpr *d = av_mallocz(sizeof(AVExpr));
194 char *next = p->s, *s0 = p->s;
198 return AVERROR(ENOMEM);
201 d->value = av_strtod(p->s, &next);
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]);
215 d->a.const_index = i;
221 p->s= strchr(p->s, '(');
223 av_log(p, AV_LOG_ERROR, "Undefined constant or missing '(' in '%s'\n", s0);
226 return AVERROR(EINVAL);
229 if (*next == '(') { // special case do-nothing
231 if ((ret = parse_expr(&d, p)) < 0)
233 if (p->s[0] != ')') {
234 av_log(p, AV_LOG_ERROR, "Missing ')' in '%s'\n", s0);
236 return AVERROR(EINVAL);
242 if ((ret = parse_expr(&(d->param[0]), p)) < 0) {
248 parse_expr(&d->param[1], p);
250 if (p->s[0] != ')') {
251 av_log(p, AV_LOG_ERROR, "Missing ')' or too many args in '%s'\n", s0);
253 return AVERROR(EINVAL);
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;
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];
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];
307 av_log(p, AV_LOG_ERROR, "Unknown function in '%s'\n", s0);
309 return AVERROR(EINVAL);
316 static AVExpr *new_eval_expr(int type, int value, AVExpr *p0, AVExpr *p1)
318 AVExpr *e = av_mallocz(sizeof(AVExpr));
328 static int parse_pow(AVExpr **e, Parser *p, int *sign)
330 *sign= (*p->s == '+') - (*p->s == '-');
332 return parse_primary(e, p);
335 static int parse_factor(AVExpr **e, Parser *p)
337 int sign, sign2, ret;
338 AVExpr *e0, *e1, *e2;
339 if ((ret = parse_pow(&e0, p, &sign)) < 0)
344 if ((ret = parse_pow(&e2, p, &sign2)) < 0) {
348 e0 = new_eval_expr(e_pow, 1, e1, e2);
352 return AVERROR(ENOMEM);
354 if (e0->param[1]) e0->param[1]->value *= (sign2|1);
356 if (e0) e0->value *= (sign|1);
362 static int parse_term(AVExpr **e, Parser *p)
365 AVExpr *e0, *e1, *e2;
366 if ((ret = parse_factor(&e0, p)) < 0)
368 while (p->s[0]=='*' || p->s[0]=='/') {
371 if ((ret = parse_factor(&e2, p)) < 0) {
375 e0 = new_eval_expr(c == '*' ? e_mul : e_div, 1, e1, e2);
379 return AVERROR(ENOMEM);
386 static int parse_subexpr(AVExpr **e, Parser *p)
389 AVExpr *e0, *e1, *e2;
390 if ((ret = parse_term(&e0, p)) < 0)
392 while (*p->s == '+' || *p->s == '-') {
394 if ((ret = parse_term(&e2, p)) < 0) {
398 e0 = new_eval_expr(e_add, 1, e1, e2);
402 return AVERROR(ENOMEM);
410 static int parse_expr(AVExpr **e, Parser *p)
413 AVExpr *e0, *e1, *e2;
414 if (p->stack_index <= 0) //protect against stack overflows
415 return AVERROR(EINVAL);
418 if ((ret = parse_subexpr(&e0, p)) < 0)
420 while (*p->s == ';') {
423 if ((ret = parse_subexpr(&e2, p)) < 0) {
427 e0 = new_eval_expr(e_last, 1, e1, e2);
431 return AVERROR(ENOMEM);
440 static int verify_expr(AVExpr *e)
445 case e_const: return 1;
456 return verify_expr(e->param[0]);
457 default: return verify_expr(e->param[0]) && verify_expr(e->param[1]);
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)
469 char *w = av_malloc(strlen(s) + 1);
475 return AVERROR(ENOMEM);
478 if (!isspace(*s++)) *wp++ = s[-1];
484 p.const_names = const_names;
486 p.func1_names = func1_names;
488 p.func2_names = func2_names;
489 p.log_offset = log_offset;
492 if ((ret = parse_expr(&e, &p)) < 0)
495 av_log(&p, AV_LOG_ERROR, "Invalid chars '%s' at the end of expression '%s'\n", p.s, s0);
496 ret = AVERROR(EINVAL);
499 if (!verify_expr(e)) {
501 ret = AVERROR(EINVAL);
510 double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
514 p.const_values = const_values;
516 return eval_expr(&p, e);
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)
526 int ret = av_expr_parse(&e, s, const_names, func1_names, funcs1, func2_names, funcs2, log_offset, log_ctx);
532 *d = av_expr_eval(e, const_values, opaque);
534 return isnan(*d) ? AVERROR(EINVAL) : 0;
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)
544 return av_expr_parse(expr, s, const_names, func1_names, funcs1, func2_names, funcs2,
545 log_offset, log_ctx);
548 double av_eval_expr(AVExpr *e, const double *const_values, void *opaque)
550 return av_expr_eval(e, const_values, opaque);
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)
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);
563 void av_free_expr(AVExpr *e)
567 #endif /* FF_API_OLD_EVAL_NAMES */
571 static double const_values[] = {
577 static const char *const_names[] = {
587 const char **expr, *exprs[] = {
593 "1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)",
614 "bar + PI + E + 100f*2 + foo",
615 "13k + 12f - foo(1, 2)",
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)",
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)",
625 "st(0, 1); while(lte(ld(0),100), st(1, ld(1)+ld(0)); st(0, ld(0)+1))",
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);
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);
657 for (i=0; i<1050; i++) {
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")