Implement BaseAudioContext

third_party/WebKit/Source/modules/webaudio/BaseAudioContext.h

 /*
  * 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
  *    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 AbstractAudioContext_h
-#define AbstractAudioContext_h
+#ifndef BaseAudioContext_h
+#define BaseAudioContext_h
 
 #include "bindings/core/v8/ActiveScriptWrappable.h"
 #include "bindings/core/v8/ScriptPromise.h"
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "core/dom/ActiveDOMObject.h"
 #include "core/dom/DOMTypedArray.h"
 #include "core/events/EventListener.h"
 #include "modules/EventTargetModules.h"
 #include "modules/ModulesExport.h"
 #include "modules/webaudio/AsyncAudioDecoder.h"
@@ skipping 34 matching lines @@
 class OscillatorNode;
 class PannerNode;
 class PeriodicWave;
 class ScriptProcessorNode;
 class ScriptPromiseResolver;
 class ScriptState;
 class SecurityOrigin;
 class StereoPannerNode;
 class WaveShaperNode;
 
-// AbstractAudioContext is the cornerstone of the web audio API and all AudioNodes are created from it.
+// BaseAudioContext is the cornerstone of the web audio API and all AudioNodes are created from it.
 // For thread safety between the audio thread and the main thread, it has a rendering graph locking mechanism.
 
-class MODULES_EXPORT AbstractAudioContext : public RefCountedGarbageCollectedEventTargetWithInlineData<AbstractAudioContext>, public ActiveScriptWrappable, public ActiveDOMObject {
-    REFCOUNTED_GARBAGE_COLLECTED_EVENT_TARGET(AbstractAudioContext);
-    USING_GARBAGE_COLLECTED_MIXIN(AbstractAudioContext);
+class MODULES_EXPORT BaseAudioContext : public RefCountedGarbageCollectedEventTargetWithInlineData<BaseAudioContext>, public ActiveScriptWrappable, public ActiveDOMObject {
+    REFCOUNTED_GARBAGE_COLLECTED_EVENT_TARGET(BaseAudioContext);
+    USING_GARBAGE_COLLECTED_MIXIN(BaseAudioContext);
     DEFINE_WRAPPERTYPEINFO();
 public:
     // The state of an audio context.  On creation, the state is Suspended. The state is Running if
     // audio is being processed (audio graph is being pulled for data). The state is Closed if the
     // audio context has been closed.  The valid transitions are from Suspended to either Running or
     // Closed; Running to Suspended or Closed. Once Closed, there are no valid transitions.
     enum AudioContextState {
         Suspended,
         Running,
         Closed
     };
 
     // Create an AudioContext for rendering to the audio hardware.
-    static AbstractAudioContext* create(Document&, ExceptionState&);
+    static BaseAudioContext* create(Document&, ExceptionState&);
 
-    ~AbstractAudioContext() override;
+    ~BaseAudioContext() override;
 
     DECLARE_VIRTUAL_TRACE();
 
     // Is the destination node initialized and ready to handle audio?
     bool isDestinationInitialized() const
     {
         AudioDestinationNode* dest = destination();
         return dest ? dest->audioDestinationHandler().isInitialized() : false;
     }
 
@@ skipping 25 matching lines @@
 
     // Handles the promise and callbacks when |decodeAudioData| is finished decoding.
     void handleDecodeAudioData(AudioBuffer*, ScriptPromiseResolver*, AudioBufferCallback* successCallback, AudioBufferCallback* errorCallback);
 
     AudioListener* listener() { return m_listener.get(); }
 
     virtual bool hasRealtimeConstraint() = 0;
 
     // The AudioNode create methods are called on the main thread (from JavaScript).
     AudioBufferSourceNode* createBufferSource(ExceptionState&);
-    MediaElementAudioSourceNode* createMediaElementSource(HTMLMediaElement*, ExceptionState&);
-    MediaStreamAudioSourceNode* createMediaStreamSource(MediaStream*, ExceptionState&);
-    MediaStreamAudioDestinationNode* createMediaStreamDestination(ExceptionState&);
     GainNode* createGain(ExceptionState&);
     BiquadFilterNode* createBiquadFilter(ExceptionState&);
     WaveShaperNode* createWaveShaper(ExceptionState&);
     DelayNode* createDelay(ExceptionState&);
     DelayNode* createDelay(double maxDelayTime, ExceptionState&);
     PannerNode* createPanner(ExceptionState&);
     ConvolverNode* createConvolver(ExceptionState&);
     DynamicsCompressorNode* createDynamicsCompressor(ExceptionState&);
     AnalyserNode* createAnalyser(ExceptionState&);
     ScriptProcessorNode* createScriptProcessor(ExceptionState&);
@@ skipping 88 matching lines @@
     //  - it has been stopped by its execution context.
     virtual bool isContextClosed() const { return m_isCleared; }
 
     // Get the security origin for this audio context.
     SecurityOrigin* getSecurityOrigin() const;
 
     // Get the PeriodicWave for the specified oscillator type.  The table is initialized internally
     // if necessary.
     PeriodicWave* periodicWave(int type);
 protected:
-    explicit AbstractAudioContext(Document*);
-    AbstractAudioContext(Document*, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate);
+    explicit BaseAudioContext(Document*);
+    BaseAudioContext(Document*, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate);
 
     void initialize();
     void uninitialize();
 
     void setContextState(AudioContextState);
 
     virtual void didClose() {}
 
     // Tries to handle AudioBufferSourceNodes that were started but became disconnected or was never
     // connected. Because these never get pulled anymore, they will stay around forever. So if we
     // can, try to stop them so they can be collected.
     void handleStoppableSourceNodes();
 
     Member<AudioDestinationNode> m_destinationNode;
 
     // FIXME(dominicc): Move m_resumeResolvers to AudioContext, because only
     // it creates these Promises.
     // Vector of promises created by resume(). It takes time to handle them, so we collect all of
     // the promises here until they can be resolved or rejected.
     HeapVector<Member<ScriptPromiseResolver>> m_resumeResolvers;
 
     void setClosedContextSampleRate(float newSampleRate) { m_closedContextSampleRate = newSampleRate; }
     float closedContextSampleRate() const { return m_closedContextSampleRate; }
+    void throwExceptionForClosedState(ExceptionState&);
+
 private:
     bool m_isCleared;
     void clear();
 
-    void throwExceptionForClosedState(ExceptionState&);
-
     // When the context goes away, there might still be some sources which
     // haven't finished playing.  Make sure to release them here.
     void releaseActiveSourceNodes();
 
     Member<AudioListener> m_listener;
 
     // Only accessed in the audio thread.
     // These raw pointers are safe because AudioSourceNodes in
     // m_activeSourceNodes own them.
     Vector<AudioHandler*> m_finishedSourceHandlers;
@@ skipping 18 matching lines @@
     // time and the audio context process loop is very fast, so we don't want to call resolve an
     // excessive number of times.
     bool m_isResolvingResumePromises;
 
     unsigned m_connectionCount;
 
     // Graph locking.
     bool m_didInitializeContextGraphMutex;
     RefPtr<DeferredTaskHandler> m_deferredTaskHandler;
 
-    // The state of the AbstractAudioContext.
+    // The state of the BaseAudioContext.
     AudioContextState m_contextState;
 
     AsyncAudioDecoder m_audioDecoder;
 
     // When a context is closed, the sample rate is cleared.  But decodeAudioData can be called
     // after the context has been closed and it needs the sample rate.  When the context is closed,
     // the sample rate is saved here.
     float m_closedContextSampleRate;
 
     // Vector of promises created by decodeAudioData.  This keeps the resolvers alive until
     // decodeAudioData finishes decoding and can tell the main thread to resolve them.
     HeapHashSet<Member<ScriptPromiseResolver>> m_decodeAudioResolvers;
 
     // PeriodicWave's for the builtin oscillator types.  These only depend on the sample rate. so
     // they can be shared with all OscillatorNodes in the context.  To conserve memory, these are
     // lazily initiialized on first use.
     Member<PeriodicWave> m_periodicWaveSine;
     Member<PeriodicWave> m_periodicWaveSquare;
     Member<PeriodicWave> m_periodicWaveSawtooth;
     Member<PeriodicWave> m_periodicWaveTriangle;
 
     // This is considering 32 is large enough for multiple channels audio.
     // It is somewhat arbitrary and could be increased if necessary.
     enum { MaxNumberOfChannels = 32 };
 };
 
 } // namespace blink
 
-#endif // AbstractAudioContext_h
+#endif // BaseAudioContext_h