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
@@ skipping 13 matching lines @@
 
 #ifndef OfflineAudioContext_h
 #define OfflineAudioContext_h
 
 #include "modules/ModulesExport.h"
 #include "modules/webaudio/AudioContext.h"
 
 namespace blink {
 
 class ExceptionState;
+class ScheduledSuspendContainer;
 
 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);
+
+    // Validate a suspend with various criteria on the render thread.
+    void checkDuplicateSuspend(ScheduledSuspendContainer*);
+
+    // TODO: Reject a suspend on the main thread after the validation fails.
+    void rejectSuspendOnMainThread(ScheduledSuspendContainer*);
+
+    // Resolve pending suspend promises and removes them from the list.
+    void resolvePendingSuspendPromisesOnMainThread();
+
+    HeapVector<Member<ScheduledSuspendContainer>> 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;
+
+    // MutexLocker for m_scheduledSuspends.
+    Mutex m_suspendMutex;
+};
+
+// A container class for a pair of time information and the suspend promise
+// resolver.
+class ScheduledSuspendContainer : public GarbageCollectedFinalized<ScheduledSuspendContainer> {
+public:
+    static ScheduledSuspendContainer* create(double suspendTime, size_t suspendFrame, PassRefPtrWillBeRawPtr<ScriptPromiseResolver>);
+    ~ScheduledSuspendContainer();
+
+    DECLARE_TRACE();
+
+    PassRefPtrWillBeRawPtr<ScriptPromiseResolver> resolver() { return m_resolver; }
+
+    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;
+
+    // Query if the suspend is pending for the promise resolution.
+    bool isPending() const;
+
+    // Mark the suspend as pending. Containers with 'pending' flag will
+    // be collectively resolved when the actual suspension happens.
+    void markAsPending();
+
+private:
+    ScheduledSuspendContainer(double suspendTime, size_t suspendFrame, PassRefPtrWillBeRawPtr<ScriptPromiseResolver>);
+
+    // Actual suspend time before the quantization by render quantum frame.
+    double m_suspendTime;
+
+    // Suspend time in samples.
+    size_t m_suspendFrame;
+
+    // Associated promise resolver.
+    RefPtrWillBeMember<ScriptPromiseResolver> m_resolver;
+
+    // A pending marker for the safe batch removal.
+    bool m_isPending;
 };
 
 } // namespace blink
 
 #endif // OfflineAudioContext_h