1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <WebCore/MediaSessionGroupIdentifier.h>
#include <WebCore/MediaUniqueIdentifier.h>
#include <WebCore/NowPlayingInfo.h>
#include <WebCore/NowPlayingMetadataObserver.h>
#include <WebCore/PageIdentifier.h>
#include <WebCore/PlatformMediaSessionTypes.h>
#include <wtf/AggregateLogger.h>
#include <wtf/CancellableTask.h>
#include <wtf/LoggerHelper.h>
#include <wtf/ProcessID.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/ThreadSafeWeakPtr.h>
#include <wtf/Vector.h>
#include <wtf/WeakHashSet.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class Page;
class PlatformMediaSessionInterface;
struct MediaConfiguration;
struct NowPlayingMetadata;
enum class MediaSessionRestriction : uint32_t {
NoRestrictions = 0,
ConcurrentPlaybackNotPermitted = 1 << 0,
BackgroundProcessPlaybackRestricted = 1 << 1,
BackgroundTabPlaybackRestricted = 1 << 2,
InterruptedPlaybackNotPermitted = 1 << 3,
InactiveProcessPlaybackRestricted = 1 << 4,
SuspendedUnderLockPlaybackRestricted = 1 << 5,
};
using MediaSessionRestrictions = OptionSet<MediaSessionRestriction>;
class WEBCORE_EXPORT MediaSessionManagerInterface
: public ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr<MediaSessionManagerInterface>
#if !RELEASE_LOG_DISABLED
, private LoggerHelper
#endif
{
WTF_MAKE_TZONE_ALLOCATED(MediaSessionManagerInterface);
public:
virtual ~MediaSessionManagerInterface();
virtual WeakPtr<PlatformMediaSessionInterface> bestEligibleSessionForRemoteControls(NOESCAPE const Function<bool(const PlatformMediaSessionInterface&)>&, PlatformMediaSessionPlaybackControlsPurpose) = 0;
virtual void forEachMatchingSession(NOESCAPE const Function<bool(const PlatformMediaSessionInterface&)>& predicate, NOESCAPE const Function<void(PlatformMediaSessionInterface&)>& matchingCallback) = 0;
virtual void setCurrentSession(PlatformMediaSessionInterface&) = 0;
virtual RefPtr<PlatformMediaSessionInterface> currentSession() const = 0;
virtual void addSession(PlatformMediaSessionInterface&);
virtual void removeSession(PlatformMediaSessionInterface&);
virtual bool hasNoSession() const;
virtual bool activeAudioSessionRequired() const;
virtual bool hasActiveAudioSession() const;
virtual bool canProduceAudio() const;
virtual void setShouldDeactivateAudioSession(bool should) { m_shouldDeactivateAudioSession = should; };
virtual bool shouldDeactivateAudioSession() { return m_shouldDeactivateAudioSession; };
virtual void updateNowPlayingInfoIfNecessary();
virtual void updateAudioSessionCategoryIfNecessary();
virtual std::optional<NowPlayingInfo> nowPlayingInfo() const { return { }; }
virtual bool hasActiveNowPlayingSession() const { return false; }
virtual String lastUpdatedNowPlayingTitle() const { return emptyString(); }
virtual double lastUpdatedNowPlayingDuration() const { return NAN; }
virtual double lastUpdatedNowPlayingElapsedTime() const { return NAN; }
virtual std::optional<MediaUniqueIdentifier> lastUpdatedNowPlayingInfoUniqueIdentifier() const { return std::nullopt; }
virtual void addNowPlayingMetadataObserver(const NowPlayingMetadataObserver&);
virtual void removeNowPlayingMetadataObserver(const NowPlayingMetadataObserver&);
virtual bool hasActiveNowPlayingSessionInGroup(std::optional<MediaSessionGroupIdentifier>);
virtual bool registeredAsNowPlayingApplication() const { return false; }
virtual bool haveEverRegisteredAsNowPlayingApplication() const { return false; }
virtual void resetHaveEverRegisteredAsNowPlayingApplicationForTesting() { };
virtual bool willIgnoreSystemInterruptions() const { return m_willIgnoreSystemInterruptions; }
virtual void setWillIgnoreSystemInterruptions(bool ignore) { m_willIgnoreSystemInterruptions = ignore; }
virtual void beginInterruption(PlatformMediaSessionInterruptionType);
virtual void endInterruption(PlatformMediaSessionEndInterruptionFlags);
virtual void applicationWillEnterForeground(bool);
virtual void applicationDidEnterBackground(bool);
virtual void applicationWillBecomeInactive();
virtual void applicationDidBecomeActive();
virtual void processWillSuspend();
virtual void processDidResume();
virtual void stopAllMediaPlaybackForProcess();
virtual bool mediaPlaybackIsPaused(std::optional<MediaSessionGroupIdentifier>);
virtual void pauseAllMediaPlaybackForGroup(std::optional<MediaSessionGroupIdentifier>);
virtual void suspendAllMediaPlaybackForGroup(std::optional<MediaSessionGroupIdentifier>);
virtual void resumeAllMediaPlaybackForGroup(std::optional<MediaSessionGroupIdentifier>);
virtual void suspendAllMediaBufferingForGroup(std::optional<MediaSessionGroupIdentifier>);
virtual void resumeAllMediaBufferingForGroup(std::optional<MediaSessionGroupIdentifier>);
virtual void addRestriction(PlatformMediaSessionMediaType, MediaSessionRestrictions);
virtual void removeRestriction(PlatformMediaSessionMediaType, MediaSessionRestrictions);
virtual MediaSessionRestrictions restrictions(PlatformMediaSessionMediaType);
virtual void resetRestrictions();
virtual bool sessionWillBeginPlayback(PlatformMediaSessionInterface&);
virtual void sessionWillEndPlayback(PlatformMediaSessionInterface&, DelayCallingUpdateNowPlaying);
virtual void sessionStateChanged(PlatformMediaSessionInterface&);
virtual void sessionDidEndRemoteScrubbing(PlatformMediaSessionInterface&) { }
virtual void sessionCanProduceAudioChanged();
virtual void clientCharacteristicsChanged(PlatformMediaSessionInterface&, bool) { }
virtual void configureWirelessTargetMonitoring() { }
virtual bool hasWirelessTargetsAvailable() { return false; }
virtual bool isMonitoringWirelessTargets() const { return false; }
virtual void sessionIsPlayingToWirelessPlaybackTargetChanged(PlatformMediaSessionInterface&);
virtual void setIsPlayingToAutomotiveHeadUnit(bool);
virtual bool isPlayingToAutomotiveHeadUnit() const { return m_isPlayingToAutomotiveHeadUnit; };
virtual void setSupportsSpatialAudioPlayback(bool);
virtual std::optional<bool> supportsSpatialAudioPlaybackForConfiguration(const MediaConfiguration&) { return m_supportsSpatialAudioPlayback; }
virtual void addAudioCaptureSource(AudioCaptureSource&);
virtual void removeAudioCaptureSource(AudioCaptureSource&);
virtual void audioCaptureSourceStateChanged() { updateSessionState(); }
virtual size_t audioCaptureSourceCount() const { return m_audioCaptureSources.computeSize(); }
virtual void processDidReceiveRemoteControlCommand(PlatformMediaSessionRemoteControlCommandType, const PlatformMediaSessionRemoteCommandArgument&);
virtual bool processIsSuspended() const { return m_processIsSuspended; };
virtual void processSystemWillSleep();
virtual void processSystemDidWake();
virtual bool isApplicationInBackground() const { return m_isApplicationInBackground; }
virtual bool isInterrupted() const { return !!m_currentInterruption; }
virtual void addSupportedCommand(PlatformMediaSessionRemoteControlCommandType) { };
virtual void removeSupportedCommand(PlatformMediaSessionRemoteControlCommandType) { };
virtual PlatformMediaSessionRemoteCommandsSet supportedCommands() const { return { }; };
virtual void scheduleSessionStatusUpdate() { }
virtual void resetSessionState() { };
protected:
MediaSessionManagerInterface(PageIdentifier);
virtual WeakListHashSet<PlatformMediaSessionInterface>& sessions() const = 0;
virtual Vector<WeakPtr<PlatformMediaSessionInterface>> copySessionsToVector() const = 0;
void forEachSession(NOESCAPE const Function<void(PlatformMediaSessionInterface&)>&);
void forEachSessionInGroup(std::optional<MediaSessionGroupIdentifier>, NOESCAPE const Function<void(PlatformMediaSessionInterface&)>&);
bool anyOfSessions(NOESCAPE const Function<bool(const PlatformMediaSessionInterface&)>&) const;
Vector<WeakPtr<PlatformMediaSessionInterface>> sessionsMatching(NOESCAPE const Function<bool(const PlatformMediaSessionInterface&)>&) const;
WeakPtr<PlatformMediaSessionInterface> firstSessionMatching(NOESCAPE const Function<bool(const PlatformMediaSessionInterface&)>&) const;
void maybeDeactivateAudioSession();
bool maybeActivateAudioSession();
void nowPlayingMetadataChanged(const NowPlayingMetadata&);
void enqueueTaskOnMainThread(Function<void()>&&);
int countActiveAudioCaptureSources();
std::optional<bool> supportsSpatialAudioPlayback() { return m_supportsSpatialAudioPlayback; }
bool computeSupportsSeeking() const;
void scheduleUpdateSessionState();
virtual void updateSessionState() { }
PageIdentifier pageIdentifier() const { return m_pageIdentifier; }
#if !RELEASE_LOG_DISABLED
void scheduleStateLog();
void dumpSessionStates();
const Logger& logger() const final { return m_logger; }
uint64_t logIdentifier() const final { return 0; }
ASCIILiteral logClassName() const override { return "MediaSessionManagerInterface"_s; }
WTFLogChannel& logChannel() const final;
#endif
bool willLog(WTFLogLevel) const;
private:
bool has(PlatformMediaSessionMediaType) const;
std::array<MediaSessionRestrictions, static_cast<unsigned>(PlatformMediaSessionMediaType::WebAudio) + 1> m_restrictions;
std::optional<bool> m_supportsSpatialAudioPlayback;
std::optional<PlatformMediaSessionInterruptionType> m_currentInterruption;
WeakHashSet<AudioCaptureSource> m_audioCaptureSources;
WeakHashSet<NowPlayingMetadataObserver> m_nowPlayingMetadataObservers;
TaskCancellationGroup m_taskGroup;
PageIdentifier m_pageIdentifier;
#if !RELEASE_LOG_DISABLED
UniqueRef<Timer> m_stateLogTimer;
const Ref<AggregateLogger> m_logger;
#endif
bool m_shouldDeactivateAudioSession { false };
bool m_willIgnoreSystemInterruptions { false };
bool m_isPlayingToAutomotiveHeadUnit { false };
bool m_processIsSuspended { false };
bool m_alreadyScheduledSessionStatedUpdate { false };
bool m_hasScheduledSessionStateUpdate { false };
mutable bool m_isApplicationInBackground { false };
#if USE(AUDIO_SESSION)
bool m_becameActive { false };
#endif
};
} // namespace WebCore
|
