sfe_face.h

Go to the documentation of this file.

 
#pragma once
 
#include "sfe_core.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
// FACE LANDMARKS
#define SFE_FACE_LANDMARK_COUNT 23
 
typedef enum SFEFaceLandmarkType {
  SFE_FACE_LANDMARK_TYPE_RIGHT_EYE_OUTER_CORNER = 0,
  SFE_FACE_LANDMARK_TYPE_RIGHT_EYE_CENTER = 1,
  SFE_FACE_LANDMARK_TYPE_RIGHT_EYE_INNER_CORNER = 2,
  SFE_FACE_LANDMARK_TYPE_LEFT_EYE_INNER_CORNER = 3,
  SFE_FACE_LANDMARK_TYPE_LEFT_EYE_CENTER = 4,
  SFE_FACE_LANDMARK_TYPE_LEFT_EYE_OUTER_CORNER = 5,
  SFE_FACE_LANDMARK_TYPE_NOSE_ROOT = 6,
  SFE_FACE_LANDMARK_TYPE_NOSE_RIGHT_BOTTOM = 7,
  SFE_FACE_LANDMARK_TYPE_NOSE_TIP = 8,
  SFE_FACE_LANDMARK_TYPE_NOSE_LEFT_BOTTOM = 9,
  SFE_FACE_LANDMARK_TYPE_NOSE_BOTTOM = 10,
  SFE_FACE_LANDMARK_TYPE_MOUTH_RIGHT_CORNER = 11,
  SFE_FACE_LANDMARK_TYPE_MOUTH_CENTER = 12,
  SFE_FACE_LANDMARK_TYPE_MOUTH_LEFT_CORNER = 13,
  SFE_FACE_LANDMARK_TYPE_MOUTH_UPPER_EDGE = 14,
  SFE_FACE_LANDMARK_TYPE_MOUTH_LOWER_EDGE = 15,
  SFE_FACE_LANDMARK_TYPE_RIGHT_EYEBROW_OUTER_END = 16,
  SFE_FACE_LANDMARK_TYPE_RIGHT_EYEBROW_INNER_END = 17,
  SFE_FACE_LANDMARK_TYPE_LEFT_EYEBROW_INNER_END = 18,
  SFE_FACE_LANDMARK_TYPE_LEFT_EYEBROW_OUTER_END = 19,
  SFE_FACE_LANDMARK_TYPE_RIGHT_EDGE = 20,
  SFE_FACE_LANDMARK_TYPE_CHIN_TIP = 21,
  SFE_FACE_LANDMARK_TYPE_LEFT_EDGE = 22,
} SFEFaceLandmarkType;
 
typedef struct SFEFaceLandmarks {
  SFEFaceLandmarkType landmark_type;
  float confidence;
  float x;
  float y;
} SFEFaceLandmarks;
 
typedef struct SFEDetectionInputSize {
  uint32_t width;
  uint32_t height;
} SFEDetectionInputSize;
 
SFEError
sfeFaceLandmarks(SFESolver solver, SFEImageView image,
                 const SFEDetection *detection,
                 SFEFaceLandmarks out_face_landmarks[SFE_FACE_LANDMARK_COUNT]);
 
SFEError sfeFaceMaskConfidence(
    const SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
    float *out_mask_confidence);
 
SFEError sfeFaceSize(SFEImageView image,
                     SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
                     float *face_size);
 
// FACE TEMPLATE
#define SFE_FACE_TEMPLATE_SIZE 522
 
typedef struct SFEFaceTemplate {
  uint8_t data[SFE_FACE_TEMPLATE_SIZE];
} SFEFaceTemplate;
 
typedef struct SFEFaceTemplateVersion {
  uint8_t version_major;
  uint8_t version_minor;
} SFEFaceTemplateVersion;
 
SFEError
sfeFaceTemplateExtract(SFESolver solver, SFEImageView image,
                       const SFEDetection *detection,
                       const SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
                       SFEFaceTemplate *out_face_template);
 
SFEError sfeFaceTemplateMatch(SFEFaceTemplate *template1,
                              SFEFaceTemplate *template2,
                              float *out_matching_score);
 
SFEError sfeFaceTemplateQuality(SFEFaceTemplate *face_template,
                                float *out_face_template_quality);
 
SFEError
sfeFaceTemplateVersion(SFEFaceTemplate *face_template,
                       SFEFaceTemplateVersion *out_face_template_version);
 
SFEError sfeFaceTemplateExport(const SFEFaceTemplate *face_template,
                               uint8_t *bytes,
                               size_t *size);
 
SFEError sfeFaceTemplateImport(const uint8_t *bytes,
                               size_t size,
                               SFEFaceTemplate *out_face_template);
 
SFEError
sfeFaceTemplateIdentify(SFEFaceTemplate *probe_face_template,
                        SFEFaceTemplate *templates_gallery, size_t gallery_size,
                        float matching_score_threshold,
                        SFETemplateIdentificationCandidate *out_candidates,
                        size_t *in_out_candidates_count, size_t thread_count);
 
SFEError sfeFaceEntityIdentify(SFEFaceTemplate *probe_face_template,
                               SFEFaceTemplate *templates_gallery,
                               SFEEntity *entities_gallery, size_t gallery_size,
                               float matching_score_threshold,
                               SFEEntityIdentificationCandidate *out_candidates,
                               size_t *in_out_candidates_count,
                               size_t thread_count);
 
typedef struct SFEFaceLiveness {
  float score;
} SFEFaceLiveness;
 
SFEError
sfeFaceLivenessPassive(SFESolver solver, SFEImageView image,
                       SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
                       SFEFaceLiveness *out_liveness);
 
typedef struct SFEFaceArea {
  float size;
  float area;
  float area_in_image;
} SFEFaceArea;
 
SFEError sfeFaceArea(SFEImageView image,
                     SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
                     SFEFaceArea *out_area);
 
typedef struct SFEFaceHeadPose {
  float pitch;
  float yaw;
  float roll;
} SFEFaceHeadPose;
 
SFEError
sfeFaceHeadPose(SFEImageView image,
                SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
                SFEFaceHeadPose *out_head_pose);
 
typedef struct SFEFaceQualityAttributes {
  float sharpness;
  float brightness;
  float contrast;
  float unique_intensity_levels;
} SFEFaceQualityAttributes;
 
typedef struct SFEFaceDemographicAttributes {
  float age;
  float gender;
} SFEFaceDemographicAttributes;
 
SFEError sfeFaceDemographicAttributes(
    SFESolver solver,
    SFEImageView image,
    SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
    SFEFaceDemographicAttributes *out_demographic_attributes);
 
SFEError sfeFaceQualityAttributes(
    SFEImageView image,
    SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
    SFEFaceQualityAttributes *out_quality_attributes);
 
typedef enum SFEFaceDetectionAccuracyType {
  SFE_FACE_DETECT_ACCURACY_TYPE_ACCURATE = 0,
  SFE_FACE_DETECT_ACCURACY_TYPE_BALANCED = 1,
} SFEFaceDetectionAccuracyType;
 
SFEError sfeFaceDetectInputSize(SFEImageView image,
                                SFEFaceDetectionAccuracyType detection_mode,
                                size_t min_face_size, size_t max_face_size,
                                SFEDetectionInputSize *out_input_size);
 
typedef struct SFEFaceCrop {
  float face_size_extension;
  SFEBoundingBox crop_box;
  SFEImage crop_image;
} SFEFaceCrop;
 
SFEError sfeFaceCrop(SFEImageView image,
                     SFEFaceLandmarks face_landmarks[SFE_FACE_LANDMARK_COUNT],
                     float face_size_extension, float max_face_size,
                     SFEFaceCrop *out_crop);
 
#ifdef __cplusplus
} // extern "C"
#endif