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