Updates required to build WebRTC Sink GST 1.20

Makefile

@@ -42,9 +42,8 @@ CXX_VERSION:=c++17
 DSL_VERSION:='L"v0.30.alpha.dev"'
 GLIB_VERSION:=2.0
 
-# Update GStreamer sub-version to 20 to enabled the WebRtcSink
 GSTREAMER_VERSION:=1.0
-GSTREAMER_SUB_VERSION:=18
+GSTREAMER_SUB_VERSION:=20
 GSTREAMER_SDP_VERSION:=1.0
 GSTREAMER_WEBRTC_VERSION:=1.0
 LIBSOUP_VERSION:=2.4
@@ -60,7 +59,11 @@ BUILD_WITH_OPENCV:=false
 # - set BUILD_INTER_PIPE:=true
 BUILD_INTER_PIPE:=false
 
-# To enable the LiveKit WebRTC Sink component (requires GSTREAMER_SUB_VERSION > 22)
+# To enable the WebRTC Sink component (requires GStreamer >= 1.20)
+# - set BUILD_WEBRTC:=true
+BUILD_WEBRTC:=false
+
+# To enable the LiveKit WebRTC Sink component (requires GStreamer >= 1.22)
 # - set BUILD_LIVEKIT_WEBRTC:=true
 BUILD_LIVEKIT_WEBRTC:=false
 
@@ -119,7 +122,7 @@ INCS+= $(wildcard ./test/*.hpp)
 TEST_OBJS+= $(wildcard ./test/api/*.o)
 TEST_OBJS+= $(wildcard ./test/unit/*.o)
 
-ifeq ($(shell test $(GSTREAMER_SUB_VERSION) -gt 18; echo $$?),0)
+ifeq ($(BUILD_WEBRTC),true)
 SRCS+= $(wildcard ./src/webrtc/*.cpp)
 SRCS+= $(wildcard ./test/webrtc/*.cpp)
 INCS+= $(wildcard ./src/webrtc/*.h)
@@ -153,8 +156,8 @@ CFLAGS+= -I$(INC_INSTALL_DIR) \
 	-DDSL_LOGGER_IMP='"DslLogGst.h"'\
 	-DBUILD_WITH_FFMPEG=$(BUILD_WITH_FFMPEG) \
 	-DBUILD_WITH_OPENCV=$(BUILD_WITH_OPENCV) \
-	-DGSTREAMER_SUB_VERSION=$(GSTREAMER_SUB_VERSION) \
 	-DBUILD_INTER_PIPE=$(BUILD_INTER_PIPE) \
+	-DBUILD_WEBRTC=$(BUILD_WEBRTC) \
 	-DBUILD_LIVEKIT_WEBRTC=$(BUILD_LIVEKIT_WEBRTC) \
 	-DBUILD_NMP_PPH=$(BUILD_NMP_PPH) \
 	-DBUILD_MESSAGE_SINK=$(BUILD_MESSAGE_SINK) \
@@ -181,7 +184,7 @@ ifeq ($(BUILD_LIVEKIT_WEBRTC),true)
 CFLAGS+= -I./test/livekitwebrtc
 endif	
 
-ifeq ($(shell test $(GSTREAMER_SUB_VERSION) -gt 18; echo $$?),0)
+ifeq ($(BUILD_WEBRTC),true)
 CFLAGS+= -I/usr/include/libsoup-$(LIBSOUP_VERSION) \
 	-I/usr/include/json-glib-$(JSON_GLIB_VERSION) \
 	-I./src/webrtc
@@ -220,7 +223,7 @@ LIBS+= -L$(LIB_INSTALL_DIR) \
 	-L/usr/local/cuda/lib64/ -lcudart \
 	-Wl,-rpath,$(LIB_INSTALL_DIR)
 
-ifeq ($(shell test $(GSTREAMER_SUB_VERSION) -gt 18; echo $$?),0)
+ifeq ($(BUILD_WEBRTC),true)
 LIBS+= -Lgstreamer-sdp-$(GSTREAMER_SDP_VERSION) \
 	-Lgstreamer-webrtc-$(GSTREAMER_WEBRTC_VERSION) \
 	-Llibsoup-$(LIBSOUP_VERSION) \
@@ -242,7 +245,7 @@ PKGS:= gstreamer-$(GSTREAMER_VERSION) \
 	gstreamer-rtsp-server-$(GSTREAMER_VERSION) \
 	x11
 
-ifeq ($(shell test $(GSTREAMER_SUB_VERSION) -gt 18; echo $$?),0)
+ifeq ($(BUILD_WEBRTC),true)
 PKGS+= gstreamer-sdp-$(GSTREAMER_SDP_VERSION) \
 	gstreamer-webrtc-$(GSTREAMER_WEBRTC_VERSION) \
 	libsoup-$(LIBSOUP_VERSION) \

docs/building-dsl.md

@@ -6,9 +6,8 @@ The DSL shared library is built using GCC and GNU Make. The MakeFile is located
 1. Clone this repository to pull down all source
 2. Use the make (all) default to build the `dsl-test-app` executable
 3. Use the `sudo make install` option to build the object files into `libdsl.so` and intall the lib
-4. Generate caffemodel engine files (optional)
+4. Generate trafficcamnet engine files (optional)
 5. Import the shared lib using Python3
-6. Run the `dsl-test-app` to verify DSL changes (optional)
 
 ### Clone the Repository
 Clone the repository to pull all source code required to build the DSL test application - then navigate to the `deepstream-services-library` root folder.
@@ -23,13 +22,8 @@ cd deepstream-services-library
 Invoke the standard make (all) to compile all source code and test scenarios into objects files, and link them into a [Catch2](https://github.com/catchorg/Catch2) test application. On successful build, the `dsl-test-app` will be found under the same root folder.
 
 ```bash
-make -j <num-cores>
+make -j$(nproc)
 ```
-For example:
-```bash
-make -j 4
-```
-to use 4 CPU cores for the parallel.
 
 ### Make and install the shared library and install dsl.py
 Once the dsl-test-app.exe has been created, the source-only objects can be re-linked into the `libdsl.so` with the make install option. Root level privileges are required for the Makefile to copy the lib to `/usr/local/lib` once built. 
@@ -40,23 +34,19 @@ The DSL Python bindings file (dsl.py) is also copied to `.local/lib/python3.6/si
 sudo make install
 ```
 
-### Generate caffemodel engine files (optional)
-Enable DSL logging if you wish to monitor the process (optional).
-```bash
-export GST_DEBUG=1,DSL:4
-```
+### Generate trafficcamnet engine files (optional)
+
 execute the python script in the `deepstream-services-library` root folder.
 ```bash
-sudo python3 make_caffemodel_engine_files.py
+sudo python3 make_trafficcamnet_engine_files.py
 ```
 **Note:** this script can take several minutes to run.
 
-The following files are generated (Jetson Nano versions by default)
+The following files are generated
 ```
-/opt/nvidia/deepstream/deepstream/samples/models/Primary_Detector_Nano/resnet10.caffemodel_b8_gpu0_fp16.engine
-/opt/nvidia/deepstream/deepstream/samples/models/Secondary_CarColor/resnet18.caffemodel_b8_gpu0_fp16.engine
-/opt/nvidia/deepstream/deepstream/samples/models/Secondary_CarMake/resnet18.caffemodel_b8_gpu0_fp16.engine
-/opt/nvidia/deepstream/deepstream/samples/models/Secondary_VehicleTypesresnet18.caffemodel_b8_gpu0_fp16.engine
+/opt/nvidia/deepstream/deepstream/samples/models/Primary_Detector/resnet18_trafficcamnet.etlt_b8_gpu0_int8.engine
+/opt/nvidia/deepstream/deepstream/samples/models/Secondary_VehicleMake/resnet18_vehiclemakenet.etlt_b8_gpu0_int8.engine
+/opt/nvidia/deepstream/deepstream/samples/models/Secondary_VehicleTypes/resnet18_vehicletypenet.etlt_b8_gpu0_int8.engine
 ```
 Update the Primary detector path specification in the script to generate files for other devices.
 

docs/installing-dependencies.md

@@ -1,13 +1,13 @@
 # Installing DSL Dependencies
-The DeepStream Services Library (DSL) is built on the NVIDIA® [DeepStream SDK](https://developer.nvidia.com/deepstream-sdk) and requires all SDK components to be installed and verified.
+The DeepStream Services Library (DSL) is built on the NVIDIA® [DeepStream SDK](https://developer.nvidia.com/deepstream-sdk) and requires all SDK components and prerequisites to be installed and verified.
 
 Please consult the [NVIDIA DeepStream Quick Start Guide](https://docs.nvidia.com/metropolis/deepstream/dev-guide/text/DS_Quickstart.html) for complete Installation Instructions.
 
-> The following instructions are for NVIDIA DeepStream Versions 6.4 and 7.0 on Ubuntu 22.04.
+> The following installation instructions are specific to NVIDIA® DeepStream Versions 6.4 and 7.0 on Ubuntu 22.04.
 
 ## Contents
 * [Base Install - Jetson and dGPU](#base-install---jetson-and-dgpu)
-* [Additional WebRTC Dependencies](#additional-webrtc-dependencies---deepstream-64--gstreamer-120)
+* [Additional WebRTC Sink Dependencies](#additional-webrtc-sink-dependencies)
 * [Enabling Extended Image Services (Optional)](#enabling-extended-image-services-optional)
 * [Enabling Interpipe Services (Optional)](#enabling-interpipe-services-optional)
 * [Documentation and Debug Dependencies (Optional)](#documentation-and-debug-dependencies-optional)
@@ -43,19 +43,43 @@ apt update && apt-get install \
     libcurl4-openssl-dev
 ```    
 
-## Additional WebRTC Dependencies - DeepStream 6.4 / GStreamer 1.20
-Enter the following command to install the additional WebRTC
+## Additional WebRTC Sink Dependencies
+### Native Install
+Enter the following command to install the additional WebRTC Sink dependencies.
 ```bash
 sudo apt-get install \
     libjson-glib-dev \
-    libsoup-gnome2.4-dev  
+    libsoup-gnome2.4-dev \
+    libgstreamer-plugins-bad1.0-dev \
+    libnice-dev \
+    gstreamer1.0-nice
 ```
+### Container Install 
+The same as above, but without using sudo
+```bash
+apt-get install \
+    libjson-glib-dev \
+    libsoup-gnome2.4-dev \
+    libgstreamer-plugins-bad1.0-dev \
+    libnice-dev \
+    gstreamer1.0-nice
+```
+
+### Post Install
 After installation, enter the following command to update the json-glib-1.0 package.
 ```bash
 pkg-config --cflags json-glib-1.0
 ```
+### Updating the Makefile
+To enable the WebRTC Sink Component, search for the following section in the DSL Makefile and set the BUILD flag to true.
+```makefile
+# To enable the WebRTC Sink component (requires GStreamer >= 1.20)
+# - set BUILD_WEBRTC:=true
+BUILD_WEBRTC:=true
+```
 
 ---
+
 ## Enabling Extended Image Services (Optional)
 DSL provides a choice of using [FFmpeg](https://ffmpeg.org/) or [OpenCV](https://opencv.org/) to implement the Extended Images Services, which include:
 * [Streaming Image Source](/docs/api-source.md#dsl_source_image_stream_new)
@@ -93,7 +117,7 @@ There are insufficient dependencies in the Docker container to install and use l
 
 ### Updating the Makefile
 To enable the Extended Image Services, search for the following section in the DSL Makefile and set the appropriate BUILD_WITH flag to true.
-```
+```makefile
 # To enable the extended Image Services, install either the FFmpeg or OpenCV 
 # development libraries (See /docs/installing-dependencies.md), and
 #  - set either BUILD_WITH_FFMPEG or BUILD_WITH_OPENCV:=true (NOT both)
@@ -145,15 +169,16 @@ sudo apt-get install doxygen
 * [On-Screen Display](/docs/api-osd.md)
 * [Demuxer and Splitter Tees](/docs/api-tee)
 * [Sink](/docs/api-sink.md)
+* [Branch](/docs/api-branch.md)
+* [Component](/docs/api-component.md)
+* [Custom Component](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)
 * [ODE Action ](/docs/api-ode-action.md)
 * [ODE Area](/docs/api-ode-area.md)
 * [ODE Heat-Mapper](/docs/api-ode-heat-mapper.md)
 * [Display Type](/docs/api-display-type.md)
-* [Branch](/docs/api-branch.md)
-* [Component](/docs/api-component.md)
 * [Mailer](/docs/api-mailer.md)
 * [WebSocket Server](/docs/api-ws-server.md)
 * [Message Broker](/docs/api-msg-broker.md)