nvdsinfer_context.h

Go to the documentation of this file.

#ifndef __NVDSINFER_CONTEXT_H__
#define __NVDSINFER_CONTEXT_H__

#include "nvdsinfer.h"

#define _PATH_MAX 4096

#define _MAX_CHANNELS 4

#define _MAX_STR_LENGTH 1024

#define NVDSINFER_MAX_BATCH_SIZE 1024

#define NVDSINFER_MIN_OUTPUT_BUFFERPOOL_SIZE 2

typedef enum
{
    NvDsInferNetworkMode_FP32,
    NvDsInferNetworkMode_INT8,
    NvDsInferNetworkMode_FP16
} NvDsInferNetworkMode;

typedef enum
{
    NvDsInferNetworkType_Detector,
    NvDsInferNetworkType_Classifier,
    NvDsInferNetworkType_Segmentation,
    NvDsInferNetworkType_InstanceSegmentation,
    NvDsInferNetworkType_Other = 100
} NvDsInferNetworkType;

typedef enum
{
    NvDsInferFormat_RGB,
    NvDsInferFormat_BGR,
    NvDsInferFormat_GRAY,
    NvDsInferFormat_RGBA,
    NvDsInferFormat_BGRx,
    NvDsInferFormat_Tensor,
    NvDsInferFormat_Unknown = 0xFFFFFFFF,
} NvDsInferFormat;

typedef enum {
    NvDsInferTensorOrder_kNCHW,
    NvDsInferTensorOrder_kNHWC,
    NvDsInferTensorOrder_kNC,
    NvDsInferUffOrder_kNCHW _DS_DEPRECATED_("Use NvDsInferTensorOrder_kNCHW instead") = NvDsInferTensorOrder_kNCHW,
    NvDsInferUffOrder_kNHWC _DS_DEPRECATED_("Use NvDsInferTensorOrder_kNCWH instead") = NvDsInferTensorOrder_kNHWC,
    NvDsInferUffOrder_kNC _DS_DEPRECATED_("Use NvDsInferTensorOrder_kNC instead") = NvDsInferTensorOrder_kNC
} NvDsInferTensorOrder;

#define NvDsInferUffOrder _Pragma \
    ("GCC warning \"'NvDsInferUffOrder' macro is deprecated. Use NvDsInferTensorOrder instead.\"") \
    NvDsInferTensorOrder

typedef struct
{
    union {
    float threshold _DS_DEPRECATED_("Use preclusterThreshold instead.");
    float preClusterThreshold;
    };

    float postClusterThreshold;

    float eps;
    int minBoxes;
    int groupThreshold;
    float minScore;
    float nmsIOUThreshold;
    int topK;
} NvDsInferDetectionParams;

typedef enum
{
    NVDSINFER_CLUSTER_GROUP_RECTANGLES = 0,
    NVDSINFER_CLUSTER_DBSCAN,
    NVDSINFER_CLUSTER_NMS,
    NVDSINFER_CLUSTER_DBSCAN_NMS_HYBRID,
    NVDSINFER_CLUSTER_NONE
} NvDsInferClusterMode;
typedef struct _NvDsInferContextInitParams
{
    unsigned int uniqueID;

    NvDsInferNetworkMode networkMode;

    char protoFilePath[_PATH_MAX];
    char modelFilePath[_PATH_MAX];
    char uffFilePath[_PATH_MAX];
    char onnxFilePath[_PATH_MAX];
    char tltEncodedModelFilePath[_PATH_MAX];

    char int8CalibrationFilePath[_PATH_MAX];

    union {
      NvDsInferDimsCHW inputDims;
      NvDsInferDimsCHW uffDimsCHW;
    } _DS_DEPRECATED_("Use inferInputDims instead.");

    NvDsInferTensorOrder uffInputOrder;
    char uffInputBlobName[_MAX_STR_LENGTH];

    NvDsInferTensorOrder netInputOrder;

    char tltModelKey[_MAX_STR_LENGTH];

    char modelEngineFilePath[_PATH_MAX];

    unsigned int maxBatchSize;

    char labelsFilePath[_PATH_MAX];

    char meanImageFilePath[_PATH_MAX];

    float networkScaleFactor;

    NvDsInferFormat networkInputFormat;

    float offsets[_MAX_CHANNELS];
    unsigned int numOffsets;

    NvDsInferNetworkType networkType;

    _DS_DEPRECATED_("Use NvDsInferClusterMode instead")
    int useDBScan;

    unsigned int numDetectedClasses;

    NvDsInferDetectionParams *perClassDetectionParams;

    float classifierThreshold;

    float segmentationThreshold;

    char ** outputLayerNames;
    unsigned int numOutputLayers;


    char customLibPath[_PATH_MAX];
    char customBBoxParseFuncName[_MAX_STR_LENGTH];
    char customClassifierParseFuncName[_MAX_STR_LENGTH];

    int copyInputToHostBuffers;

    unsigned int gpuID;

    int useDLA;
    int dlaCore;

    unsigned int outputBufferPoolSize;

    char customNetworkConfigFilePath[_PATH_MAX];

    char customEngineCreateFuncName[_MAX_STR_LENGTH];

    int forceImplicitBatchDimension;

    unsigned int workspaceSize;

    NvDsInferDimsCHW inferInputDims;

    NvDsInferClusterMode clusterMode;

    char customBBoxInstanceMaskParseFuncName[_MAX_STR_LENGTH];

    char ** outputIOFormats;
    unsigned int numOutputIOFormats;

    char ** layerDevicePrecisions;
    unsigned int numLayerDevicePrecisions;

    NvDsInferTensorOrder segmentationOutputOrder;

    int inputFromPreprocessedTensor;
} NvDsInferContextInitParams;

typedef void (* NvDsInferContextReturnInputAsyncFunc) (void *data);

typedef struct
{
    void** inputFrames;
    unsigned int numInputFrames;
    NvDsInferFormat inputFormat;
    unsigned int inputPitch;
    NvDsInferContextReturnInputAsyncFunc returnInputFunc;
    void *returnFuncData;
} NvDsInferContextBatchInput;

typedef struct
{
    NvDsInferLayerInfo *tensors;
    unsigned int numInputTensors;
    NvDsInferContextReturnInputAsyncFunc returnInputFunc;
    void *returnFuncData;
} NvDsInferContextBatchPreprocessedInput;

typedef struct
{
    float left;
    float top;
    float width;
    float height;
    int classIndex;
    char *label;
    /* confidence score of the detected object. */
    float confidence;
    /* Instance mask information for the object. */
    float *mask;
    unsigned int mask_width;
    unsigned int mask_height;
    unsigned int mask_size;
} NvDsInferObject;

typedef struct
{
    NvDsInferObject *objects;
    unsigned int numObjects;
} NvDsInferDetectionOutput;

typedef struct
{
    NvDsInferAttribute *attributes;
    unsigned int numAttributes;
    char *label;
} NvDsInferClassificationOutput;

typedef struct
{
    unsigned int width;
    unsigned int height;
    unsigned int classes;
    int *class_map;
    float *class_probability_map;
} NvDsInferSegmentationOutput;

typedef struct
{
    NvDsInferNetworkType outputType;
    union
    {
        NvDsInferDetectionOutput detectionOutput;
        NvDsInferClassificationOutput classificationOutput;
        NvDsInferSegmentationOutput segmentationOutput;
    };
} NvDsInferFrameOutput;

typedef struct
{
    NvDsInferFrameOutput *frames;
    unsigned int numFrames;

    void **outputDeviceBuffers;
    unsigned int numOutputDeviceBuffers;

    void **hostBuffers;
    unsigned int numHostBuffers;

    void* priv;
} NvDsInferContextBatchOutput;

typedef struct INvDsInferContext * NvDsInferContextHandle;

typedef void (*NvDsInferContextLoggingFunc)(NvDsInferContextHandle handle,
    unsigned int uniqueID, NvDsInferLogLevel logLevel, const char* logMessage,
    void* userCtx);

#ifdef __cplusplus
extern "C" {
#endif

void NvDsInferContext_ResetInitParams (NvDsInferContextInitParams *initParams);

_DS_DEPRECATED_("NvDsInferContext_GetStatusName is deprecated. Use NvDsInferStatus2Str instead")
const char * NvDsInferContext_GetStatusName (NvDsInferStatus status);


#ifdef __cplusplus
}
#endif

#ifdef __cplusplus

#include <string>
#include <vector>

struct INvDsInferContext
{
public:
    virtual NvDsInferStatus queueInputBatch(NvDsInferContextBatchInput &batchInput) = 0;

    virtual NvDsInferStatus dequeueOutputBatch(NvDsInferContextBatchOutput &batchOutput) = 0;

    virtual void releaseBatchOutput(NvDsInferContextBatchOutput &batchOutput) = 0;

    virtual void fillLayersInfo(std::vector<NvDsInferLayerInfo> &layersInfo) = 0;

    virtual void getNetworkInfo(NvDsInferNetworkInfo &networkInfo) = 0;

    virtual const std::vector< std::vector<std::string> >& getLabels() = 0;

    virtual void destroy() = 0;

    virtual ~INvDsInferContext() {}

    virtual NvDsInferStatus queueInputBatchPreprocessed(NvDsInferContextBatchPreprocessedInput &batchInput) = 0;
};

NvDsInferStatus createNvDsInferContext(NvDsInferContextHandle *handle,
        NvDsInferContextInitParams &initParams,
        void *userCtx = nullptr,
        NvDsInferContextLoggingFunc logFunc = nullptr);

#endif

#ifdef __cplusplus
extern "C" {
#endif


NvDsInferStatus NvDsInferContext_Create(NvDsInferContextHandle *handle,
        NvDsInferContextInitParams *initParams, void *userCtx,
        NvDsInferContextLoggingFunc logFunc);

void NvDsInferContext_Destroy (NvDsInferContextHandle handle);

NvDsInferStatus NvDsInferContext_QueueInputBatch(NvDsInferContextHandle handle,
        NvDsInferContextBatchInput *batchInput);

NvDsInferStatus NvDsInferContext_DequeueOutputBatch(NvDsInferContextHandle handle,
        NvDsInferContextBatchOutput *batchOutput);

void NvDsInferContext_ReleaseBatchOutput(NvDsInferContextHandle handle,
        NvDsInferContextBatchOutput *batchOutput);

void NvDsInferContext_GetNetworkInfo(NvDsInferContextHandle handle,
        NvDsInferNetworkInfo *networkInfo);

unsigned int NvDsInferContext_GetNumLayersInfo(NvDsInferContextHandle handle);

void NvDsInferContext_FillLayersInfo(NvDsInferContextHandle handle,
        NvDsInferLayerInfo *layersInfo);

const char* NvDsInferContext_GetLabel(NvDsInferContextHandle handle,
        unsigned int id, unsigned int value);

#ifdef __cplusplus
}
#endif

#endif