Replace use of OwnArrayPtr<Foo> with std::unique_ptr<Foo[]> in WebCore
[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 #include <memory>
53 G_BEGIN_DECLS
54 #include <gst/fft/gstfftf32.h>
55 G_END_DECLS
56 #endif // USE(WEBAUDIO_GSTREAMER)
57
58 #if USE(WEBAUDIO_OPENMAX_DL_FFT)
59 #include "dl/sp/api/armSP.h"
60 #include "dl/sp/api/omxSP.h"
61 #elif USE(WEBAUDIO_FFMPEG)
62 struct RDFTContext;
63 #endif
64
65 #endif // !USE_ACCELERATE_FFT
66
67 #if USE(WEBAUDIO_IPP)
68 #include <ipps.h>
69 #endif // USE(WEBAUDIO_IPP)
70
71 #if PLATFORM(NIX)
72 #include <public/FFTFrame.h>
73 #endif
74
75 #include <wtf/Forward.h>
76 #include <wtf/PassOwnPtr.h>
77 #include <wtf/Threading.h>
78
79 namespace WebCore {
80
81 // Defines the interface for an "FFT frame", an object which is able to perform a forward
82 // and reverse FFT, internally storing the resultant frequency-domain data.
83
84 class FFTFrame {
85 public:
86     // The constructors, destructor, and methods up to the CROSS-PLATFORM section have platform-dependent implementations.
87
88     FFTFrame(unsigned fftSize);
89     FFTFrame(); // creates a blank/empty frame for later use with createInterpolatedFrame()
90     FFTFrame(const FFTFrame& frame);
91     ~FFTFrame();
92
93     static void initialize();
94     static void cleanup();
95     void doFFT(const float* data);
96     void doInverseFFT(float* data);
97     void multiply(const FFTFrame& frame); // multiplies ourself with frame : effectively operator*=()
98
99     float* realData() const;
100     float* imagData() const;
101
102     void print(); // for debugging
103
104     // CROSS-PLATFORM
105     // The remaining public methods have cross-platform implementations:
106
107     // Interpolates from frame1 -> frame2 as x goes from 0.0 -> 1.0
108     static PassOwnPtr<FFTFrame> createInterpolatedFrame(const FFTFrame& frame1, const FFTFrame& frame2, double x);
109
110     void doPaddedFFT(const float* data, size_t dataSize); // zero-padding with dataSize <= fftSize
111     double extractAverageGroupDelay();
112     void addConstantGroupDelay(double sampleFrameDelay);
113
114     unsigned fftSize() const { return m_FFTSize; }
115     unsigned log2FFTSize() const { return m_log2FFTSize; }
116
117 private:
118     unsigned m_FFTSize;
119     unsigned m_log2FFTSize;
120
121     void interpolateFrequencyComponents(const FFTFrame& frame1, const FFTFrame& frame2, double x);
122
123 #if USE_ACCELERATE_FFT
124     DSPSplitComplex& dspSplitComplex() { return m_frame; }
125     DSPSplitComplex dspSplitComplex() const { return m_frame; }
126
127     static FFTSetup fftSetupForSize(unsigned fftSize);
128
129     static FFTSetup* fftSetups;
130
131     FFTSetup m_FFTSetup;
132
133     DSPSplitComplex m_frame;
134     AudioFloatArray m_realData;
135     AudioFloatArray m_imagData;
136 #else // !USE_ACCELERATE_FFT
137
138 #if USE(WEBAUDIO_MKL)
139     // Interleaves the planar real and imaginary data and returns a
140     // pointer to the resulting storage which can be used for in-place
141     // or out-of-place operations. FIXME: ideally all of the MKL
142     // routines would operate on planar data and this method would be
143     // removed.
144     float* getUpToDateComplexData();
145
146     static DFTI_DESCRIPTOR_HANDLE descriptorHandleForSize(unsigned fftSize);
147
148     static DFTI_DESCRIPTOR_HANDLE* descriptorHandles;
149
150     DFTI_DESCRIPTOR_HANDLE m_handle;
151     AudioFloatArray m_complexData;
152     AudioFloatArray m_realData;
153     AudioFloatArray m_imagData;
154 #endif // USE(WEBAUDIO_MKL)
155
156 #if USE(WEBAUDIO_FFMPEG)
157     static RDFTContext* contextForSize(unsigned fftSize, int trans);
158
159     RDFTContext* m_forwardContext;
160     RDFTContext* m_inverseContext;
161
162     float* getUpToDateComplexData();
163     AudioFloatArray m_complexData;
164     AudioFloatArray m_realData;
165     AudioFloatArray m_imagData;
166 #endif // USE(WEBAUDIO_FFMPEG)
167
168 #if USE(WEBAUDIO_GSTREAMER)
169     GstFFTF32* m_fft;
170     GstFFTF32* m_inverseFft;
171     std::unique_ptr<GstFFTF32Complex[]> m_complexData;
172     AudioFloatArray m_realData;
173     AudioFloatArray m_imagData;
174 #endif // USE(WEBAUDIO_GSTREAMER)
175
176 #if USE(WEBAUDIO_IPP)
177     Ipp8u* m_buffer;
178     IppsDFTSpec_R_32f* m_DFTSpec;
179
180     float* getUpToDateComplexData();
181     AudioFloatArray m_complexData;
182     AudioFloatArray m_realData;
183     AudioFloatArray m_imagData;
184 #endif // USE(WEBAUDIO_IPP)
185
186 #if PLATFORM(NIX)
187     void scalePlanarData(float scale);
188     OwnPtr<Nix::FFTFrame> m_fftFrame;
189 #endif // PLATFORM(NIX)
190
191 #if USE(WEBAUDIO_OPENMAX_DL_FFT)
192     static OMXFFTSpec_R_F32* contextForSize(unsigned log2FFTSize);
193
194     OMXFFTSpec_R_F32* m_forwardContext;
195     OMXFFTSpec_R_F32* m_inverseContext;
196
197     AudioFloatArray m_complexData;
198     AudioFloatArray m_realData;
199     AudioFloatArray m_imagData;
200 #endif
201     
202 #endif // !USE_ACCELERATE_FFT
203 };
204
205 } // namespace WebCore
206
207 #endif // FFTFrame_h