Add methods to compute magnitude and phase response for biquads
[WebKit-https.git] / Source / WebCore / webaudio / BiquadProcessor.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  * 1.  Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef BiquadProcessor_h
26 #define BiquadProcessor_h
27
28 #include "AudioDSPKernel.h"
29 #include "AudioDSPKernelProcessor.h"
30 #include "AudioNode.h"
31 #include "AudioParam.h"
32 #include "Biquad.h"
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37 // BiquadProcessor is an AudioDSPKernelProcessor which uses Biquad objects to implement several common filters.
38
39 class BiquadProcessor : public AudioDSPKernelProcessor {
40 public:
41     enum FilterType {
42         LowPass = 0,
43         HighPass = 1,
44         BandPass = 2,
45         LowShelf = 3,
46         HighShelf = 4,
47         Peaking = 5,
48         Notch = 6,
49         Allpass = 7
50     };
51
52     BiquadProcessor(float sampleRate, size_t numberOfChannels, bool autoInitialize);
53
54     // Old constructor used by deprecated LowPass2FilterNode and HighPass2FilterNode
55     BiquadProcessor(FilterType, float sampleRate, size_t numberOfChannels, bool autoInitialize = true);
56
57     virtual ~BiquadProcessor();
58     
59     virtual PassOwnPtr<AudioDSPKernel> createKernel();
60         
61     virtual void process(AudioBus* source, AudioBus* destination, size_t framesToProcess);
62
63     // Get the magnitude and phase response of the filter at the given
64     // set of frequencies (in Hz). The phase response is in radians.
65     void getFrequencyResponse(int nFrequencies,
66                               const float* frequencyHz,
67                               float* magResponse,
68                               float* phaseResponse);
69
70     void checkForDirtyCoefficients();
71     
72     bool filterCoefficientsDirty() const { return m_filterCoefficientsDirty; }
73
74     AudioParam* parameter1() { return m_parameter1.get(); }
75     AudioParam* parameter2() { return m_parameter2.get(); }
76     AudioParam* parameter3() { return m_parameter3.get(); }
77
78     FilterType type() const { return m_type; }
79     void setType(FilterType);
80
81 private:
82     FilterType m_type;
83
84     RefPtr<AudioParam> m_parameter1;
85     RefPtr<AudioParam> m_parameter2;
86     RefPtr<AudioParam> m_parameter3;
87
88     // so DSP kernels know when to re-compute coefficients
89     bool m_filterCoefficientsDirty;
90 };
91
92 } // namespace WebCore
93
94 #endif // BiquadProcessor_h