Replace ASSERT with DCHECK in WebAudio

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

 /*
  * Copyright (C) 2010, 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
@@ skipping 48 matching lines @@
     if (!s_isNodeCountInitialized) {
         s_isNodeCountInitialized = true;
         atexit(AudioHandler::printNodeCounts);
     }
 #endif
     InstanceCounters::incrementCounter(InstanceCounters::AudioHandlerCounter);
 }
 
 AudioHandler::~AudioHandler()
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     // dispose() should be called.
-    ASSERT(!node());
+    DCHECK(!node());
     InstanceCounters::decrementCounter(InstanceCounters::AudioHandlerCounter);
 #if DEBUG_AUDIONODE_REFERENCES
     --s_nodeCount[getNodeType()];
     fprintf(stderr, "%p: %2d: AudioNode::~AudioNode() %d [%d]\n",
         this, getNodeType(), m_connectionRefCount, s_nodeCount[getNodeType()]);
 #endif
 }
 
 void AudioHandler::initialize()
 {
     m_isInitialized = true;
 }
 
 void AudioHandler::uninitialize()
 {
     m_isInitialized = false;
 }
 
 void AudioHandler::clearInternalStateWhenDisabled()
 {
 }
 
 void AudioHandler::dispose()
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     ASSERT(context()->isGraphOwner());
 
     context()->deferredTaskHandler().removeChangedChannelCountMode(this);
     context()->deferredTaskHandler().removeChangedChannelInterpretation(this);
     context()->deferredTaskHandler().removeAutomaticPullNode(this);
     for (auto& output : m_outputs)
         output->dispose();
     m_node = nullptr;
 }
 
 AudioNode* AudioHandler::node() const
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     return m_node;
 }
 
 BaseAudioContext* AudioHandler::context() const
 {
     return m_context;
 }
 
 String AudioHandler::nodeTypeName() const
 {
@@ skipping 39 matching lines @@
     default:
         ASSERT_NOT_REACHED();
         return "UnknownNode";
     }
 }
 
 void AudioHandler::setNodeType(NodeType type)
 {
     // Don't allow the node type to be changed to a different node type, after it's already been
     // set!  And the new type can't be unknown or end!
-    ASSERT(m_nodeType == NodeTypeUnknown);
-    ASSERT(type != NodeTypeUnknown);
-    ASSERT(type != NodeTypeEnd);
+    DCHECK_EQ(m_nodeType, NodeTypeUnknown);
+    DCHECK_NE(type, NodeTypeUnknown);
+    DCHECK_NE(type, NodeTypeEnd);
 
     m_nodeType = type;
 
 #if DEBUG_AUDIONODE_REFERENCES
     ++s_nodeCount[type];
     fprintf(stderr, "%p: %2d: AudioNode::AudioNode [%3d]\n", this, getNodeType(), s_nodeCount[getNodeType()]);
 #endif
 }
 
 void AudioHandler::addInput()
 {
     m_inputs.append(AudioNodeInput::create(*this));
 }
 
 void AudioHandler::addOutput(unsigned numberOfChannels)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     m_outputs.append(AudioNodeOutput::create(this, numberOfChannels));
     node()->didAddOutput(numberOfOutputs());
 }
 
 AudioNodeInput& AudioHandler::input(unsigned i)
 {
     return *m_inputs[i];
 }
 
 AudioNodeOutput& AudioHandler::output(unsigned i)
 {
     return *m_outputs[i];
 }
 
 unsigned long AudioHandler::channelCount()
 {
     return m_channelCount;
 }
 
 void AudioHandler::setChannelCount(unsigned long channelCount, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     if (channelCount > 0 && channelCount <= BaseAudioContext::maxNumberOfChannels()) {
         if (m_channelCount != channelCount) {
             m_channelCount = channelCount;
             if (m_channelCountMode != Max)
                 updateChannelsForInputs();
         }
     } else {
         exceptionState.throwDOMException(
@@ skipping 17 matching lines @@
         return "clamped-max";
     case Explicit:
         return "explicit";
     }
     ASSERT_NOT_REACHED();
     return "";
 }
 
 void AudioHandler::setChannelCountMode(const String& mode, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     ChannelCountMode oldMode = m_channelCountMode;
 
     if (mode == "max") {
         m_newChannelCountMode = Max;
     } else if (mode == "clamped-max") {
         m_newChannelCountMode = ClampedMax;
     } else if (mode == "explicit") {
         m_newChannelCountMode = Explicit;
@@ skipping 12 matching lines @@
         return "speakers";
     case AudioBus::Discrete:
         return "discrete";
     }
     ASSERT_NOT_REACHED();
     return "";
 }
 
 void AudioHandler::setChannelInterpretation(const String& interpretation, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     AudioBus::ChannelInterpretation oldMode = m_channelInterpretation;
 
     if (interpretation == "speakers") {
         m_newChannelInterpretation = AudioBus::Speakers;
     } else if (interpretation == "discrete") {
         m_newChannelInterpretation = AudioBus::Discrete;
     } else {
         ASSERT_NOT_REACHED();
     }
 
     if (m_newChannelInterpretation != oldMode)
         context()->deferredTaskHandler().addChangedChannelInterpretation(this);
 }
 
 void AudioHandler::updateChannelsForInputs()
 {
     for (auto& input : m_inputs)
         input->changedOutputs();
 }
 
 void AudioHandler::processIfNecessary(size_t framesToProcess)
 {
-    ASSERT(context()->isAudioThread());
+    DCHECK(context()->isAudioThread());
 
     if (!isInitialized())
         return;
 
     // Ensure that we only process once per rendering quantum.
     // This handles the "fanout" problem where an output is connected to multiple inputs.
     // The first time we're called during this time slice we process, but after that we don't want to re-process,
     // instead our output(s) will already have the results cached in their bus;
     double currentTime = context()->currentTime();
     if (m_lastProcessingTime != currentTime) {
@@ skipping 12 matching lines @@
             // to go silent and we want to propagate that hint to the downstream nodes!  (For
             // example, a Gain node with a gain of 0 will want to silence its output.)
             unsilenceOutputs();
             process(framesToProcess);
         }
     }
 }
 
 void AudioHandler::checkNumberOfChannelsForInput(AudioNodeInput* input)
 {
-    ASSERT(context()->isAudioThread());
+    DCHECK(context()->isAudioThread());
     ASSERT(context()->isGraphOwner());
 
-    ASSERT(m_inputs.contains(input));
+    DCHECK(m_inputs.contains(input));
     if (!m_inputs.contains(input))
         return;
 
     input->updateInternalBus();
 }
 
 double AudioHandler::tailTime() const
 {
     return 0;
 }
 
 double AudioHandler::latencyTime() const
 {
     return 0;
 }
 
 bool AudioHandler::propagatesSilence() const
 {
     return m_lastNonSilentTime + latencyTime() + tailTime() < context()->currentTime();
 }
 
 void AudioHandler::pullInputs(size_t framesToProcess)
 {
-    ASSERT(context()->isAudioThread());
+    DCHECK(context()->isAudioThread());
 
     // Process all of the AudioNodes connected to our inputs.
     for (auto& input : m_inputs)
         input->pull(0, framesToProcess);
 }
 
 bool AudioHandler::inputsAreSilent()
 {
     for (auto& input : m_inputs) {
         if (!input->bus()->isSilent())
@@ skipping 10 matching lines @@
 
 void AudioHandler::unsilenceOutputs()
 {
     for (auto& output : m_outputs)
         output->bus()->clearSilentFlag();
 }
 
 void AudioHandler::enableOutputsIfNecessary()
 {
     if (m_isDisabled && m_connectionRefCount > 0) {
-        ASSERT(isMainThread());
+        DCHECK(isMainThread());
         BaseAudioContext::AutoLocker locker(context());
 
         m_isDisabled = false;
         for (auto& output : m_outputs)
             output->enable();
     }
 }
 
 void AudioHandler::disableOutputsIfNecessary()
 {
@@ skipping 53 matching lines @@
         context()->lock();
         hasLock = true;
     }
 
     if (hasLock) {
         breakConnectionWithLock();
         context()->unlock();
     } else {
         // We were unable to get the lock, so put this in a list to finish up
         // later.
-        ASSERT(context()->isAudioThread());
+        DCHECK(context()->isAudioThread());
         context()->deferredTaskHandler().addDeferredBreakConnection(*this);
     }
 }
 
 void AudioHandler::breakConnectionWithLock()
 {
     atomicDecrement(&m_connectionRefCount);
 
 #if DEBUG_AUDIONODE_REFERENCES
     fprintf(stderr, "%p: %2d: AudioNode::deref %3d [%3d]\n",
@@ skipping 47 matching lines @@
 
 AudioNode::AudioNode(BaseAudioContext& context)
     : m_context(context)
     , m_handler(nullptr)
 {
     ThreadState::current()->registerPreFinalizer(this);
 }
 
 void AudioNode::dispose()
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
     handler().dispose();
     if (context()->contextState() == BaseAudioContext::Running)
         context()->deferredTaskHandler().addRenderingOrphanHandler(m_handler.release());
 }
 
 void AudioNode::setHandler(PassRefPtr<AudioHandler> handler)
 {
-    ASSERT(handler);
+    DCHECK(handler);
     m_handler = handler;
 }
 
 AudioHandler& AudioNode::handler() const
 {
     return *m_handler;
 }
 
 DEFINE_TRACE(AudioNode)
 {
     visitor->trace(m_context);
     visitor->trace(m_connectedNodes);
     visitor->trace(m_connectedParams);
     EventTargetWithInlineData::trace(visitor);
 }
 
 BaseAudioContext* AudioNode::context() const
 {
     return m_context;
 }
 
 AudioNode* AudioNode::connect(AudioNode* destination, unsigned outputIndex, unsigned inputIndex, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     if (context()->isContextClosed()) {
         exceptionState.throwDOMException(
             InvalidStateError,
             "Cannot connect after the context has been closed.");
         return nullptr;
     }
 
     if (!destination) {
@@ skipping 41 matching lines @@
     m_connectedNodes[outputIndex]->add(destination);
 
     // Let context know that a connection has been made.
     context()->incrementConnectionCount();
 
     return destination;
 }
 
 void AudioNode::connect(AudioParam* param, unsigned outputIndex, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     if (context()->isContextClosed()) {
         exceptionState.throwDOMException(
             InvalidStateError,
             "Cannot connect after the context has been closed.");
         return;
     }
 
     if (!param) {
@@ skipping 46 matching lines @@
     AudioNodeOutput& output = handler().output(outputIndex);
     if (!output.isConnectedToAudioParam(param.handler()))
         return false;
     output.disconnectAudioParam(param.handler());
     m_connectedParams[outputIndex]->remove(&param);
     return true;
 }
 
 void AudioNode::disconnect()
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     // Disconnect all outgoing connections.
     for (unsigned i = 0; i < numberOfOutputs(); ++i)
         disconnectAllFromOutput(i);
 }
 
 void AudioNode::disconnect(unsigned outputIndex, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     // Sanity check on the output index.
     if (outputIndex >= numberOfOutputs()) {
         exceptionState.throwDOMException(
             IndexSizeError,
             ExceptionMessages::indexOutsideRange(
                 "output index",
                 outputIndex,
                 0u,
                 ExceptionMessages::InclusiveBound,
                 numberOfOutputs() - 1,
                 ExceptionMessages::InclusiveBound));
         return;
     }
     // Disconnect all outgoing connections from the given output.
     disconnectAllFromOutput(outputIndex);
 }
 
 void AudioNode::disconnect(AudioNode* destination, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     unsigned numberOfDisconnections = 0;
 
     // FIXME: Can this be optimized? ChannelSplitter and ChannelMerger can have
     // 32 ports and that requires 1024 iterations to validate entire connections.
     for (unsigned outputIndex = 0; outputIndex < numberOfOutputs(); ++outputIndex) {
         for (unsigned inputIndex = 0; inputIndex < destination->handler().numberOfInputs(); ++inputIndex) {
             if (disconnectFromOutputIfConnected(outputIndex, *destination, inputIndex))
                 numberOfDisconnections++;
         }
     }
 
     // If there is no connection to the destination, throw an exception.
     if (numberOfDisconnections == 0) {
         exceptionState.throwDOMException(
             InvalidAccessError,
             "the given destination is not connected.");
         return;
     }
 }
 
 void AudioNode::disconnect(AudioNode* destination, unsigned outputIndex, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     if (outputIndex >= numberOfOutputs()) {
         // The output index is out of range. Throw an exception.
         exceptionState.throwDOMException(
             IndexSizeError,
             ExceptionMessages::indexOutsideRange(
                 "output index",
                 outputIndex,
                 0u,
@@ skipping 14 matching lines @@
     // If there is no connection to the destination, throw an exception.
     if (numberOfDisconnections == 0) {
         exceptionState.throwDOMException(
             InvalidAccessError,
             "output (" + String::number(outputIndex) + ") is not connected to the given destination.");
     }
 }
 
 void AudioNode::disconnect(AudioNode* destination, unsigned outputIndex, unsigned inputIndex, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     if (outputIndex >= numberOfOutputs()) {
         exceptionState.throwDOMException(
             IndexSizeError,
             ExceptionMessages::indexOutsideRange(
                 "output index",
                 outputIndex,
                 0u,
                 ExceptionMessages::InclusiveBound,
@@ skipping 19 matching lines @@
     if (!disconnectFromOutputIfConnected(outputIndex, *destination, inputIndex)) {
         exceptionState.throwDOMException(
             InvalidAccessError,
             "output (" + String::number(outputIndex) + ") is not connected to the input (" + String::number(inputIndex) + ") of the destination.");
         return;
     }
 }
 
 void AudioNode::disconnect(AudioParam* destinationParam, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     // The number of disconnection made.
     unsigned numberOfDisconnections = 0;
 
     // Check if the node output is connected the destination AudioParam.
     // Disconnect if connected and increase |numberOfDisconnectios| by 1.
     for (unsigned outputIndex = 0; outputIndex < handler().numberOfOutputs(); ++outputIndex) {
         if (disconnectFromOutputIfConnected(outputIndex, *destinationParam))
             numberOfDisconnections++;
     }
 
     // Throw an exception when there is no valid connection to the destination.
     if (numberOfDisconnections == 0) {
         exceptionState.throwDOMException(
             InvalidAccessError,
             "the given AudioParam is not connected.");
         return;
     }
 }
 
 void AudioNode::disconnect(AudioParam* destinationParam, unsigned outputIndex, ExceptionState& exceptionState)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     if (outputIndex >= handler().numberOfOutputs()) {
         // The output index is out of range. Throw an exception.
         exceptionState.throwDOMException(
             IndexSizeError,
             ExceptionMessages::indexOutsideRange(
                 "output index",
                 outputIndex,
                 0u,
                 ExceptionMessages::InclusiveBound,
                 numberOfOutputs() - 1,
                 ExceptionMessages::InclusiveBound));
         return;
     }
 
     // If the output index is valid, proceed to disconnect.
     if (!disconnectFromOutputIfConnected(outputIndex, *destinationParam)) {
         exceptionState.throwDOMException(
             InvalidAccessError,
             "specified destination AudioParam and node output (" + String::number(outputIndex) + ") are not connected.");
         return;
     }
 }
 
 void AudioNode::disconnectWithoutException(unsigned outputIndex)
 {
-    ASSERT(isMainThread());
+    DCHECK(isMainThread());
     BaseAudioContext::AutoLocker locker(context());
 
     // Sanity check input and output indices.
     if (outputIndex >= handler().numberOfOutputs())
         return;
     disconnectAllFromOutput(outputIndex);
 }
 
 unsigned AudioNode::numberOfInputs() const
 {
@@ skipping 41 matching lines @@
 }
 
 ExecutionContext* AudioNode::getExecutionContext() const
 {
     return context()->getExecutionContext();
 }
 
 void AudioNode::didAddOutput(unsigned numberOfOutputs)
 {
     m_connectedNodes.append(nullptr);
     ASSERT_UNUSED(numberOfOutputs, numberOfOutputs == m_connectedNodes.size());

[hongchan, 2016/08/15 15:43:21]

Can we use DCHECK for this? I did not do the research yet so not sure if there
is a DCHECK equivalent for this assertion.

[HyungwookLee, 2016/08/16 03:16:04]

In my investigation, ASSERT_UNUSED() is considered ASSERT is not defined
condition as following.

#if ENABLE(ASSERT)
ASSERT_UNUSED(variable, assertion) ASSERT(assertion)
#else
#define ASSERT_UNUSED(variable, assertion) ((void)variable)
#endif

I think we can replace ASSERT_UNUSED with DCHECK also.

Done.

     m_connectedParams.append(nullptr);
     ASSERT_UNUSED(numberOfOutputs, numberOfOutputs == m_connectedParams.size());

[hongchan, 2016/08/15 15:43:21]

Ditto.

[HyungwookLee, 2016/08/16 03:16:04]

Done.

 }
 
 } // namespace blink