huf.h File Reference

#include <stddef.h>

Include dependency graph for huf.h:

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

Go to the source code of this file.

Macros
#define	HUF_H_298734234
#define	HUF_PUBLIC_API
#define	HUF_BLOCKSIZE_MAX   (128 * 1024)
#define	HUF_WORKSPACE_SIZE   ((6 << 10) + 256)
#define	HUF_WORKSPACE_SIZE_U32   (HUF_WORKSPACE_SIZE / sizeof(U32))

Functions
HUF_PUBLIC_API size_t	HUF_compress (void *dst, size_t dstCapacity, const void *src, size_t srcSize)
HUF_PUBLIC_API size_t	HUF_decompress (void *dst, size_t originalSize, const void *cSrc, size_t cSrcSize)
HUF_PUBLIC_API size_t	HUF_compressBound (size_t size)
HUF_PUBLIC_API unsigned	HUF_isError (size_t code)
HUF_PUBLIC_API const char *	HUF_getErrorName (size_t code)
HUF_PUBLIC_API size_t	HUF_compress2 (void *dst, size_t dstCapacity, const void *src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog)
HUF_PUBLIC_API size_t	HUF_compress4X_wksp (void *dst, size_t dstCapacity, const void *src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void *workSpace, size_t wkspSize)

Macro Definition Documentation

HUF_BLOCKSIZE_MAX

#define HUF_BLOCKSIZE_MAX   (128 * 1024)

maximum input size for a single block compressed with HUF_compress

Definition at line 72 of file huf.h.

HUF_H_298734234

#define HUF_H_298734234

Definition at line 20 of file huf.h.

HUF_PUBLIC_API

#define HUF_PUBLIC_API

Definition at line 37 of file huf.h.

HUF_WORKSPACE_SIZE

#define HUF_WORKSPACE_SIZE   ((6 << 10) + 256)

HUF_compress4X_wksp() : Same as HUF_compress2(), but uses externally allocated workSpace. workspace must have minimum alignment of 4, and be at least as large as HUF_WORKSPACE_SIZE

Definition at line 93 of file huf.h.

HUF_WORKSPACE_SIZE_U32

#define HUF_WORKSPACE_SIZE_U32   (HUF_WORKSPACE_SIZE / sizeof(U32))

Definition at line 94 of file huf.h.

Function Documentation

HUF_compress()

HUF_PUBLIC_API size_t HUF_compress	(	void *	dst,
		size_t	dstCapacity,
		const void *	src,
		size_t	srcSize
	)

HUF_compress() : Compress content from buffer 'src', of size 'srcSize', into buffer 'dst'. 'dst' buffer must be already allocated. Compression runs faster if dstCapacity >= HUF_compressBound(srcSize). srcSize must be <= HUF_BLOCKSIZE_MAX == 128 KB.

Returns

: size of compressed data (<= dstCapacity). Special values : if return == 0, srcData is not compressible => Nothing is stored within dst !!! if HUF_isError(return), compression failed (more details using HUF_getErrorName())

Definition at line 795 of file huf_compress.c.

{
    return HUF_compress2(dst, maxDstSize, src, srcSize, 255, HUF_TABLELOG_DEFAULT);
}

HUF_compress2()

HUF_PUBLIC_API size_t HUF_compress2	(	void *	dst,
		size_t	dstCapacity,
		const void *	src,
		size_t	srcSize,
		unsigned	maxSymbolValue,
		unsigned	tableLog
	)

HUF_compress2() : Same as HUF_compress(), but offers control over maxSymbolValue and tableLog. maxSymbolValue must be <= HUF_SYMBOLVALUE_MAX . tableLog must be <= HUF_TABLELOG_MAX .

Definition at line 787 of file huf_compress.c.

{
    unsigned workSpace[HUF_WORKSPACE_SIZE_U32];
    return HUF_compress4X_wksp(dst, dstSize, src, srcSize, maxSymbolValue, huffLog, workSpace, sizeof(workSpace));
}

Referenced by HUF_compress().

HUF_compress4X_wksp()

HUF_PUBLIC_API size_t HUF_compress4X_wksp	(	void *	dst,
		size_t	dstCapacity,
		const void *	src,
		size_t	srcSize,
		unsigned	maxSymbolValue,
		unsigned	tableLog,
		void *	workSpace,
		size_t	wkspSize
	)

Definition at line 761 of file huf_compress.c.

{
    return HUF_compress_internal(dst, dstSize, src, srcSize,
                                 maxSymbolValue, huffLog, HUF_fourStreams,
                                 workSpace, wkspSize,
                                 NULL, NULL, 0, 0 /*bmi2*/);
}

Referenced by HUF_compress2().

HUF_compressBound()

HUF_PUBLIC_API size_t HUF_compressBound

(

size_t

size

)

maximum compressed size (worst case)

Definition at line 441 of file huf_compress.c.

{ return HUF_COMPRESSBOUND(size); }

HUF_decompress()

HUF_PUBLIC_API size_t HUF_decompress	(	void *	dst,
		size_t	originalSize,
		const void *	cSrc,
		size_t	cSrcSize
	)

HUF_decompress() : Decompress HUF data from buffer 'cSrc', of size 'cSrcSize', into already allocated buffer 'dst', of minimum size 'dstSize'. originalSize : must be the exact size of original (uncompressed) data. Note : in contrast with FSE, HUF_decompress can regenerate RLE (cSrcSize==1) and uncompressed (cSrcSize==dstSize) data, because it knows size to regenerate (originalSize).

Returns

: size of regenerated data (== originalSize), or an error code, which can be tested using HUF_isError()

Definition at line 1056 of file huf_decompress.c.

{
#if !defined(HUF_FORCE_DECOMPRESS_X1) && !defined(HUF_FORCE_DECOMPRESS_X2)
    static const decompressionAlgo decompress[2] = { HUF_decompress4X1, HUF_decompress4X2 };
#endif
 
    /* validation checks */
    if (dstSize == 0) return ERROR(dstSize_tooSmall);
    if (cSrcSize > dstSize) return ERROR(corruption_detected);   /* invalid */
    if (cSrcSize == dstSize) { memcpy(dst, cSrc, dstSize); return dstSize; }   /* not compressed */
    if (cSrcSize == 1) { memset(dst, *(const BYTE*)cSrc, dstSize); return dstSize; }   /* RLE */
 
    {   U32 const algoNb = HUF_selectDecoder(dstSize, cSrcSize);
#if defined(HUF_FORCE_DECOMPRESS_X1)
        (void)algoNb;
        assert(algoNb == 0);
        return HUF_decompress4X1(dst, dstSize, cSrc, cSrcSize);
#elif defined(HUF_FORCE_DECOMPRESS_X2)
        (void)algoNb;
        assert(algoNb == 1);
        return HUF_decompress4X2(dst, dstSize, cSrc, cSrcSize);
#else
        return decompress[algoNb](dst, dstSize, cSrc, cSrcSize);
#endif
    }
}

HUF_getErrorName()

HUF_PUBLIC_API const char * HUF_getErrorName

(

size_t

code

)

provides error code string (useful for debugging)

Definition at line 35 of file entropy_common.c.

{ return ERR_getErrorName(code); }

HUF_isError()

HUF_PUBLIC_API unsigned HUF_isError

(

size_t

code

)

tells if a return value is an error code

Definition at line 34 of file entropy_common.c.

{ return ERR_isError(code); }