path: root/thumbnailer.go

package main

import (
	"bufio"
	"errors"
	"flag"
	"fmt"
	"image"
	"image/color"
	_ "image/gif"
	_ "image/jpeg"
	_ "image/png"
	"io"
	"io/fs"
	"os"
	"path/filepath"
	"slices"
	"strings"

	runewidth "github.com/mattn/go-runewidth"
	_ "golang.org/x/image/bmp"
	"golang.org/x/image/draw"
	_ "golang.org/x/image/tiff"
	_ "golang.org/x/image/webp"
	"golang.org/x/term"
)

var (
	x = flag.Int("x", 15, "set image width in columns")
	y = flag.Int("y", 0, "set image height in rows")
	m = flagPrintMode(flag.CommandLine, "m", modeBlock24, "one of 'block', 'block24', or 'sixel'")
)

type printMode int

const (
	modeInvalid printMode = iota
	modeBlock
	modeBlock24
	modeSixel
)

type printModeValue printMode

func (m *printModeValue) String() string {
	switch printMode(*m) {
	case modeBlock:
		return "block"
	case modeBlock24:
		return "block24"
	case modeSixel:
		return "sixel"
	default:
		return "invalid"
	}
}

func (m *printModeValue) Set(s string) error {
	var mode printMode
	switch s {
	case "block":
		mode = modeBlock
	case "block24":
		mode = modeBlock24
	case "sixel":
		mode = modeSixel
	default:
		return fmt.Errorf("bad mode type %q, should be one of 'block', 'block24', or 'sixel'", s)
	}
	*m = printModeValue(mode)
	return nil
}

func flagPrintMode(fs *flag.FlagSet, name string, value printMode, usage string) *printMode {
	fs.Var((*printModeValue)(&value), name, usage)
	return &value
}

func isDir(filename string) (bool, error) {
	stat, err := os.Stat(filename)
	if err != nil {
		return false, err
	}
	return stat.IsDir(), nil
}

func isLink(filename string) (bool, error) {
	stat, err := os.Lstat(filename)
	if err != nil {
		return false, err
	}
	return stat.Mode().Type() == fs.ModeSymlink, nil
}

var errNotAnImage = errors.New("not an image")

type notAnImageError struct {
	error
}

func (e *notAnImageError) Is(err error) bool {
	return err == errNotAnImage
}

func load(filename string) (image.Image, error) {
	file := os.Stdin
	if filename != "-" {
		var err error
		file, err = os.Open(filename)
		if err != nil {
			if errors.Is(err, fs.ErrNotExist) {
				if isLink, _ := isLink(filename); isLink {
					return nil, &notAnImageError{err}
				}
			}
			return nil, err
		}
		defer file.Close()
	}

	img, _, err := image.Decode(file)
	if err != nil {
		return nil, &notAnImageError{fmt.Errorf("decode %q: %s", filename, err)}
	}

	return img, nil
}

var (
	xtermBlack         = color.RGBA{R: 0x00, G: 0x00, B: 0x00, A: 0xff}
	xtermRed           = color.RGBA{R: 0xcd, G: 0x00, B: 0x00, A: 0xff}
	xtermGreen         = color.RGBA{R: 0x00, G: 0xcd, B: 0x00, A: 0xff}
	xtermYellow        = color.RGBA{R: 0xcd, G: 0xcd, B: 0x00, A: 0xff}
	xtermBlue          = color.RGBA{R: 0x00, G: 0x00, B: 0xee, A: 0xff}
	xtermMagenta       = color.RGBA{R: 0xcd, G: 0x00, B: 0xcd, A: 0xff}
	xtermCyan          = color.RGBA{R: 0x00, G: 0xcd, B: 0xcd, A: 0xff}
	xtermWhite         = color.RGBA{R: 0xe5, G: 0xe5, B: 0xe5, A: 0xff}
	xtermGray          = color.RGBA{R: 0x7f, G: 0x7f, B: 0x7f, A: 0xff}
	xtermBrightRed     = color.RGBA{R: 0xff, G: 0x00, B: 0x00, A: 0xff}
	xtermBrightGreen   = color.RGBA{R: 0x00, G: 0xff, B: 0x00, A: 0xff}
	xtermBrightYellow  = color.RGBA{R: 0xff, G: 0xff, B: 0x00, A: 0xff}
	xtermBrightBlue    = color.RGBA{R: 0x5c, G: 0x5c, B: 0xff, A: 0xff}
	xtermBrightMagenta = color.RGBA{R: 0xff, G: 0x00, B: 0xff, A: 0xff}
	xtermBrightCyan    = color.RGBA{R: 0x00, G: 0xff, B: 0xff, A: 0xff}
	xtermBrightWhite   = color.RGBA{R: 0xff, G: 0xff, B: 0xff, A: 0xff}
)

var xtermPalette = color.Palette{xtermBlack, xtermRed, xtermGreen, xtermYellow, xtermBlue, xtermMagenta, xtermCyan, xtermWhite, xtermGray, xtermBrightRed, xtermBrightGreen, xtermBrightYellow, xtermBrightBlue, xtermBrightMagenta, xtermBrightCyan, xtermBrightWhite}

func xtermColorCode(c color.Color) int {
	switch c {
	case xtermBlack:
		return 0
	case xtermRed:
		return 1
	case xtermGreen:
		return 2
	case xtermYellow:
		return 3
	case xtermBlue:
		return 4
	case xtermMagenta:
		return 5
	case xtermCyan:
		return 6
	case xtermWhite:
		return 7
	case xtermGray:
		return 60
	case xtermBrightRed:
		return 61
	case xtermBrightGreen:
		return 62
	case xtermBrightYellow:
		return 63
	case xtermBrightBlue:
		return 64
	case xtermBrightMagenta:
		return 65
	case xtermBrightCyan:
		return 66
	case xtermBrightWhite:
		return 67
	default:
		panic("not an xterm color")
	}
}

func printImgXterm(img image.Image, cols, lines int) (string, int) {
	scaled := image.NewRGBA(image.Rect(0, 0, cols, 2*lines))
	draw.BiLinear.Scale(scaled, scaled.Bounds(), img, img.Bounds(), draw.Over, nil)
	paletted := image.NewPaletted(scaled.Bounds(), xtermPalette)
	draw.FloydSteinberg.Draw(paletted, paletted.Bounds(), scaled, image.Point{})

	s := new(strings.Builder)
	for y := 0; y < 2*lines; y += 2 {
		if y > 0 {
			fmt.Fprintln(s)
		}
		for x := 0; x < cols; x++ {
			hi := xtermColorCode(paletted.At(x, y))
			lo := xtermColorCode(paletted.At(x, y+1))
			fmt.Fprintf(s, "\033[%dm\033[%dm▀", 30+hi, 40+lo)
		}
		fmt.Fprint(s, "\033[39m\033[49m")
	}
	return s.String(), cols
}

func printImg(img image.Image, cols, lines int) (string, int) {
	// Try not to stretch the image.
	if lines <= 0 || img.Bounds().Dy()*cols <= img.Bounds().Dx()*lines*5/2 {
		lines = img.Bounds().Dy() * cols / (img.Bounds().Dx() * 5 / 2)
	} else {
		cols = img.Bounds().Dx() * lines * 5 / 2 / img.Bounds().Dy()
	}
	if lines == 0 || cols == 0 {
		return "", 0
	}

	if *m == modeBlock {
		return printImgXterm(img, cols, lines)
	}

	dst := image.NewRGBA(image.Rect(0, 0, cols, 2*lines))
	draw.BiLinear.Scale(dst, dst.Bounds(), img, img.Bounds(), draw.Over, nil)

	s := new(strings.Builder)
	for y := 0; y < 2*lines; y += 2 {
		if y > 0 {
			fmt.Fprintln(s)
		}
		for x := 0; x < cols; x++ {
			hiR, hiG, hiB, _ := dst.At(x, y).RGBA()
			loR, loG, loB, _ := dst.At(x, y+1).RGBA()
			fmt.Fprintf(s, "\033[38;2;%d;%d;%dm\033[48;2;%d;%d;%dm▀",
				hiR>>8, hiG>>8, hiB>>8,
				loR>>8, loG>>8, loB>>8)
		}
		fmt.Fprint(s, "\033[39m\033[49m")
	}
	return s.String(), cols
}

type img struct {
	s        string
	width    int
	filename string
}

func compositeImages(w io.Writer, images []img, imageWidth, imagesPerRow int) {
	for row := range slices.Chunk(images, imagesPerRow) {
		rowLines := make([][]string, len(row))
		names := make([][]string, len(row))
		for i, img := range row {
			rowLines[i] = strings.Split(img.s, "\n")
			names[i] = strings.Split(runewidth.Wrap(img.filename, imageWidth), "\n")
		}
		maxLen := 0
		for imgIdx, img := range rowLines {
			maxLen = max(maxLen, len(img)+len(names[imgIdx]))
		}
		for i := 0; i < maxLen; i++ {
			if i > 0 {
				fmt.Fprintln(w)
			}
			for imgIdx, img := range rowLines {
				if imgIdx > 0 {
					fmt.Fprint(w, " ")
				}
				if i < len(img) {
					fmt.Fprintf(w, "%s%*s", img[i], max(imageWidth-row[imgIdx].width, 0), "")
				} else if i < len(img)+len(names[imgIdx]) {
					fmt.Fprintf(w, "%s", runewidth.FillRight(names[imgIdx][i-len(img)], imageWidth))
				} else {
					fmt.Fprintf(w, "%*s", imageWidth, "")
				}
			}
		}
		fmt.Fprintln(w)
	}
}

func thumbnailFiles(w io.Writer, cols, lines, imagesPerRow int, args []string) error {
	images := make([]img, len(args))
	for i, arg := range args {
		image, err := load(arg)
		if err != nil {
			return err
		}
		imageString, width := printImg(image, cols, lines)
		images[i] = img{imageString, width, filepath.Base(arg)}
	}
	compositeImages(w, images, cols, imagesPerRow)
	return nil
}

func readDir(d string) ([]string, error) {
	files, err := os.ReadDir(d)
	if err != nil {
		return nil, err
	}
	filenames := make([]string, len(files))
	for i, f := range files {
		filenames[i] = filepath.Join(d, f.Name())
	}
	return filenames, nil
}

func thumbnailDir(w io.Writer, cols, lines, imagesPerRow int, dir string) error {
	files, err := readDir(dir)
	if err != nil {
		return err
	}
	var images []img
	for _, file := range files {
		image, err := load(file)
		if err != nil {
			if errors.Is(err, errNotAnImage) {
				continue
			}
			return err
		}
		imageString, width := printImg(image, cols, lines)
		images = append(images, img{imageString, width, filepath.Base(file)})
	}
	compositeImages(w, images, cols, imagesPerRow)
	return nil
}

func thumbnailer(args []string) error {
	cols := *x
	lines := *y
	if cols <= 0 {
		return fmt.Errorf("-x must be greater than 0")
	}
	termCols, _, err := term.GetSize(1)
	if err != nil {
		return fmt.Errorf("terminal size: %s", err)
	}

	imagesPerRow := termCols / (cols + 1)

	var files, dirs []string
	if len(args) == 0 {
		dirs = []string{"."}
	} else {
		for _, arg := range args {
			isDir, err := isDir(arg)
			if err != nil {
				return err
			}
			if isDir {
				dirs = append(dirs, arg)
			} else {
				files = append(files, arg)
			}
		}
	}
	w := bufio.NewWriter(os.Stdout)
	defer w.Flush()
	if err := thumbnailFiles(w, cols, lines, imagesPerRow, files); err != nil {
		return err
	}
	if len(files) > 0 && len(dirs) > 0 {
		fmt.Fprintln(w)
	}
	for i, d := range dirs {
		if i > 0 {
			fmt.Fprintln(w)
		}
		if len(dirs) > 1 {
			fmt.Fprintf(w, "%s:\n", d)
		}
		if err := thumbnailDir(w, cols, lines, imagesPerRow, d); err != nil {
			return err
		}
	}

	return nil
}

func main() {
	flag.Usage = func() {
		fmt.Fprintf(os.Stderr, "Usage: thumbnailer [FILE]...\n")
	}
	flag.Parse()

	if err := thumbnailer(flag.Args()); err != nil {
		fmt.Fprintf(os.Stderr, "Failed: %s\n", err)
		os.Exit(1)
	}
}