]> git.sesse.net Git - vlc/blobdiff - include/vlc_keys.h
Merge branch 1.0-bugfix
[vlc] / include / vlc_keys.h
index f101e519efbf85d605aaee7e9932c83e50d3fcf7..f78fd3a60dc1002da48d20b4b888716634e2dbcb 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#ifndef VLC_KEYS_H
+#define VLC_KEYS_H 1
+
+/**
+ * \file
+ * This file defines keys, functions and structures for hotkey handling in vlc
+ *
+ */
+
 #define KEY_MODIFIER         0xFF000000
 #define KEY_MODIFIER_ALT     0x01000000
 #define KEY_MODIFIER_SHIFT   0x02000000
 #define KEY_BACKSPACE        0x001C0000
 #define KEY_MOUSEWHEELUP     0x001D0000
 #define KEY_MOUSEWHEELDOWN   0x001E0000
+#define KEY_MOUSEWHEELLEFT   0x001F0000
+#define KEY_MOUSEWHEELRIGHT  0x00200000
+
+/* TODO:
+ * The media keys are only used in win32. Support for other OSes needs to
+ * be added */
+#define KEY_BROWSER_BACK     0x001F0000
+#define KEY_BROWSER_FORWARD  0x00200000
+#define KEY_BROWSER_REFRESH  0x00210000
+#define KEY_BROWSER_STOP     0x00220000
+#define KEY_BROWSER_SEARCH   0x00230000
+#define KEY_BROWSER_FAVORITES 0x00240000
+#define KEY_BROWSER_HOME     0x00250000
+#define KEY_VOLUME_MUTE      0x00260000
+#define KEY_VOLUME_DOWN      0x00270000
+#define KEY_VOLUME_UP        0x00280000
+#define KEY_MEDIA_NEXT_TRACK 0x00290000
+#define KEY_MEDIA_PREV_TRACK 0x002a0000
+#define KEY_MEDIA_STOP       0x002b0000
+#define KEY_MEDIA_PLAY_PAUSE 0x002c0000
 
 #define KEY_ASCII            0x0000007F
 #define KEY_UNSET            0
 
 typedef struct key_descriptor_s
 {
-    char *psz_key_string;
+    const char *psz_key_string;
     int i_key_code;
 } key_descriptor_t;
 
@@ -79,6 +108,8 @@ static const struct key_descriptor_s vlc_modifiers[] =
     { "Meta", KEY_MODIFIER_META },
     { "Command", KEY_MODIFIER_COMMAND }
 };
+enum { vlc_num_modifiers=sizeof(vlc_modifiers)
+                        /sizeof(struct key_descriptor_s) };
 
 static const struct key_descriptor_s vlc_keys[] =
 {
@@ -113,6 +144,16 @@ static const struct key_descriptor_s vlc_keys[] =
     { "Backspace", KEY_BACKSPACE },
     { "Mouse Wheel Up", KEY_MOUSEWHEELUP },
     { "Mouse Wheel Down", KEY_MOUSEWHEELDOWN },
+    { "0", '0' },
+    { "1", '1' },
+    { "2", '2' },
+    { "3", '3' },
+    { "4", '4' },
+    { "5", '5' },
+    { "6", '6' },
+    { "7", '7' },
+    { "8", '8' },
+    { "9", '9' },
     { "a", 'a' },
     { "b", 'b' },
     { "c", 'c' },
@@ -139,27 +180,55 @@ static const struct key_descriptor_s vlc_keys[] =
     { "x", 'x' },
     { "y", 'y' },
     { "z", 'z' },
+    { "!", '!' },
+    { "\"", '\"' },
+    { "#", '#' },
+    { "$", '$' },
+    { "%", '%' },
+    { "&", '&' },
+    { "'", '\'' },
+    { "(", ')' },
+    { ")", ')' },
+    { "*", '*' },
     { "+", '+' },
-    { "=", '=' },
-    { "-", '-' },
     { ",", ',' },
+    { "-", '-' },
     { ".", '.' },
-    { "<", '<' },
-    { ">", '>' },
-    { "`", '`' },
     { "/", '/' },
+    { ":", ':' },
     { ";", ';' },
-    { "'", '\'' },
-    { "\\", '\\' },
+    { "<", '<' },
+    { "=", '=' },
+    { ">", '>' },
+    { "?", '?' },
+    { "@", '@' },
     { "[", '[' },
+    { "\\", '\\' },
     { "]", ']' },
-    { "*", '*' }
+    { "^", '^' },
+    { "_", '_' },
+    { "`", '`' },
+    { "Browser Back", KEY_BROWSER_BACK },
+    { "Browser Forward", KEY_BROWSER_FORWARD },
+    { "Browser Refresh", KEY_BROWSER_REFRESH },
+    { "Browser Stop", KEY_BROWSER_STOP },
+    { "Browser Search", KEY_BROWSER_SEARCH },
+    { "Browser Favorites", KEY_BROWSER_FAVORITES },
+    { "Browser Home", KEY_BROWSER_HOME },
+    { "Volume Mute", KEY_VOLUME_MUTE },
+    { "Volume Down", KEY_VOLUME_DOWN },
+    { "Volume Up", KEY_VOLUME_UP },
+    { "Media Next Track", KEY_MEDIA_NEXT_TRACK },
+    { "Media Prev Track", KEY_MEDIA_PREV_TRACK },
+    { "Media Stop", KEY_MEDIA_STOP },
+    { "Media Play Pause", KEY_MEDIA_PLAY_PAUSE }
 };
+enum { vlc_num_keys=sizeof(vlc_keys)/sizeof(struct key_descriptor_s) };
 
-static inline char *KeyToString( int i_key )
+static inline const char *KeyToString( int i_key )
 {
-    unsigned int i = 0;
-    for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
+    size_t i;
+    for ( i = 0; i < vlc_num_keys; ++i )
     {
         if ( vlc_keys[i].i_key_code == i_key )
         {
@@ -171,8 +240,8 @@ static inline char *KeyToString( int i_key )
 
 static inline int StringToKey( char *psz_key )
 {
-    unsigned int i = 0;
-    for ( i = 0; i < sizeof(vlc_keys) / sizeof(key_descriptor_t); i++ )
+    size_t i;
+    for ( i = 0; i < vlc_num_keys; ++i )
     {
         if ( !strcmp( vlc_keys[i].psz_key_string, psz_key ))
         {
@@ -182,87 +251,118 @@ static inline int StringToKey( char *psz_key )
     return 0;
 }
 
-
-#define ACTIONID_QUIT                  1
-#define ACTIONID_PLAY_PAUSE            2
-#define ACTIONID_PLAY                  3
-#define ACTIONID_PAUSE                 4
-#define ACTIONID_STOP                  5
-#define ACTIONID_PREV                  6
-#define ACTIONID_NEXT                  7
-#define ACTIONID_SLOWER                8
-#define ACTIONID_FASTER                9
-#define ACTIONID_FULLSCREEN            10
-#define ACTIONID_VOL_UP                11
-#define ACTIONID_VOL_DOWN              12
-#define ACTIONID_NAV_ACTIVATE          13
-#define ACTIONID_NAV_UP                14
-#define ACTIONID_NAV_DOWN              15
-#define ACTIONID_NAV_LEFT              16
-#define ACTIONID_NAV_RIGHT             17
-#define ACTIONID_JUMP_BACKWARD_EXTRASHORT 18
-#define ACTIONID_JUMP_FORWARD_EXTRASHORT  19
-#define ACTIONID_JUMP_BACKWARD_SHORT   20
-#define ACTIONID_JUMP_FORWARD_SHORT    21
-#define ACTIONID_JUMP_BACKWARD_MEDIUM  22
-#define ACTIONID_JUMP_FORWARD_MEDIUM   23
-#define ACTIONID_JUMP_BACKWARD_LONG    24
-#define ACTIONID_JUMP_FORWARD_LONG     25
-#define ACTIONID_POSITION              26
-#define ACTIONID_VOL_MUTE              27
+typedef enum vlc_key {
+    ACTIONID_QUIT = 1,
+    ACTIONID_PLAY_PAUSE,
+    ACTIONID_PLAY,
+    ACTIONID_PAUSE,
+    ACTIONID_STOP,
+    ACTIONID_PREV,
+    ACTIONID_NEXT,
+    ACTIONID_SLOWER,
+    ACTIONID_FASTER,
+    ACTIONID_TOGGLE_FULLSCREEN,
+    ACTIONID_VOL_UP,
+    ACTIONID_VOL_DOWN,
+    ACTIONID_NAV_ACTIVATE,
+    ACTIONID_NAV_UP,
+    ACTIONID_NAV_DOWN,
+    ACTIONID_NAV_LEFT,
+    ACTIONID_NAV_RIGHT,
+    ACTIONID_JUMP_BACKWARD_EXTRASHORT,
+    ACTIONID_JUMP_FORWARD_EXTRASHORT,
+    ACTIONID_JUMP_BACKWARD_SHORT,
+    ACTIONID_JUMP_FORWARD_SHORT,
+    ACTIONID_JUMP_BACKWARD_MEDIUM,
+    ACTIONID_JUMP_FORWARD_MEDIUM,
+    ACTIONID_JUMP_BACKWARD_LONG,
+    ACTIONID_JUMP_FORWARD_LONG,
+    ACTIONID_FRAME_NEXT,
+    ACTIONID_POSITION,
+    ACTIONID_VOL_MUTE,
 /* let ACTIONID_SET_BOOMARK* and ACTIONID_PLAY_BOOKMARK* be contiguous */
-#define ACTIONID_SET_BOOKMARK1         28
-#define ACTIONID_SET_BOOKMARK2         29
-#define ACTIONID_SET_BOOKMARK3         39
-#define ACTIONID_SET_BOOKMARK4         31
-#define ACTIONID_SET_BOOKMARK5         32
-#define ACTIONID_SET_BOOKMARK6         33
-#define ACTIONID_SET_BOOKMARK7         34
-#define ACTIONID_SET_BOOKMARK8         35
-#define ACTIONID_SET_BOOKMARK9         36
-#define ACTIONID_SET_BOOKMARK10        37
-#define ACTIONID_PLAY_BOOKMARK1        38
-#define ACTIONID_PLAY_BOOKMARK2        39
-#define ACTIONID_PLAY_BOOKMARK3        40
-#define ACTIONID_PLAY_BOOKMARK4        41
-#define ACTIONID_PLAY_BOOKMARK5        42
-#define ACTIONID_PLAY_BOOKMARK6        43
-#define ACTIONID_PLAY_BOOKMARK7        44
-#define ACTIONID_PLAY_BOOKMARK8        45
-#define ACTIONID_PLAY_BOOKMARK9        46
-#define ACTIONID_PLAY_BOOKMARK10       47
-/* end of contiguous zone */
-#define ACTIONID_SUBDELAY_UP           48
-#define ACTIONID_SUBDELAY_DOWN         49
-#define ACTIONID_HISTORY_BACK          50
-#define ACTIONID_HISTORY_FORWARD       51
-#define ACTIONID_AUDIO_TRACK           52
-#define ACTIONID_SUBTITLE_TRACK        53
-#define ACTIONID_CUBESPEED_UP          54
-#define ACTIONID_CUBESPEED_DOWN        55
-#define ACTIONID_INTF_SHOW             56
-#define ACTIONID_INTF_HIDE             57
-/* chapter and title navigation */
-#define ACTIONID_TITLE_PREV            58
-#define ACTIONID_TITLE_NEXT            59
-#define ACTIONID_CHAPTER_PREV          60
-#define ACTIONID_CHAPTER_NEXT          61
-/* end of chapter and title navigation */
-#define ACTIONID_AUDIODELAY_UP         62
-#define ACTIONID_AUDIODELAY_DOWN       63
-#define ACTIONID_SNAPSHOT              64
-#define ACTIONID_RECORD                65
-#define ACTIONID_DISC_MENU             66
-#define ACTIONID_ASPECT_RATIO          67
-#define ACTIONID_CROP                  68
-#define ACTIONID_DEINTERLACE           69
-#define ACTIONID_ZOOM                  70
-#define ACTIONID_UNZOOM                71
-#define ACTIONID_CROP_TOP              72
-#define ACTIONID_UNCROP_TOP            73
-#define ACTIONID_CROP_LEFT             74
-#define ACTIONID_UNCROP_LEFT           75
-#define ACTIONID_CROP_BOTTOM           76
-#define ACTIONID_UNCROP_BOTTOM         77
-#define ACTIONID_CROP_RIGHT            78
-#define ACTIONID_UNCROP_RIGHT          79
+    ACTIONID_SET_BOOKMARK1,
+    ACTIONID_SET_BOOKMARK2,
+    ACTIONID_SET_BOOKMARK3,
+    ACTIONID_SET_BOOKMARK4,
+    ACTIONID_SET_BOOKMARK5,
+    ACTIONID_SET_BOOKMARK6,
+    ACTIONID_SET_BOOKMARK7,
+    ACTIONID_SET_BOOKMARK8,
+    ACTIONID_SET_BOOKMARK9,
+    ACTIONID_SET_BOOKMARK10,
+    ACTIONID_PLAY_BOOKMARK1,
+    ACTIONID_PLAY_BOOKMARK2,
+    ACTIONID_PLAY_BOOKMARK3,
+    ACTIONID_PLAY_BOOKMARK4,
+    ACTIONID_PLAY_BOOKMARK5,
+    ACTIONID_PLAY_BOOKMARK6,
+    ACTIONID_PLAY_BOOKMARK7,
+    ACTIONID_PLAY_BOOKMARK8,
+    ACTIONID_PLAY_BOOKMARK9,
+    ACTIONID_PLAY_BOOKMARK10,
+    /* end of contiguous zone */
+    ACTIONID_SUBDELAY_UP,
+    ACTIONID_SUBDELAY_DOWN,
+    ACTIONID_HISTORY_BACK,
+    ACTIONID_HISTORY_FORWARD,
+    ACTIONID_AUDIO_TRACK,
+    ACTIONID_SUBTITLE_TRACK,
+    ACTIONID_CUBESPEED_UP,
+    ACTIONID_CUBESPEED_DOWN,
+    ACTIONID_INTF_SHOW,
+    ACTIONID_INTF_HIDE,
+    /* chapter and title navigation */
+    ACTIONID_TITLE_PREV,
+    ACTIONID_TITLE_NEXT,
+    ACTIONID_CHAPTER_PREV,
+    ACTIONID_CHAPTER_NEXT,
+    /* end of chapter and title navigation */
+    ACTIONID_AUDIODELAY_UP,
+    ACTIONID_AUDIODELAY_DOWN,
+    ACTIONID_SNAPSHOT,
+    ACTIONID_RECORD,
+    ACTIONID_DISC_MENU,
+    ACTIONID_ASPECT_RATIO,
+    ACTIONID_CROP,
+    ACTIONID_DEINTERLACE,
+    ACTIONID_ZOOM,
+    ACTIONID_UNZOOM,
+    ACTIONID_CROP_TOP,
+    ACTIONID_UNCROP_TOP,
+    ACTIONID_CROP_LEFT,
+    ACTIONID_UNCROP_LEFT,
+    ACTIONID_CROP_BOTTOM,
+    ACTIONID_UNCROP_BOTTOM,
+    ACTIONID_CROP_RIGHT,
+    ACTIONID_UNCROP_RIGHT,
+    ACTIONID_DUMP,
+    ACTIONID_RANDOM,
+    ACTIONID_LOOP,
+    ACTIONID_WALLPAPER,
+    ACTIONID_LEAVE_FULLSCREEN,
+    ACTIONID_MENU_ON,
+    ACTIONID_MENU_OFF,
+    ACTIONID_MENU_RIGHT,
+    ACTIONID_MENU_LEFT,
+    ACTIONID_MENU_UP,
+    ACTIONID_MENU_DOWN,
+    ACTIONID_MENU_SELECT,
+    /* Zoom */
+    ACTIONID_ZOOM_QUARTER,
+    ACTIONID_ZOOM_HALF,
+    ACTIONID_ZOOM_ORIGINAL,
+    ACTIONID_ZOOM_DOUBLE,
+    /* Cycle Through Audio Devices */
+    ACTIONID_AUDIODEVICE_CYCLE,
+    /* scaling */
+    ACTIONID_TOGGLE_AUTOSCALE,
+    ACTIONID_SCALE_UP,
+    ACTIONID_SCALE_DOWN,
+    /* */
+    ACTIONID_RATE_NORMAL,
+    ACTIONID_RATE_SLOWER_FINE,
+    ACTIONID_RATE_FASTER_FINE,
+
+} vlc_key_t;
+#endif