SignNet.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2018-2019 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_SIGNNET_H_
#define DW_SIGNNET_H_

#include <dw/core/Context.h>
#include <dw/core/Exports.h>
#include <dw/dnn/DNN.h>
#include <dw/world/TrafficSigns.h>

#ifdef __cplusplus
extern "C" {
#endif

#define DW_SIGNNET_MAX_CLASSES 796
#define DW_SIGNNET_MAX_DNN_OUTPUT 1000
#define DW_SIGNNET_MAX_MODELS 64


typedef struct dwSignNetObject* dwSignNetHandle_t;

typedef enum {
    DW_SIGNNET_MODEL_US_V2 = 0,
    DW_SIGNNET_MODEL_US_V4 = 1,
    DW_SIGNNET_MODEL_EU_V3 = 2,
    DW_SIGNNET_MODEL_EU_V4 = 3,
    DW_SIGNNET_MODEL_JP_V1 = 4,
    DW_SIGNNET_MODEL_COUNT,
    DW_SIGNNET_MODEL_US_CURRENT = DW_SIGNNET_MODEL_US_V4,
    DW_SIGNNET_MODEL_EU_CURRENT = DW_SIGNNET_MODEL_EU_V4,
    DW_SIGNNET_MODEL_JP_CURRENT = DW_SIGNNET_MODEL_JP_V1,
    DW_SIGNNET_MODEL_CUSTOM = -1
} dwSignNetModel;

typedef enum dwSignNetBatchSize {
    DW_SIGNNET_BATCH_SIZE_1  = 0, 
    DW_SIGNNET_BATCH_SIZE_16 = 1, 
    DW_SIGNNET_BATCH_SIZE_32 = 2  
} dwSignNetBatchSize;

typedef struct
{
    dwSignNetModel networkModel;
    dwPrecision networkPrecision;
    dwSignNetBatchSize batchSize;
    const void* networkCustomData;
} dwSignNetParams;

typedef const char* dwSignNetModelName;

typedef const char* dwSignNetClassName;

DW_API_PUBLIC
dwStatus dwSignNet_initDefaultParams(dwSignNetParams* params, dwContextHandle_t ctx);

DW_API_PUBLIC
dwStatus dwSignNet_initialize(dwSignNetHandle_t* signNetHandle,
                              const dwSignNetParams* signNetParams,
                              dwContextHandle_t ctx);

DW_API_PUBLIC
dwStatus dwSignNet_reset(dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_release(dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getInputBlobsize(dwBlobSize* inputBlobsize, dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getClassLabel(const char** classLabel, uint32_t classIdx, dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getTrafficSignalClass(dwTrafficSignalClass* trafficSignalClass, uint32_t classIdx, dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getTypeLabel(const char** classLabel, uint32_t classIdx, dwSignNetHandle_t obj)
    DW_DEPRECATED("WARNING: dwSignNet_getTypeLabel is deprecated and will be removed the future releases.");

DW_API_PUBLIC
dwStatus dwSignNet_getModelNameLabel(const char** modelNameLabel, dwSignNetHandle_t obj);

DW_API_PUBLIC
DW_DEPRECATED("WARNING: dwSignNet_getAvailableClasses() with the current signature is deprecated. "
              "Use dwSignNet_getAvailableClasses_new() in this release. In future releases use "
              "dwSignNet_getAvailableClasses() with new signature.")
dwStatus dwSignNet_getAvailableClasses(const dwSignClass** signClasses,
                                       uint32_t* numSignClasses,
                                       dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getAvailableClassesNew(dwSignNetClassName* signClasses,
                                          uint32_t* numSignClasses,
                                          dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getNumberOutputs(uint32_t* numSignOutputs,
                                    dwSignNetHandle_t obj);

DW_API_PUBLIC
dwStatus dwSignNet_getAvailableModels(dwSignNetModelName* availableModels,
                                      uint32_t* numAvailableModels);

DW_API_PUBLIC
dwStatus dwSignNet_getDNNMetaData(dwDNNMetaData* metaData, dwSignNetHandle_t obj);

#ifdef __cplusplus
}
#endif

#endif // DW_SIGNNET_H_