NVIDIA DeepStream SDK API Reference

9.1 Release
sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-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 _GST_NVMSGCONV_H_
19 #define _GST_NVMSGCONV_H_
20 
21 #include <gst/base/gstbasetransform.h>
22 #include "nvmsgconv.h"
23 
24 G_BEGIN_DECLS
25 #define GST_TYPE_NVMSGCONV (gst_nvmsgconv_get_type())
26 #define GST_NVMSGCONV(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_NVMSGCONV,GstNvMsgConv))
27 #define GST_NVMSGCONV_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_NVMSGCONV,GstNvMsgConvClass))
28 #define GST_IS_NVMSGCONV(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_NVMSGCONV))
29 #define GST_IS_NVMSGCONV_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_NVMSGCONV))
30 typedef struct _GstNvMsgConv GstNvMsgConv;
32 
33 typedef NvDsMsg2pCtx *(*nvds_msg2p_ctx_create_ptr) (const gchar * file,
34  NvDsPayloadType type);
35 
36 typedef void (*nvds_msg2p_ctx_destroy_ptr) (NvDsMsg2pCtx * ctx);
37 
38 typedef NvDsPayload *(*nvds_msg2p_generate_ptr) (NvDsMsg2pCtx * ctx,
39  NvDsEvent * events, guint size);
40 
41 typedef NvDsPayload **(*nvds_msg2p_generate_multiple_ptr) (NvDsMsg2pCtx * ctx,
42  NvDsEvent * events, guint size, guint * payloadCount);
43 
44 typedef void (*nvds_msg2p_release_ptr) (NvDsMsg2pCtx * ctx,
45  NvDsPayload * payload);
46 
47 typedef NvDsPayload *(*nvds_msg2p_generate_ptr_new) (NvDsMsg2pCtx * ctx,
48  void *metadataInfo);
49 
50 typedef NvDsPayload **(*nvds_msg2p_generate_multiple_ptr_new) (NvDsMsg2pCtx *
51  ctx, void *metadataInfo, guint * payloadCount);
52 
53 typedef enum
54 {
60 
62 {
63  GstBaseTransform parent;
64 
65  GQuark dsMetaQuark;
66  gchar *configFile;
67  gchar *msg2pLib;
68  gpointer libHandle;
69  gint compId;
73  gboolean multiplePayloads;
74  gboolean msg2pNewApi;
77  gboolean stop;
78  gboolean selfRef;
79  gboolean dummyPayload;
81 
91 };
92 
94 {
95  GstBaseTransformClass parent_class;
96 };
97 
98 GType gst_nvmsgconv_get_type (void);
99 
100 G_END_DECLS
101 #endif
gst_nvmsgconv_get_type
GType gst_nvmsgconv_get_type(void)
NvDsPayload
Holds payload metadata.
Definition: sources/includes/nvdsmeta_schema.h:488
_GstNvMsgConv::msg2pLib
gchar * msg2pLib
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:67
nvds_msg2p_generate_ptr_new
NvDsPayload *(* nvds_msg2p_generate_ptr_new)(NvDsMsg2pCtx *ctx, void *metadataInfo)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:47
_GstNvMsgConv::msg2p_generate_new
nvds_msg2p_generate_ptr_new msg2p_generate_new
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:86
_GstNvMsgConv
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:61
_GstNvMsgConv::pCtx
NvDsMsg2pCtx * pCtx
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:71
_GstNvMsgConv::msg2p_generate
nvds_msg2p_generate_ptr msg2p_generate
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:84
nvds_msg2p_generate_ptr
NvDsPayload *(* nvds_msg2p_generate_ptr)(NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:38
nvds_msg2p_generate_multiple_ptr_new
NvDsPayload **(* nvds_msg2p_generate_multiple_ptr_new)(NvDsMsg2pCtx *ctx, void *metadataInfo, guint *payloadCount)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:50
_GstNvMsgConvClass::parent_class
GstBaseTransformClass parent_class
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:95
_NvDsEvent
Holds event information.
Definition: sources/includes/nvdsmeta_schema.h:468
NvDsPayloadType
NvDsPayloadType
Defines payload type flags.
Definition: sources/includes/nvdsmeta_schema.h:95
_GstNvMsgConv::numActivePayloads
gint numActivePayloads
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:76
_GstNvMsgConv::msg2pNewApi
gboolean msg2pNewApi
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:74
_GstNvMsgConv::libHandle
gpointer libHandle
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:68
_GstNvMsgConv::debugPayloadDir
gchar * debugPayloadDir
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:72
kNvDsMsgConv_Video
@ kNvDsMsgConv_Video
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:55
_GstNvMsgConv::multiplePayloads
gboolean multiplePayloads
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:73
kNvDsMsgConv_Audio
@ kNvDsMsgConv_Audio
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:56
_GstNvMsgConv::frameInterval
guint frameInterval
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:75
nvds_msg2p_ctx_destroy_ptr
void(* nvds_msg2p_ctx_destroy_ptr)(NvDsMsg2pCtx *ctx)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:36
_GstNvMsgConv::parent
GstBaseTransform parent
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:63
NvDsMsg2pCtx
NvDsMsg2pCtx is structure for library context.
Definition: sources/libs/nvmsgconv/nvmsgconv.h:40
_GstNvMsgConv::configFile
gchar * configFile
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:66
_GstNvMsgConv::payloadType
NvDsPayloadType payloadType
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:70
kNvDsMsgConv_Sparse4D
@ kNvDsMsgConv_Sparse4D
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:58
_GstNvMsgConv::ctx_create
nvds_msg2p_ctx_create_ptr ctx_create
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:82
_GstNvMsgConv::embedding_filter
gchar * embedding_filter
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:80
nvds_msg2p_release_ptr
void(* nvds_msg2p_release_ptr)(NvDsMsg2pCtx *ctx, NvDsPayload *payload)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:44
_GstNvMsgConv::msg2p_release
nvds_msg2p_release_ptr msg2p_release
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:88
NvDsMsgConvInputType
NvDsMsgConvInputType
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:53
_GstNvMsgConv::stop
gboolean stop
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:77
_GstNvMsgConv::dummyPayload
gboolean dummyPayload
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:79
kNvDsMsgConv_DS3D
@ kNvDsMsgConv_DS3D
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:57
_GstNvMsgConv::msg2p_generate_multiple
nvds_msg2p_generate_multiple_ptr msg2p_generate_multiple
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:85
_GstNvMsgConv::selfRef
gboolean selfRef
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:78
_GstNvMsgConv::msg2p_generate_multiple_new
nvds_msg2p_generate_multiple_ptr_new msg2p_generate_multiple_new
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:87
_GstNvMsgConv::ctx_destroy
nvds_msg2p_ctx_destroy_ptr ctx_destroy
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:83
_GstNvMsgConv::inputType
NvDsMsgConvInputType inputType
Identifies from caps/capability of the incoming data.
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:90
nvds_msg2p_generate_multiple_ptr
NvDsPayload **(* nvds_msg2p_generate_multiple_ptr)(NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size, guint *payloadCount)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:41
_GstNvMsgConv::dsMetaQuark
GQuark dsMetaQuark
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:65
nvds_msg2p_ctx_create_ptr
NvDsMsg2pCtx *(* nvds_msg2p_ctx_create_ptr)(const gchar *file, NvDsPayloadType type)
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:33
_GstNvMsgConvClass
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:93
_GstNvMsgConv::compId
gint compId
Definition: sources/gst-plugins/gst-nvmsgconv/gstnvmsgconv.h:69