mirror of
https://github.com/sile/hls_m3u8.git
synced 2024-05-03 09:09:06 +00:00
223 lines
6.8 KiB
Rust
223 lines
6.8 KiB
Rust
use std::borrow::Cow;
|
|
use std::convert::{TryFrom, TryInto};
|
|
use std::fmt;
|
|
|
|
use shorthand::ShortHand;
|
|
|
|
use crate::attribute::AttributePairs;
|
|
use crate::tags::ExtXKey;
|
|
use crate::types::{ByteRange, DecryptionKey, ProtocolVersion};
|
|
use crate::utils::{quote, tag, unquote};
|
|
use crate::{Decryptable, Error, RequiredVersion};
|
|
|
|
/// The [`ExtXMap`] tag specifies how to obtain the [Media Initialization
|
|
/// Section], required to parse the applicable [`MediaSegment`]s.
|
|
///
|
|
/// It applies to every [`MediaSegment`] that appears after it in the playlist
|
|
/// until the next [`ExtXMap`] tag or until the end of the playlist.
|
|
///
|
|
/// An [`ExtXMap`] tag should be supplied for [`MediaSegment`]s in playlists
|
|
/// with the [`ExtXIFramesOnly`] tag when the first [`MediaSegment`] (i.e.,
|
|
/// I-frame) in the playlist (or the first segment following an
|
|
/// [`ExtXDiscontinuity`] tag) does not immediately follow the Media
|
|
/// Initialization Section at the beginning of its resource.
|
|
///
|
|
/// If the Media Initialization Section declared by an [`ExtXMap`] tag is
|
|
/// encrypted with [`EncryptionMethod::Aes128`], the IV attribute of
|
|
/// the [`ExtXKey`] tag that applies to the [`ExtXMap`] is required.
|
|
///
|
|
/// [Media Initialization Section]: https://tools.ietf.org/html/rfc8216#section-3
|
|
/// [`MediaSegment`]: crate::MediaSegment
|
|
/// [`ExtXIFramesOnly`]: crate::tags::ExtXIFramesOnly
|
|
/// [`ExtXDiscontinuity`]: crate::tags::ExtXDiscontinuity
|
|
/// [`EncryptionMethod::Aes128`]: crate::types::EncryptionMethod::Aes128
|
|
/// [`MediaPlaylist`]: crate::MediaPlaylist
|
|
#[derive(ShortHand, Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
|
#[shorthand(enable(must_use, into))]
|
|
pub struct ExtXMap<'a> {
|
|
/// The `URI` that identifies a resource, that contains the media
|
|
/// initialization section.
|
|
uri: Cow<'a, str>,
|
|
/// The range of the media initialization section.
|
|
#[shorthand(enable(copy))]
|
|
range: Option<ByteRange>,
|
|
#[shorthand(enable(skip))]
|
|
pub(crate) keys: Vec<ExtXKey<'a>>,
|
|
}
|
|
|
|
impl<'a> ExtXMap<'a> {
|
|
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");
|
|
/// ```
|
|
#[must_use]
|
|
pub fn new<T: Into<Cow<'a, str>>>(uri: T) -> Self {
|
|
Self {
|
|
uri: uri.into(),
|
|
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", 2..11);
|
|
/// ```
|
|
#[must_use]
|
|
pub fn with_range<I: Into<Cow<'a, str>>, B: Into<ByteRange>>(uri: I, range: B) -> Self {
|
|
Self {
|
|
uri: uri.into(),
|
|
range: Some(range.into()),
|
|
keys: vec![],
|
|
}
|
|
}
|
|
|
|
/// Makes the struct independent of its lifetime, by taking ownership of all
|
|
/// internal [`Cow`]s.
|
|
///
|
|
/// # Note
|
|
///
|
|
/// This is a relatively expensive operation.
|
|
#[must_use]
|
|
pub fn into_owned(self) -> ExtXMap<'static> {
|
|
ExtXMap {
|
|
uri: Cow::Owned(self.uri.into_owned()),
|
|
range: self.range,
|
|
keys: self.keys.into_iter().map(|v| v.into_owned()).collect(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a> Decryptable<'a> for ExtXMap<'a> {
|
|
fn keys(&self) -> Vec<&DecryptionKey<'a>> {
|
|
//
|
|
self.keys.iter().filter_map(ExtXKey::as_ref).collect()
|
|
}
|
|
}
|
|
|
|
/// Use of the [`ExtXMap`] tag in a [`MediaPlaylist`] that contains the
|
|
/// [`ExtXIFramesOnly`] tag requires [`ProtocolVersion::V5`] or
|
|
/// greater. Use of the [`ExtXMap`] tag in a [`MediaPlaylist`] that does not
|
|
/// contain the [`ExtXIFramesOnly`] tag requires [`ProtocolVersion::V6`] or
|
|
/// greater.
|
|
///
|
|
/// [`ExtXIFramesOnly`]: crate::tags::ExtXIFramesOnly
|
|
/// [`MediaPlaylist`]: crate::MediaPlaylist
|
|
impl<'a> RequiredVersion for ExtXMap<'a> {
|
|
// 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<'a> fmt::Display for ExtXMap<'a> {
|
|
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<'a> TryFrom<&'a str> for ExtXMap<'a> {
|
|
type Error = Error;
|
|
|
|
fn try_from(input: &'a str) -> Result<Self, Self::Error> {
|
|
let input = tag(input, Self::PREFIX)?;
|
|
|
|
let mut uri = None;
|
|
let mut range = None;
|
|
|
|
for (key, value) in AttributePairs::new(input) {
|
|
match key {
|
|
"URI" => uri = Some(unquote(value)),
|
|
"BYTERANGE" => {
|
|
range = Some(unquote(value).try_into()?);
|
|
}
|
|
_ => {
|
|
// [6.3.1. General Client Responsibilities]
|
|
// > ignore any attribute/value pair with an unrecognized
|
|
// AttributeName.
|
|
}
|
|
}
|
|
}
|
|
|
|
let uri = uri.ok_or_else(|| Error::missing_value("URI"))?;
|
|
|
|
Ok(Self {
|
|
uri,
|
|
range,
|
|
keys: vec![],
|
|
})
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
#[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::from(2..11)).to_string(),
|
|
"#EXT-X-MAP:URI=\"foo\",BYTERANGE=\"9@2\"".to_string(),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_parser() {
|
|
assert_eq!(
|
|
ExtXMap::new("foo"),
|
|
ExtXMap::try_from("#EXT-X-MAP:URI=\"foo\"").unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::from(2..11)),
|
|
ExtXMap::try_from("#EXT-X-MAP:URI=\"foo\",BYTERANGE=\"9@2\"").unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::from(2..11)),
|
|
ExtXMap::try_from("#EXT-X-MAP:URI=\"foo\",BYTERANGE=\"9@2\",UNKNOWN=IGNORED").unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_required_version() {
|
|
assert_eq!(ExtXMap::new("foo").required_version(), ProtocolVersion::V6);
|
|
assert_eq!(
|
|
ExtXMap::with_range("foo", ByteRange::from(2..11)).required_version(),
|
|
ProtocolVersion::V6
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_decryptable() {
|
|
assert_eq!(ExtXMap::new("foo").keys(), Vec::<&DecryptionKey<'_>>::new());
|
|
}
|
|
}
|