10c16b537SWarner Losh /* ****************************************************************** 237f1f268SConrad Meyer * huff0 huffman codec, 337f1f268SConrad Meyer * part of Finite State Entropy library 45ff13fbcSAllan Jude * Copyright (c) Yann Collet, Facebook, Inc. 537f1f268SConrad Meyer * 637f1f268SConrad Meyer * You can contact the author at : 737f1f268SConrad Meyer * - Source repository : https://github.com/Cyan4973/FiniteStateEntropy 837f1f268SConrad Meyer * 937f1f268SConrad Meyer * This source code is licensed under both the BSD-style license (found in the 1037f1f268SConrad Meyer * LICENSE file in the root directory of this source tree) and the GPLv2 (found 1137f1f268SConrad Meyer * in the COPYING file in the root directory of this source tree). 1237f1f268SConrad Meyer * You may select, at your option, one of the above-listed licenses. 130c16b537SWarner Losh ****************************************************************** */ 140c16b537SWarner Losh 150c16b537SWarner Losh #if defined (__cplusplus) 160c16b537SWarner Losh extern "C" { 170c16b537SWarner Losh #endif 180c16b537SWarner Losh 190c16b537SWarner Losh #ifndef HUF_H_298734234 200c16b537SWarner Losh #define HUF_H_298734234 210c16b537SWarner Losh 220c16b537SWarner Losh /* *** Dependencies *** */ 23f7cd7fe5SConrad Meyer #include "zstd_deps.h" /* size_t */ 240c16b537SWarner Losh 250c16b537SWarner Losh 260c16b537SWarner Losh /* *** library symbols visibility *** */ 270c16b537SWarner Losh /* Note : when linking with -fvisibility=hidden on gcc, or by default on Visual, 280c16b537SWarner Losh * HUF symbols remain "private" (internal symbols for library only). 290c16b537SWarner Losh * Set macro FSE_DLL_EXPORT to 1 if you want HUF symbols visible on DLL interface */ 300c16b537SWarner Losh #if defined(FSE_DLL_EXPORT) && (FSE_DLL_EXPORT==1) && defined(__GNUC__) && (__GNUC__ >= 4) 310c16b537SWarner Losh # define HUF_PUBLIC_API __attribute__ ((visibility ("default"))) 320c16b537SWarner Losh #elif defined(FSE_DLL_EXPORT) && (FSE_DLL_EXPORT==1) /* Visual expected */ 330c16b537SWarner Losh # define HUF_PUBLIC_API __declspec(dllexport) 340c16b537SWarner Losh #elif defined(FSE_DLL_IMPORT) && (FSE_DLL_IMPORT==1) 350c16b537SWarner Losh # define HUF_PUBLIC_API __declspec(dllimport) /* not required, just to generate faster code (saves a function pointer load from IAT and an indirect jump) */ 360c16b537SWarner Losh #else 370c16b537SWarner Losh # define HUF_PUBLIC_API 380c16b537SWarner Losh #endif 390c16b537SWarner Losh 400c16b537SWarner Losh 4119fcbaf1SConrad Meyer /* ========================== */ 420c16b537SWarner Losh /* *** simple functions *** */ 4319fcbaf1SConrad Meyer /* ========================== */ 4419fcbaf1SConrad Meyer 4519fcbaf1SConrad Meyer /** HUF_compress() : 4619fcbaf1SConrad Meyer * Compress content from buffer 'src', of size 'srcSize', into buffer 'dst'. 4719fcbaf1SConrad Meyer * 'dst' buffer must be already allocated. 4819fcbaf1SConrad Meyer * Compression runs faster if `dstCapacity` >= HUF_compressBound(srcSize). 4919fcbaf1SConrad Meyer * `srcSize` must be <= `HUF_BLOCKSIZE_MAX` == 128 KB. 5019fcbaf1SConrad Meyer * @return : size of compressed data (<= `dstCapacity`). 5119fcbaf1SConrad Meyer * Special values : if return == 0, srcData is not compressible => Nothing is stored within dst !!! 5219fcbaf1SConrad Meyer * if HUF_isError(return), compression failed (more details using HUF_getErrorName()) 530c16b537SWarner Losh */ 540c16b537SWarner Losh HUF_PUBLIC_API size_t HUF_compress(void* dst, size_t dstCapacity, 550c16b537SWarner Losh const void* src, size_t srcSize); 560c16b537SWarner Losh 5719fcbaf1SConrad Meyer /** HUF_decompress() : 5819fcbaf1SConrad Meyer * Decompress HUF data from buffer 'cSrc', of size 'cSrcSize', 5919fcbaf1SConrad Meyer * into already allocated buffer 'dst', of minimum size 'dstSize'. 6019fcbaf1SConrad Meyer * `originalSize` : **must** be the ***exact*** size of original (uncompressed) data. 6119fcbaf1SConrad Meyer * Note : in contrast with FSE, HUF_decompress can regenerate 6219fcbaf1SConrad Meyer * RLE (cSrcSize==1) and uncompressed (cSrcSize==dstSize) data, 6319fcbaf1SConrad Meyer * because it knows size to regenerate (originalSize). 6419fcbaf1SConrad Meyer * @return : size of regenerated data (== originalSize), 6519fcbaf1SConrad Meyer * or an error code, which can be tested using HUF_isError() 660c16b537SWarner Losh */ 670c16b537SWarner Losh HUF_PUBLIC_API size_t HUF_decompress(void* dst, size_t originalSize, 680c16b537SWarner Losh const void* cSrc, size_t cSrcSize); 690c16b537SWarner Losh 700c16b537SWarner Losh 710c16b537SWarner Losh /* *** Tool functions *** */ 720c16b537SWarner Losh #define HUF_BLOCKSIZE_MAX (128 * 1024) /**< maximum input size for a single block compressed with HUF_compress */ 730c16b537SWarner Losh HUF_PUBLIC_API size_t HUF_compressBound(size_t size); /**< maximum compressed size (worst case) */ 740c16b537SWarner Losh 750c16b537SWarner Losh /* Error Management */ 760c16b537SWarner Losh HUF_PUBLIC_API unsigned HUF_isError(size_t code); /**< tells if a return value is an error code */ 770c16b537SWarner Losh HUF_PUBLIC_API const char* HUF_getErrorName(size_t code); /**< provides error code string (useful for debugging) */ 780c16b537SWarner Losh 790c16b537SWarner Losh 800c16b537SWarner Losh /* *** Advanced function *** */ 810c16b537SWarner Losh 820c16b537SWarner Losh /** HUF_compress2() : 8319fcbaf1SConrad Meyer * Same as HUF_compress(), but offers control over `maxSymbolValue` and `tableLog`. 8419fcbaf1SConrad Meyer * `maxSymbolValue` must be <= HUF_SYMBOLVALUE_MAX . 850c16b537SWarner Losh * `tableLog` must be `<= HUF_TABLELOG_MAX` . */ 8619fcbaf1SConrad Meyer HUF_PUBLIC_API size_t HUF_compress2 (void* dst, size_t dstCapacity, 8719fcbaf1SConrad Meyer const void* src, size_t srcSize, 8819fcbaf1SConrad Meyer unsigned maxSymbolValue, unsigned tableLog); 890c16b537SWarner Losh 900c16b537SWarner Losh /** HUF_compress4X_wksp() : 910c16b537SWarner Losh * Same as HUF_compress2(), but uses externally allocated `workSpace`. 925ff13fbcSAllan Jude * `workspace` must be at least as large as HUF_WORKSPACE_SIZE */ 935ff13fbcSAllan Jude #define HUF_WORKSPACE_SIZE ((8 << 10) + 512 /* sorting scratch space */) 945ff13fbcSAllan Jude #define HUF_WORKSPACE_SIZE_U64 (HUF_WORKSPACE_SIZE / sizeof(U64)) 9519fcbaf1SConrad Meyer HUF_PUBLIC_API size_t HUF_compress4X_wksp (void* dst, size_t dstCapacity, 9619fcbaf1SConrad Meyer const void* src, size_t srcSize, 9719fcbaf1SConrad Meyer unsigned maxSymbolValue, unsigned tableLog, 9819fcbaf1SConrad Meyer void* workSpace, size_t wkspSize); 990c16b537SWarner Losh 1000c16b537SWarner Losh #endif /* HUF_H_298734234 */ 1010c16b537SWarner Losh 1020c16b537SWarner Losh /* ****************************************************************** 1030c16b537SWarner Losh * WARNING !! 1040c16b537SWarner Losh * The following section contains advanced and experimental definitions 10519fcbaf1SConrad Meyer * which shall never be used in the context of a dynamic library, 1060c16b537SWarner Losh * because they are not guaranteed to remain stable in the future. 1070c16b537SWarner Losh * Only consider them in association with static linking. 10819fcbaf1SConrad Meyer * *****************************************************************/ 1090c16b537SWarner Losh #if defined(HUF_STATIC_LINKING_ONLY) && !defined(HUF_H_HUF_STATIC_LINKING_ONLY) 1100c16b537SWarner Losh #define HUF_H_HUF_STATIC_LINKING_ONLY 1110c16b537SWarner Losh 1120c16b537SWarner Losh /* *** Dependencies *** */ 1130c16b537SWarner Losh #include "mem.h" /* U32 */ 114f7cd7fe5SConrad Meyer #define FSE_STATIC_LINKING_ONLY 115f7cd7fe5SConrad Meyer #include "fse.h" 1160c16b537SWarner Losh 1170c16b537SWarner Losh 1180c16b537SWarner Losh /* *** Constants *** */ 1195ff13fbcSAllan Jude #define HUF_TABLELOG_MAX 12 /* max runtime value of tableLog (due to static allocation); can be modified up to HUF_TABLELOG_ABSOLUTEMAX */ 12019fcbaf1SConrad Meyer #define HUF_TABLELOG_DEFAULT 11 /* default tableLog value when none specified */ 1210c16b537SWarner Losh #define HUF_SYMBOLVALUE_MAX 255 1220c16b537SWarner Losh 1235ff13fbcSAllan Jude #define HUF_TABLELOG_ABSOLUTEMAX 12 /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */ 1240c16b537SWarner Losh #if (HUF_TABLELOG_MAX > HUF_TABLELOG_ABSOLUTEMAX) 1250c16b537SWarner Losh # error "HUF_TABLELOG_MAX is too large !" 1260c16b537SWarner Losh #endif 1270c16b537SWarner Losh 1280c16b537SWarner Losh 1290c16b537SWarner Losh /* **************************************** 1300c16b537SWarner Losh * Static allocation 1310c16b537SWarner Losh ******************************************/ 1320c16b537SWarner Losh /* HUF buffer bounds */ 1330c16b537SWarner Losh #define HUF_CTABLEBOUND 129 1340c16b537SWarner Losh #define HUF_BLOCKBOUND(size) (size + (size>>8) + 8) /* only true when incompressible is pre-filtered with fast heuristic */ 1350c16b537SWarner Losh #define HUF_COMPRESSBOUND(size) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size)) /* Macro version, useful for static allocation */ 1360c16b537SWarner Losh 1370c16b537SWarner Losh /* static allocation of HUF's Compression Table */ 138f7cd7fe5SConrad Meyer /* this is a private definition, just exposed for allocation and strict aliasing purpose. never EVER access its members directly */ 1395ff13fbcSAllan Jude typedef size_t HUF_CElt; /* consider it an incomplete type */ 1405ff13fbcSAllan Jude #define HUF_CTABLE_SIZE_ST(maxSymbolValue) ((maxSymbolValue)+2) /* Use tables of size_t, for proper alignment */ 1415ff13fbcSAllan Jude #define HUF_CTABLE_SIZE(maxSymbolValue) (HUF_CTABLE_SIZE_ST(maxSymbolValue) * sizeof(size_t)) 1420c16b537SWarner Losh #define HUF_CREATE_STATIC_CTABLE(name, maxSymbolValue) \ 1435ff13fbcSAllan Jude HUF_CElt name[HUF_CTABLE_SIZE_ST(maxSymbolValue)] /* no final ; */ 1440c16b537SWarner Losh 1450c16b537SWarner Losh /* static allocation of HUF's DTable */ 1460c16b537SWarner Losh typedef U32 HUF_DTable; 1470c16b537SWarner Losh #define HUF_DTABLE_SIZE(maxTableLog) (1 + (1<<(maxTableLog))) 1480f743729SConrad Meyer #define HUF_CREATE_STATIC_DTABLEX1(DTable, maxTableLog) \ 1490c16b537SWarner Losh HUF_DTable DTable[HUF_DTABLE_SIZE((maxTableLog)-1)] = { ((U32)((maxTableLog)-1) * 0x01000001) } 1500f743729SConrad Meyer #define HUF_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) \ 1510c16b537SWarner Losh HUF_DTable DTable[HUF_DTABLE_SIZE(maxTableLog)] = { ((U32)(maxTableLog) * 0x01000001) } 1520c16b537SWarner Losh 1530c16b537SWarner Losh 1540c16b537SWarner Losh /* **************************************** 1550c16b537SWarner Losh * Advanced decompression functions 1560c16b537SWarner Losh ******************************************/ 1570f743729SConrad Meyer size_t HUF_decompress4X1 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< single-symbol decoder */ 158a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 1590f743729SConrad Meyer size_t HUF_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< double-symbols decoder */ 160a0483764SConrad Meyer #endif 1610c16b537SWarner Losh 1620c16b537SWarner Losh size_t HUF_decompress4X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< decodes RLE and uncompressed */ 1630c16b537SWarner Losh 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 */ 1640c16b537SWarner Losh 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 */ 1650f743729SConrad Meyer size_t HUF_decompress4X1_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< single-symbol decoder */ 1660f743729SConrad Meyer 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 */ 167a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 1680f743729SConrad Meyer size_t HUF_decompress4X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< double-symbols decoder */ 1690f743729SConrad Meyer 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 */ 170a0483764SConrad Meyer #endif 1710c16b537SWarner Losh 1720c16b537SWarner Losh 1730c16b537SWarner Losh /* **************************************** 1740c16b537SWarner Losh * HUF detailed API 17519fcbaf1SConrad Meyer * ****************************************/ 1760c16b537SWarner Losh 17719fcbaf1SConrad Meyer /*! HUF_compress() does the following: 17819fcbaf1SConrad Meyer * 1. count symbol occurrence from source[] into table count[] using FSE_count() (exposed within "fse.h") 17919fcbaf1SConrad Meyer * 2. (optional) refine tableLog using HUF_optimalTableLog() 18019fcbaf1SConrad Meyer * 3. build Huffman table from count using HUF_buildCTable() 18119fcbaf1SConrad Meyer * 4. save Huffman table to memory buffer using HUF_writeCTable() 18219fcbaf1SConrad Meyer * 5. encode the data stream using HUF_compress4X_usingCTable() 18319fcbaf1SConrad Meyer * 18419fcbaf1SConrad Meyer * The following API allows targeting specific sub-functions for advanced tasks. 18519fcbaf1SConrad Meyer * For example, it's possible to compress several blocks using the same 'CTable', 18619fcbaf1SConrad Meyer * or to save and regenerate 'CTable' using external methods. 1870c16b537SWarner Losh */ 1880c16b537SWarner Losh unsigned HUF_optimalTableLog(unsigned maxTableLog, size_t srcSize, unsigned maxSymbolValue); 18919fcbaf1SConrad Meyer 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 */ 1900c16b537SWarner Losh size_t HUF_writeCTable (void* dst, size_t maxDstSize, const HUF_CElt* CTable, unsigned maxSymbolValue, unsigned huffLog); 1915ff13fbcSAllan Jude size_t HUF_writeCTable_wksp(void* dst, size_t maxDstSize, const HUF_CElt* CTable, unsigned maxSymbolValue, unsigned huffLog, void* workspace, size_t workspaceSize); 1920c16b537SWarner Losh size_t HUF_compress4X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable); 1935ff13fbcSAllan Jude size_t HUF_compress4X_usingCTable_bmi2(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable, int bmi2); 19437f1f268SConrad Meyer size_t HUF_estimateCompressedSize(const HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue); 19537f1f268SConrad Meyer int HUF_validateCTable(const HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue); 1960c16b537SWarner Losh 1970c16b537SWarner Losh typedef enum { 1980c16b537SWarner Losh HUF_repeat_none, /**< Cannot use the previous table */ 1990c16b537SWarner Losh 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 */ 2000f743729SConrad Meyer HUF_repeat_valid /**< Can use the previous table and it is assumed to be valid */ 2010c16b537SWarner Losh } HUF_repeat; 2020c16b537SWarner Losh /** HUF_compress4X_repeat() : 2030c16b537SWarner Losh * Same as HUF_compress4X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none. 2040c16b537SWarner Losh * If it uses hufTable it does not modify hufTable or repeat. 2050c16b537SWarner Losh * If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used. 2065ff13fbcSAllan Jude * If preferRepeat then the old table will always be used if valid. 2075ff13fbcSAllan Jude * If suspectUncompressible then some sampling checks will be run to potentially skip huffman coding */ 20819fcbaf1SConrad Meyer size_t HUF_compress4X_repeat(void* dst, size_t dstSize, 20919fcbaf1SConrad Meyer const void* src, size_t srcSize, 21019fcbaf1SConrad Meyer unsigned maxSymbolValue, unsigned tableLog, 21119fcbaf1SConrad Meyer void* workSpace, size_t wkspSize, /**< `workSpace` must be aligned on 4-bytes boundaries, `wkspSize` must be >= HUF_WORKSPACE_SIZE */ 2125ff13fbcSAllan Jude HUF_CElt* hufTable, HUF_repeat* repeat, int preferRepeat, int bmi2, unsigned suspectUncompressible); 2130c16b537SWarner Losh 2140c16b537SWarner Losh /** HUF_buildCTable_wksp() : 2150c16b537SWarner Losh * Same as HUF_buildCTable(), but using externally allocated scratch buffer. 21619fcbaf1SConrad Meyer * `workSpace` must be aligned on 4-bytes boundaries, and its size must be >= HUF_CTABLE_WORKSPACE_SIZE. 2170c16b537SWarner Losh */ 21819fcbaf1SConrad Meyer #define HUF_CTABLE_WORKSPACE_SIZE_U32 (2*HUF_SYMBOLVALUE_MAX +1 +1) 21919fcbaf1SConrad Meyer #define HUF_CTABLE_WORKSPACE_SIZE (HUF_CTABLE_WORKSPACE_SIZE_U32 * sizeof(unsigned)) 2200f743729SConrad Meyer size_t HUF_buildCTable_wksp (HUF_CElt* tree, 221a0483764SConrad Meyer const unsigned* count, U32 maxSymbolValue, U32 maxNbBits, 2220f743729SConrad Meyer void* workSpace, size_t wkspSize); 2230c16b537SWarner Losh 2240c16b537SWarner Losh /*! HUF_readStats() : 22519fcbaf1SConrad Meyer * Read compact Huffman tree, saved by HUF_writeCTable(). 22619fcbaf1SConrad Meyer * `huffWeight` is destination buffer. 22719fcbaf1SConrad Meyer * @return : size read from `src` , or an error Code . 22819fcbaf1SConrad Meyer * Note : Needed by HUF_readCTable() and HUF_readDTableXn() . */ 22919fcbaf1SConrad Meyer size_t HUF_readStats(BYTE* huffWeight, size_t hwSize, 23019fcbaf1SConrad Meyer U32* rankStats, U32* nbSymbolsPtr, U32* tableLogPtr, 2310c16b537SWarner Losh const void* src, size_t srcSize); 2320c16b537SWarner Losh 233f7cd7fe5SConrad Meyer /*! HUF_readStats_wksp() : 234f7cd7fe5SConrad Meyer * Same as HUF_readStats() but takes an external workspace which must be 235f7cd7fe5SConrad Meyer * 4-byte aligned and its size must be >= HUF_READ_STATS_WORKSPACE_SIZE. 236f7cd7fe5SConrad Meyer * If the CPU has BMI2 support, pass bmi2=1, otherwise pass bmi2=0. 237f7cd7fe5SConrad Meyer */ 238f7cd7fe5SConrad Meyer #define HUF_READ_STATS_WORKSPACE_SIZE_U32 FSE_DECOMPRESS_WKSP_SIZE_U32(6, HUF_TABLELOG_MAX-1) 239f7cd7fe5SConrad Meyer #define HUF_READ_STATS_WORKSPACE_SIZE (HUF_READ_STATS_WORKSPACE_SIZE_U32 * sizeof(unsigned)) 240f7cd7fe5SConrad Meyer size_t HUF_readStats_wksp(BYTE* huffWeight, size_t hwSize, 241f7cd7fe5SConrad Meyer U32* rankStats, U32* nbSymbolsPtr, U32* tableLogPtr, 242f7cd7fe5SConrad Meyer const void* src, size_t srcSize, 243f7cd7fe5SConrad Meyer void* workspace, size_t wkspSize, 244f7cd7fe5SConrad Meyer int bmi2); 245f7cd7fe5SConrad Meyer 2460c16b537SWarner Losh /** HUF_readCTable() : 2470c16b537SWarner Losh * Loading a CTable saved with HUF_writeCTable() */ 24837f1f268SConrad Meyer size_t HUF_readCTable (HUF_CElt* CTable, unsigned* maxSymbolValuePtr, const void* src, size_t srcSize, unsigned *hasZeroWeights); 2490c16b537SWarner Losh 2505ff13fbcSAllan Jude /** HUF_getNbBitsFromCTable() : 2510f743729SConrad Meyer * Read nbBits from CTable symbolTable, for symbol `symbolValue` presumed <= HUF_SYMBOLVALUE_MAX 2525ff13fbcSAllan Jude * Note 1 : is not inlined, as HUF_CElt definition is private */ 2535ff13fbcSAllan Jude U32 HUF_getNbBitsFromCTable(const HUF_CElt* symbolTable, U32 symbolValue); 2540c16b537SWarner Losh 2550c16b537SWarner Losh /* 25619fcbaf1SConrad Meyer * HUF_decompress() does the following: 2570f743729SConrad Meyer * 1. select the decompression algorithm (X1, X2) based on pre-computed heuristics 25819fcbaf1SConrad Meyer * 2. build Huffman table from save, using HUF_readDTableX?() 25919fcbaf1SConrad Meyer * 3. decode 1 or 4 segments in parallel using HUF_decompress?X?_usingDTable() 2600c16b537SWarner Losh */ 2610c16b537SWarner Losh 2620c16b537SWarner Losh /** HUF_selectDecoder() : 2630c16b537SWarner Losh * Tells which decoder is likely to decode faster, 26419fcbaf1SConrad Meyer * based on a set of pre-computed metrics. 2650f743729SConrad Meyer * @return : 0==HUF_decompress4X1, 1==HUF_decompress4X2 . 26619fcbaf1SConrad Meyer * Assumption : 0 < dstSize <= 128 KB */ 2670c16b537SWarner Losh U32 HUF_selectDecoder (size_t dstSize, size_t cSrcSize); 2680c16b537SWarner Losh 26919fcbaf1SConrad Meyer /** 27019fcbaf1SConrad Meyer * The minimum workspace size for the `workSpace` used in 2710f743729SConrad Meyer * HUF_readDTableX1_wksp() and HUF_readDTableX2_wksp(). 27219fcbaf1SConrad Meyer * 27319fcbaf1SConrad Meyer * The space used depends on HUF_TABLELOG_MAX, ranging from ~1500 bytes when 27419fcbaf1SConrad Meyer * HUF_TABLE_LOG_MAX=12 to ~1850 bytes when HUF_TABLE_LOG_MAX=15. 27519fcbaf1SConrad Meyer * Buffer overflow errors may potentially occur if code modifications result in 27619fcbaf1SConrad Meyer * a required workspace size greater than that specified in the following 27719fcbaf1SConrad Meyer * macro. 27819fcbaf1SConrad Meyer */ 2795ff13fbcSAllan Jude #define HUF_DECOMPRESS_WORKSPACE_SIZE ((2 << 10) + (1 << 9)) 28019fcbaf1SConrad Meyer #define HUF_DECOMPRESS_WORKSPACE_SIZE_U32 (HUF_DECOMPRESS_WORKSPACE_SIZE / sizeof(U32)) 28119fcbaf1SConrad Meyer 282a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X2 2830f743729SConrad Meyer size_t HUF_readDTableX1 (HUF_DTable* DTable, const void* src, size_t srcSize); 2840f743729SConrad Meyer size_t HUF_readDTableX1_wksp (HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize); 285a0483764SConrad Meyer #endif 286a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 2870c16b537SWarner Losh size_t HUF_readDTableX2 (HUF_DTable* DTable, const void* src, size_t srcSize); 2880c16b537SWarner Losh size_t HUF_readDTableX2_wksp (HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize); 289a0483764SConrad Meyer #endif 2900c16b537SWarner Losh 2910c16b537SWarner Losh size_t HUF_decompress4X_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable); 292a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X2 2930f743729SConrad Meyer size_t HUF_decompress4X1_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable); 294a0483764SConrad Meyer #endif 295a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 2960c16b537SWarner Losh size_t HUF_decompress4X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable); 297a0483764SConrad Meyer #endif 2980c16b537SWarner Losh 2990c16b537SWarner Losh 30019fcbaf1SConrad Meyer /* ====================== */ 3010c16b537SWarner Losh /* single stream variants */ 30219fcbaf1SConrad Meyer /* ====================== */ 3030c16b537SWarner Losh 3040c16b537SWarner Losh size_t HUF_compress1X (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog); 3055ff13fbcSAllan Jude 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 */ 3060c16b537SWarner Losh size_t HUF_compress1X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable); 3075ff13fbcSAllan Jude size_t HUF_compress1X_usingCTable_bmi2(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable, int bmi2); 3080c16b537SWarner Losh /** HUF_compress1X_repeat() : 3090c16b537SWarner Losh * Same as HUF_compress1X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none. 3100c16b537SWarner Losh * If it uses hufTable it does not modify hufTable or repeat. 3110c16b537SWarner Losh * If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used. 3125ff13fbcSAllan Jude * If preferRepeat then the old table will always be used if valid. 3135ff13fbcSAllan Jude * If suspectUncompressible then some sampling checks will be run to potentially skip huffman coding */ 31419fcbaf1SConrad Meyer size_t HUF_compress1X_repeat(void* dst, size_t dstSize, 31519fcbaf1SConrad Meyer const void* src, size_t srcSize, 31619fcbaf1SConrad Meyer unsigned maxSymbolValue, unsigned tableLog, 31719fcbaf1SConrad Meyer void* workSpace, size_t wkspSize, /**< `workSpace` must be aligned on 4-bytes boundaries, `wkspSize` must be >= HUF_WORKSPACE_SIZE */ 3185ff13fbcSAllan Jude HUF_CElt* hufTable, HUF_repeat* repeat, int preferRepeat, int bmi2, unsigned suspectUncompressible); 3190c16b537SWarner Losh 3200f743729SConrad Meyer size_t HUF_decompress1X1 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* single-symbol decoder */ 321a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 3220f743729SConrad Meyer size_t HUF_decompress1X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* double-symbol decoder */ 323a0483764SConrad Meyer #endif 3240c16b537SWarner Losh 3250c16b537SWarner Losh size_t HUF_decompress1X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); 3260c16b537SWarner Losh 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); 327a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X2 3280f743729SConrad Meyer size_t HUF_decompress1X1_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< single-symbol decoder */ 3290f743729SConrad Meyer 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); /**< single-symbol decoder */ 330a0483764SConrad Meyer #endif 331a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 3320f743729SConrad Meyer size_t HUF_decompress1X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /**< double-symbols decoder */ 3330f743729SConrad Meyer 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); /**< double-symbols decoder */ 334a0483764SConrad Meyer #endif 3350c16b537SWarner Losh 3360c16b537SWarner Losh size_t HUF_decompress1X_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable); /**< automatic selection of sing or double symbol decoder, based on DTable */ 337a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X2 3380f743729SConrad Meyer size_t HUF_decompress1X1_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable); 339a0483764SConrad Meyer #endif 340a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X1 3410c16b537SWarner Losh size_t HUF_decompress1X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable); 342a0483764SConrad Meyer #endif 3430c16b537SWarner Losh 34419fcbaf1SConrad Meyer /* BMI2 variants. 34519fcbaf1SConrad Meyer * If the CPU has BMI2 support, pass bmi2=1, otherwise pass bmi2=0. 34619fcbaf1SConrad Meyer */ 34719fcbaf1SConrad Meyer size_t HUF_decompress1X_usingDTable_bmi2(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable, int bmi2); 348a0483764SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X2 3490f743729SConrad Meyer size_t HUF_decompress1X1_DCtx_wksp_bmi2(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize, int bmi2); 350a0483764SConrad Meyer #endif 35119fcbaf1SConrad Meyer size_t HUF_decompress4X_usingDTable_bmi2(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable, int bmi2); 35219fcbaf1SConrad Meyer size_t HUF_decompress4X_hufOnly_wksp_bmi2(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize, void* workSpace, size_t wkspSize, int bmi2); 353f7cd7fe5SConrad Meyer #ifndef HUF_FORCE_DECOMPRESS_X2 354f7cd7fe5SConrad Meyer size_t HUF_readDTableX1_wksp_bmi2(HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize, int bmi2); 355f7cd7fe5SConrad Meyer #endif 3565ff13fbcSAllan Jude #ifndef HUF_FORCE_DECOMPRESS_X1 3575ff13fbcSAllan Jude size_t HUF_readDTableX2_wksp_bmi2(HUF_DTable* DTable, const void* src, size_t srcSize, void* workSpace, size_t wkspSize, int bmi2); 3585ff13fbcSAllan Jude #endif 35919fcbaf1SConrad Meyer 3600c16b537SWarner Losh #endif /* HUF_STATIC_LINKING_ONLY */ 3610c16b537SWarner Losh 3620c16b537SWarner Losh #if defined (__cplusplus) 3630c16b537SWarner Losh } 3640c16b537SWarner Losh #endif 365