IFaceEngineMobile.h

#pragma once

#include <fsdk/Log.h>
#include <fsdk/Def.h>
#include <fsdk/IObject.h>
#include <fsdk/ILicense.h>
#include <fsdk/IDetector.h>
#include <fsdk/IDescriptor.h>
#include <fsdk/ISettingsProvider.h>
#include <fsdk/IWarper.h>

#include <fsdk/Estimators/IAGSEstimator.h>
#include <fsdk/Estimators/IHeadPoseEstimator.h>
#include <fsdk/Estimators/IEyeEstimator.h>
#include <fsdk/Estimators/IFaceOcclusionEstimator.h>
#include <fsdk/Estimators/IGazeEstimator.h>
#include <fsdk/Estimators/IGlassesEstimator.h>
#include <fsdk/Estimators/IBestShotQualityEstimator.h>
#include <fsdk/Estimators/ILivenessOneShotRGBEstimator.h>
#include <fsdk/Estimators/IMedicalMaskEstimator.h>
#include <fsdk/Estimators/IMouthEstimator.h>
#include <fsdk/Estimators/IQualityEstimator.h>
#include <fsdk/Estimators/ISubjectiveQualityEstimator.h>

#include <fsdk/Types/FaceEngineEdition.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFaceEngineMobile);
#endif

    struct IFaceEngineMobile : IRefCounted {

        virtual ResultValue<FSDKError, IDetectorPtr> createDetector() noexcept = 0;

        virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr> createHeadPoseEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, IAGSEstimatorPtr> createAGSEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, IEyeEstimatorPtr> createEyeEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, IMedicalMaskEstimatorPtr> createMedicalMaskEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, IGazeEstimatorPtr>
        createGazeEstimator(SensorType mode = SensorType::Visible) noexcept = 0;

        virtual ResultValue<FSDKError, IGlassesEstimatorPtr> createGlassesEstimator() noexcept = 0;

        FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, "
                                        "use createSubjectiveQualityEstimator instead!")
        virtual ResultValue<FSDKError, IQualityEstimatorPtr> createQualityEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, ISubjectiveQualityEstimatorPtr>
        createSubjectiveQualityEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, IBestShotQualityEstimatorPtr>
        createBestShotQualityEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, ILivenessOneShotRGBEstimatorPtr>
        createLivenessOneShotRGBEstimator() noexcept = 0;

        virtual ResultValue<FSDKError, IMouthEstimatorPtr> createMouthEstimator() noexcept = 0;


        virtual ResultValue<FSDKError, IFaceOcclusionEstimatorPtr> createFaceOcclusionEstimator() 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) noexcept = 0;

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

        virtual ResultValue<FSDKError, IWarperPtr> createWarper() 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, Fingerprint> getFingerprint(const ISettingsProvider* settings) noexcept;

    FSDK_API ResultValue<FSDKError, IFaceEngineMobilePtr> createFaceEngineMobile(
        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