This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syshaptic.c
934 lines (771 loc) · 24.9 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
25
26
27
28
29
30
31
/*
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"
#ifdef SDL_HAPTIC_IOKIT
#include "SDL_haptic.h"
#include "../SDL_syshaptic.h"
#include "SDL_joystick.h"
#include "../../joystick/SDL_sysjoystick.h" /* For the real SDL_Joystick */
/*#include "../../joystick/dawrin/SDL_sysjoystick_c.h"*/ /* For joystick hwdata */
32
33
#include <IOKit/IOKitLib.h>
#include <IOKit/hid/IOHIDKeys.h>
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#include <ForceFeedback/ForceFeedback.h>
#include <ForceFeedback/ForceFeedbackConstants.h>
#define MAX_HAPTICS 32
/*
* List of available haptic devices.
*/
static struct
{
io_service_t dev;
SDL_Haptic *haptic;
} SDL_hapticlist[MAX_HAPTICS];
/*
* Haptic system hardware data.
*/
struct haptic_hwdata
{
FFDeviceObjectReference device; /* Hardware device. */
};
/*
* Haptic system effect data.
*/
struct haptic_hweffect
{
FFEffectObjectReference ref; /* Reference. */
struct FFEFFECT effect; /* Hardware effect. */
};
69
70
71
/*
* Prototypes.
*/
72
static void SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect, int type );
73
74
75
76
77
78
79
80
81
82
83
84
/*
* Initializes the haptic subsystem.
*/
int
SDL_SYS_HapticInit(void)
{
int numhaptics;
IOReturn result;
io_iterator_t iter;
CFDictionaryRef match;
85
io_service_t device;
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/* Get HID devices. */
match = IOServiceMatching(kIOHIDDeviceKey);
if (match == NULL) {
SDL_SetError("Haptic: Failed to get IOServiceMatching.");
return -1;
}
/* Now search I/O Registry for matching devices. */
result = IOServiceGetMatchingServices(kIOMasterPortDefault, match, &iter);
if (result != kIOReturnSuccess) {
SDL_SetError("Haptic: Couldn't create a HID object iterator.");
return -1;
}
/* IOServiceGetMatchingServices consumes dictionary. */
numhaptics = 0;
while ((device = IOIteratorNext(iter)) != IO_OBJECT_NULL) {
/* Check for force feedback. */
if (FFIsForceFeedback(device) == FF_OK) {
SDL_hapticlist[numhaptics].dev = device;
SDL_hapticlist[numhaptics].haptic = NULL;
numhaptics++;
}
/* Reached haptic limit. */
if (numhaptics >= MAX_HAPTICS)
break;
}
IOObjectRelease(iter);
return numhaptics;
}
/*
* Return the name of a haptic device, does not need to be opened.
*/
const char *
SDL_SYS_HapticName(int index)
{
return NULL;
}
#define FF_TEST(ff, s) \
if (features.supportedEffects & ff) supported |= s
/*
* Gets supported features.
*/
static unsigned int
GetSupportedFeatures(FFDeviceObjectReference device,
139
int *neffects, int *nplaying, int *naxes)
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
{
HRESULT ret;
FFCAPABILITIES features;
unsigned int supported;
Uint32 val;
ret = FFDeviceGetForceFeedbackCapabilities(device, &features);
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to get device's supported features.");
return 0;
}
supported = 0;
/* Get maximum effects. */
*neffects = features.storageCapacity;
*nplaying = features.playbackCapacity;
/* Test for effects. */
FF_TEST(FFCAP_ET_CONSTANTFORCE, SDL_HAPTIC_CONSTANT);
FF_TEST(FFCAP_ET_RAMPFORCE, SDL_HAPTIC_RAMP);
FF_TEST(FFCAP_ET_SQUARE, SDL_HAPTIC_SQUARE);
FF_TEST(FFCAP_ET_SINE, SDL_HAPTIC_SINE);
FF_TEST(FFCAP_ET_TRIANGLE, SDL_HAPTIC_TRIANGLE);
FF_TEST(FFCAP_ET_SAWTOOTHUP, SDL_HAPTIC_SAWTOOTHUP);
FF_TEST(FFCAP_ET_SAWTOOTHDOWN, SDL_HAPTIC_SAWTOOTHDOWN);
FF_TEST(FFCAP_ET_SPRING, SDL_HAPTIC_SPRING);
FF_TEST(FFCAP_ET_DAMPER, SDL_HAPTIC_DAMPER);
FF_TEST(FFCAP_ET_INERTIA, SDL_HAPTIC_INERTIA);
FF_TEST(FFCAP_ET_FRICTION, SDL_HAPTIC_FRICTION);
FF_TEST(FFCAP_ET_CUSTOMFORCE, SDL_HAPTIC_CUSTOM);
/* Check if supports gain. */
ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_FFGAIN,
174
&val, sizeof(val));
175
176
177
178
179
180
181
if (ret == FF_OK) supported |= SDL_HAPTIC_GAIN;
else if (ret != FFERR_UNSUPPORTED) {
SDL_SetError("Haptic: Unable to get if device supports gain.");
return 0;
}
/* Checks if supports autocenter. */
182
ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_AUTOCENTER,
183
&val, sizeof(val));
184
185
186
187
188
189
if (ret == FF_OK) supported |= SDL_HAPTIC_AUTOCENTER;
else if (ret != FFERR_UNSUPPORTED) {
SDL_SetError("Haptic: Unable to get if device supports autocenter.");
return 0;
}
190
/* Check for axes, we have an artificial limit on axes */
191
*naxes = ((features.numFfAxes) > 3) ?
192
193
3 : features.numFfAxes;
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/* Always supported features. */
supported |= SDL_HAPTIC_STATUS;
return supported;
}
/*
* Opens the haptic device from the file descriptor.
*/
static int
SDL_SYS_HapticOpenFromService(SDL_Haptic * haptic, io_service_t service)
{
/* Allocate the hwdata */
haptic->hwdata = (struct haptic_hwdata *)
SDL_malloc(sizeof(*haptic->hwdata));
if (haptic->hwdata == NULL) {
SDL_OutOfMemory();
goto creat_err;
}
SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
/* Open the device */
216
if (FFCreateDevice( service, &haptic->hwdata->device ) != FF_OK) {
217
218
219
220
221
222
SDL_SetError("Haptic: Unable to create device from service.");
goto creat_err;
}
/* Get supported features. */
haptic->supported = GetSupportedFeatures(haptic->hwdata->device,
223
224
&haptic->neffects, &haptic->nplaying,
&haptic->naxes);
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
if (haptic->supported == 0) { /* Error since device supports nothing. */
goto open_err;
}
haptic->effects = (struct haptic_effect *)
SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
if (haptic->effects == NULL) {
SDL_OutOfMemory();
goto open_err;
}
/* Clear the memory */
SDL_memset(haptic->effects, 0,
sizeof(struct haptic_effect) * haptic->neffects);
return 0;
/* Error handling */
open_err:
FFReleaseDevice(haptic->hwdata->device);
creat_err:
if (haptic->hwdata != NULL) {
free(haptic->hwdata);
haptic->hwdata = NULL;
}
return -1;
}
/*
* Opens a haptic device for usage.
*/
int
SDL_SYS_HapticOpen(SDL_Haptic * haptic)
{
return SDL_SYS_HapticOpenFromService(haptic,
260
SDL_hapticlist[haptic->index].dev);
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
}
/*
* Opens a haptic device from first mouse it finds for usage.
*/
int
SDL_SYS_HapticMouse(void)
{
return -1;
}
/*
* Checks to see if a joystick has haptic features.
*/
int
SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick)
{
return SDL_FALSE;
}
/*
* Checks to see if the haptic device and joystick and in reality the same.
*/
int
SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, SDL_Joystick * joystick)
{
return 0;
}
/*
* Opens a SDL_Haptic from a SDL_Joystick.
*/
int
SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, SDL_Joystick * joystick)
{
return -1;
}
/*
* Closes the haptic device.
*/
void
SDL_SYS_HapticClose(SDL_Haptic * haptic)
{
int i;
if (haptic->hwdata) {
314
315
316
/* Free the effects. */
for (i=0; i<haptic->neffects; i++) {
if (haptic->effects[i].hweffect != NULL) {
317
318
SDL_SYS_HapticFreeFFEFFECT(&haptic->effects[i].hweffect->effect,
haptic->effects[i].effect.type);
319
320
321
322
323
324
SDL_free(haptic->effects[i].hweffect);
}
}
SDL_free(haptic->effects);
haptic->neffects = 0;
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
/* Clean up */
FFReleaseDevice(haptic->hwdata->device);
/* Free */
SDL_free(haptic->hwdata);
haptic->hwdata = NULL;
}
}
/*
* Clean up after system specific haptic stuff
*/
void
SDL_SYS_HapticQuit(void)
{
int i;
for (i=0; i < SDL_numhaptics; i++) {
344
345
346
347
/* Opened and not closed haptics are leaked, this is on purpose.
* Close your haptic devices after usage. */
/* Free the io_service_t */
348
349
350
351
352
353
354
355
356
IOObjectRelease(SDL_hapticlist[i].dev);
}
}
/*
* Sets the direction.
*/
static int
357
SDL_SYS_SetDirection( FFEFFECT * effect, SDL_HapticDirection *dir, int naxes )
358
{
359
LONG *rglDir;
360
361
/* Handle no axes a part. */
362
if (naxes == 0) {
363
364
365
366
367
effect->rglDirection = NULL;
return 0;
}
/* Has axes. */
368
rglDir = SDL_malloc( sizeof(LONG) * naxes );
369
if (rglDir == NULL) {
370
371
372
SDL_OutOfMemory();
return -1;
}
373
SDL_memset( rglDir, 0, sizeof(LONG) * naxes );
374
effect->rglDirection = rglDir;
375
376
377
378
switch (dir->type) {
case SDL_HAPTIC_POLAR:
effect->dwFlags |= FFEFF_POLAR;
379
rglDir[0] = dir->dir[0];
380
381
return 0;
case SDL_HAPTIC_CARTESIAN:
382
effect->dwFlags |= FFEFF_CARTESIAN;
383
384
385
rglDir[0] = dir->dir[0];
rglDir[1] = dir->dir[1];
rglDir[2] = dir->dir[2];
386
return 0;
387
case SDL_HAPTIC_SPHERICAL:
388
effect->dwFlags |= FFEFF_SPHERICAL;
389
390
391
rglDir[0] = dir->dir[0];
rglDir[1] = dir->dir[1];
rglDir[2] = dir->dir[2];
392
393
394
395
396
397
398
399
400
401
return 0;
default:
SDL_SetError("Haptic: Unknown direction type.");
return -1;
}
}
#define CONVERT(x) (((x)*10000) / 0xFFFF )
/*
402
* Creates the FFEFFECT from a SDL_HapticEffect.
403
404
*/
static int
405
SDL_SYS_ToFFEFFECT( SDL_Haptic * haptic, FFEFFECT * dest, SDL_HapticEffect * src )
406
{
407
int i;
408
409
FFCONSTANTFORCE *constant;
FFPERIODIC *periodic;
410
FFCONDITION *condition; /* Actually an array of conditions - one per axis. */
411
412
FFRAMPFORCE *ramp;
FFCUSTOMFORCE *custom;
413
FFENVELOPE *envelope;
414
SDL_HapticConstant *hap_constant;
415
SDL_HapticPeriodic *hap_periodic;
416
417
SDL_HapticCondition *hap_condition;
SDL_HapticRamp *hap_ramp;
418
SDL_HapticCustom *hap_custom;
419
DWORD *axes;
420
421
422
423
424
425
/* Set global stuff. */
SDL_memset(dest, 0, sizeof(FFEFFECT));
dest->dwSize = sizeof(FFEFFECT); /* Set the structure size. */
dest->dwSamplePeriod = 0; /* Not used by us. */
dest->dwGain = 10000; /* Gain is set globally, not locally. */
426
427
428
429
430
431
432
433
434
435
/* Envelope. */
envelope = SDL_malloc( sizeof(FFENVELOPE) );
if (envelope == NULL) {
SDL_OutOfMemory();
return -1;
}
SDL_memset(envelope, 0, sizeof(FFENVELOPE));
dest->lpEnvelope = envelope;
envelope->dwSize = sizeof(FFENVELOPE); /* Always should be this. */
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
/* Axes. */
dest->cAxes = haptic->naxes;
if (dest->cAxes > 0) {
axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
if (axes == NULL) {
SDL_OutOfMemory();
return -1;
}
axes[0] = FFJOFS_X; /* Always at least one axis. */
if (dest->cAxes > 1) {
axes[1] = FFJOFS_Y;
}
if (dest->cAxes > 2) {
axes[2] = FFJOFS_Z;
}
dest->rgdwAxes = axes;
}
456
/* The big type handling switch, even bigger then linux's version. */
457
458
459
460
switch (src->type) {
case SDL_HAPTIC_CONSTANT:
hap_constant = &src->constant;
constant = SDL_malloc( sizeof(FFCONSTANTFORCE) );
461
462
463
464
if (constant == NULL) {
SDL_OutOfMemory();
return -1;
}
465
SDL_memset(constant, 0, sizeof(FFCONSTANTFORCE));
466
467
468
469
470
471
472
/* Specifics */
constant->lMagnitude = CONVERT(hap_constant->level);
dest->cbTypeSpecificParams = sizeof(FFCONSTANTFORCE);
dest->lpvTypeSpecificParams = constant;
/* Generics */
473
dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
474
475
dest->dwTriggerButton = FFJOFS_BUTTON(hap_constant->button);
dest->dwTriggerRepeatInterval = hap_constant->interval;
476
dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
477
478
/* Direction. */
479
if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
480
481
482
483
return -1;
}
/* Envelope */
484
485
486
487
envelope->dwAttackLevel = CONVERT(hap_constant->attack_level);
envelope->dwAttackTime = hap_constant->attack_length * 1000;
envelope->dwFadeLevel = CONVERT(hap_constant->fade_level);
envelope->dwFadeTime = hap_constant->fade_length * 1000;
488
489
490
491
492
493
494
495
break;
case SDL_HAPTIC_SINE:
case SDL_HAPTIC_SQUARE:
case SDL_HAPTIC_TRIANGLE:
case SDL_HAPTIC_SAWTOOTHUP:
case SDL_HAPTIC_SAWTOOTHDOWN:
496
hap_periodic = &src->periodic;
497
498
499
500
501
periodic = SDL_malloc(sizeof(FFPERIODIC));
if (periodic == NULL) {
SDL_OutOfMemory();
return -1;
}
502
SDL_memset(periodic, 0, sizeof(FFPERIODIC));
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
/* Specifics */
periodic->dwMagnitude = CONVERT(hap_periodic->magnitude);
periodic->lOffset = CONVERT(hap_periodic->offset);
periodic->dwPhase = hap_periodic->phase;
periodic->dwPeriod = hap_periodic->period * 1000;
dest->cbTypeSpecificParams = sizeof(FFPERIODIC);
dest->lpvTypeSpecificParams = periodic;
/* Generics */
dest->dwDuration = hap_periodic->length * 1000; /* In microseconds. */
dest->dwTriggerButton = FFJOFS_BUTTON(hap_periodic->button);
dest->dwTriggerRepeatInterval = hap_periodic->interval;
dest->dwStartDelay = hap_periodic->delay * 1000; /* In microseconds. */
/* Direction. */
if (SDL_SYS_SetDirection(dest, &hap_periodic->direction, dest->cAxes) < 0) {
return -1;
}
/* Envelope */
envelope->dwAttackLevel = CONVERT(hap_periodic->attack_level);
envelope->dwAttackTime = hap_periodic->attack_length * 1000;
envelope->dwFadeLevel = CONVERT(hap_periodic->fade_level);
envelope->dwFadeTime = hap_periodic->fade_length * 1000;
528
529
530
531
532
533
534
break;
case SDL_HAPTIC_SPRING:
case SDL_HAPTIC_DAMPER:
case SDL_HAPTIC_INERTIA:
case SDL_HAPTIC_FRICTION:
535
hap_condition = &src->condition;
536
537
538
539
540
condition = SDL_malloc(sizeof(FFCONDITION) * dest->cAxes);
if (condition == NULL) {
SDL_OutOfMemory();
return -1;
}
541
SDL_memset(condition, 0, sizeof(FFCONDITION));
542
543
544
/* Specifics */
for (i=0; i<dest->cAxes; i++) {
545
546
547
548
549
550
condition[i].lOffset = CONVERT(hap_condition->center[i]);
condition[i].lPositiveCoefficient = CONVERT(hap_condition->right_coeff[i]);
condition[i].lNegativeCoefficient = CONVERT(hap_condition->left_coeff[i]);
condition[i].dwPositiveSaturation = CONVERT(hap_condition->right_sat[i]);
condition[i].dwNegativeSaturation = CONVERT(hap_condition->left_sat[i]);
condition[i].lDeadBand = CONVERT(hap_condition->deadband[i]);
551
552
553
554
555
}
dest->cbTypeSpecificParams = sizeof(FFCONDITION) * dest->cAxes;
dest->lpvTypeSpecificParams = condition;
/* Generics */
556
557
558
559
dest->dwDuration = hap_condition->length * 1000; /* In microseconds. */
dest->dwTriggerButton = FFJOFS_BUTTON(hap_condition->button);
dest->dwTriggerRepeatInterval = hap_condition->interval;
dest->dwStartDelay = hap_condition->delay * 1000; /* In microseconds. */
560
561
/* Direction. */
562
if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes) < 0) {
563
564
565
return -1;
}
566
567
/* Envelope */
/* TODO Check is envelope actually used.
568
569
570
571
envelope->dwAttackLevel = CONVERT(hap_condition->attack_level);
envelope->dwAttackTime = hap_condition->attack_length * 1000;
envelope->dwFadeLevel = CONVERT(hap_condition->fade_level);
envelope->dwFadeTime = hap_condition->fade_length * 1000;
572
*/
573
574
575
576
break;
case SDL_HAPTIC_RAMP:
577
hap_ramp = &src->ramp;
578
579
580
581
582
ramp = SDL_malloc(sizeof(FFRAMPFORCE));
if (ramp == NULL) {
SDL_OutOfMemory();
return -1;
}
583
SDL_memset(ramp, 0, sizeof(FFRAMPFORCE));
584
585
/* Specifics */
586
ramp->lStart = CONVERT(hap_ramp->start);
587
ramp->lEnd = CONVERT(hap_ramp->end);
588
589
dest->cbTypeSpecificParams = sizeof(FFRAMPFORCE);
dest->lpvTypeSpecificParams = ramp;
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
/* Generics */
dest->dwDuration = hap_ramp->length * 1000; /* In microseconds. */
dest->dwTriggerButton = FFJOFS_BUTTON(hap_ramp->button);
dest->dwTriggerRepeatInterval = hap_ramp->interval;
dest->dwStartDelay = hap_ramp->delay * 1000; /* In microseconds. */
/* Direction. */
if (SDL_SYS_SetDirection(dest, &hap_ramp->direction, dest->cAxes) < 0) {
return -1;
}
/* Envelope */
envelope->dwAttackLevel = CONVERT(hap_ramp->attack_level);
envelope->dwAttackTime = hap_ramp->attack_length * 1000;
envelope->dwFadeLevel = CONVERT(hap_ramp->fade_level);
envelope->dwFadeTime = hap_ramp->fade_length * 1000;
607
608
609
break;
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
case SDL_HAPTIC_CUSTOM:
hap_custom = &src->custom;
custom = SDL_malloc(sizeof(FFCUSTOMFORCE));
if (custom == NULL) {
SDL_OutOfMemory();
return -1;
}
SDL_memset(custom, 0, sizeof(FFCUSTOMFORCE));
/* Specifics */
custom->cChannels = hap_custom->channels;
custom->dwSamplePeriod = hap_custom->period * 1000;
custom->cSamples = hap_custom->samples;
custom->rglForceData = SDL_malloc(sizeof(LONG)*custom->cSamples*custom->cChannels);
for (i=0; i<hap_custom->samples*hap_custom->channels; i++) { /* Copy data. */
custom->rglForceData[i] = CONVERT(hap_custom->data[i]);
}
dest->cbTypeSpecificParams = sizeof(FFCUSTOMFORCE);
dest->lpvTypeSpecificParams = custom;
/* Generics */
dest->dwDuration = hap_custom->length * 1000; /* In microseconds. */
dest->dwTriggerButton = FFJOFS_BUTTON(hap_custom->button);
dest->dwTriggerRepeatInterval = hap_custom->interval;
dest->dwStartDelay = hap_custom->delay * 1000; /* In microseconds. */
/* Direction. */
if (SDL_SYS_SetDirection(dest, &hap_custom->direction, dest->cAxes) < 0) {
return -1;
}
/* Envelope */
envelope->dwAttackLevel = CONVERT(hap_custom->attack_level);
envelope->dwAttackTime = hap_custom->attack_length * 1000;
envelope->dwFadeLevel = CONVERT(hap_custom->fade_level);
envelope->dwFadeTime = hap_custom->fade_length * 1000;
break;
649
650
651
652
653
654
655
656
657
658
default:
SDL_SetError("Haptic: Unknown effect type.");
return -1;
}
return 0;
}
659
660
661
/*
* Frees an FFEFFECT allocated by SDL_SYS_ToFFEFFECT.
*/
662
static void
663
SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect, int type )
664
{
665
666
FFCUSTOMFORCE *custom;
667
668
669
670
671
672
673
674
675
if (effect->lpEnvelope != NULL) {
SDL_free(effect->lpEnvelope);
effect->lpEnvelope = NULL;
}
if (effect->rgdwAxes != NULL) {
SDL_free(effect->rgdwAxes);
effect->rgdwAxes = NULL;
}
if (effect->lpvTypeSpecificParams != NULL) {
676
677
678
679
680
if (type == SDL_HAPTIC_CUSTOM) { /* Must free the custom data. */
custom = (FFCUSTOMFORCE*) effect->lpvTypeSpecificParams;
SDL_free(custom->rglForceData);
custom->rglForceData = NULL;
}
681
682
683
684
685
686
687
688
689
690
SDL_free(effect->lpvTypeSpecificParams);
effect->lpvTypeSpecificParams = NULL;
}
if (effect->rglDirection != NULL) {
SDL_free(effect->rglDirection);
effect->rglDirection = NULL;
}
}
691
692
693
/*
* Gets the effect type from the generic SDL haptic effect wrapper.
*/
694
695
CFUUIDRef
SDL_SYS_HapticEffectType(struct haptic_effect * effect)
696
{
697
switch (effect->effect.type) {
698
699
700
701
702
703
704
705
706
707
708
709
case SDL_HAPTIC_CONSTANT:
return kFFEffectType_ConstantForce_ID;
case SDL_HAPTIC_RAMP:
return kFFEffectType_RampForce_ID;
case SDL_HAPTIC_SQUARE:
return kFFEffectType_Square_ID;
case SDL_HAPTIC_SINE:
return kFFEffectType_Sine_ID;
710
case SDL_HAPTIC_TRIANGLE:
711
712
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
748
749
750
751
752
753
754
755
return kFFEffectType_Triangle_ID;
case SDL_HAPTIC_SAWTOOTHUP:
return kFFEffectType_SawtoothUp_ID;
case SDL_HAPTIC_SAWTOOTHDOWN:
return kFFEffectType_SawtoothDown_ID;
case SDL_HAPTIC_SPRING:
return kFFEffectType_Spring_ID;
case SDL_HAPTIC_DAMPER:
return kFFEffectType_Damper_ID;
case SDL_HAPTIC_INERTIA:
return kFFEffectType_Inertia_ID;
case SDL_HAPTIC_FRICTION:
return kFFEffectType_Friction_ID;
case SDL_HAPTIC_CUSTOM:
return kFFEffectType_CustomForce_ID;
default:
SDL_SetError("Haptic: Unknown effect type.");
return NULL;
}
}
/*
* Creates a new haptic effect.
*/
int
SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
SDL_HapticEffect * base)
{
HRESULT ret;
CFUUIDRef type;
/* Alloc the effect. */
effect->hweffect = (struct haptic_hweffect *)
SDL_malloc(sizeof(struct haptic_hweffect));
if (effect->hweffect == NULL) {
SDL_OutOfMemory();
756
goto err_hweffect;
757
758
759
760
761
}
/* Get the type. */
type = SDL_SYS_HapticEffectType(effect);
if (type == NULL) {
762
goto err_hweffect;
763
764
765
}
/* Get the effect. */
766
767
if (SDL_SYS_ToFFEFFECT(haptic, &effect->hweffect->effect, &effect->effect ) < 0) {
goto err_effectdone;
768
769
}
770
/* Create the actual effect. */
771
772
ret = FFDeviceCreateEffect( haptic->hwdata->device, type,
&effect->hweffect->effect, &effect->hweffect->ref );
773
774
775
776
777
778
779
780
781
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to create effect.");
goto err_effectdone;
}
return 0;
err_effectdone:
782
SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, effect->effect.type);
783
784
785
786
787
788
err_hweffect:
if (effect->hweffect != NULL) {
SDL_free(effect->hweffect);
effect->hweffect = NULL;
}
return -1;
789
790
791
792
793
794
}
/*
* Updates an effect.
*/
795
796
int
SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
struct haptic_effect * effect, SDL_HapticEffect * data)
{
/* TODO */
return -1;
}
/*
* Runs an effect.
*/
int
SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
Uint32 iterations)
{
HRESULT ret;
Uint32 iter;
/* Check if it's infinite. */
if (iterations == SDL_HAPTIC_INFINITY) {
816
iter = FF_INFINITE;
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
}
else
iter = iterations;
/* Run the effect. */
ret = FFEffectStart(effect->hweffect->ref, iter, 0);
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to run the effect.");
return -1;
}
return 0;
}
/*
* Stops an effect.
*/
int
SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
{
HRESULT ret;
ret = FFEffectStop(effect->hweffect->ref);
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to stop the effect.");
return -1;
}
return 0;
}
/*
* Frees the effect.
*/
void
SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
{
HRESULT ret;
ret = FFDeviceReleaseEffect(haptic->hwdata->device, effect->hweffect->ref);
if (ret != FF_OK) {
SDL_SetError("Haptic: Error removing the effect from the device.");
}
SDL_free(effect->hweffect->effect.lpvTypeSpecificParams);
effect->hweffect->effect.lpvTypeSpecificParams = NULL;
SDL_free(effect->hweffect);
effect->hweffect = NULL;
}
/*
* Gets the status of a haptic effect.
*/
int
SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic, struct haptic_effect * effect)
{
HRESULT ret;
FFEffectStatusFlag status;
878
ret = FFEffectGetEffectStatus(effect->hweffect->ref, &status);
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to get effect status.");
return -1;
}
if (status == 0) return SDL_FALSE;
return SDL_TRUE; /* Assume it's playing or emulated. */
}
/*
* Sets the gain.
*/
int
SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain)
{
HRESULT ret;
Uint32 val;
val = gain * 100; /* Mac OS X uses 0 to 10,000 */
ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device, FFPROP_FFGAIN, &val);
if (ret != FF_OK) {
SDL_SetError("Haptic: Error setting gain.");
return -1;
}
return 0;
}
/*
* Sets the autocentering.
*/
int
SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
{
HRESULT ret;
Uint32 val;
/* Mac OS X only has 0 (off) and 1 (on) */
if (autocenter == 0) val = 0;
else val = 1;
ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device,
923
FFPROP_AUTOCENTER, &val);
924
925
926
927
928
929
930
931
932
933
934
if (ret != FF_OK) {
SDL_SetError("Haptic: Error setting autocenter.");
return -1;
}
return 0;
}
#endif /* SDL_HAPTIC_LINUX */