in_sdl.c

   1 /*
   2  * (C) Gražvydas "notaz" Ignotas, 2012
   3  *
   4  * This work is licensed under the terms of any of these licenses
   5  * (at your option):
   6  *  - GNU GPL, version 2 or later.
   7  *  - GNU LGPL, version 2.1 or later.
   8  *  - MAME license.
   9  * See the COPYING file in the top-level directory.
  10  */
  11
  12 #include <stdio.h>
  13 #include <SDL.h>
  14 #include "input.h"
  15 #include "in_sdl.h"
  16
  17 #define IN_SDL_PREFIX "sdl:"
  18 /* should be machine word for best performace */
  19 typedef unsigned long keybits_t;
  20 #define KEYBITS_WORD_BITS (sizeof(keybits_t) * 8)
  21
  22 struct in_sdl_state {
  23         const in_drv_t *drv;
  24         SDL_Joystick *joy;
  25         int joy_id;
  26         int axis_keydown[2];
  27         keybits_t keystate[SDLK_LAST / KEYBITS_WORD_BITS + 1];
  28 };
  29
  30 static void (*ext_event_handler)(void *event);
  31
  32 static const char * const in_sdl_keys[SDLK_LAST] = {
  33         [SDLK_BACKSPACE] = "backspace",
  34         [SDLK_TAB] = "tab",
  35         [SDLK_CLEAR] = "clear",
  36         [SDLK_RETURN] = "return",
  37         [SDLK_PAUSE] = "pause",
  38         [SDLK_ESCAPE] = "escape",
  39         [SDLK_SPACE] = "space",
  40         [SDLK_EXCLAIM]  = "!",
  41         [SDLK_QUOTEDBL]  = "\"",
  42         [SDLK_HASH]  = "#",
  43         [SDLK_DOLLAR]  = "$",
  44         [SDLK_AMPERSAND]  = "&",
  45         [SDLK_QUOTE] = "'",
  46         [SDLK_LEFTPAREN] = "(",
  47         [SDLK_RIGHTPAREN] = ")",
  48         [SDLK_ASTERISK] = "*",
  49         [SDLK_PLUS] = "+",
  50         [SDLK_COMMA] = ",",
  51         [SDLK_MINUS] = "-",
  52         [SDLK_PERIOD] = ".",
  53         [SDLK_SLASH] = "/",
  54         [SDLK_0] = "0",
  55         [SDLK_1] = "1",
  56         [SDLK_2] = "2",
  57         [SDLK_3] = "3",
  58         [SDLK_4] = "4",
  59         [SDLK_5] = "5",
  60         [SDLK_6] = "6",
  61         [SDLK_7] = "7",
  62         [SDLK_8] = "8",
  63         [SDLK_9] = "9",
  64         [SDLK_COLON] = ":",
  65         [SDLK_SEMICOLON] = ";",
  66         [SDLK_LESS] = "<",
  67         [SDLK_EQUALS] = "=",
  68         [SDLK_GREATER] = ">",
  69         [SDLK_QUESTION] = "?",
  70         [SDLK_AT] = "@",
  71         [SDLK_LEFTBRACKET] = "[",
  72         [SDLK_BACKSLASH] = "\\",
  73         [SDLK_RIGHTBRACKET] = "]",
  74         [SDLK_CARET] = "^",
  75         [SDLK_UNDERSCORE] = "_",
  76         [SDLK_BACKQUOTE] = "`",
  77         [SDLK_a] = "a",
  78         [SDLK_b] = "b",
  79         [SDLK_c] = "c",
  80         [SDLK_d] = "d",
  81         [SDLK_e] = "e",
  82         [SDLK_f] = "f",
  83         [SDLK_g] = "g",
  84         [SDLK_h] = "h",
  85         [SDLK_i] = "i",
  86         [SDLK_j] = "j",
  87         [SDLK_k] = "k",
  88         [SDLK_l] = "l",
  89         [SDLK_m] = "m",
  90         [SDLK_n] = "n",
  91         [SDLK_o] = "o",
  92         [SDLK_p] = "p",
  93         [SDLK_q] = "q",
  94         [SDLK_r] = "r",
  95         [SDLK_s] = "s",
  96         [SDLK_t] = "t",
  97         [SDLK_u] = "u",
  98         [SDLK_v] = "v",
  99         [SDLK_w] = "w",
 100         [SDLK_x] = "x",
 101         [SDLK_y] = "y",
 102         [SDLK_z] = "z",
 103         [SDLK_DELETE] = "delete",
 104
 105         [SDLK_KP0] = "[0]",
 106         [SDLK_KP1] = "[1]",
 107         [SDLK_KP2] = "[2]",
 108         [SDLK_KP3] = "[3]",
 109         [SDLK_KP4] = "[4]",
 110         [SDLK_KP5] = "[5]",
 111         [SDLK_KP6] = "[6]",
 112         [SDLK_KP7] = "[7]",
 113         [SDLK_KP8] = "[8]",
 114         [SDLK_KP9] = "[9]",
 115         [SDLK_KP_PERIOD] = "[.]",
 116         [SDLK_KP_DIVIDE] = "[/]",
 117         [SDLK_KP_MULTIPLY] = "[*]",
 118         [SDLK_KP_MINUS] = "[-]",
 119         [SDLK_KP_PLUS] = "[+]",
 120         [SDLK_KP_ENTER] = "enter",
 121         [SDLK_KP_EQUALS] = "equals",
 122
 123         [SDLK_UP] = "up",
 124         [SDLK_DOWN] = "down",
 125         [SDLK_RIGHT] = "right",
 126         [SDLK_LEFT] = "left",
 127         [SDLK_INSERT] = "insert",
 128         [SDLK_HOME] = "home",
 129         [SDLK_END] = "end",
 130         [SDLK_PAGEUP] = "page up",
 131         [SDLK_PAGEDOWN] = "page down",
 132
 133         [SDLK_F1] = "f1",
 134         [SDLK_F2] = "f2",
 135         [SDLK_F3] = "f3",
 136         [SDLK_F4] = "f4",
 137         [SDLK_F5] = "f5",
 138         [SDLK_F6] = "f6",
 139         [SDLK_F7] = "f7",
 140         [SDLK_F8] = "f8",
 141         [SDLK_F9] = "f9",
 142         [SDLK_F10] = "f10",
 143         [SDLK_F11] = "f11",
 144         [SDLK_F12] = "f12",
 145         [SDLK_F13] = "f13",
 146         [SDLK_F14] = "f14",
 147         [SDLK_F15] = "f15",
 148
 149         [SDLK_NUMLOCK] = "numlock",
 150         [SDLK_CAPSLOCK] = "caps lock",
 151         [SDLK_SCROLLOCK] = "scroll lock",
 152         [SDLK_RSHIFT] = "right shift",
 153         [SDLK_LSHIFT] = "left shift",
 154         [SDLK_RCTRL] = "right ctrl",
 155         [SDLK_LCTRL] = "left ctrl",
 156         [SDLK_RALT] = "right alt",
 157         [SDLK_LALT] = "left alt",
 158         [SDLK_RMETA] = "right meta",
 159         [SDLK_LMETA] = "left meta",
 160         [SDLK_LSUPER] = "left super",   /* "Windows" keys */
 161         [SDLK_RSUPER] = "right super",
 162         [SDLK_MODE] = "alt gr",
 163         [SDLK_COMPOSE] = "compose",
 164 };
 165
 166 static void in_sdl_probe(const in_drv_t *drv)
 167 {
 168         const struct in_pdata *pdata = drv->pdata;
 169         const char * const * key_names = in_sdl_keys;
 170         struct in_sdl_state *state;
 171         SDL_Joystick *joy;
 172         int i, joycount;
 173         char name[256];
 174
 175         if (pdata->key_names)
 176                 key_names = pdata->key_names;
 177
 178         state = calloc(1, sizeof(*state));
 179         if (state == NULL) {
 180                 fprintf(stderr, "in_sdl: OOM\n");
 181                 return;
 182         }
 183
 184         state->drv = drv;
 185         in_register(IN_SDL_PREFIX "keys", -1, state, SDLK_LAST,
 186                 key_names, 0);
 187
 188         /* joysticks go here too */
 189         SDL_InitSubSystem(SDL_INIT_JOYSTICK);
 190
 191         joycount = SDL_NumJoysticks();
 192         for (i = 0; i < joycount; i++) {
 193                 joy = SDL_JoystickOpen(i);
 194                 if (joy == NULL)
 195                         continue;
 196
 197                 state = calloc(1, sizeof(*state));
 198                 if (state == NULL) {
 199                         fprintf(stderr, "in_sdl: OOM\n");
 200                         break;
 201                 }
 202                 state->joy = joy;
 203                 state->joy_id = i;
 204                 state->drv = drv;
 205
 206                 snprintf(name, sizeof(name), IN_SDL_PREFIX "%s", SDL_JoystickName(i));
 207                 in_register(name, -1, state, SDLK_LAST, key_names, 0);
 208         }
 209
 210         if (joycount > 0)
 211                 SDL_JoystickEventState(SDL_ENABLE);
 212 }
 213
 214 static void in_sdl_free(void *drv_data)
 215 {
 216         struct in_sdl_state *state = drv_data;
 217
 218         if (state != NULL) {
 219                 if (state->joy != NULL)
 220                         SDL_JoystickClose(state->joy);
 221                 free(state);
 222         }
 223 }
 224
 225 static const char * const *
 226 in_sdl_get_key_names(const in_drv_t *drv, int *count)
 227 {
 228         const struct in_pdata *pdata = drv->pdata;
 229         *count = SDLK_LAST;
 230
 231         if (pdata->key_names)
 232                 return pdata->key_names;
 233         return in_sdl_keys;
 234 }
 235
 236 /* could use SDL_GetKeyState, but this gives better packing */
 237 static void update_keystate(keybits_t *keystate, int sym, int is_down)
 238 {
 239         keybits_t *ks_word, mask;
 240
 241         mask = 1;
 242         mask <<= sym & (KEYBITS_WORD_BITS - 1);
 243         ks_word = keystate + sym / KEYBITS_WORD_BITS;
 244         if (is_down)
 245                 *ks_word |= mask;
 246         else
 247                 *ks_word &= ~mask;
 248 }
 249
 250 static int handle_event(struct in_sdl_state *state, SDL_Event *event,
 251         int *kc_out, int *down_out)
 252 {
 253         if (event->type != SDL_KEYDOWN && event->type != SDL_KEYUP)
 254                 return -1;
 255
 256         update_keystate(state->keystate, event->key.keysym.sym,
 257                 event->type == SDL_KEYDOWN);
 258         if (kc_out != NULL)
 259                 *kc_out = event->key.keysym.sym;
 260         if (down_out != NULL)
 261                 *down_out = event->type == SDL_KEYDOWN;
 262
 263         return 1;
 264 }
 265
 266 static int handle_joy_event(struct in_sdl_state *state, SDL_Event *event,
 267         int *kc_out, int *down_out)
 268 {
 269         int kc = -1, down = 0, ret = 0;
 270
 271         /* TODO: remaining axis */
 272         switch (event->type) {
 273         case SDL_JOYAXISMOTION:
 274                 if (event->jaxis.which != state->joy_id)
 275                         return -2;
 276                 if (event->jaxis.axis > 1)
 277                         break;
 278                 if (-16384 <= event->jaxis.value && event->jaxis.value <= 16384) {
 279                         kc = state->axis_keydown[event->jaxis.axis];
 280                         state->axis_keydown[event->jaxis.axis] = 0;
 281                         ret = 1;
 282                 }
 283                 else if (event->jaxis.value < -16384) {
 284                         kc = state->axis_keydown[event->jaxis.axis];
 285                         if (kc)
 286                                 update_keystate(state->keystate, kc, 0);
 287                         kc = event->jaxis.axis ? SDLK_UP : SDLK_LEFT;
 288                         state->axis_keydown[event->jaxis.axis] = kc;
 289                         down = 1;
 290                         ret = 1;
 291                 }
 292                 else if (event->jaxis.value > 16384) {
 293                         kc = state->axis_keydown[event->jaxis.axis];
 294                         if (kc)
 295                                 update_keystate(state->keystate, kc, 0);
 296                         kc = event->jaxis.axis ? SDLK_DOWN : SDLK_RIGHT;
 297                         state->axis_keydown[event->jaxis.axis] = kc;
 298                         down = 1;
 299                         ret = 1;
 300                 }
 301                 break;
 302
 303         case SDL_JOYBUTTONDOWN:
 304         case SDL_JOYBUTTONUP:
 305                 if (event->jbutton.which != state->joy_id)
 306                         return -2;
 307                 kc = (int)event->jbutton.button + SDLK_WORLD_0;
 308                 down = event->jbutton.state == SDL_PRESSED;
 309                 ret = 1;
 310                 break;
 311         default:
 312                 return -1;
 313         }
 314
 315         if (ret)
 316                 update_keystate(state->keystate, kc, down);
 317         if (kc_out != NULL)
 318                 *kc_out = kc;
 319         if (down_out != NULL)
 320                 *down_out = down;
 321
 322         return ret;
 323 }
 324
 325 #define JOY_EVENTS (SDL_JOYAXISMOTIONMASK | SDL_JOYBALLMOTIONMASK | SDL_JOYHATMOTIONMASK \
 326                     | SDL_JOYBUTTONDOWNMASK | SDL_JOYBUTTONUPMASK)
 327
 328 static int collect_events(struct in_sdl_state *state, int *one_kc, int *one_down)
 329 {
 330         SDL_Event events[4];
 331         Uint32 mask = state->joy ? JOY_EVENTS : (SDL_ALLEVENTS & ~JOY_EVENTS);
 332         int count, maxcount;
 333         int i, ret, retval = 0;
 334         int num_events, num_peeped_events;
 335         SDL_Event *event;
 336
 337         maxcount = (one_kc != NULL) ? 1 : sizeof(events) / sizeof(events[0]);
 338
 339         SDL_PumpEvents();
 340
 341         num_events = SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, mask);
 342
 343         for (num_peeped_events = 0; num_peeped_events < num_events; num_peeped_events += count) {
 344                 count = SDL_PeepEvents(events, maxcount, SDL_GETEVENT, mask);
 345                 if (count <= 0)
 346                         break;
 347                 for (i = 0; i < count; i++) {
 348                         event = &events[i];
 349                         if (state->joy)
 350                                 ret = handle_joy_event(state,
 351                                         event, one_kc, one_down);
 352                         else
 353                                 ret = handle_event(state,
 354                                         event, one_kc, one_down);
 355                         if (ret < 0) {
 356                                 switch (ret) {
 357                                         case -2:
 358                                                 SDL_PushEvent(event);
 359                                                 break;
 360                                         default:
 361                                                 if (ext_event_handler != NULL)
 362                                                         ext_event_handler(event);
 363                                                 break;
 364                                 }
 365                                 continue;
 366                         }
 367
 368                         retval |= ret;
 369                         if (one_kc != NULL && ret)
 370                         {
 371                                 // don't lose events other devices might want to handle
 372                                 for (i++; i < count; i++)
 373                                         SDL_PushEvent(&events[i]);
 374                                 goto out;
 375                         }
 376                 }
 377         }
 378
 379 out:
 380         return retval;
 381 }
 382
 383 static int in_sdl_update(void *drv_data, const int *binds, int *result)
 384 {
 385         struct in_sdl_state *state = drv_data;
 386         keybits_t mask;
 387         int i, sym, bit, b;
 388
 389         collect_events(state, NULL, NULL);
 390
 391         for (i = 0; i < SDLK_LAST / KEYBITS_WORD_BITS + 1; i++) {
 392                 mask = state->keystate[i];
 393                 if (mask == 0)
 394                         continue;
 395                 for (bit = 0; mask != 0; bit++, mask >>= 1) {
 396                         if ((mask & 1) == 0)
 397                                 continue;
 398                         sym = i * KEYBITS_WORD_BITS + bit;
 399
 400                         for (b = 0; b < IN_BINDTYPE_COUNT; b++)
 401                                 result[b] |= binds[IN_BIND_OFFS(sym, b)];
 402                 }
 403         }
 404
 405         return 0;
 406 }
 407
 408 static int in_sdl_update_keycode(void *drv_data, int *is_down)
 409 {
 410         struct in_sdl_state *state = drv_data;
 411         int ret_kc = -1, ret_down = 0;
 412
 413         collect_events(state, &ret_kc, &ret_down);
 414
 415         if (is_down != NULL)
 416                 *is_down = ret_down;
 417
 418         return ret_kc;
 419 }
 420
 421 static int in_sdl_menu_translate(void *drv_data, int keycode, char *charcode)
 422 {
 423         struct in_sdl_state *state = drv_data;
 424         const struct in_pdata *pdata = state->drv->pdata;
 425         const char * const * key_names = in_sdl_keys;
 426         const struct menu_keymap *map;
 427         int map_len;
 428         int ret = 0;
 429         int i;
 430
 431         if (pdata->key_names)
 432                 key_names = pdata->key_names;
 433
 434         if (state->joy) {
 435                 map = pdata->joy_map;
 436                 map_len = pdata->jmap_size;
 437         } else {
 438                 map = pdata->key_map;
 439                 map_len = pdata->kmap_size;
 440         }
 441
 442         if (keycode < 0)
 443         {
 444                 /* menu -> kc */
 445                 keycode = -keycode;
 446                 for (i = 0; i < map_len; i++)
 447                         if (map[i].pbtn == keycode)
 448                                 return map[i].key;
 449         }
 450         else
 451         {
 452                 for (i = 0; i < map_len; i++) {
 453                         if (map[i].key == keycode) {
 454                                 ret = map[i].pbtn;
 455                                 break;
 456                         }
 457                 }
 458
 459                 if (charcode != NULL && (unsigned int)keycode < SDLK_LAST &&
 460                     key_names[keycode] != NULL && key_names[keycode][1] == 0)
 461                 {
 462                         ret |= PBTN_CHAR;
 463                         *charcode = key_names[keycode][0];
 464                 }
 465         }
 466
 467         return ret;
 468 }
 469
 470 static const in_drv_t in_sdl_drv = {
 471         .prefix         = IN_SDL_PREFIX,
 472         .probe          = in_sdl_probe,
 473         .free           = in_sdl_free,
 474         .get_key_names  = in_sdl_get_key_names,
 475         .update         = in_sdl_update,
 476         .update_keycode = in_sdl_update_keycode,
 477         .menu_translate = in_sdl_menu_translate,
 478 };
 479
 480 int in_sdl_init(const struct in_pdata *pdata, void (*handler)(void *event))
 481 {
 482         if (!pdata) {
 483                 fprintf(stderr, "in_sdl: Missing input platform data\n");
 484                 return -1;
 485         }
 486
 487         in_register_driver(&in_sdl_drv, pdata->defbinds, pdata);
 488         ext_event_handler = handler;
 489         return 0;
 490 }