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 (auto& buf : m_buffers) {
334 m_free.append(&buf.front());
335 }
336}
337
338PainterGL::~PainterGL() {
339 m_gl->makeCurrent(m_surface);
340#if defined(_WIN32) && defined(USE_EPOXY)
341 epoxy_handle_external_wglMakeCurrent();
342#endif
343#ifdef BUILD_GLES2
344 if (m_shader.passes) {
345 mGLES2ShaderFree(&m_shader);
346 }
347#endif
348 m_backend->deinit(m_backend);
349 m_gl->doneCurrent();
350 free(m_backend);
351 m_backend = nullptr;
352 delete m_window;
353}
354
355void PainterGL::setContext(std::shared_ptr<CoreController> context) {
356 m_context = context;
357 resizeContext();
358}
359
360void PainterGL::resizeContext() {
361 if (!m_context) {
362 return;
363 }
364
365 if (m_started) {
366 mCore* core = m_context->thread()->core;
367 core->reloadConfigOption(core, "videoScale", NULL);
368 }
369
370 QSize size = m_context->screenDimensions();
371 m_backend->setDimensions(m_backend, size.width(), size.height());
372}
373
374void PainterGL::setMessagePainter(MessagePainter* messagePainter) {
375 m_messagePainter = messagePainter;
376}
377
378void PainterGL::resize(const QSize& size) {
379 m_size = size;
380 m_window->setSize(m_size);
381 if (m_started && !m_active) {
382 forceDraw();
383 }
384}
385
386void PainterGL::lockAspectRatio(bool lock) {
387 m_backend->lockAspectRatio = lock;
388 resize(m_size);
389}
390
391void PainterGL::lockIntegerScaling(bool lock) {
392 m_backend->lockIntegerScaling = lock;
393 resize(m_size);
394}
395
396void PainterGL::interframeBlending(bool enable) {
397 m_backend->interframeBlending = enable;
398}
399
400void PainterGL::showOSD(bool enable) {
401 m_showOSD = enable;
402}
403
404void PainterGL::filter(bool filter) {
405 m_backend->filter = filter;
406 if (m_started && !m_active) {
407 forceDraw();
408 }
409}
410
411void PainterGL::start() {
412 m_gl->makeCurrent(m_surface);
413#if defined(_WIN32) && defined(USE_EPOXY)
414 epoxy_handle_external_wglMakeCurrent();
415#endif
416
417#ifdef BUILD_GLES2
418 if (m_supportsShaders && m_shader.passes) {
419 mGLES2ShaderAttach(reinterpret_cast<mGLES2Context*>(m_backend), static_cast<mGLES2Shader*>(m_shader.passes), m_shader.nPasses);
420 }
421#endif
422
423 m_buffer = nullptr;
424 m_active = true;
425 m_started = true;
426}
427
428void PainterGL::draw() {
429 if (!m_active || m_queue.isEmpty()) {
430 return;
431 }
432 mCoreSync* sync = &m_context->thread()->impl->sync;
433 mCoreSyncWaitFrameStart(sync);
434 dequeue();
435 if (!m_delayTimer.isValid()) {
436 m_delayTimer.start();
437 } else if (sync->audioWait || sync->videoFrameWait) {
438 while (m_delayTimer.nsecsElapsed() + 2000000 < 1000000000 / sync->fpsTarget) {
439 QThread::usleep(500);
440 }
441 m_delayTimer.restart();
442 }
443 mCoreSyncWaitFrameEnd(sync);
444
445 forceDraw();
446}
447
448void PainterGL::forceDraw() {
449 m_painter.begin(m_window);
450 performDraw();
451 m_painter.end();
452 if (!m_context->thread()->impl->sync.audioWait && !m_context->thread()->impl->sync.videoFrameWait) {
453 if (m_delayTimer.elapsed() < 1000 / m_surface->screen()->refreshRate()) {
454 return;
455 }
456 m_delayTimer.restart();
457 }
458 m_backend->swap(m_backend);
459}
460
461void PainterGL::stop() {
462 m_active = false;
463 m_started = false;
464 dequeueAll();
465 m_backend->clear(m_backend);
466 m_backend->swap(m_backend);
467 if (m_videoProxy) {
468 m_videoProxy->reset();
469 }
470 m_gl->doneCurrent();
471 m_gl->moveToThread(m_surface->thread());
472 m_context.reset();
473 moveToThread(m_gl->thread());
474 if (m_videoProxy) {
475 m_videoProxy->moveToThread(m_gl->thread());
476 }
477}
478
479void PainterGL::pause() {
480 m_active = false;
481}
482
483void PainterGL::unpause() {
484 m_active = true;
485}
486
487void PainterGL::performDraw() {
488 m_painter.beginNativePainting();
489 float r = m_surface->devicePixelRatio();
490 m_backend->resized(m_backend, m_size.width() * r, m_size.height() * r);
491 if (m_buffer) {
492 m_backend->postFrame(m_backend, m_buffer);
493 }
494 m_backend->drawFrame(m_backend);
495 m_painter.endNativePainting();
496 if (m_showOSD && m_messagePainter) {
497 m_messagePainter->paint(&m_painter);
498 }
499}
500
501void PainterGL::enqueue(const uint32_t* backing) {
502 QMutexLocker locker(&m_mutex);
503 uint32_t* buffer = nullptr;
504 if (backing) {
505 if (m_free.isEmpty()) {
506 buffer = m_queue.dequeue();
507 } else {
508 buffer = m_free.takeLast();
509 }
510 if (buffer) {
511 QSize size = m_context->screenDimensions();
512 memcpy(buffer, backing, size.width() * size.height() * BYTES_PER_PIXEL);
513 }
514 }
515 m_queue.enqueue(buffer);
516}
517
518void PainterGL::dequeue() {
519 QMutexLocker locker(&m_mutex);
520 if (m_queue.isEmpty()) {
521 return;
522 }
523 uint32_t* buffer = m_queue.dequeue();
524 if (m_buffer) {
525 m_free.append(m_buffer);
526 m_buffer = nullptr;
527 }
528 m_buffer = buffer;
529}
530
531void PainterGL::dequeueAll() {
532 uint32_t* buffer = 0;
533 m_mutex.lock();
534 while (!m_queue.isEmpty()) {
535 buffer = m_queue.dequeue();
536 if (buffer) {
537 m_free.append(buffer);
538 }
539 }
540 if (buffer) {
541 m_backend->postFrame(m_backend, buffer);
542 }
543 if (m_buffer) {
544 m_free.append(m_buffer);
545 m_buffer = nullptr;
546 }
547 m_mutex.unlock();
548}
549
550void PainterGL::setVideoProxy(std::shared_ptr<VideoProxy> proxy) {
551 m_videoProxy = proxy;
552}
553
554void PainterGL::setShaders(struct VDir* dir) {
555 if (!supportsShaders()) {
556 return;
557 }
558#ifdef BUILD_GLES2
559 if (!m_started) {
560 m_gl->makeCurrent(m_surface);
561#if defined(_WIN32) && defined(USE_EPOXY)
562 epoxy_handle_external_wglMakeCurrent();
563#endif
564 }
565 if (m_shader.passes) {
566 mGLES2ShaderDetach(reinterpret_cast<mGLES2Context*>(m_backend));
567 mGLES2ShaderFree(&m_shader);
568 }
569 mGLES2ShaderLoad(&m_shader, dir);
570 if (m_started) {
571 mGLES2ShaderAttach(reinterpret_cast<mGLES2Context*>(m_backend), static_cast<mGLES2Shader*>(m_shader.passes), m_shader.nPasses);
572 } else {
573 m_gl->doneCurrent();
574 }
575#endif
576}
577
578void PainterGL::clearShaders() {
579 if (!supportsShaders()) {
580 return;
581 }
582#ifdef BUILD_GLES2
583 if (!m_started) {
584 m_gl->makeCurrent(m_surface);
585#if defined(_WIN32) && defined(USE_EPOXY)
586 epoxy_handle_external_wglMakeCurrent();
587#endif
588 }
589 if (m_shader.passes) {
590 mGLES2ShaderDetach(reinterpret_cast<mGLES2Context*>(m_backend));
591 mGLES2ShaderFree(&m_shader);
592 }
593 if (!m_started) {
594 m_gl->doneCurrent();
595 }
596#endif
597}
598
599VideoShader* PainterGL::shaders() {
600 return &m_shader;
601}
602
603int PainterGL::glTex() {
604#ifdef BUILD_GLES2
605 if (supportsShaders()) {
606 mGLES2Context* gl2Backend = reinterpret_cast<mGLES2Context*>(m_backend);
607 return gl2Backend->tex;
608 }
609#endif
610#ifdef BUILD_GL
611 mGLContext* glBackend = reinterpret_cast<mGLContext*>(m_backend);
612 return glBackend->tex[0];
613#else
614 return -1;
615#endif
616}
617
618#endif