src/platform/qt/DisplayGL.cpp (view raw)
1/* Copyright (c) 2013-2019 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#include "DisplayGL.h"
7
8#if defined(BUILD_GL) || defined(BUILD_GLES2)
9
10#include "CoreController.h"
11
12#include <QApplication>
13#include <QOpenGLContext>
14#include <QOpenGLPaintDevice>
15#include <QResizeEvent>
16#include <QTimer>
17#include <QWindow>
18
19#include <mgba/core/core.h>
20#include <mgba-util/math.h>
21#ifdef BUILD_GL
22#include "platform/opengl/gl.h"
23#endif
24#ifdef BUILD_GLES2
25#include "platform/opengl/gles2.h"
26#ifdef _WIN32
27#include <epoxy/wgl.h>
28#endif
29#endif
30
31using namespace QGBA;
32
33DisplayGL::DisplayGL(const QSurfaceFormat& format, QWidget* parent)
34 : Display(parent)
35 , m_gl(nullptr)
36{
37 setAttribute(Qt::WA_NativeWindow);
38 windowHandle()->create();
39
40 // This can spontaneously re-enter into this->resizeEvent before creation is done, so we
41 // need to make sure it's initialized to nullptr before we assign the new object to it
42 m_gl = new QOpenGLContext;
43 m_gl->setFormat(format);
44 m_gl->create();
45
46 m_gl->makeCurrent(windowHandle());
47#if defined(_WIN32) && defined(USE_EPOXY)
48 epoxy_handle_external_wglMakeCurrent();
49#endif
50 auto version = m_gl->format().version();
51 QStringList extensions = QString(reinterpret_cast<const char*>(glGetString(GL_EXTENSIONS))).split(' ');
52
53 if ((version == qMakePair(2, 1) && !extensions.contains("GL_ARB_framebuffer_object")) || version == qMakePair(2, 0)) {
54 QSurfaceFormat newFormat(format);
55 newFormat.setVersion(1, 4);
56 m_gl->setFormat(newFormat);
57 m_gl->create();
58 }
59
60 m_painter = new PainterGL(windowHandle(), m_gl);
61 setUpdatesEnabled(false); // Prevent paint events, which can cause race conditions
62}
63
64DisplayGL::~DisplayGL() {
65 stopDrawing();
66 delete m_painter;
67 delete m_gl;
68}
69
70bool DisplayGL::supportsShaders() const {
71 return m_painter->supportsShaders();
72}
73
74VideoShader* DisplayGL::shaders() {
75 VideoShader* shaders = nullptr;
76 if (m_drawThread) {
77 QMetaObject::invokeMethod(m_painter, "shaders", Qt::BlockingQueuedConnection, Q_RETURN_ARG(VideoShader*, shaders));
78 } else {
79 shaders = m_painter->shaders();
80 }
81 return shaders;
82}
83
84void DisplayGL::startDrawing(std::shared_ptr<CoreController> controller) {
85 if (m_drawThread) {
86 return;
87 }
88 m_isDrawing = true;
89 m_painter->setContext(controller);
90 m_painter->setMessagePainter(messagePainter());
91 m_context = controller;
92 m_painter->resize(size());
93 m_drawThread = new QThread(this);
94 m_drawThread->setObjectName("Painter Thread");
95 m_gl->doneCurrent();
96 m_gl->moveToThread(m_drawThread);
97 m_painter->moveToThread(m_drawThread);
98 if (videoProxy()) {
99 videoProxy()->moveToThread(m_drawThread);
100 }
101 connect(m_drawThread, &QThread::started, m_painter, &PainterGL::start);
102 m_drawThread->start();
103
104 lockAspectRatio(isAspectRatioLocked());
105 lockIntegerScaling(isIntegerScalingLocked());
106 interframeBlending(hasInterframeBlending());
107 filter(isFiltered());
108#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
109 messagePainter()->resize(size(), isAspectRatioLocked(), devicePixelRatioF());
110#else
111 messagePainter()->resize(size(), isAspectRatioLocked(), devicePixelRatio());
112#endif
113 resizePainter();
114}
115
116void DisplayGL::stopDrawing() {
117 if (m_drawThread) {
118 m_isDrawing = false;
119 CoreController::Interrupter interrupter(m_context);
120 QMetaObject::invokeMethod(m_painter, "stop", Qt::BlockingQueuedConnection);
121 m_drawThread->exit();
122 m_drawThread = nullptr;
123
124 m_gl->makeCurrent(windowHandle());
125#if defined(_WIN32) && defined(USE_EPOXY)
126 epoxy_handle_external_wglMakeCurrent();
127#endif
128 }
129 m_context.reset();
130}
131
132void DisplayGL::pauseDrawing() {
133 if (m_drawThread) {
134 m_isDrawing = false;
135 CoreController::Interrupter interrupter(m_context);
136 QMetaObject::invokeMethod(m_painter, "pause", Qt::BlockingQueuedConnection);
137 }
138}
139
140void DisplayGL::unpauseDrawing() {
141 if (m_drawThread) {
142 m_isDrawing = true;
143 CoreController::Interrupter interrupter(m_context);
144 QMetaObject::invokeMethod(m_painter, "unpause", Qt::BlockingQueuedConnection);
145 }
146}
147
148void DisplayGL::forceDraw() {
149 if (m_drawThread) {
150 QMetaObject::invokeMethod(m_painter, "forceDraw");
151 }
152}
153
154void DisplayGL::lockAspectRatio(bool lock) {
155 Display::lockAspectRatio(lock);
156 if (m_drawThread) {
157 QMetaObject::invokeMethod(m_painter, "lockAspectRatio", Q_ARG(bool, lock));
158 }
159}
160
161void DisplayGL::lockIntegerScaling(bool lock) {
162 Display::lockIntegerScaling(lock);
163 if (m_drawThread) {
164 QMetaObject::invokeMethod(m_painter, "lockIntegerScaling", Q_ARG(bool, lock));
165 }
166}
167
168void DisplayGL::interframeBlending(bool enable) {
169 Display::interframeBlending(enable);
170 if (m_drawThread) {
171 QMetaObject::invokeMethod(m_painter, "interframeBlending", Q_ARG(bool, enable));
172 }
173}
174
175void DisplayGL::filter(bool filter) {
176 Display::filter(filter);
177 if (m_drawThread) {
178 QMetaObject::invokeMethod(m_painter, "filter", Q_ARG(bool, filter));
179 }
180}
181
182void DisplayGL::framePosted() {
183 if (m_drawThread) {
184 m_painter->enqueue(m_context->drawContext());
185 QMetaObject::invokeMethod(m_painter, "draw");
186 }
187}
188
189void DisplayGL::setShaders(struct VDir* shaders) {
190 if (m_drawThread) {
191 QMetaObject::invokeMethod(m_painter, "setShaders", Qt::BlockingQueuedConnection, Q_ARG(struct VDir*, shaders));
192 } else {
193 m_painter->setShaders(shaders);
194 }
195}
196
197void DisplayGL::clearShaders() {
198 QMetaObject::invokeMethod(m_painter, "clearShaders");
199}
200
201
202void DisplayGL::resizeContext() {
203 if (m_drawThread) {
204 m_isDrawing = false;
205 CoreController::Interrupter interrupter(m_context);
206 QMetaObject::invokeMethod(m_painter, "resizeContext", Qt::BlockingQueuedConnection);
207 }
208}
209
210void DisplayGL::resizeEvent(QResizeEvent* event) {
211 Display::resizeEvent(event);
212 resizePainter();
213}
214
215void DisplayGL::resizePainter() {
216 if (m_drawThread) {
217 QMetaObject::invokeMethod(m_painter, "resize", Qt::BlockingQueuedConnection, Q_ARG(QSize, size()));
218 }
219}
220
221void DisplayGL::setVideoProxy(std::shared_ptr<VideoProxy> proxy) {
222 Display::setVideoProxy(proxy);
223 if (m_drawThread && proxy) {
224 proxy->moveToThread(m_drawThread);
225 }
226 m_painter->setVideoProxy(proxy);
227}
228
229int DisplayGL::framebufferHandle() {
230 return m_painter->glTex();
231}
232
233PainterGL::PainterGL(QWindow* surface, QOpenGLContext* parent)
234 : m_gl(parent)
235 , m_surface(surface)
236{
237#ifdef BUILD_GL
238 mGLContext* glBackend;
239#endif
240#ifdef BUILD_GLES2
241 mGLES2Context* gl2Backend;
242#endif
243
244 m_gl->makeCurrent(m_surface);
245 m_window = new QOpenGLPaintDevice;
246#if defined(_WIN32) && defined(USE_EPOXY)
247 epoxy_handle_external_wglMakeCurrent();
248#endif
249
250#ifdef BUILD_GLES2
251 auto version = m_gl->format().version();
252 QStringList extensions = QString(reinterpret_cast<const char*>(glGetString(GL_EXTENSIONS))).split(' ');
253 if ((version == qMakePair(2, 1) && extensions.contains("GL_ARB_framebuffer_object")) || version.first > 2) {
254 gl2Backend = static_cast<mGLES2Context*>(malloc(sizeof(mGLES2Context)));
255 mGLES2ContextCreate(gl2Backend);
256 m_backend = &gl2Backend->d;
257 m_supportsShaders = true;
258 }
259#endif
260
261#ifdef BUILD_GL
262 if (!m_backend) {
263 glBackend = static_cast<mGLContext*>(malloc(sizeof(mGLContext)));
264 mGLContextCreate(glBackend);
265 m_backend = &glBackend->d;
266 m_supportsShaders = false;
267 }
268#endif
269 m_backend->swap = [](VideoBackend* v) {
270 PainterGL* painter = static_cast<PainterGL*>(v->user);
271 if (!painter->m_swapTimer.isActive()) {
272 QMetaObject::invokeMethod(&painter->m_swapTimer, "start");
273 }
274 };
275
276 m_backend->init(m_backend, 0);
277#ifdef BUILD_GLES2
278 if (m_supportsShaders) {
279 m_shader.preprocessShader = static_cast<void*>(&reinterpret_cast<mGLES2Context*>(m_backend)->initialShader);
280 }
281#endif
282
283 m_backend->user = this;
284 m_backend->filter = false;
285 m_backend->lockAspectRatio = false;
286 m_backend->interframeBlending = false;
287
288 for (int i = 0; i < 2; ++i) {
289 m_free.append(new uint32_t[1024 * 2048]);
290 }
291
292 m_swapTimer.setInterval(16);
293 m_swapTimer.setSingleShot(true);
294 connect(&m_swapTimer, &QTimer::timeout, this, &PainterGL::swap);
295}
296
297PainterGL::~PainterGL() {
298 while (!m_queue.isEmpty()) {
299 delete[] m_queue.dequeue();
300 }
301 for (auto item : m_free) {
302 delete[] item;
303 }
304 m_gl->makeCurrent(m_surface);
305#if defined(_WIN32) && defined(USE_EPOXY)
306 epoxy_handle_external_wglMakeCurrent();
307#endif
308#ifdef BUILD_GLES2
309 if (m_shader.passes) {
310 mGLES2ShaderFree(&m_shader);
311 }
312#endif
313 m_backend->deinit(m_backend);
314 m_gl->doneCurrent();
315 free(m_backend);
316 m_backend = nullptr;
317 delete m_window;
318}
319
320void PainterGL::setContext(std::shared_ptr<CoreController> context) {
321 m_context = context;
322 resizeContext();
323}
324
325void PainterGL::resizeContext() {
326 if (!m_context) {
327 return;
328 }
329
330 QSize size = m_context->screenDimensions();
331 m_backend->setDimensions(m_backend, size.width(), size.height());
332}
333
334void PainterGL::setMessagePainter(MessagePainter* messagePainter) {
335 m_messagePainter = messagePainter;
336}
337
338void PainterGL::resize(const QSize& size) {
339 m_size = size;
340 if (m_started && !m_active) {
341 forceDraw();
342 }
343}
344
345void PainterGL::lockAspectRatio(bool lock) {
346 m_backend->lockAspectRatio = lock;
347 resize(m_size);
348}
349
350void PainterGL::lockIntegerScaling(bool lock) {
351 m_backend->lockIntegerScaling = lock;
352 resize(m_size);
353}
354
355void PainterGL::interframeBlending(bool enable) {
356 m_backend->interframeBlending = enable;
357}
358
359void PainterGL::filter(bool filter) {
360 m_backend->filter = filter;
361 if (m_started && !m_active) {
362 forceDraw();
363 }
364}
365
366void PainterGL::start() {
367 m_gl->makeCurrent(m_surface);
368#if defined(_WIN32) && defined(USE_EPOXY)
369 epoxy_handle_external_wglMakeCurrent();
370#endif
371
372#ifdef BUILD_GLES2
373 if (m_supportsShaders && m_shader.passes) {
374 mGLES2ShaderAttach(reinterpret_cast<mGLES2Context*>(m_backend), static_cast<mGLES2Shader*>(m_shader.passes), m_shader.nPasses);
375 }
376#endif
377
378 m_active = true;
379 m_started = true;
380}
381
382void PainterGL::draw() {
383 if (m_queue.isEmpty()) {
384 return;
385 }
386
387 if (m_needsUnlock) {
388 QTimer::singleShot(0, this, &PainterGL::draw);
389 return;
390 }
391
392 if (mCoreSyncWaitFrameStart(&m_context->thread()->impl->sync) || !m_queue.isEmpty()) {
393 dequeue();
394 forceDraw();
395 if (m_context->thread()->impl->sync.videoFrameWait) {
396 m_needsUnlock = true;
397 } else {
398 mCoreSyncWaitFrameEnd(&m_context->thread()->impl->sync);
399 }
400 } else {
401 mCoreSyncWaitFrameEnd(&m_context->thread()->impl->sync);
402 }
403}
404
405void PainterGL::forceDraw() {
406 m_painter.begin(m_window);
407 performDraw();
408 m_painter.end();
409 m_backend->swap(m_backend);
410}
411
412void PainterGL::stop() {
413 m_active = false;
414 m_started = false;
415 dequeueAll();
416 m_backend->clear(m_backend);
417 m_backend->swap(m_backend);
418 if (m_swapTimer.isActive()) {
419 swap();
420 m_swapTimer.stop();
421 }
422 if (m_videoProxy) {
423 m_videoProxy->reset();
424 }
425 m_gl->doneCurrent();
426 m_gl->moveToThread(m_surface->thread());
427 m_context.reset();
428 moveToThread(m_gl->thread());
429 if (m_videoProxy) {
430 m_videoProxy->moveToThread(m_gl->thread());
431 }
432}
433
434void PainterGL::pause() {
435 m_active = false;
436}
437
438void PainterGL::unpause() {
439 m_active = true;
440}
441
442void PainterGL::performDraw() {
443 m_painter.beginNativePainting();
444 float r = m_surface->devicePixelRatio();
445 m_backend->resized(m_backend, m_size.width() * r, m_size.height() * r);
446 m_backend->drawFrame(m_backend);
447 m_painter.endNativePainting();
448 if (m_messagePainter) {
449 m_messagePainter->paint(&m_painter);
450 }
451 m_frameReady = true;
452}
453
454void PainterGL::swap() {
455 if (!m_gl->isValid()) {
456 return;
457 }
458 if (m_frameReady) {
459 m_gl->swapBuffers(m_surface);
460 m_gl->makeCurrent(m_surface);
461#if defined(_WIN32) && defined(USE_EPOXY)
462 epoxy_handle_external_wglMakeCurrent();
463#endif
464 m_frameReady = false;
465 }
466 if (m_needsUnlock) {
467 mCoreSyncWaitFrameEnd(&m_context->thread()->impl->sync);
468 m_needsUnlock = false;
469 }
470 if (!m_queue.isEmpty()) {
471 QMetaObject::invokeMethod(this, "draw", Qt::QueuedConnection);
472 } else {
473 m_swapTimer.start();
474 }
475}
476
477void PainterGL::enqueue(const uint32_t* backing) {
478 m_mutex.lock();
479 uint32_t* buffer = nullptr;
480 if (backing) {
481 if (m_free.isEmpty()) {
482 buffer = m_queue.dequeue();
483 } else {
484 buffer = m_free.takeLast();
485 }
486 QSize size = m_context->screenDimensions();
487 memcpy(buffer, backing, size.width() * size.height() * BYTES_PER_PIXEL);
488 }
489 m_queue.enqueue(buffer);
490 m_mutex.unlock();
491}
492
493void PainterGL::dequeue() {
494 m_mutex.lock();
495 if (m_queue.isEmpty()) {
496 m_mutex.unlock();
497 return;
498 }
499 uint32_t* buffer = m_queue.dequeue();
500 if (buffer) {
501 m_backend->postFrame(m_backend, buffer);
502 m_free.append(buffer);
503 }
504 m_mutex.unlock();
505}
506
507void PainterGL::dequeueAll() {
508 uint32_t* buffer = 0;
509 m_mutex.lock();
510 while (!m_queue.isEmpty()) {
511 buffer = m_queue.dequeue();
512 if (buffer) {
513 m_free.append(buffer);
514 }
515 }
516 if (buffer) {
517 m_backend->postFrame(m_backend, buffer);
518 }
519 m_mutex.unlock();
520}
521
522void PainterGL::setVideoProxy(std::shared_ptr<VideoProxy> proxy) {
523 m_videoProxy = proxy;
524}
525
526void PainterGL::setShaders(struct VDir* dir) {
527 if (!supportsShaders()) {
528 return;
529 }
530#ifdef BUILD_GLES2
531 if (m_shader.passes) {
532 mGLES2ShaderDetach(reinterpret_cast<mGLES2Context*>(m_backend));
533 mGLES2ShaderFree(&m_shader);
534 }
535 mGLES2ShaderLoad(&m_shader, dir);
536 if (m_started) {
537 mGLES2ShaderAttach(reinterpret_cast<mGLES2Context*>(m_backend), static_cast<mGLES2Shader*>(m_shader.passes), m_shader.nPasses);
538 }
539#endif
540}
541
542void PainterGL::clearShaders() {
543 if (!supportsShaders()) {
544 return;
545 }
546#ifdef BUILD_GLES2
547 if (m_shader.passes) {
548 mGLES2ShaderDetach(reinterpret_cast<mGLES2Context*>(m_backend));
549 mGLES2ShaderFree(&m_shader);
550 }
551#endif
552}
553
554VideoShader* PainterGL::shaders() {
555 return &m_shader;
556}
557
558int PainterGL::glTex() {
559#ifdef BUILD_GLES2
560 if (supportsShaders()) {
561 mGLES2Context* gl2Backend = reinterpret_cast<mGLES2Context*>(m_backend);
562 return gl2Backend->tex;
563 }
564#endif
565#ifdef BUILD_GL
566 mGLContext* glBackend = reinterpret_cast<mGLContext*>(m_backend);
567 return glBackend->tex[0];
568#else
569 return -1;
570#endif
571}
572
573#endif