Mercurial > libavcodec.hg
annotate eval.h @ 11601:29fda2500178 libavcodec
Avoid the use of the symbol ff_expr_s for referencing AVExpr.
This way we have to deal only with struct AVExpr and AVExpr, which is
slightly less confusing as the association between the two symbols is
obvious.
author | stefano |
---|---|
date | Sun, 11 Apr 2010 18:44:51 +0000 |
parents | 192399381906 |
children | da95280256b4 |
rev | line source |
---|---|
3790 | 1 /* |
2 * simple arithmetic expression evaluator | |
3 * | |
4 * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at> | |
5 * | |
3947
c8c591fe26f8
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
3790
diff
changeset
|
6 * This file is part of FFmpeg. |
c8c591fe26f8
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
3790
diff
changeset
|
7 * |
c8c591fe26f8
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
3790
diff
changeset
|
8 * FFmpeg is free software; you can redistribute it and/or |
3790 | 9 * modify it under the terms of the GNU Lesser General Public |
10 * License as published by the Free Software Foundation; either | |
3947
c8c591fe26f8
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
3790
diff
changeset
|
11 * version 2.1 of the License, or (at your option) any later version. |
3790 | 12 * |
3947
c8c591fe26f8
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
3790
diff
changeset
|
13 * FFmpeg is distributed in the hope that it will be useful, |
3790 | 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 | |
3947
c8c591fe26f8
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
3790
diff
changeset
|
19 * License along with FFmpeg; if not, write to the Free Software |
3790 | 20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
21 */ | |
22 | |
23 /** | |
8718
e9d9d946f213
Use full internal pathname in doxygen @file directives.
diego
parents:
8320
diff
changeset
|
24 * @file libavcodec/eval.h |
3790 | 25 * eval header. |
26 */ | |
27 | |
7760 | 28 #ifndef AVCODEC_EVAL_H |
29 #define AVCODEC_EVAL_H | |
3790 | 30 |
11601
29fda2500178
Avoid the use of the symbol ff_expr_s for referencing AVExpr.
stefano
parents:
11599
diff
changeset
|
31 typedef struct AVExpr AVExpr; |
11595
116f25bad5fb
Move AVEvalExpr declaration at the beginning of the file, where it is
stefano
parents:
9886
diff
changeset
|
32 |
4138 | 33 /** |
34 * Parses and evaluates an expression. | |
4139 | 35 * Note, this is significantly slower than ff_parse_eval() |
4138 | 36 * @param s expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)" |
37 * @param func1 NULL terminated array of function pointers for functions which take 1 argument | |
38 * @param func2 NULL terminated array of function pointers for functions which take 2 arguments | |
39 * @param const_name NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0} | |
40 * @param func1_name NULL terminated array of zero terminated strings of func1 identifers | |
41 * @param func2_name NULL terminated array of zero terminated strings of func2 identifers | |
42 * @param error pointer to a char* which is set to an error message if something goes wrong | |
43 * @param const_value a zero terminated array of values for the identifers from const_name | |
44 * @param opaque a pointer which will be passed to all functions from func1 and func2 | |
45 * @return the value of the expression | |
46 */ | |
8320 | 47 double ff_eval2(const char *s, const double *const_value, const char * const *const_name, |
3790 | 48 double (**func1)(void *, double), const char **func1_name, |
8320 | 49 double (**func2)(void *, double, double), const char **func2_name, |
6324 | 50 void *opaque, const char **error); |
3790 | 51 |
4138 | 52 /** |
53 * Parses a expression. | |
54 * @param s expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)" | |
55 * @param func1 NULL terminated array of function pointers for functions which take 1 argument | |
56 * @param func2 NULL terminated array of function pointers for functions which take 2 arguments | |
57 * @param const_name NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0} | |
58 * @param func1_name NULL terminated array of zero terminated strings of func1 identifers | |
59 * @param func2_name NULL terminated array of zero terminated strings of func2 identifers | |
60 * @param error pointer to a char* which is set to an error message if something goes wrong | |
11597 | 61 * @return AVExpr which must be freed with ff_free_expr() by the user when it is not needed anymore |
4138 | 62 * NULL if anything went wrong |
63 */ | |
11596
e22a96273dc4
Rename AVEvalExpr to AVExpr, as suggested by Michael.
stefano
parents:
11595
diff
changeset
|
64 AVExpr * ff_parse(const char *s, const char * const *const_name, |
4081
cedb63307f3d
new optimized eval method, by seperating parsing and runtime
ods15
parents:
3947
diff
changeset
|
65 double (**func1)(void *, double), const char **func1_name, |
8320 | 66 double (**func2)(void *, double, double), const char **func2_name, |
6324 | 67 const char **error); |
4138 | 68 /** |
69 * Evaluates a previously parsed expression. | |
70 * @param const_value a zero terminated array of values for the identifers from ff_parse const_name | |
71 * @param opaque a pointer which will be passed to all functions from func1 and func2 | |
72 * @return the value of the expression | |
73 */ | |
11596
e22a96273dc4
Rename AVEvalExpr to AVExpr, as suggested by Michael.
stefano
parents:
11595
diff
changeset
|
74 double ff_parse_eval(AVExpr * e, const double *const_value, void *opaque); |
11597 | 75 |
11599 | 76 /** |
77 * Frees a parsed expression previously created with ff_parse(). | |
78 */ | |
11597 | 79 void ff_free_expr(AVExpr *e); |
4081
cedb63307f3d
new optimized eval method, by seperating parsing and runtime
ods15
parents:
3947
diff
changeset
|
80 |
9886 | 81 /** |
82 * Parses the string in numstr and returns its value as a double. If | |
83 * the string is empty, contains only whitespaces, or does not contain | |
84 * an initial substring that has the expected syntax for a | |
85 * floating-point number, no conversion is performed. In this case, | |
86 * returns a value of zero and the value returned in tail is the value | |
87 * of numstr. | |
88 * | |
89 * @param numstr a string representing a number, may contain one of | |
90 * the International System number postfixes, for example 'K', 'M', | |
91 * 'G'. If 'i' is appended after the postfix, powers of 2 are used | |
92 * instead of powers of 10. The 'B' postfix multiplies the value for | |
93 * 8, and can be appended after another postfix or used alone. This | |
94 * allows using for example 'KB', 'MiB', 'G' and 'B' as postfix. | |
95 * @param tail if non-NULL puts here the pointer to the char next | |
96 * after the last parsed character | |
9880 | 97 */ |
98 double av_strtod(const char *numstr, char **tail); | |
99 | |
7760 | 100 #endif /* AVCODEC_EVAL_H */ |