Repository navigation
Expand file tree
/
Copy pathlib.rs
More file actions
84 lines (73 loc) · 3.34 KB
/
Copy pathlib.rs
File metadata and controls
84 lines (73 loc) · 3.34 KB
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
//! Clean-room MXF demuxer, written from the SMPTE specifications (editions in the README):
//! ST 377-1 (file format: KLV, partitions, primer pack, header metadata, index tables, random
//! index pack), ST 378 (OP1a), ST 390 (OP-Atom), ST 379-1/2 (generic container), ST 381-1 (MPEG
//! video mapping), ST 381-3 (AVC mapping), ST 382 (AES3 / Broadcast Wave audio mapping), ST 331
//! (AES3 element data, D-10 sound), ST 2019-4 (VC-3 mapping) and RDD 44 (ProRes mapping).
//!
//! [`open`] walks the file's KLV packets (keys and lengths only; essence payloads are never read
//! while opening), parses the partition packs, the primer pack and header metadata of the most
//! complete partition, and every index table segment, then resolves the material package to the
//! file (source) package tracks that carry essence in this file. The result is a list of
//! [`EssenceTrack`]s with per-edit-unit [`Sample`] tables for pictures (file offset, size,
//! presentation position from the index temporal offsets, random-access flag) and PCM chunk
//! tables for sound, plus the start timecode of the material package.
//!
//! [`MxfWriter`] ([`write`]) writes OP1a and OP-Atom files (VC-3, ProRes, AVC byte stream, PCM)
//! with index tables and start timecode, streaming to any `Write + Seek` sink.
//!
//! Layer L0: no dependencies beyond `std`, no `unsafe`, builds for `wasm32-unknown-unknown`.
#![cfg_attr(not(test), deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable))]
mod essence;
mod file;
mod index;
mod klv;
mod meta;
mod source;
pub mod write;
pub use essence::{Codec, PictureInfo, SoundFormat, SoundInfo, aes3_element_samples, decode_pcm};
pub use file::{Chunk, EssenceTrack, MxfFile, OperationalPattern, Partition, PartitionKind, Sample, Timecode, TrackKind, Wrapping, open};
pub use index::{IndexEntry, IndexSegment};
pub use klv::{Rational, Ul};
pub use source::ByteSource;
pub use write::{
CodedKind, ColorSpace, FrameInfo, MxfWriter, OpAtomPcm, PackageIds, Pattern, PictureCoding, PictureDesc, SoundDesc, StartTimecode, Timestamp, Umid,
WriterConfig, encode_pcm, write_opatom_pcm,
};
use std::fmt;
use std::io;
/// Errors produced by the demuxer.
#[derive(Debug)]
pub enum Error {
/// Underlying I/O failure.
Io(io::Error),
/// Not an MXF file (no header partition pack).
NotMxf(String),
/// Structurally invalid data that could not be recovered from.
Invalid(String),
/// Valid but unsupported (e.g. essence stored in another file).
Unsupported(String),
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Error::Io(e) => write!(f, "I/O error: {e}"),
Error::NotMxf(s) => write!(f, "not an MXF file: {s}"),
Error::Invalid(s) => write!(f, "invalid MXF: {s}"),
Error::Unsupported(s) => write!(f, "unsupported MXF: {s}"),
}
}
}
impl std::error::Error for Error {}
impl From<io::Error> for Error {
fn from(e: io::Error) -> Self {
Error::Io(e)
}
}
pub type Result<T> = std::result::Result<T, Error>;
/// Whether `head` (the first bytes of a file) looks like MXF: a header partition pack key within
/// the run-in (at most 64 KiB, ST 377-1 §6.5).
pub fn sniff(head: &[u8]) -> bool {
klv::find_header_partition(head).is_some()
}
#[cfg(test)]
mod tests;