summaryrefslogtreecommitdiffstats
path: root/player
diff options
context:
space:
mode:
authorAvi Halachmi (:avih) <avihpit@yahoo.com>2014-12-13 18:27:47 +0200
committerwm4 <wm4@nowhere>2017-06-14 12:29:32 +0200
commitd223a63bc5de423bca7337795fe165678cf6d236 (patch)
treeea803184506cec7c5bc1aac8250ace9d93604907 /player
parent82aa1ea87f1c83e9c32f8aa1bc8ce6acb14fa4e6 (diff)
downloadmpv-d223a63bc5de423bca7337795fe165678cf6d236.tar.bz2
mpv-d223a63bc5de423bca7337795fe165678cf6d236.tar.xz
js: add javascript scripting support using MuJS
Implements JS with almost identical API to the Lua support. Key differences from Lua: - The global mp, mp.msg and mp.utils are always available. - Instead of returning x, error, return x and expose mp.last_error(). - Timers are JS standard set/clear Timeout/Interval. - Supports CommonJS modules/require. - Added at mp.utils: getenv, read_file, write_file and few more. - Global print and dump (expand objects) functions. - mp.options currently not supported. See DOCS/man/javascript.rst for more details.
Diffstat (limited to 'player')
-rw-r--r--player/javascript.c1307
-rw-r--r--player/javascript/defaults.js495
-rw-r--r--player/scripting.c4
3 files changed, 1806 insertions, 0 deletions
diff --git a/player/javascript.c b/player/javascript.c
new file mode 100644
index 0000000000..8522328c41
--- /dev/null
+++ b/player/javascript.c
@@ -0,0 +1,1307 @@
+/*
+ * 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/>.
+ */
+
+#include <assert.h>
+#include <string.h>
+#include <strings.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <dirent.h>
+#include <math.h>
+#include <stdint.h>
+
+#include <mujs.h>
+
+#include "osdep/io.h"
+#include "mpv_talloc.h"
+#include "common/common.h"
+#include "options/m_property.h"
+#include "common/msg.h"
+#include "common/msg_control.h"
+#include "options/m_option.h"
+#include "input/input.h"
+#include "options/path.h"
+#include "misc/bstr.h"
+#include "osdep/subprocess.h"
+#include "osdep/timer.h"
+#include "osdep/threads.h"
+#include "stream/stream.h"
+#include "sub/osd.h"
+#include "core.h"
+#include "command.h"
+#include "client.h"
+#include "libmpv/client.h"
+
+#define MIN(a,b) ((a)<(b)?(a):(b))
+
+// List of builtin modules and their contents as strings.
+// All these are generated from player/javascript/*.js
+static const char *const builtin_files[][3] = {
+ {"@/defaults.js",
+# include "player/javascript/defaults.js.inc"
+ },
+ {0}
+};
+
+// Represents a loaded script. Each has its own js state.
+struct script_ctx {
+ const char *filename;
+ struct mpv_handle *client;
+ struct MPContext *mpctx;
+ struct mp_log *log;
+ char *last_error_str;
+};
+
+static struct script_ctx *jctx(js_State *J)
+{
+ return (struct script_ctx *)js_getcontext(J);
+}
+
+static mpv_handle *jclient(js_State *J)
+{
+ return jctx(J)->client;
+}
+
+/**********************************************************************
+ * conventions, MuJS notes and vm errors
+ *********************************************************************/
+// - push_foo functions are called from C and push a value to the vm stack.
+//
+// - JavaScript C functions are code which the vm can call as a js function.
+// By convention, script_bar and script__baz are js C functions. The former
+// is exposed to end users as bar, and _baz is for internal use.
+//
+// - js C functions get a fresh vm stack with their arguments, and may
+// manipulate their stack as they see fit. On exit, the vm considers the
+// top value of their stack as their return value, and GC the rest.
+//
+// - js C function's stack[0] is "this", and the rest (1, 2, ...) are the args.
+// On entry the stack has at least the number of args defined for the func,
+// padded with undefined if called with less, or bigger if called with more.
+//
+// - Almost all vm APIs (js_*) may throw an error - a longjmp to the last
+// recovery/catch point, which could skip releasing resources. Use protected
+// code (e.g. js_pcall) between aquisition and release. Alternatively, use
+// the autofree mechanism to manage it more easily. See more details below.
+//
+// - Unless named s_foo, all the functions at this file (inc. init) which
+// touch the vm may throw, but either cleanup resources regardless (mostly
+// autofree) or leave allocated resources on caller-provided talloc context
+// which the caller should release, typically with autofree (e.g. makenode).
+//
+// - Functions named s_foo (safe foo) never throw, return 0 on success, else 1.
+
+/**********************************************************************
+ * mpv scripting API error handling
+ *********************************************************************/
+// - Errors may be thrown on some cases - the reason is at the exception.
+//
+// - Some APIs also set last error which can be fetched with mp.last_error(),
+// where empty string (false-y) is success, or an error string otherwise.
+//
+// - The rest of the APIs are guaranteed to return undefined on error or a
+// true-thy value on success and may or may not set last error.
+//
+// - push_success, push_failure, push_status and pushed_error set last error.
+
+// iserr as true indicates an error, and if so, str may indicate a reason.
+// Internally ctx->last_error_str is never NULL, and empty indicates success.
+static void set_last_error(struct script_ctx *ctx, bool iserr, const char *str)
+{
+ ctx->last_error_str[0] = 0;
+ if (!iserr)
+ return;
+ if (!str || !str[0])
+ str = "Error";
+ ctx->last_error_str = talloc_strdup_append(ctx->last_error_str, str);
+}
+
+// For use only by wrappers at defaults.js.
+// arg: error string. Use empty string to indicate success.
+static void script__set_last_error(js_State *J)
+{
+ const char *e = js_tostring(J, 1);
+ set_last_error(jctx(J), e[0], e);
+}
+
+// mp.last_error() . args: none. return the last error without modifying it.
+static void script_last_error(js_State *J)
+{
+ js_pushstring(J, jctx(J)->last_error_str);
+}
+
+// Generic success for APIs which don't return an actual value.
+static void push_success(js_State *J)
+{
+ set_last_error(jctx(J), 0, NULL);
+ js_pushboolean(J, true);
+}
+
+// Doesn't (intentionally) throw. Just sets last_error and pushes undefined
+static void push_failure(js_State *J, const char *str)
+{
+ set_last_error(jctx(J), 1, str);
+ js_pushundefined(J);
+}
+
+// Most of the scripting APIs are either sending some values and getting status
+// code in return, or requesting some value while providing a default in case an
+// error happened. These simplify the C code for that and always set last_error.
+
+static void push_status(js_State *J, int err)
+{
+ if (err >= 0) {
+ push_success(J);
+ } else {
+ push_failure(J, mpv_error_string(err));
+ }
+}
+
+ // If err is success then return 0, else push the item at def and return 1
+static bool pushed_error(js_State *J, int err, int def)
+{
+ bool iserr = err < 0;
+ set_last_error(jctx(J), iserr, iserr ? mpv_error_string(err) : NULL);
+ if (!iserr)
+ return false;
+
+ js_copy(J, def);
+ return true;
+}
+
+/**********************************************************************
+ * Autofree - care-free resource deallocation on vm errors, and otherwise
+ *********************************************************************/
+// - Autofree (af) functions are called with a talloc context argument which is
+// freed after the function exits - either normally or because it threw an
+// error, on the latter case it then re-throws the error after the cleanup.
+//
+// Autofree js C functions should have an additional void* talloc arg and
+// inserted into the vm using af_newcfunction, but otherwise used normally.
+//
+// To wrap an autofree function af_TARGET in C:
+// 1. Create a wrapper s_TARGET which runs af_TARGET safely inside js_try.
+// 2. Use s_TARGET like so (always autofree, and throws if af_TARGET threw):
+// void *af = talloc_new(NULL);
+// int r = s_TARGET(J, ..., af); // use J, af where the callee expects.
+// talloc_free(af);
+// if (r)
+// js_throw(J);
+
+// add_af_file, add_af_dir, add_af_mpv_alloc take a valid FILE*/DIR*/char* value
+// respectively, and fclose/closedir/mpv_free it when the parent is freed.
+
+static void destruct_af_file(void *p)
+{
+ fclose(*(FILE**)p);
+}
+
+static void add_af_file(void *parent, FILE *f)
+{
+ FILE **pf = talloc(parent, FILE*);
+ *pf = f;
+ talloc_set_destructor(pf, destruct_af_file);
+}
+
+static void destruct_af_dir(void *p)
+{
+ closedir(*(DIR**)p);
+}
+
+static void add_af_dir(void *parent, DIR *d)
+{
+ DIR **pd = talloc(parent, DIR*);
+ *pd = d;
+ talloc_set_destructor(pd, destruct_af_dir);
+}
+
+static void destruct_af_mpv_alloc(void *p)
+{
+ mpv_free(*(char**)p);
+}
+
+static void add_af_mpv_alloc(void *parent, char *ma)
+{
+ char **p = talloc(parent, char*);
+ *p = ma;
+ talloc_set_destructor(p, destruct_af_mpv_alloc);
+}
+
+static void destruct_af_mpv_node(void *p)
+{
+ mpv_free_node_contents((mpv_node*)p); // does nothing for MPV_FORMAT_NONE
+}
+
+// returns a new zeroed allocated struct mpv_node, and free it and its content
+// when the parent is freed.
+static mpv_node *new_af_mpv_node(void *parent)
+{
+ mpv_node *p = talloc_zero(parent, mpv_node); // .format == MPV_FORMAT_NONE
+ talloc_set_destructor(p, destruct_af_mpv_node);
+ return p;
+}
+
+// Prototype for autofree functions which can be called from inside the vm.
+typedef void (*af_CFunction)(js_State*, void*);
+
+// safely run autofree js c function directly
+static int s_run_af_jsc(js_State *J, af_CFunction fn, void *af)
+{
+ if (js_try(J))
+ return 1;
+ fn(J, af);
+ js_endtry(J);
+ return 0;
+}
+
+// The trampoline function through which all autofree functions are called from
+// inside the vm. Obtains the target function address and autofree-call it.
+static void script__autofree(js_State *J)
+{
+ // The target function is at the "af_" property of this function instance.
+ js_currentfunction(J);
+ js_getproperty(J, -1, "af_");
+ af_CFunction fn = (af_CFunction)js_touserdata(J, -1, "af_fn");
+ js_pop(J, 2);
+
+ void *af = talloc_new(NULL);
+ int r = s_run_af_jsc(J, fn, af);
+ talloc_free(af);
+ if (r)
+ js_throw(J);
+}
+
+// Identical to js_newcfunction, but the function is inserted with an autofree
+// wrapper, and its prototype should have the additional af argument.
+static void af_newcfunction(js_State *J, af_CFunction fn, const char *name,
+ int length)
+{
+ js_newcfunction(J, script__autofree, name, length);
+ js_pushnull(J); // a prototype for the userdata object
+ js_newuserdata(J, "af_fn", fn, NULL); // uses a "af_fn" verification tag
+ js_defproperty(J, -2, "af_", JS_READONLY | JS_DONTENUM | JS_DONTCONF);
+}
+
+/**********************************************************************
+ * Initialization and file loading
+ *********************************************************************/
+
+static const char *get_builtin_file(const char *name)
+{
+ for (int n = 0; builtin_files[n][0]; n++) {
+ if (strcmp(builtin_files[n][0], name) == 0)
+ return builtin_files[n][1];
+ }
+ return NULL;
+}
+
+// Push up to limit bytes of file fname: from builtin_files, else from the OS.
+static void af_push_file(js_State *J, const char *fname, int limit, void *af)
+{
+ char *filename = mp_get_user_path(af, jctx(J)->mpctx->global, fname);
+ MP_VERBOSE(jctx(J), "Reading file '%s'\n", filename);
+ if (limit < 0)
+ limit = INT_MAX - 1;
+
+ const char *builtin = get_builtin_file(filename);
+ if (builtin) {
+ js_pushlstring(J, builtin, MIN(limit, strlen(builtin)));
+ return;
+ }
+
+ FILE *f = fopen(filename, "rb");
+ if (!f)
+ js_error(J, "cannot open file: '%s'", filename);
+ add_af_file(af, f);
+
+ int len = MIN(limit, 32 * 1024); // initial allocation, size*2 strategy
+ int got = 0;
+ char *s = NULL;
+ while ((s = talloc_realloc(af, s, char, len))) {
+ int want = len - got;
+ int r = fread(s + got, 1, want, f);
+
+ if (feof(f) || (len == limit && r == want)) {
+ js_pushlstring(J, s, got + r);
+ return;
+ }
+ if (r != want)
+ js_error(J, "cannot read data from file: '%s'", filename);
+
+ got = got + r;
+ len = MIN(limit, len * 2);
+ }
+
+ js_error(J, "cannot allocate %d bytes for file: '%s'", len, filename);
+}
+
+// Safely run af_push_file.
+static int s_push_file(js_State *J, const char *fname, int limit, void *af)
+{
+ if (js_try(J))
+ return 1;
+ af_push_file(J, fname, limit, af);
+ js_endtry(J);
+ return 0;
+}
+
+// Called directly, push up to limit bytes of file fname (from builtin/os).
+static void push_file_content(js_State *J, const char *fname, int limit)
+{
+ void *af = talloc_new(NULL);
+ int r = s_push_file(J, fname, limit, af);
+ talloc_free(af);
+ if (r)
+ js_throw(J);
+}
+
+// utils.read_file(..). args: fname [,max]. returns [up to max] bytes as string.
+static void script_read_file(js_State *J)
+{
+ int limit = js_isundefined(J, 2) ? -1 : js_tonumber(J, 2);
+ push_file_content(J, js_tostring(J, 1), limit);
+}
+
+// Runs a file with the caller's this, leaves the stack as is.
+static void run_file(js_State *J, const char *fname)
+{
+ MP_VERBOSE(jctx(J), "Loading file %s\n", fname);
+ push_file_content(J, fname, -1);
+ js_loadstring(J, fname, js_tostring(J, -1));
+ js_copy(J, 0); // use the caller's this
+ js_call(J, 0);
+ js_pop(J, 2); // result, file content
+}
+
+// The spec defines .name and .message for Error objects. Most engines also set
+// a very convenient .stack = name + message + trace, but MuJS instead sets
+// .stackTrace = trace only. Normalize by adding such .stack if required.
+// Run this before anything such that we can get traces on any following errors.
+static const char *norm_err_proto_js = "\
+ if (Error().stackTrace && !Error().stack) {\
+ Object.defineProperty(Error.prototype, 'stack', {\
+ get: function() {\
+ return this.name + ': ' + this.message + this.stackTrace;\
+ }\
+ });\
+ }\
+";
+
+static void add_functions(js_State*, struct script_ctx*);
+
+// args: none. called as script, setup and run the main script
+static void script__run_script(js_State *J)
+{
+ js_loadstring(J, "@/norm_err.js", norm_err_proto_js);
+ js_copy(J, 0);
+ js_pcall(J, 0);
+
+ struct script_ctx *ctx = jctx(J);
+ add_functions(J, ctx);
+ run_file(J, "@/defaults.js");
+ run_file(J, ctx->filename); // the main file to run
+
+ if (!js_hasproperty(J, 0, "mp_event_loop") || !js_iscallable(J, -1))
+ js_error(J, "no event loop function");
+ js_copy(J, 0);
+ js_call(J, 0); // mp_event_loop
+}
+
+// Safely set last error from stack top: stack trace or toString or generic.
+// May leave items on stack - the caller should detect and pop if it cares.
+static void s_top_to_last_error(struct script_ctx *ctx, js_State *J)
+{
+ set_last_error(ctx, 1, "unknown error");
+ if (js_try(J))
+ return;
+ if (js_isobject(J, -1))
+ js_hasproperty(J, -1, "stack"); // fetches it if exists
+ set_last_error(ctx, 1, js_tostring(J, -1));
+ js_endtry(J);
+}
+
+// MuJS can report warnings through this.
+static void report_handler(js_State *J, const char *msg)
+{
+ MP_WARN(jctx(J), "[JS] %s\n", msg);
+}
+
+// Safely setup the js vm for calling run_script.
+static int s_init_js(js_State *J, struct script_ctx *ctx)
+{
+ if (js_try(J))
+ return 1;
+ js_setcontext(J, ctx);
+ js_setreport(J, report_handler);
+ js_newcfunction(J, script__run_script, "run_script", 0);
+ js_pushglobal(J); // 'this' for script__run_script
+ js_endtry(J);
+ return 0;
+}
+
+/**********************************************************************
+ * Initialization - booting the script
+ *********************************************************************/
+// s_load_javascript: (entry point) creates the js vm, runs the script, returns
+// on script exit or uncaught js errors. Never throws.
+// script__run_script: - loads the built in functions and vars into the vm
+// - runs the default file[s] and the main script file
+// - calls mp_event_loop, returns on script-exit or throws.
+//
+// Note: init functions don't need autofree. They can use ctx as a talloc
+// context and free normally. If they throw - ctx is freed right afterwards.
+static int s_load_javascript(struct mpv_handle *client, const char *fname)
+{
+ struct script_ctx *ctx = talloc_ptrtype(NULL, ctx);
+ *ctx = (struct script_ctx) {
+ .client = client,
+ .mpctx = mp_client_get_core(client),
+ .log = mp_client_get_log(client),
+ .last_error_str = talloc_strdup(ctx, "Cannot initialize JavaScript"),
+ .filename = fname,
+ };
+
+ int r = -1;
+ js_State *J = js_newstate(NULL, NULL, 0);
+ if (!J || s_init_js(J, ctx))
+ goto error_out;
+
+ set_last_error(ctx, 0, NULL);
+ if (js_pcall(J, 0)) { // script__run_script
+ s_top_to_last_error(ctx, J);
+ goto error_out;
+ }
+
+ r = 0;
+
+error_out:
+ if (r)
+ MP_FATAL(ctx, "%s\n", ctx->last_error_str);
+ if (J)
+ js_freestate(J);
+
+ talloc_free(ctx);
+ return r;
+}
+
+/**********************************************************************
+ * Main mp.* scripting APIs and helpers
+ *********************************************************************/
+static void pushnode(js_State *J, mpv_node *node);
+static void makenode(void *ta_ctx, mpv_node *dst, js_State *J, int idx);
+
+// Return the index in opts of stack[idx] (or of def if undefined), else throws.
+static int checkopt(js_State *J, int idx, const char *def, const char *opts[],
+ const char *desc)
+{
+ const char *opt = js_isundefined(J, idx) ? def : js_tostring(J, idx);
+ for (int i = 0; opts[i]; i++) {
+ if (strcmp(opt, opts[i]) == 0)
+ return i;
+ }
+ js_error(J, "Invalid %s '%s'", desc, opt);
+}
+
+// args: level as string and a variable numbers of args to print. adds final \n
+static void script_log(js_State *J)
+{
+ const char *level = js_tostring(J, 1);
+ int msgl = mp_msg_find_level(level);
+ if (msgl < 0)
+ js_error(J, "Invalid log level '%s'", level);
+
+ struct mp_log *log = jctx(J)->log;
+ for (int top = js_gettop(J), i = 2; i < top; i++)
+ mp_msg(log, msgl, (i == 2 ? "%s" : " %s"), js_tostring(J, i));
+ mp_msg(log, msgl, "\n");
+ push_success(J);
+}
+
+static void script_find_config_file(js_State *J, void *af)
+{
+ const char *fname = js_tostring(J, 1);
+ char *path = mp_find_config_file(af, jctx(J)->mpctx->global, fname);
+ if (path) {
+ js_pushstring(J, path);
+ } else {
+ push_failure(J, "not found");
+ }
+}
+
+static void script__request_event(js_State *J)
+{
+ const char *event = js_tostring(J, 1);
+ bool enable = js_toboolean(J, 2);
+
+ const char *name;
+ for (int n = 0; n < 256 && (name = mpv_event_name(n)); n++) {
+ if (strcmp(name, event) == 0) {
+ push_status(J, mpv_request_event(jclient(J), n, enable));
+ return;
+ }
+ }
+ push_failure(J, "Unknown event name");
+}
+
+static void script_enable_messages(js_State *J)
+{
+ const char *level = js_tostring(J, 1);
+ if (mp_msg_find_level(level) < 0)
+ js_error(J, "Invalid log level '%s'", level);
+ push_status(J, mpv_request_log_messages(jclient(J), level));
+}
+
+// args - command [with arguments] as string
+static void script_command(js_State *J)
+{
+ push_status(J, mpv_command_string(jclient(J), js_tostring(J, 1)));
+}
+
+// args: strings of command and then variable number of arguments
+static void script_commandv(js_State *J)
+{
+ const char *argv[MP_CMD_MAX_ARGS + 1];
+ int length = js_gettop(J) - 1;
+ if (length >= MP_ARRAY_SIZE(argv))
+ js_error(J, "Too many arguments");
+
+ for (int i = 0; i < length; i++)
+ argv[i] = js_tostring(J, 1 + i);
+ argv[length] = NULL;
+ push_status(J, mpv_command(jclient(J), argv));
+}
+
+// args: name, string value
+static void script_set_property(js_State *J)
+{
+ int e = mpv_set_property_string(jclient(J), js_tostring(J, 1),
+ js_tostring(J, 2));
+ push_status(J, e);
+}
+
+// args: name, boolean
+static void script_set_property_bool(js_State *J)
+{
+ int v = js_toboolean(J, 2);
+ int e = mpv_set_property(jclient(J), js_tostring(J, 1), MPV_FORMAT_FLAG, &v);
+ push_status(J, e);
+}
+
+// args: name [,def]
+static void script_get_property_number(js_State *J)
+{
+ double result;
+ const char *name = js_tostring(J, 1);
+ int e = mpv_get_property(jclient(J), name, MPV_FORMAT_DOUBLE, &result);
+ if (!pushed_error(J, e, 2))
+ js_pushnumber(J, result);
+}
+
+// args: name, native value
+static void script_set_property_native(js_State *J, void *af)
+{
+ mpv_node node;
+ makenode(af, &node, J, 2);
+ mpv_handle *h = jclient(J);
+ int e = mpv_get_property(h, js_tostring(J, 1), MPV_FORMAT_NODE, &node);
+ push_status(J, e);
+}
+
+// args: name [,def]
+static void script_get_property(js_State *J, void *af)
+{
+ mpv_handle *h = jclient(J);
+ char *res = NULL;
+ int e = mpv_get_property(h, js_tostring(J, 1), MPV_FORMAT_STRING, &res);
+ if (e >= 0)
+ add_af_mpv_alloc(af, res);
+ if (!pushed_error(J, e, 2))
+ js_pushstring(J, res);
+}
+
+// args: name [,def]
+static void script_get_property_bool(js_State *J)
+{
+ int result;
+ mpv_handle *h = jclient(J);
+ int e = mpv_get_property(h, js_tostring(J, 1), MPV_FORMAT_FLAG, &result);
+ if (!pushed_error(J, e, 2))
+ js_pushboolean(J, result);
+}
+
+// args: name, number
+static void script_set_property_number(js_State *J)
+{
+ double v = js_tonumber(J, 2);
+ mpv_handle *h = jclient(J);
+ int e = mpv_get_property(h, js_tostring(J, 1), MPV_FORMAT_DOUBLE, &v);
+ push_status(J, e);
+}
+
+// args: name [,def]
+static void script_get_property_native(js_State *J, void *af)
+{
+ const char *name = js_tostring(J, 1);
+ mpv_handle *h = jclient(J);
+ mpv_node *presult_node = new_af_mpv_node(af);
+ int e = mpv_get_property(h, name, MPV_FORMAT_NODE, presult_node);
+ if (!pushed_error(J, e, 2))
+ pushnode(J, presult_node);
+}
+
+// args: name [,def]
+static void script_get_property_osd(js_State *J, void *af)
+{
+ const char *name = js_tostring(J, 1);
+ mpv_handle *h = jclient(J);
+ char *res = NULL;
+ int e = mpv_get_property(h, name, MPV_FORMAT_OSD_STRING, &res);
+ if (e >= 0)
+ add_af_mpv_alloc(af, res);
+ if (!pushed_error(J, e, 2))
+ js_pushstring(J, res);
+}
+
+// args: id, name, type
+static void script__observe_property(js_State *J)
+{
+ const char *fmts[] = {"none", "native", "bool", "string", "number", NULL};
+ const mpv_format mf[] = {MPV_FORMAT_NONE, MPV_FORMAT_NODE, MPV_FORMAT_FLAG,
+ MPV_FORMAT_STRING, MPV_FORMAT_DOUBLE};
+
+ mpv_format f = mf[checkopt(J, 3, "none", fmts, "observe type")];
+ int e = mpv_observe_property(jclient(J), js_tonumber(J, 1),
+ js_tostring(J, 2),
+ f);
+ push_status(J, e);
+}
+
+// args: id
+static void script__unobserve_property(js_State *J)
+{
+ int e = mpv_unobserve_property(jclient(J), js_tonumber(J, 1));
+ push_status(J, e);
+}
+
+// args: native (array of command and args, similar to commandv) [,def]
+static void script_command_native(js_State *J, void *af)
+{
+ mpv_node cmd;
+ makenode(af, &cmd, J, 1);
+ mpv_node *presult_node = new_af_mpv_node(af);
+ int e = mpv_command_node(jclient(J), &cmd, presult_node);
+ if (!pushed_error(J, e, 2))
+ pushnode(J, presult_node);
+}
+
+// args: none, result in millisec
+static void script_get_time_ms(js_State *J)
+{
+ js_pushnumber(J, mpv_get_time_us(jclient(J)) / (double)(1000));
+}
+
+static void script_set_osd_ass(js_State *J)
+{
+ struct script_ctx *ctx = jctx(J);
+ int res_x = js_tonumber(J, 1);
+ int res_y = js_tonumber(J, 2);
+ const char *text = js_tostring(J, 3);
+ osd_set_external(ctx->mpctx->osd, ctx->client, res_x, res_y, (char *)text);
+ mp_wakeup_core(ctx->mpctx);
+ push_success(J);
+}
+
+// push object with properties names (NULL terminated) with respective vals
+static void push_nums_obj(js_State *J, const char * const names[],
+ const double vals[])
+{
+ js_newobject(J);
+ for (int i = 0; names[i]; i++) {
+ js_pushnumber(J, vals[i]);
+ js_setproperty(J, -2, names[i]);
+ }
+}
+
+// args: none, return: object with properties width, height, aspect
+static void script_get_osd_size(js_State *J)
+{
+ struct mp_osd_res r = osd_get_vo_res(jctx(J)->mpctx->osd);
+ double ar = 1.0 * r.w / MPMAX(r.h, 1) / (r.display_par ? r.display_par : 1);
+ const char * const names[] = {"width", "height", "aspect", NULL};
+ const double vals[] = {r.w, r.h, ar};
+ push_nums_obj(J, names, vals);
+}
+
+// args: none, return: object with properties top, bottom, left, right
+static void script_get_osd_margins(js_State *J)
+{
+ struct mp_osd_res r = osd_get_vo_res(jctx(J)->mpctx->osd);
+ const char * const names[] = {"left", "top", "right", "bottom", NULL};
+ const double vals[] = {r.ml, r.mt, r.mr, r.mb};
+ push_nums_obj(J, names, vals);
+}
+
+// args: none, return: object with properties x, y
+static void script_get_mouse_pos(js_State *J)
+{
+ int x, y;
+ mp_input_get_mouse_pos(jctx(J)->mpctx->input, &x, &y);
+ const char * const names[] = {"x", "y", NULL};
+ const double vals[] = {x, y};
+ push_nums_obj(J, names, vals);
+}
+
+// args: input-section-name, x0, y0, x1, y1
+static void script_input_set_section_mouse_area(js_State *J)
+{
+ char *section = (char *)js_tostring(J, 1);
+ mp_input_set_section_mouse_area(jctx(J)->mpctx->input, section,
+ js_tonumber(J, 2), js_tonumber(J, 3), // x0, y0
+ js_tonumber(J, 4), js_tonumber(J, 5)); // x1, y1
+ push_success(J);
+}
+
+// args: time-in-ms [,format-string]
+static void script_format_time(js_State *J, void *af)
+{
+ double t = js_tonumber(J, 1);
+ const char *fmt = js_isundefined(J, 2) ? "%H:%M:%S" : js_tostring(J, 2);
+ char *r = talloc_steal(af, mp_format_time_fmt(fmt, t));
+ if (!r)
+ js_error(J, "Invalid time format string '%s'", fmt);
+ js_pushstring(J, r);
+}
+
+// TODO: untested
+static void script_get_wakeup_pipe(js_State *J)
+{
+ js_pushnumber(J, mpv_get_wakeup_pipe(jclient(J)));
+}
+
+/**********************************************************************
+ * mp.utils
+ *********************************************************************/
+
+// args: [path [,filter]]
+static void script_readdir(js_State *J, void *af)
+{
+ // 0 1 2 3
+ const char *filters[] = {"all", "files", "dirs", "normal", NULL};
+ const char *path = js_isundefined(J, 1) ? "." : js_tostring(J, 1);
+ int t = checkopt(J, 2, "normal", filters, "listing filter");
+
+ DIR *dir = opendir(path);
+ if (!dir) {
+ push_failure(J, "Cannot open dir");
+ return;
+ }
+ add_af_dir(af, dir);
+ set_last_error(jctx(J), 0, NULL);
+ js_newarray(J); // the return value
+ char *fullpath = talloc_strdup(af, "");
+ struct dirent *e;
+ int n = 0;
+ while ((e = readdir(dir))) {
+ char *name = e->d_name;
+ if (t) {
+ if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0)
+ continue;
+ if (fullpath)
+ fullpath[0] = '\0';
+ fullpath = talloc_asprintf_append(fullpath, "%s/%s", path, name);
+ struct stat st;
+ if (stat(fullpath, &st))
+ continue;
+ if (!(((t & 1) && S_ISREG(st.st_mode)) ||
+ ((t & 2) && S_ISDIR(st.st_mode))))
+ {
+ continue;
+ }
+ }
+ js_pushstring(J, name);
+ js_setindex(J, -2, n++);
+ }
+}
+
+static void script_split_path(js_State *J)
+{
+ const char *p = js_tostring(J, 1);
+ bstr fname = mp_dirname(p);
+ js_newarray(J);
+ js_pushlstring(J, fname.start, fname.len);
+ js_setindex(J, -2, 0);
+ js_pushstring(J, mp_basename(p));
+ js_setindex(J, -2, 1);
+}
+
+static void script_join_path(js_State *J, void *af)
+{
+ js_pushstring(J, mp_path_join(af, js_tostring(J, 1), js_tostring(J, 2)));
+}
+
+static void script_get_user_path(js_State *J, void *af)
+{
+ const char *path = js_tostring(J, 1);
+ js_pushstring(J, mp_get_user_path(af, jctx(J)->mpctx->global, path));
+}
+
+struct subprocess_cb_ctx {
+ struct mp_log *log;
+ void *talloc_ctx;
+ int64_t max_size;
+ bstr output;
+ bstr err;
+};
+
+static void subprocess_stdout(void *p, char *data, size_t size)
+{
+ struct subprocess_cb_ctx *ctx = p;
+ if (ctx->output.len < ctx->max_size)
+ bstr_xappend(ctx->talloc_ctx, &ctx->output, (bstr){data, size});
+}
+
+static void subprocess_stderr(void *p, char *data, size_t size)
+{
+ struct subprocess_cb_ctx *ctx = p;
+ if (ctx->err.len < ctx->max_size)
+ bstr_xappend(ctx->talloc_ctx, &ctx->err, (bstr){data, size});
+ MP_INFO(ctx, "%.*s", (int)size, data);
+}
+
+// args: client invocation args object. TODO: use common backend for js/lua
+static void af_subprocess_common(js_State *J, int detach, void *af)
+{
+ struct script_ctx *ctx = jctx(J);
+ if (!js_isobject(J, 1))
+ js_error(J, "argument must be an object");
+
+ js_getproperty(J, 1, "args"); // args
+ int num_args = js_getlength(J, -1);
+ if (!num_args) // not using js_isarray to also accept array-like objects
+ js_error(J, "args must be an non-empty array");
+ char *args[256];
+ if (num_args > MP_ARRAY_SIZE(args) - 1) // last needs to be NULL
+ js_error(J, "too many arguments");
+ if (num_args < 1)
+ js_error(J, "program name missing");
+
+ for (int n = 0; n < num_args; n++) {
+ js_getindex(J, -1, n);
+ if (js_isundefined(J, -1))
+ js_error(J, "program arguments must be strings");
+ args[n] = talloc_strdup(af, js_tostring(J, -1));
+ js_pop(J, 1); // args
+ }
+ args[num_args] = NULL;
+
+ if (detach) {
+ mp_subprocess_detached(ctx->log, args);
+ push_success(J);
+ return;
+ }
+
+ struct mp_cancel *cancel = NULL;
+ if (js_hasproperty(J, 1, "cancellable") ? js_toboolean(J, -1) : true)
+ cancel = ctx->mpctx->playback_abort;
+
+ int64_t max_size = js_hasproperty(J, 1, "max_size") ? js_tointeger(J, -1)
+ : 16 * 1024 * 1024;
+ struct subprocess_cb_ctx cb_ctx = {
+ .log = ctx->log,
+ .talloc_ctx = af,
+ .max_size = max_size,
+ };
+
+ char *error = NULL;
+ int status = mp_subprocess(args, cancel, &cb_ctx, subprocess_stdout,
+ subprocess_stderr, &error);
+
+ js_newobject(J); // res
+ if (error) {
+ js_pushstring(J, error); // res e
+ js_setproperty(J, -2, "error"); // res
+ }
+ js_pushnumber(J, status); // res s
+ js_setproperty(J, -2, "status"); // res
+ js_pushlstring(J, cb_ctx.output.start, cb_ctx.output.len); // res d
+ js_setproperty(J, -2, "stdout"); // res
+ js_pushlstring(J, cb_ctx.err.start, cb_ctx.err.len);
+ js_setproperty(J, -2, "stderr");
+ js_pushboolean(J, status == MP_SUBPROCESS_EKILLED_BY_US); // res b
+ js_setproperty(J, -2, "killed_by_us"); // res
+}
+
+// args: client invocation args object (same also for _detached)
+static void script_subprocess(js_State *J, void *af)
+{
+ af_subprocess_common(J, 0, af);
+}
+
+static void script_subprocess_detached(js_State *J, void *af)
+{
+ af_subprocess_common(J, 1, af);
+}
+
+// args: prefixed file name, data (c-str)
+static void script_write_file(js_State *J, void *af)
+{
+ static const char *prefix = "file://";
+ const char *fname = js_tostring(J, 1);
+ const char *data = js_tostring(J, 2);
+ if (strstr(fname, prefix) != fname) // simple protection for incorrect use
+ js_error(J, "File name must be prefixed with '%s'", prefix);
+ fname += strlen(prefix);
+ fname = mp_get_user_path(af, jctx(J)->mpctx->global, fname);
+ MP_VERBOSE(jctx(J), "Writing file '%s'\n", fname);
+
+ FILE *f = fopen(fname, "wb");
+ if (!f)
+ js_error(J, "Cannot open file for writing: '%s'", fname);
+ add_af_file(af, f);
+
+ int len = strlen(data); // limited by terminating null
+ int wrote = fwrite(data, 1, len, f);
+ if (len != wrote)
+ js_error(J, "Cannot write to file: '%s'", fname);
+}
+
+// args: env var name
+static void script_getenv(js_State *J)
+{
+ js_pushstring(J, getenv(js_tostring(J, 1)));
+}
+
+// args: as-filename, content-string, returns the compiled result as a function
+static void script_compile_js(js_State *J)
+{
+ js_loadstring(J, js_tostring(J, 1), js_tostring(J, 2));
+}
+
+// args: true = print info (with the warning report function - no info report)
+static void script__gc(js_State *J)
+{
+ js_gc(J, js_toboolean(J, 1) ? 1 : 0);
+ push_success(J);
+}
+
+/**********************************************************************
+ * Core functions: pushnode, makenode and the event loop backend
+ *********************************************************************/
+
+// pushes a js value/array/object from an mpv_node