includes/nvdsmeta_schema.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef NVDSMETA_H_
#define NVDSMETA_H_
 
#include <glib.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum NvDsEventType {
  NVDS_EVENT_ENTRY,
  NVDS_EVENT_EXIT,
  NVDS_EVENT_MOVING,
  NVDS_EVENT_STOPPED,
  NVDS_EVENT_EMPTY,
  NVDS_EVENT_PARKED,
  NVDS_EVENT_RESET,
 
  NVDS_EVENT_RESERVED = 0x100,
  NVDS_EVENT_CUSTOM = 0x101,
  NVDS_EVENT_FORCE32 = 0x7FFFFFFF
} NvDsEventType;
 
typedef enum NvDsObjectType {
  NVDS_OBJECT_TYPE_VEHICLE,
  NVDS_OBJECT_TYPE_PERSON,
  NVDS_OBJECT_TYPE_FACE,
  NVDS_OBJECT_TYPE_BAG,
  NVDS_OBJECT_TYPE_BICYCLE,
  NVDS_OBJECT_TYPE_ROADSIGN,
  NVDS_OBJECT_TYPE_VEHICLE_EXT,
  NVDS_OBJECT_TYPE_PERSON_EXT,
  NVDS_OBJECT_TYPE_FACE_EXT,
  NVDS_OBJECT_TYPE_3D,
  NVDS_OBJECT_TYPE_DUMMY,
  NVDS_OBJECT_TYPE_PRODUCT, 
  NVDS_OBJECT_TYPE_PRODUCT_EXT, 
  NVDS_OBJECT_TYPE_RESERVED = 0x100,
  NVDS_OBJECT_TYPE_CUSTOM = 0x101,
  NVDS_OBJECT_TYPE_UNKNOWN = 0x102,
  NVDS_OBEJCT_TYPE_FORCE32 = 0x7FFFFFFF
} NvDsObjectType;
 
typedef enum NvDsPayloadType {
  NVDS_PAYLOAD_DEEPSTREAM,
  NVDS_PAYLOAD_DEEPSTREAM_MINIMAL,
  NVDS_PAYLOAD_DEEPSTREAM_PROTOBUF,
  NVDS_PAYLOAD_RESERVED = 0x100,
  NVDS_PAYLOAD_CUSTOM = 0x101,
  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
} NvDsPayloadType;
 
typedef struct NvDsRect {
  float top;     
  float left;    
  float width;   
  float height;  
} NvDsRect;
 
typedef struct NvDsGeoLocation {
  gdouble lat;      
  gdouble lon;      
  gdouble alt;      
} NvDsGeoLocation;
 
typedef struct NvDsCoordinate {
  gdouble x;        
  gdouble y;        
  gdouble z;        
} NvDsCoordinate;
 
typedef struct NvDsObjectSignature {
  gdouble *signature;
  guint size;
} NvDsObjectSignature;
 
typedef struct NvDsProductObjectExt {
  gchar *brand; 
  gchar *type; 
  gchar *shape; 
  GList *mask;
} NvDsProductObjectExt;
 
typedef struct NvDsVehicleObject {
  gchar *type;      
  gchar *make;      
  gchar *model;     
  gchar *color;     
  gchar *region;    
  gchar *license;   
} NvDsVehicleObject;
 
typedef struct NvDsPersonObject {
  gchar *gender;    
  gchar *hair;      
  gchar *cap;       
  gchar *apparel;   
  guint age;        
} NvDsPersonObject;
 
typedef struct NvDsFaceObject {
  gchar *gender;    
  gchar *hair;      
  gchar *cap;       
  gchar *glasses;   
  gchar *facialhair;
  gchar *name;      
  gchar *eyecolor;  
  guint age;        
} NvDsFaceObject;
 
typedef struct NvDsVehicleObjectExt {
  gchar *type;      
  gchar *make;      
  gchar *model;     
  gchar *color;     
  gchar *region;    
  gchar *license;   
  GList *mask;      
} NvDsVehicleObjectExt;
 
typedef struct NvDsPersonObjectExt {
  gchar *gender;    
  gchar *hair;      
  gchar *cap;       
  gchar *apparel;   
  guint age;        
  GList *mask;      
} NvDsPersonObjectExt;
 
typedef struct NvDsFaceObjectWithExt {
  gchar *gender;    
  gchar *hair;      
  gchar *cap;       
  gchar *glasses;   
  gchar *facialhair;
  gchar *name;      
  gchar *eyecolor;  
  guint age;        
  GList *mask;      
} NvDsFaceObjectExt;
 
typedef struct NvDsJoint {
  float x;     
  float y;     
  float z;     
  float confidence;   
} NvDsJoint;
 
typedef struct NvDsJoints {
  NvDsJoint *joints;   
  int num_joints;      
  int pose_type;       
} NvDsJoints;
 
typedef struct NvDsEmbedding {
  float *embedding_vector; 
  guint embedding_length; 
} NvDsEmbedding;
 
typedef struct NvDsProductObject {
  gchar *brand; 
  gchar *type; 
  gchar *shape; 
} NvDsProductObject;
 
typedef struct NvDsConvexHull {
  gint* points;
  guint numFilled;
} NvDsConvexHull;
 
typedef struct _NvDsBbox3dObject {
    float boxes_3d[12];
    float scores_3d;
    gchar *labels_3d;
    gchar *embedding_filter;
    float cls_scores; // confidence
    guint instance_ids;
    NvDsEmbedding *instance_feats;
    gchar *ocr_label;
} NvDsBbox3dObject;
 
#define MAX_SOURCE_ID_LEN 128  // Define a maximum length for source_id
typedef struct {
    gchar source_id[MAX_SOURCE_ID_LEN];
    guint64 timestamp;
} SourceTimePair;
 
#define MAX_NUM_OBJECTS 600  // Define a maximum number of objects
#define MAX_ENTRIES 100      //Define max batchsize for sparse4D
typedef struct _NvDsBbox3dObjectList {
    NvDsBbox3dObject objects[MAX_NUM_OBJECTS];
    guint num_objects;
    guint64 timestamp;
    gint frame_num;
    guint camera_id;
    gchar *sensorStr;
    SourceTimePair entries[MAX_ENTRIES];
    int count;
} NvDsBbox3dObjectList;
 
#define NVDS_INFER_PROV_NAME_LEN   128
#define NVDS_INFER_PROV_ENGINE_LEN 256
 
#define NVDS_INFER_PROV_MAGIC 0x49507276u
 
typedef struct
{
  guint magic;
  guint source_id;
  gchar camera_name[NVDS_INFER_PROV_NAME_LEN];
  gchar camera_id[NVDS_INFER_PROV_NAME_LEN];
  guint gie_id;
  gchar role[16];
  gchar model_name[NVDS_INFER_PROV_NAME_LEN];
  gchar model_version[NVDS_INFER_PROV_NAME_LEN];
  gchar engine[NVDS_INFER_PROV_ENGINE_LEN];
  guint frame_num;
  guint gpu;
  guint batch;
} InferenceProvenanceMeta;
 
 typedef struct NvDs3DTracking {
  gfloat ptWorldFeet[2];
  gfloat ptImgFeet[2];
  NvDsConvexHull convexHull;
  NvDsBbox3dObject bbox3d;
} NvDs3DTracking;
 
 
typedef struct {
    gchar *id;
    gchar *query;
    gchar *response;
} NvDsConversationObject;
 
typedef struct {
    GHashTable *info;
    NvDsConversationObject *conversations;
    guint num_conversations;
    NvDsEmbedding *embeddings;
    guint num_embeddings;
} NvDsLLMObject;
 
typedef struct {
    gchar *id;
    gchar **objectIds;
    guint num_objectIds;
    NvDsCoordinate *coordinates;
    guint num_coordinates;
    gchar *description;
    GHashTable *info;
    gint64 timestamp;  // New field added
} NvDsInteractionObject;
 
typedef struct {
    gchar *id;
    gchar **objectIds;
    guint num_objectIds;
    float amount;
    GHashTable *info;
    gint64 timestamp;  // New field added
} NvDsCongestionObject;
 
typedef struct {
    gchar *id;
    gchar *type;
    gint32 count;
    NvDsCoordinate *coordinates;
    guint num_coordinates;
    gchar **objectIds;
    guint num_objectIds;
    GHashTable *info;
} NvDsTypeMetricsObject;
 
typedef struct {
    gint32 *mask;
    guint mask_size;
    GHashTable *info;
} NvDsSegmentationObject;
 
typedef struct NvDsEventMsgMeta {
  NvDsEventType type;
  NvDsObjectType objType;
  NvDsRect bbox;
  NvDsGeoLocation location;
  NvDsCoordinate coordinate;
  NvDsObjectSignature objSignature;
  gint objClassId;
  gint sensorId;
  gint moduleId;
  gint placeId;
  gint componentId;
  gint frameId;
  gdouble confidence;
  guint64 trackingId;
  gchar *ts;
  gchar *objectId;
  gchar *sensorStr;
  SourceTimePair entries[MAX_ENTRIES];
  int count;
  NvDsBbox3dObject *bbox3d;
  NvDsLLMObject *llm;
  gint num_interactions;
  NvDsInteractionObject *interactions;
  gint num_congestions;
  NvDsCongestionObject *congestions;
  gint num_fov;
  NvDsTypeMetricsObject *fov;
  NvDsSegmentationObject *segmentation;
 
  gchar *otherAttrs;
  gchar *videoPath;
  gpointer extMsg;
  guint extMsgSize;
  NvDsJoints pose;
  NvDsEmbedding embedding;
  bool has3DTracking;
  NvDs3DTracking singleView3DTracking;
  gfloat visibility;
} NvDsEventMsgMeta;
 
typedef struct _NvDsEvent {
  NvDsEventType eventType;
  NvDsEventMsgMeta *metadata;
} NvDsEvent;
 
typedef struct _NvDsCustomMsgInfo {
  void *message;
  guint size;
}NvDsCustomMsgInfo;
 
typedef struct NvDsPayload {
  gpointer payload;
  guint payloadSize;
  guint componentId;
} NvDsPayload;
 
#ifdef __cplusplus
}
#endif
#endif /* NVDSMETA_H_ */