include/vlc_actions.h

   1 /*****************************************************************************
   2  * vlc_actions.h: handle vlc actions
   3  *****************************************************************************
   4  * Copyright (C) 2003-2016 VLC authors and VideoLAN
   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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_ACTIONS_H
  25 #define VLC_ACTIONS_H 1
  26
  27 /* Called from src/libvlc.c */
  28 int
  29 libvlc_InternalActionsInit(libvlc_int_t *p_libvlc);
  30
  31 /* Called from src/libvlc.c */
  32 void
  33 libvlc_InternalActionsClean(libvlc_int_t *p_libvlc);
  34
  35 /**
  36  * \file
  37  * This file defines keys and functions
  38  */
  39
  40 #define KEY_MODIFIER         0xFF000000
  41 #define KEY_MODIFIER_ALT     0x01000000
  42 #define KEY_MODIFIER_SHIFT   0x02000000
  43 #define KEY_MODIFIER_CTRL    0x04000000
  44 #define KEY_MODIFIER_META    0x08000000
  45 #define KEY_MODIFIER_COMMAND 0x10000000
  46
  47 #define KEY_UNSET            0x00000000
  48 #define KEY_BACKSPACE              0x08
  49 #define KEY_TAB                    0x09
  50 #define KEY_ENTER                  0x0D
  51 #define KEY_ESC                    0x1B
  52 /* End of Unicode range:     0x0010FFFF */
  53 #define KEY_LEFT             0x00210000
  54 #define KEY_RIGHT            0x00220000
  55 #define KEY_UP               0x00230000
  56 #define KEY_DOWN             0x00240000
  57 #define KEY_F1               0x00270000
  58 #define KEY_F2               0x00280000
  59 #define KEY_F3               0x00290000
  60 #define KEY_F4               0x002A0000
  61 #define KEY_F5               0x002B0000
  62 #define KEY_F6               0x002C0000
  63 #define KEY_F7               0x002D0000
  64 #define KEY_F8               0x002E0000
  65 #define KEY_F9               0x002F0000
  66 #define KEY_F10              0x00300000
  67 #define KEY_F11              0x00310000
  68 #define KEY_F12              0x00320000
  69 #define KEY_HOME             0x00330000
  70 #define KEY_END              0x00340000
  71 #define KEY_INSERT           0x00350000
  72 #define KEY_DELETE           0x00360000
  73 #define KEY_MENU             0x00370000
  74 #define KEY_PAGEUP           0x00390000
  75 #define KEY_PAGEDOWN         0x003A0000
  76 #define KEY_PRINT            0x003B0000
  77 #define KEY_PAUSE            0x003D0000
  78
  79 #define KEY_BROWSER_BACK     0x003F0000
  80 #define KEY_BROWSER_FORWARD  0x00400000
  81 #define KEY_BROWSER_REFRESH  0x00410000
  82 #define KEY_BROWSER_STOP     0x00420000
  83 #define KEY_BROWSER_SEARCH   0x00430000
  84 #define KEY_BROWSER_FAVORITES 0x00440000
  85 #define KEY_BROWSER_HOME     0x00450000
  86 #define KEY_VOLUME_MUTE      0x00460000
  87 #define KEY_VOLUME_DOWN      0x00470000
  88 #define KEY_VOLUME_UP        0x00480000
  89 #define KEY_MEDIA_NEXT_TRACK 0x00490000
  90 #define KEY_MEDIA_PREV_TRACK 0x004A0000
  91 #define KEY_MEDIA_STOP       0x004B0000
  92 #define KEY_MEDIA_PLAY_PAUSE 0x004C0000
  93 #define KEY_MEDIA_RECORD     0x004D0000
  94 #define KEY_MEDIA_REWIND     0x004E0000
  95 #define KEY_MEDIA_FORWARD    0x004F0000
  96 #define KEY_MEDIA_REPEAT     0x00500000
  97 #define KEY_MEDIA_SHUFFLE    0x00510000
  98 #define KEY_MEDIA_SUBTITLE   0x00520000
  99 #define KEY_MEDIA_AUDIO      0x00530000
 100 #define KEY_MEDIA_ANGLE      0x00540000
 101 #define KEY_MEDIA_TIME       0x00550000
 102 #define KEY_MEDIA_FRAME_PREV 0x00560000
 103 #define KEY_MEDIA_FRAME_NEXT 0x00570000
 104 #define KEY_MEDIA_SELECT     0x00580000
 105 #define KEY_MEDIA_VIEW       0x00590000
 106 #define KEY_MEDIA_MENU       0x005A0000
 107 #define KEY_ZOOM_IN          0x00600000
 108 #define KEY_ZOOM_OUT         0x00610000
 109 #define KEY_BRIGHTNESS_UP    0x00620000
 110 #define KEY_BRIGHTNESS_DOWN  0x00630000
 111
 112 #define KEY_MOUSEWHEELUP     0x00F00000
 113 #define KEY_MOUSEWHEELDOWN   0x00F10000
 114 #define KEY_MOUSEWHEELLEFT   0x00F20000
 115 #define KEY_MOUSEWHEELRIGHT  0x00F30000
 116
 117 VLC_API char *vlc_keycode2str(uint_fast32_t i_key, bool locale) VLC_USED;
 118 VLC_API uint_fast32_t vlc_str2keycode(const char *str) VLC_USED;
 119
 120 typedef enum vlc_action_id {
 121     ACTIONID_NONE = 0,
 122     ACTIONID_QUIT,
 123     ACTIONID_PLAY_PAUSE,
 124     ACTIONID_PLAY,
 125     ACTIONID_PAUSE,
 126     ACTIONID_STOP,
 127     ACTIONID_PREV,
 128     ACTIONID_NEXT,
 129     ACTIONID_SLOWER,
 130     ACTIONID_FASTER,
 131     ACTIONID_TOGGLE_FULLSCREEN,
 132     ACTIONID_VOL_UP,
 133     ACTIONID_VOL_DOWN,
 134     ACTIONID_NAV_ACTIVATE,
 135     ACTIONID_NAV_UP,
 136     ACTIONID_NAV_DOWN,
 137     ACTIONID_NAV_LEFT,
 138     ACTIONID_NAV_RIGHT,
 139     ACTIONID_JUMP_BACKWARD_EXTRASHORT,
 140     ACTIONID_JUMP_FORWARD_EXTRASHORT,
 141     ACTIONID_JUMP_BACKWARD_SHORT,
 142     ACTIONID_JUMP_FORWARD_SHORT,
 143     ACTIONID_JUMP_BACKWARD_MEDIUM,
 144     ACTIONID_JUMP_FORWARD_MEDIUM,
 145     ACTIONID_JUMP_BACKWARD_LONG,
 146     ACTIONID_JUMP_FORWARD_LONG,
 147     ACTIONID_FRAME_NEXT,
 148     ACTIONID_POSITION,
 149     ACTIONID_VOL_MUTE,
 150 /* let ACTIONID_SET_BOOMARK* and ACTIONID_PLAY_BOOKMARK* be contiguous */
 151     ACTIONID_SET_BOOKMARK1,
 152     ACTIONID_SET_BOOKMARK2,
 153     ACTIONID_SET_BOOKMARK3,
 154     ACTIONID_SET_BOOKMARK4,
 155     ACTIONID_SET_BOOKMARK5,
 156     ACTIONID_SET_BOOKMARK6,
 157     ACTIONID_SET_BOOKMARK7,
 158     ACTIONID_SET_BOOKMARK8,
 159     ACTIONID_SET_BOOKMARK9,
 160     ACTIONID_SET_BOOKMARK10,
 161     ACTIONID_PLAY_BOOKMARK1,
 162     ACTIONID_PLAY_BOOKMARK2,
 163     ACTIONID_PLAY_BOOKMARK3,
 164     ACTIONID_PLAY_BOOKMARK4,
 165     ACTIONID_PLAY_BOOKMARK5,
 166     ACTIONID_PLAY_BOOKMARK6,
 167     ACTIONID_PLAY_BOOKMARK7,
 168     ACTIONID_PLAY_BOOKMARK8,
 169     ACTIONID_PLAY_BOOKMARK9,
 170     ACTIONID_PLAY_BOOKMARK10,
 171     /* end of contiguous zone */
 172     ACTIONID_PLAY_CLEAR,
 173     ACTIONID_SUBDELAY_UP,
 174     ACTIONID_SUBDELAY_DOWN,
 175     ACTIONID_SUBSYNC_MARKAUDIO,
 176     ACTIONID_SUBSYNC_MARKSUB,
 177     ACTIONID_SUBSYNC_APPLY,
 178     ACTIONID_SUBSYNC_RESET,
 179     ACTIONID_SUBPOS_UP,
 180     ACTIONID_SUBPOS_DOWN,
 181     ACTIONID_AUDIO_TRACK,
 182     ACTIONID_SUBTITLE_REVERSE_TRACK,
 183     ACTIONID_SUBTITLE_TRACK,
 184     ACTIONID_SUBTITLE_TOGGLE,
 185     ACTIONID_SUBTITLE_TEXT_SCALE_NORMAL,
 186     ACTIONID_SUBTITLE_TEXT_SCALE_UP,
 187     ACTIONID_SUBTITLE_TEXT_SCALE_DOWN,
 188     ACTIONID_INTF_TOGGLE_FSC,
 189     ACTIONID_INTF_HIDE,
 190     ACTIONID_INTF_BOSS,
 191     /* chapter and title navigation */
 192     ACTIONID_TITLE_PREV,
 193     ACTIONID_TITLE_NEXT,
 194     ACTIONID_CHAPTER_PREV,
 195     ACTIONID_CHAPTER_NEXT,
 196     /* end of chapter and title navigation */
 197     ACTIONID_AUDIODELAY_UP,
 198     ACTIONID_AUDIODELAY_DOWN,
 199     ACTIONID_SNAPSHOT,
 200     ACTIONID_RECORD,
 201     ACTIONID_DISC_MENU,
 202     ACTIONID_ASPECT_RATIO,
 203     ACTIONID_CROP,
 204     ACTIONID_DEINTERLACE,
 205     ACTIONID_DEINTERLACE_MODE,
 206     ACTIONID_ZOOM,
 207     ACTIONID_UNZOOM,
 208     ACTIONID_CROP_TOP,
 209     ACTIONID_UNCROP_TOP,
 210     ACTIONID_CROP_LEFT,
 211     ACTIONID_UNCROP_LEFT,
 212     ACTIONID_CROP_BOTTOM,
 213     ACTIONID_UNCROP_BOTTOM,
 214     ACTIONID_CROP_RIGHT,
 215     ACTIONID_UNCROP_RIGHT,
 216     ACTIONID_RANDOM,
 217     ACTIONID_LOOP,
 218     ACTIONID_WALLPAPER,
 219     ACTIONID_LEAVE_FULLSCREEN,
 220     /* Zoom */
 221     ACTIONID_ZOOM_QUARTER,
 222     ACTIONID_ZOOM_HALF,
 223     ACTIONID_ZOOM_ORIGINAL,
 224     ACTIONID_ZOOM_DOUBLE,
 225     /* Cycle Through Audio Devices */
 226     ACTIONID_AUDIODEVICE_CYCLE,
 227     /* scaling */
 228     ACTIONID_TOGGLE_AUTOSCALE,
 229     ACTIONID_SCALE_UP,
 230     ACTIONID_SCALE_DOWN,
 231     /* */
 232     ACTIONID_RATE_NORMAL,
 233     ACTIONID_RATE_SLOWER_FINE,
 234     ACTIONID_RATE_FASTER_FINE,
 235     /* Cycle Through Program Service IDs */
 236     ACTIONID_PROGRAM_SID_NEXT,
 237     ACTIONID_PROGRAM_SID_PREV,
 238     ACTIONID_INTF_POPUP_MENU,
 239     /* Viewpoint */
 240     ACTIONID_VIEWPOINT_FOV_IN,
 241     ACTIONID_VIEWPOINT_FOV_OUT,
 242     ACTIONID_VIEWPOINT_ROLL_CLOCK,
 243     ACTIONID_VIEWPOINT_ROLL_ANTICLOCK,
 244     /* Combo Actions */
 245     ACTIONID_COMBO_VOL_FOV_UP,
 246     ACTIONID_COMBO_VOL_FOV_DOWN,
 247
 248 } vlc_action_id_t;
 249
 250 /**
 251  * Get the action ID from an action key name
 252  * \return the action ID or ACTIONID_NONE on error.
 253  */
 254 VLC_API vlc_action_id_t
 255 vlc_actions_get_id(const char *psz_key_name);
 256
 257 /**
 258  * Get keycodes from a action key name and vlc configuration
 259  * \return The number of keycodes for this action, or 0 in case of an error.
 260  * The list needs to be released with free()
 261  */
 262 VLC_API size_t
 263 vlc_actions_get_keycodes(vlc_object_t *p_obj, const char *psz_key_name,
 264                         bool b_global, uint_fast32_t **pp_keycodes );
 265 #define vlc_actions_get_keycodes(a, b, c, d) vlc_actions_get_keycodes(VLC_OBJECT(a), b, c, d)
 266
 267 /**
 268  * Get a list a key names
 269  * \return A NULL terminated list of const char *
 270  */
 271 VLC_API const char* const*
 272 vlc_actions_get_key_names(vlc_object_t *p_obj);
 273 #define vlc_actions_get_key_names(x) vlc_actions_get_key_names(VLC_OBJECT(x))
 274
 275 #endif