moq-mux 0.5.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

//! Filename-style format extensions for broadcast names.
//!
//! Broadcast names use a filename-style suffix to advertise their catalog format,
//! e.g. `demo/bbb.hang` or `demo/bbb.msf`. Consumers parse the suffix to pick a
//! catalog track without explicit configuration; publishers should include the
//! suffix in the name they publish so consumers can detect it.

/// The catalog format advertised by a broadcast name suffix.
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum CatalogFormat {
	/// `hang` JSON catalog (track `catalog.json`).
	#[default]
	Hang,
	/// MSF catalog (track `catalog`).
	Msf,
}

impl CatalogFormat {
	/// The fallback used when a broadcast name has no recognized extension.
	///
	/// Matches `<Self as Default>::default()`.
	pub const DEFAULT: Self = Self::Hang;

	/// The filename-style suffix (including leading dot) for this format.
	pub fn extension(self) -> &'static str {
		match self {
			Self::Hang => ".hang",
			Self::Msf => ".msf",
		}
	}

	/// Detect the catalog format from a broadcast name suffix.
	///
	/// Returns `None` if the name has no recognized extension.
	pub fn detect(name: &str) -> Option<Self> {
		if name.ends_with(Self::Hang.extension()) {
			Some(Self::Hang)
		} else if name.ends_with(Self::Msf.extension()) {
			Some(Self::Msf)
		} else {
			None
		}
	}
}

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

	#[test]
	fn detect_hang() {
		assert_eq!(CatalogFormat::detect("demo/bbb.hang"), Some(CatalogFormat::Hang));
		assert_eq!(CatalogFormat::detect("bbb.hang"), Some(CatalogFormat::Hang));
	}

	#[test]
	fn detect_msf() {
		assert_eq!(CatalogFormat::detect("demo/bbb.msf"), Some(CatalogFormat::Msf));
	}

	#[test]
	fn detect_none() {
		assert_eq!(CatalogFormat::detect("demo/bbb"), None);
		assert_eq!(CatalogFormat::detect(""), None);
		assert_eq!(CatalogFormat::detect("demo/foo.v2"), None);
	}
}