mirrors/nnn
1
0
Fork 0
mirror of https://github.com/jarun/nnn.git synced 2024-11-24 11:51:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix preview-tui-ext and ueberzug support for preview-tui (#875)

Browse source 
* fix preview-tui-ext

* add ueberzug to preview-tui

* abolish config variables

* kitty
This commit is contained in:
luukvbaal 2021-03-14 07:53:03 +01:00 committed by GitHub
parent e8577baab2
commit ac72d2c66e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 99 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

91
plugins/preview-tui
View file

@ -18,7 +18,7 @@
# - tar # - tar
# - man # - man
# - optional: bat for code syntax highlighting # - optional: bat for code syntax highlighting
# - optional: kitty terminal or catimg for images # - optional: ueberzug, kitty terminal, viu or catimg for images.
# - optional: scope.sh file viewer from ranger. # - optional: scope.sh file viewer from ranger.
# To use: # To use:
# 1. drop scope.sh executable in $PATH # 1. drop scope.sh executable in $PATH
@ -65,6 +65,7 @@ TERMINAL="$TERMINAL" # same goes for the terminal
USE_SCOPE="${USE_SCOPE:-0}" USE_SCOPE="${USE_SCOPE:-0}"
USE_PISTOL="${USE_PISTOL:-0}" USE_PISTOL="${USE_PISTOL:-0}"
PAGER="${PAGER:-less -R}" PAGER="${PAGER:-less -R}"
TMPDIR="${TMPDIR:-/tmp}"
[ "$PAGER" = "most" ] && PAGER="less -R" [ "$PAGER" = "most" ] && PAGER="less -R"
if [ -e "${TMUX%%,*}" ] && tmux -V | grep -q '[ -][3456789]\.'; then if [ -e "${TMUX%%,*}" ] && tmux -V | grep -q '[ -][3456789]\.'; then
@ -152,26 +153,16 @@ preview_file () {
fifo_pager ls --color=always fifo_pager ls --color=always
fi fi
elif [ "$encoding" = "binary" ]; then elif [ "$encoding" = "binary" ]; then
if [ "${mimetype%%/*}" = "image" ] ; then if [ "${mimetype%%/*}" = "image" ]; then
if [ "$TERMINAL" = "kitty" ]; then image_preview "$cols" "$lines" "$1"
# Kitty terminal users can use the native image preview method. elif [ "$mimetype" = "application/zip" ]; then
kitty +kitten icat --silent --transfer-mode=stream --stdin=no \
"$1" &
elif exists catimg; then
catimg "$1"
elif exists viu; then
viu -t "$1"
else
fifo_pager print_bin_info "$1"
fi
elif [ "$mimetype" = "application/zip" ] ; then
fifo_pager unzip -l "$1" fifo_pager unzip -l "$1"
elif [ "$ext" = "gz" ] || [ "$ext" = "bz2" ] ; then elif [ "$ext" = "gz" ] || [ "$ext" = "bz2" ]; then
fifo_pager tar -tvf "$1" fifo_pager tar -tvf "$1"
else else
fifo_pager print_bin_info "$1" fifo_pager print_bin_info "$1"
fi fi
elif [ "$mimetype" = "text/troff" ] ; then elif [ "$mimetype" = "text/troff" ]; then
fifo_pager man -Pcat -l "$1" fifo_pager man -Pcat -l "$1"
else else
if exists bat; then if exists bat; then
@ -183,21 +174,71 @@ preview_file () {
fi fi
} }
if [ "$PREVIEW_MODE" ] ; then image_preview() {
if [ ! -r "$NNN_FIFO" ] ; then if [ "$TERMINAL" = "kitty" ]; then
# Kitty terminal users can use the native image preview method.
kitty +kitten icat --silent --place "$1"x"$2"@0x0 --transfer-mode=stream --stdin=no \
"$3"
elif exists ueberzug; then
ueberzug_layer "$1" "$2" "$3"
elif exists catimg; then
catimg "$3" &
gifpid="$!"
elif exists viu; then
viu -t "$3" &
gifpid="$!"
else
fifo_pager print_bin_info "$1"
fi
}
ueberzug_layer() {
printf '{"action": "add", "identifier": "nnn_ueberzug", "x": 0, "y": 0, "width": "%s", "height": "%s", "path": "%s"}\n' "$1" "$2" "$3" > "$FIFO_UEBERZUG"
}
ueberzug_remove() {
printf '{"action": "remove", "identifier": "nnn_ueberzug"}\n' > "$FIFO_UEBERZUG"
}
ueberzug_refresh() {
clear
pkill -P "$$"
pkill -f -n preview-tui
echo > "$NNN_FIFO"
tail --follow "$FIFO_UEBERZUG" | ueberzug layer --silent --parser json &
preview_fifo &
wait
}
[ "$TERMINAL" != "kitty" ] && [ "$PREVIEW_MODE" ] && exists ueberzug && trap 'ueberzug_refresh' WINCH
preview_fifo() {
# use cat instead of 'exec <' to avoid issues with dash shell
# shellcheck disable=SC2002
cat "$NNN_FIFO" |\
while read -r selection; do
[ "$gifpid" -ne 0 ] && kill "$gifpid"
[ "$TERMINAL" != "kitty" ] && exists ueberzug && ueberzug_remove
preview_file "$selection"
done
[ "$TERMINAL" != "kitty" ] && exists ueberzug && rm "$FIFO_UEBERZUG"
}
if [ "$PREVIEW_MODE" ]; then
if [ ! -r "$NNN_FIFO" ]; then
echo "No FIFO available! (\$NNN_FIFO='$NNN_FIFO')" >&2 echo "No FIFO available! (\$NNN_FIFO='$NNN_FIFO')" >&2
read -r read -r
exit 1 exit 1
fi fi
preview_file "$1" if [ "$TERMINAL" != "kitty" ] && exists ueberzug; then
FIFO_UEBERZUG="$TMPDIR/nnn-ueberzug-fifo.$$"
mkfifo "$FIFO_UEBERZUG"
tail --follow "$FIFO_UEBERZUG" | ueberzug layer --silent --parser json &
fi
# use cat instead of 'exec <' to avoid issues with dash shell preview_file "$1"
# shellcheck disable=SC2002 preview_fifo &
cat "$NNN_FIFO" |\ wait
while read -r selection ; do
preview_file "$selection"
done
# Restoring the previous layout for kitty users. This will only work for # Restoring the previous layout for kitty users. This will only work for
# kitty >= 0.18.0. # kitty >= 0.18.0.

99
plugins/preview-tui-ext
View file

@ -18,7 +18,14 @@
# - man # - man
# - optional: atool for additional archive preview # - optional: atool for additional archive preview
# - optional: bat for code syntax highlighting # - optional: bat for code syntax highlighting
# - optional: kitty terminal, catimg, viu, or ueberzug for images # - optional: ueberzug, kitty terminal, viu or catimg for images.
# - optional: convert(ImageMagick) for playing gif preview
# - optional: ffmpegthumbnailer for video thumbnails (https://github.com/dirkvdb/ffmpegthumbnailer).
# - optional: ffmpeg for audio thumbnails
# - optional: libreoffce for opendocument/officedocument preview
# - optional: pdftoppm(poppler) for pdf thumbnails
# - optional: gnome-epub-thumbnailer for epub thumbnails (https://gitlab.gnome.org/GNOME/gnome-epub-thumbnailer)
# - optional: fontpreview for font preview (https://github.com/sdushantha/fontpreview)
# - optional: scope.sh file viewer from ranger. # - optional: scope.sh file viewer from ranger.
# To use: # To use:
# 1. drop scope.sh executable in $PATH # 1. drop scope.sh executable in $PATH
@ -27,35 +34,6 @@
# To use: # To use:
# 1. install pistol # 1. install pistol
# 2. set/export $USE_PISTOL as 1 # 2. set/export $USE_PISTOL as 1
# - optional: ffmpegthumbnailer for video thumbnails (https://github.com/dirkvdb/ffmpegthumbnailer).
# To use:
# 1. install ffmpegthumbnailer
# 2. set/export USE_VIDEOPREVIEW as 1
# - optional: convert(ImageMagick) for playing gif preview
# To use:
# 1. install ImageMagick
# 2. set/export USE_GIFPREVIEW as 1
# 3. set/export LOOP_GIF as 1 if you want to loop gif preview
# - optional: ffmpeg for audio thumbnails
# To use:
# 1. install ffmpeg
# 2. set/export USE_AUDIOPREVIEW as 1
# - optional: pdftoppm(poppler) for pdf thumbnails
# To use:
# 1. install poppler
# 2. set/export USE_PDFPREVIEW as 1
# - optional: gnome-epub-thumbnailer for epub thumbnails (https://gitlab.gnome.org/GNOME/gnome-epub-thumbnailer)
# To use:
# 1. install gnome-epub-thumbnailer
# 2. set/export USE_EPUBPREVIEW as 1
# - optional: fontpreview for font preview (https://github.com/sdushantha/fontpreview)
# To use:
# 1. install fontpreview
# 2. set/export USE_FONTPREVIEW as 1
# - optional: libreoffce for opendocument/officedocument preview
# To use:
# 1. install libreoffice
# 2. set/export USE_OFFICEPREVIEW as 1
# #
# Usage: # Usage:
# You need to set a NNN_FIFO path and a key for the plugin with NNN_PLUG, # You need to set a NNN_FIFO path and a key for the plugin with NNN_PLUG,
@ -93,16 +71,6 @@ SPLIT="$SPLIT" # you can set a permanent split here
TERMINAL="$TERMINAL" # same goes for the terminal TERMINAL="$TERMINAL" # same goes for the terminal
USE_SCOPE="${USE_SCOPE:-0}" USE_SCOPE="${USE_SCOPE:-0}"
USE_PISTOL="${USE_PISTOL:-0}" USE_PISTOL="${USE_PISTOL:-0}"
USE_UEBERZUG="${USE_UEBERZUG:-0}"
USE_IMAGEPREVIEW="${USE_IMAGEPREVIEW:-0}"
USE_VIDEOPREVIEW="${USE_VIDEOPREVIEW:-0}"
USE_AUDIOPREVIEW="${USE_AUDIOPREVIEW:-0}"
USE_FONTPREVIEW="${USE_FONTPREVIEW:-0}"
USE_EPUBPREVIEW="${USE_EPUBPREVIEW:-0}"
USE_PDFPREVIEW="${USE_PDFPREVIEW:-0}"
USE_OFFICEPREVIEW="${USE_OFFICEPREVIEW:-0}"
USE_GIFPREVIEW="${USE_GIFPREVIEW:-0}"
LOOP_GIFS="${LOOP_GIFS:-0}"
PAGER="${PAGER:-less -P?n -R}" PAGER="${PAGER:-less -P?n -R}"
ARCHIVES="$(echo "$NNN_ARCHIVE" | sed 's/.*(\(.*\)).*/\1/;s/|/ /g')" ARCHIVES="$(echo "$NNN_ARCHIVE" | sed 's/.*(\(.*\)).*/\1/;s/|/ /g')"
TMPDIR="${TMPDIR:-/tmp}" TMPDIR="${TMPDIR:-/tmp}"
@ -195,21 +163,21 @@ preview_file () {
fifo_pager ls --color=always fifo_pager ls --color=always
fi fi
elif [ "$encoding" = "binary" ]; then elif [ "$encoding" = "binary" ]; then
if [ "$USE_GIFPREVIEW" -ne 0 ] && [ "$ext" = "gif" ]; then if [ "$ext" = "gif" ]; then
generate_preview "$cols" "$lines" "$1" "gif" generate_preview "$cols" "$lines" "$1" "gif"
elif [ "$USE_IMAGEPREVIEW" -ne 0 ] && [ "${mimetype%%/*}" = "image" ]; then elif [ "${mimetype%%/*}" = "image" ]; then
display_preview "$cols" "$lines" "$1" image_preview "$cols" "$lines" "$1"
elif [ "$USE_AUDIOPREVIEW" -ne 0 ] && [ "${mimetype%%/*}" = "audio" ]; then elif [ "${mimetype%%/*}" = "audio" ] && exists ffmpeg; then
generate_preview "$cols" "$lines" "$1" "audio" generate_preview "$cols" "$lines" "$1" "audio"
elif [ "$USE_VIDEOPREVIEW" -ne 0 ] && [ "${mimetype%%/*}" = "video" ]; then elif [ "${mimetype%%/*}" = "video" ] && exists ffmpegthumbnailer; then
generate_preview "$cols" "$lines" "$1" "video" generate_preview "$cols" "$lines" "$1" "video"
elif [ "$USE_PDFPREVIEW" -ne 0 ] && [ "$ext" = "pdf" ]; then elif [ "$ext" = "pdf" ] && exists pdftoppm; then
generate_preview "$cols" "$lines" "$1" "pdf" generate_preview "$cols" "$lines" "$1" "pdf"
elif [ "$USE_EPUBPREVIEW" -ne 0 ] && [ "$ext" = "epub" ]; then elif [ "$ext" = "epub" ] && exists gnome-epub-thumbnailer; then
generate_preview "$cols" "$lines" "$1" "epub" generate_preview "$cols" "$lines" "$1" "epub"
elif [ "$USE_FONTPREVIEW" -ne 0 ] && [ "${mimetype%%/*}" = "font" ]; then elif [ "${mimetype%%/*}" = "font" ] && exists fontpreview; then
generate_preview "$cols" "$lines" "$1" "font" generate_preview "$cols" "$lines" "$1" "font"
elif [ "${mimetype#*office}" != "$mimetype" ] || [ "${mimetype#*document}" != "$mimetype" ] && [ "$USE_OFFICEPREVIEW" -ne 0 ]; then elif [ "${mimetype#*office}" != "$mimetype" ] || [ "${mimetype#*document}" != "$mimetype" ] && exists libreoffice; then
generate_preview "$cols" "$lines" "$1" "office" generate_preview "$cols" "$lines" "$1" "office"
elif [ "${ARCHIVES#*$ext}" != "$ARCHIVES" ] && exists atool; then elif [ "${ARCHIVES#*$ext}" != "$ARCHIVES" ] && exists atool; then
fifo_pager atool -l "$1" fifo_pager atool -l "$1"
@ -240,14 +208,14 @@ generate_preview() {
audio) ffmpeg -i "$3" "$TMPDIR/$3.png" -y >/dev/null 2>&1 ;; audio) ffmpeg -i "$3" "$TMPDIR/$3.png" -y >/dev/null 2>&1 ;;
epub) gnome-epub-thumbnailer "$3" "$TMPDIR/$3.png" >/dev/null 2>&1 ;; epub) gnome-epub-thumbnailer "$3" "$TMPDIR/$3.png" >/dev/null 2>&1 ;;
font) fontpreview -i "$3" -o "$TMPDIR/$3.png" >/dev/null 2>&1 ;; font) fontpreview -i "$3" -o "$TMPDIR/$3.png" >/dev/null 2>&1 ;;
gif) if [ "$USE_UEBERZUG" -ne 0 ] || [ "$TERMINAL" = "kitty" ] && [ "$USE_GIFPREVIEW" -ne 0 ]; then gif) if exists ueberzug || [ "$TERMINAL" = "kitty" ]; then
if [ ! -d "$TMPDIR/$3" ]; then if [ ! -d "$TMPDIR/$3" ]; then
mkdir -p "$TMPDIR/$3" mkdir -p "$TMPDIR/$3"
convert -coalesce "$3" "$TMPDIR/$3/${3##*/}.png" convert -coalesce "$3" "$TMPDIR/$3/${3##*/}.png"
fi fi
while true; do while true; do
for frame in $(find "$TMPDIR/$3"/*.png | sort -V); do for frame in $(find "$TMPDIR/$3"/*.png | sort -V); do
display_preview "$1" "$2" "$frame" image_preview "$1" "$2" "$frame"
sleep 0.1 sleep 0.1
done done
[ "$LOOP_GIFS" -eq 0 ] && return [ "$LOOP_GIFS" -eq 0 ] && return
@ -255,7 +223,7 @@ generate_preview() {
gifpid="$!" gifpid="$!"
return return
else else
display_preview "$1" "$2" "$3" image_preview "$1" "$2" "$3"
return return
fi ;; fi ;;
office) libreoffice --convert-to png "$3" --outdir "$TMPDIR/${3%/*}" > /dev/null 2>&1 office) libreoffice --convert-to png "$3" --outdir "$TMPDIR/${3%/*}" > /dev/null 2>&1
@ -266,22 +234,24 @@ generate_preview() {
esac esac
kill "$pagerpid" kill "$pagerpid"
fi fi
display_preview "$1" "$2" "$TMPDIR/$3.png" image_preview "$1" "$2" "$TMPDIR/$3.png"
} }
display_preview() { image_preview() {
if [ "$USE_UEBERZUG" -ne 0 ] && exists ueberzug; then if [ "$TERMINAL" = "kitty" ]; then
ueberzug_layer "$1" "$2" "$3"
elif [ "$TERMINAL" = "kitty" ]; then
# Kitty terminal users can use the native image preview method. # Kitty terminal users can use the native image preview method.
kitty +kitten icat --silent --place "$1"x"$2"@0x0 --transfer-mode=stream --stdin=no \ kitty +kitten icat --silent --place "$1"x"$2"@0x0 --transfer-mode=stream --stdin=no \
"$3" "$3"
elif exists ueberzug; then
ueberzug_layer "$1" "$2" "$3"
elif exists catimg; then elif exists catimg; then
catimg "$3" & catimg "$3" &
gifpid="$!" gifpid="$!"
elif exists viu; then elif exists viu; then
viu -t "$3" & viu -t "$3" &
gifpid="$!" gifpid="$!"
else
fifo_pager print_bin_info "$1"
fi fi
} }
@ -296,13 +266,13 @@ ueberzug_remove() {
ueberzug_refresh() { ueberzug_refresh() {
clear clear
pkill -P "$$" pkill -P "$$"
pkill -f -n preview-tui pkill -f -n preview-tui-ext
echo > "$NNN_FIFO" echo > "$NNN_FIFO"
tail --follow "$FIFO_UEBERZUG" | ueberzug layer --silent --parser json & tail --follow "$FIFO_UEBERZUG" | ueberzug layer --silent --parser json &
preview_fifo & preview_fifo &
wait wait
} }
[ "$USE_UEBERZUG" -ne 0 ] && trap 'ueberzug_refresh' WINCH [ "$TERMINAL" != "kitty" ] && [ "$PREVIEW_MODE" ] && exists ueberzug && trap 'ueberzug_refresh' WINCH
preview_fifo() { preview_fifo() {
# use cat instead of 'exec <' to avoid issues with dash shell # use cat instead of 'exec <' to avoid issues with dash shell
@ -310,10 +280,10 @@ preview_fifo() {
cat "$NNN_FIFO" |\ cat "$NNN_FIFO" |\
while read -r selection ; do while read -r selection ; do
[ "$gifpid" -ne 0 ] && kill "$gifpid" [ "$gifpid" -ne 0 ] && kill "$gifpid"
[ "$USE_UEBERZUG" -ne 0 ] && ueberzug_remove [ "$TERMINAL" != "kitty" ] && exists ueberzug && ueberzug_remove
preview_file "$selection" preview_file "$selection"
done done
[ "$USE_UEBERZUG" -ne 0 ] && rm "$FIFO_UEBERZUG" [ "$TERMINAL" != "kitty" ] && exists ueberzug && rm "$FIFO_UEBERZUG"
} }
@ -324,16 +294,13 @@ if [ "$PREVIEW_MODE" ]; then
exit 1 exit 1
fi fi
if [ "$USE_UEBERZUG" -ne 0 ]; then if [ "$TERMINAL" != "kitty" ] && exists ueberzug; then
FIFO_UEBERZUG="$TMPDIR/nnn-ueberzug-fifo.$$" FIFO_UEBERZUG="$TMPDIR/nnn-ueberzug-fifo.$$"
mkfifo "$FIFO_UEBERZUG" mkfifo "$FIFO_UEBERZUG"
fi
preview_file "$1"
if [ "$USE_UEBERZUG" -ne 0 ]; then
tail --follow "$FIFO_UEBERZUG" | ueberzug layer --silent --parser json & tail --follow "$FIFO_UEBERZUG" | ueberzug layer --silent --parser json &
fi fi
preview_file "$1"
preview_fifo & preview_fifo &
wait wait