summaryrefslogtreecommitdiffstats
path: root/player/command.h
diff options
context:
space:
mode:
Diffstat (limited to 'player/command.h')
-rw-r--r--player/command.h123
1 files changed, 123 insertions, 0 deletions
diff --git a/player/command.h b/player/command.h
new file mode 100644
index 0000000..185b78f
--- /dev/null
+++ b/player/command.h
@@ -0,0 +1,123 @@
+/*
+ * 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_COMMAND_H
+#define MPLAYER_COMMAND_H
+
+#include <stdbool.h>
+
+#include "libmpv/client.h"
+#include "osdep/compiler.h"
+
+struct MPContext;
+struct mp_cmd;
+struct mp_log;
+struct mpv_node;
+struct m_config_option;
+
+void command_init(struct MPContext *mpctx);
+void command_uninit(struct MPContext *mpctx);
+
+// Runtime context for a single command.
+struct mp_cmd_ctx {
+ struct MPContext *mpctx;
+ struct mp_cmd *cmd; // original command
+ // Fields from cmd (for convenience)
+ struct mp_cmd_arg *args;
+ int num_args;
+ const void *priv; // cmd->def->priv
+ // OSD control
+ int on_osd; // MP_ON_OSD_FLAGS;
+ bool msg_osd; // OSD message requested
+ bool bar_osd; // OSD bar requested
+ bool seek_msg_osd; // same as above, but for seek commands
+ bool seek_bar_osd;
+ // If mp_cmd_def.can_abort is set, this will be set.
+ struct mp_abort_entry *abort;
+ // Return values (to be set by command implementation, read by the
+ // completion callback).
+ bool success; // true by default
+ struct mpv_node result;
+ // Command handlers can set this to false if returning from the command
+ // handler does not complete the command. It stops the common command code
+ // from signaling the completion automatically, and you can call
+ // mp_cmd_ctx_complete() to invoke on_completion() properly (including all
+ // the bookkeeping).
+ /// (Note that in no case you can call mp_cmd_ctx_complete() from within
+ // the command handler, because it frees the mp_cmd_ctx.)
+ bool completed; // true by default
+ // This is managed by the common command code. For rules about how and where
+ // this is called see run_command() comments.
+ void (*on_completion)(struct mp_cmd_ctx *cmd);
+ void *on_completion_priv; // for free use by on_completion callback
+};
+
+void run_command(struct MPContext *mpctx, struct mp_cmd *cmd,
+ struct mp_abort_entry *abort,
+ void (*on_completion)(struct mp_cmd_ctx *cmd),
+ void *on_completion_priv);
+void mp_cmd_ctx_complete(struct mp_cmd_ctx *cmd);
+PRINTF_ATTRIBUTE(3, 4)
+void mp_cmd_msg(struct mp_cmd_ctx *cmd, int status, const char *msg, ...);
+char *mp_property_expand_string(struct MPContext *mpctx, const char *str);
+char *mp_property_expand_escaped_string(struct MPContext *mpctx, const char *str);
+void property_print_help(struct MPContext *mpctx);
+int mp_property_do(const char* name, int action, void* val,
+ struct MPContext *mpctx);
+
+void mp_option_change_callback(void *ctx, struct m_config_option *co, int flags,
+ bool self_update);
+
+void mp_notify(struct MPContext *mpctx, int event, void *arg);
+void mp_notify_property(struct MPContext *mpctx, const char *property);
+
+void handle_command_updates(struct MPContext *mpctx);
+
+int mp_get_property_id(struct MPContext *mpctx, const char *name);
+uint64_t mp_get_property_event_mask(const char *name);
+
+enum {
+ // Must start with the first unused positive value in enum mpv_event_id
+ // MPV_EVENT_* and MP_EVENT_* must not overlap.
+ INTERNAL_EVENT_BASE = 26,
+ MP_EVENT_CHANGE_ALL,
+ MP_EVENT_CACHE_UPDATE,
+ MP_EVENT_WIN_RESIZE,
+ MP_EVENT_WIN_STATE,
+ MP_EVENT_WIN_STATE2,
+ MP_EVENT_FOCUS,
+ MP_EVENT_CHANGE_PLAYLIST,
+ MP_EVENT_CORE_IDLE,
+ MP_EVENT_DURATION_UPDATE,
+ MP_EVENT_INPUT_PROCESSED,
+ MP_EVENT_TRACKS_CHANGED,
+ MP_EVENT_TRACK_SWITCHED,
+ MP_EVENT_METADATA_UPDATE,
+ MP_EVENT_CHAPTER_CHANGE,
+};
+
+bool mp_hook_test_completion(struct MPContext *mpctx, char *type);
+void mp_hook_start(struct MPContext *mpctx, char *type);
+int mp_hook_continue(struct MPContext *mpctx, int64_t client_id, uint64_t id);
+void mp_hook_add(struct MPContext *mpctx, char *client, int64_t client_id,
+ const char *name, uint64_t user_id, int pri);
+
+void mark_seek(struct MPContext *mpctx);
+
+void mp_abort_cache_dumping(struct MPContext *mpctx);
+
+#endif /* MPLAYER_COMMAND_H */