mirror of https://code.videolan.org/videolan/vlc
293 lines
9.3 KiB
C
293 lines
9.3 KiB
C
/*****************************************************************************
|
|
* vlc_actions.h: handle vlc actions
|
|
*****************************************************************************
|
|
* Copyright (C) 2003-2016 VLC authors and VideoLAN
|
|
*
|
|
* Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation; either version 2.1 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_ACTIONS_H
|
|
#define VLC_ACTIONS_H 1
|
|
|
|
# include <vlc_mouse.h>
|
|
|
|
/* Called from src/libvlc.c */
|
|
int
|
|
libvlc_InternalActionsInit(libvlc_int_t *p_libvlc);
|
|
|
|
/* Called from src/libvlc.c */
|
|
void
|
|
libvlc_InternalActionsClean(libvlc_int_t *p_libvlc);
|
|
|
|
/**
|
|
* \file
|
|
* This file defines keys and functions
|
|
*/
|
|
|
|
#define KEY_MODIFIER 0xFF000000
|
|
#define KEY_MODIFIER_ALT 0x01000000
|
|
#define KEY_MODIFIER_SHIFT 0x02000000
|
|
#define KEY_MODIFIER_CTRL 0x04000000
|
|
#define KEY_MODIFIER_META 0x08000000
|
|
#define KEY_MODIFIER_COMMAND 0x10000000
|
|
|
|
#define KEY_UNSET 0x00000000
|
|
#define KEY_BACKSPACE 0x08
|
|
#define KEY_TAB 0x09
|
|
#define KEY_ENTER 0x0D
|
|
#define KEY_ESC 0x1B
|
|
/* End of Unicode range: 0x0010FFFF */
|
|
#define KEY_LEFT 0x00200000
|
|
#define KEY_RIGHT 0x00210000
|
|
#define KEY_UP 0x00220000
|
|
#define KEY_DOWN 0x00230000
|
|
#define KEY_F(n) (0x00230000 + ((n) << 16))
|
|
#define KEY_F1 KEY_F(1)
|
|
#define KEY_F2 KEY_F(2)
|
|
#define KEY_F3 KEY_F(3)
|
|
#define KEY_F4 KEY_F(4)
|
|
#define KEY_F5 KEY_F(5)
|
|
#define KEY_F6 KEY_F(6)
|
|
#define KEY_F7 KEY_F(7)
|
|
#define KEY_F8 KEY_F(8)
|
|
#define KEY_F9 KEY_F(9)
|
|
#define KEY_F10 KEY_F(10)
|
|
#define KEY_F11 KEY_F(11)
|
|
#define KEY_F12 KEY_F(12)
|
|
/* KEY_F35 0x00460000 */
|
|
#define KEY_HOME 0x00470000
|
|
#define KEY_END 0x00480000
|
|
#define KEY_INSERT 0x00490000
|
|
#define KEY_DELETE 0x004A0000
|
|
#define KEY_MENU 0x004B0000
|
|
#define KEY_PAGEUP 0x004C0000
|
|
#define KEY_PAGEDOWN 0x004D0000
|
|
#define KEY_PRINT 0x004E0000
|
|
#define KEY_PAUSE 0x004F0000
|
|
#define KEY_BROWSER_BACK 0x00500000
|
|
#define KEY_BROWSER_FORWARD 0x00510000
|
|
#define KEY_BROWSER_REFRESH 0x00520000
|
|
#define KEY_BROWSER_STOP 0x00530000
|
|
#define KEY_BROWSER_SEARCH 0x00540000
|
|
#define KEY_BROWSER_FAVORITES 0x00550000
|
|
#define KEY_BROWSER_HOME 0x00560000
|
|
#define KEY_VOLUME_MUTE 0x00570000
|
|
#define KEY_VOLUME_DOWN 0x00580000
|
|
#define KEY_VOLUME_UP 0x00590000
|
|
#define KEY_MEDIA_NEXT_TRACK 0x005A0000
|
|
#define KEY_MEDIA_PREV_TRACK 0x005B0000
|
|
#define KEY_MEDIA_STOP 0x005C0000
|
|
#define KEY_MEDIA_PLAY_PAUSE 0x005D0000
|
|
#define KEY_MEDIA_RECORD 0x005E0000
|
|
#define KEY_MEDIA_REWIND 0x005F0000
|
|
#define KEY_MEDIA_FORWARD 0x00600000
|
|
#define KEY_MEDIA_REPEAT 0x00610000
|
|
#define KEY_MEDIA_SHUFFLE 0x00620000
|
|
#define KEY_MEDIA_SUBTITLE 0x00630000
|
|
#define KEY_MEDIA_AUDIO 0x00640000
|
|
#define KEY_MEDIA_ANGLE 0x00650000
|
|
#define KEY_MEDIA_TIME 0x00660000
|
|
#define KEY_MEDIA_FRAME_PREV 0x00670000
|
|
#define KEY_MEDIA_FRAME_NEXT 0x00680000
|
|
#define KEY_MEDIA_SELECT 0x00690000
|
|
#define KEY_MEDIA_VIEW 0x006A0000
|
|
#define KEY_MEDIA_MENU 0x006B0000
|
|
#define KEY_ZOOM_IN 0x006C0000
|
|
#define KEY_ZOOM_OUT 0x006D0000
|
|
#define KEY_BRIGHTNESS_UP 0x006E0000
|
|
#define KEY_BRIGHTNESS_DOWN 0x006F0000
|
|
|
|
#define KEY_MOUSEWHEELUP 0x00F00000
|
|
#define KEY_MOUSEWHEELDOWN 0x00F10000
|
|
#define KEY_MOUSEWHEELLEFT 0x00F20000
|
|
#define KEY_MOUSEWHEELRIGHT 0x00F30000
|
|
#define KEY_MOUSEWHEEL_FROM_BUTTON(button) \
|
|
(KEY_MOUSEWHEELUP | ((button - MOUSE_BUTTON_WHEEL_UP) << 16))
|
|
|
|
VLC_API char *vlc_keycode2str(uint_fast32_t i_key, bool locale) VLC_USED;
|
|
VLC_API uint_fast32_t vlc_str2keycode(const char *str) VLC_USED;
|
|
|
|
typedef enum vlc_action_id {
|
|
ACTIONID_NONE = 0,
|
|
ACTIONID_QUIT,
|
|
/* intf actions */
|
|
ACTIONID_INTF_TOGGLE_FSC,
|
|
ACTIONID_INTF_HIDE,
|
|
ACTIONID_INTF_BOSS,
|
|
ACTIONID_INTF_POPUP_MENU,
|
|
/* playlist interaction */
|
|
ACTIONID_PLAY_CLEAR,
|
|
ACTIONID_PREV,
|
|
ACTIONID_NEXT,
|
|
/* playback */
|
|
ACTIONID_LOOP,
|
|
ACTIONID_RANDOM,
|
|
/* playlist bookmarks */
|
|
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,
|
|
/* player state */
|
|
ACTIONID_PLAY_PAUSE,
|
|
ACTIONID_PLAY,
|
|
ACTIONID_PAUSE,
|
|
ACTIONID_STOP,
|
|
ACTIONID_FRAME_NEXT,
|
|
/* input seeking */
|
|
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_POSITION,
|
|
/* program SID, chapter and title navigation */
|
|
ACTIONID_PROGRAM_SID_PREV,
|
|
ACTIONID_PROGRAM_SID_NEXT,
|
|
ACTIONID_TITLE_PREV,
|
|
ACTIONID_TITLE_NEXT,
|
|
ACTIONID_CHAPTER_PREV,
|
|
ACTIONID_CHAPTER_NEXT,
|
|
ACTIONID_DISC_MENU,
|
|
/* audio / subtitle track */
|
|
ACTIONID_AUDIO_TRACK,
|
|
ACTIONID_SUBTITLE_REVERSE_TRACK,
|
|
ACTIONID_SUBTITLE_TRACK,
|
|
/* audio / subtitle delay */
|
|
ACTIONID_AUDIODELAY_DOWN,
|
|
ACTIONID_AUDIODELAY_UP,
|
|
ACTIONID_SUBDELAY_DOWN,
|
|
ACTIONID_SUBDELAY_UP,
|
|
/* subtitle toggle */
|
|
ACTIONID_SUBTITLE_TOGGLE,
|
|
/* dual subtitle control */
|
|
ACTIONID_SUBTITLE_CONTROL_SECONDARY,
|
|
/* subtitle sync */
|
|
ACTIONID_SUBSYNC_MARKAUDIO,
|
|
ACTIONID_SUBSYNC_MARKSUB,
|
|
ACTIONID_SUBSYNC_APPLY,
|
|
ACTIONID_SUBSYNC_RESET,
|
|
/* subtitle display */
|
|
ACTIONID_SUBPOS_DOWN,
|
|
ACTIONID_SUBPOS_UP,
|
|
ACTIONID_SUBTITLE_TEXT_SCALE_NORMAL,
|
|
ACTIONID_SUBTITLE_TEXT_SCALE_DOWN,
|
|
ACTIONID_SUBTITLE_TEXT_SCALE_UP,
|
|
/* input rate */
|
|
ACTIONID_RATE_NORMAL,
|
|
ACTIONID_RATE_SLOWER,
|
|
ACTIONID_RATE_FASTER,
|
|
ACTIONID_RATE_SLOWER_FINE,
|
|
ACTIONID_RATE_FASTER_FINE,
|
|
/* input navigation */
|
|
ACTIONID_NAV_ACTIVATE,
|
|
ACTIONID_NAV_UP,
|
|
ACTIONID_NAV_DOWN,
|
|
ACTIONID_NAV_LEFT,
|
|
ACTIONID_NAV_RIGHT,
|
|
/* input recording */
|
|
ACTIONID_RECORD,
|
|
/* viewpoint */
|
|
ACTIONID_VIEWPOINT_FOV_IN,
|
|
ACTIONID_VIEWPOINT_FOV_OUT,
|
|
ACTIONID_VIEWPOINT_ROLL_CLOCK,
|
|
ACTIONID_VIEWPOINT_ROLL_ANTICLOCK,
|
|
/* aout actions */
|
|
ACTIONID_VOL_DOWN,
|
|
ACTIONID_VOL_UP,
|
|
ACTIONID_VOL_MUTE,
|
|
ACTIONID_AUDIODEVICE_CYCLE,
|
|
/* all vouts actions */
|
|
ACTIONID_TOGGLE_FULLSCREEN,
|
|
ACTIONID_LEAVE_FULLSCREEN,
|
|
ACTIONID_SNAPSHOT,
|
|
ACTIONID_WALLPAPER,
|
|
/* vout aspect ratio */
|
|
ACTIONID_ASPECT_RATIO,
|
|
/* vout cropping */
|
|
ACTIONID_CROP,
|
|
ACTIONID_CROP_TOP,
|
|
ACTIONID_UNCROP_TOP,
|
|
ACTIONID_CROP_LEFT,
|
|
ACTIONID_UNCROP_LEFT,
|
|
ACTIONID_CROP_BOTTOM,
|
|
ACTIONID_UNCROP_BOTTOM,
|
|
ACTIONID_CROP_RIGHT,
|
|
ACTIONID_UNCROP_RIGHT,
|
|
/* vout deinterlacing */
|
|
ACTIONID_DEINTERLACE,
|
|
ACTIONID_DEINTERLACE_MODE,
|
|
/* vout scaling / zooming */
|
|
ACTIONID_TOGGLE_AUTOSCALE,
|
|
ACTIONID_SCALE_UP,
|
|
ACTIONID_SCALE_DOWN,
|
|
ACTIONID_ZOOM,
|
|
ACTIONID_UNZOOM,
|
|
ACTIONID_ZOOM_QUARTER,
|
|
ACTIONID_ZOOM_HALF,
|
|
ACTIONID_ZOOM_ORIGINAL,
|
|
ACTIONID_ZOOM_DOUBLE,
|
|
/* Combo Actions */
|
|
ACTIONID_COMBO_VOL_FOV_DOWN,
|
|
ACTIONID_COMBO_VOL_FOV_UP,
|
|
} vlc_action_id_t;
|
|
|
|
/**
|
|
* Get the action ID from an action key name
|
|
* \return the action ID or ACTIONID_NONE on error.
|
|
*/
|
|
VLC_API vlc_action_id_t
|
|
vlc_actions_get_id(const char *psz_key_name);
|
|
|
|
/**
|
|
* Get keycodes from a action key name and vlc configuration
|
|
* \return The number of keycodes for this action, or 0 in case of an error.
|
|
* The list needs to be released with free()
|
|
*/
|
|
VLC_API size_t
|
|
vlc_actions_get_keycodes(vlc_object_t *p_obj, const char *psz_key_name,
|
|
bool b_global, uint_fast32_t **pp_keycodes );
|
|
#define vlc_actions_get_keycodes(a, b, c, d) vlc_actions_get_keycodes(VLC_OBJECT(a), b, c, d)
|
|
|
|
/**
|
|
* Get a list a key names
|
|
* \return A NULL terminated list of const char *
|
|
*/
|
|
VLC_API const char* const*
|
|
vlc_actions_get_key_names(vlc_object_t *p_obj);
|
|
#define vlc_actions_get_key_names(x) vlc_actions_get_key_names(VLC_OBJECT(x))
|
|
|
|
#endif
|