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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* Copyright (C) 2018-2019 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. AND ITS CONTRIBUTORS ``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 ITS 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
#if HAVE(DISPLAY_LINK)
#include "DisplayLinkObserverID.h"
#include <WebCore/AnimationFrameRate.h>
#include <WebCore/DisplayUpdate.h>
#include <WebCore/PlatformScreen.h>
#include <wtf/CheckedPtr.h>
#include <wtf/HashMap.h>
#include <wtf/Lock.h>
#include <wtf/TZoneMalloc.h>
#if PLATFORM(MAC)
#include <CoreVideo/CVDisplayLink.h>
#endif
#if PLATFORM(GTK) || PLATFORM(WPE)
#include "DisplayVBlankMonitor.h"
#endif
#if USE(WPE_BACKEND_PLAYSTATION)
struct wpe_playstation_display;
#endif
namespace WebKit {
class DisplayLink {
WTF_MAKE_TZONE_ALLOCATED(DisplayLink);
public:
class Client : public CanMakeThreadSafeCheckedPtr<Client> {
WTF_MAKE_TZONE_ALLOCATED(Client);
WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(Client);
friend class DisplayLink;
public:
virtual ~Client() = default;
private:
virtual void displayLinkFired(WebCore::PlatformDisplayID, WebCore::DisplayUpdate, bool wantsFullSpeedUpdates, bool anyObserverWantsCallback) = 0;
};
explicit DisplayLink(WebCore::PlatformDisplayID);
~DisplayLink();
WebCore::PlatformDisplayID displayID() const { return m_displayID; }
WebCore::FramesPerSecond nominalFramesPerSecond() const { return m_displayNominalFramesPerSecond; }
void displayPropertiesChanged();
void addObserver(Client&, DisplayLinkObserverID, WebCore::FramesPerSecond);
void removeObserver(Client&, DisplayLinkObserverID);
void removeClient(Client&);
// FIXME: Maybe callers should just register a DisplayLinkObserverID with the appropriate fps.
void incrementFullSpeedRequestClientCount(Client&);
void decrementFullSpeedRequestClientCount(Client&);
void setObserverPreferredFramesPerSecond(Client&, DisplayLinkObserverID, WebCore::FramesPerSecond);
#if PLATFORM(GTK) || PLATFORM(WPE)
DisplayVBlankMonitor& vblankMonitor() const { return *m_vblankMonitor; }
#endif
private:
#if PLATFORM(MAC)
static CVReturn displayLinkCallback(CVDisplayLinkRef, const CVTimeStamp*, const CVTimeStamp*, CVOptionFlags, CVOptionFlags*, void* data);
static WebCore::FramesPerSecond nominalFramesPerSecondFromDisplayLink(CVDisplayLinkRef);
#endif
void notifyObserversDisplayDidRefresh();
void platformInitialize();
void platformFinalize();
bool platformIsRunning() const;
void platformStart();
void platformStop();
bool removeInfoForClientIfUnused(Client&) WTF_REQUIRES_LOCK(m_clientsLock);
struct ObserverInfo {
DisplayLinkObserverID observerID;
WebCore::FramesPerSecond preferredFramesPerSecond;
};
struct ClientInfo {
unsigned fullSpeedUpdatesClientCount { 0 };
Vector<ObserverInfo> observers;
};
#if PLATFORM(MAC)
CVDisplayLinkRef m_displayLink { nullptr };
#endif
#if PLATFORM(GTK) || PLATFORM(WPE)
std::unique_ptr<DisplayVBlankMonitor> m_vblankMonitor;
#endif
#if USE(WPE_BACKEND_PLAYSTATION)
struct wpe_playstation_display* m_display;
#endif
Lock m_clientsLock;
HashMap<CheckedRef<Client>, ClientInfo> m_clients WTF_GUARDED_BY_LOCK(m_clientsLock);
const WebCore::PlatformDisplayID m_displayID;
WebCore::FramesPerSecond m_displayNominalFramesPerSecond { WebCore::FullSpeedFramesPerSecond };
WebCore::DisplayUpdate m_currentUpdate;
unsigned m_fireCountWithoutObservers { 0 };
};
class DisplayLinkCollection {
public:
DisplayLink& displayLinkForDisplay(WebCore::PlatformDisplayID);
DisplayLink* existingDisplayLinkForDisplay(WebCore::PlatformDisplayID) const;
std::optional<unsigned> nominalFramesPerSecondForDisplay(WebCore::PlatformDisplayID);
void startDisplayLink(DisplayLink::Client&, DisplayLinkObserverID, WebCore::PlatformDisplayID, WebCore::FramesPerSecond preferredFramesPerSecond);
void stopDisplayLink(DisplayLink::Client&, DisplayLinkObserverID, WebCore::PlatformDisplayID);
void stopDisplayLinks(DisplayLink::Client&);
void setDisplayLinkPreferredFramesPerSecond(DisplayLink::Client&, DisplayLinkObserverID, WebCore::PlatformDisplayID, WebCore::FramesPerSecond preferredFramesPerSecond);
void setDisplayLinkForDisplayWantsFullSpeedUpdates(DisplayLink::Client&, WebCore::PlatformDisplayID, bool wantsFullSpeedUpdates);
private:
void add(std::unique_ptr<DisplayLink>&&);
Vector<std::unique_ptr<DisplayLink>> m_displayLinks;
};
} // namespace WebKit
#endif // HAVE(DISPLAY_LINK)
|
