| Face Engine SDK 5.2.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/IBestShotQualityEstimator.h>
16
17 #include <fsdk/Types/FaceEngineEdition.h>
18
39 namespace fsdk {
41
42 #ifndef DOXYGEN_SHOULD_SKIP_THIS
43 DECLARE_SMARTPTR(IFaceEngineMobile);
44 #endif
45
55 struct IFaceEngineMobile : IRefCounted {
56
61 virtual ResultValue<FSDKError, IDetectorPtr> createDetector() noexcept = 0;
62
67 virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr> createHeadPoseEstimator() noexcept = 0;
68
73 virtual ResultValue<FSDKError, IAGSEstimatorPtr> createAGSEstimator() noexcept = 0;
74
79 virtual ResultValue<FSDKError, IEyeEstimatorPtr> createEyeEstimator() noexcept = 0;
80
85 virtual ResultValue<FSDKError, IBestShotQualityEstimatorPtr> createBestShotQualityEstimator() noexcept = 0;
86
94 virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
95
102 virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
103
113 virtual ResultValue<FSDKError, IDescriptorBatchPtr> createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
114
122 virtual ResultValue<FSDKError, IDescriptorExtractorPtr> createExtractor(uint32_t version = 0) noexcept = 0;
123
131 virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
132
137 virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
138
146 virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
147
152 virtual void setDataDirectory(const char* path) noexcept = 0;
153
159 virtual const char* getDataDirectory() const noexcept = 0;
160
165 virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
166
171 virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
172
177 virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
178
183 virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
184
189 virtual ILicense* getLicense() const noexcept = 0;
190 };
191
198 FSDK_API Result<FSDKError> activateLicense(ILicense* license, const char* configPath) noexcept;
199
207 FSDK_API ResultValue<FSDKError, IFaceEngineMobilePtr> createFaceEngineMobile(
208 const char* dataPath = nullptr,
209 const char* configPath = nullptr,
210 const char* runtimePath = nullptr) noexcept;
211
217 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
218
219 } // namespace fsdk
fsdk::IFaceEngineMobile::createAGSEstimator
virtual ResultValue< FSDKError, IAGSEstimatorPtr > createAGSEstimator() noexcept=0
Creates AGS estimator.
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:59
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::ILicense
License objects interface.
Definition: ILicense.h:37
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:37
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:55
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:30
fsdk::IFaceEngineMobile::createMatcher
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
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:36
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