// Copyright 2014 Citra Emulator Project // Licensed under GPLv2 or any later version // Refer to the license.txt file included. #include #include #include #include #include #include #include #include #include #include "citra_qt/bootmanager.h" #include "citra_qt/main.h" #include "common/microprofile.h" #include "common/scm_rev.h" #include "common/settings.h" #include "core/3ds.h" #include "core/core.h" #include "input_common/keyboard.h" #include "input_common/main.h" #include "input_common/motion_emu.h" #include "video_core/renderer_base.h" #include "video_core/video_core.h" #if defined(__APPLE__) #include "citra_qt/applesurfacehelper.h" #endif #if !defined(WIN32) #include #endif EmuThread::EmuThread(Frontend::GraphicsContext& core_context) : core_context(core_context) {} EmuThread::~EmuThread() = default; static GMainWindow* GetMainWindow() { const auto widgets = qApp->topLevelWidgets(); for (QWidget* w : widgets) { if (GMainWindow* main = qobject_cast(w)) { return main; } } return nullptr; } void EmuThread::run() { MicroProfileOnThreadCreate("EmuThread"); const auto scope = core_context.Acquire(); emit LoadProgress(VideoCore::LoadCallbackStage::Prepare, 0, 0); Core::System& system = Core::System::GetInstance(); system.Renderer().Rasterizer()->LoadDiskResources( stop_run, [this](VideoCore::LoadCallbackStage stage, std::size_t value, std::size_t total) { emit LoadProgress(stage, value, total); }); emit LoadProgress(VideoCore::LoadCallbackStage::Complete, 0, 0); emit HideLoadingScreen(); core_context.MakeCurrent(); if (system.frame_limiter.IsFrameAdvancing()) { // Usually the loading screen is hidden after the first frame is drawn. In this case // we hide it immediately as we need to wait for user input to start the emulation. emit HideLoadingScreen(); system.frame_limiter.WaitOnce(); } // Holds whether the cpu was running during the last iteration, // so that the DebugModeLeft signal can be emitted before the // next execution step. bool was_active = false; while (!stop_run) { if (running) { if (!was_active) emit DebugModeLeft(); const Core::System::ResultStatus result = system.RunLoop(); if (result == Core::System::ResultStatus::ShutdownRequested) { // Notify frontend we shutdown emit ErrorThrown(result, ""); // End emulation execution break; } if (result != Core::System::ResultStatus::Success) { this->SetRunning(false); emit ErrorThrown(result, Core::System::GetInstance().GetStatusDetails()); } was_active = running || exec_step; if (!was_active && !stop_run) emit DebugModeEntered(); } else if (exec_step) { if (!was_active) emit DebugModeLeft(); exec_step = false; [[maybe_unused]] const Core::System::ResultStatus result = system.SingleStep(); emit DebugModeEntered(); yieldCurrentThread(); was_active = false; } else { std::unique_lock lock{running_mutex}; running_cv.wait(lock, [this] { return IsRunning() || exec_step || stop_run; }); } } // Shutdown the core emulation system.Shutdown(); #if MICROPROFILE_ENABLED MicroProfileOnThreadExit(); #endif } class OpenGLSharedContext : public Frontend::GraphicsContext { public: /// Create the original context that should be shared from explicit OpenGLSharedContext(QSurface* surface) : surface(surface) { QSurfaceFormat format; format.setVersion(4, 4); format.setProfile(QSurfaceFormat::CoreProfile); if (Settings::values.renderer_debug) { format.setOption(QSurfaceFormat::FormatOption::DebugContext); } // TODO: expose a setting for buffer value (ie default/single/double/triple) format.setSwapBehavior(QSurfaceFormat::DefaultSwapBehavior); format.setSwapInterval(0); context = std::make_unique(); context->setFormat(format); if (!context->create()) { LOG_ERROR(Frontend, "Unable to create main openGL context"); } } /// Create the shared contexts for rendering and presentation explicit OpenGLSharedContext(QOpenGLContext* share_context, QSurface* main_surface = nullptr) { // disable vsync for any shared contexts auto format = share_context->format(); format.setSwapInterval(main_surface ? Settings::values.use_vsync_new.GetValue() : 0); context = std::make_unique(); context->setShareContext(share_context); context->setFormat(format); if (!context->create()) { LOG_ERROR(Frontend, "Unable to create shared openGL context"); } if (!main_surface) { offscreen_surface = std::make_unique(nullptr); offscreen_surface->setFormat(format); offscreen_surface->create(); surface = offscreen_surface.get(); } else { surface = main_surface; } } ~OpenGLSharedContext() { context->doneCurrent(); } void SwapBuffers() override { context->swapBuffers(surface); } void MakeCurrent() override { // We can't track the current state of the underlying context in this wrapper class because // Qt may make the underlying context not current for one reason or another. In particular, // the WebBrowser uses GL, so it seems to conflict if we aren't careful. // Instead of always just making the context current (which does not have any caching to // check if the underlying context is already current) we can check for the current context // in the thread local data by calling `currentContext()` and checking if its ours. if (QOpenGLContext::currentContext() != context.get()) { context->makeCurrent(surface); } } void DoneCurrent() override { context->doneCurrent(); } QOpenGLContext* GetShareContext() const { return context.get(); } private: // Avoid using Qt parent system here since we might move the QObjects to new threads // As a note, this means we should avoid using slots/signals with the objects too std::unique_ptr context; std::unique_ptr offscreen_surface{}; QSurface* surface; }; class DummyContext : public Frontend::GraphicsContext {}; class RenderWidget : public QWidget { public: RenderWidget(GRenderWindow* parent) : QWidget(parent), render_window(parent) { setAttribute(Qt::WA_NativeWindow); setAttribute(Qt::WA_PaintOnScreen); } virtual ~RenderWidget() = default; virtual void Present() {} void paintEvent(QPaintEvent* event) override { Present(); update(); } void resizeEvent(QResizeEvent* ev) override { render_window->resize(ev->size()); render_window->OnFramebufferSizeChanged(); } void keyPressEvent(QKeyEvent* event) override { InputCommon::GetKeyboard()->PressKey(event->key()); } void keyReleaseEvent(QKeyEvent* event) override { InputCommon::GetKeyboard()->ReleaseKey(event->key()); } void mousePressEvent(QMouseEvent* event) override { if (event->source() == Qt::MouseEventSynthesizedBySystem) return; // touch input is handled in TouchBeginEvent const auto pos{event->pos()}; if (event->button() == Qt::LeftButton) { const auto [x, y] = render_window->ScaleTouch(pos); render_window->TouchPressed(x, y); } else if (event->button() == Qt::RightButton) { InputCommon::GetMotionEmu()->BeginTilt(pos.x(), pos.y()); } } void mouseMoveEvent(QMouseEvent* event) override { if (event->source() == Qt::MouseEventSynthesizedBySystem) return; // touch input is handled in TouchUpdateEvent const auto pos{event->pos()}; const auto [x, y] = render_window->ScaleTouch(pos); render_window->TouchMoved(x, y); InputCommon::GetMotionEmu()->Tilt(pos.x(), pos.y()); } void mouseReleaseEvent(QMouseEvent* event) override { if (event->source() == Qt::MouseEventSynthesizedBySystem) return; // touch input is handled in TouchEndEvent if (event->button() == Qt::LeftButton) render_window->TouchReleased(); else if (event->button() == Qt::RightButton) InputCommon::GetMotionEmu()->EndTilt(); } std::pair GetSize() const { return std::make_pair(width(), height()); } QPaintEngine* paintEngine() const override { return nullptr; } private: GRenderWindow* render_window; }; class OpenGLRenderWidget : public RenderWidget { public: explicit OpenGLRenderWidget(GRenderWindow* parent, bool is_secondary) : RenderWidget(parent), is_secondary(is_secondary) { windowHandle()->setSurfaceType(QWindow::OpenGLSurface); } void SetContext(std::unique_ptr&& context_) { context = std::move(context_); } void Present() override { if (!isVisible()) { return; } if (!Core::System::GetInstance().IsPoweredOn()) { return; } context->MakeCurrent(); const auto f = context->GetShareContext()->extraFunctions(); f->glBindFramebuffer(GL_DRAW_FRAMEBUFFER, 0); VideoCore::g_renderer->TryPresent(100, is_secondary); context->SwapBuffers(); f->glFinish(); } private: std::unique_ptr context{}; bool is_secondary; }; class VulkanRenderWidget : public RenderWidget { public: explicit VulkanRenderWidget(GRenderWindow* parent, bool is_secondary) : RenderWidget(parent), is_secondary(is_secondary) { windowHandle()->setSurfaceType(QWindow::VulkanSurface); } void Present() override { if (!isVisible()) { return; } if (!Core::System::GetInstance().IsPoweredOn()) { return; } VideoCore::g_renderer->TryPresent(100, is_secondary); } private: bool is_secondary; }; static Frontend::WindowSystemType GetWindowSystemType() { // Determine WSI type based on Qt platform. QString platform_name = QGuiApplication::platformName(); if (platform_name == QStringLiteral("windows")) return Frontend::WindowSystemType::Windows; else if (platform_name == QStringLiteral("xcb")) return Frontend::WindowSystemType::X11; else if (platform_name == QStringLiteral("wayland")) return Frontend::WindowSystemType::Wayland; else if (platform_name == QStringLiteral("cocoa")) return Frontend::WindowSystemType::MacOS; LOG_CRITICAL(Frontend, "Unknown Qt platform!"); return Frontend::WindowSystemType::Windows; } static Frontend::EmuWindow::WindowSystemInfo GetWindowSystemInfo(QWindow* window) { Frontend::EmuWindow::WindowSystemInfo wsi; wsi.type = GetWindowSystemType(); // Our Win32 Qt external doesn't have the private API. #if defined(WIN32) wsi.render_surface = window ? reinterpret_cast(window->winId()) : nullptr; #elif defined(__APPLE__) wsi.render_surface = window ? AppleSurfaceHelper::GetSurfaceLayer(reinterpret_cast(window->winId())) : nullptr; #else QPlatformNativeInterface* pni = QGuiApplication::platformNativeInterface(); wsi.display_connection = pni->nativeResourceForWindow("display", window); if (wsi.type == Frontend::WindowSystemType::Wayland) wsi.render_surface = window ? pni->nativeResourceForWindow("surface", window) : nullptr; else wsi.render_surface = window ? reinterpret_cast(window->winId()) : nullptr; #endif wsi.render_surface_scale = window ? static_cast(window->devicePixelRatio()) : 1.0f; return wsi; } GRenderWindow::GRenderWindow(QWidget* parent_, EmuThread* emu_thread, bool is_secondary_) : QWidget(parent_), EmuWindow(is_secondary_), emu_thread(emu_thread) { setWindowTitle(QStringLiteral("Citra %1 | %2-%3") .arg(QString::fromUtf8(Common::g_build_name), QString::fromUtf8(Common::g_scm_branch), QString::fromUtf8(Common::g_scm_desc))); setAttribute(Qt::WA_AcceptTouchEvents); auto layout = new QHBoxLayout(this); layout->setContentsMargins(0, 0, 0, 0); setLayout(layout); this->setMouseTracking(true); GMainWindow* parent = GetMainWindow(); connect(this, &GRenderWindow::FirstFrameDisplayed, parent, &GMainWindow::OnLoadComplete); } GRenderWindow::~GRenderWindow() = default; void GRenderWindow::MakeCurrent() { main_context->MakeCurrent(); } void GRenderWindow::DoneCurrent() { main_context->DoneCurrent(); } void GRenderWindow::PollEvents() { if (!first_frame) { first_frame = true; emit FirstFrameDisplayed(); } } // On Qt 5.0+, this correctly gets the size of the framebuffer (pixels). // // Older versions get the window size (density independent pixels), // and hence, do not support DPI scaling ("retina" displays). // The result will be a viewport that is smaller than the extent of the window. void GRenderWindow::OnFramebufferSizeChanged() { // Screen changes potentially incur a change in screen DPI, hence we should update the // framebuffer size const qreal pixel_ratio = windowPixelRatio(); const u32 width = static_cast(this->width() * pixel_ratio); const u32 height = static_cast(this->height() * pixel_ratio); UpdateCurrentFramebufferLayout(width, height); } void GRenderWindow::BackupGeometry() { geometry = QWidget::saveGeometry(); } void GRenderWindow::RestoreGeometry() { // We don't want to back up the geometry here (obviously) QWidget::restoreGeometry(geometry); } void GRenderWindow::restoreGeometry(const QByteArray& geometry) { // Make sure users of this class don't need to deal with backing up the geometry themselves QWidget::restoreGeometry(geometry); BackupGeometry(); } QByteArray GRenderWindow::saveGeometry() { // If we are a top-level widget, store the current geometry // otherwise, store the last backup if (parent() == nullptr) { return QWidget::saveGeometry(); } return geometry; } qreal GRenderWindow::windowPixelRatio() const { return devicePixelRatioF(); } std::pair GRenderWindow::ScaleTouch(const QPointF pos) const { const qreal pixel_ratio = windowPixelRatio(); return {static_cast(std::max(std::round(pos.x() * pixel_ratio), qreal{0.0})), static_cast(std::max(std::round(pos.y() * pixel_ratio), qreal{0.0}))}; } void GRenderWindow::closeEvent(QCloseEvent* event) { emit Closed(); QWidget::closeEvent(event); } void GRenderWindow::keyPressEvent(QKeyEvent* event) { InputCommon::GetKeyboard()->PressKey(event->key()); } void GRenderWindow::keyReleaseEvent(QKeyEvent* event) { InputCommon::GetKeyboard()->ReleaseKey(event->key()); } void GRenderWindow::mousePressEvent(QMouseEvent* event) { if (event->source() == Qt::MouseEventSynthesizedBySystem) return; // touch input is handled in TouchBeginEvent auto pos = event->pos(); if (event->button() == Qt::LeftButton) { const auto [x, y] = ScaleTouch(pos); this->TouchPressed(x, y); } else if (event->button() == Qt::RightButton) { InputCommon::GetMotionEmu()->BeginTilt(pos.x(), pos.y()); } emit MouseActivity(); } void GRenderWindow::mouseMoveEvent(QMouseEvent* event) { if (event->source() == Qt::MouseEventSynthesizedBySystem) return; // touch input is handled in TouchUpdateEvent auto pos = event->pos(); const auto [x, y] = ScaleTouch(pos); this->TouchMoved(x, y); InputCommon::GetMotionEmu()->Tilt(pos.x(), pos.y()); emit MouseActivity(); } void GRenderWindow::mouseReleaseEvent(QMouseEvent* event) { if (event->source() == Qt::MouseEventSynthesizedBySystem) return; // touch input is handled in TouchEndEvent if (event->button() == Qt::LeftButton) this->TouchReleased(); else if (event->button() == Qt::RightButton) InputCommon::GetMotionEmu()->EndTilt(); emit MouseActivity(); } void GRenderWindow::TouchBeginEvent(const QTouchEvent* event) { // TouchBegin always has exactly one touch point, so take the .first() const auto [x, y] = ScaleTouch(event->touchPoints().first().pos()); this->TouchPressed(x, y); } void GRenderWindow::TouchUpdateEvent(const QTouchEvent* event) { QPointF pos; int active_points = 0; // average all active touch points for (const auto& tp : event->touchPoints()) { if (tp.state() & (Qt::TouchPointPressed | Qt::TouchPointMoved | Qt::TouchPointStationary)) { active_points++; pos += tp.pos(); } } pos /= active_points; const auto [x, y] = ScaleTouch(pos); this->TouchMoved(x, y); } void GRenderWindow::TouchEndEvent() { this->TouchReleased(); } bool GRenderWindow::event(QEvent* event) { switch (event->type()) { case QEvent::TouchBegin: TouchBeginEvent(static_cast(event)); return true; case QEvent::TouchUpdate: TouchUpdateEvent(static_cast(event)); return true; case QEvent::TouchEnd: case QEvent::TouchCancel: TouchEndEvent(); return true; default: break; } return QWidget::event(event); } void GRenderWindow::focusOutEvent(QFocusEvent* event) { QWidget::focusOutEvent(event); InputCommon::GetKeyboard()->ReleaseAllKeys(); has_focus = false; } void GRenderWindow::focusInEvent(QFocusEvent* event) { QWidget::focusInEvent(event); has_focus = true; } void GRenderWindow::resizeEvent(QResizeEvent* event) { QWidget::resizeEvent(event); OnFramebufferSizeChanged(); } std::unique_ptr GRenderWindow::CreateSharedContext() const { const Settings::GraphicsAPI graphics_api = Settings::values.graphics_api.GetValue(); if (graphics_api == Settings::GraphicsAPI::OpenGL || graphics_api == Settings::GraphicsAPI::OpenGLES) { auto c = static_cast(main_context.get()); // Bind the shared contexts to the main surface in case the backend wants to take over // presentation return std::make_unique(c->GetShareContext(), child_widget->windowHandle()); } return std::make_unique(); } bool GRenderWindow::InitRenderTarget() { ReleaseRenderTarget(); { // Create a dummy render widget so that Qt // places the render window at the correct position. const RenderWidget dummy_widget{this}; } first_frame = false; const Settings::GraphicsAPI graphics_api = Settings::values.graphics_api.GetValue(); switch (graphics_api) { case Settings::GraphicsAPI::OpenGL: case Settings::GraphicsAPI::OpenGLES: if (!InitializeOpenGL()) { return false; } break; case Settings::GraphicsAPI::Vulkan: if (!InitializeVulkan()) { return false; } break; } // Update the Window System information with the new render target window_info = GetWindowSystemInfo(child_widget->windowHandle()); child_widget->resize(Core::kScreenTopWidth, Core::kScreenTopHeight + Core::kScreenBottomHeight); layout()->addWidget(child_widget); // Reset minimum required size to avoid resizing issues on the main window after restarting. setMinimumSize(1, 1); resize(Core::kScreenTopWidth, Core::kScreenTopHeight + Core::kScreenBottomHeight); OnMinimalClientAreaChangeRequest(GetActiveConfig().min_client_area_size); OnFramebufferSizeChanged(); BackupGeometry(); return true; } void GRenderWindow::ReleaseRenderTarget() { if (child_widget) { layout()->removeWidget(child_widget); child_widget->deleteLater(); child_widget = nullptr; } main_context.reset(); } void GRenderWindow::CaptureScreenshot(u32 res_scale, const QString& screenshot_path) { if (res_scale == 0) { res_scale = VideoCore::GetResolutionScaleFactor(); } const auto layout{Layout::FrameLayoutFromResolutionScale(res_scale, is_secondary)}; screenshot_image = QImage(QSize(layout.width, layout.height), QImage::Format_RGB32); VideoCore::g_renderer->RequestScreenshot( screenshot_image.bits(), [this, screenshot_path] { const std::string std_screenshot_path = screenshot_path.toStdString(); if (screenshot_image.mirrored(false, true).save(screenshot_path)) { LOG_INFO(Frontend, "Screenshot saved to \"{}\"", std_screenshot_path); } else { LOG_ERROR(Frontend, "Failed to save screenshot to \"{}\"", std_screenshot_path); } }, layout); } void GRenderWindow::OnMinimalClientAreaChangeRequest(std::pair minimal_size) { setMinimumSize(minimal_size.first, minimal_size.second); } bool GRenderWindow::InitializeOpenGL() { // TODO: One of these flags might be interesting: WA_OpaquePaintEvent, WA_NoBackground, // WA_DontShowOnScreen, WA_DeleteOnClose auto child = new OpenGLRenderWidget(this, is_secondary); child_widget = child; child_widget->windowHandle()->create(); auto context = std::make_shared(child->windowHandle()); main_context = context; child->SetContext( std::make_unique(context->GetShareContext(), child->windowHandle())); return true; } bool GRenderWindow::InitializeVulkan() { auto child = new VulkanRenderWidget(this, is_secondary); child_widget = child; child_widget->windowHandle()->create(); main_context = std::make_unique(); return true; } void GRenderWindow::OnEmulationStarting(EmuThread* emu_thread) { this->emu_thread = emu_thread; } void GRenderWindow::OnEmulationStopping() { emu_thread = nullptr; } void GRenderWindow::showEvent(QShowEvent* event) { QWidget::showEvent(event); }