Morph MORPH
SIGN IN SIGN UP
mpv-player / mpv UNCLAIMED

🎥 Command line media player

0 0 2 C
Normal View History Raw
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Copyright (C) 2019 the mpv developers
--
-- Permission to use, copy, modify, and/or distribute this software for any
-- purpose with or without fee is hereby granted, provided that the above
-- copyright notice and this permission notice appear in all copies.
--
-- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
-- SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
-- OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
-- CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
local utils = require 'mp.utils'
local assdraw = require 'mp.assdraw'
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function detect_platform()
{console,ytdl_hook}: use the platform property The console.lua check is still kind of dumb since we check an environment variable to distinguish between wayland and x11, but otherwise it should be better in theory.
2022-01-22 23:29:28 -06:00
local platform = mp.get_property_native('platform')
if platform == 'darwin' or platform == 'windows' then
return platform
console.lua,wayland_common: also detect Wayland if WAYLAND_SOCKET set While most Wayland compositors provide a socket path indicated by environment variable WAYLAND_DISPLAY, others may sometimes bequeath a socket file descriptor specified by WAYLAND_SOCKET.
2024-11-17 14:11:57 -05:00
elseif os.getenv('WAYLAND_DISPLAY') or os.getenv('WAYLAND_SOCKET') then
console: use wl-paste on Wayland
2020-12-14 20:18:55 +01:00
return 'wayland'
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
return 'x11'
end
local platform = detect_platform()
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
-- Default options
local opts = {
font = "",
console.lua: restore the bigger default font size Fixes aa66f0dced.
2024-10-29 00:10:11 +01:00
font_size = 24,
sub/osd/console/stats: use the same 1.65 outline size
2024-11-17 07:01:55 +01:00
border_size = 1.65,
console.lua: add margin_{x,y} script-opts Allow configuring the margins from the left bottom indipendently of --osd-margin-{x,y}. Fixes #15478.
2024-12-10 13:05:21 +01:00
margin_x = -1,
margin_y = -1,
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
scale_with_window = "auto",
case_sensitive = platform ~= 'windows' and true or false,
history_dedup = true,
font_hw_ratio = 'auto',
}
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console: refactor text styles for log levels The text styles are now in a table. The color definitions of the theme where the colors were taken from are now included in a comment for future reference. The colors have been converted to BGR as is required by ASS.
2022-06-20 00:08:37 +02:00
local styles = {
-- Colors are stolen from base16 Eighties by Chris Kempson
-- and converted to BGR as is required by ASS.
-- 2d2d2d 393939 515151 697374
-- 939fa0 c8d0d3 dfe6e8 ecf0f2
-- 7a77f2 5791f9 66ccff 99cc99
-- cccc66 cc9966 cc99cc 537bd2
debug = '{\\1c&Ha09f93&}',
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
v = '{\\1c&H99cc99&}',
console: refactor text styles for log levels The text styles are now in a table. The color definitions of the theme where the colors were taken from are now included in a comment for future reference. The colors have been converted to BGR as is required by ASS.
2022-06-20 00:08:37 +02:00
warn = '{\\1c&H66ccff&}',
error = '{\\1c&H7a77f2&}',
console.lua: sync colors after msg.c change Keep ASS pallete the same, as it doesn't print trace messages anyway. Remove only bold and keep debug gray.
2024-09-13 21:26:25 +02:00
fatal = '{\\1c&H5791f9&}',
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion = '{\\1c&Hcc99cc&}',
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
disabled = '{\\1c&Hcccccc&}',
console: refactor text styles for log levels The text styles are now in a table. The color definitions of the theme where the colors were taken from are now included in a comment for future reference. The colors have been converted to BGR as is required by ASS.
2022-06-20 00:08:37 +02:00
}
console.lua: inherit --osd-color and --osd-outline-color Stop overriding the OSD font and outline color in the console input line and log, except for the lines already in a different color. This allows configuring the console color and makes it consistent with the rest of the OSD, like 51bd00c33a did for stats.
2024-12-17 10:21:54 +01:00
for key, style in pairs(styles) do
console.lua: keep --osd-{,outline}-color's alpha component for styles There is no need to override this for colored lines.
2024-12-20 15:56:16 +01:00
styles[key] = style .. '{\\3c&H111111&}'
console.lua: inherit --osd-color and --osd-outline-color Stop overriding the OSD font and outline color in the console input line and log, except for the lines already in a different color. This allows configuring the console color and makes it consistent with the rest of the OSD, like 51bd00c33a did for stats.
2024-12-17 10:21:54 +01:00
end
console: refactor text styles for log levels The text styles are now in a table. The color definitions of the theme where the colors were taken from are now included in a comment for future reference. The colors have been converted to BGR as is required by ASS.
2022-06-20 00:08:37 +02:00
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
local terminal_styles = {
console.lua: sync colors after msg.c change Keep ASS pallete the same, as it doesn't print trace messages anyway. Remove only bold and keep debug gray.
2024-09-13 21:26:25 +02:00
debug = '\027[90m',
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
v = '\027[32m',
warn = '\027[33m',
error = '\027[31m',
console.lua: sync colors after msg.c change Keep ASS pallete the same, as it doesn't print trace messages anyway. Remove only bold and keep debug gray.
2024-09-13 21:26:25 +02:00
fatal = '\027[91m',
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
selected_completion = '\027[7m',
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
default_item = '\027[1m',
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
disabled = '\027[38;5;8m',
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
}
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local repl_active = false
console.lua: clear terminal msg after changing to OSD display
2024-09-24 18:49:34 +02:00
local osd_msg_active = false
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local insert_mode = false
local pending_update = false
local line = ''
local cursor = 1
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
local default_prompt = '>'
local prompt = default_prompt
local default_id = 'default'
local id = default_id
local histories = {[id] = {}}
local history = histories[id]
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local history_pos = 1
console.lua: implement history search
2024-08-14 18:18:48 +02:00
local searching_history = false
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
local log_buffers = {[id] = {}}
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local key_bindings = {}
stats.lua: scroll keybindings while filtering them console.lua binds up and down to navigate its history. Add a private flag to mp.input.get to instruct console.lua not to bind up and down, so you can use them to scroll the keybindings page while filtering keybindings. If it is requested, this can be replaced with an argument to input.get to not bind arbitrary keys. Fixes #14966.
2024-10-01 20:53:47 +02:00
local dont_bind_up_down = false
console.lua: set a high z in select mode Give console's overlay a high z only in select mode, since in this case you want to click it so it should be above other overlays. In particular console should be above the OSC's box layout with visibility=always when you show it by clicking its buttons. Keep using z=0 otherwise when it doesn't handle clicks, to avoid unintuitive behavior of overlays handling clicks like the OSC being drawn below console. Since the legacy mp.set_osd_ass() doesn't accept z, we need to repeat its caching logic, like 490b3ba007 and 86d24b069b did for the OSC.
2025-01-10 21:07:35 +01:00
local overlay = mp.create_osd_overlay('ass-events')
console: observe osc margins from user-data instead of shared-script-properties
2023-01-28 15:27:24 -06:00
local global_margins = { t = 0, b = 0 }
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
local input_caller
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
local completion_buffer = {}
local selected_completion_index
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local completion_pos
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
local completion_append
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
local path_separator = platform == 'windows' and '\\' or '/'
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
local completion_old_line
local completion_old_cursor
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
local selectable_items
local matches = {}
local selected_match = 1
local first_match_to_print = 1
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
local default_item
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
local complete
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
local cycle_through_completions
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local set_active
console: adjust position to OSC See previous commit.
2019-12-18 09:04:15 +01:00
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
local function get_font()
if opts.font ~= '' then
return opts.font
end
if selectable_items and not searching_history then
return
end
-- Pick a better default font for Windows and macOS
if platform == 'windows' then
return 'Consolas'
end
if platform == 'darwin' then
return 'Menlo'
end
return 'monospace'
end
console.lua: add margin_{x,y} script-opts Allow configuring the margins from the left bottom indipendently of --osd-margin-{x,y}. Fixes #15478.
2024-12-10 13:05:21 +01:00
local function get_margin_x()
return opts.margin_x > -1 and opts.margin_x or mp.get_property_native('osd-margin-x')
end
local function get_margin_y()
return opts.margin_y > -1 and opts.margin_y or mp.get_property_native('osd-margin-y')
end
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- Naive helper function to find the next UTF-8 character in 'str' after 'pos'
-- by skipping continuation bytes. Assumes 'str' contains valid UTF-8.
local function next_utf8(str, pos)
if pos > str:len() then return pos end
repeat
pos = pos + 1
until pos > str:len() or str:byte(pos) < 0x80 or str:byte(pos) > 0xbf
return pos
end
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- As above, but finds the previous UTF-8 character in 'str' before 'pos'
local function prev_utf8(str, pos)
if pos <= 1 then return pos end
repeat
pos = pos - 1
until pos <= 1 or str:byte(pos) < 0x80 or str:byte(pos) > 0xbf
return pos
end
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function len_utf8(str)
local len = 0
local pos = 1
while pos <= str:len() do
pos = next_utf8(str, pos)
len = len + 1
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
return len
end
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- Functions to calculate the font width.
local width_length_ratio = 0.5
local osd_width, osd_height = 100, 100
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
---Update osd resolution if valid
local function update_osd_resolution()
local dim = mp.get_property_native('osd-dimensions')
if not dim or dim.w == 0 or dim.h == 0 then
return
end
osd_width = dim.w
osd_height = dim.h
end
local text_osd = mp.create_osd_overlay('ass-events')
text_osd.compute_bounds, text_osd.hidden = true, true
local function measure_bounds(ass_text)
update_osd_resolution()
text_osd.res_x, text_osd.res_y = osd_width, osd_height
text_osd.data = ass_text
local res = text_osd:update()
return res.x0, res.y0, res.x1, res.y1
end
---Measure text width and normalize to a font size of 1
---text has to be ass safe
local function normalized_text_width(text, size, horizontal)
local align, rotation = horizontal and 7 or 1, horizontal and 0 or -90
local template = '{\\pos(0,0)\\rDefault\\blur0\\bord0\\shad0\\q2\\an%s\\fs%s\\fn%s\\frz%s}%s'
size = size / 0.8
local width
-- Limit to 5 iterations
local repetitions_left = 5
for i = 1, repetitions_left do
size = size * 0.8
local ass = assdraw.ass_new()
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
ass.text = template:format(align, size, get_font(), rotation, text)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local _, _, x1, y1 = measure_bounds(ass.text)
-- Check if nothing got clipped
if x1 and x1 < osd_width and y1 < osd_height then
width = horizontal and x1 or y1
break
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
if i == repetitions_left then
width = 0
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
end
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
return width / size, horizontal and osd_width or osd_height
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-08 00:03:48 +01:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function fit_on_osd(text)
local estimated_width = #text * width_length_ratio
if osd_width >= osd_height then
-- Fill the osd as much as possible, bigger is more accurate.
return math.min(osd_width / estimated_width, osd_height), true
else
return math.min(osd_height / estimated_width, osd_width), false
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local measured_font_hw_ratio = nil
local function get_font_hw_ratio()
local font_hw_ratio = tonumber(opts.font_hw_ratio)
if font_hw_ratio then
return font_hw_ratio
end
if not measured_font_hw_ratio then
local alphabet = 'abcdefghijklmnopqrstuvwxyz'
local text = alphabet:rep(3)
update_osd_resolution()
local size, horizontal = fit_on_osd(text)
local normalized_width = normalized_text_width(text, size * 0.9, horizontal)
measured_font_hw_ratio = #text / normalized_width * 0.95
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
return measured_font_hw_ratio
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Escape a string for verbatim display on the OSD
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function ass_escape(str)
command: add escape-ass This adds a command to escape ASS tags to remove code duplication between sub/osd_libass.c, console.lua, osc.lua, stats.lua and any user script that calls mp.create_osd_overlay(). A command is used instead of scripting functions so that all clients can use this and not just use Lua and JS ones. osd_mangle_ass() also interprets osd-sym-cc and osd-ass-cc/{0,1}, but since they use invalid UTF-8 characters there is no risk of escape-ass users using them by accident, like with any OSD message. Always replacing \n with \\N in mangle_ass() even when it is not called by escape-ass doesn't seem to cause any issue, but I made it conditional anyway to avoid changing how all OSD messages are treated unnecessarily.
2022-05-01 07:29:32 +02:00
return mp.command_native({'escape-ass', str})
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
local function should_scale()
return opts.scale_with_window == "yes" or
(opts.scale_with_window == "auto" and mp.get_property_native("osd-scale-by-window"))
end
console.lua: fix the hovered line calculation without scale with window If not scaling with the window the hidpi scale needs to be factored into mouse-pos. Follow up to a670f75679 and a2106396bc.
2024-10-28 15:34:05 +01:00
local function scale_factor()
local height = mp.get_property_native('osd-height')
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
console.lua: fix the hovered line calculation without scale with window If not scaling with the window the hidpi scale needs to be factored into mouse-pos. Follow up to a670f75679 and a2106396bc.
2024-10-28 15:34:05 +01:00
if should_scale() and height > 0 then
return height / 720
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
end
console.lua: fix the hovered line calculation without scale with window If not scaling with the window the hidpi scale needs to be factored into mouse-pos. Follow up to a670f75679 and a2106396bc.
2024-10-28 15:34:05 +01:00
return mp.get_property_native('display-hidpi-scale', 1)
end
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
console.lua: fix the hovered line calculation without scale with window If not scaling with the window the hidpi scale needs to be factored into mouse-pos. Follow up to a670f75679 and a2106396bc.
2024-10-28 15:34:05 +01:00
local function get_scaled_osd_dimensions()
local dims = mp.get_property_native('osd-dimensions')
local scale = scale_factor()
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
console.lua: fix the hovered line calculation without scale with window If not scaling with the window the hidpi scale needs to be factored into mouse-pos. Follow up to a670f75679 and a2106396bc.
2024-10-28 15:34:05 +01:00
return dims.w / scale, dims.h /scale
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
end
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
local function calculate_max_log_lines()
console.lua: fix the height calculation with --video-osd=no
2024-09-22 17:27:27 +02:00
if not mp.get_property_native('vo-configured')
or not mp.get_property_native('video-osd') then
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
-- Subtract 1 for the input line and for each line in the status line.
-- This does not detect wrapped lines.
return mp.get_property_native('term-size/h', 24) - 2 -
select(2, mp.get_property('term-status-msg'):gsub('\\n', ''))
end
console.lua: factor OSC margins before the bottom margin OSC margins are relative to the whole height before subtracting the bottom left margin.
2024-10-30 15:57:37 +01:00
return math.floor((select(2, get_scaled_osd_dimensions())
* (1 - global_margins.t - global_margins.b)
console.lua: add margin_{x,y} script-opts Allow configuring the margins from the left bottom indipendently of --osd-margin-{x,y}. Fixes #15478.
2024-12-10 13:05:21 +01:00
- get_margin_y())
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
/ opts.font_size
Revert "console.lua: fix the max log lines calculation" This reverts commit 5e65999eb26b92bb10aa1ed2f88a633f77442e25. This was wrong because an empty line doesn't occupy as much height as a filled line. But update the comment so it is not unclear like before why 1.5 is subtracted.
2024-10-29 19:14:26 +01:00
-- Subtract 1 for the input line and 0.5 for the empty
-- line between the log and the input line.
- 1.5)
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
end
console.lua: don't highlight the first completion with mp.input.get The first completion is highlighted because it is automatically inserted when pressing Enter, but this isn't the case when the console is used with mp.input.get, and autoselecting it can be undesirable if you're entering arbitrary text, unlike with mpv commands where you're usually choosing from predefined lists. So just don't highlight the first completion for mp.input clients.
2024-12-15 15:44:11 +01:00
local function should_highlight_completion(i)
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
return i == selected_completion_index or
(i == 1 and selected_completion_index == 0 and input_caller == nil)
console.lua: don't highlight the first completion with mp.input.get The first completion is highlighted because it is automatically inserted when pressing Enter, but this isn't the case when the console is used with mp.input.get, and autoselecting it can be undesirable if you're entering arbitrary text, unlike with mpv commands where you're usually choosing from predefined lists. So just don't highlight the first completion for mp.input clients.
2024-12-15 15:44:11 +01:00
end
console.lua: apply --osd-selected-color to selected completions
2025-01-02 16:23:49 +01:00
local function mpv_color_to_ass(color)
return color:sub(8,9) .. color:sub(6,7) .. color:sub(4,5),
string.format('%x', 255 - tonumber('0x' .. color:sub(2,3)))
end
local function get_selected_ass()
local color, alpha = mpv_color_to_ass(mp.get_property('osd-selected-color'))
local outline_color, outline_alpha =
mpv_color_to_ass(mp.get_property('osd-selected-outline-color'))
return '{\\1c&H' .. color .. '&\\1a&H' .. alpha ..
'&\\3c&H' .. outline_color .. '&\\3a&H' .. outline_alpha .. '&}'
end
console: cull lines outside of visible area Lines that would be outside of the visible area are now culled. The log messages were already culled, however with the introduction of suggestions, they also needed a small update.
2022-06-20 22:28:04 +02:00
-- Takes a list of strings, a max width in characters and
-- optionally a max row count.
-- The result contains at least one column.
-- Rows are cut off from the top if rows_max is specified.
-- returns a string containing the formatted table and the row count
console.lua: rename format_table() to format_grid() Since there is no table header or predetermined columns.
2025-01-20 13:49:47 +01:00
local function format_grid(list, width_max, rows_max)
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
if #list == 0 then
console: cull lines outside of visible area Lines that would be outside of the visible area are now culled. The log messages were already culled, however with the introduction of suggestions, they also needed a small update.
2022-06-20 22:28:04 +02:00
return '', 0
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
end
local spaces_min = 2
local spaces_max = 8
local list_size = #list
local column_count = 1
local row_count = list_size
local column_widths
-- total width without spacing
local width_total = 0
console: support utf8 for table formatting
2022-11-03 18:14:53 +01:00
local list_widths = {}
for i, item in ipairs(list) do
list_widths[i] = len_utf8(item)
end
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
-- use as many columns as possible
console: optimize table generation Showing all properties was terribly slow. Instead of starting at one row and increasing the row count until it fits, the column count can be increased until it doesn't fit anymore. That alone already reduces the required iterations, but from the column count an upper and lower bound for the row count can be calculated. For large tables this dramatically reduces the amount of iterations.
2023-09-27 21:44:52 +02:00
for columns = 2, list_size do
console: wrap rows at the top The previous commit was already a big improvement, but it was still somewhat slow on the lua interpreter. By wrapping the table at the top we loose the consistent placement of items while resizing (at least as long as the column count didn't change), but we avoid taking all the off screen items into account. The fewer items fit on screen the faster this becomes.
2023-09-27 22:36:58 +02:00
local rows_lower_bound = math.min(rows_max, math.ceil(list_size / columns))
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local rows_upper_bound = math.min(rows_max, list_size,
math.ceil(list_size / (columns - 1) - 1))
console: optimize table generation Showing all properties was terribly slow. Instead of starting at one row and increasing the row count until it fits, the column count can be increased until it doesn't fit anymore. That alone already reduces the required iterations, but from the column count an upper and lower bound for the row count can be calculated. For large tables this dramatically reduces the amount of iterations.
2023-09-27 21:44:52 +02:00
for rows = rows_upper_bound, rows_lower_bound, -1 do
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local cw = {}
console: optimize table generation Showing all properties was terribly slow. Instead of starting at one row and increasing the row count until it fits, the column count can be increased until it doesn't fit anymore. That alone already reduces the required iterations, but from the column count an upper and lower bound for the row count can be calculated. For large tables this dramatically reduces the amount of iterations.
2023-09-27 21:44:52 +02:00
width_total = 0
-- find out width of each column
for column = 1, columns do
local width = 0
for row = 1, rows do
local i = row + (column - 1) * rows
local item_width = list_widths[i]
if not item_width then break end
if width < item_width then
width = item_width
end
end
cw[column] = width
width_total = width_total + width
if width_total + (columns - 1) * spaces_min > width_max then
break
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
end
end
console: optimize table generation Showing all properties was terribly slow. Instead of starting at one row and increasing the row count until it fits, the column count can be increased until it doesn't fit anymore. That alone already reduces the required iterations, but from the column count an upper and lower bound for the row count can be calculated. For large tables this dramatically reduces the amount of iterations.
2023-09-27 21:44:52 +02:00
if width_total + (columns - 1) * spaces_min <= width_max then
row_count = rows
column_count = columns
column_widths = cw
else
break
end
end
console: wrap rows at the top The previous commit was already a big improvement, but it was still somewhat slow on the lua interpreter. By wrapping the table at the top we loose the consistent placement of items while resizing (at least as long as the column count didn't change), but we avoid taking all the off screen items into account. The fewer items fit on screen the faster this becomes.
2023-09-27 22:36:58 +02:00
if width_total + (columns - 1) * spaces_min > width_max then
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
break
end
end
local spaces = math.floor((width_max - width_total) / (column_count - 1))
spaces = math.max(spaces_min, math.min(spaces_max, spaces))
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
local spacing = column_count > 1
and ass_escape(string.format('%' .. spaces .. 's', ' '))
or ''
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
local rows = {}
console: wrap rows at the top The previous commit was already a big improvement, but it was still somewhat slow on the lua interpreter. By wrapping the table at the top we loose the consistent placement of items while resizing (at least as long as the column count didn't change), but we avoid taking all the off screen items into account. The fewer items fit on screen the faster this becomes.
2023-09-27 22:36:58 +02:00
for row = 1, row_count do
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
local columns = {}
for column = 1, column_count do
local i = row + (column - 1) * row_count
if i > #list then break end
console: fix crash for long suggestion strings String formatting of Lua crashes with widths greater then 99, so limit the value to that. A nicer solution would be to create our own string padding function that can handle bigger widths, but such long suggestions aren't common enough to be worth the effort.
2023-11-11 20:17:41 +01:00
-- more then 99 leads to 'invalid format (width or precision too long)'
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
local format_string = column == column_count and '%s'
console: fix crash for long suggestion strings String formatting of Lua crashes with widths greater then 99, so limit the value to that. A nicer solution would be to create our own string padding function that can handle bigger widths, but such long suggestions aren't common enough to be worth the effort.
2023-11-11 20:17:41 +01:00
or '%-' .. math.min(column_widths[column], 99) .. 's'
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
columns[column] = ass_escape(string.format(format_string, list[i]))
console.lua: don't highlight the first completion with mp.input.get The first completion is highlighted because it is automatically inserted when pressing Enter, but this isn't the case when the console is used with mp.input.get, and autoselecting it can be undesirable if you're entering arbitrary text, unlike with mpv commands where you're usually choosing from predefined lists. So just don't highlight the first completion for mp.input clients.
2024-12-15 15:44:11 +01:00
if should_highlight_completion(i) then
console.lua: apply --osd-selected-color to selected completions
2025-01-02 16:23:49 +01:00
columns[column] = '{\\b1}' .. get_selected_ass() .. columns[column] ..
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
'{\\b\\1a&\\3a&}' .. styles.completion
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
end
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
end
-- first row is at the bottom
console: wrap rows at the top The previous commit was already a big improvement, but it was still somewhat slow on the lua interpreter. By wrapping the table at the top we loose the consistent placement of items while resizing (at least as long as the column count didn't change), but we avoid taking all the off screen items into account. The fewer items fit on screen the faster this becomes.
2023-09-27 22:36:58 +02:00
rows[row_count - row + 1] = table.concat(columns, spacing)
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
end
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
return table.concat(rows, ass_escape('\n')), row_count
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 23:26:33 +02:00
end
console.lua: determine completions with fuzzy search For example, set vo gn<Tab> will complete to gpu-next.
2024-11-22 16:10:35 +01:00
local function fuzzy_find(needle, haystacks, case_sensitive)
local result = require 'mp.fzy'.filter(needle, haystacks, case_sensitive)
console.lua: preserve the order of items with equal score table.sort() is unstable, meaning that it randomly reorders items with the same score, so currently fuzzy_find() checks if the line is empty to not change the original order of the unsorted items. But actually filled lines have the same problem: e.g. searching foo with filenames like foo_{1..99}, they are returned in random order. To fix this sort by score only when 2 items have different score, else sort by the original position.
2025-01-19 18:04:01 +01:00
table.sort(result, function (i, j)
if i[3] ~= j[3] then
console.lua: pre-filter searched commands if the line is filled If you type something before pressing Ctrl+r, filter the commands containing the typed line. fuzzy_find() is modified to not code a separate case when the line is empty in both handle_edit() or search_history().
2024-08-23 19:12:38 +02:00
return i[3] > j[3]
console.lua: preserve the order of items with equal score table.sort() is unstable, meaning that it randomly reorders items with the same score, so currently fuzzy_find() checks if the line is empty to not change the original order of the unsorted items. But actually filled lines have the same problem: e.g. searching foo with filenames like foo_{1..99}, they are returned in random order. To fix this sort by score only when 2 items have different score, else sort by the original position.
2025-01-19 18:04:01 +01:00
end
return i[1] < j[1]
end)
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
for i, value in ipairs(result) do
result[i] = value[1]
end
return result
end
console.lua: use ${term-clip-cc} to clip lines Instead of considering every non-ASCII character 2-cell wide, use this newly introduced property to let msg.c clip the select menu using all available with.
2024-10-01 22:24:05 +02:00
local function populate_log_with_matches()
console.lua: don't crash when scrolling without matches selected_match can become 0 when pressing certain scrolling keybindings without any match, and for i = first_match_to_print, last_match_to_print do in populate_log_with_matches() runs from 0 to 0 and accessing matches[0].text crashes console.lua. Return early when it is 0.
2024-05-11 19:31:34 +02:00
if not selectable_items or selected_match == 0 then
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
return
end
log_buffers[id] = {}
local log = log_buffers[id]
console.lua: use all available lines for selection Refine populate_log_with_matches()'s logic to not reserve 2 lines for "n hidden items" when it is not necessary. This avoids printing "1 hidden items", and doesn't leave an empty line when there are hidden items only in one direction.
2024-05-14 22:09:30 +02:00
local max_log_lines = calculate_max_log_lines()
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
local print_counter = false
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
if #matches > max_log_lines then
print_counter = true
console.lua: use all available lines for selection Refine populate_log_with_matches()'s logic to not reserve 2 lines for "n hidden items" when it is not necessary. This avoids printing "1 hidden items", and doesn't leave an empty line when there are hidden items only in one direction.
2024-05-14 22:09:30 +02:00
max_log_lines = max_log_lines - 1
end
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
if selected_match < first_match_to_print then
first_match_to_print = selected_match
elseif selected_match > first_match_to_print + max_log_lines - 1 then
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
first_match_to_print = selected_match - max_log_lines + 1
end
console.lua: use all available lines for selection Refine populate_log_with_matches()'s logic to not reserve 2 lines for "n hidden items" when it is not necessary. This avoids printing "1 hidden items", and doesn't leave an empty line when there are hidden items only in one direction.
2024-05-14 22:09:30 +02:00
local last_match_to_print = math.min(first_match_to_print + max_log_lines - 1,
#matches)
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
if print_counter then
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
log[1] = {
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
text = '',
style = styles.disabled .. selected_match .. '/' .. #matches ..
' {\\fs' .. opts.font_size * 0.75 .. '}[' ..
first_match_to_print .. '-' .. last_match_to_print .. ']',
terminal_style = terminal_styles.disabled .. selected_match .. '/' ..
#matches .. ' [' .. first_match_to_print .. '-' ..
last_match_to_print .. ']',
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
}
end
for i = first_match_to_print, last_match_to_print do
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
local style = ''
local terminal_style = ''
console.lua: color the default item with --osd-selected-color Currently if you change --osd-selected-color the preselected item stays yellow and can't be changed. Since the default item style was just chosen from the selected color without the bold, also make the default item follow --osd-selected-color. Requested in https://github.com/Samillion/ModernZ/issues/259#issuecomment-2556608926.
2024-12-20 11:16:14 +01:00
if i == selected_match or matches[i].index == default_item then
console.lua: apply --osd-selected-color to selected completions
2025-01-02 16:23:49 +01:00
style = get_selected_ass()
console.lua: color the default item with --osd-selected-color Currently if you change --osd-selected-color the preselected item stays yellow and can't be changed. Since the default item style was just chosen from the selected color without the bold, also make the default item follow --osd-selected-color. Requested in https://github.com/Samillion/ModernZ/issues/259#issuecomment-2556608926.
2024-12-20 11:16:14 +01:00
end
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
if matches[i].index == default_item then
command: highlight selected list items with color Instead of printing circles in show-text ${playlist}, ${chapter-list} and ${edition-list}, introduce --osd-selected-color and --osd-selected-outline-color to reduce clutter, make the selected item easier to differentiate, and have visual consistency with select.lua. The defaults are taken from the style of the selected item in the console. These new options are also used there, replacing the hardcoded styles. Due to being user-configurable, selected item styles are changed to take priority over default item styles. The default selected style is yellow and bold. The bold (hardcoded) allows differentiating the selected item with color blindness. There is also a separate --osd-selected-outline-color option defaulting to black, since without it if the user changes --osd-outline-color yellow text becomes unreadable without a black border. --osd-selected-back-color is omitted for now. Text and background colors are inverted for the selected item in the terminal. This is hardcoded, adding an option is overkill. A disadvantage of this commit is that if you run print-text ${playlist} with a VO, the selected style ASS is printed to the terminal (but ASS printed in the console is interpreted). This commit avoids printing the reset ASS sequence for non-selected items to reduce clutter in this case.
2024-11-26 22:15:45 +01:00
terminal_style = terminal_styles.default_item
end
if i == selected_match then
console.lua: color the default item with --osd-selected-color Currently if you change --osd-selected-color the preselected item stays yellow and can't be changed. Since the default item style was just chosen from the selected color without the bold, also make the default item follow --osd-selected-color. Requested in https://github.com/Samillion/ModernZ/issues/259#issuecomment-2556608926.
2024-12-20 11:16:14 +01:00
style = style .. '{\\b1}'
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
terminal_style = terminal_style .. terminal_styles.selected_completion
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
end
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
log[#log + 1] = {
console.lua: use ${term-clip-cc} to clip lines Instead of considering every non-ASCII character 2-cell wide, use this newly introduced property to let msg.c clip the select menu using all available with.
2024-10-01 22:24:05 +02:00
text = matches[i].text,
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
style = style,
terminal_style = terminal_style,
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
}
end
end
console.lua: set a high z in select mode Give console's overlay a high z only in select mode, since in this case you want to click it so it should be above other overlays. In particular console should be above the OSC's box layout with visibility=always when you show it by clicking its buttons. Keep using z=0 otherwise when it doesn't handle clicks, to avoid unintuitive behavior of overlays handling clicks like the OSC being drawn below console. Since the legacy mp.set_osd_ass() doesn't accept z, we need to repeat its caching logic, like 490b3ba007 and 86d24b069b did for the OSC.
2025-01-10 21:07:35 +01:00
local function update_overlay(data, res_x, res_y, z)
if overlay.data == data and
overlay.res_x == res_x and
overlay.res_y == res_y and
overlay.z == z then
return
end
overlay.data = data
overlay.res_x = res_x
overlay.res_y = res_y
overlay.z = z
overlay:update()
end
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
local function print_to_terminal()
-- Clear the log after closing the console.
if not repl_active then
console.lua: don't clear not ours osd messages Note that this still is not perfect, because if osd message is changed, console cannot know about it and would still clear it, but this change make it at least not do it to every message even if console is not used.
2024-10-12 20:27:58 +02:00
if osd_msg_active then
mp.osd_message('')
end
console.lua: clear terminal msg after changing to OSD display
2024-09-24 18:49:34 +02:00
osd_msg_active = false
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
return
end
console.lua: use ${term-clip-cc} to clip lines Instead of considering every non-ASCII character 2-cell wide, use this newly introduced property to let msg.c clip the select menu using all available with.
2024-10-01 22:24:05 +02:00
populate_log_with_matches()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
local log = ''
console.lua: use ${term-clip-cc} to clip lines Instead of considering every non-ASCII character 2-cell wide, use this newly introduced property to let msg.c clip the select menu using all available with.
2024-10-01 22:24:05 +02:00
local clip = selectable_items and mp.get_property('term-clip-cc') or ''
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
for _, log_line in ipairs(log_buffers[id]) do
console.lua: use ${term-clip-cc} to clip lines Instead of considering every non-ASCII character 2-cell wide, use this newly introduced property to let msg.c clip the select menu using all available with.
2024-10-01 22:24:05 +02:00
log = log .. clip .. log_line.terminal_style .. log_line.text .. '\027[0m\n'
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
end
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
local completions = ''
for i, completion in ipairs(completion_buffer) do
console.lua: don't highlight the first completion with mp.input.get The first completion is highlighted because it is automatically inserted when pressing Enter, but this isn't the case when the console is used with mp.input.get, and autoselecting it can be undesirable if you're entering arbitrary text, unlike with mpv commands where you're usually choosing from predefined lists. So just don't highlight the first completion for mp.input clients.
2024-12-15 15:44:11 +01:00
if should_highlight_completion(i) then
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completions = completions .. terminal_styles.selected_completion ..
completion .. '\027[0m'
console.lua: highlight the selected suggestion in the terminal
2024-01-14 23:30:19 +01:00
else
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completions = completions .. completion
console.lua: highlight the selected suggestion in the terminal
2024-01-14 23:30:19 +01:00
end
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completions = completions .. (i < #completion_buffer and '\t' or '\n')
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
end
local before_cur = line:sub(1, cursor - 1)
local after_cur = line:sub(cursor)
-- Ensure there is a character with inverted colors to print.
if after_cur == '' then
after_cur = ' '
end
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
mp.osd_message(log .. completions .. prompt .. ' ' .. before_cur ..
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
'\027[7m' .. after_cur:sub(1, 1) .. '\027[0m' ..
after_cur:sub(2), 999)
console.lua: clear terminal msg after changing to OSD display
2024-09-24 18:49:34 +02:00
osd_msg_active = true
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
local function render()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
pending_update = false
console.lua: simplify the condition to print to the terminal This was a simpler fix to not print the console log to the OSD while switching VO.
2023-12-05 23:18:04 +01:00
-- Unlike vo-configured, current-vo doesn't become falsy while switching VO,
-- which would print the log to the OSD.
console.lua: respect --video-osd=no
2024-09-15 09:20:56 +02:00
if not mp.get_property('current-vo') or not mp.get_property_native('video-osd') then
console.lua: print the log and input line to the terminal
2023-10-11 17:26:16 +02:00
print_to_terminal()
return
end
console.lua: clear terminal msg after changing to OSD display
2024-09-24 18:49:34 +02:00
-- Clear the OSD if the console was being printed to the terminal
if osd_msg_active then
mp.osd_message('')
osd_msg_active = false
end
console.lua: minor tweaks - Remove the opts comments because they are already in console.rst and will become outdated if not updated in both places - Reuse last_pos in truncate_utf8() instead of recalculating the previous character's position - Clear the OSD earlier when the console is not active
2024-06-27 12:30:02 +02:00
-- Clear the OSD if the REPL is not active
if not repl_active then
console.lua: set a high z in select mode Give console's overlay a high z only in select mode, since in this case you want to click it so it should be above other overlays. In particular console should be above the OSC's box layout with visibility=always when you show it by clicking its buttons. Keep using z=0 otherwise when it doesn't handle clicks, to avoid unintuitive behavior of overlays handling clicks like the OSC being drawn below console. Since the legacy mp.set_osd_ass() doesn't accept z, we need to repeat its caching logic, like 490b3ba007 and 86d24b069b did for the OSC.
2025-01-10 21:07:35 +01:00
update_overlay('', 0, 0, 0)
console.lua: minor tweaks - Remove the opts comments because they are already in console.rst and will become outdated if not updated in both places - Reuse last_pos in truncate_utf8() instead of recalculating the previous character's position - Clear the OSD earlier when the console is not active
2024-06-27 12:30:02 +02:00
return
end
console: use hidpi scale reporting I decided to factor this into the user's scale option (instead of somehow using it as default if the user has not specified it), because it makes the option handling simpler, and won't break things like per-screen DPI if the user only wants to scale the console font by a factor.
2019-12-20 12:53:56 +01:00
console.lua: use the same blur amount as --osd-blur I have no idea why, but console's blur is smaller than in OSD messages and stats (regardless of persistent_overlay). It's smaller regardless of scale_with_window, or if using 0 PlayRes like stats with persistent_overlay=yes. With scale_with_window=yes, multiplying the blur by 2.5 seems to make it the same. This is probably because 2.5 is 720 / 288, which are the base height sizes scale from and the OSD's PlayResY. With scale_with_window=no, we need to multiply by osd_h, which is always 720 with scale_with_window=yes.
2025-01-24 18:55:18 +01:00
local ass = assdraw.ass_new()
console.lua: rename dimension variables These are easier to read with _ between words. Also screenx/y could be assumed to be display coordinates, so rename them to osd_w/h. They are not named osd_width/osd_height to avoid Redefined local LSP warnings with the ones in the upper scope.
2024-12-10 16:36:09 +01:00
local osd_w, osd_h = get_scaled_osd_dimensions()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: deduplicate y position calculation in update() This deduplicates the calculation of the y position by assigning it to a y variable, which will also be used in the next commit. margin_x is also renamed to x for consistency.
2025-01-10 12:20:09 +01:00
local x = get_margin_x()
local y = osd_h * (1 - global_margins.b) - get_margin_y()
console.lua: use OSD margins Now that default OSD margins have been decreased to 15 it is reasonable to let console.lua inherit them for consistency.
2024-11-11 10:41:47 +01:00
console.lua: use the same blur amount as --osd-blur I have no idea why, but console's blur is smaller than in OSD messages and stats (regardless of persistent_overlay). It's smaller regardless of scale_with_window, or if using 0 PlayRes like stats with persistent_overlay=yes. With scale_with_window=yes, multiplying the blur by 2.5 seems to make it the same. This is probably because 2.5 is 720 / 288, which are the base height sizes scale from and the OSD's PlayResY. With scale_with_window=no, we need to multiply by osd_h, which is always 720 with scale_with_window=yes.
2025-01-24 18:55:18 +01:00
local font = get_font()
-- Use the same blur value as the rest of the OSD. 288 is the OSD's
-- PlayResY.
local blur = mp.get_property_native('osd-blur') * osd_h / 288
console.lua: rename dimension variables These are easier to read with _ between words. Also screenx/y could be assumed to be display coordinates, so rename them to osd_w/h. They are not named osd_width/osd_height to avoid Redefined local LSP warnings with the ones in the upper scope.
2024-12-10 16:36:09 +01:00
local coordinate_top = math.floor(global_margins.t * osd_h + 0.5)
console: respect the top margin shared script property Console already respected the bottom margin to not overlap with the bottom bar from the OSC, but it would still overlap with the window decorations from the OSC. Now everything is clipped above the top margin and no superfluous lines are drawn.
2022-09-02 22:24:36 +02:00
local clipping_coordinates = '0,' .. coordinate_top .. ',' ..
console.lua: rename dimension variables These are easier to read with _ between words. Also screenx/y could be assumed to be display coordinates, so rename them to osd_w/h. They are not named osd_width/osd_height to avoid Redefined local LSP warnings with the ones in the upper scope.
2024-12-10 16:36:09 +01:00
osd_w .. ',' .. osd_h
console.lua: use the same blur amount as --osd-blur I have no idea why, but console's blur is smaller than in OSD messages and stats (regardless of persistent_overlay). It's smaller regardless of scale_with_window, or if using 0 PlayRes like stats with persistent_overlay=yes. With scale_with_window=yes, multiplying the blur by 2.5 seems to make it the same. This is probably because 2.5 is 720 / 288, which are the base height sizes scale from and the OSD's PlayResY. With scale_with_window=no, we need to multiply by osd_h, which is always 720 with scale_with_window=yes.
2025-01-24 18:55:18 +01:00
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local style = '{\\r' ..
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
(font and '\\fn' .. font or '') ..
'\\fs' .. opts.font_size ..
console.lua: don't override the offset of opaque boxes With --osd-border-style=opaque-box and background-box, respect --osd-shadow-offset. I am not sure if --osd-shadow-offset should be inherited with --osd-border-style=outline-and-shadow, especially since it doesn't let you specify different x and y offsets.
2024-11-18 17:00:29 +01:00
'\\bord' .. opts.border_size .. '\\fsp0' ..
console.lua: use the same blur amount as --osd-blur I have no idea why, but console's blur is smaller than in OSD messages and stats (regardless of persistent_overlay). It's smaller regardless of scale_with_window, or if using 0 PlayRes like stats with persistent_overlay=yes. With scale_with_window=yes, multiplying the blur by 2.5 seems to make it the same. This is probably because 2.5 is 720 / 288, which are the base height sizes scale from and the OSD's PlayResY. With scale_with_window=no, we need to multiply by osd_h, which is always 720 with scale_with_window=yes.
2025-01-24 18:55:18 +01:00
'\\blur' .. blur ..
console.lua: let libass clip lines in select mode In select mode and when printing the OSD, use \q2 to let libass clip lines longer than the OSD. This works around having to leave a large horizontal space unused due to libass subtracting the left margin from the max text width even though the ASS event is anchored to the bottom left. It also fixes truncating wide Unicode characters.
2024-06-24 04:22:55 +02:00
(selectable_items and '\\q2' or '\\q1') ..
console: respect the top margin shared script property Console already respected the bottom margin to not overlap with the bottom bar from the OSC, but it would still overlap with the window decorations from the OSC. Now everything is clipped above the top margin and no superfluous lines are drawn.
2022-09-02 22:24:36 +02:00
'\\clip(' .. clipping_coordinates .. ')}'
console.lua: use the same blur amount as --osd-blur I have no idea why, but console's blur is smaller than in OSD messages and stats (regardless of persistent_overlay). It's smaller regardless of scale_with_window, or if using 0 PlayRes like stats with persistent_overlay=yes. With scale_with_window=yes, multiplying the blur by 2.5 seems to make it the same. This is probably because 2.5 is 720 / 288, which are the base height sizes scale from and the OSD's PlayResY. With scale_with_window=no, we need to multiply by osd_h, which is always 720 with scale_with_window=yes.
2025-01-24 18:55:18 +01:00
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Create the cursor glyph as an ASS drawing. ASS will draw the cursor
-- inline with the surrounding text, but it sets the advance to the width
-- of the drawing. So the cursor doesn't affect layout too much, make it as
-- thin as possible and make it appear to be 1px wide by giving it 0.5px
-- horizontal borders.
console.lua: inherit --osd-color in the cursor Following up 19537a4996, also respect the user-specified color in the cursor. But the cursor is drawn as a border, so we actually need to use --osd-color as the border color.
2024-12-22 13:58:48 +01:00
local color, alpha = mpv_color_to_ass(mp.get_property('osd-color'))
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local cheight = opts.font_size * 8
console.lua: inherit --osd-back-color in the cursor 3dcc661de7 made the cursor reset to Default style to not apply the blur, but \blur0 achieves that without resetting every user style. The cursor can thus respect the user's --osd-back/shadow-color.
2024-12-22 14:08:37 +01:00
local cglyph = '{\\r\\blur0' ..
console.lua: hide the cursor when unfocused This is commonly done to understand whether a window is focused. This explicitly checks if focused is false instead of unavailable to not break the cursor where focused is unimplemented like on --vo=drm. The cursor is taller than the input text so it is made transparent instead of completely removing it so that the log doesn't move up and down while toggling focus. Alternatively, cheight = opts.font_size * 8 can be changed to 7.
2023-12-29 08:21:32 +01:00
(mp.get_property_native('focused') == false
console.lua: don't set the cursor color This makes no visible difference, only the border color is visible, as the border is drawn on top of the regular color.
2024-12-22 14:09:22 +01:00
and '\\alpha&HFF&' or '\\3a&H' .. alpha .. '&') ..
'\\3c&H' .. color .. '&' ..
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
'\\xbord0.5\\ybord0\\xshad0\\yshad1\\p4\\pbo24}' ..
'm 0 0 l 1 0 l 1 ' .. cheight .. ' l 0 ' .. cheight ..
'{\\p0}'
local before_cur = ass_escape(line:sub(1, cursor - 1))
local after_cur = ass_escape(line:sub(cursor))
console: cull lines outside of visible area Lines that would be outside of the visible area are now culled. The log messages were already culled, however with the introduction of suggestions, they also needed a small update.
2022-06-20 22:28:04 +02:00
-- Render log messages as ASS.
-- This will render at most screeny / font_size - 1 messages.
console.lua: refactor some log code Rename lines_max to max_lines which is the name used in other functions, and inline the log_messages variable because its name was confusing. The math.max(0, lines_max) call was not necessary because console doesn't crash with 0 or negative max lines.
2025-01-10 11:46:36 +01:00
local max_lines = calculate_max_log_lines()
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
local completion_ass = ''
if next(completion_buffer) then
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
-- Estimate how many characters fit in one line
console.lua: use OSD margins Now that default OSD margins have been decreased to 15 it is reasonable to let console.lua inherit them for consistency.
2024-11-11 10:41:47 +01:00
-- Even with bottom-left anchoring,
-- libass/ass_render.c:ass_render_event() subtracts --osd-margin-x from
-- the maximum text width twice.
console.lua: add margin_{x,y} script-opts Allow configuring the margins from the left bottom indipendently of --osd-margin-{x,y}. Fixes #15478.
2024-12-10 13:05:21 +01:00
local width_max = math.floor(
console.lua: deduplicate y position calculation in update() This deduplicates the calculation of the y position by assigning it to a y variable, which will also be used in the next commit. margin_x is also renamed to x for consistency.
2025-01-10 12:20:09 +01:00
(osd_w - x - mp.get_property_native('osd-margin-x') * 2 / scale_factor())
console.lua: add margin_{x,y} script-opts Allow configuring the margins from the left bottom indipendently of --osd-margin-{x,y}. Fixes #15478.
2024-12-10 13:05:21 +01:00
/ opts.font_size * get_font_hw_ratio())
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
console.lua: rename format_table() to format_grid() Since there is no table header or predetermined columns.
2025-01-20 13:49:47 +01:00
local completions, rows = format_grid(completion_buffer, width_max, max_lines)
console.lua: refactor some log code Rename lines_max to max_lines which is the name used in other functions, and inline the log_messages variable because its name was confusing. The math.max(0, lines_max) call was not necessary because console doesn't crash with 0 or negative max lines.
2025-01-10 11:46:36 +01:00
max_lines = max_lines - rows
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_ass = style .. styles.completion .. completions .. '\\N'
console.lua: default to a proportional font for select In the select menu there are no completions to align in a grid, so the better looking proportional font of --osd-font can be used by default. It is also easier to read for the visually impaired. The text width calculation is no longer performed if the console is only opened through select, it is only performed the first time something is completed. This avoids having to pass an argument to get_font() to make it use the monospace font regardless of selectable_items. Fixes #15176.
2024-10-26 12:08:24 +02:00
end
console: cull lines outside of visible area Lines that would be outside of the visible area are now culled. The log messages were already culled, however with the introduction of suggestions, they also needed a small update.
2022-06-20 22:28:04 +02:00
console.lua: let libass clip lines in select mode In select mode and when printing the OSD, use \q2 to let libass clip lines longer than the OSD. This works around having to leave a large horizontal space unused due to libass subtracting the left margin from the max text width even though the ASS event is anchored to the bottom left. It also fixes truncating wide Unicode characters.
2024-06-24 04:22:55 +02:00
populate_log_with_matches()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local log_ass = ''
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
local log_buffer = log_buffers[id]
console.lua: improve the hovered item calculation Currently determine_hovered_item() assumes that each item is opts.font_size pixels tall, which usually works well. This breaks with fonts that get drawn taller than that, such as Japanese text, which makes the calculation inaccurate for the top items and clips the counter. A couple of users reported that it is inaccurate for them for the top items even with ASCII characters in track selectors, presumably because the circles are taken from a different font and make all lines taller. To fix this place each selectable item in its own ASS event positioned like determine_hovered_item() expects. Unfortunately this breaks --profile=box, so keep placing every item in one ASS event with it.
2025-01-11 20:33:01 +01:00
local box = mp.get_property('osd-border-style') == 'background-box'
console.lua: refactor some log code Rename lines_max to max_lines which is the name used in other functions, and inline the log_messages variable because its name was confusing. The math.max(0, lines_max) call was not necessary because console doesn't crash with 0 or negative max lines.
2025-01-10 11:46:36 +01:00
for i = #log_buffer - math.min(max_lines, #log_buffer) + 1, #log_buffer do
console.lua: improve the hovered item calculation Currently determine_hovered_item() assumes that each item is opts.font_size pixels tall, which usually works well. This breaks with fonts that get drawn taller than that, such as Japanese text, which makes the calculation inaccurate for the top items and clips the counter. A couple of users reported that it is inaccurate for them for the top items even with ASCII characters in track selectors, presumably because the circles are taken from a different font and make all lines taller. To fix this place each selectable item in its own ASS event positioned like determine_hovered_item() expects. Unfortunately this breaks --profile=box, so keep placing every item in one ASS event with it.
2025-01-11 20:33:01 +01:00
local log_item = style .. log_buffer[i].style .. ass_escape(log_buffer[i].text)
-- Put every selectable item in its own event to prevent libass from
-- drawing them taller than opts.font_size with taller fonts, which
-- makes the hovered item calculation inaccurate and clips the counter.
-- But not with background-box, because it makes it look bad by
-- overlapping the semitransparent backgrounds of every line.
if selectable_items and not box then
ass:new_event()
ass:an(1)
ass:pos(x, y - (1.5 + #log_buffer - i) * opts.font_size)
ass:append(log_item)
else
log_ass = log_ass .. log_item .. '\\N'
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
ass:new_event()
ass:an(1)
console.lua: deduplicate y position calculation in update() This deduplicates the calculation of the y position by assigning it to a y variable, which will also be used in the next commit. margin_x is also renamed to x for consistency.
2025-01-10 12:20:09 +01:00
ass:pos(x, y)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
ass:append(log_ass .. '\\N')
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
ass:append(completion_ass)
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
ass:append(style .. ass_escape(prompt) .. ' ' .. before_cur)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
ass:append(cglyph)
ass:append(style .. after_cur)
-- Redraw the cursor with the REPL text invisible. This will make the
-- cursor appear in front of the text.
ass:new_event()
ass:an(1)
console.lua: deduplicate y position calculation in update() This deduplicates the calculation of the y position by assigning it to a y variable, which will also be used in the next commit. margin_x is also renamed to x for consistency.
2025-01-10 12:20:09 +01:00
ass:pos(x, y)
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
ass:append(style .. '{\\alpha&HFF&}' .. ass_escape(prompt) .. ' ' .. before_cur)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
ass:append(cglyph)
ass:append(style .. '{\\alpha&HFF&}' .. after_cur)
console.lua: set a high z in select mode Give console's overlay a high z only in select mode, since in this case you want to click it so it should be above other overlays. In particular console should be above the OSC's box layout with visibility=always when you show it by clicking its buttons. Keep using z=0 otherwise when it doesn't handle clicks, to avoid unintuitive behavior of overlays handling clicks like the OSC being drawn below console. Since the legacy mp.set_osd_ass() doesn't accept z, we need to repeat its caching logic, like 490b3ba007 and 86d24b069b did for the OSC.
2025-01-10 21:07:35 +01:00
-- z with selectable_items needs to be greater than the OSC's.
update_overlay(ass.text, osd_w, osd_h, selectable_items and 2000 or 0)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local update_timer = nil
update_timer = mp.add_periodic_timer(0.05, function()
if pending_update then
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
else
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
update_timer:kill()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end)
update_timer:kill()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- Add a line to the log buffer (which is limited to 100 lines)
local function log_add(text, style, terminal_style)
local log_buffer = log_buffers[id]
log_buffer[#log_buffer + 1] = {
text = text,
style = style or '',
terminal_style = terminal_style or '',
}
if #log_buffer > 100 then
table.remove(log_buffer, 1)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
if repl_active then
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
if not update_timer:is_enabled() then
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
update_timer:resume()
else
pending_update = true
end
console: support utf8 for table formatting
2022-11-03 18:14:53 +01:00
end
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- Add a line to the history and deduplicate
local function history_add(text)
if opts.history_dedup then
-- More recent entries are more likely to be repeated
for i = #history, 1, -1 do
if history[i] == text then
table.remove(history, i)
break
end
console.lua: truncate lines longer than the maximum width Avoid messing up the max_log_lines calculation when mp.input.select() is called with very long items. This doesn't work with Japanese characters because they are bigger.
2024-05-10 12:57:05 +02:00
end
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
history[#history + 1] = text
console.lua: truncate lines longer than the maximum width Avoid messing up the max_log_lines calculation when mp.input.select() is called with very long items. This doesn't work with Japanese characters because they are bigger.
2024-05-10 12:57:05 +02:00
end
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
local function handle_cursor_move()
-- Don't show completions after a command is entered because they move its
-- output up, and allow clearing completions by emptying the line.
if line == '' then
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer = {}
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
else
complete()
end
end
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
local function handle_edit()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
if selectable_items then
matches = {}
console.lua: pre-filter searched commands if the line is filled If you type something before pressing Ctrl+r, filter the commands containing the typed line. fuzzy_find() is modified to not code a separate case when the line is empty in both handle_edit() or search_history().
2024-08-23 19:12:38 +02:00
for i, match in ipairs(fuzzy_find(line, selectable_items)) do
matches[i] = { index = match, text = selectable_items[match] }
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
end
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
console.lua: focus the default item after emptying the input line When console is opened with selectable items and a default item, the default item is placed at the center. But if you type something and then clear the line, the first item becomes the selected one. Make it select the default item and place it in the center in this case too.
2025-01-02 10:30:50 +01:00
if line == '' and default_item then
selected_match = default_item
local max_lines = calculate_max_log_lines()
first_match_to_print = math.max(1, selected_match - math.floor(max_lines / 2) + 1)
if first_match_to_print > #selectable_items - max_lines + 2 then
first_match_to_print = math.max(1, #selectable_items - max_lines + 1)
end
else
selected_match = 1
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
return
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
end
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
if input_caller then
mp.commandv('script-message-to', input_caller, 'input-event', 'edited',
console.lua: don't convert integers for mp.input to string I misunderstood CogentRedTester's review in https://github.com/mpv-player/mpv/pull/10282#discussion_r1428972352 as referring to the cursor_position in mp.input's arguments instead of the one received by the closed callback. The cursor_position passed to input.get doesn't need to be converted to a number because it was already JSON, while the cursor_position received by the closed callback is currently a string, and we need to pass JSON in input-event script messages to keep it as an integer to work around mpv converting integer script message arguments to string. This is more noticeable after implementing mp.input.select(): its submit argument currently receives the selected index as a string, and this makes Lua error if you use it as an index of a numerical table, e.g.: submit = function (id) mp.set_property(property, tracks[tonumber(id)].selected and "no" or tracks[tonumber(id)].id) ... end, This commit avoids having to call tonumber(id).
2024-05-08 10:22:39 +02:00
utils.format_json({line}))
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
end
end
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
-- Insert a character at the current cursor position (any_unicode)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_char_input(c)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
if insert_mode then
line = line:sub(1, cursor - 1) .. c .. line:sub(next_utf8(line, cursor))
else
line = line:sub(1, cursor - 1) .. c .. line:sub(cursor)
end
cursor = cursor + #c
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
handle_edit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Remove the character behind the cursor (Backspace)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_backspace()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
if cursor <= 1 then return end
local prev = prev_utf8(line, cursor)
line = line:sub(1, prev - 1) .. line:sub(cursor)
cursor = prev
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
handle_edit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Remove the character in front of the cursor (Del)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_del()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
if cursor > line:len() then return end
line = line:sub(1, cursor - 1) .. line:sub(next_utf8(line, cursor))
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
handle_edit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Toggle insert mode (Ins)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_ins()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
insert_mode = not insert_mode
end
-- Move the cursor to the next character (Right)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function next_char()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
cursor = next_utf8(line, cursor)
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Move the cursor to the previous character (Left)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function prev_char()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
cursor = prev_utf8(line, cursor)
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Clear the current line (Ctrl+C)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function clear()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
line = ''
cursor = 1
insert_mode = false
history_pos = #history + 1
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
handle_edit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
-- Close the REPL if the current line is empty, otherwise delete the next
-- character (Ctrl+D)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function maybe_exit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
if line == '' then
set_active(false)
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
else
handle_del()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function help_command(param)
console: add a basic help command It's not really great. But I think it's good enough to save someone who's lost. Most importantly, it should become obvious _what_ the console expects (input commands), and how to exit it. Would be nice if we could show some documentation, or give a link to documentation, but that's out of scope and/or not easy. I considered implementing the "help" command as builtin command in command.c. On the other hand, this could not show console.lua specific help, so I implemented it in console.lua. The ad-hoc command parsing (that sort-of mirrors mpv input command syntax) for the "help" command is probably the worst part of this.
2019-12-24 16:08:04 +01:00
local cmdlist = mp.get_property_native('command-list')
console: sort the output from the `help` command Closes #11927
2023-07-13 22:10:22 +02:00
table.sort(cmdlist, function(c1, c2)
return c1.name < c2.name
end)
console: add a basic help command It's not really great. But I think it's good enough to save someone who's lost. Most importantly, it should become obvious _what_ the console expects (input commands), and how to exit it. Would be nice if we could show some documentation, or give a link to documentation, but that's out of scope and/or not easy. I considered implementing the "help" command as builtin command in command.c. On the other hand, this could not show console.lua specific help, so I implemented it in console.lua. The ad-hoc command parsing (that sort-of mirrors mpv input command syntax) for the "help" command is probably the worst part of this.
2019-12-24 16:08:04 +01:00
local output = ''
if param == '' then
output = 'Available commands:\n'
for _, cmd in ipairs(cmdlist) do
output = output .. ' ' .. cmd.name
end
output = output .. '\n'
output = output .. 'Use "help command" to show information about a command.\n'
output = output .. "ESC or Ctrl+d exits the console.\n"
else
local cmd = nil
for _, curcmd in ipairs(cmdlist) do
if curcmd.name:find(param, 1, true) then
cmd = curcmd
if curcmd.name == param then
break -- exact match
end
end
end
if not cmd then
console.lua: fix highlighting the selected item with --msg-module With --msg-module the select menu also highlights the "statusline" on the next line. Fix this by resetting the color before \n instead of after it. This requires changing all log code to not preemptively add a newline, which is actually simpler, though we have to modify the messages received with log-message which already contain a newline.
2024-09-15 08:29:39 +02:00
log_add('No command matches "' .. param .. '"!', styles.error,
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
terminal_styles.error)
console: add a basic help command It's not really great. But I think it's good enough to save someone who's lost. Most importantly, it should become obvious _what_ the console expects (input commands), and how to exit it. Would be nice if we could show some documentation, or give a link to documentation, but that's out of scope and/or not easy. I considered implementing the "help" command as builtin command in command.c. On the other hand, this could not show console.lua specific help, so I implemented it in console.lua. The ad-hoc command parsing (that sort-of mirrors mpv input command syntax) for the "help" command is probably the worst part of this.
2019-12-24 16:08:04 +01:00
return
end
output = output .. 'Command "' .. cmd.name .. '"\n'
for _, arg in ipairs(cmd.args) do
output = output .. ' ' .. arg.name .. ' (' .. arg.type .. ')'
if arg.optional then
output = output .. ' (optional)'
end
output = output .. '\n'
end
if cmd.vararg then
output = output .. 'This command supports variable arguments.\n'
end
end
console.lua: fix highlighting the selected item with --msg-module With --msg-module the select menu also highlights the "statusline" on the next line. Fix this by resetting the color before \n instead of after it. This requires changing all log code to not preemptively add a newline, which is actually simpler, though we have to modify the messages received with log-message which already contain a newline.
2024-09-15 08:29:39 +02:00
log_add(output:sub(1, -2))
console: add a basic help command It's not really great. But I think it's good enough to save someone who's lost. Most importantly, it should become obvious _what_ the console expects (input commands), and how to exit it. Would be nice if we could show some documentation, or give a link to documentation, but that's out of scope and/or not easy. I considered implementing the "help" command as builtin command in command.c. On the other hand, this could not show console.lua specific help, so I implemented it in console.lua. The ad-hoc command parsing (that sort-of mirrors mpv input command syntax) for the "help" command is probably the worst part of this.
2019-12-24 16:08:04 +01:00
end
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
local function unbind_mouse()
mp.remove_key_binding('_console_mouse_move')
mp.remove_key_binding('_console_mbtn_left')
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Run the current command and clear the line (Enter)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_enter()
console.lua: implement history search
2024-08-14 18:18:48 +02:00
if searching_history then
searching_history = false
selectable_items = nil
line = #matches > 0 and matches[selected_match].text or ''
cursor = #line + 1
log_buffers[id] = {}
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_edit()
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
unbind_mouse()
console.lua: implement history search
2024-08-14 18:18:48 +02:00
return
end
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
if line == '' and input_caller == nil then
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
return
end
console.lua: close when pressing enter with input.select When you select an item, due to the submit handler being called asynchronously, the default item list is redrawn before the console closes, which is jarring. Fix this by always closing the console as soon as enter is pressed, as keeping it open is unlikely to be useful with a fuzzy selector (unlike with input.get() where it can be used e.g. to implement a Lua REPL). If desired we can later add a close_on_submit flag defaulting to true. Also fix a crash when pressing enter without any match.
2024-05-12 21:17:46 +02:00
if selectable_items then
if #matches > 0 then
mp.commandv('script-message-to', input_caller, 'input-event', 'submit',
utils.format_json({matches[selected_match].index}))
end
set_active(false)
elseif input_caller then
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
mp.commandv('script-message-to', input_caller, 'input-event', 'submit',
console.lua: close when pressing enter with input.select When you select an item, due to the submit handler being called asynchronously, the default item list is redrawn before the console closes, which is jarring. Fix this by always closing the console as soon as enter is pressed, as keeping it open is unlikely to be useful with a fuzzy selector (unlike with input.get() where it can be used e.g. to implement a Lua REPL). If desired we can later add a close_on_submit flag defaulting to true. Also fix a crash when pressing enter without any match.
2024-05-12 21:17:46 +02:00
utils.format_json({line}))
console: add a basic help command It's not really great. But I think it's good enough to save someone who's lost. Most importantly, it should become obvious _what_ the console expects (input commands), and how to exit it. Would be nice if we could show some documentation, or give a link to documentation, but that's out of scope and/or not easy. I considered implementing the "help" command as builtin command in command.c. On the other hand, this could not show console.lua specific help, so I implemented it in console.lua. The ad-hoc command parsing (that sort-of mirrors mpv input command syntax) for the "help" command is probably the worst part of this.
2019-12-24 16:08:04 +01:00
else
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
if selected_completion_index == 0 then
cycle_through_completions()
console.lua: expand the first completion on Enter If you run a command without manually selecting a completion, select the first one. e.g. set vo gn runs set vo gpu-next.
2024-11-23 09:14:18 +01:00
end
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
-- match "help [<text>]", return <text> or "", strip all whitespace
local help = line:match('^%s*help%s+(.-)%s*$') or
(line:match('^%s*help$') and '')
if help then
help_command(help)
else
mp.command(line)
end
console: add a basic help command It's not really great. But I think it's good enough to save someone who's lost. Most importantly, it should become obvious _what_ the console expects (input commands), and how to exit it. Would be nice if we could show some documentation, or give a link to documentation, but that's out of scope and/or not easy. I considered implementing the "help" command as builtin command in command.c. On the other hand, this could not show console.lua specific help, so I implemented it in console.lua. The ad-hoc command parsing (that sort-of mirrors mpv input command syntax) for the "help" command is probably the worst part of this.
2019-12-24 16:08:04 +01:00
end
console.lua: save commands in history after autocompletion 2f271a92de made it so that the first completion suggestion is automatically selected when pressing enter, but that was done after saving the command in the history. Save it to the history after expanding it, so re-running the previous command actually works, e.g. save "set vo gpu-next" instead of "set vo gn".
2024-11-24 10:45:42 +01:00
if history[#history] ~= line and line ~= '' then
history_add(line)
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
clear()
end
console.lua: improve hovered line calculation - Don't do anything if clicking on the top counter, the input line or the new line between the items and the input line - Don't scroll upwards when hovering the counter - Don't redraw before clicking to avoid quickly updating the overlay before closing it with touch input, where the item you touch can be different from the one that was highlighted
2024-10-14 20:01:37 +02:00
local function determine_hovered_item()
console.lua: add scale_with_window script-opt If this is set to yes or auto and --osd-scale-by-window is true, console scales with the window height like everything else in mpv. Defaults to auto.
2024-10-27 07:09:18 +01:00
local height = select(2, get_scaled_osd_dimensions())
console.lua: fix the hovered line calculation without scale with window If not scaling with the window the hidpi scale needs to be factored into mouse-pos. Follow up to a670f75679 and a2106396bc.
2024-10-28 15:34:05 +01:00
local y = mp.get_property_native('mouse-pos').y / scale_factor()
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
local log_bottom_pos = height * (1 - global_margins.b)
console.lua: add margin_{x,y} script-opts Allow configuring the margins from the left bottom indipendently of --osd-margin-{x,y}. Fixes #15478.
2024-12-10 13:05:21 +01:00
- get_margin_y()
console.lua: use OSD margins Now that default OSD margins have been decreased to 15 it is reasonable to let console.lua inherit them for consistency.
2024-11-11 10:41:47 +01:00
- 1.5 * opts.font_size
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
if y > log_bottom_pos then
return
end
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
local max_lines = calculate_max_log_lines()
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
-- Subtract 1 line for the position counter.
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
if #matches > max_lines then
max_lines = max_lines - 1
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
end
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
local last = math.min(first_match_to_print - 1 + max_lines, #matches)
console.lua: print position/count instead of n hidden items This makes it consistent with the new changes to show-text ${playlist} and greatly simplifies the logic, making it sane to implement scrolling the view with the wheel in the commit.
2024-10-11 21:58:41 +02:00
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
local hovered_item = last - math.floor((log_bottom_pos - y) / opts.font_size)
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
console.lua: refine the hovered item calculation Calculate the hovered item from the bottom of the screen where the console is anchored. This is simpler and accurate because it accounts for the fact that the empty line between the log and the input line isn't as tall as a full line, for the exact height of an always visible OSC bottombar, and for the empty top pixels present because the height isn't an integer multiple of the font size.
2024-10-31 09:46:49 +01:00
if hovered_item >= first_match_to_print then
return hovered_item
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
end
end
local function bind_mouse()
console.lua: improve hovered line calculation - Don't do anything if clicking on the top counter, the input line or the new line between the items and the input line - Don't scroll upwards when hovering the counter - Don't redraw before clicking to avoid quickly updating the overlay before closing it with touch input, where the item you touch can be different from the one that was highlighted
2024-10-14 20:01:37 +02:00
mp.add_forced_key_binding('MOUSE_MOVE', '_console_mouse_move', function()
local item = determine_hovered_item()
if item and item ~= selected_match then
selected_match = item
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: improve hovered line calculation - Don't do anything if clicking on the top counter, the input line or the new line between the items and the input line - Don't scroll upwards when hovering the counter - Don't redraw before clicking to avoid quickly updating the overlay before closing it with touch input, where the item you touch can be different from the one that was highlighted
2024-10-14 20:01:37 +02:00
end
end)
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
mp.add_forced_key_binding('MBTN_LEFT', '_console_mbtn_left', function()
console.lua: improve hovered line calculation - Don't do anything if clicking on the top counter, the input line or the new line between the items and the input line - Don't scroll upwards when hovering the counter - Don't redraw before clicking to avoid quickly updating the overlay before closing it with touch input, where the item you touch can be different from the one that was highlighted
2024-10-14 20:01:37 +02:00
local item = determine_hovered_item()
if item then
selected_match = item
handle_enter()
console.lua: exit when left clicking outside of selectable items
2024-10-21 21:33:50 +02:00
else
set_active(false)
console.lua: improve hovered line calculation - Don't do anything if clicking on the top counter, the input line or the new line between the items and the input line - Don't scroll upwards when hovering the counter - Don't redraw before clicking to avoid quickly updating the overlay before closing it with touch input, where the item you touch can be different from the one that was highlighted
2024-10-14 20:01:37 +02:00
end
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
end)
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Go to the specified position in the command history
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function go_history(new_pos)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local old_pos = history_pos
history_pos = new_pos
-- Restrict the position to a legal value
if history_pos > #history + 1 then
history_pos = #history + 1
elseif history_pos < 1 then
history_pos = 1
end
-- Do nothing if the history position didn't actually change
if history_pos == old_pos then
return
end
-- If the user was editing a non-history line, save it as the last history
-- entry. This makes it much less frustrating to accidentally hit Up/Down
-- while editing a line.
if old_pos == #history + 1 and line ~= '' and history[#history] ~= line then
console: add history deduplication Deduplicate history like the fish shell. So for example entering "cmd 1" then "cmd 2" then "cmd 3" then "cmd 1" would result in a history of [cmd 2][cmd 3][cmd 1] instead of [cmd 1][cmd 2][cmd 3][cmd 1] Adds a function `history_add` to replace directly adding to history. Adds an option `history_dedup` to activate the deduplication. Defaults to on.
2022-06-18 03:29:32 +02:00
history_add(line)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Now show the history line (or a blank line for #history + 1)
if history_pos <= #history then
line = history[history_pos]
else
line = ''
end
cursor = line:len() + 1
insert_mode = false
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_edit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- Go to the specified relative position in the command history (Up, Down)
console.lua: make the wheel scroll selectable items instead of the match This makes scrolling with the wheel more usable because it doesn't matter if the focused item is reset by moving the mouse slightly, and scrolling always begins immediately. This makes the MBTN_MID binding to handle_enter() unnecessary so it is removed.
2024-10-12 14:30:56 +02:00
local function move_history(amount, is_wheel)
if is_wheel and selectable_items then
local max_lines = calculate_max_log_lines()
-- Update selected_match only if it's the first or last printed item and
-- there are hidden items.
if (amount > 0 and selected_match == first_match_to_print
and first_match_to_print + max_lines - 2 < #matches)
or (amount < 0 and selected_match == first_match_to_print + max_lines - 2
and first_match_to_print > 1) then
selected_match = selected_match + amount
end
if amount > 0 and first_match_to_print < #matches - max_lines + 2
or amount < 0 and first_match_to_print > 1 then
-- math.min and math.max would only be needed with amounts other than
-- 1 and -1.
first_match_to_print = math.min(
math.max(first_match_to_print + amount, 1), #matches - max_lines + 2)
end
console.lua: update selected item under the cursor on mouse wheel action
2024-10-29 00:47:16 +01:00
local item = determine_hovered_item()
if item then
selected_match = item
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: make the wheel scroll selectable items instead of the match This makes scrolling with the wheel more usable because it doesn't matter if the focused item is reset by moving the mouse slightly, and scrolling always begins immediately. This makes the MBTN_MID binding to handle_enter() unnecessary so it is removed.
2024-10-12 14:30:56 +02:00
return
end
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
if selectable_items then
selected_match = selected_match + amount
if selected_match > #matches then
selected_match = 1
elseif selected_match < 1 then
selected_match = #matches
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
return
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
go_history(history_pos + amount)
end
-- Go to the first command in the command history (PgUp)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_pgup()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
if selectable_items then
console.lua: use all available lines for selection Refine populate_log_with_matches()'s logic to not reserve 2 lines for "n hidden items" when it is not necessary. This avoids printing "1 hidden items", and doesn't leave an empty line when there are hidden items only in one direction.
2024-05-14 22:09:30 +02:00
selected_match = math.max(selected_match - calculate_max_log_lines() + 2, 1)
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
return
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
go_history(1)
end
-- Stop browsing history and start editing a blank line (PgDown)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function handle_pgdown()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
if selectable_items then
console.lua: use all available lines for selection Refine populate_log_with_matches()'s logic to not reserve 2 lines for "n hidden items" when it is not necessary. This avoids printing "1 hidden items", and doesn't leave an empty line when there are hidden items only in one direction.
2024-05-14 22:09:30 +02:00
selected_match = math.min(selected_match + calculate_max_log_lines() - 2, #matches)
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
return
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
go_history(#history + 1)
end
console.lua: implement history search
2024-08-14 18:18:48 +02:00
local function search_history()
if selectable_items or #history == 0 then
return
end
searching_history = true
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer = {}
console.lua: implement history search
2024-08-14 18:18:48 +02:00
selectable_items = {}
for i = 1, #history do
selectable_items[i] = history[#history + 1 - i]
console.lua: pre-filter searched commands if the line is filled If you type something before pressing Ctrl+r, filter the commands containing the typed line. fuzzy_find() is modified to not code a separate case when the line is empty in both handle_edit() or search_history().
2024-08-23 19:12:38 +02:00
end
console.lua: remove code repetition to initialize matches
2024-12-05 17:54:32 +01:00
handle_edit()
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
bind_mouse()
console.lua: implement history search
2024-08-14 18:18:48 +02:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function page_up_or_prev_char()
if selectable_items then
handle_pgup()
else
prev_char()
end
end
local function page_down_or_next_char()
if selectable_items then
handle_pgdown()
else
next_char()
end
end
-- Move to the start of the current word, or if already at the start, the start
-- of the previous word. (Ctrl+Left)
local function prev_word()
-- This is basically the same as next_word() but backwards, so reverse the
-- string in order to do a "backwards" find. This wouldn't be as annoying
-- to do if Lua didn't insist on 1-based indexing.
cursor = line:len() - select(2, line:reverse():find('%s*[^%s]*', line:len() - cursor + 2)) + 1
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
-- Move to the end of the current word, or if already at the end, the end of
-- the next word. (Ctrl+Right)
local function next_word()
cursor = select(2, line:find('%s*[^%s]*', cursor)) + 1
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
-- Move the cursor to the beginning of the line (HOME)
local function go_home()
cursor = 1
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
-- Move the cursor to the end of the line (END)
local function go_end()
cursor = line:len() + 1
console.lua: update completions after moving the cursor ...and after navigating the history. I thought of making the new function accept the new cursor position and set it, but it would not be clear that you're only supposed to call it when handle_edit() is not already called.
2024-11-24 12:13:51 +01:00
handle_cursor_move()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
-- Delete from the cursor to the beginning of the word (Ctrl+Backspace)
local function del_word()
local before_cur = line:sub(1, cursor - 1)
local after_cur = line:sub(cursor)
before_cur = before_cur:gsub('[^%s]+%s*$', '', 1)
line = before_cur .. after_cur
cursor = before_cur:len() + 1
handle_edit()
end
-- Delete from the cursor to the end of the word (Ctrl+Del)
local function del_next_word()
if cursor > line:len() then return end
local before_cur = line:sub(1, cursor - 1)
local after_cur = line:sub(cursor)
after_cur = after_cur:gsub('^%s*[^%s]+', '', 1)
line = before_cur .. after_cur
handle_edit()
end
-- Delete from the cursor to the end of the line (Ctrl+K)
local function del_to_eol()
line = line:sub(1, cursor - 1)
handle_edit()
end
-- Delete from the cursor back to the start of the line (Ctrl+U)
local function del_to_start()
line = line:sub(cursor)
cursor = 1
handle_edit()
end
-- Empty the log buffer of all messages (Ctrl+L)
local function clear_log_buffer()
log_buffers[id] = {}
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
-- Returns a string of UTF-8 text from the clipboard (or the primary selection)
local function get_clipboard(clip)
if platform == 'x11' then
local res = utils.subprocess({
args = { 'xclip', '-selection', clip and 'clipboard' or 'primary', '-out' },
playback_only = false,
})
if not res.error then
return res.stdout
end
elseif platform == 'wayland' then
console.lua: use clipboard property for native Wayland backend This backend does not require the window focus quirk handling, and also supports primary selection.
2025-01-18 01:27:23 -05:00
if mp.get_property('current-clipboard-backend') == 'wayland' then
local property = clip and 'clipboard/text' or 'clipboard/text-primary'
return mp.get_property(property, '')
end
-- Wayland VO clipboard is only updated on window focus
console.lua: use native clipboard property on win32 and wayland Since native clipboard is implemented on win32 and wayland, use the clipboard property instead. This fixes the problems with commandline implementations of clipboard: - On win32, the powershell implementation is complex, and it can take several seconds to run for the first time. - On wayland, it requires wl-paste to be installed, which isn't always available. It also works poorly on GNOME.
2024-11-22 03:47:25 -05:00
if clip and mp.get_property_native('focused') then
return mp.get_property('clipboard/text', '')
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local res = utils.subprocess({
args = { 'wl-paste', clip and '-n' or '-np' },
playback_only = false,
})
if not res.error then
return res.stdout
end
console.lua: use native clipboard property on macOS
2024-12-23 14:27:42 +01:00
elseif platform == 'windows' or platform == 'darwin' then
console.lua: use native clipboard property on win32 and wayland Since native clipboard is implemented on win32 and wayland, use the clipboard property instead. This fixes the problems with commandline implementations of clipboard: - On win32, the powershell implementation is complex, and it can take several seconds to run for the first time. - On wayland, it requires wl-paste to be installed, which isn't always available. It also works poorly on GNOME.
2024-11-22 03:47:25 -05:00
return mp.get_property('clipboard/text', '')
console.lua: fix ctrl+f and ctrl+b keybindings With mp.input.select() these keybindings were both scrolling and moving the cursor because of how the condition was written and handle_pgup()/handle_pgdown() not returning a truthy value.
2024-05-11 19:38:30 +02:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
return ''
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- Paste text from the window-system's clipboard. 'clip' determines whether the
-- clipboard or the primary selection buffer is used (on X11 and Wayland only.)
console.lua: make the wheel scroll selectable items instead of the match This makes scrolling with the wheel more usable because it doesn't matter if the focused item is reset by moving the mouse slightly, and scrolling always begins immediately. This makes the MBTN_MID binding to handle_enter() unnecessary so it is removed.
2024-10-12 14:30:56 +02:00
local function paste(clip)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local text = get_clipboard(clip)
local before_cur = line:sub(1, cursor - 1)
local after_cur = line:sub(cursor)
line = before_cur .. text .. after_cur
cursor = cursor + text:len()
handle_edit()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function text_input(info)
if info.key_text and (info.event == "press" or info.event == "down"
or info.event == "repeat")
then
handle_char_input(info.key_text)
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: generate completion lists lazily This will allow providing more nested completions without pre-generating an enormous amount of completions, and it is more efficient since it only generates the completions needed for each completion attempt.
2023-10-11 17:10:58 +02:00
local function command_list()
local commands = {}
for i, command in ipairs(mp.get_property_native('command-list')) do
commands[i] = command.name
end
return commands
end
local function property_list()
local properties = mp.get_property_native('property-list')
console.lua: complete current-tracks sub-properties Also inline option-info's sub-properties so we don't have to define sub-properties at the top of the function for every one we decide to complete.
2023-12-05 23:22:13 +01:00
for _, sub_property in pairs({'video', 'audio', 'sub', 'sub2'}) do
properties[#properties + 1] = 'current-tracks/' .. sub_property
end
console.lua: autocomplete clipboard/text-primary property
2025-01-18 00:47:07 -05:00
for _, sub_property in pairs({'text', 'text-primary'}) do
console.lua: complete clipboard/text
2024-12-28 14:06:30 +01:00
properties[#properties + 1] = 'clipboard/' .. sub_property
end
console.lua: generate completion lists lazily This will allow providing more nested completions without pre-generating an enormous amount of completions, and it is more efficient since it only generates the completions needed for each completion attempt.
2023-10-11 17:10:58 +02:00
return properties
end
console.lua: complete profiles
2023-10-15 12:16:55 +02:00
local function profile_list()
local profiles = {}
for i, profile in ipairs(mp.get_property_native('profile-list')) do
profiles[i] = profile.name
end
return profiles
end
console.lua: complete list options
2023-10-15 12:51:13 +02:00
local function list_option_list()
local options = {}
-- Don't log errors for renamed and removed properties.
-- (Just mp.enable_messages('fatal') still logs them to the terminal.)
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 _, option in pairs(mp.get_property_native('options')) do
if mp.get_property('option-info/' .. option .. '/type', ''):find(' list$') then
options[#options + 1] = option
end
end
mp.set_property('msg-level', msg_level_backup)
return options
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local function list_option_action_list(option)
console.lua: complete list option verbs
2023-10-17 15:32:49 +02:00
local type = mp.get_property('option-info/' .. option .. '/type')
if type == 'Key/value list' then
return {'add', 'append', 'set', 'remove'}
end
if type == 'String list' or type == 'Object settings list' then
return {'add', 'append', 'clr', 'pre', 'set', 'remove', 'toggle'}
end
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local function list_option_value_list(option)
console.lua: fix completing change-list ao/vo/gpu-context remove The value of list options is a table not just for vf and af but for all object settings lists. Extract just the names from the tables returned when retrieving these options.
2024-05-20 14:04:36 +02:00
local values = mp.get_property_native(option)
if type(values) ~= 'table' then
return
console.lua: complete choice and flag options
2023-10-21 23:56:47 +02:00
end
console.lua: fix completing change-list ao/vo/gpu-context remove The value of list options is a table not just for vf and af but for all object settings lists. Extract just the names from the tables returned when retrieving these options.
2024-05-20 14:04:36 +02:00
if type(values[1]) ~= 'table' then
return values
end
console.lua: complete choice and flag options
2023-10-21 23:56:47 +02:00
console.lua: fix completing change-list ao/vo/gpu-context remove The value of list options is a table not just for vf and af but for all object settings lists. Extract just the names from the tables returned when retrieving these options.
2024-05-20 14:04:36 +02:00
for i, value in ipairs(values) do
values[i] = value.label and '@' .. value.label or value.name
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
end
console.lua: fix completing change-list ao/vo/gpu-context remove The value of list options is a table not just for vf and af but for all object settings lists. Extract just the names from the tables returned when retrieving these options.
2024-05-20 14:04:36 +02:00
return values
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
local function has_file_argument(candidate_command)
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
for _, command in pairs(mp.get_property_native('command-list')) do
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
if command.name == candidate_command then
return command.args[1] and
(command.args[1].name == 'filename' or command.args[1].name == 'url')
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
end
end
end
local function file_list(directory)
if directory == '' then
directory = '.'
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
else
directory = mp.command_native({'expand-path', directory})
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
end
local files = utils.readdir(directory, 'files') or {}
for _, dir in pairs(utils.readdir(directory, 'dirs') or {}) do
files[#files + 1] = dir .. path_separator
end
return files
end
console.lua: remove code repetition in complete()
2024-11-30 10:40:27 +01:00
local function handle_file_completion(before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local directory, last_component_pos =
console.lua: remove code repetition in complete()
2024-11-30 10:40:27 +01:00
before_cur:sub(completion_pos):match('(.-)()[^' .. path_separator ..']*$')
console.lua: remove repetition from build_completers()
2023-10-11 17:36:20 +02:00
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completion_pos = completion_pos + last_component_pos - 1
console.lua: remove repetition from build_completers()
2023-10-11 17:36:20 +02:00
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
-- Don't use completion_append for file completion to not add quotes after
-- directories whose entries you may want to complete afterwards.
completion_append = ''
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
return file_list(directory)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
console.lua: remove code repetition in complete()
2024-11-30 10:40:27 +01:00
local function handle_choice_completion(option, before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local info = mp.get_property_native('option-info/' .. option, {})
if info.type == 'Flag' then
return { 'no', 'yes' }, before_cur
console.lua: complete file paths
2023-11-01 18:36:46 +01:00
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
if info['expects-file'] then
console.lua: remove code repetition in complete()
2024-11-30 10:40:27 +01:00
return handle_file_completion(before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
console.lua: fix completing empty --dscale and --cscale These options accept an empty value within their choices. If the user didn't add manually input a quote before completing them, add quotes automatically so that the blank value can actually be used.
2024-09-14 16:47:07 +02:00
-- Fix completing the empty value for --dscale and --cscale.
if info.choices and info.choices[1] == '' and completion_append == '' then
info.choices[1] = '""'
end
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
return info.choices
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: complete command flags
2024-11-30 11:55:41 +01:00
local function command_flags_at_1st_argument_list(command)
local flags = {
['playlist-next'] = {'weak', 'force'},
console.lua: complete playlist-play-index none
2024-12-31 14:59:29 +01:00
['playlist-play-index'] = {'current', 'none'},
console.lua: complete command flags
2024-11-30 11:55:41 +01:00
['playlist-remove'] = {'current'},
['rescan-external-files'] = {'reselect', 'keep-selection'},
['revert-seek'] = {'mark', 'mark-permanent'},
['screenshot'] = {'subtitles', 'video', 'window', 'each-frame'},
['stop'] = {'keep-playlist'},
}
flags['playlist-prev'] = flags['playlist-next']
flags['screenshot-raw'] = flags.screenshot
return flags[command]
end
local function command_flags_at_2nd_argument_list(command)
local flags = {
['apply-profile'] = {'default', 'restore'},
['loadfile'] = {'replace', 'append', 'append-play', 'insert-next',
'insert-next-play', 'insert-at', 'insert-at-play'},
['screenshot-to-file'] = {'subtitles', 'video', 'window', 'each-frame'},
console.lua: complete screenshot-raw format parameter
2025-01-05 11:32:37 -05:00
['screenshot-raw'] = {'bgr0', 'bgra', 'rgba', 'rgba64'},
console.lua: complete command flags
2024-11-30 11:55:41 +01:00
['seek'] = {'relative', 'absolute', 'absolute-percent',
'relative-percent', 'keyframes', 'exact'},
['sub-add'] = {'select', 'auto', 'cached'},
['sub-seek'] = {'primary', 'secondary'},
}
flags.loadlist = flags.loadfile
flags['audio-add'] = flags['sub-add']
flags['video-add'] = flags['sub-add']
flags['sub-step'] = flags['sub-seek']
return flags[command]
end
console.lua: complete executables after run
2024-11-30 12:40:05 +01:00
local function list_executables()
local executable_map = {}
local path = os.getenv('PATH') or ''
local separator = platform == 'windows' and ';' or ':'
console.lua: don't complete DLLs on Windows run completion on Windows is slow because system32 contains thousands of DLLs, so filter executables with an extension in PATHEXT.
2024-12-02 11:29:41 +01:00
local exts = {}
for ext in (os.getenv('PATHEXT') or ''):gmatch('[^;]+') do
exts[ext:lower()] = true
end
console.lua: complete executables after run
2024-11-30 12:40:05 +01:00
for directory in path:gmatch('[^' .. separator .. ']+') do
for _, executable in pairs(utils.readdir(directory, 'files') or {}) do
console.lua: don't complete DLLs on Windows run completion on Windows is slow because system32 contains thousands of DLLs, so filter executables with an extension in PATHEXT.
2024-12-02 11:29:41 +01:00
if not next(exts) or exts[(executable:match('%.%w+$') or ''):lower()] then
executable_map[executable] = true
end
console.lua: complete executables after run
2024-11-30 12:40:05 +01:00
end
end
local executables = {}
for executable, _ in pairs(executable_map) do
executables[#executables + 1] = executable
end
return executables
end
console.lua: complete filter labels for {a,v}f-command
2024-11-30 12:09:49 +01:00
local function list_filter_labels(type)
local values = {'all'}
for _, value in pairs(mp.get_property_native(type)) do
if value.label then
values[#values + 1] = value.label
end
end
return values
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function common_prefix_length(s1, s2)
console.lua: move functions to strip common characters Move common_prefix_length() and related functions before the first call to common_prefix_length(). It works now because it's global but if we ever make all functions local for consistency it will stop working.
2024-02-05 10:58:28 +01:00
local common_count = 0
for i = 1, #s1 do
if s1:byte(i) ~= s2:byte(i) then
break
end
common_count = common_count + 1
end
return common_count
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function max_overlap_length(s1, s2)
console.lua: move functions to strip common characters Move common_prefix_length() and related functions before the first call to common_prefix_length(). It works now because it's global but if we ever make all functions local for consistency it will stop working.
2024-02-05 10:58:28 +01:00
for s1_offset = 0, #s1 - 1 do
local match = true
for i = 1, #s1 - s1_offset do
if s1:byte(s1_offset + i) ~= s2:byte(i) then
match = false
break
end
end
if match then
return #s1 - s1_offset
end
end
return 0
end
-- If str starts with the first or last characters of prefix, strip them.
local function strip_common_characters(str, prefix)
return str:sub(1 + math.max(
common_prefix_length(prefix, str),
max_overlap_length(prefix, str)))
end
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
cycle_through_completions = function (backwards)
if #completion_buffer == 0 then
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
-- Allow Tab completion of commands before typing anything.
if line == '' then
complete()
end
console.lua: implement case-insensitive completion This is useful for completing files and more rarely for profiles. It will also be useful to third-party scripts interacting with the console once the API to do it is merged.
2023-11-29 19:14:47 +01:00
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
return
console.lua: implement case-insensitive completion This is useful for completing files and more rarely for profiles. It will also be useful to third-party scripts interacting with the console once the API to do it is merged.
2023-11-29 19:14:47 +01:00
end
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
selected_completion_index = selected_completion_index + (backwards and -1 or 1)
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
if selected_completion_index > #completion_buffer then
selected_completion_index = 1
elseif selected_completion_index < 1 then
selected_completion_index = #completion_buffer
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local before_cur = line:sub(1, completion_pos - 1) ..
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer[selected_completion_index] .. completion_append
console.lua: don't reinsert the next characters on complete This avoids inserting the characters in front of the cursor again when completing to text already in front of the cursor. This is important after 2f271a92de made Enter automatically insert the first completion.
2024-12-02 19:52:32 +01:00
line = before_cur .. strip_common_characters(line:sub(cursor),
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer[selected_completion_index] .. completion_append)
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
cursor = before_cur:len() + 1
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: cycle through completions
2023-11-25 18:30:49 +01:00
end
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
-- Show autocompletions.
complete = function ()
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
if input_caller then
completion_old_line = line
completion_old_cursor = cursor
mp.commandv('script-message-to', input_caller, 'input-event',
console.lua: don't convert integers for mp.input to string I misunderstood CogentRedTester's review in https://github.com/mpv-player/mpv/pull/10282#discussion_r1428972352 as referring to the cursor_position in mp.input's arguments instead of the one received by the closed callback. The cursor_position passed to input.get doesn't need to be converted to a number because it was already JSON, while the cursor_position received by the closed callback is currently a string, and we need to pass JSON in input-event script messages to keep it as an integer to work around mpv converting integer script message arguments to string. This is more noticeable after implementing mp.input.select(): its submit argument currently receives the selected index as a string, and this makes Lua error if you use it as an index of a numerical table, e.g.: submit = function (id) mp.set_property(property, tracks[tonumber(id)].selected and "no" or tracks[tonumber(id)].id) ... end, This commit avoids having to call tonumber(id).
2024-05-08 10:22:39 +02:00
'complete', utils.format_json({line:sub(1, cursor - 1)}))
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
return
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
local before_cur = line:sub(1, cursor - 1)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local tokens = {}
local first_useful_token_index = 1
local completions
local begin_new_token = true
local last_quote
for pos, char in before_cur:gmatch('()(.)') do
if char:find('[%s;]') and not last_quote then
begin_new_token = true
if char == ';' then
first_useful_token_index = #tokens + 1
end
elseif begin_new_token then
tokens[#tokens + 1] = { text = char, pos = pos }
last_quote = char:match('["\']')
begin_new_token = false
else
tokens[#tokens].text = tokens[#tokens].text .. char
if char == last_quote then
last_quote = nil
end
end
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
completion_append = last_quote or ''
-- Strip quotes from tokens.
for _, token in pairs(tokens) do
if token.text:find('^"') then
token.text = token.text:sub(2):gsub('"$', '')
token.pos = token.pos + 1
elseif token.text:find("^'") then
token.text = token.text:sub(2):gsub("'$", '')
token.pos = token.pos + 1
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
console.lua: complete choice and flag options
2023-10-21 23:56:47 +02:00
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
-- Skip command prefixes because it is not worth lumping them together with
-- command completions when they are useless for interactive usage.
local command_prefixes = {
['osd-auto'] = true, ['no-osd'] = true, ['osd-bar'] = true,
['osd-msg'] = true, ['osd-msg-bar'] = true, ['raw'] = true,
console.lua: add nonrepeatable prefix to command_prefixes
2024-05-18 02:55:03 -04:00
['expand-properties'] = true, ['repeatable'] = true,
console.lua: add nonscalable prefix to command_prefixes
2024-10-13 14:28:49 -04:00
['nonrepeatable'] = true, ['nonscalable'] = true,
['async'] = true, ['sync'] = true
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
}
console.lua: expand ~/ in file completion Makes Tab expand loadfile ~/ to loadfile /home/$USER/. I used expand-path instead of os.getenv('HOME') to make it work on Windows.
2023-12-25 22:14:56 +01:00
console.lua: fix completion after command prefixes I'm not sure when this broke but completions after command prefixes were not being updated.
2025-02-06 10:59:18 +01:00
-- Add an empty token if the cursor is after whitespace or ; to simplify
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
-- comparisons.
console.lua: fix crash with set ;<Tab> Fixes https://github.com/mpv-player/mpv/pull/14247#issuecomment-2134418206
2024-05-28 08:23:19 +02:00
if before_cur == '' or before_cur:find('[%s;]$') then
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
tokens[#tokens + 1] = { text = "", pos = cursor }
console.lua: fix completion after command prefixes I'm not sure when this broke but completions after command prefixes were not being updated.
2025-02-06 10:59:18 +01:00
end
while tokens[first_useful_token_index] and
command_prefixes[tokens[first_useful_token_index].text] do
if first_useful_token_index == #tokens then
completion_buffer = {}
render()
return
end
first_useful_token_index = first_useful_token_index + 1
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
console.lua: remove code repetition in complete()
2024-11-30 10:40:27 +01:00
completion_pos = tokens[#tokens].pos
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
local add_actions = {
['add'] = true, ['append'] = true, ['pre'] = true, ['set'] = true
}
local first_useful_token = tokens[first_useful_token_index]
console.lua: remove code repetition in complete()
2024-11-30 10:40:27 +01:00
local property_pos = before_cur:match('${[=>]?()[%w_/-]*$')
if property_pos then
completion_pos = property_pos
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
completions = property_list()
console.lua: don't append spaces after completion After pressing Tab a space is usually appended after the suggestion, and with the new autocompletion you have to enter a space again before seeing the completions for the next token even when there is only 1 matching completion. Just don't append spaces and let the user manually type 1 space after completion, which is more intuitive.
2024-11-25 16:06:36 +01:00
completion_append = '}'
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif #tokens == first_useful_token_index then
completions = command_list()
completions[#completions + 1] = 'help'
elseif #tokens == first_useful_token_index + 1 then
if first_useful_token.text == 'set' or
first_useful_token.text == 'add' or
first_useful_token.text == 'cycle' or
first_useful_token.text == 'cycle-values' or
first_useful_token.text == 'multiply' then
completions = property_list()
elseif first_useful_token.text == 'help' then
completions = command_list()
elseif first_useful_token.text == 'apply-profile' then
completions = profile_list()
elseif first_useful_token.text == 'change-list' then
completions = list_option_list()
console.lua: complete executables after run
2024-11-30 12:40:05 +01:00
elseif first_useful_token.text == 'run' then
completions = list_executables()
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif first_useful_token.text == 'vf' or
first_useful_token.text == 'af' then
completions = list_option_action_list(first_useful_token.text)
console.lua: complete filter labels for {a,v}f-command
2024-11-30 12:09:49 +01:00
elseif first_useful_token.text == 'vf-command' or
first_useful_token.text == 'af-command' then
completions = list_filter_labels(first_useful_token.text:sub(1,2))
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif has_file_argument(first_useful_token.text) then
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completions = handle_file_completion(before_cur)
console.lua: complete command flags
2024-11-30 11:55:41 +01:00
else
completions = command_flags_at_1st_argument_list(first_useful_token.text)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
elseif first_useful_token.text == 'cycle-values' then
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completions = handle_choice_completion(tokens[first_useful_token_index + 1].text,
before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif #tokens == first_useful_token_index + 2 then
if first_useful_token.text == 'set' then
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completions = handle_choice_completion(tokens[first_useful_token_index + 1].text,
before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif first_useful_token.text == 'change-list' then
completions = list_option_action_list(tokens[first_useful_token_index + 1].text)
elseif first_useful_token.text == 'vf' or
first_useful_token.text == 'af' then
if add_actions[tokens[first_useful_token_index + 1].text] then
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completions = handle_choice_completion(first_useful_token.text, before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif tokens[first_useful_token_index + 1].text == 'remove' then
completions = list_option_value_list(first_useful_token.text)
end
console.lua: complete command flags
2024-11-30 11:55:41 +01:00
else
completions = command_flags_at_2nd_argument_list(first_useful_token.text)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
elseif #tokens == first_useful_token_index + 3 then
if first_useful_token.text == 'change-list' then
if add_actions[tokens[first_useful_token_index + 2].text] then
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completions = handle_choice_completion(tokens[first_useful_token_index + 1].text,
before_cur)
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif tokens[first_useful_token_index + 2].text == 'remove' then
completions = list_option_value_list(tokens[first_useful_token_index + 1].text)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
elseif first_useful_token.text == 'dump-cache' then
console.lua: stop expanding ~/ in file completion It is not needed to expand ~ in file completion as you type after 62c3aeb9c made commands themselves interpret it. We only need to call expand-path on the directory before passing it to utils.readdir in order to find files in it when it contains ~ placeholders. As a bonus this will now also complete files in directories like ~~/ and ~state/. This simplifies command completion, and was also the blocker for splitting running commands out of console.lua, since I didn't know how to replicate it through mp.input.
2025-01-31 10:44:17 +01:00
completions = handle_file_completion(before_cur)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
end
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer = {}
selected_completion_index = 0
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
completions = completions or {}
console.lua: sort completions With the previous commit, this sorts completions with the same score alphabetically.
2025-01-19 18:09:43 +01:00
table.sort(completions)
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
completion_pos = completion_pos or 1
for i, match in ipairs(fuzzy_find(before_cur:sub(completion_pos),
completions, opts.case_sensitive)) do
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer[i] = completions[match]
console.lua: implement a command parser to complete more things This allows more completions than patterns: Both single and double quotes are recognized. Quotes around the first token are recognized. Command prefixes are recognized. Choice options are completed after change-list/vf/af add/append/pre/set. File paths are completed after set/cycle-values/change-list with options that expect files, including cycling between paths with spaces, e.g. cycle-values glsl-shaders 'foo bar' 'baz qux'. File paths are completed in the fourth argument of dump-cache. Items that have been set are completed after change-list remove.
2024-05-12 22:01:01 +02:00
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
-- List of input bindings. This is a weird mashup between common GUI text-input
-- bindings and readline bindings.
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function get_bindings()
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
local bindings = {
{ 'esc', function() set_active(false) end },
console.lua: exit with with Ctrl+[ This binding commonly closes similar input buffers like vim's Command-line mode and dmenu.
2023-10-10 08:33:08 +02:00
{ 'ctrl+[', function() set_active(false) end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'enter', handle_enter },
{ 'kp_enter', handle_enter },
{ 'shift+enter', function() handle_char_input('\n') end },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+j', handle_enter },
{ 'ctrl+m', handle_enter },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'bs', handle_backspace },
{ 'shift+bs', handle_backspace },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+h', handle_backspace },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'del', handle_del },
{ 'shift+del', handle_del },
{ 'ins', handle_ins },
{ 'shift+ins', function() paste(false) end },
console.lua: make the wheel scroll selectable items instead of the match This makes scrolling with the wheel more usable because it doesn't matter if the focused item is reset by moving the mouse slightly, and scrolling always begins immediately. This makes the MBTN_MID binding to handle_enter() unnecessary so it is removed.
2024-10-12 14:30:56 +02:00
{ 'mbtn_mid', function() paste(false) end },
console.lua: close with right click Useful to close the console after it was opened with the mouse. Also fix the spacing of the previous line.
2024-10-09 17:01:17 +02:00
{ 'mbtn_right', function() set_active(false) end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'left', function() prev_char() end },
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
{ 'ctrl+b', function() page_up_or_prev_char() end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'right', function() next_char() end },
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
{ 'ctrl+f', function() page_down_or_next_char() end},
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'up', function() move_history(-1) end },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+p', function() move_history(-1) end },
console.lua: make the wheel scroll selectable items instead of the match This makes scrolling with the wheel more usable because it doesn't matter if the focused item is reset by moving the mouse slightly, and scrolling always begins immediately. This makes the MBTN_MID binding to handle_enter() unnecessary so it is removed.
2024-10-12 14:30:56 +02:00
{ 'wheel_up', function() move_history(-1, true) end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'down', function() move_history(1) end },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+n', function() move_history(1) end },
console.lua: make the wheel scroll selectable items instead of the match This makes scrolling with the wheel more usable because it doesn't matter if the focused item is reset by moving the mouse slightly, and scrolling always begins immediately. This makes the MBTN_MID binding to handle_enter() unnecessary so it is removed.
2024-10-12 14:30:56 +02:00
{ 'wheel_down', function() move_history(1, true) end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'wheel_left', function() end },
{ 'wheel_right', function() end },
{ 'ctrl+left', prev_word },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'alt+b', prev_word },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'ctrl+right', next_word },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'alt+f', next_word },
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
{ 'tab', cycle_through_completions },
{ 'ctrl+i', cycle_through_completions },
{ 'shift+tab', function() cycle_through_completions(true) end },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+a', go_home },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'home', go_home },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+e', go_end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'end', go_end },
{ 'pgup', handle_pgup },
{ 'pgdwn', handle_pgdown },
console.lua: implement history search
2024-08-14 18:18:48 +02:00
{ 'ctrl+r', search_history },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'ctrl+c', clear },
{ 'ctrl+d', maybe_exit },
{ 'ctrl+k', del_to_eol },
{ 'ctrl+l', clear_log_buffer },
{ 'ctrl+u', del_to_start },
{ 'ctrl+v', function() paste(true) end },
{ 'meta+v', function() paste(true) end },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+bs', del_word },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'ctrl+w', del_word },
console.lua: define remaining emacs keybindings
2021-10-31 11:30:25 +01:00
{ 'ctrl+del', del_next_word },
{ 'alt+d', del_next_word },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
{ 'kp_dec', function() handle_char_input('.') end },
console.lua: add numpad + - * / keybindings numpad + - * / was remapped to KP_ADD/KP_SUBTRACT/KP_MULTIPLY/KP_DIVIDE in #14660
2024-08-20 18:21:18 +08:00
{ 'kp_add', function() handle_char_input('+') end },
{ 'kp_subtract', function() handle_char_input('-') end },
{ 'kp_multiply', function() handle_char_input('*') end },
{ 'kp_divide', function() handle_char_input('/') end },
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
}
for i = 0, 9 do
bindings[#bindings + 1] =
{'kp' .. i, function() handle_char_input('' .. i) end}
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
return bindings
console: manually map numeric keypad (KP*) bindings While mpv normally uses the text a key produces (as opposed to physical key mappings), this is different with the keypad. This is for the sake of making it possible to distinguish between these keys and the normal number keys on the left side of a full size keyboard. There were complaints that the keypad doesn't interact with console.lua, so manually map them. This ignores numlock (behaves as if it's always on), and maps KP_DEC to "." (even though it's mapped to "," on some keyboards). The /*-+ keys produce ASCII on mpv (at least with X11) as an inexplicable inconsistency, so there are no mappings for these. Fixes: #7431
2020-02-07 13:51:25 +01:00
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function define_key_bindings()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
if #key_bindings > 0 then
return
end
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
for _, bind in ipairs(get_bindings()) do
stats.lua: scroll keybindings while filtering them console.lua binds up and down to navigate its history. Add a private flag to mp.input.get to instruct console.lua not to bind up and down, so you can use them to scroll the keybindings page while filtering keybindings. If it is requested, this can be replaced with an argument to input.get to not bind arbitrary keys. Fixes #14966.
2024-10-01 20:53:47 +02:00
if not (dont_bind_up_down and (bind[1] == 'up' or bind[1] == 'down')) then
-- Generate arbitrary name for removing the bindings later.
local name = "_console_" .. (#key_bindings + 1)
key_bindings[#key_bindings + 1] = name
mp.add_forced_key_binding(bind[1], name, bind[2], {repeatable = true})
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end
mp.add_forced_key_binding("any_unicode", "_console_text", text_input,
{repeatable = true, complex = true})
key_bindings[#key_bindings + 1] = "_console_text"
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
local function undefine_key_bindings()
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
for _, name in ipairs(key_bindings) do
mp.remove_key_binding(name)
end
key_bindings = {}
end
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
-- Set the REPL visibility ("enable", Esc)
set_active = function (active)
if active == repl_active then return end
if active then
repl_active = true
insert_mode = false
define_key_bindings()
console.lua: add user-data/mpv/console/open Fixes #15762.
2025-01-30 20:18:58 +01:00
mp.set_property_bool('user-data/mpv/console/open', true)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
if not input_caller then
prompt = default_prompt
id = default_id
history = histories[id]
history_pos = #history + 1
mp.enable_messages('terminal-default')
end
console.lua: implement history search
2024-08-14 18:18:48 +02:00
elseif searching_history then
searching_history = false
line = ''
cursor = 1
selectable_items = nil
log_buffers[id] = {}
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
unbind_mouse()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
else
repl_active = false
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer = {}
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
undefine_key_bindings()
mp.enable_messages('silent:terminal-default')
console.lua: add user-data/mpv/console/open Fixes #15762.
2025-01-30 20:18:58 +01:00
mp.set_property_bool('user-data/mpv/console/open', false)
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
if input_caller then
mp.commandv('script-message-to', input_caller, 'input-event',
'closed', utils.format_json({line, cursor}))
input_caller = nil
line = ''
cursor = 1
selectable_items = nil
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
default_item = nil
stats.lua: scroll keybindings while filtering them console.lua binds up and down to navigate its history. Add a private flag to mp.input.get to instruct console.lua not to bind up and down, so you can use them to scroll the keybindings page while filtering keybindings. If it is requested, this can be replaced with an argument to input.get to not bind arbitrary keys. Fixes #14966.
2024-10-01 20:53:47 +02:00
dont_bind_up_down = false
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
unbind_mouse()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
collectgarbage()
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end
-- Show the repl if hidden and replace its contents with 'text'
-- (script-message-to repl type)
local function show_and_type(text, cursor_pos)
text = text or ''
cursor_pos = tonumber(cursor_pos)
-- Save the line currently being edited, just in case
if line ~= text and line ~= '' and history[#history] ~= line then
history_add(line)
end
line = text
if cursor_pos ~= nil and cursor_pos >= 1
and cursor_pos <= line:len() + 1 then
cursor = math.floor(cursor_pos)
else
cursor = line:len() + 1
end
history_pos = #history + 1
insert_mode = false
if repl_active then
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
else
set_active(true)
end
end
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Add a global binding for enabling the REPL. While it's enabled, its bindings
-- will take over and it can be closed with ESC.
mp.add_key_binding(nil, 'enable', function()
set_active(true)
end)
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
mp.register_script_message('disable', function()
set_active(false)
end)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Add a script-message to show the REPL and fill it with the provided text
console: let type set the cursor position This allows keybindings such as: a script-message-to console type "seek :0 absolute" 6 % script-message-to console type "seek absolute-percent" 6 The cursor position 0 isn't allowed because it has the weird effect of filling the console with the text twice, leaving the cursor in the middle. Negative positions would put the cursor n characters before the end, and positions greater than the text's length at the end. They seem to work at first, but the console breaks when you move the cursor, so they aren't allowed. It seems that float values don't cause issues, but I'm using the argument's floor anyway to be safe. Using >= 1 instead of > 0 ignores values like 0.5.
2020-03-27 14:46:39 +01:00
mp.register_script_message('type', function(text, cursor_pos)
show_and_type(text, cursor_pos)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end)
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
mp.register_script_message('get-input', function (script_name, args)
if repl_active then
return
end
input_caller = script_name
args = utils.parse_json(args)
prompt = args.prompt or default_prompt
line = args.default_text or ''
console.lua: don't convert integers for mp.input to string I misunderstood CogentRedTester's review in https://github.com/mpv-player/mpv/pull/10282#discussion_r1428972352 as referring to the cursor_position in mp.input's arguments instead of the one received by the closed callback. The cursor_position passed to input.get doesn't need to be converted to a number because it was already JSON, while the cursor_position received by the closed callback is currently a string, and we need to pass JSON in input-event script messages to keep it as an integer to work around mpv converting integer script message arguments to string. This is more noticeable after implementing mp.input.select(): its submit argument currently receives the selected index as a string, and this makes Lua error if you use it as an index of a numerical table, e.g.: submit = function (id) mp.set_property(property, tracks[tonumber(id)].selected and "no" or tracks[tonumber(id)].id) ... end, This commit avoids having to call tonumber(id).
2024-05-08 10:22:39 +02:00
cursor = args.cursor_position or line:len() + 1
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
id = args.id or script_name .. prompt
stats.lua: scroll keybindings while filtering them console.lua binds up and down to navigate its history. Add a private flag to mp.input.get to instruct console.lua not to bind up and down, so you can use them to scroll the keybindings page while filtering keybindings. If it is requested, this can be replaced with an argument to input.get to not bind arbitrary keys. Fixes #14966.
2024-10-01 20:53:47 +02:00
dont_bind_up_down = args.dont_bind_up_down
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
if histories[id] == nil then
histories[id] = {}
log_buffers[id] = {}
end
history = histories[id]
history_pos = #history + 1
console.lua: strip multiple lines in selectable items If an item contains newlines, it hides the top items. This is often the case for sub-ass-extradata and metadata/ytdl_description in the property list. So keep only the first line.
2024-11-22 16:44:00 +01:00
if args.items then
selectable_items = {}
for i, item in ipairs(args.items) do
console.lua: limit the length of selectable items Giving very long lines to libass freezes mpv and makes the CPU spin (though it's fine with terminal output). This is often the case user-data/mpv/ytdl/json-subprocess-result in the property list. So limit the length of selectable items to 300 characters (not Unicode aware). This is enough to fill a 1920x1080 window with font_size=16 and Japanese text.
2024-11-22 16:55:01 +01:00
selectable_items[i] = item:gsub("[\r\n].*", "⋯"):sub(1, 300)
console.lua: strip multiple lines in selectable items If an item contains newlines, it hides the top items. This is often the case for sub-ass-extradata and metadata/ytdl_description in the property list. So keep only the first line.
2024-11-22 16:44:00 +01:00
end
console.lua: highlight the select menu's preselected item Requested in https://github.com/mpv-player/mpv/pull/14087#issuecomment-2110889436 and https://github.com/mpv-player/mpv/pull/15031#issuecomment-2401328081 This is mainly useful to keep highlighting the current playlist entry after moving the mouse.
2024-10-09 21:35:03 +02:00
default_item = args.default_item
console.lua: focus the default item after emptying the input line When console is opened with selectable items and a default item, the default item is placed at the center. But if you type something and then clear the line, the first item becomes the selected one. Make it select the default item and place it in the center in this case too.
2025-01-02 10:30:50 +01:00
handle_edit()
console.lua: allow clicking selectable items This adds click support for the select menu. Scrolling with the wheel already worked. If a custom OSC binds a button to a select.lua script-binding, this lets users keep using the mouse to select an item. While the OSC and the select menu are open at the same time, you can no longer click the OSC's buttons. By using mp.add_key_binding instead of add_forced_key_binding you could click both, but the console's binding would be shadowed by MBTN_LEFT bindings in input.conf.
2024-10-08 19:34:20 +02:00
bind_mouse()
scripting: add mp.input.select() This allows scripts to make the user choose from a list of entries by typing part of their text and/or by navigating them with keybindings, like dmenu or fzf. Closes #13964.
2024-05-04 19:02:18 +02:00
end
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
set_active(true)
mp.commandv('script-message-to', input_caller, 'input-event', 'opened')
end)
mp.register_script_message('log', function (message)
various: fix typos
2025-01-03 23:43:40 +01:00
-- input.get edited handler is invoked after submit, so avoid modifying
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
-- the default log.
if input_caller == nil then
return
end
message = utils.parse_json(message)
console.lua: fix highlighting the selected item with --msg-module With --msg-module the select menu also highlights the "statusline" on the next line. Fix this by resetting the color before \n instead of after it. This requires changing all log code to not preemptively add a newline, which is actually simpler, though we have to modify the messages received with log-message which already contain a newline.
2024-09-15 08:29:39 +02:00
log_add(message.text,
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
message.error and styles.error or message.style,
message.error and terminal_styles.error or message.terminal_style)
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
end)
mp.register_script_message('set-log', function (log)
if input_caller == nil then
return
end
log = utils.parse_json(log)
log_buffers[id] = {}
for i = 1, #log do
if type(log[i]) == 'table' then
console.lua: fix highlighting the selected item with --msg-module With --msg-module the select menu also highlights the "statusline" on the next line. Fix this by resetting the color before \n instead of after it. This requires changing all log code to not preemptively add a newline, which is actually simpler, though we have to modify the messages received with log-message which already contain a newline.
2024-09-15 08:29:39 +02:00
log[i].text = log[i].text
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
log[i].style = log[i].style or ''
log[i].terminal_style = log[i].terminal_style or ''
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
log_buffers[id][i] = log[i]
else
log_buffers[id][i] = {
console.lua: fix highlighting the selected item with --msg-module With --msg-module the select menu also highlights the "statusline" on the next line. Fix this by resetting the color before \n instead of after it. This requires changing all log code to not preemptively add a newline, which is actually simpler, though we have to modify the messages received with log-message which already contain a newline.
2024-09-15 08:29:39 +02:00
text = log[i],
console.lua: style log lines in the terminal When running the console in the terminal, style log lines with the same escape sequences as msg.c. mp.input can also specify terminal escape sequences, e.g. a script to select a playlist entry can invert the color of the selection. Also add a missing newline to help's error message.
2024-01-13 08:40:16 +01:00
style = '',
terminal_style = '',
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
}
end
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
end)
mp.register_script_message('complete', function(list, start_pos)
if line ~= completion_old_line or cursor ~= completion_old_cursor then
return
end
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer = {}
selected_completion_index = 0
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
local completions = utils.parse_json(list)
console.lua: sort completions With the previous commit, this sorts completions with the same score alphabetically.
2025-01-19 18:09:43 +01:00
table.sort(completions)
console.lua: show completions as you type Show available completion suggestions as you type without having to press Tab. This is fast even on a 2011 CPU, so we can get away with doing this in the same thread that draws the console. The one case where it could make the console hang is file completion of network drives, but in general it is convenient for loadfile. mp.input.get clients also get a request to complete on each character typed, but those run in a different thread so performance is always fine, and completions were already rejected if the input line or cursor changed after the request. If I ever make running mpv commands an mp.input client in the future, command completion will also benefit from running in a different thread.
2024-11-22 22:10:13 +01:00
completion_pos = start_pos
completion_append = ''
for i, match in ipairs(fuzzy_find(line:sub(completion_pos, cursor),
completions)) do
console.lua: always say completions instead of suggestions Both completions and suggestions were being used inconsistently. Just always use completions which is much more common.
2025-01-20 13:48:54 +01:00
completion_buffer[i] = completions[match]
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
scripting: add mp.input This lets scripts get textual input from the user using console.lua.
2024-01-02 18:58:32 +01:00
end)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Redraw the REPL when the OSD size changes. This is needed because the
-- PlayRes of the OSD will need to be adjusted.
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
mp.observe_property('osd-width', 'native', render)
mp.observe_property('osd-height', 'native', render)
mp.observe_property('display-hidpi-scale', 'native', render)
mp.observe_property('focused', 'native', render)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
mp.observe_property("user-data/osc/margins", "native", function(_, val)
console.lua: guard user-data/osc/margins value Defaults margins to 0 if an external script sets this to an invalid value.
2024-08-02 03:53:19 -04:00
if type(val) == "table" and type(val.t) == "number" and type(val.b) == "number" then
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
global_margins = val
else
global_margins = { t = 0, b = 0 }
end
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
render()
console.lua: fix lint warnings
2024-05-27 22:40:39 +02:00
end)
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
-- Enable log messages. In silent mode, mpv will queue log messages in a buffer
-- until enable_messages is called again without the silent: prefix.
mp.enable_messages('silent:terminal-default')
mp.register_event('log-message', function(e)
-- Ignore log messages from the OSD because of paranoia, since writing them
-- to the OSD could generate more messages in an infinite loop.
if e.prefix:sub(1, 3) == 'osd' then return end
-- Ignore messages output by this script.
if e.prefix == mp.get_script_name() then return end
-- Ignore buffer overflow warning messages. Overflowed log messages would
-- have been offscreen anyway.
if e.prefix == 'overflow' then return end
-- Filter out trace-level log messages, even if the terminal-default log
-- level includes them. These aren't too useful for an on-screen display
-- without scrollback and they include messages that are generated from the
-- OSD display itself.
if e.level == 'trace' then return end
console: refactor text styles for log levels The text styles are now in a table. The color definitions of the theme where the colors were taken from are now included in a comment for future reference. The colors have been converted to BGR as is required by ASS.
2022-06-20 00:08:37 +02:00
-- Use color for debug/v/warn/error/fatal messages.
console.lua: fix highlighting the selected item with --msg-module With --msg-module the select menu also highlights the "statusline" on the next line. Fix this by resetting the color before \n instead of after it. This requires changing all log code to not preemptively add a newline, which is actually simpler, though we have to modify the messages received with log-message which already contain a newline.
2024-09-15 08:29:39 +02:00
log_add('[' .. e.prefix .. '] ' .. e.text:sub(1, -2), styles[e.level],
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
terminal_styles[e.level])
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-08 03:16:10 +11:00
end)
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
console.lua: add user-data/mpv/console/open Fixes #15762.
2025-01-30 20:18:58 +01:00
mp.register_event('shutdown', function ()
mp.del_property('user-data/mpv/console')
end)
console.lua: rename update() to render() It is not clear what update() updates, in fact this rename allows removing the comment explaining it. render() is clearer and is the same term used by the OSC.
2025-01-20 13:46:14 +01:00
require 'mp.options'.read_options(opts, nil, render)
console.lua: enable runtime updates of script-opts
2024-11-27 10:10:20 +01:00
console: reduce memory usage in default mode This used 1 MB due to building the complete command and property list when starting the script. These are needed only for auto-completion, so build them only on demand. Since building them is fast enough, rebuild them every time. The key bindings table is not that much, but saves some KBs. Oddly, the code to build it uses less memory than the table at runtime (???), so build it at runtime as well. Add 2 tactic collectgarbage() calls as well. This frees unused heap when it is known that the script is going to be completely inactive until re-enabled by the user.
2020-04-10 13:36:10 +02:00
collectgarbage()
Reference in New Issue Copy Permalink