Implement suspend/resume for AudioContext

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 12 matching lines @@
  */
 
 #include "config.h"
 
 #if ENABLE(WEB_AUDIO)
 
 #include "modules/webaudio/AudioContext.h"
 
 #include "bindings/core/v8/ExceptionMessages.h"
 #include "bindings/core/v8/ExceptionState.h"
+#include "bindings/core/v8/ScriptState.h"
 #include "core/dom/Document.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/html/HTMLMediaElement.h"
 #include "core/inspector/ScriptCallStack.h"
 #include "platform/audio/FFTFrame.h"
 #include "platform/audio/HRTFPanner.h"
 #include "modules/mediastream/MediaStream.h"
 #include "modules/webaudio/AnalyserNode.h"
 #include "modules/webaudio/AudioBuffer.h"
 #include "modules/webaudio/AudioBufferCallback.h"
@@ skipping 51 matching lines @@
     return audioContext;
 }
 
 // Constructor for rendering to the audio hardware.
 AudioContext::AudioContext(Document* document)
     : ActiveDOMObject(document)
     , m_isStopScheduled(false)
     , m_isCleared(false)
     , m_isInitialized(false)
     , m_destinationNode(nullptr)
+    , m_isResolvingResumePromises(false)
     , m_automaticPullNodesNeedUpdating(false)
     , m_connectionCount(0)
     , m_audioThread(0)
     , m_isOfflineContext(false)
+    , m_state(Paused)
 {
     m_destinationNode = DefaultAudioDestinationNode::create(this);
 
     initialize();
 #if DEBUG_AUDIONODE_REFERENCES
     fprintf(stderr, "%p: AudioContext::AudioContext() #%u\n", this, AudioContext::s_hardwareContextCount);
 #endif
 }
 
 // Constructor for offline (non-realtime) rendering.
 AudioContext::AudioContext(Document* document, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate)
     : ActiveDOMObject(document)
     , m_isStopScheduled(false)
     , m_isCleared(false)
     , m_isInitialized(false)
     , m_destinationNode(nullptr)
+    , m_isResolvingResumePromises(false)
     , m_automaticPullNodesNeedUpdating(false)
     , m_connectionCount(0)
     , m_audioThread(0)
     , m_isOfflineContext(true)
+    , m_state(Paused)
 {
     // Create a new destination for offline rendering.
     m_renderTarget = AudioBuffer::create(numberOfChannels, numberOfFrames, sampleRate);
     if (m_renderTarget.get())
         m_destinationNode = OfflineAudioDestinationNode::create(this, m_renderTarget.get());
 
     initialize();
 }
 
 AudioContext::~AudioContext()
@@ skipping 20 matching lines @@
     m_listener = AudioListener::create();
 
     if (m_destinationNode.get()) {
         m_destinationNode->initialize();
 
         if (!isOfflineContext()) {
             // This starts the audio thread. The destination node's provideInput() method will now be called repeatedly to render audio.
             // Each time provideInput() is called, a portion of the audio stream is rendered. Let's call this time period a "render quantum".
             // NOTE: for now default AudioContext does not need an explicit startRendering() call from JavaScript.
             // We may want to consider requiring it for symmetry with OfflineAudioContext.
             m_destinationNode->startRendering();

[haraken, 2014/10/15 15:36:26]

You can call startRendering() instead of m_destinationNode->startRendering().

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+            setState(Running);

[haraken, 2014/10/15 15:36:26]

Then you can remove this. It's important to reduce the call sites of setState to
avoid mistakes :)

[Raymond Toy, 2014/10/15 19:50:49]

Done.

             ++s_hardwareContextCount;
         }
 
         m_isInitialized = true;
     }
 }
 
 void AudioContext::clear()
 {
     // We need to run disposers before destructing m_contextGraphMutex.
@@ skipping 345 matching lines @@
         exceptionState.throwDOMException(
             IndexSizeError,
             "length of imaginary array (" + String::number(imag->length())
             + ") exceeds allowed maximum of 4096");
         return 0;
     }
 
     return PeriodicWave::create(sampleRate(), real, imag);
 }
 
+String AudioContext::state() const
+{
+    switch (m_state) {
+    case Paused:
+        return "paused";
+    case Running:
+        return "running";
+    case Released:
+        return "released";
+    }
+    ASSERT_NOT_REACHED();
+    return "running";

[haraken, 2014/10/15 15:36:26]

Nit: I'd return "".

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+}
+
+void AudioContext::setState(AudioContextState newState)
+{
+    // Validate the transitions
+    switch (newState) {
+    case Paused:
+        ASSERT(m_state == Running);
+        break;
+    case Running:
+        ASSERT(m_state == Paused);
+        break;
+    case Released:
+        break;

[haraken, 2014/10/15 15:36:26]

Shall we add ASSERT(m_state == Released) ?

[Raymond Toy, 2014/10/15 16:31:56]

When the close() method is implemented, it will be possible to transition to
Released from the Paused or Running state. But it's probably good to check that
m_state != Released. We shouldn't be releasing twice.

+    }
+
+    m_state = newState;
+}
+
+void AudioContext::suspendContext(ExceptionState& exceptionState)
+{
+    ASSERT(isMainThread());
+    AutoLocker locker(this);
+
+    if (m_state == Released) {
+        exceptionState.throwDOMException(
+            InvalidStateError,
+            "cannot suspend an AudioContext that has been released");

[haraken, 2014/10/15 15:36:26]

Nit: You can immediately return here. Then you don't need the following 'else'.

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+    } else {
+        if (m_destinationNode && !isOfflineContext()) {
+            m_destinationNode->stop();
+            setState(Paused);

[haraken, 2014/10/15 15:36:26]

Probably you want to implement a helper method for AudioContext::stopRendering
for consistency with AudioContext::startRendering.

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+        }
+    }
+}
+
+ScriptPromise AudioContext::resumeContext(ScriptState* scriptState)
+{
+    ASSERT(isMainThread());
+    AutoLocker locker(this);
+
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
+
+    ScriptPromise promise = resolver->promise();
+
+    if (isOfflineContext()) {
+        // For offline context, resolve now, but reject if the context has been released.
+        if (m_state == Released)
+            resolver->reject();
+        else
+            resolver->resolve();
+    } else {
+        // Restart the destination node to pull on the audio graph.
+        if (m_destinationNode) {
+            m_destinationNode->startRendering();

[haraken, 2014/10/15 15:36:26]

You can call startRendering() instead of m_destinationNode->startRendering().

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+            setState(Running);

[haraken, 2014/10/15 15:36:26]

Then you can remove this. We want to reduce the call sites of setState in order
to avoid mistakes.

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+        }
+
+        // Save the promise which will get resolved when the destination node starts pulling on the
+        // graph again.
+        m_resumePromises.append(resolver);
+    }
+
+    return promise;
+}
+
 void AudioContext::notifyNodeFinishedProcessing(AudioNode* node)
 {
     ASSERT(isAudioThread());
     m_finishedNodes.append(node);
 }
 
 void AudioContext::derefFinishedSourceNodes()
 {
     ASSERT(isGraphOwner());
     ASSERT(isAudioThread());
@@ skipping 86 matching lines @@
     // It's OK if the tryLock() fails, we'll just take slightly longer to pick up the changes.
     if (tryLock()) {
         // Update the channel count mode.
         updateChangedChannelCountMode();
 
         // Fixup the state of any dirty AudioSummingJunctions and AudioNodeOutputs.
         handleDirtyAudioSummingJunctions();
         handleDirtyAudioNodeOutputs();
 
         updateAutomaticPullNodes();
+        resolvePromisesForResume();
+
         unlock();
     }
 }
 
 void AudioContext::handlePostRenderTasks()
 {
     ASSERT(isAudioThread());
 
     // Must use a tryLock() here too.  Don't worry, the lock will very rarely be contended and this method is called frequently.
     // The worst that can happen is that there will be some nodes which will take slightly longer than usual to be deleted or removed
@@ skipping 145 matching lines @@
 }
 
 void AudioContext::processAutomaticPullNodes(size_t framesToProcess)
 {
     ASSERT(isAudioThread());
 
     for (unsigned i = 0; i < m_renderingAutomaticPullNodes.size(); ++i)
         m_renderingAutomaticPullNodes[i]->processIfNecessary(framesToProcess);
 }
 
+void AudioContext::resolvePromisesForResumeOnMainThread()
+{
+    ASSERT(isMainThread());
+    AutoLocker locker(this);
+
+    for (unsigned k = 0; k < m_resumePromises.size(); ++k) {
+        if (m_state == Released)
+            m_resumePromises[k]->reject();

[yhirano, 2014/10/15 09:02:27]

[opt] In general, it would be better to reject a promise with an Exception. That
being said, it seems that the spec doesn't state that so it's OK now.

[Raymond Toy, 2014/10/15 19:50:49]

Good idea. I've added an Exception.  The spec isn't quite finalized yet, and
we'll probably propose this addition.

+        else
+            m_resumePromises[k]->resolve();
+    }
+
+    m_resumePromises.clear();
+    m_isResolvingResumePromises = false;
+}
+
+void AudioContext::resolvePromisesForResume()
+{
+    // This is run inside the AudioContext's lock when handling pre-render tasks.

[haraken, 2014/10/15 15:36:26]

Nit: is run => runs

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+    ASSERT(isAudioThread());

[haraken, 2014/10/15 15:36:26]

Shall we add ASSERT(isGraphOwner()) ?

[Raymond Toy, 2014/10/15 19:50:50]

Done.

+
+    // Resolve any pending promises created by resume(). Only do this we if haven't already started
+    // resolving these promises. This gets called very often and it takes some time to resolve the
+    // promises in the main thread.
+    if (!m_isResolvingResumePromises && m_resumePromises.size() > 0) {
+        m_isResolvingResumePromises = true;
+        callOnMainThread(bind(&AudioContext::resolvePromisesForResumeOnMainThread, this));
+    }
+}
+
 const AtomicString& AudioContext::interfaceName() const
 {
     return EventTargetNames::AudioContext;
 }
 
 ExecutionContext* AudioContext::executionContext() const
 {
     return m_isStopScheduled ? 0 : ActiveDOMObject::executionContext();
 }
 
 void AudioContext::startRendering()
 {
+    ASSERT(isMainThread());
     destination()->startRendering();
+    setState(Running);
 }
 
 void AudioContext::fireCompletionEvent()
 {
     ASSERT(isMainThread());
     if (!isMainThread())
         return;
 
     AudioBuffer* renderedBuffer = m_renderTarget.get();
 
+    setState(Released);
+
     ASSERT(renderedBuffer);
     if (!renderedBuffer)
         return;
 
     // Avoid firing the event if the document has already gone away.
     if (executionContext()) {
         // Call the offline rendering completion event listener.
         dispatchEvent(OfflineAudioCompletionEvent::create(renderedBuffer));
     }
 }
@@ skipping 29 matching lines @@
 
     for (HashSet<AudioNode*>::iterator k = m_deferredCountModeChange.begin(); k != m_deferredCountModeChange.end(); ++k)
         (*k)->updateChannelCountMode();
 
     m_deferredCountModeChange.clear();
 }
 
 } // namespace blink
 
 #endif // ENABLE(WEB_AUDIO)