Implement StereoPannerNode for robust stereo panning

Source/platform/audio/StereoPanner.cpp

+// Copyright 2014 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "config.h"
+
+#if ENABLE(WEB_AUDIO)
+
+#include "platform/audio/StereoPanner.h"
+
+#include "platform/audio/AudioBus.h"
+#include "platform/audio/AudioUtilities.h"
+#include "wtf/MathExtras.h"
+#include <algorithm>
+
+// Use a 50ms smoothing / de-zippering time-constant.
+const float SmoothingTimeConstant = 0.050f;
+
+namespace blink {
+
+StereoPanner::StereoPanner(float sampleRate) : Spatializer(PanningModelEqualPower)
+    , m_isFirstRender(true)
+    , m_gainL(0.5)
+    , m_gainR(0.5)
+{
+    m_smoothingConstant = AudioUtilities::discreteTimeConstantForSampleRate(SmoothingTimeConstant, sampleRate);
+}
+
+void StereoPanner::panWithSampleAccurateValues(const AudioBus* inputBus, AudioBus* outputBus, const float* panValues, size_t framesToProcess)
+{
+    bool isInputSafe = inputBus
+        && (inputBus->numberOfChannels() == 1 || inputBus->numberOfChannels() == 2)
+        && framesToProcess <= inputBus->length();
+    ASSERT(isInputSafe);
+    if (!isInputSafe)
+        return;
+
+    unsigned numberOfInputChannels = inputBus->numberOfChannels();
+
+    bool isOutputSafe = outputBus
+        && outputBus->numberOfChannels() == 2
+        && framesToProcess <= outputBus->length();
+    ASSERT(isOutputSafe);
+    if (!isOutputSafe)
+        return;
+
+    const float* sourceL = inputBus->channel(0)->data();
+    const float* sourceR = numberOfInputChannels > 1 ? inputBus->channel(1)->data() : sourceL;
+    float* destinationL = outputBus->channelByType(AudioBus::ChannelLeft)->mutableData();
+    float* destinationR = outputBus->channelByType(AudioBus::ChannelRight)->mutableData();
+
+    if (!sourceL || !sourceR || !destinationL || !destinationR)
+        return;
+
+    // Cache in local variables.
+    double gainL = m_gainL;
+    double gainR = m_gainR;
+
+    int n = framesToProcess;
+
+    if (numberOfInputChannels == 1) { // For mono source case.
+        while (n--) {
+            float inputL = *sourceL++;
+            float panPosition = (*panValues++ * 0.5 + 0.5) * piOverTwoDouble;
+            gainL = std::cos(panPosition);
+            gainR = std::sin(panPosition);
+            *destinationL++ = static_cast<float>(inputL * gainL);
+            *destinationR++ = static_cast<float>(inputL * gainR);
+        }
+    } else { // For stereo source case.
+        while (n--) {
+            float inputL = *sourceL++;
+            float inputR = *sourceR++;
+            float panPosition = (*panValues++ * 0.5 + 0.5) * piOverTwoDouble;
+            gainL = std::cos(panPosition);
+            gainR = std::sin(panPosition);
+            *destinationL++ = static_cast<float>(inputL * gainL);
+            *destinationR++ = static_cast<float>(inputR * gainR);
+        }
+    }
+
+    m_gainL = gainL;
+    m_gainR = gainR;
+}
+
+void StereoPanner::panToTargetValue(const AudioBus* inputBus, AudioBus* outputBus, float panValue, size_t framesToProcess)
+{
+    bool isInputSafe = inputBus
+        && (inputBus->numberOfChannels() == 1 || inputBus->numberOfChannels() == 2)
+        && framesToProcess <= inputBus->length();
+    ASSERT(isInputSafe);
+    if (!isInputSafe)
+        return;
+
+    unsigned numberOfInputChannels = inputBus->numberOfChannels();
+
+    bool isOutputSafe = outputBus
+        && outputBus->numberOfChannels() == 2
+        && framesToProcess <= outputBus->length();
+    ASSERT(isOutputSafe);
+    if (!isOutputSafe)
+        return;
+
+    const float* sourceL = inputBus->channel(0)->data();
+    const float* sourceR = numberOfInputChannels > 1 ? inputBus->channel(1)->data() : sourceL;
+    float* destinationL = outputBus->channelByType(AudioBus::ChannelLeft)->mutableData();
+    float* destinationR = outputBus->channelByType(AudioBus::ChannelRight)->mutableData();
+
+    if (!sourceL || !sourceR || !destinationL || !destinationR)
+        return;
+
+    double targetGainL = std::cos(piOverTwoDouble * (panValue * 0.5 + 0.5));
+    double targetGainR = std::sin(piOverTwoDouble * (panValue * 0.5 + 0.5));
+
+    // Don't de-zipper on first render call.
+    if (m_isFirstRender) {
+        m_isFirstRender = false;
+        m_gainL = targetGainL;
+        m_gainR = targetGainR;
+    }
+
+    // Cache in local variables.
+    double gainL = m_gainL;
+    double gainR = m_gainR;
+
+    // Get local copy of smoothing constant.
+    const double SmoothingConstant = m_smoothingConstant;
+
+    int n = framesToProcess;
+
+    if (numberOfInputChannels == 1) { // For mono source case.
+        while (n--) {
+            float inputL = *sourceL++;
+            gainL += (targetGainL - gainL) * SmoothingConstant;
+            gainR += (targetGainR - gainR) * SmoothingConstant;
+            *destinationL++ = static_cast<float>(inputL * gainL);
+            *destinationR++ = static_cast<float>(inputL * gainR);
+        }
+    } else { // For stereo source case.
+        while (n--) {
+            float inputL = *sourceL++;
+            float inputR = *sourceR++;
+            gainL += (targetGainL - gainL) * SmoothingConstant;
+            gainR += (targetGainR - gainR) * SmoothingConstant;
+            *destinationL++ = static_cast<float>(inputL * gainL);
+            *destinationR++ = static_cast<float>(inputR * gainR);
+        }
+    }
+
+    m_gainL = gainL;
+    m_gainR = gainR;
+}
+
+} // namespace blink
+
+#endif // ENABLE(WEB_AUDIO)