diff --git a/Source/Core/InputCommon/ControllerInterface/SDL/SDL.cpp b/Source/Core/InputCommon/ControllerInterface/SDL/SDL.cpp index fa5a2602cb..feb1f8f4ce 100644 --- a/Source/Core/InputCommon/ControllerInterface/SDL/SDL.cpp +++ b/Source/Core/InputCommon/ControllerInterface/SDL/SDL.cpp @@ -4,6 +4,7 @@ #include "InputCommon/ControllerInterface/SDL/SDL.h" #include +#include #include #include @@ -11,8 +12,8 @@ #include "Common/Event.h" #include "Common/Logging/Log.h" +#include "Common/MathUtil.h" #include "Common/ScopeGuard.h" -#include "Common/StringUtil.h" #include "InputCommon/ControllerInterface/ControllerInterface.h" #ifdef _WIN32 @@ -24,6 +25,39 @@ namespace ciface::Core class Device; } +namespace +{ +std::string GetLegacyButtonName(int index) +{ + return "Button " + std::to_string(index); +} + +std::string GetLegacyAxisName(int index, int range) +{ + return "Axis " + std::to_string(index) + (range < 0 ? '-' : '+'); +} + +std::string GetLegacyHatName(int index, int direction) +{ + return "Hat " + std::to_string(index) + ' ' + "NESW"[direction]; +} + +constexpr int GetDirectionFromHatMask(u8 mask) +{ + return MathUtil::IntLog2(mask); +} + +static_assert(GetDirectionFromHatMask(SDL_HAT_UP) == 0); +static_assert(GetDirectionFromHatMask(SDL_HAT_LEFT) == 3); + +bool IsTriggerAxis(int index) +{ + // First 4 axes are for the analog sticks, the rest are for the triggers + return index >= 4; +} + +} // namespace + namespace ciface::SDL { @@ -64,54 +98,48 @@ private: class LegacyButton : public Core::Device::Input { public: - std::string GetName() const override; - LegacyButton(SDL_Joystick* js, int index, bool is_detectable) - : m_js(js), m_index(index), m_is_detectable(is_detectable) - { - } - bool IsDetectable() const override { return m_is_detectable; } + std::string GetName() const override { return GetLegacyButtonName(m_index); } + LegacyButton(SDL_Joystick* js, int index) : m_js(js), m_index(index) {} ControlState GetState() const override; private: SDL_Joystick* const m_js; const int m_index; - const bool m_is_detectable; }; class LegacyAxis : public Core::Device::Input { public: - std::string GetName() const override; - LegacyAxis(SDL_Joystick* js, int index, s16 range, bool is_detectable) - : m_js(js), m_index(index), m_range(range), m_is_detectable(is_detectable) + std::string GetName() const override { return GetLegacyAxisName(m_index, m_range); } + LegacyAxis(SDL_Joystick* js, int index, s16 range, bool is_handled_elsewhere) + : m_js(js), m_index(index), m_range(range), m_is_handled_elsewhere(is_handled_elsewhere) { } - bool IsDetectable() const override { return m_is_detectable; } ControlState GetState() const override; + bool IsHidden() const override { return m_is_handled_elsewhere; } + bool IsDetectable() const override { return !IsHidden(); } private: SDL_Joystick* const m_js; const int m_index; const s16 m_range; - const bool m_is_detectable; + const bool m_is_handled_elsewhere; }; class LegacyHat : public Input { public: - std::string GetName() const override; - LegacyHat(SDL_Joystick* js, int index, u8 direction, bool is_detectable) - : m_js(js), m_index(index), m_direction(direction), m_is_detectable(is_detectable) + std::string GetName() const override { return GetLegacyHatName(m_index, m_direction); } + LegacyHat(SDL_Joystick* js, int index, u8 direction) + : m_js(js), m_index(index), m_direction(direction) { } - bool IsDetectable() const override { return m_is_detectable; } ControlState GetState() const override; private: SDL_Joystick* const m_js; const int m_index; const u8 m_direction; - const bool m_is_detectable; }; // Rumble @@ -565,48 +593,26 @@ GameController::GameController(SDL_GameController* const gamecontroller, name = SDL_JoystickName(joystick); m_name = name != nullptr ? name : "Unknown"; - // If a Joystick Button has a GameController equivalent, don't detect it - int n_legacy_buttons = SDL_JoystickNumButtons(joystick); - if (n_legacy_buttons < 0) - { - ERROR_LOG_FMT(CONTROLLERINTERFACE, "Error in SDL_JoystickNumButtons(): {}", SDL_GetError()); - n_legacy_buttons = 0; - } - - int n_legacy_axes = SDL_JoystickNumAxes(joystick); - if (n_legacy_axes < 0) - { - ERROR_LOG_FMT(CONTROLLERINTERFACE, "Error in SDL_JoystickNumAxes(): {}", SDL_GetError()); - n_legacy_axes = 0; - } - - int n_legacy_hats = SDL_JoystickNumHats(joystick); - if (n_legacy_hats < 0) - { - ERROR_LOG_FMT(CONTROLLERINTERFACE, "Error in SDL_JoystickNumHats(): {}", SDL_GetError()); - n_legacy_hats = 0; - } - - std::vector is_button_mapped(static_cast(n_legacy_buttons), false); - std::vector is_axis_mapped(static_cast(n_legacy_axes), false); - std::vector is_hat_mapped(static_cast(n_legacy_hats), false); - + // If a Joystick input has a GameController equivalent button/hat we don't add it. + // "Equivalent" axes are still added as hidden/undetectable inputs to handle + // loading of existing configs which may use "full surface" inputs. + // Otherwise handling those would require dealing with gamepad specific quirks. + std::unordered_set registered_buttons; + std::unordered_set registered_hats; + std::unordered_set registered_axes; const auto register_mapping = [&](const SDL_GameControllerButtonBind& bind) { switch (bind.bindType) { - case SDL_CONTROLLER_BINDTYPE_NONE: - return; case SDL_CONTROLLER_BINDTYPE_BUTTON: - if (bind.value.button >= 0 && bind.value.button < n_legacy_buttons) - is_button_mapped[bind.value.button] = true; - break; - case SDL_CONTROLLER_BINDTYPE_AXIS: - if (bind.value.axis >= 0 && bind.value.axis < n_legacy_axes) - is_axis_mapped[bind.value.axis] = true; + registered_buttons.insert(bind.value.button); break; case SDL_CONTROLLER_BINDTYPE_HAT: - if (bind.value.hat.hat >= 0 && bind.value.hat.hat < n_legacy_hats) - is_hat_mapped[bind.value.hat.hat] = true; + registered_hats.insert(bind.value.hat.hat); + break; + case SDL_CONTROLLER_BINDTYPE_AXIS: + registered_axes.insert(bind.value.axis); + break; + default: break; } }; @@ -622,6 +628,7 @@ GameController::GameController(SDL_GameController* const gamecontroller, if (SDL_GameControllerHasButton(m_gamecontroller, button)) { AddInput(new Button(gamecontroller, button)); + register_mapping(SDL_GameControllerGetBindForButton(gamecontroller, button)); } } @@ -632,20 +639,21 @@ GameController::GameController(SDL_GameController* const gamecontroller, SDL_GameControllerAxis axis = static_cast(i); if (SDL_GameControllerHasAxis(m_gamecontroller, axis)) { - // First 4 axes are for the analog sticks, the rest are for the triggers - if (i < 4) + if (IsTriggerAxis(axis)) + { + AddInput(new Axis(m_gamecontroller, 32767, axis)); + } + else { // Each axis gets a negative and a positive input instance associated with it AddInput(new Axis(m_gamecontroller, -32768, axis)); AddInput(new Axis(m_gamecontroller, 32767, axis)); } - else - { - AddInput(new Axis(m_gamecontroller, 32767, axis)); - } + register_mapping(SDL_GameControllerGetBindForAxis(gamecontroller, axis)); } } + // Rumble if (SDL_GameControllerHasRumble(m_gamecontroller)) { @@ -655,14 +663,14 @@ GameController::GameController(SDL_GameController* const gamecontroller, } // Motion - const auto add_sensor = [this](SDL_SensorType type, std::string_view name, + const auto add_sensor = [this](SDL_SensorType type, std::string_view sensor_name, const SDLMotionAxisList& axes) { if (SDL_GameControllerSetSensorEnabled(m_gamecontroller, type, SDL_TRUE) == 0) { for (const SDLMotionAxis& axis : axes) { - AddInput(new MotionInput(fmt::format("{} {}", name, axis.name), m_gamecontroller, type, - axis.index, axis.scale)); + AddInput(new MotionInput(fmt::format("{} {}", sensor_name, axis.name), m_gamecontroller, + type, axis.index, axis.scale)); } } }; @@ -678,23 +686,51 @@ GameController::GameController(SDL_GameController* const gamecontroller, // Legacy inputs // Buttons + int n_legacy_buttons = SDL_JoystickNumButtons(joystick); + if (n_legacy_buttons < 0) + { + ERROR_LOG_FMT(CONTROLLERINTERFACE, "Error in SDL_JoystickNumButtons(): {}", SDL_GetError()); + n_legacy_buttons = 0; + } for (int i = 0; i != n_legacy_buttons; ++i) - AddInput(new LegacyButton(m_joystick, i, !is_button_mapped[i])); + { + if (registered_buttons.contains(i)) + continue; + + AddInput(new LegacyButton(m_joystick, i)); + } // Axes + int n_legacy_axes = SDL_JoystickNumAxes(joystick); + if (n_legacy_axes < 0) + { + ERROR_LOG_FMT(CONTROLLERINTERFACE, "Error in SDL_JoystickNumAxes(): {}", SDL_GetError()); + n_legacy_axes = 0; + } for (int i = 0; i != n_legacy_axes; ++i) { + const bool is_registered = registered_axes.contains(i); + // each axis gets a negative and a positive input instance associated with it - AddAnalogInputs(new LegacyAxis(m_joystick, i, -32768, !is_axis_mapped[i]), - new LegacyAxis(m_joystick, i, 32767, !is_axis_mapped[i])); + AddAnalogInputs(new LegacyAxis(m_joystick, i, -32768, is_registered), + new LegacyAxis(m_joystick, i, 32767, is_registered)); } // Hats + int n_legacy_hats = SDL_JoystickNumHats(joystick); + if (n_legacy_hats < 0) + { + ERROR_LOG_FMT(CONTROLLERINTERFACE, "Error in SDL_JoystickNumHats(): {}", SDL_GetError()); + n_legacy_hats = 0; + } for (int i = 0; i != n_legacy_hats; ++i) { + if (registered_hats.contains(i)) + continue; + // each hat gets 4 input instances associated with it, (up down left right) for (u8 d = 0; d != 4; ++d) - AddInput(new LegacyHat(m_joystick, i, d, !is_hat_mapped[i])); + AddInput(new LegacyHat(m_joystick, i, d)); } // Haptics @@ -783,8 +819,7 @@ std::string GameController::Button::GetName() const std::string GameController::Axis::GetName() const { - // The triggers are only positive, and must not have a sign - if (m_axis >= 4) + if (IsTriggerAxis(m_axis)) return std::string(s_sdl_axis_names[m_axis]); bool negative = m_range < 0; @@ -820,7 +855,19 @@ bool GameController::Button::IsMatchingName(std::string_view name) const return GetName() == "Button W"; if (name == "Button Y") return GetName() == "Button N"; - return false; + + // Match legacy names. + const auto bind = SDL_GameControllerGetBindForButton(m_gc, m_button); + switch (bind.bindType) + { + case SDL_CONTROLLER_BINDTYPE_BUTTON: + return name == GetLegacyButtonName(bind.value.button); + case SDL_CONTROLLER_BINDTYPE_HAT: + return name == GetLegacyHatName(bind.value.hat.hat, + GetDirectionFromHatMask(u8(bind.value.hat.hat_mask))); + default: + return false; + } } ControlState GameController::MotionInput::GetState() const @@ -831,21 +878,6 @@ ControlState GameController::MotionInput::GetState() const } // Legacy input -std::string GameController::LegacyButton::GetName() const -{ - return "Button " + std::to_string(m_index); -} - -std::string GameController::LegacyAxis::GetName() const -{ - return "Axis " + std::to_string(m_index) + (m_range < 0 ? '-' : '+'); -} - -std::string GameController::LegacyHat::GetName() const -{ - return "Hat " + std::to_string(m_index) + ' ' + "NESW"[m_direction]; -} - ControlState GameController::LegacyButton::GetState() const { return SDL_JoystickGetButton(m_js, m_index);