IFaceEngine.h

#pragma once

#include "Version.h"
#include "IObject.h"
#include "ISettingsProvider.h"
#include "IEstimator.h"
#include "IDetector.h"
#include "IDescriptor.h"
#include "IWarper.h"
#include "IHumanWarper.h"
#include "IIndex.h"
#include "IAsyncContext.h"
#include "ILicense.h"
#include "Types/FaceEngineEdition.h"

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFaceEngine);
#endif

    struct IFaceEngine : IRefCounted {

        virtual IDetector* createDetector(
            ObjectDetectorClassType type = FACE_DET_DEFAULT,
            RecognitionMode mode = RecognitionMode::RM_RGB) noexcept = 0;
        
        virtual IHumanDetector* createHumanDetector() noexcept = 0;
        
        virtual IHeadPoseEstimator* createHeadPoseEstimator() noexcept = 0;

        virtual IOverlapEstimator* createOverlapEstimator() noexcept = 0;
        
        virtual IChildEstimator* createChildEstimator() noexcept = 0;

        virtual IAGSEstimator* createAGSEstimator() noexcept = 0;
        
        virtual IHeadAndShouldersLivenessEstimator* createHeadAndShouldersLivenessEstimator() noexcept = 0;
        
        virtual IAttributeEstimator* createAttributeEstimator() noexcept = 0;
        
        virtual IQualityEstimator* createQualityEstimator() noexcept = 0;

        virtual IBlackWhiteEstimator* createBlackWhiteEstimator() noexcept = 0;

        virtual ILivenessDepthEstimator* createDepthEstimator() noexcept = 0;

        virtual ILivenessIREstimator* createIREstimator() noexcept = 0;

        virtual ISmileEstimator* createSmileEstimator() noexcept = 0;

        virtual IMouthEstimator* createMouthEstimator() noexcept = 0;
        
        virtual IMedicalMaskEstimator* createMedicalMaskEstimator() noexcept = 0;

        virtual ILivenessFlyingFacesEstimator* createLivenessFlyingFacesEstimator() noexcept = 0;

        virtual ILivenessFlowEstimator* createFaceFlowEstimator() noexcept = 0;

        virtual ILivenessRGBMEstimator* createLivenessRGBMEstimator() noexcept = 0;

        virtual ILivenessFPREstimator* createLivenessFPREstimator() noexcept = 0;

        virtual IEyeEstimator* createEyeEstimator(RecognitionMode mode = RecognitionMode::RM_RGB) noexcept = 0;
        
        virtual IEmotionsEstimator* createEmotionsEstimator() noexcept = 0;

        virtual IGazeEstimator* createGazeEstimator(RecognitionMode mode = RecognitionMode::RM_RGB) noexcept = 0;

        virtual IGlassesEstimator* createGlassesEstimator() noexcept = 0;

        virtual IBestShotQualityEstimator* createBestShotQualityEstimator() noexcept = 0;

        virtual ICredibilityCheckEstimator* createCredibilityCheckEstimator() noexcept = 0;

        virtual IFacialHairEstimator* createFacialHairEstimator() noexcept = 0;

        virtual IHeadWearEstimator* createHeadWearEstimator() noexcept = 0;
        
        virtual IDescriptor* createDescriptor(uint32_t version = 0) noexcept = 0;

        virtual IDescriptor* createDescriptor(fsdk::IArchive* archive, uint32_t flags = 0) noexcept = 0;

        virtual IDescriptorBatch* createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;

        virtual IDescriptorExtractor* createExtractor(uint32_t version = 0) noexcept = 0;

        virtual IDescriptorMatcher* createMatcher(uint32_t version = 0) noexcept = 0;

        virtual IIndexBuilder* createIndexBuilder(
            const size_t capacity = 0,
            uint32_t version = 0) noexcept = 0;

        virtual ResultValue<FSDKError, IDenseIndex*> loadDenseIndex(
            const char* indexPath) noexcept = 0;
        
        virtual ResultValue<FSDKError, IDynamicIndex*> loadDynamicIndex(
            const char* indexPath) noexcept = 0;

        virtual IWarper* createWarper() noexcept = 0;
        
        virtual IHumanWarper* createHumanWarper() noexcept = 0;
        
        virtual IAsyncContext* createAsyncContext(const int8_t threadCount) noexcept = 0;

        virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;

        virtual void setDataDirectory(const char* path) noexcept = 0;

        virtual const char* getDataDirectory() const noexcept = 0;

        virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;

        virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;

        virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
        
        virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;

        virtual ILicense* getLicense() const noexcept = 0;
    };

    FSDK_API bool activateLicense(ILicense* license, const char* configPath) noexcept;

    FSDK_API bool activateLicense(ILicense* license, fsdk::ISettingsProvider* settings) noexcept;

    FSDK_API IFaceEngine* createFaceEngine(
        const char* dataPath = nullptr,
        const char* configPath = nullptr,
        const char* runtimePath = nullptr) noexcept;

    FSDK_API ISettingsProvider* createSettingsProvider(const char* path) noexcept;

}