mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 09:16:55 +00:00
Miguel Ángel
9e5da67409
* fix(cli): a Chrome that fails to start says how it ended, and a slow start says so A failed launch only reported "Protocol error (Target.setDiscoverTargets): Target closed". It now runs the browser once more on its own with the same flags and reports its exit code (Windows codes named: missing runtime, out of memory, security software), its last stderr lines, or that it stayed up. The CLI and the engine's render launch both use it. A start slower than 5 s prints "Chrome is still starting...", and a --timeout that looks like seconds says it is milliseconds. * chore(cli): cut the Chrome launch diagnosis comments to the comment limit * fix(cli): the Chrome startup check runs Chrome as puppeteer does and can be cancelled The check started the browser with only the caller's flags, so a full Chrome ran headful and was blamed for a missing X server. It now uses puppeteer's default arguments (headless included). The check is stopped when the CLI is stopped, and the GPU probe, whose failure falls back to software anyway, skips it. * fix(cli): a Chrome launch error is never replaced by a failure to explain it The startup diagnosis asks puppeteer for its default arguments before re-running Chrome. If that call fails, its error used to replace the launch error the caller needed. The launch error is now reported as it was. The core package size budget rises to cover the new chromeStartup module (about 4.7 KB unpacked). * refactor(engine): the Chrome startup diagnosis lives in the engine, not core Both callers launch Chrome through the engine (the CLI already imports it), so the engine owns the diagnosis. Core's package size budget is back to its old value.
@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