NvInferPlugin.h

Go to the documentation of this file.

/*
 * Copyright 1993-2018 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_INFER_PLUGIN_H
#define NV_INFER_PLUGIN_H

#include "NvInfer.h"


namespace nvinfer1
{
    enum class PluginType : int
    {
        kFASTERRCNN = 0,         
        kNORMALIZE = 1,          
        kPERMUTE = 2,            
        kPRIORBOX = 3,           
        kSSDDETECTIONOUTPUT = 4, 
        kCONCAT = 5,             
        kPRELU = 6,              
        kYOLOREORG = 7,          
        kYOLOREGION = 8,         
        kANCHORGENERATOR = 9,    
    };

    template <>
    inline int EnumMax<PluginType>() { return 10; }

namespace plugin
{
    class INvPlugin : public IPlugin
    {
        public:
            virtual PluginType getPluginType() const = 0;

            virtual const char *getName() const = 0;

            virtual void destroy() = 0;
        protected:
            ~INvPlugin() {}
    };  // INvPlugin

    TENSORRTAPI INvPlugin * createFasterRCNNPlugin(int featureStride, int preNmsTop,
                                                    int nmsMaxOut, float iouThreshold, float minBoxSize,
                                                    float spatialScale, DimsHW pooling,
                                                    Weights anchorRatios, Weights anchorScales);
    TENSORRTAPI INvPlugin * createFasterRCNNPlugin(const void * data, size_t length);


    TENSORRTAPI INvPlugin * createSSDNormalizePlugin(const Weights *scales, bool acrossSpatial, bool channelShared, float eps);
    TENSORRTAPI INvPlugin * createSSDNormalizePlugin(const void * data, size_t length);

    typedef struct
    {
        int data[4];
    } Quadruple;

    TENSORRTAPI INvPlugin * createSSDPermutePlugin(Quadruple permuteOrder);
    TENSORRTAPI INvPlugin * createSSDPermutePlugin(const void * data, size_t length);

    struct PriorBoxParameters
    {
        float *minSize, *maxSize, *aspectRatios;
        int numMinSize, numMaxSize, numAspectRatios;
        bool flip;
        bool clip;
        float variance[4];
        int imgH, imgW;
        float stepH, stepW;
        float offset;
    };

    struct GridAnchorParameters
    {
        float minSize, maxSize;
        float *aspectRatios;
        int numAspectRatios, H, W;
        float variance[4];
    };

    TENSORRTAPI INvPlugin * createSSDPriorBoxPlugin(PriorBoxParameters param);
    TENSORRTAPI INvPlugin * createSSDPriorBoxPlugin(const void * data, size_t length);

    TENSORRTAPI INvPlugin * createSSDAnchorGeneratorPlugin(GridAnchorParameters* param, int numLayers);
    TENSORRTAPI INvPlugin * createSSDAnchorGeneratorPlugin(const void * data, size_t length);

    enum class CodeTypeSSD : int
    {
        CORNER      = 0, 
        CENTER_SIZE = 1, 
        CORNER_SIZE = 2, 
        TF_CENTER   = 3  
    };

    struct DetectionOutputParameters
    {
        bool shareLocation, varianceEncodedInTarget;
        int backgroundLabelId, numClasses, topK, keepTopK;
        float confidenceThreshold, nmsThreshold;
        CodeTypeSSD codeType;
        int inputOrder[3];
        bool confSigmoid;
        bool isNormalized;
    };

    TENSORRTAPI INvPlugin * createSSDDetectionOutputPlugin(DetectionOutputParameters param);
    TENSORRTAPI INvPlugin * createSSDDetectionOutputPlugin(const void * data, size_t length);

    TENSORRTAPI INvPlugin * createConcatPlugin(int concatAxis, bool ignoreBatch);
    TENSORRTAPI INvPlugin * createConcatPlugin(const void * data, size_t length);

    TENSORRTAPI INvPlugin * createPReLUPlugin(float negSlope);
    TENSORRTAPI INvPlugin * createPReLUPlugin(const void * data, size_t length);

    TENSORRTAPI INvPlugin * createYOLOReorgPlugin(int stride);
    TENSORRTAPI INvPlugin * createYOLOReorgPlugin(const void * data, size_t length);

    typedef struct{
        int *leaf;
        int n;
        int *parent;
        int *child;
        int *group;
        char **name;

        int groups;
        int *groupSize;
        int *groupOffset;
    } softmaxTree; // softmax tree

    struct RegionParameters
    {
        int num;
        int coords;
        int classes;
        softmaxTree * smTree;
    };

    TENSORRTAPI INvPlugin * createYOLORegionPlugin(RegionParameters params);
    TENSORRTAPI INvPlugin * createYOLORegionPlugin(const void * data, size_t length);

} // end plugin namespace
} // end nvinfer1 namespace
#endif // NV_INFER_PLUGIN_H