a2773e6f9f23ba2664875b5e819a272ce7543596
[WebKit-https.git] / Source / WebKit / UIProcess / Cocoa / PlaybackSessionManagerProxy.h
1 /*
2  * Copyright (C) 2016-2017 Apple 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''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
29
30 #include "MessageReceiver.h"
31 #include <WebCore/GraphicsLayer.h>
32 #include <WebCore/MediaSelectionOption.h>
33 #include <WebCore/PlatformView.h>
34 #include <WebCore/PlaybackSessionModel.h>
35 #include <WebCore/TimeRanges.h>
36 #include <wtf/HashCountedSet.h>
37 #include <wtf/HashMap.h>
38 #include <wtf/HashSet.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/RefPtr.h>
41
42 #if PLATFORM(IOS)
43 #include <WebCore/PlaybackSessionInterfaceAVKit.h>
44 #else
45 #include <WebCore/PlaybackSessionInterfaceMac.h>
46 #endif
47
48 #if PLATFORM(IOS)
49 typedef WebCore::PlaybackSessionInterfaceAVKit PlatformPlaybackSessionInterface;
50 #else
51 typedef WebCore::PlaybackSessionInterfaceMac PlatformPlaybackSessionInterface;
52 #endif
53
54 namespace WebKit {
55
56 class WebPageProxy;
57 class PlaybackSessionManagerProxy;
58
59 class PlaybackSessionModelContext final: public RefCounted<PlaybackSessionModelContext>, public WebCore::PlaybackSessionModel  {
60 public:
61     static Ref<PlaybackSessionModelContext> create(PlaybackSessionManagerProxy& manager, uint64_t contextId)
62     {
63         return adoptRef(*new PlaybackSessionModelContext(manager, contextId));
64     }
65     virtual ~PlaybackSessionModelContext() { }
66
67     void invalidate() { m_manager = nullptr; }
68
69     // PlaybackSessionModel
70     void addClient(WebCore::PlaybackSessionModelClient&) final;
71     void removeClient(WebCore::PlaybackSessionModelClient&)final;
72
73     void durationChanged(double);
74     void currentTimeChanged(double);
75     void bufferedTimeChanged(double);
76     void playbackStartedTimeChanged(double);
77     void rateChanged(bool isPlaying, float playbackRate);
78     void seekableRangesChanged(WebCore::TimeRanges&, double lastModifiedTime, double liveUpdateInterval);
79     void canPlayFastReverseChanged(bool);
80     void audioMediaSelectionOptionsChanged(const Vector<WebCore::MediaSelectionOption>& options, uint64_t index);
81     void legibleMediaSelectionOptionsChanged(const Vector<WebCore::MediaSelectionOption>& options, uint64_t index);
82     void audioMediaSelectionIndexChanged(uint64_t selectedIndex);
83     void legibleMediaSelectionIndexChanged(uint64_t selectedIndex);
84     void externalPlaybackChanged(bool, PlaybackSessionModel::ExternalPlaybackTargetType, const String&);
85     void wirelessVideoPlaybackDisabledChanged(bool);
86     void mutedChanged(bool);
87     void volumeChanged(double);
88     void pictureInPictureSupportedChanged(bool);
89     void pictureInPictureActiveChanged(bool);
90
91 private:
92     friend class VideoFullscreenModelContext;
93
94     PlaybackSessionModelContext(PlaybackSessionManagerProxy& manager, uint64_t contextId)
95         : m_manager(&manager)
96         , m_contextId(contextId)
97     {
98     }
99
100     // PlaybackSessionModel
101     void play() final;
102     void pause() final;
103     void togglePlayState() final;
104     void beginScrubbing() final;
105     void endScrubbing() final;
106     void seekToTime(double, double, double) final;
107     void fastSeek(double time) final;
108     void beginScanningForward() final;
109     void beginScanningBackward() final;
110     void endScanning() final;
111     void selectAudioMediaOption(uint64_t) final;
112     void selectLegibleMediaOption(uint64_t) final;
113     void togglePictureInPicture() final;
114     void toggleMuted() final;
115     void setMuted(bool) final;
116     void setVolume(double) final;
117     void setPlayingOnSecondScreen(bool) final;
118
119     double playbackStartedTime() const final { return m_playbackStartedTime; }
120     double duration() const final { return m_duration; }
121     double currentTime() const final { return m_currentTime; }
122     double bufferedTime() const final { return m_bufferedTime; }
123     bool isPlaying() const final { return m_isPlaying; }
124     bool isScrubbing() const final { return m_isScrubbing; }
125     float playbackRate() const final { return m_playbackRate; }
126     Ref<WebCore::TimeRanges> seekableRanges() const final { return m_seekableRanges.copyRef(); }
127     double seekableTimeRangesLastModifiedTime() const final { return m_seekableTimeRangesLastModifiedTime; }
128     double liveUpdateInterval() const { return m_liveUpdateInterval; }
129     bool canPlayFastReverse() const final { return m_canPlayFastReverse; }
130     Vector<WebCore::MediaSelectionOption> audioMediaSelectionOptions() const final { return m_audioMediaSelectionOptions; }
131     uint64_t audioMediaSelectedIndex() const final { return m_audioMediaSelectedIndex; }
132     Vector<WebCore::MediaSelectionOption> legibleMediaSelectionOptions() const final { return m_legibleMediaSelectionOptions; }
133     uint64_t legibleMediaSelectedIndex() const final { return m_legibleMediaSelectedIndex; }
134     bool externalPlaybackEnabled() const final { return m_externalPlaybackEnabled; }
135     PlaybackSessionModel::ExternalPlaybackTargetType externalPlaybackTargetType() const final { return m_externalPlaybackTargetType; }
136     String externalPlaybackLocalizedDeviceName() const final { return m_externalPlaybackLocalizedDeviceName; }
137     bool wirelessVideoPlaybackDisabled() const final { return m_wirelessVideoPlaybackDisabled; }
138     bool isMuted() const final { return m_muted; }
139     double volume() const final { return m_volume; }
140     bool isPictureInPictureSupported() const final { return m_pictureInPictureSupported; }
141     bool isPictureInPictureActive() const final { return m_pictureInPictureActive; }
142
143     PlaybackSessionManagerProxy* m_manager;
144     uint64_t m_contextId;
145     HashSet<WebCore::PlaybackSessionModelClient*> m_clients;
146     double m_playbackStartedTime { 0 };
147     bool m_playbackStartedTimeNeedsUpdate { false };
148     double m_duration { 0 };
149     double m_currentTime { 0 };
150     double m_bufferedTime { 0 };
151     bool m_isPlaying { false };
152     bool m_isScrubbing { false };
153     float m_playbackRate { 0 };
154     Ref<WebCore::TimeRanges> m_seekableRanges { WebCore::TimeRanges::create() };
155     double m_seekableTimeRangesLastModifiedTime { 0 };
156     double m_liveUpdateInterval { 0 };
157     bool m_canPlayFastReverse { false };
158     Vector<WebCore::MediaSelectionOption> m_audioMediaSelectionOptions;
159     uint64_t m_audioMediaSelectedIndex { 0 };
160     Vector<WebCore::MediaSelectionOption> m_legibleMediaSelectionOptions;
161     uint64_t m_legibleMediaSelectedIndex { 0 };
162     bool m_externalPlaybackEnabled { false };
163     PlaybackSessionModel::ExternalPlaybackTargetType m_externalPlaybackTargetType { PlaybackSessionModel::TargetTypeNone };
164     String m_externalPlaybackLocalizedDeviceName;
165     bool m_wirelessVideoPlaybackDisabled { false };
166     bool m_muted { false };
167     double m_volume { 0 };
168     bool m_pictureInPictureSupported { false };
169     bool m_pictureInPictureActive { false };
170 };
171
172 class PlaybackSessionManagerProxy : public RefCounted<PlaybackSessionManagerProxy>, private IPC::MessageReceiver {
173 public:
174     static RefPtr<PlaybackSessionManagerProxy> create(WebPageProxy&);
175     virtual ~PlaybackSessionManagerProxy();
176
177     void invalidate();
178
179     PlatformPlaybackSessionInterface* controlsManagerInterface();
180     void requestControlledElementID();
181
182 private:
183     friend class PlaybackSessionModelContext;
184     friend class VideoFullscreenManagerProxy;
185
186     explicit PlaybackSessionManagerProxy(WebPageProxy&);
187     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) final;
188
189     typedef std::tuple<RefPtr<PlaybackSessionModelContext>, RefPtr<PlatformPlaybackSessionInterface>> ModelInterfaceTuple;
190     ModelInterfaceTuple createModelAndInterface(uint64_t contextId);
191     ModelInterfaceTuple& ensureModelAndInterface(uint64_t contextId);
192     PlaybackSessionModelContext& ensureModel(uint64_t contextId);
193     PlatformPlaybackSessionInterface& ensureInterface(uint64_t contextId);
194     void addClientForContext(uint64_t contextId);
195     void removeClientForContext(uint64_t contextId);
196
197     uint64_t controlsManagerContextId() const { return m_controlsManagerContextId; }
198
199     // Messages from PlaybackSessionManager
200     void setUpPlaybackControlsManagerWithID(uint64_t contextId);
201     void clearPlaybackControlsManager();
202     void resetMediaState(uint64_t contextId);
203     void currentTimeChanged(uint64_t contextId, double currentTime, double hostTime);
204     void bufferedTimeChanged(uint64_t contextId, double bufferedTime);
205     void seekableRangesVectorChanged(uint64_t contextId, Vector<std::pair<double, double>> ranges, double lastModifiedTime, double liveUpdateInterval);
206     void canPlayFastReverseChanged(uint64_t contextId, bool value);
207     void audioMediaSelectionOptionsChanged(uint64_t contextId, Vector<WebCore::MediaSelectionOption> options, uint64_t selectedIndex);
208     void legibleMediaSelectionOptionsChanged(uint64_t contextId, Vector<WebCore::MediaSelectionOption> options, uint64_t selectedIndex);
209     void audioMediaSelectionIndexChanged(uint64_t contextId, uint64_t selectedIndex);
210     void legibleMediaSelectionIndexChanged(uint64_t contextId, uint64_t selectedIndex);
211     void externalPlaybackPropertiesChanged(uint64_t contextId, bool enabled, uint32_t targetType, String localizedDeviceName);
212     void wirelessVideoPlaybackDisabledChanged(uint64_t contextId, bool);
213     void durationChanged(uint64_t contextId, double duration);
214     void playbackStartedTimeChanged(uint64_t contextId, double playbackStartedTime);
215     void rateChanged(uint64_t contextId, bool isPlaying, double rate);
216     void handleControlledElementIDResponse(uint64_t, String) const;
217     void mutedChanged(uint64_t contextId, bool muted);
218     void volumeChanged(uint64_t contextId, double volume);
219     void pictureInPictureSupportedChanged(uint64_t contextId, bool pictureInPictureSupported);
220     void pictureInPictureActiveChanged(uint64_t contextId, bool pictureInPictureActive);
221
222     // Messages to PlaybackSessionManager
223     void play(uint64_t contextId);
224     void pause(uint64_t contextId);
225     void togglePlayState(uint64_t contextId);
226     void beginScrubbing(uint64_t contextId);
227     void endScrubbing(uint64_t contextId);
228     void seekToTime(uint64_t contextId, double time, double before, double after);
229     void fastSeek(uint64_t contextId, double time);
230     void beginScanningForward(uint64_t contextId);
231     void beginScanningBackward(uint64_t contextId);
232     void endScanning(uint64_t contextId);
233     void selectAudioMediaOption(uint64_t contextId, uint64_t index);
234     void selectLegibleMediaOption(uint64_t contextId, uint64_t index);
235     void togglePictureInPicture(uint64_t contextId);
236     void toggleMuted(uint64_t contextId);
237     void setMuted(uint64_t contextId, bool);
238     void setVolume(uint64_t contextId, double);
239     void setPlayingOnSecondScreen(uint64_t contextId, bool);
240
241     WebPageProxy* m_page;
242     HashMap<uint64_t, ModelInterfaceTuple> m_contextMap;
243     uint64_t m_controlsManagerContextId { 0 };
244     HashCountedSet<uint64_t> m_clientCounts;
245 };
246
247 } // namespace WebKit
248
249 #endif // PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))