New gamepad types

Author: nstbayless

include/SDL3/SDL_gamepad.h

@@ -103,10 +103,15 @@ typedef struct SDL_Gamepad SDL_Gamepad;
  * Standard gamepad types.
  *
  * This type does not necessarily map to first-party controllers from
- * Microsoft/Sony/Nintendo; in many cases, third-party controllers can report
+ * Microsoft/Sony/Nintendo/etc.; in many cases, third-party controllers can report
  * as these, either because they were designed for a specific console, or they
  * simply most closely match that console's controllers (does it have A/B/X/Y
  * buttons or X/O/Square/Triangle? Does it have a touchpad? etc).
+ *
+ * PSX and PS2 controllers should be classified as PS3.
+ *
+ * Sega Saturn controllers should be classified as Sega Genesis.
+ *
  */
 typedef enum SDL_GamepadType
 {
@@ -123,6 +128,9 @@ typedef enum SDL_GamepadType
     SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR,
     SDL_GAMEPAD_TYPE_GAMECUBE,
     SDL_GAMEPAD_TYPE_STEAM,
+    SDL_GAMEPAD_TYPE_N64,
+    SDL_GAMEPAD_TYPE_WII,
+    SDL_GAMEPAD_TYPE_SEGA_GENESIS,
     SDL_GAMEPAD_TYPE_COUNT
 } SDL_GamepadType;
 
@@ -136,15 +144,25 @@ typedef enum SDL_GamepadType
  * would be A/X/B/Y, for PlayStation controllers this would be
  * Cross/Circle/Square/Triangle.
  *
+ * Gamepads which use a Sega Genesis-style layout (3 button or 6-button both)
+ * should map the bottom (or only) row to South, East, and Right Trigger, and
+ * the top row to West, North, and Right Button. L and R, if present, should
+ * be mapped to Left Button and Left Trigger respectively.
+ *
  * For controllers that don't use a diamond pattern for the face buttons, the
  * south/east/west/north buttons indicate the buttons labeled A, B, C, D, or
  * 1, 2, 3, 4, or for controllers that aren't labeled, they are the primary,
  * secondary, etc. buttons.
  *
  * The activate action is often the south button and the cancel action is
- * often the east button, but in some regions this is reversed, so your game
- * should allow remapping actions based on user preferences.
- *
+ * often the east button, but in some regions and on some gamepads this is reversed,
+ * so your game should allow remapping actions based on user preferences, and you should
+ * check the gamepad type and region for the default mapping.
+ *
+ * On some controllers, what would conventionally be considered buttons are instead
+ * considered axes by SDL, such as the R and C buttons on the genesis controller,
+ * or the ZL and ZR buttons on the Switch Pro controller.
+ * 
  * You can query the labels for the face buttons using
  * SDL_GetGamepadButtonLabel()
  *
@@ -732,6 +750,7 @@ extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadTypeForID(SDL_Joystick
  * \since This function is available since SDL 3.2.0.
  *
  * \sa SDL_GetGamepadTypeForID
+ * \sa SDL_GetGamepadStringForType
  * \sa SDL_GetGamepads
  * \sa SDL_GetRealGamepadType
  */
@@ -893,6 +912,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetGamepadPath(SDL_Gamepad *gamepad
  * \since This function is available since SDL 3.2.0.
  *
  * \sa SDL_GetGamepadTypeForID
+ * \sa SDL_GetGamepadStringForType
  */
 extern SDL_DECLSPEC SDL_GamepadType SDLCALL SDL_GetGamepadType(SDL_Gamepad *gamepad);
 
@@ -1367,7 +1387,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetGamepadButton(SDL_Gamepad *gamepad, SDL_
  *
  * \param type the type of gamepad to check.
  * \param button a button index (one of the SDL_GamepadButton values).
- * \returns the SDL_GamepadButtonLabel enum corresponding to the button label.
+ * \returns the SDL_GamepadButtonLabel enum corresponding to the button label, or SDL_GAMEPAD_BUTTON_LABEL_UNKNOWN.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1380,9 +1400,10 @@ extern SDL_DECLSPEC SDL_GamepadButtonLabel SDLCALL SDL_GetGamepadButtonLabelForT
 /**
  * Get the label of a button on a gamepad.
  *
+ *
  * \param gamepad a gamepad.
  * \param button a button index (one of the SDL_GamepadButton values).
- * \returns the SDL_GamepadButtonLabel enum corresponding to the button label.
+ * \returns the SDL_GamepadButtonLabel enum corresponding to the button label, or SDL_GAMEPAD_BUTTON_LABEL_UNKNOWN.
  *
  * \threadsafety It is safe to call this function from any thread.
  *

src/joystick/SDL_gamepad.c

@@ -3079,12 +3079,11 @@ SDL_GamepadType SDL_GetGamepadTypeFromVIDPID(Uint16 vendor, Uint16 product, cons
                (product == USB_PRODUCT_NINTENDO_SWITCH_JOYCON_RIGHT ||
                 product == USB_PRODUCT_NINTENDO_SWITCH2_JOYCON_RIGHT)) {
         if (name && SDL_strstr(name, "NES Controller") != NULL) {
-            // We don't have a type for the Nintendo Online NES Controller
-            type = SDL_GAMEPAD_TYPE_STANDARD;
+            /* TODO -- NES gamepad type */
+            type = SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_PRO;
         } else {
             type = SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT;
         }
-
     } else if (vendor == USB_VENDOR_NINTENDO && product == USB_PRODUCT_NINTENDO_SWITCH_JOYCON_GRIP) {
         if (name && SDL_strstr(name, "(L)") != NULL) {
             type = SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_LEFT;
@@ -3098,10 +3097,19 @@ SDL_GamepadType SDL_GetGamepadTypeFromVIDPID(Uint16 vendor, Uint16 product, cons
                (product == USB_PRODUCT_NINTENDO_SWITCH_JOYCON_PAIR ||
                 product == USB_PRODUCT_NINTENDO_SWITCH2_JOYCON_PAIR)) {
         type = SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR;
-
+    } else if (vendor == USB_VENDOR_NINTENDO && product == USB_PRODUCT_NINTENDO_N64_CONTROLLER) {
+        type = SDL_GAMEPAD_TYPE_N64;
+    } else if (vendor == USB_VENDOR_NINTENDO && product == USB_PRODUCT_NINTENDO_SNES_CONTROLLER) {
+        /* TODO -- SNES gamepad type */
+        type = SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_PRO;
+    } else if (vendor == USB_VENDOR_NINTENDO && product == USB_PRODUCT_NINTENDO_SEGA_GENESIS_CONTROLLER) {
+        type = SDL_GAMEPAD_TYPE_SEGA_GENESIS;
+    } else if (vendor == USB_VENDOR_NINTENDO &&
+               (product == USB_PRODUCT_NINTENDO_WII_REMOTE ||
+                product == USB_PRODUCT_NINTENDO_WII_REMOTE2)) {
+        type = SDL_GAMEPAD_TYPE_WII;
     } else if (forUI && SDL_IsJoystickGameCube(vendor, product)) {
         type = SDL_GAMEPAD_TYPE_GAMECUBE;
-
     } else {
         switch (GuessControllerType(vendor, product)) {
         case k_eControllerType_XBox360Controller:

src/joystick/SDL_gamepad_db.h

@@ -411,13 +411,7 @@ static void DeviceDynamicEncodingSetup(SDL_HIDAPI_Device *device)
         break;
     }
 
-    int version = analogStyle;
-    version = (version * (int)SINPUT_BUMPERSTYLE_MAX) + bumperStyle;
-    version = (version * (int)SINPUT_TRIGGERSTYLE_MAX) + triggerStyle;
-    version = (version * (int)SINPUT_PADDLESTYLE_MAX) + paddleStyle;
-    version = (version * (int)SINPUT_METASTYLE_MAX) + metaStyle;
-    version = (version * (int)SINPUT_TOUCHSTYLE_MAX) + touchStyle;
-    version = (version * (int)SINPUT_MISCSTYLE_MAX) + miscStyle;
+    Uint16 version = SINPUT_PACK_VERSION(miscStyle, touchStyle, metaStyle, paddleStyle, triggerStyle, bumperStyle, analogStyle);
 
     // Overwrite our button usage masks
     // with our sanitized masks
@@ -426,8 +420,6 @@ static void DeviceDynamicEncodingSetup(SDL_HIDAPI_Device *device)
     ctx->usage_masks[2] = mask[2];
     ctx->usage_masks[3] = mask[3];
 
-    version = SDL_clamp(version, 0, UINT16_MAX);
-
     // Overwrite 'Version' field of the GUID data
     device->guid.data[12] = (Uint8)(version & 0xFF);
     device->guid.data[13] = (Uint8)(version >> 8);
@@ -460,10 +452,12 @@ static void ProcessSDLFeaturesResponse(SDL_HIDAPI_Device *device, Uint8 *data)
     // The gamepad type represents a style of gamepad that most closely
     // resembles the gamepad in question (Button style, button layout)
     SDL_GamepadType type = SDL_GAMEPAD_TYPE_UNKNOWN;
-    type = (SDL_GamepadType)SDL_clamp(data[4], SDL_GAMEPAD_TYPE_UNKNOWN, SDL_GAMEPAD_TYPE_COUNT);
+    if (data[4] < SDL_GAMEPAD_TYPE_COUNT) {
+        type = (SDL_GamepadType)data[4];
+    }
     device->type = type;
 
-    // The 3 MSB represent a button layout style SDL_GamepadFaceStyle
+    // The 3 MSB represent a face button layout style
     // The 5 LSB represent a device sub-type
     device->guid.data[15] = data[5];
 

src/joystick/SDL_joystick.c

@@ -90,3 +90,15 @@ typedef struct
     Uint16 touch_style;
     Uint16 misc_style;
 } SDL_SInputStyles_t;
+
+/* Pack the seven style enums into a single Uint16
+ * (can fit in the version field of the GUID) */
+#define SINPUT_PACK_VERSION(misc, touch, meta, paddle, trigger, bumper, analog) \
+    ((Uint16)(((((((                                                            \
+        (analog)) * SINPUT_BUMPERSTYLE_MAX +                                    \
+        (bumper)) * SINPUT_TRIGGERSTYLE_MAX +                                   \
+        (trigger)) * SINPUT_PADDLESTYLE_MAX +                                   \
+        (paddle)) * SINPUT_METASTYLE_MAX +                                      \
+        (meta)) * SINPUT_TOUCHSTYLE_MAX +                                       \
+        (touch)) * SINPUT_MISCSTYLE_MAX +                                       \
+        (misc)))

src/joystick/hidapi/SDL_hidapi_sinput.c

@@ -3622,7 +3622,6 @@ char *SetMappingName(char *mapping, const char *name)
     return RecreateMapping(&parts, mapping);
 }
 
-
 const char *GetGamepadTypeString(SDL_GamepadType type)
 {
     switch (type) {
@@ -3636,6 +3635,12 @@ const char *GetGamepadTypeString(SDL_GamepadType type)
         return "PS4";
     case SDL_GAMEPAD_TYPE_PS5:
         return "PS5";
+    case SDL_GAMEPAD_TYPE_N64:
+        return "N64";
+    case SDL_GAMEPAD_TYPE_GAMECUBE:
+        return "GameCube";
+    case SDL_GAMEPAD_TYPE_WII:
+        return "Wii";
     case SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_PRO:
         return "Nintendo Switch";
     case SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_LEFT:
@@ -3644,12 +3649,14 @@ const char *GetGamepadTypeString(SDL_GamepadType type)
         return "Joy-Con (R)";
     case SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR:
         return "Joy-Con Pair";
-    case SDL_GAMEPAD_TYPE_GAMECUBE:
-        return "GameCube";
     case SDL_GAMEPAD_TYPE_STEAM:
         return "Steam";
+    case SDL_GAMEPAD_TYPE_SEGA_GENESIS:
+        return "Sega Genesis";
+    case SDL_GAMEPAD_TYPE_STANDARD:
+        return "Standard";
     default:
-        return "";
+        return "(unknown)";
     }
 }