dash-runtime 0.4.0

Sans-IO MPEG-DASH (ISO/IEC 23009-1): MPD model and parser, segment addressing, UTC clock and live-edge arithmetic, and a client for static and dynamic presentations. No I/O, no clock reads.
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Representation to Segment plan (ISO/IEC 23009-1 5.3.9.2-5.3.9.6).
//!
//! [`plan::SegmentPlan`] is a lazy, ordered view of a Representation's Media
//! Segments: number, media time, duration, URL reference, byte range and, for
//! dynamic MPDs, availability window. Nothing is materialised per segment
//! except where the MPD itself lists them (`SegmentList`, `sidx`).

use thiserror::Error;

use crate::error::Unsupported;

pub mod base_index;
pub mod list;
pub mod plan;
pub mod representation;
pub mod timeline;

pub use broadcast_dash::template;

pub use plan::{DynamicContext, PlanInput, ResourceRef, SegmentPlan, SegmentRef};
pub use representation::{PlanError, PlanOptions, PlannedRepresentation, plan_representation};

/// Why a Representation's segments cannot be addressed.
#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum AddressError {
    /// A template string is invalid (5.3.9.4.4); the Representation is
    /// dropped.
    #[error("invalid template `{template}`: {fault}")]
    InvalidTemplate {
        /// The template text.
        template: String,
        /// What is wrong with it.
        fault: template::TemplateFault,
    },
    /// A template names a `$Number$` or `$Time$` the Representation has no
    /// value for; rendering it would address the wrong segment.
    #[error("template `{template}` names {which} but there is no value for it")]
    MissingTemplateValue {
        /// The template text.
        template: String,
        /// Which identifier (`number`, `time`).
        which: &'static str,
    },
    /// A feature outside the 0.1 scope.
    #[error("unsupported: {0}")]
    Unsupported(Unsupported),
    /// A template Representation with no `@media`.
    #[error("SegmentTemplate has no @media")]
    MissingMediaTemplate,
    /// A multi-segment list with neither `@duration` nor a timeline.
    #[error("no @duration or SegmentTimeline to time the segments")]
    MissingDuration,
    /// `S@t` smaller than the end of the previous run.
    #[error("S@t {t} is before the end of the previous run ({floor})")]
    TimelineNotIncreasing {
        /// The offending `@t`.
        t: u64,
        /// The previous end.
        floor: u64,
    },
    /// `S@n` smaller than the next expected number.
    #[error("S@n {n} is below the expected next number {expected}")]
    NumberNotIncreasing {
        /// The offending `@n`.
        n: u64,
        /// The expected number.
        expected: u64,
    },
    /// An `S` with `@d` of zero cannot time a segment (5.3.9.6.1).
    #[error("S@d is zero")]
    ZeroSegmentDuration,
    /// The timeline describes more segments than the bound allows.
    #[error("timeline describes at least {count_hint} segments")]
    TimelineTooLong {
        /// Count reached.
        count_hint: u64,
    },
    /// A `SegmentList` whose URL count and timeline disagree.
    #[error("SegmentList has {urls} SegmentURL entries but its timeline describes {segments}")]
    ListTimelineMismatch {
        /// `SegmentURL` entries.
        urls: usize,
        /// Timeline segments.
        segments: u64,
    },
    /// The index bytes are not a usable `sidx`.
    #[error("sidx: {0}")]
    Sidx(String),
    /// Arithmetic overflow on hostile values.
    #[error("segment arithmetic overflow")]
    Overflow,
    /// A SegmentBase Representation whose `sidx` has not been supplied yet.
    #[error("the Representation index (sidx) is required before its segments can be addressed")]
    IndexRequired,
    /// A `SegmentList` entry with no `@media` and no `@mediaRange`.
    #[error("SegmentURL has neither @media nor @mediaRange")]
    EmptySegmentUrl,
    /// A Segment addressing kind this core does not plan (a future
    /// `broadcast-dash` variant), or a template fault it does not classify.
    #[error("unsupported segment addressing")]
    UnsupportedFeature,
}