Building GstObuMetadata

From RidgeRun Developer Wiki


Previous: Getting Started/Getting the code Index Next: User Guide





The following instructions shows the steps to build the Gst OBU Metadata plugin.

Dependencies

The GstOBU has the following dependencies:

  • GStreamer 1.22
  • Meson >= 0.60.1

GStreamer

The GStreamer packages are likely already installed in Ubuntu OS distributions. If it is install check the current version with the following command:

gst-launch-1.0 --version

If the version is lower to 1.22 uninstall the current version previous obtaining version 1.22.

To install Gstreamer version 1.22 follow the Building from source guide.

Meson

GstOBU uses Meson to build the plugin. To build correctly use Meson version 1.1 or greater.

First installed meson dependecies:

sudo apt install python3 python3-pip python3-setuptools python3-wheel ninja-build

Then use pip3 to install Meson:

sudo -H pip3 install meson

Hotdoc

This is an optional dependency as Hotdoc is used for documentation. To install Hotdoc use the following command:

sudo -H pip3 install hotdoc

Building the plugin

To build GstOBU plugin natively run the following commands:

meson setup build --prefix /usr/
ninja -C build
sudo ninja -C build install

You can also installed the plugin in a predetermined prefix using the following command at the meson setup:

meson setup build --prefix /path/to/install
ninja -C build
sudo ninja -C build install

For additional customization, you may refer to the following table of options:

`
Configure Option Description
-Dexamples=disabled Skip examples compilation
-Dtests=disabled Skip tests compilation
-Ddoc=disabled Skip documentation generation
--prefix /usr Set the installation path of the library
Table 1. GstSEI configuration options (Meson)


Test installation

After installing the plugin test that the plugin is being properly picked up by GStreamer by running:

gst-inspect-1.0 obu

The expected output looks like:

Plugin Details:
  Name                     obu
  Description              Gstreamer plugin to add metadata as Open Bitstream Units (OBU)
  Filename                 /home/kcarvajal/work/devdirs/gstObuMetadata/install/lib/x86_64-linux-gnu/gstreamer-1.0/libobu.so
  Version                  0.1.0
  License                  Proprietary
  Source module            gst-obu
  Binary package           gst-obu
  Origin URL               https://www.ridgerun.com/

  obuextract: OBU extract metadata
  obuinject: OBU inject metadata
  obumetatester: Helper element to insert a test GstObuMeta to buffers.

  3 features:
  +-- 3 elements

Also check Gstreamer obtain the respective plugin elements running:

gst-inspect-1.0 | grep obu

The expected output looks like:

obu:  obuextract: OBU extract metadata
obu:  obuinject: OBU inject metadata
obu:  obumetatester: Helper element to insert a test GstObuMeta to buffers.



Previous: Getting Started/Getting the code Index Next: User Guide