// 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 #ifdef HAS_OPENGL #include #include #endif #if !defined(WIN32) #include #endif #include #include "common/assert.h" #include "common/microprofile.h" #include "common/scm_rev.h" #include "common/scope_exit.h" #include "common/settings.h" #include "core/core.h" #include "core/frontend/framebuffer_layout.h" #include "core/hle/kernel/k_process.h" #include "input_common/keyboard.h" #include "input_common/main.h" #include "input_common/mouse/mouse_input.h" #include "video_core/renderer_base.h" #include "video_core/video_core.h" #include "yuzu/bootmanager.h" #include "yuzu/main.h" EmuThread::EmuThread() = default; EmuThread::~EmuThread() = default; void EmuThread::run() { std::string name = "yuzu:EmuControlThread"; MicroProfileOnThreadCreate(name.c_str()); Common::SetCurrentThreadName(name.c_str()); auto& system = Core::System::GetInstance(); system.RegisterHostThread(); auto& gpu = system.GPU(); // Main process has been loaded. Make the context current to this thread and begin GPU and CPU // execution. gpu.Start(); gpu.ObtainContext(); emit LoadProgress(VideoCore::LoadCallbackStage::Prepare, 0, 0); system.Renderer().ReadRasterizer()->LoadDiskResources( system.CurrentProcess()->GetTitleID(), 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); gpu.ReleaseContext(); // 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(); } running_guard = true; Core::System::ResultStatus result = system.Run(); if (result != Core::System::ResultStatus::Success) { running_guard = false; this->SetRunning(false); emit ErrorThrown(result, system.GetStatusDetails()); } running_wait.Wait(); result = system.Pause(); if (result != Core::System::ResultStatus::Success) { running_guard = false; this->SetRunning(false); emit ErrorThrown(result, system.GetStatusDetails()); } running_guard = false; if (!stop_run) { was_active = true; emit DebugModeEntered(); } } else if (exec_step) { UNIMPLEMENTED(); } 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 } #ifdef HAS_OPENGL class OpenGLSharedContext : public Core::Frontend::GraphicsContext { public: /// Create the original context that should be shared from explicit OpenGLSharedContext(QSurface* surface) : surface(surface) { QSurfaceFormat format; format.setVersion(4, 6); format.setProfile(QSurfaceFormat::CompatibilityProfile); format.setOption(QSurfaceFormat::FormatOption::DeprecatedFunctions); 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.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() { 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() { return context.get(); } const 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; }; #endif class DummyContext : public Core::Frontend::GraphicsContext {}; class RenderWidget : public QWidget { public: explicit RenderWidget(GRenderWindow* parent) : QWidget(parent), render_window(parent) { setAttribute(Qt::WA_NativeWindow); setAttribute(Qt::WA_PaintOnScreen); } virtual ~RenderWidget() = default; QPaintEngine* paintEngine() const override { return nullptr; } private: GRenderWindow* render_window; }; class OpenGLRenderWidget : public RenderWidget { public: explicit OpenGLRenderWidget(GRenderWindow* parent) : RenderWidget(parent) { windowHandle()->setSurfaceType(QWindow::OpenGLSurface); } void SetContext(std::unique_ptr&& context_) { context = std::move(context_); } private: std::unique_ptr context; }; class VulkanRenderWidget : public RenderWidget { public: explicit VulkanRenderWidget(GRenderWindow* parent) : RenderWidget(parent) { windowHandle()->setSurfaceType(QWindow::VulkanSurface); } }; static Core::Frontend::WindowSystemType GetWindowSystemType() { // Determine WSI type based on Qt platform. QString platform_name = QGuiApplication::platformName(); if (platform_name == QStringLiteral("windows")) return Core::Frontend::WindowSystemType::Windows; else if (platform_name == QStringLiteral("xcb")) return Core::Frontend::WindowSystemType::X11; else if (platform_name == QStringLiteral("wayland")) return Core::Frontend::WindowSystemType::Wayland; LOG_CRITICAL(Frontend, "Unknown Qt platform!"); return Core::Frontend::WindowSystemType::Windows; } static Core::Frontend::EmuWindow::WindowSystemInfo GetWindowSystemInfo(QWindow* window) { Core::Frontend::EmuWindow::WindowSystemInfo wsi; wsi.type = GetWindowSystemType(); // Our Win32 Qt external doesn't have the private API. #if defined(WIN32) || defined(__APPLE__) wsi.render_surface = window ? reinterpret_cast(window->winId()) : nullptr; #else QPlatformNativeInterface* pni = QGuiApplication::platformNativeInterface(); wsi.display_connection = pni->nativeResourceForWindow("display", window); if (wsi.type == Core::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(GMainWindow* parent, EmuThread* emu_thread_, std::shared_ptr input_subsystem_) : QWidget(parent), emu_thread(emu_thread_), input_subsystem{std::move(input_subsystem_)} { setWindowTitle(QStringLiteral("yuzu %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); input_subsystem->Initialize(); this->setMouseTracking(true); connect(this, &GRenderWindow::FirstFrameDisplayed, parent, &GMainWindow::OnLoadComplete); connect(this, &GRenderWindow::ExecuteProgramSignal, parent, &GMainWindow::OnExecuteProgram, Qt::QueuedConnection); } void GRenderWindow::ExecuteProgram(std::size_t program_index) { emit ExecuteProgramSignal(program_index); } GRenderWindow::~GRenderWindow() { input_subsystem->Shutdown(); } void GRenderWindow::OnFrameDisplayed() { if (!first_frame) { first_frame = true; emit FirstFrameDisplayed(); } } bool GRenderWindow::IsShown() const { return !isMinimized(); } // 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 = this->width() * pixel_ratio; const u32 height = 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) { if (!event->isAutoRepeat()) { input_subsystem->GetKeyboard()->PressKey(event->key()); } } void GRenderWindow::keyReleaseEvent(QKeyEvent* event) { if (!event->isAutoRepeat()) { input_subsystem->GetKeyboard()->ReleaseKey(event->key()); } } MouseInput::MouseButton GRenderWindow::QtButtonToMouseButton(Qt::MouseButton button) { switch (button) { case Qt::LeftButton: return MouseInput::MouseButton::Left; case Qt::RightButton: return MouseInput::MouseButton::Right; case Qt::MiddleButton: return MouseInput::MouseButton::Wheel; case Qt::BackButton: return MouseInput::MouseButton::Backward; case Qt::ForwardButton: return MouseInput::MouseButton::Forward; case Qt::TaskButton: return MouseInput::MouseButton::Task; default: return MouseInput::MouseButton::Extra; } } void GRenderWindow::mousePressEvent(QMouseEvent* event) { // Touch input is handled in TouchBeginEvent if (event->source() == Qt::MouseEventSynthesizedBySystem) { return; } auto pos = event->pos(); const auto [x, y] = ScaleTouch(pos); const auto button = QtButtonToMouseButton(event->button()); input_subsystem->GetMouse()->PressButton(x, y, button); if (event->button() == Qt::LeftButton) { this->TouchPressed(x, y, 0); } emit MouseActivity(); } void GRenderWindow::mouseMoveEvent(QMouseEvent* event) { // Touch input is handled in TouchUpdateEvent if (event->source() == Qt::MouseEventSynthesizedBySystem) { return; } auto pos = event->pos(); const auto [x, y] = ScaleTouch(pos); const int center_x = width() / 2; const int center_y = height() / 2; input_subsystem->GetMouse()->MouseMove(x, y, center_x, center_y); this->TouchMoved(x, y, 0); if (Settings::values.mouse_panning) { QCursor::setPos(mapToGlobal({center_x, center_y})); } emit MouseActivity(); } void GRenderWindow::mouseReleaseEvent(QMouseEvent* event) { // Touch input is handled in TouchEndEvent if (event->source() == Qt::MouseEventSynthesizedBySystem) { return; } const auto button = QtButtonToMouseButton(event->button()); input_subsystem->GetMouse()->ReleaseButton(button); if (event->button() == Qt::LeftButton) { this->TouchReleased(0); } } void GRenderWindow::TouchBeginEvent(const QTouchEvent* event) { QList touch_points = event->touchPoints(); for (const auto& touch_point : touch_points) { if (!TouchUpdate(touch_point)) { TouchStart(touch_point); } } } void GRenderWindow::TouchUpdateEvent(const QTouchEvent* event) { QList touch_points = event->touchPoints(); for (const auto& touch_point : touch_points) { if (!TouchUpdate(touch_point)) { TouchStart(touch_point); } } // Release all inactive points for (std::size_t id = 0; id < touch_ids.size(); ++id) { if (!TouchExist(touch_ids[id], touch_points)) { touch_ids[id] = 0; this->TouchReleased(id + 1); } } } void GRenderWindow::TouchEndEvent() { for (std::size_t id = 0; id < touch_ids.size(); ++id) { if (touch_ids[id] != 0) { touch_ids[id] = 0; this->TouchReleased(id + 1); } } } bool GRenderWindow::TouchStart(const QTouchEvent::TouchPoint& touch_point) { for (std::size_t id = 0; id < touch_ids.size(); ++id) { if (touch_ids[id] == 0) { touch_ids[id] = touch_point.id() + 1; const auto [x, y] = ScaleTouch(touch_point.pos()); this->TouchPressed(x, y, id + 1); return true; } } return false; } bool GRenderWindow::TouchUpdate(const QTouchEvent::TouchPoint& touch_point) { for (std::size_t id = 0; id < touch_ids.size(); ++id) { if (touch_ids[id] == static_cast(touch_point.id() + 1)) { const auto [x, y] = ScaleTouch(touch_point.pos()); this->TouchMoved(x, y, id + 1); return true; } } return false; } bool GRenderWindow::TouchExist(std::size_t id, const QList& touch_points) const { return std::any_of(touch_points.begin(), touch_points.end(), [id](const auto& point) { return id == static_cast(point.id() + 1); }); } bool GRenderWindow::event(QEvent* event) { if (event->type() == QEvent::TouchBegin) { TouchBeginEvent(static_cast(event)); return true; } else if (event->type() == QEvent::TouchUpdate) { TouchUpdateEvent(static_cast(event)); return true; } else if (event->type() == QEvent::TouchEnd || event->type() == QEvent::TouchCancel) { TouchEndEvent(); return true; } return QWidget::event(event); } void GRenderWindow::focusOutEvent(QFocusEvent* event) { QWidget::focusOutEvent(event); input_subsystem->GetKeyboard()->ReleaseAllKeys(); } void GRenderWindow::resizeEvent(QResizeEvent* event) { QWidget::resizeEvent(event); OnFramebufferSizeChanged(); } std::unique_ptr GRenderWindow::CreateSharedContext() const { #ifdef HAS_OPENGL if (Settings::values.renderer_backend.GetValue() == Settings::RendererBackend::OpenGL) { 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()); } #endif return std::make_unique(); } bool GRenderWindow::InitRenderTarget() { ReleaseRenderTarget(); first_frame = false; switch (Settings::values.renderer_backend.GetValue()) { case Settings::RendererBackend::OpenGL: if (!InitializeOpenGL()) { return false; } break; case Settings::RendererBackend::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(Layout::ScreenUndocked::Width, Layout::ScreenUndocked::Height); layout()->addWidget(child_widget); // Reset minimum required size to avoid resizing issues on the main window after restarting. setMinimumSize(1, 1); resize(Layout::ScreenUndocked::Width, Layout::ScreenUndocked::Height); OnMinimalClientAreaChangeRequest(GetActiveConfig().min_client_area_size); OnFramebufferSizeChanged(); BackupGeometry(); if (Settings::values.renderer_backend.GetValue() == Settings::RendererBackend::OpenGL) { if (!LoadOpenGL()) { return false; } } 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) { auto& renderer = Core::System::GetInstance().Renderer(); if (res_scale == 0) { res_scale = VideoCore::GetResolutionScaleFactor(renderer); } const Layout::FramebufferLayout layout{Layout::FrameLayoutFromResolutionScale(res_scale)}; screenshot_image = QImage(QSize(layout.width, layout.height), QImage::Format_RGB32); renderer.RequestScreenshot( screenshot_image.bits(), [=, this] { 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); } bool GRenderWindow::IsLoadingComplete() const { return first_frame; } void GRenderWindow::OnMinimalClientAreaChangeRequest(std::pair minimal_size) { setMinimumSize(minimal_size.first, minimal_size.second); } bool GRenderWindow::InitializeOpenGL() { #ifdef HAS_OPENGL // TODO: One of these flags might be interesting: WA_OpaquePaintEvent, WA_NoBackground, // WA_DontShowOnScreen, WA_DeleteOnClose auto child = new OpenGLRenderWidget(this); 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; #else QMessageBox::warning(this, tr("OpenGL not available!"), tr("yuzu has not been compiled with OpenGL support.")); return false; #endif } bool GRenderWindow::InitializeVulkan() { auto child = new VulkanRenderWidget(this); child_widget = child; child_widget->windowHandle()->create(); main_context = std::make_unique(); return true; } bool GRenderWindow::LoadOpenGL() { auto context = CreateSharedContext(); auto scope = context->Acquire(); if (!gladLoadGL()) { QMessageBox::warning( this, tr("Error while initializing OpenGL!"), tr("Your GPU may not support OpenGL, or you do not have the latest graphics driver.")); return false; } const QString renderer = QString::fromUtf8(reinterpret_cast(glGetString(GL_RENDERER))); if (!GLAD_GL_VERSION_4_6) { LOG_ERROR(Frontend, "GPU does not support OpenGL 4.6: {}", renderer.toStdString()); QMessageBox::warning(this, tr("Error while initializing OpenGL 4.6!"), tr("Your GPU may not support OpenGL 4.6, or you do not have the " "latest graphics driver.

GL Renderer:
%1") .arg(renderer)); return false; } QStringList unsupported_gl_extensions = GetUnsupportedGLExtensions(); if (!unsupported_gl_extensions.empty()) { QMessageBox::warning( this, tr("Error while initializing OpenGL!"), tr("Your GPU may not support one or more required OpenGL extensions. Please ensure you " "have the latest graphics driver.

GL Renderer:
%1

Unsupported " "extensions:
%2") .arg(renderer) .arg(unsupported_gl_extensions.join(QStringLiteral("
")))); return false; } return true; } QStringList GRenderWindow::GetUnsupportedGLExtensions() const { QStringList unsupported_ext; // Extensions required to support some texture formats. if (!GLAD_GL_EXT_texture_compression_s3tc) { unsupported_ext.append(QStringLiteral("EXT_texture_compression_s3tc")); } if (!GLAD_GL_ARB_texture_compression_rgtc) { unsupported_ext.append(QStringLiteral("ARB_texture_compression_rgtc")); } if (!unsupported_ext.empty()) { LOG_ERROR(Frontend, "GPU does not support all required extensions: {}", glGetString(GL_RENDERER)); } for (const QString& ext : unsupported_ext) { LOG_ERROR(Frontend, "Unsupported GL extension: {}", ext.toStdString()); } return unsupported_ext; } 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); // windowHandle() is not initialized until the Window is shown, so we connect it here. connect(windowHandle(), &QWindow::screenChanged, this, &GRenderWindow::OnFramebufferSizeChanged, Qt::UniqueConnection); } bool GRenderWindow::eventFilter(QObject* object, QEvent* event) { if (event->type() == QEvent::HoverMove) { if (Settings::values.mouse_panning) { auto* hover_event = static_cast(event); mouseMoveEvent(hover_event); return false; } emit MouseActivity(); } return false; }