Add methods to compute magnitude and phase response for biquads
[WebKit-https.git] / Source / WebCore / webaudio / BiquadProcessor.cpp
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 #include "config.h"
26
27 #if ENABLE(WEB_AUDIO)
28
29 #include "BiquadProcessor.h"
30
31 #include "BiquadDSPKernel.h"
32
33 namespace WebCore {
34     
35 BiquadProcessor::BiquadProcessor(float sampleRate, size_t numberOfChannels, bool autoInitialize)
36     : AudioDSPKernelProcessor(sampleRate, numberOfChannels)
37     , m_type(LowPass)
38     , m_parameter1(0)
39     , m_parameter2(0)
40     , m_parameter3(0)
41     , m_filterCoefficientsDirty(true)
42 {
43     double nyquist = 0.5 * this->sampleRate();
44
45     // Create parameters for BiquadFilterNode.
46     m_parameter1 = AudioParam::create("frequency", 350.0, 10.0, nyquist);
47     m_parameter2 = AudioParam::create("Q", 1, 0.0001, 1000.0);
48     m_parameter3 = AudioParam::create("gain", 0.0, -40, 40);
49
50     if (autoInitialize)
51         initialize();
52 }
53
54 BiquadProcessor::BiquadProcessor(FilterType type, float sampleRate, size_t numberOfChannels, bool autoInitialize)
55     : AudioDSPKernelProcessor(sampleRate, numberOfChannels)
56     , m_type(type)
57     , m_parameter1(0)
58     , m_parameter2(0)
59     , m_parameter3(0)
60     , m_filterCoefficientsDirty(true)
61 {
62     double nyquist = 0.5 * this->sampleRate();
63     
64     // Handle the deprecated LowPass2FilterNode and HighPass2FilterNode.
65     switch (type) {
66     // Highpass and lowpass share the same parameters and only differ in filter type.
67     case LowPass:
68     case HighPass:
69         m_parameter1 = AudioParam::create("frequency", 350.0, 20.0, nyquist);
70         m_parameter2 = AudioParam::create("resonance", 0.0, -20.0, 20.0);
71         m_parameter3 = AudioParam::create("unused", 0.0, 0.0, 1.0);
72         break;
73
74     default:
75         ASSERT_NOT_REACHED();
76     }
77
78     if (autoInitialize)
79         initialize();
80 }
81
82 BiquadProcessor::~BiquadProcessor()
83 {
84     if (isInitialized())
85         uninitialize();
86 }
87
88 PassOwnPtr<AudioDSPKernel> BiquadProcessor::createKernel()
89 {
90     return adoptPtr(new BiquadDSPKernel(this));
91 }
92
93 void BiquadProcessor::checkForDirtyCoefficients()
94 {
95     // Deal with smoothing / de-zippering. Start out assuming filter parameters are not changing.
96
97     // The BiquadDSPKernel objects rely on this value to see if they need to re-compute their internal filter coefficients.
98     m_filterCoefficientsDirty = false;
99     
100     if (m_hasJustReset) {
101         // Snap to exact values first time after reset, then smooth for subsequent changes.
102         m_parameter1->resetSmoothedValue();
103         m_parameter2->resetSmoothedValue();
104         m_parameter3->resetSmoothedValue();
105         m_filterCoefficientsDirty = true;
106         m_hasJustReset = false;
107     } else {
108         // Smooth all of the filter parameters. If they haven't yet converged to their target value then mark coefficients as dirty.
109         bool isStable1 = m_parameter1->smooth();
110         bool isStable2 = m_parameter2->smooth();
111         bool isStable3 = m_parameter3->smooth();
112         if (!(isStable1 && isStable2 && isStable3))
113             m_filterCoefficientsDirty = true;
114     }
115 }
116
117 void BiquadProcessor::process(AudioBus* source, AudioBus* destination, size_t framesToProcess)
118 {
119     if (!isInitialized()) {
120         destination->zero();
121         return;
122     }
123         
124     checkForDirtyCoefficients();
125             
126     // For each channel of our input, process using the corresponding BiquadDSPKernel into the output channel.
127     for (unsigned i = 0; i < m_kernels.size(); ++i)
128         m_kernels[i]->process(source->channel(i)->data(), destination->channel(i)->data(), framesToProcess);
129 }
130
131 void BiquadProcessor::setType(FilterType type)
132 {
133     if (type != m_type) {
134         m_type = type;
135         reset(); // The filter state must be reset only if the type has changed.
136     }
137 }
138
139 void BiquadProcessor::getFrequencyResponse(int nFrequencies,
140                                            const float* frequencyHz,
141                                            float* magResponse,
142                                            float* phaseResponse)
143 {
144     // Compute the frequency response on a separate temporary kernel
145     // to avoid interfering with the processing running in the audio
146     // thread on the main kernels.
147     
148     OwnPtr<BiquadDSPKernel> responseKernel = adoptPtr(new BiquadDSPKernel(this));
149
150     responseKernel->getFrequencyResponse(nFrequencies, frequencyHz, magResponse, phaseResponse);
151 }
152
153 } // namespace WebCore
154
155 #endif // ENABLE(WEB_AUDIO)