Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Classes | Typedefs | Functions
Serializer

Classes

struct  face_sdk__serializer
 The serializer object. The serializer object allows serialize and deserialize face_sdk__face, face_sdk__alignment_info, face_sdk__fir objects. More...
 

Typedefs

typedef struct face_sdk__serializer face_sdk__serializer_t
 The serializer object. The serializer object allows serialize and deserialize face_sdk__face, face_sdk__alignment_info, face_sdk__fir objects.
 

Functions

bool face_sdk__serializer__get_addr (const face_sdk__serializer_t *serializer, uint64_t *addr)
 Retrieves face_sdk__serializer_t object address * *. More...
 
bool face_sdk__serializer__serialize_face (const face_sdk__serializer_t *serializer, const face_sdk__face_t *face, uint8_t **data, uint64_t *data_size)
 Serializes face_sdk__face object into binary data. More...
 
bool face_sdk__serializer__serialize_face_1 (const face_sdk__serializer_t *serializer, const face_sdk__face_t *face, bool serialize_full_frame, uint8_t **data, uint64_t *data_size)
 Serializes face_sdk__face object into binary data. More...
 
bool face_sdk__serializer__deserialize_face (const face_sdk__serializer_t *serializer, const uint8_t *data, uint64_t data_size, face_sdk__face_t **face)
 Deserializes face_sdk__face object from binary data. More...
 
bool face_sdk__serializer__serialize_alignment_info (const face_sdk__serializer_t *serializer, const face_sdk__alignment_info_t *alignment_info, uint8_t **data, uint64_t *data_size)
 Serializes face_sdk__alignment_info object into binary data. More...
 
bool face_sdk__serializer__deserialize_alignment_info (const face_sdk__serializer_t *serializer, const uint8_t *data, uint64_t data_size, face_sdk__alignment_info_t **alignment_info)
 Deserializes face_sdk__alignment_info object from binary data. More...
 
bool face_sdk__serializer__deserialize_fir (const face_sdk__serializer_t *serializer, const uint8_t *data, uint64_t data_size, face_sdk__fir_t **fir)
 Deserializes face_sdk__fir object object from binary data. More...
 
bool face_sdk__serializer__serialize_fir (const face_sdk__serializer_t *serializer, const face_sdk__fir_t *fir, uint8_t **data, uint64_t *data_size)
 Serializes face_sdk__fir object into binary data. More...
 
bool face_sdk__make_serializer (face_sdk__serializer_t **serializer)
 Makes serializer object. More...
 
void face_sdk__serializer_free (face_sdk__serializer_t *serializer)
 Destroys face_sdk__serializer object. More...
 

Detailed Description

Function Documentation

◆ face_sdk__make_serializer()

bool face_sdk__make_serializer ( face_sdk__serializer_t **  serializer)

Makes serializer object.

Parameters
[out]serializerSerializer object
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__deserialize_alignment_info()

bool face_sdk__serializer__deserialize_alignment_info ( const face_sdk__serializer_t serializer,
const uint8_t *  data,
uint64_t  data_size,
face_sdk__alignment_info_t **  alignment_info 
)

Deserializes face_sdk__alignment_info object from binary data.

Parameters
[in]serializerSerializer object
[in]dataBuffer holding serialized Alignment Info object
[in]data_sizeSize in bytes of data buffer
[out]alignment_infoAlignment Info object
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__deserialize_face()

bool face_sdk__serializer__deserialize_face ( const face_sdk__serializer_t serializer,
const uint8_t *  data,
uint64_t  data_size,
face_sdk__face_t **  face 
)

Deserializes face_sdk__face object from binary data.

Parameters
[in]serializerSerializer object
[in]dataBuffer holding serialized Face object
[in]data_sizeSize in bytes of data buffer
[out]faceFace object
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__deserialize_fir()

bool face_sdk__serializer__deserialize_fir ( const face_sdk__serializer_t serializer,
const uint8_t *  data,
uint64_t  data_size,
face_sdk__fir_t **  fir 
)

Deserializes face_sdk__fir object object from binary data.

Parameters
[in]serializerSerializer object
[in]dataBuffer holding serialized Fir object
[in]data_sizeSize in bytes of data buffer
[out]firFir object
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__get_addr()

bool face_sdk__serializer__get_addr ( const face_sdk__serializer_t serializer,
uint64_t *  addr 
)

Retrieves face_sdk__serializer_t object address * *.

Parameters
[in]serializerface_sdk__serializer_t object *
[out]addrObject address * *
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__serialize_alignment_info()

bool face_sdk__serializer__serialize_alignment_info ( const face_sdk__serializer_t serializer,
const face_sdk__alignment_info_t alignment_info,
uint8_t **  data,
uint64_t *  data_size 
)

Serializes face_sdk__alignment_info object into binary data.

Parameters
[in]serializerSerializer object
[in]alignment_infoAlignment Info object
[out]dataBuffer holding serialized Alignment Info object
[out]data_sizeSize in bytes of data buffer
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__serialize_face()

bool face_sdk__serializer__serialize_face ( const face_sdk__serializer_t serializer,
const face_sdk__face_t face,
uint8_t **  data,
uint64_t *  data_size 
)

Serializes face_sdk__face object into binary data.

Parameters
[in]serializerSerializer object
[in]faceFace object
[out]dataBuffer holding serialized Face object
[out]data_sizeSize in bytes of data buffer
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__serialize_face_1()

bool face_sdk__serializer__serialize_face_1 ( const face_sdk__serializer_t serializer,
const face_sdk__face_t face,
bool  serialize_full_frame,
uint8_t **  data,
uint64_t *  data_size 
)

Serializes face_sdk__face object into binary data.

Parameters
[in]serializerSerializer object
[in]faceFace object
[in]serialize_full_frameIf true serializes entire image, if false only image will be cropped to face bounding box and then serialized
[out]dataBuffer holding serialized Face object
[out]data_sizeSize in bytes of data buffer
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer__serialize_fir()

bool face_sdk__serializer__serialize_fir ( const face_sdk__serializer_t serializer,
const face_sdk__fir_t fir,
uint8_t **  data,
uint64_t *  data_size 
)

Serializes face_sdk__fir object into binary data.

Parameters
[in]serializerSerializer object
[in]firFir object
[out]dataBuffer holding serialized fir object
[out]data_sizeSize in bytes of data buffer
Returns
true on success, false on failure. See last_error

◆ face_sdk__serializer_free()

void face_sdk__serializer_free ( face_sdk__serializer_t serializer)

Destroys face_sdk__serializer object.

Parameters
[in]serializerSerializer object