Implement suspend() and resume() for OfflineAudioContext

Source/modules/webaudio/OfflineAudioContext.h

 /*
  * 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.
  */
 
 #ifndef OfflineAudioContext_h
 #define OfflineAudioContext_h
 
 #include "modules/ModulesExport.h"
 #include "modules/webaudio/AudioContext.h"
+#include "wtf/HashMap.h"
 
 namespace blink {
 
 class ExceptionState;
+class ScheduledSuspendContainer;
+
+// The HashMap with 'zero' key is needed because |currentSampleFrame| can be zero.
+using SuspendContainerMap = HashMap<size_t, RefPtr<ScheduledSuspendContainer>, DefaultHash<size_t>::Hash, WTF::UnsignedWithZeroKeyHashTraits<size_t>>;
 
 class MODULES_EXPORT OfflineAudioContext final : public AudioContext {
     DEFINE_WRAPPERTYPEINFO();
 public:
     static OfflineAudioContext* create(ExecutionContext*, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate, ExceptionState&);
 
     virtual ~OfflineAudioContext();
 
+    DECLARE_VIRTUAL_TRACE();
+
+    // Fire completion event when the rendering is finished.
+    void fireCompletionEvent() override;
+
+    // Check all the scheduled suspends if the context should suspend at
+    // currentTime(). Then post tasks to resolve promises on the main thread
+    // if necessary.
+    bool shouldSuspendNow() override;
+
+    // Clear suspensions marked as 'resolved' in the list.
+    void resolvePendingSuspendPromises() override;
+
+    DEFINE_ATTRIBUTE_EVENT_LISTENER(complete);
+
     ScriptPromise startOfflineRendering(ScriptState*);
+    ScriptPromise suspendOfflineRendering(ScriptState*, double);
+    ScriptPromise resumeOfflineRendering(ScriptState*);
+
 private:
     OfflineAudioContext(Document*, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate);
+
+    // Check if there is any duplicate entry in scheduled suspends and reject
+    // the promise if needed.
+    void checkDuplicateSuspend(PassRefPtr<ScheduledSuspendContainer>);
+
+    // Reject a suspend promise on the main thread when the validation fails.
+    void rejectSuspendPromiseOnMainThread(PassRefPtr<ScheduledSuspendContainer>);
+
+    // Resolve a pending suspend promise and removes it from the map.
+    void resolvePendingSuspendPromisesOnMainThread(PassRefPtr<ScheduledSuspendContainer>);
+
+    SuspendContainerMap m_scheduledSuspends;
+    RefPtrWillBeMember<ScriptPromiseResolver> m_completeResolver;
+
+    // This flag is necessary to indicate the rendering has actually started.
+    // Note that initial state of context is 'Suspended', which is the same
+    // state when the context is suspended.
+    bool m_isRenderingStarted;
+
+    // Total render sample length.
+    size_t m_totalRenderFrames;
+};
+
+// A container class for a pair of time information and the suspend promise
+// resolver.
+//
+// TODO: This class is |ThreadSafeRefCounted| because it needs to be accessed by

[haraken, 2015/06/30 07:41:51]

Add your name to TODO.

[hongchan, 2015/06/30 18:52:10]

Done.

+// the offline render thread which is not oilpan-enabled. This is a short-term
+// solution until the offline render thread gets oilpan coverage.
+class ScheduledSuspendContainer : public ThreadSafeRefCounted<ScheduledSuspendContainer> {
+public:
+    static PassRefPtr<ScheduledSuspendContainer> create(double suspendTime, size_t suspendFrame, PassRefPtrWillBeRawPtr<ScriptPromiseResolver>);
+    ~ScheduledSuspendContainer();
+
+    PassRefPtrWillBeRawPtr<ScriptPromiseResolver> resolver() { return m_resolver; }

[haraken, 2015/06/30 07:41:51]

I guess this should be ScriptPromiseResolver*, because it is not passing an
ownership of the ScriptPromiseResolver.

[hongchan, 2015/06/30 18:52:10]

I made this change from the suggestion from yhirano@.

I tried to change it to the raw pointer (and all the related parts), but it does
not compile any more so I reverted it back. I will keep PassRefPtrWillBeRawPtr
for the time being but am open to other suggestions.

+
+    double suspendTime() const { return m_suspendTime; }
+
+    size_t suspendFrame() const { return m_suspendFrame; }
+
+    // Query if the rendering should be suspended at |whenFrame|.
+    bool shouldSuspendAtFrame(size_t whenFrame) const;
+
+private:
+    ScheduledSuspendContainer(double suspendTime, size_t suspendFrame, PassRefPtrWillBeRawPtr<ScriptPromiseResolver>);
+
+    // Actual suspend time before the quantization by render quantum frame.
+    double m_suspendTime;
+
+    // Suspend sample frame. This is quantized by the render quantum size.
+    size_t m_suspendFrame;
+
+    // Associated promise resolver.
+    RefPtrWillBePersistent<ScriptPromiseResolver> m_resolver;
 };
 
 } // namespace blink
 
 #endif // OfflineAudioContext_h