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