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 00:06:02 +00:00
|
|
|
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2015-01-04 17:36:57 +00:00
|
|
|
|
2016-12-11 11:53:18 +00:00
|
|
|
#pragma once
|
|
|
|
|
2014-10-12 16:14:57 +00:00
|
|
|
#include <atomic>
|
2015-05-16 17:56:00 +00:00
|
|
|
#include <condition_variable>
|
2020-08-29 04:44:27 +00:00
|
|
|
#include <memory>
|
2015-05-16 17:56:00 +00:00
|
|
|
#include <mutex>
|
2020-03-25 04:57:36 +00:00
|
|
|
|
2018-08-31 06:16:16 +00:00
|
|
|
#include <QImage>
|
2022-05-12 14:03:37 +00:00
|
|
|
#include <QStringList>
|
2015-09-11 04:23:00 +00:00
|
|
|
#include <QThread>
|
2021-01-03 04:04:50 +00:00
|
|
|
#include <QTouchEvent>
|
2019-01-12 04:06:34 +00:00
|
|
|
#include <QWidget>
|
2020-03-25 04:57:36 +00:00
|
|
|
|
2022-11-21 16:31:18 +00:00
|
|
|
#include "common/polyfill_thread.h"
|
2020-01-21 19:40:53 +00:00
|
|
|
#include "common/thread.h"
|
2016-12-23 13:37:40 +00:00
|
|
|
#include "core/frontend/emu_window.h"
|
2014-04-01 02:26:50 +00:00
|
|
|
|
2020-02-21 17:40:23 +00:00
|
|
|
class GRenderWindow;
|
2020-03-25 02:58:49 +00:00
|
|
|
class GMainWindow;
|
2022-06-19 04:34:28 +00:00
|
|
|
class QCamera;
|
|
|
|
class QCameraImageCapture;
|
2014-04-01 02:26:50 +00:00
|
|
|
class QKeyEvent;
|
|
|
|
|
2021-10-14 22:16:45 +00:00
|
|
|
namespace Core {
|
|
|
|
enum class SystemResultStatus : u32;
|
|
|
|
class System;
|
|
|
|
} // namespace Core
|
|
|
|
|
2020-08-27 19:16:47 +00:00
|
|
|
namespace InputCommon {
|
|
|
|
class InputSubsystem;
|
2021-02-24 02:39:02 +00:00
|
|
|
enum class MouseButton;
|
2021-09-21 00:39:08 +00:00
|
|
|
} // namespace InputCommon
|
2021-02-24 02:39:02 +00:00
|
|
|
|
2021-11-22 04:37:50 +00:00
|
|
|
namespace InputCommon::TasInput {
|
|
|
|
enum class TasState;
|
|
|
|
} // namespace InputCommon::TasInput
|
|
|
|
|
2019-01-21 19:38:23 +00:00
|
|
|
namespace VideoCore {
|
|
|
|
enum class LoadCallbackStage;
|
2021-09-03 01:40:55 +00:00
|
|
|
class RendererBase;
|
|
|
|
} // namespace VideoCore
|
2019-01-21 19:38:23 +00:00
|
|
|
|
2019-05-29 06:05:06 +00:00
|
|
|
class EmuThread final : public QThread {
|
2014-04-01 02:26:50 +00:00
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
public:
|
2022-12-17 19:34:03 +00:00
|
|
|
explicit EmuThread(Core::System& system);
|
2019-05-29 06:05:06 +00:00
|
|
|
~EmuThread() override;
|
2014-04-01 02:26:50 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Start emulation (on new thread)
|
|
|
|
* @warning Only call when not running!
|
|
|
|
*/
|
2014-10-26 04:56:13 +00:00
|
|
|
void run() override;
|
2014-04-01 02:26:50 +00:00
|
|
|
|
|
|
|
/**
|
2022-12-17 19:34:03 +00: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 02:26:50 +00:00
|
|
|
*/
|
2022-12-17 19:34:03 +00: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) {
|
|
|
|
m_is_running.wait(true);
|
2020-02-25 02:04:12 +00:00
|
|
|
}
|
2015-05-16 17:56:00 +00:00
|
|
|
}
|
2014-04-01 02:26:50 +00:00
|
|
|
|
2014-04-04 01:24:07 +00:00
|
|
|
/**
|
2015-04-28 23:03:01 +00:00
|
|
|
* Check if the emulation thread is running or not
|
|
|
|
* @return True if the emulation thread is running, otherwise false
|
2015-04-17 03:31:14 +00:00
|
|
|
*/
|
2018-01-17 23:34:58 +00:00
|
|
|
bool IsRunning() const {
|
2022-12-24 02:44:53 +00:00
|
|
|
return m_is_running.load() || m_should_run;
|
2016-09-18 00:38:01 +00:00
|
|
|
}
|
2015-04-17 03:31:14 +00:00
|
|
|
|
|
|
|
/**
|
2022-12-13 02:38:20 +00:00
|
|
|
* Requests for the emulation thread to immediately stop running
|
2015-04-17 03:31:14 +00:00
|
|
|
*/
|
2022-07-18 07:41:29 +00:00
|
|
|
void ForceStop() {
|
|
|
|
LOG_WARNING(Frontend, "Force stopping EmuThread");
|
2022-12-17 19:34:03 +00:00
|
|
|
m_stop_source.request_stop();
|
2018-01-17 23:34:58 +00:00
|
|
|
}
|
2014-04-01 02:26:50 +00:00
|
|
|
|
2023-01-10 17:46:01 +00:00
|
|
|
private:
|
|
|
|
void EmulationPaused(std::unique_lock<std::mutex>& lk);
|
|
|
|
void EmulationResumed(std::unique_lock<std::mutex>& lk);
|
|
|
|
|
2014-04-01 02:26:50 +00:00
|
|
|
private:
|
2022-12-17 19:34:03 +00: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;
|
|
|
|
std::atomic<bool> m_is_running{false};
|
|
|
|
bool m_should_run{true};
|
2014-04-01 02:26:50 +00:00
|
|
|
|
|
|
|
signals:
|
|
|
|
/**
|
2015-01-07 11:14:23 +00:00
|
|
|
* Emitted when the CPU has halted execution
|
2014-10-12 16:14:57 +00:00
|
|
|
*
|
2016-09-18 00:38:01 +00:00
|
|
|
* @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 02:26:50 +00:00
|
|
|
*/
|
2015-01-07 11:14:23 +00:00
|
|
|
void DebugModeEntered();
|
2015-05-25 18:34:09 +00:00
|
|
|
|
2015-01-07 11:14:23 +00:00
|
|
|
/**
|
|
|
|
* Emitted right before the CPU continues execution
|
|
|
|
*
|
2016-09-18 00:38:01 +00:00
|
|
|
* @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)
|
2015-01-07 11:14:23 +00:00
|
|
|
*/
|
|
|
|
void DebugModeLeft();
|
2017-03-08 21:28:30 +00:00
|
|
|
|
2019-01-21 19:38:23 +00:00
|
|
|
void LoadProgress(VideoCore::LoadCallbackStage stage, std::size_t value, std::size_t total);
|
2014-04-01 02:26:50 +00:00
|
|
|
};
|
|
|
|
|
2018-08-12 00:20:19 +00:00
|
|
|
class GRenderWindow : public QWidget, public Core::Frontend::EmuWindow {
|
2014-08-24 14:47:00 +00:00
|
|
|
Q_OBJECT
|
|
|
|
|
2014-04-01 02:26:50 +00:00
|
|
|
public:
|
2020-08-27 19:16:47 +00:00
|
|
|
explicit GRenderWindow(GMainWindow* parent, EmuThread* emu_thread_,
|
2021-09-03 01:40:55 +00:00
|
|
|
std::shared_ptr<InputCommon::InputSubsystem> input_subsystem_,
|
|
|
|
Core::System& system_);
|
2018-08-06 17:12:32 +00:00
|
|
|
~GRenderWindow() override;
|
2014-04-01 02:26:50 +00:00
|
|
|
|
2020-02-17 20:53:21 +00:00
|
|
|
// EmuWindow implementation.
|
Overhaul EmuWindow::PollEvents to fix yuzu-cmd calling SDL_PollEvents off main thread
EmuWindow::PollEvents was called from the GPU thread (or the CPU thread
in sync-GPU mode) when swapping buffers. It had three implementations:
- In GRenderWindow, it didn't actually poll events, just set a flag and
emit a signal to indicate that a frame was displayed.
- In EmuWindow_SDL2_Hide, it did nothing.
- In EmuWindow_SDL2, it did call SDL_PollEvents, but this is wrong
because SDL_PollEvents is supposed to be called on the thread that set
up video - in this case, the main thread, which was sleeping in a
busyloop (regardless of whether sync-GPU was enabled). On macOS this
causes a crash.
To fix this:
- Rename EmuWindow::PollEvents to OnFrameDisplayed, and give it a
default implementation that does nothing.
- In EmuWindow_SDL2, do not override OnFrameDisplayed, but instead have
the main thread call SDL_WaitEvent in a loop.
2020-11-22 21:05:18 +00:00
|
|
|
void OnFrameDisplayed() override;
|
2020-01-21 19:40:53 +00:00
|
|
|
bool IsShown() const override;
|
2019-01-12 04:06:34 +00:00
|
|
|
std::unique_ptr<Core::Frontend::GraphicsContext> CreateSharedContext() const override;
|
2014-04-01 02:26:50 +00:00
|
|
|
|
|
|
|
void BackupGeometry();
|
|
|
|
void RestoreGeometry();
|
2022-05-26 23:57:35 +00:00
|
|
|
void restoreGeometry(const QByteArray& geometry_); // overridden
|
|
|
|
QByteArray saveGeometry(); // overridden
|
2014-04-01 02:26:50 +00:00
|
|
|
|
2020-02-17 20:53:21 +00:00
|
|
|
qreal windowPixelRatio() const;
|
2015-09-10 21:42:45 +00:00
|
|
|
|
2015-09-05 10:29:44 +00:00
|
|
|
void closeEvent(QCloseEvent* event) override;
|
2020-02-17 20:53:21 +00:00
|
|
|
|
|
|
|
void resizeEvent(QResizeEvent* event) override;
|
|
|
|
|
2021-11-14 05:25:45 +00:00
|
|
|
/// Converts a Qt keybard key into NativeKeyboard key
|
|
|
|
static int QtKeyToSwitchKey(Qt::Key qt_keys);
|
|
|
|
|
|
|
|
/// Converts a Qt modifier keys into NativeKeyboard modifier keys
|
2021-11-19 16:56:52 +00:00
|
|
|
static int QtModifierToSwitchModifier(Qt::KeyboardModifiers qt_modifiers);
|
2021-11-14 05:25:45 +00:00
|
|
|
|
2020-02-17 20:53:21 +00:00
|
|
|
void keyPressEvent(QKeyEvent* event) override;
|
|
|
|
void keyReleaseEvent(QKeyEvent* event) override;
|
|
|
|
|
2021-02-24 02:39:02 +00:00
|
|
|
/// Converts a Qt mouse button into MouseInput mouse button
|
2021-09-21 00:39:08 +00:00
|
|
|
static InputCommon::MouseButton QtButtonToMouseButton(Qt::MouseButton button);
|
2021-02-24 02:39:02 +00:00
|
|
|
|
2020-02-17 20:53:21 +00:00
|
|
|
void mousePressEvent(QMouseEvent* event) override;
|
|
|
|
void mouseMoveEvent(QMouseEvent* event) override;
|
|
|
|
void mouseReleaseEvent(QMouseEvent* event) override;
|
2021-11-14 20:09:29 +00:00
|
|
|
void wheelEvent(QWheelEvent* event) override;
|
2020-02-17 20:53:21 +00:00
|
|
|
|
2022-06-19 04:34:28 +00:00
|
|
|
void InitializeCamera();
|
|
|
|
void FinalizeCamera();
|
|
|
|
|
2018-10-01 19:42:49 +00:00
|
|
|
bool event(QEvent* event) override;
|
2017-03-17 19:41:25 +00:00
|
|
|
|
2020-02-17 20:53:21 +00:00
|
|
|
void focusOutEvent(QFocusEvent* event) override;
|
2014-10-12 16:14:57 +00:00
|
|
|
|
2020-01-21 19:40:53 +00:00
|
|
|
bool InitRenderTarget();
|
2016-08-30 01:28:58 +00:00
|
|
|
|
2020-02-17 20:53:21 +00:00
|
|
|
/// Destroy the previous run's child_widget which should also destroy the child_window
|
|
|
|
void ReleaseRenderTarget();
|
|
|
|
|
2020-11-17 05:33:38 +00:00
|
|
|
bool IsLoadingComplete() const;
|
|
|
|
|
2021-09-10 05:28:02 +00:00
|
|
|
void CaptureScreenshot(const QString& screenshot_path);
|
2018-08-31 06:16:16 +00:00
|
|
|
|
2020-03-25 04:57:36 +00:00
|
|
|
std::pair<u32, u32> ScaleTouch(const QPointF& pos) const;
|
2020-03-25 02:58:49 +00:00
|
|
|
|
2020-11-24 23:18:29 +00:00
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
|
2021-09-26 03:18:14 +00:00
|
|
|
/// Instructs the window to exit the application.
|
|
|
|
void Exit();
|
|
|
|
|
2014-08-24 15:49:34 +00:00
|
|
|
public slots:
|
2022-05-26 23:57:35 +00:00
|
|
|
void OnEmulationStarting(EmuThread* emu_thread_);
|
2015-04-30 23:46:50 +00:00
|
|
|
void OnEmulationStopping();
|
2015-09-04 13:55:48 +00:00
|
|
|
void OnFramebufferSizeChanged();
|
2015-04-29 04:01:41 +00:00
|
|
|
|
2015-09-05 10:29:44 +00:00
|
|
|
signals:
|
|
|
|
/// Emitted when the window is closed
|
|
|
|
void Closed();
|
2019-01-17 07:01:00 +00:00
|
|
|
void FirstFrameDisplayed();
|
2020-11-24 23:18:29 +00:00
|
|
|
void ExecuteProgramSignal(std::size_t program_index);
|
2021-09-26 03:18:14 +00:00
|
|
|
void ExitSignal();
|
2020-12-30 19:41:14 +00:00
|
|
|
void MouseActivity();
|
2021-11-22 01:28:47 +00:00
|
|
|
void TasPlaybackStateChanged();
|
2015-09-05 10:29:44 +00:00
|
|
|
|
2014-04-01 02:26:50 +00:00
|
|
|
private:
|
2018-10-01 19:42:49 +00:00
|
|
|
void TouchBeginEvent(const QTouchEvent* event);
|
|
|
|
void TouchUpdateEvent(const QTouchEvent* event);
|
|
|
|
void TouchEndEvent();
|
|
|
|
|
2022-06-19 04:34:28 +00:00
|
|
|
void RequestCameraCapture();
|
|
|
|
void OnCameraCapture(int requestId, const QImage& img);
|
|
|
|
|
2019-05-29 06:02:36 +00:00
|
|
|
void OnMinimalClientAreaChangeRequest(std::pair<u32, u32> minimal_size) override;
|
2014-10-12 20:46:33 +00:00
|
|
|
|
2020-01-21 19:40:53 +00:00
|
|
|
bool InitializeOpenGL();
|
|
|
|
bool InitializeVulkan();
|
2022-11-28 01:37:37 +00:00
|
|
|
void InitializeNull();
|
2020-01-21 19:40:53 +00:00
|
|
|
bool LoadOpenGL();
|
|
|
|
QStringList GetUnsupportedGLExtensions() const;
|
2014-04-01 02:26:50 +00:00
|
|
|
|
2015-04-29 04:01:41 +00:00
|
|
|
EmuThread* emu_thread;
|
2020-08-29 04:44:27 +00:00
|
|
|
std::shared_ptr<InputCommon::InputSubsystem> input_subsystem;
|
2020-02-17 20:53:21 +00:00
|
|
|
|
2020-03-25 02:58:49 +00:00
|
|
|
// 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 13:55:48 +00:00
|
|
|
|
2018-08-31 06:16:16 +00:00
|
|
|
/// Temporary storage of the screenshot taken
|
|
|
|
QImage screenshot_image;
|
|
|
|
|
2020-01-21 19:40:53 +00:00
|
|
|
QByteArray geometry;
|
2020-02-17 20:53:21 +00:00
|
|
|
|
|
|
|
QWidget* child_widget = nullptr;
|
|
|
|
|
2019-01-17 07:01:00 +00:00
|
|
|
bool first_frame = false;
|
2021-11-22 04:37:50 +00:00
|
|
|
InputCommon::TasInput::TasState last_tas_state;
|
2019-01-17 07:01:00 +00:00
|
|
|
|
2022-08-31 10:10:34 +00:00
|
|
|
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) && YUZU_USE_QT_MULTIMEDIA
|
2022-12-18 05:54:47 +00:00
|
|
|
bool is_virtual_camera;
|
|
|
|
int pending_camera_snapshots;
|
2022-12-16 03:50:36 +00:00
|
|
|
std::vector<u32> camera_data;
|
2022-12-18 05:54:47 +00:00
|
|
|
std::unique_ptr<QCamera> camera;
|
|
|
|
std::unique_ptr<QCameraImageCapture> camera_capture;
|
2022-06-19 04:34:28 +00:00
|
|
|
std::unique_ptr<QTimer> camera_timer;
|
2022-12-18 05:54:47 +00:00
|
|
|
#endif
|
2022-06-19 04:34:28 +00:00
|
|
|
|
2021-09-03 01:40:55 +00:00
|
|
|
Core::System& system;
|
|
|
|
|
2015-09-04 13:55:48 +00:00
|
|
|
protected:
|
|
|
|
void showEvent(QShowEvent* event) override;
|
2020-12-30 19:41:14 +00:00
|
|
|
bool eventFilter(QObject* object, QEvent* event) override;
|
2014-04-01 02:26:50 +00:00
|
|
|
};
|