This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syshaptic.c
1172 lines (982 loc) · 32.2 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
58
59
60
61
62
63
64
65
66
67
68
69
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. */
};
70
71
72
/*
* Prototypes.
*/
73
74
static void SDL_SYS_HapticFreeFFEFFECT(FFEFFECT * effect, int type);
static int HIDGetDeviceProduct(io_service_t dev, char * name);
75
76
77
78
79
80
81
82
83
84
85
/*
* Like strerror but for force feedback errors.
*/
static const char *
FFStrError(HRESULT err)
{
switch (err) {
case FFERR_DEVICEFULL:
return "device full";
86
/* This should be valid, but for some reason isn't defined... */
87
88
/*case FFERR_DEVICENOTREG:
return "device not registered";*/
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
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";
}
}
134
135
136
137
138
139
140
141
142
143
/*
* Initializes the haptic subsystem.
*/
int
SDL_SYS_HapticInit(void)
{
int numhaptics;
IOReturn result;
io_iterator_t iter;
CFDictionaryRef match;
144
io_service_t device;
145
146
147
148
/* Clear all the memory. */
SDL_memset(SDL_hapticlist, 0, sizeof(SDL_hapticlist));
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/* 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) {
169
HIDGetDeviceProduct(device, SDL_hapticlist[numhaptics].name);
170
171
172
173
SDL_hapticlist[numhaptics].dev = device;
SDL_hapticlist[numhaptics].haptic = NULL;
numhaptics++;
}
174
175
176
else { /* Free the unused device. */
IOObjectRelease(device);
}
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/* 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)
{
194
195
196
197
198
199
200
201
202
203
204
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;
205
kern_return_t ret;
206
207
208
hidProperties = usbProperties = 0;
209
ret = IORegistryEntryCreateCFProperties(dev, &hidProperties,
210
211
212
213
214
215
216
kCFAllocatorDefault,
kNilOptions);
if ((ret != KERN_SUCCESS) || !hidProperties) {
SDL_SetError("Haptic: Unable to create CFProperties.");
return -1;
}
217
218
219
220
221
222
223
224
225
/* 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,
226
227
kCFAllocatorDefault,
kNilOptions))) {
228
229
230
231
232
233
234
235
if (usbProperties) {
CFTypeRef refCF = 0;
/* get device info
* try hid dictionary first, if fail then go to usb dictionary
*/
/* Get product name */
236
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDProductKey));
237
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
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.");
}
}
263
264
265
266
267
else {
SDL_SetError("Haptic: Error getting registry entries.");
return -1;
}
268
return 0;
269
270
271
272
}
#define FF_TEST(ff, s) \
273
if (features.supportedEffects & (ff)) supported |= (s)
274
275
276
277
278
/*
* Gets supported features.
*/
static unsigned int
GetSupportedFeatures(FFDeviceObjectReference device,
279
int *neffects, int *nplaying, int *naxes)
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
{
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. */
313
314
ret = FFDeviceGetForceFeedbackProperty( device, FFPROP_FFGAIN,
&val, sizeof(val));
315
316
if (ret == FF_OK) supported |= SDL_HAPTIC_GAIN;
else if (ret != FFERR_UNSUPPORTED) {
317
SDL_SetError("Haptic: Unable to get if device supports gain: %s.",
318
FFStrError(ret));
319
320
321
322
return 0;
}
/* Checks if supports autocenter. */
323
ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_AUTOCENTER,
324
&val, sizeof(val));
325
326
if (ret == FF_OK) supported |= SDL_HAPTIC_AUTOCENTER;
else if (ret != FFERR_UNSUPPORTED) {
327
328
SDL_SetError("Haptic: Unable to get if device supports autocenter: %s.",
FFStrError(ret));
329
330
331
return 0;
}
332
/* Check for axes, we have an artificial limit on axes */
333
*naxes = ((features.numFfAxes) > 3) ?
334
335
3 : features.numFfAxes;
336
337
338
339
340
341
342
343
344
345
346
347
/* 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)
{
348
349
HRESULT ret;
350
351
352
353
354
355
356
357
358
359
/* 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 */
360
361
362
363
ret = FFCreateDevice( service, &haptic->hwdata->device);
if (ret != FF_OK) {
SDL_SetError("Haptic: Unable to create device from service: %s.",
FFStrError(ret));
364
365
366
367
goto creat_err;
}
/* Get supported features. */
368
369
370
haptic->supported = GetSupportedFeatures( haptic->hwdata->device,
&haptic->neffects, &haptic->nplaying,
&haptic->naxes );
371
372
373
if (haptic->supported == 0) { /* Error since device supports nothing. */
goto open_err;
}
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
/* 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. */
392
393
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
419
420
421
422
423
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,
424
SDL_hapticlist[haptic->index].dev);
425
426
427
428
429
430
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
}
/*
* 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) {
476
/* Free Effects. */
477
SDL_free(haptic->effects);
478
haptic->effects = NULL;
479
480
haptic->neffects = 0;
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/* 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++) {
500
501
502
503
/* Opened and not closed haptics are leaked, this is on purpose.
* Close your haptic devices after usage. */
/* Free the io_service_t */
504
505
506
507
508
IOObjectRelease(SDL_hapticlist[i].dev);
}
}
509
510
511
512
513
514
515
516
517
518
/*
* Converts an SDL trigger button to an FFEFFECT trigger button.
*/
static DWORD
FFGetTriggerButton( Uint16 button )
{
DWORD dwTriggerButton;
dwTriggerButton = FFEB_NOTRIGGER;
519
if (button != 0) {
520
dwTriggerButton = FFJOFS_BUTTON(button - 1);
521
}
522
523
524
525
526
return dwTriggerButton;
}
527
528
529
530
/*
* Sets the direction.
*/
static int
531
SDL_SYS_SetDirection( FFEFFECT * effect, SDL_HapticDirection *dir, int naxes )
532
{
533
LONG *rglDir;
534
535
/* Handle no axes a part. */
536
if (naxes == 0) {
537
effect->dwFlags |= FFEFF_SPHERICAL; /* Set as default. */
538
539
540
541
542
effect->rglDirection = NULL;
return 0;
}
/* Has axes. */
543
rglDir = SDL_malloc( sizeof(LONG) * naxes );
544
if (rglDir == NULL) {
545
546
547
SDL_OutOfMemory();
return -1;
}
548
SDL_memset( rglDir, 0, sizeof(LONG) * naxes );
549
effect->rglDirection = rglDir;
550
551
552
553
switch (dir->type) {
case SDL_HAPTIC_POLAR:
effect->dwFlags |= FFEFF_POLAR;
554
rglDir[0] = dir->dir[0];
555
556
return 0;
case SDL_HAPTIC_CARTESIAN:
557
effect->dwFlags |= FFEFF_CARTESIAN;
558
rglDir[0] = dir->dir[0];
559
560
561
562
if (naxes > 1)
rglDir[1] = dir->dir[1];
if (naxes > 2)
rglDir[2] = dir->dir[2];
563
return 0;
564
case SDL_HAPTIC_SPHERICAL:
565
effect->dwFlags |= FFEFF_SPHERICAL;
566
rglDir[0] = dir->dir[0];
567
568
569
570
if (naxes > 1)
rglDir[1] = dir->dir[1];
if (naxes > 2)
rglDir[2] = dir->dir[2];
571
572
573
574
575
576
577
578
return 0;
default:
SDL_SetError("Haptic: Unknown direction type.");
return -1;
}
}
579
#define CONVERT(x) (((x)*10000) / 0x7FFF)
580
/*
581
* Creates the FFEFFECT from a SDL_HapticEffect.
582
583
*/
static int
584
SDL_SYS_ToFFEFFECT( SDL_Haptic * haptic, FFEFFECT * dest, SDL_HapticEffect * src )
585
{
586
int i;
587
588
FFCONSTANTFORCE *constant;
FFPERIODIC *periodic;
589
FFCONDITION *condition; /* Actually an array of conditions - one per axis. */
590
591
FFRAMPFORCE *ramp;
FFCUSTOMFORCE *custom;
592
FFENVELOPE *envelope;
593
SDL_HapticConstant *hap_constant;
594
SDL_HapticPeriodic *hap_periodic;
595
596
SDL_HapticCondition *hap_condition;
SDL_HapticRamp *hap_ramp;
597
SDL_HapticCustom *hap_custom;
598
DWORD *axes;
599
600
601
602
603
604
/* 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. */
605
606
607
608
609
610
611
612
613
614
/* 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. */
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
/* 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;
}
635
/* The big type handling switch, even bigger then linux's version. */
636
637
638
639
switch (src->type) {
case SDL_HAPTIC_CONSTANT:
hap_constant = &src->constant;
constant = SDL_malloc( sizeof(FFCONSTANTFORCE) );
640
641
642
643
if (constant == NULL) {
SDL_OutOfMemory();
return -1;
}
644
SDL_memset(constant, 0, sizeof(FFCONSTANTFORCE));
645
646
647
648
649
650
651
/* Specifics */
constant->lMagnitude = CONVERT(hap_constant->level);
dest->cbTypeSpecificParams = sizeof(FFCONSTANTFORCE);
dest->lpvTypeSpecificParams = constant;
/* Generics */
652
dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
653
dest->dwTriggerButton = FFGetTriggerButton(hap_constant->button);
654
dest->dwTriggerRepeatInterval = hap_constant->interval;
655
dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
656
657
/* Direction. */
658
if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
659
660
661
662
return -1;
}
/* Envelope */
663
if ((hap_constant->attack_length==0) && (hap_constant->fade_length==0)) {
664
665
SDL_free(envelope);
dest->lpEnvelope = NULL;
666
667
668
669
670
671
672
}
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;
}
673
674
675
676
677
678
679
680
break;
case SDL_HAPTIC_SINE:
case SDL_HAPTIC_SQUARE:
case SDL_HAPTIC_TRIANGLE:
case SDL_HAPTIC_SAWTOOTHUP:
case SDL_HAPTIC_SAWTOOTHDOWN:
681
hap_periodic = &src->periodic;
682
683
684
685
686
periodic = SDL_malloc(sizeof(FFPERIODIC));
if (periodic == NULL) {
SDL_OutOfMemory();
return -1;
}
687
SDL_memset(periodic, 0, sizeof(FFPERIODIC));
688
689
690
691
692
693
694
695
696
697
698
/* 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. */
699
dest->dwTriggerButton = FFGetTriggerButton(hap_periodic->button);
700
701
702
703
704
705
706
707
708
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 */
709
if ((hap_periodic->attack_length==0) && (hap_periodic->fade_length==0)) {
710
711
SDL_free(envelope);
dest->lpEnvelope = NULL;
712
713
714
715
716
717
718
}
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;
}
719
720
721
722
723
724
725
break;
case SDL_HAPTIC_SPRING:
case SDL_HAPTIC_DAMPER:
case SDL_HAPTIC_INERTIA:
case SDL_HAPTIC_FRICTION:
726
hap_condition = &src->condition;
727
728
729
730
731
condition = SDL_malloc(sizeof(FFCONDITION) * dest->cAxes);
if (condition == NULL) {
SDL_OutOfMemory();
return -1;
}
732
SDL_memset(condition, 0, sizeof(FFCONDITION));
733
734
735
/* Specifics */
for (i=0; i<dest->cAxes; i++) {
736
737
738
739
740
741
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]);
742
743
744
745
746
}
dest->cbTypeSpecificParams = sizeof(FFCONDITION) * dest->cAxes;
dest->lpvTypeSpecificParams = condition;
/* Generics */
747
dest->dwDuration = hap_condition->length * 1000; /* In microseconds. */
748
dest->dwTriggerButton = FFGetTriggerButton(hap_condition->button);
749
750
dest->dwTriggerRepeatInterval = hap_condition->interval;
dest->dwStartDelay = hap_condition->delay * 1000; /* In microseconds. */
751
752
/* Direction. */
753
if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes) < 0) {
754
755
756
return -1;
}
757
/* Envelope */
758
759
SDL_free(dest->lpEnvelope);
dest->lpEnvelope = NULL;
760
/* TODO Check is envelope actually used.
761
762
763
764
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;
765
*/
766
767
768
769
break;
case SDL_HAPTIC_RAMP:
770
hap_ramp = &src->ramp;
771
772
773
774
775
ramp = SDL_malloc(sizeof(FFRAMPFORCE));
if (ramp == NULL) {
SDL_OutOfMemory();
return -1;
}
776
SDL_memset(ramp, 0, sizeof(FFRAMPFORCE));
777
778
/* Specifics */
779
ramp->lStart = CONVERT(hap_ramp->start);
780
ramp->lEnd = CONVERT(hap_ramp->end);
781
782
dest->cbTypeSpecificParams = sizeof(FFRAMPFORCE);
dest->lpvTypeSpecificParams = ramp;
783
784
785
/* Generics */
dest->dwDuration = hap_ramp->length * 1000; /* In microseconds. */
786
dest->dwTriggerButton = FFGetTriggerButton(hap_ramp->button);
787
788
789
790
791
792
793
794
795
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 */
796
if ((hap_ramp->attack_length==0) && (hap_ramp->fade_length==0)) {
797
798
SDL_free(envelope);
dest->lpEnvelope = NULL;
799
}
800
801
802
803
804
805
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;
}
806
807
808
break;
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
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. */
831
dest->dwTriggerButton = FFGetTriggerButton(hap_custom->button);
832
833
834
835
836
837
838
839
840
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 */
841
if ((hap_custom->attack_length==0) && (hap_custom->fade_length==0)) {
842
843
SDL_free(envelope);
dest->lpEnvelope = NULL;
844
845
846
847
848
849
850
}
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;
}
851
852
853
break;
854
855
856
857
858
859
860
861
862
863
default:
SDL_SetError("Haptic: Unknown effect type.");
return -1;
}
return 0;
}
864
865
866
/*
* Frees an FFEFFECT allocated by SDL_SYS_ToFFEFFECT.
*/
867
static void
868
SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect, int type )
869
{
870
871
FFCUSTOMFORCE *custom;
872
873
874
875
876
877
878
879
880
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) {
881
882
883
884
885
if (type == SDL_HAPTIC_CUSTOM) { /* Must free the custom data. */
custom = (FFCUSTOMFORCE*) effect->lpvTypeSpecificParams;
SDL_free(custom->rglForceData);
custom->rglForceData = NULL;
}
886
887
888
889
890
891
892
893
894
895
SDL_free(effect->lpvTypeSpecificParams);
effect->lpvTypeSpecificParams = NULL;
}
if (effect->rglDirection != NULL) {
SDL_free(effect->rglDirection);
effect->rglDirection = NULL;
}
}
896
897
898
/*
* Gets the effect type from the generic SDL haptic effect wrapper.
*/
899
CFUUIDRef
900
SDL_SYS_HapticEffectType( Uint16 type )
901
{
902
switch (type) {
903
904
905
906
907
908
909
910
911
912
913
914
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;
915
case SDL_HAPTIC_TRIANGLE:
916
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
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
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();
961
goto err_hweffect;
962
963
964
}
/* Get the type. */
965
type = SDL_SYS_HapticEffectType(base->type);
966
if (type == NULL) {
967
goto err_hweffect;
968
969
970
}
/* Get the effect. */
971
if (SDL_SYS_ToFFEFFECT(haptic, &effect->hweffect->effect, base) < 0) {
972
goto err_effectdone;
973
974
}
975
/* Create the actual effect. */
976
977
ret = FFDeviceCreateEffect(haptic->hwdata->device, type,
&effect->hweffect->effect, &effect->hweffect->ref);
978
if (ret != FF_OK) {
979
SDL_SetError("Haptic: Unable to create effect: %s.", FFStrError(ret));
980
981
982
983
984
985
goto err_effectdone;
}
return 0;
err_effectdone:
986
SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, base->type);
987
988
989
990
991
992
err_hweffect:
if (effect->hweffect != NULL) {
SDL_free(effect->hweffect);
effect->hweffect = NULL;
}
return -1;
993
994
995
996
997
998
}
/*
* Updates an effect.
*/
999
1000
int
SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,