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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright (C) 2010, 2014 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 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.
*/
#include "config.h"
#include "DisplayRefreshMonitor.h"
#include "DisplayRefreshMonitorClient.h"
#include "DisplayRefreshMonitorFactory.h"
#include "DisplayRefreshMonitorManager.h"
#include "Logging.h"
#include <wtf/text/TextStream.h>
#if PLATFORM(IOS_FAMILY)
#include "DisplayRefreshMonitorIOS.h"
#elif PLATFORM(MAC)
#include "LegacyDisplayRefreshMonitorMac.h"
#elif PLATFORM(WIN)
#include "DisplayRefreshMonitorWin.h"
#endif
namespace WebCore {
RefPtr<DisplayRefreshMonitor> DisplayRefreshMonitor::createDefaultDisplayRefreshMonitor(PlatformDisplayID displayID)
{
#if PLATFORM(MAC)
return LegacyDisplayRefreshMonitorMac::create(displayID);
#endif
#if PLATFORM(IOS_FAMILY)
return DisplayRefreshMonitorIOS::create(displayID);
#endif
#if PLATFORM(WIN)
return DisplayRefreshMonitorWin::create(displayID);
#endif
UNUSED_PARAM(displayID);
return nullptr;
}
RefPtr<DisplayRefreshMonitor> DisplayRefreshMonitor::create(DisplayRefreshMonitorFactory* factory, PlatformDisplayID displayID)
{
if (factory) {
auto monitor = factory->createDisplayRefreshMonitor(displayID);
if (monitor)
return monitor;
}
return createDefaultDisplayRefreshMonitor(displayID);
}
DisplayRefreshMonitor::DisplayRefreshMonitor(PlatformDisplayID displayID)
: m_displayID(displayID)
{
}
DisplayRefreshMonitor::~DisplayRefreshMonitor() = default;
void DisplayRefreshMonitor::stop()
{
stopNotificationMechanism();
Locker locker { m_lock };
setIsScheduled(false);
}
void DisplayRefreshMonitor::addClient(DisplayRefreshMonitorClient& client)
{
auto addResult = m_clients.add(&client);
if (addResult.isNewEntry) {
LOG_WITH_STREAM(DisplayLink, stream << "[Web] DisplayRefreshMonitor " << this << " addedClient - displayID " << m_displayID << " client " << &client << " client preferred fps " << client.preferredFramesPerSecond());
computeMaxPreferredFramesPerSecond();
}
}
bool DisplayRefreshMonitor::removeClient(DisplayRefreshMonitorClient& client)
{
if (m_clientsToBeNotified)
m_clientsToBeNotified->remove(&client);
bool removed = m_clients.remove(&client);
if (removed) {
LOG_WITH_STREAM(DisplayLink, stream << "[Web] DisplayRefreshMonitor " << this << " removedClient " << &client);
computeMaxPreferredFramesPerSecond();
}
return removed;
}
std::optional<FramesPerSecond> DisplayRefreshMonitor::maximumClientPreferredFramesPerSecond() const
{
std::optional<FramesPerSecond> maxFramesPerSecond;
for (auto& client : m_clients)
maxFramesPerSecond = std::max<FramesPerSecond>(maxFramesPerSecond.value_or(0), client->preferredFramesPerSecond());
return maxFramesPerSecond;
}
void DisplayRefreshMonitor::computeMaxPreferredFramesPerSecond()
{
auto maxFramesPerSecond = maximumClientPreferredFramesPerSecond();
LOG_WITH_STREAM(DisplayLink, stream << "[Web] DisplayRefreshMonitor " << this << " computeMaxPreferredFramesPerSecond - displayID " << m_displayID << " adjusting max fps to " << maxFramesPerSecond);
if (maxFramesPerSecond != m_maxClientPreferredFramesPerSecond) {
m_maxClientPreferredFramesPerSecond = maxFramesPerSecond;
if (m_maxClientPreferredFramesPerSecond)
adjustPreferredFramesPerSecond(*m_maxClientPreferredFramesPerSecond);
}
}
void DisplayRefreshMonitor::clientPreferredFramesPerSecondChanged(DisplayRefreshMonitorClient&)
{
computeMaxPreferredFramesPerSecond();
}
bool DisplayRefreshMonitor::requestRefreshCallback()
{
Locker locker { m_lock };
if (isScheduled())
return true;
if (!startNotificationMechanism())
return false;
setIsScheduled(true);
return true;
}
bool DisplayRefreshMonitor::firedAndReachedMaxUnscheduledFireCount()
{
if (isScheduled()) {
m_unscheduledFireCount = 0;
return false;
}
++m_unscheduledFireCount;
return m_unscheduledFireCount > m_maxUnscheduledFireCount;
}
void DisplayRefreshMonitor::displayLinkFired(const DisplayUpdate& displayUpdate)
{
{
Locker locker { m_lock };
// This may be off the main thread.
if (!isPreviousFrameDone()) {
RELEASE_LOG(DisplayLink, "[Web] DisplayRefreshMonitor::displayLinkFired for display %u - previous frame is not complete", displayID());
return;
}
LOG_WITH_STREAM(DisplayLink, stream << "[Web] DisplayRefreshMonitor::displayLinkFired for display " << displayID() << " - scheduled " << isScheduled() << " unscheduledFireCount " << m_unscheduledFireCount << " of " << m_maxUnscheduledFireCount);
if (firedAndReachedMaxUnscheduledFireCount()) {
stopNotificationMechanism();
return;
}
setIsScheduled(false);
setIsPreviousFrameDone(false);
}
dispatchDisplayDidRefresh(displayUpdate);
}
void DisplayRefreshMonitor::dispatchDisplayDidRefresh(const DisplayUpdate& displayUpdate)
{
ASSERT(isMainThread());
displayDidRefresh(displayUpdate);
}
void DisplayRefreshMonitor::displayDidRefresh(const DisplayUpdate& displayUpdate)
{
ASSERT(isMainThread());
UNUSED_PARAM(displayUpdate);
LOG_WITH_STREAM(DisplayLink, stream << "DisplayRefreshMonitor::displayDidRefresh for display " << displayID() << " update " << displayUpdate);
// The call back can cause all our clients to be unregistered, so we need to protect
// against deletion until the end of the method.
Ref<DisplayRefreshMonitor> protectedThis(*this);
// Copy the hash table and remove clients from it one by one so we don't notify
// any client twice, but can respond to removal of clients during the delivery process.
auto clientsToBeNotified = m_clients;
m_clientsToBeNotified = &clientsToBeNotified;
while (!clientsToBeNotified.isEmpty()) {
auto client = clientsToBeNotified.takeAny();
client->fireDisplayRefreshIfNeeded(displayUpdate);
// This checks if this function was reentered. In that case, stop iterating
// since it's not safe to use the set any more.
if (m_clientsToBeNotified != &clientsToBeNotified)
break;
}
if (m_clientsToBeNotified == &clientsToBeNotified)
m_clientsToBeNotified = nullptr;
{
Locker locker { m_lock };
setIsPreviousFrameDone(true);
}
DisplayRefreshMonitorManager::sharedManager().displayMonitorDisplayDidRefresh(*this);
}
}
|
