This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_syshaptic.c
1309 lines (1089 loc) · 35.8 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
/*
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_DINPUT
#include "SDL_haptic.h"
#include "../SDL_syshaptic.h"
#include "SDL_joystick.h"
#include "../../joystick/SDL_sysjoystick.h" /* For the real SDL_Joystick */
30
#include "../../joystick/win32/SDL_dxjoystick_c.h" /* For joystick hwdata */
31
32
33
34
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
35
#define DIRECTINPUT_VERSION 0x0700 /* Need at least DirectX 7 for dwStartDelay */
36
#include <dinput.h>
37
#include <dxerr.h>
38
#ifdef _MSC_VER
39
40
41
# pragma comment (lib, "dinput8.lib")
# pragma comment (lib, "dxguid.lib")
# pragma comment (lib, "dxerr.lib")
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
#endif /* _MSC_VER */
/* an ISO hack for VisualC++ */
#ifdef _MSC_VER
#define snprintf _snprintf
#endif /* _MSC_VER */
#define MAX_HAPTICS 32
/*
* List of available haptic devices.
*/
static struct
{
DIDEVICEINSTANCE instance;
SDL_Haptic *haptic;
60
DIDEVCAPS capabilities;
61
62
63
64
65
66
67
68
69
} SDL_hapticlist[MAX_HAPTICS];
/*
* Haptic system hardware data.
*/
struct haptic_hwdata
{
LPDIRECTINPUTDEVICE2 device;
70
71
DWORD axes[3]; /* Axes to use. */
int is_joystick; /* Device is loaded as joystick. */
72
73
74
75
76
77
78
79
80
};
/*
* Haptic system effect data.
*/
struct haptic_hweffect
{
DIEFFECT effect;
81
LPDIRECTINPUTEFFECT ref;
82
83
84
85
86
87
88
89
90
};
/*
* Internal stuff.
*/
static LPDIRECTINPUT dinput = NULL;
91
92
93
/*
* External stuff.
*/
94
extern HWND SDL_HelperWindow;
95
96
97
98
99
/*
* Prototypes.
*/
100
101
102
103
104
105
106
107
108
109
static void DI_SetError(const char *str, HRESULT err);
static int DI_GUIDIsSame(const GUID * a, const GUID * b);
static int SDL_SYS_HapticOpenFromInstance(SDL_Haptic * haptic, DIDEVICEINSTANCE instance);
static int SDL_SYS_HapticOpenFromDevice2(SDL_Haptic * haptic, LPDIRECTINPUTDEVICE2 device2);
static DWORD DIGetTriggerButton( Uint16 button );
static int SDL_SYS_SetDirection( DIEFFECT * effect, SDL_HapticDirection *dir, int naxes );
static int SDL_SYS_ToDIEFFECT( SDL_Haptic * haptic, DIEFFECT * dest, SDL_HapticEffect * src );
static void SDL_SYS_HapticFreeDIEFFECT( DIEFFECT * effect, int type );
static REFGUID SDL_SYS_HapticEffectType(SDL_HapticEffect * effect);
/* Callbacks. */
110
static BOOL CALLBACK EnumHapticsCallback(const DIDEVICEINSTANCE * pdidInstance, VOID * pContext);
111
static BOOL CALLBACK DI_EffectCallback(LPCDIEFFECTINFO pei, LPVOID pv);
112
113
114
115
116
117
118
119
120
/*
* Like SDL_SetError but for DX error codes.
*/
static void
DI_SetError(const char *str, HRESULT err)
{
SDL_SetError( "Haptic: %s - %s: %s", str,
121
122
DXGetErrorString(err),
DXGetErrorDescription(err));
123
124
125
}
126
127
128
129
/*
* Checks to see if two GUID are the same.
*/
static int
130
DI_GUIDIsSame(const GUID * a, const GUID * b)
131
132
133
134
135
136
137
138
139
140
{
if (((a)->Data1 == (b)->Data1) &&
((a)->Data2 == (b)->Data2) &&
((a)->Data3 == (b)->Data3) &&
(SDL_strcmp((a)->Data4, (b)->Data4)==0))
return 1;
return 0;
}
141
142
143
144
145
146
147
/*
* Initializes the haptic subsystem.
*/
int
SDL_SYS_HapticInit(void)
{
HRESULT ret;
148
HINSTANCE instance;
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
if (dinput != NULL) { /* Already open. */
SDL_SetError("Haptic: SubSystem already open.");
return -1;
}
/* Clear all the memory. */
SDL_memset(SDL_hapticlist, 0, sizeof(SDL_hapticlist));
SDL_numhaptics = 0;
ret = CoInitialize(NULL);
if (FAILED(ret)) {
DI_SetError("Coinitialize",ret);
return -1;
}
ret = CoCreateInstance(&CLSID_DirectInput, NULL, CLSCTX_INPROC_SERVER,
&IID_IDirectInput, &dinput);
if (FAILED(ret)) {
DI_SetError("CoCreateInstance",ret);
return -1;
}
/* Because we used CoCreateInstance, we need to Initialize it, first. */
174
175
176
177
178
179
instance = GetModuleHandle(NULL);
if (instance == NULL) {
SDL_SetError("GetModuleHandle() failed with error code %d.", GetLastError());
return -1;
}
ret = IDirectInput_Initialize(dinput, instance, DIRECTINPUT_VERSION);
180
181
182
183
184
185
186
if (FAILED(ret)) {
DI_SetError("Initializing DirectInput device",ret);
return -1;
}
/* Look for haptic devices. */
ret = IDirectInput_EnumDevices( dinput,
187
0, /* Not sure if this is legal, but gets all devices. */
188
EnumHapticsCallback,
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
NULL, DIEDFL_FORCEFEEDBACK | DIEDFL_ATTACHEDONLY);
if (FAILED(ret)) {
DI_SetError("Enumerating DirectInput devices",ret);
return -1;
}
return SDL_numhaptics;
}
/*
* Callback to find the haptic devices.
*/
static BOOL CALLBACK
EnumHapticsCallback(const DIDEVICEINSTANCE * pdidInstance, VOID * pContext)
{
204
205
206
207
HRESULT ret;
LPDIRECTINPUTDEVICE device;
/* Copy the instance over, useful for creating devices. */
208
SDL_memcpy(&SDL_hapticlist[SDL_numhaptics].instance, pdidInstance,
209
sizeof(DIDEVICEINSTANCE));
210
211
/* Open the device */
212
ret = IDirectInput_CreateDevice( dinput, &pdidInstance->guidInstance,
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
&device, NULL );
if (FAILED(ret)) {
/* DI_SetError("Creating DirectInput device",ret); */
return DIENUM_CONTINUE;
}
/* Get capabilities. */
SDL_hapticlist[SDL_numhaptics].capabilities.dwSize = sizeof(DIDEVCAPS);
ret = IDirectInputDevice_GetCapabilities( device,
&SDL_hapticlist[SDL_numhaptics].capabilities );
if (FAILED(ret)) {
/* DI_SetError("Getting device capabilities",ret); */
IDirectInputDevice_Release(device);
return DIENUM_CONTINUE;
}
/* Close up device and count it. */
IDirectInputDevice_Release(device);
231
232
SDL_numhaptics++;
233
/* Watch out for hard limit. */
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
if (SDL_numhaptics >= MAX_HAPTICS)
return DIENUM_STOP;
return DIENUM_CONTINUE;
}
/*
* Return the name of a haptic device, does not need to be opened.
*/
const char *
SDL_SYS_HapticName(int index)
{
return SDL_hapticlist[index].instance.tszProductName;
}
/*
* Callback to get all supported effects.
*/
254
255
#define EFFECT_TEST(e,s) \
if (DI_GUIDIsSame(&pei->guid, &(e))) \
256
257
haptic->supported |= (s)
static BOOL CALLBACK
258
DI_EffectCallback(LPCDIEFFECTINFO pei, LPVOID pv)
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
{
/* Prepare the haptic device. */
SDL_Haptic *haptic = (SDL_Haptic*) pv;
/* Get supported. */
EFFECT_TEST(GUID_Spring, SDL_HAPTIC_SPRING);
EFFECT_TEST(GUID_Damper, SDL_HAPTIC_DAMPER);
EFFECT_TEST(GUID_Inertia, SDL_HAPTIC_INERTIA);
EFFECT_TEST(GUID_Friction, SDL_HAPTIC_FRICTION);
EFFECT_TEST(GUID_ConstantForce, SDL_HAPTIC_CONSTANT);
EFFECT_TEST(GUID_CustomForce, SDL_HAPTIC_CUSTOM);
EFFECT_TEST(GUID_Sine, SDL_HAPTIC_SINE);
EFFECT_TEST(GUID_Square, SDL_HAPTIC_SQUARE);
EFFECT_TEST(GUID_Triangle, SDL_HAPTIC_TRIANGLE);
EFFECT_TEST(GUID_SawtoothUp, SDL_HAPTIC_SAWTOOTHUP);
EFFECT_TEST(GUID_SawtoothDown, SDL_HAPTIC_SAWTOOTHDOWN);
EFFECT_TEST(GUID_RampForce, SDL_HAPTIC_RAMP);
/* Check for more. */
return DIENUM_CONTINUE;
}
282
283
284
285
286
287
/*
* Callback to get supported axes.
*/
static BOOL CALLBACK
DI_DeviceObjectCallback(LPCDIDEVICEOBJECTINSTANCE dev, LPVOID pvRef)
{
288
SDL_Haptic *haptic = (SDL_Haptic *) pvRef;
289
290
if ((dev->dwType & DIDFT_AXIS) && (dev->dwFlags & DIDOI_FFACTUATOR)) {
291
292
haptic->hwdata->axes[haptic->naxes] = dev->dwOfs;
293
294
295
296
297
298
299
300
301
302
303
304
haptic->naxes++;
/* Currently using the artificial limit of 3 axes. */
if (haptic->naxes >= 3) {
return DIENUM_STOP;
}
}
return DIENUM_CONTINUE;
}
305
306
307
308
309
310
311
/*
* Opens the haptic device from the file descriptor.
*
* Steps:
* - Open temporary DirectInputDevice interface.
* - Create DirectInputDevice2 interface.
* - Release DirectInputDevice interface.
312
* - Call SDL_SYS_HapticOpenFromDevice2
313
314
315
316
317
*/
static int
SDL_SYS_HapticOpenFromInstance(SDL_Haptic * haptic, DIDEVICEINSTANCE instance)
{
HRESULT ret;
318
int ret2;
319
320
321
322
323
324
325
326
327
328
329
330
LPDIRECTINPUTDEVICE device;
/* 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 */
331
332
ret = IDirectInput_CreateDevice( dinput, &instance.guidInstance,
&device, NULL );
333
334
335
336
337
338
339
340
if (FAILED(ret)) {
DI_SetError("Creating DirectInput device",ret);
goto creat_err;
}
/* Now get the IDirectInputDevice2 interface, instead. */
ret = IDirectInputDevice_QueryInterface( device,
&IID_IDirectInputDevice2,
341
(LPVOID *) &haptic->hwdata->device );
342
343
344
345
346
347
348
/* Done with the temporary one now. */
IDirectInputDevice_Release(device);
if (FAILED(ret)) {
DI_SetError("Querying DirectInput interface",ret);
goto creat_err;
}
349
350
351
352
353
354
355
356
357
358
359
360
361
362
ret2 = SDL_SYS_HapticOpenFromDevice2( haptic, haptic->hwdata->device );
if (ret2 < 0) {
goto query_err;
}
return 0;
query_err:
IDirectInputDevice2_Release(haptic->hwdata->device);
creat_err:
if (haptic->hwdata != NULL) {
SDL_free(haptic->hwdata);
haptic->hwdata = NULL;
}
363
return -1;
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
}
/*
* Opens the haptic device from the file descriptor.
*
* Steps:
* - Set cooperative level.
* - Set data format.
* - Acquire exclusiveness.
* - Reset actuators.
* - Get supported featuers.
*/
static int
SDL_SYS_HapticOpenFromDevice2(SDL_Haptic * haptic, LPDIRECTINPUTDEVICE2 device2)
{
HRESULT ret;
382
DIPROPDWORD dipdw;
383
384
385
386
/* We'll use the device2 from now on. */
haptic->hwdata->device = device2;
387
388
/* Grab it exclusively to use force feedback stuff. */
ret =IDirectInputDevice2_SetCooperativeLevel( haptic->hwdata->device,
389
SDL_HelperWindow,
390
391
392
393
394
395
DISCL_EXCLUSIVE | DISCL_BACKGROUND );
if (FAILED(ret)) {
DI_SetError("Setting cooperative level to exclusive",ret);
goto acquire_err;
}
396
397
398
399
400
/* Set data format. */
ret = IDirectInputDevice2_SetDataFormat( haptic->hwdata->device,
&c_dfDIJoystick2 );
if (FAILED(ret)) {
DI_SetError("Setting data format",ret);
401
goto acquire_err;
402
403
}
404
405
406
407
408
409
/* Get number of axes. */
ret = IDirectInputDevice2_EnumObjects( haptic->hwdata->device,
DI_DeviceObjectCallback,
haptic, DIDFT_AXIS );
if (FAILED(ret)) {
DI_SetError("Getting device axes",ret);
410
goto acquire_err;
411
412
}
413
414
415
416
/* Acquire the device. */
ret = IDirectInputDevice2_Acquire(haptic->hwdata->device);
if (FAILED(ret)) {
DI_SetError("Acquiring DirectInput device",ret);
417
goto acquire_err;
418
419
}
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/* Reset all actuators - just in case. */
ret = IDirectInputDevice2_SendForceFeedbackCommand( haptic->hwdata->device,
DISFFC_RESET );
if (FAILED(ret)) {
DI_SetError("Resetting device",ret);
goto acquire_err;
}
/* Enabling actuators. */
ret = IDirectInputDevice2_SendForceFeedbackCommand( haptic->hwdata->device,
DISFFC_SETACTUATORSON );
if (FAILED(ret)) {
DI_SetError("Enabling actuators",ret);
goto acquire_err;
}
/* Get supported effects. */
437
438
ret = IDirectInputDevice2_EnumEffects( haptic->hwdata->device,
DI_EffectCallback, haptic, DIEFT_ALL );
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
if (FAILED(ret)) {
DI_SetError("Enumerating supported effects",ret);
goto acquire_err;
}
if (haptic->supported == 0) { /* Error since device supports nothing. */
SDL_SetError("Haptic: Internal error on finding supported effects.");
goto acquire_err;
}
/* Check autogain and autocenter. */
dipdw.diph.dwSize = sizeof(DIPROPDWORD);
dipdw.diph.dwHeaderSize = sizeof(DIPROPHEADER);
dipdw.diph.dwObj = 0;
dipdw.diph.dwHow = DIPH_DEVICE;
dipdw.dwData = 10000;
ret = IDirectInputDevice2_SetProperty( haptic->hwdata->device,
DIPROP_FFGAIN, &dipdw.diph );
456
if (!FAILED(ret)) { /* Gain is supported. */
457
458
haptic->supported |= SDL_HAPTIC_GAIN;
}
459
460
dipdw.diph.dwObj = 0;
dipdw.diph.dwHow = DIPH_DEVICE;
461
462
463
dipdw.dwData = DIPROPAUTOCENTER_OFF;
ret = IDirectInputDevice2_SetProperty( haptic->hwdata->device,
DIPROP_AUTOCENTER, &dipdw.diph );
464
if (!FAILED(ret)) { /* Autocenter is supported. */
465
466
467
haptic->supported |= SDL_HAPTIC_AUTOCENTER;
}
468
469
470
/* Status is always supported. */
haptic->supported |= SDL_HAPTIC_STATUS;
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
/* Check maximum effects. */
haptic->neffects = 128; /* TODO actually figure this out. */
haptic->nplaying = 128;
/* Prepare effects memory. */
haptic->effects = (struct haptic_effect *)
SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
if (haptic->effects == NULL) {
SDL_OutOfMemory();
goto acquire_err;
}
/* Clear the memory */
SDL_memset(haptic->effects, 0,
sizeof(struct haptic_effect) * haptic->neffects);
return 0;
/* Error handling */
acquire_err:
IDirectInputDevice2_Unacquire(haptic->hwdata->device);
return -1;
}
/*
* Opens a haptic device for usage.
*/
int
SDL_SYS_HapticOpen(SDL_Haptic * haptic)
{
return SDL_SYS_HapticOpenFromInstance( haptic,
SDL_hapticlist[haptic->index].instance );
}
/*
* Opens a haptic device from first mouse it finds for usage.
*/
int
SDL_SYS_HapticMouse(void)
{
513
514
int i;
515
/* Grab the first mouse haptic device we find. */
516
for (i=0; i<SDL_numhaptics; i++) {
517
518
519
if (SDL_hapticlist[i].capabilities.dwDevType == DIDEVTYPE_MOUSE ) {
return i;
}
520
}
521
522
523
524
525
526
527
528
529
530
531
return -1;
}
/*
* Checks to see if a joystick has haptic features.
*/
int
SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick)
{
532
533
534
535
if (joystick->hwdata->Capabilities.dwFlags & DIDC_FORCEFEEDBACK) {
return SDL_TRUE;
}
536
537
538
539
540
541
542
543
544
545
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)
{
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
HRESULT ret;
DIDEVICEINSTANCE hap_instance, joy_instance;
/* Get the device instances. */
ret = IDirectInputDevice2_GetDeviceInfo( haptic->hwdata->device,
&hap_instance );
if (FAILED(ret)) {
return 0;
}
ret = IDirectInputDevice2_GetDeviceInfo( joystick->hwdata->InputDevice,
&joy_instance );
if (FAILED(ret)) {
return 0;
}
if (DI_GUIDIsSame(&hap_instance.guidInstance, &joy_instance.guidInstance))
return 1;
564
565
566
567
568
569
570
571
572
573
return 0;
}
/*
* Opens a SDL_Haptic from a SDL_Joystick.
*/
int
SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, SDL_Joystick * joystick)
{
574
575
int ret;
576
577
578
579
580
581
582
583
584
585
/* Allocate the hwdata */
haptic->hwdata = (struct haptic_hwdata *)
SDL_malloc(sizeof(*haptic->hwdata));
if (haptic->hwdata == NULL) {
SDL_OutOfMemory();
return -1;
}
SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
/* Now open the device. */
586
587
588
589
590
591
592
593
594
ret = SDL_SYS_HapticOpenFromDevice2( haptic, joystick->hwdata->InputDevice );
if (ret < 0) {
return -1;
}
/* It's using the joystick device. */
haptic->hwdata->is_joystick = 1;
return 0;
595
596
597
598
599
600
601
602
603
604
605
}
/*
* Closes the haptic device.
*/
void
SDL_SYS_HapticClose(SDL_Haptic * haptic)
{
if (haptic->hwdata) {
606
/* Free effects. */
607
SDL_free(haptic->effects);
608
haptic->effects = NULL;
609
610
611
612
haptic->neffects = 0;
/* Clean up */
IDirectInputDevice2_Unacquire(haptic->hwdata->device);
613
614
615
616
/* Only release if isn't grabbed by a joystick. */
if (haptic->hwdata->is_joystick == 0) {
IDirectInputDevice2_Release(haptic->hwdata->device);
}
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
/* Free */
SDL_free(haptic->hwdata);
haptic->hwdata = NULL;
}
}
/*
* Clean up after system specific haptic stuff
*/
void
SDL_SYS_HapticQuit(void)
{
IDirectInput_Release(dinput);
dinput = NULL;
}
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
/*
* Converts an SDL trigger button to an DIEFFECT trigger button.
*/
static DWORD
DIGetTriggerButton( Uint16 button )
{
DWORD dwTriggerButton;
dwTriggerButton = DIEB_NOTRIGGER;
if (button != 0) {
dwTriggerButton = DIJOFS_BUTTON(button - 1);
}
return dwTriggerButton;
}
654
655
656
657
/*
* Sets the direction.
*/
static int
658
SDL_SYS_SetDirection( DIEFFECT * effect, SDL_HapticDirection *dir, int naxes )
659
660
661
662
663
{
LONG *rglDir;
/* Handle no axes a part. */
if (naxes == 0) {
664
effect->dwFlags |= DIEFF_SPHERICAL; /* Set as default. */
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
effect->rglDirection = NULL;
return 0;
}
/* Has axes. */
rglDir = SDL_malloc( sizeof(LONG) * naxes );
if (rglDir == NULL) {
SDL_OutOfMemory();
return -1;
}
SDL_memset( rglDir, 0, sizeof(LONG) * naxes );
effect->rglDirection = rglDir;
switch (dir->type) {
case SDL_HAPTIC_POLAR:
680
effect->dwFlags |= DIEFF_POLAR;
681
682
683
rglDir[0] = dir->dir[0];
return 0;
case SDL_HAPTIC_CARTESIAN:
684
effect->dwFlags |= DIEFF_CARTESIAN;
685
rglDir[0] = dir->dir[0];
686
687
688
689
if (naxes > 1)
rglDir[1] = dir->dir[1];
if (naxes > 2)
rglDir[2] = dir->dir[2];
690
691
return 0;
case SDL_HAPTIC_SPHERICAL:
692
effect->dwFlags |= DIEFF_SPHERICAL;
693
rglDir[0] = dir->dir[0];
694
695
696
697
if (naxes > 1)
rglDir[1] = dir->dir[1];
if (naxes > 2)
rglDir[2] = dir->dir[2];
698
699
700
701
702
703
704
705
return 0;
default:
SDL_SetError("Haptic: Unknown direction type.");
return -1;
}
}
706
#define CONVERT(x) (((x) > 0x7FFF) ? 10000 : ((x)*10000) / 0x7FFF)
707
/*
708
* Creates the DIEFFECT from a SDL_HapticEffect.
709
710
*/
static int
711
SDL_SYS_ToDIEFFECT( SDL_Haptic * haptic, DIEFFECT * dest, SDL_HapticEffect * src )
712
713
{
int i;
714
715
716
717
718
719
DICONSTANTFORCE *constant;
DIPERIODIC *periodic;
DICONDITION *condition; /* Actually an array of conditions - one per axis. */
DIRAMPFORCE *ramp;
DICUSTOMFORCE *custom;
DIENVELOPE *envelope;
720
721
722
723
724
725
726
727
SDL_HapticConstant *hap_constant;
SDL_HapticPeriodic *hap_periodic;
SDL_HapticCondition *hap_condition;
SDL_HapticRamp *hap_ramp;
SDL_HapticCustom *hap_custom;
DWORD *axes;
/* Set global stuff. */
728
729
SDL_memset(dest, 0, sizeof(DIEFFECT));
dest->dwSize = sizeof(DIEFFECT); /* Set the structure size. */
730
731
dest->dwSamplePeriod = 0; /* Not used by us. */
dest->dwGain = 10000; /* Gain is set globally, not locally. */
732
dest->dwFlags = DIEFF_OBJECTOFFSETS; /* Seems obligatory. */
733
734
/* Envelope. */
735
envelope = SDL_malloc( sizeof(DIENVELOPE) );
736
737
738
739
if (envelope == NULL) {
SDL_OutOfMemory();
return -1;
}
740
SDL_memset(envelope, 0, sizeof(DIENVELOPE));
741
dest->lpEnvelope = envelope;
742
envelope->dwSize = sizeof(DIENVELOPE); /* Always should be this. */
743
744
745
746
747
748
749
750
751
/* Axes. */
dest->cAxes = haptic->naxes;
if (dest->cAxes > 0) {
axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
if (axes == NULL) {
SDL_OutOfMemory();
return -1;
}
752
axes[0] = haptic->hwdata->axes[0]; /* Always at least one axis. */
753
if (dest->cAxes > 1) {
754
axes[1] = haptic->hwdata->axes[1];
755
756
}
if (dest->cAxes > 2) {
757
axes[2] = haptic->hwdata->axes[2];
758
759
760
761
762
763
764
765
766
}
dest->rgdwAxes = axes;
}
/* The big type handling switch, even bigger then linux's version. */
switch (src->type) {
case SDL_HAPTIC_CONSTANT:
hap_constant = &src->constant;
767
constant = SDL_malloc( sizeof(DICONSTANTFORCE) );
768
769
770
771
if (constant == NULL) {
SDL_OutOfMemory();
return -1;
}
772
SDL_memset(constant, 0, sizeof(DICONSTANTFORCE));
773
774
775
/* Specifics */
constant->lMagnitude = CONVERT(hap_constant->level);
776
dest->cbTypeSpecificParams = sizeof(DICONSTANTFORCE);
777
778
779
780
dest->lpvTypeSpecificParams = constant;
/* Generics */
dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
781
dest->dwTriggerButton = DIGetTriggerButton(hap_constant->button);
782
783
784
785
786
787
788
789
790
dest->dwTriggerRepeatInterval = hap_constant->interval;
dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
/* Direction. */
if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
return -1;
}
/* Envelope */
791
792
793
794
795
796
797
798
799
800
if ((hap_constant->attack_length==0) && (hap_constant->fade_length==0)) {
SDL_free(dest->lpEnvelope);
dest->lpEnvelope = NULL;
}
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;
}
801
802
803
804
805
806
807
808
809
break;
case SDL_HAPTIC_SINE:
case SDL_HAPTIC_SQUARE:
case SDL_HAPTIC_TRIANGLE:
case SDL_HAPTIC_SAWTOOTHUP:
case SDL_HAPTIC_SAWTOOTHDOWN:
hap_periodic = &src->periodic;
810
periodic = SDL_malloc(sizeof(DIPERIODIC));
811
812
813
814
if (periodic == NULL) {
SDL_OutOfMemory();
return -1;
}
815
SDL_memset(periodic, 0, sizeof(DIPERIODIC));
816
817
818
819
820
821
/* Specifics */
periodic->dwMagnitude = CONVERT(hap_periodic->magnitude);
periodic->lOffset = CONVERT(hap_periodic->offset);
periodic->dwPhase = hap_periodic->phase;
periodic->dwPeriod = hap_periodic->period * 1000;
822
dest->cbTypeSpecificParams = sizeof(DIPERIODIC);
823
824
825
826
dest->lpvTypeSpecificParams = periodic;
/* Generics */
dest->dwDuration = hap_periodic->length * 1000; /* In microseconds. */
827
dest->dwTriggerButton = DIGetTriggerButton(hap_periodic->button);
828
829
830
831
832
833
834
835
836
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 */
837
838
839
840
841
842
843
844
845
846
if ((hap_periodic->attack_length==0) && (hap_periodic->fade_length==0)) {
SDL_free(dest->lpEnvelope);
dest->lpEnvelope = NULL;
}
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;
}
847
848
849
850
851
852
853
854
break;
case SDL_HAPTIC_SPRING:
case SDL_HAPTIC_DAMPER:
case SDL_HAPTIC_INERTIA:
case SDL_HAPTIC_FRICTION:
hap_condition = &src->condition;
855
condition = SDL_malloc(sizeof(DICONDITION) * dest->cAxes);
856
857
858
859
if (condition == NULL) {
SDL_OutOfMemory();
return -1;
}
860
SDL_memset(condition, 0, sizeof(DICONDITION));
861
862
/* Specifics */
863
for (i=0; i<(int)dest->cAxes; i++) {
864
865
866
867
868
869
870
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]);
}
871
dest->cbTypeSpecificParams = sizeof(DICONDITION) * dest->cAxes;
872
873
874
875
dest->lpvTypeSpecificParams = condition;
/* Generics */
dest->dwDuration = hap_condition->length * 1000; /* In microseconds. */
876
dest->dwTriggerButton = DIGetTriggerButton(hap_condition->button);
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
dest->dwTriggerRepeatInterval = hap_condition->interval;
dest->dwStartDelay = hap_condition->delay * 1000; /* In microseconds. */
/* Direction. */
if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes) < 0) {
return -1;
}
/* Envelope */
/* TODO Check is envelope actually used.
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;
*/
break;
case SDL_HAPTIC_RAMP:
hap_ramp = &src->ramp;
897
ramp = SDL_malloc(sizeof(DIRAMPFORCE));
898
899
900
901
if (ramp == NULL) {
SDL_OutOfMemory();
return -1;
}
902
SDL_memset(ramp, 0, sizeof(DIRAMPFORCE));
903
904
905
906
/* Specifics */
ramp->lStart = CONVERT(hap_ramp->start);
ramp->lEnd = CONVERT(hap_ramp->end);
907
dest->cbTypeSpecificParams = sizeof(DIRAMPFORCE);
908
909
910
911
dest->lpvTypeSpecificParams = ramp;
/* Generics */
dest->dwDuration = hap_ramp->length * 1000; /* In microseconds. */
912
dest->dwTriggerButton = DIGetTriggerButton(hap_ramp->button);
913
914
915
916
917
918
919
920
921
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 */
922
923
924
925
926
927
928
929
930
931
if ((hap_ramp->attack_length==0) && (hap_ramp->fade_length==0)) {
SDL_free(dest->lpEnvelope);
dest->lpEnvelope = NULL;
}
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;
}
932
933
934
935
936
break;
case SDL_HAPTIC_CUSTOM:
hap_custom = &src->custom;
937
custom = SDL_malloc(sizeof(DICUSTOMFORCE));
938
939
940
941
if (custom == NULL) {
SDL_OutOfMemory();
return -1;
}
942
SDL_memset(custom, 0, sizeof(DICUSTOMFORCE));
943
944
945
946
947
948
949
950
951
/* 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]);
}
952
dest->cbTypeSpecificParams = sizeof(DICUSTOMFORCE);
953
954
955
956
dest->lpvTypeSpecificParams = custom;
/* Generics */
dest->dwDuration = hap_custom->length * 1000; /* In microseconds. */
957
dest->dwTriggerButton = DIGetTriggerButton(hap_custom->button);
958
959
960
961
962
963
964
965
966
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 */
967
968
969
970
971
972
973
974
975
976
if ((hap_custom->attack_length==0) && (hap_custom->fade_length==0)) {
SDL_free(dest->lpEnvelope);
dest->lpEnvelope = NULL;
}
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;
}
977
978
979
980
981
982
983
984
985
986
987
988
989
990
break;
default:
SDL_SetError("Haptic: Unknown effect type.");
return -1;
}
return 0;
}
/*
991
* Frees an DIEFFECT allocated by SDL_SYS_ToDIEFFECT.
992
993
*/
static void
994
SDL_SYS_HapticFreeDIEFFECT( DIEFFECT * effect, int type )
995
{
996
DICUSTOMFORCE *custom;
997
998
999
1000
if (effect->lpEnvelope != NULL) {
SDL_free(effect->lpEnvelope);
effect->lpEnvelope = NULL;