mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-01 19:42:03 +00:00
Via
97e094621f
Field signals ts=1784049136 (hardware-GPU intermittent black rectangles → resolved with --no-browser-gpu --low-memory-mode --workers 1) and ts=1784032286 (clip-path animated image → intermittent black rectangles → resolved with deterministic precompose). Pattern: hardware-GPU writes solid-black on some composition shapes; software-GPU / screenshot bypass restores correctness. Raw per-pixel diff alone false-positives on every compositor jitter frame; the diagnostic-grade signal is asymmetric black-only-in-A pixels (solid-black where B has content). Adds `packages/engine/src/utils/gpuParityDiff.ts`: pure helpers (`diffGpuParityFrames`, `diffGpuParityPngs`, `verifyGpuParity`) that compare two RGBA frames captured via different GPU paths, count per-pixel diffs above a tolerance, and isolate black-only-in-A / black-only-in-B pixel counts + bounding boxes. Symmetric black regions (real black content present in both captures) are NOT flagged. PNG wrapper preserves the underlying decode error as Error.cause on either side. All exposed via `@hyperframes/engine`'s package index for downstream wiring. 19 unit tests cover identity, per-pixel tolerance, the field-bug shape, the shared-black no-op case, bounding-box tightness across multiple regions, the inverse pattern, dimension mismatch, data-length mismatch, overlapping threshold rejection, custom tolerance, verdict output, PNG end-to-end, and cause-preservation on both A and B decode failures. Reduced-scope first pass. Wiring a `hyperframes verify-gpu-parity` CLI command, dual-mode capture orchestration, and integration coverage against a known-bad composition is intentionally deferred to a follow-up so the diagnostic primitive can land and be exercised in isolation. The exported surface is stable — a follow-up need only add the capture-and-diff driver. Stack: PR #7 of 9 (base via/parallel-capture-observability). Signed-off-by: Via
@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