Skip to content

Write HTML. Render video. Built for agents.

feat(producer): distributed renders accept 25 fps (#5423)

Robin Eberscc9e1bb33a43
diff --git a/docs/deploy/migrating-to-hyperframes-lambda.mdx b/docs/deploy/migrating-to-hyperframes-lambda.mdx
index 7582a8b996..b812afdf1e 100644
--- a/docs/deploy/migrating-to-hyperframes-lambda.mdx
+++ b/docs/deploy/migrating-to-hyperframes-lambda.mdx
@@ -52,7 +52,7 @@ Most adopters' render config maps directly:
| Concept | HyperFrames equivalent | Where it lives |
| ------------------------ | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `fps` | `--fps=30` (CLI) or `config.fps` (SDK) | 24, 30, 60 only — non-integer NTSC rationals are an in-process-only feature. |
+| `fps` | `--fps=30` (CLI) or `config.fps` (SDK) | 24, 25, 30, 60 only — non-integer NTSC rationals are an in-process-only feature. |
| `width` / `height` | `--width` / `--height` flags, or `config.width` / `config.height` | Even integers ≤ 7680 (yuv420p parity). |
| `codec: 'h264' / 'h265'` | `--codec=h264` or `--codec=h265` (mp4 only) | h265 uses libx265 with closed-GOP keyint params so chunked concat-copy round-trips losslessly. |
| Output format | `--format=mp4 / mov / webm / png-sequence` | webm uses libvpx-vp9 + closed-GOP concat-copy. Distributed mode still refuses HDR mp4 at plan time. |
diff --git a/docs/packages/cli.mdx b/docs/packages/cli.mdx
index 0ed9b94395..bc6f33743b 100644
--- a/docs/packages/cli.mdx
+++ b/docs/packages/cli.mdx
@@ -1937,7 +1937,7 @@ And these drive `render` and `render-batch`:
| ----------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `--width`, `--height` | required | Render dimensions in pixels |
| `--site-id` | content hash | Reuse an uploaded site instead of uploading again |
-| `--fps` | `30` | `24`, `30`, or `60` |
+| `--fps` | `30` | `24`, `25`, `30`, or `60` |
| `--format` | `mp4` | `mp4`, `mov`, `webm`, or `png-sequence` |
| `--codec` | `h264` | `h264` or `h265`, MP4 only |
| `--quality` | `standard` | `draft`, `standard`, or `high` |
diff --git a/packages/aws-lambda/src/events.ts b/packages/aws-lambda/src/events.ts
index 8b25122dc5..233e938178 100644
--- a/packages/aws-lambda/src/events.ts
+++ b/packages/aws-lambda/src/events.ts
@@ -164,7 +164,7 @@ interface PlanLambdaResultBase {
PlanHash: string;
ChunkCount: number;
TotalFrames: number;
- Fps: 24 | 30 | 60;
+ Fps: 24 | 25 | 30 | 60;
Width: number;
Height: number;
Format: DistributedFormat;
diff --git a/packages/aws-lambda/src/sdk/renderToLambda.test.ts b/packages/aws-lambda/src/sdk/renderToLambda.test.ts
index bb9007bb06..b858703235 100644
--- a/packages/aws-lambda/src/sdk/renderToLambda.test.ts
+++ b/packages/aws-lambda/src/sdk/renderToLambda.test.ts
@@ -173,7 +173,7 @@ describe("renderToLambda", () => {
projectDir,
bucketName: "test-bucket",
stateMachineArn: "arn:aws:states:us-east-1:1234:stateMachine:hf",
- config: { ...baseConfig, fps: 25 as 24 | 30 | 60 },
+ config: { ...baseConfig, fps: 50 as 24 | 25 | 30 | 60 },
sfn: asSFNClient(sfn),
s3: asS3Client(s3),
});
diff --git a/packages/aws-lambda/src/sdk/validateConfig.test.ts b/packages/aws-lambda/src/sdk/validateConfig.test.ts
index daf2250f7d..a3560f5deb 100644
--- a/packages/aws-lambda/src/sdk/validateConfig.test.ts
+++ b/packages/aws-lambda/src/sdk/validateConfig.test.ts
@@ -20,6 +20,11 @@ describe("validateDistributedRenderConfig", () => {
expect(validateDistributedRenderConfig(VALID)).toBe(VALID);
});
+ it("accepts 25 fps", () => {
+ const cfg: SerializableDistributedRenderConfig = { ...VALID, fps: 25 };
+ expect(validateDistributedRenderConfig(cfg)).toBe(cfg);
+ });
+
it("accepts optional fields when valid", () => {
const cfg: SerializableDistributedRenderConfig = {
...VALID,
@@ -39,7 +44,7 @@ describe("validateDistributedRenderConfig", () => {
["null config", null as unknown as SerializableDistributedRenderConfig, "config"],
[
"wrong fps",
- { ...VALID, fps: 25 as 24 | 30 | 60 } satisfies SerializableDistributedRenderConfig,
+ { ...VALID, fps: 50 as 24 | 25 | 30 | 60 } satisfies SerializableDistributedRenderConfig,
"config.fps",
],
[
diff --git a/packages/cli/src/commands/cloudrun.ts b/packages/cli/src/commands/cloudrun.ts
index 804bc7f9c1..405677596f 100644
--- a/packages/cli/src/commands/cloudrun.ts
+++ b/packages/cli/src/commands/cloudrun.ts
@@ -167,7 +167,7 @@ export default defineCommand({
"site-id": { type: "string", description: "Explicit site id (overrides content hash)" },
width: { type: "string", description: "Render width in pixels" },
height: { type: "string", description: "Render height in pixels" },
- fps: { type: "string", description: "Render fps (24 | 30 | 60)" },
+ fps: { type: "string", description: "Render fps (24 | 25 | 30 | 60)" },
format: { type: "string", description: "mp4 | mov | png-sequence | webm (default: mp4)" },
codec: { type: "string", description: "h264 | h265 (mp4 only)" },
quality: { type: "string", description: "draft | standard | high" },
@@ -529,11 +529,11 @@ function resolveCloudRunFps(
args: Record<string, unknown>,
projectDir: string,
command: "render" | "render-batch",
-): 24 | 30 | 60 {
+): 24 | 25 | 30 | 60 {
const fps =
- parseIntFlag(args.fps) ?? readAllowedCompositionFpsFromDir(projectDir, [24, 30, 60]) ?? 30;
- if (fps === 24 || fps === 30 || fps === 60) return fps;
- console.error(`[cloudrun ${command}] --fps must be 24, 30, or 60; got ${fps}.`);
+ parseIntFlag(args.fps) ?? readAllowedCompositionFpsFromDir(projectDir, [24, 25, 30, 60]) ?? 30;
+ if (fps === 24 || fps === 25 || fps === 30 || fps === 60) return fps;
+ console.error(`[cloudrun ${command}] --fps must be 24, 25, 30, or 60; got ${fps}.`);
failCommand();
}
diff --git a/packages/cli/src/commands/lambda.ts b/packages/cli/src/commands/lambda.ts
index 5265602a08..e0226c84d4 100644
--- a/packages/cli/src/commands/lambda.ts
+++ b/packages/cli/src/commands/lambda.ts
@@ -126,7 +126,7 @@ export default defineCommand({
description:
"Output resolution preset that engages Chrome deviceScaleFactor supersampling. Accepts canonical names (landscape, landscape-4k, portrait, portrait-4k, square, square-4k) and aliases (1080p, 4k, uhd, hd). When set, the composition's authored data-width/data-height is supersampled to the target preset without changing the layout.",
},
- fps: { type: "string", description: "Render fps (24 | 30 | 60)" },
+ fps: { type: "string", description: "Render fps (24 | 25 | 30 | 60)" },
format: { type: "string", description: "mp4 | mov | png-sequence | webm (default: mp4)" },
codec: { type: "string", description: "h264 | h265 (mp4 only)" },
quality: { type: "string", description: "draft | standard | high" },
@@ -298,10 +298,10 @@ export default defineCommand({
}
const fpsRaw =
parseIntFlag(args.fps) ??
- readAllowedCompositionFpsFromDir(projectDir, [24, 30, 60]) ??
+ readAllowedCompositionFpsFromDir(projectDir, [24, 25, 30, 60]) ??
30;
- if (fpsRaw !== 24 && fpsRaw !== 30 && fpsRaw !== 60) {
- console.error(`[lambda render] --fps must be 24, 30, or 60; got ${fpsRaw}.`);
+ if (fpsRaw !== 24 && fpsRaw !== 25 && fpsRaw !== 30 && fpsRaw !== 60) {
+ console.error(`[lambda render] --fps must be 24, 25, 30, or 60; got ${fpsRaw}.`);
failCommand();
}
const { runRender } = await import("./lambda/render.js");
@@ -355,10 +355,10 @@ export default defineCommand({
}
const fpsRaw =
parseIntFlag(args.fps) ??
- readAllowedCompositionFpsFromDir(projectDir, [24, 30, 60]) ??
+ readAllowedCompositionFpsFromDir(projectDir, [24, 25, 30, 60]) ??
30;
- if (fpsRaw !== 24 && fpsRaw !== 30 && fpsRaw !== 60) {
- console.error(`[lambda render-batch] --fps must be 24, 30, or 60; got ${fpsRaw}.`);
+ if (fpsRaw !== 24 && fpsRaw !== 25 && fpsRaw !== 30 && fpsRaw !== 60) {
+ console.error(`[lambda render-batch] --fps must be 24, 25, 30, or 60; got ${fpsRaw}.`);
failCommand();
}
const { runRenderBatch } = await import("./lambda/render-batch.js");
diff --git a/packages/cli/src/commands/lambda/render-batch.ts b/packages/cli/src/commands/lambda/render-batch.ts
index a071122fd9..9fd7c136b4 100644
--- a/packages/cli/src/commands/lambda/render-batch.ts
+++ b/packages/cli/src/commands/lambda/render-batch.ts
@@ -61,7 +61,7 @@ export interface RenderBatchArgs {
*/
siteId?: string;
/** Composition config — fps/width/height/format required, rest optional. */
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
width: number;
height: number;
/** See {@link RenderArgs.outputResolution}. */
diff --git a/packages/cli/src/commands/lambda/render.ts b/packages/cli/src/commands/lambda/render.ts
index 14063c1b54..8274c23869 100644
--- a/packages/cli/src/commands/lambda/render.ts
+++ b/packages/cli/src/commands/lambda/render.ts
@@ -32,7 +32,7 @@ export interface RenderArgs {
stackName: string;
siteId?: string;
/** Composition config — fps/width/height/format required, rest optional. */
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
width: number;
height: number;
/**
diff --git a/packages/cli/src/utils/compositionFps.ts b/packages/cli/src/utils/compositionFps.ts
index 8286febbda..bc2b13012e 100644
--- a/packages/cli/src/utils/compositionFps.ts
+++ b/packages/cli/src/utils/compositionFps.ts
@@ -36,7 +36,7 @@ export function readCompositionFps(html: string): string | null {
/**
* Cloud render backends (Lambda, Cloud Run) accept only an integer fps
- * from a small fixed allowed set (currently {24, 30, 60}) — unlike local
+ * from a small fixed allowed set (currently {24, 25, 30, 60}) — unlike local
* `render`, they can't take an arbitrary/fractional data-fps. Reads
* `<projectDir>/index.html` and returns its declared data-fps as a number
* ONLY when it parses to an integer AND is a member of `allowed`;
diff --git a/packages/gcp-cloud-run/src/events.ts b/packages/gcp-cloud-run/src/events.ts
index 244b032920..f43fbc2449 100644
--- a/packages/gcp-cloud-run/src/events.ts
+++ b/packages/gcp-cloud-run/src/events.ts
@@ -178,7 +178,7 @@ interface PlanResultBodyBase {
PlanHash: string;
ChunkCount: number;
TotalFrames: number;
- Fps: 24 | 30 | 60;
+ Fps: 24 | 25 | 30 | 60;
Width: number;
Height: number;
Format: DistributedFormat;
diff --git a/packages/gcp-cloud-run/src/sdk/renderToCloudRun.test.ts b/packages/gcp-cloud-run/src/sdk/renderToCloudRun.test.ts
index cc487a9913..a6a394c872 100644
--- a/packages/gcp-cloud-run/src/sdk/renderToCloudRun.test.ts
+++ b/packages/gcp-cloud-run/src/sdk/renderToCloudRun.test.ts
@@ -136,7 +136,7 @@ describe("renderToCloudRun", () => {
it("validates the config before any GCP call", async () => {
const fake = new FakeExecutions();
await expect(
- renderToCloudRun({ ...opts(fake), config: { ...config, fps: 25 } as never }),
+ renderToCloudRun({ ...opts(fake), config: { ...config, fps: 50 } as never }),
).rejects.toThrow(/config\.fps/);
expect(fake.lastArgument).toBeNull();
});
diff --git a/packages/gcp-cloud-run/src/sdk/validateConfig.test.ts b/packages/gcp-cloud-run/src/sdk/validateConfig.test.ts
index b7ee430f85..96c00b3f26 100644
--- a/packages/gcp-cloud-run/src/sdk/validateConfig.test.ts
+++ b/packages/gcp-cloud-run/src/sdk/validateConfig.test.ts
@@ -28,8 +28,12 @@ describe("validateDistributedRenderConfig", () => {
expect(validateDistributedRenderConfig(base())).toBeDefined();
});
+ it("accepts 25 fps", () => {
+ expect(validateDistributedRenderConfig({ ...base(), fps: 25 }).fps).toBe(25);
+ });
+
it("rejects a bad fps", () => {
- expect(() => validateDistributedRenderConfig({ ...base(), fps: 25 } as never)).toThrow(
+ expect(() => validateDistributedRenderConfig({ ...base(), fps: 50 } as never)).toThrow(
/config\.fps/,
);
});
diff --git a/packages/producer/src/plan-parity-contract.ts b/packages/producer/src/plan-parity-contract.ts
index 0b783a1145..065abc11b9 100644
--- a/packages/producer/src/plan-parity-contract.ts
+++ b/packages/producer/src/plan-parity-contract.ts
@@ -9,7 +9,7 @@
export type PlanParityProtocol = "v1" | "v2";
export interface PlanParityRenderConfig {
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
width: number;
height: number;
format: "mp4";
diff --git a/packages/producer/src/plan-parity-harness.test.ts b/packages/producer/src/plan-parity-harness.test.ts
index aae449507c..9ddbee21d2 100644
--- a/packages/producer/src/plan-parity-harness.test.ts
+++ b/packages/producer/src/plan-parity-harness.test.ts
@@ -97,8 +97,8 @@ describe("parsePlanParityArgs()", () => {
expect(() =>
parsePlanParityArgs(["node", "plan-parity", "--v1-plan-size-cap-bytes", "-1"]),
).toThrow(/positive integer/);
- expect(() => parsePlanParityArgs(["node", "plan-parity", "--fps", "25"])).toThrow(
- /24, 30, or 60/,
+ expect(() => parsePlanParityArgs(["node", "plan-parity", "--fps", "50"])).toThrow(
+ /24, 25, 30, or 60/,
);
expect(() =>
parsePlanParityArgs(["node", "plan-parity", "--duration-tolerance-seconds", "not-a-number"]),
diff --git a/packages/producer/src/plan-parity-harness.ts b/packages/producer/src/plan-parity-harness.ts
index 12a7cda801..2b1e43d7aa 100644
--- a/packages/producer/src/plan-parity-harness.ts
+++ b/packages/producer/src/plan-parity-harness.ts
@@ -155,8 +155,8 @@ export function parsePlanParityArgs(argv: string[]): PlanParityCliOptions {
const fixtureDir = resolve(args.get("fixture") ?? "fixtures/plan-parity-visual-audio");
const artifactsDir = resolve(args.get("artifacts-dir") ?? ".debug/plan-protocol-parity");
const fps = parsePositiveInteger("fps", args.get("fps")) ?? 30;
- if (fps !== 24 && fps !== 30 && fps !== 60) {
- throw new Error("plan parity: --fps must be 24, 30, or 60");
+ if (fps !== 24 && fps !== 25 && fps !== 30 && fps !== 60) {
+ throw new Error("plan parity: --fps must be 24, 25, 30, or 60");
}
return {
diff --git a/packages/producer/src/regression-harness-distributed.test.ts b/packages/producer/src/regression-harness-distributed.test.ts
index 6de6de6bef..a8b24f9b73 100644
--- a/packages/producer/src/regression-harness-distributed.test.ts
+++ b/packages/producer/src/regression-harness-distributed.test.ts
@@ -40,8 +40,8 @@ describe("parseHarnessModeFlag()", () => {
});
describe("checkDistributedSupport()", () => {
- it("accepts mp4 SDR at 24 / 30 / 60 fps", () => {
- for (const fpsNum of [24, 30, 60]) {
+ it("accepts mp4 SDR at 24 / 25 / 30 / 60 fps", () => {
+ for (const fpsNum of [24, 25, 30, 60]) {
const result = checkDistributedSupport({ fps: { num: fpsNum, den: 1 } });
expect(result.supported).toBe(true);
}
@@ -60,12 +60,12 @@ describe("checkDistributedSupport()", () => {
}
});
- it("rejects fps outside the {24,30,60} set", () => {
- for (const fpsNum of [12, 25, 48, 50, 120]) {
+ it("rejects fps outside the {24,25,30,60} set", () => {
+ for (const fpsNum of [12, 48, 50, 120]) {
const result = checkDistributedSupport({ fps: { num: fpsNum, den: 1 } });
expect(result.supported).toBe(false);
if (!result.supported) {
- expect(result.reason).toMatch(/not in \{24, 30, 60\}/);
+ expect(result.reason).toMatch(/not in \{24, 25, 30, 60\}/);
}
}
});
diff --git a/packages/producer/src/regression-harness-distributed.ts b/packages/producer/src/regression-harness-distributed.ts
index b35dbaa7f7..73aa59b192 100644
--- a/packages/producer/src/regression-harness-distributed.ts
+++ b/packages/producer/src/regression-harness-distributed.ts
@@ -92,10 +92,10 @@ export function checkDistributedSupport(renderConfig: {
};
}
const fpsNum = renderConfig.fps.num;
- if (fpsNum !== 24 && fpsNum !== 30 && fpsNum !== 60) {
+ if (fpsNum !== 24 && fpsNum !== 25 && fpsNum !== 30 && fpsNum !== 60) {
return {
supported: false,
- reason: `fps ${fpsNum} not in {24, 30, 60} (DistributedRenderConfig.fps is a closed set)`,
+ reason: `fps ${fpsNum} not in {24, 25, 30, 60} (DistributedRenderConfig.fps is a closed set)`,
};
}
if (renderConfig.hdr === true) {
@@ -120,7 +120,7 @@ export interface RunDistributedSimulatedInput {
/** Where to write the assembled final mp4 / mov / png-sequence directory. */
renderedOutputPath: string;
/** From the fixture's renderConfig — must pass `checkDistributedSupport`. */
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
format: DistributedFormat;
/**
* Codec for `format: "mp4"`. Defaults to `"h264"`; pass `"h265"` to
diff --git a/packages/producer/src/regression-harness-lambda-local-types.ts b/packages/producer/src/regression-harness-lambda-local-types.ts
index 1579547154..ab8dd0bb7f 100644
--- a/packages/producer/src/regression-harness-lambda-local-types.ts
+++ b/packages/producer/src/regression-harness-lambda-local-types.ts
@@ -18,7 +18,7 @@ export interface RunLambdaLocalInput {
projectDir: string;
tempRoot: string;
renderedOutputPath: string;
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
/**
* Width/height from the fixture's renderConfig. Forwarded directly to
* the Lambda event so this mode catches drift if the handler ever
diff --git a/packages/producer/src/regression-harness.ts b/packages/producer/src/regression-harness.ts
index 555b7520d0..959b396f7b 100644
--- a/packages/producer/src/regression-harness.ts
+++ b/packages/producer/src/regression-harness.ts
@@ -1117,7 +1117,7 @@ async function runTestSuite(
// `checkDistributedSupport` already narrowed fps to {24,30,60}; the
// cast surfaces that guarantee to TS. webm is now distributed-
// supported via closed-GOP concat-copy, so the format passes through.
- const fpsNum = suite.meta.renderConfig.fps.num as 24 | 30 | 60;
+ const fpsNum = suite.meta.renderConfig.fps.num as 24 | 25 | 30 | 60;
const distributedInput = {
projectDir: tempSrcDir,
tempRoot,
diff --git a/packages/producer/src/regression-shard-plan.test.ts b/packages/producer/src/regression-shard-plan.test.ts
index aeabc2bae6..4a0e779acb 100644
--- a/packages/producer/src/regression-shard-plan.test.ts
+++ b/packages/producer/src/regression-shard-plan.test.ts
@@ -159,7 +159,7 @@ describe("shard planner fixture discovery", () => {
expect(hdr.supported).toBe(false);
const ntsc = checkDistributedSupport({ fps: { num: 30000, den: 1001 } });
expect(ntsc.supported).toBe(false);
- const odd = checkDistributedSupport({ fps: { num: 25, den: 1 } });
+ const odd = checkDistributedSupport({ fps: { num: 50, den: 1 } });
expect(odd.supported).toBe(false);
});
diff --git a/packages/producer/src/renderRequest.test.ts b/packages/producer/src/renderRequest.test.ts
index 9fb1cca947..96ffd04f19 100644
--- a/packages/producer/src/renderRequest.test.ts
+++ b/packages/producer/src/renderRequest.test.ts
@@ -120,6 +120,12 @@ describe("RenderRequest", () => {
expect(renderConfigFromRequest(value).producerConfig?.forceScreenshot).toBe(true);
});
+ it("accepts 25 fps for a distributed render", () => {
+ const value = request();
+ value.options.fps = { num: 25, den: 1 };
+ expect(distributedConfigFromRequest(value).fps).toBe(25);
+ });
+
it("rejects unsupported distributed fps before an adapter launch", () => {
const value = request();
value.options.fps = { num: 30_000, den: 1_001 };
diff --git a/packages/producer/src/renderRequest.ts b/packages/producer/src/renderRequest.ts
index 12cbc442d5..abff40161a 100644
--- a/packages/producer/src/renderRequest.ts
+++ b/packages/producer/src/renderRequest.ts
@@ -262,8 +262,9 @@ export function renderConfigFromRequest(
};
}
-function distributedFps(fps: Fps): 24 | 30 | 60 {
- if (fps.den === 1 && (fps.num === 24 || fps.num === 30 || fps.num === 60)) return fps.num;
+function distributedFps(fps: Fps): 24 | 25 | 30 | 60 {
+ if (fps.den === 1 && (fps.num === 24 || fps.num === 25 || fps.num === 30 || fps.num === 60))
+ return fps.num;
throw new Error(`Distributed render does not support fps ${fps.num}/${fps.den}`);
}
diff --git a/packages/producer/src/services/distributed/plan.ts b/packages/producer/src/services/distributed/plan.ts
index 6b09a4693b..ef9ea5c1e5 100644
--- a/packages/producer/src/services/distributed/plan.ts
+++ b/packages/producer/src/services/distributed/plan.ts
@@ -103,7 +103,7 @@ import {
*/
export interface DistributedRenderConfig {
/** Integer frame rate. Distributed renders only accept integer fps; the in-process renderer's `Fps` rational handles NTSC. */
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
width: number;
height: number;
/**
@@ -271,7 +271,7 @@ export interface LocalExecutionPlan {
executionPlanHash: string;
chunkCount: number;
totalFrames: number;
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
width: number;
height: number;
format: DistributedFormat;
@@ -307,7 +307,7 @@ export interface PlanResult {
planHash: string;
chunkCount: number;
totalFrames: number;
- fps: 24 | 30 | 60;
+ fps: 24 | 25 | 30 | 60;
width: number;
height: number;
format: DistributedFormat;
diff --git a/packages/producer/src/services/distributed/planV2.test.ts b/packages/producer/src/services/distributed/planV2.test.ts
index 287e4a51cf..9c1be46b88 100644
--- a/packages/producer/src/services/distributed/planV2.test.ts
+++ b/packages/producer/src/services/distributed/planV2.test.ts
@@ -57,6 +57,7 @@ function createV1Plan(
audio?: boolean;
video?: boolean;
omitVideoMetadata?: boolean;
+ fpsNum?: number;
fpsDen?: number;
videoColorSpace?: unknown;
videoCodec?: string;
@@ -73,6 +74,7 @@ function createV1Plan(
audio = false,
video = false,
omitVideoMetadata = false,
+ fpsNum = 30,
fpsDen = 1,
videoColorSpace = null,
videoCodec = "h264",
@@ -172,7 +174,7 @@ function createV1Plan(
producerVersion: "0.0.0-test",
fontSnapshotSha: "font-snapshot-fixture",
dimensions: {
- fpsNum: 30,
+ fpsNum,
fpsDen,
width: 16,
height: 16,
@@ -686,6 +688,21 @@ describe("Plan v2 manifest", () => {
expect(() => createPlanV2FromV1(v1, join(root, "v2"))).toThrow("dimensions.fpsDen must be 1");
});
+ it("carries 25 fps through the manifest it writes and reads back", () => {
+ const root = tempPath("hf-plan-v2-fps-25-");
+ const v1 = createV1Plan(root, { fpsNum: 25 });
+ const manifest = readPlanV2Manifest(createPlanV2FromV1(v1, join(root, "v2")).planDir);
+ expect(manifest.fps).toBe(25);
+ });
+
+ it("rejects an fps outside the distributed set", () => {
+ const root = tempPath("hf-plan-v2-fps-50-");
+ const v1 = createV1Plan(root, { fpsNum: 50 });
+ expect(() => createPlanV2FromV1(v1, join(root, "v2"))).toThrow(
+ "dimensions.fpsNum must be 24, 25, 30, or 60",
+ );
+ });
+
it("materializes and revalidates strict chunk and assembler subsets", () => {
const root = tempPath("hf-plan-v2-materialize-");
const result = createPlanV2FromV1(createV1Plan(root, { audio: true }), join(root, "v2"));
diff --git a/packages/producer/src/services/distributed/planV2.ts b/packages/producer/src/services/distributed/planV2.ts
index 730daa9593..02183f9bda 100644
--- a/packages/producer/src/services/distributed/planV2.ts
+++ b/packages/producer/src/services/distributed/planV2.ts
@@ -92,7 +92,7 @@ export interface PlanV2Manifest {
readonly sourcePlanV1Hash: string;
readonly chunkCount: number;
readonly totalFrames: number;
- readonly fps: 24 | 30 | 60;
+ readonly fps: 24 | 25 | 30 | 60;
readonly width: number;
readonly height: number;
readonly format: DistributedFormat;
@@ -120,7 +120,7 @@ export interface PlanV2Result {
readonly sourcePlanV1Hash: string;
readonly chunkCount: number;
readonly totalFrames: number;
- readonly fps: 24 | 30 | 60;
+ readonly fps: 24 | 25 | 30 | 60;
readonly width: number;
readonly height: number;
readonly format: DistributedFormat;
@@ -765,14 +765,14 @@ function readNonNegativeInteger(value: unknown, field: string): number {
return value;
}
-function readSupportedFps(value: unknown): 24 | 30 | 60 {
- if (value !== 24 && value !== 30 && value !== 60) {
- throw new PlanV2IntegrityError("dimensions.fpsNum must be 24, 30, or 60");
+function readSupportedFps(value: unknown): 24 | 25 | 30 | 60 {
+ if (value !== 24 && value !== 25 && value !== 30 && value !== 60) {
+ throw new PlanV2IntegrityError("dimensions.fpsNum must be 24, 25, 30, or 60");
}
return value;
}
-function readExecutionPlanFps(dimensions: Record<string, unknown>): 24 | 30 | 60 {
+function readExecutionPlanFps(dimensions: Record<string, unknown>): 24 | 25 | 30 | 60 {
const fpsDen = readPositiveInteger(dimensions.fpsDen, "dimensions.fpsDen");
if (fpsDen !== 1) {
throw new PlanV2IntegrityError("dimensions.fpsDen must be 1 for plan v2");
diff --git a/packages/producer/src/services/distributed/renderConfigValidation.ts b/packages/producer/src/services/distributed/renderConfigValidation.ts
index 69669bd591..8b64f50656 100644
--- a/packages/producer/src/services/distributed/renderConfigValidation.ts
+++ b/packages/producer/src/services/distributed/renderConfigValidation.ts
@@ -48,7 +48,7 @@ export class InvalidConfigError extends Error {
}
}
-const ALLOWED_FPS = [24, 30, 60] as const;
+const ALLOWED_FPS = [24, 25, 30, 60] as const;
const ALLOWED_FORMATS = [
"mp4",
"mov",
@@ -80,7 +80,7 @@ export function validateDistributedRenderConfig(
throw new InvalidConfigError("config", "must be an object");
}
- if (!ALLOWED_FPS.includes(config.fps as 24 | 30 | 60)) {
+ if (!ALLOWED_FPS.includes(config.fps as 24 | 25 | 30 | 60)) {
throw new InvalidConfigError(
"config.fps",
`must be one of ${ALLOWED_FPS.join(", ")}; got ${String(config.fps)}`,
diff --git a/packages/producer/tests/README.md b/packages/producer/tests/README.md
index 2ef35f4470..1bdeaa7b3f 100644
--- a/packages/producer/tests/README.md
+++ b/packages/producer/tests/README.md
@@ -92,7 +92,7 @@ of these gates are **skipped** with a clear log line (and counted as
passing in the summary):
- `fps.den !== 1` — distributed mode is integer-fps only (no NTSC).
-- `fps.num ∉ {24, 30, 60}` — closed set per `DistributedRenderConfig`.
+- `fps.num ∉ {24, 25, 30, 60}` — closed set per `DistributedRenderConfig`.
- `format === "webm"` — `plan()` refuses webm.
- `hdr === true` — distributed mode is SDR-only at v1.