3 Commits

Author SHA1 Message Date
dc1743ba38 cleanup code 2025-08-07 21:37:40 -07:00
9d1b6d7eab fix for when categories are not set
Some checks failed
Luacheck / luacheck (push) Failing after 7m3s
2025-03-04 22:16:06 -08:00
c84eabf6c2 Update 2025-02 (#22)
Some checks failed
Luacheck / luacheck (push) Failing after 2m14s
* add documentation and update get_video_info

- change to json dump and use mpv native json reader

* add additional fields for history database

* update config file and readme

* clean up code

* disable debug
2025-02-16 14:17:15 -08:00
3 changed files with 730 additions and 745 deletions

View File

@@ -84,7 +84,7 @@ This script requires the following software to be installed on the system
- `ytdlp_file_format - mp4`: The preferred file format for downloaded videos
- `ytdlp_output_template - %(uploader)s/%(title)s.%(ext)s`: The [yt-dlp output template string](https://github.com/yt-dlp/yt-dlp#output-template)
- Full path with the default `download_directory` is: `~/videos/YouTube/<uploader>/<title>.<ext>`
- `use_history_db - no`: Enable watch history tracking through integration with [mpv-youtube-queue-server](https://gitea.suda.codes/sudacode/mpv-youtube-queue-server)
- `use_history_db - no`: Enable watch history tracking and remote video queuing through integration with [mpv-youtube-queue-server](https://gitea.suda.codes/sudacode/mpv-youtube-queue-server)
- `backend_host`: ip or hostname of the backend server
- `backend_port`: port to connect to for the backend server

View File

@@ -13,7 +13,7 @@ play_previous_in_queue=ctrl+p
print_current_video=ctrl+P
print_queue=ctrl+q
save_queue=ctrl+s
save_full_queue=ctrl+S
save_full_alt=ctrl+S
remove_from_queue=ctrl+x
play_selected_video=ctrl+ENTER
browser=firefox

View File

@@ -13,10 +13,11 @@
-- GNU General Public License for more details.
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <https://www.gnu.org/licenses/>.
local mp = require 'mp'
mp.options = require 'mp.options'
local utils = require 'mp.utils'
local assdraw = require 'mp.assdraw'
local mp = require("mp")
mp.options = require("mp.options")
local assdraw = require("mp.assdraw")
local msg = require("mp.msg")
local utils = require("mp.utils")
local styleOn = mp.get_property("osd-ass-cc/0")
local styleOff = mp.get_property("osd-ass-cc/1")
local YouTubeQueue = {}
@@ -29,7 +30,7 @@ local marked_index = nil
local current_video = nil
local destroyer = nil
local timeout
local debug = true
local debug = false
local options = {
add_to_queue = "ctrl+a",
@@ -66,7 +67,7 @@ local options = {
save_queue = "ctrl+s",
save_queue_alt = "ctrl+S",
default_save_method = "unwatched",
load_queue = "ctrl+l"
load_queue = "ctrl+l",
}
mp.options.read_options(options, "mpv-youtube-queue")
@@ -76,7 +77,8 @@ local function destroy()
destroyer = nil
end
timeout = mp.add_periodic_timer(options.menu_timeout, destroy)
timeout = mp.add_timeout(options.menu_timeout, destroy)
timeout:kill()
-- STYLE {{{
local colors = {
@@ -87,7 +89,7 @@ local colors = {
header = "8CFAF1",
hover = "F2F8F8",
text = "BFBFBF",
marked = "C679FF"
marked = "C679FF",
}
local notransparent = "\\alpha&H00&"
@@ -101,11 +103,17 @@ local style = {
cursor = "{\\c&" .. colors.cursor .. "&" .. notransparent .. "}",
marked = "{\\c&" .. colors.marked .. "&" .. notransparent .. "}",
reset = "{\\c&" .. colors.text .. "&" .. sortoftransparent .. "}",
header = "{\\fn" ..
options.font_name .. "\\fs" .. options.font_size * 1.5 .. "\\u1\\b1\\c&" .. colors.header .. "&" ..
notransparent .. "}",
header = "{\\fn"
.. options.font_name
.. "\\fs"
.. options.font_size * 1.5
.. "\\u1\\b1\\c&"
.. colors.header
.. "&"
.. notransparent
.. "}",
hover = "{\\c&" .. colors.hover .. "&" .. semitransparent .. "}",
font = "{\\fn" .. options.font_name .. "\\fs" .. options.font_size .. "{" .. sortoftransparent .. "}"
font = "{\\fn" .. options.font_name .. "\\fs" .. options.font_size .. "{" .. sortoftransparent .. "}",
}
-- }}}
@@ -115,63 +123,31 @@ local style = {
--- @param s string - the string to surround with quotes
--- @return string | nil - the string surrounded with quotes
local function surround_with_quotes(s)
if string.sub(s, 0, 1) == '"' and string.sub(s, -1) == '"' then
return nil
if type(s) ~= "string" then
return s
end
if string.sub(s, 1, 1) == '"' and string.sub(s, -1) == '"' then
return s
else
return '"' .. s .. '"'
end
end
--- Truncate a string to a maximum length, adding an ellipsis if truncated
--- @param str string The string to truncate
--- @param length number The maximum length
--- @param use_ellipsis? boolean Whether to add "..." (defaults to true)
--- @return string truncated The truncated string
local function truncate_string(str, length, use_ellipsis)
if use_ellipsis == nil then
use_ellipsis = true
end
if #str <= length then
return str
end
local truncated = string.sub(str, 1, length)
if use_ellipsis then
-- Remove last 3 chars to make room for ellipsis
truncated = string.sub(truncated, 1, length - 3) .. "..." .. '"'
end
return truncated
end
--- return true if the input is null, empty, or 0
--- @param s any - the input to check for nullity
--- @return boolean - true if the input is null, false otherwise
local function isnull(s)
-- Handle nil case
if s == nil then
return true
end
-- Handle empty string case
if type(s) == "string" and s:match("^%s*$") then
elseif type(s) == "string" and s:match("^%s*$") then
return true
elseif type(s) == "number" and s == 0 then
return true
elseif type(s) == "table" and next(s) == nil then
return true
elseif type(s) == "boolean" and not s then
return true
end
-- Handle numeric zero case
if type(s) == "number" and s == 0 then
return true
end
-- Handle empty table case
if type(s) == "table" and next(s) == nil then
return true
end
-- Handle false boolean case
if type(s) == "boolean" and not s then
return true
end
return false
end
@@ -203,13 +179,11 @@ end
---@return boolean - true if the path is a file, false otherwise
local function is_file(filepath)
local result = utils.file_info(filepath)
if debug and type(result) == "table" then
print("IS_FILE() check: " .. tostring(result.is_file))
end
msg.debug("IS_FILE() check: " .. tostring(result.is_file))
if result == nil or type(result) ~= "table" then
return false
end
return true
return result.is_file == true
end
---returns the filename given a path (eg. /home/user/file.txt -> file.txt)
@@ -244,8 +218,14 @@ end
---Open a URL in the browser
---@param url string
local function open_url_in_browser(url)
local command = options.browser .. " " .. surround_with_quotes(url)
os.execute(command)
if isnull(url) then
return
end
mp.command_native({
name = "subprocess",
detach = true,
args = { options.browser, url },
})
end
--- Opens the current video in the browser
@@ -263,12 +243,12 @@ local function open_channel_in_browser()
end
-- Internal function to print the contents of the internal playlist to the console
local function _print_internal_playlist()
local function print_internal_playlist()
local count = mp.get_property_number("playlist-count")
print("Playlist contents:")
msg.info("Playlist contents:")
for i = 0, count - 1 do
local uri = mp.get_property(string.format("playlist/%d/filename", i))
print(string.format("%d: %s", i, uri))
msg.info(string.format("%d: %s", i, uri))
end
end
@@ -276,20 +256,19 @@ end
--- @param prefix string - the prefix to add to the row
--- @param s string - the style to apply to the row
--- @param i number - the index of the row
--- @param title string - the title of the video
--- @param video_name string - the title of the video
--- @param channel_name string - the name of the channel
--- @return string - the OSD row
local function _build_osd_row(prefix, s, i, title, channel_name)
return prefix .. s .. i .. ". " .. title .. " - (" .. channel_name .. ")"
local function build_osd_row(prefix, s, i, video_name, channel_name)
return prefix .. s .. i .. ". " .. video_name .. " - (" .. channel_name .. ")"
end
--- Helper function to determine display range for queue items
--- @param queue_length number Total number of items in queue
--- @param selected number Currently selected index
--- @param limit number Maximum items to display
--- @return number, number start and end indices
local function _get_display_range(queue_length, selected, limit)
local function get_display_range(queue_length, selected, limit)
local half_limit = math.floor(limit / 2)
local start_index = selected <= half_limit and 1 or selected - half_limit
local end_index = math.min(start_index + limit - 1, queue_length)
@@ -301,7 +280,7 @@ end
--- @param current number Currently playing index
--- @param selected number Selected index
--- @return string Style to apply
local function _get_item_style(i, current, selected)
local function get_item_style(i, current, selected)
if i == current and i == selected then
return style.hover_selected
elseif i == current then
@@ -322,13 +301,13 @@ local function toggle_print()
end
-- Function to remove leading and trailing quotes from the first and last arguments of a command table in-place
local function _remove_command_quotes(s)
local function remove_command_quotes(s)
-- if the first character of the first argument is a quote, remove it
if string.sub(s[1], 1, 1) == "'" or string.sub(s[1], 1, 1) == "\"" then
if string.sub(s[1], 1, 1) == "'" or string.sub(s[1], 1, 1) == '"' then
s[1] = string.sub(s[1], 2)
end
-- if the last character of the last argument is a quote, remove it
if string.sub(s[#s], -1) == "'" or string.sub(s[#s], -1) == "\"" then
if string.sub(s[#s], -1) == "'" or string.sub(s[#s], -1) == '"' then
s[#s] = string.sub(s[#s], 1, -2)
end
end
@@ -336,171 +315,30 @@ end
--- Function to split the clipboard_command into it's parts and return as a table
--- @param cmd string - the command to split
--- @return table - the split command as a table
local function _split_command(cmd)
local function split_command(cmd)
local components = {}
for arg in cmd:gmatch("%S+") do
table.insert(components, arg)
end
_remove_command_quotes(components)
remove_command_quotes(components)
return components
end
--- Add a video to the history database
--- @param v table - the video to add to the history database
--- @return boolean - true if the video was added successfully, false otherwise
function YouTubeQueue._add_to_history_db(v)
if not options.use_history_db then
return false
end
local url = options.backend_host .. ":" .. options.backend_port .. "/add_video"
local command = { "curl", "-X", "POST", url, "-H", "Content-Type: application/json", "-d",
string.format(
'{"video_url": "%s", "video_name": "%s", "channel_url": "%s", "channel_name": "%s", "category": "%s", "view_count": "%s", "upload_date": "%s", "thumbnail_url": "%s", "subscribers": "%s"}',
v.video_url, v.title, v.channel_url, v.channel_name, v.category, v.view_count, v.upload_date, v
.thumbnail_url, v.subscribers) }
if debug then
print("Adding video to history")
-- print("Command: " .. table.concat(command, " "))
end
mp.command_native_async({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command
}, function(success, _, err)
if not success then
print_osd_message("Failed to send video data to backend: " .. err, MSG_DURATION, style.error)
return false
end
end)
return true
end
--- Returns a list of URLs in the queue from start_index to the end
--- @param start_index number - the index to start from
--- @return table | nil - a table of URLs
function YouTubeQueue._get_urls(start_index)
if start_index < 0 or start_index > #video_queue then
return nil
end
local urls = {}
for i = start_index + 1, #video_queue do
table.insert(urls, video_queue[i].video_url)
end
return urls
end
--- Converts key value pairs to a json string
--- @param key any - json key
--- @param val any - json value
--- @return string | nil - the json string
function YouTubeQueue._convert_to_json(key, val)
if val == nil then
return
end
if type(val) ~= "table" then
-- For non-table values, properly quote strings and format numbers
if type(val) == "string" then
return string.format('{"%s": "%s"}', key, val)
--- Converts a key-value pair or a table of key-value pairs into a JSON string.
--- If the key is a table, it iterates over the table to construct a JSON object.
--- If the key is a single value, it constructs a JSON object with the provided key and value.
--- @param key any - A single key or a table of key-value pairs to convert.
--- @param val any - The value associated with the key, used only if the key is not a table.
--- @return string | nil - The resulting JSON string, or nil if the input is invalid.
local function convert_to_json(key, val)
if type(key) == "table" then
return utils.format_json(key)
else
return string.format('{"%s": %s}', key, tostring(val))
local t = {}
t[key] = val
return utils.format_json(t)
end
end
local json = string.format('{"%s": [', key)
for i, v in ipairs(val) do
json = json .. '"' .. v .. '"'
if i < #val then
json = json .. ", "
end
end
json = json .. "]}"
return json
end
--- Saves the remainder of the videos in the queue (all videos after the currently playing video) to the history database
--- @param idx number - the index to start saving from
--- @return boolean - true if the queue was saved successfully, false otherwise
function YouTubeQueue.save_queue(idx)
if not options.use_history_db then
return false
end
if idx == nil then
idx = index
end
local url = options.backend_host .. ":" .. options.backend_port .. "/save_queue"
local data = YouTubeQueue._convert_to_json("urls", YouTubeQueue._get_urls(idx + 1))
if data == nil or data == '{"urls": []}' then
print_osd_message("Failed to save queue: No videos remaining in queue", MSG_DURATION, style.error)
return false
end
if debug then
print("Data: " .. data)
end
local command = { "curl", "-X", "POST", url, "-H", "Content-Type: application/json", "-d", data }
if debug then
print("Saving queue to history")
print("Command: " .. table.concat(command, " "))
end
mp.command_native_async({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command
}, function(success, result, err)
if not success then
print_osd_message("Failed to save queue: " .. err, MSG_DURATION, style.error)
return false
end
if debug then
print("Status: " .. result.status)
end
if result.status == 0 then
if idx > 1 then
print_osd_message("Queue saved to history from index: " .. idx, MSG_DURATION)
else
print_osd_message("Queue saved to history.", MSG_DURATION)
end
end
end)
return true
end
-- loads the queue from the backend
function YouTubeQueue.load_queue()
if not options.use_history_db then
return false
end
local url = options.backend_host .. ":" .. options.backend_port .. "/load_queue"
local command = { "curl", "-X", "GET", url }
mp.command_native_async({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command
}, function(success, result, err)
if not success then
print_osd_message("Failed to load queue: " .. err, MSG_DURATION, style.error)
return false
else
if result.status == 0 then
-- split urls based on commas
local urls = {}
-- Remove the brackets from json list
local l = result.stdout:sub(2, -3)
local item
for turl in l:gmatch('[^,]+') do
item = turl:match("^%s*(.-)%s*$"):gsub('"', "'")
table.insert(urls, item)
end
for _, turl in ipairs(urls) do
YouTubeQueue.add_to_queue(turl, 0)
end
print_osd_message("Loaded queue from history.", MSG_DURATION)
end
end
end)
end
-- }}}
@@ -517,15 +355,15 @@ function YouTubeQueue.get_video_at(idx)
return video_queue[idx]
end
-- returns the content of the clipboard
-- @return string - the content of the clipboard
--- returns the content of the clipboard
--- @return string | nil - the content of the clipboard
function YouTubeQueue.get_clipboard_content()
local command = _split_command(options.clipboard_command)
local command = split_command(options.clipboard_command)
local res = mp.command_native({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command
args = command,
})
if res.status ~= 0 then
@@ -544,22 +382,30 @@ function YouTubeQueue.get_clipboard_content()
end
end
-- Function to get the video info from the URL
-- @param url string - the URL to get the video info from
-- @return string, string, string - the channel URL, channel name, and title of the video
--- Function to get the video info from the URL
--- @param url string - the URL to get the video info from
--- @return table | nil - a table containing the video information
function YouTubeQueue.get_video_info(url)
print_osd_message("Getting video info...", MSG_DURATION * 2)
local res = mp.command_native({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = { "yt-dlp", "--dump-single-json", "--ignore-config", "--no-warnings", "--skip-download",
"--playlist-items", "1", url }
args = {
"yt-dlp",
"--dump-single-json",
"--ignore-config",
"--no-warnings",
"--skip-download",
"--playlist-items",
"1",
url,
},
})
if res.status ~= 0 or isnull(res.stdout) then
print_osd_message("Failed to get video info (yt-dlp error)", MSG_DURATION, style.error)
print("yt-dlp status: " .. res.status)
msg.warn("yt-dlp status: " .. res.status)
return nil
end
@@ -569,19 +415,25 @@ function YouTubeQueue.get_video_info(url)
return nil
end
local category = nil
if data.categories then
category = data.categories[1]
else
category = "Unknown"
end
local info = {
channel_url = data.channel_url or "",
channel_name = data.uploader or "",
title = data.title or "",
video_name = data.title or "",
view_count = data.view_count or "",
upload_date = data.upload_date or "",
category = data.categories[1] or "",
category = category or "",
thumbnail_url = data.thumbnail or "",
subscribers = data.channel_follower_count or ""
subscribers = data.channel_follower_count or 0,
}
if isnull(info.channel_url) or isnull(info.channel_name) or isnull(info.title) then
print_osd_message("Missing metadata (channel_url, uploader, title) in JSON", MSG_DURATION, style.error)
if isnull(info.channel_url) or isnull(info.channel_name) or isnull(info.video_name) then
print_osd_message("Missing metadata (channel_url, uploader, video_name) in JSON", MSG_DURATION, style.error)
return nil
end
@@ -592,11 +444,11 @@ end
function YouTubeQueue.print_current_video()
destroy()
local current = current_video
if current and current.vidro_url ~= "" and is_file(current.video_url) then
if current and current.video_url ~= "" and is_file(current.video_url) then
print_osd_message("Playing: " .. current.video_url, 3)
else
if current and current.video_url then
print_osd_message("Playing: " .. current.title .. ' by ' .. current.channel_name, 3)
print_osd_message("Playing: " .. current.video_name .. " by " .. current.channel_name, 3)
end
end
end
@@ -611,10 +463,10 @@ end
--- @return table | nil - the video at the new index
function YouTubeQueue.set_video(direction)
local amt
direction = string.upper(direction)
if (direction == "NEXT" or direction == nil) then
direction = (direction and string.upper(direction)) or "NEXT"
if direction == "NEXT" or direction == nil then
amt = 1
elseif (direction == "PREV" or direction == "PREVIOUS") then
elseif direction == "PREV" or direction == "PREVIOUS" then
amt = -1
else
print_osd_message("Invalid direction: " .. direction, MSG_DURATION, style.error)
@@ -645,9 +497,7 @@ end
--- @param update_history boolean - whether to update the history database
--- @return number | nil - the index of the currently playing video
function YouTubeQueue.update_current_index(update_history)
if debug then
print("Updating current index")
end
msg.debug("Updating current index")
if #video_queue == 0 then
return
end
@@ -662,7 +512,7 @@ function YouTubeQueue.update_current_index(update_history)
---@class table
current_video = YouTubeQueue.get_video_at(index)
if update_history then
YouTubeQueue._add_to_history_db(current_video)
YouTubeQueue.add_to_history_db(current_video)
end
return
end
@@ -725,12 +575,11 @@ function YouTubeQueue.reorder_queue(from_index, to_index)
end
--- Prints the queue to the OSD
--- @param duration number? Optional duration to display the queue
--- @param duration number Optional duration to display the queue
function YouTubeQueue.print_queue(duration)
-- Reset and prepare OSD
timeout:kill()
mp.set_osd_ass(0, 0, "")
timeout:resume()
if #video_queue == 0 then
print_osd_message("No videos in the queue or history.", duration, style.error)
@@ -741,37 +590,40 @@ function YouTubeQueue.print_queue(duration)
local ass = assdraw.ass_new()
ass:append(style.header .. "MPV-YOUTUBE-QUEUE{\\u0\\b0}" .. style.reset .. style.font .. "\n")
local start_index, end_index = _get_display_range(
#video_queue,
selected_index,
options.display_limit
)
local start_index, end_index = get_display_range(#video_queue, selected_index, options.display_limit)
for i = start_index, end_index do
local video = video_queue[i]
if not video then break end
local prefix = (i == selected_index)
and style.cursor .. options.cursor_icon .. "\\h" .. style.reset
if not video then
break
end
local prefix = (i == selected_index) and style.cursor .. options.cursor_icon .. "\\h" .. style.reset
or "\\h\\h\\h"
local item_style = _get_item_style(i, index, selected_index)
local message = _build_osd_row(prefix, item_style, i, video.title, video.channel_name)
.. style.reset
local item_style = get_item_style(i, index, selected_index)
local message = build_osd_row(prefix, item_style, i, video.video_name, video.channel_name) .. style.reset
if i == marked_index then
message = message .. " " .. style.marked .. options.marked_icon .. style.reset
end
ass:append(style.font .. message .. "\n")
end
mp.set_osd_ass(0, 0, ass.text)
if duration then
mp.add_timeout(duration, destroy)
-- restart one-shot timer for menu hide
if duration and type(duration) == "number" then
timeout.timeout = duration
else
timeout.timeout = options.menu_timeout
end
timeout:resume()
destroyer = destroy
end
--- Function to move the cursor on the OSD by amt
--- @param amt number - the number of steps to take
--- Function to move the cursor on the OSD by a specified amount.
--- Adjusts the selected index and updates the display offset to ensure
--- the selected item is visible within the display limits
--- @param amt number - the number of steps to move the cursor. Positive values move up, negative values move down.
function YouTubeQueue.move_cursor(amt)
timeout:kill()
timeout.timeout = options.menu_timeout
timeout:resume()
selected_index = selected_index - amt
if selected_index < 1 then
@@ -850,32 +702,32 @@ function YouTubeQueue.add_to_queue(url, update_internal_playlist)
return
end
local video, channel_url, title
local video, channel_url, video_name
url = strip(url)
if not is_file(url) then
local info = YouTubeQueue.get_video_info(url)
if info == nil then
return nil
end
title = info.title
video_name = info.video_name
video = info
video["video_url"] = url
else
channel_url, title = split_path(url)
if isnull(channel_url) or isnull(title) then
channel_url, video_name = split_path(url)
if isnull(channel_url) or isnull(video_name) then
print_osd_message("Error getting video info.", MSG_DURATION, style.error)
return
end
video = {
video_url = url,
title = title,
video_name = video_name,
channel_url = channel_url,
channel_name = "Local file",
thumbnail_url = "",
view_count = "",
upload_date = "",
category = "",
subscribers = ""
subscribers = "",
}
end
@@ -887,7 +739,7 @@ function YouTubeQueue.add_to_queue(url, update_internal_playlist)
elseif update_internal_playlist == 0 then
mp.commandv("loadfile", url, "append-play")
end
print_osd_message("Added " .. title .. " to queue.", MSG_DURATION)
print_osd_message("Added " .. video_name .. " to queue.", MSG_DURATION)
end
--- Downloads the video at the specified index
@@ -906,21 +758,38 @@ function YouTubeQueue.download_video_at(idx)
local q = o.download_quality:sub(1, -2)
local dl_dir = expanduser(o.download_directory)
print_osd_message("Downloading " .. v.title .. "...", MSG_DURATION)
print_osd_message("Downloading " .. v.video_name .. "...", MSG_DURATION)
-- Run the download command
mp.command_native_async({
name = "subprocess",
capture_stderr = true,
detach = true,
args = { "yt-dlp", "-f",
"bestvideo[height<=" .. q .. "][ext=" .. options.ytdlp_file_format .. "]+bestaudio/best[height<=" .. q ..
"]/bestvideo[height<=" .. q .. "]+bestaudio/best[height<=" .. q .. "]", "-o",
dl_dir .. "/" .. options.ytdlp_output_template, "--downloader", o.downloader, "--", v.video_url }
args = {
"yt-dlp",
"-f",
"bestvideo[height<="
.. q
.. "][ext="
.. options.ytdlp_file_format
.. "]+bestaudio/best[height<="
.. q
.. "]/bestvideo[height<="
.. q
.. "]+bestaudio/best[height<="
.. q
.. "]",
"-o",
dl_dir .. "/" .. options.ytdlp_output_template,
"--downloader",
o.downloader,
"--",
v.video_url,
},
}, function(success, _, err)
if success then
print_osd_message("Finished downloading " .. v.title .. ".", MSG_DURATION)
print_osd_message("Finished downloading " .. v.video_name .. ".", MSG_DURATION)
else
print_osd_message("Error downloading " .. v.title .. ": " .. err, MSG_DURATION, style.error)
print_osd_message("Error downloading " .. v.video_name .. ": " .. err, MSG_DURATION, style.error)
end
end)
return true
@@ -935,8 +804,8 @@ function YouTubeQueue.remove_from_queue()
end
table.remove(video_queue, selected_index)
mp.commandv("playlist-remove", selected_index - 1)
if current_video and current_video.title then
print_osd_message("Deleted " .. current_video.title .. " from queue.", MSG_DURATION)
if current_video and current_video.video_name then
print_osd_message("Deleted " .. current_video.video_name .. " from queue.", MSG_DURATION)
end
if selected_index > 1 then
selected_index = selected_index - 1
@@ -946,6 +815,130 @@ function YouTubeQueue.remove_from_queue()
return true
end
--- Returns a list of URLs in the queue from start_index to the end
--- @param start_index number - the index to start from
--- @return table | nil - a table of URLs
function YouTubeQueue.get_urls(start_index)
if start_index < 0 or start_index > #video_queue then
return nil
end
local urls = {}
for i = start_index + 1, #video_queue do
table.insert(urls, video_queue[i].video_url)
end
return urls
end
-- }}}
-- {{{ HISTORY DB
--- Add a video to the history database
--- @param v table - the video to add to the history database
--- @return boolean - true if the video was added successfully, false otherwise
function YouTubeQueue.add_to_history_db(v)
if not options.use_history_db then
return false
end
local url = options.backend_host .. ":" .. options.backend_port .. "/add_video"
local json = convert_to_json(v)
local command = { "curl", "-X", "POST", url, "-H", "Content-Type: application/json", "-d", json }
msg.debug("Adding video to history")
msg.debug("Command: " .. table.concat(command, " "))
print_osd_message("Adding video to history...", MSG_DURATION)
mp.command_native_async({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command,
}, function(success, _, err)
if not success then
print_osd_message("Failed to send video data to backend: " .. err, MSG_DURATION, style.error)
return false
end
end)
print_osd_message("Video added to history db", MSG_DURATION)
return true
end
--- Saves the remainder of the videos in the queue
--- (all videos after the currently playing video) to the history database
--- @param idx number - the index to start saving from
--- @return boolean - true if the queue was saved successfully, false otherwise
function YouTubeQueue.save_queue(idx)
if not options.use_history_db then
return false
end
if idx == nil then
idx = index
end
local url = options.backend_host .. ":" .. options.backend_port .. "/save_queue"
local urls_list = YouTubeQueue.get_urls(idx + 1)
if urls_list == nil or #urls_list == 0 then
print_osd_message("Failed to save queue: No videos remaining in queue", MSG_DURATION, style.error)
return false
end
local data = convert_to_json({ urls = urls_list })
msg.debug("Data: " .. data)
local command = { "curl", "-X", "POST", url, "-H", "Content-Type: application/json", "-d", data }
msg.debug("Saving queue to history")
msg.debug("Command: " .. table.concat(command, " "))
mp.command_native_async({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command,
}, function(success, result, err)
if not success then
print_osd_message("Failed to save queue: " .. err, MSG_DURATION, style.error)
return false
end
msg.debug("Status: " .. result.status)
if result.status == 0 then
if idx > 1 then
print_osd_message("Queue saved to history from index: " .. idx, MSG_DURATION)
else
print_osd_message("Queue saved to history.", MSG_DURATION)
end
end
end)
return true
end
-- loads the queue from the backend
function YouTubeQueue.load_queue()
if not options.use_history_db then
return false
end
local url = options.backend_host .. ":" .. options.backend_port .. "/load_queue"
local command = { "curl", "-X", "GET", url }
mp.command_native_async({
name = "subprocess",
playback_only = false,
capture_stdout = true,
args = command,
}, function(success, result, err)
if not success then
print_osd_message("Failed to load queue: " .. err, MSG_DURATION, style.error)
return false
else
if result.status == 0 then
local ok, parsed = pcall(utils.parse_json, result.stdout)
if not ok or type(parsed) ~= "table" then
print_osd_message("Invalid JSON from history backend", MSG_DURATION, style.error)
return false
end
for _, turl in ipairs(parsed) do
if type(turl) == "string" then
YouTubeQueue.add_to_queue(turl, 0)
end
end
print_osd_message("Loaded queue from history.", MSG_DURATION)
end
end
end)
end
-- }}}
-- LISTENERS {{{
@@ -953,9 +946,7 @@ end
-- This function is called when the current file ends or when moving to the
-- next or previous item in the internal playlist
local function on_end_file(event)
if debug then
print("End file event triggered: " .. event.reason)
end
msg.debug("End file event triggered: " .. event.reason)
if event.reason == "eof" then -- The file ended normally
YouTubeQueue.update_current_index(true)
end
@@ -963,29 +954,23 @@ end
-- Function to be called when the track-changed event is triggered
local function on_track_changed()
if debug then
print("Track changed event triggered.")
end
msg.debug("Track changed event triggered.")
YouTubeQueue.update_current_index()
end
local function on_file_loaded()
if debug then
print("Load file event triggered.")
end
msg.debug("Load file event triggered.")
YouTubeQueue.update_current_index(true)
end
-- Function to be called when the playback-restart event is triggered
local function on_playback_restart()
if debug then
print("Playback restart event triggered.")
end
msg.debug("Playback restart event triggered.")
if current_video == nil then
local url = mp.get_property("path")
YouTubeQueue.add_to_queue(url)
---@diagnostic disable-next-line: param-type-mismatch
YouTubeQueue._add_to_history_db(current_video)
YouTubeQueue.add_to_history_db(current_video)
end
end
@@ -1003,12 +988,12 @@ mp.add_key_binding(options.print_queue, "print_queue", toggle_print)
mp.add_key_binding(options.move_cursor_up, "move_cursor_up", function()
YouTubeQueue.move_cursor(1)
end, {
repeatable = true
repeatable = true,
})
mp.add_key_binding(options.move_cursor_down, "move_cursor_down", function()
YouTubeQueue.move_cursor(-1)
end, {
repeatable = true
repeatable = true,
})
mp.add_key_binding(options.play_selected_video, "play_selected_video", function()
YouTubeQueue.play_video_at(selected_index)
@@ -1051,6 +1036,6 @@ mp.register_script_message("print_queue", YouTubeQueue.print_queue)
mp.register_script_message("add_to_youtube_queue", YouTubeQueue.add_to_queue)
mp.register_script_message("toggle_youtube_queue", toggle_print)
mp.register_script_message("print_internal_playlist", _print_internal_playlist)
mp.register_script_message("print_internal_playlist", print_internal_playlist)
mp.register_script_message("reorder_youtube_queue", YouTubeQueue.reorder_queue)
-- }}}