Skip to content

Commit 0c281ed

Browse files
[DOC] Fixing issues in docs for DL Streamer for main (open-edge-platform#987)
1 parent b317c68 commit 0c281ed

File tree

10 files changed

+186
-25
lines changed

10 files changed

+186
-25
lines changed

libraries/dl-streamer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Please refer to [Install Guide](./docs/source/get_started/install/install_guide_
2626
3. [Compile from source code](./docs/source/dev_guide/advanced_install/advanced_install_guide_compilation.md)
2727
4. [Build Docker image from source code](./docs/source/dev_guide/advanced_install/advanced_build_docker_image.md)
2828

29-
To see the full list of installed components check the [dockerfile content for Ubuntu24](https://raw.githubusercontent.com/open-edge-platform/edge-ai-libraries/refs/heads/main/libraries/dl-streamer/docker/dlstreamer_dev_ubuntu24.Dockerfile)
29+
To see the full list of installed components check the [dockerfile content for Ubuntu24](https://github.com/open-edge-platform/edge-ai-libraries/blob/main/libraries/dl-streamer/docker/ubuntu/ubuntu24.Dockerfile)
3030

3131
## Samples
3232
[Samples](https://github.com/open-edge-platform/edge-ai-libraries/tree/main/libraries/dl-streamer/samples) available for C/C++ and Python programming, and as gst-launch command lines and scripts.

libraries/dl-streamer/docs/source/architecture_2.0/architecture_2.0.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ architecture 2.0, aiming for the following goals:
1616
[Source](./api_ref/class_dlstreamer_Source),
1717
[Transform](./api_ref/class_dlstreamer_Transform) and
1818
[Sink](./api_ref/class_dlstreamer_Sink) for C++ elements implemented in next sub-component. See
19-
[Memory Interop and C++ abstract interfaces](./cpp_interfaces) for details.
19+
[Memory Interop and C++ abstract interfaces](./cpp_interfaces.md) for details.
2020
2. **\"non-GStreamer\" backend support via C++/Python programming.**
2121
Expose Deep Learning Streamer functional blocks (elements) as both
2222
GStreamer elements and C++/Python interfaces accessible by any
@@ -27,8 +27,8 @@ architecture 2.0, aiming for the following goals:
2727
use mix of out-of-box elements, custom/additional elements, memory
2828
interop library and pipeline management logic on top to build
2929
complete performance-optimized media analytics pipeline. See
30-
[C++ elements](cpp_elements) and [Elements list](elements_list) and
31-
[Samples 2.0](samples_2.0) for details.
30+
[C++ elements](./cpp_elements.md) and [Elements list](./elements_list.md) and
31+
[Samples 2.0](./samples_2.0.md) for details.
3232
3. **GStreamer bin elements.** Reimplement most gva\* elements as
3333
GStreamer bin elements which internally build sub-pipeline of other
3434
(low-level) GStreamer elements. Most low-level elements are C++
@@ -37,7 +37,7 @@ architecture 2.0, aiming for the following goals:
3737
operation (no multi-stage processing inside element and no
3838
intermediate memory allocation) with all pipelining done on either
3939
bin-elements or application level. See pages
40-
[GStreamer Elements](gstreamer_elements) and [GStreamer Bin Elements](gstreamer_bins) for details.
40+
[GStreamer Elements](./gstreamer_elements.md) and [GStreamer Bin Elements](./gstreamer_bins.md) for details.
4141

4242
The following diagram visualizes Architecture 2.0 sub-components ①, ②
4343
and ③ inside block **Deep Learning Streamer Pipeline Framework**

libraries/dl-streamer/docs/source/dev_guide/advanced_install/advanced_install_guide_compilation.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Follow the instructions in
1919
::::{tab-set}
2020
:::{tab-item} Ubuntu 24
2121
:sync: tab1
22+
2223
```bash
2324
sudo apt-get update && \
2425
sudo apt-get install -y wget vainfo xz-utils python3-pip python3-gi gcc-multilib libglib2.0-dev \
@@ -31,9 +32,11 @@ Follow the instructions in
3132
ffmpeg librdkafka-dev libpaho-mqtt-dev libopencv-dev libpostproc-dev libavfilter-dev libavdevice-dev \
3233
libswscale-dev libswresample-dev libavutil-dev libavformat-dev libavcodec-dev libtbb12 libxml2-dev libopencv-dev
3334
```
35+
3436
:::
3537
:::{tab-item} Ubuntu 22
3638
:sync: tab2
39+
3740
```bash
3841
sudo apt-get update && \
3942
sudo apt-get install -y wget vainfo xz-utils python3-pip python3-gi gcc-multilib libglib2.0-dev \
@@ -46,9 +49,11 @@ Follow the instructions in
4649
ffmpeg libpaho-mqtt-dev libpostproc-dev libavfilter-dev libavdevice-dev \
4750
libswscale-dev libswresample-dev libavutil-dev libavformat-dev libavcodec-dev libxml2-dev
4851
```
52+
4953
:::
5054
:::{tab-item} Fedora 41
5155
:sync: tab3
56+
5257
```bash
5358
sudo dnf install -y \
5459
https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \
@@ -61,21 +66,18 @@ Follow the instructions in
6166
libssh2-devel cmake git valgrind numactl libvpx-devel opus-devel libsrtp-devel libXv-devel paho-c-devel \
6267
kernel-headers pmix pmix-devel hwloc hwloc-libs hwloc-devel libxcb-devel libX11-devel libatomic intel-media-driver
6368
```
69+
6470
:::
6571
:::{tab-item} EMT 3.x
6672
:sync: tab3
73+
6774
```bash
6875
sudo dnf install -y uuid libuuid-devel openssl-devel gcc gcc-c++ make curl ca-certificates librdkafka-devel libva-devel alsa-lib-devel unzip glibc libstdc++ libgcc cmake sudo pkgconf pkgconf-pkg-config ocl-icd-devel libva-intel-media-driver python3-devel libXaw-devel ncurses-devel libva2 intel-compute-runtime intel-opencl intel-level-zero-gpu intel-ocloc-devel nasm
6976
```
77+
7078
:::
7179
::::
7280

73-
### EMT 3.x
74-
75-
```bash
76-
sudo dnf install -y uuid libuuid-devel openssl-devel gcc gcc-c++ make curl ca-certificates librdkafka-devel libva-devel alsa-lib-devel unzip glibc libstdc++ libgcc cmake sudo pkgconf pkgconf-pkg-config ocl-icd-devel libva-intel-media-driver python3-devel libXaw-devel ncurses-devel libva2 intel-compute-runtime intel-opencl intel-level-zero-gpu intel-ocloc-devel nasm
77-
```
78-
7981
## Step 3: Set up a Python environment
8082

8183
Create a Python virtual environment and install required Python
@@ -103,6 +105,7 @@ git submodule update --init libraries/dl-streamer/thirdparty/spdlog
103105
::::{tab-set}
104106
:::{tab-item} Ubuntu/Fedora
105107
:sync: tab1
108+
106109
```bash
107110
cd ~/edge-ai-libraries/libraries/dl-streamer
108111
sudo ./scripts/install_dependencies/install_openvino.sh
@@ -126,9 +129,11 @@ git submodule update --init libraries/dl-streamer/thirdparty/spdlog
126129
sudo -E /opt/intel/openvino_2025/install_dependencies/install_openvino_dependencies.sh
127130
source /opt/intel/openvino_2025/setupvars.sh
128131
```
132+
129133
:::
130134
:::{tab-item} EMT
131135
:sync: tab2
136+
132137
```bash
133138
wget https://storage.openvinotoolkit.org/repositories/openvino/packages/2025.3/linux/openvino_toolkit_ubuntu24_2025.3.0.19807.44526285f24_x86_64.tgz
134139
tar -xvzf openvino_toolkit_ubuntu24_2025.3.0.19807.44526285f24_x86_64.tgz
@@ -139,39 +144,51 @@ git submodule update --init libraries/dl-streamer/thirdparty/spdlog
139144
sudo ln -s openvino_2025.3.0 openvino_2025
140145
```
141146

147+
:::
148+
::::
149+
142150
### [Optional] Step 6: Install OpenVINO™ GenAI (only for Ubuntu)
143151

144-
To use [gvagenai element](https://docs.openedgeplatform.intel.com/oep/edge-ai-libraries/dl-streamer/elements/gvagenai.html)
152+
To use [gvagenai element](https://docs.openedgeplatform.intel.com/oep/edge-ai-libraries/dl-streamer/elements/gvagenai.html)
145153
there is need to install [OpenVINO GenAI archive](https://docs.openvino.ai/2025/get-started/install-openvino/install-openvino-genai.html) package.
146154

155+
::::{tab-set}
156+
:::{tab-item} Ubuntu 24
157+
:sync: tab1
158+
159+
```bash
160+
curl -L https://storage.openvinotoolkit.org/repositories/openvino_genai/packages/2025.3/linux/openvino_genai_ubuntu24_2025.3.0.0_x86_64.tar.gz | tar -xz &&
161+
mv openvino_genai_ubuntu24_2025.3.0.0_x86_64 /opt/intel/openvino_genai
162+
source /opt/intel/openvino_genai/setupvars.sh
163+
```
147164

148-
- **Ubuntu 22**
165+
:::
166+
:::{tab-item} Ubuntu 22
167+
:sync: tab2
149168

150169
```bash
151170
curl -L https://storage.openvinotoolkit.org/repositories/openvino_genai/packages/2025.3/linux/openvino_genai_ubuntu22_2025.3.0.0_x86_64.tar.gz | tar -xz &&
152171
mv openvino_genai_ubuntu22_2025.3.0.0_x86_64 /opt/intel/openvino_genai
153172
source /opt/intel/openvino_genai/setupvars.sh
154173
```
155174

156-
- **Ubuntu 24**
157-
158-
```bash
159-
curl -L https://storage.openvinotoolkit.org/repositories/openvino_genai/packages/2025.3/linux/openvino_genai_ubuntu24_2025.3.0.0_x86_64.tar.gz | tar -xz &&
160-
mv openvino_genai_ubuntu24_2025.3.0.0_x86_64 /opt/intel/openvino_genai
161-
source /opt/intel/openvino_genai/setupvars.sh
162-
```
175+
:::
176+
::::
163177

164178
## Step 7: Build Deep Learning Streamer
165179

166180
To build DL Streamer is it recommended to use the provided makefile for ease of use:
181+
167182
```bash
168183
make build
169184
```
185+
170186
Running this command will build any major missing dependencies and then compile DL Streamer itself.
171187

172188
## Step 8: Install Deep Learning Streamer (optional)
173189

174190
After building DL Streamer you can install it on your local system by running:
191+
175192
```bash
176193
sudo -E make install
177194
```
@@ -183,6 +200,7 @@ Set up the required environment variables:
183200
::::{tab-set}
184201
:::{tab-item} Ubuntu
185202
:sync: tab1
203+
186204
```bash
187205
export LIBVA_DRIVER_NAME=iHD
188206
export GST_PLUGIN_PATH="/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:$HOME/edge-ai-libraries/libraries/dl-streamer/build/intel64/Release/lib:$HOME/edge-ai-libraries/libraries/dl-streamer/build/deps/gstreamer-bin/lib/gstreamer-1.0:$GST_PLUGIN_PATH"
@@ -194,9 +212,11 @@ Set up the required environment variables:
194212
export GST_PLUGIN_FEATURE_RANK=${GST_PLUGIN_FEATURE_RANK},ximagesink:MAX
195213
export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.0gi
196214
```
215+
197216
:::
198217
:::{tab-item} Fedora
199218
:sync: tab2
219+
200220
```bash
201221
export LIBVA_DRIVER_NAME=iHD
202222
export GST_PLUGIN_PATH="/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:$HOME/edge-ai-libraries/libraries/dl-streamer/build/intel64/Release/lib:$HOME/edge-ai-libraries/libraries/dl-streamer/build/deps/gstreamer-bin/lib/gstreamer-1.0:$GST_PLUGIN_PATH"
@@ -207,9 +227,11 @@ Set up the required environment variables:
207227
export PKG_CONFIG_PATH="/opt/intel/dlstreamer/lib/pkgconfig:/opt/intel/dlstreamer/gstreamer/lib/pkgconfig::$HOME/edge-ai-libraries/libraries/dl-streamer/build/intel64/Release/lib/pkgconfig:$HOME/edge-ai-libraries/libraries/dl-streamer/build/deps/gstreamer-bin/lib/pkgconfig:$PKG_CONFIG_PATH"
208228
export GST_PLUGIN_FEATURE_RANK=${GST_PLUGIN_FEATURE_RANK},ximagesink:MAX
209229
```
230+
210231
:::
211232
:::{tab-item} EMT
212-
:sync: tab2
233+
:sync: tab3
234+
213235
Enable `i915` graphics driver in the system:
214236

215237
```bash
@@ -232,6 +254,7 @@ Set up the required environment variables:
232254
export PKG_CONFIG_PATH="/opt/intel/dlstreamer/lib/pkgconfig:/opt/intel/dlstreamer/gstreamer/lib/pkgconfig::$HOME/edge-ai-libraries/libraries/dl-streamer/build/intel64/Release/lib/pkgconfig:$HOME/edge-ai-libraries/libraries/dl-streamer/build/deps/gstreamer-bin/lib/pkgconfig:$PKG_CONFIG_PATH"
233255
export GST_PLUGIN_FEATURE_RANK=${GST_PLUGIN_FEATURE_RANK},ximagesink:MAX
234256
```
257+
235258
:::
236259
::::
237260

libraries/dl-streamer/docs/source/dev_guide/advanced_install/advanced_install_guide_index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,41 @@
11
# Advanced Installation Guide
22

3+
- [Ubuntu advanced installation - prerequisites](./advanced_install_guide_prerequisites.md)
4+
- [Prerequisite 1 - Intel® GPU drivers for computing and media runtimes](./advanced_install_guide_prerequisites.md#prerequisite-1---intel-gpu-drivers-for-computing-and-media-runtimes)
5+
- [Prerequisite 2 - Install Intel® NPU drivers](./advanced_install_guide_prerequisites.md#optional-prerequisite-2---install-intel-npu-drivers)
6+
- [Ubuntu advanced installation - pre-built packages](./advanced_install_guide_prebuilt.md)
7+
- [Step 1: Install prerequisites](./advanced_install_guide_prebuilt.md#step-1-setup-prerequisites)
8+
- [Step 2: Prepare the installation environment](./advanced_install_guide_prebuilt.md#step-2-prepare-the-installation-environment)
9+
- [Step 3: Install Intel® DL Streamer](./advanced_install_guide_prebuilt.md#step-3-install-deep-learning-streamer)
10+
- [Step 4: Install OpenVINO™ toolkit](./advanced_install_guide_prebuilt.md#step-4-install-openvino-toolkit)
11+
- [Step 5: Install MQTT and Kafka clients for element gvametapublish](./advanced_install_guide_prebuilt.md#step-5-optional-install-mqtt-and-kafka-clients-for-element-gvametapublish)
12+
- [Step 6: Add user to groups](./advanced_install_guide_prebuilt.md#step-6-add-user-to-groups)
13+
- [Step 7: Set up the environment for Intel® DL Streamer](./advanced_install_guide_prebuilt.md#step-7-set-up-the-environment-for-deep-learning-streamer)
14+
- [Step 8: Verify Intel® DL Streamer installation](./advanced_install_guide_prebuilt.md#step-8-verify-deep-learning-streamer-installation)
15+
- [Step 9: Next steps - running sample Intel® DL Streamer pipelines](./advanced_install_guide_prebuilt.md#step-9-next-steps---running-sample-deep-learning-streamer-pipelines)
16+
- [Advanced installation - compilation from source files](./advanced_install_guide_compilation.md)
17+
- [Step 1: Install prerequisites (only for Ubuntu)](./advanced_install_guide_compilation.md#step-1-install-prerequisites-only-for-ubuntu)
18+
- [Step 2: Install build dependencies](./advanced_install_guide_compilation.md#step-2-install-build-dependencies)
19+
- [Step 3: Set up a Python environment](./advanced_install_guide_compilation.md#step-3-set-up-a-python-environment)
20+
- [Step 4: Build/Install FFmpeg](./advanced_install_guide_compilation.md#step-4-clone-deep-learning-streamer-repository)
21+
- [Step 5: Build GStreamer](./advanced_install_guide_compilation.md#step-5-install-openvino-toolkit)
22+
- [Step 6: Build OpenCV](./advanced_install_guide_compilation.md#optional-step-6-install-openvino-genai-only-for-ubuntu)
23+
- [Step 7: Clone Intel® DL Streamer repository](./advanced_install_guide_compilation.md#step-7-build-deep-learning-streamer)
24+
- [Step 8: Install OpenVINO™ Toolkit](./advanced_install_guide_compilation.md#step-8-install-deep-learning-streamer-optional)
25+
- [Step 9: Build Intel DLStreamer](./advanced_install_guide_compilation.md#step-9-set-up-environment)
26+
- [Step 10: Set up environment](./advanced_install_guide_compilation.md#step-10-install-python-dependencies-optional)
27+
- [Ubuntu advanced installation - build Docker image](./advanced_build_docker_image.md)
28+
- [Step 1: Install prerequisites](./advanced_build_docker_image.md#step-1-install-prerequisites)
29+
- [Step 2: Download Dockerfiles](./advanced_build_docker_image.md#step-2-download-dockerfiles)
30+
- [Step 3: Build Docker image](./advanced_build_docker_image.md#step-3-build-docker-image)
31+
- [Ubuntu advanced uninstall guide](./advanced_uninstall_guide.md)
32+
- [Option #1: Uninstall Intel® Deep Learning Streamer (Intel® DL Streamer) Pipeline Framework from APT repository](./advanced_uninstall_guide.md#option-1-apt-repository)
33+
- [Option #2: Intel® DL Streamer Pipeline Framework Docker image](./advanced_uninstall_guide.md#option-2-docker)
34+
- [Option #3: Compiled version](./advanced_uninstall_guide.md#option-3-compiled-version)
35+
336
:::{toctree}
437
:maxdepth: 2
38+
:hidden:
539

640
advanced_install_guide_prerequisites
741
advanced_install_guide_prebuilt

0 commit comments

Comments
 (0)