Detailed Description

Define structures that hold metadata.

Data Structures
struct	_NvDsMetaPool
	Holds information about a given metadata pool. More...

struct	_NvDsBaseMeta
	Holds information about base metadata of a given metadata type. More...

struct	_NvDsBatchMeta
	Holds information about a formed batch containing frames from different sources. More...

struct	_NvDsFrameMeta
	Holds metadata for a frame in a batch. More...

struct	_NvDsObjectMeta
	Holds metadata for an object in the frame. More...

struct	_NvDsClassifierMeta
	Holds classifier metadata for an object. More...

struct	_NvDsLabelInfo
	Holds label metadata for the classifier. More...

struct	NvDsDisplayMeta
	Holds display metadata that the user can specify in the frame. More...

struct	_NvDsUserMeta
	Holds user metadata. More...

Macros
#define	MAX_USER_FIELDS 4
	Defines the number of additional fields available to the user in the metadata structure. More...

#define	MAX_RESERVED_FIELDS 4

#define	MAX_LABEL_SIZE 128
	Defines the maximum size of an array for storing a text result. More...

#define	MAX_ELEMENTS_IN_DISPLAY_META 16
	Defines the maximum number of elements that a given display meta can hold. More...

#define	UNTRACKED_OBJECT_ID 0xFFFFFFFFFFFFFFFF
	Defines an untracked object ID. More...

Typedefs
typedef GList	NvDsFrameMetaList

typedef GList	NvDsUserMetaList

typedef GList	NvDsObjectMetaList

typedef GList	NvDisplayMetaList

typedef GList	NvDsClassifierMetaList

typedef GList	NvDsLabelInfoList

typedef GList	NvDsMetaList

typedef void	NvDsElementMeta

typedef gpointer(*	NvDsMetaCopyFunc )(gpointer data, gpointer user_data)
	Defines the type of a callback to copy metadata. More...

typedef void(*	NvDsMetaReleaseFunc )(gpointer data, gpointer user_data)
	Defines the type of a callback to free metadata. More...

typedef struct _NvDsMetaPool	NvDsMetaPool
	Holds information about a given metadata pool. More...

typedef struct _NvDsBaseMeta	NvDsBaseMeta
	Holds information about base metadata of a given metadata type. More...

typedef struct _NvDsBatchMeta	NvDsBatchMeta
	Holds information about a formed batch containing frames from different sources. More...

typedef struct _NvDsFrameMeta	NvDsFrameMeta
	Holds metadata for a frame in a batch. More...

typedef struct _NvDsObjectMeta	NvDsObjectMeta
	Holds metadata for an object in the frame. More...

typedef struct _NvDsClassifierMeta	NvDsClassifierMeta
	Holds classifier metadata for an object. More...

typedef struct _NvDsLabelInfo	NvDsLabelInfo
	Holds label metadata for the classifier. More...

typedef struct NvDsDisplayMeta	NvDsDisplayMeta
	Holds display metadata that the user can specify in the frame. More...

typedef struct _NvDsUserMeta	NvDsUserMeta
	Holds user metadata. More...

Enumerations
enum	NvDsMetaType { NVDS_INVALID_META =-1, NVDS_BATCH_META = 1, NVDS_FRAME_META, NVDS_OBJ_META, NVDS_DISPLAY_META, NVDS_CLASSIFIER_META, NVDS_LABEL_INFO_META, NVDS_USER_META, NVDS_PAYLOAD_META, NVDS_EVENT_MSG_META, NVDS_OPTICAL_FLOW_META, NVDS_LATENCY_MEASUREMENT_META, NVDSINFER_TENSOR_OUTPUT_META, NVDSINFER_SEGMENTATION_META, NVDS_CROP_IMAGE_META, NVDS_TRACKER_PAST_FRAME_META, NVDS_RESERVED_META = 4095, NVDS_GST_CUSTOM_META = 4096, NVDS_START_USER_META = NVDS_GST_CUSTOM_META + 4096 + 1, NVDS_FORCE32_META = 0x7FFFFFFF }
	Specifies the type of metadata. More...

Functions
void	nvds_acquire_meta_lock (NvDsBatchMeta *batch_meta)
	Acquires a lock before updating metadata. More...

void	nvds_release_meta_lock (NvDsBatchMeta *batch_meta)
	Releases the lock after updating metadata. More...

NvDsBatchMeta *	nvds_create_batch_meta (guint max_batch_size)
	Creates a batch metadata structure for a batch of specified size. More...

gboolean	nvds_destroy_batch_meta (NvDsBatchMeta *batch_meta)
	Destroys a batch metadata structure. More...

NvDsFrameMeta *	nvds_acquire_frame_meta_from_pool (NvDsBatchMeta *batch_meta)
	Acquires a frame meta from a batch's frame meta pool. More...

void	nvds_add_frame_meta_to_batch (NvDsBatchMeta batch_meta, NvDsFrameMeta frame_meta)
	Adds a frame meta to a batch meta. More...

void	nvds_remove_frame_meta_from_batch (NvDsBatchMeta batch_meta, NvDsFrameMeta frame_meta)
	Removes a frame meta from a batch meta. More...

NvDsObjectMeta *	nvds_acquire_obj_meta_from_pool (NvDsBatchMeta *batch_meta)
	Acquires an object meta from a batch meta's object meta pool. More...

void	nvds_add_obj_meta_to_frame (NvDsFrameMeta frame_meta, NvDsObjectMeta obj_meta, NvDsObjectMeta *obj_parent)
	Adds an object meta to a frame meta. More...

void	nvds_remove_obj_meta_from_frame (NvDsFrameMeta frame_meta, NvDsObjectMeta obj_meta)
	Removes an object meta from the frame meta to which it is attached. More...

NvDsClassifierMeta *	nvds_acquire_classifier_meta_from_pool (NvDsBatchMeta *batch_meta)
	Acquires a classifier meta from a batch meta's classifier meta pool. More...

void	nvds_add_classifier_meta_to_object (NvDsObjectMeta obj_meta, NvDsClassifierMeta classifier_meta)
	Adds a classifier meta the appropriate object meta. More...

void	nvds_remove_classifier_meta_from_obj (NvDsObjectMeta obj_meta, NvDsClassifierMeta classifier_meta)
	Removes a classifier meta from the object meta to which it is attached. More...

NvDsDisplayMeta *	nvds_acquire_display_meta_from_pool (NvDsBatchMeta *batch_meta)
	Acquires a display meta from a batch meta's display meta pool. More...

void	nvds_add_display_meta_to_frame (NvDsFrameMeta frame_meta, NvDsDisplayMeta display_meta)
	Adds a display meta to the appropriate frame meta. More...

void	nvds_remove_display_meta_from_frame (NvDsFrameMeta frame_meta, NvDsDisplayMeta display_meta)
	Removes a display meta from the frame meta to which it is attached. More...

NvDsLabelInfo *	nvds_acquire_label_info_meta_from_pool (NvDsBatchMeta *batch_meta)
	Acquires a label info meta from a batch meta's label info meta pool. More...

void	nvds_add_label_info_meta_to_classifier (NvDsClassifierMeta classifier_meta, NvDsLabelInfo label_info_meta)
	Adds a label info meta to a classifier meta. More...

void	nvds_remove_label_info_meta_from_classifier (NvDsClassifierMeta classifier_meta, NvDsLabelInfo label_info_meta)
	Removes a label info meta from the classifier meta to which it is attached. More...

void	nvds_add_user_meta_to_batch (NvDsBatchMeta batch_meta, NvDsUserMeta user_meta)
	Add a user meta to a batch meta. More...

void	nvds_add_user_meta_to_frame (NvDsFrameMeta frame_meta, NvDsUserMeta user_meta)
	Add a user meta to a frame meta. More...

void	nvds_add_user_meta_to_obj (NvDsObjectMeta obj_meta, NvDsUserMeta user_meta)
	Add a user meta user to an object meta. More...

NvDsUserMeta *	nvds_acquire_user_meta_from_pool (NvDsBatchMeta *batch_meta)
	Acquires a user meta from a batch meta's user meta pool. More...

void	nvds_remove_user_meta_from_batch (NvDsBatchMeta batch_meta, NvDsUserMeta user_meta)
	Removes a user meta from a batch meta to which it is attached. More...

void	nvds_remove_user_meta_from_frame (NvDsFrameMeta frame_meta, NvDsUserMeta user_meta)
	Removes a user meta from a frame meta to which it is attached. More...

void	nvds_remove_user_meta_from_object (NvDsObjectMeta obj_meta, NvDsUserMeta user_meta)
	Removes a user meta from an object meta to which it is attached. More...

gboolean	nvds_get_current_metadata_info (NvDsBatchMeta *batch_meta)
	A debugging function; prints current metadata information available after inference. More...

gpointer	nvds_batch_meta_copy_func (gpointer data, gpointer user_data)
	Copies or transforms meta data from one buffer to another. More...

void	nvds_batch_meta_release_func (gpointer data, gpointer user_data)
	Releases metadata from a batch meta. More...

NvDsFrameMeta *	nvds_get_nth_frame_meta (NvDsFrameMetaList *frame_meta_list, guint index)
	Returns a pointer to a specified frame meta in the frame meta list. More...

void	nvds_clear_frame_meta_list (NvDsBatchMeta batch_meta, NvDsFrameMetaList meta_list)
	Removes all of the frame metadata attached to a batch meta. More...

void	nvds_clear_obj_meta_list (NvDsFrameMeta frame_meta, NvDsObjectMetaList meta_list)
	Removes all the object metadata attached to a frame meta. More...

void	nvds_clear_classifier_meta_list (NvDsObjectMeta obj_meta, NvDsClassifierMetaList meta_list)
	Removes all of the classifier metadata attached to an object meta. More...

void	nvds_clear_label_info_meta_list (NvDsClassifierMeta classifier_meta, NvDsLabelInfoList meta_list)
	Removes all of the label info metadata attached to a classifier meta. More...

void	nvds_clear_display_meta_list (NvDsFrameMeta frame_meta, NvDisplayMetaList meta_list)
	Removes all of the display metadata attached to a frame meta. More...

void	nvds_clear_batch_user_meta_list (NvDsBatchMeta batch_meta, NvDsUserMetaList meta_list)
	Removes all of the user metadata attached to the batch meta. More...

void	nvds_clear_frame_user_meta_list (NvDsFrameMeta frame_meta, NvDsUserMetaList meta_list)
	Removes all of the user metadata attached to the frame meta. More...

void	nvds_clear_obj_user_meta_list (NvDsObjectMeta object_meta, NvDsUserMetaList meta_list)
	Removes all of the user metadata attached to an object meta. More...

NvDsMetaList *	nvds_clear_meta_list (NvDsBatchMeta batch_meta, NvDsMetaList meta_list, NvDsMetaPool *meta_pool)
	Removes all of the metadata elements attached to a metadata list. More...

void	nvds_copy_frame_meta (NvDsFrameMeta src_frame_meta, NvDsFrameMeta dst_frame_meta)
	Makes a deep copy of a frame meta to another frame meta. More...

void	nvds_copy_obj_meta (NvDsObjectMeta src_object_meta, NvDsObjectMeta dst_object_meta)
	Makes a deep copy of an object meta to another object meta. More...

void	nvds_copy_classifier_meta (NvDsClassifierMeta src_classifier_meta, NvDsClassifierMeta dst_classifier_meta)
	Makes a deep copy of a classifier meta to another classifier meta. More...

void	nvds_copy_label_info_meta (NvDsLabelInfo src_label_info, NvDsLabelInfo dst_label_info)
	Makes a deep copy of a label info meta to another label info meta. More...

void	nvds_copy_display_meta (NvDsDisplayMeta src_display_meta, NvDsDisplayMeta dst_display_meta)
	Makes a deep copy of a display meta to another display meta. More...

void	nvds_copy_batch_user_meta_list (NvDsUserMetaList src_user_meta_list, NvDsBatchMeta dst_batch_meta)
	Makes a deep copy of a user meta list to the user meta list in a specified batch meta. More...

void	nvds_copy_frame_user_meta_list (NvDsUserMetaList src_user_meta_list, NvDsFrameMeta dst_frame_meta)
	Makes a deep copy of a source user meta list to the user meta list in a specified frame meta. More...

void	nvds_copy_obj_user_meta_list (NvDsUserMetaList src_user_meta_list, NvDsObjectMeta dst_object_meta)
	Makes a deep copy of a source user meta list to the user meta list in a specified object meta. More...

void	nvds_copy_display_meta_list (NvDisplayMetaList src_display_meta_list, NvDsFrameMeta dst_frame_meta)
	Makes a deep copy of a source display meta list to the display meta list in a specified frame meta. More...

void	nvds_copy_frame_meta_list (NvDsFrameMetaList src_frame_meta_list, NvDsBatchMeta dst_batch_meta)
	Makes a deep copy of a source frame meta list to the frame meta list in a specified batch meta. More...

void	nvds_copy_obj_meta_list (NvDsObjectMetaList src_obj_meta_list, NvDsFrameMeta dst_frame_meta)
	Makes a deep copy of a source object meta list to the object meta list in a specified frame meta. More...

void	nvds_copy_classification_list (NvDsClassifierMetaList src_classifier_meta_list, NvDsObjectMeta dst_object_meta)
	Makes a deep copy of a source classifier meta list to the classifier meta list in a specified object meta. More...

void	nvds_copy_label_info_list (NvDsLabelInfoList src_label_info_list, NvDsClassifierMeta dst_classifier_meta)
	Makes a deep copy of a source label info meta list to the label info meta list in a specified classifier meta. More...

NvDsMetaType	nvds_get_user_meta_type (gchar *meta_descriptor)
	Generates a unique user metadata type from a specified string describing user-specific metadata. More...

Macro Definition Documentation

#define MAX_ELEMENTS_IN_DISPLAY_META 16

Defines the maximum number of elements that a given display meta can hold.

Definition at line 48 of file nvdsmeta.h.

#define MAX_LABEL_SIZE 128

Defines the maximum size of an array for storing a text result.

Definition at line 45 of file nvdsmeta.h.

#define MAX_RESERVED_FIELDS 4

Definition at line 43 of file nvdsmeta.h.

#define MAX_USER_FIELDS 4

Defines the number of additional fields available to the user in the metadata structure.

Definition at line 41 of file nvdsmeta.h.

#define UNTRACKED_OBJECT_ID 0xFFFFFFFFFFFFFFFF

Defines an untracked object ID.

Definition at line 50 of file nvdsmeta.h.

Typedef Documentation

typedef GList NvDisplayMetaList

Definition at line 55 of file nvdsmeta.h.

typedef struct _NvDsBaseMeta NvDsBaseMeta

Holds information about base metadata of a given metadata type.

typedef struct _NvDsBatchMeta NvDsBatchMeta

Holds information about a formed batch containing frames from different sources.

typedef struct _NvDsClassifierMeta NvDsClassifierMeta

Holds classifier metadata for an object.

typedef GList NvDsClassifierMetaList

Definition at line 56 of file nvdsmeta.h.

typedef struct NvDsDisplayMeta NvDsDisplayMeta

Holds display metadata that the user can specify in the frame.

typedef void NvDsElementMeta

Definition at line 59 of file nvdsmeta.h.

typedef struct _NvDsFrameMeta NvDsFrameMeta

Holds metadata for a frame in a batch.

typedef GList NvDsFrameMetaList

Definition at line 52 of file nvdsmeta.h.

typedef struct _NvDsLabelInfo NvDsLabelInfo

Holds label metadata for the classifier.

typedef GList NvDsLabelInfoList

Definition at line 57 of file nvdsmeta.h.

typedef gpointer(* NvDsMetaCopyFunc)(gpointer data, gpointer user_data)

Defines the type of a callback to copy metadata.

The callback is passed pointers to source metadata. It allocates the required memory, copies the content from the source metadata and returns a pointer to the destination.

Parameters

[in]	data	A pointer to the source metadata.
[in]	user_data	A pointer to user-specific data.

Definition at line 75 of file nvdsmeta.h.

typedef GList NvDsMetaList

Definition at line 58 of file nvdsmeta.h.

typedef struct _NvDsMetaPool NvDsMetaPool

Holds information about a given metadata pool.

typedef void(* NvDsMetaReleaseFunc)(gpointer data, gpointer user_data)

Defines the type of a callback to free metadata.

The callback is passed a pointer to metadata created by NvDsMetaCopyFunc(). It frees the metadata and any other resources that the metadata uses.

Parameters

[in]	data	A pointer to the metadata to be freed.
[in]	user_data	A pointer to user-specific data.

Definition at line 87 of file nvdsmeta.h.

typedef struct _NvDsObjectMeta NvDsObjectMeta

Holds metadata for an object in the frame.

typedef GList NvDsObjectMetaList

Definition at line 54 of file nvdsmeta.h.

typedef struct _NvDsUserMeta NvDsUserMeta

Holds user metadata.

typedef GList NvDsUserMetaList

Definition at line 53 of file nvdsmeta.h.

Enumeration Type Documentation

enum NvDsMetaType

Specifies the type of metadata.

All metadata types are subtypes of NvDsMetaType. Members that represent NVIDIA-defined types are in the range from NVDS_BATCH_META to NVDS_START_USER_META. User-defined types may be assigned values greater than or equal to NVDS_START_USER_META.

Enumerator
NVDS_INVALID_META
NVDS_BATCH_META	Specifies metadata type for formed batch.
NVDS_FRAME_META	Specifies metadata type for frame.
NVDS_OBJ_META	Specifies metadata type for a detected object.
NVDS_DISPLAY_META	Specifies metadata type for display.
NVDS_CLASSIFIER_META	Specifies metadata type for an object classifier.
NVDS_LABEL_INFO_META	Specifies metadata type for a label assigned by a classifier.
NVDS_USER_META	Reserved for internal use.
NVDS_PAYLOAD_META	Specifies metadata type for a payload generated by a message converter.
NVDS_EVENT_MSG_META	Specifies metadata type for a payload generated by a message broker.
NVDS_OPTICAL_FLOW_META	Specifies metadata type for an optical flow.
NVDS_LATENCY_MEASUREMENT_META	Specifies metadata type for a latency measurement.
NVDSINFER_TENSOR_OUTPUT_META	Specifies metadata type for raw inference output attached by Gst-nvinfer. See also NvDsInferTensorMeta for details.
NVDSINFER_SEGMENTATION_META	Specifies metadata type for segmentation model output attached by Gst-nvinfer. See also NvDsInferSegmentationMeta for details.
NVDS_CROP_IMAGE_META	Specifies metadata type for JPEG-encoded object crops. See the deepstream-image-meta-test app for details.
NVDS_TRACKER_PAST_FRAME_META	metadata type to be set for tracking previous frames
NVDS_RESERVED_META	Reserved field.
NVDS_GST_CUSTOM_META	Specifies the start of a range of enum values that represent types of NVIDIA-defined Gst metas. The range is from NVDS_GST_CUSTOM_META to NVDS_GST_CUSTOM_META+4096, inclusive.
NVDS_START_USER_META	Start adding user specific meta types from here. Specifies the start of a range of enum values that represent custom (application-specific) Gst meta types. A custom meta type may be assigned any enum value equal to or larger than this. Such Gst metas may be attached by GStreamer plugins upstream from Gst-nvstreammux. They may have any contents that is a superset of the metadata in an NvDsFrameMeta.
NVDS_FORCE32_META

Definition at line 96 of file nvdsmeta.h.

Function Documentation

NvDsClassifierMeta* nvds_acquire_classifier_meta_from_pool ( NvDsBatchMeta * batch_meta )

Acquires a classifier meta from a batch meta's classifier meta pool.

You must acquire a classifier meta from the classifier meta pool before you can fill it with classifier metadata.

Parameters

[in] batch_meta A pointer to the batch meta from which to acquire a classifier meta.

Returns: The classifier meta acquired from the batch meta's classifier meta pool.

NvDsDisplayMeta* nvds_acquire_display_meta_from_pool ( NvDsBatchMeta * batch_meta )

Acquires a display meta from a batch meta's display meta pool.

You must acquire a display meta before you can fill it with display metadata.

Parameters

[in] batch_meta A pointer to the batch meta from which to acquire a display meta.

Returns: The display meta acquired from the batch meta's display meta pool.

NvDsFrameMeta* nvds_acquire_frame_meta_from_pool ( NvDsBatchMeta * batch_meta )

Acquires a frame meta from a batch's frame meta pool.

You must acquire a frame meta before you can fill it with frame metadata.

Parameters

[in] batch_meta A pointer to batch meta from which to acquire a frame meta.

Returns: A pointer to the acquired frame meta.

NvDsLabelInfo* nvds_acquire_label_info_meta_from_pool ( NvDsBatchMeta * batch_meta )

Acquires a label info meta from a batch meta's label info meta pool.

You must acquire a label info meta before you can fill it and add it to a classifier meta.

Parameters

[in] batch_meta A pointer to the batch meta from which to acquire a label info meta.

Returns: The label info meta acquired from the batch meta's label info meta pool.

void nvds_acquire_meta_lock ( NvDsBatchMeta * batch_meta )

Acquires a lock before updating metadata.

Parameters

[in] batch_meta A pointer to the NvDsBatchMeta structure to be locked.

NvDsObjectMeta* nvds_acquire_obj_meta_from_pool ( NvDsBatchMeta * batch_meta )

Acquires an object meta from a batch meta's object meta pool.

You must acquire an object meta before you can fill it with object metadata.

Parameters

[in] batch_meta A pointer to the batch meta from which to acquire an object meta.

Returns: A pointer to the acquired object meta.

NvDsUserMeta* nvds_acquire_user_meta_from_pool ( NvDsBatchMeta * batch_meta )

Acquires a user meta from a batch meta's user meta pool.

You must acquire a user meta before you can fill it with user metdata and add it to a batch, frame, or object meta (call nvds_add_user_data_to_batch(), nvds_add_user_data_to_frame(), or nvds_add_user_data_to_obj()).

Parameters

[in] batch_meta A pointer to the batch meta from which to acquire a user meta.

void nvds_add_classifier_meta_to_object	(	NvDsObjectMeta *	obj_meta,
		NvDsClassifierMeta *	classifier_meta
	)

Adds a classifier meta the appropriate object meta.

You must acquire a classifier meta with nvds_acquire_classifier_meta_from_pool() and fill it with classifier metadata before you add it to the object metadata.

Parameters

[in]	obj_meta	A pointer to the object meta to which classifier_meta is to be added.
[in]	classifier_meta	A pointer to the classifier meta to be added to obj_meta.

void nvds_add_display_meta_to_frame	(	NvDsFrameMeta *	frame_meta,
		NvDsDisplayMeta *	display_meta
	)

Adds a display meta to the appropriate frame meta.

You must acquire a display meta with nvds_)acquire_display_meta_from_pool() and fill it with display metadata before you can add it to the frame meta.

Parameters

[in]	frame_meta	A pointer to frame meta to which display_meta is to be added.
[in]	display_meta	A pointer to the display meta to be added to frame_meta.

void nvds_add_frame_meta_to_batch	(	NvDsBatchMeta *	batch_meta,
		NvDsFrameMeta *	frame_meta
	)

Adds a frame meta to a batch meta.

Parameters

[in]	batch_meta	A pointer to the NvDsBatchMeta to which frame_meta is to be added.
[in]	frame_meta	A pointer to a frame meta to be added to batch_meta.

void nvds_add_label_info_meta_to_classifier	(	NvDsClassifierMeta *	classifier_meta,
		NvDsLabelInfo *	label_info_meta
	)

Adds a label info meta to a classifier meta.

Parameters

[in]	classifier_meta	A pointer to the classifier meta to which label_info_meta is to be added.
[in]	label_info_meta	A pointer to the label info meta to be added to classifier_meta.

void nvds_add_obj_meta_to_frame	(	NvDsFrameMeta *	frame_meta,
		NvDsObjectMeta *	obj_meta,
		NvDsObjectMeta *	obj_parent
	)

Adds an object meta to a frame meta.

You must acquire the object meta with nvds_acquire_object_meta_from_pool() and fill it with metadata before you add to to the frame meta.

Parameters

[in]	frame_meta	A pointer to the frame meta to which obj_meta is to be added.
[in]	obj_meta	A pointer to an object meta to be added to frame_meta.
[in]	obj_parent	A pointer to the this object meta's parent object meta. This pointer is stored in obj_meta->parent.

void nvds_add_user_meta_to_batch	(	NvDsBatchMeta *	batch_meta,
		NvDsUserMeta *	user_meta
	)

Add a user meta to a batch meta.

Parameters

[in]	batch_meta	A pointer to batch meta to which user_meta is to be added.
[in]	user_meta	A pointer to a user meta to be added to batch_meta.

void nvds_add_user_meta_to_frame	(	NvDsFrameMeta *	frame_meta,
		NvDsUserMeta *	user_meta
	)

Add a user meta to a frame meta.

Parameters

[in]	frame_meta	A pointer to the frame meta to which user_meta is to be added.
[in]	user_meta	A pointer to a user meta to be added to frame_meta.

void nvds_add_user_meta_to_obj	(	NvDsObjectMeta *	obj_meta,
		NvDsUserMeta *	user_meta
	)

Add a user meta user to an object meta.

Parameters

[in]	obj_meta	A pointer to the object meta to which user_meta is to be added.
[in]	user_meta	A pointer to the user meta to be added to obj_meta.

gpointer nvds_batch_meta_copy_func	(	gpointer	data,
		gpointer	user_data
	)

Copies or transforms meta data from one buffer to another.

Parameters

[in]	data	A pointer to a batch meta (of type NvDsBatchMeta), cast to `gpointer`.
[in]	user_data	Currently not in use and should be set to NULL.

Returns: A pointer to a metadata structure, to be cast to type NvDsBatchMeta.

void nvds_batch_meta_release_func	(	gpointer	data,
		gpointer	user_data
	)

Releases metadata from a batch meta.

Parameters

[in]	data	A pointer to a batch meta (type NvDsBatchMeta), cast to `gpointer`.
[in]	user_data	Currently not in use and should be set to NULL.

void nvds_clear_batch_user_meta_list	(	NvDsBatchMeta *	batch_meta,
		NvDsUserMetaList *	meta_list
	)

Removes all of the user metadata attached to the batch meta.

Parameters

[in]	batch_meta	A pointer to the batch meta whose user meta list is to be cleared.
[in]	meta_list	A pointer to the user meta list to be cleared

void nvds_clear_classifier_meta_list	(	NvDsObjectMeta *	obj_meta,
		NvDsClassifierMetaList *	meta_list
	)

Removes all of the classifier metadata attached to an object meta.

Parameters

[in]	obj_meta	A pointer to NvDsObjectMeta from which NvDsClassifierMetaList needs to be cleared
[in]	meta_list	A pointer to NvDsClassifierMetaList which needs to be cleared

void nvds_clear_display_meta_list	(	NvDsFrameMeta *	frame_meta,
		NvDisplayMetaList *	meta_list
	)

Removes all of the display metadata attached to a frame meta.

Parameters

[in]	frame_meta	A pointer to the frame meta whose display meta list is to be cleared.
[in]	meta_list	A pointer to the display meta list to be cleared.

void nvds_clear_frame_meta_list	(	NvDsBatchMeta *	batch_meta,
		NvDsFrameMetaList *	meta_list
	)

Removes all of the frame metadata attached to a batch meta.

Parameters

[in]	batch_meta	A pointer to the batch whose frame meta list is to be cleared.
[in]	meta_list	A pointer to the frame meta list to be cleared.

void nvds_clear_frame_user_meta_list	(	NvDsFrameMeta *	frame_meta,
		NvDsUserMetaList *	meta_list
	)

Removes all of the user metadata attached to the frame meta.

Parameters

[in]	frame_meta	A pointer to the frame meta whose user meta list is to be cleared.
[in]	meta_list	A pointer to the user meta list to be cleared.

void nvds_clear_label_info_meta_list	(	NvDsClassifierMeta *	classifier_meta,
		NvDsLabelInfoList *	meta_list
	)

Removes all of the label info metadata attached to a classifier meta.

Parameters

[in]	classifier_meta	A pointer to the classifier meta whose label info meta list is to be cleared.
[in]	meta_list	A pointer to the label info meta list to be cleared.

NvDsMetaList* nvds_clear_meta_list	(	NvDsBatchMeta *	batch_meta,
		NvDsMetaList *	meta_list,
		NvDsMetaPool *	meta_pool
	)

Removes all of the metadata elements attached to a metadata list.

Parameters

[in]	batch_meta	A pointer to a batch meta.
[in]	meta_list	A pointer to meta list to be cleared.
[in]	meta_pool	A pointer to the meta pool that contains meta_list.

Returns: A pointer to the updated meta list.

void nvds_clear_obj_meta_list	(	NvDsFrameMeta *	frame_meta,
		NvDsObjectMetaList *	meta_list
	)

Removes all the object metadata attached to a frame meta.

Parameters

[in]	frame_meta	A pointer to the frame meta whose object meta list is to be cleared.
[in]	meta_list	A pointer to the object meta list to be cleared.

void nvds_clear_obj_user_meta_list	(	NvDsObjectMeta *	object_meta,
		NvDsUserMetaList *	meta_list
	)

Removes all of the user metadata attached to an object meta.

Parameters

[in]	object_meta	A pointer to the object meta whose user meta list is to be cleared.
[in]	meta_list	A pointer to the user meta list to be cleared.

void nvds_copy_batch_user_meta_list	(	NvDsUserMetaList *	src_user_meta_list,
		NvDsBatchMeta *	dst_batch_meta
	)

Makes a deep copy of a user meta list to the user meta list in a specified batch meta.

Parameters

[in]	src_user_meta_list	A pointer to the source user meta list.
[in]	dst_batch_meta	A pointer to the destination batch meta.

void nvds_copy_classification_list	(	NvDsClassifierMetaList *	src_classifier_meta_list,
		NvDsObjectMeta *	dst_object_meta
	)

Makes a deep copy of a source classifier meta list to the classifier meta list in a specified object meta.

Parameters

[in]	src_classifier_meta_list	A pointer to the source classifier meta list.
[in]	dst_object_meta	A pointer to the destination object meta.

void nvds_copy_classifier_meta	(	NvDsClassifierMeta *	src_classifier_meta,
		NvDsClassifierMeta *	dst_classifier_meta
	)

Makes a deep copy of a classifier meta to another classifier meta.

Parameters

[in]	src_classifier_meta	A pointer to the source classifier meta.
[in]	dst_classifier_meta	A pointer to the destination classifier meta.

void nvds_copy_display_meta	(	NvDsDisplayMeta *	src_display_meta,
		NvDsDisplayMeta *	dst_display_meta
	)

Makes a deep copy of a display meta to another display meta.

Parameters

[in]	src_display_meta	A pointer to the source display meta.
[in]	dst_display_meta	A pointer to destination display meta.

void nvds_copy_display_meta_list	(	NvDisplayMetaList *	src_display_meta_list,
		NvDsFrameMeta *	dst_frame_meta
	)

Makes a deep copy of a source display meta list to the display meta list in a specified frame meta.

Parameters

[in]	src_display_meta_list	A pointer to the source display meta list.
[in]	dst_frame_meta	A pointer to the destination frame meta.

void nvds_copy_frame_meta	(	NvDsFrameMeta *	src_frame_meta,
		NvDsFrameMeta *	dst_frame_meta
	)

Makes a deep copy of a frame meta to another frame meta.

Parameters

[in]	src_frame_meta	A pointer to the source frame meta.
[in]	dst_frame_meta	A pointer to the destination frame meta.

void nvds_copy_frame_meta_list	(	NvDsFrameMetaList *	src_frame_meta_list,
		NvDsBatchMeta *	dst_batch_meta
	)

Makes a deep copy of a source frame meta list to the frame meta list in a specified batch meta.

Parameters

[in]	src_frame_meta_list	A pointer to the source frame meta list.
[in]	dst_batch_meta	A pointer to the destination batch meta.

void nvds_copy_frame_user_meta_list	(	NvDsUserMetaList *	src_user_meta_list,
		NvDsFrameMeta *	dst_frame_meta
	)

Makes a deep copy of a source user meta list to the user meta list in a specified frame meta.

Parameters

[in]	src_user_meta_list	A pointer to the source user meta list.
[in]	dst_frame_meta	A pointer to the destination frame meta.

void nvds_copy_label_info_list	(	NvDsLabelInfoList *	src_label_info_list,
		NvDsClassifierMeta *	dst_classifier_meta
	)

Makes a deep copy of a source label info meta list to the label info meta list in a specified classifier meta.

Parameters

[in]	src_label_info_list	A pointer to the source label info meta list.
[in]	dst_classifier_meta	A pointer to the destination classifier meta.

void nvds_copy_label_info_meta	(	NvDsLabelInfo *	src_label_info,
		NvDsLabelInfo *	dst_label_info
	)

Makes a deep copy of a label info meta to another label info meta.

Parameters

[in]	src_label_info	A pointer to the source label info meta.
[in]	dst_label_info	A pointer to the destination label info meta.

void nvds_copy_obj_meta	(	NvDsObjectMeta *	src_object_meta,
		NvDsObjectMeta *	dst_object_meta
	)

Makes a deep copy of an object meta to another object meta.

Parameters

[in]	src_object_meta	A pointer to the source object meta.
[in]	dst_object_meta	A pointer to the destination object meta.

void nvds_copy_obj_meta_list	(	NvDsObjectMetaList *	src_obj_meta_list,
		NvDsFrameMeta *	dst_frame_meta
	)

Makes a deep copy of a source object meta list to the object meta list in a specified frame meta.

Parameters

[in]	src_obj_meta_list	A pointer to the source object meta list.
[in]	dst_frame_meta	A pointer to the destination frame meta.

void nvds_copy_obj_user_meta_list	(	NvDsUserMetaList *	src_user_meta_list,
		NvDsObjectMeta *	dst_object_meta
	)

Makes a deep copy of a source user meta list to the user meta list in a specified object meta.

Parameters

[in]	src_user_meta_list	A pointer to the source user meta list.
[in]	dst_object_meta	A pointer to the destination object meta.

NvDsBatchMeta* nvds_create_batch_meta ( guint max_batch_size )

Creates a batch metadata structure for a batch of specified size.

Parameters

[in] max_batch_size The maximum number of frames in the batch. @ return A pointer to the created structure.

gboolean nvds_destroy_batch_meta ( NvDsBatchMeta * batch_meta )

Destroys a batch metadata structure.

Parameters

[in] batch_meta A pointer to batch metadata structure to be destroyed.

Returns: True if the object was successfully destroyed, or false otherwise.

gboolean nvds_get_current_metadata_info ( NvDsBatchMeta * batch_meta )

A debugging function; prints current metadata information available after inference.

This function should be called after inference.

Parameters

[in] batch_meta A pointer to a batch meta from which to print information.

Returns

NvDsFrameMeta* nvds_get_nth_frame_meta	(	NvDsFrameMetaList *	frame_meta_list,
		guint	index
	)

Returns a pointer to a specified frame meta in the frame meta list.

Parameters

[in]	frame_meta_list	A pointer to a list of pointers to frame metas.
[in]	index	The index of the frame meta to be returned.

Returns: A pointer to the index'th frame meta in the frame meta list.

NvDsMetaType nvds_get_user_meta_type ( gchar * meta_descriptor )

Generates a unique user metadata type from a specified string describing user-specific metadata.

Parameters

[in] meta_descriptor A pointer to a string describing user-specific metadata. The string must be in the format ORG_NAME.COMPONENT_NAME.METADATA_DESCRIPTION, e.g. NVIDIA.NVINFER.TENSOR_METADATA.

void nvds_release_meta_lock ( NvDsBatchMeta * batch_meta )

Releases the lock after updating metadata.

Parameters

[in] batch_meta A pointer to NvDsBatchMeta structure to be unlocked.

void nvds_remove_classifier_meta_from_obj	(	NvDsObjectMeta *	obj_meta,
		NvDsClassifierMeta *	classifier_meta
	)

Removes a classifier meta from the object meta to which it is attached.

Parameters

[in]	obj_meta	A pointer to the object meta from which classifier_meta is to be removed.
[in]	classifier_meta	A pointer to the classifier meta to be removed from obj_meta.

void nvds_remove_display_meta_from_frame	(	NvDsFrameMeta *	frame_meta,
		NvDsDisplayMeta *	display_meta
	)

Removes a display meta from the frame meta to which it is attached.

Parameters

[in]	frame_meta	A pointer to the frame meta from which display_meta is to be removed.
[in]	display_meta	A pointer to the display meta to be removed from frame_meta.

void nvds_remove_frame_meta_from_batch	(	NvDsBatchMeta *	batch_meta,
		NvDsFrameMeta *	frame_meta
	)

Removes a frame meta from a batch meta.

Parameters

[in]	batch_meta	A pointer to the batch meta from which frame_meta is to be removed.
[in]	frame_meta	A pointer to the frame meta to be removed from batch_meta.

void nvds_remove_label_info_meta_from_classifier	(	NvDsClassifierMeta *	classifier_meta,
		NvDsLabelInfo *	label_info_meta
	)

Removes a label info meta from the classifier meta to which it is attached.

Parameters

[in]	classifier_meta	A pointer to the classifier meta from which label_info_meta is to be removed.
[in]	label_info_meta	A pointer to the label info meta to be removed from classifier_meta.

void nvds_remove_obj_meta_from_frame	(	NvDsFrameMeta *	frame_meta,
		NvDsObjectMeta *	obj_meta
	)

Removes an object meta from the frame meta to which it is attached.

Parameters

[in]	frame_meta	A pointer to frame meta from which obj_meta is to be removed.
[in]	obj_meta	A pointer to the object meta to be removed from frame_meta.

void nvds_remove_user_meta_from_batch	(	NvDsBatchMeta *	batch_meta,
		NvDsUserMeta *	user_meta
	)

Removes a user meta from a batch meta to which it is attached.

Parameters

[in]	batch_meta	A pointer to the batch meta from which user_meta is to be removed.
[in]	user_meta	A pointer to the user meta to be removed from batch_meta.

returns acquired NvDsUserMeta pointer from user meta pool

void nvds_remove_user_meta_from_frame	(	NvDsFrameMeta *	frame_meta,
		NvDsUserMeta *	user_meta
	)

Removes a user meta from a frame meta to which it is attached.

Parameters

[in]	frame_meta	A pointer to the frame meta from which user_meta is to be removed.
[in]	user_meta	A pointer to the user meta to be removed from frame_meta.

void nvds_remove_user_meta_from_object	(	NvDsObjectMeta *	obj_meta,
		NvDsUserMeta *	user_meta
	)

Removes a user meta from an object meta to which it is attached.

Parameters

[in]	obj_meta	A pointer to the object meta from which user_meta is to be removed.
[in]	user_meta	A pointer to the user to be removed from obj_meta.

NVIDIA DeepStream SDK API Reference

5.0 Release

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation