https://github.com/yeautyye/ez-ffmpeg
A safe and ergonomic Rust interface for FFmpeg integration, designed for ease of use.
https://github.com/yeautyye/ez-ffmpeg
audio cross-platform easy example ffmpeg flv integration media opengl rtmp rust safe tutorial video
Last synced: 3 days ago
JSON representation
A safe and ergonomic Rust interface for FFmpeg integration, designed for ease of use.
- Host: GitHub
- URL: https://github.com/yeautyye/ez-ffmpeg
- Owner: YeautyYE
- License: apache-2.0
- Created: 2025-03-05T09:55:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-07-04T17:53:12.000Z (3 days ago)
- Last Synced: 2026-07-04T18:11:16.676Z (3 days ago)
- Topics: audio, cross-platform, easy, example, ffmpeg, flv, integration, media, opengl, rtmp, rust, safe, tutorial, video
- Language: Rust
- Homepage:
- Size: 1.48 MB
- Stars: 338
- Watchers: 7
- Forks: 32
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
[](https://crates.io/crates/ez-ffmpeg)
[](https://docs.rs/ez-ffmpeg)
[](https://github.com/YeautyYE/ez-ffmpeg/blob/main/LICENSE-APACHE)
[](https://www.rust-lang.org/)
[](https://ffmpeg.org)
## Overview
**`ez-ffmpeg`** provides a **safe and ergonomic Rust interface for FFmpeg integration**, offering a familiar API that closely follows FFmpeg’s original logic and parameter structures.
This library:
- Exposes a safe public API; the internal FFmpeg FFI layer uses audited `unsafe` code
- Keeps the execution logic and parameter conventions as close to FFmpeg as possible
- Provides an intuitive and user-friendly API for media processing
- Supports custom Rust filters and flexible input/output handling
- Offers optional GPU-accelerated custom filters (wgpu) and a high-performance embedded RTMP server
- Ships one-shot recipes (thumbnails/sprite sheets, animated GIF, HLS ABR ladders) and a detection/measurement API (black/silence/scene/crop/EBU R128 loudness) that returns typed Rust results instead of only FFmpeg logs
By abstracting the complexity of the raw C API, `ez-ffmpeg` simplifies configuring media pipelines, performing transcoding and filtering, and inspecting media streams.
The transcoding pipeline is ported from the FFmpeg CLI sources (`fftools/ffmpeg`, FFmpeg 7.x): the demux/decode/filter/encode/mux stages keep the fftools function names and semantics, and code comments cite the corresponding C file and line (line numbers refer to the FFmpeg `n7.1` tag). FFmpeg developers can navigate the codebase by grepping for the names they already know (`ts_fixup`, `video_sync_process`, `enc_open`, `mux_fixup_ts`, ...).
Not every CLI feature is implemented. Notable gaps (unsupported paths fail with explicit errors): progress/stats reporting (`-progress`), sub2video, `-shortest` cross-stream sync, bitstream filters (`-bsf`), keyframe forcing (`-force_key_frames`), `-fix_sub_duration`, two-pass encoding, and attachments.
## Version Requirements
- **Rust:** Version 1.80.0 or higher.
- **FFmpeg:** Version 7.0 or higher.
## Documentation
More information about this crate can be found in the [crate documentation](https://docs.rs/ez-ffmpeg).
## Quick Start
### Installation Prerequisites
#### macOS
```bash
brew install ffmpeg
```
#### Windows
```bash
# For dynamic linking
vcpkg install ffmpeg
# For static linking (requires 'static' feature)
vcpkg install ffmpeg:x64-windows-static-md
# Set VCPKG_ROOT environment variable
```
### Adding the Dependency
Add **ez-ffmpeg** to your project by including it in your `Cargo.toml`:
```toml
[dependencies]
ez-ffmpeg = "*"
```
### Basic Usage
Below is a basic example to get you started. Create or update your `main.rs` with the following code:
```rust
use ez_ffmpeg::FfmpegContext;
use ez_ffmpeg::FfmpegScheduler;
fn main() -> Result<(), Box> {
// 1. Build the FFmpeg context
let context = FfmpegContext::builder()
.input("input.mp4")
.filter_desc("hue=s=0") // Example filter: desaturate (optional)
.output("output.mov")
.build()?;
// 2. Run it via FfmpegScheduler (synchronous mode)
let result = FfmpegScheduler::new(context)
.start()?
.wait();
result?; // Propagate any errors that occur
Ok(())
}
```
More examples can be found [here][examples].
[examples]: https://github.com/YeautyYE/ez-ffmpeg/tree/master/examples
## Features
**ez-ffmpeg** offers several optional features that can be enabled in your `Cargo.toml` as needed:
- **wgpu:** GPU-accelerated custom video filters written in WGSL, running headless over Vulkan/Metal/DX12/GL — YUV↔RGB conversion on the GPU with the correct color matrix, GPU work overlapped with CPU work while preserving output order, and experimental zero-copy hardware-frame input (Linux/Vulkan). Successor to the deprecated `opengl` feature.
- **opengl:** *(deprecated, superseded by `wgpu`)* GPU-accelerated OpenGL filters. Requires a display connection and converts colors on the CPU; kept functional for existing users — see the `opengl` module docs for migration.
- **rtmp:** High-performance embedded RTMP server with native epoll/kqueue, O(1) GOP sharing, and 10,000+ concurrent connections on Linux/macOS (8,000 on Windows). In-process ingest with no TCP between FFmpeg and server.
- **subtitle:** Native ASS/SRT subtitle burn-in rendered by a pure-Rust engine inside the frame pipeline — independent of FFmpeg build flags (no `--enable-libass` needed, no system libass), with in-memory script input and explicit font-file control.
- **flv:** Provides support for FLV container parsing and handling.
- **async:** Adds asynchronous functionality (allowing you to `.await` operations).
- **static:** Enables static linking for FFmpeg libraries (via `ffmpeg-next/static`).
## License
ez-ffmpeg is licensed under your choice of the MIT, Apache-2.0, or MPL-2.0 licenses. You may select the license that best fits your needs.
**Important:** While ez-ffmpeg is freely usable, FFmpeg has its own licensing terms. Ensure that your use of its components complies with FFmpeg's license.