Face Engine SDK  5.21.0
A face detection, recognition and tracking engine.
IFaceEngineMobile.h
1 #pragma once
2 
3 #include <fsdk/Log.h>
4 #include <fsdk/Def.h>
5 #include <fsdk/IObject.h>
6 #include <fsdk/ILicense.h>
7 #include <fsdk/IDetector.h>
8 #include <fsdk/IDescriptor.h>
9 #include <fsdk/ISettingsProvider.h>
10 #include <fsdk/IWarper.h>
11 
12 #include <fsdk/Estimators/IAGSEstimator.h>
13 #include <fsdk/Estimators/IHeadPoseEstimator.h>
14 #include <fsdk/Estimators/IEyeEstimator.h>
15 #include <fsdk/Estimators/IGlassesEstimator.h>
16 #include <fsdk/Estimators/IBestShotQualityEstimator.h>
17 #include <fsdk/Estimators/ILivenessOneShotRGBEstimator.h>
18 #include <fsdk/Estimators/ILivenessDepthRGBEstimator.h>
19 #include <fsdk/Estimators/IMedicalMaskEstimator.h>
20 #include <fsdk/Estimators/INIRLivenessEstimator.h>
21 #include <fsdk/Estimators/IQualityEstimator.h>
22 
23 #include <fsdk/Types/FaceEngineEdition.h>
24 
47 namespace fsdk {
49 
50 #ifndef DOXYGEN_SHOULD_SKIP_THIS
51  DECLARE_SMARTPTR(IFaceEngineMobile);
52 #endif
53 
64 
70 
75  virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr> createHeadPoseEstimator() noexcept = 0;
76 
81  virtual ResultValue<FSDKError, IAGSEstimatorPtr> createAGSEstimator() noexcept = 0;
82 
87  virtual ResultValue<FSDKError, IEyeEstimatorPtr> createEyeEstimator() noexcept = 0;
88 
94  virtual ResultValue<FSDKError, IMedicalMaskEstimatorPtr> createMedicalMaskEstimator() noexcept = 0;
95 
101  virtual ResultValue<FSDKError, IGlassesEstimatorPtr> createGlassesEstimator() noexcept = 0;
102 
108  virtual ResultValue<FSDKError, IQualityEstimatorPtr> createQualityEstimator() noexcept = 0;
109 
114  virtual ResultValue<FSDKError, IBestShotQualityEstimatorPtr>
116 
121  virtual ResultValue<FSDKError, ILivenessOneShotRGBEstimatorPtr>
123 
129  virtual ResultValue<FSDKError, ILivenessDepthRGBEstimatorPtr>
131 
139  virtual ResultValue<FSDKError, INIRLivenessEstimatorPtr>
140  createNIRLivenessEstimator(const NIRLivenessMode mode = NIRLivenessMode::Default) noexcept = 0;
141 
150  virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
151 
158  virtual ResultValue<FSDKError, IDescriptorPtr>
159  createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
160 
171  virtual ResultValue<FSDKError, IDescriptorBatchPtr>
172  createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
173 
183  virtual ResultValue<FSDKError, IDescriptorExtractorPtr>
184  createExtractor(uint32_t version = 0) noexcept = 0;
185 
194  virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
195 
200  virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
201 
209  virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
210 
215  virtual void setDataDirectory(const char* path) noexcept = 0;
216 
222  virtual const char* getDataDirectory() const noexcept = 0;
223 
228  virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
229 
234  virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
235 
240  virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
241 
246  virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
247 
252  virtual ILicense* getLicense() const noexcept = 0;
253  };
254 
261  FSDK_API Result<FSDKError> activateLicense(ILicense* license, const char* configPath) noexcept;
262 
270 
280  const char* dataPath = nullptr,
281  const char* configPath = nullptr,
282  const char* runtimePath = nullptr) noexcept;
283 
289  FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
290 
297  FSDK_API ResultValue<FSDKError, ISettingsProviderPtr>
298  createSettingsProviderFromString(const char* content) noexcept;
299 
300 } // namespace fsdk
fsdk::IFaceEngineMobile::createAGSEstimator
virtual ResultValue< FSDKError, IAGSEstimatorPtr > createAGSEstimator() noexcept=0
Creates AGS estimator.
fsdk::createSettingsProviderFromString
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProviderFromString(const char *content) noexcept
Creates a settings provider from the xml-formatted string.
fsdk::IFaceEngineMobile::createDetector
virtual ResultValue< FSDKError, IDetectorPtr > createDetector() noexcept=0
Creates a detector of given type.
fsdk::FSDKError
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:56
fsdk::IFaceEngineMobile::getFaceEngineEdition
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK ditribution edition.
fsdk::IFaceEngineMobile::getSettingsProvider
virtual ISettingsProvider * getSettingsProvider() const noexcept=0
Gets settings provider.
fsdk::IFaceEngineMobile::getRuntimeSettingsProvider
virtual ISettingsProvider * getRuntimeSettingsProvider() const noexcept=0
Gets runtime settings provider.
fsdk::IFaceEngineMobile::createLivenessOneShotRGBEstimator
virtual ResultValue< FSDKError, ILivenessOneShotRGBEstimatorPtr > createLivenessOneShotRGBEstimator() noexcept=0
Creates Liveness OneShot estimator.
fsdk::ILicense
License objects interface.
Definition: ILicense.h:47
fsdk::IFaceEngineMobile::createLivenessDepthRGBEstimator
virtual ResultValue< FSDKError, ILivenessDepthRGBEstimatorPtr > createLivenessDepthRGBEstimator() noexcept=0
Creates Liveness Depth+RGB estimator.
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
fsdk::IFaceEngineMobile::setSettingsProvider
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
fsdk::IFaceEngineMobile::createEyeEstimator
virtual ResultValue< FSDKError, IEyeEstimatorPtr > createEyeEstimator() noexcept=0
Creates Eye estimator.
fsdk::IFaceEngineMobile::setRuntimeSettingsProvider
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
fsdk::IFaceEngineMobile::createHeadPoseEstimator
virtual ResultValue< FSDKError, IHeadPoseEstimatorPtr > createHeadPoseEstimator() noexcept=0
Creates Head pose estimator.
fsdk::createSettingsProvider
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProvider(const char *path) noexcept
Create a settings provider.
fsdk::ISettingsProvider
SDK settings provider interface.
Definition: ISettingsProvider.h:32
fsdk::IFaceEngineMobile::getLicense
virtual ILicense * getLicense() const noexcept=0
Get current License object, which was set for FaceEngine object.
FSDK_API
#define FSDK_API
Dummy.
Definition: Def.h:27
fsdk::IFaceEngineMobile::createDescriptorBatch
virtual ResultValue< FSDKError, IDescriptorBatchPtr > createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
fsdk::IArchive
Archive interface.
Definition: IObject.h:38
fsdk::NIRLivenessMode
NIRLivenessMode
NIRLiveness estimation mode. Currently, available values to select the estimation mode are: Default,...
Definition: INIRLivenessEstimator.h:23
fsdk::createFaceEngineMobile
FSDK_API ResultValue< FSDKError, IFaceEngineMobilePtr > createFaceEngineMobile(const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept
Create the LUNA SDK root object.
fsdk::IFaceEngineMobile::createDescriptor
virtual ResultValue< FSDKError, IDescriptorPtr > createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
fsdk::IFaceEngineMobile
Root LUNA SDK object interface.
Definition: IFaceEngineMobile.h:63
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::IFaceEngineMobile::createMatcher
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
fsdk::IFaceEngineMobile::createGlassesEstimator
virtual ResultValue< FSDKError, IGlassesEstimatorPtr > createGlassesEstimator() noexcept=0
Creates Glasses estimator.
fsdk::IFaceEngineMobile::createMedicalMaskEstimator
virtual ResultValue< FSDKError, IMedicalMaskEstimatorPtr > createMedicalMaskEstimator() noexcept=0
Creates MedicalMask estimator.
fsdk::IFaceEngineMobile::createQualityEstimator
virtual ResultValue< FSDKError, IQualityEstimatorPtr > createQualityEstimator() noexcept=0
Creates Quality estimator.
fsdk::IFaceEngineMobile::createWarper
virtual ResultValue< FSDKError, IWarperPtr > createWarper() noexcept=0
Creates warper.
fsdk::IFaceEngineMobile::createBestShotQualityEstimator
virtual ResultValue< FSDKError, IBestShotQualityEstimatorPtr > createBestShotQualityEstimator() noexcept=0
Creates BestShotQuality estimator.
fsdk::activateLicense
FSDK_API Result< FSDKError > activateLicense(ILicense *license, const char *configPath) noexcept
Makes License activation with some platform specific manner. Network connection is required.
fsdk::IFaceEngineMobile::getDataDirectory
virtual const char * getDataDirectory() const noexcept=0
Gets data directory.
fsdk::IFaceEngineMobile::setDataDirectory
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::IFaceEngineMobile::createNIRLivenessEstimator
virtual ResultValue< FSDKError, INIRLivenessEstimatorPtr > createNIRLivenessEstimator(const NIRLivenessMode mode=NIRLivenessMode::Default) noexcept=0
Creates NIRLiveness estimator.
fsdk::IFaceEngineMobile::createExtractor
virtual ResultValue< FSDKError, IDescriptorExtractorPtr > createExtractor(uint32_t version=0) noexcept=0
Creates descriptor extractor.
fsdk::ResultValue
Addon for Result to output some value aside the result. Specialization for copiable types.
Definition: ResultValue.h:21