src/platform/qt/FrameView.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 "FrameView.h"
7
8#include <QMouseEvent>
9#include <QPalette>
10
11#include <array>
12#include <cmath>
13
14#include "CoreController.h"
15#include "GBAApp.h"
16
17#include <mgba/core/core.h>
18#include <mgba/feature/video-logger.h>
19#ifdef M_CORE_GBA
20#include <mgba/internal/gba/gba.h>
21#include <mgba/internal/gba/io.h>
22#include <mgba/internal/gba/memory.h>
23#include <mgba/internal/gba/video.h>
24#endif
25#ifdef M_CORE_GB
26#include <mgba/internal/gb/gb.h>
27#include <mgba/internal/gb/io.h>
28#include <mgba/internal/gb/memory.h>
29#endif
30
31using namespace QGBA;
32
33FrameView::FrameView(std::shared_ptr<CoreController> controller, QWidget* parent)
34 : AssetView(controller, parent)
35{
36 m_ui.setupUi(this);
37
38 m_glowTimer.setInterval(33);
39 connect(&m_glowTimer, &QTimer::timeout, this, [this]() {
40 ++m_glowFrame;
41 invalidateQueue();
42 });
43
44 m_ui.compositedView->installEventFilter(this);
45
46 connect(m_ui.queue, &QListWidget::itemChanged, this, [this](QListWidgetItem* item) {
47 Layer& layer = m_queue[item->data(Qt::UserRole).toInt()];
48 layer.enabled = item->checkState() == Qt::Checked;
49 if (layer.enabled) {
50 m_disabled.remove(layer.id);
51 } else {
52 m_disabled.insert(layer.id);
53 }
54 invalidateQueue();
55 });
56 connect(m_ui.queue, &QListWidget::currentItemChanged, this, [this](QListWidgetItem* item) {
57 if (item) {
58 m_active = m_queue[item->data(Qt::UserRole).toInt()].id;
59 } else {
60 m_active = {};
61 }
62 invalidateQueue();
63 });
64 connect(m_ui.magnification, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged), this, [this]() {
65 invalidateQueue();
66 });
67 connect(m_ui.exportButton, &QAbstractButton::pressed, this, &FrameView::exportFrame);
68 connect(m_ui.reset, &QAbstractButton::pressed, this, &FrameView::reset);
69
70 m_backdropPicker = ColorPicker(m_ui.backdrop, QColor(0, 0, 0, 0));
71 connect(&m_backdropPicker, &ColorPicker::colorChanged, this, [this](const QColor& color) {
72 m_overrideBackdrop = color;
73 });
74 m_controller->addFrameAction(std::bind(&FrameView::frameCallback, this, m_callbackLocker));
75
76 {
77 CoreController::Interrupter interrupter(m_controller);
78 refreshVl();
79 }
80 m_controller->frameAdvance();
81}
82
83FrameView::~FrameView() {
84 QMutexLocker locker(&m_mutex);
85 *m_callbackLocker = false;
86 if (m_vl) {
87 m_vl->deinit(m_vl);
88 }
89}
90
91bool FrameView::lookupLayer(const QPointF& coord, Layer*& out) {
92 for (Layer& layer : m_queue) {
93 if (!layer.enabled || m_disabled.contains(layer.id)) {
94 continue;
95 }
96 QPointF location = layer.location;
97 QSizeF layerDims(layer.image.width(), layer.image.height());
98 QRegion region;
99 if (layer.repeats) {
100 if (location.x() + layerDims.width() < 0) {
101 location.setX(std::fmod(location.x(), layerDims.width()));
102 }
103 if (location.y() + layerDims.height() < 0) {
104 location.setY(std::fmod(location.y(), layerDims.height()));
105 }
106
107 region += layer.mask.translated(location.x(), location.y());
108 region += layer.mask.translated(location.x() + layerDims.width(), location.y());
109 region += layer.mask.translated(location.x(), location.y() + layerDims.height());
110 region += layer.mask.translated(location.x() + layerDims.width(), location.y() + layerDims.height());
111 } else {
112 region = layer.mask.translated(location.x(), location.y());
113 }
114
115 if (region.contains(QPoint(coord.x(), coord.y()))) {
116 out = &layer;
117 return true;
118 }
119 }
120 return false;
121}
122
123void FrameView::selectLayer(const QPointF& coord) {
124 Layer* layer;
125 if (!lookupLayer(coord, layer)) {
126 return;
127 }
128 if (layer->id == m_active) {
129 m_active = {};
130 } else {
131 m_active = layer->id;
132 }
133 m_glowFrame = 0;
134}
135
136void FrameView::disableLayer(const QPointF& coord) {
137 Layer* layer;
138 if (!lookupLayer(coord, layer)) {
139 return;
140 }
141 layer->enabled = false;
142 m_disabled.insert(layer->id);
143}
144
145#ifdef M_CORE_GBA
146void FrameView::updateTilesGBA(bool) {
147 if (m_ui.freeze->checkState() == Qt::Checked) {
148 return;
149 }
150 QMutexLocker locker(&m_mutex);
151 m_queue.clear();
152 {
153 CoreController::Interrupter interrupter(m_controller);
154
155 uint16_t* io = static_cast<GBA*>(m_controller->thread()->core->board)->memory.io;
156 QRgb backdrop = M_RGB5_TO_RGB8(static_cast<GBA*>(m_controller->thread()->core->board)->video.palette[0]);
157 GBARegisterDISPCNT gbaDispcnt = io[REG_DISPCNT >> 1];
158 int mode = GBARegisterDISPCNTGetMode(gbaDispcnt);
159
160 std::array<bool, 4> enabled{
161 bool(GBARegisterDISPCNTIsBg0Enable(gbaDispcnt)),
162 bool(GBARegisterDISPCNTIsBg1Enable(gbaDispcnt)),
163 bool(GBARegisterDISPCNTIsBg2Enable(gbaDispcnt)),
164 bool(GBARegisterDISPCNTIsBg3Enable(gbaDispcnt)),
165 };
166
167 if (GBARegisterDISPCNTIsWin0Enable(gbaDispcnt)) {
168 m_queue.append({
169 { LayerId::WINDOW, 0 },
170 !m_disabled.contains({ LayerId::WINDOW, 0 }),
171 {},
172 {}, {0, 0}, true, false
173 });
174 }
175
176 if (GBARegisterDISPCNTIsWin1Enable(gbaDispcnt)) {
177 m_queue.append({
178 { LayerId::WINDOW, 1 },
179 !m_disabled.contains({ LayerId::WINDOW, 1 }),
180 {},
181 {}, {0, 0}, true, false
182 });
183 }
184
185 if (GBARegisterDISPCNTIsObjwinEnable(gbaDispcnt)) {
186 m_queue.append({
187 { LayerId::WINDOW, 2 },
188 !m_disabled.contains({ LayerId::WINDOW, 2 }),
189 {},
190 {}, {0, 0}, true, false
191 });
192
193 }
194
195 for (int priority = 0; priority < 4; ++priority) {
196 for (int sprite = 0; sprite < 128; ++sprite) {
197 ObjInfo info;
198 lookupObj(sprite, &info);
199
200 if (!info.enabled || info.priority != priority) {
201 continue;
202 }
203
204 QPointF offset(info.x, info.y);
205 QImage obj(compositeObj(info));
206 if (info.hflip || info.vflip) {
207 obj = obj.mirrored(info.hflip, info.vflip);
208 }
209 if (!info.xform.isIdentity()) {
210 offset += QPointF(obj.width(), obj.height()) / 2;
211 obj = obj.transformed(info.xform);
212 offset -= QPointF(obj.width() / 2, obj.height() / 2);
213 }
214 m_queue.append({
215 { LayerId::SPRITE, sprite },
216 !m_disabled.contains({ LayerId::SPRITE, sprite }),
217 QPixmap::fromImage(obj),
218 {}, offset, false, false
219 });
220 if (m_queue.back().image.hasAlpha()) {
221 m_queue.back().mask = QRegion(m_queue.back().image.mask());
222 } else {
223 m_queue.back().mask = QRegion(0, 0, m_queue.back().image.width(), m_queue.back().image.height());
224 }
225 }
226
227 for (int bg = 0; bg < 4; ++bg) {
228 if (!enabled[bg]) {
229 continue;
230 }
231 if (GBARegisterBGCNTGetPriority(io[(REG_BG0CNT >> 1) + bg]) != priority) {
232 continue;
233 }
234
235 QPointF offset;
236 if (mode == 0) {
237 offset.setX(-(io[(REG_BG0HOFS >> 1) + (bg << 1)] & 0x1FF));
238 offset.setY(-(io[(REG_BG0VOFS >> 1) + (bg << 1)] & 0x1FF));
239 };
240 m_queue.append({
241 { LayerId::BACKGROUND, bg },
242 !m_disabled.contains({ LayerId::BACKGROUND, bg }),
243 QPixmap::fromImage(compositeMap(bg, m_mapStatus[bg])),
244 {}, offset, true, false
245 });
246 if (m_queue.back().image.hasAlpha()) {
247 m_queue.back().mask = QRegion(m_queue.back().image.mask());
248 } else {
249 m_queue.back().mask = QRegion(0, 0, m_queue.back().image.width(), m_queue.back().image.height());
250 }
251 }
252 }
253 QImage backdropImage(QSize(GBA_VIDEO_HORIZONTAL_PIXELS, GBA_VIDEO_VERTICAL_PIXELS), QImage::Format_Mono);
254 backdropImage.fill(1);
255 backdropImage.setColorTable({backdrop, backdrop | 0xFF000000 });
256 m_queue.append({
257 { LayerId::BACKDROP },
258 !m_disabled.contains({ LayerId::BACKDROP }),
259 QPixmap::fromImage(backdropImage),
260 {}, {0, 0}, false, true
261 });
262 updateRendered();
263 }
264 invalidateQueue(QSize(GBA_VIDEO_HORIZONTAL_PIXELS, GBA_VIDEO_VERTICAL_PIXELS));
265}
266
267void FrameView::injectGBA() {
268 mVideoLogger* logger = m_vl->videoLogger;
269 GBA* gba = static_cast<GBA*>(m_vl->board);
270 gba->video.renderer->highlightBG[0] = false;
271 gba->video.renderer->highlightBG[1] = false;
272 gba->video.renderer->highlightBG[2] = false;
273 gba->video.renderer->highlightBG[3] = false;
274 for (int i = 0; i < 128; ++i) {
275 gba->video.renderer->highlightOBJ[i] = false;
276 }
277 QPalette palette;
278 gba->video.renderer->highlightColor = M_RGB8_TO_NATIVE(palette.color(QPalette::Highlight).rgb());
279 gba->video.renderer->highlightAmount = sin(m_glowFrame * M_PI / 30) * 48 + 64;
280 if (!m_overrideBackdrop.isValid()) {
281 QRgb backdrop = M_RGB5_TO_RGB8(gba->video.palette[0]) | 0xFF000000;
282 m_backdropPicker.setColor(backdrop);
283 }
284
285 m_vl->reset(m_vl);
286 for (const Layer& layer : m_queue) {
287 switch (layer.id.type) {
288 case LayerId::SPRITE:
289 if (!layer.enabled) {
290 mVideoLoggerInjectOAM(logger, layer.id.index << 2, 0x200);
291 }
292 if (layer.id == m_active) {
293 gba->video.renderer->highlightOBJ[layer.id.index] = true;
294 }
295 break;
296 case LayerId::BACKGROUND:
297 m_vl->enableVideoLayer(m_vl, layer.id.index, layer.enabled);
298 if (layer.id == m_active) {
299 gba->video.renderer->highlightBG[layer.id.index] = true;
300 }
301 break;
302 case LayerId::WINDOW:
303 m_vl->enableVideoLayer(m_vl, GBA_LAYER_WIN0 + layer.id.index, layer.enabled);
304 break;
305 }
306 }
307 if (m_overrideBackdrop.isValid()) {
308 mVideoLoggerInjectPalette(logger, 0, M_RGB8_TO_RGB5(m_overrideBackdrop.rgb()));
309 }
310}
311#endif
312
313#ifdef M_CORE_GB
314void FrameView::updateTilesGB(bool) {
315 if (m_ui.freeze->checkState() == Qt::Checked) {
316 return;
317 }
318 m_queue.clear();
319 {
320 CoreController::Interrupter interrupter(m_controller);
321 uint8_t* io = static_cast<GB*>(m_controller->thread()->core->board)->memory.io;
322 GBRegisterLCDC lcdc = io[GB_REG_LCDC];
323
324 for (int sprite = 0; sprite < 40; ++sprite) {
325 ObjInfo info;
326 lookupObj(sprite, &info);
327
328 if (!info.enabled) {
329 continue;
330 }
331
332 QPointF offset(info.x, info.y);
333 QImage obj(compositeObj(info));
334 if (info.hflip || info.vflip) {
335 obj = obj.mirrored(info.hflip, info.vflip);
336 }
337 m_queue.append({
338 { LayerId::SPRITE, sprite },
339 !m_disabled.contains({ LayerId::SPRITE, sprite }),
340 QPixmap::fromImage(obj),
341 {}, offset, false, false
342 });
343 if (m_queue.back().image.hasAlpha()) {
344 m_queue.back().mask = QRegion(m_queue.back().image.mask());
345 } else {
346 m_queue.back().mask = QRegion(0, 0, m_queue.back().image.width(), m_queue.back().image.height());
347 }
348 }
349
350 if (GBRegisterLCDCIsWindow(lcdc)) {
351 m_queue.append({
352 { LayerId::WINDOW },
353 !m_disabled.contains({ LayerId::WINDOW }),
354 {},
355 {}, {0, 0}, false, false
356 });
357 }
358
359 m_queue.append({
360 { LayerId::BACKGROUND },
361 !m_disabled.contains({ LayerId::BACKGROUND }),
362 {},
363 {}, {0, 0}, false, false
364 });
365
366 updateRendered();
367 }
368 invalidateQueue(m_controller->screenDimensions());
369}
370
371void FrameView::injectGB() {
372 mVideoLogger* logger = m_vl->videoLogger;
373 GB* gb = static_cast<GB*>(m_vl->board);
374 gb->video.renderer->highlightBG = false;
375 gb->video.renderer->highlightWIN = false;
376 for (int i = 0; i < 40; ++i) {
377 gb->video.renderer->highlightOBJ[i] = false;
378 }
379 QPalette palette;
380 gb->video.renderer->highlightColor = M_RGB8_TO_NATIVE(palette.color(QPalette::Highlight).rgb());
381 gb->video.renderer->highlightAmount = sin(m_glowFrame * M_PI / 30) * 48 + 64;
382
383 m_vl->reset(m_vl);
384 for (const Layer& layer : m_queue) {
385 switch (layer.id.type) {
386 case LayerId::SPRITE:
387 if (!layer.enabled) {
388 mVideoLoggerInjectOAM(logger, layer.id.index << 2, 0);
389 }
390 if (layer.id == m_active) {
391 gb->video.renderer->highlightOBJ[layer.id.index] = true;
392 }
393 break;
394 case LayerId::BACKGROUND:
395 m_vl->enableVideoLayer(m_vl, GB_LAYER_BACKGROUND, layer.enabled);
396 if (layer.id == m_active) {
397 gb->video.renderer->highlightBG = true;
398 }
399 break;
400 case LayerId::WINDOW:
401 m_vl->enableVideoLayer(m_vl, GB_LAYER_WINDOW, layer.enabled);
402 if (layer.id == m_active) {
403 gb->video.renderer->highlightWIN = true;
404 }
405 break;
406 }
407 }
408}
409#endif
410
411void FrameView::invalidateQueue(const QSize& dims) {
412 if (dims.isValid()) {
413 m_dims = dims;
414 }
415 bool blockSignals = m_ui.queue->blockSignals(true);
416 QMutexLocker locker(&m_mutex);
417 if (m_vl) {
418 mVideoLogger* logger = m_vl->videoLogger;
419 mVideoLoggerInjectionPoint(logger, LOGGER_INJECTION_FIRST_SCANLINE);
420 switch (m_controller->platform()) {
421#ifdef M_CORE_GBA
422 case PLATFORM_GBA:
423 injectGBA();
424 break;
425#endif
426#ifdef M_CORE_GB
427 case PLATFORM_GB:
428 injectGB();
429 break;
430#endif
431 }
432 if (m_ui.disableScanline->checkState() == Qt::Checked) {
433 mVideoLoggerIgnoreAfterInjection(logger, (1 << DIRTY_PALETTE) | (1 << DIRTY_OAM) | (1 << DIRTY_REGISTER));
434 } else {
435 mVideoLoggerIgnoreAfterInjection(logger, 0);
436 }
437 m_vl->runFrame(m_vl);
438 }
439
440 for (int i = 0; i < m_queue.count(); ++i) {
441 const Layer& layer = m_queue[i];
442 QListWidgetItem* item;
443 if (i >= m_ui.queue->count()) {
444 item = new QListWidgetItem;
445 m_ui.queue->addItem(item);
446 } else {
447 item = m_ui.queue->item(i);
448 }
449 item->setText(layer.id.readable());
450 item->setFlags(Qt::ItemIsSelectable | (layer.fixed ? Qt::NoItemFlags : Qt::ItemIsUserCheckable) | Qt::ItemIsEnabled);
451 item->setCheckState(layer.enabled ? Qt::Checked : Qt::Unchecked);
452 item->setData(Qt::UserRole, i);
453 item->setSelected(layer.id == m_active);
454 }
455
456 while (m_ui.queue->count() > m_queue.count()) {
457 delete m_ui.queue->takeItem(m_queue.count());
458 }
459 m_ui.queue->blockSignals(blockSignals);
460
461 QPixmap composited;
462 if (m_framebuffer.isNull()) {
463 updateRendered();
464 composited = m_rendered;
465 } else {
466 QImage framebuffer(m_framebuffer);
467 m_ui.exportButton->setEnabled(true);
468 if (framebuffer.size() != m_dims) {
469 framebuffer = framebuffer.copy({QPoint(), m_dims});
470 }
471 composited.convertFromImage(framebuffer);
472 }
473 m_composited = composited.scaled(m_dims * m_ui.magnification->value());
474 m_ui.compositedView->setPixmap(m_composited);
475}
476
477void FrameView::updateRendered() {
478 if (m_ui.freeze->checkState() == Qt::Checked) {
479 return;
480 }
481 m_rendered.convertFromImage(m_controller->getPixels());
482}
483
484bool FrameView::eventFilter(QObject*, QEvent* event) {
485 QPointF pos;
486 switch (event->type()) {
487 case QEvent::MouseButtonPress:
488 pos = static_cast<QMouseEvent*>(event)->localPos();
489 pos /= m_ui.magnification->value();
490 selectLayer(pos);
491 return true;
492 case QEvent::MouseButtonDblClick:
493 pos = static_cast<QMouseEvent*>(event)->localPos();
494 pos /= m_ui.magnification->value();
495 disableLayer(pos);
496 return true;
497 default:
498 break;
499 }
500 return false;
501}
502
503void FrameView::refreshVl() {
504 QMutexLocker locker(&m_mutex);
505 m_currentFrame = m_nextFrame;
506 m_nextFrame = VFileMemChunk(nullptr, 0);
507 if (m_currentFrame) {
508 m_controller->endVideoLog(false);
509 QMetaObject::invokeMethod(this, "newVl");
510 }
511 m_controller->endVideoLog();
512 m_controller->startVideoLog(m_nextFrame, false);
513}
514
515void FrameView::newVl() {
516 if (!m_glowTimer.isActive()) {
517 m_glowTimer.start();
518 }
519 QMutexLocker locker(&m_mutex);
520 if (!m_currentFrame) {
521 return;
522 }
523 if (m_vl) {
524 m_vl->deinit(m_vl);
525 }
526 m_vl = mCoreFindVF(m_currentFrame);
527 m_vl->init(m_vl);
528 m_vl->loadROM(m_vl, m_currentFrame);
529 m_currentFrame = nullptr;
530 mCoreInitConfig(m_vl, nullptr);
531 unsigned width, height;
532 m_vl->desiredVideoDimensions(m_vl, &width, &height);
533 m_framebuffer = QImage(width, height, QImage::Format_RGBX8888);
534 m_vl->setVideoBuffer(m_vl, reinterpret_cast<color_t*>(m_framebuffer.bits()), width);
535 m_vl->reset(m_vl);
536}
537
538void FrameView::frameCallback(FrameView* viewer, std::shared_ptr<bool> lock) {
539 if (!*lock) {
540 return;
541 }
542 CoreController::Interrupter interrupter(viewer->m_controller);
543 viewer->refreshVl();
544 viewer->m_controller->addFrameAction(std::bind(&FrameView::frameCallback, viewer, lock));
545}
546
547void FrameView::exportFrame() {
548 QString filename = GBAApp::app()->getSaveFileName(this, tr("Export frame"),
549 tr("Portable Network Graphics (*.png)"));
550 CoreController::Interrupter interrupter(m_controller);
551 m_framebuffer.save(filename, "PNG");
552}
553
554void FrameView::reset() {
555 m_disabled.clear();
556 for (Layer& layer : m_queue) {
557 layer.enabled = true;
558 }
559 m_overrideBackdrop = QColor();
560 invalidateQueue();
561}
562
563QString FrameView::LayerId::readable() const {
564 QString typeStr;
565 switch (type) {
566 case NONE:
567 return tr("None");
568 case BACKGROUND:
569 typeStr = tr("Background");
570 break;
571 case WINDOW:
572 typeStr = tr("Window");
573#ifdef M_CORE_GBA
574 if (index == 2) {
575 return tr("Objwin");
576 }
577#endif
578 break;
579 case SPRITE:
580 typeStr = tr("Sprite");
581 break;
582 case BACKDROP:
583 typeStr = tr("Backdrop");
584 break;
585 case FRAME:
586 typeStr = tr("Frame");
587 break;
588 }
589 if (index < 0) {
590 return typeStr;
591 }
592 return tr("%1 %2").arg(typeStr).arg(index);
593}