mediaschema 0.1.0

Product-agnostic media-primitive schema (buffa-generated)
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

//! Hand-written domain layer — the architectural hub for mediaschema.
//!
//! App logic programs against these types; the buffa-generated wire types at
//! the crate root are the serialization edge. Domain types are governed by
//! `domain → wire → domain` round-trip property tests (added as the aggregate
//! types come online in later stacked PRs).
//!
//! Locked-schema implementation tracks `schema/*.md`. This module starts with
//! the primitives + shared cross-cutting VOs; subsequent stacked PRs add the
//! enums + bitflags, then the leaf aggregates, then the big container/track
//! aggregates.

#[cfg(any(feature = "std", feature = "alloc"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "std", feature = "alloc"))))]
pub mod aggregates;
pub mod bitflags;
pub mod enums;
pub mod identified;
pub mod primitives;
#[cfg(any(feature = "std", feature = "alloc"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "std", feature = "alloc"))))]
pub mod vo;

// Always available (pure no-std no-alloc):
pub use bitflags::{AudioIndexStatus, MediaErrorFlags, SubtitleIndexStatus, VideoIndexStatus};
pub use enums::{
  AudioContentKind, AudioIndexStage, KeyframeExtractor, MediaKind, ScanStatus, SceneDetector,
  SubtitleIndexStage, SubtitleKind, VideoIndexStage,
};
pub use identified::Identified;
pub use primitives::{ErrorCode, FileChecksum, Rgba, Uuid7};

// Heap-tier (gate on `any(std, alloc)`): cross-cutting aggregates and
// types that reach `Vec` / `SmolStr` regardless of which media features
// are on.
#[cfg(any(feature = "std", feature = "alloc"))]
pub use aggregates::{
  Media, MediaFile, Person, PersonConfidence, SceneAnnotation, Speaker, UserTag, WatchedLocation,
};
// Medium-specific aggregate re-exports: only re-export when the
// corresponding medium feature is on (in addition to the heap tier).
#[cfg(all(any(feature = "std", feature = "alloc"), feature = "audio"))]
pub use aggregates::{Audio, AudioSegment, AudioTrack, Word};
#[cfg(all(any(feature = "std", feature = "alloc"), feature = "video"))]
pub use aggregates::{Keyframe, Scene, Video, VideoTrack};
#[cfg(all(any(feature = "std", feature = "alloc"), feature = "subtitle"))]
pub use aggregates::{Subtitle, SubtitleCue, SubtitleTrack};
#[cfg(any(feature = "std", feature = "alloc"))]
pub use primitives::{ErrorInfo, Location};
#[cfg(any(feature = "std", feature = "alloc"))]
pub use vo::{IndexProgress, LocalizedText, Provenance, VoiceFingerprint, VoiceFingerprintError};