The World Wide Leader in SCTE35
Project description
threefive is the most advanced SCTE35 parser lib available, probably.
Q. How many lines of code doe it take to parse SCTE35 from Mpegts?
A. Three.
from threefive import Stream
strm = Stream('https://example.com/vid.ts')
strm.decode()
Supported | Format |
---|---|
Files | "/home/you/vid.ts" |
Http(s) | "https://example.com" |
Udp | "udp://1.2.3.4:5555" |
Multicast | "udp://@227.1.3.10:4310" |
-
Supports All 2020 SCTE-35
Commands
andDescriptors
andUpids
. -
ffmpeg
andSCTE35
andStream Type 0x6 bin data
and threefive -
Multicast?
HLS?
Custom Upid Handling?
Frame Accurate Preroll timings?
... Yes. -
Check out
cuei
cli tool. -
Encoding
too withExamples
-
Issues
andBugs
andFeature Requests
No forms man, just open an issue and tell me what you need. -
Direct Multicast Support Now Included. ( udp://@224.0.0.1:1234)
-
Heads Up
. New output format forthreefive.Stream.show()
just pushed.
-
Diagram of a threefive SCTE-35 Cue
-
Issues
andBugs
andFeature
Requests No forms man, just open an issue.
Requirements
- threefive requires pypy3 or python 3.6+
- (pypy3 runs threefive 4x Faster than python3)
- threefive 2.3.02+ requires crcmod for encoding and pyaes for decrypting.
Install
pip3 install threefive
# for pypy3
pypy3 -m pip install threefive
Versions and Releases
Release versions are odd. Unstable testing versions are even.
threefive.version()
returns the version as a string.
threefive.version_number()
returns an int for easy version comparisons.
Easy threefive
threefive.decode is a SCTE-35 decoder function with input type auto-detection.
Base64
,Binary
,Hex Strings
,Hex literals
,Integers
,Mpegts files
andMpegts HTTP/HTTPS Streams
SCTE-35 data can be parsed with just one function call.
SCTE-35 data is printed in JSON format.
Examples:
Base64
import threefive
stuff = '/DAvAAAAAAAA///wBQb+dGKQoAAZAhdDVUVJSAAAjn+fCAgAAAAALKChijUCAKnMZ1g='
threefive.decode(stuff)
Bytes
import threefive
payload = b'\xfc0\x11\x00\x00\x00\x00\x00\x00\x00\xff\xff\xff\x00\x00\x00O%3\x96'
threefive.decode(payload)
Hex String
import threefive
stuff = '0XFC301100000000000000FFFFFF0000004F253396'
threefive.decode(stuff)
Hex Literal
import threefive
threefive.decode(0XFC301100000000000000FFFFFF0000004F253396)
Integer
big_int = 1439737590925997869941740173214217318917816529814
threefive.decode(big_int)
Mpegts File
import threefive
threefive.decode('/path/to/mpegts')
Mpegts HTTP/HTTPS Streams
import threefive
threefive.decode('https://futzu.com/xaa.ts')
A threefive SCTE-35 Cue
{
"info_section": {
"table_id": "0xfc",
"section_syntax_indicator": false,
"private": false,
"sap_type": "0x3",
"sap_details": "No Sap Type",
"section_length": 47,
"protocol_version": 0,
"encrypted_packet": false,
"encryption_algorithm": 0,
"pts_adjustment": 0.0,
"cw_index": "0x0",
"tier": "0xfff",
"splice_command_length": 4095,
"splice_command_type": 5,
"descriptor_loop_length": 10,
"crc": "0x10fa4d9e"
},
"command": {
"calculated_length": 20,
"name": "Splice Insert",
"time_specified_flag": true,
"pts_time": 89742.161689,
"break_auto_return": false,
"break_duration": 242.0,
"splice_event_id": 662,
"splice_event_cancel_indicator": false,
"out_of_network_indicator": true,
"program_splice_flag": true,
"duration_flag": true,
"splice_immediate_flag": false,
"unique_program_id": 1,
"avail_num": 0,
"avail_expected": 0
},
"descriptors": [
{
"tag": 0,
"descriptor_length": 8,
"name": "Avail Descriptor",
"identifier": "CUEI",
"provider_avail_id": 0
}
],
"packet_data": {
"pid": "0x135",
"program": 1,
"pcr": 89730.281789,
"pts": 89730.289522
}
}
Advanced threefive
Cue Class
- src cue.py
- The threefive.Cue class decodes a SCTE35 binary, base64, or hex encoded string.
- threefive.Cue provides several methods to access the parsed data.
>>>> import threefive
>>>> Base64 = "/DAvAAAAAAAA///wBQb+dGKQoAAZAhdDVUVJSAAAjn+fCAgAAAAALKChijUCAKnMZ1g="
>>>> cue = threefive.Cue(Base64)
cue.decode() returns True on success,or False if decoding failed
>>>> cue.decode()
True
After Calling cue.decode() the instance variables can be accessed via dot notation.
>>>> cue.command
{'calculated_length': 5, 'name': 'Time Signal', 'time_specified_flag': True, 'pts_time': 21695.740089}
>>>> cue.command.pts_time
21695.740089
>>>> cue.info_section.table_id
'0xfc'
When parsing SCTE35 Cues from MPEGTS streams, threefive attempts to include as many of the following as possible.'
- pid of the packet
- program of the pid
- pts of the packet
- pcr of the packet
- call one or more of these methods after decode.
Cue Method | Description |
---|---|
cue.get() | returns cue as a dict |
cue.get_json() | returns cue as a JSON string |
cue.show() | prints cue as JSON |
Stream Class
threefive.Stream(tsdata, show_null = False)
- src stream.py
- The threefive.Stream class parses SCTE35 messages from a file or stream.
- Supports
- __file and http(s) URIs directly. * Multiple Programs. * Multiple SCTE35 Streams. * Multi-Packet PAT, PMT, and SCTE35 tables. * Constant Data Parsing. * threefive.Stream is designed to run continuously
Method | Description |
---|---|
Stream.show() | Prints Streams that will be checked for SCTE35 |
Stream.decode(func=show_cue) | Prints SCTE-35 cues for SCTE-35 packets. Accepts an optional function, func, as arg. |
Stream.decode_next() | Returns the next SCTE35 cue as a threefive.Cue instance. |
Stream.decode_program(the_program=None, func=show_cue) | Same as Stream.decode except only packets where program == the_program |
Stream.decode_proxy(func=show_cue) | Same as Stream.decode except raw packets are written to stdout for piping to another program. |
Stream.show()
- List programs and streams that will be checked for SCTE35 data.
>>>> from threefive import Stream
>>>> Stream('https://slo.me/plp0.ts').show()
Program: 1040
Service: fumatic
Provider: fu-labs
Pcr Pid: 1041[0x411]
Streams:
Pid: 1041[0x411] Type: 0x1b AVC Video
Pid: 1042[0x412] Type: 0x3 MP2 Audio
Pid: 1044[0x414] Type: 0x6 PES Packets/Private Data
Pid: 1045[0x415] Type: 0x86 SCTE35 Data
Program: 1050
Service: fancy ˹
Provider: fu-corp
Pcr Pid: 1051[0x41b]
Streams:
Pid: 1051[0x41b] Type: 0x1b AVC Video
Pid: 1052[0x41c] Type: 0x3 MP2 Audio
Pid: 1054[0x41e] Type: 0x6 PES Packets/Private Data
Pid: 1055[0x41f] Type: 0x86 SCTE35 Data
Stream.decode(func=show_cue)
import sys
from threefive import Stream
>>>> Stream('plp0.ts').decode()
-
Pass in custom function
-
func should match the interface
func(cue)
import sys
import threefive
def display(cue):
print(f'\033[92m{cue.packet_data}\033[00m')
print(f'{cue.command.name}')
def do():
sp = threefive.Stream(tsdata)
sp.decode(func = display)
if __name__ == '__main__':
do()
Stream.decode_next()
- Stream.decode_next returns the next SCTE35 cue as a threefive.Cue instance.
import sys
import threefive
def do():
arg = sys.argv[1]
with open(arg,'rb') as tsdata:
st = threefive.Stream(tsdata)
while True:
cue = st.decode_next()
if not cue:
return False
if cue:
cue.show()
if __name__ == "__main__":
do()
Stream.decode_program(the_program, func = show_cue)
- Use Stream.decode_program() instead of Stream.decode() to decode SCTE-35 from packets where program == the_program
import threefive
threefive.Stream('35.ts').decode_program(1)
Stream.decode_proxy(func = show_cue)
-
Writes all packets to sys.stdout.
-
Writes scte35 data to sys.stderr.
import threefive
sp = threefive.Stream('https://futzu.com/xaa.ts')
sp.proxy_decode()
- Pipe to mplayer
$ python3 proxy.py | mplayer -
Issues and Bugs and Feature Requests
Speak up. I want to hear what you have to say.
If threefive doesn't work as expected,
or if you find a bug ,
or if you have feature request,
please open an issue.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for threefive-2.3.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c1d162bb84bddda126dce20cc2fdb5b6f9ad49ea464b0780c19438fd2325bad |
|
MD5 | 8a838d52459d51aca15b0d1d21488d7f |
|
BLAKE2b-256 | 97bec3072508badf73b957a5d919abefe708b69052c29ef8a2b8d86844ec656f |