src/haptic/windows/SDL_syshaptic.c
author Sam Lantinga <slouken@libsdl.org>
Sat, 18 May 2013 14:17:52 -0700
changeset 7191 75360622e65f
parent 7132 1415923c2eab
child 7319 8bdc5aac93d7
permissions -rw-r--r--
File style cleanup for the SDL 2.0 release
slouken@2713
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@2713
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@2713
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@2713
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@2713
    20
*/
slouken@2713
    21
#include "SDL_config.h"
slouken@2713
    22
slouken@2713
    23
#ifdef SDL_HAPTIC_DINPUT
slouken@2713
    24
icculus@6990
    25
#include "SDL_assert.h"
icculus@6990
    26
#include "SDL_hints.h"
slouken@2713
    27
#include "SDL_haptic.h"
slouken@2713
    28
#include "../SDL_syshaptic.h"
slouken@2713
    29
#include "SDL_joystick.h"
slouken@2713
    30
#include "../../joystick/SDL_sysjoystick.h"     /* For the real SDL_Joystick */
slouken@5062
    31
#include "../../joystick/windows/SDL_dxjoystick_c.h"      /* For joystick hwdata */
slouken@2713
    32
slouken@2713
    33
#define MAX_HAPTICS  32
slouken@2713
    34
slouken@2713
    35
/*
slouken@2713
    36
 * List of available haptic devices.
slouken@2713
    37
 */
slouken@2713
    38
static struct
slouken@2713
    39
{
slouken@2713
    40
    DIDEVICEINSTANCE instance;
slouken@5090
    41
    char *name;
slouken@2713
    42
    SDL_Haptic *haptic;
slouken@2713
    43
    DIDEVCAPS capabilities;
slouken@7191
    44
    Uint8 bXInputHaptic; /* Supports force feedback via XInput. */
slouken@7191
    45
    Uint8 userid; /* XInput userid index for this joystick */
slouken@2713
    46
} SDL_hapticlist[MAX_HAPTICS];
slouken@2713
    47
slouken@2713
    48
slouken@2713
    49
/*
slouken@2713
    50
 * Haptic system hardware data.
slouken@2713
    51
 */
slouken@2713
    52
struct haptic_hwdata
slouken@2713
    53
{
icculus@6716
    54
    LPDIRECTINPUTDEVICE8 device;
slouken@2713
    55
    DWORD axes[3];              /* Axes to use. */
slouken@2713
    56
    int is_joystick;            /* Device is loaded as joystick. */
slouken@7191
    57
    Uint8 bXInputHaptic; /* Supports force feedback via XInput. */
slouken@7191
    58
    Uint8 userid; /* XInput userid index for this joystick */
slouken@2713
    59
};
slouken@2713
    60
slouken@2713
    61
slouken@2713
    62
/*
slouken@2713
    63
 * Haptic system effect data.
slouken@2713
    64
 */
slouken@2713
    65
struct haptic_hweffect
slouken@2713
    66
{
slouken@2713
    67
    DIEFFECT effect;
slouken@2713
    68
    LPDIRECTINPUTEFFECT ref;
icculus@6990
    69
    XINPUT_VIBRATION vibration;
slouken@2713
    70
};
slouken@2713
    71
slouken@2713
    72
slouken@2713
    73
/*
slouken@2713
    74
 * Internal stuff.
slouken@2713
    75
 */
icculus@5591
    76
static SDL_bool coinitialized = SDL_FALSE;
icculus@6716
    77
static LPDIRECTINPUT8 dinput = NULL;
icculus@6990
    78
static SDL_bool loaded_xinput = SDL_FALSE;
slouken@2713
    79
slouken@2713
    80
slouken@2713
    81
/*
slouken@2713
    82
 * External stuff.
slouken@2713
    83
 */
slouken@2713
    84
extern HWND SDL_HelperWindow;
slouken@2713
    85
slouken@2713
    86
slouken@2713
    87
/*
slouken@2713
    88
 * Prototypes.
slouken@2713
    89
 */
icculus@7037
    90
static int DI_SetError(const char *str, HRESULT err);
slouken@2713
    91
static int DI_GUIDIsSame(const GUID * a, const GUID * b);
slouken@2713
    92
static int SDL_SYS_HapticOpenFromInstance(SDL_Haptic * haptic,
slouken@2713
    93
                                          DIDEVICEINSTANCE instance);
icculus@6716
    94
static int SDL_SYS_HapticOpenFromDevice8(SDL_Haptic * haptic,
icculus@6716
    95
                                         LPDIRECTINPUTDEVICE8 device8);
icculus@6990
    96
static int SDL_SYS_HapticOpenFromXInput(SDL_Haptic * haptic, Uint8 userid);
slouken@2713
    97
static DWORD DIGetTriggerButton(Uint16 button);
slouken@2713
    98
static int SDL_SYS_SetDirection(DIEFFECT * effect, SDL_HapticDirection * dir,
slouken@2713
    99
                                int naxes);
slouken@2713
   100
static int SDL_SYS_ToDIEFFECT(SDL_Haptic * haptic, DIEFFECT * dest,
slouken@2713
   101
                              SDL_HapticEffect * src);
slouken@2713
   102
static void SDL_SYS_HapticFreeDIEFFECT(DIEFFECT * effect, int type);
slouken@2713
   103
static REFGUID SDL_SYS_HapticEffectType(SDL_HapticEffect * effect);
slouken@2713
   104
/* Callbacks. */
slouken@2713
   105
static BOOL CALLBACK EnumHapticsCallback(const DIDEVICEINSTANCE *
slouken@2713
   106
                                         pdidInstance, VOID * pContext);
slouken@2713
   107
static BOOL CALLBACK DI_EffectCallback(LPCDIEFFECTINFO pei, LPVOID pv);
slouken@2713
   108
slouken@2713
   109
slouken@7191
   110
/*
slouken@2713
   111
 * Like SDL_SetError but for DX error codes.
slouken@2713
   112
 */
icculus@7037
   113
static int
slouken@2713
   114
DI_SetError(const char *str, HRESULT err)
slouken@2713
   115
{
slouken@2786
   116
    /*
slouken@2786
   117
       SDL_SetError("Haptic: %s - %s: %s", str,
slouken@2786
   118
       DXGetErrorString8A(err), DXGetErrorDescription8A(err));
slouken@2786
   119
     */
icculus@7037
   120
    return SDL_SetError("Haptic error %s", str);
slouken@2713
   121
}
slouken@2713
   122
slouken@2713
   123
slouken@2713
   124
/*
slouken@2713
   125
 * Checks to see if two GUID are the same.
slouken@2713
   126
 */
slouken@2713
   127
static int
slouken@2713
   128
DI_GUIDIsSame(const GUID * a, const GUID * b)
slouken@2713
   129
{
icculus@6403
   130
    return (SDL_memcmp(a, b, sizeof (GUID)) == 0);
slouken@2713
   131
}
slouken@2713
   132
slouken@2713
   133
slouken@2713
   134
/*
slouken@2713
   135
 * Initializes the haptic subsystem.
slouken@2713
   136
 */
slouken@2713
   137
int
slouken@2713
   138
SDL_SYS_HapticInit(void)
slouken@2713
   139
{
icculus@6990
   140
    const char *env = SDL_GetHint(SDL_HINT_XINPUT_ENABLED);
slouken@2713
   141
    HRESULT ret;
slouken@2713
   142
    HINSTANCE instance;
slouken@2713
   143
slouken@2713
   144
    if (dinput != NULL) {       /* Already open. */
icculus@7037
   145
        return SDL_SetError("Haptic: SubSystem already open.");
slouken@2713
   146
    }
slouken@2713
   147
slouken@2713
   148
    /* Clear all the memory. */
slouken@2713
   149
    SDL_memset(SDL_hapticlist, 0, sizeof(SDL_hapticlist));
slouken@2713
   150
slouken@2713
   151
    SDL_numhaptics = 0;
slouken@2713
   152
icculus@5591
   153
    ret = WIN_CoInitialize();
slouken@2713
   154
    if (FAILED(ret)) {
icculus@7037
   155
        return DI_SetError("Coinitialize", ret);
slouken@2713
   156
    }
slouken@2713
   157
icculus@5591
   158
    coinitialized = SDL_TRUE;
icculus@5591
   159
icculus@6716
   160
    ret = CoCreateInstance(&CLSID_DirectInput8, NULL, CLSCTX_INPROC_SERVER,
icculus@6716
   161
                           &IID_IDirectInput8, (LPVOID) & dinput);
slouken@2713
   162
    if (FAILED(ret)) {
icculus@5591
   163
        SDL_SYS_HapticQuit();
icculus@7037
   164
        return DI_SetError("CoCreateInstance", ret);
slouken@2713
   165
    }
slouken@2713
   166
slouken@2713
   167
    /* Because we used CoCreateInstance, we need to Initialize it, first. */
slouken@2713
   168
    instance = GetModuleHandle(NULL);
slouken@2713
   169
    if (instance == NULL) {
icculus@5591
   170
        SDL_SYS_HapticQuit();
icculus@7037
   171
        return SDL_SetError("GetModuleHandle() failed with error code %d.",
icculus@7037
   172
                            GetLastError());
slouken@2713
   173
    }
icculus@6716
   174
    ret = IDirectInput8_Initialize(dinput, instance, DIRECTINPUT_VERSION);
slouken@2713
   175
    if (FAILED(ret)) {
icculus@5591
   176
        SDL_SYS_HapticQuit();
icculus@7037
   177
        return DI_SetError("Initializing DirectInput device", ret);
slouken@2713
   178
    }
slouken@2713
   179
slouken@2713
   180
    /* Look for haptic devices. */
icculus@6716
   181
    ret = IDirectInput8_EnumDevices(dinput,
slouken@2714
   182
                                   0,
slouken@2713
   183
                                   EnumHapticsCallback,
slouken@2713
   184
                                   NULL,
slouken@2713
   185
                                   DIEDFL_FORCEFEEDBACK |
slouken@2713
   186
                                   DIEDFL_ATTACHEDONLY);
slouken@2713
   187
    if (FAILED(ret)) {
icculus@5591
   188
        SDL_SYS_HapticQuit();
icculus@7037
   189
        return DI_SetError("Enumerating DirectInput devices", ret);
slouken@2713
   190
    }
slouken@2713
   191
icculus@6990
   192
    if (!env || SDL_atoi(env)) {
icculus@6990
   193
        loaded_xinput = (WIN_LoadXInputDLL() == 0);
icculus@6990
   194
    }
icculus@6990
   195
icculus@6990
   196
    if (loaded_xinput) {
icculus@6990
   197
        DWORD i;
icculus@6990
   198
        const SDL_bool bIs14OrLater = (SDL_XInputVersion >= ((1<<16)|4));
icculus@6990
   199
icculus@6990
   200
        for (i = 0; (i < SDL_XINPUT_MAX_DEVICES) && (SDL_numhaptics < MAX_HAPTICS); i++) {
icculus@6990
   201
            XINPUT_CAPABILITIES caps;
icculus@6990
   202
            if (XINPUTGETCAPABILITIES(i, XINPUT_FLAG_GAMEPAD, &caps) == ERROR_SUCCESS) {
icculus@6990
   203
                if ((!bIs14OrLater) || (caps.Flags & XINPUT_CAPS_FFB_SUPPORTED)) {
icculus@6990
   204
                    /* !!! FIXME: I'm not bothering to query for a real name right now. */
icculus@6990
   205
                    char buf[64];
icculus@6990
   206
                    SDL_snprintf(buf, sizeof (buf), "XInput Controller #%u", i+1);
icculus@6990
   207
                    SDL_hapticlist[SDL_numhaptics].name = SDL_strdup(buf);
icculus@6990
   208
                    SDL_hapticlist[SDL_numhaptics].bXInputHaptic = 1;
icculus@6990
   209
                    SDL_hapticlist[SDL_numhaptics].userid = (Uint8) i;
icculus@6990
   210
                    SDL_numhaptics++;
icculus@6990
   211
                }
icculus@6990
   212
            }
icculus@6990
   213
        }
icculus@6990
   214
    }
icculus@6990
   215
slouken@2713
   216
    return SDL_numhaptics;
slouken@2713
   217
}
slouken@2713
   218
slouken@2713
   219
/*
slouken@2713
   220
 * Callback to find the haptic devices.
slouken@2713
   221
 */
slouken@2713
   222
static BOOL CALLBACK
slouken@2713
   223
EnumHapticsCallback(const DIDEVICEINSTANCE * pdidInstance, VOID * pContext)
slouken@2713
   224
{
slouken@2713
   225
    HRESULT ret;
icculus@6716
   226
    LPDIRECTINPUTDEVICE8 device;
slouken@2713
   227
slouken@2713
   228
    /* Copy the instance over, useful for creating devices. */
slouken@2713
   229
    SDL_memcpy(&SDL_hapticlist[SDL_numhaptics].instance, pdidInstance,
slouken@2713
   230
               sizeof(DIDEVICEINSTANCE));
slouken@2713
   231
slouken@2713
   232
    /* Open the device */
icculus@6716
   233
    ret = IDirectInput8_CreateDevice(dinput, &pdidInstance->guidInstance,
slouken@2713
   234
                                    &device, NULL);
slouken@2713
   235
    if (FAILED(ret)) {
slouken@2713
   236
        /* DI_SetError("Creating DirectInput device",ret); */
slouken@2713
   237
        return DIENUM_CONTINUE;
slouken@2713
   238
    }
slouken@2713
   239
slouken@2713
   240
    /* Get capabilities. */
slouken@2713
   241
    SDL_hapticlist[SDL_numhaptics].capabilities.dwSize = sizeof(DIDEVCAPS);
icculus@6716
   242
    ret = IDirectInputDevice8_GetCapabilities(device,
slouken@3013
   243
                                             &SDL_hapticlist[SDL_numhaptics].
slouken@3013
   244
                                             capabilities);
slouken@2713
   245
    if (FAILED(ret)) {
slouken@2713
   246
        /* DI_SetError("Getting device capabilities",ret); */
icculus@6716
   247
        IDirectInputDevice8_Release(device);
slouken@2713
   248
        return DIENUM_CONTINUE;
slouken@2713
   249
    }
slouken@2713
   250
slouken@5090
   251
    /* Copy the name */
slouken@5090
   252
    SDL_hapticlist[SDL_numhaptics].name = WIN_StringToUTF8(SDL_hapticlist[SDL_numhaptics].instance.tszProductName);
slouken@5090
   253
slouken@2713
   254
    /* Close up device and count it. */
icculus@6716
   255
    IDirectInputDevice8_Release(device);
slouken@2713
   256
    SDL_numhaptics++;
slouken@2713
   257
slouken@2713
   258
    /* Watch out for hard limit. */
slouken@2713
   259
    if (SDL_numhaptics >= MAX_HAPTICS)
slouken@2713
   260
        return DIENUM_STOP;
slouken@2713
   261
slouken@2713
   262
    return DIENUM_CONTINUE;
slouken@2713
   263
}
slouken@2713
   264
slouken@2713
   265
slouken@2713
   266
/*
slouken@2713
   267
 * Return the name of a haptic device, does not need to be opened.
slouken@2713
   268
 */
slouken@2713
   269
const char *
slouken@2713
   270
SDL_SYS_HapticName(int index)
slouken@2713
   271
{
slouken@5090
   272
    return SDL_hapticlist[index].name;
slouken@2713
   273
}
slouken@2713
   274
slouken@2713
   275
slouken@2713
   276
/*
slouken@2713
   277
 * Callback to get all supported effects.
slouken@2713
   278
 */
slouken@2713
   279
#define EFFECT_TEST(e,s)               \
slouken@2713
   280
if (DI_GUIDIsSame(&pei->guid, &(e)))   \
slouken@2713
   281
   haptic->supported |= (s)
slouken@2713
   282
static BOOL CALLBACK
slouken@2713
   283
DI_EffectCallback(LPCDIEFFECTINFO pei, LPVOID pv)
slouken@2713
   284
{
slouken@2713
   285
    /* Prepare the haptic device. */
slouken@2713
   286
    SDL_Haptic *haptic = (SDL_Haptic *) pv;
slouken@2713
   287
slouken@2713
   288
    /* Get supported. */
slouken@2713
   289
    EFFECT_TEST(GUID_Spring, SDL_HAPTIC_SPRING);
slouken@2713
   290
    EFFECT_TEST(GUID_Damper, SDL_HAPTIC_DAMPER);
slouken@2713
   291
    EFFECT_TEST(GUID_Inertia, SDL_HAPTIC_INERTIA);
slouken@2713
   292
    EFFECT_TEST(GUID_Friction, SDL_HAPTIC_FRICTION);
slouken@2713
   293
    EFFECT_TEST(GUID_ConstantForce, SDL_HAPTIC_CONSTANT);
slouken@2713
   294
    EFFECT_TEST(GUID_CustomForce, SDL_HAPTIC_CUSTOM);
slouken@2713
   295
    EFFECT_TEST(GUID_Sine, SDL_HAPTIC_SINE);
slouken@2713
   296
    EFFECT_TEST(GUID_Square, SDL_HAPTIC_SQUARE);
slouken@2713
   297
    EFFECT_TEST(GUID_Triangle, SDL_HAPTIC_TRIANGLE);
slouken@2713
   298
    EFFECT_TEST(GUID_SawtoothUp, SDL_HAPTIC_SAWTOOTHUP);
slouken@2713
   299
    EFFECT_TEST(GUID_SawtoothDown, SDL_HAPTIC_SAWTOOTHDOWN);
slouken@2713
   300
    EFFECT_TEST(GUID_RampForce, SDL_HAPTIC_RAMP);
slouken@2713
   301
slouken@2713
   302
    /* Check for more. */
slouken@2713
   303
    return DIENUM_CONTINUE;
slouken@2713
   304
}
slouken@2713
   305
slouken@2713
   306
slouken@2713
   307
/*
slouken@2713
   308
 * Callback to get supported axes.
slouken@2713
   309
 */
slouken@2713
   310
static BOOL CALLBACK
slouken@2713
   311
DI_DeviceObjectCallback(LPCDIDEVICEOBJECTINSTANCE dev, LPVOID pvRef)
slouken@2713
   312
{
slouken@2713
   313
    SDL_Haptic *haptic = (SDL_Haptic *) pvRef;
slouken@2713
   314
slouken@2713
   315
    if ((dev->dwType & DIDFT_AXIS) && (dev->dwFlags & DIDOI_FFACTUATOR)) {
slouken@2713
   316
slouken@2713
   317
        haptic->hwdata->axes[haptic->naxes] = dev->dwOfs;
slouken@2713
   318
        haptic->naxes++;
slouken@2713
   319
slouken@2713
   320
        /* Currently using the artificial limit of 3 axes. */
slouken@2713
   321
        if (haptic->naxes >= 3) {
slouken@2713
   322
            return DIENUM_STOP;
slouken@2713
   323
        }
slouken@2713
   324
    }
slouken@2713
   325
slouken@2713
   326
    return DIENUM_CONTINUE;
slouken@2713
   327
}
slouken@2713
   328
slouken@2713
   329
slouken@2713
   330
/*
slouken@2713
   331
 * Opens the haptic device from the file descriptor.
slouken@2713
   332
 *
slouken@2713
   333
 *    Steps:
slouken@2713
   334
 *       - Open temporary DirectInputDevice interface.
icculus@6716
   335
 *       - Create DirectInputDevice8 interface.
slouken@2713
   336
 *       - Release DirectInputDevice interface.
icculus@6716
   337
 *       - Call SDL_SYS_HapticOpenFromDevice8
slouken@2713
   338
 */
slouken@2713
   339
static int
slouken@2713
   340
SDL_SYS_HapticOpenFromInstance(SDL_Haptic * haptic, DIDEVICEINSTANCE instance)
slouken@2713
   341
{
slouken@2713
   342
    HRESULT ret;
slouken@2713
   343
    int ret2;
icculus@6716
   344
    LPDIRECTINPUTDEVICE8 device;
slouken@2713
   345
slouken@2713
   346
    /* Allocate the hwdata */
slouken@2713
   347
    haptic->hwdata = (struct haptic_hwdata *)
slouken@2713
   348
        SDL_malloc(sizeof(*haptic->hwdata));
slouken@2713
   349
    if (haptic->hwdata == NULL) {
slouken@2713
   350
        SDL_OutOfMemory();
slouken@2713
   351
        goto creat_err;
slouken@2713
   352
    }
slouken@2713
   353
    SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
slouken@2713
   354
slouken@2713
   355
    /* Open the device */
icculus@6716
   356
    ret = IDirectInput8_CreateDevice(dinput, &instance.guidInstance,
slouken@2713
   357
                                    &device, NULL);
slouken@2713
   358
    if (FAILED(ret)) {
slouken@2713
   359
        DI_SetError("Creating DirectInput device", ret);
slouken@2713
   360
        goto creat_err;
slouken@2713
   361
    }
slouken@2713
   362
icculus@6716
   363
    /* Now get the IDirectInputDevice8 interface, instead. */
icculus@6716
   364
    ret = IDirectInputDevice8_QueryInterface(device,
icculus@6716
   365
                                            &IID_IDirectInputDevice8,
slouken@3013
   366
                                            (LPVOID *) & haptic->hwdata->
slouken@3013
   367
                                            device);
slouken@2713
   368
    /* Done with the temporary one now. */
icculus@6716
   369
    IDirectInputDevice8_Release(device);
slouken@2713
   370
    if (FAILED(ret)) {
slouken@2713
   371
        DI_SetError("Querying DirectInput interface", ret);
slouken@2713
   372
        goto creat_err;
slouken@2713
   373
    }
slouken@2713
   374
icculus@6716
   375
    ret2 = SDL_SYS_HapticOpenFromDevice8(haptic, haptic->hwdata->device);
slouken@2713
   376
    if (ret2 < 0) {
slouken@2713
   377
        goto query_err;
slouken@2713
   378
    }
slouken@2713
   379
slouken@2713
   380
    return 0;
slouken@2713
   381
slouken@2713
   382
  query_err:
icculus@6716
   383
    IDirectInputDevice8_Release(haptic->hwdata->device);
slouken@2713
   384
  creat_err:
slouken@2713
   385
    if (haptic->hwdata != NULL) {
slouken@2713
   386
        SDL_free(haptic->hwdata);
slouken@2713
   387
        haptic->hwdata = NULL;
slouken@2713
   388
    }
slouken@2713
   389
    return -1;
slouken@2713
   390
}
slouken@2713
   391
icculus@6990
   392
static int
icculus@6990
   393
SDL_SYS_HapticOpenFromXInput(SDL_Haptic * haptic, Uint8 userid)
icculus@6990
   394
{
icculus@6990
   395
    XINPUT_VIBRATION vibration = { 0, 0 };  /* stop any current vibration */
icculus@6990
   396
    XINPUTSETSTATE(userid, &vibration);
icculus@6990
   397
icculus@6990
   398
    /* !!! FIXME: we can probably do more than SINE if we figure out how to set up the left and right motors properly. */
icculus@6990
   399
    haptic->supported = SDL_HAPTIC_SINE;
icculus@6990
   400
icculus@6990
   401
    haptic->neffects = 1;
icculus@6990
   402
    haptic->nplaying = 1;
icculus@6990
   403
icculus@6990
   404
    /* Prepare effects memory. */
icculus@6990
   405
    haptic->effects = (struct haptic_effect *)
icculus@6990
   406
        SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
icculus@6990
   407
    if (haptic->effects == NULL) {
icculus@7037
   408
        return SDL_OutOfMemory();
icculus@6990
   409
    }
icculus@6990
   410
    /* Clear the memory */
icculus@6990
   411
    SDL_memset(haptic->effects, 0,
icculus@6990
   412
               sizeof(struct haptic_effect) * haptic->neffects);
icculus@6990
   413
icculus@6990
   414
    haptic->hwdata = (struct haptic_hwdata *) SDL_malloc(sizeof(*haptic->hwdata));
icculus@6990
   415
    if (haptic->hwdata == NULL) {
icculus@6990
   416
        SDL_free(haptic->effects);
icculus@6990
   417
        haptic->effects = NULL;
icculus@7037
   418
        return SDL_OutOfMemory();
icculus@6990
   419
    }
icculus@6990
   420
    SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
icculus@6990
   421
icculus@6990
   422
    haptic->hwdata->bXInputHaptic = 1;
icculus@6990
   423
    haptic->hwdata->userid = userid;
icculus@6990
   424
icculus@6990
   425
    return 0;
icculus@6990
   426
 }
slouken@2713
   427
slouken@2713
   428
/*
slouken@2713
   429
 * Opens the haptic device from the file descriptor.
slouken@2713
   430
 *
slouken@2713
   431
 *    Steps:
slouken@2713
   432
 *       - Set cooperative level.
slouken@2713
   433
 *       - Set data format.
slouken@2713
   434
 *       - Acquire exclusiveness.
slouken@2713
   435
 *       - Reset actuators.
philipp@7132
   436
 *       - Get supported features.
slouken@2713
   437
 */
slouken@2713
   438
static int
icculus@6716
   439
SDL_SYS_HapticOpenFromDevice8(SDL_Haptic * haptic,
icculus@6716
   440
                              LPDIRECTINPUTDEVICE8 device8)
slouken@2713
   441
{
slouken@2713
   442
    HRESULT ret;
slouken@2713
   443
    DIPROPDWORD dipdw;
slouken@2713
   444
icculus@6716
   445
    /* We'll use the device8 from now on. */
icculus@6716
   446
    haptic->hwdata->device = device8;
slouken@2713
   447
slouken@2713
   448
    /* Grab it exclusively to use force feedback stuff. */
icculus@6716
   449
    ret = IDirectInputDevice8_SetCooperativeLevel(haptic->hwdata->device,
slouken@2713
   450
                                                  SDL_HelperWindow,
slouken@2713
   451
                                                  DISCL_EXCLUSIVE |
slouken@2713
   452
                                                  DISCL_BACKGROUND);
slouken@2713
   453
    if (FAILED(ret)) {
slouken@2713
   454
        DI_SetError("Setting cooperative level to exclusive", ret);
slouken@2713
   455
        goto acquire_err;
slouken@2713
   456
    }
slouken@2713
   457
slouken@2713
   458
    /* Set data format. */
icculus@6716
   459
    ret = IDirectInputDevice8_SetDataFormat(haptic->hwdata->device,
slouken@2713
   460
                                            &c_dfDIJoystick2);
slouken@2713
   461
    if (FAILED(ret)) {
slouken@2713
   462
        DI_SetError("Setting data format", ret);
slouken@2713
   463
        goto acquire_err;
slouken@2713
   464
    }
slouken@2713
   465
slouken@2713
   466
    /* Get number of axes. */
icculus@6716
   467
    ret = IDirectInputDevice8_EnumObjects(haptic->hwdata->device,
slouken@2713
   468
                                          DI_DeviceObjectCallback,
slouken@2713
   469
                                          haptic, DIDFT_AXIS);
slouken@2713
   470
    if (FAILED(ret)) {
slouken@2713
   471
        DI_SetError("Getting device axes", ret);
slouken@2713
   472
        goto acquire_err;
slouken@2713
   473
    }
slouken@2713
   474
slouken@2713
   475
    /* Acquire the device. */
icculus@6716
   476
    ret = IDirectInputDevice8_Acquire(haptic->hwdata->device);
slouken@2713
   477
    if (FAILED(ret)) {
slouken@2713
   478
        DI_SetError("Acquiring DirectInput device", ret);
slouken@2713
   479
        goto acquire_err;
slouken@2713
   480
    }
slouken@2713
   481
slouken@2713
   482
    /* Reset all actuators - just in case. */
icculus@6716
   483
    ret = IDirectInputDevice8_SendForceFeedbackCommand(haptic->hwdata->device,
slouken@2713
   484
                                                       DISFFC_RESET);
slouken@2713
   485
    if (FAILED(ret)) {
slouken@2713
   486
        DI_SetError("Resetting device", ret);
slouken@2713
   487
        goto acquire_err;
slouken@2713
   488
    }
slouken@2713
   489
slouken@2713
   490
    /* Enabling actuators. */
icculus@6716
   491
    ret = IDirectInputDevice8_SendForceFeedbackCommand(haptic->hwdata->device,
slouken@2713
   492
                                                       DISFFC_SETACTUATORSON);
slouken@2713
   493
    if (FAILED(ret)) {
slouken@2713
   494
        DI_SetError("Enabling actuators", ret);
slouken@2713
   495
        goto acquire_err;
slouken@2713
   496
    }
slouken@2713
   497
slouken@2713
   498
    /* Get supported effects. */
icculus@6716
   499
    ret = IDirectInputDevice8_EnumEffects(haptic->hwdata->device,
slouken@2713
   500
                                          DI_EffectCallback, haptic,
slouken@2713
   501
                                          DIEFT_ALL);
slouken@2713
   502
    if (FAILED(ret)) {
slouken@2713
   503
        DI_SetError("Enumerating supported effects", ret);
slouken@2713
   504
        goto acquire_err;
slouken@2713
   505
    }
slouken@2713
   506
    if (haptic->supported == 0) {       /* Error since device supports nothing. */
slouken@2713
   507
        SDL_SetError("Haptic: Internal error on finding supported effects.");
slouken@2713
   508
        goto acquire_err;
slouken@2713
   509
    }
slouken@2713
   510
slouken@2713
   511
    /* Check autogain and autocenter. */
slouken@2713
   512
    dipdw.diph.dwSize = sizeof(DIPROPDWORD);
slouken@2713
   513
    dipdw.diph.dwHeaderSize = sizeof(DIPROPHEADER);
slouken@2713
   514
    dipdw.diph.dwObj = 0;
slouken@2713
   515
    dipdw.diph.dwHow = DIPH_DEVICE;
slouken@2713
   516
    dipdw.dwData = 10000;
icculus@6716
   517
    ret = IDirectInputDevice8_SetProperty(haptic->hwdata->device,
slouken@2713
   518
                                          DIPROP_FFGAIN, &dipdw.diph);
slouken@2713
   519
    if (!FAILED(ret)) {         /* Gain is supported. */
slouken@2713
   520
        haptic->supported |= SDL_HAPTIC_GAIN;
slouken@2713
   521
    }
slouken@2713
   522
    dipdw.diph.dwObj = 0;
slouken@2713
   523
    dipdw.diph.dwHow = DIPH_DEVICE;
slouken@2713
   524
    dipdw.dwData = DIPROPAUTOCENTER_OFF;
icculus@6716
   525
    ret = IDirectInputDevice8_SetProperty(haptic->hwdata->device,
slouken@2713
   526
                                          DIPROP_AUTOCENTER, &dipdw.diph);
slouken@2713
   527
    if (!FAILED(ret)) {         /* Autocenter is supported. */
slouken@2713
   528
        haptic->supported |= SDL_HAPTIC_AUTOCENTER;
slouken@2713
   529
    }
slouken@2713
   530
slouken@2713
   531
    /* Status is always supported. */
slouken@2713
   532
    haptic->supported |= SDL_HAPTIC_STATUS | SDL_HAPTIC_PAUSE;
slouken@2713
   533
slouken@2713
   534
    /* Check maximum effects. */
slouken@2713
   535
    haptic->neffects = 128;     /* This is not actually supported as thus under windows,
slouken@2713
   536
                                   there is no way to tell the number of EFFECTS that a
slouken@2713
   537
                                   device can hold, so we'll just use a "random" number
slouken@2713
   538
                                   instead and put warnings in SDL_haptic.h */
slouken@2713
   539
    haptic->nplaying = 128;     /* Even more impossible to get this then neffects. */
slouken@2713
   540
slouken@2713
   541
    /* Prepare effects memory. */
slouken@2713
   542
    haptic->effects = (struct haptic_effect *)
slouken@2713
   543
        SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
slouken@2713
   544
    if (haptic->effects == NULL) {
slouken@2713
   545
        SDL_OutOfMemory();
slouken@2713
   546
        goto acquire_err;
slouken@2713
   547
    }
slouken@2713
   548
    /* Clear the memory */
slouken@2713
   549
    SDL_memset(haptic->effects, 0,
slouken@2713
   550
               sizeof(struct haptic_effect) * haptic->neffects);
slouken@2713
   551
slouken@2713
   552
    return 0;
slouken@2713
   553
slouken@2713
   554
    /* Error handling */
slouken@2713
   555
  acquire_err:
icculus@6716
   556
    IDirectInputDevice8_Unacquire(haptic->hwdata->device);
slouken@2713
   557
    return -1;
slouken@2713
   558
slouken@2713
   559
}
slouken@2713
   560
slouken@2713
   561
slouken@2713
   562
/*
slouken@2713
   563
 * Opens a haptic device for usage.
slouken@2713
   564
 */
slouken@2713
   565
int
slouken@2713
   566
SDL_SYS_HapticOpen(SDL_Haptic * haptic)
slouken@2713
   567
{
icculus@6990
   568
    if (SDL_hapticlist[haptic->index].bXInputHaptic) {
icculus@6990
   569
        return SDL_SYS_HapticOpenFromXInput(haptic, SDL_hapticlist[haptic->index].userid);
icculus@6990
   570
    }
icculus@6990
   571
icculus@6990
   572
    return SDL_SYS_HapticOpenFromInstance(haptic, SDL_hapticlist[haptic->index].instance);
slouken@2713
   573
}
slouken@2713
   574
slouken@2713
   575
slouken@2713
   576
/*
slouken@2713
   577
 * Opens a haptic device from first mouse it finds for usage.
slouken@2713
   578
 */
slouken@2713
   579
int
slouken@2713
   580
SDL_SYS_HapticMouse(void)
slouken@2713
   581
{
slouken@2713
   582
    int i;
slouken@2713
   583
slouken@2713
   584
    /* Grab the first mouse haptic device we find. */
slouken@2713
   585
    for (i = 0; i < SDL_numhaptics; i++) {
slouken@6690
   586
        if (SDL_hapticlist[i].capabilities.dwDevType == DI8DEVCLASS_POINTER ) {
slouken@2713
   587
            return i;
slouken@2713
   588
        }
slouken@2713
   589
    }
slouken@2713
   590
slouken@2713
   591
    return -1;
slouken@2713
   592
}
slouken@2713
   593
slouken@2713
   594
slouken@2713
   595
/*
slouken@2713
   596
 * Checks to see if a joystick has haptic features.
slouken@2713
   597
 */
slouken@2713
   598
int
slouken@2713
   599
SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick)
slouken@2713
   600
{
icculus@6990
   601
    const struct joystick_hwdata *hwdata = joystick->hwdata;
icculus@6990
   602
    return ( (hwdata->bXInputHaptic) ||
icculus@6990
   603
             ((hwdata->Capabilities.dwFlags & DIDC_FORCEFEEDBACK) != 0) );
slouken@2713
   604
}
slouken@2713
   605
slouken@2713
   606
slouken@2713
   607
/*
slouken@2713
   608
 * Checks to see if the haptic device and joystick and in reality the same.
slouken@2713
   609
 */
slouken@2713
   610
int
slouken@2713
   611
SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, SDL_Joystick * joystick)
slouken@2713
   612
{
icculus@6990
   613
    if ((joystick->hwdata->bXInputHaptic == haptic->hwdata->bXInputHaptic) && (haptic->hwdata->userid == joystick->hwdata->userid)) {
icculus@6990
   614
        return 1;
icculus@6990
   615
    } else {
icculus@6990
   616
        HRESULT ret;
icculus@6990
   617
        DIDEVICEINSTANCE hap_instance, joy_instance;
slouken@2713
   618
icculus@6990
   619
        hap_instance.dwSize = sizeof(DIDEVICEINSTANCE);
icculus@6990
   620
        joy_instance.dwSize = sizeof(DIDEVICEINSTANCE);
icculus@6990
   621
icculus@6990
   622
        /* Get the device instances. */
icculus@6990
   623
        ret = IDirectInputDevice8_GetDeviceInfo(haptic->hwdata->device,
slouken@2713
   624
                                            &hap_instance);
icculus@6990
   625
        if (FAILED(ret)) {
icculus@6990
   626
            return 0;
icculus@6990
   627
        }
icculus@6990
   628
        ret = IDirectInputDevice8_GetDeviceInfo(joystick->hwdata->InputDevice,
icculus@6990
   629
                                                &joy_instance);
icculus@6990
   630
        if (FAILED(ret)) {
icculus@6990
   631
            return 0;
icculus@6990
   632
        }
icculus@6990
   633
icculus@6990
   634
        if (DI_GUIDIsSame(&hap_instance.guidInstance, &joy_instance.guidInstance))
icculus@6990
   635
            return 1;
slouken@2713
   636
    }
slouken@2713
   637
slouken@2713
   638
    return 0;
slouken@2713
   639
}
slouken@2713
   640
slouken@2713
   641
slouken@2713
   642
/*
slouken@2713
   643
 * Opens a SDL_Haptic from a SDL_Joystick.
slouken@2713
   644
 */
slouken@2713
   645
int
slouken@2713
   646
SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, SDL_Joystick * joystick)
slouken@2713
   647
{
slouken@5358
   648
    int i, ret;
slouken@5358
   649
    HRESULT idret;
slouken@5358
   650
    DIDEVICEINSTANCE joy_instance;
slouken@5539
   651
    joy_instance.dwSize = sizeof(DIDEVICEINSTANCE);
slouken@5358
   652
slouken@5358
   653
    /* Since it comes from a joystick we have to try to match it with a haptic device on our haptic list. */
icculus@6990
   654
    if (joystick->hwdata->bXInputDevice) {
icculus@6990
   655
        const Uint8 userid = joystick->hwdata->userid;
icculus@6990
   656
        for (i=0; i<SDL_numhaptics; i++) {
icculus@6990
   657
            if ((SDL_hapticlist[i].bXInputHaptic) && (SDL_hapticlist[i].userid == userid)) {
icculus@6990
   658
                SDL_assert(joystick->hwdata->bXInputHaptic);
icculus@6990
   659
                haptic->index = i;
icculus@6990
   660
                break;
icculus@6990
   661
            }
slouken@5358
   662
        }
icculus@6990
   663
    } else {
icculus@6990
   664
        for (i=0; i<SDL_numhaptics; i++) {
icculus@6990
   665
            idret = IDirectInputDevice8_GetDeviceInfo(joystick->hwdata->InputDevice,
icculus@6990
   666
                  &joy_instance);
icculus@6990
   667
            if (FAILED(idret)) {
icculus@6990
   668
                return -1;
icculus@6990
   669
            }
icculus@6990
   670
            if (DI_GUIDIsSame(&SDL_hapticlist[i].instance.guidInstance,
icculus@6990
   671
                              &joy_instance.guidInstance)) {
icculus@6990
   672
                haptic->index = i;
icculus@6990
   673
                break;
icculus@6990
   674
            }
slouken@5358
   675
        }
slouken@5358
   676
    }
slouken@5358
   677
    if (i >= SDL_numhaptics) {
slouken@5358
   678
        return -1;
slouken@5358
   679
    }
slouken@2713
   680
slouken@2713
   681
    /* Allocate the hwdata */
slouken@2713
   682
    haptic->hwdata = (struct haptic_hwdata *)
slouken@2713
   683
        SDL_malloc(sizeof(*haptic->hwdata));
slouken@2713
   684
    if (haptic->hwdata == NULL) {
icculus@7037
   685
        return SDL_OutOfMemory();
slouken@2713
   686
    }
slouken@2713
   687
    SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
slouken@2713
   688
slouken@2713
   689
    /* Now open the device. */
icculus@6990
   690
    if (!joystick->hwdata->bXInputHaptic) {
icculus@6990
   691
        ret = SDL_SYS_HapticOpenFromDevice8(haptic, joystick->hwdata->InputDevice);
icculus@6990
   692
        if (ret < 0) {
icculus@6990
   693
            return -1;
icculus@6990
   694
        }
slouken@2713
   695
    }
slouken@2713
   696
slouken@2713
   697
    /* It's using the joystick device. */
slouken@2713
   698
    haptic->hwdata->is_joystick = 1;
icculus@6990
   699
    haptic->hwdata->bXInputHaptic = joystick->hwdata->bXInputHaptic;
icculus@6990
   700
    haptic->hwdata->userid = joystick->hwdata->userid;
slouken@2713
   701
slouken@2713
   702
    return 0;
slouken@2713
   703
}
slouken@2713
   704
slouken@2713
   705
slouken@2713
   706
/*
slouken@2713
   707
 * Closes the haptic device.
slouken@2713
   708
 */
slouken@2713
   709
void
slouken@2713
   710
SDL_SYS_HapticClose(SDL_Haptic * haptic)
slouken@2713
   711
{
slouken@2713
   712
    if (haptic->hwdata) {
slouken@2713
   713
slouken@2713
   714
        /* Free effects. */
slouken@2713
   715
        SDL_free(haptic->effects);
slouken@2713
   716
        haptic->effects = NULL;
slouken@2713
   717
        haptic->neffects = 0;
slouken@2713
   718
slouken@2713
   719
        /* Clean up */
icculus@6990
   720
        if (!haptic->hwdata->bXInputHaptic) {
icculus@6990
   721
            IDirectInputDevice8_Unacquire(haptic->hwdata->device);
icculus@6990
   722
            /* Only release if isn't grabbed by a joystick. */
icculus@6990
   723
            if (haptic->hwdata->is_joystick == 0) {
icculus@6990
   724
                IDirectInputDevice8_Release(haptic->hwdata->device);
icculus@6990
   725
            }
slouken@2713
   726
        }
slouken@2713
   727
slouken@2713
   728
        /* Free */
slouken@2713
   729
        SDL_free(haptic->hwdata);
slouken@2713
   730
        haptic->hwdata = NULL;
slouken@2713
   731
    }
slouken@2713
   732
}
slouken@2713
   733
slouken@2713
   734
slouken@7191
   735
/*
slouken@2713
   736
 * Clean up after system specific haptic stuff
slouken@2713
   737
 */
slouken@2713
   738
void
slouken@2713
   739
SDL_SYS_HapticQuit(void)
slouken@2713
   740
{
slouken@5090
   741
    int i;
slouken@5090
   742
icculus@6990
   743
    if (loaded_xinput) {
icculus@6990
   744
        WIN_UnloadXInputDLL();
icculus@6990
   745
        loaded_xinput = SDL_FALSE;
icculus@6990
   746
    }
icculus@6990
   747
slouken@5090
   748
    for (i = 0; i < SDL_arraysize(SDL_hapticlist); ++i) {
slouken@5090
   749
        if (SDL_hapticlist[i].name) {
slouken@5090
   750
            SDL_free(SDL_hapticlist[i].name);
slouken@5090
   751
            SDL_hapticlist[i].name = NULL;
slouken@5090
   752
        }
slouken@5090
   753
    }
slouken@5090
   754
icculus@5591
   755
    if (dinput != NULL) {
icculus@6716
   756
        IDirectInput8_Release(dinput);
icculus@5591
   757
        dinput = NULL;
icculus@5591
   758
    }
icculus@5591
   759
icculus@5591
   760
    if (coinitialized) {
icculus@5591
   761
        WIN_CoUninitialize();
icculus@5591
   762
        coinitialized = SDL_FALSE;
icculus@5591
   763
    }
slouken@2713
   764
}
slouken@2713
   765
slouken@2713
   766
slouken@2713
   767
/*
slouken@2713
   768
 * Converts an SDL trigger button to an DIEFFECT trigger button.
slouken@2713
   769
 */
slouken@2713
   770
static DWORD
slouken@2713
   771
DIGetTriggerButton(Uint16 button)
slouken@2713
   772
{
slouken@2713
   773
    DWORD dwTriggerButton;
slouken@2713
   774
slouken@2713
   775
    dwTriggerButton = DIEB_NOTRIGGER;
slouken@2713
   776
slouken@2713
   777
    if (button != 0) {
slouken@2713
   778
        dwTriggerButton = DIJOFS_BUTTON(button - 1);
slouken@2713
   779
    }
slouken@2713
   780
slouken@2713
   781
    return dwTriggerButton;
slouken@2713
   782
}
slouken@2713
   783
slouken@2713
   784
slouken@2713
   785
/*
slouken@2713
   786
 * Sets the direction.
slouken@2713
   787
 */
slouken@2713
   788
static int
slouken@2713
   789
SDL_SYS_SetDirection(DIEFFECT * effect, SDL_HapticDirection * dir, int naxes)
slouken@2713
   790
{
slouken@2713
   791
    LONG *rglDir;
slouken@2713
   792
slouken@2713
   793
    /* Handle no axes a part. */
slouken@2713
   794
    if (naxes == 0) {
slouken@2713
   795
        effect->dwFlags |= DIEFF_SPHERICAL;     /* Set as default. */
slouken@2713
   796
        effect->rglDirection = NULL;
slouken@2713
   797
        return 0;
slouken@2713
   798
    }
slouken@2713
   799
slouken@2713
   800
    /* Has axes. */
slouken@2713
   801
    rglDir = SDL_malloc(sizeof(LONG) * naxes);
slouken@2713
   802
    if (rglDir == NULL) {
icculus@7037
   803
        return SDL_OutOfMemory();
slouken@2713
   804
    }
slouken@2713
   805
    SDL_memset(rglDir, 0, sizeof(LONG) * naxes);
slouken@2713
   806
    effect->rglDirection = rglDir;
slouken@2713
   807
slouken@2713
   808
    switch (dir->type) {
slouken@2713
   809
    case SDL_HAPTIC_POLAR:
slouken@2713
   810
        effect->dwFlags |= DIEFF_POLAR;
slouken@2713
   811
        rglDir[0] = dir->dir[0];
slouken@2713
   812
        return 0;
slouken@2713
   813
    case SDL_HAPTIC_CARTESIAN:
slouken@2713
   814
        effect->dwFlags |= DIEFF_CARTESIAN;
slouken@2713
   815
        rglDir[0] = dir->dir[0];
slouken@2713
   816
        if (naxes > 1)
slouken@2713
   817
            rglDir[1] = dir->dir[1];
slouken@2713
   818
        if (naxes > 2)
slouken@2713
   819
            rglDir[2] = dir->dir[2];
slouken@2713
   820
        return 0;
slouken@2713
   821
    case SDL_HAPTIC_SPHERICAL:
slouken@2713
   822
        effect->dwFlags |= DIEFF_SPHERICAL;
slouken@2713
   823
        rglDir[0] = dir->dir[0];
slouken@2713
   824
        if (naxes > 1)
slouken@2713
   825
            rglDir[1] = dir->dir[1];
slouken@2713
   826
        if (naxes > 2)
slouken@2713
   827
            rglDir[2] = dir->dir[2];
slouken@2713
   828
        return 0;
slouken@2713
   829
slouken@2713
   830
    default:
icculus@7037
   831
        return SDL_SetError("Haptic: Unknown direction type.");
slouken@2713
   832
    }
slouken@2713
   833
}
slouken@2713
   834
slouken@2713
   835
#define CONVERT(x)   (((x) > 0x7FFF) ? 10000 : ((x)*10000) / 0x7FFF)
slouken@2713
   836
/*
slouken@2713
   837
 * Creates the DIEFFECT from a SDL_HapticEffect.
slouken@2713
   838
 */
slouken@2713
   839
static int
slouken@2713
   840
SDL_SYS_ToDIEFFECT(SDL_Haptic * haptic, DIEFFECT * dest,
slouken@2713
   841
                   SDL_HapticEffect * src)
slouken@2713
   842
{
slouken@2713
   843
    int i;
slouken@2713
   844
    DICONSTANTFORCE *constant;
slouken@2713
   845
    DIPERIODIC *periodic;
slouken@2713
   846
    DICONDITION *condition;     /* Actually an array of conditions - one per axis. */
slouken@2713
   847
    DIRAMPFORCE *ramp;
slouken@2713
   848
    DICUSTOMFORCE *custom;
slouken@2713
   849
    DIENVELOPE *envelope;
slouken@2713
   850
    SDL_HapticConstant *hap_constant;
slouken@2713
   851
    SDL_HapticPeriodic *hap_periodic;
slouken@2713
   852
    SDL_HapticCondition *hap_condition;
slouken@2713
   853
    SDL_HapticRamp *hap_ramp;
slouken@2713
   854
    SDL_HapticCustom *hap_custom;
slouken@2713
   855
    DWORD *axes;
slouken@2713
   856
slouken@2713
   857
    /* Set global stuff. */
slouken@2713
   858
    SDL_memset(dest, 0, sizeof(DIEFFECT));
slouken@2713
   859
    dest->dwSize = sizeof(DIEFFECT);    /* Set the structure size. */
slouken@2713
   860
    dest->dwSamplePeriod = 0;   /* Not used by us. */
slouken@2713
   861
    dest->dwGain = 10000;       /* Gain is set globally, not locally. */
slouken@2713
   862
    dest->dwFlags = DIEFF_OBJECTOFFSETS;        /* Seems obligatory. */
slouken@2713
   863
slouken@2713
   864
    /* Envelope. */
slouken@2713
   865
    envelope = SDL_malloc(sizeof(DIENVELOPE));
slouken@2713
   866
    if (envelope == NULL) {
icculus@7037
   867
        return SDL_OutOfMemory();
slouken@2713
   868
    }
slouken@2713
   869
    SDL_memset(envelope, 0, sizeof(DIENVELOPE));
slouken@2713
   870
    dest->lpEnvelope = envelope;
slouken@2713
   871
    envelope->dwSize = sizeof(DIENVELOPE);      /* Always should be this. */
slouken@2713
   872
slouken@2713
   873
    /* Axes. */
slouken@2713
   874
    dest->cAxes = haptic->naxes;
slouken@2713
   875
    if (dest->cAxes > 0) {
slouken@2713
   876
        axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
slouken@2713
   877
        if (axes == NULL) {
icculus@7037
   878
            return SDL_OutOfMemory();
slouken@2713
   879
        }
slouken@2713
   880
        axes[0] = haptic->hwdata->axes[0];      /* Always at least one axis. */
slouken@2713
   881
        if (dest->cAxes > 1) {
slouken@2713
   882
            axes[1] = haptic->hwdata->axes[1];
slouken@2713
   883
        }
slouken@2713
   884
        if (dest->cAxes > 2) {
slouken@2713
   885
            axes[2] = haptic->hwdata->axes[2];
slouken@2713
   886
        }
slouken@2713
   887
        dest->rgdwAxes = axes;
slouken@2713
   888
    }
slouken@2713
   889
slouken@2713
   890
philipp@7132
   891
    /* The big type handling switch, even bigger then Linux's version. */
slouken@2713
   892
    switch (src->type) {
slouken@2713
   893
    case SDL_HAPTIC_CONSTANT:
slouken@2713
   894
        hap_constant = &src->constant;
slouken@2713
   895
        constant = SDL_malloc(sizeof(DICONSTANTFORCE));
slouken@2713
   896
        if (constant == NULL) {
icculus@7037
   897
            return SDL_OutOfMemory();
slouken@2713
   898
        }
slouken@2713
   899
        SDL_memset(constant, 0, sizeof(DICONSTANTFORCE));
slouken@2713
   900
slouken@2713
   901
        /* Specifics */
slouken@2713
   902
        constant->lMagnitude = CONVERT(hap_constant->level);
slouken@2713
   903
        dest->cbTypeSpecificParams = sizeof(DICONSTANTFORCE);
slouken@2713
   904
        dest->lpvTypeSpecificParams = constant;
slouken@2713
   905
slouken@2713
   906
        /* Generics */
slouken@2713
   907
        dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
slouken@2713
   908
        dest->dwTriggerButton = DIGetTriggerButton(hap_constant->button);
slouken@2713
   909
        dest->dwTriggerRepeatInterval = hap_constant->interval;
slouken@2713
   910
        dest->dwStartDelay = hap_constant->delay * 1000;        /* In microseconds. */
slouken@2713
   911
slouken@2713
   912
        /* Direction. */
slouken@2713
   913
        if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes)
slouken@2713
   914
            < 0) {
slouken@2713
   915
            return -1;
slouken@2713
   916
        }
slouken@2713
   917
slouken@2713
   918
        /* Envelope */
slouken@2713
   919
        if ((hap_constant->attack_length == 0)
slouken@2713
   920
            && (hap_constant->fade_length == 0)) {
slouken@2713
   921
            SDL_free(dest->lpEnvelope);
slouken@2713
   922
            dest->lpEnvelope = NULL;
slouken@2713
   923
        } else {
slouken@2713
   924
            envelope->dwAttackLevel = CONVERT(hap_constant->attack_level);
slouken@2713
   925
            envelope->dwAttackTime = hap_constant->attack_length * 1000;
slouken@2713
   926
            envelope->dwFadeLevel = CONVERT(hap_constant->fade_level);
slouken@2713
   927
            envelope->dwFadeTime = hap_constant->fade_length * 1000;
slouken@2713
   928
        }
slouken@2713
   929
slouken@2713
   930
        break;
slouken@2713
   931
slouken@2713
   932
    case SDL_HAPTIC_SINE:
slouken@2713
   933
    case SDL_HAPTIC_SQUARE:
slouken@2713
   934
    case SDL_HAPTIC_TRIANGLE:
slouken@2713
   935
    case SDL_HAPTIC_SAWTOOTHUP:
slouken@2713
   936
    case SDL_HAPTIC_SAWTOOTHDOWN:
slouken@2713
   937
        hap_periodic = &src->periodic;
slouken@2713
   938
        periodic = SDL_malloc(sizeof(DIPERIODIC));
slouken@2713
   939
        if (periodic == NULL) {
icculus@7037
   940
            return SDL_OutOfMemory();
slouken@2713
   941
        }
slouken@2713
   942
        SDL_memset(periodic, 0, sizeof(DIPERIODIC));
slouken@2713
   943
slouken@2713
   944
        /* Specifics */
slouken@2713
   945
        periodic->dwMagnitude = CONVERT(hap_periodic->magnitude);
slouken@2713
   946
        periodic->lOffset = CONVERT(hap_periodic->offset);
slouken@2713
   947
        periodic->dwPhase = hap_periodic->phase;
slouken@2713
   948
        periodic->dwPeriod = hap_periodic->period * 1000;
slouken@2713
   949
        dest->cbTypeSpecificParams = sizeof(DIPERIODIC);
slouken@2713
   950
        dest->lpvTypeSpecificParams = periodic;
slouken@2713
   951
slouken@2713
   952
        /* Generics */
slouken@2713
   953
        dest->dwDuration = hap_periodic->length * 1000; /* In microseconds. */
slouken@2713
   954
        dest->dwTriggerButton = DIGetTriggerButton(hap_periodic->button);
slouken@2713
   955
        dest->dwTriggerRepeatInterval = hap_periodic->interval;
slouken@2713
   956
        dest->dwStartDelay = hap_periodic->delay * 1000;        /* In microseconds. */
slouken@2713
   957
slouken@2713
   958
        /* Direction. */
slouken@2713
   959
        if (SDL_SYS_SetDirection(dest, &hap_periodic->direction, dest->cAxes)
slouken@2713
   960
            < 0) {
slouken@2713
   961
            return -1;
slouken@2713
   962
        }
slouken@2713
   963
slouken@2713
   964
        /* Envelope */
slouken@2713
   965
        if ((hap_periodic->attack_length == 0)
slouken@2713
   966
            && (hap_periodic->fade_length == 0)) {
slouken@2713
   967
            SDL_free(dest->lpEnvelope);
slouken@2713
   968
            dest->lpEnvelope = NULL;
slouken@2713
   969
        } else {
slouken@2713
   970
            envelope->dwAttackLevel = CONVERT(hap_periodic->attack_level);
slouken@2713
   971
            envelope->dwAttackTime = hap_periodic->attack_length * 1000;
slouken@2713
   972
            envelope->dwFadeLevel = CONVERT(hap_periodic->fade_level);
slouken@2713
   973
            envelope->dwFadeTime = hap_periodic->fade_length * 1000;
slouken@2713
   974
        }
slouken@2713
   975
slouken@2713
   976
        break;
slouken@2713
   977
slouken@2713
   978
    case SDL_HAPTIC_SPRING:
slouken@2713
   979
    case SDL_HAPTIC_DAMPER:
slouken@2713
   980
    case SDL_HAPTIC_INERTIA:
slouken@2713
   981
    case SDL_HAPTIC_FRICTION:
slouken@2713
   982
        hap_condition = &src->condition;
slouken@2713
   983
        condition = SDL_malloc(sizeof(DICONDITION) * dest->cAxes);
slouken@2713
   984
        if (condition == NULL) {
icculus@7037
   985
            return SDL_OutOfMemory();
slouken@2713
   986
        }
slouken@2713
   987
        SDL_memset(condition, 0, sizeof(DICONDITION));
slouken@2713
   988
slouken@2713
   989
        /* Specifics */
slouken@2713
   990
        for (i = 0; i < (int) dest->cAxes; i++) {
slouken@2713
   991
            condition[i].lOffset = CONVERT(hap_condition->center[i]);
slouken@2713
   992
            condition[i].lPositiveCoefficient =
slouken@2713
   993
                CONVERT(hap_condition->right_coeff[i]);
slouken@2713
   994
            condition[i].lNegativeCoefficient =
slouken@2713
   995
                CONVERT(hap_condition->left_coeff[i]);
slouken@2713
   996
            condition[i].dwPositiveSaturation =
slouken@2713
   997
                CONVERT(hap_condition->right_sat[i]);
slouken@2713
   998
            condition[i].dwNegativeSaturation =
slouken@2713
   999
                CONVERT(hap_condition->left_sat[i]);
slouken@2713
  1000
            condition[i].lDeadBand = CONVERT(hap_condition->deadband[i]);
slouken@2713
  1001
        }
slouken@2713
  1002
        dest->cbTypeSpecificParams = sizeof(DICONDITION) * dest->cAxes;
slouken@2713
  1003
        dest->lpvTypeSpecificParams = condition;
slouken@2713
  1004
slouken@2713
  1005
        /* Generics */
slouken@2713
  1006
        dest->dwDuration = hap_condition->length * 1000;        /* In microseconds. */
slouken@2713
  1007
        dest->dwTriggerButton = DIGetTriggerButton(hap_condition->button);
slouken@2713
  1008
        dest->dwTriggerRepeatInterval = hap_condition->interval;
slouken@2713
  1009
        dest->dwStartDelay = hap_condition->delay * 1000;       /* In microseconds. */
slouken@2713
  1010
slouken@2713
  1011
        /* Direction. */
slouken@2713
  1012
        if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes)
slouken@2713
  1013
            < 0) {
slouken@2713
  1014
            return -1;
slouken@2713
  1015
        }
slouken@2713
  1016
slouken@2713
  1017
        /* Envelope - Not actually supported by most CONDITION implementations. */
slouken@2713
  1018
        SDL_free(dest->lpEnvelope);
slouken@2713
  1019
        dest->lpEnvelope = NULL;
slouken@2713
  1020
slouken@2713
  1021
        break;
slouken@2713
  1022
slouken@2713
  1023
    case SDL_HAPTIC_RAMP:
slouken@2713
  1024
        hap_ramp = &src->ramp;
slouken@2713
  1025
        ramp = SDL_malloc(sizeof(DIRAMPFORCE));
slouken@2713
  1026
        if (ramp == NULL) {
icculus@7037
  1027
            return SDL_OutOfMemory();
slouken@2713
  1028
        }
slouken@2713
  1029
        SDL_memset(ramp, 0, sizeof(DIRAMPFORCE));
slouken@2713
  1030
slouken@2713
  1031
        /* Specifics */
slouken@2713
  1032
        ramp->lStart = CONVERT(hap_ramp->start);
slouken@2713
  1033
        ramp->lEnd = CONVERT(hap_ramp->end);
slouken@2713
  1034
        dest->cbTypeSpecificParams = sizeof(DIRAMPFORCE);
slouken@2713
  1035
        dest->lpvTypeSpecificParams = ramp;
slouken@2713
  1036
slouken@2713
  1037
        /* Generics */
slouken@2713
  1038
        dest->dwDuration = hap_ramp->length * 1000;     /* In microseconds. */
slouken@2713
  1039
        dest->dwTriggerButton = DIGetTriggerButton(hap_ramp->button);
slouken@2713
  1040
        dest->dwTriggerRepeatInterval = hap_ramp->interval;
slouken@2713
  1041
        dest->dwStartDelay = hap_ramp->delay * 1000;    /* In microseconds. */
slouken@2713
  1042
slouken@2713
  1043
        /* Direction. */
slouken@2713
  1044
        if (SDL_SYS_SetDirection(dest, &hap_ramp->direction, dest->cAxes) < 0) {
slouken@2713
  1045
            return -1;
slouken@2713
  1046
        }
slouken@2713
  1047
slouken@2713
  1048
        /* Envelope */
slouken@2713
  1049
        if ((hap_ramp->attack_length == 0) && (hap_ramp->fade_length == 0)) {
slouken@2713
  1050
            SDL_free(dest->lpEnvelope);
slouken@2713
  1051
            dest->lpEnvelope = NULL;
slouken@2713
  1052
        } else {
slouken@2713
  1053
            envelope->dwAttackLevel = CONVERT(hap_ramp->attack_level);
slouken@2713
  1054
            envelope->dwAttackTime = hap_ramp->attack_length * 1000;
slouken@2713
  1055
            envelope->dwFadeLevel = CONVERT(hap_ramp->fade_level);
slouken@2713
  1056
            envelope->dwFadeTime = hap_ramp->fade_length * 1000;
slouken@2713
  1057
        }
slouken@2713
  1058
slouken@2713
  1059
        break;
slouken@2713
  1060
slouken@2713
  1061
    case SDL_HAPTIC_CUSTOM:
slouken@2713
  1062
        hap_custom = &src->custom;
slouken@2713
  1063
        custom = SDL_malloc(sizeof(DICUSTOMFORCE));
slouken@2713
  1064
        if (custom == NULL) {
icculus@7037
  1065
            return SDL_OutOfMemory();
slouken@2713
  1066
        }
slouken@2713
  1067
        SDL_memset(custom, 0, sizeof(DICUSTOMFORCE));
slouken@2713
  1068
slouken@2713
  1069
        /* Specifics */
slouken@2713
  1070
        custom->cChannels = hap_custom->channels;
slouken@2713
  1071
        custom->dwSamplePeriod = hap_custom->period * 1000;
slouken@2713
  1072
        custom->cSamples = hap_custom->samples;
slouken@2713
  1073
        custom->rglForceData =
slouken@2713
  1074
            SDL_malloc(sizeof(LONG) * custom->cSamples * custom->cChannels);
slouken@2713
  1075
        for (i = 0; i < hap_custom->samples * hap_custom->channels; i++) {      /* Copy data. */
slouken@2713
  1076
            custom->rglForceData[i] = CONVERT(hap_custom->data[i]);
slouken@2713
  1077
        }
slouken@2713
  1078
        dest->cbTypeSpecificParams = sizeof(DICUSTOMFORCE);
slouken@2713
  1079
        dest->lpvTypeSpecificParams = custom;
slouken@2713
  1080
slouken@2713
  1081
        /* Generics */
slouken@2713
  1082
        dest->dwDuration = hap_custom->length * 1000;   /* In microseconds. */
slouken@2713
  1083
        dest->dwTriggerButton = DIGetTriggerButton(hap_custom->button);
slouken@2713
  1084
        dest->dwTriggerRepeatInterval = hap_custom->interval;
slouken@2713
  1085
        dest->dwStartDelay = hap_custom->delay * 1000;  /* In microseconds. */
slouken@2713
  1086
slouken@2713
  1087
        /* Direction. */
slouken@2713
  1088
        if (SDL_SYS_SetDirection(dest, &hap_custom->direction, dest->cAxes) <
slouken@2713
  1089
            0) {
slouken@2713
  1090
            return -1;
slouken@2713
  1091
        }
slouken@2713
  1092
slouken@2713
  1093
        /* Envelope */
slouken@2713
  1094
        if ((hap_custom->attack_length == 0)
slouken@2713
  1095
            && (hap_custom->fade_length == 0)) {
slouken@2713
  1096
            SDL_free(dest->lpEnvelope);
slouken@2713
  1097
            dest->lpEnvelope = NULL;
slouken@2713
  1098
        } else {
slouken@2713
  1099
            envelope->dwAttackLevel = CONVERT(hap_custom->attack_level);
slouken@2713
  1100
            envelope->dwAttackTime = hap_custom->attack_length * 1000;
slouken@2713
  1101
            envelope->dwFadeLevel = CONVERT(hap_custom->fade_level);
slouken@2713
  1102
            envelope->dwFadeTime = hap_custom->fade_length * 1000;
slouken@2713
  1103
        }
slouken@2713
  1104
slouken@2713
  1105
        break;
slouken@2713
  1106
slouken@2713
  1107
slouken@2713
  1108
    default:
icculus@7037
  1109
        return SDL_SetError("Haptic: Unknown effect type.");
slouken@2713
  1110
    }
slouken@2713
  1111
slouken@2713
  1112
    return 0;
slouken@2713
  1113
}
slouken@2713
  1114
slouken@2713
  1115
slouken@2713
  1116
/*
slouken@2713
  1117
 * Frees an DIEFFECT allocated by SDL_SYS_ToDIEFFECT.
slouken@2713
  1118
 */
slouken@2713
  1119
static void
slouken@2713
  1120
SDL_SYS_HapticFreeDIEFFECT(DIEFFECT * effect, int type)
slouken@2713
  1121
{
slouken@2713
  1122
    DICUSTOMFORCE *custom;
slouken@2713
  1123
slouken@2713
  1124
    if (effect->lpEnvelope != NULL) {
slouken@2713
  1125
        SDL_free(effect->lpEnvelope);
slouken@2713
  1126
        effect->lpEnvelope = NULL;
slouken@2713
  1127
    }
slouken@2713
  1128
    if (effect->rgdwAxes != NULL) {
slouken@2713
  1129
        SDL_free(effect->rgdwAxes);
slouken@2713
  1130
        effect->rgdwAxes = NULL;
slouken@2713
  1131
    }
slouken@2713
  1132
    if (effect->lpvTypeSpecificParams != NULL) {
slouken@2713
  1133
        if (type == SDL_HAPTIC_CUSTOM) {        /* Must free the custom data. */
slouken@2713
  1134
            custom = (DICUSTOMFORCE *) effect->lpvTypeSpecificParams;
slouken@2713
  1135
            SDL_free(custom->rglForceData);
slouken@2713
  1136
            custom->rglForceData = NULL;
slouken@2713
  1137
        }
slouken@2713
  1138
        SDL_free(effect->lpvTypeSpecificParams);
slouken@2713
  1139
        effect->lpvTypeSpecificParams = NULL;
slouken@2713
  1140
    }
slouken@2713
  1141
    if (effect->rglDirection != NULL) {
slouken@2713
  1142
        SDL_free(effect->rglDirection);
slouken@2713
  1143
        effect->rglDirection = NULL;
slouken@2713
  1144
    }
slouken@2713
  1145
}
slouken@2713
  1146
slouken@2713
  1147
slouken@2713
  1148
/*
slouken@2713
  1149
 * Gets the effect type from the generic SDL haptic effect wrapper.
slouken@2713
  1150
 */
slouken@2713
  1151
static REFGUID
slouken@2713
  1152
SDL_SYS_HapticEffectType(SDL_HapticEffect * effect)
slouken@2713
  1153
{
slouken@2713
  1154
    switch (effect->type) {
slouken@2713
  1155
    case SDL_HAPTIC_CONSTANT:
slouken@2713
  1156
        return &GUID_ConstantForce;
slouken@2713
  1157
slouken@2713
  1158
    case SDL_HAPTIC_RAMP:
slouken@2713
  1159
        return &GUID_RampForce;
slouken@2713
  1160
slouken@2713
  1161
    case SDL_HAPTIC_SQUARE:
slouken@2713
  1162
        return &GUID_Square;
slouken@2713
  1163
slouken@2713
  1164
    case SDL_HAPTIC_SINE:
slouken@2713
  1165
        return &GUID_Sine;
slouken@2713
  1166
slouken@2713
  1167
    case SDL_HAPTIC_TRIANGLE:
slouken@2713
  1168
        return &GUID_Triangle;
slouken@2713
  1169
slouken@2713
  1170
    case SDL_HAPTIC_SAWTOOTHUP:
slouken@2713
  1171
        return &GUID_SawtoothUp;
slouken@2713
  1172
slouken@2713
  1173
    case SDL_HAPTIC_SAWTOOTHDOWN:
slouken@2713
  1174
        return &GUID_SawtoothDown;
slouken@2713
  1175
slouken@2713
  1176
    case SDL_HAPTIC_SPRING:
slouken@2713
  1177
        return &GUID_Spring;
slouken@2713
  1178
slouken@2713
  1179
    case SDL_HAPTIC_DAMPER:
slouken@2713
  1180
        return &GUID_Damper;
slouken@2713
  1181
slouken@2713
  1182
    case SDL_HAPTIC_INERTIA:
slouken@2713
  1183
        return &GUID_Inertia;
slouken@2713
  1184
slouken@2713
  1185
    case SDL_HAPTIC_FRICTION:
slouken@2713
  1186
        return &GUID_Friction;
slouken@2713
  1187
slouken@2713
  1188
    case SDL_HAPTIC_CUSTOM:
slouken@2713
  1189
        return &GUID_CustomForce;
slouken@2713
  1190
slouken@2713
  1191
    default:
slouken@2713
  1192
        SDL_SetError("Haptic: Unknown effect type.");
slouken@2713
  1193
        return NULL;
slouken@2713
  1194
    }
slouken@2713
  1195
}
slouken@2713
  1196
slouken@2713
  1197
slouken@2713
  1198
/*
slouken@2713
  1199
 * Creates a new haptic effect.
slouken@2713
  1200
 */
slouken@2713
  1201
int
slouken@2713
  1202
SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, struct haptic_effect *effect,
slouken@2713
  1203
                        SDL_HapticEffect * base)
slouken@2713
  1204
{
slouken@2713
  1205
    HRESULT ret;
icculus@6990
  1206
    REFGUID type = SDL_SYS_HapticEffectType(base);
slouken@2713
  1207
slouken@2713
  1208
    if (type == NULL) {
slouken@2713
  1209
        goto err_hweffect;
slouken@2713
  1210
    }
slouken@2713
  1211
slouken@2713
  1212
    /* Alloc the effect. */
slouken@2713
  1213
    effect->hweffect = (struct haptic_hweffect *)
slouken@2713
  1214
        SDL_malloc(sizeof(struct haptic_hweffect));
slouken@2713
  1215
    if (effect->hweffect == NULL) {
slouken@2713
  1216
        SDL_OutOfMemory();
slouken@2713
  1217
        goto err_hweffect;
slouken@2713
  1218
    }
slouken@2713
  1219
icculus@6990
  1220
    SDL_zerop(effect->hweffect);
icculus@6990
  1221
icculus@6990
  1222
    if (haptic->hwdata->bXInputHaptic) {
icculus@6990
  1223
        SDL_assert(base->type == SDL_HAPTIC_SINE);  /* should catch this at higher level */
icculus@6990
  1224
        return SDL_SYS_HapticUpdateEffect(haptic, effect, base);
icculus@6990
  1225
    }
icculus@6990
  1226
slouken@2713
  1227
    /* Get the effect. */
slouken@2713
  1228
    if (SDL_SYS_ToDIEFFECT(haptic, &effect->hweffect->effect, base) < 0) {
slouken@2713
  1229
        goto err_effectdone;
slouken@2713
  1230
    }
slouken@2713
  1231
slouken@2713
  1232
    /* Create the actual effect. */
icculus@6716
  1233
    ret = IDirectInputDevice8_CreateEffect(haptic->hwdata->device, type,
slouken@2713
  1234
                                           &effect->hweffect->effect,
slouken@2713
  1235
                                           &effect->hweffect->ref, NULL);
slouken@2713
  1236
    if (FAILED(ret)) {
slouken@2713
  1237
        DI_SetError("Unable to create effect", ret);
slouken@2713
  1238
        goto err_effectdone;
slouken@2713
  1239
    }
slouken@2713
  1240
slouken@2713
  1241
    return 0;
slouken@2713
  1242
slouken@2713
  1243
  err_effectdone:
slouken@2713
  1244
    SDL_SYS_HapticFreeDIEFFECT(&effect->hweffect->effect, base->type);
slouken@2713
  1245
  err_hweffect:
slouken@2713
  1246
    if (effect->hweffect != NULL) {
slouken@2713
  1247
        SDL_free(effect->hweffect);
slouken@2713
  1248
        effect->hweffect = NULL;
slouken@2713
  1249
    }
slouken@2713
  1250
    return -1;
slouken@2713
  1251
}
slouken@2713
  1252
slouken@2713
  1253
slouken@2713
  1254
/*
slouken@2713
  1255
 * Updates an effect.
slouken@2713
  1256
 */
slouken@2713
  1257
int
slouken@2713
  1258
SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
slouken@2713
  1259
                           struct haptic_effect *effect,
slouken@2713
  1260
                           SDL_HapticEffect * data)
slouken@2713
  1261
{
slouken@2713
  1262
    HRESULT ret;
slouken@2713
  1263
    DWORD flags;
slouken@2713
  1264
    DIEFFECT temp;
slouken@2713
  1265
icculus@6990
  1266
    if (haptic->hwdata->bXInputHaptic) {
slouken@7191
  1267
        /* !!! FIXME: this isn't close to right. We only support "sine" effects,
slouken@7191
  1268
         * !!! FIXME:  we ignore most of the parameters, and we probably get
slouken@7191
  1269
         * !!! FIXME:  the ones we don't ignore wrong, too.
slouken@7191
  1270
         * !!! FIXME: if I had a better understanding of how the two motors
slouken@7191
  1271
         * !!! FIXME:  could be used in unison, perhaps I could implement other
slouken@7191
  1272
         * !!! FIXME:  effect types?
slouken@7191
  1273
         */
icculus@6990
  1274
        /* From MSDN:
icculus@6990
  1275
            "Note that the right motor is the high-frequency motor, the left
icculus@6990
  1276
             motor is the low-frequency motor. They do not always need to be
icculus@6990
  1277
             set to the same amount, as they provide different effects." */
icculus@6990
  1278
        XINPUT_VIBRATION *vib = &effect->hweffect->vibration;
icculus@6990
  1279
        SDL_assert(data->type == SDL_HAPTIC_SINE);
icculus@6990
  1280
        vib->wLeftMotorSpeed = vib->wRightMotorSpeed = data->periodic.magnitude * 2;
icculus@6990
  1281
        return 0;
icculus@6990
  1282
    }
icculus@6990
  1283
slouken@2713
  1284
    /* Get the effect. */
slouken@2713
  1285
    SDL_memset(&temp, 0, sizeof(DIEFFECT));
slouken@2713
  1286
    if (SDL_SYS_ToDIEFFECT(haptic, &temp, data) < 0) {
slouken@2713
  1287
        goto err_update;
slouken@2713
  1288
    }
slouken@2713
  1289
slouken@2713
  1290
    /* Set the flags.  Might be worthwhile to diff temp with loaded effect and
slouken@2713
  1291
     *  only change those parameters. */
slouken@2713
  1292
    flags = DIEP_DIRECTION |
slouken@2713
  1293
        DIEP_DURATION |
slouken@2713
  1294
        DIEP_ENVELOPE |
slouken@2713
  1295
        DIEP_STARTDELAY |
slouken@2713
  1296
        DIEP_TRIGGERBUTTON |
slouken@2713
  1297
        DIEP_TRIGGERREPEATINTERVAL | DIEP_TYPESPECIFICPARAMS;
slouken@2713
  1298
slouken@2713
  1299
    /* Create the actual effect. */
slouken@2713
  1300
    ret =
slouken@2713
  1301
        IDirectInputEffect_SetParameters(effect->hweffect->ref, &temp, flags);
slouken@2713
  1302
    if (FAILED(ret)) {
slouken@2713
  1303
        DI_SetError("Unable to update effect", ret);
slouken@2713
  1304
        goto err_update;
slouken@2713
  1305
    }
slouken@2713
  1306
slouken@2713
  1307
    /* Copy it over. */
slouken@2713
  1308
    SDL_SYS_HapticFreeDIEFFECT(&effect->hweffect->effect, data->type);
slouken@2713
  1309
    SDL_memcpy(&effect->hweffect->effect, &temp, sizeof(DIEFFECT));
slouken@2713
  1310
slouken@2713
  1311
    return 0;
slouken@2713
  1312
slouken@2713
  1313
  err_update:
slouken@2713
  1314
    SDL_SYS_HapticFreeDIEFFECT(&temp, data->type);
slouken@2713
  1315
    return -1;
slouken@2713
  1316
}
slouken@2713
  1317
slouken@2713
  1318
slouken@2713
  1319
/*
slouken@2713
  1320
 * Runs an effect.
slouken@2713
  1321
 */
slouken@2713
  1322
int
slouken@2713
  1323
SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, struct haptic_effect *effect,
slouken@2713
  1324
                        Uint32 iterations)
slouken@2713
  1325
{
slouken@2713
  1326
    HRESULT ret;
slouken@2713
  1327
    DWORD iter;
slouken@2713
  1328
icculus@6990
  1329
    if (haptic->hwdata->bXInputHaptic) {
icculus@6990
  1330
        XINPUT_VIBRATION *vib = &effect->hweffect->vibration;
icculus@6990
  1331
        return (XINPUTSETSTATE(haptic->hwdata->userid, vib) == ERROR_SUCCESS);
icculus@6990
  1332
    }
icculus@6990
  1333
slouken@2713
  1334
    /* Check if it's infinite. */
slouken@2713
  1335
    if (iterations == SDL_HAPTIC_INFINITY) {
slouken@2713
  1336
        iter = INFINITE;
slouken@2713
  1337
    } else
slouken@2713
  1338
        iter = iterations;
slouken@2713
  1339
slouken@2713
  1340
    /* Run the effect. */
slouken@2713
  1341
    ret = IDirectInputEffect_Start(effect->hweffect->ref, iter, 0);
slouken@2713
  1342
    if (FAILED(ret)) {
icculus@7037
  1343
        return DI_SetError("Running the effect", ret);
slouken@2713
  1344
    }
slouken@2713
  1345
slouken@2713
  1346
    return 0;
slouken@2713
  1347
}
slouken@2713
  1348
slouken@2713
  1349
slouken@2713
  1350
/*
slouken@2713
  1351
 * Stops an effect.
slouken@2713
  1352
 */
slouken@2713
  1353
int
slouken@2713
  1354
SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, struct haptic_effect *effect)
slouken@2713
  1355
{
slouken@2713
  1356
    HRESULT ret;
slouken@2713
  1357
icculus@6990
  1358
    if (haptic->hwdata->bXInputHaptic) {
icculus@6990
  1359
        XINPUT_VIBRATION vibration = { 0, 0 };
icculus@6990
  1360
        return (XINPUTSETSTATE(haptic->hwdata->userid, &vibration) == ERROR_SUCCESS);
icculus@6990
  1361
    }
icculus@6990
  1362
slouken@2713
  1363
    ret = IDirectInputEffect_Stop(effect->hweffect->ref);
slouken@2713
  1364
    if (FAILED(ret)) {
icculus@7037
  1365
        return DI_SetError("Unable to stop effect", ret);
slouken@2713
  1366
    }
slouken@2713
  1367
slouken@2713
  1368
    return 0;
slouken@2713
  1369
}
slouken@2713
  1370
slouken@2713
  1371
slouken@2713
  1372
/*
slouken@2713
  1373
 * Frees the effect.
slouken@2713
  1374
 */
slouken@2713
  1375
void
slouken@2713
  1376
SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, struct haptic_effect *effect)
slouken@2713
  1377
{
slouken@2713
  1378
    HRESULT ret;
slouken@2713
  1379
icculus@6990
  1380
    if (haptic->hwdata->bXInputHaptic) {
icculus@6990
  1381
        SDL_SYS_HapticStopEffect(haptic, effect);
icculus@6990
  1382
    } else {
icculus@6990
  1383
        ret = IDirectInputEffect_Unload(effect->hweffect->ref);
icculus@6990
  1384
        if (FAILED(ret)) {
icculus@6990
  1385
            DI_SetError("Removing effect from the device", ret);
icculus@6990
  1386
        }
icculus@6990
  1387
        SDL_SYS_HapticFreeDIEFFECT(&effect->hweffect->effect,
icculus@6990
  1388
                                   effect->effect.type);
slouken@2713
  1389
    }
slouken@2713
  1390
    SDL_free(effect->hweffect);
slouken@2713
  1391
    effect->hweffect = NULL;
slouken@2713
  1392
}
slouken@2713
  1393
slouken@2713
  1394
slouken@2713
  1395
/*
slouken@2713
  1396
 * Gets the status of a haptic effect.
slouken@2713
  1397
 */
slouken@2713
  1398
int
slouken@2713
  1399
SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic,
slouken@2713
  1400
                              struct haptic_effect *effect)
slouken@2713
  1401
{
slouken@2713
  1402
    HRESULT ret;
slouken@2713
  1403
    DWORD status;
slouken@2713
  1404
slouken@2713
  1405
    ret = IDirectInputEffect_GetEffectStatus(effect->hweffect->ref, &status);
slouken@2713
  1406
    if (FAILED(ret)) {
icculus@7037
  1407
        return DI_SetError("Getting effect status", ret);
slouken@2713
  1408
    }
slouken@2713
  1409
slouken@2713
  1410
    if (status == 0)
slouken@2713
  1411
        return SDL_FALSE;
slouken@2713
  1412
    return SDL_TRUE;
slouken@2713
  1413
}
slouken@2713
  1414
slouken@2713
  1415
slouken@2713
  1416
/*
slouken@2713
  1417
 * Sets the gain.
slouken@2713
  1418
 */
slouken@2713
  1419
int
slouken@2713
  1420
SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain)
slouken@2713
  1421
{
slouken@2713
  1422
    HRESULT ret;
slouken@2713
  1423
    DIPROPDWORD dipdw;
slouken@2713
  1424
slouken@2713
  1425
    /* Create the weird structure thingy. */
slouken@2713
  1426
    dipdw.diph.dwSize = sizeof(DIPROPDWORD);
slouken@2713
  1427
    dipdw.diph.dwHeaderSize = sizeof(DIPROPHEADER);
slouken@2713
  1428
    dipdw.diph.dwObj = 0;
slouken@2713
  1429
    dipdw.diph.dwHow = DIPH_DEVICE;
slouken@2713
  1430
    dipdw.dwData = gain * 100;  /* 0 to 10,000 */
slouken@2713
  1431
slouken@2713
  1432
    /* Try to set the autocenter. */
icculus@6716
  1433
    ret = IDirectInputDevice8_SetProperty(haptic->hwdata->device,
slouken@2713
  1434
                                          DIPROP_FFGAIN, &dipdw.diph);
slouken@2713
  1435
    if (FAILED(ret)) {
icculus@7037
  1436
        return DI_SetError("Setting gain", ret);
slouken@2713
  1437
    }
slouken@2713
  1438
slouken@2713
  1439
    return 0;
slouken@2713
  1440
}
slouken@2713
  1441
slouken@2713
  1442
slouken@2713
  1443
/*
slouken@2713
  1444
 * Sets the autocentering.
slouken@2713
  1445
 */
slouken@2713
  1446
int
slouken@2713
  1447
SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
slouken@2713
  1448
{
slouken@2713
  1449
    HRESULT ret;
slouken@2713
  1450
    DIPROPDWORD dipdw;
slouken@2713
  1451
slouken@2713
  1452
    /* Create the weird structure thingy. */
slouken@2713
  1453
    dipdw.diph.dwSize = sizeof(DIPROPDWORD);
slouken@2713
  1454
    dipdw.diph.dwHeaderSize = sizeof(DIPROPHEADER);
slouken@2713
  1455
    dipdw.diph.dwObj = 0;
slouken@2713
  1456
    dipdw.diph.dwHow = DIPH_DEVICE;
slouken@2713
  1457
    dipdw.dwData = (autocenter == 0) ? DIPROPAUTOCENTER_OFF :
slouken@2713
  1458
        DIPROPAUTOCENTER_ON;
slouken@2713
  1459
slouken@2713
  1460
    /* Try to set the autocenter. */
icculus@6716
  1461
    ret = IDirectInputDevice8_SetProperty(haptic->hwdata->device,
slouken@2713
  1462
                                          DIPROP_AUTOCENTER, &dipdw.diph);
slouken@2713
  1463
    if (FAILED(ret)) {
icculus@7037
  1464
        return DI_SetError("Setting autocenter", ret);
slouken@2713
  1465
    }
slouken@2713
  1466
slouken@2713
  1467
    return 0;
slouken@2713
  1468
}
slouken@2713
  1469
slouken@2713
  1470
slouken@2713
  1471
/*
slouken@2713
  1472
 * Pauses the device.
slouken@2713
  1473
 */
slouken@2713
  1474
int
slouken@2713
  1475
SDL_SYS_HapticPause(SDL_Haptic * haptic)
slouken@2713
  1476
{
slouken@2713
  1477
    HRESULT ret;
slouken@2713
  1478
slouken@2713
  1479
    /* Pause the device. */
icculus@6716
  1480
    ret = IDirectInputDevice8_SendForceFeedbackCommand(haptic->hwdata->device,
slouken@2713
  1481
                                                       DISFFC_PAUSE);
slouken@2713
  1482
    if (FAILED(ret)) {
icculus@7037
  1483
        return DI_SetError("Pausing the device", ret);
slouken@2713
  1484
    }
slouken@2713
  1485
slouken@2713
  1486
    return 0;
slouken@2713
  1487
}
slouken@2713
  1488
slouken@2713
  1489
slouken@2713
  1490
/*
slouken@2713
  1491
 * Pauses the device.
slouken@2713
  1492
 */
slouken@2713
  1493
int
slouken@2713
  1494
SDL_SYS_HapticUnpause(SDL_Haptic * haptic)
slouken@2713
  1495
{
slouken@2713
  1496
    HRESULT ret;
slouken@2713
  1497
slouken@2713
  1498
    /* Unpause the device. */
icculus@6716
  1499
    ret = IDirectInputDevice8_SendForceFeedbackCommand(haptic->hwdata->device,
slouken@2713
  1500
                                                       DISFFC_CONTINUE);
slouken@2713
  1501
    if (FAILED(ret)) {
icculus@7037
  1502
        return DI_SetError("Pausing the device", ret);
slouken@2713
  1503
    }
slouken@2713
  1504
slouken@2713
  1505
    return 0;
slouken@2713
  1506
}
slouken@2713
  1507
slouken@2713
  1508
slouken@2713
  1509
/*
slouken@2713
  1510
 * Stops all the playing effects on the device.
slouken@2713
  1511
 */
slouken@2713
  1512
int
bobbens@2715
  1513
SDL_SYS_HapticStopAll(SDL_Haptic * haptic)
slouken@2713
  1514
{
slouken@2713
  1515
    HRESULT ret;
slouken@2713
  1516
icculus@6990
  1517
    if (haptic->hwdata->bXInputHaptic) {
icculus@6990
  1518
        XINPUT_VIBRATION vibration = { 0, 0 };
icculus@6990
  1519
        return (XINPUTSETSTATE(haptic->hwdata->userid, &vibration) == ERROR_SUCCESS);
icculus@6990
  1520
    }
icculus@6990
  1521
slouken@2713
  1522
    /* Try to stop the effects. */
icculus@6716
  1523
    ret = IDirectInputDevice8_SendForceFeedbackCommand(haptic->hwdata->device,
slouken@2713
  1524
                                                       DISFFC_STOPALL);
slouken@2713
  1525
    if (FAILED(ret)) {
icculus@7037
  1526
        return DI_SetError("Stopping the device", ret);
slouken@2713
  1527
    }
slouken@2713
  1528
slouken@2713
  1529
    return 0;
slouken@2713
  1530
}
slouken@2713
  1531
slouken@7191
  1532
#endif /* SDL_HAPTIC_DINPUT */
slouken@2713
  1533
slouken@7191
  1534
/* vi: set ts=4 sw=4 expandtab: */