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

IFaceEngineMobile.h
1 #pragma once
2
3 #include <fsdk/IObject.h>
4 #include <fsdk/Def.h>
5 #include <fsdk/ILicense.h>
6 #include <fsdk/IDetector.h>
7 #include <fsdk/IDescriptor.h>
8 #include <fsdk/ISettingsProvider.h>
9 #include <fsdk/IWarper.h>
10
11 #include <fsdk/Estimators/IAGSEstimator.h>
12 #include <fsdk/Estimators/IHeadPoseEstimator.h>
13 #include <fsdk/Estimators/IEyeEstimator.h>
14 #include <fsdk/Estimators/IBestShotQualityEstimator.h>
15
16 #include <fsdk/Types/FaceEngineEdition.h>
17
38 namespace fsdk {
40
41 #ifndef DOXYGEN_SHOULD_SKIP_THIS
42 DECLARE_SMARTPTR(IFaceEngineMobile);
43 #endif
44
54 struct IFaceEngineMobile : IRefCounted {
55
60 virtual IDetector* createDetector() noexcept = 0;
61
66 virtual IHeadPoseEstimator* createHeadPoseEstimator() noexcept = 0;
67
72 virtual IAGSEstimator* createAGSEstimator() noexcept = 0;
73
78 virtual IEyeEstimator* createEyeEstimator() noexcept = 0;
79
84 virtual IBestShotQualityEstimator* createBestShotQualityEstimator() noexcept = 0;
85
93 virtual IDescriptor* createDescriptor(uint32_t version = 0) noexcept = 0;
94
101 virtual IDescriptor* createDescriptor(fsdk::IArchive* archive, uint32_t flags = 0) noexcept = 0;
102
112 virtual IDescriptorBatch* createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
113
121 virtual IDescriptorExtractor* createExtractor(uint32_t version = 0) noexcept = 0;
122
130 virtual IDescriptorMatcher* createMatcher(uint32_t version = 0) noexcept = 0;
131
136 virtual IWarper* createWarper() noexcept = 0;
137
145 virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
146
151 virtual void setDataDirectory(const char* path) noexcept = 0;
152
158 virtual const char* getDataDirectory() const noexcept = 0;
159
164 virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
165
170 virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
171
176 virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
177
182 virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
183
188 virtual ILicense* getLicense() const noexcept = 0;
189 };
190
197 FSDK_API bool activateLicense(ILicense* license, const char* configPath) noexcept;
198
206 FSDK_API IFaceEngineMobile* createFaceEngineMobile(
207 const char* dataPath = nullptr,
208 const char* configPath = nullptr,
209 const char* runtimePath = nullptr) noexcept;
210
216 FSDK_API ISettingsProvider* createSettingsProvider(const char* path) noexcept;
217
218 } // namespace fsdk
fsdk::IFaceEngineMobile::createExtractor
virtual IDescriptorExtractor * createExtractor(uint32_t version=0) noexcept=0
Creates descriptor extractor.
fsdk::IFaceEngineMobile::createWarper
virtual IWarper * createWarper() noexcept=0
Creates warper.
FSDK_API
#define FSDK_API
Dummy.
Definition: Def.h:27
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
IWarper.h
Image and landmarks warping.
fsdk::IFaceEngineMobile::createDescriptor
virtual IDescriptor * createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
fsdk::IFaceEngineMobile::setRuntimeSettingsProvider
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
fsdk::IBestShotQualityEstimator
BestShot and Quality estimator interface.
Definition: IBestShotQualityEstimator.h:20
fsdk::IDescriptorBatch
Descriptor batch interface.
Definition: IDescriptor.h:130
fsdk::IFaceEngineMobile::createEyeEstimator
virtual IEyeEstimator * createEyeEstimator() noexcept=0
Creates Eye estimator.
IObject.h
Object system types and interfaces.
fsdk::IWarper
Face detection area warper interface.
Definition: IWarper.h:41
fsdk::ILicense
License objects interface.
Definition: ILicense.h:34
fsdk::activateLicense
FSDK_API bool activateLicense(ILicense *license, const char *configPath) noexcept
Makes License activation with some platform specific manner. Network connection is required...
fsdk::IFaceEngineMobile::createBestShotQualityEstimator
virtual IBestShotQualityEstimator * createBestShotQualityEstimator() noexcept=0
Creates BestShotQuality estimator.
fsdk::IFaceEngineMobile::createAGSEstimator
virtual IAGSEstimator * createAGSEstimator() noexcept=0
Creates AGS estimator.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::IDescriptorMatcher
Descriptor matcher interface.
Definition: IDescriptor.h:407
fsdk::IDetector
face detector interface.
Definition: IDetector.h:115
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:54
IDescriptor.h
Descriptor extractor and matcher interfaces.
Def.h
Common SDK definitions.
fsdk::createFaceEngineMobile
FSDK_API IFaceEngineMobile * createFaceEngineMobile(const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept
Create the LUNA SDK root object.
fsdk::IFaceEngineMobile::setDataDirectory
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
fsdk::IFaceEngineMobile::createDescriptorBatch
virtual IDescriptorBatch * createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
fsdk::IFaceEngineMobile::createMatcher
virtual IDescriptorMatcher * createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
IDetector.h
Face detector interfaces.
fsdk::IFaceEngineMobile::createHeadPoseEstimator
virtual IHeadPoseEstimator * createHeadPoseEstimator() noexcept=0
Creates Head pose estimator.
fsdk::IDescriptorExtractor
Descriptor extractor interface.
Definition: IDescriptor.h:291
fsdk::IEyeEstimator
Eye estimator interface.
Definition: IEyeEstimator.h:86
fsdk::IFaceEngineMobile::setSettingsProvider
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
fsdk::createSettingsProvider
FSDK_API ISettingsProvider * createSettingsProvider(const char *path) noexcept
Create a settings provider.
fsdk::IAGSEstimator
Approximate Garbage Score estimator interface.
Definition: IAGSEstimator.h:18
fsdk::IDescriptor
Descriptor interface.
Definition: IDescriptor.h:82
fsdk::IArchive
Archive interface.
Definition: IObject.h:37
ISettingsProvider.h
Settings provider interface.
fsdk::IFaceEngineMobile::getFaceEngineEdition
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK ditribution edition.
fsdk::IHeadPoseEstimator
Head pose angles estimator interface.
Definition: IHeadPoseEstimator.h:48
fsdk::IFaceEngineMobile::createDetector
virtual IDetector * createDetector() noexcept=0
Creates a detector of given type.
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:31