Metadata-Version: 1.2
Name: klvdata
Version: 0.0.1
Summary: A Python library for parsing MISB/STANAG 4609 Key Length Value (KLV) metadata.
Home-page: https://github.com/paretech/klvdata/
Author: paretech
Author-email: paretech@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: klvdata
        =======
        .. image:: https://travis-ci.org/paretech/klvdata.svg?branch=master
            :target: https://travis-ci.org/paretech/klvdata
        
        .. image:: https://coveralls.io/repos/github/paretech/klvdata/badge.svg?branch=master
            :target: https://coveralls.io/github/paretech/klvdata?branch=master
        
        .. image:: https://img.shields.io/pypi/v/klvdata.svg
                :target: https://pypi.org/project/klvdata/
        
        What?
        -----
        Klvdata is a Python library for parsing and constructing Key Length Value (KLV_) formatted binary streams. Common uses of the library would be parsing and displaying `MISB ST`_ 0601 Unmanned Air System (UAS) metadata from `STANAG 4609`_ compliant `MPEG-2 Transport Streams (TS) (MPEG-TS)`_. Note that klvdata alone cannot de-mux KLV data from an MPEG-2 TS, but programs like FFmpeg_ and GStreamer_ can be used with klvdata in the workflow to perform the function.
        
        .. _KLV: https://en.wikipedia.org/wiki/KLV
        .. _STANAG 4609: http://www.gwg.nga.mil/misb/docs/nato_docs/STANAG_4609_Ed3.pdf
        .. _MPEG-2 Transport Streams (TS) (MPEG-TS): https://en.wikipedia.org/wiki/MPEG_transport_stream
        .. _MISB ST: http://www.gwg.nga.mil/misb/st_pubs.html
        .. _FFMpeg: https://www.ffmpeg.org/
        .. _GStreamer: https://gstreamer.freedesktop.org/
        
        
        Why?
        ----
        Not many opensource options available.
        
        Features
        --------
        - Parses KLV metadata streams.
        - Supports `MISB ST`_ 0601 UAS Datalink Local Set.
        - Supports `MISB ST`_ 0102 Security Metadata Local Set.
        - Built for Python 3.5, 3.6.
        - Requires no external Python dependencies.
        
        .. _MISB ST: http://www.gwg.nga.mil/misb/st_pubs.html
        
        Quick Start
        -----------
        Try these commands in your GNU/Linux terminal.
        
        First:
        
        .. code-block:: console
        
            $ pip install klvdata
            
            $ wget https://raw.githubusercontent.com/paretech/klvdata/master/data/DynamicConstantMISMMSPacketData.bin
        
            $ cat << EOF > klvdata_test.py
            #!/usr/bin/env python
            import sys, klvdata;
            for packet in klvdata.StreamParser(sys.stdin.buffer.read()): packet.structure()
            EOF
        
        
        And then:
        
        .. code-block:: console
        
        	$ ./klvdata_test.py < DynamicConstantMISMMSPacketData.bin
        
        		<class 'klvdata.misb0601.UASLocalMetadataSet'>
        		    <class 'klvdata.misb0601.PrecisionTimeStamp'>
        		    <class 'klvdata.misb0601.MissionID'>
        		    <class 'klvdata.misb0601.PlatformHeadingAngle'>
        		    <class 'klvdata.misb0601.PlatformPitchAngle'>
        		    <class 'klvdata.misb0601.PlatformRollAngle'>
        		    <class 'klvdata.misb0601.PlatformDesignation'>
        		    <class 'klvdata.misb0601.ImageSourceSensor'>
        		    <class 'klvdata.misb0601.ImageCoordinateSystem'>
        		    <class 'klvdata.misb0601.SensorLatitude'>
        		    <class 'klvdata.misb0601.SensorLongitude'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0102.SecurityLocalMetadataSet'>
        		            <class 'klvdata.misb0102.SecurityClassification'>
        		            <class 'klvdata.misb0102.UnknownElement'>
        		            <class 'klvdata.misb0102.UnknownElement'>
        		            <class 'klvdata.misb0102.UnknownElement'>
        		            <class 'klvdata.misb0102.UnknownElement'>
        		            <class 'klvdata.misb0102.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.UnknownElement'>
        		    <class 'klvdata.misb0601.Checksum'>
        
        If you have FFmpeg installed and want to try it on real video from a drone with embedded KLV metadata (~97 MB Download):
        
        .. code-block:: console
        
            $ wget http://samples.ffmpeg.org/MPEG2/mpegts-klv/Day%20Flight.mpg
            $ ffmpeg -i data/Day\ Flight.mpg -map data-re -codec copy -f data - | ./klvdata_test.py
        
        	    <class 'klvdata.misb0601.UASLocalMetadataSet'>
        	        <class 'klvdata.misb0601.PrecisionTimeStamp'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.PlatformHeadingAngle'>
        	        <class 'klvdata.misb0601.PlatformPitchAngle'>
        	        <class 'klvdata.misb0601.PlatformRollAngle'>
        	        <class 'klvdata.misb0601.ImageSourceSensor'>
        	        <class 'klvdata.misb0601.ImageCoordinateSystem'>
        	        <class 'klvdata.misb0601.SensorLatitude'>
        	        <class 'klvdata.misb0601.SensorLongitude'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.UnknownElement'>
        	        <class 'klvdata.misb0601.Checksum'>
        
        	       [...]
        
        Documentation
        -------------
        Documentation is available at https://paretech.github.io/klvdata.
        
        Contributing
        ------------
        Contributions are welcome!
Keywords: STANAG 4609,MISB,KLV,Metadata,Video
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Multimedia :: Video :: Conversion
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5
