/amazon-kinesis-video-streams-pic

Primary LanguageC++Apache License 2.0Apache-2.0

Amazon Kinesis Video Streams PIC

Platform Indendent Code for Amazon Kinesis Video Streams

Build Status Coverage Status

Key Features • Build • Run • Documentation • Related • License

Key Features

Build

Download

To download run the following command:

git clone https://github.com/awslabs/amazon-kinesis-video-streams-pic.git

You will also need to install pkg-config and CMake and a build enviroment

Configure

Create a build directory in the newly checked out repository, and execute CMake from it.

mkdir -p amazon-kinesis-video-streams-pic/build; cd amazon-kinesis-video-streams-pic/build; cmake ..

By default we download all the libraries from GitHub and build them locally, so should require nothing to be installed ahead of time. If you do wish to link to existing libraries you can use the following flags to customize your build.

Cross-Compilation

If you wish to cross-compile CC and CXX are respected when building the library and all its dependencies. See our .travis.yml for an example of this. Every commit is cross compiled to ensure that it continues to work.

CMake Arguments

You can pass the following options to cmake ...

  • -DBUILD_DEPENDENCIES -- Whether or not to build depending libraries from source
  • -DBUILD_TEST=TRUE -- Build unit/integration tests, may be useful for confirm support for your device. ./tst/webrtc_client_test
  • -DCODE_COVERAGE -- Enable coverage reporting
  • -DCOMPILER_WARNINGS -- Enable all compiler warnings
  • -DADDRESS_SANITIZER -- Build with AddressSanitizer
  • -DMEMORY_SANITIZER -- Build with MemorySanitizer
  • -DTHREAD_SANITIZER -- Build with ThreadSanitizer
  • -DUNDEFINED_BEHAVIOR_SANITIZER Build with UndefinedBehaviorSanitizer
  • -DBUILD_DEBUG_HEAP Build debug heap with guard bands and validation. This is ONLY intended for low-level debugging purposes. Default is OFF
  • -DALIGNED_MEMORY_MODEL Build for aligned memory model only devices. Default is OFF.

Build

To build the library run make in the build directory you executed CMake.

make

Note on alignment

The entire PIC codebase is built with aligned memory access to machine native word (up-to 64 bit). The only exception is the heap implementation. In order to provide for tight packing and low-fragmentation, we default to unaligned heap access. For devices and OS-es that do not have unaligned access or unaligned access emulation, -DALIGNED_MEMORY_MODEL CMake argument should be passed in build-time to ensure heap is aligned.

Documentation

Related

License

This library is licensed under the Apache 2.0 License.