Files
hyperframes/packages/engine/src/services/videoFrameExtractor.test.ts
T
Miguel Ángel 48f158a0c2 perf(engine): one-pass SDR-to-HDR extraction with cache-key transform (#1902)
* perf(engine): one-pass SDR-to-HDR extraction with cache-key transform

Mixed-HDR compositions converted each SDR source with a full libx264
re-encode (convertSdrToHdr) before extraction. The BT.709 to BT.2020
colorspace remap now runs as a filter inside the extraction pass
itself; convertSdrToHdr and the _hdr_normalized intermediate are
deleted. Same shape as the earlier one-pass VFR change.

Also fixes a cache-poisoning bug this exposed: the HDR preflight
rewrote entry.videoPath AFTER the cache-key snapshot, so a mixed-HDR
render cached converted frames under the plain source key and a later
SDR render of the same trim would have served HDR-tinted frames. The
cache key now carries an optional transform discriminator; keys
without a transform stay byte-compatible with existing entries.

* fix(engine): attribute SDR-to-HDR extract failures, pin filter-order intent

Review hardening for one-pass SDR-to-HDR:

- ffmpeg failures now carry an 'SDR→HDR conversion failed (colorspace
  filter in extract pass)' prefix when the remap is in the chain, so a
  filter-less ffmpeg build fails loudly with attribution instead of a
  generic extract error.
- Comments pin the fps-before-colorspace ordering intent and mark
  sdrToHdrTransfers as the canonical read for both the cache key and
  extraction options.
- Cross-render cache-poisoning regression test now compares frame
  BYTES across the cache boundary: mixed-HDR render then plain-SDR
  render of the same trim must produce different pixels, and a repeat
  plain render must hit the plain entry with byte-identical frames.
2026-07-03 15:08:51 -07:00

1204 lines
41 KiB
TypeScript

import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
import {
existsSync,
mkdirSync,
readFileSync,
mkdtempSync,
readdirSync,
rmSync,
statSync,
utimesSync,
writeFileSync,
} from "node:fs";
import { join } from "node:path";
import { tmpdir } from "node:os";
import { spawnSync } from "node:child_process";
import {
parseVideoElements,
parseImageElements,
extractAllVideoFrames,
extractVideoFramesRange,
createFrameLookupTable,
resolveProjectRelativeSrc,
resolveFrameFormat,
codecMayHaveAlpha,
decoderForCodec,
getFrameAtTime,
analyzeClipMediaFit,
type VideoElement,
type ExtractedFrames,
type ExtractionResult,
} from "./videoFrameExtractor.js";
import { extractVideoMetadata, type VideoMetadata } from "../utils/ffprobe.js";
import { runFfmpeg } from "../utils/runFfmpeg.js";
import { COMPLETE_SENTINEL, SCHEMA_PREFIX } from "./extractionCache.js";
// ffmpeg is not preinstalled on GitHub's ubuntu-24.04 runners. The producer
// regression test at packages/producer/tests/vfr-screen-recording/ runs inside
// Dockerfile.test (which does include ffmpeg) and is the primary CI signal
// for this bug. Locally and in any CI job with ffmpeg on PATH, the tests
// below run too — they exercise the extractor in isolation against a
// synthesized VFR fixture.
const HAS_FFMPEG = spawnSync("ffmpeg", ["-version"]).status === 0;
// Codec-based alpha defaulting replaces tag-based detection (the
// alpha_mode/ALPHA_MODE case bug — see ffprobe.test.ts for the regression
// pin on that). The extractor uses these helpers for two decisions:
// 1. whether to force the alpha-aware decoder (libvpx-vp9 for VP9, libvpx
// for VP8)
// 2. whether to default the cached frame format to PNG (with alpha) vs JPG
// The "default to capable" trade is small file-size growth on opaque VP9
// content for correctness on alpha-having content even when the sidecar tag
// is missing or muxed with the wrong case.
describe("codec alpha capability", () => {
it("flags VP9, VP8, and ProRes as alpha-capable", () => {
expect(codecMayHaveAlpha("vp9")).toBe(true);
expect(codecMayHaveAlpha("VP9")).toBe(true);
expect(codecMayHaveAlpha("vp8")).toBe(true);
expect(codecMayHaveAlpha("prores")).toBe(true);
});
it("does not flag h264 / h265 / mpeg4 (no alpha in their bitstreams)", () => {
expect(codecMayHaveAlpha("h264")).toBe(false);
expect(codecMayHaveAlpha("h265")).toBe(false);
expect(codecMayHaveAlpha("hevc")).toBe(false);
expect(codecMayHaveAlpha("mpeg4")).toBe(false);
});
it("treats undefined / empty input as non-alpha", () => {
expect(codecMayHaveAlpha(undefined)).toBe(false);
expect(codecMayHaveAlpha("")).toBe(false);
});
it("returns the alpha-aware decoder name for VP9 and VP8", () => {
expect(decoderForCodec("vp9")).toBe("libvpx-vp9");
expect(decoderForCodec("VP9")).toBe("libvpx-vp9");
expect(decoderForCodec("vp8")).toBe("libvpx");
});
});
describe("resolveFrameFormat", () => {
function metadata(overrides: Partial<VideoMetadata> = {}): VideoMetadata {
return {
durationSeconds: 1,
width: 320,
height: 180,
fps: 30,
hasAudio: false,
videoCodec: "h264",
colorSpace: {
colorTransfer: "bt709",
colorPrimaries: "bt709",
colorSpace: "bt709",
},
isVFR: false,
hasAlpha: false,
...overrides,
};
}
it("keeps opaque non-alpha sources on jpg by default", () => {
expect(resolveFrameFormat(metadata(), undefined)).toBe("jpg");
expect(resolveFrameFormat(metadata(), "auto")).toBe("jpg");
});
it("honors explicit png for opaque videos", () => {
expect(resolveFrameFormat(metadata(), "png")).toBe("png");
});
it("honors explicit jpg for opaque videos", () => {
expect(resolveFrameFormat(metadata(), "jpg")).toBe("jpg");
});
it("forces png when alpha is present or the codec can carry alpha", () => {
expect(resolveFrameFormat(metadata({ hasAlpha: true }), "jpg")).toBe("png");
expect(resolveFrameFormat(metadata({ videoCodec: "vp9" }), "jpg")).toBe("png");
});
});
// Regression: a long-standing footgun where `<video src="../assets/foo">`
// inside a sub-composition silently dropped the video from extraction. The
// browser's URL resolver clamps `..` at the served origin's root (so the
// page renders fine in the studio), but `path.join(projectDir, "../assets/foo")`
// normalizes to <parentOfProjectDir>/assets/foo, which doesn't exist —
// extraction skipped, no frame injection, rendered output shows the video's
// first decoded frame for the whole clip duration. The resolver now mirrors
// browser semantics by clamping any traversal that escapes the project root.
describe("resolveProjectRelativeSrc — sub-composition path clamping", () => {
let tmp: string;
beforeAll(() => {
tmp = mkdtempSync(join(tmpdir(), "hf-resolver-"));
mkdirSync(join(tmp, "project", "assets"), { recursive: true });
writeFileSync(join(tmp, "project", "assets", "foo.mp4"), "");
});
afterAll(() => {
rmSync(tmp, { recursive: true, force: true });
});
it("returns the literal join when the file exists at projectDir/src", () => {
const projectDir = join(tmp, "project");
expect(resolveProjectRelativeSrc("assets/foo.mp4", projectDir)).toBe(
join(projectDir, "assets/foo.mp4"),
);
});
it("clamps a leading `../` so `../assets/foo.mp4` resolves to assets/foo.mp4", () => {
const projectDir = join(tmp, "project");
expect(resolveProjectRelativeSrc("../assets/foo.mp4", projectDir)).toBe(
join(projectDir, "assets/foo.mp4"),
);
});
it("clamps multiple leading `../../../` segments", () => {
const projectDir = join(tmp, "project");
expect(resolveProjectRelativeSrc("../../../assets/foo.mp4", projectDir)).toBe(
join(projectDir, "assets/foo.mp4"),
);
});
it("clamps mid-path traversal that escapes baseDir (not just leading `..`)", () => {
// `assets/../../foo.mp4` collapses past projectDir via path.join — this
// case used to silently escape; the resolver now strips embedded `..`
// segments and re-anchors at the project root.
const projectDir = join(tmp, "project");
expect(resolveProjectRelativeSrc("assets/../../assets/foo.mp4", projectDir)).toBe(
join(projectDir, "assets/foo.mp4"),
);
});
it("returns the (non-existent) base-dir path on miss so callers get a stable error message", () => {
const projectDir = join(tmp, "project");
expect(resolveProjectRelativeSrc("../assets/missing.mp4", projectDir)).toBe(
join(projectDir, "../assets/missing.mp4"),
);
});
it("prefers compiled-dir over base-dir when the file exists in both", () => {
const projectDir = join(tmp, "project");
const compiledDir = join(tmp, "compiled");
mkdirSync(join(compiledDir, "assets"), { recursive: true });
writeFileSync(join(compiledDir, "assets", "foo.mp4"), "");
expect(resolveProjectRelativeSrc("assets/foo.mp4", projectDir, compiledDir)).toBe(
join(compiledDir, "assets/foo.mp4"),
);
});
it("resolves percent-encoded non-Latin filenames across scripts", () => {
const projectDir = join(tmp, "project");
const cases = [
["arabic", "%D9%87%D9%86%D8%A7-%D9%85%D8%B1%D9%88%D8%A7.mp4"],
["japanese", "%E6%97%A5%E6%9C%AC%E8%AA%9E.mp4"],
["cyrillic", "%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82.mp4"],
["korean", "%ED%95%9C%EA%B8%80.mp4"],
] as const;
for (const [, encodedFilename] of cases) {
const filename = decodeURIComponent(encodedFilename);
writeFileSync(join(projectDir, "assets", filename), "");
expect(resolveProjectRelativeSrc(`assets/${encodedFilename}`, projectDir)).toBe(
join(projectDir, "assets", filename),
);
}
});
it("falls back to literal filenames when percent sequences are malformed", () => {
const projectDir = join(tmp, "project");
const filename = "100%-discount.mp4";
writeFileSync(join(projectDir, "assets", filename), "");
expect(resolveProjectRelativeSrc(`assets/${filename}`, projectDir)).toBe(
join(projectDir, "assets", filename),
);
});
});
describe("parseVideoElements", () => {
it("parses videos without an id or data-start attribute", () => {
const videos = parseVideoElements('<video src="clip.mp4"></video>');
expect(videos).toHaveLength(1);
expect(videos[0]).toMatchObject({
id: "hf-video-0",
src: "clip.mp4",
start: 0,
end: Infinity,
mediaStart: 0,
loop: false,
hasAudio: false,
});
});
it("preserves explicit ids and derives end from data-duration", () => {
const videos = parseVideoElements(
'<video id="hero" src="clip.mp4" data-start="2" data-duration="5" data-media-start="1.5" data-has-audio="true"></video>',
);
expect(videos).toHaveLength(1);
expect(videos[0]).toEqual({
id: "hero",
src: "clip.mp4",
start: 2,
end: 7,
mediaStart: 1.5,
loop: false,
hasAudio: true,
});
});
it("preserves looped timed video semantics for render frame lookup", () => {
const videos = parseVideoElements(
'<video id="hero" src="clip.webm" data-start="2" data-duration="5" loop></video>',
);
expect(videos[0]).toMatchObject({
id: "hero",
start: 2,
end: 7,
loop: true,
});
});
});
describe("FrameLookupTable", () => {
function fakeExtracted(totalFrames: number, fps: number): ExtractedFrames {
const framePaths = new Map<number, string>();
for (let i = 0; i < totalFrames; i += 1) {
framePaths.set(i, `frame-${i}.jpg`);
}
return {
videoId: "hero",
srcPath: "clip.webm",
outputDir: "/tmp/frames",
framePattern: "frame-%05d.jpg",
fps,
totalFrames,
metadata: {
durationSeconds: totalFrames / fps,
width: 320,
height: 180,
fps,
hasAudio: false,
videoCodec: "vp9",
colorSpace: {
colorTransfer: "bt709",
colorPrimaries: "bt709",
colorSpace: "bt709",
},
isVFR: false,
hasAlpha: false,
},
framePaths,
};
}
it("wraps active frame payloads for looped clips whose display window exceeds source frames", () => {
const table = createFrameLookupTable(
[
{
id: "hero",
src: "clip.webm",
start: 0,
end: 5,
mediaStart: 0,
loop: true,
hasAudio: false,
},
],
[fakeExtracted(30, 30)],
);
expect(table.getActiveFramePayloads(0.5).get("hero")?.frameIndex).toBe(15);
expect(table.getActiveFramePayloads(1.5).get("hero")?.frameIndex).toBe(15);
expect(table.getActiveFramePayloads(4.5).get("hero")?.frameIndex).toBe(15);
});
it("does not hold stale frames for non-looping clips after extracted frames end", () => {
const table = createFrameLookupTable(
[
{
id: "hero",
src: "clip.webm",
start: 0,
end: 5,
mediaStart: 0,
loop: false,
hasAudio: false,
},
],
[fakeExtracted(30, 30)],
);
expect(table.getActiveFramePayloads(0.5).has("hero")).toBe(true);
expect(table.getActiveFramePayloads(1.5).has("hero")).toBe(false);
});
it("holds the last frame at the inclusive clip end (t === end)", () => {
// clip [1,3] with exactly 2s of source frames (60 @ 30fps). The frame
// landing on t === end used to deactivate one frame early and render blank,
// while the runtime keeps the element visible on its last frame.
const table = createFrameLookupTable(
[
{
id: "hero",
src: "clip.webm",
start: 1,
end: 3,
mediaStart: 0,
loop: false,
hasAudio: false,
},
],
[fakeExtracted(60, 30)],
);
const atEnd = table.getActiveFramePayloads(3.0).get("hero");
expect(atEnd?.frameIndex).toBe(59);
// mid-clip is unaffected
expect(table.getActiveFramePayloads(2.5).get("hero")?.frameIndex).toBe(45);
});
it("holds the last frame at the clip end even when the source is shorter than the window", () => {
// clip [0,5] with only 1s of source (30 @ 30fps). The mid-clip tail stays
// blank (source exhausted), but t === end still holds the last frame to
// match the runtime's inclusive visibility.
const table = createFrameLookupTable(
[
{
id: "hero",
src: "clip.webm",
start: 0,
end: 5,
mediaStart: 0,
loop: false,
hasAudio: false,
},
],
[fakeExtracted(30, 30)],
);
expect(table.getActiveFramePayloads(1.5).has("hero")).toBe(false);
expect(table.getActiveFramePayloads(5.0).get("hero")?.frameIndex).toBe(29);
});
it("holds the last frame when the source is a sub-frame shorter than the slot", () => {
// clip [2, 3.45] declares a 1.45s slot, but `ffmpeg -t 1.45` at 30fps emits
// 43 frames = 1.433s — a half-frame short. The tail between source
// exhaustion (~3.433) and the clip end (3.45) must hold the last frame
// rather than render the page background (a one-frame black flash at the
// cut). The held index is the final extracted frame (42).
const table = createFrameLookupTable(
[
{
id: "hero",
src: "clip.mp4",
start: 2,
end: 3.45,
mediaStart: 0,
loop: false,
hasAudio: false,
},
],
[fakeExtracted(43, 30)],
);
// last real frame
expect(table.getActiveFramePayloads(3.4).get("hero")?.frameIndex).toBe(42);
// source exhausted but within tolerance of the end → hold, don't blank
expect(table.getActiveFramePayloads(3.44).get("hero")?.frameIndex).toBe(42);
expect(table.getActiveFramePayloads(3.45).get("hero")?.frameIndex).toBe(42);
});
it("keeps both clips active at a shared adjacent boundary, matching the runtime", () => {
// clip A ends at 3.0, clip B starts at 3.0. The runtime shows both at the
// shared instant; the active set must too.
const table = createFrameLookupTable(
[
{ id: "a", src: "a.webm", start: 0, end: 3, mediaStart: 0, loop: false, hasAudio: false },
{ id: "b", src: "b.webm", start: 3, end: 6, mediaStart: 0, loop: false, hasAudio: false },
],
// createFrameLookupTable maps each clip to extracted frames by id.
[
{ ...fakeExtracted(90, 30), videoId: "a" },
{ ...fakeExtracted(90, 30), videoId: "b" },
],
);
const payloads = table.getActiveFramePayloads(3.0);
expect(payloads.has("a")).toBe(true);
expect(payloads.has("b")).toBe(true);
});
});
describe("analyzeClipMediaFit", () => {
it("returns null for a sub-tolerance shortfall the compiler leaves unclamped", () => {
// 1.433s media in a 1.45s slot — a sub-frame shortfall (<0.05s) the renderer
// freezes seamlessly and the compiler never clamps. Not worth warning about.
expect(analyzeClipMediaFit({ slotSeconds: 1.45, mediaSeconds: 1.433 })).toBeNull();
});
it("returns null when media is longer than or equal to the slot", () => {
expect(analyzeClipMediaFit({ slotSeconds: 2, mediaSeconds: 2 })).toBeNull();
expect(analyzeClipMediaFit({ slotSeconds: 2, mediaSeconds: 5 })).toBeNull();
});
it("reports the shortfall when the slot exceeds media beyond the clamp epsilon", () => {
const fit = analyzeClipMediaFit({ slotSeconds: 5, mediaSeconds: 1 });
expect(fit).not.toBeNull();
expect(fit?.shortfallSeconds).toBeCloseTo(4, 5);
expect(fit?.toleranceSeconds).toBeCloseTo(0.05, 5);
});
it("never flags looping clips (they repeat to fill the slot)", () => {
expect(analyzeClipMediaFit({ slotSeconds: 5, mediaSeconds: 1, loop: true })).toBeNull();
});
it("returns null for unusable inputs (non-finite media, zero slot)", () => {
expect(analyzeClipMediaFit({ slotSeconds: 0, mediaSeconds: 1 })).toBeNull();
expect(analyzeClipMediaFit({ slotSeconds: 5, mediaSeconds: NaN })).toBeNull();
});
});
describe("parseImageElements", () => {
it("parses images with data-start and data-duration", () => {
const images = parseImageElements(
'<img id="photo" src="hdr-photo.png" data-start="0" data-duration="3" />',
);
expect(images).toHaveLength(1);
expect(images[0]).toEqual({
id: "photo",
src: "hdr-photo.png",
start: 0,
end: 3,
});
});
it("generates stable IDs for images without one", () => {
const images = parseImageElements(
'<img src="a.png" data-start="0" data-end="2" /><img src="b.png" data-start="1" data-end="4" />',
);
expect(images).toHaveLength(2);
expect(images[0]!.id).toBe("hf-img-0");
expect(images[1]!.id).toBe("hf-img-1");
});
it("defaults start to 0 and end to Infinity when attributes missing", () => {
const images = parseImageElements('<img src="photo.png" />');
expect(images).toHaveLength(1);
expect(images[0]).toMatchObject({
src: "photo.png",
start: 0,
end: Infinity,
});
});
it("ignores img elements without src", () => {
const images = parseImageElements('<img data-start="0" data-end="3" />');
expect(images).toHaveLength(0);
});
it("uses data-end over data-duration when both present", () => {
const images = parseImageElements(
'<img src="a.png" data-start="1" data-end="5" data-duration="10" />',
);
expect(images[0]!.end).toBe(5);
});
});
type Rgb = [number, number, number];
const UI_FIXTURE_WIDTH = 240;
const UI_FIXTURE_HEIGHT = 160;
const RED_SAMPLE_PIXELS = [
[70, 72],
[118, 82],
[178, 92],
] as const;
function readFirstFramePixel(mediaPath: string, x: number, y: number): Rgb {
const result = spawnSync(
"ffmpeg",
[
"-v",
"error",
"-i",
mediaPath,
"-frames:v",
"1",
"-f",
"rawvideo",
"-pix_fmt",
"rgb24",
"pipe:1",
],
{ maxBuffer: UI_FIXTURE_WIDTH * UI_FIXTURE_HEIGHT * 3 + 1024 },
);
if (result.status !== 0) {
throw new Error(`ffmpeg pixel decode failed: ${result.stderr.toString().slice(-400)}`);
}
const offset = (y * UI_FIXTURE_WIDTH + x) * 3;
return [
result.stdout[offset] ?? 0,
result.stdout[offset + 1] ?? 0,
result.stdout[offset + 2] ?? 0,
];
}
function maxChannelDelta(a: Rgb, b: Rgb): number {
return Math.max(Math.abs(a[0] - b[0]), Math.abs(a[1] - b[1]), Math.abs(a[2] - b[2]));
}
// Regression for saturated UI recordings: default JPEG extraction can shift
// high-chroma reds before browser capture. Forcing PNG should keep extracted
// source-video frames effectively identical to the decoded source pixels.
describe.skipIf(!HAS_FFMPEG)("video frame extraction format", () => {
const FIXTURE_DIR = mkdtempSync(join(tmpdir(), "hf-video-frame-format-"));
const UI_FIXTURE = join(FIXTURE_DIR, "ui-red.mp4");
beforeAll(async () => {
const result = await runFfmpeg([
"-y",
"-hide_banner",
"-loglevel",
"error",
"-f",
"lavfi",
"-i",
`color=c=0xffe7ee:s=${UI_FIXTURE_WIDTH}x${UI_FIXTURE_HEIGHT}:d=1:r=1`,
"-vf",
"drawbox=x=44:y=58:w=152:h=44:color=0xdd382e@1:t=fill,drawbox=x=64:y=75:w=112:h=10:color=0xfff0f0@1:t=fill",
"-c:v",
"libx264",
"-preset",
"ultrafast",
"-crf",
"0",
"-pix_fmt",
"yuv420p",
"-color_primaries",
"bt709",
"-color_trc",
"bt709",
"-colorspace",
"bt709",
UI_FIXTURE,
]);
if (!result.success) {
throw new Error(`UI color fixture synthesis failed: ${result.stderr.slice(-400)}`);
}
}, 30_000);
afterAll(() => {
if (existsSync(FIXTURE_DIR)) rmSync(FIXTURE_DIR, { recursive: true, force: true });
});
function fixtureVideo(): VideoElement {
return {
id: "ui",
src: UI_FIXTURE,
start: 0,
end: 1,
mediaStart: 0,
loop: false,
hasAudio: false,
};
}
it("keeps color-sensitive UI reds closer to source when extraction is forced to png", async () => {
const defaultOut = join(FIXTURE_DIR, "out-default");
const pngOut = join(FIXTURE_DIR, "out-png");
mkdirSync(defaultOut, { recursive: true });
mkdirSync(pngOut, { recursive: true });
const defaultResult = await extractAllVideoFrames([fixtureVideo()], FIXTURE_DIR, {
fps: 1,
outputDir: defaultOut,
});
const pngResult = await extractAllVideoFrames([fixtureVideo()], FIXTURE_DIR, {
fps: 1,
outputDir: pngOut,
format: "png",
});
expect(defaultResult.errors).toEqual([]);
expect(pngResult.errors).toEqual([]);
const defaultFrame = defaultResult.extracted[0]!.framePaths.get(0)!;
const pngFrame = pngResult.extracted[0]!.framePaths.get(0)!;
expect(defaultFrame.endsWith(".jpg")).toBe(true);
expect(pngFrame.endsWith(".png")).toBe(true);
let worstDefaultDelta = 0;
let worstPngDelta = 0;
for (const [x, y] of RED_SAMPLE_PIXELS) {
const sourcePixel = readFirstFramePixel(UI_FIXTURE, x, y);
worstDefaultDelta = Math.max(
worstDefaultDelta,
maxChannelDelta(sourcePixel, readFirstFramePixel(defaultFrame, x, y)),
);
worstPngDelta = Math.max(
worstPngDelta,
maxChannelDelta(sourcePixel, readFirstFramePixel(pngFrame, x, y)),
);
}
expect(worstPngDelta).toBeLessThanOrEqual(5);
expect(worstPngDelta).toBeLessThanOrEqual(worstDefaultDelta);
}, 60_000);
it("keeps jpg and png extraction caches separate", async () => {
const cacheDir = mkdtempSync(join(tmpdir(), "hf-extract-format-cache-"));
try {
const defaultOut = join(FIXTURE_DIR, "cache-default");
const pngOut = join(FIXTURE_DIR, "cache-png");
const pngHitOut = join(FIXTURE_DIR, "cache-png-hit");
mkdirSync(defaultOut, { recursive: true });
mkdirSync(pngOut, { recursive: true });
mkdirSync(pngHitOut, { recursive: true });
const defaultResult = await extractAllVideoFrames(
[fixtureVideo()],
FIXTURE_DIR,
{ fps: 1, outputDir: defaultOut },
undefined,
{ extractCacheDir: cacheDir },
);
expect(defaultResult.errors).toEqual([]);
expect(defaultResult.phaseBreakdown.cacheHits).toBe(0);
expect(defaultResult.phaseBreakdown.cacheMisses).toBe(1);
expect(defaultResult.extracted[0]!.framePaths.get(0)!.endsWith(".jpg")).toBe(true);
const pngMiss = await extractAllVideoFrames(
[fixtureVideo()],
FIXTURE_DIR,
{ fps: 1, outputDir: pngOut, format: "png" },
undefined,
{ extractCacheDir: cacheDir },
);
expect(pngMiss.errors).toEqual([]);
expect(pngMiss.phaseBreakdown.cacheHits).toBe(0);
expect(pngMiss.phaseBreakdown.cacheMisses).toBe(1);
expect(pngMiss.extracted[0]!.framePaths.get(0)!.endsWith(".png")).toBe(true);
const pngHit = await extractAllVideoFrames(
[fixtureVideo()],
FIXTURE_DIR,
{ fps: 1, outputDir: pngHitOut, format: "png" },
undefined,
{ extractCacheDir: cacheDir },
);
expect(pngHit.errors).toEqual([]);
expect(pngHit.phaseBreakdown.cacheHits).toBe(1);
expect(pngHit.phaseBreakdown.cacheMisses).toBe(0);
expect(pngHit.extracted[0]!.framePaths.get(0)!.endsWith(".png")).toBe(true);
} finally {
rmSync(cacheDir, { recursive: true, force: true });
}
}, 60_000);
it("dedupes identical extractions within one render", async () => {
const outputDir = join(FIXTURE_DIR, "out-dedupe");
mkdirSync(outputDir, { recursive: true });
const videoA: VideoElement = { ...fixtureVideo(), id: "dupe-a" };
const videoB: VideoElement = { ...fixtureVideo(), id: "dupe-b" };
const result = await extractAllVideoFrames([videoA, videoB], FIXTURE_DIR, {
fps: 1,
outputDir,
});
expect(result.errors).toEqual([]);
expect(result.extracted).toHaveLength(2);
const first = result.extracted[0]!;
const second = result.extracted[1]!;
expect(first.videoId).toBe("dupe-a");
expect(second.videoId).toBe("dupe-b");
expect(second.outputDir).toBe(first.outputDir);
expect(Array.from(second.framePaths.entries())).toEqual(Array.from(first.framePaths.entries()));
const frameDirs = readdirSync(outputDir, { withFileTypes: true })
.filter((entry) => entry.isDirectory())
.map((entry) => entry.name);
expect(frameDirs).toEqual(["dupe-a"]);
expect(readdirSync(first.outputDir).filter((f) => f.endsWith(".jpg"))).toHaveLength(
first.totalFrames,
);
}, 60_000);
});
// Regression test for the VFR (variable frame rate) freeze bug.
// Screen recordings and phone videos often have irregular timestamps.
// When such inputs hit `extractVideoFramesRange`'s `-ss <start> -i ... -t <dur>
// -vf fps=N` pipeline, the fps filter can emit fewer frames than requested —
// e.g. a 4-second segment at 30fps would produce ~90 frames instead of 120.
// FrameLookupTable.getFrameAtTime then returns null for out-of-range indices
// and the compositor holds the last valid frame, which the user perceives as
// the video freezing. extractAllVideoFrames now routes VFR sources through
// FFmpeg's one-pass `-fps_mode cfr -r` extraction path to fix this without a
// separate normalization encode.
describe.skipIf(!HAS_FFMPEG)("extractAllVideoFrames on a VFR source", () => {
const FIXTURE_DIR = mkdtempSync(join(tmpdir(), "hf-vfr-test-"));
const VFR_FIXTURE = join(FIXTURE_DIR, "vfr_screen.mp4");
beforeAll(async () => {
// 10s testsrc2 at 60fps, ~40% of frames dropped via select filter and
// encoded with -vsync vfr so timestamps are irregular. Declared fps 60,
// actual average ~36 — well over the 10% threshold used by isVFR.
// The select expression drops four 1-second windows (frames 30-89,
// 180-239, 330-389, 480-539) to simulate static segments in a screen
// recording where no pixels changed.
// -g/-keyint_min 600 forces a single keyframe so mid-segment seeks in the
// mediaStart=3 test don't snap to an intermediate IDR and drift the count.
const result = await runFfmpeg([
"-y",
"-hide_banner",
"-loglevel",
"error",
"-f",
"lavfi",
"-i",
"testsrc2=s=320x180:d=10:rate=60",
"-vf",
"select='not(between(n\\,30\\,89))*not(between(n\\,180\\,239))*not(between(n\\,330\\,389))*not(between(n\\,480\\,539))'",
"-vsync",
"vfr",
"-c:v",
"libx264",
"-preset",
"ultrafast",
"-pix_fmt",
"yuv420p",
"-g",
"600",
"-keyint_min",
"600",
VFR_FIXTURE,
]);
if (!result.success) {
throw new Error(
`ffmpeg fixture synthesis failed (${result.exitCode}): ${result.stderr.slice(-400)}`,
);
}
}, 30_000);
afterAll(() => {
if (existsSync(FIXTURE_DIR)) rmSync(FIXTURE_DIR, { recursive: true, force: true });
});
it("detects the synthesized fixture as VFR", async () => {
const md = await extractVideoMetadata(VFR_FIXTURE);
expect(md.isVFR).toBe(true);
});
it("produces the expected frame count for a mid-file segment", async () => {
const outputDir = join(FIXTURE_DIR, "out-mid-segment");
mkdirSync(outputDir, { recursive: true });
const video: VideoElement = {
id: "v1",
src: VFR_FIXTURE,
start: 0,
end: 4,
mediaStart: 3,
loop: false,
hasAudio: false,
};
const result = await extractAllVideoFrames([video], FIXTURE_DIR, {
fps: 30,
outputDir,
});
expect(result.errors).toEqual([]);
expect(result.extracted).toHaveLength(1);
const frames = readdirSync(join(outputDir, "v1")).filter((f) => f.endsWith(".jpg"));
// Pre-fix behavior produced ~90 frames (a 25% shortfall).
// ±3 tolerance: FFmpeg's one-pass VFR→CFR extraction yields slightly
// different frame counts across versions (timestamp rounding).
expect(frames.length).toBeGreaterThanOrEqual(117);
expect(frames.length).toBeLessThanOrEqual(123);
expect(result.phaseBreakdown).toBeDefined();
expect(result.phaseBreakdown.extractMs).toBeGreaterThan(0);
expect(result.phaseBreakdown.vfrPreflightCount).toBe(1);
expect(result.phaseBreakdown.vfrPreflightMs).toBeGreaterThanOrEqual(0);
}, 60_000);
// Shared fixture helpers for the cache tests below. All synthesize clean
// CFR SDR clips — keeps VFR preflight count at zero so cache keys are
// stable across runs within a test.
async function synthCfrClip(name: string, durationSeconds: number): Promise<string> {
const src = join(FIXTURE_DIR, name);
const synth = await runFfmpeg([
"-y",
"-hide_banner",
"-loglevel",
"error",
"-f",
"lavfi",
"-i",
`testsrc2=s=320x180:d=${durationSeconds}:rate=30`,
"-c:v",
"libx264",
"-preset",
"ultrafast",
"-pix_fmt",
"yuv420p",
src,
]);
if (!synth.success) {
throw new Error(`Fixture synthesis failed (${name}): ${synth.stderr.slice(-400)}`);
}
return src;
}
function cfrClipElement(id: string, src: string, endSeconds: number): VideoElement {
return { id, src, start: 0, end: endSeconds, mediaStart: 0, loop: false, hasAudio: false };
}
async function extractWithCache(
video: VideoElement,
outName: string,
cacheDir: string,
fps = 30,
): Promise<ExtractionResult> {
const outputDir = join(FIXTURE_DIR, outName);
mkdirSync(outputDir, { recursive: true });
return extractAllVideoFrames([video], FIXTURE_DIR, { fps, outputDir }, undefined, {
extractCacheDir: cacheDir,
});
}
async function synthHdrTaggedClip(name: string, durationSeconds: number): Promise<string> {
const src = join(FIXTURE_DIR, name);
const synth = await runFfmpeg([
"-y",
"-hide_banner",
"-loglevel",
"error",
"-f",
"lavfi",
"-i",
`testsrc2=s=320x180:d=${durationSeconds}:rate=30`,
"-c:v",
"libx264",
"-preset",
"ultrafast",
"-pix_fmt",
"yuv420p",
"-color_primaries",
"bt2020",
"-color_trc",
"smpte2084",
"-colorspace",
"bt2020nc",
src,
]);
if (!synth.success) {
throw new Error(`HDR fixture synthesis failed (${name}): ${synth.stderr.slice(-400)}`);
}
return src;
}
function cacheEntryNames(cacheDir: string): string[] {
return readdirSync(cacheDir).filter((name) => name.startsWith(SCHEMA_PREFIX));
}
function extractedFor(result: ExtractionResult, videoId: string): ExtractedFrames {
const extracted = result.extracted.find((item) => item.videoId === videoId);
if (!extracted) throw new Error(`missing extraction result for ${videoId}`);
return extracted;
}
function framePath(result: ExtractionResult, videoId: string, frameIndex: number): string {
const extracted = extractedFor(result, videoId);
const frame = extracted?.framePaths.get(frameIndex);
if (!frame) throw new Error(`missing frame ${frameIndex} for ${videoId}`);
return frame;
}
it("reuses extracted frames on a warm cache hit", async () => {
const CACHE_DIR = mkdtempSync(join(tmpdir(), "hf-extract-cache-test-"));
const SRC = await synthCfrClip("cache-src.mp4", 2);
const video = cfrClipElement("cv1", SRC, 2);
const miss = await extractWithCache(video, "out-cache-miss", CACHE_DIR);
expect(miss.errors).toEqual([]);
expect(miss.phaseBreakdown.cacheHits).toBe(0);
expect(miss.phaseBreakdown.cacheMisses).toBe(1);
const hit = await extractWithCache(video, "out-cache-hit", CACHE_DIR);
expect(hit.errors).toEqual([]);
expect(hit.phaseBreakdown.cacheHits).toBe(1);
expect(hit.phaseBreakdown.cacheMisses).toBe(0);
// extractMs on a hit is only the cache-lookup bookkeeping; asserting <50ms
// is loose enough to survive CI jitter but tight enough to catch a
// regression that accidentally triggered ffmpeg again.
expect(hit.phaseBreakdown.extractMs).toBeLessThan(50);
expect(hit.extracted).toHaveLength(1);
expect(hit.extracted[0]!.totalFrames).toBe(miss.extracted[0]!.totalFrames);
rmSync(CACHE_DIR, { recursive: true, force: true });
}, 60_000);
it("updates the cache sentinel mtime on a hit", async () => {
const CACHE_DIR = mkdtempSync(join(tmpdir(), "hf-extract-cache-touch-test-"));
const SRC = await synthCfrClip("cache-touch-src.mp4", 1);
const video = cfrClipElement("touch", SRC, 1);
const miss = await extractWithCache(video, "out-cache-touch-miss", CACHE_DIR);
expect(miss.errors).toEqual([]);
expect(miss.phaseBreakdown.cacheMisses).toBe(1);
const cacheEntryNames = readdirSync(CACHE_DIR).filter((name) => name.startsWith(SCHEMA_PREFIX));
expect(cacheEntryNames).toHaveLength(1);
const sentinel = join(CACHE_DIR, cacheEntryNames[0]!, COMPLETE_SENTINEL);
const old = new Date(Date.now() - 120_000);
utimesSync(sentinel, old, old);
const before = statSync(sentinel).mtimeMs;
const hit = await extractWithCache(video, "out-cache-touch-hit", CACHE_DIR);
expect(hit.errors).toEqual([]);
expect(hit.phaseBreakdown.cacheHits).toBe(1);
expect(statSync(sentinel).mtimeMs).toBeGreaterThan(before);
rmSync(CACHE_DIR, { recursive: true, force: true });
}, 60_000);
it("disables caching for this render when the cache dir is not writable", async () => {
const CACHE_FILE = join(FIXTURE_DIR, "cache-dir-is-a-file");
writeFileSync(CACHE_FILE, "not a directory", "utf-8");
const SRC = await synthCfrClip("cache-disabled-src.mp4", 1);
const stderr = vi.spyOn(process.stderr, "write").mockImplementation(() => true);
try {
const result = await extractWithCache(
cfrClipElement("uncached", SRC, 1),
"out-cache-disabled",
CACHE_FILE,
);
expect(result.errors).toEqual([]);
expect(result.extracted).toHaveLength(1);
expect(result.phaseBreakdown.cacheHits).toBe(0);
expect(result.phaseBreakdown.cacheMisses).toBe(0);
expect(stderr).toHaveBeenCalledTimes(1);
expect(String(stderr.mock.calls[0]?.[0])).toContain("extraction cache dir");
expect(String(stderr.mock.calls[0]?.[0])).toContain("caching disabled for this render");
} finally {
stderr.mockRestore();
}
}, 60_000);
it("invalidates the cache when fps changes", async () => {
const CACHE_DIR = mkdtempSync(join(tmpdir(), "hf-extract-cache-test-"));
const SRC = await synthCfrClip("cache-fps-src.mp4", 1);
const video = cfrClipElement("cv2", SRC, 1);
const first = await extractWithCache(video, "out-cache-fps-30", CACHE_DIR);
expect(first.phaseBreakdown.cacheMisses).toBe(1);
const second = await extractWithCache(video, "out-cache-fps-60", CACHE_DIR, 60);
expect(second.phaseBreakdown.cacheMisses).toBe(1);
expect(second.phaseBreakdown.cacheHits).toBe(0);
rmSync(CACHE_DIR, { recursive: true, force: true });
}, 60_000);
it("applies SDR→HDR conversion during extraction without normalized intermediates", async () => {
const SDR_LONG = await synthCfrClip("sdr-long.mp4", 10);
const HDR_SHORT = await synthHdrTaggedClip("hdr-short.mp4", 2);
const outputDir = join(FIXTURE_DIR, "out-hdr-segment");
const plainOutputDir = join(FIXTURE_DIR, "out-hdr-plain-sdr");
mkdirSync(outputDir, { recursive: true });
mkdirSync(plainOutputDir, { recursive: true });
const videos: VideoElement[] = [
{ id: "sdr", src: SDR_LONG, start: 0, end: 2, mediaStart: 0, loop: false, hasAudio: false },
{
id: "hdr",
src: HDR_SHORT,
start: 2,
end: 4,
mediaStart: 0,
loop: false,
hasAudio: false,
},
];
const result = await extractAllVideoFrames(videos, FIXTURE_DIR, {
fps: 30,
outputDir,
});
expect(result.errors).toEqual([]);
expect(result.phaseBreakdown.hdrPreflightCount).toBe(1);
expect(existsSync(join(outputDir, "_hdr_normalized"))).toBe(false);
const sdrFrames = result.extracted.find((item) => item.videoId === "sdr");
expect(sdrFrames?.totalFrames).toBe(60);
const plain = await extractVideoFramesRange(SDR_LONG, "plain-sdr", 0, 2, {
fps: 30,
outputDir: plainOutputDir,
format: "jpg",
});
expect(plain.totalFrames).toBe(60);
expect(
readFileSync(framePath(result, "sdr", 0)).equals(readFileSync(plain.framePaths.get(0)!)),
).toBe(false);
}, 60_000);
it("keeps SDR→HDR cache entries distinct from plain SDR entries", async () => {
const CACHE_DIR = mkdtempSync(join(tmpdir(), "hf-extract-hdr-cache-test-"));
const SDR = await synthCfrClip("cache-hdr-sdr.mp4", 1);
const HDR = await synthHdrTaggedClip("cache-hdr-hdr.mp4", 1);
try {
const mixedOutputDir = join(FIXTURE_DIR, "out-cache-hdr-mixed");
mkdirSync(mixedOutputDir, { recursive: true });
const mixed = await extractAllVideoFrames(
[
cfrClipElement("sdr-transform", SDR, 1),
{ ...cfrClipElement("hdr-peer", HDR, 1), start: 1, end: 2 },
],
FIXTURE_DIR,
{ fps: 30, outputDir: mixedOutputDir },
undefined,
{ extractCacheDir: CACHE_DIR },
);
expect(mixed.errors).toEqual([]);
expect(mixed.phaseBreakdown.hdrPreflightCount).toBe(1);
expect(mixed.phaseBreakdown.cacheHits).toBe(0);
expect(mixed.phaseBreakdown.cacheMisses).toBe(2);
const plain = await extractWithCache(
cfrClipElement("sdr-plain", SDR, 1),
"out-cache-hdr-plain",
CACHE_DIR,
);
expect(plain.errors).toEqual([]);
expect(plain.phaseBreakdown.cacheHits).toBe(0);
expect(plain.phaseBreakdown.cacheMisses).toBe(1);
expect(cacheEntryNames(CACHE_DIR)).toHaveLength(3);
// Cross-render poisoning regression: the plain-SDR render must not be
// served the BT.2020-converted frames the mixed render cached for the
// SAME source+trim. Compare actual frame bytes across the cache
// boundary, not just entry counts.
expect(
readFileSync(framePath(plain, "sdr-plain", 0)).equals(
readFileSync(framePath(mixed, "sdr-transform", 0)),
),
).toBe(false);
// And a repeat plain render must HIT the plain entry and serve
// byte-identical plain frames (proves the hit path keys correctly too).
const plainAgain = await extractWithCache(
cfrClipElement("sdr-plain-again", SDR, 1),
"out-cache-hdr-plain-again",
CACHE_DIR,
);
expect(plainAgain.phaseBreakdown.cacheHits).toBe(1);
expect(
readFileSync(framePath(plainAgain, "sdr-plain-again", 0)).equals(
readFileSync(framePath(plain, "sdr-plain", 0)),
),
).toBe(true);
} finally {
rmSync(CACHE_DIR, { recursive: true, force: true });
}
}, 60_000);
// Asserts frame-count correctness for a full VFR file. One-pass CFR image
// extraction may repeat held source frames across timestamp gaps; the freeze
// regression is missing frames, which leaves late timeline lookups null.
it("produces the full frame count on the full VFR file", async () => {
const outputDir = join(FIXTURE_DIR, "out-full");
mkdirSync(outputDir, { recursive: true });
const video: VideoElement = {
id: "vfull",
src: VFR_FIXTURE,
start: 0,
end: 10,
mediaStart: 0,
loop: false,
hasAudio: false,
};
const result = await extractAllVideoFrames([video], FIXTURE_DIR, {
fps: 30,
outputDir,
});
expect(result.errors).toEqual([]);
const frameDir = join(outputDir, "vfull");
const frames = readdirSync(frameDir)
.filter((f) => f.endsWith(".jpg"))
.sort();
// ±3 tolerance: same FFmpeg one-pass VFR→CFR rounding variance as the
// mid-segment test.
expect(frames.length).toBeGreaterThanOrEqual(297);
expect(frames.length).toBeLessThanOrEqual(303);
}, 60_000);
});
describe("getFrameAtTime — IEEE 754 boundary precision", () => {
function makeExtracted(fps: number, totalFrames: number): ExtractedFrames {
const framePaths = new Map<number, string>();
for (let i = 0; i < totalFrames; i++) framePaths.set(i, `frame-${i}.jpg`);
return {
fps,
totalFrames,
framePaths,
metadata: {
durationSeconds: totalFrames / fps,
width: 1920,
height: 1080,
codec: "h264",
hasAudio: false,
fps,
},
} as ExtractedFrames;
}
it("does not produce duplicate frames when data-start is grid-aligned", () => {
const extracted = makeExtracted(25, 351);
const videoStart = 0;
const seen: string[] = [];
let duplicates = 0;
for (let i = 0; i < 351; i++) {
const globalTime = i / 25;
const frame = getFrameAtTime(extracted, globalTime, videoStart);
if (frame && seen.length > 0 && frame === seen[seen.length - 1]) duplicates++;
if (frame) seen.push(frame);
}
expect(duplicates).toBe(0);
});
it("returns monotonically increasing frame indices", () => {
const extracted = makeExtracted(25, 100);
let lastIndex = -1;
for (let i = 0; i < 100; i++) {
const globalTime = i / 25;
const frame = getFrameAtTime(extracted, globalTime, 0);
const idx = frame ? parseInt(frame.split("-")[1]!) : -1;
expect(idx).toBeGreaterThan(lastIndex);
lastIndex = idx;
}
});
it("handles the 0.28 * 25 boundary case (6.999999 vs 7)", () => {
const extracted = makeExtracted(25, 10);
const frame = getFrameAtTime(extracted, 0.28, 0);
expect(frame).toBe("frame-7.jpg");
});
it("mediaStart does not offset frame index (extractor handles trim via -ss)", () => {
const extracted = makeExtracted(25, 100);
const frame = getFrameAtTime(extracted, 0, 0, false, 1.0);
expect(frame).toBe("frame-0.jpg");
});
});