This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syshaptic.c
1179 lines (987 loc) · 32.3 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
#include <ForceFeedback/ForceFeedback.h>
#include <ForceFeedback/ForceFeedbackConstants.h>
#define MAX_HAPTICS 32
/*
* List of available haptic devices.
*/
static struct
{
46
char name[256];
47
48
49
50
51
52
53
54
55
56
57
io_service_t dev;
SDL_Haptic *haptic;
} SDL_hapticlist[MAX_HAPTICS];
/*
* Haptic system hardware data.
*/
struct haptic_hwdata
{
FFDeviceObjectReference device; /* Hardware device. */
58
UInt8 axes[3];
59
60
61
62
63
64
65
66
67
68
69
70
};
/*
* Haptic system effect data.
*/
struct haptic_hweffect
{
FFEffectObjectReference ref; /* Reference. */
struct FFEFFECT effect; /* Hardware effect. */
};
71
72
73
/*
* Prototypes.
*/
74
75
static void SDL_SYS_HapticFreeFFEFFECT(FFEFFECT * effect, int type);
static int HIDGetDeviceProduct(io_service_t dev, char * name);
76
77
78
79
80
81
82
83
84
85
86
/*
* Like strerror but for force feedback errors.
*/
static const char *
FFStrError(HRESULT err)
{
switch (err) {
case FFERR_DEVICEFULL:
return "device full";
87
/* This should be valid, but for some reason isn't defined... */
88
89
/*case FFERR_DEVICENOTREG:
return "device not registered";*/
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
case FFERR_DEVICEPAUSED:
return "device paused";
case FFERR_DEVICERELEASED:
return "device released";
case FFERR_EFFECTPLAYING:
return "effect playing";
case FFERR_EFFECTTYPEMISMATCH:
return "effect type mismatch";
case FFERR_EFFECTTYPENOTSUPPORTED:
return "effect type not supported";
case FFERR_GENERIC:
return "undetermined error";
case FFERR_HASEFFECTS:
return "device has effects";
case FFERR_INCOMPLETEEFFECT:
return "incomplete effect";
case FFERR_INTERNAL:
return "internal fault";
case FFERR_INVALIDDOWNLOADID:
return "invalid download id";
case FFERR_INVALIDPARAM:
return "invalid parameter";
case FFERR_MOREDATA:
return "more data";
case FFERR_NOINTERFACE:
return "interface not supported";
case FFERR_NOTDOWNLOADED:
return "effect is not downloaded";
case FFERR_NOTINITIALIZED:
return "object has not been initialized";
case FFERR_OUTOFMEMORY:
return "out of memory";
case FFERR_UNPLUGGED:
return "device is unplugged";
case FFERR_UNSUPPORTED:
return "function call unsupported";
case FFERR_UNSUPPORTEDAXIS:
return "axis unsupported";
default:
return "unknown error";
}
}
135
136
137
138
139
140
141
142
143
144
/*
* Initializes the haptic subsystem.
*/
int
SDL_SYS_HapticInit(void)
{
int numhaptics;
IOReturn result;
io_iterator_t iter;
CFDictionaryRef match;
145
io_service_t device;
146
147
148
149
/* Clear all the memory. */
SDL_memset(SDL_hapticlist, 0, sizeof(SDL_hapticlist));
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/* 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) {
170
HIDGetDeviceProduct(device, SDL_hapticlist[numhaptics].name);
171
172
173
174
SDL_hapticlist[numhaptics].dev = device;
SDL_hapticlist[numhaptics].haptic = NULL;
numhaptics++;
}
175
176
177
else { /* Free the unused device. */
IOObjectRelease(device);
}
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/* 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)
{
195
196
197
198
199
200
201
202
203
204
205
return SDL_hapticlist[index].name;
}
/*
* Gets the device's product name.
*/
static int
HIDGetDeviceProduct(io_service_t dev, char *name)
{
CFMutableDictionaryRef hidProperties, usbProperties;
io_registry_entry_t parent1, parent2;
206
kern_return_t ret;
207
208
209
hidProperties = usbProperties = 0;
210
ret = IORegistryEntryCreateCFProperties(dev, &hidProperties,
211
212
213
214
215
216
217
kCFAllocatorDefault,
kNilOptions);
if ((ret != KERN_SUCCESS) || !hidProperties) {
SDL_SetError("Haptic: Unable to create CFProperties.");
return -1;
}
218
219
220
221
222
223
224
225
226
/* Mac OS X currently is not mirroring all USB properties to HID page so need to look at USB device page also
* get dictionary for usb properties: step up two levels and get CF dictionary for USB properties
*/
if ((KERN_SUCCESS ==
IORegistryEntryGetParentEntry(dev, kIOServicePlane, &parent1))
&& (KERN_SUCCESS ==
IORegistryEntryGetParentEntry(parent1, kIOServicePlane, &parent2))
&& (KERN_SUCCESS ==
IORegistryEntryCreateCFProperties(parent2, &usbProperties,
227
228
kCFAllocatorDefault,
kNilOptions))) {
229
230
231
232
233
234
235
236
if (usbProperties) {
CFTypeRef refCF = 0;
/* get device info
* try hid dictionary first, if fail then go to usb dictionary
*/
/* Get product name */
237
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDProductKey));
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
if (!refCF)
refCF =
CFDictionaryGetValue(usbProperties, CFSTR("USB Product Name"));
if (refCF) {
if (!CFStringGetCString(refCF, name, 256,
CFStringGetSystemEncoding())) {
SDL_SetError("CFStringGetCString error retrieving pDevice->product.");
return -1;
}
}
CFRelease(usbProperties);
}
else {
SDL_SetError("IORegistryEntryCreateCFProperties failed to create usbProperties.");
return -1;
}
/* Release stuff. */
if (kIOReturnSuccess != IOObjectRelease(parent2)) {
SDL_SetError("IOObjectRelease error with parent2.");
}
if (kIOReturnSuccess != IOObjectRelease(parent1)) {
SDL_SetError("IOObjectRelease error with parent1.");
}
}
264
265
266
267
268
else {
SDL_SetError("Haptic: Error getting registry entries.");
return -1;
}
269
return 0;
270
271
272
273
}
#define FF_TEST(ff, s) \
274
if (features.supportedEffects & (ff)) supported |= (s)
275
276
277
278
/*
* Gets supported features.
*/
static unsigned int
279
GetSupportedFeatures(SDL_Haptic* haptic)
280
281
{
HRESULT ret;
282
FFDeviceObjectReference device;
283
284
285
286
FFCAPABILITIES features;
unsigned int supported;
Uint32 val;
287
288
device = haptic->hwdata->device;
289
290
291
ret = FFDeviceGetForceFeedbackCapabilities(device, &features);
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to get device's supported features.");
292
return -1;
293
294
295
296
297
}
supported = 0;
/* Get maximum effects. */
298
299
haptic->neffects = features.storageCapacity;
haptic->nplaying = features.playbackCapacity;
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
/* 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. */
316
317
ret = FFDeviceGetForceFeedbackProperty( device, FFPROP_FFGAIN,
&val, sizeof(val));
318
319
if (ret == FF_OK) supported |= SDL_HAPTIC_GAIN;
else if (ret != FFERR_UNSUPPORTED) {
320
SDL_SetError("Haptic: Unable to get if device supports gain: %s.",
321
FFStrError(ret));
322
return -1;
323
324
325
}
/* Checks if supports autocenter. */
326
ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_AUTOCENTER,
327
&val, sizeof(val));
328
329
if (ret == FF_OK) supported |= SDL_HAPTIC_AUTOCENTER;
else if (ret != FFERR_UNSUPPORTED) {
330
331
SDL_SetError("Haptic: Unable to get if device supports autocenter: %s.",
FFStrError(ret));
332
return -1;
333
334
}
335
/* Check for axes, we have an artificial limit on axes */
336
haptic->naxes = ((features.numFfAxes) > 3) ?
337
3 : features.numFfAxes;
338
339
/* Actually store the axes we want to use */
SDL_memcpy( haptic->hwdata->axes, features.ffAxes, haptic->naxes * sizeof(Uint8));
340
341
342
/* Always supported features. */
supported |= SDL_HAPTIC_STATUS;
343
344
345
haptic->supported = supported;
return 0;;
346
347
348
349
350
351
352
353
354
}
/*
* Opens the haptic device from the file descriptor.
*/
static int
SDL_SYS_HapticOpenFromService(SDL_Haptic * haptic, io_service_t service)
{
355
HRESULT ret;
356
int ret2;
357
358
359
360
361
362
363
364
365
366
367
/* 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 */
368
369
370
371
ret = FFCreateDevice( service, &haptic->hwdata->device);
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to create device from service: %s.",
FFStrError(ret));
372
373
374
375
goto creat_err;
}
/* Get supported features. */
376
377
ret2 = GetSupportedFeatures( haptic );
if (haptic->supported < 0) {
378
379
goto open_err;
}
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/* Reset and then enable actuators. */
ret = FFDeviceSendForceFeedbackCommand( haptic->hwdata->device,
FFSFFC_RESET );
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to reset device: %s.", FFStrError(ret));
goto open_err;
}
ret = FFDeviceSendForceFeedbackCommand( haptic->hwdata->device,
FFSFFC_SETACTUATORSON );
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to enable actuators: %s.", FFStrError(ret));
goto open_err;
}
/* Allocate effects memory. */
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
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,
430
SDL_hapticlist[haptic->index].dev);
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
}
/*
* 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)
{
if (haptic->hwdata) {
482
/* Free Effects. */
483
SDL_free(haptic->effects);
484
haptic->effects = NULL;
485
486
haptic->neffects = 0;
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
/* 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++) {
506
507
508
509
/* Opened and not closed haptics are leaked, this is on purpose.
* Close your haptic devices after usage. */
/* Free the io_service_t */
510
511
512
513
514
IOObjectRelease(SDL_hapticlist[i].dev);
}
}
515
516
517
518
519
520
521
522
523
524
/*
* Converts an SDL trigger button to an FFEFFECT trigger button.
*/
static DWORD
FFGetTriggerButton( Uint16 button )
{
DWORD dwTriggerButton;
dwTriggerButton = FFEB_NOTRIGGER;
525
if (button != 0) {
526
dwTriggerButton = FFJOFS_BUTTON(button - 1);
527
}
528
529
530
531
532
return dwTriggerButton;
}
533
534
535
536
/*
* Sets the direction.
*/
static int
537
SDL_SYS_SetDirection( FFEFFECT * effect, SDL_HapticDirection *dir, int naxes )
538
{
539
LONG *rglDir;
540
541
/* Handle no axes a part. */
542
if (naxes == 0) {
543
effect->dwFlags |= FFEFF_SPHERICAL; /* Set as default. */
544
545
546
547
548
effect->rglDirection = NULL;
return 0;
}
/* Has axes. */
549
rglDir = SDL_malloc( sizeof(LONG) * naxes );
550
if (rglDir == NULL) {
551
552
553
SDL_OutOfMemory();
return -1;
}
554
SDL_memset( rglDir, 0, sizeof(LONG) * naxes );
555
effect->rglDirection = rglDir;
556
557
558
559
switch (dir->type) {
case SDL_HAPTIC_POLAR:
effect->dwFlags |= FFEFF_POLAR;
560
rglDir[0] = dir->dir[0];
561
562
return 0;
case SDL_HAPTIC_CARTESIAN:
563
effect->dwFlags |= FFEFF_CARTESIAN;
564
rglDir[0] = dir->dir[0];
565
566
567
568
if (naxes > 1)
rglDir[1] = dir->dir[1];
if (naxes > 2)
rglDir[2] = dir->dir[2];
569
return 0;
570
case SDL_HAPTIC_SPHERICAL:
571
effect->dwFlags |= FFEFF_SPHERICAL;
572
rglDir[0] = dir->dir[0];
573
574
575
576
if (naxes > 1)
rglDir[1] = dir->dir[1];
if (naxes > 2)
rglDir[2] = dir->dir[2];
577
578
579
580
581
582
583
584
return 0;
default:
SDL_SetError("Haptic: Unknown direction type.");
return -1;
}
}
585
#define CONVERT(x) (((x) > 0x7FFF) ? 10000 : ((x)*10000) / 0x7FFF)
586
/*
587
* Creates the FFEFFECT from a SDL_HapticEffect.
588
589
*/
static int
590
SDL_SYS_ToFFEFFECT( SDL_Haptic * haptic, FFEFFECT * dest, SDL_HapticEffect * src )
591
{
592
int i;
593
594
FFCONSTANTFORCE *constant;
FFPERIODIC *periodic;
595
FFCONDITION *condition; /* Actually an array of conditions - one per axis. */
596
597
FFRAMPFORCE *ramp;
FFCUSTOMFORCE *custom;
598
FFENVELOPE *envelope;
599
SDL_HapticConstant *hap_constant;
600
SDL_HapticPeriodic *hap_periodic;
601
602
SDL_HapticCondition *hap_condition;
SDL_HapticRamp *hap_ramp;
603
SDL_HapticCustom *hap_custom;
604
DWORD *axes;
605
606
607
608
609
610
/* 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. */
611
dest->dwFlags = FFEFF_OBJECTOFFSETS; /* Seems obligatory. */
612
613
614
615
616
617
618
619
620
621
/* 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. */
622
623
624
625
626
627
628
629
630
/* Axes. */
dest->cAxes = haptic->naxes;
if (dest->cAxes > 0) {
axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
if (axes == NULL) {
SDL_OutOfMemory();
return -1;
}
631
axes[0] = haptic->hwdata->axes[0]; /* Always at least one axis. */
632
if (dest->cAxes > 1) {
633
axes[1] = haptic->hwdata->axes[1];
634
635
}
if (dest->cAxes > 2) {
636
axes[2] = haptic->hwdata->axes[2];
637
638
639
640
641
}
dest->rgdwAxes = axes;
}
642
/* The big type handling switch, even bigger then linux's version. */
643
644
645
646
switch (src->type) {
case SDL_HAPTIC_CONSTANT:
hap_constant = &src->constant;
constant = SDL_malloc( sizeof(FFCONSTANTFORCE) );
647
648
649
650
if (constant == NULL) {
SDL_OutOfMemory();
return -1;
}
651
SDL_memset(constant, 0, sizeof(FFCONSTANTFORCE));
652
653
654
655
656
657
658
/* Specifics */
constant->lMagnitude = CONVERT(hap_constant->level);
dest->cbTypeSpecificParams = sizeof(FFCONSTANTFORCE);
dest->lpvTypeSpecificParams = constant;
/* Generics */
659
dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
660
dest->dwTriggerButton = FFGetTriggerButton(hap_constant->button);
661
dest->dwTriggerRepeatInterval = hap_constant->interval;
662
dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
663
664
/* Direction. */
665
if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
666
667
668
669
return -1;
}
/* Envelope */
670
if ((hap_constant->attack_length==0) && (hap_constant->fade_length==0)) {
671
672
SDL_free(envelope);
dest->lpEnvelope = NULL;
673
674
675
676
677
678
679
}
else {
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;
}
680
681
682
683
684
685
686
687
break;
case SDL_HAPTIC_SINE:
case SDL_HAPTIC_SQUARE:
case SDL_HAPTIC_TRIANGLE:
case SDL_HAPTIC_SAWTOOTHUP:
case SDL_HAPTIC_SAWTOOTHDOWN:
688
hap_periodic = &src->periodic;
689
690
691
692
693
periodic = SDL_malloc(sizeof(FFPERIODIC));
if (periodic == NULL) {
SDL_OutOfMemory();
return -1;
}
694
SDL_memset(periodic, 0, sizeof(FFPERIODIC));
695
696
697
698
699
700
701
702
703
704
705
/* 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. */
706
dest->dwTriggerButton = FFGetTriggerButton(hap_periodic->button);
707
708
709
710
711
712
713
714
715
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 */
716
if ((hap_periodic->attack_length==0) && (hap_periodic->fade_length==0)) {
717
718
SDL_free(envelope);
dest->lpEnvelope = NULL;
719
720
721
722
723
724
725
}
else {
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;
}
726
727
728
729
730
731
732
break;
case SDL_HAPTIC_SPRING:
case SDL_HAPTIC_DAMPER:
case SDL_HAPTIC_INERTIA:
case SDL_HAPTIC_FRICTION:
733
hap_condition = &src->condition;
734
735
736
737
738
condition = SDL_malloc(sizeof(FFCONDITION) * dest->cAxes);
if (condition == NULL) {
SDL_OutOfMemory();
return -1;
}
739
SDL_memset(condition, 0, sizeof(FFCONDITION));
740
741
742
/* Specifics */
for (i=0; i<dest->cAxes; i++) {
743
744
745
746
747
748
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]);
749
750
751
752
753
}
dest->cbTypeSpecificParams = sizeof(FFCONDITION) * dest->cAxes;
dest->lpvTypeSpecificParams = condition;
/* Generics */
754
dest->dwDuration = hap_condition->length * 1000; /* In microseconds. */
755
dest->dwTriggerButton = FFGetTriggerButton(hap_condition->button);
756
757
dest->dwTriggerRepeatInterval = hap_condition->interval;
dest->dwStartDelay = hap_condition->delay * 1000; /* In microseconds. */
758
759
/* Direction. */
760
if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes) < 0) {
761
762
763
return -1;
}
764
/* Envelope */
765
766
SDL_free(dest->lpEnvelope);
dest->lpEnvelope = NULL;
767
/* TODO Check is envelope actually used.
768
769
770
771
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;
772
*/
773
774
775
776
break;
case SDL_HAPTIC_RAMP:
777
hap_ramp = &src->ramp;
778
779
780
781
782
ramp = SDL_malloc(sizeof(FFRAMPFORCE));
if (ramp == NULL) {
SDL_OutOfMemory();
return -1;
}
783
SDL_memset(ramp, 0, sizeof(FFRAMPFORCE));
784
785
/* Specifics */
786
ramp->lStart = CONVERT(hap_ramp->start);
787
ramp->lEnd = CONVERT(hap_ramp->end);
788
789
dest->cbTypeSpecificParams = sizeof(FFRAMPFORCE);
dest->lpvTypeSpecificParams = ramp;
790
791
792
/* Generics */
dest->dwDuration = hap_ramp->length * 1000; /* In microseconds. */
793
dest->dwTriggerButton = FFGetTriggerButton(hap_ramp->button);
794
795
796
797
798
799
800
801
802
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 */
803
if ((hap_ramp->attack_length==0) && (hap_ramp->fade_length==0)) {
804
805
SDL_free(envelope);
dest->lpEnvelope = NULL;
806
}
807
808
809
810
811
812
else {
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;
}
813
814
815
break;
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
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. */
838
dest->dwTriggerButton = FFGetTriggerButton(hap_custom->button);
839
840
841
842
843
844
845
846
847
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 */
848
if ((hap_custom->attack_length==0) && (hap_custom->fade_length==0)) {
849
850
SDL_free(envelope);
dest->lpEnvelope = NULL;
851
852
853
854
855
856
857
}
else {
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;
}
858
859
860
break;
861
862
863
864
865
866
867
868
869
870
default:
SDL_SetError("Haptic: Unknown effect type.");
return -1;
}
return 0;
}
871
872
873
/*
* Frees an FFEFFECT allocated by SDL_SYS_ToFFEFFECT.
*/
874
static void
875
SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect, int type )
876
{
877
878
FFCUSTOMFORCE *custom;
879
880
881
882
883
884
885
886
887
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) {
888
889
890
891
892
if (type == SDL_HAPTIC_CUSTOM) { /* Must free the custom data. */
custom = (FFCUSTOMFORCE*) effect->lpvTypeSpecificParams;
SDL_free(custom->rglForceData);
custom->rglForceData = NULL;
}
893
894
895
896
897
898
899
900
901
902
SDL_free(effect->lpvTypeSpecificParams);
effect->lpvTypeSpecificParams = NULL;
}
if (effect->rglDirection != NULL) {
SDL_free(effect->rglDirection);
effect->rglDirection = NULL;
}
}
903
904
905
/*
* Gets the effect type from the generic SDL haptic effect wrapper.
*/
906
CFUUIDRef
907
SDL_SYS_HapticEffectType( Uint16 type )
908
{
909
switch (type) {
910
911
912
913
914
915
916
917
918
919
920
921
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;
922
case SDL_HAPTIC_TRIANGLE:
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
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();
968
goto err_hweffect;
969
970
971
}
/* Get the type. */
972
type = SDL_SYS_HapticEffectType(base->type);
973
if (type == NULL) {
974
goto err_hweffect;
975
976
977
}
/* Get the effect. */
978
if (SDL_SYS_ToFFEFFECT(haptic, &effect->hweffect->effect, base) < 0) {
979
goto err_effectdone;
980
981
}
982
/* Create the actual effect. */
983
984
ret = FFDeviceCreateEffect(haptic->hwdata->device, type,
&effect->hweffect->effect, &effect->hweffect->ref);
985
if (ret != FF_OK) {
986
SDL_SetError("Haptic: Unable to create effect: %s.", FFStrError(ret));
987
988
989
990
991
992
goto err_effectdone;
}
return 0;
err_effectdone:
993
SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, base->type);
994
995
996
997
998
999
err_hweffect:
if (effect->hweffect != NULL) {
SDL_free(effect->hweffect);
effect->hweffect = NULL;
}
return -1;
1000
}