Move more logic from AudioDestinationNode to its subclasses
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioContext.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2016-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 "BaseAudioContext.h"
29 #include "DefaultAudioDestinationNode.h"
30 #include "MediaCanStartListener.h"
31 #include "MediaProducer.h"
32 #include "PlatformMediaSession.h"
33 #include "VisibilityChangeClient.h"
34 #include <wtf/UniqueRef.h>
35
36 namespace WebCore {
37
38 class DOMWindow;
39 class HTMLMediaElement;
40 class MediaStream;
41 class MediaStreamAudioDestinationNode;
42 class MediaStreamAudioSourceNode;
43
44 struct AudioContextOptions;
45 struct AudioTimestamp;
46
47 class AudioContext final
48     : public BaseAudioContext
49     , public MediaProducer
50     , public MediaCanStartListener
51     , private PlatformMediaSessionClient
52     , private VisibilityChangeClient {
53     WTF_MAKE_ISO_ALLOCATED(AudioContext);
54 public:
55     // Create an AudioContext for rendering to the audio hardware.
56     static ExceptionOr<Ref<AudioContext>> create(Document&, AudioContextOptions&&);
57     ~AudioContext();
58
59     WEBCORE_EXPORT static void setDefaultSampleRateForTesting(Optional<float>);
60
61     void close(DOMPromiseDeferred<void>&&);
62
63     DefaultAudioDestinationNode& destination() final { return m_destinationNode.get(); }
64     const DefaultAudioDestinationNode& destination() const final { return m_destinationNode.get(); }
65
66     double baseLatency();
67
68     AudioTimestamp getOutputTimestamp(DOMWindow&);
69
70 #if ENABLE(VIDEO)
71     ExceptionOr<Ref<MediaElementAudioSourceNode>> createMediaElementSource(HTMLMediaElement&);
72 #endif
73 #if ENABLE(MEDIA_STREAM)
74     ExceptionOr<Ref<MediaStreamAudioSourceNode>> createMediaStreamSource(MediaStream&);
75     ExceptionOr<Ref<MediaStreamAudioDestinationNode>> createMediaStreamDestination();
76 #endif
77
78     void suspendRendering(DOMPromiseDeferred<void>&&);
79     void resumeRendering(DOMPromiseDeferred<void>&&);
80
81     void sourceNodeWillBeginPlayback(AudioNode&) final;
82     void lazyInitialize() final;
83
84     void startRendering();
85
86     void isPlayingAudioDidChange();
87
88     // Restrictions to change default behaviors.
89     enum BehaviorRestrictionFlags {
90         NoRestrictions = 0,
91         RequireUserGestureForAudioStartRestriction = 1 << 0,
92         RequirePageConsentForAudioStartRestriction = 1 << 1,
93     };
94     typedef unsigned BehaviorRestrictions;
95     BehaviorRestrictions behaviorRestrictions() const { return m_restrictions; }
96     void addBehaviorRestriction(BehaviorRestrictions restriction) { m_restrictions |= restriction; }
97     void removeBehaviorRestriction(BehaviorRestrictions restriction) { m_restrictions &= ~restriction; }
98
99 private:
100     AudioContext(Document&, const AudioContextOptions&);
101
102     bool willBeginPlayback();
103
104 #if !RELEASE_LOG_DISABLED
105     const Logger& logger() const final;
106 #endif
107
108     void constructCommon();
109
110     bool userGestureRequiredForAudioStart() const { return !isOfflineContext() && m_restrictions & RequireUserGestureForAudioStartRestriction; }
111     bool pageConsentRequiredForAudioStart() const { return !isOfflineContext() && m_restrictions & RequirePageConsentForAudioStartRestriction; }
112
113     bool willPausePlayback();
114
115     void uninitialize() final;
116     bool isOfflineContext() const final { return false; }
117
118     // MediaProducer
119     MediaProducer::MediaStateFlags mediaState() const final;
120     void pageMutedStateDidChange() final;
121
122     // PlatformMediaSessionClient
123     PlatformMediaSession::MediaType mediaType() const final { return isSuspended() ? PlatformMediaSession::MediaType::None : PlatformMediaSession::MediaType::WebAudio; }
124     PlatformMediaSession::MediaType presentationType() const final { return PlatformMediaSession::MediaType::WebAudio; }
125     void mayResumePlayback(bool shouldResume) final;
126     void suspendPlayback() final;
127     bool canReceiveRemoteControlCommands() const final { return false; }
128     void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument&) final { }
129     bool supportsSeeking() const final { return false; }
130     bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const final { return false; }
131     bool canProduceAudio() const final { return true; }
132     bool isSuspended() const final;
133     MediaSessionGroupIdentifier mediaSessionGroupIdentifier() const final;
134
135     // MediaCanStartListener.
136     void mediaCanStart(Document&) final;
137
138     // VisibilityChangeClient
139     void visibilityStateChanged() final;
140
141     // ActiveDOMObject
142     const char* activeDOMObjectName() const final;
143     void suspend(ReasonForSuspension) final;
144     void resume() final;
145
146     UniqueRef<DefaultAudioDestinationNode> m_destinationNode;
147     std::unique_ptr<PlatformMediaSession> m_mediaSession;
148
149     BehaviorRestrictions m_restrictions { NoRestrictions };
150
151     // [[suspended by user]] flag in the specification:
152     // https://www.w3.org/TR/webaudio/#dom-audiocontext-suspended-by-user-slot
153     bool m_wasSuspendedByScript { false };
154 };
155
156 } // WebCore
157
158 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::AudioContext)
159     static bool isType(const WebCore::BaseAudioContext& context) { return !context.isOfflineContext(); }
160 SPECIALIZE_TYPE_TRAITS_END()