avplayer 0.7.0

Safe Rust bindings for Apple's AVPlayer + AVAssetReader — playback and frame-by-frame asset reading on macOS
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use serde::{Deserialize, Serialize};

/// Serializable representation of `CMTime`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "snake_case")]
#[non_exhaustive]
pub enum Time {
    /// Numeric time represented as `value / timescale` seconds.
    Numeric { value: i64, timescale: i32 },
    /// `kCMTimeInvalid`.
    Invalid,
    /// `kCMTimeIndefinite`.
    Indefinite,
    /// Positive infinity.
    PositiveInfinity,
    /// Negative infinity.
    NegativeInfinity,
}

impl Time {
    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn new(value: i64, timescale: i32) -> Self {
        Self::Numeric { value, timescale }
    }

    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn invalid() -> Self {
        Self::Invalid
    }

    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn indefinite() -> Self {
        Self::Indefinite
    }

    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn positive_infinity() -> Self {
        Self::PositiveInfinity
    }

    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn negative_infinity() -> Self {
        Self::NegativeInfinity
    }

    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn as_numeric(self) -> Option<(i64, i32)> {
        match self {
            Self::Numeric { value, timescale } => Some((value, timescale)),
            Self::Invalid | Self::Indefinite | Self::PositiveInfinity | Self::NegativeInfinity => {
                None
            }
        }
    }

    #[must_use]
    pub(crate) const fn to_raw(self) -> (i64, i32, i32) {
        match self {
            Self::Numeric { value, timescale } => (value, timescale, 0),
            Self::Invalid => (0, 0, 1),
            Self::Indefinite => (0, 0, 2),
            Self::PositiveInfinity => (0, 0, 3),
            Self::NegativeInfinity => (0, 0, 4),
        }
    }

    #[must_use]
    pub(crate) const fn from_raw(value: i64, timescale: i32, kind: i32) -> Self {
        match kind {
            0 => Self::Numeric { value, timescale },
            2 => Self::Indefinite,
            3 => Self::PositiveInfinity,
            4 => Self::NegativeInfinity,
            _ => Self::Invalid,
        }
    }
}

impl From<(i64, i32)> for Time {
    fn from(value: (i64, i32)) -> Self {
        Self::new(value.0, value.1)
    }
}

/// Serializable representation of `CMTimeRange`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct TimeRange {
    /// Range start.
    pub start: Time,
    /// Range duration.
    pub duration: Time,
}

impl TimeRange {
    /// Mirrors the `AVPlayer` framework constant `fn`.
    #[must_use]
    pub const fn new(start: Time, duration: Time) -> Self {
        Self { start, duration }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn numeric_time_round_trips_through_raw_representation() {
        let time = Time::new(1_234, 600);

        assert_eq!(time.as_numeric(), Some((1_234, 600)));
        assert_eq!(time.to_raw(), (1_234, 600, 0));
        assert_eq!(Time::from_raw(1_234, 600, 0), time);
    }

    #[test]
    fn tuple_conversion_creates_numeric_time() {
        assert_eq!(Time::from((7, 3)), Time::new(7, 3));
    }

    #[test]
    fn invalid_time_is_not_numeric() {
        let time = Time::invalid();

        assert_eq!(time.as_numeric(), None);
        assert_eq!(time.to_raw(), (0, 0, 1));
        assert_eq!(Time::from_raw(99, 1, 1), Time::Invalid);
    }

    #[test]
    fn indefinite_time_is_not_numeric() {
        let time = Time::indefinite();

        assert_eq!(time.as_numeric(), None);
        assert_eq!(time.to_raw(), (0, 0, 2));
        assert_eq!(Time::from_raw(99, 1, 2), Time::Indefinite);
    }

    #[test]
    fn positive_infinity_time_is_not_numeric() {
        let time = Time::positive_infinity();

        assert_eq!(time.as_numeric(), None);
        assert_eq!(time.to_raw(), (0, 0, 3));
        assert_eq!(Time::from_raw(99, 1, 3), Time::PositiveInfinity);
    }

    #[test]
    fn negative_infinity_time_is_not_numeric() {
        let time = Time::negative_infinity();

        assert_eq!(time.as_numeric(), None);
        assert_eq!(time.to_raw(), (0, 0, 4));
        assert_eq!(Time::from_raw(99, 1, 4), Time::NegativeInfinity);
    }

    #[test]
    fn time_range_new_preserves_start_and_duration() {
        let range = TimeRange::new(Time::new(5, 1), Time::new(2, 1));

        assert_eq!(range.start, Time::new(5, 1));
        assert_eq!(range.duration, Time::new(2, 1));
    }
}