imferno-core

Rust library for parsing and validating SMPTE ST 2067 (IMF) packages. All parsing, validation, and inspection logic lives here.

Part of the imferno ecosystem.

Install

[dependencies]
imferno-core = "2.0"

Usage

Validate a package

use imferno_core::package::{Imferno, ValidationOptions, read_dir};

let files = read_dir("./my-imp")?;
let report = Imferno::parse_and_validate(files, &ValidationOptions::default());

for issue in &report.errors {
    eprintln!("[{}] {}", issue.code, issue.message);
}

Parse and inspect

use imferno_core::package::{Imferno, read_dir};

let files = read_dir("./my-imp")?;
let pkg = Imferno::parse(files)?;

for (id, cpl) in &pkg.composition_playlists {
    println!("{} — {}", id, cpl.content_title);
}

Parse individual files

use imferno_core::cpl::parse_cpl;
use imferno_core::assetmap::{parse_assetmap, parse_pkl, parse_volindex};

let cpl = parse_cpl(cpl_xml)?;
let asset_map = parse_assetmap(assetmap_xml)?;
let pkl = parse_pkl(pkl_xml)?;
let volindex = parse_volindex(volindex_xml)?;

Validate a package directly from a URI

package::read accepts file:// and bare paths out of the box, plus s3://bucket/prefix/ when built with the aws-s3 Cargo feature.

use imferno_core::package::{read, Imferno};
use imferno_core::storage::{fs::FsStorage, StorageUri};

let uri = StorageUri::parse("/path/to/imp")?;
let storage = FsStorage::new();
let files = read(&uri, &storage)?;
let package = Imferno::parse(files)?;

S3 (with --features aws-s3):

use imferno_core::storage::{s3::S3Storage, StorageUri};

let uri = StorageUri::parse("s3://my-bucket/path/to/imp/")?;
let storage = S3Storage::from_default()?;
let files = imferno_core::package::read(&uri, &storage)?;

Standards coverage

Development

MXF test fixtures are stored as GitHub Release assets. Fetch them before running tests:

./scripts/fetch-test-data.sh
cargo test -p imferno-core

License

MIT