Navigation Menu

Skip to content

Latest commit

 

History

History
2253 lines (1932 loc) · 63.5 KB

SDL_joystick.c

File metadata and controls

2253 lines (1932 loc) · 63.5 KB
 
1
2
/*
Simple DirectMedia Layer
Jan 17, 2020
Jan 17, 2020
3
Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#include "../SDL_internal.h"
/* This is the joystick API for Simple DirectMedia Layer */
#include "SDL.h"
Aug 9, 2018
Aug 9, 2018
26
#include "SDL_atomic.h"
27
28
29
30
31
32
33
34
#include "SDL_events.h"
#include "SDL_sysjoystick.h"
#include "SDL_assert.h"
#include "SDL_hints.h"
#if !SDL_EVENTS_DISABLED
#include "../events/SDL_events_c.h"
#endif
Aug 13, 2017
Aug 13, 2017
35
#include "../video/SDL_sysvideo.h"
Dec 19, 2019
Dec 19, 2019
36
#include "hidapi/SDL_hidapijoystick_c.h"
Aug 9, 2018
Aug 9, 2018
38
39
/* This is included in only one place because it has a large static list of controllers */
#include "controller_type.h"
Jan 27, 2017
Jan 27, 2017
40
Aug 9, 2018
Aug 9, 2018
41
42
#ifdef __WIN32__
/* Needed for checking for input remapping programs */
Aug 9, 2018
Aug 9, 2018
43
#include "../core/windows/SDL_windows.h"
Aug 9, 2018
Aug 9, 2018
44
45
46
47
48
#undef UNICODE /* We want ASCII functions */
#include <tlhelp32.h>
#endif
Mar 14, 2020
Mar 14, 2020
49
#if SDL_JOYSTICK_VIRTUAL
Mar 15, 2020
Mar 15, 2020
50
#include "./virtual/SDL_virtualjoystick_c.h"
Mar 14, 2020
Mar 14, 2020
51
52
#endif
Aug 9, 2018
Aug 9, 2018
53
static SDL_JoystickDriver *SDL_joystick_drivers[] = {
Mar 16, 2020
Mar 16, 2020
54
55
56
57
58
59
60
#ifdef SDL_JOYSTICK_RAWINPUT /* Before WINDOWS_ driver, as WINDOWS wants to check if this driver is handling things */
/* Also before HIDAPI, as HIDAPI wants to check if this driver is handling things */
&SDL_RAWINPUT_JoystickDriver,
#endif
#ifdef SDL_JOYSTICK_HIDAPI /* Before WINDOWS_ driver, as WINDOWS wants to check if this driver is handling things */
&SDL_HIDAPI_JoystickDriver,
#endif
Aug 9, 2018
Aug 9, 2018
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
#if defined(SDL_JOYSTICK_DINPUT) || defined(SDL_JOYSTICK_XINPUT)
&SDL_WINDOWS_JoystickDriver,
#endif
#ifdef SDL_JOYSTICK_LINUX
&SDL_LINUX_JoystickDriver,
#endif
#ifdef SDL_JOYSTICK_IOKIT
&SDL_DARWIN_JoystickDriver,
#endif
#if defined(__IPHONEOS__) || defined(__TVOS__)
&SDL_IOS_JoystickDriver,
#endif
#ifdef SDL_JOYSTICK_ANDROID
&SDL_ANDROID_JoystickDriver,
#endif
Aug 10, 2018
Aug 10, 2018
76
77
78
#ifdef SDL_JOYSTICK_EMSCRIPTEN
&SDL_EMSCRIPTEN_JoystickDriver,
#endif
Aug 10, 2018
Aug 10, 2018
79
80
81
#ifdef SDL_JOYSTICK_HAIKU
&SDL_HAIKU_JoystickDriver,
#endif
Aug 10, 2018
Aug 10, 2018
82
83
84
#ifdef SDL_JOYSTICK_USBHID /* !!! FIXME: "USBHID" is a generic name, and doubly-confusing with HIDAPI next to it. This is the *BSD interface, rename this. */
&SDL_BSD_JoystickDriver,
#endif
Mar 14, 2020
Mar 14, 2020
85
86
87
#ifdef SDL_JOYSTICK_VIRTUAL
&SDL_VIRTUAL_JoystickDriver,
#endif
Aug 9, 2018
Aug 9, 2018
88
89
90
91
#if defined(SDL_JOYSTICK_DUMMY) || defined(SDL_JOYSTICK_DISABLED)
&SDL_DUMMY_JoystickDriver
#endif
};
92
93
static SDL_bool SDL_joystick_allows_background_events = SDL_FALSE;
static SDL_Joystick *SDL_joysticks = NULL;
Dec 14, 2016
Dec 14, 2016
94
static SDL_bool SDL_updating_joystick = SDL_FALSE;
Nov 29, 2016
Nov 29, 2016
95
static SDL_mutex *SDL_joystick_lock = NULL; /* This needs to support recursive locks */
Aug 9, 2018
Aug 9, 2018
96
static SDL_atomic_t SDL_next_joystick_instance_id;
Dec 21, 2019
Dec 21, 2019
97
98
static int SDL_joystick_player_count = 0;
static SDL_JoystickID *SDL_joystick_players = NULL;
Nov 29, 2016
Nov 29, 2016
99
Dec 8, 2016
Dec 8, 2016
100
void
Oct 10, 2017
Oct 10, 2017
101
SDL_LockJoysticks(void)
Nov 29, 2016
Nov 29, 2016
102
103
104
105
106
107
{
if (SDL_joystick_lock) {
SDL_LockMutex(SDL_joystick_lock);
}
}
Dec 8, 2016
Dec 8, 2016
108
void
Oct 10, 2017
Oct 10, 2017
109
SDL_UnlockJoysticks(void)
Nov 29, 2016
Nov 29, 2016
110
111
112
113
114
115
{
if (SDL_joystick_lock) {
SDL_UnlockMutex(SDL_joystick_lock);
}
}
Dec 21, 2019
Dec 21, 2019
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
static int
SDL_FindFreePlayerIndex()
{
int player_index;
for (player_index = 0; player_index < SDL_joystick_player_count; ++player_index) {
if (SDL_joystick_players[player_index] == -1) {
return player_index;
}
}
return player_index;
}
static int
SDL_GetPlayerIndexForJoystickID(SDL_JoystickID instance_id)
{
int player_index;
for (player_index = 0; player_index < SDL_joystick_player_count; ++player_index) {
if (instance_id == SDL_joystick_players[player_index]) {
break;
}
}
if (player_index == SDL_joystick_player_count) {
player_index = -1;
}
return player_index;
}
static SDL_JoystickID
SDL_GetJoystickIDForPlayerIndex(int player_index)
{
if (player_index < 0 || player_index >= SDL_joystick_player_count) {
return -1;
}
return SDL_joystick_players[player_index];
}
static SDL_bool
SDL_SetJoystickIDForPlayerIndex(int player_index, SDL_JoystickID instance_id)
{
SDL_JoystickID existing_instance = SDL_GetJoystickIDForPlayerIndex(player_index);
SDL_JoystickDriver *driver;
int device_index;
Mar 8, 2020
Mar 8, 2020
160
int existing_player_index;
Dec 21, 2019
Dec 21, 2019
161
162
163
164
165
166
167
168
169
170
171
172
if (player_index < 0) {
return SDL_FALSE;
}
if (player_index >= SDL_joystick_player_count) {
SDL_JoystickID *new_players = (SDL_JoystickID *)SDL_realloc(SDL_joystick_players, (player_index + 1)*sizeof(*SDL_joystick_players));
if (!new_players) {
SDL_OutOfMemory();
return SDL_FALSE;
}
SDL_joystick_players = new_players;
Jan 13, 2020
Jan 13, 2020
173
174
SDL_memset(&SDL_joystick_players[SDL_joystick_player_count], 0xFF, (player_index - SDL_joystick_player_count + 1) * sizeof(SDL_joystick_players[0]));
SDL_joystick_player_count = player_index + 1;
Mar 8, 2020
Mar 8, 2020
175
176
177
} else if (SDL_joystick_players[player_index] == instance_id) {
/* Joystick is already assigned the requested player index */
return SDL_TRUE;
Dec 21, 2019
Dec 21, 2019
178
179
}
Mar 8, 2020
Mar 8, 2020
180
181
182
183
184
185
/* Clear the old player index */
existing_player_index = SDL_GetPlayerIndexForJoystickID(instance_id);
if (existing_player_index >= 0) {
SDL_joystick_players[existing_player_index] = -1;
}
Dec 21, 2019
Dec 21, 2019
186
187
188
189
190
191
192
193
194
195
196
197
198
199
SDL_joystick_players[player_index] = instance_id;
/* Update the driver with the new index */
device_index = SDL_JoystickGetDeviceIndexFromInstanceID(instance_id);
if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
driver->SetDevicePlayerIndex(device_index, player_index);
}
/* Move any existing joystick to another slot */
if (existing_instance >= 0) {
SDL_SetJoystickIDForPlayerIndex(SDL_FindFreePlayerIndex(), existing_instance);
}
return SDL_TRUE;
}
Aug 14, 2017
Aug 14, 2017
201
static void SDLCALL
202
203
204
205
206
207
208
209
210
211
212
213
SDL_JoystickAllowBackgroundEventsChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
{
if (hint && *hint == '1') {
SDL_joystick_allows_background_events = SDL_TRUE;
} else {
SDL_joystick_allows_background_events = SDL_FALSE;
}
}
int
SDL_JoystickInit(void)
{
Aug 9, 2018
Aug 9, 2018
214
int i, status;
Aug 9, 2017
Aug 9, 2017
216
217
SDL_GameControllerInitMappings();
Nov 29, 2016
Nov 29, 2016
218
219
220
221
222
/* Create the joystick list lock */
if (!SDL_joystick_lock) {
SDL_joystick_lock = SDL_CreateMutex();
}
223
224
225
226
227
228
229
230
231
232
/* See if we should allow joystick events while in the background */
SDL_AddHintCallback(SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS,
SDL_JoystickAllowBackgroundEventsChanged, NULL);
#if !SDL_EVENTS_DISABLED
if (SDL_InitSubSystem(SDL_INIT_EVENTS) < 0) {
return -1;
}
#endif /* !SDL_EVENTS_DISABLED */
Aug 9, 2018
Aug 9, 2018
233
234
235
236
237
status = -1;
for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
if (SDL_joystick_drivers[i]->Init() >= 0) {
status = 0;
}
Aug 9, 2018
Aug 9, 2018
239
return status;
240
241
242
243
244
245
246
247
}
/*
* Count the number of joysticks attached to the system
*/
int
SDL_NumJoysticks(void)
{
Aug 9, 2018
Aug 9, 2018
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
int i, total_joysticks = 0;
SDL_LockJoysticks();
for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
total_joysticks += SDL_joystick_drivers[i]->GetCount();
}
SDL_UnlockJoysticks();
return total_joysticks;
}
/*
* Return the next available joystick instance ID
* This may be called by drivers from multiple threads, unprotected by any locks
*/
SDL_JoystickID SDL_GetNextJoystickInstanceID()
{
return SDL_AtomicIncRef(&SDL_next_joystick_instance_id);
}
/*
* Get the driver and device index for an API device index
* This should be called while the joystick lock is held, to prevent another thread from updating the list
*/
SDL_bool
SDL_GetDriverAndJoystickIndex(int device_index, SDL_JoystickDriver **driver, int *driver_index)
{
int i, num_joysticks, total_joysticks = 0;
if (device_index >= 0) {
for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
num_joysticks = SDL_joystick_drivers[i]->GetCount();
if (device_index < num_joysticks) {
*driver = SDL_joystick_drivers[i];
*driver_index = device_index;
return SDL_TRUE;
}
device_index -= num_joysticks;
total_joysticks += num_joysticks;
}
}
SDL_SetError("There are %d joysticks available", total_joysticks);
return SDL_FALSE;
290
291
292
293
294
295
296
297
}
/*
* Get the implementation dependent name of a joystick
*/
const char *
SDL_JoystickNameForIndex(int device_index)
{
Aug 9, 2018
Aug 9, 2018
298
299
300
301
302
SDL_JoystickDriver *driver;
const char *name = NULL;
SDL_LockJoysticks();
if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
Mar 13, 2020
Mar 13, 2020
303
name = driver->GetDeviceName(device_index);
Aug 9, 2018
Aug 9, 2018
305
306
307
308
SDL_UnlockJoysticks();
/* FIXME: Really we should reference count this name so it doesn't go away after unlock */
return name;
Dec 21, 2019
Dec 21, 2019
311
312
313
/*
* Get the player index of a joystick, or -1 if it's not available
*/
Oct 25, 2018
Oct 25, 2018
314
315
316
int
SDL_JoystickGetDevicePlayerIndex(int device_index)
{
Dec 21, 2019
Dec 21, 2019
317
int player_index;
Oct 25, 2018
Oct 25, 2018
318
319
SDL_LockJoysticks();
Dec 21, 2019
Dec 21, 2019
320
player_index = SDL_GetPlayerIndexForJoystickID(SDL_JoystickGetDeviceInstanceID(device_index));
Oct 25, 2018
Oct 25, 2018
321
322
323
324
325
SDL_UnlockJoysticks();
return player_index;
}
Jan 4, 2017
Jan 4, 2017
326
327
328
329
330
331
332
333
/*
* Return true if this joystick is known to have all axes centered at zero
* This isn't generally needed unless the joystick never generates an initial axis value near zero,
* e.g. it's emulating axes with digital buttons
*/
static SDL_bool
SDL_JoystickAxesCenteredAtZero(SDL_Joystick *joystick)
{
Jan 27, 2017
Jan 27, 2017
334
335
336
static Uint32 zero_centered_joysticks[] = {
MAKE_VIDPID(0x0e8f, 0x3013), /* HuiJia SNES USB adapter */
MAKE_VIDPID(0x05a0, 0x3232), /* 8Bitdo Zero Gamepad */
Jan 4, 2017
Jan 4, 2017
337
338
339
};
int i;
Jan 27, 2017
Jan 27, 2017
340
341
Uint32 id = MAKE_VIDPID(SDL_JoystickGetVendor(joystick),
SDL_JoystickGetProduct(joystick));
Jan 4, 2017
Jan 4, 2017
342
Jan 20, 2017
Jan 20, 2017
343
344
/*printf("JOYSTICK '%s' VID/PID 0x%.4x/0x%.4x AXES: %d\n", joystick->name, vendor, product, joystick->naxes);*/
Jan 4, 2017
Jan 4, 2017
345
346
347
348
349
if (joystick->naxes == 2) {
/* Assume D-pad or thumbstick style axes are centered at 0 */
return SDL_TRUE;
}
Jan 4, 2017
Jan 4, 2017
350
for (i = 0; i < SDL_arraysize(zero_centered_joysticks); ++i) {
Jan 27, 2017
Jan 27, 2017
351
if (id == zero_centered_joysticks[i]) {
Jan 4, 2017
Jan 4, 2017
352
353
354
355
356
357
return SDL_TRUE;
}
}
return SDL_FALSE;
}
358
359
360
361
362
363
364
365
366
367
/*
* Open a joystick for use - the index passed as an argument refers to
* the N'th joystick on the system. This index is the value which will
* identify this joystick in future joystick events.
*
* This function returns a joystick identifier, or NULL if an error occurred.
*/
SDL_Joystick *
SDL_JoystickOpen(int device_index)
{
Aug 9, 2018
Aug 9, 2018
368
369
SDL_JoystickDriver *driver;
SDL_JoystickID instance_id;
370
371
372
373
SDL_Joystick *joystick;
SDL_Joystick *joysticklist;
const char *joystickname = NULL;
Oct 10, 2017
Oct 10, 2017
374
SDL_LockJoysticks();
Nov 29, 2016
Nov 29, 2016
375
Aug 9, 2018
Aug 9, 2018
376
377
378
379
380
if (!SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
SDL_UnlockJoysticks();
return NULL;
}
381
382
joysticklist = SDL_joysticks;
/* If the joystick is already open, return it
Mar 10, 2017
Mar 10, 2017
383
384
* it is important that we have a single joystick * for each instance id
*/
Aug 9, 2018
Aug 9, 2018
385
instance_id = driver->GetDeviceInstanceID(device_index);
386
while (joysticklist) {
Aug 9, 2018
Aug 9, 2018
387
if (instance_id == joysticklist->instance_id) {
388
389
joystick = joysticklist;
++joystick->ref_count;
Oct 10, 2017
Oct 10, 2017
390
SDL_UnlockJoysticks();
Aug 9, 2018
Aug 9, 2018
391
return joystick;
392
393
394
395
396
}
joysticklist = joysticklist->next;
}
/* Create and initialize the joystick */
Jan 27, 2017
Jan 27, 2017
397
joystick = (SDL_Joystick *) SDL_calloc(sizeof(*joystick), 1);
398
399
if (joystick == NULL) {
SDL_OutOfMemory();
Oct 10, 2017
Oct 10, 2017
400
SDL_UnlockJoysticks();
Aug 9, 2018
Aug 9, 2018
403
404
joystick->driver = driver;
joystick->instance_id = instance_id;
Aug 9, 2018
Aug 9, 2018
405
joystick->attached = SDL_TRUE;
Jun 19, 2019
Jun 19, 2019
406
joystick->epowerlevel = SDL_JOYSTICK_POWER_UNKNOWN;
Aug 9, 2018
Aug 9, 2018
408
if (driver->Open(joystick, device_index) < 0) {
409
SDL_free(joystick);
Oct 10, 2017
Oct 10, 2017
410
SDL_UnlockJoysticks();
411
412
413
return NULL;
}
Aug 9, 2018
Aug 9, 2018
414
415
joystickname = driver->GetDeviceName(device_index);
if (joystickname) {
416
joystick->name = SDL_strdup(joystickname);
Aug 9, 2018
Aug 9, 2018
417
} else {
418
joystick->name = NULL;
Aug 9, 2018
Aug 9, 2018
419
420
421
}
joystick->guid = driver->GetDeviceGUID(device_index);
422
423
if (joystick->naxes > 0) {
Dec 23, 2016
Dec 23, 2016
424
joystick->axes = (SDL_JoystickAxisInfo *) SDL_calloc(joystick->naxes, sizeof(SDL_JoystickAxisInfo));
425
426
}
if (joystick->nhats > 0) {
Dec 23, 2016
Dec 23, 2016
427
joystick->hats = (Uint8 *) SDL_calloc(joystick->nhats, sizeof(Uint8));
428
429
}
if (joystick->nballs > 0) {
Dec 23, 2016
Dec 23, 2016
430
joystick->balls = (struct balldelta *) SDL_calloc(joystick->nballs, sizeof(*joystick->balls));
431
432
}
if (joystick->nbuttons > 0) {
Dec 23, 2016
Dec 23, 2016
433
joystick->buttons = (Uint8 *) SDL_calloc(joystick->nbuttons, sizeof(Uint8));
434
435
436
437
438
439
440
}
if (((joystick->naxes > 0) && !joystick->axes)
|| ((joystick->nhats > 0) && !joystick->hats)
|| ((joystick->nballs > 0) && !joystick->balls)
|| ((joystick->nbuttons > 0) && !joystick->buttons)) {
SDL_OutOfMemory();
SDL_JoystickClose(joystick);
Oct 10, 2017
Oct 10, 2017
441
SDL_UnlockJoysticks();
442
443
444
return NULL;
}
Jan 4, 2017
Jan 4, 2017
445
446
447
448
449
450
451
452
453
/* If this joystick is known to have all zero centered axes, skip the auto-centering code */
if (SDL_JoystickAxesCenteredAtZero(joystick)) {
int i;
for (i = 0; i < joystick->naxes; ++i) {
joystick->axes[i].has_initial_value = SDL_TRUE;
}
}
Jan 27, 2017
Jan 27, 2017
454
455
joystick->is_game_controller = SDL_IsGameController(device_index);
456
457
458
459
460
461
/* Add joystick to list */
++joystick->ref_count;
/* Link the joystick in the list */
joystick->next = SDL_joysticks;
SDL_joysticks = joystick;
Oct 10, 2017
Oct 10, 2017
462
SDL_UnlockJoysticks();
Nov 29, 2016
Nov 29, 2016
463
Aug 9, 2018
Aug 9, 2018
464
driver->Update(joystick);
Dec 8, 2016
Dec 8, 2016
465
Aug 9, 2018
Aug 9, 2018
466
return joystick;
Mar 14, 2020
Mar 14, 2020
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
int
SDL_JoystickAttachVirtual(SDL_JoystickType type,
int naxes,
int nbuttons,
int nhats)
{
#if SDL_JOYSTICK_VIRTUAL
return SDL_JoystickAttachVirtualInner(type,
naxes,
nbuttons,
nhats);
#else
return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}
int
SDL_JoystickDetachVirtual(int device_index)
{
#if SDL_JOYSTICK_VIRTUAL
SDL_JoystickDriver *driver;
SDL_LockJoysticks();
if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
if (driver == &SDL_VIRTUAL_JoystickDriver) {
const int result = SDL_JoystickDetachVirtualInner(device_index);
SDL_UnlockJoysticks();
return result;
}
}
SDL_UnlockJoysticks();
return SDL_SetError("Virtual joystick not found at provided index");
#else
return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}
SDL_bool
SDL_JoystickIsVirtual(int device_index)
{
#if SDL_JOYSTICK_VIRTUAL
SDL_JoystickDriver *driver;
int driver_device_index;
SDL_bool is_virtual = SDL_FALSE;
SDL_LockJoysticks();
if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &driver_device_index)) {
if (driver == &SDL_VIRTUAL_JoystickDriver) {
is_virtual = SDL_TRUE;
}
}
SDL_UnlockJoysticks();
return is_virtual;
#else
return SDL_FALSE;
#endif
}
int
SDL_JoystickSetVirtualAxis(SDL_Joystick * joystick, int axis, Sint16 value)
{
#if SDL_JOYSTICK_VIRTUAL
return SDL_JoystickSetVirtualAxisInner(joystick, axis, value);
#else
return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}
int
SDL_JoystickSetVirtualButton(SDL_Joystick * joystick, int button, Uint8 value)
{
#if SDL_JOYSTICK_VIRTUAL
return SDL_JoystickSetVirtualButtonInner(joystick, button, value);
#else
return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}
int
SDL_JoystickSetVirtualHat(SDL_Joystick * joystick, int hat, Uint8 value)
{
#if SDL_JOYSTICK_VIRTUAL
return SDL_JoystickSetVirtualHatInner(joystick, hat, value);
#else
return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}
566
567
568
/*
* Checks to make sure the joystick is valid.
*/
Dec 21, 2019
Dec 21, 2019
569
SDL_bool
570
571
SDL_PrivateJoystickValid(SDL_Joystick * joystick)
{
Dec 21, 2019
Dec 21, 2019
572
SDL_bool valid;
573
574
575
if (joystick == NULL) {
SDL_SetError("Joystick hasn't been opened yet");
Dec 21, 2019
Dec 21, 2019
576
valid = SDL_FALSE;
Dec 21, 2019
Dec 21, 2019
578
valid = SDL_TRUE;
579
580
581
582
583
584
585
586
587
588
589
590
}
return valid;
}
/*
* Get the number of multi-dimensional axis controls on a joystick
*/
int
SDL_JoystickNumAxes(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
591
return -1;
Aug 9, 2018
Aug 9, 2018
593
return joystick->naxes;
594
595
596
597
598
599
600
601
602
}
/*
* Get the number of hats on a joystick
*/
int
SDL_JoystickNumHats(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
603
return -1;
Aug 9, 2018
Aug 9, 2018
605
return joystick->nhats;
606
607
608
609
610
611
612
613
614
}
/*
* Get the number of trackballs on a joystick
*/
int
SDL_JoystickNumBalls(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
615
return -1;
Aug 9, 2018
Aug 9, 2018
617
return joystick->nballs;
618
619
620
621
622
623
624
625
626
}
/*
* Get the number of buttons on a joystick
*/
int
SDL_JoystickNumButtons(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
627
return -1;
Aug 9, 2018
Aug 9, 2018
629
return joystick->nbuttons;
630
631
632
633
634
635
636
637
638
639
640
}
/*
* Get the current state of an axis control on a joystick
*/
Sint16
SDL_JoystickGetAxis(SDL_Joystick * joystick, int axis)
{
Sint16 state;
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
641
return 0;
642
643
}
if (axis < joystick->naxes) {
Dec 23, 2016
Dec 23, 2016
644
state = joystick->axes[axis].value;
645
646
647
648
} else {
SDL_SetError("Joystick only has %d axes", joystick->naxes);
state = 0;
}
Aug 9, 2018
Aug 9, 2018
649
return state;
Jan 4, 2017
Jan 4, 2017
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
/*
* Get the initial state of an axis control on a joystick
*/
SDL_bool
SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick, int axis, Sint16 *state)
{
if (!SDL_PrivateJoystickValid(joystick)) {
return SDL_FALSE;
}
if (axis >= joystick->naxes) {
SDL_SetError("Joystick only has %d axes", joystick->naxes);
return SDL_FALSE;
}
if (state) {
*state = joystick->axes[axis].initial_value;
}
return joystick->axes[axis].has_initial_value;
}
671
672
673
674
675
676
677
678
679
/*
* Get the current state of a hat on a joystick
*/
Uint8
SDL_JoystickGetHat(SDL_Joystick * joystick, int hat)
{
Uint8 state;
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
680
return 0;
681
682
683
684
685
686
687
}
if (hat < joystick->nhats) {
state = joystick->hats[hat];
} else {
SDL_SetError("Joystick only has %d hats", joystick->nhats);
state = 0;
}
Aug 9, 2018
Aug 9, 2018
688
return state;
689
690
691
692
693
694
695
696
697
698
699
}
/*
* Get the ball axis change since the last poll
*/
int
SDL_JoystickGetBall(SDL_Joystick * joystick, int ball, int *dx, int *dy)
{
int retval;
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
700
return -1;
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
}
retval = 0;
if (ball < joystick->nballs) {
if (dx) {
*dx = joystick->balls[ball].dx;
}
if (dy) {
*dy = joystick->balls[ball].dy;
}
joystick->balls[ball].dx = 0;
joystick->balls[ball].dy = 0;
} else {
return SDL_SetError("Joystick only has %d balls", joystick->nballs);
}
Aug 9, 2018
Aug 9, 2018
716
return retval;
717
718
719
720
721
722
723
724
725
726
727
}
/*
* Get the current state of a button on a joystick
*/
Uint8
SDL_JoystickGetButton(SDL_Joystick * joystick, int button)
{
Uint8 state;
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
728
return 0;
729
730
731
732
733
734
735
}
if (button < joystick->nbuttons) {
state = joystick->buttons[button];
} else {
SDL_SetError("Joystick only has %d buttons", joystick->nbuttons);
state = 0;
}
Aug 9, 2018
Aug 9, 2018
736
return state;
737
738
739
740
741
742
743
744
745
746
747
748
749
}
/*
* Return if the joystick in question is currently attached to the system,
* \return SDL_FALSE if not plugged in, SDL_TRUE if still present.
*/
SDL_bool
SDL_JoystickGetAttached(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
return SDL_FALSE;
}
Aug 9, 2018
Aug 9, 2018
750
return joystick->attached;
751
752
753
754
755
756
757
758
759
}
/*
* Get the instance id for this opened joystick
*/
SDL_JoystickID
SDL_JoystickInstanceID(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
760
return -1;
Aug 9, 2018
Aug 9, 2018
763
return joystick->instance_id;
Nov 14, 2015
Nov 14, 2015
766
/*
Dec 21, 2019
Dec 21, 2019
767
* Return the SDL_Joystick associated with an instance id.
Nov 14, 2015
Nov 14, 2015
768
769
*/
SDL_Joystick *
Dec 21, 2019
Dec 21, 2019
770
SDL_JoystickFromInstanceID(SDL_JoystickID instance_id)
Nov 14, 2015
Nov 14, 2015
771
{
Nov 29, 2016
Nov 29, 2016
772
773
SDL_Joystick *joystick;
Oct 10, 2017
Oct 10, 2017
774
SDL_LockJoysticks();
Nov 29, 2016
Nov 29, 2016
775
for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
Dec 21, 2019
Dec 21, 2019
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
if (joystick->instance_id == instance_id) {
break;
}
}
SDL_UnlockJoysticks();
return joystick;
}
/**
* Return the SDL_Joystick associated with a player index.
*/
SDL_Joystick *
SDL_JoystickFromPlayerIndex(int player_index)
{
SDL_JoystickID instance_id;
SDL_Joystick *joystick;
SDL_LockJoysticks();
instance_id = SDL_GetJoystickIDForPlayerIndex(player_index);
for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
if (joystick->instance_id == instance_id) {
Aug 21, 2018
Aug 21, 2018
797
break;
Nov 14, 2015
Nov 14, 2015
798
799
}
}
Oct 10, 2017
Oct 10, 2017
800
SDL_UnlockJoysticks();
Aug 21, 2018
Aug 21, 2018
801
return joystick;
Nov 14, 2015
Nov 14, 2015
802
803
}
804
805
806
807
808
809
810
/*
* Get the friendly name of this joystick
*/
const char *
SDL_JoystickName(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
Aug 9, 2018
Aug 9, 2018
811
return NULL;
Mar 13, 2020
Mar 13, 2020
814
return joystick->name;
Dec 21, 2019
Dec 21, 2019
817
818
819
/**
* Get the player index of an opened joystick, or -1 if it's not available
*/
Oct 25, 2018
Oct 25, 2018
820
821
822
int
SDL_JoystickGetPlayerIndex(SDL_Joystick * joystick)
{
Dec 21, 2019
Dec 21, 2019
823
824
int player_index;
Oct 25, 2018
Oct 25, 2018
825
826
827
if (!SDL_PrivateJoystickValid(joystick)) {
return -1;
}
Dec 21, 2019
Dec 21, 2019
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
SDL_LockJoysticks();
player_index = SDL_GetPlayerIndexForJoystickID(joystick->instance_id);
SDL_UnlockJoysticks();
return player_index;
}
/**
* Set the player index of an opened joystick
*/
void
SDL_JoystickSetPlayerIndex(SDL_Joystick * joystick, int player_index)
{
if (!SDL_PrivateJoystickValid(joystick)) {
return;
}
SDL_LockJoysticks();
SDL_SetJoystickIDForPlayerIndex(player_index, joystick->instance_id);
SDL_UnlockJoysticks();
Oct 25, 2018
Oct 25, 2018
849
850
}
Aug 9, 2018
Aug 9, 2018
851
852
853
int
SDL_JoystickRumble(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
{
Jan 18, 2020
Jan 18, 2020
854
int result;
Jan 14, 2020
Jan 14, 2020
855
Aug 9, 2018
Aug 9, 2018
856
857
858
if (!SDL_PrivateJoystickValid(joystick)) {
return -1;
}
Jan 14, 2020
Jan 14, 2020
859
Jan 18, 2020
Jan 18, 2020
860
SDL_LockJoysticks();
Feb 4, 2020
Feb 4, 2020
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
if (low_frequency_rumble == joystick->low_frequency_rumble &&
high_frequency_rumble == joystick->high_frequency_rumble) {
/* Just update the expiration */
result = 0;
} else {
result = joystick->driver->Rumble(joystick, low_frequency_rumble, high_frequency_rumble);
}
/* Save the rumble value regardless of success, so we don't spam the driver */
joystick->low_frequency_rumble = low_frequency_rumble;
joystick->high_frequency_rumble = high_frequency_rumble;
if ((low_frequency_rumble || high_frequency_rumble) && duration_ms) {
joystick->rumble_expiration = SDL_GetTicks() + SDL_min(duration_ms, SDL_MAX_RUMBLE_DURATION_MS);
if (!joystick->rumble_expiration) {
joystick->rumble_expiration = 1;
}
} else {
joystick->rumble_expiration = 0;
}
Jan 18, 2020
Jan 18, 2020
881
SDL_UnlockJoysticks();
Jan 14, 2020
Jan 14, 2020
882
Jan 18, 2020
Jan 18, 2020
883
return result;
Aug 9, 2018
Aug 9, 2018
884
885
}
886
887
888
889
890
891
892
893
894
/*
* Close a joystick previously opened with SDL_JoystickOpen()
*/
void
SDL_JoystickClose(SDL_Joystick * joystick)
{
SDL_Joystick *joysticklist;
SDL_Joystick *joysticklistprev;
Aug 9, 2018
Aug 9, 2018
895
if (!SDL_PrivateJoystickValid(joystick)) {
Oct 10, 2017
Oct 10, 2017
899
SDL_LockJoysticks();
Nov 29, 2016
Nov 29, 2016
900
901
902
/* First decrement ref count */
if (--joystick->ref_count > 0) {
Oct 10, 2017
Oct 10, 2017
903
SDL_UnlockJoysticks();
Dec 14, 2016
Dec 14, 2016
907
if (SDL_updating_joystick) {
Oct 10, 2017
Oct 10, 2017
908
SDL_UnlockJoysticks();
Feb 4, 2020
Feb 4, 2020
912
913
914
915
if (joystick->rumble_expiration) {
SDL_JoystickRumble(joystick, 0, 0, 0);
}
Aug 9, 2018
Aug 9, 2018
916
joystick->driver->Close(joystick);
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
joystick->hwdata = NULL;
joysticklist = SDL_joysticks;
joysticklistprev = NULL;
while (joysticklist) {
if (joystick == joysticklist) {
if (joysticklistprev) {
/* unlink this entry */
joysticklistprev->next = joysticklist->next;
} else {
SDL_joysticks = joystick->next;
}
break;
}
joysticklistprev = joysticklist;
joysticklist = joysticklist->next;
}
SDL_free(joystick->name);
/* Free the data associated with this joystick */
SDL_free(joystick->axes);
SDL_free(joystick->hats);
SDL_free(joystick->balls);
SDL_free(joystick->buttons);
SDL_free(joystick);
Nov 29, 2016
Nov 29, 2016
943
Oct 10, 2017
Oct 10, 2017
944
SDL_UnlockJoysticks();
945
946
947
948
949
}
void
SDL_JoystickQuit(void)
{
Aug 9, 2018
Aug 9, 2018
950
951
int i;
952
/* Make sure we're not getting called in the middle of updating joysticks */
Oct 10, 2017
Oct 10, 2017
953
SDL_LockJoysticks();
Mar 27, 2019
Mar 27, 2019
954
955
956
957
958
while (SDL_updating_joystick) {
SDL_UnlockJoysticks();
SDL_Delay(1);
SDL_LockJoysticks();
}
Nov 29, 2016
Nov 29, 2016
959
960
961
962
963
964
965
966
/* Stop the event polling */
while (SDL_joysticks) {
SDL_joysticks->ref_count = 1;
SDL_JoystickClose(SDL_joysticks);
}
/* Quit the joystick setup */
Aug 9, 2018
Aug 9, 2018
967
968
969
for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
SDL_joystick_drivers[i]->Quit();
}
Dec 21, 2019
Dec 21, 2019
971
972
973
974
975
if (SDL_joystick_players) {
SDL_free(SDL_joystick_players);
SDL_joystick_players = NULL;
SDL_joystick_player_count = 0;
}
Oct 10, 2017
Oct 10, 2017
976
SDL_UnlockJoysticks();
Nov 29, 2016
Nov 29, 2016
977
978
979
980
#if !SDL_EVENTS_DISABLED
SDL_QuitSubSystem(SDL_INIT_EVENTS);
#endif
Nov 29, 2016
Nov 29, 2016
981
Aug 9, 2017
Aug 9, 2017
982
983
984
SDL_DelHintCallback(SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS,
SDL_JoystickAllowBackgroundEventsChanged, NULL);
Nov 29, 2016
Nov 29, 2016
985
if (SDL_joystick_lock) {
Mar 27, 2019
Mar 27, 2019
986
SDL_mutex *mutex = SDL_joystick_lock;
Nov 29, 2016
Nov 29, 2016
987
SDL_joystick_lock = NULL;
Mar 27, 2019
Mar 27, 2019
988
SDL_DestroyMutex(mutex);
Nov 29, 2016
Nov 29, 2016
989
}
Aug 9, 2017
Aug 9, 2017
990
991
SDL_GameControllerQuitMappings();
992
993
994
995
996
997
998
999
1000
}
static SDL_bool
SDL_PrivateJoystickShouldIgnoreEvent()
{
if (SDL_joystick_allows_background_events) {
return SDL_FALSE;
}