mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-01 19:42:03 +00:00
Miguel Ángel
e5346afdd8
* fix(engine): use ANGLE-EGL for Linux GPU path, bump NVENC probe size Chrome 131+ rejects --use-gl=egl in headless shell; the GPU process exits and the renderer silently falls back to SwiftShader. Switch to (gl=angle, angle=gl-egl) which is on the headless-shell allowlist, and add --ignore-gpu-blocklist + --disable-software-rasterizer so data-center GPUs (L4/T4/A10) are not blocked. Also bump the NVENC probe frame from 16×16 to 320×240 — NVIDIA data-center cards require ≥257 on each dimension and reject the smaller size with "Frame Dimension less than the minimum supported value", causing the encoder probe to silently fall back to libx264. Closes #1493 * fix(engine): address review feedback — probe test, observability, comments - Export getProbeArgs and add test pinning 320×240 probe dimensions across all 5 GPU encoder backends (nvenc/videotoolbox/vaapi/qsv/amf) - Add driver/SKU rationale comment on the probe size constant with context about NVIDIA data-center card behavior vs documented minimums - Add rationale comment on --ignore-gpu-blocklist (operator opted into hardware mode explicitly) - Log resolved GL flags at browser launch for GPU fallback observability
@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,
releaseBrowser,
createCaptureSession,
initializeSession,
captureFrame,
closeCaptureSession,
} from "@hyperframes/engine";
// 1. Launch browser
const browser = await acquireBrowser({ captureMode: "beginFrame" });
// 2. Open a capture session
const session = createCaptureSession({
browser: browser.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 releaseBrowser(browser);
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