Support multichannel audio stream more than 2 in MediaStreamDestinationNode

third_party/WebKit/Source/modules/webaudio/MediaStreamAudioDestinationNode.cpp

 /*
  * Copyright (C) 2012, Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1.  Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2.  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.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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/MediaStreamAudioDestinationNode.h"
 
+#include "bindings/core/v8/ExceptionMessages.h"
+#include "bindings/core/v8/ExceptionState.h"
+#include "core/dom/ExceptionCode.h"
 #include "modules/webaudio/AbstractAudioContext.h"
 #include "modules/webaudio/AudioNodeInput.h"
 #include "platform/UUID.h"
 #include "platform/mediastream/MediaStreamCenter.h"
 #include "public/platform/WebRTCPeerConnectionHandler.h"
 #include "wtf/Locker.h"
 
 namespace blink {
 
+// WebAudioCapturerSource ignores the channel count beyond 8, so we set the
+// block here to avoid anything can cause the crash.
+static unsigned long kMaxChannelCount = 8;
+
 MediaStreamAudioDestinationHandler::MediaStreamAudioDestinationHandler(AudioNode& node, size_t numberOfChannels)
     : AudioBasicInspectorHandler(NodeTypeMediaStreamAudioDestination, node, node.context()->sampleRate(), numberOfChannels)
     , m_mixBus(AudioBus::create(numberOfChannels, ProcessingSizeInFrames))
 {
     m_source = MediaStreamSource::create("WebAudio-" + createCanonicalUUIDString(), MediaStreamSource::TypeAudio, "MediaStreamAudioDestinationNode", false, true, MediaStreamSource::ReadyStateLive, true);
     MediaStreamSourceVector audioSources;
     audioSources.append(m_source.get());
     MediaStreamSourceVector videoSources;
     m_stream = MediaStream::create(node.context()->executionContext(), MediaStreamDescriptor::create(audioSources, videoSources));
     MediaStreamCenter::instance().didCreateMediaStreamAndTracks(m_stream->descriptor());
 
     m_source->setAudioFormat(numberOfChannels, node.context()->sampleRate());
 
     initialize();
 }
 
 PassRefPtr<MediaStreamAudioDestinationHandler> MediaStreamAudioDestinationHandler::create(AudioNode& node, size_t numberOfChannels)
 {
     return adoptRef(new MediaStreamAudioDestinationHandler(node, numberOfChannels));
 }
 
 MediaStreamAudioDestinationHandler::~MediaStreamAudioDestinationHandler()
 {
     uninitialize();
 }
 
 void MediaStreamAudioDestinationHandler::process(size_t numberOfFrames)
 {
+    // Conform the input bus into the internal mix bus, which represents
+    // MediaStreamDestination's channel count.
     m_mixBus->copyFrom(*input(0).bus());
+

[Raymond Toy, 2015/11/20 14:47:18]

Why a new blank line here?

[hongchan, 2015/11/20 18:02:59]

Because the comment above only applies to the line 75.

[Raymond Toy, 2015/11/30 18:06:09]

Acknowledged.

     m_source->consumeAudio(m_mixBus.get(), numberOfFrames);
 }
 
+void MediaStreamAudioDestinationHandler::setChannelCount(unsigned long channelCount, ExceptionState& exceptionState)
+{
+    ASSERT(isMainThread());
+
+    // Currently the maximum channel count supported for this node is 8,
+    // which is constrained by m_source (WebAudioCapturereSource). Although
+    // it has its own safety check for the excessive channels, throwing an
+    // exception here is useful to developers.
+    if (channelCount > maxChannelCount()) {
+        exceptionState.throwDOMException(
+            IndexSizeError,
+            ExceptionMessages::indexOutsideRange<unsigned>("channel count",
+                channelCount,
+                1,
+                ExceptionMessages::InclusiveBound,
+                maxChannelCount(),
+                ExceptionMessages::InclusiveBound));
+        return;
+    }
+
+    unsigned long oldChannelCount = this->channelCount();
+    AudioHandler::setChannelCount(channelCount, exceptionState);
+
+    // Update the pipeline wit the new channel count only if absolutely

[Raymond Toy, 2015/11/20 14:47:18]

Typo: "wit" -> "with"

[hongchan, 2015/11/20 18:02:59]

Done.

+    // necessary.
+    //
+    // TODO(hongchan): There might be a data race here since both threads
+    // have access to m_mixBus.

[Raymond Toy, 2015/11/20 14:47:18]

I think you should lock the context here. Or maybe a process lock should be
added so that you don't change the m_mixBus out from under the process()
function above.

[hongchan, 2015/11/20 18:02:59]

Yes I agree. I will add the lock here. However, note that
DefaultAudioDestinatioNode::setChannelCount also does not have a lock in the
same scenario.

https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit...

Perhaps it is safe because of stopping/recreating the destination?

+    if (!exceptionState.hadException() && this->channelCount() != oldChannelCount && isInitialized()) {
+        m_mixBus = AudioBus::create(channelCount, ProcessingSizeInFrames);
+        m_source->setAudioFormat(channelCount, context()->sampleRate());
+    }
+}
+
+unsigned long MediaStreamAudioDestinationHandler::maxChannelCount() const

[Raymond Toy, 2015/11/20 14:47:18]

Is this used anywhere else?  If not, is there a reason not to use
kMaxChannelCount directly?

[hongchan, 2015/11/20 18:02:59]

I don't have a strong opinion on this and I am simply following conventions. You
prefer to have kMaxChannelCount rather than a getter?

[Raymond Toy, 2015/11/30 18:06:09]

Up to you.  This isn't speed-critical, so I'm fine with it.  Getters are
probably better in general.

+{
+    return kMaxChannelCount;
+}
+
 // ----------------------------------------------------------------
 
 MediaStreamAudioDestinationNode::MediaStreamAudioDestinationNode(AbstractAudioContext& context, size_t numberOfChannels)
     : AudioBasicInspectorNode(context)
 {
     setHandler(MediaStreamAudioDestinationHandler::create(*this, numberOfChannels));
 }
 
 MediaStreamAudioDestinationNode* MediaStreamAudioDestinationNode::create(AbstractAudioContext& context, size_t numberOfChannels)
 {
     return new MediaStreamAudioDestinationNode(context, numberOfChannels);
 }
 
 MediaStream* MediaStreamAudioDestinationNode::stream() const
 {
     return static_cast<MediaStreamAudioDestinationHandler&>(handler()).stream();
 }
 
 } // namespace blink
 
 #endif // ENABLE(WEB_AUDIO)