utils.lua: add this script

guidocella · guidocella · commit e148a55e959d · 2025-04-02T18:38:32.000+02:00
Add a script with script bindings to edit mpv.conf and input.conf, and
add them to the menu. These are useful as shortcuts, but the main
motivation is that new users often ask why they can't find mpv.conf and
input.conf, so this creates them if they don't exist, also including
links to the documentation.

Other future script bindings that don't fit anywhere else can also be
added to utils.lua.
diff --git a/DOCS/interface-changes/utils.txt b/DOCS/interface-changes/utils.txt
@@ -0,0 +1 @@
+add `--load-utils` option
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
@@ -1547,6 +1547,8 @@ works like in older mpv releases:
 
 .. include:: positioning.rst
 
+.. include:: utils.rst
+
 .. include:: lua.rst
 
 .. include:: javascript.rst
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
@@ -1070,6 +1070,10 @@ Program Behavior
     Enable the builtin script that provides various keybindings to pan videos
     and images (default: yes).
 
+``--load-utils=<yes|no>``
+    Enable the builtin script that provides miscellaneous script bindings
+    (default: yes).
+
 ``--player-operation-mode=<cplayer|pseudo-gui>``
     For enabling "pseudo GUI mode", which means that the defaults for some
     options are changed. This option should not normally be used directly, but
diff --git a/DOCS/man/utils.rst b/DOCS/man/utils.rst
@@ -0,0 +1,16 @@
+UTILS
+=====
+
+This script provides miscellaneous script bindings. It can be disabled using the
+``--load-utils=no`` option.
+
+Script bindings
+---------------
+
+``edit-config-file``
+    Open ``mpv.conf`` in the system text editor, creating it if it doesn't
+    already exist.
+
+``edit-input-conf``
+    Open ``input.conf`` in the system text editor, creating it if it doesn't
+    already exist.
diff --git a/options/options.c b/options/options.c
@@ -556,6 +556,7 @@ static const m_option_t mp_opts[] = {
     {"load-select", OPT_BOOL(lua_load_select), .flags = UPDATE_BUILTIN_SCRIPTS},
     {"load-positioning", OPT_BOOL(lua_load_positioning), .flags = UPDATE_BUILTIN_SCRIPTS},
     {"load-commands", OPT_BOOL(lua_load_commands), .flags = UPDATE_BUILTIN_SCRIPTS},
+    {"load-utils", OPT_BOOL(lua_load_utils), .flags = UPDATE_BUILTIN_SCRIPTS},
 #endif
 
 // ------------------------- stream options --------------------
@@ -990,6 +991,7 @@ static const struct MPOpts mp_default_opts = {
     .lua_load_select = true,
     .lua_load_positioning = true,
     .lua_load_commands = true,
+    .lua_load_utils = true,
 #endif
     .auto_load_scripts = true,
     .loop_times = 1,
diff --git a/options/options.h b/options/options.h
@@ -176,6 +176,7 @@ typedef struct MPOpts {
     bool lua_load_select;
     bool lua_load_positioning;
     bool lua_load_commands;
+    bool lua_load_utils;
 
     bool auto_load_scripts;
 
diff --git a/player/core.h b/player/core.h
@@ -444,7 +444,7 @@ typedef struct MPContext {
 
     struct mp_ipc_ctx *ipc_ctx;
 
-    int64_t builtin_script_ids[8];
+    int64_t builtin_script_ids[9];
 
     mp_mutex abort_lock;
 
diff --git a/player/lua.c b/player/lua.c
@@ -90,6 +90,9 @@ static const char * const builtin_lua_scripts[][2] = {
     },
     {"@commands.lua",
 #   include "player/lua/commands.lua.inc"
+    },
+    {"@utils.lua",
+#   include "player/lua/utils.lua.inc"
     },
     {0}
 };
diff --git a/player/lua/meson.build b/player/lua/meson.build
@@ -1,7 +1,7 @@
 lua_files = ['defaults.lua', 'assdraw.lua', 'options.lua', 'osc.lua',
              'ytdl_hook.lua', 'stats.lua', 'console.lua', 'auto_profiles.lua',
              'input.lua', 'fzy.lua', 'select.lua', 'positioning.lua',
-             'commands.lua']
+             'commands.lua', 'utils.lua']
 foreach file: lua_files
     lua_file = custom_target(file,
         input: file,
diff --git a/player/lua/select.lua b/player/lua/select.lua
@@ -620,6 +620,8 @@ mp.add_key_binding(nil, "menu", function ()
         {"Watch later", "script-binding select/select-watch-later", true},
         {"Stats for nerds", "script-binding stats/display-page-1-toggle", true},
         {"File info", "script-binding stats/display-page-5-toggle", mp.get_property("filename")},
+        {"Edit config file", "script-binding utils/edit-config-file", true},
+        {"Edit key bindings", "script-binding utils/edit-input-conf", true},
         {"Help", "script-binding stats/display-page-4-toggle", true},
     }
 
diff --git a/player/lua/utils.lua b/player/lua/utils.lua
@@ -0,0 +1,82 @@
+--[[
+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/>.
+]]
+
+local utils = require "mp.utils"
+
+local default_config_file = [[# https://mpv.io/manual/master/#configuration-files
+# https://mpv.io/manual/master/#options
+
+]]
+
+local default_input_conf = [[# https://mpv.io/manual/master/#command-interface
+
+]]
+
+local function show_error(message)
+    mp.msg.error(message)
+    if mp.get_property_native("vo-configured") then
+        mp.osd_message(message)
+    end
+end
+
+local function edit_config_file(filename, initial_contents)
+    local path = mp.find_config_file(filename)
+
+    if not path then
+        path = mp.command_native({"expand-path", "~~/" .. filename})
+        local file_handle, error_message = io.open(path, "w")
+
+        if not file_handle then
+            show_error(error_message)
+            return
+        end
+
+        file_handle:write(initial_contents)
+        file_handle:close()
+    end
+
+    local platform = mp.get_property("platform")
+    local args
+    if platform == "windows" then
+        args = {"rundll32", "url.dll,FileProtocolHandler", path}
+    elseif platform == "darwin" then
+        args = {"open", path}
+    else
+        args = {"xdg-open", path}
+    end
+
+    local result = mp.command_native({
+        name = "subprocess",
+        playback_only = false,
+        args = args,
+    })
+
+    if result.status < 0 then
+        show_error("Subprocess error: " .. result.error_string)
+    elseif result.status > 0 then
+        show_error(utils.to_string(args) .. " failed with code " ..
+                   result.status)
+    end
+end
+
+mp.add_key_binding(nil, "edit-config-file", function ()
+    edit_config_file("mpv.conf", default_config_file)
+end)
+
+mp.add_key_binding(nil, "edit-input-conf", function ()
+    edit_config_file("input.conf", default_input_conf)
+end)
diff --git a/player/scripting.c b/player/scripting.c
@@ -269,6 +269,7 @@ void mp_load_builtin_scripts(struct MPContext *mpctx)
     load_builtin_script(mpctx, 5, mpctx->opts->lua_load_select, "@select.lua");
     load_builtin_script(mpctx, 6, mpctx->opts->lua_load_positioning, "@positioning.lua");
     load_builtin_script(mpctx, 7, mpctx->opts->lua_load_commands, "@commands.lua");
+    load_builtin_script(mpctx, 8, mpctx->opts->lua_load_utils, "@utils.lua");
 }
 
 bool mp_load_scripts(struct MPContext *mpctx)

Original file line number	Diff line number	Diff line change
`@@ -620,6 +620,8 @@ mp.add_key_binding(nil, "menu", function ()`
`620`	`620`	`{"Watch later", "script-binding select/select-watch-later", true},`
`621`	`621`	`{"Stats for nerds", "script-binding stats/display-page-1-toggle", true},`
`622`	`622`	`{"File info", "script-binding stats/display-page-5-toggle", mp.get_property("filename")},`
	`623`	`+ {"Edit config file", "script-binding utils/edit-config-file", true},`
	`624`	`+ {"Edit key bindings", "script-binding utils/edit-input-conf", true},`
`623`	`625`	`{"Help", "script-binding stats/display-page-4-toggle", true},`
`624`	`626`	`}`
`625`	`627`