moq-mux 0.7.2

Media muxers and demuxers for MoQ
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

//! Track selection.
//!
//! [`Broadcast`] picks which renditions of a broadcast to keep. It is purely
//! additive: a default [`Broadcast`] selects *nothing*, and you opt a role in with
//! [`video`](Broadcast::video) / [`audio`](Broadcast::audio). Within an opted-in
//! role, an empty field matches everything; listing values keeps renditions matching
//! any one of them (a union within a field, intersected across fields).
//!
//! The same [`Broadcast`] drives selection at either end of the pipeline: narrowing
//! a published catalog on the consume side (see [`catalog::Select`](crate::catalog::Select)),
//! or choosing which tracks to publish on the import side.

use hang::catalog::{AudioCodecKind, AudioConfig, VideoCodecKind, VideoConfig};

use crate::catalog::hang::{Catalog, CatalogExt};

/// Which renditions of a broadcast to keep.
///
/// Defaults to selecting nothing. Opt a role in with [`video`](Self::video) /
/// [`audio`](Self::audio); an unselected role is dropped entirely.
#[derive(Clone, Debug, Default)]
pub struct Broadcast {
	video: Option<Video>,
	audio: Option<Audio>,
}

impl Broadcast {
	/// Select video, narrowed by `video`. A default [`Video`] keeps every video rendition.
	pub fn video(mut self, video: Video) -> Self {
		self.video = Some(video);
		self
	}

	/// Select audio, narrowed by `audio`. A default [`Audio`] keeps every audio rendition.
	pub fn audio(mut self, audio: Audio) -> Self {
		self.audio = Some(audio);
		self
	}

	/// Whether any video is selected.
	pub fn has_video(&self) -> bool {
		self.video.is_some()
	}

	/// Whether any audio is selected.
	pub fn has_audio(&self) -> bool {
		self.audio.is_some()
	}

	/// Drop every rendition from `catalog` that isn't selected.
	pub fn retain<E: CatalogExt>(&self, catalog: &mut Catalog<E>) {
		match &self.video {
			Some(video) => catalog
				.video
				.renditions
				.retain(|name, config| video.matches(name, config)),
			None => catalog.video.renditions.clear(),
		}
		match &self.audio {
			Some(audio) => catalog
				.audio
				.renditions
				.retain(|name, config| audio.matches(name, config)),
			None => catalog.audio.renditions.clear(),
		}
	}
}

/// Video rendition criteria. An empty field matches every rendition.
#[derive(Clone, Debug, Default)]
pub struct Video {
	name: Vec<String>,
	codec: Vec<VideoCodecKind>,
}

impl Video {
	/// Also accept the rendition with this exact name. Repeatable; empty = any name.
	pub fn name(mut self, name: impl Into<String>) -> Self {
		self.name.push(name.into());
		self
	}

	/// Also accept renditions of this codec. Repeatable; empty = any codec.
	pub fn codec(mut self, codec: VideoCodecKind) -> Self {
		self.codec.push(codec);
		self
	}

	fn matches(&self, name: &str, config: &VideoConfig) -> bool {
		(self.name.is_empty() || self.name.iter().any(|n| n == name))
			&& (self.codec.is_empty() || self.codec.contains(&config.codec.kind()))
	}
}

/// Audio rendition criteria. An empty field matches every rendition.
#[derive(Clone, Debug, Default)]
pub struct Audio {
	name: Vec<String>,
	codec: Vec<AudioCodecKind>,
}

impl Audio {
	/// Also accept the rendition with this exact name. Repeatable; empty = any name.
	pub fn name(mut self, name: impl Into<String>) -> Self {
		self.name.push(name.into());
		self
	}

	/// Also accept renditions of this codec. Repeatable; empty = any codec.
	pub fn codec(mut self, codec: AudioCodecKind) -> Self {
		self.codec.push(codec);
		self
	}

	fn matches(&self, name: &str, config: &AudioConfig) -> bool {
		(self.name.is_empty() || self.name.iter().any(|n| n == name))
			&& (self.codec.is_empty() || self.codec.contains(&config.codec.kind()))
	}
}

#[cfg(test)]
mod tests {
	use std::collections::BTreeMap;

	use hang::catalog::{AudioCodec, AudioConfig, Container, H264, VP9, VideoConfig};

	use super::*;

	fn h264(name: &str) -> (String, VideoConfig) {
		let mut config = VideoConfig::new(H264 {
			profile: 0x42,
			constraints: 0,
			level: 0x1e,
			inline: false,
		});
		config.container = Container::Legacy;
		(name.to_string(), config)
	}

	fn vp9(name: &str) -> (String, VideoConfig) {
		let mut config = VideoConfig::new(VP9 {
			profile: 0,
			level: 10,
			bit_depth: 8,
			chroma_subsampling: 1,
			color_primaries: 1,
			transfer_characteristics: 1,
			matrix_coefficients: 1,
			full_range: false,
		});
		config.container = Container::Legacy;
		(name.to_string(), config)
	}

	fn opus(name: &str) -> (String, AudioConfig) {
		let mut config = AudioConfig::new(AudioCodec::Opus, 48_000, 2);
		config.container = Container::Legacy;
		(name.to_string(), config)
	}

	fn catalog(video: Vec<(String, VideoConfig)>, audio: Vec<(String, AudioConfig)>) -> Catalog {
		let mut catalog = Catalog::default();
		catalog.video.renditions = BTreeMap::from_iter(video);
		catalog.audio.renditions = BTreeMap::from_iter(audio);
		catalog
	}

	fn video_names(catalog: &Catalog) -> Vec<&str> {
		catalog.video.renditions.keys().map(String::as_str).collect()
	}

	fn audio_names(catalog: &Catalog) -> Vec<&str> {
		catalog.audio.renditions.keys().map(String::as_str).collect()
	}

	#[test]
	fn default_selects_nothing() {
		let mut catalog = catalog(vec![h264("v")], vec![opus("a")]);
		Broadcast::default().retain(&mut catalog);
		assert!(catalog.video.renditions.is_empty());
		assert!(catalog.audio.renditions.is_empty());
	}

	#[test]
	fn empty_axis_keeps_everything() {
		let mut catalog = catalog(vec![h264("lo"), h264("hi")], vec![opus("a")]);
		Broadcast::default().video(Video::default()).retain(&mut catalog);
		assert_eq!(video_names(&catalog), vec!["hi", "lo"]);
		// Audio was never selected, so it's dropped.
		assert!(catalog.audio.renditions.is_empty());
	}

	#[test]
	fn video_only_drops_audio() {
		let mut catalog = catalog(vec![h264("v")], vec![opus("a")]);
		Broadcast::default().video(Video::default()).retain(&mut catalog);
		assert_eq!(video_names(&catalog), vec!["v"]);
		assert!(catalog.audio.renditions.is_empty());
	}

	#[test]
	fn name_matches_exact() {
		let mut catalog = catalog(vec![h264("lo"), h264("hi")], vec![]);
		Broadcast::default()
			.video(Video::default().name("hi"))
			.retain(&mut catalog);
		assert_eq!(video_names(&catalog), vec!["hi"]);
	}

	#[test]
	fn names_union_within_field() {
		let mut catalog = catalog(vec![], vec![opus("en"), opus("es"), opus("fr")]);
		Broadcast::default()
			.audio(Audio::default().name("en").name("es"))
			.retain(&mut catalog);
		assert_eq!(audio_names(&catalog), vec!["en", "es"]);
	}

	#[test]
	fn codec_filters_within_selected_axis() {
		let mut catalog = catalog(vec![h264("a"), vp9("b"), h264("c")], vec![]);
		Broadcast::default()
			.video(Video::default().codec(VideoCodecKind::H264))
			.retain(&mut catalog);
		assert_eq!(video_names(&catalog), vec!["a", "c"]);
	}

	#[test]
	fn codecs_union_within_field() {
		let mut catalog = catalog(vec![h264("a"), vp9("b")], vec![]);
		Broadcast::default()
			.video(Video::default().codec(VideoCodecKind::H264).codec(VideoCodecKind::VP9))
			.retain(&mut catalog);
		assert_eq!(video_names(&catalog), vec!["a", "b"]);
	}

	#[test]
	fn name_and_codec_intersect() {
		let mut catalog = catalog(vec![h264("hi"), vp9("hi2"), h264("lo")], vec![]);
		// name in {hi, hi2} AND codec H264 -> only "hi".
		Broadcast::default()
			.video(Video::default().name("hi").name("hi2").codec(VideoCodecKind::H264))
			.retain(&mut catalog);
		assert_eq!(video_names(&catalog), vec!["hi"]);
	}
}