29509e28c4afa54c6d46a13ad3c1f11b16c1a362
[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)
29
30 #include "MediaPlaybackTargetContext.h"
31 #include "MediaPlaybackTargetPicker.h"
32 #include "MediaPlaybackTargetPickerMock.h"
33 #include "MediaProducer.h"
34 #include "Timer.h"
35 #include <wtf/Ref.h>
36 #include <wtf/RefPtr.h>
37 #include <wtf/RunLoop.h>
38
39 namespace WebCore {
40
41 struct ClientState;
42 class IntRect;
43 class WebMediaSessionManagerClient;
44
45 class WebMediaSessionManager : public MediaPlaybackTargetPicker::Client {
46     WTF_MAKE_NONCOPYABLE(WebMediaSessionManager);
47 public:
48
49     WEBCORE_EXPORT static WebMediaSessionManager& shared();
50
51     WEBCORE_EXPORT void setMockMediaPlaybackTargetPickerEnabled(bool);
52     WEBCORE_EXPORT void setMockMediaPlaybackTargetPickerState(const String&, MediaPlaybackTargetContext::State);
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);
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
76     size_t find(WebMediaSessionManagerClient*, uint64_t);
77
78     void configurePlaybackTargetClients();
79     void configureNewClients();
80     void configurePlaybackTargetMonitoring();
81     void configureWatchdogTimer();
82
83     enum ConfigurationTaskFlags {
84         NoTask = 0,
85         InitialConfigurationTask = 1 << 0,
86         TargetClientsConfigurationTask = 1 << 1,
87         TargetMonitoringConfigurationTask = 1 << 2,
88         WatchdogTimerConfigurationTask = 1 << 3,
89     };
90     typedef unsigned ConfigurationTasks;
91     String toString(ConfigurationTasks);
92
93     void scheduleDelayedTask(ConfigurationTasks);
94     void taskTimerFired();
95
96     void watchdogTimerFired();
97
98     RunLoop::Timer<WebMediaSessionManager> m_taskTimer;
99     RunLoop::Timer<WebMediaSessionManager> m_watchdogTimer;
100
101     Vector<std::unique_ptr<ClientState>> m_clientState;
102     RefPtr<MediaPlaybackTarget> m_playbackTarget;
103     std::unique_ptr<WebCore::MediaPlaybackTargetPickerMock> m_pickerOverride;
104     ConfigurationTasks m_taskFlags { NoTask };
105     Seconds m_currentWatchdogInterval;
106     bool m_externalOutputDeviceAvailable { false };
107     bool m_targetChanged { false };
108     bool m_mockPickerEnabled { false };
109 };
110
111 } // namespace WebCore
112
113 #endif // ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS)