Update to 1.2.2 Release

This release is compatible with DeepStream SDK 8.0
 - Ubuntu 24.04
 - Python 3.12
 - DeepStream SDK 8.0
Attached are the pipwheels for the Python bindings for x86 and Jetson.
Features:
 - Updated build system using PyPA to support pip 24.2+
 - Support and instructions for virtual environment
 - Multiple bug fixes
Notes:
 - deepstream-ssd-parser app has been removed
 - Numpy 2.x is not currently supported

Author: nv-rpaliwal

FAQ.md

@@ -13,6 +13,8 @@
     - [Pipeline unable to perform at real time](#pipeline-unable-to-perform-at-real-time)
     - [Triton container problems with multi-GPU setup](#triton-container-problems-with-multi-gpu-setup)
     - [ModuleNotFoundError: No module named 'pyds'](#modulenotfounderror-no-module-named-pyds)
+    - [error: externally-managed-environment](#error-externally-managed-environment)
+    - [Running deepstream-segmentation app on x86 with mjpeg streams](#running-deepstream-segmentation-app-on-x86-with-mjpeg-streams)
 
 <a name="faq11"></a>
 ### App causes Jetson Orin Nano to freeze and reboot
@@ -166,4 +168,45 @@ The pyds wheel installs the pyds.so library where all the pip packages are store
 Command to install the pyds wheel is:
 ```bash
    $ pip3 install ./pyds-1.2.0*.whl
+```
+
+<a name="faq9"></a>  
+### error: externally-managed-environment
+Python 3.12 requires a virtual environment to install and import pip packages. To create a virtual environment for pyds:
+```
+sudo apt install python3-venv
+
+# Create a venv for pyds
+python3 -m venv pyds
+# Activate the environment
+source ./pyds/bin/activate
+```
+
+<a name="faq12"></a>  
+### Running deepstream-segmentation app on x86 with mjpeg streams
+There is a current limitation in deepstream-segmentation app. When mjpeg streams are used on x86, the app hangs. However, there is a workaround. Please apply below patch to the app and it should work with mjpeg as well as jpeg streams on x86:
+```
+diff --git a/apps/deepstream-segmentation/deepstream_segmentation.py b/apps/deepstream-segmentation/deepstream_segmentation.py
+index ec38b1c..13c28f9 100755
+--- a/apps/deepstream-segmentation/deepstream_segmentation.py
++++ b/apps/deepstream-segmentation/deepstream_segmentation.py
+@@ -168,7 +168,7 @@ def main(args):
+ 
+     # Use nvdec for hardware accelerated decode on GPU
+     print("Creating Decoder \n")
+-    decoder = Gst.ElementFactory.make("nvjpegdec", "nvjpeg-decoder")
++    decoder = Gst.ElementFactory.make("nvv4l2decoder", "nvjpeg-decoder")
+     if not decoder:
+         sys.stderr.write(" Unable to create NvJPEG Decoder \n")
+ 
+@@ -214,6 +214,9 @@ def main(args):
+ 
+     print("Playing file %s " % args[2])
+     source.set_property('location', args[2])
++    if platform_info.is_integrated_gpu() and ("mjpeg" in args[2] or "mjpg" in args[2]):
++        print ("setting decoder mjpeg property")
++        decoder.set_property('mjpeg', 1)
+ 
+     streammux.set_property('width', 1920)
+     streammux.set_property('height', 1080)
 ```

HOWTO.md

@@ -9,16 +9,15 @@ This guide provides resources for DeepStream application development in Python.
 * [Pipeline Construction](#pipeline_construction)
 * [MetaData Access](#metadata_access)
 * [Image Data Access](#imagedata_access)
-* [Custom Inference Output Parsing](apps/deepstream-ssd-parser/custom_parser_guide.md)
 * [FAQ and Troubleshooting](FAQ.md)
 
 <a name="prereqs"></a>
 ## Prerequisites
 
-* Ubuntu 22.04
-* [DeepStream SDK 7.1](https://developer.nvidia.com/deepstream-download) or later
-* Python 3.10
-* [Gst Python](https://gstreamer.freedesktop.org/modules/gst-python.html) v1.20.3
+* Ubuntu 24.04
+* [DeepStream SDK 8.0](https://developer.nvidia.com/deepstream-download) or later
+* Python 3.12
+* [Gst Python](https://gstreamer.freedesktop.org/modules/gst-python.html) v1.24.1
 
 Gst python should be already installed on Jetson.  
 If missing, install with the following steps:

README.md

@@ -2,20 +2,32 @@
 
 This repository contains Python bindings and sample applications for the [DeepStream SDK](https://developer.nvidia.com/deepstream-sdk).  
 
-SDK version supported: 7.1
+SDK version supported: 8.0
 
-<b>This release only supports Ubuntu 22.04 for DeepStreamSDK 7.1 with Python 3.10 and [gst-python](3rdparty/gst-python/) 1.20.3! Ubuntu 20.04 for DeepStreamSDK 6.3 with Python 3.8 support is NOW DEPRECATED</b>
+<b>This release only supports Ubuntu 24.04 for DeepStreamSDK 8.0 with Python 3.12 and [gst-python](3rdparty/gst-python/) 1.24.1!</b>
 
-The bindings sources along with build instructions are available under [bindings](bindings)! PyDS 1.2.0 for DeepStream 7.1 uses an updated build system for PyPA to support pip 24.2, which deprecated setup.py command line. We include one [guide](bindings/BINDINGSGUIDE.md) for contributing to bindings and another [guide](bindings/CUSTOMUSERMETAGUIDE.md) for advanced use-cases such as writing bindings for custom data structures. 
+The bindings sources along with build instructions are available under [bindings](bindings)! PyDS 1.2.0+ for DeepStream 7.1+ uses an updated build system for PyPA to support pip 24.2+, which deprecated setup.py command line. We include one [guide](bindings/BINDINGSGUIDE.md) for contributing to bindings and another [guide](bindings/CUSTOMUSERMETAGUIDE.md) for advanced use-cases such as writing bindings for custom data structures. 
 
 Please report any issues or bugs on the [DeepStream SDK Forums](https://devtalk.nvidia.com/default/board/209). This enables the DeepStream community to find help at a central location.
 
+<b>NOTE:<b> Python 3.12 requires a virtual environment to install and import pip packages:
+```
+sudo apt install python3-venv
+
+# Create a venv for pyds
+python3 -m venv pyds
+# Activate the environment
+source ./pyds/bin/activate
+```
+
 <b>NOTE:<b> numpy 2.x is not supported. If you have numpy 2.x installed, please downgrade by running
 ```
 pip3 install --force-reinstall numpy==1.26.0
 ```
 
-<b>NOTE:<b> deepstream-segmask and deepstream-segmentation applications are not currently supported by DeepStream 7.1, due to removal of segmentation models.
+<b>NOTE:<b> deepstream-segmask and deepstream-segmentation applications are not currently supported by DeepStream 8.0, due to removal of segmentation and ssd models.
+
+<b>NOTE:<b> deepstream-ssd-parser app is not supported since ssd models have been deprecated. The ssd-parser app is removed.
 
 <b>NOTE for DeepStream dockers:<b> If you installed PyDS by running the user_deepstream_python_apps_install.sh script, be sure you also run the <b>user_additional_install.sh script<b>.
 
@@ -64,19 +76,18 @@ We currently provide the following sample applications:
 * [deepstream-test3](apps/deepstream-test3) -- multi-stream pipeline performing 4-class object detection, also supports triton inference server, no-display mode, file-loop and silent mode
 * [deepstream-test4](apps/deepstream-test4) -- msgbroker for sending analytics results to the cloud
 * [deepstream-imagedata-multistream](apps/deepstream-imagedata-multistream) -- multi-stream pipeline with access to image buffers
-* [deepstream-ssd-parser](apps/deepstream-ssd-parser) -- SSD model inference via Triton server with output parsing in Python
 * [deepstream-test1-usbcam](apps/deepstream-test1-usbcam) -- deepstream-test1 pipeline with USB camera input
 * [deepstream-test1-rtsp-out](apps/deepstream-test1-rtsp-out) -- deepstream-test1 pipeline with RTSP output, demonstrates adding software encoder option to support Jetson Orin Nano
 * [deepstream-opticalflow](apps/deepstream-opticalflow) -- optical flow and visualization pipeline with flow vectors returned in NumPy array
-* [deepstream-segmentation](apps/deepstream-segmentation) -- **NOT CURRENTLY SUPPORTED IN DS 7.1** segmentation and visualization pipeline with segmentation mask returned in NumPy array
+* [deepstream-segmentation](apps/deepstream-segmentation) -- segmentation and visualization pipeline with segmentation mask returned in NumPy array
 * [deepstream-nvdsanalytics](apps/deepstream-nvdsanalytics) -- multistream pipeline with analytics plugin
 * [runtime_source_add_delete](apps/runtime_source_add_delete) -- add/delete source streams at runtime
-* [deepstream-imagedata-multistream-redaction](apps/deepstream-imagedata-multistream-redaction) -- multi-stream pipeline with face detection and redaction
+* [deepstream-imagedata-multistream-redaction](apps/deepstream-imagedata-multistream-redaction) -- multi-stream pipeline with face detection and redaction **NOTE** now uses local sink instead of rtsp output
 * [deepstream-rtsp-in-rtsp-out](apps/deepstream-rtsp-in-rtsp-out) -- multi-stream pipeline with RTSP input/output - has command line option "--rtsp-ts" for configuring the RTSP source to attach the timestamp rather than the streammux
 * [deepstream-preprocess-test](apps/deepstream-preprocess-test) -- multi-stream pipeline using nvdspreprocess plugin with custom ROIs
 * [deepstream-demux-multi-in-multi-out](apps/deepstream-demux-multi-in-multi-out) -- multi-stream pipeline using nvstreamdemux plugin to generated separate buffer outputs
 * [deepstream-imagedata-multistream-cupy](apps/deepstream-imagedata-multistream-cupy) -- access imagedata buffer from GPU in a multistream source as CuPy array - x86 only
-* [deepstream-segmask](apps/deepstream-segmask) -- **NOT CURRENTLY SUPPORTED IN DS 7.1** access and interpret segmentation mask information from NvOSD_MaskParams
+* [deepstream-segmask](apps/deepstream-segmask) -- access and interpret segmentation mask information from NvOSD_MaskParams
 * [deepstream-custom-binding-test](apps/deepstream-custom-binding-test) -- demonstrate usage of NvDsUserMeta for attaching custom data structure - see also the [Custom User Meta Guide](bindings/CUSTOMUSERMETAGUIDE.md)
 
 

apps/README

@@ -1,5 +1,5 @@
 ################################################################################
-# SPDX-FileCopyrightText: Copyright (c) 2019-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-FileCopyrightText: Copyright (c) 2019-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,9 +19,9 @@
 DeepStream SDK Python Bindings
 ================================================================================
 Setup pre-requisites:
-- Ubuntu 22.04
-- NVIDIA DeepStream SDK 7.1
-- Python 3.10
+- Ubuntu 24.04
+- NVIDIA DeepStream SDK 8.0
+- Python 3.12
 - Gst-python
 
 --------------------------------------------------------------------------------
@@ -36,29 +36,36 @@ Package Contents
 Installing Pre-requisites:
 --------------------------------------------------------------------------------
 
-DeepStream SDK 7.1
+DeepStream SDK 8.0
 --------------------
 Download and install from https://developer.nvidia.com/deepstream-download
 
-Python 3.10
-----------
-Should be already installed with Ubuntu 22.04
+Python 3.12
+-----------
+Should be already installed with Ubuntu 24.04
 
-Gst-python
+gst-python
 ----------
 Should be already installed on Jetson
 If missing, install with the following steps:
 $ sudo apt update
 $ sudo apt install python3-gi python3-dev python3-gst-1.0 -y
 
-**NEW** cuda-python
+**NEW** If in virtual environment, additionally run:
+$ pip3 install PyGObject
+
+cuda-python
 -----------
+**WARNING** cuda-python 13.0.0 is now installed by default. For x86, cuda-python 12.8.0 must
+be installed to match Cuda version 12.8:
+$ pip3 install cuda-python==12.8.0
+For Jetson, Cuda version is 13.0:
 $ pip3 install cuda-python
 
 --------------------------------------------------------------------------------
 Running the samples
 --------------------------------------------------------------------------------
-The apps are configured to work from inside the DeepStream SDK 7.1 installation.
+The apps are configured to work from inside the DeepStream SDK 8.0 installation.
 
 Clone the deepstream_python_apps repo under <DeepStream ROOT>/sources:
 $ git clone https://github.com/NVIDIA-AI-IOT/deepstream_python_apps
@@ -80,20 +87,23 @@ Running the samples inside DeepStream SDK docker
 The general steps are:
 1. Pull the DeepStream SDK docker of choice following the latest DeepStream
    Release Notes at https://developer.nvidia.com/deepstream-sdk for more info.
-   Note that the deepstream-ssd-parser app requires the Triton docker on x86_64.
 2. Run the docker with Python Bindings mapped using the following option:
    -v <path to this python bindings directory>:/opt/nvidia/deepstream/deepstream/sources/python
 3. Inside the container, install packages required by all samples:
    $ sudo apt update
    $ sudo apt install python3-gi python3-dev python3-gst-1.0 -y
-4. Optionally install additional dependencies required by specific samples.
+4. If running script user_deepstream_python_apps_install.sh available in the triton docker, please note that it
+   will setup a virtual environment for you at <DS_ROOT>/deepstream_python_apps/pyds location.
+   While the script will activate this virtual environment for you, you might have to activate it explicitly before installing
+   PIP packages and running apps.
+5. Optionally install additional dependencies required by specific samples.
    See README in app's directory for such requirements.
-   $ sudo apt install python3-opencv
-   $ sudo apt install python3-numpy
+   $ pip3 install opencv-python
+   $ pip3 install --force-reinstall numpy==1.26.0
    $ sudo apt install libgstrtspserver-1.0-0 gstreamer1.0-rtsp
    $ sudo apt install libgirepository1.0-dev
    $ sudo apt install gobject-introspection gir1.2-gst-rtsp-server-1.0
-5. Run sample apps following directions in each app's README.
+6. Run sample apps following directions in each app's README.
 
 --------------------------------------------------------------------------------
 Notes:

apps/common/platform_info.py

@@ -18,8 +18,8 @@
 import sys
 import platform
 from threading import Lock
-from cuda import cudart
-from cuda import cuda
+from cuda.bindings import runtime
+from cuda.bindings import driver
 
 guard_platform_info = Lock()
 
@@ -58,17 +58,17 @@ def is_integrated_gpu(self):
         with guard_platform_info:
             #Cuda initialize
             if not self.is_integrated_gpu_verified:
-                cuda_init_result, = cuda.cuInit(0)
-                if  cuda_init_result == cuda.CUresult.CUDA_SUCCESS:
+                cuda_init_result, = driver.cuInit(0)
+                if  cuda_init_result == driver.CUresult.CUDA_SUCCESS:
                     #Get cuda devices count
-                    device_count_result, num_devices = cuda.cuDeviceGetCount()
-                    if device_count_result == cuda.CUresult.CUDA_SUCCESS:
+                    device_count_result, num_devices = driver.cuDeviceGetCount()
+                    if device_count_result == driver.CUresult.CUDA_SUCCESS:
                         #If atleast one device is found, we can use the property from
                         #the first device
                         if num_devices >= 1:
                             #Get properties from first device
-                            property_result, properties = cudart.cudaGetDeviceProperties(0)
-                            if property_result == cuda.CUresult.CUDA_SUCCESS:
+                            property_result, properties = runtime.cudaGetDeviceProperties(0)
+                            if property_result == runtime.cudaError_t.cudaSuccess:
                                 print("Is it Integrated GPU? :", properties.integrated)
                                 self.is_integrated_gpu_system = properties.integrated
                                 self.is_integrated_gpu_verified = True

apps/deepstream-custom-binding-test/README

@@ -16,8 +16,8 @@
 ################################################################################
 
 Prequisites:
-- DeepStreamSDK 7.1
-- Python 3.10
+- DeepStreamSDK 8.0
+- Python 3.12
 - Gst-python
 
 To run the test app: