lz4hc.h File Reference

Go to the source code of this file.

Classes
struct	LZ4HC_CCtx_internal
union	LZ4_streamHC_u

Macros
#define	LZ4HC_CLEVEL_MIN   3
#define	LZ4HC_CLEVEL_DEFAULT   9
#define	LZ4HC_CLEVEL_OPT_MIN   11
#define	LZ4HC_CLEVEL_MAX   12
#define	LZ4HC_DICTIONARY_LOGSIZE   17
#define	LZ4HC_MAXD   (1<<LZ4HC_DICTIONARY_LOGSIZE)
#define	LZ4HC_MAXD_MASK   (LZ4HC_MAXD - 1)
#define	LZ4HC_HASH_LOG   15
#define	LZ4HC_HASHTABLESIZE   (1 << LZ4HC_HASH_LOG)
#define	LZ4HC_HASH_MASK   (LZ4HC_HASHTABLESIZE - 1)
#define	LZ4_STREAMHCSIZE   (4*LZ4HC_HASHTABLESIZE + 2*LZ4HC_MAXD + 56) /* 393268 */
#define	LZ4_STREAMHCSIZE_SIZET   (LZ4_STREAMHCSIZE / sizeof(size_t))

Typedefs
typedef union LZ4_streamHC_u	LZ4_streamHC_t

Functions
LZ4LIB_API int	LZ4_compress_HCStatic (const char *src, char *dst, int srcSize, int dstCapacity, int compressionLevel)
LZ4LIB_API int	LZ4_compress_HC_extStateHC (void *state, const char *src, char *dst, int srcSize, int maxDstSize, int compressionLevel)
LZ4LIB_API int	LZ4_sizeofStateHC (void)
LZ4LIB_API LZ4_streamHC_t *	LZ4_createStreamHC (void)
LZ4LIB_API int	LZ4_freeStreamHC (LZ4_streamHC_t *streamHCPtr)
LZ4LIB_API void	LZ4_resetStreamHC (LZ4_streamHC_t *streamHCPtr, int compressionLevel)
LZ4LIB_API int	LZ4_loadDictHC (LZ4_streamHC_t *streamHCPtr, const char *dictionary, int dictSize)
LZ4LIB_API int	LZ4_compress_HC_continue (LZ4_streamHC_t *streamHCPtr, const char *src, char *dst, int srcSize, int maxDstSize)
LZ4LIB_API int	LZ4_saveDictHC (LZ4_streamHC_t *streamHCPtr, char *safeBuffer, int maxDictSize)
	LZ4_DEPRECATED ("use LZ4_compress_HC() instead") int LZ4_compressHC(const char *source
	LZ4_DEPRECATED ("use LZ4_compress_HC_extStateHC() instead") int LZ4_compressHC_withStateHC(void *state
	LZ4_DEPRECATED ("use LZ4_compress_HC_continue() instead") int LZ4_compressHC_continue(LZ4_streamHC_t *LZ4_streamHCPtr
	LZ4_DEPRECATED ("use LZ4_createStreamHC() instead") void *LZ4_createHC(char *inputBuffer)
	LZ4_DEPRECATED ("use LZ4_saveDictHC() instead") char *LZ4_slideInputBufferHC(void *LZ4HC_Data)
	LZ4_DEPRECATED ("use LZ4_freeStreamHC() instead") int LZ4_freeHC(void *LZ4HC_Data)
	LZ4_DEPRECATED ("use LZ4_resetStreamHC() instead") int LZ4_resetStreamStateHC(void *state

Variables
char *	dest
char int	inputSize
char int int	maxOutputSize
char int int	compressionLevel
const char *	source
char *	inputBuffer

Macro Definition Documentation

#define LZ4HC_CLEVEL_MIN   3

#define LZ4HC_CLEVEL_DEFAULT   9

#define LZ4HC_CLEVEL_OPT_MIN   11

#define LZ4HC_CLEVEL_MAX   12

#define LZ4HC_DICTIONARY_LOGSIZE   17

#define LZ4HC_MAXD   (1<<LZ4HC_DICTIONARY_LOGSIZE)

#define LZ4HC_MAXD_MASK   (LZ4HC_MAXD - 1)

#define LZ4HC_HASH_LOG   15

#define LZ4HC_HASHTABLESIZE   (1 << LZ4HC_HASH_LOG)

#define LZ4HC_HASH_MASK   (LZ4HC_HASHTABLESIZE - 1)

#define LZ4_STREAMHCSIZE   (4*LZ4HC_HASHTABLESIZE + 2*LZ4HC_MAXD + 56) /* 393268 */

#define LZ4_STREAMHCSIZE_SIZET   (LZ4_STREAMHCSIZE / sizeof(size_t))

Typedef Documentation

typedef union LZ4_streamHC_u LZ4_streamHC_t

Function Documentation

LZ4LIB_API int LZ4_compress_HCStatic	(	const char *	src,
		char *	dst,
		int	srcSize,
		int	dstCapacity,
		int	compressionLevel
	)

LZ4_compress_HC() : Compress data from src into dst, using the more powerful but slower "HC" algorithm. dst must be already allocated. Compression is guaranteed to succeed if dstCapacity >= LZ4_compressBound(srcSize) (see "lz4.h") Max supported srcSize value is LZ4_MAX_INPUT_SIZE (see "lz4.h") compressionLevel : Recommended values are between 4 and 9, although any value between 1 and LZ4HC_MAX_CLEVEL will work. Values >LZ4HC_MAX_CLEVEL behave the same as LZ4HC_MAX_CLEVEL.

Returns

: the number of bytes written into 'dst' or 0 if compression fails.

LZ4LIB_API int LZ4_compress_HC_extStateHC	(	void *	state,
		const char *	src,
		char *	dst,
		int	srcSize,
		int	maxDstSize,
		int	compressionLevel
	)

LZ4_compress_HC_extStateHC() : Same as LZ4_compress_HC(), but using an externally allocated memory segment for state. state size is provided by LZ4_sizeofStateHC(). Memory segment must be aligned on 8-bytes boundaries (which a normal malloc() will do properly).

LZ4LIB_API int LZ4_sizeofStateHC

(

void

)

LZ4LIB_API LZ4_streamHC_t* LZ4_createStreamHC

(

void

)

LZ4_createStreamHC() and LZ4_freeStreamHC() : These functions create and release memory for LZ4 HC streaming state. Newly created states are automatically initialized. Existing states can be re-used several times, using LZ4_resetStreamHC(). These methods are API and ABI stable, they can be used in combination with a DLL.

LZ4LIB_API int LZ4_freeStreamHC

(

LZ4_streamHC_t *

streamHCPtr

)

LZ4LIB_API void LZ4_resetStreamHC	(	LZ4_streamHC_t *	streamHCPtr,
		int	compressionLevel
	)

LZ4LIB_API int LZ4_loadDictHC	(	LZ4_streamHC_t *	streamHCPtr,
		const char *	dictionary,
		int	dictSize
	)

LZ4LIB_API int LZ4_compress_HC_continue	(	LZ4_streamHC_t *	streamHCPtr,
		const char *	src,
		char *	dst,
		int	srcSize,
		int	maxDstSize
	)

LZ4LIB_API int LZ4_saveDictHC	(	LZ4_streamHC_t *	streamHCPtr,
		char *	safeBuffer,
		int	maxDictSize
	)

LZ4_DEPRECATED

(

"use LZ4_compress_HC() instead"

)

const

LZ4_DEPRECATED

(

"use LZ4_compress_HC_extStateHC() instead"

)

LZ4_DEPRECATED

(

"use LZ4_compress_HC_continue() instead"

)

LZ4_DEPRECATED

(

"use LZ4_createStreamHC() instead"

)

LZ4_DEPRECATED

(

"use LZ4_saveDictHC() instead"

)

LZ4_DEPRECATED

(

"use LZ4_freeStreamHC() instead"

)

LZ4_DEPRECATED

(

"use LZ4_resetStreamHC() instead"

)

Variable Documentation

const char char* dest

const char char int inputSize

const char char int int maxOutputSize

const char char int int int compressionLevel

const char* source

char* inputBuffer