Remove redundant file descriptions from copyright headers.
[libav.git] / libavcodec / eval.h
1 /*
2 * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 /**
22 * @file libavcodec/eval.h
23 * simple arithmetic expression evaluator
24 */
25
26 #ifndef AVCODEC_EVAL_H
27 #define AVCODEC_EVAL_H
28
29 typedef struct AVExpr AVExpr;
30
31 /**
32 * Parses and evaluates an expression.
33 * Note, this is significantly slower than ff_parse_eval()
34 * @param s expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)"
35 * @param func1 NULL terminated array of function pointers for functions which take 1 argument
36 * @param func2 NULL terminated array of function pointers for functions which take 2 arguments
37 * @param const_name NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0}
38 * @param func1_name NULL terminated array of zero terminated strings of func1 identifers
39 * @param func2_name NULL terminated array of zero terminated strings of func2 identifers
40 * @param error pointer to a char* which is set to an error message if something goes wrong
41 * @param const_value a zero terminated array of values for the identifers from const_name
42 * @param opaque a pointer which will be passed to all functions from func1 and func2
43 * @return the value of the expression
44 */
45 double ff_eval2(const char *s, const double *const_value, const char * const *const_name,
46 double (**func1)(void *, double), const char **func1_name,
47 double (**func2)(void *, double, double), const char **func2_name,
48 void *opaque, const char **error);
49
50 /**
51 * Parses a expression.
52 * @param s expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)"
53 * @param func1 NULL terminated array of function pointers for functions which take 1 argument
54 * @param func2 NULL terminated array of function pointers for functions which take 2 arguments
55 * @param const_name NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0}
56 * @param func1_name NULL terminated array of zero terminated strings of func1 identifers
57 * @param func2_name NULL terminated array of zero terminated strings of func2 identifers
58 * @param error pointer to a char* which is set to an error message if something goes wrong
59 * @return AVExpr which must be freed with ff_free_expr() by the user when it is not needed anymore
60 * NULL if anything went wrong
61 */
62 AVExpr * ff_parse(const char *s, const char * const *const_name,
63 double (**func1)(void *, double), const char **func1_name,
64 double (**func2)(void *, double, double), const char **func2_name,
65 const char **error);
66 /**
67 * Evaluates a previously parsed expression.
68 * @param const_value a zero terminated array of values for the identifers from ff_parse const_name
69 * @param opaque a pointer which will be passed to all functions from func1 and func2
70 * @return the value of the expression
71 */
72 double ff_parse_eval(AVExpr * e, const double *const_value, void *opaque);
73
74 /**
75 * Frees a parsed expression previously created with ff_parse().
76 */
77 void ff_free_expr(AVExpr *e);
78
79 /**
80 * Parses the string in numstr and returns its value as a double. If
81 * the string is empty, contains only whitespaces, or does not contain
82 * an initial substring that has the expected syntax for a
83 * floating-point number, no conversion is performed. In this case,
84 * returns a value of zero and the value returned in tail is the value
85 * of numstr.
86 *
87 * @param numstr a string representing a number, may contain one of
88 * the International System number postfixes, for example 'K', 'M',
89 * 'G'. If 'i' is appended after the postfix, powers of 2 are used
90 * instead of powers of 10. The 'B' postfix multiplies the value for
91 * 8, and can be appended after another postfix or used alone. This
92 * allows using for example 'KB', 'MiB', 'G' and 'B' as postfix.
93 * @param tail if non-NULL puts here the pointer to the char next
94 * after the last parsed character
95 */
96 double av_strtod(const char *numstr, char **tail);
97
98 #endif /* AVCODEC_EVAL_H */