Detailed Description

Defines an API for the GStreamer NvDsPreProcess plugin.

Data Structures
struct	CustomTransformParams
	custom transformation parameter for calling nvbufsurftransform api for scaling and converting the ROIs to the network resolutions to be used by custom lib. More...

struct	NvDsPreProcessTensorParams
	Holds model parameters for tensor preparation. More...

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

struct	CustomSeqProcTensorParams
	Tensor params for Custom sequence processing for 3d conv network. More...

struct	CustomTensorParams
	Tensor params passed to custom library for tensor preparation. More...

struct	CustomInitParams
	Custom Initialization parameter for custom library. More...

struct	NvDsPreProcessCustomBuf
	Custom Buffer passed to the custom lib for preparing tensor. More...

class	NvDsPreProcessAcquirer
	class for acquiring and releasing a buffer from tensor pool by custom lib. More...

struct	NvDsPreProcessUnit
	A preprocess unit for processing which can be Frame/ROI. More...

struct	NvDsPreProcessBatch
	Holds information about the batch of frames to be inferred. More...

struct	NvDsPreProcessTensorMeta
	tensor meta containing prepared tensor and related info inside preprocess user meta which is attached at batch level More...

struct	GstNvDsPreProcessBatchMeta
	preprocess meta as a user meta which is attached at batch level More...

Typedefs
typedef struct CustomCtx	CustomCtx
	Context for custom library. More...

Enumerations
enum	NvDsPreProcessStatus { NVDSPREPROCESS_SUCCESS = 0, NVDSPREPROCESS_CONFIG_FAILED, NVDSPREPROCESS_CUSTOM_LIB_FAILED, NVDSPREPROCESS_CUSTOM_TRANSFORMATION_FAILED, NVDSPREPROCESS_CUSTOM_TENSOR_FAILED, NVDSPREPROCESS_INVALID_PARAMS, NVDSPREPROCESS_OUTPUT_PARSING_FAILED, NVDSPREPROCESS_CUDA_ERROR, NVDSPREPROCESS_TENSORRT_ERROR, NVDSPREPROCESS_RESOURCE_ERROR, NVDSPREPROCESS_TENSOR_NOT_READY }
	Enum for the status codes returned by NvDsPreProcessImpl. More...

enum	NvDsPreProcessNetworkInputOrder { NvDsPreProcessNetworkInputOrder_kNCHW = 0, NvDsPreProcessNetworkInputOrder_kNHWC, NvDsPreProcessNetworkInputOrder_CUSTOM }
	Enum for the network input order according to which network shape will be provided to prepare raw tensor for inferencing. More...

enum	NvDsPreProcessFormat { NvDsPreProcessFormat_RGB, NvDsPreProcessFormat_BGR, NvDsPreProcessFormat_GRAY, NvDsPreProcessFormat_RGBA, NvDsPreProcessFormat_BGRx, NvDsPreProcessFormat_Tensor, NvDsPreProcessFormat_Unknown = 0xFFFFFFFF }
	Defines model color formats. More...

Variables
void *	NvDsPreProcessTensorMeta::raw_tensor_buffer
	raw tensor buffer preprocessed for infer More...

guint64	NvDsPreProcessTensorMeta::buffer_size
	size of raw tensor buffer More...

std::vector< int >	NvDsPreProcessTensorMeta::tensor_shape
	raw tensor buffer shape More...

NvDsDataType	NvDsPreProcessTensorMeta::data_type
	model datatype for which tensor prepared More...

std::string	NvDsPreProcessTensorMeta::tensor_name
	to be same as model input layer name More...

guint	NvDsPreProcessTensorMeta::gpu_id
	gpu-id on which tensor prepared More...

void *	NvDsPreProcessTensorMeta::private_data
	pointer to buffer from tensor pool More...

guint	NvDsPreProcessTensorMeta::meta_id
	meta id for differentiating between multiple tensor meta from same gst buffer,for the case when sum of roi's exceeds the batch size More...

std::vector< guint64 >	GstNvDsPreProcessBatchMeta::target_unique_ids
	target unique ids for which meta is prepared More...

NvDsPreProcessTensorMeta *	GstNvDsPreProcessBatchMeta::tensor_meta
	pointer to tensor meta More...

std::vector< NvDsRoiMeta >	GstNvDsPreProcessBatchMeta::roi_vector
	list of roi vectors per batch More...

void *	GstNvDsPreProcessBatchMeta::private_data
	pointer to buffer from scaling pool More...

Typedef Documentation

◆ CustomCtx

typedef struct CustomCtx CustomCtx

Context for custom library.

Definition at line 54 of file nvdspreprocess_interface.h.

Enumeration Type Documentation

◆ NvDsPreProcessFormat

enum NvDsPreProcessFormat

Defines model color formats.

Enumerator
NvDsPreProcessFormat_RGB	Specifies 24-bit interleaved R-G-B format.
NvDsPreProcessFormat_BGR	Specifies 24-bit interleaved B-G-R format.
NvDsPreProcessFormat_GRAY	Specifies 8-bit Luma format.
NvDsPreProcessFormat_RGBA	Specifies 32-bit interleaved R-G-B-A format.
NvDsPreProcessFormat_BGRx	Specifies 32-bit interleaved B-G-R-x format.
NvDsPreProcessFormat_Tensor	NCHW planar.
NvDsPreProcessFormat_Unknown

Definition at line 104 of file nvdspreprocess_interface.h.

◆ NvDsPreProcessNetworkInputOrder

enum NvDsPreProcessNetworkInputOrder

Enum for the network input order according to which network shape will be provided to prepare raw tensor for inferencing.

Enumerator
NvDsPreProcessNetworkInputOrder_kNCHW	Specifies NCHW network input order.
NvDsPreProcessNetworkInputOrder_kNHWC	Specifies NHWC network input order.
NvDsPreProcessNetworkInputOrder_CUSTOM	Specifies any other custom input order handled by custom lib.

Definition at line 91 of file nvdspreprocess_interface.h.

◆ NvDsPreProcessStatus

enum NvDsPreProcessStatus

Enum for the status codes returned by NvDsPreProcessImpl.

Enumerator
NVDSPREPROCESS_SUCCESS	NvDsPreprocess operation succeeded.
NVDSPREPROCESS_CONFIG_FAILED	Failed to configure the tensor_impl instance possibly due to an erroneous initialization property.
NVDSPREPROCESS_CUSTOM_LIB_FAILED	Custom Library interface implementation failed.
NVDSPREPROCESS_CUSTOM_TRANSFORMATION_FAILED	Custom Group Transformation failed.
NVDSPREPROCESS_CUSTOM_TENSOR_FAILED	Custom Tensor Preparation failed.
NVDSPREPROCESS_INVALID_PARAMS	Invalid parameters were supplied.
NVDSPREPROCESS_OUTPUT_PARSING_FAILED	Output parsing failed.
NVDSPREPROCESS_CUDA_ERROR	CUDA error was encountered.
NVDSPREPROCESS_TENSORRT_ERROR	TensorRT interface failed.
NVDSPREPROCESS_RESOURCE_ERROR	Resource error was encountered.
NVDSPREPROCESS_TENSOR_NOT_READY	Tensor Yet not ready to be attached as meta.

Definition at line 59 of file nvdspreprocess_interface.h.

Variable Documentation

◆ buffer_size

guint64 NvDsPreProcessTensorMeta::buffer_size

size of raw tensor buffer

Definition at line 56 of file nvdspreprocess_meta.h.

◆ data_type

NvDsDataType NvDsPreProcessTensorMeta::data_type

model datatype for which tensor prepared

Definition at line 62 of file nvdspreprocess_meta.h.

◆ gpu_id

guint NvDsPreProcessTensorMeta::gpu_id

gpu-id on which tensor prepared

Definition at line 68 of file nvdspreprocess_meta.h.

◆ meta_id

guint NvDsPreProcessTensorMeta::meta_id

meta id for differentiating between multiple tensor meta from same gst buffer,for the case when sum of roi's exceeds the batch size

Definition at line 74 of file nvdspreprocess_meta.h.

◆ private_data [1/2]

void* NvDsPreProcessTensorMeta::private_data

pointer to buffer from tensor pool

Definition at line 71 of file nvdspreprocess_meta.h.

◆ private_data [2/2]

void* GstNvDsPreProcessBatchMeta::private_data

pointer to buffer from scaling pool

Definition at line 94 of file nvdspreprocess_meta.h.

◆ raw_tensor_buffer

void* NvDsPreProcessTensorMeta::raw_tensor_buffer

raw tensor buffer preprocessed for infer

Definition at line 53 of file nvdspreprocess_meta.h.

◆ roi_vector

std::vector<NvDsRoiMeta> GstNvDsPreProcessBatchMeta::roi_vector

list of roi vectors per batch

Definition at line 91 of file nvdspreprocess_meta.h.

◆ target_unique_ids

std::vector<guint64> GstNvDsPreProcessBatchMeta::target_unique_ids

target unique ids for which meta is prepared

Definition at line 85 of file nvdspreprocess_meta.h.

◆ tensor_meta

NvDsPreProcessTensorMeta* GstNvDsPreProcessBatchMeta::tensor_meta

pointer to tensor meta

Definition at line 88 of file nvdspreprocess_meta.h.

◆ tensor_name

std::string NvDsPreProcessTensorMeta::tensor_name

to be same as model input layer name

Definition at line 65 of file nvdspreprocess_meta.h.

◆ tensor_shape

std::vector<int> NvDsPreProcessTensorMeta::tensor_shape

raw tensor buffer shape

Definition at line 59 of file nvdspreprocess_meta.h.

NVIDIA DeepStream SDK API Reference

6.2 Release