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:
-* OpenGL. See more about CUDA Toolkit in this link: [https://developer.nvidia.com/cuda-toolkit CUDA Toolkit].
+* GStreamer. Visit [https://gstreamer.freedesktop.org/ GStreamer Project Site] for more information,
-* libspdlog. You can see more about spdlog in this link: [https://github.com/gabime/spdlog spdlog repository].
+* OpenGL. See more about OpenGL in this link: [https://www.opengl.org/ OpenGL]
-* GstCUDA. This is another RidgeRun product. You can see more about it in the following link: [[GstCUDA]]
+* 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 the dependencies mentioned before.
+In the following sections, you can see how to install the dependencies (mentioned before) in Debian-based systems:
+=== OpenGL ===
-=== Core ===
+To install OpenGL, please use:
-Please, install them using (in Debian-based systems):
+<syntaxhighlight lang=bash>
+sudo apt install mesa-utils
+sudo apt-get install freeglut3
+</syntaxhighlight>
+=== GTK+ ===
+To install GTK+,please use:
 <syntaxhighlight lang=bash>
-sudo apt install -y     \
+sudo apt-get install libgtk-3-dev
-    libspdlog-dev       \
-    python3-dev
 </syntaxhighlight>
-=== CUDA L4T pacakge (NPPI library) ===
+=== Webkit2GTK+ ===
+To install Webkit2GTK+, please use:
+<syntaxhighlight lang=bash>
+sudo apt-get install libwebkit2gtk-4.0-dev
+</syntaxhighlight>
-<pre style=background-color:yellow>
+=== GLEW ===
-The Jetpack default installation will flash and install all the necessary CUDA packages, including NPPI library. This section describes how to perform a manual installation, which is typically __NOT__ needed
+To install GLEW, please use:
-</pre>
-Installation guide for CUDA:
+<syntaxhighlight lang=bash>
+sudo apt-get install libglew-dev
+</syntaxhighlight>
-. You will need to know which distribution version you are using:
+=== GLFW ===
+To install GLFW, please use:
 <syntaxhighlight lang=bash>
-lsb_release -a
+sudo apt-get install libglfw3 libglfw3-dev
 </syntaxhighlight>
-. Depending on your platform follow the next instructions:
+=== 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:
-==== Jetson platforms ====
+<syntaxhighlight lang=bash>
-* Depending on what Jetpack release you have installed on your Jetson, you might want to download the corresponding CUDA Toolkit version, including NPPI library. In the following table you can see which one you need. Click on the link and follow the selection menu.
+sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base
+</syntaxhighlight>
-{| class="wikitable"
-|-
-! Jetpack Release !! CUDA Toolkit version
-|-
-| JetPack 4.x || [https://developer.nvidia.com/cuda-10.2-download-archive Get CUDA 10.2 Toolkit]
-|-
-| JetPack 5.x || [https://developer.nvidia.com/cuda-11-4-0-download-archive Get CUDA 11.4 Toolkit]
-|}
-==== x86 platforms ====
-* For x86 platforms, go to this link: [https://developer.nvidia.com/cuda-downloads CUDA Toolkit 12.1 download archive] and follow the selection menu.
-. Select the version depending on the ''lsb_release'' command executed above. We recommend using the '''deb (local)''' option for the installation.
-. Once you have selected your system setup, NVIDIA will show you the installation instructions for those requirements.
-=== GstCUDA ===
-GstCUDA is another RigdeRun product. This product is required for CUDA ISP if you want to use it with GStreamer applications. You can see more about this product in this link: [[GstCUDA|Get GstCUDA]]
-=== Custom v4l2src element ===
-To capture from a camera in raw format with a bits per pixel different from 0, you may require to recompile the GStreamer Plugins Good. Please, follow [[CUDA_ISP_for_NVIDIA_Jetson/Getting_Started/Building_custom_v4l2src_element|these steps]].
 === Documentation (optional) ===
@@ Line 78: / Line 68: @@
 <syntaxhighlight lang=bash>
-sudo apt install -y     \
+sudo apt install doxygen -y
-    doxygen             \
 </syntaxhighlight>
@@ Line 91: / 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 105: / 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 125: / Line 116: @@
 | -Denable-docs=disabled || Skip documentation generation. Enabled by default.
 |-
-| -Denable-gst=disabled || Skip building for GStreamer elements. 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.
@@ Line 133: / Line 130: @@
 | --optimization 3 || Set the optimization level to the maximum
 |}
-<b>Table 1.</b> CUDA ISP configuration options (Meson)</caption>
+<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>