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