muxide 0.2.5

Minimal-dependency pure-Rust MP4 muxer for recording applications. Includes CLI tool and library 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
111
112
113
114
115
116
117
118
119
120
121
122

use muxide::api::{AacProfile, AudioCodec, MuxerBuilder, MuxerError, VideoCodec};
use std::{fs, path::Path};

mod support;
use support::SharedBuffer;

fn read_hex_fixture(dir: &str, name: &str) -> Vec<u8> {
    let path = Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("fixtures")
        .join(dir)
        .join(name);
    let contents = fs::read_to_string(path).expect("fixture must be readable");
    let hex: String = contents.chars().filter(|c| !c.is_whitespace()).collect();
    assert!(hex.len() % 2 == 0, "hex fixtures must have even length");

    let mut out = Vec::with_capacity(hex.len() / 2);
    for i in (0..hex.len()).step_by(2) {
        let byte = u8::from_str_radix(&hex[i..i + 2], 16).expect("valid hex");
        out.push(byte);
    }
    out
}

#[test]
fn errors_are_specific_and_descriptive() -> Result<(), Box<dyn std::error::Error>> {
    let frame0 = read_hex_fixture("video_samples", "frame0_key.264");
    let non_sps_pps = read_hex_fixture("video_samples", "frame1_p.264");

    // Video pts must be non-negative.
    {
        let (writer, _) = SharedBuffer::new();
        let mut muxer = MuxerBuilder::new(writer)
            .video(VideoCodec::H264, 640, 480, 30.0)
            .build()?;
        let err = muxer.write_video(-0.001, &frame0, true).unwrap_err();
        assert!(matches!(err, MuxerError::NegativeVideoPts { .. }));
        let msg = err.to_string();
        assert!(
            msg.contains("negative"),
            "error should mention negative: {}",
            msg
        );
        assert!(
            msg.contains("frame 0"),
            "error should include frame index: {}",
            msg
        );
    }

    // First frame must be a keyframe.
    {
        let (writer, _) = SharedBuffer::new();
        let mut muxer = MuxerBuilder::new(writer)
            .video(VideoCodec::H264, 640, 480, 30.0)
            .build()?;
        let err = muxer.write_video(0.0, &frame0, false).unwrap_err();
        assert!(matches!(err, MuxerError::FirstVideoFrameMustBeKeyframe));
        assert!(err.to_string().contains("keyframe"));
    }

    // First keyframe must contain SPS/PPS.
    {
        let (writer, _) = SharedBuffer::new();
        let mut muxer = MuxerBuilder::new(writer)
            .video(VideoCodec::H264, 640, 480, 30.0)
            .build()?;
        let err = muxer.write_video(0.0, &non_sps_pps, true).unwrap_err();
        assert!(matches!(err, MuxerError::FirstVideoFrameMissingSpsPps));
        assert!(err.to_string().contains("SPS"));
    }

    // Video pts must be strictly increasing.
    {
        let (writer, _) = SharedBuffer::new();
        let mut muxer = MuxerBuilder::new(writer)
            .video(VideoCodec::H264, 640, 480, 30.0)
            .build()?;
        muxer.write_video(0.0, &frame0, true)?;
        let err = muxer.write_video(0.0, &frame0, false).unwrap_err();
        assert!(matches!(err, MuxerError::NonIncreasingVideoPts { .. }));
        let msg = err.to_string();
        assert!(
            msg.contains("frame 1"),
            "error should include frame index: {}",
            msg
        );
        assert!(
            msg.contains("increase"),
            "error should mention increasing: {}",
            msg
        );
    }

    // Audio must not arrive before first video frame.
    {
        let (writer, _) = SharedBuffer::new();
        let mut muxer = MuxerBuilder::new(writer)
            .video(VideoCodec::H264, 640, 480, 30.0)
            .audio(AudioCodec::Aac(AacProfile::Lc), 48_000, 2)
            .build()?;
        let err = muxer
            .write_audio(0.0, &[0xff, 0xf1, 0x4c, 0x80, 0x01, 0x3f, 0xfc])
            .unwrap_err();
        assert!(matches!(err, MuxerError::AudioBeforeFirstVideo { .. }));
        assert!(err.to_string().contains("video"));
    }

    // Invalid ADTS should surface as InvalidAdts.
    {
        let (writer, _) = SharedBuffer::new();
        let mut muxer = MuxerBuilder::new(writer)
            .video(VideoCodec::H264, 640, 480, 30.0)
            .audio(AudioCodec::Aac(AacProfile::Lc), 48_000, 2)
            .build()?;
        muxer.write_video(0.0, &frame0, true)?;
        let err = muxer.write_audio(0.0, &[0, 1, 2, 3]).unwrap_err();
        assert!(matches!(err, MuxerError::InvalidAdtsDetailed { .. }));
        assert!(err.to_string().contains("ADTS"));
    }

    Ok(())
}