26f56354aba9eefbd84b843c29cca64846b79075
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioDestinationNode.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 #pragma once
26
27 #include "AudioBus.h"
28 #include "AudioIOCallback.h"
29 #include "AudioNode.h"
30 #include "ExceptionOr.h"
31 #include <wtf/CompletionHandler.h>
32
33 namespace WebCore {
34
35 class AudioDestinationNode : public AudioNode, public AudioIOCallback {
36     WTF_MAKE_ISO_ALLOCATED(AudioDestinationNode);
37 public:
38     AudioDestinationNode(BaseAudioContext&, float sampleRate);
39     virtual ~AudioDestinationNode();
40     
41     // AudioNode   
42     void process(size_t) override { }; // we're pulled by hardware so this is never called
43     
44     // The audio hardware calls render() to get the next render quantum of audio into destinationBus.
45     // It will optionally give us local/live audio input in sourceBus (if it's not 0).
46     void render(AudioBus* sourceBus, AudioBus* destinationBus, size_t numberOfFrames, const AudioIOPosition& outputPosition) override;
47
48     float sampleRate() const final { return m_sampleRate; }
49
50     size_t currentSampleFrame() const { return m_currentSampleFrame; }
51     double currentTime() const { return currentSampleFrame() / static_cast<double>(sampleRate()); }
52
53     virtual unsigned maxChannelCount() const = 0;
54
55     // Enable local/live input for the specified device.
56     virtual void enableInput(const String& inputDeviceId) = 0;
57
58     virtual void startRendering(CompletionHandler<void(Optional<Exception>&&)>&&) = 0;
59     virtual void resume(CompletionHandler<void(Optional<Exception>&&)>&& completionHandler) { completionHandler(WTF::nullopt); }
60     virtual void suspend(CompletionHandler<void(Optional<Exception>&&)>&& completionHandler) { completionHandler(WTF::nullopt); }
61     virtual void close(CompletionHandler<void()>&& completionHandler) { completionHandler(); }
62     virtual void restartRendering() { }
63
64     virtual bool isPlaying() { return false; }
65     void isPlayingDidChange() override;
66     bool isPlayingAudio() const { return m_isEffectivelyPlayingAudio; }
67     void setMuted(bool muted) { m_muted = muted; }
68
69     // AudioDestinationNodes are owned by the BaseAudioContext so we forward the refcounting to its BaseAudioContext.
70     void ref() final;
71     void deref() final;
72
73 protected:
74     double tailTime() const override { return 0; }
75     double latencyTime() const override { return 0; }
76
77     void setIsSilent(bool);
78     void updateIsEffectivelyPlayingAudio();
79
80     // Counts the number of sample-frames processed by the destination.
81     std::atomic<size_t> m_currentSampleFrame { 0 };
82
83     float m_sampleRate;
84     bool m_isSilent { true };
85     bool m_isEffectivelyPlayingAudio { false };
86     bool m_muted { false };
87 };
88
89 } // namespace WebCore