NVIDIA DeepStream SDK API Reference

9.2 Release
sources/libs/nvdsmeta/nvdsmeta_internal.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2019-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _NVDSMETA_INTERNAL_H_
19 #define _NVDSMETA_INTERNAL_H_
20 
21 #include "nvdsmeta.h"
22 
23 #ifdef __cplusplus
24 extern "C"
25 {
26 #endif
27 
29 #define NUM_OBJ_META 16
30 
31 #define NUM_CLASSIFIER_META 8
32 
33 #define NUM_DISPLAY_META 8
34 
35 #define NUM_USER_META 8
36 
37 #define NUM_LABEL_META 8
38 
40  guint max_batch_size);
41 
42 gboolean nvds_destroy_frame_meta_pool (NvDsBatchMeta *batch_meta,
43  NvDsMetaPool *frame_meta_pool);
44 
46  guint max_batch_size);
47 
49  NvDsMetaPool *frame_meta_pool);
50 
52  guint max_init_objs);
53 
54 gboolean nvds_destroy_obj_meta_pool (NvDsBatchMeta *batch_meta,
55  NvDsMetaPool *obj_meta_pool);
56 
58  guint max_init_classifier_meta);
59 
61  NvDsMetaPool *classifier_meta_pool);
62 
64  guint max_display_meta);
65 
66 gboolean nvds_destroy_display_meta_pool (NvDsBatchMeta *batch_meta,
67  NvDsMetaPool *display_meta_pool);
68 
70  guint max_user_meta);
71 
72 gboolean nvds_destroy_user_meta_pool (NvDsBatchMeta *batch_meta,
73  NvDsMetaPool *user_meta_pool);
74 
76  guint max_label_info_meta);
77 
79  NvDsMetaPool *label_info_meta_pool);
80 
82  guint pool_size, guint element_size, NvDsMetaCopyFunc copy_func,
83  NvDsMetaReleaseFunc release_func, NvDsMetaType meta_type);
84 
85 gboolean nvds_destroy_meta_pool (NvDsBatchMeta *batch_meta,
86  NvDsMetaPool *meta_pool);
87 
89  NvDsMetaPool *meta_pool);
90 
92  NvDsElementMeta *element_meta, gboolean append);
93 
95  NvDsElementMeta * meta, NvDsMetaPool *meta_pool);
96 
97 void increase_pool_size (NvDsBatchMeta *batch_meta, NvDsMetaPool *meta_pool);
98 
100  gpointer user_data);
101 
103  gpointer user_data);
104 
105 void release_frame_meta(NvDsElementMeta * element_meta, gpointer user_data);
106 
107 void release_audio_frame_meta(NvDsElementMeta * element_meta, gpointer user_data);
108 
109 void release_obj_meta(NvDsElementMeta *element_meta, gpointer user_data);
110 
111 void release_classifier_meta(NvDsElementMeta *element_meta, gpointer user_data);
112 
113 void release_label_meta(NvDsElementMeta *element_meta, gpointer user_data);
114 
115 void release_display_meta(NvDsElementMeta *element_meta, gpointer user_data);
116 
117 void get_meta_pool_status(NvDsMetaPool *meta_pool);
118 
119 void copy_user_meta_list(NvDsUserMetaList *src_user_meta_list,
120  NvDsElementMeta *element_meta, NvDsMetaType meta_type);
121 
122 void copy_audio_user_meta_list(NvDsUserMetaList *src_user_meta_list,
123  NvDsElementMeta *element_meta, NvDsMetaType meta_type);
124 
125 void copy_user_meta(NvDsUserMeta *src_user_meta, NvDsUserMeta *dst_user_meta);
126 
127 #ifdef __cplusplus
128 }
129 #endif
130 
131 #endif
release_audio_frame_meta
void release_audio_frame_meta(NvDsElementMeta *element_meta, gpointer user_data)
NvDsMetaCopyFunc
gpointer(* NvDsMetaCopyFunc)(gpointer data, gpointer user_data)
Defines the type of a callback to copy metadata.
Definition: includes/nvdsmeta.h:84
copy_audio_user_meta_list
void copy_audio_user_meta_list(NvDsUserMetaList *src_user_meta_list, NvDsElementMeta *element_meta, NvDsMetaType meta_type)
nvds_create_user_meta_pool
NvDsMetaPool * nvds_create_user_meta_pool(NvDsBatchMeta *batch_meta, guint max_user_meta)
release_frame_meta
void release_frame_meta(NvDsElementMeta *element_meta, gpointer user_data)
nvds_destroy_display_meta_pool
gboolean nvds_destroy_display_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *display_meta_pool)
nvds_destroy_audio_frame_meta_pool
gboolean nvds_destroy_audio_frame_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *frame_meta_pool)
nvds_destroy_obj_meta_pool
gboolean nvds_destroy_obj_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *obj_meta_pool)
nvds_destroy_frame_meta_pool
gboolean nvds_destroy_frame_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *frame_meta_pool)
copy_user_meta_list
void copy_user_meta_list(NvDsUserMetaList *src_user_meta_list, NvDsElementMeta *element_meta, NvDsMetaType meta_type)
release_obj_meta
void release_obj_meta(NvDsElementMeta *element_meta, gpointer user_data)
nvds_create_display_meta_pool
NvDsMetaPool * nvds_create_display_meta_pool(NvDsBatchMeta *batch_meta, guint max_display_meta)
audio_batch_meta_copy
NvDsBatchMeta * audio_batch_meta_copy(NvDsBatchMeta *src_batch_meta, gpointer user_data)
release_label_meta
void release_label_meta(NvDsElementMeta *element_meta, gpointer user_data)
nvds_create_frame_meta_pool
NvDsMetaPool * nvds_create_frame_meta_pool(NvDsBatchMeta *batch_meta, guint max_batch_size)
nvds_acquire_meta_from_pool
NvDsElementMeta * nvds_acquire_meta_from_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *meta_pool)
nvds_create_classifier_meta_pool
NvDsMetaPool * nvds_create_classifier_meta_pool(NvDsBatchMeta *batch_meta, guint max_init_classifier_meta)
_NvDsUserMeta
Holds user metadata.
Definition: includes/nvdsmeta.h:496
release_display_meta
void release_display_meta(NvDsElementMeta *element_meta, gpointer user_data)
nvds_remove_meta_from_parent
NvDsMetaList * nvds_remove_meta_from_parent(NvDsMetaList *parent_list, NvDsElementMeta *meta, NvDsMetaPool *meta_pool)
_NvDsBatchMeta
Holds information about a formed batch containing frames from different sources.
Definition: includes/nvdsmeta.h:264
nvds_create_label_info_meta_pool
NvDsMetaPool * nvds_create_label_info_meta_pool(NvDsBatchMeta *batch_meta, guint max_label_info_meta)
_NvDsMetaPool
Holds information about a given metadata pool.
Definition: includes/nvdsmeta.h:223
release_classifier_meta
void release_classifier_meta(NvDsElementMeta *element_meta, gpointer user_data)
nvds_destroy_label_info_meta_pool
gboolean nvds_destroy_label_info_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *label_info_meta_pool)
NvDsElementMeta
void NvDsElementMeta
Definition: includes/nvdsmeta.h:68
NvDsUserMetaList
GList NvDsUserMetaList
Definition: includes/nvdsmeta.h:62
nvds_destroy_classifier_meta_pool
gboolean nvds_destroy_classifier_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *classifier_meta_pool)
nvds_destroy_user_meta_pool
gboolean nvds_destroy_user_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *user_meta_pool)
pydeepstreamdoc::nvmeta::BatchMetaDoc::append
constexpr const char * append
Definition: service-maker/sources/python/src/bindings/docstrings/metadatadoc.h:63
batch_meta_copy
NvDsBatchMeta * batch_meta_copy(NvDsBatchMeta *src_batch_meta, gpointer user_data)
increase_pool_size
void increase_pool_size(NvDsBatchMeta *batch_meta, NvDsMetaPool *meta_pool)
NvDsMetaType
NvDsMetaType
Specifies the type of metadata.
Definition: includes/nvdsmeta.h:105
nvds_destroy_meta_pool
gboolean nvds_destroy_meta_pool(NvDsBatchMeta *batch_meta, NvDsMetaPool *meta_pool)
nvds_create_meta_pool
NvDsMetaPool * nvds_create_meta_pool(NvDsBatchMeta *batch_meta, guint pool_size, guint element_size, NvDsMetaCopyFunc copy_func, NvDsMetaReleaseFunc release_func, NvDsMetaType meta_type)
copy_user_meta
void copy_user_meta(NvDsUserMeta *src_user_meta, NvDsUserMeta *dst_user_meta)
NvDsMetaReleaseFunc
void(* NvDsMetaReleaseFunc)(gpointer data, gpointer user_data)
Defines the type of a callback to free metadata.
Definition: includes/nvdsmeta.h:96
get_meta_pool_status
void get_meta_pool_status(NvDsMetaPool *meta_pool)
nvds_add_meta_to_parent
NvDsMetaList * nvds_add_meta_to_parent(NvDsMetaList *parent_meta_list, NvDsElementMeta *element_meta, gboolean append)
NvDsMetaList
GList NvDsMetaList
Definition: includes/nvdsmeta.h:67
nvds_create_audio_frame_meta_pool
NvDsMetaPool * nvds_create_audio_frame_meta_pool(NvDsBatchMeta *batch_meta, guint max_batch_size)
nvds_create_obj_meta_pool
NvDsMetaPool * nvds_create_obj_meta_pool(NvDsBatchMeta *batch_meta, guint max_init_objs)