src/third_party/WebKit/Source/modules/webaudio/ConvolverNode.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 "modules/webaudio/ConvolverNode.h"
  30
  31 #include "bindings/core/v8/ExceptionState.h"
  32 #include "core/dom/ExceptionCode.h"
  33 #include "platform/audio/Reverb.h"
  34 #include "modules/webaudio/AudioBuffer.h"
  35 #include "modules/webaudio/AudioContext.h"
  36 #include "modules/webaudio/AudioNodeInput.h"
  37 #include "modules/webaudio/AudioNodeOutput.h"
  38 #include "wtf/MainThread.h"
  39
  40 // Note about empirical tuning:
  41 // The maximum FFT size affects reverb performance and accuracy.
  42 // If the reverb is single-threaded and processes entirely in the real-time audio thread,
  43 // it's important not to make this too high.  In this case 8192 is a good value.
  44 // But, the Reverb object is multi-threaded, so we want this as high as possible without losing too much accuracy.
  45 // Very large FFTs will have worse phase errors. Given these constraints 32768 is a good compromise.
  46 const size_t MaxFFTSize = 32768;
  47
  48 namespace blink {
  49
  50 ConvolverNode::ConvolverNode(AudioContext* context, float sampleRate)
  51     : AudioNode(context, sampleRate)
  52     , m_normalize(true)
  53 {
  54     ScriptWrappable::init(this);
  55     addInput();
  56     addOutput(AudioNodeOutput::create(this, 2));
  57
  58     // Node-specific default mixing rules.
  59     m_channelCount = 2;
  60     m_channelCountMode = ClampedMax;
  61     m_channelInterpretation = AudioBus::Speakers;
  62
  63     setNodeType(NodeTypeConvolver);
  64     initialize();
  65 }
  66
  67 ConvolverNode::~ConvolverNode()
  68 {
  69     ASSERT(!isInitialized());
  70 }
  71
  72 void ConvolverNode::dispose()
  73 {
  74     uninitialize();
  75     AudioNode::dispose();
  76 }
  77
  78 void ConvolverNode::process(size_t framesToProcess)
  79 {
  80     AudioBus* outputBus = output(0)->bus();
  81     ASSERT(outputBus);
  82
  83     // Synchronize with possible dynamic changes to the impulse response.
  84     MutexTryLocker tryLocker(m_processLock);
  85     if (tryLocker.locked()) {
  86         if (!isInitialized() || !m_reverb.get())
  87             outputBus->zero();
  88         else {
  89             // Process using the convolution engine.
  90             // Note that we can handle the case where nothing is connected to the input, in which case we'll just feed silence into the convolver.
  91             // FIXME:  If we wanted to get fancy we could try to factor in the 'tail time' and stop processing once the tail dies down if
  92             // we keep getting fed silence.
  93             m_reverb->process(input(0)->bus(), outputBus, framesToProcess);
  94         }
  95     } else {
  96         // Too bad - the tryLock() failed.  We must be in the middle of setting a new impulse response.
  97         outputBus->zero();
  98     }
  99 }
 100
 101 void ConvolverNode::initialize()
 102 {
 103     if (isInitialized())
 104         return;
 105
 106     AudioNode::initialize();
 107 }
 108
 109 void ConvolverNode::uninitialize()
 110 {
 111     if (!isInitialized())
 112         return;
 113
 114     m_reverb.clear();
 115     AudioNode::uninitialize();
 116 }
 117
 118 void ConvolverNode::setBuffer(AudioBuffer* buffer, ExceptionState& exceptionState)
 119 {
 120     ASSERT(isMainThread());
 121
 122     if (!buffer)
 123         return;
 124
 125     if (buffer->sampleRate() != context()->sampleRate()) {
 126         exceptionState.throwDOMException(
 127             NotSupportedError,
 128             "The buffer sample rate of " + String::number(buffer->sampleRate())
 129             + " does not match the context rate of " + String::number(context()->sampleRate())
 130             + " Hz.");
 131     }
 132
 133     unsigned numberOfChannels = buffer->numberOfChannels();
 134     size_t bufferLength = buffer->length();
 135
 136     // The current implementation supports up to four channel impulse responses, which are interpreted as true-stereo (see Reverb class).
 137     bool isBufferGood = numberOfChannels > 0 && numberOfChannels <= 4 && bufferLength;
 138     ASSERT(isBufferGood);
 139     if (!isBufferGood)
 140         return;
 141
 142     // Wrap the AudioBuffer by an AudioBus. It's an efficient pointer set and not a memcpy().
 143     // This memory is simply used in the Reverb constructor and no reference to it is kept for later use in that class.
 144     RefPtr<AudioBus> bufferBus = AudioBus::create(numberOfChannels, bufferLength, false);
 145     for (unsigned i = 0; i < numberOfChannels; ++i)
 146         bufferBus->setChannelMemory(i, buffer->getChannelData(i)->data(), bufferLength);
 147
 148     bufferBus->setSampleRate(buffer->sampleRate());
 149
 150     // Create the reverb with the given impulse response.
 151     bool useBackgroundThreads = !context()->isOfflineContext();
 152     OwnPtr<Reverb> reverb = adoptPtr(new Reverb(bufferBus.get(), AudioNode::ProcessingSizeInFrames, MaxFFTSize, 2, useBackgroundThreads, m_normalize));
 153
 154     {
 155         // Synchronize with process().
 156         MutexLocker locker(m_processLock);
 157         m_reverb = reverb.release();
 158         m_buffer = buffer;
 159     }
 160 }
 161
 162 AudioBuffer* ConvolverNode::buffer()
 163 {
 164     ASSERT(isMainThread());
 165     return m_buffer.get();
 166 }
 167
 168 double ConvolverNode::tailTime() const
 169 {
 170     MutexTryLocker tryLocker(m_processLock);
 171     if (tryLocker.locked())
 172         return m_reverb ? m_reverb->impulseResponseLength() / static_cast<double>(sampleRate()) : 0;
 173     // Since we don't want to block the Audio Device thread, we return a large value
 174     // instead of trying to acquire the lock.
 175     return std::numeric_limits<double>::infinity();
 176 }
 177
 178 double ConvolverNode::latencyTime() const
 179 {
 180     MutexTryLocker tryLocker(m_processLock);
 181     if (tryLocker.locked())
 182         return m_reverb ? m_reverb->latencyFrames() / static_cast<double>(sampleRate()) : 0;
 183     // Since we don't want to block the Audio Device thread, we return a large value
 184     // instead of trying to acquire the lock.
 185     return std::numeric_limits<double>::infinity();
 186 }
 187
 188 void ConvolverNode::trace(Visitor* visitor)
 189 {
 190     visitor->trace(m_buffer);
 191     AudioNode::trace(visitor);
 192 }
 193
 194 } // namespace blink
 195
 196 #endif // ENABLE(WEB_AUDIO)