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
|
/*
* Copyright (C) 2010, 2014, 2015 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.
*/
#pragma once
#include "AnimationFrameRate.h"
#include "DisplayUpdate.h"
#include "PlatformScreen.h"
#include <wtf/CheckedPtr.h>
#include <wtf/HashSet.h>
#include <wtf/Lock.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/RefPtr.h>
namespace WebCore {
class DisplayAnimationClient;
class DisplayRefreshMonitorClient;
class DisplayRefreshMonitorFactory;
class DisplayRefreshMonitor : public ThreadSafeRefCounted<DisplayRefreshMonitor> {
friend class DisplayRefreshMonitorManager;
public:
static RefPtr<DisplayRefreshMonitor> create(DisplayRefreshMonitorFactory*, PlatformDisplayID);
WEBCORE_EXPORT virtual ~DisplayRefreshMonitor();
WEBCORE_EXPORT virtual void stop();
// Return true if callback request was scheduled, false if it couldn't be
// (e.g., hardware refresh is not available)
WEBCORE_EXPORT virtual bool requestRefreshCallback();
void windowScreenDidChange(PlatformDisplayID);
bool hasClients() const { return m_clients.size(); }
void addClient(DisplayRefreshMonitorClient&);
bool removeClient(DisplayRefreshMonitorClient&);
void clientPreferredFramesPerSecondChanged(DisplayRefreshMonitorClient&);
std::optional<FramesPerSecond> maxClientPreferredFramesPerSecond() const { return m_maxClientPreferredFramesPerSecond; }
virtual std::optional<FramesPerSecond> displayNominalFramesPerSecond() { return std::nullopt; }
PlatformDisplayID displayID() const { return m_displayID; }
static RefPtr<DisplayRefreshMonitor> createDefaultDisplayRefreshMonitor(PlatformDisplayID);
WEBCORE_EXPORT virtual void displayLinkFired(const DisplayUpdate&);
protected:
WEBCORE_EXPORT explicit DisplayRefreshMonitor(PlatformDisplayID);
WEBCORE_EXPORT virtual void dispatchDisplayDidRefresh(const DisplayUpdate&);
Lock& lock() WTF_RETURNS_LOCK(m_lock) { return m_lock; }
void setMaxUnscheduledFireCount(unsigned count) WTF_REQUIRES_LOCK(m_lock) { m_maxUnscheduledFireCount = count; }
// Returns true if the start was successful.
WEBCORE_EXPORT virtual bool startNotificationMechanism() = 0;
WEBCORE_EXPORT virtual void stopNotificationMechanism() = 0;
bool isScheduled() const WTF_REQUIRES_LOCK(m_lock) { return m_scheduled; }
void setIsScheduled(bool scheduled) WTF_REQUIRES_LOCK(m_lock) { m_scheduled = scheduled; }
bool isPreviousFrameDone() const WTF_REQUIRES_LOCK(m_lock) { return m_previousFrameDone; }
void setIsPreviousFrameDone(bool done) WTF_REQUIRES_LOCK(m_lock) { m_previousFrameDone = done; }
WEBCORE_EXPORT void displayDidRefresh(const DisplayUpdate&);
private:
bool firedAndReachedMaxUnscheduledFireCount() WTF_REQUIRES_LOCK(m_lock);
virtual void adjustPreferredFramesPerSecond(FramesPerSecond) { }
std::optional<FramesPerSecond> maximumClientPreferredFramesPerSecond() const;
void computeMaxPreferredFramesPerSecond();
UncheckedKeyHashSet<CheckedPtr<DisplayRefreshMonitorClient>> m_clients;
UncheckedKeyHashSet<CheckedPtr<DisplayRefreshMonitorClient>>* m_clientsToBeNotified { nullptr };
PlatformDisplayID m_displayID { 0 };
std::optional<FramesPerSecond> m_maxClientPreferredFramesPerSecond;
Lock m_lock;
bool m_scheduled WTF_GUARDED_BY_LOCK(m_lock) { false };
bool m_previousFrameDone WTF_GUARDED_BY_LOCK(m_lock) { true };
unsigned m_unscheduledFireCount WTF_GUARDED_BY_LOCK(m_lock) { 0 };
unsigned m_maxUnscheduledFireCount WTF_GUARDED_BY_LOCK(m_lock) { 0 };
};
}
|
