perf: new image_delay option debounces image previews to avoid lag …

…caused by terminal image decoding during fast scrolling (#1512)
sxyazi · Aug 18, 2024 · 0f106b5 · 0f106b5
1 parent 99a3b3a
commit 0f106b5
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 25 deletions.
diff --git a/yazi-config/preset/yazi.toml b/yazi-config/preset/yazi.toml
@@ -21,6 +21,7 @@ tab_size        = 2
 max_width       = 600
 max_height      = 900
 cache_dir       = ""
+image_delay     = 30
 image_filter    = "triangle"
 image_quality   = 75
 sixel_fraction  = 15

diff --git a/yazi-config/src/preview/preview.rs b/yazi-config/src/preview/preview.rs
@@ -15,6 +15,7 @@ pub struct Preview {
 
 	pub cache_dir: PathBuf,
 
+	pub image_delay:    u8,
 	pub image_filter:   String,
 	pub image_quality:  u8,
 	pub sixel_fraction: u8,
@@ -63,6 +64,8 @@ impl FromStr for Preview {
 
 			cache_dir: Option<String>,
 
+			#[validate(range(min = 0, max = 100))]
+			image_delay:    u8,
 			image_filter:   String,
 			#[validate(range(min = 50, max = 90))]
 			image_quality:  u8,
@@ -87,6 +90,7 @@ impl FromStr for Preview {
 
 			cache_dir,
 
+			image_delay: preview.image_delay,
 			image_filter: preview.image_filter,
 			image_quality: preview.image_quality,
 			sixel_fraction: preview.sixel_fraction,

diff --git a/yazi-plugin/preset/plugins/font.lua b/yazi-plugin/preset/plugins/font.lua
@@ -3,15 +3,14 @@ local TEXT = "ABCDEFGHIJKLM\nNOPQRSTUVWXYZ\nabcdefghijklm\nnopqrstuvwxyz\n123456
 local M = {}
 
 function M:peek()
-	local cache = ya.file_cache(self)
-	if not cache then
+	local start, cache = os.clock(), ya.file_cache(self)
+	if not cache or self:preload() ~= 1 then
 		return
 	end
 
-	if self:preload() == 1 then
-		ya.image_show(cache, self.area)
-		ya.preview_widgets(self, {})
-	end
+	ya.sleep(math.max(0, PREVIEW.image_delay / 1000 + start - os.clock()))
+	ya.image_show(cache, self.area)
+	ya.preview_widgets(self, {})
 end
 
 function M:seek() end

diff --git a/yazi-plugin/preset/plugins/image.lua b/yazi-plugin/preset/plugins/image.lua
@@ -1,11 +1,12 @@
 local M = {}
 
 function M:peek()
-	local url = ya.file_cache(self)
+	local start, url = os.clock(), ya.file_cache(self)
 	if not url or not fs.cha(url) then
 		url = self.file.url
 	end
 
+	ya.sleep(math.max(0, PREVIEW.image_delay / 1000 + start - os.clock()))
 	ya.image_show(url, self.area)
 	ya.preview_widgets(self, {})
 end

diff --git a/yazi-plugin/preset/plugins/magick.lua b/yazi-plugin/preset/plugins/magick.lua
@@ -1,15 +1,14 @@
 local M = {}
 
 function M:peek()
-	local cache = ya.file_cache(self)
-	if not cache then
+	local start, cache = os.clock(), ya.file_cache(self)
+	if not cache or self:preload() ~= 1 then
 		return
 	end
 
-	if self:preload() == 1 then
-		ya.image_show(cache, self.area)
-		ya.preview_widgets(self, {})
-	end
+	ya.sleep(math.max(0, PREVIEW.image_delay / 1000 + start - os.clock()))
+	ya.image_show(cache, self.area)
+	ya.preview_widgets(self, {})
 end
 
 function M:seek() end

diff --git a/yazi-plugin/preset/plugins/pdf.lua b/yazi-plugin/preset/plugins/pdf.lua
@@ -1,15 +1,14 @@
 local M = {}
 
 function M:peek()
-	local cache = ya.file_cache(self)
-	if not cache then
+	local start, cache = os.clock(), ya.file_cache(self)
+	if not cache or self:preload() ~= 1 then
 		return
 	end
 
-	if self:preload() == 1 then
-		ya.image_show(cache, self.area)
-		ya.preview_widgets(self, {})
-	end
+	ya.sleep(math.max(0, PREVIEW.image_delay / 1000 + start - os.clock()))
+	ya.image_show(cache, self.area)
+	ya.preview_widgets(self, {})
 end
 
 function M:seek(units)

diff --git a/yazi-plugin/preset/plugins/video.lua b/yazi-plugin/preset/plugins/video.lua
@@ -1,15 +1,14 @@
 local M = {}
 
 function M:peek()
-	local cache = ya.file_cache(self)
-	if not cache then
+	local start, cache = os.clock(), ya.file_cache(self)
+	if not cache or self:preload() ~= 1 then
 		return
 	end
 
-	if self:preload() == 1 then
-		ya.image_show(cache, self.area)
-		ya.preview_widgets(self, {})
-	end
+	ya.sleep(math.max(0, PREVIEW.image_delay / 1000 + start - os.clock()))
+	ya.image_show(cache, self.area)
+	ya.preview_widgets(self, {})
 end
 
 function M:seek(units)