requestFrameAnimation() callback timestamp should be very close to Performance.now()
[WebKit-https.git] / Source / WebCore / platform / graphics / DisplayRefreshMonitor.cpp
1 /*
2  * Copyright (C) 2010, 2014 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 #include "config.h"
27 #include "DisplayRefreshMonitor.h"
28
29 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
30
31 #include "DisplayRefreshMonitorClient.h"
32 #include "DisplayRefreshMonitorManager.h"
33
34 #if PLATFORM(IOS)
35 #include "DisplayRefreshMonitorIOS.h"
36 #else
37 #include "DisplayRefreshMonitorMac.h"
38 #endif
39
40 namespace WebCore {
41
42 RefPtr<DisplayRefreshMonitor> DisplayRefreshMonitor::createDefaultDisplayRefreshMonitor(PlatformDisplayID displayID)
43 {
44 #if PLATFORM(MAC)
45     return DisplayRefreshMonitorMac::create(displayID);
46 #endif
47 #if PLATFORM(IOS)
48     return DisplayRefreshMonitorIOS::create(displayID);
49 #endif
50     return nullptr;
51 }
52
53 RefPtr<DisplayRefreshMonitor> DisplayRefreshMonitor::create(DisplayRefreshMonitorClient& client)
54 {
55     return client.createDisplayRefreshMonitor(client.displayID());
56 }
57
58 DisplayRefreshMonitor::DisplayRefreshMonitor(PlatformDisplayID displayID)
59     : m_active(true)
60     , m_scheduled(false)
61     , m_previousFrameDone(true)
62     , m_unscheduledFireCount(0)
63     , m_displayID(displayID)
64     , m_clientsToBeNotified(nullptr)
65 {
66 }
67
68 DisplayRefreshMonitor::~DisplayRefreshMonitor()
69 {
70 }
71
72 void DisplayRefreshMonitor::handleDisplayRefreshedNotificationOnMainThread(void* data)
73 {
74     DisplayRefreshMonitor* monitor = static_cast<DisplayRefreshMonitor*>(data);
75     monitor->displayDidRefresh();
76 }
77
78 void DisplayRefreshMonitor::addClient(DisplayRefreshMonitorClient& client)
79 {
80     m_clients.add(&client);
81 }
82
83 bool DisplayRefreshMonitor::removeClient(DisplayRefreshMonitorClient& client)
84 {
85     if (m_clientsToBeNotified)
86         m_clientsToBeNotified->remove(&client);
87     return m_clients.remove(&client);
88 }
89
90 void DisplayRefreshMonitor::displayDidRefresh()
91 {
92     {
93         LockHolder lock(m_mutex);
94         if (!m_scheduled)
95             ++m_unscheduledFireCount;
96         else
97             m_unscheduledFireCount = 0;
98
99         m_scheduled = false;
100     }
101
102     // The call back can cause all our clients to be unregistered, so we need to protect
103     // against deletion until the end of the method.
104     Ref<DisplayRefreshMonitor> protectedThis(*this);
105
106     // Copy the hash table and remove clients from it one by one so we don't notify
107     // any client twice, but can respond to removal of clients during the delivery process.
108     HashSet<DisplayRefreshMonitorClient*> clientsToBeNotified = m_clients;
109     m_clientsToBeNotified = &clientsToBeNotified;
110     while (!clientsToBeNotified.isEmpty()) {
111         DisplayRefreshMonitorClient* client = clientsToBeNotified.takeAny();
112         client->fireDisplayRefreshIfNeeded();
113
114         // This checks if this function was reentered. In that case, stop iterating
115         // since it's not safe to use the set any more.
116         if (m_clientsToBeNotified != &clientsToBeNotified)
117             break;
118     }
119
120     if (m_clientsToBeNotified == &clientsToBeNotified)
121         m_clientsToBeNotified = nullptr;
122
123     {
124         LockHolder lock(m_mutex);
125         m_previousFrameDone = true;
126     }
127     
128     DisplayRefreshMonitorManager::sharedManager().displayDidRefresh(*this);
129 }
130
131 }
132
133 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)