| Face Engine SDK 5.35.0 A face detection, recognition and tracking engine.

IFaceEngineMobile.h
1 #pragma once
2
3 #include <fsdk/Version.h>
4 #include <fsdk/Log.h>
5 #include <fsdk/Def.h>
6 #include <fsdk/IObject.h>
7 #include <fsdk/ILicense.h>
8 #include <fsdk/IDetector.h>
9 #include <fsdk/IDescriptor.h>
10 #include <fsdk/ISettingsProvider.h>
11 #include <fsdk/IWarper.h>
12
13 #include <fsdk/Estimators/IAGSEstimator.h>
14 #include <fsdk/Estimators/IHeadPoseEstimator.h>
15 #include <fsdk/Estimators/IEyeEstimator.h>
16 #include <fsdk/Estimators/IFaceOcclusionEstimator.h>
17 #include <fsdk/Estimators/IGazeEstimator.h>
18 #include <fsdk/Estimators/IGlassesEstimator.h>
19 #include <fsdk/Estimators/IBestShotQualityEstimator.h>
20 #include <fsdk/Estimators/ILivenessOneShotRGBEstimator.h>
21 #include <fsdk/Estimators/IMedicalMaskEstimator.h>
22 #include <fsdk/Estimators/IMouthEstimator.h>
23 #include <fsdk/Estimators/IQualityEstimator.h>
24 #include <fsdk/Estimators/ISubjectiveQualityEstimator.h>
25
26 #include <fsdk/Types/FaceEngineEdition.h>
27
50 namespace fsdk {
52
53 #ifndef DOXYGEN_SHOULD_SKIP_THIS
54 DECLARE_SMARTPTR(IFaceEngineMobile);
55 #endif
56
66 struct IFaceEngineMobile : IRefCounted {
67
72 virtual ResultValue<FSDKError, IDetectorPtr> createDetector() noexcept = 0;
73
78 virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr> createHeadPoseEstimator() noexcept = 0;
79
84 virtual ResultValue<FSDKError, IAGSEstimatorPtr> createAGSEstimator() noexcept = 0;
85
90 virtual ResultValue<FSDKError, IEyeEstimatorPtr> createEyeEstimator() noexcept = 0;
91
97 virtual ResultValue<FSDKError, IMedicalMaskEstimatorPtr> createMedicalMaskEstimator() noexcept = 0;
98
104 virtual ResultValue<FSDKError, IGazeEstimatorPtr>
105 createGazeEstimator(SensorType mode = SensorType::Visible) noexcept = 0;
106
112 virtual ResultValue<FSDKError, IGlassesEstimatorPtr> createGlassesEstimator() noexcept = 0;
113
119 FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, "
120 "use createSubjectiveQualityEstimator instead!")
121 virtual ResultValue<FSDKError, IQualityEstimatorPtr> createQualityEstimator() noexcept = 0;
122
128 virtual ResultValue<FSDKError, ISubjectiveQualityEstimatorPtr>
129 createSubjectiveQualityEstimator() noexcept = 0;
130
135 virtual ResultValue<FSDKError, IBestShotQualityEstimatorPtr>
136 createBestShotQualityEstimator() noexcept = 0;
137
142 virtual ResultValue<FSDKError, ILivenessOneShotRGBEstimatorPtr>
143 createLivenessOneShotRGBEstimator() noexcept = 0;
144
150 virtual ResultValue<FSDKError, IMouthEstimatorPtr> createMouthEstimator() noexcept = 0;
151
152
158 virtual ResultValue<FSDKError, IFaceOcclusionEstimatorPtr> createFaceOcclusionEstimator() noexcept = 0;
159
168 virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
169
176 virtual ResultValue<FSDKError, IDescriptorPtr>
177 createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
178
189 virtual ResultValue<FSDKError, IDescriptorBatchPtr>
190 createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
191
201 virtual ResultValue<FSDKError, IDescriptorExtractorPtr>
202 createExtractor(uint32_t version = 0) noexcept = 0;
203
212 virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
213
218 virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
219
227 virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
228
233 virtual void setDataDirectory(const char* path) noexcept = 0;
234
240 virtual const char* getDataDirectory() const noexcept = 0;
241
246 virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
247
252 virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
253
258 virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
259
264 virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
265
270 virtual ILicense* getLicense() const noexcept = 0;
271 };
272
282 FSDK_API Result<FSDKError>
283 activateLicense(ILicense* license, const char* configPath, const char* json = nullptr) noexcept;
284
294 FSDK_API Result<FSDKError>
295 activateLicense(ILicense* license, ISettingsProvider* settings, const char* json = nullptr) noexcept;
296
302 FSDK_API ResultValue<FSDKError, Fingerprint> getFingerprint(const ISettingsProvider* settings) noexcept;
303
312 FSDK_API ResultValue<FSDKError, IFaceEngineMobilePtr> createFaceEngineMobile(
313 const char* dataPath = nullptr,
314 const char* configPath = nullptr,
315 const char* runtimePath = nullptr) noexcept;
316
322 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
323
330 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr>
331 createSettingsProviderFromString(const char* content) noexcept;
332
333 } // namespace fsdk
fsdk::activateLicense
FSDK_API Result< FSDKError > activateLicense(ILicense *license, const char *configPath, const char *json=nullptr) noexcept
Makes License activation with some platform specific manner. Network connection is required...
FSDK_API
#define FSDK_API
Dummy.
Definition: Def.h:27
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:70
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
IWarper.h
Image and landmarks warping.
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
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::setRuntimeSettingsProvider
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
fsdk::IFaceEngineMobile::createExtractor
virtual ResultValue< FSDKError, IDescriptorExtractorPtr > createExtractor(uint32_t version=0) noexcept=0
Creates descriptor extractor.
fsdk::IFaceEngineMobile::createLivenessOneShotRGBEstimator
virtual ResultValue< FSDKError, ILivenessOneShotRGBEstimatorPtr > createLivenessOneShotRGBEstimator() noexcept=0
Creates Liveness OneShot estimator.
IObject.h
Object system types and interfaces.
fsdk::IFaceEngineMobile::createGazeEstimator
virtual ResultValue< FSDKError, IGazeEstimatorPtr > createGazeEstimator(SensorType mode=SensorType::Visible) noexcept=0
Creates Gaze estimator.
fsdk::ILicense
License objects interface.
Definition: ILicense.h:84
fsdk::createSettingsProviderFromString
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProviderFromString(const char *content) noexcept
Creates a settings provider from the xml-formatted string.
fsdk::getFingerprint
FSDK_API ResultValue< FSDKError, Fingerprint > getFingerprint(const ISettingsProvider *settings) noexcept
Gets the device fingerprint which could be used for the offline activation.
fsdk::IFaceEngineMobile::createBestShotQualityEstimator
virtual ResultValue< FSDKError, IBestShotQualityEstimatorPtr > createBestShotQualityEstimator() noexcept=0
Creates BestShotQuality estimator.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::IFaceEngineMobile::createHeadPoseEstimator
virtual ResultValue< FSDKError, IHeadPoseEstimatorPtr > createHeadPoseEstimator() noexcept=0
Creates Head pose estimator.
Version.h
SDK version information routines.
Log.h
Log interfaces.
fsdk::IFaceEngineMobile::createAGSEstimator
virtual ResultValue< FSDKError, IAGSEstimatorPtr > createAGSEstimator() noexcept=0
Creates AGS estimator.
fsdk::IFaceEngineMobile::getRuntimeSettingsProvider
virtual ISettingsProvider * getRuntimeSettingsProvider() const noexcept=0
Gets runtime settings provider.
fsdk::IFaceEngineMobile::getDataDirectory
virtual const char * getDataDirectory() const noexcept=0
Gets data directory.
fsdk::IFaceEngineMobile
Root LUNA SDK object interface.
Definition: IFaceEngineMobile.h:66
fsdk::SensorType
SensorType
Sensor type structure. Determines which type of camera sensor is used to perform face recognition...
Definition: SensorType.h:9
fsdk::IFaceEngineMobile::FSDK_DEPRECATED
FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, " "use createSubjectiveQualityEstimator instead!") virtual ResultValue< FSDKError
Creates Quality estimator.
IDescriptor.h
Descriptor extractor and matcher interfaces.
Def.h
Common SDK definitions.
fsdk::IFaceEngineMobile::setDataDirectory
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
fsdk::ResultValue
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:21
IDetector.h
Face detector interfaces.
fsdk::IFaceEngineMobile::createDescriptorBatch
virtual ResultValue< FSDKError, IDescriptorBatchPtr > createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
fsdk::IFaceEngineMobile::createDetector
virtual ResultValue< FSDKError, IDetectorPtr > createDetector() noexcept=0
Creates a detector of given type.
fsdk::IFaceEngineMobile::createSubjectiveQualityEstimator
virtual ResultValue< FSDKError, ISubjectiveQualityEstimatorPtr > createSubjectiveQualityEstimator() noexcept=0
Creates Subjective quality estimator.
fsdk::IFaceEngineMobile::createMatcher
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
fsdk::SensorType::Visible
Visible sensor type.
fsdk::Fingerprint
Fingreprint structure.
Definition: ILicense.h:47
fsdk::IFaceEngineMobile::setSettingsProvider
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
fsdk::IFaceEngineMobile::createMouthEstimator
virtual ResultValue< FSDKError, IMouthEstimatorPtr > createMouthEstimator() noexcept=0
Creates Mouth estimator.
fsdk::IArchive
Archive interface.
Definition: IObject.h:38
fsdk::IFaceEngineMobile::createEyeEstimator
virtual ResultValue< FSDKError, IEyeEstimatorPtr > createEyeEstimator() noexcept=0
Creates Eye estimator.
fsdk::FSDKError
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
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.
ISettingsProvider.h
Settings provider interface.
fsdk::IFaceEngineMobile::getFaceEngineEdition
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK ditribution edition.
fsdk::IFaceEngineMobile::createWarper
virtual ResultValue< FSDKError, IWarperPtr > createWarper() noexcept=0
Creates warper.
fsdk::IFaceEngineMobile::createDescriptor
virtual ResultValue< FSDKError, IDescriptorPtr > createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
fsdk::createSettingsProvider
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProvider(const char *path) noexcept
Create a settings provider.
fsdk::IFaceEngineMobile::createFaceOcclusionEstimator
virtual ResultValue< FSDKError, IFaceOcclusionEstimatorPtr > createFaceOcclusionEstimator() noexcept=0
Creates FaceOcclusion estimator.
fsdk::IFaceEngineMobile::getSettingsProvider
virtual ISettingsProvider * getSettingsProvider() const noexcept=0
Gets settings provider.
fsdk::IFaceEngineMobile::getLicense
virtual ILicense * getLicense() const noexcept=0
Get current License object, which was set for FaceEngine object.
fsdk::ISettingsProvider
SDK settings provider interface.
Definition: ISettingsProvider.h:32