Move more logic from AudioDestinationNode to its subclasses
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioDestinationNode.h
1 /*
2  * Copyright (C) 2010, Google Inc. All rights reserved.
3  * Copyright (C) 2020-2021, Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "AudioNode.h"
29 #include <wtf/CompletionHandler.h>
30
31 namespace WebCore {
32
33 class AudioBus;
34 struct AudioIOPosition;
35
36 class AudioDestinationNode : public AudioNode {
37     WTF_MAKE_ISO_ALLOCATED(AudioDestinationNode);
38 public:
39     ~AudioDestinationNode();
40     
41     // AudioNode   
42     void process(size_t) final { } // we're pulled by hardware so this is never called
43
44     float sampleRate() const final { return m_sampleRate; }
45
46     size_t currentSampleFrame() const { return m_currentSampleFrame; }
47     double currentTime() const { return currentSampleFrame() / static_cast<double>(sampleRate()); }
48
49     virtual unsigned maxChannelCount() const = 0;
50
51     // Enable local/live input for the specified device.
52     virtual void enableInput(const String& inputDeviceId) = 0;
53
54     virtual void startRendering(CompletionHandler<void(Optional<Exception>&&)>&&) = 0;
55     virtual void restartRendering() { }
56
57     // AudioDestinationNodes are owned by the BaseAudioContext so we forward the refcounting to its BaseAudioContext.
58     void ref() final;
59     void deref() final;
60
61 protected:
62     AudioDestinationNode(BaseAudioContext&, float sampleRate);
63
64     double tailTime() const final { return 0; }
65     double latencyTime() const final { return 0; }
66
67     void renderQuantum(AudioBus* destinationBus, size_t numberOfFrames, const AudioIOPosition& outputPosition);
68
69 private:
70     // Counts the number of sample-frames processed by the destination.
71     std::atomic<size_t> m_currentSampleFrame { 0 };
72     float m_sampleRate;
73 };
74
75 } // namespace WebCore