Source/WebCore:
[WebKit-https.git] / Source / WebKit2 / UIProcess / Cocoa / WebPlaybackSessionManagerProxy.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/TimeRanges.h>
35 #include <WebCore/WebPlaybackSessionModel.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/WebPlaybackSessionInterfaceAVKit.h>
44 #else
45 #include <WebCore/WebPlaybackSessionInterfaceMac.h>
46 #endif
47
48 #if PLATFORM(IOS)
49 typedef WebCore::WebPlaybackSessionInterfaceAVKit PlatformWebPlaybackSessionInterface;
50 #else
51 typedef WebCore::WebPlaybackSessionInterfaceMac PlatformWebPlaybackSessionInterface;
52 #endif
53
54 namespace WebKit {
55
56 class WebPageProxy;
57 class WebPlaybackSessionManagerProxy;
58
59 class WebPlaybackSessionModelContext final: public RefCounted<WebPlaybackSessionModelContext>, public WebCore::WebPlaybackSessionModel  {
60 public:
61     static Ref<WebPlaybackSessionModelContext> create(WebPlaybackSessionManagerProxy& manager, uint64_t contextId)
62     {
63         return adoptRef(*new WebPlaybackSessionModelContext(manager, contextId));
64     }
65     virtual ~WebPlaybackSessionModelContext() { }
66
67     void invalidate() { m_manager = nullptr; }
68
69     // WebPlaybackSessionModel
70     void addClient(WebCore::WebPlaybackSessionModelClient&) final;
71     void removeClient(WebCore::WebPlaybackSessionModelClient&)final;
72
73     void setDuration(double);
74     void setCurrentTime(double);
75     void setBufferedTime(double);
76     void setPlaybackStartedTime(double);
77     void setRate(bool isPlaying, float playbackRate);
78     void setSeekableRanges(WebCore::TimeRanges&);
79     void setCanPlayFastReverse(bool);
80     void setAudioMediaSelectionOptions(const Vector<WebCore::MediaSelectionOption>& options, uint64_t index);
81     void setLegibleMediaSelectionOptions(const Vector<WebCore::MediaSelectionOption>& options, uint64_t index);
82     void setAudioMediaSelectionIndex(uint64_t selectedIndex);
83     void setLegibleMediaSelectionIndex(uint64_t selectedIndex);
84     void setExternalPlayback(bool, WebPlaybackSessionModel::ExternalPlaybackTargetType, const String&);
85     void setWirelessVideoPlaybackDisabled(bool);
86     void setMuted(bool);
87
88 private:
89     friend class WebVideoFullscreenModelContext;
90
91     WebPlaybackSessionModelContext(WebPlaybackSessionManagerProxy& manager, uint64_t contextId)
92         : m_manager(&manager)
93         , m_contextId(contextId)
94     {
95     }
96
97     // WebPlaybackSessionModel
98     void play() final;
99     void pause() final;
100     void togglePlayState() final;
101     void beginScrubbing() final;
102     void endScrubbing() final;
103     void seekToTime(double) final;
104     void fastSeek(double time) final;
105     void beginScanningForward() final;
106     void beginScanningBackward() final;
107     void endScanning() final;
108     void selectAudioMediaOption(uint64_t) final;
109     void selectLegibleMediaOption(uint64_t) final;
110     void togglePictureInPicture() final;
111     void toggleMuted() final;
112
113     double playbackStartedTime() const final { return m_playbackStartedTime; }
114     double duration() const final { return m_duration; }
115     double currentTime() const final { return m_currentTime; }
116     double bufferedTime() const final { return m_bufferedTime; }
117     bool isPlaying() const final { return m_isPlaying; }
118     bool isScrubbing() const final { return m_isScrubbing; }
119     float playbackRate() const final { return m_playbackRate; }
120     Ref<WebCore::TimeRanges> seekableRanges() const final { return m_seekableRanges.copyRef(); }
121     bool canPlayFastReverse() const final { return m_canPlayFastReverse; }
122     Vector<WebCore::MediaSelectionOption> audioMediaSelectionOptions() const final { return m_audioMediaSelectionOptions; }
123     uint64_t audioMediaSelectedIndex() const final { return m_audioMediaSelectedIndex; }
124     Vector<WebCore::MediaSelectionOption> legibleMediaSelectionOptions() const final { return m_legibleMediaSelectionOptions; }
125     uint64_t legibleMediaSelectedIndex() const final { return m_legibleMediaSelectedIndex; }
126     bool externalPlaybackEnabled() const final { return m_externalPlaybackEnabled; }
127     WebPlaybackSessionModel::ExternalPlaybackTargetType externalPlaybackTargetType() const final { return m_externalPlaybackTargetType; }
128     String externalPlaybackLocalizedDeviceName() const final { return m_externalPlaybackLocalizedDeviceName; }
129     bool wirelessVideoPlaybackDisabled() const final { return m_wirelessVideoPlaybackDisabled; }
130     bool isMuted() const final { return m_muted; }
131
132     WebPlaybackSessionManagerProxy* m_manager;
133     uint64_t m_contextId;
134     HashSet<WebCore::WebPlaybackSessionModelClient*> m_clients;
135     double m_playbackStartedTime { 0 };
136     bool m_playbackStartedTimeNeedsUpdate { false };
137     double m_duration { 0 };
138     double m_currentTime { 0 };
139     double m_bufferedTime { 0 };
140     bool m_isPlaying { false };
141     bool m_isScrubbing { false };
142     float m_playbackRate { 0 };
143     Ref<WebCore::TimeRanges> m_seekableRanges { WebCore::TimeRanges::create() };
144     bool m_canPlayFastReverse { false };
145     Vector<WebCore::MediaSelectionOption> m_audioMediaSelectionOptions;
146     uint64_t m_audioMediaSelectedIndex { 0 };
147     Vector<WebCore::MediaSelectionOption> m_legibleMediaSelectionOptions;
148     uint64_t m_legibleMediaSelectedIndex { 0 };
149     bool m_externalPlaybackEnabled { false };
150     WebPlaybackSessionModel::ExternalPlaybackTargetType m_externalPlaybackTargetType { WebPlaybackSessionModel::TargetTypeNone };
151     String m_externalPlaybackLocalizedDeviceName;
152     bool m_wirelessVideoPlaybackDisabled { false };
153     bool m_muted { false };
154 };
155
156 class WebPlaybackSessionManagerProxy : public RefCounted<WebPlaybackSessionManagerProxy>, private IPC::MessageReceiver {
157 public:
158     static RefPtr<WebPlaybackSessionManagerProxy> create(WebPageProxy&);
159     virtual ~WebPlaybackSessionManagerProxy();
160
161     void invalidate();
162
163     PlatformWebPlaybackSessionInterface* controlsManagerInterface();
164     void requestControlledElementID();
165
166 private:
167     friend class WebPlaybackSessionModelContext;
168     friend class WebVideoFullscreenManagerProxy;
169
170     explicit WebPlaybackSessionManagerProxy(WebPageProxy&);
171     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) final;
172
173     typedef std::tuple<RefPtr<WebPlaybackSessionModelContext>, RefPtr<PlatformWebPlaybackSessionInterface>> ModelInterfaceTuple;
174     ModelInterfaceTuple createModelAndInterface(uint64_t contextId);
175     ModelInterfaceTuple& ensureModelAndInterface(uint64_t contextId);
176     WebPlaybackSessionModelContext& ensureModel(uint64_t contextId);
177     PlatformWebPlaybackSessionInterface& ensureInterface(uint64_t contextId);
178     void addClientForContext(uint64_t contextId);
179     void removeClientForContext(uint64_t contextId);
180
181     // Messages from WebPlaybackSessionManager
182     void setUpPlaybackControlsManagerWithID(uint64_t contextId);
183     void clearPlaybackControlsManager();
184     void resetMediaState(uint64_t contextId);
185     void setCurrentTime(uint64_t contextId, double currentTime, double hostTime);
186     void setBufferedTime(uint64_t contextId, double bufferedTime);
187     void setSeekableRangesVector(uint64_t contextId, Vector<std::pair<double, double>> ranges);
188     void setCanPlayFastReverse(uint64_t contextId, bool value);
189     void setAudioMediaSelectionOptions(uint64_t contextId, Vector<WebCore::MediaSelectionOption> options, uint64_t selectedIndex);
190     void setLegibleMediaSelectionOptions(uint64_t contextId, Vector<WebCore::MediaSelectionOption> options, uint64_t selectedIndex);
191     void setAudioMediaSelectionIndex(uint64_t contextId, uint64_t selectedIndex);
192     void setLegibleMediaSelectionIndex(uint64_t contextId, uint64_t selectedIndex);
193     void setExternalPlaybackProperties(uint64_t contextId, bool enabled, uint32_t targetType, String localizedDeviceName);
194     void setWirelessVideoPlaybackDisabled(uint64_t contextId, bool);
195     void setDuration(uint64_t contextId, double duration);
196     void setPlaybackStartedTime(uint64_t contextId, double playbackStartedTime);
197     void setRate(uint64_t contextId, bool isPlaying, double rate);
198     void handleControlledElementIDResponse(uint64_t, String) const;
199     void setMuted(uint64_t contextId, bool muted);
200
201     // Messages to WebPlaybackSessionManager
202     void play(uint64_t contextId);
203     void pause(uint64_t contextId);
204     void togglePlayState(uint64_t contextId);
205     void beginScrubbing(uint64_t contextId);
206     void endScrubbing(uint64_t contextId);
207     void seekToTime(uint64_t contextId, double time);
208     void fastSeek(uint64_t contextId, double time);
209     void beginScanningForward(uint64_t contextId);
210     void beginScanningBackward(uint64_t contextId);
211     void endScanning(uint64_t contextId);
212     void selectAudioMediaOption(uint64_t contextId, uint64_t index);
213     void selectLegibleMediaOption(uint64_t contextId, uint64_t index);
214     void togglePictureInPicture(uint64_t contextId);
215     void toggleMuted(uint64_t contextId);
216
217     WebPageProxy* m_page;
218     HashMap<uint64_t, ModelInterfaceTuple> m_contextMap;
219     uint64_t m_controlsManagerContextId { 0 };
220     HashCountedSet<uint64_t> m_clientCounts;
221 };
222
223 } // namespace WebKit
224
225 #endif // PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))