src/haptic/darwin/SDL_syshaptic.c
author Edgar Simo <bobbens@gmail.com>
Wed, 30 Jul 2008 15:08:44 +0000
branchgsoc2008_force_feedback
changeset 2557 30778d9d8bff
parent 2556 fe346eddd3fb
child 2559 42b682e85546
permissions -rw-r--r--
Made envelopes behave correctly with length of 0.
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@2537
    46
   char name[256];
bobbens@2520
    47
   io_service_t dev;
bobbens@2520
    48
   SDL_Haptic *haptic;
bobbens@2520
    49
} SDL_hapticlist[MAX_HAPTICS];
bobbens@2520
    50
bobbens@2520
    51
bobbens@2520
    52
/*
bobbens@2520
    53
 * Haptic system hardware data.
bobbens@2520
    54
 */
bobbens@2520
    55
struct haptic_hwdata
bobbens@2520
    56
{
bobbens@2520
    57
   FFDeviceObjectReference device; /* Hardware device. */
bobbens@2520
    58
};
bobbens@2520
    59
bobbens@2520
    60
bobbens@2520
    61
/*
bobbens@2520
    62
 * Haptic system effect data.
bobbens@2520
    63
 */
bobbens@2520
    64
struct haptic_hweffect
bobbens@2520
    65
{
bobbens@2520
    66
   FFEffectObjectReference ref; /* Reference. */
bobbens@2520
    67
   struct FFEFFECT effect; /* Hardware effect. */
bobbens@2520
    68
};
bobbens@2520
    69
bobbens@2531
    70
/*
bobbens@2531
    71
 * Prototypes.
bobbens@2531
    72
 */
bobbens@2537
    73
static void SDL_SYS_HapticFreeFFEFFECT(FFEFFECT * effect, int type);
bobbens@2537
    74
static int HIDGetDeviceProduct(io_service_t dev, char * name);
bobbens@2531
    75
bobbens@2520
    76
bobbens@2541
    77
/* 
bobbens@2541
    78
 * Like strerror but for force feedback errors.
bobbens@2541
    79
 */
bobbens@2541
    80
static const char *
bobbens@2541
    81
FFStrError(HRESULT err)
bobbens@2541
    82
{
bobbens@2541
    83
   switch (err) {
bobbens@2541
    84
      case FFERR_DEVICEFULL:
bobbens@2541
    85
         return "device full";
bobbens@2543
    86
      /*case FFERR_DEVICENOTREG:
bobbens@2543
    87
         return "device not registered";*/
bobbens@2541
    88
      case FFERR_DEVICEPAUSED:
bobbens@2541
    89
         return "device paused";
bobbens@2541
    90
      case FFERR_DEVICERELEASED:
bobbens@2541
    91
         return "device released";
bobbens@2541
    92
      case FFERR_EFFECTPLAYING:
bobbens@2541
    93
         return "effect playing";
bobbens@2541
    94
      case FFERR_EFFECTTYPEMISMATCH:
bobbens@2541
    95
         return "effect type mismatch";
bobbens@2541
    96
      case FFERR_EFFECTTYPENOTSUPPORTED:
bobbens@2541
    97
         return "effect type not supported";
bobbens@2541
    98
      case FFERR_GENERIC:
bobbens@2541
    99
         return "undetermined error";
bobbens@2541
   100
      case FFERR_HASEFFECTS:
bobbens@2541
   101
         return "device has effects";
bobbens@2541
   102
      case FFERR_INCOMPLETEEFFECT:
bobbens@2541
   103
         return "incomplete effect";
bobbens@2541
   104
      case FFERR_INTERNAL:
bobbens@2541
   105
         return "internal fault";
bobbens@2541
   106
      case FFERR_INVALIDDOWNLOADID:
bobbens@2541
   107
         return "invalid download id";
bobbens@2541
   108
      case FFERR_INVALIDPARAM:
bobbens@2541
   109
         return "invalid parameter";
bobbens@2541
   110
      case FFERR_MOREDATA:
bobbens@2541
   111
         return "more data";
bobbens@2541
   112
      case FFERR_NOINTERFACE:
bobbens@2541
   113
         return "interface not supported";
bobbens@2541
   114
      case FFERR_NOTDOWNLOADED:
bobbens@2541
   115
         return "effect is not downloaded";
bobbens@2541
   116
      case FFERR_NOTINITIALIZED:
bobbens@2541
   117
         return "object has not been initialized";
bobbens@2541
   118
      case FFERR_OUTOFMEMORY:
bobbens@2541
   119
         return "out of memory";
bobbens@2541
   120
      case FFERR_UNPLUGGED:
bobbens@2541
   121
         return "device is unplugged";
bobbens@2541
   122
      case FFERR_UNSUPPORTED:
bobbens@2541
   123
         return "function call unsupported";
bobbens@2541
   124
      case FFERR_UNSUPPORTEDAXIS:
bobbens@2541
   125
         return "axis unsupported";
bobbens@2541
   126
bobbens@2541
   127
      default:
bobbens@2541
   128
         return "unknown error";
bobbens@2541
   129
   }
bobbens@2541
   130
}
bobbens@2541
   131
bobbens@2541
   132
bobbens@2520
   133
/*
bobbens@2520
   134
 * Initializes the haptic subsystem.
bobbens@2520
   135
 */
bobbens@2520
   136
int
bobbens@2520
   137
SDL_SYS_HapticInit(void)
bobbens@2520
   138
{
bobbens@2520
   139
   int numhaptics;
bobbens@2520
   140
   IOReturn result;
bobbens@2520
   141
   io_iterator_t iter;
bobbens@2520
   142
   CFDictionaryRef match;
bobbens@2521
   143
   io_service_t device;
bobbens@2520
   144
bobbens@2537
   145
   /* Clear all the memory. */
bobbens@2537
   146
   SDL_memset(SDL_hapticlist, 0, sizeof(SDL_hapticlist));
bobbens@2537
   147
bobbens@2520
   148
   /* Get HID devices. */
bobbens@2520
   149
   match = IOServiceMatching(kIOHIDDeviceKey);
bobbens@2520
   150
   if (match == NULL) {
bobbens@2520
   151
      SDL_SetError("Haptic: Failed to get IOServiceMatching.");
bobbens@2520
   152
      return -1;
bobbens@2520
   153
   }
bobbens@2520
   154
bobbens@2520
   155
   /* Now search I/O Registry for matching devices. */
bobbens@2520
   156
   result = IOServiceGetMatchingServices(kIOMasterPortDefault, match, &iter);
bobbens@2520
   157
   if (result != kIOReturnSuccess) {
bobbens@2520
   158
      SDL_SetError("Haptic: Couldn't create a HID object iterator.");
bobbens@2520
   159
      return -1;
bobbens@2520
   160
   }
bobbens@2520
   161
   /* IOServiceGetMatchingServices consumes dictionary. */
bobbens@2520
   162
bobbens@2520
   163
   numhaptics = 0;
bobbens@2520
   164
   while ((device = IOIteratorNext(iter)) != IO_OBJECT_NULL) {
bobbens@2520
   165
bobbens@2520
   166
      /* Check for force feedback. */
bobbens@2520
   167
      if (FFIsForceFeedback(device) == FF_OK) {
bobbens@2537
   168
         HIDGetDeviceProduct(device, SDL_hapticlist[numhaptics].name);
bobbens@2520
   169
         SDL_hapticlist[numhaptics].dev = device;
bobbens@2520
   170
         SDL_hapticlist[numhaptics].haptic = NULL;
bobbens@2520
   171
         numhaptics++;
bobbens@2520
   172
      }
bobbens@2537
   173
      else { /* Free the unused device. */
bobbens@2537
   174
         IOObjectRelease(device);
bobbens@2537
   175
      }
bobbens@2520
   176
bobbens@2520
   177
      /* Reached haptic limit. */
bobbens@2520
   178
      if (numhaptics >= MAX_HAPTICS)
bobbens@2520
   179
         break;
bobbens@2520
   180
   }
bobbens@2520
   181
   IOObjectRelease(iter);
bobbens@2520
   182
bobbens@2520
   183
   return numhaptics;
bobbens@2520
   184
}
bobbens@2520
   185
bobbens@2520
   186
bobbens@2520
   187
/*
bobbens@2520
   188
 * Return the name of a haptic device, does not need to be opened.
bobbens@2520
   189
 */
bobbens@2520
   190
const char *
bobbens@2520
   191
SDL_SYS_HapticName(int index)
bobbens@2520
   192
{
bobbens@2537
   193
   return SDL_hapticlist[index].name;
bobbens@2537
   194
}
bobbens@2537
   195
bobbens@2537
   196
/*
bobbens@2537
   197
 * Gets the device's product name.
bobbens@2537
   198
 */
bobbens@2537
   199
static int
bobbens@2537
   200
HIDGetDeviceProduct(io_service_t dev, char *name)
bobbens@2537
   201
{
bobbens@2537
   202
   CFMutableDictionaryRef hidProperties, usbProperties;
bobbens@2537
   203
   io_registry_entry_t parent1, parent2;
bobbens@2546
   204
   kern_return_t ret;
bobbens@2537
   205
bobbens@2537
   206
   hidProperties = usbProperties = 0;
bobbens@2537
   207
bobbens@2547
   208
   ret = IORegistryEntryCreateCFProperties(dev, &hidProperties,
bobbens@2546
   209
                                           kCFAllocatorDefault,
bobbens@2546
   210
                                           kNilOptions);
bobbens@2546
   211
   if ((ret != KERN_SUCCESS) || !hidProperties) {
bobbens@2546
   212
      SDL_SetError("Haptic: Unable to create CFProperties.");
bobbens@2546
   213
      return -1;
bobbens@2546
   214
   }
bobbens@2546
   215
bobbens@2537
   216
   /* Mac OS X currently is not mirroring all USB properties to HID page so need to look at USB device page also
bobbens@2537
   217
    * get dictionary for usb properties: step up two levels and get CF dictionary for USB properties
bobbens@2537
   218
    */
bobbens@2537
   219
   if ((KERN_SUCCESS ==
bobbens@2537
   220
            IORegistryEntryGetParentEntry(dev, kIOServicePlane, &parent1))
bobbens@2537
   221
         && (KERN_SUCCESS ==
bobbens@2537
   222
            IORegistryEntryGetParentEntry(parent1, kIOServicePlane, &parent2))
bobbens@2537
   223
         && (KERN_SUCCESS ==
bobbens@2537
   224
            IORegistryEntryCreateCFProperties(parent2, &usbProperties,
bobbens@2546
   225
                                              kCFAllocatorDefault,
bobbens@2546
   226
                                              kNilOptions))) {
bobbens@2537
   227
      if (usbProperties) {
bobbens@2537
   228
         CFTypeRef refCF = 0;
bobbens@2537
   229
         /* get device info
bobbens@2537
   230
          * try hid dictionary first, if fail then go to usb dictionary
bobbens@2537
   231
          */
bobbens@2537
   232
bobbens@2537
   233
bobbens@2537
   234
         /* Get product name */
bobbens@2546
   235
         refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDProductKey));
bobbens@2537
   236
         if (!refCF)
bobbens@2537
   237
            refCF =
bobbens@2537
   238
               CFDictionaryGetValue(usbProperties, CFSTR("USB Product Name"));
bobbens@2537
   239
         if (refCF) {
bobbens@2537
   240
            if (!CFStringGetCString(refCF, name, 256,
bobbens@2537
   241
                                    CFStringGetSystemEncoding())) {
bobbens@2537
   242
               SDL_SetError("CFStringGetCString error retrieving pDevice->product.");
bobbens@2537
   243
               return -1;
bobbens@2537
   244
            }
bobbens@2537
   245
         }
bobbens@2537
   246
bobbens@2537
   247
         CFRelease(usbProperties);
bobbens@2537
   248
      }
bobbens@2537
   249
      else {
bobbens@2537
   250
         SDL_SetError("IORegistryEntryCreateCFProperties failed to create usbProperties.");
bobbens@2537
   251
         return -1;
bobbens@2537
   252
      }
bobbens@2537
   253
bobbens@2537
   254
      /* Release stuff. */
bobbens@2537
   255
      if (kIOReturnSuccess != IOObjectRelease(parent2)) {
bobbens@2537
   256
         SDL_SetError("IOObjectRelease error with parent2.");
bobbens@2537
   257
      }
bobbens@2537
   258
      if (kIOReturnSuccess != IOObjectRelease(parent1))  {
bobbens@2537
   259
         SDL_SetError("IOObjectRelease error with parent1.");
bobbens@2537
   260
      }
bobbens@2537
   261
   }
bobbens@2546
   262
   else {
bobbens@2546
   263
      SDL_SetError("Haptic: Error getting registry entries.");
bobbens@2546
   264
      return -1;
bobbens@2546
   265
   }
bobbens@2546
   266
bobbens@2537
   267
   return 0;
bobbens@2520
   268
}
bobbens@2520
   269
bobbens@2520
   270
bobbens@2520
   271
#define FF_TEST(ff, s) \
bobbens@2520
   272
if (features.supportedEffects & ff) supported |= s
bobbens@2520
   273
/*
bobbens@2520
   274
 * Gets supported features.
bobbens@2520
   275
 */
bobbens@2520
   276
static unsigned int
bobbens@2520
   277
GetSupportedFeatures(FFDeviceObjectReference device,
bobbens@2527
   278
                     int *neffects, int *nplaying, int *naxes)
bobbens@2520
   279
{
bobbens@2520
   280
   HRESULT ret;
bobbens@2520
   281
   FFCAPABILITIES features;
bobbens@2520
   282
   unsigned int supported;
bobbens@2520
   283
   Uint32 val;
bobbens@2520
   284
bobbens@2520
   285
   ret = FFDeviceGetForceFeedbackCapabilities(device, &features);
bobbens@2520
   286
   if (ret != FF_OK) {
bobbens@2520
   287
      SDL_SetError("Haptic: Unable to get device's supported features.");
bobbens@2520
   288
      return 0;
bobbens@2520
   289
   }
bobbens@2520
   290
bobbens@2520
   291
   supported = 0;
bobbens@2520
   292
bobbens@2520
   293
   /* Get maximum effects. */
bobbens@2520
   294
   *neffects = features.storageCapacity;
bobbens@2520
   295
   *nplaying = features.playbackCapacity;
bobbens@2520
   296
bobbens@2520
   297
   /* Test for effects. */
bobbens@2520
   298
   FF_TEST(FFCAP_ET_CONSTANTFORCE, SDL_HAPTIC_CONSTANT);
bobbens@2520
   299
   FF_TEST(FFCAP_ET_RAMPFORCE,     SDL_HAPTIC_RAMP);
bobbens@2520
   300
   FF_TEST(FFCAP_ET_SQUARE,        SDL_HAPTIC_SQUARE);
bobbens@2520
   301
   FF_TEST(FFCAP_ET_SINE,          SDL_HAPTIC_SINE);
bobbens@2520
   302
   FF_TEST(FFCAP_ET_TRIANGLE,      SDL_HAPTIC_TRIANGLE);
bobbens@2520
   303
   FF_TEST(FFCAP_ET_SAWTOOTHUP,    SDL_HAPTIC_SAWTOOTHUP);
bobbens@2520
   304
   FF_TEST(FFCAP_ET_SAWTOOTHDOWN,  SDL_HAPTIC_SAWTOOTHDOWN);
bobbens@2520
   305
   FF_TEST(FFCAP_ET_SPRING,        SDL_HAPTIC_SPRING);
bobbens@2520
   306
   FF_TEST(FFCAP_ET_DAMPER,        SDL_HAPTIC_DAMPER);
bobbens@2520
   307
   FF_TEST(FFCAP_ET_INERTIA,       SDL_HAPTIC_INERTIA);
bobbens@2520
   308
   FF_TEST(FFCAP_ET_FRICTION,      SDL_HAPTIC_FRICTION);
bobbens@2520
   309
   FF_TEST(FFCAP_ET_CUSTOMFORCE,   SDL_HAPTIC_CUSTOM);
bobbens@2520
   310
bobbens@2520
   311
   /* Check if supports gain. */
bobbens@2554
   312
   ret = FFDeviceGetForceFeedbackProperty( device, FFPROP_FFGAIN,
bobbens@2554
   313
                                           &val, sizeof(val));
bobbens@2520
   314
   if (ret == FF_OK) supported |= SDL_HAPTIC_GAIN;
bobbens@2520
   315
   else if (ret != FFERR_UNSUPPORTED) {
bobbens@2541
   316
      SDL_SetError("Haptic: Unable to get if device supports gain: %s.",
bobbens@2542
   317
                   FFStrError(ret));
bobbens@2520
   318
      return 0;
bobbens@2520
   319
   }
bobbens@2520
   320
bobbens@2520
   321
   /* Checks if supports autocenter. */
bobbens@2521
   322
   ret = FFDeviceGetForceFeedbackProperty(device, FFPROP_AUTOCENTER,
bobbens@2522
   323
                                          &val, sizeof(val));
bobbens@2520
   324
   if (ret == FF_OK) supported |= SDL_HAPTIC_AUTOCENTER;
bobbens@2520
   325
   else if (ret != FFERR_UNSUPPORTED) {
bobbens@2541
   326
      SDL_SetError("Haptic: Unable to get if device supports autocenter: %s.",
bobbens@2541
   327
                   FFStrError(ret));
bobbens@2520
   328
      return 0;
bobbens@2520
   329
   }
bobbens@2520
   330
bobbens@2527
   331
   /* Check for axes, we have an artificial limit on axes */
bobbens@2528
   332
   *naxes = ((features.numFfAxes) > 3) ?
bobbens@2527
   333
         3 : features.numFfAxes;
bobbens@2527
   334
bobbens@2520
   335
   /* Always supported features. */
bobbens@2520
   336
   supported |= SDL_HAPTIC_STATUS;
bobbens@2520
   337
   return supported;
bobbens@2520
   338
}
bobbens@2520
   339
bobbens@2520
   340
bobbens@2520
   341
/*
bobbens@2520
   342
 * Opens the haptic device from the file descriptor.
bobbens@2520
   343
 */
bobbens@2520
   344
static int
bobbens@2520
   345
SDL_SYS_HapticOpenFromService(SDL_Haptic * haptic, io_service_t service)
bobbens@2520
   346
{
bobbens@2541
   347
   HRESULT ret;
bobbens@2541
   348
bobbens@2520
   349
   /* Allocate the hwdata */
bobbens@2520
   350
   haptic->hwdata = (struct haptic_hwdata *)
bobbens@2520
   351
         SDL_malloc(sizeof(*haptic->hwdata));
bobbens@2520
   352
   if (haptic->hwdata == NULL) {
bobbens@2520
   353
      SDL_OutOfMemory();
bobbens@2520
   354
      goto creat_err;
bobbens@2520
   355
   }
bobbens@2520
   356
   SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
bobbens@2520
   357
  
bobbens@2520
   358
   /* Open the device */
bobbens@2541
   359
   ret = FFCreateDevice( service, &haptic->hwdata->device);
bobbens@2541
   360
   if (ret != FF_OK) {
bobbens@2541
   361
      SDL_SetError("Haptic: Unable to create device from service: %s.",
bobbens@2541
   362
                   FFStrError(ret));
bobbens@2520
   363
      goto creat_err;
bobbens@2520
   364
   }
bobbens@2520
   365
bobbens@2520
   366
   /* Get supported features. */
bobbens@2550
   367
   haptic->supported = GetSupportedFeatures( haptic->hwdata->device,
bobbens@2550
   368
                                             &haptic->neffects, &haptic->nplaying,
bobbens@2550
   369
                                             &haptic->naxes );
bobbens@2520
   370
   if (haptic->supported == 0) { /* Error since device supports nothing. */
bobbens@2520
   371
      goto open_err;
bobbens@2520
   372
   }
bobbens@2550
   373
bobbens@2550
   374
bobbens@2550
   375
   /* Reset and then enable actuators. */
bobbens@2550
   376
   ret = FFDeviceSendForceFeedbackCommand( haptic->hwdata->device,
bobbens@2550
   377
                                           FFSFFC_RESET );
bobbens@2550
   378
   if (ret != FF_OK) {
bobbens@2550
   379
      SDL_SetError("Haptic: Unable to reset device: %s.", FFStrError(ret));
bobbens@2550
   380
      goto open_err;
bobbens@2550
   381
   }
bobbens@2550
   382
   ret = FFDeviceSendForceFeedbackCommand( haptic->hwdata->device,
bobbens@2550
   383
                                           FFSFFC_SETACTUATORSON  );
bobbens@2550
   384
   if (ret != FF_OK) {
bobbens@2550
   385
      SDL_SetError("Haptic: Unable to enable actuators: %s.", FFStrError(ret));
bobbens@2550
   386
      goto open_err;
bobbens@2550
   387
   }
bobbens@2550
   388
bobbens@2550
   389
bobbens@2550
   390
   /* Allocate effects memory. */
bobbens@2520
   391
   haptic->effects = (struct haptic_effect *)
bobbens@2520
   392
         SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
bobbens@2520
   393
   if (haptic->effects == NULL) {
bobbens@2520
   394
      SDL_OutOfMemory();
bobbens@2520
   395
      goto open_err;
bobbens@2520
   396
   }
bobbens@2520
   397
   /* Clear the memory */
bobbens@2520
   398
   SDL_memset(haptic->effects, 0,
bobbens@2520
   399
         sizeof(struct haptic_effect) * haptic->neffects);
bobbens@2520
   400
   
bobbens@2520
   401
   return 0;
bobbens@2520
   402
   
bobbens@2520
   403
   /* Error handling */
bobbens@2520
   404
open_err:
bobbens@2520
   405
   FFReleaseDevice(haptic->hwdata->device);
bobbens@2520
   406
creat_err:
bobbens@2520
   407
   if (haptic->hwdata != NULL) {
bobbens@2520
   408
      free(haptic->hwdata);
bobbens@2520
   409
      haptic->hwdata = NULL;                                              
bobbens@2520
   410
   }
bobbens@2520
   411
   return -1;
bobbens@2520
   412
bobbens@2520
   413
}
bobbens@2520
   414
bobbens@2520
   415
bobbens@2520
   416
/*
bobbens@2520
   417
 * Opens a haptic device for usage.
bobbens@2520
   418
 */
bobbens@2520
   419
int
bobbens@2520
   420
SDL_SYS_HapticOpen(SDL_Haptic * haptic)
bobbens@2520
   421
{
bobbens@2520
   422
   return SDL_SYS_HapticOpenFromService(haptic,
bobbens@2522
   423
                SDL_hapticlist[haptic->index].dev);
bobbens@2520
   424
}
bobbens@2520
   425
bobbens@2520
   426
bobbens@2520
   427
/*
bobbens@2520
   428
 * Opens a haptic device from first mouse it finds for usage.
bobbens@2520
   429
 */
bobbens@2520
   430
int
bobbens@2520
   431
SDL_SYS_HapticMouse(void)
bobbens@2520
   432
{
bobbens@2520
   433
   return -1;
bobbens@2520
   434
}
bobbens@2520
   435
bobbens@2520
   436
bobbens@2520
   437
/*
bobbens@2520
   438
 * Checks to see if a joystick has haptic features.
bobbens@2520
   439
 */
bobbens@2520
   440
int
bobbens@2520
   441
SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick)
bobbens@2520
   442
{
bobbens@2520
   443
   return SDL_FALSE;
bobbens@2520
   444
}
bobbens@2520
   445
bobbens@2520
   446
bobbens@2520
   447
/*
bobbens@2520
   448
 * Checks to see if the haptic device and joystick and in reality the same.
bobbens@2520
   449
 */
bobbens@2520
   450
int
bobbens@2520
   451
SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, SDL_Joystick * joystick)
bobbens@2520
   452
{
bobbens@2520
   453
   return 0;
bobbens@2520
   454
}
bobbens@2520
   455
bobbens@2520
   456
bobbens@2520
   457
/*
bobbens@2520
   458
 * Opens a SDL_Haptic from a SDL_Joystick.
bobbens@2520
   459
 */
bobbens@2520
   460
int
bobbens@2520
   461
SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, SDL_Joystick * joystick)
bobbens@2520
   462
{
bobbens@2520
   463
   return -1;
bobbens@2520
   464
}
bobbens@2520
   465
bobbens@2520
   466
bobbens@2520
   467
/*
bobbens@2520
   468
 * Closes the haptic device.
bobbens@2520
   469
 */
bobbens@2520
   470
void
bobbens@2520
   471
SDL_SYS_HapticClose(SDL_Haptic * haptic)
bobbens@2520
   472
{
bobbens@2520
   473
   int i;
bobbens@2520
   474
bobbens@2520
   475
   if (haptic->hwdata) {
bobbens@2520
   476
bobbens@2530
   477
      /* Free the effects. */
bobbens@2530
   478
      for (i=0; i<haptic->neffects; i++) {        
bobbens@2530
   479
         if (haptic->effects[i].hweffect != NULL) {
bobbens@2535
   480
            SDL_SYS_HapticFreeFFEFFECT(&haptic->effects[i].hweffect->effect,
bobbens@2535
   481
                                       haptic->effects[i].effect.type);
bobbens@2530
   482
            SDL_free(haptic->effects[i].hweffect);
bobbens@2530
   483
         } 
bobbens@2530
   484
      }    
bobbens@2530
   485
      SDL_free(haptic->effects);
bobbens@2530
   486
      haptic->neffects = 0;
bobbens@2530
   487
bobbens@2520
   488
      /* Clean up */
bobbens@2520
   489
      FFReleaseDevice(haptic->hwdata->device);
bobbens@2520
   490
bobbens@2520
   491
      /* Free */
bobbens@2520
   492
      SDL_free(haptic->hwdata);
bobbens@2520
   493
      haptic->hwdata = NULL;
bobbens@2520
   494
   }
bobbens@2520
   495
}
bobbens@2520
   496
bobbens@2520
   497
bobbens@2520
   498
/* 
bobbens@2520
   499
 * Clean up after system specific haptic stuff
bobbens@2520
   500
 */
bobbens@2520
   501
void
bobbens@2520
   502
SDL_SYS_HapticQuit(void)
bobbens@2520
   503
{
bobbens@2520
   504
   int i;
bobbens@2520
   505
bobbens@2520
   506
   for (i=0; i < SDL_numhaptics; i++) {
bobbens@2530
   507
      /* Opened and not closed haptics are leaked, this is on purpose.
bobbens@2530
   508
       * Close your haptic devices after usage. */
bobbens@2530
   509
bobbens@2530
   510
      /* Free the io_service_t */
bobbens@2520
   511
      IOObjectRelease(SDL_hapticlist[i].dev);
bobbens@2520
   512
   }
bobbens@2520
   513
}
bobbens@2520
   514
bobbens@2520
   515
bobbens@2520
   516
/*
bobbens@2554
   517
 * Converts an SDL trigger button to an FFEFFECT trigger button.
bobbens@2554
   518
 */
bobbens@2554
   519
static DWORD
bobbens@2554
   520
FFGetTriggerButton( Uint16 button )
bobbens@2554
   521
{
bobbens@2554
   522
   DWORD dwTriggerButton;
bobbens@2554
   523
bobbens@2554
   524
   dwTriggerButton = FFEB_NOTRIGGER;
bobbens@2554
   525
bobbens@2555
   526
   if (button != 0) {
bobbens@2556
   527
      dwTriggerButton = FFJOFS_BUTTON(button - 1);
bobbens@2555
   528
   }
bobbens@2554
   529
bobbens@2554
   530
   return dwTriggerButton;
bobbens@2554
   531
}
bobbens@2554
   532
bobbens@2554
   533
bobbens@2554
   534
/*
bobbens@2520
   535
 * Sets the direction.
bobbens@2520
   536
 */
bobbens@2520
   537
static int
bobbens@2529
   538
SDL_SYS_SetDirection( FFEFFECT * effect, SDL_HapticDirection *dir, int naxes )
bobbens@2520
   539
{
bobbens@2521
   540
   LONG *rglDir;
bobbens@2527
   541
bobbens@2527
   542
   /* Handle no axes a part. */
bobbens@2528
   543
   if (naxes == 0) {
bobbens@2527
   544
      effect->rglDirection = NULL;
bobbens@2527
   545
      return 0;
bobbens@2527
   546
   }
bobbens@2527
   547
bobbens@2527
   548
   /* Has axes. */
bobbens@2529
   549
   rglDir = SDL_malloc( sizeof(LONG) * naxes );
bobbens@2527
   550
   if (rglDir == NULL) {
bobbens@2520
   551
      SDL_OutOfMemory();
bobbens@2520
   552
      return -1;
bobbens@2520
   553
   }
bobbens@2529
   554
   SDL_memset( rglDir, 0, sizeof(LONG) * naxes );
bobbens@2521
   555
   effect->rglDirection = rglDir;
bobbens@2520
   556
bobbens@2520
   557
   switch (dir->type) {
bobbens@2520
   558
      case SDL_HAPTIC_POLAR:
bobbens@2520
   559
         effect->dwFlags |= FFEFF_POLAR;
bobbens@2521
   560
         rglDir[0] = dir->dir[0];
bobbens@2520
   561
         return 0;
bobbens@2520
   562
      case SDL_HAPTIC_CARTESIAN:
bobbens@2522
   563
         effect->dwFlags |= FFEFF_CARTESIAN;
bobbens@2521
   564
         rglDir[0] = dir->dir[0];
bobbens@2521
   565
         rglDir[1] = dir->dir[1];
bobbens@2521
   566
         rglDir[2] = dir->dir[2];
bobbens@2520
   567
         return 0;
bobbens@2521
   568
      case SDL_HAPTIC_SPHERICAL:
bobbens@2522
   569
         effect->dwFlags |= FFEFF_SPHERICAL;
bobbens@2521
   570
         rglDir[0] = dir->dir[0];
bobbens@2521
   571
         rglDir[1] = dir->dir[1];
bobbens@2521
   572
         rglDir[2] = dir->dir[2];
bobbens@2520
   573
         return 0;
bobbens@2520
   574
bobbens@2520
   575
      default:
bobbens@2520
   576
         SDL_SetError("Haptic: Unknown direction type.");
bobbens@2520
   577
         return -1;
bobbens@2520
   578
   }
bobbens@2520
   579
}
bobbens@2520
   580
bobbens@2520
   581
#define CONVERT(x)   (((x)*10000) / 0xFFFF )
bobbens@2520
   582
/*
bobbens@2527
   583
 * Creates the FFEFFECT from a SDL_HapticEffect.
bobbens@2520
   584
 */
bobbens@2520
   585
static int
bobbens@2527
   586
SDL_SYS_ToFFEFFECT( SDL_Haptic * haptic, FFEFFECT * dest, SDL_HapticEffect * src )
bobbens@2520
   587
{
bobbens@2530
   588
   int i;
bobbens@2520
   589
   FFCONSTANTFORCE *constant;
bobbens@2520
   590
   FFPERIODIC *periodic;
bobbens@2530
   591
   FFCONDITION *condition; /* Actually an array of conditions - one per axis. */
bobbens@2520
   592
   FFRAMPFORCE *ramp;
bobbens@2520
   593
   FFCUSTOMFORCE *custom;
bobbens@2522
   594
   FFENVELOPE *envelope;
bobbens@2520
   595
   SDL_HapticConstant *hap_constant;
bobbens@2521
   596
   SDL_HapticPeriodic *hap_periodic;
bobbens@2520
   597
   SDL_HapticCondition *hap_condition;
bobbens@2520
   598
   SDL_HapticRamp *hap_ramp;
bobbens@2535
   599
   SDL_HapticCustom *hap_custom;
bobbens@2527
   600
   DWORD *axes;
bobbens@2520
   601
bobbens@2520
   602
   /* Set global stuff. */
bobbens@2520
   603
   SDL_memset(dest, 0, sizeof(FFEFFECT));
bobbens@2520
   604
   dest->dwSize = sizeof(FFEFFECT); /* Set the structure size. */
bobbens@2520
   605
   dest->dwSamplePeriod = 0; /* Not used by us. */
bobbens@2520
   606
   dest->dwGain = 10000; /* Gain is set globally, not locally. */
bobbens@2522
   607
bobbens@2522
   608
   /* Envelope. */
bobbens@2522
   609
   envelope = SDL_malloc( sizeof(FFENVELOPE) );
bobbens@2522
   610
   if (envelope == NULL) {
bobbens@2522
   611
      SDL_OutOfMemory();
bobbens@2522
   612
      return -1;
bobbens@2522
   613
   }
bobbens@2522
   614
   SDL_memset(envelope, 0, sizeof(FFENVELOPE));
bobbens@2522
   615
   dest->lpEnvelope = envelope;
bobbens@2522
   616
   envelope->dwSize = sizeof(FFENVELOPE); /* Always should be this. */
bobbens@2520
   617
bobbens@2527
   618
   /* Axes. */
bobbens@2527
   619
   dest->cAxes = haptic->naxes;
bobbens@2527
   620
   if (dest->cAxes > 0) {
bobbens@2527
   621
      axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
bobbens@2527
   622
      if (axes == NULL) {
bobbens@2527
   623
         SDL_OutOfMemory();
bobbens@2527
   624
         return -1;
bobbens@2527
   625
      }
bobbens@2527
   626
      axes[0] = FFJOFS_X; /* Always at least one axis. */
bobbens@2527
   627
      if (dest->cAxes > 1) {
bobbens@2527
   628
         axes[1] = FFJOFS_Y;
bobbens@2527
   629
      }
bobbens@2527
   630
      if (dest->cAxes > 2) {
bobbens@2527
   631
         axes[2] = FFJOFS_Z;
bobbens@2527
   632
      }
bobbens@2527
   633
      dest->rgdwAxes = axes;
bobbens@2527
   634
   }
bobbens@2527
   635
bobbens@2527
   636
bobbens@2530
   637
   /* The big type handling switch, even bigger then linux's version. */
bobbens@2520
   638
   switch (src->type) {
bobbens@2520
   639
      case SDL_HAPTIC_CONSTANT:
bobbens@2520
   640
         hap_constant = &src->constant;
bobbens@2520
   641
         constant = SDL_malloc( sizeof(FFCONSTANTFORCE) );
bobbens@2527
   642
         if (constant == NULL) {
bobbens@2527
   643
            SDL_OutOfMemory();
bobbens@2527
   644
            return -1;
bobbens@2527
   645
         }
bobbens@2535
   646
         SDL_memset(constant, 0, sizeof(FFCONSTANTFORCE));
bobbens@2520
   647
bobbens@2520
   648
         /* Specifics */
bobbens@2520
   649
         constant->lMagnitude = CONVERT(hap_constant->level);
bobbens@2520
   650
         dest->cbTypeSpecificParams = sizeof(FFCONSTANTFORCE); 
bobbens@2520
   651
         dest->lpvTypeSpecificParams = constant;
bobbens@2520
   652
bobbens@2520
   653
         /* Generics */
bobbens@2521
   654
         dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
bobbens@2554
   655
         dest->dwTriggerButton = FFGetTriggerButton(hap_constant->button);
bobbens@2520
   656
         dest->dwTriggerRepeatInterval = hap_constant->interval;
bobbens@2521
   657
         dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
bobbens@2520
   658
bobbens@2520
   659
         /* Direction. */
bobbens@2522
   660
         if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
bobbens@2520
   661
            return -1;
bobbens@2520
   662
         }
bobbens@2520
   663
         
bobbens@2520
   664
         /* Envelope */
bobbens@2557
   665
         if (envelope->dwAttackTime == 0) {
bobbens@2557
   666
            envelope->dwAttackLevel = constant->dwMagnitude
bobbens@2557
   667
         }
bobbens@2557
   668
         else {
bobbens@2557
   669
            envelope->dwAttackLevel = CONVERT(hap_constant->attack_level);
bobbens@2557
   670
            envelope->dwAttackTime = hap_constant->attack_length * 1000;
bobbens@2557
   671
         }
bobbens@2557
   672
         if (envelope->dwFadeTime == 0) {
bobbens@2557
   673
            envelope->dwFadeLevel = constant->dwMagnitude
bobbens@2557
   674
         }
bobbens@2557
   675
         else {
bobbens@2557
   676
            envelope->dwFadeLevel = CONVERT(hap_constant->fade_level);
bobbens@2557
   677
            envelope->dwFadeTime = hap_constant->fade_length * 1000;
bobbens@2557
   678
         }
bobbens@2520
   679
bobbens@2520
   680
         break;
bobbens@2520
   681
bobbens@2520
   682
      case SDL_HAPTIC_SINE:
bobbens@2520
   683
      case SDL_HAPTIC_SQUARE:
bobbens@2520
   684
      case SDL_HAPTIC_TRIANGLE:
bobbens@2520
   685
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2520
   686
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2522
   687
         hap_periodic = &src->periodic;
bobbens@2527
   688
         periodic = SDL_malloc(sizeof(FFPERIODIC));
bobbens@2527
   689
         if (periodic == NULL) {
bobbens@2527
   690
            SDL_OutOfMemory();
bobbens@2527
   691
            return -1;
bobbens@2527
   692
         }
bobbens@2535
   693
         SDL_memset(periodic, 0, sizeof(FFPERIODIC));
bobbens@2527
   694
bobbens@2527
   695
         /* Specifics */
bobbens@2527
   696
         periodic->dwMagnitude = CONVERT(hap_periodic->magnitude);
bobbens@2527
   697
         periodic->lOffset = CONVERT(hap_periodic->offset);
bobbens@2527
   698
         periodic->dwPhase = hap_periodic->phase;
bobbens@2527
   699
         periodic->dwPeriod = hap_periodic->period * 1000;
bobbens@2527
   700
         dest->cbTypeSpecificParams = sizeof(FFPERIODIC);
bobbens@2527
   701
         dest->lpvTypeSpecificParams = periodic;
bobbens@2527
   702
bobbens@2527
   703
         /* Generics */
bobbens@2527
   704
         dest->dwDuration = hap_periodic->length * 1000; /* In microseconds. */
bobbens@2554
   705
         dest->dwTriggerButton = FFGetTriggerButton(hap_periodic->button);
bobbens@2527
   706
         dest->dwTriggerRepeatInterval = hap_periodic->interval;
bobbens@2527
   707
         dest->dwStartDelay = hap_periodic->delay * 1000; /* In microseconds. */
bobbens@2527
   708
         
bobbens@2527
   709
         /* Direction. */
bobbens@2527
   710
         if (SDL_SYS_SetDirection(dest, &hap_periodic->direction, dest->cAxes) < 0) {
bobbens@2527
   711
            return -1;
bobbens@2527
   712
         }
bobbens@2527
   713
         
bobbens@2527
   714
         /* Envelope */
bobbens@2557
   715
         if (envelope->dwAttackTime == 0) {
bobbens@2557
   716
            envelope->dwAttackLevel = periodic->dwMagnitude
bobbens@2557
   717
         }
bobbens@2557
   718
         else {
bobbens@2557
   719
            envelope->dwAttackLevel = CONVERT(hap_periodic->attack_level);
bobbens@2557
   720
            envelope->dwAttackTime = hap_periodic->attack_length * 1000;
bobbens@2557
   721
         }
bobbens@2557
   722
         if (envelope->dwFadeTime == 0) {
bobbens@2557
   723
            envelope->dwFadeLevel = periodic->dwMagnitude
bobbens@2557
   724
         }
bobbens@2557
   725
         else {
bobbens@2557
   726
            envelope->dwFadeLevel = CONVERT(hap_periodic->fade_level);
bobbens@2557
   727
            envelope->dwFadeTime = hap_periodic->fade_length * 1000;
bobbens@2557
   728
         }
bobbens@2520
   729
bobbens@2520
   730
         break;
bobbens@2520
   731
bobbens@2520
   732
      case SDL_HAPTIC_SPRING:
bobbens@2520
   733
      case SDL_HAPTIC_DAMPER:
bobbens@2520
   734
      case SDL_HAPTIC_INERTIA:
bobbens@2520
   735
      case SDL_HAPTIC_FRICTION:
bobbens@2522
   736
         hap_condition = &src->condition;
bobbens@2530
   737
         condition = SDL_malloc(sizeof(FFCONDITION) * dest->cAxes);
bobbens@2530
   738
         if (condition == NULL) {
bobbens@2530
   739
            SDL_OutOfMemory();
bobbens@2530
   740
            return -1;
bobbens@2530
   741
         }
bobbens@2535
   742
         SDL_memset(condition, 0, sizeof(FFCONDITION));
bobbens@2530
   743
bobbens@2530
   744
         /* Specifics */
bobbens@2530
   745
         for (i=0; i<dest->cAxes; i++) {
bobbens@2531
   746
            condition[i].lOffset = CONVERT(hap_condition->center[i]);
bobbens@2531
   747
            condition[i].lPositiveCoefficient = CONVERT(hap_condition->right_coeff[i]);
bobbens@2531
   748
            condition[i].lNegativeCoefficient = CONVERT(hap_condition->left_coeff[i]);
bobbens@2531
   749
            condition[i].dwPositiveSaturation = CONVERT(hap_condition->right_sat[i]);
bobbens@2531
   750
            condition[i].dwNegativeSaturation = CONVERT(hap_condition->left_sat[i]);
bobbens@2531
   751
            condition[i].lDeadBand = CONVERT(hap_condition->deadband[i]);
bobbens@2530
   752
         }
bobbens@2530
   753
         dest->cbTypeSpecificParams = sizeof(FFCONDITION) * dest->cAxes;
bobbens@2530
   754
         dest->lpvTypeSpecificParams = condition;
bobbens@2530
   755
bobbens@2530
   756
         /* Generics */
bobbens@2531
   757
         dest->dwDuration = hap_condition->length * 1000; /* In microseconds. */
bobbens@2554
   758
         dest->dwTriggerButton = FFGetTriggerButton(hap_condition->button);
bobbens@2531
   759
         dest->dwTriggerRepeatInterval = hap_condition->interval;
bobbens@2531
   760
         dest->dwStartDelay = hap_condition->delay * 1000; /* In microseconds. */
bobbens@2530
   761
bobbens@2530
   762
         /* Direction. */
bobbens@2531
   763
         if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes) < 0) {
bobbens@2530
   764
            return -1;                
bobbens@2530
   765
         }                            
bobbens@2530
   766
                                      
bobbens@2532
   767
         /* Envelope */
bobbens@2557
   768
         SDL_free(dest->lpEnvelope);
bobbens@2557
   769
         dest->lpEnvelope = NULL;
bobbens@2532
   770
/* TODO Check is envelope actually used.
bobbens@2531
   771
         envelope->dwAttackLevel = CONVERT(hap_condition->attack_level);
bobbens@2531
   772
         envelope->dwAttackTime = hap_condition->attack_length * 1000;
bobbens@2531
   773
         envelope->dwFadeLevel = CONVERT(hap_condition->fade_level);
bobbens@2531
   774
         envelope->dwFadeTime = hap_condition->fade_length * 1000;
bobbens@2532
   775
*/
bobbens@2520
   776
bobbens@2520
   777
         break;
bobbens@2520
   778
bobbens@2520
   779
      case SDL_HAPTIC_RAMP:
bobbens@2522
   780
         hap_ramp = &src->ramp;
bobbens@2533
   781
         ramp = SDL_malloc(sizeof(FFRAMPFORCE));
bobbens@2533
   782
         if (ramp == NULL) {
bobbens@2533
   783
            SDL_OutOfMemory();
bobbens@2533
   784
            return -1;
bobbens@2533
   785
         }
bobbens@2535
   786
         SDL_memset(ramp, 0, sizeof(FFRAMPFORCE));
bobbens@2533
   787
bobbens@2533
   788
         /* Specifics */
bobbens@2534
   789
         ramp->lStart = CONVERT(hap_ramp->start);
bobbens@2533
   790
         ramp->lEnd = CONVERT(hap_ramp->end);
bobbens@2535
   791
         dest->cbTypeSpecificParams = sizeof(FFRAMPFORCE);
bobbens@2535
   792
         dest->lpvTypeSpecificParams = ramp;
bobbens@2533
   793
bobbens@2533
   794
         /* Generics */
bobbens@2533
   795
         dest->dwDuration = hap_ramp->length * 1000; /* In microseconds. */
bobbens@2554
   796
         dest->dwTriggerButton = FFGetTriggerButton(hap_ramp->button);
bobbens@2533
   797
         dest->dwTriggerRepeatInterval = hap_ramp->interval;
bobbens@2533
   798
         dest->dwStartDelay = hap_ramp->delay * 1000; /* In microseconds. */
bobbens@2533
   799
bobbens@2533
   800
         /* Direction. */
bobbens@2533
   801
         if (SDL_SYS_SetDirection(dest, &hap_ramp->direction, dest->cAxes) < 0) {
bobbens@2533
   802
            return -1;
bobbens@2533
   803
         }
bobbens@2533
   804
bobbens@2533
   805
         /* Envelope */
bobbens@2557
   806
         if (envelope->dwAttackTime == 0) {
bobbens@2557
   807
            envelope->dwAttackLevel = ramp->dwMagnitude
bobbens@2557
   808
         }
bobbens@2557
   809
         else {
bobbens@2557
   810
            envelope->dwAttackLevel = CONVERT(hap_ramp->attack_level);
bobbens@2557
   811
            envelope->dwAttackTime = hap_ramp->attack_length * 1000;
bobbens@2557
   812
         }
bobbens@2557
   813
         if (envelope->dwFadeTime == 0) {
bobbens@2557
   814
            envelope->dwFadeLevel = ramp->dwMagnitude
bobbens@2557
   815
         }
bobbens@2557
   816
         else {
bobbens@2557
   817
            envelope->dwFadeLevel = CONVERT(hap_ramp->fade_level);
bobbens@2557
   818
            envelope->dwFadeTime = hap_ramp->fade_length * 1000;
bobbens@2557
   819
         }
bobbens@2520
   820
bobbens@2520
   821
         break;
bobbens@2520
   822
bobbens@2535
   823
      case SDL_HAPTIC_CUSTOM:
bobbens@2535
   824
         hap_custom = &src->custom;
bobbens@2535
   825
         custom = SDL_malloc(sizeof(FFCUSTOMFORCE));
bobbens@2535
   826
         if (custom == NULL) {
bobbens@2535
   827
            SDL_OutOfMemory();
bobbens@2535
   828
            return -1;
bobbens@2535
   829
         }
bobbens@2535
   830
         SDL_memset(custom, 0, sizeof(FFCUSTOMFORCE));
bobbens@2535
   831
bobbens@2535
   832
         /* Specifics */
bobbens@2535
   833
         custom->cChannels = hap_custom->channels;
bobbens@2535
   834
         custom->dwSamplePeriod = hap_custom->period * 1000;
bobbens@2535
   835
         custom->cSamples = hap_custom->samples;
bobbens@2535
   836
         custom->rglForceData = SDL_malloc(sizeof(LONG)*custom->cSamples*custom->cChannels);
bobbens@2535
   837
         for (i=0; i<hap_custom->samples*hap_custom->channels; i++) { /* Copy data. */
bobbens@2535
   838
            custom->rglForceData[i] = CONVERT(hap_custom->data[i]);
bobbens@2535
   839
         }
bobbens@2535
   840
         dest->cbTypeSpecificParams = sizeof(FFCUSTOMFORCE);
bobbens@2535
   841
         dest->lpvTypeSpecificParams = custom;
bobbens@2535
   842
bobbens@2535
   843
         /* Generics */
bobbens@2535
   844
         dest->dwDuration = hap_custom->length * 1000; /* In microseconds. */
bobbens@2554
   845
         dest->dwTriggerButton = FFGetTriggerButton(hap_custom->button);
bobbens@2535
   846
         dest->dwTriggerRepeatInterval = hap_custom->interval;
bobbens@2535
   847
         dest->dwStartDelay = hap_custom->delay * 1000; /* In microseconds. */
bobbens@2535
   848
bobbens@2535
   849
         /* Direction. */
bobbens@2535
   850
         if (SDL_SYS_SetDirection(dest, &hap_custom->direction, dest->cAxes) < 0) {
bobbens@2535
   851
            return -1;
bobbens@2535
   852
         }
bobbens@2535
   853
         
bobbens@2535
   854
         /* Envelope */
bobbens@2557
   855
         if (envelope->dwAttackTime == 0) {
bobbens@2557
   856
            envelope->dwAttackLevel = custom->dwMagnitude
bobbens@2557
   857
         }
bobbens@2557
   858
         else {
bobbens@2557
   859
            envelope->dwAttackLevel = CONVERT(hap_custom->attack_level);
bobbens@2557
   860
            envelope->dwAttackTime = hap_custom->attack_length * 1000;
bobbens@2557
   861
         }
bobbens@2557
   862
         if (envelope->dwFadeTime == 0) {
bobbens@2557
   863
            envelope->dwFadeLevel = custom->dwMagnitude
bobbens@2557
   864
         }
bobbens@2557
   865
         else {
bobbens@2557
   866
            envelope->dwFadeLevel = CONVERT(hap_custom->fade_level);
bobbens@2557
   867
            envelope->dwFadeTime = hap_custom->fade_length * 1000;
bobbens@2557
   868
         }
bobbens@2535
   869
bobbens@2535
   870
         break;
bobbens@2535
   871
bobbens@2520
   872
bobbens@2520
   873
      default:
bobbens@2520
   874
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2520
   875
         return -1;
bobbens@2520
   876
   }
bobbens@2520
   877
bobbens@2520
   878
   return 0;
bobbens@2520
   879
}
bobbens@2520
   880
bobbens@2520
   881
bobbens@2520
   882
/*
bobbens@2527
   883
 * Frees an FFEFFECT allocated by SDL_SYS_ToFFEFFECT.
bobbens@2527
   884
 */
bobbens@2531
   885
static void
bobbens@2535
   886
SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect, int type )
bobbens@2527
   887
{
bobbens@2535
   888
   FFCUSTOMFORCE *custom;
bobbens@2535
   889
bobbens@2527
   890
   if (effect->lpEnvelope != NULL) {
bobbens@2527
   891
      SDL_free(effect->lpEnvelope);
bobbens@2527
   892
      effect->lpEnvelope = NULL;
bobbens@2527
   893
   }
bobbens@2527
   894
   if (effect->rgdwAxes != NULL) {
bobbens@2527
   895
      SDL_free(effect->rgdwAxes);
bobbens@2527
   896
      effect->rgdwAxes = NULL;
bobbens@2527
   897
   }
bobbens@2527
   898
   if (effect->lpvTypeSpecificParams != NULL) {
bobbens@2535
   899
      if (type == SDL_HAPTIC_CUSTOM) { /* Must free the custom data. */
bobbens@2535
   900
         custom = (FFCUSTOMFORCE*) effect->lpvTypeSpecificParams;
bobbens@2535
   901
         SDL_free(custom->rglForceData);
bobbens@2535
   902
         custom->rglForceData = NULL;
bobbens@2535
   903
      }
bobbens@2527
   904
      SDL_free(effect->lpvTypeSpecificParams);
bobbens@2527
   905
      effect->lpvTypeSpecificParams = NULL;
bobbens@2527
   906
   }
bobbens@2527
   907
   if (effect->rglDirection != NULL) {
bobbens@2527
   908
      SDL_free(effect->rglDirection);
bobbens@2527
   909
      effect->rglDirection = NULL;
bobbens@2527
   910
   }
bobbens@2527
   911
}
bobbens@2527
   912
bobbens@2527
   913
bobbens@2527
   914
/*
bobbens@2520
   915
 * Gets the effect type from the generic SDL haptic effect wrapper.
bobbens@2520
   916
 */
bobbens@2531
   917
CFUUIDRef
bobbens@2552
   918
SDL_SYS_HapticEffectType( Uint16 type )
bobbens@2520
   919
{
bobbens@2552
   920
   switch (type) {
bobbens@2520
   921
      case SDL_HAPTIC_CONSTANT:
bobbens@2520
   922
         return kFFEffectType_ConstantForce_ID;
bobbens@2520
   923
bobbens@2520
   924
      case SDL_HAPTIC_RAMP:
bobbens@2520
   925
         return kFFEffectType_RampForce_ID;
bobbens@2520
   926
bobbens@2520
   927
      case SDL_HAPTIC_SQUARE:
bobbens@2520
   928
         return kFFEffectType_Square_ID;
bobbens@2520
   929
bobbens@2520
   930
      case SDL_HAPTIC_SINE:
bobbens@2520
   931
         return kFFEffectType_Sine_ID;
bobbens@2520
   932
bobbens@2521
   933
      case SDL_HAPTIC_TRIANGLE:
bobbens@2520
   934
         return kFFEffectType_Triangle_ID;
bobbens@2520
   935
bobbens@2520
   936
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2520
   937
         return kFFEffectType_SawtoothUp_ID;
bobbens@2520
   938
bobbens@2520
   939
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2520
   940
         return kFFEffectType_SawtoothDown_ID;
bobbens@2520
   941
bobbens@2520
   942
      case SDL_HAPTIC_SPRING:
bobbens@2520
   943
         return kFFEffectType_Spring_ID;
bobbens@2520
   944
bobbens@2520
   945
      case SDL_HAPTIC_DAMPER:
bobbens@2520
   946
         return kFFEffectType_Damper_ID;
bobbens@2520
   947
bobbens@2520
   948
      case SDL_HAPTIC_INERTIA:
bobbens@2520
   949
         return kFFEffectType_Inertia_ID;
bobbens@2520
   950
bobbens@2520
   951
      case SDL_HAPTIC_FRICTION:
bobbens@2520
   952
         return kFFEffectType_Friction_ID;
bobbens@2520
   953
bobbens@2520
   954
      case SDL_HAPTIC_CUSTOM:
bobbens@2520
   955
         return kFFEffectType_CustomForce_ID;
bobbens@2520
   956
bobbens@2520
   957
      default:
bobbens@2520
   958
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2520
   959
         return NULL;
bobbens@2520
   960
   }
bobbens@2520
   961
}
bobbens@2520
   962
bobbens@2520
   963
bobbens@2520
   964
/*
bobbens@2520
   965
 * Creates a new haptic effect.
bobbens@2520
   966
 */
bobbens@2520
   967
int
bobbens@2520
   968
SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2520
   969
      SDL_HapticEffect * base)
bobbens@2520
   970
{
bobbens@2520
   971
   HRESULT ret;
bobbens@2520
   972
   CFUUIDRef type;
bobbens@2520
   973
bobbens@2520
   974
   /* Alloc the effect. */
bobbens@2520
   975
   effect->hweffect = (struct haptic_hweffect *)
bobbens@2520
   976
         SDL_malloc(sizeof(struct haptic_hweffect));
bobbens@2520
   977
   if (effect->hweffect == NULL) {
bobbens@2520
   978
      SDL_OutOfMemory();
bobbens@2527
   979
      goto err_hweffect;
bobbens@2520
   980
   }
bobbens@2520
   981
bobbens@2520
   982
   /* Get the type. */
bobbens@2553
   983
   type = SDL_SYS_HapticEffectType(base->type);
bobbens@2520
   984
   if (type == NULL) {
bobbens@2527
   985
      goto err_hweffect;
bobbens@2520
   986
   }
bobbens@2520
   987
bobbens@2520
   988
   /* Get the effect. */
bobbens@2538
   989
   if (SDL_SYS_ToFFEFFECT(haptic, &effect->hweffect->effect, base) < 0) {
bobbens@2527
   990
      goto err_effectdone;
bobbens@2520
   991
   }
bobbens@2520
   992
bobbens@2527
   993
   /* Create the actual effect. */
bobbens@2538
   994
   ret = FFDeviceCreateEffect(haptic->hwdata->device, type,
bobbens@2538
   995
         &effect->hweffect->effect, &effect->hweffect->ref);
bobbens@2527
   996
   if (ret != FF_OK) {
bobbens@2541
   997
      SDL_SetError("Haptic: Unable to create effect: %s.", FFStrError(ret));
bobbens@2527
   998
      goto err_effectdone;
bobbens@2527
   999
   }
bobbens@2527
  1000
bobbens@2527
  1001
   return 0;
bobbens@2527
  1002
bobbens@2527
  1003
err_effectdone:
bobbens@2538
  1004
   SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, base->type);
bobbens@2527
  1005
err_hweffect:
bobbens@2527
  1006
   if (effect->hweffect != NULL) {
bobbens@2527
  1007
      SDL_free(effect->hweffect);
bobbens@2527
  1008
      effect->hweffect = NULL;
bobbens@2527
  1009
   }
bobbens@2527
  1010
   return -1;
bobbens@2520
  1011
}
bobbens@2520
  1012
bobbens@2520
  1013
bobbens@2520
  1014
/*
bobbens@2520
  1015
 * Updates an effect.
bobbens@2520
  1016
 */
bobbens@2531
  1017
int
bobbens@2531
  1018
SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
bobbens@2520
  1019
      struct haptic_effect * effect, SDL_HapticEffect * data)
bobbens@2520
  1020
{
bobbens@2538
  1021
   HRESULT ret;
bobbens@2538
  1022
   FFEffectParameterFlag flags;
bobbens@2538
  1023
   FFEFFECT temp;
bobbens@2538
  1024
bobbens@2538
  1025
   /* Get the effect. */
bobbens@2538
  1026
   SDL_memset(&temp, 0, sizeof(FFEFFECT));
bobbens@2538
  1027
   if (SDL_SYS_ToFFEFFECT(haptic, &temp, data) < 0) {
bobbens@2538
  1028
      goto err_update;
bobbens@2538
  1029
   }
bobbens@2538
  1030
bobbens@2538
  1031
   /* Set the flags.  Might be worthwhile to diff temp with loaded effect and
bobbens@2538
  1032
    *  only change those parameters. */
bobbens@2538
  1033
   flags = FFEP_ALLPARAMS;
bobbens@2538
  1034
bobbens@2538
  1035
   /* Create the actual effect. */
bobbens@2542
  1036
   ret = FFEffectSetParameters(effect->hweffect->ref, &temp, flags);
bobbens@2538
  1037
   if (ret != FF_OK) {
bobbens@2541
  1038
      SDL_SetError("Haptic: Unable to update effect: %s.", FFStrError(ret));
bobbens@2538
  1039
      goto err_update;
bobbens@2538
  1040
   }
bobbens@2538
  1041
bobbens@2538
  1042
   /* Copy it over. */
bobbens@2538
  1043
   SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, data->type);
bobbens@2538
  1044
   SDL_memcpy(&effect->hweffect->effect, &temp, sizeof(FFEFFECT));
bobbens@2538
  1045
bobbens@2538
  1046
   return 0;
bobbens@2538
  1047
bobbens@2538
  1048
err_update:
bobbens@2538
  1049
   SDL_SYS_HapticFreeFFEFFECT(&temp, data->type);
bobbens@2520
  1050
   return -1;
bobbens@2520
  1051
}
bobbens@2520
  1052
bobbens@2520
  1053
bobbens@2520
  1054
/*
bobbens@2520
  1055
 * Runs an effect.
bobbens@2520
  1056
 */
bobbens@2520
  1057
int
bobbens@2520
  1058
SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2520
  1059
                        Uint32 iterations)
bobbens@2520
  1060
{
bobbens@2520
  1061
   HRESULT ret;
bobbens@2520
  1062
   Uint32 iter;
bobbens@2520
  1063
bobbens@2520
  1064
   /* Check if it's infinite. */
bobbens@2520
  1065
   if (iterations == SDL_HAPTIC_INFINITY) {
bobbens@2521
  1066
      iter = FF_INFINITE;
bobbens@2520
  1067
   }
bobbens@2520
  1068
   else
bobbens@2520
  1069
      iter = iterations;
bobbens@2520
  1070
bobbens@2520
  1071
   /* Run the effect. */
bobbens@2520
  1072
   ret = FFEffectStart(effect->hweffect->ref, iter, 0);
bobbens@2520
  1073
   if (ret != FF_OK) {
bobbens@2541
  1074
      SDL_SetError("Haptic: Unable to run the effect: %s.", FFStrError(ret));
bobbens@2520
  1075
      return -1;
bobbens@2520
  1076
   }
bobbens@2520
  1077
bobbens@2520
  1078
   return 0;
bobbens@2520
  1079
}
bobbens@2520
  1080
bobbens@2520
  1081
bobbens@2520
  1082
/*
bobbens@2520
  1083
 * Stops an effect.
bobbens@2520
  1084
 */
bobbens@2520
  1085
int
bobbens@2520
  1086
SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
  1087
{
bobbens@2520
  1088
   HRESULT ret;
bobbens@2520
  1089
bobbens@2520
  1090
   ret = FFEffectStop(effect->hweffect->ref);
bobbens@2520
  1091
   if (ret != FF_OK) {
bobbens@2541
  1092
      SDL_SetError("Haptic: Unable to stop the effect: %s.", FFStrError(ret));
bobbens@2520
  1093
      return -1;
bobbens@2520
  1094
   }
bobbens@2520
  1095
bobbens@2520
  1096
   return 0;
bobbens@2520
  1097
}
bobbens@2520
  1098
bobbens@2520
  1099
bobbens@2520
  1100
/*
bobbens@2520
  1101
 * Frees the effect.
bobbens@2520
  1102
 */
bobbens@2520
  1103
void
bobbens@2520
  1104
SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
  1105
{
bobbens@2520
  1106
   HRESULT ret;
bobbens@2520
  1107
bobbens@2520
  1108
   ret = FFDeviceReleaseEffect(haptic->hwdata->device, effect->hweffect->ref);
bobbens@2520
  1109
   if (ret != FF_OK) {
bobbens@2541
  1110
      SDL_SetError("Haptic: Error removing the effect from the device: %s.",
bobbens@2541
  1111
                   FFStrError(ret));
bobbens@2520
  1112
   }
bobbens@2520
  1113
   SDL_free(effect->hweffect->effect.lpvTypeSpecificParams);
bobbens@2520
  1114
   effect->hweffect->effect.lpvTypeSpecificParams = NULL;
bobbens@2520
  1115
   SDL_free(effect->hweffect);
bobbens@2520
  1116
   effect->hweffect = NULL;
bobbens@2520
  1117
}
bobbens@2520
  1118
bobbens@2520
  1119
bobbens@2520
  1120
/*
bobbens@2520
  1121
 * Gets the status of a haptic effect.
bobbens@2520
  1122
 */
bobbens@2520
  1123
int
bobbens@2520
  1124
SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
  1125
{
bobbens@2520
  1126
   HRESULT ret;
bobbens@2520
  1127
   FFEffectStatusFlag status;
bobbens@2520
  1128
bobbens@2521
  1129
   ret = FFEffectGetEffectStatus(effect->hweffect->ref, &status);
bobbens@2520
  1130
   if (ret != FF_OK) {
bobbens@2541
  1131
      SDL_SetError("Haptic: Unable to get effect status: %s.", FFStrError(ret));
bobbens@2520
  1132
      return -1;
bobbens@2520
  1133
   }
bobbens@2520
  1134
bobbens@2520
  1135
   if (status == 0) return SDL_FALSE;
bobbens@2520
  1136
   return SDL_TRUE; /* Assume it's playing or emulated. */
bobbens@2520
  1137
}
bobbens@2520
  1138
bobbens@2520
  1139
bobbens@2520
  1140
/*
bobbens@2520
  1141
 * Sets the gain.
bobbens@2520
  1142
 */
bobbens@2520
  1143
int
bobbens@2520
  1144
SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain)
bobbens@2520
  1145
{
bobbens@2520
  1146
   HRESULT ret;
bobbens@2520
  1147
   Uint32 val;
bobbens@2520
  1148
bobbens@2520
  1149
   val = gain * 100; /* Mac OS X uses 0 to 10,000 */
bobbens@2520
  1150
   ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device, FFPROP_FFGAIN, &val);
bobbens@2520
  1151
   if (ret != FF_OK) {
bobbens@2541
  1152
      SDL_SetError("Haptic: Error setting gain: %s.", FFStrError(ret));
bobbens@2520
  1153
      return -1;
bobbens@2520
  1154
   }
bobbens@2520
  1155
bobbens@2520
  1156
   return 0;
bobbens@2520
  1157
}
bobbens@2520
  1158
bobbens@2520
  1159
bobbens@2520
  1160
/*
bobbens@2520
  1161
 * Sets the autocentering.
bobbens@2520
  1162
 */
bobbens@2520
  1163
int
bobbens@2520
  1164
SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
bobbens@2520
  1165
{
bobbens@2520
  1166
   HRESULT ret;
bobbens@2520
  1167
   Uint32 val;
bobbens@2520
  1168
bobbens@2520
  1169
   /* Mac OS X only has 0 (off) and 1 (on) */
bobbens@2520
  1170
   if (autocenter == 0) val = 0;
bobbens@2520
  1171
   else val = 1;
bobbens@2520
  1172
bobbens@2520
  1173
   ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device,
bobbens@2521
  1174
               FFPROP_AUTOCENTER, &val);
bobbens@2520
  1175
   if (ret != FF_OK) {
bobbens@2541
  1176
      SDL_SetError("Haptic: Error setting autocenter: %s.", FFStrError(ret));
bobbens@2520
  1177
      return -1;
bobbens@2520
  1178
   }
bobbens@2520
  1179
  
bobbens@2520
  1180
   return 0;
bobbens@2520
  1181
bobbens@2520
  1182
}
bobbens@2520
  1183
bobbens@2520
  1184
bobbens@2541
  1185
#endif /* SDL_HAPTIC_IOKIT */