Detailed Description

Defines common elements used in the API exposed by the Gst-inference plugin.

Data Structures
struct	NvDsInferDims
	Holds the dimensions of a layer. More...

struct	NvDsInferDimsCHW
	Holds the dimensions of a three-dimensional layer. More...

struct	NvDsInferLayerInfo
	Holds information about one layer in the model. More...

struct	NvDsInferNetworkInfo
	Holds information about the model network. More...

struct	NvDsInferObjectDetectionInfo
	Holds information about one parsed object from a detector's output. More...

struct	NvDsInferInstanceMaskInfo
	Holds information about one parsed object and instance mask from a detector's output. More...

struct	NvDsInferAttribute
	Holds information about one classified attribute. More...

Macros
#define	NVDSINFER_MAX_DIMS 8

#define	_DS_DEPRECATED_(STR) __attribute__ ((deprecated (STR)))

#define	getDimsCHWFromDims(dimsCHW, dims)
	Sets values on a NvDsInferDimsCHW structure from a NvDsInferDims structure. More...

#define	getDimsHWCFromDims(dimsCHW, dims)

#define	NVDSINFER_MAX_DIMS 8

#define	_DS_DEPRECATED_(STR) __attribute__ ((deprecated (STR)))

#define	getDimsCHWFromDims(dimsCHW, dims)
	Sets values on a NvDsInferDimsCHW structure from a NvDsInferDims structure. More...

#define	getDimsHWCFromDims(dimsCHW, dims)

Typedefs
typedef NvDsInferObjectDetectionInfo	NvDsInferParseObjectInfo
	A typedef defined to maintain backward compatibility. More...

typedef NvDsInferObjectDetectionInfo	NvDsInferParseObjectInfo
	A typedef defined to maintain backward compatibility. More...

Enumerations
enum	NvDsInferDataType { FLOAT = 0, HALF = 1, INT8 = 2, INT32 = 3, INT64 = 4, UINT8 = 5, FLOAT = 0, HALF = 1, INT8 = 2, INT32 = 3, INT64 = 4, UINT8 = 5 }
	Specifies the data type of a layer. More...

enum	NvDsInferStatus { NVDSINFER_SUCCESS = 0, NVDSINFER_CONFIG_FAILED, NVDSINFER_CUSTOM_LIB_FAILED, NVDSINFER_INVALID_PARAMS, NVDSINFER_OUTPUT_PARSING_FAILED, NVDSINFER_CUDA_ERROR, NVDSINFER_TENSORRT_ERROR, NVDSINFER_RESOURCE_ERROR, NVDSINFER_TRITON_ERROR, NVDSINFER_TRTIS_ERROR = NVDSINFER_TRITON_ERROR, NVDSINFER_MEM_ERROR, NVDSINFER_UNKNOWN_ERROR, NVDSINFER_SUCCESS = 0, NVDSINFER_CONFIG_FAILED, NVDSINFER_CUSTOM_LIB_FAILED, NVDSINFER_INVALID_PARAMS, NVDSINFER_OUTPUT_PARSING_FAILED, NVDSINFER_CUDA_ERROR, NVDSINFER_TENSORRT_ERROR, NVDSINFER_RESOURCE_ERROR, NVDSINFER_TRITON_ERROR, NVDSINFER_TRTIS_ERROR = NVDSINFER_TRITON_ERROR, NVDSINFER_MEM_ERROR, NVDSINFER_UNKNOWN_ERROR }
	Enum for the status codes returned by NvDsInferContext. More...

enum	NvDsInferLogLevel { NVDSINFER_LOG_ERROR = 0, NVDSINFER_LOG_WARNING, NVDSINFER_LOG_INFO, NVDSINFER_LOG_DEBUG, NVDSINFER_LOG_ERROR = 0, NVDSINFER_LOG_WARNING, NVDSINFER_LOG_INFO, NVDSINFER_LOG_DEBUG }
	Enum for the log levels of NvDsInferContext. More...

enum	NvDsInferDataType { FLOAT = 0, HALF = 1, INT8 = 2, INT32 = 3, INT64 = 4, UINT8 = 5, FLOAT = 0, HALF = 1, INT8 = 2, INT32 = 3, INT64 = 4, UINT8 = 5 }
	Specifies the data type of a layer. More...

enum	NvDsInferStatus { NVDSINFER_SUCCESS = 0, NVDSINFER_CONFIG_FAILED, NVDSINFER_CUSTOM_LIB_FAILED, NVDSINFER_INVALID_PARAMS, NVDSINFER_OUTPUT_PARSING_FAILED, NVDSINFER_CUDA_ERROR, NVDSINFER_TENSORRT_ERROR, NVDSINFER_RESOURCE_ERROR, NVDSINFER_TRITON_ERROR, NVDSINFER_TRTIS_ERROR = NVDSINFER_TRITON_ERROR, NVDSINFER_MEM_ERROR, NVDSINFER_UNKNOWN_ERROR, NVDSINFER_SUCCESS = 0, NVDSINFER_CONFIG_FAILED, NVDSINFER_CUSTOM_LIB_FAILED, NVDSINFER_INVALID_PARAMS, NVDSINFER_OUTPUT_PARSING_FAILED, NVDSINFER_CUDA_ERROR, NVDSINFER_TENSORRT_ERROR, NVDSINFER_RESOURCE_ERROR, NVDSINFER_TRITON_ERROR, NVDSINFER_TRTIS_ERROR = NVDSINFER_TRITON_ERROR, NVDSINFER_MEM_ERROR, NVDSINFER_UNKNOWN_ERROR }
	Enum for the status codes returned by NvDsInferContext. More...

enum	NvDsInferLogLevel { NVDSINFER_LOG_ERROR = 0, NVDSINFER_LOG_WARNING, NVDSINFER_LOG_INFO, NVDSINFER_LOG_DEBUG, NVDSINFER_LOG_ERROR = 0, NVDSINFER_LOG_WARNING, NVDSINFER_LOG_INFO, NVDSINFER_LOG_DEBUG }
	Enum for the log levels of NvDsInferContext. More...

Functions
const char *	NvDsInferStatus2Str (NvDsInferStatus status)
	Get the string name for the status. More...

Macro Definition Documentation

◆ _DS_DEPRECATED_ [1/2]

#define _DS_DEPRECATED_ ( STR ) __attribute__ ((deprecated (STR)))

Definition at line 41 of file sources/includes/nvdsinfer.h.

◆ _DS_DEPRECATED_ [2/2]

#define _DS_DEPRECATED_ ( STR ) __attribute__ ((deprecated (STR)))

Definition at line 41 of file 9.0/sources/includes/nvdsinfer.h.

◆ getDimsCHWFromDims [1/2]

#define getDimsCHWFromDims	(	dimsCHW,
		dims
	)

Value:

  do { \
    (dimsCHW).c = (dims).d[0]; \
    (dimsCHW).h = (dims).d[1]; \
    (dimsCHW).w = (dims).d[2]; \
  } while (0)

Sets values on a NvDsInferDimsCHW structure from a NvDsInferDims structure.

Definition at line 128 of file 9.0/sources/includes/nvdsinfer.h.

◆ getDimsCHWFromDims [2/2]

#define getDimsCHWFromDims	(	dimsCHW,
		dims
	)

Value:

  do { \
    (dimsCHW).c = (dims).d[0]; \
    (dimsCHW).h = (dims).d[1]; \
    (dimsCHW).w = (dims).d[2]; \
  } while (0)

Sets values on a NvDsInferDimsCHW structure from a NvDsInferDims structure.

Definition at line 128 of file sources/includes/nvdsinfer.h.

◆ getDimsHWCFromDims [1/2]

#define getDimsHWCFromDims	(	dimsCHW,
		dims
	)

Value:

  do { \
    (dimsCHW).h = (dims).d[0]; \
    (dimsCHW).w = (dims).d[1]; \
    (dimsCHW).c = (dims).d[2]; \
  } while (0)

Definition at line 135 of file sources/includes/nvdsinfer.h.

◆ getDimsHWCFromDims [2/2]

#define getDimsHWCFromDims	(	dimsCHW,
		dims
	)

Value:

  do { \
    (dimsCHW).h = (dims).d[0]; \
    (dimsCHW).w = (dims).d[1]; \
    (dimsCHW).c = (dims).d[2]; \
  } while (0)

Definition at line 135 of file 9.0/sources/includes/nvdsinfer.h.

◆ NVDSINFER_MAX_DIMS [1/2]

#define NVDSINFER_MAX_DIMS 8

Definition at line 39 of file sources/includes/nvdsinfer.h.

◆ NVDSINFER_MAX_DIMS [2/2]

#define NVDSINFER_MAX_DIMS 8

Definition at line 39 of file 9.0/sources/includes/nvdsinfer.h.

Typedef Documentation

◆ NvDsInferParseObjectInfo [1/2]

typedef NvDsInferObjectDetectionInfo NvDsInferParseObjectInfo

A typedef defined to maintain backward compatibility.

Definition at line 171 of file sources/includes/nvdsinfer.h.

◆ NvDsInferParseObjectInfo [2/2]

typedef NvDsInferObjectDetectionInfo NvDsInferParseObjectInfo

A typedef defined to maintain backward compatibility.

Definition at line 171 of file 9.0/sources/includes/nvdsinfer.h.

Enumeration Type Documentation

◆ NvDsInferDataType [1/2]

enum NvDsInferDataType

Specifies the data type of a layer.

Enumerator
FLOAT	Specifies FP32 format.
HALF	Specifies FP16 format.
INT8	Specifies INT8 format.
INT32	Specifies INT32 format.
INT64	Specifies INT64 format.
UINT8	Specifies UINT8 format.
FLOAT	Specifies FP32 format.
HALF	Specifies FP16 format.
INT8	Specifies INT8 format.
INT32	Specifies INT32 format.
INT64	Specifies INT64 format.
UINT8	Specifies UINT8 format.

Definition at line 72 of file sources/includes/nvdsinfer.h.

◆ NvDsInferDataType [2/2]

enum NvDsInferDataType

Specifies the data type of a layer.

Enumerator
FLOAT	Specifies FP32 format.
HALF	Specifies FP16 format.
INT8	Specifies INT8 format.
INT32	Specifies INT32 format.
INT64	Specifies INT64 format.
UINT8	Specifies UINT8 format.
FLOAT	Specifies FP32 format.
HALF	Specifies FP16 format.
INT8	Specifies INT8 format.
INT32	Specifies INT32 format.
INT64	Specifies INT64 format.
UINT8	Specifies UINT8 format.

Definition at line 72 of file 9.0/sources/includes/nvdsinfer.h.

◆ NvDsInferLogLevel [1/2]

enum NvDsInferLogLevel

Enum for the log levels of NvDsInferContext.

Enumerator
NVDSINFER_LOG_ERROR
NVDSINFER_LOG_WARNING
NVDSINFER_LOG_INFO
NVDSINFER_LOG_DEBUG
NVDSINFER_LOG_ERROR
NVDSINFER_LOG_WARNING
NVDSINFER_LOG_INFO
NVDSINFER_LOG_DEBUG

Definition at line 257 of file 9.0/sources/includes/nvdsinfer.h.

◆ NvDsInferLogLevel [2/2]

enum NvDsInferLogLevel

Enum for the log levels of NvDsInferContext.

Enumerator
NVDSINFER_LOG_ERROR
NVDSINFER_LOG_WARNING
NVDSINFER_LOG_INFO
NVDSINFER_LOG_DEBUG
NVDSINFER_LOG_ERROR
NVDSINFER_LOG_WARNING
NVDSINFER_LOG_INFO
NVDSINFER_LOG_DEBUG

Definition at line 257 of file sources/includes/nvdsinfer.h.

◆ NvDsInferStatus [1/2]

enum NvDsInferStatus

Enum for the status codes returned by NvDsInferContext.

Enumerator
NVDSINFER_SUCCESS	NvDsInferContext operation succeeded.
NVDSINFER_CONFIG_FAILED	Failed to configure the NvDsInferContext instance possibly due to an erroneous initialization property.
NVDSINFER_CUSTOM_LIB_FAILED	Custom Library interface implementation failed.
NVDSINFER_INVALID_PARAMS	Invalid parameters were supplied.
NVDSINFER_OUTPUT_PARSING_FAILED	Output parsing failed.
NVDSINFER_CUDA_ERROR	CUDA error was encountered.
NVDSINFER_TENSORRT_ERROR	TensorRT interface failed.
NVDSINFER_RESOURCE_ERROR	Resource error was encountered.
NVDSINFER_TRITON_ERROR	Triton error was encountered. Renamed TRT-IS to Triton.
NVDSINFER_TRTIS_ERROR	[deprecated]TRT-IS error was encountered
NVDSINFER_MEM_ERROR	Cuda Memory error was encountered.
NVDSINFER_UNKNOWN_ERROR	Unknown error was encountered.
NVDSINFER_SUCCESS	NvDsInferContext operation succeeded.
NVDSINFER_CONFIG_FAILED	Failed to configure the NvDsInferContext instance possibly due to an erroneous initialization property.
NVDSINFER_CUSTOM_LIB_FAILED	Custom Library interface implementation failed.
NVDSINFER_INVALID_PARAMS	Invalid parameters were supplied.
NVDSINFER_OUTPUT_PARSING_FAILED	Output parsing failed.
NVDSINFER_CUDA_ERROR	CUDA error was encountered.
NVDSINFER_TENSORRT_ERROR	TensorRT interface failed.
NVDSINFER_RESOURCE_ERROR	Resource error was encountered.
NVDSINFER_TRITON_ERROR	Triton error was encountered. Renamed TRT-IS to Triton.
NVDSINFER_TRTIS_ERROR	[deprecated]TRT-IS error was encountered
NVDSINFER_MEM_ERROR	Cuda Memory error was encountered.
NVDSINFER_UNKNOWN_ERROR	Unknown error was encountered.

Definition at line 226 of file sources/includes/nvdsinfer.h.

◆ NvDsInferStatus [2/2]

enum NvDsInferStatus

Enum for the status codes returned by NvDsInferContext.

Enumerator
NVDSINFER_SUCCESS	NvDsInferContext operation succeeded.
NVDSINFER_CONFIG_FAILED	Failed to configure the NvDsInferContext instance possibly due to an erroneous initialization property.
NVDSINFER_CUSTOM_LIB_FAILED	Custom Library interface implementation failed.
NVDSINFER_INVALID_PARAMS	Invalid parameters were supplied.
NVDSINFER_OUTPUT_PARSING_FAILED	Output parsing failed.
NVDSINFER_CUDA_ERROR	CUDA error was encountered.
NVDSINFER_TENSORRT_ERROR	TensorRT interface failed.
NVDSINFER_RESOURCE_ERROR	Resource error was encountered.
NVDSINFER_TRITON_ERROR	Triton error was encountered. Renamed TRT-IS to Triton.
NVDSINFER_TRTIS_ERROR	[deprecated]TRT-IS error was encountered
NVDSINFER_MEM_ERROR	Cuda Memory error was encountered.
NVDSINFER_UNKNOWN_ERROR	Unknown error was encountered.
NVDSINFER_SUCCESS	NvDsInferContext operation succeeded.
NVDSINFER_CONFIG_FAILED	Failed to configure the NvDsInferContext instance possibly due to an erroneous initialization property.
NVDSINFER_CUSTOM_LIB_FAILED	Custom Library interface implementation failed.
NVDSINFER_INVALID_PARAMS	Invalid parameters were supplied.
NVDSINFER_OUTPUT_PARSING_FAILED	Output parsing failed.
NVDSINFER_CUDA_ERROR	CUDA error was encountered.
NVDSINFER_TENSORRT_ERROR	TensorRT interface failed.
NVDSINFER_RESOURCE_ERROR	Resource error was encountered.
NVDSINFER_TRITON_ERROR	Triton error was encountered. Renamed TRT-IS to Triton.
NVDSINFER_TRTIS_ERROR	[deprecated]TRT-IS error was encountered
NVDSINFER_MEM_ERROR	Cuda Memory error was encountered.
NVDSINFER_UNKNOWN_ERROR	Unknown error was encountered.

Definition at line 226 of file 9.0/sources/includes/nvdsinfer.h.

Function Documentation

◆ NvDsInferStatus2Str()

const char * NvDsInferStatus2Str ( NvDsInferStatus status )

Get the string name for the status.

Parameters

[in] status An NvDsInferStatus value.

Returns: String name for the status. Memory is owned by the function. Callers should not free the pointer.

NVIDIA DeepStream SDK API Reference

8.0 Release

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ _DS_DEPRECATED_ [1/2]

◆ _DS_DEPRECATED_ [2/2]

◆ getDimsCHWFromDims [1/2]

◆ getDimsCHWFromDims [2/2]

◆ getDimsHWCFromDims [1/2]

◆ getDimsHWCFromDims [2/2]

◆ NVDSINFER_MAX_DIMS [1/2]

◆ NVDSINFER_MAX_DIMS [2/2]

Typedef Documentation

◆ NvDsInferParseObjectInfo [1/2]

◆ NvDsInferParseObjectInfo [2/2]

Enumeration Type Documentation

◆ NvDsInferDataType [1/2]

◆ NvDsInferDataType [2/2]

◆ NvDsInferLogLevel [1/2]

◆ NvDsInferLogLevel [2/2]

◆ NvDsInferStatus [1/2]

◆ NvDsInferStatus [2/2]

Function Documentation

◆ NvDsInferStatus2Str()