mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-14 13:27:13 +00:00
snapshot: fix two shader pre-render wait failure modes - Cold cache: overlay stays in DOM as display:none after hiding, element-absence check never resolved, always timed out at 60s - Warm cache: IndexedDB hydration runs without overlay, absence check resolved instantly while prewarming was still in progress - Fix: primary signal is window.__hf.shaderTransitions[].ready; overlay display:none is fallback for older builds - Verified: huly-promo snapshots show composition content, not loader shader-transitions: optional shader field for CSS crossfade mixing - TransitionConfig.shader is now optional (ShaderName | undefined) - Omitting shader = smooth CSS opacity crossfade via fallback path - CSS-only transitions skip program compilation and prewarming - HfTransitionMeta.shader made optional in engine/src/types.ts - Verified: mixed CSS + WebGL composition renders all three beats correctly step-3-storyboard: SFX assigned here with exact files, not in Step 5 - Agent reads sfx/manifest.json and assigns exact filenames per moment - Less-is-more: most beats need zero SFX, one max per beat - Removed duplicate HTML-in-Canvas API detail (build concern, not storyboard) step-5-build: implement storyboard SFX exactly, zero creative decisions step-4-vo: required timing reconciliation gate before Step 5 - Compare real audio vs planned total; if delta >15% rescale or trim - Hard cap on CTA hold: 2-3s after last word, not extended dead silence
@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