Skip to content

Commit 7e51fc6

Browse files
committed
fix(engine): crop pack members at the master's probed size
With --resolution the encoded master is supersampled past the authored data-width/data-height, but the crop rect was planned in composition pixels, so a 1920x1080 composition rendered at 4k cropped a quarter-size patch from the upper left of the window. Plan the members against the master's probed size (planCropPackMembersForMaster), falling back to the composition size when the probe has no dimensions. Siblings also re-encoded with encoder defaults, ignoring the render's quality and leaving VP9 at its low default bitrate. Pass the master's preset, CRF and bitrate through to each member: x264 preset with CRF or bitrate for mp4, VP9 constant quality for webm, the ProRes profile for mov.
1 parent 22da764 commit 7e51fc6

6 files changed

Lines changed: 177 additions & 15 deletions

File tree

‎packages/engine/src/index.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,8 +419,9 @@ export {
419419
export {
420420
buildCropPackArgs,
421421
encodeCropPackMember,
422-
planCropPackMembers,
422+
planCropPackMembersForMaster,
423423
cropPackOutputPath,
424+
type CropPackEncodeSettings,
424425
type CropPackMemberPlan,
425426
type CropPackMemberResult,
426427
type BuildCropPackArgsInput,

‎packages/engine/src/utils/cropPack.test.ts‎

Lines changed: 92 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ vi.mock("./hdr.js", () => ({
2222
cs?.colorTransfer === "smpte2084" || cs?.colorTransfer === "arib-std-b67",
2323
}));
2424

25-
import { buildCropPackArgs, encodeCropPackMember, planCropPackMembers } from "./cropPack.js";
25+
import {
26+
buildCropPackArgs,
27+
encodeCropPackMember,
28+
planCropPackMembers,
29+
planCropPackMembersForMaster,
30+
} from "./cropPack.js";
2631

2732
describe("buildCropPackArgs", () => {
2833
const crop = { x: 656, y: 0, width: 608, height: 1080 };
@@ -57,6 +62,51 @@ describe("buildCropPackArgs", () => {
5762
expect(args).toContain("-an");
5863
expect(args).not.toContain("-c:a");
5964
});
65+
66+
it("encodes an mp4 sibling with the master's preset and CRF", () => {
67+
const args = buildCropPackArgs({
68+
masterPath: "renders/launch.mp4",
69+
outputPath: "renders/launch.vertical.mp4",
70+
crop,
71+
outputWidth: 608,
72+
outputHeight: 1080,
73+
copyAudio: true,
74+
encode: { preset: "slow", quality: 18 },
75+
});
76+
expect(args[args.indexOf("-preset") + 1]).toBe("slow");
77+
expect(args[args.indexOf("-crf") + 1]).toBe("18");
78+
expect(args).not.toContain("-b:v");
79+
});
80+
81+
it("uses the master's bitrate instead of CRF when one is set", () => {
82+
const args = buildCropPackArgs({
83+
masterPath: "renders/launch.mp4",
84+
outputPath: "renders/launch.vertical.mp4",
85+
crop,
86+
outputWidth: 608,
87+
outputHeight: 1080,
88+
copyAudio: true,
89+
encode: { preset: "medium", quality: 23, bitrate: "10M" },
90+
});
91+
expect(args[args.indexOf("-b:v") + 1]).toBe("10M");
92+
expect(args).not.toContain("-crf");
93+
});
94+
95+
it("encodes a webm sibling in VP9 constant-quality mode", () => {
96+
const args = buildCropPackArgs({
97+
masterPath: "renders/launch.webm",
98+
outputPath: "renders/launch.vertical.webm",
99+
crop,
100+
outputWidth: 608,
101+
outputHeight: 1080,
102+
copyAudio: true,
103+
encode: { preset: "good", quality: 18 },
104+
});
105+
expect(args[args.indexOf("-c:v") + 1]).toBe("libvpx-vp9");
106+
expect(args[args.indexOf("-b:v") + 1]).toBe("0");
107+
expect(args[args.indexOf("-crf") + 1]).toBe("18");
108+
expect(args[args.indexOf("-deadline") + 1]).toBe("good");
109+
});
60110
});
61111

62112
describe("planCropPackMembers", () => {
@@ -86,6 +136,47 @@ describe("planCropPackMembers", () => {
86136
});
87137
});
88138

139+
describe("planCropPackMembersForMaster", () => {
140+
afterEach(() => {
141+
vi.clearAllMocks();
142+
});
143+
144+
const vertical = {
145+
id: "vertical",
146+
ratio: "9:16" as const,
147+
x: (1920 - 608) / 2 / 1920,
148+
y: 0,
149+
width: 608 / 1920,
150+
height: 1,
151+
};
152+
153+
it("crops the supersampled master at its probed size", async () => {
154+
extractVideoMetadataMock.mockResolvedValue({ width: 3840, height: 2160 });
155+
const members = await planCropPackMembersForMaster(
156+
[vertical],
157+
1920,
158+
1080,
159+
"renders/launch.mp4",
160+
);
161+
expect(extractVideoMetadataMock).toHaveBeenCalledWith("renders/launch.mp4");
162+
expect(members[0]?.crop).toEqual(planCropPackMembers([vertical], 3840, 2160, "x.mp4")[0]?.crop);
163+
expect(members[0]?.crop.x).toBe(1312);
164+
expect(members[0]?.crop.height).toBe(2160);
165+
expect(members[0]?.outputHeight).toBe(2160);
166+
});
167+
168+
it("falls back to the composition size when the probe has no dimensions", async () => {
169+
extractVideoMetadataMock.mockResolvedValue({ width: 0, height: 0 });
170+
const members = await planCropPackMembersForMaster(
171+
[vertical],
172+
1920,
173+
1080,
174+
"renders/launch.mp4",
175+
);
176+
expect(members[0]?.crop).toEqual({ x: 656, y: 0, width: 608, height: 1080 });
177+
});
178+
});
179+
89180
describe("encodeCropPackMember", () => {
90181
let dir: string;
91182

‎packages/engine/src/utils/cropPack.ts‎

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,24 @@ export interface CropPackMemberResult {
2727
height: number;
2828
}
2929

30+
/** The master's encoder settings, so siblings match its quality. */
31+
export interface CropPackEncodeSettings {
32+
/** x264 preset for mp4, VP9 deadline for webm, ProRes profile for mov. */
33+
preset: string;
34+
/** CRF for mp4 and webm. */
35+
quality: number;
36+
/** Target bitrate; replaces CRF for mp4 and caps VP9 when set. */
37+
bitrate?: string;
38+
}
39+
3040
export interface BuildCropPackArgsInput {
3141
masterPath: string;
3242
outputPath: string;
3343
crop: PixelRect;
3444
outputWidth: number;
3545
outputHeight: number;
3646
copyAudio: boolean;
47+
encode?: CropPackEncodeSettings;
3748
}
3849

3950
export function planCropPackMembers(
@@ -55,11 +66,47 @@ export function planCropPackMembers(
5566
});
5667
}
5768

58-
function videoEncodeArgs(outputPath: string): string[] {
69+
/**
70+
* Plans against the encoded master's probed size. With `--resolution` the
71+
* master is supersampled past the composition size, so composition pixels
72+
* would crop the wrong region.
73+
*/
74+
export async function planCropPackMembersForMaster(
75+
frames: SafeFrame[],
76+
compositionWidth: number,
77+
compositionHeight: number,
78+
masterPath: string,
79+
): Promise<CropPackMemberPlan[]> {
80+
const metadata = await extractVideoMetadata(masterPath);
81+
const sized = metadata.width > 0 && metadata.height > 0;
82+
return planCropPackMembers(
83+
frames,
84+
sized ? metadata.width : compositionWidth,
85+
sized ? metadata.height : compositionHeight,
86+
masterPath,
87+
);
88+
}
89+
90+
function videoEncodeArgs(outputPath: string, encode?: CropPackEncodeSettings): string[] {
5991
const ext = extname(outputPath).toLowerCase();
60-
if (ext === ".webm") return ["-c:v", "libvpx-vp9", "-pix_fmt", "yuv420p"];
61-
if (ext === ".mov") return ["-c:v", "prores_ks", "-pix_fmt", "yuva444p10le"];
62-
return ["-c:v", "libx264", "-pix_fmt", "yuv420p"];
92+
if (ext === ".webm") {
93+
const rate = encode
94+
? ["-b:v", encode.bitrate || "0", "-crf", String(encode.quality), "-deadline", encode.preset]
95+
: [];
96+
return ["-c:v", "libvpx-vp9", ...rate, "-pix_fmt", "yuv420p"];
97+
}
98+
if (ext === ".mov") {
99+
const profile = encode ? ["-profile:v", encode.preset] : [];
100+
return ["-c:v", "prores_ks", ...profile, "-pix_fmt", "yuva444p10le"];
101+
}
102+
const rate = encode
103+
? [
104+
"-preset",
105+
encode.preset,
106+
...(encode.bitrate ? ["-b:v", encode.bitrate] : ["-crf", String(encode.quality)]),
107+
]
108+
: [];
109+
return ["-c:v", "libx264", ...rate, "-pix_fmt", "yuv420p"];
63110
}
64111

65112
/**
@@ -70,7 +117,13 @@ function videoEncodeArgs(outputPath: string): string[] {
70117
*/
71118
export function buildCropPackArgs(input: BuildCropPackArgsInput): string[] {
72119
const filter = `crop=${input.crop.width}:${input.crop.height}:${input.crop.x}:${input.crop.y},scale=${input.outputWidth}:${input.outputHeight}`;
73-
const args = ["-i", input.masterPath, "-filter:v", filter, ...videoEncodeArgs(input.outputPath)];
120+
const args = [
121+
"-i",
122+
input.masterPath,
123+
"-filter:v",
124+
filter,
125+
...videoEncodeArgs(input.outputPath, input.encode),
126+
];
74127
args.push("-map", "0:v:0");
75128
if (input.copyAudio) {
76129
args.push("-map", "0:a?", "-c:a", "copy");
@@ -86,7 +139,7 @@ export function buildCropPackArgs(input: BuildCropPackArgsInput): string[] {
86139
export async function encodeCropPackMember(
87140
member: CropPackMemberPlan,
88141
masterPath: string,
89-
options: { copyAudio?: boolean; signal?: AbortSignal } = {},
142+
options: { copyAudio?: boolean; signal?: AbortSignal; encode?: CropPackEncodeSettings } = {},
90143
): Promise<CropPackMemberResult> {
91144
if (!existsSync(masterPath)) {
92145
throw new Error(`Crop pack master "${masterPath}" does not exist.`);
@@ -105,6 +158,7 @@ export async function encodeCropPackMember(
105158
outputWidth: member.outputWidth,
106159
outputHeight: member.outputHeight,
107160
copyAudio,
161+
encode: options.encode,
108162
});
109163
const result = await runFfmpeg(args, { signal: options.signal });
110164
if (!result.success) {

‎packages/producer/src/services/render/stages/cropPackStage.test.ts‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { beforeEach, describe, expect, it, vi } from "vitest";
22

3-
const { encodeCropPackMemberMock, planCropPackMembersMock } = vi.hoisted(() => ({
3+
const { encodeCropPackMemberMock, planCropPackMembersForMasterMock } = vi.hoisted(() => ({
44
encodeCropPackMemberMock: vi.fn(),
5-
planCropPackMembersMock: vi.fn(),
5+
planCropPackMembersForMasterMock: vi.fn(),
66
}));
77

88
vi.mock("@hyperframes/engine", () => ({
99
encodeCropPackMember: encodeCropPackMemberMock,
10-
planCropPackMembers: planCropPackMembersMock,
10+
planCropPackMembersForMaster: planCropPackMembersForMasterMock,
1111
}));
1212

1313
import { runCropPackStage } from "./cropPackStage.js";
@@ -45,7 +45,7 @@ function makeJob(overrides: Partial<RenderJob["config"]> = {}): RenderJob {
4545
describe("runCropPackStage", () => {
4646
beforeEach(() => {
4747
vi.clearAllMocks();
48-
planCropPackMembersMock.mockReturnValue([
48+
planCropPackMembersForMasterMock.mockResolvedValue([
4949
{
5050
id: "vertical",
5151
crop: { x: 656, y: 0, width: 608, height: 1080 },
@@ -69,14 +69,25 @@ describe("runCropPackStage", () => {
6969
expect(masterPath).toBe("/tmp/launch.mp4");
7070
expect(result.members[0]?.outputPath).toBe("/tmp/launch.vertical.mp4");
7171
expect(job.cropPack?.[0]?.outputPath).toBe("/tmp/launch.vertical.mp4");
72-
expect(planCropPackMembersMock).toHaveBeenCalledWith(
72+
expect(planCropPackMembersForMasterMock).toHaveBeenCalledWith(
7373
job.config.cropPack?.members,
7474
1920,
7575
1080,
7676
masterPath,
7777
);
7878
});
7979

80+
it("passes the master's encoder settings to every member", async () => {
81+
const job = makeJob();
82+
const encode = { preset: "slow", quality: 18 };
83+
await runCropPackStage({ job, masterPath: "/tmp/launch.mp4", format: "mp4", encode });
84+
expect(encodeCropPackMemberMock).toHaveBeenCalledWith(
85+
expect.objectContaining({ id: "vertical" }),
86+
"/tmp/launch.mp4",
87+
expect.objectContaining({ encode }),
88+
);
89+
});
90+
8091
it("skips an empty pack list", async () => {
8192
const job = makeJob({ cropPack: undefined });
8293
const result = await runCropPackStage({

‎packages/producer/src/services/render/stages/cropPackStage.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
import {
1010
encodeCropPackMember,
11-
planCropPackMembers,
11+
planCropPackMembersForMaster,
12+
type CropPackEncodeSettings,
1213
type CropPackMemberResult,
1314
} from "@hyperframes/engine";
1415
import type { RenderJob } from "../../renderOrchestrator.js";
@@ -17,6 +18,8 @@ export interface CropPackStageInput {
1718
job: RenderJob;
1819
masterPath: string;
1920
format: string;
21+
/** The master's encoder settings, so siblings match its quality. */
22+
encode?: CropPackEncodeSettings;
2023
abortSignal?: AbortSignal;
2124
}
2225

@@ -33,7 +36,7 @@ export async function runCropPackStage(input: CropPackStageInput): Promise<CropP
3336
if (!spec || spec.members.length === 0) return { members: [] };
3437
if (!isCropPackContainer(input.format)) return { members: [] };
3538

36-
const plans = planCropPackMembers(
39+
const plans = await planCropPackMembersForMaster(
3740
spec.members,
3841
spec.compositionWidth,
3942
spec.compositionHeight,
@@ -45,6 +48,7 @@ export async function runCropPackStage(input: CropPackStageInput): Promise<CropP
4548
await encodeCropPackMember(plan, input.masterPath, {
4649
copyAudio: true,
4750
signal: input.abortSignal,
51+
encode: input.encode,
4852
}),
4953
);
5054
}

‎packages/producer/src/services/renderOrchestrator.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3971,6 +3971,7 @@ async function executeRenderPipeline(input: {
39713971
job,
39723972
masterPath: stagedOutputPath,
39733973
format: outputFormat,
3974+
encode: { preset: preset.preset, quality: effectiveQuality, bitrate: effectiveBitrate },
39743975
abortSignal: executionSignal,
39753976
});
39763977
if (cropPackRes.members.length > 0) {

0 commit comments

Comments
 (0)