ffc64fbf53d5ef3f5861cd97ec63710a5a01e442
[WebKit-https.git] / Source / WebCore / Modules / 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(BaseAudioContext& context, float sampleRate, size_t numberOfChannels, bool autoInitialize)
36     : AudioDSPKernelProcessor(sampleRate, numberOfChannels)
37     , m_parameter1(AudioParam::create(context, "frequency", 350.0, 0.0, 0.5 * sampleRate, AutomationRate::ARate))
38     , m_parameter2(AudioParam::create(context, "Q", 1, -FLT_MAX, FLT_MAX, AutomationRate::ARate))
39     , m_parameter3(AudioParam::create(context, "gain", 0.0, -FLT_MAX, 40 * std::log10(std::numeric_limits<float>::max()), AutomationRate::ARate))
40     , m_parameter4(AudioParam::create(context, "detune", 0.0, -153600, 153600, AutomationRate::ARate))
41 {
42     if (autoInitialize)
43         initialize();
44 }
45
46 BiquadProcessor::~BiquadProcessor()
47 {
48     if (isInitialized())
49         uninitialize();
50 }
51
52 std::unique_ptr<AudioDSPKernel> BiquadProcessor::createKernel()
53 {
54     return makeUnique<BiquadDSPKernel>(this);
55 }
56
57 void BiquadProcessor::checkForDirtyCoefficients()
58 {
59     // Deal with smoothing / de-zippering. Start out assuming filter parameters are not changing.
60
61     // The BiquadDSPKernel objects rely on this value to see if they need to re-compute their internal filter coefficients.
62     m_filterCoefficientsDirty = false;
63     m_hasSampleAccurateValues = false;
64     
65     if (m_parameter1->hasSampleAccurateValues() || m_parameter2->hasSampleAccurateValues() || m_parameter3->hasSampleAccurateValues() || m_parameter4->hasSampleAccurateValues()) {
66         m_filterCoefficientsDirty = true;
67         m_hasSampleAccurateValues = true;
68
69         m_shouldUseARate = m_parameter1->automationRate() == AutomationRate::ARate
70             || m_parameter2->automationRate() == AutomationRate::ARate
71             || m_parameter3->automationRate() == AutomationRate::ARate
72             || m_parameter4->automationRate() == AutomationRate::ARate;
73     } else {
74         if (m_hasJustReset) {
75             // Snap to exact values first time after reset, then smooth for subsequent changes.
76             m_parameter1->resetSmoothedValue();
77             m_parameter2->resetSmoothedValue();
78             m_parameter3->resetSmoothedValue();
79             m_parameter4->resetSmoothedValue();
80             m_filterCoefficientsDirty = true;
81             m_hasJustReset = false;
82         } else {
83             // Smooth all of the filter parameters. If they haven't yet converged to their target value then mark coefficients as dirty.
84             bool isStable1 = m_parameter1->smooth();
85             bool isStable2 = m_parameter2->smooth();
86             bool isStable3 = m_parameter3->smooth();
87             bool isStable4 = m_parameter4->smooth();
88             if (!(isStable1 && isStable2 && isStable3 && isStable4))
89                 m_filterCoefficientsDirty = true;
90         }
91     }
92 }
93
94 void BiquadProcessor::process(const AudioBus* source, AudioBus* destination, size_t framesToProcess)
95 {
96     if (!isInitialized()) {
97         destination->zero();
98         return;
99     }
100         
101     checkForDirtyCoefficients();
102             
103     // For each channel of our input, process using the corresponding BiquadDSPKernel into the output channel.
104     for (unsigned i = 0; i < m_kernels.size(); ++i)
105         m_kernels[i]->process(source->channel(i)->data(), destination->channel(i)->mutableData(), framesToProcess);
106 }
107
108 void BiquadProcessor::processOnlyAudioParams(size_t framesToProcess)
109 {
110     float values[AudioUtilities::renderQuantumSize];
111     ASSERT(framesToProcess <= AudioUtilities::renderQuantumSize);
112
113     m_parameter1->calculateSampleAccurateValues(values, framesToProcess);
114     m_parameter2->calculateSampleAccurateValues(values, framesToProcess);
115     m_parameter3->calculateSampleAccurateValues(values, framesToProcess);
116     m_parameter4->calculateSampleAccurateValues(values, framesToProcess);
117 }
118
119 void BiquadProcessor::setType(BiquadFilterType type)
120 {
121     if (type != m_type) {
122         m_type = type;
123         reset(); // The filter state must be reset only if the type has changed.
124     }
125 }
126
127 void BiquadProcessor::getFrequencyResponse(unsigned nFrequencies, const float* frequencyHz, float* magResponse, float* phaseResponse)
128 {
129     // Compute the frequency response on a separate temporary kernel
130     // to avoid interfering with the processing running in the audio
131     // thread on the main kernels.
132     
133     auto responseKernel = makeUnique<BiquadDSPKernel>(this);
134
135     // Get a copy of the current biquad filter coefficients so we can update
136     // |responseKernel| with these values.
137     float cutoffFrequency = parameter1().value();
138     float q = parameter2().value();
139     float gain = parameter3().value();
140     float detune = parameter4().value();
141
142     responseKernel->updateCoefficients(1, &cutoffFrequency, &q, &gain, &detune);
143     responseKernel->getFrequencyResponse(nFrequencies, frequencyHz, magResponse, phaseResponse);
144 }
145
146 } // namespace WebCore
147
148 #endif // ENABLE(WEB_AUDIO)