2011-06-03 Chris Rogers <crogers@google.com>
[WebKit-https.git] / Source / WebCore / webaudio / AudioGainNode.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 "AudioGainNode.h"
30
31 #include "AudioBus.h"
32 #include "AudioNodeInput.h"
33 #include "AudioNodeOutput.h"
34
35 namespace WebCore {
36
37 AudioGainNode::AudioGainNode(AudioContext* context, double sampleRate)
38     : AudioNode(context, sampleRate)
39     , m_lastGain(1.0)
40     , m_sampleAccurateGainValues(AudioNode::ProcessingSizeInFrames) // FIXME: can probably share temp buffer in context
41 {
42     m_gain = AudioGain::create("gain", 1.0, 0.0, 1.0);
43     m_gain->setContext(context);
44
45     addInput(adoptPtr(new AudioNodeInput(this)));
46     addOutput(adoptPtr(new AudioNodeOutput(this, 1)));
47     
48     setType(NodeTypeGain);
49     
50     initialize();
51 }
52
53 void AudioGainNode::process(size_t framesToProcess)
54 {
55     // FIXME: for some cases there is a nice optimization to avoid processing here, and let the gain change
56     // happen in the summing junction input of the AudioNode we're connected to.
57     // Then we can avoid all of the following:
58
59     AudioBus* outputBus = output(0)->bus();
60     ASSERT(outputBus);
61
62     // The realtime thread can't block on this lock, so we call tryLock() instead.
63     if (m_processLock.tryLock()) {
64         if (!isInitialized() || !input(0)->isConnected())
65             outputBus->zero();
66         else {
67             AudioBus* inputBus = input(0)->bus();
68
69             if (gain()->hasTimelineValues()) {
70                 // Apply sample-accurate gain scaling for precise envelopes, grain windows, etc.
71                 ASSERT(framesToProcess <= m_sampleAccurateGainValues.size());
72                 if (framesToProcess <= m_sampleAccurateGainValues.size()) {
73                     float* gainValues = m_sampleAccurateGainValues.data();
74                     gain()->calculateSampleAccurateValues(gainValues, framesToProcess);
75                     outputBus->copyWithSampleAccurateGainValuesFrom(*inputBus, gainValues, framesToProcess);
76                 }
77             } else {
78                 // Apply the gain with de-zippering into the output bus.
79                 outputBus->copyWithGainFrom(*inputBus, &m_lastGain, gain()->value());
80             }
81         }
82
83         m_processLock.unlock();
84     } else {
85         // Too bad - the tryLock() failed.  We must be in the middle of re-connecting and were already outputting silence anyway...
86         outputBus->zero();
87     }
88 }
89
90 void AudioGainNode::reset()
91 {
92     // Snap directly to desired gain.
93     m_lastGain = gain()->value();
94 }
95
96 // FIXME: this can go away when we do mixing with gain directly in summing junction of AudioNodeInput
97 //
98 // As soon as we know the channel count of our input, we can lazily initialize.
99 // Sometimes this may be called more than once with different channel counts, in which case we must safely
100 // uninitialize and then re-initialize with the new channel count.
101 void AudioGainNode::checkNumberOfChannelsForInput(AudioNodeInput* input)
102 {
103     ASSERT(input && input == this->input(0));
104     if (input != this->input(0))
105         return;
106         
107     unsigned numberOfChannels = input->numberOfChannels();    
108
109     if (isInitialized() && numberOfChannels != output(0)->numberOfChannels()) {
110         // We're already initialized but the channel count has changed.
111         // We need to be careful since we may be actively processing right now, so synchronize with process().
112         MutexLocker locker(m_processLock);
113         uninitialize();
114     }
115
116     if (!isInitialized()) {
117         // This will propagate the channel count to any nodes connected further downstream in the graph.
118         output(0)->setNumberOfChannels(numberOfChannels);
119         initialize();
120     }
121 }
122
123 } // namespace WebCore
124
125 #endif // ENABLE(WEB_AUDIO)