Skip to content

Commit 91f9c9e

Browse files
feat(studio): export can encode on the GPU, like render --gpu (#5397)
* feat(studio): export can encode on the GPU, like render --gpu * test(studio): the 4K export assertion carries the GPU flag * refactor(studio): the GPU flag needs no comment beyond its name * fix(studio-server): only MP4 exports encode on the GPU, and render errors report it * fix(studio): the disabled GPU option dims like the other export controls
1 parent 684c038 commit 91f9c9e

16 files changed

Lines changed: 158 additions & 10 deletions

‎packages/cli/src/server/studioRenderTelemetry.test.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,3 +352,15 @@ describe("studioRenderTelemetry", () => {
352352
});
353353
});
354354
});
355+
356+
describe("studio render telemetry: GPU encoding", () => {
357+
it("reports whether the render asked for GPU encoding, on success and on failure", () => {
358+
trackRenderComplete.mockClear();
359+
trackRenderError.mockClear();
360+
emitStudioRenderComplete({ ...opts, useGpu: true }, 1000, undefined);
361+
emitStudioRenderError({ ...opts, useGpu: true }, 1000, "capture", new Error("x"), undefined);
362+
emitStudioRenderComplete(opts, 1000, undefined);
363+
expect(trackRenderComplete.mock.calls.map(([props]) => props.gpu)).toEqual([true, false]);
364+
expect(trackRenderError.mock.calls[0]?.[0]).toMatchObject({ gpu: true });
365+
});
366+
});

‎packages/cli/src/server/studioRenderTelemetry.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ export interface StudioRenderOpts {
2424
format?: "mp4" | "webm" | "mov";
2525
/** Named canvas preset the Studio request asked for; undefined renders at the composition's native dimensions. */
2626
outputResolution?: CanvasResolution;
27+
useGpu?: boolean;
2728
// gif_fps_capped/hdr_mode/video_frame_format are deliberately absent: Studio
2829
// has no gif/png-sequence option and createRenderJob never receives an
2930
// hdrMode or videoFrameFormat from the Studio request type, so there is no
@@ -127,6 +128,7 @@ export function emitStudioRenderError(
127128
fps: fpsToNumber(opts.fps),
128129
quality: opts.quality,
129130
docker: false,
131+
gpu: opts.useGpu === true,
130132
source: "studio",
131133
failedStage,
132134
errorMessage: err instanceof Error ? err.message : String(err),
@@ -150,7 +152,7 @@ export function emitStudioRenderComplete(
150152
fps: fpsToNumber(opts.fps),
151153
quality: opts.quality,
152154
docker: false,
153-
gpu: false,
155+
gpu: opts.useGpu === true,
154156
source: "studio",
155157
outputFormat: opts.format,
156158
outputResolutionPreset: opts.outputResolution,

‎packages/cli/src/server/studioServer.renderBrowser.test.ts‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ afterEach(() => {
4343
for (const dir of dirs.splice(0)) rmSync(dir, { recursive: true, force: true });
4444
});
4545

46-
function startStudioRender() {
46+
function startStudioRender(extra: Record<string, unknown> = {}) {
4747
const dir = mkdtempSync(join(tmpdir(), "hf-studio-render-browser-"));
4848
dirs.push(dir);
4949
server = createStudioServer({ projectDir: dir });
@@ -54,6 +54,7 @@ function startStudioRender() {
5454
fps: { num: 30, den: 1 },
5555
quality: "draft",
5656
jobId: "job",
57+
...extra,
5758
} as never);
5859
}
5960

@@ -86,3 +87,19 @@ describe("Studio render browser resolution", () => {
8687
expect(process.env.PRODUCER_HEADLESS_SHELL_PATH).toBe("/opt/chrome");
8788
});
8889
});
90+
91+
describe("Studio render GPU encoding", () => {
92+
it("creates the job with useGpu when the request asks for GPU encoding", async () => {
93+
mocks.resolveRenderBrowser.mockResolvedValue({
94+
executablePath: "/opt/chrome",
95+
source: "cache",
96+
});
97+
98+
startStudioRender({ useGpu: true });
99+
await vi.waitFor(() => expect(mocks.createRenderJob).toHaveBeenCalledTimes(1), {
100+
timeout: 10_000,
101+
});
102+
103+
expect(mocks.createRenderJob).toHaveBeenCalledWith(expect.objectContaining({ useGpu: true }));
104+
});
105+
});

‎packages/cli/src/server/studioServer.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,7 @@ export function createStudioServer(options: StudioServerOptions): StudioServer {
627627
...(manualEditsRenderScript ? { renderBodyScripts: [manualEditsRenderScript] } : {}),
628628
...(opts.composition ? { entryFile: opts.composition } : {}),
629629
...(opts.variables ? { variables: opts.variables } : {}),
630+
...(opts.useGpu ? { useGpu: true } : {}),
630631
});
631632
renderJob = job;
632633
const onProgress = (j: { progress: number; currentStage?: string }) => {

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -826,6 +826,41 @@ describe("POST /projects/:id/render — variables forwarding", () => {
826826
});
827827
});
828828

829+
describe("POST /projects/:id/render — GPU encoding", () => {
830+
it("passes gpu: true on an MP4 export to the adapter as useGpu, and anything else as off", async () => {
831+
const spy = vi.fn();
832+
const { app, cleanup } = buildApp(spy);
833+
try {
834+
const requests = [
835+
{ format: "mp4", gpu: true },
836+
{ format: "mp4" },
837+
{ format: "mp4", gpu: "true" },
838+
{ format: "mp4", gpu: 1 },
839+
{ format: "webm", gpu: true },
840+
{ format: "mov", gpu: true },
841+
];
842+
for (const body of requests) {
843+
const res = await app.request("http://localhost/projects/demo/render", {
844+
method: "POST",
845+
headers: { "content-type": "application/json" },
846+
body: JSON.stringify(body),
847+
});
848+
expect(res.status).toBe(200);
849+
}
850+
expect(spy.mock.calls.map(([opts]) => opts.useGpu)).toEqual([
851+
true,
852+
false,
853+
false,
854+
false,
855+
false,
856+
false,
857+
]);
858+
} finally {
859+
cleanup();
860+
}
861+
});
862+
});
863+
829864
describe("audioLoweredDb — the limiter's attenuation reaches the host", () => {
830865
async function completedJobProgress(audioLoweredDb: number | undefined): Promise<string> {
831866
const spy = vi.fn();

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ export function registerRenderRoutes(api: Hono, adapter: StudioApiAdapter): void
106106
// Composition-variable overrides ({variableId: value}), injected as
107107
// window.__hfVariables — same channel as `hyperframes render --variables`.
108108
variables?: Record<string, unknown>;
109+
gpu?: boolean;
109110
};
110111
const VALID_FORMATS = new Set(["mp4", "webm", "mov"]);
111112
const FORMAT_EXT: Record<string, string> = { mp4: ".mp4", webm: ".webm", mov: ".mov" };
@@ -162,6 +163,7 @@ export function registerRenderRoutes(api: Hono, adapter: StudioApiAdapter): void
162163
outputResolution,
163164
composition,
164165
variables,
166+
useGpu: body.gpu === true && format === "mp4",
165167
distinctId:
166168
typeof body.telemetryDistinctId === "string" ? body.telemetryDistinctId : undefined,
167169
telemetryOptOut: body.telemetryOptOut === true,

‎packages/studio-server/src/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ export interface StudioApiAdapter {
192192
* the same channel `hyperframes render --variables` uses.
193193
*/
194194
variables?: Record<string, unknown>;
195+
useGpu?: boolean;
195196
/**
196197
* Telemetry id of the browser user who triggered the render. Lets the
197198
* adapter attribute the server-emitted render_complete/render_error to

‎packages/studio/src/components/StudioLeftPanels.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ export const StudioLeftPanels = memo(function StudioLeftPanels({
7575
return;
7676
}
7777
await waitForPendingDomEditSaves();
78-
const { format, quality, fps } = getPersistedRenderSettings();
79-
await renderQueue.startRender({ composition: comp, format, quality, fps });
78+
const { format, quality, fps, gpu } = getPersistedRenderSettings();
79+
await renderQueue.startRender({ composition: comp, format, quality, fps, gpu });
8080
},
8181
[renderQueue, waitForPendingDomEditSaves],
8282
);
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
export function GpuEncodingToggle({
2+
format,
3+
checked,
4+
disabled,
5+
onToggle,
6+
}: {
7+
format: "mp4" | "webm" | "mov";
8+
checked: boolean;
9+
disabled: boolean;
10+
onToggle: () => void;
11+
}) {
12+
// GPU encoders exist for H.264/H.265 only, so only MP4 can use one.
13+
if (format !== "mp4") return null;
14+
return (
15+
<label
16+
className={`flex items-center gap-2 text-step-10 text-text-4 ${disabled ? "opacity-40 cursor-not-allowed" : "cursor-pointer"}`}
17+
>
18+
<input
19+
type="checkbox"
20+
checked={checked}
21+
disabled={disabled}
22+
onChange={onToggle}
23+
className="accent-studio-accent"
24+
/>
25+
<span>Use GPU encoding</span>
26+
</label>
27+
);
28+
}

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

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ describe("RenderQueue controls", () => {
142142
exportButtonIn(host).dispatchEvent(new MouseEvent("click", { bubbles: true }));
143143
});
144144

145-
expect(onStartRender).toHaveBeenCalledWith("mp4", "standard", "landscape-4k", 30);
145+
expect(onStartRender).toHaveBeenCalledWith("mp4", "standard", "landscape-4k", 30, false);
146146
});
147147

148148
it("refuses a resolution the composition cannot reach, and says why", async () => {
@@ -172,7 +172,23 @@ describe("RenderQueue controls", () => {
172172
exportButtonIn(host).dispatchEvent(new MouseEvent("click", { bubbles: true }));
173173
});
174174

175-
expect(onStartRender).toHaveBeenCalledWith("mp4", "standard", "auto", 30);
175+
expect(onStartRender).toHaveBeenCalledWith("mp4", "standard", "auto", 30, false);
176+
});
177+
178+
it("exports with GPU encoding once the box is ticked, and remembers it", () => {
179+
const onStartRender: Mock<StartRenderHandler> = vi.fn();
180+
const host = mountRenderQueue(onStartRender);
181+
const gpu = [...host.querySelectorAll("label")].find((label) =>
182+
label.textContent?.includes("Use GPU encoding"),
183+
);
184+
185+
act(() => gpu?.querySelector("input")?.click());
186+
act(() => {
187+
exportButtonIn(host).dispatchEvent(new MouseEvent("click", { bubbles: true }));
188+
});
189+
190+
expect(onStartRender).toHaveBeenCalledWith("mp4", "standard", "auto", 30, true);
191+
expect(getPersistedRenderSettings().gpu).toBe(true);
176192
});
177193

178194
it("persists a changed format as the literal union value", async () => {
@@ -185,7 +201,9 @@ describe("RenderQueue controls", () => {
185201
format: "mov",
186202
quality: "standard",
187203
fps: 30,
204+
gpu: false,
188205
});
206+
expect(host.textContent).not.toContain("Use GPU encoding");
189207
});
190208
});
191209

0 commit comments

Comments
 (0)