Face Engine SDK  5.14.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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>
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/IMedicalMaskEstimator.h>
19 #include <fsdk/Estimators/IQualityEstimator.h>
20 
21 #include <fsdk/Types/FaceEngineEdition.h>
22 
45 namespace fsdk {
47 
48 #ifndef DOXYGEN_SHOULD_SKIP_THIS
49  DECLARE_SMARTPTR(IFaceEngineMobile);
50 #endif
51 
62 
68 
74 
80 
86 
93 
100 
107 
113 
119 
128  virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
129 
136  virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
137 
147  virtual ResultValue<FSDKError, IDescriptorBatchPtr> createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
148 
157  virtual ResultValue<FSDKError, IDescriptorExtractorPtr> createExtractor(uint32_t version = 0) noexcept = 0;
158 
167  virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
168 
173  virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
174 
182  virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
183 
188  virtual void setDataDirectory(const char* path) noexcept = 0;
189 
195  virtual const char* getDataDirectory() const noexcept = 0;
196 
201  virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
202 
207  virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
208 
213  virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
214 
219  virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
220 
225  virtual ILicense* getLicense() const noexcept = 0;
226  };
227 
234  FSDK_API Result<FSDKError> activateLicense(ILicense* license, const char* configPath) noexcept;
235 
243 
252  const char* dataPath = nullptr,
253  const char* configPath = nullptr,
254  const char* runtimePath = nullptr) noexcept;
255 
261  FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
262 
263 } // namespace fsdk
#define FSDK_API
Dummy.
Definition: Def.h:27
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
Image and landmarks warping.
A structure that encapsulates an action result enumeration.
Definition: Result.h:29
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
virtual ResultValue< FSDKError, IDescriptorExtractorPtr > createExtractor(uint32_t version=0) noexcept=0
Creates descriptor extractor.
virtual ResultValue< FSDKError, ILivenessOneShotRGBEstimatorPtr > createLivenessOneShotRGBEstimator() noexcept=0
Creates Liveness OneShot estimator.
FSDK_API Result< FSDKError > activateLicense(ILicense *license, const char *configPath) noexcept
Makes License activation with some platform specific manner. Network connection is required...
Object system types and interfaces.
License objects interface.
Definition: ILicense.h:38
virtual ResultValue< FSDKError, IBestShotQualityEstimatorPtr > createBestShotQualityEstimator() noexcept=0
Creates BestShotQuality estimator.
Base strong reference counted object interface.
Definition: IRefCounted.h:36
virtual ResultValue< FSDKError, IHeadPoseEstimatorPtr > createHeadPoseEstimator() noexcept=0
Creates Head pose estimator.
Log interfaces.
virtual ResultValue< FSDKError, IAGSEstimatorPtr > createAGSEstimator() noexcept=0
Creates AGS estimator.
virtual ISettingsProvider * getRuntimeSettingsProvider() const noexcept=0
Gets runtime settings provider.
virtual const char * getDataDirectory() const noexcept=0
Gets data directory.
Root LUNA SDK object interface.
Definition: IFaceEngineMobile.h:61
Descriptor extractor and matcher interfaces.
Common SDK definitions.
virtual ResultValue< FSDKError, IQualityEstimatorPtr > createQualityEstimator() noexcept=0
Creates Quality estimator.
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:25
Face detector interfaces.
virtual ResultValue< FSDKError, IDescriptorBatchPtr > createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
virtual ResultValue< FSDKError, IDetectorPtr > createDetector() noexcept=0
Creates a detector of given type.
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
Archive interface.
Definition: IObject.h:37
virtual ResultValue< FSDKError, IEyeEstimatorPtr > createEyeEstimator() noexcept=0
Creates Eye estimator.
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
virtual ResultValue< FSDKError, IGlassesEstimatorPtr > createGlassesEstimator() noexcept=0
Creates Glasses estimator.
virtual ResultValue< FSDKError, IMedicalMaskEstimatorPtr > createMedicalMaskEstimator() noexcept=0
Creates MedicalMask estimator.
Settings provider interface.
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK ditribution edition.
virtual ResultValue< FSDKError, IWarperPtr > createWarper() noexcept=0
Creates warper.
virtual ResultValue< FSDKError, IDescriptorPtr > createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProvider(const char *path) noexcept
Create a settings provider.
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.
virtual ISettingsProvider * getSettingsProvider() const noexcept=0
Gets settings provider.
virtual ILicense * getLicense() const noexcept=0
Get current License object, which was set for FaceEngine object.
SDK settings provider interface.
Definition: ISettingsProvider.h:32