src/haptic/SDL_haptic.c
author Sam Lantinga <slouken@libsdl.org>
Mon, 25 Aug 2008 09:55:03 +0000
changeset 2713 0906692aa6a4
child 3080 4094b4f1c3a1
permissions -rw-r--r--
Final merge of Google Summer of Code 2008 work...

Force Feedback for SDL
by Edgar Simo, mentored by Ryan C. Gordon
slouken@2713
     1
/*
slouken@2713
     2
    SDL - Simple DirectMedia Layer
slouken@2713
     3
    Copyright (C) 2008 Edgar Simo
slouken@2713
     4
slouken@2713
     5
    This library is free software; you can redistribute it and/or
slouken@2713
     6
    modify it under the terms of the GNU Lesser General Public
slouken@2713
     7
    License as published by the Free Software Foundation; either
slouken@2713
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@2713
     9
slouken@2713
    10
    This library is distributed in the hope that it will be useful,
slouken@2713
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@2713
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@2713
    13
    Lesser General Public License for more details.
slouken@2713
    14
slouken@2713
    15
    You should have received a copy of the GNU Lesser General Public
slouken@2713
    16
    License along with this library; if not, write to the Free Software
slouken@2713
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@2713
    18
slouken@2713
    19
    Sam Lantinga
slouken@2713
    20
    slouken@libsdl.org
slouken@2713
    21
*/
slouken@2713
    22
#include "SDL_config.h"
slouken@2713
    23
slouken@2713
    24
#include "SDL_syshaptic.h"
slouken@2713
    25
#include "../joystick/SDL_joystick_c.h" /* For SDL_PrivateJoystickValid */
slouken@2713
    26
slouken@2713
    27
slouken@2713
    28
Uint8 SDL_numhaptics = 0;
slouken@2713
    29
SDL_Haptic **SDL_haptics = NULL;
slouken@2713
    30
slouken@2713
    31
slouken@2713
    32
/*
slouken@2713
    33
 * Initializes the Haptic devices.
slouken@2713
    34
 */
slouken@2713
    35
int
slouken@2713
    36
SDL_HapticInit(void)
slouken@2713
    37
{
slouken@2713
    38
    int arraylen;
slouken@2713
    39
    int status;
slouken@2713
    40
slouken@2713
    41
    SDL_numhaptics = 0;
slouken@2713
    42
    status = SDL_SYS_HapticInit();
slouken@2713
    43
    if (status >= 0) {
slouken@2713
    44
        arraylen = (status + 1) * sizeof(*SDL_haptics);
slouken@2713
    45
        SDL_haptics = (SDL_Haptic **) SDL_malloc(arraylen);
slouken@2713
    46
        if (SDL_haptics == NULL) {      /* Out of memory. */
slouken@2713
    47
            SDL_numhaptics = 0;
slouken@2713
    48
        } else {
slouken@2713
    49
            SDL_memset(SDL_haptics, 0, arraylen);
slouken@2713
    50
            SDL_numhaptics = status;
slouken@2713
    51
        }
slouken@2713
    52
        status = 0;
slouken@2713
    53
    }
slouken@2713
    54
slouken@2713
    55
    return status;
slouken@2713
    56
}
slouken@2713
    57
slouken@2713
    58
slouken@2713
    59
/*
slouken@2713
    60
 * Checks to see if the haptic device is valid
slouken@2713
    61
 */
slouken@2713
    62
static int
slouken@2713
    63
ValidHaptic(SDL_Haptic * haptic)
slouken@2713
    64
{
slouken@2713
    65
    int i;
slouken@2713
    66
    int valid;
slouken@2713
    67
slouken@2713
    68
    valid = 0;
slouken@2713
    69
    for (i = 0; i < SDL_numhaptics; i++) {
slouken@2713
    70
        if (SDL_haptics[i] == haptic) {
slouken@2713
    71
            valid = 1;
slouken@2713
    72
            break;
slouken@2713
    73
        }
slouken@2713
    74
    }
slouken@2713
    75
slouken@2713
    76
    return valid;
slouken@2713
    77
}
slouken@2713
    78
slouken@2713
    79
slouken@2713
    80
/*
slouken@2713
    81
 * Returns the number of available devices.
slouken@2713
    82
 */
slouken@2713
    83
int
slouken@2713
    84
SDL_NumHaptics(void)
slouken@2713
    85
{
slouken@2713
    86
    return SDL_numhaptics;
slouken@2713
    87
}
slouken@2713
    88
slouken@2713
    89
slouken@2713
    90
/*
slouken@2713
    91
 * Gets the name of a Haptic device by index.
slouken@2713
    92
 */
slouken@2713
    93
const char *
slouken@2713
    94
SDL_HapticName(int device_index)
slouken@2713
    95
{
slouken@2713
    96
    if ((device_index < 0) || (device_index >= SDL_numhaptics)) {
slouken@2713
    97
        SDL_SetError("Haptic: There are %d haptic devices available",
slouken@2713
    98
                     SDL_numhaptics);
slouken@2713
    99
        return NULL;
slouken@2713
   100
    }
slouken@2713
   101
    return SDL_SYS_HapticName(device_index);
slouken@2713
   102
}
slouken@2713
   103
slouken@2713
   104
slouken@2713
   105
/*
slouken@2713
   106
 * Opens a Haptic device.
slouken@2713
   107
 */
slouken@2713
   108
SDL_Haptic *
slouken@2713
   109
SDL_HapticOpen(int device_index)
slouken@2713
   110
{
slouken@2713
   111
    int i;
slouken@2713
   112
    SDL_Haptic *haptic;
slouken@2713
   113
slouken@2713
   114
    if ((device_index < 0) || (device_index >= SDL_numhaptics)) {
slouken@2713
   115
        SDL_SetError("Haptic: There are %d haptic devices available",
slouken@2713
   116
                     SDL_numhaptics);
slouken@2713
   117
        return NULL;
slouken@2713
   118
    }
slouken@2713
   119
slouken@2713
   120
    /* If the haptic is already open, return it */
slouken@2713
   121
    for (i = 0; SDL_haptics[i]; i++) {
slouken@2713
   122
        if (device_index == SDL_haptics[i]->index) {
slouken@2713
   123
            haptic = SDL_haptics[i];
slouken@2713
   124
            ++haptic->ref_count;
slouken@2713
   125
            return haptic;
slouken@2713
   126
        }
slouken@2713
   127
    }
slouken@2713
   128
slouken@2713
   129
    /* Create the haptic device */
slouken@2713
   130
    haptic = (SDL_Haptic *) SDL_malloc((sizeof *haptic));
slouken@2713
   131
    if (haptic == NULL) {
slouken@2713
   132
        SDL_OutOfMemory();
slouken@2713
   133
        return NULL;
slouken@2713
   134
    }
slouken@2713
   135
slouken@2713
   136
    /* Initialize the haptic device */
slouken@2713
   137
    SDL_memset(haptic, 0, (sizeof *haptic));
slouken@2713
   138
    haptic->index = device_index;
slouken@2713
   139
    if (SDL_SYS_HapticOpen(haptic) < 0) {
slouken@2713
   140
        SDL_free(haptic);
slouken@2713
   141
        return NULL;
slouken@2713
   142
    }
slouken@2713
   143
slouken@2713
   144
    /* Disable autocenter and set gain to max. */
slouken@2713
   145
    if (haptic->supported & SDL_HAPTIC_GAIN)
slouken@2713
   146
        SDL_HapticSetGain(haptic, 100);
slouken@2713
   147
    if (haptic->supported & SDL_HAPTIC_AUTOCENTER)
slouken@2713
   148
        SDL_HapticSetAutocenter(haptic, 0);
slouken@2713
   149
slouken@2713
   150
    /* Add haptic to list */
slouken@2713
   151
    ++haptic->ref_count;
slouken@2713
   152
    for (i = 0; SDL_haptics[i]; i++)
slouken@2713
   153
        /* Skip to next haptic */ ;
slouken@2713
   154
    SDL_haptics[i] = haptic;
slouken@2713
   155
slouken@2713
   156
    return haptic;
slouken@2713
   157
}
slouken@2713
   158
slouken@2713
   159
slouken@2713
   160
/*
slouken@2713
   161
 * Returns 1 if the device has been opened.
slouken@2713
   162
 */
slouken@2713
   163
int
slouken@2713
   164
SDL_HapticOpened(int device_index)
slouken@2713
   165
{
slouken@2713
   166
    int i, opened;
slouken@2713
   167
slouken@2713
   168
    opened = 0;
slouken@2713
   169
    for (i = 0; SDL_haptics[i]; i++) {
slouken@2713
   170
        if (SDL_haptics[i]->index == (Uint8) device_index) {
slouken@2713
   171
            opened = 1;
slouken@2713
   172
            break;
slouken@2713
   173
        }
slouken@2713
   174
    }
slouken@2713
   175
    return opened;
slouken@2713
   176
}
slouken@2713
   177
slouken@2713
   178
slouken@2713
   179
/*
slouken@2713
   180
 * Returns the index to a haptic device.
slouken@2713
   181
 */
slouken@2713
   182
int
slouken@2713
   183
SDL_HapticIndex(SDL_Haptic * haptic)
slouken@2713
   184
{
slouken@2713
   185
    if (!ValidHaptic(haptic)) {
slouken@2713
   186
        return -1;
slouken@2713
   187
    }
slouken@2713
   188
slouken@2713
   189
    return haptic->index;
slouken@2713
   190
}
slouken@2713
   191
slouken@2713
   192
slouken@2713
   193
/*
slouken@2713
   194
 * Returns SDL_TRUE if mouse is haptic, SDL_FALSE if it isn't.
slouken@2713
   195
 */
slouken@2713
   196
int
slouken@2713
   197
SDL_MouseIsHaptic(void)
slouken@2713
   198
{
slouken@2713
   199
    if (SDL_SYS_HapticMouse() < 0)
slouken@2713
   200
        return SDL_FALSE;
slouken@2713
   201
    return SDL_TRUE;
slouken@2713
   202
}
slouken@2713
   203
slouken@2713
   204
slouken@2713
   205
/*
slouken@2713
   206
 * Returns the haptic device if mouse is haptic or NULL elsewise.
slouken@2713
   207
 */
slouken@2713
   208
SDL_Haptic *
slouken@2713
   209
SDL_HapticOpenFromMouse(void)
slouken@2713
   210
{
slouken@2713
   211
    int device_index;
slouken@2713
   212
slouken@2713
   213
    device_index = SDL_SYS_HapticMouse();
slouken@2713
   214
slouken@2713
   215
    if (device_index < 0) {
slouken@2713
   216
        SDL_SetError("Haptic: Mouse isn't a haptic device.");
slouken@2713
   217
        return NULL;
slouken@2713
   218
    }
slouken@2713
   219
slouken@2713
   220
    return SDL_HapticOpen(device_index);
slouken@2713
   221
}
slouken@2713
   222
slouken@2713
   223
slouken@2713
   224
/*
slouken@2713
   225
 * Returns SDL_TRUE if joystick has haptic features.
slouken@2713
   226
 */
slouken@2713
   227
int
slouken@2713
   228
SDL_JoystickIsHaptic(SDL_Joystick * joystick)
slouken@2713
   229
{
slouken@2713
   230
    int ret;
slouken@2713
   231
slouken@2713
   232
    /* Must be a valid joystick */
slouken@2713
   233
    if (!SDL_PrivateJoystickValid(&joystick)) {
slouken@2713
   234
        return -1;
slouken@2713
   235
    }
slouken@2713
   236
slouken@2713
   237
    ret = SDL_SYS_JoystickIsHaptic(joystick);
slouken@2713
   238
slouken@2713
   239
    if (ret > 0)
slouken@2713
   240
        return SDL_TRUE;
slouken@2713
   241
    else if (ret == 0)
slouken@2713
   242
        return SDL_FALSE;
slouken@2713
   243
    else
slouken@2713
   244
        return -1;
slouken@2713
   245
}
slouken@2713
   246
slouken@2713
   247
slouken@2713
   248
/*
slouken@2713
   249
 * Opens a haptic device from a joystick.
slouken@2713
   250
 */
slouken@2713
   251
SDL_Haptic *
slouken@2713
   252
SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
slouken@2713
   253
{
slouken@2713
   254
    int i;
slouken@2713
   255
    SDL_Haptic *haptic;
slouken@2713
   256
slouken@2713
   257
    /* Must be a valid joystick */
slouken@2713
   258
    if (!SDL_PrivateJoystickValid(&joystick)) {
slouken@2713
   259
        return NULL;
slouken@2713
   260
    }
slouken@2713
   261
slouken@2713
   262
    /* Joystick must be haptic */
slouken@2713
   263
    if (SDL_SYS_JoystickIsHaptic(joystick) <= 0) {
slouken@2713
   264
        return NULL;
slouken@2713
   265
    }
slouken@2713
   266
slouken@2713
   267
    /* Check to see if joystick's haptic is already open */
slouken@2713
   268
    for (i = 0; SDL_haptics[i]; i++) {
slouken@2713
   269
        if (SDL_SYS_JoystickSameHaptic(SDL_haptics[i], joystick)) {
slouken@2713
   270
            haptic = SDL_haptics[i];
slouken@2713
   271
            ++haptic->ref_count;
slouken@2713
   272
            return haptic;
slouken@2713
   273
        }
slouken@2713
   274
    }
slouken@2713
   275
slouken@2713
   276
    /* Create the haptic device */
slouken@2713
   277
    haptic = (SDL_Haptic *) SDL_malloc((sizeof *haptic));
slouken@2713
   278
    if (haptic == NULL) {
slouken@2713
   279
        SDL_OutOfMemory();
slouken@2713
   280
        return NULL;
slouken@2713
   281
    }
slouken@2713
   282
slouken@2713
   283
    /* Initialize the haptic device */
slouken@2713
   284
    SDL_memset(haptic, 0, sizeof(SDL_Haptic));
slouken@2713
   285
    if (SDL_SYS_HapticOpenFromJoystick(haptic, joystick) < 0) {
slouken@2713
   286
        SDL_free(haptic);
slouken@2713
   287
        return NULL;
slouken@2713
   288
    }
slouken@2713
   289
slouken@2713
   290
    /* Add haptic to list */
slouken@2713
   291
    ++haptic->ref_count;
slouken@2713
   292
    for (i = 0; SDL_haptics[i]; i++)
slouken@2713
   293
        /* Skip to next haptic */ ;
slouken@2713
   294
    SDL_haptics[i] = haptic;
slouken@2713
   295
slouken@2713
   296
    return haptic;
slouken@2713
   297
}
slouken@2713
   298
slouken@2713
   299
slouken@2713
   300
/*
slouken@2713
   301
 * Closes a SDL_Haptic device.
slouken@2713
   302
 */
slouken@2713
   303
void
slouken@2713
   304
SDL_HapticClose(SDL_Haptic * haptic)
slouken@2713
   305
{
slouken@2713
   306
    int i;
slouken@2713
   307
slouken@2713
   308
    /* Must be valid */
slouken@2713
   309
    if (!ValidHaptic(haptic)) {
slouken@2713
   310
        return;
slouken@2713
   311
    }
slouken@2713
   312
slouken@2713
   313
    /* Check if it's still in use */
slouken@2713
   314
    if (--haptic->ref_count < 0) {
slouken@2713
   315
        return;
slouken@2713
   316
    }
slouken@2713
   317
slouken@2713
   318
    /* Close it, properly removing effects if needed */
slouken@2713
   319
    for (i = 0; i < haptic->neffects; i++) {
slouken@2713
   320
        if (haptic->effects[i].hweffect != NULL) {
slouken@2713
   321
            SDL_HapticDestroyEffect(haptic, i);
slouken@2713
   322
        }
slouken@2713
   323
    }
slouken@2713
   324
    SDL_SYS_HapticClose(haptic);
slouken@2713
   325
slouken@2713
   326
    /* Remove from the list */
slouken@2713
   327
    for (i = 0; SDL_haptics[i]; ++i) {
slouken@2713
   328
        if (haptic == SDL_haptics[i]) {
slouken@2713
   329
            SDL_haptics[i] = NULL;
slouken@2713
   330
            SDL_memcpy(&SDL_haptics[i], &SDL_haptics[i + 1],
slouken@2713
   331
                       (SDL_numhaptics - i) * sizeof(haptic));
slouken@2713
   332
            break;
slouken@2713
   333
        }
slouken@2713
   334
    }
slouken@2713
   335
slouken@2713
   336
    /* Free */
slouken@2713
   337
    SDL_free(haptic);
slouken@2713
   338
}
slouken@2713
   339
slouken@2713
   340
/*
slouken@2713
   341
 * Cleans up after the subsystem.
slouken@2713
   342
 */
slouken@2713
   343
void
slouken@2713
   344
SDL_HapticQuit(void)
slouken@2713
   345
{
slouken@2713
   346
    SDL_SYS_HapticQuit();
slouken@2713
   347
    if (SDL_haptics != NULL) {
slouken@2713
   348
        SDL_free(SDL_haptics);
slouken@2713
   349
        SDL_haptics = NULL;
slouken@2713
   350
    }
slouken@2713
   351
    SDL_numhaptics = 0;
slouken@2713
   352
}
slouken@2713
   353
slouken@2713
   354
/*
slouken@2713
   355
 * Returns the number of effects a haptic device has.
slouken@2713
   356
 */
slouken@2713
   357
int
slouken@2713
   358
SDL_HapticNumEffects(SDL_Haptic * haptic)
slouken@2713
   359
{
slouken@2713
   360
    if (!ValidHaptic(haptic)) {
slouken@2713
   361
        return -1;
slouken@2713
   362
    }
slouken@2713
   363
slouken@2713
   364
    return haptic->neffects;
slouken@2713
   365
}
slouken@2713
   366
slouken@2713
   367
slouken@2713
   368
/*
slouken@2713
   369
 * Returns the number of effects a haptic device can play.
slouken@2713
   370
 */
slouken@2713
   371
int
slouken@2713
   372
SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic)
slouken@2713
   373
{
slouken@2713
   374
    if (!ValidHaptic(haptic)) {
slouken@2713
   375
        return -1;
slouken@2713
   376
    }
slouken@2713
   377
slouken@2713
   378
    return haptic->nplaying;
slouken@2713
   379
}
slouken@2713
   380
slouken@2713
   381
slouken@2713
   382
/*
slouken@2713
   383
 * Returns supported effects by the device.
slouken@2713
   384
 */
slouken@2713
   385
unsigned int
slouken@2713
   386
SDL_HapticQuery(SDL_Haptic * haptic)
slouken@2713
   387
{
slouken@2713
   388
    if (!ValidHaptic(haptic)) {
slouken@2713
   389
        return -1;
slouken@2713
   390
    }
slouken@2713
   391
slouken@2713
   392
    return haptic->supported;
slouken@2713
   393
}
slouken@2713
   394
slouken@2713
   395
slouken@2713
   396
/*
slouken@2713
   397
 * Returns the number of axis on the device.
slouken@2713
   398
 */
slouken@2713
   399
int
slouken@2713
   400
SDL_HapticNumAxes(SDL_Haptic * haptic)
slouken@2713
   401
{
slouken@2713
   402
    if (!ValidHaptic(haptic)) {
slouken@2713
   403
        return -1;
slouken@2713
   404
    }
slouken@2713
   405
slouken@2713
   406
    return haptic->naxes;
slouken@2713
   407
}
slouken@2713
   408
slouken@2713
   409
/*
slouken@2713
   410
 * Checks to see if the device can support the effect.
slouken@2713
   411
 */
slouken@2713
   412
int
slouken@2713
   413
SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect)
slouken@2713
   414
{
slouken@2713
   415
    if (!ValidHaptic(haptic)) {
slouken@2713
   416
        return -1;
slouken@2713
   417
    }
slouken@2713
   418
slouken@2713
   419
    if ((haptic->supported & effect->type) != 0)
slouken@2713
   420
        return SDL_TRUE;
slouken@2713
   421
    return SDL_FALSE;
slouken@2713
   422
}
slouken@2713
   423
slouken@2713
   424
/*
slouken@2713
   425
 * Creates a new haptic effect.
slouken@2713
   426
 */
slouken@2713
   427
int
slouken@2713
   428
SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
slouken@2713
   429
{
slouken@2713
   430
    int i;
slouken@2713
   431
slouken@2713
   432
    /* Check for device validity. */
slouken@2713
   433
    if (!ValidHaptic(haptic)) {
slouken@2713
   434
        return -1;
slouken@2713
   435
    }
slouken@2713
   436
slouken@2713
   437
    /* Check to see if effect is supported */
slouken@2713
   438
    if (SDL_HapticEffectSupported(haptic, effect) == SDL_FALSE) {
slouken@2713
   439
        SDL_SetError("Haptic: Effect not supported by haptic device.");
slouken@2713
   440
        return -1;
slouken@2713
   441
    }
slouken@2713
   442
slouken@2713
   443
    /* See if there's a free slot */
slouken@2713
   444
    for (i = 0; i < haptic->neffects; i++) {
slouken@2713
   445
        if (haptic->effects[i].hweffect == NULL) {
slouken@2713
   446
slouken@2713
   447
            /* Now let the backend create the real effect */
slouken@2713
   448
            if (SDL_SYS_HapticNewEffect(haptic, &haptic->effects[i], effect)
slouken@2713
   449
                != 0) {
slouken@2713
   450
                return -1;      /* Backend failed to create effect */
slouken@2713
   451
            }
slouken@2713
   452
slouken@2713
   453
            SDL_memcpy(&haptic->effects[i].effect, effect,
slouken@2713
   454
                       sizeof(SDL_HapticEffect));
slouken@2713
   455
            return i;
slouken@2713
   456
        }
slouken@2713
   457
    }
slouken@2713
   458
slouken@2713
   459
    SDL_SetError("Haptic: Device has no free space left.");
slouken@2713
   460
    return -1;
slouken@2713
   461
}
slouken@2713
   462
slouken@2713
   463
/*
slouken@2713
   464
 * Checks to see if an effect is valid.
slouken@2713
   465
 */
slouken@2713
   466
static int
slouken@2713
   467
ValidEffect(SDL_Haptic * haptic, int effect)
slouken@2713
   468
{
slouken@2713
   469
    if ((effect < 0) || (effect >= haptic->neffects)) {
slouken@2713
   470
        SDL_SetError("Haptic: Invalid effect identifier.");
slouken@2713
   471
        return 0;
slouken@2713
   472
    }
slouken@2713
   473
    return 1;
slouken@2713
   474
}
slouken@2713
   475
slouken@2713
   476
/*
slouken@2713
   477
 * Updates an effect.
slouken@2713
   478
 */
slouken@2713
   479
int
slouken@2713
   480
SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect,
slouken@2713
   481
                       SDL_HapticEffect * data)
slouken@2713
   482
{
slouken@2713
   483
    if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
slouken@2713
   484
        return -1;
slouken@2713
   485
    }
slouken@2713
   486
slouken@2713
   487
    /* Can't change type dynamically. */
slouken@2713
   488
    if (data->type != haptic->effects[effect].effect.type) {
slouken@2713
   489
        SDL_SetError("Haptic: Updating effect type is illegal.");
slouken@2713
   490
        return -1;
slouken@2713
   491
    }
slouken@2713
   492
slouken@2713
   493
    /* Updates the effect */
slouken@2713
   494
    if (SDL_SYS_HapticUpdateEffect(haptic, &haptic->effects[effect], data) <
slouken@2713
   495
        0) {
slouken@2713
   496
        return -1;
slouken@2713
   497
    }
slouken@2713
   498
slouken@2713
   499
    SDL_memcpy(&haptic->effects[effect].effect, data,
slouken@2713
   500
               sizeof(SDL_HapticEffect));
slouken@2713
   501
    return 0;
slouken@2713
   502
}
slouken@2713
   503
slouken@2713
   504
slouken@2713
   505
/*
slouken@2713
   506
 * Runs the haptic effect on the device.
slouken@2713
   507
 */
slouken@2713
   508
int
slouken@2713
   509
SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations)
slouken@2713
   510
{
slouken@2713
   511
    if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
slouken@2713
   512
        return -1;
slouken@2713
   513
    }
slouken@2713
   514
slouken@2713
   515
    /* Run the effect */
slouken@2713
   516
    if (SDL_SYS_HapticRunEffect(haptic, &haptic->effects[effect], iterations)
slouken@2713
   517
        < 0) {
slouken@2713
   518
        return -1;
slouken@2713
   519
    }
slouken@2713
   520
slouken@2713
   521
    return 0;
slouken@2713
   522
}
slouken@2713
   523
slouken@2713
   524
/*
slouken@2713
   525
 * Stops the haptic effect on the device.
slouken@2713
   526
 */
slouken@2713
   527
int
slouken@2713
   528
SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
slouken@2713
   529
{
slouken@2713
   530
    if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
slouken@2713
   531
        return -1;
slouken@2713
   532
    }
slouken@2713
   533
slouken@2713
   534
    /* Stop the effect */
slouken@2713
   535
    if (SDL_SYS_HapticStopEffect(haptic, &haptic->effects[effect]) < 0) {
slouken@2713
   536
        return -1;
slouken@2713
   537
    }
slouken@2713
   538
slouken@2713
   539
    return 0;
slouken@2713
   540
}
slouken@2713
   541
slouken@2713
   542
/*
slouken@2713
   543
 * Gets rid of a haptic effect.
slouken@2713
   544
 */
slouken@2713
   545
void
slouken@2713
   546
SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
slouken@2713
   547
{
slouken@2713
   548
    if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
slouken@2713
   549
        return;
slouken@2713
   550
    }
slouken@2713
   551
slouken@2713
   552
    /* Not allocated */
slouken@2713
   553
    if (haptic->effects[effect].hweffect == NULL) {
slouken@2713
   554
        return;
slouken@2713
   555
    }
slouken@2713
   556
slouken@2713
   557
    SDL_SYS_HapticDestroyEffect(haptic, &haptic->effects[effect]);
slouken@2713
   558
}
slouken@2713
   559
slouken@2713
   560
/*
slouken@2713
   561
 * Gets the status of a haptic effect.
slouken@2713
   562
 */
slouken@2713
   563
int
slouken@2713
   564
SDL_HapticGetEffectStatus(SDL_Haptic * haptic, int effect)
slouken@2713
   565
{
slouken@2713
   566
    if (!ValidHaptic(haptic) || !ValidEffect(haptic, effect)) {
slouken@2713
   567
        return -1;
slouken@2713
   568
    }
slouken@2713
   569
slouken@2713
   570
    if ((haptic->supported & SDL_HAPTIC_STATUS) == 0) {
slouken@2713
   571
        SDL_SetError("Haptic: Device does not support status queries.");
slouken@2713
   572
        return -1;
slouken@2713
   573
    }
slouken@2713
   574
slouken@2713
   575
    return SDL_SYS_HapticGetEffectStatus(haptic, &haptic->effects[effect]);
slouken@2713
   576
}
slouken@2713
   577
slouken@2713
   578
/*
slouken@2713
   579
 * Sets the global gain of the device.
slouken@2713
   580
 */
slouken@2713
   581
int
slouken@2713
   582
SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
slouken@2713
   583
{
slouken@2713
   584
    const char *env;
slouken@2713
   585
    int real_gain, max_gain;
slouken@2713
   586
slouken@2713
   587
    if (!ValidHaptic(haptic)) {
slouken@2713
   588
        return -1;
slouken@2713
   589
    }
slouken@2713
   590
slouken@2713
   591
    if ((haptic->supported & SDL_HAPTIC_GAIN) == 0) {
slouken@2713
   592
        SDL_SetError("Haptic: Device does not support setting gain.");
slouken@2713
   593
        return -1;
slouken@2713
   594
    }
slouken@2713
   595
slouken@2713
   596
    if ((gain < 0) || (gain > 100)) {
slouken@2713
   597
        SDL_SetError("Haptic: Gain must be between 0 and 100.");
slouken@2713
   598
        return -1;
slouken@2713
   599
    }
slouken@2713
   600
slouken@2713
   601
    /* We use the envvar to get the maximum gain. */
slouken@2713
   602
    env = SDL_getenv("SDL_HAPTIC_GAIN_MAX");
slouken@2713
   603
    if (env != NULL) {
slouken@2713
   604
        max_gain = SDL_atoi(env);
slouken@2713
   605
slouken@2713
   606
        /* Check for sanity. */
slouken@2713
   607
        if (max_gain < 0)
slouken@2713
   608
            max_gain = 0;
slouken@2713
   609
        else if (max_gain > 100)
slouken@2713
   610
            max_gain = 100;
slouken@2713
   611
slouken@2713
   612
        /* We'll scale it linearly with SDL_HAPTIC_GAIN_MAX */
slouken@2713
   613
        real_gain = (gain * max_gain) / 100;
slouken@2713
   614
    } else {
slouken@2713
   615
        real_gain = gain;
slouken@2713
   616
    }
slouken@2713
   617
slouken@2713
   618
    if (SDL_SYS_HapticSetGain(haptic, real_gain) < 0) {
slouken@2713
   619
        return -1;
slouken@2713
   620
    }
slouken@2713
   621
slouken@2713
   622
    return 0;
slouken@2713
   623
}
slouken@2713
   624
slouken@2713
   625
/*
slouken@2713
   626
 * Makes the device autocenter, 0 disables.
slouken@2713
   627
 */
slouken@2713
   628
int
slouken@2713
   629
SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
slouken@2713
   630
{
slouken@2713
   631
    if (!ValidHaptic(haptic)) {
slouken@2713
   632
        return -1;
slouken@2713
   633
    }
slouken@2713
   634
slouken@2713
   635
    if ((haptic->supported & SDL_HAPTIC_AUTOCENTER) == 0) {
slouken@2713
   636
        SDL_SetError("Haptic: Device does not support setting autocenter.");
slouken@2713
   637
        return -1;
slouken@2713
   638
    }
slouken@2713
   639
slouken@2713
   640
    if ((autocenter < 0) || (autocenter > 100)) {
slouken@2713
   641
        SDL_SetError("Haptic: Autocenter must be between 0 and 100.");
slouken@2713
   642
        return -1;
slouken@2713
   643
    }
slouken@2713
   644
slouken@2713
   645
    if (SDL_SYS_HapticSetAutocenter(haptic, autocenter) < 0) {
slouken@2713
   646
        return -1;
slouken@2713
   647
    }
slouken@2713
   648
slouken@2713
   649
    return 0;
slouken@2713
   650
}
slouken@2713
   651
slouken@2713
   652
/*
slouken@2713
   653
 * Pauses the haptic device.
slouken@2713
   654
 */
slouken@2713
   655
int
slouken@2713
   656
SDL_HapticPause(SDL_Haptic * haptic)
slouken@2713
   657
{
slouken@2713
   658
    if (!ValidHaptic(haptic)) {
slouken@2713
   659
        return -1;
slouken@2713
   660
    }
slouken@2713
   661
slouken@2713
   662
    if ((haptic->supported & SDL_HAPTIC_PAUSE) == 0) {
slouken@2713
   663
        SDL_SetError("Haptic: Device does not support setting pausing.");
slouken@2713
   664
        return -1;
slouken@2713
   665
    }
slouken@2713
   666
slouken@2713
   667
    return SDL_SYS_HapticPause(haptic);
slouken@2713
   668
}
slouken@2713
   669
slouken@2713
   670
/*
slouken@2713
   671
 * Unpauses the haptic device.
slouken@2713
   672
 */
slouken@2713
   673
int
slouken@2713
   674
SDL_HapticUnpause(SDL_Haptic * haptic)
slouken@2713
   675
{
slouken@2713
   676
    if (!ValidHaptic(haptic)) {
slouken@2713
   677
        return -1;
slouken@2713
   678
    }
slouken@2713
   679
slouken@2713
   680
    if ((haptic->supported & SDL_HAPTIC_PAUSE) == 0) {
slouken@2713
   681
        return 0;               /* Not going to be paused, so we pretend it's unpaused. */
slouken@2713
   682
    }
slouken@2713
   683
slouken@2713
   684
    return SDL_SYS_HapticUnpause(haptic);
slouken@2713
   685
}
slouken@2713
   686
slouken@2713
   687
/*
slouken@2713
   688
 * Stops all the currently playing effects.
slouken@2713
   689
 */
slouken@2713
   690
int
slouken@2713
   691
SDL_HapticStopAll(SDL_Haptic * haptic)
slouken@2713
   692
{
slouken@2713
   693
    if (!ValidHaptic(haptic)) {
slouken@2713
   694
        return -1;
slouken@2713
   695
    }
slouken@2713
   696
slouken@2713
   697
    return SDL_SYS_HapticStopAll(haptic);
slouken@2713
   698
}