select.lua: populate the context menu

Add a default context menu definition in etc/menu.conf, which can be
replaced in ~~/menu.conf.

The format is meant to be easily readable with just 3+ spaces as
separators and submenus denoted by indentation. It avoids complicating
the builtin input.conf like similar scripts do.

select.lua parses menu.conf, fills menu-data and opens the context menu.
This is done from select.lua to reuse the code to format the data and
retrieve key bindings.

When a preconfigured submenu has more than 25 items, … entries are added
that open the scrollable console menu when clicked.

input-bindings is parsed to show the shortcuts bound to commands.
Compared to associating pre-defined shortcuts in the default input.conf,
this won't show wrong shortcuts when the user's input.conf changes key
bindings without redefining the menu.

console and stats key bindings are skipped in case the context menu is
opened together with those scripts.

Multimedia and numpad keys are not shown to reduce clutter.

Right click and MENU are rebound to show the context menu. MENU is not
added to restore-old-bindings.conf because it is uncommon. Shift+F10 is
also bound since it is a standard context menu binding.

Author: guidocella

.luacheckrc

@@ -106,4 +106,5 @@ stds = { mp = { read_globals = mp_globals } }
 -- mp_internal seems to be merged with mp for other files too...
 files["player/lua/defaults.lua"] = { globals = mp_internal }
 files["player/lua/auto_profiles.lua"] = { globals = { "p", "get" } }
+files["player/lua/select.lua"] = { globals = { "p", "get" } }
 max_line_length = 100

DOCS/man/context_menu.rst

@@ -1,10 +1,46 @@
 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
+The context menu is a menu that pops up on the video window. By default, it is
+bound to right click.
+
+menu.conf
+---------
+
+The default menu is defined in ``etc/menu.conf``. You can define your own menu
+in ``~~/menu.conf`` (see `FILES`_), or an alternative path specified with
+``--script-opt=select_menu_conf_path``. It is recommended to use the default
+``menu.conf`` from https://github.com/mpv-player/mpv/blob/master/etc/input.conf
+as an example to get started.
+
+Each line of ``menu.conf`` is a menu entry with fields separated by 3 or more
+spaces. The first field is the text shown in the menu. The second field is
+usually the command that is run when that entry is selected. Fields from the
+third onwards can specify ``checked=``, ``disabled=`` and ``hidden=`` states in
+the same way as `Conditional auto profiles`_.
+
+When there is only one field, or the second field specifies a state, it is
+interpreted as the title of an entry associated with a submenu. Fields below
+indented with leading spaces are added to this submenu. Nested submenu items are
+defined by adding more leading spaces than the parent menu entry.
+
+Empty lines are interpreted as separators.
+
+The second field can also be one of the following tokens to make that entry a
+submenu with the relative items: ``$playlist``, ``$video-tracks``,
+``$audio-tracks``, ``$sub-tracks``, ``$secondary-sub-tracks``, ``$chapters``,
+``$editions``, ``$audio-devices``. These menus are automatically disabled when
+empty.
+
+``menu.conf`` is parsed by ``select.lua`` in order to fill the ``menu-data``
+property. It then calls the ``context-menu`` command on platforms where
+integration with the native context menu is implemented, while on platforms
+where it is not, it opens ``context_menu.lua``.
+
+On these platforms, ``context_menu.lua`` can be disabled entirely using the
 ``--load-context-menu=no`` option. On platforms where the integration is
-implemented, it is already disabled by default.
+implemented, it is already disabled by default, and ``--load-context-menu=yes``
+will make ``select.lua`` use it.
 
 Script messages
 ---------------

DOCS/man/mpv.rst

@@ -351,11 +351,14 @@ g-b
 g-r
     Show the values of all properties.
 
-g-m, MENU, Ctrl+p
+g-m, Ctrl+p
     Show a menu with miscellaneous entries.
 
 See `SELECT`_ for more information.
 
+MENU, Shift+F10
+    Show the context menu (see `CONTEXT MENU`_).
+
 (The following keys are valid if you have a keyboard with multimedia keys.)
 
 PAUSE
@@ -384,7 +387,7 @@ Left double click
     Toggle fullscreen on/off.
 
 Right click
-    Toggle pause on/off.
+    Show the context menu (see `CONTEXT MENU`_).
 
 Forward/Back button
     Skip to next/previous entry in playlist.
@@ -399,16 +402,6 @@ Ctrl+Wheel up/down
     Change video zoom keeping the part of the video hovered by the cursor under
     it.
 
-Context Menu
--------------
-
-Context Menu is a menu that pops up on the video window on user interaction
-(mouse right click, etc.).
-
-To use this feature, you need to fill the ``menu-data`` property with menu
-definition data, and add a keybinding to run the ``context-menu`` command,
-which can be done with a user script.
-
 USAGE
 =====
 

DOCS/man/select.rst

@@ -7,6 +7,8 @@ providing script bindings that gather and format the data to be selected in the
 console and do operations on the selected item. It can be disabled using the
 ``--load-select=no`` option.
 
+This script is also used to populate the context menu.
+
 Key bindings
 ------------
 
@@ -130,6 +132,9 @@ Available script bindings are:
 ``menu``
     Show a menu with miscellaneous entries.
 
+``context-menu``
+    Show the context menu.
+
 Configuration
 -------------
 
@@ -150,3 +155,26 @@ Configurable options
     Default: yes
 
     Whether to show only the last of history entries with the same path.
+
+``menu_conf_path``
+    Default: ~~/menu.conf (see `FILES`_).
+
+    The path from which to read the custom context menu definition (see `CONTEXT
+    MENU`_).
+
+``max_submenu_items``
+    Default: 25
+
+    The maximum number of items in preconfigured submenus.
+
+``use_context_menu_script``
+    Default: auto
+
+    Whether to use the native context menu or ``context_menu.lua``.
+
+    ``auto`` means ``context_menu.lua`` is used with
+    ``--load-context-menu=yes``, and the native context menu is attempted to be
+    used with ``--load-context-menu=no``.
+
+    ``yes`` allows using a fork of ``context_menu.lua`` with
+    ``--load-context-menu=no``.

DOCS/tech-overview.txt

@@ -272,8 +272,9 @@ sub/:
     sd_ass.c's internal state.
 
 etc/:
-    The files input.conf and builtin.conf are actually integrated into the mpv
-    binary by the build system. They contain the default configs and keybindings.
+    The files input.conf, builtin.conf and menu.conf are actually integrated
+    into the mpv binary by the build system. They contain the default configs
+    and keybindings.
 
 Best practices and Concepts within mpv
 ======================================

etc/input.conf

@@ -30,7 +30,7 @@
 
 #MBTN_LEFT     ignore              # don't do anything
 #MBTN_LEFT_DBL cycle fullscreen    # toggle fullscreen
-#MBTN_RIGHT    cycle pause         # toggle pause/playback mode
+#MBTN_RIGHT    script-binding select/context-menu # show the context menu
 #MBTN_BACK     playlist-prev       # skip to the previous file
 #MBTN_FORWARD  playlist-next       # skip to the next file
 #Ctrl+MBTN_LEFT script-binding positioning/drag-to-pan # pan around the clicked point
@@ -196,8 +196,9 @@
 #g-b script-binding select/select-binding
 #g-r script-binding select/show-properties
 #g-m script-binding select/menu
-#MENU script-binding select/menu
 #ctrl+p script-binding select/menu
+#MENU script-binding select/context-menu
+#Shift+F10 script-binding select/context-menu
 
 #Alt+KP1 add video-rotate -1 # rotate video counterclockwise by 1 degree
 #Alt+KP5 set video-rotate  0 # reset rotation

etc/menu.conf

@@ -0,0 +1,133 @@
+Play    cycle pause    hidden=not pause and not idle_active    disabled=idle_active
+Pause   cycle pause    hidden=idle_active or pause
+Stop    stop           hidden=idle ~= true                     disabled=idle_active
+
+Open
+    Clipboard      loadfile ${clipboard/text} append-play; show-text '+ ${clipboard/text}'
+    History        script-binding select/select-watch-history
+    Watch later    script-binding select/select-watch-later
+Playlist          $playlist        disabled=playlist_count < 2
+
+Video
+    Track    $video-tracks
+
+    Fill        no-osd cycle-values panscan 0 1; no-osd set video-unscaled no; no-osd set video-zoom 0      checked=panscan == 1
+    Unscaled    no-osd cycle-values video-unscaled yes no; no-osd set video-zoom 0; no-osd set panscan 0    checked=video_unscaled
+    Zoom
+        50%      set video-zoom -1    checked=video_zoom == -1
+        100%     set video-zoom  0    checked=video_zoom == 0
+        200%     set video-zoom  1    checked=video_zoom == 1
+    Aspect ratio
+        16:9      set video-aspect-override 16:9      checked=math.abs(video_aspect_override - 1.7) < 0.1
+        4:3       set video-aspect-override 4:3       checked=math.abs(video_aspect_override - 1.3) < 0.1
+        2.35:1    set video-aspect-override 2.35:1    checked=video_aspect_override == 2.35
+        Default   set video-aspect-override no        checked=video_aspect_override == -2
+    Center      no-osd set video-pan-x 0; no-osd set video-pan-y 0; no-osd set video-align-x 0; no-osd set video-align-y 0   disabled=video_pan_x == 0 and video_pan_y == 0 and video_align_x == 0 and video_align_y == 0
+
+    Rotate clockwise           cycle-values video-rotate 90 180 270 0
+    Rotate counterclockwise    cycle-values video-rotate 270 180 90 0
+
+    Deband         cycle deband         checked=deband
+    Deinterlace    cycle deinterlace    checked=deinterlace_active
+
+    Screenshot                      screenshot          disabled=not p["current-tracks/video"]
+    Screenshot without subtitles    screenshot video    disabled=not p["current-tracks/video"]
+Audio
+    Track      $audio-tracks
+    Devices    $audio-devices
+    Channels
+        Auto      set audio-channels auto-safe    checked=audio_channels == "auto-safe"
+        Stereo    set audio-channels stereo       checked=audio_channels == "stereo"
+        Mono      set audio-channels mono         checked=audio_channels == "mono"
+
+    Increase volume    add volume  5
+    Decrease volume    add volume -5
+    Mute               cycle mute    checked=mute
+
+    Increase delay    add audio-delay  0.1
+    Decrease delay    add audio-delay -0.1
+Subtitle
+    Track             $sub-tracks
+    Visible           cycle sub-visibility    checked=sub_visibility
+
+    Increase delay    add sub-delay  0.1
+    Decrease delay    add sub-delay -0.1
+
+    Scale up      add sub-scale  0.1
+    Scale down    add sub-scale -0.1
+
+    Lines    script-binding select/select-subtitle-line    disabled=not sid or p["current-tracks/sub/codec"] == "dvd_subtitle" or p["current-tracks/sub/codec"] == "hdmv_pgs_subtitle"
+    Secondary subtitle
+        Track             $secondary-sub-tracks
+        Visible           cycle secondary-sub-visibility    checked=secondary_sub_visibility
+
+        Increase delay    add secondary-sub-delay 0.1
+        Decrease delay    add secondary-sub-delay -0.1
+
+Playback
+    Display duration    hidden=not p["current-tracks/video/image"] or p["current-tracks/audio"]
+        1 second      set image-display-duration 1      checked=image_display_duration == 1
+        2 seconds     set image-display-duration 2      checked=image_display_duration == 2
+        5 seconds     set image-display-duration 5      checked=image_display_duration == 5
+        10 seconds    set image-display-duration 10     checked=image_display_duration == 10
+        Infinite      set image-display-duration inf    checked=image_display_duration == math.huge
+    Speed    hidden=p["current-tracks/video/image"] and not p["current-tracks/audio"]
+        25%     set speed 0.25    checked=speed == 0.25
+        50%     set speed 0.50    checked=speed == 0.50
+        75%     set speed 0.75    checked=speed == 0.75
+        100%    set speed 1       checked=speed == 1
+        125%    set speed 1.25    checked=speed == 1.25
+        150%    set speed 1.50    checked=speed == 1.50
+        175%    set speed 1.75    checked=speed == 1.75
+        200%    set speed 2       checked=speed == 2
+        400%    set speed 4       checked=speed == 4
+        800%    set speed 8       checked=speed == 8
+
+    Seek 10 seconds forward     seek  10     hidden=p["current-tracks/video/image"] and not p["current-tracks/audio"]
+    Seek 10 seconds backward    seek -10     hidden=p["current-tracks/video/image"] and not p["current-tracks/audio"]
+    Seek 10 minutes forward     seek  600    hidden=p["current-tracks/video/image"] and not p["current-tracks/audio"]
+    Seek 10 minutes backward    seek -600    hidden=p["current-tracks/video/image"] and not p["current-tracks/audio"]
+
+    Next file         playlist-next    disabled=playlist_count < 2
+    Previous file     playlist-prev    disabled=playlist_count < 2
+
+    Next sub-playlist        playlist-next-playlist    disabled=playlist_count < 2
+    Previous sub-playlist    playlist-prev-playlist    disabled=playlist_count < 2
+Chapters           $chapters
+Editions/Titles    $editions    disabled=get("edition-list/count", 0) < 2
+
+Window
+    Fullscreen       cycle fullscreen    checked=fullscreen
+    Border           cycle border        checked=border
+    Always on top    cycle ontop         checked=ontop
+    Window scale
+        50%     set window-scale 0.5    checked=math.abs(get(current_window_scale, 0) - 0.5) < 0.1
+        100%    set window-scale 1      checked=math.abs(get(current_window_scale, 0) - 1) < 0.1
+        200%    set window-scale 2      checked=math.abs(get(current_window_scale, 0) - 2) < 0.1
+        300%    set window-scale 3      checked=math.abs(get(current_window_scale, 0) - 3) < 0.1
+    Screenshot window    screenshot window
+View
+    Stats                   script-binding stats/display-page-1-toggle
+    File info               script-binding stats/display-page-5-toggle
+    Key bindings            script-binding stats/display-page-4-toggle
+    Time OSD                no-osd cycle-values osd-level 3 1    checked=osd_level == 3
+    Cycle OSC visibility    script-binding osc/visibility
+Tools
+    Set/clear A-B loop points    ab-loop
+    Loop file        cycle-values loop-file inf no        checked=loop_file == "inf"
+    Loop playlist    cycle-values loop-playlist inf no    checked=loop_playlist == "inf"
+
+    Copy path        set clipboard/text ${path}           disabled=idle_active
+    Copy subtitle    set clipboard/text ${sub-text}       disabled=not sid or p["current-tracks/sub/codec"] == "dvd_subtitle" or p["current-tracks/sub/codec"] == "hdmv_pgs_subtitle"
+    Copy title       set clipboard/text ${media-title}    disabled=idle_active
+
+    Shuffle              playlist-shuffle
+    Unshuffle            playlist-unshuffle
+
+    Hardware decoding    cycle-values hwdec no auto    checked=hwdec_current ~= "no"    disabled=p["current-tracks/video/image"] ~= false
+    Key bindings         script-binding select/select-binding
+    Properties           script-binding select/show-properties
+    Console              script-binding commands/open
+
+Quit               quit
+Quit watch later   quit-watch-later    hidden=save_position_on_quit

etc/meson.build

@@ -9,7 +9,7 @@ foreach size: icons
     sources += icon
 endforeach
 
-etc_files = ['input.conf', 'builtin.conf']
+etc_files = ['input.conf', 'builtin.conf', 'menu.conf']
 foreach file: etc_files
     etc_file = custom_target(file,
         input: file,

etc/restore-old-bindings.conf

@@ -9,6 +9,10 @@
 #
 # Older installations use ~/.mpv/input.conf instead.
 
+# changed in mpv 0.41.0
+
+MBTN_RIGHT cycle pause
+
 # changed in mpv 0.37.0
 
 WHEEL_UP      seek 10                  # seek 10 seconds forward

player/command.c

@@ -4039,6 +4039,22 @@ static int mp_property_mdata(void *ctx, struct m_property *prop,
     return M_PROPERTY_NOT_IMPLEMENTED;
 }
 
+static int mp_property_default_menu(void *ctx, struct m_property *prop,
+                                    int action, void *arg)
+{
+    switch (action) {
+        case M_PROPERTY_GET:
+            *(char **)arg = talloc_strdup(NULL,
+#include "etc/menu.conf.inc"
+                );
+            return M_PROPERTY_OK;
+        case M_PROPERTY_GET_TYPE:
+            *(struct m_option *)arg = (struct m_option){.type = CONF_TYPE_STRING};
+            return M_PROPERTY_OK;
+    }
+    return M_PROPERTY_NOT_IMPLEMENTED;
+}
+
 static int do_list_udata(int item, int action, void *arg, void *ctx);
 
 struct udata_ctx {
@@ -4542,6 +4558,7 @@ static const struct m_property mp_properties_base[] = {
     {"input-bindings", mp_property_bindings},
 
     {"menu-data", mp_property_mdata},
+    {"default-menu", mp_property_default_menu},
 
     {"user-data", mp_property_udata},
     {"term-size", mp_property_term_size},