A bit of vlc/libvlc cleanup:
[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 #if !defined( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 #define KEY_MODIFIER         0xFF000000
29 #define KEY_MODIFIER_ALT     0x01000000
30 #define KEY_MODIFIER_SHIFT   0x02000000
31 #define KEY_MODIFIER_CTRL    0x04000000
32 #define KEY_MODIFIER_META    0x08000000
33 #define KEY_MODIFIER_COMMAND 0x10000000
34
35 #define KEY_SPECIAL          0x00FF0000
36 #define KEY_LEFT             0x00010000
37 #define KEY_RIGHT            0x00020000
38 #define KEY_UP               0x00030000
39 #define KEY_DOWN             0x00040000
40 #define KEY_SPACE            0x00050000
41 #define KEY_ENTER            0x00060000
42 #define KEY_F1               0x00070000
43 #define KEY_F2               0x00080000
44 #define KEY_F3               0x00090000
45 #define KEY_F4               0x000A0000
46 #define KEY_F5               0x000B0000
47 #define KEY_F6               0x000C0000
48 #define KEY_F7               0x000D0000
49 #define KEY_F8               0x000E0000
50 #define KEY_F9               0x000F0000
51 #define KEY_F10              0x00100000
52 #define KEY_F11              0x00110000
53 #define KEY_F12              0x00120000
54 #define KEY_HOME             0x00130000
55 #define KEY_END              0x00140000
56 #define KEY_INSERT           0x00150000
57 #define KEY_DELETE           0x00160000
58 #define KEY_MENU             0x00170000
59 #define KEY_ESC              0x00180000
60 #define KEY_PAGEUP           0x00190000
61 #define KEY_PAGEDOWN         0x001A0000
62 #define KEY_TAB              0x001B0000
63 #define KEY_BACKSPACE        0x001C0000
64 #define KEY_MOUSEWHEELUP     0x001D0000
65 #define KEY_MOUSEWHEELDOWN   0x001E0000
66
67 /* TODO:
68  * The media keys are only used in win32. Support for other OSes needs to
69  * be added */
70 #define KEY_BROWSER_BACK     0x001F0000
71 #define KEY_BROWSER_FORWARD  0x00200000
72 #define KEY_BROWSER_REFRESH  0x00210000
73 #define KEY_BROWSER_STOP     0x00220000
74 #define KEY_BROWSER_SEARCH   0x00230000
75 #define KEY_BROWSER_FAVORITES 0x00240000
76 #define KEY_BROWSER_HOME     0x00250000
77 #define KEY_VOLUME_MUTE      0x00260000
78 #define KEY_VOLUME_DOWN      0x00270000
79 #define KEY_VOLUME_UP        0x00280000
80 #define KEY_MEDIA_NEXT_TRACK 0x00290000
81 #define KEY_MEDIA_PREV_TRACK 0x002a0000
82 #define KEY_MEDIA_STOP       0x002b0000
83 #define KEY_MEDIA_PLAY_PAUSE 0x002c0000
84
85 #define KEY_ASCII            0x0000007F
86 #define KEY_UNSET            0
87
88 typedef struct key_descriptor_s
89 {
90     const char *psz_key_string;
91     int i_key_code;
92 } key_descriptor_t;
93
94 #define ADD_KEY(a) { a, *a }
95
96 static const struct key_descriptor_s vlc_modifiers[] =
97 {
98     { "Alt", KEY_MODIFIER_ALT },
99     { "Shift", KEY_MODIFIER_SHIFT },
100     { "Ctrl", KEY_MODIFIER_CTRL },
101     { "Meta", KEY_MODIFIER_META },
102     { "Command", KEY_MODIFIER_COMMAND }
103 };
104
105 static const struct key_descriptor_s vlc_keys[] =
106 {
107     { "Unset", KEY_UNSET },
108     { "Left", KEY_LEFT },
109     { "Right", KEY_RIGHT },
110     { "Up", KEY_UP },
111     { "Down", KEY_DOWN },
112     { "Space", KEY_SPACE },
113     { "Enter", KEY_ENTER },
114     { "F1", KEY_F1 },
115     { "F2", KEY_F2 },
116     { "F3", KEY_F3 },
117     { "F4", KEY_F4 },
118     { "F5", KEY_F5 },
119     { "F6", KEY_F6 },
120     { "F7", KEY_F7 },
121     { "F8", KEY_F8 },
122     { "F9", KEY_F9 },
123     { "F10", KEY_F10 },
124     { "F11", KEY_F11 },
125     { "F12", KEY_F12 },
126     { "Home", KEY_HOME },
127     { "End", KEY_END },
128     { "Insert", KEY_INSERT },
129     { "Delete", KEY_DELETE },
130     { "Menu", KEY_MENU },
131     { "Esc", KEY_ESC },
132     { "Page Up", KEY_PAGEUP },
133     { "Page Down", KEY_PAGEDOWN },
134     { "Tab", KEY_TAB },
135     { "Backspace", KEY_BACKSPACE },
136     { "Mouse Wheel Up", KEY_MOUSEWHEELUP },
137     { "Mouse Wheel Down", KEY_MOUSEWHEELDOWN },
138     { "a", 'a' },
139     { "b", 'b' },
140     { "c", 'c' },
141     { "d", 'd' },
142     { "e", 'e' },
143     { "f", 'f' },
144     { "g", 'g' },
145     { "h", 'h' },
146     { "i", 'i' },
147     { "j", 'j' },
148     { "k", 'k' },
149     { "l", 'l' },
150     { "m", 'm' },
151     { "n", 'n' },
152     { "o", 'o' },
153     { "p", 'p' },
154     { "q", 'q' },
155     { "r", 'r' },
156     { "s", 's' },
157     { "t", 't' },
158     { "u", 'u' },
159     { "v", 'v' },
160     { "w", 'w' },
161     { "x", 'x' },
162     { "y", 'y' },
163     { "z", 'z' },
164     { "+", '+' },
165     { "=", '=' },
166     { "-", '-' },
167     { ",", ',' },
168     { ".", '.' },
169     { "<", '<' },
170     { ">", '>' },
171     { "`", '`' },
172     { "/", '/' },
173     { ";", ';' },
174     { "'", '\'' },
175     { "\\", '\\' },
176     { "[", '[' },
177     { "]", ']' },
178     { "*", '*' },
179     { "Browser Back", KEY_BROWSER_BACK },
180     { "Browser Forward", KEY_BROWSER_FORWARD },
181     { "Browser Refresh", KEY_BROWSER_REFRESH },
182     { "Browser Stop", KEY_BROWSER_STOP },
183     { "Browser Search", KEY_BROWSER_SEARCH },
184     { "Browser Favorites", KEY_BROWSER_FAVORITES },
185     { "Browser Home", KEY_BROWSER_HOME },
186     { "Volume Mute", KEY_VOLUME_MUTE },
187     { "Volume Down", KEY_VOLUME_DOWN },
188     { "Volume Up", KEY_VOLUME_UP },
189     { "Media Next Track", KEY_MEDIA_NEXT_TRACK },
190     { "Media Prev Track", KEY_MEDIA_PREV_TRACK },
191     { "Media Stop", KEY_MEDIA_STOP },
192     { "Media Play Pause", KEY_MEDIA_PLAY_PAUSE }
193 };
194
195 static inline const char *KeyToString( int i_key )
196 {
197     unsigned int i = 0;
198     for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
199     {
200         if ( vlc_keys[i].i_key_code == i_key )
201         {
202             return vlc_keys[i].psz_key_string;
203         }
204     }
205     return NULL;
206 }
207
208 static inline int StringToKey( char *psz_key )
209 {
210     unsigned int i = 0;
211     for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
212     {
213         if ( !strcmp( vlc_keys[i].psz_key_string, psz_key ))
214         {
215             return vlc_keys[i].i_key_code;
216         }
217     }
218     return 0;
219 }
220
221
222 #define ACTIONID_QUIT                  1
223 #define ACTIONID_PLAY_PAUSE            2
224 #define ACTIONID_PLAY                  3
225 #define ACTIONID_PAUSE                 4
226 #define ACTIONID_STOP                  5
227 #define ACTIONID_PREV                  6
228 #define ACTIONID_NEXT                  7
229 #define ACTIONID_SLOWER                8
230 #define ACTIONID_FASTER                9
231 #define ACTIONID_FULLSCREEN            10
232 #define ACTIONID_VOL_UP                11
233 #define ACTIONID_VOL_DOWN              12
234 #define ACTIONID_NAV_ACTIVATE          13
235 #define ACTIONID_NAV_UP                14
236 #define ACTIONID_NAV_DOWN              15
237 #define ACTIONID_NAV_LEFT              16
238 #define ACTIONID_NAV_RIGHT             17
239 #define ACTIONID_JUMP_BACKWARD_EXTRASHORT 18
240 #define ACTIONID_JUMP_FORWARD_EXTRASHORT  19
241 #define ACTIONID_JUMP_BACKWARD_SHORT   20
242 #define ACTIONID_JUMP_FORWARD_SHORT    21
243 #define ACTIONID_JUMP_BACKWARD_MEDIUM  22
244 #define ACTIONID_JUMP_FORWARD_MEDIUM   23
245 #define ACTIONID_JUMP_BACKWARD_LONG    24
246 #define ACTIONID_JUMP_FORWARD_LONG     25
247 #define ACTIONID_POSITION              26
248 #define ACTIONID_VOL_MUTE              27
249 /* let ACTIONID_SET_BOOMARK* and ACTIONID_PLAY_BOOKMARK* be contiguous */
250 #define ACTIONID_SET_BOOKMARK1         28
251 #define ACTIONID_SET_BOOKMARK2         29
252 #define ACTIONID_SET_BOOKMARK3         39
253 #define ACTIONID_SET_BOOKMARK4         31
254 #define ACTIONID_SET_BOOKMARK5         32
255 #define ACTIONID_SET_BOOKMARK6         33
256 #define ACTIONID_SET_BOOKMARK7         34
257 #define ACTIONID_SET_BOOKMARK8         35
258 #define ACTIONID_SET_BOOKMARK9         36
259 #define ACTIONID_SET_BOOKMARK10        37
260 #define ACTIONID_PLAY_BOOKMARK1        38
261 #define ACTIONID_PLAY_BOOKMARK2        39
262 #define ACTIONID_PLAY_BOOKMARK3        40
263 #define ACTIONID_PLAY_BOOKMARK4        41
264 #define ACTIONID_PLAY_BOOKMARK5        42
265 #define ACTIONID_PLAY_BOOKMARK6        43
266 #define ACTIONID_PLAY_BOOKMARK7        44
267 #define ACTIONID_PLAY_BOOKMARK8        45
268 #define ACTIONID_PLAY_BOOKMARK9        46
269 #define ACTIONID_PLAY_BOOKMARK10       47
270 /* end of contiguous zone */
271 #define ACTIONID_SUBDELAY_UP           48
272 #define ACTIONID_SUBDELAY_DOWN         49
273 #define ACTIONID_HISTORY_BACK          50
274 #define ACTIONID_HISTORY_FORWARD       51
275 #define ACTIONID_AUDIO_TRACK           52
276 #define ACTIONID_SUBTITLE_TRACK        53
277 #define ACTIONID_CUBESPEED_UP          54
278 #define ACTIONID_CUBESPEED_DOWN        55
279 #define ACTIONID_INTF_SHOW             56
280 #define ACTIONID_INTF_HIDE             57
281 /* chapter and title navigation */
282 #define ACTIONID_TITLE_PREV            58
283 #define ACTIONID_TITLE_NEXT            59
284 #define ACTIONID_CHAPTER_PREV          60
285 #define ACTIONID_CHAPTER_NEXT          61
286 /* end of chapter and title navigation */
287 #define ACTIONID_AUDIODELAY_UP         62
288 #define ACTIONID_AUDIODELAY_DOWN       63
289 #define ACTIONID_SNAPSHOT              64
290 #define ACTIONID_RECORD                65
291 #define ACTIONID_DISC_MENU             66
292 #define ACTIONID_ASPECT_RATIO          67
293 #define ACTIONID_CROP                  68
294 #define ACTIONID_DEINTERLACE           69
295 #define ACTIONID_ZOOM                  70
296 #define ACTIONID_UNZOOM                71
297 #define ACTIONID_CROP_TOP              72
298 #define ACTIONID_UNCROP_TOP            73
299 #define ACTIONID_CROP_LEFT             74
300 #define ACTIONID_UNCROP_LEFT           75
301 #define ACTIONID_CROP_BOTTOM           76
302 #define ACTIONID_UNCROP_BOTTOM         77
303 #define ACTIONID_CROP_RIGHT            78
304 #define ACTIONID_UNCROP_RIGHT          79
305 #define ACTIONID_DUMP                  80