![]() |
Face SDK
1.14.1 Mozart release
Face Recognition Software Development Kit
|
Classes | |
struct | face_sdk__liveness |
The liveness detection. Can be used to detect if that`s alive person on the photo. More... | |
struct | face_sdk__liveness_result |
The liveness_result object. The result object can be casted to specific liveness depending on liveness algorithm version. For example, the result can be casted to face_sdk__livenes_102_result if it obtained from liveness version 102. More... | |
struct | face_sdk__liveness_result_set |
struct | face_sdk__liveness_102_config |
The config for liveness 102 algorithm. More... | |
struct | face_sdk__liveness_102_result |
The result of liveness 102 algorithm. More... | |
struct | face_sdk__liveness_102_result_set |
Typedefs | |
typedef struct face_sdk__liveness | face_sdk__liveness_t |
The liveness detection. Can be used to detect if that`s alive person on the photo. More... | |
typedef struct face_sdk__liveness_result | face_sdk__liveness_result_t |
The liveness_result object. The result object can be casted to specific liveness depending on liveness algorithm version. For example, the result can be casted to face_sdk__livenes_102_result if it obtained from liveness version 102. | |
typedef struct face_sdk__liveness_result_set | face_sdk__liveness_result_set_t |
typedef struct face_sdk__liveness_102_config | face_sdk__liveness_102_config_t |
The config for liveness 102 algorithm. More... | |
typedef struct face_sdk__liveness_102_result | face_sdk__liveness_102_result_t |
The result of liveness 102 algorithm. More... | |
typedef struct face_sdk__liveness_102_result_set | face_sdk__liveness_102_result_set_t |
Functions | |
bool | face_sdk__liveness__get_addr (const face_sdk__liveness_t *liveness, uint64_t *addr) |
Retrieves face_sdk__liveness_t object address * *. More... | |
bool | face_sdk__liveness_result__get_addr (const face_sdk__liveness_result_t *liveness_result, uint64_t *addr) |
Retrieves face_sdk__liveness_result_t object address * *. More... | |
bool | face_sdk__liveness_result__get_error_code (const face_sdk__liveness_result_t *result, int *error_code) |
Error code. Non-success error codes depend on liveness algoritm version. More... | |
bool | face_sdk__liveness_result__get_real (const face_sdk__liveness_result_t *result, bool *real) |
Returns liveness status. true means person is alive, false means spoof. Make sense only if error_code for result object is SUCCESS. More... | |
bool | face_sdk__make_liveness_result_set (face_sdk__liveness_result_set_t **set) |
Makes face_sdk__liveness_result_set_t collection with items of type face_sdk__liveness_result_t * *. More... | |
bool | face_sdk__liveness_result_set__get_size (const face_sdk__liveness_result_set_t *set, uint64_t *value) |
Retrieves number of items stored in collection * *. More... | |
bool | face_sdk__liveness_result_set__get_at (const face_sdk__liveness_result_set_t *set, uint64_t pos, face_sdk__liveness_result_t **item) |
Retrieves item by index * *. More... | |
bool | face_sdk__liveness_result_set__set_at (face_sdk__liveness_result_set_t *set, uint64_t pos, const face_sdk__liveness_result_t *item) |
Sets item by index * *. More... | |
bool | face_sdk__liveness_result_set__append (face_sdk__liveness_result_set_t *set, const face_sdk__liveness_result_t *item) |
Appends item into collection * *. More... | |
bool | face_sdk__liveness_result_set__remove_at (face_sdk__liveness_result_set_t *set, uint64_t pos) |
Removes item by index * *. More... | |
bool | face_sdk__liveness_result_set__clear (face_sdk__liveness_result_set_t *set) |
Removes all items from collection *. More... | |
bool | face_sdk__liveness_result_set__get_addr (const face_sdk__liveness_result_set_t *set, uint64_t *addr) |
Retrieves face_sdk__liveness_result_set_t object address * *. More... | |
void | face_sdk__liveness_result_set_free (face_sdk__liveness_result_set_t *set) |
Destroys face_sdk__liveness_result_set_t object * *. More... | |
bool | face_sdk__liveness__process_faces (const face_sdk__liveness_t *liveness, const face_sdk__face_set_t *face_set, face_sdk__liveness_result_set_t **liveness_result_set) |
Performs Performs liveness detection on detected faces. The faces must be detected by compatible face detection algorithm. See list of dependencies. If you serialize faces you must serialize with full frame for correct work. More... | |
bool | face_sdk__liveness__version (const face_sdk__liveness_t *liveness, uint32_t *version) |
Returns liveness algorithm version. More... | |
void | face_sdk__liveness_free (face_sdk__liveness_t *liveness) |
Destroys face_sdk__liveness object. More... | |
void | face_sdk__liveness_result_free (face_sdk__liveness_result_t *liveness_result) |
Destroys face_sdk__liveness_result object. More... | |
bool | face_sdk__liveness_102_config__get_addr (const face_sdk__liveness_102_config_t *liveness_102_config, uint64_t *addr) |
Retrieves face_sdk__liveness_102_config_t object address * *. More... | |
bool | face_sdk__liveness_102_config__get_threshold1 (const face_sdk__liveness_102_config_t *config, float *threshold) |
threshold for face_sdk__liveness_102_result__get_value1(). All three values must be greater than corresponsding thresholds for passing liveness. | |
bool | face_sdk__liveness_102_config__get_threshold2 (const face_sdk__liveness_102_config_t *config, float *threshold) |
threshold for face_sdk__liveness_102_result__get_value2(). All three values must be greater than corresponsding thresholds for passing liveness. | |
bool | face_sdk__liveness_102_config__get_threshold3 (const face_sdk__liveness_102_config_t *config, float *threshold) |
threshold for face_sdk__liveness_102_result__get_value3(). All three values must be greater than corresponsding thresholds for passing liveness. | |
bool | face_sdk__liveness_102_result__get_addr (const face_sdk__liveness_102_result_t *liveness_102_result, uint64_t *addr) |
Retrieves face_sdk__liveness_102_result_t object address * *. More... | |
bool | face_sdk__liveness_102_result__get_value1 (const face_sdk__liveness_102_result_t *result, float *threshold) |
predicted value1. All three values must be greater than corresponsding thresholds for passing liveness. | |
bool | face_sdk__liveness_102_result__get_value2 (const face_sdk__liveness_102_result_t *result, float *threshold) |
predicted value2. All three values must be greater than corresponsding thresholds for passing liveness. | |
bool | face_sdk__liveness_102_result__get_value3 (const face_sdk__liveness_102_result_t *result, float *threshold) |
predicted value3. All three values must be greater than corresponsding thresholds for passing liveness. | |
bool | face_sdk__make_liveness_102_result_set (face_sdk__liveness_102_result_set_t **set) |
Makes face_sdk__liveness_102_result_set_t collection with items of type face_sdk__liveness_102_result_t * *. More... | |
bool | face_sdk__liveness_102_result_set__get_size (const face_sdk__liveness_102_result_set_t *set, uint64_t *value) |
Retrieves number of items stored in collection * *. More... | |
bool | face_sdk__liveness_102_result_set__get_at (const face_sdk__liveness_102_result_set_t *set, uint64_t pos, face_sdk__liveness_102_result_t **item) |
Retrieves item by index * *. More... | |
bool | face_sdk__liveness_102_result_set__set_at (face_sdk__liveness_102_result_set_t *set, uint64_t pos, const face_sdk__liveness_102_result_t *item) |
Sets item by index * *. More... | |
bool | face_sdk__liveness_102_result_set__append (face_sdk__liveness_102_result_set_t *set, const face_sdk__liveness_102_result_t *item) |
Appends item into collection * *. More... | |
bool | face_sdk__liveness_102_result_set__remove_at (face_sdk__liveness_102_result_set_t *set, uint64_t pos) |
Removes item by index * *. More... | |
bool | face_sdk__liveness_102_result_set__clear (face_sdk__liveness_102_result_set_t *set) |
Removes all items from collection *. More... | |
bool | face_sdk__liveness_102_result_set__get_addr (const face_sdk__liveness_102_result_set_t *set, uint64_t *addr) |
Retrieves face_sdk__liveness_102_result_set_t object address * *. More... | |
void | face_sdk__liveness_102_result_set_free (face_sdk__liveness_102_result_set_t *set) |
Destroys face_sdk__liveness_102_result_set_t object * *. More... | |
bool | face_sdk__make_liveness (uint32_t version, const face_sdk__liveness_102_config_t *config, uint32_t batch_size, int32_t compute_device, face_sdk__liveness_t **liveness) |
Makes liveness with specified version, config, batch size and compute device. More... | |
bool | face_sdk__make_liveness_1 (uint32_t version, const face_sdk__liveness_102_config_t *config, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, face_sdk__liveness_t **liveness) |
Makes liveness with specified version, config, license, batch size and compute device. More... | |
bool | face_sdk__make_liveness_2 (uint32_t version, const face_sdk__liveness_102_config_t *config, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__liveness_t **liveness) |
Makes liveness with specified version, config, data container, batch size and compute device. More... | |
bool | face_sdk__make_liveness_3 (uint32_t version, const face_sdk__liveness_102_config_t *config, const face_sdk__license_t *license, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__liveness_t **liveness) |
Makes liveness with specified version, config, license, data container, batch size and compute device. More... | |
bool | face_sdk__make_liveness_102_config (float threshold1, float threshold2, float threshold3, face_sdk__liveness_102_config_t **config) |
Makes config for liveness 102 with specified thresholds. | |
bool | face_sdk__make_liveness_102_default_config (face_sdk__liveness_102_config_t **config) |
Makes config for liveness 102 with default thresholds. | |
void | face_sdk__liveness_102_config_free (face_sdk__liveness_102_config_t *config) |
Destroys face_sdk__liveness_102_config object. More... | |
void | face_sdk__liveness_102_result_free (face_sdk__liveness_102_result_t *liveness_result) |
Destroys face_sdk__liveness_102_result object. More... | |
bool | face_sdk__liveness_results_102_cast (const face_sdk__liveness_result_set_t *results, face_sdk__liveness_102_result_set_t **results_102) |
Casts face_sdk__liveness_result_set to face_sdk__liveness_102_result_set. More... | |
Module detects if that`s alive person on the photo.
typedef struct face_sdk__liveness_102_config face_sdk__liveness_102_config_t |
The config for liveness 102 algorithm.
Use face_sdk__make_liveness_102_config or face_sdk__make_liveness_102_default_config to instantiate config
typedef struct face_sdk__liveness_102_result face_sdk__liveness_102_result_t |
The result of liveness 102 algorithm.
typedef struct face_sdk__liveness face_sdk__liveness_t |
The liveness detection. Can be used to detect if that`s alive person on the photo.
Use face_sdk__make_liveness functions for instantiate an liveness object.
bool face_sdk__liveness_102_config__get_addr | ( | const face_sdk__liveness_102_config_t * | liveness_102_config, |
uint64_t * | addr | ||
) |
Retrieves face_sdk__liveness_102_config_t object address * *.
[in] | liveness_102_config | face_sdk__liveness_102_config_t object * |
[out] | addr | Object address * * |
void face_sdk__liveness_102_config_free | ( | face_sdk__liveness_102_config_t * | config | ) |
Destroys face_sdk__liveness_102_config object.
[in] | config | face_sdk__liveness_102_config object made with face_sdk__make_liveness_102_config() or face_sdk__make_liveness_102_default_config() function |
bool face_sdk__liveness_102_result__get_addr | ( | const face_sdk__liveness_102_result_t * | liveness_102_result, |
uint64_t * | addr | ||
) |
Retrieves face_sdk__liveness_102_result_t object address * *.
[in] | liveness_102_result | face_sdk__liveness_102_result_t object * |
[out] | addr | Object address * * |
void face_sdk__liveness_102_result_free | ( | face_sdk__liveness_102_result_t * | liveness_result | ) |
Destroys face_sdk__liveness_102_result object.
[in] | config | face_sdk__liveness_102_result object obtained from face_sdk__liveness_results_102_cast() function |
bool face_sdk__liveness_102_result_set__append | ( | face_sdk__liveness_102_result_set_t * | set, |
const face_sdk__liveness_102_result_t * | item | ||
) |
Appends item into collection * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
[in] | item | Item * * |
bool face_sdk__liveness_102_result_set__clear | ( | face_sdk__liveness_102_result_set_t * | set | ) |
Removes all items from collection *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * * |
bool face_sdk__liveness_102_result_set__get_addr | ( | const face_sdk__liveness_102_result_set_t * | set, |
uint64_t * | addr | ||
) |
Retrieves face_sdk__liveness_102_result_set_t object address * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
[out] | addr | Object address * * |
bool face_sdk__liveness_102_result_set__get_at | ( | const face_sdk__liveness_102_result_set_t * | set, |
uint64_t | pos, | ||
face_sdk__liveness_102_result_t ** | item | ||
) |
Retrieves item by index * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
[in] | pos | Item index * |
[out] | value | Item * * |
bool face_sdk__liveness_102_result_set__get_size | ( | const face_sdk__liveness_102_result_set_t * | set, |
uint64_t * | value | ||
) |
Retrieves number of items stored in collection * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
[out] | value | Items count * * |
bool face_sdk__liveness_102_result_set__remove_at | ( | face_sdk__liveness_102_result_set_t * | set, |
uint64_t | pos | ||
) |
Removes item by index * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
[in] | pos | Item index * * |
bool face_sdk__liveness_102_result_set__set_at | ( | face_sdk__liveness_102_result_set_t * | set, |
uint64_t | pos, | ||
const face_sdk__liveness_102_result_t * | item | ||
) |
Sets item by index * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
[in] | pos | Item index * |
[in] | item | Item object * * |
void face_sdk__liveness_102_result_set_free | ( | face_sdk__liveness_102_result_set_t * | set | ) |
Destroys face_sdk__liveness_102_result_set_t object * *.
[in] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * |
bool face_sdk__liveness__get_addr | ( | const face_sdk__liveness_t * | liveness, |
uint64_t * | addr | ||
) |
Retrieves face_sdk__liveness_t object address * *.
[in] | liveness | face_sdk__liveness_t object * |
[out] | addr | Object address * * |
bool face_sdk__liveness__process_faces | ( | const face_sdk__liveness_t * | liveness, |
const face_sdk__face_set_t * | face_set, | ||
face_sdk__liveness_result_set_t ** | liveness_result_set | ||
) |
Performs Performs liveness detection on detected faces. The faces must be detected by compatible face detection algorithm. See list of dependencies.
If you serialize faces you must serialize with full frame for correct work.
[in] | liveness | Liveness object made with face_sdk__make_liveness() function |
[in] | faces | Faces obtained directly from face_sdk__face_detector or deserialized by face_sdk__serializer. |
[out] | liveness_result_set | Liveness detection result set. Each element in the set relates to the face in input faces set. |
bool face_sdk__liveness__version | ( | const face_sdk__liveness_t * | liveness, |
uint32_t * | version | ||
) |
Returns liveness algorithm version.
[in] | liveness | Liveness object made with face_sdk__make_liveness() function |
[out] | version | Liveness algorithm version |
void face_sdk__liveness_free | ( | face_sdk__liveness_t * | liveness | ) |
Destroys face_sdk__liveness object.
[in] | liveness | Liveness object made with face_sdk__make_liveness() function |
bool face_sdk__liveness_result__get_addr | ( | const face_sdk__liveness_result_t * | liveness_result, |
uint64_t * | addr | ||
) |
Retrieves face_sdk__liveness_result_t object address * *.
[in] | liveness_result | face_sdk__liveness_result_t object * |
[out] | addr | Object address * * |
bool face_sdk__liveness_result__get_error_code | ( | const face_sdk__liveness_result_t * | result, |
int * | error_code | ||
) |
Error code. Non-success error codes depend on liveness algoritm version.
[in] | liveness | Liveness object made with face_sdk__make_liveness() function |
[out] | real | Liveness detection result set. Each element in the set relates to face in input faces set. |
bool face_sdk__liveness_result__get_real | ( | const face_sdk__liveness_result_t * | result, |
bool * | real | ||
) |
Returns liveness status. true means person is alive, false means spoof. Make sense only if error_code for result object is SUCCESS.
[in] | liveness | Liveness object made with face_sdk__make_liveness() function |
[out] | real | true means person is alive, false means spoof. |
void face_sdk__liveness_result_free | ( | face_sdk__liveness_result_t * | liveness_result | ) |
Destroys face_sdk__liveness_result object.
[in] | liveness_result | Liveness detection results obtained from face_sdk__liveness__process_faces() function |
bool face_sdk__liveness_result_set__append | ( | face_sdk__liveness_result_set_t * | set, |
const face_sdk__liveness_result_t * | item | ||
) |
Appends item into collection * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
[in] | item | Item * * |
bool face_sdk__liveness_result_set__clear | ( | face_sdk__liveness_result_set_t * | set | ) |
Removes all items from collection *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * * |
bool face_sdk__liveness_result_set__get_addr | ( | const face_sdk__liveness_result_set_t * | set, |
uint64_t * | addr | ||
) |
Retrieves face_sdk__liveness_result_set_t object address * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
[out] | addr | Object address * * |
bool face_sdk__liveness_result_set__get_at | ( | const face_sdk__liveness_result_set_t * | set, |
uint64_t | pos, | ||
face_sdk__liveness_result_t ** | item | ||
) |
Retrieves item by index * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
[in] | pos | Item index * |
[out] | value | Item * * |
bool face_sdk__liveness_result_set__get_size | ( | const face_sdk__liveness_result_set_t * | set, |
uint64_t * | value | ||
) |
Retrieves number of items stored in collection * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
[out] | value | Items count * * |
bool face_sdk__liveness_result_set__remove_at | ( | face_sdk__liveness_result_set_t * | set, |
uint64_t | pos | ||
) |
Removes item by index * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
[in] | pos | Item index * * |
bool face_sdk__liveness_result_set__set_at | ( | face_sdk__liveness_result_set_t * | set, |
uint64_t | pos, | ||
const face_sdk__liveness_result_t * | item | ||
) |
Sets item by index * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
[in] | pos | Item index * |
[in] | item | Item object * * |
void face_sdk__liveness_result_set_free | ( | face_sdk__liveness_result_set_t * | set | ) |
Destroys face_sdk__liveness_result_set_t object * *.
[in] | liveness_result_set | face_sdk__liveness_result_set_t object * |
bool face_sdk__liveness_results_102_cast | ( | const face_sdk__liveness_result_set_t * | results, |
face_sdk__liveness_102_result_set_t ** | results_102 | ||
) |
Casts face_sdk__liveness_result_set to face_sdk__liveness_102_result_set.
[in] | results | |
[out] | results_102 |
bool face_sdk__make_liveness | ( | uint32_t | version, |
const face_sdk__liveness_102_config_t * | config, | ||
uint32_t | batch_size, | ||
int32_t | compute_device, | ||
face_sdk__liveness_t ** | liveness | ||
) |
Makes liveness with specified version, config, batch size and compute device.
[in] | version | Required version of the algorithm. See Liveness versions |
[in] | config | Liveness config. Depends on liveness version. Use corresponded factory functions to make config. |
[in] | batch_size | The batch size. See Batching. |
[in] | compute_device | The compute device. -1 = CPU. 0, 1, ..., N - GPU device. |
[out] | liveness | face_sdk__liveness object |
bool face_sdk__make_liveness_1 | ( | uint32_t | version, |
const face_sdk__liveness_102_config_t * | config, | ||
const face_sdk__license_t * | license, | ||
uint32_t | batch_size, | ||
int32_t | compute_device, | ||
face_sdk__liveness_t ** | liveness | ||
) |
Makes liveness with specified version, config, license, batch size and compute device.
[in] | version | Required version of the algorithm. See Liveness versions |
[in] | config | Liveness config. Depends on liveness version. Use corresponded factory functions to make config. |
[in] | license | The license object. See Licensing. |
[in] | batch_size | The batch size. See Batching. |
[in] | compute_device | The compute device. -1 = CPU. 0, 1, ..., N - GPU device. |
[out] | liveness | face_sdk__liveness object |
bool face_sdk__make_liveness_102_result_set | ( | face_sdk__liveness_102_result_set_t ** | set | ) |
Makes face_sdk__liveness_102_result_set_t collection with items of type face_sdk__liveness_102_result_t * *.
[out] | liveness_102_result_set | face_sdk__liveness_102_result_set_t object * * |
bool face_sdk__make_liveness_2 | ( | uint32_t | version, |
const face_sdk__liveness_102_config_t * | config, | ||
const face_sdk__data_container_t * | container, | ||
uint32_t | batch_size, | ||
int32_t | compute_device, | ||
face_sdk__liveness_t ** | liveness | ||
) |
Makes liveness with specified version, config, data container, batch size and compute device.
[in] | version | Required version of the algorithm. See Liveness versions |
[in] | config | Liveness config. Depends on liveness version. Use corresponded factory functions to make config. |
[in] | container | The container with algorithm data. |
[in] | batch_size | The batch size. See Batching. |
[in] | compute_device | The compute device. -1 = CPU. 0, 1, ..., N - GPU device. |
[out] | liveness | face_sdk__liveness object |
bool face_sdk__make_liveness_3 | ( | uint32_t | version, |
const face_sdk__liveness_102_config_t * | config, | ||
const face_sdk__license_t * | license, | ||
const face_sdk__data_container_t * | container, | ||
uint32_t | batch_size, | ||
int32_t | compute_device, | ||
face_sdk__liveness_t ** | liveness | ||
) |
Makes liveness with specified version, config, license, data container, batch size and compute device.
[in] | version | Required version of the algorithm. See Liveness versions |
[in] | config | Liveness config. Depends on liveness version. Use corresponded factory functions to make config. |
[in] | license | The license object. See Licensing. |
[in] | container | The container with algorithm data. |
[in] | batch_size | The batch size. See Batching. |
[in] | compute_device | The compute device. -1 = CPU. 0, 1, ..., N - GPU device. |
[out] | liveness | face_sdk__liveness object |
bool face_sdk__make_liveness_result_set | ( | face_sdk__liveness_result_set_t ** | set | ) |
Makes face_sdk__liveness_result_set_t collection with items of type face_sdk__liveness_result_t * *.
[out] | liveness_result_set | face_sdk__liveness_result_set_t object * * |