Panda3DS/src/panda_qt/main_window.cpp

#include "panda_qt/main_window.hpp"

#include <QDesktopServices>
#include <QFileDialog>
#include <QString>
#include <cmath>
#include <cstdio>
#include <fstream>

#include "cheats.hpp"
#include "input_mappings.hpp"
#include "services/dsp.hpp"

MainWindow::MainWindow(QApplication* app, QWidget* parent) : QMainWindow(parent), keyboardMappings(InputMappings::defaultKeyboardMappings()), screen(this) {
	setWindowTitle("Alber");
	// Enable drop events for loading ROMs
	setAcceptDrops(true);
	resize(800, 240 * 4);
	screen.show();

	appRunning = true;

	// Set our menu bar up
	menuBar = new QMenuBar(this);
	setMenuBar(menuBar);

	// Create menu bar menus
	auto fileMenu = menuBar->addMenu(tr("File"));
	auto emulationMenu = menuBar->addMenu(tr("Emulation"));
	auto toolsMenu = menuBar->addMenu(tr("Tools"));
	auto aboutMenu = menuBar->addMenu(tr("About"));

	// Create and bind actions for them
	auto loadGameAction = fileMenu->addAction(tr("Load game"));
	auto loadLuaAction = fileMenu->addAction(tr("Load Lua script"));
	auto openAppFolderAction = fileMenu->addAction(tr("Open Panda3DS folder"));

	connect(loadGameAction, &QAction::triggered, this, &MainWindow::selectROM);
	connect(loadLuaAction, &QAction::triggered, this, &MainWindow::selectLuaFile);
	connect(openAppFolderAction, &QAction::triggered, this, [this]() {
		QString path = QString::fromStdU16String(emu->getAppDataRoot().u16string());
		QDesktopServices::openUrl(QUrl::fromLocalFile(path));
	});

	auto pauseAction = emulationMenu->addAction(tr("Pause"));
	auto resumeAction = emulationMenu->addAction(tr("Resume"));
	auto resetAction = emulationMenu->addAction(tr("Reset"));
	auto configureAction = emulationMenu->addAction(tr("Configure"));
	connect(pauseAction, &QAction::triggered, this, [this]() { sendMessage(EmulatorMessage{.type = MessageType::Pause}); });
	connect(resumeAction, &QAction::triggered, this, [this]() { sendMessage(EmulatorMessage{.type = MessageType::Resume}); });
	connect(resetAction, &QAction::triggered, this, [this]() { sendMessage(EmulatorMessage{.type = MessageType::Reset}); });
	connect(configureAction, &QAction::triggered, this, [this]() { configWindow->show(); });

	auto dumpRomFSAction = toolsMenu->addAction(tr("Dump RomFS"));
	auto luaEditorAction = toolsMenu->addAction(tr("Open Lua Editor"));
	auto cheatsEditorAction = toolsMenu->addAction(tr("Open Cheats Editor"));
	auto patchWindowAction = toolsMenu->addAction(tr("Open Patch Window"));
	auto shaderEditorAction = toolsMenu->addAction(tr("Open Shader Editor"));
	auto dumpDspFirmware = toolsMenu->addAction(tr("Dump loaded DSP firmware"));

	connect(dumpRomFSAction, &QAction::triggered, this, &MainWindow::dumpRomFS);
	connect(luaEditorAction, &QAction::triggered, this, [this]() { luaEditor->show(); });
	connect(shaderEditorAction, &QAction::triggered, this, [this]() { shaderEditor->show(); });
	connect(cheatsEditorAction, &QAction::triggered, this, [this]() { cheatsEditor->show(); });
	connect(patchWindowAction, &QAction::triggered, this, [this]() { patchWindow->show(); });
	connect(dumpDspFirmware, &QAction::triggered, this, &MainWindow::dumpDspFirmware);

	auto aboutAction = aboutMenu->addAction(tr("About Panda3DS"));
	connect(aboutAction, &QAction::triggered, this, &MainWindow::showAboutMenu);

	emu = new Emulator();
	emu->setOutputSize(screen.surfaceWidth, screen.surfaceHeight);

	// Set up misc objects
	aboutWindow = new AboutWindow(nullptr);
	configWindow = new ConfigWindow(this);
	cheatsEditor = new CheatsWindow(emu, {}, this);
	patchWindow = new PatchWindow(this);
	luaEditor = new TextEditorWindow(this, "script.lua", "");
	shaderEditor = new ShaderEditorWindow(this, "shader.glsl", "");
	shaderEditor->setEnable(emu->getRenderer()->supportsShaderReload());

	auto args = QCoreApplication::arguments();
	if (args.size() > 1) {
		auto romPath = std::filesystem::current_path() / args.at(1).toStdU16String();
		if (!emu->loadROM(romPath)) {
			// For some reason just .c_str() doesn't show the proper path
			Helpers::warn("Failed to load ROM file: %s", romPath.string().c_str());
		}
	}

	// The emulator graphics context for the thread should be initialized in the emulator thread due to how GL contexts work
	emuThread = std::thread([this]() {
		const RendererType rendererType = emu->getConfig().rendererType;
		usingGL = (rendererType == RendererType::OpenGL || rendererType == RendererType::Software || rendererType == RendererType::Null);
		usingVk = (rendererType == RendererType::Vulkan);

		if (usingGL) {
			// Make GL context current for this thread, enable VSync
			GL::Context* glContext = screen.getGLContext();
			glContext->MakeCurrent();
			glContext->SetSwapInterval(emu->getConfig().vsyncEnabled ? 1 : 0);

			emu->initGraphicsContext(glContext);
		} else if (usingVk) {
			Helpers::panic("Vulkan on Qt is currently WIP, try the SDL frontend instead!");
		} else {
			Helpers::panic("Unsupported graphics backend for Qt frontend!");
		}

		// We have to initialize controllers on the same thread they'll be polled in
		initControllers();
		emuThreadMainLoop();
	});
}

void MainWindow::emuThreadMainLoop() {
	while (appRunning) {
		{
			std::unique_lock lock(messageQueueMutex);

			// Dispatch all messages in the message queue
			if (!messageQueue.empty()) {
				for (const auto& msg : messageQueue) {
					dispatchMessage(msg);
				}

				messageQueue.clear();
			}
		}

		emu->runFrame();
		pollControllers();

		if (emu->romType != ROMType::None) {
			emu->getServiceManager().getHID().updateInputs(emu->getTicks());
		}

		swapEmuBuffer();
	}

	// Unbind GL context if we're using GL, otherwise some setups seem to be unable to join this thread
	if (usingGL) {
		screen.getGLContext()->DoneCurrent();
	}
}

void MainWindow::swapEmuBuffer() {
	if (usingGL) {
		screen.getGLContext()->SwapBuffers();
	} else {
		Helpers::panic("[Qt] Don't know how to swap buffers for the current rendering backend :(");
	}
}

void MainWindow::selectROM() {
	auto path = QFileDialog::getOpenFileName(
		this, tr("Select 3DS ROM to load"), QString::fromStdU16String(emu->getConfig().defaultRomPath.u16string()),
		tr("Nintendo 3DS ROMs (*.3ds *.cci *.cxi *.app *.3dsx *.elf *.axf)")
	);

	if (!path.isEmpty()) {
		std::filesystem::path* p = new std::filesystem::path(path.toStdU16String());

		EmulatorMessage message{.type = MessageType::LoadROM};
		message.path.p = p;
		sendMessage(message);
	}
}

void MainWindow::selectLuaFile() {
	auto path = QFileDialog::getOpenFileName(this, tr("Select Lua script to load"), "", tr("Lua scripts (*.lua *.txt)"));

	if (!path.isEmpty()) {
		std::ifstream file(std::filesystem::path(path.toStdU16String()), std::ios::in);

		if (file.fail()) {
			printf("Failed to load selected lua file\n");
			return;
		}

		// Read whole file into an std::string string
		// Get file size, preallocate std::string to avoid furthermemory allocations
		std::string code;
		file.seekg(0, std::ios::end);
		code.resize(file.tellg());

		// Rewind and read the whole file
		file.seekg(0, std::ios::beg);
		file.read(&code[0], code.size());
		file.close();

		loadLuaScript(code);
		// Copy the Lua script to the Lua editor
		luaEditor->setText(code);
	}
}

// Cleanup when the main window closes
MainWindow::~MainWindow() {
	appRunning = false;  // Set our running atomic to false in order to make the emulator thread stop, and join it

	if (emuThread.joinable()) {
		emuThread.join();
	}

	delete emu;
	delete menuBar;
	delete aboutWindow;
	delete configWindow;
	delete cheatsEditor;
	delete luaEditor;
}

// Send a message to the emulator thread. Lock the mutex and just push back to the vector.
void MainWindow::sendMessage(const EmulatorMessage& message) {
	std::unique_lock lock(messageQueueMutex);
	messageQueue.push_back(message);
}

void MainWindow::dumpRomFS() {
	auto folder = QFileDialog::getExistingDirectory(
		this, tr("Select folder to dump RomFS files to"), "", QFileDialog::ShowDirsOnly | QFileDialog::DontResolveSymlinks
	);

	if (folder.isEmpty()) {
		return;
	}
	std::filesystem::path path(folder.toStdU16String());

	messageQueueMutex.lock();
	RomFS::DumpingResult res = emu->dumpRomFS(path);
	messageQueueMutex.unlock();

	switch (res) {
		case RomFS::DumpingResult::Success: break;  // Yay!
		case RomFS::DumpingResult::InvalidFormat: {
			QMessageBox messageBox(
				QMessageBox::Icon::Warning, tr("Invalid format for RomFS dumping"),
				tr("The currently loaded app is not in a format that supports RomFS")
			);

			QAbstractButton* button = messageBox.addButton(tr("OK"), QMessageBox::ButtonRole::YesRole);
			button->setIcon(QIcon(":/docs/img/rsob_icon.png"));
			messageBox.exec();
			break;
		}

		case RomFS::DumpingResult::NoRomFS:
			QMessageBox::warning(this, tr("No RomFS found"), tr("No RomFS partition was found in the loaded app"));
			break;
	}
}

void MainWindow::dumpDspFirmware() {
	auto file = QFileDialog::getSaveFileName(this, tr("Select file"), "", tr("DSP firmware file (*.cdc)"));

	if (file.isEmpty()) {
		return;
	}
	std::filesystem::path path(file.toStdU16String());

	messageQueueMutex.lock();
	auto res = emu->getServiceManager().getDSP().dumpComponent(path);
	messageQueueMutex.unlock();

	switch (res) {
		case DSPService::ComponentDumpResult::Success: break;
		case DSPService::ComponentDumpResult::NotLoaded: {
			QMessageBox messageBox(
				QMessageBox::Icon::Warning, tr("No DSP firmware loaded"),
				tr("The currently loaded app has not uploaded a firmware to the DSP")
			);

			QAbstractButton* button = messageBox.addButton(tr("OK"), QMessageBox::ButtonRole::YesRole);
			button->setIcon(QIcon(":/docs/img/rsob_icon.png"));
			messageBox.exec();
			break;
		}

		case DSPService::ComponentDumpResult::FileFailure: {
			QMessageBox messageBox(
				QMessageBox::Icon::Warning, tr("Failed to open output file"),
				tr("The currently loaded DSP firmware could not be written to the selected file. Please make sure you have permission to access this "
				   "file")
			);

			QAbstractButton* button = messageBox.addButton(tr("OK"), QMessageBox::ButtonRole::YesRole);
			button->setIcon(QIcon(":/docs/img/rstarstruck_icon.png"));
			messageBox.exec();
			break;
		}
	}
}

void MainWindow::showAboutMenu() {
	AboutWindow about(this);
	about.exec();
}

void MainWindow::dispatchMessage(const EmulatorMessage& message) {
	switch (message.type) {
		case MessageType::LoadROM:
			emu->loadROM(*message.path.p);
			// Clean up the allocated path
			delete message.path.p;
			break;

		case MessageType::LoadLuaScript:
			emu->getLua().loadString(*message.string.str);
			delete message.string.str;
			break;

		case MessageType::EditCheat: {
			u32 handle = message.cheat.c->handle;
			const std::vector<uint8_t>& cheat = message.cheat.c->cheat;
			const std::function<void(u32)>& callback = message.cheat.c->callback;
			bool isEditing = handle != Cheats::badCheatHandle;
			if (isEditing) {
				emu->getCheats().removeCheat(handle);
				u32 handle = emu->getCheats().addCheat(cheat.data(), cheat.size());
			} else {
				u32 handle = emu->getCheats().addCheat(cheat.data(), cheat.size());
				callback(handle);
			}
			delete message.cheat.c;
		} break;

		case MessageType::Pause: emu->pause(); break;
		case MessageType::Resume: emu->resume(); break;
		case MessageType::TogglePause: emu->togglePause(); break;
		case MessageType::Reset: emu->reset(Emulator::ReloadOption::Reload); break;
		case MessageType::PressKey: emu->getServiceManager().getHID().pressKey(message.key.key); break;
		case MessageType::ReleaseKey: emu->getServiceManager().getHID().releaseKey(message.key.key); break;

		// Track whether we're controlling the analog stick with our controller and update the CirclePad X/Y values in HID
		// Controllers are polled on the emulator thread, so this message type is only used when the circlepad is changed via keyboard input
		case MessageType::SetCirclePadX: {
			keyboardAnalogX = message.circlepad.value != 0;
			emu->getServiceManager().getHID().setCirclepadX(message.circlepad.value);
			break;
		}

		case MessageType::SetCirclePadY: {
			keyboardAnalogY = message.circlepad.value != 0;
			emu->getServiceManager().getHID().setCirclepadY(message.circlepad.value);
			break;
		}

		case MessageType::PressTouchscreen:
			emu->getServiceManager().getHID().setTouchScreenPress(message.touchscreen.x, message.touchscreen.y);
			break;
		case MessageType::ReleaseTouchscreen: emu->getServiceManager().getHID().releaseTouchScreen(); break;
	}
}

void MainWindow::keyPressEvent(QKeyEvent* event) {
	auto pressKey = [this](u32 key) {
		EmulatorMessage message{.type = MessageType::PressKey};
		message.key.key = key;
		sendMessage(message);
	};

	auto setCirclePad = [this](MessageType type, s16 value) {
		EmulatorMessage message{.type = type};
		message.circlepad.value = value;
		sendMessage(message);
	};

	u32 key = keyboardMappings.getMapping(event->key());
	if (key != HID::Keys::Null) {
		switch (key) {
			case HID::Keys::CirclePadUp: setCirclePad(MessageType::SetCirclePadY, 0x9C); break;
			case HID::Keys::CirclePadDown: setCirclePad(MessageType::SetCirclePadY, -0x9C); break;
			case HID::Keys::CirclePadLeft: setCirclePad(MessageType::SetCirclePadX, -0x9C); break;
			case HID::Keys::CirclePadRight: setCirclePad(MessageType::SetCirclePadX, 0x9C); break;

			default: pressKey(key); break;
		}
	} else {
		switch (event->key()) {
			case Qt::Key_F4: sendMessage(EmulatorMessage{.type = MessageType::TogglePause}); break;
			case Qt::Key_F5: sendMessage(EmulatorMessage{.type = MessageType::Reset}); break;
		}
	}
}

void MainWindow::keyReleaseEvent(QKeyEvent* event) {
	auto releaseKey = [this](u32 key) {
		EmulatorMessage message{.type = MessageType::ReleaseKey};
		message.key.key = key;
		sendMessage(message);
	};

	auto releaseCirclePad = [this](MessageType type) {
		EmulatorMessage message{.type = type};
		message.circlepad.value = 0;
		sendMessage(message);
	};

	u32 key = keyboardMappings.getMapping(event->key());
	if (key != HID::Keys::Null) {
		switch (key) {
			case HID::Keys::CirclePadUp: releaseCirclePad(MessageType::SetCirclePadY); break;
			case HID::Keys::CirclePadDown: releaseCirclePad(MessageType::SetCirclePadY); break;
			case HID::Keys::CirclePadLeft: releaseCirclePad(MessageType::SetCirclePadX); break;
			case HID::Keys::CirclePadRight: releaseCirclePad(MessageType::SetCirclePadX); break;

			default: releaseKey(key); break;
		}
	}
}

void MainWindow::mousePressEvent(QMouseEvent* event) {
	if (event->button() == Qt::MouseButton::LeftButton) {
		const QPointF clickPos = event->globalPosition();
		const QPointF widgetPos = screen.mapFromGlobal(clickPos);

		// Press is inside the screen area
		if (widgetPos.x() >= 0 && widgetPos.x() < screen.width() && widgetPos.y() >= 0 && widgetPos.y() < screen.height()) {
			// Go from widget positions to [0, 400) for x and [0, 480) for y
			uint x = (uint)std::round(widgetPos.x() / screen.width() * 400.f);
			uint y = (uint)std::round(widgetPos.y() / screen.height() * 480.f);

			// Check if touch falls in the touch screen area
			if (y >= 240 && y <= 480 && x >= 40 && x < 40 + 320) {
				// Convert to 3DS coordinates
				u16 x_converted = static_cast<u16>(x) - 40;
				u16 y_converted = static_cast<u16>(y) - 240;

				EmulatorMessage message{.type = MessageType::PressTouchscreen};
				message.touchscreen.x = x_converted;
				message.touchscreen.y = y_converted;
				sendMessage(message);
			} else {
				sendMessage(EmulatorMessage{.type = MessageType::ReleaseTouchscreen});
			}
		}
	}
}

void MainWindow::mouseReleaseEvent(QMouseEvent* event) {
	if (event->button() == Qt::MouseButton::LeftButton) {
		sendMessage(EmulatorMessage{.type = MessageType::ReleaseTouchscreen});
	}
}

void MainWindow::loadLuaScript(const std::string& code) {
	EmulatorMessage message{.type = MessageType::LoadLuaScript};

	// Make a copy of the code on the heap to send via the message queue
	message.string.str = new std::string(code);
	sendMessage(message);
}

void MainWindow::reloadShader(const std::string& shader) {
	EmulatorMessage message{.type = MessageType::ReloadUbershader};

	// Make a copy of the code on the heap to send via the message queue
	message.string.str = new std::string(shader);
	sendMessage(message);
}

void MainWindow::editCheat(u32 handle, const std::vector<uint8_t>& cheat, const std::function<void(u32)>& callback) {
	EmulatorMessage message{.type = MessageType::EditCheat};

	CheatMessage* c = new CheatMessage();
	c->handle = handle;
	c->cheat = cheat;
	c->callback = callback;

	message.cheat.c = c;
	sendMessage(message);
}

void MainWindow::initControllers() {
	// Make SDL use consistent positional button mapping
	SDL_SetHint(SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS, "0");
	if (SDL_Init(SDL_INIT_JOYSTICK | SDL_INIT_GAMECONTROLLER | SDL_INIT_HAPTIC) < 0) {
		Helpers::warn("Failed to initialize SDL2 GameController: %s", SDL_GetError());
		return;
	}

	if (SDL_WasInit(SDL_INIT_GAMECONTROLLER)) {
		gameController = SDL_GameControllerOpen(0);

		if (gameController != nullptr) {
			SDL_Joystick* stick = SDL_GameControllerGetJoystick(gameController);
			gameControllerID = SDL_JoystickInstanceID(stick);
		}
	}
}

void MainWindow::pollControllers() {
	// Update circlepad if a controller is plugged in
	if (gameController != nullptr) {
		HIDService& hid = emu->getServiceManager().getHID();
		const s16 stickX = SDL_GameControllerGetAxis(gameController, SDL_CONTROLLER_AXIS_LEFTX);
		const s16 stickY = SDL_GameControllerGetAxis(gameController, SDL_CONTROLLER_AXIS_LEFTY);
		constexpr s16 deadzone = 3276;
		constexpr s16 maxValue = 0x9C;
		constexpr s16 div = 0x8000 / maxValue;

		// Avoid overriding the keyboard's circlepad input
		if (std::abs(stickX) < deadzone && !keyboardAnalogX) {
			hid.setCirclepadX(0);
		} else {
			hid.setCirclepadX(stickX / div);
		}

		if (std::abs(stickY) < deadzone && !keyboardAnalogY) {
			hid.setCirclepadY(0);
		} else {
			hid.setCirclepadY(-(stickY / div));
		}
	}

	SDL_Event event;
	while (SDL_PollEvent(&event)) {
		HIDService& hid = emu->getServiceManager().getHID();
		using namespace HID;

		switch (event.type) {
			case SDL_CONTROLLERDEVICEADDED:
				if (gameController == nullptr) {
					gameController = SDL_GameControllerOpen(event.cdevice.which);
					gameControllerID = event.cdevice.which;
				}
				break;

			case SDL_CONTROLLERDEVICEREMOVED:
				if (event.cdevice.which == gameControllerID) {
					SDL_GameControllerClose(gameController);
					gameController = nullptr;
					gameControllerID = 0;
				}
				break;

			case SDL_CONTROLLERBUTTONUP:
			case SDL_CONTROLLERBUTTONDOWN: {
				if (emu->romType == ROMType::None) break;
				u32 key = 0;

				switch (event.cbutton.button) {
					case SDL_CONTROLLER_BUTTON_A: key = Keys::B; break;
					case SDL_CONTROLLER_BUTTON_B: key = Keys::A; break;
					case SDL_CONTROLLER_BUTTON_X: key = Keys::Y; break;
					case SDL_CONTROLLER_BUTTON_Y: key = Keys::X; break;
					case SDL_CONTROLLER_BUTTON_LEFTSHOULDER: key = Keys::L; break;
					case SDL_CONTROLLER_BUTTON_RIGHTSHOULDER: key = Keys::R; break;
					case SDL_CONTROLLER_BUTTON_DPAD_LEFT: key = Keys::Left; break;
					case SDL_CONTROLLER_BUTTON_DPAD_RIGHT: key = Keys::Right; break;
					case SDL_CONTROLLER_BUTTON_DPAD_UP: key = Keys::Up; break;
					case SDL_CONTROLLER_BUTTON_DPAD_DOWN: key = Keys::Down; break;
					case SDL_CONTROLLER_BUTTON_BACK: key = Keys::Select; break;
					case SDL_CONTROLLER_BUTTON_START: key = Keys::Start; break;
				}

				if (key != 0) {
					if (event.cbutton.state == SDL_PRESSED) {
						hid.pressKey(key);
					} else {
						hid.releaseKey(key);
					}
				}
				break;
			}
		}
	}
}