Files
hyperframes/packages/engine
Vance IngallsandClaude Sonnet 5 12f3626fd8 fix(engine): hard-fail processCompositionAudio on VST chain errors
A missing VST plugin or chain file was caught by the per-element try/catch
shared with every soft-degrading failure mode (missing source asset,
download failure, etc): the track was silently dropped and MixResult.success
stayed true, so a render with a missing plugin completed successfully with
no visible error anywhere.

Introduce VstChainProcessingError to mark VST-specific failures and let the
per-element catch rethrow it instead of swallowing it into the warnings
list. The rethrow escapes the Promise.all and rejects
processCompositionAudio itself, which (traced through audioStage.ts's
uncaught await and observability.ts's observeRenderStage, which rethrows)
surfaces as a real render failure through the CLI's existing error-handling
path — the same one every other hard pipeline failure already uses. Every
non-VST failure mode is untouched.

Fixed the two "hard-fails" tests to assert the promise actually rejects
(rejects.toThrow) instead of only checking tracksProcessed/error on an
still-resolved, still-successful result — the previous assertions would
have passed even with the bug present.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-16 18:49:17 -07:00
..
2026-03-21 22:43:56 -07:00

@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,
  createCaptureSession,
  initializeSession,
  captureFrame,
  closeCaptureSession,
} from "@hyperframes/engine";

// 1. Launch browser
const browserLease = await acquireBrowser({ captureMode: "beginFrame" });

// 2. Open a capture session
const session = createCaptureSession({
  browser: browserLease.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 browserLease.release();

Most users should use @hyperframes/producer or the hyperframes CLI instead of calling the engine directly.

Documentation

Full documentation: hyperframes.heygen.com/packages/engine