feat: menu lifecycle and actions API #936
Conversation
|
My For existing scripts, emptying the memo search bar doesn't return to the unfiltered results, it stays on the last search. Icon example from wiki: thumbs_up -> thumb_up This misalignment of long tooltip text can happen when the window is small enough. Could you make long tooltips wrap? And move tooltips to the left, overlapping the menu, when there is not enough space at all. I understand if you're against that 2nd idea, it's just likely to happen in windowed mode with any menu made wide by long info like filenames in memo. I feel like the background of the whole item should still be highlighted when going to an action, just remove its left-side accent. White still communicates what's selected. Have yet to mess with the callback API :^) |
Since the API now also supports tapping into keybinds, menu now takes over a lot of shortcuts so it can forward them. It's the combination of these: local keys = {'mbtn_left', 'mbtn_right', 'up+', 'down+', 'left', 'right', 'enter', 'kp_enter', 'bs', 'tab', 'esc',
'pgup+', 'pgdwn+', 'home', 'end', 'del'}
local modifiers = {nil, 'alt', 'alt+ctrl', 'alt+shift', 'alt+ctrl+shift', 'ctrl', 'ctrl+shift', 'shift'}But I think And I'll look into the rest of the stuff too. |
|
I think I've fixed all above and some more (except the playlist reordering with ctrl+pgup/pgdwn/home/end).
Tooltips shouldn't be so long as to require wrapping. It's like a button label, not a place for long descriptions. And with their current location they should hopefully never hit this need. |
|
I've been using it with the builtin actions for a while, here's what I caught:
[uosc]
[uosc] stack traceback:
[uosc] /home/eva/.config/mpv/scripts/uosc/elements/Menu.lua:857: in function 'search_query_update'
[uosc] /home/eva/.config/mpv/scripts/uosc/elements/Menu.lua:911: in function </home/eva/.config/mpv/scripts/uosc/elements/Menu.lua:899>
[uosc] (...tail calls...)
[uosc] /home/eva/.config/mpv/scripts/uosc/elements/Menu.lua:1130: in function 'fn'
[uosc] /home/eva/.config/mpv/scripts/uosc/elements/Menu.lua:1122: in function 'fn'
[uosc] mp.defaults:207: in function 'fn'
[uosc] mp.defaults:66: in function 'handler'
[uosc] mp.defaults:385: in function 'handler'
[uosc] mp.defaults:515: in function 'call_event_handlers'
[uosc] mp.defaults:557: in function 'dispatch_events'
[uosc] mp.defaults:508: in function <mp.defaults:507>
[uosc] [C]: in ?
[uosc] [C]: in ?
[uosc] Lua error: /home/eva/.config/mpv/scripts/uosc/elements/Menu.lua:857: attempt to index field 'timeout' (a nil value)
|
This still happens, haven't tracked down the reason why the menu closes but something is obviously wrong since |
|
Hm, I can see the confusion. Currently, the It's not send every time menu closes. Let me think about it. Also I think I broke |
|
If something still behaves unexpectedly, let me know. And |
|
That did fix memo, thanks! |
|
Looks like this broke my thingy, and for the life of me i can't get it working. Is it no longer possible to make an local utils = require('mp.utils')
local function toggle_menu()
toggle = not toggle
local json = utils.format_json({
type = 'test_menu',
title = toggle and 'Foo' or 'Bar',
search_style = 'disabled',
items = {
{ title = toggle and 'Lorem 1' or 'Ipsum A', value = 'show-text 111' },
{ title = toggle and 'Ipsum 2' or 'Lorem B', value = 'show-text 222' }
}
})
mp.commandv('script-message-to', 'uosc', toggle and 'open-menu' or 'update-menu', json)
end
mp.add_forced_key_binding('a', 'toggle_menu1', toggle_menu)
mp.add_forced_key_binding('tab', 'toggle_menu2', toggle_menu)
mp.add_forced_key_binding('ctrl+a', 'toggle_menu3', toggle_menu)
My default
And just to make sure… Is this: local utils = require('mp.utils')
mp.add_forced_key_binding('tab', 'toggle_menu', function()
local json = utils.format_json({
type = 'test_menu',
title = 'Foobar',
on_close = {'script-message-to', mp.get_script_name(), 'uosc-cleanup'},
search_style = 'disabled',
items = {{ title = 'Lorem 1', value = 'show-text 111' }}
})
mp.commandv('script-message-to', 'uosc', 'open-menu', json)
end)
mp.register_script_message('uosc-cleanup', function()
mp.msg.info('DEBUG cleanup')
mp.osd_message('DEBUG cleanup')
end)
mp.add_forced_key_binding('ctrl+a', 'close_menu', function()
mp.commandv('script-message-to', 'uosc', 'close-menu')
end)expected to still call |
|
Commit above fixes your use case with
|
Well, that's unfortunate, since my main use case was basically a modified recent.lua script: local o = {
-- Automatically save to log, otherwise only saves when requested
-- you need to bind a save key if you disable it
auto_save = true,
save_bind = "",
-- When automatically saving, skip entries with playback positions
-- past this value, in percent. 100 saves all, around 95 is
-- good for skipping videos that have reached final credits.
auto_save_skip_past = 100,
-- Display only the latest file from each directory
hide_same_dir = false,
-- Runs automatically when --idle
auto_run_idle = true,
-- Write watch later for current file when switching
write_watch_later = true,
-- Display menu bind
display_bind = "tab",
-- Middle click: Select; Right click: Exit;
-- Scroll wheel: Up/Down
mouse_controls = true,
-- Reads from config directory or an absolute path
log_path = "history.log",
-- Date format in the log (see lua date formatting)
date_format = "%d/%m/%y %X",
-- Show file paths instead of media-title
show_paths = false,
--slice long filenames, and how many chars to show
slice_longfilenames = false,
slice_longfilenames_amount = 100,
-- Split paths to only show the file or show the full path
split_paths = true,
-- Font settings
font_scale = 50,
border_size = 0.7,
-- Highlight color in BGR hexadecimal
hi_color = "H46CFFF",
-- Draw ellipsis at start/end denoting ommited entries
ellipsis = false,
--Change maximum number to show items on integrated submenus in uosc or mpv-menu-plugin
list_show_amount = 20,
-- Use uosc menu as default
use_uosc_menu = false,
-- Open default menu by keypress, open uosc menu when holding it (second hold switches to path menu)
double_menu_key = true,
}
(require "mp.options").read_options(o, _, function() end)
local utils = require("mp.utils")
o.log_path = utils.join_path(mp.find_config_file("."), o.log_path)
local cur_title, cur_path
local list_drawn = false
local uosc_available = false
local is_windows = package.config:sub(1,1) == "\\"
function esc_string(str)
return str:gsub("([%p])", "%%%1")
end
function is_protocol(path)
return type(path) == 'string' and path:match('^%a[%a%d-_]+://') ~= nil
end
function normalize(path)
if normalize_path ~= nil then
if normalize_path then
path = mp.command_native({"normalize-path", path})
else
local directory = mp.get_property("working-directory", "")
path = mp.utils.join_path(directory, path:gusb('^%.[\\/]',''))
if is_windows then path = path:gsub("\\", "/") end
end
return path
end
normalize_path = false
local commands = mp.get_property_native("command-list", {})
for _, command in ipairs(commands) do
if command.name == "normalize-path" then
normalize_path = true
break
end
end
return normalize(path)
end
-- from http://lua-users.org/wiki/LuaUnicode
local UTF8_PATTERN = '[%z\1-\127\194-\244][\128-\191]*'
-- return a substring based on utf8 characters
-- like string.sub, but negative index is not supported
local function utf8_sub(s, i, j)
local t = {}
local idx = 1
for match in s:gmatch(UTF8_PATTERN) do
if j and idx > j then break end
if idx >= i then t[#t + 1] = match end
idx = idx + 1
end
return table.concat(t)
end
function split_ext(filename)
local idx = filename:match(".+()%.%w+$")
if idx then
filename = filename:sub(1, idx - 1)
end
return filename
end
function strip_title(str)
if o.slice_longfilenames and str:len() > o.slice_longfilenames_amount + 5 then
str = utf8_sub(str, 1, o.slice_longfilenames_amount) .. "..."
end
return str
end
function get_ext(path)
if is_protocol(path) then
return path:match("^(%a[%w.+-]-)://"):upper()
else
return path:match(".+%.(%w+)$"):upper()
end
end
function get_dir(path)
if is_protocol(path) then
return path
end
local dir, filename = utils.split_path(path)
return dir
end
function get_filename(item)
if is_protocol(item.path) then
return item.title
end
local dir, filename = utils.split_path(item.path)
return filename
end
function get_path()
local path = mp.get_property("path")
local title = mp.get_property("media-title"):gsub("\"", "")
if not path then return end
if is_protocol(path) then
return title, path
else
local path = normalize(path)
return title, path
end
end
function unbind()
if o.mouse_controls then
mp.remove_key_binding("recent-WUP")
mp.remove_key_binding("recent-WDOWN")
mp.remove_key_binding("recent-MMID")
mp.remove_key_binding("recent-MRIGHT")
end
mp.remove_key_binding("recent-UP")
mp.remove_key_binding("recent-DOWN")
mp.remove_key_binding("recent-ENTER")
mp.remove_key_binding("recent-1")
mp.remove_key_binding("recent-2")
mp.remove_key_binding("recent-3")
mp.remove_key_binding("recent-4")
mp.remove_key_binding("recent-5")
mp.remove_key_binding("recent-6")
mp.remove_key_binding("recent-7")
mp.remove_key_binding("recent-8")
mp.remove_key_binding("recent-9")
mp.remove_key_binding("recent-0")
mp.remove_key_binding("recent-ESC")
mp.remove_key_binding("recent-DEL")
mp.set_osd_ass(0, 0, "")
list_drawn = false
end
function read_log(func)
local f = io.open(o.log_path, "r")
if not f then return end
local list = {}
for line in f:lines() do
if not line:match("^%s*$") then
table.insert(list, (func(line)))
end
end
f:close()
return list
end
function read_log_table()
return read_log(function(line)
local t, p
t, p = line:match("^.-\"(.-)\" | (.*)$")
return {title = t, path = p}
end)
end
function table_reverse(table)
local reversed_table = {}
for i = 1, #table do
reversed_table[#table - i + 1] = table[i]
end
return reversed_table
end
function hide_same_dir(content)
local lists = {}
local dir_cache = {}
for i = 1, #content do
local dirname = get_dir(content[#content-i+1].path)
if not dir_cache[dirname] then
table.insert(lists, content[#content-i+1])
end
if dirname ~= "." then
dir_cache[dirname] = true
end
end
return table_reverse(lists)
end
local dyn_menu = {
ready = false,
type = 'submenu',
submenu = {}
}
function update_dyn_menu_items()
local menu = {}
local lists = read_log_table()
if not lists or not lists[1] then
return
end
if o.hide_same_dir then
lists = hide_same_dir(lists)
end
if #lists > o.list_show_amount then
length = o.list_show_amount
else
length = #lists
end
for i = 1, length do
menu[#menu + 1] = {
title = string.format('%s\t%s', o.show_paths and strip_title(split_ext(get_filename(lists[#lists-i+1])))
or strip_title(split_ext(lists[#lists-i+1].title)), get_ext(lists[#lists-i+1].path)),
cmd = string.format("loadfile '%s'", lists[#lists-i+1].path),
}
end
dyn_menu.submenu = menu
mp.commandv('script-message-to', 'dyn_menu', 'update', 'recent', utils.format_json(dyn_menu))
end
-- Write path to log on file end
-- removing duplicates along the way
function write_log(delete)
if not cur_path or (cur_path:match("bd://") or cur_path:match("dvd://")
or cur_path:match("dvb://") or cur_path:match("cdda://")) then
return
end
local content = read_log(function(line)
if line:find(esc_string(cur_path)) then
return nil
else
return line
end
end)
f = io.open(o.log_path, "w+")
if content then
for i=1, #content do
f:write(("%s\n"):format(content[i]))
end
end
if not delete then
f:write(("[%s] \"%s\" | %s\n"):format(os.date(o.date_format), cur_title, cur_path))
end
f:close()
if dyn_menu.ready then
update_dyn_menu_items()
end
end
-- Display list on OSD and terminal
function draw_list(list, start, choice)
local font_scale = o.font_scale * (display_scale or 1)
local msg = string.format("{\\fscx%f}{\\fscy%f}{\\bord%f}",
font_scale, font_scale, o.border_size)
local hi_start = string.format("{\\1c&H%s}", o.hi_color)
local hi_end = "{\\1c&HFFFFFF}"
if o.ellipsis then
if start ~= 0 then
msg = msg.."..."
end
msg = msg.."\\h\\N\\N"
end
local size = #list
for i=1, math.min(10, size-start), 1 do
local key = i % 10
local p
if o.show_paths then
if o.split_paths or is_protocol(list[size-start-i+1].path) then
p = get_filename(list[size-start-i+1])
else
p = list[size-start-i+1].path or ""
end
else
p = list[size-start-i+1].title or list[size-start-i+1].path or ""
end
p = p:gsub("\\", "\\\239\187\191"):gsub("{", "\\{"):gsub("^ ", "\\h")
if i == choice+1 then
msg = msg..hi_start.."("..key..") "..strip_title(p).."\\N\\N"..hi_end
else
msg = msg.."("..key..") "..strip_title(p).."\\N\\N"
end
if not list_drawn then
-- print("("..key..") "..p)
end
end
if o.ellipsis and start+10 < size then
msg = msg .."..."
end
mp.set_osd_ass(0, 0, msg)
end
-- Handle up/down keys
function select(list, start, choice, inc)
choice = choice + inc
if choice < 0 then
choice = choice + 1
start = start + inc
elseif choice >= math.min(#list, 10) then
choice = choice - 1
start = start + inc
end
if start > math.max(#list-10, 0) then
start = start - 1
elseif start < 0 then
start = start + 1
end
draw_list(list, start, choice)
return start, choice
end
-- Delete selected entry from the log
function delete(list, start, choice)
local playing_path = cur_path
cur_path = list[#list-start-choice].path
if not cur_path then
print("Failed to delete")
return
end
write_log(true)
print("Deleted \""..cur_path.."\"")
cur_path = playing_path
end
-- Load file and remove binds
function load(list, start, choice)
unbind()
if start+choice >= #list then return end
if o.write_watch_later then
mp.command("write-watch-later-config")
end
mp.commandv("loadfile", list[#list-start-choice].path, "replace")
end
-- play last played file
function play_last()
local lists = read_log_table()
if not lists or not lists[1] then
return
end
mp.commandv("loadfile", lists[#lists].path, "replace")
end
-- Open the recent submenu for uosc
function open_menu(lists)
local script_name = mp.get_script_name()
local menu = {
type = 'recent_menu',
title = 'Recent',
on_close = {"script-message-to", script_name, "recent-uosc-closed"},
items = { { title = 'Nothing here', value = 'ignore' } },
}
if #lists > o.list_show_amount then
length = o.list_show_amount
else
length = #lists
end
for i = 1, length do
menu.items[i] = {
title = (o.show_paths or uosc_opened) and strip_title(lists[#lists-i+1].path)
or strip_title(lists[#lists-i+1].title),
hint = get_ext(lists[#lists-i+1].path),
value = { "loadfile", lists[#lists-i+1].path, "replace" },
}
end
local json = utils.format_json(menu)
mp.commandv("script-message-to", "uosc", not uosc_menu_opened and "open-menu" or "update-menu", json)
uosc_menu_opened = true
end
-- Display list and add keybinds
function display_list()
if list_drawn then
unbind()
return
end
local list = read_log_table()
if not list or not list[1] then
mp.osd_message("Log empty")
return
end
if o.hide_same_dir then
list = hide_same_dir(list)
end
if not o.use_uosc_menu and uosc_menu_opened then
mp.commandv("script-message-to", mp.get_script_name(), "recent-uosc-closed")
end
if o.use_uosc_menu and uosc_available then
if uosc_menu_opened then mp.commandv('script-message-to', 'uosc', 'close-menu')
mp.commandv("script-message-to", mp.get_script_name(), "recent-uosc-closed")
return
end
open_menu(list)
if o.double_menu_key then uosc_opened = true end
return
end
local choice = 0
local start = 0
draw_list(list, start, choice)
list_drawn = true
mp.add_forced_key_binding("UP", "recent-UP", function()
start, choice = select(list, start, choice, -1)
end, {repeatable=true})
mp.add_forced_key_binding("DOWN", "recent-DOWN", function()
start, choice = select(list, start, choice, 1)
end, {repeatable=true})
mp.add_forced_key_binding("ENTER", "recent-ENTER", function()
load(list, start, choice)
end)
mp.add_forced_key_binding("DEL", "recent-DEL", function()
delete(list, start, choice)
list = read_log_table()
if not list or not list[1] then
unbind()
return
end
start, choice = select(list, start, choice, 0)
end)
if o.mouse_controls then
mp.add_forced_key_binding("WHEEL_UP", "recent-WUP", function()
start, choice = select(list, start, choice, -1)
end)
mp.add_forced_key_binding("WHEEL_DOWN", "recent-WDOWN", function()
start, choice = select(list, start, choice, 1)
end)
mp.add_forced_key_binding("MBTN_MID", "recent-MMID", function()
load(list, start, choice)
end)
mp.add_forced_key_binding("MBTN_RIGHT", "recent-MRIGHT", function()
unbind()
end)
end
mp.add_forced_key_binding("1", "recent-1", function() load(list, start, 0) end)
mp.add_forced_key_binding("2", "recent-2", function() load(list, start, 1) end)
mp.add_forced_key_binding("3", "recent-3", function() load(list, start, 2) end)
mp.add_forced_key_binding("4", "recent-4", function() load(list, start, 3) end)
mp.add_forced_key_binding("5", "recent-5", function() load(list, start, 4) end)
mp.add_forced_key_binding("6", "recent-6", function() load(list, start, 5) end)
mp.add_forced_key_binding("7", "recent-7", function() load(list, start, 6) end)
mp.add_forced_key_binding("8", "recent-8", function() load(list, start, 7) end)
mp.add_forced_key_binding("9", "recent-9", function() load(list, start, 8) end)
mp.add_forced_key_binding("0", "recent-0", function() load(list, start, 9) end)
mp.add_forced_key_binding("ESC", "recent-ESC", function() unbind() end)
end
if o.double_menu_key then
mp.add_key_binding(o.display_bind, "display-recent", function(keypress)
if keypress.event == "down" and uosc_available then
long_press = false
key_timer = mp.add_timeout(.2, function()
if list_drawn then unbind() end
local list = read_log_table()
open_menu(list)
long_press = true
uosc_opened = not uosc_opened
end)
elseif keypress.event == "up" then
if key_timer and key_timer:is_enabled() then key_timer:kill() end
if not long_press then
mp.commandv('script-message-to', 'uosc', 'close-menu')
display_list()
end
end
end, {complex=true})
else
mp.add_key_binding(o.display_bind, "display-recent", display_list)
end
local function run_idle()
mp.observe_property("idle-active", "bool", function(_, v)
if o.auto_run_idle and v and not use_uosc_menu then
display_list()
end
end)
end
-- mpv-menu-plugin integration
mp.register_script_message('menu-ready', function()
dyn_menu.ready = true
update_dyn_menu_items()
end)
-- check if uosc is running
mp.register_script_message('uosc-version', function(version)
uosc_available = true
uosc_menu_opened = false
end)
mp.register_script_message("recent-uosc-closed", function()
uosc_menu_opened = false
uosc_opened = false
end)
mp.observe_property("display-hidpi-scale", "native", function(_, scale)
if scale then
display_scale = scale
run_idle()
end
end)
mp.register_event("file-loaded", function()
unbind()
cur_title, cur_path = get_path()
end)
-- Using hook, as at the "end-file" event the playback position info is already unset.
mp.add_hook("on_unload", 9, function ()
if not o.auto_save then return end
local pos = mp.get_property("percent-pos")
if not pos then return end
if tonumber(pos) <= o.auto_save_skip_past then
write_log(false)
else
write_log(true)
end
end)
mp.add_key_binding(o.save_bind, "recent-save", function()
write_log(false)
mp.osd_message("Saved entry to log")
end)
mp.add_key_binding(nil, "play-last", play_last)that allowed me to seamlessly switch between default and uosc lists on long key press, with intention to search through history with a toggle between title/path without making seperate or modifier keybinds. |
I was implementing menu actions (item buttons), and it turned into quite a rewrite of how menu shortcuts work, and introduced a more powerful menu lifecycle API, where scripts can now get a high resolution events for various stuff, and overall get more control over menus.
I'm not too happy with it, but it's the best I could come up with without breaking things.
I'm sure there are still some bugs and undesirable side effects I've failed to notice as a lot has changed.
Notable new features:
select-menu-item <menu_type> <item_index> [submenu_id]command.