MMindInferEngine.h

Go to the documentation of this file.

/*******************************************************************************
 *BSD 3-Clause License
 *
 *Copyright (c) 2016-2023, Mech-Mind Robotics
 *All rights reserved.
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1. Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 *2. Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 *3. Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 *THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 *FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/
 
#pragma once
#include <vector>
#include <string>
#include <memory>
#include "common/Export.h"
#include "common/StatusCode.h"
#include "MMindImage.h"
#include "MMIndResult.h"
#include "common.h"
 
namespace mmind::dl {
 
class MMIND_DL_SDK_EXPORT MMindInferEngine
{
public:
    MMindInferEngine();
 
    StatusCode setBatchSize(const unsigned int batchSize, const unsigned int moduleIdx = 0);
 
    StatusCode setBatchSize(const std::vector<unsigned int>& batchSize);
 
    StatusCode setFloatPrecision(const FloatPrecisionType floatPrecisionType,
                                 const unsigned int moduleIdx = 0);
 
    StatusCode setFloatPrecision(const std::vector<FloatPrecisionType>& floatPrecisionType);
 
    StatusCode setDeviceId(const unsigned int deviceId);
 
    StatusCode setInferDeviceType(const InferDeviceType type);
 
    StatusCode create(const std::string& modelPath);
 
    StatusCode load();
 
    StatusCode infer(const std::vector<MMindImage>& images);
 
    StatusCode getResults(std::vector<MMindResult>& results);
 
    StatusCode resultVisualization(std::vector<MMindImage>& images);
 
    StatusCode moduleResultVisualization(std::vector<MMindImage>& images,
                                         const unsigned int moduleIdx);
 
    std::vector<DeepLearningAlgoType> getDeepLearningAlgoTypes() const;
 
    void release();
 
    MMindInferEngine(const MMindInferEngine& rhs) = delete;
    MMindInferEngine(MMindInferEngine&& rhs);
    MMindInferEngine& operator=(const MMindInferEngine& rhs) = delete;
    MMindInferEngine& operator=(MMindInferEngine&& rhs);
    ~MMindInferEngine();
 
private:
    struct Impl;
    std::unique_ptr<Impl> _pImpl;
};
 
} // namespace mmind::dl