ec57b36f791475aefb9a4d945102594d41b9ef93
[ffmpeg.git] / libavutil / float_dsp.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVUTIL_FLOAT_DSP_H
20 #define AVUTIL_FLOAT_DSP_H
21
22 typedef struct AVFloatDSPContext {
23     /**
24      * Calculate the product of two vectors of floats and store the result in
25      * a vector of floats.
26      *
27      * @param dst  output vector
28      *             constraints: 32-byte aligned
29      * @param src0 first input vector
30      *             constraints: 32-byte aligned
31      * @param src1 second input vector
32      *             constraints: 32-byte aligned
33      * @param len  number of elements in the input
34      *             constraints: multiple of 16
35      */
36     void (*vector_fmul)(float *dst, const float *src0, const float *src1,
37                         int len);
38
39     /**
40      * Multiply a vector of floats by a scalar float and add to
41      * destination vector.  Source and destination vectors must
42      * overlap exactly or not at all.
43      *
44      * @param dst result vector
45      *            constraints: 32-byte aligned
46      * @param src input vector
47      *            constraints: 32-byte aligned
48      * @param mul scalar value
49      * @param len length of vector
50      *            constraints: multiple of 16
51      */
52     void (*vector_fmac_scalar)(float *dst, const float *src, float mul,
53                                int len);
54
55     /**
56      * Multiply a vector of floats by a scalar float.  Source and
57      * destination vectors must overlap exactly or not at all.
58      *
59      * @param dst result vector
60      *            constraints: 16-byte aligned
61      * @param src input vector
62      *            constraints: 16-byte aligned
63      * @param mul scalar value
64      * @param len length of vector
65      *            constraints: multiple of 4
66      */
67     void (*vector_fmul_scalar)(float *dst, const float *src, float mul,
68                                int len);
69
70     /**
71      * Multiply a vector of double by a scalar double.  Source and
72      * destination vectors must overlap exactly or not at all.
73      *
74      * @param dst result vector
75      *            constraints: 32-byte aligned
76      * @param src input vector
77      *            constraints: 32-byte aligned
78      * @param mul scalar value
79      * @param len length of vector
80      *            constraints: multiple of 8
81      */
82     void (*vector_dmul_scalar)(double *dst, const double *src, double mul,
83                                int len);
84
85     /**
86      * Overlap/add with window function.
87      * Used primarily by MDCT-based audio codecs.
88      * Source and destination vectors must overlap exactly or not at all.
89      *
90      * @param dst  result vector
91      *             constraints: 16-byte aligned
92      * @param src0 first source vector
93      *             constraints: 16-byte aligned
94      * @param src1 second source vector
95      *             constraints: 16-byte aligned
96      * @param win  half-window vector
97      *             constraints: 16-byte aligned
98      * @param len  length of vector
99      *             constraints: multiple of 4
100      */
101     void (*vector_fmul_window)(float *dst, const float *src0,
102                                const float *src1, const float *win, int len);
103
104     /**
105      * Calculate the product of two vectors of floats, add a third vector of
106      * floats and store the result in a vector of floats.
107      *
108      * @param dst  output vector
109      *             constraints: 32-byte aligned
110      * @param src0 first input vector
111      *             constraints: 32-byte aligned
112      * @param src1 second input vector
113      *             constraints: 32-byte aligned
114      * @param src1 third input vector
115      *             constraints: 32-byte aligned
116      * @param len  number of elements in the input
117      *             constraints: multiple of 16
118      */
119     void (*vector_fmul_add)(float *dst, const float *src0, const float *src1,
120                             const float *src2, int len);
121
122     /**
123      * Calculate the product of two vectors of floats, and store the result
124      * in a vector of floats. The second vector of floats is iterated over
125      * in reverse order.
126      *
127      * @param dst  output vector
128      *             constraints: 32-byte aligned
129      * @param src0 first input vector
130      *             constraints: 32-byte aligned
131      * @param src1 second input vector
132      *             constraints: 32-byte aligned
133      * @param src1 third input vector
134      *             constraints: 32-byte aligned
135      * @param len  number of elements in the input
136      *             constraints: multiple of 16
137      */
138     void (*vector_fmul_reverse)(float *dst, const float *src0,
139                                 const float *src1, int len);
140
141     /**
142      * Calculate the sum and difference of two vectors of floats.
143      *
144      * @param v1  first input vector, sum output, 16-byte aligned
145      * @param v2  second input vector, difference output, 16-byte aligned
146      * @param len length of vectors, multiple of 4
147      */
148     void (*butterflies_float)(float *restrict v1, float *restrict v2, int len);
149 } AVFloatDSPContext;
150
151 /**
152  * Initialize a float DSP context.
153  *
154  * @param fdsp    float DSP context
155  * @param strict  setting to non-zero avoids using functions which may not be IEEE-754 compliant
156  */
157 void avpriv_float_dsp_init(AVFloatDSPContext *fdsp, int strict);
158
159
160 void ff_float_dsp_init_arm(AVFloatDSPContext *fdsp);
161 void ff_float_dsp_init_ppc(AVFloatDSPContext *fdsp, int strict);
162 void ff_float_dsp_init_x86(AVFloatDSPContext *fdsp);
163
164 #endif /* AVUTIL_FLOAT_DSP_H */