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