diff options
Diffstat (limited to 'core/input/input.h')
-rw-r--r-- | core/input/input.h | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/core/input/input.h b/core/input/input.h new file mode 100644 index 0000000000..59f2d031ff --- /dev/null +++ b/core/input/input.h @@ -0,0 +1,219 @@ +/* + * This file is part of MPlayer. + * + * MPlayer is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * MPlayer 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with MPlayer; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef MPLAYER_INPUT_H +#define MPLAYER_INPUT_H + +#include <stdbool.h> +#include "bstr.h" +#include "m_option.h" + +// All command IDs +enum mp_command_type { + MP_CMD_IGNORE, + MP_CMD_SEEK, + MP_CMD_QUIT, + MP_CMD_PLAYLIST_NEXT, + MP_CMD_PLAYLIST_PREV, + MP_CMD_OSD, + MP_CMD_TV_STEP_CHANNEL, + MP_CMD_TV_STEP_NORM, + MP_CMD_TV_STEP_CHANNEL_LIST, + MP_CMD_SCREENSHOT, + MP_CMD_LOADFILE, + MP_CMD_LOADLIST, + MP_CMD_PLAYLIST_CLEAR, + MP_CMD_SUB_STEP, + MP_CMD_TV_SET_CHANNEL, + MP_CMD_EDL_MARK, + MP_CMD_TV_LAST_CHANNEL, + MP_CMD_TV_SET_FREQ, + MP_CMD_TV_SET_NORM, + MP_CMD_FRAME_STEP, + MP_CMD_SPEED_MULT, + MP_CMD_RUN, + MP_CMD_SUB_LOAD, + MP_CMD_KEYDOWN_EVENTS, + MP_CMD_SET, + MP_CMD_GET_PROPERTY, + MP_CMD_PRINT_TEXT, + MP_CMD_SHOW_TEXT, + MP_CMD_SHOW_PROGRESS, + MP_CMD_RADIO_STEP_CHANNEL, + MP_CMD_RADIO_SET_CHANNEL, + MP_CMD_RADIO_SET_FREQ, + MP_CMD_SET_MOUSE_POS, + MP_CMD_ADD, + MP_CMD_CYCLE, + MP_CMD_RADIO_STEP_FREQ, + MP_CMD_TV_STEP_FREQ, + MP_CMD_TV_START_SCAN, + MP_CMD_STOP, + + /// DVB commands + MP_CMD_DVB_SET_CHANNEL = 5101, + + /// Audio Filter commands + MP_CMD_AF_SWITCH, + MP_CMD_AF_ADD, + MP_CMD_AF_DEL, + MP_CMD_AF_CLR, + MP_CMD_AF_CMDLINE, + + MP_CMD_SHOW_CHAPTERS, + MP_CMD_SHOW_TRACKS, + + /// Video output commands + MP_CMD_VO_CMDLINE, +}; + +#define MP_CMD_MAX_ARGS 10 + +// Error codes for the drivers + +// An error occurred but we can continue +#define MP_INPUT_ERROR -1 +// A fatal error occurred, this driver should be removed +#define MP_INPUT_DEAD -2 +// No input was available +#define MP_INPUT_NOTHING -3 +//! Input will be available if you try again +#define MP_INPUT_RETRY -4 +// Key FIFO was full - release events may be lost, zero button-down status +#define MP_INPUT_RELEASE_ALL -5 + +enum mp_on_osd { + MP_ON_OSD_NO = 0, // prefer not using OSD + MP_ON_OSD_AUTO = 1, // use default behavior of the specific command + MP_ON_OSD_BAR = 2, // force a bar, if applicable + MP_ON_OSD_MSG = 4, // force a message, if applicable +}; + +enum mp_input_section_flags { + // If a key binding is not defined in the current section, search the + // default section for it ("default" refers to bindings with no section + // specified, not to the default input.conf aka builtin key bindings) + MP_INPUT_NO_DEFAULT_SECTION = 1, +}; + +struct input_ctx; + +struct mp_cmd_arg { + struct m_option type; + bool optional; + union { + int i; + float f; + char *s; + } v; +}; + +typedef struct mp_cmd { + int id; + char *name; + struct mp_cmd_arg args[MP_CMD_MAX_ARGS]; + int nargs; + int pausing; + enum mp_on_osd on_osd; + bstr original; + struct mp_cmd *queue_next; +} mp_cmd_t; + + +// Executing this command will abort playback (play something else, or quit). +bool mp_input_is_abort_cmd(int cmd_id); + +/* Add a new command input source. + * "fd" is a file descriptor (use a negative value if you don't use any fd) + * "select" tells whether to use select() on the fd to determine when to + * try reading. + * "read_func" is optional. If NULL a default function which reads data + * directly from the fd will be used. It must return either text data + * or one of the MP_INPUT error codes above. + * "close_func" will be called when closing. Can be NULL. Its return value + * is ignored (it's only there to allow using standard close() as the func). + */ +int mp_input_add_cmd_fd(struct input_ctx *ictx, int fd, int select, + int read_func(int fd, char *dest, int size), + int close_func(int fd)); + +// This removes a cmd driver, you usually don't need to use it. +void mp_input_rm_cmd_fd(struct input_ctx *ictx, int fd); + +/* The args are similar to the cmd version above, except you must give + * a read_func, and it should return key codes (ASCII plus keycodes.h). + */ +int mp_input_add_key_fd(struct input_ctx *ictx, int fd, int select, + int read_func(void *ctx, int fd), + int close_func(int fd), void *ctx); + +// Feed a keypress (alternative to being returned from read_func above) +void mp_input_feed_key(struct input_ctx *ictx, int code); + +// As for the cmd one you usually don't need this function. +void mp_input_rm_key_fd(struct input_ctx *ictx, int fd); + +// Get input key from its name. +int mp_input_get_key_from_name(const char *name); + +// Add a command to the command queue. +int mp_input_queue_cmd(struct input_ctx *ictx, struct mp_cmd *cmd); + +/* Return next available command, or sleep up to "time" ms if none is + * available. If "peek_only" is true return a reference to the command + * but leave it queued. + */ +struct mp_cmd *mp_input_get_cmd(struct input_ctx *ictx, int time, + int peek_only); + +// Parse text and return corresponding struct mp_cmd. +// The location parameter is for error messages. +struct mp_cmd *mp_input_parse_cmd(bstr str, const char *location); + +// After getting a command from mp_input_get_cmd you need to free it using this +// function +void mp_cmd_free(struct mp_cmd *cmd); + +// This creates a copy of a command (used by the auto repeat stuff). +struct mp_cmd *mp_cmd_clone(struct mp_cmd *cmd); + +// Set current input section +// flags is a bitfield of enum mp_input_section_flags values +void mp_input_set_section(struct input_ctx *ictx, char *name, int flags); + +// Get current input section +char *mp_input_get_section(struct input_ctx *ictx); + +// Initialize the input system +struct input_conf; +struct input_ctx *mp_input_init(struct input_conf *input_conf); + +void mp_input_uninit(struct input_ctx *ictx); + +struct m_config; +void mp_input_register_options(struct m_config *cfg); + +// Wake up sleeping input loop from another thread. +void mp_input_wakeup(struct input_ctx *ictx); + +// Interruptible usleep: (used by libmpdemux) +int mp_input_check_interrupt(struct input_ctx *ictx, int time); + +extern int async_quit_request; + +#endif /* MPLAYER_INPUT_H */ |