Source/WebCore/platform/audio/Reverb.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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include "config.h"
  30
  31 #if ENABLE(WEB_AUDIO)
  32
  33 #include "Reverb.h"
  34
  35 #include "AudioBus.h"
  36 #include "AudioFileReader.h"
  37 #include "ReverbConvolver.h"
  38 #include <math.h>
  39 #include <wtf/MathExtras.h>
  40 #include <wtf/OwnPtr.h>
  41 #include <wtf/PassOwnPtr.h>
  42
  43 #if OS(DARWIN)
  44 using namespace std;
  45 #endif
  46
  47 namespace WebCore {
  48
  49 // Empirical gain calibration tested across many impulse responses to ensure perceived volume is same as dry (unprocessed) signal
  50 const double GainCalibration = -58.0;
  51
  52 // A minimum power value to when normalizing a silent (or very quiet) impulse response
  53 const double MinPower = 0.000125;
  54
  55 static double calculateNormalizationScale(AudioBus* response)
  56 {
  57     // Normalize by RMS power
  58     size_t numberOfChannels = response->numberOfChannels();
  59     size_t length = response->length();
  60
  61     double power = 0.0;
  62
  63     for (size_t i = 0; i < numberOfChannels; ++i) {
  64         int n = length;
  65         float* p = response->channel(i)->data();
  66
  67         while (n--) {
  68             float sample = *p++;
  69             power += sample * sample;
  70         }
  71     }
  72
  73     power = sqrt(power / (numberOfChannels * length));
  74
  75     // Protect against accidental overload
  76     if (isinf(power) || isnan(power) || power < MinPower)
  77         power = MinPower;
  78
  79     double scale = 1.0 / power;
  80
  81     scale *= pow(10.0, GainCalibration * 0.05); // calibrate to make perceived volume same as unprocessed
  82
  83     // True-stereo compensation
  84     if (response->numberOfChannels() == 4)
  85         scale *= 0.5;
  86
  87     return scale;
  88 }
  89
  90 Reverb::Reverb(AudioBus* impulseResponse, size_t renderSliceSize, size_t maxFFTSize, size_t numberOfChannels, bool useBackgroundThreads, bool normalize)
  91 {
  92     double scale = 1;
  93
  94     if (normalize) {
  95         scale = calculateNormalizationScale(impulseResponse);
  96
  97         if (scale)
  98             impulseResponse->scale(scale);
  99     }
 100
 101     initialize(impulseResponse, renderSliceSize, maxFFTSize, numberOfChannels, useBackgroundThreads);
 102
 103     // Undo scaling since this shouldn't be a destructive operation on impulseResponse.
 104     // FIXME: What about roundoff? Perhaps consider making a temporary scaled copy
 105     // instead of scaling and unscaling in place.
 106     if (normalize && scale)
 107         impulseResponse->scale(1.0 / scale);
 108 }
 109
 110 void Reverb::initialize(AudioBus* impulseResponseBuffer, size_t renderSliceSize, size_t maxFFTSize, size_t numberOfChannels, bool useBackgroundThreads)
 111 {
 112     m_impulseResponseLength = impulseResponseBuffer->length();
 113
 114     // The reverb can handle a mono impulse response and still do stereo processing
 115     size_t numResponseChannels = impulseResponseBuffer->numberOfChannels();
 116     m_convolvers.reserveCapacity(numberOfChannels);
 117
 118     int convolverRenderPhase = 0;
 119     for (size_t i = 0; i < numResponseChannels; ++i) {
 120         AudioChannel* channel = impulseResponseBuffer->channel(i);
 121
 122         OwnPtr<ReverbConvolver> convolver = adoptPtr(new ReverbConvolver(channel, renderSliceSize, maxFFTSize, convolverRenderPhase, useBackgroundThreads));
 123         m_convolvers.append(convolver.release());
 124
 125         convolverRenderPhase += renderSliceSize;
 126     }
 127
 128     // For "True" stereo processing we allocate a temporary buffer to avoid repeatedly allocating it in the process() method.
 129     // It can be bad to allocate memory in a real-time thread.
 130     if (numResponseChannels == 4)
 131         m_tempBuffer = adoptPtr(new AudioBus(2, MaxFrameSize));
 132 }
 133
 134 void Reverb::process(AudioBus* sourceBus, AudioBus* destinationBus, size_t framesToProcess)
 135 {
 136     // Do a fairly comprehensive sanity check.
 137     // If these conditions are satisfied, all of the source and destination pointers will be valid for the various matrixing cases.
 138     bool isSafeToProcess = sourceBus && destinationBus && sourceBus->numberOfChannels() > 0 && destinationBus->numberOfChannels() > 0
 139         && framesToProcess <= MaxFrameSize && framesToProcess <= sourceBus->length() && framesToProcess <= destinationBus->length();
 140
 141     ASSERT(isSafeToProcess);
 142     if (!isSafeToProcess)
 143         return;
 144
 145     // For now only handle mono or stereo output
 146     if (destinationBus->numberOfChannels() > 2) {
 147         destinationBus->zero();
 148         return;
 149     }
 150
 151     AudioChannel* destinationChannelL = destinationBus->channel(0);
 152     AudioChannel* sourceChannelL = sourceBus->channel(0);
 153
 154     // Handle input -> output matrixing...
 155     size_t numInputChannels = sourceBus->numberOfChannels();
 156     size_t numOutputChannels = destinationBus->numberOfChannels();
 157     size_t numReverbChannels = m_convolvers.size();
 158
 159     if (numInputChannels == 2 && numReverbChannels == 2 && numOutputChannels == 2) {
 160         // 2 -> 2 -> 2
 161         AudioChannel* sourceChannelR = sourceBus->channel(1);
 162         AudioChannel* destinationChannelR = destinationBus->channel(1);
 163         m_convolvers[0]->process(sourceChannelL, destinationChannelL, framesToProcess);
 164         m_convolvers[1]->process(sourceChannelR, destinationChannelR, framesToProcess);
 165     } else  if (numInputChannels == 1 && numOutputChannels == 2 && numReverbChannels == 2) {
 166         // 1 -> 2 -> 2
 167         for (int i = 0; i < 2; ++i) {
 168             AudioChannel* destinationChannel = destinationBus->channel(i);
 169             m_convolvers[i]->process(sourceChannelL, destinationChannel, framesToProcess);
 170         }
 171     } else if (numInputChannels == 1 && numReverbChannels == 1 && numOutputChannels == 2) {
 172         // 1 -> 1 -> 2
 173         m_convolvers[0]->process(sourceChannelL, destinationChannelL, framesToProcess);
 174
 175         // simply copy L -> R
 176         AudioChannel* destinationChannelR = destinationBus->channel(1);
 177         bool isCopySafe = destinationChannelL->data() && destinationChannelR->data() && destinationChannelL->length() >= framesToProcess && destinationChannelR->length() >= framesToProcess;
 178         ASSERT(isCopySafe);
 179         if (!isCopySafe)
 180             return;
 181         memcpy(destinationChannelR->data(), destinationChannelL->data(), sizeof(float) * framesToProcess);
 182     } else if (numInputChannels == 1 && numReverbChannels == 1 && numOutputChannels == 1) {
 183         // 1 -> 1 -> 1
 184         m_convolvers[0]->process(sourceChannelL, destinationChannelL, framesToProcess);
 185     } else if (numInputChannels == 2 && numReverbChannels == 4 && numOutputChannels == 2) {
 186         // 2 -> 4 -> 2 ("True" stereo)
 187         AudioChannel* sourceChannelR = sourceBus->channel(1);
 188         AudioChannel* destinationChannelR = destinationBus->channel(1);
 189
 190         AudioChannel* tempChannelL = m_tempBuffer->channel(0);
 191         AudioChannel* tempChannelR = m_tempBuffer->channel(1);
 192
 193         // Process left virtual source
 194         m_convolvers[0]->process(sourceChannelL, destinationChannelL, framesToProcess);
 195         m_convolvers[1]->process(sourceChannelL, destinationChannelR, framesToProcess);
 196
 197         // Process right virtual source
 198         m_convolvers[2]->process(sourceChannelR, tempChannelL, framesToProcess);
 199         m_convolvers[3]->process(sourceChannelR, tempChannelR, framesToProcess);
 200
 201         destinationBus->sumFrom(*m_tempBuffer);
 202     } else if (numInputChannels == 1 && numReverbChannels == 4 && numOutputChannels == 2) {
 203         // 1 -> 4 -> 2 (Processing mono with "True" stereo impulse response)
 204         // This is an inefficient use of a four-channel impulse response, but we should handle the case.
 205         AudioChannel* destinationChannelR = destinationBus->channel(1);
 206
 207         AudioChannel* tempChannelL = m_tempBuffer->channel(0);
 208         AudioChannel* tempChannelR = m_tempBuffer->channel(1);
 209
 210         // Process left virtual source
 211         m_convolvers[0]->process(sourceChannelL, destinationChannelL, framesToProcess);
 212         m_convolvers[1]->process(sourceChannelL, destinationChannelR, framesToProcess);
 213
 214         // Process right virtual source
 215         m_convolvers[2]->process(sourceChannelL, tempChannelL, framesToProcess);
 216         m_convolvers[3]->process(sourceChannelL, tempChannelR, framesToProcess);
 217
 218         destinationBus->sumFrom(*m_tempBuffer);
 219     } else {
 220         // Handle gracefully any unexpected / unsupported matrixing
 221         // FIXME: add code for 5.1 support...
 222         destinationBus->zero();
 223     }
 224 }
 225
 226 void Reverb::reset()
 227 {
 228     for (size_t i = 0; i < m_convolvers.size(); ++i)
 229         m_convolvers[i]->reset();
 230 }
 231
 232 } // namespace WebCore
 233
 234 #endif // ENABLE(WEB_AUDIO)