NvUffParser.h

Go to the documentation of this file.

/*
 * Copyright 1993-2020 NVIDIA Corporation.  All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */
 
#ifndef NV_UFF_PARSER_H
#define NV_UFF_PARSER_H
 
#include "NvInfer.h"
 
 
// Current supported Universal Framework Format (UFF) version for the parser.
#define UFF_REQUIRED_VERSION_MAJOR 0
#define UFF_REQUIRED_VERSION_MINOR 6
#define UFF_REQUIRED_VERSION_PATCH 9
 
namespace nvuffparser
{
 
enum class UffInputOrder : int32_t
{
    kNCHW = 0, 
    kNHWC = 1, 
    kNC = 2    
};
 
 
enum class FieldType : int32_t
{
    kFLOAT = 0,    
    kINT32 = 1,    
    kCHAR = 2,     
    kDIMS = 4,     
    kDATATYPE = 5, 
    kUNKNOWN = 6
};
 
class TENSORRTAPI FieldMap
{
public:
    const char* name;
    const void* data;
    FieldType type = FieldType::kUNKNOWN;
    int32_t length = 1;
 
    FieldMap(const char* name, const void* data, const FieldType type, int32_t length = 1) TRTNOEXCEPT;
};
 
struct FieldCollection
{
    int32_t nbFields;
    const FieldMap* fields;
};
 
class IPluginFactory
{
public:
    virtual bool isPlugin(const char* layerName) TRTNOEXCEPT = 0;
 
    virtual nvinfer1::IPlugin* createPlugin(const char* layerName, const nvinfer1::Weights* weights, int32_t nbWeights,
        const FieldCollection fc) TRTNOEXCEPT = 0;
 
    virtual ~IPluginFactory() {}
};
 
class IPluginFactoryExt : public IPluginFactory
{
public:
    virtual int32_t getVersion() const TRTNOEXCEPT
    {
        return NV_TENSORRT_VERSION;
    }
 
    virtual bool isPluginExt(const char* layerName) TRTNOEXCEPT = 0;
};
 
class IUffParser
{
public:
    virtual bool registerInput(const char* inputName, nvinfer1::Dims inputDims, UffInputOrder inputOrder) TRTNOEXCEPT = 0;
 
    virtual bool registerOutput(const char* outputName) TRTNOEXCEPT = 0;
 
    virtual bool parse(const char* file,
                       nvinfer1::INetworkDefinition& network,
                       nvinfer1::DataType weightsType=nvinfer1::DataType::kFLOAT) TRTNOEXCEPT = 0;
 
    virtual bool parseBuffer(const char* buffer, std::size_t size,
                             nvinfer1::INetworkDefinition& network,
                             nvinfer1::DataType weightsType=nvinfer1::DataType::kFLOAT) TRTNOEXCEPT = 0;
 
    virtual void destroy() TRTNOEXCEPT = 0;
 
    virtual int32_t getUffRequiredVersionMajor() TRTNOEXCEPT = 0;
 
    virtual int32_t getUffRequiredVersionMinor() TRTNOEXCEPT = 0;
 
    virtual int32_t getUffRequiredVersionPatch() TRTNOEXCEPT = 0;
 
    virtual void setPluginFactory(IPluginFactory* factory) TRTNOEXCEPT = 0;
 
    virtual void setPluginFactoryExt(IPluginFactoryExt* factory) TRTNOEXCEPT = 0;
 
    virtual void setPluginNamespace(const char* libNamespace) TRTNOEXCEPT = 0;
 
protected:
    virtual ~IUffParser() {}
 
public:
    //
    virtual void setErrorRecorder(nvinfer1::IErrorRecorder* recorder) TRTNOEXCEPT = 0;
 
    virtual nvinfer1::IErrorRecorder* getErrorRecorder() const TRTNOEXCEPT = 0;
};
 
TENSORRTAPI IUffParser* createUffParser() TRTNOEXCEPT;
 
TENSORRTAPI void shutdownProtobufLibrary(void) TRTNOEXCEPT;
 
} // namespace nvuffparser
 
 
extern "C" TENSORRTAPI void* createNvUffParser_INTERNAL() TRTNOEXCEPT;
 
#endif /* !NV_UFF_PARSER_H */