neko-apps/xfce-custom/dots/home/neko/.config/mpv/scripts/uosc/main.lua
2024-05-25 00:19:22 +12:00

1141 lines
40 KiB
Lua

--[[ uosc | https://github.com/tomasklaen/uosc ]]
local uosc_version = '5.2.0'
mp.commandv('script-message', 'uosc-version', uosc_version)
assdraw = require('mp.assdraw')
opt = require('mp.options')
utils = require('mp.utils')
msg = require('mp.msg')
osd = mp.create_osd_overlay('ass-events')
QUARTER_PI_SIN = math.sin(math.pi / 4)
require('lib/std')
--[[ OPTIONS ]]
defaults = {
timeline_style = 'line',
timeline_line_width = 2,
timeline_size = 40,
progress = 'windowed',
progress_size = 2,
progress_line_width = 20,
timeline_persistency = '',
timeline_border = 1,
timeline_step = 5,
timeline_cache = true,
controls =
'menu,gap,subtitles,<has_many_audio>audio,<has_many_video>video,<has_many_edition>editions,<stream>stream-quality,gap,space,speed,space,shuffle,loop-playlist,loop-file,gap,prev,items,next,gap,fullscreen',
controls_size = 32,
controls_margin = 8,
controls_spacing = 2,
controls_persistency = '',
volume = 'right',
volume_size = 40,
volume_persistency = '',
volume_border = 1,
volume_step = 1,
speed_persistency = '',
speed_step = 0.1,
speed_step_is_factor = false,
menu_item_height = 36,
menu_min_width = 260,
menu_padding = 4,
menu_type_to_search = true,
top_bar = 'no-border',
top_bar_size = 40,
top_bar_persistency = '',
top_bar_controls = true,
top_bar_title = 'yes',
top_bar_alt_title = '',
top_bar_alt_title_place = 'below',
top_bar_flash_on = 'video,audio',
window_border_size = 1,
autoload = false,
autoload_types = 'video,audio,image',
shuffle = false,
scale = 1,
scale_fullscreen = 1.3,
font_scale = 1,
text_border = 1.2,
border_radius = 4,
color = '',
opacity = '',
animation_duration = 100,
refine = '',
pause_on_click_shorter_than = 0, -- deprecated by below
click_threshold = 0,
click_command = 'cycle pause; script-binding uosc/flash-pause-indicator',
flash_duration = 1000,
proximity_in = 40,
proximity_out = 120,
total_time = false, -- deprecated by below
destination_time = 'playtime-remaining',
time_precision = 0,
font_bold = false,
autohide = false,
buffered_time_threshold = 60,
pause_indicator = 'flash',
stream_quality_options = '4320,2160,1440,1080,720,480,360,240,144',
video_types =
'3g2,3gp,asf,avi,f4v,flv,h264,h265,m2ts,m4v,mkv,mov,mp4,mp4v,mpeg,mpg,ogm,ogv,rm,rmvb,ts,vob,webm,wmv,y4m',
audio_types =
'aac,ac3,aiff,ape,au,cue,dsf,dts,flac,m4a,mid,midi,mka,mp3,mp4a,oga,ogg,opus,spx,tak,tta,wav,weba,wma,wv',
image_types = 'apng,avif,bmp,gif,j2k,jp2,jfif,jpeg,jpg,jxl,mj2,png,svg,tga,tif,tiff,webp',
subtitle_types = 'aqt,ass,gsub,idx,jss,lrc,mks,pgs,pjs,psb,rt,sbv,slt,smi,sub,sup,srt,ssa,ssf,ttxt,txt,usf,vt,vtt',
default_directory = '~/',
show_hidden_files = false,
use_trash = false,
adjust_osd_margins = true,
chapter_ranges = 'openings:30abf964,endings:30abf964,ads:c54e4e80',
chapter_range_patterns = 'openings:オープニング;endings:エンディング',
languages = 'slang,en',
disable_elements = '',
}
options = table_copy(defaults)
opt.read_options(options, 'uosc', function(changed_options)
if changed_options.time_precision then
timestamp_zero_rep_clear_cache()
end
update_config()
update_human_times()
Manager:disable('user', options.disable_elements)
Elements:trigger('options')
Elements:update_proximities()
request_render()
end)
-- Normalize values
options.proximity_out = math.max(options.proximity_out, options.proximity_in + 1)
if options.chapter_ranges:sub(1, 4) == '^op|' then options.chapter_ranges = defaults.chapter_ranges end
if options.pause_on_click_shorter_than > 0 and options.click_threshold == 0 then
msg.warn('`pause_on_click_shorter_than` is deprecated. Use `click_threshold` and `click_command` instead.')
options.click_threshold = options.pause_on_click_shorter_than
end
if options.total_time and options.destination_time == 'playtime-remaining' then
msg.warn('`total_time` is deprecated. Use `destination_time` instead.')
options.destination_time = 'total'
elseif not itable_index_of({'total', 'playtime-remaining', 'time-remaining'}, options.destination_time) then
options.destination_time = 'playtime-remaining'
end
-- Ensure required environment configuration
if options.autoload then mp.commandv('set', 'keep-open-pause', 'no') end
--[[ INTERNATIONALIZATION ]]
local intl = require('lib/intl')
t = intl.t
require('lib/char_conv')
--[[ CONFIG ]]
local config_defaults = {
color = {
foreground = serialize_rgba('ffffff').color,
foreground_text = serialize_rgba('000000').color,
background = serialize_rgba('000000').color,
background_text = serialize_rgba('ffffff').color,
curtain = serialize_rgba('111111').color,
success = serialize_rgba('a5e075').color,
error = serialize_rgba('ff616e').color,
},
opacity = {
timeline = 0.9,
position = 1,
chapters = 0.8,
slider = 0.9,
slider_gauge = 1,
controls = 0,
speed = 0.6,
menu = 1,
submenu = 0.4,
border = 1,
title = 1,
tooltip = 1,
thumbnail = 1,
curtain = 0.8,
idle_indicator = 0.8,
audio_indicator = 0.5,
buffering_indicator = 0.3,
playlist_position = 0.8,
},
}
config = {
version = uosc_version,
open_subtitles_api_key = 'b0rd16N0bp7DETMpO4pYZwIqmQkZbYQr',
open_subtitles_agent = 'uosc v' .. uosc_version,
-- sets max rendering frequency in case the
-- native rendering frequency could not be detected
render_delay = 1 / 60,
font = mp.get_property('options/osd-font'),
osd_margin_x = mp.get_property('osd-margin-x'),
osd_margin_y = mp.get_property('osd-margin-y'),
osd_alignment_x = mp.get_property('osd-align-x'),
osd_alignment_y = mp.get_property('osd-align-y'),
refine = create_set(comma_split(options.refine)),
types = {
video = comma_split(options.video_types),
audio = comma_split(options.audio_types),
image = comma_split(options.image_types),
subtitle = comma_split(options.subtitle_types),
media = comma_split(options.video_types .. ',' .. options.audio_types .. ',' .. options.image_types),
autoload = (function()
---@type string[]
local option_values = {}
for _, name in ipairs(comma_split(options.autoload_types)) do
local value = options[name .. '_types']
if type(value) == 'string' then option_values[#option_values + 1] = value end
end
return comma_split(table.concat(option_values, ','))
end)(),
},
stream_quality_options = comma_split(options.stream_quality_options),
top_bar_flash_on = comma_split(options.top_bar_flash_on),
chapter_ranges = (function()
---@type table<string, string[]> Alternative patterns.
local alt_patterns = {}
if options.chapter_range_patterns and options.chapter_range_patterns ~= '' then
for _, definition in ipairs(split(options.chapter_range_patterns, ';+ *')) do
local name_patterns = split(definition, ' *:')
local name, patterns = name_patterns[1], name_patterns[2]
if name and patterns then alt_patterns[name] = split(patterns, ',') end
end
end
---@type table<string, {color: string; opacity: number; patterns?: string[]}>
local ranges = {}
if options.chapter_ranges and options.chapter_ranges ~= '' then
for _, definition in ipairs(split(options.chapter_ranges, ' *,+ *')) do
local name_color = split(definition, ' *:+ *')
local name, color = name_color[1], name_color[2]
if name and color
and name:match('^[a-zA-Z0-9_]+$') and color:match('^[a-fA-F0-9]+$')
and (#color == 6 or #color == 8) then
local range = serialize_rgba(name_color[2])
range.patterns = alt_patterns[name]
ranges[name_color[1]] = range
end
end
end
return ranges
end)(),
color = table_copy(config_defaults.color),
opacity = table_copy(config_defaults.opacity),
cursor_leave_fadeout_elements = {'timeline', 'volume', 'top_bar', 'controls'},
}
-- Updates config with values dependent on options
function update_config()
-- Adds `{element}_persistency` config properties with forced visibility states (e.g.: `{paused = true}`)
for _, name in ipairs({'timeline', 'controls', 'volume', 'top_bar', 'speed'}) do
local option_name = name .. '_persistency'
local value, flags = options[option_name], {}
if type(value) == 'string' then
for _, state in ipairs(comma_split(value)) do flags[state] = true end
end
config[option_name] = flags
end
-- Opacity
config.opacity = table_assign({}, config_defaults.opacity, serialize_key_value_list(options.opacity,
function(value, key)
return clamp(0, tonumber(value) or config.opacity[key], 1)
end
))
-- Color
config.color = table_assign({}, config_defaults.color, serialize_key_value_list(options.color, function(value)
return serialize_rgba(value).color
end))
-- Global color shorthands
fg, bg = config.color.foreground, config.color.background
fgt, bgt = config.color.foreground_text, config.color.background_text
end
update_config()
-- Default menu items
function create_default_menu_items()
return {
{title = t('Subtitles'), value = 'script-binding uosc/subtitles'},
{title = t('Audio tracks'), value = 'script-binding uosc/audio'},
{title = t('Stream quality'), value = 'script-binding uosc/stream-quality'},
{title = t('Playlist'), value = 'script-binding uosc/items'},
{title = t('Chapters'), value = 'script-binding uosc/chapters'},
{
title = t('Navigation'),
items = {
{
title = t('Next'),
hint = t('playlist or file'),
value =
'script-binding uosc/next',
},
{
title = t('Prev'),
hint = t('playlist or file'),
value =
'script-binding uosc/prev',
},
{title = t('Delete file & Next'), value = 'script-binding uosc/delete-file-next'},
{title = t('Delete file & Prev'), value = 'script-binding uosc/delete-file-prev'},
{title = t('Delete file & Quit'), value = 'script-binding uosc/delete-file-quit'},
{title = t('Open file'), value = 'script-binding uosc/open-file'},
},
},
{
title = t('Utils'),
items = {
{
title = t('Aspect ratio'),
items = {
{title = t('Default'), value = 'set video-aspect-override "-1"'},
{title = '16:9', value = 'set video-aspect-override "16:9"'},
{title = '4:3', value = 'set video-aspect-override "4:3"'},
{title = '2.35:1', value = 'set video-aspect-override "2.35:1"'},
},
},
{title = t('Audio devices'), value = 'script-binding uosc/audio-device'},
{title = t('Editions'), value = 'script-binding uosc/editions'},
{title = t('Screenshot'), value = 'async screenshot'},
{title = t('Key bindings'), value = 'script-binding uosc/keybinds'},
{title = t('Show in directory'), value = 'script-binding uosc/show-in-directory'},
{title = t('Open config folder'), value = 'script-binding uosc/open-config-directory'},
{title = t('Update uosc'), value = 'script-binding uosc/update'},
},
},
{title = t('Quit'), value = 'quit'},
}
end
--[[ STATE ]]
display = {width = 1280, height = 720, initialized = false}
cursor = require('lib/cursor')
state = {
platform = (function()
local platform = mp.get_property_native('platform')
if platform then
if itable_index_of({'windows', 'darwin'}, platform) then return platform end
else
if os.getenv('windir') ~= nil then return 'windows' end
local homedir = os.getenv('HOME')
if homedir ~= nil and string.sub(homedir, 1, 6) == '/Users' then return 'darwin' end
end
return 'linux'
end)(),
cwd = mp.get_property('working-directory'),
path = nil, -- current file path or URL
history = {}, -- history of last played files stored as full paths
title = nil,
alt_title = nil,
time = nil, -- current media playback time
speed = 1,
duration = nil, -- current media duration
time_human = nil, -- current playback time in human format
destination_time_human = nil, -- depends on options.destination_time
pause = mp.get_property_native('pause'),
chapters = {},
current_chapter = nil,
chapter_ranges = {},
border = mp.get_property_native('border'),
title_bar = mp.get_property_native('title-bar'),
fullscreen = mp.get_property_native('fullscreen'),
maximized = mp.get_property_native('window-maximized'),
fullormaxed = mp.get_property_native('fullscreen') or mp.get_property_native('window-maximized'),
render_timer = nil,
render_last_time = 0,
volume = nil,
volume_max = nil,
mute = nil,
is_idle = false,
is_video = false,
is_audio = false, -- true if file is audio only (mp3, etc)
is_image = false,
is_stream = false,
has_image = false,
has_audio = false,
has_sub = false,
has_chapter = false,
has_playlist = false,
shuffle = options.shuffle,
---@type nil|{pos: number; paths: string[]}
shuffle_history = nil,
on_shuffle = function() state.shuffle_history = nil end,
mouse_bindings_enabled = false,
uncached_ranges = nil,
cache = nil,
cache_buffering = 100,
cache_underrun = false,
core_idle = false,
eof_reached = false,
render_delay = config.render_delay,
playlist_count = 0,
playlist_pos = 0,
margin_top = 0,
margin_bottom = 0,
margin_left = 0,
margin_right = 0,
hidpi_scale = 1,
scale = 1,
radius = 0,
}
thumbnail = {width = 0, height = 0, disabled = false}
external = {} -- Properties set by external scripts
key_binding_overwrites = {} -- Table of key_binding:mpv_command
Elements = require('elements/Elements')
Menu = require('elements/Menu')
-- State dependent utilities
require('lib/utils')
require('lib/text')
require('lib/ass')
require('lib/menus')
-- Determine path to ziggy
do
local bin = 'ziggy-' .. (state.platform == 'windows' and 'windows.exe' or state.platform)
config.ziggy_path = os.getenv('MPV_UOSC_ZIGGY') or join_path(mp.get_script_directory(), join_path('bin', bin))
end
--[[ STATE UPDATERS ]]
function update_display_dimensions()
state.scale = (state.hidpi_scale or 1) * (state.fullormaxed and options.scale_fullscreen or options.scale)
state.radius = round(options.border_radius * state.scale)
local real_width, real_height = mp.get_osd_size()
if real_width <= 0 then return end
display.width, display.height = real_width, real_height
display.initialized = true
-- Tell elements about this
Elements:trigger('display')
-- Some elements probably changed their rectangles as a reaction to `display`
Elements:update_proximities()
request_render()
end
function update_fullormaxed()
state.fullormaxed = state.fullscreen or state.maximized
update_display_dimensions()
Elements:trigger('prop_fullormaxed', state.fullormaxed)
cursor:leave()
end
function update_human_times()
if state.time then
state.time_human = format_time(state.time, state.duration)
if state.duration then
local speed = state.speed or 1
if options.destination_time == 'playtime-remaining' then
state.destination_time_human = format_time((state.time - state.duration) / speed, state.duration)
elseif options.destination_time == 'total' then
state.destination_time_human = format_time(state.duration, state.duration)
else
state.destination_time_human = format_time(state.time - state.duration, state.duration)
end
else
state.destination_time_human = nil
end
else
state.time_human = nil
end
end
-- Notifies other scripts such as console about where the unoccupied parts of the screen are.
function update_margins()
if display.height == 0 then return end
local function causes_margin(element)
return element and element.enabled and (element:is_persistent() or element.min_visibility > 0.5)
end
local timeline, top_bar, controls, volume = Elements.timeline, Elements.top_bar, Elements.controls, Elements.volume
-- margins are normalized to window size
local left, right, top, bottom = 0, 0, 0, 0
if causes_margin(controls) then
bottom = (display.height - controls.ay) / display.height
elseif causes_margin(timeline) then
bottom = (display.height - timeline.ay) / display.height
end
if causes_margin(top_bar) then top = top_bar.title_by / display.height end
if causes_margin(volume) then
if options.volume == 'left' then
left = volume.bx / display.width
elseif options.volume == 'right' then
right = volume.ax / display.width
end
end
if top == state.margin_top and bottom == state.margin_bottom and
left == state.margin_left and right == state.margin_right then
return
end
state.margin_top = top
state.margin_bottom = bottom
state.margin_left = left
state.margin_right = right
if utils.shared_script_property_set then
utils.shared_script_property_set('osc-margins', string.format('%f,%f,%f,%f', 0, 0, top, bottom))
end
mp.set_property_native('user-data/osc/margins', {l = left, r = right, t = top, b = bottom})
if not options.adjust_osd_margins then return end
local osd_margin_y, osd_margin_x, osd_factor_x = 0, 0, display.width / display.height * 720
if config.osd_alignment_y == 'bottom' then
osd_margin_y = round(bottom * 720)
elseif config.osd_alignment_y == 'top' then
osd_margin_y = round(top * 720)
end
if config.osd_alignment_x == 'left' then
osd_margin_x = round(left * osd_factor_x)
elseif config.osd_alignment_x == 'right' then
osd_margin_x = round(right * osd_factor_x)
end
mp.set_property_native('osd-margin-y', osd_margin_y + config.osd_margin_y)
mp.set_property_native('osd-margin-x', osd_margin_x + config.osd_margin_x)
end
function create_state_setter(name, callback)
return function(_, value)
set_state(name, value)
if callback then callback() end
request_render()
end
end
function set_state(name, value)
state[name] = value
call_maybe(state['on_' .. name], value)
Elements:trigger('prop_' .. name, value)
end
function handle_file_end()
local resume = false
if not state.loop_file then
if state.has_playlist then
resume = state.shuffle and navigate_playlist(1)
else
resume = options.autoload and navigate_directory(1)
end
end
-- Resume only when navigation happened
if resume then mp.command('set pause no') end
end
local file_end_timer = mp.add_timeout(1, handle_file_end)
file_end_timer:kill()
function load_file_index_in_current_directory(index)
if not state.path or is_protocol(state.path) then return end
local serialized = serialize_path(state.path)
if serialized and serialized.dirname then
local files = read_directory(serialized.dirname, {
types = config.types.autoload,
hidden = options.show_hidden_files,
})
if not files then return end
sort_strings(files)
if index < 0 then index = #files + index + 1 end
if files[index] then
mp.commandv('loadfile', join_path(serialized.dirname, files[index]))
end
end
end
function update_render_delay(name, fps)
if fps then state.render_delay = 1 / fps end
end
function observe_display_fps(name, fps)
if fps then
mp.unobserve_property(update_render_delay)
mp.unobserve_property(observe_display_fps)
mp.observe_property('display-fps', 'native', update_render_delay)
end
end
function select_current_chapter()
local current_chapter
if state.time and state.chapters then
_, current_chapter = itable_find(state.chapters, function(c) return state.time >= c.time end, #state.chapters, 1)
end
set_state('current_chapter', current_chapter)
end
--[[ STATE HOOKS ]]
-- Click detection
if options.click_threshold > 0 then
-- Executes custom command for clicks shorter than `options.click_threshold`
-- while filtering out double clicks.
local click_time = options.click_threshold / 1000
local doubleclick_time = mp.get_property_native('input-doubleclick-time') / 1000
local last_down, last_up = 0, 0
local click_timer = mp.add_timeout(math.max(click_time, doubleclick_time), function()
local delta = last_up - last_down
if delta > 0 and delta < click_time and delta > 0.02 then mp.command(options.click_command) end
end)
click_timer:kill()
local function handle_up() last_up = mp.get_time() end
local function handle_down()
last_down = mp.get_time()
if click_timer:is_enabled() then click_timer:kill() else click_timer:resume() end
end
-- If this function exists, it'll be called at the beginning of render().
function setup_click_detection()
local hitbox = {ax = 0, ay = 0, bx = display.width, by = display.height, window_drag = true}
cursor:zone('primary_down', hitbox, handle_down)
cursor:zone('primary_up', hitbox, handle_up)
end
end
mp.observe_property('osc', 'bool', function(name, value) if value == true then mp.set_property('osc', 'no') end end)
mp.register_event('file-loaded', function()
local path = normalize_path(mp.get_property_native('path'))
itable_delete_value(state.history, path)
state.history[#state.history + 1] = path
set_state('path', path)
-- Flash top bar on requested file types
for _, type in ipairs(config.top_bar_flash_on) do
if state['is_' .. type] then
Elements:flash({'top_bar'})
break
end
end
end)
mp.register_event('end-file', function(event)
set_state('path', nil)
if event.reason == 'eof' then
file_end_timer:kill()
handle_file_end()
end
end)
-- Top bar titles
do
local function update_state_with_template(prop, template)
-- escape ASS, and strip newlines and trailing slashes and trim whitespace
local tmp = mp.command_native({'expand-text', template}):gsub('\\n', ' '):gsub('[\\%s]+$', ''):gsub('^%s+', '')
set_state(prop, ass_escape(tmp))
end
local function add_template_listener(template, callback)
local props = get_expansion_props(template)
for prop, _ in pairs(props) do
mp.observe_property(prop, 'native', callback)
end
if not next(props) then callback() end
end
local function remove_template_listener(callback) mp.unobserve_property(callback) end
-- Main title
if #options.top_bar_title > 0 and options.top_bar_title ~= 'no' then
if options.top_bar_title == 'yes' then
local template = nil
local function update_title() update_state_with_template('title', template) end
mp.observe_property('title', 'string', function(_, title)
remove_template_listener(update_title)
template = title
if template then
if template:sub(-6) == ' - mpv' then template = template:sub(1, -7) end
add_template_listener(template, update_title)
end
end)
elseif type(options.top_bar_title) == 'string' then
add_template_listener(options.top_bar_title, function()
update_state_with_template('title', options.top_bar_title)
end)
end
end
-- Alt title
if #options.top_bar_alt_title > 0 and options.top_bar_alt_title ~= 'no' then
add_template_listener(options.top_bar_alt_title, function()
update_state_with_template('alt_title', options.top_bar_alt_title)
end)
end
end
mp.observe_property('playback-time', 'number', create_state_setter('time', function()
-- Create a file-end event that triggers right before file ends
file_end_timer:kill()
if state.duration and state.time and not state.pause then
local remaining = (state.duration - state.time) / state.speed
if remaining < 5 then
local timeout = remaining - 0.02
if timeout > 0 then
file_end_timer.timeout = timeout
file_end_timer:resume()
else
handle_file_end()
end
end
end
update_human_times()
select_current_chapter()
end))
mp.observe_property('duration', 'number', create_state_setter('duration', update_human_times))
mp.observe_property('speed', 'number', create_state_setter('speed', update_human_times))
mp.observe_property('track-list', 'native', function(name, value)
-- checks the file dispositions
local types = {sub = 0, image = 0, audio = 0, video = 0}
for _, track in ipairs(value) do
if track.type == 'video' then
if track.image or track.albumart then
types.image = types.image + 1
else
types.video = types.video + 1
end
elseif types[track.type] then
types[track.type] = types[track.type] + 1
end
end
set_state('is_audio', types.video == 0 and types.audio > 0)
set_state('is_image', types.image > 0 and types.video == 0 and types.audio == 0)
set_state('has_image', types.image > 0)
set_state('has_audio', types.audio > 0)
set_state('has_many_audio', types.audio > 1)
set_state('has_sub', types.sub > 0)
set_state('has_many_sub', types.sub > 1)
set_state('is_video', types.video > 0)
set_state('has_many_video', types.video > 1)
Elements:trigger('dispositions')
end)
mp.observe_property('editions', 'number', function(_, editions)
if editions then set_state('has_many_edition', editions > 1) end
Elements:trigger('dispositions')
end)
mp.observe_property('chapter-list', 'native', function(_, chapters)
local chapters, chapter_ranges = serialize_chapters(chapters), {}
if chapters then chapters, chapter_ranges = serialize_chapter_ranges(chapters) end
set_state('chapters', chapters)
set_state('chapter_ranges', chapter_ranges)
set_state('has_chapter', #chapters > 0)
select_current_chapter()
Elements:trigger('dispositions')
end)
mp.observe_property('border', 'bool', create_state_setter('border'))
mp.observe_property('title-bar', 'bool', create_state_setter('title_bar'))
mp.observe_property('loop-file', 'native', create_state_setter('loop_file'))
mp.observe_property('ab-loop-a', 'number', create_state_setter('ab_loop_a'))
mp.observe_property('ab-loop-b', 'number', create_state_setter('ab_loop_b'))
mp.observe_property('playlist-pos-1', 'number', create_state_setter('playlist_pos'))
mp.observe_property('playlist-count', 'number', function(_, value)
set_state('playlist_count', value)
set_state('has_playlist', value > 1)
Elements:trigger('dispositions')
end)
mp.observe_property('fullscreen', 'bool', create_state_setter('fullscreen', update_fullormaxed))
mp.observe_property('window-maximized', 'bool', create_state_setter('maximized', update_fullormaxed))
mp.observe_property('idle-active', 'bool', function(_, idle)
set_state('is_idle', idle)
Elements:trigger('dispositions')
end)
mp.observe_property('pause', 'bool', create_state_setter('pause', function() file_end_timer:kill() end))
mp.observe_property('volume', 'number', create_state_setter('volume'))
mp.observe_property('volume-max', 'number', create_state_setter('volume_max'))
mp.observe_property('mute', 'bool', create_state_setter('mute'))
mp.observe_property('osd-dimensions', 'native', function(name, val)
update_display_dimensions()
request_render()
end)
mp.observe_property('display-hidpi-scale', 'native', create_state_setter('hidpi_scale', update_display_dimensions))
mp.observe_property('cache', 'string', create_state_setter('cache'))
mp.observe_property('cache-buffering-state', 'number', create_state_setter('cache_buffering'))
mp.observe_property('demuxer-via-network', 'native', create_state_setter('is_stream', function()
Elements:trigger('dispositions')
end))
mp.observe_property('demuxer-cache-state', 'native', function(prop, cache_state)
local cached_ranges, bof, eof, uncached_ranges = nil, nil, nil, nil
if cache_state then
cached_ranges, bof, eof = cache_state['seekable-ranges'], cache_state['bof-cached'], cache_state['eof-cached']
set_state('cache_underrun', cache_state['underrun'])
else
cached_ranges = {}
end
if not (state.duration and (#cached_ranges > 0 or state.cache == 'yes' or
(state.cache == 'auto' and state.is_stream))) then
if state.uncached_ranges then set_state('uncached_ranges', nil) end
return
end
-- Normalize
local ranges = {}
for _, range in ipairs(cached_ranges) do
ranges[#ranges + 1] = {
math.max(range['start'] or 0, 0),
math.min(range['end'] or state.duration, state.duration),
}
end
table.sort(ranges, function(a, b) return a[1] < b[1] end)
if bof then ranges[1][1] = 0 end
if eof then ranges[#ranges][2] = state.duration end
-- Invert cached ranges into uncached ranges, as that's what we're rendering
local inverted_ranges = {{0, state.duration}}
for _, cached in pairs(ranges) do
inverted_ranges[#inverted_ranges][2] = cached[1]
inverted_ranges[#inverted_ranges + 1] = {cached[2], state.duration}
end
uncached_ranges = {}
local last_range = nil
for _, range in ipairs(inverted_ranges) do
if last_range and last_range[2] + 0.5 > range[1] then -- fuse ranges
last_range[2] = range[2]
else
if range[2] - range[1] > 0.5 then -- skip short ranges
uncached_ranges[#uncached_ranges + 1] = range
last_range = range
end
end
end
set_state('uncached_ranges', uncached_ranges)
end)
mp.observe_property('display-fps', 'native', observe_display_fps)
mp.observe_property('estimated-display-fps', 'native', update_render_delay)
mp.observe_property('eof-reached', 'native', create_state_setter('eof_reached'))
mp.observe_property('core-idle', 'native', create_state_setter('core_idle'))
--[[ KEY BINDS ]]
-- Adds a key binding that respects rerouting set by `key_binding_overwrites` table.
---@param name string
---@param callback fun(event: table)
---@param flags nil|string
function bind_command(name, callback, flags)
mp.add_key_binding(nil, name, function(...)
if key_binding_overwrites[name] then
mp.command(key_binding_overwrites[name])
else
callback(...)
end
end, flags)
end
bind_command('toggle-ui', function() Elements:toggle({'timeline', 'controls', 'volume', 'top_bar'}) end)
bind_command('flash-ui', function() Elements:flash({'timeline', 'controls', 'volume', 'top_bar'}) end)
bind_command('flash-timeline', function() Elements:flash({'timeline'}) end)
bind_command('flash-top-bar', function() Elements:flash({'top_bar'}) end)
bind_command('flash-volume', function() Elements:flash({'volume'}) end)
bind_command('flash-speed', function() Elements:flash({'speed'}) end)
bind_command('flash-pause-indicator', function() Elements:flash({'pause_indicator'}) end)
bind_command('flash-progress', function() Elements:flash({'progress'}) end)
bind_command('toggle-progress', function() Elements:maybe('timeline', 'toggle_progress') end)
bind_command('toggle-title', function() Elements:maybe('top_bar', 'toggle_title') end)
bind_command('decide-pause-indicator', function() Elements:maybe('pause_indicator', 'decide') end)
bind_command('menu', function() toggle_menu_with_items() end)
bind_command('menu-blurred', function() toggle_menu_with_items({mouse_nav = true}) end)
bind_command('keybinds', function()
if Menu:is_open('keybinds') then
Menu:close()
else
open_command_menu({type = 'keybinds', items = get_keybinds_items(), search_style = 'palette'})
end
end)
bind_command('download-subtitles', open_subtitle_downloader)
bind_command('load-subtitles', create_track_loader_menu_opener({
name = 'subtitles', prop = 'sub', allowed_types = itable_join(config.types.video, config.types.subtitle),
}))
bind_command('load-audio', create_track_loader_menu_opener({
name = 'audio', prop = 'audio', allowed_types = itable_join(config.types.video, config.types.audio),
}))
bind_command('load-video', create_track_loader_menu_opener({
name = 'video', prop = 'video', allowed_types = config.types.video,
}))
bind_command('subtitles', create_select_tracklist_type_menu_opener(
t('Subtitles'), 'sub', 'sid', 'script-binding uosc/load-subtitles', 'script-binding uosc/download-subtitles'
))
bind_command('audio', create_select_tracklist_type_menu_opener(
t('Audio'), 'audio', 'aid', 'script-binding uosc/load-audio'
))
bind_command('video', create_select_tracklist_type_menu_opener(
t('Video'), 'video', 'vid', 'script-binding uosc/load-video'
))
bind_command('playlist', create_self_updating_menu_opener({
title = t('Playlist'),
type = 'playlist',
list_prop = 'playlist',
serializer = function(playlist)
local items = {}
for index, item in ipairs(playlist) do
local is_url = is_protocol(item.filename)
local item_title = type(item.title) == 'string' and #item.title > 0 and item.title or false
items[index] = {
title = item_title or (is_url and item.filename or serialize_path(item.filename).basename),
hint = tostring(index),
active = item.current,
value = index,
}
end
return items
end,
on_select = function(index) mp.commandv('set', 'playlist-pos-1', tostring(index)) end,
on_move_item = function(from, to)
mp.commandv('playlist-move', tostring(math.max(from, to) - 1), tostring(math.min(from, to) - 1))
end,
on_delete_item = function(index) mp.commandv('playlist-remove', tostring(index - 1)) end,
}))
bind_command('chapters', create_self_updating_menu_opener({
title = t('Chapters'),
type = 'chapters',
list_prop = 'chapter-list',
active_prop = 'chapter',
serializer = function(chapters, current_chapter)
local items = {}
chapters = normalize_chapters(chapters)
for index, chapter in ipairs(chapters) do
items[index] = {
title = chapter.title or '',
hint = format_time(chapter.time, state.duration),
value = index,
active = index - 1 == current_chapter,
}
end
return items
end,
on_select = function(index) mp.commandv('set', 'chapter', tostring(index - 1)) end,
}))
bind_command('editions', create_self_updating_menu_opener({
title = t('Editions'),
type = 'editions',
list_prop = 'edition-list',
active_prop = 'current-edition',
serializer = function(editions, current_id)
local items = {}
for _, edition in ipairs(editions or {}) do
local edition_id_1 = tostring(edition.id + 1)
items[#items + 1] = {
title = edition.title or t('Edition %s', edition_id_1),
hint = edition_id_1,
value = edition.id,
active = edition.id == current_id,
}
end
return items
end,
on_select = function(id) mp.commandv('set', 'edition', id) end,
}))
bind_command('show-in-directory', function()
-- Ignore URLs
if not state.path or is_protocol(state.path) then return end
if state.platform == 'windows' then
utils.subprocess_detached({args = {'explorer', '/select,', state.path .. ' '}, cancellable = false})
elseif state.platform == 'darwin' then
utils.subprocess_detached({args = {'open', '-R', state.path}, cancellable = false})
elseif state.platform == 'linux' then
local result = utils.subprocess({args = {'nautilus', state.path}, cancellable = false})
-- Fallback opens the folder with xdg-open instead
if result.status ~= 0 then
utils.subprocess({args = {'xdg-open', serialize_path(state.path).dirname}, cancellable = false})
end
end
end)
bind_command('stream-quality', open_stream_quality_menu)
bind_command('open-file', open_open_file_menu)
bind_command('shuffle', function() set_state('shuffle', not state.shuffle) end)
bind_command('items', function()
if state.has_playlist then
mp.command('script-binding uosc/playlist')
else
mp.command('script-binding uosc/open-file')
end
end)
bind_command('next', function() navigate_item(1) end)
bind_command('prev', function() navigate_item(-1) end)
bind_command('next-file', function() navigate_directory(1) end)
bind_command('prev-file', function() navigate_directory(-1) end)
bind_command('first', function()
if state.has_playlist then
mp.commandv('set', 'playlist-pos-1', '1')
else
load_file_index_in_current_directory(1)
end
end)
bind_command('last', function()
if state.has_playlist then
mp.commandv('set', 'playlist-pos-1', tostring(state.playlist_count))
else
load_file_index_in_current_directory(-1)
end
end)
bind_command('first-file', function() load_file_index_in_current_directory(1) end)
bind_command('last-file', function() load_file_index_in_current_directory(-1) end)
bind_command('delete-file-prev', function() delete_file_navigate(-1) end)
bind_command('delete-file-next', function() delete_file_navigate(1) end)
bind_command('delete-file-quit', function()
mp.command('stop')
if state.path and not is_protocol(state.path) then delete_file(state.path) end
mp.command('quit')
end)
bind_command('audio-device', create_self_updating_menu_opener({
title = t('Audio devices'),
type = 'audio-device-list',
list_prop = 'audio-device-list',
active_prop = 'audio-device',
serializer = function(audio_device_list, current_device)
current_device = current_device or 'auto'
local ao = mp.get_property('current-ao') or ''
local items = {}
for _, device in ipairs(audio_device_list) do
if device.name == 'auto' or string.match(device.name, '^' .. ao) then
local hint = string.match(device.name, ao .. '/(.+)')
if not hint then hint = device.name end
items[#items + 1] = {
title = device.description:sub(1, 7) == 'Default'
and t('Default %s', device.description:sub(9))
or device.description,
hint = hint,
active = device.name == current_device,
value = device.name,
}
end
end
return items
end,
on_select = function(name) mp.commandv('set', 'audio-device', name) end,
}))
bind_command('open-config-directory', function()
local config_path = mp.command_native({'expand-path', '~~/mpv.conf'})
local config = serialize_path(normalize_path(config_path))
if config then
local args
if state.platform == 'windows' then
args = {'explorer', '/select,', config.path}
elseif state.platform == 'darwin' then
args = {'open', '-R', config.path}
elseif state.platform == 'linux' then
args = {'xdg-open', config.dirname}
end
utils.subprocess_detached({args = args, cancellable = false})
else
msg.error('Couldn\'t serialize config path "' .. config_path .. '".')
end
end)
bind_command('update', function()
if not Elements:has('updater') then require('elements/Updater'):new() end
end)
--[[ MESSAGE HANDLERS ]]
mp.register_script_message('show-submenu', function(id) toggle_menu_with_items({submenu = id}) end)
mp.register_script_message('show-submenu-blurred', function(id)
toggle_menu_with_items({submenu = id, mouse_nav = true})
end)
mp.register_script_message('open-menu', function(json, submenu_id)
local data = utils.parse_json(json)
if type(data) ~= 'table' or type(data.items) ~= 'table' then
msg.error('open-menu: received json didn\'t produce a table with menu configuration')
else
open_command_menu(data, {submenu = submenu_id, on_close = data.on_close})
end
end)
mp.register_script_message('update-menu', function(json)
local data = utils.parse_json(json)
if type(data) ~= 'table' or type(data.items) ~= 'table' then
msg.error('update-menu: received json didn\'t produce a table with menu configuration')
else
local menu = data.type and Menu:is_open(data.type)
if menu then menu:update(data) end
end
end)
mp.register_script_message('close-menu', function(type)
if Menu:is_open(type) then Menu:close() end
end)
mp.register_script_message('thumbfast-info', function(json)
local data = utils.parse_json(json)
if type(data) ~= 'table' or not data.width or not data.height then
thumbnail.disabled = true
msg.error('thumbfast-info: received json didn\'t produce a table with thumbnail information')
else
thumbnail = data
request_render()
end
end)
mp.register_script_message('set', function(name, value)
external[name] = value
Elements:trigger('external_prop_' .. name, value)
end)
mp.register_script_message('toggle-elements', function(elements) Elements:toggle(comma_split(elements)) end)
mp.register_script_message('set-min-visibility', function(visibility, elements)
local fraction = tonumber(visibility)
local ids = comma_split(elements and elements ~= '' and elements or 'timeline,controls,volume,top_bar')
if fraction then Elements:set_min_visibility(clamp(0, fraction, 1), ids) end
end)
mp.register_script_message('flash-elements', function(elements) Elements:flash(comma_split(elements)) end)
mp.register_script_message('overwrite-binding', function(name, command) key_binding_overwrites[name] = command end)
mp.register_script_message('disable-elements', function(id, elements) Manager:disable(id, elements) end)
--[[ ELEMENTS ]]
-- Dynamic elements
local constructors = {
window_border = require('elements/WindowBorder'),
buffering_indicator = require('elements/BufferingIndicator'),
pause_indicator = require('elements/PauseIndicator'),
top_bar = require('elements/TopBar'),
timeline = require('elements/Timeline'),
controls = options.controls and options.controls ~= 'never' and require('elements/Controls'),
volume = itable_index_of({'left', 'right'}, options.volume) and require('elements/Volume'),
}
-- Required elements
require('elements/Curtain'):new()
-- Element manager
-- Handles creating and destroying elements based on disabled_elements user+script config.
Manager = {
-- Managed disable-able element IDs
_ids = itable_join(table_keys(constructors), {'idle_indicator', 'audio_indicator'}),
---@type table<string, string[]> A map of clients and a list of element ids they disable
_disabled_by = {},
---@type table<string, boolean>
disabled = {},
}
-- Set client and which elements it wishes disabled. To undo just pass an empty `element_ids` for the same `client`.
---@param client string
---@param element_ids string|string[]|nil `foo,bar` or `{'foo', 'bar'}`.
function Manager:disable(client, element_ids)
self._disabled_by[client] = comma_split(element_ids)
self.disabled = create_set(itable_join(unpack(table_values(self._disabled_by))))
self:_commit()
end
function Manager:_commit()
-- Create and destroy elements as needed
for _, id in ipairs(self._ids) do
local constructor = constructors[id]
if not self.disabled[id] then
if not Elements:has(id) and constructor then constructor:new() end
else
Elements:maybe(id, 'destroy')
end
end
-- We use `on_display` event to tell elements to update their dimensions
Elements:trigger('display')
end
-- Initial commit
Manager:disable('user', options.disable_elements)