yuzu/src/core/hid/emulated_devices.h

212 lines
7.2 KiB
C++
Raw Normal View History

2021-09-21 03:43:16 +03:00
// Copyright 2021 yuzu Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.
#pragma once
#include <array>
2021-09-21 03:43:16 +03:00
#include <functional>
#include <memory>
2021-09-21 03:43:16 +03:00
#include <mutex>
#include <unordered_map>
#include "common/common_types.h"
2021-09-21 03:43:16 +03:00
#include "common/input.h"
#include "common/param_package.h"
#include "common/settings.h"
#include "core/hid/hid_types.h"
namespace Core::HID {
using KeyboardDevices = std::array<std::unique_ptr<Common::Input::InputDevice>,
Settings::NativeKeyboard::NumKeyboardKeys>;
using KeyboardModifierDevices = std::array<std::unique_ptr<Common::Input::InputDevice>,
Settings::NativeKeyboard::NumKeyboardMods>;
using MouseButtonDevices = std::array<std::unique_ptr<Common::Input::InputDevice>,
Settings::NativeMouseButton::NumMouseButtons>;
2021-11-14 23:09:29 +03:00
using MouseAnalogDevices = std::array<std::unique_ptr<Common::Input::InputDevice>,
Settings::NativeMouseWheel::NumMouseWheels>;
using MouseStickDevice = std::unique_ptr<Common::Input::InputDevice>;
2021-09-21 03:43:16 +03:00
using MouseButtonParams =
std::array<Common::ParamPackage, Settings::NativeMouseButton::NumMouseButtons>;
using KeyboardValues =
std::array<Common::Input::ButtonStatus, Settings::NativeKeyboard::NumKeyboardKeys>;
2021-09-21 03:43:16 +03:00
using KeyboardModifierValues =
std::array<Common::Input::ButtonStatus, Settings::NativeKeyboard::NumKeyboardMods>;
2021-09-21 03:43:16 +03:00
using MouseButtonValues =
std::array<Common::Input::ButtonStatus, Settings::NativeMouseButton::NumMouseButtons>;
2021-11-14 23:09:29 +03:00
using MouseAnalogValues =
std::array<Common::Input::AnalogStatus, Settings::NativeMouseWheel::NumMouseWheels>;
using MouseStickValue = Common::Input::TouchStatus;
2021-09-21 03:43:16 +03:00
struct MousePosition {
2021-11-14 23:09:29 +03:00
f32 x;
f32 y;
2021-09-21 03:43:16 +03:00
};
struct DeviceStatus {
// Data from input_common
KeyboardValues keyboard_values{};
KeyboardModifierValues keyboard_moddifier_values{};
MouseButtonValues mouse_button_values{};
2021-11-14 23:09:29 +03:00
MouseAnalogValues mouse_analog_values{};
MouseStickValue mouse_stick_value{};
2021-09-21 03:43:16 +03:00
2021-10-17 08:33:00 +03:00
// Data for HID serices
2021-09-21 03:43:16 +03:00
KeyboardKey keyboard_state{};
KeyboardModifier keyboard_moddifier_state{};
MouseButton mouse_button_state{};
MousePosition mouse_position_state{};
2021-11-14 23:09:29 +03:00
AnalogStickState mouse_wheel_state{};
2021-09-21 03:43:16 +03:00
};
enum class DeviceTriggerType {
Keyboard,
KeyboardModdifier,
Mouse,
};
struct InterfaceUpdateCallback {
std::function<void(DeviceTriggerType)> on_change;
};
class EmulatedDevices {
public:
/**
2021-10-17 08:33:00 +03:00
* Contains all input data related to external devices that aren't necesarily a controller
* This includes devices such as the keyboard or mouse
2021-09-21 03:43:16 +03:00
*/
2021-10-17 08:33:00 +03:00
EmulatedDevices();
2021-09-21 03:43:16 +03:00
~EmulatedDevices();
YUZU_NON_COPYABLE(EmulatedDevices);
YUZU_NON_MOVEABLE(EmulatedDevices);
2021-10-17 08:33:00 +03:00
/// Removes all callbacks created from input devices
2021-09-21 03:43:16 +03:00
void UnloadInput();
/**
* Sets the emulated devices into configuring mode
* This prevents the modification of the HID state of the emulated devices by input commands
*/
2021-09-21 03:43:16 +03:00
void EnableConfiguration();
2021-10-17 08:33:00 +03:00
/// Returns the emulated devices into normal mode, allowing the modification of the HID state
2021-09-21 03:43:16 +03:00
void DisableConfiguration();
2021-10-17 08:33:00 +03:00
/// Returns true if the emulated device is in configuring mode
2021-09-21 03:43:16 +03:00
bool IsConfiguring() const;
2021-10-17 08:33:00 +03:00
/// Reload all input devices
void ReloadInput();
/// Overrides current mapped devices with the stored configuration and reloads all input devices
void ReloadFromSettings();
/// Saves the current mapped configuration
2021-09-21 03:43:16 +03:00
void SaveCurrentConfig();
2021-10-17 08:33:00 +03:00
/// Reverts any mapped changes made that weren't saved
void RestoreConfig();
2021-09-21 03:43:16 +03:00
2021-10-17 08:33:00 +03:00
/// Returns the latest status of button input from the keyboard with parameters
2021-09-21 03:43:16 +03:00
KeyboardValues GetKeyboardValues() const;
2021-10-17 08:33:00 +03:00
/// Returns the latest status of button input from the keyboard modifiers with parameters
2021-09-21 03:43:16 +03:00
KeyboardModifierValues GetKeyboardModdifierValues() const;
2021-10-17 08:33:00 +03:00
/// Returns the latest status of button input from the mouse with parameters
2021-09-21 03:43:16 +03:00
MouseButtonValues GetMouseButtonsValues() const;
2021-10-17 08:33:00 +03:00
/// Returns the latest status of button input from the keyboard
2021-09-21 03:43:16 +03:00
KeyboardKey GetKeyboard() const;
2021-10-17 08:33:00 +03:00
/// Returns the latest status of button input from the keyboard modifiers
2021-09-21 03:43:16 +03:00
KeyboardModifier GetKeyboardModifier() const;
2021-10-17 08:33:00 +03:00
/// Returns the latest status of button input from the mouse
2021-09-21 03:43:16 +03:00
MouseButton GetMouseButtons() const;
2021-10-17 08:33:00 +03:00
/// Returns the latest mouse coordinates
2021-09-21 03:43:16 +03:00
MousePosition GetMousePosition() const;
2021-11-14 23:09:29 +03:00
/// Returns the latest mouse wheel change
AnalogStickState GetMouseWheel() const;
2021-11-14 23:09:29 +03:00
2021-10-17 08:33:00 +03:00
/**
* Adds a callback to the list of events
* @param update_callback InterfaceUpdateCallback that will be triggered
2021-10-17 08:33:00 +03:00
* @return an unique key corresponding to the callback index in the list
*/
2021-09-21 03:43:16 +03:00
int SetCallback(InterfaceUpdateCallback update_callback);
2021-10-17 08:33:00 +03:00
/**
* Removes a callback from the list stopping any future events to this object
* @param key Key corresponding to the callback index in the list
2021-10-17 08:33:00 +03:00
*/
2021-09-21 03:43:16 +03:00
void DeleteCallback(int key);
private:
/// Helps assigning a value to keyboard_state
void UpdateKey(std::size_t key_index, bool status);
2021-09-21 03:43:16 +03:00
/**
2021-11-14 23:09:29 +03:00
* Updates the touch status of the keyboard device
* @param callback A CallbackStatus containing the key status
* @param index key ID to be updated
2021-09-21 03:43:16 +03:00
*/
void SetKeyboardButton(Common::Input::CallbackStatus callback, std::size_t index);
2021-10-17 08:33:00 +03:00
/**
2021-11-14 23:09:29 +03:00
* Updates the keyboard status of the keyboard device
* @param callback A CallbackStatus containing the modifier key status
* @param index modifier key ID to be updated
2021-10-17 08:33:00 +03:00
*/
void SetKeyboardModifier(Common::Input::CallbackStatus callback, std::size_t index);
2021-10-17 08:33:00 +03:00
/**
2021-11-14 23:09:29 +03:00
* Updates the mouse button status of the mouse device
* @param callback A CallbackStatus containing the button status
* @param index Button ID to be updated
2021-10-17 08:33:00 +03:00
*/
void SetMouseButton(Common::Input::CallbackStatus callback, std::size_t index);
2021-09-21 03:43:16 +03:00
2021-11-14 23:09:29 +03:00
/**
* Updates the mouse wheel status of the mouse device
* @param callback A CallbackStatus containing the wheel status
* @param index wheel ID to be updated
2021-11-14 23:09:29 +03:00
*/
void SetMouseAnalog(Common::Input::CallbackStatus callback, std::size_t index);
/**
* Updates the mouse position status of the mouse device
* @param callback A CallbackStatus containing the position status
* @param index stick ID to be updated
2021-11-14 23:09:29 +03:00
*/
void SetMouseStick(Common::Input::CallbackStatus callback);
2021-09-21 03:43:16 +03:00
/**
2021-10-17 08:33:00 +03:00
* Triggers a callback that something has changed on the device status
* @param type Input type of the event to trigger
2021-09-21 03:43:16 +03:00
*/
void TriggerOnChange(DeviceTriggerType type);
bool is_configuring{false};
KeyboardDevices keyboard_devices;
KeyboardModifierDevices keyboard_modifier_devices;
MouseButtonDevices mouse_button_devices;
2021-11-14 23:09:29 +03:00
MouseAnalogDevices mouse_analog_devices;
MouseStickDevice mouse_stick_device;
2021-09-21 03:43:16 +03:00
mutable std::mutex mutex;
std::unordered_map<int, InterfaceUpdateCallback> callback_list;
int last_callback_key = 0;
2021-10-17 08:33:00 +03:00
// Stores the current status of all external device input
2021-09-21 03:43:16 +03:00
DeviceStatus device_status;
};
} // namespace Core::HID