context_menu.lua: add this script

This implements a ASS context menu to be used on platforms other than
Windows.

The select script message will allow selecting an item with a single
click when releasing a mouse button, like in native context menus. This
is mainly useful to cycle pause with one click.

Author: guidocella

DOCS/interface-changes/context-menu.rst

@@ -0,0 +1 @@
+add `--load-context-menu` option

DOCS/man/context_menu.rst

@@ -0,0 +1,98 @@
+CONTEXT MENU
+============
+
+This script provides a context menu for platforms without integration with a
+native context menu. On these platforms, it can be disabled entirely using the
+``--load-context-menu=no`` option. On platforms where the integration is
+implemented, it is already disabled by default.
+
+Script messages
+---------------
+
+``open``
+    Show the context menu.
+
+``select``
+    Select the focused item when there is one.
+
+Configuration
+-------------
+
+This script can be customized through a config file
+``script-opts/context_menu.conf`` placed in mpv's user directory and through
+the ``--script-opts`` command-line option. The configuration syntax is
+described in `mp.options functions`_.
+
+Configurable Options
+~~~~~~~~~~~~~~~~~~~~
+
+``font_size``
+    Default: 20
+
+    The font size.
+
+``gap``
+    Default: 5
+
+    The gap between menu items.
+
+``padding_x``
+    Default: 10
+
+    The horizontal padding of the menu.
+
+``padding_y``
+    Default: 5
+
+    The vertical padding of the menu.
+
+``menu_outline_size``
+    Default: 0
+
+    The size of the menu's border.
+
+``menu_outline_color``
+    Default: ``#FFFFFF``
+
+    The color of the menu's border.
+
+``corner_radius``
+    Default: 8
+
+    The radius of the menu's corners.
+
+``scale_with_window``
+    Default: auto
+
+    Whether to scale sizes with the window height. Can be ``yes``, ``no``, or
+    ``auto``, which follows the value of ``--osd-scale-by-window``.
+
+    When sizes aren't scaled with the window, they are scaled by
+    ``display-hidpi-scale``.
+
+``focused_color``
+    Default: ``#222222``
+
+    The color of the focused item.
+
+``focused_back_color``
+    Default: ``#FFFFFF``
+
+    The background color of the focused item.
+
+``disabled_color``
+    Default: ``#555555``
+
+    The color of disabled items.
+
+``seconds_to_open_submenus``
+    Default: 0.2
+
+    The number of seconds to open submenus after the cursor enters items
+    associated with one.
+
+``seconds_to_close_submenus``
+    Default: 0.2
+
+    The number of seconds to close submenus after the cursor enters a parent
+    menu.

DOCS/man/mpv.rst

@@ -402,11 +402,6 @@ Ctrl+Wheel up/down
 Context Menu
 -------------
 
-.. warning::
-
-    This feature is experimental. It may not work with all VOs. A libass based
-    fallback may be implemented in the future.
-
 Context Menu is a menu that pops up on the video window on user interaction
 (mouse right click, etc.).
 
@@ -1548,6 +1543,8 @@ works like in older mpv releases:
 
 .. include:: select.rst
 
+.. include:: context_menu.rst
+
 .. include:: positioning.rst
 
 .. include:: lua.rst

DOCS/man/options.rst

@@ -1066,6 +1066,11 @@ Program Behavior
     Enable the builtin script that lets you select from lists of items (default:
     yes). By default, its keybindings start with the ``g`` key.
 
+``--load-context-menu=<yes|no>``
+    Enable the builtin script that implements a context menu. Defaults to
+    ``yes`` on platforms where integration with a native context menu is not
+    implemented, and to ``no`` on platform where it is.
+
 ``--load-positioning=<yes|no>``
     Enable the builtin script that provides various keybindings to pan videos
     and images (default: yes).

etc/builtin.conf

@@ -85,6 +85,8 @@ osd-outline-size=0
 osd-shadow-offset=4
 script-opt=console-border_size=0
 script-opt=console-corner_radius=0
+script-opt=context_menu-padding_y=0
+script-opt=context_menu-corner_radius=0
 script-opt=stats-border_size=0
 
 [sub-box]

options/options.c

@@ -565,6 +565,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-context-menu", OPT_BOOL(lua_load_context_menu), .flags = UPDATE_BUILTIN_SCRIPTS},
 #endif
 
 // ------------------------- stream options --------------------
@@ -1000,6 +1001,9 @@ static const struct MPOpts mp_default_opts = {
     .lua_load_select = true,
     .lua_load_positioning = true,
     .lua_load_commands = true,
+#ifndef _WIN32
+    .lua_load_context_menu = true,
+#endif
 #endif
     .auto_load_scripts = true,
     .loop_times = 1,

options/options.h

@@ -183,6 +183,7 @@ typedef struct MPOpts {
     bool lua_load_select;
     bool lua_load_positioning;
     bool lua_load_commands;
+    bool lua_load_context_menu;
 
     bool auto_load_scripts;
 

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;
 

player/lua.c

@@ -90,6 +90,9 @@ static const char * const builtin_lua_scripts[][2] = {
     },
     {"@commands.lua",
 #   include "player/lua/commands.lua.inc"
+    },
+    {"@context_menu.lua",
+#   include "player/lua/context_menu.lua.inc"
     },
     {0}
 };