33019a530132ad267a6ee385824457235fdcd5f2
[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
53     WEBCORE_EXPORT uint64_t addPlaybackTargetPickerClient(WebMediaSessionManagerClient&, uint64_t);
54     WEBCORE_EXPORT void removePlaybackTargetPickerClient(WebMediaSessionManagerClient&, uint64_t);
55     WEBCORE_EXPORT void removeAllPlaybackTargetPickerClients(WebMediaSessionManagerClient&);
56     WEBCORE_EXPORT void showPlaybackTargetPicker(WebMediaSessionManagerClient&, uint64_t, const IntRect&, bool, bool);
57     WEBCORE_EXPORT void clientStateDidChange(WebMediaSessionManagerClient&, uint64_t, WebCore::MediaProducer::MediaStateFlags);
58
59 protected:
60     WebMediaSessionManager();
61     virtual ~WebMediaSessionManager();
62
63     virtual WebCore::MediaPlaybackTargetPicker& platformPicker() = 0;
64     static WebMediaSessionManager& platformManager();
65
66 private:
67
68     WebCore::MediaPlaybackTargetPicker& targetPicker();
69     WebCore::MediaPlaybackTargetPickerMock& mockPicker();
70
71     // MediaPlaybackTargetPicker::Client
72     void setPlaybackTarget(Ref<WebCore::MediaPlaybackTarget>&&) override;
73     void externalOutputDeviceAvailableDidChange(bool) override;
74
75     size_t find(WebMediaSessionManagerClient*, uint64_t);
76
77     void configurePlaybackTargetClients();
78     void configureNewClients();
79     void configurePlaybackTargetMonitoring();
80     void configureWatchdogTimer();
81
82     enum ConfigurationTaskFlags {
83         NoTask = 0,
84         InitialConfigurationTask = 1 << 0,
85         TargetClientsConfigurationTask = 1 << 1,
86         TargetMonitoringConfigurationTask = 1 << 2,
87         WatchdogTimerConfigurationTask = 1 << 3,
88     };
89     typedef unsigned ConfigurationTasks;
90     String toString(ConfigurationTasks);
91
92     void scheduleDelayedTask(ConfigurationTasks);
93     void taskTimerFired();
94
95     void watchdogTimerFired();
96
97     RunLoop::Timer<WebMediaSessionManager> m_taskTimer;
98     RunLoop::Timer<WebMediaSessionManager> m_watchdogTimer;
99
100     Vector<std::unique_ptr<ClientState>> m_clientState;
101     RefPtr<MediaPlaybackTarget> m_playbackTarget;
102     std::unique_ptr<WebCore::MediaPlaybackTargetPickerMock> m_pickerOverride;
103     ConfigurationTasks m_taskFlags { NoTask };
104     Seconds m_currentWatchdogInterval;
105     bool m_externalOutputDeviceAvailable { false };
106     bool m_targetChanged { false };
107     bool m_mockPickerEnabled { false };
108 };
109
110 } // namespace WebCore
111
112 #endif // ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS_FAMILY)