threefive3

https://pypi.org/project/threefive3/
Admin
SCTE-35 decoder and encoder with MPEGTS and HLS and XML support for advanced parsing and encoding of...
Tokens:6,690
Snippets:91
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Threefive3 from Git Repo

Source: https://pypi.org/project/threefive3

Clone the repository and install the library locally using the make install command.

```bash
git clone https://github.com/superkabuki/scte35.git
cd threefive3
make install
```

--------------------------------

### Install Threefive3 with pip

Source: https://pypi.org/project/threefive3

Install the threefive3 library using pip for Python 3 or PyPy3.

```bash
python3 -mpip install threefive3
```

```bash
pypy3 -mpip install threefive3
```

--------------------------------

### Get Help for Stream Class

Source: https://pypi.org/project/threefive3

Access the built-in Python help documentation for the Stream class to understand its methods and usage.

```python
from threefive import Stream
help(Stream)
```

--------------------------------

### Display Help Information

Source: https://pypi.org/project/threefive3

Use the 'help' command to display the help message and usage instructions for the threefive3 CLI tool.

```bash
 threefive3 help
```

--------------------------------

### Input SCTE-35 Data as Xmlbin

Source: https://pypi.org/project/threefive3

Provide SCTE-35 data in Xml+bin format as input to the CLI. This is typically done by redirecting a file.

```bash
js threefive3 < xmlbin.xml
```

--------------------------------

### Probe MPEGTS Video Information

Source: https://pypi.org/project/threefive3

Use the 'show' command to probe an MPEGTS video file for information, similar to ffprobe.

```bash
 threefive3 show video.ts
```

--------------------------------

### Read SCTE-35 XML from file

Source: https://pypi.org/project/threefive3

Load SCTE-35 XML data from a file using the `reader` and then parse it into a `Cue` instance.

```python
from threefive3 import reader
from threefive3 import Cue
data =reader('/home/a/xml.xml').read()
cue = Cue(data)
```

--------------------------------

### Display CLI Version

Source: https://pypi.org/project/threefive3

Use the 'version' command to display the current version of the threefive3 CLI tool.

```bash
 threefive3 version
```

--------------------------------

### Input SCTE-35 Data as Base64

Source: https://pypi.org/project/threefive3

Provide SCTE-35 data encoded in Base64 format as input to the CLI.

```bash
threefive3 '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='
```

--------------------------------

### Multicast Command Help

Source: https://pypi.org/project/threefive3

Display the help message for the 'mcast' subcommand, which is used for multicast streaming.

```bash
a@fu:~$ threefive3 mcast help
usage: threefive3 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:~$ 
```

--------------------------------

### Input HLS Manifest for SCTE-35 Parsing

Source: https://pypi.org/project/threefive3

Specify an HLS manifest URL to parse for SCTE-35 data.

```bash
threefive3 hls https://example.com/master.m3u8
```

--------------------------------

### Specify MPEGTS Input by URI

Source: https://pypi.org/project/threefive3

Use this command to specify an MPEGTS input stream using its URI.

```bash
threefive3 udp://@235.2.5.35:3535
```

--------------------------------

### Process Video from Stdin

Source: https://pypi.org/project/threefive3

Pipe video data from stdin to the CLI for processing.

```bash
threefive3 < video.ts
```

--------------------------------

### Print Raw SCTE-35 Packets

Source: https://pypi.org/project/threefive3

Use the 'packets' command to print raw SCTE-35 packets from a multicast MPEGTS video stream.

```bash
threefive3 packets udp://@235.35.3.5:3535
```

--------------------------------

### Process Local Video File

Source: https://pypi.org/project/threefive3

Specify a local video file (e.g., .ts) to process.

```bash
threefive3 video.ts
```

--------------------------------

### Show SCTE-35 data as JSON

Source: https://pypi.org/project/threefive3

Display the parsed SCTE-35 data in JSON format using the `show()` method.

```json
{
    "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
        },
        {
            "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
        }
    ]
}
```

--------------------------------

### Input SCTE-35 Data as Hex

Source: https://pypi.org/project/threefive3

Provide SCTE-35 data encoded in Hexadecimal format as input to the CLI.

```bash
threefive3 0xfc301600000000000000fff00506fed605225b0000b0b65f3b
```

--------------------------------

### Show Descriptors

Source: https://pypi.org/project/threefive3

Iterates through and displays details for each descriptor within the SCTE-35 command. This is useful for inspecting individual descriptors.

```python
>>>> _ = [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
}

```

--------------------------------

### Convert SCTE-35 to Xml+bin Output

Source: https://pypi.org/project/threefive3

Convert SCTE-35 data to Xml+bin format. Specify the input data and the desired output type.

```bash
threefive3 0xfc301600000000000000fff00506fed605225b0000b0b65f3b xmlbin   
```

--------------------------------

### Write PTS and SCTE-35 Cues to Sidecar File

Source: https://pypi.org/project/threefive3

Use the 'sidecar' command to parse a stream, write its PTS, and SCTE-35 Cues to a file named 'sidecar.txt'.

```bash
threefive3 sidecar video.ts
```

--------------------------------

### Redirect File Contents as Input

Source: https://pypi.org/project/threefive3

When a file contains SCTE-35 data as a string (base64, hex, int, json, or xml+bin), redirect its contents to the CLI.

```bash
threefive3 < json.json
```

--------------------------------

### Process HTTP(s) Video Stream

Source: https://pypi.org/project/threefive3

Specify an HTTP or HTTPS URL for a video stream to process.

```bash
threefive3 https://example.com/video.ts
```

--------------------------------

### Proxy HTTPS Stream to Stdout

Source: https://pypi.org/project/threefive3

Use the 'proxy' command to parse an HTTPS stream and write the raw video data to standard output.

```bash
threefive3 proxy video.ts
```

--------------------------------

### Pass Quoted SCTE-35 Strings as Input

Source: https://pypi.org/project/threefive3

Quoted SCTE-35 strings (base64, hex, int, json, or xml+bin) can be passed directly on the command line.

```bash
threefive3 '/DAWAAAAAAAAAP/wBQb+ztd7owAAdIbbmw=='
```

--------------------------------

### Convert SCTE-35 data to XML+Binary

Source: https://pypi.org/project/threefive3

Convert the SCTE-35 data into an XML format that includes the binary payload using the `xmlbin()` method.

```xml
<scte35:Signal xmlns:scte35="https://scte.org/schemas/35">
    <scte35:Binary>/DBcAAAAAAAAAP/wDwVAAAT3f69+APcxQAABDAUAPAAIQ1VFSQAAAAwACENVRUkAAAANAAhDVUVJAAAADgAIQ1VFSQAAAA8ACENVRUkAAAAQAAhDVUVJAAAAEQdjKTU=</scte35:Binary>
</scte35:Signal>
```

--------------------------------

### Convert SCTE-35 to Base64 Output

Source: https://pypi.org/project/threefive3

Convert SCTE-35 data to Base64 format. Specify the input data and the desired output type.

```bash
threefive3 0xfc301600000000000000fff00506fed605225b0000b0b65f3b  base64  
```

--------------------------------

### Parse MPEGTS Stream for SCTE-35

Source: https://pypi.org/project/threefive3

Initialize a Stream object with an MPEGTS URL and decode it to extract SCTE-35 data. This is a concise way to handle SCTE-35 in MPEGTS.

```python
from threefive3 import Stream
strm=Stream('https://futzu.com/xaa.ts')
strm.decode()
```

--------------------------------

### Convert SCTE-35 data to Base64

Source: https://pypi.org/project/threefive3

Encode the SCTE-35 data into a Base64 string using the `base64()` method.

```text
/DBcAAAAAAAAAP/wDwVAAAT3f69+APcxQAABDAUAPAAIQ1VFSQAAAAwACENVRUkAAAANAAhDVUVJAAAADgAIQ1VFSQAAAA8ACENVRUkAAAAQAAhDVUVJAAAAEQdjKTU=
```

--------------------------------

### Parse DASH MPD with SCTE-35 Data

Source: https://pypi.org/project/threefive3

Use the reader to fetch an MPD file over the network and pass its content to the Cue instance for parsing the first SCTE-35 event found.

```python
from threefive3 import Cue,reader
data = reader('https://demo.unified-streaming.com/k8s/live/stable/scte35-no-splicing.isml/.mpd').read().strip().decode()    # use reader to pull the mpd over a network.
cue=Cue(data)     # pass in to a Cue instance
cue.show()
```

--------------------------------

### Convert SCTE-35 to Bytes Output

Source: https://pypi.org/project/threefive3

Convert SCTE-35 data to raw bytes format. Specify the input data and the desired output type.

```bash
threefive3 0xfc301600000000000000fff00506fed605225b0000b0b65f3b  bytes
```

--------------------------------

### Show Splice Insert Command

Source: https://pypi.org/project/threefive3

Displays the details of a splice insert command. This is useful for inspecting the parameters of a SCTE-35 splice insert.

```python
>>>> 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
}
```

--------------------------------

### Show only the splice command

Source: https://pypi.org/project/threefive3

Access and display only the splice command details from the parsed SCTE-35 data using the `command.show()` attribute.

```json
{
    "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
}
```

--------------------------------

### Pop Descriptor and Re-encode to XML

Source: https://pypi.org/project/threefive3

Removes the last descriptor from the SCTE-35 command and then re-encodes the modified command to XML. This demonstrates modifying the descriptors and observing the effect on the XML output.

```python
>>>> cue.descriptors.pop()
{'tag': 0, 'identifier': 'CUEI', 'name': 'Avail Descriptor', 'private_data': None, 'provider_avail_id': 17, 'descriptor_length': 8}
>>>> print(cue.xml())
<scte35:SpliceInfoSection xmlns:scte35="https://scte.org/schemas/35"  ptsAdjustment="0" protocolVersion="0" sapType="3" tier="4095">
   <scte35:SpliceInsert spliceEventId="1073743095" spliceEventCancelIndicator="false" spliceImmediateFlag="false" eventIdComplianceFlag="true" availNum="12" availsExpected="5" outOfNetworkIndicator="true" uniqueProgramId="1">
      <scte35:BreakDuration autoReturn="false" duration="2700000"/>
   </scte35:SpliceInsert>
   <scte35:AvailDescriptor providerAvailId="12"/>
   <scte35:AvailDescriptor providerAvailId="13"/>
   <scte35:AvailDescriptor providerAvailId="14"/>
   <scte35:AvailDescriptor providerAvailId="15"/>
   <scte35:AvailDescriptor providerAvailId="16"/>
</scte35:SpliceInfoSection>

```

--------------------------------

### Receive UDP Multicast Stream

Source: https://pypi.org/project/threefive3

Listen for and process MPEGTS streams on a UDP multicast address.

```bash
threefive3 udp://@235.35.3.5:9999
```

--------------------------------

### Convert SCTE-35 to Integer Output

Source: https://pypi.org/project/threefive3

Convert SCTE-35 data to an integer format. Specify the input data and the desired output type.

```bash
threefive3 '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='  int
```

--------------------------------

### Receive UDP Unicast Stream

Source: https://pypi.org/project/threefive3

Listen for and process MPEGTS streams on a UDP unicast address.

```bash
threefive3 udp://10.0.0.7:5555
```

--------------------------------

### Convert SCTE-35 to Hex Output

Source: https://pypi.org/project/threefive3

Convert SCTE-35 data to Hexadecimal format. Specify the input data and the desired output type.

```bash
threefive3 '/DAsAAAAAyiYAP/wCgUAAAABf1+ZmQEBABECD0NVRUkAAAAAf4ABADUAAC2XQZU='  hex
```

--------------------------------

### Repair SCTE-35 Data Mangled by FFmpeg

Source: https://pypi.org/project/threefive3

Use the 'sixfix' command to repair SCTE-35 data that has been corrupted or altered by FFmpeg.

```bash
threefive3 sixfix video.ts
```

--------------------------------

### Re-encode to XML

Source: https://pypi.org/project/threefive3

Encodes the current SCTE-35 command into an XML string. This provides a human-readable representation of the SCTE-35 message.

```python
>>>> print(cue.xml())
<scte35:SpliceInfoSection xmlns:scte35="https://scte.org/schemas/35"  ptsAdjustment="0" protocolVersion="0" sapType="3" tier="4095">
   <scte35:SpliceInsert spliceEventId="1073743095" spliceEventCancelIndicator="false" spliceImmediateFlag="false" eventIdComplianceFlag="true" availNum="12" availsExpected="5" outOfNetworkIndicator="true" uniqueProgramId="1">
      <scte35:BreakDuration autoReturn="false" duration="2700000"/>
   </scte35:SpliceInsert>
   <scte35:AvailDescriptor providerAvailId="12"/>
   <scte35:AvailDescriptor providerAvailId="13"/>
   <scte35:AvailDescriptor providerAvailId="14"/>
   <scte35:AvailDescriptor providerAvailId="15"/>
   <scte35:AvailDescriptor providerAvailId="16"/>
   <scte35:AvailDescriptor providerAvailId="17"/>
</scte35:SpliceInfoSection>

```

--------------------------------

### Convert SCTE-35 data to XML

Source: https://pypi.org/project/threefive3

Convert the parsed SCTE-35 data back into its XML representation using the `xml()` method.

```xml
<scte35:SpliceInfoSection xmlns:scte35="https://scte.org/schemas/35"  ptsAdjustment="0" protocolVersion="0" sapType="3" tier="4095">
   <scte35:SpliceInsert spliceEventId="1073743095" spliceEventCancelIndicator="false" spliceImmediateFlag="false" eventIdComplianceFlag="true" availNum="12" availsExpected="5" outOfNetworkIndicator="true" uniqueProgramId="1">
      <scte35:BreakDuration autoReturn="false" duration="16200000"/>
   </scte35:SpliceInsert>
   <scte35:AvailDescriptor providerAvailId="12"/>
   <scte35:AvailDescriptor providerAvailId="13"/>
   <scte35:AvailDescriptor providerAvailId="14"/>
   <scte35:AvailDescriptor providerAvailId="15"/>
   <scte35:AvailDescriptor providerAvailId="16"/>
   <scte35:AvailDescriptor providerAvailId="17"/>
</scte35:SpliceInfoSection>
```

--------------------------------

### Convert SCTE-35 data to Hex

Source: https://pypi.org/project/threefive3

Represent the SCTE-35 data as a hexadecimal string using the `hex()` method.

```text
0xfc305c00000000000000fff00f05400004f77faf7e00f7314000010c05003c0008435545490000000c0008435545490000000d0008435545490000000e0008435545490000000f0008435545490000001107632935
```

--------------------------------

### Re-encode to Base64

Source: https://pypi.org/project/threefive3

Encodes the current SCTE-35 command into a base64 string. This is often used for transmitting the SCTE-35 message.

```python
>>>> cue.base64()
'/DBcAAAAAAAAAP/wDwVAAAT3f69+ACky4AABDAUAPAAIQ1VFSQAAAAwACENVRUkAAAANAAhDVUVJAAAADwAIQ1VFSQAAAA8ACENVRUkAAAAQAAhDVUVJAAAAEe1FB6g='

```

--------------------------------

### Print PTS from MPEGTS Video

Source: https://pypi.org/project/threefive3

Use the 'pts' command to extract and print the Presentation Timestamp (PTS) from an MPEGTS video stream.

```bash
threefive3 pts video.ts
```

--------------------------------

### Convert SCTE-35 to JSON Output

Source: https://pypi.org/project/threefive3

Convert SCTE-35 data to JSON format. Specify the input data and the desired output type.

```bash
threefive3 0xfc301600000000000000fff00506fed605225b0000b0b65f3b json 
```

--------------------------------

### Display MPEGTS Iframes PTS

Source: https://pypi.org/project/threefive3

Use the 'iframes' command to show the Presentation Timestamp (PTS) of iframes within an MPEGTS video.

```bash
threefive3 iframes https://example.com/video.ts
```
Tokens:
Raw