This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_haptic.c
640 lines (523 loc) · 12.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/*
SDL - Simple DirectMedia Layer
Copyright (C) 2008 Edgar Simo
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Sam Lantinga
slouken@libsdl.org
*/
#include "SDL_config.h"
#include "SDL_syshaptic.h"
25
#include "../joystick/SDL_joystick_c.h" /* For SDL_PrivateJoystickValid */
26
27
28
Uint8 SDL_numhaptics = 0;
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
SDL_Haptic **SDL_haptics = NULL;
/*
* Initializes the Haptic devices.
*/
int
SDL_HapticInit(void)
{
int arraylen;
int status;
SDL_numhaptics = 0;
status = SDL_SYS_HapticInit();
if (status >= 0) {
arraylen = (status + 1) * sizeof(*SDL_haptics);
SDL_haptics = (SDL_Haptic **) SDL_malloc(arraylen);
46
if (SDL_haptics == NULL) { /* Out of memory. */
47
SDL_numhaptics = 0;
48
49
}
else {
50
51
52
53
54
55
56
57
58
59
SDL_memset(SDL_haptics, 0, arraylen);
SDL_numhaptics = status;
}
status = 0;
}
return status;
}
60
61
62
63
/*
* Checks to see if the haptic device is valid
*/
static int
64
ValidHaptic(SDL_Haptic * haptic)
65
{
66
int i;
67
int valid;
68
69
70
71
72
73
74
valid = 0;
for (i=0; i<SDL_numhaptics; i++) {
if (SDL_haptics[i] == haptic) {
valid = 1;
break;
}
75
}
76
77
78
79
80
return valid;
}
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*
* Returns the number of available devices.
*/
int
SDL_NumHaptics(void)
{
return SDL_numhaptics;
}
/*
* Gets the name of a Haptic device by index.
*/
const char *
SDL_HapticName(int device_index)
{
if ((device_index < 0) || (device_index >= SDL_numhaptics)) {
98
SDL_SetError("Haptic: There are %d haptic devices available", SDL_numhaptics);
99
100
101
102
103
104
105
return NULL;
}
return SDL_SYS_HapticName(device_index);
}
/*
106
* Opens a Haptic device.
107
108
109
110
111
112
113
114
*/
SDL_Haptic *
SDL_HapticOpen(int device_index)
{
int i;
SDL_Haptic *haptic;
if ((device_index < 0) || (device_index >= SDL_numhaptics)) {
115
SDL_SetError("Haptic: There are %d haptic devices available", SDL_numhaptics);
116
117
118
119
return NULL;
}
/* If the haptic is already open, return it */
120
for (i=0; SDL_haptics[i]; i++) {
121
122
123
124
125
126
127
if (device_index == SDL_haptics[i]->index) {
haptic = SDL_haptics[i];
++haptic->ref_count;
return haptic;
}
}
128
/* Create the haptic device */
129
haptic = (SDL_Haptic *) SDL_malloc((sizeof *haptic));
130
131
132
if (haptic == NULL) {
SDL_OutOfMemory();
return NULL;
133
}
134
135
136
137
138
139
140
/* Initialize the haptic device */
SDL_memset(haptic, 0, (sizeof *haptic));
haptic->index = device_index;
if (SDL_SYS_HapticOpen(haptic) < 0) {
SDL_free(haptic);
return NULL;
141
}
142
143
144
145
146
147
148
/* Disable autocenter and set gain to max. */
if (haptic->supported & SDL_HAPTIC_GAIN)
SDL_HapticSetGain(haptic,100);
if (haptic->supported & SDL_HAPTIC_AUTOCENTER)
SDL_HapticSetAutocenter(haptic,0);
149
150
/* Add haptic to list */
++haptic->ref_count;
151
for (i=0; SDL_haptics[i]; i++)
152
153
154
/* Skip to next haptic */ ;
SDL_haptics[i] = haptic;
155
156
return haptic;
}
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
* Returns 1 if the device has been opened.
*/
int
SDL_HapticOpened(int device_index)
{
int i, opened;
opened = 0;
for (i=0; SDL_haptics[i]; i++) {
if (SDL_haptics[i]->index == (Uint8) device_index) {
opened = 1;
break;
}
}
return opened;
}
178
179
180
181
182
183
/*
* Returns the index to a haptic device.
*/
int
SDL_HapticIndex(SDL_Haptic * haptic)
{
184
if (!ValidHaptic(haptic)) {
185
186
187
188
189
190
191
return -1;
}
return haptic->index;
}
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*
* Returns SDL_TRUE if mouse is haptic, SDL_FALSE if it isn't.
*/
int
SDL_MouseIsHaptic(void)
{
if (SDL_SYS_HapticMouse() < 0)
return SDL_FALSE;
return SDL_TRUE;
}
/*
* Returns the haptic device if mouse is haptic or NULL elsewise.
*/
SDL_Haptic *
SDL_HapticOpenFromMouse(void)
{
int device_index;
device_index = SDL_SYS_HapticMouse();
if (device_index < 0) {
215
SDL_SetError("Haptic: Mouse isn't a haptic device.");
216
217
218
219
220
221
222
return NULL;
}
return SDL_HapticOpen(device_index);
}
223
224
225
226
227
228
229
230
/*
* Returns SDL_TRUE if joystick has haptic features.
*/
int
SDL_JoystickIsHaptic(SDL_Joystick * joystick)
{
int ret;
231
/* Must be a valid joystick */
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
if (!SDL_PrivateJoystickValid(&joystick)) {
return -1;
}
ret = SDL_SYS_JoystickIsHaptic(joystick);
if (ret > 0) return SDL_TRUE;
else if (ret == 0) return SDL_FALSE;
else return -1;
}
/*
* Opens a haptic device from a joystick.
*/
SDL_Haptic *
SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
{
250
251
252
253
int i;
SDL_Haptic *haptic;
/* Must be a valid joystick */
254
if (!SDL_PrivateJoystickValid(&joystick)) {
255
256
257
258
259
260
261
262
263
264
return NULL;
}
/* Joystick must be haptic */
if (SDL_SYS_JoystickIsHaptic(joystick) <= 0) {
return NULL;
}
/* Check to see if joystick's haptic is already open */
for (i=0; SDL_haptics[i]; i++) {
265
if (SDL_SYS_JoystickSameHaptic(SDL_haptics[i],joystick)) {
266
267
268
269
270
271
272
273
274
275
276
haptic = SDL_haptics[i];
++haptic->ref_count;
return haptic;
}
}
/* Create the haptic device */
haptic = (SDL_Haptic *) SDL_malloc((sizeof *haptic));
if (haptic == NULL) {
SDL_OutOfMemory();
return NULL;
277
}
278
279
/* Initialize the haptic device */
280
SDL_memset(haptic, 0, sizeof(SDL_Haptic));
281
282
283
284
285
286
287
288
289
290
291
292
if (SDL_SYS_HapticOpenFromJoystick(haptic,joystick) < 0) {
SDL_free(haptic);
return NULL;
}
/* Add haptic to list */
++haptic->ref_count;
for (i=0; SDL_haptics[i]; i++)
/* Skip to next haptic */ ;
SDL_haptics[i] = haptic;
return haptic;
293
294
295
}
296
297
298
299
300
301
/*
* Closes a SDL_Haptic device.
*/
void
SDL_HapticClose(SDL_Haptic * haptic)
{
302
303
304
int i;
/* Must be valid */
305
if (!ValidHaptic(haptic)) {
306
307
308
309
310
311
312
313
return;
}
/* Check if it's still in use */
if (--haptic->ref_count < 0) {
return;
}
314
315
316
317
318
319
/* Close it, properly removing effects if needed */
for (i=0; i<haptic->neffects; i++) {
if (haptic->effects[i].hweffect != NULL) {
SDL_HapticDestroyEffect(haptic,i);
}
}
320
321
322
323
324
325
326
327
328
329
330
331
332
SDL_SYS_HapticClose(haptic);
/* Remove from the list */
for (i = 0; SDL_haptics[i]; ++i) {
if (haptic == SDL_haptics[i]) {
SDL_memcpy(&SDL_haptics[i], &SDL_haptics[i + 1],
(SDL_numhaptics - i) * sizeof(haptic));
break;
}
}
/* Free */
SDL_free(haptic);
333
334
335
336
337
}
/*
* Cleans up after the subsystem.
*/
338
339
340
341
342
343
344
345
void
SDL_HapticQuit(void)
{
SDL_SYS_HapticQuit();
if (SDL_haptics != NULL) {
SDL_free(SDL_haptics);
SDL_haptics = NULL;
}
346
SDL_numhaptics = 0;
347
}
348
349
350
351
352
353
354
/*
* Returns the number of effects a haptic device has.
*/
int
SDL_HapticNumEffects(SDL_Haptic * haptic)
{
355
if (!ValidHaptic(haptic)) {
356
357
358
359
360
361
return -1;
}
return haptic->neffects;
}
362
363
364
365
366
367
368
/*
* Returns the number of effects a haptic device can play.
*/
int
SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic)
{
369
if (!ValidHaptic(haptic)) {
370
371
372
373
374
375
376
return -1;
}
return haptic->nplaying;
}
377
378
379
380
/*
* Returns supported effects by the device.
*/
unsigned int
381
SDL_HapticQuery(SDL_Haptic * haptic)
382
{
383
if (!ValidHaptic(haptic)) {
384
385
386
387
388
389
return -1;
}
return haptic->supported;
}
390
391
392
393
394
395
396
/*
* Returns the number of axis on the device.
*/
int
SDL_HapticNumAxes(SDL_Haptic * haptic)
{
397
if (!ValidHaptic(haptic)) {
398
399
400
401
402
403
return -1;
}
return haptic->naxes;
}
404
405
406
/*
* Checks to see if the device can support the effect.
*/
407
408
409
int
SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
{
410
if (!ValidHaptic(haptic)) {
411
412
413
414
415
416
417
return -1;
}
if ((haptic->supported & effect->type) != 0)
return SDL_TRUE;
return SDL_FALSE;
}
418
419
420
421
422
423
424
425
426
427
/*
* Creates a new haptic effect.
*/
int
SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
{
int i;
/* Check for device validity. */
428
if (!ValidHaptic(haptic)) {
429
430
431
return -1;
}
432
433
/* Check to see if effect is supported */
if (SDL_HapticEffectSupported(haptic,effect)==SDL_FALSE) {
434
SDL_SetError("Haptic: Effect not supported by haptic device.");
435
436
437
return -1;
}
438
439
440
441
442
/* See if there's a free slot */
for (i=0; i<haptic->neffects; i++) {
if (haptic->effects[i].hweffect == NULL) {
/* Now let the backend create the real effect */
443
if (SDL_SYS_HapticNewEffect(haptic,&haptic->effects[i],effect) != 0) {
444
445
return -1; /* Backend failed to create effect */
}
446
447
SDL_memcpy(&haptic->effects[i].effect, effect, sizeof(SDL_HapticEffect));
448
449
450
451
return i;
}
}
452
SDL_SetError("Haptic: Device has no free space left.");
453
454
455
return -1;
}
456
457
458
459
460
461
462
/*
* Checks to see if an effect is valid.
*/
static int
ValidEffect(SDL_Haptic * haptic, int effect)
{
if ((effect < 0) || (effect >= haptic->neffects)) {
463
SDL_SetError("Haptic: Invalid effect identifier.");
464
465
466
467
468
return 0;
}
return 1;
}
469
470
471
472
473
474
/*
* Updates an effect.
*/
int
SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
{
475
if (!ValidHaptic(haptic) || !ValidEffect(haptic,effect)) {
476
477
478
return -1;
}
479
480
481
482
483
484
/* Can't change type dynamically. */
if (data->type != haptic->effects[effect].effect.type) {
SDL_SetError("Haptic: Updating effect type is illegal.");
return -1;
}
485
486
487
488
489
/* Updates the effect */
if (SDL_SYS_HapticUpdateEffect(haptic,&haptic->effects[effect],data) < 0) {
return -1;
}
490
SDL_memcpy(&haptic->effects[effect].effect, data, sizeof(SDL_HapticEffect));
491
492
493
494
return 0;
}
495
496
497
498
/*
* Runs the haptic effect on the device.
*/
int
499
SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations)
500
{
501
if (!ValidHaptic(haptic) || !ValidEffect(haptic,effect)) {
502
503
return -1;
}
504
505
/* Run the effect */
506
if (SDL_SYS_HapticRunEffect(haptic,&haptic->effects[effect], iterations) < 0) {
507
508
509
510
return -1;
}
return 0;
511
512
}
513
514
515
516
517
518
/*
* Stops the haptic effect on the device.
*/
int
SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
{
519
if (!ValidHaptic(haptic) || !ValidEffect(haptic,effect)) {
520
521
522
523
524
525
526
527
528
529
530
return -1;
}
/* Stop the effect */
if (SDL_SYS_HapticStopEffect(haptic,&haptic->effects[effect]) < 0) {
return -1;
}
return 0;
}
531
532
533
534
535
536
/*
* Gets rid of a haptic effect.
*/
void
SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
{
537
if (!ValidHaptic(haptic) || !ValidEffect(haptic,effect)) {
538
539
return;
}
540
541
542
543
544
545
546
/* Not allocated */
if (haptic->effects[effect].hweffect == NULL) {
return;
}
SDL_SYS_HapticDestroyEffect(haptic, &haptic->effects[effect]);
547
548
}
549
550
551
552
553
554
/*
* Gets the status of a haptic effect.
*/
int
SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
{
555
if (!ValidHaptic(haptic) || !ValidEffect(haptic,effect)) {
556
557
558
559
return -1;
}
if ((haptic->supported & SDL_HAPTIC_STATUS) == 0) {
560
SDL_SetError("Haptic: Device does not support status queries.");
561
562
563
564
565
566
return -1;
}
return SDL_SYS_HapticGetEffectStatus(haptic, &haptic->effects[effect]);
}
567
568
569
570
571
572
/*
* Sets the global gain of the device.
*/
int
SDL_HapticSetGain(SDL_Haptic * haptic, int gain )
{
573
574
575
const char *env;
int real_gain, max_gain;
576
if (!ValidHaptic(haptic)) {
577
578
579
return -1;
}
580
if ((haptic->supported & SDL_HAPTIC_GAIN) == 0) {
581
SDL_SetError("Haptic: Device does not support setting gain.");
582
583
584
return -1;
}
585
if ((gain < 0) || (gain > 100)) {
586
SDL_SetError("Haptic: Gain must be between 0 and 100.");
587
588
589
return -1;
}
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
/* We use the envvar to get the maximum gain. */
env = SDL_getenv("SDL_HAPTIC_GAIN_MAX");
if (env != NULL) {
max_gain = SDL_atoi(env);
/* Check for sanity. */
if (max_gain < 0) max_gain = 0;
else if (max_gain > 100) max_gain = 100;
/* We'll scale it linearly with SDL_HAPTIC_GAIN_MAX */
real_gain = (gain * max_gain) / 100;
}
else {
real_gain = gain;
}
if (SDL_SYS_HapticSetGain(haptic,real_gain) < 0) {
607
608
609
610
611
612
return -1;
}
return 0;
}
613
614
615
616
617
618
/*
* Makes the device autocenter, 0 disables.
*/
int
SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter )
{
619
if (!ValidHaptic(haptic)) {
620
621
622
623
return -1;
}
if ((haptic->supported & SDL_HAPTIC_AUTOCENTER) == 0) {
624
SDL_SetError("Haptic: Device does not support setting autocenter.");
625
626
627
628
return -1;
}
if ((autocenter < 0) || (autocenter > 100)) {
629
SDL_SetError("Haptic: Autocenter must be between 0 and 100.");
630
631
632
633
634
635
636
637
638
return -1;
}
if (SDL_SYS_HapticSetAutocenter(haptic,autocenter) < 0) {
return -1;
}
return 0;
}