c interface

Classes
struct	face_sdk__image_compressor
	The image_compressor. Can be used to compress and/or decompress images. More...

Typedefs
typedef struct face_sdk__image_compressor	face_sdk__image_compressor_t
	The image_compressor. Can be used to compress and/or decompress images. More...

Enumerations
enum	face_sdk__compression_level_t : uint32_t {   _1 = 1, _2, _3, _4,   _5 }
	Level of compression used in compress_image function. More...

Functions
bool	face_sdk__image_compressor__get_addr (const face_sdk__image_compressor_t *image_compressor, uint64_t *addr)
	Retrieves face_sdk__image_compressor_t object address * *. More...
bool	face_sdk__image_compressor__compress_image (const face_sdk__image_compressor_t *image_compressor, const face_sdk__image_t *image, enum face_sdk__compression_level_t lvl, uint8_t **image_data, uint64_t *image_data_size)
	Performs image compression. More...
bool	face_sdk__image_compressor__decompress_image (const face_sdk__image_compressor_t *image_compressor, const uint8_t *image_data, uint64_t image_data_size, face_sdk__image_t **image)
	Performs image decompression. More...
bool	face_sdk__make_image_compressor (uint32_t version, face_sdk__image_compressor_t **image_compressor)
	Makes an image_compressor with specified version. More...
bool	face_sdk__make_image_compressor_1 (uint32_t version, const face_sdk__license_t *license, face_sdk__image_compressor_t **image_compressor)
	Makes an image_compressor with specified version and license. More...
void	face_sdk__image_compressor_free (face_sdk__image_compressor_t *image_compressor)
	Destroys face_sdk__image_compressor object. More...

Detailed Description

Module classifies image quality.

Typedef Documentation

face_sdk__image_compressor_t

typedef struct face_sdk__image_compressor face_sdk__image_compressor_t

The image_compressor. Can be used to compress and/or decompress images.

Use face_sdk__make_image_compressor() function to instantiate an image_compressor object

Enumeration Type Documentation

face_sdk__compression_level_t

enum face_sdk__compression_level_t : uint32_t

Level of compression used in compress_image function.

_1 means less size with smaller quality and _5 means bigger size, but higher quality.

Function Documentation

face_sdk__image_compressor__compress_image()

bool face_sdk__image_compressor__compress_image	(	const face_sdk__image_compressor_t *	image_compressor,
		const face_sdk__image_t *	image,
		enum face_sdk__compression_level_t	lvl,
		uint8_t **	image_data,
		uint64_t *	image_data_size
	)

Performs image compression.

Parameters

[in]	image_compressor	Image compressor object made with face_sdk__make_image_compressor() function
[in]	image	Image object
[out]	image_data	Compressed image binary data
[out]	image_data_size	Size of data stored in image_data

Returns

true on success, false on failure. See last_error

face_sdk__image_compressor__decompress_image()

bool face_sdk__image_compressor__decompress_image	(	const face_sdk__image_compressor_t *	image_compressor,
		const uint8_t *	image_data,
		uint64_t	image_data_size,
		face_sdk__image_t **	image
	)

Performs image decompression.

Parameters

[in]	image_compressor	Image compressor object made with face_sdk__make_image_compressor() function
[in]	image_data	Compressed image binary data obtained with face_sdk__compress_image() function
[in]	image_data_size	Size of data stored in image_data
[out]	image	Decompressed image object

Returns

true on success, false on failure. See last_error

face_sdk__image_compressor__get_addr()

bool face_sdk__image_compressor__get_addr	(	const face_sdk__image_compressor_t *	image_compressor,
		uint64_t *	addr
	)

Retrieves face_sdk__image_compressor_t object address * *.

Parameters

[in]	image_compressor	face_sdk__image_compressor_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__image_compressor_free()

void face_sdk__image_compressor_free

(

face_sdk__image_compressor_t *

image_compressor

)

Destroys face_sdk__image_compressor object.

Parameters

[in]

image_compressor

Image compressor object made with face_sdk__make_image_compressor() function

face_sdk__make_image_compressor()

bool face_sdk__make_image_compressor	(	uint32_t	version,
		face_sdk__image_compressor_t **	image_compressor
	)

Makes an image_compressor with specified version.

Parameters

[in]	version	Required version of the algorithm. See Image Smart Compression versions.
[out]	image_compressor	Image compressor object

Returns

true on success, false on failure. See last_error

face_sdk__make_image_compressor_1()

bool face_sdk__make_image_compressor_1	(	uint32_t	version,
		const face_sdk__license_t *	license,
		face_sdk__image_compressor_t **	image_compressor
	)

Makes an image_compressor with specified version and license.

Parameters

[in]	version	Required version of the algorithm. See Image Smart Compression versions
[in]	license	The license object. See Licensing
[out]	image_compressor	Image compressor object

Returns

true on success, false on failure. See last_error