114 lines
7.5 KiB
C
114 lines
7.5 KiB
C
|
|
|
|
/* *** library symbols visibility *** */
|
|
/* Note : when linking with -fvisibility=hidden on gcc, or by default on Visual,
|
|
* HUF symbols remain "private" (internal symbols for library only).
|
|
* Set macro FSE_DLL_EXPORT to 1 if you want HUF symbols visible on DLL interface */
|
|
#if defined(FSE_DLL_EXPORT) && (FSE_DLL_EXPORT==1) && defined(__GNUC__) && (__GNUC__ >= 4)
|
|
# define HUF_PUBLIC_API __attribute__ ((visibility ("default")))
|
|
#elif defined(FSE_DLL_EXPORT) && (FSE_DLL_EXPORT==1) /* Visual expected */
|
|
# define HUF_PUBLIC_API __declspec(dllexport)
|
|
#elif defined(FSE_DLL_IMPORT) && (FSE_DLL_IMPORT==1)
|
|
# define HUF_PUBLIC_API __declspec(dllimport) /* not required, just to generate faster code (saves a function pointer load from IAT and an indirect jump) */
|
|
#else
|
|
# define HUF_PUBLIC_API
|
|
#endif
|
|
|
|
|
|
/* ========================== */
|
|
/* *** simple functions *** */
|
|
/* ========================== */
|
|
|
|
/** 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.
|
|
* @return : 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())
|
|
*/
|
|
HUF_PUBLIC_API size_t HUF_compress(void* dst, size_t dstCapacity,
|
|
const void* src, size_t srcSize);
|
|
|
|
/** 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).
|
|
* @return : size of regenerated data (== originalSize),
|
|
* or an error code, which can be tested using HUF_isError()
|
|
*/
|
|
HUF_PUBLIC_API size_t HUF_decompress(void* dst, size_t originalSize,
|
|
const void* cSrc, size_t cSrcSize);
|
|
|
|
#define HUF_BLOCKSIZE_MAX (128 * 1024) /**< maximum input size for a single block compressed with HUF_compress */
|
|
HUF_PUBLIC_API size_t HUF_compressBound(size_t size); /**< maximum compressed size (worst case) */
|
|
HUF_PUBLIC_API unsigned HUF_isError(size_t code); /**< tells if a return value is an error code */
|
|
HUF_PUBLIC_API const char* HUF_getErrorName(size_t code); /**< provides error code string (useful for debugging) */
|
|
|
|
/** 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` . */
|
|
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);
|
|
#define HUF_H_HUF_STATIC_LINKING_ONLY
|
|
|
|
#define HUF_TABLELOG_MAX 12 /* max runtime value of tableLog (due to static allocation); can be modified up to HUF_TABLELOG_ABSOLUTEMAX */
|
|
|
|
size_t HUF_decompress4X1 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< single-symbol decoder */
|
|
#ifndef HUF_FORCE_DECOMPRESS_X1
|
|
size_t HUF_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< double-symbols decoder */
|
|
#endif
|
|
|
|
size_t HUF_decompress4X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< decodes RLE and uncompressed */
|
|
size_t HUF_decompress4X_hufOnly(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< considers RLE and uncompressed as errors */
|
|
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); /**< considers RLE and uncompressed as errors */
|
|
size_t HUF_decompress4X1_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< single-symbol decoder */
|
|
size_t HUF_decompress4X1_DCtx_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize); /**< single-symbol decoder */
|
|
#ifndef HUF_FORCE_DECOMPRESS_X1
|
|
size_t HUF_decompress4X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< double-symbols decoder */
|
|
size_t HUF_decompress4X2_DCtx_wksp(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize); /**< double-symbols decoder */
|
|
#endif
|
|
|
|
size_t HUF_buildCTable (HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue, unsigned maxNbBits); /* @return : maxNbBits; CTable and count can overlap. In which case, CTable will overwrite count content */
|
|
size_t HUF_writeCTable (void* dst, size_t maxDstSize, const HUF_CElt* CTable, unsigned maxSymbolValue, unsigned huffLog);
|
|
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);
|
|
|
|
#define HUF_CTABLE_WORKSPACE_SIZE_U32 ((4 * (HUF_SYMBOLVALUE_MAX + 1)) + 192)
|
|
|
|
#ifndef HUF_FORCE_DECOMPRESS_X2
|
|
size_t HUF_readDTableX1 (HUF_DTable* DTable, const void* src, size_t srcSize);
|
|
size_t HUF_readDTableX1_wksp (HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize);
|
|
#endif
|
|
#ifndef HUF_FORCE_DECOMPRESS_X1
|
|
size_t HUF_readDTableX2 (HUF_DTable* DTable, const void* src, size_t srcSize);
|
|
size_t HUF_readDTableX2_wksp (HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize);
|
|
#endif
|
|
|
|
size_t HUF_decompress4X_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
|
|
#ifndef HUF_FORCE_DECOMPRESS_X2
|
|
size_t HUF_decompress4X1_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
|
|
#endif
|
|
#ifndef HUF_FORCE_DECOMPRESS_X1
|
|
size_t HUF_decompress4X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
|
|
#endif
|
|
|
|
size_t HUF_compress1X (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog);
|
|
size_t HUF_compress1X_wksp (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void* workSpace, size_t wkspSize); /**< `workSpace` must be a table of at least HUF_WORKSPACE_SIZE_U64 U64 */
|
|
size_t HUF_compress1X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable);
|
|
size_t HUF_compress1X_usingCTable_bmi2(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable, int bmi2);
|
|
|
|
#define ZSTD_malloc(s) malloc(s)
|
|
#define ZSTD_calloc(n,s) calloc((n), (s))
|
|
#define ZSTD_free(p) free((p))
|