[Mac] Inactive AirPlay route should automatically timeout
[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 #ifndef WebMediaSessionManager_h
27 #define WebMediaSessionManager_h
28
29 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS)
30
31 #include "MediaPlaybackTargetPicker.h"
32 #include "MediaProducer.h"
33 #include "Timer.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 uint64_t addPlaybackTargetPickerClient(WebMediaSessionManagerClient&, uint64_t);
49     WEBCORE_EXPORT void removePlaybackTargetPickerClient(WebMediaSessionManagerClient&, uint64_t);
50     WEBCORE_EXPORT void removeAllPlaybackTargetPickerClients(WebMediaSessionManagerClient&);
51     WEBCORE_EXPORT void showPlaybackTargetPicker(WebMediaSessionManagerClient&, uint64_t, const IntRect&, bool);
52     WEBCORE_EXPORT void clientStateDidChange(WebMediaSessionManagerClient&, uint64_t, WebCore::MediaProducer::MediaStateFlags);
53
54 protected:
55     WebMediaSessionManager();
56     virtual ~WebMediaSessionManager();
57
58     virtual WebCore::MediaPlaybackTargetPicker& targetPicker() = 0;
59
60 private:
61
62     // MediaPlaybackTargetPicker::Client
63     virtual void setPlaybackTarget(Ref<WebCore::MediaPlaybackTarget>&&) override;
64     virtual void externalOutputDeviceAvailableDidChange(bool) override;
65
66     size_t find(WebMediaSessionManagerClient*, uint64_t);
67     void configurePlaybackTargetClients();
68     void configureNewClients();
69     void configurePlaybackTargetMonitoring();
70     void configureWatchdogTimer();
71
72     enum ConfigurationTaskFlags {
73         NoTask = 0,
74         InitialConfigurationTask = 1 << 0,
75         TargetClientsConfigurationTask = 1 << 1,
76         TargetMonitoringConfigurationTask = 1 << 2,
77         WatchdogTimerConfigurationTask = 1 << 3,
78     };
79     typedef unsigned ConfigurationTasks;
80     String toString(ConfigurationTasks);
81
82     void scheduleDelayedTask(ConfigurationTasks);
83     void taskTimerFired();
84
85     void watchdogTimerFired();
86
87     RunLoop::Timer<WebMediaSessionManager> m_taskTimer;
88     RunLoop::Timer<WebMediaSessionManager> m_watchdogTimer;
89
90     Vector<std::unique_ptr<ClientState>> m_clientState;
91     RefPtr<MediaPlaybackTarget> m_playbackTarget;
92     ConfigurationTasks m_taskFlags { NoTask };
93     double m_currentWatchdogInterval { 0 };
94     bool m_externalOutputDeviceAvailable { false };
95 };
96
97 } // namespace WebCore
98
99 #endif // ENABLE(WIRELESS_PLAYBACK_TARGET)
100
101 #endif // WebMediaSessionManager_h