8000 Persist EXT-OATCLS-SCTE35 in Segment.dumps by bbayles · Pull Request #290 · globocom/m3u8 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Persist EXT-OATCLS-SCTE35 in Segment.dumps #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 5, 2022
Merged

Persist EXT-OATCLS-SCTE35 in Segment.dumps #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
354aeca
Add support for EXT-OATCLS-SCTE35
bbayles Aug 1, 2022
1fec9f6
Insert EXT-OATCLS-SCTE35 during cue out start only
bbayles Aug 1, 2022
52d42e4
Thorough testing of scte35 and oatcls_scte35
bbayles Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions m3u8/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@
import os
import errno

from m3u8.protocol import ext_x_start, ext_x_key, ext_x_session_key, ext_x_map
from m3u8.protocol import (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you!

ext_x_key,
ext_x_map,
ext_oatcls_scte35,
ext_x_session_key,
ext_x_start,
)
from m3u8.parser import parse, format_date_time
from m3u8.mixins import BasePathMixin, GroupedBasePathMixin

Expand Down Expand Up @@ -443,8 +449,8 @@ class Segment(BasePathMixin):
def __init__(self, uri=None, base_uri=None, program_date_time=None, current_program_date_time=None,
duration=None, title=None, bitrate=None, byterange=None, cue_out=False,
cue_out_start=False, cue_in=False, discontinuity=False, key=None, scte35=None,
scte35_duration=None, scte35_elapsedtime=None, keyobject=None, parts=None,
init_section=None, dateranges=None, gap_tag=None, custom_parser_values=None):
oatcls_scte35=None, scte35_duration=None, scte35_elapsedtime=None, keyobject=None,
parts=None, init_section=None, dateranges=None, gap_tag=None, custom_parser_values=None):
self.uri = uri
self.duration = duration
self.title = title
Expand All @@ -458,6 +464,7 @@ def __init__(self, uri=None, base_uri=None, program_date_time=None, current_prog
self.cue_out = cue_out
self.cue_in = cue_in
self.scte35 = scte35
self.oatcls_scte35 = oatcls_scte35
self.scte35_duration = scte35_duration
self.scte35_elapsedtime = scte35_elapsedtime
self.key = keyobject
Expand Down Expand Up @@ -506,7 +513,11 @@ def dumps(self, last_segment, timespec='milliseconds'):
output.append(str(self.dateranges))
output.append('\n')


if self.cue_out_start:
if self.oatcls_scte35:
output.append(f'{ext_oatcls_scte35}:{self.oatcls_scte35}\n')

output.append('#EXT-X-CUE-OUT{}\n'.format(
(':' + self.scte35_duration) if self.scte35_duration else ''))
elif self.cue_out:
Expand Down
38 changes: 19 additions & 19 deletions m3u8/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,13 @@ def parse(content, strict=False, custom_tags_parser=None):
state['cue_out'] = True

elif line.startswith(protocol.ext_x_cue_out):
_parse_cueout(line, state, string_to_lines(content)[lineno - 2])
_parse_cueout(line, state)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change allowed me to simplify "cue out" parsing. We no longer require the "previous line" to be examined.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right! Much better.

state['cue_out_start'] = True
state['cue_out'] = True

elif line.startswith(f'{protocol.ext_oatcls_scte35}:'):
_parse_oatcls_scte35(line, state)

elif line.startswith(protocol.ext_x_cue_in):
state['cue_in'] = True

Expand Down Expand Up @@ -269,6 +272,7 @@ def _parse_ts_chunk(line, data, state):
segment['cue_out_start'] = state.pop('cue_out_start', False)
scte_op = state.pop if segment['cue_in'] else state.get
segment['scte35'] = scte_op('current_cue_out_scte35', None)
segment['oatcls_scte35'] = scte_op('current_cue_out_oatcls_scte35', None)
segment['scte35_duration'] = scte_op('current_cue_out_duration', None)
segment['scte35_elapsedtime'] = scte_op('current_cue_out_elapsedtime', None)
segment['discontinuity'] = state.pop('discontinuity', False)
Expand Down Expand Up @@ -397,15 +401,7 @@ def _cueout_no_duration(line):
if line == protocol.ext_x_cue_out:
return (None, None)

def _cueout_elemental(line, state, prevline):
param, value = line.split(':', 1)
res = re.match('.*EXT-OATCLS-SCTE35:(.*)$', prevline)
if res:
return (res.group(1), value)
else:
return None

def _cueout_envivio(line, state, prevline):
def _cueout_envivio(line, state):
param, value = line.split(':', 1)
res = re.match('.*DURATION=(.*),.*,CUE="(.*)"', value)
if res:
Expand All @@ -414,31 +410,28 @@ def _cueout_envivio(line, state, prevline):
return None

def _cueout_duration(line):
# this needs to be called after _cueout_elemental
# as it would capture those cues incompletely
# This was added separately rather than modifying "simple"
param, value = line.split(':', 1)
res = re.match(r'DURATION=(.*)', value)
if res:
return (None, res.group(1))

def _cueout_simple(line):
# this needs to be called after _cueout_elemental
# as it would capture those cues incompletely
param, value = line.split(':', 1)
res = re.match(r'^(\d+(?:\.\d)?\d*)$', value)
if res:
return (None, res.group(1))

def _parse_cueout(line, state, prevline):
def _parse_cueout(line, state):
_cueout_state = (_cueout_no_duration(line)
or _cueout_elemental(line, state, prevline)
or _cueout_envivio(line, state, prevline)
or _cueout_envivio(line, state)
or _cueout_duration(line)
or _cueout_simple(line))
if _cueout_state:
state['current_cue_out_scte35'] = _cueout_state[0]
state['current_cue_out_duration'] = _cueout_state[1]
cue_out_scte35, cue_out_duration = _cueout_state
current_cue_out_scte35 = state.get('current_cue_out_scte35')
state['current_cue_out_scte35'] = cue_out_scte35 or current_cue_out_scte35
state['current_cue_out_duration'] = cue_out_duration

def _parse_server_control(line, data, state):
attribute_parser = {
Expand Down Expand Up @@ -552,6 +545,13 @@ def _parse_content_steering(line, data, state):
protocol.ext_x_content_steering, line, attribute_parser
)


def _parse_oatcls_scte35(line, state):
scte35_cue = line.split(':', 1)[1]
state['current_cue_out_oatcls_scte35'] = scte35_cue
state['current_cue_out_scte35'] = scte35_cue


def string_to_lines(string):
return string.strip().splitlines()

Expand Down
2 changes: 1 addition & 1 deletion m3u8/protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
ext_x_cue_out_cont = '#EXT-X-CUE-OUT-CONT'
ext_x_cue_in = '#EXT-X-CUE-IN'
ext_x_cue_span = '#EXT-X-CUE-SPAN'
ext_x_scte35 = '#EXT-OATCLS-SCTE35'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EXT-X-SCTE35 is actually a different tag. It's specified in this document.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed! Nice catch

ext_oatcls_scte35 = '#EXT-OATCLS-SCTE35'
ext_is_independent_segments = '#EXT-X-INDEPENDENT-SEGMENTS'
ext_x_map = '#EXT-X-MAP'
ext_x_start = '#EXT-X-START'
Expand Down
18 changes: 18 additions & 0 deletions tests/test_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,24 @@ def test_segment_cue_out_cont_attributes_dumps():
)
assert expected in result

def test_segment_oatcls_scte35_dumps():
obj = m3u8.M3U8(playlists.CUE_OUT_ELEMENTAL_PLAYLIST)
result = obj.dumps()

# Only insert OATCLS-SCTE35 at cue out
cue_out_line = (
'#EXT-OATCLS-SCTE35:/DAlAAAAAAAAAP/wFAUAAAABf+//wpiQkv4ARKogAAEBAQAAQ6sodg==\n'
'#EXT-X-CUE-OUT'
)
assert cue_out_line in result

# Don't insert it for continued cue outs
cue_out_cont_line = (
'#EXT-OATCLS-SCTE35:/DAlAAAAAAAAAP/wFAUAAAABf+//wpiQkv4ARKogAAEBAQAAQ6sodg==\n'
'#EXT-X-CUE-OUT-CONT'
)
assert cue_out_cont_line not in result

def test_segment_cue_out_start_dumps():
obj = m3u8.M3U8(playlists.CUE_OUT_WITH_DURATION_PLAYLIST)

Expand Down
31 changes: 26 additions & 5 deletions tests/test_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,11 +285,32 @@ def test_should_parse_program_date_time_from_playlist():

def test_should_parse_scte35_from_playlist():
data = m3u8.parse(playlists.CUE_OUT_ELEMENTAL_PLAYLIST)
assert not data['segments'][2]['cue_out']
assert data['segments'][3]['scte35']
assert data['segments'][3]['cue_out']
assert '/DAlAAAAAAAAAP/wFAUAAAABf+//wpiQkv4ARKogAAEBAQAAQ6sodg==' == data['segments'][4]['scte35']
assert '50' == data['segments'][4]['scte35_duration']

# cue_out should be maintained from [EXT-X-CUE-OUT, EXT-X-CUE-IN)
actual_cue_status = [s['cue_out'] for s in data['segments']]
expected_cue_status = [
False, False, False, True, True, True, True, True, True, False, False
]
assert actual_cue_status == expected_cue_status

# scte35 should be maintained from [EXT-X-CUE-OUT, EXT-X-CUE-IN]
cue = '/DAlAAAAAAAAAP/wFAUAAAABf+//wpiQkv4ARKogAAEBAQAAQ6sodg=='
actual_scte35 = [s['scte35'] for s in data['segments']]
expected_scte35 = [None, None, None, cue, cue, cue, cue, cue, cue, cue, None]
assert actual_scte35 == expected_scte35

# oatcls_scte35 should be maintained from [EXT-X-CUE-OUT, EXT-X-CUE-IN]
actual_oatcls_scte35 = [s['oatcls_scte35'] for s in data['segments']]
expected_oatcls_scte35 = [None, None, None, cue, cue, cue, cue, cue, cue, cue, None]
assert actual_oatcls_scte35 == expected_oatcls_scte35

# durations should be maintained from from [EXT-X-CUE-OUT, EXT-X-CUE-IN]
actual_scte35_duration = [s['scte35_duration'] for s in data['segments']]
expected_scte35_duration = [
None, None, None, '50.000', '50', '50', '50', '50', '50', '50', None
]
assert actual_scte35_duration == expected_scte35_duration


def test_should_parse_envivio_cue_playlist():
data = m3u8.parse(playlists.CUE_OUT_ENVIVIO_PLAYLIST)
Expand Down
0