contrib/zstd/lib/common/huf.h

   1 /* ******************************************************************
   2    Huffman coder, part of New Generation Entropy library
   3    header file
   4    Copyright (C) 2013-2016, Yann Collet.
   5
   6    BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
   7
   8    Redistribution and use in source and binary forms, with or without
   9    modification, are permitted provided that the following conditions are
  10    met:
  11
  12        * Redistributions of source code must retain the above copyright
  13    notice, this list of conditions and the following disclaimer.
  14        * Redistributions in binary form must reproduce the above
  15    copyright notice, this list of conditions and the following disclaimer
  16    in the documentation and/or other materials provided with the
  17    distribution.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31    You can contact the author at :
  32    - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  33 ****************************************************************** */
  34 #ifndef HUF_H_298734234
  35 #define HUF_H_298734234
  36
  37 #if defined (__cplusplus)
  38 extern "C" {
  39 #endif
  40
  41
  42 /* *** Dependencies *** */
  43 #include <stddef.h>    /* size_t */
  44
  45
  46 /* *** simple functions *** */
  47 /**
  48 HUF_compress() :
  49     Compress content from buffer 'src', of size 'srcSize', into buffer 'dst'.
  50     'dst' buffer must be already allocated.
  51     Compression runs faster if `dstCapacity` >= HUF_compressBound(srcSize).
  52     `srcSize` must be <= `HUF_BLOCKSIZE_MAX` == 128 KB.
  53     @return : size of compressed data (<= `dstCapacity`).
  54     Special values : if return == 0, srcData is not compressible => Nothing is stored within dst !!!
  55                      if return == 1, srcData is a single repeated byte symbol (RLE compression).
  56                      if HUF_isError(return), compression failed (more details using HUF_getErrorName())
  57 */
  58 size_t HUF_compress(void* dst, size_t dstCapacity,
  59               const void* src, size_t srcSize);
  60
  61 /**
  62 HUF_decompress() :
  63     Decompress HUF data from buffer 'cSrc', of size 'cSrcSize',
  64     into already allocated buffer 'dst', of minimum size 'dstSize'.
  65     `originalSize` : **must** be the ***exact*** size of original (uncompressed) data.
  66     Note : in contrast with FSE, HUF_decompress can regenerate
  67            RLE (cSrcSize==1) and uncompressed (cSrcSize==dstSize) data,
  68            because it knows size to regenerate.
  69     @return : size of regenerated data (== originalSize),
  70               or an error code, which can be tested using HUF_isError()
  71 */
  72 size_t HUF_decompress(void* dst,  size_t originalSize,
  73                 const void* cSrc, size_t cSrcSize);
  74
  75
  76 /* ***   Tool functions *** */
  77 #define HUF_BLOCKSIZE_MAX (128 * 1024)       /**< maximum input size for a single block compressed with HUF_compress */
  78 size_t HUF_compressBound(size_t size);       /**< maximum compressed size (worst case) */
  79
  80 /* Error Management */
  81 unsigned    HUF_isError(size_t code);        /**< tells if a return value is an error code */
  82 const char* HUF_getErrorName(size_t code);   /**< provides error code string (useful for debugging) */
  83
  84
  85 /* ***   Advanced function   *** */
  86
  87 /** HUF_compress2() :
  88  *   Same as HUF_compress(), but offers direct control over `maxSymbolValue` and `tableLog` .
  89  *   `tableLog` must be `<= HUF_TABLELOG_MAX` . */
  90 size_t HUF_compress2 (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog);
  91
  92 /** HUF_compress4X_wksp() :
  93 *   Same as HUF_compress2(), but uses externally allocated `workSpace`, which must be a table of >= 1024 unsigned */
  94 size_t HUF_compress4X_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_U32 unsigned */
  95
  96
  97
  98 #ifdef HUF_STATIC_LINKING_ONLY
  99
 100 /* *** Dependencies *** */
 101 #include "mem.h"   /* U32 */
 102
 103
 104 /* *** Constants *** */
 105 #define HUF_TABLELOG_MAX      12       /* max configured tableLog (for static allocation); can be modified up to HUF_ABSOLUTEMAX_TABLELOG */
 106 #define HUF_TABLELOG_DEFAULT  11       /* tableLog by default, when not specified */
 107 #define HUF_SYMBOLVALUE_MAX  255
 108
 109 #define HUF_TABLELOG_ABSOLUTEMAX  15   /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */
 110 #if (HUF_TABLELOG_MAX > HUF_TABLELOG_ABSOLUTEMAX)
 111 #  error "HUF_TABLELOG_MAX is too large !"
 112 #endif
 113
 114
 115 /* ****************************************
 116 *  Static allocation
 117 ******************************************/
 118 /* HUF buffer bounds */
 119 #define HUF_CTABLEBOUND 129
 120 #define HUF_BLOCKBOUND(size) (size + (size>>8) + 8)   /* only true if incompressible pre-filtered with fast heuristic */
 121 #define HUF_COMPRESSBOUND(size) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size))   /* Macro version, useful for static allocation */
 122
 123 /* static allocation of HUF's Compression Table */
 124 #define HUF_CREATE_STATIC_CTABLE(name, maxSymbolValue) \
 125     U32 name##hb[maxSymbolValue+1]; \
 126     void* name##hv = &(name##hb); \
 127     HUF_CElt* name = (HUF_CElt*)(name##hv)   /* no final ; */
 128
 129 /* static allocation of HUF's DTable */
 130 typedef U32 HUF_DTable;
 131 #define HUF_DTABLE_SIZE(maxTableLog)   (1 + (1<<(maxTableLog)))
 132 #define HUF_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) \
 133         HUF_DTable DTable[HUF_DTABLE_SIZE((maxTableLog)-1)] = { ((U32)((maxTableLog)-1) * 0x01000001) }
 134 #define HUF_CREATE_STATIC_DTABLEX4(DTable, maxTableLog) \
 135         HUF_DTable DTable[HUF_DTABLE_SIZE(maxTableLog)] = { ((U32)(maxTableLog) * 0x01000001) }
 136
 137 /* The workspace must have alignment at least 4 and be at least this large */
 138 #define HUF_WORKSPACE_SIZE (6 << 10)
 139 #define HUF_WORKSPACE_SIZE_U32 (HUF_WORKSPACE_SIZE / sizeof(U32))
 140
 141
 142 /* ****************************************
 143 *  Advanced decompression functions
 144 ******************************************/
 145 size_t HUF_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< single-symbol decoder */
 146 size_t HUF_decompress4X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< double-symbols decoder */
 147
 148 size_t HUF_decompress4X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< decodes RLE and uncompressed */
 149 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 */
 150 size_t HUF_decompress4X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< single-symbol decoder */
 151 size_t HUF_decompress4X4_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< double-symbols decoder */
 152
 153
 154 /* ****************************************
 155 *  HUF detailed API
 156 ******************************************/
 157 /*!
 158 HUF_compress() does the following:
 159 1. count symbol occurrence from source[] into table count[] using FSE_count()
 160 2. (optional) refine tableLog using HUF_optimalTableLog()
 161 3. build Huffman table from count using HUF_buildCTable()
 162 4. save Huffman table to memory buffer using HUF_writeCTable()
 163 5. encode the data stream using HUF_compress4X_usingCTable()
 164
 165 The following API allows targeting specific sub-functions for advanced tasks.
 166 For example, it's possible to compress several blocks using the same 'CTable',
 167 or to save and regenerate 'CTable' using external methods.
 168 */
 169 /* FSE_count() : find it within "fse.h" */
 170 unsigned HUF_optimalTableLog(unsigned maxTableLog, size_t srcSize, unsigned maxSymbolValue);
 171 typedef struct HUF_CElt_s HUF_CElt;   /* incomplete type */
 172 size_t HUF_buildCTable (HUF_CElt* CTable, const unsigned* count, unsigned maxSymbolValue, unsigned maxNbBits);
 173 size_t HUF_writeCTable (void* dst, size_t maxDstSize, const HUF_CElt* CTable, unsigned maxSymbolValue, unsigned huffLog);
 174 size_t HUF_compress4X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable);
 175
 176 typedef enum {
 177    HUF_repeat_none,  /**< Cannot use the previous table */
 178    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 */
 179    HUF_repeat_valid  /**< Can use the previous table and it is asumed to be valid */
 180  } HUF_repeat;
 181 /** HUF_compress4X_repeat() :
 182 *   Same as HUF_compress4X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none.
 183 *   If it uses hufTable it does not modify hufTable or repeat.
 184 *   If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used.
 185 *   If preferRepeat then the old table will always be used if valid. */
 186 size_t HUF_compress4X_repeat(void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void* workSpace, size_t wkspSize, HUF_CElt* hufTable, HUF_repeat* repeat, int preferRepeat);  /**< `workSpace` must be a table of at least HUF_WORKSPACE_SIZE_U32 unsigned */
 187
 188 /** HUF_buildCTable_wksp() :
 189  *  Same as HUF_buildCTable(), but using externally allocated scratch buffer.
 190  *  `workSpace` must be aligned on 4-bytes boundaries, and be at least as large as a table of 1024 unsigned.
 191  */
 192 size_t HUF_buildCTable_wksp (HUF_CElt* tree, const U32* count, U32 maxSymbolValue, U32 maxNbBits, void* workSpace, size_t wkspSize);
 193
 194 /*! HUF_readStats() :
 195     Read compact Huffman tree, saved by HUF_writeCTable().
 196     `huffWeight` is destination buffer.
 197     @return : size read from `src` , or an error Code .
 198     Note : Needed by HUF_readCTable() and HUF_readDTableXn() . */
 199 size_t HUF_readStats(BYTE* huffWeight, size_t hwSize, U32* rankStats,
 200                      U32* nbSymbolsPtr, U32* tableLogPtr,
 201                      const void* src, size_t srcSize);
 202
 203 /** HUF_readCTable() :
 204 *   Loading a CTable saved with HUF_writeCTable() */
 205 size_t HUF_readCTable (HUF_CElt* CTable, unsigned maxSymbolValue, const void* src, size_t srcSize);
 206
 207
 208 /*
 209 HUF_decompress() does the following:
 210 1. select the decompression algorithm (X2, X4) based on pre-computed heuristics
 211 2. build Huffman table from save, using HUF_readDTableXn()
 212 3. decode 1 or 4 segments in parallel using HUF_decompressSXn_usingDTable
 213 */
 214
 215 /** HUF_selectDecoder() :
 216 *   Tells which decoder is likely to decode faster,
 217 *   based on a set of pre-determined metrics.
 218 *   @return : 0==HUF_decompress4X2, 1==HUF_decompress4X4 .
 219 *   Assumption : 0 < cSrcSize < dstSize <= 128 KB */
 220 U32 HUF_selectDecoder (size_t dstSize, size_t cSrcSize);
 221
 222 size_t HUF_readDTableX2 (HUF_DTable* DTable, const void* src, size_t srcSize);
 223 size_t HUF_readDTableX4 (HUF_DTable* DTable, const void* src, size_t srcSize);
 224
 225 size_t HUF_decompress4X_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
 226 size_t HUF_decompress4X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
 227 size_t HUF_decompress4X4_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
 228
 229
 230 /* single stream variants */
 231
 232 size_t HUF_compress1X (void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog);
 233 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_U32 unsigned */
 234 size_t HUF_compress1X_usingCTable(void* dst, size_t dstSize, const void* src, size_t srcSize, const HUF_CElt* CTable);
 235 /** HUF_compress1X_repeat() :
 236 *   Same as HUF_compress1X_wksp(), but considers using hufTable if *repeat != HUF_repeat_none.
 237 *   If it uses hufTable it does not modify hufTable or repeat.
 238 *   If it doesn't, it sets *repeat = HUF_repeat_none, and it sets hufTable to the table used.
 239 *   If preferRepeat then the old table will always be used if valid. */
 240 size_t HUF_compress1X_repeat(void* dst, size_t dstSize, const void* src, size_t srcSize, unsigned maxSymbolValue, unsigned tableLog, void* workSpace, size_t wkspSize, HUF_CElt* hufTable, HUF_repeat* repeat, int preferRepeat);  /**< `workSpace` must be a table of at least HUF_WORKSPACE_SIZE_U32 unsigned */
 241
 242 size_t HUF_decompress1X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /* single-symbol decoder */
 243 size_t HUF_decompress1X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /* double-symbol decoder */
 244
 245 size_t HUF_decompress1X_DCtx (HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);
 246 size_t HUF_decompress1X2_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< single-symbol decoder */
 247 size_t HUF_decompress1X4_DCtx(HUF_DTable* dctx, void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);   /**< double-symbols decoder */
 248
 249 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 */
 250 size_t HUF_decompress1X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
 251 size_t HUF_decompress1X4_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const HUF_DTable* DTable);
 252
 253 #endif /* HUF_STATIC_LINKING_ONLY */
 254
 255
 256 #if defined (__cplusplus)
 257 }
 258 #endif
 259
 260 #endif   /* HUF_H_298734234 */