🎥 MP4 reader and writer library in Rust! 🦀
Go to file
Andrey Tkachenko 35560e94f5
hev1 box parser (#101)
Co-authored-by: Alfred Gutierrez <alfg@users.noreply.github.com>
2023-08-02 21:20:03 -07:00
.github/workflows fix clippy & enhance CI/CD (#78) 2022-07-07 20:02:00 -07:00
benches Cargo fmt and clippy (#73) 2022-05-31 20:50:49 -07:00
examples fix clippy & enhance CI/CD (#78) 2022-07-07 20:02:00 -07:00
src hev1 box parser (#101) 2023-08-02 21:20:03 -07:00
tests Extract esds box from wave box (#96) 2023-08-02 21:13:58 -07:00
.gitignore Remove Cargo.lock and add to .gitignore. 2020-07-28 22:13:15 -07:00
Cargo.toml Release 0.14.0 (#117) 2023-07-31 20:54:29 -07:00
LICENSE Change main.rs to lib.rs and create example mp4info project. Update readme and license. 2020-01-12 19:33:26 -08:00
README.md Release 0.14.0 (#117) 2023-07-31 20:54:29 -07:00

README.md

mp4

MP4 Reader and Writer in Rust 🦀

mp4 is a Rust library to read and write ISO-MP4 files. This package contains MPEG-4 specifications defined in parts:

https://crates.io/crates/mp4

Crates.io Crates.io Docs Rust

Example

use std::fs::File;
use std::io::{BufReader};
use mp4::{Result};

fn main() -> Result<()> {
    let f = File::open("tests/samples/minimal.mp4").unwrap();
    let size = f.metadata()?.len();
    let reader = BufReader::new(f);

    let mp4 = mp4::Mp4Reader::read_header(reader, size)?;

    // Print boxes.
    println!("major brand: {}", mp4.ftyp.major_brand);
    println!("timescale: {}", mp4.moov.mvhd.timescale);

    // Use available methods.
    println!("size: {}", mp4.size());

    let mut compatible_brands = String::new();
    for brand in mp4.compatible_brands().iter() {
        compatible_brands.push_str(&brand.to_string());
        compatible_brands.push_str(",");
    }
    println!("compatible brands: {}", compatible_brands);
    println!("duration: {:?}", mp4.duration());

    // Track info.
    for track in mp4.tracks().values() {
        println!(
            "track: #{}({}) {} : {}",
            track.track_id(),
            track.language(),
            track.track_type()?,
            track.box_type()?,
        );
    }
    Ok(())
}

See examples/ for more examples.

Install

cargo add mp4

or add to your Cargo.toml:

mp4 = "0.14.0"

Documentation

Development

Requirements

Build

cargo build

Lint and Format

cargo clippy --fix
cargo fmt --all

Run Examples

  • mp4info
cargo run --example mp4info <movie.mp4>
  • mp4dump
cargo run --example mp4dump <movie.mp4>

Run Tests

cargo test

With print statement output.

cargo test -- --nocapture

Run Cargo fmt

Run fmt to catch formatting errors.

rustup component add rustfmt
cargo fmt --all -- --check

Run Clippy

Run Clippy tests to catch common lints and mistakes.

rustup component add clippy
cargo clippy --no-deps -- -D warnings

Run Benchmark Tests

cargo bench

View HTML report at target/criterion/report/index.html

Generate Docs

cargo docs

View at target/doc/mp4/index.html

Web Assembly

See the mp4-inspector project as a reference for using this library in Javascript via Web Assembly.

License

MIT