m3u8

Python m3u8 parser

Project description

Python m3u8 parser.

Documentation

Loading a playlist

To load a playlist into an object from uri, file path or directly from string, use the load/loads functions:

import m3u8

playlist = m3u8.load('http://videoserver.com/playlist.m3u8')  # this could also be an absolute filename
print(playlist.segments)
print(playlist.target_duration)

# if you already have the content as string, use

playlist = m3u8.loads('#EXTM3U8 ... etc ... ')

Dumping a playlist

To dump a playlist from an object to the console or a file, use the dump/dumps functions:

import m3u8

playlist = m3u8.load('http://videoserver.com/playlist.m3u8')
print(playlist.dumps())

# if you want to write a file from its content

playlist.dump('playlist.m3u8')

Supported tags

Encryption keys

The segments may be or not encrypted. The keys attribute list will be a list with all the different keys as described with #EXT-X-KEY:

Each key has the next properties:

method: ex.: “AES-128”
uri: the key uri, ex.: “http://videoserver.com/key.bin”
iv: the initialization vector, if available. Otherwise None.

If no #EXT-X-KEY is found, the keys list will have a unique element None. Multiple keys are supported.

If unencrypted and encrypted segments are mixed in the M3U8 file, then the list will contain a None element, with one or more keys afterwards.

To traverse the list of keys available:

import m3u8

m3u8_obj = m3u8.loads('#EXTM3U8 ... etc ...')
len(m3u8_obj.keys) => returns the number of keys available in the list (normally 1)
for key in m3u8_obj.keys:
   if key:  # First one could be None
      key.uri
      key.method
      key.iv

Getting segments encrypted with one key

There are cases where listing segments for a given key is important. It’s possible to retrieve the list of segments encrypted with one key via by_key method in the segments list.

Example of getting the segments with no encryption:

import m3u8

m3u8_obj = m3u8.loads('#EXTM3U8 ... etc ...')
segmk1 = m3u8_obj.segments.by_key(None)

# Get the list of segments encrypted using last key
segm = m3u8_obj.segments.by_key( m3u8_obj.keys[-1] )

With this method, is now possible also to change the key from some of the segments programmatically:

import m3u8

m3u8_obj = m3u8.loads('#EXTM3U8 ... etc ...')

# Create a new Key and replace it
new_key = m3u8.Key("AES-128", "/encrypted/newkey.bin", None, iv="0xf123ad23f22e441098aa87ee")
for segment in m3u8_obj.segments.by_key( m3u8_obj.keys[-1] ):
    segm.key = new_key
# Remember to sync the key from the list as well
m3u8_obj.keys[-1] = new_key

Variant playlists (variable bitrates)

A playlist can have a list to other playlist files, this is used to represent multiple bitrates videos, and it’s called variant streams. See an example here.

variant_m3u8 = m3u8.loads('#EXTM3U8 ... contains a variant stream ...')
variant_m3u8.is_variant    # in this case will be True

for playlist in variant_m3u8.playlists:
    playlist.uri
    playlist.stream_info.bandwidth

the playlist object used in the for loop above has a few attributes:

uri: the url to the stream
stream_info: a StreamInfo object (actually a namedtuple) with all the attributes available to #EXT-X-STREAM-INF
media: a list of related Media objects with all the attributes available to #EXT-X-MEDIA
playlist_type: the type of the playlist, which can be one of VOD (video on demand) or EVENT

NOTE: the following attributes are not implemented yet, follow issue 4 for updates

alternative_audios: its an empty list, unless it’s a playlist with Alternative audio, in this case it’s a list with Media objects with all the attributes available to #EXT-X-MEDIA
alternative_videos: same as alternative_audios

A variant playlist can also have links to I-frame playlists, which are used to specify where the I-frames are in a video. See Apple’s documentation on this for more information. These I-frame playlists can be accessed in a similar way to regular playlists.

variant_m3u8 = m3u8.loads('#EXTM3U ... contains a variant stream ...')

for iframe_playlist in variant_m3u8.iframe_playlists:
    iframe_playlist.uri
    iframe_playlist.iframe_stream_info.bandwidth

The iframe_playlist object used in the for loop above has a few attributes:

uri: the url to the I-frame playlist
base_uri: the base uri of the variant playlist (if given)
iframe_stream_info: a StreamInfo object (same as a regular playlist)

Custom tags

Quoting the documentation:

Lines that start with the character '#' are either comments or tags.
Tags begin with #EXT.  They are case-sensitive.  All other lines that
begin with '#' are comments and SHOULD be ignored.

This library ignores all the non standard tags by default. If you want them to be collected while loading the file content, you need to pass a function to the load/loads functions, following the example below:

import m3u8

def get_movie(line, data, lineno):
    if line.startswith('#MOVIE-NAME:'):
        custom_tag = line.split(':')
        data['movie'] = custom_tag[1].strip()

m3u8_obj = m3u8.load('http://videoserver.com/playlist.m3u8', custom_tags_parser=get_movie)
print(m3u8_obj.data['movie'])  #  million dollar baby

Running Tests

$ ./runtests

Contributing

All contribution is welcome, but we will merge a pull request if, and only if, it

has tests
follows the code conventions

If you plan to implement a new feature or something that will take more than a few minutes, please open an issue to make sure we don’t work on the same thing.

Project details

Release history Release notifications | RSS feed

6.0.0

Aug 7, 2024

5.3.0

Aug 2, 2024

5.2.0

Jul 30, 2024

5.1.0

Jun 21, 2024

5.0.0

May 14, 2024

4.1.0

Apr 1, 2024

4.0.0

Dec 12, 2023

3.6.0

Sep 9, 2023

3.5.0

May 10, 2023

3.4.0

Dec 29, 2022

3.3.0

Aug 20, 2022

3.2.0

Aug 11, 2022

3.1.0

Aug 1, 2022

3.0.0

Jul 25, 2022

2.0.0

Apr 28, 2022

1.0.0

Jan 14, 2022

0.10.0

Jan 12, 2022

0.9.0

Jun 1, 2021

0.8.0

Dec 23, 2020

0.7.1

Aug 6, 2020

0.7.0

Jul 20, 2020

This version

0.6.0

May 4, 2020

0.5.4

Jan 19, 2020

0.5.3

Dec 8, 2019

0.5.2

Nov 16, 2019

0.5.1

Nov 4, 2019

0.5.0

Sep 30, 2019

0.4.0

Sep 12, 2019

0.3.12

Aug 16, 2019

0.3.11

Aug 1, 2019

0.3.10

Jun 20, 2019

0.3.9

May 20, 2019

0.3.8

Apr 8, 2019

0.3.7

Dec 6, 2018

0.3.6

Oct 13, 2018

0.3.5

Nov 9, 2017

0.3.4

Oct 15, 2017

0.3.3

Aug 31, 2017

0.3.2

Apr 12, 2017

0.3.1

Jan 19, 2017

0.3.0

Oct 5, 2016

0.2.11

Sep 28, 2016

0.2.10

Aug 8, 2016

0.2.9

Jul 4, 2016

0.2.8

Oct 20, 2015

0.2.7

Oct 16, 2015

0.2.6

Sep 20, 2015

0.2.5

Jul 15, 2015

0.2.4

Mar 3, 2015

0.2.3

Feb 19, 2015

0.2.2

Sep 8, 2014

0.2.1

Sep 8, 2014

0.2.0

Sep 5, 2014

0.1.9

Aug 20, 2014

0.1.8

Aug 19, 2014

0.1.6

Aug 6, 2013

0.1.5

Aug 6, 2013

0.1.4

Oct 8, 2012

0.1.3

Sep 27, 2012

0.1.1

May 21, 2012

0.1.0

May 18, 2012

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

m3u8-0.6.0.tar.gz (22.4 kB view details)

Uploaded May 4, 2020 Source

Built Distribution

m3u8-0.6.0-py3-none-any.whl (20.8 kB view details)

Uploaded May 4, 2020 Python 3

File details

Details for the file m3u8-0.6.0.tar.gz.

File metadata

Download URL: m3u8-0.6.0.tar.gz
Upload date: May 4, 2020
Size: 22.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.6

File hashes

Hashes for m3u8-0.6.0.tar.gz
Algorithm	Hash digest
SHA256	`05823b6161b40a9ec1a6535a301c439019d2070d2a150bb7157ced3ee0aa4316`
MD5	`93b7421553ed79b133834cd860689073`
BLAKE2b-256	`6133d8fc875cd6b2e7e9af7e89b13967dbe34504fd6043b0a09f70cb299856d7`

See more details on using hashes here.

File details

Details for the file m3u8-0.6.0-py3-none-any.whl.

File metadata

Download URL: m3u8-0.6.0-py3-none-any.whl
Upload date: May 4, 2020
Size: 20.8 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.6

File hashes

Hashes for m3u8-0.6.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`b37ca561bcf6a16a6e6865e2f225befade3368a6679316a1a4c19c942674275e`
MD5	`64dbf21da6dfcb3f0ed8134a544ed7a1`
BLAKE2b-256	`2829aa66f3347c2e9cd04462a3fc3823ddb355e6b262ed0e7c28f633813c4d9f`