mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 17:27:09 +00:00
Miguel ÁngelandKenneth Shortrede
3a64ea867c
* fix(engine): forced-SDR renders show tone-mapped HDR footage as Studio does Forced-SDR extraction tone-maps HDR frames with zscale, but the frames kept the BT.709 transfer tag, so Chrome re-curved them (a tone-mapped 388d96 painted as 2d8790), and JPEG frames kept the BT.709 matrix every JPEG reader decodes as BT.601. Tone-mapped frames now get the same sRGB tag and BT.601 JPEG conversion as other SDR frames. macOS used VideoToolbox, which does not tone-map: its frames stay PQ and Chrome tone-maps them itself, darker than the hable curve Linux and Studio use. macOS now takes the zscale path whenever ffmpeg has zscale, found through the shared ffmpeg filter probe; without it the old path stays and the render warns once. Co-authored-by: Kenneth Shortrede <95665480+sontiac@users.noreply.github.com> * fix(engine): forced-SDR renders tone-map HDR footage that lacks matrix or primaries tags zscale finds no path between colourspaces without them, so the extraction failed. Untagged HDR footage is BT.2020 in practice, and now gets those tags. Co-authored-by: Kenneth Shortrede <95665480+sontiac@users.noreply.github.com> * fix(engine): forced-SDR tone map also tags the transfer ffprobe read from the container From ffmpeg 8.1 ffprobe reports a container-only PQ or HLG tag; the frames still lack it, so zscale failed where macOS VideoToolbox used to render. Co-authored-by: Kenneth Shortrede <95665480+sontiac@users.noreply.github.com> * test(engine): gate the container-only transfer case on the ffprobe that reads it * docs(engine): shorten the filter-probe comment to the comment limit * fix(engine): keep valid per-frame colour tags when tone-mapping HDR footage * test(engine): build the mixed HLG and PQ fixture without B-frames so its timestamps are valid * test(engine): build the trimmed mixed fixture without B-frames too --------- Co-authored-by: Kenneth Shortrede <95665480+sontiac@users.noreply.github.com>
@hyperframes/engine
Seekable web-page-to-video rendering engine built on Puppeteer and FFmpeg.
Framework-agnostic: works with GSAP, Lottie, Three.js, CSS animations, or any web content that implements the window.__hf seek protocol.
Install
npm install @hyperframes/engine
Requirements: Node.js >= 22, Chrome/Chromium (auto-downloaded by Puppeteer), FFmpeg
What it does
The engine opens your HTML composition in a headless Chrome instance, seeks frame-by-frame using Chrome's HeadlessExperimental.beginFrame API, captures screenshots, and encodes them into video with FFmpeg.
Key services
| Service | Description |
|---|---|
| browserManager | Launches and pools headless Chrome instances (chrome-headless-shell) |
| frameCapture | Manages capture sessions — seek, screenshot, buffer lifecycle |
| screenshotService | BeginFrame-based capture with CDP (Chrome DevTools Protocol) |
| chunkEncoder | FFmpeg encoding with chunked concat, GPU detection, faststart |
| streamingEncoder | Pipe frames to FFmpeg in real time (no intermediate PNGs on disk) |
| audioMixer | Parse <audio> elements and mix audio tracks via FFmpeg |
| videoFrameExtractor | Extract frames from <video> elements for compositing |
| parallelCoordinator | Split frame ranges across worker processes |
| fileServer | Serve local HTML files to the browser via Hono |
Usage
import {
acquireBrowser,
createCaptureSession,
initializeSession,
captureFrame,
closeCaptureSession,
} from "@hyperframes/engine";
// 1. Launch browser
const browserLease = await acquireBrowser({ captureMode: "beginFrame" });
// 2. Open a capture session
const session = createCaptureSession({
browser: browserLease.browser,
url: "http://localhost:3000/my-composition.html",
width: 1920,
height: 1080,
fps: 30,
});
await initializeSession(session);
// 3. Capture frames
for (let i = 0; i < totalFrames; i++) {
await captureFrame(session, i, `/tmp/frames/frame-${i}.png`);
}
// 4. Clean up
await closeCaptureSession(session);
await browserLease.release();
Most users should use @hyperframes/producer or the hyperframes CLI instead of calling the engine directly.
Documentation
Full documentation: hyperframes.heygen.com/packages/engine
Related packages
@hyperframes/core— types, parsers, frame adapters@hyperframes/producer— high-level render pipeline built on this enginehyperframes— CLI