Face Engine SDK  5.21.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
IFaceEngine.h
1 
8 #pragma once
9 
31 #include <fsdk/Log.h>
32 #include <fsdk/Version.h>
33 #include <fsdk/IObject.h>
34 #include <fsdk/ISettingsProvider.h>
35 #include <fsdk/IEstimator.h>
36 #include <fsdk/IDetector.h>
37 #include <fsdk/IFaceLandmarksDetector.h>
38 #include <fsdk/IHeadDetector.h>
39 #include <fsdk/IDescriptor.h>
40 #include <fsdk/IWarper.h>
41 #include <fsdk/IHumanDetector.h>
42 #include <fsdk/IHumanFaceDetector.h>
43 #include <fsdk/IHumanWarper.h>
44 #include <fsdk/IIndex.h>
45 #include <fsdk/IAsyncContext.h>
46 #include <fsdk/ILicense.h>
47 #include <fsdk/LaunchOptions.h>
48 #include <fsdk/Exception.h>
49 #include <fsdk/Types/FaceEngineEdition.h>
50 
52 namespace fsdk {
53 
54 #ifndef DOXYGEN_SHOULD_SKIP_THIS
55  DECLARE_SMARTPTR(IFaceEngine);
56 #endif
57 
68 
80  const LaunchOptions* launchOptions = nullptr) noexcept = 0;
81 
89  createHeadDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
90 
100  const LaunchOptions* launchOptions = nullptr) noexcept = 0;
101 
102 
104  createOrientationEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
105 
113  createHumanDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
114 
122  createHumanFaceDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
123 
131  createHeadPoseEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
132 
140  createOverlapEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
141 
149  createAGSEstimator(const LaunchOptions* options = nullptr) noexcept = 0;
150 
158  createAttributeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
159 
167  createHumanAttributeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
168 
176  createQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
177 
185  createBlackWhiteEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
186 
194  createDepthEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
195 
203  createLivenessDepthRGBEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
204 
212  createIREstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
213 
221  createLivenessOneShotRGBEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
222 
230  createMouthEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
231 
239  createMedicalMaskEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
240 
248  createLivenessFlyingFacesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
249 
257  createLivenessFPREstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
258 
267  createLivenessRGBMEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
268 
278  const LaunchOptions* launchOptions = nullptr) noexcept = 0;
279 
287  createEmotionsEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
288 
298  const LaunchOptions* launchOptions = nullptr) noexcept = 0;
299 
307  createGlassesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
308 
316  createBestShotQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
317 
325  createCredibilityCheckEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
326 
334  createHeadWearEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
335 
343  createFacialHairEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
344 
352  createFishEyeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
353 
361  createNaturalLightEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
362 
370  createPPEEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
371 
379  createPortraitStyleEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
380 
388  createDynamicRangeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
389 
397  createBackgroundEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
398 
406  createRedEyeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
407 
415  createEyeBrowEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
416 
418  createEthnicityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
419 
429  const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
430 
431 
443  const experimental::DeepFakeMode mode = experimental::DeepFakeMode::Default,
444  const LaunchOptions* launchOptions = nullptr) noexcept = 0;
445 
454  const NIRLivenessMode mode = NIRLivenessMode::Default,
455  const LaunchOptions* launchOptions = nullptr) noexcept = 0;
456 
464  createFightsEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
465 
474  virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
475 
484  createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
485 
497  createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
498 
510  createExtractor(uint32_t version = 0, const LaunchOptions* launchOptions = nullptr) noexcept = 0;
511 
521  virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
522 
531  createIndexBuilder(const size_t capacity = 0, uint32_t version = 0) noexcept = 0;
532 
540  virtual ResultValue<FSDKError, IDenseIndexPtr> loadDenseIndex(const char* indexPath) noexcept = 0;
541 
549  virtual ResultValue<FSDKError, IDynamicIndexPtr> loadDynamicIndex(const char* indexPath) noexcept = 0;
550 
556  virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
557 
564 
572  createAsyncContext(const int8_t threadCount) noexcept = 0;
573 
581  virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
582 
587  virtual void setDataDirectory(const char* path) noexcept = 0;
588 
594  virtual const char* getDataDirectory() const noexcept = 0;
595 
600  virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
601 
606  virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
607 
612  virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
613 
618  virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
619 
624  virtual ILicense* getLicense() const noexcept = 0;
625  };
626 
633  FSDK_API Result<FSDKError> activateLicense(ILicense* license, const char* configPath) noexcept;
634 
642 
655  const char* dataPath = nullptr,
656  const char* configPath = nullptr,
657  const char* runtimePath = nullptr) noexcept;
658 
664  FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
665 
672  FSDK_API ResultValue<FSDKError, ISettingsProviderPtr>
673  createSettingsProviderFromString(const char* content) noexcept;
674 
675 
678 } // namespace fsdk
virtual ResultValue< FSDKError, IHeadWearEstimatorPtr > createHeadWearEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates HeadWear estimator.
virtual ResultValue< FSDKError, IWarperPtr > createWarper() noexcept=0
Creates warper.
virtual ResultValue< FSDKError, IHumanDetectorPtr > createHumanDetector(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a human detector.
virtual ResultValue< FSDKError, IPortraitStyleEstimatorPtr > createPortraitStyleEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates PortraitStyle estimator.
virtual ResultValue< FSDKError, experimental::IDeepFakeEstimatorPtr > createDeepFakeEstimator(const experimental::DeepFakeMode mode=experimental::DeepFakeMode::Default, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates DeepFake estimator. The current implementation is experimental, and does not support backward...
virtual ResultValue< FSDKError, IAGSEstimatorPtr > createAGSEstimator(const LaunchOptions *options=nullptr) noexcept=0
Creates AGS estimator.
virtual ResultValue< FSDKError, IFacialHairEstimatorPtr > createFacialHairEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates FacialHair estimator.
virtual ResultValue< FSDKError, ILivenessDepthEstimatorPtr > createDepthEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness Depth estimator.
#define FSDK_API
Dummy.
Definition: Def.h:27
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:56
LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation.
Definition: LaunchOptions.h:35
virtual ResultValue< FSDKError, IFishEyeEstimatorPtr > createFishEyeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates FishEye estimator.
Default detector cpecified in config file.
Definition: IDetector.h:37
Image and landmarks warping.
virtual ResultValue< FSDKError, IDynamicRangeEstimatorPtr > createDynamicRangeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates DynamicRange estimator.
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
virtual ResultValue< FSDKError, IHeadPoseEstimatorPtr > createHeadPoseEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Head pose estimator.
DeepFakeMode
DeepFake estimation mode. Currently, available values for selecting estimation scenario are: Default...
Definition: IDeepFakeEstimator.h:28
virtual ResultValue< FSDKError, IDescriptorBatchPtr > createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
virtual ResultValue< FSDKError, ILivenessFlyingFacesEstimatorPtr > createLivenessFlyingFacesEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates LivenessFlyingFaces estimator.
virtual ResultValue< FSDKError, IFaceLandmarksDetectorPtr > createFaceLandmarksDetector(SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a face landmark detector.
virtual ResultValue< FSDKError, ICredibilityCheckEstimatorPtr > createCredibilityCheckEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates CredibilityCheck estimator.
virtual ResultValue< FSDKError, IRedEyeEstimatorPtr > createRedEyeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Red Eye estimator.
virtual ResultValue< FSDKError, IMouthEstimatorPtr > createMouthEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Mouth estimator.
virtual ResultValue< FSDKError, ILivenessOneShotRGBEstimatorPtr > createLivenessOneShotRGBEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness OneShot estimator.
virtual ISettingsProvider * getSettingsProvider() const noexcept=0
Gets settings provider.
virtual ResultValue< FSDKError, ILivenessDepthRGBEstimatorPtr > createLivenessDepthRGBEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness Depth+RGB estimator.
Image warping base on Human detection.
virtual ResultValue< FSDKError, IEyeBrowEstimatorPtr > createEyeBrowEstimator(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates EyeBrow estimator .
virtual ResultValue< FSDKError, IPPEEstimatorPtr > createPPEEstimator(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates Personal Protection Equipment (PPE) estimator.
virtual ResultValue< FSDKError, ICrowdEstimatorPtr > createCrowdEstimator(fsdk::CrowdEstimatorType type=fsdk::CrowdEstimatorType::CET_DEFAULT, const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates Crowd estimator.
virtual ResultValue< FSDKError, IHumanWarperPtr > createHumanWarper() noexcept=0
Creates human warper.
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.
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
NIRLivenessMode
NIRLiveness estimation mode. Currently, available values to select the estimation mode are: Default...
Definition: INIRLivenessEstimator.h:23
License objects interface.
Definition: ILicense.h:47
virtual ResultValue< FSDKError, IGlassesEstimatorPtr > createGlassesEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Glasses estimator.
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProviderFromString(const char *content) noexcept
Creates a settings provider from the xml-formatted string.
virtual ResultValue< FSDKError, IBestShotQualityEstimatorPtr > createBestShotQualityEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates BestShotQuality estimator.
virtual ILicense * getLicense() const noexcept=0
Get current License object, which was set for FaceEngine object.
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
Root LUNA SDK object interface.
Definition: IFaceEngine.h:67
Base strong reference counted object interface.
Definition: IRefCounted.h:37
Default type which is specified in config file.
Definition: ICrowdEstimator.h:27
virtual ResultValue< FSDKError, IHumanFaceDetectorPtr > createHumanFaceDetector(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a HumanFace detector, which detects humans, faces and associations between them...
virtual ResultValue< FSDKError, IFightsEstimatorPtr > createFightsEstimator(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates FightsEstimator estimator.
virtual ResultValue< FSDKError, IIndexBuilderPtr > createIndexBuilder(const size_t capacity=0, uint32_t version=0) noexcept=0
Creates index builder.
SDK version information routines.
Log interfaces.
Image analysis and attribute estimation interfaces.
FSDK_API ResultValue< FSDKError, IFaceEnginePtr > createFaceEngine(const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept
Create the LUNA SDK root object.
SensorType
Sensor type structure. Determines which type of camera sensor is used to perform face recognition...
Definition: SensorType.h:9
virtual ResultValue< FSDKError, IDescriptorExtractorPtr > createExtractor(uint32_t version=0, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates descriptor extractor.
Descriptor extractor and matcher interfaces.
virtual ResultValue< FSDKError, ILivenessRGBMEstimatorPtr > createLivenessRGBMEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness RGBM estimator.
virtual ResultValue< FSDKError, IGazeEstimatorPtr > createGazeEstimator(SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Gaze estimator.
virtual ResultValue< FSDKError, IDescriptorPtr > createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
virtual ISettingsProvider * getRuntimeSettingsProvider() const noexcept=0
Gets runtime settings provider.
virtual ResultValue< FSDKError, IHeadDetectorPtr > createHeadDetector(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a head detector.
virtual ResultValue< FSDKError, IOverlapEstimatorPtr > createOverlapEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Overlap estimator.
virtual ResultValue< FSDKError, IDenseIndexPtr > loadDenseIndex(const char *indexPath) noexcept=0
Loads dense index.
virtual ResultValue< FSDKError, ILivenessFPREstimatorPtr > createLivenessFPREstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates LivenessFPR estimator.
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:21
Face detector interfaces.
Visible sensor type.
virtual ResultValue< FSDKError, IDetectorPtr > createDetector(ObjectDetectorClassType type=FACE_DET_DEFAULT, SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a detector of a given type.
virtual ResultValue< FSDKError, IEmotionsEstimatorPtr > createEmotionsEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Emotions estimator.
Async context interface.
virtual ResultValue< FSDKError, IDynamicIndexPtr > loadDynamicIndex(const char *indexPath) noexcept=0
Loads dynamic index.
virtual ResultValue< FSDKError, INaturalLightEstimatorPtr > createNaturalLightEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates NaturalLight estimator.
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
virtual ResultValue< FSDKError, IQualityEstimatorPtr > createQualityEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Quality estimator.
virtual ResultValue< FSDKError, IMedicalMaskEstimatorPtr > createMedicalMaskEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates MedicalMask estimator.
virtual const char * getDataDirectory() const noexcept=0
Gets data directory.
virtual ResultValue< FSDKError, IEyeEstimatorPtr > createEyeEstimator(SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Eye estimator.
virtual ResultValue< FSDKError, IAsyncContextPtr > createAsyncContext(const int8_t threadCount) noexcept=0
Creates async context.
ObjectDetectorClassType
Object detector type enumeration.
Definition: IDetector.h:36
Archive interface.
Definition: IObject.h:38
virtual ResultValue< FSDKError, INIRLivenessEstimatorPtr > createNIRLivenessEstimator(const NIRLivenessMode mode=NIRLivenessMode::Default, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates NIRLiveness estimator.
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK ditribution edition.
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
virtual ResultValue< FSDKError, IBackgroundEstimatorPtr > createBackgroundEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Background estimator.
virtual ResultValue< FSDKError, ILivenessIREstimatorPtr > createIREstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness Infrared estimator.
Settings provider interface.
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProvider(const char *path) noexcept
Creates a settings provider.
virtual ResultValue< FSDKError, IBlackWhiteEstimatorPtr > createBlackWhiteEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates BlackWhite estimator.
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
virtual ResultValue< FSDKError, IAttributeEstimatorPtr > createAttributeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Attribute estimator.
CrowdEstimatorType
CrowdEstimator type enumeration.
Definition: ICrowdEstimator.h:26
virtual ResultValue< FSDKError, IHumanAttributeEstimatorPtr > createHumanAttributeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates HumanAttribute estimator.
SDK settings provider interface.
Definition: ISettingsProvider.h:32