6c15349d9718689e35393f8c0e5deb2a5823a44a
[WebKit-https.git] / Source / WebCore / platform / audio / FFTFrame.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef FFTFrame_h
30 #define FFTFrame_h
31
32 #include "AudioArray.h"
33
34 #if OS(DARWIN) && !USE(WEBAUDIO_FFMPEG)
35 #define USE_ACCELERATE_FFT 1
36 #else
37 #define USE_ACCELERATE_FFT 0
38 #endif
39
40 #if USE_ACCELERATE_FFT
41 #include <Accelerate/Accelerate.h>
42 #endif
43
44 #if !USE_ACCELERATE_FFT
45
46 #if USE(WEBAUDIO_MKL)
47 #include "mkl_dfti.h"
48 #endif // USE(WEBAUDIO_MKL)
49
50 #if USE(WEBAUDIO_GSTREAMER)
51 #include <glib.h>
52 G_BEGIN_DECLS
53 #include <gst/fft/gstfftf32.h>
54 G_END_DECLS
55 #endif // USE(WEBAUDIO_GSTREAMER)
56
57 #if USE(WEBAUDIO_FFMPEG)
58 struct RDFTContext;
59 #endif // USE(WEBAUDIO_FFMPEG)
60
61 #endif // !USE_ACCELERATE_FFT
62
63 #if USE(WEBAUDIO_IPP)
64 #include <ipps.h>
65 #endif // USE(WEBAUDIO_IPP)
66
67 #include <wtf/Forward.h>
68 #include <wtf/PassOwnPtr.h>
69 #include <wtf/Platform.h>
70 #include <wtf/Threading.h>
71
72 namespace WebCore {
73
74 // Defines the interface for an "FFT frame", an object which is able to perform a forward
75 // and reverse FFT, internally storing the resultant frequency-domain data.
76
77 class FFTFrame {
78 public:
79     // The constructors, destructor, and methods up to the CROSS-PLATFORM section have platform-dependent implementations.
80
81     FFTFrame(unsigned fftSize);
82     FFTFrame(); // creates a blank/empty frame for later use with createInterpolatedFrame()
83     FFTFrame(const FFTFrame& frame);
84     ~FFTFrame();
85
86     static void initialize();
87     static void cleanup();
88     void doFFT(const float* data);
89     void doInverseFFT(float* data);
90     void multiply(const FFTFrame& frame); // multiplies ourself with frame : effectively operator*=()
91
92     float* realData() const;
93     float* imagData() const;
94
95     void print(); // for debugging
96
97     // CROSS-PLATFORM
98     // The remaining public methods have cross-platform implementations:
99
100     // Interpolates from frame1 -> frame2 as x goes from 0.0 -> 1.0
101     static PassOwnPtr<FFTFrame> createInterpolatedFrame(const FFTFrame& frame1, const FFTFrame& frame2, double x);
102
103     void doPaddedFFT(const float* data, size_t dataSize); // zero-padding with dataSize <= fftSize
104     double extractAverageGroupDelay();
105     void addConstantGroupDelay(double sampleFrameDelay);
106
107     unsigned fftSize() const { return m_FFTSize; }
108     unsigned log2FFTSize() const { return m_log2FFTSize; }
109
110     void reportMemoryUsage(MemoryObjectInfo*) const;
111
112 private:
113     unsigned m_FFTSize;
114     unsigned m_log2FFTSize;
115
116     void interpolateFrequencyComponents(const FFTFrame& frame1, const FFTFrame& frame2, double x);
117
118 #if USE_ACCELERATE_FFT
119     DSPSplitComplex& dspSplitComplex() { return m_frame; }
120     DSPSplitComplex dspSplitComplex() const { return m_frame; }
121
122     static FFTSetup fftSetupForSize(unsigned fftSize);
123
124     static FFTSetup* fftSetups;
125
126     FFTSetup m_FFTSetup;
127
128     DSPSplitComplex m_frame;
129     AudioFloatArray m_realData;
130     AudioFloatArray m_imagData;
131 #else // !USE_ACCELERATE_FFT
132
133 #if USE(WEBAUDIO_MKL)
134     // Interleaves the planar real and imaginary data and returns a
135     // pointer to the resulting storage which can be used for in-place
136     // or out-of-place operations. FIXME: ideally all of the MKL
137     // routines would operate on planar data and this method would be
138     // removed.
139     float* getUpToDateComplexData();
140
141     static DFTI_DESCRIPTOR_HANDLE descriptorHandleForSize(unsigned fftSize);
142
143     static DFTI_DESCRIPTOR_HANDLE* descriptorHandles;
144
145     DFTI_DESCRIPTOR_HANDLE m_handle;
146     AudioFloatArray m_complexData;
147     AudioFloatArray m_realData;
148     AudioFloatArray m_imagData;
149 #endif // USE(WEBAUDIO_MKL)
150
151 #if USE(WEBAUDIO_FFMPEG)
152     static RDFTContext* contextForSize(unsigned fftSize, int trans);
153
154     RDFTContext* m_forwardContext;
155     RDFTContext* m_inverseContext;
156
157     float* getUpToDateComplexData();
158     AudioFloatArray m_complexData;
159     AudioFloatArray m_realData;
160     AudioFloatArray m_imagData;
161 #endif // USE(WEBAUDIO_FFMPEG)
162
163 #if USE(WEBAUDIO_GSTREAMER)
164     GstFFTF32* m_fft;
165     GstFFTF32* m_inverseFft;
166     GstFFTF32Complex* m_complexData;
167     AudioFloatArray m_realData;
168     AudioFloatArray m_imagData;
169 #endif // USE(WEBAUDIO_GSTREAMER)
170
171 #if USE(WEBAUDIO_IPP)
172     Ipp8u* m_buffer;
173     IppsDFTSpec_R_32f* m_DFTSpec;
174
175     float* getUpToDateComplexData();
176     AudioFloatArray m_complexData;
177     AudioFloatArray m_realData;
178     AudioFloatArray m_imagData;
179 #endif // USE(WEBAUDIO_IPP)
180
181 #endif // !USE_ACCELERATE_FFT
182 };
183
184 } // namespace WebCore
185
186 #endif // FFTFrame_h