666a353e165dc975ac391eed73b8a3c7c89a49a0
[WebKit-https.git] / Source / WebCore / webaudio / AudioContext.h
1 /*
2  * Copyright (C) 2010, Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1.  Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef AudioContext_h
26 #define AudioContext_h
27
28 #include "ActiveDOMObject.h"
29 #include "AudioBus.h"
30 #include "AudioDestinationNode.h"
31 #include "EventListener.h"
32 #include "EventTarget.h"
33 #include "HRTFDatabaseLoader.h"
34 #include <wtf/HashSet.h>
35 #include <wtf/OwnPtr.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/Threading.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/AtomicStringHash.h>
42
43 namespace WebCore {
44
45 class ArrayBuffer;
46 class AudioBuffer;
47 class AudioBufferSourceNode;
48 class AudioChannelMerger;
49 class AudioChannelSplitter;
50 class AudioGainNode;
51 class AudioPannerNode;
52 class AudioListener;
53 class DelayNode;
54 class Document;
55 class LowPass2FilterNode;
56 class HighPass2FilterNode;
57 class ConvolverNode;
58 class DynamicsCompressorNode;
59 class RealtimeAnalyserNode;
60 class JavaScriptAudioNode;
61
62 // AudioContext is the cornerstone of the web audio API and all AudioNodes are created from it.
63 // For thread safety between the audio thread and the main thread, it has a rendering graph locking mechanism. 
64
65 class AudioContext : public ActiveDOMObject, public RefCounted<AudioContext>, public EventTarget {
66 public:
67     // Create an AudioContext for rendering to the audio hardware.
68     static PassRefPtr<AudioContext> create(Document*);
69
70     // Create an AudioContext for offline (non-realtime) rendering.
71     static PassRefPtr<AudioContext> createOfflineContext(Document*, unsigned numberOfChannels, size_t numberOfFrames, double sampleRate);
72
73     virtual ~AudioContext();
74
75     bool isInitialized() const;
76     
77     bool isOfflineContext() { return m_isOfflineContext; }
78
79     // Returns true when initialize() was called AND all asynchronous initialization has completed.
80     bool isRunnable() const;
81
82     // Document notification
83     virtual void stop();
84
85     Document* document() const; // ASSERTs if document no longer exists.
86     bool hasDocument();
87
88     AudioDestinationNode* destination() { return m_destinationNode.get(); }
89     double currentTime() { return m_destinationNode->currentTime(); }
90     double sampleRate() { return m_destinationNode->sampleRate(); }
91
92     PassRefPtr<AudioBuffer> createBuffer(unsigned numberOfChannels, size_t numberOfFrames, double sampleRate);
93     PassRefPtr<AudioBuffer> createBuffer(ArrayBuffer* arrayBuffer, bool mixToMono);
94
95     // Keep track of this buffer so we can release memory after the context is shut down...
96     void refBuffer(PassRefPtr<AudioBuffer> buffer);
97
98     AudioListener* listener() { return m_listener.get(); }
99
100     // The AudioNode create methods are called on the main thread (from JavaScript).
101     PassRefPtr<AudioBufferSourceNode> createBufferSource();
102     PassRefPtr<AudioGainNode> createGainNode();
103     PassRefPtr<DelayNode> createDelayNode();
104     PassRefPtr<LowPass2FilterNode> createLowPass2Filter();
105     PassRefPtr<HighPass2FilterNode> createHighPass2Filter();
106     PassRefPtr<AudioPannerNode> createPanner();
107     PassRefPtr<ConvolverNode> createConvolver();
108     PassRefPtr<DynamicsCompressorNode> createDynamicsCompressor();    
109     PassRefPtr<RealtimeAnalyserNode> createAnalyser();
110     PassRefPtr<JavaScriptAudioNode> createJavaScriptNode(size_t bufferSize);
111     PassRefPtr<AudioChannelSplitter> createChannelSplitter();
112     PassRefPtr<AudioChannelMerger> createChannelMerger();
113
114     AudioBus* temporaryMonoBus() { return m_temporaryMonoBus.get(); }
115     AudioBus* temporaryStereoBus() { return m_temporaryStereoBus.get(); }
116
117     // When a source node has no more processing to do (has finished playing), then it tells the context to dereference it.
118     void notifyNodeFinishedProcessing(AudioNode*);
119
120     // Called at the start of each render quantum.
121     void handlePreRenderTasks();
122
123     // Called at the end of each render quantum.
124     void handlePostRenderTasks();
125
126     // Called periodically at the end of each render quantum to dereference finished source nodes.
127     void derefFinishedSourceNodes();
128
129     // We reap all marked nodes at the end of each realtime render quantum in deleteMarkedNodes().
130     void markForDeletion(AudioNode*);
131     void deleteMarkedNodes();
132
133     // Keeps track of the number of connections made.
134     void incrementConnectionCount()
135     {
136         ASSERT(isMainThread());
137         m_connectionCount++;
138     }
139
140     unsigned connectionCount() const { return m_connectionCount; }
141
142     //
143     // Thread Safety and Graph Locking:
144     //
145     
146     void setAudioThread(ThreadIdentifier thread) { m_audioThread = thread; } // FIXME: check either not initialized or the same
147     ThreadIdentifier audioThread() const { return m_audioThread; }
148     bool isAudioThread() const;
149
150     // Returns true only after the audio thread has been started and then shutdown.
151     bool isAudioThreadFinished() { return m_isAudioThreadFinished; }
152     
153     // mustReleaseLock is set to true if we acquired the lock in this method call and caller must unlock(), false if it was previously acquired.
154     void lock(bool& mustReleaseLock);
155
156     // Returns true if we own the lock.
157     // mustReleaseLock is set to true if we acquired the lock in this method call and caller must unlock(), false if it was previously acquired.
158     bool tryLock(bool& mustReleaseLock);
159
160     void unlock();
161
162     // Returns true if this thread owns the context's lock.
163     bool isGraphOwner() const;
164
165     class AutoLocker {
166     public:
167         AutoLocker(AudioContext* context)
168             : m_context(context)
169         {
170             ASSERT(context);
171             context->lock(m_mustReleaseLock);
172         }
173         
174         ~AutoLocker()
175         {
176             if (m_mustReleaseLock)
177                 m_context->unlock();
178         }
179     private:
180         AudioContext* m_context;
181         bool m_mustReleaseLock;
182     };
183     
184     // In AudioNode::deref() a tryLock() is used for calling finishDeref(), but if it fails keep track here.
185     void addDeferredFinishDeref(AudioNode*, AudioNode::RefType);
186
187     // In the audio thread at the start of each render cycle, we'll call handleDeferredFinishDerefs().
188     void handleDeferredFinishDerefs();
189
190     // Only accessed when the graph lock is held.
191     void markAudioNodeInputDirty(AudioNodeInput*);
192     void markAudioNodeOutputDirty(AudioNodeOutput*);
193
194     // EventTarget
195     virtual ScriptExecutionContext* scriptExecutionContext() const;
196     virtual AudioContext* toAudioContext();
197     virtual EventTargetData* eventTargetData() { return &m_eventTargetData; }
198     virtual EventTargetData* ensureEventTargetData() { return &m_eventTargetData; }
199
200     DEFINE_ATTRIBUTE_EVENT_LISTENER(complete);
201
202     // Reconcile ref/deref which are defined both in AudioNode and EventTarget.
203     using RefCounted<AudioContext>::ref;
204     using RefCounted<AudioContext>::deref;
205
206     void startRendering();
207     void fireCompletionEvent();
208     
209 private:
210     AudioContext(Document*);
211     AudioContext(Document*, unsigned numberOfChannels, size_t numberOfFrames, double sampleRate);
212     void constructCommon();
213
214     void lazyInitialize();
215     void uninitialize();
216     
217     bool m_isInitialized;
218     bool m_isAudioThreadFinished;
219     bool m_isAudioThreadShutdown;
220
221     Document* m_document;
222
223     // The context itself keeps a reference to all source nodes.  The source nodes, then reference all nodes they're connected to.
224     // In turn, these nodes reference all nodes they're connected to.  All nodes are ultimately connected to the AudioDestinationNode.
225     // When the context dereferences a source node, it will be deactivated from the rendering graph along with all other nodes it is
226     // uniquely connected to.  See the AudioNode::ref() and AudioNode::deref() methods for more details.
227     void refNode(AudioNode*);
228     void derefNode(AudioNode*);
229
230     // When the context goes away, there might still be some sources which haven't finished playing.
231     // Make sure to dereference them here.
232     void derefUnfinishedSourceNodes();
233
234     RefPtr<AudioDestinationNode> m_destinationNode;
235     RefPtr<AudioListener> m_listener;
236
237     // Only accessed in the main thread.
238     Vector<RefPtr<AudioBuffer> > m_allocatedBuffers;
239
240     // Only accessed in the audio thread.
241     Vector<AudioNode*> m_finishedNodes;
242
243     // We don't use RefPtr<AudioNode> here because AudioNode has a more complex ref() / deref() implementation
244     // with an optional argument for refType.  We need to use the special refType: RefTypeConnection
245     // Either accessed when the graph lock is held, or on the main thread when the audio thread has finished.
246     Vector<AudioNode*> m_referencedNodes;
247
248     // Accumulate nodes which need to be deleted at the end of a render cycle (in realtime thread) here.
249     Vector<AudioNode*> m_nodesToDelete;
250
251     // Only accessed when the graph lock is held.
252     HashSet<AudioNodeInput*> m_dirtyAudioNodeInputs;
253     HashSet<AudioNodeOutput*> m_dirtyAudioNodeOutputs;
254     void handleDirtyAudioNodeInputs();
255     void handleDirtyAudioNodeOutputs();
256
257     OwnPtr<AudioBus> m_temporaryMonoBus;
258     OwnPtr<AudioBus> m_temporaryStereoBus;
259
260     unsigned m_connectionCount;
261
262     // Graph locking.
263     Mutex m_contextGraphMutex;
264     volatile ThreadIdentifier m_audioThread;
265     volatile ThreadIdentifier m_graphOwnerThread; // if the lock is held then this is the thread which owns it, otherwise == UndefinedThreadIdentifier
266     
267     // Deferred de-referencing.
268     struct RefInfo {
269         RefInfo(AudioNode* node, AudioNode::RefType refType)
270             : m_node(node)
271             , m_refType(refType)
272         {
273         }
274         AudioNode* m_node;
275         AudioNode::RefType m_refType;
276     };    
277
278     // Only accessed in the audio thread.
279     Vector<RefInfo> m_deferredFinishDerefList;
280     
281     // HRTF Database loader
282     RefPtr<HRTFDatabaseLoader> m_hrtfDatabaseLoader;
283
284     // EventTarget
285     virtual void refEventTarget() { ref(); }
286     virtual void derefEventTarget() { deref(); }
287     EventTargetData m_eventTargetData;
288
289     RefPtr<AudioBuffer> m_renderTarget;
290     
291     bool m_isOfflineContext;
292 };
293
294 } // WebCore
295
296 #endif // AudioContext_h