// License: GPLv3 Copyright: 2023, Kovid Goyal, package images import ( "bytes" "encoding/json" "errors" "fmt" "image" "image/color" "image/gif" "io" "os" "os/exec" "path/filepath" "strconv" "strings" "kitty/tools/tui/graphics" "kitty/tools/utils" "kitty/tools/utils/shm" "github.com/disintegration/imaging" "golang.org/x/exp/slices" ) var _ = fmt.Print type ImageFrame struct { Width, Height, Left, Top int Number int // 1-based number Compose_onto int // number of frame to compose onto Delay_ms int32 // negative for gapless frame, zero ignored, positive is number of ms Is_opaque bool Img image.Image } type ImageData struct { Width, Height int Format_uppercase string Frames []*ImageFrame } func CalcMinimumGIFGap(gaps []int) int { // Some broken GIF images have all zero gaps, browsers with their usual // idiot ideas render these with a default 100ms gap https://bugzilla.mozilla.org/show_bug.cgi?id=125137 // Browsers actually force a 100ms gap at any zero gap frame, but that // just means it is impossible to deliberately use zero gap frames for // sophisticated blending, so we dont do that. max_gap := utils.Max(0, gaps...) min_gap := 0 if max_gap <= 0 { min_gap = 10 } return min_gap } func SetGIFFrameDisposal(number, anchor_frame int, disposal byte) (int, int) { compose_onto := 0 if number > 1 { switch disposal { case gif.DisposalNone: compose_onto = number - 1 anchor_frame = number case gif.DisposalBackground: // see https://github.com/golang/go/issues/20694 anchor_frame = number case gif.DisposalPrevious: compose_onto = anchor_frame } } return anchor_frame, compose_onto } func MakeTempDir(template string) (ans string, err error) { if template == "" { template = "kitty-img-*" } if shm.SHM_DIR != "" { ans, err = os.MkdirTemp(shm.SHM_DIR, template) if err == nil { return } } return os.MkdirTemp("", template) } func check_resize(frame *ImageFrame, filename string) error { // ImageMagick sometimes generates RGBA images smaller than the specified // size. See https://github.com/kovidgoyal/kitty/issues/276 for examples s, err := os.Stat(filename) if err != nil { return err } sz := int(s.Size()) bytes_per_pixel := 4 if frame.Is_opaque { bytes_per_pixel = 3 } expected_size := bytes_per_pixel * frame.Width * frame.Height if sz < expected_size { missing := expected_size - sz if missing%(bytes_per_pixel*frame.Width) != 0 { return fmt.Errorf("ImageMagick failed to resize correctly. It generated %d < %d of data (w=%d h=%d bpp=%d)", sz, expected_size, frame.Width, frame.Height, bytes_per_pixel) } frame.Height -= missing / (bytes_per_pixel * frame.Width) } return nil } func (frame *ImageFrame) set_delay(min_gap, delay int) { frame.Delay_ms = int32(utils.Max(min_gap, delay) * 10) if frame.Delay_ms == 0 { frame.Delay_ms = -1 // gapless frame in the graphics protocol } } func open_native_gif(f io.Reader, ans *ImageData) error { gif_frames, err := gif.DecodeAll(f) if err != nil { return err } min_gap := CalcMinimumGIFGap(gif_frames.Delay) anchor_frame := 1 for i, paletted_img := range gif_frames.Image { b := paletted_img.Bounds() frame := ImageFrame{Img: paletted_img, Left: b.Min.X, Top: b.Min.Y, Width: b.Dx(), Height: b.Dy(), Number: len(ans.Frames) + 1, Is_opaque: paletted_img.Opaque()} frame.set_delay(min_gap, gif_frames.Delay[i]) anchor_frame, frame.Compose_onto = SetGIFFrameDisposal(frame.Number, anchor_frame, gif_frames.Disposal[i]) ans.Frames = append(ans.Frames, &frame) } return nil } func OpenNativeImageFromReader(f io.ReadSeeker) (ans *ImageData, err error) { c, fmt, err := image.DecodeConfig(f) if err != nil { return nil, err } f.Seek(0, os.SEEK_SET) ans = &ImageData{Width: c.Width, Height: c.Height, Format_uppercase: strings.ToUpper(fmt)} if ans.Format_uppercase == "GIF" { err = open_native_gif(f, ans) if err != nil { return nil, err } } else { img, err := imaging.Decode(f, imaging.AutoOrientation(true)) if err != nil { return nil, err } b := img.Bounds() ans.Frames = []*ImageFrame{{Img: img, Left: b.Min.X, Top: b.Min.Y, Width: b.Dx(), Height: b.Dy()}} ans.Frames[0].Is_opaque = c.ColorModel == color.YCbCrModel || c.ColorModel == color.GrayModel || c.ColorModel == color.Gray16Model || c.ColorModel == color.CMYKModel || ans.Format_uppercase == "JPEG" || ans.Format_uppercase == "JPG" || IsOpaque(img) } return } var MagickExe = (&utils.Once[string]{Run: func() string { return utils.FindExe("magick") }}).Get func RunMagick(path string, cmd []string) ([]byte, error) { if MagickExe() != "magick" { cmd = append([]string{MagickExe()}, cmd...) } c := exec.Command(cmd[0], cmd[1:]...) output, err := c.Output() if err != nil { var exit_err *exec.ExitError if errors.As(err, &exit_err) { return nil, fmt.Errorf("Running the command: %s\nFailed with error:\n%s", strings.Join(cmd, " "), string(exit_err.Stderr)) } return nil, fmt.Errorf("Could not find the program: %#v. Is ImageMagick installed and in your PATH?", cmd[0]) } return output, nil } type IdentifyOutput struct { Fmt, Canvas, Transparency, Gap, Index, Size, Dpi, Dispose, Orientation string } type IdentifyRecord struct { Fmt_uppercase string Gap int Canvas struct{ Width, Height, Left, Top int } Width, Height int Dpi struct{ X, Y float64 } Index int Mode graphics.GRT_f Needs_blend bool Disposal int Dimensions_swapped bool } func parse_identify_record(ans *IdentifyRecord, raw *IdentifyOutput) (err error) { ans.Fmt_uppercase = strings.ToUpper(raw.Fmt) if raw.Gap != "" { ans.Gap, err = strconv.Atoi(raw.Gap) if err != nil { return fmt.Errorf("Invalid gap value in identify output: %s", raw.Gap) } ans.Gap = utils.Max(0, ans.Gap) } area, pos, found := strings.Cut(raw.Canvas, "+") ok := false if found { w, h, found := strings.Cut(area, "x") if found { ans.Canvas.Width, err = strconv.Atoi(w) if err == nil { ans.Canvas.Height, err = strconv.Atoi(h) if err == nil { x, y, found := strings.Cut(pos, "+") if found { ans.Canvas.Left, err = strconv.Atoi(x) if err == nil { ans.Canvas.Top, err = strconv.Atoi(y) ok = true } } } } } } if !ok { return fmt.Errorf("Invalid canvas value in identify output: %s", raw.Canvas) } w, h, found := strings.Cut(raw.Size, "x") ok = false if found { ans.Width, err = strconv.Atoi(w) if err == nil { ans.Height, err = strconv.Atoi(h) ok = true } } if !ok { return fmt.Errorf("Invalid size value in identify output: %s", raw.Size) } x, y, found := strings.Cut(raw.Dpi, "x") ok = false if found { ans.Dpi.X, err = strconv.ParseFloat(x, 64) if err == nil { ans.Dpi.Y, err = strconv.ParseFloat(y, 64) ok = true } } if !ok { return fmt.Errorf("Invalid dpi value in identify output: %s", raw.Dpi) } ans.Index, err = strconv.Atoi(raw.Index) if err != nil { return fmt.Errorf("Invalid index value in identify output: %s", raw.Index) } q := strings.ToLower(raw.Transparency) if q == "blend" || q == "true" { ans.Mode = graphics.GRT_format_rgba } else { ans.Mode = graphics.GRT_format_rgb } ans.Needs_blend = q == "blend" switch strings.ToLower(raw.Dispose) { case "undefined": ans.Disposal = 0 case "none": ans.Disposal = gif.DisposalNone case "background": ans.Disposal = gif.DisposalBackground case "previous": ans.Disposal = gif.DisposalPrevious default: return fmt.Errorf("Invalid value for dispose: %s", raw.Dispose) } switch raw.Orientation { case "5", "6", "7", "8": ans.Dimensions_swapped = true } if ans.Dimensions_swapped { ans.Canvas.Width, ans.Canvas.Height = ans.Canvas.Height, ans.Canvas.Width ans.Width, ans.Height = ans.Height, ans.Width } return } func IdentifyWithMagick(path string) (ans []IdentifyRecord, err error) { cmd := []string{"identify"} q := `{"fmt":"%m","canvas":"%g","transparency":"%A","gap":"%T","index":"%p","size":"%wx%h",` + `"dpi":"%xx%y","dispose":"%D","orientation":"%[EXIF:Orientation]"},` cmd = append(cmd, "-format", q, "--", path) output, err := RunMagick(path, cmd) if err != nil { return nil, err } output = bytes.TrimRight(bytes.TrimSpace(output), ",") raw_json := make([]byte, 0, len(output)+2) raw_json = append(raw_json, '[') raw_json = append(raw_json, output...) raw_json = append(raw_json, ']') var records []IdentifyOutput err = json.Unmarshal(raw_json, &records) if err != nil { return nil, fmt.Errorf("The ImageMagick identify program returned malformed output, with error: %w", err) } ans = make([]IdentifyRecord, len(records)) for i, rec := range records { err = parse_identify_record(&ans[i], &rec) if err != nil { return nil, err } } return ans, nil } type RenderOptions struct { RemoveAlpha *NRGBColor Flip, Flop bool ResizeTo image.Point OnlyFirstFrame bool TempfilenameTemplate string } func RenderWithMagick(path string, ro *RenderOptions, frames []IdentifyRecord) (ans []*ImageFrame, fmap map[int]string, err error) { cmd := []string{"convert"} ans = make([]*ImageFrame, 0, len(frames)) fmap = make(map[int]string, len(frames)) defer func() { if err != nil { for _, f := range fmap { os.Remove(f) } } }() if ro.RemoveAlpha != nil { cmd = append(cmd, "-background", ro.RemoveAlpha.AsSharp(), "-alpha", "remove") } else { cmd = append(cmd, "-background", "none") } if ro.Flip { cmd = append(cmd, "-flip") } if ro.Flop { cmd = append(cmd, "-flop") } cpath := path if ro.OnlyFirstFrame { cpath += "[0]" } has_multiple_frames := len(frames) > 1 get_multiple_frames := has_multiple_frames && !ro.OnlyFirstFrame cmd = append(cmd, "--", cpath, "-auto-orient") if ro.ResizeTo.X > 0 { rcmd := []string{"-resize", fmt.Sprintf("%dx%d!", ro.ResizeTo.X, ro.ResizeTo.Y)} if get_multiple_frames { cmd = append(cmd, "-coalesce") cmd = append(cmd, rcmd...) cmd = append(cmd, "-deconstruct") } else { cmd = append(cmd, rcmd...) } } cmd = append(cmd, "-depth", "8", "-set", "filename:f", "%w-%h-%g-%p") if get_multiple_frames { cmd = append(cmd, "+adjoin") } tdir, err := MakeTempDir(ro.TempfilenameTemplate) if err != nil { err = fmt.Errorf("Failed to create temporary directory to hold ImageMagick output with error: %w", err) return } defer os.RemoveAll(tdir) mode := "rgba" if frames[0].Mode == graphics.GRT_format_rgb { mode = "rgb" } cmd = append(cmd, filepath.Join(tdir, "im-%[filename:f]."+mode)) _, err = RunMagick(path, cmd) if err != nil { return } entries, err := os.ReadDir(tdir) if err != nil { err = fmt.Errorf("Failed to read temp dir used to store ImageMagick output with error: %w", err) return } base_dir := filepath.Dir(tdir) gaps := make([]int, len(frames)) for i, frame := range frames { gaps[i] = frame.Gap } min_gap := CalcMinimumGIFGap(gaps) for _, entry := range entries { fname := entry.Name() p, _, _ := strings.Cut(fname, ".") parts := strings.Split(p, "-") if len(parts) < 5 { continue } index, cerr := strconv.Atoi(parts[len(parts)-1]) if cerr != nil || index < 0 || index >= len(frames) { continue } width, cerr := strconv.Atoi(parts[1]) if cerr != nil { continue } height, cerr := strconv.Atoi(parts[2]) if cerr != nil { continue } _, pos, found := strings.Cut(parts[3], "+") if !found { continue } px, py, found := strings.Cut(pos, "+") if !found { continue } x, cerr := strconv.Atoi(px) if cerr != nil { continue } y, cerr := strconv.Atoi(py) if cerr != nil { continue } identify_data := frames[index] df, cerr := os.CreateTemp(base_dir, graphics.TempTemplate+"."+mode) if cerr != nil { err = fmt.Errorf("Failed to create a temporary file in %s with error: %w", base_dir, cerr) return } err = os.Rename(filepath.Join(tdir, fname), df.Name()) if err != nil { err = fmt.Errorf("Failed to rename a temporary file in %s with error: %w", tdir, err) return } df.Close() fmap[index+1] = df.Name() frame := ImageFrame{ Number: index + 1, Width: width, Height: height, Left: x, Top: y, Is_opaque: identify_data.Mode == graphics.GRT_format_rgb, } frame.set_delay(min_gap, identify_data.Gap) err = check_resize(&frame, df.Name()) if err != nil { return } ans = append(ans, &frame) } if len(ans) < len(frames) { err = fmt.Errorf("Failed to render %d out of %d frames", len(frames)-len(ans), len(frames)) return } slices.SortFunc(ans, func(a, b *ImageFrame) bool { return a.Number < b.Number }) anchor_frame := 1 for i, frame := range ans { anchor_frame, frame.Compose_onto = SetGIFFrameDisposal(frame.Number, anchor_frame, byte(frames[i].Disposal)) } return } func OpenImageFromPathWithMagick(path string) (ans *ImageData, err error) { identify_records, err := IdentifyWithMagick(path) if err != nil { return nil, fmt.Errorf("Failed to identify image at %#v with error: %w", path, err) } frames, filenames, err := RenderWithMagick(path, &RenderOptions{}, identify_records) if err != nil { return nil, fmt.Errorf("Failed to render image at %#v with error: %w", path, err) } defer func() { for _, f := range filenames { os.Remove(f) } }() for _, frame := range frames { filename := filenames[frame.Number] data, err := os.ReadFile(filename) if err != nil { return nil, fmt.Errorf("Failed to read temp file for image %#v at %#v with error: %w", path, filename, err) } dest_rect := image.Rect(0, 0, frame.Width, frame.Height) if frame.Is_opaque { frame.Img = &NRGB{Pix: data, Stride: frame.Width * 3, Rect: dest_rect} } else { frame.Img = &image.NRGBA{Pix: data, Stride: frame.Width * 4, Rect: dest_rect} } } ans = &ImageData{ Width: frames[0].Width, Height: frames[0].Height, Format_uppercase: identify_records[0].Fmt_uppercase, Frames: frames, } return ans, nil } func OpenImageFromPath(path string) (ans *ImageData, err error) { mt := utils.GuessMimeType(path) if DecodableImageTypes[mt] { f, err := os.Open(path) if err != nil { return nil, err } defer f.Close() ans, err = OpenNativeImageFromReader(f) if err != nil { return nil, fmt.Errorf("Failed to load image at %#v with error: %w", path, err) } } else { return OpenImageFromPathWithMagick(path) } return }