255 lines · 10.9 KB · C
RawDownload
/* * This file is part of mpv. * * mpv 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. * * mpv 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 mpv.  If not, see <http://www.gnu.org/licenses/>. */ #ifndef MPLAYER_INPUT_H#define MPLAYER_INPUT_H #include <stdbool.h>#include "misc/bstr.h" #include "cmd.h" struct input_ctx;struct mp_log; struct mp_input_src {    struct mpv_global *global;    struct mp_log *log;    struct input_ctx *input_ctx;     struct mp_input_src_internal *in;     // If not-NULL: called before destroying the input_src. Should unblock the    // reader loop, and make it exit. (Use with mp_input_add_thread_src().)    void (*cancel)(struct mp_input_src *src);    // Called after the reader thread returns, and cancel() won't be called    // again. This should make sure that nothing after this call accesses src.    void (*uninit)(struct mp_input_src *src);     // For free use by the implementer.    void *priv;}; enum mp_input_section_flags {    // If a key binding is not defined in the current section, do not search the    // other sections for it (like the default section). Instead, an unbound    // key warning will be printed.    MP_INPUT_EXCLUSIVE = 1,    // Prefer it to other sections.    MP_INPUT_ON_TOP = 2,    // Let mp_input_test_dragging() return true, even if inside the mouse area.    MP_INPUT_ALLOW_VO_DRAGGING = 4,    // Don't force mouse pointer visible, even if inside the mouse area.    MP_INPUT_ALLOW_HIDE_CURSOR = 8,}; // Add an input source that runs on a thread. The source is automatically// removed if the thread loop exits.//  ctx: this is passed to loop_fn.//  loop_fn: this is called once inside of a new thread, and should not return//      until all input is read, or src->cancel is called by another thread.//      You must call mp_input_src_init_done(src) early during init to signal//      success (then src->cancel may be called at a later point); on failure,//      return from loop_fn immediately.// Returns >=0 on success, <0 on failure to allocate resources.// Do not set src->cancel after mp_input_src_init_done() has been called.int mp_input_add_thread_src(struct input_ctx *ictx, void *ctx,    void (*loop_fn)(struct mp_input_src *src, void *ctx)); // Signal successful init.// Must be called on the same thread as loop_fn (see mp_input_add_thread_src()).// Set src->cancel and src->uninit (if needed) before calling this.void mp_input_src_init_done(struct mp_input_src *src); // Feed text data, which will be split into lines of commands.void mp_input_src_feed_cmd_text(struct mp_input_src *src, char *buf, size_t len); // Process keyboard input. code is a key code from keycodes.h, possibly// with modifiers applied. MP_INPUT_RELEASE_ALL is also a valid value.void mp_input_put_key(struct input_ctx *ictx, int code); // Like mp_input_put_key(), but ignore mouse disable option for mouse buttons.// value can be used like with mp_input_put_wheel(), use 1 if not applicable.void mp_input_put_key_artificial(struct input_ctx *ictx, int code, double value); // Like mp_input_put_key(), but process all UTF-8 characters in the given// string as key events.void mp_input_put_key_utf8(struct input_ctx *ictx, int mods, struct bstr t); // Process scrolling input. Support for precise scrolling. Scales the given// scroll amount add multiplies it with the command (seeking, sub-delay, etc)void mp_input_put_wheel(struct input_ctx *ictx, int direction, double value); // Update mouse position (in window coordinates).void mp_input_set_mouse_pos(struct input_ctx *ictx, int x, int y); // Like mp_input_set_mouse_pos(), but ignore mouse disable option.void mp_input_set_mouse_pos_artificial(struct input_ctx *ictx, int x, int y); void mp_input_get_mouse_pos(struct input_ctx *ictx, int *x, int *y, int *hover); // Add/Update/Remove a touch point (in window coordinates).void mp_input_add_touch_point(struct input_ctx *ictx, int id, int x, int y);void mp_input_update_touch_point(struct input_ctx *ictx, int id, int x, int y);void mp_input_remove_touch_point(struct input_ctx *ictx, int id); // Get the positions of the touch points. xs and ys are arrays of at least// count elements. ids is an array of at least count elements to uniquely// identify touch points. Return the current number of touch points.int mp_input_get_touch_pos(struct input_ctx *ictx, int count, int *xs, int *ys, int *ids); // Return whether we want/accept mouse input.bool mp_input_mouse_enabled(struct input_ctx *ictx); bool mp_input_vo_keyboard_enabled(struct input_ctx *ictx); /* Make mp_input_set_mouse_pos() mangle the mouse coordinates. Hack for certain * VOs. dst=NULL, src=NULL reset it. src can be NULL. */struct mp_rect;void mp_input_set_mouse_transform(struct input_ctx *ictx, struct mp_rect *dst,                                  struct mp_rect *src); // Add a command to the command queue.int mp_input_queue_cmd(struct input_ctx *ictx, struct mp_cmd *cmd); // Return next queued command, or NULL.struct mp_cmd *mp_input_read_cmd(struct input_ctx *ictx); // Parse text and return corresponding struct mp_cmd.// The location parameter is for error messages.struct mp_cmd *mp_input_parse_cmd(struct input_ctx *ictx, bstr str,                                  const char *location); // Set current input section. The section is appended on top of the list of// active sections, so its bindings are considered first. If the section was// already active, it's moved to the top as well.// name==NULL will behave as if name=="default"// flags is a bitfield of enum mp_input_section_flags valuesvoid mp_input_enable_section(struct input_ctx *ictx, char *name, int flags); // Undo mp_input_enable_section().// name==NULL will behave as if name=="default"void mp_input_disable_section(struct input_ctx *ictx, char *name); // Like mp_input_set_section(ictx, ..., 0) for all sections.void mp_input_disable_all_sections(struct input_ctx *ictx); // Set the contents of an input section.//  name: name of the section, for mp_input_set_section() etc.//  location: location string (like filename) for error reporting//  contents: list of keybindings, like input.conf//            a value of NULL deletes the section//  builtin: create as builtin section; this means if the user defines bindings//           using "{name}", they won't be ignored or overwritten - instead,//           they are preferred to the bindings defined with this call//  owner: string ID of the client which defined this, or NULL// If the section already exists, its bindings are removed and replaced.void mp_input_define_section(struct input_ctx *ictx, char *name, char *location,                             char *contents, bool builtin, char *owner); // Remove all sections that have been defined by the given owner.void mp_input_remove_sections_by_owner(struct input_ctx *ictx, char *owner); // Define where on the screen the named input section should receive.// Setting a rectangle of size 0 unsets the mouse area.// A rectangle with negative size disables mouse input for this section.void mp_input_set_section_mouse_area(struct input_ctx *ictx, char *name,                                     int x0, int y0, int x1, int y1); // Used to detect mouse movement.unsigned int mp_input_get_mouse_event_counter(struct input_ctx *ictx); // Test whether there is any input section which wants to receive events.// Note that the mouse event is always delivered, even if this returns false.bool mp_input_test_mouse_active(struct input_ctx *ictx, int x, int y); // Whether input.c wants mouse drag events at this mouse position. If this// returns false, some VOs will initiate window dragging.bool mp_input_test_dragging(struct input_ctx *ictx, int x, int y); // Initialize the input systemstruct mpv_global;struct input_ctx *mp_input_init(struct mpv_global *global,                                void (*wakeup_cb)(void *ctx),                                void *wakeup_ctx); // Load the configured input.conf files.void mp_input_load_config(struct input_ctx *ictx); // Load a specific input.conf file.bool mp_input_load_config_file(struct input_ctx *ictx, char *file); void mp_input_update_opts(struct input_ctx *ictx); void mp_input_uninit(struct input_ctx *ictx); // Return number of seconds until the next autorepeat event will be generated.// Returns INFINITY if no autorepeated key is active.double mp_input_get_delay(struct input_ctx *ictx); // Wake up sleeping input loop from another thread.void mp_input_wakeup(struct input_ctx *ictx); // If this returns true, use Right Alt key as Alt Gr to produce special// characters. If false, count Right Alt as the modifier Alt key.bool mp_input_use_alt_gr(struct input_ctx *ictx); // Return true if mpv should intercept keyboard media keysbool mp_input_use_media_keys(struct input_ctx *ictx); // Like mp_input_parse_cmd_strv, but also run the command.void mp_input_run_cmd(struct input_ctx *ictx, const char **cmd); // Binds a command to a key. Returns true if the bind is successful.bool mp_input_bind_key(struct input_ctx *ictx, const char *key, bstr command,                       const char *desc); void mp_input_set_repeat_info(struct input_ctx *ictx, int rate, int delay); struct mpv_node mp_input_get_bindings(struct input_ctx *ictx); void mp_input_sdl_gamepad_add(struct input_ctx *ictx); struct mp_ipc_ctx;struct mp_client_api;struct mpv_handle; // Platform specific implementation, provided by ipc-*.c.struct mp_ipc_ctx *mp_init_ipc(struct mp_client_api *client_api,                               struct mpv_global *global);// Start a thread for the given handle and return a socket in out_fd[0] that// is served by this thread. If the FD is not full-duplex, then out_fd[0] is// the user's read-end, and out_fd[1] the write-end, otherwise out_fd[1] is set// to -1.//  returns://      true: out_fd[0] and out_fd[1] are set, ownership of h is transferred//      false: out_fd are not touched, caller retains ownership of hbool mp_ipc_start_anon_client(struct mp_ipc_ctx *ctx, struct mpv_handle *h,                              int out_fd[2]);void mp_uninit_ipc(struct mp_ipc_ctx *ctx); // Serialize the given mpv_event structure to JSON. Returns an allocated string.struct mpv_event;char *mp_json_encode_event(struct mpv_event *event); // Given the raw IPC input buffer "buf", remove the first newline-separated// command, execute it and return the result (if any) as an allocated string.struct mpv_handle;char *mp_ipc_consume_next_command(struct mpv_handle *client, void *ctx, bstr *buf); #endif /* MPLAYER_INPUT_H */

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t