ROS H264 Video Encoding Library for Amazon Kinesis Video Streams

Overview

This repository contains the h264_encoder_core package, a library for encoding images into video frames. It is used by the h264_video_encoder node.

License

The source code is released under LGPL 2.1. However, h264_encoder_core incorporates several different encoding components which may further restrict the license. By default, x264 is used for software encoding, thereby applying GPL to all of h264_encoder_core.

Author: AWS RoboMaker
Affiliation: Amazon Web Services (AWS)
Maintainer: AWS RoboMaker, ros-contributions@amazon.com

Supported ROS Distributions

• Kinetic
• Melodic

Build status

• Travis CI:
  • ROS build farm:
  • ROS Kinetic @ u16.04 Xenial
  • ROS Melodic @ u18.04 Bionic

Installation

Binaries

On Ubuntu you can install the latest version of this package using the following command

    sudo apt-get update
    sudo apt-get install -y ros-$ROS_DISTRO-h264-encoder-core

Building from Source

To build from source you'll need to create a new workspace, clone and checkout the latest release branch of this repository, install all the dependencies, and compile. If you need the latest development features you can clone from the master branch instead of the latest release branch. While we guarantee the release branches are stable, the master should be considered to have an unstable build due to ongoing development.

• Create a ROS workspace and a source directory

  mkdir -p ~/ros-workspace/src
  

• Clone the package into the source directory .

  Note: Replace _{MAJOR.VERSION}__ below with the latest major version number to get the latest release branch._

  cd ~/ros-workspace/src
  git clone https://github.com/aws-robotics/kinesisvideo-encoder-common.git -b release-v{MAJOR.VERSION}
  

• Install dependencies

  cd ~/ros-workspace 
  sudo apt-get update && rosdep update
  rosdep install --from-paths src --ignore-src -r -y
  

Note: If building the master branch instead of a release branch you may need to also checkout and build the master branches of the packages this package depends on.

• Build the packages

  cd ~/ros-workspace && colcon build
  

• Configure ROS library Path

  source ~/ros-workspace/install/setup.bash