ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-08 02:36:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(engine): harden ffprobe parsing and command arguments (#2740)

Browse Source 
- parseFrameRate now rejects malformed ratios (e.g. "30/", "30/0") instead of NaN.

- Add "--" before file paths so names starting with "-" are not parsed as options.

- cICP PNG chunk no longer returns before IHDR supplies width and height.

- Add regression tests for option injection, frame rates, and cICP ordering.
This commit is contained in:
Santhi Prakash
2026-07-30 12:54:50 -07:00
committed by GitHub
parent a52dd9c308
commit f75ca076b7
2 changed files with 165 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/engine/src/utils/ffprobe.test.ts
+140
View File
@@ -502,3 +502,143 @@ describe("ffprobe missing-binary fallback", () => {
await expect(extractAudioMetadata("/tmp/example.mp3")).rejects.toThrow(/install FFmpeg/i);
});
});
describe("ffprobe option separator", () => {
afterEach(() => {
vi.resetModules();
vi.doUnmock("child_process");
});
it("places -- before the file path so paths starting with - are not parsed as options", async () => {
const { spawn, calls } = createSpawnSpy([
{
kind: "exit",
code: 0,
stdout: JSON.stringify({
streams: [
{
codec_type: "video",
codec_name: "h264",
width: 320,
height: 180,
r_frame_rate: "30/1",
avg_frame_rate: "30/1",
},
],
format: { duration: "1.5" },
}),
},
]);
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { extractMediaMetadata } = await import("./ffprobe.js");
const filePath = "/tmp/-dangerous-name.mp4";
await extractMediaMetadata(filePath);
const args = calls[0]?.args ?? [];
const filePathIndex = args.indexOf(filePath);
expect(filePathIndex).toBeGreaterThan(0);
expect(args[filePathIndex - 1]).toBe("--");
});
it("uses -- for audio and keyframe probes too", async () => {
const { spawn, calls } = createSpawnSpy([
{
kind: "exit",
code: 0,
stdout: JSON.stringify({
streams: [{ codec_type: "audio", codec_name: "aac", sample_rate: "48000", channels: 2 }],
format: { duration: "1.25" },
}),
},
{
kind: "exit",
code: 0,
stdout: JSON.stringify({
streams: [{ nb_read_packets: "783" }],
format: {},
}),
},
{ kind: "exit", code: 0, stdout: "0.000\n1.000\n" },
]);
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { extractAudioMetadata, analyzeKeyframeIntervals } = await import("./ffprobe.js");
await extractAudioMetadata("/tmp/-audio.wav");
await analyzeKeyframeIntervals("/tmp/-video.mp4");
const args = calls.flatMap((call) => [...(call.args ?? [])]);
expect(args.filter((arg) => arg === "--")).toHaveLength(3);
});
});
describe("ffprobe frame rate parsing", () => {
afterEach(() => {
vi.resetModules();
vi.doUnmock("child_process");
});
it.each([
{ r: "30/1", avg: "30/1", expected: 30 },
{ r: "30000/1001", avg: "30000/1001", expected: 29.97 },
{ r: "30/", avg: undefined, expected: 0 },
{ r: "30/0", avg: undefined, expected: 0 },
{ r: "0/0", avg: undefined, expected: 0 },
{ r: "abc/def", avg: undefined, expected: 0 },
{ r: "60", avg: undefined, expected: 60 },
])("parses r=$r avg=$avg as fps=$expected", async ({ r, avg, expected }) => {
const { spawn } = createSpawnSpy([
{
kind: "exit",
code: 0,
stdout: JSON.stringify({
streams: [
{
codec_type: "video",
codec_name: "h264",
width: 320,
height: 180,
r_frame_rate: r,
avg_frame_rate: avg,
},
],
format: { duration: "1.5" },
}),
},
]);
vi.resetModules();
vi.doMock("child_process", () => ({ spawn }));
const { extractMediaMetadata } = await import("./ffprobe.js");
const meta = await extractMediaMetadata("/tmp/frame-rate.mp4");
expect(meta.fps).toBe(expected);
});
});
describe("extractPngMetadataFromBuffer cICP ordering", () => {
it("does not emit color space until IHDR provides width and height", () => {
const ihdr = pngChunk("IHDR", [0, 0, 0, 1, 0, 0, 0, 1, 16, 2, 0, 0, 0]);
const cicp = pngChunk("cICP", [9, 16, 0, 1]);
const iend = pngChunk("IEND", []);
// cICP before IHDR is invalid PNG ordering; make sure we don't return
// zero-sized metadata in that case.
const malformed = buildPngWithChunks([cicp, ihdr, iend]);
expect(extractPngMetadataFromBuffer(malformed)).toEqual({
width: 1,
height: 1,
colorSpace: {
colorPrimaries: "bt2020",
colorTransfer: "smpte2084",
colorSpace: "gbr",
},
});
// Without any IHDR, a cICP alone should not produce a result.
const onlyCicp = buildPngWithChunks([cicp, iend]);
expect(extractPngMetadataFromBuffer(onlyCicp)).toBeNull();
});
});
packages/engine/src/utils/ffprobe.ts
+25 -24
View File
@@ -48,7 +48,7 @@ async function runFfprobe(
signal?: AbortSignal,
): Promise<string> {
const command = getFfprobeBinary();
const proc = spawn(command, ["-v", "error", ...argsWithoutInput, filePath]);
const proc = spawn(command, ["-v", "error", ...argsWithoutInput, "--", filePath]);
trackChildProcess(proc);
let stdout = "";
proc.stdout.on("data", (data) => {
@@ -197,6 +197,7 @@ export function extractPngMetadataFromBuffer(buf: Buffer): StillImageMetadata |
let width = 0;
let height = 0;
let seenIdat = false;
let colorSpaceFromCicp: VideoColorSpace | null = null;
let pos = 8;
while (pos + 12 <= buf.length) {
const chunkLen = buf.readUInt32BE(pos);
@@ -221,27 +222,23 @@ export function extractPngMetadataFromBuffer(buf: Buffer): StillImageMetadata |
const transferCode = chunkData[1] ?? 0;
const matrixCode = chunkData[2] ?? 0;
return {
width,
height,
colorSpace: {
colorPrimaries:
primariesCode === 9
? "bt2020"
: primariesCode === 1
colorSpaceFromCicp = {
colorPrimaries:
primariesCode === 9
? "bt2020"
: primariesCode === 1
? "bt709"
: `unknown-${primariesCode}`,
colorTransfer:
transferCode === 16
? "smpte2084"
: transferCode === 18
? "arib-std-b67"
: transferCode === 1
? "bt709"
: `unknown-${primariesCode}`,
colorTransfer:
transferCode === 16
? "smpte2084"
: transferCode === 18
? "arib-std-b67"
: transferCode === 1
? "bt709"
: `unknown-${transferCode}`,
colorSpace:
matrixCode === 9 ? "bt2020nc" : matrixCode === 0 ? "gbr" : `unknown-${matrixCode}`,
},
: `unknown-${transferCode}`,
colorSpace:
matrixCode === 9 ? "bt2020nc" : matrixCode === 0 ? "gbr" : `unknown-${matrixCode}`,
};
}
@@ -249,7 +246,7 @@ export function extractPngMetadataFromBuffer(buf: Buffer): StillImageMetadata |
pos += 12 + chunkLen;
}
return width > 0 && height > 0 ? { width, height, colorSpace: null } : null;
return width > 0 && height > 0 ? { width, height, colorSpace: colorSpaceFromCicp } : null;
}
function extractStillImageMetadata(filePath: string): StillImageMetadata | null {
@@ -283,9 +280,13 @@ function parseFrameRate(frameRateStr: string | undefined): number {
if (parts.length === 2) {
const num = parseFloat(parts[0] ?? "");
const den = parseFloat(parts[1] ?? "");
if (den !== 0) return Math.round((num / den) * 100) / 100;
if (Number.isFinite(num) && Number.isFinite(den) && den !== 0) {
return Math.round((num / den) * 100) / 100;
}
return 0;
}
return parseFloat(frameRateStr) || 0;
const parsed = parseFloat(frameRateStr);
return Number.isFinite(parsed) ? parsed : 0;
}
/**