IFaceEngine.h

#pragma once

#include <fsdk/Log.h>
#include <fsdk/Version.h>
#include <fsdk/MemoryTrim.h>
#include <fsdk/IObject.h>
#include <fsdk/ISettingsProvider.h>
#include <fsdk/IEstimator.h>
#include <fsdk/IDetector.h>
#include <fsdk/IFaceLandmarksDetector.h>
#include <fsdk/IHeadDetector.h>
#include <fsdk/IDescriptor.h>
#include <fsdk/IWarper.h>
#include <fsdk/IImageTransfer.h>
#include <fsdk/IHumanDetector.h>
#include <fsdk/IHumanFaceDetector.h>
#include <fsdk/IHumanWarper.h>
#include <fsdk/IIndex.h>
#include <fsdk/IAsyncContext.h>
#include <fsdk/ILicense.h>
#include <fsdk/LaunchOptions.h>
#include <fsdk/Exception.h>
#include <fsdk/Types/FaceEngineEdition.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFaceEngine);
#endif

    struct IFaceEngine : IRefCounted {

        virtual ResultValue<FSDKError, IDetectorPtr> createDetector(
            ObjectDetectorClassType type = FACE_DET_DEFAULT,
            SensorType mode = SensorType::Visible,
            const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IHeadDetectorPtr>
        createHeadDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IFaceLandmarksDetectorPtr> createFaceLandmarksDetector(
            SensorType mode = SensorType::Visible,
            const LaunchOptions* launchOptions = nullptr) noexcept = 0;


        virtual ResultValue<FSDKError, IOrientationEstimatorPtr>
        createOrientationEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IHumanDetectorPtr>
        createHumanDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IHumanFaceDetectorPtr>
        createHumanFaceDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr>
        createHeadPoseEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IOverlapEstimatorPtr>
        createOverlapEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IAGSEstimatorPtr>
        createAGSEstimator(const LaunchOptions* options = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IAttributeEstimatorPtr>
        createAttributeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IHumanAttributeEstimatorPtr>
        createHumanAttributeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IQualityEstimatorPtr>
        createQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IBlackWhiteEstimatorPtr>
        createBlackWhiteEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessDepthEstimatorPtr>
        createDepthEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IDepthLivenessEstimatorPtr>
        createDepthLivenessEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessDepthRGBEstimatorPtr>
        createLivenessDepthRGBEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessIREstimatorPtr>
        createIREstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessOneShotRGBEstimatorPtr>
        createLivenessOneShotRGBEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IMouthEstimatorPtr>
        createMouthEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IMedicalMaskEstimatorPtr>
        createMedicalMaskEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessFlyingFacesEstimatorPtr>
        createLivenessFlyingFacesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessFPREstimatorPtr>
        createLivenessFPREstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessRGBMEstimatorPtr>
        createLivenessRGBMEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IEyeEstimatorPtr> createEyeEstimator(
            SensorType mode = SensorType::Visible,
            const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IEmotionsEstimatorPtr>
        createEmotionsEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IGazeEstimatorPtr> createGazeEstimator(
            SensorType mode = SensorType::Visible,
            const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IGlassesEstimatorPtr>
        createGlassesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IFaceOcclusionEstimatorPtr>
        createFaceOcclusionEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IBestShotQualityEstimatorPtr>
        createBestShotQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ICredibilityCheckEstimatorPtr>
        createCredibilityCheckEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IHeadWearEstimatorPtr>
        createHeadWearEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IFacialHairEstimatorPtr>
        createFacialHairEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IFishEyeEstimatorPtr>
        createFishEyeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, INaturalLightEstimatorPtr>
        createNaturalLightEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IPPEEstimatorPtr>
        createPPEEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IPortraitStyleEstimatorPtr>
        createPortraitStyleEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IDynamicRangeEstimatorPtr>
        createDynamicRangeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IBackgroundEstimatorPtr>
        createBackgroundEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IRedEyeEstimatorPtr>
        createRedEyeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IEyeBrowEstimatorPtr>
        createEyeBrowEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IEthnicityEstimatorPtr>
        createEthnicityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, ICrowdEstimatorPtr> createCrowdEstimator(
            fsdk::CrowdEstimatorType type = fsdk::CrowdEstimatorType::CET_DEFAULT,
            const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;


        virtual ResultValue<FSDKError, experimental::IDeepFakeEstimatorPtr> createDeepFakeEstimator(
            const experimental::DeepFakeMode mode = experimental::DeepFakeMode::Default,
            const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, INIRLivenessEstimatorPtr> createNIRLivenessEstimator(
            const NIRLivenessMode mode = NIRLivenessMode::Default,
            const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IFightsEstimatorPtr>
        createFightsEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;

        virtual ResultValue<FSDKError, IDescriptorPtr>
        createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;

        virtual ResultValue<FSDKError, IDescriptorBatchPtr>
        createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;

        virtual ResultValue<FSDKError, IDescriptorExtractorPtr>
        createExtractor(uint32_t version = 0, const LaunchOptions* launchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;

        virtual ResultValue<FSDKError, IIndexBuilderPtr>
        createIndexBuilder(const size_t capacity = 0, uint32_t version = 0) noexcept = 0;

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

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

        virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;

        virtual ResultValue<FSDKError, IHumanWarperPtr> createHumanWarper() noexcept = 0;

        virtual ResultValue<FSDKError, IImageTransferPtr>
        createImageTransfer(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;

        virtual ResultValue<FSDKError, IAsyncContextPtr>
        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 Result<FSDKError> activateLicense(ILicense* license, const char* configPath) noexcept;

    FSDK_API Result<FSDKError> activateLicense(ILicense* license, ISettingsProvider* settings) noexcept;

    FSDK_API ResultValue<FSDKError, IFaceEnginePtr> createFaceEngine(
        const char* dataPath = nullptr,
        const char* configPath = nullptr,
        const char* runtimePath = nullptr) noexcept;

    FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;

    FSDK_API ResultValue<FSDKError, ISettingsProviderPtr>
    createSettingsProviderFromString(const char* content) noexcept;


} // namespace fsdk