src/haptic/darwin/SDL_syshaptic.c
author Edgar Simo <bobbens@gmail.com>
Fri, 18 Jul 2008 08:03:24 +0000
branchgsoc2008_force_feedback
changeset 2527 924a32719b6f
parent 2522 0877146be013
child 2528 50414589501e
permissions -rw-r--r--
Handle axes for darwin now.
Support for periodic effect sort of.
More cleaning up.
bobbens@2520
     1
/*
bobbens@2520
     2
    SDL - Simple DirectMedia Layer
bobbens@2520
     3
    Copyright (C) 2008 Edgar Simo
bobbens@2520
     4
bobbens@2520
     5
    This library is free software; you can redistribute it and/or
bobbens@2520
     6
    modify it under the terms of the GNU Lesser General Public
bobbens@2520
     7
    License as published by the Free Software Foundation; either
bobbens@2520
     8
    version 2.1 of the License, or (at your option) any later version.
bobbens@2520
     9
bobbens@2520
    10
    This library is distributed in the hope that it will be useful,
bobbens@2520
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
bobbens@2520
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
bobbens@2520
    13
    Lesser General Public License for more details.
bobbens@2520
    14
bobbens@2520
    15
    You should have received a copy of the GNU Lesser General Public
bobbens@2520
    16
    License along with this library; if not, write to the Free Software
bobbens@2520
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
bobbens@2520
    18
bobbens@2520
    19
    Sam Lantinga
bobbens@2520
    20
    slouken@libsdl.org
bobbens@2520
    21
*/
bobbens@2520
    22
#include "SDL_config.h"
bobbens@2520
    23
bobbens@2520
    24
#ifdef SDL_HAPTIC_IOKIT
bobbens@2520
    25
bobbens@2520
    26
#include "SDL_haptic.h"
bobbens@2520
    27
#include "../SDL_syshaptic.h"
bobbens@2520
    28
#include "SDL_joystick.h"
bobbens@2520
    29
#include "../../joystick/SDL_sysjoystick.h" /* For the real SDL_Joystick */
bobbens@2520
    30
/*#include "../../joystick/dawrin/SDL_sysjoystick_c.h"*/ /* For joystick hwdata */ 
bobbens@2520
    31
bobbens@2522
    32
#include <IOKit/IOKitLib.h>
bobbens@2522
    33
#include <IOKit/hid/IOHIDKeys.h>
bobbens@2520
    34
#include <ForceFeedback/ForceFeedback.h>
bobbens@2520
    35
#include <ForceFeedback/ForceFeedbackConstants.h>
bobbens@2520
    36
bobbens@2520
    37
bobbens@2520
    38
#define MAX_HAPTICS  32
bobbens@2520
    39
bobbens@2520
    40
bobbens@2520
    41
/*
bobbens@2520
    42
 * List of available haptic devices.
bobbens@2520
    43
 */
bobbens@2520
    44
static struct
bobbens@2520
    45
{
bobbens@2520
    46
   io_service_t dev;
bobbens@2520
    47
   SDL_Haptic *haptic;
bobbens@2520
    48
} SDL_hapticlist[MAX_HAPTICS];
bobbens@2520
    49
bobbens@2520
    50
bobbens@2520
    51
/*
bobbens@2520
    52
 * Haptic system hardware data.
bobbens@2520
    53
 */
bobbens@2520
    54
struct haptic_hwdata
bobbens@2520
    55
{
bobbens@2520
    56
   FFDeviceObjectReference device; /* Hardware device. */
bobbens@2520
    57
};
bobbens@2520
    58
bobbens@2520
    59
bobbens@2520
    60
/*
bobbens@2520
    61
 * Haptic system effect data.
bobbens@2520
    62
 */
bobbens@2520
    63
struct haptic_hweffect
bobbens@2520
    64
{
bobbens@2520
    65
   FFEffectObjectReference ref; /* Reference. */
bobbens@2520
    66
   struct FFEFFECT effect; /* Hardware effect. */
bobbens@2520
    67
};
bobbens@2520
    68
bobbens@2520
    69
bobbens@2520
    70
/*
bobbens@2520
    71
 * Initializes the haptic subsystem.
bobbens@2520
    72
 */
bobbens@2520
    73
int
bobbens@2520
    74
SDL_SYS_HapticInit(void)
bobbens@2520
    75
{
bobbens@2520
    76
   int numhaptics;
bobbens@2520
    77
   IOReturn result;
bobbens@2520
    78
   io_iterator_t iter;
bobbens@2520
    79
   CFDictionaryRef match;
bobbens@2521
    80
   io_service_t device;
bobbens@2520
    81
bobbens@2520
    82
   /* Get HID devices. */
bobbens@2520
    83
   match = IOServiceMatching(kIOHIDDeviceKey);
bobbens@2520
    84
   if (match == NULL) {
bobbens@2520
    85
      SDL_SetError("Haptic: Failed to get IOServiceMatching.");
bobbens@2520
    86
      return -1;
bobbens@2520
    87
   }
bobbens@2520
    88
bobbens@2520
    89
   /* Now search I/O Registry for matching devices. */
bobbens@2520
    90
   result = IOServiceGetMatchingServices(kIOMasterPortDefault, match, &iter);
bobbens@2520
    91
   if (result != kIOReturnSuccess) {
bobbens@2520
    92
      SDL_SetError("Haptic: Couldn't create a HID object iterator.");
bobbens@2520
    93
      return -1;
bobbens@2520
    94
   }
bobbens@2520
    95
   /* IOServiceGetMatchingServices consumes dictionary. */
bobbens@2520
    96
bobbens@2520
    97
   numhaptics = 0;
bobbens@2520
    98
   while ((device = IOIteratorNext(iter)) != IO_OBJECT_NULL) {
bobbens@2520
    99
bobbens@2520
   100
      /* Check for force feedback. */
bobbens@2520
   101
      if (FFIsForceFeedback(device) == FF_OK) {
bobbens@2520
   102
         SDL_hapticlist[numhaptics].dev = device;
bobbens@2520
   103
         SDL_hapticlist[numhaptics].haptic = NULL;
bobbens@2520
   104
         numhaptics++;
bobbens@2520
   105
      }
bobbens@2520
   106
bobbens@2520
   107
      /* Reached haptic limit. */
bobbens@2520
   108
      if (numhaptics >= MAX_HAPTICS)
bobbens@2520
   109
         break;
bobbens@2520
   110
   }
bobbens@2520
   111
   IOObjectRelease(iter);
bobbens@2520
   112
bobbens@2520
   113
   return numhaptics;
bobbens@2520
   114
}
bobbens@2520
   115
bobbens@2520
   116
bobbens@2520
   117
/*
bobbens@2520
   118
 * Return the name of a haptic device, does not need to be opened.
bobbens@2520
   119
 */
bobbens@2520
   120
const char *
bobbens@2520
   121
SDL_SYS_HapticName(int index)
bobbens@2520
   122
{
bobbens@2520
   123
   return NULL;
bobbens@2520
   124
}
bobbens@2520
   125
bobbens@2520
   126
bobbens@2520
   127
#define FF_TEST(ff, s) \
bobbens@2520
   128
if (features.supportedEffects & ff) supported |= s
bobbens@2520
   129
/*
bobbens@2520
   130
 * Gets supported features.
bobbens@2520
   131
 */
bobbens@2520
   132
static unsigned int
bobbens@2520
   133
GetSupportedFeatures(FFDeviceObjectReference device,
bobbens@2527
   134
                     int *neffects, int *nplaying, int *naxes)
bobbens@2520
   135
{
bobbens@2520
   136
   HRESULT ret;
bobbens@2520
   137
   FFCAPABILITIES features;
bobbens@2520
   138
   unsigned int supported;
bobbens@2520
   139
   Uint32 val;
bobbens@2520
   140
bobbens@2520
   141
   ret = FFDeviceGetForceFeedbackCapabilities(device, &features);
bobbens@2520
   142
   if (ret != FF_OK) {
bobbens@2520
   143
      SDL_SetError("Haptic: Unable to get device's supported features.");
bobbens@2520
   144
      return 0;
bobbens@2520
   145
   }
bobbens@2520
   146
bobbens@2520
   147
   supported = 0;
bobbens@2520
   148
bobbens@2520
   149
   /* Get maximum effects. */
bobbens@2520
   150
   *neffects = features.storageCapacity;
bobbens@2520
   151
   *nplaying = features.playbackCapacity;
bobbens@2520
   152
bobbens@2520
   153
   /* Test for effects. */
bobbens@2520
   154
   FF_TEST(FFCAP_ET_CONSTANTFORCE, SDL_HAPTIC_CONSTANT);
bobbens@2520
   155
   FF_TEST(FFCAP_ET_RAMPFORCE,     SDL_HAPTIC_RAMP);
bobbens@2520
   156
   FF_TEST(FFCAP_ET_SQUARE,        SDL_HAPTIC_SQUARE);
bobbens@2520
   157
   FF_TEST(FFCAP_ET_SINE,          SDL_HAPTIC_SINE);
bobbens@2520
   158
   FF_TEST(FFCAP_ET_TRIANGLE,      SDL_HAPTIC_TRIANGLE);
bobbens@2520
   159
   FF_TEST(FFCAP_ET_SAWTOOTHUP,    SDL_HAPTIC_SAWTOOTHUP);
bobbens@2520
   160
   FF_TEST(FFCAP_ET_SAWTOOTHDOWN,  SDL_HAPTIC_SAWTOOTHDOWN);
bobbens@2520
   161
   FF_TEST(FFCAP_ET_SPRING,        SDL_HAPTIC_SPRING);
bobbens@2520
   162
   FF_TEST(FFCAP_ET_DAMPER,        SDL_HAPTIC_DAMPER);
bobbens@2520
   163
   FF_TEST(FFCAP_ET_INERTIA,       SDL_HAPTIC_INERTIA);
bobbens@2520
   164
   FF_TEST(FFCAP_ET_FRICTION,      SDL_HAPTIC_FRICTION);
bobbens@2520
   165
   FF_TEST(FFCAP_ET_CUSTOMFORCE,   SDL_HAPTIC_CUSTOM);
bobbens@2520
   166
bobbens@2520
   167
   /* Check if supports gain. */
bobbens@2520
   168
   ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_FFGAIN,
bobbens@2522
   169
                                          &val, sizeof(val));
bobbens@2520
   170
   if (ret == FF_OK) supported |= SDL_HAPTIC_GAIN;
bobbens@2520
   171
   else if (ret != FFERR_UNSUPPORTED) {
bobbens@2520
   172
      SDL_SetError("Haptic: Unable to get if device supports gain.");
bobbens@2520
   173
      return 0;
bobbens@2520
   174
   }
bobbens@2520
   175
bobbens@2520
   176
   /* Checks if supports autocenter. */
bobbens@2521
   177
   ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_AUTOCENTER,
bobbens@2522
   178
                                          &val, sizeof(val));
bobbens@2520
   179
   if (ret == FF_OK) supported |= SDL_HAPTIC_AUTOCENTER;
bobbens@2520
   180
   else if (ret != FFERR_UNSUPPORTED) {
bobbens@2520
   181
      SDL_SetError("Haptic: Unable to get if device supports autocenter.");
bobbens@2520
   182
      return 0;
bobbens@2520
   183
   }
bobbens@2520
   184
bobbens@2527
   185
   /* Check for axes, we have an artificial limit on axes */
bobbens@2527
   186
   *axes = ((features.numFfAxes) > 3) ?
bobbens@2527
   187
         3 : features.numFfAxes;
bobbens@2527
   188
bobbens@2520
   189
   /* Always supported features. */
bobbens@2520
   190
   supported |= SDL_HAPTIC_STATUS;
bobbens@2520
   191
   return supported;
bobbens@2520
   192
}
bobbens@2520
   193
bobbens@2520
   194
bobbens@2520
   195
/*
bobbens@2520
   196
 * Opens the haptic device from the file descriptor.
bobbens@2520
   197
 */
bobbens@2520
   198
static int
bobbens@2520
   199
SDL_SYS_HapticOpenFromService(SDL_Haptic * haptic, io_service_t service)
bobbens@2520
   200
{
bobbens@2520
   201
   /* Allocate the hwdata */
bobbens@2520
   202
   haptic->hwdata = (struct haptic_hwdata *)
bobbens@2520
   203
         SDL_malloc(sizeof(*haptic->hwdata));
bobbens@2520
   204
   if (haptic->hwdata == NULL) {
bobbens@2520
   205
      SDL_OutOfMemory();
bobbens@2520
   206
      goto creat_err;
bobbens@2520
   207
   }
bobbens@2520
   208
   SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
bobbens@2520
   209
  
bobbens@2520
   210
   /* Open the device */
bobbens@2522
   211
   if (FFCreateDevice( service, &haptic->hwdata->device ) != FF_OK) {
bobbens@2520
   212
      SDL_SetError("Haptic: Unable to create device from service.");
bobbens@2520
   213
      goto creat_err;
bobbens@2520
   214
   }
bobbens@2520
   215
bobbens@2520
   216
   /* Get supported features. */
bobbens@2520
   217
   haptic->supported = GetSupportedFeatures(haptic->hwdata->device,
bobbens@2527
   218
                                            &haptic->neffects, &haptic->nplaying,
bobbens@2527
   219
                                            &haptic->naxes);
bobbens@2520
   220
   if (haptic->supported == 0) { /* Error since device supports nothing. */
bobbens@2520
   221
      goto open_err;
bobbens@2520
   222
   }
bobbens@2520
   223
   haptic->effects = (struct haptic_effect *)
bobbens@2520
   224
         SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
bobbens@2520
   225
   if (haptic->effects == NULL) {
bobbens@2520
   226
      SDL_OutOfMemory();
bobbens@2520
   227
      goto open_err;
bobbens@2520
   228
   }
bobbens@2520
   229
   /* Clear the memory */
bobbens@2520
   230
   SDL_memset(haptic->effects, 0,
bobbens@2520
   231
         sizeof(struct haptic_effect) * haptic->neffects);
bobbens@2520
   232
   
bobbens@2520
   233
   return 0;
bobbens@2520
   234
   
bobbens@2520
   235
   /* Error handling */
bobbens@2520
   236
open_err:
bobbens@2520
   237
   FFReleaseDevice(haptic->hwdata->device);
bobbens@2520
   238
creat_err:
bobbens@2520
   239
   if (haptic->hwdata != NULL) {
bobbens@2520
   240
      free(haptic->hwdata);
bobbens@2520
   241
      haptic->hwdata = NULL;                                              
bobbens@2520
   242
   }
bobbens@2520
   243
   return -1;
bobbens@2520
   244
bobbens@2520
   245
}
bobbens@2520
   246
bobbens@2520
   247
bobbens@2520
   248
/*
bobbens@2520
   249
 * Opens a haptic device for usage.
bobbens@2520
   250
 */
bobbens@2520
   251
int
bobbens@2520
   252
SDL_SYS_HapticOpen(SDL_Haptic * haptic)
bobbens@2520
   253
{
bobbens@2520
   254
   return SDL_SYS_HapticOpenFromService(haptic,
bobbens@2522
   255
                SDL_hapticlist[haptic->index].dev);
bobbens@2520
   256
}
bobbens@2520
   257
bobbens@2520
   258
bobbens@2520
   259
/*
bobbens@2520
   260
 * Opens a haptic device from first mouse it finds for usage.
bobbens@2520
   261
 */
bobbens@2520
   262
int
bobbens@2520
   263
SDL_SYS_HapticMouse(void)
bobbens@2520
   264
{
bobbens@2520
   265
   return -1;
bobbens@2520
   266
}
bobbens@2520
   267
bobbens@2520
   268
bobbens@2520
   269
/*
bobbens@2520
   270
 * Checks to see if a joystick has haptic features.
bobbens@2520
   271
 */
bobbens@2520
   272
int
bobbens@2520
   273
SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick)
bobbens@2520
   274
{
bobbens@2520
   275
   return SDL_FALSE;
bobbens@2520
   276
}
bobbens@2520
   277
bobbens@2520
   278
bobbens@2520
   279
/*
bobbens@2520
   280
 * Checks to see if the haptic device and joystick and in reality the same.
bobbens@2520
   281
 */
bobbens@2520
   282
int
bobbens@2520
   283
SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, SDL_Joystick * joystick)
bobbens@2520
   284
{
bobbens@2520
   285
   if (SDL_strcmp(joystick->name,haptic->name)==0) {
bobbens@2520
   286
      return 1;
bobbens@2520
   287
   }
bobbens@2520
   288
   return 0;
bobbens@2520
   289
}
bobbens@2520
   290
bobbens@2520
   291
bobbens@2520
   292
/*
bobbens@2520
   293
 * Opens a SDL_Haptic from a SDL_Joystick.
bobbens@2520
   294
 */
bobbens@2520
   295
int
bobbens@2520
   296
SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, SDL_Joystick * joystick)
bobbens@2520
   297
{
bobbens@2520
   298
   return -1;
bobbens@2520
   299
}
bobbens@2520
   300
bobbens@2520
   301
bobbens@2520
   302
/*
bobbens@2520
   303
 * Closes the haptic device.
bobbens@2520
   304
 */
bobbens@2520
   305
void
bobbens@2520
   306
SDL_SYS_HapticClose(SDL_Haptic * haptic)
bobbens@2520
   307
{
bobbens@2520
   308
   int i;
bobbens@2520
   309
bobbens@2520
   310
   if (haptic->hwdata) {
bobbens@2520
   311
bobbens@2520
   312
      /* Clean up */
bobbens@2520
   313
      FFReleaseDevice(haptic->hwdata->device);
bobbens@2520
   314
bobbens@2520
   315
      /* Free */
bobbens@2520
   316
      SDL_free(haptic->hwdata);
bobbens@2520
   317
      haptic->hwdata = NULL;
bobbens@2520
   318
      for (i=0; i<haptic->neffects; i++) {
bobbens@2520
   319
         if (haptic->effects[i].hweffect != NULL)
bobbens@2520
   320
            SDL_free(haptic->effects[i].hweffect->effect.lpvTypeSpecificParams);
bobbens@2520
   321
      }
bobbens@2520
   322
      SDL_free(haptic->effects);
bobbens@2520
   323
      haptic->neffects = 0;
bobbens@2520
   324
   }
bobbens@2520
   325
}
bobbens@2520
   326
bobbens@2520
   327
bobbens@2520
   328
/* 
bobbens@2520
   329
 * Clean up after system specific haptic stuff
bobbens@2520
   330
 */
bobbens@2520
   331
void
bobbens@2520
   332
SDL_SYS_HapticQuit(void)
bobbens@2520
   333
{
bobbens@2520
   334
   int i;
bobbens@2520
   335
bobbens@2520
   336
   for (i=0; i < SDL_numhaptics; i++) {
bobbens@2520
   337
      IOObjectRelease(SDL_hapticlist[i].dev);
bobbens@2520
   338
      /* TODO free effects. */
bobbens@2520
   339
   }
bobbens@2520
   340
}
bobbens@2520
   341
bobbens@2520
   342
bobbens@2520
   343
/*
bobbens@2520
   344
 * Sets the direction.
bobbens@2520
   345
 */
bobbens@2520
   346
static int
bobbens@2520
   347
SDL_SYS_SetDirection( FFEFFECT * effect, SDL_HapticDirection *dir, int axes )
bobbens@2520
   348
{
bobbens@2521
   349
   LONG *rglDir;
bobbens@2527
   350
bobbens@2527
   351
   /* Handle no axes a part. */
bobbens@2527
   352
   if (dest->cAxes == 0) {
bobbens@2527
   353
      effect->rglDirection = NULL;
bobbens@2527
   354
      return 0;
bobbens@2527
   355
   }
bobbens@2527
   356
bobbens@2527
   357
   /* Has axes. */
bobbens@2527
   358
   rglDir = SDL_malloc( sizeof(LONG) * axes );
bobbens@2527
   359
   if (rglDir == NULL) {
bobbens@2520
   360
      SDL_OutOfMemory();
bobbens@2520
   361
      return -1;
bobbens@2520
   362
   }
bobbens@2527
   363
   SDL_memset( rglDir, 0, sizeof(LONG) * axes );
bobbens@2521
   364
   effect->rglDirection = rglDir;
bobbens@2520
   365
bobbens@2520
   366
   switch (dir->type) {
bobbens@2520
   367
      case SDL_HAPTIC_POLAR:
bobbens@2520
   368
         effect->dwFlags |= FFEFF_POLAR;
bobbens@2521
   369
         rglDir[0] = dir->dir[0];
bobbens@2520
   370
         return 0;
bobbens@2520
   371
      case SDL_HAPTIC_CARTESIAN:
bobbens@2522
   372
         effect->dwFlags |= FFEFF_CARTESIAN;
bobbens@2521
   373
         rglDir[0] = dir->dir[0];
bobbens@2521
   374
         rglDir[1] = dir->dir[1];
bobbens@2521
   375
         rglDir[2] = dir->dir[2];
bobbens@2520
   376
         return 0;
bobbens@2521
   377
      case SDL_HAPTIC_SPHERICAL:
bobbens@2522
   378
         effect->dwFlags |= FFEFF_SPHERICAL;
bobbens@2521
   379
         rglDir[0] = dir->dir[0];
bobbens@2521
   380
         rglDir[1] = dir->dir[1];
bobbens@2521
   381
         rglDir[2] = dir->dir[2];
bobbens@2520
   382
         return 0;
bobbens@2520
   383
bobbens@2520
   384
      default:
bobbens@2520
   385
         SDL_SetError("Haptic: Unknown direction type.");
bobbens@2520
   386
         return -1;
bobbens@2520
   387
   }
bobbens@2520
   388
}
bobbens@2520
   389
bobbens@2520
   390
#define CONVERT(x)   (((x)*10000) / 0xFFFF )
bobbens@2520
   391
/*
bobbens@2527
   392
 * Creates the FFEFFECT from a SDL_HapticEffect.
bobbens@2520
   393
 */
bobbens@2520
   394
static int
bobbens@2527
   395
SDL_SYS_ToFFEFFECT( SDL_Haptic * haptic, FFEFFECT * dest, SDL_HapticEffect * src )
bobbens@2520
   396
{
bobbens@2520
   397
   FFCONSTANTFORCE *constant;
bobbens@2520
   398
   FFPERIODIC *periodic;
bobbens@2520
   399
   FFCONDITION *condition;
bobbens@2520
   400
   FFRAMPFORCE *ramp;
bobbens@2520
   401
   FFCUSTOMFORCE *custom;
bobbens@2522
   402
   FFENVELOPE *envelope;
bobbens@2520
   403
   SDL_HapticConstant *hap_constant;
bobbens@2521
   404
   SDL_HapticPeriodic *hap_periodic;
bobbens@2520
   405
   SDL_HapticCondition *hap_condition;
bobbens@2520
   406
   SDL_HapticRamp *hap_ramp;
bobbens@2527
   407
   DWORD *axes;
bobbens@2520
   408
bobbens@2520
   409
   /* Set global stuff. */
bobbens@2520
   410
   SDL_memset(dest, 0, sizeof(FFEFFECT));
bobbens@2520
   411
   dest->dwSize = sizeof(FFEFFECT); /* Set the structure size. */
bobbens@2520
   412
   dest->dwSamplePeriod = 0; /* Not used by us. */
bobbens@2520
   413
   dest->dwGain = 10000; /* Gain is set globally, not locally. */
bobbens@2522
   414
bobbens@2522
   415
   /* Envelope. */
bobbens@2522
   416
   envelope = SDL_malloc( sizeof(FFENVELOPE) );
bobbens@2522
   417
   if (envelope == NULL) {
bobbens@2522
   418
      SDL_OutOfMemory();
bobbens@2522
   419
      return -1;
bobbens@2522
   420
   }
bobbens@2522
   421
   SDL_memset(envelope, 0, sizeof(FFENVELOPE));
bobbens@2522
   422
   dest->lpEnvelope = envelope;
bobbens@2522
   423
   envelope->dwSize = sizeof(FFENVELOPE); /* Always should be this. */
bobbens@2520
   424
bobbens@2527
   425
   /* Axes. */
bobbens@2527
   426
   dest->cAxes = haptic->naxes;
bobbens@2527
   427
   if (dest->cAxes > 0) {
bobbens@2527
   428
      axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
bobbens@2527
   429
      if (axes == NULL) {
bobbens@2527
   430
         SDL_OutOfMemory();
bobbens@2527
   431
         return -1;
bobbens@2527
   432
      }
bobbens@2527
   433
      axes[0] = FFJOFS_X; /* Always at least one axis. */
bobbens@2527
   434
      if (dest->cAxes > 1) {
bobbens@2527
   435
         axes[1] = FFJOFS_Y;
bobbens@2527
   436
      }
bobbens@2527
   437
      if (dest->cAxes > 2) {
bobbens@2527
   438
         axes[2] = FFJOFS_Z;
bobbens@2527
   439
      }
bobbens@2527
   440
      dest->rgdwAxes = axes;
bobbens@2527
   441
   }
bobbens@2527
   442
bobbens@2527
   443
bobbens@2520
   444
   switch (src->type) {
bobbens@2520
   445
      case SDL_HAPTIC_CONSTANT:
bobbens@2520
   446
         hap_constant = &src->constant;
bobbens@2520
   447
         constant = SDL_malloc( sizeof(FFCONSTANTFORCE) );
bobbens@2527
   448
         if (constant == NULL) {
bobbens@2527
   449
            SDL_OutOfMemory();
bobbens@2527
   450
            return -1;
bobbens@2527
   451
         }
bobbens@2520
   452
bobbens@2520
   453
         /* Specifics */
bobbens@2520
   454
         constant->lMagnitude = CONVERT(hap_constant->level);
bobbens@2520
   455
         dest->cbTypeSpecificParams = sizeof(FFCONSTANTFORCE); 
bobbens@2520
   456
         dest->lpvTypeSpecificParams = constant;
bobbens@2520
   457
bobbens@2520
   458
         /* Generics */
bobbens@2521
   459
         dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
bobbens@2520
   460
         dest->dwTriggerButton = FFJOFS_BUTTON(hap_constant->button);
bobbens@2520
   461
         dest->dwTriggerRepeatInterval = hap_constant->interval;
bobbens@2521
   462
         dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
bobbens@2520
   463
bobbens@2520
   464
         /* Direction. */
bobbens@2522
   465
         if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
bobbens@2520
   466
            return -1;
bobbens@2520
   467
         }
bobbens@2520
   468
         
bobbens@2520
   469
         /* Envelope */
bobbens@2522
   470
         envelope->dwAttackLevel = CONVERT(hap_constant->attack_level);
bobbens@2522
   471
         envelope->dwAttackTime = hap_constant->attack_length * 1000;
bobbens@2522
   472
         envelope->dwFadeLevel = CONVERT(hap_constant->fade_level);
bobbens@2522
   473
         envelope->dwFadeTime = hap_constant->fade_length * 1000;
bobbens@2520
   474
bobbens@2520
   475
         break;
bobbens@2520
   476
bobbens@2520
   477
      case SDL_HAPTIC_SINE:
bobbens@2520
   478
      case SDL_HAPTIC_SQUARE:
bobbens@2520
   479
      case SDL_HAPTIC_TRIANGLE:
bobbens@2520
   480
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2520
   481
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2522
   482
         hap_periodic = &src->periodic;
bobbens@2527
   483
         periodic = SDL_malloc(sizeof(FFPERIODIC));
bobbens@2527
   484
         if (periodic == NULL) {
bobbens@2527
   485
            SDL_OutOfMemory();
bobbens@2527
   486
            return -1;
bobbens@2527
   487
         }
bobbens@2527
   488
bobbens@2527
   489
         /* Specifics */
bobbens@2527
   490
         periodic->dwMagnitude = CONVERT(hap_periodic->magnitude);
bobbens@2527
   491
         periodic->lOffset = CONVERT(hap_periodic->offset);
bobbens@2527
   492
         periodic->dwPhase = hap_periodic->phase;
bobbens@2527
   493
         periodic->dwPeriod = hap_periodic->period * 1000;
bobbens@2527
   494
         dest->cbTypeSpecificParams = sizeof(FFPERIODIC);
bobbens@2527
   495
         dest->lpvTypeSpecificParams = periodic;
bobbens@2527
   496
bobbens@2527
   497
         /* Generics */
bobbens@2527
   498
         dest->dwDuration = hap_periodic->length * 1000; /* In microseconds. */
bobbens@2527
   499
         dest->dwTriggerButton = FFJOFS_BUTTON(hap_periodic->button);
bobbens@2527
   500
         dest->dwTriggerRepeatInterval = hap_periodic->interval;
bobbens@2527
   501
         dest->dwStartDelay = hap_periodic->delay * 1000; /* In microseconds. */
bobbens@2527
   502
         
bobbens@2527
   503
         /* Direction. */
bobbens@2527
   504
         if (SDL_SYS_SetDirection(dest, &hap_periodic->direction, dest->cAxes) < 0) {
bobbens@2527
   505
            return -1;
bobbens@2527
   506
         }
bobbens@2527
   507
         
bobbens@2527
   508
         /* Envelope */
bobbens@2527
   509
         envelope->dwAttackLevel = CONVERT(hap_periodic->attack_level);
bobbens@2527
   510
         envelope->dwAttackTime = hap_periodic->attack_length * 1000;
bobbens@2527
   511
         envelope->dwFadeLevel = CONVERT(hap_periodic->fade_level);
bobbens@2527
   512
         envelope->dwFadeTime = hap_periodic->fade_length * 1000;
bobbens@2520
   513
bobbens@2520
   514
         break;
bobbens@2520
   515
bobbens@2520
   516
      case SDL_HAPTIC_SPRING:
bobbens@2520
   517
      case SDL_HAPTIC_DAMPER:
bobbens@2520
   518
      case SDL_HAPTIC_INERTIA:
bobbens@2520
   519
      case SDL_HAPTIC_FRICTION:
bobbens@2522
   520
         hap_condition = &src->condition;
bobbens@2520
   521
bobbens@2520
   522
         break;
bobbens@2520
   523
bobbens@2520
   524
      case SDL_HAPTIC_RAMP:
bobbens@2522
   525
         hap_ramp = &src->ramp;
bobbens@2520
   526
bobbens@2520
   527
         break;
bobbens@2520
   528
bobbens@2520
   529
bobbens@2520
   530
      default:
bobbens@2520
   531
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2520
   532
         return -1;
bobbens@2520
   533
   }
bobbens@2520
   534
bobbens@2520
   535
   return 0;
bobbens@2520
   536
}
bobbens@2520
   537
bobbens@2520
   538
bobbens@2520
   539
/*
bobbens@2527
   540
 * Frees an FFEFFECT allocated by SDL_SYS_ToFFEFFECT.
bobbens@2527
   541
 */
bobbens@2527
   542
void SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect )
bobbens@2527
   543
{
bobbens@2527
   544
   if (effect->lpEnvelope != NULL) {
bobbens@2527
   545
      SDL_free(effect->lpEnvelope);
bobbens@2527
   546
      effect->lpEnvelope = NULL;
bobbens@2527
   547
   }
bobbens@2527
   548
   if (effect->rgdwAxes != NULL) {
bobbens@2527
   549
      SDL_free(effect->rgdwAxes);
bobbens@2527
   550
      effect->rgdwAxes = NULL;
bobbens@2527
   551
   }
bobbens@2527
   552
   if (effect->lpvTypeSpecificParams != NULL) {
bobbens@2527
   553
      SDL_free(effect->lpvTypeSpecificParams);
bobbens@2527
   554
      effect->lpvTypeSpecificParams = NULL;
bobbens@2527
   555
   }
bobbens@2527
   556
   if (effect->rglDirection != NULL) {
bobbens@2527
   557
      SDL_free(effect->rglDirection);
bobbens@2527
   558
      effect->rglDirection = NULL;
bobbens@2527
   559
   }
bobbens@2527
   560
}
bobbens@2527
   561
bobbens@2527
   562
bobbens@2527
   563
/*
bobbens@2520
   564
 * Gets the effect type from the generic SDL haptic effect wrapper.
bobbens@2520
   565
 */
bobbens@2520
   566
CFUUIDRef SDL_SYS_HapticEffectType(struct haptic_effect * effect)
bobbens@2520
   567
{
bobbens@2521
   568
   switch (effect->effect.type) {
bobbens@2520
   569
      case SDL_HAPTIC_CONSTANT:
bobbens@2520
   570
         return kFFEffectType_ConstantForce_ID;
bobbens@2520
   571
bobbens@2520
   572
      case SDL_HAPTIC_RAMP:
bobbens@2520
   573
         return kFFEffectType_RampForce_ID;
bobbens@2520
   574
bobbens@2520
   575
      case SDL_HAPTIC_SQUARE:
bobbens@2520
   576
         return kFFEffectType_Square_ID;
bobbens@2520
   577
bobbens@2520
   578
      case SDL_HAPTIC_SINE:
bobbens@2520
   579
         return kFFEffectType_Sine_ID;
bobbens@2520
   580
bobbens@2521
   581
      case SDL_HAPTIC_TRIANGLE:
bobbens@2520
   582
         return kFFEffectType_Triangle_ID;
bobbens@2520
   583
bobbens@2520
   584
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2520
   585
         return kFFEffectType_SawtoothUp_ID;
bobbens@2520
   586
bobbens@2520
   587
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2520
   588
         return kFFEffectType_SawtoothDown_ID;
bobbens@2520
   589
bobbens@2520
   590
      case SDL_HAPTIC_SPRING:
bobbens@2520
   591
         return kFFEffectType_Spring_ID;
bobbens@2520
   592
bobbens@2520
   593
      case SDL_HAPTIC_DAMPER:
bobbens@2520
   594
         return kFFEffectType_Damper_ID;
bobbens@2520
   595
bobbens@2520
   596
      case SDL_HAPTIC_INERTIA:
bobbens@2520
   597
         return kFFEffectType_Inertia_ID;
bobbens@2520
   598
bobbens@2520
   599
      case SDL_HAPTIC_FRICTION:
bobbens@2520
   600
         return kFFEffectType_Friction_ID;
bobbens@2520
   601
bobbens@2520
   602
      case SDL_HAPTIC_CUSTOM:
bobbens@2520
   603
         return kFFEffectType_CustomForce_ID;
bobbens@2520
   604
bobbens@2520
   605
      default:
bobbens@2520
   606
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2520
   607
         return NULL;
bobbens@2520
   608
   }
bobbens@2520
   609
}
bobbens@2520
   610
bobbens@2520
   611
bobbens@2520
   612
/*
bobbens@2520
   613
 * Creates a new haptic effect.
bobbens@2520
   614
 */
bobbens@2520
   615
int
bobbens@2520
   616
SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2520
   617
      SDL_HapticEffect * base)
bobbens@2520
   618
{
bobbens@2520
   619
   HRESULT ret;
bobbens@2520
   620
   CFUUIDRef type;
bobbens@2520
   621
bobbens@2520
   622
   /* Alloc the effect. */
bobbens@2520
   623
   effect->hweffect = (struct haptic_hweffect *)
bobbens@2520
   624
         SDL_malloc(sizeof(struct haptic_hweffect));
bobbens@2520
   625
   if (effect->hweffect == NULL) {
bobbens@2520
   626
      SDL_OutOfMemory();
bobbens@2527
   627
      goto err_hweffect;
bobbens@2520
   628
   }
bobbens@2520
   629
bobbens@2520
   630
   /* Get the type. */
bobbens@2520
   631
   type = SDL_SYS_HapticEffectType(effect);
bobbens@2520
   632
   if (type == NULL) {
bobbens@2527
   633
      goto err_hweffect;
bobbens@2520
   634
   }
bobbens@2520
   635
bobbens@2520
   636
   /* Get the effect. */
bobbens@2527
   637
   if (SDL_SYS_ToFFEFFECT(haptic, &effect->hweffect->effect, &effect->effect ) < 0) {
bobbens@2527
   638
      goto err_effectdone;
bobbens@2520
   639
   }
bobbens@2520
   640
bobbens@2527
   641
   /* Create the actual effect. */
bobbens@2520
   642
   ret = FFDeviceCreateEffect( haptic->hwdata->device, type,
bobbens@2520
   643
         &effect->hweffect->effect, &effect->hweffect->ref );
bobbens@2527
   644
bobbens@2527
   645
   if (ret != FF_OK) {
bobbens@2527
   646
      SDL_SetError("Haptic: Unable to create effect.");
bobbens@2527
   647
      goto err_effectdone;
bobbens@2527
   648
   }
bobbens@2527
   649
bobbens@2527
   650
   return 0;
bobbens@2527
   651
bobbens@2527
   652
err_effectdone:
bobbens@2527
   653
   SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect);
bobbens@2527
   654
err_hweffect:
bobbens@2527
   655
   if (effect->hweffect != NULL) {
bobbens@2527
   656
      SDL_free(effect->hweffect);
bobbens@2527
   657
      effect->hweffect = NULL;
bobbens@2527
   658
   }
bobbens@2527
   659
   return -1;
bobbens@2520
   660
}
bobbens@2520
   661
bobbens@2520
   662
bobbens@2520
   663
/*
bobbens@2520
   664
 * Updates an effect.
bobbens@2520
   665
 */
bobbens@2520
   666
int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
bobbens@2520
   667
      struct haptic_effect * effect, SDL_HapticEffect * data)
bobbens@2520
   668
{
bobbens@2520
   669
   /* TODO */
bobbens@2520
   670
   return -1;
bobbens@2520
   671
}
bobbens@2520
   672
bobbens@2520
   673
bobbens@2520
   674
/*
bobbens@2520
   675
 * Runs an effect.
bobbens@2520
   676
 */
bobbens@2520
   677
int
bobbens@2520
   678
SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2520
   679
                        Uint32 iterations)
bobbens@2520
   680
{
bobbens@2520
   681
   HRESULT ret;
bobbens@2520
   682
   Uint32 iter;
bobbens@2520
   683
bobbens@2520
   684
   /* Check if it's infinite. */
bobbens@2520
   685
   if (iterations == SDL_HAPTIC_INFINITY) {
bobbens@2521
   686
      iter = FF_INFINITE;
bobbens@2520
   687
   }
bobbens@2520
   688
   else
bobbens@2520
   689
      iter = iterations;
bobbens@2520
   690
bobbens@2520
   691
   /* Run the effect. */
bobbens@2520
   692
   ret = FFEffectStart(effect->hweffect->ref, iter, 0);
bobbens@2520
   693
   if (ret != FF_OK) {
bobbens@2520
   694
      SDL_SetError("Haptic: Unable to run the effect.");
bobbens@2520
   695
      return -1;
bobbens@2520
   696
   }
bobbens@2520
   697
bobbens@2520
   698
   return 0;
bobbens@2520
   699
}
bobbens@2520
   700
bobbens@2520
   701
bobbens@2520
   702
/*
bobbens@2520
   703
 * Stops an effect.
bobbens@2520
   704
 */
bobbens@2520
   705
int
bobbens@2520
   706
SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
   707
{
bobbens@2520
   708
   HRESULT ret;
bobbens@2520
   709
bobbens@2520
   710
   ret = FFEffectStop(effect->hweffect->ref);
bobbens@2520
   711
   if (ret != FF_OK) {
bobbens@2520
   712
      SDL_SetError("Haptic: Unable to stop the effect.");
bobbens@2520
   713
      return -1;
bobbens@2520
   714
   }
bobbens@2520
   715
bobbens@2520
   716
   return 0;
bobbens@2520
   717
}
bobbens@2520
   718
bobbens@2520
   719
bobbens@2520
   720
/*
bobbens@2520
   721
 * Frees the effect.
bobbens@2520
   722
 */
bobbens@2520
   723
void
bobbens@2520
   724
SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
   725
{
bobbens@2520
   726
   HRESULT ret;
bobbens@2520
   727
bobbens@2520
   728
   ret = FFDeviceReleaseEffect(haptic->hwdata->device, effect->hweffect->ref);
bobbens@2520
   729
   if (ret != FF_OK) {
bobbens@2520
   730
      SDL_SetError("Haptic: Error removing the effect from the device.");
bobbens@2520
   731
   }
bobbens@2520
   732
   SDL_free(effect->hweffect->effect.lpvTypeSpecificParams);
bobbens@2520
   733
   effect->hweffect->effect.lpvTypeSpecificParams = NULL;
bobbens@2520
   734
   SDL_free(effect->hweffect);
bobbens@2520
   735
   effect->hweffect = NULL;
bobbens@2520
   736
}
bobbens@2520
   737
bobbens@2520
   738
bobbens@2520
   739
/*
bobbens@2520
   740
 * Gets the status of a haptic effect.
bobbens@2520
   741
 */
bobbens@2520
   742
int
bobbens@2520
   743
SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
   744
{
bobbens@2520
   745
   HRESULT ret;
bobbens@2520
   746
   FFEffectStatusFlag status;
bobbens@2520
   747
bobbens@2521
   748
   ret = FFEffectGetEffectStatus(effect->hweffect->ref, &status);
bobbens@2520
   749
   if (ret != FF_OK) {
bobbens@2520
   750
      SDL_SetError("Haptic: Unable to get effect status.");
bobbens@2520
   751
      return -1;
bobbens@2520
   752
   }
bobbens@2520
   753
bobbens@2520
   754
   if (status == 0) return SDL_FALSE;
bobbens@2520
   755
   return SDL_TRUE; /* Assume it's playing or emulated. */
bobbens@2520
   756
}
bobbens@2520
   757
bobbens@2520
   758
bobbens@2520
   759
/*
bobbens@2520
   760
 * Sets the gain.
bobbens@2520
   761
 */
bobbens@2520
   762
int
bobbens@2520
   763
SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain)
bobbens@2520
   764
{
bobbens@2520
   765
   HRESULT ret;
bobbens@2520
   766
   Uint32 val;
bobbens@2520
   767
bobbens@2520
   768
   val = gain * 100; /* Mac OS X uses 0 to 10,000 */
bobbens@2520
   769
   ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device, FFPROP_FFGAIN, &val);
bobbens@2520
   770
   if (ret != FF_OK) {
bobbens@2520
   771
      SDL_SetError("Haptic: Error setting gain.");
bobbens@2520
   772
      return -1;
bobbens@2520
   773
   }
bobbens@2520
   774
bobbens@2520
   775
   return 0;
bobbens@2520
   776
}
bobbens@2520
   777
bobbens@2520
   778
bobbens@2520
   779
/*
bobbens@2520
   780
 * Sets the autocentering.
bobbens@2520
   781
 */
bobbens@2520
   782
int
bobbens@2520
   783
SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
bobbens@2520
   784
{
bobbens@2520
   785
   HRESULT ret;
bobbens@2520
   786
   Uint32 val;
bobbens@2520
   787
bobbens@2520
   788
   /* Mac OS X only has 0 (off) and 1 (on) */
bobbens@2520
   789
   if (autocenter == 0) val = 0;
bobbens@2520
   790
   else val = 1;
bobbens@2520
   791
bobbens@2520
   792
   ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device,
bobbens@2521
   793
               FFPROP_AUTOCENTER, &val);
bobbens@2520
   794
   if (ret != FF_OK) {
bobbens@2520
   795
      SDL_SetError("Haptic: Error setting autocenter.");
bobbens@2520
   796
      return -1;
bobbens@2520
   797
   }
bobbens@2520
   798
  
bobbens@2520
   799
   return 0;
bobbens@2520
   800
bobbens@2520
   801
}
bobbens@2520
   802
bobbens@2520
   803
bobbens@2520
   804
#endif /* SDL_HAPTIC_LINUX */