Support for thumbnailing network files/streams

Author: TheAMM

README.md

@@ -98,6 +98,22 @@ thumbnail_count=150
 min_delta=5
 max_delta=90
 # 120 seconds aka 2 minutes will add more thumbnails only when the video is over 5 hours long!
+
+# Below are overrides for remote urls (you generally want less thumbnails, because it's slow!)
+# Thumbnailing network paths will be done with mpv (leveraging youtube-dl)
+
+# Allow thumbnailing network paths (naive check for "://")
+# Defaults to no
+thumbnail_network=[yes/no]
+# Override thumbnail count, min/max delta, as above
+remote_thumbnail_count=60
+remote_min_delta=15
+remote_max_delta=120
+
+# Try to grab the raw stream and disable ytdl for the mpv subcalls
+# Much faster than passing the url to ytdl again, but may cause problems with some sites
+Defaults to yes
+remote_direct_stream=[yes/no]
 ```
 
 With `disable_keybind=yes`, you can add your own keybind to [`input.conf`](https://mpv.io/manual/master/#input-conf) with `script-binding generate-thumbnails`, for example:

src/options.lua

@@ -38,6 +38,21 @@ local thumbnailer_options = {
     min_delta = 5,
     -- 120 seconds aka 2 minutes will add more thumbnails when the video is over 5 hours!
     max_delta = 90,
+
+
+    -- Overrides for remote urls (you generally want less thumbnails!)
+    -- Thumbnailing network paths will be done with mpv
+
+    -- Allow thumbnailing network paths (naive check for "://")
+    thumbnail_network = false,
+    -- Override thumbnail count, min/max delta
+    remote_thumbnail_count = 60,
+    remote_min_delta = 15,
+    remote_max_delta = 120,
+
+    -- Try to grab the raw stream and disable ytdl for the mpv subcalls
+    -- Much faster than passing the url to ytdl again, but may cause problems with some sites
+    remote_direct_stream = true,
 }
 
 read_options(thumbnailer_options, SCRIPT_NAME)

src/thumbnailer_server.lua

@@ -1,9 +1,20 @@
+function skip_nil(tbl)
+    local n = {}
+    for k, v in pairs(tbl) do
+        table.insert(n, v)
+    end
+    return n
+end
 
 function create_thumbnail_mpv(file_path, timestamp, size, output_path)
-    local mpv_command = {
+    local ytdl_disabled = mp.get_property_native("ytdl") == false or thumbnailer_options.remote_direct_stream
+
+    local mpv_command = skip_nil({
         "mpv",
         file_path,
 
+        -- Disable ytdl
+        (ytdl_disabled and "--no-ytdl" or nil),
         -- Disable hardware decoding
         "--hwdec=no",
 
@@ -17,7 +28,7 @@ function create_thumbnail_mpv(file_path, timestamp, size, output_path)
         "--of=rawvideo",
         "--ovc=rawvideo",
         "--o", output_path
-    }
+    })
     return utils.subprocess({args=mpv_command})
 end
 
@@ -66,10 +77,16 @@ end
 
 
 function generate_thumbnails(from_keypress)
+    msg.debug("Thumbnailer state:")
+    msg.debug(utils.to_string(Thumbnailer.state))
+
     if not Thumbnailer.state.available then
         if from_keypress then
             mp.osd_message("Nothing to thumbnail", 2)
         end
+        if Thumbnailer.state.is_remote then
+            msg.warn("Not thumbnailing remote file")
+        end
         return
     end
 
@@ -99,6 +116,16 @@ function generate_thumbnails(from_keypress)
         end
     end
 
+    if Thumbnailer.state.is_remote then
+        thumbnail_func = create_thumbnail_mpv
+        if thumbnailer_options.remote_direct_stream then
+            -- Use the direct stream (possibly) provided by ytdl
+            -- This skips ytdl on the sub-calls, making the thumbnailing faster
+            -- Works well on YouTube, rest not really tested
+            file_path = mp.get_property_native("stream-path")
+        end
+    end
+
     mp.commandv("script-message", "mpv_thumbnail_script-enabled")
 
     local generate_thumbnail_for_index = function(thumbnail_index)

src/thumbnailer_shared.lua

@@ -60,6 +60,9 @@ function Thumbnailer:update_state()
 
     self.state.ready = true
 
+    local file_path = mp.get_property_native("path")
+    self.state.is_remote = file_path:find("://") ~= nil
+
     self.state.available = false
 
     -- Make sure the file has video (and not just albumart)
@@ -80,7 +83,19 @@ end
 
 
 function Thumbnailer:get_thubmnail_template()
-    local file_key = ("%s-%d"):format(mp.get_property_native("filename/no-ext"), mp.get_property_native("file-size"))
+    local file_path = mp.get_property_native("path")
+    local is_remote = file_path:find("://") ~= nil
+
+    local filename = mp.get_property_native("filename/no-ext")
+    local filesize = mp.get_property_native("file-size", 0)
+
+    if is_remote then
+        filesize = 0
+    end
+
+    filename = filename:gsub('[^a-zA-Z0-9_.%-\' ]', '')
+
+    local file_key = ("%s-%d"):format(filename, filesize)
     local file_template = join_paths(self.cache_directory, file_key, "%06d.bgra")
     return file_template
 end
@@ -111,13 +126,31 @@ function Thumbnailer:get_delta()
     local file_duration = mp.get_property_native("duration")
     local is_seekable = mp.get_property_native("seekable")
 
-    if file_path:find("://") ~= nil or not is_seekable or not file_duration then
-        -- Not a local path, not seekable or lacks duration
+    -- Naive url check
+    local is_remote = file_path:find("://") ~= nil
+
+    local remote_and_disallowed = is_remote
+    if is_remote and thumbnailer_options.thumbnail_network then
+        remote_and_disallowed = false
+    end
+
+    if remote_and_disallowed or not is_seekable or not file_duration then
+        -- Not a local path (or remote thumbnails allowed), not seekable or lacks duration
         return nil
     end
 
-    local target_delta = (file_duration / thumbnailer_options.thumbnail_count)
-    local delta = math.max(thumbnailer_options.min_delta, math.min(thumbnailer_options.max_delta, target_delta))
+    local thumbnail_count = thumbnailer_options.thumbnail_count
+    local min_delta = thumbnailer_options.min_delta
+    local max_delta = thumbnailer_options.max_delta
+
+    if is_remote then
+        thumbnail_count = thumbnailer_options.remote_thumbnail_count
+        min_delta = thumbnailer_options.remote_min_delta
+        max_delta = thumbnailer_options.remote_max_delta
+    end
+
+    local target_delta = (file_duration / thumbnail_count)
+    local delta = math.max(min_delta, math.min(max_delta, target_delta))
 
     return delta
 end