View source for GstObuMetadata/Getting Started/Building GstObuMetadata

<noinclude>
{{GstObuMetadata/Head|previous=Getting Started/Getting the code|next=User Guide|metakeywords=metadata, AV1, OBU|title=Building GstObuMetadata|}}
</noinclude>

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:

<syntaxhighlight lang=bash>
gst-launch-1.0 --version
</syntaxhighlight>

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 [https://gstreamer.freedesktop.org/documentation/installing/building-from-source-using-meson.html?gi-language=c 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:

<syntaxhighlight lang=bash>
sudo apt install python3 python3-pip python3-setuptools python3-wheel ninja-build
</syntaxhighlight>

Then use pip3 to install Meson:

<syntaxhighlight lang=bash>
sudo -H pip3 install meson
</syntaxhighlight>

=== Hotdoc ===

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

<syntaxhighlight lang=bash>
sudo -H pip3 install hotdoc
</syntaxhighlight>

== Building the plugin ==

To build GstOBU plugin natively run the following commands:

<syntaxhighlight lang=bash>
meson setup build --prefix /usr/
ninja -C build
sudo ninja -C build install
</syntaxhighlight>

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

<syntaxhighlight lang=bash>
meson setup build --prefix /path/to/install
ninja -C build
sudo ninja -C build install
</syntaxhighlight>

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

<center>`
{| class="wikitable"
|-
! 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
|}
<b>Table 1.</b> GstSEI configuration options (Meson)</caption>
</center>


== Test installation ==

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

<syntaxhighlight lang=bash>
gst-inspect-1.0 obu
</syntaxhighlight>

The expected output looks like:

<syntaxhighlight lang=bash>
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
</syntaxhighlight>

Also check Gstreamer obtain the respective plugin elements running:

<syntaxhighlight lang=bash>
gst-inspect-1.0 | grep obu
</syntaxhighlight>

The expected output looks like:

<syntaxhighlight lang=bash>
obu:  obuextract: OBU extract metadata
obu:  obuinject: OBU inject metadata
obu:  obumetatester: Helper element to insert a test GstObuMeta to buffers.
</syntaxhighlight>


<noinclude>
{{GstObuMetadata/Foot|Getting Started/Getting the code|User Guide}}
</noinclude>