feat: support for Überzug++ for image previews with X11/wayland environment

README.md

@@ -36,7 +36,7 @@ brew install jq unar ffmpegthumbnailer fd ripgrep fzf zoxide
 brew tap homebrew/cask-fonts && brew install --cask font-symbols-only-nerd-font
 ```
 
-And download the latest release [from here](https://github.com/sxyazi/yazi/releases). Or you can install Yazi with cargo:
+And download the latest release [from here](https://github.com/sxyazi/yazi/releases). Or you can install Yazi via cargo:
 
 ```bash
 cargo install --git https://github.com/sxyazi/yazi.git
@@ -66,13 +66,32 @@ yazi
 
 If you want to use your own config, copy the [config folder](https://github.com/sxyazi/yazi/tree/main/config) to `~/.config/yazi`, and modify it as you like.
 
+## Image Preview
+
+| Platform    | Protocol                                                                         | Support               |
+| ----------- | -------------------------------------------------------------------------------- | --------------------- |
+| Kitty       | [Terminal graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/) | ✅ Built-in           |
+| WezTerm     | [Terminal graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/) | ✅ Built-in           |
+| Konsole     | [Terminal graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/) | ✅ Built-in           |
+| iTerm2      | [Inline Images Protocol](https://iterm2.com/documentation-images.html)           | ✅ Built-in           |
+| Hyper       | Sixel                                                                            | ☑️ Überzug++ required |
+| foot        | Sixel                                                                            | ☑️ Überzug++ required |
+| X11/Wayland | Window system protocol                                                           | ☑️ Überzug++ required |
+| Fallback    | [Chafa](https://hpjansson.org/chafa/)                                            | ☑️ Überzug++ required |
+
+Yazi automatically selects the appropriate preview method for you, based on the priority from top to bottom.
+That's relying on the `$TERM`, `$TERM_PROGRAM`, and `$XDG_SESSION_TYPE` variables, make sure you don't overwrite them by mistake!
+
+For instance, if your terminal is Alacritty, which doesn't support displaying images itself, but you are running on an X11/Wayland environment,
+it will automatically use the "Window system protocol" to display images -- this requires you to have [Überzug++](https://github.com/jstkdng/ueberzugpp) installed.
+
 ## TODO
 
 - [x] Add example config for general usage, currently please see my [another repo](https://github.com/sxyazi/dotfiles/tree/main/yazi) instead
 - [x] Integration with fzf, zoxide for fast directory navigation
 - [x] Integration with fd, rg for fuzzy file searching
 - [x] Documentation of commands and options
-- [ ] Support for Überzug++ for image previews with X11/wayland environment
+- [x] Support for Überzug++ for image previews with X11/wayland environment
 - [ ] Batch renaming support
 
 ## License

cspell.json

@@ -1 +1 @@
-{"language":"en","flagWords":[],"words":["Punct","KEYMAP","splitn","crossterm","YAZI","unar","peekable","ratatui","syntect","pbpaste","pbcopy","ffmpegthumbnailer","oneshot","Posix","Lsar","XADDOS","zoxide","cands","Deque","precache","imageops","IFBLK","IFCHR","IFDIR","IFIFO","IFLNK","IFMT","IFSOCK","IRGRP","IROTH","IRUSR","ISGID","ISUID","ISVTX","IWGRP","IWOTH","IWUSR","IXGRP","IXOTH","IXUSR","libc","winsize","TIOCGWINSZ","xpixel","ypixel","ioerr","appender","Catppuccin","macchiato","gitmodules","Dotfiles","bashprofile","vimrc","flac","webp","exiftool","mediainfo","ripgrep","nvim","indexmap","indexmap","unwatch","canonicalize","serde","fsevent"],"version":"0.2"}
+{"flagWords":[],"words":["Punct","KEYMAP","splitn","crossterm","YAZI","unar","peekable","ratatui","syntect","pbpaste","pbcopy","ffmpegthumbnailer","oneshot","Posix","Lsar","XADDOS","zoxide","cands","Deque","precache","imageops","IFBLK","IFCHR","IFDIR","IFIFO","IFLNK","IFMT","IFSOCK","IRGRP","IROTH","IRUSR","ISGID","ISUID","ISVTX","IWGRP","IWOTH","IWUSR","IXGRP","IXOTH","IXUSR","libc","winsize","TIOCGWINSZ","xpixel","ypixel","ioerr","appender","Catppuccin","macchiato","gitmodules","Dotfiles","bashprofile","vimrc","flac","webp","exiftool","mediainfo","ripgrep","nvim","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","️ Überzug","️ Überzug","Konsole","Alacritty"],"version":"0.2","language":"en"}

src/config/preview/adaptor.rs

@@ -0,0 +1,64 @@
+use std::env;
+
+#[derive(Debug, PartialEq, Eq)]
+pub enum PreviewAdaptor {
+	Kitty,
+	Iterm2,
+
+	// Supported by Überzug++
+	Sixel,
+	X11,
+	Wayland,
+	Chafa,
+}
+
+impl Default for PreviewAdaptor {
+	fn default() -> Self {
+		if env::var("KITTY_WINDOW_ID").is_ok() {
+			return Self::Kitty;
+		}
+		if env::var("KONSOLE_VERSION").is_ok() {
+			return Self::Kitty;
+		}
+		match env::var("TERM").unwrap_or_default().as_str() {
+			"xterm-kitty" => return Self::Kitty,
+			"wezterm" => return Self::Kitty,
+			"foot" => return Self::Sixel,
+			_ => {}
+		}
+		match env::var("TERM_PROGRAM").unwrap_or_default().as_str() {
+			"iTerm.app" => return Self::Iterm2,
+			_ => {}
+		}
+		match env::var("XDG_SESSION_TYPE").unwrap_or_default().as_str() {
+			"x11" => return Self::X11,
+			"wayland" => return Self::Wayland,
+			_ => Self::Chafa,
+		}
+	}
+}
+
+impl ToString for PreviewAdaptor {
+	fn to_string(&self) -> String {
+		match self {
+			PreviewAdaptor::Kitty => "kitty",
+			PreviewAdaptor::Iterm2 => "iterm2",
+			PreviewAdaptor::Sixel => "sixel",
+			PreviewAdaptor::X11 => "x11",
+			PreviewAdaptor::Wayland => "wayland",
+			PreviewAdaptor::Chafa => "chafa",
+		}
+		.to_string()
+	}
+}
+
+impl PreviewAdaptor {
+	#[inline]
+	pub fn needs_ueberzug(&self) -> bool {
+		match self {
+			PreviewAdaptor::Kitty => false,
+			PreviewAdaptor::Iterm2 => false,
+			_ => true,
+		}
+	}
+}

src/config/preview/mod.rs

@@ -1,3 +1,5 @@
+mod adaptor;
 mod preview;
 
+pub use adaptor::*;
 pub use preview::*;

src/config/preview/preview.rs

@@ -1,9 +1,12 @@
 use serde::Deserialize;
 
+use super::PreviewAdaptor;
 use crate::config::MERGED_YAZI;
 
 #[derive(Debug, Deserialize)]
 pub struct Preview {
+	#[serde(skip)]
+	pub adaptor:  PreviewAdaptor,
 	pub tab_size: u32,
 
 	pub max_width:  u32,

src/core/adaptor/adaptor.rs

@@ -0,0 +1,53 @@
+use std::{path::{Path, PathBuf}, sync::atomic::{AtomicBool, Ordering}};
+
+use anyhow::Result;
+use once_cell::sync::Lazy;
+use ratatui::prelude::Rect;
+use tokio::sync::mpsc::UnboundedSender;
+
+use super::{iterm2::Iterm2, kitty::Kitty, ueberzug::Ueberzug};
+use crate::config::{preview::PreviewAdaptor, PREVIEW};
+
+static IMAGE_SHOWN: AtomicBool = AtomicBool::new(false);
+
+static UEBERZUG: Lazy<Option<UnboundedSender<Option<(PathBuf, Rect)>>>> =
+	Lazy::new(|| if PREVIEW.adaptor.needs_ueberzug() { Ueberzug::start().ok() } else { None });
+
+pub struct Adaptor;
+
+impl Adaptor {
+	pub fn init() { Lazy::force(&UEBERZUG); }
+
+	pub async fn image_show(path: &Path, rect: Rect) -> Result<()> {
+		if IMAGE_SHOWN.swap(true, Ordering::Relaxed) {
+			Self::image_hide(rect);
+		}
+
+		match PREVIEW.adaptor {
+			PreviewAdaptor::Kitty => Kitty::image_show(path, rect).await,
+			PreviewAdaptor::Iterm2 => Iterm2::image_show(path, rect).await,
+			_ => {
+				if let Some(tx) = &*UEBERZUG {
+					tx.send(Some((path.to_path_buf(), rect))).ok();
+				}
+				Ok(())
+			}
+		}
+	}
+
+	pub fn image_hide(rect: Rect) {
+		if !IMAGE_SHOWN.swap(false, Ordering::Relaxed) {
+			return;
+		}
+
+		match PREVIEW.adaptor {
+			PreviewAdaptor::Kitty => Kitty::image_hide(),
+			PreviewAdaptor::Iterm2 => Iterm2::image_hide(rect),
+			_ => {
+				if let Some(tx) = &*UEBERZUG {
+					tx.send(None).ok();
+				}
+			}
+		}
+	}
+}

src/core/adaptor/image.rs

@@ -0,0 +1,31 @@
+use std::path::Path;
+
+use anyhow::Result;
+use image::{imageops::FilterType, DynamicImage};
+use tokio::fs;
+
+use crate::{config::PREVIEW, misc::tty_ratio};
+
+pub(super) struct Image;
+
+impl Image {
+	pub(super) async fn resize(path: &Path, size: (u16, u16)) -> Result<DynamicImage> {
+		let (w, h) = {
+			let r = tty_ratio();
+			let (w, h) = ((size.0 as f64 * r.0) as u32, (size.1 as f64 * r.1) as u32);
+			(w.min(PREVIEW.max_width), h.min(PREVIEW.max_height))
+		};
+
+		let img = fs::read(path).await?;
+		let img = tokio::task::spawn_blocking(move || -> Result<DynamicImage> {
+			let img = image::load_from_memory(&img)?;
+			Ok(if img.width() > w || img.height() > h {
+				img.resize(w, h, FilterType::Triangle)
+			} else {
+				img
+			})
+		});
+
+		Ok(img.await??)
+	}
+}

src/core/adaptor/iterm2.rs

@@ -0,0 +1,53 @@
+use std::{io::Write, path::Path};
+
+use anyhow::Result;
+use base64::{engine::general_purpose, Engine};
+use image::{codecs::jpeg::JpegEncoder, DynamicImage};
+use ratatui::prelude::Rect;
+use tokio::io::AsyncWriteExt;
+
+use super::image::Image;
+use crate::ui::Term;
+
+pub(super) struct Iterm2;
+
+impl Iterm2 {
+	pub(super) async fn image_show(path: &Path, rect: Rect) -> Result<()> {
+		let img = Image::resize(path, (rect.width, rect.height)).await?;
+		let b = Self::encode(img).await?;
+
+		Term::move_to(rect.x, rect.y).ok();
+		tokio::io::stdout().write_all(&b).await.ok();
+		Ok(())
+	}
+
+	#[inline]
+	pub(super) fn image_hide(rect: Rect) {
+		let s = " ".repeat(rect.width as usize);
+		for y in rect.top()..=rect.bottom() {
+			Term::move_to(rect.x, y).ok();
+			std::io::stdout().write_all(s.as_bytes()).ok();
+		}
+	}
+
+	async fn encode(img: DynamicImage) -> Result<Vec<u8>> {
+		tokio::task::spawn_blocking(move || {
+			let size = (img.width(), img.height());
+
+			let mut jpg = vec![];
+			JpegEncoder::new_with_quality(&mut jpg, 75).encode_image(&img)?;
+
+			let mut buf = vec![];
+			write!(
+				buf,
+				"\x1b]1337;File=inline=1;size={};width={}px;height={}px:{}\x07",
+				jpg.len(),
+				size.0,
+				size.1,
+				general_purpose::STANDARD.encode(&jpg)
+			)?;
+			Ok(buf)
+		})
+		.await?
+	}
+}