rff-codec 0.3.0

Remade FFmpeg (Rust): codec abstraction — Decoder/Encoder traits and the codec registry (libavcodec core).
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

# rff-codec

[![Remade With Rust](https://img.shields.io/badge/Remade%20With-Rust-000?logo=rust&logoColor=fff)](https://github.com/remade-with-rust)
[![By Mata Network](https://img.shields.io/badge/by-Mata%20Network-5b2be0)](https://www.mata.network)
[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/Remade-With-Rust/remade_ffmpeg_rs/blob/main/LICENSE)

The codec abstraction layer of **remade_ffmpeg_rs** — the `Decoder` and
`Encoder` traits plus the `CodecRegistry` that every codec crate registers into.
FFmpeg's `libavcodec` core, minus the codecs themselves.

- **`Decoder` / `Encoder` traits** — push/pull, following the `Again`/`Eof` drain protocol from [`rff-core`](https://crates.io/crates/rff-core).
- **`CodecRegistry`** — lookup by `CodecId` or by FFmpeg-style name (`"vp9"`, `"aac"`), which is what powers `ffmpeg -codecs`.
- **`Codec`** — the registration record: id, name, long name, media type, and optional decoder/encoder factories, so a codec can be decode-only or encode-only.
- **`CodecParams`** — the negotiated stream parameters handed to a codec at open time.
- Adding a codec is one `register(&mut registry)` call — no engine-core changes.

## Usage

```rust
use rff_codec::{Codec, CodecRegistry};
use rff_core::{CodecId, Error, MediaType};

fn main() -> Result<(), Error> {
    let mut codecs = CodecRegistry::new();

    // Each rff-codec-* crate contributes one line like this.
    rff_codec_pcm::register(&mut codecs);

    // Lookup by id, or by the name the CLI accepts (`-c:a pcm`).
    let _decoder = codecs.find_decoder(CodecId::Pcm)?;
    let codec: &Codec = codecs.by_name("pcm").expect("just registered");
    assert_eq!(codec.media_type, MediaType::Audio);

    // `ffmpeg -codecs` is a walk over the registry.
    for c in codecs.iter() {
        println!("{:>6}  {}{}  {}", c.name,
            if c.can_decode() { "D" } else { "." },
            if c.can_encode() { "E" } else { "." },
            c.long_name);
    }
    Ok(())
}
```

## Part of Remade With Rust

This crate is one layer of
**[remade_ffmpeg_rs](https://github.com/Remade-With-Rust/remade_ffmpeg_rs)** — a
ground-up, permissively-licensed Rust rebuild of FFmpeg: a drop-in
`ffmpeg`/`ffprobe` CLI on pure-Rust codecs, with no copyleft. Most users want
the [`remade-ffmpeg`](https://crates.io/crates/remade-ffmpeg) engine facade or the
[`rff-cli`](https://crates.io/crates/rff-cli) binaries rather than this crate
directly.

Also check out our sister project
**[FFAI](https://github.com/Remade-With-Rust/FFAI)** — media for an AI-first
world — and the rest of
**[github.com/remade-with-rust](https://github.com/remade-with-rust)**, including
the standalone codec crates
[`rusty_h264`](https://crates.io/crates/rusty_h264),
[`rusty_vp9`](https://crates.io/crates/rusty_vp9),
[`rusty_mp3`](https://crates.io/crates/rusty_mp3),
[`rusty_aac`](https://crates.io/crates/rusty_aac),
[`rusty-opus`](https://crates.io/crates/rusty-opus),
[`rusty_vorbis`](https://crates.io/crates/rusty_vorbis), and the
[rusty-av1-toolkit](https://github.com/Remade-With-Rust/rusty-av1-toolkit) forks.

## About Mata Network

<!-- ORG BOILERPLATE — keep identical across repos -->

[Mata Network](https://www.mata.network) builds sovereign, self-hostable
infrastructure. **Remade With Rust** is our open-source home for the
permissively-licensed building blocks that work depends on.

<!-- /ORG BOILERPLATE -->

## License

Apache-2.0. See the workspace
[LICENSE](https://github.com/Remade-With-Rust/remade_ffmpeg_rs/blob/main/LICENSE).