diff options
Diffstat (limited to '')
| -rw-r--r-- | src/input_common/tas/tas_input.h | 237 |
1 files changed, 0 insertions, 237 deletions
diff --git a/src/input_common/tas/tas_input.h b/src/input_common/tas/tas_input.h deleted file mode 100644 index 3e2db8f00..000000000 --- a/src/input_common/tas/tas_input.h +++ /dev/null | |||
| @@ -1,237 +0,0 @@ | |||
| 1 | // Copyright 2020 yuzu Emulator Project | ||
| 2 | // Licensed under GPLv2 or any later version | ||
| 3 | // Refer to the license.txt file included. | ||
| 4 | |||
| 5 | #pragma once | ||
| 6 | |||
| 7 | #include <array> | ||
| 8 | |||
| 9 | #include "common/common_types.h" | ||
| 10 | #include "common/settings_input.h" | ||
| 11 | #include "core/frontend/input.h" | ||
| 12 | #include "input_common/main.h" | ||
| 13 | |||
| 14 | /* | ||
| 15 | To play back TAS scripts on Yuzu, select the folder with scripts in the configuration menu below | ||
| 16 | Tools -> Configure TAS. The file itself has normal text format and has to be called script0-1.txt | ||
| 17 | for controller 1, script0-2.txt for controller 2 and so forth (with max. 8 players). | ||
| 18 | |||
| 19 | A script file has the same format as TAS-nx uses, so final files will look like this: | ||
| 20 | |||
| 21 | 1 KEY_B 0;0 0;0 | ||
| 22 | 6 KEY_ZL 0;0 0;0 | ||
| 23 | 41 KEY_ZL;KEY_Y 0;0 0;0 | ||
| 24 | 43 KEY_X;KEY_A 32767;0 0;0 | ||
| 25 | 44 KEY_A 32767;0 0;0 | ||
| 26 | 45 KEY_A 32767;0 0;0 | ||
| 27 | 46 KEY_A 32767;0 0;0 | ||
| 28 | 47 KEY_A 32767;0 0;0 | ||
| 29 | |||
| 30 | After placing the file at the correct location, it can be read into Yuzu with the (default) hotkey | ||
| 31 | CTRL+F6 (refresh). In the bottom left corner, it will display the amount of frames the script file | ||
| 32 | has. Playback can be started or stopped using CTRL+F5. | ||
| 33 | |||
| 34 | However, for playback to actually work, the correct input device has to be selected: In the Controls | ||
| 35 | menu, select TAS from the device list for the controller that the script should be played on. | ||
| 36 | |||
| 37 | Recording a new script file is really simple: Just make sure that the proper device (not TAS) is | ||
| 38 | connected on P1, and press CTRL+F7 to start recording. When done, just press the same keystroke | ||
| 39 | again (CTRL+F7). The new script will be saved at the location previously selected, as the filename | ||
| 40 | record.txt. | ||
| 41 | |||
| 42 | For debugging purposes, the common controller debugger can be used (View -> Debugging -> Controller | ||
| 43 | P1). | ||
| 44 | */ | ||
| 45 | |||
| 46 | namespace TasInput { | ||
| 47 | |||
| 48 | constexpr size_t PLAYER_NUMBER = 8; | ||
| 49 | |||
| 50 | using TasAnalog = std::pair<float, float>; | ||
| 51 | |||
| 52 | enum class TasState { | ||
| 53 | Running, | ||
| 54 | Recording, | ||
| 55 | Stopped, | ||
| 56 | }; | ||
| 57 | |||
| 58 | enum class TasButton : u32 { | ||
| 59 | BUTTON_A = 1U << 0, | ||
| 60 | BUTTON_B = 1U << 1, | ||
| 61 | BUTTON_X = 1U << 2, | ||
| 62 | BUTTON_Y = 1U << 3, | ||
| 63 | STICK_L = 1U << 4, | ||
| 64 | STICK_R = 1U << 5, | ||
| 65 | TRIGGER_L = 1U << 6, | ||
| 66 | TRIGGER_R = 1U << 7, | ||
| 67 | TRIGGER_ZL = 1U << 8, | ||
| 68 | TRIGGER_ZR = 1U << 9, | ||
| 69 | BUTTON_PLUS = 1U << 10, | ||
| 70 | BUTTON_MINUS = 1U << 11, | ||
| 71 | BUTTON_LEFT = 1U << 12, | ||
| 72 | BUTTON_UP = 1U << 13, | ||
| 73 | BUTTON_RIGHT = 1U << 14, | ||
| 74 | BUTTON_DOWN = 1U << 15, | ||
| 75 | BUTTON_SL = 1U << 16, | ||
| 76 | BUTTON_SR = 1U << 17, | ||
| 77 | BUTTON_HOME = 1U << 18, | ||
| 78 | BUTTON_CAPTURE = 1U << 19, | ||
| 79 | }; | ||
| 80 | |||
| 81 | enum class TasAxes : u8 { | ||
| 82 | StickX, | ||
| 83 | StickY, | ||
| 84 | SubstickX, | ||
| 85 | SubstickY, | ||
| 86 | Undefined, | ||
| 87 | }; | ||
| 88 | |||
| 89 | struct TasData { | ||
| 90 | u32 buttons{}; | ||
| 91 | std::array<float, 4> axis{}; | ||
| 92 | }; | ||
| 93 | |||
| 94 | class Tas { | ||
| 95 | public: | ||
| 96 | Tas(); | ||
| 97 | ~Tas(); | ||
| 98 | |||
| 99 | // Changes the input status that will be stored in each frame | ||
| 100 | void RecordInput(u32 buttons, const std::array<std::pair<float, float>, 2>& axes); | ||
| 101 | |||
| 102 | // Main loop that records or executes input | ||
| 103 | void UpdateThread(); | ||
| 104 | |||
| 105 | // Sets the flag to start or stop the TAS command excecution and swaps controllers profiles | ||
| 106 | void StartStop(); | ||
| 107 | |||
| 108 | // Stop the TAS and reverts any controller profile | ||
| 109 | void Stop(); | ||
| 110 | |||
| 111 | // Sets the flag to reload the file and start from the begining in the next update | ||
| 112 | void Reset(); | ||
| 113 | |||
| 114 | /** | ||
| 115 | * Sets the flag to enable or disable recording of inputs | ||
| 116 | * @return Returns true if the current recording status is enabled | ||
| 117 | */ | ||
| 118 | bool Record(); | ||
| 119 | |||
| 120 | // Saves contents of record_commands on a file if overwrite is enabled player 1 will be | ||
| 121 | // overwritten with the recorded commands | ||
| 122 | void SaveRecording(bool overwrite_file); | ||
| 123 | |||
| 124 | /** | ||
| 125 | * Returns the current status values of TAS playback/recording | ||
| 126 | * @return Tuple of | ||
| 127 | * TasState indicating the current state out of Running, Recording or Stopped ; | ||
| 128 | * Current playback progress or amount of frames (so far) for Recording ; | ||
| 129 | * Total length of script file currently loaded or amount of frames (so far) for Recording | ||
| 130 | */ | ||
| 131 | std::tuple<TasState, size_t, size_t> GetStatus() const; | ||
| 132 | |||
| 133 | // Retuns an array of the default button mappings | ||
| 134 | InputCommon::ButtonMapping GetButtonMappingForDevice(const Common::ParamPackage& params) const; | ||
| 135 | |||
| 136 | // Retuns an array of the default analog mappings | ||
| 137 | InputCommon::AnalogMapping GetAnalogMappingForDevice(const Common::ParamPackage& params) const; | ||
| 138 | [[nodiscard]] const TasData& GetTasState(std::size_t pad) const; | ||
| 139 | |||
| 140 | private: | ||
| 141 | struct TASCommand { | ||
| 142 | u32 buttons{}; | ||
| 143 | TasAnalog l_axis{}; | ||
| 144 | TasAnalog r_axis{}; | ||
| 145 | }; | ||
| 146 | |||
| 147 | // Loads TAS files from all players | ||
| 148 | void LoadTasFiles(); | ||
| 149 | |||
| 150 | // Loads TAS file from the specified player | ||
| 151 | void LoadTasFile(size_t player_index); | ||
| 152 | |||
| 153 | // Writes a TAS file from the recorded commands | ||
| 154 | void WriteTasFile(std::u8string file_name); | ||
| 155 | |||
| 156 | /** | ||
| 157 | * Parses a string containing the axis values with the following format "x;y" | ||
| 158 | * X and Y have a range from -32767 to 32767 | ||
| 159 | * @return Returns a TAS analog object with axis values with range from -1.0 to 1.0 | ||
| 160 | */ | ||
| 161 | TasAnalog ReadCommandAxis(const std::string& line) const; | ||
| 162 | |||
| 163 | /** | ||
| 164 | * Parses a string containing the button values with the following format "a;b;c;d..." | ||
| 165 | * Each button is represented by it's text format specified in text_to_tas_button array | ||
| 166 | * @return Returns a u32 with each bit representing the status of a button | ||
| 167 | */ | ||
| 168 | u32 ReadCommandButtons(const std::string& line) const; | ||
| 169 | |||
| 170 | /** | ||
| 171 | * Converts an u32 containing the button status into the text equivalent | ||
| 172 | * @return Returns a string with the name of the buttons to be written to the file | ||
| 173 | */ | ||
| 174 | std::string WriteCommandButtons(u32 data) const; | ||
| 175 | |||
| 176 | /** | ||
| 177 | * Converts an TAS analog object containing the axis status into the text equivalent | ||
| 178 | * @return Returns a string with the value of the axis to be written to the file | ||
| 179 | */ | ||
| 180 | std::string WriteCommandAxis(TasAnalog data) const; | ||
| 181 | |||
| 182 | // Inverts the Y axis polarity | ||
| 183 | std::pair<float, float> FlipAxisY(std::pair<float, float> old); | ||
| 184 | |||
| 185 | /** | ||
| 186 | * Converts an u32 containing the button status into the text equivalent | ||
| 187 | * @return Returns a string with the name of the buttons to be printed on console | ||
| 188 | */ | ||
| 189 | std::string DebugButtons(u32 buttons) const; | ||
| 190 | |||
| 191 | /** | ||
| 192 | * Converts an TAS analog object containing the axis status into the text equivalent | ||
| 193 | * @return Returns a string with the value of the axis to be printed on console | ||
| 194 | */ | ||
| 195 | std::string DebugJoystick(float x, float y) const; | ||
| 196 | |||
| 197 | /** | ||
| 198 | * Converts the given TAS status into the text equivalent | ||
| 199 | * @return Returns a string with the value of the TAS status to be printed on console | ||
| 200 | */ | ||
| 201 | std::string DebugInput(const TasData& data) const; | ||
| 202 | |||
| 203 | /** | ||
| 204 | * Converts the given TAS status of multiple players into the text equivalent | ||
| 205 | * @return Returns a string with the value of the status of all TAS players to be printed on | ||
| 206 | * console | ||
| 207 | */ | ||
| 208 | std::string DebugInputs(const std::array<TasData, PLAYER_NUMBER>& arr) const; | ||
| 209 | |||
| 210 | /** | ||
| 211 | * Converts an u32 containing the button status into the text equivalent | ||
| 212 | * @return Returns a string with the name of the buttons | ||
| 213 | */ | ||
| 214 | std::string ButtonsToString(u32 button) const; | ||
| 215 | |||
| 216 | // Stores current controller configuration and sets a TAS controller for every active controller | ||
| 217 | // to the current config | ||
| 218 | void SwapToTasController(); | ||
| 219 | |||
| 220 | // Sets the stored controller configuration to the current config | ||
| 221 | void SwapToStoredController(); | ||
| 222 | |||
| 223 | size_t script_length{0}; | ||
| 224 | std::array<TasData, PLAYER_NUMBER> tas_data; | ||
| 225 | bool is_old_input_saved{false}; | ||
| 226 | bool is_recording{false}; | ||
| 227 | bool is_running{false}; | ||
| 228 | bool needs_reset{false}; | ||
| 229 | std::array<std::vector<TASCommand>, PLAYER_NUMBER> commands{}; | ||
| 230 | std::vector<TASCommand> record_commands{}; | ||
| 231 | size_t current_command{0}; | ||
| 232 | TASCommand last_input{}; // only used for recording | ||
| 233 | |||
| 234 | // Old settings for swapping controllers | ||
| 235 | std::array<Settings::PlayerInput, 10> player_mappings; | ||
| 236 | }; | ||
| 237 | } // namespace TasInput | ||