mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 12:54:29 +00:00
Via
58cff5f6d5
Field signal ts=1784146416 (darwin/arm64, CLI 0.7.58, 7/10): host page.goto hit Navigation timeout of 60000ms twice on a CSS 3D + audio composition; Docker rendered the same composition successfully. Puppeteer's stock "Navigation timeout of 60000 ms exceeded" text names none of HyperFrames' existing escape hatches, so the reporter had no signal that the failure had knobs. Wraps main-render Puppeteer `page.goto` errors matching /Navigation timeout|net::ERR_TIMED_OUT/i with an augmented message that names: - The effective timeout currently applied (`cfg.pageNavigationTimeout`). - Raise-the-timeout: `PRODUCER_PAGE_NAVIGATION_TIMEOUT_MS` env, `--browser-timeout` CLI flag (seconds). - Browser-binary escape hatch: `HYPERFRAMES_BROWSER_PATH` env. - Field-signal shape: darwin/arm64 + CSS 3D + audio compound Docker hint — gated on all three inputs being explicitly true; falls back to generic hints when any input is unknown. Mirrors #2443's HYPERFRAMES_BROWSER_PATH surfacing pattern (which covered download-time failures) at the runtime `page.goto` layer. Non-matching errors flow through unchanged. Original error preserved via `err.cause`. Wired into `renderOrchestrator.executeRenderJob`'s top-level catch, composed after `augmentProtocolTimeoutError` so the two augmenters never both fire on the same error (mutually exclusive regexes). Current wire-up passes no `hasCss3D` / `hasAudio` context — no compile-time CSS-3D signal is threaded through the render pipeline, and `hasAudio` is block-scoped inside the try. Per the helper's fallback docs, unknown flags route to the generic env + browser-path hints. A future compile-time CSS-3D scan can thread both flags to enable the full compound Docker hint without touching this helper's signature. Stack: PR #3 of 9 (base via/win32-streaming-encode-autodisable). Signed-off-by: Via <vance@heygen.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,
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