Add more informative messages for DOM exceptions.

Source/modules/webaudio/AudioContext.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 10 matching lines @@
  * (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/AudioContext.h"
 
+#include "bindings/v8/ExceptionMessages.h"
 #include "bindings/v8/ExceptionState.h"
 #include "core/dom/Document.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/html/HTMLMediaElement.h"
 #include "core/inspector/ScriptCallStack.h"
 #include "core/platform/audio/FFTFrame.h"
 #include "core/platform/audio/HRTFDatabaseLoader.h"
 #include "core/platform/audio/HRTFPanner.h"
 #include "modules/mediastream/MediaStream.h"
 #include "modules/webaudio/AnalyserNode.h"
@@ skipping 245 matching lines @@
     // of dealing with all of its ActiveDOMObjects at this point. uninitialize() can de-reference other
     // ActiveDOMObjects so let's schedule uninitialize() to be called later.
     // FIXME: see if there's a more direct way to handle this issue.
     callOnMainThread(stopDispatch, this);
 }
 
 PassRefPtr<AudioBuffer> AudioContext::createBuffer(unsigned numberOfChannels, size_t numberOfFrames, float sampleRate, ExceptionState& es)
 {
     RefPtr<AudioBuffer> audioBuffer = AudioBuffer::create(numberOfChannels, numberOfFrames, sampleRate);
     if (!audioBuffer.get()) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        if (numberOfChannels > AudioContext::maxNumberOfChannels()) {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "AudioBuffer",
+                    "requested number of channels (" + String::number(numberOfChannels) + ") exceeds maximum (" + String::number(AudioContext::maxNumberOfChannels()) + ")"));
+        } else if (sampleRate < AudioBuffer::minAllowedSampleRate() || sampleRate > AudioBuffer::maxAllowedSampleRate()) {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "AudioBuffer",
+                    "requested sample rate (" + String::number(sampleRate)
+                    + ") does not lie in the allowed range of "
+                    + String::number(AudioBuffer::minAllowedSampleRate())
+                    + "-" + String::number(AudioBuffer::maxAllowedSampleRate()) + " Hz"));
+        } else {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "AudioBuffer",
+                    "invalid number of channels, frames, or sample rate."));
+        }
         return 0;
     }
 
     return audioBuffer;
 }
 
 PassRefPtr<AudioBuffer> AudioContext::createBuffer(ArrayBuffer* arrayBuffer, bool mixToMono, ExceptionState& es)
 {
     ASSERT(arrayBuffer);
     if (!arrayBuffer) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "AudioBuffer",
+                "invalid ArrayBuffer."));
         return 0;
     }
 
     RefPtr<AudioBuffer> audioBuffer = AudioBuffer::createFromAudioFileData(arrayBuffer->data(), arrayBuffer->byteLength(), mixToMono, sampleRate());
     if (!audioBuffer.get()) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "AudioBuffer",
+                "invalid audio data in ArrayBuffer."));
         return 0;
     }
 
     return audioBuffer;
 }
 
 void AudioContext::decodeAudioData(ArrayBuffer* audioData, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback, ExceptionState& es)
 {
     if (!audioData) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToExecute(
+                "decodeAudioData",
+                "AudioContext",
+                "invalid ArrayBuffer for audioData."));
         return;
     }
     m_audioDecoder.decodeAsync(audioData, sampleRate(), successCallback, errorCallback);
 }
 
 PassRefPtr<AudioBufferSourceNode> AudioContext::createBufferSource()
 {
     ASSERT(isMainThread());
     lazyInitialize();
     RefPtr<AudioBufferSourceNode> node = AudioBufferSourceNode::create(this, m_destinationNode->sampleRate());
 
     // Because this is an AudioScheduledSourceNode, the context keeps a reference until it has finished playing.
     // When this happens, AudioScheduledSourceNode::finish() calls AudioContext::notifyNodeFinishedProcessing().
     refNode(node.get());
 
     return node;
 }
 
 PassRefPtr<MediaElementAudioSourceNode> AudioContext::createMediaElementSource(HTMLMediaElement* mediaElement, ExceptionState& es)
 {
-    ASSERT(mediaElement);
     if (!mediaElement) {
-        es.throwUninformativeAndGenericDOMException(InvalidStateError);
+        es.throwDOMException(
+            InvalidStateError,
+            ExceptionMessages::failedToConstruct(
+                "MediaElementAudioSourceNode",
+                "invalid HTMLMedialElement."));
         return 0;
     }
 
     ASSERT(isMainThread());
     lazyInitialize();
 
     // First check if this media element already has a source node.
     if (mediaElement->audioSourceNode()) {
-        es.throwUninformativeAndGenericDOMException(InvalidStateError);
+        es.throwDOMException(
+            InvalidStateError,
+            ExceptionMessages::failedToConstruct(
+                "MediaElementAudioSourceNode",
+                "invalid HTMLMediaElement."));
         return 0;
     }
 
     RefPtr<MediaElementAudioSourceNode> node = MediaElementAudioSourceNode::create(this, mediaElement);
 
     mediaElement->setAudioSourceNode(node.get());
 
     refNode(node.get()); // context keeps reference until node is disconnected
     return node;
 }
 
 PassRefPtr<MediaStreamAudioSourceNode> AudioContext::createMediaStreamSource(MediaStream* mediaStream, ExceptionState& es)
 {
-    ASSERT(mediaStream);
     if (!mediaStream) {
-        es.throwUninformativeAndGenericDOMException(InvalidStateError);
+        es.throwDOMException(
+            InvalidStateError,
+            ExceptionMessages::failedToConstruct(
+                "MediaStreamAudioSourceNode",
+                "invalid MediaStream source"));
         return 0;
     }
 
     ASSERT(isMainThread());
     lazyInitialize();
 
     AudioSourceProvider* provider = 0;
 
     MediaStreamTrackVector audioTracks = mediaStream->getAudioTracks();
 
@@ skipping 34 matching lines @@
     return createScriptProcessor(bufferSize, numberOfInputChannels, 2, es);
 }
 
 PassRefPtr<ScriptProcessorNode> AudioContext::createScriptProcessor(size_t bufferSize, size_t numberOfInputChannels, size_t numberOfOutputChannels, ExceptionState& es)
 {
     ASSERT(isMainThread());
     lazyInitialize();
     RefPtr<ScriptProcessorNode> node = ScriptProcessorNode::create(this, m_destinationNode->sampleRate(), bufferSize, numberOfInputChannels, numberOfOutputChannels);
 
     if (!node.get()) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        if (!numberOfInputChannels && !numberOfOutputChannels) {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "ScriptProcessorNode",
+                    "number of input channels and output channels cannot both be zero."));
+        } else if (numberOfInputChannels > AudioContext::maxNumberOfChannels()) {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "ScriptProcessorNode",
+                    "number of input channels (" + String::number(numberOfInputChannels)
+                    + ") exceeds maximum ("
+                    + String::number(AudioContext::maxNumberOfChannels()) + ")."));
+        } else if (numberOfOutputChannels > AudioContext::maxNumberOfChannels()) {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "ScriptProcessorNode",
+                    "number of output channels (" + String::number(numberOfInputChannels)
+                    + ") exceeds maximum ("
+                    + String::number(AudioContext::maxNumberOfChannels()) + ")."));
+        } else {
+            es.throwDOMException(
+                SyntaxError,
+                ExceptionMessages::failedToConstruct(
+                    "ScriptProcessorNode",
+                    "buffer size (" + String::number(bufferSize)
+                    + ") must be a power of two between 256 and 16384."));
+        }
         return 0;
     }
 
     refNode(node.get()); // context keeps reference until we stop making javascript rendering callbacks
     return node;
 }
 
 PassRefPtr<BiquadFilterNode> AudioContext::createBiquadFilter()
 {
     ASSERT(isMainThread());
@@ skipping 66 matching lines @@
 }
 
 PassRefPtr<ChannelSplitterNode> AudioContext::createChannelSplitter(size_t numberOfOutputs, ExceptionState& es)
 {
     ASSERT(isMainThread());
     lazyInitialize();
 
     RefPtr<ChannelSplitterNode> node = ChannelSplitterNode::create(this, m_destinationNode->sampleRate(), numberOfOutputs);
 
     if (!node.get()) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "ChannelSplitterNode",
+                "number of outputs (" + String::number(numberOfOutputs)
+                + ") must be between 1 and "
+                + String::number(AudioContext::maxNumberOfChannels()) + "."));
         return 0;
     }
 
     return node;
 }
 
 PassRefPtr<ChannelMergerNode> AudioContext::createChannelMerger(ExceptionState& es)
 {
     const unsigned ChannelMergerDefaultNumberOfInputs = 6;
     return createChannelMerger(ChannelMergerDefaultNumberOfInputs, es);
 }
 
 PassRefPtr<ChannelMergerNode> AudioContext::createChannelMerger(size_t numberOfInputs, ExceptionState& es)
 {
     ASSERT(isMainThread());
     lazyInitialize();
 
     RefPtr<ChannelMergerNode> node = ChannelMergerNode::create(this, m_destinationNode->sampleRate(), numberOfInputs);
 
     if (!node.get()) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "ChannelMergerNode",
+                "number of inputs (" + String::number(numberOfInputs)
+                + ") must be between 1 and "
+                + String::number(AudioContext::maxNumberOfChannels()) + "."));
         return 0;
     }
 
     return node;
 }
 
 PassRefPtr<OscillatorNode> AudioContext::createOscillator()
 {
     ASSERT(isMainThread());
     lazyInitialize();
 
     RefPtr<OscillatorNode> node = OscillatorNode::create(this, m_destinationNode->sampleRate());
 
     // Because this is an AudioScheduledSourceNode, the context keeps a reference until it has finished playing.
     // When this happens, AudioScheduledSourceNode::finish() calls AudioContext::notifyNodeFinishedProcessing().
     refNode(node.get());
 
     return node;
 }
 
 PassRefPtr<PeriodicWave> AudioContext::createPeriodicWave(Float32Array* real, Float32Array* imag, ExceptionState& es)
 {
     ASSERT(isMainThread());
 
-    if (!real || !imag || (real->length() != imag->length())) {
-        es.throwUninformativeAndGenericDOMException(SyntaxError);
+    if (!real) {
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "PeriodicWave",
+                "invalid real array"));
         return 0;
     }
 
+    if (!imag) {
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "PeriodicWave",
+                "invalid imaginary array"));
+        return 0;
+    }
+
+    if (real->length() != imag->length()) {
+        es.throwDOMException(
+            SyntaxError,
+            ExceptionMessages::failedToConstruct(
+                "PeriodicWave",
+                "length of real array (" + String::number(real->length())
+                + ") and length of imaginary array (" +  String::number(imag->length())
+                + ") must match."));
+        return 0;
+    }
+
     lazyInitialize();
     return PeriodicWave::create(sampleRate(), real, imag);
 }
 
 void AudioContext::notifyNodeFinishedProcessing(AudioNode* node)
 {
     ASSERT(isAudioThread());
     m_finishedNodes.append(node);
 }
 
@@ skipping 377 matching lines @@
 }
 
 void AudioContext::decrementActiveSourceCount()
 {
     atomicDecrement(&m_activeSourceCount);
 }
 
 } // namespace WebCore
 
 #endif // ENABLE(WEB_AUDIO)