This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_joystick.c
773 lines (661 loc) · 18 KB
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2013 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
26
27
28
29
30
31
32
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_config.h"
/* This is the joystick API for Simple DirectMedia Layer */
#include "SDL_events.h"
#include "SDL_sysjoystick.h"
#include "SDL_assert.h"
#if !SDL_EVENTS_DISABLED
#include "../events/SDL_events_c.h"
#endif
33
34
static SDL_Joystick *SDL_joysticks = NULL;
static SDL_Joystick *SDL_updating_joystick = NULL;
35
36
37
38
39
40
41
42
int
SDL_JoystickInit(void)
{
int status;
status = SDL_SYS_JoystickInit();
if (status >= 0) {
43
status = 0;
44
45
46
47
48
49
50
51
52
53
}
return (status);
}
/*
* Count the number of joysticks attached to the system
*/
int
SDL_NumJoysticks(void)
{
54
return SDL_SYS_NumJoysticks();
55
56
57
58
59
60
}
/*
* Get the implementation dependent name of a joystick
*/
const char *
61
SDL_JoystickNameForIndex(int device_index)
62
{
63
64
if ((device_index < 0) || (device_index >= SDL_NumJoysticks())) {
SDL_SetError("There are %d joysticks available", SDL_NumJoysticks());
65
66
return (NULL);
}
67
return (SDL_SYS_JoystickNameForDeviceIndex(device_index));
68
69
70
71
72
73
74
75
76
77
78
79
80
}
/*
* 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)
{
SDL_Joystick *joystick;
81
82
SDL_Joystick *joysticklist;
const char *joystickname = NULL;
83
84
85
if ((device_index < 0) || (device_index >= SDL_NumJoysticks())) {
SDL_SetError("There are %d joysticks available", SDL_NumJoysticks());
86
87
88
return (NULL);
}
89
90
91
92
93
94
95
96
97
98
99
100
joysticklist = SDL_joysticks;
/* If the joystick is already open, return it
* it is important that we have a single joystick * for each instance id
*/
while ( joysticklist )
{
if ( SDL_SYS_GetInstanceIdOfDeviceIndex(device_index) == joysticklist->instance_id ) {
joystick = joysticklist;
++joystick->ref_count;
return (joystick);
}
joysticklist = joysticklist->next;
101
102
103
104
105
106
107
108
109
110
}
/* Create and initialize the joystick */
joystick = (SDL_Joystick *) SDL_malloc((sizeof *joystick));
if (joystick == NULL) {
SDL_OutOfMemory();
return NULL;
}
SDL_memset(joystick, 0, (sizeof *joystick));
111
if (SDL_SYS_JoystickOpen(joystick, device_index) < 0) {
112
113
114
SDL_free(joystick);
return NULL;
}
115
116
joystickname = SDL_SYS_JoystickNameForDeviceIndex( device_index );
117
118
119
120
121
if ( joystickname )
joystick->name = SDL_strdup( joystickname );
else
joystick->name = NULL;
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
160
161
if (joystick->naxes > 0) {
joystick->axes = (Sint16 *) SDL_malloc
(joystick->naxes * sizeof(Sint16));
}
if (joystick->nhats > 0) {
joystick->hats = (Uint8 *) SDL_malloc
(joystick->nhats * sizeof(Uint8));
}
if (joystick->nballs > 0) {
joystick->balls = (struct balldelta *) SDL_malloc
(joystick->nballs * sizeof(*joystick->balls));
}
if (joystick->nbuttons > 0) {
joystick->buttons = (Uint8 *) SDL_malloc
(joystick->nbuttons * sizeof(Uint8));
}
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);
return NULL;
}
if (joystick->axes) {
SDL_memset(joystick->axes, 0, joystick->naxes * sizeof(Sint16));
}
if (joystick->hats) {
SDL_memset(joystick->hats, 0, joystick->nhats * sizeof(Uint8));
}
if (joystick->balls) {
SDL_memset(joystick->balls, 0,
joystick->nballs * sizeof(*joystick->balls));
}
if (joystick->buttons) {
SDL_memset(joystick->buttons, 0, joystick->nbuttons * sizeof(Uint8));
}
/* Add joystick to list */
++joystick->ref_count;
162
163
164
/* Link the joystick in the list */
joystick->next = SDL_joysticks;
SDL_joysticks = joystick;
165
166
SDL_SYS_JoystickUpdate( joystick );
167
168
return (joystick);
169
170
171
172
173
174
175
}
/*
* Checks to make sure the joystick is valid.
*/
int
176
SDL_PrivateJoystickValid(SDL_Joystick * joystick)
177
178
179
{
int valid;
180
if ( joystick == NULL ) {
181
182
183
184
185
SDL_SetError("Joystick hasn't been opened yet");
valid = 0;
} else {
valid = 1;
}
186
187
188
189
190
191
if ( joystick && joystick->closed )
{
valid = 0;
}
192
193
194
195
196
197
198
199
200
return valid;
}
/*
* Get the number of multi-dimensional axis controls on a joystick
*/
int
SDL_JoystickNumAxes(SDL_Joystick * joystick)
{
201
if (!SDL_PrivateJoystickValid(joystick)) {
202
203
204
205
206
207
208
209
210
211
212
return (-1);
}
return (joystick->naxes);
}
/*
* Get the number of hats on a joystick
*/
int
SDL_JoystickNumHats(SDL_Joystick * joystick)
{
213
if (!SDL_PrivateJoystickValid(joystick)) {
214
215
216
217
218
219
220
221
222
223
224
return (-1);
}
return (joystick->nhats);
}
/*
* Get the number of trackballs on a joystick
*/
int
SDL_JoystickNumBalls(SDL_Joystick * joystick)
{
225
if (!SDL_PrivateJoystickValid(joystick)) {
226
227
228
229
230
231
232
233
234
235
236
return (-1);
}
return (joystick->nballs);
}
/*
* Get the number of buttons on a joystick
*/
int
SDL_JoystickNumButtons(SDL_Joystick * joystick)
{
237
if (!SDL_PrivateJoystickValid(joystick)) {
238
239
240
241
242
243
244
245
246
247
248
249
250
return (-1);
}
return (joystick->nbuttons);
}
/*
* Get the current state of an axis control on a joystick
*/
Sint16
SDL_JoystickGetAxis(SDL_Joystick * joystick, int axis)
{
Sint16 state;
251
if (!SDL_PrivateJoystickValid(joystick)) {
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
return (0);
}
if (axis < joystick->naxes) {
state = joystick->axes[axis];
} else {
SDL_SetError("Joystick only has %d axes", joystick->naxes);
state = 0;
}
return (state);
}
/*
* Get the current state of a hat on a joystick
*/
Uint8
SDL_JoystickGetHat(SDL_Joystick * joystick, int hat)
{
Uint8 state;
271
if (!SDL_PrivateJoystickValid(joystick)) {
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
return (0);
}
if (hat < joystick->nhats) {
state = joystick->hats[hat];
} else {
SDL_SetError("Joystick only has %d hats", joystick->nhats);
state = 0;
}
return (state);
}
/*
* Get the ball axis change since the last poll
*/
int
SDL_JoystickGetBall(SDL_Joystick * joystick, int ball, int *dx, int *dy)
{
int retval;
291
if (!SDL_PrivateJoystickValid(joystick)) {
292
293
294
295
296
297
298
299
300
301
302
303
304
305
return (-1);
}
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 {
306
return SDL_SetError("Joystick only has %d balls", joystick->nballs);
307
308
309
310
311
312
313
314
315
316
317
318
}
return (retval);
}
/*
* Get the current state of a button on a joystick
*/
Uint8
SDL_JoystickGetButton(SDL_Joystick * joystick, int button)
{
Uint8 state;
319
if (!SDL_PrivateJoystickValid(joystick)) {
320
321
322
323
324
325
326
327
328
329
330
return (0);
}
if (button < joystick->nbuttons) {
state = joystick->buttons[button];
} else {
SDL_SetError("Joystick only has %d buttons", joystick->nbuttons);
state = 0;
}
return (state);
}
331
332
333
334
/*
* Return if the joystick in question is currently attached to the system,
* \return 0 if not plugged in, 1 if still present.
*/
335
336
SDL_bool
SDL_JoystickGetAttached(SDL_Joystick * joystick)
337
338
{
if (!SDL_PrivateJoystickValid(joystick)) {
339
return SDL_FALSE;
340
341
342
343
344
345
346
347
348
}
return SDL_SYS_JoystickAttached(joystick);
}
/*
* Get the instance id for this opened joystick
*/
SDL_JoystickID
349
SDL_JoystickInstanceID(SDL_Joystick * joystick)
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
{
if (!SDL_PrivateJoystickValid(joystick)) {
return (-1);
}
return (joystick->instance_id);
}
/*
* Get the friendly name of this joystick
*/
const char *
SDL_JoystickName(SDL_Joystick * joystick)
{
if (!SDL_PrivateJoystickValid(joystick)) {
return (NULL);
}
return (joystick->name);
}
371
372
373
374
375
376
/*
* Close a joystick previously opened with SDL_JoystickOpen()
*/
void
SDL_JoystickClose(SDL_Joystick * joystick)
{
377
378
SDL_Joystick *joysticklist;
SDL_Joystick *joysticklistprev;
379
380
if (!joystick) {
381
382
383
384
385
386
387
388
return;
}
/* First decrement ref count */
if (--joystick->ref_count > 0) {
return;
}
389
390
391
392
if (joystick == SDL_updating_joystick) {
return;
}
393
SDL_SYS_JoystickClose(joystick);
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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;
}
if (joystick->name)
SDL_free(joystick->name);
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
/* Free the data associated with this joystick */
if (joystick->axes) {
SDL_free(joystick->axes);
}
if (joystick->hats) {
SDL_free(joystick->hats);
}
if (joystick->balls) {
SDL_free(joystick->balls);
}
if (joystick->buttons) {
SDL_free(joystick->buttons);
}
SDL_free(joystick);
}
void
SDL_JoystickQuit(void)
{
439
440
441
/* Make sure we're not getting called in the middle of updating joysticks */
SDL_assert(!SDL_updating_joystick);
442
/* Stop the event polling */
443
444
445
446
447
while ( SDL_joysticks )
{
SDL_joysticks->ref_count = 1;
SDL_JoystickClose(SDL_joysticks);
}
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
/* Quit the joystick setup */
SDL_SYS_JoystickQuit();
}
/* These are global for SDL_sysjoystick.c and SDL_events.c */
int
SDL_PrivateJoystickAxis(SDL_Joystick * joystick, Uint8 axis, Sint16 value)
{
int posted;
/* Make sure we're not getting garbage events */
if (axis >= joystick->naxes) {
return 0;
}
/* Update internal joystick state */
467
468
469
if (value == joystick->axes[axis]) {
return 0;
}
470
471
472
473
474
475
476
477
joystick->axes[axis] = value;
/* Post the event, if desired */
posted = 0;
#if !SDL_EVENTS_DISABLED
if (SDL_GetEventState(SDL_JOYAXISMOTION) == SDL_ENABLE) {
SDL_Event event;
event.type = SDL_JOYAXISMOTION;
478
event.jaxis.which = joystick->instance_id;
479
480
event.jaxis.axis = axis;
event.jaxis.value = value;
481
posted = SDL_PushEvent(&event) == 1;
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
}
#endif /* !SDL_EVENTS_DISABLED */
return (posted);
}
int
SDL_PrivateJoystickHat(SDL_Joystick * joystick, Uint8 hat, Uint8 value)
{
int posted;
/* Make sure we're not getting garbage events */
if (hat >= joystick->nhats) {
return 0;
}
/* Update internal joystick state */
joystick->hats[hat] = value;
/* Post the event, if desired */
posted = 0;
#if !SDL_EVENTS_DISABLED
if (SDL_GetEventState(SDL_JOYHATMOTION) == SDL_ENABLE) {
SDL_Event event;
event.jhat.type = SDL_JOYHATMOTION;
506
event.jhat.which = joystick->instance_id;
507
508
event.jhat.hat = hat;
event.jhat.value = value;
509
posted = SDL_PushEvent(&event) == 1;
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
}
#endif /* !SDL_EVENTS_DISABLED */
return (posted);
}
int
SDL_PrivateJoystickBall(SDL_Joystick * joystick, Uint8 ball,
Sint16 xrel, Sint16 yrel)
{
int posted;
/* Make sure we're not getting garbage events */
if (ball >= joystick->nballs) {
return 0;
}
/* Update internal mouse state */
joystick->balls[ball].dx += xrel;
joystick->balls[ball].dy += yrel;
/* Post the event, if desired */
posted = 0;
#if !SDL_EVENTS_DISABLED
if (SDL_GetEventState(SDL_JOYBALLMOTION) == SDL_ENABLE) {
SDL_Event event;
event.jball.type = SDL_JOYBALLMOTION;
536
event.jball.which = joystick->instance_id;
537
538
539
event.jball.ball = ball;
event.jball.xrel = xrel;
event.jball.yrel = yrel;
540
posted = SDL_PushEvent(&event) == 1;
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
566
567
568
569
570
571
572
573
574
575
576
577
}
#endif /* !SDL_EVENTS_DISABLED */
return (posted);
}
int
SDL_PrivateJoystickButton(SDL_Joystick * joystick, Uint8 button, Uint8 state)
{
int posted;
#if !SDL_EVENTS_DISABLED
SDL_Event event;
switch (state) {
case SDL_PRESSED:
event.type = SDL_JOYBUTTONDOWN;
break;
case SDL_RELEASED:
event.type = SDL_JOYBUTTONUP;
break;
default:
/* Invalid state -- bail */
return (0);
}
#endif /* !SDL_EVENTS_DISABLED */
/* Make sure we're not getting garbage events */
if (button >= joystick->nbuttons) {
return 0;
}
/* Update internal joystick state */
joystick->buttons[button] = state;
/* Post the event, if desired */
posted = 0;
#if !SDL_EVENTS_DISABLED
if (SDL_GetEventState(event.type) == SDL_ENABLE) {
578
event.jbutton.which = joystick->instance_id;
579
580
event.jbutton.button = button;
event.jbutton.state = state;
581
posted = SDL_PushEvent(&event) == 1;
582
583
584
585
586
587
588
589
}
#endif /* !SDL_EVENTS_DISABLED */
return (posted);
}
void
SDL_JoystickUpdate(void)
{
590
591
592
593
594
595
596
597
598
599
600
SDL_Joystick *joystick;
joystick = SDL_joysticks;
while ( joystick )
{
SDL_Joystick *joysticknext;
/* save off the next pointer, the Update call may cause a joystick removed event
* and cause our joystick pointer to be freed
*/
joysticknext = joystick->next;
601
602
SDL_updating_joystick = joystick;
603
604
605
606
607
608
609
SDL_SYS_JoystickUpdate( joystick );
if ( joystick->closed && joystick->uncentered )
{
int i;
joystick->uncentered = 0;
610
/* Tell the app that everything is centered/unpressed... */
611
612
613
614
615
616
617
618
for (i = 0; i < joystick->naxes; i++)
SDL_PrivateJoystickAxis(joystick, i, 0);
for (i = 0; i < joystick->nbuttons; i++)
SDL_PrivateJoystickButton(joystick, i, 0);
for (i = 0; i < joystick->nhats; i++)
SDL_PrivateJoystickHat(joystick, i, SDL_HAT_CENTERED);
619
620
621
}
622
623
624
625
626
627
628
SDL_updating_joystick = NULL;
/* If the joystick was closed while updating, free it here */
if ( joystick->ref_count <= 0 ) {
SDL_JoystickClose(joystick);
}
629
630
631
joystick = joysticknext;
}
632
633
// this needs to happen AFTER walking the joystick list above, so that any
// dangling hardware data from removed devices can be free'd
634
SDL_SYS_JoystickDetect();
635
636
637
638
639
640
}
int
SDL_JoystickEventState(int state)
{
#if SDL_EVENTS_DISABLED
641
return SDL_DISABLE;
642
643
644
#else
const Uint32 event_list[] = {
SDL_JOYAXISMOTION, SDL_JOYBALLMOTION, SDL_JOYHATMOTION,
645
SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_JOYDEVICEADDED, SDL_JOYDEVICEREMOVED
646
647
648
649
650
};
unsigned int i;
switch (state) {
case SDL_QUERY:
651
state = SDL_DISABLE;
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
for (i = 0; i < SDL_arraysize(event_list); ++i) {
state = SDL_EventState(event_list[i], SDL_QUERY);
if (state == SDL_ENABLE) {
break;
}
}
break;
default:
for (i = 0; i < SDL_arraysize(event_list); ++i) {
SDL_EventState(event_list[i], state);
}
break;
}
return (state);
#endif /* SDL_EVENTS_DISABLED */
}
669
/* return 1 if you want to run the joystick update loop this frame, used by hotplug support */
670
SDL_bool
671
672
SDL_PrivateJoystickNeedsPolling()
{
673
if (SDL_joysticks != NULL) {
674
return SDL_TRUE;
675
676
} else {
return SDL_SYS_JoystickNeedsPolling();
677
678
679
680
}
}
681
/* return the guid for this index */
682
SDL_JoystickGUID SDL_JoystickGetDeviceGUID(int device_index)
683
{
684
return SDL_SYS_JoystickGetDeviceGUID( device_index );
685
686
}
687
/* return the guid for this opened device */
688
SDL_JoystickGUID SDL_JoystickGetGUID(SDL_Joystick * joystick)
689
{
690
return SDL_SYS_JoystickGetGUID( joystick );
691
692
693
}
/* convert the guid to a printable string */
694
void SDL_JoystickGetGUIDString( SDL_JoystickGUID guid, char *pszGUID, int cbGUID )
695
696
697
698
{
static const char k_rgchHexToASCII[] = "0123456789abcdef";
int i;
699
700
701
702
703
if ((pszGUID == NULL) || (cbGUID <= 0)) {
return;
}
for ( i = 0; i < sizeof(guid.data) && i < (cbGUID-1); i++ )
704
705
706
707
708
{
// each input byte writes 2 ascii chars, and might write a null byte.
// If we don't have room for next input byte, stop
unsigned char c = guid.data[i];
709
710
*pszGUID++ = k_rgchHexToASCII[ c >> 4 ];
*pszGUID++ = k_rgchHexToASCII[ c & 0x0F ];
711
}
712
*pszGUID = '\0';
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
}
//-----------------------------------------------------------------------------
// Purpose: Returns the 4 bit nibble for a hex character
// Input : c -
// Output : unsigned char
//-----------------------------------------------------------------------------
static unsigned char nibble( char c )
{
if ( ( c >= '0' ) &&
( c <= '9' ) )
{
return (unsigned char)(c - '0');
}
if ( ( c >= 'A' ) &&
( c <= 'F' ) )
{
return (unsigned char)(c - 'A' + 0x0a);
}
if ( ( c >= 'a' ) &&
( c <= 'f' ) )
{
return (unsigned char)(c - 'a' + 0x0a);
}
// received an invalid character, and no real way to return an error
// AssertMsg1( false, "Q_nibble invalid hex character '%c' ", c );
return 0;
}
/* convert the string version of a joystick guid to the struct */
748
SDL_JoystickGUID SDL_JoystickGetGUIDFromString(const char *pchGUID)
749
{
750
SDL_JoystickGUID guid;
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
int maxoutputbytes= sizeof(guid);
int len = SDL_strlen( pchGUID );
Uint8 *p;
int i;
// Make sure it's even
len = ( len ) & ~0x1;
SDL_memset( &guid, 0x00, sizeof(guid) );
p = (Uint8 *)&guid;
for ( i = 0;
( i < len ) && ( ( p - (Uint8 *)&guid ) < maxoutputbytes );
i+=2, p++ )
{
*p = ( nibble( pchGUID[i] ) << 4 ) | nibble( pchGUID[i+1] );
}
return guid;
}
773
/* vi: set ts=4 sw=4 expandtab: */