huf.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. /* SPDX-License-Identifier: (GPL-2.0 or BSD-2-Clause) */
  2. /*
  3. * Huffman coder, part of New Generation Entropy library
  4. * header file
  5. * Copyright (C) 2013-2016, Yann Collet.
  6. *
  7. * You can contact the author at :
  8. * - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  9. */
  10. #ifndef HUF_H_298734234
  11. #define HUF_H_298734234
  12. /* *** Dependencies *** */
  13. #include <linux/types.h> /* size_t */
  14. /* *** Tool functions *** */
  15. #define HUF_BLOCKSIZE_MAX (128 * 1024) /**< maximum input size for a single block compressed with HUF_compress */
  16. size_t HUF_compressBound(size_t size); /**< maximum compressed size (worst case) */
  17. /* Error Management */
  18. unsigned HUF_isError(size_t code); /**< tells if a return value is an error code */
  19. /* *** Advanced function *** */
  20. /** HUF_compress4X_wksp() :
  21. * Same as HUF_compress2(), but uses externally allocated `workSpace`, which must be a table of >= 1024 unsigned */
  22. size_t HUF_compress4X_wksp(void *dst, size_t dstSize, const void *src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void *workSpace,
  23. size_t wkspSize); /**< `workSpace` must be a table of at least HUF_COMPRESS_WORKSPACE_SIZE_U32 unsigned */
  24. /* *** Dependencies *** */
  25. #include "mem.h" /* U32 */
  26. /* *** Constants *** */
  27. #define HUF_TABLELOG_MAX 12 /* max configured tableLog (for static allocation); can be modified up to HUF_ABSOLUTEMAX_TABLELOG */
  28. #define HUF_TABLELOG_DEFAULT 11 /* tableLog by default, when not specified */
  29. #define HUF_SYMBOLVALUE_MAX 255
  30. #define HUF_TABLELOG_ABSOLUTEMAX 15 /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */
  31. #if (HUF_TABLELOG_MAX > HUF_TABLELOG_ABSOLUTEMAX)
  32. #error "HUF_TABLELOG_MAX is too large !"
  33. #endif
  34. /* ****************************************
  35. * Static allocation
  36. ******************************************/
  37. /* HUF buffer bounds */
  38. #define HUF_CTABLEBOUND 129
  39. #define HUF_BLOCKBOUND(size) (size + (size >> 8) + 8) /* only true if incompressible pre-filtered with fast heuristic */
  40. #define HUF_COMPRESSBOUND(size) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size)) /* Macro version, useful for static allocation */
  41. /* static allocation of HUF's Compression Table */
  42. #define HUF_CREATE_STATIC_CTABLE(name, maxSymbolValue) \
  43. U32 name##hb[maxSymbolValue + 1]; \
  44. void *name##hv = &(name##hb); \
  45. HUF_CElt *name = (HUF_CElt *)(name##hv) /* no final ; */
  46. /* static allocation of HUF's DTable */
  47. typedef U32 HUF_DTable;
  48. #define HUF_DTABLE_SIZE(maxTableLog) (1 + (1 << (maxTableLog)))
  49. #define HUF_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) HUF_DTable DTable[HUF_DTABLE_SIZE((maxTableLog)-1)] = {((U32)((maxTableLog)-1) * 0x01000001)}
  50. #define HUF_CREATE_STATIC_DTABLEX4(DTable, maxTableLog) HUF_DTable DTable[HUF_DTABLE_SIZE(maxTableLog)] = {((U32)(maxTableLog)*0x01000001)}
  51. /* The workspace must have alignment at least 4 and be at least this large */
  52. #define HUF_COMPRESS_WORKSPACE_SIZE (6 << 10)
  53. #define HUF_COMPRESS_WORKSPACE_SIZE_U32 (HUF_COMPRESS_WORKSPACE_SIZE / sizeof(U32))
  54. /* The workspace must have alignment at least 4 and be at least this large */
  55. #define HUF_DECOMPRESS_WORKSPACE_SIZE (3 << 10)
  56. #define HUF_DECOMPRESS_WORKSPACE_SIZE_U32 (HUF_DECOMPRESS_WORKSPACE_SIZE / sizeof(U32))
  57. /* ****************************************
  58. * Advanced decompression functions
  59. ******************************************/
  60. size_t HUF_decompress4X_DCtx_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace, size_t workspaceSize); /**< decodes RLE and uncompressed */
  61. size_t HUF_decompress4X_hufOnly_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace,
  62. size_t workspaceSize); /**< considers RLE and uncompressed as errors */
  63. size_t HUF_decompress4X2_DCtx_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace,
  64. size_t workspaceSize); /**< single-symbol decoder */
  65. size_t HUF_decompress4X4_DCtx_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace,
  66. size_t workspaceSize); /**< double-symbols decoder */
  67. /* ****************************************
  68. * HUF detailed API
  69. ******************************************/
  70. /*!
  71. HUF_compress() does the following:
  72. 1. count symbol occurrence from source[] into table count[] using FSE_count()
  73. 2. (optional) refine tableLog using HUF_optimalTableLog()
  74. 3. build Huffman table from count using HUF_buildCTable()
  75. 4. save Huffman table to memory buffer using HUF_writeCTable_wksp()
  76. 5. encode the data stream using HUF_compress4X_usingCTable()
  77. The following API allows targeting specific sub-functions for advanced tasks.
  78. For example, it's possible to compress several blocks using the same 'CTable',
  79. or to save and regenerate 'CTable' using external methods.
  80. */
  81. /* FSE_count() : find it within "fse.h" */
  82. unsigned HUF_optimalTableLog(unsigned maxTableLog, size_t srcSize, unsigned maxSymbolValue);
  83. typedef struct HUF_CElt_s HUF_CElt; /* incomplete type */
  84. size_t HUF_writeCTable_wksp(void *dst, size_t maxDstSize, const HUF_CElt *CTable, unsigned maxSymbolValue, unsigned huffLog, void *workspace, size_t workspaceSize);
  85. size_t HUF_compress4X_usingCTable(void *dst, size_t dstSize, const void *src, size_t srcSize, const HUF_CElt *CTable);
  86. typedef enum {
  87. HUF_repeat_none, /**< Cannot use the previous table */
  88. 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,
  89. 4}X_repeat */
  90. HUF_repeat_valid /**< Can use the previous table and it is asumed to be valid */
  91. } HUF_repeat;
  92. /** HUF_compress4X_repeat() :
  93. * Same as HUF_compress4X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none.
  94. * If it uses hufTable it does not modify hufTable or repeat.
  95. * If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used.
  96. * If preferRepeat then the old table will always be used if valid. */
  97. size_t HUF_compress4X_repeat(void *dst, size_t dstSize, const void *src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void *workSpace,
  98. size_t wkspSize, HUF_CElt *hufTable, HUF_repeat *repeat,
  99. int preferRepeat); /**< `workSpace` must be a table of at least HUF_COMPRESS_WORKSPACE_SIZE_U32 unsigned */
  100. /** HUF_buildCTable_wksp() :
  101. * Same as HUF_buildCTable(), but using externally allocated scratch buffer.
  102. * `workSpace` must be aligned on 4-bytes boundaries, and be at least as large as a table of 1024 unsigned.
  103. */
  104. size_t HUF_buildCTable_wksp(HUF_CElt *tree, const U32 *count, U32 maxSymbolValue, U32 maxNbBits, void *workSpace, size_t wkspSize);
  105. /*! HUF_readStats() :
  106. Read compact Huffman tree, saved by HUF_writeCTable().
  107. `huffWeight` is destination buffer.
  108. @return : size read from `src` , or an error Code .
  109. Note : Needed by HUF_readCTable() and HUF_readDTableXn() . */
  110. size_t HUF_readStats_wksp(BYTE *huffWeight, size_t hwSize, U32 *rankStats, U32 *nbSymbolsPtr, U32 *tableLogPtr, const void *src, size_t srcSize,
  111. void *workspace, size_t workspaceSize);
  112. /** HUF_readCTable() :
  113. * Loading a CTable saved with HUF_writeCTable() */
  114. size_t HUF_readCTable_wksp(HUF_CElt *CTable, unsigned maxSymbolValue, const void *src, size_t srcSize, void *workspace, size_t workspaceSize);
  115. /*
  116. HUF_decompress() does the following:
  117. 1. select the decompression algorithm (X2, X4) based on pre-computed heuristics
  118. 2. build Huffman table from save, using HUF_readDTableXn()
  119. 3. decode 1 or 4 segments in parallel using HUF_decompressSXn_usingDTable
  120. */
  121. /** HUF_selectDecoder() :
  122. * Tells which decoder is likely to decode faster,
  123. * based on a set of pre-determined metrics.
  124. * @return : 0==HUF_decompress4X2, 1==HUF_decompress4X4 .
  125. * Assumption : 0 < cSrcSize < dstSize <= 128 KB */
  126. U32 HUF_selectDecoder(size_t dstSize, size_t cSrcSize);
  127. size_t HUF_readDTableX2_wksp(HUF_DTable *DTable, const void *src, size_t srcSize, void *workspace, size_t workspaceSize);
  128. size_t HUF_readDTableX4_wksp(HUF_DTable *DTable, const void *src, size_t srcSize, void *workspace, size_t workspaceSize);
  129. size_t HUF_decompress4X_usingDTable(void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize, const HUF_DTable *DTable);
  130. size_t HUF_decompress4X2_usingDTable(void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize, const HUF_DTable *DTable);
  131. size_t HUF_decompress4X4_usingDTable(void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize, const HUF_DTable *DTable);
  132. /* single stream variants */
  133. size_t HUF_compress1X_wksp(void *dst, size_t dstSize, const void *src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void *workSpace,
  134. size_t wkspSize); /**< `workSpace` must be a table of at least HUF_COMPRESS_WORKSPACE_SIZE_U32 unsigned */
  135. size_t HUF_compress1X_usingCTable(void *dst, size_t dstSize, const void *src, size_t srcSize, const HUF_CElt *CTable);
  136. /** HUF_compress1X_repeat() :
  137. * Same as HUF_compress1X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none.
  138. * If it uses hufTable it does not modify hufTable or repeat.
  139. * If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used.
  140. * If preferRepeat then the old table will always be used if valid. */
  141. size_t HUF_compress1X_repeat(void *dst, size_t dstSize, const void *src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void *workSpace,
  142. size_t wkspSize, HUF_CElt *hufTable, HUF_repeat *repeat,
  143. int preferRepeat); /**< `workSpace` must be a table of at least HUF_COMPRESS_WORKSPACE_SIZE_U32 unsigned */
  144. size_t HUF_decompress1X_DCtx_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace, size_t workspaceSize);
  145. size_t HUF_decompress1X2_DCtx_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace,
  146. size_t workspaceSize); /**< single-symbol decoder */
  147. size_t HUF_decompress1X4_DCtx_wksp(HUF_DTable *dctx, void *dst, size_t dstSize, const void *cSrc, size_t cSrcSize, void *workspace,
  148. size_t workspaceSize); /**< double-symbols decoder */
  149. size_t HUF_decompress1X_usingDTable(void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize,
  150. const HUF_DTable *DTable); /**< automatic selection of sing or double symbol decoder, based on DTable */
  151. size_t HUF_decompress1X2_usingDTable(void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize, const HUF_DTable *DTable);
  152. size_t HUF_decompress1X4_usingDTable(void *dst, size_t maxDstSize, const void *cSrc, size_t cSrcSize, const HUF_DTable *DTable);
  153. #endif /* HUF_H_298734234 */