summaryrefslogtreecommitdiffstats
path: root/src/core/compositor.cpp
blob: 20d956ab4dcfe9c081a8eee0192e4accdd6c6882 (plain)
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "compositor.h"

#include "delegated_frame_node.h"

#include <components/viz/common/resources/returned_resource.h>
#include <content/public/browser/browser_thread.h>
#include <services/viz/public/interfaces/compositing/compositor_frame_sink.mojom.h>

namespace QtWebEngineCore {

Compositor::Compositor()
    : m_chromiumCompositorData(new ChromiumCompositorData)
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

    base::SingleThreadTaskRunner *taskRunner =
        content::BrowserThread::GetTaskRunnerForThread(content::BrowserThread::UI).get();
    m_beginFrameSource =
        std::make_unique<viz::DelayBasedBeginFrameSource>(
            std::make_unique<viz::DelayBasedTimeSource>(taskRunner),
            viz::BeginFrameSource::kNotRestartableId);
}

Compositor::~Compositor()
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
}

void Compositor::setViewDelegate(RenderWidgetHostViewQtDelegate *viewDelegate)
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

    m_viewDelegate = viewDelegate;
}

void Compositor::setFrameSinkClient(viz::mojom::CompositorFrameSinkClient *frameSinkClient)
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

    if (m_frameSinkClient == frameSinkClient)
        return;

    // Accumulated resources belong to the old RendererCompositorFrameSink and
    // should not be returned.
    //
    // TODO(juvaldma): Can there be a pending frame from the old client?
    m_resourcesToRelease.clear();
    m_frameSinkClient = frameSinkClient;
}

void Compositor::setNeedsBeginFrames(bool needsBeginFrames)
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

    if (m_needsBeginFrames == needsBeginFrames)
        return;

    if (needsBeginFrames)
        m_beginFrameSource->AddObserver(this);
    else
        m_beginFrameSource->RemoveObserver(this);

    m_needsBeginFrames = needsBeginFrames;
}

void Compositor::submitFrame(viz::CompositorFrame frame)
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
    DCHECK(!m_havePendingFrame);

    m_chromiumCompositorData->frameDevicePixelRatio = frame.metadata.device_scale_factor;
    m_chromiumCompositorData->previousFrameData = std::move(m_chromiumCompositorData->frameData);
    m_chromiumCompositorData->frameData = std::move(frame);
    m_havePendingFrame = true;

    // Tell viewDelegate to call updatePaintNode() soon.
    m_viewDelegate->update();
}

QSGNode *Compositor::updatePaintNode(QSGNode *oldNode)
{
    // DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
    //
    // This might be called from a Qt Quick render thread, but the UI thread
    // will still be blocked for the duration of this call.

    DelegatedFrameNode *frameNode = static_cast<DelegatedFrameNode *>(oldNode);
    if (!frameNode)
        frameNode = new DelegatedFrameNode;

    frameNode->commit(m_chromiumCompositorData.data(), &m_resourcesToRelease, m_viewDelegate);

    if (m_havePendingFrame) {
        m_havePendingFrame = false;
        content::BrowserThread::PostTask(
            content::BrowserThread::UI, FROM_HERE,
            base::BindOnce(&Compositor::notifyFrameCommitted, m_weakPtrFactory.GetWeakPtr()));
    }

    return frameNode;
}

void Compositor::notifyFrameCommitted()
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

    m_beginFrameSource->DidFinishFrame(this);
    if (m_frameSinkClient)
        m_frameSinkClient->DidReceiveCompositorFrameAck(m_resourcesToRelease);
    m_resourcesToRelease.clear();
}

bool Compositor::OnBeginFrameDerivedImpl(const viz::BeginFrameArgs &args)
{
    DCHECK_CURRENTLY_ON(content::BrowserThread::UI);

    m_beginFrameSource->OnUpdateVSyncParameters(args.frame_time, args.interval);
    if (m_frameSinkClient)
        m_frameSinkClient->OnBeginFrame(args);

    return true;
}

void Compositor::OnBeginFrameSourcePausedChanged(bool)
{
    // Ignored for now.  If the begin frame source is paused, the renderer
    // doesn't need to be informed about it and will just not receive more
    // begin frames.
}

} // namespace QtWebEngineCore