File: WPEViewQtQuick.cpp

package info (click to toggle)
wpewebkit 2.48.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 421,736 kB
  • sloc: cpp: 3,671,212; javascript: 194,411; ansic: 165,592; python: 46,476; asm: 19,295; ruby: 18,528; perl: 16,602; xml: 4,650; yacc: 2,360; java: 1,993; sh: 1,948; lex: 1,327; pascal: 366; makefile: 87
file content (445 lines) | stat: -rw-r--r-- 16,570 bytes parent folder | download | duplicates (2)
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/*
 * Copyright (C) 2024 Igalia S.L.
 *
 * 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 THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
 * HOLDER 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.
 */

#include "config.h"
#include "WPEViewQtQuick.h"

#include "WPEQtView.h"

#include <epoxy/egl.h>
#include <wtf/glib/GRefPtr.h>
#include <wtf/glib/GUniquePtr.h>
#include <wtf/glib/RunLoopSourcePriority.h>
#include <wtf/glib/WTFGType.h>

#include <QOffscreenSurface>
#include <QOpenGLFunctions>
#include <QQuickWindow>
#include <QSGTexture>

/**
 * WPEViewQtQuick:
 *
 */
struct _WPEViewQtQuickPrivate {
    GRefPtr<WPEBuffer> pendingBuffer;
    GRefPtr<WPEBuffer> committedBuffer;
    bool bufferUpdateRequested;
    GLuint textureId;
    GLuint textureUniform;
    GLuint program;
    QOffscreenSurface surface;
    QOpenGLContext* context;
    WPEQtView* wpeQtView;

    // Event handling
    bool isHovering;
    std::optional<QPointF> lastMousePosition;
};
WEBKIT_DEFINE_FINAL_TYPE(WPEViewQtQuick, wpe_view_qtquick, WPE_TYPE_VIEW, WPEView)

static PFNGLEGLIMAGETARGETTEXTURE2DOESPROC imageTargetTexture2DOES;

static void wpeViewQtQuickDispose(GObject* object)
{
    auto* priv = WPE_VIEW_QTQUICK(object)->priv;
    if (priv->textureId) {
        if (auto* glFunctions = priv->context ? priv->context->functions() : nullptr)
            glFunctions->glDeleteTextures(1, &priv->textureId);
        priv->textureId = 0;
    }

    G_OBJECT_CLASS(wpe_view_qtquick_parent_class)->dispose(object);
}

static gboolean wpeViewQtQuickRenderBuffer(WPEView* view, WPEBuffer* buffer, const WPERectangle*, guint, GError**)
{
    // TODO: Add support for damage rects.
    auto* priv = WPE_VIEW_QTQUICK(view)->priv;
    priv->pendingBuffer = buffer;
    priv->bufferUpdateRequested = true;

    priv->wpeQtView->triggerUpdateScene();
    return TRUE;
}

static void wpe_view_qtquick_class_init(WPEViewQtQuickClass* viewQtQuickClass)
{
    GObjectClass* objectClass = G_OBJECT_CLASS(viewQtQuickClass);
    objectClass->dispose = wpeViewQtQuickDispose;

    WPEViewClass* viewClass = WPE_VIEW_CLASS(viewQtQuickClass);
    viewClass->render_buffer = wpeViewQtQuickRenderBuffer;
}

WPEView* wpe_view_qtquick_new(WPEDisplayQtQuick* display)
{
    g_return_val_if_fail(WPE_IS_DISPLAY_QTQUICK(display), nullptr);
    return WPE_VIEW(g_object_new(WPE_TYPE_VIEW_QTQUICK, "display", display, nullptr));
}

gboolean wpe_view_qtquick_initialize_rendering(WPEViewQtQuick* view, WPEQtView* wpeQtView, GError** error)
{
    auto* window = wpeQtView ? wpeQtView->window() : nullptr;
    if (!window || !window->rendererInterface()) {
        g_set_error_literal(error, WPE_VIEW_ERROR, WPE_VIEW_ERROR_RENDER_FAILED, "Failed to initialize rendering: Cannot access renderer interface via Qt");
        return FALSE;
    }

    auto* context = static_cast<QOpenGLContext*>(window->rendererInterface()->getResource(window, QSGRendererInterface::OpenGLContextResource));
    if (!context) {
        g_set_error_literal(error, WPE_VIEW_ERROR, WPE_VIEW_ERROR_RENDER_FAILED, "Failed to initialize rendering: Cannot retrieve OpenGL context via Qt");
        return FALSE;
    }

    auto* priv = WPE_VIEW_QTQUICK(view)->priv;
    priv->context = context;
    priv->wpeQtView = wpeQtView;

    if (!imageTargetTexture2DOES)
        imageTargetTexture2DOES = reinterpret_cast<PFNGLEGLIMAGETARGETTEXTURE2DOESPROC>(eglGetProcAddress("glEGLImageTargetTexture2DOES"));

    static const char* vertexShaderSource =
        "attribute vec2 pos;\n"
        "attribute vec2 texture;\n"
        "varying vec2 v_texture;\n"
        "void main() {\n"
        "  v_texture = texture;\n"
        "  gl_Position = vec4(pos, 0, 1);\n"
        "}\n";

    static const char* fragmentShaderSource =
        "precision mediump float;\n"
        "uniform sampler2D u_texture;\n"
        "varying vec2 v_texture;\n"
        "void main() {\n"
        "  gl_FragColor = texture2D(u_texture, v_texture);\n"
        "}\n";

    auto* glFunctions = context->functions();
    auto vertexShader = glFunctions->glCreateShader(GL_VERTEX_SHADER);
    glFunctions->glShaderSource(vertexShader, 1, &vertexShaderSource, nullptr);
    glFunctions->glCompileShader(vertexShader);

    auto fragmentShader = glFunctions->glCreateShader(GL_FRAGMENT_SHADER);
    glFunctions->glShaderSource(fragmentShader, 1, &fragmentShaderSource, nullptr);
    glFunctions->glCompileShader(fragmentShader);

    priv->program = glFunctions->glCreateProgram();
    glFunctions->glAttachShader(priv->program, vertexShader);
    glFunctions->glAttachShader(priv->program, fragmentShader);

    glFunctions->glBindAttribLocation(priv->program, 0, "pos");
    glFunctions->glBindAttribLocation(priv->program, 1, "texture");

    glFunctions->glLinkProgram(priv->program);
    priv->textureUniform = glFunctions->glGetUniformLocation(priv->program, "u_texture");

    priv->surface.setFormat(context->format());
    priv->surface.create();

    return TRUE;
}

QSGTexture* wpe_view_qtquick_render_buffer_to_texture(WPEViewQtQuick* view, QSize size, GError** error)
{
    auto* priv = WPE_VIEW_QTQUICK(view)->priv;
    priv->context->makeCurrent(&priv->surface);

    auto wrapNativeTexture = [&]() -> QSGTexture* {
        RELEASE_ASSERT(priv->wpeQtView->window());

        auto texture = QNativeInterface::QSGOpenGLTexture::fromNative(priv->textureId, priv->wpeQtView->window(), size, QQuickWindow::TextureHasAlphaChannel);
        if (UNLIKELY(!texture)) {
            g_set_error_literal(error, WPE_VIEW_ERROR, WPE_VIEW_ERROR_RENDER_FAILED, "Failed to import QSOpenGLTexture from native OpenGL texture");
            return nullptr;
        }

        return texture;
    };

    if (UNLIKELY(!priv->pendingBuffer)) {
        if (!priv->committedBuffer) {
            g_set_error_literal(error, WPE_VIEW_ERROR, WPE_VIEW_ERROR_RENDER_FAILED, "Failed to render, no pending buffer available to render into, and no commitedBuffer.");
            return nullptr;
        }

        RELEASE_ASSERT(priv->textureId);
        return wrapNativeTexture();
    }

    GUniqueOutPtr<GError> bufferError;
    auto eglImage = wpe_buffer_import_to_egl_image(priv->pendingBuffer.get(), &bufferError.outPtr());
    if (UNLIKELY(!eglImage)) {
        g_set_error(error, WPE_VIEW_ERROR, WPE_VIEW_ERROR_RENDER_FAILED, "Failed to render: %s", bufferError->message);
        return nullptr;
    }

    auto* glFunctions = priv->context->functions();
    if (UNLIKELY(!priv->textureId)) {
        glFunctions->glGenTextures(1, &priv->textureId);
        glFunctions->glBindTexture(GL_TEXTURE_2D, priv->textureId);
        glFunctions->glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
        glFunctions->glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
        glFunctions->glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
        glFunctions->glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
        glFunctions->glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, 1, 1, 0, GL_RGBA, GL_UNSIGNED_BYTE, nullptr); // Passed size doesn't matter.
        glFunctions->glBindTexture(GL_TEXTURE_2D, 0);
    }

    glFunctions->glClearColor(1, 0, 0, 1);
    glFunctions->glClear(GL_COLOR_BUFFER_BIT);

    glFunctions->glUseProgram(priv->program);

    glFunctions->glActiveTexture(GL_TEXTURE0);
    glFunctions->glBindTexture(GL_TEXTURE_2D, priv->textureId);
    imageTargetTexture2DOES(GL_TEXTURE_2D, eglImage);
    glFunctions->glUniform1i(priv->textureUniform, 0);

    static const GLfloat vertices[4][2] = {
        { -1.0, 1.0 },
        { 1.0, 1.0 },
        { -1.0, -1.0 },
        { 1.0, -1.0 },
    };

    static const GLfloat texturePos[4][2] = {
        { 0, 0 },
        { 1, 0 },
        { 0, 1 },
        { 1, 1 },
    };

    glFunctions->glVertexAttribPointer(0, 2, GL_FLOAT, GL_FALSE, 0, vertices);
    glFunctions->glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 0, texturePos);

    glFunctions->glEnableVertexAttribArray(0);
    glFunctions->glEnableVertexAttribArray(1);

    glFunctions->glDrawArrays(GL_TRIANGLE_STRIP, 0, 4);

    glFunctions->glDisableVertexAttribArray(0);
    glFunctions->glDisableVertexAttribArray(1);

    // Wrap in QSGOpenGLTexture for Qt Scene Graph.
    auto texture = QNativeInterface::QSGOpenGLTexture::fromNative(priv->textureId, priv->wpeQtView->window(), size, QQuickWindow::TextureHasAlphaChannel);
    if (!texture) {
        g_set_error_literal(error, WPE_VIEW_ERROR, WPE_VIEW_ERROR_RENDER_FAILED, "Failed to import QSOpenGLTexture from native OpenGL texture");
        return nullptr;
    }

    return texture;
}

void wpe_view_qtquick_did_update_scene(WPEViewQtQuick* view)
{
    auto* priv = view->priv;
    if (!priv->bufferUpdateRequested)
        return;

    priv->bufferUpdateRequested = false;
    if (priv->committedBuffer)
        wpe_view_buffer_released(WPE_VIEW(view), priv->committedBuffer.get());
    priv->committedBuffer = WTFMove(priv->pendingBuffer);
    wpe_view_buffer_rendered(WPE_VIEW(view), priv->committedBuffer.get());
}

// Event handling
static inline guint buttonFromEvent(QMouseEvent* event)
{
    switch (event->button()) {
    case Qt::LeftButton:
        return WPE_BUTTON_PRIMARY;
    case Qt::MiddleButton:
        return WPE_BUTTON_MIDDLE;
    case Qt::RightButton:
        return WPE_BUTTON_SECONDARY;
    default:
        break;
    }

    return 0;
}

template<typename QtEvent>
static inline uint32_t mouseModifiersFromEvent(QtEvent* event)
{
    switch (event->button()) {
    case Qt::LeftButton:
        return WPE_MODIFIER_POINTER_BUTTON1;
    case Qt::RightButton:
        return WPE_MODIFIER_POINTER_BUTTON2;
    default:
        break;
    }

    return 0;
}

template<typename QtEvent>
static inline uint32_t keyboardModifiersFromEvent(QtEvent* event)
{
    uint32_t result = 0;

    // No support for WPE_MODIFIER_KEYBOARD_CAPS_LOCK. Qt doesn't expose CapsLock.
    auto modifiers = event->modifiers();
    if (modifiers.testFlag(Qt::ShiftModifier))
        result |= WPE_MODIFIER_KEYBOARD_SHIFT;
    if (modifiers.testFlag(Qt::ControlModifier))
        result |= WPE_MODIFIER_KEYBOARD_CONTROL;
    if (modifiers.testFlag(Qt::AltModifier))
        result |= WPE_MODIFIER_KEYBOARD_ALT;
    if (modifiers.testFlag(Qt::MetaModifier))
        result |= WPE_MODIFIER_KEYBOARD_META;

    return result;
}

template<typename QtEvent>
static inline WPEModifiers modifiersFromEvent(QtEvent* event)
{
    return static_cast<WPEModifiers>(mouseModifiersFromEvent(event) | keyboardModifiersFromEvent(event));
}

// Mouse events
void wpe_view_dispatch_mouse_press_event(WPEViewQtQuick *view, QMouseEvent *event)
{
    auto position = event->position().toPoint();
    auto button = buttonFromEvent(event);

    auto pressCount = wpe_view_compute_press_count(WPE_VIEW(view), position.x(), position.y(), button, event->timestamp());
    auto* wpeEvent = wpe_event_pointer_button_new(WPE_EVENT_POINTER_DOWN, WPE_VIEW(view), WPE_INPUT_SOURCE_MOUSE, event->timestamp(),
        modifiersFromEvent(event), button, position.x(), position.y(), pressCount);
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

void wpe_view_dispatch_mouse_move_event(WPEViewQtQuick *view, QMouseEvent *event)
{
    auto position = event->position().toPoint();
    auto delta = view->priv->lastMousePosition ? position - view->priv->lastMousePosition.value() : QPointF();
    view->priv->lastMousePosition = position;

    auto* wpeEvent = wpe_event_pointer_move_new(WPE_EVENT_POINTER_MOVE, WPE_VIEW(view), WPE_INPUT_SOURCE_MOUSE, event->timestamp(),
        modifiersFromEvent(event), position.x(), position.y(), delta.x(), delta.y());
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

void wpe_view_dispatch_mouse_release_event(WPEViewQtQuick *view, QMouseEvent *event)
{
    auto position = event->position().toPoint();
    auto* wpeEvent = wpe_event_pointer_button_new(WPE_EVENT_POINTER_UP, WPE_VIEW(view), WPE_INPUT_SOURCE_MOUSE, event->timestamp(),
        modifiersFromEvent(event), buttonFromEvent(event), position.x(), position.y(), 0 /* pressCount */);
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

// Wheel events
void wpe_view_dispatch_wheel_event(WPEViewQtQuick *view, QWheelEvent *event)
{
    auto position = event->position().toPoint();
    auto numPixels = event->pixelDelta();

    auto* wpeEvent = wpe_event_scroll_new(WPE_VIEW(view), WPE_INPUT_SOURCE_MOUSE, event->timestamp(),
        modifiersFromEvent(event), numPixels.x(), numPixels.y(), FALSE, FALSE, position.x(), position.y());
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

// Hover events
void wpe_view_dispatch_hover_enter_event(WPEViewQtQuick *view, QHoverEvent *)
{
    view->priv->isHovering = true;
}

void wpe_view_dispatch_hover_move_event(WPEViewQtQuick *view, QHoverEvent *event)
{
    if (!view->priv->isHovering)
        return;

    auto position = event->position().toPoint();
    auto delta = view->priv->lastMousePosition ? position - view->priv->lastMousePosition.value() : QPointF();
    view->priv->lastMousePosition = position;

    auto* wpeEvent = wpe_event_pointer_move_new(WPE_EVENT_POINTER_MOVE, WPE_VIEW(view), WPE_INPUT_SOURCE_MOUSE, event->timestamp(),
        modifiersFromEvent(event), position.x(), position.y(), delta.x(), delta.y());
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

void wpe_view_dispatch_hover_leave_event(WPEViewQtQuick *view, QHoverEvent *)
{
    view->priv->isHovering = false;
}

// Keyboard events
void wpe_view_dispatch_key_press_event(WPEViewQtQuick *view, QKeyEvent *event)
{
    auto modifiers = static_cast<WPEModifiers>(keyboardModifiersFromEvent(event));
    auto* wpeEvent = wpe_event_keyboard_new(WPE_EVENT_KEYBOARD_KEY_DOWN, WPE_VIEW(view), WPE_INPUT_SOURCE_KEYBOARD, event->timestamp(),
        modifiers, event->key(), event->nativeVirtualKey());
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

void wpe_view_dispatch_key_release_event(WPEViewQtQuick *view, QKeyEvent *event)
{
    auto modifiers = static_cast<WPEModifiers>(keyboardModifiersFromEvent(event));
    auto* wpeEvent = wpe_event_keyboard_new(WPE_EVENT_KEYBOARD_KEY_UP, WPE_VIEW(view), WPE_INPUT_SOURCE_KEYBOARD, event->timestamp(),
        modifiers, event->key(), event->nativeVirtualKey());
    wpe_view_event(WPE_VIEW(view), wpeEvent);
    wpe_event_unref(wpeEvent);
}

// Touch events
void wpe_view_dispatch_touch_event(WPEViewQtQuick *view, QTouchEvent *event)
{
    WPEEventType eventType = WPE_EVENT_NONE;
    switch (event->type()) {
    case QEvent::TouchBegin:
        eventType = WPE_EVENT_TOUCH_DOWN;
        break;
    case QEvent::TouchUpdate:
        eventType = WPE_EVENT_TOUCH_MOVE;
        break;
    case QEvent::TouchEnd:
        eventType = WPE_EVENT_TOUCH_UP;
        break;
    default:
        RELEASE_ASSERT_NOT_REACHED();
        break;
    }

    auto modifiers = static_cast<WPEModifiers>(keyboardModifiersFromEvent(event));
    for (auto& point : event->points()) {
        auto position = point.position();
        auto* wpeEvent = wpe_event_touch_new(eventType, WPE_VIEW(view), WPE_INPUT_SOURCE_TOUCHPAD, event->timestamp(),
            modifiers, point.id(), position.x(), position.y());
        wpe_view_event(WPE_VIEW(view), wpeEvent);
        wpe_event_unref(wpeEvent);
    }
}