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