remade-ffmpeg 0.4.0

Remade FFmpeg (Rust): the engine facade — registers built-in codecs/formats and exposes the high-level transcode & probe API.
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! `rff` — the Remade FFmpeg (Rust) engine facade.
//!
//! This is the crate you depend on to *use* the project as a library. It pulls
//! the layered crates together:
//! * re-exports the core vocabulary ([`core`], [`codec`], [`format`]),
//! * builds an [`Engine`] with every built-in codec and container registered,
//! * exposes the high-level [`transcode`], [`probe`] and [`targets`] APIs that
//!   the CLI and the HTTP server are both thin wrappers over.
//!
//! "API first": the CLI (`ffmpeg`/`ffprobe`) and the server expose *this* API.
//! There is no logic in those front-ends that isn't reachable programmatically.

pub use rff_codec as codec;
pub use rff_core as core;
pub use rff_format as format;

pub mod probe;
pub mod targets;
pub mod transcode;

use rff_codec::CodecRegistry;
use rff_format::FormatRegistry;

/// A fully-wired engine: every built-in codec and container, ready to use.
///
/// Construct one with [`Engine::new`] and hand it to [`transcode`] / [`probe`],
/// or query its registries directly (e.g. to implement `ffmpeg -codecs`).
pub struct Engine {
    pub codecs: CodecRegistry,
    pub formats: FormatRegistry,
}

impl Engine {
    /// Build an engine with all built-in codecs and formats registered.
    pub fn new() -> Engine {
        let mut codecs = CodecRegistry::new();
        register_builtin_codecs(&mut codecs);

        let mut formats = FormatRegistry::new();
        register_builtin_formats(&mut formats);

        Engine { codecs, formats }
    }
}

impl Default for Engine {
    fn default() -> Self {
        Engine::new()
    }
}

/// Register every codec compiled into this build. New codec crates get one line
/// here.
fn register_builtin_codecs(codecs: &mut CodecRegistry) {
    rff_codec_h264::register(codecs);
    rff_codec_hevc::register(codecs);
    rff_codec_opus::register(codecs);
    rff_codec_avif::register(codecs);
    rff_codec_png::register(codecs);
    rff_codec_jpeg::register(codecs);
    rff_codec_gif::register(codecs);
    rff_codec_webp::register(codecs);
    rff_codec_pcm::register(codecs);
    rff_codec_vorbis::register(codecs);
    rff_codec_flac::register(codecs);
    rff_codec_jxl::register(codecs);
    rff_codec_aac::register(codecs);
    rff_codec_vp9::register(codecs);
    rff_codec_av2::register(codecs);
    rff_codec_mp3::register(codecs);
    rff_codec_rawvideo::register(codecs);
    // H.264 defaults to the in-house pure-Rust `rusty_h264` (registered above).
    // The `h264-openh264` feature swaps in Cisco's C/FFI openh264 instead — a
    // cross-check / fallback option, off by default.
    #[cfg(feature = "h264-openh264")]
    rff_codec_openh264::register(codecs);
}

/// Register every container format compiled into this build.
fn register_builtin_formats(formats: &mut FormatRegistry) {
    rff_format_avi::register(formats);
    rff_format_avif::register(formats);
    rff_format_png::register(formats);
    rff_format_jpeg::register(formats);
    rff_format_gif::register(formats);
    rff_format_webp::register(formats);
    rff_format_wav::register(formats);
    rff_format_y4m::register(formats);
    rff_format_ivf::register(formats);
    // AV2F is EXPERIMENTAL: its four-character codes are chosen by us, not
    // specified by AOM. Files written here are readable here and nowhere else.
    rff_format_av2f::register(formats);
    rff_format_ogg::register(formats);
    rff_format_flac::register(formats);
    rff_format_mp3::register(formats);
    rff_format_jxl::register(formats);
    rff_format_mp4::register(formats);
    rff_format_mkv::register(formats);
    rff_format_ts::register(formats);
    rff_format_flv::register(formats);
    rff_format_srt::register(formats);
    rff_format_webvtt::register(formats);
    rff_format_ass::register(formats);
    rff_format_hls::register(formats);
    rff_format_mjpeg::register(formats);
    rff_format_rtp::register(formats);
}

/// The crate version, surfaced in the CLI/server banners.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");