Something went wrong. Try again.
🎥 Command line media player
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791-- 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 options = require 'mp.options'local assdraw = require 'mp.assdraw'
-- Default optionslocal opts = { -- All drawing is scaled by this value, including the text borders and the -- cursor. Change it if you have a high-DPI display. scale = 1, -- Set the font used for the REPL and the console. This probably doesn't -- have to be a monospaced font. font = "", -- Set the font size used for the REPL and the console. This will be -- multiplied by "scale." font_size = 16,}
function detect_platform() local o = {} -- Kind of a dumb way of detecting the platform but whatever if mp.get_property_native('options/vo-mmcss-profile', o) ~= o then return 'windows' elseif mp.get_property_native('options/macos-force-dedicated-gpu', o) ~= o then return 'macos' end return 'x11'end
-- Pick a better default font for Windows and macOSlocal platform = detect_platform()if platform == 'windows' then opts.font = 'Consolas'elseif platform == 'macos' then opts.font = 'Menlo'else opts.font = 'monospace'end
-- Apply user-set optionsoptions.read_options(opts)
local repl_active = falselocal insert_mode = falselocal pending_update = falselocal line = ''local cursor = 1local history = {}local history_pos = 1local log_buffer = {}local key_bindings = {}local global_margin_y = 0
local update_timer = nilupdate_timer = mp.add_periodic_timer(0.05, function() if pending_update then update() else update_timer:kill() endend)update_timer:kill()
utils.shared_script_property_observe("osc-margins", function(_, val) if val then -- formatted as "%f,%f,%f,%f" with left, right, top, bottom, each -- value being the border size as ratio of the window size (0.0-1.0) local vals = {} for v in string.gmatch(val, "[^,]+") do vals[#vals + 1] = tonumber(v) end global_margin_y = vals[4] -- bottom else global_margin_y = 0 end update()end)
-- Add a line to the log buffer (which is limited to 100 lines)function log_add(style, text) log_buffer[#log_buffer + 1] = { style = style, text = text } if #log_buffer > 100 then table.remove(log_buffer, 1) end
if repl_active then if not update_timer:is_enabled() then update() update_timer:resume() else pending_update = true end endend
-- Escape a string for verbatim display on the OSDfunction ass_escape(str) -- There is no escape for '\' in ASS (I think?) but '\' is used verbatim if -- it isn't followed by a recognised character, so add a zero-width -- non-breaking space str = str:gsub('\\', '\\\239\187\191') str = str:gsub('{', '\\{') str = str:gsub('}', '\\}') -- Precede newlines with a ZWNBSP to prevent ASS's weird collapsing of -- consecutive newlines str = str:gsub('\n', '\239\187\191\\N') -- Turn leading spaces into hard spaces to prevent ASS from stripping them str = str:gsub('\\N ', '\\N\\h') str = str:gsub('^ ', '\\h') return strend
-- Render the REPL and console as an ASS OSDfunction update() pending_update = false
local dpi_scale = mp.get_property_native("display-hidpi-scale", 1.0)
dpi_scale = dpi_scale * opts.scale
local screenx, screeny, aspect = mp.get_osd_size() screenx = screenx / dpi_scale screeny = screeny / dpi_scale
-- Clear the OSD if the REPL is not active if not repl_active then mp.set_osd_ass(screenx, screeny, '') return end
local ass = assdraw.ass_new() local style = '{\\r' .. '\\1a&H00&\\3a&H00&\\4a&H99&' .. '\\1c&Heeeeee&\\3c&H111111&\\4c&H000000&' .. '\\fn' .. opts.font .. '\\fs' .. opts.font_size .. '\\bord1\\xshad0\\yshad1\\fsp0\\q1}' -- 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. local cheight = opts.font_size * 8 local cglyph = '{\\r' .. '\\1a&H44&\\3a&H44&\\4a&H99&' .. '\\1c&Heeeeee&\\3c&Heeeeee&\\4c&H000000&' .. '\\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))
-- Render log messages as ASS. This will render at most screeny / font_size -- messages. local log_ass = '' local log_messages = #log_buffer local log_max_lines = math.ceil(screeny / opts.font_size) if log_max_lines < log_messages then log_messages = log_max_lines end for i = #log_buffer - log_messages + 1, #log_buffer do log_ass = log_ass .. style .. log_buffer[i].style .. ass_escape(log_buffer[i].text) end
ass:new_event() ass:an(1) ass:pos(2, screeny - 2 - global_margin_y * screeny) ass:append(log_ass .. '\\N') ass:append(style .. '> ' .. before_cur) 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) ass:pos(2, screeny - 2) ass:append(style .. '{\\alpha&HFF&}> ' .. before_cur) ass:append(cglyph) ass:append(style .. '{\\alpha&HFF&}' .. after_cur)
mp.set_osd_ass(screenx, screeny, ass.text)end
-- Set the REPL visibility ("enable", Esc)function set_active(active) if active == repl_active then return end if active then repl_active = true insert_mode = false mp.enable_key_bindings('console-input', 'allow-hide-cursor+allow-vo-dragging') mp.enable_messages('terminal-default') define_key_bindings() else repl_active = false undefine_key_bindings() mp.enable_messages('silent:terminal-default') collectgarbage() end update()end
-- Show the repl if hidden and replace its contents with 'text'-- (script-message-to repl type)function show_and_type(text) text = text or ''
-- Save the line currently being edited, just in case if line ~= text and line ~= '' and history[#history] ~= line then history[#history + 1] = line end
line = text cursor = line:len() + 1 history_pos = #history + 1 insert_mode = false if repl_active then update() else set_active(true) endend
-- Naive helper function to find the next UTF-8 character in 'str' after 'pos'-- by skipping continuation bytes. Assumes 'str' contains valid UTF-8.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 posend
-- As above, but finds the previous UTF-8 charcter in 'str' before 'pos'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 posend
-- Insert a character at the current cursor position (any_unicode, Shift+Enter)function handle_char_input(c) 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 update()end
-- Remove the character behind the cursor (Backspace)function handle_backspace() if cursor <= 1 then return end local prev = prev_utf8(line, cursor) line = line:sub(1, prev - 1) .. line:sub(cursor) cursor = prev update()end
-- Remove the character in front of the cursor (Del)function handle_del() if cursor > line:len() then return end line = line:sub(1, cursor - 1) .. line:sub(next_utf8(line, cursor)) update()end
-- Toggle insert mode (Ins)function handle_ins() insert_mode = not insert_modeend
-- Move the cursor to the next character (Right)function next_char(amount) cursor = next_utf8(line, cursor) update()end
-- Move the cursor to the previous character (Left)function prev_char(amount) cursor = prev_utf8(line, cursor) update()end
-- Clear the current line (Ctrl+C)function clear() line = '' cursor = 1 insert_mode = false history_pos = #history + 1 update()end
-- Close the REPL if the current line is empty, otherwise do nothing (Ctrl+D)function maybe_exit() if line == '' then set_active(false) endend
function help_command(param) local cmdlist = mp.get_property_native('command-list') local error_style = '{\\1c&H7a77f2&}' 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 log_add(error_style, 'No command matches "' .. param .. '"!') 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 log_add('', output)end
-- Run the current command and clear the line (Enter)function handle_enter() if line == '' then return end if history[#history] ~= line then history[#history + 1] = line end
-- 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
clear()end
-- Go to the specified position in the command historyfunction go_history(new_pos) 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 history[#history + 1] = line 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 update()end
-- Go to the specified relative position in the command history (Up, Down)function move_history(amount) go_history(history_pos + amount)end
-- Go to the first command in the command history (PgUp)function handle_pgup() go_history(1)end
-- Stop browsing history and start editing a blank line (PgDown)function handle_pgdown() go_history(#history + 1)end
-- Move to the start of the current word, or if already at the start, the start-- of the previous word. (Ctrl+Left)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 update()end
-- Move to the end of the current word, or if already at the end, the end of-- the next word. (Ctrl+Right)function next_word() cursor = select(2, line:find('%s*[^%s]*', cursor)) + 1 update()end
-- List of tab-completions:-- pattern: A Lua pattern used in string:find. Should return the start and-- end positions of the word to be completed in the first and second-- capture groups (using the empty parenthesis notation "()")-- list: A list of candidate completion values.-- append: An extra string to be appended to the end of a successful-- completion. It is only appended if 'list' contains exactly one-- match.function build_completers() -- Build a list of commands, properties and options for tab-completion local option_info = { 'name', 'type', 'set-from-commandline', 'set-locally', 'default-value', 'min', 'max', 'choices', } local cmd_list = {} for i, cmd in ipairs(mp.get_property_native('command-list')) do cmd_list[i] = cmd.name end local prop_list = mp.get_property_native('property-list') for _, opt in ipairs(mp.get_property_native('options')) do prop_list[#prop_list + 1] = 'options/' .. opt prop_list[#prop_list + 1] = 'file-local-options/' .. opt prop_list[#prop_list + 1] = 'option-info/' .. opt for _, p in ipairs(option_info) do prop_list[#prop_list + 1] = 'option-info/' .. opt .. '/' .. p end end
return { { pattern = '^%s*()[%w_-]+()$', list = cmd_list, append = ' ' }, { pattern = '^%s*set%s+()[%w_/-]+()$', list = prop_list, append = ' ' }, { pattern = '^%s*set%s+"()[%w_/-]+()$', list = prop_list, append = '" ' }, { pattern = '^%s*add%s+()[%w_/-]+()$', list = prop_list, append = ' ' }, { pattern = '^%s*add%s+"()[%w_/-]+()$', list = prop_list, append = '" ' }, { pattern = '^%s*cycle%s+()[%w_/-]+()$', list = prop_list, append = ' ' }, { pattern = '^%s*cycle%s+"()[%w_/-]+()$', list = prop_list, append = '" ' }, { pattern = '^%s*multiply%s+()[%w_/-]+()$', list = prop_list, append = ' ' }, { pattern = '^%s*multiply%s+"()[%w_/-]+()$', list = prop_list, append = '" ' }, { pattern = '${()[%w_/-]+()$', list = prop_list, append = '}' }, }end
-- Use 'list' to find possible tab-completions for 'part.' Returns the longest-- common prefix of all the matching list items and a flag that indicates-- whether the match was unique or not.function complete_match(part, list) local completion = nil local full_match = false
for _, candidate in ipairs(list) do if candidate:sub(1, part:len()) == part then if completion and completion ~= candidate then local prefix_len = part:len() while completion:sub(1, prefix_len + 1) == candidate:sub(1, prefix_len + 1) do prefix_len = prefix_len + 1 end completion = candidate:sub(1, prefix_len) full_match = false else completion = candidate full_match = true end end end
return completion, full_matchend
-- Complete the option or property at the cursor (TAB)function complete() local before_cur = line:sub(1, cursor - 1) local after_cur = line:sub(cursor)
-- Try the first completer that works for _, completer in ipairs(build_completers()) do -- Completer patterns should return the start and end of the word to be -- completed as the first and second capture groups local _, _, s, e = before_cur:find(completer.pattern) if not s then -- Multiple input commands can be separated by semicolons, so all -- completions that are anchored at the start of the string with -- '^' can start from a semicolon as well. Replace ^ with ; and try -- to match again. _, _, s, e = before_cur:find(completer.pattern:gsub('^^', ';')) end if s then -- If the completer's pattern found a word, check the completer's -- list for possible completions local part = before_cur:sub(s, e) local c, full = complete_match(part, completer.list) if c then -- If there was only one full match from the list, add -- completer.append to the final string. This is normally a -- space or a quotation mark followed by a space. if full and completer.append then c = c .. completer.append end
-- Insert the completion and update before_cur = before_cur:sub(1, s - 1) .. c cursor = before_cur:len() + 1 line = before_cur .. after_cur update() return end end endend
-- Move the cursor to the beginning of the line (HOME)function go_home() cursor = 1 update()end
-- Move the cursor to the end of the line (END)function go_end() cursor = line:len() + 1 update()end
-- Delete from the cursor to the end of the word (Ctrl+W)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 update()end
-- Delete from the cursor to the end of the line (Ctrl+K)function del_to_eol() line = line:sub(1, cursor - 1) update()end
-- Delete from the cursor back to the start of the line (Ctrl+U)function del_to_start() line = line:sub(cursor) cursor = 1 update()end
-- Empty the log buffer of all messages (Ctrl+L)function clear_log_buffer() log_buffer = {} update()end
-- Returns a string of UTF-8 text from the clipboard (or the primary selection)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 == 'windows' then local res = utils.subprocess({ args = { 'powershell', '-NoProfile', '-Command', [[& { Trap { Write-Error -ErrorRecord $_ Exit 1 }
$clip = "" if (Get-Command "Get-Clipboard" -errorAction SilentlyContinue) { $clip = Get-Clipboard -Raw -Format Text -TextFormatType UnicodeText } else { Add-Type -AssemblyName PresentationCore $clip = [Windows.Clipboard]::GetText() }
$clip = $clip -Replace "`r","" $u8clip = [System.Text.Encoding]::UTF8.GetBytes($clip) [Console]::OpenStandardOutput().Write($u8clip, 0, $u8clip.Length) }]] }, playback_only = false, }) if not res.error then return res.stdout end elseif platform == 'macos' then local res = utils.subprocess({ args = { 'pbpaste' }, playback_only = false, }) if not res.error then return res.stdout end end return ''end
-- Paste text from the window-system's clipboard. 'clip' determines whether the-- clipboard or the primary selection buffer is used (on X11 only.)function paste(clip) 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() update()end
-- List of input bindings. This is a weird mashup between common GUI text-input-- bindings and readline bindings.function get_bindings() local bindings = { { 'esc', function() set_active(false) end }, { 'enter', handle_enter }, { 'kp_enter', handle_enter }, { 'shift+enter', function() handle_char_input('\n') end }, { 'bs', handle_backspace }, { 'shift+bs', handle_backspace }, { 'del', handle_del }, { 'shift+del', handle_del }, { 'ins', handle_ins }, { 'shift+ins', function() paste(false) end }, { 'mbtn_mid', function() paste(false) end }, { 'left', function() prev_char() end }, { 'right', function() next_char() end }, { 'up', function() move_history(-1) end }, { 'wheel_up', function() move_history(-1) end }, { 'down', function() move_history(1) end }, { 'wheel_down', function() move_history(1) end }, { 'wheel_left', function() end }, { 'wheel_right', function() end }, { 'ctrl+left', prev_word }, { 'ctrl+right', next_word }, { 'tab', complete }, { 'home', go_home }, { 'end', go_end }, { 'pgup', handle_pgup }, { 'pgdwn', handle_pgdown }, { '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 }, { 'ctrl+w', del_word }, { 'kp_dec', function() handle_char_input('.') end }, }
for i = 0, 9 do bindings[#bindings + 1] = {'kp' .. i, function() handle_char_input('' .. i) end} end
return bindingsend
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) endend
function define_key_bindings() if #key_bindings > 0 then return end for _, bind in ipairs(get_bindings()) do -- 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 mp.add_forced_key_binding("any_unicode", "_console_text", text_input, {repeatable = true, complex = true}) key_bindings[#key_bindings + 1] = "_console_text"end
function undefine_key_bindings() for _, name in ipairs(key_bindings) do mp.remove_key_binding(name) end key_bindings = {}end
-- 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)
-- Add a script-message to show the REPL and fill it with the provided textmp.register_script_message('type', function(text) show_and_type(text)end)
-- Redraw the REPL when the OSD size changes. This is needed because the-- PlayRes of the OSD will need to be adjusted.mp.observe_property('osd-width', 'native', update)mp.observe_property('osd-height', 'native', update)mp.observe_property('display-hidpi-scale', 'native', update)
-- 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
-- Use color for debug/v/warn/error/fatal messages. Colors are stolen from -- base16 Eighties by Chris Kempson. local style = '' if e.level == 'debug' then style = '{\\1c&Ha09f93&}' elseif e.level == 'v' then style = '{\\1c&H99cc99&}' elseif e.level == 'warn' then style = '{\\1c&H66ccff&}' elseif e.level == 'error' then style = '{\\1c&H7a77f2&}' elseif e.level == 'fatal' then style = '{\\1c&H5791f9&\\b1}' end
log_add(style, '[' .. e.prefix .. '] ' .. e.text)end)
collectgarbage()