mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-17 15:24:19 +00:00
feat(cli,producer): add gif output format with two-pass palette encode (#1333)
Co-authored-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
This commit is contained in:
co-authored by
Matt Van Horn
parent
e0ecd4d2d1
commit
e6b8d66c2d
+2
-1
@@ -112,8 +112,9 @@ This is the same pipeline that handles compositions where, for example, an HDR d
|
||||
| `mp4` | Yes — H.265 10-bit BT.2020, HDR10 metadata |
|
||||
| `mov` | No — falls back to SDR |
|
||||
| `webm` | No — falls back to SDR |
|
||||
| `gif` | No — falls back to SDR |
|
||||
|
||||
If HDR is enabled and you also pass `--format mov` or `--format webm`, Hyperframes logs a message and produces the equivalent SDR render. There is no error — the render still completes — so check the logs (or your verification step) to confirm you got HDR.
|
||||
If HDR is enabled and you also pass `--format mov`, `--format webm`, or `--format gif`, Hyperframes logs a message and produces the equivalent SDR render. There is no error — the render still completes — so check the logs (or your verification step) to confirm you got HDR.
|
||||
|
||||
## Verifying HDR Output
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
title: Rendering
|
||||
description: "Render compositions to MP4, MOV, or WebM locally or in Docker."
|
||||
description: "Render compositions to MP4, MOV, WebM, GIF, or PNG sequences locally or in Docker."
|
||||
---
|
||||
|
||||
Render your Hyperframes [compositions](/concepts/compositions) to MP4, MOV, or WebM with the [CLI](/packages/cli). The rendering pipeline is frame-by-frame and seek-driven — see [Deterministic Rendering](/concepts/determinism) for how this works under the hood.
|
||||
Render your Hyperframes [compositions](/concepts/compositions) to MP4, MOV, WebM, GIF, or PNG sequences with the [CLI](/packages/cli). The rendering pipeline is frame-by-frame and seek-driven — see [Deterministic Rendering](/concepts/determinism) for how this works under the hood.
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -116,8 +116,9 @@ Render your Hyperframes [compositions](/concepts/compositions) to MP4, MOV, or W
|
||||
| Flag | Values | Default | Description |
|
||||
|------|--------|---------|-------------|
|
||||
| `--output` | path | `renders/<name>.mp4` | Output file path |
|
||||
| `--format` | mp4, mov, webm, png-sequence | mp4 | Output format (see [Transparent Video](#transparent-video) below) |
|
||||
| `--format` | mp4, mov, webm, gif, png-sequence | mp4 | Output format (see [Transparent Video](#transparent-video) below) |
|
||||
| `--fps` | 24, 30, 60 | 30 | Frames per second |
|
||||
| `--gif-loop` | 0-65535 | 0 | GIF loop count. `0` loops forever |
|
||||
| `--quality` | draft, standard, high | standard | Encoding quality preset |
|
||||
| `--crf` | 0–51 | — | Override CRF (lower = higher quality). Cannot combine with `--video-bitrate` |
|
||||
| `--video-bitrate` | e.g. `10M`, `5000k` | — | Target bitrate encoding. Cannot combine with `--crf` |
|
||||
@@ -152,6 +153,18 @@ npx hyperframes render --video-bitrate 10M --output controlled.mp4
|
||||
|
||||
**Tip**: The default `standard` preset (CRF 18) is visually lossless at 1080p — most people cannot distinguish it from the source. Use `--quality draft` for faster iteration, or `--quality high` / `--crf 10` when file size is no concern.
|
||||
|
||||
## Animated GIF
|
||||
|
||||
Use GIF when the output needs to autoplay inline in GitHub PRs, READMEs, issue reports, and docs pages:
|
||||
|
||||
```bash Terminal
|
||||
npx hyperframes render --format gif --fps 15 --gif-loop 0 --output demo.gif
|
||||
```
|
||||
|
||||
GIF output uses a two-pass FFmpeg palette encode (`palettegen` with diff statistics, then `paletteuse` with Sierra dithering) for better gradients and text edges than a single-pass conversion. GIFs are still much larger than MP4/WebM at the same dimensions, so prefer `--fps 15` and short compositions. Hyperframes caps GIF renders at 30fps.
|
||||
|
||||
GIF does not carry audio and only has 1-bit transparency. For transparent overlays, use `--format webm`, `--format mov`, or `--format png-sequence` instead.
|
||||
|
||||
## GPU Acceleration
|
||||
|
||||
Hyperframes has two separate GPU acceleration surfaces:
|
||||
|
||||
Reference in New Issue
Block a user