Remove all uses of PassRefPtr in WebCore/svg
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioScheduledSourceNode.h
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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef AudioScheduledSourceNode_h
30 #define AudioScheduledSourceNode_h
31
32 #include "AudioNode.h"
33 #include "ExceptionCode.h"
34
35 namespace WebCore {
36
37 class AudioBus;
38
39 class AudioScheduledSourceNode : public AudioNode {
40 public:
41     // These are the possible states an AudioScheduledSourceNode can be in:
42     //
43     // UNSCHEDULED_STATE - Initial playback state. Created, but not yet scheduled.
44     // SCHEDULED_STATE - Scheduled to play (via noteOn() or noteGrainOn()), but not yet playing.
45     // PLAYING_STATE - Generating sound.
46     // FINISHED_STATE - Finished generating sound.
47     //
48     // The state can only transition to the next state, except for the FINISHED_STATE which can
49     // never be changed.
50     enum PlaybackState {
51         // These must be defined with the same names and values as in the .idl file.
52         UNSCHEDULED_STATE = 0,
53         SCHEDULED_STATE = 1,
54         PLAYING_STATE = 2,
55         FINISHED_STATE = 3
56     };
57     
58     AudioScheduledSourceNode(AudioContext*, float sampleRate);
59
60     // Scheduling.
61     void start(ExceptionCode&);
62     void stop(ExceptionCode&);
63     void start(double when, ExceptionCode&);
64     void stop(double when, ExceptionCode&);
65
66 #if ENABLE(LEGACY_WEB_AUDIO)
67     void noteOn(double when, ExceptionCode&);
68     void noteOff(double when, ExceptionCode&);
69 #endif
70
71     unsigned short playbackState() const { return static_cast<unsigned short>(m_playbackState); }
72     bool isPlayingOrScheduled() const { return m_playbackState == PLAYING_STATE || m_playbackState == SCHEDULED_STATE; }
73     bool hasFinished() const { return m_playbackState == FINISHED_STATE; }
74
75 protected:
76     // Get frame information for the current time quantum.
77     // We handle the transition into PLAYING_STATE and FINISHED_STATE here,
78     // zeroing out portions of the outputBus which are outside the range of startFrame and endFrame.
79     //
80     // Each frame time is relative to the context's currentSampleFrame().
81     // quantumFrameOffset    : Offset frame in this time quantum to start rendering.
82     // nonSilentFramesToProcess : Number of frames rendering non-silence (will be <= quantumFrameSize).
83     void updateSchedulingInfo(size_t quantumFrameSize,
84                               AudioBus* outputBus,
85                               size_t& quantumFrameOffset,
86                               size_t& nonSilentFramesToProcess);
87
88     // Called when we have no more sound to play or the noteOff() time has been reached.
89     virtual void finish();
90
91     PlaybackState m_playbackState;
92
93     // m_startTime is the time to start playing based on the context's timeline (0 or a time less than the context's current time means "now").
94     double m_startTime; // in seconds
95
96     // m_endTime is the time to stop playing based on the context's timeline (0 or a time less than the context's current time means "now").
97     // If it hasn't been set explicitly, then the sound will not stop playing (if looping) or will stop when the end of the AudioBuffer
98     // has been reached.
99     double m_endTime; // in seconds
100
101     bool m_hasEndedListener;
102
103     static const double UnknownTime;
104
105 private:
106     bool addEventListener(const AtomicString& eventType, RefPtr<EventListener>&&, bool useCapture) override;
107     bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) override;
108     void removeAllEventListeners() override;
109 };
110
111 } // namespace WebCore
112
113 #endif // AudioScheduledSourceNode_h