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