NVIDIA DeepStream SDK API Reference

7.1 Release
nvmsgconv/nvmsgconv.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
21 #ifndef NVMSGCONV_H_
22 #define NVMSGCONV_H_
23 
24 #include "nvdsmeta_schema.h"
25 #include <glib.h>
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 
35 typedef struct NvDsMsg2pCtx {
38 
40  gpointer privData;
41 } NvDsMsg2pCtx;
42 
48 typedef struct {
50  void* objMeta;
52  void* frameMeta;
54  gchar* mediaType;
56  // abiRefDataMap* typecasted to void*
57  // NvDs3D_Find1stDataMap() will be used to get this pointer
58  // in LL library, we can:
59  void* datamap;
61 
75 NvDsMsg2pCtx* nvds_msg2p_ctx_create(const gchar* file, NvDsPayloadType type);
76 
83 
98 NvDsPayload* nvds_msg2p_generate(NvDsMsg2pCtx* ctx, NvDsEvent* events, guint size);
99 
117 NvDsPayload** nvds_msg2p_generate_multiple(NvDsMsg2pCtx* ctx, NvDsEvent* events, guint size, guint* payloadCount);
118 
132 NvDsPayload* nvds_msg2p_generate_new(NvDsMsg2pCtx* ctx, void* metadataInfo);
133 
150 NvDsPayload** nvds_msg2p_generate_multiple_new(NvDsMsg2pCtx* ctx, void* metadataInfo, guint* payloadCount);
151 
158 void nvds_msg2p_release(NvDsMsg2pCtx* ctx, NvDsPayload* payload);
159 
160 #ifdef __cplusplus
161 }
162 #endif
163 #endif /* NVMSGCONV_H_ */
NvDsMsg2pMetaInfo::frameMeta
void * frameMeta
Holds the frame metadata.
Definition: nvmsgconv/nvmsgconv.h:52
NvDsPayload
Holds payload metadata.
Definition: nvdsmeta_schema.h:385
NvDsMsg2pCtx::payloadType
NvDsPayloadType payloadType
type of payload to be generated.
Definition: nvmsgconv_audio/nvmsgconv.h:37
nvds_msg2p_generate
NvDsPayload * nvds_msg2p_generate(NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size)
This function will parse the NvDsEventMsgMeta and will generate message payload.
nvds_msg2p_generate_multiple
NvDsPayload ** nvds_msg2p_generate_multiple(NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size, guint *payloadCount)
This function will parse the NvDsEventMsgMeta and will generate multiple message payloads.
_NvDsEvent
Holds event information.
Definition: nvdsmeta_schema.h:365
NvDsPayloadType
NvDsPayloadType
Defines payload type flags.
Definition: nvdsmeta_schema.h:88
nvds_msg2p_generate_multiple_new
NvDsPayload ** nvds_msg2p_generate_multiple_new(NvDsMsg2pCtx *ctx, void *metadataInfo, guint *payloadCount)
This function will parse the NvDsMsg2pMetaInfo and will generate multiple message payloads.
NvDsMsg2pCtx::privData
gpointer privData
private to component.
Definition: nvmsgconv_audio/nvmsgconv.h:40
NvDsMsg2pCtx
struct NvDsMsg2pCtx NvDsMsg2pCtx
NvDsMsg2pCtx is structure for library context.
NvDsMsg2pMetaInfo
NvDsMsg2pMetaInfo is structure to hold the NvDs metadata related information to be processed to gener...
Definition: nvmsgconv/nvmsgconv.h:48
nvds_msg2p_ctx_destroy
void nvds_msg2p_ctx_destroy(NvDsMsg2pCtx *ctx)
Release the resources allocated during context creation.
NvDsMsg2pCtx
NvDsMsg2pCtx is structure for library context.
Definition: nvmsgconv_audio/nvmsgconv.h:35
NvDsMsg2pMetaInfo::mediaType
gchar * mediaType
media type: (ex: audio, video)
Definition: nvmsgconv/nvmsgconv.h:54
nvds_msg2p_ctx_create
NvDsMsg2pCtx * nvds_msg2p_ctx_create(const gchar *file, NvDsPayloadType type)
This function initializes the library with user defined options mentioned in the file and returns the...
nvds_msg2p_generate_new
NvDsPayload * nvds_msg2p_generate_new(NvDsMsg2pCtx *ctx, void *metadataInfo)
This function will parse the NvDsMsg2pMetaInfo and will generate message payloads.
nvds_msg2p_release
void nvds_msg2p_release(NvDsMsg2pCtx *ctx, NvDsPayload *payload)
This function should be called to release memory allocated for payload.
NvDsMsg2pMetaInfo::objMeta
void * objMeta
Holds the object metadata.
Definition: nvmsgconv/nvmsgconv.h:50
NvDsMsg2pMetaInfo::datamap
void * datamap
datamap for buffers from ds3d components
Definition: nvmsgconv/nvmsgconv.h:59
nvdsmeta_schema.h