d9a62260c309e2325054ab29b10b59aca89e7999
[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_monotonicAnimationStartTime(0)
60     , m_active(true)
61     , m_scheduled(false)
62     , m_previousFrameDone(true)
63     , m_unscheduledFireCount(0)
64     , m_displayID(displayID)
65     , m_clientsToBeNotified(nullptr)
66 {
67 }
68
69 DisplayRefreshMonitor::~DisplayRefreshMonitor()
70 {
71 }
72
73 void DisplayRefreshMonitor::handleDisplayRefreshedNotificationOnMainThread(void* data)
74 {
75     DisplayRefreshMonitor* monitor = static_cast<DisplayRefreshMonitor*>(data);
76     monitor->displayDidRefresh();
77 }
78
79 void DisplayRefreshMonitor::addClient(DisplayRefreshMonitorClient& client)
80 {
81     m_clients.add(&client);
82 }
83
84 bool DisplayRefreshMonitor::removeClient(DisplayRefreshMonitorClient& client)
85 {
86     if (m_clientsToBeNotified)
87         m_clientsToBeNotified->remove(&client);
88     return m_clients.remove(&client);
89 }
90
91 void DisplayRefreshMonitor::displayDidRefresh()
92 {
93     double monotonicAnimationStartTime;
94
95     {
96         LockHolder lock(m_mutex);
97         if (!m_scheduled)
98             ++m_unscheduledFireCount;
99         else
100             m_unscheduledFireCount = 0;
101
102         m_scheduled = false;
103         monotonicAnimationStartTime = m_monotonicAnimationStartTime;
104     }
105
106     // The call back can cause all our clients to be unregistered, so we need to protect
107     // against deletion until the end of the method.
108     Ref<DisplayRefreshMonitor> protectedThis(*this);
109
110     // Copy the hash table and remove clients from it one by one so we don't notify
111     // any client twice, but can respond to removal of clients during the delivery process.
112     HashSet<DisplayRefreshMonitorClient*> clientsToBeNotified = m_clients;
113     m_clientsToBeNotified = &clientsToBeNotified;
114     while (!clientsToBeNotified.isEmpty()) {
115         DisplayRefreshMonitorClient* client = clientsToBeNotified.takeAny();
116         client->fireDisplayRefreshIfNeeded(monotonicAnimationStartTime);
117
118         // This checks if this function was reentered. In that case, stop iterating
119         // since it's not safe to use the set any more.
120         if (m_clientsToBeNotified != &clientsToBeNotified)
121             break;
122     }
123
124     if (m_clientsToBeNotified == &clientsToBeNotified)
125         m_clientsToBeNotified = nullptr;
126
127     {
128         LockHolder lock(m_mutex);
129         m_previousFrameDone = true;
130     }
131     
132     DisplayRefreshMonitorManager::sharedManager().displayDidRefresh(*this);
133 }
134
135 }
136
137 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)