From c0c31df39ca007bdd07a1b3f0a8914dde0e4c2ce Mon Sep 17 00:00:00 2001 From: Zhizhen He Date: Thu, 5 Nov 2026 16:25:59 +0800 Subject: [PATCH] choose-files: Decode video preview thumbnails only once --- docs/changelog.rst | 3 ++ kittens/choose_files/ffmpeg.go | 29 +++++----- kittens/choose_files/image_preview_test.go | 63 ++++++++++++++++++++++ 3 files changed, 83 insertions(+), 12 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 7f6d491f9..dbec2d137 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -138,6 +138,9 @@ Detailed list of changes - :doc:`choose-files `: Fix concurrent custom preview commands occasionally receiving the path of a different file. +- :doc:`choose-files `: Avoid decoding video preview + thumbnails twice and preserve errors from ffmpeg when generating them. + - macOS: Add a workaround for clicking notifications not focusing the correct OS Window when there are multiple kitty instances because of Cocoa limitations (:iss:`10805`) diff --git a/kittens/choose_files/ffmpeg.go b/kittens/choose_files/ffmpeg.go index 6e65af8a4..451a3e611 100644 --- a/kittens/choose_files/ffmpeg.go +++ b/kittens/choose_files/ffmpeg.go @@ -42,19 +42,17 @@ func ffmpeg_thumbnail_cmd(path, outpath string) *exec.Cmd { ) } -func ffmpeg_thumbnail(path, tempath string, wg *sync.WaitGroup) (ans *images.ImageData, err error) { - defer wg.Done() +func ffmpeg_thumbnail(path, tempath string) error { cmd := ffmpeg_thumbnail_cmd(path, tempath) cmd.Stdin = nil cmd.SysProcAttr = &unix.SysProcAttr{Setsid: true} var stderr bytes.Buffer cmd.Stdout = nil cmd.Stderr = &stderr - if err = cmd.Run(); err != nil { - return ans, fmt.Errorf("failed to use ffmpeg to render video from %s with error: %w and stderr: %s", path, err, stderr.String()) + if err := cmd.Run(); err != nil { + return fmt.Errorf("failed to use ffmpeg to render video from %s with error: %w and stderr: %s", path, err, stderr.String()) } - ans, err = images.OpenImageFromPath(tempath) - return + return nil } type FFMpegFormat struct { @@ -80,8 +78,7 @@ func ffmpeg_metadata_cmd(path string) *exec.Cmd { ) } -func ffmpeg_metadata(path string, wg *sync.WaitGroup) (ans FFMpegMetadata, err error) { - defer wg.Done() +func ffmpeg_metadata(path string) (ans FFMpegMetadata, err error) { cmd := ffmpeg_metadata_cmd(path) cmd.Stdin = nil cmd.SysProcAttr = &unix.SysProcAttr{Setsid: true} @@ -106,14 +103,22 @@ func (c ffmpeg_renderer) Render(path string) (m map[string][]byte, mi metadata, defer func() { _ = os.Remove(tempfile.Name()); tempfile.Close() }() var metadata FFMpegMetadata var metadata_error error - wg.Add(1) - go func() { metadata, metadata_error = ffmpeg_metadata(path, &wg) }() - wg.Add(1) - go func() { img, err = ffmpeg_thumbnail(path, tempfile.Name(), &wg) }() + wg.Add(2) + go func() { + defer wg.Done() + metadata, metadata_error = ffmpeg_metadata(path) + }() + go func() { + defer wg.Done() + err = ffmpeg_thumbnail(path, tempfile.Name()) + }() wg.Wait() if metadata_error != nil { return nil, mi, nil, metadata_error } + if err != nil { + return nil, mi, nil, err + } var ip ImagePreviewRenderer if m, mi, img, err = ip.Render(tempfile.Name()); err != nil { return diff --git a/kittens/choose_files/image_preview_test.go b/kittens/choose_files/image_preview_test.go index a33bbb397..2baf46d76 100644 --- a/kittens/choose_files/image_preview_test.go +++ b/kittens/choose_files/image_preview_test.go @@ -2,8 +2,12 @@ package choose_files import ( "fmt" + "image" + "io" "os" "path/filepath" + "strings" + "sync/atomic" "testing" "time" @@ -174,3 +178,62 @@ func TestCmdPreviewConcurrentRendering(t *testing.T) { t.Errorf("rendering modified shared command arguments: %q", backing) } } + +func TestFFMpegPreviewSingleDecode(t *testing.T) { + dir := t.TempDir() + thumbnail := image.NewNRGBA(image.Rect(0, 0, 2, 1)) + var decodes atomic.Int32 + // A private image format counts full decodes through the real image loader. + // Its magic is unique even when the test is repeated in the same process. + image.RegisterFormat("choose-files-test", dir, func(io.Reader) (image.Image, error) { + decodes.Add(1) + return thumbnail, nil + }, func(io.Reader) (image.Config, error) { + return image.Config{ColorModel: thumbnail.ColorModel(), Width: 2, Height: 1}, nil + }) + write_script := func(t *testing.T, name, body string) { + t.Helper() + if err := os.WriteFile(filepath.Join(dir, name), []byte("#!/bin/sh\n"+body), 0o700); err != nil { + t.Fatal(err) + } + } + write_script(t, "ffprobe", `printf '%s' '{"streams":[{"codec_type":"video","width":2,"height":1}],"format":{"duration":"1.0"}}'`) + t.Setenv("PATH", dir+string(os.PathListSeparator)+os.Getenv("PATH")) + for _, tc := range []struct { + name, content, failure string + want_error bool + want_decodes int32 + }{ + {name: "success", content: dir, want_decodes: 1}, + {name: "ffmpeg-error", content: dir, failure: "printf 'thumbnail generation failed' >&2\nexit 7\n", want_error: true}, + {name: "invalid-thumbnail", content: "not an image", want_error: true}, + } { + t.Run(tc.name, func(t *testing.T) { + decodes.Store(0) + t.Setenv("KITTY_TEST_THUMBNAIL", tc.content) + write_script(t, "ffmpeg", "for output; do :; done\nprintf '%s' \"$KITTY_TEST_THUMBNAIL\" > \"$output\"\n"+tc.failure) + data, md, img, err := ffmpeg_renderer(0).Render(filepath.Join(dir, "video.mp4")) + if (err != nil) != tc.want_error { + t.Fatalf("unexpected render error: %v", err) + } + if tc.failure != "" && !strings.Contains(err.Error(), "thumbnail generation failed") { + t.Errorf("ffmpeg stderr was lost: %v", err) + } + if got := decodes.Load(); got != tc.want_decodes { + t.Errorf("decoded thumbnail %d times, expected %d", got, tc.want_decodes) + } + if tc.want_error { + if data != nil || img != nil { + t.Fatal("failed rendering returned an image") + } + return + } + if img == nil || img.Width != 2 || img.Height != 1 || len(img.Frames) != 1 || md.image == nil || len(data[IMAGE_METADATA_KEY]) == 0 || len(data[IMAGE_DATA_PREFIX+"0"]) == 0 { + t.Fatalf("missing rendered image or serialized data: %#v, %#v", img, data) + } + if info, ok := md.custom.(*FFMpegMetadata); !ok || info.Format.Duration != "1.0" || len(info.Streams) != 1 || info.Streams[0].Width != 2 { + t.Errorf("missing video metadata: %#v", md.custom) + } + }) + } +}