ff-encode 0.14.0

Video and audio encoding - the Rust way
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

//! AV1 (libaom-av1) per-codec encoding options.

/// AV1 per-codec options (libaom-av1).
#[derive(Debug, Clone)]
pub struct Av1Options {
    /// CPU effort level: `0` = slowest / best quality, `8` = fastest / lowest quality.
    pub cpu_used: u8,
    /// Log2 of the number of tile rows (0–6).
    pub tile_rows: u8,
    /// Log2 of the number of tile columns (0–6).
    pub tile_cols: u8,
    /// Encoding usage mode.
    pub usage: Av1Usage,
}

impl Default for Av1Options {
    fn default() -> Self {
        Self {
            cpu_used: 4,
            tile_rows: 0,
            tile_cols: 0,
            usage: Av1Usage::VoD,
        }
    }
}

/// AV1 encoding usage mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum Av1Usage {
    /// Video-on-demand: maximise quality at the cost of speed.
    #[default]
    VoD,
    /// Real-time: minimise encoding latency.
    RealTime,
}

impl Av1Usage {
    pub(in crate::video) fn as_str(self) -> &'static str {
        match self {
            Self::VoD => "vod",
            Self::RealTime => "realtime",
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn av1_usage_should_return_correct_str() {
        assert_eq!(Av1Usage::VoD.as_str(), "vod");
        assert_eq!(Av1Usage::RealTime.as_str(), "realtime");
    }

    #[test]
    fn av1_options_default_should_have_vod_usage() {
        let opts = Av1Options::default();
        assert_eq!(opts.cpu_used, 4);
        assert_eq!(opts.tile_rows, 0);
        assert_eq!(opts.tile_cols, 0);
        assert_eq!(opts.usage, Av1Usage::VoD);
    }
}