From af81562606546457249035a43e77a39fc6d79557 Mon Sep 17 00:00:00 2001 From: Kyle Yasuda Date: Sun, 6 Aug 2023 23:30:28 -0700 Subject: [PATCH] Dev (#3) * add download_selected_video function * add ytdlp_output_template to conf file - add function to download the currently selected video in the queue - update readme and conf file - change ordering of options to have keybindings in alphabetical order --- README.md | 22 ++++++--- mpv-youtube-queue.conf | 14 ++++-- mpv-youtube-queue.lua | 101 +++++++++++++++++++++++------------------ 3 files changed, 80 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 16f1508..0f7e319 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # mpv-youtube-queue -A Lua script that implements the YouTube 'Add to Queue' functionality for MPV +
+ +A Lua script that implements the YouTube 'Add to Queue' functionality for mpv + +
![mpv-youtube-queue image](.assets/mpv-youtube-queue.png) @@ -13,6 +17,7 @@ A Lua script that implements the YouTube 'Add to Queue' functionality for MPV - Edit the order of videos in the queue - Open the URL or channel page of the currently playing video in a new browser tab - Download the currently playing video +- Download a video in the queue ## Notes @@ -42,21 +47,23 @@ This script requires the following software to be installed on the system - `add_to_queue - ctrl+a`: Add a video in the clipboard to the queue - `download_current_video - ctrl+d`: Download the currently playing video -- `move_cursor_down - ctrl+DOWN`: Move the cursor down one row in the queue -- `move_cursor_up - ctrl+UP`- Move the cursor up one row in the queue +- `download_selected_video - ctrl+D`: Download the currently selected video + in the queue - `move_video - ctrl+m`: Mark/move the selected video in the queue +- `play_next_in_queue - ctrl+n`: Play the next video in the queue +- `open_video_in_browser - ctrl+o`: Open the currently playing video in the browser - `open_channel_in_browser - ctrl+O`: Open the channel page for the currently playing video in the browser -- `open_video_in_browser - ctrl+o`: Open the currently playing video in the browser -- `play_next_in_queue - ctrl+n`: Play the next video in the queue - `play_previous_in_queue - ctrl+p`: Play the previous video in the queue -- `play_selected_video - ctrl+ENTER`: Play the currently selected video in - the queue - `print_current_video - ctrl+P`: Print the name and channel of the currently playing video to the OSD - `print_queue - ctrl+q`: Print the contents of the queue to the OSD - `remove_from_queue - ctrl+x`: Remove the currently selected video from the queue +- `move_cursor_up - ctrl+UP`- Move the cursor up one row in the queue +- `move_cursor_down - ctrl+DOWN`: Move the cursor down one row in the queue +- `play_selected_video - ctrl+ENTER`: Play the currently selected video in + the queue ### Default Option @@ -75,6 +82,7 @@ This script requires the following software to be installed on the system - `show_errors - yes`: Show error messages on the OSD - `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 default path is: `~/videos/YouTube//.<ext>` ## License diff --git a/mpv-youtube-queue.conf b/mpv-youtube-queue.conf index c0c97e3..698d1f1 100644 --- a/mpv-youtube-queue.conf +++ b/mpv-youtube-queue.conf @@ -1,14 +1,17 @@ add_to_queue=ctrl+a -move_cursor_down=ctrl+DOWN -move_cursor_up=ctrl+UP -open_channel_in_browser=ctrl+O -open_video_in_browser=ctrl+o +download_current_video=ctrl+d +download_selected_video=ctrl+D +move_video=ctrl+m play_next_in_queue=ctrl+n +open_video_in_browser=ctrl+o +open_channel_in_browser=ctrl+O play_previous_in_queue=ctrl+p -play_selected_video=ctrl+ENTER print_current_video=ctrl+P print_queue=ctrl+q remove_from_queue=ctrl+x +move_cursor_up=ctrl+UP +move_cursor_down=ctrl+DOWN +play_selected_video=ctrl+ENTER browser=firefox clipboard_command=xclip -o cursor_icon=➤ @@ -21,3 +24,4 @@ font_name=JetBrains Mono font_size=12 marked_icon=⇅ show_errors=yes +ytdlp_output_template=%(uploader)s/%(title)s.%(ext)s diff --git a/mpv-youtube-queue.lua b/mpv-youtube-queue.lua index daf8f67..987c90f 100644 --- a/mpv-youtube-queue.lua +++ b/mpv-youtube-queue.lua @@ -28,29 +28,30 @@ local styleOff = mp.get_property("osd-ass-cc/1") local options = { add_to_queue = "ctrl+a", download_current_video = "ctrl+d", - move_cursor_down = "ctrl+DOWN", - move_cursor_up = "ctrl+UP", + download_selected_video = "ctrl+D", move_video = "ctrl+m", - open_channel_in_browser = "ctrl+O", - open_video_in_browser = "ctrl+o", play_next_in_queue = "ctrl+n", + open_video_in_browser = "ctrl+o", + open_channel_in_browser = "ctrl+O", play_previous_in_queue = "ctrl+p", - play_selected_video = "ctrl+ENTER", print_current_video = "ctrl+P", print_queue = "ctrl+q", remove_from_queue = "ctrl+x", - clipboard_command = "xclip -o", + move_cursor_up = "ctrl+UP", + move_cursor_down = "ctrl+DOWN", + play_selected_video = "ctrl+ENTER", browser = "firefox", + clipboard_command = "xclip -o", cursor_icon = "➤", - marked_icon = "⇅", + display_limit = 6, download_directory = "~/videos/YouTube", - download_format_str = "%(uploader)s/%(title)s.%(ext)s", - downloader = "curl", download_quality = "720p", + downloader = "curl", font_name = "JetBrains Mono", font_size = 12, - display_limit = 6, - show_errors = false + marked_icon = "⇅", + show_errors = false, + ytdlp_output_template = "%(uploader)s/%(title)s.%(ext)s" } mp.options.read_options(options, "mpv-youtube-queue") @@ -452,46 +453,54 @@ function YouTubeQueue.play_previous_video() sleep(MSG_DURATION) end +function YouTubeQueue.download_video_at(idx) + local o = options + local v = video_queue[idx] + local q = o.download_quality:sub(1, -2) + local dl_dir = expanduser(o.download_directory) + local command = 'yt-dlp -f \'bestvideo[height<=' .. q .. + ']+bestaudio/best[height<=' .. q .. ']\' -o "' .. dl_dir .. + "/" .. options.ytdlp_output_template .. + '" --downloader ' .. o.downloader .. ' ' .. v.video_url + + -- Run the download command + local handle = io.popen(command) + if handle == nil then + print_osd_message("Error starting download.", MSG_DURATION, style.error) + return + end + print_osd_message("Starting download for " .. v.video_name, MSG_DURATION) + local result = handle:read("*a") + handle:close() + if result == nil then + print_osd_message("Error starting download.", MSG_DURATION, style.error) + return + end + + if result then + print_osd_message("Finished downloading " .. v.video_name, MSG_DURATION) + else + print_osd_message("Error downloading " .. v.video_name, MSG_DURATION, + style.error) + end +end + function YouTubeQueue.download_current_video() - if current_video and current_video ~= "" then - local o = options - local v = current_video - local q = o.download_quality:sub(1, -2) - local dl_dir = expanduser(o.download_directory) - local command = 'yt-dlp -f \'bestvideo[height<=' .. q .. - ']+bestaudio/best[height<=' .. q .. ']\' -o "' .. - dl_dir .. "/" .. options.download_format_str .. - '" --downloader ' .. o.downloader .. ' ' .. - v.video_url - - -- Run the download command - local handle = io.popen(command) - if handle == nil then - print_osd_message("Error starting download.", MSG_DURATION, - style.error) - return - end - print_osd_message("Starting download for " .. v.video_name, MSG_DURATION) - local result = handle:read("*a") - handle:close() - if result == nil then - print_osd_message("Error starting download.", MSG_DURATION, - style.error) - return - end - - if result then - print_osd_message("Finished downloading " .. v.video_name, - MSG_DURATION) - else - print_osd_message("Error downloading " .. v.video_name, - MSG_DURATION, style.error) - end + if current_video ~= nil and current_video ~= "" then + YouTubeQueue.download_video_at(index) else print_osd_message("No video to download.", MSG_DURATION, style.error) end end +function YouTubeQueue.download_selected_video() + if selected_index == 1 and current_video == nil then + print_osd_message("No video to download.", MSG_DURATION, style.error) + return + end + YouTubeQueue.download_video_at(selected_index) +end + function YouTubeQueue.remove_from_queue() if index == selected_index then print_osd_message("Cannot remove current video", MSG_DURATION, @@ -555,6 +564,8 @@ mp.add_key_binding(options.open_channel_in_browser, "open_channel_in_browser", open_channel_in_browser) mp.add_key_binding(options.download_current_video, "download_current_video", YouTubeQueue.download_current_video) +mp.add_key_binding(options.download_selected_video, "download_selected_video", + YouTubeQueue.download_selected_video) mp.add_key_binding(options.move_video, "move_video", YouTubeQueue.mark_and_move_video) mp.add_key_binding(options.remove_from_queue, "delete_video",