xran_compression.h File Reference

External API for compading with the use BFP algorithm. More...

#include <stdint.h>

Include dependency graph for xran_compression.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	xranlib_compress_request
	Request structure containing pointer to data and its length. More...
struct	xranlib_compress_response
	Response structure containing pointer to data and its length. More...
struct	xranlib_decompress_request
	Request structure containing pointer to data and its length. More...
struct	xranlib_decompress_response
	Response structure containing pointer to data and its length. More...

Functions
int16_t	xranlib_companding_version (char *version, int buffer_size)
	Report the version number for the xranlib_companding library. More...
int	xranlib_compress (const struct xranlib_compress_request *request, struct xranlib_compress_response *response)
	Compress functions - it converts a 16-bit linear PCM value to 8-bt A-law. More...
int	xranlib_compress_sse (const struct xranlib_compress_request *request, struct xranlib_compress_response *response)
int	xranlib_compress_avx2 (const struct xranlib_compress_request *request, struct xranlib_compress_response *response)
int	xranlib_compress_avx512 (const struct xranlib_compress_request *request, struct xranlib_compress_response *response)
int	xranlib_compress_avx512_bfw (const struct xranlib_compress_request *request, struct xranlib_compress_response *response)
int	xranlib_decompress (const struct xranlib_decompress_request *request, struct xranlib_decompress_response *response)
	Decompress function - it converts an A-law value to 16-bit linear PCM. More...
int	xranlib_decompress_sse (const struct xranlib_decompress_request *request, struct xranlib_decompress_response *response)
int	xranlib_decompress_avx2 (const struct xranlib_decompress_request *request, struct xranlib_decompress_response *response)
int	xranlib_decompress_avx512 (const struct xranlib_decompress_request *request, struct xranlib_decompress_response *response)

Detailed Description

External API for compading with the use BFP algorithm.

Definition in file xran_compression.h.

Function Documentation

xranlib_companding_version()

int16_t xranlib_companding_version	(	char *	version,
		int	buffer_size
	)

Report the version number for the xranlib_companding library.

Parameters

[in]	version	Pointer to a char buffer where the version string should be copied.
[in]	buffer_size	The length of the string buffer, must be at least xranlib_SDK_VERSION_STRING_MAX_LEN characters.

Returns

0 if the version string was populated, otherwise -1.

xranlib_compress()

int xranlib_compress	(	const struct xranlib_compress_request *	request,
		struct xranlib_compress_response *	response
	)

Compress functions - it converts a 16-bit linear PCM value to 8-bt A-law.

Parameters

[in]	request	Structure containing the input data and data length.
[out]	response	Structure containing the output data and data length.

Returns

0 for success, -1 for error

xranlib_compress_avx2()

int xranlib_compress_avx2	(	const struct xranlib_compress_request *	request,
		struct xranlib_compress_response *	response
	)

xranlib_compress_avx512()

int xranlib_compress_avx512	(	const struct xranlib_compress_request *	request,
		struct xranlib_compress_response *	response
	)

Definition at line 729 of file xran_compression.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

xranlib_compress_avx512_bfw()

int xranlib_compress_avx512_bfw	(	const struct xranlib_compress_request *	request,
		struct xranlib_compress_response *	response
	)

Definition at line 783 of file xran_compression.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

xranlib_compress_sse()

int xranlib_compress_sse	(	const struct xranlib_compress_request *	request,
		struct xranlib_compress_response *	response
	)

xranlib_decompress()

int xranlib_decompress	(	const struct xranlib_decompress_request *	request,
		struct xranlib_decompress_response *	response
	)

Decompress function - it converts an A-law value to 16-bit linear PCM.

Parameters

[in]	request	Structure containing the input data and data length.
[out]	response	Structure containing the output data and data length.

Returns

0 for success, -1 for error.

xranlib_decompress_avx2()

int xranlib_decompress_avx2	(	const struct xranlib_decompress_request *	request,
		struct xranlib_decompress_response *	response
	)

xranlib_decompress_avx512()

int xranlib_decompress_avx512	(	const struct xranlib_decompress_request *	request,
		struct xranlib_decompress_response *	response
	)

Definition at line 834 of file xran_compression.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

xranlib_decompress_sse()

int xranlib_decompress_sse	(	const struct xranlib_decompress_request *	request,
		struct xranlib_decompress_response *	response
	)