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 QSize dims = controller->screenDimensions();
96 setSystemDimensions(dims.width(), dims.height());
97
98 m_isDrawing = true;
99 m_painter->setContext(controller);
100 m_painter->setMessagePainter(messagePainter());
101 m_context = controller;
102 m_painter->resize(size());
103 m_drawThread = new QThread(this);
104 m_drawThread->setObjectName("Painter Thread");
105 m_gl->doneCurrent();
106 m_gl->moveToThread(m_drawThread);
107 m_painter->moveToThread(m_drawThread);
108 if (videoProxy()) {
109 videoProxy()->moveToThread(m_drawThread);
110 }
111 connect(m_drawThread, &QThread::started, m_painter, &PainterGL::start);
112 m_drawThread->start();
113
114 lockAspectRatio(isAspectRatioLocked());
115 lockIntegerScaling(isIntegerScalingLocked());
116 interframeBlending(hasInterframeBlending());
117 showOSDMessages(isShowOSD());
118 filter(isFiltered());
119#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
120 messagePainter()->resize(size(), isAspectRatioLocked(), devicePixelRatioF());
121#else
122 messagePainter()->resize(size(), isAspectRatioLocked(), devicePixelRatio());
123#endif
124 resizePainter();
125 setUpdatesEnabled(false);
126}
127
128void DisplayGL::stopDrawing() {
129 if (m_drawThread) {
130 m_isDrawing = false;
131 CoreController::Interrupter interrupter(m_context);
132 QMetaObject::invokeMethod(m_painter, "stop", Qt::BlockingQueuedConnection);
133 m_drawThread->exit();
134 m_drawThread->wait();
135 m_drawThread = nullptr;
136
137 m_gl->makeCurrent(windowHandle());
138#if defined(_WIN32) && defined(USE_EPOXY)
139 epoxy_handle_external_wglMakeCurrent();
140#endif
141 setUpdatesEnabled(true);
142 }
143 m_context.reset();
144}
145
146void DisplayGL::pauseDrawing() {
147 if (m_drawThread) {
148 m_isDrawing = false;
149 CoreController::Interrupter interrupter(m_context);
150 QMetaObject::invokeMethod(m_painter, "pause", Qt::BlockingQueuedConnection);
151 setUpdatesEnabled(true);
152 }
153}
154
155void DisplayGL::unpauseDrawing() {
156 if (m_drawThread) {
157 m_isDrawing = true;
158 CoreController::Interrupter interrupter(m_context);
159 QMetaObject::invokeMethod(m_painter, "unpause", Qt::BlockingQueuedConnection);
160 setUpdatesEnabled(false);
161 }
162}
163
164void DisplayGL::forceDraw() {
165 if (m_drawThread) {
166 QMetaObject::invokeMethod(m_painter, "forceDraw");
167 }
168}
169
170void DisplayGL::lockAspectRatio(bool lock) {
171 Display::lockAspectRatio(lock);
172 if (m_drawThread) {
173 QMetaObject::invokeMethod(m_painter, "lockAspectRatio", Q_ARG(bool, lock));
174 }
175}
176
177void DisplayGL::lockIntegerScaling(bool lock) {
178 Display::lockIntegerScaling(lock);
179 if (m_drawThread) {
180 QMetaObject::invokeMethod(m_painter, "lockIntegerScaling", Q_ARG(bool, lock));
181 }
182}
183
184void DisplayGL::interframeBlending(bool enable) {
185 Display::interframeBlending(enable);
186 if (m_drawThread) {
187 QMetaObject::invokeMethod(m_painter, "interframeBlending", Q_ARG(bool, enable));
188 }
189}
190
191void DisplayGL::showOSDMessages(bool enable) {
192 Display::showOSDMessages(enable);
193 if (m_drawThread) {
194 QMetaObject::invokeMethod(m_painter, "showOSD", Q_ARG(bool, enable));
195 }
196}
197
198void DisplayGL::filter(bool filter) {
199 Display::filter(filter);
200 if (m_drawThread) {
201 QMetaObject::invokeMethod(m_painter, "filter", Q_ARG(bool, filter));
202 }
203}
204
205void DisplayGL::framePosted() {
206 if (m_drawThread) {
207 m_painter->enqueue(m_context->drawContext());
208 QMetaObject::invokeMethod(m_painter, "draw");
209 }
210}
211
212void DisplayGL::setShaders(struct VDir* shaders) {
213 if (m_drawThread) {
214 QMetaObject::invokeMethod(m_painter, "setShaders", Qt::BlockingQueuedConnection, Q_ARG(struct VDir*, shaders));
215 } else {
216 m_painter->setShaders(shaders);
217 }
218}
219
220void DisplayGL::clearShaders() {
221 QMetaObject::invokeMethod(m_painter, "clearShaders");
222}
223
224void DisplayGL::resizeContext() {
225 if (m_drawThread) {
226 m_isDrawing = false;
227 CoreController::Interrupter interrupter(m_context);
228 QMetaObject::invokeMethod(m_painter, "resizeContext", Qt::BlockingQueuedConnection);
229 }
230}
231
232void DisplayGL::setVideoScale(int scale) {
233 if (m_drawThread) {
234 m_isDrawing = false;
235 CoreController::Interrupter interrupter(m_context);
236 mCoreConfigSetIntValue(&m_context->thread()->core->config, "videoScale", scale);
237 QMetaObject::invokeMethod(m_painter, "resizeContext", Qt::BlockingQueuedConnection);
238 }
239}
240
241void DisplayGL::resizeEvent(QResizeEvent* event) {
242 Display::resizeEvent(event);
243 resizePainter();
244}
245
246void DisplayGL::resizePainter() {
247 if (m_drawThread) {
248 QMetaObject::invokeMethod(m_painter, "resize", Qt::BlockingQueuedConnection, Q_ARG(QSize, size()));
249 }
250}
251
252void DisplayGL::setVideoProxy(std::shared_ptr<VideoProxy> proxy) {
253 Display::setVideoProxy(proxy);
254 if (m_drawThread && proxy) {
255 proxy->moveToThread(m_drawThread);
256 }
257 m_painter->setVideoProxy(proxy);
258}
259
260int DisplayGL::framebufferHandle() {
261 return m_painter->glTex();
262}
263
264PainterGL::PainterGL(QWindow* surface, QOpenGLContext* parent, int forceVersion)
265 : m_gl(parent)
266 , m_surface(surface)
267{
268#ifdef BUILD_GL
269 mGLContext* glBackend;
270#endif
271#ifdef BUILD_GLES2
272 mGLES2Context* gl2Backend;
273#endif
274
275 m_gl->makeCurrent(m_surface);
276 m_window = new QOpenGLPaintDevice;
277 {
278 // XXX: Qt creates TLS for OpenGL objects in the local thread
279 // We need to prevent that thread from being the painter thread
280 // Qt also caches the engine object on the device if a different
281 // engine is active, so let's make a temporary one
282 QOpenGLPaintDevice* fakeDevice = new QOpenGLPaintDevice;
283 QPainter fakePainter(fakeDevice);
284 m_window->paintEngine();
285 }
286#if defined(_WIN32) && defined(USE_EPOXY)
287 epoxy_handle_external_wglMakeCurrent();
288#endif
289
290#ifdef BUILD_GLES2
291 auto version = m_gl->format().version();
292 QStringList extensions = QString(reinterpret_cast<const char*>(glGetString(GL_EXTENSIONS))).split(' ');
293 if (forceVersion != 1 && ((version == qMakePair(2, 1) && extensions.contains("GL_ARB_framebuffer_object")) || version.first > 2)) {
294 gl2Backend = static_cast<mGLES2Context*>(malloc(sizeof(mGLES2Context)));
295 mGLES2ContextCreate(gl2Backend);
296 m_backend = &gl2Backend->d;
297 m_supportsShaders = true;
298 }
299#endif
300
301#ifdef BUILD_GL
302 if (!m_backend) {
303 glBackend = static_cast<mGLContext*>(malloc(sizeof(mGLContext)));
304 mGLContextCreate(glBackend);
305 m_backend = &glBackend->d;
306 m_supportsShaders = false;
307 }
308#endif
309 m_backend->swap = [](VideoBackend* v) {
310 PainterGL* painter = static_cast<PainterGL*>(v->user);
311 if (!painter->m_gl->isValid()) {
312 return;
313 }
314 painter->m_gl->swapBuffers(painter->m_surface);
315 painter->m_gl->makeCurrent(painter->m_surface);
316#if defined(_WIN32) && defined(USE_EPOXY)
317 epoxy_handle_external_wglMakeCurrent();
318#endif
319 };
320
321 m_backend->init(m_backend, 0);
322#ifdef BUILD_GLES2
323 if (m_supportsShaders) {
324 m_shader.preprocessShader = static_cast<void*>(&reinterpret_cast<mGLES2Context*>(m_backend)->initialShader);
325 }
326#endif
327
328 m_backend->user = this;
329 m_backend->filter = false;
330 m_backend->lockAspectRatio = false;
331 m_backend->interframeBlending = false;
332
333 for (int i = 0; i < 2; ++i) {
334 m_free.append(new uint32_t[256 * 512]);
335 }
336}
337
338PainterGL::~PainterGL() {
339 while (!m_queue.isEmpty()) {
340 delete[] m_queue.dequeue();
341 }
342 for (auto item : m_free) {
343 delete[] item;
344 }
345 m_gl->makeCurrent(m_surface);
346#if defined(_WIN32) && defined(USE_EPOXY)
347 epoxy_handle_external_wglMakeCurrent();
348#endif
349#ifdef BUILD_GLES2
350 if (m_shader.passes) {
351 mGLES2ShaderFree(&m_shader);
352 }
353#endif
354 m_backend->deinit(m_backend);
355 m_gl->doneCurrent();
356 free(m_backend);
357 m_backend = nullptr;
358 delete m_window;
359}
360
361void PainterGL::setContext(std::shared_ptr<CoreController> context) {
362 m_context = context;
363 resizeContext();
364}
365
366void PainterGL::resizeContext() {
367 if (!m_context) {
368 return;
369 }
370
371 if (m_started) {
372 mCore* core = m_context->thread()->core;
373 core->reloadConfigOption(core, "videoScale", NULL);
374 }
375
376 QSize size = m_context->screenDimensions();
377 m_backend->setDimensions(m_backend, size.width(), size.height());
378}
379
380void PainterGL::setMessagePainter(MessagePainter* messagePainter) {
381 m_messagePainter = messagePainter;
382}
383
384void PainterGL::resize(const QSize& size) {
385 m_size = size;
386 m_window->setSize(m_size);
387 if (m_started && !m_active) {
388 forceDraw();
389 }
390}
391
392void PainterGL::lockAspectRatio(bool lock) {
393 m_backend->lockAspectRatio = lock;
394 resize(m_size);
395}
396
397void PainterGL::lockIntegerScaling(bool lock) {
398 m_backend->lockIntegerScaling = lock;
399 resize(m_size);
400}
401
402void PainterGL::interframeBlending(bool enable) {
403 m_backend->interframeBlending = enable;
404}
405
406void PainterGL::showOSD(bool enable) {
407 m_showOSD = enable;
408}
409
410void PainterGL::filter(bool filter) {
411 m_backend->filter = filter;
412 if (m_started && !m_active) {
413 forceDraw();
414 }
415}
416
417void PainterGL::start() {
418 m_gl->makeCurrent(m_surface);
419#if defined(_WIN32) && defined(USE_EPOXY)
420 epoxy_handle_external_wglMakeCurrent();
421#endif
422
423#ifdef BUILD_GLES2
424 if (m_supportsShaders && m_shader.passes) {
425 mGLES2ShaderAttach(reinterpret_cast<mGLES2Context*>(m_backend), static_cast<mGLES2Shader*>(m_shader.passes), m_shader.nPasses);
426 }
427#endif
428
429 m_active = true;
430 m_started = true;
431}
432
433void PainterGL::draw() {
434 if (!m_active || m_queue.isEmpty()) {
435 return;
436 }
437 mCoreSync* sync = &m_context->thread()->impl->sync;
438 mCoreSyncWaitFrameStart(sync);
439 dequeue();
440 if (!m_delayTimer.isValid()) {
441 m_delayTimer.start();
442 } else if (sync->audioWait || sync->videoFrameWait) {
443 while (m_delayTimer.nsecsElapsed() + 2000000 < 1000000000 / sync->fpsTarget) {
444 QThread::usleep(500);
445 }
446 m_delayTimer.restart();
447 }
448 mCoreSyncWaitFrameEnd(sync);
449
450 forceDraw();
451}
452
453void PainterGL::forceDraw() {
454 m_painter.begin(m_window);
455 performDraw();
456 m_painter.end();
457 if (!m_context->thread()->impl->sync.audioWait && !m_context->thread()->impl->sync.videoFrameWait) {
458 if (m_delayTimer.elapsed() < 1000 / m_surface->screen()->refreshRate()) {
459 return;
460 }
461 m_delayTimer.restart();
462 }
463 m_backend->swap(m_backend);
464}
465
466void PainterGL::stop() {
467 m_active = false;
468 m_started = false;
469 dequeueAll();
470 m_backend->clear(m_backend);
471 m_backend->swap(m_backend);
472 if (m_videoProxy) {
473 m_videoProxy->reset();
474 }
475 m_gl->doneCurrent();
476 m_gl->moveToThread(m_surface->thread());
477 m_context.reset();
478 moveToThread(m_gl->thread());
479 if (m_videoProxy) {
480 m_videoProxy->moveToThread(m_gl->thread());
481 }
482}
483
484void PainterGL::pause() {
485 m_active = false;
486}
487
488void PainterGL::unpause() {
489 m_active = true;
490}
491
492void PainterGL::performDraw() {
493 m_painter.beginNativePainting();
494 float r = m_surface->devicePixelRatio();
495 m_backend->resized(m_backend, m_size.width() * r, m_size.height() * r);
496 m_backend->drawFrame(m_backend);
497 m_painter.endNativePainting();
498 if (m_showOSD && m_messagePainter) {
499 m_messagePainter->paint(&m_painter);
500 }
501}
502
503void PainterGL::enqueue(const uint32_t* backing) {
504 m_mutex.lock();
505 uint32_t* buffer = nullptr;
506 if (backing) {
507 if (m_free.isEmpty()) {
508 buffer = m_queue.dequeue();
509 } else {
510 buffer = m_free.takeLast();
511 }
512 QSize size = m_context->screenDimensions();
513 memcpy(buffer, backing, size.width() * size.height() * BYTES_PER_PIXEL);
514 }
515 m_queue.enqueue(buffer);
516 m_mutex.unlock();
517}
518
519void PainterGL::dequeue() {
520 m_mutex.lock();
521 if (m_queue.isEmpty()) {
522 m_mutex.unlock();
523 return;
524 }
525 uint32_t* buffer = m_queue.dequeue();
526 if (buffer) {
527 m_backend->postFrame(m_backend, buffer);
528 m_free.append(buffer);
529 }
530 m_mutex.unlock();
531}
532
533void PainterGL::dequeueAll() {
534 uint32_t* buffer = 0;
535 m_mutex.lock();
536 while (!m_queue.isEmpty()) {
537 buffer = m_queue.dequeue();
538 if (buffer) {
539 m_free.append(buffer);
540 }
541 }
542 if (buffer) {
543 m_backend->postFrame(m_backend, buffer);
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