1
0
Fork 0
mirror of https://github.com/alfg/mp4-rust.git synced 2024-12-22 20:16:27 +00:00
mp4-rust/README.md
Alfred Gutierrez a4fd45b3e8
Add basic integration test (#10)
* Add basic integration test and update README and example. Add sample minimal.mp4 file for tests.

* Add .travis.yml file.

* Update readme.
2020-07-25 20:07:39 -07:00

65 lines
1.3 KiB
Markdown

# mp4rs
> MP4 Reader in Rust
ISO/IEC 14496-12 - ISO Base Media File Format (QuickTime, MPEG-4, etc)
[![Crates.io](https://img.shields.io/crates/v/mp4)](https://crates.io/crates/mp4)
[![Crates.io](https://img.shields.io/crates/d/mp4)](https://crates.io/crates/mp4)
[![Build Status](https://travis-ci.org/alfg/mp4rs.svg?branch=master)](https://travis-ci.org/alfg/mp4rs)
![Rust](https://github.com/alfg/mp4rs/workflows/Rust/badge.svg)
#### Example
```rust
use mp4;
fn main() {
let f = File::open("example.mp4").unwrap();
let bmff = mp4::read_mp4(f).unwrap();
println!("file size: {}", bmff.size);
println!("brands: {:?} {:?}\n",
bmff.ftyp.major_brand, bmff.ftyp.compatible_brands
);
}
```
See [examples/](examples/) for a full example.
#### Documentation
* https://docs.rs/mp4/
## Development
#### Requirements
* [Rust](https://www.rust-lang.org/)
#### Build
```
cargo build
```
#### Run Examples
* `mp4info`
```
cargo run --example mp4info <movie.mp4>
```
#### Run Tests
```
cargo test
```
With print statement output.
```
cargo test -- --nocapture
```
## Resources
Thanks to the following resources used when learning Rust:
* https://github.com/mozilla/mp4parse-rust
* https://github.com/pcwalton/rust-media
* https://github.com/alfg/mp4
## License
MIT