Skip to main content

Open source package for extracting and parsing telemetry associated with video streams and converting to common formats.

Project description

Open Telemetry Kit

Image of Open Telemetry Kit

The Open Telemetry Kit (OTK) is an open source package for extracting and parsing telemetry associated with video streams and converting to common formats. It comes out of a need for a singular API that can be used for multiple different video telemetry formats.

Telemetry that can be parsed includes: GPS, time, camera information, speed

Features:

  • Automatically detect telemetry format
  • Manipulate telemetry with ease
  • Write telemetry to a new format

Getting Started

Dependencies

Python version: >=3.6

ffmpeg and ffprobe.

On Debian systems these can be installed with:

$ sudo apt install ffmpeg

dateutil

On Debian systems this can be installed with:

$ pip3 install python-dateutil

Installation

$ pip3 install open-telemetry-kit

Importing

The OTK package can be imported into your python3 project with:

import open_telemetry_kit as otk

Quick Start

Download the OTK Quickstart package with sample data

Download the OTK quickstart package (~90 MB). (Mac users can install wget using these instructions)

$ wget https://hivemapper-sample-videos.s3-us-west-2.amazonaws.com/OTK/OTK_quickstart.tgz

This includes a sample .csv, .srt, and .mov with embedded telemetry. It also contains quickstart.py which you can use to extract the telemetry from the sample files.

Extract the package:

$ tar xzvf OTK_quickstart.tgz

This will extract everything into a new directory called OTK_quickstart/

The quickstart.py script accepts a standalone .csv or .srt or a video file with an embedded .srt. It will read in the data, convert it to JSON, and write it to the provided destination.

Telemetry extraction and conversion example

In your terminal go to the new OTK_quickstart directory.

Extract telemetry from the sample video:

$ python3 quickstart.py embedded_srt_example.mov embedded_srt_example.json

Extract telemetry from the sample srt or csv files respectively:

$ python3 quickstart.py srt_example.srt srt_example.json

$ python3 quickstart.py csv_example.csv csv_example.json

Note: This process will create a new JSON file containing the telemetry extracted from the sample file. The data is organized into an array of objects (or, in python terminology, a list of dictionaries)

Data manipulation example

For an example of simple data manipulation, open quickstart.py and uncomment the lines:

# gps = Telemetry()
# for packet in telemetry:
#   gps.append({ k:v for k, v in packet.items() if k in ['latitude', 'longitude', 'altitude']})

# write.telemetryToJson(gps, dest)

Rerun the script with one of the provided commands above.

Current Functionality

Input Formats

The OTK currently supports the following forms of telemetry:

  • .csv files
  • .srt files
  • Any video file with embedded telemetry encoded as a .srt (e.g. video taken with some DJI drone models)
  • .gpx files
  • .kml files

Output Formats

  • JSON

Future Releases

Planned expansions and updates for the OTK include:

Input Formats

  • Open Camera .srt
  • KLV/MISB embedded data

Output Formats

  • geoJSON

Other

  • Unit Tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for open-telemetry-kit, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size open_telemetry_kit-0.1.7-py3-none-any.whl (16.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size open_telemetry_kit-0.1.7.tar.gz (10.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page