Skip to content

Commit ad9ce86

Browse files
committed
fix(studio): cap GIF exports at 30 fps
1 parent 3642b63 commit ad9ce86

5 files changed

Lines changed: 90 additions & 11 deletions

File tree

‎packages/studio-server/src/routes/render.test.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,3 +1076,31 @@ describe("Studio GIF renders", () => {
10761076
}
10771077
});
10781078
});
1079+
1080+
describe("Studio GIF frame-rate cap", () => {
1081+
it.each([
1082+
{ format: "gif", fps: 60, expected: { num: 30, den: 1 } },
1083+
{ format: "gif", fps: "60000/1001", expected: { num: 30, den: 1 } },
1084+
{ format: "gif", fps: "30001/1000", expected: { num: 30, den: 1 } },
1085+
{ format: "gif", fps: "30000/1001", expected: { num: 30000, den: 1001 } },
1086+
{ format: "gif", fps: 30, expected: { num: 30, den: 1 } },
1087+
{ format: "gif", fps: 24, expected: { num: 24, den: 1 } },
1088+
{ format: "mp4", fps: 60, expected: { num: 60, den: 1 } },
1089+
{ format: "webm", fps: 60, expected: { num: 60, den: 1 } },
1090+
{ format: "mov", fps: 60, expected: { num: 60, den: 1 } },
1091+
])("forwards $format at $fps fps as $expected", async ({ format, fps, expected }) => {
1092+
const spy = vi.fn();
1093+
const { app, cleanup } = buildApp(spy);
1094+
try {
1095+
const res = await app.request("/projects/demo/render", {
1096+
method: "POST",
1097+
headers: { "content-type": "application/json" },
1098+
body: JSON.stringify({ format, fps }),
1099+
});
1100+
expect(res.status).toBe(200);
1101+
expect(spy).toHaveBeenCalledWith(expect.objectContaining({ format, fps: expected }));
1102+
} finally {
1103+
cleanup();
1104+
}
1105+
});
1106+
});

‎packages/studio-server/src/routes/render.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { existsSync, lstatSync, readFileSync, unlinkSync, readdirSync, statSync
44
import { dirname, join } from "node:path";
55
import type { StudioApiAdapter, RenderJobState } from "../types.js";
66
import { VALID_CANVAS_RESOLUTIONS, type CanvasResolution } from "@hyperframes/parsers";
7-
import { formatRenderOutputTimestamp, parseFps } from "@hyperframes/core";
7+
import { formatRenderOutputTimestamp, parseFps, fpsToNumber } from "@hyperframes/core";
88
import {
99
folderGone,
1010
isPrivateProjectFile,
@@ -124,7 +124,9 @@ export function registerRenderRoutes(api: Hono, adapter: StudioApiAdapter): void
124124
// `quality` already in this file) — the producer surfaces a clearer error
125125
// message if the caller really did mean to fail loudly.
126126
const fpsParse = body.fps === undefined ? null : parseFps(body.fps);
127-
const fps = fpsParse && fpsParse.ok ? fpsParse.value : { num: 30, den: 1 };
127+
const requestedFps = fpsParse && fpsParse.ok ? fpsParse.value : { num: 30, den: 1 };
128+
const fps =
129+
format === "gif" && fpsToNumber(requestedFps) > 30 ? { num: 30, den: 1 } : requestedFps;
128130
const quality = ["draft", "standard", "high"].includes(body.quality ?? "")
129131
? (body.quality as string)
130132
: "standard";

‎packages/studio/src/components/renders/RenderQueue.test.tsx‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,3 +321,34 @@ describe("GIF export controls", () => {
321321
expect(onStartRender).not.toHaveBeenCalled();
322322
});
323323
});
324+
325+
describe("GIF frame-rate controls", () => {
326+
it("caps a saved GIF frame rate of 60 and disables that option", async () => {
327+
localStorage.setItem("hf-studio-render-settings", JSON.stringify({ format: "gif", fps: 60 }));
328+
const onStartRender: Mock<StartRenderHandler> = vi.fn();
329+
const host = mountRenderQueue(onStartRender);
330+
const fps = triggerFor(host, "Frame rate");
331+
expect(fps.textContent).toContain("30 fps");
332+
act(() => exportButtonIn(host).click());
333+
expect(onStartRender).toHaveBeenCalledWith("gif", "standard", "auto", 30, false, 0);
334+
act(() => fps.click());
335+
await settle();
336+
const sixty = Array.from(document.querySelectorAll('[role="option"]')).find((option) =>
337+
option.textContent?.includes("60 fps"),
338+
);
339+
expect(sixty?.getAttribute("aria-disabled")).toBe("true");
340+
});
341+
342+
it("switches a 60 fps video to a 30 fps GIF and preserves 60 fps for video", async () => {
343+
localStorage.setItem("hf-studio-render-settings", JSON.stringify({ format: "mp4", fps: 60 }));
344+
const onStartRender: Mock<StartRenderHandler> = vi.fn();
345+
const host = mountRenderQueue(onStartRender);
346+
act(() => exportButtonIn(host).click());
347+
expect(onStartRender).toHaveBeenLastCalledWith("mp4", "standard", "auto", 60, false);
348+
await chooseByArrowing(triggerFor(host, "Format"), 3);
349+
expect(triggerFor(host, "Frame rate").textContent).toContain("30 fps");
350+
expect(getPersistedRenderSettings()).toMatchObject({ format: "gif", fps: 30 });
351+
act(() => exportButtonIn(host).click());
352+
expect(onStartRender).toHaveBeenLastCalledWith("gif", "standard", "auto", 30, false, 0);
353+
});
354+
});

‎packages/studio/src/components/renders/RenderQueue.tsx‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import { resolveFloatingPanelPosition, type FloatingPosition } from "../editor/f
1212
import type { RenderJob, ResolutionPreset } from "./useRenderQueue";
1313
import {
1414
FORMAT_INFO,
15+
resolveRenderFps,
16+
getRenderFpsOptions,
1517
getPersistedRenderSettings,
1618
persistRenderSettings,
1719
resolveRenderFormat,
@@ -270,12 +272,6 @@ const QUALITY_OPTIONS: SelectOption[] = [
270272
{ value: "high", label: "High Quality" },
271273
];
272274

273-
const FPS_OPTIONS: SelectOption[] = [
274-
{ value: "24", label: "24 fps" },
275-
{ value: "30", label: "30 fps" },
276-
{ value: "60", label: "60 fps" },
277-
];
278-
279275
function formatEta(ms: number): string {
280276
const s = Math.round(ms / 1000);
281277
return s < 60 ? `${s}s` : `${Math.floor(s / 60)}m ${s % 60}s`;
@@ -302,7 +298,8 @@ function FormatExportButton({
302298
const [format, setFormat] = useState<"mp4" | "webm" | "mov" | "gif">(persisted.format);
303299
const [quality, setQuality] = useState<"draft" | "standard" | "high">(persisted.quality);
304300
const [resolution, setResolution] = useState<RenderScale>("auto");
305-
const [fps, setFps] = useState<24 | 30 | 60>(persisted.fps);
301+
const [requestedFps, setFps] = useState<24 | 30 | 60>(persisted.fps);
302+
const fps = resolveRenderFps(format, requestedFps);
306303
const [gpu, setGpu] = useState(persisted.gpu);
307304
const [gifLoop, setGifLoop] = useState("0");
308305
const loopCount = Number(gifLoop);
@@ -341,7 +338,7 @@ function FormatExportButton({
341338
onCommit={(next) => {
342339
const v = resolveRenderFormat(next);
343340
setFormat(v);
344-
persistRenderSettings(v, quality, fps);
341+
persistRenderSettings(v, quality, resolveRenderFps(v, requestedFps));
345342
}}
346343
/>
347344
</div>
@@ -364,7 +361,7 @@ function FormatExportButton({
364361
<Select
365362
label="Frame rate"
366363
value={String(fps)}
367-
options={FPS_OPTIONS}
364+
options={getRenderFpsOptions(format)}
368365
disabled={isRendering}
369366
onCommit={(next) => {
370367
const v = Number(next) as 24 | 30 | 60;

‎packages/studio/src/components/renders/renderSettings.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import type { SelectOption } from "../ui/Select";
12
import type { StartRenderHandler } from "./RenderQueue";
23
import type { ResolutionPreset } from "./useRenderQueue";
34

@@ -77,3 +78,23 @@ export const FORMAT_INFO: Record<"mp4" | "webm" | "mov" | "gif", { label: string
7778
desc: "Transparent video for web. Smaller than MOV but limited editor support.",
7879
},
7980
};
81+
82+
const FPS_OPTIONS: SelectOption[] = [
83+
{ value: "24", label: "24 fps" },
84+
{ value: "30", label: "30 fps" },
85+
{ value: "60", label: "60 fps" },
86+
];
87+
88+
export function resolveRenderFps(
89+
format: PersistedRenderSettings["format"],
90+
fps: PersistedRenderSettings["fps"],
91+
): PersistedRenderSettings["fps"] {
92+
return format === "gif" && fps === 60 ? 30 : fps;
93+
}
94+
95+
export function getRenderFpsOptions(format: PersistedRenderSettings["format"]): SelectOption[] {
96+
return FPS_OPTIONS.map((option) => ({
97+
...option,
98+
disabled: format === "gif" && option.value === "60",
99+
}));
100+
}

0 commit comments

Comments
 (0)