1 /*****************************************************************************
2 * vlc_keys.h: keycode defines
3 *****************************************************************************
4 * Copyright (C) 2003 the VideoLAN team
7 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
29 * This file defines keys, functions and structures for hotkey handling in vlc
33 #define KEY_MODIFIER 0xFF000000
34 #define KEY_MODIFIER_ALT 0x01000000
35 #define KEY_MODIFIER_SHIFT 0x02000000
36 #define KEY_MODIFIER_CTRL 0x04000000
37 #define KEY_MODIFIER_META 0x08000000
38 #define KEY_MODIFIER_COMMAND 0x10000000
40 #define KEY_SPECIAL 0x00FF0000
41 #define KEY_LEFT 0x00010000
42 #define KEY_RIGHT 0x00020000
43 #define KEY_UP 0x00030000
44 #define KEY_DOWN 0x00040000
45 #define KEY_SPACE 0x00050000
46 #define KEY_ENTER 0x00060000
47 #define KEY_F1 0x00070000
48 #define KEY_F2 0x00080000
49 #define KEY_F3 0x00090000
50 #define KEY_F4 0x000A0000
51 #define KEY_F5 0x000B0000
52 #define KEY_F6 0x000C0000
53 #define KEY_F7 0x000D0000
54 #define KEY_F8 0x000E0000
55 #define KEY_F9 0x000F0000
56 #define KEY_F10 0x00100000
57 #define KEY_F11 0x00110000
58 #define KEY_F12 0x00120000
59 #define KEY_HOME 0x00130000
60 #define KEY_END 0x00140000
61 #define KEY_INSERT 0x00150000
62 #define KEY_DELETE 0x00160000
63 #define KEY_MENU 0x00170000
64 #define KEY_ESC 0x00180000
65 #define KEY_PAGEUP 0x00190000
66 #define KEY_PAGEDOWN 0x001A0000
67 #define KEY_TAB 0x001B0000
68 #define KEY_BACKSPACE 0x001C0000
69 #define KEY_MOUSEWHEELUP 0x001D0000
70 #define KEY_MOUSEWHEELDOWN 0x001E0000
71 #define KEY_MOUSEWHEELLEFT 0x001F0000
72 #define KEY_MOUSEWHEELRIGHT 0x00200000
75 * The media keys are only used in win32. Support for other OSes needs to
77 #define KEY_BROWSER_BACK 0x001F0000
78 #define KEY_BROWSER_FORWARD 0x00200000
79 #define KEY_BROWSER_REFRESH 0x00210000
80 #define KEY_BROWSER_STOP 0x00220000
81 #define KEY_BROWSER_SEARCH 0x00230000
82 #define KEY_BROWSER_FAVORITES 0x00240000
83 #define KEY_BROWSER_HOME 0x00250000
84 #define KEY_VOLUME_MUTE 0x00260000
85 #define KEY_VOLUME_DOWN 0x00270000
86 #define KEY_VOLUME_UP 0x00280000
87 #define KEY_MEDIA_NEXT_TRACK 0x00290000
88 #define KEY_MEDIA_PREV_TRACK 0x002a0000
89 #define KEY_MEDIA_STOP 0x002b0000
90 #define KEY_MEDIA_PLAY_PAUSE 0x002c0000
92 #define KEY_ASCII 0x0000007F
95 typedef struct key_descriptor_s
97 const char *psz_key_string;
101 #define ADD_KEY(a) { a, *a }
103 static const struct key_descriptor_s vlc_modifiers[] =
105 { "Alt", KEY_MODIFIER_ALT },
106 { "Shift", KEY_MODIFIER_SHIFT },
107 { "Ctrl", KEY_MODIFIER_CTRL },
108 { "Meta", KEY_MODIFIER_META },
109 { "Command", KEY_MODIFIER_COMMAND }
112 static const struct key_descriptor_s vlc_keys[] =
114 { "Unset", KEY_UNSET },
115 { "Left", KEY_LEFT },
116 { "Right", KEY_RIGHT },
118 { "Down", KEY_DOWN },
119 { "Space", KEY_SPACE },
120 { "Enter", KEY_ENTER },
133 { "Home", KEY_HOME },
135 { "Insert", KEY_INSERT },
136 { "Delete", KEY_DELETE },
137 { "Menu", KEY_MENU },
139 { "Page Up", KEY_PAGEUP },
140 { "Page Down", KEY_PAGEDOWN },
142 { "Backspace", KEY_BACKSPACE },
143 { "Mouse Wheel Up", KEY_MOUSEWHEELUP },
144 { "Mouse Wheel Down", KEY_MOUSEWHEELDOWN },
196 { "Browser Back", KEY_BROWSER_BACK },
197 { "Browser Forward", KEY_BROWSER_FORWARD },
198 { "Browser Refresh", KEY_BROWSER_REFRESH },
199 { "Browser Stop", KEY_BROWSER_STOP },
200 { "Browser Search", KEY_BROWSER_SEARCH },
201 { "Browser Favorites", KEY_BROWSER_FAVORITES },
202 { "Browser Home", KEY_BROWSER_HOME },
203 { "Volume Mute", KEY_VOLUME_MUTE },
204 { "Volume Down", KEY_VOLUME_DOWN },
205 { "Volume Up", KEY_VOLUME_UP },
206 { "Media Next Track", KEY_MEDIA_NEXT_TRACK },
207 { "Media Prev Track", KEY_MEDIA_PREV_TRACK },
208 { "Media Stop", KEY_MEDIA_STOP },
209 { "Media Play Pause", KEY_MEDIA_PLAY_PAUSE }
212 static inline const char *KeyToString( int i_key )
215 for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
217 if ( vlc_keys[i].i_key_code == i_key )
219 return vlc_keys[i].psz_key_string;
225 static inline int StringToKey( char *psz_key )
228 for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
230 if ( !strcmp( vlc_keys[i].psz_key_string, psz_key ))
232 return vlc_keys[i].i_key_code;
238 typedef enum vlc_key {
248 ACTIONID_TOGGLE_FULLSCREEN,
251 ACTIONID_NAV_ACTIVATE,
256 ACTIONID_JUMP_BACKWARD_EXTRASHORT,
257 ACTIONID_JUMP_FORWARD_EXTRASHORT,
258 ACTIONID_JUMP_BACKWARD_SHORT,
259 ACTIONID_JUMP_FORWARD_SHORT,
260 ACTIONID_JUMP_BACKWARD_MEDIUM,
261 ACTIONID_JUMP_FORWARD_MEDIUM,
262 ACTIONID_JUMP_BACKWARD_LONG,
263 ACTIONID_JUMP_FORWARD_LONG,
267 /* let ACTIONID_SET_BOOMARK* and ACTIONID_PLAY_BOOKMARK* be contiguous */
268 ACTIONID_SET_BOOKMARK1,
269 ACTIONID_SET_BOOKMARK2,
270 ACTIONID_SET_BOOKMARK3,
271 ACTIONID_SET_BOOKMARK4,
272 ACTIONID_SET_BOOKMARK5,
273 ACTIONID_SET_BOOKMARK6,
274 ACTIONID_SET_BOOKMARK7,
275 ACTIONID_SET_BOOKMARK8,
276 ACTIONID_SET_BOOKMARK9,
277 ACTIONID_SET_BOOKMARK10,
278 ACTIONID_PLAY_BOOKMARK1,
279 ACTIONID_PLAY_BOOKMARK2,
280 ACTIONID_PLAY_BOOKMARK3,
281 ACTIONID_PLAY_BOOKMARK4,
282 ACTIONID_PLAY_BOOKMARK5,
283 ACTIONID_PLAY_BOOKMARK6,
284 ACTIONID_PLAY_BOOKMARK7,
285 ACTIONID_PLAY_BOOKMARK8,
286 ACTIONID_PLAY_BOOKMARK9,
287 ACTIONID_PLAY_BOOKMARK10,
288 /* end of contiguous zone */
289 ACTIONID_SUBDELAY_UP,
290 ACTIONID_SUBDELAY_DOWN,
291 ACTIONID_HISTORY_BACK,
292 ACTIONID_HISTORY_FORWARD,
293 ACTIONID_AUDIO_TRACK,
294 ACTIONID_SUBTITLE_TRACK,
295 ACTIONID_CUBESPEED_UP,
296 ACTIONID_CUBESPEED_DOWN,
299 /* chapter and title navigation */
302 ACTIONID_CHAPTER_PREV,
303 ACTIONID_CHAPTER_NEXT,
304 /* end of chapter and title navigation */
305 ACTIONID_AUDIODELAY_UP,
306 ACTIONID_AUDIODELAY_DOWN,
310 ACTIONID_ASPECT_RATIO,
312 ACTIONID_DEINTERLACE,
318 ACTIONID_UNCROP_LEFT,
319 ACTIONID_CROP_BOTTOM,
320 ACTIONID_UNCROP_BOTTOM,
322 ACTIONID_UNCROP_RIGHT,
327 ACTIONID_LEAVE_FULLSCREEN,
334 ACTIONID_MENU_SELECT,
336 ACTIONID_ZOOM_QUARTER,
338 ACTIONID_ZOOM_ORIGINAL,
339 ACTIONID_ZOOM_DOUBLE,
340 /* Cycle Through Audio Devices */
341 ACTIONID_AUDIODEVICE_CYCLE