Change license headers to say 'FFmpeg' instead of 'this program/this library'
[ffmpeg.git] / libavcodec / eval.c
1 /*
2  * simple arithmetic expression evaluator
3  *
4  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  */
23
24 /**
25  * @file eval.c
26  * simple arithmetic expression evaluator.
27  *
28  * see http://joe.hotchkiss.com/programming/eval/eval.html
29  */
30
31 #include "avcodec.h"
32 #include "mpegvideo.h"
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <math.h>
38
39 #ifndef NAN
40   #define NAN 0.0/0.0
41 #endif
42
43 #ifndef M_PI
44 #define M_PI 3.14159265358979323846
45 #endif
46
47 typedef struct Parser{
48     int stack_index;
49     char *s;
50     double *const_value;
51     const char **const_name;          // NULL terminated
52     double (**func1)(void *, double a); // NULL terminated
53     const char **func1_name;          // NULL terminated
54     double (**func2)(void *, double a, double b); // NULL terminated
55     char **func2_name;          // NULL terminated
56     void *opaque;
57     char **error;
58 } Parser;
59
60 static double evalExpression(Parser *p);
61
62 static int8_t si_prefixes['z' - 'E' + 1]={
63     ['y'-'E']= -24,
64     ['z'-'E']= -21,
65     ['a'-'E']= -18,
66     ['f'-'E']= -15,
67     ['p'-'E']= -12,
68     ['n'-'E']= - 9,
69     ['u'-'E']= - 6,
70     ['m'-'E']= - 3,
71     ['c'-'E']= - 2,
72     ['d'-'E']= - 1,
73     ['h'-'E']=   2,
74     ['k'-'E']=   3,
75     ['K'-'E']=   3,
76     ['M'-'E']=   6,
77     ['G'-'E']=   9,
78     ['T'-'E']=  12,
79     ['P'-'E']=  15,
80     ['E'-'E']=  18,
81     ['Z'-'E']=  21,
82     ['Y'-'E']=  24,
83 };
84
85 /** strtod() function extended with 'k', 'M', 'G', 'ki', 'Mi', 'Gi' and 'B'
86  * postfixes.  This allows using f.e. kB, MiB, G and B as a postfix. This
87  * function assumes that the unit of numbers is bits not bytes.
88  */
89 static double av_strtod(const char *name, char **tail) {
90     double d;
91     char *next;
92     d = strtod(name, &next);
93     /* if parsing succeeded, check for and interpret postfixes */
94     if (next!=name) {
95
96         if(*next >= 'E' && *next <= 'z'){
97             int e= si_prefixes[*next - 'E'];
98             if(e){
99                 if(next[1] == 'i'){
100                     d*= pow( 2, e/0.3);
101                     next+=2;
102                 }else{
103                     d*= pow(10, e);
104                     next++;
105                 }
106             }
107         }
108
109         if(*next=='B') {
110             d*=8;
111             *next++;
112         }
113     }
114     /* if requested, fill in tail with the position after the last parsed
115        character */
116     if (tail)
117         *tail = next;
118     return d;
119 }
120
121 static int strmatch(const char *s, const char *prefix){
122     int i;
123     for(i=0; prefix[i]; i++){
124         if(prefix[i] != s[i]) return 0;
125     }
126     return 1;
127 }
128
129 static double evalPrimary(Parser *p){
130     double d, d2=NAN;
131     char *next= p->s;
132     int i;
133
134     /* number */
135     d= av_strtod(p->s, &next);
136     if(next != p->s){
137         p->s= next;
138         return d;
139     }
140
141     /* named constants */
142     for(i=0; p->const_name && p->const_name[i]; i++){
143         if(strmatch(p->s, p->const_name[i])){
144             p->s+= strlen(p->const_name[i]);
145             return p->const_value[i];
146         }
147     }
148
149     p->s= strchr(p->s, '(');
150     if(p->s==NULL){
151         *p->error = "missing (";
152         p->s= next;
153         return NAN;
154     }
155     p->s++; // "("
156     d= evalExpression(p);
157     if(p->s[0]== ','){
158         p->s++; // ","
159         d2= evalExpression(p);
160     }
161     if(p->s[0] != ')'){
162         *p->error = "missing )";
163         return NAN;
164     }
165     p->s++; // ")"
166
167          if( strmatch(next, "sinh"  ) ) d= sinh(d);
168     else if( strmatch(next, "cosh"  ) ) d= cosh(d);
169     else if( strmatch(next, "tanh"  ) ) d= tanh(d);
170     else if( strmatch(next, "sin"   ) ) d= sin(d);
171     else if( strmatch(next, "cos"   ) ) d= cos(d);
172     else if( strmatch(next, "tan"   ) ) d= tan(d);
173     else if( strmatch(next, "exp"   ) ) d= exp(d);
174     else if( strmatch(next, "log"   ) ) d= log(d);
175     else if( strmatch(next, "squish") ) d= 1/(1+exp(4*d));
176     else if( strmatch(next, "gauss" ) ) d= exp(-d*d/2)/sqrt(2*M_PI);
177     else if( strmatch(next, "abs"   ) ) d= fabs(d);
178     else if( strmatch(next, "max"   ) ) d= d >  d2 ?   d : d2;
179     else if( strmatch(next, "min"   ) ) d= d <  d2 ?   d : d2;
180     else if( strmatch(next, "gt"    ) ) d= d >  d2 ? 1.0 : 0.0;
181     else if( strmatch(next, "gte"   ) ) d= d >= d2 ? 1.0 : 0.0;
182     else if( strmatch(next, "lt"    ) ) d= d >  d2 ? 0.0 : 1.0;
183     else if( strmatch(next, "lte"   ) ) d= d >= d2 ? 0.0 : 1.0;
184     else if( strmatch(next, "eq"    ) ) d= d == d2 ? 1.0 : 0.0;
185     else if( strmatch(next, "("     ) ) d= d;
186 //    else if( strmatch(next, "l1"    ) ) d= 1 + d2*(d - 1);
187 //    else if( strmatch(next, "sq01"  ) ) d= (d >= 0.0 && d <=1.0) ? 1.0 : 0.0;
188     else{
189         for(i=0; p->func1_name && p->func1_name[i]; i++){
190             if(strmatch(next, p->func1_name[i])){
191                 return p->func1[i](p->opaque, d);
192             }
193         }
194
195         for(i=0; p->func2_name && p->func2_name[i]; i++){
196             if(strmatch(next, p->func2_name[i])){
197                 return p->func2[i](p->opaque, d, d2);
198             }
199         }
200
201         *p->error = "unknown function";
202         return NAN;
203     }
204
205     return d;
206 }
207
208 static double evalPow(Parser *p){
209     int sign= (*p->s == '+') - (*p->s == '-');
210     p->s += sign&1;
211     return (sign|1) * evalPrimary(p);
212 }
213
214 static double evalFactor(Parser *p){
215     double ret= evalPow(p);
216     while(p->s[0]=='^'){
217         p->s++;
218         ret= pow(ret, evalPow(p));
219     }
220     return ret;
221 }
222
223 static double evalTerm(Parser *p){
224     double ret= evalFactor(p);
225     while(p->s[0]=='*' || p->s[0]=='/'){
226         if(*p->s++ == '*') ret*= evalFactor(p);
227         else               ret/= evalFactor(p);
228     }
229     return ret;
230 }
231
232 static double evalExpression(Parser *p){
233     double ret= 0;
234
235     if(p->stack_index <= 0) //protect against stack overflows
236         return NAN;
237     p->stack_index--;
238
239     do{
240         ret += evalTerm(p);
241     }while(*p->s == '+' || *p->s == '-');
242
243     p->stack_index++;
244
245     return ret;
246 }
247
248 double ff_eval2(char *s, double *const_value, const char **const_name,
249                double (**func1)(void *, double), const char **func1_name,
250                double (**func2)(void *, double, double), char **func2_name,
251                void *opaque, char **error){
252     Parser p;
253
254     p.stack_index=100;
255     p.s= s;
256     p.const_value= const_value;
257     p.const_name = const_name;
258     p.func1      = func1;
259     p.func1_name = func1_name;
260     p.func2      = func2;
261     p.func2_name = func2_name;
262     p.opaque     = opaque;
263     p.error= error;
264
265     return evalExpression(&p);
266 }
267
268 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
269 attribute_deprecated double ff_eval(char *s, double *const_value, const char **const_name,
270                double (**func1)(void *, double), const char **func1_name,
271                double (**func2)(void *, double, double), char **func2_name,
272                void *opaque){
273     char *error=NULL;
274     double ret;
275     ret = ff_eval2(s, const_value, const_name, func1, func1_name, func2, func2_name, opaque, &error);
276     if (error)
277         av_log(NULL, AV_LOG_ERROR, "Error evaluating \"%s\": %s\n", s, error);
278     return ret;
279 }
280 #endif
281
282 #ifdef TEST
283 #undef printf
284 static double const_values[]={
285     M_PI,
286     M_E,
287     0
288 };
289 static const char *const_names[]={
290     "PI",
291     "E",
292     0
293 };
294 main(){
295     int i;
296     printf("%f == 12.7\n", ff_eval("1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)", const_values, const_names, NULL, NULL, NULL, NULL, NULL));
297     printf("%f == 0.931322575\n", ff_eval("80G/80Gi", const_values, const_names, NULL, NULL, NULL, NULL, NULL));
298
299     for(i=0; i<1050; i++){
300         START_TIMER
301             ff_eval("1+(5-2)^(3-1)+1/2+sin(PI)-max(-2.2,-3.1)", const_values, const_names, NULL, NULL, NULL, NULL, NULL);
302         STOP_TIMER("ff_eval")
303     }
304 }
305 #endif