Files
hyperframes/packages/engine
Miguel Ángel b54e4981f2 fix(engine): keep media ids that differ only by case in separate folders (#7635)
* fix(engine): keep media ids that differ only by case in separate folders

macOS and Windows disks ignore case, and APFS ignores Unicode normalization,
but mediaIdPathSegment passed plain ids through as written. Two clips such as
`s12-vB1` and `s12-vb1` therefore shared one `__hyperframes_video_frames`
folder: whichever was staged first kept it, and the other clip read its
frames. A longer clip then failed mid-render with ENOENT on a frame past the
shorter clip's end; a same-length pair rendered the wrong footage silently.

Only a lowercase, NFC-normalized id now maps to itself. Any other spelling
gets the existing readable~digest form, so every per-id path (frame folders,
the tail probe, audio work files, distributed plans) stays distinct on a
case-insensitive disk.

* fix(engine): name the case-folding check instead of commenting it

Keeps mediaPathSegment.ts at or under its comment share at the merge base.
2026-11-13 03:09:18 +00:00
..
2026-11-12 21:52:46 +00: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