scpeters / ign-common

Ignition Common is a component in the ignition framework, a set of libraries designed to rapidly develop robot applications.

Ignition Common : AV, Graphics, Events, and much more.

Maintainer: nate AT openrobotics DOT org

Build	Status
Test coverage
Ubuntu Bionic
Homebrew
Windows

Ignition Common, a component of Ignition Robotics, provides a set of libraries that cover many different use cases. An audio-visual library supports processing audio and video files, a graphics library can load a variety 3D mesh file formats into a generic in-memory representation, and the core library of Ignition Common contains functionality that spans Base64 encoding/decoding to thread pools.

Table of Contents

Features

Install

• Binary Install

• Source Install

  • Prerequisites

  • Building from Source

Usage

Documentation

Testing

Folder Structure

Code of Conduct

Contributing

Versioning

License

Features

Some of the many capabilities contained in Ignition Common are:

• AV: FFMpeg based audio decoder, and video encoder and decoder.
• Core: Base64 encoding and decoding, battery model, console logging, cross-platform filesystem interface, URI processing, and a thread pool.
• Events: Mouse and keyboard events, and a high-performance signal and callback system.
• Graphics: Collada, SVG, STL, OBJ, and DEM loaders. In-memory mesh, image, and material representations. Animation processing and BVH loader.
• Profiler: A common profiler abstraction that can be used to measure and visualize run time of various pieces of ignition robotics software.

Install

We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible.

The Source Install instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.

Binary Install

On Ubuntu systems, apt-get can be used to install ignition-common:

sudo apt install libignition-common<#>-dev

Be sure to replace <#> with a number value, such as 2 or 3, depending on which version you need.

Source Install

Source installation can be performed in UNIX systems by first installing the necessary prerequisites followed by building from source.

Prerequisites

Ignition Common requires:

• Ignition CMake
• Ignition Math.

The Graphics component requires:

• FreeImage
• GTS.

The AV component requires:

• libswscale
• libavdevice
• libavformat
• libavcodec
• libavutil

Building from source

1. Clone the repository

   git clone https://github.com/ignitionrobotics/ign-common
   

2. Install the Prerequisites.

3. Configure and build

   cd ign-common; mkdir build;cd build; cmake ..;  make
   

4. Optionally, install Ignition Common

   sudo make install
   

Usage

Please refer to the examples directory.

Documentation

API and tutorials can be found at https://ignitionrobotics.org/libs/common.

You can also generate the documentation from a clone of this repository by following these steps.

1. You will need Doxygen. On Ubuntu Doxygen can be installed using

   sudo apt-get install doxygen
   

2. Clone the repository

   git clone https://github.com/ignitionrobotics/ign-common
   

3. Configure and build the documentation.

   cd ign-common; mkdir build; cd build; cmake ../; make doc
   

4. View the documentation by running the following command from the build directory.

   firefox doxygen/html/index.html
   

Testing

Follow these steps to run tests and static code analysis in your clone of this repository.

1. Follow the source install instruction.

2. Run tests.

   make test
   

3. Static code checker.

   make codecheck
   

Folder Structure

Refer to the following table for information about important directories and files in this repository.

+-- av                       Header and source files for the AV component.
+-- events                   Header and source files for the Event component.
+-- examples                 Example programs.
+-- graphics                 Header and source files for the Graphics component.
+-- include/ignition/common  Header files for the core component.
+-- profiler                 Header and source files for the Profiler component.
+-- src                      Core source files and unit tests.
+-- test
|    +-- integration         Integration tests.
|    +-- performance         Performance tests.
|    +-- plugins             Plugin tests.
|    +-- static_assertions   Plugin static assertion tests.
|    +-- regression          Regression tests.
+-- tutorials                Tutorials, written in markdown.
+-- Changelog.md             Changelog.
+-- CMakeLists.txt           CMake build script.
+-- Migration.md             Migration guide.

Contributing

Please see CONTRIBUTING.md.

Code of Conduct

Please see CODE_OF_CONDUCT.md.

Versioning

This library uses Semantic Versioning. Additionally, this library is part of the Ignition Robotics project which periodically releases a versioned set of compatible and complimentary libraries. See the Ignition Robotics website for version and release information.

License

This library is licensed under Apache 2.0. See also the LICENSE file.