2d9518448dc58d3decbe7adbef92a1d97320ac23
[WebKit-https.git] / Source / WebCore / platform / graphics / DisplayRefreshMonitor.h
1 /*
2  * Copyright (C) 2010 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DisplayRefreshMonitor_h
27 #define DisplayRefreshMonitor_h
28
29 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
30
31 #include "PlatformScreen.h"
32 #include <wtf/HashMap.h>
33 #include <wtf/HashSet.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/Threading.h>
37
38 #if PLATFORM(COCOA)
39 typedef struct __CVDisplayLink *CVDisplayLinkRef;
40 #endif
41
42 namespace WebCore {
43
44 class DisplayAnimationClient;
45 class DisplayRefreshMonitor;
46 class DisplayRefreshMonitorManager;
47
48 //
49 // Abstract virtual client which receives refresh fired messages on the main thread
50 //
51 class DisplayRefreshMonitorClient {
52     friend class DisplayRefreshMonitor;
53     friend class DisplayRefreshMonitorManager;
54     
55 public:
56     DisplayRefreshMonitorClient();
57     virtual ~DisplayRefreshMonitorClient();
58     
59     virtual void displayRefreshFired(double timestamp) = 0;
60
61 private:
62     void fireDisplayRefreshIfNeeded(double timestamp);
63     
64     void setDisplayID(PlatformDisplayID displayID)
65     {
66         m_displayID = displayID;
67         m_displayIDIsSet = true;
68     }
69     
70     bool m_scheduled;
71     bool m_displayIDIsSet;
72     PlatformDisplayID m_displayID;
73 };
74
75 //
76 // Monitor for display refresh messages for a given screen
77 //
78
79 class DisplayRefreshMonitor : public RefCounted<DisplayRefreshMonitor> {
80 public:
81     static PassRefPtr<DisplayRefreshMonitor> create(PlatformDisplayID displayID)
82     {
83         return adoptRef(new DisplayRefreshMonitor(displayID));
84     }
85     
86     ~DisplayRefreshMonitor();
87     
88     // Return true if callback request was scheduled, false if it couldn't be
89     // (e.g., hardware refresh is not available)
90     bool requestRefreshCallback();
91     void windowScreenDidChange(PlatformDisplayID);
92     
93     bool hasClients() const { return m_clients.size(); }
94     void addClient(DisplayRefreshMonitorClient*);
95     bool removeClient(DisplayRefreshMonitorClient*);
96     
97     PlatformDisplayID displayID() const { return m_displayID; }
98
99     bool shouldBeTerminated() const
100     {
101         const int maxInactiveFireCount = 10;
102         return !m_scheduled && m_unscheduledFireCount > maxInactiveFireCount;
103     }
104     
105 private:
106     explicit DisplayRefreshMonitor(PlatformDisplayID);
107
108     void displayDidRefresh();
109     static void handleDisplayRefreshedNotificationOnMainThread(void* data);
110
111     double m_monotonicAnimationStartTime;
112     bool m_active;
113     bool m_scheduled;
114     bool m_previousFrameDone;
115     int m_unscheduledFireCount; // Number of times the display link has fired with no clients.
116     PlatformDisplayID m_displayID;
117     Mutex m_mutex;
118
119     HashSet<DisplayRefreshMonitorClient*> m_clients;
120     HashSet<DisplayRefreshMonitorClient*>* m_clientsToBeNotified;
121
122 #if PLATFORM(MAC)
123 public:
124     void displayLinkFired(double nowSeconds, double outputTimeSeconds);
125 private:
126     CVDisplayLinkRef m_displayLink;
127 #endif
128
129 #if PLATFORM(IOS)
130 public:
131     void displayLinkFired(double nowSeconds);
132 private:
133     void* m_displayLink;
134 #endif
135 };
136
137 //
138 // Singleton manager for all the DisplayRefreshMonitors. This is the interface to the 
139 // outside world. It distributes requests to the appropriate monitor. When the display
140 // refresh event fires, the passed DisplayRefreshMonitorClient is called directly on
141 // the main thread.
142 //
143 class DisplayRefreshMonitorManager {
144 public:
145     static DisplayRefreshMonitorManager* sharedManager();
146     
147     void registerClient(DisplayRefreshMonitorClient*);
148     void unregisterClient(DisplayRefreshMonitorClient*);
149
150     bool scheduleAnimation(DisplayRefreshMonitorClient*);
151     void windowScreenDidChange(PlatformDisplayID, DisplayRefreshMonitorClient*);
152
153 private:
154     friend class DisplayRefreshMonitor;
155     void displayDidRefresh(DisplayRefreshMonitor*);
156     
157     DisplayRefreshMonitorManager() { }
158     DisplayRefreshMonitor* ensureMonitorForClient(DisplayRefreshMonitorClient*);
159
160     // We know nothing about the values of PlatformDisplayIDs, so use UnsignedWithZeroKeyHashTraits.
161     // FIXME: Since we know nothing about these values, this is not sufficient.
162     // Even with UnsignedWithZeroKeyHashTraits, there are still two special values used for empty and deleted hash table slots.
163     typedef HashMap<uint64_t, RefPtr<DisplayRefreshMonitor>, WTF::IntHash<uint64_t>, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> DisplayRefreshMonitorMap;
164     DisplayRefreshMonitorMap m_monitors;
165 };
166
167 }
168
169 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
170
171 #endif