Implement the Remote Playback API.
[WebKit-https.git] / Source / WebCore / Modules / mediasession / WebMediaSessionManager.h
1 /*
2  * Copyright (C) 2015 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 ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS_FAMILY)
29
30 #include "MediaPlaybackTargetContext.h"
31 #include "MediaPlaybackTargetPicker.h"
32 #include "MediaPlaybackTargetPickerMock.h"
33 #include "MediaProducer.h"
34 #include <wtf/Ref.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/RunLoop.h>
37
38 namespace WebCore {
39
40 struct ClientState;
41 class IntRect;
42 class WebMediaSessionManagerClient;
43
44 class WebMediaSessionManager : public MediaPlaybackTargetPicker::Client {
45     WTF_MAKE_NONCOPYABLE(WebMediaSessionManager);
46 public:
47
48     WEBCORE_EXPORT static WebMediaSessionManager& shared();
49
50     WEBCORE_EXPORT void setMockMediaPlaybackTargetPickerEnabled(bool);
51     WEBCORE_EXPORT void setMockMediaPlaybackTargetPickerState(const String&, MediaPlaybackTargetContext::State);
52     WEBCORE_EXPORT void mockMediaPlaybackTargetPickerDismissPopup();
53
54     WEBCORE_EXPORT uint64_t addPlaybackTargetPickerClient(WebMediaSessionManagerClient&, uint64_t);
55     WEBCORE_EXPORT void removePlaybackTargetPickerClient(WebMediaSessionManagerClient&, uint64_t);
56     WEBCORE_EXPORT void removeAllPlaybackTargetPickerClients(WebMediaSessionManagerClient&);
57     WEBCORE_EXPORT void showPlaybackTargetPicker(WebMediaSessionManagerClient&, uint64_t, const IntRect&, bool, bool);
58     WEBCORE_EXPORT void clientStateDidChange(WebMediaSessionManagerClient&, uint64_t, WebCore::MediaProducer::MediaStateFlags);
59
60 protected:
61     WebMediaSessionManager();
62     virtual ~WebMediaSessionManager();
63
64     virtual WebCore::MediaPlaybackTargetPicker& platformPicker() = 0;
65     static WebMediaSessionManager& platformManager();
66
67 private:
68
69     WebCore::MediaPlaybackTargetPicker& targetPicker();
70     WebCore::MediaPlaybackTargetPickerMock& mockPicker();
71
72     // MediaPlaybackTargetPicker::Client
73     void setPlaybackTarget(Ref<WebCore::MediaPlaybackTarget>&&) override;
74     void externalOutputDeviceAvailableDidChange(bool) override;
75     void playbackTargetPickerWasDismissed() override;
76
77     size_t find(WebMediaSessionManagerClient*, uint64_t);
78
79     void configurePlaybackTargetClients();
80     void configureNewClients();
81     void configurePlaybackTargetMonitoring();
82     void configureWatchdogTimer();
83
84     enum ConfigurationTaskFlags {
85         NoTask = 0,
86         InitialConfigurationTask = 1 << 0,
87         TargetClientsConfigurationTask = 1 << 1,
88         TargetMonitoringConfigurationTask = 1 << 2,
89         WatchdogTimerConfigurationTask = 1 << 3,
90     };
91     typedef unsigned ConfigurationTasks;
92     String toString(ConfigurationTasks);
93
94     void scheduleDelayedTask(ConfigurationTasks);
95     void taskTimerFired();
96
97     void watchdogTimerFired();
98
99     RunLoop::Timer<WebMediaSessionManager> m_taskTimer;
100     RunLoop::Timer<WebMediaSessionManager> m_watchdogTimer;
101
102     Vector<std::unique_ptr<ClientState>> m_clientState;
103     RefPtr<MediaPlaybackTarget> m_playbackTarget;
104     std::unique_ptr<WebCore::MediaPlaybackTargetPickerMock> m_pickerOverride;
105     ConfigurationTasks m_taskFlags { NoTask };
106     Seconds m_currentWatchdogInterval;
107     bool m_externalOutputDeviceAvailable { false };
108     bool m_targetChanged { false };
109     bool m_playbackTargetPickerDismissed { false };
110     bool m_mockPickerEnabled { false };
111 };
112
113 } // namespace WebCore
114
115 #endif // ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS_FAMILY)