add download_selected_video function

- 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
This commit is contained in:
ksyasuda 2023-08-06 23:28:04 -07:00
parent 8b4d2639e6
commit 05becd9cbb
3 changed files with 79 additions and 57 deletions

View File

@ -1,6 +1,10 @@
# mpv-youtube-queue # mpv-youtube-queue
A Lua script that implements the YouTube 'Add to Queue' functionality for MPV <div align="center">
A Lua script that implements the YouTube 'Add to Queue' functionality for mpv
</div>
![mpv-youtube-queue image](.assets/mpv-youtube-queue.png) ![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 - Edit the order of videos in the queue
- Open the URL or channel page of the currently playing video in a new browser tab - Open the URL or channel page of the currently playing video in a new browser tab
- Download the currently playing video - Download the currently playing video
- Download a video in the queue
## Notes ## 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 - `add_to_queue - ctrl+a`: Add a video in the clipboard to the queue
- `download_current_video - ctrl+d`: Download the currently playing video - `download_current_video - ctrl+d`: Download the currently playing video
- `move_cursor_down - ctrl+DOWN`: Move the cursor down one row in the queue - `download_selected_video - ctrl+D`: Download the currently selected video
- `move_cursor_up - ctrl+UP`- Move the cursor up one row in the queue in the queue
- `move_video - ctrl+m`: Mark/move the 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 - `open_channel_in_browser - ctrl+O`: Open the channel page for the currently
playing video in the browser 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_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 - `print_current_video - ctrl+P`: Print the name and channel of the currently
playing video to the OSD playing video to the OSD
- `print_queue - ctrl+q`: Print the contents of the queue 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 - `remove_from_queue - ctrl+x`: Remove the currently selected video from the
queue 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 ### 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 - `show_errors - yes`: Show error messages on the OSD
- `ytdlp_output_template - %(uploader)s/%(title)s.%(ext)s`: The [yt-dlp output - `ytdlp_output_template - %(uploader)s/%(title)s.%(ext)s`: The [yt-dlp output
template string](https://github.com/yt-dlp/yt-dlp#output-template) template string](https://github.com/yt-dlp/yt-dlp#output-template)
- Full default path is: `~/videos/YouTube/<uploader>/<title>.<ext>`
## License ## License

View File

@ -1,14 +1,17 @@
add_to_queue=ctrl+a add_to_queue=ctrl+a
move_cursor_down=ctrl+DOWN download_current_video=ctrl+d
move_cursor_up=ctrl+UP download_selected_video=ctrl+D
open_channel_in_browser=ctrl+O move_video=ctrl+m
open_video_in_browser=ctrl+o
play_next_in_queue=ctrl+n 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_previous_in_queue=ctrl+p
play_selected_video=ctrl+ENTER
print_current_video=ctrl+P print_current_video=ctrl+P
print_queue=ctrl+q print_queue=ctrl+q
remove_from_queue=ctrl+x remove_from_queue=ctrl+x
move_cursor_up=ctrl+UP
move_cursor_down=ctrl+DOWN
play_selected_video=ctrl+ENTER
browser=firefox browser=firefox
clipboard_command=xclip -o clipboard_command=xclip -o
cursor_icon=➤ cursor_icon=➤

View File

@ -28,29 +28,30 @@ local styleOff = mp.get_property("osd-ass-cc/1")
local options = { local options = {
add_to_queue = "ctrl+a", add_to_queue = "ctrl+a",
download_current_video = "ctrl+d", download_current_video = "ctrl+d",
move_cursor_down = "ctrl+DOWN", download_selected_video = "ctrl+D",
move_cursor_up = "ctrl+UP",
move_video = "ctrl+m", move_video = "ctrl+m",
open_channel_in_browser = "ctrl+O",
open_video_in_browser = "ctrl+o",
play_next_in_queue = "ctrl+n", 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_previous_in_queue = "ctrl+p",
play_selected_video = "ctrl+ENTER",
print_current_video = "ctrl+P", print_current_video = "ctrl+P",
print_queue = "ctrl+q", print_queue = "ctrl+q",
remove_from_queue = "ctrl+x", 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", browser = "firefox",
clipboard_command = "xclip -o",
cursor_icon = "", cursor_icon = "",
marked_icon = "", display_limit = 6,
download_directory = "~/videos/YouTube", download_directory = "~/videos/YouTube",
download_format_str = "%(uploader)s/%(title)s.%(ext)s",
downloader = "curl",
download_quality = "720p", download_quality = "720p",
downloader = "curl",
font_name = "JetBrains Mono", font_name = "JetBrains Mono",
font_size = 12, font_size = 12,
display_limit = 6, marked_icon = "",
show_errors = false show_errors = false,
ytdlp_output_template = "%(uploader)s/%(title)s.%(ext)s"
} }
mp.options.read_options(options, "mpv-youtube-queue") mp.options.read_options(options, "mpv-youtube-queue")
@ -452,46 +453,54 @@ function YouTubeQueue.play_previous_video()
sleep(MSG_DURATION) sleep(MSG_DURATION)
end 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() function YouTubeQueue.download_current_video()
if current_video and current_video ~= "" then if current_video ~= nil and current_video ~= "" then
local o = options YouTubeQueue.download_video_at(index)
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
else else
print_osd_message("No video to download.", MSG_DURATION, style.error) print_osd_message("No video to download.", MSG_DURATION, style.error)
end end
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() function YouTubeQueue.remove_from_queue()
if index == selected_index then if index == selected_index then
print_osd_message("Cannot remove current video", MSG_DURATION, 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) open_channel_in_browser)
mp.add_key_binding(options.download_current_video, "download_current_video", mp.add_key_binding(options.download_current_video, "download_current_video",
YouTubeQueue.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", mp.add_key_binding(options.move_video, "move_video",
YouTubeQueue.mark_and_move_video) YouTubeQueue.mark_and_move_video)
mp.add_key_binding(options.remove_from_queue, "delete_video", mp.add_key_binding(options.remove_from_queue, "delete_video",