Description
This is the most complete opensource library for parsing and generating of M3U8 playlists used in HTTP Live Streaming (Apple HLS) for internet video translations.
M3U8 alternatives and similar packages
Based on the "Video" category.
Alternatively, view M3U8 alternatives based on common mentions on social networks and blogs.
-
go-m3u8
Parse and generate m3u8 playlists for Apple HTTP Live Streaming (HLS) in Golang (ported from gem https://github.com/sethdeckard/m3u8)
InfluxDB - Purpose built for real-time analytics at any scale.
Do you think we are missing an alternative of M3U8 or a related project?
Popular Comparisons
README
<!--- mode:markdown --->
M3U8
This is the most complete opensource library for parsing and generating of M3U8 playlists used in HTTP Live Streaming (Apple HLS) for internet video translations.
M3U8 is simple text format and parsing library for it must be simple too. It does not offer ways to play HLS or handle playlists over HTTP. So library features are:
- Support HLS specs up to version 5 of the protocol.
- Parsing and generation of master-playlists and media-playlists.
- Autodetect input streams as master or media playlists.
- Offer structures for keeping playlists metadata.
- Encryption keys support for use with DRM systems like Verimatrix etc.
- Support for non standard Google Widevine tags.
The library covered by BSD 3-clause license. See [LICENSE](LICENSE) for the full text. Versions 0.8 and below was covered by GPL v3. License was changed from the version 0.9 and upper.
See the list of the library authors at [AUTHORS](AUTHORS) file.
Install
go get github.com/grafov/m3u8
or get releases from https://github.com/grafov/m3u8/releases
Documentation
Package online documentation (examples included) available at:
Supported by the HLS protocol tags and their library support explained in [M3U8 cheatsheet](M3U8.md).
Examples
Parse playlist:
f, err := os.Open("playlist.m3u8")
if err != nil {
panic(err)
}
p, listType, err := m3u8.DecodeFrom(bufio.NewReader(f), true)
if err != nil {
panic(err)
}
switch listType {
case m3u8.MEDIA:
mediapl := p.(*m3u8.MediaPlaylist)
fmt.Printf("%+v\n", mediapl)
case m3u8.MASTER:
masterpl := p.(*m3u8.MasterPlaylist)
fmt.Printf("%+v\n", masterpl)
}
Then you get filled with parsed data structures. For master playlists you get Master
struct with slice consists of pointers to Variant
structures (which represent playlists to each bitrate).
For media playlist parser returns MediaPlaylist
structure with slice of Segments
. Each segment is of MediaSegment
type.
See structure.go
or full documentation (link below).
You may use API methods to fill structures or create them manually to generate playlists. Example of media playlist generation:
p, e := m3u8.NewMediaPlaylist(3, 10) // with window of size 3 and capacity 10
if e != nil {
panic(fmt.Sprintf("Creating of media playlist failed: %s", e))
}
for i := 0; i < 5; i++ {
e = p.Append(fmt.Sprintf("test%d.ts", i), 6.0, "")
if e != nil {
panic(fmt.Sprintf("Add segment #%d to a media playlist failed: %s", i, e))
}
}
fmt.Println(p.Encode().String())
Custom Tags
M3U8 supports parsing and writing of custom tags. You must implement both the CustomTag
and CustomDecoder
interface for each custom tag that may be encountered in the playlist. Look at the template files in example/template/
for examples on parsing custom playlist and segment tags.
Library structure
Library has compact code and bundled in three files:
structure.go
โ declares all structures related to playlists and their propertiesreader.go
โ playlist parser methodswriter.go
โ playlist generator methods
Each file has own test suite placed in *_test.go
accordingly.
Related links
- http://en.wikipedia.org/wiki/M3U
- http://en.wikipedia.org/wiki/HTTP_Live_Streaming
- http://gonze.com/playlists/playlist-format-survey.html
Library usage
This library was successfully used in streaming software developed for company where I worked several years ago. It was tested then in generating of VOD and Live streams and parsing of Widevine Live streams. Also the library used in opensource software so you may look at these apps for usage examples:
Project status
Code coverage: https://gocover.io/github.com/grafov/m3u8
Project maintainers:
- Lei Gao @leikao
- Bradley Falzon @bradleyfalzon
- Alexander Grafov @grafov
Roadmap
To version 1.0:
- Support all M3U8 tags up to latest version of specs.
- Code coverage by unit tests up to 90%
FYI M3U8 parsing/generation in other languages
- https://github.com/globocom/m3u8 in Python
- https://github.com/zencoder/m3uzi in Ruby
- https://github.com/Jeanvf/M3U8Paser in Objective C
- https://github.com/tedconf/node-m3u8 in Javascript
- http://sourceforge.net/projects/m3u8parser/ in Java
- https://github.com/karlll/erlm3u8 in Erlang
*Note that all licence references and agreements mentioned in the M3U8 README section above
are relevant to that project's source code only.