src/haptic/darwin/SDL_syshaptic.c
author Edgar Simo <bobbens@gmail.com>
Wed, 30 Jul 2008 14:48:34 +0000
branchgsoc2008_force_feedback
changeset 2554 2681a04c2d3d
parent 2553 3f853f075bc0
child 2555 f5bcc926bac4
permissions -rw-r--r--
Warn about using button triggers.
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@2554
   526
   if (hap_constant->button != 0)
bobbens@2554
   527
      dwTriggerButton = FFJOFS_BUTTON(hap_constant->button);
bobbens@2554
   528
bobbens@2554
   529
   return dwTriggerButton;
bobbens@2554
   530
}
bobbens@2554
   531
bobbens@2554
   532
bobbens@2554
   533
/*
bobbens@2520
   534
 * Sets the direction.
bobbens@2520
   535
 */
bobbens@2520
   536
static int
bobbens@2529
   537
SDL_SYS_SetDirection( FFEFFECT * effect, SDL_HapticDirection *dir, int naxes )
bobbens@2520
   538
{
bobbens@2521
   539
   LONG *rglDir;
bobbens@2527
   540
bobbens@2527
   541
   /* Handle no axes a part. */
bobbens@2528
   542
   if (naxes == 0) {
bobbens@2527
   543
      effect->rglDirection = NULL;
bobbens@2527
   544
      return 0;
bobbens@2527
   545
   }
bobbens@2527
   546
bobbens@2527
   547
   /* Has axes. */
bobbens@2529
   548
   rglDir = SDL_malloc( sizeof(LONG) * naxes );
bobbens@2527
   549
   if (rglDir == NULL) {
bobbens@2520
   550
      SDL_OutOfMemory();
bobbens@2520
   551
      return -1;
bobbens@2520
   552
   }
bobbens@2529
   553
   SDL_memset( rglDir, 0, sizeof(LONG) * naxes );
bobbens@2521
   554
   effect->rglDirection = rglDir;
bobbens@2520
   555
bobbens@2520
   556
   switch (dir->type) {
bobbens@2520
   557
      case SDL_HAPTIC_POLAR:
bobbens@2520
   558
         effect->dwFlags |= FFEFF_POLAR;
bobbens@2521
   559
         rglDir[0] = dir->dir[0];
bobbens@2520
   560
         return 0;
bobbens@2520
   561
      case SDL_HAPTIC_CARTESIAN:
bobbens@2522
   562
         effect->dwFlags |= FFEFF_CARTESIAN;
bobbens@2521
   563
         rglDir[0] = dir->dir[0];
bobbens@2521
   564
         rglDir[1] = dir->dir[1];
bobbens@2521
   565
         rglDir[2] = dir->dir[2];
bobbens@2520
   566
         return 0;
bobbens@2521
   567
      case SDL_HAPTIC_SPHERICAL:
bobbens@2522
   568
         effect->dwFlags |= FFEFF_SPHERICAL;
bobbens@2521
   569
         rglDir[0] = dir->dir[0];
bobbens@2521
   570
         rglDir[1] = dir->dir[1];
bobbens@2521
   571
         rglDir[2] = dir->dir[2];
bobbens@2520
   572
         return 0;
bobbens@2520
   573
bobbens@2520
   574
      default:
bobbens@2520
   575
         SDL_SetError("Haptic: Unknown direction type.");
bobbens@2520
   576
         return -1;
bobbens@2520
   577
   }
bobbens@2520
   578
}
bobbens@2520
   579
bobbens@2520
   580
#define CONVERT(x)   (((x)*10000) / 0xFFFF )
bobbens@2520
   581
/*
bobbens@2527
   582
 * Creates the FFEFFECT from a SDL_HapticEffect.
bobbens@2520
   583
 */
bobbens@2520
   584
static int
bobbens@2527
   585
SDL_SYS_ToFFEFFECT( SDL_Haptic * haptic, FFEFFECT * dest, SDL_HapticEffect * src )
bobbens@2520
   586
{
bobbens@2530
   587
   int i;
bobbens@2520
   588
   FFCONSTANTFORCE *constant;
bobbens@2520
   589
   FFPERIODIC *periodic;
bobbens@2530
   590
   FFCONDITION *condition; /* Actually an array of conditions - one per axis. */
bobbens@2520
   591
   FFRAMPFORCE *ramp;
bobbens@2520
   592
   FFCUSTOMFORCE *custom;
bobbens@2522
   593
   FFENVELOPE *envelope;
bobbens@2520
   594
   SDL_HapticConstant *hap_constant;
bobbens@2521
   595
   SDL_HapticPeriodic *hap_periodic;
bobbens@2520
   596
   SDL_HapticCondition *hap_condition;
bobbens@2520
   597
   SDL_HapticRamp *hap_ramp;
bobbens@2535
   598
   SDL_HapticCustom *hap_custom;
bobbens@2527
   599
   DWORD *axes;
bobbens@2520
   600
bobbens@2520
   601
   /* Set global stuff. */
bobbens@2520
   602
   SDL_memset(dest, 0, sizeof(FFEFFECT));
bobbens@2520
   603
   dest->dwSize = sizeof(FFEFFECT); /* Set the structure size. */
bobbens@2520
   604
   dest->dwSamplePeriod = 0; /* Not used by us. */
bobbens@2520
   605
   dest->dwGain = 10000; /* Gain is set globally, not locally. */
bobbens@2522
   606
bobbens@2522
   607
   /* Envelope. */
bobbens@2522
   608
   envelope = SDL_malloc( sizeof(FFENVELOPE) );
bobbens@2522
   609
   if (envelope == NULL) {
bobbens@2522
   610
      SDL_OutOfMemory();
bobbens@2522
   611
      return -1;
bobbens@2522
   612
   }
bobbens@2522
   613
   SDL_memset(envelope, 0, sizeof(FFENVELOPE));
bobbens@2522
   614
   dest->lpEnvelope = envelope;
bobbens@2522
   615
   envelope->dwSize = sizeof(FFENVELOPE); /* Always should be this. */
bobbens@2520
   616
bobbens@2527
   617
   /* Axes. */
bobbens@2527
   618
   dest->cAxes = haptic->naxes;
bobbens@2527
   619
   if (dest->cAxes > 0) {
bobbens@2527
   620
      axes = SDL_malloc(sizeof(DWORD) * dest->cAxes);
bobbens@2527
   621
      if (axes == NULL) {
bobbens@2527
   622
         SDL_OutOfMemory();
bobbens@2527
   623
         return -1;
bobbens@2527
   624
      }
bobbens@2527
   625
      axes[0] = FFJOFS_X; /* Always at least one axis. */
bobbens@2527
   626
      if (dest->cAxes > 1) {
bobbens@2527
   627
         axes[1] = FFJOFS_Y;
bobbens@2527
   628
      }
bobbens@2527
   629
      if (dest->cAxes > 2) {
bobbens@2527
   630
         axes[2] = FFJOFS_Z;
bobbens@2527
   631
      }
bobbens@2527
   632
      dest->rgdwAxes = axes;
bobbens@2527
   633
   }
bobbens@2527
   634
bobbens@2527
   635
bobbens@2530
   636
   /* The big type handling switch, even bigger then linux's version. */
bobbens@2520
   637
   switch (src->type) {
bobbens@2520
   638
      case SDL_HAPTIC_CONSTANT:
bobbens@2520
   639
         hap_constant = &src->constant;
bobbens@2520
   640
         constant = SDL_malloc( sizeof(FFCONSTANTFORCE) );
bobbens@2527
   641
         if (constant == NULL) {
bobbens@2527
   642
            SDL_OutOfMemory();
bobbens@2527
   643
            return -1;
bobbens@2527
   644
         }
bobbens@2535
   645
         SDL_memset(constant, 0, sizeof(FFCONSTANTFORCE));
bobbens@2520
   646
bobbens@2520
   647
         /* Specifics */
bobbens@2520
   648
         constant->lMagnitude = CONVERT(hap_constant->level);
bobbens@2520
   649
         dest->cbTypeSpecificParams = sizeof(FFCONSTANTFORCE); 
bobbens@2520
   650
         dest->lpvTypeSpecificParams = constant;
bobbens@2520
   651
bobbens@2520
   652
         /* Generics */
bobbens@2521
   653
         dest->dwDuration = hap_constant->length * 1000; /* In microseconds. */
bobbens@2554
   654
         dest->dwTriggerButton = FFGetTriggerButton(hap_constant->button);
bobbens@2520
   655
         dest->dwTriggerRepeatInterval = hap_constant->interval;
bobbens@2521
   656
         dest->dwStartDelay = hap_constant->delay * 1000; /* In microseconds. */
bobbens@2520
   657
bobbens@2520
   658
         /* Direction. */
bobbens@2522
   659
         if (SDL_SYS_SetDirection(dest, &hap_constant->direction, dest->cAxes) < 0) {
bobbens@2520
   660
            return -1;
bobbens@2520
   661
         }
bobbens@2520
   662
         
bobbens@2520
   663
         /* Envelope */
bobbens@2522
   664
         envelope->dwAttackLevel = CONVERT(hap_constant->attack_level);
bobbens@2522
   665
         envelope->dwAttackTime = hap_constant->attack_length * 1000;
bobbens@2522
   666
         envelope->dwFadeLevel = CONVERT(hap_constant->fade_level);
bobbens@2522
   667
         envelope->dwFadeTime = hap_constant->fade_length * 1000;
bobbens@2520
   668
bobbens@2520
   669
         break;
bobbens@2520
   670
bobbens@2520
   671
      case SDL_HAPTIC_SINE:
bobbens@2520
   672
      case SDL_HAPTIC_SQUARE:
bobbens@2520
   673
      case SDL_HAPTIC_TRIANGLE:
bobbens@2520
   674
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2520
   675
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2522
   676
         hap_periodic = &src->periodic;
bobbens@2527
   677
         periodic = SDL_malloc(sizeof(FFPERIODIC));
bobbens@2527
   678
         if (periodic == NULL) {
bobbens@2527
   679
            SDL_OutOfMemory();
bobbens@2527
   680
            return -1;
bobbens@2527
   681
         }
bobbens@2535
   682
         SDL_memset(periodic, 0, sizeof(FFPERIODIC));
bobbens@2527
   683
bobbens@2527
   684
         /* Specifics */
bobbens@2527
   685
         periodic->dwMagnitude = CONVERT(hap_periodic->magnitude);
bobbens@2527
   686
         periodic->lOffset = CONVERT(hap_periodic->offset);
bobbens@2527
   687
         periodic->dwPhase = hap_periodic->phase;
bobbens@2527
   688
         periodic->dwPeriod = hap_periodic->period * 1000;
bobbens@2527
   689
         dest->cbTypeSpecificParams = sizeof(FFPERIODIC);
bobbens@2527
   690
         dest->lpvTypeSpecificParams = periodic;
bobbens@2527
   691
bobbens@2527
   692
         /* Generics */
bobbens@2527
   693
         dest->dwDuration = hap_periodic->length * 1000; /* In microseconds. */
bobbens@2554
   694
         dest->dwTriggerButton = FFGetTriggerButton(hap_periodic->button);
bobbens@2527
   695
         dest->dwTriggerRepeatInterval = hap_periodic->interval;
bobbens@2527
   696
         dest->dwStartDelay = hap_periodic->delay * 1000; /* In microseconds. */
bobbens@2527
   697
         
bobbens@2527
   698
         /* Direction. */
bobbens@2527
   699
         if (SDL_SYS_SetDirection(dest, &hap_periodic->direction, dest->cAxes) < 0) {
bobbens@2527
   700
            return -1;
bobbens@2527
   701
         }
bobbens@2527
   702
         
bobbens@2527
   703
         /* Envelope */
bobbens@2527
   704
         envelope->dwAttackLevel = CONVERT(hap_periodic->attack_level);
bobbens@2527
   705
         envelope->dwAttackTime = hap_periodic->attack_length * 1000;
bobbens@2527
   706
         envelope->dwFadeLevel = CONVERT(hap_periodic->fade_level);
bobbens@2527
   707
         envelope->dwFadeTime = hap_periodic->fade_length * 1000;
bobbens@2520
   708
bobbens@2520
   709
         break;
bobbens@2520
   710
bobbens@2520
   711
      case SDL_HAPTIC_SPRING:
bobbens@2520
   712
      case SDL_HAPTIC_DAMPER:
bobbens@2520
   713
      case SDL_HAPTIC_INERTIA:
bobbens@2520
   714
      case SDL_HAPTIC_FRICTION:
bobbens@2522
   715
         hap_condition = &src->condition;
bobbens@2530
   716
         condition = SDL_malloc(sizeof(FFCONDITION) * dest->cAxes);
bobbens@2530
   717
         if (condition == NULL) {
bobbens@2530
   718
            SDL_OutOfMemory();
bobbens@2530
   719
            return -1;
bobbens@2530
   720
         }
bobbens@2535
   721
         SDL_memset(condition, 0, sizeof(FFCONDITION));
bobbens@2530
   722
bobbens@2530
   723
         /* Specifics */
bobbens@2530
   724
         for (i=0; i<dest->cAxes; i++) {
bobbens@2531
   725
            condition[i].lOffset = CONVERT(hap_condition->center[i]);
bobbens@2531
   726
            condition[i].lPositiveCoefficient = CONVERT(hap_condition->right_coeff[i]);
bobbens@2531
   727
            condition[i].lNegativeCoefficient = CONVERT(hap_condition->left_coeff[i]);
bobbens@2531
   728
            condition[i].dwPositiveSaturation = CONVERT(hap_condition->right_sat[i]);
bobbens@2531
   729
            condition[i].dwNegativeSaturation = CONVERT(hap_condition->left_sat[i]);
bobbens@2531
   730
            condition[i].lDeadBand = CONVERT(hap_condition->deadband[i]);
bobbens@2530
   731
         }
bobbens@2530
   732
         dest->cbTypeSpecificParams = sizeof(FFCONDITION) * dest->cAxes;
bobbens@2530
   733
         dest->lpvTypeSpecificParams = condition;
bobbens@2530
   734
bobbens@2530
   735
         /* Generics */
bobbens@2531
   736
         dest->dwDuration = hap_condition->length * 1000; /* In microseconds. */
bobbens@2554
   737
         dest->dwTriggerButton = FFGetTriggerButton(hap_condition->button);
bobbens@2531
   738
         dest->dwTriggerRepeatInterval = hap_condition->interval;
bobbens@2531
   739
         dest->dwStartDelay = hap_condition->delay * 1000; /* In microseconds. */
bobbens@2530
   740
bobbens@2530
   741
         /* Direction. */
bobbens@2531
   742
         if (SDL_SYS_SetDirection(dest, &hap_condition->direction, dest->cAxes) < 0) {
bobbens@2530
   743
            return -1;                
bobbens@2530
   744
         }                            
bobbens@2530
   745
                                      
bobbens@2532
   746
         /* Envelope */
bobbens@2532
   747
/* TODO Check is envelope actually used.
bobbens@2531
   748
         envelope->dwAttackLevel = CONVERT(hap_condition->attack_level);
bobbens@2531
   749
         envelope->dwAttackTime = hap_condition->attack_length * 1000;
bobbens@2531
   750
         envelope->dwFadeLevel = CONVERT(hap_condition->fade_level);
bobbens@2531
   751
         envelope->dwFadeTime = hap_condition->fade_length * 1000;
bobbens@2532
   752
*/
bobbens@2520
   753
bobbens@2520
   754
         break;
bobbens@2520
   755
bobbens@2520
   756
      case SDL_HAPTIC_RAMP:
bobbens@2522
   757
         hap_ramp = &src->ramp;
bobbens@2533
   758
         ramp = SDL_malloc(sizeof(FFRAMPFORCE));
bobbens@2533
   759
         if (ramp == NULL) {
bobbens@2533
   760
            SDL_OutOfMemory();
bobbens@2533
   761
            return -1;
bobbens@2533
   762
         }
bobbens@2535
   763
         SDL_memset(ramp, 0, sizeof(FFRAMPFORCE));
bobbens@2533
   764
bobbens@2533
   765
         /* Specifics */
bobbens@2534
   766
         ramp->lStart = CONVERT(hap_ramp->start);
bobbens@2533
   767
         ramp->lEnd = CONVERT(hap_ramp->end);
bobbens@2535
   768
         dest->cbTypeSpecificParams = sizeof(FFRAMPFORCE);
bobbens@2535
   769
         dest->lpvTypeSpecificParams = ramp;
bobbens@2533
   770
bobbens@2533
   771
         /* Generics */
bobbens@2533
   772
         dest->dwDuration = hap_ramp->length * 1000; /* In microseconds. */
bobbens@2554
   773
         dest->dwTriggerButton = FFGetTriggerButton(hap_ramp->button);
bobbens@2533
   774
         dest->dwTriggerRepeatInterval = hap_ramp->interval;
bobbens@2533
   775
         dest->dwStartDelay = hap_ramp->delay * 1000; /* In microseconds. */
bobbens@2533
   776
bobbens@2533
   777
         /* Direction. */
bobbens@2533
   778
         if (SDL_SYS_SetDirection(dest, &hap_ramp->direction, dest->cAxes) < 0) {
bobbens@2533
   779
            return -1;
bobbens@2533
   780
         }
bobbens@2533
   781
bobbens@2533
   782
         /* Envelope */
bobbens@2533
   783
         envelope->dwAttackLevel = CONVERT(hap_ramp->attack_level);
bobbens@2533
   784
         envelope->dwAttackTime = hap_ramp->attack_length * 1000;
bobbens@2533
   785
         envelope->dwFadeLevel = CONVERT(hap_ramp->fade_level);
bobbens@2533
   786
         envelope->dwFadeTime = hap_ramp->fade_length * 1000;
bobbens@2520
   787
bobbens@2520
   788
         break;
bobbens@2520
   789
bobbens@2535
   790
      case SDL_HAPTIC_CUSTOM:
bobbens@2535
   791
         hap_custom = &src->custom;
bobbens@2535
   792
         custom = SDL_malloc(sizeof(FFCUSTOMFORCE));
bobbens@2535
   793
         if (custom == NULL) {
bobbens@2535
   794
            SDL_OutOfMemory();
bobbens@2535
   795
            return -1;
bobbens@2535
   796
         }
bobbens@2535
   797
         SDL_memset(custom, 0, sizeof(FFCUSTOMFORCE));
bobbens@2535
   798
bobbens@2535
   799
         /* Specifics */
bobbens@2535
   800
         custom->cChannels = hap_custom->channels;
bobbens@2535
   801
         custom->dwSamplePeriod = hap_custom->period * 1000;
bobbens@2535
   802
         custom->cSamples = hap_custom->samples;
bobbens@2535
   803
         custom->rglForceData = SDL_malloc(sizeof(LONG)*custom->cSamples*custom->cChannels);
bobbens@2535
   804
         for (i=0; i<hap_custom->samples*hap_custom->channels; i++) { /* Copy data. */
bobbens@2535
   805
            custom->rglForceData[i] = CONVERT(hap_custom->data[i]);
bobbens@2535
   806
         }
bobbens@2535
   807
         dest->cbTypeSpecificParams = sizeof(FFCUSTOMFORCE);
bobbens@2535
   808
         dest->lpvTypeSpecificParams = custom;
bobbens@2535
   809
bobbens@2535
   810
         /* Generics */
bobbens@2535
   811
         dest->dwDuration = hap_custom->length * 1000; /* In microseconds. */
bobbens@2554
   812
         dest->dwTriggerButton = FFGetTriggerButton(hap_custom->button);
bobbens@2535
   813
         dest->dwTriggerRepeatInterval = hap_custom->interval;
bobbens@2535
   814
         dest->dwStartDelay = hap_custom->delay * 1000; /* In microseconds. */
bobbens@2535
   815
bobbens@2535
   816
         /* Direction. */
bobbens@2535
   817
         if (SDL_SYS_SetDirection(dest, &hap_custom->direction, dest->cAxes) < 0) {
bobbens@2535
   818
            return -1;
bobbens@2535
   819
         }
bobbens@2535
   820
         
bobbens@2535
   821
         /* Envelope */
bobbens@2535
   822
         envelope->dwAttackLevel = CONVERT(hap_custom->attack_level);
bobbens@2535
   823
         envelope->dwAttackTime = hap_custom->attack_length * 1000;
bobbens@2535
   824
         envelope->dwFadeLevel = CONVERT(hap_custom->fade_level);
bobbens@2535
   825
         envelope->dwFadeTime = hap_custom->fade_length * 1000;
bobbens@2535
   826
bobbens@2535
   827
         break;
bobbens@2535
   828
bobbens@2520
   829
bobbens@2520
   830
      default:
bobbens@2520
   831
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2520
   832
         return -1;
bobbens@2520
   833
   }
bobbens@2520
   834
bobbens@2520
   835
   return 0;
bobbens@2520
   836
}
bobbens@2520
   837
bobbens@2520
   838
bobbens@2520
   839
/*
bobbens@2527
   840
 * Frees an FFEFFECT allocated by SDL_SYS_ToFFEFFECT.
bobbens@2527
   841
 */
bobbens@2531
   842
static void
bobbens@2535
   843
SDL_SYS_HapticFreeFFEFFECT( FFEFFECT * effect, int type )
bobbens@2527
   844
{
bobbens@2535
   845
   FFCUSTOMFORCE *custom;
bobbens@2535
   846
bobbens@2527
   847
   if (effect->lpEnvelope != NULL) {
bobbens@2527
   848
      SDL_free(effect->lpEnvelope);
bobbens@2527
   849
      effect->lpEnvelope = NULL;
bobbens@2527
   850
   }
bobbens@2527
   851
   if (effect->rgdwAxes != NULL) {
bobbens@2527
   852
      SDL_free(effect->rgdwAxes);
bobbens@2527
   853
      effect->rgdwAxes = NULL;
bobbens@2527
   854
   }
bobbens@2527
   855
   if (effect->lpvTypeSpecificParams != NULL) {
bobbens@2535
   856
      if (type == SDL_HAPTIC_CUSTOM) { /* Must free the custom data. */
bobbens@2535
   857
         custom = (FFCUSTOMFORCE*) effect->lpvTypeSpecificParams;
bobbens@2535
   858
         SDL_free(custom->rglForceData);
bobbens@2535
   859
         custom->rglForceData = NULL;
bobbens@2535
   860
      }
bobbens@2527
   861
      SDL_free(effect->lpvTypeSpecificParams);
bobbens@2527
   862
      effect->lpvTypeSpecificParams = NULL;
bobbens@2527
   863
   }
bobbens@2527
   864
   if (effect->rglDirection != NULL) {
bobbens@2527
   865
      SDL_free(effect->rglDirection);
bobbens@2527
   866
      effect->rglDirection = NULL;
bobbens@2527
   867
   }
bobbens@2527
   868
}
bobbens@2527
   869
bobbens@2527
   870
bobbens@2527
   871
/*
bobbens@2520
   872
 * Gets the effect type from the generic SDL haptic effect wrapper.
bobbens@2520
   873
 */
bobbens@2531
   874
CFUUIDRef
bobbens@2552
   875
SDL_SYS_HapticEffectType( Uint16 type )
bobbens@2520
   876
{
bobbens@2552
   877
   switch (type) {
bobbens@2520
   878
      case SDL_HAPTIC_CONSTANT:
bobbens@2520
   879
         return kFFEffectType_ConstantForce_ID;
bobbens@2520
   880
bobbens@2520
   881
      case SDL_HAPTIC_RAMP:
bobbens@2520
   882
         return kFFEffectType_RampForce_ID;
bobbens@2520
   883
bobbens@2520
   884
      case SDL_HAPTIC_SQUARE:
bobbens@2520
   885
         return kFFEffectType_Square_ID;
bobbens@2520
   886
bobbens@2520
   887
      case SDL_HAPTIC_SINE:
bobbens@2520
   888
         return kFFEffectType_Sine_ID;
bobbens@2520
   889
bobbens@2521
   890
      case SDL_HAPTIC_TRIANGLE:
bobbens@2520
   891
         return kFFEffectType_Triangle_ID;
bobbens@2520
   892
bobbens@2520
   893
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2520
   894
         return kFFEffectType_SawtoothUp_ID;
bobbens@2520
   895
bobbens@2520
   896
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2520
   897
         return kFFEffectType_SawtoothDown_ID;
bobbens@2520
   898
bobbens@2520
   899
      case SDL_HAPTIC_SPRING:
bobbens@2520
   900
         return kFFEffectType_Spring_ID;
bobbens@2520
   901
bobbens@2520
   902
      case SDL_HAPTIC_DAMPER:
bobbens@2520
   903
         return kFFEffectType_Damper_ID;
bobbens@2520
   904
bobbens@2520
   905
      case SDL_HAPTIC_INERTIA:
bobbens@2520
   906
         return kFFEffectType_Inertia_ID;
bobbens@2520
   907
bobbens@2520
   908
      case SDL_HAPTIC_FRICTION:
bobbens@2520
   909
         return kFFEffectType_Friction_ID;
bobbens@2520
   910
bobbens@2520
   911
      case SDL_HAPTIC_CUSTOM:
bobbens@2520
   912
         return kFFEffectType_CustomForce_ID;
bobbens@2520
   913
bobbens@2520
   914
      default:
bobbens@2520
   915
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2520
   916
         return NULL;
bobbens@2520
   917
   }
bobbens@2520
   918
}
bobbens@2520
   919
bobbens@2520
   920
bobbens@2520
   921
/*
bobbens@2520
   922
 * Creates a new haptic effect.
bobbens@2520
   923
 */
bobbens@2520
   924
int
bobbens@2520
   925
SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2520
   926
      SDL_HapticEffect * base)
bobbens@2520
   927
{
bobbens@2520
   928
   HRESULT ret;
bobbens@2520
   929
   CFUUIDRef type;
bobbens@2520
   930
bobbens@2520
   931
   /* Alloc the effect. */
bobbens@2520
   932
   effect->hweffect = (struct haptic_hweffect *)
bobbens@2520
   933
         SDL_malloc(sizeof(struct haptic_hweffect));
bobbens@2520
   934
   if (effect->hweffect == NULL) {
bobbens@2520
   935
      SDL_OutOfMemory();
bobbens@2527
   936
      goto err_hweffect;
bobbens@2520
   937
   }
bobbens@2520
   938
bobbens@2520
   939
   /* Get the type. */
bobbens@2553
   940
   type = SDL_SYS_HapticEffectType(base->type);
bobbens@2520
   941
   if (type == NULL) {
bobbens@2527
   942
      goto err_hweffect;
bobbens@2520
   943
   }
bobbens@2520
   944
bobbens@2520
   945
   /* Get the effect. */
bobbens@2538
   946
   if (SDL_SYS_ToFFEFFECT(haptic, &effect->hweffect->effect, base) < 0) {
bobbens@2527
   947
      goto err_effectdone;
bobbens@2520
   948
   }
bobbens@2520
   949
bobbens@2527
   950
   /* Create the actual effect. */
bobbens@2538
   951
   ret = FFDeviceCreateEffect(haptic->hwdata->device, type,
bobbens@2538
   952
         &effect->hweffect->effect, &effect->hweffect->ref);
bobbens@2527
   953
   if (ret != FF_OK) {
bobbens@2541
   954
      SDL_SetError("Haptic: Unable to create effect: %s.", FFStrError(ret));
bobbens@2527
   955
      goto err_effectdone;
bobbens@2527
   956
   }
bobbens@2527
   957
bobbens@2527
   958
   return 0;
bobbens@2527
   959
bobbens@2527
   960
err_effectdone:
bobbens@2538
   961
   SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, base->type);
bobbens@2527
   962
err_hweffect:
bobbens@2527
   963
   if (effect->hweffect != NULL) {
bobbens@2527
   964
      SDL_free(effect->hweffect);
bobbens@2527
   965
      effect->hweffect = NULL;
bobbens@2527
   966
   }
bobbens@2527
   967
   return -1;
bobbens@2520
   968
}
bobbens@2520
   969
bobbens@2520
   970
bobbens@2520
   971
/*
bobbens@2520
   972
 * Updates an effect.
bobbens@2520
   973
 */
bobbens@2531
   974
int
bobbens@2531
   975
SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
bobbens@2520
   976
      struct haptic_effect * effect, SDL_HapticEffect * data)
bobbens@2520
   977
{
bobbens@2538
   978
   HRESULT ret;
bobbens@2538
   979
   FFEffectParameterFlag flags;
bobbens@2538
   980
   FFEFFECT temp;
bobbens@2538
   981
bobbens@2538
   982
   /* Get the effect. */
bobbens@2538
   983
   SDL_memset(&temp, 0, sizeof(FFEFFECT));
bobbens@2538
   984
   if (SDL_SYS_ToFFEFFECT(haptic, &temp, data) < 0) {
bobbens@2538
   985
      goto err_update;
bobbens@2538
   986
   }
bobbens@2538
   987
bobbens@2538
   988
   /* Set the flags.  Might be worthwhile to diff temp with loaded effect and
bobbens@2538
   989
    *  only change those parameters. */
bobbens@2538
   990
   flags = FFEP_ALLPARAMS;
bobbens@2538
   991
bobbens@2538
   992
   /* Create the actual effect. */
bobbens@2542
   993
   ret = FFEffectSetParameters(effect->hweffect->ref, &temp, flags);
bobbens@2538
   994
   if (ret != FF_OK) {
bobbens@2541
   995
      SDL_SetError("Haptic: Unable to update effect: %s.", FFStrError(ret));
bobbens@2538
   996
      goto err_update;
bobbens@2538
   997
   }
bobbens@2538
   998
bobbens@2538
   999
   /* Copy it over. */
bobbens@2538
  1000
   SDL_SYS_HapticFreeFFEFFECT(&effect->hweffect->effect, data->type);
bobbens@2538
  1001
   SDL_memcpy(&effect->hweffect->effect, &temp, sizeof(FFEFFECT));
bobbens@2538
  1002
bobbens@2538
  1003
   return 0;
bobbens@2538
  1004
bobbens@2538
  1005
err_update:
bobbens@2538
  1006
   SDL_SYS_HapticFreeFFEFFECT(&temp, data->type);
bobbens@2520
  1007
   return -1;
bobbens@2520
  1008
}
bobbens@2520
  1009
bobbens@2520
  1010
bobbens@2520
  1011
/*
bobbens@2520
  1012
 * Runs an effect.
bobbens@2520
  1013
 */
bobbens@2520
  1014
int
bobbens@2520
  1015
SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2520
  1016
                        Uint32 iterations)
bobbens@2520
  1017
{
bobbens@2520
  1018
   HRESULT ret;
bobbens@2520
  1019
   Uint32 iter;
bobbens@2520
  1020
bobbens@2520
  1021
   /* Check if it's infinite. */
bobbens@2520
  1022
   if (iterations == SDL_HAPTIC_INFINITY) {
bobbens@2521
  1023
      iter = FF_INFINITE;
bobbens@2520
  1024
   }
bobbens@2520
  1025
   else
bobbens@2520
  1026
      iter = iterations;
bobbens@2520
  1027
bobbens@2520
  1028
   /* Run the effect. */
bobbens@2520
  1029
   ret = FFEffectStart(effect->hweffect->ref, iter, 0);
bobbens@2520
  1030
   if (ret != FF_OK) {
bobbens@2541
  1031
      SDL_SetError("Haptic: Unable to run the effect: %s.", FFStrError(ret));
bobbens@2520
  1032
      return -1;
bobbens@2520
  1033
   }
bobbens@2520
  1034
bobbens@2520
  1035
   return 0;
bobbens@2520
  1036
}
bobbens@2520
  1037
bobbens@2520
  1038
bobbens@2520
  1039
/*
bobbens@2520
  1040
 * Stops an effect.
bobbens@2520
  1041
 */
bobbens@2520
  1042
int
bobbens@2520
  1043
SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
  1044
{
bobbens@2520
  1045
   HRESULT ret;
bobbens@2520
  1046
bobbens@2520
  1047
   ret = FFEffectStop(effect->hweffect->ref);
bobbens@2520
  1048
   if (ret != FF_OK) {
bobbens@2541
  1049
      SDL_SetError("Haptic: Unable to stop the effect: %s.", FFStrError(ret));
bobbens@2520
  1050
      return -1;
bobbens@2520
  1051
   }
bobbens@2520
  1052
bobbens@2520
  1053
   return 0;
bobbens@2520
  1054
}
bobbens@2520
  1055
bobbens@2520
  1056
bobbens@2520
  1057
/*
bobbens@2520
  1058
 * Frees the effect.
bobbens@2520
  1059
 */
bobbens@2520
  1060
void
bobbens@2520
  1061
SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
  1062
{
bobbens@2520
  1063
   HRESULT ret;
bobbens@2520
  1064
bobbens@2520
  1065
   ret = FFDeviceReleaseEffect(haptic->hwdata->device, effect->hweffect->ref);
bobbens@2520
  1066
   if (ret != FF_OK) {
bobbens@2541
  1067
      SDL_SetError("Haptic: Error removing the effect from the device: %s.",
bobbens@2541
  1068
                   FFStrError(ret));
bobbens@2520
  1069
   }
bobbens@2520
  1070
   SDL_free(effect->hweffect->effect.lpvTypeSpecificParams);
bobbens@2520
  1071
   effect->hweffect->effect.lpvTypeSpecificParams = NULL;
bobbens@2520
  1072
   SDL_free(effect->hweffect);
bobbens@2520
  1073
   effect->hweffect = NULL;
bobbens@2520
  1074
}
bobbens@2520
  1075
bobbens@2520
  1076
bobbens@2520
  1077
/*
bobbens@2520
  1078
 * Gets the status of a haptic effect.
bobbens@2520
  1079
 */
bobbens@2520
  1080
int
bobbens@2520
  1081
SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2520
  1082
{
bobbens@2520
  1083
   HRESULT ret;
bobbens@2520
  1084
   FFEffectStatusFlag status;
bobbens@2520
  1085
bobbens@2521
  1086
   ret = FFEffectGetEffectStatus(effect->hweffect->ref, &status);
bobbens@2520
  1087
   if (ret != FF_OK) {
bobbens@2541
  1088
      SDL_SetError("Haptic: Unable to get effect status: %s.", FFStrError(ret));
bobbens@2520
  1089
      return -1;
bobbens@2520
  1090
   }
bobbens@2520
  1091
bobbens@2520
  1092
   if (status == 0) return SDL_FALSE;
bobbens@2520
  1093
   return SDL_TRUE; /* Assume it's playing or emulated. */
bobbens@2520
  1094
}
bobbens@2520
  1095
bobbens@2520
  1096
bobbens@2520
  1097
/*
bobbens@2520
  1098
 * Sets the gain.
bobbens@2520
  1099
 */
bobbens@2520
  1100
int
bobbens@2520
  1101
SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain)
bobbens@2520
  1102
{
bobbens@2520
  1103
   HRESULT ret;
bobbens@2520
  1104
   Uint32 val;
bobbens@2520
  1105
bobbens@2520
  1106
   val = gain * 100; /* Mac OS X uses 0 to 10,000 */
bobbens@2520
  1107
   ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device, FFPROP_FFGAIN, &val);
bobbens@2520
  1108
   if (ret != FF_OK) {
bobbens@2541
  1109
      SDL_SetError("Haptic: Error setting gain: %s.", FFStrError(ret));
bobbens@2520
  1110
      return -1;
bobbens@2520
  1111
   }
bobbens@2520
  1112
bobbens@2520
  1113
   return 0;
bobbens@2520
  1114
}
bobbens@2520
  1115
bobbens@2520
  1116
bobbens@2520
  1117
/*
bobbens@2520
  1118
 * Sets the autocentering.
bobbens@2520
  1119
 */
bobbens@2520
  1120
int
bobbens@2520
  1121
SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
bobbens@2520
  1122
{
bobbens@2520
  1123
   HRESULT ret;
bobbens@2520
  1124
   Uint32 val;
bobbens@2520
  1125
bobbens@2520
  1126
   /* Mac OS X only has 0 (off) and 1 (on) */
bobbens@2520
  1127
   if (autocenter == 0) val = 0;
bobbens@2520
  1128
   else val = 1;
bobbens@2520
  1129
bobbens@2520
  1130
   ret = FFDeviceSetForceFeedbackProperty(haptic->hwdata->device,
bobbens@2521
  1131
               FFPROP_AUTOCENTER, &val);
bobbens@2520
  1132
   if (ret != FF_OK) {
bobbens@2541
  1133
      SDL_SetError("Haptic: Error setting autocenter: %s.", FFStrError(ret));
bobbens@2520
  1134
      return -1;
bobbens@2520
  1135
   }
bobbens@2520
  1136
  
bobbens@2520
  1137
   return 0;
bobbens@2520
  1138
bobbens@2520
  1139
}
bobbens@2520
  1140
bobbens@2520
  1141
bobbens@2541
  1142
#endif /* SDL_HAPTIC_IOKIT */