https://github.com/superkabuki/SCTE35

SCTE-35 | threefive, the most advanced, and complete SCTE-35 tool and lib available. threefive will save us all.
https://github.com/superkabuki/SCTE35
adbreak adrianofdoom adtech best hls-live-streaming hls-scte35 mpegts python3 scte scte-214 scte-35 scte-35-hls scte35 spliceinfosection threefive threefive3
Last synced: 3 months ago
JSON representation
SCTE-35 | threefive, the most advanced, and complete SCTE-35 tool and lib available. threefive will save us all.
Host: GitHub
URL: https://github.com/superkabuki/SCTE35
Owner: superkabuki
License: gpl-2.0
Created: 2025-03-14T08:55:42.000Z (10 months ago)
Default Branch: main
Last Pushed: 2025-10-06T22:01:47.000Z (3 months ago)
Last Synced: 2025-10-06T23:33:09.090Z (3 months ago)
Topics: adbreak, adrianofdoom, adtech, best, hls-live-streaming, hls-scte35, mpegts, python3, scte, scte-214, scte-35, scte-35-hls, scte35, spliceinfosection, threefive, threefive3
Language: Python
Homepage: https://iodisco.com/scte35
Size: 1.05 MB
Stars: 12
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          
# threefive is the Highest Rated SCTE-35 Parser. Ever.

# SCTE-35 CLI tool and python3 library

## [Latest version is v3.0.63](v3063.md)

### Q. `Who uses threefive?` 

### A. `Everybody.` 

_(threefive has been installed over one million times according to [pypi.org](https://pypi.org)_

# `Features`



* __Decodes SCTE-35__ from:

	* MPEGTS

 	* Base64

  	*  Bytes

  	*  DASH

  	*  Dicts

  	*  Hex

  	*  HLS

  	*  Integers

  	*  JSON

  	*  XML

  	*  XML+Binary

* __Encodes SCTE-35__ to:

	* MPEGTS

 	* Base64

  	* Bytes

  	* Hex

  	* Integers

  	* JSON

  	* XML

  	* XML+Binary

* __Automatic AES decryption__ for __MPEGTS__ and __HLS__.

* __Built-in Multicast Sender__ and __Receiver__.

* __Injects SCTE-35 Packets__ into __MPEGTS__ video.



#  `Tip Of The Week`

If you want to have a Segmentation Descriptor without a UPID 


set __segmentation_upid_length__= __0__ 


set __segmentation_upid_type__= __0__

___

# `Documentation`

	

* [__Install__](#install)

* [SCTE-35 Decoding __Quick Start__ ](#quick-start) _threefive makes decoding SCTE-35 fast and easy_

* [SCTE-35 __Examples__](https://github.com/superkabuki/threefive/tree/main/examples) _examples of all kinds of SCTE-35 stuff_

* [SCTE-35 __Cli__](#the-cli-tool) _decode SCTE-35 on the command line_

* [Using the __threefive lib__](#using-the-library) _decode SCTE-35 with less than ten lines of code_

* [SCTE-35 __HLS__](https://github.com/superkabuki/threefive/blob/main/hls.md) _parse SCTE-35 in HLS__

* [SCTE-35 __XML__ ](https://github.com/superkabuki/SCTE-35/blob/main/xml.md) and [More __XML__](node.md) _threefive can parse and encode SCTE-35 xml_

* [__Encode__ SCTE-35](https://github.com/superkabuki/threefive/blob/main/encode.md) _threefive can encode SCTE-35 in every SCTE-35 format_

* [SCTE-35 __Sidecar Files__](https://github.com/superkabuki/SCTE-35_Sidecar_Files) _threefive supports SCTE-35 sidecar files_

* [__SuperKabuki__ SCTE-35 MPEGTS __Packet Injection__](inject.md) _inject SCTE-35 into MPEGTS streams_ 

* [threefive __Classes__](#classes) _threefive is OO, made to subclass_

	* [__Cue__ Class](https://github.com/superkabuki/threefive/blob/main/cue.md) _this class you'll use often_ 

	* [__Stream__ Class](https://github.com/superkabuki/threefive/blob/main/stream.md) _this is the class for parsing MPEGTS_

* [Use threefive to stream __Multicast__](#stream-multicast-with-the-threefive-cli-its-easy) _threefive is a multicast client and server_

* [SCTE-35 __Online Parser__](https://iodisco.com/scte35) _powered by threefive, hosted on my server_

* [SCTE-35 __As a Service__](sassy.md) _if you can make an http request, you can parse SCTE-35, no install needed._

* [Make your __threefive__ script an executable with __cython__](cython.md) _threefive is compatible with all python tools_



## `Install`

* [Install](#install)

## `Quick Start` 

* Here's how to decode these SCTE-35 formats with threefive.

* This covers both the Cli tool and library.

 MPEGTS  

* MPEGTS streams can be  Files, Http(s), Multicast, UDP Unicast, or  stdin. 

* __cli__

```js

threefive https://example.com/video.ts

```

* wildcards work too.

```js

threefive /mpegts/*.ts

```

* __lib__

```py3

from threefive import Stream

stream = Stream('https://example.com/video.ts')

stream.decode()

```

Base64

* __cli__

```js

threefive '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='

```

* __lib__

```py3

from threefive import Cue

data = '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='

cue=Cue(data)

cue.show()

```

Bytes

* __cli__

	* Bytes don't work on the cli

* __lib__

```py3

from threefive import Cue

data =  b'\xfc0\x16\x00\x00\x00\x00\x00\x00\x00\xff\xf0\x05\x06\xfe\x00\xc0D\xa0\x00\x00\x00\xb5k\x88'

cue=Cue(data)

cue.show()

```

Hex

* Can be a hex literal or hex string or bytes.

* __cli__

```js

threefive  0xfc301600000000000000fff00506fed605225b0000b0b65f3b

```

* __lib__

```py3

from threefive import Cue

data =  0xfc301600000000000000fff00506fed605225b0000b0b65f3b

cue=Cue(data)

cue.show()

```

Int

* Can be a literal integer or string or bytes.

* __cli__

```js

threefive  1583008701074197245727019716796221243043855984942057168199483

```

* __lib__

```py3

from threefive import Cue

data =  1583008701074197245727019716796221243043855984942057168199483

cue=Cue(data)

cue.show()

```

JSON

* __cli__

	* 	put JSON SCTE-35 in a file and redirect it into threefive 

```js

threefive  < json.json

```

* __lib__

```py3

 from threefive import Cue

 data = '''{

    "info_section": {

        "table_id": "0xfc",

        "section_syntax_indicator": false,

        "private": false,

        "sap_type": "0x03",

        "sap_details": "No Sap Type",

        "section_length": 22,

        "protocol_version": 0,

        "encrypted_packet": false,

        "encryption_algorithm": 0,

        "pts_adjustment": 0.0,

        "cw_index": "0x00",

        "tier": "0x0fff",

        "splice_command_length": 5,

        "splice_command_type": 6,

        "descriptor_loop_length": 0,

        "crc": "0xb56b88"

    },

    "command": {

        "command_length": 5,

        "command_type": 6,

        "name": "Time Signal",

        "time_specified_flag": true,

        "pts_time": 140.005333

    },

    "descriptors": []

}

'''

cue=Cue(data)

cue.show()

```

Xml

* __cli__

	* put xml SCTE-35 in a [file](xml.xml) and redirect it into threefive 

	```js

	threefive < xml.xml

	```

* __lib__

```py3

from threefive import Cue

data =  '''

   

      

   

'''

cue=Cue(data)

cue.show()

```

Xml+binary

* __cli__

	* write xml+binary to a [file](xmlbin.xml) and redirect it to threefive

```js

threefive < xmlbin.xml

```

* __lib__

```py3

from threefive import Cue

data = '''

    /DAWAAAAAAAAAP/wBQb+AMBEoAAAALVriA==

'''

cue=Cue(data)

cue.show()

```



## `Examples` 

* [__Examples__](https://github.com/superkabuki/threefive/tree/main/examples)

## `XML`

* [XML](https://github.com/superkabuki/SCTE-35/blob/main/xml.md) __New__! _updated 05/01/2025_

## `Cli`

* [SCTE-35 Cli Super Tool](#the-cli-tool) Encodes, Decodes, and Recodes. This is pretty cool, it does SCTE-35 seven different ways.

     * The cli tool comes with builtin documentation just type `threefive help`

## `HLS`

* [Advanced Parsing of SCTE-35 in HLS with threefive](https://github.com/superkabuki/threefive/blob/main/hls.md) All HLS SCTE-35 tags, Sidecar Files, AAC ID3 Header Timestamps, SCTE-35 filters... Who loves you baby?

## `MPEGTS Packet Injection`

* [The SuperKabuki MPEGTS Packet Injection Engine in the Cli](inject.md)

## `SCTE-35 As a Service`

* Decode SCTE-35 without installing anything. If you can make an https request, you can use [__Sassy__](sassy.md) to decode SCTE-35. . 

## `Classes`

* The python built in help is always the most up to date docs for the library.

```py3

a@fu:~/build7/threefive$ pypy3

>>>> from threefive import Stream

>>>> help(Stream)

```

* [Class Structure](https://github.com/superkabuki/threefive/blob/main/classes.md)

* [Cue Class](https://github.com/superkabuki/threefive/blob/main/cue.md)  Cue is the main SCTE-35 class to use. 

* [Stream Class](https://github.com/superkabuki/threefive/blob/main/stream.md)  The Stream class handles MPEGTS SCTE-35 streams local, Http(s), UDP, and Multicast.

___

## `| more`

* [Online SCTE-35 Parser](https://iodisco.com/scte35)  Supporte Base64, Bytes,Hex,Int, Json, Xml, and Xml+binary.

* [Encode SCTE-35](https://github.com/superkabuki/threefive/blob/main/encode.md) Some encoding code examples. 

___

## `Install`

* python3 via pip

```rebol

python3 -mpip install threefive

```

* pypy3 

```rebol

pypy3 -mpip install threefive

```

* from the git repo

```rebol

git clone https://github.com/superkabuki/scte35.git

cd threefive

make install

```

___

## `Using the library`

* Let me show you how easy threefive is to use.

* reading SCTE-35 xml from a file

```py3

a@fu:~/threefive$ pypy3

Python 3.9.16 (7.3.11+dfsg-2+deb12u3, Dec 30 2024, 22:36:23)

[PyPy 7.3.11 with GCC 12.2.0] on linux

Type "help", "copyright", "credits" or "license" for more information.

>>>> from threefive import reader

>>>> from threefive import Cue

>>>> data =reader('/home/a/xml.xml').read()

```

* load it into a threefive.Cue instance

```py3

>>>> cue = Cue(data)

```

* Show the data as JSON

```py3

>>>> cue.show()

{

    "info_section": {

        "table_id": "0xfc",

        "section_syntax_indicator": false,

        "private": false,

        "sap_type": "0x03",

        "sap_details": "No Sap Type",

        "section_length": 92,

        "protocol_version": 0,

        "encrypted_packet": false,

        "encryption_algorithm": 0,

        "pts_adjustment": 0.0,

        "cw_index": "0x00",

        "tier": "0x0fff",

        "splice_command_length": 15,

        "splice_command_type": 5,

        "descriptor_loop_length": 60,

        "crc": "0x7632935"

    },

    "command": {

        "command_length": 15,

        "command_type": 5,

        "name": "Splice Insert",

        "break_auto_return": false,

        "break_duration": 180.0,

        "splice_event_id": 1073743095,

        "splice_event_cancel_indicator": false,

        "out_of_network_indicator": true,

        "program_splice_flag": false,

        "duration_flag": true,

        "splice_immediate_flag": false,

        "event_id_compliance_flag": true,

        "unique_program_id": 1,

        "avail_num": 12,

        "avails_expected": 5

    },

    "descriptors": [

        {

            "tag": 0,

            "identifier": "CUEI",

            "name": "Avail Descriptor",

            "provider_avail_id": 12,

            "descriptor_length": 8

        },

        {

            "tag": 0,

            "identifier": "CUEI",

            "name": "Avail Descriptor",

            "provider_avail_id": 13,

            "descriptor_length": 8

        },

      

    ]

}

```

* convert the data back to xml

```py3

>>>> print(cue.xml())

   

      

   

   

   

   

   

   

   

```

* convert to xml+binary

```py3

>>>> print(cue.xmlbin())

    /DBcAAAAAAAAAP/wDwVAAAT3f69+APcxQAABDAUAPAAIQ1VFSQAAAAwACENVRUkAAAANAAhDVUVJAAAADgAIQ1VFSQAAAA8ACENVRUkAAAAQAAhDVUVJAAAAEQdjKTU=

```

* convert to base64

```py3

>>>> print(cue.base64())

/DBcAAAAAAAAAP/wDwVAAAT3f69+APcxQAABDAUAPAAIQ1VFSQAAAAwACENVRUkAAAANAAhDVUVJAAAADgAIQ1VFSQAAAA8ACENVRUkAAAAQAAhDVUVJAAAAEQdjKTU=

```

* convert to hex

```py3

>>>> print(cue.hex())

0xfc305c00000000000000fff00f05400004f77faf7e00f7314000010c05003c0008435545490000000c0008435545490000000d0008435545490000000e0008435545490000000f000843554549000000100008435545490000001107632935

```

* show just the splice command

```py3

>>>> cue.command.show()

{

    "command_length": 15,

    "command_type": 5,

    "name": "Splice Insert",

    "break_auto_return": false,

    "break_duration": 180.0,

    "splice_event_id": 1073743095,

    "splice_event_cancel_indicator": false,

    "out_of_network_indicator": true,

    "program_splice_flag": false,

    "duration_flag": true,

    "splice_immediate_flag": false,

    "event_id_compliance_flag": true,

    "unique_program_id": 1,

    "avail_num": 12,

    "avails_expected": 5

}

```

* edit the break duration

```py3

>>>> cue.command.break_duration=30

>>>> cue.command.show()

{

    "command_length": 15,

    "command_type": 5,

    "name": "Splice Insert",

    "break_auto_return": false,

    "break_duration": 30,

    "splice_event_id": 1073743095,

    "splice_event_cancel_indicator": false,

    "out_of_network_indicator": true,

    "program_splice_flag": false,

    "duration_flag": true,

    "splice_immediate_flag": false,

    "event_id_compliance_flag": true,

    "unique_program_id": 1,

    "avail_num": 12,

    "avails_expected": 5

}

```

* re-encode to base64 with the new duration

```py3

>>>> cue.base64()

'/DBcAAAAAAAAAP/wDwVAAAT3f69+ACky4AABDAUAPAAIQ1VFSQAAAAwACENVRUkAAAANAAhDVUVJAAAADgAIQ1VFSQAAAA8ACENVRUkAAAAQAAhDVUVJAAAAEe1FB6g='

```

* re-encode to xml with the new duration

```py3

>>>> print(cue.xml())

   

      

   

   

   

   

   

   

   

```

* show just the descriptors

```py3

>>>> _ = [d.show() for d in cue.descriptors]

{

    "tag": 0,

    "identifier": "CUEI",

    "name": "Avail Descriptor",

    "provider_avail_id": 12,

    "descriptor_length": 8

}

{

    "tag": 0,

    "identifier": "CUEI",

    "name": "Avail Descriptor",

    "provider_avail_id": 13,

    "descriptor_length": 8

}

{

    "tag": 0,

    "identifier": "CUEI",

    "name": "Avail Descriptor",

    "provider_avail_id": 14,

    "descriptor_length": 8

}

{

    "tag": 0,

    "identifier": "CUEI",

    "name": "Avail Descriptor",

    "provider_avail_id": 15,

    "descriptor_length": 8

}

{

    "tag": 0,

    "identifier": "CUEI",

    "name": "Avail Descriptor",

    "provider_avail_id": 16,

    "descriptor_length": 8

}

{

    "tag": 0,

    "identifier": "CUEI",

    "name": "Avail Descriptor",

    "provider_avail_id": 17,

    "descriptor_length": 8

}

```

* pop off the last descriptor and re-encode to xml

```py3

>>>> cue.descriptors.pop()

{'tag': 0, 'identifier': 'CUEI', 'name': 'Avail Descriptor', 'private_data': None, 'provider_avail_id': 17, 'descriptor_length': 8}

>>>> print(cue.xml())

   

      

   

   

   

   

   

   

```

## `The Cli tool`

#### The cli tool installs automatically with pip or the Makefile.

* [__SCTE-35 Inputs__](#inputs)

* [__SCTE-35 Outputs__](#outputs)

* [Parse __MPEGTS__ streams for __SCTE-35__](#streams)

* [Parse __SCTE-35__ in __hls__](#hls)

* [Display __MPEGTS__ __iframes__](#iframes)

* [Display raw __SCTE-35 packets__ from __video streams__](#packets)

* [__Repair SCTE-35 streams__ changed to __bin data__ by __ffmpeg__](#sixfix)

#### `Inputs`

* Most __inputs__ are __auto-detected.__ 

* __stdin__ is __auto selected__ and __auto detected.__

* __SCTE-35 data is printed to stderr__

* __stdout is used when piping video__

* mpegts can be specified by file name or URI.

```rebol

threefive udp://@235.2.5.35:3535

```

* If a file comtains a SCTE-35 cue as a string( base64,hex,int,json,or xml+bin), redirect the file contents.

```rebol

  threefive < json.json  

 ```

* quoted strings(( base64,hex,int,json or xml+bin), can be passed directly on the command line as well.

```awk

threefive '/DAWAAAAAAAAAP/wBQb+ztd7owAAdIbbmw=='

```

| Input Type |     Cli Example                                                                                             |

|------------|-------------------------------------------------------------------------------------------------------------|

| __Base64__     |  `threefive '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='`

| __Hex__        |`threefive 0xfc301600000000000000fff00506fed605225b0000b0b65f3b`|

| __HLS__         |`threefive hls https://example.com/master.m3u8`                                                             |

| __JSON__        |`threefive < json.json`  |

| __Xmlbin__      | `js threefive < xmlbin.xml`                                                                                 |

# `Streams`

|Protocol       |  Cli Example                                                                                                                                       |

|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------|

|  __File__         |   `threefive video.ts`                                                                                                                            |

|  __Http(s)__      |   `threefive https://example.com/video.ts`                                                                                                        |

|  __Stdin__        |  `threefive < video.ts`            |

|  __UDP Multicast__|  `threefive udp://@235.35.3.5:9999`                                                                          |

|  __UDP Unicast__  |                                                                      `threefive udp://10.0.0.7:5555`                                              |

|  __HLS__          |                                                                                                    `threefive hls https://example.com/master.m3u8`|

|               |                                                                                                                                                    |

#### Outputs

* output type is determined by the key words __base64, bytes, hex, int, json, and xmlbin__.

* __json is the default__.

* __Any input (except HLS,) can be returned as any output__

  * examples __Base64 to Hex__ etc...) 

| Output Type | Cli Example         |

|-------------|----------------------------------------------------------|

|__Base 64__     |                                                                                                                                                                    `threefive 0xfc301600000000000000fff00506fed605225b0000b0b65f3b  base64  `                                                                                                                                                                                                                                                                                                                                         |

| __Bytes__       |                                                                                 `threefive 0xfc301600000000000000fff00506fed605225b0000b0b65f3b  bytes`                                                                                                                                                                                                                                                                                                                                                                                                                               |

| __Hex__         | `threefive '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='  hex`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

| __Integer__     |                                                                                                                                                                                                                                                       `threefive '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='  int`   |

| __JSON__        |                                                                                                                                                                                                                                                                                                              `threefive 0xfc301600000000000000fff00506fed605225b0000b0b65f3b json ` |

| __Xml+bin__     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        `threefive 0xfc301600000000000000fff00506fed605225b0000b0b65f3b xmlbin   `      |`

#### `hls`

* parse hls manifests and segments for SCTE-35

```smalltalk

threefive hls https://example.com/master.m3u8

```

___

#### `Iframes`

* Show iframes PTS in an MPEGTS video

```smalltalk

threefive iframes https://example.com/video.ts

```

___

#### `packets`   

* Print raw SCTE-35 packets from multicast mpegts video

```smalltalk

threefive packets udp://@235.35.3.5:3535

```

___

#### `proxy`   

* Parse a https stream and write raw video to stdout

```smalltalk

threefive proxy video.ts

```

___

#### `pts`    

* Print PTS from mpegts video

```smalltalk

threefive pts video.ts

```

___

#### `sidecar`  

* Parse a stream, write pts,write SCTE-35 Cues to sidecar.txt

```smalltalk

threefive sidecar video.ts

```

___

#### `sixfix`  

* Fix SCTE-35 data mangled by ffmpeg

```smalltalk

threefive sixfix video.ts

```

___

#### `show`  

* Probe mpegts video _( kind of like ffprobe )_

```smalltalk

 threefive show video.ts

```

___

#### `version`     

* Show version

```smalltalk

 threefive version

```

___

#### `help`        

* Help

```rebol

 threefive help

```

___

## Stream Multicast with the threefive cli, it's easy.

* The threefive cli has long been a Multicast Receiver( client )

* The cli now comes with a builtin Multicast Sender( server).

 * __Start the Receiver first__

* It's optimized for MPEGTS (1316 byte Datagrams) but you can send any video or file.

* The defaults will work in most situations, you don't even have to set the address.

* threefive cli also supports UDP Unicast Streaming.

  

![image](https://github.com/user-attachments/assets/6042b8e0-5d6b-4de0-b6b0-9556cecc184f)

 

```js

a@fu:~$ threefive mcast help

usage: threefive mcast [-h] [-i INPUT] [-a ADDR] [-b BIND_ADDR] [-t TTL]

optional arguments:

  -h, --help            show this help message and exit

  -i INPUT, --input INPUT

                        like "/home/a/vid.ts" or "udp://@235.35.3.5:3535" or

                        "https://futzu.com/xaa.ts"

                        [default:sys.stdin.buffer]

  -a ADDR, --addr ADDR  Destination IP:Port [default:235.35.3.5:3535]

  -b BIND_ADDR, --bind_addr BIND_ADDR

                        Local IP to bind [default:0.0.0.0]

  -t TTL, --ttl TTL     Multicast TTL (1 - 255) [default:32]

a@fu:~$ 

```

## [iodisco.com/scte35](https://iodisco.com/scte35)

 

  

 

 

___

 [__Install__](#install) |[__SCTE-35 Cli__](#the-cli-tool) | [__SCTE-35 HLS__](https://github.com/superkabuki/threefive/blob/main/hls.md) | [__Cue__ Class](https://github.com/superkabuki/threefive/blob/main/cue.md) | [__Stream__ Class](https://github.com/superkabuki/threefive/blob/main/stream.md) | [__Online SCTE-35 Parser__](https://iodisco.com/scte35) | [__Encode SCTE-35__](https://github.com/superkabuki/threefive/blob/main/encode.md) | [__SCTE-35 Examples__](https://github.com/superkabuki/threefive/tree/main/examples)

 | [__SCTE-35 XML__ ](https://github.com/superkabuki/SCTE-35/blob/main/xml.md) and [More __XML__](node.md) | [__threefive runs Four Times Faster on pypy3__](https://pypy.org/) | [__SuperKabuki SCTE-35 MPEGTS Packet Injection__](inject.md)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/superkabuki/SCTE35

Awesome Lists containing this project

README
