Modules
	Alignment info

	Alignment info set

	Data container

	Face

	Face set

	Set of face sets

	Fir set

	Image set

	Face landmark

	Landmark set

	Last error

	License

	Matrix

	Remote_license

	Serializer

	Version

	Video frame

	Video stream

Classes
struct	face_sdk__fir
	The FIR object. FIR - Face Identification Record, biometric template. More...

struct	face_sdk__image
	An image keeps bitmap data in 24bpp RBG format. More...

Typedefs
typedef struct face_sdk__fir	face_sdk__fir_t
	The FIR object. FIR - Face Identification Record, biometric template. More...

typedef struct face_sdk__image	face_sdk__image_t
	An image keeps bitmap data in 24bpp RBG format. More...

Functions
bool	face_sdk__fir__get_addr (const face_sdk__fir_t fir, uint64_t addr)
	Retrieves face_sdk__fir_t object address. More...

bool	face_sdk__fir__get_version (const face_sdk__fir_t fir, uint32_t value)
	Retrieves fir object version. More...

bool	face_sdk__fir__is_short (const face_sdk__fir_t fir, bool value)
	Retrieves fir data type. More...

bool	face_sdk__fir__is_binary (const face_sdk__fir_t fir, bool value)
	Retrieves fir data type. More...

bool	face_sdk__convert_to_short_fir (const face_sdk__fir_t long_fir, face_sdk__fir_t *short_fir)
	Converts long data type fir to short data type fir. More...

void	face_sdk__fir_free (face_sdk__fir_t *fir)
	Destroys face_sdk__fir object. More...

bool	face_sdk__image__get_addr (const face_sdk__image_t image, uint64_t addr)
	Retrieves face_sdk__image_t object address. More...

bool	face_sdk__load_image_from_file (const uint8_t file_name, uint64_t file_name_size, face_sdk__image_t *image)
	Load encoded image from file. Image must be in RBG or BRG channels order. Grayscale or images with alfa-channel not allowed. More...

bool	face_sdk__load_image_from_data (const std::uint8_t data, uint64_t data_size, face_sdk__image_t *image)
	Load encoded image from memory. More...

bool	face_sdk__make_image_from_data (const std::uint8_t data, uint32_t width, uint32_t height, face_sdk__image_t *image)
	Makes image object from bitmap. Bitmap must 24bpp RGB format. More...

bool	face_sdk__make_image_from_data_1 (const std::uint8_t data, uint32_t width, uint32_t height, uint64_t stride, face_sdk__image_t *image)
	Makes image object from bitmap. Bitmap must 24bpp RGB format. More...

bool	face_sdk__image__get_width (const face_sdk__image_t image, int32_t value)
	Retrieves image width. More...

bool	face_sdk__image__get_height (const face_sdk__image_t image, int32_t value)
	Retrieves image height. More...

bool	face_sdk__image__get_stride (const face_sdk__image_t image, uint64_t value)
	Retrieves image stride. More...

bool	face_sdk__image__get_data (const face_sdk__image_t image, void data, uint64_t data_size)
	Retrieves image data. More...

void	face_sdk__image_free (face_sdk__image_t *image)
	Destroys Image object. More...

Detailed Description

Typedef Documentation

◆ face_sdk__fir_t

typedef struct face_sdk__fir face_sdk__fir_t

The FIR object. FIR - Face Identification Record, biometric template.

Usually face_sdk__builder_builder make firs, but you can use face_sdk__make_fir() function to instantiate a fir object.

◆ face_sdk__image_t

typedef struct face_sdk__image face_sdk__image_t

An image keeps bitmap data in 24bpp RBG format.

Use face_sdk__load_image_from_file(), face_sdk__load_image_from_data() and face_sdk__make_image_from_data() functions to get handle to image. Use face_sdk__image_free() to release resources occupied by image;

Function Documentation

◆ face_sdk__convert_to_short_fir()

bool face_sdk__convert_to_short_fir	(	const face_sdk__fir_t *	long_fir,
		face_sdk__fir_t **	short_fir
	)

Converts long data type fir to short data type fir.

Parameters

[in]	long_fir	Long data type fir object
[out]	short_fir	Short data type fir object

Returns: true on success, false on failure. See last_error

◆ face_sdkfirget_addr()

bool face_sdk__fir__get_addr	(	const face_sdk__fir_t *	fir,
		uint64_t *	addr
	)

Retrieves face_sdk__fir_t object address.

Parameters

[in]	fir	face_sdk__fir_t object
[out]	addr	Object address

Returns: true on success, false on failure. See last_error

◆ face_sdkfirget_version()

bool face_sdk__fir__get_version	(	const face_sdk__fir_t *	fir,
		uint32_t *	value
	)

Retrieves fir object version.

Parameters

[in]	fir	Fir object
[out]	value	Fir object version

Returns: true on success, false on failure. See last_error

◆ face_sdkfiris_binary()

bool face_sdk__fir__is_binary	(	const face_sdk__fir_t *	fir,
		bool *	value
	)

Retrieves fir data type.

Parameters

[in]	fir	Fir object
[out]	value	True if fir has binary data type, false if it has short or float-based data type.

Returns: true on success, false on failure. See last_error

◆ face_sdkfiris_short()

bool face_sdk__fir__is_short	(	const face_sdk__fir_t *	fir,
		bool *	value
	)

Retrieves fir data type.

Parameters

[in]	fir	Fir object
[out]	value	True if fir has short data type, false if it has binary or float-based data type.

Returns: true on success, false on failure. See last_error

◆ face_sdk__fir_free()

void face_sdk__fir_free ( face_sdk__fir_t * fir )

Destroys face_sdk__fir object.

Parameters

[in] fir Fir object

◆ face_sdkimageget_addr()

bool face_sdk__image__get_addr	(	const face_sdk__image_t *	image,
		uint64_t *	addr
	)

Retrieves face_sdk__image_t object address.

Parameters

[in]	image	face_sdk__image_t object
[out]	addr	Object address

Returns: true on success, false on failure. See last_error

◆ face_sdkimageget_data()

bool face_sdk__image__get_data	(	const face_sdk__image_t *	image,
		void **	data,
		uint64_t *	data_size
	)

Retrieves image data.

Parameters

[in]	image	Image object
[out]	data	Buffer holding bitmap
[out]	data_size	Size in bytes of data buffer

Returns: true on success, false on failure. See last_error

◆ face_sdkimageget_height()

bool face_sdk__image__get_height	(	const face_sdk__image_t *	image,
		int32_t *	value
	)

Retrieves image height.

Parameters

[in]	image	Image object
[out]	value	Image height

Returns: true on success, false on failure. See last_error

◆ face_sdkimageget_stride()

bool face_sdk__image__get_stride	(	const face_sdk__image_t *	image,
		uint64_t *	value
	)

Retrieves image stride.

Parameters

[in]	image	Image object
[out]	value	Image stride

Returns: true on success, false on failure. See last_error

◆ face_sdkimageget_width()

bool face_sdk__image__get_width	(	const face_sdk__image_t *	image,
		int32_t *	value
	)

Retrieves image width.

Parameters

[in]	image	Image object
[out]	value	Image width

Returns: true on success, false on failure. See last_error

◆ face_sdk__image_free()

void face_sdk__image_free ( face_sdk__image_t * image )

Destroys Image object.

Parameters

[in] image Image object

◆ face_sdk__load_image_from_data()

bool face_sdk__load_image_from_data	(	const std::uint8_t *	data,
		uint64_t	data_size,
		face_sdk__image_t **	image
	)

Load encoded image from memory.

Parameters

[in]	data	pointer to memory with encoded image
[in]	data_size	size of data
[out]	image	Image object

Returns: true on success, false on failure. See last_error

◆ face_sdk__load_image_from_file()

bool face_sdk__load_image_from_file	(	const uint8_t *	file_name,
		uint64_t	file_name_size,
		face_sdk__image_t **	image
	)

Load encoded image from file. Image must be in RBG or BRG channels order. Grayscale or images with alfa-channel not allowed.

Parameters

[in]	file_name	String containing path to a file. See text_encoding
[in]	file_name_size	Size in bytes of file_name string
[out]	image	Image object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_image_from_data()

bool face_sdk__make_image_from_data	(	const std::uint8_t *	data,
		uint32_t	width,
		uint32_t	height,
		face_sdk__image_t **	image
	)

Makes image object from bitmap. Bitmap must 24bpp RGB format.

Parameters

[in]	data	pointer to memory with bitmap
[in]	width	bitmap width in pixels
[in]	height	bitmap height in pixels
[out]	image	Image object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_image_from_data_1()

bool face_sdk__make_image_from_data_1	(	const std::uint8_t *	data,
		uint32_t	width,
		uint32_t	height,
		uint64_t	stride,
		face_sdk__image_t **	image
	)

Makes image object from bitmap. Bitmap must 24bpp RGB format.

Parameters

[in]	data	pointer to memory with bitmap
[in]	width	bitmap width in pixels
[in]	height	bitmap height in pixels
[in]	stride	bitmap row size in bytes
[out]	image	Image object

Returns: true on success, false on failure. See last_error

Modules

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ face_sdk__fir_t

◆ face_sdk__image_t

Function Documentation

◆ face_sdk__convert_to_short_fir()

◆ face_sdk__fir__get_addr()

◆ face_sdk__fir__get_version()

◆ face_sdk__fir__is_binary()

◆ face_sdk__fir__is_short()

◆ face_sdk__fir_free()

◆ face_sdk__image__get_addr()

◆ face_sdk__image__get_data()

◆ face_sdk__image__get_height()

◆ face_sdk__image__get_stride()

◆ face_sdk__image__get_width()

◆ face_sdk__image_free()

◆ face_sdk__load_image_from_data()

◆ face_sdk__load_image_from_file()

◆ face_sdk__make_image_from_data()

◆ face_sdk__make_image_from_data_1()

◆ face_sdkfirget_addr()

◆ face_sdkfirget_version()

◆ face_sdkfiris_binary()

◆ face_sdkfiris_short()

◆ face_sdkimageget_addr()

◆ face_sdkimageget_data()

◆ face_sdkimageget_height()

◆ face_sdkimageget_stride()

◆ face_sdkimageget_width()