ff-preview 0.14.1

Real-time video/audio preview and proxy workflow
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# ff-preview


Real-time video preview and proxy workflow for Rust. Provides frame-accurate seek, audio-master A/V sync, a `FrameSink` trait for custom renderers, RGBA pixel delivery, and proxy generation with transparent auto-substitution.

> **Project status (as of 2026-04-13):** This crate is in an early phase. The high-level API is designed and reviewed by hand; AI is used as an accelerator to implement FFmpeg bindings efficiently. Code contributions are not expected at this time — questions, bug reports, and feature requests are welcome. See the [main repository](https://github.com/itsakeyfut/avio) for full context.

## Installation


```toml
[dependencies]
ff-preview = "0.14"

# Enable async support

ff-preview = { version = "0.14", features = ["tokio"] }

# Enable proxy generation

ff-preview = { version = "0.14", features = ["proxy"] }
```

## Quick Start


### Playback with a custom RGBA sink


```rust
use ff_preview::{PreviewPlayer, RgbaSink};

fn main() -> Result<(), ff_preview::PreviewError> {
    let mut player = PreviewPlayer::open("video.mp4")?;
    player.set_sink(Box::new(RgbaSink::new()));
    player.play();
    player.run()?;
    Ok(())
}
```

### Frame-accurate seek


```rust
use std::time::Duration;
use ff_preview::{DecodeBuffer, FrameResult};

let mut buf = DecodeBuffer::open("video.mp4").build()?;
buf.seek(Duration::from_secs(30))?;

loop {
    match buf.pop_frame() {
        FrameResult::Frame(f) => {
            println!("pts: {:?}", f.timestamp().as_duration());
            break;
        }
        FrameResult::Seeking(_) => std::thread::sleep(Duration::from_millis(5)),
        FrameResult::Eof => break,
    }
}
```

### Proxy generation


```rust
use ff_preview::{ProxyGenerator, ProxyResolution};

let proxy_path = ProxyGenerator::new("original_1080p.mp4")?
    .resolution(ProxyResolution::Quarter)
    .output_dir("/tmp")
    .generate()?;

println!("proxy at {}", proxy_path.display());
```

## Feature Flags


| Feature | What it enables |
|---------|----------------|
| *(default)* | `PreviewPlayer`, `DecodeBuffer`, `PlaybackClock`, `FrameSink`, `RgbaSink`, `RgbaFrame`, seek |
| `tokio` | `AsyncPreviewPlayer` |
| `proxy` | `ProxyGenerator`, `ProxyJob`, `ProxyResolution` |

## MSRV


Rust 1.93.0 (edition 2024).

## License


MIT OR Apache-2.0