Pure Fir extractor

Classes
struct	face_sdk__pure_fir_extractor
	Module allows to extract pure data from FIRs. Pure data can be used to implement manual matching, ecnryption, serialization, etc... Use face_sdk__make_pure_fir_extractor() functions to instantiate pure_fir_extractor object. More...

Typedefs
typedef struct face_sdk__pure_fir_extractor	face_sdk__pure_fir_extractor_t
	Module allows to extract pure data from FIRs. Pure data can be used to implement manual matching, ecnryption, serialization, etc... Use face_sdk__make_pure_fir_extractor() functions to instantiate pure_fir_extractor object.

Functions
bool	face_sdk__pure_fir_extractor__get_addr (const face_sdk__pure_fir_extractor_t *pure_fir_extractor, uint64_t *addr)
	Retrieves face_sdk__pure_fir_extractor_t object address * *. More...
bool	face_sdk__pure_fir_extractor__extract_from_long (const face_sdk__pure_fir_extractor_t *handle, const face_sdk__fir_t *fir, float *buff, uint32_t *buf_size)
	Extracts pure data from long FIRs. Fir is long if it is not short and not binary. Use face_sdk__fir__is_short() and face_sdk__fir__is_binary() functions to determine which type of fir is. More...
bool	face_sdk__pure_fir_extractor__extract_from_short_or_binary (const face_sdk__pure_fir_extractor_t *handle, const face_sdk__fir_t *fir, int8_t *buff, uint32_t *buf_size)
	Extracts pure data from short or binary FIRs. Use face_sdk__fir__is_short() and face_sdk__fir__is_binary() functions to determine which type of fir is. Caller is resposibile for buffer allocation/deallocation. See face_sdk__pure_fir_extractor__extract_from_long to how to determine requred buffer size. More...
bool	face_sdk__make_pure_fir_extractor (face_sdk__pure_fir_extractor_t **handle)
	Makes face_sdk__pure_fir_extractor with default license. [out] handle face_sdk__pure_fir_extractor handle. More...
bool	face_sdk__make_pure_fir_extractor1 (const face_sdk__license_t *license, face_sdk__pure_fir_extractor_t **handle)
	Makes face_sdk__pure_fir_extractor with specified license. More...
void	face_sdk__pure_fir_extractor_free (face_sdk__pure_fir_extractor_t *handle)
	Destroys face_sdk__pure_fir_extractor object. More...

Variables
const int	pure_fir_extractor_not_enough_buffer_error_code = 1051

Detailed Description

Function Documentation

face_sdk__make_pure_fir_extractor()

bool face_sdk__make_pure_fir_extractor

(

face_sdk__pure_fir_extractor_t **

handle

)

Makes face_sdk__pure_fir_extractor with default license.
[out] handle face_sdk__pure_fir_extractor handle.

Returns

true on success, false on failure. See last_error

face_sdk__make_pure_fir_extractor1()

bool face_sdk__make_pure_fir_extractor1	(	const face_sdk__license_t *	license,
		face_sdk__pure_fir_extractor_t **	handle
	)

Makes face_sdk__pure_fir_extractor with specified license.

Parameters

[in]	license	face_sdk__license handle.
[out]	handle	face_sdk__pure_fir_extractor handle.

Returns

true on success, false on failure. See last_error

face_sdk__pure_fir_extractor__extract_from_long()

bool face_sdk__pure_fir_extractor__extract_from_long	(	const face_sdk__pure_fir_extractor_t *	handle,
		const face_sdk__fir_t *	fir,
		float *	buff,
		uint32_t *	buf_size
	)

Extracts pure data from long FIRs. Fir is long if it is not short and not binary. Use face_sdk__fir__is_short() and face_sdk__fir__is_binary() functions to determine which type of fir is.

Caller is resposibile for buffer allocation/deallocation.
Call face_sdk__pure_fir_extractor__extract_from_long() with buff = 0 to determine what size of buffer is required to store extracted data.
The method writes required buffer size in buf_size parameter in such case.

Parameters

[in]	handle	face_sdk__pure_fir_extractor handle made by face_sdk__make_pure_fir_extractor.
[in]	fir	face_sdk__fir handle made by face_sdk__builder__build or deserialized by face_sdk__serializer__deserialize_fir.
[out]	buff	output buffer where extrated data will be stored.
[in,out]	buf_size	(in elements) specify buff size on input. The method write actual buffer size on output.

Returns

true on success, false on failure. See last_error

face_sdk__pure_fir_extractor__extract_from_short_or_binary()

bool face_sdk__pure_fir_extractor__extract_from_short_or_binary	(	const face_sdk__pure_fir_extractor_t *	handle,
		const face_sdk__fir_t *	fir,
		int8_t *	buff,
		uint32_t *	buf_size
	)

Extracts pure data from short or binary FIRs. Use face_sdk__fir__is_short() and face_sdk__fir__is_binary() functions to determine which type of fir is. Caller is resposibile for buffer allocation/deallocation. See face_sdk__pure_fir_extractor__extract_from_long to how to determine requred buffer size.

Parameters

[in]	handle	face_sdk__pure_fir_extractor handle made by face_sdk__make_pure_fir_extractor.
[in]	fir	face_sdk__fir handle made by face_sdk__builder__build or deserialized by face_sdk__serializer__deserialize_fir.
[out]	buff	output buffer where extrated data will be stored.
[in,out]	buf_size	specify buff size on input. The method write actual buffer size on output.

Returns

true on success, false on failure. See last_error

face_sdk__pure_fir_extractor__get_addr()

bool face_sdk__pure_fir_extractor__get_addr	(	const face_sdk__pure_fir_extractor_t *	pure_fir_extractor,
		uint64_t *	addr
	)

Retrieves face_sdk__pure_fir_extractor_t object address * *.

Parameters

[in]	pure_fir_extractor	face_sdk__pure_fir_extractor_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__pure_fir_extractor_free()

void face_sdk__pure_fir_extractor_free

(

face_sdk__pure_fir_extractor_t *

handle

)

Destroys face_sdk__pure_fir_extractor object.

Parameters

[in]

handle

face_sdk__pure_fir_extractor object