MORPH
SIGN IN SIGN UP
mpv-player / mpv UNCLAIMED

🎥 Command line media player

0 0 0 C
Normal View History Raw
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
--[[
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 input = require "mp.input"
select.lua: select from the watch history with g-h Implement selection of the entries in the watch history. The last entry in the selector deletes the history file.
2025-01-26 08:42:58 +01:00
local options = {
history_date_format = "%Y-%m-%d %H:%M:%S",
hide_history_duplicates = true,
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
menu_conf_path = "~~/menu.conf",
max_playlist_items = 25,
populate_menu_data = true,
select.lua: select from the watch history with g-h Implement selection of the entries in the watch history. The last entry in the selector deletes the history file.
2025-01-26 08:42:58 +01:00
}
require "mp.options".read_options(options, nil, function () end)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local platform = mp.get_property("platform")
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
local function show_warning(message)
mp.msg.warn(message)
if mp.get_property_native("vo-configured") then
mp.osd_message(message)
end
end
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local function show_error(message)
mp.msg.error(message)
if mp.get_property_native("vo-configured") then
mp.osd_message(message)
end
end
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local function to_map(t)
local map = {}
for _, value in pairs(t) do
map[value] = true
end
return map
end
local function format_playlist_entry(entry, show)
local item = entry.title
if not item or show ~= "title" then
item = entry.filename
if not item:find("://") then
item = select(2, utils.split_path(item))
end
if entry.title and show == "both" then
item = entry.title .. " (" .. item .. ")"
end
end
return item
end
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-playlist", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local playlist = {}
select.lua: don't needlessly initialize default_item
2024-05-13 20:32:48 +02:00
local default_item
options: add --osd-playlist-entry Allow configuring whether to print the media-title, the filename or both (as `<title> (<filename>)`) in show-text ${playlist}, the OSC playlist and in the playlist selector. Showing only titles hides information when files are badly tagged, or when it hides the track numbers of album songs. But showing filenames is not as useful as titles e.g. when playing URLs with media titles. This option lets the user choose which one to show, or show both if switching is inconvenient. The OSC's playlist_media_title script-opt is removed because this option is better since it works everywhere after configuring it once. Closes #11653. Also show the full URLs of playlist entries instead of their basenames in osc.lua and select.lua, consistently with mp_property_playlist(). For simplicity, this just checks if entries contain :// instead of replicating all of mp_is_url(). Co-authored-by: Kacper Michajłow <kasper93@gmail.com>
2024-06-08 01:28:36 +02:00
local show = mp.get_property_native("osd-playlist-entry")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
for i, entry in ipairs(mp.get_property_native("playlist")) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
playlist[i] = format_playlist_entry(entry, show)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
if entry.playing then
default_item = i
end
end
if #playlist == 0 then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning("The playlist is empty.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
input.select({
prompt = "Select a playlist entry:",
items = playlist,
default_item = default_item,
submit = function (index)
mp.commandv("playlist-play-index", index - 1)
end,
})
end)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local function format_track_type(track)
return (track.image
and "Image"
or track.type:sub(1, 1):upper() .. track.type:sub(2)) ..
": "
end
various: sync shown track flags Show the same flags in loadfile.c, select.lua and stats.lua. The only differences are that only stats.lua prints both image and albumart because it's supposed to show detailed track information, and select.lua prints the image flag because pressing g-v doesn't show Video or Image like in loadfile.c and stats.lua.
2024-06-27 20:00:31 +02:00
local function format_flags(track)
local flags = ""
for _, flag in ipairs({
"default", "forced", "dependent", "visual-impaired", "hearing-impaired",
{demux,player}: expose original and commentary track flags Those flags were added to the Matroska specification together with the already implemented hearing-impaired and visual-impaired flags. They allow specifying whether a track is a commentary track or in the original language without relying on the free-form track name, which makes consistent tagging and parsing by machines easier. Ref: https://github.com/ietf-wg-cellar/matroska-specification/pull/447 Ref: https://www.rfc-editor.org/rfc/rfc9559#name-original-flag Ref: https://www.rfc-editor.org/rfc/rfc9559#name-commentary-flag
2026-02-19 21:56:08 +01:00
"original", "commentary", "image", "external"
various: sync shown track flags Show the same flags in loadfile.c, select.lua and stats.lua. The only differences are that only stats.lua prints both image and albumart because it's supposed to show detailed track information, and select.lua prints the image flag because pressing g-v doesn't show Video or Image like in loadfile.c and stats.lua.
2024-06-27 20:00:31 +02:00
}) do
if track[flag] then
flags = flags .. flag .. " "
end
end
if flags == "" then
return ""
end
return " [" .. flags:sub(1, -2) .. "]"
end
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local function format_track(track)
loadfile,select.lua: print only one bitrate Print demux-bitrate if available, else hls-bitrate, not both (as demux-bitrate is generally more reliable). This avoids printing "HLS kbps" which looks weird. Fixes https://github.com/mpv-player/mpv/pull/14453#discussion_r1700550385
2024-08-01 19:36:32 +02:00
local bitrate = track["demux-bitrate"] or track["hls-bitrate"]
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return (track.selected and "●" or "○") ..
(track.title and " " .. track.title or "") ..
" (" .. (
(track.lang and track.lang .. " " or "") ..
(track.codec and track.codec .. " " or "") ..
(track["demux-w"] and track["demux-w"] .. "x" .. track["demux-h"]
.. " " or "") ..
(track["demux-fps"] and not track.image
select.lua: strip trailing zeros from FPS values Show e.g. "30 fps" instead of "30.000 fps". Also switch to %.4f for consistency with pretty_print_double().
2024-05-14 20:10:11 +02:00
and string.format("%.4f", track["demux-fps"]):gsub("%.?0*$", "") ..
" fps " or "") ..
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
(track["demux-channel-count"] and track["demux-channel-count"] ..
loadfile: update the format of terminal track information Stop making unselected tracks and editions grey because they can be hard to read over a dark background (\033[2m would be hard to differentiate from regular text with a light theme instead), and because there is no way to not print the escape sequences in --log-file. Just use the same circles as the OSD and OSC. We need to print the empty circles for alignment on mlterm with East Asian fonts (we could also make them invisible with \033[8m but it would still get added to log files). Add back the space before tracks and editions when printed after "Playing..." or "Track switched" and similar, so they look like a sub-section of it, consistently with the metadata which starts with space which makes it look like a sub-section of the "File tags" line. Leave 2 spaces between track columns. Make the lang options only as long as the longest language. Place hls-bitrate within the same parentheses as the other data. Replace the incomprehensible (*) (f) and [P] with textual descriptions within []. Also place external there. Stop converting Hz to kHz for consistency with other log messages, e.g. AO: [pipewire] 48000Hz stereo 2ch floatp Remove the space in "2 ch" so it doesn't look like 2 separate values (We considered using mp_chmap_to_str(&s->codec->channels) but it prints values like "unknown2").
2024-06-24 15:56:55 +02:00
"ch " or "") ..
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
(track["codec-profile"] and track.type == "audio"
and track["codec-profile"] .. " " or "") ..
(track["demux-samplerate"] and track["demux-samplerate"] / 1000 ..
loadfile,select.lua: print bitrates of tracks
2024-06-27 16:33:48 +02:00
" kHz " or "") ..
loadfile,select.lua: print only one bitrate Print demux-bitrate if available, else hls-bitrate, not both (as demux-bitrate is generally more reliable). This avoids printing "HLS kbps" which looks weird. Fixes https://github.com/mpv-player/mpv/pull/14453#discussion_r1700550385
2024-08-01 19:36:32 +02:00
(bitrate and string.format("%.0f", bitrate / 1000) ..
" kbps " or "")
various: sync shown track flags Show the same flags in loadfile.c, select.lua and stats.lua. The only differences are that only stats.lua prints both image and albumart because it's supposed to show detailed track information, and select.lua prints the image flag because pressing g-v doesn't show Video or Image like in loadfile.c and stats.lua.
2024-06-27 20:00:31 +02:00
):sub(1, -2) .. ")" .. format_flags(track)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
end
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-track", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local tracks = {}
for i, track in ipairs(mp.get_property_native("track-list")) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
tracks[i] = format_track_type(track) .. format_track(track)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
end
if #tracks == 0 then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning("No available tracks.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
input.select({
prompt = "Select a track:",
items = tracks,
submit = function (id)
local track = mp.get_property_native("track-list/" .. id - 1)
if track then
mp.set_property(track.type, track.selected and "no" or track.id)
end
end,
})
end)
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
local function select_track(property, type, prompt, warning)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local tracks = {}
local items = {}
select.lua: don't needlessly initialize default_item
2024-05-13 20:32:48 +02:00
local default_item
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local track_id = mp.get_property_native(property)
for _, track in ipairs(mp.get_property_native("track-list")) do
if track.type == type then
tracks[#tracks + 1] = track
items[#items + 1] = format_track(track)
if track.id == track_id then
default_item = #items
end
end
end
if #items == 0 then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning(warning)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
input.select({
prompt = prompt,
items = items,
default_item = default_item,
submit = function (id)
mp.set_property(property, tracks[id].selected and "no" or tracks[id].id)
end,
})
end
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-sid", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
select_track("sid", "sub", "Select a subtitle:", "No available subtitles.")
end)
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-secondary-sid", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
select_track("secondary-sid", "sub", "Select a secondary subtitle:",
"No available subtitles.")
end)
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-aid", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
select_track("aid", "audio", "Select an audio track:",
"No available audio tracks.")
end)
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-vid", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
select_track("vid", "video", "Select a video track:",
"No available video tracks.")
end)
select.lua: hide the hour when it's 0 Omit the hour in the chapter and subtitle line selectors when the file is shorter than an hour.
2024-05-30 09:41:44 +02:00
local function format_time(t, duration)
select.lua: simplify the time formatting function The C version of time formatting function has been exposed to lua, so why not use it, `osc.lua` and `stats.lua` are already using it.
2025-03-31 00:17:27 +08:00
local fmt = math.max(t, duration) >= 60 * 60 and "%H:%M:%S" or "%M:%S"
return mp.format_time(t, fmt)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
end
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-chapter", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local chapters = {}
local default_item = mp.get_property_native("chapter")
if default_item == nil then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning("No available chapters.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
select.lua: hide the hour when it's 0 Omit the hour in the chapter and subtitle line selectors when the file is shorter than an hour.
2024-05-30 09:41:44 +02:00
local duration = mp.get_property_native("duration", math.huge)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
for i, chapter in ipairs(mp.get_property_native("chapter-list")) do
select.lua: hide the hour when it's 0 Omit the hour in the chapter and subtitle line selectors when the file is shorter than an hour.
2024-05-30 09:41:44 +02:00
chapters[i] = format_time(chapter.time, duration) .. " " .. chapter.title
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
end
input.select({
prompt = "Select a chapter:",
items = chapters,
select.lua: display chapters when before the first chapter When the first chapter is not at the start of the file but after the current time position, the chapter property is -1, which prevented displaying any chapter. Fixes #16073.
2025-03-18 10:31:49 +01:00
default_item = default_item > -1 and default_item + 1,
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
submit = function (chapter)
mp.set_property("chapter", chapter - 1)
end,
})
end)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local function format_edition(edition)
return edition.title or ("Edition " .. edition.id + 1)
end
select.lua: select editions
2024-11-28 19:03:08 +01:00
mp.add_key_binding(nil, "select-edition", function ()
select.lua: abort edition selection when there's only 1 MKVs have 1 edition by default so don't show an empty edition selection in that case.
2024-12-12 22:57:23 +01:00
local edition_list = mp.get_property_native("edition-list")
select.lua: select editions
2024-11-28 19:03:08 +01:00
select.lua: fix select-edition crash on non-MKVs In files other than MKVs edition-list is an empty table, not nil. It is current-edition that is nil. However nil still needs to be checked to not crash with mpv --idle.
2024-12-31 10:08:18 +01:00
if edition_list == nil or #edition_list < 2 then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning("No available editions.")
select.lua: select editions
2024-11-28 19:03:08 +01:00
return
end
select.lua: abort edition selection when there's only 1 MKVs have 1 edition by default so don't show an empty edition selection in that case.
2024-12-12 22:57:23 +01:00
local editions = {}
select.lua: display editions when before the first edition When the first edition is not at the start of the file but after the current time position, the current-edition property is -1, which prevented displaying any edition. Fixes https://github.com/mpv-player/mpv/issues/16073#issuecomment-2787316609
2025-04-08 20:26:26 +02:00
local default_item = mp.get_property_native("current-edition")
select.lua: abort edition selection when there's only 1 MKVs have 1 edition by default so don't show an empty edition selection in that case.
2024-12-12 22:57:23 +01:00
for i, edition in ipairs(edition_list) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
editions[i] = format_edition(edition)
select.lua: select editions
2024-11-28 19:03:08 +01:00
end
input.select({
prompt = "Select an edition:",
items = editions,
select.lua: display editions when before the first edition When the first edition is not at the start of the file but after the current time position, the current-edition property is -1, which prevented displaying any edition. Fixes https://github.com/mpv-player/mpv/issues/16073#issuecomment-2787316609
2025-04-08 20:26:26 +02:00
default_item = default_item > -1 and default_item + 1,
select.lua: select editions
2024-11-28 19:03:08 +01:00
submit = function (edition)
mp.set_property("edition", edition - 1)
end,
})
end)
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-subtitle-line", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local sub = mp.get_property_native("current-tracks/sub")
if sub == nil then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning("No subtitle is loaded.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
select.lua: support extracting ytdl_hook subtitles They don't work because they have EDL URLs, but we can attempt to extract their real URLs.
2024-05-31 15:52:51 +02:00
if sub.external and sub["external-filename"]:find("^edl://") then
sub["external-filename"] = sub["external-filename"]:match('https?://.*')
or sub["external-filename"]
end
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local r = mp.command_native({
name = "subprocess",
capture_stdout = true,
args = sub.external
select.lua: allow ffmpeg to print errors if it fails Also don't print subprocess result to OSD, as it is not comprehensible.
2024-05-13 15:27:07 +02:00
and {"ffmpeg", "-loglevel", "error", "-i", sub["external-filename"],
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
"-f", "lrc", "-map_metadata", "-1", "-fflags", "+bitexact", "-"}
select.lua: allow ffmpeg to print errors if it fails Also don't print subprocess result to OSD, as it is not comprehensible.
2024-05-13 15:27:07 +02:00
or {"ffmpeg", "-loglevel", "error", "-i", mp.get_property("path"),
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
"-map", "s:" .. sub["id"] - 1, "-f", "lrc", "-map_metadata",
"-1", "-fflags", "+bitexact", "-"}
})
select.lua: allow ffmpeg to print errors if it fails Also don't print subprocess result to OSD, as it is not comprehensible.
2024-05-13 15:27:07 +02:00
if r.error_string == "init" then
show_error("Failed to extract subtitles: ffmpeg not found.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
select.lua: allow ffmpeg to print errors if it fails Also don't print subprocess result to OSD, as it is not comprehensible.
2024-05-13 15:27:07 +02:00
elseif r.status ~= 0 then
show_error("Failed to extract subtitles.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
local sub_lines = {}
select.lua: preselect the correct sub line with duration >= 100 minutes ffmpeg outputs timestamps like '100:00.00' in LRCs instead of adding hours, and timestamps like '100:00' are < '10:00', so since these strings are being compared, if there is no current subtitle line, there are subtitle lines at >= 100 minutes, and time-pos is between 10 minutes and 100 minutes, one of the last subtitle lines gets preselected. Fix this by converting the timestamps to numbers before comparing them. Also simplify the logic by merging the 2 loops to determine the default line, and reformat the timestamps by adding hours to not print minutes > 60 in the selector, and by removing the hundredths of seconds. This requires storing the accurate timestamps in a table to seek to them on submit.
2024-05-30 05:21:01 +02:00
local sub_times = {}
select.lua: preselect the previous sub line without a current line
2024-05-13 20:28:44 +02:00
local default_item
select.lua: consider --sub-delay for the subtitle line selector Preselect and seek to the correct subtitle line when there is a sub-delay. Also slightly increase the offset without a video track else it occasionally doesn't seek to the selected line with non-0 sub-delay and no video. This now uses the same offset as sub/sd.h.
2024-06-16 21:45:47 +02:00
local delay = mp.get_property_native("sub-delay")
local time_pos = mp.get_property_native("time-pos") - delay
select.lua: hide the hour when it's 0 Omit the hour in the chapter and subtitle line selectors when the file is shorter than an hour.
2024-05-30 09:41:44 +02:00
local duration = mp.get_property_native("duration", math.huge)
select.lua: refactor subtitle parse Avoid repeated display of the same content at the same subtitle time Keep blank lines for both lrc and srt formats
2025-07-06 22:03:11 +08:00
local sub_content = {}
-- Strip HTML and ASS tags and process subtitles
for line in r.stdout:gmatch("[^\n]+") do
-- Clean up tags
local sub_line = line:gsub("<.->", "") -- Strip HTML tags
:gsub("\\h+", " ") -- Replace '\h' tag
:gsub("{[\\=].-}", "") -- Remove ASS formatting
:gsub(".-]", "", 1) -- Remove time info prefix
:gsub("^%s*(.-)%s*$", "%1") -- Strip whitespace
:gsub("^m%s[mbl%s%-%d%.]+$", "") -- Remove graphics code
select.lua: preserve empty LRC lines Subtitle extraction preserves empty lines in LRC subtitles because they are useful for separating verses and choruses. 036fae317c changed their sub codec from subrip to text, so update select.lua accordingly.
2025-12-26 16:01:05 +01:00
if sub.codec == "text" or (sub_line ~= "" and sub_line:match("^%s+$") == nil) then
select.lua: refactor subtitle parse Avoid repeated display of the same content at the same subtitle time Keep blank lines for both lrc and srt formats
2025-07-06 22:03:11 +08:00
local sub_time = line:match("%d+") * 60 + line:match(":([%d%.]*)")
local time_seconds = math.floor(sub_time)
sub_content[time_seconds] = sub_content[time_seconds] or {}
sub_content[time_seconds][sub_line] = true
end
end
-- Process all timestamps and content into selectable subtitle list
for time_seconds, contents in pairs(sub_content) do
for sub_line in pairs(contents) do
sub_times[#sub_times + 1] = time_seconds
sub_lines[#sub_lines + 1] = format_time(time_seconds, duration) .. " " .. sub_line
end
end
-- Generate time -> subtitle mapping
local time_to_lines = {}
for i = 1, #sub_times do
local time = sub_times[i]
local line = sub_lines[i]
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
select.lua: refactor subtitle parse Avoid repeated display of the same content at the same subtitle time Keep blank lines for both lrc and srt formats
2025-07-06 22:03:11 +08:00
if not time_to_lines[time] then
time_to_lines[time] = {}
end
table.insert(time_to_lines[time], line)
end
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
select.lua: refactor subtitle parse Avoid repeated display of the same content at the same subtitle time Keep blank lines for both lrc and srt formats
2025-07-06 22:03:11 +08:00
-- Sort by timestamp
local sorted_sub_times = {}
for i = 1, #sub_times do
sorted_sub_times[i] = sub_times[i]
end
table.sort(sorted_sub_times)
-- Use a helper table to avoid duplicates
local added_times = {}
-- Rebuild sub_lines and sub_times based on the sorted timestamps
local sorted_sub_lines = {}
for _, sub_time in ipairs(sorted_sub_times) do
-- Iterate over all subtitle content for this timestamp
if not added_times[sub_time] then
added_times[sub_time] = true
for _, line in ipairs(time_to_lines[sub_time]) do
table.insert(sorted_sub_lines, line)
end
end
end
-- Use the sorted subtitle list
sub_lines = sorted_sub_lines
sub_times = sorted_sub_times
-- Get the default item (last subtitle before current time position)
for i, sub_time in ipairs(sub_times) do
if sub_time <= time_pos then
default_item = i
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
end
end
input.select({
prompt = "Select a line to seek to:",
items = sub_lines,
default_item = default_item,
submit = function (index)
select.lua: seek to the currect subtitle line when paused without video Add an offset to sub seek correctly like in b35e34ae2f. The extra 0.01 offset apparently isn't necessary in this case.
2024-05-30 05:29:47 +02:00
-- Add an offset to seek to the correct line while paused without a
-- video track.
select.lua: consider --sub-delay for the subtitle line selector Preselect and seek to the correct subtitle line when there is a sub-delay. Also slightly increase the offset without a video track else it occasionally doesn't seek to the selected line with non-0 sub-delay and no video. This now uses the same offset as sub/sd.h.
2024-06-16 21:45:47 +02:00
if mp.get_property_native("current-tracks/video/image") ~= false then
delay = delay + 0.1
end
mp.commandv("seek", sub_times[index] + delay, "absolute")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
end,
})
end)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local function format_audio_device(device)
return device.name .. " (" .. device.description .. ")"
end
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "select-audio-device", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local devices = mp.get_property_native("audio-device-list")
local items = {}
-- This is only useful if an --audio-device has been explicitly set,
-- otherwise its value is just auto and there is no current-audio-device
-- property.
local selected_device = mp.get_property("audio-device")
select.lua: don't needlessly initialize default_item
2024-05-13 20:32:48 +02:00
local default_item
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
if #devices == 0 then
select.lua: use mp.msg.warn for unavailable messages
2024-12-10 23:09:02 +01:00
show_warning("No available audio devices.")
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
return
end
for i, device in ipairs(devices) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
items[i] = format_audio_device(device)
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
if device.name == selected_device then
default_item = i
end
end
input.select({
prompt = "Select an audio device:",
items = items,
default_item = default_item,
submit = function (id)
mp.set_property("audio-device", devices[id].name)
end,
})
end)
select.lua: select from the watch history with g-h Implement selection of the entries in the watch history. The last entry in the selector deletes the history file.
2025-01-26 08:42:58 +01:00
local function format_history_entry(entry)
local status
status, entry.time = pcall(os.date, options.history_date_format, entry.time)
if not status then
mp.msg.warn(entry.time)
end
local item = "(" .. entry.time .. ") "
if entry.title then
return item .. entry.title .. " (" .. entry.path .. ")"
end
if entry.path:find("://") then
return item .. entry.path
end
local directory, filename = utils.split_path(entry.path)
return item .. filename .. " (" .. directory .. ")"
end
mp.add_key_binding(nil, "select-watch-history", function ()
local history_file_path = mp.command_native(
{"expand-path", mp.get_property("watch-history-path")})
local history_file, error_message = io.open(history_file_path)
if not history_file then
show_warning(mp.get_property_native("save-watch-history")
and error_message
select.lua: change the --save-watch-history warning text The current warning was fine when you select history directly, but giving more information can be useful when you happen to see it by right clicking the title without prior information. Fixes https://github.com/mpv-player/mpv/pull/15655#discussion_r1948053973
2025-02-09 12:26:34 +01:00
or "Enable --save-watch-history to jump to recently played files.")
select.lua: select from the watch history with g-h Implement selection of the entries in the watch history. The last entry in the selector deletes the history file.
2025-01-26 08:42:58 +01:00
return
end
local all_entries = {}
local line_num = 1
for line in history_file:lines() do
local entry = utils.parse_json(line)
if entry and entry.path then
all_entries[#all_entries + 1] = entry
else
mp.msg.warn(history_file_path .. ": Parse error at line " .. line_num)
end
line_num = line_num + 1
end
history_file:close()
local entries = {}
local items = {}
local seen = {}
for i = #all_entries, 1, -1 do
local entry = all_entries[i]
if not seen[entry.path] or not options.hide_history_duplicates then
seen[entry.path] = true
entries[#entries + 1] = entry
items[#items + 1] = format_history_entry(entry)
end
end
items[#items+1] = "Clear history"
input.select({
prompt = "Select a file:",
items = items,
submit = function (i)
if entries[i] then
mp.commandv("loadfile", entries[i].path)
return
end
error_message = select(2, os.remove(history_file_path))
if error_message then
show_error(error_message)
else
mp.osd_message("History cleared.")
end
end,
})
end)
select.lua: select files with watch later files with g-w Implement selection of files to resume playing from watch later config files. Requires --write-filename-in-watch-later-config.
2024-12-31 10:26:10 +01:00
mp.add_key_binding(nil, "select-watch-later", function ()
local watch_later_dir = mp.get_property("current-watch-later-dir")
if not watch_later_dir then
show_warning("No watch later files found.")
return
end
local watch_later_files = {}
for i, file in ipairs(utils.readdir(watch_later_dir, "files") or {}) do
watch_later_files[i] = watch_later_dir .. "/" .. file
end
if #watch_later_files == 0 then
show_warning("No watch later files found.")
return
end
local files = {}
for _, watch_later_file in pairs(watch_later_files) do
local file_handle = io.open(watch_later_file)
if file_handle then
local line = file_handle:read()
if line and line ~= "# redirect entry" and line:find("^#") then
files[#files + 1] = {line:sub(3), utils.file_info(watch_later_file).mtime}
end
file_handle:close()
end
end
if #files == 0 then
show_warning(mp.get_property_native("write-filename-in-watch-later-config")
and "No watch later files found."
or "Enable --write-filename-in-watch-later-config to select recent files.")
return
end
table.sort(files, function (i, j)
return i[2] > j[2]
end)
local items = {}
for i, file in ipairs(files) do
items[i] = os.date("(%Y-%m-%d) ", file[2]) .. file[1]
end
input.select({
prompt = "Select a file:",
items = items,
submit = function (i)
mp.commandv("loadfile", files[i][1])
end,
})
end)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local function get_active_bindings()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local bindings = {}
for _, binding in pairs(mp.get_property_native("input-bindings")) do
if binding.priority >= 0 and (
bindings[binding.key] == nil or
(bindings[binding.key].is_weak and not binding.is_weak) or
(binding.is_weak == bindings[binding.key].is_weak and
binding.priority > bindings[binding.key].priority)
select.lua: skip key bindings of forced input sections Avoid showing forced key bindings by modal scripts that temporarily overwrite keybindings, like console and stats. These have section input_forced_$scriptName. Unfortunately this skips all keybindings added with mp.add_forced_key_binding even if you may want to show them. Also skip the OSC sections "input" and "window-controls"; these sections are not called input_forced_osc because the OSC uses mp.enable_key_bindings() directly instead of mp.add_key_binding(). This mainly benefits the shortcuts in the context menu that the next commit will add, but is also useful select/select-binding.
2026-01-25 16:06:36 +01:00
) and not binding.section:find("^input_forced_")
-- OSC sections
and binding.section ~= "input"
and binding.section ~= "window-controls" then
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
bindings[binding.key] = binding
end
end
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
return bindings
end
mp.add_key_binding(nil, "select-binding", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
local items = {}
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
for _, binding in pairs(get_active_bindings()) do
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
if binding.cmd ~= "ignore" then
items[#items + 1] = binding.key .. " " .. binding.cmd
end
end
table.sort(items)
input.select({
prompt = "Select a binding:",
items = items,
submit = function (i)
mp.command(items[i]:gsub("^.- ", ""))
end,
})
end)
local properties = {}
local function add_property(property, value)
value = value or mp.get_property_native(property)
if type(value) == "table" and next(value) then
for key, val in pairs(value) do
add_property(property .. "/" .. key, val)
end
else
properties[#properties + 1] = property .. ": " .. utils.to_string(value)
end
end
select.lua: don't use add_forced_key_binding There's no advantage in using the forced version here. It is a leftover from when this was an external script and forced was necessary to bind key sequences reliably until 3f83671f20.
2024-09-17 11:34:56 +02:00
mp.add_key_binding(nil, "show-properties", function ()
select.lua: add this script This adds script messages to select playlist entries, tracks, chapters, subtitle lines, bindings and properties using the newly introduced mp.input.select(). This fully closes #13964.
2024-05-12 21:57:56 +02:00
properties = {}
-- Don't log errors for renamed and removed properties.
local msg_level_backup = mp.get_property("msg-level")
mp.set_property("msg-level", msg_level_backup == "" and "cplayer=no"
or msg_level_backup .. ",cplayer=no")
for _, property in pairs(mp.get_property_native("property-list")) do
add_property(property)
end
mp.set_property("msg-level", msg_level_backup)
add_property("current-tracks/audio")
add_property("current-tracks/video")
add_property("current-tracks/sub")
add_property("current-tracks/sub2")
table.sort(properties)
input.select({
prompt = "Inspect a property:",
items = properties,
submit = function (i)
if mp.get_property_native("vo-configured") then
mp.commandv("expand-properties", "show-text",
(#properties[i] > 100 and
"${osd-ass-cc/0}{\\fs9}${osd-ass-cc/1}" or "") ..
"$>" .. properties[i], 20000)
else
mp.msg.info(properties[i])
end
end,
})
end)
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
select.lua: add edit-config-file and edit-input-conf Add 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.
2025-07-26 15:49:42 +02:00
local function system_open(path)
local args
if platform == "windows" then
args = {"rundll32", "url.dll,FileProtocolHandler", path}
elseif platform == "darwin" then
args = {"open", path}
else
args = {"gio", "open", path}
end
mp.commandv("run", unpack(args))
end
local function edit_config_file(filename)
if not mp.get_property_bool("config") then
show_warning("Editing config files with --no-config is not supported.")
return
end
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:close()
end
system_open(path)
end
mp.add_key_binding(nil, "edit-config-file", function ()
edit_config_file("mpv.conf")
end)
mp.add_key_binding(nil, "edit-input-conf", function ()
edit_config_file("input.conf")
end)
select.lua: add online documentation menu entry
2025-07-26 16:51:05 +02:00
mp.add_key_binding(nil, "open-docs", function ()
system_open("https://mpv.io/manual/")
end)
select.lua: link to mpv's IRC channel in the menu Add a menu entry that opens mpv's IRC channel so users can quickly ask support questions.
2026-01-21 09:43:23 +01:00
mp.add_key_binding(nil, "open-chat", function ()
system_open("https://web.libera.chat/#mpv")
end)
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
mp.add_key_binding(nil, "menu", function ()
local sub_track_count = 0
local audio_track_count = 0
local video_track_count = 0
local text_sub_selected = false
local is_disc = mp.get_property("current-demuxer") == "disc"
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local image_sub_codecs = to_map({"dvb_subtitle", "dvd_subtitle", "hdmv_pgs_subtitle"})
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
for _, track in pairs(mp.get_property_native("track-list")) do
if track.type == "sub" then
sub_track_count = sub_track_count + 1
if track["main-selection"] == 0 and not image_sub_codecs[track.codec] then
text_sub_selected = true
end
elseif track.type == "audio" then
audio_track_count = audio_track_count + 1
elseif track.type == "video" then
video_track_count = video_track_count + 1
end
end
local menu = {
{"Subtitles", "script-binding select/select-sid", sub_track_count > 0},
{"Secondary subtitles", "script-binding select/select-secondary-sid", sub_track_count > 1},
{"Subtitle lines", "script-binding select/select-subtitle-line", text_sub_selected},
{"Audio tracks", "script-binding select/select-aid", audio_track_count > 1},
{"Video tracks", "script-binding select/select-vid", video_track_count > 1},
{"Playlist", "script-binding select/select-playlist",
mp.get_property_native("playlist-count") > 1},
{"Chapters", "script-binding select/select-chapter", mp.get_property("chapter")},
{is_disc and "Titles" or "Editions", "script-binding select/select-edition",
mp.get_property_native("edition-list/count", 0) > 1},
{"Audio devices", "script-binding select/select-audio-device", audio_track_count > 0},
{"Key bindings", "script-binding select/select-binding", true},
{"History", "script-binding select/select-watch-history", true},
{"Watch later", "script-binding select/select-watch-later", true},
select.lua: rename some menus with proper name
2025-09-24 14:01:35 +08:00
{"Playback statistics", "script-binding stats/display-page-1-toggle", true},
select.lua: don't go beyond the max line length Fixes 7be6095c23.
2025-10-10 08:40:18 +02:00
{"File information", "script-binding stats/display-page-5-toggle",
mp.get_property("filename")},
select.lua: add edit-config-file and edit-input-conf Add 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.
2025-07-26 15:49:42 +02:00
{"Edit config file", "script-binding select/edit-config-file", true},
{"Edit key bindings", "script-binding select/edit-input-conf", true},
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
{"Help", "script-binding stats/display-page-4-toggle", true},
select.lua: add online documentation menu entry
2025-07-26 16:51:05 +02:00
{"Online documentation", "script-binding select/open-docs", true},
select.lua: link to mpv's IRC channel in the menu Add a menu entry that opens mpv's IRC channel so users can quickly ask support questions.
2026-01-21 09:43:23 +01:00
{"Support", "script-binding select/open-chat", true},
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
}
local labels = {}
local commands = {}
for _, entry in ipairs(menu) do
if entry[3] then
labels[#labels + 1] = entry[1]
commands[#commands + 1] = entry[2]
end
end
input.select({
items = labels,
select.lua: don't quickly close and reopen the menu Use the new keep_open flag to avoid flicker when opening submenus.
2025-02-23 15:42:48 +01:00
keep_open = true,
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
submit = function (i)
mp.command(commands[i])
select.lua: don't quickly close and reopen the menu Use the new keep_open flag to avoid flicker when opening submenus.
2025-02-23 15:42:48 +01:00
select.lua: add edit-config-file and edit-input-conf Add 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.
2025-07-26 15:49:42 +02:00
if not commands[i]:find("^script%-binding select/select") then
select.lua: don't quickly close and reopen the menu Use the new keep_open flag to avoid flicker when opening submenus.
2025-02-23 15:42:48 +01:00
input.terminate()
end
select.lua: add a miscellaneous menu
2025-01-08 11:56:13 +01:00
end,
})
end)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local menu = {} -- contains wrappers of menu_data's items
local menu_data = {}
local observed_properties = {}
local property_cache = {}
local active_bindings = {}
local property_set = {}
local property_items = {}
local have_dirty_items = false
local current_item
local function on_property_change(name, value)
property_cache[name] = value
if property_items[name] then
for item, _ in pairs(property_items[name]) do
item.dirty = true
end
have_dirty_items = true
end
end
select.lua: update the playlist submenu after playlist-move Observing playlist-pos and playlist-count is not enough to update it after playlist-move, but we can observe any playlist property with type none to get notified of every MP_EVENT_CHANGE_PLAYLIST, even if the property has not changed. This is similar to the mp.observe_property("vsync-jitter", "none", recorder) hack used by stats.lua to replicate the deprecated tick event. Fixes https://github.com/mpv-player/mpv/pull/16816#discussion_r2727498518
2026-01-28 15:07:26 +01:00
local none_getters = {
-- Only retrieve playlist when playlist-count is not huge to not kill
-- performance. playlist is observed with type none to receive every
-- MP_EVENT_CHANGE_PLAYLIST.
playlist = function ()
if mp.get_property_native("playlist-count") < 100 then
return mp.get_property_native("playlist")
end
end,
}
local function on_none_property_change(name)
on_property_change(name, none_getters[name]())
end
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
function _G.get(name, default)
if not observed_properties[name] then
select.lua: update the playlist submenu after playlist-move Observing playlist-pos and playlist-count is not enough to update it after playlist-move, but we can observe any playlist property with type none to get notified of every MP_EVENT_CHANGE_PLAYLIST, even if the property has not changed. This is similar to the mp.observe_property("vsync-jitter", "none", recorder) hack used by stats.lua to replicate the deprecated tick event. Fixes https://github.com/mpv-player/mpv/pull/16816#discussion_r2727498518
2026-01-28 15:07:26 +01:00
local result, err = (none_getters[name] or mp.get_property_native)(name)
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
if err == "property not found" and not property_set(name:match("^([^/]+)")) then
mp.msg.error("Property '" .. name .. "' was not found.")
return default
end
observed_properties[name] = true
property_cache[name] = result
select.lua: update the playlist submenu after playlist-move Observing playlist-pos and playlist-count is not enough to update it after playlist-move, but we can observe any playlist property with type none to get notified of every MP_EVENT_CHANGE_PLAYLIST, even if the property has not changed. This is similar to the mp.observe_property("vsync-jitter", "none", recorder) hack used by stats.lua to replicate the deprecated tick event. Fixes https://github.com/mpv-player/mpv/pull/16816#discussion_r2727498518
2026-01-28 15:07:26 +01:00
if none_getters[name] then
mp.observe_property(name, "none", on_none_property_change)
else
mp.observe_property(name, "native", on_property_change)
end
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
end
if current_item then
if not property_items[name] then
property_items[name] = {}
end
property_items[name][current_item] = true
end
if property_cache[name] == nil then
return default
end
return property_cache[name]
end
local function magic_get(name)
return get(name:gsub("_", "-"), nil)
end
local evil_magic = {}
setmetatable(evil_magic, {
__index = function(_, key)
if _G[key] ~= nil then
return _G[key]
end
return magic_get(key)
end,
})
_G.p = {}
setmetatable(p, {
__index = function(_, key)
return magic_get(key)
end,
})
local function compile_condition(chunk, chunkname)
chunk = "return " .. chunk
chunkname = 'Menu entry "' .. chunkname .. '"'
local compiled_chunk, err
-- luacheck: push
-- luacheck: ignore setfenv loadstring
if setfenv then -- lua 5.1
compiled_chunk, err = loadstring(chunk, chunkname)
if compiled_chunk then
setfenv(compiled_chunk, evil_magic)
end
else -- lua 5.2
compiled_chunk, err = load(chunk, chunkname, "t", evil_magic)
end
-- luacheck: pop
if not compiled_chunk then
mp.msg.error(chunkname .. " : " .. err)
compiled_chunk = function() return false end
end
return compiled_chunk
end
local function evaluate_condition(chunk, chunkname)
local status, result
status, result = pcall(chunk)
if not status then
mp.msg.verbose(chunkname .. " error on evaluating: " .. result)
return false
end
return not not result
end
local function toggle_state(states, state, add)
for i, existing_state in ipairs(states) do
if existing_state == state then
if add then
return
end
table.remove(states, i)
end
end
if add then
states[#states + 1] = state
end
end
local function on_idle()
if not have_dirty_items then
return
end
have_dirty_items = false
for _, item in pairs(menu) do
if item.dirty then
item:update()
item.dirty = false
end
end
mp.set_property_native("menu-data", menu_data)
end
select.lua: quote and escape string arguments in menu item commands try to define a `[foo \ "bar"]` profile in mpv.conf, the command to apply it in context-menu is `apply-profile foo \ "bar"`, which is obviously incorrect, the correct command should be `apply-profile "foo \\ \"bar\""`. for string arguments that may contain spaces or some special characters, we need to quote and escape them in JSON-style, fortunately, `utils.format_json` can do this very well.
2026-02-03 16:31:54 +08:00
-- quote string and escape it in JSON-style
local function quote(str)
return utils.format_json(str or "")
end
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local function clamp_submenu(submenu, max, cmd)
if #submenu <= max then
return submenu
end
local mid = 1
for i, item in pairs(submenu) do
if item.state then
mid = i
break
end
end
local offset = math.floor(max / 2)
local first = mid + 1 - offset
local last = mid + offset
if first < 1 then
first = 1
last = max
end
if last > #submenu then
first = math.max(#submenu - max + 1, 1)
last = #submenu
end
local clamped = {}
if first > 1 then
clamped[1] = {
title = "…",
cmd = cmd,
shortcut = first - 1 .. " more",
}
end
for i = first, last do
clamped[#clamped + 1] = submenu[i]
end
if last < #submenu then
clamped[#clamped + 1] = {
title = "…",
cmd = cmd,
shortcut = #submenu - last .. " more",
}
end
return clamped
end
local function playlist()
select.lua: always observe --osd-playlist-entry The playlist submenu does not update in this edge case: - Have a playlist-count > 99 on the first vo-configured. This makes playlist() return before observing --osd-playlist-entry. - Remove playlist entries until the count is < 100 - Change --osd-playlist-entry - Show the playlist submenu before changing the playlist
2026-01-30 10:44:07 +01:00
local show = get("osd-playlist-entry")
select.lua: update the playlist submenu after playlist-move Observing playlist-pos and playlist-count is not enough to update it after playlist-move, but we can observe any playlist property with type none to get notified of every MP_EVENT_CHANGE_PLAYLIST, even if the property has not changed. This is similar to the mp.observe_property("vsync-jitter", "none", recorder) hack used by stats.lua to replicate the deprecated tick event. Fixes https://github.com/mpv-player/mpv/pull/16816#discussion_r2727498518
2026-01-28 15:07:26 +01:00
if not get("playlist") then
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
return
end
local items = {}
select.lua: update the playlist submenu after playlist-move Observing playlist-pos and playlist-count is not enough to update it after playlist-move, but we can observe any playlist property with type none to get notified of every MP_EVENT_CHANGE_PLAYLIST, even if the property has not changed. This is similar to the mp.observe_property("vsync-jitter", "none", recorder) hack used by stats.lua to replicate the deprecated tick event. Fixes https://github.com/mpv-player/mpv/pull/16816#discussion_r2727498518
2026-01-28 15:07:26 +01:00
for i, entry in ipairs(get("playlist")) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
items[i] = {
title = format_playlist_entry(entry, show):gsub("&", "&&"),
cmd = "playlist-play-index " .. (i - 1)
}
if entry.current then
items[i].state = {"checked"}
end
end
return clamp_submenu(items, options.max_playlist_items,
"script-binding select/select-playlist")
end
local function tracks(property, track_type)
local items = {}
select.lua: sort the track submenu track-list doesn't necessarily return tracks sorted by type so we need to sort them ourselves.
2026-02-12 09:31:57 +01:00
local track_list = get("track-list")
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
local last_type
select.lua: sort the track submenu track-list doesn't necessarily return tracks sorted by type so we need to sort them ourselves.
2026-02-12 09:31:57 +01:00
local positions = {video = 0, audio = 1, sub = 2}
table.sort(track_list, function (i, j)
if i.type ~= j.type then
return positions[i.type] < positions[j.type]
end
return i.id < j.id
end)
for _, track in ipairs(track_list) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
if not track_type or track.type == track_type then
if last_type and track.type ~= last_type then
items[#items + 1] = { type = "separator" }
end
last_type = track.type
items[#items + 1] = {
title = (track_type and "" or format_track_type(track)) ..
-- Remove the circles since checkmarks are already added.
format_track(track):sub(5):gsub("&", "&&"),
cmd = "set " .. (property or track.type) .. " " .. track.id,
}
if track.selected then
items[#items].cmd = "set " .. (property or track.type) .. " no"
items[#items].state = {"checked"}
end
end
end
return items
end
local function chapters()
local items = {}
local current_chapter = get("chapter", -1)
local duration = mp.get_property_native("duration", math.huge)
for i, chapter in ipairs(get("chapter-list")) do
items[i] = {
title = chapter.title:gsub("&", "&&"),
cmd = "set chapter " .. (i - 1),
shortcut = format_time(chapter.time, duration),
}
if i == current_chapter + 1 then
items[i].state = {"checked"}
end
end
return items
end
local function editions()
local items = {}
local current_edition = get("current-edition", -1)
for i, edition in ipairs(get("edition-list", {})) do
items[i] = {
title = format_edition(edition):gsub("&", "&&"),
cmd = "set edition " .. (i - 1),
}
if i == current_edition + 1 then
items[i].state = {"checked"}
end
end
return items
end
local function audio_devices()
local items = {}
local selected_device = get("audio-device")
for i, device in ipairs(get("audio-device-list")) do
items[i] = {
title = format_audio_device(device):gsub("&", "&&"),
select.lua: quote and escape string arguments in menu item commands try to define a `[foo \ "bar"]` profile in mpv.conf, the command to apply it in context-menu is `apply-profile foo \ "bar"`, which is obviously incorrect, the correct command should be `apply-profile "foo \\ \"bar\""`. for string arguments that may contain spaces or some special characters, we need to quote and escape them in JSON-style, fortunately, `utils.format_json` can do this very well.
2026-02-03 16:31:54 +08:00
cmd = "set audio-device " .. quote(device.name),
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
}
if device.name == selected_device then
items[i].state = {"checked"}
end
end
return items
end
local function profiles()
local builtin_profiles = to_map({
"box", "builtin-pseudo-gui", "default", "encoding", "fast", "gpu-hq",
"high-quality", "libmpv", "low-latency", "osd-box", "pseudo-gui",
"sub-box", "sw-fast"
})
local user_profiles = {}
select.lua: fix crash on user_profiles sort The list is filtered, so we need to not use index of the input. Fixes: Lua error: attempt to compare string with nil
2026-03-08 08:55:01 +01:00
for _, profile in ipairs(get("profile-list")) do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
if not builtin_profiles[profile.name] then
select.lua: fix crash on user_profiles sort The list is filtered, so we need to not use index of the input. Fixes: Lua error: attempt to compare string with nil
2026-03-08 08:55:01 +01:00
user_profiles[#user_profiles + 1] = profile.name
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
end
end
table.sort(user_profiles)
local items = {}
for i, profile in ipairs({
"fast", "high-quality", "osd-box", "sub-box", "box",
}) do
items[i] = {
title = profile,
cmd = "apply-profile " .. profile,
}
end
if user_profiles[1] then
items[#items + 1] = { type = "separator" }
end
for _, profile in ipairs(user_profiles) do
items[#items + 1] = {
select.lua: quote and escape string arguments in menu item commands try to define a `[foo \ "bar"]` profile in mpv.conf, the command to apply it in context-menu is `apply-profile foo \ "bar"`, which is obviously incorrect, the correct command should be `apply-profile "foo \\ \"bar\""`. for string arguments that may contain spaces or some special characters, we need to quote and escape them in JSON-style, fortunately, `utils.format_json` can do this very well.
2026-02-03 16:31:54 +08:00
title = profile:gsub("&", "&&"),
cmd = "apply-profile " .. quote(profile),
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
}
end
return items
end
local builtin_submenus = {
["$playlist"] = playlist,
["$tracks"] = function () return tracks() end,
["$video-tracks"] = function () return tracks("video", "video") end,
["$audio-tracks"] = function () return tracks("audio", "audio") end,
["$sub-tracks"] = function () return tracks("sub", "sub") end,
["$secondary-sub-tracks"] = function () return tracks("secondary-sid", "sub") end,
["$chapters"] = chapters,
["$editions"] = editions,
["$audio-devices"] = audio_devices,
["$profiles"] = profiles,
}
local submenu_commands = {
["$playlist"] = "script-binding select/select-playlist",
["$tracks"] = "script-binding select/select-track",
["$video-tracks"] = "script-binding select/select-vid",
["$audio-tracks"] = "script-binding select/select-aid",
["$sub-tracks"] = "script-binding select/select-sid",
["$secondary-sub-tracks"] = "script-binding select/select-secondary-sid",
["$chapters"] = "script-binding select/select-chapter",
["$editions"] = "script-binding select/select-edition",
["$audio-devices"] = "script-binding select/select-audio-device",
}
local function get_shortcut(cmd)
local shortcuts = {}
local uncommon_keys = to_map({
"MBTN_BACK", "MBTN_FORWARD", "POWER", "PLAY", "PAUSE", "PLAYPAUSE",
"PLAYONLY", "PAUSEONLY", "STOP", "FORWARD", "REWIND", "NEXT", "PREV",
"VOLUME_UP", "VOLUME_DOWN", "MUTE", "CLOSE_WIN",
})
for _, binding in pairs(active_bindings) do
if binding.cmd == cmd and not uncommon_keys[binding.key]
and not binding.key:find("KP_") then
shortcuts[#shortcuts + 1] = binding.key
end
end
return table.concat(shortcuts, ",")
end
local function update_builtin_submenu(item)
item.item.submenu = builtin_submenus[item.builtin_submenu]()
-- With huge playlists, make the menu item open the playlist menu
-- instead to not kill performance.
if not item.item.submenu then
item.item.cmd = submenu_commands[item.builtin_submenu]
item.item.type = nil
return
end
item.item.cmd = nil
item.item.type = "submenu"
local min = item.builtin_submenu == "$editions" and 2 or 1
item.item.state = #item.item.submenu < min and {"disabled"} or {}
end
local function update_state(item)
for state, compiled_condition in pairs(item.compiled_conditions) do
toggle_state(item.item.state, state,
evaluate_condition(compiled_condition, item.item.title))
end
end
local function parse_menu_item(line)
local tokens = {}
local separator = "\t+"
for token in line:gmatch("(.-)" .. separator) do
tokens[#tokens + 1] = token
end
tokens[#tokens + 1] = line:gsub(".*" .. separator, "")
if tokens[1] == "" then
return { type = "separator" }
end
local item = {
item = {
title = tokens[1],
state = {},
},
compiled_conditions = {},
}
current_item = item
if builtin_submenus[tokens[2]] then
item.builtin_submenu = tokens[2]
item.item.shortcut = get_shortcut(submenu_commands[item.builtin_submenu])
item.update = update_builtin_submenu
item:update()
return item
end
local state_start = 3
for _, state in pairs({"checked", "disabled", "hidden"}) do
if not tokens[2] or tokens[2]:find("^%s*" .. state .. "=") then
state_start = 2
break
end
end
if state_start == 2 then
item.item.type = "submenu"
item.item.submenu = {}
else
item.item.cmd = tokens[2]
item.item.shortcut = get_shortcut(tokens[2])
end
for i = state_start, #tokens do
local state, condition = tokens[i]:match("(%S-)=(.*)")
if not state then
return false
end
item.compiled_conditions[state] = compile_condition(condition, tokens[1])
if evaluate_condition(item.compiled_conditions[state], tokens[1]) then
table.insert(item.item.state, state)
end
end
item.update = update_state
return item
end
local function get_menu_conf()
local menu_conf
local file_handle = io.open(mp.command_native({"expand-path", options.menu_conf_path}))
if file_handle then
menu_conf = file_handle:read("*a")
file_handle:close()
else
menu_conf = mp.get_property("default-menu")
end
local lines = {}
select.lua: handle carriage returns in menu.conf Fixes https://github.com/mpv-player/mpv/pull/16816#issuecomment-3804029038
2026-01-31 13:07:37 +01:00
for line in menu_conf:gmatch("(.-)\r?\n") do
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
lines[#lines + 1] = line
end
return lines
end
local function parse_menu_conf(_, vo_configured)
if not vo_configured then
return
end
mp.unobserve_property(parse_menu_conf)
property_set = to_map(mp.get_property_native("property-list"))
active_bindings = get_active_bindings()
local lines = get_menu_conf()
local last_leading_whitespace = ""
local menus_by_depth = { [""] = menu_data }
for i, line in ipairs(lines) do
local leading_whitespace = line:match("^%s*")
local item = parse_menu_item(line:gsub("^%s*", ""))
if not item then
show_error("menu.conf is malformed: " .. line ..
" contains tabs not used as separators")
return
end
if item.item then
menu[#menu + 1] = item
item = item.item
end
if #leading_whitespace > #last_leading_whitespace then
local last_menu = menus_by_depth[last_leading_whitespace]
if not last_menu[#last_menu].submenu then
show_error("menu.conf is malformed: " .. line ..
" has leading whitespace but no parent menu was defined")
return
end
menus_by_depth[leading_whitespace] = last_menu[#last_menu].submenu
end
if line == "" then
-- Determine the depth of the separator from the next line.
select.lua: handle empty lines at the end of the file Prevent a crash in this case due to lines[i + 1] being nil.
2026-01-31 13:58:26 +01:00
if lines[i + 1] then -- ignore newlines at the end
table.insert(menus_by_depth[lines[i + 1]:match("%s*")], item)
end
select.lua: populate the context menu Make select.lua parse menu.conf on the first vo-configured and fill menu-data with the properties referenced in menu.conf change. This is disabled in the libmpv profile. This is done from select.lua to reuse functions to format the data and retrieve key bindings. There is also a script-binding that opens the correct context menu depending on --load-context-menu. While the context menu is scrollable, for the playlist it is better to start from around the current entry rather than from the beginning, and since menu-data has no way to specify where to start, when there are more than 25 items playlist items this adds … entries that open the scrollable console menu when clicked. input-bindings is parsed to show the shortcuts bound to commands. Since it is not observable, it just uses the bindings from the first time the context menu is opened. Multimedia and numpad keys are also not shown to reduce clutter. The old Context Menu section of the docs is merged in the more detailed context_menu.rst to not repeat the same information.
2025-09-26 20:01:39 +02:00
else
table.insert(menus_by_depth[leading_whitespace], item)
last_leading_whitespace = leading_whitespace
end
end
property_set = nil
active_bindings = nil
current_item = nil
mp.register_idle(on_idle)
end
if options.populate_menu_data then
mp.observe_property("vo-configured", "native", parse_menu_conf)
end
mp.add_key_binding(nil, "context-menu", function (info)
if info.event == "repeat" then
return
end
if not info.is_mouse then
if info.event == "down" or info.event == "press" then
mp.command(mp.get_property_native("load-context-menu")
and "script-message-to context_menu open"
or "context-menu")
end
elseif mp.get_property_native("load-context-menu") then
mp.commandv("script-message-to", "context_menu",
info.event == "down" and "open" or "select")
elseif info.event == (platform == "windows" and "up" or "down") then
mp.command("context-menu")
end
end, { complex = true })
Reference in New Issue Copy Permalink