Convert more creator functions to return Ref instead of PassRefPtr.
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioContext.cpp
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 #include "config.h"
26
27 #if ENABLE(WEB_AUDIO)
28
29 #include "AudioContext.h"
30
31 #include "AnalyserNode.h"
32 #include "AsyncAudioDecoder.h"
33 #include "AudioBuffer.h"
34 #include "AudioBufferCallback.h"
35 #include "AudioBufferSourceNode.h"
36 #include "AudioListener.h"
37 #include "AudioNodeInput.h"
38 #include "AudioNodeOutput.h"
39 #include "BiquadFilterNode.h"
40 #include "ChannelMergerNode.h"
41 #include "ChannelSplitterNode.h"
42 #include "ConvolverNode.h"
43 #include "DefaultAudioDestinationNode.h"
44 #include "DelayNode.h"
45 #include "Document.h"
46 #include "DynamicsCompressorNode.h"
47 #include "ExceptionCode.h"
48 #include "FFTFrame.h"
49 #include "GainNode.h"
50 #include "HRTFDatabaseLoader.h"
51 #include "HRTFPanner.h"
52 #include "OfflineAudioCompletionEvent.h"
53 #include "OfflineAudioDestinationNode.h"
54 #include "OscillatorNode.h"
55 #include "Page.h"
56 #include "PannerNode.h"
57 #include "PeriodicWave.h"
58 #include <inspector/ScriptCallStack.h>
59 #include "ScriptController.h"
60 #include "ScriptProcessorNode.h"
61 #include "WaveShaperNode.h"
62
63 #if ENABLE(MEDIA_STREAM)
64 #include "MediaStream.h"
65 #include "MediaStreamAudioDestinationNode.h"
66 #include "MediaStreamAudioSource.h"
67 #include "MediaStreamAudioSourceNode.h"
68 #endif
69
70 #if ENABLE(VIDEO)
71 #include "HTMLMediaElement.h"
72 #include "MediaElementAudioSourceNode.h"
73 #endif
74
75 #if DEBUG_AUDIONODE_REFERENCES
76 #include <stdio.h>
77 #endif
78
79 #if USE(GSTREAMER)
80 #include "GStreamerUtilities.h"
81 #endif
82
83 #if PLATFORM(IOS)
84 #include "ScriptController.h"
85 #include "Settings.h"
86 #endif
87
88 #include <runtime/ArrayBuffer.h>
89 #include <wtf/Atomics.h>
90 #include <wtf/MainThread.h>
91 #include <wtf/Ref.h>
92 #include <wtf/RefCounted.h>
93 #include <wtf/text/WTFString.h>
94
95 // FIXME: check the proper way to reference an undefined thread ID
96 const int UndefinedThreadIdentifier = 0xffffffff;
97
98 const unsigned MaxPeriodicWaveLength = 4096;
99
100 namespace WebCore {
101     
102 bool AudioContext::isSampleRateRangeGood(float sampleRate)
103 {
104     // FIXME: It would be nice if the minimum sample-rate could be less than 44.1KHz,
105     // but that will require some fixes in HRTFPanner::fftSizeForSampleRate(), and some testing there.
106     return sampleRate >= 44100 && sampleRate <= 96000;
107 }
108
109 // Don't allow more than this number of simultaneous AudioContexts talking to hardware.
110 const unsigned MaxHardwareContexts = 4;
111 unsigned AudioContext::s_hardwareContextCount = 0;
112     
113 RefPtr<AudioContext> AudioContext::create(Document& document, ExceptionCode& ec)
114 {
115     UNUSED_PARAM(ec);
116
117     ASSERT(isMainThread());
118     if (s_hardwareContextCount >= MaxHardwareContexts)
119         return nullptr;
120
121     RefPtr<AudioContext> audioContext(adoptRef(new AudioContext(document)));
122     audioContext->suspendIfNeeded();
123     return audioContext.release();
124 }
125
126 // Constructor for rendering to the audio hardware.
127 AudioContext::AudioContext(Document& document)
128     : ActiveDOMObject(&document)
129     , m_isStopScheduled(false)
130     , m_isInitialized(false)
131     , m_isAudioThreadFinished(false)
132     , m_destinationNode(0)
133     , m_isDeletionScheduled(false)
134     , m_automaticPullNodesNeedUpdating(false)
135     , m_connectionCount(0)
136     , m_audioThread(0)
137     , m_graphOwnerThread(UndefinedThreadIdentifier)
138     , m_isOfflineContext(false)
139     , m_activeSourceCount(0)
140     , m_restrictions(NoRestrictions)
141 {
142     constructCommon();
143
144     m_destinationNode = DefaultAudioDestinationNode::create(this);
145
146     // Initialize the destination node's muted state to match the page's current muted state.
147     pageMutedStateDidChange();
148 }
149
150 // Constructor for offline (non-realtime) rendering.
151 AudioContext::AudioContext(Document& document, unsigned numberOfChannels, size_t numberOfFrames, float sampleRate)
152     : ActiveDOMObject(&document)
153     , m_isStopScheduled(false)
154     , m_isInitialized(false)
155     , m_isAudioThreadFinished(false)
156     , m_destinationNode(0)
157     , m_automaticPullNodesNeedUpdating(false)
158     , m_connectionCount(0)
159     , m_audioThread(0)
160     , m_graphOwnerThread(UndefinedThreadIdentifier)
161     , m_isOfflineContext(true)
162     , m_activeSourceCount(0)
163     , m_restrictions(NoRestrictions)
164 {
165     constructCommon();
166
167     // Create a new destination for offline rendering.
168     m_renderTarget = AudioBuffer::create(numberOfChannels, numberOfFrames, sampleRate);
169     m_destinationNode = OfflineAudioDestinationNode::create(this, m_renderTarget.get());
170 }
171
172 void AudioContext::constructCommon()
173 {
174     // According to spec AudioContext must die only after page navigate.
175     // Lets mark it as ActiveDOMObject with pending activity and unmark it in clear method.
176     setPendingActivity(this);
177
178 #if USE(GSTREAMER)
179     initializeGStreamer();
180 #endif
181
182     FFTFrame::initialize();
183     
184     m_listener = AudioListener::create();
185
186 #if PLATFORM(IOS)
187     if (!document()->settings() || document()->settings()->mediaPlaybackRequiresUserGesture())
188         addBehaviorRestriction(RequireUserGestureForAudioStartRestriction);
189     else
190         m_restrictions = NoRestrictions;
191 #endif
192
193 #if PLATFORM(COCOA)
194     addBehaviorRestriction(RequirePageConsentForAudioStartRestriction);
195 #endif
196 }
197
198 AudioContext::~AudioContext()
199 {
200 #if DEBUG_AUDIONODE_REFERENCES
201     fprintf(stderr, "%p: AudioContext::~AudioContext()\n", this);
202 #endif
203     // AudioNodes keep a reference to their context, so there should be no way to be in the destructor if there are still AudioNodes around.
204     ASSERT(!m_isInitialized);
205     ASSERT(m_isStopScheduled);
206     ASSERT(!m_nodesToDelete.size());
207     ASSERT(!m_referencedNodes.size());
208     ASSERT(!m_finishedNodes.size());
209     ASSERT(!m_automaticPullNodes.size());
210     if (m_automaticPullNodesNeedUpdating)
211         m_renderingAutomaticPullNodes.resize(m_automaticPullNodes.size());
212     ASSERT(!m_renderingAutomaticPullNodes.size());
213 }
214
215 void AudioContext::lazyInitialize()
216 {
217     if (!m_isInitialized) {
218         // Don't allow the context to initialize a second time after it's already been explicitly uninitialized.
219         ASSERT(!m_isAudioThreadFinished);
220         if (!m_isAudioThreadFinished) {
221             if (m_destinationNode.get()) {
222                 m_destinationNode->initialize();
223
224                 if (!isOfflineContext()) {
225                     document()->addAudioProducer(this);
226
227                     // This starts the audio thread. The destination node's provideInput() method will now be called repeatedly to render audio.
228                     // Each time provideInput() is called, a portion of the audio stream is rendered. Let's call this time period a "render quantum".
229                     // NOTE: for now default AudioContext does not need an explicit startRendering() call from JavaScript.
230                     // We may want to consider requiring it for symmetry with OfflineAudioContext.
231                     startRendering();
232                     ++s_hardwareContextCount;
233                 }
234
235             }
236             m_isInitialized = true;
237         }
238     }
239 }
240
241 void AudioContext::clear()
242 {
243     // We have to release our reference to the destination node before the context will ever be deleted since the destination node holds a reference to the context.
244     if (m_destinationNode)
245         m_destinationNode.clear();
246
247     // Audio thread is dead. Nobody will schedule node deletion action. Let's do it ourselves.
248     do {
249         deleteMarkedNodes();
250         m_nodesToDelete.appendVector(m_nodesMarkedForDeletion);
251         m_nodesMarkedForDeletion.clear();
252     } while (m_nodesToDelete.size());
253
254     // It was set in constructCommon.
255     unsetPendingActivity(this);
256 }
257
258 void AudioContext::uninitialize()
259 {
260     ASSERT(isMainThread());
261
262     if (!m_isInitialized)
263         return;
264
265     // This stops the audio thread and all audio rendering.
266     m_destinationNode->uninitialize();
267
268     // Don't allow the context to initialize a second time after it's already been explicitly uninitialized.
269     m_isAudioThreadFinished = true;
270
271     if (!isOfflineContext()) {
272         document()->removeAudioProducer(this);
273
274         ASSERT(s_hardwareContextCount);
275         --s_hardwareContextCount;
276     }
277
278     // Get rid of the sources which may still be playing.
279     derefUnfinishedSourceNodes();
280
281     m_isInitialized = false;
282 }
283
284 bool AudioContext::isInitialized() const
285 {
286     return m_isInitialized;
287 }
288
289 void AudioContext::stopDispatch(void* userData)
290 {
291     AudioContext* context = reinterpret_cast<AudioContext*>(userData);
292     ASSERT(context);
293     if (!context)
294         return;
295
296     context->uninitialize();
297     context->clear();
298 }
299
300 void AudioContext::stop()
301 {
302     // Usually ScriptExecutionContext calls stop twice.
303     if (m_isStopScheduled)
304         return;
305     m_isStopScheduled = true;
306
307     document()->updateIsPlayingAudio();
308
309     // Don't call uninitialize() immediately here because the ScriptExecutionContext is in the middle
310     // of dealing with all of its ActiveDOMObjects at this point. uninitialize() can de-reference other
311     // ActiveDOMObjects so let's schedule uninitialize() to be called later.
312     // FIXME: see if there's a more direct way to handle this issue.
313     callOnMainThread(stopDispatch, this);
314 }
315
316 Document* AudioContext::document() const
317 {
318     ASSERT(m_scriptExecutionContext);
319     return downcast<Document>(m_scriptExecutionContext);
320 }
321
322 PassRefPtr<AudioBuffer> AudioContext::createBuffer(unsigned numberOfChannels, size_t numberOfFrames, float sampleRate, ExceptionCode& ec)
323 {
324     RefPtr<AudioBuffer> audioBuffer = AudioBuffer::create(numberOfChannels, numberOfFrames, sampleRate);
325     if (!audioBuffer.get()) {
326         ec = NOT_SUPPORTED_ERR;
327         return nullptr;
328     }
329
330     return audioBuffer;
331 }
332
333 PassRefPtr<AudioBuffer> AudioContext::createBuffer(ArrayBuffer* arrayBuffer, bool mixToMono, ExceptionCode& ec)
334 {
335     ASSERT(arrayBuffer);
336     if (!arrayBuffer) {
337         ec = SYNTAX_ERR;
338         return nullptr;
339     }
340
341     RefPtr<AudioBuffer> audioBuffer = AudioBuffer::createFromAudioFileData(arrayBuffer->data(), arrayBuffer->byteLength(), mixToMono, sampleRate());
342     if (!audioBuffer.get()) {
343         ec = SYNTAX_ERR;
344         return nullptr;
345     }
346
347     return audioBuffer;
348 }
349
350 void AudioContext::decodeAudioData(ArrayBuffer* audioData, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback, ExceptionCode& ec)
351 {
352     if (!audioData) {
353         ec = SYNTAX_ERR;
354         return;
355     }
356     m_audioDecoder.decodeAsync(audioData, sampleRate(), successCallback, errorCallback);
357 }
358
359 PassRefPtr<AudioBufferSourceNode> AudioContext::createBufferSource()
360 {
361     ASSERT(isMainThread());
362     lazyInitialize();
363     RefPtr<AudioBufferSourceNode> node = AudioBufferSourceNode::create(this, m_destinationNode->sampleRate());
364
365     // Because this is an AudioScheduledSourceNode, the context keeps a reference until it has finished playing.
366     // When this happens, AudioScheduledSourceNode::finish() calls AudioContext::notifyNodeFinishedProcessing().
367     refNode(node.get());
368
369     return node;
370 }
371
372 #if ENABLE(VIDEO)
373 PassRefPtr<MediaElementAudioSourceNode> AudioContext::createMediaElementSource(HTMLMediaElement* mediaElement, ExceptionCode& ec)
374 {
375     ASSERT(mediaElement);
376     if (!mediaElement) {
377         ec = INVALID_STATE_ERR;
378         return nullptr;
379     }
380         
381     ASSERT(isMainThread());
382     lazyInitialize();
383     
384     // First check if this media element already has a source node.
385     if (mediaElement->audioSourceNode()) {
386         ec = INVALID_STATE_ERR;
387         return nullptr;
388     }
389         
390     RefPtr<MediaElementAudioSourceNode> node = MediaElementAudioSourceNode::create(this, mediaElement);
391
392     mediaElement->setAudioSourceNode(node.get());
393
394     refNode(node.get()); // context keeps reference until node is disconnected
395     return node;
396 }
397 #endif
398
399 #if ENABLE(MEDIA_STREAM)
400 PassRefPtr<MediaStreamAudioSourceNode> AudioContext::createMediaStreamSource(MediaStream* mediaStream, ExceptionCode& ec)
401 {
402     ASSERT(mediaStream);
403     if (!mediaStream) {
404         ec = INVALID_STATE_ERR;
405         return nullptr;
406     }
407
408     ASSERT(isMainThread());
409     lazyInitialize();
410
411     AudioSourceProvider* provider = 0;
412
413     Vector<RefPtr<MediaStreamTrack>> audioTracks = mediaStream->getAudioTracks();
414     RefPtr<MediaStreamTrack> audioTrack;
415
416     // FIXME: get a provider for non-local MediaStreams (like from a remote peer).
417     for (size_t i = 0; i < audioTracks.size(); ++i) {
418         audioTrack = audioTracks[i];
419         if (audioTrack->source()->isAudioStreamSource()) {
420             auto source = static_cast<MediaStreamAudioSource*>(audioTrack->source());
421             ASSERT(!source->deviceId().isEmpty());
422             destination()->enableInput(source->deviceId());
423             provider = destination()->localAudioInputProvider();
424             break;
425         }
426     }
427
428     RefPtr<MediaStreamAudioSourceNode> node = MediaStreamAudioSourceNode::create(this, mediaStream, audioTrack.get(), provider);
429
430     // FIXME: Only stereo streams are supported right now. We should be able to accept multi-channel streams.
431     node->setFormat(2, sampleRate());
432
433     refNode(node.get()); // context keeps reference until node is disconnected
434     return node;
435 }
436
437 PassRefPtr<MediaStreamAudioDestinationNode> AudioContext::createMediaStreamDestination()
438 {
439     // FIXME: Add support for an optional argument which specifies the number of channels.
440     // FIXME: The default should probably be stereo instead of mono.
441     return MediaStreamAudioDestinationNode::create(this, 1);
442 }
443
444 #endif
445
446 PassRefPtr<ScriptProcessorNode> AudioContext::createScriptProcessor(size_t bufferSize, ExceptionCode& ec)
447 {
448     // Set number of input/output channels to stereo by default.
449     return createScriptProcessor(bufferSize, 2, 2, ec);
450 }
451
452 PassRefPtr<ScriptProcessorNode> AudioContext::createScriptProcessor(size_t bufferSize, size_t numberOfInputChannels, ExceptionCode& ec)
453 {
454     // Set number of output channels to stereo by default.
455     return createScriptProcessor(bufferSize, numberOfInputChannels, 2, ec);
456 }
457
458 PassRefPtr<ScriptProcessorNode> AudioContext::createScriptProcessor(size_t bufferSize, size_t numberOfInputChannels, size_t numberOfOutputChannels, ExceptionCode& ec)
459 {
460     ASSERT(isMainThread());
461     lazyInitialize();
462     RefPtr<ScriptProcessorNode> node = ScriptProcessorNode::create(this, m_destinationNode->sampleRate(), bufferSize, numberOfInputChannels, numberOfOutputChannels);
463
464     if (!node.get()) {
465         ec = INDEX_SIZE_ERR;
466         return nullptr;
467     }
468
469     refNode(node.get()); // context keeps reference until we stop making javascript rendering callbacks
470     return node;
471 }
472
473 PassRefPtr<BiquadFilterNode> AudioContext::createBiquadFilter()
474 {
475     ASSERT(isMainThread());
476     lazyInitialize();
477     return BiquadFilterNode::create(this, m_destinationNode->sampleRate());
478 }
479
480 PassRefPtr<WaveShaperNode> AudioContext::createWaveShaper()
481 {
482     ASSERT(isMainThread());
483     lazyInitialize();
484     return WaveShaperNode::create(this);
485 }
486
487 PassRefPtr<PannerNode> AudioContext::createPanner()
488 {
489     ASSERT(isMainThread());
490     lazyInitialize();
491     return PannerNode::create(this, m_destinationNode->sampleRate());
492 }
493
494 PassRefPtr<ConvolverNode> AudioContext::createConvolver()
495 {
496     ASSERT(isMainThread());
497     lazyInitialize();
498     return ConvolverNode::create(this, m_destinationNode->sampleRate());
499 }
500
501 PassRefPtr<DynamicsCompressorNode> AudioContext::createDynamicsCompressor()
502 {
503     ASSERT(isMainThread());
504     lazyInitialize();
505     return DynamicsCompressorNode::create(this, m_destinationNode->sampleRate());
506 }
507
508 PassRefPtr<AnalyserNode> AudioContext::createAnalyser()
509 {
510     ASSERT(isMainThread());
511     lazyInitialize();
512     return AnalyserNode::create(this, m_destinationNode->sampleRate());
513 }
514
515 PassRefPtr<GainNode> AudioContext::createGain()
516 {
517     ASSERT(isMainThread());
518     lazyInitialize();
519     return GainNode::create(this, m_destinationNode->sampleRate());
520 }
521
522 PassRefPtr<DelayNode> AudioContext::createDelay(ExceptionCode& ec)
523 {
524     const double defaultMaxDelayTime = 1;
525     return createDelay(defaultMaxDelayTime, ec);
526 }
527
528 PassRefPtr<DelayNode> AudioContext::createDelay(double maxDelayTime, ExceptionCode& ec)
529 {
530     ASSERT(isMainThread());
531     lazyInitialize();
532     RefPtr<DelayNode> node = DelayNode::create(this, m_destinationNode->sampleRate(), maxDelayTime, ec);
533     if (ec)
534         return nullptr;
535     return node;
536 }
537
538 PassRefPtr<ChannelSplitterNode> AudioContext::createChannelSplitter(ExceptionCode& ec)
539 {
540     const unsigned ChannelSplitterDefaultNumberOfOutputs = 6;
541     return createChannelSplitter(ChannelSplitterDefaultNumberOfOutputs, ec);
542 }
543
544 PassRefPtr<ChannelSplitterNode> AudioContext::createChannelSplitter(size_t numberOfOutputs, ExceptionCode& ec)
545 {
546     ASSERT(isMainThread());
547     lazyInitialize();
548
549     RefPtr<ChannelSplitterNode> node = ChannelSplitterNode::create(this, m_destinationNode->sampleRate(), numberOfOutputs);
550
551     if (!node.get()) {
552         ec = SYNTAX_ERR;
553         return nullptr;
554     }
555
556     return node;
557 }
558
559 PassRefPtr<ChannelMergerNode> AudioContext::createChannelMerger(ExceptionCode& ec)
560 {
561     const unsigned ChannelMergerDefaultNumberOfInputs = 6;
562     return createChannelMerger(ChannelMergerDefaultNumberOfInputs, ec);
563 }
564
565 PassRefPtr<ChannelMergerNode> AudioContext::createChannelMerger(size_t numberOfInputs, ExceptionCode& ec)
566 {
567     ASSERT(isMainThread());
568     lazyInitialize();
569
570     RefPtr<ChannelMergerNode> node = ChannelMergerNode::create(this, m_destinationNode->sampleRate(), numberOfInputs);
571
572     if (!node.get()) {
573         ec = SYNTAX_ERR;
574         return nullptr;
575     }
576
577     return node;
578 }
579
580 PassRefPtr<OscillatorNode> AudioContext::createOscillator()
581 {
582     ASSERT(isMainThread());
583     lazyInitialize();
584
585     RefPtr<OscillatorNode> node = OscillatorNode::create(this, m_destinationNode->sampleRate());
586
587     // Because this is an AudioScheduledSourceNode, the context keeps a reference until it has finished playing.
588     // When this happens, AudioScheduledSourceNode::finish() calls AudioContext::notifyNodeFinishedProcessing().
589     refNode(node.get());
590
591     return node;
592 }
593
594 PassRefPtr<PeriodicWave> AudioContext::createPeriodicWave(Float32Array* real, Float32Array* imag, ExceptionCode& ec)
595 {
596     ASSERT(isMainThread());
597     
598     if (!real || !imag || (real->length() != imag->length() || (real->length() > MaxPeriodicWaveLength) || (real->length() <= 0))) {
599         ec = SYNTAX_ERR;
600         return nullptr;
601     }
602     
603     lazyInitialize();
604     return PeriodicWave::create(sampleRate(), real, imag);
605 }
606
607 void AudioContext::notifyNodeFinishedProcessing(AudioNode* node)
608 {
609     ASSERT(isAudioThread());
610     m_finishedNodes.append(node);
611 }
612
613 void AudioContext::derefFinishedSourceNodes()
614 {
615     ASSERT(isGraphOwner());
616     ASSERT(isAudioThread() || isAudioThreadFinished());
617     for (unsigned i = 0; i < m_finishedNodes.size(); i++)
618         derefNode(m_finishedNodes[i]);
619
620     m_finishedNodes.clear();
621 }
622
623 void AudioContext::refNode(AudioNode* node)
624 {
625     ASSERT(isMainThread());
626     AutoLocker locker(*this);
627     
628     node->ref(AudioNode::RefTypeConnection);
629     m_referencedNodes.append(node);
630 }
631
632 void AudioContext::derefNode(AudioNode* node)
633 {
634     ASSERT(isGraphOwner());
635     
636     node->deref(AudioNode::RefTypeConnection);
637
638     for (unsigned i = 0; i < m_referencedNodes.size(); ++i) {
639         if (node == m_referencedNodes[i]) {
640             m_referencedNodes.remove(i);
641             break;
642         }
643     }
644 }
645
646 void AudioContext::derefUnfinishedSourceNodes()
647 {
648     ASSERT(isMainThread() && isAudioThreadFinished());
649     for (unsigned i = 0; i < m_referencedNodes.size(); ++i)
650         m_referencedNodes[i]->deref(AudioNode::RefTypeConnection);
651
652     m_referencedNodes.clear();
653 }
654
655 void AudioContext::lock(bool& mustReleaseLock)
656 {
657     // Don't allow regular lock in real-time audio thread.
658     ASSERT(isMainThread());
659
660     ThreadIdentifier thisThread = currentThread();
661
662     if (thisThread == m_graphOwnerThread) {
663         // We already have the lock.
664         mustReleaseLock = false;
665     } else {
666         // Acquire the lock.
667         m_contextGraphMutex.lock();
668         m_graphOwnerThread = thisThread;
669         mustReleaseLock = true;
670     }
671 }
672
673 bool AudioContext::tryLock(bool& mustReleaseLock)
674 {
675     ThreadIdentifier thisThread = currentThread();
676     bool isAudioThread = thisThread == audioThread();
677
678     // Try to catch cases of using try lock on main thread - it should use regular lock.
679     ASSERT(isAudioThread || isAudioThreadFinished());
680     
681     if (!isAudioThread) {
682         // In release build treat tryLock() as lock() (since above ASSERT(isAudioThread) never fires) - this is the best we can do.
683         lock(mustReleaseLock);
684         return true;
685     }
686     
687     bool hasLock;
688     
689     if (thisThread == m_graphOwnerThread) {
690         // Thread already has the lock.
691         hasLock = true;
692         mustReleaseLock = false;
693     } else {
694         // Don't already have the lock - try to acquire it.
695         hasLock = m_contextGraphMutex.tryLock();
696         
697         if (hasLock)
698             m_graphOwnerThread = thisThread;
699
700         mustReleaseLock = hasLock;
701     }
702     
703     return hasLock;
704 }
705
706 void AudioContext::unlock()
707 {
708     ASSERT(currentThread() == m_graphOwnerThread);
709
710     m_graphOwnerThread = UndefinedThreadIdentifier;
711     m_contextGraphMutex.unlock();
712 }
713
714 bool AudioContext::isAudioThread() const
715 {
716     return currentThread() == m_audioThread;
717 }
718
719 bool AudioContext::isGraphOwner() const
720 {
721     return currentThread() == m_graphOwnerThread;
722 }
723
724 void AudioContext::addDeferredFinishDeref(AudioNode* node)
725 {
726     ASSERT(isAudioThread());
727     m_deferredFinishDerefList.append(node);
728 }
729
730 void AudioContext::handlePreRenderTasks()
731 {
732     ASSERT(isAudioThread());
733
734     // At the beginning of every render quantum, try to update the internal rendering graph state (from main thread changes).
735     // It's OK if the tryLock() fails, we'll just take slightly longer to pick up the changes.
736     bool mustReleaseLock;
737     if (tryLock(mustReleaseLock)) {
738         // Fixup the state of any dirty AudioSummingJunctions and AudioNodeOutputs.
739         handleDirtyAudioSummingJunctions();
740         handleDirtyAudioNodeOutputs();
741
742         updateAutomaticPullNodes();
743
744         if (mustReleaseLock)
745             unlock();
746     }
747 }
748
749 void AudioContext::handlePostRenderTasks()
750 {
751     ASSERT(isAudioThread());
752
753     // Must use a tryLock() here too. Don't worry, the lock will very rarely be contended and this method is called frequently.
754     // The worst that can happen is that there will be some nodes which will take slightly longer than usual to be deleted or removed
755     // from the render graph (in which case they'll render silence).
756     bool mustReleaseLock;
757     if (tryLock(mustReleaseLock)) {
758         // Take care of finishing any derefs where the tryLock() failed previously.
759         handleDeferredFinishDerefs();
760
761         // Dynamically clean up nodes which are no longer needed.
762         derefFinishedSourceNodes();
763
764         // Don't delete in the real-time thread. Let the main thread do it.
765         // Ref-counted objects held by certain AudioNodes may not be thread-safe.
766         scheduleNodeDeletion();
767
768         // Fixup the state of any dirty AudioSummingJunctions and AudioNodeOutputs.
769         handleDirtyAudioSummingJunctions();
770         handleDirtyAudioNodeOutputs();
771
772         updateAutomaticPullNodes();
773
774         if (mustReleaseLock)
775             unlock();
776     }
777 }
778
779 void AudioContext::handleDeferredFinishDerefs()
780 {
781     ASSERT(isAudioThread() && isGraphOwner());
782     for (unsigned i = 0; i < m_deferredFinishDerefList.size(); ++i) {
783         AudioNode* node = m_deferredFinishDerefList[i];
784         node->finishDeref(AudioNode::RefTypeConnection);
785     }
786     
787     m_deferredFinishDerefList.clear();
788 }
789
790 void AudioContext::markForDeletion(AudioNode* node)
791 {
792     ASSERT(isGraphOwner());
793
794     if (isAudioThreadFinished())
795         m_nodesToDelete.append(node);
796     else
797         m_nodesMarkedForDeletion.append(node);
798
799     // This is probably the best time for us to remove the node from automatic pull list,
800     // since all connections are gone and we hold the graph lock. Then when handlePostRenderTasks()
801     // gets a chance to schedule the deletion work, updateAutomaticPullNodes() also gets a chance to
802     // modify m_renderingAutomaticPullNodes.
803     removeAutomaticPullNode(node);
804 }
805
806 void AudioContext::scheduleNodeDeletion()
807 {
808     bool isGood = m_isInitialized && isGraphOwner();
809     ASSERT(isGood);
810     if (!isGood)
811         return;
812
813     // Make sure to call deleteMarkedNodes() on main thread.    
814     if (m_nodesMarkedForDeletion.size() && !m_isDeletionScheduled) {
815         m_nodesToDelete.appendVector(m_nodesMarkedForDeletion);
816         m_nodesMarkedForDeletion.clear();
817
818         m_isDeletionScheduled = true;
819
820         // Don't let ourself get deleted before the callback.
821         // See matching deref() in deleteMarkedNodesDispatch().
822         ref();
823         callOnMainThread(deleteMarkedNodesDispatch, this);
824     }
825 }
826
827 void AudioContext::deleteMarkedNodesDispatch(void* userData)
828 {
829     AudioContext* context = reinterpret_cast<AudioContext*>(userData);
830     ASSERT(context);
831     if (!context)
832         return;
833
834     context->deleteMarkedNodes();
835     context->deref();
836 }
837
838 void AudioContext::deleteMarkedNodes()
839 {
840     ASSERT(isMainThread());
841
842     // Protect this object from being deleted before we release the mutex locked by AutoLocker.
843     Ref<AudioContext> protect(*this);
844     {
845         AutoLocker locker(*this);
846
847         while (size_t n = m_nodesToDelete.size()) {
848             AudioNode* node = m_nodesToDelete[n - 1];
849             m_nodesToDelete.removeLast();
850
851             // Before deleting the node, clear out any AudioNodeInputs from m_dirtySummingJunctions.
852             unsigned numberOfInputs = node->numberOfInputs();
853             for (unsigned i = 0; i < numberOfInputs; ++i)
854                 m_dirtySummingJunctions.remove(node->input(i));
855
856             // Before deleting the node, clear out any AudioNodeOutputs from m_dirtyAudioNodeOutputs.
857             unsigned numberOfOutputs = node->numberOfOutputs();
858             for (unsigned i = 0; i < numberOfOutputs; ++i)
859                 m_dirtyAudioNodeOutputs.remove(node->output(i));
860
861             // Finally, delete it.
862             delete node;
863         }
864         m_isDeletionScheduled = false;
865     }
866 }
867
868 void AudioContext::markSummingJunctionDirty(AudioSummingJunction* summingJunction)
869 {
870     ASSERT(isGraphOwner());    
871     m_dirtySummingJunctions.add(summingJunction);
872 }
873
874 void AudioContext::removeMarkedSummingJunction(AudioSummingJunction* summingJunction)
875 {
876     ASSERT(isMainThread());
877     AutoLocker locker(*this);
878     m_dirtySummingJunctions.remove(summingJunction);
879 }
880
881 void AudioContext::markAudioNodeOutputDirty(AudioNodeOutput* output)
882 {
883     ASSERT(isGraphOwner());    
884     m_dirtyAudioNodeOutputs.add(output);
885 }
886
887 void AudioContext::handleDirtyAudioSummingJunctions()
888 {
889     ASSERT(isGraphOwner());    
890
891     for (HashSet<AudioSummingJunction*>::iterator i = m_dirtySummingJunctions.begin(); i != m_dirtySummingJunctions.end(); ++i)
892         (*i)->updateRenderingState();
893
894     m_dirtySummingJunctions.clear();
895 }
896
897 void AudioContext::handleDirtyAudioNodeOutputs()
898 {
899     ASSERT(isGraphOwner());    
900
901     for (HashSet<AudioNodeOutput*>::iterator i = m_dirtyAudioNodeOutputs.begin(); i != m_dirtyAudioNodeOutputs.end(); ++i)
902         (*i)->updateRenderingState();
903
904     m_dirtyAudioNodeOutputs.clear();
905 }
906
907 void AudioContext::addAutomaticPullNode(AudioNode* node)
908 {
909     ASSERT(isGraphOwner());
910
911     if (m_automaticPullNodes.add(node).isNewEntry)
912         m_automaticPullNodesNeedUpdating = true;
913 }
914
915 void AudioContext::removeAutomaticPullNode(AudioNode* node)
916 {
917     ASSERT(isGraphOwner());
918
919     if (m_automaticPullNodes.remove(node))
920         m_automaticPullNodesNeedUpdating = true;
921 }
922
923 void AudioContext::updateAutomaticPullNodes()
924 {
925     ASSERT(isGraphOwner());
926
927     if (m_automaticPullNodesNeedUpdating) {
928         // Copy from m_automaticPullNodes to m_renderingAutomaticPullNodes.
929         m_renderingAutomaticPullNodes.resize(m_automaticPullNodes.size());
930
931         unsigned j = 0;
932         for (HashSet<AudioNode*>::iterator i = m_automaticPullNodes.begin(); i != m_automaticPullNodes.end(); ++i, ++j) {
933             AudioNode* output = *i;
934             m_renderingAutomaticPullNodes[j] = output;
935         }
936
937         m_automaticPullNodesNeedUpdating = false;
938     }
939 }
940
941 void AudioContext::processAutomaticPullNodes(size_t framesToProcess)
942 {
943     ASSERT(isAudioThread());
944
945     for (unsigned i = 0; i < m_renderingAutomaticPullNodes.size(); ++i)
946         m_renderingAutomaticPullNodes[i]->processIfNecessary(framesToProcess);
947 }
948
949 ScriptExecutionContext* AudioContext::scriptExecutionContext() const
950 {
951     return m_isStopScheduled ? 0 : ActiveDOMObject::scriptExecutionContext();
952 }
953
954 void AudioContext::startRendering()
955 {
956     if (ScriptController::processingUserGesture())
957         removeBehaviorRestriction(AudioContext::RequireUserGestureForAudioStartRestriction);
958
959     if (pageConsentRequiredForAudioStart()) {
960         Page* page = document()->page();
961         if (page && !page->canStartMedia())
962             document()->addMediaCanStartListener(this);
963         else
964             removeBehaviorRestriction(AudioContext::RequirePageConsentForAudioStartRestriction);
965     }
966     destination()->startRendering();
967 }
968
969 void AudioContext::mediaCanStart()
970 {
971     removeBehaviorRestriction(AudioContext::RequirePageConsentForAudioStartRestriction);
972 }
973
974 bool AudioContext::isPlayingAudio()
975 {
976     return !m_isStopScheduled && m_destinationNode && m_destinationNode->isPlayingAudio();
977 }
978
979 void AudioContext::pageMutedStateDidChange()
980 {
981     if (m_destinationNode && document()->page())
982         m_destinationNode->setMuted(document()->page()->isMuted());
983 }
984
985 void AudioContext::isPlayingAudioDidChange()
986 {
987     document()->updateIsPlayingAudio();
988 }
989
990 void AudioContext::fireCompletionEvent()
991 {
992     ASSERT(isMainThread());
993     if (!isMainThread())
994         return;
995         
996     AudioBuffer* renderedBuffer = m_renderTarget.get();
997
998     ASSERT(renderedBuffer);
999     if (!renderedBuffer)
1000         return;
1001
1002     // Avoid firing the event if the document has already gone away.
1003     if (scriptExecutionContext()) {
1004         // Call the offline rendering completion event listener.
1005         dispatchEvent(OfflineAudioCompletionEvent::create(renderedBuffer));
1006     }
1007 }
1008
1009 void AudioContext::incrementActiveSourceCount()
1010 {
1011     ++m_activeSourceCount;
1012 }
1013
1014 void AudioContext::decrementActiveSourceCount()
1015 {
1016     --m_activeSourceCount;
1017 }
1018
1019 } // namespace WebCore
1020
1021 #endif // ENABLE(WEB_AUDIO)