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