carveimg

README

Carve & Img

Two image viewing utilities for the terminal. Both of them can display images in only 16 colors.

• carve - uses content-aware image resizing before displaying the image
• img - uses regular image resizing before displaying the image

Screenshots

Original PNG image	In a VT100 compatible terminal emulator, using seam carving for content-aware image resizing

Original PNG image	In carve (wonky, but higher information density)	In img (may look better, but retains less information

Installation

With Go 1.17 or later:

go install github.com/xyproto/carveimg/cmd/img@latest
go install github.com/xyproto/carveimg/cmd/carve@latest

The carve utility

• The image resizing is done with github.com/esimov/caire.
• The palette reduction is done with github.com/xyproto/palgen.
• The image reszing may be very slow for larger images.

The img utilitiy

• The image resizing is done with golang.org/x/image/draw and the CatmullRom kernel.
• The palette reduction is done with github.com/xyproto/palgen.

General info

• Version: 1.4.6
• License: BSD-3
• Author: Alexander F. Rødseth <xyproto@archlinux.org>

Documentation

Index

• Variables
• func ConvertToNRGBA(img image.Image) (*image.NRGBA, error)
• func Draw(canvas *vt100.Canvas, m image.Image) error
• func LoadImage(filename string) (*image.NRGBA, error)

Variables

var DrawRune = '▒'

Functions

func ConvertToNRGBA

func ConvertToNRGBA(img image.Image) (*image.NRGBA, error)

func Draw

func Draw(canvas *vt100.Canvas, m image.Image) error

Draw attempts to draw the given image.Image onto a VT100 Canvas

func LoadImage

func LoadImage(filename string) (*image.NRGBA, error)

LoadImage loads an image and converts it to *image.NRGBA. Currently, PNG, GIF and JPEG images are supported.