sources/gst-plugins/gst-nvinfer/gstnvinfer.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2018-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef __GST_NVINFER_H__
#define __GST_NVINFER_H__
 
#include <gst/base/gstbasetransform.h>
#include <gst/video/video.h>
 
#include <set>
#include <unordered_map>
#include <vector>
#include <memory>
 
#include "cuda_runtime_api.h"
#include "nvbufsurftransform.h"
#include <nvdsinfer_context.h>
 
#include "gstnvdsinfer.h"
 
#include "gstnvdsmeta.h"
 
#include "nvtx3/nvToolsExt.h"
 
/* Package and library details required for plugin_init */
#define PACKAGE "nvinfer"
#define VERSION "1.0"
#define LICENSE "Proprietary"
#define DESCRIPTION "NVIDIA DeepStreamSDK TensorRT plugin"
#define BINARY_PACKAGE "NVIDIA DeepStreamSDK TensorRT plugin"
#define URL "http://nvidia.com/"
 
 
G_BEGIN_DECLS
/* Standard GStreamer boilerplate */
typedef struct _GstNvInfer GstNvInfer;
typedef struct _GstNvInferClass GstNvInferClass;
typedef struct _GstNvInferImpl GstNvInferImpl;
 
/* Standard GStreamer boilerplate */
#define GST_TYPE_NVINFER (gst_nvinfer_get_type())
#define GST_NVINFER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_NVINFER,GstNvInfer))
#define GST_NVINFER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_NVINFER,GstNvInferClass))
#define GST_NVINFER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GST_TYPE_NVINFER, GstNvInferClass))
#define GST_IS_NVINFER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_NVINFER))
#define GST_IS_NVINFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_NVINFER))
#define GST_NVINFER_CAST(obj)  ((GstNvInfer *)(obj))
 
enum
{
  PROP_0,
  PROP_UNIQUE_ID,
  PROP_PROCESS_MODE,
  PROP_CONFIG_FILE_PATH,
  PROP_OPERATE_ON_GIE_ID,
  PROP_OPERATE_ON_CLASS_IDS,
  PROP_FILTER_OUT_CLASS_IDS,
  PROP_MODEL_ENGINEFILE,
  PROP_BATCH_SIZE,
  PROP_INTERVAL,
  PROP_GPU_DEVICE_ID,
  PROP_OUTPUT_WRITE_TO_FILE,
  PROP_OUTPUT_CALLBACK,
  PROP_OUTPUT_CALLBACK_USERDATA,
  PROP_OUTPUT_TENSOR_META,
  PROP_OUTPUT_INSTANCE_MASK,
  PROP_INPUT_TENSOR_META,
  PROP_CLIP_OBJECT_OUTSIDE_ROI,
  PROP_CROP_OBJECTS_TO_ROI_BOUNDARY,
  PROP_STRONGLY_TYPED,
  PROP_DYNAMIC_PROPERTIES,
  PROP_LAST
};
 
/* nvinfer signals */
enum {
  /* Signal emitted to notify app about model update completion with
   * success/error messages. */
  SIGNAL_MODEL_UPDATED,
  LAST_SIGNAL,
};
 
extern guint gst_nvinfer_signals[LAST_SIGNAL];
 
typedef struct
{
  guint roiTopOffset;
  guint roiBottomOffset;
  guint detectionMinWidth;
  guint detectionMinHeight;
  guint detectionMaxWidth;
  guint detectionMaxHeight;
} GstNvInferDetectionFilterParams;
 
typedef struct
{
  gboolean have_border_color;
  NvOSD_ColorParams border_color;
 
  gboolean have_bg_color;
  NvOSD_ColorParams bg_color;
} GstNvInferColorParams;
 
struct GstNvInferObjectInfo {
  std::vector<NvDsInferAttribute> attributes;
  std::string label;
 
  GstNvInferObjectInfo(const GstNvInferObjectInfo&) = delete;
  GstNvInferObjectInfo() = default;
  ~GstNvInferObjectInfo(){
    for (auto &attr : attributes) {
      if (attr.attributeLabel)
        free (attr.attributeLabel);
    }
  }
};
 
typedef struct _GstNvInferObjectHistory
{
  gboolean under_inference;
  NvOSD_RectParams last_inferred_coords;
  gulong last_inferred_frame_num;
  gulong last_accessed_frame_num;
  GstNvInferObjectInfo cached_info;
} GstNvInferObjectHistory;
 
typedef std::unordered_map<guint64, std::shared_ptr<GstNvInferObjectHistory>> GstNvInferObjectHistoryMap;
 
typedef struct
{
  GstNvInferObjectHistoryMap object_history_map;
  gulong last_cleanup_frame_num;
  gulong last_seen_frame_num;
} GstNvInferSourceInfo;
 
struct _GstNvInfer
{
  GstBaseTransform base_trans;
 
  gboolean config_file_parse_successful;
 
  guint max_batch_size;
 
  guint unique_id;
 
  GstBufferPool *pool;
 
  GQueue *process_queue;
  GMutex process_lock;
  GCond process_cond;
  GQueue *input_queue;
 
  GThread *output_thread;
  GThread *input_queue_thread;
 
  gboolean stop;
 
  gint network_width;
  gint network_height;
 
  gboolean process_full_frame;
 
  gchar *config_file_path;
 
  GstFlowReturn last_flow_ret;
 
  guint gpu_id;
 
  cudaStream_t convertStream;
 
  gboolean input_tensor_from_meta;
 
  gboolean clip_object_outside_roi;
 
  gboolean maintain_aspect_ratio;
 
  gboolean symmetric_padding;
 
  std::vector<GstNvInferDetectionFilterParams> *perClassDetectionFilterParams;
 
  std::vector<GstNvInferColorParams> *perClassColorParams;
 
  guint interval;
  guint interval_counter;
 
  guint secondary_reinfer_interval;
 
  guint min_input_object_width;
  guint min_input_object_height;
  guint max_input_object_width;
  guint max_input_object_height;
 
  gint operate_on_gie_id;
  std::vector<gboolean> *operate_on_class_ids;
  std::set<uint> *filter_out_class_ids;
 
  std::unordered_map<gint, GstNvInferSourceInfo> *source_info;
  gulong last_map_cleanup_frame_num;
 
  gulong current_batch_num;
 
  gboolean classifier_async_mode;
 
  gchar *classifier_type;
 
  NvDsInferNetworkInfo network_info;
 
  std::vector<NvDsInferLayerInfo> *layers_info;
 
  std::vector<NvDsInferLayerInfo> *output_layers_info;
 
  gboolean write_raw_buffers_to_file;
 
  guint64 file_write_batch_num;
 
  gst_nvinfer_raw_output_generated_callback output_generated_callback;
  gpointer output_generated_userdata;
 
  std::vector<gboolean> *is_prop_set;
 
  NvBufSurfTransformConfigParams transform_config_params;
 
  NvBufSurfTransformParams transform_params;
 
  NvBufSurface tmp_surf;
 
  gboolean output_tensor_meta;
 
  gboolean output_instance_mask;
 
  GstClockTime untracked_object_warn_pts;
 
  nvtxDomainHandle_t nvtx_domain;
  
  /*Clip the object bounding-box which lies outside the roi boundary. */
  gboolean crop_objects_to_roi_boundary;
 
  gchar *dynamic_properties_string;
 
  guint stabilize_buffer_count;
 
  GstNvInferImpl *impl;
};
 
/* GStreamer boilerplate. */
struct _GstNvInferClass {
  GstBaseTransformClass parent_class;
 
  void (*model_updated) (GstNvInfer *, gint err, const gchar *cfg_file);
};
 
GType gst_nvinfer_get_type (void);
 
G_END_DECLS
 
#endif /* __GST_INFER_H__ */