mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-15 22:08:03 +00:00
Vance IngallsandClaude Opus 4.7
d20e28a623
Three fixes from PR #822 self-review: 1. Gate the "Software GPU detected" console.warn so it only fires when the guard actually changed the outcome. Previously the warn condition (captureMode==="screenshot" && isSoftwareRenderer && headlessShell && isLinux) was satisfied even when the caller had explicitly set forceScreenshot=true — misleading operators into thinking the guard kicked in when they had already picked screenshot mode. Add `!forceScreenshot` to the condition and one-shot the warn with a process-level latch to avoid spam across multi-worker renders. 2. Thread the already-resolved browserGpuMode from frameCapture.ts into acquireBrowser via a new AcquireBrowserOptions.resolvedBrowserGpuMode. The Promise cache made the duplicate resolution cheap, but threading the value removes the smell of two parallel resolutions of the same thing with no static guarantee they agree under future refactors. 3. Add fallback-launch-retry test: simulate probeBeginFrameSupport failure via a CDP mock whose `send` rejects, assert the second launch strips beginframe-only flags. Also add positive-control tests for "Linux + hardware + headless-shell does NOT warn" and "forceScreenshot suppresses the software-GPU warn". Co-Authored-By: Claude Opus 4.7 (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,
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