suyu/src/yuzu/bootmanager.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

281 lines
8 KiB
C++
Raw Normal View History

chore: make yuzu REUSE compliant [REUSE] is a specification that aims at making file copyright information consistent, so that it can be both human and machine readable. It basically requires that all files have a header containing copyright and licensing information. When this isn't possible, like when dealing with binary assets, generated files or embedded third-party dependencies, it is permitted to insert copyright information in the `.reuse/dep5` file. Oh, and it also requires that all the licenses used in the project are present in the `LICENSES` folder, that's why the diff is so huge. This can be done automatically with `reuse download --all`. The `reuse` tool also contains a handy subcommand that analyzes the project and tells whether or not the project is (still) compliant, `reuse lint`. Following REUSE has a few advantages over the current approach: - Copyright information is easy to access for users / downstream - Files like `dist/license.md` do not need to exist anymore, as `.reuse/dep5` is used instead - `reuse lint` makes it easy to ensure that copyright information of files like binary assets / images is always accurate and up to date To add copyright information of files that didn't have it I looked up who committed what and when, for each file. As yuzu contributors do not have to sign a CLA or similar I couldn't assume that copyright ownership was of the "yuzu Emulator Project", so I used the name and/or email of the commit author instead. [REUSE]: https://reuse.software Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 02:06:02 +02:00
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <condition_variable>
#include <cstddef>
#include <memory>
#include <mutex>
#include <utility>
#include <vector>
#include <QByteArray>
#include <QImage>
#include <QObject>
#include <QPoint>
#include <QString>
#include <QStringList>
2015-09-11 06:23:00 +02:00
#include <QThread>
#include <QTimer>
2019-01-12 05:06:34 +01:00
#include <QWidget>
#include <qglobal.h>
#include <qnamespace.h>
#include <qobjectdefs.h>
#include "common/common_types.h"
#include "common/logging/log.h"
2022-11-21 17:31:18 +01:00
#include "common/polyfill_thread.h"
#include "common/thread.h"
#include "core/frontend/emu_window.h"
2014-04-01 04:26:50 +02:00
class GMainWindow;
2022-06-19 06:34:28 +02:00
class QCamera;
class QCameraImageCapture;
class QCloseEvent;
class QFocusEvent;
2014-04-01 04:26:50 +02:00
class QKeyEvent;
class QMouseEvent;
class QObject;
class QResizeEvent;
class QShowEvent;
class QTouchEvent;
class QWheelEvent;
2014-04-01 04:26:50 +02:00
namespace Core {
class System;
} // namespace Core
namespace InputCommon {
class InputSubsystem;
2021-02-24 03:39:02 +01:00
enum class MouseButton;
} // namespace InputCommon
2021-02-24 03:39:02 +01:00
2021-11-22 05:37:50 +01:00
namespace InputCommon::TasInput {
enum class TasState;
} // namespace InputCommon::TasInput
namespace VideoCore {
enum class LoadCallbackStage;
} // namespace VideoCore
class EmuThread final : public QThread {
2014-04-01 04:26:50 +02:00
Q_OBJECT
public:
2022-12-17 20:34:03 +01:00
explicit EmuThread(Core::System& system);
~EmuThread() override;
2014-04-01 04:26:50 +02:00
/**
* Start emulation (on new thread)
* @warning Only call when not running!
*/
void run() override;
2014-04-01 04:26:50 +02:00
/**
2022-12-17 20:34:03 +01:00
* Sets whether the emulation thread should run or not
* @param should_run Boolean value, set the emulation thread to running if true
2014-04-01 04:26:50 +02:00
*/
2022-12-17 20:34:03 +01:00
void SetRunning(bool should_run) {
// TODO: Prevent other threads from modifying the state until we finish.
{
// Notify the running thread to change state.
std::unique_lock run_lk{m_should_run_mutex};
m_should_run = should_run;
m_should_run_cv.notify_one();
}
// Wait until paused, if pausing.
if (!should_run) {
2023-06-20 17:41:38 +02:00
m_stopped.Wait();
}
}
2014-04-01 04:26:50 +02:00
2014-04-04 03:24:07 +02:00
/**
* Check if the emulation thread is running or not
* @return True if the emulation thread is running, otherwise false
*/
bool IsRunning() const {
2023-06-20 17:41:38 +02:00
return m_should_run;
}
/**
* Requests for the emulation thread to immediately stop running
*/
2022-07-18 09:41:29 +02:00
void ForceStop() {
LOG_WARNING(Frontend, "Force stopping EmuThread");
2022-12-17 20:34:03 +01:00
m_stop_source.request_stop();
}
2014-04-01 04:26:50 +02:00
2023-01-10 18:46:01 +01:00
private:
void EmulationPaused(std::unique_lock<std::mutex>& lk);
void EmulationResumed(std::unique_lock<std::mutex>& lk);
2014-04-01 04:26:50 +02:00
private:
2022-12-17 20:34:03 +01:00
Core::System& m_system;
std::stop_source m_stop_source;
std::mutex m_should_run_mutex;
std::condition_variable_any m_should_run_cv;
2023-06-20 17:41:38 +02:00
Common::Event m_stopped;
2022-12-17 20:34:03 +01:00
bool m_should_run{true};
2014-04-01 04:26:50 +02:00
signals:
/**
* Emitted when the CPU has halted execution
*
* @warning When connecting to this signal from other threads, make sure to specify either
* Qt::QueuedConnection (invoke slot within the destination object's message thread) or even
* Qt::BlockingQueuedConnection (additionally block source thread until slot returns)
2014-04-01 04:26:50 +02:00
*/
void DebugModeEntered();
/**
* Emitted right before the CPU continues execution
*
* @warning When connecting to this signal from other threads, make sure to specify either
* Qt::QueuedConnection (invoke slot within the destination object's message thread) or even
* Qt::BlockingQueuedConnection (additionally block source thread until slot returns)
*/
void DebugModeLeft();
void LoadProgress(VideoCore::LoadCallbackStage stage, std::size_t value, std::size_t total);
2014-04-01 04:26:50 +02:00
};
class GRenderWindow : public QWidget, public Core::Frontend::EmuWindow {
Q_OBJECT
2014-04-01 04:26:50 +02:00
public:
explicit GRenderWindow(GMainWindow* parent, EmuThread* emu_thread_,
std::shared_ptr<InputCommon::InputSubsystem> input_subsystem_,
Core::System& system_);
~GRenderWindow() override;
2014-04-01 04:26:50 +02:00
// EmuWindow implementation.
void OnFrameDisplayed() override;
bool IsShown() const override;
2019-01-12 05:06:34 +01:00
std::unique_ptr<Core::Frontend::GraphicsContext> CreateSharedContext() const override;
2014-04-01 04:26:50 +02:00
void BackupGeometry();
void RestoreGeometry();
2022-05-27 01:57:35 +02:00
void restoreGeometry(const QByteArray& geometry_); // overridden
QByteArray saveGeometry(); // overridden
2014-04-01 04:26:50 +02:00
qreal windowPixelRatio() const;
std::pair<u32, u32> ScaleTouch(const QPointF& pos) const;
void closeEvent(QCloseEvent* event) override;
void leaveEvent(QEvent* event) override;
void resizeEvent(QResizeEvent* event) override;
2024-01-16 00:26:53 +01:00
/// Converts a Qt keyboard key into NativeKeyboard key
static int QtKeyToSwitchKey(Qt::Key qt_keys);
/// Converts a Qt modifier keys into NativeKeyboard modifier keys
static int QtModifierToSwitchModifier(Qt::KeyboardModifiers qt_modifiers);
void keyPressEvent(QKeyEvent* event) override;
void keyReleaseEvent(QKeyEvent* event) override;
2021-02-24 03:39:02 +01:00
/// Converts a Qt mouse button into MouseInput mouse button
static InputCommon::MouseButton QtButtonToMouseButton(Qt::MouseButton button);
2021-02-24 03:39:02 +01:00
void mousePressEvent(QMouseEvent* event) override;
void mouseMoveEvent(QMouseEvent* event) override;
void mouseReleaseEvent(QMouseEvent* event) override;
2021-11-14 21:09:29 +01:00
void wheelEvent(QWheelEvent* event) override;
2022-06-19 06:34:28 +02:00
void InitializeCamera();
void FinalizeCamera();
bool event(QEvent* event) override;
void focusOutEvent(QFocusEvent* event) override;
bool InitRenderTarget();
/// Destroy the previous run's child_widget which should also destroy the child_window
void ReleaseRenderTarget();
bool IsLoadingComplete() const;
void CaptureScreenshot(const QString& screenshot_path);
/**
* Instructs the window to re-launch the application using the specified program_index.
* @param program_index Specifies the index within the application of the program to launch.
*/
void ExecuteProgram(std::size_t program_index);
/// Instructs the window to exit the application.
void Exit();
public slots:
2022-05-27 01:57:35 +02:00
void OnEmulationStarting(EmuThread* emu_thread_);
void OnEmulationStopping();
2015-09-04 15:55:48 +02:00
void OnFramebufferSizeChanged();
signals:
/// Emitted when the window is closed
void Closed();
void FirstFrameDisplayed();
void ExecuteProgramSignal(std::size_t program_index);
void ExitSignal();
void MouseActivity();
void TasPlaybackStateChanged();
2014-04-01 04:26:50 +02:00
private:
void TouchBeginEvent(const QTouchEvent* event);
void TouchUpdateEvent(const QTouchEvent* event);
void TouchEndEvent();
void ConstrainMouse();
2022-06-19 06:34:28 +02:00
void RequestCameraCapture();
void OnCameraCapture(int requestId, const QImage& img);
void OnMinimalClientAreaChangeRequest(std::pair<u32, u32> minimal_size) override;
bool InitializeOpenGL();
bool InitializeVulkan();
2022-11-28 02:37:37 +01:00
void InitializeNull();
bool LoadOpenGL();
QStringList GetUnsupportedGLExtensions() const;
2014-04-01 04:26:50 +02:00
EmuThread* emu_thread;
std::shared_ptr<InputCommon::InputSubsystem> input_subsystem;
// Main context that will be shared with all other contexts that are requested.
// If this is used in a shared context setting, then this should not be used directly, but
// should instead be shared from
std::shared_ptr<Core::Frontend::GraphicsContext> main_context;
2015-09-04 15:55:48 +02:00
/// Temporary storage of the screenshot taken
QImage screenshot_image;
QByteArray geometry;
QWidget* child_widget = nullptr;
bool first_frame = false;
2021-11-22 05:37:50 +01:00
InputCommon::TasInput::TasState last_tas_state;
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) && YUZU_USE_QT_MULTIMEDIA
bool is_virtual_camera;
int pending_camera_snapshots;
std::vector<u32> camera_data;
std::unique_ptr<QCamera> camera;
std::unique_ptr<QCameraImageCapture> camera_capture;
2022-06-19 06:34:28 +02:00
std::unique_ptr<QTimer> camera_timer;
#endif
2022-06-19 06:34:28 +02:00
QTimer mouse_constrain_timer;
Core::System& system;
2015-09-04 15:55:48 +02:00
protected:
void showEvent(QShowEvent* event) override;
bool eventFilter(QObject* object, QEvent* event) override;
2014-04-01 04:26:50 +02:00
};