Crate m3u8_rs

Expand description

A library to parse m3u8 playlists HTTP Live Streaming.

§Examples

Parsing a playlist and let the parser figure out if it’s a media or master playlist.

use m3u8_rs::Playlist;
use nom::IResult;
use std::io::Read;

let mut file = std::fs::File::open("playlist.m3u8").unwrap();
let mut bytes: Vec<u8> = Vec::new();
file.read_to_end(&mut bytes).unwrap();

match m3u8_rs::parse_playlist(&bytes) {
    Result::Ok((i, Playlist::MasterPlaylist(pl))) => println!("Master playlist:\n{:?}", pl),
    Result::Ok((i, Playlist::MediaPlaylist(pl))) => println!("Media playlist:\n{:?}", pl),
    Result::Err(e) =>  panic!("Parsing error: \n{}", e),
}

Parsing a master playlist directly

use std::io::Read;
use nom::IResult;

let mut file = std::fs::File::open("masterplaylist.m3u8").unwrap();
let mut bytes: Vec<u8> = Vec::new();
file.read_to_end(&mut bytes).unwrap();

if let Result::Ok((_, pl)) = m3u8_rs::parse_master_playlist(&bytes) {
    println!("{:?}", pl);
}

Creating a playlist and writing it back to a vec/file

use m3u8_rs::{MediaPlaylist, MediaPlaylistType, MediaSegment};

let playlist = MediaPlaylist {
    version: Some(6),
    target_duration: 3,
    media_sequence: 338559,
    discontinuity_sequence: 1234,
    end_list: true,
    playlist_type: Some(MediaPlaylistType::Vod),
    segments: vec![
        MediaSegment {
            uri: "20140311T113819-01-338559live.ts".into(),
            duration: 2.002,
            title: Some("title".into()),
            ..Default::default()
        },
    ],
    ..Default::default()
};

//let mut v: Vec<u8> = Vec::new();
//playlist.write_to(&mut v).unwrap();

//let mut file = std::fs::File::open("playlist.m3u8").unwrap();
//playlist.write_to(&mut file).unwrap();

Controlling the output precision for floats, such as #EXTINF (default is unset)

use std::sync::atomic::Ordering;
use m3u8_rs::{WRITE_OPT_FLOAT_PRECISION, MediaPlaylist, MediaSegment};

WRITE_OPT_FLOAT_PRECISION.store(5, Ordering::Relaxed);

let playlist = MediaPlaylist {
    target_duration: 3,
    segments: vec![
        MediaSegment {
            duration: 2.9,
            title: Some("title".into()),
            ..Default::default()
        },
    ],
    ..Default::default()
};

let mut v: Vec<u8> = Vec::new();

playlist.write_to(&mut v).unwrap();
let m3u8_str: &str = std::str::from_utf8(&v).unwrap();
assert!(m3u8_str.contains("#EXTINF:2.90000,title"));

Structs§

AlternativeMedia: #EXT-X-MEDIA:<attribute-list>
ByteRange: #EXT-X-BYTERANGE:<n>[@<o>]
DateRange: #EXT-X-DATERANGE:<attribute-list>
ExtTag: A simple #EXT- tag
Key: #EXT-X-KEY:<attribute-list>
Map: #EXT-X-MAP:<attribute-list>
MasterPlaylist: A Master Playlist provides a set of Variant Streams, each of which describes a different version of the same content.
MediaPlaylist: A Media Playlist contains a list of Media Segments, which when played sequentially will play the multimedia presentation.
MediaSegment: A Media Segment is specified by a URI and optionally a byte range.
Resolution
SessionData: #EXT-X-SESSION-DATA:<attribute-list> The EXT-X-SESSION-DATA tag allows arbitrary session data to be carried in a Master Playlist.
SessionKey: #EXT-X-SESSION-KEY:<attribute-list> The EXT-X-SESSION-KEY tag allows encryption keys from Media Playlists to be specified in a Master Playlist. This allows the client to preload these keys without having to read the Media Playlist(s) first.
Start: #EXT-X-START:<attribute-list>
VariantStream: #EXT-X-STREAM-INF:<attribute-list> <URI> #EXT-X-I-FRAME-STREAM-INF:<attribute-list>

Enums§

AlternativeMediaType
ClosedCaptionGroupId: TODO docs
HDCPLevel
InstreamId
KeyMethod
MediaPlaylistType: #EXT-X-PLAYLIST-TYPE:<EVENT|VOD>
Playlist: Playlist, can either be a MasterPlaylist or a MediaPlaylist.
QuotedOrUnquoted
SessionDataField

Statics§

WRITE_OPT_FLOAT_PRECISION: The output precision for floats, such as #EXTINF (default is unset)

Functions§