1/*
2 * Copyright (C) 2019 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 "RenderingUpdateScheduler.h"
28
29#include "Chrome.h"
30#include "ChromeClient.h"
31#include "DisplayRefreshMonitorManager.h"
32#include "Page.h"
33#include <wtf/SystemTracing.h>
34
35namespace WebCore {
36
37RenderingUpdateScheduler::RenderingUpdateScheduler(Page& page)
38 : m_page(page)
39{
40#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
41 windowScreenDidChange(page.chrome().displayID());
42#endif
43}
44
45void RenderingUpdateScheduler::scheduleRenderingUpdate()
46{
47 if (isScheduled())
48 return;
49
50 // Optimize the case when an invisible page wants just to schedule layer flush.
51 if (!m_page.isVisible()) {
52 scheduleCompositingLayerFlush();
53 return;
54 }
55
56 tracePoint(ScheduleRenderingUpdate);
57
58#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
59 if (!DisplayRefreshMonitorManager::sharedManager().scheduleAnimation(*this))
60#endif
61 startTimer(Seconds(1.0 / 60));
62
63 m_scheduled = true;
64}
65
66bool RenderingUpdateScheduler::isScheduled() const
67{
68 ASSERT_IMPLIES(m_refreshTimer.get(), m_scheduled);
69 return m_scheduled;
70}
71
72void RenderingUpdateScheduler::startTimer(Seconds delay)
73{
74 ASSERT(!isScheduled());
75 m_refreshTimer = std::make_unique<Timer>(*this, &RenderingUpdateScheduler::displayRefreshFired);
76 m_refreshTimer->startOneShot(delay);
77}
78
79void RenderingUpdateScheduler::clearScheduled()
80{
81 m_scheduled = false;
82 m_refreshTimer = nullptr;
83}
84
85#if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
86RefPtr<DisplayRefreshMonitor> RenderingUpdateScheduler::createDisplayRefreshMonitor(PlatformDisplayID displayID) const
87{
88 if (auto monitor = m_page.chrome().client().createDisplayRefreshMonitor(displayID))
89 return monitor;
90
91 return DisplayRefreshMonitor::createDefaultDisplayRefreshMonitor(displayID);
92}
93
94void RenderingUpdateScheduler::windowScreenDidChange(PlatformDisplayID displayID)
95{
96 DisplayRefreshMonitorManager::sharedManager().windowScreenDidChange(displayID, *this);
97}
98#endif
99
100void RenderingUpdateScheduler::displayRefreshFired()
101{
102 tracePoint(TriggerRenderingUpdate);
103
104 clearScheduled();
105 scheduleCompositingLayerFlush();
106}
107
108void RenderingUpdateScheduler::scheduleCompositingLayerFlush()
109{
110 m_page.chrome().client().scheduleCompositingLayerFlush();
111}
112
113}
114