fse_decompress.c File Reference

#include "debug.h"
#include "bitstream.h"
#include "compiler.h"
#include "fse.h"
#include "error_private.h"
#include "zstd_deps.h"

Data Structures
struct	FSE_DecompressWksp

Macros
#define	FSE_STATIC_LINKING_ONLY
#define	ZSTD_DEPS_NEED_MALLOC
#define	FSE_isError   ERR_isError
#define	FSE_STATIC_ASSERT(c)
#define	FSE_CAT(X, Y)
#define	FSE_FUNCTION_NAME(X, Y)
#define	FSE_TYPE_NAME(X, Y)
#define	FSE_GETSYMBOL(statePtr)

Typedefs
typedef FSE_DTable	DTable_max_t[FSE_DTABLE_SIZE_U32(FSE_MAX_TABLELOG)]

Functions
FSE_DTable *	FSE_createDTable (unsigned tableLog)
void	FSE_freeDTable (FSE_DTable *dt)
size_t	FSE_buildDTable_wksp (FSE_DTable *dt, const short *normalizedCounter, unsigned maxSymbolValue, unsigned tableLog, void *workSpace, size_t wkspSize)
size_t	FSE_buildDTable_rle (FSE_DTable *dt, BYTE symbolValue)
size_t	FSE_buildDTable_raw (FSE_DTable *dt, unsigned nbBits)
FORCE_INLINE_TEMPLATE size_t	FSE_decompress_usingDTable_generic (void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize, const FSE_DTable *dt, const unsigned fast)
size_t	FSE_decompress_usingDTable (void *dst, size_t originalSize, const void *cSrc, size_t cSrcSize, const FSE_DTable *dt)
size_t	FSE_decompress_wksp (void *dst, size_t dstCapacity, const void *cSrc, size_t cSrcSize, unsigned maxLog, void *workSpace, size_t wkspSize)
FORCE_INLINE_TEMPLATE size_t	FSE_decompress_wksp_body (void *dst, size_t dstCapacity, const void *cSrc, size_t cSrcSize, unsigned maxLog, void *workSpace, size_t wkspSize, int bmi2)
size_t	FSE_decompress_wksp_bmi2 (void *dst, size_t dstCapacity, const void *cSrc, size_t cSrcSize, unsigned maxLog, void *workSpace, size_t wkspSize, int bmi2)
size_t	FSE_buildDTable (FSE_DTable *dt, const short *normalizedCounter, unsigned maxSymbolValue, unsigned tableLog)
size_t	FSE_decompress (void *dst, size_t dstCapacity, const void *cSrc, size_t cSrcSize)

Macro Definition Documentation

FSE_CAT

#define FSE_CAT	(		X,
			Y )

Value:

X##Y

FSE_FUNCTION_NAME

#define FSE_FUNCTION_NAME	(		X,
			Y )

Value:

FSE_CAT(X,Y)

FSE_GETSYMBOL

#define FSE_GETSYMBOL

(

statePtr

)

Value:

fast ? FSE_decodeSymbolFast(statePtr, &bitD) : FSE_decodeSymbol(statePtr, &bitD)

FSE_isError

#define FSE_isError   ERR_isError

FSE_STATIC_ASSERT

#define FSE_STATIC_ASSERT

(

c

)

Value:

DEBUG_STATIC_ASSERT(c)   /* use only *after* variable declarations */

FSE_STATIC_LINKING_ONLY

#define FSE_STATIC_LINKING_ONLY

FSE_TYPE_NAME

#define FSE_TYPE_NAME	(		X,
			Y )

Value:

FSE_CAT(X,Y)

ZSTD_DEPS_NEED_MALLOC

#define ZSTD_DEPS_NEED_MALLOC

Typedef Documentation

DTable_max_t

typedef U32 DTable_max_t[FSEv07_DTABLE_SIZE_U32(FSEv07_MAX_TABLELOG)]

Function Documentation

FSE_buildDTable()

size_t FSE_buildDTable	(	FSE_DTable *	dt,
		const short *	normalizedCounter,
		unsigned	maxSymbolValue,
		unsigned	tableLog )

FSE_buildDTable(): Builds 'dt', which must be already allocated, using FSE_createDTable(). return : 0, or an errorCode, which can be tested using FSE_isError()

FSE_buildDTable_raw()

static size_t FSE_buildDTable_raw	(	FSE_DTable *	dt,
		unsigned	nbBits )

FSE_buildDTable_rle()

static size_t FSE_buildDTable_rle	(	FSE_DTable *	dt,
		BYTE	symbolValue )

FSE_buildDTable_wksp()

size_t FSE_buildDTable_wksp	(	FSE_DTable *	dt,
		const short *	normalizedCounter,
		unsigned	maxSymbolValue,
		unsigned	tableLog,
		void *	workSpace,
		size_t	wkspSize )

FSE_createDTable()

FSE_DTable * FSE_createDTable

(

unsigned

tableLog

)

FSE_decompress()

size_t FSE_decompress	(	void *	dst,
		size_t	dstCapacity,
		const void *	cSrc,
		size_t	cSrcSize )

FSE_decompress(): Decompress FSE data from buffer 'cSrc', of size 'cSrcSize', into already allocated destination buffer 'dst', of size 'dstCapacity'.

Returns

: size of regenerated data (<= maxDstSize), or an error code, which can be tested using FSE_isError() .

Important ** : FSE_decompress() does not decompress non-compressible nor RLE data !!! Why ? : making this distinction requires a header. Header management is intentionally delegated to the user layer, which can better manage special cases.

FSE_decompress_usingDTable()

size_t FSE_decompress_usingDTable	(	void *	dst,
		size_t	originalSize,
		const void *	cSrc,
		size_t	cSrcSize,
		const FSE_DTable *	dt )

FSE_decompress_usingDTable(): Decompress compressed source cSrc of size cSrcSize using dt into dst which must be already allocated.

Returns

: size of regenerated data (necessarily <= dstCapacity), or an errorCode, which can be tested using FSE_isError()

FSE_decompress_usingDTable_generic()

FORCE_INLINE_TEMPLATE size_t FSE_decompress_usingDTable_generic	(	void *	dst,
		size_t	maxDstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		const FSE_DTable *	dt,
		const unsigned	fast )

FSE_decompress_wksp()

size_t FSE_decompress_wksp	(	void *	dst,
		size_t	dstCapacity,
		const void *	cSrc,
		size_t	cSrcSize,
		unsigned	maxLog,
		void *	workSpace,
		size_t	wkspSize )

FSE_decompress_wksp_bmi2()

size_t FSE_decompress_wksp_bmi2	(	void *	dst,
		size_t	dstCapacity,
		const void *	cSrc,
		size_t	cSrcSize,
		unsigned	maxLog,
		void *	workSpace,
		size_t	wkspSize,
		int	bmi2 )

FSE_decompress_wksp_body()

FORCE_INLINE_TEMPLATE size_t FSE_decompress_wksp_body	(	void *	dst,
		size_t	dstCapacity,
		const void *	cSrc,
		size_t	cSrcSize,
		unsigned	maxLog,
		void *	workSpace,
		size_t	wkspSize,
		int	bmi2 )

FSE_freeDTable()

void FSE_freeDTable

(

FSE_DTable *

dt

)