changes
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
# lsns
|
||||
# List information about all namespaces or about the specified namespace.
|
||||
# More information: <https://man7.org/linux/man-pages/man8/lsns.8.html>.
|
||||
|
||||
# List all namespaces:
|
||||
lsns
|
||||
|
||||
# List namespaces in JSON format:
|
||||
lsns --json
|
||||
|
||||
# List namespaces associated with {{pid}}:
|
||||
lsns --task pid
|
||||
|
||||
# List the specified type of namespaces only:
|
||||
lsns --type <mnt|net|ipc|user|pid|uts|cgroup|time>
|
||||
|
||||
# List the namespaces in Tree format
|
||||
lsns -T
|
||||
|
||||
# List namespaces, only showing the namespace ID, type, PID, and command:
|
||||
lsns --output NS,TYPE,PID,COMMAND
|
||||
@@ -42,6 +42,11 @@ pacman -Qqn | pacman -S -
|
||||
# To install a package from builded package file (.tar.xz) (manually)
|
||||
pacman -U <file name/file url>
|
||||
|
||||
# Downgrade
|
||||
sudo pacman -U https://archive.archlinux.org/packages/w/wireplumber/wireplumber-0.4.17-1-x86_64.pkg.tar.zst
|
||||
https://archive.archlinux.org/packages/l/libwireplumber/libwireplumber-0.4.17-1-x86_64.pkg.tar.zst
|
||||
|
||||
|
||||
#################### update mirrors #####################
|
||||
# update mirror with https Germany
|
||||
sudo reflector --country DE --age 24 --protocol https --sort score --save /etc/pacman.d/mirrorlist
|
||||
|
||||
@@ -8,6 +8,8 @@ bind = $mainMod, RETURN, exec, wezterm # Open Wezterm
|
||||
bind = $mainMod, E, exec, dolphin # Open Dolphin
|
||||
bind =$mainMod, SPACE, exec,rofi -show # lunch rofi application menu
|
||||
bind = $mainMod, l, exec, hyprlock # Screenlock
|
||||
bind = $mainMod, q, exec, copyq show # Clipboard
|
||||
|
||||
# Key([], "Print", lazy.spawn("flameshot gui"), desc="Screenshot gui"),
|
||||
# Key([mod], "Escape", lazy.spawn("betterlockscreen -l dim "), desc="Lockscreen"),
|
||||
# Key([mod], "e", lazy.spawn(myTerm + " -e ranger"), desc="lunch Ranger"),
|
||||
@@ -57,6 +59,10 @@ bind = $mainMod, P, pseudo, # dwindle
|
||||
# KeyNode([mod4, "control"], "l", [], lazy.layout.grow_right(), desc="Grow right"),
|
||||
|
||||
|
||||
|
||||
bind = $mainMod, m, fullscreen
|
||||
bind = $mainMod ALT, m, fakefullscreen
|
||||
|
||||
# Moves the active window in a direction or to a monitor
|
||||
bind = $mainMod CTRL, h, movewindow, l
|
||||
bind = $mainMod CTRL, l, movewindow, r
|
||||
|
||||
@@ -22,7 +22,7 @@ windowrulev2 = float,title:^(Picture-in-Picture)$
|
||||
windowrulev2 = float,class:^(Viewnior)$
|
||||
windowrulev2 = float,title:^(DevTools)$
|
||||
windowrulev2 = float,title:^(Kopiervorgang)(.*)$
|
||||
windowrulev2 = float,title:^(Verschiebvorgang)(.*)$
|
||||
windowrulev2 = float,title:^(Verschiebevorgang)(.*)$
|
||||
windowrulev2 = float,class:^(file_progress)$
|
||||
windowrulev2 = float,class:^(confirm)$
|
||||
windowrulev2 = float,class:^(dialog)$
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
acpi
|
||||
neovim
|
||||
goverlay
|
||||
alacritty
|
||||
alsa-oss
|
||||
alsa-tools
|
||||
|
||||
@@ -5,6 +5,7 @@ beautysh
|
||||
bluetuith-bin
|
||||
buku
|
||||
xdg-unused-data-git
|
||||
jnv
|
||||
catppuccin-gtk-theme-mocha
|
||||
cheat-bin
|
||||
cpu-x
|
||||
@@ -31,6 +32,7 @@ kvantum-theme-catppuccin-git
|
||||
lnav
|
||||
localsend-bin
|
||||
mangohud
|
||||
netscanner-bin
|
||||
masterpdfeditor
|
||||
mcmojave-cursors-git
|
||||
mkv-extractor-qt
|
||||
|
||||
@@ -29,6 +29,15 @@ video/3gpp=mpv.desktop;
|
||||
video/mp4=mpv.desktop;
|
||||
video/webm=mpv.desktop;
|
||||
video/x-matroska=mpv.desktop;
|
||||
application/x-tar=ark.desktop;
|
||||
application/gzip=ark.desktop;
|
||||
application/gzip-compressed-tar=ark.desktop;
|
||||
application/x-zip=ark.desktop;
|
||||
application/x-zip-compressed-tar=ark.desktop;
|
||||
application/zip=ark.desktop;
|
||||
application/zip-compressed-tar=ark.desktop;
|
||||
application/x-bzip2=ark.desktop;
|
||||
application/x-bzip2-compressed-tar=ark.desktop;
|
||||
x-scheme-handler/about=brave-browser.desktop
|
||||
x-scheme-handler/eclipse+command=_usr_lib_dbeaver_.desktop
|
||||
x-scheme-handler/etcher=balena-etcher.desktop
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# addons
|
||||
|
||||
Add-ons are ways to add extra features to file-browser, for example adding support for network file servers like ftp, or implementing virtual directories in the root like recently opened files.
|
||||
They can be enabled by setting `addon` script-opt to yes, and placing the addon file into the `~~/script-modules/file-browser-addons/` directory.
|
||||
|
||||
Browsing filesystems provided by add-ons should feel identical to the normal handling of the script,
|
||||
but they may require extra commandline tools be installed.
|
||||
|
||||
Since addons are loaded programatically from the addon directory it is possible for anyone to write their own addon.
|
||||
Instructions on how to do this are available [here](../docs/addons.md).
|
||||
|
||||
For a list of available addons see the [wiki](https://github.com/CogentRedTester/mpv-file-browser/wiki/Addon-List).
|
||||
@@ -0,0 +1,89 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which adds support for apache http directory indexes
|
||||
]]--
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
local fb = require "file-browser"
|
||||
|
||||
--decodes a URL address
|
||||
--this piece of code was taken from: https://stackoverflow.com/questions/20405985/lua-decodeuri-luvit/20406960#20406960
|
||||
local decodeURI
|
||||
do
|
||||
local char, gsub, tonumber = string.char, string.gsub, tonumber
|
||||
local function _(hex) return char(tonumber(hex, 16)) end
|
||||
|
||||
function decodeURI(s)
|
||||
s = gsub(s, '%%(%x%x)', _)
|
||||
return s
|
||||
end
|
||||
end
|
||||
|
||||
local apache = {
|
||||
priority = 80,
|
||||
version = "1.1.0"
|
||||
}
|
||||
|
||||
function apache:can_parse(name)
|
||||
return name:find("^https?://")
|
||||
end
|
||||
|
||||
--send curl errors through the browser empty_text
|
||||
function apache:send_error(str)
|
||||
return {}, {empty_text = "curl error: "..str}
|
||||
end
|
||||
|
||||
local function execute(args)
|
||||
msg.trace(utils.to_string(args))
|
||||
local _, cmd = fb.get_parse_state():yield(
|
||||
mp.command_native_async({
|
||||
name = "subprocess",
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
capture_stderr = true,
|
||||
args = args
|
||||
}, fb.coroutine.callback())
|
||||
)
|
||||
return cmd
|
||||
end
|
||||
|
||||
function apache:parse(directory)
|
||||
msg.verbose(directory)
|
||||
|
||||
local test = execute({"curl", "-k", "-l", "-I", directory})
|
||||
local response = test.stdout:match("(%d%d%d [^\n\r]+)")
|
||||
if test.stdout:match("Content%-Type: ([^\r\n/]+)") ~= "text" then return nil end
|
||||
if response ~= "200 OK" then return self:send_error(response) end
|
||||
|
||||
local html = execute({"curl", "-k", "-l", directory})
|
||||
if html.status ~= 0 then return self:send_error(tostring(html.status))
|
||||
elseif not html.stdout:find("%[PARENTDIR%]") then return nil end
|
||||
|
||||
html = html.stdout
|
||||
local list = {}
|
||||
for str in string.gmatch(html, "[^\r\n]+") do
|
||||
local valid = true
|
||||
if str:sub(1,4) ~= "<tr>" then valid = false end
|
||||
|
||||
local link = str:match('href="(.-)"')
|
||||
local alt = str:match('alt="%[(.-)%]"')
|
||||
|
||||
if valid and not alt or not link then valid = false end
|
||||
if valid and alt == "PARENTDIR" or alt == "ICO" then valid = false end
|
||||
if valid and link:find("[:?<>|]") then valid = false end
|
||||
|
||||
local is_dir = (alt == "DIR")
|
||||
if valid and is_dir and not self.valid_dir(link) then valid = false end
|
||||
if valid and not is_dir and not self.valid_file(link) then valid = false end
|
||||
|
||||
if valid then
|
||||
msg.trace(alt..": "..link)
|
||||
table.insert(list, { name = link, type = (is_dir and "dir" or "file"), label = decodeURI(link) })
|
||||
end
|
||||
end
|
||||
|
||||
return list, {filtered = true, directory_label = decodeURI(directory)}
|
||||
end
|
||||
|
||||
return apache
|
||||
@@ -0,0 +1,191 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which adds a Favourites path that can be loaded from the ROOT
|
||||
]]--
|
||||
|
||||
local mp = require "mp"
|
||||
local msg = require "mp.msg"
|
||||
local utils = require "mp.utils"
|
||||
local save_path = mp.command_native({"expand-path", "~~/script-opts/file_browser_favourites.txt"})
|
||||
do
|
||||
local file = io.open(save_path, "a+")
|
||||
if not file then
|
||||
msg.error("cannot access file", ("%q"):format(save_path), "make sure that the directory exists")
|
||||
return {}
|
||||
end
|
||||
file:close()
|
||||
end
|
||||
|
||||
local favourites = nil
|
||||
local favs = {
|
||||
version = "1.4.0",
|
||||
priority = 30,
|
||||
cursor = 1
|
||||
}
|
||||
|
||||
local use_virtual_directory = true
|
||||
local full_paths = {}
|
||||
|
||||
local function create_favourite_object(str)
|
||||
local item = {
|
||||
type = str:sub(-1) == "/" and "dir" or "file",
|
||||
path = str,
|
||||
redirect = not use_virtual_directory,
|
||||
name = str:match("([^/]+/?)$")
|
||||
}
|
||||
full_paths[str:match("([^/]+)/?$")] = str
|
||||
return item
|
||||
end
|
||||
|
||||
function favs:setup()
|
||||
self:register_root_item('Favourites/')
|
||||
end
|
||||
|
||||
local function update_favourites()
|
||||
favourites = {}
|
||||
|
||||
local file = io.open(save_path, "r")
|
||||
if not file then return end
|
||||
|
||||
for str in file:lines() do
|
||||
table.insert(favourites, create_favourite_object(str))
|
||||
end
|
||||
file:close()
|
||||
end
|
||||
|
||||
function favs:can_parse(directory)
|
||||
return directory:find("Favourites/") == 1
|
||||
end
|
||||
|
||||
function favs:parse(directory)
|
||||
if not favourites then update_favourites() end
|
||||
if directory == "Favourites/" then
|
||||
local opts = {
|
||||
filtered = true,
|
||||
sorted = true
|
||||
}
|
||||
if self.cursor ~= 1 then opts.selected_index = self.cursor ; self.cursor = 1 end
|
||||
return favourites, opts
|
||||
end
|
||||
|
||||
if use_virtual_directory then
|
||||
-- converts the relative favourite path into a full path
|
||||
local name = directory:match("Favourites/([^/]+)/?")
|
||||
|
||||
local _, finish = directory:find("Favourites/([^/]+/?)")
|
||||
local full_path = (full_paths[name] or "")..directory:sub(finish+1)
|
||||
local list, opts = self:defer(full_path or "")
|
||||
|
||||
if not list then return nil end
|
||||
opts.id = self:get_id()
|
||||
if opts.directory_label then
|
||||
opts.directory_label = opts.directory_label:gsub(full_paths[name], "Favourites/"..name..'/')
|
||||
if opts.directory_label:find("Favourites/") ~= 1 then opts.directory_label = nil end
|
||||
end
|
||||
|
||||
for _, item in ipairs(list) do
|
||||
if not item.path then item.redirect = false end
|
||||
item.path = item.path or full_path..item.name
|
||||
end
|
||||
|
||||
return list, opts
|
||||
end
|
||||
|
||||
local path = full_paths[ directory:match("([^/]+/?)$") or "" ]
|
||||
|
||||
local list, opts = self:defer(path)
|
||||
if not list then return nil end
|
||||
opts.directory = opts.directory or path
|
||||
return list, opts
|
||||
end
|
||||
|
||||
local function get_favourite(path)
|
||||
for index, value in ipairs(favourites) do
|
||||
if value.path == path then return index, value end
|
||||
end
|
||||
end
|
||||
|
||||
--update the browser with new contents of the file
|
||||
local function update_browser()
|
||||
if favs.get_directory():find("[fF]avourites/") then
|
||||
if favs.get_directory():find("[fF]avourites/$") then
|
||||
local cursor = favs.get_selected_index()
|
||||
favs.rescan()
|
||||
favs.set_selected_index(cursor)
|
||||
favs.redraw()
|
||||
else
|
||||
favs.clear_cache()
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--write the contents of favourites to the file
|
||||
local function write_to_file()
|
||||
local file = io.open(save_path, "w+")
|
||||
if not file then return msg.error(file, "could not open favourites file") end
|
||||
for _, item in ipairs(favourites) do
|
||||
file:write(string.format("%s\n", item.path))
|
||||
end
|
||||
file:close()
|
||||
end
|
||||
|
||||
local function add_favourite(path)
|
||||
if get_favourite(path) then return end
|
||||
update_favourites()
|
||||
table.insert(favourites, create_favourite_object(path))
|
||||
write_to_file()
|
||||
end
|
||||
|
||||
local function remove_favourite(path)
|
||||
update_favourites()
|
||||
local index = get_favourite(path)
|
||||
if not index then return end
|
||||
table.remove(favourites, index)
|
||||
write_to_file()
|
||||
end
|
||||
|
||||
local function move_favourite(path, direction)
|
||||
update_favourites()
|
||||
local index, item = get_favourite(path)
|
||||
if not index or not favourites[index + direction] then return end
|
||||
|
||||
favourites[index] = favourites[index + direction]
|
||||
favourites[index + direction] = item
|
||||
write_to_file()
|
||||
end
|
||||
|
||||
local function toggle_favourite(cmd, state, co)
|
||||
local path = favs.get_full_path(state.list[state.selected], state.directory)
|
||||
|
||||
if state.directory:find("[fF]avourites/$") then remove_favourite(path)
|
||||
else add_favourite(path) end
|
||||
update_browser()
|
||||
end
|
||||
|
||||
local function move_key(cmd, state, co)
|
||||
if not state.directory:find("[fF]avourites/") then return false end
|
||||
local path = favs.get_full_path(state.list[state.selected], state.directory)
|
||||
|
||||
local cursor = favs.get_selected_index()
|
||||
if cmd.name == favs:get_id().."/move_up" then
|
||||
move_favourite(path, -1)
|
||||
favs.set_selected_index(cursor-1)
|
||||
else
|
||||
move_favourite(path, 1)
|
||||
favs.set_selected_index(cursor+1)
|
||||
end
|
||||
update_browser()
|
||||
end
|
||||
|
||||
update_favourites()
|
||||
mp.register_script_message("favourites/add_favourite", add_favourite)
|
||||
mp.register_script_message("favourites/remove_favourite", remove_favourite)
|
||||
mp.register_script_message("favourites/move_up", function(path) move_favourite(path, -1) end)
|
||||
mp.register_script_message("favourites/move_down", function(path) move_favourite(path, 1) end)
|
||||
|
||||
favs.keybinds = {
|
||||
{ "F", "toggle_favourite", toggle_favourite, {}, },
|
||||
{ "Ctrl+UP", "move_up", move_key, {repeatable = true} },
|
||||
{ "Ctrl+DOWN", "move_down", move_key, {repeatable = true} },
|
||||
}
|
||||
|
||||
return favs
|
||||
@@ -0,0 +1,95 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser for searching the current directory
|
||||
Available at: https://github.com/CogentRedTester/mpv-file-browser/tree/master/addons
|
||||
|
||||
Requires mpv-user-input: https://github.com/CogentRedTester/mpv-user-input
|
||||
|
||||
Keybinds:
|
||||
Ctrl+f open search box
|
||||
Ctrl+F open advanced search box (supports Lua patterns)
|
||||
n cycle to next valid item
|
||||
]]--
|
||||
|
||||
local msg = require "mp.msg"
|
||||
local fb = require "file-browser"
|
||||
local input = require "user-input-module"
|
||||
|
||||
local find = {
|
||||
version = "1.3.0"
|
||||
}
|
||||
local latest_coroutine = nil
|
||||
local global_fb_state = getmetatable(fb.get_state()).__original
|
||||
|
||||
local function compare(name, query)
|
||||
if name:find(query) then return true end
|
||||
if name:lower():find(query) then return true end
|
||||
if name:upper():find(query) then return true end
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
local function main(key, state, co)
|
||||
if not state.list then return false end
|
||||
|
||||
local text
|
||||
if key.name == "find/find" then text = "Find: enter search string"
|
||||
else text = "Find: enter advanced search string" end
|
||||
|
||||
local query, error = coroutine.yield(
|
||||
input.get_user_input( fb.coroutine.callback(), { text = text, id = "find", replace = true } )
|
||||
)
|
||||
|
||||
if not query then return msg.debug(error) end
|
||||
|
||||
-- allow the directory to be changed before this point
|
||||
local list = fb.get_list()
|
||||
local parse_id = global_fb_state.co
|
||||
|
||||
if key.name == "find/find" then
|
||||
query = fb.pattern_escape(query)
|
||||
end
|
||||
|
||||
local results = {}
|
||||
|
||||
for index, item in ipairs(list) do
|
||||
if compare(item.label or item.name, query) then
|
||||
table.insert(results, index)
|
||||
end
|
||||
end
|
||||
|
||||
if (#results < 1) then
|
||||
msg.warn("No matching items for '"..query.."'")
|
||||
return
|
||||
end
|
||||
|
||||
--keep cycling through the search results if any are found
|
||||
--putting this into a separate coroutine removes any passthrough ambiguity
|
||||
--the final return statement should return to `step_find` not any other function
|
||||
fb.coroutine.run(function()
|
||||
latest_coroutine = coroutine.running()
|
||||
while (true) do
|
||||
for _, index in ipairs(results) do
|
||||
fb.set_selected_index(index)
|
||||
coroutine.yield(true)
|
||||
|
||||
if parse_id ~= global_fb_state.co then
|
||||
latest_coroutine = nil
|
||||
return false
|
||||
end
|
||||
end
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
local function step_find()
|
||||
if not latest_coroutine then return false end
|
||||
return fb.coroutine.resume_err(latest_coroutine)
|
||||
end
|
||||
|
||||
find.keybinds = {
|
||||
{"Ctrl+f", "find", main, {}},
|
||||
{"Ctrl+F", "find_advanced", main, {}},
|
||||
{"n", "next", step_find, {}},
|
||||
}
|
||||
|
||||
return find
|
||||
@@ -0,0 +1,86 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which adds support for ftp servers
|
||||
]]--
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
local fb = require 'file-browser'
|
||||
|
||||
local ftp = {
|
||||
priority = 100,
|
||||
version = "1.1.0"
|
||||
}
|
||||
|
||||
function ftp:can_parse(directory)
|
||||
return directory:sub(1, 6) == "ftp://"
|
||||
end
|
||||
|
||||
--in my experience curl has been somewhat unreliable when it comes to ftp requests
|
||||
--this fuction retries the request a few times just in case
|
||||
local function execute(args)
|
||||
msg.debug(utils.to_string(args))
|
||||
local _, cmd = fb.get_parse_state():yield(
|
||||
mp.command_native_async({
|
||||
name = "subprocess",
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
capture_stderr = true,
|
||||
args = args
|
||||
}, fb.coroutine.callback())
|
||||
)
|
||||
return cmd
|
||||
end
|
||||
|
||||
-- encodes special characters using the URL percent encoding format
|
||||
function urlEncode(url)
|
||||
local domain, path = string.match(url, '(ftp://[^/]-/)(.*)')
|
||||
if not path then return url end
|
||||
|
||||
-- these are the unreserved URI characters according to RFC 3986
|
||||
-- https://www.rfc-editor.org/rfc/rfc3986#section-2.3
|
||||
path = string.gsub(path, '[^%w.~_%-]', function(c)
|
||||
return ('%%%x'):format(string.byte(c))
|
||||
end)
|
||||
return domain..path
|
||||
end
|
||||
|
||||
function ftp:parse(directory)
|
||||
msg.verbose(directory)
|
||||
|
||||
local ftp = execute({"curl", "-k", "-g", "--retry", "4", urlEncode(directory)})
|
||||
|
||||
local entries = execute({"curl", "-k", "-g", "-l", "--retry", "4", urlEncode(directory)})
|
||||
|
||||
if entries.status == 28 then
|
||||
msg.error(entries.stderr)
|
||||
elseif entries.status ~= 0 or ftp.status ~= 0 then
|
||||
msg.error(entries.stderr)
|
||||
return
|
||||
end
|
||||
|
||||
local response = {}
|
||||
for str in string.gmatch(ftp.stdout, "[^\r\n]+") do
|
||||
table.insert(response, str)
|
||||
end
|
||||
|
||||
local list = {}
|
||||
local i = 1
|
||||
for str in string.gmatch(entries.stdout, "[^\r\n]+") do
|
||||
if str and response[i] then
|
||||
msg.trace(str .. ' | ' .. response[i])
|
||||
|
||||
if response[i]:sub(1,1) == "d" then
|
||||
table.insert(list, { name = str..'/', type = "dir" })
|
||||
else
|
||||
table.insert(list, { name = str, type = "file" })
|
||||
end
|
||||
|
||||
i = i+1
|
||||
end
|
||||
end
|
||||
|
||||
return list
|
||||
end
|
||||
|
||||
return ftp
|
||||
@@ -0,0 +1,27 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which displays ~/ for the home directory instead of the full path
|
||||
]]--
|
||||
|
||||
local mp = require "mp"
|
||||
local fb = require "file-browser"
|
||||
|
||||
local home = fb.fix_path(mp.command_native({"expand-path", "~/"}), true)
|
||||
|
||||
local home_label = {
|
||||
priority = 100,
|
||||
version = "1.0.0"
|
||||
}
|
||||
|
||||
function home_label:can_parse(directory)
|
||||
return directory:sub(1, home:len()) == home
|
||||
end
|
||||
|
||||
function home_label:parse(directory)
|
||||
local list, opts = self:defer(directory)
|
||||
if (not opts.directory or opts.directory == directory) and not opts.directory_label then
|
||||
opts.directory_label = "~/"..(directory:sub(home:len()+1) or "")
|
||||
end
|
||||
return list, opts
|
||||
end
|
||||
|
||||
return home_label
|
||||
@@ -0,0 +1,55 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which uses the Linux ls command to parse native directories
|
||||
This behaves near identically to the native parser, but IO is done asynchronously.
|
||||
|
||||
Available at: https://github.com/CogentRedTester/mpv-file-browser/tree/master/addons
|
||||
]]--
|
||||
|
||||
local mp = require "mp"
|
||||
local fb = require "file-browser"
|
||||
|
||||
local ls = {
|
||||
priority = 109,
|
||||
version = "1.1.0",
|
||||
name = "ls",
|
||||
keybind_name = "file"
|
||||
}
|
||||
|
||||
local function command(args, parse_state)
|
||||
local _, cmd = parse_state:yield(
|
||||
mp.command_native_async({
|
||||
name = "subprocess",
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
capture_stderr = true,
|
||||
args = args
|
||||
}, fb.coroutine.callback())
|
||||
)
|
||||
|
||||
return cmd.status == 0 and cmd.stdout or nil
|
||||
end
|
||||
|
||||
function ls:can_parse(directory)
|
||||
return not fb.get_protocol(directory)
|
||||
end
|
||||
|
||||
function ls:parse(directory, parse_state)
|
||||
local list = {}
|
||||
local files = command({"ls", "-1", "-p", "-A", "-N", directory}, parse_state)
|
||||
|
||||
if not files then return nil end
|
||||
|
||||
for str in files:gmatch("[^\n\r]+") do
|
||||
local is_dir = str:sub(-1) == "/"
|
||||
|
||||
if is_dir and fb.valid_dir(str) then
|
||||
table.insert(list, {name = str, type = "dir"})
|
||||
elseif fb.valid_file(str) then
|
||||
table.insert(list, {name = str, type = "file"})
|
||||
end
|
||||
end
|
||||
|
||||
return list, {filtered = true}
|
||||
end
|
||||
|
||||
return ls
|
||||
@@ -0,0 +1,54 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which adds support for m3u playlists
|
||||
|
||||
If the first entry of a playlist isn't working it is because some playlists are created with random invisible unicode in the first line
|
||||
Vim makes it easy to detect these
|
||||
|
||||
This addon requires that my API mpv-read-file be available in ~~/script-modules/
|
||||
https://github.com/CogentRedTester/mpv-read-file
|
||||
]]--
|
||||
|
||||
local rf = require "read-file"
|
||||
|
||||
local m3u = {
|
||||
priority = 100,
|
||||
version = "1.0.0",
|
||||
name = "m3u"
|
||||
}
|
||||
|
||||
local full_paths = {}
|
||||
|
||||
function m3u:setup()
|
||||
self.register_parseable_extension("m3u")
|
||||
self.register_parseable_extension("m3u8")
|
||||
end
|
||||
|
||||
function m3u:can_parse(directory)
|
||||
return directory:find("m3u8?/?$")
|
||||
end
|
||||
|
||||
function m3u:parse(directory)
|
||||
directory = directory:gsub("/$", "")
|
||||
local list = {}
|
||||
|
||||
local path = full_paths[ directory ] or directory
|
||||
local playlist = rf.get_file_handler( path )
|
||||
|
||||
--if we can't read the path then stop here
|
||||
if not playlist then return {}, {sorted = true, filtered = true, empty_text = "Could not read filepath"} end
|
||||
|
||||
local parent = self.fix_path(path:match("^(.+/[^/]+)/"), true)
|
||||
|
||||
local lines = playlist:read("*a")
|
||||
|
||||
for item in lines:gmatch("[^%c]+") do
|
||||
item = self.fix_path(item)
|
||||
local fullpath = self.join_path(parent, item)
|
||||
|
||||
local name = ( self.get_protocol(item) and item or fullpath:match("([^/]+)/?$") )
|
||||
table.insert(list, {name = name, path = fullpath, type = "file"})
|
||||
end
|
||||
return list, {filtered = true, sorted = true}
|
||||
end
|
||||
|
||||
return m3u
|
||||
@@ -0,0 +1,81 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which uses powershell commands to parse native directories
|
||||
|
||||
This is slower than the default parser for local drives, but faster for network drives
|
||||
The drive_letters array below is used to list the drives to use this parser for
|
||||
]]--
|
||||
|
||||
--list the drive letters to use here (case sensitive)
|
||||
local drive_letters = {
|
||||
"Y", "Z"
|
||||
}
|
||||
|
||||
local mp = require "mp"
|
||||
local msg = require "mp.msg"
|
||||
local fb = require "file-browser"
|
||||
|
||||
local wn = {
|
||||
priority = 109,
|
||||
version = "1.1.0",
|
||||
name = "powershell",
|
||||
keybind_name = "file"
|
||||
}
|
||||
|
||||
local drives = {}
|
||||
for _, letter in ipairs(drive_letters) do
|
||||
drives[letter] = true
|
||||
end
|
||||
|
||||
local function command(args, parse_state)
|
||||
local _, cmd = parse_state:yield(
|
||||
mp.command_native_async({
|
||||
name = "subprocess",
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
capture_stderr = true,
|
||||
args = args
|
||||
}, fb.coroutine.callback())
|
||||
)
|
||||
|
||||
return cmd.status == 0 and cmd.stdout or nil, cmd.stderr
|
||||
end
|
||||
|
||||
function wn:can_parse(directory)
|
||||
return not self.get_protocol(directory) and drives[ directory:sub(1,1) ]
|
||||
end
|
||||
|
||||
function wn:parse(directory, parse_state)
|
||||
local list = {}
|
||||
local files, err = command({"powershell", "-noprofile", "-command", [[
|
||||
$dirs = Get-ChildItem -LiteralPath ]]..string.format("%q", directory)..[[ -Directory
|
||||
$files = Get-ChildItem -LiteralPath ]]..string.format("%q", directory)..[[ -File
|
||||
|
||||
foreach ($n in $dirs.Name) {
|
||||
$n += "/"
|
||||
$u8clip = [System.Text.Encoding]::UTF8.GetBytes($n)
|
||||
[Console]::OpenStandardOutput().Write($u8clip, 0, $u8clip.Length)
|
||||
Write-Host ""
|
||||
}
|
||||
|
||||
foreach ($n in $files.Name) {
|
||||
$u8clip = [System.Text.Encoding]::UTF8.GetBytes($n)
|
||||
[Console]::OpenStandardOutput().Write($u8clip, 0, $u8clip.Length)
|
||||
Write-Host ""
|
||||
}
|
||||
]]}, parse_state)
|
||||
|
||||
if not files then msg.debug(err) ; return nil end
|
||||
|
||||
for str in files:gmatch("[^\n\r]+") do
|
||||
local is_dir = str:sub(-1) == "/"
|
||||
if is_dir and self.valid_dir(str) then
|
||||
table.insert(list, {name = str, type = "dir"})
|
||||
elseif self.valid_file(str) then
|
||||
table.insert(list, {name = str, type = "file"})
|
||||
end
|
||||
end
|
||||
|
||||
return self.sort(list), {filtered = true, sorted = true}
|
||||
end
|
||||
|
||||
return wn
|
||||
@@ -0,0 +1,54 @@
|
||||
--[[
|
||||
An addon that loads root items from a `~~/script-opts/file-browser-root.json` file.
|
||||
The contents of this file will override the root script-opt.
|
||||
|
||||
The json file takes the form of a list array as defined by the addon API:
|
||||
https://github.com/CogentRedTester/mpv-file-browser/blob/master/addons/addons.md#the-list-array
|
||||
|
||||
The main purpose of this addon is to allow for users to customise the appearance of their root items
|
||||
using the label or ass fields:
|
||||
|
||||
[
|
||||
{ "name": "Favourites/" },
|
||||
{ "label": "~/", "name": "C:/Users/User/" },
|
||||
{ "label": "1TB HDD", "name": "D:/" },
|
||||
{ "ass": "{\\c&H007700&}Green Text", "name": "E:/" },
|
||||
{ "label": "FTP Server", name: "ftp://user:password@server.com/" }
|
||||
]
|
||||
|
||||
Make sure local directories always end with `/`.
|
||||
`path` and `name` behave the same in the root but either name or label should have a value.
|
||||
ASS styling codes: https://aegi.vmoe.info/docs/3.0/ASS_Tags/
|
||||
]]
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
local fb = require 'file-browser'
|
||||
|
||||
-- loads the root json file
|
||||
local config_path = mp.command_native({'expand-path', '~~/script-opts/file-browser-root.json'})
|
||||
|
||||
local file = io.open(config_path, 'r')
|
||||
if not file then
|
||||
msg.error('failed to read file', config_path)
|
||||
return
|
||||
end
|
||||
|
||||
local root_config = utils.parse_json(file:read("*a"))
|
||||
if not root_config then
|
||||
msg.error('failed to parse contents of', config_path, '- Check the syntax is correct.')
|
||||
return
|
||||
end
|
||||
|
||||
local function setup()
|
||||
for i, item in ipairs(root_config) do
|
||||
fb.register_root_item(item, item.priority)
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
version = '1.4.0',
|
||||
setup = setup,
|
||||
priority = -1000,
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
--[[
|
||||
An addon for file-browser which decodes URLs so that they are more readable
|
||||
]]
|
||||
|
||||
local urldecode = {
|
||||
priority = 5,
|
||||
version = "1.0.0"
|
||||
}
|
||||
|
||||
--decodes a URL address
|
||||
--this piece of code was taken from: https://stackoverflow.com/questions/20405985/lua-decodeuri-luvit/20406960#20406960
|
||||
local decodeURI
|
||||
do
|
||||
local char, gsub, tonumber = string.char, string.gsub, tonumber
|
||||
local function _(hex) return char(tonumber(hex, 16)) end
|
||||
|
||||
function decodeURI(s)
|
||||
s = gsub(s, '%%(%x%x)', _)
|
||||
return s
|
||||
end
|
||||
end
|
||||
|
||||
function urldecode:can_parse(directory)
|
||||
return self.get_protocol(directory)
|
||||
end
|
||||
|
||||
function urldecode:parse(directory)
|
||||
local list, opts = self:defer(directory)
|
||||
if opts.directory and not self.get_protocol(opts.directory) then return list, opts end
|
||||
|
||||
opts.directory_label = decodeURI(opts.directory_label or (opts.directory or directory))
|
||||
return list, opts
|
||||
end
|
||||
|
||||
return urldecode
|
||||
@@ -0,0 +1,97 @@
|
||||
--[[
|
||||
An addon for mpv-file-browser which uses the Windows dir command to parse native directories
|
||||
This behaves near identically to the native parser, but IO is done asynchronously.
|
||||
|
||||
Available at: https://github.com/CogentRedTester/mpv-file-browser/tree/master/addons
|
||||
]]--
|
||||
|
||||
local mp = require "mp"
|
||||
local msg = require "mp.msg"
|
||||
local fb = require "file-browser"
|
||||
|
||||
--this is a LuaJit module this addon will not load if not using LuaJit
|
||||
local ffi = require 'ffi'
|
||||
ffi.cdef([[
|
||||
int __stdcall WideCharToMultiByte(unsigned int CodePage, unsigned int dwFlags, const wchar_t *lpWideCharStr, int cchWideChar, char *lpMultiByteStr, int cbMultiByte, const char *lpDefaultChar, bool *lpUsedDefaultChar);
|
||||
]])
|
||||
|
||||
--converts a UTF16 string to a UTF8 string
|
||||
--this function was adapted from https://github.com/mpv-player/mpv/issues/10139#issuecomment-1117954648
|
||||
local function utf8(WideCharStr)
|
||||
WideCharStr = ffi.cast("wchar_t*", WideCharStr)
|
||||
if not WideCharStr then return nil end
|
||||
|
||||
local utf8_size = ffi.C.WideCharToMultiByte(65001, 0, WideCharStr, -1, nil, 0, nil, nil) --CP_UTF8
|
||||
if utf8_size > 0 then
|
||||
local utf8_path = ffi.new("char[?]", utf8_size)
|
||||
local utf8_size = ffi.C.WideCharToMultiByte(65001, 0, WideCharStr, -1, utf8_path, utf8_size, nil, nil)
|
||||
if utf8_size > 0 then
|
||||
--removes the trailing `\0` character which can break things
|
||||
return ffi.string(utf8_path, utf8_size):sub(1, -2)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
local dir = {
|
||||
priority = 109,
|
||||
version = "1.1.0",
|
||||
name = "cmd-dir",
|
||||
keybind_name = "file"
|
||||
}
|
||||
|
||||
local function command(args, parse_state)
|
||||
local _, cmd = parse_state:yield(
|
||||
mp.command_native_async({
|
||||
name = "subprocess",
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
capture_stderr = true,
|
||||
args = args,
|
||||
}, fb.coroutine.callback() )
|
||||
)
|
||||
cmd.stdout = utf8(cmd.stdout)
|
||||
cmd.stderr = utf8(cmd.stderr)
|
||||
|
||||
--dir returns this exact error message if the directory is empty
|
||||
if cmd.status == 1 and cmd.stderr == "File Not Found\r\n" then cmd.status = 0 end
|
||||
|
||||
return cmd.status == 0 and cmd.stdout or nil, cmd.stderr
|
||||
end
|
||||
|
||||
function dir:can_parse(directory)
|
||||
if directory == "" then return end
|
||||
return not fb.get_protocol(directory)
|
||||
end
|
||||
|
||||
function dir:parse(directory, parse_state)
|
||||
local list = {}
|
||||
local files, dirs, err
|
||||
|
||||
-- the dir command expects backslashes for our paths
|
||||
directory = directory:gsub("/", "\\")
|
||||
|
||||
dirs, err = command({ "cmd", "/U", "/c", "dir", "/b", "/ad", directory }, parse_state)
|
||||
if not dirs then return msg.error(err) end
|
||||
|
||||
files, err = command({ "cmd", "/U", "/c", "dir", "/b", "/a-d", directory }, parse_state)
|
||||
if not files then return msg.error(err) end
|
||||
|
||||
for name in dirs:gmatch("[^\n\r]+") do
|
||||
name = name.."/"
|
||||
if fb.valid_dir(name) then
|
||||
table.insert(list, { name = name, type = "dir" })
|
||||
msg.trace(name)
|
||||
end
|
||||
end
|
||||
|
||||
for name in files:gmatch("[^\n\r]+") do
|
||||
if fb.valid_file(name) then
|
||||
table.insert(list, { name = name, type = "file" })
|
||||
msg.trace(name)
|
||||
end
|
||||
end
|
||||
|
||||
return list, { filtered = true }
|
||||
end
|
||||
|
||||
return dir
|
||||
@@ -0,0 +1,52 @@
|
||||
--[[
|
||||
Automatically populates the root with windows drives on startup.
|
||||
Ctrl+r will add new drives mounted since startup.
|
||||
|
||||
Drives will only be added if they are not already present in the root.
|
||||
|
||||
Available at: https://github.com/CogentRedTester/mpv-file-browser/tree/master/addons
|
||||
]]
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local fb = require 'file-browser'
|
||||
|
||||
-- returns a list of windows drives
|
||||
local function get_drives()
|
||||
local result = mp.command_native({
|
||||
name = 'subprocess',
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
args = {'wmic', 'logicaldisk', 'get', 'caption'}
|
||||
})
|
||||
if result.status ~= 0 then return msg.error('could not read windows root') end
|
||||
|
||||
local root = {}
|
||||
for drive in result.stdout:gmatch("%a:") do
|
||||
table.insert(root, drive..'/')
|
||||
end
|
||||
return root
|
||||
end
|
||||
|
||||
-- adds windows drives to the root if they are not already present
|
||||
local function import_drives()
|
||||
local drives = get_drives()
|
||||
|
||||
for _, drive in ipairs(drives) do
|
||||
fb.register_root_item(drive)
|
||||
end
|
||||
end
|
||||
|
||||
local keybind = {
|
||||
key = 'Ctrl+r',
|
||||
name = 'import_root_drives',
|
||||
command = import_drives,
|
||||
parser = 'root',
|
||||
passthrough = true
|
||||
}
|
||||
|
||||
return {
|
||||
version = '1.4.0',
|
||||
setup = import_drives,
|
||||
keybinds = { keybind }
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Oscar Manglaras
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,177 @@
|
||||
# mpv-file-browser
|
||||
|
||||
|
||||
|
||||
This script allows users to browse and open files and folders entirely from within mpv. The script uses nothing outside the mpv API, so should work identically on all platforms. The browser can move up and down directories, start playing files and folders, or add them to the queue.
|
||||
|
||||
By default only file types compatible with mpv will be shown, but this can be changed in the config file.
|
||||
|
||||
This script requires at least **mpv v0.33**.
|
||||
|
||||
Originally, file-browser worked with versions of mpv going back to
|
||||
v0.31, you can find those (now unsupported) older versions of file-browser
|
||||
[here](https://github.com/CogentRedTester/mpv-file-browser/tree/mpv-v0.31)
|
||||
|
||||
## Installation
|
||||
|
||||
### Basic
|
||||
|
||||
Clone this git repository into the mpv `~~/scripts` directory and
|
||||
change the name of the folder from `mpv-file-browser` to `file-browser`.
|
||||
You can then pull to receive updates.
|
||||
Alternatively, you can download the zip and extract the contents to `~~/scripts/file-browser`.
|
||||
`~~/` is the mpv config directory which is typically `~/.config/mpv/` on linux and `%APPDATA%/mpv/` on windows.
|
||||
|
||||
Create a `file_browser.conf` file in the `~~/script-opts/` directory and customise the [`root` option](#root-directory) for your
|
||||
system. The [`docs/file_browser.conf`](docs/file_browser.conf) file contains the full list of options and their defaults.
|
||||
|
||||
### Advanced
|
||||
|
||||
To setup [custom keybinds](docs/custom-keybinds.md) enable the `custom_keybinds` option in `file_browser.conf` and
|
||||
create a `~~/script-opts/file-browser-keybinds.json` file. Do **not** copy the `file-browser-keybinds.json` file
|
||||
stored in this repository, that file is a collection of random examples, many of which are for completely different
|
||||
operating systems. Use them and the [docs](docs/custom-keybinds.md) to create your own collection of keybinds.
|
||||
|
||||
To setup [addons](addons/README.md) enable the `addons` option in `file_browser.conf` and place the addon files
|
||||
in the `~~/script-modules/file-browser-addons/` directory.
|
||||
|
||||
If you are not going to enable custom keybinds or addons then there is no reason to
|
||||
create `file-browser-keybinds.json` or `script-modules/file-browser-addons/`.
|
||||
|
||||
## Keybinds
|
||||
|
||||
The following keybinds are set by default
|
||||
|
||||
| Key | Name | Description |
|
||||
|-------------|----------------------------------|-------------------------------------------------------------------------------|
|
||||
| MENU | browse-files | toggles the browser |
|
||||
| Ctrl+o | open-browser | opens the browser |
|
||||
| Alt+o | browse-directory/get-user-input | opens a dialogue box to type in a directory - requires [mpv-user-input](#mpv-user-input) |
|
||||
|
||||
The following dynamic keybinds are only set while the browser is open:
|
||||
|
||||
| Key | Name | Description |
|
||||
|-------------|---------------|-------------------------------------------------------------------------------|
|
||||
| ESC | close | closes the browser or clears the selection |
|
||||
| ENTER | play | plays the currently selected file or folder |
|
||||
| Shift+ENTER | play_append | appends the current file or folder to the playlist |
|
||||
| Alt+ENTER | play_autoload | loads playlist entries before and after the selected file (like autoload.lua) |
|
||||
| RIGHT | down_dir | enter the currently selected directory |
|
||||
| LEFT | up_dir | move to the parent directory |
|
||||
| DOWN | scroll_down | move selector down the list |
|
||||
| UP | scroll_up | move selector up the list |
|
||||
| PGDWN | page_down | move selector down the list by a page (the num_entries option) |
|
||||
| PGUP | page_up | move selector up the list by a page (the num_entries option) |
|
||||
| Shift+PGDWN | list_bottom | move selector to the bottom of the list |
|
||||
| Shift+PGUP | list_top | move selector to the top of the list |
|
||||
| HOME | goto_current | move to the directory of the currently playing file |
|
||||
| Shift+HOME | goto_root | move to the root directory |
|
||||
| Ctrl+r | reload | reload directory and reset cache |
|
||||
| s | select_mode | toggles multiselect mode |
|
||||
| S | select_item | toggles selection for the current item |
|
||||
| Ctrl+a | select_all | select all items in the current directory |
|
||||
|
||||
When attempting to play or append a subtitle file the script will instead load the subtitle track into the existing video.
|
||||
|
||||
The behaviour of the autoload keybind can be reversed with the `autoload` script-opt.
|
||||
By default the playlist will only be autoloaded if `Alt+ENTER` is used on a single file, however when the option is switched autoload will always be used on single files *unless* `Alt+ENTER` is used. Using autoload on a directory, or while appending an item, will not work.
|
||||
|
||||
## Root Directory
|
||||
|
||||
To accomodate for both windows and linux this script has its own virtual root directory where drives and file folders can be manually added. The root directory can only contain folders.
|
||||
|
||||
The root directory is set using the `root` option, which is a comma separated list of directories. Entries are sent through mpv's `expand-path` command. By default the only root value is the user's home folder:
|
||||
|
||||
`root=~/`
|
||||
|
||||
It is highly recommended that this be customised for the computer being used; [file_browser.conf](file_browser.conf) contains commented out suggestions for generic linux and windows systems. For example, my windows root looks like:
|
||||
|
||||
`root=~/,C:/,D:/,E:/,Z:/`
|
||||
|
||||
## Multi-Select
|
||||
|
||||
By default file-browser only opens/appends the single item that the cursor has selected.
|
||||
However, using the `s` keybinds specified above, it is possible to select multiple items to open all at once. Selected items are shown in a different colour to the cursor.
|
||||
When in multiselect mode the cursor changes colour and scrolling up and down the list will drag the current selection. If the original item was unselected, then dragging will select items, if the original item was selected, then dragging will unselect items.
|
||||
|
||||
When multiple items are selected using the open or append commands all selected files will be added to the playlist in the order they appear on the screen.
|
||||
The currently selected (with the cursor) file will be ignored, instead the first multi-selected item in the folder will follow replace/append behaviour as normal, and following selected items will be appended to the playlist afterwards in the order that they appear on the screen.
|
||||
|
||||
## Custom Keybinds
|
||||
|
||||
File-browser also supports custom keybinds. These keybinds send normal input commands, but the script will substitute characters in the command strings for specific values depending on the currently open directory, and currently selected item.
|
||||
This allows for a wide range of customised behaviour, such as loading additional audio tracks from the browser, or copying the path of the selected item to the clipboard.
|
||||
|
||||
To see how to enable and use custom keybinds, see [custom-keybinds.md](docs/custom-keybinds.md).
|
||||
|
||||
## Add-ons
|
||||
|
||||
Add-ons are ways to add extra features to file-browser, for example adding support for network file servers like ftp, or implementing virtual directories in the root like recently opened files.
|
||||
They can be enabled by setting `addon` script-opt to yes, and placing the addon file into the `~~/script-modules/file-browser-addons/` directory.
|
||||
|
||||
For a list of existing addons see the [wiki](https://github.com/CogentRedTester/mpv-file-browser/wiki/Addon-List).
|
||||
For instructions on writing your own addons see [addons.md](docs/addons.md).
|
||||
|
||||
## Script Messages
|
||||
|
||||
File-browser supports a small number of script messages that allow the user or other scripts to talk with the browser.
|
||||
|
||||
### `browse-directory`
|
||||
|
||||
`script-message browse-directory [directory]`
|
||||
|
||||
Opens the given directory in the browser. If the browser is currently closed it will be opened.
|
||||
|
||||
### `get-directory-contents`
|
||||
|
||||
`script-message get-directory-contents [directory] [response-string]`
|
||||
|
||||
Reads the given directory, and sends the resulting tables to the specified script-message in the format:
|
||||
|
||||
`script-message [response-string] [list] [opts]`
|
||||
|
||||
The [list](docs/addons.md#the-list-array)
|
||||
and [opts](docs/addons.md#the-opts-table)
|
||||
tables are formatted as json strings through the `mp.utils.format_json` function.
|
||||
See [addons.md](docs/addons.md) for how the tables are structured, and what each field means.
|
||||
The API_VERSION field of the `opts` table refers to what version of the addon API file browser is using.
|
||||
The `response-string` refers to an arbitrary script-message that the tables should be sent to.
|
||||
|
||||
This script-message allows other scripts to utilise file-browser's directory parsing capabilities, as well as those of the file-browser addons.
|
||||
|
||||
## Configuration
|
||||
|
||||
See [file_browser.conf](docs/file_browser.conf) for the full list of options and their default values.
|
||||
The file is placed in the `~~/script-opts/` folder.
|
||||
|
||||
## Conditional Auto-Profiles
|
||||
|
||||
file-browser provides a property that can be used with [conditional auto-profiles](https://mpv.io/manual/master/#conditional-auto-profiles)
|
||||
to detect when the browser is open.
|
||||
On mpv v0.36+ you should use the `user-data` property with the `file_browser/open` boolean.
|
||||
|
||||
Here is an example of an auto-profile that hides the OSC logo when using file-browser in an idle window:
|
||||
|
||||
```properties
|
||||
[hide-logo]
|
||||
profile-cond= idle_active and user_data.file_browser.open
|
||||
profile-restore=copy
|
||||
osc=no
|
||||
```
|
||||
|
||||
On older versions of mpv you can use the `file_browser-open` field of the `shared-script-properties` property:
|
||||
|
||||
```properties
|
||||
[hide-logo]
|
||||
profile-cond= idle_active and shared_script_properties["file_browser-open"] == "yes"
|
||||
profile-restore=copy
|
||||
osc=no
|
||||
```
|
||||
|
||||
See [#55](https://github.com/CogentRedTester/mpv-file-browser/issues/55) for more details on this.
|
||||
|
||||
## [mpv-user-input](https://github.com/CogentRedTester/mpv-user-input)
|
||||
|
||||
mpv-user-input is a script that provides an API to request text input from the user over the OSD.
|
||||
It was built using `console.lua` as a base, so supports almost all the same text input commands.
|
||||
If `user-input.lua` is loaded by mpv, and `user-input-module` is in the `~~/script-modules/` directory, then using `Alt+o` will open an input box that can be used to directly enter directories for file-browser to open.
|
||||
@@ -0,0 +1,833 @@
|
||||
# How to Write an Addon - API v1.4.0
|
||||
|
||||
Addons provide ways for file-browser to parse non-native directory structures. This document describes how one can create their own custom addon.
|
||||
|
||||
If you have an independent script but want to use file-browser's parsing capabilities, perhaps to make use of existing addons, then look [here](https://github.com/CogentRedTester/mpv-file-browser#get-directory-contents).
|
||||
|
||||
## Terminology
|
||||
|
||||
For the purpose of this document addons refer to the scripts being loaded while parsers are the objects the scripts return.
|
||||
An addon can return multiple parsers, but when they only returns one the terms are almost synonymous.
|
||||
Additionally, `method` refers to functions called using the `object:funct()` syntax, and hence have access to the self object, whereas `function` is the standard `object.funct()` syntax.
|
||||
|
||||
## API Version
|
||||
|
||||
The API version, shown in the title of this document, allows file-browser to ensure that addons are using the correct
|
||||
version of the API. It follows [semantic versioning](https://semver.org/) conventions of `MAJOR.MINOR.PATCH`.
|
||||
A parser sets its version string with the `version` field, as seen [below](#overview).
|
||||
|
||||
Any change that breaks backwards compatability will cause the major version number to increase.
|
||||
A parser MUST have the same version number as the API, otherwise an error message will be printed and the parser will
|
||||
not be loaded.
|
||||
|
||||
A minor version number denotes a change to the API that is backwards compatible. This includes additional API functions,
|
||||
or extra fields in tables that were previously unused. It may also include additional arguments to existing functions that
|
||||
add additional behaviour without changing the old behaviour.
|
||||
If the parser's minor version number is greater than the API_VERSION, then a warning is printed to the console.
|
||||
|
||||
Patch numbers denote bug fixes, and are ignored when loading an addon.
|
||||
For this reason addon authors are allowed to leave the patch number out of their version tag and just use `MAJOR.MINOR`.
|
||||
|
||||
## Overview
|
||||
|
||||
File-browser automatically loads any lua files from the `~~/script-modules/file-browser-addons` directory as modules.
|
||||
Each addon must return either a single parser table, or an array of parser tables. Each parser object must contain the following three members:
|
||||
|
||||
| key | type | arguments | returns | description |
|
||||
|-----------|--------|-----------|----------------------------|------------------------------------------------------------------------------------------------------------|
|
||||
| priority | number | - | - | a number to determine what order parsers are tested - see [here](#priority-suggestions) for suggested values |
|
||||
| version | string | - | - | the API version the parser is using - see [API Version](#api-version) |
|
||||
| can_parse | method | string, parse_state_table | boolean | returns whether or not the given path is compatible with the parser |
|
||||
| parse | method | string, parse_state_table | list_table, opts_table | returns an array of item_tables, and a table of options to control how file_browser handles the list |
|
||||
|
||||
Additionally, each parser can optionally contain:
|
||||
|
||||
| key | type | arguments | returns | description |
|
||||
|---------------|--------|-----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| name | string | - | - | the name of the parser used for debug messages and to create a unique id - by default uses the filename with `.lua` or `-browser.lua` removed |
|
||||
| keybind_name | string | - | - | the name to use when setting custom keybind filters - uses the value of name by default but can be set manually so that the same keys work with multiple addons |
|
||||
| setup | method | - | - | if it exists this method is automatically run after all parsers are imported and API functions are made available |
|
||||
| keybinds | table | - | - | an array of keybind objects for the browser to set when loading - see [#keybinds] |
|
||||
|
||||
All parsers are given a unique string ID based on their name. If there are collisions then numbers are appended to the end of the name until a free name is found.
|
||||
These IDs are primarily used for debug messages, though they may gain additional functionality in the future.
|
||||
|
||||
Here is an extremely simple example of an addon creating a parser table and returning it to file-browser.
|
||||
|
||||
```lua
|
||||
local parser = {
|
||||
version = '1.0.0',
|
||||
priority = 100,
|
||||
name = "example" -- this parser will have the id 'example' or 'example_#' if there are duplicates
|
||||
}
|
||||
|
||||
function parser:can_parse(directory)
|
||||
return directory == "Example/"
|
||||
end
|
||||
|
||||
function parser:parse(directory, state)
|
||||
local list, opts
|
||||
------------------------------
|
||||
--- populate the list here ---
|
||||
------------------------------
|
||||
return list, opts
|
||||
end
|
||||
|
||||
return parser
|
||||
|
||||
```
|
||||
|
||||
## Parsing
|
||||
|
||||
When a directory is loaded file-browser will iterate through the list of parsers from lowest to highest priority.
|
||||
The first parser for which `can_parse` returns true will be selected as the parser for that directory.
|
||||
|
||||
The `parse` method will then be called on the selected parser, which is expected to return either a table of list items, or nil.
|
||||
If an empty table is returned then file-browser will treat the directory as empty, otherwise if the list_table is nil then file-browser will attempt to run `parse` on the next parser for which `can_parse` returns true.
|
||||
This continues until a parser returns a list_table, or until there are no more parsers, after which the root is loaded instead.
|
||||
|
||||
The entire parse operation is run inside of a coroutine, this allows parsers to pause execution to handle asynchronous operations.
|
||||
Please read [coroutines](#coroutines) for all the details.
|
||||
|
||||
### Parse State Table
|
||||
|
||||
The `parse` and `can_parse` functions are passed a state table as its second argument, this contains the following fields.
|
||||
|
||||
| key | type | description |
|
||||
|--------|--------|-----------------------------------------------|
|
||||
| source | string | the source of the parse request |
|
||||
| directory | string | the directory of the parse request - for debugging purposes |
|
||||
| already_deferred| boolean | whether or not [defer](#advanced-functions) was called during this parse, if so then file-browser will not try to query any more parsers after receiving the result - set automatically, but can be manually disabled |
|
||||
| yield | method | a wrapper around `coroutine.yield()` - see [coroutines](#coroutines) |
|
||||
| is_coroutine_current | method | returns if the browser is waiting on the current coroutine to populate the list |
|
||||
|
||||
`already_deferred` is an optimisation. If a script uses defer and still returns nil, then that means that none of the remaining parsers will be able to parse the path.
|
||||
Therefore, it is more efficient to just immediately jump to the root.
|
||||
It is up to the addon author to manually disable this if their use of `defer` conflicts with this assumption.
|
||||
|
||||
Source can have the following values:
|
||||
|
||||
| source | description |
|
||||
|----------------|-----------------------------------------------------------------|
|
||||
| browser | triggered by the main browser window |
|
||||
| loadlist | the browser is scanning the directory to append to the playlist |
|
||||
| script-message | triggered by the `get-directory-contents` script-message |
|
||||
| addon | caused by an addon calling the `parse_directory` API function - note that addons can set a custom state |
|
||||
|
||||
Note that all calls to any `parse` function during a specific parse request will be given the same parse_state table.
|
||||
This theoretically allows parsers to communicate with parsers of a lower priority (or modify how they see source information),
|
||||
but no guarantees are made that specific keys will remain unused by the API.
|
||||
|
||||
#### Coroutines
|
||||
|
||||
Any calls to `parse()` (or `can_parse()`, but you should never be yielding inside there) are done in a [Lua coroutine](https://www.lua.org/manual/5.1/manual.html#2.11).
|
||||
This means that you can arbitrarily pause the parse operation if you need to wait for some asynchronous operation to complete,
|
||||
such as waiting for user input, or for a network request to complete.
|
||||
|
||||
Making these operations asynchronous has performance
|
||||
advantages as well, for example recursively opening a network directory tree could cause the browser to freeze
|
||||
for a long period of time. If the network query were asynchronous then the browser would only freeze during actual operations,
|
||||
during network operations it would be free for the user interract with. The browser has even been designed so that
|
||||
a loadfile/loadlist operation saves it's own copy of the current directory, so even if the user hops around like crazy the original
|
||||
open operation will still occur in the correct order (though there's nothing stopping them starting a new operation which will cause
|
||||
random ordering.)
|
||||
|
||||
However, there is one downside to this behaviour. If the parse operation is requested by the browser, then it is
|
||||
possible for the user to change directories while the coroutine is yielded. If you were to resume the coroutine
|
||||
in that situation, then any operations you do are wasted, and unexpected bahaviour could happen.
|
||||
file-browser will automatically detect when it receives a list from an aborted coroutine, so there is no risk
|
||||
of the current list being replaced, but any other logic in your script will continue until `parse` returns.
|
||||
|
||||
To fix this there are two methods available in the state table, the `yield()` method is a wrapper around `coroutine.yield()` that
|
||||
detects when the browser has abandoned the parse, and automatically kills the coroutine by throwing an error.
|
||||
The `is_coroutine_current()` method simply compares if the current coroutine (as returned by `coroutine.running()`) matches the
|
||||
coroutine that the browser is waiting for. Remember this is only a problem when the browser is the source of the request,
|
||||
if the request came from a script-message, or from a loadlist command there are no issues.
|
||||
|
||||
### The List Array
|
||||
|
||||
The list array must be made up of item_tables, which contain details about each item in the directory.
|
||||
Each item has the following members:
|
||||
|
||||
| key | type | required | description |
|
||||
|-------|--------|----------|-------------------------------------------------------------------------------------------|
|
||||
| name | string | yes | name of the item, and the string to append after the directory when opening a file/folder |
|
||||
| type | string | yes | determines whether the item is a file ("file") or directory ("dir") |
|
||||
| label | string | no | an alternative string to print to the screen instead of name |
|
||||
| ass | string | no | a string to print to the screen without escaping ass styling - overrides label and name |
|
||||
| path | string | no | opening the item uses this full path instead of appending directory and name |
|
||||
| redirect| bool | no | whether path should redirect the browser when opening a directory - default yes (nil counts as true)|
|
||||
|
||||
File-browser expects that `type` and `name` will be set for each item, so leaving these out will probably crash the script.
|
||||
File-browser also assumes that all directories end in a `/` when appending name, and that there will be no backslashes.
|
||||
The API function [`fix_path`](#utility-functions) can be used to ensure that paths conform to file-browser rules.
|
||||
|
||||
Here is an example of a static list table being returned by the `parse` method.
|
||||
This would allow one to specify a custom list of items.
|
||||
|
||||
```lua
|
||||
function parser:parse(directory, state)
|
||||
local list = {
|
||||
{ name = "first/", type = "dir" },
|
||||
{ name = "second/", type = "dir" },
|
||||
{ name = "third/", type = "dir" },
|
||||
{ name = "file%01", type = "file", label = "file1" },
|
||||
{ name = "file2", type = "file", path = "https://youtube.com/video" },
|
||||
}
|
||||
|
||||
return list
|
||||
end
|
||||
```
|
||||
|
||||
### The Opts Table
|
||||
|
||||
The options table allows scripts to better control how they are handled by file-browser.
|
||||
None of these values are required, and the opts table can even left as nil when returning.
|
||||
|
||||
| key | type | description |
|
||||
|-----------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| filtered | boolean | if true file-browser will not run the standard filter() function on the list |
|
||||
| sorted | boolean | if true file-browser will not sort the list |
|
||||
| directory | string | changes the browser directory to this - used for redirecting to other locations |
|
||||
| directory_label | string | display this label in the header instead of the actual directory - useful to display encoded paths |
|
||||
| empty_text | string | display this text when the list is empty - can be used for error messages |
|
||||
| selected_index | number | the index of the item on the list to select by default - a.k.a. the cursor position |
|
||||
| id | number | id of the parser that successfully returns a list - set automatically, but can be set manually to take ownership (see defer) |
|
||||
|
||||
The previous static example, but modified so that file browser does not try to filter or re-order the list:
|
||||
|
||||
```lua
|
||||
function parser:parse(directory, state)
|
||||
local list = {
|
||||
{ name = "first/", type = "dir" },
|
||||
{ name = "second/", type = "dir" },
|
||||
{ name = "third/", type = "dir" },
|
||||
{ name = "file%01", type = "file", label = "file1" },
|
||||
{ name = "file2", type = "file", path = "https://youtube.com/video" },
|
||||
}
|
||||
|
||||
return list, { sorted = true, filtered = true }
|
||||
end
|
||||
```
|
||||
|
||||
`id` is used to declare ownership of a page. The name of the parser that has ownership is used for custom-keybinds parser filtering.
|
||||
When using `defer` id will be the id of whichever parser first returned a list.
|
||||
This is the only situation when a parser may want to set id manually.
|
||||
|
||||
## Priority Suggestions
|
||||
|
||||
Below is a table of suggested priority ranges:
|
||||
|
||||
| Range | Suggested Use | Example parsers |
|
||||
|--------|----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
|
||||
| 0-20 | parsers that purely modify the results of other parsers | [m3u-fixer](m3u-browser.lua) |
|
||||
| 21-40 | virtual filesystems which need to link to the results of other parsers | [favourites](favourites.lua) |
|
||||
| 41-50 | to support specific sites or systems which can be inferred from the path | |
|
||||
| 51-80 | limitted support for specific protocols which requires complex parsing to verify compatability | [apache](apache-browser.lua) |
|
||||
| 81-90 | parsers that only need to modify the results of full parsers | [home-label](home-label.lua) |
|
||||
| 91-100 | use for parsers which fully support a non-native protocol with absolutely no overlap | [ftp](ftp-browser.lua), [m3u](m3u-browser.lua) |
|
||||
| 101-109| replacements for the native file parser or fallbacks for the full parsers | [powershell](powershell.lua) |
|
||||
| 110 | priority of the native file parser - don't use | |
|
||||
| 111+ | fallbacks for native parser - potentially alternatives to the default root | |
|
||||
|
||||
## Keybinds
|
||||
|
||||
Addons have the ability to set custom keybinds using the `keybinds` field in the `parser` table. `keybinds` must be an array of tables, each of which may be in two forms.
|
||||
|
||||
Firstly, the keybind_table may be in the form
|
||||
`{ "key", "name", [function], [flags] }`
|
||||
where the table is an array whose four values corresond to the four arguments for the [mp.add_key_binding](https://mpv.io/manual/master/#lua-scripting-[,flags]]\)) API function.
|
||||
|
||||
```lua
|
||||
local function main(keybind, state, co)
|
||||
-- deletes files
|
||||
end
|
||||
|
||||
parser.keybinds = {
|
||||
{ "Alt+DEL", "delete_files", main, {} },
|
||||
}
|
||||
```
|
||||
|
||||
Secondly, the keybind_table may use the same formatting as file-browser's [custom-keybinds](../custom-keybinds.md).
|
||||
Using the array form is equivalent to setting `key`, `name`, `command`, and `flags` of the custom-keybind form, and leaving everything else on the defaults.
|
||||
|
||||
```lua
|
||||
parser.keybinds = {
|
||||
{
|
||||
key = "Alt+DEL",
|
||||
name = "delete_files",
|
||||
command = {"run", "rm", "%F"},
|
||||
filter = "files"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
These keybinds are evaluated only once shortly after the addon is loaded, they cannot be modified dynamically during runtime.
|
||||
Keybinds are applied after the default keybinds, but before the custom keybinds. This means that addons can overwrite the
|
||||
default keybinds, but that users can ovewrite addon keybinds. Among addons, those with higher priority numbers have their keybinds loaded before those
|
||||
with lower priority numbers.
|
||||
Remember that a lower priority value is better, they will overwrite already loaded keybinds.
|
||||
Keybind passthrough works the same way, though there is some custom behaviour when it comes to [raw functions](#keybind-functions).
|
||||
|
||||
### Keybind Names
|
||||
|
||||
In either form the naming of the function is different from custom keybinds. Instead of using the form `file_browser/dynamic/custom/[name]`
|
||||
they use the form `file_browser/dynamic/[parser_ID]/[name]`, where `[parser_id]` is a unique string ID for the parser, which can be retrieved using the
|
||||
`parser:get_id()` method.
|
||||
|
||||
### Native Functions vs Command Tables
|
||||
|
||||
There are two ways of specifying the behaviour of a keybind.
|
||||
It can be in command table form, as done when using custom-keybind syntax, and it can be done in
|
||||
native function form, as done when using the `mp.add_key_binding` syntax.
|
||||
However, these two ways of specifying commands are independant of how the overall keybind is defined.
|
||||
What this means is that the command field of the custom-keybinds syntax can be an array, and the
|
||||
3rd value in the array syntax can be a table of mpv commands.
|
||||
|
||||
```lua
|
||||
local function main(keybind, state, co)
|
||||
-- deletes files
|
||||
end
|
||||
|
||||
-- this is a valid keybind table
|
||||
parser.keybinds = {
|
||||
{ "Alt+DEL", "delete_files", {"run", "rm", "%F"}, {} },
|
||||
|
||||
{
|
||||
key = "Alt+DEL",
|
||||
name = "delete_files",
|
||||
command = main
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
There are some limitations however, not all custom-keybind options are supported when using native functions.
|
||||
The supported options are: `key`, `name`, `condition`, `flags`, `parser`, `passthrough`. The other options can be replicated manually (see below).
|
||||
|
||||
### Keybind Functions
|
||||
|
||||
This section details the use of keybind functions.
|
||||
|
||||
#### Function Call
|
||||
|
||||
If one uses the raw function then the functions are called directly in the form:
|
||||
|
||||
`fn(keybind, state, coroutine)`
|
||||
|
||||
Where `keybind` is the keybind_table of the key being run, `state` is a table of state values at the time of the key press, and `coroutine` is the coroutine object
|
||||
that the keybind is being executed inside.
|
||||
|
||||
The `keybind` table uses the same fields as defined
|
||||
in [custom-keybinds.md](../custom-keybinds.md). Any random extra fields placed in the original
|
||||
`file-browser-keybinds.json` will likely show up as well (this is not guaranteed).
|
||||
Note that even if the array form is used, the `keybind` table will still use the custom-keybind format.
|
||||
|
||||
The entire process of running a keybind is handled with a coroutine, so the addon can safely pause and resume the coroutine at will. The `state` table is provided to
|
||||
allow addons to keep a record of important state values that may be changed during a paused coroutine.
|
||||
|
||||
#### State Table
|
||||
|
||||
The state table contains copies of the following values at the time of the key press.
|
||||
|
||||
| key | description |
|
||||
|-----------------|------------------------------------------------------------------------------------------|
|
||||
| directory | the current directory |
|
||||
| directory_label | the current directory_label - can (and often will) be `nil` |
|
||||
| list | the current list_table |
|
||||
| selected | index of the currently selected list item |
|
||||
| selection | table of currently selected items (for multi-select) - in the form { index = true, ... } - always available even if the `multiselect` flag is not set |
|
||||
| parser | a copy of the parser object that provided the current directory |
|
||||
|
||||
The following example shows the implementation of the `delete_files` keybind using the state values:
|
||||
|
||||
```lua
|
||||
local fb = require "file-browser" -- see #api-functions and #utility-functions
|
||||
|
||||
local function main(keybind, state, co)
|
||||
for index, item in state.list do
|
||||
if state.selection[index] and item.type == "file" then
|
||||
os.remove( fb.get_full_path(item, state.directory) )
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
parser.keybinds = {
|
||||
{ "Alt+DEL", "delete_files", main, {} },
|
||||
}
|
||||
```
|
||||
|
||||
#### Passthrough
|
||||
|
||||
If the `passthrough` field of the keybind_table is set to `true` or `false` then file-browser will
|
||||
handle everything. However, if the passthrough field is not set (meaning the bahviour should be automatic)
|
||||
then it is up to the addon to ensure that they are
|
||||
correctly notifying when the operation failed and a passthrough should occur.
|
||||
In order to tell the keybind handler to run the next priority command, the keybind function simply needs to return the value `false`,
|
||||
any other value (including `nil`) will be treated as a successful operation.
|
||||
|
||||
The below example only allows removing files from the `/tmp/` directory and allows other
|
||||
keybinds to run in different directories:
|
||||
|
||||
```lua
|
||||
local fb = require "file-browser" -- see #api-functions and #utility-functions
|
||||
|
||||
local function main(keybind, state, co)
|
||||
if state.directory ~= "/tmp/" then return false end
|
||||
|
||||
for index, item in state.list do
|
||||
if state.selection[index] and item.type == "file" then
|
||||
os.remove( fb.get_full_path(item, state.directory) )
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
parser.keybinds = {
|
||||
{ "Alt+DEL", "delete_files", main, {} },
|
||||
}
|
||||
```
|
||||
|
||||
## The API
|
||||
|
||||
The API is available through a module, which can be loaded with `require "file-browser"`.
|
||||
The API provides a variety of different values and functions for an addon to use
|
||||
in order to make them more powerful.
|
||||
Function definitions are written using Typescript-style type annotations.
|
||||
|
||||
```lua
|
||||
local fb = require "file-browser"
|
||||
|
||||
local parser = {
|
||||
priority = 100,
|
||||
}
|
||||
|
||||
function parser:setup()
|
||||
fb.register_root_item("Example/")
|
||||
end
|
||||
|
||||
return parser
|
||||
```
|
||||
|
||||
### Parser API
|
||||
|
||||
In addition to the standard API there is also an extra parser API that provides
|
||||
several parser specific methods, listed below using `parser:method` instead of `fb.function`.
|
||||
This API is added to the parser object after it is loaded by file-browser,
|
||||
so if a script wants to call them immediately on load they must do so in the `setup` method.
|
||||
All the standard API functions are also available in the parser API.
|
||||
|
||||
```lua
|
||||
local parser = {
|
||||
priority = 100,
|
||||
}
|
||||
|
||||
function parser:setup()
|
||||
-- same operations
|
||||
self.insert_root_item({ name = "Example/", type = "dir" })
|
||||
parser.insert_root_item({ name = "Example/", type = "dir" })
|
||||
end
|
||||
|
||||
-- will not work since the API hasn't been added to the parser yet
|
||||
parser.insert_root_item({ name = "Example/", type = "dir" })
|
||||
|
||||
return parser
|
||||
```
|
||||
|
||||
### General Functions
|
||||
|
||||
#### `fb.API_VERSION: string`
|
||||
|
||||
The current API version in use by file-browser.
|
||||
|
||||
#### `fb.add_default_extension(ext: string): void`
|
||||
|
||||
Adds the given extension to the default extension filter whitelist. Can only be run inside the `setup()` method.
|
||||
|
||||
#### `fb.browse_directory(directory: string): void`
|
||||
|
||||
Clears the cache and opens the given directory in the browser. If the browser is closed then it will be opened.
|
||||
This function is non-blocking, it is possible that the function will return before the directory has finished
|
||||
being scanned.
|
||||
|
||||
This is the equivalent of calling the `browse-directory` script-message.
|
||||
|
||||
#### `fb.insert_root_item(item: item_table, pos?: number): void`
|
||||
|
||||
Add an item_table to the root list at the specified position. If `pos` is nil then append to the end of the root.
|
||||
`item` must be a valid item_table of `type='dir'`.
|
||||
|
||||
#### `fb.register_parseable_extension(ext: string): void`
|
||||
|
||||
Register a file extension that the browser will attempt to open, like a directory - for addons which can parse files such
|
||||
as playlist files.
|
||||
|
||||
#### `fb.register_root_item(item: string | item_table, priority?: number): boolean`
|
||||
|
||||
Registers an item to be added to the root and an optional priority value that determines the position relative to other items (default is 100).
|
||||
A lower priority number is better, meaning they will be placed earlier in the list.
|
||||
Only adds the item if it is not already in the root and returns a boolean that specifies whether or not the item was added.
|
||||
Must be called during or after the `parser:setup()` method is run.
|
||||
|
||||
If `item` is a string then a new item_table is created with the values: `{ type = 'dir', name = item }`.
|
||||
If `item` is an item_table then it must be a valid directory item.
|
||||
Use [`fb.fix_path(name, true)`](#fbfix_pathpath-string-is_directory-boolean-string) to ensure the name field is correct.
|
||||
|
||||
This function should be used over the older `fb.insert_root_item`.
|
||||
|
||||
#### `fb.remove_parseable_extension(ext: string): void`
|
||||
|
||||
Remove a file extension that the browser will attempt to open like a directory.
|
||||
|
||||
#### `fb.parse_directory(directory: string, parse?: parse_state_table): (list_table, opts_table) | nil`
|
||||
|
||||
Starts a new scan for the given directory and returns a list_table and opts_table on success and `nil` on failure.
|
||||
Must be called from inside a [coroutine](#coroutines).
|
||||
|
||||
This function allows addons to request the contents of directories from the loaded parsers. There are no protections
|
||||
against infinite recursion, so be careful about calling this from within another parse.
|
||||
|
||||
Do not use the same `parse` table for multiple parses, state values for the two operations may intefere with each other
|
||||
and cause undefined behaviour. If the `parse.source` field is not set then it will be set to `"addon"`.
|
||||
|
||||
Note that this function is for creating new parse operations, if you wish to create virtual directories or modify
|
||||
the results of other parsers then use [`defer`](#parserdeferdirectory-string-list_table-opts_table--nil).
|
||||
|
||||
Also note that every parse operation is expected to have its own unique coroutine. This acts as a unique
|
||||
ID that can be used internally or by other addons. This means that if multiple `parse_directory` operations
|
||||
are run within a single coroutine then file-browser will automatically create a new coroutine for the scan,
|
||||
which hands execution back to the original coroutine upon completion.
|
||||
|
||||
#### `parser:register_root_item(item: string | item_table, priority?: number): boolean`
|
||||
|
||||
A wrapper around [`fb.register_root_item`](#fbregister_root_itemitem-string--item_table-priority-number-boolean)
|
||||
which uses the parser's priority value if `priority` is undefined.
|
||||
|
||||
### Advanced Functions
|
||||
|
||||
#### `fb.clear_cache(): void`
|
||||
|
||||
Clears the directory cache. Use this if you are modifying the contents of directories other
|
||||
than the current one to ensure that their contents will be rescanned when next opened.
|
||||
|
||||
#### `fb.coroutine.assert(err?: string): coroutine`
|
||||
|
||||
Throws an error if it is not called from within a coroutine. Returns the currently running coroutine on success.
|
||||
The string argument can be used to throw a custom error string.
|
||||
|
||||
#### `fb.coroutine.callback(): function`
|
||||
|
||||
Creates and returns a callback function that resumes the current coroutine.
|
||||
This function is designed to help streamline asynchronous operations. The best way to explain is with an example:
|
||||
|
||||
```lua
|
||||
local function execute(args)
|
||||
mp.command_native_async({
|
||||
name = "subprocess",
|
||||
playback_only = false,
|
||||
capture_stdout = true,
|
||||
capture_stderr = true,
|
||||
args = args
|
||||
}, fb.coroutine.callback())
|
||||
|
||||
local _, cmd = coroutine.yield()
|
||||
|
||||
return cmd.status == 0 and cmd.stdout or nil
|
||||
end
|
||||
```
|
||||
|
||||
This function uses the mpv [subprocess](https://mpv.io/manual/master/#command-interface-subprocess)
|
||||
command to execute some system operation. To prevent the whole script (file-browser and all addons) from freezing
|
||||
it uses the [command_native_async](https://mpv.io/manual/master/#lua-scripting-mp-command-native-async(table-[,fn])) command
|
||||
to execute the operation asynchronously and takes a callback function as its second argument.
|
||||
|
||||
`coroutine.callback())` will automatically create a callback function to resume whatever coroutine ran the `execute` function.
|
||||
Any arguments passed into the callback function (by the async function, not by you) will be passed on to the resume;
|
||||
in this case `command_native_async` passes three values into the callback, of which only the second is of interest to me.
|
||||
|
||||
The unsaid expectation is that the programmer will yield execution before that callback returns. In this example I
|
||||
yield immediately after running the async command.
|
||||
|
||||
If you are doing this during a parse operation you could also substitute `coroutine.yield()` with `parse_state:yield()` to abort the parse if the user changed
|
||||
browser directories during the asynchronous operation.
|
||||
|
||||
If you have no idea what I've been talking about read the [Lua manual on coroutines](https://www.lua.org/manual/5.1/manual.html#2.11).
|
||||
|
||||
#### `fb.coroutine.resume_catch(co: coroutine, ...): (boolean, ...)`
|
||||
|
||||
Runs `coroutine.resume(co, ...)` with the given coroutine, passing through any additional arguments.
|
||||
If the coroutine throws an error then an error message and stacktrace is printed to the console.
|
||||
All the return values of `coroutine.resume` are caught and returned.
|
||||
|
||||
#### `fb.coroutine.resume_err(co: coroutine, ...): boolean`
|
||||
|
||||
Runs `coroutine.resume(co, ...)` with the given coroutine, passing through any additional arguments.
|
||||
If the coroutine throws an error then an error message and stacktrace is printed to the console.
|
||||
Returns the success boolean returned by `coroutine.resume`, but drops all other return values.
|
||||
|
||||
#### `fb.coroutine.run(fn: function, ...): void`
|
||||
|
||||
Runs the given function in a new coroutine, passing through any additional arguments.
|
||||
|
||||
#### `fb.rescan(): void`
|
||||
|
||||
Rescans the current directory. Equivalent to Ctrl+r without the cache refresh for higher level directories.
|
||||
|
||||
#### `fb.redraw(): void`
|
||||
|
||||
Forces a redraw of the browser UI.
|
||||
|
||||
#### `parser:defer(directory: string): (list_table, opts_table) | nil`
|
||||
|
||||
Forwards the given directory to the next valid parser. For use from within a parse operation.
|
||||
|
||||
The `defer` function is very powerful, and can be used by scripts to create virtual directories, or to modify the results of other parsers.
|
||||
However, due to how much freedom Lua gives coders, it is impossible for file-browser to ensure that parsers are using defer correctly, which can cause unexpected results.
|
||||
The following are a list of recommendations that will increase the compatability with other parsers:
|
||||
|
||||
* Always return the opts table that is returned by defer, this can contain important values for file-browser, as described [above](#the-opts-table).
|
||||
* If required modify values in the existing opts table, don't create a new one.
|
||||
* Respect the `sorted` and `filtered` values in the opts table. This may mean calling `sort` or `filter` manually.
|
||||
* Think about how to handle the `directory_label` field, especially how it might interract with any virtual paths the parser may be maintaining.
|
||||
* Think about what to do if the `directory` field is set.
|
||||
* Think if you want your parser to take full ownership of the results of `defer`, if so consider setting `opts.id = self:get_id()`.
|
||||
* Currently this only affects custom keybind filtering, though it may be changed in the future.
|
||||
|
||||
The [home-label](https://github.com/CogentRedTester/mpv-file-browser/blob/master/addons/home-label.lua)
|
||||
addon provides a good simple example of the safe use of defer. It lets the normal file
|
||||
parser load the home directory, then modifies the directory label.
|
||||
|
||||
```lua
|
||||
local mp = require "mp"
|
||||
local fb = require "file-browser"
|
||||
|
||||
local home = fb.fix_path(mp.command_native({"expand-path", "~/"}), true)
|
||||
|
||||
local home_label = {
|
||||
version = '1.0.0',
|
||||
priority = 100
|
||||
}
|
||||
|
||||
function home_label:can_parse(directory)
|
||||
return directory:sub(1, home:len()) == home
|
||||
end
|
||||
|
||||
function home_label:parse(directory, ...)
|
||||
local list, opts = self:defer(directory, ...)
|
||||
|
||||
if (not opts.directory or opts.directory == directory) and not opts.directory_label then
|
||||
opts.directory_label = "~/"..(directory:sub(home:len()+1) or "")
|
||||
end
|
||||
|
||||
return list, opts
|
||||
end
|
||||
|
||||
return home_label
|
||||
```
|
||||
|
||||
### Utility Functions
|
||||
|
||||
#### `fb.ass_escape(str: string, substitute_newline?: true | string): string`
|
||||
|
||||
Returns the `str` string with escaped ass styling codes.
|
||||
The optional 2nd argument allows replacing newlines with the given string, or `'\\n'` if set to `true`.
|
||||
|
||||
#### `fb.copy_table(t: table, depth?: number): table`
|
||||
|
||||
Returns a copy of table `t`.
|
||||
The copy is done recursively to the given `depth`, and any cyclical table references are maintained.
|
||||
Both keys and values are copied. If `depth` is undefined then it defaults to `math.huge` (infinity).
|
||||
Additionally, the original table is stored in the `__original` field of the copy's metatable.
|
||||
The copy behaviour of the metatable itself is subject to change, but currently it is not copied.
|
||||
|
||||
#### `fb.filter(list: list_table): list_table`
|
||||
|
||||
Iterates through the given list and removes items that don't pass the user set filters
|
||||
(dot files/directories and valid file extensions).
|
||||
Returns the list but does not create a copy; the `list` table is filtered in-place.
|
||||
|
||||
#### `fb.fix_path(path: string, is_directory?: boolean): string`
|
||||
|
||||
Takes a path and returns a file-browser compatible path string.
|
||||
The optional second argument is a boolean that tells the function to format the path to be a
|
||||
directory.
|
||||
|
||||
#### `fb.get_extension(filename: string, def?: any): string | def`
|
||||
|
||||
Returns the file extension for the string `filename`, or `nil` if there is no extension.
|
||||
If `def` is defined then that is returned instead of `nil`.
|
||||
|
||||
The full stop is not included in the extension, so `test.mkv` will return `mkv`.
|
||||
|
||||
#### `fb.get_full_path(item: item_table, directory?: string): string`
|
||||
|
||||
Takes an item table and returns the item's full path assuming it is in the given directory.
|
||||
Takes into account `item.name`/`item.path` fields, etc.
|
||||
If directory is nil then it uses the currently open directory.
|
||||
|
||||
#### `fb.get_protocol(url: string, def?: any): string | def`
|
||||
|
||||
Returns the protocol scheme for the string `url`, or `nil` if there is no scheme.
|
||||
If `def` is defined then that is returned instead of `nil`.
|
||||
|
||||
The `://` is not included, so `https://example.com/test.mkv` will return `https`.
|
||||
|
||||
#### `fb.iterate_opt(opts: string): iterator`
|
||||
|
||||
Takes an options string consisting of a list of items separated by the `root_separators` defined in `file_browser.conf` and
|
||||
returns an iterator function that can be used to iterate over each item in the list.
|
||||
|
||||
```lua
|
||||
local opt = "a,b,zz z" -- root_separators=,
|
||||
for item in fb.iterate_opt(opt) do
|
||||
print(item) -- prints: 'a', 'b', 'zz z'
|
||||
end
|
||||
```
|
||||
|
||||
#### `fb.join_path(p1: string, p2: string): string`
|
||||
|
||||
A wrapper around [`mp.utils.join_path`](https://mpv.io/manual/master/#lua-scripting-utils-join-path(p1,-p2))
|
||||
which treats paths with network protocols as absolute paths.
|
||||
|
||||
#### `fb.pattern_escape(str: string): string`
|
||||
|
||||
Returns `str` with Lua special pattern characters escaped.
|
||||
|
||||
#### `fb.sort(list: list_table): list_table`
|
||||
|
||||
Iterates through the given list and sorts the items using file-browser's sorting algorithm.
|
||||
Returns the list but does not create a copy; the `list` table is sorted in-place.
|
||||
|
||||
#### `fb.valid_file(name: string): boolean`
|
||||
|
||||
Tests if the string `name` passes the user set filters for valid files (extensions/dot files/etc).
|
||||
|
||||
#### `fb.valid_dir(name: string): boolean`
|
||||
|
||||
Tests if the string `name` passes the user set filters for valid directories (dot folders/etc).
|
||||
|
||||
### Getters
|
||||
|
||||
These functions allow addons to safely get information from file-browser.
|
||||
All tables returned by these functions are copies sent through the [`fb.copy_table`](#fbcopy_tablet-table-depth-number-table)
|
||||
function to ensure addons can't accidentally break things.
|
||||
|
||||
#### `fb.get_audio_extensions(): table`
|
||||
|
||||
Returns a set of extensions like [`fb.get_extensions`](#fbget_extensions-table) but for extensions that are opened
|
||||
as additional audio tracks.
|
||||
All of these are included in `fb.get_extensions`.
|
||||
|
||||
#### `fb.get_current_file(): table`
|
||||
|
||||
A table containing the path of the current open file in the form:
|
||||
`{directory = "/home/me/", name = "bunny.mkv", path = "/home/me/bunny.mkv"}`.
|
||||
|
||||
#### `fb.get_current_parser(): string`
|
||||
|
||||
The unique id of the parser that successfully parsed the current directory.
|
||||
|
||||
#### `fb.get_current_parser_keyname(): string`
|
||||
|
||||
The `keybind_name` of the parser that successfully parsed the current directory.
|
||||
Used for custom-keybind filtering.
|
||||
|
||||
#### `fb.get_directory(): string`
|
||||
|
||||
The current directory open in the browser.
|
||||
|
||||
#### `fb.get_dvd_device(): string`
|
||||
|
||||
The current dvd-device as reported by mpv's `dvd-device` property.
|
||||
Formatted to work with file-browser.
|
||||
|
||||
#### `fb.get_extensions(): table`
|
||||
|
||||
Returns the set of valid extensions after applying the user's whitelist/blacklist options.
|
||||
The table is in the form `{ mkv = true, mp3 = true, ... }`.
|
||||
Sub extensions, audio extensions, and parseable extensions are all included in this set.
|
||||
|
||||
#### `fb.get_list(): list_table`
|
||||
|
||||
The list_table currently open in the browser.
|
||||
|
||||
#### `fb.get_open_status(): boolean`
|
||||
|
||||
Returns true if the browser is currently open and false if not.
|
||||
|
||||
#### `fb.get_opt(name: string): string | number | boolean`
|
||||
|
||||
Returns the script-opt with the given name.
|
||||
|
||||
#### `fb.get_parsers(): table`
|
||||
|
||||
Returns a table of all the loaded parsers/addons.
|
||||
The formatting of this table in undefined, but it should
|
||||
always contain an array of the parsers in order of priority.
|
||||
|
||||
#### `fb.get_parse_state(co?: coroutine): parse_state_table`
|
||||
|
||||
Returns the [parse_state table](#parse-state-table) for the given coroutine.
|
||||
If no coroutine is given then it uses the running coroutine.
|
||||
Every parse operation is guaranteed to have a unique coroutine.
|
||||
|
||||
#### `fb.get_parseable_extensions(): table`
|
||||
|
||||
Returns a set of extensions like [`fb.get_extensions`](#fbget_extensions-table) but for extensions that are
|
||||
treated as parseable by the browser.
|
||||
All of these are included in `fb.get_extensions`.
|
||||
|
||||
#### `fb.get_root(): list_table`
|
||||
|
||||
Returns the root table.
|
||||
|
||||
#### `fb.get_script_opts(): table`
|
||||
|
||||
The table of script opts set by the user. This currently does not get
|
||||
changed during runtime, but that is not guaranteed for future minor version increments.
|
||||
|
||||
#### `fb.get_selected_index(): number`
|
||||
|
||||
The current index of the cursor.
|
||||
Note that it is possible for the cursor to be outside the bounds of the list;
|
||||
for example when the list is empty this usually returns 1.
|
||||
|
||||
#### `fb.get_selected_item(): item_table | nil`
|
||||
|
||||
Returns the item_table of the currently selected item.
|
||||
If no item is selected (for example an empty list) then returns nil.
|
||||
|
||||
#### `fb.get_state(): table`
|
||||
|
||||
Returns the current state values of the browser.
|
||||
These are not documented and are subject to change at any time,
|
||||
adding a proper getter for anything is a valid request.
|
||||
|
||||
#### `fb.get_sub_extensions(): table`
|
||||
|
||||
Returns a set of extensions like [`fb.get_extensions`](#fbget_extensions-table) but for extensions that are opened
|
||||
as additional subtitle tracks.
|
||||
All of these are included in `fb.get_extensions`.
|
||||
|
||||
#### `parser:get_id(): string`
|
||||
|
||||
The unique id of the parser. Used for log messages and various internal functions.
|
||||
|
||||
#### `parser:get_index(): number`
|
||||
|
||||
The index of the parser in order of preference (based on the priority value).
|
||||
`defer` uses this internally.
|
||||
|
||||
### Setters
|
||||
|
||||
#### `fb.set_selected_index(pos: number): number | false`
|
||||
|
||||
Sets the cursor position and returns the new index.
|
||||
If the input is not a number return false, if the input is out of bounds move it in bounds.
|
||||
|
||||
## Examples
|
||||
|
||||
For standard addons that add support for non-native filesystems, but otherwise don't do anything fancy, see [ftp-browser](ftp-browser.lua) and [apache-browser](apache-browser.lua).
|
||||
|
||||
For more simple addons that make a few small modifications to how other parsers are displayed, see [home-label](home-label.lua).
|
||||
|
||||
For more complex addons that maintain their own virtual directory structure, see
|
||||
[favourites](favourites.lua).
|
||||
@@ -0,0 +1,327 @@
|
||||
# Custom Keybinds
|
||||
|
||||
File-browser also supports custom keybinds. These keybinds send normal input commands, but the script will substitute characters in the command strings for specific values depending on the currently open directory, and currently selected item.
|
||||
This allows for a wide range of customised behaviour, such as loading additional audio tracks from the browser, or copying the path of the selected item to the clipboard.
|
||||
|
||||
The feature is disabled by default, but is enabled with the `custom_keybinds` script-opt.
|
||||
Keybinds are declared in the `~~/script-opts/file-browser-keybinds.json` file, the config takes the form of an array of json objects, with the following keys:
|
||||
|
||||
| option | required | default | description |
|
||||
|---------------|----------|------------|--------------------------------------------------------------------------------------------|
|
||||
| key | yes | - | the key to bind the command to - same syntax as input.conf |
|
||||
| command | yes | - | json array of commands and arguments |
|
||||
| name | no | numeric id | name of the script-binding - see [modifying default keybinds](#modifying-default-keybinds) |
|
||||
| condition | no | - | a Lua [expression](#expressions) - the keybind will only run if this evaluates to true |
|
||||
| flags | no | - | flags to send to the mpv add_keybind function - see [here](https://mpv.io/manual/master/#lua-scripting-[,flags]]\)) |
|
||||
| filter | no | - | run the command on just a file (`file`) or folder (`dir`) |
|
||||
| parser | no | - | run the command only in directories provided by the specified parser. |
|
||||
| multiselect | no | `false` | command is run on all selected items |
|
||||
| multi-type | no | `repeat` | which multiselect mode to use - `repeat` or `concat` |
|
||||
| delay | no | `0` | time to wait between sending repeated multi commands |
|
||||
| concat-string | no | `' '` (space) | string to insert between items when concatenating multi commands |
|
||||
| passthrough | no | - | force or ban passthrough behaviour - see [passthrough](#passthrough-keybinds) |
|
||||
|
||||
Example:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["print-text", "example"],
|
||||
}
|
||||
```
|
||||
|
||||
The command can also be an array of arrays, in order to send multiple commands at once:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP2",
|
||||
"command": [
|
||||
["print-text", "example2"],
|
||||
["show-text", "example2"]
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Filter should not be included unless one wants to limit what types of list entries the command should be run on.
|
||||
To only run the command for directories use `dir`, to only run the command for files use `file`.
|
||||
|
||||
The parser filter is for filtering keybinds to only work inside directories loaded by specific parsers.
|
||||
There are two parsers in the base script, the default parser for native filesystems is called `file`, while the root parser is called `root`.
|
||||
Other parsers can be supplied by addons, and use the addon's filename with `-browser.lua` or just `.lua` stripped unless otherwise stated.
|
||||
For example `ftp-browser.lua` would have a parser called `ftp`.
|
||||
You can set the filter to match multiple parsers by separating the names with spaces.
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP2",
|
||||
"command": [ ["print-text", "example3"] ],
|
||||
"parser": "ftp file"
|
||||
}
|
||||
```
|
||||
|
||||
The `flags` field is mostly only useful for addons, but can also be useful if one wants a key to be repeatable.
|
||||
In this case the the keybind would look like the following:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "p",
|
||||
"command": ["print-text", "spam-text"],
|
||||
"flags": { "repeatable": true }
|
||||
}
|
||||
```
|
||||
|
||||
## Codes
|
||||
|
||||
The script will scan every string in the command for the special substitution strings, they are:
|
||||
|
||||
| code | description |
|
||||
|--------|---------------------------------------------------------------------|
|
||||
| `%%` | escape code for `%` |
|
||||
| `%f` | filepath of the selected item |
|
||||
| `%n` | filename of the selected item |
|
||||
| `%p` | currently open directory |
|
||||
| `%q` | currently open directory but preferring the directory label |
|
||||
| `%d` | name of the current directory (characters between the last two '/') |
|
||||
| `%r` | name of the parser for the currently open directory |
|
||||
| `%x` | number of items in the currently open directory |
|
||||
| `%i` | the 1-based index of the selected item in the list |
|
||||
| `%j` | the 1-based index of the item in a multiselection - returns 1 for single selections |
|
||||
|
||||
Additionally, using the uppercase forms of those codes will send the substituted string through the `string.format("%q", str)` function.
|
||||
This adds double quotes around the string and automatically escapes any characters which would break the string encapsulation.
|
||||
This is not necessary for most mpv commands, but can be very useful when sending commands to the OS with the `run` command,
|
||||
or when passing values into [expressions](#conditional-command-condition-command).
|
||||
|
||||
Example of a command to add an audio track:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "Ctrl+a",
|
||||
"command": ["audio-add", "%f"],
|
||||
"filter": "file"
|
||||
}
|
||||
```
|
||||
|
||||
Any commands that contain codes representing specific items (`%f`, `%n`, `%i` etc) will
|
||||
not be run if no item is selected (for example in an empty directory).
|
||||
In these cases [passthrough](#passthrough-keybinds) rules will apply.
|
||||
|
||||
## Multiselect Commands
|
||||
|
||||
When multiple items are selected the command can be run for all items in the order they appear on the screen.
|
||||
This can be controlled by the `multiselect` flag, which takes a boolean value.
|
||||
When not set the flag defaults to `false`.
|
||||
|
||||
There are two different multiselect modes, controlled by the `multi-type` option. There are two options:
|
||||
|
||||
### `repeat`
|
||||
|
||||
The default mode that sends the commands once for each item that is selected.
|
||||
If time is needed between running commands of multiple selected items (for example, due to file handlers) then the `delay` option can be used to set a duration (in seconds) between commands.
|
||||
|
||||
### `concat`
|
||||
|
||||
Run a single command, but replace item specific codes with a concatenated string made from each selected item.
|
||||
For example `["print-text", "%n" ]` would print the name of each item selected separated by `' '` (space).
|
||||
The string inserted between each item is determined by the `concat-string` option, but `' '` is the default.
|
||||
|
||||
## Passthrough Keybinds
|
||||
|
||||
When loading keybinds from the json file file-browser will move down the list and overwrite any existing bindings with the same key.
|
||||
This means the lower an item on the list, the higher preference it has.
|
||||
However, file-browser implements a layered passthrough system for its keybinds; if a keybind is blocked from running by user filters, then the next highest preference command will be sent, continuing until a command is sent or there are no more keybinds.
|
||||
The default dynamic keybinds are considered the lowest priority.
|
||||
|
||||
The `filter`, `parser`, and `condition` options can all trigger passthrough, as well as some [codes](#codes).
|
||||
If a multi-select command is run on multiple items then passthrough will occur if any of the selected items fail the filters.
|
||||
|
||||
Passthrough can be forcibly disabled or enabled using the passthrough option.
|
||||
When set to `true` passthrough will always be activate regardless of the state of the filters.
|
||||
|
||||
## Modifying Default Keybinds
|
||||
|
||||
Since the custom keybinds are applied after the default dynamic keybinds they can be used to overwrite the default bindings.
|
||||
Setting new keys for the existing binds can be done with the `script-binding [binding-name]` command, where `binding-name` is the full name of the keybinding.
|
||||
For this script the names of the dynamic keybinds are in the format `file_browser/dynamic/[name]` where `name` is a unique identifier documented in the [keybinds](README.md#keybinds) table.
|
||||
|
||||
For example to change the scroll buttons from the arrows to the scroll wheel:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"key": "WHEEL_UP",
|
||||
"command": ["script-binding", "file_browser/dynamic/scroll_up"]
|
||||
},
|
||||
{
|
||||
"key": "WHEEL_DOWN",
|
||||
"command": ["script-binding", "file_browser/dynamic/scroll_down"]
|
||||
},
|
||||
{
|
||||
"key": "UP",
|
||||
"command": ["osd-auto", "add", "volume", "2"]
|
||||
},
|
||||
{
|
||||
"key": "DOWN",
|
||||
"command": ["osd-auto", "add", "volume", "-2"]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
Custom keybinds can be called using the same method, but users must set the `name` value inside the `file-browser-keybinds.json` file.
|
||||
To avoid conflicts custom keybinds use the format: `file_browser/dynamic/custom/[name]`.
|
||||
|
||||
## Expressions
|
||||
|
||||
Expressions are used to evaluate Lua code into a string that can be used for commands.
|
||||
These behave similarly to those used for [`profile-cond`](https://mpv.io/manual/master/#conditional-auto-profiles)
|
||||
values. In an expression the `mp`, `mp.msg`, and `mp.utils` modules are available as `mp`, `msg`, and `utils` respectively.
|
||||
Additionally the file-browser [addon API](addons/addons.md#the-api) is available as `fb` and if [mpv-user-input](https://github.com/CogentRedTester/mpv-user-input)
|
||||
is installed then user-input API will be available in `input`.
|
||||
|
||||
This example only runs the keybind if the browser is in the Windows C drive or if
|
||||
the selected item is a matroska file:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["print-text", "in my C:/ drive!"],
|
||||
"condition": "(%P):find('C:/') == 1"
|
||||
},
|
||||
{
|
||||
"key": "KP2",
|
||||
"command": ["print-text", "Matroska File!"],
|
||||
"condition": "fb.get_extension(%N) == 'mkv'"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
If the `condition` expression contains any item specific codes (`%F`, `%I`, etc) then it will be
|
||||
evaluated on each individual item, otherwise it will evaluated once for the whole keybind.
|
||||
If a code is invalid (for example using `%i` in empty directories) then the expression returns false.
|
||||
|
||||
There are some utility script messages that extend the power of expressions.
|
||||
[`conditional-command`](#conditional-command-condition-command) allows one to specify conditions that
|
||||
can apply to individual items or commands. The tradeoff is that you lose the automated passthrough behaviour.
|
||||
There is also [`evaluate-expressions`](#evaluate-expressions-command) which allows one to evaluate expressions inside commands.
|
||||
|
||||
## Utility Script Messages
|
||||
|
||||
There are a small number of custom script messages defined by file-browser to support custom keybinds.
|
||||
|
||||
### `=> <command...>`
|
||||
|
||||
A basic script message that makes it easier to chain multiple utility script messages together.
|
||||
Any `=>` string will be substituted for `script-message`.
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "=>", "delay-command", "%j * 2", "=>", "evaluate-expressions", "print-text", "!{%j * 2}"],
|
||||
"multiselect": true
|
||||
}
|
||||
```
|
||||
|
||||
### `conditional-command [condition] <command...>`
|
||||
|
||||
Runs the following command only if the condition [expression](#expressions) is `true`.
|
||||
|
||||
This example command will only run if the player is currently paused:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "conditional-command", "mp.get_property_bool('pause')", "print-text", "is paused"],
|
||||
}
|
||||
```
|
||||
|
||||
Custom keybind codes are evaluated before the expressions.
|
||||
|
||||
This example only runs if the currently selected item in the browser has a `.mkv` extension:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "conditional-command", "fb.get_extension(%N) == 'mkv'", "print-text", "a matroska file"],
|
||||
}
|
||||
```
|
||||
|
||||
### `delay-command [delay] <command...>`
|
||||
|
||||
Delays the following command by `[delay]` seconds.
|
||||
Delay is an [expression](#expressions).
|
||||
|
||||
The following example will send the `print-text` command after 5 seconds:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "delay-command", "5", "print-text", "example"],
|
||||
}
|
||||
```
|
||||
|
||||
### `evaluate-expressions <command...>`
|
||||
|
||||
Evaluates embedded Lua expressions in the following command.
|
||||
Expressions have the same behaviour as the [`conditional-command`](#conditional-command-condition-command) script-message.
|
||||
Expressions must be surrounded by `!{}` characters.
|
||||
Additional `!` characters can be placed at the start of the expression to
|
||||
escape the evaluation.
|
||||
|
||||
For example the following keybind will print 3 to the console:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "evaluate-expressions", "print-text", "!{1 + 2}"],
|
||||
}
|
||||
```
|
||||
|
||||
This example replaces all `/` characters in the path with `\`
|
||||
(note that the `\` needs to be escaped twice, once for the json file, and once for the string in the lua expression):
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "evaluate-expressions", "print-text", "!{ string.gsub(%F, '/', '\\\\') }"],
|
||||
}
|
||||
```
|
||||
|
||||
### `run-statement <statement...>`
|
||||
|
||||
Runs the following string a as a Lua statement. This is similar to an [expression](#expressions),
|
||||
but instead of the code evaluating to a value it must run a series of statements. Basically it allows
|
||||
for function bodies to be embedded into custom keybinds. All the same modules are available.
|
||||
If multiple strings are sent to the script-message then they will be concatenated together with newlines.
|
||||
|
||||
The following keybind will use [mpv-user-input](https://github.com/CogentRedTester/mpv-user-input) to
|
||||
rename items in file-browser:
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["script-message", "run-statement",
|
||||
"assert(input, 'install mpv-user-input!')",
|
||||
|
||||
"local line, err = input.get_user_input_co({",
|
||||
"id = 'rename-file',",
|
||||
"source = 'custom-keybind',",
|
||||
"request_text = 'rename file:',",
|
||||
"queueable = true,",
|
||||
"default_input = %N,",
|
||||
"cursor_pos = #(%N) - #fb.get_extension(%N, '')",
|
||||
"})",
|
||||
|
||||
"if not line then return end",
|
||||
"os.rename(%F, utils.join_path(%P, line))",
|
||||
|
||||
"fb.rescan()"
|
||||
],
|
||||
"parser": "file",
|
||||
"multiselect": true
|
||||
}
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
See [here](file-browser-keybinds.json).
|
||||
@@ -0,0 +1,118 @@
|
||||
[
|
||||
{
|
||||
"key": "KP1",
|
||||
"command": ["print-text", "file: %f"],
|
||||
"multiselect": true
|
||||
},
|
||||
{
|
||||
"key": "KP2",
|
||||
"command": ["print-text", "name: %n"],
|
||||
"multiselect": true
|
||||
},
|
||||
{
|
||||
"key": "KP3",
|
||||
"command": ["print-text", "open directory: %p"]
|
||||
},
|
||||
{
|
||||
"key": "KP4",
|
||||
"command": ["print-text", "directory name: %d"]
|
||||
},
|
||||
{
|
||||
"key": "KP5",
|
||||
"command": ["print-text", "escape the code: %%f"],
|
||||
"multiselect": true
|
||||
},
|
||||
{
|
||||
"key": "KP6",
|
||||
"command": ["print-text", "full filepath via concatenation: %p%n"],
|
||||
"multiselect": true
|
||||
},
|
||||
{
|
||||
"key": "KP7",
|
||||
"command": ["print-text", "quote/escape filepath: %F"],
|
||||
"multiselect": true
|
||||
},
|
||||
|
||||
|
||||
{
|
||||
"comment": "deletes the currently selected file",
|
||||
"key": "Alt+DEL",
|
||||
"command": ["run", "rm", "%F"],
|
||||
"filter": "file",
|
||||
"multiselect": true,
|
||||
"multi-type": "concat"
|
||||
},
|
||||
{
|
||||
"comment": "opens the currently selected items in a new mpv window",
|
||||
"key": "Ctrl+ENTER",
|
||||
"command": ["run", "mpv", "%F"],
|
||||
"multiselect": true,
|
||||
"multi-type": "concat"
|
||||
},
|
||||
{
|
||||
"key": "Ctrl+c",
|
||||
"command": [
|
||||
["run", "powershell", "-command", "Set-Clipboard", "%F"],
|
||||
["print-text", "copied filepath to clipboard"]
|
||||
],
|
||||
"multiselect": true,
|
||||
"delay": 0.3
|
||||
},
|
||||
{
|
||||
"comment": "Opens the current directory in windows explorer",
|
||||
"key": "Ctrl+o",
|
||||
"command": ["run", "powershell", "-command", "explorer.exe", "(( %P ).TrimEnd('/') -replace '/', '\\' )"],
|
||||
"multiselect": false
|
||||
},
|
||||
{
|
||||
"comment": "Opens the selected directory in windows explorer",
|
||||
"key": "Ctrl+O",
|
||||
"command": ["run", "powershell", "-command", "explorer.exe", "(( %F ).TrimEnd('/') -replace '/', '\\' )"],
|
||||
"filter": "dir",
|
||||
"multiselect": true
|
||||
},
|
||||
{
|
||||
"comment": "Opens the current directory in windows explorer and highlights the currently selected file",
|
||||
"key": "Ctrl+O",
|
||||
"command": ["run", "powershell", "-command", "explorer.exe", "'/select,'", "( %F -replace '/', '\\' )"],
|
||||
"filter": "file",
|
||||
"multiselect": true
|
||||
},
|
||||
{
|
||||
"key": "INS",
|
||||
"command": ["run", "powershell", "-command", "Set-Content", "-LiteralPath", "( %P + '/.ordered-chapters.m3u' )", "-Value", "( %N )"],
|
||||
"multiselect": true,
|
||||
"multi-type": "concat",
|
||||
"concat-string": "+ '\n' +"
|
||||
},
|
||||
|
||||
|
||||
{
|
||||
"key": "WHEEL_UP",
|
||||
"command": ["script-binding", "file_browser/dynamic/scroll_up"]
|
||||
},
|
||||
{
|
||||
"key": "WHEEL_DOWN",
|
||||
"command": ["script-binding", "file_browser/dynamic/scroll_down"]
|
||||
},
|
||||
{
|
||||
"key": "MBTN_LEFT",
|
||||
"command": ["script-binding", "file_browser/dynamic/down_dir"]
|
||||
},
|
||||
{
|
||||
"key": "MBTN_RIGHT",
|
||||
"command": ["script-binding", "file_browser/dynamic/up_dir"]
|
||||
},
|
||||
{
|
||||
"key": "MBTN_MID",
|
||||
"command": ["script-binding", "file_browser/dynamic/play"]
|
||||
},
|
||||
{
|
||||
"key": "UP",
|
||||
"command": ["osd-auto", "add", "volume", "2"]
|
||||
},
|
||||
{
|
||||
"key": "DOWN",
|
||||
"command": ["osd-auto", "add", "volume", "-2"]
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,156 @@
|
||||
#######################################################
|
||||
# This is the default config file for mpv-file-browser
|
||||
# https://github.com/CogentRedTester/mpv-file-browser
|
||||
#######################################################
|
||||
|
||||
# root directories, separated by commas
|
||||
# on linux you will probably want to add `/`,
|
||||
# on windows this should be used to add different drive letters
|
||||
# Examples:
|
||||
# linux: root=~/,/
|
||||
# windows: root=~/,C:/
|
||||
root=~/
|
||||
|
||||
# characters to separate root directories, each character works individually
|
||||
# this is in case one is using directories with strange names
|
||||
root_separators=,;
|
||||
|
||||
# number of entries to show on the screen at once
|
||||
num_entries=20
|
||||
|
||||
# wrap the cursor around the top and bottom of the list
|
||||
wrap=no
|
||||
|
||||
# only show files compatible with mpv in the browser
|
||||
filter_files=yes
|
||||
|
||||
# experimental feature that recurses directories concurrently when appending items to the playlist
|
||||
# this feature has the potential for massive performance improvements when using addons with asynchronous IO
|
||||
concurrent_recursion=no
|
||||
|
||||
# maximum number of recursions that can run concurrently
|
||||
# if this number is too high it risks overflowing the mpv event queue, which will cause some directories to be dropped entirely
|
||||
max_concurrency=16
|
||||
|
||||
# enable custom keybinds
|
||||
# the keybind json file must go in ~~/script-opts
|
||||
custom_keybinds=no
|
||||
|
||||
# file-browser only shows files that are compatible with mpv by default
|
||||
# adding a file extension to this list will add it to the extension whitelist
|
||||
# extensions are separated with the root separators, do not use any spaces
|
||||
extension_whitelist=
|
||||
|
||||
# add file extensions to this list to disable default filetypes
|
||||
# note that this will also override audio/subtitle_extension options below
|
||||
extension_blacklist=
|
||||
|
||||
# files with these extensions will be added as additional audio tracks for the current file instead of appended to the playlist
|
||||
# items on this list are automatically added to the extension whitelist
|
||||
audio_extensions=mka,dts,dtshd,dts-hd,truehd,true-hd
|
||||
|
||||
# files with these extensions will be added as additional subtitle tracks for the current file instead of appended to the playlist
|
||||
# items on this list are automatically added to the extension whitelist
|
||||
subtitle_extensions=etf,etf8,utf-8,idx,sub,srt,rt,ssa,ass,mks,vtt,sup,scc,smi,lrc,pgs
|
||||
|
||||
# filter directories or files starting with a period like .config
|
||||
# for linux systems
|
||||
filter_dot_dirs=no
|
||||
filter_dot_files=no
|
||||
|
||||
# substitude forward slashes for backslashes when appending a local file to the playlist
|
||||
# may be useful on windows systems
|
||||
substitute_backslash=no
|
||||
|
||||
# this option reverses the behaviour of the alt+ENTER keybind
|
||||
# when disabled the keybind is required to enable autoload for the file
|
||||
# when enabled the keybind disables autoload for the file
|
||||
autoload=no
|
||||
|
||||
# if autoload is triggered by selecting the currently playing file, then
|
||||
# the current file will have it's watch-later config saved before being closed and re-opened
|
||||
# essentially the current file will not be restarted
|
||||
autoload_save_current=yes
|
||||
|
||||
# when opening the browser in idle mode prefer the current working directory over the root
|
||||
# note that the working directory is set as the 'current' directory regardless, so `home` will
|
||||
# move the browser there even if this option is set to false
|
||||
default_to_working_directory=no
|
||||
|
||||
# enables addons
|
||||
addons=no
|
||||
addon_directory=~~/script-modules/file-browser-addons
|
||||
|
||||
# directory to load external modules - currently just user-input-module
|
||||
module_directory=~~/script-modules
|
||||
|
||||
# turn the OSC idle screen off and on when opening and closing the browser
|
||||
# this should only be enabled if file-browser is the only thing controlling the idle-screen,
|
||||
# if multiple sources attempt to control the idle-screen at the same time it can cause unexpected behaviour.
|
||||
toggle_idlescreen=no
|
||||
|
||||
# Set the current open status of the browser in the `file_browser/open` field of the `user-data` property.
|
||||
# This property is only available in mpv v0.36+.
|
||||
set_user_data=yes
|
||||
|
||||
# Set the current open status of the browser in the `file_browser-open` field of the `shared-script-properties` property.
|
||||
# This property is deprecated. When it is removed in mpv v0.37 file-browser will automatically disable this option.
|
||||
set_shared_script_properties=yes
|
||||
|
||||
####################################
|
||||
######### style settings ###########
|
||||
####################################
|
||||
|
||||
# force file-browser to use a specific text alignment (default: top-left)
|
||||
# uses ass tag alignment numbers: https://aegi.vmoe.info/docs/3.0/ASS_Tags/#index23h3
|
||||
# set to 0 to use the default mpv osd-align options
|
||||
alignment=7
|
||||
|
||||
# The format string used for the header. Uses custom-keybind substitution codes to
|
||||
# dynamically change the contents of the header. See: docs/custom-keybinds.md#codes
|
||||
format_string_header=%q\N----------------------------------------------------
|
||||
|
||||
# The format strings used for the wrappers. Supports custom-keybind substitution codes, and
|
||||
# supports two additional codes: `%<` and `%>` to show the number of items before and after the visible list, respectively.
|
||||
# Setting these options to empty strings will disable the wrappers.
|
||||
format_string_topwrapper=%< item(s) above\N
|
||||
format_string_bottomwrapper=\N%> item(s) remaining
|
||||
|
||||
# allows custom icons be set for the folder and cursor
|
||||
# the `\h` character is a hard space to add padding
|
||||
folder_icon={\p1}m 6.52 0 l 1.63 0 b 0.73 0 0.01 0.73 0.01 1.63 l 0 11.41 b 0 12.32 0.73 13.05 1.63 13.05 l 14.68 13.05 b 15.58 13.05 16.31 12.32 16.31 11.41 l 16.31 3.26 b 16.31 2.36 15.58 1.63 14.68 1.63 l 8.15 1.63{\p0}\h
|
||||
cursor_icon={\p1}m 14.11 6.86 l 0.34 0.02 b 0.25 -0.02 0.13 -0 0.06 0.08 b -0.01 0.16 -0.02 0.28 0.04 0.36 l 3.38 5.55 l 3.38 5.55 3.67 6.15 3.81 6.79 3.79 7.45 3.61 8.08 3.39 8.5l 0.04 13.77 b -0.02 13.86 -0.01 13.98 0.06 14.06 b 0.11 14.11 0.17 14.13 0.24 14.13 b 0.27 14.13 0.31 14.13 0.34 14.11 l 14.11 7.28 b 14.2 7.24 14.25 7.16 14.25 7.07 b 14.25 6.98 14.2 6.9 14.11 6.86{\p0}\h
|
||||
|
||||
# set the opacity of fonts in hexadecimal from 00 (opaque) to FF (transparent)
|
||||
font_opacity_selection_marker=99
|
||||
|
||||
# print the header in bold font
|
||||
font_bold_header=yes
|
||||
|
||||
# scale the size of the browser; 2 would double the size, 0.5 would halve it, etc.
|
||||
# the header and wrapper scaling is relative to the base scaling
|
||||
scaling_factor_base=1
|
||||
scaling_factor_header=1.4
|
||||
scaling_factor_wrappers=0.64
|
||||
|
||||
# set custom font names, blank is the default
|
||||
# setting custom fonts for the folder/cursor can fix broken or missing icons
|
||||
font_name_header=
|
||||
font_name_body=
|
||||
font_name_wrappers=
|
||||
font_name_folder=
|
||||
font_name_cursor=
|
||||
|
||||
# set custom font colours
|
||||
# colours are in hexadecimal format in Blue Green Red order
|
||||
# note that this is the opposite order to most RGB colour codes
|
||||
font_colour_header=00ccff
|
||||
font_colour_body=ffffff
|
||||
font_colour_wrappers=00ccff
|
||||
font_colour_cursor=00ccff
|
||||
|
||||
# these are colours applied to list items in different states
|
||||
font_colour_selected=fce788
|
||||
font_colour_multiselect=fcad88
|
||||
font_colour_playing=33ff66
|
||||
font_colour_playing_multiselected=22b547
|
||||
@@ -0,0 +1,60 @@
|
||||
--[[
|
||||
mpv-file-browser
|
||||
|
||||
This script allows users to browse and open files and folders entirely from within mpv.
|
||||
The script uses nothing outside the mpv API, so should work identically on all platforms.
|
||||
The browser can move up and down directories, start playing files and folders, or add them to the queue.
|
||||
|
||||
For full documentation see: https://github.com/CogentRedTester/mpv-file-browser
|
||||
]]--
|
||||
|
||||
local mp = require 'mp'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local addons = require 'modules.addons'
|
||||
local keybinds = require 'modules.keybinds'
|
||||
local setup = require 'modules.setup'
|
||||
local controls = require 'modules.controls'
|
||||
local observers = require 'modules.observers'
|
||||
local script_messages = require 'modules.script-messages'
|
||||
|
||||
local file_parser = require 'modules.parsers.file'
|
||||
local root_parser = require 'modules.parsers.root'
|
||||
|
||||
-- setting the package paths
|
||||
package.path = mp.command_native({"expand-path", o.module_directory}).."/?.lua;"..package.path
|
||||
local _, input = pcall(require, "user-input-module")
|
||||
|
||||
-- root and addon setup
|
||||
setup.root()
|
||||
addons.setup_parser(file_parser, "file-browser.lua")
|
||||
addons.setup_parser(root_parser, 'file-browser.lua')
|
||||
if o.addons then addons.setup_addons() end
|
||||
|
||||
--these need to be below the addon setup in case any parsers add custom entries
|
||||
setup.extensions_list()
|
||||
keybinds.setup_keybinds()
|
||||
|
||||
-- property observers
|
||||
mp.observe_property('path', 'string', observers.current_directory)
|
||||
mp.observe_property('dvd-device', 'string', observers.dvd_device)
|
||||
|
||||
-- scripts messages
|
||||
mp.register_script_message('=>', script_messages.chain)
|
||||
mp.register_script_message('delay-command', script_messages.delay_command)
|
||||
mp.register_script_message('conditional-command', script_messages.conditional_command)
|
||||
mp.register_script_message('evaluate-expressions', script_messages.evaluate_expressions)
|
||||
mp.register_script_message('run-statement', script_messages.run_statement)
|
||||
|
||||
mp.register_script_message('browse-directory', controls.browse_directory)
|
||||
mp.register_script_message("get-directory-contents", script_messages.get_directory_contents)
|
||||
|
||||
--declares the keybind to open the browser
|
||||
mp.add_key_binding('MENU','browse-files', controls.toggle)
|
||||
mp.add_key_binding('Ctrl+o','open-browser', controls.open)
|
||||
|
||||
if input then
|
||||
mp.add_key_binding("Alt+o", "browse-directory/get-user-input", function()
|
||||
input.get_user_input(controls.browse_directory, {request_text = "open directory:"})
|
||||
end)
|
||||
end
|
||||
@@ -0,0 +1,159 @@
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local fb = require 'modules.apis.fb'
|
||||
local API = require 'modules.utils'
|
||||
local parser_API = require 'modules.apis.parser'
|
||||
|
||||
local root_parser = require 'modules.parsers.root'
|
||||
|
||||
local API_MAJOR, API_MINOR, API_PATCH = g.API_VERSION:match("(%d+)%.(%d+)%.(%d+)")
|
||||
|
||||
--checks if the given parser has a valid version number
|
||||
local function check_api_version(parser)
|
||||
local version = parser.version or "1.0.0"
|
||||
|
||||
local major, minor = version:match("(%d+)%.(%d+)")
|
||||
|
||||
if not major or not minor then
|
||||
return msg.error("Invalid version number")
|
||||
elseif major ~= API_MAJOR then
|
||||
return msg.error("parser", parser.name, "has wrong major version number, expected", ("v%d.x.x"):format(API_MAJOR), "got", 'v'..version)
|
||||
elseif minor > API_MINOR then
|
||||
msg.warn("parser", parser.name, "has newer minor version number than API, expected", ("v%d.%d.x"):format(API_MAJOR, API_MINOR), "got", 'v'..version)
|
||||
end
|
||||
return true
|
||||
end
|
||||
|
||||
--create a unique id for the given parser
|
||||
local function set_parser_id(parser)
|
||||
local name = parser.name
|
||||
if g.parsers[name] then
|
||||
local n = 2
|
||||
name = parser.name.."_"..n
|
||||
while g.parsers[name] do
|
||||
n = n + 1
|
||||
name = parser.name.."_"..n
|
||||
end
|
||||
end
|
||||
|
||||
g.parsers[name] = parser
|
||||
g.parsers[parser] = { id = name }
|
||||
end
|
||||
|
||||
--loads an addon in a separate environment
|
||||
local function load_addon(path)
|
||||
local name_sqbr = string.format("[%s]", path:match("/([^/]*)%.lua$"))
|
||||
local addon_environment = API.redirect_table(_G)
|
||||
addon_environment._G = addon_environment
|
||||
|
||||
--gives each addon custom debug messages
|
||||
addon_environment.package = API.redirect_table(addon_environment.package)
|
||||
addon_environment.package.loaded = API.redirect_table(addon_environment.package.loaded)
|
||||
local msg_module = {
|
||||
log = function(level, ...) msg.log(level, name_sqbr, ...) end,
|
||||
fatal = function(...) return msg.fatal(name_sqbr, ...) end,
|
||||
error = function(...) return msg.error(name_sqbr, ...) end,
|
||||
warn = function(...) return msg.warn(name_sqbr, ...) end,
|
||||
info = function(...) return msg.info(name_sqbr, ...) end,
|
||||
verbose = function(...) return msg.verbose(name_sqbr, ...) end,
|
||||
debug = function(...) return msg.debug(name_sqbr, ...) end,
|
||||
trace = function(...) return msg.trace(name_sqbr, ...) end,
|
||||
}
|
||||
addon_environment.print = msg_module.info
|
||||
|
||||
addon_environment.require = function(module)
|
||||
if module == "mp.msg" then return msg_module end
|
||||
return require(module)
|
||||
end
|
||||
|
||||
local chunk, err
|
||||
if setfenv then
|
||||
--since I stupidly named a function loadfile I need to specify the global one
|
||||
--I've been using the name too long to want to change it now
|
||||
chunk, err = _G.loadfile(path)
|
||||
if not chunk then return msg.error(err) end
|
||||
setfenv(chunk, addon_environment)
|
||||
else
|
||||
chunk, err = _G.loadfile(path, "bt", addon_environment)
|
||||
if not chunk then return msg.error(err) end
|
||||
end
|
||||
|
||||
local success, result = xpcall(chunk, API.traceback)
|
||||
return success and result or nil
|
||||
end
|
||||
|
||||
--setup an internal or external parser
|
||||
local function setup_parser(parser, file)
|
||||
parser = setmetatable(parser, { __index = parser_API })
|
||||
parser.name = parser.name or file:gsub("%-browser%.lua$", ""):gsub("%.lua$", "")
|
||||
|
||||
set_parser_id(parser)
|
||||
if not check_api_version(parser) then return msg.error("aborting load of parser", parser:get_id(), "from", file) end
|
||||
|
||||
msg.verbose("imported parser", parser:get_id(), "from", file)
|
||||
|
||||
--sets missing functions
|
||||
if not parser.can_parse then
|
||||
if parser.parse then parser.can_parse = function() return true end
|
||||
else parser.can_parse = function() return false end end
|
||||
end
|
||||
|
||||
if parser.priority == nil then parser.priority = 0 end
|
||||
if type(parser.priority) ~= "number" then return msg.error("parser", parser:get_id(), "needs a numeric priority") end
|
||||
|
||||
--the root parser has special behaviour, so it should not be in the list of parsers
|
||||
if parser == root_parser then return end
|
||||
table.insert(g.parsers, parser)
|
||||
end
|
||||
|
||||
--load an external addon
|
||||
local function setup_addon(file, path)
|
||||
if file:sub(-4) ~= ".lua" then return msg.verbose(path, "is not a lua file - aborting addon setup") end
|
||||
|
||||
local addon_parsers = load_addon(path)
|
||||
if not addon_parsers or type(addon_parsers) ~= "table" then return msg.error("addon", path, "did not return a table") end
|
||||
|
||||
--if the table contains a priority key then we assume it isn't an array of parsers
|
||||
if not addon_parsers[1] then addon_parsers = {addon_parsers} end
|
||||
|
||||
for _, parser in ipairs(addon_parsers) do
|
||||
setup_parser(parser, file)
|
||||
end
|
||||
end
|
||||
|
||||
--loading external addons
|
||||
local function setup_addons()
|
||||
package.loaded["file-browser"] = setmetatable({}, { __index = fb })
|
||||
|
||||
local addon_dir = mp.command_native({"expand-path", o.addon_directory..'/'})
|
||||
local files = utils.readdir(addon_dir)
|
||||
if not files then error("could not read addon directory") end
|
||||
|
||||
for _, file in ipairs(files) do
|
||||
setup_addon(file, addon_dir..file)
|
||||
end
|
||||
table.sort(g.parsers, function(a, b) return a.priority < b.priority end)
|
||||
|
||||
--we want to store the indexes of the parsers
|
||||
for i = #g.parsers, 1, -1 do g.parsers[ g.parsers[i] ].index = i end
|
||||
|
||||
--we want to run the setup functions for each addon
|
||||
for index, parser in ipairs(g.parsers) do
|
||||
if parser.setup then
|
||||
local success = xpcall(function() parser:setup() end, API.traceback)
|
||||
if not success then
|
||||
msg.error("parser", parser:get_id(), "threw an error in the setup method - removing from list of parsers")
|
||||
table.remove(g.parsers, index)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
setup_parser = setup_parser,
|
||||
setup_addons = setup_addons,
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local ass = require 'modules.ass'
|
||||
local scanning = require 'modules.navigation.scanning'
|
||||
local cache = require 'modules.cache'
|
||||
local controls = require 'modules.controls'
|
||||
|
||||
local fb = setmetatable({}, { __index = setmetatable({}, { __index = API }) })
|
||||
|
||||
--these functions we'll provide as-is
|
||||
fb.redraw = ass.update_ass
|
||||
fb.rescan = scanning.rescan
|
||||
fb.browse_directory = controls.browse_directory
|
||||
|
||||
function fb.clear_cache()
|
||||
cache:clear()
|
||||
end
|
||||
|
||||
--a wrapper around scan_directory for addon API
|
||||
function fb.parse_directory(directory, parse_state)
|
||||
if not parse_state then parse_state = { source = "addon" }
|
||||
elseif not parse_state.source then parse_state.source = "addon" end
|
||||
return scanning.scan_directory(directory, parse_state)
|
||||
end
|
||||
|
||||
--register file extensions which can be opened by the browser
|
||||
function fb.register_parseable_extension(ext)
|
||||
g.parseable_extensions[string.lower(ext)] = true
|
||||
end
|
||||
function fb.remove_parseable_extension(ext)
|
||||
g.parseable_extensions[string.lower(ext)] = nil
|
||||
end
|
||||
|
||||
--add a compatible extension to show through the filter, only applies if run during the setup() method
|
||||
function fb.add_default_extension(ext)
|
||||
table.insert(g.compatible_file_extensions, ext)
|
||||
end
|
||||
|
||||
--add item to root at position pos
|
||||
function fb.insert_root_item(item, pos)
|
||||
msg.debug("adding item to root", item.label or item.name, pos)
|
||||
item.ass = item.ass or fb.ass_escape(item.label or item.name)
|
||||
item.type = "dir"
|
||||
table.insert(g.root, pos or (#g.root + 1), item)
|
||||
end
|
||||
|
||||
--a newer API for adding items to the root
|
||||
--only adds the item if the same item does not already exist in the root
|
||||
--the priority variable is a number that specifies the insertion location
|
||||
--a lower priority is placed higher in the list and the default is 100
|
||||
function fb.register_root_item(item, priority)
|
||||
msg.verbose('registering root item:', utils.to_string(item))
|
||||
if type(item) == 'string' then
|
||||
item = {name = item}
|
||||
end
|
||||
|
||||
-- if the item is already in the list then do nothing
|
||||
if fb.list.some(g.root, function(r)
|
||||
return fb.get_full_path(r, '') == fb.get_full_path(item, '')
|
||||
end) then return false end
|
||||
|
||||
item._priority = priority
|
||||
for i, v in ipairs(g.root) do
|
||||
if (v._priority or 100) > (priority or 100) then
|
||||
fb.insert_root_item(item, i)
|
||||
return true
|
||||
end
|
||||
end
|
||||
fb.insert_root_item(item)
|
||||
return true
|
||||
end
|
||||
|
||||
--providing getter and setter functions so that addons can't modify things directly
|
||||
function fb.get_script_opts() return fb.copy_table(o) end
|
||||
function fb.get_opt(key) return o[key] end
|
||||
function fb.get_extensions() return fb.copy_table(g.extensions) end
|
||||
function fb.get_sub_extensions() return fb.copy_table(g.sub_extensions) end
|
||||
function fb.get_audio_extensions() return fb.copy_table(g.audio_extensions) end
|
||||
function fb.get_parseable_extensions() return fb.copy_table(g.parseable_extensions) end
|
||||
function fb.get_state() return fb.copy_table(g.state) end
|
||||
function fb.get_dvd_device() return g.dvd_device end
|
||||
function fb.get_parsers() return fb.copy_table(g.parsers) end
|
||||
function fb.get_root() return fb.copy_table(g.root) end
|
||||
function fb.get_directory() return g.state.directory end
|
||||
function fb.get_list() return fb.copy_table(g.state.list) end
|
||||
function fb.get_current_file() return fb.copy_table(g.current_file) end
|
||||
function fb.get_current_parser() return g.state.parser:get_id() end
|
||||
function fb.get_current_parser_keyname() return g.state.parser.keybind_name or g.state.parser.name end
|
||||
function fb.get_selected_index() return g.state.selected end
|
||||
function fb.get_selected_item() return fb.copy_table(g.state.list[g.state.selected]) end
|
||||
function fb.get_open_status() return not g.state.hidden end
|
||||
function fb.get_parse_state(co) return g.parse_states[co or coroutine.running() or ""] end
|
||||
|
||||
function fb.set_empty_text(str)
|
||||
g.state.empty_text = str
|
||||
fb.redraw()
|
||||
end
|
||||
|
||||
function fb.set_selected_index(index)
|
||||
if type(index) ~= "number" then return false end
|
||||
if index < 1 then index = 1 end
|
||||
if index > #g.state.list then index = #g.state.list end
|
||||
g.state.selected = index
|
||||
fb.redraw()
|
||||
return index
|
||||
end
|
||||
|
||||
return fb
|
||||
@@ -0,0 +1,32 @@
|
||||
|
||||
local msg = require 'mp.msg'
|
||||
|
||||
local g = require 'modules.globals'
|
||||
|
||||
local parse_state_API = {}
|
||||
|
||||
--a wrapper around coroutine.yield that aborts the coroutine if
|
||||
--the parse request was cancelled by the user
|
||||
--the coroutine is
|
||||
function parse_state_API:yield(...)
|
||||
local co = coroutine.running()
|
||||
local is_browser = co == g.state.co
|
||||
if self.source == "browser" and not is_browser then
|
||||
msg.error("current coroutine does not match browser's expected coroutine - did you unsafely yield before this?")
|
||||
error("current coroutine does not match browser's expected coroutine - aborting the parse")
|
||||
end
|
||||
|
||||
local result = table.pack(coroutine.yield(...))
|
||||
if is_browser and co ~= g.state.co then
|
||||
msg.verbose("browser no longer waiting for list - aborting parse for", self.directory)
|
||||
error(g.ABORT_ERROR)
|
||||
end
|
||||
return unpack(result, 1, result.n)
|
||||
end
|
||||
|
||||
--checks if the current coroutine is the one handling the browser's request
|
||||
function parse_state_API:is_coroutine_current()
|
||||
return coroutine.running() == g.state.co
|
||||
end
|
||||
|
||||
return parse_state_API
|
||||
@@ -0,0 +1,25 @@
|
||||
local msg = require 'mp.msg'
|
||||
|
||||
local g = require 'modules.globals'
|
||||
local scanning = require 'modules.navigation.scanning'
|
||||
local fb = require 'modules.apis.fb'
|
||||
|
||||
local parser_api = setmetatable({}, { __index = fb })
|
||||
|
||||
function parser_api:get_index() return g.parsers[self].index end
|
||||
function parser_api:get_id() return g.parsers[self].id end
|
||||
|
||||
--a wrapper that passes the parsers priority value if none other is specified
|
||||
function parser_api:register_root_item(item, priority)
|
||||
return fb.register_root_item(item, priority or g.parsers[self:get_id()].priority)
|
||||
end
|
||||
|
||||
--runs choose_and_parse starting from the next parser
|
||||
function parser_api:defer(directory)
|
||||
msg.trace("deferring to other parsers...")
|
||||
local list, opts = scanning.choose_and_parse(directory, self:get_index() + 1)
|
||||
fb.get_parse_state().already_deferred = true
|
||||
return list, opts
|
||||
end
|
||||
|
||||
return parser_api
|
||||
@@ -0,0 +1,163 @@
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
-----------------------------------------List Formatting------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
local g = require 'modules.globals'
|
||||
local o = require 'modules.options'
|
||||
local API = require 'modules.utils'
|
||||
|
||||
local state = g.state
|
||||
local style = g.style
|
||||
local ass = g.ass
|
||||
|
||||
local function draw()
|
||||
ass:update()
|
||||
end
|
||||
|
||||
local function remove()
|
||||
ass:remove()
|
||||
end
|
||||
|
||||
local string_buffer = {}
|
||||
|
||||
--appends the entered text to the overlay
|
||||
local function append(...)
|
||||
for i = 1, select("#", ...) do
|
||||
table.insert(string_buffer, select(i, ...) or '' )
|
||||
end
|
||||
end
|
||||
|
||||
--appends a newline character to the osd
|
||||
local function newline()
|
||||
table.insert(string_buffer, '\\N')
|
||||
end
|
||||
|
||||
local function flush_buffer()
|
||||
ass.data = table.concat(string_buffer, '')
|
||||
string_buffer = {}
|
||||
end
|
||||
|
||||
--detects whether or not to highlight the given entry as being played
|
||||
local function highlight_entry(v)
|
||||
if g.current_file.name == nil then return false end
|
||||
if API.parseable_item(v) then
|
||||
return string.find(g.current_file.directory, API.get_full_path(v), 1, true)
|
||||
else
|
||||
return g.current_file.path == API.get_full_path(v)
|
||||
end
|
||||
end
|
||||
|
||||
-- escape ass values and replace newlines
|
||||
local function ass_escape(str)
|
||||
return API.ass_escape(str, true)
|
||||
end
|
||||
|
||||
--refreshes the ass text using the contents of the list
|
||||
local function update_ass()
|
||||
if state.hidden then state.flag_update = true ; return end
|
||||
|
||||
append(style.global)
|
||||
|
||||
local dir_name = state.directory_label or state.directory
|
||||
if dir_name == "" then dir_name = "ROOT" end
|
||||
append(style.header)
|
||||
append(API.substitute_codes(o.format_string_header, nil, nil, nil, ass_escape))
|
||||
newline()
|
||||
|
||||
if #state.list < 1 then
|
||||
append(state.empty_text)
|
||||
flush_buffer()
|
||||
draw()
|
||||
return
|
||||
end
|
||||
|
||||
local start = 1
|
||||
local finish = start+o.num_entries-1
|
||||
|
||||
--handling cursor positioning
|
||||
local mid = math.ceil(o.num_entries/2)+1
|
||||
if state.selected+mid > finish then
|
||||
local offset = state.selected - finish + mid
|
||||
|
||||
--if we've overshot the end of the list then undo some of the offset
|
||||
if finish + offset > #state.list then
|
||||
offset = offset - ((finish+offset) - #state.list)
|
||||
end
|
||||
|
||||
start = start + offset
|
||||
finish = finish + offset
|
||||
end
|
||||
|
||||
--making sure that we don't overstep the boundaries
|
||||
if start < 1 then start = 1 end
|
||||
local overflow = finish < #state.list
|
||||
--this is necessary when the number of items in the dir is less than the max
|
||||
if not overflow then finish = #state.list end
|
||||
|
||||
-- these are the number values to place into the wrappers
|
||||
local wrapper_overrides = {['<'] = tostring(start-1), ['>'] = tostring(#state.list-finish)}
|
||||
|
||||
--adding a header to show there are items above in the list
|
||||
if o.format_string_topwrapper ~= '' and start > 1 then
|
||||
append(style.footer_header, API.substitute_codes(o.format_string_topwrapper, wrapper_overrides, nil, nil, ass_escape))
|
||||
newline()
|
||||
end
|
||||
|
||||
for i=start, finish do
|
||||
local v = state.list[i]
|
||||
local playing_file = highlight_entry(v)
|
||||
append(style.body)
|
||||
|
||||
--handles custom styles for different entries
|
||||
if i == state.selected or i == state.multiselect_start then
|
||||
if not (i == state.selected) then append(style.selection_marker) end
|
||||
|
||||
if not state.multiselect_start then append(style.cursor)
|
||||
else
|
||||
if state.selection[state.multiselect_start] then append(style.cursor_select)
|
||||
else append(style.cursor_deselect) end
|
||||
end
|
||||
append(o.cursor_icon, "\\h", style.body)
|
||||
else
|
||||
append(g.style.indent, o.cursor_icon, "\\h", style.body)
|
||||
end
|
||||
|
||||
--sets the selection colour scheme
|
||||
local multiselected = state.selection[i]
|
||||
|
||||
--sets the colour for the item
|
||||
local function set_colour()
|
||||
if multiselected then append(style.multiselect)
|
||||
elseif i == state.selected then append(style.selected) end
|
||||
|
||||
if playing_file then append( multiselected and style.playing_selected or style.playing) end
|
||||
end
|
||||
set_colour()
|
||||
|
||||
--sets the folder icon
|
||||
if v.type == 'dir' then
|
||||
append(style.folder, o.folder_icon, "\\h", style.body)
|
||||
set_colour()
|
||||
end
|
||||
|
||||
--adds the actual name of the item
|
||||
append(v.ass or ass_escape(v.label or v.name))
|
||||
newline()
|
||||
end
|
||||
|
||||
if o.format_string_bottomwrapper ~= '' and overflow then
|
||||
append(style.footer_header)
|
||||
append(API.substitute_codes(o.format_string_bottomwrapper, wrapper_overrides, nil, nil, ass_escape))
|
||||
end
|
||||
|
||||
flush_buffer()
|
||||
draw()
|
||||
end
|
||||
|
||||
return {
|
||||
update_ass = update_ass,
|
||||
highlight_entry = highlight_entry,
|
||||
draw = draw,
|
||||
remove = remove,
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
--------------------------------------Cache Implementation----------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
local g = require 'modules.globals'
|
||||
|
||||
--metatable of methods to manage the cache
|
||||
local __cache = {}
|
||||
|
||||
__cache.cached_values = {
|
||||
"directory", "directory_label", "list", "selected", "selection", "parser", "empty_text", "co"
|
||||
}
|
||||
|
||||
--inserts latest state values onto the cache stack
|
||||
function __cache:push()
|
||||
local t = {}
|
||||
for _, value in ipairs(self.cached_values) do
|
||||
t[value] = g.state[value]
|
||||
end
|
||||
table.insert(self, t)
|
||||
end
|
||||
|
||||
function __cache:pop()
|
||||
table.remove(self)
|
||||
end
|
||||
|
||||
function __cache:apply()
|
||||
local t = self[#self]
|
||||
for _, value in ipairs(self.cached_values) do
|
||||
g.state[value] = t[value]
|
||||
end
|
||||
end
|
||||
|
||||
function __cache:clear()
|
||||
for i = 1, #self do
|
||||
self[i] = nil
|
||||
end
|
||||
end
|
||||
|
||||
local cache = setmetatable({}, { __index = __cache })
|
||||
|
||||
return cache
|
||||
@@ -0,0 +1,87 @@
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local movement = require 'modules.navigation.directory-movement'
|
||||
local ass = require 'modules.ass'
|
||||
local cursor = require 'modules.navigation.cursor'
|
||||
|
||||
local controls = {}
|
||||
|
||||
--opens the browser
|
||||
function controls.open()
|
||||
if not g.state.hidden then return end
|
||||
|
||||
for _,v in ipairs(g.state.keybinds) do
|
||||
mp.add_forced_key_binding(v[1], 'dynamic/'..v[2], v[3], v[4])
|
||||
end
|
||||
|
||||
if o.set_shared_script_properties then utils.shared_script_property_set('file_browser-open', 'yes') end
|
||||
if o.set_user_data then mp.set_property_bool('user-data/file_browser/open', true) end
|
||||
|
||||
if o.toggle_idlescreen then mp.commandv('script-message', 'osc-idlescreen', 'no', 'no_osd') end
|
||||
g.state.hidden = false
|
||||
if g.state.directory == nil then
|
||||
local path = mp.get_property('path')
|
||||
if path or o.default_to_working_directory then movement.goto_current_dir() else movement.goto_root() end
|
||||
return
|
||||
end
|
||||
|
||||
if not g.state.flag_update then ass.draw()
|
||||
else g.state.flag_update = false ; ass.update_ass() end
|
||||
end
|
||||
|
||||
--closes the list and sets the hidden flag
|
||||
function controls.close()
|
||||
if g.state.hidden then return end
|
||||
|
||||
for _,v in ipairs(g.state.keybinds) do
|
||||
mp.remove_key_binding('dynamic/'..v[2])
|
||||
end
|
||||
|
||||
if o.set_shared_script_properties then utils.shared_script_property_set("file_browser-open", "no") end
|
||||
if o.set_user_data then mp.set_property_bool('user-data/file_browser/open', false) end
|
||||
|
||||
if o.toggle_idlescreen then mp.commandv('script-message', 'osc-idlescreen', 'yes', 'no_osd') end
|
||||
g.state.hidden = true
|
||||
ass.remove()
|
||||
end
|
||||
|
||||
--toggles the list
|
||||
function controls.toggle()
|
||||
if g.state.hidden then controls.open()
|
||||
else controls.close() end
|
||||
end
|
||||
|
||||
--run when the escape key is used
|
||||
function controls.escape()
|
||||
--if multiple items are selection cancel the
|
||||
--selection instead of closing the browser
|
||||
if next(g.state.selection) or g.state.multiselect_start then
|
||||
g.state.selection = {}
|
||||
cursor.disable_select_mode()
|
||||
ass.update_ass()
|
||||
return
|
||||
end
|
||||
controls.close()
|
||||
end
|
||||
|
||||
--opens a specific directory
|
||||
function controls.browse_directory(directory)
|
||||
if not directory then return end
|
||||
directory = mp.command_native({"expand-path", directory}) or ''
|
||||
-- directory = join_path( mp.get_property("working-directory", ""), directory )
|
||||
|
||||
if directory ~= "" then directory = API.fix_path(directory, true) end
|
||||
msg.verbose('recieved directory from script message: '..directory)
|
||||
|
||||
if directory == "dvd://" then directory = g.dvd_device end
|
||||
movement.goto_directory(directory)
|
||||
controls.open()
|
||||
end
|
||||
|
||||
return controls
|
||||
@@ -0,0 +1,104 @@
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
------------------------------------------Variable Setup------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
local mp = require 'mp'
|
||||
|
||||
local globals = {}
|
||||
local o = require 'modules.options'
|
||||
|
||||
--sets the version for the file-browser API
|
||||
globals.API_VERSION = "1.4.0"
|
||||
|
||||
--the osd_overlay API was not added until v0.31. The expand-path command was not added until 0.30
|
||||
assert(mp.create_osd_overlay, "Script requires minimum mpv version 0.33")
|
||||
|
||||
globals.ass = mp.create_osd_overlay("ass-events")
|
||||
globals.ass.res_y = 720 / o.scaling_factor_base
|
||||
|
||||
local BASE_FONT_SIZE = 25
|
||||
|
||||
globals.style = {
|
||||
global = o.alignment == 0 and "" or ([[{\an%d}]]):format(o.alignment),
|
||||
|
||||
-- full line styles
|
||||
header = ([[{\r\q2\b%s\fs%d\fn%s\c&H%s&}]]):format((o.font_bold_header and "1" or "0"), o.scaling_factor_header*BASE_FONT_SIZE, o.font_name_header, o.font_colour_header),
|
||||
body = ([[{\r\q2\fs%d\fn%s\c&H%s&}]]):format(BASE_FONT_SIZE, o.font_name_body, o.font_colour_body),
|
||||
footer_header = ([[{\r\q2\fs%d\fn%s\c&H%s&}]]):format(o.scaling_factor_wrappers*BASE_FONT_SIZE, o.font_name_wrappers, o.font_colour_wrappers),
|
||||
|
||||
--small section styles (for colours)
|
||||
multiselect = ([[{\c&H%s&}]]):format(o.font_colour_multiselect),
|
||||
selected = ([[{\c&H%s&}]]):format(o.font_colour_selected),
|
||||
playing = ([[{\c&H%s&}]]):format(o.font_colour_playing),
|
||||
playing_selected = ([[{\c&H%s&}]]):format(o.font_colour_playing_multiselected),
|
||||
|
||||
--icon styles
|
||||
indent = ([[{\alpha&H%s}]]):format('ff'),
|
||||
cursor = ([[{\fn%s\c&H%s&}]]):format(o.font_name_cursor, o.font_colour_cursor),
|
||||
cursor_select = ([[{\fn%s\c&H%s&}]]):format(o.font_name_cursor, o.font_colour_multiselect),
|
||||
cursor_deselect = ([[{\fn%s\c&H%s&}]]):format(o.font_name_cursor, o.font_colour_selected),
|
||||
folder = ([[{\fn%s}]]):format(o.font_name_folder),
|
||||
selection_marker = ([[{\alpha&H%s}]]):format(o.font_opacity_selection_marker),
|
||||
}
|
||||
|
||||
globals.state = {
|
||||
list = {},
|
||||
selected = 1,
|
||||
hidden = true,
|
||||
flag_update = false,
|
||||
keybinds = nil,
|
||||
|
||||
parser = nil,
|
||||
directory = nil,
|
||||
directory_label = nil,
|
||||
prev_directory = "",
|
||||
co = nil,
|
||||
|
||||
multiselect_start = nil,
|
||||
initial_selection = nil,
|
||||
selection = {}
|
||||
}
|
||||
|
||||
--the parser table actually contains 3 entries for each parser
|
||||
--a numeric entry which represents the priority of the parsers and has the parser object as the value
|
||||
--a string entry representing the id of each parser and with the parser object as the value
|
||||
--and a table entry with the parser itself as the key and a table value in the form { id = %s, index = %d }
|
||||
globals.parsers = {}
|
||||
|
||||
--this table contains the parse_state tables for every parse operation indexed with the coroutine used for the parse
|
||||
--this table has weakly referenced keys, meaning that once the coroutine for a parse is no-longer used by anything that
|
||||
--field in the table will be removed by the garbage collector
|
||||
globals.parse_states = setmetatable({}, { __mode = "k"})
|
||||
|
||||
globals.extensions = {}
|
||||
globals.sub_extensions = {}
|
||||
globals.audio_extensions = {}
|
||||
globals.parseable_extensions = {}
|
||||
|
||||
globals.dvd_device = nil
|
||||
globals.current_file = {
|
||||
directory = nil,
|
||||
name = nil,
|
||||
path = nil
|
||||
}
|
||||
|
||||
globals.root = {}
|
||||
|
||||
--default list of compatible file extensions
|
||||
--adding an item to this list is a valid request on github
|
||||
globals.compatible_file_extensions = {
|
||||
"264","265","3g2","3ga","3ga2","3gp","3gp2","3gpp","3iv","a52","aac","adt","adts","ahn","aif","aifc","aiff","amr","ape","asf","au","avc","avi","awb","ay",
|
||||
"bmp","cue","divx","dts","dtshd","dts-hd","dv","dvr","dvr-ms","eac3","evo","evob","f4a","flac","flc","fli","flic","flv","gbs","gif","gxf","gym",
|
||||
"h264","h265","hdmov","hdv","hes","hevc","jpeg","jpg","kss","lpcm","m1a","m1v","m2a","m2t","m2ts","m2v","m3u","m3u8","m4a","m4v","mk3d","mka","mkv",
|
||||
"mlp","mod","mov","mp1","mp2","mp2v","mp3","mp4","mp4v","mp4v","mpa","mpe","mpeg","mpeg2","mpeg4","mpg","mpg4","mpv","mpv2","mts","mtv","mxf","nsf",
|
||||
"nsfe","nsv","nut","oga","ogg","ogm","ogv","ogx","opus","pcm","pls","png","qt","ra","ram","rm","rmvb","sap","snd","spc","spx","svg","thd","thd+ac3",
|
||||
"tif","tiff","tod","trp","truehd","true-hd","ts","tsa","tsv","tta","tts","vfw","vgm","vgz","vob","vro","wav","weba","webm","webp","wm","wma","wmv","wtv",
|
||||
"wv","x264","x265","xvid","y4m","yuv"
|
||||
}
|
||||
|
||||
globals.ABORT_ERROR = {
|
||||
msg = "browser is no longer waiting for list - aborting parse"
|
||||
}
|
||||
|
||||
return globals
|
||||
@@ -0,0 +1,301 @@
|
||||
------------------------------------------------------------------------------------------
|
||||
----------------------------------Keybind Implementation----------------------------------
|
||||
------------------------------------------------------------------------------------------
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local playlist = require 'modules.playlist'
|
||||
local controls = require 'modules.controls'
|
||||
local movement = require 'modules.navigation.directory-movement'
|
||||
local scanning = require 'modules.navigation.scanning'
|
||||
local cursor = require 'modules.navigation.cursor'
|
||||
local cache = require 'modules.cache'
|
||||
|
||||
g.state.keybinds = {
|
||||
{'ENTER', 'play', function() playlist.add_files('replace', false) end},
|
||||
{'Shift+ENTER', 'play_append', function() playlist.add_files('append-play', false) end},
|
||||
{'Alt+ENTER', 'play_autoload',function() playlist.add_files('replace', true) end},
|
||||
{'ESC', 'close', controls.escape},
|
||||
{'RIGHT', 'down_dir', movement.down_dir},
|
||||
{'LEFT', 'up_dir', movement.up_dir},
|
||||
{'DOWN', 'scroll_down', function() cursor.scroll(1, o.wrap) end, {repeatable = true}},
|
||||
{'UP', 'scroll_up', function() cursor.scroll(-1, o.wrap) end, {repeatable = true}},
|
||||
{'PGDWN', 'page_down', function() cursor.scroll(o.num_entries) end, {repeatable = true}},
|
||||
{'PGUP', 'page_up', function() cursor.scroll(-o.num_entries) end, {repeatable = true}},
|
||||
{'Shift+PGDWN', 'list_bottom', function() cursor.scroll(math.huge) end},
|
||||
{'Shift+PGUP', 'list_top', function() cursor.scroll(-math.huge) end},
|
||||
{'HOME', 'goto_current', movement.goto_current_dir},
|
||||
{'Shift+HOME', 'goto_root', movement.goto_root},
|
||||
{'Ctrl+r', 'reload', function() cache:clear(); scanning.rescan() end},
|
||||
{'s', 'select_mode', cursor.toggle_select_mode},
|
||||
{'S', 'select_item', cursor.toggle_selection},
|
||||
{'Ctrl+a', 'select_all', cursor.select_all}
|
||||
}
|
||||
|
||||
--a map of key-keybinds - only saves the latest keybind if multiple have the same key code
|
||||
local top_level_keys = {}
|
||||
|
||||
--format the item string for either single or multiple items
|
||||
local function create_item_string(base_code_fn, items, state, cmd, quoted)
|
||||
if not items[1] then return end
|
||||
local func = quoted and function(...) return ("%q"):format(base_code_fn(...)) end or base_code_fn
|
||||
|
||||
local out = {}
|
||||
for _, item in ipairs(items) do
|
||||
table.insert(out, func(item, state))
|
||||
end
|
||||
|
||||
return table.concat(out, cmd['concat-string'] or ' ')
|
||||
end
|
||||
|
||||
local KEYBIND_CODE_PATTERN = API.get_code_pattern(API.code_fns)
|
||||
local item_specific_codes = 'fnij'
|
||||
|
||||
--substitutes the key codes for the
|
||||
local function substitute_codes(str, cmd, items, state)
|
||||
local overrides = {}
|
||||
|
||||
for code in item_specific_codes:gmatch('.') do
|
||||
overrides[code] = function(_,s) return create_item_string(API.code_fns[code], items, s, cmd) end
|
||||
overrides[code:upper()] = function(_,s) return create_item_string(API.code_fns[code], items, s, cmd, true) end
|
||||
end
|
||||
|
||||
return API.substitute_codes(str, overrides, items[1], state)
|
||||
end
|
||||
|
||||
--iterates through the command table and substitutes special
|
||||
--character codes for the correct strings used for custom functions
|
||||
local function format_command_table(cmd, items, state)
|
||||
local copy = {}
|
||||
for i = 1, #cmd.command do
|
||||
copy[i] = {}
|
||||
|
||||
for j = 1, #cmd.command[i] do
|
||||
copy[i][j] = substitute_codes(cmd.command[i][j], cmd, items, state)
|
||||
end
|
||||
end
|
||||
return copy
|
||||
end
|
||||
|
||||
--runs all of the commands in the command table
|
||||
--key.command must be an array of command tables compatible with mp.command_native
|
||||
--items must be an array of multiple items (when multi-type ~= concat the array will be 1 long)
|
||||
local function run_custom_command(cmd, items, state)
|
||||
local custom_cmds = cmd.codes and format_command_table(cmd, items, state) or cmd.command
|
||||
|
||||
for _, custom_cmd in ipairs(custom_cmds) do
|
||||
msg.debug("running command:", utils.to_string(custom_cmd))
|
||||
mp.command_native(custom_cmd)
|
||||
end
|
||||
end
|
||||
|
||||
--returns true if the given code set has item specific codes (%f, %i, etc)
|
||||
local function has_item_codes(codes)
|
||||
for code in pairs(codes) do
|
||||
if item_specific_codes:find(code:lower(), 1, true) then return true end
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
--runs one of the custom commands
|
||||
local function run_custom_keybind(cmd, state, co)
|
||||
--evaluates a condition and passes through the correct values
|
||||
local function evaluate_condition(condition, items)
|
||||
local cond = substitute_codes(condition, cmd, items, state)
|
||||
return API.evaluate_string('return '..cond) == true
|
||||
end
|
||||
|
||||
-- evaluates the string condition to decide if the keybind should be run
|
||||
local do_item_condition
|
||||
if cmd.condition then
|
||||
if has_item_codes(cmd.condition_codes) then
|
||||
do_item_condition = true
|
||||
elseif not evaluate_condition(cmd.condition, {}) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
|
||||
if cmd.parser then
|
||||
local parser_str = ' '..cmd.parser..' '
|
||||
if not parser_str:find( '%W'..(state.parser.keybind_name or state.parser.name)..'%W' ) then return false end
|
||||
end
|
||||
|
||||
--these are for the default keybinds, or from addons which use direct functions
|
||||
if type(cmd.command) == 'function' then return cmd.command(cmd, cmd.addon and API.copy_table(state) or state, co) end
|
||||
|
||||
--the function terminates here if we are running the command on a single item
|
||||
if not (cmd.multiselect and next(state.selection)) then
|
||||
if cmd.filter then
|
||||
if not state.list[state.selected] then return false end
|
||||
if state.list[state.selected].type ~= cmd.filter then return false end
|
||||
end
|
||||
|
||||
if cmd.codes then
|
||||
--if the directory is empty, and this command needs to work on an item, then abort and fallback to the next command
|
||||
if not state.list[state.selected] and has_item_codes(cmd.codes) then return false end
|
||||
end
|
||||
|
||||
if do_item_condition and not evaluate_condition(cmd.condition, { state.list[state.selected] }) then
|
||||
return false
|
||||
end
|
||||
run_custom_command(cmd, { state.list[state.selected] }, state)
|
||||
return true
|
||||
end
|
||||
|
||||
--runs the command on all multi-selected items
|
||||
local selection = API.sort_keys(state.selection, function(item)
|
||||
if do_item_condition and not evaluate_condition(cmd.condition, { item }) then return false end
|
||||
return not cmd.filter or item.type == cmd.filter
|
||||
end)
|
||||
if not next(selection) then return false end
|
||||
|
||||
if cmd["multi-type"] == "concat" then
|
||||
run_custom_command(cmd, selection, state)
|
||||
|
||||
elseif cmd["multi-type"] == "repeat" or cmd["multi-type"] == nil then
|
||||
for i,_ in ipairs(selection) do
|
||||
run_custom_command(cmd, {selection[i]}, state)
|
||||
|
||||
if cmd.delay then
|
||||
mp.add_timeout(cmd.delay, function() API.coroutine.resume_err(co) end)
|
||||
coroutine.yield()
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--we passthrough by default if the command is not run on every selected item
|
||||
if cmd.passthrough ~= nil then return end
|
||||
|
||||
local num_selection = 0
|
||||
for _ in pairs(state.selection) do num_selection = num_selection+1 end
|
||||
return #selection == num_selection
|
||||
end
|
||||
|
||||
--recursively runs the keybind functions, passing down through the chain
|
||||
--of keybinds with the same key value
|
||||
local function run_keybind_recursive(keybind, state, co)
|
||||
msg.trace("Attempting custom command:", utils.to_string(keybind))
|
||||
|
||||
if keybind.passthrough ~= nil then
|
||||
run_custom_keybind(keybind, state, co)
|
||||
if keybind.passthrough == true and keybind.prev_key then
|
||||
run_keybind_recursive(keybind.prev_key, state, co)
|
||||
end
|
||||
else
|
||||
if run_custom_keybind(keybind, state, co) == false and keybind.prev_key then
|
||||
run_keybind_recursive(keybind.prev_key, state, co)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--a wrapper to run a custom keybind as a lua coroutine
|
||||
local function run_keybind_coroutine(key)
|
||||
msg.debug("Received custom keybind "..key.key)
|
||||
local co = coroutine.create(run_keybind_recursive)
|
||||
|
||||
local state_copy = {
|
||||
directory = g.state.directory,
|
||||
directory_label = g.state.directory_label,
|
||||
list = g.state.list, --the list should remain unchanged once it has been saved to the global state, new directories get new tables
|
||||
selected = g.state.selected,
|
||||
selection = API.copy_table(g.state.selection),
|
||||
parser = g.state.parser,
|
||||
}
|
||||
local success, err = coroutine.resume(co, key, state_copy, co)
|
||||
if not success then
|
||||
msg.error("error running keybind:", utils.to_string(key))
|
||||
API.traceback(err, co)
|
||||
end
|
||||
end
|
||||
|
||||
--scans the given command table to identify if they contain any custom keybind codes
|
||||
local function scan_for_codes(command_table, codes)
|
||||
if type(command_table) ~= "table" then return codes end
|
||||
for _, value in pairs(command_table) do
|
||||
local type = type(value)
|
||||
if type == "table" then
|
||||
scan_for_codes(value, codes)
|
||||
elseif type == "string" then
|
||||
value:gsub(KEYBIND_CODE_PATTERN, function(code) codes[code] = true end)
|
||||
end
|
||||
end
|
||||
return codes
|
||||
end
|
||||
|
||||
--inserting the custom keybind into the keybind array for declaration when file-browser is opened
|
||||
--custom keybinds with matching names will overwrite eachother
|
||||
local function insert_custom_keybind(keybind)
|
||||
--we'll always save the keybinds as either an array of command arrays or a function
|
||||
if type(keybind.command) == "table" and type(keybind.command[1]) ~= "table" then
|
||||
keybind.command = {keybind.command}
|
||||
end
|
||||
|
||||
keybind.codes = scan_for_codes(keybind.command, {})
|
||||
if not next(keybind.codes) then keybind.codes = nil end
|
||||
keybind.prev_key = top_level_keys[keybind.key]
|
||||
|
||||
if keybind.condition then
|
||||
keybind.condition_codes = {}
|
||||
for code in string.gmatch(keybind.condition, KEYBIND_CODE_PATTERN) do keybind.condition_codes[code] = true end
|
||||
end
|
||||
|
||||
table.insert(g.state.keybinds, {keybind.key, keybind.name, function() run_keybind_coroutine(keybind) end, keybind.flags or {}})
|
||||
top_level_keys[keybind.key] = keybind
|
||||
end
|
||||
|
||||
--loading the custom keybinds
|
||||
--can either load keybinds from the config file, from addons, or from both
|
||||
local function setup_keybinds()
|
||||
if not o.custom_keybinds and not o.addons then return end
|
||||
|
||||
--this is to make the default keybinds compatible with passthrough from custom keybinds
|
||||
for _, keybind in ipairs(g.state.keybinds) do
|
||||
top_level_keys[keybind[1]] = { key = keybind[1], name = keybind[2], command = keybind[3], flags = keybind[4] }
|
||||
end
|
||||
|
||||
--this loads keybinds from addons
|
||||
if o.addons then
|
||||
for i = #g.parsers, 1, -1 do
|
||||
local parser = g.parsers[i]
|
||||
if parser.keybinds then
|
||||
for i, keybind in ipairs(parser.keybinds) do
|
||||
--if addons use the native array command format, then we need to convert them over to the custom command format
|
||||
if not keybind.key then keybind = { key = keybind[1], name = keybind[2], command = keybind[3], flags = keybind[4] }
|
||||
else keybind = API.copy_table(keybind) end
|
||||
|
||||
keybind.name = g.parsers[parser].id.."/"..(keybind.name or tostring(i))
|
||||
keybind.addon = true
|
||||
insert_custom_keybind(keybind)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--loads custom keybinds from file-browser-keybinds.json
|
||||
if o.custom_keybinds then
|
||||
local path = mp.command_native({"expand-path", "~~/script-opts"}).."/file-browser-keybinds.json"
|
||||
local custom_keybinds, err = io.open( path )
|
||||
if not custom_keybinds then return error(err) end
|
||||
|
||||
local json = custom_keybinds:read("*a")
|
||||
custom_keybinds:close()
|
||||
|
||||
json = utils.parse_json(json)
|
||||
if not json then return error("invalid json syntax for "..path) end
|
||||
|
||||
for i, keybind in ipairs(json) do
|
||||
keybind.name = "custom/"..(keybind.name or tostring(i))
|
||||
insert_custom_keybind(keybind)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
setup_keybinds = setup_keybinds,
|
||||
}
|
||||
@@ -0,0 +1,121 @@
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
--------------------------------Scroll/Select Implementation--------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local ass = require 'modules.ass'
|
||||
|
||||
local cursor = {}
|
||||
|
||||
--disables multiselect
|
||||
function cursor.disable_select_mode()
|
||||
g.state.multiselect_start = nil
|
||||
g.state.initial_selection = nil
|
||||
end
|
||||
|
||||
--enables multiselect
|
||||
function cursor.enable_select_mode()
|
||||
g.state.multiselect_start = g.state.selected
|
||||
g.state.initial_selection = API.copy_table(g.state.selection)
|
||||
end
|
||||
|
||||
--calculates what drag behaviour is required for that specific movement
|
||||
local function drag_select(original_pos, new_pos)
|
||||
if original_pos == new_pos then return end
|
||||
|
||||
local setting = g.state.selection[g.state.multiselect_start]
|
||||
for i = original_pos, new_pos, (new_pos > original_pos and 1 or -1) do
|
||||
--if we're moving the cursor away from the starting point then set the selection
|
||||
--otherwise restore the original selection
|
||||
if i > g.state.multiselect_start then
|
||||
if new_pos > original_pos then
|
||||
g.state.selection[i] = setting
|
||||
elseif i ~= new_pos then
|
||||
g.state.selection[i] = g.state.initial_selection[i]
|
||||
end
|
||||
elseif i < g.state.multiselect_start then
|
||||
if new_pos < original_pos then
|
||||
g.state.selection[i] = setting
|
||||
elseif i ~= new_pos then
|
||||
g.state.selection[i] = g.state.initial_selection[i]
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--moves the selector up and down the list by the entered amount
|
||||
function cursor.scroll(n, wrap)
|
||||
local num_items = #g.state.list
|
||||
if num_items == 0 then return end
|
||||
|
||||
local original_pos = g.state.selected
|
||||
|
||||
if original_pos + n > num_items then
|
||||
g.state.selected = wrap and 1 or num_items
|
||||
elseif original_pos + n < 1 then
|
||||
g.state.selected = wrap and num_items or 1
|
||||
else
|
||||
g.state.selected = original_pos + n
|
||||
end
|
||||
|
||||
if g.state.multiselect_start then drag_select(original_pos, g.state.selected) end
|
||||
ass.update_ass()
|
||||
end
|
||||
|
||||
--selects the first item in the list which is highlighted as playing
|
||||
function cursor.select_playing_item()
|
||||
for i,item in ipairs(g.state.list) do
|
||||
if ass.highlight_entry(item) then
|
||||
g.state.selected = i
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--scans the list for which item to select by default
|
||||
--chooses the folder that the script just moved out of
|
||||
--or, otherwise, the item highlighted as currently playing
|
||||
function cursor.select_prev_directory()
|
||||
if g.state.prev_directory:find(g.state.directory, 1, true) == 1 then
|
||||
local i = 1
|
||||
while (g.state.list[i] and API.parseable_item(g.state.list[i])) do
|
||||
if g.state.prev_directory:find(API.get_full_path(g.state.list[i]), 1, true) then
|
||||
g.state.selected = i
|
||||
return
|
||||
end
|
||||
i = i+1
|
||||
end
|
||||
end
|
||||
|
||||
cursor.select_playing_item()
|
||||
end
|
||||
|
||||
--toggles the selection
|
||||
function cursor.toggle_selection()
|
||||
if not g.state.list[g.state.selected] then return end
|
||||
g.state.selection[g.state.selected] = not g.state.selection[g.state.selected] or nil
|
||||
ass.update_ass()
|
||||
end
|
||||
|
||||
--select all items in the list
|
||||
function cursor.select_all()
|
||||
for i,_ in ipairs(g.state.list) do
|
||||
g.state.selection[i] = true
|
||||
end
|
||||
ass.update_ass()
|
||||
end
|
||||
|
||||
--toggles select mode
|
||||
function cursor.toggle_select_mode()
|
||||
if g.state.multiselect_start == nil then
|
||||
cursor.enable_select_mode()
|
||||
cursor.toggle_selection()
|
||||
else
|
||||
cursor.disable_select_mode()
|
||||
ass.update_ass()
|
||||
end
|
||||
end
|
||||
|
||||
return cursor
|
||||
@@ -0,0 +1,63 @@
|
||||
|
||||
local msg = require 'mp.msg'
|
||||
|
||||
local g = require 'modules.globals'
|
||||
local cache = require 'modules.cache'
|
||||
local scanning = require 'modules.navigation.scanning'
|
||||
local API = require 'modules.utils'
|
||||
|
||||
local directory_movement = {}
|
||||
|
||||
--the base function for moving to a directory
|
||||
function directory_movement.goto_directory(directory)
|
||||
g.state.directory = directory
|
||||
scanning.rescan(false)
|
||||
end
|
||||
|
||||
--loads the root list
|
||||
function directory_movement.goto_root()
|
||||
msg.verbose('jumping to root')
|
||||
directory_movement.goto_directory("")
|
||||
end
|
||||
|
||||
--switches to the directory of the currently playing file
|
||||
function directory_movement.goto_current_dir()
|
||||
msg.verbose('jumping to current directory')
|
||||
directory_movement.goto_directory(g.current_file.directory)
|
||||
end
|
||||
|
||||
--moves up a directory
|
||||
function directory_movement.up_dir()
|
||||
local dir = g.state.directory:reverse()
|
||||
local index = dir:find("[/\\]")
|
||||
|
||||
while index == 1 do
|
||||
dir = dir:sub(2)
|
||||
index = dir:find("[/\\]")
|
||||
end
|
||||
|
||||
if index == nil then g.state.directory = ""
|
||||
else g.state.directory = dir:sub(index):reverse() end
|
||||
|
||||
--we can make some assumptions about the next directory label when moving up or down
|
||||
if g.state.directory_label then g.state.directory_label = string.match(g.state.directory_label, "^(.+/)[^/]+/$") end
|
||||
|
||||
scanning.rescan(true)
|
||||
cache:pop()
|
||||
end
|
||||
|
||||
--moves down a directory
|
||||
function directory_movement.down_dir()
|
||||
local current = g.state.list[g.state.selected]
|
||||
if not current or not API.parseable_item(current) then return end
|
||||
|
||||
cache:push()
|
||||
local directory, redirected = API.get_new_directory(current, g.state.directory)
|
||||
g.state.directory = directory
|
||||
|
||||
--we can make some assumptions about the next directory label when moving up or down
|
||||
if g.state.directory_label then g.state.directory_label = g.state.directory_label..(current.label or current.name) end
|
||||
scanning.rescan(not redirected)
|
||||
end
|
||||
|
||||
return directory_movement
|
||||
@@ -0,0 +1,176 @@
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local root_parser = require 'modules.parsers.root'
|
||||
local cache = require 'modules.cache'
|
||||
local cursor = require 'modules.navigation.cursor'
|
||||
local ass = require 'modules.ass'
|
||||
|
||||
local parse_state_API = require 'modules.apis.parse-state'
|
||||
|
||||
--parses the given directory or defers to the next parser if nil is returned
|
||||
local function choose_and_parse(directory, index)
|
||||
msg.debug("finding parser for", directory)
|
||||
local parser, list, opts
|
||||
local parse_state = g.parse_states[coroutine.running() or ""]
|
||||
while list == nil and not parse_state.already_deferred and index <= #g.parsers do
|
||||
parser = g.parsers[index]
|
||||
if parser:can_parse(directory, parse_state) then
|
||||
msg.debug("attempting parser:", parser:get_id())
|
||||
list, opts = parser:parse(directory, parse_state)
|
||||
end
|
||||
index = index + 1
|
||||
end
|
||||
if not list then return nil, {} end
|
||||
|
||||
msg.debug("list returned from:", parser:get_id())
|
||||
opts = opts or {}
|
||||
if list then opts.id = opts.id or parser:get_id() end
|
||||
return list, opts
|
||||
end
|
||||
|
||||
--sets up the parse_state table and runs the parse operation
|
||||
local function run_parse(directory, parse_state)
|
||||
msg.verbose("scanning files in", directory)
|
||||
parse_state.directory = directory
|
||||
|
||||
local co = coroutine.running()
|
||||
g.parse_states[co] = setmetatable(parse_state, { __index = parse_state_API })
|
||||
|
||||
if directory == "" then return root_parser:parse() end
|
||||
local list, opts = choose_and_parse(directory, 1)
|
||||
|
||||
if list == nil then return msg.debug("no successful parsers found") end
|
||||
opts.parser = g.parsers[opts.id]
|
||||
|
||||
if not opts.filtered then API.filter(list) end
|
||||
if not opts.sorted then API.sort(list) end
|
||||
return list, opts
|
||||
end
|
||||
|
||||
--returns the contents of the given directory using the given parse state
|
||||
--if a coroutine has already been used for a parse then create a new coroutine so that
|
||||
--the every parse operation has a unique thread ID
|
||||
local function parse_directory(directory, parse_state)
|
||||
local co = API.coroutine.assert("scan_directory must be executed from within a coroutine - aborting scan "..utils.to_string(parse_state))
|
||||
if not g.parse_states[co] then return run_parse(directory, parse_state) end
|
||||
|
||||
--if this coroutine is already is use by another parse operation then we create a new
|
||||
--one and hand execution over to that
|
||||
local new_co = coroutine.create(function()
|
||||
API.coroutine.resume_err(co, run_parse(directory, parse_state))
|
||||
end)
|
||||
|
||||
--queue the new coroutine on the mpv event queue
|
||||
mp.add_timeout(0, function()
|
||||
local success, err = coroutine.resume(new_co)
|
||||
if not success then
|
||||
API.traceback(err, new_co)
|
||||
API.coroutine.resume_err(co)
|
||||
end
|
||||
end)
|
||||
return g.parse_states[co]:yield()
|
||||
end
|
||||
|
||||
--sends update requests to the different parsers
|
||||
local function update_list(moving_adjacent)
|
||||
msg.verbose('opening directory: ' .. g.state.directory)
|
||||
|
||||
g.state.selected = 1
|
||||
g.state.selection = {}
|
||||
|
||||
--loads the current directry from the cache to save loading time
|
||||
--there will be a way to forcibly reload the current directory at some point
|
||||
--the cache is in the form of a stack, items are taken off the stack when the dir moves up
|
||||
if cache[1] and cache[#cache].directory == g.state.directory then
|
||||
msg.verbose('found directory in cache')
|
||||
cache:apply()
|
||||
g.state.prev_directory = g.state.directory
|
||||
return
|
||||
end
|
||||
local directory = g.state.directory
|
||||
local list, opts = parse_directory(g.state.directory, { source = "browser" })
|
||||
|
||||
--if the running coroutine isn't the one stored in the state variable, then the user
|
||||
--changed directories while the coroutine was paused, and this operation should be aborted
|
||||
if coroutine.running() ~= g.state.co then
|
||||
msg.verbose(g.ABORT_ERROR.msg)
|
||||
msg.debug("expected:", g.state.directory, "received:", directory)
|
||||
return
|
||||
end
|
||||
|
||||
--apply fallbacks if the scan failed
|
||||
if not list and cache[1] then
|
||||
--switches settings back to the previously opened directory
|
||||
--to the user it will be like the directory never changed
|
||||
msg.warn("could not read directory", g.state.directory)
|
||||
cache:apply()
|
||||
return
|
||||
elseif not list then
|
||||
msg.warn("could not read directory", g.state.directory)
|
||||
list, opts = root_parser:parse()
|
||||
end
|
||||
|
||||
g.state.list = list
|
||||
g.state.parser = opts.parser
|
||||
|
||||
--this only matters when displaying the list on the screen, so it doesn't need to be in the scan function
|
||||
if not opts.escaped then
|
||||
for i = 1, #list do
|
||||
list[i].ass = list[i].ass or API.ass_escape(list[i].label or list[i].name, true)
|
||||
end
|
||||
end
|
||||
|
||||
--setting custom options from parsers
|
||||
g.state.directory_label = opts.directory_label
|
||||
g.state.empty_text = opts.empty_text or g.state.empty_text
|
||||
|
||||
--we assume that directory is only changed when redirecting to a different location
|
||||
--therefore, the cache should be wiped
|
||||
if opts.directory then
|
||||
g.state.directory = opts.directory
|
||||
cache:clear()
|
||||
end
|
||||
|
||||
if opts.selected_index then
|
||||
g.state.selected = opts.selected_index or g.state.selected
|
||||
if g.state.selected > #g.state.list then g.state.selected = #g.state.list
|
||||
elseif g.state.selected < 1 then g.state.selected = 1 end
|
||||
end
|
||||
|
||||
if moving_adjacent then cursor.select_prev_directory()
|
||||
else cursor.select_playing_item() end
|
||||
g.state.prev_directory = g.state.directory
|
||||
end
|
||||
|
||||
--rescans the folder and updates the list
|
||||
local function update(moving_adjacent)
|
||||
--we can only make assumptions about the directory label when moving from adjacent directories
|
||||
if not moving_adjacent then
|
||||
g.state.directory_label = nil
|
||||
cache:clear()
|
||||
end
|
||||
|
||||
g.state.empty_text = "~"
|
||||
g.state.list = {}
|
||||
cursor.disable_select_mode()
|
||||
ass.update_ass()
|
||||
|
||||
--the directory is always handled within a coroutine to allow addons to
|
||||
--pause execution for asynchronous operations
|
||||
API.coroutine.run(function()
|
||||
g.state.co = coroutine.running()
|
||||
update_list(moving_adjacent)
|
||||
g.state.empty_text = "empty directory"
|
||||
ass.update_ass()
|
||||
end)
|
||||
end
|
||||
|
||||
return {
|
||||
rescan = update,
|
||||
scan_directory = parse_directory,
|
||||
choose_and_parse = choose_and_parse,
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
|
||||
local mp = require 'mp'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local ass = require 'modules.ass'
|
||||
|
||||
local observers ={}
|
||||
|
||||
--saves the directory and name of the currently playing file
|
||||
function observers.current_directory(_, filepath)
|
||||
--if we're in idle mode then we want to open the working directory
|
||||
if filepath == nil then
|
||||
g.current_file.directory = API.fix_path( mp.get_property("working-directory", ""), true)
|
||||
g.current_file.name = nil
|
||||
g.current_file.path = nil
|
||||
return
|
||||
elseif filepath:find("dvd://") == 1 then
|
||||
filepath = g.dvd_device..filepath:match("dvd://(.*)")
|
||||
end
|
||||
|
||||
local workingDirectory = mp.get_property('working-directory', '')
|
||||
local exact_path = API.join_path(workingDirectory, filepath)
|
||||
exact_path = API.fix_path(exact_path, false)
|
||||
g.current_file.directory, g.current_file.name = utils.split_path(exact_path)
|
||||
g.current_file.path = exact_path
|
||||
|
||||
if not g.state.hidden then ass.update_ass()
|
||||
else g.state.flag_update = true end
|
||||
end
|
||||
|
||||
function observers.dvd_device(_, device)
|
||||
if not device or device == "" then device = "/dev/dvd/" end
|
||||
g.dvd_device = API.fix_path(device, true)
|
||||
end
|
||||
|
||||
return observers
|
||||
@@ -0,0 +1,129 @@
|
||||
local utils = require 'mp.utils'
|
||||
local opt = require 'mp.options'
|
||||
|
||||
local o = {
|
||||
--root directories
|
||||
root = "~/",
|
||||
|
||||
--characters to use as separators
|
||||
root_separators = ",;",
|
||||
|
||||
--number of entries to show on the screen at once
|
||||
num_entries = 20,
|
||||
|
||||
--wrap the cursor around the top and bottom of the list
|
||||
wrap = false,
|
||||
|
||||
--only show files compatible with mpv
|
||||
filter_files = true,
|
||||
|
||||
--experimental feature that recurses directories concurrently when
|
||||
--appending items to the playlist
|
||||
concurrent_recursion = false,
|
||||
|
||||
--maximum number of recursions that can run concurrently
|
||||
max_concurrency = 16,
|
||||
|
||||
--enable custom keybinds
|
||||
custom_keybinds = false,
|
||||
|
||||
--blacklist compatible files, it's recommended to use this rather than to edit the
|
||||
--compatible list directly. A semicolon separated list of extensions without spaces
|
||||
extension_blacklist = "",
|
||||
|
||||
--add extra file extensions
|
||||
extension_whitelist = "",
|
||||
|
||||
--files with these extensions will be added as additional audio tracks for the current file instead of appended to the playlist
|
||||
audio_extensions = "mka,dts,dtshd,dts-hd,truehd,true-hd",
|
||||
|
||||
--files with these extensions will be added as additional subtitle tracks instead of appended to the playlist
|
||||
subtitle_extensions = "etf,etf8,utf-8,idx,sub,srt,rt,ssa,ass,mks,vtt,sup,scc,smi,lrc,pgs",
|
||||
|
||||
--filter dot directories like .config
|
||||
--most useful on linux systems
|
||||
filter_dot_dirs = false,
|
||||
filter_dot_files = false,
|
||||
|
||||
--substitude forward slashes for backslashes when appending a local file to the playlist
|
||||
--potentially useful on windows systems
|
||||
substitute_backslash = false,
|
||||
|
||||
--this option reverses the behaviour of the alt+ENTER keybind
|
||||
--when disabled the keybind is required to enable autoload for the file
|
||||
--when enabled the keybind disables autoload for the file
|
||||
autoload = false,
|
||||
|
||||
--if autoload is triggered by selecting the currently playing file, then
|
||||
--the current file will have it's watch-later config saved before being closed
|
||||
--essentially the current file will not be restarted
|
||||
autoload_save_current = true,
|
||||
|
||||
--when opening the browser in idle mode prefer the current working directory over the root
|
||||
--note that the working directory is set as the 'current' directory regardless, so `home` will
|
||||
--move the browser there even if this option is set to false
|
||||
default_to_working_directory = false,
|
||||
|
||||
--allows custom icons be set for the folder and cursor
|
||||
--the `\h` character is a hard space to add padding between the symbol and the text
|
||||
folder_icon = [[{\p1}m 6.52 0 l 1.63 0 b 0.73 0 0.01 0.73 0.01 1.63 l 0 11.41 b 0 12.32 0.73 13.05 1.63 13.05 l 14.68 13.05 b 15.58 13.05 16.31 12.32 16.31 11.41 l 16.31 3.26 b 16.31 2.36 15.58 1.63 14.68 1.63 l 8.15 1.63{\p0}\h]],
|
||||
cursor_icon = [[{\p1}m 14.11 6.86 l 0.34 0.02 b 0.25 -0.02 0.13 -0 0.06 0.08 b -0.01 0.16 -0.02 0.28 0.04 0.36 l 3.38 5.55 l 3.38 5.55 3.67 6.15 3.81 6.79 3.79 7.45 3.61 8.08 3.39 8.5l 0.04 13.77 b -0.02 13.86 -0.01 13.98 0.06 14.06 b 0.11 14.11 0.17 14.13 0.24 14.13 b 0.27 14.13 0.31 14.13 0.34 14.11 l 14.11 7.28 b 14.2 7.24 14.25 7.16 14.25 7.07 b 14.25 6.98 14.2 6.9 14.11 6.86{\p0}\h]],
|
||||
|
||||
--enable addons
|
||||
addons = false,
|
||||
addon_directory = "~~/script-modules/file-browser-addons",
|
||||
|
||||
--directory to load external modules - currently just user-input-module
|
||||
module_directory = "~~/script-modules",
|
||||
|
||||
--turn the OSC idle screen off and on when opening and closing the browser
|
||||
toggle_idlescreen = false,
|
||||
|
||||
--Set the current open status of the browser in the `file_browser/open` field of the `user-data` property.
|
||||
--This property is only available in mpv v0.36+.
|
||||
set_user_data = true,
|
||||
|
||||
--Set the current open status of the browser in the `file_browser-open` field of the `shared-script-properties` property.
|
||||
--This property is deprecated. When it is removed in mpv v0.37 file-browser will automatically ignore this option.
|
||||
set_shared_script_properties = true,
|
||||
|
||||
--force file-browser to use a specific text alignment (default: top-left)
|
||||
--uses ass tag alignment numbers: https://aegi.vmoe.info/docs/3.0/ASS_Tags/#index23h3
|
||||
--set to 0 to use the default mpv osd-align options
|
||||
alignment = 7,
|
||||
|
||||
--style settings
|
||||
format_string_header = '%q\\N----------------------------------------------------',
|
||||
format_string_topwrapper = '%< item(s) above\\N',
|
||||
format_string_bottomwrapper = '\\N%> item(s) remaining',
|
||||
|
||||
font_bold_header = true,
|
||||
font_opacity_selection_marker = "99",
|
||||
|
||||
scaling_factor_base = 1,
|
||||
scaling_factor_header = 1.4,
|
||||
scaling_factor_wrappers = 0.64,
|
||||
|
||||
font_name_header = "",
|
||||
font_name_body = "",
|
||||
font_name_wrappers = "",
|
||||
font_name_folder = "",
|
||||
font_name_cursor = "",
|
||||
|
||||
font_colour_header = "00ccff",
|
||||
font_colour_body = "ffffff",
|
||||
font_colour_wrappers = "00ccff",
|
||||
font_colour_cursor = "00ccff",
|
||||
|
||||
font_colour_multiselect = "fcad88",
|
||||
font_colour_selected = "fce788",
|
||||
font_colour_playing = "33ff66",
|
||||
font_colour_playing_multiselected = "22b547"
|
||||
|
||||
}
|
||||
|
||||
opt.read_options(o, 'file_browser')
|
||||
|
||||
o.set_shared_script_properties = o.set_shared_script_properties and utils.shared_script_property_set
|
||||
|
||||
return o
|
||||
@@ -0,0 +1,47 @@
|
||||
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local API = require 'modules.utils'
|
||||
|
||||
--parser ofject for native filesystems
|
||||
local file_parser = {
|
||||
name = "file",
|
||||
priority = 110,
|
||||
|
||||
--as the default parser we'll always attempt to use it if all others fail
|
||||
can_parse = function(_, directory) return true end,
|
||||
|
||||
--scans the given directory using the mp.utils.readdir function
|
||||
parse = function(self, directory)
|
||||
local new_list = {}
|
||||
local list1 = utils.readdir(directory, 'dirs')
|
||||
if list1 == nil then return nil end
|
||||
|
||||
--sorts folders and formats them into the list of directories
|
||||
for i=1, #list1 do
|
||||
local item = list1[i]
|
||||
|
||||
--filters hidden dot directories for linux
|
||||
if self.valid_dir(item) then
|
||||
msg.trace(item..'/')
|
||||
table.insert(new_list, {name = item..'/', type = 'dir'})
|
||||
end
|
||||
end
|
||||
|
||||
--appends files to the list of directory items
|
||||
local list2 = utils.readdir(directory, 'files')
|
||||
for i=1, #list2 do
|
||||
local item = list2[i]
|
||||
|
||||
--only adds whitelisted files to the browser
|
||||
if self.valid_file(item) then
|
||||
msg.trace(item)
|
||||
table.insert(new_list, {name = item, type = 'file'})
|
||||
end
|
||||
end
|
||||
return API.sort(new_list), {filtered = true, sorted = true}
|
||||
end
|
||||
}
|
||||
|
||||
return file_parser
|
||||
@@ -0,0 +1,26 @@
|
||||
|
||||
local g = require 'modules.globals'
|
||||
|
||||
--parser object for the root
|
||||
--not inserted to the parser list as it has special behaviour
|
||||
--it does get get added to parsers under it's ID to prevent confusing duplicates
|
||||
local root_parser = {
|
||||
name = "root",
|
||||
priority = math.huge,
|
||||
|
||||
--if this is being called then all other parsers have failed and we've fallen back to root
|
||||
can_parse = function() return true end,
|
||||
|
||||
--we return the root directory exactly as setup
|
||||
parse = function(self)
|
||||
return g.root, {
|
||||
sorted = true,
|
||||
filtered = true,
|
||||
escaped = true,
|
||||
parser = self,
|
||||
directory = "",
|
||||
}
|
||||
end
|
||||
}
|
||||
|
||||
return root_parser
|
||||
@@ -0,0 +1,257 @@
|
||||
------------------------------------------------------------------------------------------
|
||||
---------------------------------File/Playlist Opening------------------------------------
|
||||
------------------------------------------------------------------------------------------
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local ass = require 'modules.ass'
|
||||
local cursor = require 'modules.navigation.cursor'
|
||||
local controls = require 'modules.controls'
|
||||
local scanning = require 'modules.navigation.scanning'
|
||||
local movement = require 'modules.navigation.directory-movement'
|
||||
|
||||
local state = g.state
|
||||
|
||||
--adds a file to the playlist and changes the flag to `append-play` in preparation
|
||||
--for future items
|
||||
local function loadfile(file, opts)
|
||||
if o.substitute_backslash and not API.get_protocol(file) then
|
||||
file = file:gsub("/", "\\")
|
||||
end
|
||||
|
||||
if opts.flag == "replace" then msg.verbose("Playling file", file)
|
||||
else msg.verbose("Appending", file, "to the playlist") end
|
||||
|
||||
if not mp.commandv("loadfile", file, opts.flag) then msg.warn(file) end
|
||||
opts.flag = "append-play"
|
||||
opts.items_appended = opts.items_appended + 1
|
||||
end
|
||||
|
||||
--this function recursively loads directories concurrently in separate coroutines
|
||||
--results are saved in a tree of tables that allows asynchronous access
|
||||
local function concurrent_loadlist_parse(directory, load_opts, prev_dirs, item_t)
|
||||
--prevents infinite recursion from the item.path or opts.directory fields
|
||||
if prev_dirs[directory] then return end
|
||||
prev_dirs[directory] = true
|
||||
|
||||
local list, list_opts = scanning.scan_directory(directory, { source = "loadlist" })
|
||||
if list == g.root then return end
|
||||
|
||||
--if we can't parse the directory then append it and hope mpv fares better
|
||||
if list == nil then
|
||||
msg.warn("Could not parse", directory, "appending to playlist anyway")
|
||||
item_t.type = "file"
|
||||
return
|
||||
end
|
||||
|
||||
directory = list_opts.directory or directory
|
||||
if directory == "" then return end
|
||||
|
||||
--we must declare these before we start loading sublists otherwise the append thread will
|
||||
--need to wait until the whole list is loaded (when synchronous IO is used)
|
||||
item_t._sublist = list or {}
|
||||
list._directory = directory
|
||||
|
||||
--launches new parse operations for directories, each in a different coroutine
|
||||
for _, item in ipairs(list) do
|
||||
if API.parseable_item(item) then
|
||||
API.coroutine.run(concurrent_loadlist_wrapper, API.get_new_directory(item, directory), load_opts, prev_dirs, item)
|
||||
end
|
||||
end
|
||||
return true
|
||||
end
|
||||
|
||||
--a wrapper function that ensures the concurrent_loadlist_parse is run correctly
|
||||
function concurrent_loadlist_wrapper(directory, opts, prev_dirs, item)
|
||||
--ensures that only a set number of concurrent parses are operating at any one time.
|
||||
--the mpv event queue is seemingly limited to 1000 items, but only async mpv actions like
|
||||
--command_native_async should use that, events like mp.add_timeout (which coroutine.sleep() uses) should
|
||||
--be handled enturely on the Lua side with a table, which has a significantly larger maximum size.
|
||||
while (opts.concurrency > o.max_concurrency) do
|
||||
API.coroutine.sleep(0.1)
|
||||
end
|
||||
opts.concurrency = opts.concurrency + 1
|
||||
|
||||
local success = concurrent_loadlist_parse(directory, opts, prev_dirs, item)
|
||||
opts.concurrency = opts.concurrency - 1
|
||||
if not success then item._sublist = {} end
|
||||
if coroutine.status(opts.co) == "suspended" then API.coroutine.resume_err(opts.co) end
|
||||
end
|
||||
|
||||
--recursively appends items to the playlist, acts as a consumer to the previous functions producer;
|
||||
--if the next directory has not been parsed this function will yield until the parse has completed
|
||||
local function concurrent_loadlist_append(list, load_opts)
|
||||
local directory = list._directory
|
||||
|
||||
for _, item in ipairs(list) do
|
||||
if not g.sub_extensions[ API.get_extension(item.name, "") ]
|
||||
and not g.audio_extensions[ API.get_extension(item.name, "") ]
|
||||
then
|
||||
while (not item._sublist and API.parseable_item(item)) do
|
||||
coroutine.yield()
|
||||
end
|
||||
|
||||
if API.parseable_item(item) then
|
||||
concurrent_loadlist_append(item._sublist, load_opts)
|
||||
else
|
||||
loadfile(API.get_full_path(item, directory), load_opts)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
--recursive function to load directories using the script custom parsers
|
||||
--returns true if any items were appended to the playlist
|
||||
local function custom_loadlist_recursive(directory, load_opts, prev_dirs)
|
||||
--prevents infinite recursion from the item.path or opts.directory fields
|
||||
if prev_dirs[directory] then return end
|
||||
prev_dirs[directory] = true
|
||||
|
||||
local list, opts = scanning.scan_directory(directory, { source = "loadlist" })
|
||||
if list == g.root then return end
|
||||
|
||||
--if we can't parse the directory then append it and hope mpv fares better
|
||||
if list == nil then
|
||||
msg.warn("Could not parse", directory, "appending to playlist anyway")
|
||||
loadfile(directory, load_opts.flag)
|
||||
return true
|
||||
end
|
||||
|
||||
directory = opts.directory or directory
|
||||
if directory == "" then return end
|
||||
|
||||
for _, item in ipairs(list) do
|
||||
if not g.sub_extensions[ API.get_extension(item.name, "") ]
|
||||
and not g.audio_extensions[ API.get_extension(item.name, "") ]
|
||||
then
|
||||
if API.parseable_item(item) then
|
||||
custom_loadlist_recursive( API.get_new_directory(item, directory) , load_opts, prev_dirs)
|
||||
else
|
||||
local path = API.get_full_path(item, directory)
|
||||
loadfile(path, load_opts)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
--a wrapper for the custom_loadlist_recursive function
|
||||
local function loadlist(item, opts)
|
||||
local dir = API.get_full_path(item, opts.directory)
|
||||
local num_items = opts.items_appended
|
||||
|
||||
if o.concurrent_recursion then
|
||||
item = API.copy_table(item)
|
||||
opts.co = API.coroutine.assert()
|
||||
opts.concurrency = 0
|
||||
|
||||
--we need the current coroutine to suspend before we run the first parse operation, so
|
||||
--we schedule the coroutine to run on the mpv event queue
|
||||
mp.add_timeout(0, function()
|
||||
API.coroutine.run(concurrent_loadlist_wrapper, dir, opts, {}, item)
|
||||
end)
|
||||
concurrent_loadlist_append({item, _directory = opts.directory}, opts)
|
||||
else
|
||||
custom_loadlist_recursive(dir, opts, {})
|
||||
end
|
||||
|
||||
if opts.items_appended == num_items then msg.warn(dir, "contained no valid files") end
|
||||
end
|
||||
|
||||
--load playlist entries before and after the currently playing file
|
||||
local function autoload_dir(path, opts)
|
||||
if o.autoload_save_current and path == g.current_file.path then
|
||||
mp.commandv("write-watch-later-config") end
|
||||
|
||||
--loads the currently selected file, clearing the playlist in the process
|
||||
loadfile(path, opts)
|
||||
|
||||
local pos = 1
|
||||
local file_count = 0
|
||||
for _,item in ipairs(state.list) do
|
||||
if item.type == "file"
|
||||
and not g.sub_extensions[ API.get_extension(item.name, "") ]
|
||||
and not g.audio_extensions[ API.get_extension(item.name, "") ]
|
||||
then
|
||||
local p = API.get_full_path(item)
|
||||
|
||||
if p == path then pos = file_count
|
||||
else loadfile( p, opts) end
|
||||
|
||||
file_count = file_count + 1
|
||||
end
|
||||
end
|
||||
mp.commandv("playlist-move", 0, pos+1)
|
||||
end
|
||||
|
||||
--runs the loadfile or loadlist command
|
||||
local function open_item(item, opts)
|
||||
if API.parseable_item(item) then
|
||||
return loadlist(item, opts)
|
||||
end
|
||||
|
||||
local path = API.get_full_path(item, opts.directory)
|
||||
if g.sub_extensions[ API.get_extension(item.name, "") ] then
|
||||
mp.commandv("sub-add", path, opts.flag == "replace" and "select" or "auto")
|
||||
elseif g.audio_extensions[ API.get_extension(item.name, "") ] then
|
||||
mp.commandv("audio-add", path, opts.flag == "replace" and "select" or "auto")
|
||||
else
|
||||
if opts.autoload then autoload_dir(path, opts)
|
||||
else loadfile(path, opts) end
|
||||
end
|
||||
end
|
||||
|
||||
--handles the open options as a coroutine
|
||||
--once loadfile has been run we can no-longer guarantee synchronous execution - the state values may change
|
||||
--therefore, we must ensure that any state values that could be used after a loadfile call are saved beforehand
|
||||
local function open_file_coroutine(opts)
|
||||
if not state.list[state.selected] then return end
|
||||
if opts.flag == 'replace' then controls.close() end
|
||||
|
||||
--we want to set the idle option to yes to ensure that if the first item
|
||||
--fails to load then the player has a chance to attempt to load further items (for async append operations)
|
||||
local idle = mp.get_property("idle", "once")
|
||||
mp.set_property("idle", "yes")
|
||||
|
||||
--handles multi-selection behaviour
|
||||
if next(state.selection) then
|
||||
local selection = API.sort_keys(state.selection)
|
||||
--reset the selection after
|
||||
state.selection = {}
|
||||
|
||||
cursor.disable_select_mode()
|
||||
ass.update_ass()
|
||||
|
||||
--the currently selected file will be loaded according to the flag
|
||||
--the flag variable will be switched to append once a file is loaded
|
||||
for i=1, #selection do
|
||||
open_item(selection[i], opts)
|
||||
end
|
||||
|
||||
else
|
||||
local item = state.list[state.selected]
|
||||
if opts.flag == "replace" then movement.down_dir() end
|
||||
open_item(item, opts)
|
||||
end
|
||||
|
||||
if mp.get_property("idle") == "yes" then mp.set_property("idle", idle) end
|
||||
end
|
||||
|
||||
--opens the selelected file(s)
|
||||
local function open_file(flag, autoload)
|
||||
API.coroutine.run(open_file_coroutine, {
|
||||
flag = flag,
|
||||
autoload = (autoload ~= o.autoload and flag == "replace"),
|
||||
directory = state.directory,
|
||||
items_appended = 0
|
||||
})
|
||||
end
|
||||
|
||||
return {
|
||||
add_files = open_file,
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
local scanning = require 'modules.navigation.scanning'
|
||||
|
||||
local script_messages = {}
|
||||
|
||||
--allows other scripts to request directory contents from file-browser
|
||||
function script_messages.get_directory_contents(directory, response_str)
|
||||
API.coroutine.run(function()
|
||||
if not directory then msg.error("did not receive a directory string"); return end
|
||||
if not response_str then msg.error("did not receive a response string"); return end
|
||||
|
||||
directory = mp.command_native({"expand-path", directory}, "")
|
||||
if directory ~= "" then directory = API.fix_path(directory, true) end
|
||||
msg.verbose(("recieved %q from 'get-directory-contents' script message - returning result to %q"):format(directory, response_str))
|
||||
|
||||
local list, opts = scanning.scan_directory(directory, { source = "script-message" } )
|
||||
if opts then opts.API_VERSION = g.API_VERSION end
|
||||
|
||||
local err
|
||||
list, err = API.format_json_safe(list)
|
||||
if not list then msg.error(err) end
|
||||
|
||||
opts, err = API.format_json_safe(opts)
|
||||
if not opts then msg.error(err) end
|
||||
|
||||
mp.commandv("script-message", response_str, list or "", opts or "")
|
||||
end)
|
||||
end
|
||||
|
||||
--a helper script message for custom keybinds
|
||||
--substitutes any '=>' arguments for 'script-message'
|
||||
--makes chaining script-messages much easier
|
||||
function script_messages.chain(...)
|
||||
local command = table.pack('script-message', ...)
|
||||
for i, v in ipairs(command) do
|
||||
if v == '=>' then command[i] = 'script-message' end
|
||||
end
|
||||
mp.commandv(table.unpack(command))
|
||||
end
|
||||
|
||||
--a helper script message for custom keybinds
|
||||
--sends a command after the specified delay
|
||||
function script_messages.delay_command(delay, ...)
|
||||
local command = table.pack(...)
|
||||
local success, err = pcall(mp.add_timeout, API.evaluate_string('return '..delay), function() mp.commandv(table.unpack(command)) end)
|
||||
if not success then return msg.error(err) end
|
||||
end
|
||||
|
||||
--a helper script message for custom keybinds
|
||||
--sends a command only if the given expression returns true
|
||||
function script_messages.conditional_command(condition, ...)
|
||||
local command = table.pack(...)
|
||||
API.coroutine.run(function()
|
||||
if API.evaluate_string('return '..condition) == true then mp.commandv(table.unpack(command)) end
|
||||
end)
|
||||
end
|
||||
|
||||
--a helper script message for custom keybinds
|
||||
--extracts lua expressions from the command and evaluates them
|
||||
--expressions must be surrounded by !{}. Another ! before the { will escape the evaluation
|
||||
function script_messages.evaluate_expressions(...)
|
||||
local args = table.pack(...)
|
||||
API.coroutine.run(function()
|
||||
for i, arg in ipairs(args) do
|
||||
args[i] = arg:gsub('(!+)(%b{})', function(lead, expression)
|
||||
if #lead % 2 == 0 then return string.rep('!', #lead/2)..expression end
|
||||
|
||||
local eval = API.evaluate_string('return '..expression:sub(2, -2))
|
||||
return type(eval) == "table" and utils.to_string(eval) or tostring(eval)
|
||||
end)
|
||||
end
|
||||
|
||||
mp.commandv(table.unpack(args))
|
||||
end)
|
||||
end
|
||||
|
||||
--a helper function for custom-keybinds
|
||||
--concatenates the command arguments with newlines and runs the
|
||||
--string as a statement of code
|
||||
function script_messages.run_statement(...)
|
||||
local statement = table.concat(table.pack(...), '\n')
|
||||
API.coroutine.run(API.evaluate_string, statement)
|
||||
end
|
||||
|
||||
return script_messages
|
||||
@@ -0,0 +1,52 @@
|
||||
local mp = require 'mp'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
local API = require 'modules.utils'
|
||||
|
||||
--sets up the compatible extensions list
|
||||
local function setup_extensions_list()
|
||||
--setting up subtitle extensions
|
||||
for ext in API.iterate_opt(o.subtitle_extensions:lower()) do
|
||||
g.sub_extensions[ext] = true
|
||||
g.extensions[ext] = true
|
||||
end
|
||||
|
||||
--setting up audio extensions
|
||||
for ext in API.iterate_opt(o.audio_extensions:lower()) do
|
||||
g.audio_extensions[ext] = true
|
||||
g.extensions[ext] = true
|
||||
end
|
||||
|
||||
--adding file extensions to the set
|
||||
for _, ext in ipairs(g.compatible_file_extensions) do
|
||||
g.extensions[ext] = true
|
||||
end
|
||||
|
||||
--adding extra extensions on the whitelist
|
||||
for str in API.iterate_opt(o.extension_whitelist:lower()) do
|
||||
g.extensions[str] = true
|
||||
end
|
||||
|
||||
--removing extensions that are in the blacklist
|
||||
for str in API.iterate_opt(o.extension_blacklist:lower()) do
|
||||
g.extensions[str] = nil
|
||||
end
|
||||
end
|
||||
|
||||
--splits the string into a table on the separators
|
||||
local function setup_root()
|
||||
for str in API.iterate_opt(o.root) do
|
||||
local path = mp.command_native({'expand-path', str})
|
||||
path = API.fix_path(path, true)
|
||||
|
||||
local temp = {name = path, type = 'dir', label = str, ass = API.ass_escape(str, true)}
|
||||
|
||||
g.root[#g.root+1] = temp
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
extensions_list = setup_extensions_list,
|
||||
root = setup_root,
|
||||
}
|
||||
@@ -0,0 +1,424 @@
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
-----------------------------------------Utility Functions----------------------------------------------
|
||||
---------------------------------------Part of the addon API--------------------------------------------
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
local mp = require 'mp'
|
||||
local msg = require 'mp.msg'
|
||||
local utils = require 'mp.utils'
|
||||
|
||||
local o = require 'modules.options'
|
||||
local g = require 'modules.globals'
|
||||
|
||||
local success, input = pcall(require, "user-input-module")
|
||||
if not success then input = nil end
|
||||
|
||||
--creates a table for the API functions
|
||||
--adds one metatable redirect to prevent addon authors from accidentally breaking file-browser
|
||||
local API = { API_VERSION = g.API_VERSION }
|
||||
|
||||
API.list = {}
|
||||
API.coroutine = {}
|
||||
|
||||
--implements table.pack if on lua 5.1
|
||||
if not table.pack then
|
||||
table.unpack = unpack
|
||||
---@diagnostic disable-next-line: duplicate-set-field
|
||||
function table.pack(...)
|
||||
local t = {n = select("#", ...), ...}
|
||||
return t
|
||||
end
|
||||
end
|
||||
|
||||
-- returns the index of the given item in the table
|
||||
-- return -1 if item does not exist
|
||||
function API.list.indexOf(t, item, from_index)
|
||||
for i = from_index or 1, #t, 1 do
|
||||
if t[i] == item then return i end
|
||||
end
|
||||
return -1
|
||||
end
|
||||
|
||||
--returns whether or not the given table contains an entry that
|
||||
--causes the given function to evaluate to true
|
||||
function API.list.some(t, fn)
|
||||
for i, v in ipairs(t) do
|
||||
if fn(v, i, t) then return true end
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
--prints an error message and a stack trace
|
||||
--accepts an error object and optionally a coroutine
|
||||
--can be passed directly to xpcall
|
||||
function API.traceback(errmsg, co)
|
||||
if co then
|
||||
msg.warn(debug.traceback(co))
|
||||
else
|
||||
msg.warn(debug.traceback("", 2))
|
||||
end
|
||||
msg.error(errmsg)
|
||||
end
|
||||
|
||||
--returns a table that stores the given table t as the __index in its metatable
|
||||
--creates a prototypally inherited table
|
||||
function API.redirect_table(t)
|
||||
return setmetatable({}, { __index = t })
|
||||
end
|
||||
|
||||
--prints an error if a coroutine returns an error
|
||||
--unlike the next function this one still returns the results of coroutine.resume()
|
||||
function API.coroutine.resume_catch(...)
|
||||
local returns = table.pack(coroutine.resume(...))
|
||||
if not returns[1] and returns[2] ~= g.ABORT_ERROR then
|
||||
API.traceback(returns[2], select(1, ...))
|
||||
end
|
||||
return table.unpack(returns, 1, returns.n)
|
||||
end
|
||||
|
||||
--resumes a coroutine and prints an error if it was not sucessful
|
||||
function API.coroutine.resume_err(...)
|
||||
local success, err = coroutine.resume(...)
|
||||
if not success and err ~= g.ABORT_ERROR then
|
||||
API.traceback(err, select(1, ...))
|
||||
end
|
||||
return success
|
||||
end
|
||||
|
||||
--in lua 5.1 there is only one return value which will be nil if run from the main thread
|
||||
--in lua 5.2 main will be true if running from the main thread
|
||||
function API.coroutine.assert(err)
|
||||
local co, main = coroutine.running()
|
||||
assert(not main and co, err or "error - function must be executed from within a coroutine")
|
||||
return co
|
||||
end
|
||||
|
||||
--creates a callback fuction to resume the current coroutine
|
||||
function API.coroutine.callback()
|
||||
local co = API.coroutine.assert("cannot create a coroutine callback for the main thread")
|
||||
return function(...)
|
||||
return API.coroutine.resume_err(co, ...)
|
||||
end
|
||||
end
|
||||
|
||||
--puts the current coroutine to sleep for the given number of seconds
|
||||
function API.coroutine.sleep(n)
|
||||
mp.add_timeout(n, API.coroutine.callback())
|
||||
coroutine.yield()
|
||||
end
|
||||
|
||||
--runs the given function in a coroutine, passing through any additional arguments
|
||||
--this is for triggering an event in a coroutine
|
||||
function API.coroutine.run(fn, ...)
|
||||
local co = coroutine.create(fn)
|
||||
API.coroutine.resume_err(co, ...)
|
||||
end
|
||||
|
||||
--get the full path for the current file
|
||||
function API.get_full_path(item, dir)
|
||||
if item.path then return item.path end
|
||||
return (dir or g.state.directory)..item.name
|
||||
end
|
||||
|
||||
--gets the path for a new subdirectory, redirects if the path field is set
|
||||
--returns the new directory path and a boolean specifying if a redirect happened
|
||||
function API.get_new_directory(item, directory)
|
||||
if item.path and item.redirect ~= false then return item.path, true end
|
||||
if directory == "" then return item.name end
|
||||
if string.sub(directory, -1) == "/" then return directory..item.name end
|
||||
return directory.."/"..item.name
|
||||
end
|
||||
|
||||
--returns the file extension of the given file
|
||||
function API.get_extension(filename, def)
|
||||
return string.lower(filename):match("%.([^%./]+)$") or def
|
||||
end
|
||||
|
||||
--returns the protocol scheme of the given url, or nil if there is none
|
||||
function API.get_protocol(filename, def)
|
||||
return string.lower(filename):match("^(%a[%w+-.]*)://") or def
|
||||
end
|
||||
|
||||
--formats strings for ass handling
|
||||
--this function is based on a similar function from https://github.com/mpv-player/mpv/blob/master/player/lua/console.lua#L110
|
||||
function API.ass_escape(str, replace_newline)
|
||||
if replace_newline == true then replace_newline = "\\\239\187\191n" end
|
||||
|
||||
--escape the invalid single characters
|
||||
str = string.gsub(str, '[\\{}\n]', {
|
||||
-- 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
|
||||
['\\'] = '\\\239\187\191',
|
||||
['{'] = '\\{',
|
||||
['}'] = '\\}',
|
||||
-- Precede newlines with a ZWNBSP to prevent ASS's weird collapsing of
|
||||
-- consecutive newlines
|
||||
['\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')
|
||||
|
||||
if replace_newline then
|
||||
str = str:gsub("\\N", replace_newline)
|
||||
end
|
||||
return str
|
||||
end
|
||||
|
||||
--escape lua pattern characters
|
||||
function API.pattern_escape(str)
|
||||
return string.gsub(str, "([%^%$%(%)%%%.%[%]%*%+%-])", "%%%1")
|
||||
end
|
||||
|
||||
--standardises filepaths across systems
|
||||
function API.fix_path(str, is_directory)
|
||||
str = string.gsub(str, [[\]],[[/]])
|
||||
str = str:gsub([[/%./]], [[/]])
|
||||
if is_directory and str:sub(-1) ~= '/' then str = str..'/' end
|
||||
return str
|
||||
end
|
||||
|
||||
--wrapper for utils.join_path to handle protocols
|
||||
function API.join_path(working, relative)
|
||||
return API.get_protocol(relative) and relative or utils.join_path(working, relative)
|
||||
end
|
||||
|
||||
--sorts the table lexicographically ignoring case and accounting for leading/non-leading zeroes
|
||||
--the number format functionality was proposed by github user twophyro, and was presumably taken
|
||||
--from here: http://notebook.kulchenko.com/algorithms/alphanumeric-natural-sorting-for-humans-in-lua
|
||||
function API.sort(t)
|
||||
local function padnum(n, d)
|
||||
return #d > 0 and ("%03d%s%.12f"):format(#n, n, tonumber(d) / (10 ^ #d))
|
||||
or ("%03d%s"):format(#n, n)
|
||||
end
|
||||
|
||||
--appends the letter d or f to the start of the comparison to sort directories and folders as well
|
||||
local tuples = {}
|
||||
for i, f in ipairs(t) do
|
||||
tuples[i] = {f.type:sub(1, 1) .. (f.label or f.name):lower():gsub("0*(%d+)%.?(%d*)", padnum), f}
|
||||
end
|
||||
table.sort(tuples, function(a, b)
|
||||
return a[1] == b[1] and #b[2] < #a[2] or a[1] < b[1]
|
||||
end)
|
||||
for i, tuple in ipairs(tuples) do t[i] = tuple[2] end
|
||||
return t
|
||||
end
|
||||
|
||||
function API.valid_dir(dir)
|
||||
if o.filter_dot_dirs and string.sub(dir, 1, 1) == "." then return false end
|
||||
return true
|
||||
end
|
||||
|
||||
function API.valid_file(file)
|
||||
if o.filter_dot_files and (string.sub(file, 1, 1) == ".") then return false end
|
||||
if o.filter_files and not g.extensions[ API.get_extension(file, "") ] then return false end
|
||||
return true
|
||||
end
|
||||
|
||||
--returns whether or not the item can be parsed
|
||||
function API.parseable_item(item)
|
||||
return item.type == "dir" or g.parseable_extensions[API.get_extension(item.name, "")]
|
||||
end
|
||||
|
||||
--removes items and folders from the list
|
||||
--this is for addons which can't filter things during their normal processing
|
||||
function API.filter(t)
|
||||
local max = #t
|
||||
local top = 1
|
||||
for i = 1, max do
|
||||
local temp = t[i]
|
||||
t[i] = nil
|
||||
|
||||
if ( temp.type == "dir" and API.valid_dir(temp.label or temp.name) ) or
|
||||
( temp.type == "file" and API.valid_file(temp.label or temp.name) )
|
||||
then
|
||||
t[top] = temp
|
||||
top = top+1
|
||||
end
|
||||
end
|
||||
return t
|
||||
end
|
||||
|
||||
--returns a string iterator that uses the root separators
|
||||
function API.iterate_opt(str)
|
||||
return string.gmatch(str, "([^"..API.pattern_escape(o.root_separators).."]+)")
|
||||
end
|
||||
|
||||
--sorts a table into an array of selected items in the correct order
|
||||
--if a predicate function is passed, then the item will only be added to
|
||||
--the table if the function returns true
|
||||
function API.sort_keys(t, include_item)
|
||||
local keys = {}
|
||||
for k in pairs(t) do
|
||||
local item = g.state.list[k]
|
||||
if not include_item or include_item(item) then
|
||||
item.index = k
|
||||
keys[#keys+1] = item
|
||||
end
|
||||
end
|
||||
|
||||
table.sort(keys, function(a,b) return a.index < b.index end)
|
||||
return keys
|
||||
end
|
||||
|
||||
--Uses a loop to get the length of an array. The `#` operator is undefined if there
|
||||
--are gaps in the array, this ensures there are none as expected by the mpv node function.
|
||||
local function get_length(t)
|
||||
local i = 1
|
||||
while t[i] do i = i+1 end
|
||||
return i - 1
|
||||
end
|
||||
|
||||
--recursively removes elements of the table which would cause
|
||||
--utils.format_json to throw an error
|
||||
local function json_safe_recursive(t)
|
||||
if type(t) ~= "table" then return t end
|
||||
|
||||
local array_length = get_length(t)
|
||||
local isarray = array_length > 0
|
||||
|
||||
for key, value in pairs(t) do
|
||||
local ktype = type(key)
|
||||
local vtype = type(value)
|
||||
|
||||
if vtype ~= "userdata" and vtype ~= "function" and vtype ~= "thread"
|
||||
and (( isarray and ktype == "number" and key <= array_length)
|
||||
or (not isarray and ktype == "string"))
|
||||
then
|
||||
t[key] = json_safe_recursive(t[key])
|
||||
elseif key then
|
||||
t[key] = nil
|
||||
if isarray then array_length = get_length(t) end
|
||||
end
|
||||
end
|
||||
return t
|
||||
end
|
||||
|
||||
--formats a table into a json string but ensures there are no invalid datatypes inside the table first
|
||||
function API.format_json_safe(t)
|
||||
--operate on a copy of the table to prevent any data loss in the original table
|
||||
t = json_safe_recursive(API.copy_table(t))
|
||||
local success, result, err = pcall(utils.format_json, t)
|
||||
if success then return result, err
|
||||
else return nil, result end
|
||||
end
|
||||
|
||||
--evaluates and runs the given string in both Lua 5.1 and 5.2
|
||||
--the name argument is used for error reporting
|
||||
--provides the mpv modules and the fb module to the string
|
||||
function API.evaluate_string(str, name)
|
||||
local env = API.redirect_table(_G)
|
||||
env.mp = API.redirect_table(mp)
|
||||
env.msg = API.redirect_table(msg)
|
||||
env.utils = API.redirect_table(utils)
|
||||
env.fb = API.redirect_table(API)
|
||||
env.input = input and API.redirect_table(input)
|
||||
|
||||
local chunk, err
|
||||
if setfenv then
|
||||
chunk, err = loadstring(str, name)
|
||||
if chunk then setfenv(chunk, env) end
|
||||
else
|
||||
chunk, err = load(str, name, 't', env)
|
||||
end
|
||||
if not chunk then
|
||||
msg.warn('failed to load string:', str)
|
||||
msg.error(err)
|
||||
chunk = function() return nil end
|
||||
end
|
||||
|
||||
return chunk()
|
||||
end
|
||||
|
||||
--copies a table without leaving any references to the original
|
||||
--uses a structured clone algorithm to maintain cyclic references
|
||||
local function copy_table_recursive(t, references, depth)
|
||||
if type(t) ~= "table" or depth == 0 then return t end
|
||||
if references[t] then return references[t] end
|
||||
|
||||
local copy = setmetatable({}, { __original = t })
|
||||
references[t] = copy
|
||||
|
||||
for key, value in pairs(t) do
|
||||
key = copy_table_recursive(key, references, depth - 1)
|
||||
copy[key] = copy_table_recursive(value, references, depth - 1)
|
||||
end
|
||||
return copy
|
||||
end
|
||||
|
||||
--a wrapper around copy_table to provide the reference table
|
||||
function API.copy_table(t, depth)
|
||||
--this is to handle cyclic table references
|
||||
return copy_table_recursive(t, {}, depth or math.huge)
|
||||
end
|
||||
|
||||
--format the item string for either single or multiple items
|
||||
local function create_item_string(base_code_fn, items, state, cmd, quoted)
|
||||
if not items[1] then return end
|
||||
local func = quoted and function(...) return ("%q"):format(base_code_fn(...)) end or base_code_fn
|
||||
|
||||
local out = {}
|
||||
for _, item in ipairs(items) do
|
||||
table.insert(out, func(item, state))
|
||||
end
|
||||
|
||||
return table.concat(out, cmd['concat-string'] or ' ')
|
||||
end
|
||||
|
||||
--functions to replace custom-keybind codes
|
||||
API.code_fns = {
|
||||
["%"] = "%",
|
||||
|
||||
f = function(item, s) return item and API.get_full_path(item, s.directory) or "" end,
|
||||
n = function(item, s) return item and (item.label or item.name) or "" end,
|
||||
i = function(item, s) local i = API.list.indexOf(s.list, item) ; return i ~= -1 and i or 0 end,
|
||||
j = function (item, s) return API.list.indexOf(s.list, item) ~= -1 and math.abs(API.list.indexOf( API.sort_keys(s.selection) , item)) or 0 end,
|
||||
|
||||
x = function(_, s) return #s.list or 0 end,
|
||||
p = function(_, s) return s.directory or "" end,
|
||||
q = function(_, s) return s.directory == '' and 'ROOT' or s.directory_label or s.directory or "" end,
|
||||
d = function(_, s) return (s.directory_label or s.directory):match("([^/]+)/?$") or "" end,
|
||||
r = function(_, s) return s.parser.keybind_name or s.parser.name or "" end,
|
||||
}
|
||||
|
||||
-- programatically creates a pattern that matches any key code
|
||||
-- this will result in some duplicates but that shouldn't really matter
|
||||
function API.get_code_pattern(codes)
|
||||
local CUSTOM_KEYBIND_CODES = ""
|
||||
for key in pairs(codes) do CUSTOM_KEYBIND_CODES = CUSTOM_KEYBIND_CODES..key:lower()..key:upper() end
|
||||
for key in pairs((getmetatable(codes) or {}).__index or {}) do CUSTOM_KEYBIND_CODES = CUSTOM_KEYBIND_CODES..key:lower()..key:upper() end
|
||||
return('%%%%([%s])'):format(API.pattern_escape(CUSTOM_KEYBIND_CODES))
|
||||
end
|
||||
|
||||
-- substitutes codes in the given string for other substrings
|
||||
-- overrides is a map of characters->strings|functions that determines the replacement string is
|
||||
-- item and state are values passed to functions in the map
|
||||
-- modifier_fn is given the replacement substrings before they are placed in the main string (the return value is the new replacement string)
|
||||
function API.substitute_codes(str, overrides, item, state, modifier_fn)
|
||||
local replacers = overrides and setmetatable(API.copy_table(overrides), {__index = API.code_fns}) or API.code_fns
|
||||
item = item or g.state.list[g.state.selected]
|
||||
state = state or g.state
|
||||
|
||||
return (string.gsub(str, API.get_code_pattern(replacers), function(code)
|
||||
local result
|
||||
|
||||
if type(replacers[code]) == "string" then
|
||||
result = replacers[code]
|
||||
--encapsulates the string if using an uppercase code
|
||||
elseif not replacers[code] then
|
||||
local lower_fn = replacers[code:lower()]
|
||||
if not lower_fn then return end
|
||||
result = string.format("%q", lower_fn(item, state))
|
||||
else
|
||||
result = replacers[code](item, state)
|
||||
end
|
||||
|
||||
if modifier_fn then return modifier_fn(result) end
|
||||
return result
|
||||
end))
|
||||
end
|
||||
|
||||
|
||||
return API
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 2.8 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 975 KiB |
@@ -577,7 +577,7 @@ header_window_color = 5
|
||||
#
|
||||
#state_flags_color = default:b
|
||||
#
|
||||
main_window_color = 5
|
||||
main_window_color = 62
|
||||
#
|
||||
#color1 = white
|
||||
#
|
||||
@@ -599,3 +599,4 @@ progressbar_color = 5:b
|
||||
#
|
||||
#active_window_border = red
|
||||
#
|
||||
#https://www.ditig.com/publications/256-colors-cheat-sheet
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
],
|
||||
"news": {
|
||||
"NEWS.md": "2123"
|
||||
"NEWS.md": "3314"
|
||||
},
|
||||
"version": 3
|
||||
}
|
||||
@@ -0,0 +1,248 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
## rofi-screenshot
|
||||
## https://github.com/ceuk/rofi-screenshot
|
||||
## Author: ceuk @ github
|
||||
## Licence: WTFPL
|
||||
## Usage:
|
||||
## show the menu with rofi-screenshot
|
||||
## stop recording with rofi-screenshot -s
|
||||
|
||||
# Screenshot directory
|
||||
screenshot_directory="${ROFI_SCREENSHOT_DIR:-${XDG_PICTURES_DIR:-$HOME/Pictures}/Screenshots}"
|
||||
|
||||
# Default date format
|
||||
default_date_format="+%d-%m-%Y %H:%M:%S"
|
||||
|
||||
# set ffmpeg defaults
|
||||
ffmpeg() {
|
||||
command ffmpeg -hide_banner -loglevel error -nostdin "$@"
|
||||
}
|
||||
|
||||
video_to_gif() {
|
||||
ffmpeg -i "$1" -vf palettegen -f image2 -c:v png - |
|
||||
ffmpeg -i "$1" -i - -filter_complex paletteuse "$2"
|
||||
}
|
||||
|
||||
countdown() {
|
||||
notify-send --app-name="screenshot" "Screenshot" "Recording in 3" -t 1000
|
||||
sleep 1
|
||||
notify-send --app-name="screenshot" "Screenshot" "Recording in 2" -t 1000
|
||||
sleep 1
|
||||
notify-send --app-name="screenshot" "Screenshot" "Recording in 1" -t 1000
|
||||
sleep 1
|
||||
}
|
||||
|
||||
crtc() {
|
||||
notify-send --app-name="screenshot" "Screenshot" "Select a region to capture"
|
||||
ffcast -q "$(slop -n -f '-g %g ')" png /tmp/screenshot_clip.png
|
||||
xclip -selection clipboard -t image/png /tmp/screenshot_clip.png
|
||||
rm /tmp/screenshot_clip.png
|
||||
notify-send --app-name="screenshot" "Screenshot" "Region copied to Clipboard"
|
||||
}
|
||||
|
||||
crtf() {
|
||||
notify-send --app-name="screenshot" "Screenshot" "Select a region to capture"
|
||||
dt=$1
|
||||
ffcast -q "$(slop -n -f '-g %g ')" png "$screenshot_directory/$dt.png"
|
||||
notify-send --app-name="screenshot" "Screenshot" "Region saved to ${screenshot_directory//${HOME}/~}/$dt.png"
|
||||
}
|
||||
|
||||
cstc() {
|
||||
ffcast -q png /tmp/screenshot_clip.png
|
||||
xclip -selection clipboard -t image/png /tmp/screenshot_clip.png
|
||||
rm /tmp/screenshot_clip.png
|
||||
notify-send --app-name="screenshot" "Screenshot" "Screenshot copied to Clipboard"
|
||||
}
|
||||
|
||||
cstf() {
|
||||
dt=$1
|
||||
ffcast -q png "$screenshot_directory/$dt.png"
|
||||
notify-send --app-name="screenshot" "Screenshot" "Saved to ${screenshot_directory//${HOME}/~}/$dt.png"
|
||||
}
|
||||
|
||||
rgrtf() {
|
||||
notify-send --app-name="screenshot" "Screenshot" "Select a region to record"
|
||||
dt=$1
|
||||
ffcast -q "$(slop -n -f '-g %g ' && countdown)" rec /tmp/screenshot_gif.mp4
|
||||
notify-send --app-name="screenshot" "Screenshot" "Converting to gif… (can take a while)"
|
||||
video_to_gif /tmp/screenshot_gif.mp4 "$screenshot_directory/$dt.gif"
|
||||
rm /tmp/screenshot_gif.mp4
|
||||
notify-send --app-name="screenshot" "Screenshot" "Saved to ${screenshot_directory//${HOME}/~}/$dt.gif"
|
||||
}
|
||||
|
||||
rgstf() {
|
||||
countdown
|
||||
dt=$1
|
||||
ffcast -q rec /tmp/screenshot_gif.mp4
|
||||
notify-send --app-name="screenshot" "Screenshot" "Converting to gif… (can take a while)"
|
||||
video_to_gif /tmp/screenshot_gif.mp4 "$screenshot_directory/$dt.gif"
|
||||
rm /tmp/screenshot_gif.mp4
|
||||
notify-send --app-name="screenshot" "Screenshot" "Saved to ${screenshot_directory//${HOME}/~}/$dt.gif"
|
||||
}
|
||||
|
||||
rvrtf() {
|
||||
notify-send --app-name="screenshot" "Screenshot" "Select a region to record"
|
||||
dt=$1
|
||||
ffcast -q "$(slop -n -f '-g %g ' && countdown)" rec "$screenshot_directory/$dt.mp4"
|
||||
notify-send --app-name="screenshot" "Screenshot" "Saved to ${screenshot_directory//${HOME}/~}/$dt.mp4"
|
||||
}
|
||||
|
||||
rvstf() {
|
||||
countdown
|
||||
dt=$1
|
||||
ffcast -q rec "$screenshot_directory/$dt.mp4"
|
||||
notify-send --app-name="screenshot" "Screenshot" "Saved to ${screenshot_directory//${HOME}/~}/$dt.mp4"
|
||||
}
|
||||
|
||||
stop_recording() {
|
||||
if [ -z "$(pgrep -fxn '(/\S+)*ffmpeg\s.*\sx11grab\s.*')" ]; then
|
||||
notify-send --app-name="screenshot" "Screenshot" "No recording found"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
pkill -fxn '(/\S+)*ffmpeg\s.*\sx11grab\s.*'
|
||||
notify-send --app-name="screenshot" "Screenshot" "Recording stopped"
|
||||
}
|
||||
|
||||
get_options() {
|
||||
echo " Region Clip"
|
||||
echo " Region File"
|
||||
echo " Screen Clip"
|
||||
echo " Screen File"
|
||||
echo " Region File (GIF)"
|
||||
echo " Screen File (GIF)"
|
||||
echo " Region File (MP4)"
|
||||
echo " Screen File (MP4)"
|
||||
echo " Stop recording"
|
||||
}
|
||||
|
||||
check_deps() {
|
||||
if ! hash "$1" 2>/dev/null; then
|
||||
echo "Error: This script requires $1"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
show_help() {
|
||||
echo ### rofi-screenshot
|
||||
echo "USAGE: rofi-screenshot [OPTION] <argument>"
|
||||
echo "(no option)"
|
||||
echo " show the screenshot menu"
|
||||
echo "-s, --stop"
|
||||
echo " stop recording"
|
||||
echo "-h, --help"
|
||||
echo " this screen"
|
||||
echo "-d, --directory <directory>"
|
||||
echo " set the screenshot directory"
|
||||
echo "-t, --timestamp <format>"
|
||||
echo " set the format used for timestamps, in the format the date"
|
||||
echo " command expects (default '+%d-%m-%Y %H:%M:%S')"
|
||||
}
|
||||
|
||||
check_directory() {
|
||||
if [[ ! -d $1 ]]; then
|
||||
echo "Directory does not exist!"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
main() {
|
||||
# check dependencies
|
||||
check_deps slop
|
||||
check_deps ffcast
|
||||
check_deps ffmpeg
|
||||
check_deps xclip
|
||||
check_deps rofi
|
||||
|
||||
# rebind long args as short ones
|
||||
for arg in "$@"; do
|
||||
shift
|
||||
case "$arg" in
|
||||
'--help') set -- "$@" '-h' ;;
|
||||
'--directory') set -- "$@" '-d' ;;
|
||||
'--timestamp') set -- "$@" '-t' ;;
|
||||
'--stop') set -- "$@" '-s' ;;
|
||||
*) set -- "$@" "$arg" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# parse short options
|
||||
OPTIND=1
|
||||
date_format="$default_date_format"
|
||||
while getopts "hd:t:s" opt; do
|
||||
case "$opt" in
|
||||
'h')
|
||||
show_help
|
||||
exit 0
|
||||
;;
|
||||
'd')
|
||||
check_directory $OPTARG
|
||||
screenshot_directory="$OPTARG"
|
||||
;;
|
||||
't')
|
||||
date_format="$OPTARG"
|
||||
;;
|
||||
's')
|
||||
stop_recording
|
||||
exit 0
|
||||
;;
|
||||
'?')
|
||||
show_help
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
shift $(expr $OPTIND - 1)
|
||||
|
||||
# Get choice from rofi
|
||||
choice=$( (get_options) | rofi -dmenu -i -fuzzy -p "Screenshot")
|
||||
|
||||
# If user has not picked anything, exit
|
||||
if [[ -z "${choice// /}" ]]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cmd='date "${date_format}"'
|
||||
dt=$(eval $cmd)
|
||||
|
||||
# run the selected command
|
||||
case $choice in
|
||||
' Region Clip')
|
||||
crtc
|
||||
;;
|
||||
' Region File')
|
||||
crtf "$dt"
|
||||
;;
|
||||
' Screen Clip')
|
||||
cstc
|
||||
;;
|
||||
' Screen File')
|
||||
cstf "$dt"
|
||||
;;
|
||||
' Region File (GIF)')
|
||||
rgrtf "$dt"
|
||||
;;
|
||||
' Screen File (GIF)')
|
||||
rgstf "$dt"
|
||||
;;
|
||||
' Region File (MP4)')
|
||||
rvrtf "$dt"
|
||||
;;
|
||||
' Screen File (MP4)')
|
||||
rvstf "$dt"
|
||||
;;
|
||||
' Stop recording')
|
||||
stop_recording
|
||||
;;
|
||||
esac
|
||||
|
||||
# done
|
||||
set -e
|
||||
}
|
||||
|
||||
main "$@" &
|
||||
|
||||
exit 0
|
||||
|
||||
! /bin/bash
|
||||
@@ -0,0 +1,75 @@
|
||||
#!/usr/bin/sh
|
||||
## https://github.com/danrog303/rofi-screenshot/tree/main
|
||||
|
||||
# CONFIG
|
||||
SAVE_DIR=$(xdg-user-dir PICTURES)
|
||||
# END CONFIG
|
||||
|
||||
# LANGUAGE STRINGS
|
||||
lang_scr_whole="📷 Screenshot of whole screen"
|
||||
lang_scr_fragment="📷 Screenshot of selected region"
|
||||
|
||||
lang_delay="⏰ Delay:"
|
||||
lang_nodelay="🕰 No delay"
|
||||
|
||||
lang_save_png="🖼️ Save as png"
|
||||
lang_save_jpg="🖼️ Save as jpg"
|
||||
lang_copy_clipboard="🖼️ Copy to clipboard"
|
||||
|
||||
lang_copied="Screenshot copied to clipboard"
|
||||
lang_saved="Screenshot saved to file"
|
||||
# END OF LANGUAGE STRINGS
|
||||
|
||||
rofi_delay=$(
|
||||
printf "%s 1s\n%s 3s\n%s 5s\n%s 10s\n%s\n" \
|
||||
"$lang_delay" "$lang_delay" "$lang_delay" "$lang_delay" "$lang_nodelay" |
|
||||
rofi -dmenu -p "screenshot" -lines 5
|
||||
) || exit 2
|
||||
|
||||
rofi_save_method=$(
|
||||
printf "%s\n%s\n%s\n" "$lang_save_png" "$lang_save_jpg" "$lang_copy_clipboard" |
|
||||
rofi -dmenu -p "screenshot" -lines 3
|
||||
) || exit 3
|
||||
|
||||
rofi_scr_type=$(
|
||||
printf "%s\n%s\n" "$lang_scr_whole" "$lang_scr_fragment" |
|
||||
rofi -dmenu -p "screenshot" -lines 2
|
||||
) || exit 4
|
||||
|
||||
if [ "$rofi_scr_type" = "$lang_scr_fragment" ]; then
|
||||
screen_fragment=$(slop --highlight --tolerance=0 --color=0.3,0.4,0.6,0.4 -n -f '-g %g ')
|
||||
fi
|
||||
|
||||
if [ "$rofi_delay" = "$lang_delay 1s" ]; then
|
||||
sleep 1
|
||||
elif [ "$rofi_delay" = "$lang_delay 3s" ]; then
|
||||
sleep 3
|
||||
elif [ "$rofi_delay" = "$lang_delay 5s" ]; then
|
||||
sleep 5
|
||||
elif [ "$rofi_delay" = "$lang_delay 10s" ]; then
|
||||
sleep 10
|
||||
fi
|
||||
|
||||
filename="Screenshot $(date '+%Y-%m-%d, %R:%S')"
|
||||
filepath="$SAVE_DIR/$filename.png"
|
||||
tempfilepath="/tmp/$filename.png"
|
||||
|
||||
if [ "$rofi_scr_type" = "$lang_scr_fragment" ]; then
|
||||
ffcast -q "$screen_fragment" png "$tempfilepath"
|
||||
else
|
||||
ffcast -q png "$tempfilepath"
|
||||
fi
|
||||
|
||||
if [ "$rofi_save_method" = "$lang_copy_clipboard" ]; then
|
||||
xclip -selection clipboard -t "image/png" "$tempfilepath"
|
||||
notify-send "$lang_copied"
|
||||
elif [ "$rofi_save_method" = "$lang_save_jpg" ]; then
|
||||
convert "/tmp/$filename.png" "/tmp/$filename.jpg"
|
||||
cp "/tmp/$filename.jpg" "$SAVE_DIR"
|
||||
notify-send "$lang_saved" "$SAVE_DIR/$filename.jpg"
|
||||
else
|
||||
cp "$tempfilepath" "$filepath"
|
||||
notify-send "$lang_saved" "$SAVE_DIR/$filename.png"
|
||||
fi
|
||||
|
||||
rm "$tempfilepath"
|
||||
@@ -58,7 +58,7 @@ color_bg3 = '#a6adc8'
|
||||
color_blue = '#9399b2'
|
||||
color_aqua = '#6c7086'
|
||||
color_green = '#98971a'
|
||||
color_orange = '#1e1e2e'
|
||||
color_orange = '#11111b'
|
||||
color_purple = '#b16286'
|
||||
color_red = '#cc241d'
|
||||
color_yellow = '#45475a'
|
||||
@@ -173,13 +173,6 @@ symbol = ""
|
||||
style = "bg:color_bg3"
|
||||
format = '[[ $symbol( $context) ](fg:#83a598 bg:color_bg3)]($style)'
|
||||
|
||||
[elm]
|
||||
# disabled = true
|
||||
symbol = " " # original
|
||||
# symbol = " " # clearer
|
||||
style = "bg:#3E92D2 fg:#EEEEEE"
|
||||
format = "[[ ](bg:#464347 fg:#3E92D2)$symbol$version[](bg:#464347 fg:#3E92D2)]($style)"
|
||||
|
||||
[helm]
|
||||
# disabled = true
|
||||
symbol = "ﴱ "
|
||||
@@ -188,7 +181,7 @@ format = "[[ ](bg:#464347 fg:#0F1689)$symbol$version[](bg:#464347 fg:#0F16
|
||||
|
||||
[hostname]
|
||||
ssh_only = false
|
||||
trim_at = ""
|
||||
trim_at = "-"
|
||||
style = "bg:color_orange fg:color_fg0"
|
||||
disabled = false
|
||||
format = "[$hostname]($style)"
|
||||
|
||||
@@ -0,0 +1,329 @@
|
||||
@import "theme/catppuccin-mocha.css";
|
||||
|
||||
* {
|
||||
border: none;
|
||||
border-radius: 10px;
|
||||
/*font-family: VictorMono, Iosevka Nerd Font, Noto Sans CJK;*/
|
||||
font-family: JetbrainsMono Nerd Font;
|
||||
font-size: 14px;
|
||||
font-style: normal;
|
||||
min-height: 0;
|
||||
}
|
||||
|
||||
window#waybar {
|
||||
background: transparent;
|
||||
color: @text;
|
||||
|
||||
}
|
||||
|
||||
#custom-launcher {
|
||||
color: @text;
|
||||
background-color: @surface0;
|
||||
border-radius: 0px 24px 0px 0px;
|
||||
margin: 5px 0px 5px 0px;
|
||||
padding: 0 20px 0 10px;
|
||||
/*border-right: solid 1px #282738;*/
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
#custom-launcher button:hover {
|
||||
background-color: @red;
|
||||
border-radius: 8px;
|
||||
margin-right: -5px;
|
||||
margin-left: 10px;
|
||||
}
|
||||
|
||||
#workspaces {
|
||||
background: @base;
|
||||
margin: 5px;
|
||||
padding: 0px 5px 0px 5px;
|
||||
border-radius: 10px;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
font-size: 40px;
|
||||
}
|
||||
|
||||
#workspaces button {
|
||||
padding: 0px 5px;
|
||||
color: @overlay0;
|
||||
/* opacity: 0.2; */
|
||||
}
|
||||
|
||||
#workspaces button.empty {
|
||||
color: @surface0;
|
||||
}
|
||||
|
||||
#workspaces button.visible {
|
||||
color: @blue;
|
||||
}
|
||||
|
||||
#workspaces button.active {
|
||||
color: @lavender;
|
||||
}
|
||||
|
||||
#workspaces button:hover {
|
||||
color: @mauve;
|
||||
}
|
||||
|
||||
#mpd {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin: 5px 0px 5px 0px;
|
||||
padding: 0px 10px 0px 10px;
|
||||
}
|
||||
|
||||
#custom-weather {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin: 5px;
|
||||
padding: 0px 10px 0px 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#network {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
padding: 0px 10px 0px 10px;
|
||||
margin: 5px 0px 5px 0px;
|
||||
}
|
||||
|
||||
#memory {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 10px;
|
||||
margin: 5px;
|
||||
padding: 0px 10px 0px 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#cpu {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin: 5px;
|
||||
padding: 0px 10px 0px 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#wireplumber {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 10px;
|
||||
margin: 5px;
|
||||
margin-left: 5px;
|
||||
margin-right: 5px;
|
||||
padding: 0px 10px 0px 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#custom-screenshot {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 0px;
|
||||
border-top-left-radius: 10px 10px;
|
||||
border-bottom-left-radius: 10px 10px;
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
padding: 0px 0px 0px 15px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#custom-wall_picker {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
border-radius: 0px;
|
||||
padding: 0px 15px 0px 15px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#idle_inhibitor {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 0px;
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
padding: 0px 15px 0px 5px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#custom-notification {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 0px;
|
||||
border-top-right-radius: 10px 10px;
|
||||
border-bottom-right-radius: 10px 10px;
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
padding: 0px 15px 0px 5px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#tray {
|
||||
background-color: @surface0;
|
||||
margin: 5px;
|
||||
padding: 0px 5px;
|
||||
/*border-right: solid 1px #282738;*/
|
||||
}
|
||||
|
||||
#clock.date {
|
||||
color: @text;
|
||||
background-color: @surface0;
|
||||
border-radius: 0px;
|
||||
border-top-left-radius: 10px 10px;
|
||||
border-bottom-left-radius: 10px 10px;
|
||||
/* padding-left: 13px; */
|
||||
padding: 0px 5px 0px 15px;
|
||||
margin: 5px 0px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#clock.time {
|
||||
color: @text;
|
||||
background-color: @surface0;
|
||||
border-radius: 0px;
|
||||
border-top-right-radius: 10px 10px;
|
||||
border-bottom-right-radius: 10px 10px;
|
||||
padding: 0px 10px 0px 5px;
|
||||
margin: 5px 0px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#custom-powermenu {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin: 5px 10px 5px 5px;
|
||||
padding: 0px 5px 0px 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#battery {
|
||||
color: @text;
|
||||
}
|
||||
|
||||
#battery.charging {
|
||||
color: @text;
|
||||
}
|
||||
|
||||
#battery.warning:not(.charging) {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 5px 5px 5px 5px;
|
||||
}
|
||||
|
||||
#disk {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin: 5px;
|
||||
padding: 0px 10px 0px 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#pulseaudio {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
margin-left: 0px;
|
||||
}
|
||||
|
||||
#pulseaudio.muted {
|
||||
background: transparent;
|
||||
color: @text;
|
||||
margin-left: 0px;
|
||||
}
|
||||
|
||||
/* #custom-date { */
|
||||
/* color: @text; */
|
||||
/* } */
|
||||
|
||||
#backlight {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 0px 0px 0px 0px;
|
||||
margin: 5px;
|
||||
margin-left: 0px;
|
||||
margin-right: 0px;
|
||||
padding: 0px 0px;
|
||||
}
|
||||
|
||||
#custom-playerctl {
|
||||
background-color: @surface0;
|
||||
padding-left: 15px;
|
||||
padding-right: 14px;
|
||||
border-radius: 16px;
|
||||
/*border-left: solid 1px #282738;*/
|
||||
/*border-right: solid 1px #282738;*/
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
margin-left: 0px;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
#custom-playerlabel {
|
||||
background: transparent;
|
||||
padding-left: 10px;
|
||||
padding-right: 15px;
|
||||
border-radius: 16px;
|
||||
/*border-left: solid 1px #282738;*/
|
||||
/*border-right: solid 1px #282738;*/
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
#window {
|
||||
background: #282828;
|
||||
padding-left: 15px;
|
||||
padding-right: 15px;
|
||||
border-radius: 16px;
|
||||
/*border-left: solid 1px #282738;*/
|
||||
/*border-right: solid 1px #282738;*/
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
#custom-wf-recorder {
|
||||
padding: 0 20px;
|
||||
color: #e5809e;
|
||||
background-color: @surface0;
|
||||
}
|
||||
|
||||
#custom-hyprpicker {
|
||||
background-color: @surface0;
|
||||
color: @text;
|
||||
border-radius: 16px;
|
||||
margin: 5px;
|
||||
margin-left: 5px;
|
||||
margin-right: 5px;
|
||||
padding: 0px 11px 0px 9px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -----------------------------------------------------------------------------
|
||||
* Keyframes
|
||||
* -------------------------------------------------------------------------- */
|
||||
@keyframes blink-warning {
|
||||
70% {
|
||||
color: @white;
|
||||
}
|
||||
|
||||
to {
|
||||
color: @white;
|
||||
background-color: @peach;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes blink-critical {
|
||||
70% {
|
||||
color: @white;
|
||||
}
|
||||
|
||||
to {
|
||||
color: @white;
|
||||
background-color: @red;
|
||||
}
|
||||
}
|
||||
@@ -12,7 +12,7 @@ WhitePointGreen=799
|
||||
WhitePointBlue=799
|
||||
[Input]
|
||||
Options=2
|
||||
Source=MB5100
|
||||
Source=0
|
||||
PDFFileName=YYYY-MM-DD-0001+.pdf
|
||||
[Input-MX350]
|
||||
Mode=1
|
||||
@@ -29,10 +29,10 @@ WhitePointBlue=986
|
||||
WhitePointGreen=986
|
||||
[Prefs]
|
||||
StartupTip=15
|
||||
WindowXOffset=1283
|
||||
WindowYOffset=490
|
||||
WindowXSize=1270
|
||||
WindowYSize=702
|
||||
WindowXOffset=1086
|
||||
WindowYOffset=369
|
||||
WindowXSize=1268
|
||||
WindowYSize=701
|
||||
Language=3
|
||||
[Output]
|
||||
Copyright=Lokman Caliskan
|
||||
@@ -44,54 +44,32 @@ Sharpen=1
|
||||
Mode=2
|
||||
[Input-File-DocFeeder]
|
||||
ScanResolution=2
|
||||
AutoMedia=1
|
||||
[Filter-File-DocFeeder]
|
||||
Sharpen=1
|
||||
AutoFlatten=1
|
||||
[Input-MB5100-Flatbed]
|
||||
ScanResolution=3
|
||||
Media=0
|
||||
PreviewXOffset=139
|
||||
PreviewXSize=9921
|
||||
PreviewYSize=14031
|
||||
[Input-MB5100]
|
||||
Mode=2
|
||||
Mode=1
|
||||
[Input-MB5100-DuplexFeeder]
|
||||
ScanResolution=3
|
||||
Skew=156
|
||||
Media=2
|
||||
AutoMedia=2
|
||||
PreviewXOffset=139
|
||||
PreviewXSize=9921
|
||||
PreviewYSize=14031
|
||||
Rotation=2
|
||||
ScanResolution=2
|
||||
AutoSkew=1
|
||||
Skew=359
|
||||
[Crop-MB5100-DuplexFeeder]
|
||||
CropSize=15
|
||||
XSize=9921
|
||||
YSize=14031
|
||||
XSize=4961
|
||||
YSize=7016
|
||||
PreviewXSize=4961
|
||||
PreviewYSize=7016
|
||||
XCenter=5544
|
||||
YCenter=9176
|
||||
[Color-MB5100-DuplexFeeder]
|
||||
WhitePointRed=973
|
||||
WhitePointGreen=973
|
||||
WhitePointBlue=973
|
||||
[Input-MB5100-DocFeeder]
|
||||
Media=0
|
||||
PreviewXOffset=139
|
||||
PreviewXSize=9921
|
||||
PreviewYSize=14031
|
||||
ScanResolution=3
|
||||
AutoSkew=1
|
||||
Skew=63
|
||||
Media=0
|
||||
[Crop-MB5100-DocFeeder]
|
||||
CropSize=15
|
||||
XCenter=4960
|
||||
YCenter=7016
|
||||
XSize=9921
|
||||
YSize=14031
|
||||
Skew=-1125
|
||||
[Crop-MB5100-Flatbed]
|
||||
CropSize=15
|
||||
XCenter=4960
|
||||
YCenter=7016
|
||||
XSize=9921
|
||||
YSize=14031
|
||||
Skew=-1125
|
||||
XSize=4961
|
||||
YSize=7016
|
||||
PreviewXSize=4961
|
||||
PreviewYSize=7016
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
[VueScan]
|
||||
[Input-MX350-DocFeeder]
|
||||
Media=4
|
||||
AutoSkew=1
|
||||
Skew=250
|
||||
[Crop-MX350-Flatbed]
|
||||
PreviewXSize=9921
|
||||
PreviewYSize=14031
|
||||
[Color-MX350-Flatbed]
|
||||
WhitePointRed=799
|
||||
WhitePointGreen=799
|
||||
WhitePointBlue=799
|
||||
[Input]
|
||||
Options=2
|
||||
Source=0
|
||||
PDFFileName=YYYY-MM-DD-0001+.pdf
|
||||
[Input-MX350]
|
||||
Mode=1
|
||||
[Crop-MX350-DocFeeder]
|
||||
CropSize=15
|
||||
PreviewXOffset=139
|
||||
PreviewXSize=9921
|
||||
PreviewYSize=14031
|
||||
XSize=9921
|
||||
YSize=14031
|
||||
[Color-MX350-DocFeeder]
|
||||
WhitePointRed=986
|
||||
WhitePointBlue=986
|
||||
WhitePointGreen=986
|
||||
[Prefs]
|
||||
StartupTip=15
|
||||
WindowXOffset=1086
|
||||
WindowYOffset=369
|
||||
WindowXSize=1268
|
||||
WindowYSize=701
|
||||
Language=3
|
||||
[Output]
|
||||
Copyright=Lokman Caliskan
|
||||
LogFile=0
|
||||
PDFFileName=YYYY-MM-DD-0001+.pdf
|
||||
[Filter-MX350-DocFeeder]
|
||||
Sharpen=1
|
||||
[Input-File]
|
||||
Mode=2
|
||||
[Input-File-DocFeeder]
|
||||
ScanResolution=2
|
||||
[Filter-File-DocFeeder]
|
||||
Sharpen=1
|
||||
[Input-MB5100-Flatbed]
|
||||
ScanResolution=3
|
||||
[Input-MB5100]
|
||||
Mode=1
|
||||
[Input-MB5100-DuplexFeeder]
|
||||
ScanResolution=2
|
||||
AutoSkew=1
|
||||
Skew=359
|
||||
[Crop-MB5100-DuplexFeeder]
|
||||
CropSize=15
|
||||
XSize=4961
|
||||
YSize=7016
|
||||
PreviewXSize=4961
|
||||
PreviewYSize=7016
|
||||
[Input-MB5100-DocFeeder]
|
||||
ScanResolution=3
|
||||
Skew=63
|
||||
Media=1
|
||||
AutoMedia=1
|
||||
PreviewXOffset=139
|
||||
PreviewXSize=9921
|
||||
PreviewYSize=14031
|
||||
[Crop-MB5100-DocFeeder]
|
||||
CropSize=15
|
||||
XSize=9921
|
||||
YSize=14031
|
||||
PreviewXSize=4961
|
||||
PreviewYSize=7016
|
||||
XCenter=4960
|
||||
YCenter=7016
|
||||
Skew=-359
|
||||
@@ -0,0 +1,96 @@
|
||||
VueScan 9 x64 (9.7.99.20) Mar 29 2024 UTC+1 de Linux gcc 7 16 cpus
|
||||
Professional Edition l.caliskan@gmx.de
|
||||
0 Begin startup
|
||||
0 Calling mdns_open
|
||||
0 mDNS 4 AF_INET 192.168.2.100
|
||||
2 Calling prob_open
|
||||
2 prob: Searching for /dev/usbscanner devices
|
||||
2 prob: Searching for libusb devices
|
||||
3 [genesys] sane_init_impl: start
|
||||
3 [genesys] sane_init_impl: authorize == null
|
||||
3 [genesys] Genesys Logic backend: test 4850
|
||||
3 [genesys] sane_init_impl: completed
|
||||
3 prob: Found device: vid 0f0d pid 0085 bcd 0100 mfg "Unknown" mdl "Unknown" ser "Unknown" por "002"
|
||||
3 prob: Found device: vid 0b05 pid 1a52 bcd 0002 mfg "Unknown" mdl "Unknown" ser "Unknown" por "003"
|
||||
3 prob: Found device: vid 0b05 pid 19af bcd 0100 mfg "Unknown" mdl "Unknown" ser "Unknown" por "004"
|
||||
3 prob: Found device: vid 05e3 pid 0608 bcd 6090 mfg "Genesys" mdl "Unknown" ser "Unknown" por "005"
|
||||
3 prob: Found device: vid 046d pid c33c bcd 1901 mfg "Logitech" mdl "Unknown" ser "Unknown" por "006"
|
||||
3 prob: Found device: vid 0e8d pid 0608 bcd 0100 mfg "Unknown" mdl "Unknown" ser "Unknown" por "007"
|
||||
3 prob: Found device: vid 3329 pid 4b19 bcd 0100 mfg "Unknown" mdl "Unknown" ser "Unknown" por "003"
|
||||
3 prob: Found device: vid 174c pid 2074 bcd 0001 mfg "Unknown" mdl "Unknown" ser "Unknown" por "002"
|
||||
3 prob: Found device: vid 046d pid c08b bcd 2703 mfg "Logitech" mdl "Unknown" ser "Unknown" por "003"
|
||||
3 prob: Found device: vid 174c pid 3074 bcd 0001 mfg "Unknown" mdl "Unknown" ser "Unknown" por "002"
|
||||
3 prob: Found device: vid 045e pid 0719 bcd 0100 mfg "Microsoft" mdl "Unknown" ser "Unknown" por "002"
|
||||
3 prob: Getting mDNS devices
|
||||
3 prob: Listing devices being used
|
||||
3 Calling scan_open
|
||||
3 Searching for SCSI devices
|
||||
3 Calling vid1_open
|
||||
3 Calling net1_open
|
||||
3 Calling usbi_open
|
||||
3 Calling dot4_open
|
||||
3 Calling scsi_init
|
||||
3 Calling SetupLists
|
||||
3 Calling SetupControls
|
||||
4 Internet connection on
|
||||
4 Loading options
|
||||
4 Changed Input | Options 1 (Standard) 2 (Professional)
|
||||
4 Changed Output | PDF file name "YYYY-MM-DD-0001+.pdf"
|
||||
4 Changed Output | Copyright "Lokman Caliskan"
|
||||
4 Changed Output | Log file 1 (On) 0 (Off)
|
||||
4 Changed Prefs | Language 0 (Default) 3 (Deutsch)
|
||||
4 Changed Prefs | Startup tip 0 15
|
||||
4 Changed Prefs | Window x offset -1 59
|
||||
4 Changed Prefs | Window y offset -1 96
|
||||
4 Changed Prefs | Window x size 640 1268
|
||||
4 Changed Prefs | Window y size 480 701
|
||||
4 Changed Input | Mode 0 (Flatbed) 2 (Doc Feeder)
|
||||
4 Changed Color | Color balance 7 (White balance) 2 (Neutral)
|
||||
4 Changed Input | Scan resolution 0 (Auto) 2 (300 dpi)
|
||||
4 Changed Filter | Sharpen 0 (None) 1 (Light)
|
||||
4 Calling SetupTop
|
||||
4 Calling SetupCrp
|
||||
4 Startup complete
|
||||
4 ---------------------- Current source/mode settings ----------------------
|
||||
4 Source driver : disk
|
||||
4 Source make : Generic
|
||||
4 Source name : Doc Feeder
|
||||
4 Mode name 0 : Flatbed
|
||||
4 Mode name 1 : Transparency
|
||||
4 Mode name 2 : Doc Feeder
|
||||
4 Scanner mode : Doc Feeder
|
||||
4 Capabilities : 00002020
|
||||
4 file source : 00000020
|
||||
4 scan from preview required : 00002000
|
||||
4 Maximum positive exposure : 0
|
||||
4 Maximum negative exposure : 0
|
||||
4 Number of frames : 0
|
||||
4 Ready to scan : 0
|
||||
4 Device bits per sample : 8
|
||||
4 Device samples per pixel : 3
|
||||
4 Device width : 2550
|
||||
4 Device height : 3300
|
||||
4 Device dpi : 300
|
||||
4 Resolution 1 : 300
|
||||
4 Resolution 2 : 150
|
||||
4 Resolution 3 : 100
|
||||
4 Resolution 4 : 75
|
||||
4 Resolution 5 : 60
|
||||
4 Resolution 6 : 50
|
||||
4 Resolution 7 : 43
|
||||
4 Resolution 8 : 37
|
||||
4 --------------------------------------------------------------------------
|
||||
4 License Status - Valid
|
||||
4 **** Menu Help | Update
|
||||
9 **** Menu Help | About
|
||||
15 **** Menu Help | About
|
||||
19 Calling scan_clos
|
||||
19 [genesys] sane_exit_impl: start
|
||||
19 [genesys] sane_exit_impl: completed
|
||||
19 Calling scsi_term
|
||||
19 Calling dot4_clos
|
||||
19 Calling usbi_clos
|
||||
19 Calling vid1_clos
|
||||
19 Exiting scsi_clos
|
||||
19 Calling prob_clos
|
||||
19 Calling mdns_clos
|
||||
@@ -15,16 +15,16 @@
|
||||
"default": "",
|
||||
"active": "",
|
||||
"urgent": "",
|
||||
"special": "",
|
||||
"special": ""
|
||||
},
|
||||
"show-special": true,
|
||||
"persistent_workspaces": {
|
||||
"*": 7, // 8 workspaces by default on every monitor
|
||||
"*": 7 // 8 workspaces by default on every monitor
|
||||
// "HDMI-A-1": 3 // but only three on HDMI-A-1
|
||||
},
|
||||
// "all-outputs": true,
|
||||
"active-only": false,
|
||||
"disable-scroll": true,
|
||||
"disable-scroll": true
|
||||
},
|
||||
"wireplumber": {
|
||||
"format": "{volume}% <span font='14'>{icon}</span>",
|
||||
@@ -32,8 +32,10 @@
|
||||
"on-click": "pavucontrol",
|
||||
"on-click-middle": "wezterm -e pulsemixer",
|
||||
"on-click-right": "~/.config/hypr/scripts/wireplumber.py",
|
||||
"on-scroll-up": "pamixer -i 5",
|
||||
"on-scroll-down": "pamixer -d 5",
|
||||
"on-scroll-up": "volumectl +2%",
|
||||
"on-scroll-down": "volumectl -2%",
|
||||
// "on-scroll-up": "pamixer -i 5",
|
||||
// "on-scroll-down": "pamixer -d 5",
|
||||
"format-icons": {
|
||||
"headphone": "",
|
||||
"hands-free": "",
|
||||
@@ -45,8 +47,8 @@
|
||||
"",
|
||||
"",
|
||||
""
|
||||
],
|
||||
},
|
||||
]
|
||||
}
|
||||
},
|
||||
// "custom/themen": {
|
||||
// "format": "",
|
||||
@@ -60,7 +62,7 @@
|
||||
"tooltip": true,
|
||||
"interval": 1800,
|
||||
"exec": "wttrbar --location Hamburg --hide-conditions --main-indicator 'FeelsLikeC' --date-format '%d.%m.%Y'",
|
||||
"return-type": "json",
|
||||
"return-type": "json"
|
||||
},
|
||||
"custom/pulseaudio-cycle": {
|
||||
"return-type": "json",
|
||||
@@ -68,13 +70,13 @@
|
||||
"interval": "5s",
|
||||
"exec": "pactl --format=json list sinks | jq -cM --unbuffered \"map(select(.name == \\\"$(pactl get-default-sink)\\\"))[0].properties | [.\\\"media.name\\\",.\\\"alsa.name\\\",.\\\"node.nick\\\",.\\\"alsa.long_card_name\\\"] | map(select(length>0))[0] | {text:.}\"",
|
||||
"exec-if": "sleep 0.1", // Give enough time for `pactl get-default-sink` to update
|
||||
"on-click": "pactl --format=json list sinks short | jq -cM --unbuffered \"[.[].name] | .[((index(\\\"$(pactl get-default-sink)\\\")+1)%length)]\" | xargs pactl set-default-sink",
|
||||
"on-click": "pactl --format=json list sinks short | jq -cM --unbuffered \"[.[].name] | .[((index(\\\"$(pactl get-default-sink)\\\")+1)%length)]\" | xargs pactl set-default-sink"
|
||||
},
|
||||
"custom/screenshot": {
|
||||
"format": "<span font='14'> </span>",
|
||||
"on-click": "flameshot gui",
|
||||
// "on-click": "wofi --show drun -I -a -n -W 500 -H 376 -s ~/.config/wofi/themes/gruvbox.css",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh", //TODO: make rofi with selectable options (like edit/upload https://github.com/hyprwm/contrib/blob/main/grimblast/grimblast)
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh" //TODO: make rofi with selectable options (like edit/upload https://github.com/hyprwm/contrib/blob/main/grimblast/grimblast)
|
||||
// "on-click-right": "wofi --show run -I -a -n -W 500 -H 376 -s ~/.config/wofi/themes/gruvbox.css"
|
||||
},
|
||||
"custom/notification": {
|
||||
@@ -88,84 +90,40 @@
|
||||
"inhibited-notification": "<span foreground='red'><sup></sup></span>",
|
||||
"inhibited-none": "",
|
||||
"dnd-inhibited-notification": "<span foreground='red'><sup></sup></span>",
|
||||
"dnd-inhibited-none": "",
|
||||
"dnd-inhibited-none": ""
|
||||
},
|
||||
"return-type": "json",
|
||||
"exec-if": "which swaync-client",
|
||||
"exec": "swaync-client -swb",
|
||||
"on-click": "sleep 0.1 && swaync-client -t -sw",
|
||||
"on-click-right": "sleep 0.1 && swaync-client -d -sw",
|
||||
"escape": true,
|
||||
"escape": true
|
||||
},
|
||||
"idle_inhibitor": {
|
||||
"format": "<span font='16'>{icon}</span>",
|
||||
"format-icons": {
|
||||
"activated": "",
|
||||
"deactivated": "",
|
||||
},
|
||||
"deactivated": ""
|
||||
}
|
||||
},
|
||||
"custom/layout": {
|
||||
"format": "",
|
||||
"on-click": "sleep 0.1 && $HOME/.config/rofi/launcher.sh",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh"
|
||||
},
|
||||
"custom/powermenu": {
|
||||
"format": "⏻ ",
|
||||
"on-click": "sleep 0.1 && $HOME/.config/rofi/script/powermenu.sh",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh",
|
||||
"on-click": "wlogout",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh"
|
||||
},
|
||||
"custom/launcher": {
|
||||
// ngw-bar / rofi application luncher
|
||||
"format": "",
|
||||
"on-click": "anyrun",
|
||||
// "on-click": "wofi --show drun -I -a -n -W 500 -H 376 -s ~/.config/wofi/themes/gruvbox.css",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh",
|
||||
"on-click-right": "bash $HOME/.config/rofi/run.sh"
|
||||
// "on-click-right": "wofi --show run -I -a -n -W 500 -H 376 -s ~/.config/wofi/themes/gruvbox.css"
|
||||
},
|
||||
// "hyprland/window": {
|
||||
// "format": "{}",
|
||||
// "separate-outputs": true
|
||||
// "max-length": 12w0
|
||||
// },
|
||||
// "hyprland/workspaces": {
|
||||
// "format": "{name}: {icon}",
|
||||
// "format-icons": {
|
||||
// "1": "",
|
||||
// "2": "",
|
||||
// "3": "",
|
||||
// "4": "",
|
||||
// "default": ""
|
||||
// }
|
||||
// },
|
||||
// "wlr/workspaces": {
|
||||
// "persistent_workspaces": {
|
||||
// "2": [],
|
||||
// "3": [],
|
||||
// "4": [],
|
||||
// "5": [],
|
||||
// "6": [],
|
||||
// "7": [],
|
||||
// "8": []
|
||||
// },
|
||||
// "all-outputs": true,
|
||||
// "active-only": false,
|
||||
// "disable-scroll": true,
|
||||
// "format": "<span font='20'>{icon}</span> {name}",
|
||||
// "format-icons": {
|
||||
// "1": "", // Icon: firefox-browser
|
||||
// "2": "", // Icon: mail
|
||||
// "3": "", // Icon: code
|
||||
// "4": "", // Icon: terminal
|
||||
// "5": "", // Icon: terminal
|
||||
// "6": "", // Icon: terminal
|
||||
// "7": "", // Icon: terminal
|
||||
// "8": "", // Icon: terminal
|
||||
// "urgent": "",
|
||||
// "focused": "",
|
||||
// "default": ""
|
||||
// },
|
||||
// "on-click": "activate"
|
||||
// },
|
||||
"mpd": {
|
||||
"format": "{stateIcon} {artist} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S})",
|
||||
"format-disconnected": "Disconnected",
|
||||
@@ -178,16 +136,16 @@
|
||||
"interval": 2,
|
||||
"state-icons": {
|
||||
"paused": "",
|
||||
"playing": "",
|
||||
"playing": ""
|
||||
},
|
||||
"tooltip": "true",
|
||||
"tooltip-format": "MPD (connected)",
|
||||
"tooltip-format-disconnected": "MPD (disconnected)",
|
||||
"tooltip-format-disconnected": "MPD (disconnected)"
|
||||
},
|
||||
"clock#time": {
|
||||
"interval": 1,
|
||||
"format": " {:%H:%M:%S}",
|
||||
"tooltip": false,
|
||||
"tooltip": false
|
||||
},
|
||||
// "custom/wrap-left": {
|
||||
// "format": "<b>[</b>"
|
||||
@@ -196,7 +154,7 @@
|
||||
"interval": 10,
|
||||
"format": " {:%e %b %Y}", // Icon: calendar-alt
|
||||
"tooltip-format": "{:%e %B %Y}",
|
||||
"on-click": ".config/waybar/scripts/calendar.sh --popup",
|
||||
"on-click": ".config/waybar/scripts/calendar.sh --popup"
|
||||
},
|
||||
// "clock#2": {
|
||||
// "interval": 1,
|
||||
@@ -206,31 +164,32 @@
|
||||
"cpu": {
|
||||
"interval": 5,
|
||||
"format": "<span font='14'> </span>{usage}% ({load})", // Icon: microchip
|
||||
"on-click": "wezterm -e btop",
|
||||
"states": {
|
||||
"warning": 70,
|
||||
"critical": 90,
|
||||
},
|
||||
"critical": 90
|
||||
}
|
||||
},
|
||||
"disk": {
|
||||
"format": "<span font='16'></span>{}%",
|
||||
"format-alt": "<span font='16'></span>{used}/{total} GiB",
|
||||
"interval": 5,
|
||||
"path": "/mnt/Datos",
|
||||
"path": "/mnt/Daten"
|
||||
},
|
||||
"memory": {
|
||||
"interval": 5,
|
||||
"format": "<span font='14'> </span>{}%", // Icon: memory
|
||||
"states": {
|
||||
"warning": 70,
|
||||
"critical": 90,
|
||||
},
|
||||
"critical": 90
|
||||
}
|
||||
},
|
||||
"network": {
|
||||
"interval": 10,
|
||||
"format-wifi": " {essid} ({signalStrength}%)", // Icon: wifi
|
||||
"format-ethernet": " {ifname}: {ipaddr}/{cidr}", // Icon: ethernet
|
||||
"format-disconnected": "⚠ Disconnected",
|
||||
"tooltip-format": "{ifname}: {ipaddr}",
|
||||
"tooltip-format": "{ifname}: {ipaddr}"
|
||||
},
|
||||
// "hyprland/submap": {
|
||||
// "format": "✌️ {}",
|
||||
@@ -239,17 +198,17 @@
|
||||
// },
|
||||
"tray": {
|
||||
"icon-size": 20,
|
||||
"spacing": 5,
|
||||
"spacing": 5
|
||||
},
|
||||
"custom/wall_picker": {
|
||||
"format": "<span font='16'></span>",
|
||||
"on-click": "exec $HOME/.config/hypr/scripts/wallpaper.sh changer",
|
||||
"on-click-right": "bash $HOME/.config/hypr/wall_random_picker.sh",
|
||||
"on-click-right": "bash $HOME/.config/hypr/wall_random_picker.sh"
|
||||
},
|
||||
"custom/hyprpicker": {
|
||||
"format": "",
|
||||
"on-click": "hyprpicker -a -f hex",
|
||||
"on-click-right": "hyprpicker -a -f rgb",
|
||||
"on-click-right": "hyprpicker -a -f rgb"
|
||||
},
|
||||
"bluetooth": {
|
||||
"format": " {status}",
|
||||
@@ -258,7 +217,7 @@
|
||||
"tooltip-format": "{device_alias}",
|
||||
"format-connected-battery": " {device_alias} {device_battery_percentage}%",
|
||||
"tooltip-format-enumerate-connected": "{device_alias}",
|
||||
"on-click": "btblock",
|
||||
"on-click": "btblock"
|
||||
},
|
||||
// "temperature": {
|
||||
// "critical-threshold": 80,
|
||||
|
||||
@@ -45,23 +45,27 @@ window#waybar {
|
||||
|
||||
#workspaces button {
|
||||
padding: 0px 5px;
|
||||
color: #928374;
|
||||
color: @overlay0;
|
||||
transition: all 0.6s ease-in-out;
|
||||
/* opacity: 0.2; */
|
||||
}
|
||||
|
||||
#workspaces button.active {
|
||||
color: #bbd9e1;
|
||||
background-color: @surface0;
|
||||
#workspaces button.empty {
|
||||
color: @surface0;
|
||||
}
|
||||
|
||||
/* #workspaces button.persistent { */
|
||||
/* color: yellow; */
|
||||
/* font-size: 12px; */
|
||||
/* } */
|
||||
#workspaces button.visible {
|
||||
color: @blue;
|
||||
}
|
||||
|
||||
#workspaces button.active {
|
||||
color: @lavender;
|
||||
transition: all 0.3s ease-in-out;
|
||||
}
|
||||
|
||||
#workspaces button:hover {
|
||||
background-color: @surface0;
|
||||
color: black;
|
||||
color: @blue;
|
||||
border-radius: 15px;
|
||||
}
|
||||
|
||||
#mpd {
|
||||
@@ -305,24 +309,52 @@ window#waybar {
|
||||
/* -----------------------------------------------------------------------------
|
||||
* Keyframes
|
||||
* -------------------------------------------------------------------------- */
|
||||
@keyframes blink-warning {
|
||||
70% {
|
||||
color: @white;
|
||||
|
||||
@keyframes alert-notification {
|
||||
from {
|
||||
color: #ff2222;
|
||||
}
|
||||
|
||||
to {
|
||||
color: @white;
|
||||
background-color: @peach;
|
||||
color: #990000;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes blink-critical {
|
||||
70% {
|
||||
color: @white;
|
||||
|
||||
|
||||
/* @keyframes blink-recording { */
|
||||
/* from { color: #ff2222; } */
|
||||
/* to { color: #990000; } */
|
||||
/* } */
|
||||
/**/
|
||||
/* #custom-recording { */
|
||||
/* padding: 0 8px 0 8px; */
|
||||
/* min-width: 60px; */
|
||||
/* animation-duration: 1s; */
|
||||
/* animation-iteration-count: infinite; */
|
||||
/* animation-direction: alternate; */
|
||||
/* animation-name: blink-recording; */
|
||||
/* } */
|
||||
/* +#battery.critical:not(.charging) { */
|
||||
/* + background-color: #f53c3c; */
|
||||
/* + color: #ffffff; */
|
||||
/* + animation-name: blink; */
|
||||
/* + animation-duration: 0.5s; */
|
||||
/* + animation-timing-function: linear; */
|
||||
/* + animation-iteration-count: infinite; */
|
||||
/* + animation-direction: alternate; */
|
||||
/* +} */
|
||||
|
||||
|
||||
|
||||
@keyframes switch {
|
||||
from {
|
||||
padding-left: 18px;
|
||||
padding-right: 45px;
|
||||
}
|
||||
|
||||
to {
|
||||
color: @white;
|
||||
background-color: @red;
|
||||
padding-left: 18px;
|
||||
padding-right: 18px;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
alias ls='eza -h --icons --color=auto'
|
||||
alias ll='eza -lah --icons --color=auto'
|
||||
alias changebackground="feh --bg-fill --randomize ~/Bilder/Wallpaper_Wide/*"
|
||||
alias wetter='curl wttr.in/Ham'
|
||||
alias wetter='curl wttr.in/Hamburg'
|
||||
alias mpv="mpv --no-input-default-bindings"
|
||||
alias rename="perl-rename"
|
||||
alias diff="batdiff"
|
||||
|
||||
Reference in New Issue
Block a user