mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
Vance Ingalls
6c788b8706
hf#732 PR 4 of 5. Delivers the bulk of the 2.22x shader-transition speedup by spreading per-frame DOM capture work across N DOM worker sessions and offloading the per-pixel shader-blend onto a `worker_threads` pool (the pool added in PR 3). The hybrid path is gated by `shouldUseHybridLayeredPath`: * SDR content only (HDR raw-frame sources are fd-bound to one worker; per-worker `dup(fd)` is out of scope here). * workerCount >= 2. * Not every frame inside a transition window (parallel workers buy nothing for all-transition compositions). When the gate trips, the hybrid loop spawns `workerCount - 1` extra DOM sessions in addition to the existing `domSession`, allocates per- worker scratch buffers, and partitions the frame range into contiguous slices via `distributeLayeredHybridFrameRanges`. Each worker walks its slice; the shader-blend at the tail of each transition frame is dispatched to the worker pool (with inline fallback when the pool spawn fails). `createFrameReorderBuffer` fences the encoder so out-of- order worker completions hit the muxer in ascending frame-index order. Pool teardown is guaranteed via try/finally on both the success and error paths. The DOM worker sessions and the shader-blend pool both close even when the inner loop throws. Structural change (necessary for the perf change): `captureHdrStage.ts` was 921 lines on main, the inner per-frame loop was 250+ lines, and the file already exceeded the project's 500-line ceiling. Adding the hybrid path on top would push it past 1100 lines and the local pre-commit hook refuses to stage files past 500. Splitting `captureHdrStage.ts` into: * `captureHdrStage.ts` (orchestrator + cleanup invariants) * `captureHdrResources.ts` (HDR video extraction + image decode + dim probing) * `captureHdrFrameShared.ts` (gating predicates, partitioning, per-scene capture primitives shared by both loops) * `captureHdrSequentialLoop.ts` (legacy single-session loop) * `captureHdrHybridLoop.ts` (new multi-worker SDR path) is the simplest way to land the perf change while honoring the project's file-size rule. No behavior change in any pre-existing code path: the sequential loop is byte-equivalent to the previous inline implementation (both consume `captureSceneIntoBuffer` from the shared module, so behavior parity is enforced structurally). `renderOrchestrator.ts` is unchanged. The stage computes its own worker budget via `calculateOptimalWorkers` rather than receiving it through the call signature. Tests: * `captureHdrFrameShared.test.ts` -- 14 vitest tests pinning the hybrid gating predicate (SDR/HDR, all-transition edge, worker budget) and the contiguous-chunking partitioner. All pass. * Producer typecheck clean; oxlint clean. PR 4 of 5 in the hf#732 decomposition stack; stacked on top of PR 3 (shaderTransitionWorkerPool). -- Vai Co-Authored-By: Vai <vai@heygen.com>
hyperframes
CLI for creating, previewing, and rendering HTML video compositions.
Install
npm install -g hyperframes
Or use directly with npx:
npx hyperframes <command>
Requirements: Node.js >= 22, FFmpeg
Commands
init
Scaffold a new Hyperframes project from a template:
npx hyperframes init my-video
cd my-video
preview
Start the live preview studio in your browser:
npx hyperframes preview
# Studio running at http://localhost:3002
npx hyperframes preview --port 4567
render
Render a composition to MP4:
npx hyperframes render ./my-composition.html -o output.mp4
lint
Validate your Hyperframes HTML:
npx hyperframes lint ./my-composition
npx hyperframes lint ./my-composition --json # JSON output for CI/tooling
npx hyperframes lint ./my-composition --verbose # Include info-level findings
By default only errors and warnings are shown. Use --verbose to also display informational findings (e.g., external script dependency notices). Use --json for machine-readable output with errorCount, warningCount, infoCount, and a findings array.
compositions
List compositions found in the current project:
npx hyperframes compositions
benchmark
Run rendering benchmarks:
npx hyperframes benchmark ./my-composition.html
doctor
Check your environment for required dependencies (Chrome, FFmpeg, Node.js):
npx hyperframes doctor
browser
Manage the bundled Chrome/Chromium installation:
npx hyperframes browser
info
Print version and environment info:
npx hyperframes info
docs
Open the documentation in your browser:
npx hyperframes docs
upgrade
Check for updates and show upgrade instructions:
npx hyperframes upgrade
npx hyperframes upgrade --check --json # machine-readable for agents
Documentation
Full documentation: hyperframes.heygen.com/packages/cli
Related packages
@hyperframes/core— types, parsers, frame adapters@hyperframes/engine— rendering engine@hyperframes/producer— render pipeline@hyperframes/studio— composition editor UI