Change eval API to take parent log context and log level offset.
[libav.git] / libavcodec / eval.c
CommitLineData
3aa102be 1/*
3cedeeca 2 * Copyright (c) 2002-2006 Michael Niedermayer <michaelni@gmx.at>
b5c5a86b 3 * Copyright (c) 2006 Oded Shimon <ods15@ods15.dyndns.org>
3aa102be 4 *
b78e7197
DB
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
3aa102be
MN
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
b78e7197 10 * version 2.1 of the License, or (at your option) any later version.
3aa102be 11 *
b78e7197 12 * FFmpeg is distributed in the hope that it will be useful,
3aa102be
MN
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
b78e7197 18 * License along with FFmpeg; if not, write to the Free Software
5509bffa 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
3aa102be
MN
20 */
21
983e3246 22/**
ba87f080 23 * @file
983e3246
MN
24 * simple arithmetic expression evaluator.
25 *
3aa102be
MN
26 * see http://joe.hotchkiss.com/programming/eval/eval.html
27 */
28
6c71d2c1 29#include "libavutil/avutil.h"
9a88c1df
MR
30#include "eval.h"
31
3aa102be 32typedef struct Parser{
2b65bb45 33 const AVClass *class;
3aa102be
MN
34 int stack_index;
35 char *s;
cac55c91
AG
36 const double *const_value;
37 const char * const *const_name; // NULL terminated
fc7e2d34 38 double (* const *func1)(void *, double a); // NULL terminated
82fdcd44 39 const char * const *func1_name; // NULL terminated
fc7e2d34 40 double (* const *func2)(void *, double a, double b); // NULL terminated
82fdcd44 41 const char * const *func2_name; // NULL terminated
3aa102be 42 void *opaque;
2b65bb45
MN
43 int log_offset;
44 void *log_ctx;
835954e3
MN
45#define VARS 10
46 double var[VARS];
3aa102be
MN
47} Parser;
48
2b65bb45
MN
49static const AVClass class = { "Eval", av_default_item_name, NULL, LIBAVUTIL_VERSION_INT, offsetof(Parser,log_offset), offsetof(Parser,log_ctx) };
50
cf2baeb3 51static const int8_t si_prefixes['z' - 'E' + 1]={
95c99430
PI
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
1c2744d1 74double av_strtod(const char *numstr, char **tail) {
95c99430 75 double d;
95c99430 76 char *next;
e877eaac 77 d = strtod(numstr, &next);
95c99430 78 /* if parsing succeeded, check for and interpret postfixes */
e877eaac 79 if (next!=numstr) {
95c99430
PI
80
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;
a02142a5 96 next++;
95c99430
PI
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
5c91a675 106static int strmatch(const char *s, const char *prefix){
3aa102be
MN
107 int i;
108 for(i=0; prefix[i]; i++){
109 if(prefix[i] != s[i]) return 0;
110 }
111 return 1;
112}
113
a3731cad 114struct AVExpr {
85b4eb08
OS
115 enum {
116 e_value, e_const, e_func0, e_func1, e_func2,
835954e3 117 e_squish, e_gauss, e_ld,
85b4eb08
OS
118 e_mod, e_max, e_min, e_eq, e_gt, e_gte,
119 e_pow, e_mul, e_div, e_add,
45ee0e32 120 e_last, e_st, e_while,
85b4eb08
OS
121 } type;
122 double value; // is sign in other types
123 union {
124 int const_index;
125 double (*func0)(double);
126 double (*func1)(void *, double);
127 double (*func2)(void *, double, double);
128 } a;
a3731cad 129 struct AVExpr *param[2];
85b4eb08
OS
130};
131
073f6d5b 132static double eval_expr(Parser * p, AVExpr * e) {
85b4eb08
OS
133 switch (e->type) {
134 case e_value: return e->value;
135 case e_const: return e->value * p->const_value[e->a.const_index];
136 case e_func0: return e->value * e->a.func0(eval_expr(p, e->param[0]));
137 case e_func1: return e->value * e->a.func1(p->opaque, eval_expr(p, e->param[0]));
138 case e_func2: return e->value * e->a.func2(p->opaque, eval_expr(p, e->param[0]), eval_expr(p, e->param[1]));
139 case e_squish: return 1/(1+exp(4*eval_expr(p, e->param[0])));
140 case e_gauss: { double d = eval_expr(p, e->param[0]); return exp(-d*d/2)/sqrt(2*M_PI); }
f66e4f5f 141 case e_ld: return e->value * p->var[av_clip(eval_expr(p, e->param[0]), 0, VARS-1)];
45ee0e32 142 case e_while: {
63a547ea 143 double d = NAN;
45ee0e32
MN
144 while(eval_expr(p, e->param[0]))
145 d=eval_expr(p, e->param[1]);
146 return d;
147 }
85b4eb08
OS
148 default: {
149 double d = eval_expr(p, e->param[0]);
150 double d2 = eval_expr(p, e->param[1]);
151 switch (e->type) {
152 case e_mod: return e->value * (d - floor(d/d2)*d2);
153 case e_max: return e->value * (d > d2 ? d : d2);
154 case e_min: return e->value * (d < d2 ? d : d2);
155 case e_eq: return e->value * (d == d2 ? 1.0 : 0.0);
156 case e_gt: return e->value * (d > d2 ? 1.0 : 0.0);
157 case e_gte: return e->value * (d >= d2 ? 1.0 : 0.0);
158 case e_pow: return e->value * pow(d, d2);
159 case e_mul: return e->value * (d * d2);
160 case e_div: return e->value * (d / d2);
161 case e_add: return e->value * (d + d2);
72523c7a 162 case e_last:return e->value * d2;
f66e4f5f 163 case e_st : return e->value * (p->var[av_clip(d, 0, VARS-1)]= d2);
85b4eb08
OS
164 }
165 }
166 }
167 return NAN;
168}
169
073f6d5b 170static AVExpr * parse_expr(Parser *p);
85b4eb08 171
f8fea468 172void ff_free_expr(AVExpr * e) {
85b4eb08 173 if (!e) return;
f8fea468
SS
174 ff_free_expr(e->param[0]);
175 ff_free_expr(e->param[1]);
85b4eb08
OS
176 av_freep(&e);
177}
178
073f6d5b
SS
179static AVExpr * parse_primary(Parser *p) {
180 AVExpr * d = av_mallocz(sizeof(AVExpr));
3aa102be
MN
181 char *next= p->s;
182 int i;
183
0345f36b
RP
184 if (!d)
185 return NULL;
186
3aa102be 187 /* number */
85b4eb08 188 d->value = av_strtod(p->s, &next);
3aa102be 189 if(next != p->s){
85b4eb08 190 d->type = e_value;
3aa102be 191 p->s= next;
67e11730 192 return d;
3aa102be 193 }
85b4eb08 194 d->value = 1;
115329f1 195
3aa102be 196 /* named constants */
b349fde1 197 for(i=0; p->const_name && p->const_name[i]; i++){
3aa102be 198 if(strmatch(p->s, p->const_name[i])){
3aa102be 199 p->s+= strlen(p->const_name[i]);
85b4eb08
OS
200 d->type = e_const;
201 d->a.const_index = i;
202 return d;
3aa102be
MN
203 }
204 }
115329f1 205
3aa102be
MN
206 p->s= strchr(p->s, '(');
207 if(p->s==NULL){
2b65bb45 208 av_log(p, AV_LOG_ERROR, "undefined constant or missing (\n");
e6b12001 209 p->s= next;
f8fea468 210 ff_free_expr(d);
85b4eb08 211 return NULL;
3aa102be
MN
212 }
213 p->s++; // "("
85b4eb08
OS
214 if (*next == '(') { // special case do-nothing
215 av_freep(&d);
216 d = parse_expr(p);
217 if(p->s[0] != ')'){
2b65bb45 218 av_log(p, AV_LOG_ERROR, "missing )\n");
f8fea468 219 ff_free_expr(d);
85b4eb08
OS
220 return NULL;
221 }
222 p->s++; // ")"
223 return d;
224 }
225 d->param[0] = parse_expr(p);
69f5de18
AB
226 if(p->s[0]== ','){
227 p->s++; // ","
85b4eb08 228 d->param[1] = parse_expr(p);
3aa102be 229 }
69f5de18 230 if(p->s[0] != ')'){
2b65bb45 231 av_log(p, AV_LOG_ERROR, "missing )\n");
f8fea468 232 ff_free_expr(d);
85b4eb08 233 return NULL;
69f5de18
AB
234 }
235 p->s++; // ")"
115329f1 236
85b4eb08
OS
237 d->type = e_func0;
238 if( strmatch(next, "sinh" ) ) d->a.func0 = sinh;
239 else if( strmatch(next, "cosh" ) ) d->a.func0 = cosh;
240 else if( strmatch(next, "tanh" ) ) d->a.func0 = tanh;
241 else if( strmatch(next, "sin" ) ) d->a.func0 = sin;
242 else if( strmatch(next, "cos" ) ) d->a.func0 = cos;
243 else if( strmatch(next, "tan" ) ) d->a.func0 = tan;
244 else if( strmatch(next, "atan" ) ) d->a.func0 = atan;
245 else if( strmatch(next, "asin" ) ) d->a.func0 = asin;
246 else if( strmatch(next, "acos" ) ) d->a.func0 = acos;
247 else if( strmatch(next, "exp" ) ) d->a.func0 = exp;
248 else if( strmatch(next, "log" ) ) d->a.func0 = log;
249 else if( strmatch(next, "abs" ) ) d->a.func0 = fabs;
250 else if( strmatch(next, "squish") ) d->type = e_squish;
251 else if( strmatch(next, "gauss" ) ) d->type = e_gauss;
252 else if( strmatch(next, "mod" ) ) d->type = e_mod;
253 else if( strmatch(next, "max" ) ) d->type = e_max;
254 else if( strmatch(next, "min" ) ) d->type = e_min;
255 else if( strmatch(next, "eq" ) ) d->type = e_eq;
85b4eb08 256 else if( strmatch(next, "gte" ) ) d->type = e_gte;
d024359a 257 else if( strmatch(next, "gt" ) ) d->type = e_gt;
073f6d5b
SS
258 else if( strmatch(next, "lte" ) ) { AVExpr * tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gt; }
259 else if( strmatch(next, "lt" ) ) { AVExpr * tmp = d->param[1]; d->param[1] = d->param[0]; d->param[0] = tmp; d->type = e_gte; }
835954e3
MN
260 else if( strmatch(next, "ld" ) ) d->type = e_ld;
261 else if( strmatch(next, "st" ) ) d->type = e_st;
45ee0e32 262 else if( strmatch(next, "while" ) ) d->type = e_while;
85b4eb08 263 else {
3aa102be
MN
264 for(i=0; p->func1_name && p->func1_name[i]; i++){
265 if(strmatch(next, p->func1_name[i])){
85b4eb08
OS
266 d->a.func1 = p->func1[i];
267 d->type = e_func1;
268 return d;
3aa102be
MN
269 }
270 }
271
272 for(i=0; p->func2_name && p->func2_name[i]; i++){
273 if(strmatch(next, p->func2_name[i])){
85b4eb08
OS
274 d->a.func2 = p->func2[i];
275 d->type = e_func2;
276 return d;
3aa102be
MN
277 }
278 }
279
2b65bb45 280 av_log(p, AV_LOG_ERROR, "unknown function\n");
f8fea468 281 ff_free_expr(d);
85b4eb08 282 return NULL;
3aa102be 283 }
b349fde1 284
67e11730 285 return d;
115329f1 286}
80a49958 287
073f6d5b
SS
288static AVExpr * new_eval_expr(int type, int value, AVExpr *p0, AVExpr *p1){
289 AVExpr * e = av_mallocz(sizeof(AVExpr));
0345f36b
RP
290 if (!e)
291 return NULL;
a98f4515
MN
292 e->type =type ;
293 e->value =value ;
294 e->param[0] =p0 ;
295 e->param[1] =p1 ;
296 return e;
297}
298
073f6d5b 299static AVExpr * parse_pow(Parser *p, int *sign){
2c409cc7
MN
300 *sign= (*p->s == '+') - (*p->s == '-');
301 p->s += *sign&1;
85b4eb08 302 return parse_primary(p);
3aa102be
MN
303}
304
073f6d5b 305static AVExpr * parse_factor(Parser *p){
2c409cc7 306 int sign, sign2;
073f6d5b 307 AVExpr * e = parse_pow(p, &sign);
3aa102be 308 while(p->s[0]=='^'){
3aa102be 309 p->s++;
577eab6b 310 e= new_eval_expr(e_pow, 1, e, parse_pow(p, &sign2));
0345f36b
RP
311 if (!e)
312 return NULL;
577eab6b 313 if (e->param[1]) e->param[1]->value *= (sign2|1);
3aa102be 314 }
85b4eb08
OS
315 if (e) e->value *= (sign|1);
316 return e;
3aa102be
MN
317}
318
073f6d5b
SS
319static AVExpr * parse_term(Parser *p){
320 AVExpr * e = parse_factor(p);
3aa102be 321 while(p->s[0]=='*' || p->s[0]=='/'){
a98f4515
MN
322 int c= *p->s++;
323 e= new_eval_expr(c == '*' ? e_mul : e_div, 1, e, parse_factor(p));
0345f36b
RP
324 if (!e)
325 return NULL;
3aa102be 326 }
85b4eb08 327 return e;
3aa102be
MN
328}
329
073f6d5b
SS
330static AVExpr * parse_subexpr(Parser *p) {
331 AVExpr * e = parse_term(p);
835954e3
MN
332 while(*p->s == '+' || *p->s == '-') {
333 e= new_eval_expr(e_add, 1, e, parse_term(p));
0345f36b
RP
334 if (!e)
335 return NULL;
835954e3
MN
336 };
337
338 return e;
339}
340
073f6d5b
SS
341static AVExpr * parse_expr(Parser *p) {
342 AVExpr * e;
3aa102be 343
67e11730 344 if(p->stack_index <= 0) //protect against stack overflows
85b4eb08 345 return NULL;
67e11730
MN
346 p->stack_index--;
347
835954e3 348 e = parse_subexpr(p);
85b4eb08 349
835954e3
MN
350 while(*p->s == ';') {
351 p->s++;
352 e= new_eval_expr(e_last, 1, e, parse_subexpr(p));
0345f36b
RP
353 if (!e)
354 return NULL;
85b4eb08 355 };
67e11730
MN
356
357 p->stack_index++;
358
85b4eb08 359 return e;
3aa102be
MN
360}
361
073f6d5b 362static int verify_expr(AVExpr * e) {
85b4eb08
OS
363 if (!e) return 0;
364 switch (e->type) {
365 case e_value:
366 case e_const: return 1;
367 case e_func0:
368 case e_func1:
369 case e_squish:
835954e3 370 case e_ld:
85b4eb08
OS
371 case e_gauss: return verify_expr(e->param[0]);
372 default: return verify_expr(e->param[0]) && verify_expr(e->param[1]);
373 }
374}
375
edd259f9
SS
376AVExpr *ff_parse_expr(const char *s,
377 const char * const *const_name,
378 const char * const *func1_name, double (* const *func1)(void *, double),
379 const char * const *func2_name, double (* const *func2)(void *, double, double),
2b65bb45
MN
380 int log_offset, void *log_ctx)
381{
3aa102be 382 Parser p;
073f6d5b 383 AVExpr *e = NULL;
0314dead
MR
384 char *w = av_malloc(strlen(s) + 1);
385 char *wp = w;
386
387 if (!w)
388 goto end;
8cd68d80
OS
389
390 while (*s)
391 if (!isspace(*s++)) *wp++ = s[-1];
392 *wp++ = 0;
115329f1 393
2b65bb45 394 p.class = &class;
67e11730 395 p.stack_index=100;
8cd68d80 396 p.s= w;
3aa102be
MN
397 p.const_name = const_name;
398 p.func1 = func1;
399 p.func1_name = func1_name;
400 p.func2 = func2;
401 p.func2_name = func2_name;
2b65bb45
MN
402 p.log_offset = log_offset;
403 p.log_ctx = log_ctx;
115329f1 404
85b4eb08
OS
405 e = parse_expr(&p);
406 if (!verify_expr(e)) {
f8fea468 407 ff_free_expr(e);
0314dead 408 e = NULL;
85b4eb08 409 }
0314dead
MR
410end:
411 av_free(w);
85b4eb08
OS
412 return e;
413}
414
4565caf1 415double ff_eval_expr(AVExpr * e, const double *const_value, void *opaque) {
85b4eb08
OS
416 Parser p;
417
418 p.const_value= const_value;
419 p.opaque = opaque;
420 return eval_expr(&p, e);
421}
422
edd259f9
SS
423double ff_parse_and_eval_expr(const char *s,
424 const char * const *const_name, const double *const_value,
425 const char * const *func1_name, double (* const *func1)(void *, double),
426 const char * const *func2_name, double (* const *func2)(void *, double, double),
2b65bb45
MN
427 void *opaque, int log_offset, void *log_ctx)
428{
429 AVExpr *e = ff_parse_expr(s, const_name, func1_name, func1, func2_name, func2, log_offset, log_ctx);
85b4eb08
OS
430 double d;
431 if (!e) return NAN;
4565caf1 432 d = ff_eval_expr(e, const_value, opaque);
f8fea468 433 ff_free_expr(e);
85b4eb08 434 return d;
3aa102be 435}
b349fde1
MN
436
437#ifdef TEST
115329f1 438#undef printf
b349fde1
MN
439static double const_values[]={
440 M_PI,
441 M_E,
442 0
443};
444static const char *const_names[]={
445 "PI",
446 "E",
447 0
448};
e5b10e31 449int main(void){
80a49958 450 int i;
2b65bb45 451 printf("%f == 12.7\n", ff_parse_and_eval_expr("1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)", const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, NULL));
edd259f9 452 printf("%f == 0.931322575\n", ff_parse_and_eval_expr("80G/80Gi", const_names, const_values, NULL, NULL, NULL, NULL, NULL, NULL));
115329f1 453
80a49958
MN
454 for(i=0; i<1050; i++){
455 START_TIMER
2b65bb45 456 ff_parse_and_eval_expr("1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)", const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, NULL);
a367be1e 457 STOP_TIMER("ff_parse_and_eval_expr")
80a49958 458 }
e5b10e31 459 return 0;
b349fde1
MN
460}
461#endif