1 /*****************************************************************************
2 * keys.c: keys configuration
3 *****************************************************************************
4 * Copyright (C) 2003-2009 VLC authors and VideoLAN
6 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
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.
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.
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 *****************************************************************************/
29 * This file defines functions and structures for hotkey handling in vlc
43 #include <vlc_common.h>
45 #include "configuration.h"
48 typedef struct key_descriptor_s
50 const char psz_key_string[20];
54 static const struct key_descriptor_s vlc_keys[] =
55 { /* Alphabetical order */
56 { N_("Backspace"), KEY_BACKSPACE },
57 { N_("Brightness Down"), KEY_BRIGHTNESS_DOWN },
58 { N_("Brightness Up"), KEY_BRIGHTNESS_UP },
59 { N_("Browser Back"), KEY_BROWSER_BACK },
60 { N_("Browser Favorites"), KEY_BROWSER_FAVORITES },
61 { N_("Browser Forward"), KEY_BROWSER_FORWARD },
62 { N_("Browser Home"), KEY_BROWSER_HOME },
63 { N_("Browser Refresh"), KEY_BROWSER_REFRESH },
64 { N_("Browser Search"), KEY_BROWSER_SEARCH },
65 { N_("Browser Stop"), KEY_BROWSER_STOP },
66 { N_("Delete"), KEY_DELETE },
67 { N_("Down"), KEY_DOWN },
68 { N_("End"), KEY_END },
69 { N_("Enter"), KEY_ENTER },
70 { N_("Esc"), KEY_ESC },
72 { N_("F10"), KEY_F10 },
73 { N_("F11"), KEY_F11 },
74 { N_("F12"), KEY_F12 },
83 { N_("Home"), KEY_HOME },
84 { N_("Insert"), KEY_INSERT },
85 { N_("Left"), KEY_LEFT },
86 { N_("Media Angle"), KEY_MEDIA_ANGLE },
87 { N_("Media Audio Track"), KEY_MEDIA_AUDIO },
88 { N_("Media Forward"), KEY_MEDIA_FORWARD },
89 { N_("Media Menu"), KEY_MEDIA_MENU },
90 { N_("Media Next Frame"), KEY_MEDIA_FRAME_NEXT },
91 { N_("Media Next Track"), KEY_MEDIA_NEXT_TRACK },
92 { N_("Media Play Pause"), KEY_MEDIA_PLAY_PAUSE },
93 { N_("Media Prev Frame"), KEY_MEDIA_FRAME_PREV },
94 { N_("Media Prev Track"), KEY_MEDIA_PREV_TRACK },
95 { N_("Media Record"), KEY_MEDIA_RECORD },
96 { N_("Media Repeat"), KEY_MEDIA_REPEAT },
97 { N_("Media Rewind"), KEY_MEDIA_REWIND },
98 { N_("Media Select"), KEY_MEDIA_SELECT },
99 { N_("Media Shuffle"), KEY_MEDIA_SHUFFLE },
100 { N_("Media Stop"), KEY_MEDIA_STOP },
101 { N_("Media Subtitle"), KEY_MEDIA_SUBTITLE },
102 { N_("Media Time"), KEY_MEDIA_TIME },
103 { N_("Media View"), KEY_MEDIA_VIEW },
104 { N_("Menu"), KEY_MENU },
105 { N_("Mouse Wheel Down"), KEY_MOUSEWHEELDOWN },
106 { N_("Mouse Wheel Left"), KEY_MOUSEWHEELLEFT },
107 { N_("Mouse Wheel Right"), KEY_MOUSEWHEELRIGHT },
108 { N_("Mouse Wheel Up"), KEY_MOUSEWHEELUP },
109 { N_("Page Down"), KEY_PAGEDOWN },
110 { N_("Page Up"), KEY_PAGEUP },
111 { N_("Pause"), KEY_PAUSE },
112 { N_("Print"), KEY_PRINT },
113 { N_("Right"), KEY_RIGHT },
114 { N_("Space"), ' ' },
115 { N_("Tab"), KEY_TAB },
116 { N_("Unset"), KEY_UNSET },
117 { N_("Up"), KEY_UP },
118 { N_("Volume Down"), KEY_VOLUME_DOWN },
119 { N_("Volume Mute"), KEY_VOLUME_MUTE },
120 { N_("Volume Up"), KEY_VOLUME_UP },
121 { N_("Zoom In"), KEY_ZOOM_IN },
122 { N_("Zoom Out"), KEY_ZOOM_OUT },
124 #define KEYS_COUNT (sizeof(vlc_keys)/sizeof(vlc_keys[0]))
126 static int keystrcmp (const void *key, const void *elem)
128 const char *sa = key, *sb = elem;
129 return strcmp (sa, sb);
132 /* Convert Unicode code point to UTF-8 */
133 static char *utf8_cp (uint_fast32_t cp, char *buf)
140 else if (cp < (1 << 11))
143 buf[1] = 0x80 | (cp & 0x3F);
147 else if (cp < (1 << 16))
150 buf[2] = 0x80 | (cp & 0x3F);
152 buf[1] = 0x80 | (cp & 0x3F);
156 else if (cp < (1 << 21))
159 buf[3] = 0x80 | (cp & 0x3F);
161 buf[2] = 0x80 | (cp & 0x3F);
163 buf[1] = 0x80 | (cp & 0x3F);
173 * Parse a human-readable string representation of a VLC key code.
174 * @note This only works with the American English representation
175 * (a.k.a. C or POSIX), not with the local representation returned from
177 * @return a VLC key code, or KEY_UNSET on failure.
179 uint_fast32_t vlc_str2keycode (const char *name)
181 uint_fast32_t mods = 0;
186 size_t len = strcspn (name, "-+");
187 if (len == 0 || name[len] == '\0')
190 if (len == 4 && !strncasecmp (name, "Ctrl", 4))
191 mods |= KEY_MODIFIER_CTRL;
192 if (len == 3 && !strncasecmp (name, "Alt", 3))
193 mods |= KEY_MODIFIER_ALT;
194 if (len == 5 && !strncasecmp (name, "Shift", 5))
195 mods |= KEY_MODIFIER_SHIFT;
196 if (len == 4 && !strncasecmp (name, "Meta", 4))
197 mods |= KEY_MODIFIER_META;
198 if (len == 7 && !strncasecmp (name, "Command", 7))
199 mods |= KEY_MODIFIER_COMMAND;
204 key_descriptor_t *d = bsearch (name, vlc_keys, KEYS_COUNT,
205 sizeof (vlc_keys[0]), keystrcmp);
207 code = d->i_key_code;
209 if (vlc_towc (name, &code) <= 0)
212 if (code != KEY_UNSET)
217 static char *nooptext (const char *txt)
223 * Format a human-readable and unique representation of a VLC key code
224 * (including modifiers).
225 * @param code key code to translate to a string
226 * @param locale true to get a localized string,
227 * false to get a C string suitable for 'vlcrc'
228 * @return a heap-allocated string, or NULL on error.
230 char *vlc_keycode2str (uint_fast32_t code, bool locale)
232 char *(*tr) (const char *) = locale ? vlc_gettext : nooptext;
235 uintptr_t key = code & ~KEY_MODIFIER;
237 for (size_t i = 0; i < KEYS_COUNT; i++)
238 if (vlc_keys[i].i_key_code == key)
240 name = vlc_keys[i].psz_key_string;
244 if (utf8_cp (key, buf) == NULL)
249 if (asprintf (&str, "%s%s%s%s%s%s",
250 (code & KEY_MODIFIER_CTRL) ? tr(N_("Ctrl+")) : "",
251 (code & KEY_MODIFIER_ALT) ? tr(N_("Alt+")) : "",
252 (code & KEY_MODIFIER_SHIFT) ? tr(N_("Shift+")) : "",
253 (code & KEY_MODIFIER_META) ? tr(N_("Meta+")) : "",
254 (code & KEY_MODIFIER_COMMAND) ? tr(N_("Command+")) : "",
261 /*** VLC key map ***/
266 char name[MAXACTION];
270 static const struct action actions[] =
272 /* *MUST* be sorted (ASCII order) */
273 { "aspect-ratio", ACTIONID_ASPECT_RATIO, },
274 { "audio-track", ACTIONID_AUDIO_TRACK, },
275 { "audiodelay-down", ACTIONID_AUDIODELAY_DOWN, },
276 { "audiodelay-up", ACTIONID_AUDIODELAY_UP, },
277 { "audiodevice-cycle", ACTIONID_AUDIODEVICE_CYCLE, },
278 { "chapter-next", ACTIONID_CHAPTER_NEXT, },
279 { "chapter-prev", ACTIONID_CHAPTER_PREV, },
280 { "clear-playlist", ACTIONID_PLAY_CLEAR, },
281 { "crop", ACTIONID_CROP, },
282 { "crop-bottom", ACTIONID_CROP_BOTTOM, },
283 { "crop-left", ACTIONID_CROP_LEFT, },
284 { "crop-right", ACTIONID_CROP_RIGHT, },
285 { "crop-top", ACTIONID_CROP_TOP, },
286 { "decr-scalefactor", ACTIONID_SCALE_DOWN, },
287 { "deinterlace", ACTIONID_DEINTERLACE, },
288 { "deinterlace-mode", ACTIONID_DEINTERLACE_MODE, },
289 { "disc-menu", ACTIONID_DISC_MENU, },
290 { "faster", ACTIONID_FASTER, },
291 { "frame-next", ACTIONID_FRAME_NEXT, },
292 { "incr-scalefactor", ACTIONID_SCALE_UP, },
293 { "intf-boss", ACTIONID_INTF_BOSS, },
294 { "intf-popup-menu", ACTIONID_INTF_POPUP_MENU, },
295 { "intf-show", ACTIONID_INTF_TOGGLE_FSC, },
296 { "jump+extrashort", ACTIONID_JUMP_FORWARD_EXTRASHORT, },
297 { "jump+long", ACTIONID_JUMP_FORWARD_LONG, },
298 { "jump+medium", ACTIONID_JUMP_FORWARD_MEDIUM, },
299 { "jump+short", ACTIONID_JUMP_FORWARD_SHORT, },
300 { "jump-extrashort", ACTIONID_JUMP_BACKWARD_EXTRASHORT, },
301 { "jump-long", ACTIONID_JUMP_BACKWARD_LONG, },
302 { "jump-medium", ACTIONID_JUMP_BACKWARD_MEDIUM, },
303 { "jump-short", ACTIONID_JUMP_BACKWARD_SHORT, },
304 { "leave-fullscreen", ACTIONID_LEAVE_FULLSCREEN, },
305 { "loop", ACTIONID_LOOP, },
306 { "nav-activate", ACTIONID_NAV_ACTIVATE, },
307 { "nav-down", ACTIONID_NAV_DOWN, },
308 { "nav-left", ACTIONID_NAV_LEFT, },
309 { "nav-right", ACTIONID_NAV_RIGHT, },
310 { "nav-up", ACTIONID_NAV_UP, },
311 { "next", ACTIONID_NEXT, },
312 { "pause", ACTIONID_PAUSE, },
313 { "play", ACTIONID_PLAY, },
314 { "play-bookmark1", ACTIONID_PLAY_BOOKMARK1, },
315 { "play-bookmark10", ACTIONID_PLAY_BOOKMARK10, },
316 { "play-bookmark2", ACTIONID_PLAY_BOOKMARK2, },
317 { "play-bookmark3", ACTIONID_PLAY_BOOKMARK3, },
318 { "play-bookmark4", ACTIONID_PLAY_BOOKMARK4, },
319 { "play-bookmark5", ACTIONID_PLAY_BOOKMARK5, },
320 { "play-bookmark6", ACTIONID_PLAY_BOOKMARK6, },
321 { "play-bookmark7", ACTIONID_PLAY_BOOKMARK7, },
322 { "play-bookmark8", ACTIONID_PLAY_BOOKMARK8, },
323 { "play-bookmark9", ACTIONID_PLAY_BOOKMARK9, },
324 { "play-pause", ACTIONID_PLAY_PAUSE, },
325 { "position", ACTIONID_POSITION, },
326 { "prev", ACTIONID_PREV, },
327 { "program-sid-next", ACTIONID_PROGRAM_SID_NEXT, },
328 { "program-sid-prev", ACTIONID_PROGRAM_SID_PREV, },
329 { "quit", ACTIONID_QUIT, },
330 { "random", ACTIONID_RANDOM, },
331 { "rate-faster-fine", ACTIONID_RATE_FASTER_FINE, },
332 { "rate-normal", ACTIONID_RATE_NORMAL, },
333 { "rate-slower-fine", ACTIONID_RATE_SLOWER_FINE, },
334 { "record", ACTIONID_RECORD, },
335 { "set-bookmark1", ACTIONID_SET_BOOKMARK1, },
336 { "set-bookmark10", ACTIONID_SET_BOOKMARK10, },
337 { "set-bookmark2", ACTIONID_SET_BOOKMARK2, },
338 { "set-bookmark3", ACTIONID_SET_BOOKMARK3, },
339 { "set-bookmark4", ACTIONID_SET_BOOKMARK4, },
340 { "set-bookmark5", ACTIONID_SET_BOOKMARK5, },
341 { "set-bookmark6", ACTIONID_SET_BOOKMARK6, },
342 { "set-bookmark7", ACTIONID_SET_BOOKMARK7, },
343 { "set-bookmark8", ACTIONID_SET_BOOKMARK8, },
344 { "set-bookmark9", ACTIONID_SET_BOOKMARK9, },
345 { "slower", ACTIONID_SLOWER, },
346 { "snapshot", ACTIONID_SNAPSHOT, },
347 { "stop", ACTIONID_STOP, },
348 { "subdelay-down", ACTIONID_SUBDELAY_DOWN, },
349 { "subdelay-up", ACTIONID_SUBDELAY_UP, },
350 { "subpos-down", ACTIONID_SUBPOS_DOWN, },
351 { "subpos-up", ACTIONID_SUBPOS_UP, },
352 { "subsync-apply", ACTIONID_SUBSYNC_APPLY, },
353 { "subsync-markaudio", ACTIONID_SUBSYNC_MARKAUDIO, },
354 { "subsync-marksub", ACTIONID_SUBSYNC_MARKSUB, },
355 { "subsync-reset", ACTIONID_SUBSYNC_RESET, },
356 { "subtitle-toggle", ACTIONID_SUBTITLE_TOGGLE, },
357 { "subtitle-track", ACTIONID_SUBTITLE_TRACK, },
358 { "title-next", ACTIONID_TITLE_NEXT, },
359 { "title-prev", ACTIONID_TITLE_PREV, },
360 { "toggle-autoscale", ACTIONID_TOGGLE_AUTOSCALE, },
361 { "toggle-fullscreen", ACTIONID_TOGGLE_FULLSCREEN, },
362 { "uncrop-bottom", ACTIONID_UNCROP_BOTTOM, },
363 { "uncrop-left", ACTIONID_UNCROP_LEFT, },
364 { "uncrop-right", ACTIONID_UNCROP_RIGHT, },
365 { "uncrop-top", ACTIONID_UNCROP_TOP, },
366 { "unzoom", ACTIONID_UNZOOM, },
367 { "vol-down", ACTIONID_VOL_DOWN, },
368 { "vol-mute", ACTIONID_VOL_MUTE, },
369 { "vol-up", ACTIONID_VOL_UP, },
370 { "wallpaper", ACTIONID_WALLPAPER, },
371 { "zoom", ACTIONID_ZOOM, },
372 { "zoom-double", ACTIONID_ZOOM_DOUBLE, },
373 { "zoom-half", ACTIONID_ZOOM_HALF, },
374 { "zoom-original", ACTIONID_ZOOM_ORIGINAL, },
375 { "zoom-quarter", ACTIONID_ZOOM_QUARTER, },
377 #define ACTIONS_COUNT (sizeof (actions) / sizeof (actions[0]))
381 uint32_t key; ///< Key code
382 vlc_action_t action; ///< Action ID
385 static int keycmp (const void *a, const void *b)
387 const struct mapping *ka = a, *kb = b;
389 return (ka->key < kb->key) ? -1 : (ka->key > kb->key) ? +1 : 0;
394 void *map; /* Key map */
395 void *global_map; /* Grabbed/global key map */
396 struct hotkey keys[1];
399 static int vlc_key_to_action (vlc_object_t *obj, const char *varname,
400 vlc_value_t prevkey, vlc_value_t curkey, void *d)
402 void *const *map = d;
403 const struct mapping **pent;
404 uint32_t keycode = curkey.i_int;
406 pent = tfind (&keycode, map, keycmp);
412 return var_SetInteger (obj, "key-action", (*pent)->action);
416 * Adds a mapping from a certain key code to a certain action.
418 static int vlc_AddMapping (void **map, uint32_t keycode, vlc_action_t action)
420 struct mapping *entry = malloc (sizeof (*entry));
423 entry->key = keycode;
424 entry->action = action;
426 struct mapping **pent = tsearch (entry, map, keycmp);
427 if (unlikely(pent == NULL))
437 static void vlc_AddWheelMapping (void **map, uint32_t kmore, uint32_t kless,
440 vlc_action_t amore = ACTIONID_NONE, aless = ACTIONID_NONE;
444 case 0: /* volume up/down */
445 amore = ACTIONID_VOL_UP;
446 aless = ACTIONID_VOL_DOWN;
448 case 2: /* position latter/earlier */
449 amore = ACTIONID_JUMP_FORWARD_EXTRASHORT;
450 aless = ACTIONID_JUMP_BACKWARD_EXTRASHORT;
452 case 3: /* position earlier/latter */
453 amore = ACTIONID_JUMP_BACKWARD_EXTRASHORT;
454 aless = ACTIONID_JUMP_FORWARD_EXTRASHORT;
458 if (amore != ACTIONID_NONE)
459 vlc_AddMapping (map, kmore, amore);
460 if (aless != ACTIONID_NONE)
461 vlc_AddMapping (map, kless, aless);
466 * Sets up all key mappings for a given action.
467 * \param map tree (of struct mapping entries) to write mappings to
468 * \param confname VLC configuration item to read mappings from
469 * \param action action ID
471 static void vlc_InitAction (vlc_object_t *obj, void **map,
472 const char *confname, vlc_action_t action)
474 char *keys = var_InheritString (obj, confname);
478 for (char *buf, *key = strtok_r (keys, "\t", &buf);
480 key = strtok_r (NULL, "\t", &buf))
482 uint32_t code = vlc_str2keycode (key);
483 if (code == KEY_UNSET)
485 msg_Warn (obj, "Key \"%s\" unrecognized", key);
489 if (vlc_AddMapping (map, code, action) == EEXIST)
490 msg_Warn (obj, "Key \"%s\" bound to multiple actions", key);
496 * Initializes the key map from configuration.
498 struct vlc_actions *vlc_InitActions (libvlc_int_t *libvlc)
500 vlc_object_t *obj = VLC_OBJECT(libvlc);
502 struct vlc_actions *as = malloc (sizeof (*as) + ACTIONS_COUNT * sizeof (*keys));
504 if (unlikely(as == NULL))
507 as->global_map = NULL;
510 var_Create (obj, "key-pressed", VLC_VAR_INTEGER);
511 var_Create (obj, "global-key-pressed", VLC_VAR_INTEGER);
512 var_Create (obj, "key-action", VLC_VAR_INTEGER);
514 /* Initialize from configuration */
515 for (size_t i = 0; i < ACTIONS_COUNT; i++)
519 && strcmp (actions[i-1].name, actions[i].name) >= 0)
521 msg_Err (libvlc, "key-%s and key-%s are not ordered properly",
522 actions[i-1].name, actions[i].name);
526 keys->psz_action = actions[i].name;
529 char name[12 + MAXACTION];
531 snprintf (name, sizeof (name), "global-key-%s", actions[i].name);
532 vlc_InitAction (obj, &as->map, name + 7, actions[i].value);
533 vlc_InitAction (obj, &as->global_map, name, actions[i].value);
535 keys->psz_action = NULL;
537 /* Initialize mouse wheel events */
538 vlc_AddWheelMapping (&as->map, KEY_MOUSEWHEELRIGHT, KEY_MOUSEWHEELLEFT,
539 var_InheritInteger (obj, "hotkeys-x-wheel-mode"));
540 vlc_AddWheelMapping (&as->map, KEY_MOUSEWHEELUP, KEY_MOUSEWHEELDOWN,
541 var_InheritInteger (obj, "hotkeys-y-wheel-mode"));
543 libvlc->p_hotkeys = as->keys;
544 var_AddCallback (obj, "key-pressed", vlc_key_to_action, &as->map);
545 var_AddCallback (obj, "global-key-pressed", vlc_key_to_action,
551 * Destroys the key map.
553 void vlc_DeinitActions (libvlc_int_t *libvlc, struct vlc_actions *as)
555 if (unlikely(as == NULL))
558 var_DelCallback (libvlc, "global-key-pressed", vlc_key_to_action,
560 var_DelCallback (libvlc, "key-pressed", vlc_key_to_action, &as->map);
562 tdestroy (as->global_map, free);
563 tdestroy (as->map, free);
565 libvlc->p_hotkeys = NULL;
569 static int actcmp(const void *key, const void *ent)
571 const struct action *act = ent;
572 return strcmp(key, act->name);
576 * Get the action ID from the action name in the configuration subsystem.
577 * @return the action ID or ACTIONID_NONE on error.
579 vlc_action_t vlc_GetActionId (const char *name)
581 const struct action *act;
583 if (strncmp (name, "key-", 4))
584 return ACTIONID_NONE;
587 act = bsearch(name, actions, ACTIONS_COUNT, sizeof(*act), actcmp);
588 return (act != NULL) ? act->value : ACTIONID_NONE;