1 | /* |
2 | * Copyright (C) 2010, 2014, 2015 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 | #pragma once |
27 | |
28 | #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR) |
29 | |
30 | #include "PlatformScreen.h" |
31 | #include <wtf/HashSet.h> |
32 | #include <wtf/Lock.h> |
33 | #include <wtf/RefCounted.h> |
34 | #include <wtf/RefPtr.h> |
35 | |
36 | namespace WebCore { |
37 | |
38 | class DisplayAnimationClient; |
39 | class DisplayRefreshMonitorClient; |
40 | |
41 | class DisplayRefreshMonitor : public RefCounted<DisplayRefreshMonitor> { |
42 | public: |
43 | static RefPtr<DisplayRefreshMonitor> create(DisplayRefreshMonitorClient&); |
44 | WEBCORE_EXPORT virtual ~DisplayRefreshMonitor(); |
45 | |
46 | virtual void displayLinkFired() { } |
47 | |
48 | // Return true if callback request was scheduled, false if it couldn't be |
49 | // (e.g., hardware refresh is not available) |
50 | virtual bool requestRefreshCallback() = 0; |
51 | void windowScreenDidChange(PlatformDisplayID); |
52 | |
53 | bool hasClients() const { return m_clients.size(); } |
54 | void addClient(DisplayRefreshMonitorClient&); |
55 | bool removeClient(DisplayRefreshMonitorClient&); |
56 | |
57 | PlatformDisplayID displayID() const { return m_displayID; } |
58 | |
59 | bool shouldBeTerminated() const |
60 | { |
61 | const int maxInactiveFireCount = 20; |
62 | return !m_scheduled && m_unscheduledFireCount > maxInactiveFireCount; |
63 | } |
64 | |
65 | static RefPtr<DisplayRefreshMonitor> createDefaultDisplayRefreshMonitor(PlatformDisplayID); |
66 | |
67 | protected: |
68 | WEBCORE_EXPORT explicit DisplayRefreshMonitor(PlatformDisplayID); |
69 | WEBCORE_EXPORT static void handleDisplayRefreshedNotificationOnMainThread(void* data); |
70 | |
71 | friend class DisplayRefreshMonitorManager; |
72 | |
73 | Lock& mutex() { return m_mutex; } |
74 | |
75 | bool isActive() const { return m_active; } |
76 | void setIsActive(bool active) { m_active = active; } |
77 | |
78 | bool isScheduled() const { return m_scheduled; } |
79 | void setIsScheduled(bool scheduled) { m_scheduled = scheduled; } |
80 | |
81 | bool isPreviousFrameDone() const { return m_previousFrameDone; } |
82 | void setIsPreviousFrameDone(bool done) { m_previousFrameDone = done; } |
83 | |
84 | virtual bool hasRequestedRefreshCallback() const { return false; } |
85 | |
86 | private: |
87 | void displayDidRefresh(); |
88 | |
89 | HashSet<DisplayRefreshMonitorClient*> m_clients; |
90 | HashSet<DisplayRefreshMonitorClient*>* m_clientsToBeNotified { nullptr }; |
91 | Lock m_mutex; |
92 | PlatformDisplayID m_displayID { 0 }; |
93 | int m_unscheduledFireCount { 0 }; // Number of times the display link has fired with no clients. |
94 | bool m_active { true }; |
95 | bool m_scheduled { false }; |
96 | bool m_previousFrameDone { true }; |
97 | }; |
98 | |
99 | } |
100 | |
101 | #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR) |
102 | |
103 | |