smallinput.h

   1 /**
   2   @file smallinput.h
   3
   4   Small API for getting keyboard/mouse input, with possiblity to record it and
   5   play back.
   6
   7   The Linux Input API requires root pirivileges (sudo).
   8
   9   by Milsolav "drummyfish" Ciz, released under CC0 1.0 (public domain)
  10 */
  11
  12 #ifndef _SMALLINPUT_H
  13 #define _SMALLINPUT_H
  14
  15 #include <stdint.h>
  16 #include <stdio.h>
  17
  18 #define SMALLINPUT_MODE_NORMAL 0 ///< Only handle input.
  19 #define SMALLINPUT_MODE_RECORD 1 ///< Handle input and record it.
  20 #define SMALLINPUT_MODE_PLAY   2 ///< Play back recorded input.
  21
  22 #define SMALLINPUT_KEY_NONE    0
  23 #define SMALLINPUT_SPACE       ' '
  24 #define SMALLINPUT_BACKSPACE   8
  25 #define SMALLINPUT_TAB         9
  26 #define SMALLINPUT_RETURN      13
  27 #define SMALLINPUT_SHIFT       14
  28 #define SMALLINPUT_ESCAPE      27
  29 #define SMALLINPUT_DELETE      127
  30 #define SMALLINPUT_ARROW_UP    128
  31 #define SMALLINPUT_ARROW_RIGHT 129
  32 #define SMALLINPUT_ARROW_DOWN  130
  33 #define SMALLINPUT_ARROW_LEFT  131
  34 #define SMALLINPUT_F1          132
  35 #define SMALLINPUT_F2          133
  36 #define SMALLINPUT_F3          134
  37 #define SMALLINPUT_F4          135
  38 #define SMALLINPUT_F5          136
  39 #define SMALLINPUT_F6          137
  40 #define SMALLINPUT_F7          138
  41 #define SMALLINPUT_F8          139
  42 #define SMALLINPUT_F9          140
  43 #define SMALLINPUT_F10         141
  44 #define SMALLINPUT_F11         142
  45 #define SMALLINPUT_F12         143
  46 #define SMALLINPUT_CTRL        144
  47 #define SMALLINPUT_MOUSE_L     253
  48 #define SMALLINPUT_MOUSE_M     254
  49 #define SMALLINPUT_MOUSE_R     255
  50
  51 #define SMALLINPUT_RECORD_KEY_DOWN 1   ///< Mouse down event, followed by code.
  52 #define SMALLINPUT_RECORD_KEY_UP   2   ///< Moue up event, followed by code.
  53 #define SMALLINPUT_RECORD_MOUSE_X  3   ///< Mouse x move, followed by s32 value.
  54 #define SMALLINPUT_RECORD_MOUSE_Y  4   ///< Mouse y move, followed by s32 value.
  55 #define SMALLINPUT_RECORD_END      255 ///< Record end, followed by 4 more same values.
  56
  57 uint8_t input_keyStates[256];
  58 int32_t input_mousePosition[2];
  59
  60 uint8_t input_keyStatesPrevious[256];
  61 int32_t input_mousePositionPrevious[2];
  62
  63 uint8_t input_mode;
  64
  65 uint32_t input_frame = 0;
  66 uint8_t *input_recordData;
  67 uint32_t input_recordPosition;
  68 uint32_t input_recordSize;
  69
  70 #if 1 // TODO: add other options for input handling (SDL, xinput, ...)
  71   /*
  72     This is using Linux Input Subsystem API. Defines can be found in
  73     include/uapi/linux/input-event-codes.h.
  74   */
  75
  76   #include <fcntl.h>
  77   #include <linux/input.h>
  78   #include <sys/time.h>
  79   #include <unistd.h>
  80
  81   typedef struct
  82   {
  83     struct timeval time;
  84     uint16_t type;
  85     uint16_t code;
  86     int32_t value;
  87   } LinuxInputEvent;
  88
  89   #define INPUT_KEYBOARD_FILE "/dev/input/event0"
  90   #define INPUT_MOUSE_FILE "/dev/input/event1"
  91
  92   int input_keyboardFile = 0;
  93   int input_mouseFile = 0;
  94
  95   /**
  96     Maps this library's key codes to linux input key codes.
  97   */
  98   static const int input_linuxCodes[256] =
  99     {
 100       #define no KEY_RESERVED
 101       no,no,no,no,no,no,no,no,KEY_BACKSPACE,KEY_TAB,no,no,no,KEY_ENTER,KEY_LEFTSHIFT,no,
 102       no,no,no,no,no,no,no,no,no,no,no,KEY_ESC,no,no,no,no,
 103       KEY_SPACE,no,no,no,no,no,no,no,no,no,no,no,KEY_COMMA,no,KEY_DOT,no,
 104       KEY_0,KEY_1,KEY_2,KEY_3,KEY_4,KEY_5,KEY_6,KEY_7,KEY_8,KEY_9,no,KEY_SEMICOLON,no,KEY_EQUAL,no,KEY_QUESTION,
 105       no,KEY_A,KEY_B,KEY_C,KEY_D,KEY_E,KEY_F,KEY_G,KEY_H,KEY_I,KEY_J,KEY_K,KEY_L,KEY_M,KEY_N,KEY_O,
 106       KEY_P,KEY_Q,KEY_R,KEY_S,KEY_T,KEY_U,KEY_V,KEY_W,KEY_X,KEY_Y,KEY_Z,no,no,no,no,no,
 107       no,KEY_A,KEY_B,KEY_C,KEY_D,KEY_E,KEY_F,KEY_G,KEY_H,KEY_I,KEY_J,KEY_K,KEY_L,KEY_M,KEY_N,KEY_O,
 108       KEY_P,KEY_Q,KEY_R,KEY_S,KEY_T,KEY_U,KEY_V,KEY_W,KEY_X,KEY_Y,KEY_Z,no,no,no,no,KEY_DELETE,
 109       KEY_UP,KEY_RIGHT,KEY_DOWN,KEY_LEFT,KEY_F1,KEY_F2,KEY_F3,KEY_F4,KEY_F5,KEY_F6,KEY_F7,KEY_F8,KEY_F9,KEY_F10,KEY_F11,KEY_F12,
 110       KEY_LEFTCTRL,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,
 111       no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,
 112       no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,
 113       no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,
 114       no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,
 115       no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,
 116       no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no
 117       #undef no
 118     };
 119 #endif
 120
 121 void input_recordU8(uint8_t value)
 122 {
 123   if (input_recordPosition < (input_recordSize - 1))
 124   {
 125     input_recordData[input_recordPosition] = value;
 126     input_recordPosition++;
 127   }
 128 }
 129
 130 void input_recordU32(uint32_t value)
 131 {
 132   for (uint8_t i = 0; i < 4; ++i)
 133   {
 134     input_recordU8(value % 256);
 135     value /= 256;
 136   }
 137 }
 138
 139 uint32_t input_readU32(uint8_t *data)
 140 {
 141   uint32_t result = 0;
 142
 143   for (uint8_t i = 0; i < 4; ++i)
 144     result = result * 256 + data[3 - i];
 145
 146   return result;
 147 }
 148
 149 /**
 150   Initializes the library with given mode (SMALLINPUT_MODE_*).
 151 */
 152 uint8_t input_init(uint8_t mode, uint8_t *recordData, uint32_t recordDataLength)
 153 {
 154   input_mode = mode;
 155
 156   input_mousePosition[0] = 0;
 157   input_mousePosition[1] = 0;
 158
 159   input_mousePositionPrevious[0] = 0;
 160   input_mousePositionPrevious[1] = 0;
 161
 162   input_frame = 0;
 163   input_recordData = recordData;
 164   input_recordPosition = 0;
 165   input_recordSize = recordDataLength;
 166
 167   for (int16_t i = 0; i < 256; ++i)
 168   {
 169     input_keyStates[i] = 0;
 170     input_keyStatesPrevious[i] = 0;
 171   }
 172
 173   uint8_t result = 1;
 174
 175   if (input_mode != SMALLINPUT_MODE_PLAY)
 176   {
 177     input_keyboardFile = open(INPUT_KEYBOARD_FILE, O_RDONLY);
 178
 179     result = input_keyboardFile >= 0;
 180
 181     if (result)
 182     {
 183       fcntl(input_keyboardFile, F_SETFL, O_NONBLOCK);
 184
 185       input_mouseFile = open(INPUT_MOUSE_FILE, O_RDONLY);
 186
 187       result = input_mouseFile >= 0;
 188
 189       if (result)
 190         fcntl(input_mouseFile, F_SETFL, O_NONBLOCK);
 191     }
 192
 193     if (!result)
 194       puts("could not open device file (are you root?)");
 195   }
 196
 197   return result;
 198 }
 199
 200 void input_end(void)
 201 {
 202   if (input_mode == SMALLINPUT_MODE_RECORD)
 203     for (uint8_t i = 0; i < 5; ++i)
 204       input_recordU8(SMALLINPUT_RECORD_END);
 205
 206   close(input_keyboardFile);
 207   close(input_mouseFile);
 208 }
 209
 210 /**
 211   Should be called once every main loop iteration to retrieve current input
 212   state.
 213 */
 214 void input_update(void)
 215 {
 216   LinuxInputEvent event;
 217
 218   if (input_mode == SMALLINPUT_MODE_PLAY)
 219   {
 220     while (input_recordPosition < input_recordSize)
 221     {
 222       uint32_t nextFrame = input_readU32(input_recordData + input_recordPosition);
 223
 224       if (input_frame >= nextFrame)
 225       {
 226         input_recordPosition += 4;
 227
 228         uint8_t rec = input_recordData[input_recordPosition];
 229
 230         switch (rec)
 231         {
 232           case SMALLINPUT_RECORD_KEY_DOWN:
 233           case SMALLINPUT_RECORD_KEY_UP:
 234             input_recordPosition++;
 235             input_keyStates[input_recordData[input_recordPosition]] = rec == SMALLINPUT_RECORD_KEY_DOWN;
 236             input_recordPosition++;
 237             break;
 238
 239           case SMALLINPUT_RECORD_MOUSE_X:
 240           case SMALLINPUT_RECORD_MOUSE_Y:
 241             input_recordPosition++;
 242             input_mousePosition[rec == SMALLINPUT_RECORD_MOUSE_Y] =
 243               input_readU32(input_recordData + input_recordPosition);
 244             input_recordPosition += 4;
 245             break;
 246
 247           case SMALLINPUT_RECORD_END:
 248             input_recordPosition = input_recordSize;
 249             break;
 250
 251           default: /*printf("corrupt record\n");*/ break;
 252         }
 253       }
 254       else
 255         break;
 256     }
 257   }
 258   else
 259   {
 260     while (1) // keyboard
 261     {
 262       if (read(input_keyboardFile, &event, sizeof(event)) <= 0)
 263         break;
 264
 265       if (event.type == EV_KEY && (event.value == 1 || event.value == 0))
 266         for (uint16_t i = 0; i < 256; ++i)
 267           if (event.code == input_linuxCodes[i])
 268           {
 269             input_keyStates[i] = event.value;
 270             break;
 271           }
 272     }
 273
 274     while (1) // mouse
 275     {
 276       if (read(input_mouseFile, &event, sizeof(event)) <= 0)
 277         break;
 278
 279       if (event.type == EV_REL)
 280         input_mousePosition[event.code % 2] += event.value;
 281       else if (event.type == EV_KEY)
 282       {
 283         input_keyStates[
 284           event.code == BTN_LEFT ? SMALLINPUT_MOUSE_L :
 285           (event.code == BTN_RIGHT ? SMALLINPUT_MOUSE_R : SMALLINPUT_MOUSE_M)]
 286           = event.value;
 287       }
 288     }
 289   }
 290
 291   for (uint16_t i = 0; i < 256; ++i)
 292     if (input_keyStates[i] && input_keyStates[i] < 255)
 293       input_keyStates[i]++;
 294
 295   if (input_mode == SMALLINPUT_MODE_RECORD)
 296   {
 297     for (uint8_t i = 0; i < 2; ++i) // record mouse events
 298       if (input_mousePositionPrevious[i] != input_mousePosition[i])
 299       {
 300         input_recordU32(input_frame + 1);
 301         input_recordU8((i == 0) ? SMALLINPUT_RECORD_MOUSE_X : SMALLINPUT_RECORD_MOUSE_Y);
 302         input_recordU32(input_mousePosition[i]);
 303
 304         input_mousePositionPrevious[i] = input_mousePosition[i];
 305       }
 306
 307     for (uint16_t i = 0; i < 256; ++i) // record key events
 308     {
 309       uint8_t a = input_keyStates[i] > 0;
 310       uint8_t b = input_keyStatesPrevious[i] > 0;
 311
 312       if (a != b)
 313       {
 314         input_recordU32(input_frame + 1);
 315         input_recordU8(a ? SMALLINPUT_RECORD_KEY_DOWN : SMALLINPUT_RECORD_KEY_UP);
 316         input_recordU8(i);
 317
 318         input_keyStatesPrevious[i] = input_keyStates[i];
 319       }
 320     }
 321   }
 322
 323   input_frame++;
 324 }
 325
 326 /**
 327   Returns the number of input frames for which given key has been pressed (> 1:
 328   key is pressed, == 1: key was just pressed, == 0: key is not pressed).
 329 */
 330 static inline uint8_t input_getKey(uint8_t key)
 331 {
 332   if (key >= 'a' && key <= 'z')
 333     key = 'A' + (key - 'a');
 334
 335   return input_keyStates[key];
 336 }
 337
 338 /**
 339   Gets the mouse position.
 340 */
 341 static inline void input_getMousePos(int32_t *x, int32_t *y)
 342 {
 343   *x = input_mousePosition[0];
 344   *y = input_mousePosition[1];
 345 }
 346
 347 static inline void input_setMousePos(int32_t x, int32_t y)
 348 {
 349   input_mousePosition[0] = x;
 350   input_mousePosition[1] = y;
 351 }
 352
 353 /**
 354   Prints the current input state.
 355 */
 356 void input_print()
 357 {
 358   printf("frame: %d\nmouse pos: %d %d",input_frame,input_mousePosition[0],input_mousePosition[1]);
 359
 360   for (uint16_t i = 0; i < 256; ++i)
 361   {
 362     if (i % 8 == 0)
 363       putchar('\n');
 364
 365     char c = (i > ' ' && i <= 126) ? i : '?';
 366
 367     uint8_t n = input_getKey(i);
 368
 369     printf("%s",n ? " [" : "  ");
 370     printf("%03d (\'%c\'): %03d",i,c,input_getKey(i));
 371     printf("%s",n ? "] " : "  ");
 372   }
 373
 374   putchar('\n');
 375 }
 376
 377 void input_printRecord()
 378 {
 379   for (uint32_t i = 0; i < input_recordPosition; ++i)
 380   {
 381     if (i % 32 == 0)
 382       putchar('\n');
 383
 384     printf("%d,",input_recordData[i]);
 385   }
 386 }
 387
 388 uint32_t input_hash()
 389 {
 390   uint32_t result = 0;
 391
 392   for (uint16_t i = 0; i < 256; ++i)
 393     result += input_getKey(i) * (i + 1);
 394
 395   int32_t x, y;
 396
 397   input_getMousePos(&x,&y);
 398
 399   result += x + y << 16;
 400
 401   return result;
 402 }
 403
 404 #endif // guard