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