d759b97c77362ca38cd13846d52d65c6c11de6e8
[WebKit-https.git] / Source / WebKit / UIProcess / mac / DisplayLink.cpp
1 /*
2  * Copyright (C) 2018 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "DisplayLink.h"
28
29 #if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
30
31 #include "DrawingAreaMessages.h"
32 #include "WebPageProxy.h"
33 #include "WebProcessProxy.h"
34 #include <wtf/ProcessPrivilege.h>
35
36 namespace WebKit {
37     
38 DisplayLink::DisplayLink(WebCore::PlatformDisplayID displayID, WebPageProxy& webPageProxy)
39     : m_connection(webPageProxy.process().connection())
40     , m_pageID(webPageProxy.pageID())
41 {
42     ASSERT(hasProcessPrivilege(ProcessPrivilege::CanCommunicateWithWindowServer));
43     CVReturn error = CVDisplayLinkCreateWithCGDisplay(displayID, &m_displayLink);
44     if (error) {
45         WTFLogAlways("Could not create a display link: %d", error);
46         return;
47     }
48     
49     error = CVDisplayLinkSetOutputCallback(m_displayLink, displayLinkCallback, this);
50     if (error) {
51         WTFLogAlways("Could not set the display link output callback: %d", error);
52         return;
53     }
54
55     error = CVDisplayLinkStart(m_displayLink);
56     if (error)
57         WTFLogAlways("Could not start the display link: %d", error);
58 }
59
60 DisplayLink::~DisplayLink()
61 {
62     ASSERT(hasProcessPrivilege(ProcessPrivilege::CanCommunicateWithWindowServer));
63     ASSERT(m_displayLink);
64     if (!m_displayLink)
65         return;
66
67     CVDisplayLinkStop(m_displayLink);
68     CVDisplayLinkRelease(m_displayLink);
69 }
70
71 void DisplayLink::addObserver(unsigned observerID)
72 {
73     m_observers.add(observerID);
74 }
75
76 void DisplayLink::removeObserver(unsigned observerID)
77 {
78     m_observers.remove(observerID);
79 }
80
81 bool DisplayLink::hasObservers() const
82 {
83     return !m_observers.isEmpty();
84 }
85
86 void DisplayLink::pause()
87 {
88     if (!CVDisplayLinkIsRunning(m_displayLink))
89         return;
90     CVDisplayLinkStop(m_displayLink);
91 }
92
93 void DisplayLink::resume()
94 {
95     if (CVDisplayLinkIsRunning(m_displayLink))
96         return;
97     CVDisplayLinkStart(m_displayLink);
98 }
99
100 CVReturn DisplayLink::displayLinkCallback(CVDisplayLinkRef displayLinkRef, const CVTimeStamp*, const CVTimeStamp*, CVOptionFlags, CVOptionFlags*, void* data)
101 {
102     DisplayLink* displayLink = static_cast<DisplayLink*>(data);
103     displayLink->m_connection->send(Messages::DrawingArea::DisplayWasRefreshed(), displayLink->m_pageID);
104     return kCVReturnSuccess;
105 }
106
107 }
108
109 #endif