PluginTypes.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
 
#ifndef NVNEURAL_PLUGINTYPES_H
#define NVNEURAL_PLUGINTYPES_H
 
#include <nvneural/CoreTypes.h>
 
namespace nvneural {
 
    class IPlugin : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0x1ac7814b0a47cf4ful;
 
        virtual NeuralResult createObject(IRefObject** ppOut, const char* pObjectClass) const noexcept = 0;
 
        virtual NeuralResult setDefaultLogger(ILogger* pLogger) noexcept = 0;
 
        virtual const char* pluginName() const noexcept = 0;
 
        virtual const char* pluginVersion() const noexcept = 0;
 
        virtual const char* pluginAuthor() const noexcept = 0;
 
        virtual const char* pluginDescription() const noexcept = 0;
    };
 
    class ILayerPlugin : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0xaa0b0fdbb7cf6616ul;
 
        virtual std::size_t getLayerDescCount() const noexcept = 0;
 
        virtual const LayerDesc* getLayerDesc(std::size_t layerIndex) const noexcept = 0;
 
        virtual std::size_t getFusingRuleCount() const noexcept = 0;
 
        virtual const FusingRule* getFusingRule(std::size_t fusingRuleIndex) const noexcept = 0;
    };
 
    class IActivationPlugin : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0xfe4bd876f03c7b1dul;
 
        virtual std::size_t getActivationDescCount() const noexcept = 0;
 
        virtual const ActivationDesc* getActivationDesc(std::size_t activationIndex) const noexcept = 0;
    };
 
    class IPrototypePlugin : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0x55309c8928361be1ul;
 
        virtual std::size_t getPrototypeDescCount() const noexcept = 0;
 
        virtual const PrototypeDesc* getPrototypeDesc(std::size_t prototypeIndex) const noexcept = 0;
 
        virtual PrototypeRuntimeValidatorFunction getPrototypeRuntimeValidator(std::size_t prototypeIndex) const noexcept = 0;
    };
 
    extern "C" using NvNeuralCreatePluginV1_Func = NeuralResult(*)(IPlugin** ppPluginOut) noexcept;
 
    class IPluginLoader : public IRefObject
    {
    public:
        static const IRefObject::TypeId typeID = 0x8c3c1cd6b49fa3eaul;
 
        virtual NeuralResult loadLibrary(const char* pFilename, IPlugin** ppPluginOut) noexcept = 0;
 
        virtual NeuralResult loadDirectory(const char* pPathname, std::uint32_t* pNumberLoadedOut) noexcept = 0;
 
        virtual NeuralResult releasePlugin(IPlugin* pPlugin) noexcept = 0;
 
        virtual NeuralResult releaseAllPlugins() noexcept = 0;
 
        virtual std::size_t pluginCount() const noexcept = 0;
 
        virtual IPlugin* getPluginByIndex(std::size_t pluginIndex) const noexcept = 0;
 
        virtual NeuralResult getPluginPath(const IPlugin* pPlugin, const char** ppPluginPathOut) const noexcept = 0;
 
        virtual void allowIncompatiblePlugins() noexcept = 0;
    };
}
 
#endif // NVNEURAL_PLUGINTYPES_H