From dfc6e8825ebcb82297c4fc2a55f49fc18f527047 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Tue, 18 Jul 2023 11:52:56 -0700
Subject: [PATCH] Improved reliability of gamepad message ordering
The gamepad vs joystick events always happen in this order:
SDL_EVENT_JOYSTICK_ADDED
SDL_EVENT_GAMEPAD_ADDED
SDL_EVENT_GAMEPAD_REMAPPED
SDL_EVENT_GAMEPAD_REMOVED
SDL_EVENT_JOYSTICK_REMOVED
Whenever a mapping is changed, any controller affected by that mapping will generate a gamepad event. You will only get one SDL_EVENT_GAMEPAD_REMAPPED event per controller per batch of mapping changes, where SDL_AddGamepadMappingsFromFile() and SDL_AddGamepadMapping() are each a batch of changes.
---
src/joystick/SDL_gamepad.c | 305 +++++++++++++++++++++++-----------
src/joystick/SDL_gamepad_c.h | 2 +
src/joystick/SDL_joystick.c | 23 ++-
src/joystick/SDL_joystick_c.h | 1 +
test/testcontroller.c | 175 +++++++++++--------
5 files changed, 342 insertions(+), 164 deletions(-)
diff --git a/src/joystick/SDL_gamepad.c b/src/joystick/SDL_gamepad.c
index 3147caa07a8a..5c6cb469f183 100644
--- a/src/joystick/SDL_gamepad.c
+++ b/src/joystick/SDL_gamepad.c
@@ -54,7 +54,7 @@
#define SDL_GAMEPAD_SDKLE_FIELD "sdk<=:"
#define SDL_GAMEPAD_SDKLE_FIELD_SIZE SDL_strlen(SDL_GAMEPAD_SDKLE_FIELD)
-/* a list of currently opened gamepads */
+static SDL_bool SDL_gamepads_initialized;
static SDL_Gamepad *SDL_gamepads SDL_GUARDED_BY(SDL_joystick_lock) = NULL;
typedef enum
@@ -122,12 +122,24 @@ typedef struct GamepadMapping_t
struct GamepadMapping_t *next _guarded;
} GamepadMapping_t;
+typedef struct
+{
+ int refcount _guarded;
+ SDL_JoystickID *joysticks _guarded;
+ GamepadMapping_t **joystick_mappings _guarded;
+
+ int num_changed_mappings _guarded;
+ GamepadMapping_t **changed_mappings _guarded;
+
+} MappingChangeTracker;
+
#undef _guarded
static SDL_JoystickGUID s_zeroGUID;
static GamepadMapping_t *s_pSupportedGamepads SDL_GUARDED_BY(SDL_joystick_lock) = NULL;
static GamepadMapping_t *s_pDefaultMapping SDL_GUARDED_BY(SDL_joystick_lock) = NULL;
static GamepadMapping_t *s_pXInputMapping SDL_GUARDED_BY(SDL_joystick_lock) = NULL;
+static MappingChangeTracker s_mappingChangeTracker;
static char gamepad_magic;
#define _guarded SDL_GUARDED_BY(SDL_joystick_lock)
@@ -174,30 +186,12 @@ static void SDLCALL SDL_GamepadIgnoreDevicesExceptChanged(void *userdata, const
SDL_LoadVIDPIDListFromHint(hint, &SDL_allowed_gamepads);
}
-static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, const char *mappingString, SDL_bool *existing, SDL_GamepadMappingPriority priority, SDL_bool send_event);
+static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, const char *mappingString, SDL_bool *existing, SDL_GamepadMappingPriority priority);
+static void SDL_PrivateLoadButtonMapping(SDL_Gamepad *gamepad, GamepadMapping_t *pGamepadMapping);
+static GamepadMapping_t *SDL_PrivateGetGamepadMapping(SDL_JoystickID instance_id);
static int SDL_SendGamepadAxis(Uint64 timestamp, SDL_Gamepad *gamepad, SDL_GamepadAxis axis, Sint16 value);
static int SDL_SendGamepadButton(Uint64 timestamp, SDL_Gamepad *gamepad, SDL_GamepadButton button, Uint8 state);
-static void SDL_PrivateGamepadAdded(SDL_JoystickID instance_id)
-{
- SDL_Event event;
-
- event.type = SDL_EVENT_GAMEPAD_ADDED;
- event.common.timestamp = 0;
- event.gdevice.which = instance_id;
- SDL_PushEvent(&event);
-}
-
-static void SDL_PrivateGamepadRemoved(SDL_JoystickID instance_id)
-{
- SDL_Event event;
-
- event.type = SDL_EVENT_GAMEPAD_REMOVED;
- event.common.timestamp = 0;
- event.gdevice.which = instance_id;
- SDL_PushEvent(&event);
-}
-
static SDL_bool HasSameOutput(SDL_GamepadBinding *a, SDL_GamepadBinding *b)
{
if (a->outputType != b->outputType) {
@@ -349,6 +343,56 @@ static void RecenterGamepad(SDL_Gamepad *gamepad)
}
}
+void SDL_PrivateGamepadAdded(SDL_JoystickID instance_id)
+{
+ SDL_Event event;
+
+ if (!SDL_gamepads_initialized) {
+ return;
+ }
+
+ event.type = SDL_EVENT_GAMEPAD_ADDED;
+ event.common.timestamp = 0;
+ event.gdevice.which = instance_id;
+ SDL_PushEvent(&event);
+}
+
+void SDL_PrivateGamepadRemoved(SDL_JoystickID instance_id)
+{
+ SDL_Event event;
+ SDL_Gamepad *gamepad;
+
+ if (!SDL_gamepads_initialized) {
+ return;
+ }
+
+ for (gamepad = SDL_gamepads; gamepad; gamepad = gamepad->next) {
+ if (gamepad->joystick->instance_id == instance_id) {
+ RecenterGamepad(gamepad);
+ break;
+ }
+ }
+
+ event.type = SDL_EVENT_GAMEPAD_REMOVED;
+ event.common.timestamp = 0;
+ event.gdevice.which = instance_id;
+ SDL_PushEvent(&event);
+}
+
+static void SDL_PrivateGamepadRemapped(SDL_JoystickID instance_id)
+{
+ SDL_Event event;
+
+ if (!SDL_gamepads_initialized || SDL_IsJoystickBeingAdded()) {
+ return;
+ }
+
+ event.type = SDL_EVENT_GAMEPAD_REMAPPED;
+ event.common.timestamp = 0;
+ event.gdevice.which = instance_id;
+ SDL_PushEvent(&event);
+}
+
/*
* Event filter to fire gamepad events from joystick ones
*/
@@ -391,27 +435,6 @@ static int SDLCALL SDL_GamepadEventWatcher(void *userdata, SDL_Event *event)
}
}
} break;
- case SDL_EVENT_JOYSTICK_ADDED:
- {
- if (SDL_IsGamepad(event->jdevice.which)) {
- SDL_PrivateGamepadAdded(event->jdevice.which);
- }
- } break;
- case SDL_EVENT_JOYSTICK_REMOVED:
- {
- SDL_AssertJoysticksLocked();
-
- for (gamepad = SDL_gamepads; gamepad; gamepad = gamepad->next) {
- if (gamepad->joystick->instance_id == event->jdevice.which) {
- RecenterGamepad(gamepad);
- break;
- }
- }
-
- if (SDL_IsGamepad(event->jdevice.which)) {
- SDL_PrivateGamepadRemoved(event->jdevice.which);
- }
- } break;
case SDL_EVENT_JOYSTICK_UPDATE_COMPLETE:
{
SDL_AssertJoysticksLocked();
@@ -481,6 +504,106 @@ void SDL_GamepadSensorWatcher(Uint64 timestamp, SDL_SensorID sensor, Uint64 sens
SDL_UnlockJoysticks();
}
+static void PushMappingChangeTracking(void)
+{
+ int i, num_joysticks;
+
+ SDL_AssertJoysticksLocked();
+
+ ++s_mappingChangeTracker.refcount;
+ if (s_mappingChangeTracker.refcount > 1) {
+ return;
+ }
+
+ /* Save the list of joysticks and associated mappings */
+ s_mappingChangeTracker.joysticks = SDL_GetJoysticks(&num_joysticks);
+ if (!s_mappingChangeTracker.joysticks) {
+ return;
+ }
+ if (num_joysticks == 0) {
+ return;
+ }
+ s_mappingChangeTracker.joystick_mappings = (GamepadMapping_t **)SDL_malloc(num_joysticks * sizeof(*s_mappingChangeTracker.joystick_mappings));
+ if (!s_mappingChangeTracker.joystick_mappings) {
+ return;
+ }
+ for (i = 0; i < num_joysticks; ++i) {
+ s_mappingChangeTracker.joystick_mappings[i] = SDL_PrivateGetGamepadMapping(s_mappingChangeTracker.joysticks[i]);
+ }
+}
+
+static void AddMappingChangeTracking(GamepadMapping_t *mapping)
+{
+ int num_mappings;
+ GamepadMapping_t **new_mappings;
+
+ num_mappings = s_mappingChangeTracker.num_changed_mappings;
+ new_mappings = (GamepadMapping_t **)SDL_realloc(s_mappingChangeTracker.changed_mappings, (num_mappings + 1) * sizeof(*new_mappings));
+ if (new_mappings) {
+ s_mappingChangeTracker.changed_mappings = new_mappings;
+ s_mappingChangeTracker.changed_mappings[num_mappings] = mapping;
+ s_mappingChangeTracker.num_changed_mappings = (num_mappings + 1);
+ }
+}
+
+static SDL_bool HasMappingChangeTracking(GamepadMapping_t *mapping)
+{
+ int i;
+
+ for (i = 0; i < s_mappingChangeTracker.num_changed_mappings; ++i) {
+ if (s_mappingChangeTracker.changed_mappings[i] == mapping) {
+ return SDL_TRUE;
+ }
+ }
+ return SDL_FALSE;
+}
+
+static void PopMappingChangeTracking(void)
+{
+ int i;
+
+ SDL_assert(s_mappingChangeTracker.refcount > 0);
+ --s_mappingChangeTracker.refcount;
+ if (s_mappingChangeTracker.refcount > 0) {
+ return;
+ }
+
+ /* Now check to see what gamepads changed because of the mapping changes */
+ if (s_mappingChangeTracker.joysticks && s_mappingChangeTracker.joystick_mappings) {
+ for (i = 0; s_mappingChangeTracker.joysticks[i]; ++i) {
+ SDL_JoystickID joystick = s_mappingChangeTracker.joysticks[i];
+ GamepadMapping_t *old_mapping = s_mappingChangeTracker.joystick_mappings[i];
+ GamepadMapping_t *new_mapping = SDL_PrivateGetGamepadMapping(joystick);
+ SDL_Gamepad *gamepad = SDL_GetGamepadFromInstanceID(joystick);
+
+ if (new_mapping && !old_mapping) {
+ SDL_PrivateGamepadAdded(joystick);
+ } else if (old_mapping && !new_mapping) {
+ SDL_PrivateGamepadRemoved(joystick);
+ } else if (old_mapping != new_mapping || HasMappingChangeTracking(new_mapping)) {
+ if (gamepad) {
+ SDL_PrivateLoadButtonMapping(gamepad, new_mapping);
+ }
+ SDL_PrivateGamepadRemapped(joystick);
+ }
+ }
+ }
+
+ if (s_mappingChangeTracker.joysticks) {
+ SDL_free(s_mappingChangeTracker.joysticks);
+ s_mappingChangeTracker.joysticks = NULL;
+ }
+ if (s_mappingChangeTracker.joystick_mappings) {
+ SDL_free(s_mappingChangeTracker.joystick_mappings);
+ s_mappingChangeTracker.joystick_mappings = NULL;
+ }
+ if (s_mappingChangeTracker.changed_mappings) {
+ SDL_free(s_mappingChangeTracker.changed_mappings);
+ s_mappingChangeTracker.changed_mappings = NULL;
+ }
+ s_mappingChangeTracker.num_changed_mappings = 0;
+}
+
#ifdef __ANDROID__
/*
* Helper function to guess at a mapping based on the elements reported for this gamepad
@@ -580,7 +703,7 @@ static GamepadMapping_t *SDL_CreateMappingForAndroidGamepad(SDL_JoystickGUID gui
SDL_strlcat(mapping_string, "righttrigger:a5,", sizeof(mapping_string));
}
- return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT, SDL_TRUE);
+ return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
}
#endif /* __ANDROID__ */
@@ -723,7 +846,7 @@ static GamepadMapping_t *SDL_CreateMappingForHIDAPIGamepad(SDL_JoystickGUID guid
}
}
- return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT, SDL_TRUE);
+ return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
}
/*
@@ -737,7 +860,7 @@ static GamepadMapping_t *SDL_CreateMappingForRAWINPUTGamepad(SDL_JoystickGUID gu
SDL_strlcpy(mapping_string, "none,*,", sizeof(mapping_string));
SDL_strlcat(mapping_string, "a:b0,b:b1,x:b2,y:b3,back:b6,guide:b10,start:b7,leftstick:b8,rightstick:b9,leftshoulder:b4,rightshoulder:b5,dpup:h0.1,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:a4,righttrigger:a5,", sizeof(mapping_string));
- return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT, SDL_TRUE);
+ return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
}
/*
@@ -755,7 +878,7 @@ static GamepadMapping_t *SDL_CreateMappingForWGIGamepad(SDL_JoystickGUID guid)
SDL_strlcpy(mapping_string, "none,*,", sizeof(mapping_string));
SDL_strlcat(mapping_string, "a:b0,b:b1,x:b2,y:b3,back:b6,start:b7,leftstick:b8,rightstick:b9,leftshoulder:b4,rightshoulder:b5,dpup:b10,dpdown:b12,dpleft:b13,dpright:b11,leftx:a1,lefty:a0~,rightx:a3,righty:a2~,lefttrigger:a4,righttrigger:a5,", sizeof(mapping_string));
- return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT, SDL_TRUE);
+ return SDL_PrivateAddMappingForGUID(guid, mapping_string, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
}
/*
@@ -1286,40 +1409,10 @@ static char *SDL_PrivateGetGamepadMappingFromMappingString(const char *pMapping)
return SDL_strdup(pSecondComma + 1); /* mapping is everything after the 3rd comma */
}
-static void SDL_SendGamepadRemappedEvent(SDL_JoystickID instance_id)
-{
- SDL_Event event;
-
- event.type = SDL_EVENT_GAMEPAD_REMAPPED;
- event.common.timestamp = 0;
- event.gdevice.which = instance_id;
- SDL_PushEvent(&event);
-}
-
-/*
- * Helper function to refresh a mapping
- */
-static void SDL_PrivateRefreshGamepadMapping(GamepadMapping_t *pGamepadMapping, SDL_bool send_event)
-{
- SDL_Gamepad *gamepad;
-
- SDL_AssertJoysticksLocked();
-
- for (gamepad = SDL_gamepads; gamepad; gamepad = gamepad->next) {
- if (gamepad->mapping == pGamepadMapping) {
- SDL_PrivateLoadButtonMapping(gamepad, pGamepadMapping);
-
- if (send_event) {
- SDL_SendGamepadRemappedEvent(gamepad->joystick->instance_id);
- }
- }
- }
-}
-
/*
* Helper function to add a mapping for a guid
*/
-static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, const char *mappingString, SDL_bool *existing, SDL_GamepadMappingPriority priority, SDL_bool send_event)
+static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, const char *mappingString, SDL_bool *existing, SDL_GamepadMappingPriority priority)
{
char *pchName;
char *pchMapping;
@@ -1373,6 +1466,8 @@ static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, co
}
}
+ PushMappingChangeTracking();
+
pGamepadMapping = SDL_PrivateGetGamepadMappingForGUID(jGUID, SDL_TRUE);
if (pGamepadMapping) {
/* Only overwrite the mapping if the priority is the same or higher. */
@@ -1383,8 +1478,6 @@ static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, co
SDL_free(pGamepadMapping->mapping);
pGamepadMapping->mapping = pchMapping;
pGamepadMapping->priority = priority;
- /* refresh open gamepads */
- SDL_PrivateRefreshGamepadMapping(pGamepadMapping, send_event);
} else {
SDL_free(pchName);
SDL_free(pchMapping);
@@ -1392,9 +1485,11 @@ static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, co
if (existing) {
*existing = SDL_TRUE;
}
+ AddMappingChangeTracking(pGamepadMapping);
} else {
pGamepadMapping = SDL_malloc(sizeof(*pGamepadMapping));
if (pGamepadMapping == NULL) {
+ PopMappingChangeTracking();
SDL_free(pchName);
SDL_free(pchMapping);
SDL_OutOfMemory();
@@ -1427,6 +1522,9 @@ static GamepadMapping_t *SDL_PrivateAddMappingForGUID(SDL_JoystickGUID jGUID, co
*existing = SDL_FALSE;
}
}
+
+ PopMappingChangeTracking();
+
return pGamepadMapping;
}
@@ -1447,7 +1545,7 @@ static GamepadMapping_t *SDL_PrivateGetGamepadMappingForNameAndGUID(const char *
SDL_bool existing;
mapping = SDL_PrivateAddMappingForGUID(guid,
"none,X360 Wireless Controller,a:b0,b:b1,back:b6,dpdown:b14,dpleft:b11,dpright:b12,dpup:b13,guide:b8,leftshoulder:b4,leftstick:b9,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b5,rightstick:b10,righttrigger:a5,rightx:a3,righty:a4,start:b7,x:b2,y:b3,",
- &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT, SDL_TRUE);
+ &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
}
}
#endif /* __LINUX__ */
@@ -1534,7 +1632,7 @@ static GamepadMapping_t *SDL_PrivateGenerateAutomaticGamepadMapping(const char *
SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "lefttrigger", &raw_map->lefttrigger);
SDL_PrivateAppendToMappingString(mapping, sizeof(mapping), "righttrigger", &raw_map->righttrigger);
- return SDL_PrivateAddMappingForGUID(guid, mapping, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT, SDL_TRUE);
+ return SDL_PrivateAddMappingForGUID(guid, mapping, &existing, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
}
static GamepadMapping_t *SDL_PrivateGetGamepadMapping(SDL_JoystickID instance_id)
@@ -1599,6 +1697,8 @@ int SDL_AddGamepadMappingsFromRW(SDL_RWops *rw, int freerw)
buf[db_size] = '\0';
line = buf;
+ PushMappingChangeTracking();
+
while (line < buf + db_size) {
line_end = SDL_strchr(line, '\n');
if (line_end != NULL) {
@@ -1627,6 +1727,8 @@ int SDL_AddGamepadMappingsFromRW(SDL_RWops *rw, int freerw)
line = line_end + 1;
}
+ PopMappingChangeTracking();
+
SDL_free(buf);
return gamepads;
}
@@ -1723,7 +1825,7 @@ static int SDL_PrivateAddGamepadMapping(const char *mappingString, SDL_GamepadMa
jGUID = SDL_GetJoystickGUIDFromString(pchGUID);
SDL_free(pchGUID);
- pGamepadMapping = SDL_PrivateAddMappingForGUID(jGUID, mappingString, &existing, priority, SDL_TRUE);
+ pGamepadMapping = SDL_PrivateAddMappingForGUID(jGUID, mappingString, &existing, priority);
if (pGamepadMapping == NULL) {
return -1;
}
@@ -1919,8 +2021,7 @@ int SDL_SetGamepadMapping(SDL_JoystickID instance_id, const char *mapping)
SDL_LockJoysticks();
{
- if (SDL_PrivateAddMappingForGUID(guid, mapping, NULL, SDL_GAMEPAD_MAPPING_PRIORITY_API, SDL_FALSE)) {
- SDL_SendGamepadRemappedEvent(instance_id);
+ if (SDL_PrivateAddMappingForGUID(guid, mapping, NULL, SDL_GAMEPAD_MAPPING_PRIORITY_API)) {
retval = 0;
}
}
@@ -1933,11 +2034,11 @@ static void SDL_LoadGamepadHints(void)
{
const char *hint = SDL_GetHint(SDL_HINT_GAMECONTROLLERCONFIG);
if (hint && hint[0]) {
- size_t nchHints = SDL_strlen(hint);
- char *pUserMappings = SDL_malloc(nchHints + 1);
- char *pTempMappings = pUserMappings;
- SDL_memcpy(pUserMappings, hint, nchHints);
- pUserMappings[nchHints] = '\0';
+ char *pTempMappings = SDL_strdup(hint);
+ char *pUserMappings = pTempMappings;
+
+ PushMappingChangeTracking();
+
while (pUserMappings) {
char *pchNewLine = NULL;
@@ -1954,6 +2055,9 @@ static void SDL_LoadGamepadHints(void)
pUserMappings = NULL;
}
}
+
+ PopMappingChangeTracking();
+
SDL_free(pTempMappings);
}
}
@@ -1988,6 +2092,8 @@ int SDL_InitGamepadMappings(void)
SDL_AssertJoysticksLocked();
+ PushMappingChangeTracking();
+
pMappingString = s_GamepadMappings[i];
while (pMappingString) {
SDL_PrivateAddGamepadMapping(pMappingString, SDL_GAMEPAD_MAPPING_PRIORITY_DEFAULT);
@@ -2008,6 +2114,8 @@ int SDL_InitGamepadMappings(void)
SDL_AddHintCallback(SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT,
SDL_GamepadIgnoreDevicesExceptChanged, NULL);
+ PopMappingChangeTracking();
+
return 0;
}
@@ -2016,6 +2124,8 @@ int SDL_InitGamepads(void)
int i;
SDL_JoystickID *joysticks;
+ SDL_gamepads_initialized = SDL_TRUE;
+
/* Watch for joystick events and fire gamepad ones if needed */
SDL_AddEventWatch(SDL_GamepadEventWatcher, NULL);
@@ -2024,11 +2134,7 @@ int SDL_InitGamepads(void)
if (joysticks) {
for (i = 0; joysticks[i]; ++i) {
if (SDL_IsGamepad(joysticks[i])) {
- SDL_Event deviceevent;
- deviceevent.type = SDL_EVENT_GAMEPAD_ADDED;
- deviceevent.common.timestamp = 0;
- deviceevent.gdevice.which = joysticks[i];
- SDL_PushEvent(&deviceevent);
+ SDL_PrivateGamepadAdded(joysticks[i]);
}
}
SDL_free(joysticks);
@@ -3143,12 +3249,19 @@ void SDL_CloseGamepad(SDL_Gamepad *gamepad)
*/
void SDL_QuitGamepads(void)
{
+ SDL_Gamepad *gamepad;
+
SDL_LockJoysticks();
+ for (gamepad = SDL_gamepads; gamepad; gamepad = gamepad->next) {
+ SDL_PrivateGamepadRemoved(gamepad->joystick->instance_id);
+ }
+
+ SDL_gamepads_initialized = SDL_FALSE;
+
SDL_DelEventWatch(SDL_GamepadEventWatcher, NULL);
while (SDL_gamepads) {
- SDL_PrivateGamepadRemoved(SDL_gamepads->joystick->instance_id);
SDL_gamepads->ref_count = 1;
SDL_CloseGamepad(SDL_gamepads);
}
diff --git a/src/joystick/SDL_gamepad_c.h b/src/joystick/SDL_gamepad_c.h
index d7472db5088d..113be066a34f 100644
--- a/src/joystick/SDL_gamepad_c.h
+++ b/src/joystick/SDL_gamepad_c.h
@@ -32,6 +32,8 @@ extern void SDL_QuitGamepadMappings(void);
extern int SDL_InitGamepads(void);
extern void SDL_QuitGamepads(void);
+extern void SDL_PrivateGamepadAdded(SDL_JoystickID instance_id);
+extern void SDL_PrivateGamepadRemoved(SDL_JoystickID instance_id);
/* Function to return whether a joystick name and GUID is a gamepad */
extern SDL_bool SDL_IsGamepadNameAndGUID(const char *name, SDL_JoystickGUID guid);
diff --git a/src/joystick/SDL_joystick.c b/src/joystick/SDL_joystick.c
index 4fcd547a618a..9702a936bdc4 100644
--- a/src/joystick/SDL_joystick.c
+++ b/src/joystick/SDL_joystick.c
@@ -113,7 +113,8 @@ SDL_Mutex *SDL_joystick_lock = NULL; /* This needs to support recursive locks */
static SDL_AtomicInt SDL_joystick_lock_pending;
static int SDL_joysticks_locked;
static SDL_bool SDL_joysticks_initialized;
-static SDL_bool SDL_joysticks_quitting = SDL_FALSE;
+static SDL_bool SDL_joysticks_quitting;
+static SDL_bool SDL_joystick_being_added;
static SDL_Joystick *SDL_joysticks SDL_GUARDED_BY(SDL_joystick_lock) = NULL;
static SDL_AtomicInt SDL_last_joystick_instance_id SDL_GUARDED_BY(SDL_joystick_lock);
static int SDL_joystick_player_count SDL_GUARDED_BY(SDL_joystick_lock) = 0;
@@ -1621,6 +1622,8 @@ void SDL_PrivateJoystickAdded(SDL_JoystickID instance_id)
return;
}
+ SDL_joystick_being_added = SDL_TRUE;
+
if (SDL_GetDriverAndJoystickIndex(instance_id, &driver, &device_index)) {
player_index = driver->GetDevicePlayerIndex(device_index);
}
@@ -1644,6 +1647,17 @@ void SDL_PrivateJoystickAdded(SDL_JoystickID instance_id)
}
}
#endif /* !SDL_EVENTS_DISABLED */
+
+ SDL_joystick_being_added = SDL_FALSE;
+
+ if (SDL_IsGamepad(instance_id)) {
+ SDL_PrivateGamepadAdded(instance_id);
+ }
+}
+
+SDL_bool SDL_IsJoystickBeingAdded(void)
+{
+ return SDL_joystick_being_added;
}
void SDL_PrivateJoystickForceRecentering(SDL_Joystick *joystick)
@@ -1696,6 +1710,13 @@ void SDL_PrivateJoystickRemoved(SDL_JoystickID instance_id)
}
}
+ /* FIXME: The driver no longer provides the name and GUID at this point, so we
+ * don't know whether this was a gamepad. For now always send the event.
+ */
+ if (SDL_TRUE /*SDL_IsGamepad(instance_id)*/) {
+ SDL_PrivateGamepadRemoved(instance_id);
+ }
+
#ifndef SDL_EVENTS_DISABLED
event.type = SDL_EVENT_JOYSTICK_REMOVED;
event.common.timestamp = 0;
diff --git a/src/joystick/SDL_joystick_c.h b/src/joystick/SDL_joystick_c.h
index 5a3f89f923f6..6a4afaeab15f 100644
--- a/src/joystick/SDL_joystick_c.h
+++ b/src/joystick/SDL_joystick_c.h
@@ -145,6 +145,7 @@ extern SDL_bool SDL_ShouldIgnoreJoystick(const char *name, SDL_JoystickGUID guid
extern void SDL_PrivateJoystickAddTouchpad(SDL_Joystick *joystick, int nfingers);
extern void SDL_PrivateJoystickAddSensor(SDL_Joystick *joystick, SDL_SensorType type, float rate);
extern void SDL_PrivateJoystickAdded(SDL_JoystickID instance_id);
+extern SDL_bool SDL_IsJoystickBeingAdded(void);
extern void SDL_PrivateJoystickRemoved(SDL_JoystickID instance_id);
extern void SDL_PrivateJoystickForceRecentering(SDL_Joystick *joystick);
extern int SDL_SendJoystickAxis(Uint64 timestamp, SDL_Joystick *joystick,
diff --git a/test/testcontroller.c b/test/testcontroller.c
index 4e05d31fb9c0..ed76483b6440 100644
--- a/test/testcontroller.c
+++ b/test/testcontroller.c
@@ -770,18 +770,100 @@ static void SetController(SDL_JoystickID id)
RefreshControllerName();
}
+static void AddController(SDL_JoystickID id, SDL_bool verbose)
+{
+ Controller *new_controllers;
+ Controller *new_controller;
+ SDL_Joystick *joystick;
+
+ if (FindController(id) >= 0) {
+ /* We already have this controller */
+ return;
+ }
+
+ new_controllers = (Controller *)SDL_realloc(controllers, (num_controllers + 1) * sizeof(*controllers));
+ if (new_controllers == NULL) {
+ return;
+ }
+
+ controller = NULL;
+ controllers = new_controllers;
+ new_controller = &new_controllers[num_controllers++];
+ SDL_zerop(new_controller);
+ new_controller->id = id;
+
+ new_controller->joystick = SDL_OpenJoystick(id);
+ new_controller->num_axes = SDL_GetNumJoystickAxes(new_controller->joystick);
+ new_controller->axis_state = (AxisState *)SDL_calloc(new_controller->num_axes, sizeof(*new_controller->axis_state));
+
+ joystick = new_controller->joystick;
+ if (joystick) {
+ if (verbose && !SDL_IsGamepad(id)) {
+ const char *name = SDL_GetJoystickName(new_controller->joystick);
+ const char *path = SDL_GetJoystickPath(new_controller->joystick);
+ SDL_Log("Opened joystick %s%s%s\n", name, path ? ", " : "", path ? path : "");
+ }
+ } else {
+ SDL_Log("Couldn't open joystick: %s", SDL_GetError());
+ }
+
+ if (mapping_controller) {
+ SetController(mapping_controller);
+ } else {
+ SetController(id);
+ }
+}
+
+static void DelController(SDL_JoystickID id)
+{
+ int i = FindController(id);
+
+ if (i < 0) {
+ return;
+ }
+
+ if (display_mode == CONTROLLER_MODE_BINDING && id == controller->id) {
+ SetDisplayMode(CONTROLLER_MODE_TESTING);
+ }
+
+ /* Reset trigger state */
+ if (controllers[i].trigger_effect != 0) {
+ controllers[i].trigger_effect = -1;
+ CyclePS5TriggerEffect(&controllers[i]);
+ }
+ SDL_assert(controllers[i].gamepad == NULL);
+ if (controllers[i].axis_state) {
+ SDL_free(controllers[i].axis_state);
+ }
+ if (controllers[i].joystick) {
+ SDL_CloseJoystick(controllers[i].joystick);
+ }
+
+ --num_controllers;
+ if (i < num_controllers) {
+ SDL_memcpy(&controllers[i], &controllers[i + 1], (num_controllers - i) * sizeof(*controllers));
+ }
+
+ if (mapping_controller) {
+ SetController(mapping_controller);
+ } else {
+ SetController(id);
+ }
+}
+
static void HandleGamepadRemapped(SDL_JoystickID id)
{
char *mapping;
int i = FindController(id);
+ SDL_assert(i >= 0);
if (i < 0) {
return;
}
if (!controllers[i].gamepad) {
- controllers[i].gamepad = SDL_OpenGamepad(id);
- RefreshControllerName();
+ /* Failed to open this controller */
+ return;
}
/* Get the current mapping */
@@ -797,10 +879,9 @@ static void HandleGamepadRemapped(SDL_JoystickID id)
controllers[i].has_bindings = MappingHasBindings(mapping);
}
-static void AddController(SDL_JoystickID id, SDL_bool verbose)
+static void HandleGamepadAdded(SDL_JoystickID id, SDL_bool verbose)
{
- Controller *new_controllers;
- Controller *new_controller;
+ SDL_Gamepad *gamepad;
Uint16 firmware_version;
SDL_SensorType sensors[] = {
SDL_SENSOR_ACCEL,
@@ -810,33 +891,20 @@ static void AddController(SDL_JoystickID id, SDL_bool verbose)
SDL_SENSOR_ACCEL_R,
SDL_SENSOR_GYRO_R
};
- unsigned int i;
+ int i;
- if (FindController(id) >= 0) {
- /* We already have this controller */
- return;
- }
+ i = FindController(id);
- new_controllers = (Controller *)SDL_realloc(controllers, (num_controllers + 1) * sizeof(*controllers));
- if (new_controllers == NULL) {
+ SDL_assert(i >= 0);
+ if (i < 0) {
return;
}
- controller = NULL;
- controllers = new_controllers;
- new_controller = &new_controllers[num_controllers++];
- SDL_zerop(new_controller);
- new_controller->id = id;
-
- new_controller->joystick = SDL_OpenJoystick(id);
- new_controller->num_axes = SDL_GetNumJoystickAxes(new_controller->joystick);
- new_controller->axis_state = (AxisState *)SDL_calloc(new_controller->num_axes, sizeof(*new_controller->axis_state));
-
- new_controller->gamepad = SDL_OpenGamepad(id);
-
- if (new_controller->gamepad) {
- SDL_Gamepad *gamepad = new_controller->gamepad;
+ SDL_assert(!controllers[i].gamepad);
+ controllers[i].gamepad = SDL_OpenGamepad(id);
+ gamepad = controllers[i].gamepad;
+ if (gamepad) {
if (verbose) {
const char *name = SDL_GetGamepadName(gamepad);
const char *path = SDL_GetGamepadPath(gamepad);
@@ -867,64 +935,28 @@ static void AddController(SDL_JoystickID id, SDL_bool verbose)
}
}
} else {
- SDL_Joystick *joystick = new_controller->joystick;
-
- if (verbose) {
- const char *name = SDL_GetJoystickName(joystick);
- const char *path = SDL_GetJoystickPath(joystick);
- SDL_Log("Opened joystick %s%s%s\n", name, path ? ", " : "", path ? path : "");
- }
- }
-
- if (mapping_controller) {
- SetController(mapping_controller);
- } else {
- SetController(id);
+ SDL_Log("Couldn't open gamepad: %s", SDL_GetError());
}
- /* Update the binding state */
HandleGamepadRemapped(id);
}
-static void DelController(SDL_JoystickID id)
+static void HandleGamepadRemoved(SDL_JoystickID id)
{
int i = FindController(id);
+ SDL_assert(i >= 0);
if (i < 0) {
return;
}
- if (display_mode == CONTROLLER_MODE_BINDING && id == controller->id) {
- SetDisplayMode(CONTROLLER_MODE_TESTING);
- }
-
- /* Reset trigger state */
- if (controllers[i].trigger_effect != 0) {
- controllers[i].trigger_effect = -1;
- CyclePS5TriggerEffect(&controllers[i]);
- }
if (controllers[i].mapping) {
SDL_free(controllers[i].mapping);
+ controllers[i].mapping = NULL;
}
if (controllers[i].gamepad) {
SDL_CloseGamepad(controllers[i].gamepad);
- }
- if (controllers[i].axis_state) {
- SDL_free(controllers[i].axis_state);
- }
- if (controllers[i].joystick) {
- SDL_CloseJoystick(controllers[i].joystick);
- }
-
- --num_controllers;
- if (i < num_controllers) {
- SDL_memcpy(&controllers[i], &controllers[i + 1], (num_controllers - i) * sizeof(*controllers));
- }
-
- if (mapping_controller) {
- SetController(mapping_controller);
- } else {
- SetController(id);
+ controllers[i].gamepad = NULL;
}
}
@@ -1430,6 +1462,14 @@ static void loop(void *arg)
}
break;
+ case SDL_EVENT_GAMEPAD_ADDED:
+ HandleGamepadAdded(event.gdevice.which, SDL_TRUE);
+ break;
+
+ case SDL_EVENT_GAMEPAD_REMOVED:
+ HandleGamepadRemoved(event.gdevice.which);
+ break;
+
case SDL_EVENT_GAMEPAD_REMAPPED:
HandleGamepadRemapped(event.gdevice.which);
break;
@@ -1916,6 +1956,7 @@ int main(int argc, char *argv[])
CloseVirtualGamepad();
while (num_controllers > 0) {
+ HandleGamepadRemoved(controll
(Patch may be truncated, please check the link at the top of this post.)