sources/gst-plugins/gst-nvdsvisionencoder-c/gstnvdsvisionencoder.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 */
 
#ifndef __GST_NVDSVISIONENCODER_H__
#define __GST_NVDSVISIONENCODER_H__
 
#include <gst/gst.h>
#include <gst/base/gstbasetransform.h>
#include <gst/video/video.h>
 
#include "nvbufsurface.h"
#include "nvbufsurftransform.h"
#include "nvdsmeta.h"
#include "gstnvdsmeta.h"
#include "nvds_tracker_meta.h"
 
#ifdef ENABLE_INSTRUMENTATION
#include <sys/time.h>
#endif
 
G_BEGIN_DECLS
 
#define GST_TYPE_NVDSVISIONENCODER (gst_nvdsvisionencoder_get_type())
#define GST_NVDSVISIONENCODER(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_NVDSVISIONENCODER,GstNvDsVisionEncoder))
#define GST_NVDSVISIONENCODER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_NVDSVISIONENCODER,GstNvDsVisionEncoderClass))
#define GST_IS_NVDSVISIONENCODER(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_NVDSVISIONENCODER))
#define GST_IS_NVDSVISIONENCODER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_NVDSVISIONENCODER))
 
typedef struct _GstNvDsVisionEncoder GstNvDsVisionEncoder;
typedef struct _GstNvDsVisionEncoderClass GstNvDsVisionEncoderClass;
 
typedef enum {
  NVDS_VISION_ENCODER_BACKEND_TRITON = 0,
  NVDS_VISION_ENCODER_BACKEND_TENSORRT = 1,
} NvDsVisionEncoderBackend;
 
struct _GstNvDsVisionEncoder {
  GstBaseTransform base_trans;
  
  /* Configuration properties */
  gboolean enable;
  NvDsVisionEncoderBackend backend;
  gchar *backend_str;  // String version for property
  gchar *triton_url;
  gchar *triton_model;
  gchar *model_variant;  // For compatibility with Python plugin config
  gchar *tensorrt_engine;
  gchar *onnx_model;     // Path to ONNX model for engine building
  guint batch_size;      // TensorRT batch size (for engine building/selection)
  guint min_crop_size;
  gboolean verbose;
  guint gpu_id;
  gchar *device;  // For compatibility (cuda/cpu)
  guint skip_interval;  // Frame skip interval: 0=none, 1=every other, 2=every 3rd, etc.
  gchar *embedding_classes;  // Semicolon-separated list of classes to generate embeddings for (NULL = all classes)
  
  /* Runtime state */
  guint frame_count;
  gchar **allowed_classes;  // Parsed array of allowed class names
  guint num_allowed_classes;  // Number of allowed classes
  gboolean is_initialized;
  
  /* Triton client handle (C++ object wrapped as void*) */
  void *triton_client;
  
  /* CUDA stream for async operations */
  void *cuda_stream;  // cudaStream_t
  
  /* Model info */
  guint input_width;
  guint input_height;
  guint embedding_dim;
  
  /* Pre-allocated buffers for preprocessing (like nvinfer SGIE) */
  guint max_batch_size;  // Maximum number of objects per transform call
  NvBufSurfaceParams *prealloc_surf_list;  // Pre-allocated surface list for src_batch
  NvBufSurfTransformRect *prealloc_src_rect;  // Pre-allocated source rectangles
  NvBufSurfTransformRect *prealloc_dst_rect;  // Pre-allocated destination rectangles
  NvBufSurface *prealloc_output_surface;  // Pre-allocated output surface (reused across calls)
  float *d_preprocessed_pool;  // Pre-allocated device tensor (max_batch_size) for GPU path
  size_t d_preprocessed_pool_bytes;  // Allocated size in bytes
  float *embeddings_buffer;    // Pre-allocated host buffer for inference output (max_batch_size * embedding_dim)
  
#ifdef ENABLE_INSTRUMENTATION
  /* Performance counters */
  GstClockTime total_process_time;
  guint total_objects_processed;
 
  /* Periodic performance reporting (every PERF_WINDOW_SEC seconds) */
  struct timeval perf_window_start;
  guint perf_window_objects;
  guint perf_window_batches;
  gboolean perf_window_started;
 
  /* Per-phase cumulative microseconds within current window */
  guint64 perf_phase_preproc_us;   /* NvBufSurfTransform crop+resize */
  guint64 perf_phase_tensor_us;    /* RGB surface -> CHW float tensor */
  guint64 perf_phase_infer_us;     /* TRT inference + D2H memcpy */
  guint64 perf_phase_post_us;      /* Attach embedding metadata */
#endif
};
 
struct _GstNvDsVisionEncoderClass {
  GstBaseTransformClass parent_class;
};
 
GType gst_nvdsvisionencoder_get_type (void);
 
G_END_DECLS
 
#endif /* __GST_NVDSVISIONENCODER_H__ */