mirror of
https://github.com/sile/hls_m3u8.git
synced 2024-06-02 05:41:21 +00:00
245 lines
6.8 KiB
Rust
245 lines
6.8 KiB
Rust
use std::fmt;
|
|
use std::str::FromStr;
|
|
|
|
use crate::attribute::AttributePairs;
|
|
use crate::tags::ExtXKey;
|
|
use crate::types::{ByteRange, ProtocolVersion};
|
|
use crate::utils::{quote, tag, unquote};
|
|
use crate::{Encrypted, Error, RequiredVersion};
|
|
|
|
/// # [4.3.2.5. EXT-X-MAP]
|
|
///
|
|
/// The [`ExtXMap`] tag specifies how to obtain the Media Initialization
|
|
/// Section, required to parse the applicable [`MediaSegment`]s.
|
|
///
|
|
/// [`MediaSegment`]: crate::MediaSegment
|
|
/// [4.3.2.5. EXT-X-MAP]: https://tools.ietf.org/html/rfc8216#section-4.3.2.5
|
|
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
|
pub struct ExtXMap {
|
|
uri: String,
|
|
range: Option<ByteRange>,
|
|
keys: Vec<ExtXKey>,
|
|
}
|
|
|
|
impl ExtXMap {
|
|
pub(crate) const PREFIX: &'static str = "#EXT-X-MAP:";
|
|
|
|
/// Makes a new [`ExtXMap`] tag.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use hls_m3u8::tags::ExtXMap;
|
|
/// let map = ExtXMap::new("https://prod.mediaspace.com/init.bin");
|
|
/// ```
|
|
pub fn new<T: ToString>(uri: T) -> Self {
|
|
Self {
|
|
uri: uri.to_string(),
|
|
range: None,
|
|
keys: vec![],
|
|
}
|
|
}
|
|
|
|
/// Makes a new [`ExtXMap`] tag with the given range.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use hls_m3u8::tags::ExtXMap;
|
|
/// use hls_m3u8::types::ByteRange;
|
|
///
|
|
/// let map = ExtXMap::with_range(
|
|
/// "https://prod.mediaspace.com/init.bin",
|
|
/// ByteRange::new(9, Some(2)),
|
|
/// );
|
|
/// ```
|
|
pub fn with_range<T: ToString>(uri: T, range: ByteRange) -> Self {
|
|
Self {
|
|
uri: uri.to_string(),
|
|
range: Some(range),
|
|
keys: vec![],
|
|
}
|
|
}
|
|
|
|
/// Returns the `URI` that identifies a resource, that contains the media
|
|
/// initialization section.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use hls_m3u8::tags::ExtXMap;
|
|
/// let map = ExtXMap::new("https://prod.mediaspace.com/init.bin");
|
|
///
|
|
/// assert_eq!(
|
|
/// map.uri(),
|
|
/// &"https://prod.mediaspace.com/init.bin".to_string()
|
|
/// );
|
|
/// ```
|
|
pub const fn uri(&self) -> &String { &self.uri }
|
|
|
|
/// Sets the `URI` that identifies a resource, that contains the media
|
|
/// initialization section.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use hls_m3u8::tags::ExtXMap;
|
|
/// let mut map = ExtXMap::new("https://prod.mediaspace.com/init.bin");
|
|
///
|
|
/// map.set_uri("https://dev.mediaspace.com/init.bin");
|
|
/// assert_eq!(
|
|
/// map.uri(),
|
|
/// &"https://dev.mediaspace.com/init.bin".to_string()
|
|
/// );
|
|
/// ```
|
|
pub fn set_uri<T: ToString>(&mut self, value: T) -> &mut Self {
|
|
self.uri = value.to_string();
|
|
self
|
|
}
|
|
|
|
/// Returns the range of the media initialization section.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use hls_m3u8::tags::ExtXMap;
|
|
/// use hls_m3u8::types::ByteRange;
|
|
///
|
|
/// let map = ExtXMap::with_range(
|
|
/// "https://prod.mediaspace.com/init.bin",
|
|
/// ByteRange::new(9, Some(2)),
|
|
/// );
|
|
///
|
|
/// assert_eq!(map.range(), Some(ByteRange::new(9, Some(2))));
|
|
/// ```
|
|
pub const fn range(&self) -> Option<ByteRange> { self.range }
|
|
|
|
/// Sets the range of the media initialization section.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use hls_m3u8::tags::ExtXMap;
|
|
/// use hls_m3u8::types::ByteRange;
|
|
///
|
|
/// let mut map = ExtXMap::with_range(
|
|
/// "https://prod.mediaspace.com/init.bin",
|
|
/// ByteRange::new(9, Some(2)),
|
|
/// );
|
|
///
|
|
/// map.set_range(Some(ByteRange::new(1, None)));
|
|
/// assert_eq!(map.range(), Some(ByteRange::new(1, None)));
|
|
/// ```
|
|
pub fn set_range(&mut self, value: Option<ByteRange>) -> &mut Self {
|
|
self.range = value;
|
|
self
|
|
}
|
|
}
|
|
|
|
impl Encrypted for ExtXMap {
|
|
fn keys(&self) -> &Vec<ExtXKey> { &self.keys }
|
|
|
|
fn keys_mut(&mut self) -> &mut Vec<ExtXKey> { &mut self.keys }
|
|
}
|
|
|
|
/// This tag requires [`ProtocolVersion::V6`].
|
|
impl RequiredVersion for ExtXMap {
|
|
// this should return ProtocolVersion::V5, if it does not contain an
|
|
// EXT-X-I-FRAMES-ONLY!
|
|
// http://alexzambelli.com/blog/2016/05/04/understanding-hls-versions-and-client-compatibility/
|
|
fn required_version(&self) -> ProtocolVersion { ProtocolVersion::V6 }
|
|
|
|
fn introduced_version(&self) -> ProtocolVersion { ProtocolVersion::V5 }
|
|
}
|
|
|
|
impl fmt::Display for ExtXMap {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
write!(f, "{}", Self::PREFIX)?;
|
|
write!(f, "URI={}", quote(&self.uri))?;
|
|
|
|
if let Some(value) = &self.range {
|
|
write!(f, ",BYTERANGE={}", quote(value))?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
impl FromStr for ExtXMap {
|
|
type Err = Error;
|
|
|
|
fn from_str(input: &str) -> Result<Self, Self::Err> {
|
|
let input = tag(input, Self::PREFIX)?;
|
|
|
|
let mut uri = None;
|
|
let mut range = None;
|
|
|
|
for (key, value) in input.parse::<AttributePairs>()? {
|
|
match key.as_str() {
|
|
"URI" => uri = Some(unquote(value)),
|
|
"BYTERANGE" => {
|
|
range = Some(unquote(value).parse()?);
|
|
}
|
|
_ => {
|
|
// [6.3.1. General Client Responsibilities]
|
|
// > ignore any attribute/value pair with an unrecognized
|
|
// AttributeName.
|
|
}
|
|
}
|
|
}
|
|
|
|
let uri = uri.ok_or_else(|| Error::missing_value("EXT-X-URI"))?;
|
|
Ok(Self {
|
|
uri,
|
|
range,
|
|
keys: vec![],
|
|
})
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_display() {
|
|
assert_eq!(
|
|
ExtXMap::new("foo").to_string(),
|
|
"#EXT-X-MAP:URI=\"foo\"".to_string(),
|
|
);
|
|
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::new(9, Some(2))).to_string(),
|
|
"#EXT-X-MAP:URI=\"foo\",BYTERANGE=\"9@2\"".to_string(),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_parser() {
|
|
assert_eq!(
|
|
ExtXMap::new("foo"),
|
|
"#EXT-X-MAP:URI=\"foo\"".parse().unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::new(9, Some(2))),
|
|
"#EXT-X-MAP:URI=\"foo\",BYTERANGE=\"9@2\"".parse().unwrap()
|
|
);
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::new(9, Some(2))),
|
|
"#EXT-X-MAP:URI=\"foo\",BYTERANGE=\"9@2\",UNKNOWN=IGNORED"
|
|
.parse()
|
|
.unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_required_version() {
|
|
assert_eq!(ExtXMap::new("foo").required_version(), ProtocolVersion::V6);
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::new(9, Some(2))).required_version(),
|
|
ProtocolVersion::V6
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_encrypted() {
|
|
assert_eq!(ExtXMap::new("foo").keys(), &vec![]);
|
|
assert_eq!(ExtXMap::new("foo").keys_mut(), &mut vec![]);
|
|
}
|
|
}
|