media-doctor 0.8.0

Media diagnostics harness for DVB/MPEG-TS: pluggable lint-style checks (sync, PAT/PMT versioning, CC anomalies, PCR, PTS/DTS monotonicity, SCTE-35 splice consistency) + HLS playlist validation.
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

//! `media-doctor` — media diagnostics harness for DVB / MPEG-2 Transport Streams.
//!
//! An extensible lint-style analysis framework: individual [`Diagnostic`]s each
//! check one rule against a TS byte-stream, producing [`Finding`]s that feed into
//! a [`Report`]. A trivial built-in [`SyncByteCheck`] proves the
//! harness.
//!
//! # Feature flags
//!
//! | Feature | Default | Description |
//! |---|---|---|
//! | `std`   | yes     | `std::error::Error` impls |
//! | `serde` | yes     | JSON report output via `serde` / `serde_json` |
//! | `cli`   | yes     | `clap`-based CLI binary, incl. `watch` (issue #665) |
//!
//! # Quick start (library)
//!
//! ```rust
//! use media_doctor::{Diagnostic, Report, SyncByteCheck};
//!
//! let mut report = Report::new();
//! let diag = SyncByteCheck;
//! diag.run(&[0x47, 0x00, 0x00, 0x10], &mut report);
//! assert!(report.findings().is_empty());
//! ```

#![cfg_attr(not(feature = "std"), no_std)]
#![forbid(unsafe_code)]
#![cfg_attr(docsrs, feature(doc_cfg))]

extern crate alloc;

mod container_codec;
mod dash_validator;
mod diagnostics;
mod hls_validator;
mod playlist;
mod report;
mod watch;

pub use container_codec::check_container_codec;
pub use dash_validator::check_dash_mpd;
pub use diagnostics::cc_anomaly::CcAnomalyCheck;
pub use diagnostics::codec_signalling::CodecSignallingCheck;
pub use diagnostics::fps_cadence::FpsCadenceCheck;
pub use diagnostics::interlace::InterlaceCheck;
pub use diagnostics::param_sets::ParamSetsCheck;
pub use diagnostics::pat_pmt_version::PatPmtVersionCheck;
pub use diagnostics::pcr_check::PcrCheck;
pub use diagnostics::pts_check::PtsCheck;
pub use diagnostics::scte35_check::Scte35Check;
pub use diagnostics::sync_byte::SyncByteCheck;
pub use hls_validator::check_hls_playlist;
pub use playlist::check_playlist;
pub use report::{Finding, Location, Report, Severity};
pub use watch::WatchState;

/// A pluggable diagnostic check that examines a Transport Stream byte buffer.
///
/// Implementors receive the full TS byte slice (contiguous 188-byte packets, no
/// framing gaps — `ts.len()` is a multiple of 188) and push any findings into
/// `report`.
pub trait Diagnostic {
    /// Check a TS byte buffer, appending findings to `report`.
    fn run(&self, ts: &[u8], report: &mut Report);
}

/// Run every registered [`Diagnostic`] against a TS buffer.
///
/// This is the simplest harness runner: it feeds the buffer through each
/// diagnostic in order. A streaming version will follow in a later story.
pub fn run_all(ts: &[u8], diagnostics: &[&dyn Diagnostic], report: &mut Report) {
    for diag in diagnostics {
        diag.run(ts, report);
    }
}

#[cfg(feature = "cli")]
pub mod cli;