mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 09:16:55 +00:00
Tooling and logs need more than "off". Give the runtime's report a reason code for every way blur can be off (renderer-off, unsupported-browser, each html-in-canvas defect, capture-failures), and two calls for tooling: probe() runs the same scan a render would, without painting, and suspend() stops all painting for the rest of a session without changing the reported decision. The engine prints one line per session from what the page reports: `[motion-blur] on reasonCode=null movers=N failedFrames=K`. The first-frame line cannot know about later failures, so the session end prints the same line with "(session end)" when any frame fell back to plain DOM; a clean session stays quiet. A render where every capture failed no longer reads as "on" with nothing else. Add the first test that reads blurred pixels: real Chrome with html-in-canvas, the engine's frame order (seek, wait, composite, screenshot). It checks the trail along the motion line, that what does not move matches the sharp frame, that a box centered with translate is blurred where it really is, and that a flipped backface card renders the plain frame. It skips when Chrome or html-in-canvas is missing. Folded review fixes: R13 (runtime half), R17 (engine half), T1 (the guards that need reason codes), T3 (log-line and pixel tests). Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.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