#include "zstd_deps.h"
#include "mem.h"
#include "fse.h"

Include dependency graph for huf.h:

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

Classes
struct	HUF_CTableHeader

Macros
#define	HUF_H_298734234

#define	FSE_STATIC_LINKING_ONLY

#define	HUF_BLOCKSIZE_MAX (128 * 1024)

#define	HUF_WORKSPACE_SIZE ((8 << 10) + 512 /* sorting scratch space */)

#define	HUF_WORKSPACE_SIZE_U64 (HUF_WORKSPACE_SIZE / sizeof(U64))

#define	HUF_TABLELOG_MAX 12 /* max runtime value of tableLog (due to static allocation); can be modified up to HUF_TABLELOG_ABSOLUTEMAX */

#define	HUF_TABLELOG_DEFAULT 11 /* default tableLog value when none specified */

#define	HUF_SYMBOLVALUE_MAX 255

#define	HUF_TABLELOG_ABSOLUTEMAX 12 /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */

#define	HUF_CTABLEBOUND 129

#define	HUF_BLOCKBOUND(size) (size + (size>>8) + 8) /* only true when incompressible is pre-filtered with fast heuristic */

#define	HUF_COMPRESSBOUND(size) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size)) /* Macro version, useful for static allocation */

#define	HUF_CTABLE_SIZE_ST(maxSymbolValue) ((maxSymbolValue)+2) /* Use tables of size_t, for proper alignment */

#define	HUF_CTABLE_SIZE(maxSymbolValue) (HUF_CTABLE_SIZE_ST(maxSymbolValue) * sizeof(size_t))

#define	HUF_CREATE_STATIC_CTABLE(name, maxSymbolValue) HUF_CElt name[HUF_CTABLE_SIZE_ST(maxSymbolValue)] /* no final ; */

#define	HUF_DTABLE_SIZE(maxTableLog) (1 + (1<<(maxTableLog)))

#define	HUF_CREATE_STATIC_DTABLEX1(DTable, maxTableLog) HUF_DTable DTable[HUF_DTABLE_SIZE((maxTableLog)-1)] = { ((U32)((maxTableLog)-1) * 0x01000001) }

#define	HUF_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) HUF_DTable DTable[HUF_DTABLE_SIZE(maxTableLog)] = { ((U32)(maxTableLog) * 0x01000001) }

#define	HUF_OPTIMAL_DEPTH_THRESHOLD ZSTD_btultra

#define	HUF_CTABLE_WORKSPACE_SIZE_U32 ((4 * (HUF_SYMBOLVALUE_MAX + 1)) + 192)

#define	HUF_CTABLE_WORKSPACE_SIZE (HUF_CTABLE_WORKSPACE_SIZE_U32 * sizeof(unsigned))

#define	HUF_READ_STATS_WORKSPACE_SIZE_U32 FSE_DECOMPRESS_WKSP_SIZE_U32(6, HUF_TABLELOG_MAX-1)

#define	HUF_READ_STATS_WORKSPACE_SIZE (HUF_READ_STATS_WORKSPACE_SIZE_U32 * sizeof(unsigned))

#define	HUF_DECOMPRESS_WORKSPACE_SIZE ((2 << 10) + (1 << 9))

#define	HUF_DECOMPRESS_WORKSPACE_SIZE_U32 (HUF_DECOMPRESS_WORKSPACE_SIZE / sizeof(U32))

Typedefs
typedef size_t	HUF_CElt

typedef U32	HUF_DTable

Enumerations
enum	HUF_flags_e { HUF_flags_bmi2 = (1 << 0) , HUF_flags_optimalDepth = (1 << 1) , HUF_flags_preferRepeat = (1 << 2) , HUF_flags_suspectUncompressible = (1 << 3) , HUF_flags_disableAsm = (1 << 4) , HUF_flags_disableFast = (1 << 5) }

enum	HUF_repeat { HUF_repeat_none , HUF_repeat_check , HUF_repeat_valid }

Functions
size_t	HUF_compressBound (size_t size)

unsigned	HUF_isError (size_t code)

const char *	HUF_getErrorName (size_t code)

unsigned	HUF_minTableLog (unsigned symbolCardinality)

unsigned	HUF_cardinality (const unsigned *count, unsigned maxSymbolValue)

unsigned	HUF_optimalTableLog (unsigned maxTableLog, size_t srcSize, unsigned maxSymbolValue, void workSpace, size_t wkspSize, HUF_CElt table, const unsigned *count, int flags)

size_t	HUF_writeCTable_wksp (void dst, size_t maxDstSize, const HUF_CElt CTable, unsigned maxSymbolValue, unsigned huffLog, void *workspace, size_t workspaceSize)

size_t	HUF_compress4X_usingCTable (void dst, size_t dstSize, const void src, size_t srcSize, const HUF_CElt *CTable, int flags)

size_t	HUF_estimateCompressedSize (const HUF_CElt CTable, const unsigned count, unsigned maxSymbolValue)

int	HUF_validateCTable (const HUF_CElt CTable, const unsigned count, unsigned maxSymbolValue)

size_t	HUF_compress4X_repeat (void dst, size_t dstSize, const void src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void workSpace, size_t wkspSize, HUF_CElt hufTable, HUF_repeat *repeat, int flags)

size_t	HUF_buildCTable_wksp (HUF_CElt tree, const unsigned count, U32 maxSymbolValue, U32 maxNbBits, void *workSpace, size_t wkspSize)

size_t	HUF_readStats (BYTE huffWeight, size_t hwSize, U32 rankStats, U32 nbSymbolsPtr, U32 tableLogPtr, const void *src, size_t srcSize)

size_t	HUF_readStats_wksp (BYTE huffWeight, size_t hwSize, U32 rankStats, U32 nbSymbolsPtr, U32 tableLogPtr, const void src, size_t srcSize, void workspace, size_t wkspSize, int flags)

size_t	HUF_readCTable (HUF_CElt CTable, unsigned maxSymbolValuePtr, const void src, size_t srcSize, unsigned hasZeroWeights)

U32	HUF_getNbBitsFromCTable (const HUF_CElt *symbolTable, U32 symbolValue)

HUF_CTableHeader	HUF_readCTableHeader (HUF_CElt const *ctable)

U32	HUF_selectDecoder (size_t dstSize, size_t cSrcSize)

size_t	HUF_compress1X_usingCTable (void dst, size_t dstSize, const void src, size_t srcSize, const HUF_CElt *CTable, int flags)

size_t	HUF_compress1X_repeat (void dst, size_t dstSize, const void src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void workSpace, size_t wkspSize, HUF_CElt hufTable, HUF_repeat *repeat, int flags)

size_t	HUF_decompress1X_DCtx_wksp (HUF_DTable dctx, void dst, size_t dstSize, const void cSrc, size_t cSrcSize, void workSpace, size_t wkspSize, int flags)

size_t	HUF_decompress1X2_DCtx_wksp (HUF_DTable dctx, void dst, size_t dstSize, const void cSrc, size_t cSrcSize, void workSpace, size_t wkspSize, int flags)

size_t	HUF_decompress1X_usingDTable (void dst, size_t maxDstSize, const void cSrc, size_t cSrcSize, const HUF_DTable *DTable, int flags)

size_t	HUF_decompress1X1_DCtx_wksp (HUF_DTable dctx, void dst, size_t dstSize, const void cSrc, size_t cSrcSize, void workSpace, size_t wkspSize, int flags)

size_t	HUF_decompress4X_usingDTable (void dst, size_t maxDstSize, const void cSrc, size_t cSrcSize, const HUF_DTable *DTable, int flags)

size_t	HUF_decompress4X_hufOnly_wksp (HUF_DTable dctx, void dst, size_t dstSize, const void cSrc, size_t cSrcSize, void workSpace, size_t wkspSize, int flags)

size_t	HUF_readDTableX1_wksp (HUF_DTable DTable, const void src, size_t srcSize, void *workSpace, size_t wkspSize, int flags)

size_t	HUF_readDTableX2_wksp (HUF_DTable DTable, const void src, size_t srcSize, void *workSpace, size_t wkspSize, int flags)

Macro Definition Documentation

◆ FSE_STATIC_LINKING_ONLY

#define FSE_STATIC_LINKING_ONLY

Definition at line 25 of file huf.h.

◆ HUF_BLOCKBOUND

#define HUF_BLOCKBOUND ( size ) (size + (size>>8) + 8) /* only true when incompressible is pre-filtered with fast heuristic */

Definition at line 57 of file huf.h.

◆ HUF_BLOCKSIZE_MAX

#define HUF_BLOCKSIZE_MAX (128 * 1024)

maximum input size for a single block compressed with HUF_compress

Definition at line 30 of file huf.h.

◆ HUF_COMPRESSBOUND

#define HUF_COMPRESSBOUND ( size ) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size)) /* Macro version, useful for static allocation */

Definition at line 58 of file huf.h.

◆ HUF_CREATE_STATIC_CTABLE

#define HUF_CREATE_STATIC_CTABLE	(	name,
		maxSymbolValue
	)	HUF_CElt name[HUF_CTABLE_SIZE_ST(maxSymbolValue)] /* no final ; */

Definition at line 65 of file huf.h.

◆ HUF_CREATE_STATIC_DTABLEX1

#define HUF_CREATE_STATIC_DTABLEX1	(	DTable,
		maxTableLog
	)	HUF_DTable DTable[HUF_DTABLE_SIZE((maxTableLog)-1)] = { ((U32)((maxTableLog)-1) * 0x01000001) }

Definition at line 71 of file huf.h.

◆ HUF_CREATE_STATIC_DTABLEX2

#define HUF_CREATE_STATIC_DTABLEX2	(	DTable,
		maxTableLog
	)	HUF_DTable DTable[HUF_DTABLE_SIZE(maxTableLog)] = { ((U32)(maxTableLog) * 0x01000001) }

Definition at line 73 of file huf.h.

◆ HUF_CTABLE_SIZE

#define HUF_CTABLE_SIZE ( maxSymbolValue ) (HUF_CTABLE_SIZE_ST(maxSymbolValue) * sizeof(size_t))

Definition at line 64 of file huf.h.

◆ HUF_CTABLE_SIZE_ST

#define HUF_CTABLE_SIZE_ST ( maxSymbolValue ) ((maxSymbolValue)+2) /* Use tables of size_t, for proper alignment */

Definition at line 63 of file huf.h.

◆ HUF_CTABLE_WORKSPACE_SIZE

#define HUF_CTABLE_WORKSPACE_SIZE (HUF_CTABLE_WORKSPACE_SIZE_U32 * sizeof(unsigned))

Definition at line 167 of file huf.h.

◆ HUF_CTABLE_WORKSPACE_SIZE_U32

#define HUF_CTABLE_WORKSPACE_SIZE_U32 ((4 * (HUF_SYMBOLVALUE_MAX + 1)) + 192)

HUF_buildCTable_wksp() : Same as HUF_buildCTable(), but using externally allocated scratch buffer. workSpace must be aligned on 4-bytes boundaries, and its size must be >= HUF_CTABLE_WORKSPACE_SIZE.

Definition at line 166 of file huf.h.

◆ HUF_CTABLEBOUND

#define HUF_CTABLEBOUND 129

Definition at line 56 of file huf.h.

◆ HUF_DECOMPRESS_WORKSPACE_SIZE

#define HUF_DECOMPRESS_WORKSPACE_SIZE ((2 << 10) + (1 << 9))

The minimum workspace size for the workSpace used in HUF_readDTableX1_wksp() and HUF_readDTableX2_wksp().

The space used depends on HUF_TABLELOG_MAX, ranging from ~1500 bytes when HUF_TABLE_LOG_MAX=12 to ~1850 bytes when HUF_TABLE_LOG_MAX=15. Buffer overflow errors may potentially occur if code modifications result in a required workspace size greater than that specified in the following macro.

Definition at line 240 of file huf.h.

◆ HUF_DECOMPRESS_WORKSPACE_SIZE_U32

#define HUF_DECOMPRESS_WORKSPACE_SIZE_U32 (HUF_DECOMPRESS_WORKSPACE_SIZE / sizeof(U32))

Definition at line 241 of file huf.h.

◆ HUF_DTABLE_SIZE

#define HUF_DTABLE_SIZE ( maxTableLog ) (1 + (1<<(maxTableLog)))

Definition at line 70 of file huf.h.

◆ HUF_H_298734234

#define HUF_H_298734234

Definition at line 20 of file huf.h.

◆ HUF_OPTIMAL_DEPTH_THRESHOLD

#define HUF_OPTIMAL_DEPTH_THRESHOLD ZSTD_btultra

Definition at line 122 of file huf.h.

◆ HUF_READ_STATS_WORKSPACE_SIZE

#define HUF_READ_STATS_WORKSPACE_SIZE (HUF_READ_STATS_WORKSPACE_SIZE_U32 * sizeof(unsigned))

Definition at line 187 of file huf.h.

◆ HUF_READ_STATS_WORKSPACE_SIZE_U32

#define HUF_READ_STATS_WORKSPACE_SIZE_U32 FSE_DECOMPRESS_WKSP_SIZE_U32(6, HUF_TABLELOG_MAX-1)

HUF_readStats_wksp() : Same as HUF_readStats() but takes an external workspace which must be 4-byte aligned and its size must be >= HUF_READ_STATS_WORKSPACE_SIZE. If the CPU has BMI2 support, pass bmi2=1, otherwise pass bmi2=0.

Definition at line 186 of file huf.h.

◆ HUF_SYMBOLVALUE_MAX

#define HUF_SYMBOLVALUE_MAX 255

Definition at line 44 of file huf.h.

◆ HUF_TABLELOG_ABSOLUTEMAX

#define HUF_TABLELOG_ABSOLUTEMAX 12 /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */

Definition at line 46 of file huf.h.

◆ HUF_TABLELOG_DEFAULT

#define HUF_TABLELOG_DEFAULT 11 /* default tableLog value when none specified */

Definition at line 43 of file huf.h.

◆ HUF_TABLELOG_MAX

#define HUF_TABLELOG_MAX 12 /* max runtime value of tableLog (due to static allocation); can be modified up to HUF_TABLELOG_ABSOLUTEMAX */

Definition at line 42 of file huf.h.

◆ HUF_WORKSPACE_SIZE

#define HUF_WORKSPACE_SIZE ((8 << 10) + 512 /* sorting scratch space */)

Definition at line 38 of file huf.h.

◆ HUF_WORKSPACE_SIZE_U64

#define HUF_WORKSPACE_SIZE_U64 (HUF_WORKSPACE_SIZE / sizeof(U64))

Definition at line 39 of file huf.h.

Typedef Documentation

◆ HUF_CElt

typedef size_t HUF_CElt

Definition at line 62 of file huf.h.

◆ HUF_DTable

typedef U32 HUF_DTable

Definition at line 69 of file huf.h.

Enumeration Type Documentation

◆ HUF_flags_e

enum HUF_flags_e

Huffman flags bitset. For all flags, 0 is the default value.

Enumerator
HUF_flags_bmi2	If compiled with DYNAMIC_BMI2: Set flag only if the CPU supports BMI2 at runtime. Otherwise: Ignored.
HUF_flags_optimalDepth	If set: Test possible table depths to find the one that produces the smallest header + encoded size. If unset: Use heuristic to find the table depth.
HUF_flags_preferRepeat	If set: If the previous table can encode the input, always reuse the previous table. If unset: If the previous table can encode the input, reuse the previous table if it results in a smaller output.
HUF_flags_suspectUncompressible	If set: Sample the input and check if the sample is uncompressible, if it is then don't attempt to compress. If unset: Always histogram the entire input.
HUF_flags_disableAsm	If set: Don't use assembly implementations If unset: Allow using assembly implementations
HUF_flags_disableFast	If set: Don't use the fast decoding loop, always use the fallback decoding loop. If unset: Use the fast decoding loop when possible.

Definition at line 85 of file huf.h.

◆ HUF_repeat

enum HUF_repeat

Enumerator
HUF_repeat_none	Cannot use the previous table
HUF_repeat_check	Can use the previous table but it must be checked. Note : The previous table must have been constructed by HUF_compress{1, 4}X_repeat
HUF_repeat_valid	Can use the previous table and it is assumed to be valid

Definition at line 144 of file huf.h.

Function Documentation

◆ HUF_buildCTable_wksp()

size_t HUF_buildCTable_wksp	(	HUF_CElt *	tree,
		const unsigned *	count,
		U32	maxSymbolValue,
		U32	maxNbBits,
		void *	workSpace,
		size_t	wkspSize
	)

Definition at line 756 of file huf_compress.c.

Here is the caller graph for this function:

◆ HUF_cardinality()

unsigned HUF_cardinality	(	const unsigned *	count,
		unsigned	maxSymbolValue
	)

Definition at line 1254 of file huf_compress.c.

Here is the caller graph for this function:

◆ HUF_compress1X_repeat()

size_t HUF_compress1X_repeat	(	void *	dst,
		size_t	dstSize,
		const void *	src,
		size_t	srcSize,
		unsigned	maxSymbolValue,
		unsigned	tableLog,
		void *	workSpace,
		size_t	wkspSize,
		HUF_CElt *	hufTable,
		HUF_repeat *	repeat,
		int	flags
	)

HUF_compress1X_repeat() : Same as HUF_compress1X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none. If it uses hufTable it does not modify hufTable or repeat. If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used. If preferRepeat then the old table will always be used if valid. If suspectUncompressible then some sampling checks will be run to potentially skip huffman coding

Parameters

wkspSize workSpace must be aligned on 4-bytes boundaries, wkspSize must be >= HUF_WORKSPACE_SIZE

Definition at line 1436 of file huf_compress.c.

Here is the caller graph for this function:

◆ HUF_compress1X_usingCTable()

size_t HUF_compress1X_usingCTable	(	void *	dst,
		size_t	dstSize,
		const void *	src,
		size_t	srcSize,
		const HUF_CElt *	CTable,
		int	flags
	)

Definition at line 1162 of file huf_compress.c.

◆ HUF_compress4X_repeat()

size_t HUF_compress4X_repeat	(	void *	dst,
		size_t	dstSize,
		const void *	src,
		size_t	srcSize,
		unsigned	maxSymbolValue,
		unsigned	tableLog,
		void *	workSpace,
		size_t	wkspSize,
		HUF_CElt *	hufTable,
		HUF_repeat *	repeat,
		int	flags
	)

HUF_compress4X_repeat() : Same as HUF_compress4X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none. If it uses hufTable it does not modify hufTable or repeat. If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used. If preferRepeat then the old table will always be used if valid. If suspectUncompressible then some sampling checks will be run to potentially skip huffman coding

Parameters

wkspSize workSpace must be aligned on 4-bytes boundaries, wkspSize must be >= HUF_WORKSPACE_SIZE

Definition at line 1453 of file huf_compress.c.

Here is the caller graph for this function:

◆ HUF_compress4X_usingCTable()

size_t HUF_compress4X_usingCTable	(	void *	dst,
		size_t	dstSize,
		const void *	src,
		size_t	srcSize,
		const HUF_CElt *	CTable,
		int	flags
	)

Definition at line 1217 of file huf_compress.c.

◆ HUF_compressBound()

size_t HUF_compressBound ( size_t size )

maximum compressed size (worst case)

Definition at line 821 of file huf_compress.c.

◆ HUF_decompress1X1_DCtx_wksp()

size_t HUF_decompress1X1_DCtx_wksp	(	HUF_DTable *	dctx,
		void *	dst,
		size_t	dstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		void *	workSpace,
		size_t	wkspSize,
		int	flags
	)

Definition at line 1894 of file huf_decompress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_decompress1X2_DCtx_wksp()

size_t HUF_decompress1X2_DCtx_wksp	(	HUF_DTable *	dctx,
		void *	dst,
		size_t	dstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		void *	workSpace,
		size_t	wkspSize,
		int	flags
	)

double-symbols decoder

Definition at line 1754 of file huf_decompress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_decompress1X_DCtx_wksp()

size_t HUF_decompress1X_DCtx_wksp	(	HUF_DTable *	dctx,
		void *	dst,
		size_t	dstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		void *	workSpace,
		size_t	wkspSize,
		int	flags
	)

Definition at line 1845 of file huf_decompress.c.

Here is the call graph for this function:

◆ HUF_decompress1X_usingDTable()

size_t HUF_decompress1X_usingDTable	(	void *	dst,
		size_t	maxDstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		const HUF_DTable *	DTable,
		int	flags
	)

Definition at line 1876 of file huf_decompress.c.

◆ HUF_decompress4X_hufOnly_wksp()

size_t HUF_decompress4X_hufOnly_wksp	(	HUF_DTable *	dctx,
		void *	dst,
		size_t	dstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		void *	workSpace,
		size_t	wkspSize,
		int	flags
	)

Definition at line 1924 of file huf_decompress.c.

Here is the call graph for this function:

◆ HUF_decompress4X_usingDTable()

size_t HUF_decompress4X_usingDTable	(	void *	dst,
		size_t	maxDstSize,
		const void *	cSrc,
		size_t	cSrcSize,
		const HUF_DTable *	DTable,
		int	flags
	)

Definition at line 1907 of file huf_decompress.c.

◆ HUF_estimateCompressedSize()

size_t HUF_estimateCompressedSize	(	const HUF_CElt *	CTable,
		const unsigned *	count,
		unsigned	maxSymbolValue
	)

Definition at line 793 of file huf_compress.c.

Here is the caller graph for this function:

◆ HUF_getErrorName()

const char * HUF_getErrorName ( size_t code )

provides error code string (useful for debugging)

Definition at line 35 of file entropy_common.c.

Here is the call graph for this function:

◆ HUF_getNbBitsFromCTable()

U32 HUF_getNbBitsFromCTable	(	const HUF_CElt *	symbolTable,
		U32	symbolValue
	)

HUF_getNbBitsFromCTable() : Read nbBits from CTable symbolTable, for symbol symbolValue presumed <= HUF_SYMBOLVALUE_MAX Note 1 : If symbolValue > HUF_readCTableHeader(symbolTable).maxSymbolValue, returns 0 Note 2 : is not inlined, as HUF_CElt definition is private

Definition at line 345 of file huf_compress.c.

Here is the call graph for this function:

◆ HUF_isError()

unsigned HUF_isError ( size_t code )

tells if a return value is an error code

◆ HUF_minTableLog()

unsigned HUF_minTableLog ( unsigned symbolCardinality )

HUF_compress() does the following:

count symbol occurrence from source[] into table count[] using FSE_count() (exposed within "fse.h")
(optional) refine tableLog using HUF_optimalTableLog()
build Huffman table from count using HUF_buildCTable()
save Huffman table to memory buffer using HUF_writeCTable()
encode the data stream using HUF_compress4X_usingCTable()

The following API allows targeting specific sub-functions for advanced tasks. For example, it's possible to compress several blocks using the same 'CTable', or to save and regenerate 'CTable' using external methods.

Definition at line 1266 of file huf_compress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_optimalTableLog()

unsigned HUF_optimalTableLog	(	unsigned	maxTableLog,
		size_t	srcSize,
		unsigned	maxSymbolValue,
		void *	workSpace,
		size_t	wkspSize,
		HUF_CElt *	table,
		const unsigned *	count,
		int	flags
	)

Definition at line 1272 of file huf_compress.c.

Here is the call graph for this function:

◆ HUF_readCTable()

size_t HUF_readCTable	(	HUF_CElt *	CTable,
		unsigned *	maxSymbolValuePtr,
		const void *	src,
		size_t	srcSize,
		unsigned *	hasZeroWeights
	)

HUF_readCTable() : Loading a CTable saved with HUF_writeCTable()

Definition at line 292 of file huf_compress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_readCTableHeader()

HUF_CTableHeader HUF_readCTableHeader ( HUF_CElt const * ctable )

HUF_readCTableHeader() :

Returns: The header from the CTable specifying the tableLog and the maxSymbolValue.

Definition at line 223 of file huf_compress.c.

Here is the caller graph for this function:

◆ HUF_readDTableX1_wksp()

size_t HUF_readDTableX1_wksp	(	HUF_DTable *	DTable,
		const void *	src,
		size_t	srcSize,
		void *	workSpace,
		size_t	wkspSize,
		int	flags
	)

Definition at line 385 of file huf_decompress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_readDTableX2_wksp()

size_t HUF_readDTableX2_wksp	(	HUF_DTable *	DTable,
		const void *	src,
		size_t	srcSize,
		void *	workSpace,
		size_t	wkspSize,
		int	flags
	)

Definition at line 1179 of file huf_decompress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_readStats()

size_t HUF_readStats	(	BYTE *	huffWeight,
		size_t	hwSize,
		U32 *	rankStats,
		U32 *	nbSymbolsPtr,
		U32 *	tableLogPtr,
		const void *	src,
		size_t	srcSize
	)

HUF_readStats() : Read compact Huffman tree, saved by HUF_writeCTable(). huffWeight is destination buffer.

Returns: : size read from src , or an error Code . Note : Needed by HUF_readCTable() and HUF_readDTableXn() .

HUF_readStats() : Read compact Huffman tree, saved by HUF_writeCTable(). huffWeight is destination buffer. rankStats is assumed to be a table of at least HUF_TABLELOG_MAX U32.

Returns: : size read from src , or an error Code . Note : Needed by HUF_readCTable() and HUF_readDTableX?() .

Definition at line 234 of file entropy_common.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HUF_readStats_wksp()

size_t HUF_readStats_wksp	(	BYTE *	huffWeight,
		size_t	hwSize,
		U32 *	rankStats,
		U32 *	nbSymbolsPtr,
		U32 *	tableLogPtr,
		const void *	src,
		size_t	srcSize,
		void *	workspace,
		size_t	wkspSize,
		int	flags
	)

Definition at line 327 of file entropy_common.c.

Here is the caller graph for this function:

◆ HUF_selectDecoder()

U32 HUF_selectDecoder	(	size_t	dstSize,
		size_t	cSrcSize
	)

HUF_selectDecoder() : Tells which decoder is likely to decode faster, based on a set of pre-computed metrics.

Returns: : 0==HUF_decompress4X1, 1==HUF_decompress4X2 . Assumption : 0 < dstSize <= 128 KB

Definition at line 1821 of file huf_decompress.c.

Here is the caller graph for this function:

◆ HUF_validateCTable()

int HUF_validateCTable	(	const HUF_CElt *	CTable,
		const unsigned *	count,
		unsigned	maxSymbolValue
	)

Definition at line 804 of file huf_compress.c.

Here is the call graph for this function:

◆ HUF_writeCTable_wksp()

size_t HUF_writeCTable_wksp	(	void *	dst,
		size_t	maxDstSize,
		const HUF_CElt *	CTable,
		unsigned	maxSymbolValue,
		unsigned	huffLog,
		void *	workspace,
		size_t	workspaceSize
	)

Definition at line 248 of file huf_compress.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Classes

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ FSE_STATIC_LINKING_ONLY

◆ HUF_BLOCKBOUND

◆ HUF_BLOCKSIZE_MAX

◆ HUF_COMPRESSBOUND

◆ HUF_CREATE_STATIC_CTABLE

◆ HUF_CREATE_STATIC_DTABLEX1

◆ HUF_CREATE_STATIC_DTABLEX2

◆ HUF_CTABLE_SIZE

◆ HUF_CTABLE_SIZE_ST

◆ HUF_CTABLE_WORKSPACE_SIZE

◆ HUF_CTABLE_WORKSPACE_SIZE_U32

◆ HUF_CTABLEBOUND

◆ HUF_DECOMPRESS_WORKSPACE_SIZE

◆ HUF_DECOMPRESS_WORKSPACE_SIZE_U32

◆ HUF_DTABLE_SIZE

◆ HUF_H_298734234

◆ HUF_OPTIMAL_DEPTH_THRESHOLD

◆ HUF_READ_STATS_WORKSPACE_SIZE

◆ HUF_READ_STATS_WORKSPACE_SIZE_U32

◆ HUF_SYMBOLVALUE_MAX

◆ HUF_TABLELOG_ABSOLUTEMAX

◆ HUF_TABLELOG_DEFAULT

◆ HUF_TABLELOG_MAX

◆ HUF_WORKSPACE_SIZE

◆ HUF_WORKSPACE_SIZE_U64

Typedef Documentation

◆ HUF_CElt

◆ HUF_DTable

Enumeration Type Documentation

◆ HUF_flags_e

◆ HUF_repeat

Function Documentation

◆ HUF_buildCTable_wksp()

◆ HUF_cardinality()

◆ HUF_compress1X_repeat()

◆ HUF_compress1X_usingCTable()

◆ HUF_compress4X_repeat()

◆ HUF_compress4X_usingCTable()

◆ HUF_compressBound()

◆ HUF_decompress1X1_DCtx_wksp()

◆ HUF_decompress1X2_DCtx_wksp()

◆ HUF_decompress1X_DCtx_wksp()

◆ HUF_decompress1X_usingDTable()

◆ HUF_decompress4X_hufOnly_wksp()

◆ HUF_decompress4X_usingDTable()

◆ HUF_estimateCompressedSize()

◆ HUF_getErrorName()

◆ HUF_getNbBitsFromCTable()

◆ HUF_isError()

◆ HUF_minTableLog()

◆ HUF_optimalTableLog()

◆ HUF_readCTable()

◆ HUF_readCTableHeader()

◆ HUF_readDTableX1_wksp()

◆ HUF_readDTableX2_wksp()

◆ HUF_readStats()

◆ HUF_readStats_wksp()

◆ HUF_selectDecoder()

◆ HUF_validateCTable()

◆ HUF_writeCTable_wksp()