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