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>

DOCS/man/console.rst

@@ -0,0 +1,104 @@
+CONSOLE
+=======
+
+The console is a REPL for mpv input commands. It is displayed on the video
+window. It also shows log messages. It can be disabled entirely using the
+``--load-osd-console=no`` option.
+
+Keybindings
+-----------
+
+\`
+    Show the console.
+
+ESC
+    Hide the console.
+
+ENTER
+    Run the typed command.
+
+Shift+ENTER
+    Type a literal newline character.
+
+Ctrl+LEFT and Ctrl+RIGHT
+    Move cursor to previous/next word.
+
+UP and DOWN
+    Navigate command history.
+
+PGUP
+    Go to the first command in the history.
+
+PGDN
+    Stop navigating command history.
+
+INSERT
+    Toggle insert mode.
+
+Shift+INSERT
+    Paste text (uses the primary selection on X11.)
+
+TAB
+    Complete the command or property name at the cursor.
+
+Ctrl+C
+    Clear current line.
+
+Ctrl+K.
+    Delete text from the cursor to the end of the line.
+
+Ctrl+L
+    Clear all log messages from the console.
+
+Ctrl+U
+    Delete text from the cursor to the beginning of the line.
+
+Ctrl+V
+    Paste text (uses the clipboard on X11.)
+
+Ctrl+W
+    Delete text from the cursor to the beginning of the current word.
+
+Commands
+--------
+
+``script-message-to console type <text>``
+    Show the console and pre-fill it with the provided text.
+
+Known issues
+------------
+
+- Pasting text is slow on Windows
+- Non-ASCII keyboard input has restrictions
+- The cursor keys move between Unicode code-points, not grapheme clusters
+
+Configuration
+-------------
+
+This script can be customized through a config file ``script-opts/console.conf``
+placed in mpv's user directory and through the ``--script-opts`` command-line
+option. The configuration syntax is described in `ON SCREEN CONTROLLER`_.
+
+Key bindings can be changed in a standard way, see for example stats.lua
+documentation.
+
+Configurable Options
+~~~~~~~~~~~~~~~~~~~~
+
+``scale``
+    Default: 1
+
+    All drawing is scaled by this value, including the text borders and the
+    cursor. Change it if you have a high-DPI display.
+
+``font``
+    Default: unset (picks a hardcoded font depending on detected platform)
+
+    Set the font used for the REPL and the console. This probably doesn't
+    have to be a monospaced font.
+
+``font_size``
+    Default: 16
+
+    Set the font size used for the REPL and the console. This will be
+    multiplied by "scale."

DOCS/man/mpv.rst

@@ -991,6 +991,8 @@ works like in older mpv releases. The profiles are currently defined as follows:
 
 .. include:: stats.rst
 
+.. include:: console.rst
+
 .. include:: lua.rst
 
 .. include:: javascript.rst

DOCS/man/options.rst

@@ -847,6 +847,12 @@ Program Behavior
     binding (default: yes). By default, the ``i`` key is used (``I`` to make
     the overlay permanent).
 
+``--load-osd-console=<yes|no>``
+    Enable the builtin script that shows a console on a key binding and lets
+    you enter commands (default: yes). By default,. The ``´`` key is used to
+    show the console, and ``ESC`` to hide it again. (This is based on  a user
+    script called ``repl.lua``.)
+
 ``--player-operation-mode=<cplayer|pseudo-gui>``
     For enabling "pseudo GUI mode", which means that the defaults for some
     options are changed. This option should not normally be used directly, but

etc/input.conf

@@ -97,6 +97,7 @@
 #P show-progress
 #i script-binding stats/display-stats
 #I script-binding stats/display-stats-toggle
+#` script-binding console/enable
 #z add sub-delay -0.1                   # subtract 100 ms delay from subs
 #Z add sub-delay +0.1                   # add
 #x add sub-delay +0.1                   # same as previous binding (discouraged)

options/options.c

@@ -400,6 +400,7 @@ static const m_option_t mp_opts[] = {
     OPT_STRING("ytdl-format", lua_ytdl_format, 0),
     OPT_KEYVALUELIST("ytdl-raw-options", lua_ytdl_raw_options, 0),
     OPT_FLAG("load-stats-overlay", lua_load_stats, UPDATE_BUILTIN_SCRIPTS),
+    OPT_FLAG("load-osd-console", lua_load_console, UPDATE_BUILTIN_SCRIPTS),
 #endif
 
 // ------------------------- stream options --------------------
@@ -920,6 +921,7 @@ static const struct MPOpts mp_default_opts = {
     .lua_ytdl_format = NULL,
     .lua_ytdl_raw_options = NULL,
     .lua_load_stats = 1,
+    .lua_load_console = 1,
 #endif
     .auto_load_scripts = 1,
     .loop_times = 1,

options/options.h

@@ -139,6 +139,7 @@ typedef struct MPOpts {
     char *lua_ytdl_format;
     char **lua_ytdl_raw_options;
     int lua_load_stats;
+    int lua_load_console;
 
     int auto_load_scripts;
 

player/lua.c

@@ -72,6 +72,9 @@ static const char * const builtin_lua_scripts[][2] = {
     },
     {"@stats.lua",
 #   include "player/lua/stats.inc"
+    },
+    {"@console.lua",
+#   include "player/lua/console.inc"
     },
     {0}
 };

player/lua/console.lua

@@ -0,0 +1,701 @@
+-- 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 options
+local 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/cocoa-force-dedicated-gpu', o) ~= o then
+        return 'macos'
+    end
+    return 'x11'
+end
+
+-- Pick a better default font for Windows and macOS
+local 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 options
+options.read_options(opts)
+
+-- 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
+
+local repl_active = false
+local insert_mode = false
+local pending_update = false
+local line = ''
+local cursor = 1
+local history = {}
+local history_pos = 1
+local log_buffer = {}
+local key_bindings = {}
+
+local update_timer = nil
+update_timer = mp.add_periodic_timer(0.05, function()
+    if pending_update then
+        update()
+    else
+        update_timer:kill()
+    end
+end)
+update_timer:kill()
+
+-- 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
+    end
+end
+
+-- Escape a string for verbatim display on the OSD
+function 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')
+    return str
+end
+
+-- Render the REPL and console as an ASS OSD
+function update()
+    pending_update = false
+
+    local screenx, screeny, aspect = mp.get_osd_size()
+    screenx = screenx / opts.scale
+    screeny = screeny / opts.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 ..
+                  '\\bord2\\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)
+    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')
+    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)
+    end
+end
+
+-- 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 pos
+end
+
+-- 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 pos
+end
+
+-- 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_mode
+end
+
+-- 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)
+    end
+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
+
+    mp.command(line)
+    clear()
+end
+
+-- Go to the specified position in the command history
+function 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.
+local completers = {
+    { 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 = '}' },
+}
+
+-- 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_match
+end
+
+-- 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(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
+    end
+end
+
+-- 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.
+local bindings = {
+    { 'esc',         function() set_active(false) end       },
+    { '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                               },
+}
+
+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
+end
+
+function define_key_bindings()
+    if #key_bindings > 0 then
+        return
+    end
+    for _, bind in ipairs(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 text
+mp.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)
+
+-- 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)

player/scripting.c

@@ -208,6 +208,7 @@ void mp_load_builtin_scripts(struct MPContext *mpctx)
     load_builtin_script(mpctx, mpctx->opts->lua_load_osc, "@osc.lua");
     load_builtin_script(mpctx, mpctx->opts->lua_load_ytdl, "@ytdl_hook.lua");
     load_builtin_script(mpctx, mpctx->opts->lua_load_stats, "@stats.lua");
+    load_builtin_script(mpctx, mpctx->opts->lua_load_console, "@console.lua");
 }
 
 void mp_load_scripts(struct MPContext *mpctx)

wscript_build.py

@@ -100,7 +100,7 @@ def build(ctx):
     )
 
     lua_files = ["defaults.lua", "assdraw.lua", "options.lua", "osc.lua",
-                 "ytdl_hook.lua", "stats.lua"]
+                 "ytdl_hook.lua", "stats.lua", "console.lua"]
 
     for fn in lua_files:
         fn = "player/lua/" + fn