Re-factor scheduling logic from AudioBufferSourceNode into AudioScheduledSourceNode
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioScheduledSourceNode.cpp
1 /*
2  * Copyright (C) 2012, 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 "AudioScheduledSourceNode.h"
30
31 #include "AudioContext.h"
32 #include "AudioUtilities.h"
33 #include <algorithm>
34 #include <wtf/MathExtras.h>
35
36 using namespace std;
37
38 namespace WebCore {
39
40 const double AudioScheduledSourceNode::UnknownTime = -1;
41
42 AudioScheduledSourceNode::AudioScheduledSourceNode(AudioContext* context, float sampleRate)
43     : AudioSourceNode(context, sampleRate)
44     , m_playbackState(UNSCHEDULED_STATE)
45     , m_startTime(0)
46     , m_endTime(UnknownTime)
47 {
48 }
49
50 void AudioScheduledSourceNode::updateSchedulingInfo(size_t quantumFrameSize,
51                                                     size_t& quantumStartFrame,
52                                                     size_t& quantumEndFrame,
53                                                     size_t& startFrame,
54                                                     size_t& endFrame,
55                                                     size_t& quantumFrameOffset,
56                                                     size_t& nonSilentFramesToProcess)
57 {
58     ASSERT(quantumFrameSize == AudioNode::ProcessingSizeInFrames);
59     if (quantumFrameSize != AudioNode::ProcessingSizeInFrames)
60         return;
61     
62     // Check if it's time to start playing.
63     double sampleRate = this->sampleRate();
64     quantumStartFrame = context()->currentSampleFrame();
65     quantumEndFrame = quantumStartFrame + quantumFrameSize;
66     startFrame = AudioUtilities::timeToSampleFrame(m_startTime, sampleRate);
67     endFrame = m_endTime == UnknownTime ? 0 : AudioUtilities::timeToSampleFrame(m_endTime, sampleRate);
68
69     // If we know the end time and it's already passed, then don't bother doing any more rendering this cycle.
70     if (m_endTime != UnknownTime && endFrame <= quantumStartFrame)
71         finish();
72
73     if (m_playbackState == UNSCHEDULED_STATE || m_playbackState == FINISHED_STATE || startFrame >= quantumEndFrame) {
74         // Output silence.
75         nonSilentFramesToProcess = 0;
76         return;
77     }
78
79     if (m_playbackState == SCHEDULED_STATE) {
80         // Increment the active source count only if we're transitioning from SCHEDULED_STATE to PLAYING_STATE.
81         m_playbackState = PLAYING_STATE;
82         context()->incrementActiveSourceCount();
83     }
84
85     quantumFrameOffset = startFrame > quantumStartFrame ? startFrame - quantumStartFrame : 0;
86     quantumFrameOffset = min(quantumFrameOffset, quantumFrameSize); // clamp to valid range
87     nonSilentFramesToProcess = quantumFrameSize - quantumFrameOffset;
88
89     return;
90 }
91
92 void AudioScheduledSourceNode::noteOn(double when)
93 {
94     ASSERT(isMainThread());
95     if (m_playbackState != UNSCHEDULED_STATE)
96         return;
97
98     m_startTime = when;
99     m_playbackState = SCHEDULED_STATE;
100 }
101
102 void AudioScheduledSourceNode::noteOff(double when)
103 {
104     ASSERT(isMainThread());
105     if (!(m_playbackState == SCHEDULED_STATE || m_playbackState == PLAYING_STATE))
106         return;
107     
108     when = max(0.0, when);
109     m_endTime = when;
110 }
111
112 void AudioScheduledSourceNode::finish()
113 {
114     if (m_playbackState != FINISHED_STATE) {
115         // Let the context dereference this AudioNode.
116         context()->notifyNodeFinishedProcessing(this);
117         m_playbackState = FINISHED_STATE;
118         context()->decrementActiveSourceCount();
119     }
120 }
121
122 } // namespace WebCore
123
124 #endif // ENABLE(WEB_AUDIO)