git.sesse.net Git - vlc/blob - src/config/keys.c

   1 /*****************************************************************************
   2  * keys.c: keys configuration
   3  *****************************************************************************
   4  * Copyright (C) 2003-2009 VLC authors and VideoLAN
   5  *
   6  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26
  27 /**
  28  * \file
  29  * This file defines functions and structures for hotkey handling in vlc
  30  */
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include <config.h>
  34 #endif
  35
  36 #include <stdlib.h>
  37 #include <limits.h>
  38 #ifdef HAVE_SEARCH_H
  39 # include <search.h>
  40 #endif
  41
  42 #include <vlc_common.h>
  43 #include <vlc_keys.h>
  44 #include "configuration.h"
  45 #include "libvlc.h"
  46
  47 typedef struct key_descriptor_s
  48 {
  49     const char psz_key_string[20];
  50     uint32_t i_key_code;
  51 } key_descriptor_t;
  52
  53 static const struct key_descriptor_s vlc_keys[] =
  54 {   /* Alphabetical order */
  55     { N_("Backspace"),         KEY_BACKSPACE         },
  56     { N_("Browser Back"),      KEY_BROWSER_BACK      },
  57     { N_("Browser Favorites"), KEY_BROWSER_FAVORITES },
  58     { N_("Browser Forward"),   KEY_BROWSER_FORWARD   },
  59     { N_("Browser Home"),      KEY_BROWSER_HOME      },
  60     { N_("Browser Refresh"),   KEY_BROWSER_REFRESH   },
  61     { N_("Browser Search"),    KEY_BROWSER_SEARCH    },
  62     { N_("Browser Stop"),      KEY_BROWSER_STOP      },
  63     { N_("Delete"),            KEY_DELETE            },
  64     { N_("Down"),              KEY_DOWN              },
  65     { N_("End"),               KEY_END               },
  66     { N_("Enter"),             KEY_ENTER             },
  67     { N_("Esc"),               KEY_ESC               },
  68     { N_("F1"),                KEY_F1                },
  69     { N_("F10"),               KEY_F10               },
  70     { N_("F11"),               KEY_F11               },
  71     { N_("F12"),               KEY_F12               },
  72     { N_("F2"),                KEY_F2                },
  73     { N_("F3"),                KEY_F3                },
  74     { N_("F4"),                KEY_F4                },
  75     { N_("F5"),                KEY_F5                },
  76     { N_("F6"),                KEY_F6                },
  77     { N_("F7"),                KEY_F7                },
  78     { N_("F8"),                KEY_F8                },
  79     { N_("F9"),                KEY_F9                },
  80     { N_("Home"),              KEY_HOME              },
  81     { N_("Insert"),            KEY_INSERT            },
  82     { N_("Left"),              KEY_LEFT              },
  83     { N_("Media Next Track"),  KEY_MEDIA_NEXT_TRACK  },
  84     { N_("Media Play Pause"),  KEY_MEDIA_PLAY_PAUSE  },
  85     { N_("Media Prev Track"),  KEY_MEDIA_PREV_TRACK  },
  86     { N_("Media Stop"),        KEY_MEDIA_STOP        },
  87     { N_("Menu"),              KEY_MENU              },
  88     { N_("Mouse Wheel Down"),  KEY_MOUSEWHEELDOWN    },
  89     { N_("Mouse Wheel Left"),  KEY_MOUSEWHEELLEFT    },
  90     { N_("Mouse Wheel Right"), KEY_MOUSEWHEELRIGHT   },
  91     { N_("Mouse Wheel Up"),    KEY_MOUSEWHEELUP      },
  92     { N_("Page Down"),         KEY_PAGEDOWN          },
  93     { N_("Page Up"),           KEY_PAGEUP            },
  94     { N_("Right"),             KEY_RIGHT             },
  95     { N_("Space"),             ' '                   },
  96     { N_("Tab"),               KEY_TAB               },
  97     { N_("Unset"),             KEY_UNSET             },
  98     { N_("Up"),                KEY_UP                },
  99     { N_("Volume Down"),       KEY_VOLUME_DOWN       },
 100     { N_("Volume Mute"),       KEY_VOLUME_MUTE       },
 101     { N_("Volume Up"),         KEY_VOLUME_UP         },
 102 };
 103 #define KEYS_COUNT (sizeof(vlc_keys)/sizeof(vlc_keys[0]))
 104
 105 static int keystrcmp (const void *key, const void *elem)
 106 {
 107     const char *sa = key, *sb = elem;
 108     return strcmp (sa, sb);
 109 }
 110
 111 /* Convert Unicode code point to UTF-8 */
 112 static char *utf8_cp (uint_fast32_t cp, char *buf)
 113 {
 114     if (cp < (1 << 7))
 115     {
 116         buf[1] = 0;
 117         buf[0] = cp;
 118     }
 119     else if (cp < (1 << 11))
 120     {
 121         buf[2] = 0;
 122         buf[1] = 0x80 | (cp & 0x3F);
 123         cp >>= 6;
 124         buf[0] = 0xC0 | cp;
 125     }
 126     else if (cp < (1 << 16))
 127     {
 128         buf[3] = 0;
 129         buf[2] = 0x80 | (cp & 0x3F);
 130         cp >>= 6;
 131         buf[1] = 0x80 | (cp & 0x3F);
 132         cp >>= 6;
 133         buf[0] = 0xE0 | cp;
 134     }
 135     else if (cp < (1 << 21))
 136     {
 137         buf[4] = 0;
 138         buf[3] = 0x80 | (cp & 0x3F);
 139         cp >>= 6;
 140         buf[2] = 0x80 | (cp & 0x3F);
 141         cp >>= 6;
 142         buf[1] = 0x80 | (cp & 0x3F);
 143         cp >>= 6;
 144         buf[0] = 0xE0 | cp;
 145     }
 146     else
 147         return NULL;
 148     return buf;
 149 }
 150
 151 /**
 152  * Parse a human-readable string representation of a VLC key code.
 153  * @note This only works with the American English representation
 154  * (a.k.a. C or POSIX), not with the local representation returned from
 155  * vlc_keycode2str().
 156  * @return a VLC key code, or KEY_UNSET on failure.
 157  */
 158 uint_fast32_t vlc_str2keycode (const char *name)
 159 {
 160     uint_fast32_t mods = 0;
 161     uint32_t code;
 162
 163     for (;;)
 164     {
 165         size_t len = strcspn (name, "-+");
 166         if (len == 0 || name[len] == '\0')
 167             break;
 168
 169         if (len == 4 && !strncasecmp (name, "Ctrl", 4))
 170             mods |= KEY_MODIFIER_CTRL;
 171         if (len == 3 && !strncasecmp (name, "Alt", 3))
 172             mods |= KEY_MODIFIER_ALT;
 173         if (len == 5 && !strncasecmp (name, "Shift", 5))
 174             mods |= KEY_MODIFIER_SHIFT;
 175         if (len == 4 && !strncasecmp (name, "Meta", 4))
 176             mods |= KEY_MODIFIER_META;
 177         if (len == 7 && !strncasecmp (name, "Command", 7))
 178             mods |= KEY_MODIFIER_COMMAND;
 179
 180         name += len + 1;
 181     }
 182
 183     key_descriptor_t *d = bsearch (name, vlc_keys, KEYS_COUNT,
 184                                    sizeof (vlc_keys[0]), keystrcmp);
 185     if (d != NULL)
 186         code = d->i_key_code;
 187     else
 188     if (vlc_towc (name, &code) <= 0)
 189         code = KEY_UNSET;
 190
 191     if (code != KEY_UNSET)
 192         code |= mods;
 193     return code;
 194 }
 195
 196 static char *nooptext (const char *txt)
 197 {
 198     return (char *)txt;
 199 }
 200
 201 /**
 202  * Format a human-readable and unique representation of a VLC key code
 203  * (including modifiers).
 204  * @param code key code to translate to a string
 205  * @param locale true to get a localized string,
 206  *               false to get a C string suitable for 'vlcrc'
 207  * @return a heap-allocated string, or NULL on error.
 208  */
 209 char *vlc_keycode2str (uint_fast32_t code, bool locale)
 210 {
 211     char *(*tr) (const char *) = locale ? vlc_gettext : nooptext;
 212     const char *name;
 213     char *str, buf[5];
 214     uintptr_t key = code & ~KEY_MODIFIER;
 215
 216     for (size_t i = 0; i < KEYS_COUNT; i++)
 217         if (vlc_keys[i].i_key_code == key)
 218         {
 219             name = vlc_keys[i].psz_key_string;
 220             goto found;
 221         }
 222
 223     if (utf8_cp (key, buf) == NULL)
 224         return NULL;
 225     name = buf;
 226
 227 found:
 228     if (asprintf (&str, "%s%s%s%s%s%s",
 229                   (code & KEY_MODIFIER_CTRL) ? tr(N_("Ctrl+")) : "",
 230                   (code & KEY_MODIFIER_ALT) ? tr(N_("Alt+")) : "",
 231                   (code & KEY_MODIFIER_SHIFT) ? tr(N_("Shift+")) : "",
 232                   (code & KEY_MODIFIER_META) ? tr(N_("Meta+")) : "",
 233                   (code & KEY_MODIFIER_COMMAND) ? tr(N_("Command+")) : "",
 234                   tr(name)) == -1)
 235         return NULL;
 236     return str;
 237 }
 238
 239
 240 /*** VLC key map ***/
 241
 242 #define MAXACTION 20
 243 struct action
 244 {
 245     char name[MAXACTION];
 246     vlc_action_t value;
 247 };
 248
 249 static const struct action actions[] =
 250 {
 251     /* *MUST* be sorted (ASCII order) */
 252     { "aspect-ratio", ACTIONID_ASPECT_RATIO, },
 253     { "audio-track", ACTIONID_AUDIO_TRACK, },
 254     { "audiodelay-down", ACTIONID_AUDIODELAY_DOWN, },
 255     { "audiodelay-up", ACTIONID_AUDIODELAY_UP, },
 256     { "audiodevice-cycle", ACTIONID_AUDIODEVICE_CYCLE, },
 257     { "chapter-next", ACTIONID_CHAPTER_NEXT, },
 258     { "chapter-prev", ACTIONID_CHAPTER_PREV, },
 259     { "crop", ACTIONID_CROP, },
 260     { "crop-bottom", ACTIONID_CROP_BOTTOM, },
 261     { "crop-left", ACTIONID_CROP_LEFT, },
 262     { "crop-right", ACTIONID_CROP_RIGHT, },
 263     { "crop-top", ACTIONID_CROP_TOP, },
 264     { "decr-scalefactor", ACTIONID_SCALE_DOWN, },
 265     { "deinterlace", ACTIONID_DEINTERLACE, },
 266     { "disc-menu", ACTIONID_DISC_MENU, },
 267     { "faster", ACTIONID_FASTER, },
 268     { "frame-next", ACTIONID_FRAME_NEXT, },
 269     { "incr-scalefactor", ACTIONID_SCALE_UP, },
 270     { "intf-boss", ACTIONID_INTF_BOSS, },
 271     { "intf-show", ACTIONID_INTF_TOGGLE_FSC, },
 272     { "jump+extrashort", ACTIONID_JUMP_FORWARD_EXTRASHORT, },
 273     { "jump+long", ACTIONID_JUMP_FORWARD_LONG, },
 274     { "jump+medium", ACTIONID_JUMP_FORWARD_MEDIUM, },
 275     { "jump+short", ACTIONID_JUMP_FORWARD_SHORT, },
 276     { "jump-extrashort", ACTIONID_JUMP_BACKWARD_EXTRASHORT, },
 277     { "jump-long", ACTIONID_JUMP_BACKWARD_LONG, },
 278     { "jump-medium", ACTIONID_JUMP_BACKWARD_MEDIUM, },
 279     { "jump-short", ACTIONID_JUMP_BACKWARD_SHORT, },
 280     { "leave-fullscreen", ACTIONID_LEAVE_FULLSCREEN, },
 281     { "loop", ACTIONID_LOOP, },
 282     { "menu-down", ACTIONID_MENU_DOWN, },
 283     { "menu-left", ACTIONID_MENU_LEFT, },
 284     { "menu-off", ACTIONID_MENU_OFF, },
 285     { "menu-on", ACTIONID_MENU_ON, },
 286     { "menu-right", ACTIONID_MENU_RIGHT, },
 287     { "menu-select", ACTIONID_MENU_SELECT, },
 288     { "menu-up", ACTIONID_MENU_UP, },
 289     { "nav-activate", ACTIONID_NAV_ACTIVATE, },
 290     { "nav-down", ACTIONID_NAV_DOWN, },
 291     { "nav-left", ACTIONID_NAV_LEFT, },
 292     { "nav-right", ACTIONID_NAV_RIGHT, },
 293     { "nav-up", ACTIONID_NAV_UP, },
 294     { "next", ACTIONID_NEXT, },
 295     { "pause", ACTIONID_PAUSE, },
 296     { "play", ACTIONID_PLAY, },
 297     { "play-bookmark1", ACTIONID_PLAY_BOOKMARK1, },
 298     { "play-bookmark10", ACTIONID_PLAY_BOOKMARK10, },
 299     { "play-bookmark2", ACTIONID_PLAY_BOOKMARK2, },
 300     { "play-bookmark3", ACTIONID_PLAY_BOOKMARK3, },
 301     { "play-bookmark4", ACTIONID_PLAY_BOOKMARK4, },
 302     { "play-bookmark5", ACTIONID_PLAY_BOOKMARK5, },
 303     { "play-bookmark6", ACTIONID_PLAY_BOOKMARK6, },
 304     { "play-bookmark7", ACTIONID_PLAY_BOOKMARK7, },
 305     { "play-bookmark8", ACTIONID_PLAY_BOOKMARK8, },
 306     { "play-bookmark9", ACTIONID_PLAY_BOOKMARK9, },
 307     { "play-pause", ACTIONID_PLAY_PAUSE, },
 308     { "position", ACTIONID_POSITION, },
 309     { "prev", ACTIONID_PREV, },
 310     { "program-sid", ACTIONID_PROGRAM_SID, },
 311     { "quit", ACTIONID_QUIT, },
 312     { "random", ACTIONID_RANDOM, },
 313     { "rate-faster-fine", ACTIONID_RATE_FASTER_FINE, },
 314     { "rate-normal", ACTIONID_RATE_NORMAL, },
 315     { "rate-slower-fine", ACTIONID_RATE_SLOWER_FINE, },
 316     { "record", ACTIONID_RECORD, },
 317     { "set-bookmark1", ACTIONID_SET_BOOKMARK1, },
 318     { "set-bookmark10", ACTIONID_SET_BOOKMARK10, },
 319     { "set-bookmark2", ACTIONID_SET_BOOKMARK2, },
 320     { "set-bookmark3", ACTIONID_SET_BOOKMARK3, },
 321     { "set-bookmark4", ACTIONID_SET_BOOKMARK4, },
 322     { "set-bookmark5", ACTIONID_SET_BOOKMARK5, },
 323     { "set-bookmark6", ACTIONID_SET_BOOKMARK6, },
 324     { "set-bookmark7", ACTIONID_SET_BOOKMARK7, },
 325     { "set-bookmark8", ACTIONID_SET_BOOKMARK8, },
 326     { "set-bookmark9", ACTIONID_SET_BOOKMARK9, },
 327     { "slower", ACTIONID_SLOWER, },
 328     { "snapshot", ACTIONID_SNAPSHOT, },
 329     { "stop", ACTIONID_STOP, },
 330     { "subdelay-down", ACTIONID_SUBDELAY_DOWN, },
 331     { "subdelay-up", ACTIONID_SUBDELAY_UP, },
 332     { "subpos-down", ACTIONID_SUBPOS_DOWN, },
 333     { "subpos-up", ACTIONID_SUBPOS_UP, },
 334     { "subtitle-track", ACTIONID_SUBTITLE_TRACK, },
 335     { "title-next", ACTIONID_TITLE_NEXT, },
 336     { "title-prev", ACTIONID_TITLE_PREV, },
 337     { "toggle-autoscale", ACTIONID_TOGGLE_AUTOSCALE, },
 338     { "toggle-fullscreen", ACTIONID_TOGGLE_FULLSCREEN, },
 339     { "uncrop-bottom", ACTIONID_UNCROP_BOTTOM, },
 340     { "uncrop-left", ACTIONID_UNCROP_LEFT, },
 341     { "uncrop-right", ACTIONID_UNCROP_RIGHT, },
 342     { "uncrop-top", ACTIONID_UNCROP_TOP, },
 343     { "unzoom", ACTIONID_UNZOOM, },
 344     { "vol-down", ACTIONID_VOL_DOWN, },
 345     { "vol-mute", ACTIONID_VOL_MUTE, },
 346     { "vol-up", ACTIONID_VOL_UP, },
 347     { "wallpaper", ACTIONID_WALLPAPER, },
 348     { "zoom", ACTIONID_ZOOM, },
 349     { "zoom-double", ACTIONID_ZOOM_DOUBLE, },
 350     { "zoom-half", ACTIONID_ZOOM_HALF, },
 351     { "zoom-original", ACTIONID_ZOOM_ORIGINAL, },
 352     { "zoom-quarter", ACTIONID_ZOOM_QUARTER, },
 353 };
 354 #define ACTIONS_COUNT (sizeof (actions) / sizeof (actions[0]))
 355
 356 struct mapping
 357 {
 358     uint32_t     key; ///< Key code
 359     vlc_action_t action; ///< Action ID
 360 };
 361
 362 static int keycmp (const void *a, const void *b)
 363 {
 364     const struct mapping *ka = a, *kb = b;
 365
 366 #if (INT_MAX >= 0x7fffffff)
 367     return ka->key - kb->key;
 368 #else
 369     return (ka->key < kb->key) ? -1 : (ka->key > kb->key) ? +1 : 0;
 370 #endif
 371 }
 372
 373 struct vlc_actions
 374 {
 375     void *map; /* Key map */
 376     void *global_map; /* Grabbed/global key map */
 377     struct hotkey keys[0];
 378 };
 379
 380 static int vlc_key_to_action (vlc_object_t *obj, const char *varname,
 381                               vlc_value_t prevkey, vlc_value_t curkey, void *d)
 382 {
 383     void *const *map = d;
 384     const struct mapping **pent;
 385     uint32_t keycode = curkey.i_int;
 386
 387     pent = tfind (&keycode, map, keycmp);
 388     if (pent == NULL)
 389         return VLC_SUCCESS;
 390
 391     (void) varname;
 392     (void) prevkey;
 393     return var_SetInteger (obj, "key-action", (*pent)->action);
 394 }
 395
 396 /**
 397  * Sets up all key mappings for a given action.
 398  * \param map tree (of struct mapping entries) to write mappings to
 399  * \param confname VLC configuration item to read mappings from
 400  * \param action action ID
 401  */
 402 static void vlc_MapAction (vlc_object_t *obj, void **map,
 403                            const char *confname, vlc_action_t action)
 404 {
 405     char *keys = var_InheritString (obj, confname);
 406     if (keys == NULL)
 407         return;
 408
 409     for (char *buf, *key = strtok_r (keys, "\t", &buf);
 410          key != NULL;
 411          key = strtok_r (NULL, "\t", &buf))
 412     {
 413         uint32_t code = vlc_str2keycode (key);
 414         if (code == KEY_UNSET)
 415         {
 416             msg_Warn (obj, "Key \"%s\" unrecognized", key);
 417             continue;
 418         }
 419
 420         struct mapping *entry = malloc (sizeof (*entry));
 421         if (entry == NULL)
 422             continue;
 423         entry->key = code;
 424         entry->action = action;
 425
 426         struct mapping **pent = tsearch (entry, map, keycmp);
 427         if (unlikely(pent == NULL))
 428             continue;
 429         if (*pent != entry)
 430         {
 431             free (entry);
 432             msg_Warn (obj, "Key \"%s\" bound to multiple actions", key);
 433         }
 434     }
 435     free (keys);
 436 }
 437
 438
 439 /**
 440  * Initializes the key map from configuration.
 441  */
 442 struct vlc_actions *vlc_InitActions (libvlc_int_t *libvlc)
 443 {
 444     vlc_object_t *obj = VLC_OBJECT(libvlc);
 445     struct hotkey *keys;
 446     struct vlc_actions *as = malloc (sizeof (*as) + (ACTIONS_COUNT + 1) * sizeof (*keys));
 447
 448     if (unlikely(as == NULL))
 449         return NULL;
 450     as->map = NULL;
 451     as->global_map = NULL;
 452     keys = as->keys;
 453
 454     var_Create (obj, "key-pressed", VLC_VAR_INTEGER);
 455     var_Create (obj, "global-key-pressed", VLC_VAR_INTEGER);
 456     var_Create (obj, "key-action", VLC_VAR_INTEGER);
 457
 458     /* Initialize from configuration */
 459     for (size_t i = 0; i < ACTIONS_COUNT; i++)
 460     {
 461 #ifndef NDEBUG
 462         if (i > 0
 463          && strcmp (actions[i-1].name, actions[i].name) >= 0)
 464         {
 465             msg_Err (libvlc, "key-%s and key-%s are not ordered properly",
 466                      actions[i-1].name, actions[i].name);
 467             abort ();
 468         }
 469 #endif
 470         keys->psz_action = actions[i].name;
 471         keys++;
 472
 473         char name[12 + MAXACTION];
 474
 475         snprintf (name, sizeof (name), "global-key-%s", actions[i].name);
 476         vlc_MapAction (obj, &as->map, name + 7, actions[i].value);
 477         vlc_MapAction (obj, &as->global_map, name, actions[i].value);
 478     }
 479
 480     keys->psz_action = NULL;
 481
 482     libvlc->p_hotkeys = as->keys;
 483     var_AddCallback (obj, "key-pressed", vlc_key_to_action, &as->map);
 484     var_AddCallback (obj, "global-key-pressed", vlc_key_to_action,
 485                      &as->global_map);
 486     return as;
 487 }
 488
 489 /**
 490  * Destroys the key map.
 491  */
 492 void vlc_DeinitActions (libvlc_int_t *libvlc, struct vlc_actions *as)
 493 {
 494     if (unlikely(as == NULL))
 495         return;
 496
 497     var_DelCallback (libvlc, "global-key-pressed", vlc_key_to_action,
 498                      &as->global_map);
 499     var_DelCallback (libvlc, "key-pressed", vlc_key_to_action, &as->map);
 500
 501     tdestroy (as->global_map, free);
 502     tdestroy (as->map, free);
 503     free (as);
 504     libvlc->p_hotkeys = NULL;
 505 }
 506
 507
 508 static int actcmp(const void *key, const void *ent)
 509 {
 510     const struct action *act = ent;
 511     return strcmp(key, act->name);
 512 }
 513
 514 /**
 515  * Get the action ID from the action name in the configuration subsystem.
 516  * @return the action ID or ACTIONID_NONE on error.
 517  */
 518 vlc_action_t vlc_GetActionId (const char *name)
 519 {
 520     const struct action *act;
 521
 522     if (strncmp (name, "key-", 4))
 523         return ACTIONID_NONE;
 524     name += 4;
 525
 526     act = bsearch(name, actions, ACTIONS_COUNT, sizeof(*act), actcmp);
 527     return (act != NULL) ? act->value : ACTIONID_NONE;
 528 }