Face SDK  1.8.2 Mozart release
Face Recognition Software Development Kit
face.h
1 
5 #pragma once
6 
7 #include <face_sdk_base/export.h>
8 
9 #include <c_interface/common/face_sdk_class.h>
10 #include <c_interface/face_sdk_base/landmark_set.h>
11 #include <c_interface/face_sdk_base/image.h>
12 #include <c_interface/common/priv/common.h>
13 
14 extern "C"
15 {
21 const float FACE_SDK__UNKNOWN_CONFIDENCE = .0f;
22 const uint32_t FACE_SDK__UNKNOWN_VERSION = 0;
23 
29 DECLARE_FACE_SDK_CLASS(face)
30 
31 
32 
39 bool FACE_SDK_C_EXPORT face_sdk__face__get_confidence(const face_sdk__face_t *face, float *value);
40 
48 bool FACE_SDK_C_EXPORT face_sdk__face__get_x(const face_sdk__face_t *face, int32_t *value);
49 
57 bool FACE_SDK_C_EXPORT face_sdk__face__get_y(const face_sdk__face_t *face, int32_t *value);
58 
66 bool FACE_SDK_C_EXPORT face_sdk__face__get_width(const face_sdk__face_t *face, int32_t *value);
67 
75 bool FACE_SDK_C_EXPORT face_sdk__face__get_height(const face_sdk__face_t *face, int32_t *value);
76 
84 bool FACE_SDK_C_EXPORT face_sdk__face__get_img(const face_sdk__face_t *face, face_sdk__image_t **image);
85 
93 bool FACE_SDK_C_EXPORT face_sdk__face__get_cropped_image(const face_sdk__face_t *face, face_sdk__image_t **image);
94 
102 bool FACE_SDK_C_EXPORT face_sdk__face__has_landmarks(const face_sdk__face_t *face, bool *value);
103 
111 bool FACE_SDK_C_EXPORT face_sdk__face__get_landmarks(const face_sdk__face_t *face, face_sdk__landmark_set_t **landmarks);
112 
120 bool FACE_SDK_C_EXPORT face_sdk__face__is_out_of_bounds_set(const face_sdk__face_t *face, bool *value);
121 
129 bool FACE_SDK_C_EXPORT face_sdk__face__out_of_bounds(const face_sdk__face_t *face, bool *value);
130 
138 bool FACE_SDK_C_EXPORT face_sdk__face__get_version(const face_sdk__face_t *face, uint32_t *value);
139 
147 bool FACE_SDK_C_EXPORT face_sdk__make_face(const face_sdk__image_t *img, face_sdk__face_t **face);
148 
158 bool FACE_SDK_C_EXPORT face_sdk__make_face_1(const face_sdk__image_t *img, uint32_t version, face_sdk__face_t **face);
159 
170 bool FACE_SDK_C_EXPORT face_sdk__make_face_2(const face_sdk__image_t *img,
171  bool out_of_bounds,
172  uint32_t version,
173  face_sdk__face_t **face);
174 
188 bool FACE_SDK_C_EXPORT face_sdk__make_face_3(const face_sdk__image_t *img,
189  int32_t x, int32_t y, int32_t width, int32_t height,
190  float confidence, face_sdk__face_t **face);
191 
206 bool FACE_SDK_C_EXPORT face_sdk__make_face_4(const face_sdk__image_t *img,
207  int32_t x, int32_t y, int32_t width, int32_t height,
208  float confidence,
209  uint32_t version, face_sdk__face_t **face);
210 
226 bool FACE_SDK_C_EXPORT face_sdk__make_face_5(const face_sdk__image_t *img,
227  int32_t x, int32_t y, int32_t width, int32_t height,
228  float confidence,
229  bool out_of_bounds,
230  uint32_t version, face_sdk__face_t **face);
231 
246 bool FACE_SDK_C_EXPORT face_sdk__make_face_6(const face_sdk__image_t *img,
247  int32_t x, int32_t y, int32_t width, int32_t height,
248  float confidence,
249  const face_sdk__landmark_set_t *landmark_set,
250  face_sdk__face_t **face);
251 
267 bool FACE_SDK_C_EXPORT face_sdk__make_face_7(const face_sdk__image_t *img,
268  int32_t x, int32_t y, int32_t width, int32_t height,
269  float confidence,
270  const face_sdk__landmark_set_t *landmark_set,
271  uint32_t version, face_sdk__face_t **face);
272 
289 bool FACE_SDK_C_EXPORT face_sdk__make_face_8(const face_sdk__image_t *img,
290  int32_t x, int32_t y, int32_t width, int32_t height,
291  float confidence,
292  const face_sdk__landmark_set_t *landmark_set,
293  bool out_of_bounds,
294  uint32_t version, face_sdk__face_t **face);
295 
311 bool FACE_SDK_C_EXPORT face_sdk__make_face_9(const face_sdk__image_t *img,
312  int32_t x, int32_t y, int32_t width, int32_t height,
313  float confidence,
314  const face_sdk__landmark_set_t *landmark_set,
315  const face_sdk__image_t *cropped_image, face_sdk__face_t **face);
316 
333 bool FACE_SDK_C_EXPORT face_sdk__make_face_10(const face_sdk__image_t *img,
334  int32_t x, int32_t y, int32_t width, int32_t height,
335  float confidence,
336  const face_sdk__landmark_set_t *landmark_set,
337  const face_sdk__image_t *cropped_image,
338  uint32_t version, face_sdk__face_t **face);
339 
356 bool FACE_SDK_C_EXPORT face_sdk__make_face_11(const face_sdk__image_t *img,
357  int32_t x, int32_t y, int32_t width, int32_t height,
358  float confidence,
359  const face_sdk__landmark_set_t *landmark_set,
360  const face_sdk__image_t *cropped_image,
361  bool out_of_bounds,
362  uint32_t version, face_sdk__face_t **face);
363 
369 void FACE_SDK_C_EXPORT face_sdk__face_free(face_sdk__face_t *face);
370 
372 }
bool face_sdk__face__get_version(const face_sdk__face_t *face, uint32_t *value)
Retrieves face object version.
bool face_sdk__make_face_8(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks, out_of_bounds flag and version.
bool face_sdk__make_face_2(const face_sdk__image_t *img, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified out of bound flag and version. Bounding box size is set equal to...
bool face_sdk__face__has_landmarks(const face_sdk__face_t *face, bool *value)
Retrieves face landmarks availability.
bool face_sdk__make_face_3(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box and confidence.
bool face_sdk__face__get_img(const face_sdk__face_t *face, face_sdk__image_t **image)
Retrieves original image.
bool face_sdk__face__out_of_bounds(const face_sdk__face_t *face, bool *value)
Retrieves out of bounds state.
bool face_sdk__face__get_x(const face_sdk__face_t *face, int32_t *value)
Retrieves x coordinate of face bounding box in pixels.
bool face_sdk__face__get_confidence(const face_sdk__face_t *face, float *value)
Retrieves face confidence. Range is from 0.0f to 1.0f where 1.0f is definitely a face.
bool face_sdk__make_face_4(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence and version.
bool face_sdk__make_face_10(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, const face_sdk__image_t *cropped_image, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks, cropped_image version.
bool face_sdk__face__is_out_of_bounds_set(const face_sdk__face_t *face, bool *value)
Retrieves out of bounds feature availability.
bool face_sdk__make_face(const face_sdk__image_t *img, face_sdk__face_t **face)
Makes the face object. Bounding box size is set equal to the original image size. ...
bool face_sdk__face__get_y(const face_sdk__face_t *face, int32_t *value)
Retrieves y coordinate of face bounding box in pixels.
bool face_sdk__make_face_9(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, const face_sdk__image_t *cropped_image, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks and cropped i...
bool face_sdk__face__get_landmarks(const face_sdk__face_t *face, face_sdk__landmark_set_t **landmarks)
Retrieves set of 10 predicted landmarks.
bool face_sdk__make_face_6(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence and landmarks.
An image keeps bitmap data in 24bpp RBG format.
Definition: image.h:22
bool face_sdk__face__get_width(const face_sdk__face_t *face, int32_t *value)
Retrieves width of face bounding box in pixels.
Set of face landmarks.
Definition: landmark_set.h:20
bool face_sdk__face__get_cropped_image(const face_sdk__face_t *face, face_sdk__image_t **image)
The cropped image (Not all detector versions support this method. If supported function will return f...
bool face_sdk__make_face_11(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, const face_sdk__image_t *cropped_image, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, landmarks, cropped_image, out_of_bounds flag and version.
bool face_sdk__make_face_1(const face_sdk__image_t *img, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified version. Bounding box size is set equal to the original image si...
The face object. Face object contains information about face bounding box on the image and the origin...
Definition: face.h:29
bool face_sdk__make_face_5(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, out_of_bounds flag and ...
bool face_sdk__face__get_height(const face_sdk__face_t *face, int32_t *value)
Retrieves height of face bounding box in pixels.
bool face_sdk__make_face_7(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks and version...
void face_sdk__face_free(face_sdk__face_t *face)
Destroys face_sdk__face object.