Implement StereoPannerNode for robust stereo panning

Source/modules/webaudio/StereoPannerNode.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 "modules/webaudio/StereoPannerNode.h"
+
+#include "bindings/core/v8/ExceptionMessages.h"
+#include "bindings/core/v8/ExceptionState.h"
+#include "core/dom/ExecutionContext.h"
+#include "modules/webaudio/AudioContext.h"
+#include "modules/webaudio/AudioNodeInput.h"
+#include "modules/webaudio/AudioNodeOutput.h"
+#include "platform/audio/StereoPanner.h"
+#include "wtf/MathExtras.h"
+
+namespace blink {
+
+StereoPannerNode::StereoPannerNode(AudioContext* context, float sampleRate)
+    : AudioNode(context, sampleRate)
+    , m_sampleAccuratePanValues(AudioNode::ProcessingSizeInFrames)
+{
+    m_pan = AudioParam::create(context, 0);
+
+    addInput();
+    addOutput(AudioNodeOutput::create(this, 2));
+
+    // This node-specific default mixing rules declare that StereoPannerNode

[Raymond Toy, 2014/11/12 18:06:52]

Typo: "This" -> "The"

[hongchan, 2014/11/12 22:01:42]

Done.

+    // can handle mono to stereo and stereo to stereo conversion.
+    m_channelCount = 2;
+    m_channelCountMode = ClampedMax;
+    m_channelInterpretation = AudioBus::Speakers;
+
+    setNodeType(NodeTypeStereoPanner);
+
+    initialize();
+}
+
+StereoPannerNode::~StereoPannerNode()
+{
+    ASSERT(!isInitialized());
+}
+
+void StereoPannerNode::dispose()
+{
+    uninitialize();
+    AudioNode::dispose();
+}
+
+void StereoPannerNode::process(size_t framesToProcess)
+{
+    AudioBus* outputBus = output(0)->bus();
+
+    if (!isInitialized() || !input(0)->isConnected() || !m_stereoPanner.get()) {
+        outputBus->zero();
+        return;
+    }
+
+    AudioBus* inputBus = input(0)->bus();
+    if (!inputBus) {
+        outputBus->zero();
+        return;
+    }
+
+    if (pan()->hasSampleAccurateValues()) {
+        // Apply sample-accurate panning specified by AudioParam automation.
+        ASSERT(framesToProcess <= m_sampleAccuratePanValues.size());
+        if (framesToProcess <= m_sampleAccuratePanValues.size()) {
+            float* panValues = m_sampleAccuratePanValues.data();
+            pan()->calculateSampleAccurateValues(panValues, framesToProcess);
+            m_stereoPanner->panWithSampleAccurateValues(inputBus, outputBus, panValues, framesToProcess);
+        }
+    } else {
+        m_stereoPanner->panToTargetValue(inputBus, outputBus, pan()->value(), framesToProcess);
+    }
+}
+
+void StereoPannerNode::initialize()
+{
+    if (isInitialized())
+        return;
+
+    m_stereoPanner = Spatializer::create(Spatializer::PanningModelEqualPower, sampleRate());
+
+    AudioNode::initialize();
+}
+
+void StereoPannerNode::uninitialize()
+{
+    if (!isInitialized())
+        return;
+
+    m_stereoPanner.clear();
+
+    AudioNode::uninitialize();
+}
+
+void StereoPannerNode::setChannelCount(unsigned long channelCount, ExceptionState& exceptionState)
+{
+    ASSERT(isMainThread());
+    AudioContext::AutoLocker locker(context());
+
+    // A PannerNode only supports 1 or 2 channels
+    if (channelCount > 0 && channelCount <= 2) {
+        if (m_channelCount != channelCount) {
+            m_channelCount = channelCount;
+            if (m_channelCountMode != Max)
+                updateChannelsForInputs();
+        }
+    } else {
+        exceptionState.throwDOMException(
+            NotSupportedError,
+            ExceptionMessages::indexOutsideRange<unsigned long>(
+                "channelCount",
+                channelCount,
+                1,
+                ExceptionMessages::InclusiveBound,
+                2,
+                ExceptionMessages::InclusiveBound));
+    }
+}
+
+void StereoPannerNode::setChannelCountMode(const String& mode, ExceptionState& exceptionState)
+{
+    ASSERT(isMainThread());
+    AudioContext::AutoLocker locker(context());
+
+    ChannelCountMode oldMode = m_channelCountMode;
+
+    if (mode == "clamped-max") {
+        m_newChannelCountMode = ClampedMax;
+    } else if (mode == "explicit") {
+        m_newChannelCountMode = Explicit;
+    } else if (mode == "max") {
+        // This is not supported for a StereoPannerNode, which can only handle
+        // 1 or 2 channels.
+        exceptionState.throwDOMException(
+            NotSupportedError,
+            ExceptionMessages::failedToSet(
+                "channelCountMode",
+                "StereoPannerNode",
+                "'max' is not allowed"));
+        m_newChannelCountMode = oldMode;
+    } else {
+        // Do nothing for other invalid values.
+        m_newChannelCountMode = oldMode;
+    }
+
+    if (m_newChannelCountMode != oldMode)
+        context()->addChangedChannelCountMode(this);
+}
+
+void StereoPannerNode::trace(Visitor* visitor)
+{
+    visitor->trace(m_stereoPanner);
+    visitor->trace(m_pan);
+    AudioNode::trace(visitor);
+}
+
+} // namespace blink
+
+#endif // ENABLE(WEB_AUDIO)