threefive 3.0.93__tar.gz → 3.0.97__tar.gz

{threefive-3.0.93 → threefive-3.0.97}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: threefive
-Version: 3.0.93
+Version: 3.0.97
 Summary: threefive is The #1 SCTE-35 Decoder and Encoder on the Planet.
 Author-email: AdrianofDoom <spam@iodisco.com>
 License-Expression: Sleepycat
@@ -17,47 +17,115 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
 
-# threefive is the highest rated SCTE-35 tool. Ever.
+_A lot of people consider me to be a subject matter expert on SCTE-35,<BR> I see myself more as the undisputed heavy weight champion of SCTE-35._ ~Adrian
+
+# [ threefive ] 
+
+# Over 1.2 Million Installs.
+
+
+
 *   __Decodes SCTE-35__ from `MPEGTS`✔ `Base64`✔ `Bytes`✔ `DASH`✔ `Hex` ✔ `HLS`✔ `Integers`✔ `JSON`✔ `XML`✔ `XML+Binary`✔  
 *   __Encodes SCTE-35__ to `MPEGTS`✔ `Base64`✔ `Bytes`✔ `Hex`✔ `Integers`✔ `JSON`✔ `XML`✔ `XML+Binary`✔
-___
 
-## [ News ]
-* __threefive__ now has support for __SCTE-35-2. Event Descriptors__ and __Property types__ from the recently published __2026 SCTE-35-2 Specification__.
-* __threefive v3.0.93__ now supports HLS autodetection in the cli.
-___
+# [ version ]
 
-## [ Latest threefive version is  v3.0.93 ] _Released 06/11/2026_
-___
-##  [[ Examples ]](https://github.com/superkabuki/threefive_is_scte35/blob/main/examples)
-___
-## [ [ Tip of the Week ] ](totw.md)
+### __latest is v.3.0.97__
+
+
+# [ really really quick start ]
+
+* __Install__
+```
+ python3 -m pip install threefive`
+```
+* __decoding SCTE-35__
+	* __base64__ 
+		* decode __SCTE-35__ as __base64__
+		```cobol
+		threefive '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q=='
+		```
+		* decode __SCTE-35__ as __base64__ and __convert SCTE-35 to hex__
+		```cobol
+		threefive '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q==' hex
+		```
+ 	* __Hex__
+		* decode __SCTE-35__ as __hex__
+		```cobol
+		threefive '0xfc301600000000000000fff00506fe00a98ac700000b3baed9'
+		```
+		* decode __SCTE-35__ as __hex__ and __convert__ __SCTE-35__ to __xml__
+		```cobol
+		threefive '0xfc301600000000000000fff00506fe00a98ac700000b3baed9' xml
+		```
+	* __HLS__
+		* decode __SCTE-35__ from __HLS__ ( a rendition or a master.m3u8)
+		```cobol
+		threefive 'https://demo.unified-streaming.com/k8s/live/scte35.isml/.m3u8'
+		```
+ 	* __MPEGTS__
+		* decode  __SCTE-35__ from __MPEGTS__
+		```cobol
+		threefive 'https;//iodisco.com/longb2.ts'
+		```
+		* decode  __SCTE-35__ from __MPEGTS__ and __convert__ __SCTE-35__ to __bytes__
+		```cobol
+		threefive 'https;//iodisco.com/longb2.ts' bytes
+		```
+ 	* __Multicast__
+		* decode __SCTE-35__ from __MPEGTS__ over __Multicast__ 
+		```cobol
+		threefive udp://@235.3.5.35:3535
+		```
+ 
+* __threefive does a lot more__, that was just to get you started.
 ___
-# [ Documentation ]
+
+# [ Documentation ] 
+
+ [A Lot of Examples ](https://github.com/superkabuki/threefive_is_scte35/blob/main/examples)  |  [  Tip of the Week  ](totw.md)  |   [  Cheap Tricks   ](cheaptricks.md) | 
+
+
 #### Need to inject SCTE-35 into HLS?  [X9k3.](https://github.com/superkabuki/x9k3)
+
 * [__web based SCTE-35 tools__](#web) - threefive and friends over http. 
+
 * [__install__](#install)
+
 * [__quick start__](quickstart.md)
-* __command line tools__
-	* [ __threefive__](#cli) _decode SCTE-35 on the command line_
-  	* [__scte35bump__](#scte35bump) _adjust SCTE-35 PTS in MPEGTS streams_ 
+
+* ___SCTE-35 on the command line___   
+	* [ __the threefive cli tool__](#-cli-) _If you work with SCTE-35, this is as cool as it gets._  
+
+* __other included tools__
     * [__scte35fix__](#scte35fix)  _ffmpeg changes scte-35 streams into bin data, scte35fix changes them back._
 	* [__scte35inject__](scte35inject.md) _scte35inject inject scte-35 into mpegts._
   	* [__gums__](#gums) _gums is a  multicast sender(server) for video_ 
-* __library__
+
+
+* __the threefive library__ _cool code for the cool kids_.
  	* [__Using the threefive.Cue class__](lib.md) 
-	* [__Using the threefive library__](#using-the-library) _decode SCTE-35 with less than ten lines of code_
+	* [__Using the threefive library__](#-using-the-library-) _decode SCTE-35 with less than ten lines of code_
  	* * [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_
+
 * [SCTE-35 __Sidecar Files__](https://github.com/superkabuki/SCTE-35_Sidecar_Files) _threefive supports SCTE-35 sidecar files_
-* [SCTE-35 __HLS__](https://github.com/superkabuki/threefive/blob/main/hls.md) _parse SCTE-35 in HLS__
+
+* [SCTE-35 __HLS__](https://github.com/superkabuki/threefive/blob/main/hls.md) _parse SCTE-35 in HLS in MPEGTS,CMAF, or fmP4__
+
 * [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_
+
 * [Make your __threefive__ script an executable with __cython__](cython.md) _threefive is compatible with all python tools_
 </samp>
 
 ##  [Install]
+
+* __threefive__ is curretnly tested on python-3.11, python-3.14, python-3.14t, pypy-7.3.11 and pypy-7.3.22
+
+* __threefive__ is some of the __fastest code__ you'll see on __python3__. 
 * __python3 via pip__
 ```rebol
 python3 -mpip install threefive
@@ -96,121 +164,120 @@ make install py3=python3.14
 # works for any python in your path or use a full path if needed.
 
 ```
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 ___
 
-### [CLI]
-The threefive cli tool is able to parse SCTE-35 from MPEGTS Streams,Base64,Hex,Integers,JSON XML,and XMLBinary.
-The format is auto-detected.
+## [ CLI ]
+threefive is designed to be easy to use. I'm not sure that it's served well by a long explaination, so I'm going to try and keep this brief. 
 
-# [⇧](#-documentation-)
+### The threefive cli tool.
 
-#### [ Parse SCTE-35 from HLS with threefive ]
-```js
-threefive https://example.com/master.m3u8
-```
+ the threefive cli tool decodes SCTE-35, formats are autodetected, and they all work the same way. 
 
-#### [ Parse SCTE-35 from MPEGTS ]
-SCTE-35 can be parsed from MPEGTS over a variety of protocols.
-* __SCTE-35 Input__: MPEGTS
-*  __Protocols__: pipes, files, stdin, http(s), multicast,SRT and UDP.
-* __SCTE-35 Output__: JSON _(default)_ base64, bytes, hex, int, xml, and xmlbin.
+threefive [media to parse for SCTE-35]
 
-|SCTE-35 Input  | Protocol   | SCTE-35 Output     | Command                                             |
-|-------|------------|-----------|---------------------------------------------------------|
-|__MPEGTS__|file|__JSON__   | __threefive__ video.ts										 |  
-|__.__|https|__base64__ | __threefive__ https://example.com/video.ts  __base64__      |
-|__.__|multicast|__bytes__ | __threefive__ udp://@235.3.5:3535  __bytes__      |
-|__.__|SRT|__hex__ | __threefive__ srt://1.2.3.4:4201  __hex__      |
-|__.__|UDP|__int__ | __threefive__ udp://10.10.10.10:1011  __int__      |
-|__.__|Pipe|__xml__| cat video.ts \| __threefive__  __xml__                           |
-|__.__|stdin|__xml+bin__| __threefive__  __xmlbin__ < video.ts|
+examples:
 
-___
+*
+```sed
+threefive '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q=='
+```
+*
+```sed
+threefive 0xfc301600000000000000fff00506fe00a98ac700000b3baed9
+```
+*
+```sed
+threefive 1583008701074197245727019716796221242036302348025116111908569
+```
+*
+```sed
+threefive video.ts
+```
+*
+```sed
+threefive https://demo.unified-streaming.com/k8s/live/scte35.isml/scte35-audio_eng=64000-video=500000.m3u8
+```
 
-# [⇧](#-documentation-)
+* Formats like XML and JSON that may be to large to type on the command line,they can be redirected or piped in to threefive.
 
-#### [ Parse SCTE-35 Cues ]
-
-  *  The __default output__ is JSON
-  *  __SCTE-35 Inputs:__  base64, hex, int, JSON,int,xml,and xmlbin.
-  *  __SCTE-35 Outputs:__ base64, bytes, hex, int,JSON, xml, and xmlbin.
-  *  __Any Input can be used with Any Output__
-
-> __Here are several examples.__
-
-|SCTE-35 Input  |  SCTE-35 Output     | Command                                             |
-|-------|-----------|---------------------------------------------------------|
-|__base64__|__JSON__    | __threefive__ '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q==' |
-|__.__|__bytes__    | __threefive__ '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q==' __bytes__|
-|__.__|__hex__    | __threefive__ '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q==' __hex__|
-|__.__|__xml__    | __threefive__ '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q==' __xml__|
-|__hex__  | __JSON__  | __threefive__ 0xfc301600000000000000fff00506fe00a98ac700000b3baed9|
-|__.__  | __base64__  | __threefive__ 0xfc301600000000000000fff00506fe00a98ac700000b3baed9 __base64__ |
-|__.__  | __int__  | __threefive__ 0xfc301600000000000000fff00506fe00a98ac700000b3baed9 __int__ |
-|__.__  | __xmlbin__  | __threefive__ 0xfc301600000000000000fff00506fe00a98ac700000b3baed9 __xmlbin__ |
-| __int__ | __JSON__    | __threefive__ 1583008701074197245727019716796221242036302348025116111908569  |  
-|__.__ | __hex__    | __threefive__ 1583008701074197245727019716796221242036302348025116111908569 __hex__ |  
-|__.__ | __xml__    | __threefive__ 1583008701074197245727019716796221242036302348025116111908569 __xml__ |
-|__JSON__ |__base64__    | __threefive__  < json.json  __base64__                         |
-|__.__  |__bytes__    | __threefive__  < json.json  __bytes__                         |
-|__.__  |__xml__    | __threefive__  < json.json  __xml__                         |
-|__xml__   |__JSON__   | __threefive__   < xml.xml                                   |
-|__xmlbin__|__int__    | __threefive__   < xmlbin.xml __int__                        |
+* redirect
+```sed
+threefive < xml.xml
+```
+* pipe
+```sed
+cat json.json | threefive
 
-___
+```
+### cli outputs and converting SCTE-35 Formats
 
-# [⇧](#-documentation-)
+* the __default output format for threefive is json__
 
-#### [__Additional functionality__]
-* threefive has several additional features, mostly related to MPEGTS streams.
-* threefive has built in help, just type `threefive help`
-* This table shows how to use them.
-
-| Description                              | How To Use                                       |
-|------------------------------------------|---------------------------------------------------------|
-| Inject __SCTE35__ packets                |threefive __inject__ -i in.video -s sidecar.txt -o out.ts|
-| Show raw __SCTE35__ packets              |threefive __packets__ udp://@235.35.3.5:3535             |
-| Copy MPEGTS stream to stdout at realtime speed| threefive __rt__ input.ts | mplayer -				|
-| Create __SCTE35__ sidecar file           |threefive __sidecar__ video.ts                           |
-| Show streams in mpegts stream            | threefive __show__ https://example.com/video.ts         |
-| Show __iframes__ in mpegts stream        |threefive __iframes__ srt://10.10.1.3:9000               |
-| Show __PTS__ values from mpegts stream   | threefive __pts__ udp://192.168.1.10:9000               |
-|__Proxy__ the __mpegts__ stream to stdout |threefive __proxy__ https://wexample.com/video.ts        |
-|                                          |                                                         |
-|                                          |                                                         |
+* The cli tool can convert from one SCTE-35 format to another using keywords.
+    * The keywords are __base64,bytes,hex, int,json,xml, and xmlbin__ 
 
-___
+* some conversion examples
 
-# [⇧](#-documentation-)
 
+* SCTE-35 Base64 to SCTE-35 Hex
+```sed
+threefive '/DAWAAAAAAAAAP/wBQb+AKmKxwAACzuu2Q==' hex
+```
+* SCTE-35 Int to SCTE-35 Xml
+```sed
+threefive 1583008701074197245727019716796221242036302348025116111908569 xml
+```
+* SCTE-35 Hex to SCTE-35 xml+binary
+```sed
+threefive 0xfc301600000000000000fff00506fe00a98ac700000b3baed9 xmlbin
+```
 
-### Other tools
-threefive also comes with: 
-#### scte35bump 
+### threefive cli and MPEGTS
+* threefive can parse MPEGTS from stdin, local files, HTTP(s), Multicast, SRT, and unicast UDP. 
 
-* bump adjusts SCTE-35 PTS in an MPEGTS stream
+* some mpegts examples
 
-```js
-$ scte35bump -h
-usage: scte35bump [-h] [-i INFILE] [-o OUTFILE] [-s SECS]
+* local
+```sed
+threefive video.ts
+```
+* stdin
+```sed
+cat video.ts | threefive 
+```
+* https
+```sed
+threefive https://iodisco.com/longb2.ts
+```
+* multicast
+```sed
+threefive udp://@235.35.3.5:3535 
+```
 
-options:
-  -h, --help            show this help message and exit
-  -i INFILE, --infile INFILE
-                        Input source, stdin, file, http(s), udp, or multicast
-                        mpegts [default: sys.stdin.buffer]
-  -o OUTFILE, --outfile OUTFILE
-                        Output file [default: sys.stdout.buffer]
-  -s SECS, --secs SECS  Adjustment to apply to SCTE-35 Cues. [default: 0.0]
+### threefive cli MPEGTS outputs
+
+* the __default output for MPEGTS is json__
+
+* keywords can be used to specify other output formats
+   * The keywords are __base64,bytes,hex, int,json,xml, and xmlbin__ 
 
-scte35bump is part of threefive.
+* An example of mpegts with a keyword
 ```
+threefive https://iodisco.com/longb2.ts xml
+```
+
+
 ___
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
+
+
+##### Other tools
+
+threefive also comes with: 
 
-#### gums
+##### gums
 *  the Grande Udp Multicast Server
 
 ```js
@@ -230,7 +297,7 @@ options:
 gums is part of threefive.
 ```
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
 #### HLS
 
@@ -239,27 +306,115 @@ gums is part of threefive.
 ```js
 $ threefive hls help
 ```
+```smalltalk
 
 [ Input ]
-    threefive hls takes an m3u8 URI as input.
-    M3U8 formats supported:
-        * master  ( When a master.m3u8 used,
-                   threefive hls parses the first rendition it finds )
-        * rendition
-    Segment types supported:
-    * AAC
-    * AC3
-    * MPEGTS
-    *codecs:
-        * video
-            * mpeg2, h.264, h.265
-        * audio
-            * mpeg2, aac, ac3, mp3
+
+A m3u8 URI as input.
+
+[what is supported]
+
+    M3U8 formats: master, rendition
+    Segment types: AAC, AC3, MPEGTS, CMAF,fMP4
+    Video codecs: mpeg2, h.264, h.265
+	Audio codecs: mpeg2, aac, ac3, mp3
+    Protocols: File, Http(s), Multicast, SRT, Stdin, UDP
+    Encryption: AES-128 (automatic)
+
+[ SCTE-35 ]
+
+  SCTE-35 Embedded Cues as well as all SCTE-35 HLS Tags can be parsed.
+
+  [ Supported HLS Tags ]
+
+	* #EXT-OATCLS-SCTE35
+    * #EXT-X-CUE-OUT-CONT
+    * #EXT-X-DATERANGE
+    * #EXT-X-SCTE35
+    * #EXT-X-CUE-IN
+    * #EXT-X-CUE-OUT
+
+[ SCTE-35 Parsing Profiles ]
+
+    SCTE-35 parsing can be fine tuned by setting a parsing profile.
+
+    running the command:  threefive hls profile
+
+    will generate a default profile and write a file named hls.profile
+    in the current working directory.
+
+    a@fu:~$ cat hls.profile
+
+    expand_cues = False
+    parse_segments = False
+    parse_manifests = True
+    hls_tags = #EXT-OATCLS-SCTE35,#EXT-X-CUE-OUT-CONT,
+    #EXT-X-DATERANGE,#EXT-X-SCTE35,#EXT-X-CUE-IN,#EXT-X-CUE-OUT
+    command_types = 0x6,0x5
+    descriptor_tags = 0x2
+    starts = 0x22,0x30,0x32,0x34,0x36,0x44,0x46
+
+    ( Integers are show in hex (base 16),
+      base 10 unsigned integers can also be used in hls.profile )
+
+    * expand_cues:       set to True to show cues fully expanded as JSON
+    * parse_segments:    set to true to enable parsing SCTE-35 from MPEGTS.
+    * parse_manifests:   set to true to parse the m3u8 file for SCTE-35 HLS Tags.
+    * hls_tags:          set which SCTE-35 HLS Tags to parse.
+    * command_types:     set which Splice Commands to parse.
+    * descriptor_tags:   set which Splice Descriptor Tags to parse.
+    * starts:            set which Segmentation Type IDs to use to start breaks.
+
+    Edit the file as needed and then run threefive.
+
+[ Profile Formatting Rules ]
+
+    * Values do not need to be quoted.
+    * Multiple values are separated by a commas.
+    * No partial line comments. Comments must be on a separate lines.
+    * Comments can be started with a # or //
+    * Integers can be base 10 or base 16
+
+[ Output Files ]
+	scte35 hls creates a few output files.
+
+	* Profile rules applied to the output:
+
+		* hls.m3u8  - live playable rewrite of the m3u8 with the profile SCTE-35 rules.
+        * hls.sidecar - list of ( pts, HLS SCTE-35 tag ) pairs
+
+	* Profile rules not applied to the output:
+
+		* hlsflat.m3u8  - hls live streams are flattened out into a vod playlist.
+                     When the live m3u8  first loads, every line is written to hlsflat.m3u8
+                     Wnen a live m3u8 is reloaded, everything except the headers
+                    is appended to hlsflat.m3u8. This give you a VOD style m3u8
+                    so you can fast forward or rewind while playing.
+                    GREAT for debugging SCTE-35 live hls.
+
+[ Cool Features ]
+
+    * threefive can resume when started in the middle of an ad break.
+
+            2023-10-13T05:59:50.24Z Resuming Ad Break
+            2023-10-13T05:59:50.34Z Setting Break Timer to 17.733
+            2023-10-13T05:59:50.44Z Setting Break Duration to 60.067
+
+[ Example Usage ]
+
+	* Show this help:   threefive hls help
+
+	* Generate a new hls.profile:   threefive hls profile
+
+	* parse an m3u8:    scte35hls  https://example.com/out/master.m3u8
+
+
 ```
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
 #### __scte35fix__
+
 * when ffmpeg changes a SCTE-35 stream to bin data stream, scte35fix changes it back. 
 
 ```js
@@ -284,9 +439,9 @@ scte35fix is part of threefive.
 ```
 ___
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
-### [Using the library]
+## [ Using the library ]
 * Let me show you how easy threefive is to use.
 
 * reading SCTE-35 xml from a file
@@ -523,9 +678,9 @@ Type "help", "copyright", "credits" or "license" for more information.
 ```
 ___
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
-### [web]
+#### [web]
 * [threefive SCTE-35 __Online Parser__](https://iodisco.com/scte35) __hosted on my server iodisco.com__
 * Parse SCTE-35 in MPEGTS over HTTP, in your browser with[ Go, Wasm and Super Karate Death Car](https://bigcorp.ltd/gowasm) __hosted om my server bigcorp.ltd__
 *  Parse SCTE-35 in MPEGTS over HTTP, in your browser with[ threefive.js,javascript, and a little sed](https://bigcorp.ltd/bread) just to keep things interesting. __hosted om my server bigcorp.ltd__
@@ -534,17 +689,17 @@ ___
 __hosted on my server iodisco.com__
 ___
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
-### [XML]
+#### [XML]
 * [XML](https://github.com/superkabuki/SCTE-35/blob/main/xml.md) __New__! _updated 05/01/2025_
 
-### [HLS]
+#### [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?
 
- # [⇧](#-documentation-)
+ #### [⇧](#-documentation-)
  
-###  [Classes]
+####  [Classes]
 * The python built in help is always the most up to date docs for the library.
 
 ```py3
@@ -562,9 +717,9 @@ a@fu:~/build7/threefive$ pypy3
 
 ___
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
-### [threefive now supports SRT]
+#### [threefive now supports SRT]
 
 * _( You have to unmute the audio )_
 
@@ -579,9 +734,9 @@ https://github.com/user-attachments/assets/a323ea90-867f-480f-a55f-e9339263e511
 
 ___
 
-# [⇧](#-documentation-)
+#### [⇧](#-documentation-)
 
-### [more]
+##### [more]
 
 * [Encode SCTE-35](https://github.com/superkabuki/threefive/blob/main/encode.md) Some encoding code examples. 
 ___