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