Added SDL_GAMEPAD_TYPE_GAMECUBE

The GameCube controller has a different face button layout than the Xbox or Nintendo Switch style controllers. It has the B button on the left and the X button on the right, so we should map those to SDL_GAMEPAD_BUTTON_WEST with SDL_GAMEPAD_BUTTON_LABEL_B and SDL_GAMEPAD_BUTTON_EAST with SDL_GAMEPAD_BUTTON_LABEL_X respectively.

Fixes #12847

Author: slouken

include/SDL3/SDL_gamepad.h

@@ -118,6 +118,7 @@ typedef enum SDL_GamepadType
     SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_LEFT,
     SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT,
     SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR,
+    SDL_GAMEPAD_TYPE_GAMECUBE,
     SDL_GAMEPAD_TYPE_COUNT
 } SDL_GamepadType;
 
@@ -127,8 +128,8 @@ typedef enum SDL_GamepadType
  * For controllers that use a diamond pattern for the face buttons, the
  * south/east/west/north buttons below correspond to the locations in the
  * diamond pattern. For Xbox controllers, this would be A/B/X/Y, for Nintendo
- * Switch controllers, this would be B/A/Y/X, for PlayStation controllers this
- * would be Cross/Circle/Square/Triangle.
+ * Switch controllers, this would be B/A/Y/X, for GameCube controllers this
+ * would be A/X/B/Y, for PlayStation controllers this would be Cross/Circle/Square/Triangle.
  *
  * 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

src/joystick/SDL_gamepad.c

@@ -62,6 +62,7 @@ typedef enum
 {
     SDL_GAMEPAD_FACE_STYLE_UNKNOWN,
     SDL_GAMEPAD_FACE_STYLE_ABXY,
+    SDL_GAMEPAD_FACE_STYLE_AXBY,
     SDL_GAMEPAD_FACE_STYLE_BAYX,
     SDL_GAMEPAD_FACE_STYLE_SONY,
 } SDL_GamepadFaceStyle;
@@ -710,7 +711,8 @@ static GamepadMapping_t *SDL_CreateMappingForHIDAPIGamepad(SDL_GUID guid)
     if ((vendor == USB_VENDOR_NINTENDO && product == USB_PRODUCT_NINTENDO_GAMECUBE_ADAPTER) ||
         (vendor == USB_VENDOR_DRAGONRISE &&
          (product == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER1 ||
-          product == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2))) {
+          product == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2 ||
+          product == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER3))) {
         // GameCube driver has 12 buttons and 6 axes
         SDL_strlcat(mapping_string, "a:b0,b:b1,dpdown:b6,dpleft:b4,dpright:b5,dpup:b7,lefttrigger:a4,leftx:a0,lefty:a1~,rightshoulder:b9,righttrigger:a5,rightx:a2,righty:a3~,start:b8,x:b2,y:b3,", sizeof(mapping_string));
     } else if (vendor == USB_VENDOR_NINTENDO &&
@@ -992,7 +994,8 @@ static const char *map_StringForGamepadType[] = {
     "switchpro",
     "joyconleft",
     "joyconright",
-    "joyconpair"
+    "joyconpair",
+    "gamecube"
 };
 SDL_COMPILE_TIME_ASSERT(map_StringForGamepadType, SDL_arraysize(map_StringForGamepadType) == SDL_GAMEPAD_TYPE_COUNT);
 
@@ -1347,6 +1350,8 @@ static SDL_GamepadFaceStyle SDL_GetGamepadFaceStyleFromString(const char *string
 {
     if (SDL_strcmp(string, "abxy") == 0) {
         return SDL_GAMEPAD_FACE_STYLE_ABXY;
+    } else if (SDL_strcmp(string, "axby") == 0) {
+        return SDL_GAMEPAD_FACE_STYLE_AXBY;
     } else if (SDL_strcmp(string, "bayx") == 0) {
         return SDL_GAMEPAD_FACE_STYLE_BAYX;
     } else if (SDL_strcmp(string, "sony") == 0) {
@@ -1368,6 +1373,8 @@ static SDL_GamepadFaceStyle SDL_GetGamepadFaceStyleForGamepadType(SDL_GamepadTyp
     case SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT:
     case SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR:
         return SDL_GAMEPAD_FACE_STYLE_BAYX;
+    case SDL_GAMEPAD_TYPE_GAMECUBE:
+        return SDL_GAMEPAD_FACE_STYLE_AXBY;
     default:
         return SDL_GAMEPAD_FACE_STYLE_ABXY;
     }
@@ -2997,6 +3004,24 @@ static SDL_GamepadButtonLabel SDL_GetGamepadButtonLabelForFaceStyle(SDL_GamepadF
             break;
         }
         break;
+    case SDL_GAMEPAD_FACE_STYLE_AXBY:
+        switch (button) {
+        case SDL_GAMEPAD_BUTTON_SOUTH:
+            label = SDL_GAMEPAD_BUTTON_LABEL_A;
+            break;
+        case SDL_GAMEPAD_BUTTON_EAST:
+            label = SDL_GAMEPAD_BUTTON_LABEL_X;
+            break;
+        case SDL_GAMEPAD_BUTTON_WEST:
+            label = SDL_GAMEPAD_BUTTON_LABEL_B;
+            break;
+        case SDL_GAMEPAD_BUTTON_NORTH:
+            label = SDL_GAMEPAD_BUTTON_LABEL_Y;
+            break;
+        default:
+            break;
+        }
+        break;
     case SDL_GAMEPAD_FACE_STYLE_BAYX:
         switch (button) {
         case SDL_GAMEPAD_BUTTON_SOUTH:

src/joystick/SDL_gamepad_db.h

@@ -479,7 +479,13 @@ static SDL_vidpid_list flightstick_devices = {
 };
 
 static Uint32 initial_gamecube_devices[] = {
+    MAKE_VIDPID(0x0079, 0x1843), // DragonRise GameCube Controller Adapter
+    MAKE_VIDPID(0x0079, 0x1844), // DragonRise GameCube Controller Adapter
+    MAKE_VIDPID(0x0079, 0x1846), // DragonRise GameCube Controller Adapter
+    MAKE_VIDPID(0x057e, 0x0337), // Nintendo Wii U GameCube Controller Adapter
+    MAKE_VIDPID(0x0926, 0x8888), // Cyber Gadget GameCube Controller
     MAKE_VIDPID(0x0e6f, 0x0185), // PDP Wired Fight Pad Pro for Nintendo Switch
+    MAKE_VIDPID(0x1a34, 0xf705), // GameCube {HuiJia USB box}
     MAKE_VIDPID(0x20d6, 0xa711), // PowerA Wired Controller Nintendo GameCube Style
 };
 static SDL_vidpid_list gamecube_devices = {
@@ -2937,8 +2943,7 @@ SDL_GamepadType SDL_GetGamepadTypeFromVIDPID(Uint16 vendor, Uint16 product, cons
         type = SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR;
 
     } else if (forUI && SDL_IsJoystickGameCube(vendor, product)) {
-        // We don't have a type for the Nintendo GameCube controller
-        type = SDL_GAMEPAD_TYPE_STANDARD;
+        type = SDL_GAMEPAD_TYPE_GAMECUBE;
 
     } else {
         switch (GuessControllerType(vendor, product)) {

src/joystick/SDL_joystick.c

@@ -74,7 +74,8 @@ static bool HIDAPI_DriverGameCube_IsSupportedDevice(SDL_HIDAPI_Device *device, c
     }
     if (vendor_id == USB_VENDOR_DRAGONRISE &&
         (product_id == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER1 ||
-         product_id == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2)) {
+         product_id == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2 ||
+         product_id == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER3)) {
         // EVORETRO GameCube Controller Adapter
         return true;
     }
@@ -232,10 +233,10 @@ static void HIDAPI_DriverGameCube_HandleJoystickPacket(SDL_HIDAPI_Device *device
         joystick,                       \
         button,                         \
         ((packet[off] & flag) != 0));
-    READ_BUTTON(1, 0x02, 0) // A
-    READ_BUTTON(1, 0x04, 1) // B
-    READ_BUTTON(1, 0x08, 3) // Y
-    READ_BUTTON(1, 0x01, 2) // X
+    READ_BUTTON(1, 0x02, 0) // SOUTH (A)
+    READ_BUTTON(1, 0x01, 1) // EAST (X)
+    READ_BUTTON(1, 0x04, 2) // WEST (B)
+    READ_BUTTON(1, 0x08, 3) // NORTH (Y)
     READ_BUTTON(2, 0x80, 4) // DPAD_LEFT
     READ_BUTTON(2, 0x20, 5) // DPAD_RIGHT
     READ_BUTTON(2, 0x40, 6) // DPAD_DOWN

src/joystick/hidapi/SDL_hidapi_gamecube.c

@@ -285,6 +285,7 @@ typedef struct
     SDL_HIDAPI_Device *device;
     SDL_Joystick *joystick;
     bool m_bInputOnly;
+    bool m_bGameCube;
     bool m_bUseButtonLabels;
     bool m_bPlayerLights;
     int m_nPlayerIndex;
@@ -1130,7 +1131,20 @@ static Sint16 ApplySimpleStickCalibration(SDL_DriverSwitch_Context *ctx, int nSt
 
 static Uint8 RemapButton(SDL_DriverSwitch_Context *ctx, Uint8 button)
 {
-    if (ctx->m_bUseButtonLabels) {
+    if (ctx->m_bGameCube) {
+        switch (button) {
+        case SDL_GAMEPAD_BUTTON_SOUTH:
+            return SDL_GAMEPAD_BUTTON_WEST;
+        case SDL_GAMEPAD_BUTTON_EAST:
+            return SDL_GAMEPAD_BUTTON_SOUTH;
+        case SDL_GAMEPAD_BUTTON_WEST:
+            return SDL_GAMEPAD_BUTTON_NORTH;
+        case SDL_GAMEPAD_BUTTON_NORTH:
+            return SDL_GAMEPAD_BUTTON_EAST;
+        default:
+            break;
+        }
+    } else if (ctx->m_bUseButtonLabels) {
         // Use button labels instead of positions, e.g. Nintendo Online Classic controllers
         switch (button) {
         case SDL_GAMEPAD_BUTTON_SOUTH:
@@ -1232,9 +1246,6 @@ static bool HasHomeLED(SDL_DriverSwitch_Context *ctx)
 static bool AlwaysUsesLabels(Uint16 vendor_id, Uint16 product_id, ESwitchDeviceInfoControllerType eControllerType)
 {
     // Some controllers don't have a diamond button configuration, so should always use labels
-    if (SDL_IsJoystickGameCube(vendor_id, product_id)) {
-        return true;
-    }
     switch (eControllerType) {
     case k_eSwitchDeviceInfoControllerType_HVCLeft:
     case k_eSwitchDeviceInfoControllerType_HVCRight:
@@ -1367,7 +1378,7 @@ static void UpdateDeviceIdentity(SDL_HIDAPI_Device *device)
 
     if (ctx->m_bInputOnly) {
         if (SDL_IsJoystickGameCube(device->vendor_id, device->product_id)) {
-            device->type = SDL_GAMEPAD_TYPE_STANDARD;
+            device->type = SDL_GAMEPAD_TYPE_GAMECUBE;
         }
     } else {
         char serial[18];
@@ -1590,7 +1601,9 @@ static bool HIDAPI_DriverSwitch_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joys
         }
     }
 
-    if (AlwaysUsesLabels(device->vendor_id, device->product_id, ctx->m_eControllerType)) {
+    if (SDL_IsJoystickGameCube(device->vendor_id, device->product_id)) {
+        ctx->m_bGameCube = true;
+    } else if (AlwaysUsesLabels(device->vendor_id, device->product_id, ctx->m_eControllerType)) {
         ctx->m_bUseButtonLabels = true;
     }
 

src/joystick/hidapi/SDL_hidapi_switch.c

@@ -66,7 +66,8 @@
 #define USB_PRODUCT_BACKBONE_ONE_IOS_PS5                  0x0104
 #define USB_PRODUCT_GOOGLE_STADIA_CONTROLLER              0x9400
 #define USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER1            0x1843
-#define USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2            0x1846
+#define USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2            0x1844
+#define USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER3            0x1846
 #define USB_PRODUCT_HORI_FIGHTING_STICK_ALPHA_PS4         0x011c
 #define USB_PRODUCT_HORI_FIGHTING_STICK_ALPHA_PS5         0x0184
 #define USB_PRODUCT_HORI_FIGHTING_STICK_ALPHA_PS5         0x0184