Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioBufferSourceNode.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 AudioBufferSourceNode_h
26 #define AudioBufferSourceNode_h
27
28 #include "AudioBuffer.h"
29 #include "AudioBus.h"
30 #include "AudioParam.h"
31 #include "AudioScheduledSourceNode.h"
32 #include "ExceptionCode.h"
33 #include "PannerNode.h"
34 #include <memory>
35 #include <wtf/Lock.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefPtr.h>
38
39 namespace WebCore {
40
41 class AudioContext;
42
43 // AudioBufferSourceNode is an AudioNode representing an audio source from an in-memory audio asset represented by an AudioBuffer.
44 // It generally will be used for short sounds which require a high degree of scheduling flexibility (can playback in rhythmically perfect ways).
45
46 class AudioBufferSourceNode : public AudioScheduledSourceNode {
47 public:
48     static Ref<AudioBufferSourceNode> create(AudioContext&, float sampleRate);
49
50     virtual ~AudioBufferSourceNode();
51
52     // AudioNode
53     void process(size_t framesToProcess) override;
54     void reset() override;
55
56     // setBuffer() is called on the main thread.  This is the buffer we use for playback.
57     // returns true on success.
58     bool setBuffer(AudioBuffer*);
59     AudioBuffer* buffer() { return m_buffer.get(); }
60
61     // numberOfChannels() returns the number of output channels.  This value equals the number of channels from the buffer.
62     // If a new buffer is set with a different number of channels, then this value will dynamically change.
63     unsigned numberOfChannels();
64
65     // Play-state
66     void start(ExceptionCode&);
67     void start(double when, ExceptionCode&);
68     void start(double when, double grainOffset, ExceptionCode&);
69     void start(double when, double grainOffset, double grainDuration, ExceptionCode&);
70
71 #if ENABLE(LEGACY_WEB_AUDIO)
72     void noteGrainOn(double when, double grainOffset, double grainDuration, ExceptionCode&);
73 #endif
74
75     // Note: the attribute was originally exposed as .looping, but to be more consistent in naming with <audio>
76     // and with how it's described in the specification, the proper attribute name is .loop
77     // The old attribute is kept for backwards compatibility.
78     bool loop() const { return m_isLooping; }
79     void setLoop(bool looping) { m_isLooping = looping; }
80
81     // Loop times in seconds.
82     double loopStart() const { return m_loopStart; }
83     double loopEnd() const { return m_loopEnd; }
84     void setLoopStart(double loopStart) { m_loopStart = loopStart; }
85     void setLoopEnd(double loopEnd) { m_loopEnd = loopEnd; }
86
87     // Deprecated.
88     bool looping();
89     void setLooping(bool);
90
91     AudioParam* gain() { return m_gain.get(); }
92     AudioParam* playbackRate() { return m_playbackRate.get(); }
93
94     // If a panner node is set, then we can incorporate doppler shift into the playback pitch rate.
95     void setPannerNode(PannerNode*);
96     void clearPannerNode();
97
98     // If we are no longer playing, propogate silence ahead to downstream nodes.
99     bool propagatesSilence() const override;
100
101     // AudioScheduledSourceNode
102     void finish() override;
103
104 private:
105     AudioBufferSourceNode(AudioContext&, float sampleRate);
106
107     double tailTime() const override { return 0; }
108     double latencyTime() const override { return 0; }
109
110     enum BufferPlaybackMode {
111         Entire,
112         Partial
113     };
114
115     void startPlaying(BufferPlaybackMode, double when, double grainOffset, double grainDuration, ExceptionCode&);
116
117     // Returns true on success.
118     bool renderFromBuffer(AudioBus*, unsigned destinationFrameOffset, size_t numberOfFrames);
119
120     // Render silence starting from "index" frame in AudioBus.
121     inline bool renderSilenceAndFinishIfNotLooping(AudioBus*, unsigned index, size_t framesToProcess);
122
123     // m_buffer holds the sample data which this node outputs.
124     RefPtr<AudioBuffer> m_buffer;
125
126     // Pointers for the buffer and destination.
127     std::unique_ptr<const float*[]> m_sourceChannels;
128     std::unique_ptr<float*[]> m_destinationChannels;
129
130     // Used for the "gain" and "playbackRate" attributes.
131     RefPtr<AudioParam> m_gain;
132     RefPtr<AudioParam> m_playbackRate;
133
134     // If m_isLooping is false, then this node will be done playing and become inactive after it reaches the end of the sample data in the buffer.
135     // If true, it will wrap around to the start of the buffer each time it reaches the end.
136     bool m_isLooping;
137
138     double m_loopStart;
139     double m_loopEnd;
140
141     // m_virtualReadIndex is a sample-frame index into our buffer representing the current playback position.
142     // Since it's floating-point, it has sub-sample accuracy.
143     double m_virtualReadIndex;
144
145     // Granular playback
146     bool m_isGrain;
147     double m_grainOffset; // in seconds
148     double m_grainDuration; // in seconds
149
150     // totalPitchRate() returns the instantaneous pitch rate (non-time preserving).
151     // It incorporates the base pitch rate, any sample-rate conversion factor from the buffer, and any doppler shift from an associated panner node.
152     double totalPitchRate();
153
154     // m_lastGain provides continuity when we dynamically adjust the gain.
155     float m_lastGain;
156
157     // We optionally keep track of a panner node which has a doppler shift that is incorporated into
158     // the pitch rate. We manually manage ref-counting because we want to use RefTypeConnection.
159     PannerNode* m_pannerNode;
160
161     // This synchronizes process() with setBuffer() which can cause dynamic channel count changes.
162     mutable Lock m_processMutex;
163 };
164
165 } // namespace WebCore
166
167 #endif // AudioBufferSourceNode_h