sources/gst-plugins/gst-nvdspreprocess/include/nvdspreprocess_interface.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-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 __NVDSPREPROCESS_INTERFACE_H__
#define __NVDSPREPROCESS_INTERFACE_H__
 
#include <cuda.h>
#include <cuda_runtime.h>
#include "nvbufsurface.h"
#include "nvbufsurftransform.h"
#include "gstnvdsmeta.h"
 
#include "nvds_roi_meta.h"
#include "nvtx3/nvToolsExt.h"
#include <unordered_map>
 
typedef struct CustomCtx CustomCtx;
 
typedef enum
{
  NVDSPREPROCESS_SUCCESS = 0,
  NVDSPREPROCESS_CONFIG_FAILED,
  NVDSPREPROCESS_CUSTOM_LIB_FAILED,
  NVDSPREPROCESS_CUSTOM_TRANSFORMATION_FAILED,
  NVDSPREPROCESS_CUSTOM_TENSOR_FAILED,
  NVDSPREPROCESS_INVALID_PARAMS,
  NVDSPREPROCESS_OUTPUT_PARSING_FAILED,
  NVDSPREPROCESS_CUDA_ERROR,
  NVDSPREPROCESS_TENSORRT_ERROR,
  NVDSPREPROCESS_RESOURCE_ERROR,
  NVDSPREPROCESS_TENSOR_NOT_READY,
} NvDsPreProcessStatus;
 
typedef enum
{
  NvDsPreProcessNetworkInputOrder_kNCHW = 0,
  NvDsPreProcessNetworkInputOrder_kNHWC,
  NvDsPreProcessNetworkInputOrder_CUSTOM,
} NvDsPreProcessNetworkInputOrder;
 
typedef enum
{
  NvDsPreProcessFormat_RGB,
  NvDsPreProcessFormat_BGR,
  NvDsPreProcessFormat_GRAY,
  NvDsPreProcessFormat_RGBA,
  NvDsPreProcessFormat_BGRx,
  NvDsPreProcessFormat_Tensor,
  NvDsPreProcessFormat_Unknown = 0xFFFFFFFF,
} NvDsPreProcessFormat;
 
typedef struct
{
  NvBufSurfTransformConfigParams transform_config_params;
  NvBufSurfTransformParams transform_params;
  NvBufSurfTransformSyncObj_t sync_obj = NULL;
} CustomTransformParams;
 
typedef struct
{
  NvDsPreProcessNetworkInputOrder network_input_order;
  std::vector<int> network_input_shape;
  NvDsPreProcessFormat network_color_format;
  guint64 buffer_size = 1;
  NvDsDataType data_type;
  NvBufSurfaceMemType memory_type;
  std::string tensor_name;
} NvDsPreProcessTensorParams;
 
typedef struct
{
  unsigned int width;
  unsigned int height;
  unsigned int channels;
} NvDsPreProcessNetworkSize;
 
typedef struct
{
  std::vector<NvDsRoiMeta> roi_vector;
} CustomSeqProcTensorParams;
 
typedef struct
{
  NvDsPreProcessTensorParams params;
  CustomSeqProcTensorParams seq_params;
} CustomTensorParams;
 
typedef struct
{
  guint unique_id;
  NvDsPreProcessTensorParams tensor_params;
  std::unordered_map <std::string, std::string> user_configs;
  gchar *config_file_path;
} CustomInitParams;
 
struct NvDsPreProcessCustomBuf
{
  void *memory_ptr;
};
 
class NvDsPreProcessAcquirer
{
public:
  virtual NvDsPreProcessCustomBuf *acquire() = 0;
  virtual gboolean release(NvDsPreProcessCustomBuf *) = 0;
};
 
typedef struct
{
  NvDsObjectMeta *obj_meta = nullptr;
  NvDsFrameMeta *frame_meta = nullptr;
  guint batch_index = 0;
  gulong frame_num = 0;
  NvBufSurfaceParams *input_surf_params = nullptr;
  gpointer converted_frame_ptr = nullptr;
  NvDsRoiMeta roi_meta;
 
} NvDsPreProcessUnit;
 
typedef struct
{
  std::vector<NvDsPreProcessUnit> units;
  std::vector<NvBufSurfTransformSyncObj_t> sync_objects;
  GstBuffer *inbuf = nullptr;
  gulong inbuf_batch_num = 0;
  gboolean push_buffer = FALSE;
  gboolean event_marker = FALSE;
  GstBuffer *converted_buf = nullptr;
  NvDsPreProcessFormat scaling_pool_format;
  NvDsBatchMeta *batch_meta;
  uint32_t pitch;
  nvtxRangeId_t nvtx_complete_buf_range = 0;
} NvDsPreProcessBatch;
 
#endif //__NVDSPREPROCESS_INTERFACE_H__