Metadata-Version: 2.1
Name: threefive
Version: 2.2.99
Summary: threefive, Pythonic SCTE-35.
Home-page: https://github.com/futzu/threefive
Author: fu-corp
Author-email: spam@so.slo.me
License: UNKNOWN
Description: 
        > threefive is a __SCTE-35 Decoder__ / Parser library in Python3.
        > If you need to parse SCTE-35, this is probably what you want to use.
        
        > threefive can parse SCTE-35 from __Base64, Binary, Hex Strings, Hex literals, Integers, Mpegts files, and Mpegts HTTP/HTTPS Streams__ in one function call.
        
        > __Mpegts is well supported__ in threefive. 
        * Multiple Programs
        * Multiple SCTE35 Streams
        * Multi-Packet PAT, PMT, and SCTE35 tables
        * PCR and PTS to the microsecond. 
        
        > Multicast?  HLS?  Custom Upid Handling?  Frame Accurate Preroll timings? [Oh yeah.](https://github.com/futzu/SCTE35-threefive/tree/master/examples#threefive-examples)
        
        
        > You feedback is welcome and encouraged. __The best parts of threefive
        > have come from other people__. 
        > 
        > If you have something to say, I want to hear it. 
        > 
        > If you have a question, ask it. If it's a stupid question, that's okay, 
        > I ask stupid questions all the time. 
        > 
        
        
        
        * [Requirements](#requirements)
        * [Install threefive](#install)
        * [Versions and Releases](#versions-and-releases)
        
        * [Fast Start](https://github.com/futzu/SCTE35-threefive/blob/master/FastStart.md) 
        
        *   [Easy threefive](#the-decode-function) __sou desu!__
              *   [threefive.decode()](#the-decode-function)      
        
        *  [Advanced threefive](#)     
             *  [threefive.__Cue__ Class](#cue-class)         
             *  [threefive.__Stream__ Class](#stream-class)
             
        * [Super Cool Examples ](https://github.com/futzu/SCTE35-threefive/tree/master/examples#threefive-examples)  
        
        * [__ffmpeg__ and __SCTE35__ and __Stream Type__ and __threefive__](https://github.com/futzu/SCTE35-threefive/blob/master/threefive-ffmpeg.md)   
         
        * [threefive Spotted in The Wild](https://gist.github.com/flavioribeiro/9b52c603c70cdb34c6910c1c5c4d240d)
        
        *  [Code of Conduct](https://github.com/futzu/threefive/blob/master/CODE_OF_CONDUCT.md).
        
        * [Issues and Bugs and Feature Requests](#issues-and-bugs-and-feature-requests)
        
        
        
        ### Requirements
        threefive requires python 3.6+ or [pypy3](https://pypy.org)
        
        ### Install
           
        ```sh
        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
        
        ####   The __decode__ Function
        
        
        
        > __threefive.decode__ is a SCTE-35 decoder function
        > with input type __auto-detection__.
        
        > __SCTE-35__ data can be __parsed__ 
        > with just __one function call__.
            
        > the arg __stuff__ is the input.
        > if __stuff is not set__, 
        > decode will attempt to __read__ from __sys.stdin.buffer__.
        
        > if __stuff is a file__, the file data
        > will be read and the type of the data
        > will be autodetected and decoded.
        
        > SCTE-35 data is __printed in JSON__ format.
        
        
        #### threefive.decode Examples:
        
        ##### Base64
        ```python3
        import threefive 
        
        stuff = '/DAvAAAAAAAA///wBQb+dGKQoAAZAhdDVUVJSAAAjn+fCAgAAAAALKChijUCAKnMZ1g='
        threefive.decode(stuff)
        ```
        ##### Bytes
        ```python3
        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
        ```python3
        import threefive 
        
        stuff = '0XFC301100000000000000FFFFFF0000004F253396'
        threefive.decode(stuff)
        ```
        ##### Hex Literal
        ```python3
        import threefive 
        
        threefive.decode(0XFC301100000000000000FFFFFF0000004F253396)
        ```
        ##### Integer
        ```python3
        big_int = 1439737590925997869941740173214217318917816529814
        threefive.decode(big_int)
        ```
        ##### Mpegts File
        ```python3
        import threefive 
        
        threefive.decode('/path/to/mpegts')
        ```
        ##### Mpegts HTTP/HTTPS Streams
        ```python3
        import threefive 
        
        threefive.decode('https://futzu.com/xaa.ts')
        ````
        
        ##### Read from File [cue.txt](https://github.com/futzu/threefive/files/6986120/cue.txt)
        
        ```python3
        from threefive import decode
        
        decode('cue.txt')
        
        ```
        
        ___
        
        
        #  Advanced threefive
        
        ___
        
        ###  Cue Class
        
        
           *  src [cue.py](https://github.com/futzu/SCTE35-threefive/blob/master/threefive/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.
           
        ```python3
            >>>> import threefive
            >>>> Base64 = "/DAvAAAAAAAA///wBQb+dGKQoAAZAhdDVUVJSAAAjn+fCAgAAAAALKChijUCAKnMZ1g="
            >>>> cue = threefive.Cue(Base64)
        ```
        
        > cue.decode() returns True on success,or False if decoding failed
        ```python3
            >>>> cue.decode()
            True
        ```
        > After Calling cue.decode() the instance variables can be accessed via dot notation.
        ```python3
        
            >>>> 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
        
        
         ```python3
          threefive.Stream(tsdata, show_null = False)
          ```
        
          * src [stream.py](https://github.com/futzu/SCTE35-threefive/blob/master/threefive/stream.py)
          * The threefive.__Stream__ class parses SCTE35 messages from a file or stream.
          * Supports 
          	* __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__()](#streamshow)                 |__Prints__ Streams that will be checked for SCTE35 
         [Stream.__decode__(func=show_cue)](#streamdecodefuncshow_cue)                                                                             | __Prints__ SCTE-35 __cues__ for SCTE-35 packets. Accepts an optional function, func, as arg.
        [Stream.__decode_next__()](#streamdecode_next)|__Returns__ the next SCTE35 cue as a threefive.Cue instance. 
        [Stream.__decode_program__(the_program=None, func=show_cue)](#streamdecode_programthe_program-func--show_cue) |Same as Stream.__decode__ except only packets where program == __the_program__
        [Stream.__decode_proxy__(func=show_cue)](#streamdecode_proxyfunc--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.
        
        ```python3
        >>>> from threefive import Stream, version
        >>>> version()
        '2.2.69'
        >>>> with open('video.ts','rb') as tsdata:
        ....     strm = Stream(tsdata)
        ....     strm.show()
        ....     
        
        Program:1030
                PID: 1034(0x40a) Type: 0x6
                PID: 1035(0x40b) Type: 0x86 SCTE35
        
        Program:1100
                PID: 1104(0x450) Type: 0x6
                PID: 1105(0x451) Type: 0x86 SCTE35
        
        Program:1080
                PID: 1084(0x43c) Type: 0x6
        
        ```
        ___
        
        
        #### Stream.decode(func=show_cue)
         
         ```python3
         import sys
         from threefive import Stream
         
         if __name__ =='__main__':
            with open(sys.argv[1],'rb') as tsdata:
                sp = Stream(tsdata)
                sp.decode()
        
        ```
        
          *   Pass in custom function 
        
          *  __func__ should match the interface 
          ``` func(cue)```
         
         
        ```python3
        import sys
        import threefive
        
        def display(cue):
           print(f'\033[92m{cue.packet_data}\033[00m')
           print(f'{cue.command.name}')
        
        def do():
           with open(sys.argv[1],'rb') as tsdata:
            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.
        
        ```python3
        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__
        
        ```python3
        import threefive
        
        with open('../35.ts','rb') as tsdata:
            threefive.Stream(tsdata).decode_program(1)
        ```
        ___
        
        
        #### Stream.decode_proxy(func = show_cue)
        
        *  Writes all packets to __sys.stdout__.
        
        *  Writes scte35 data to __sys.stderr__.
        
        ```python3
        
        import threefive
        
        with open('vid.ts','rb') as tsdata:
            sp = threefive.Stream(tsdata)
            sp.proxy_decode()
        ```
        
        * Pipe to __mplayer__
        ```bash
        $ 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__. 
        
        > If you want help resolving a video parsing issue, __a sample of the video is required__ .
        
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6
Description-Content-Type: text/markdown
