medea 0.2.0

Medea media server
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

//! Implementation of the [`MediaTrafficState`] which will be used for
//! the storing started/stopped [`MediaType`]s.

use crate::api::control::callback::MediaType;

/// Traffic state of all [`MediaType`]s for some `Endpoint`.
///
/// All [`MediaType`]s can be in started or stopped state.
///
/// `1` bit in this bitflags structure represents that [`MediaType`] is started.
/// `0` bit in this bitflags structure represents that [`MediaType`] is stopped.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct MediaTrafficState(u8);

impl MediaTrafficState {
    /// Creates new [`MediaTrafficState`] in which all [`MediaType`]s is
    /// stopped.
    #[inline]
    pub const fn new() -> MediaTrafficState {
        Self(0)
    }

    /// Returns new [`MediaTrafficState`] in which provided [`MediaType`] is
    /// started.
    #[cfg(test)]
    #[inline]
    pub const fn with_media_type(media_type: MediaType) -> MediaTrafficState {
        Self(media_type as u8)
    }

    /// Sets provided [`MediaType`] to the started state.
    ///
    /// Note that [`MediaType::Both`] will set [`MediaType::Audio`] and
    /// [`MediaType::Video`] to started state.
    #[inline]
    pub fn started(&mut self, media_type: MediaType) {
        self.0 |= media_type as u8;
    }

    /// Sets provided [`MediaType`] to the stopped state.
    ///
    /// Note that [`MediaType::Both`] will set [`MediaType::Audio`] and
    /// [`MediaType::Video`] to stopped state.
    #[inline]
    pub fn stopped(&mut self, media_type: MediaType) {
        self.0 &= !(media_type as u8);
    }

    /// Returns `true` if the provided [`MediaType`] is started.
    ///
    /// Note that [`MediaType::Both`] will return `true` only if
    /// [`MediaType::Audio`] and [`MediaType::Video`] is started.
    #[inline]
    pub const fn is_started(self, media_type: MediaType) -> bool {
        let media_type = media_type as u8;

        (self.0 & media_type) == media_type
    }

    /// Returns `true` if the provided [`MediaType`] is stopped.
    ///
    /// Note that [`MediaType::Both`] will return `true` only if
    /// [`MediaType::Audio`] and [`MediaType::Video`] is stopped.
    #[inline]
    pub const fn is_stopped(self, media_type: MediaType) -> bool {
        let media_type = !(media_type as u8);

        (self.0 | media_type) == media_type
    }

    /// Returns [`MediaType`] which started according to this
    /// [`MediaTrafficState`].
    ///
    /// Returns `None` if all [`MediaType`]s stopped.
    pub fn get_started_media_type(self) -> Option<MediaType> {
        if self.is_started(MediaType::Both) {
            Some(MediaType::Both)
        } else if self.is_started(MediaType::Audio) {
            Some(MediaType::Audio)
        } else if self.is_started(MediaType::Video) {
            Some(MediaType::Video)
        } else {
            None
        }
    }
}

/// Returns [`MediaType`] which was started based on [`MediaTrafficState`]
/// before and [`MediaTrafficState`] after. Returns `Some(MediaType)` if `after`
/// contains [`MediaType`] that is not present in `before` and `None` otherwise.
///
/// `None` will be returned if none of the [`MediaType`]s was started.
pub fn get_diff_added(
    before: MediaTrafficState,
    after: MediaTrafficState,
) -> Option<MediaType> {
    MediaTrafficState(!before.0 & after.0).get_started_media_type()
}

/// Returns [`MediaType`] which was stopped based on [`MediaTrafficState`]
/// before and [`MediaTrafficState`] after. Returns `Some(MediaType)` if
/// `before` contains [`MediaType`] that is not present in `after` and `None`
/// otherwise.
pub fn get_diff_removed(
    before: MediaTrafficState,
    after: MediaTrafficState,
) -> Option<MediaType> {
    MediaTrafficState(before.0 & !after.0).get_started_media_type()
}

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

    #[test]
    fn normally_sets_started() {
        let mut state = MediaTrafficState::new();

        assert!(!state.is_started(MediaType::Audio));
        assert!(!state.is_started(MediaType::Video));
        assert!(!state.is_started(MediaType::Both));

        state.started(MediaType::Audio);
        assert!(state.is_started(MediaType::Audio));
        assert!(!state.is_started(MediaType::Video));
        assert!(!state.is_started(MediaType::Both));

        state.started(MediaType::Video);
        assert!(state.is_started(MediaType::Video));
        assert!(state.is_started(MediaType::Audio));
        assert!(state.is_started(MediaType::Both));
    }

    #[test]
    fn normally_sets_started_on_both() {
        let mut state = MediaTrafficState::new();

        assert!(!state.is_started(MediaType::Video));
        assert!(!state.is_started(MediaType::Audio));
        assert!(!state.is_started(MediaType::Both));

        state.started(MediaType::Both);
        assert!(state.is_started(MediaType::Video));
        assert!(state.is_started(MediaType::Audio));
        assert!(state.is_started(MediaType::Both));
    }

    #[test]
    fn normally_sets_stopped() {
        let mut state = MediaTrafficState::new();
        state.started(MediaType::Both);
        assert!(state.is_started(MediaType::Video));
        assert!(state.is_started(MediaType::Audio));
        assert!(state.is_started(MediaType::Both));

        state.stopped(MediaType::Audio);
        assert!(!state.is_started(MediaType::Audio));
        assert!(state.is_started(MediaType::Video));
        assert!(!state.is_started(MediaType::Both));

        state.stopped(MediaType::Video);
        assert!(!state.is_started(MediaType::Audio));
        assert!(!state.is_started(MediaType::Video));
        assert!(!state.is_started(MediaType::Both));
    }

    #[test]
    fn normally_sets_stopped_on_both() {
        let mut state = MediaTrafficState::new();
        state.started(MediaType::Both);
        assert!(state.is_started(MediaType::Video));
        assert!(state.is_started(MediaType::Audio));
        assert!(state.is_started(MediaType::Both));

        state.stopped(MediaType::Both);
        assert!(!state.is_started(MediaType::Video));
        assert!(!state.is_started(MediaType::Audio));
        assert!(!state.is_started(MediaType::Both));
    }

    #[test]
    fn normally_works_is_stopped() {
        let mut state = MediaTrafficState::new();
        assert!(state.is_stopped(MediaType::Both));

        state.started(MediaType::Audio);
        assert!(state.is_stopped(MediaType::Video));
        assert!(!state.is_stopped(MediaType::Both));
        assert!(!state.is_stopped(MediaType::Audio));

        state.started(MediaType::Video);
        assert!(!state.is_stopped(MediaType::Video));
        assert!(!state.is_stopped(MediaType::Audio));
        assert!(!state.is_stopped(MediaType::Both));

        state.stopped(MediaType::Both);
        assert!(state.is_stopped(MediaType::Video));
        assert!(state.is_stopped(MediaType::Audio));
        assert!(state.is_stopped(MediaType::Both));
    }

    #[test]
    fn diff_started() {
        // Audio - 0b1
        // Video - 0b10
        // Both - 0b11

        // 0b1 -> 0b10 = 0b10
        let state_before = MediaTrafficState::with_media_type(MediaType::Audio);
        let state_after = MediaTrafficState::with_media_type(MediaType::Video);
        let started_media_type =
            get_diff_added(state_before, state_after).unwrap();
        assert_eq!(started_media_type, MediaType::Video);

        // 0b0 -> 0b1 = 0b1
        let state_before = MediaTrafficState::new();
        let state_after = MediaTrafficState::with_media_type(MediaType::Audio);
        let started_media_type =
            get_diff_added(state_before, state_after).unwrap();
        assert_eq!(started_media_type, MediaType::Audio);

        // 0b0 -> 0b11 = 0b11
        let state_before = MediaTrafficState::new();
        let state_after = MediaTrafficState::with_media_type(MediaType::Both);
        let started_media_type =
            get_diff_added(state_before, state_after).unwrap();
        assert_eq!(started_media_type, MediaType::Both);

        // 0b11 -> 0b0 = 0b0
        let state_before = MediaTrafficState::with_media_type(MediaType::Both);
        let state_after = MediaTrafficState::new();
        assert!(get_diff_added(state_before, state_after).is_none());

        // 0b11 -> 0b11 = 0b0
        let state_before = MediaTrafficState::with_media_type(MediaType::Both);
        let state_after = MediaTrafficState::with_media_type(MediaType::Both);
        assert!(get_diff_added(state_before, state_after).is_none());

        // 0b10 -> 0b1 = 0b1
        let state_before = MediaTrafficState::with_media_type(MediaType::Video);
        let state_after = MediaTrafficState::with_media_type(MediaType::Audio);
        assert_eq!(
            get_diff_added(state_before, state_after).unwrap(),
            MediaType::Audio
        );

        // 0b0 -> 0b10 = 0b10
        let state_before = MediaTrafficState::new();
        let state_after = MediaTrafficState::with_media_type(MediaType::Video);
        assert_eq!(
            get_diff_added(state_before, state_after).unwrap(),
            MediaType::Video
        );

        let state_before = MediaTrafficState::with_media_type(MediaType::Audio);
        let state_after = MediaTrafficState::with_media_type(MediaType::Both);
        assert_eq!(
            get_diff_added(state_before, state_after).unwrap(),
            MediaType::Video,
        );

        let state_before = MediaTrafficState::with_media_type(MediaType::Video);
        let state_after = MediaTrafficState::with_media_type(MediaType::Both);
        assert_eq!(
            get_diff_added(state_before, state_after).unwrap(),
            MediaType::Audio,
        );
    }

    #[test]
    fn diff_stopped() {
        let before = MediaTrafficState::with_media_type(MediaType::Both);
        let after = MediaTrafficState::with_media_type(MediaType::Audio);
        assert_eq!(get_diff_removed(before, after).unwrap(), MediaType::Video);

        let before = MediaTrafficState::with_media_type(MediaType::Audio);
        let after = MediaTrafficState::with_media_type(MediaType::Video);
        assert_eq!(get_diff_removed(before, after).unwrap(), MediaType::Audio);

        let before = MediaTrafficState::with_media_type(MediaType::Both);
        let after = MediaTrafficState::new();
        assert_eq!(get_diff_removed(before, after).unwrap(), MediaType::Both);

        let before = MediaTrafficState::with_media_type(MediaType::Both);
        let after = MediaTrafficState::with_media_type(MediaType::Both);
        assert!(get_diff_removed(before, after).is_none());

        let before = MediaTrafficState::new();
        let after = MediaTrafficState::new();
        assert!(get_diff_removed(before, after).is_none());

        let before = MediaTrafficState::new();
        let after = MediaTrafficState::with_media_type(MediaType::Both);
        assert!(get_diff_removed(before, after).is_none());

        let before = MediaTrafficState::with_media_type(MediaType::Both);
        let after = MediaTrafficState::with_media_type(MediaType::Audio);
        assert_eq!(get_diff_removed(before, after).unwrap(), MediaType::Video);

        let before = MediaTrafficState::with_media_type(MediaType::Both);
        let after = MediaTrafficState::with_media_type(MediaType::Video);
        assert_eq!(get_diff_removed(before, after).unwrap(), MediaType::Audio);
    }
}