mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 07:50:13 +00:00
* fix(engine): restricted downloads use the capture proxy's address rule With PRODUCER_RESTRICT_PAGE_NETWORK on, remote asset downloads now go through the same transport and host check as the render page's capture proxy: - An IPv6 literal host, or a name the capture proxy refuses, is not permitted, on the first request and on every redirect hop. - Names resolve to IPv4 answers only, every answer must be public, and the download dials the checked address. A name with only IPv6 answers does not download, as in the capture proxy. - Proxy variables (HTTPS_PROXY, NO_PROXY) are not used in this mode, so no host is dialled without the address check. HYPERFRAMES_CAPTURE_PROXY still routes downloads, as it does for the page. With the setting off, downloads keep the existing transport. * fix(engine): restricted downloads keep undici's transport with the capture resolver The capture transport refuses any compressed response and sends no User-Agent, and its socket and parse errors were not retried. Restricted downloads now use the same undici agent as before, with a connect lookup that calls the capture proxy's resolvePublicAddress: IPv4 answers only, every answer public, and the checked address is the one dialled. This keeps the old request headers (User-Agent, Accept: */*), gzip, br and deflate unpacking for text fetches under the existing byte cap, the asset path's refusal of compressed bodies, "fetch failed" retry handling, and connection reuse. Non-public destinations stay non-retryable refusals.
@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