mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
James
dff2971577
Every render from the published `hyperframes` CLI stamped `hyperframes_version=0.0.0-dev`. `readEngineVersion` resolved `../../package.json` relative to `import.meta.url`. That depth is right for `src/utils/` and for the published engine's `dist/utils/`, but the CLI bundles the engine flat into `dist/cli.js` (tsup `noExternal`), one level below the package root. There `../..` overshoots to `node_modules/package.json`, throws MODULE_NOT_FOUND, and hits the never-break-a-render fallback. Walk up to the nearest `package.json` instead, so the lookup no longer depends on how deep the file is bundled. Only a HyperFrames package is accepted: if the engine is bundled into someone else's package, reporting their version under a `hyperframes_version` key is worse than admitting we don't know. Verified against the real published artifact — `npm pack hyperframes@0.8.29`, whose `dist/cli.js` reproduces the fallback, and which resolves 0.8.29 under this change. Also checked at the source layout, the built engine's `dist/utils/`, and a tsup-equivalent flat bundle. The existing suite could not have caught this: every version assertion compares PROVENANCE_VERSION against itself, so all of them pass just as happily when it is the fallback sentinel. The new tests pin the bundled depth-1 layout and assert the stamped version is the real one. Co-Authored-By: Claude Opus 5 (1M context) <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