NVIDIA DeepStream SDK API Reference

5.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
gstnvdsmeta.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2020, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA Corporation is strictly prohibited.
9  *
10  */
11 
39 #ifndef GST_NVDS_META_API_H
40 #define GST_NVDS_META_API_H
41 
42 #include <gst/gst.h>
43 #include <gst/video/video.h>
44 #include <gst/base/gstbasetransform.h>
45 
46 #include "nvdsmeta.h"
47 #include "nvds_latency_meta.h"
48 
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 GType nvds_meta_api_get_type (void);
54 #define NVDS_META_API_TYPE (nvds_meta_api_get_type())
55 
56 const GstMetaInfo *nvds_meta_get_info (void);
57 
58 #define NVDS_META_INFO (nvds_meta_get_info())
59 
60 #define NVDS_META_STRING "nvdsmeta"
61 
66 typedef enum {
68  /* Specifies information of a formed batch. */
71  /* Specifies information of dewarped surfaces. */
74  /* Specifies the first value that may be assigned to a user-defined type. */
75  NVDS_GST_META_FORCE32 = 0x7FFFFFFF
77 
81  typedef struct _NvDsMeta {
82  GstMeta meta;
83 
86  gpointer meta_data;
87 
89  gpointer user_data;
90 
92  gint meta_type;
93 
98 
102 
120 
128 
129 } NvDsMeta;
130 
151 NvDsMeta *gst_buffer_add_nvds_meta (GstBuffer *buffer, gpointer meta_data,
152  gpointer user_data, NvDsMetaCopyFunc copy_func,
153  NvDsMetaReleaseFunc release_func);
154 
163 NvDsMeta* gst_buffer_get_nvds_meta (GstBuffer *buffer);
164 
173 NvDsBatchMeta * gst_buffer_get_nvds_batch_meta (GstBuffer *buffer);
175 #ifdef __cplusplus
176 }
177 #endif
178 #endif
gpointer meta_data
Holds a pointer to metadata.
Definition: gstnvdsmeta.h:86
NvDsMetaReleaseFunc gst_to_nvds_meta_release_func
A callback to be called when meta_data transformed into NvDsUserMeta is to be destroyed.
Definition: gstnvdsmeta.h:127
GstMeta meta
Definition: gstnvdsmeta.h:82
struct _NvDsMeta NvDsMeta
Holds DeepSteam metadata.
NvDsMeta * gst_buffer_get_nvds_meta(GstBuffer *buffer)
Gets the NvDsMeta last added to a GstBuffer.
NvDsMeta * gst_buffer_add_nvds_meta(GstBuffer *buffer, gpointer meta_data, gpointer user_data, NvDsMetaCopyFunc copy_func, NvDsMetaReleaseFunc release_func)
Adds GstMeta of type NvDsMeta to the GstBuffer and sets the meta_data member of NvDsMeta.
const GstMetaInfo * nvds_meta_get_info(void)
GType nvds_meta_api_get_type(void)
Holds DeepSteam metadata.
Definition: gstnvdsmeta.h:81
GstNvDsMetaType
Defines the type of metadata.
Definition: gstnvdsmeta.h:66
Holds information about a formed batch containing frames from different sources.
Definition: nvdsmeta.h:206
NvDsMetaReleaseFunc freefunc
A callback to be called when meta_data is to be destroyed.
Definition: gstnvdsmeta.h:101
gpointer(* NvDsMetaCopyFunc)(gpointer data, gpointer user_data)
Defines the type of a callback to copy metadata.
Definition: nvdsmeta.h:77
Defines Latency API
NvDsMetaCopyFunc gst_to_nvds_meta_transform_func
A callback to be called when meta_data is transformed into NvDsUserMeta.
Definition: gstnvdsmeta.h:119
Defines NVIDIA DeepStream Metadata Structures
void(* NvDsMetaReleaseFunc)(gpointer data, gpointer user_data)
Defines the type of a callback to free metadata.
Definition: nvdsmeta.h:89
gint meta_type
Holds the type of metadata, one of values of enum GstNvDsMetaType.
Definition: gstnvdsmeta.h:92
Specifies the start of a range of enum values that represent types of NVIDIA-defined Gst metas...
Definition: nvdsmeta.h:144
gpointer user_data
Holds a pointer to user-specific data .
Definition: gstnvdsmeta.h:89
NvDsMetaCopyFunc copyfunc
A callback to be called when meta_data is to be copied or transformed from one buffer to other...
Definition: gstnvdsmeta.h:97
NvDsBatchMeta * gst_buffer_get_nvds_batch_meta(GstBuffer *buffer)
Gets the NvDsBatchMeta added to a GstBuffer.