ff_preview/
lib.rs

1//! # ff-preview
2//!
3//! Real-time video/audio preview and proxy workflow for the `avio` crate family.
4//!
5//! This crate provides single-file playback (`PreviewPlayer`) with frame-accurate
6//! seek, A/V sync, and an optional proxy generation workflow.
7//!
8//! ## Feature Flags
9//!
10//! | Feature | Description | Default |
11//! |---------|-------------|---------|
12//! | `tokio` | Async `AsyncPreviewPlayer` backed by `spawn_blocking` | no |
13//! | `proxy` | `ProxyGenerator` for lower-resolution proxy files | no |
14//!
15//! ## Usage
16//!
17//! ```ignore
18//! use ff_preview::{PreviewPlayer, RgbaSink};
19//!
20//! let mut player = PreviewPlayer::open("clip.mp4")?;
21//! player.set_sink(Box::new(RgbaSink::new()));
22//! player.play();
23//! player.run()?;
24//! ```
25
26#![warn(clippy::all)]
27#![warn(clippy::pedantic)]
28
29pub mod audio;
30pub(crate) mod cache;
31pub mod error;
32pub mod event;
33pub mod playback;
34
35#[cfg(feature = "proxy")]
36pub mod proxy;
37
38#[cfg(feature = "timeline")]
39pub mod scene;
40
41pub use audio::{AudioMixer, AudioTrackHandle};
42pub use error::PreviewError;
43pub use event::PlayerEvent;
44pub use ff_decode::HardwareAccel;
45pub use ff_format::{ErrorSeverity, MediaError};
46pub use playback::{
47    DecodeBuffer, DecodeBufferBuilder, FrameResult, FrameSink, PlaybackClock, PlayerCommand,
48    PlayerHandle, PlayerRunner, PreviewPlayer, RgbaFrame, RgbaSink, SeekEvent,
49};
50
51#[cfg(feature = "tokio")]
52pub use playback::AsyncPreviewPlayer;
53
54#[cfg(feature = "proxy")]
55pub use proxy::{ProxyGenerator, ProxyJob, ProxyResolution};
56
57#[cfg(feature = "timeline")]
58pub use scene::{
59    Scene, SceneAudioPlacement, SceneAudioTrack, ScenePlacement, ScenePlayer, SceneRunner,
60    SceneVideoTrack,
61};
ff_preview/lib.rs

ff_preview/
lib.rs
