mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
Vance Ingalls
ddfbb80043
Replaces per-frame Page.captureScreenshot in the HDR / shader-transition layered composite path with HeadlessExperimental.beginFrame, and flips optimizeForSpeed from false to true on the PNG-alpha encoder paths. Both flips were gated on stale Chrome behavior that no longer reproduces on 146+. Measured impact (854x480, p50, 100-frame samples on chrome-headless-shell 148.0.7778.97): - Page.captureScreenshot + PNG + optimizeForSpeed:false: 49.21 ms (current) - beginFrame + PNG + optimizeForSpeed:true: 9.04 ms (this PR) - Speedup per frame: 5.4x at 854x480; 3.2x at 1920x1080. Projected fixture impact (hf#677 validation): - domScreenshotMs: 67-69s -> ~12-14s (recover ~55s wall) - total wall: 99s -> ~44s - cumulative on 220s baseline: ~2.22x -> ~5x Output equivalence verified (see PR body for full test matrix): - 0/409,920 pixels differ vs current path on real fixture + 6 synthetic fixture-style scenes + AA text + 10-90% alpha overlays + HDR/wide-gamut (display-p3, rec2020) + resolutions through 4K. - PNG bytes are determinism-stable across 5 back-to-back captures. - File-size delta is a DEFLATE-effort artifact (optimizeForSpeed:true produces less-compressed but pixel-identical output). The HDR layered path now selects beginframe vs screenshot capture per session.captureMode -- the alpha-output-format codepath (webm/mov/png- sequence) still routes through Page.captureScreenshot until the engine's main capture loop is migrated to beginFrame alpha too. Stale comments at screenshotService.ts replaced with a citation to page_handler.cc -- both PNG encoder paths call EncodeBGRASkBitmap with discard_transparency=false; the fast/slow distinction is compression- effort only. Drive-by extraction: moved injectVideoFramesBatch / syncVideoFrameVisibility into a new videoFrameOverlay.ts. These Hyperframes-specific video-to-img overlay helpers were the largest non-screenshot block in screenshotService.ts. The move brings the file under the 500-line ceiling enforced by lefthook filesize. The barrel export in engine/src/index.ts keeps the public API unchanged. Added a regression fixture (screenshotService.test.ts) pinning optimizeForSpeed:true on every PNG capture path, the new function's CDP call shape, monotonic-tick semantics, alpha-cache replay on hasDamage=false, and isolation from the opaque beginFrameCapture cache. -- Vai
@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