60a3075bb54bd2ffb88c57a65279d00a6d86e70d
[vlc.git] / include / vlc_keys.h
1 /*****************************************************************************
2  * vlc_keys.h: keycode defines
3  *****************************************************************************
4  * Copyright (C) 2003 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 #ifndef VLC_KEYS_H
25 #define VLC_KEYS_H 1
26
27 /**
28  * \file
29  * This file defines keys, functions and structures for hotkey handling in vlc
30  *
31  */
32
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
39
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
73
74 /* TODO:
75  * The media keys are only used in win32. Support for other OSes needs to
76  * be added */
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
91
92 #define KEY_ASCII            0x0000007F
93 #define KEY_UNSET            0
94
95 typedef struct key_descriptor_s
96 {
97     const char *psz_key_string;
98     int i_key_code;
99 } key_descriptor_t;
100
101 #define ADD_KEY(a) { a, *a }
102
103 static const struct key_descriptor_s vlc_modifiers[] =
104 {
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 }
110 };
111
112 static const struct key_descriptor_s vlc_keys[] =
113 {
114     { "Unset", KEY_UNSET },
115     { "Left", KEY_LEFT },
116     { "Right", KEY_RIGHT },
117     { "Up", KEY_UP },
118     { "Down", KEY_DOWN },
119     { "Space", KEY_SPACE },
120     { "Enter", KEY_ENTER },
121     { "F1", KEY_F1 },
122     { "F2", KEY_F2 },
123     { "F3", KEY_F3 },
124     { "F4", KEY_F4 },
125     { "F5", KEY_F5 },
126     { "F6", KEY_F6 },
127     { "F7", KEY_F7 },
128     { "F8", KEY_F8 },
129     { "F9", KEY_F9 },
130     { "F10", KEY_F10 },
131     { "F11", KEY_F11 },
132     { "F12", KEY_F12 },
133     { "Home", KEY_HOME },
134     { "End", KEY_END },
135     { "Insert", KEY_INSERT },
136     { "Delete", KEY_DELETE },
137     { "Menu", KEY_MENU },
138     { "Esc", KEY_ESC },
139     { "Page Up", KEY_PAGEUP },
140     { "Page Down", KEY_PAGEDOWN },
141     { "Tab", KEY_TAB },
142     { "Backspace", KEY_BACKSPACE },
143     { "Mouse Wheel Up", KEY_MOUSEWHEELUP },
144     { "Mouse Wheel Down", KEY_MOUSEWHEELDOWN },
145     { "0", '0' },
146     { "1", '1' },
147     { "2", '2' },
148     { "3", '3' },
149     { "4", '4' },
150     { "5", '5' },
151     { "6", '6' },
152     { "7", '7' },
153     { "8", '8' },
154     { "9", '9' },
155     { "a", 'a' },
156     { "b", 'b' },
157     { "c", 'c' },
158     { "d", 'd' },
159     { "e", 'e' },
160     { "f", 'f' },
161     { "g", 'g' },
162     { "h", 'h' },
163     { "i", 'i' },
164     { "j", 'j' },
165     { "k", 'k' },
166     { "l", 'l' },
167     { "m", 'm' },
168     { "n", 'n' },
169     { "o", 'o' },
170     { "p", 'p' },
171     { "q", 'q' },
172     { "r", 'r' },
173     { "s", 's' },
174     { "t", 't' },
175     { "u", 'u' },
176     { "v", 'v' },
177     { "w", 'w' },
178     { "x", 'x' },
179     { "y", 'y' },
180     { "z", 'z' },
181     { "+", '+' },
182     { "=", '=' },
183     { "-", '-' },
184     { ",", ',' },
185     { ".", '.' },
186     { "<", '<' },
187     { ">", '>' },
188     { "`", '`' },
189     { "/", '/' },
190     { ";", ';' },
191     { "'", '\'' },
192     { "\\", '\\' },
193     { "[", '[' },
194     { "]", ']' },
195     { "*", '*' },
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 }
210 };
211
212 static inline const char *KeyToString( int i_key )
213 {
214     unsigned int i = 0;
215     for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
216     {
217         if ( vlc_keys[i].i_key_code == i_key )
218         {
219             return vlc_keys[i].psz_key_string;
220         }
221     }
222     return NULL;
223 }
224
225 static inline int StringToKey( char *psz_key )
226 {
227     unsigned int i = 0;
228     for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
229     {
230         if ( !strcmp( vlc_keys[i].psz_key_string, psz_key ))
231         {
232             return vlc_keys[i].i_key_code;
233         }
234     }
235     return 0;
236 }
237
238 typedef enum vlc_key {
239     ACTIONID_QUIT = 1,
240     ACTIONID_PLAY_PAUSE,
241     ACTIONID_PLAY,
242     ACTIONID_PAUSE,
243     ACTIONID_STOP,
244     ACTIONID_PREV,
245     ACTIONID_NEXT,
246     ACTIONID_SLOWER,
247     ACTIONID_FASTER,
248     ACTIONID_TOGGLE_FULLSCREEN,
249     ACTIONID_VOL_UP,
250     ACTIONID_VOL_DOWN,
251     ACTIONID_NAV_ACTIVATE,
252     ACTIONID_NAV_UP,
253     ACTIONID_NAV_DOWN,
254     ACTIONID_NAV_LEFT,
255     ACTIONID_NAV_RIGHT,
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,
264     ACTIONID_FRAME_NEXT,
265     ACTIONID_POSITION,
266     ACTIONID_VOL_MUTE,
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,
297     ACTIONID_INTF_SHOW,
298     ACTIONID_INTF_HIDE,
299     /* chapter and title navigation */
300     ACTIONID_TITLE_PREV,
301     ACTIONID_TITLE_NEXT,
302     ACTIONID_CHAPTER_PREV,
303     ACTIONID_CHAPTER_NEXT,
304     /* end of chapter and title navigation */
305     ACTIONID_AUDIODELAY_UP,
306     ACTIONID_AUDIODELAY_DOWN,
307     ACTIONID_SNAPSHOT,
308     ACTIONID_RECORD,
309     ACTIONID_DISC_MENU,
310     ACTIONID_ASPECT_RATIO,
311     ACTIONID_CROP,
312     ACTIONID_DEINTERLACE,
313     ACTIONID_ZOOM,
314     ACTIONID_UNZOOM,
315     ACTIONID_CROP_TOP,
316     ACTIONID_UNCROP_TOP,
317     ACTIONID_CROP_LEFT,
318     ACTIONID_UNCROP_LEFT,
319     ACTIONID_CROP_BOTTOM,
320     ACTIONID_UNCROP_BOTTOM,
321     ACTIONID_CROP_RIGHT,
322     ACTIONID_UNCROP_RIGHT,
323     ACTIONID_DUMP,
324     ACTIONID_RANDOM,
325     ACTIONID_LOOP,
326     ACTIONID_WALLPAPER,
327     ACTIONID_LEAVE_FULLSCREEN,
328     ACTIONID_MENU_ON,
329     ACTIONID_MENU_OFF,
330     ACTIONID_MENU_RIGHT,
331     ACTIONID_MENU_LEFT,
332     ACTIONID_MENU_UP,
333     ACTIONID_MENU_DOWN,
334     ACTIONID_MENU_SELECT,
335     /* Zoom */
336     ACTIONID_ZOOM_QUARTER,
337     ACTIONID_ZOOM_HALF,
338     ACTIONID_ZOOM_ORIGINAL,
339     ACTIONID_ZOOM_DOUBLE,
340     /* Cycle Through Audio Devices */
341     ACTIONID_AUDIODEVICE_CYCLE,
342     /* scaling */
343     ACTIONID_TOGGLE_AUTOSCALE,
344     ACTIONID_SCALE_UP,
345     ACTIONID_SCALE_DOWN,
346     /* */
347     ACTIONID_RATE_NORMAL,
348
349 } vlc_key_t;
350 #endif