OpenGL Accelerated HTML Overlay/Getting Started/Building HTML Overlay: Difference between revisions

Latest revision as of 20:25, 16 October 2023

Dependencies

HTML Overlay has the following dependencies for building from source:

GStreamer. Visit GStreamer Project Site for more information,
OpenGL. See more about OpenGL in this link: OpenGL
GTK+. You can see more about GTK+ at this link: GTK+.
Webkit2GTK+. You can see more about it in the following link: Webkit2GTK+
GLEW
EGL

In the following sections, you can see how to install the dependencies (mentioned before) in Debian-based systems:

OpenGL

To install OpenGL, please use:

sudo apt install mesa-utils
sudo apt-get install freeglut3

GTK+

To install GTK+,please use:

sudo apt-get install libgtk-3-dev

Webkit2GTK+

To install Webkit2GTK+, please use:

sudo apt-get install libwebkit2gtk-4.0-dev

GLEW

To install GLEW, please use:

sudo apt-get install libglew-dev

GLFW

To install GLFW, please use:

sudo apt-get install libglfw3 libglfw3-dev

GStreamer

In case you don't have GStreamer, please visit GStreamer Project Site to see your platform specific installation guide. If you're in Ubuntu or Debian you can run the following command:

sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base

Documentation (optional)

For the documentation, consider the following dependency:

doxygen

Please, install it using (in Debian-based systems):

sudo apt install doxygen -y

Meson building system

At the building system level:

ninja-build
python3-pip
pkg-config
meson

Please install them using (in Debian-based systems like Ubuntu):

sudo apt install -y \
     build-essential \
     python3        \
     python3-pip    \
     ninja-build    \
     meson          \
     pkg-config

The process should be similar in other systems, not based on Debian.

Building the project

Once the dependencies are installed, you can run a default compilation with:

meson setup build --optimization 3 --prefix /usr -Denable-docs=disabled -Ddeveloper-mode=false
ninja -C build
sudo ninja -C build install

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

`

Configure Option	Description
-Ddeveloper-mode=false	Disable developer mode. Enabled by default.
-Denable-docs=disabled	Skip documentation generation. Enabled by default.
-Denable-docs-only=enabled	Build documentation with Doxygen without compiling. Disabled by default.
-Denable-gst=disabled	Skip building the GStreamer element. Enabled by default.
-Denable-tests=disabled	Skip building tests. Enabled by default.
-Denable-examples=disabled	Build examples. Not supported on i.MX 8
-Dplatform={generic,jetson,vivante}	Select target platform as Jetson for NVIDIA Jetson and Vivante for i.MX8 . x86 by default
--prefix /usr	Set the installation path of the library.
--optimization 3	Set the optimization level to the maximum

Table 1. HTML Overlay configuration options (Meson)

Examples

You can visit GStreamer Usage page of this Guide to check out some application examples.

Previous: Getting_Started/Getting_the_Code

Index

Next: Library_User_Manual

@@ Line 9: / Line 9: @@
 HTML Overlay has the following dependencies for building from source:
+* GStreamer. Visit [https://gstreamer.freedesktop.org/ GStreamer Project Site] for more information,
 * OpenGL. See more about OpenGL in this link: [https://www.opengl.org/ OpenGL]
-* GTK+. You can see more about GTK+ in this link: [https://www.gtk.org/ GTK+].
+* GTK+. You can see more about GTK+ at this link: [https://www.gtk.org/ GTK+].
 * Webkit2GTK+. You can see more about it in the following link: [https://webkitgtk.org/ Webkit2GTK+]
 * GLEW
 * EGL
-In the following sections you can see how to install, in Debian-based systems, the dependencies mentioned before.
+In the following sections, you can see how to install the dependencies (mentioned before) in Debian-based systems:
 === OpenGL ===
@@ Line 49: / Line 51: @@
 <syntaxhighlight lang=bash>
 sudo apt-get install libglfw3 libglfw3-dev
+</syntaxhighlight>
+=== GStreamer ===
+In case you don't have GStreamer, please visit [https://gstreamer.freedesktop.org/ GStreamer Project Site] to see your platform specific installation guide. If you're in Ubuntu or Debian you can run the following command:
+<syntaxhighlight lang=bash>
+sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base
 </syntaxhighlight>
@@ Line 60: / Line 68: @@
 <syntaxhighlight lang=bash>
-sudo apt install -y     \
+sudo apt install doxygen -y
-    doxygen             \
 </syntaxhighlight>
@@ Line 73: / Line 80: @@
 * meson
-Please, install them using (in Debian-based systems):
+Please install them using (in Debian-based systems like Ubuntu):
 <syntaxhighlight lang=bash>
 sudo apt install -y \
+     build-essential \
       python3        \
       python3-pip    \
       ninja-build    \
+     meson          \
       pkg-config
 </syntaxhighlight>
@@ Line 87: / Line 96: @@
 == Building the project ==
-Once fulfilled the dependencies, you can run a default compilation with:
+Once the dependencies are installed, you can run a default compilation with:
 <syntaxhighlight lang=bash>
-meson build --optimization 3 --prefix /usr -Denable-docs=disabled -Ddeveloper-mode=false
+meson setup build --optimization 3 --prefix /usr -Denable-docs=disabled -Ddeveloper-mode=false
 ninja -C build
 sudo ninja -C build install
@@ Line 109: / Line 118: @@
 | -Denable-docs-only=enabled || Build documentation with Doxygen without compiling. Disabled by default.
 |-
-| -Denable-gst=disabled || Skip building for GStreamer elements. Enabled by default.
+| -Denable-gst=disabled || Skip building the GStreamer element. Enabled by default.
 |-
 | -Denable-tests=disabled || Skip building tests. Enabled by default.
 |-
-| -Denable-examples=disabled || Build examples
+| -Denable-examples=disabled || Build examples. Not supported on i.MX 8
 |-
-| -Dplatform=jetson || Select target paltform as Jetson. x86 by default
+| -Dplatform={generic,jetson,vivante} || Select target platform as Jetson for NVIDIA Jetson and Vivante for i.MX8 . x86 by default
 |-
 | --prefix /usr || Set the installation path of the library.
@@ Line 123: / Line 132: @@
 <b>Table 1.</b> HTML Overlay configuration options (Meson)</caption>
 </center>
+== Examples ==
+You can visit [[OpenGL_Accelerated_HTML_Overlay/Examples/GStreamer_Usage | GStreamer Usage]] page of this Guide to check out some application examples.
 <noinclude>
 {{OpenGL Accelerated HTML Overlay/Foot|Getting_Started/Getting_the_Code|Library_User_Manual}}
 </noinclude>