blob: a695cbb8a6ddea086d3b94e1c144a7f6d818444f [file] [log] [blame]
William Kurkianea869482019-04-09 15:16:11 -04001/*
2 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
3 * All rights reserved.
4 *
5 * This source code is licensed under both the BSD-style license (found in the
6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7 * in the COPYING file in the root directory of this source tree).
8 * You may select, at your option, one of the above-listed licenses.
9 */
10
11
12/*- Dependencies -*/
13#include "zstd_v06.h"
14#include <stddef.h> /* size_t, ptrdiff_t */
15#include <string.h> /* memcpy */
16#include <stdlib.h> /* malloc, free, qsort */
17#include "error_private.h"
18
19
20
21/* ******************************************************************
22 mem.h
23 low-level memory access routines
24 Copyright (C) 2013-2015, Yann Collet.
25
26 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
27
28 Redistribution and use in source and binary forms, with or without
29 modification, are permitted provided that the following conditions are
30 met:
31
32 * Redistributions of source code must retain the above copyright
33 notice, this list of conditions and the following disclaimer.
34 * Redistributions in binary form must reproduce the above
35 copyright notice, this list of conditions and the following disclaimer
36 in the documentation and/or other materials provided with the
37 distribution.
38
39 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
43 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
46 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
47 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50
51 You can contact the author at :
52 - FSE source repository : https://github.com/Cyan4973/FiniteStateEntropy
53 - Public forum : https://groups.google.com/forum/#!forum/lz4c
54****************************************************************** */
55#ifndef MEM_H_MODULE
56#define MEM_H_MODULE
57
58#if defined (__cplusplus)
59extern "C" {
60#endif
61
62
63/*-****************************************
64* Compiler specifics
65******************************************/
66#if defined(_MSC_VER) /* Visual Studio */
67# include <stdlib.h> /* _byteswap_ulong */
68# include <intrin.h> /* _byteswap_* */
69#endif
70#if defined(__GNUC__)
71# define MEM_STATIC static __attribute__((unused))
72#elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
73# define MEM_STATIC static inline
74#elif defined(_MSC_VER)
75# define MEM_STATIC static __inline
76#else
77# define MEM_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */
78#endif
79
80
81/*-**************************************************************
82* Basic Types
83*****************************************************************/
84#if !defined (__VMS) && (defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) )
85# include <stdint.h>
86 typedef uint8_t BYTE;
87 typedef uint16_t U16;
88 typedef int16_t S16;
89 typedef uint32_t U32;
90 typedef int32_t S32;
91 typedef uint64_t U64;
92 typedef int64_t S64;
93#else
94 typedef unsigned char BYTE;
95 typedef unsigned short U16;
96 typedef signed short S16;
97 typedef unsigned int U32;
98 typedef signed int S32;
99 typedef unsigned long long U64;
100 typedef signed long long S64;
101#endif
102
103
104/*-**************************************************************
105* Memory I/O
106*****************************************************************/
107/* MEM_FORCE_MEMORY_ACCESS :
108 * By default, access to unaligned memory is controlled by `memcpy()`, which is safe and portable.
109 * Unfortunately, on some target/compiler combinations, the generated assembly is sub-optimal.
110 * The below switch allow to select different access method for improved performance.
111 * Method 0 (default) : use `memcpy()`. Safe and portable.
112 * Method 1 : `__packed` statement. It depends on compiler extension (ie, not portable).
113 * This method is safe if your compiler supports it, and *generally* as fast or faster than `memcpy`.
114 * Method 2 : direct access. This method is portable but violate C standard.
115 * It can generate buggy code on targets depending on alignment.
116 * In some circumstances, it's the only known way to get the most performance (ie GCC + ARMv6)
117 * See http://fastcompression.blogspot.fr/2015/08/accessing-unaligned-memory.html for details.
118 * Prefer these methods in priority order (0 > 1 > 2)
119 */
120#ifndef MEM_FORCE_MEMORY_ACCESS /* can be defined externally, on command line for example */
121# if defined(__GNUC__) && ( defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6ZK__) || defined(__ARM_ARCH_6T2__) )
122# define MEM_FORCE_MEMORY_ACCESS 2
123# elif (defined(__INTEL_COMPILER) && !defined(WIN32)) || \
124 (defined(__GNUC__) && ( defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7S__) ))
125# define MEM_FORCE_MEMORY_ACCESS 1
126# endif
127#endif
128
129MEM_STATIC unsigned MEM_32bits(void) { return sizeof(size_t)==4; }
130MEM_STATIC unsigned MEM_64bits(void) { return sizeof(size_t)==8; }
131
132MEM_STATIC unsigned MEM_isLittleEndian(void)
133{
134 const union { U32 u; BYTE c[4]; } one = { 1 }; /* don't use static : performance detrimental */
135 return one.c[0];
136}
137
138#if defined(MEM_FORCE_MEMORY_ACCESS) && (MEM_FORCE_MEMORY_ACCESS==2)
139
140/* violates C standard, by lying on structure alignment.
141Only use if no other choice to achieve best performance on target platform */
142MEM_STATIC U16 MEM_read16(const void* memPtr) { return *(const U16*) memPtr; }
143MEM_STATIC U32 MEM_read32(const void* memPtr) { return *(const U32*) memPtr; }
144MEM_STATIC U64 MEM_read64(const void* memPtr) { return *(const U64*) memPtr; }
145
146MEM_STATIC void MEM_write16(void* memPtr, U16 value) { *(U16*)memPtr = value; }
147
148#elif defined(MEM_FORCE_MEMORY_ACCESS) && (MEM_FORCE_MEMORY_ACCESS==1)
149
150/* __pack instructions are safer, but compiler specific, hence potentially problematic for some compilers */
151/* currently only defined for gcc and icc */
152typedef union { U16 u16; U32 u32; U64 u64; size_t st; } __attribute__((packed)) unalign;
153
154MEM_STATIC U16 MEM_read16(const void* ptr) { return ((const unalign*)ptr)->u16; }
155MEM_STATIC U32 MEM_read32(const void* ptr) { return ((const unalign*)ptr)->u32; }
156MEM_STATIC U64 MEM_read64(const void* ptr) { return ((const unalign*)ptr)->u64; }
157
158MEM_STATIC void MEM_write16(void* memPtr, U16 value) { ((unalign*)memPtr)->u16 = value; }
159
160#else
161
162/* default method, safe and standard.
163 can sometimes prove slower */
164
165MEM_STATIC U16 MEM_read16(const void* memPtr)
166{
167 U16 val; memcpy(&val, memPtr, sizeof(val)); return val;
168}
169
170MEM_STATIC U32 MEM_read32(const void* memPtr)
171{
172 U32 val; memcpy(&val, memPtr, sizeof(val)); return val;
173}
174
175MEM_STATIC U64 MEM_read64(const void* memPtr)
176{
177 U64 val; memcpy(&val, memPtr, sizeof(val)); return val;
178}
179
180MEM_STATIC void MEM_write16(void* memPtr, U16 value)
181{
182 memcpy(memPtr, &value, sizeof(value));
183}
184
185
186#endif /* MEM_FORCE_MEMORY_ACCESS */
187
188MEM_STATIC U32 MEM_swap32(U32 in)
189{
190#if defined(_MSC_VER) /* Visual Studio */
191 return _byteswap_ulong(in);
192#elif defined (__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 403)
193 return __builtin_bswap32(in);
194#else
195 return ((in << 24) & 0xff000000 ) |
196 ((in << 8) & 0x00ff0000 ) |
197 ((in >> 8) & 0x0000ff00 ) |
198 ((in >> 24) & 0x000000ff );
199#endif
200}
201
202MEM_STATIC U64 MEM_swap64(U64 in)
203{
204#if defined(_MSC_VER) /* Visual Studio */
205 return _byteswap_uint64(in);
206#elif defined (__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 403)
207 return __builtin_bswap64(in);
208#else
209 return ((in << 56) & 0xff00000000000000ULL) |
210 ((in << 40) & 0x00ff000000000000ULL) |
211 ((in << 24) & 0x0000ff0000000000ULL) |
212 ((in << 8) & 0x000000ff00000000ULL) |
213 ((in >> 8) & 0x00000000ff000000ULL) |
214 ((in >> 24) & 0x0000000000ff0000ULL) |
215 ((in >> 40) & 0x000000000000ff00ULL) |
216 ((in >> 56) & 0x00000000000000ffULL);
217#endif
218}
219
220
221/*=== Little endian r/w ===*/
222
223MEM_STATIC U16 MEM_readLE16(const void* memPtr)
224{
225 if (MEM_isLittleEndian())
226 return MEM_read16(memPtr);
227 else {
228 const BYTE* p = (const BYTE*)memPtr;
229 return (U16)(p[0] + (p[1]<<8));
230 }
231}
232
233MEM_STATIC void MEM_writeLE16(void* memPtr, U16 val)
234{
235 if (MEM_isLittleEndian()) {
236 MEM_write16(memPtr, val);
237 } else {
238 BYTE* p = (BYTE*)memPtr;
239 p[0] = (BYTE)val;
240 p[1] = (BYTE)(val>>8);
241 }
242}
243
244MEM_STATIC U32 MEM_readLE32(const void* memPtr)
245{
246 if (MEM_isLittleEndian())
247 return MEM_read32(memPtr);
248 else
249 return MEM_swap32(MEM_read32(memPtr));
250}
251
252
253MEM_STATIC U64 MEM_readLE64(const void* memPtr)
254{
255 if (MEM_isLittleEndian())
256 return MEM_read64(memPtr);
257 else
258 return MEM_swap64(MEM_read64(memPtr));
259}
260
261
262MEM_STATIC size_t MEM_readLEST(const void* memPtr)
263{
264 if (MEM_32bits())
265 return (size_t)MEM_readLE32(memPtr);
266 else
267 return (size_t)MEM_readLE64(memPtr);
268}
269
270
271
272#if defined (__cplusplus)
273}
274#endif
275
276#endif /* MEM_H_MODULE */
277
278/*
279 zstd - standard compression library
280 Header File for static linking only
281 Copyright (C) 2014-2016, Yann Collet.
282
283 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
284
285 Redistribution and use in source and binary forms, with or without
286 modification, are permitted provided that the following conditions are
287 met:
288 * Redistributions of source code must retain the above copyright
289 notice, this list of conditions and the following disclaimer.
290 * Redistributions in binary form must reproduce the above
291 copyright notice, this list of conditions and the following disclaimer
292 in the documentation and/or other materials provided with the
293 distribution.
294 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
295 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
296 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
297 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
298 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
299 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
300 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
301 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
302 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
303 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
304 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
305
306 You can contact the author at :
307 - zstd homepage : http://www.zstd.net
308*/
309#ifndef ZSTDv06_STATIC_H
310#define ZSTDv06_STATIC_H
311
312/* The prototypes defined within this file are considered experimental.
313 * They should not be used in the context DLL as they may change in the future.
314 * Prefer static linking if you need them, to control breaking version changes issues.
315 */
316
317#if defined (__cplusplus)
318extern "C" {
319#endif
320
321
322
323/*- Advanced Decompression functions -*/
324
325/*! ZSTDv06_decompress_usingPreparedDCtx() :
326* Same as ZSTDv06_decompress_usingDict, but using a reference context `preparedDCtx`, where dictionary has been loaded.
327* It avoids reloading the dictionary each time.
328* `preparedDCtx` must have been properly initialized using ZSTDv06_decompressBegin_usingDict().
329* Requires 2 contexts : 1 for reference (preparedDCtx), which will not be modified, and 1 to run the decompression operation (dctx) */
330ZSTDLIBv06_API size_t ZSTDv06_decompress_usingPreparedDCtx(
331 ZSTDv06_DCtx* dctx, const ZSTDv06_DCtx* preparedDCtx,
332 void* dst, size_t dstCapacity,
333 const void* src, size_t srcSize);
334
335
336
337#define ZSTDv06_FRAMEHEADERSIZE_MAX 13 /* for static allocation */
338static const size_t ZSTDv06_frameHeaderSize_min = 5;
339static const size_t ZSTDv06_frameHeaderSize_max = ZSTDv06_FRAMEHEADERSIZE_MAX;
340
341ZSTDLIBv06_API size_t ZSTDv06_decompressBegin(ZSTDv06_DCtx* dctx);
342
343/*
344 Streaming decompression, direct mode (bufferless)
345
346 A ZSTDv06_DCtx object is required to track streaming operations.
347 Use ZSTDv06_createDCtx() / ZSTDv06_freeDCtx() to manage it.
348 A ZSTDv06_DCtx object can be re-used multiple times.
349
350 First optional operation is to retrieve frame parameters, using ZSTDv06_getFrameParams(), which doesn't consume the input.
351 It can provide the minimum size of rolling buffer required to properly decompress data,
352 and optionally the final size of uncompressed content.
353 (Note : content size is an optional info that may not be present. 0 means : content size unknown)
354 Frame parameters are extracted from the beginning of compressed frame.
355 The amount of data to read is variable, from ZSTDv06_frameHeaderSize_min to ZSTDv06_frameHeaderSize_max (so if `srcSize` >= ZSTDv06_frameHeaderSize_max, it will always work)
356 If `srcSize` is too small for operation to succeed, function will return the minimum size it requires to produce a result.
357 Result : 0 when successful, it means the ZSTDv06_frameParams structure has been filled.
358 >0 : means there is not enough data into `src`. Provides the expected size to successfully decode header.
359 errorCode, which can be tested using ZSTDv06_isError()
360
361 Start decompression, with ZSTDv06_decompressBegin() or ZSTDv06_decompressBegin_usingDict().
362 Alternatively, you can copy a prepared context, using ZSTDv06_copyDCtx().
363
364 Then use ZSTDv06_nextSrcSizeToDecompress() and ZSTDv06_decompressContinue() alternatively.
365 ZSTDv06_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTDv06_decompressContinue().
366 ZSTDv06_decompressContinue() requires this exact amount of bytes, or it will fail.
367 ZSTDv06_decompressContinue() needs previous data blocks during decompression, up to (1 << windowlog).
368 They should preferably be located contiguously, prior to current block. Alternatively, a round buffer is also possible.
369
370 @result of ZSTDv06_decompressContinue() is the number of bytes regenerated within 'dst' (necessarily <= dstCapacity)
371 It can be zero, which is not an error; it just means ZSTDv06_decompressContinue() has decoded some header.
372
373 A frame is fully decoded when ZSTDv06_nextSrcSizeToDecompress() returns zero.
374 Context can then be reset to start a new decompression.
375*/
376
377
378/* **************************************
379* Block functions
380****************************************/
381/*! Block functions produce and decode raw zstd blocks, without frame metadata.
382 User will have to take in charge required information to regenerate data, such as compressed and content sizes.
383
384 A few rules to respect :
385 - Uncompressed block size must be <= ZSTDv06_BLOCKSIZE_MAX (128 KB)
386 - Compressing or decompressing requires a context structure
387 + Use ZSTDv06_createCCtx() and ZSTDv06_createDCtx()
388 - It is necessary to init context before starting
389 + compression : ZSTDv06_compressBegin()
390 + decompression : ZSTDv06_decompressBegin()
391 + variants _usingDict() are also allowed
392 + copyCCtx() and copyDCtx() work too
393 - When a block is considered not compressible enough, ZSTDv06_compressBlock() result will be zero.
394 In which case, nothing is produced into `dst`.
395 + User must test for such outcome and deal directly with uncompressed data
396 + ZSTDv06_decompressBlock() doesn't accept uncompressed data as input !!
397*/
398
399#define ZSTDv06_BLOCKSIZE_MAX (128 * 1024) /* define, for static allocation */
400ZSTDLIBv06_API size_t ZSTDv06_decompressBlock(ZSTDv06_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
401
402
403
404#if defined (__cplusplus)
405}
406#endif
407
408#endif /* ZSTDv06_STATIC_H */
409/*
410 zstd_internal - common functions to include
411 Header File for include
412 Copyright (C) 2014-2016, Yann Collet.
413
414 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
415
416 Redistribution and use in source and binary forms, with or without
417 modification, are permitted provided that the following conditions are
418 met:
419 * Redistributions of source code must retain the above copyright
420 notice, this list of conditions and the following disclaimer.
421 * Redistributions in binary form must reproduce the above
422 copyright notice, this list of conditions and the following disclaimer
423 in the documentation and/or other materials provided with the
424 distribution.
425 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
426 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
427 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
428 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
429 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
430 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
431 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
432 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
433 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
434 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
435 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
436
437 You can contact the author at :
438 - zstd homepage : https://www.zstd.net
439*/
440#ifndef ZSTDv06_CCOMMON_H_MODULE
441#define ZSTDv06_CCOMMON_H_MODULE
442
443
444/*-*************************************
445* Common macros
446***************************************/
447#define MIN(a,b) ((a)<(b) ? (a) : (b))
448#define MAX(a,b) ((a)>(b) ? (a) : (b))
449
450
451/*-*************************************
452* Common constants
453***************************************/
454#define ZSTDv06_DICT_MAGIC 0xEC30A436
455
456#define ZSTDv06_REP_NUM 3
457#define ZSTDv06_REP_INIT ZSTDv06_REP_NUM
458#define ZSTDv06_REP_MOVE (ZSTDv06_REP_NUM-1)
459
460#define KB *(1 <<10)
461#define MB *(1 <<20)
462#define GB *(1U<<30)
463
464#define BIT7 128
465#define BIT6 64
466#define BIT5 32
467#define BIT4 16
468#define BIT1 2
469#define BIT0 1
470
471#define ZSTDv06_WINDOWLOG_ABSOLUTEMIN 12
472static const size_t ZSTDv06_fcs_fieldSize[4] = { 0, 1, 2, 8 };
473
474#define ZSTDv06_BLOCKHEADERSIZE 3 /* because C standard does not allow a static const value to be defined using another static const value .... :( */
475static const size_t ZSTDv06_blockHeaderSize = ZSTDv06_BLOCKHEADERSIZE;
476typedef enum { bt_compressed, bt_raw, bt_rle, bt_end } blockType_t;
477
478#define MIN_SEQUENCES_SIZE 1 /* nbSeq==0 */
479#define MIN_CBLOCK_SIZE (1 /*litCSize*/ + 1 /* RLE or RAW */ + MIN_SEQUENCES_SIZE /* nbSeq==0 */) /* for a non-null block */
480
481#define HufLog 12
482
483#define IS_HUF 0
484#define IS_PCH 1
485#define IS_RAW 2
486#define IS_RLE 3
487
488#define LONGNBSEQ 0x7F00
489
490#define MINMATCH 3
491#define EQUAL_READ32 4
492#define REPCODE_STARTVALUE 1
493
494#define Litbits 8
495#define MaxLit ((1<<Litbits) - 1)
496#define MaxML 52
497#define MaxLL 35
498#define MaxOff 28
499#define MaxSeq MAX(MaxLL, MaxML) /* Assumption : MaxOff < MaxLL,MaxML */
500#define MLFSELog 9
501#define LLFSELog 9
502#define OffFSELog 8
503
504#define FSEv06_ENCODING_RAW 0
505#define FSEv06_ENCODING_RLE 1
506#define FSEv06_ENCODING_STATIC 2
507#define FSEv06_ENCODING_DYNAMIC 3
508
Abhilash S.L3b494632019-07-16 15:51:09 +0530509#define ZSTD_CONTENTSIZE_ERROR (0ULL - 2)
510
William Kurkianea869482019-04-09 15:16:11 -0400511static const U32 LL_bits[MaxLL+1] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
512 1, 1, 1, 1, 2, 2, 3, 3, 4, 6, 7, 8, 9,10,11,12,
513 13,14,15,16 };
514static const S16 LL_defaultNorm[MaxLL+1] = { 4, 3, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 1, 1, 1,
515 2, 2, 2, 2, 2, 2, 2, 2, 2, 3, 2, 1, 1, 1, 1, 1,
516 -1,-1,-1,-1 };
517static const U32 LL_defaultNormLog = 6;
518
519static const U32 ML_bits[MaxML+1] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
520 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
521 1, 1, 1, 1, 2, 2, 3, 3, 4, 4, 5, 7, 8, 9,10,11,
522 12,13,14,15,16 };
523static const S16 ML_defaultNorm[MaxML+1] = { 1, 4, 3, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1,
524 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
525 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,-1,-1,
526 -1,-1,-1,-1,-1 };
527static const U32 ML_defaultNormLog = 6;
528
529static const S16 OF_defaultNorm[MaxOff+1] = { 1, 1, 1, 1, 1, 1, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1,
530 1, 1, 1, 1, 1, 1, 1, 1,-1,-1,-1,-1,-1 };
531static const U32 OF_defaultNormLog = 5;
532
533
534/*-*******************************************
535* Shared functions to include for inlining
536*********************************************/
537static void ZSTDv06_copy8(void* dst, const void* src) { memcpy(dst, src, 8); }
538#define COPY8(d,s) { ZSTDv06_copy8(d,s); d+=8; s+=8; }
539
540/*! ZSTDv06_wildcopy() :
541* custom version of memcpy(), can copy up to 7 bytes too many (8 bytes if length==0) */
542#define WILDCOPY_OVERLENGTH 8
543MEM_STATIC void ZSTDv06_wildcopy(void* dst, const void* src, ptrdiff_t length)
544{
545 const BYTE* ip = (const BYTE*)src;
546 BYTE* op = (BYTE*)dst;
547 BYTE* const oend = op + length;
548 do
549 COPY8(op, ip)
550 while (op < oend);
551}
552
553
554
555/*-*******************************************
556* Private interfaces
557*********************************************/
558typedef struct {
559 U32 off;
560 U32 len;
561} ZSTDv06_match_t;
562
563typedef struct {
564 U32 price;
565 U32 off;
566 U32 mlen;
567 U32 litlen;
568 U32 rep[ZSTDv06_REP_INIT];
569} ZSTDv06_optimal_t;
570
571typedef struct { U32 unused; } ZSTDv06_stats_t;
572
573typedef struct {
574 void* buffer;
575 U32* offsetStart;
576 U32* offset;
577 BYTE* offCodeStart;
578 BYTE* litStart;
579 BYTE* lit;
580 U16* litLengthStart;
581 U16* litLength;
582 BYTE* llCodeStart;
583 U16* matchLengthStart;
584 U16* matchLength;
585 BYTE* mlCodeStart;
586 U32 longLengthID; /* 0 == no longLength; 1 == Lit.longLength; 2 == Match.longLength; */
587 U32 longLengthPos;
588 /* opt */
589 ZSTDv06_optimal_t* priceTable;
590 ZSTDv06_match_t* matchTable;
591 U32* matchLengthFreq;
592 U32* litLengthFreq;
593 U32* litFreq;
594 U32* offCodeFreq;
595 U32 matchLengthSum;
596 U32 matchSum;
597 U32 litLengthSum;
598 U32 litSum;
599 U32 offCodeSum;
600 U32 log2matchLengthSum;
601 U32 log2matchSum;
602 U32 log2litLengthSum;
603 U32 log2litSum;
604 U32 log2offCodeSum;
605 U32 factor;
606 U32 cachedPrice;
607 U32 cachedLitLength;
608 const BYTE* cachedLiterals;
609 ZSTDv06_stats_t stats;
610} seqStore_t;
611
612void ZSTDv06_seqToCodes(const seqStore_t* seqStorePtr, size_t const nbSeq);
613
614
615#endif /* ZSTDv06_CCOMMON_H_MODULE */
616/* ******************************************************************
617 FSE : Finite State Entropy codec
618 Public Prototypes declaration
619 Copyright (C) 2013-2016, Yann Collet.
620
621 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
622
623 Redistribution and use in source and binary forms, with or without
624 modification, are permitted provided that the following conditions are
625 met:
626
627 * Redistributions of source code must retain the above copyright
628 notice, this list of conditions and the following disclaimer.
629 * Redistributions in binary form must reproduce the above
630 copyright notice, this list of conditions and the following disclaimer
631 in the documentation and/or other materials provided with the
632 distribution.
633
634 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
635 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
636 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
637 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
638 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
639 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
640 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
641 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
642 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
643 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
644 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
645
646 You can contact the author at :
647 - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
648****************************************************************** */
649#ifndef FSEv06_H
650#define FSEv06_H
651
652#if defined (__cplusplus)
653extern "C" {
654#endif
655
656
657
658/*-****************************************
659* FSE simple functions
660******************************************/
661/*! FSEv06_decompress():
662 Decompress FSE data from buffer 'cSrc', of size 'cSrcSize',
663 into already allocated destination buffer 'dst', of size 'dstCapacity'.
664 @return : size of regenerated data (<= maxDstSize),
665 or an error code, which can be tested using FSEv06_isError() .
666
667 ** Important ** : FSEv06_decompress() does not decompress non-compressible nor RLE data !!!
668 Why ? : making this distinction requires a header.
669 Header management is intentionally delegated to the user layer, which can better manage special cases.
670*/
671size_t FSEv06_decompress(void* dst, size_t dstCapacity,
672 const void* cSrc, size_t cSrcSize);
673
674
675/*-*****************************************
676* Tool functions
677******************************************/
678size_t FSEv06_compressBound(size_t size); /* maximum compressed size */
679
680/* Error Management */
681unsigned FSEv06_isError(size_t code); /* tells if a return value is an error code */
682const char* FSEv06_getErrorName(size_t code); /* provides error code string (useful for debugging) */
683
684
685
686/*-*****************************************
687* FSE detailed API
688******************************************/
689/*!
690
691FSEv06_decompress() does the following:
6921. read normalized counters with readNCount()
6932. build decoding table 'DTable' from normalized counters
6943. decode the data stream using decoding table 'DTable'
695
696The following API allows targeting specific sub-functions for advanced tasks.
697For example, it's possible to compress several blocks using the same 'CTable',
698or to save and provide normalized distribution using external method.
699*/
700
701
702/* *** DECOMPRESSION *** */
703
704/*! FSEv06_readNCount():
705 Read compactly saved 'normalizedCounter' from 'rBuffer'.
706 @return : size read from 'rBuffer',
707 or an errorCode, which can be tested using FSEv06_isError().
708 maxSymbolValuePtr[0] and tableLogPtr[0] will also be updated with their respective values */
709size_t FSEv06_readNCount (short* normalizedCounter, unsigned* maxSymbolValuePtr, unsigned* tableLogPtr, const void* rBuffer, size_t rBuffSize);
710
711/*! Constructor and Destructor of FSEv06_DTable.
712 Note that its size depends on 'tableLog' */
713typedef unsigned FSEv06_DTable; /* don't allocate that. It's just a way to be more restrictive than void* */
714FSEv06_DTable* FSEv06_createDTable(unsigned tableLog);
715void FSEv06_freeDTable(FSEv06_DTable* dt);
716
717/*! FSEv06_buildDTable():
718 Builds 'dt', which must be already allocated, using FSEv06_createDTable().
719 return : 0, or an errorCode, which can be tested using FSEv06_isError() */
720size_t FSEv06_buildDTable (FSEv06_DTable* dt, const short* normalizedCounter, unsigned maxSymbolValue, unsigned tableLog);
721
722/*! FSEv06_decompress_usingDTable():
723 Decompress compressed source `cSrc` of size `cSrcSize` using `dt`
724 into `dst` which must be already allocated.
725 @return : size of regenerated data (necessarily <= `dstCapacity`),
726 or an errorCode, which can be tested using FSEv06_isError() */
727size_t FSEv06_decompress_usingDTable(void* dst, size_t dstCapacity, const void* cSrc, size_t cSrcSize, const FSEv06_DTable* dt);
728
729/*!
730Tutorial :
731----------
732(Note : these functions only decompress FSE-compressed blocks.
733 If block is uncompressed, use memcpy() instead
734 If block is a single repeated byte, use memset() instead )
735
736The first step is to obtain the normalized frequencies of symbols.
737This can be performed by FSEv06_readNCount() if it was saved using FSEv06_writeNCount().
738'normalizedCounter' must be already allocated, and have at least 'maxSymbolValuePtr[0]+1' cells of signed short.
739In practice, that means it's necessary to know 'maxSymbolValue' beforehand,
740or size the table to handle worst case situations (typically 256).
741FSEv06_readNCount() will provide 'tableLog' and 'maxSymbolValue'.
742The result of FSEv06_readNCount() is the number of bytes read from 'rBuffer'.
743Note that 'rBufferSize' must be at least 4 bytes, even if useful information is less than that.
744If there is an error, the function will return an error code, which can be tested using FSEv06_isError().
745
746The next step is to build the decompression tables 'FSEv06_DTable' from 'normalizedCounter'.
747This is performed by the function FSEv06_buildDTable().
748The space required by 'FSEv06_DTable' must be already allocated using FSEv06_createDTable().
749If there is an error, the function will return an error code, which can be tested using FSEv06_isError().
750
751`FSEv06_DTable` can then be used to decompress `cSrc`, with FSEv06_decompress_usingDTable().
752`cSrcSize` must be strictly correct, otherwise decompression will fail.
753FSEv06_decompress_usingDTable() result will tell how many bytes were regenerated (<=`dstCapacity`).
754If there is an error, the function will return an error code, which can be tested using FSEv06_isError(). (ex: dst buffer too small)
755*/
756
757
758#if defined (__cplusplus)
759}
760#endif
761
762#endif /* FSEv06_H */
763/* ******************************************************************
764 bitstream
765 Part of FSE library
766 header file (to include)
767 Copyright (C) 2013-2016, Yann Collet.
768
769 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
770
771 Redistribution and use in source and binary forms, with or without
772 modification, are permitted provided that the following conditions are
773 met:
774
775 * Redistributions of source code must retain the above copyright
776 notice, this list of conditions and the following disclaimer.
777 * Redistributions in binary form must reproduce the above
778 copyright notice, this list of conditions and the following disclaimer
779 in the documentation and/or other materials provided with the
780 distribution.
781
782 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
783 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
784 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
785 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
786 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
787 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
788 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
789 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
790 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
791 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
792 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
793
794 You can contact the author at :
795 - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
796****************************************************************** */
797#ifndef BITSTREAM_H_MODULE
798#define BITSTREAM_H_MODULE
799
800#if defined (__cplusplus)
801extern "C" {
802#endif
803
804
805/*
806* This API consists of small unitary functions, which must be inlined for best performance.
807* Since link-time-optimization is not available for all compilers,
808* these functions are defined into a .h to be included.
809*/
810
811
812/*=========================================
813* Target specific
814=========================================*/
815#if defined(__BMI__) && defined(__GNUC__)
816# include <immintrin.h> /* support for bextr (experimental) */
817#endif
818
819
820
821/*-********************************************
822* bitStream decoding API (read backward)
823**********************************************/
824typedef struct
825{
826 size_t bitContainer;
827 unsigned bitsConsumed;
828 const char* ptr;
829 const char* start;
830} BITv06_DStream_t;
831
832typedef enum { BITv06_DStream_unfinished = 0,
833 BITv06_DStream_endOfBuffer = 1,
834 BITv06_DStream_completed = 2,
835 BITv06_DStream_overflow = 3 } BITv06_DStream_status; /* result of BITv06_reloadDStream() */
836 /* 1,2,4,8 would be better for bitmap combinations, but slows down performance a bit ... :( */
837
838MEM_STATIC size_t BITv06_initDStream(BITv06_DStream_t* bitD, const void* srcBuffer, size_t srcSize);
839MEM_STATIC size_t BITv06_readBits(BITv06_DStream_t* bitD, unsigned nbBits);
840MEM_STATIC BITv06_DStream_status BITv06_reloadDStream(BITv06_DStream_t* bitD);
841MEM_STATIC unsigned BITv06_endOfDStream(const BITv06_DStream_t* bitD);
842
843
844
845/*-****************************************
846* unsafe API
847******************************************/
848MEM_STATIC size_t BITv06_readBitsFast(BITv06_DStream_t* bitD, unsigned nbBits);
849/* faster, but works only if nbBits >= 1 */
850
851
852
853/*-**************************************************************
854* Internal functions
855****************************************************************/
856MEM_STATIC unsigned BITv06_highbit32 ( U32 val)
857{
858# if defined(_MSC_VER) /* Visual */
859 unsigned long r=0;
860 _BitScanReverse ( &r, val );
861 return (unsigned) r;
862# elif defined(__GNUC__) && (__GNUC__ >= 3) /* Use GCC Intrinsic */
863 return 31 - __builtin_clz (val);
864# else /* Software version */
865 static const unsigned DeBruijnClz[32] = { 0, 9, 1, 10, 13, 21, 2, 29, 11, 14, 16, 18, 22, 25, 3, 30, 8, 12, 20, 28, 15, 17, 24, 7, 19, 27, 23, 6, 26, 5, 4, 31 };
866 U32 v = val;
867 unsigned r;
868 v |= v >> 1;
869 v |= v >> 2;
870 v |= v >> 4;
871 v |= v >> 8;
872 v |= v >> 16;
873 r = DeBruijnClz[ (U32) (v * 0x07C4ACDDU) >> 27];
874 return r;
875# endif
876}
877
878
879
880/*-********************************************************
881* bitStream decoding
882**********************************************************/
883/*! BITv06_initDStream() :
884* Initialize a BITv06_DStream_t.
885* `bitD` : a pointer to an already allocated BITv06_DStream_t structure.
886* `srcSize` must be the *exact* size of the bitStream, in bytes.
887* @return : size of stream (== srcSize) or an errorCode if a problem is detected
888*/
889MEM_STATIC size_t BITv06_initDStream(BITv06_DStream_t* bitD, const void* srcBuffer, size_t srcSize)
890{
891 if (srcSize < 1) { memset(bitD, 0, sizeof(*bitD)); return ERROR(srcSize_wrong); }
892
893 if (srcSize >= sizeof(bitD->bitContainer)) { /* normal case */
894 bitD->start = (const char*)srcBuffer;
895 bitD->ptr = (const char*)srcBuffer + srcSize - sizeof(bitD->bitContainer);
896 bitD->bitContainer = MEM_readLEST(bitD->ptr);
897 { BYTE const lastByte = ((const BYTE*)srcBuffer)[srcSize-1];
898 if (lastByte == 0) return ERROR(GENERIC); /* endMark not present */
899 bitD->bitsConsumed = 8 - BITv06_highbit32(lastByte); }
900 } else {
901 bitD->start = (const char*)srcBuffer;
902 bitD->ptr = bitD->start;
903 bitD->bitContainer = *(const BYTE*)(bitD->start);
904 switch(srcSize)
905 {
906 case 7: bitD->bitContainer += (size_t)(((const BYTE*)(srcBuffer))[6]) << (sizeof(bitD->bitContainer)*8 - 16);/* fall-through */
907 case 6: bitD->bitContainer += (size_t)(((const BYTE*)(srcBuffer))[5]) << (sizeof(bitD->bitContainer)*8 - 24);/* fall-through */
908 case 5: bitD->bitContainer += (size_t)(((const BYTE*)(srcBuffer))[4]) << (sizeof(bitD->bitContainer)*8 - 32);/* fall-through */
909 case 4: bitD->bitContainer += (size_t)(((const BYTE*)(srcBuffer))[3]) << 24; /* fall-through */
910 case 3: bitD->bitContainer += (size_t)(((const BYTE*)(srcBuffer))[2]) << 16; /* fall-through */
911 case 2: bitD->bitContainer += (size_t)(((const BYTE*)(srcBuffer))[1]) << 8; /* fall-through */
912 default: break;
913 }
914 { BYTE const lastByte = ((const BYTE*)srcBuffer)[srcSize-1];
915 if (lastByte == 0) return ERROR(GENERIC); /* endMark not present */
916 bitD->bitsConsumed = 8 - BITv06_highbit32(lastByte); }
917 bitD->bitsConsumed += (U32)(sizeof(bitD->bitContainer) - srcSize)*8;
918 }
919
920 return srcSize;
921}
922
923
924 MEM_STATIC size_t BITv06_lookBits(const BITv06_DStream_t* bitD, U32 nbBits)
925{
926 U32 const bitMask = sizeof(bitD->bitContainer)*8 - 1;
927 return ((bitD->bitContainer << (bitD->bitsConsumed & bitMask)) >> 1) >> ((bitMask-nbBits) & bitMask);
928}
929
930/*! BITv06_lookBitsFast() :
931* unsafe version; only works only if nbBits >= 1 */
932MEM_STATIC size_t BITv06_lookBitsFast(const BITv06_DStream_t* bitD, U32 nbBits)
933{
934 U32 const bitMask = sizeof(bitD->bitContainer)*8 - 1;
935 return (bitD->bitContainer << (bitD->bitsConsumed & bitMask)) >> (((bitMask+1)-nbBits) & bitMask);
936}
937
938MEM_STATIC void BITv06_skipBits(BITv06_DStream_t* bitD, U32 nbBits)
939{
940 bitD->bitsConsumed += nbBits;
941}
942
943MEM_STATIC size_t BITv06_readBits(BITv06_DStream_t* bitD, U32 nbBits)
944{
945 size_t const value = BITv06_lookBits(bitD, nbBits);
946 BITv06_skipBits(bitD, nbBits);
947 return value;
948}
949
950/*! BITv06_readBitsFast() :
951* unsafe version; only works only if nbBits >= 1 */
952MEM_STATIC size_t BITv06_readBitsFast(BITv06_DStream_t* bitD, U32 nbBits)
953{
954 size_t const value = BITv06_lookBitsFast(bitD, nbBits);
955 BITv06_skipBits(bitD, nbBits);
956 return value;
957}
958
959MEM_STATIC BITv06_DStream_status BITv06_reloadDStream(BITv06_DStream_t* bitD)
960{
961 if (bitD->bitsConsumed > (sizeof(bitD->bitContainer)*8)) /* should never happen */
962 return BITv06_DStream_overflow;
963
964 if (bitD->ptr >= bitD->start + sizeof(bitD->bitContainer)) {
965 bitD->ptr -= bitD->bitsConsumed >> 3;
966 bitD->bitsConsumed &= 7;
967 bitD->bitContainer = MEM_readLEST(bitD->ptr);
968 return BITv06_DStream_unfinished;
969 }
970 if (bitD->ptr == bitD->start) {
971 if (bitD->bitsConsumed < sizeof(bitD->bitContainer)*8) return BITv06_DStream_endOfBuffer;
972 return BITv06_DStream_completed;
973 }
974 { U32 nbBytes = bitD->bitsConsumed >> 3;
975 BITv06_DStream_status result = BITv06_DStream_unfinished;
976 if (bitD->ptr - nbBytes < bitD->start) {
977 nbBytes = (U32)(bitD->ptr - bitD->start); /* ptr > start */
978 result = BITv06_DStream_endOfBuffer;
979 }
980 bitD->ptr -= nbBytes;
981 bitD->bitsConsumed -= nbBytes*8;
982 bitD->bitContainer = MEM_readLEST(bitD->ptr); /* reminder : srcSize > sizeof(bitD) */
983 return result;
984 }
985}
986
987/*! BITv06_endOfDStream() :
988* @return Tells if DStream has exactly reached its end (all bits consumed).
989*/
990MEM_STATIC unsigned BITv06_endOfDStream(const BITv06_DStream_t* DStream)
991{
992 return ((DStream->ptr == DStream->start) && (DStream->bitsConsumed == sizeof(DStream->bitContainer)*8));
993}
994
995#if defined (__cplusplus)
996}
997#endif
998
999#endif /* BITSTREAM_H_MODULE */
1000/* ******************************************************************
1001 FSE : Finite State Entropy coder
1002 header file for static linking (only)
1003 Copyright (C) 2013-2015, Yann Collet
1004
1005 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
1006
1007 Redistribution and use in source and binary forms, with or without
1008 modification, are permitted provided that the following conditions are
1009 met:
1010
1011 * Redistributions of source code must retain the above copyright
1012 notice, this list of conditions and the following disclaimer.
1013 * Redistributions in binary form must reproduce the above
1014 copyright notice, this list of conditions and the following disclaimer
1015 in the documentation and/or other materials provided with the
1016 distribution.
1017
1018 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1019 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1020 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1021 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1022 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1023 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1024 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1025 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1026 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1027 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1028 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1029
1030 You can contact the author at :
1031 - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
1032 - Public forum : https://groups.google.com/forum/#!forum/lz4c
1033****************************************************************** */
1034#ifndef FSEv06_STATIC_H
1035#define FSEv06_STATIC_H
1036
1037#if defined (__cplusplus)
1038extern "C" {
1039#endif
1040
1041
1042/* *****************************************
1043* Static allocation
1044*******************************************/
1045/* FSE buffer bounds */
1046#define FSEv06_NCOUNTBOUND 512
1047#define FSEv06_BLOCKBOUND(size) (size + (size>>7))
1048#define FSEv06_COMPRESSBOUND(size) (FSEv06_NCOUNTBOUND + FSEv06_BLOCKBOUND(size)) /* Macro version, useful for static allocation */
1049
1050/* It is possible to statically allocate FSE CTable/DTable as a table of unsigned using below macros */
1051#define FSEv06_DTABLE_SIZE_U32(maxTableLog) (1 + (1<<maxTableLog))
1052
1053
1054/* *****************************************
1055* FSE advanced API
1056*******************************************/
1057size_t FSEv06_countFast(unsigned* count, unsigned* maxSymbolValuePtr, const void* src, size_t srcSize);
1058/* same as FSEv06_count(), but blindly trusts that all byte values within src are <= *maxSymbolValuePtr */
1059
1060size_t FSEv06_buildDTable_raw (FSEv06_DTable* dt, unsigned nbBits);
1061/* build a fake FSEv06_DTable, designed to read an uncompressed bitstream where each symbol uses nbBits */
1062
1063size_t FSEv06_buildDTable_rle (FSEv06_DTable* dt, unsigned char symbolValue);
1064/* build a fake FSEv06_DTable, designed to always generate the same symbolValue */
1065
1066
1067/* *****************************************
1068* FSE symbol decompression API
1069*******************************************/
1070typedef struct
1071{
1072 size_t state;
1073 const void* table; /* precise table may vary, depending on U16 */
1074} FSEv06_DState_t;
1075
1076
1077static void FSEv06_initDState(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD, const FSEv06_DTable* dt);
1078
1079static unsigned char FSEv06_decodeSymbol(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD);
1080
1081
1082/* *****************************************
1083* FSE unsafe API
1084*******************************************/
1085static unsigned char FSEv06_decodeSymbolFast(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD);
1086/* faster, but works only if nbBits is always >= 1 (otherwise, result will be corrupted) */
1087
1088
1089/* *****************************************
1090* Implementation of inlined functions
1091*******************************************/
1092
1093
1094/* ====== Decompression ====== */
1095
1096typedef struct {
1097 U16 tableLog;
1098 U16 fastMode;
1099} FSEv06_DTableHeader; /* sizeof U32 */
1100
1101typedef struct
1102{
1103 unsigned short newState;
1104 unsigned char symbol;
1105 unsigned char nbBits;
1106} FSEv06_decode_t; /* size == U32 */
1107
1108MEM_STATIC void FSEv06_initDState(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD, const FSEv06_DTable* dt)
1109{
1110 const void* ptr = dt;
1111 const FSEv06_DTableHeader* const DTableH = (const FSEv06_DTableHeader*)ptr;
1112 DStatePtr->state = BITv06_readBits(bitD, DTableH->tableLog);
1113 BITv06_reloadDStream(bitD);
1114 DStatePtr->table = dt + 1;
1115}
1116
1117MEM_STATIC BYTE FSEv06_peekSymbol(const FSEv06_DState_t* DStatePtr)
1118{
1119 FSEv06_decode_t const DInfo = ((const FSEv06_decode_t*)(DStatePtr->table))[DStatePtr->state];
1120 return DInfo.symbol;
1121}
1122
1123MEM_STATIC void FSEv06_updateState(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD)
1124{
1125 FSEv06_decode_t const DInfo = ((const FSEv06_decode_t*)(DStatePtr->table))[DStatePtr->state];
1126 U32 const nbBits = DInfo.nbBits;
1127 size_t const lowBits = BITv06_readBits(bitD, nbBits);
1128 DStatePtr->state = DInfo.newState + lowBits;
1129}
1130
1131MEM_STATIC BYTE FSEv06_decodeSymbol(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD)
1132{
1133 FSEv06_decode_t const DInfo = ((const FSEv06_decode_t*)(DStatePtr->table))[DStatePtr->state];
1134 U32 const nbBits = DInfo.nbBits;
1135 BYTE const symbol = DInfo.symbol;
1136 size_t const lowBits = BITv06_readBits(bitD, nbBits);
1137
1138 DStatePtr->state = DInfo.newState + lowBits;
1139 return symbol;
1140}
1141
1142/*! FSEv06_decodeSymbolFast() :
1143 unsafe, only works if no symbol has a probability > 50% */
1144MEM_STATIC BYTE FSEv06_decodeSymbolFast(FSEv06_DState_t* DStatePtr, BITv06_DStream_t* bitD)
1145{
1146 FSEv06_decode_t const DInfo = ((const FSEv06_decode_t*)(DStatePtr->table))[DStatePtr->state];
1147 U32 const nbBits = DInfo.nbBits;
1148 BYTE const symbol = DInfo.symbol;
1149 size_t const lowBits = BITv06_readBitsFast(bitD, nbBits);
1150
1151 DStatePtr->state = DInfo.newState + lowBits;
1152 return symbol;
1153}
1154
1155
1156
1157#ifndef FSEv06_COMMONDEFS_ONLY
1158
1159/* **************************************************************
1160* Tuning parameters
1161****************************************************************/
1162/*!MEMORY_USAGE :
1163* Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.)
1164* Increasing memory usage improves compression ratio
1165* Reduced memory usage can improve speed, due to cache effect
1166* Recommended max value is 14, for 16KB, which nicely fits into Intel x86 L1 cache */
1167#define FSEv06_MAX_MEMORY_USAGE 14
1168#define FSEv06_DEFAULT_MEMORY_USAGE 13
1169
1170/*!FSEv06_MAX_SYMBOL_VALUE :
1171* Maximum symbol value authorized.
1172* Required for proper stack allocation */
1173#define FSEv06_MAX_SYMBOL_VALUE 255
1174
1175
1176/* **************************************************************
1177* template functions type & suffix
1178****************************************************************/
1179#define FSEv06_FUNCTION_TYPE BYTE
1180#define FSEv06_FUNCTION_EXTENSION
1181#define FSEv06_DECODE_TYPE FSEv06_decode_t
1182
1183
1184#endif /* !FSEv06_COMMONDEFS_ONLY */
1185
1186
1187/* ***************************************************************
1188* Constants
1189*****************************************************************/
1190#define FSEv06_MAX_TABLELOG (FSEv06_MAX_MEMORY_USAGE-2)
1191#define FSEv06_MAX_TABLESIZE (1U<<FSEv06_MAX_TABLELOG)
1192#define FSEv06_MAXTABLESIZE_MASK (FSEv06_MAX_TABLESIZE-1)
1193#define FSEv06_DEFAULT_TABLELOG (FSEv06_DEFAULT_MEMORY_USAGE-2)
1194#define FSEv06_MIN_TABLELOG 5
1195
1196#define FSEv06_TABLELOG_ABSOLUTE_MAX 15
1197#if FSEv06_MAX_TABLELOG > FSEv06_TABLELOG_ABSOLUTE_MAX
1198#error "FSEv06_MAX_TABLELOG > FSEv06_TABLELOG_ABSOLUTE_MAX is not supported"
1199#endif
1200
1201#define FSEv06_TABLESTEP(tableSize) ((tableSize>>1) + (tableSize>>3) + 3)
1202
1203
1204#if defined (__cplusplus)
1205}
1206#endif
1207
1208#endif /* FSEv06_STATIC_H */
1209/*
1210 Common functions of New Generation Entropy library
1211 Copyright (C) 2016, Yann Collet.
1212
1213 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
1214
1215 Redistribution and use in source and binary forms, with or without
1216 modification, are permitted provided that the following conditions are
1217 met:
1218
1219 * Redistributions of source code must retain the above copyright
1220 notice, this list of conditions and the following disclaimer.
1221 * Redistributions in binary form must reproduce the above
1222 copyright notice, this list of conditions and the following disclaimer
1223 in the documentation and/or other materials provided with the
1224 distribution.
1225
1226 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1227 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1228 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1229 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1230 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1231 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1232 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1233 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1234 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1235 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1236 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1237
1238 You can contact the author at :
1239 - FSE+HUF source repository : https://github.com/Cyan4973/FiniteStateEntropy
1240 - Public forum : https://groups.google.com/forum/#!forum/lz4c
1241*************************************************************************** */
1242
1243
1244/*-****************************************
1245* FSE Error Management
1246******************************************/
1247unsigned FSEv06_isError(size_t code) { return ERR_isError(code); }
1248
1249const char* FSEv06_getErrorName(size_t code) { return ERR_getErrorName(code); }
1250
1251
1252/* **************************************************************
1253* HUF Error Management
1254****************************************************************/
Abhilash S.L3b494632019-07-16 15:51:09 +05301255static unsigned HUFv06_isError(size_t code) { return ERR_isError(code); }
William Kurkianea869482019-04-09 15:16:11 -04001256
1257
1258/*-**************************************************************
1259* FSE NCount encoding-decoding
1260****************************************************************/
1261static short FSEv06_abs(short a) { return a<0 ? -a : a; }
1262
1263size_t FSEv06_readNCount (short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
1264 const void* headerBuffer, size_t hbSize)
1265{
1266 const BYTE* const istart = (const BYTE*) headerBuffer;
1267 const BYTE* const iend = istart + hbSize;
1268 const BYTE* ip = istart;
1269 int nbBits;
1270 int remaining;
1271 int threshold;
1272 U32 bitStream;
1273 int bitCount;
1274 unsigned charnum = 0;
1275 int previous0 = 0;
1276
1277 if (hbSize < 4) return ERROR(srcSize_wrong);
1278 bitStream = MEM_readLE32(ip);
1279 nbBits = (bitStream & 0xF) + FSEv06_MIN_TABLELOG; /* extract tableLog */
1280 if (nbBits > FSEv06_TABLELOG_ABSOLUTE_MAX) return ERROR(tableLog_tooLarge);
1281 bitStream >>= 4;
1282 bitCount = 4;
1283 *tableLogPtr = nbBits;
1284 remaining = (1<<nbBits)+1;
1285 threshold = 1<<nbBits;
1286 nbBits++;
1287
1288 while ((remaining>1) && (charnum<=*maxSVPtr)) {
1289 if (previous0) {
1290 unsigned n0 = charnum;
1291 while ((bitStream & 0xFFFF) == 0xFFFF) {
1292 n0+=24;
1293 if (ip < iend-5) {
1294 ip+=2;
1295 bitStream = MEM_readLE32(ip) >> bitCount;
1296 } else {
1297 bitStream >>= 16;
1298 bitCount+=16;
1299 } }
1300 while ((bitStream & 3) == 3) {
1301 n0+=3;
1302 bitStream>>=2;
1303 bitCount+=2;
1304 }
1305 n0 += bitStream & 3;
1306 bitCount += 2;
1307 if (n0 > *maxSVPtr) return ERROR(maxSymbolValue_tooSmall);
1308 while (charnum < n0) normalizedCounter[charnum++] = 0;
1309 if ((ip <= iend-7) || (ip + (bitCount>>3) <= iend-4)) {
1310 ip += bitCount>>3;
1311 bitCount &= 7;
1312 bitStream = MEM_readLE32(ip) >> bitCount;
1313 }
1314 else
1315 bitStream >>= 2;
1316 }
1317 { short const max = (short)((2*threshold-1)-remaining);
1318 short count;
1319
1320 if ((bitStream & (threshold-1)) < (U32)max) {
1321 count = (short)(bitStream & (threshold-1));
1322 bitCount += nbBits-1;
1323 } else {
1324 count = (short)(bitStream & (2*threshold-1));
1325 if (count >= threshold) count -= max;
1326 bitCount += nbBits;
1327 }
1328
1329 count--; /* extra accuracy */
1330 remaining -= FSEv06_abs(count);
1331 normalizedCounter[charnum++] = count;
1332 previous0 = !count;
1333 while (remaining < threshold) {
1334 nbBits--;
1335 threshold >>= 1;
1336 }
1337
1338 if ((ip <= iend-7) || (ip + (bitCount>>3) <= iend-4)) {
1339 ip += bitCount>>3;
1340 bitCount &= 7;
1341 } else {
1342 bitCount -= (int)(8 * (iend - 4 - ip));
1343 ip = iend - 4;
1344 }
1345 bitStream = MEM_readLE32(ip) >> (bitCount & 31);
1346 } } /* while ((remaining>1) && (charnum<=*maxSVPtr)) */
1347 if (remaining != 1) return ERROR(GENERIC);
1348 *maxSVPtr = charnum-1;
1349
1350 ip += (bitCount+7)>>3;
1351 if ((size_t)(ip-istart) > hbSize) return ERROR(srcSize_wrong);
1352 return ip-istart;
1353}
1354/* ******************************************************************
1355 FSE : Finite State Entropy decoder
1356 Copyright (C) 2013-2015, Yann Collet.
1357
1358 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
1359
1360 Redistribution and use in source and binary forms, with or without
1361 modification, are permitted provided that the following conditions are
1362 met:
1363
1364 * Redistributions of source code must retain the above copyright
1365 notice, this list of conditions and the following disclaimer.
1366 * Redistributions in binary form must reproduce the above
1367 copyright notice, this list of conditions and the following disclaimer
1368 in the documentation and/or other materials provided with the
1369 distribution.
1370
1371 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1372 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1373 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1374 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1375 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1376 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1377 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1378 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1379 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1380 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1381 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1382
1383 You can contact the author at :
1384 - FSE source repository : https://github.com/Cyan4973/FiniteStateEntropy
1385 - Public forum : https://groups.google.com/forum/#!forum/lz4c
1386****************************************************************** */
1387
1388
1389/* **************************************************************
1390* Compiler specifics
1391****************************************************************/
1392#ifdef _MSC_VER /* Visual Studio */
1393# define FORCE_INLINE static __forceinline
1394# include <intrin.h> /* For Visual 2005 */
1395# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
1396# pragma warning(disable : 4214) /* disable: C4214: non-int bitfields */
1397#else
1398# if defined (__cplusplus) || defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L /* C99 */
1399# ifdef __GNUC__
1400# define FORCE_INLINE static inline __attribute__((always_inline))
1401# else
1402# define FORCE_INLINE static inline
1403# endif
1404# else
1405# define FORCE_INLINE static
1406# endif /* __STDC_VERSION__ */
1407#endif
1408
1409
1410/* **************************************************************
1411* Error Management
1412****************************************************************/
1413#define FSEv06_isError ERR_isError
1414#define FSEv06_STATIC_ASSERT(c) { enum { FSEv06_static_assert = 1/(int)(!!(c)) }; } /* use only *after* variable declarations */
1415
1416
1417/* **************************************************************
1418* Complex types
1419****************************************************************/
1420typedef U32 DTable_max_t[FSEv06_DTABLE_SIZE_U32(FSEv06_MAX_TABLELOG)];
1421
1422
1423/* **************************************************************
1424* Templates
1425****************************************************************/
1426/*
1427 designed to be included
1428 for type-specific functions (template emulation in C)
1429 Objective is to write these functions only once, for improved maintenance
1430*/
1431
1432/* safety checks */
1433#ifndef FSEv06_FUNCTION_EXTENSION
1434# error "FSEv06_FUNCTION_EXTENSION must be defined"
1435#endif
1436#ifndef FSEv06_FUNCTION_TYPE
1437# error "FSEv06_FUNCTION_TYPE must be defined"
1438#endif
1439
1440/* Function names */
1441#define FSEv06_CAT(X,Y) X##Y
1442#define FSEv06_FUNCTION_NAME(X,Y) FSEv06_CAT(X,Y)
1443#define FSEv06_TYPE_NAME(X,Y) FSEv06_CAT(X,Y)
1444
1445
1446/* Function templates */
1447FSEv06_DTable* FSEv06_createDTable (unsigned tableLog)
1448{
1449 if (tableLog > FSEv06_TABLELOG_ABSOLUTE_MAX) tableLog = FSEv06_TABLELOG_ABSOLUTE_MAX;
1450 return (FSEv06_DTable*)malloc( FSEv06_DTABLE_SIZE_U32(tableLog) * sizeof (U32) );
1451}
1452
1453void FSEv06_freeDTable (FSEv06_DTable* dt)
1454{
1455 free(dt);
1456}
1457
1458size_t FSEv06_buildDTable(FSEv06_DTable* dt, const short* normalizedCounter, unsigned maxSymbolValue, unsigned tableLog)
1459{
1460 void* const tdPtr = dt+1; /* because *dt is unsigned, 32-bits aligned on 32-bits */
1461 FSEv06_DECODE_TYPE* const tableDecode = (FSEv06_DECODE_TYPE*) (tdPtr);
1462 U16 symbolNext[FSEv06_MAX_SYMBOL_VALUE+1];
1463
1464 U32 const maxSV1 = maxSymbolValue + 1;
1465 U32 const tableSize = 1 << tableLog;
1466 U32 highThreshold = tableSize-1;
1467
1468 /* Sanity Checks */
1469 if (maxSymbolValue > FSEv06_MAX_SYMBOL_VALUE) return ERROR(maxSymbolValue_tooLarge);
1470 if (tableLog > FSEv06_MAX_TABLELOG) return ERROR(tableLog_tooLarge);
1471
1472 /* Init, lay down lowprob symbols */
1473 { FSEv06_DTableHeader DTableH;
1474 DTableH.tableLog = (U16)tableLog;
1475 DTableH.fastMode = 1;
1476 { S16 const largeLimit= (S16)(1 << (tableLog-1));
1477 U32 s;
1478 for (s=0; s<maxSV1; s++) {
1479 if (normalizedCounter[s]==-1) {
1480 tableDecode[highThreshold--].symbol = (FSEv06_FUNCTION_TYPE)s;
1481 symbolNext[s] = 1;
1482 } else {
1483 if (normalizedCounter[s] >= largeLimit) DTableH.fastMode=0;
1484 symbolNext[s] = normalizedCounter[s];
1485 } } }
1486 memcpy(dt, &DTableH, sizeof(DTableH));
1487 }
1488
1489 /* Spread symbols */
1490 { U32 const tableMask = tableSize-1;
1491 U32 const step = FSEv06_TABLESTEP(tableSize);
1492 U32 s, position = 0;
1493 for (s=0; s<maxSV1; s++) {
1494 int i;
1495 for (i=0; i<normalizedCounter[s]; i++) {
1496 tableDecode[position].symbol = (FSEv06_FUNCTION_TYPE)s;
1497 position = (position + step) & tableMask;
1498 while (position > highThreshold) position = (position + step) & tableMask; /* lowprob area */
1499 } }
1500
1501 if (position!=0) return ERROR(GENERIC); /* position must reach all cells once, otherwise normalizedCounter is incorrect */
1502 }
1503
1504 /* Build Decoding table */
1505 { U32 u;
1506 for (u=0; u<tableSize; u++) {
1507 FSEv06_FUNCTION_TYPE const symbol = (FSEv06_FUNCTION_TYPE)(tableDecode[u].symbol);
1508 U16 nextState = symbolNext[symbol]++;
1509 tableDecode[u].nbBits = (BYTE) (tableLog - BITv06_highbit32 ((U32)nextState) );
1510 tableDecode[u].newState = (U16) ( (nextState << tableDecode[u].nbBits) - tableSize);
1511 } }
1512
1513 return 0;
1514}
1515
1516
1517
1518#ifndef FSEv06_COMMONDEFS_ONLY
1519
1520/*-*******************************************************
1521* Decompression (Byte symbols)
1522*********************************************************/
1523size_t FSEv06_buildDTable_rle (FSEv06_DTable* dt, BYTE symbolValue)
1524{
1525 void* ptr = dt;
1526 FSEv06_DTableHeader* const DTableH = (FSEv06_DTableHeader*)ptr;
1527 void* dPtr = dt + 1;
1528 FSEv06_decode_t* const cell = (FSEv06_decode_t*)dPtr;
1529
1530 DTableH->tableLog = 0;
1531 DTableH->fastMode = 0;
1532
1533 cell->newState = 0;
1534 cell->symbol = symbolValue;
1535 cell->nbBits = 0;
1536
1537 return 0;
1538}
1539
1540
1541size_t FSEv06_buildDTable_raw (FSEv06_DTable* dt, unsigned nbBits)
1542{
1543 void* ptr = dt;
1544 FSEv06_DTableHeader* const DTableH = (FSEv06_DTableHeader*)ptr;
1545 void* dPtr = dt + 1;
1546 FSEv06_decode_t* const dinfo = (FSEv06_decode_t*)dPtr;
1547 const unsigned tableSize = 1 << nbBits;
1548 const unsigned tableMask = tableSize - 1;
1549 const unsigned maxSV1 = tableMask+1;
1550 unsigned s;
1551
1552 /* Sanity checks */
1553 if (nbBits < 1) return ERROR(GENERIC); /* min size */
1554
1555 /* Build Decoding Table */
1556 DTableH->tableLog = (U16)nbBits;
1557 DTableH->fastMode = 1;
1558 for (s=0; s<maxSV1; s++) {
1559 dinfo[s].newState = 0;
1560 dinfo[s].symbol = (BYTE)s;
1561 dinfo[s].nbBits = (BYTE)nbBits;
1562 }
1563
1564 return 0;
1565}
1566
1567FORCE_INLINE size_t FSEv06_decompress_usingDTable_generic(
1568 void* dst, size_t maxDstSize,
1569 const void* cSrc, size_t cSrcSize,
1570 const FSEv06_DTable* dt, const unsigned fast)
1571{
1572 BYTE* const ostart = (BYTE*) dst;
1573 BYTE* op = ostart;
1574 BYTE* const omax = op + maxDstSize;
1575 BYTE* const olimit = omax-3;
1576
1577 BITv06_DStream_t bitD;
1578 FSEv06_DState_t state1;
1579 FSEv06_DState_t state2;
1580
1581 /* Init */
1582 { size_t const errorCode = BITv06_initDStream(&bitD, cSrc, cSrcSize); /* replaced last arg by maxCompressed Size */
1583 if (FSEv06_isError(errorCode)) return errorCode; }
1584
1585 FSEv06_initDState(&state1, &bitD, dt);
1586 FSEv06_initDState(&state2, &bitD, dt);
1587
1588#define FSEv06_GETSYMBOL(statePtr) fast ? FSEv06_decodeSymbolFast(statePtr, &bitD) : FSEv06_decodeSymbol(statePtr, &bitD)
1589
1590 /* 4 symbols per loop */
1591 for ( ; (BITv06_reloadDStream(&bitD)==BITv06_DStream_unfinished) && (op<olimit) ; op+=4) {
1592 op[0] = FSEv06_GETSYMBOL(&state1);
1593
1594 if (FSEv06_MAX_TABLELOG*2+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
1595 BITv06_reloadDStream(&bitD);
1596
1597 op[1] = FSEv06_GETSYMBOL(&state2);
1598
1599 if (FSEv06_MAX_TABLELOG*4+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
1600 { if (BITv06_reloadDStream(&bitD) > BITv06_DStream_unfinished) { op+=2; break; } }
1601
1602 op[2] = FSEv06_GETSYMBOL(&state1);
1603
1604 if (FSEv06_MAX_TABLELOG*2+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
1605 BITv06_reloadDStream(&bitD);
1606
1607 op[3] = FSEv06_GETSYMBOL(&state2);
1608 }
1609
1610 /* tail */
1611 /* note : BITv06_reloadDStream(&bitD) >= FSEv06_DStream_partiallyFilled; Ends at exactly BITv06_DStream_completed */
1612 while (1) {
1613 if (op>(omax-2)) return ERROR(dstSize_tooSmall);
1614
1615 *op++ = FSEv06_GETSYMBOL(&state1);
1616
1617 if (BITv06_reloadDStream(&bitD)==BITv06_DStream_overflow) {
1618 *op++ = FSEv06_GETSYMBOL(&state2);
1619 break;
1620 }
1621
1622 if (op>(omax-2)) return ERROR(dstSize_tooSmall);
1623
1624 *op++ = FSEv06_GETSYMBOL(&state2);
1625
1626 if (BITv06_reloadDStream(&bitD)==BITv06_DStream_overflow) {
1627 *op++ = FSEv06_GETSYMBOL(&state1);
1628 break;
1629 } }
1630
1631 return op-ostart;
1632}
1633
1634
1635size_t FSEv06_decompress_usingDTable(void* dst, size_t originalSize,
1636 const void* cSrc, size_t cSrcSize,
1637 const FSEv06_DTable* dt)
1638{
1639 const void* ptr = dt;
1640 const FSEv06_DTableHeader* DTableH = (const FSEv06_DTableHeader*)ptr;
1641 const U32 fastMode = DTableH->fastMode;
1642
1643 /* select fast mode (static) */
1644 if (fastMode) return FSEv06_decompress_usingDTable_generic(dst, originalSize, cSrc, cSrcSize, dt, 1);
1645 return FSEv06_decompress_usingDTable_generic(dst, originalSize, cSrc, cSrcSize, dt, 0);
1646}
1647
1648
1649size_t FSEv06_decompress(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize)
1650{
1651 const BYTE* const istart = (const BYTE*)cSrc;
1652 const BYTE* ip = istart;
1653 short counting[FSEv06_MAX_SYMBOL_VALUE+1];
1654 DTable_max_t dt; /* Static analyzer seems unable to understand this table will be properly initialized later */
1655 unsigned tableLog;
1656 unsigned maxSymbolValue = FSEv06_MAX_SYMBOL_VALUE;
1657
1658 if (cSrcSize<2) return ERROR(srcSize_wrong); /* too small input size */
1659
1660 /* normal FSE decoding mode */
1661 { size_t const NCountLength = FSEv06_readNCount (counting, &maxSymbolValue, &tableLog, istart, cSrcSize);
1662 if (FSEv06_isError(NCountLength)) return NCountLength;
1663 if (NCountLength >= cSrcSize) return ERROR(srcSize_wrong); /* too small input size */
1664 ip += NCountLength;
1665 cSrcSize -= NCountLength;
1666 }
1667
1668 { size_t const errorCode = FSEv06_buildDTable (dt, counting, maxSymbolValue, tableLog);
1669 if (FSEv06_isError(errorCode)) return errorCode; }
1670
1671 return FSEv06_decompress_usingDTable (dst, maxDstSize, ip, cSrcSize, dt); /* always return, even if it is an error code */
1672}
1673
1674
1675
1676#endif /* FSEv06_COMMONDEFS_ONLY */
1677/* ******************************************************************
1678 Huffman coder, part of New Generation Entropy library
1679 header file
1680 Copyright (C) 2013-2016, Yann Collet.
1681
1682 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
1683
1684 Redistribution and use in source and binary forms, with or without
1685 modification, are permitted provided that the following conditions are
1686 met:
1687
1688 * Redistributions of source code must retain the above copyright
1689 notice, this list of conditions and the following disclaimer.
1690 * Redistributions in binary form must reproduce the above
1691 copyright notice, this list of conditions and the following disclaimer
1692 in the documentation and/or other materials provided with the
1693 distribution.
1694
1695 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1696 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1697 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1698 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1699 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1700 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1701 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1702 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1703 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1704 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1705 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1706
1707 You can contact the author at :
1708 - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
1709****************************************************************** */
1710#ifndef HUFv06_H
1711#define HUFv06_H
1712
1713#if defined (__cplusplus)
1714extern "C" {
1715#endif
1716
1717
1718/* ****************************************
1719* HUF simple functions
1720******************************************/
1721size_t HUFv06_decompress(void* dst, size_t dstSize,
1722 const void* cSrc, size_t cSrcSize);
1723/*
1724HUFv06_decompress() :
1725 Decompress HUF data from buffer 'cSrc', of size 'cSrcSize',
1726 into already allocated destination buffer 'dst', of size 'dstSize'.
1727 `dstSize` : must be the **exact** size of original (uncompressed) data.
1728 Note : in contrast with FSE, HUFv06_decompress can regenerate
1729 RLE (cSrcSize==1) and uncompressed (cSrcSize==dstSize) data,
1730 because it knows size to regenerate.
1731 @return : size of regenerated data (== dstSize)
1732 or an error code, which can be tested using HUFv06_isError()
1733*/
1734
1735
1736/* ****************************************
1737* Tool functions
1738******************************************/
1739size_t HUFv06_compressBound(size_t size); /**< maximum compressed size */
1740
1741
1742#if defined (__cplusplus)
1743}
1744#endif
1745
1746#endif /* HUFv06_H */
1747/* ******************************************************************
1748 Huffman codec, part of New Generation Entropy library
1749 header file, for static linking only
1750 Copyright (C) 2013-2016, Yann Collet
1751
1752 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
1753
1754 Redistribution and use in source and binary forms, with or without
1755 modification, are permitted provided that the following conditions are
1756 met:
1757
1758 * Redistributions of source code must retain the above copyright
1759 notice, this list of conditions and the following disclaimer.
1760 * Redistributions in binary form must reproduce the above
1761 copyright notice, this list of conditions and the following disclaimer
1762 in the documentation and/or other materials provided with the
1763 distribution.
1764
1765 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1766 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1767 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1768 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1769 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1770 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1771 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1772 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1773 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1774 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1775 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1776
1777 You can contact the author at :
1778 - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
1779****************************************************************** */
1780#ifndef HUFv06_STATIC_H
1781#define HUFv06_STATIC_H
1782
1783#if defined (__cplusplus)
1784extern "C" {
1785#endif
1786
1787
1788/* ****************************************
1789* Static allocation
1790******************************************/
1791/* HUF buffer bounds */
1792#define HUFv06_CTABLEBOUND 129
1793#define HUFv06_BLOCKBOUND(size) (size + (size>>8) + 8) /* only true if incompressible pre-filtered with fast heuristic */
1794#define HUFv06_COMPRESSBOUND(size) (HUFv06_CTABLEBOUND + HUFv06_BLOCKBOUND(size)) /* Macro version, useful for static allocation */
1795
1796/* static allocation of HUF's DTable */
1797#define HUFv06_DTABLE_SIZE(maxTableLog) (1 + (1<<maxTableLog))
1798#define HUFv06_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) \
1799 unsigned short DTable[HUFv06_DTABLE_SIZE(maxTableLog)] = { maxTableLog }
1800#define HUFv06_CREATE_STATIC_DTABLEX4(DTable, maxTableLog) \
1801 unsigned int DTable[HUFv06_DTABLE_SIZE(maxTableLog)] = { maxTableLog }
1802#define HUFv06_CREATE_STATIC_DTABLEX6(DTable, maxTableLog) \
1803 unsigned int DTable[HUFv06_DTABLE_SIZE(maxTableLog) * 3 / 2] = { maxTableLog }
1804
1805
1806/* ****************************************
1807* Advanced decompression functions
1808******************************************/
1809size_t HUFv06_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* single-symbol decoder */
1810size_t HUFv06_decompress4X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* double-symbols decoder */
1811
1812
1813
1814/*!
1815HUFv06_decompress() does the following:
18161. select the decompression algorithm (X2, X4, X6) based on pre-computed heuristics
18172. build Huffman table from save, using HUFv06_readDTableXn()
18183. decode 1 or 4 segments in parallel using HUFv06_decompressSXn_usingDTable
1819*/
1820size_t HUFv06_readDTableX2 (unsigned short* DTable, const void* src, size_t srcSize);
1821size_t HUFv06_readDTableX4 (unsigned* DTable, const void* src, size_t srcSize);
1822
1823size_t HUFv06_decompress4X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const unsigned short* DTable);
1824size_t HUFv06_decompress4X4_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const unsigned* DTable);
1825
1826
1827/* single stream variants */
1828size_t HUFv06_decompress1X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* single-symbol decoder */
1829size_t HUFv06_decompress1X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* double-symbol decoder */
1830
1831size_t HUFv06_decompress1X2_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const unsigned short* DTable);
1832size_t HUFv06_decompress1X4_usingDTable(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize, const unsigned* DTable);
1833
1834
1835
1836/* **************************************************************
1837* Constants
1838****************************************************************/
1839#define HUFv06_ABSOLUTEMAX_TABLELOG 16 /* absolute limit of HUFv06_MAX_TABLELOG. Beyond that value, code does not work */
1840#define HUFv06_MAX_TABLELOG 12 /* max configured tableLog (for static allocation); can be modified up to HUFv06_ABSOLUTEMAX_TABLELOG */
1841#define HUFv06_DEFAULT_TABLELOG HUFv06_MAX_TABLELOG /* tableLog by default, when not specified */
1842#define HUFv06_MAX_SYMBOL_VALUE 255
1843#if (HUFv06_MAX_TABLELOG > HUFv06_ABSOLUTEMAX_TABLELOG)
1844# error "HUFv06_MAX_TABLELOG is too large !"
1845#endif
1846
1847
1848
1849/*! HUFv06_readStats() :
1850 Read compact Huffman tree, saved by HUFv06_writeCTable().
1851 `huffWeight` is destination buffer.
1852 @return : size read from `src`
1853*/
1854MEM_STATIC size_t HUFv06_readStats(BYTE* huffWeight, size_t hwSize, U32* rankStats,
1855 U32* nbSymbolsPtr, U32* tableLogPtr,
1856 const void* src, size_t srcSize)
1857{
1858 U32 weightTotal;
1859 const BYTE* ip = (const BYTE*) src;
1860 size_t iSize;
1861 size_t oSize;
1862
1863 if (!srcSize) return ERROR(srcSize_wrong);
1864 iSize = ip[0];
1865 //memset(huffWeight, 0, hwSize); /* is not necessary, even though some analyzer complain ... */
1866
1867 if (iSize >= 128) { /* special header */
1868 if (iSize >= (242)) { /* RLE */
1869 static U32 l[14] = { 1, 2, 3, 4, 7, 8, 15, 16, 31, 32, 63, 64, 127, 128 };
1870 oSize = l[iSize-242];
1871 memset(huffWeight, 1, hwSize);
1872 iSize = 0;
1873 }
1874 else { /* Incompressible */
1875 oSize = iSize - 127;
1876 iSize = ((oSize+1)/2);
1877 if (iSize+1 > srcSize) return ERROR(srcSize_wrong);
1878 if (oSize >= hwSize) return ERROR(corruption_detected);
1879 ip += 1;
1880 { U32 n;
1881 for (n=0; n<oSize; n+=2) {
1882 huffWeight[n] = ip[n/2] >> 4;
1883 huffWeight[n+1] = ip[n/2] & 15;
1884 } } } }
1885 else { /* header compressed with FSE (normal case) */
1886 if (iSize+1 > srcSize) return ERROR(srcSize_wrong);
1887 oSize = FSEv06_decompress(huffWeight, hwSize-1, ip+1, iSize); /* max (hwSize-1) values decoded, as last one is implied */
1888 if (FSEv06_isError(oSize)) return oSize;
1889 }
1890
1891 /* collect weight stats */
1892 memset(rankStats, 0, (HUFv06_ABSOLUTEMAX_TABLELOG + 1) * sizeof(U32));
1893 weightTotal = 0;
1894 { U32 n; for (n=0; n<oSize; n++) {
1895 if (huffWeight[n] >= HUFv06_ABSOLUTEMAX_TABLELOG) return ERROR(corruption_detected);
1896 rankStats[huffWeight[n]]++;
1897 weightTotal += (1 << huffWeight[n]) >> 1;
1898 } }
1899 if (weightTotal == 0) return ERROR(corruption_detected);
1900
1901 /* get last non-null symbol weight (implied, total must be 2^n) */
1902 { U32 const tableLog = BITv06_highbit32(weightTotal) + 1;
1903 if (tableLog > HUFv06_ABSOLUTEMAX_TABLELOG) return ERROR(corruption_detected);
1904 *tableLogPtr = tableLog;
1905 /* determine last weight */
1906 { U32 const total = 1 << tableLog;
1907 U32 const rest = total - weightTotal;
1908 U32 const verif = 1 << BITv06_highbit32(rest);
1909 U32 const lastWeight = BITv06_highbit32(rest) + 1;
1910 if (verif != rest) return ERROR(corruption_detected); /* last value must be a clean power of 2 */
1911 huffWeight[oSize] = (BYTE)lastWeight;
1912 rankStats[lastWeight]++;
1913 } }
1914
1915 /* check tree construction validity */
1916 if ((rankStats[1] < 2) || (rankStats[1] & 1)) return ERROR(corruption_detected); /* by construction : at least 2 elts of rank 1, must be even */
1917
1918 /* results */
1919 *nbSymbolsPtr = (U32)(oSize+1);
1920 return iSize+1;
1921}
1922
1923
1924
1925#if defined (__cplusplus)
1926}
1927#endif
1928
1929#endif /* HUFv06_STATIC_H */
1930/* ******************************************************************
1931 Huffman decoder, part of New Generation Entropy library
1932 Copyright (C) 2013-2016, Yann Collet.
1933
1934 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
1935
1936 Redistribution and use in source and binary forms, with or without
1937 modification, are permitted provided that the following conditions are
1938 met:
1939
1940 * Redistributions of source code must retain the above copyright
1941 notice, this list of conditions and the following disclaimer.
1942 * Redistributions in binary form must reproduce the above
1943 copyright notice, this list of conditions and the following disclaimer
1944 in the documentation and/or other materials provided with the
1945 distribution.
1946
1947 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1948 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1949 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1950 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1951 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1952 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1953 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1954 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1955 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1956 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1957 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1958
1959 You can contact the author at :
1960 - FSE+HUF source repository : https://github.com/Cyan4973/FiniteStateEntropy
1961 - Public forum : https://groups.google.com/forum/#!forum/lz4c
1962****************************************************************** */
1963
1964/* **************************************************************
1965* Compiler specifics
1966****************************************************************/
1967#if defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
1968/* inline is defined */
1969#elif defined(_MSC_VER)
1970# define inline __inline
1971#else
1972# define inline /* disable inline */
1973#endif
1974
1975
1976#ifdef _MSC_VER /* Visual Studio */
1977# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
1978#endif
1979
1980
1981
1982/* **************************************************************
1983* Error Management
1984****************************************************************/
1985#define HUFv06_STATIC_ASSERT(c) { enum { HUFv06_static_assert = 1/(int)(!!(c)) }; } /* use only *after* variable declarations */
1986
1987
1988
1989/* *******************************************************
1990* HUF : Huffman block decompression
1991*********************************************************/
1992typedef struct { BYTE byte; BYTE nbBits; } HUFv06_DEltX2; /* single-symbol decoding */
1993
1994typedef struct { U16 sequence; BYTE nbBits; BYTE length; } HUFv06_DEltX4; /* double-symbols decoding */
1995
1996typedef struct { BYTE symbol; BYTE weight; } sortedSymbol_t;
1997
1998
1999
2000/*-***************************/
2001/* single-symbol decoding */
2002/*-***************************/
2003
2004size_t HUFv06_readDTableX2 (U16* DTable, const void* src, size_t srcSize)
2005{
2006 BYTE huffWeight[HUFv06_MAX_SYMBOL_VALUE + 1];
2007 U32 rankVal[HUFv06_ABSOLUTEMAX_TABLELOG + 1]; /* large enough for values from 0 to 16 */
2008 U32 tableLog = 0;
2009 size_t iSize;
2010 U32 nbSymbols = 0;
2011 U32 n;
2012 U32 nextRankStart;
2013 void* const dtPtr = DTable + 1;
2014 HUFv06_DEltX2* const dt = (HUFv06_DEltX2*)dtPtr;
2015
2016 HUFv06_STATIC_ASSERT(sizeof(HUFv06_DEltX2) == sizeof(U16)); /* if compilation fails here, assertion is false */
2017 //memset(huffWeight, 0, sizeof(huffWeight)); /* is not necessary, even though some analyzer complain ... */
2018
2019 iSize = HUFv06_readStats(huffWeight, HUFv06_MAX_SYMBOL_VALUE + 1, rankVal, &nbSymbols, &tableLog, src, srcSize);
2020 if (HUFv06_isError(iSize)) return iSize;
2021
2022 /* check result */
2023 if (tableLog > DTable[0]) return ERROR(tableLog_tooLarge); /* DTable is too small */
2024 DTable[0] = (U16)tableLog; /* maybe should separate sizeof allocated DTable, from used size of DTable, in case of re-use */
2025
2026 /* Prepare ranks */
2027 nextRankStart = 0;
2028 for (n=1; n<tableLog+1; n++) {
2029 U32 current = nextRankStart;
2030 nextRankStart += (rankVal[n] << (n-1));
2031 rankVal[n] = current;
2032 }
2033
2034 /* fill DTable */
2035 for (n=0; n<nbSymbols; n++) {
2036 const U32 w = huffWeight[n];
2037 const U32 length = (1 << w) >> 1;
2038 U32 i;
2039 HUFv06_DEltX2 D;
2040 D.byte = (BYTE)n; D.nbBits = (BYTE)(tableLog + 1 - w);
2041 for (i = rankVal[w]; i < rankVal[w] + length; i++)
2042 dt[i] = D;
2043 rankVal[w] += length;
2044 }
2045
2046 return iSize;
2047}
2048
2049
2050static BYTE HUFv06_decodeSymbolX2(BITv06_DStream_t* Dstream, const HUFv06_DEltX2* dt, const U32 dtLog)
2051{
2052 const size_t val = BITv06_lookBitsFast(Dstream, dtLog); /* note : dtLog >= 1 */
2053 const BYTE c = dt[val].byte;
2054 BITv06_skipBits(Dstream, dt[val].nbBits);
2055 return c;
2056}
2057
2058#define HUFv06_DECODE_SYMBOLX2_0(ptr, DStreamPtr) \
2059 *ptr++ = HUFv06_decodeSymbolX2(DStreamPtr, dt, dtLog)
2060
2061#define HUFv06_DECODE_SYMBOLX2_1(ptr, DStreamPtr) \
2062 if (MEM_64bits() || (HUFv06_MAX_TABLELOG<=12)) \
2063 HUFv06_DECODE_SYMBOLX2_0(ptr, DStreamPtr)
2064
2065#define HUFv06_DECODE_SYMBOLX2_2(ptr, DStreamPtr) \
2066 if (MEM_64bits()) \
2067 HUFv06_DECODE_SYMBOLX2_0(ptr, DStreamPtr)
2068
2069static inline size_t HUFv06_decodeStreamX2(BYTE* p, BITv06_DStream_t* const bitDPtr, BYTE* const pEnd, const HUFv06_DEltX2* const dt, const U32 dtLog)
2070{
2071 BYTE* const pStart = p;
2072
2073 /* up to 4 symbols at a time */
2074 while ((BITv06_reloadDStream(bitDPtr) == BITv06_DStream_unfinished) && (p <= pEnd-4)) {
2075 HUFv06_DECODE_SYMBOLX2_2(p, bitDPtr);
2076 HUFv06_DECODE_SYMBOLX2_1(p, bitDPtr);
2077 HUFv06_DECODE_SYMBOLX2_2(p, bitDPtr);
2078 HUFv06_DECODE_SYMBOLX2_0(p, bitDPtr);
2079 }
2080
2081 /* closer to the end */
2082 while ((BITv06_reloadDStream(bitDPtr) == BITv06_DStream_unfinished) && (p < pEnd))
2083 HUFv06_DECODE_SYMBOLX2_0(p, bitDPtr);
2084
2085 /* no more data to retrieve from bitstream, hence no need to reload */
2086 while (p < pEnd)
2087 HUFv06_DECODE_SYMBOLX2_0(p, bitDPtr);
2088
2089 return pEnd-pStart;
2090}
2091
2092size_t HUFv06_decompress1X2_usingDTable(
2093 void* dst, size_t dstSize,
2094 const void* cSrc, size_t cSrcSize,
2095 const U16* DTable)
2096{
2097 BYTE* op = (BYTE*)dst;
2098 BYTE* const oend = op + dstSize;
2099 const U32 dtLog = DTable[0];
2100 const void* dtPtr = DTable;
2101 const HUFv06_DEltX2* const dt = ((const HUFv06_DEltX2*)dtPtr)+1;
2102 BITv06_DStream_t bitD;
2103
2104 { size_t const errorCode = BITv06_initDStream(&bitD, cSrc, cSrcSize);
2105 if (HUFv06_isError(errorCode)) return errorCode; }
2106
2107 HUFv06_decodeStreamX2(op, &bitD, oend, dt, dtLog);
2108
2109 /* check */
2110 if (!BITv06_endOfDStream(&bitD)) return ERROR(corruption_detected);
2111
2112 return dstSize;
2113}
2114
2115size_t HUFv06_decompress1X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
2116{
2117 HUFv06_CREATE_STATIC_DTABLEX2(DTable, HUFv06_MAX_TABLELOG);
2118 const BYTE* ip = (const BYTE*) cSrc;
2119
2120 size_t const errorCode = HUFv06_readDTableX2 (DTable, cSrc, cSrcSize);
2121 if (HUFv06_isError(errorCode)) return errorCode;
2122 if (errorCode >= cSrcSize) return ERROR(srcSize_wrong);
2123 ip += errorCode;
2124 cSrcSize -= errorCode;
2125
2126 return HUFv06_decompress1X2_usingDTable (dst, dstSize, ip, cSrcSize, DTable);
2127}
2128
2129
2130size_t HUFv06_decompress4X2_usingDTable(
2131 void* dst, size_t dstSize,
2132 const void* cSrc, size_t cSrcSize,
2133 const U16* DTable)
2134{
2135 /* Check */
2136 if (cSrcSize < 10) return ERROR(corruption_detected); /* strict minimum : jump table + 1 byte per stream */
2137
2138 { const BYTE* const istart = (const BYTE*) cSrc;
2139 BYTE* const ostart = (BYTE*) dst;
2140 BYTE* const oend = ostart + dstSize;
2141 const void* const dtPtr = DTable;
2142 const HUFv06_DEltX2* const dt = ((const HUFv06_DEltX2*)dtPtr) +1;
2143 const U32 dtLog = DTable[0];
2144 size_t errorCode;
2145
2146 /* Init */
2147 BITv06_DStream_t bitD1;
2148 BITv06_DStream_t bitD2;
2149 BITv06_DStream_t bitD3;
2150 BITv06_DStream_t bitD4;
2151 const size_t length1 = MEM_readLE16(istart);
2152 const size_t length2 = MEM_readLE16(istart+2);
2153 const size_t length3 = MEM_readLE16(istart+4);
2154 size_t length4;
2155 const BYTE* const istart1 = istart + 6; /* jumpTable */
2156 const BYTE* const istart2 = istart1 + length1;
2157 const BYTE* const istart3 = istart2 + length2;
2158 const BYTE* const istart4 = istart3 + length3;
2159 const size_t segmentSize = (dstSize+3) / 4;
2160 BYTE* const opStart2 = ostart + segmentSize;
2161 BYTE* const opStart3 = opStart2 + segmentSize;
2162 BYTE* const opStart4 = opStart3 + segmentSize;
2163 BYTE* op1 = ostart;
2164 BYTE* op2 = opStart2;
2165 BYTE* op3 = opStart3;
2166 BYTE* op4 = opStart4;
2167 U32 endSignal;
2168
2169 length4 = cSrcSize - (length1 + length2 + length3 + 6);
2170 if (length4 > cSrcSize) return ERROR(corruption_detected); /* overflow */
2171 errorCode = BITv06_initDStream(&bitD1, istart1, length1);
2172 if (HUFv06_isError(errorCode)) return errorCode;
2173 errorCode = BITv06_initDStream(&bitD2, istart2, length2);
2174 if (HUFv06_isError(errorCode)) return errorCode;
2175 errorCode = BITv06_initDStream(&bitD3, istart3, length3);
2176 if (HUFv06_isError(errorCode)) return errorCode;
2177 errorCode = BITv06_initDStream(&bitD4, istart4, length4);
2178 if (HUFv06_isError(errorCode)) return errorCode;
2179
2180 /* 16-32 symbols per loop (4-8 symbols per stream) */
2181 endSignal = BITv06_reloadDStream(&bitD1) | BITv06_reloadDStream(&bitD2) | BITv06_reloadDStream(&bitD3) | BITv06_reloadDStream(&bitD4);
2182 for ( ; (endSignal==BITv06_DStream_unfinished) && (op4<(oend-7)) ; ) {
2183 HUFv06_DECODE_SYMBOLX2_2(op1, &bitD1);
2184 HUFv06_DECODE_SYMBOLX2_2(op2, &bitD2);
2185 HUFv06_DECODE_SYMBOLX2_2(op3, &bitD3);
2186 HUFv06_DECODE_SYMBOLX2_2(op4, &bitD4);
2187 HUFv06_DECODE_SYMBOLX2_1(op1, &bitD1);
2188 HUFv06_DECODE_SYMBOLX2_1(op2, &bitD2);
2189 HUFv06_DECODE_SYMBOLX2_1(op3, &bitD3);
2190 HUFv06_DECODE_SYMBOLX2_1(op4, &bitD4);
2191 HUFv06_DECODE_SYMBOLX2_2(op1, &bitD1);
2192 HUFv06_DECODE_SYMBOLX2_2(op2, &bitD2);
2193 HUFv06_DECODE_SYMBOLX2_2(op3, &bitD3);
2194 HUFv06_DECODE_SYMBOLX2_2(op4, &bitD4);
2195 HUFv06_DECODE_SYMBOLX2_0(op1, &bitD1);
2196 HUFv06_DECODE_SYMBOLX2_0(op2, &bitD2);
2197 HUFv06_DECODE_SYMBOLX2_0(op3, &bitD3);
2198 HUFv06_DECODE_SYMBOLX2_0(op4, &bitD4);
2199 endSignal = BITv06_reloadDStream(&bitD1) | BITv06_reloadDStream(&bitD2) | BITv06_reloadDStream(&bitD3) | BITv06_reloadDStream(&bitD4);
2200 }
2201
2202 /* check corruption */
2203 if (op1 > opStart2) return ERROR(corruption_detected);
2204 if (op2 > opStart3) return ERROR(corruption_detected);
2205 if (op3 > opStart4) return ERROR(corruption_detected);
2206 /* note : op4 supposed already verified within main loop */
2207
2208 /* finish bitStreams one by one */
2209 HUFv06_decodeStreamX2(op1, &bitD1, opStart2, dt, dtLog);
2210 HUFv06_decodeStreamX2(op2, &bitD2, opStart3, dt, dtLog);
2211 HUFv06_decodeStreamX2(op3, &bitD3, opStart4, dt, dtLog);
2212 HUFv06_decodeStreamX2(op4, &bitD4, oend, dt, dtLog);
2213
2214 /* check */
2215 endSignal = BITv06_endOfDStream(&bitD1) & BITv06_endOfDStream(&bitD2) & BITv06_endOfDStream(&bitD3) & BITv06_endOfDStream(&bitD4);
2216 if (!endSignal) return ERROR(corruption_detected);
2217
2218 /* decoded size */
2219 return dstSize;
2220 }
2221}
2222
2223
2224size_t HUFv06_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
2225{
2226 HUFv06_CREATE_STATIC_DTABLEX2(DTable, HUFv06_MAX_TABLELOG);
2227 const BYTE* ip = (const BYTE*) cSrc;
2228
2229 size_t const errorCode = HUFv06_readDTableX2 (DTable, cSrc, cSrcSize);
2230 if (HUFv06_isError(errorCode)) return errorCode;
2231 if (errorCode >= cSrcSize) return ERROR(srcSize_wrong);
2232 ip += errorCode;
2233 cSrcSize -= errorCode;
2234
2235 return HUFv06_decompress4X2_usingDTable (dst, dstSize, ip, cSrcSize, DTable);
2236}
2237
2238
2239/* *************************/
2240/* double-symbols decoding */
2241/* *************************/
2242
2243static void HUFv06_fillDTableX4Level2(HUFv06_DEltX4* DTable, U32 sizeLog, const U32 consumed,
2244 const U32* rankValOrigin, const int minWeight,
2245 const sortedSymbol_t* sortedSymbols, const U32 sortedListSize,
2246 U32 nbBitsBaseline, U16 baseSeq)
2247{
2248 HUFv06_DEltX4 DElt;
2249 U32 rankVal[HUFv06_ABSOLUTEMAX_TABLELOG + 1];
2250
2251 /* get pre-calculated rankVal */
2252 memcpy(rankVal, rankValOrigin, sizeof(rankVal));
2253
2254 /* fill skipped values */
2255 if (minWeight>1) {
2256 U32 i, skipSize = rankVal[minWeight];
2257 MEM_writeLE16(&(DElt.sequence), baseSeq);
2258 DElt.nbBits = (BYTE)(consumed);
2259 DElt.length = 1;
2260 for (i = 0; i < skipSize; i++)
2261 DTable[i] = DElt;
2262 }
2263
2264 /* fill DTable */
2265 { U32 s; for (s=0; s<sortedListSize; s++) { /* note : sortedSymbols already skipped */
2266 const U32 symbol = sortedSymbols[s].symbol;
2267 const U32 weight = sortedSymbols[s].weight;
2268 const U32 nbBits = nbBitsBaseline - weight;
2269 const U32 length = 1 << (sizeLog-nbBits);
2270 const U32 start = rankVal[weight];
2271 U32 i = start;
2272 const U32 end = start + length;
2273
2274 MEM_writeLE16(&(DElt.sequence), (U16)(baseSeq + (symbol << 8)));
2275 DElt.nbBits = (BYTE)(nbBits + consumed);
2276 DElt.length = 2;
2277 do { DTable[i++] = DElt; } while (i<end); /* since length >= 1 */
2278
2279 rankVal[weight] += length;
2280 }}
2281}
2282
2283typedef U32 rankVal_t[HUFv06_ABSOLUTEMAX_TABLELOG][HUFv06_ABSOLUTEMAX_TABLELOG + 1];
2284
2285static void HUFv06_fillDTableX4(HUFv06_DEltX4* DTable, const U32 targetLog,
2286 const sortedSymbol_t* sortedList, const U32 sortedListSize,
2287 const U32* rankStart, rankVal_t rankValOrigin, const U32 maxWeight,
2288 const U32 nbBitsBaseline)
2289{
2290 U32 rankVal[HUFv06_ABSOLUTEMAX_TABLELOG + 1];
2291 const int scaleLog = nbBitsBaseline - targetLog; /* note : targetLog >= srcLog, hence scaleLog <= 1 */
2292 const U32 minBits = nbBitsBaseline - maxWeight;
2293 U32 s;
2294
2295 memcpy(rankVal, rankValOrigin, sizeof(rankVal));
2296
2297 /* fill DTable */
2298 for (s=0; s<sortedListSize; s++) {
2299 const U16 symbol = sortedList[s].symbol;
2300 const U32 weight = sortedList[s].weight;
2301 const U32 nbBits = nbBitsBaseline - weight;
2302 const U32 start = rankVal[weight];
2303 const U32 length = 1 << (targetLog-nbBits);
2304
2305 if (targetLog-nbBits >= minBits) { /* enough room for a second symbol */
2306 U32 sortedRank;
2307 int minWeight = nbBits + scaleLog;
2308 if (minWeight < 1) minWeight = 1;
2309 sortedRank = rankStart[minWeight];
2310 HUFv06_fillDTableX4Level2(DTable+start, targetLog-nbBits, nbBits,
2311 rankValOrigin[nbBits], minWeight,
2312 sortedList+sortedRank, sortedListSize-sortedRank,
2313 nbBitsBaseline, symbol);
2314 } else {
2315 HUFv06_DEltX4 DElt;
2316 MEM_writeLE16(&(DElt.sequence), symbol);
2317 DElt.nbBits = (BYTE)(nbBits);
2318 DElt.length = 1;
2319 { U32 u;
2320 const U32 end = start + length;
2321 for (u = start; u < end; u++) DTable[u] = DElt;
2322 } }
2323 rankVal[weight] += length;
2324 }
2325}
2326
2327size_t HUFv06_readDTableX4 (U32* DTable, const void* src, size_t srcSize)
2328{
2329 BYTE weightList[HUFv06_MAX_SYMBOL_VALUE + 1];
2330 sortedSymbol_t sortedSymbol[HUFv06_MAX_SYMBOL_VALUE + 1];
2331 U32 rankStats[HUFv06_ABSOLUTEMAX_TABLELOG + 1] = { 0 };
2332 U32 rankStart0[HUFv06_ABSOLUTEMAX_TABLELOG + 2] = { 0 };
2333 U32* const rankStart = rankStart0+1;
2334 rankVal_t rankVal;
2335 U32 tableLog, maxW, sizeOfSort, nbSymbols;
2336 const U32 memLog = DTable[0];
2337 size_t iSize;
2338 void* dtPtr = DTable;
2339 HUFv06_DEltX4* const dt = ((HUFv06_DEltX4*)dtPtr) + 1;
2340
2341 HUFv06_STATIC_ASSERT(sizeof(HUFv06_DEltX4) == sizeof(U32)); /* if compilation fails here, assertion is false */
2342 if (memLog > HUFv06_ABSOLUTEMAX_TABLELOG) return ERROR(tableLog_tooLarge);
2343 //memset(weightList, 0, sizeof(weightList)); /* is not necessary, even though some analyzer complain ... */
2344
2345 iSize = HUFv06_readStats(weightList, HUFv06_MAX_SYMBOL_VALUE + 1, rankStats, &nbSymbols, &tableLog, src, srcSize);
2346 if (HUFv06_isError(iSize)) return iSize;
2347
2348 /* check result */
2349 if (tableLog > memLog) return ERROR(tableLog_tooLarge); /* DTable can't fit code depth */
2350
2351 /* find maxWeight */
2352 for (maxW = tableLog; rankStats[maxW]==0; maxW--) {} /* necessarily finds a solution before 0 */
2353
2354 /* Get start index of each weight */
2355 { U32 w, nextRankStart = 0;
2356 for (w=1; w<maxW+1; w++) {
2357 U32 current = nextRankStart;
2358 nextRankStart += rankStats[w];
2359 rankStart[w] = current;
2360 }
2361 rankStart[0] = nextRankStart; /* put all 0w symbols at the end of sorted list*/
2362 sizeOfSort = nextRankStart;
2363 }
2364
2365 /* sort symbols by weight */
2366 { U32 s;
2367 for (s=0; s<nbSymbols; s++) {
2368 U32 const w = weightList[s];
2369 U32 const r = rankStart[w]++;
2370 sortedSymbol[r].symbol = (BYTE)s;
2371 sortedSymbol[r].weight = (BYTE)w;
2372 }
2373 rankStart[0] = 0; /* forget 0w symbols; this is beginning of weight(1) */
2374 }
2375
2376 /* Build rankVal */
2377 { U32* const rankVal0 = rankVal[0];
2378 { int const rescale = (memLog-tableLog) - 1; /* tableLog <= memLog */
2379 U32 nextRankVal = 0;
2380 U32 w;
2381 for (w=1; w<maxW+1; w++) {
2382 U32 current = nextRankVal;
2383 nextRankVal += rankStats[w] << (w+rescale);
2384 rankVal0[w] = current;
2385 } }
2386 { U32 const minBits = tableLog+1 - maxW;
2387 U32 consumed;
2388 for (consumed = minBits; consumed < memLog - minBits + 1; consumed++) {
2389 U32* const rankValPtr = rankVal[consumed];
2390 U32 w;
2391 for (w = 1; w < maxW+1; w++) {
2392 rankValPtr[w] = rankVal0[w] >> consumed;
2393 } } } }
2394
2395 HUFv06_fillDTableX4(dt, memLog,
2396 sortedSymbol, sizeOfSort,
2397 rankStart0, rankVal, maxW,
2398 tableLog+1);
2399
2400 return iSize;
2401}
2402
2403
2404static U32 HUFv06_decodeSymbolX4(void* op, BITv06_DStream_t* DStream, const HUFv06_DEltX4* dt, const U32 dtLog)
2405{
2406 const size_t val = BITv06_lookBitsFast(DStream, dtLog); /* note : dtLog >= 1 */
2407 memcpy(op, dt+val, 2);
2408 BITv06_skipBits(DStream, dt[val].nbBits);
2409 return dt[val].length;
2410}
2411
2412static U32 HUFv06_decodeLastSymbolX4(void* op, BITv06_DStream_t* DStream, const HUFv06_DEltX4* dt, const U32 dtLog)
2413{
2414 const size_t val = BITv06_lookBitsFast(DStream, dtLog); /* note : dtLog >= 1 */
2415 memcpy(op, dt+val, 1);
2416 if (dt[val].length==1) BITv06_skipBits(DStream, dt[val].nbBits);
2417 else {
2418 if (DStream->bitsConsumed < (sizeof(DStream->bitContainer)*8)) {
2419 BITv06_skipBits(DStream, dt[val].nbBits);
2420 if (DStream->bitsConsumed > (sizeof(DStream->bitContainer)*8))
2421 DStream->bitsConsumed = (sizeof(DStream->bitContainer)*8); /* ugly hack; works only because it's the last symbol. Note : can't easily extract nbBits from just this symbol */
2422 } }
2423 return 1;
2424}
2425
2426
2427#define HUFv06_DECODE_SYMBOLX4_0(ptr, DStreamPtr) \
2428 ptr += HUFv06_decodeSymbolX4(ptr, DStreamPtr, dt, dtLog)
2429
2430#define HUFv06_DECODE_SYMBOLX4_1(ptr, DStreamPtr) \
2431 if (MEM_64bits() || (HUFv06_MAX_TABLELOG<=12)) \
2432 ptr += HUFv06_decodeSymbolX4(ptr, DStreamPtr, dt, dtLog)
2433
2434#define HUFv06_DECODE_SYMBOLX4_2(ptr, DStreamPtr) \
2435 if (MEM_64bits()) \
2436 ptr += HUFv06_decodeSymbolX4(ptr, DStreamPtr, dt, dtLog)
2437
2438static inline size_t HUFv06_decodeStreamX4(BYTE* p, BITv06_DStream_t* bitDPtr, BYTE* const pEnd, const HUFv06_DEltX4* const dt, const U32 dtLog)
2439{
2440 BYTE* const pStart = p;
2441
2442 /* up to 8 symbols at a time */
2443 while ((BITv06_reloadDStream(bitDPtr) == BITv06_DStream_unfinished) && (p < pEnd-7)) {
2444 HUFv06_DECODE_SYMBOLX4_2(p, bitDPtr);
2445 HUFv06_DECODE_SYMBOLX4_1(p, bitDPtr);
2446 HUFv06_DECODE_SYMBOLX4_2(p, bitDPtr);
2447 HUFv06_DECODE_SYMBOLX4_0(p, bitDPtr);
2448 }
2449
2450 /* closer to the end */
2451 while ((BITv06_reloadDStream(bitDPtr) == BITv06_DStream_unfinished) && (p <= pEnd-2))
2452 HUFv06_DECODE_SYMBOLX4_0(p, bitDPtr);
2453
2454 while (p <= pEnd-2)
2455 HUFv06_DECODE_SYMBOLX4_0(p, bitDPtr); /* no need to reload : reached the end of DStream */
2456
2457 if (p < pEnd)
2458 p += HUFv06_decodeLastSymbolX4(p, bitDPtr, dt, dtLog);
2459
2460 return p-pStart;
2461}
2462
2463
2464size_t HUFv06_decompress1X4_usingDTable(
2465 void* dst, size_t dstSize,
2466 const void* cSrc, size_t cSrcSize,
2467 const U32* DTable)
2468{
2469 const BYTE* const istart = (const BYTE*) cSrc;
2470 BYTE* const ostart = (BYTE*) dst;
2471 BYTE* const oend = ostart + dstSize;
2472
2473 const U32 dtLog = DTable[0];
2474 const void* const dtPtr = DTable;
2475 const HUFv06_DEltX4* const dt = ((const HUFv06_DEltX4*)dtPtr) +1;
2476
2477 /* Init */
2478 BITv06_DStream_t bitD;
2479 { size_t const errorCode = BITv06_initDStream(&bitD, istart, cSrcSize);
2480 if (HUFv06_isError(errorCode)) return errorCode; }
2481
2482 /* decode */
2483 HUFv06_decodeStreamX4(ostart, &bitD, oend, dt, dtLog);
2484
2485 /* check */
2486 if (!BITv06_endOfDStream(&bitD)) return ERROR(corruption_detected);
2487
2488 /* decoded size */
2489 return dstSize;
2490}
2491
2492size_t HUFv06_decompress1X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
2493{
2494 HUFv06_CREATE_STATIC_DTABLEX4(DTable, HUFv06_MAX_TABLELOG);
2495 const BYTE* ip = (const BYTE*) cSrc;
2496
2497 size_t const hSize = HUFv06_readDTableX4 (DTable, cSrc, cSrcSize);
2498 if (HUFv06_isError(hSize)) return hSize;
2499 if (hSize >= cSrcSize) return ERROR(srcSize_wrong);
2500 ip += hSize;
2501 cSrcSize -= hSize;
2502
2503 return HUFv06_decompress1X4_usingDTable (dst, dstSize, ip, cSrcSize, DTable);
2504}
2505
2506size_t HUFv06_decompress4X4_usingDTable(
2507 void* dst, size_t dstSize,
2508 const void* cSrc, size_t cSrcSize,
2509 const U32* DTable)
2510{
2511 if (cSrcSize < 10) return ERROR(corruption_detected); /* strict minimum : jump table + 1 byte per stream */
2512
2513 { const BYTE* const istart = (const BYTE*) cSrc;
2514 BYTE* const ostart = (BYTE*) dst;
2515 BYTE* const oend = ostart + dstSize;
2516 const void* const dtPtr = DTable;
2517 const HUFv06_DEltX4* const dt = ((const HUFv06_DEltX4*)dtPtr) +1;
2518 const U32 dtLog = DTable[0];
2519 size_t errorCode;
2520
2521 /* Init */
2522 BITv06_DStream_t bitD1;
2523 BITv06_DStream_t bitD2;
2524 BITv06_DStream_t bitD3;
2525 BITv06_DStream_t bitD4;
2526 const size_t length1 = MEM_readLE16(istart);
2527 const size_t length2 = MEM_readLE16(istart+2);
2528 const size_t length3 = MEM_readLE16(istart+4);
2529 size_t length4;
2530 const BYTE* const istart1 = istart + 6; /* jumpTable */
2531 const BYTE* const istart2 = istart1 + length1;
2532 const BYTE* const istart3 = istart2 + length2;
2533 const BYTE* const istart4 = istart3 + length3;
2534 const size_t segmentSize = (dstSize+3) / 4;
2535 BYTE* const opStart2 = ostart + segmentSize;
2536 BYTE* const opStart3 = opStart2 + segmentSize;
2537 BYTE* const opStart4 = opStart3 + segmentSize;
2538 BYTE* op1 = ostart;
2539 BYTE* op2 = opStart2;
2540 BYTE* op3 = opStart3;
2541 BYTE* op4 = opStart4;
2542 U32 endSignal;
2543
2544 length4 = cSrcSize - (length1 + length2 + length3 + 6);
2545 if (length4 > cSrcSize) return ERROR(corruption_detected); /* overflow */
2546 errorCode = BITv06_initDStream(&bitD1, istart1, length1);
2547 if (HUFv06_isError(errorCode)) return errorCode;
2548 errorCode = BITv06_initDStream(&bitD2, istart2, length2);
2549 if (HUFv06_isError(errorCode)) return errorCode;
2550 errorCode = BITv06_initDStream(&bitD3, istart3, length3);
2551 if (HUFv06_isError(errorCode)) return errorCode;
2552 errorCode = BITv06_initDStream(&bitD4, istart4, length4);
2553 if (HUFv06_isError(errorCode)) return errorCode;
2554
2555 /* 16-32 symbols per loop (4-8 symbols per stream) */
2556 endSignal = BITv06_reloadDStream(&bitD1) | BITv06_reloadDStream(&bitD2) | BITv06_reloadDStream(&bitD3) | BITv06_reloadDStream(&bitD4);
2557 for ( ; (endSignal==BITv06_DStream_unfinished) && (op4<(oend-7)) ; ) {
2558 HUFv06_DECODE_SYMBOLX4_2(op1, &bitD1);
2559 HUFv06_DECODE_SYMBOLX4_2(op2, &bitD2);
2560 HUFv06_DECODE_SYMBOLX4_2(op3, &bitD3);
2561 HUFv06_DECODE_SYMBOLX4_2(op4, &bitD4);
2562 HUFv06_DECODE_SYMBOLX4_1(op1, &bitD1);
2563 HUFv06_DECODE_SYMBOLX4_1(op2, &bitD2);
2564 HUFv06_DECODE_SYMBOLX4_1(op3, &bitD3);
2565 HUFv06_DECODE_SYMBOLX4_1(op4, &bitD4);
2566 HUFv06_DECODE_SYMBOLX4_2(op1, &bitD1);
2567 HUFv06_DECODE_SYMBOLX4_2(op2, &bitD2);
2568 HUFv06_DECODE_SYMBOLX4_2(op3, &bitD3);
2569 HUFv06_DECODE_SYMBOLX4_2(op4, &bitD4);
2570 HUFv06_DECODE_SYMBOLX4_0(op1, &bitD1);
2571 HUFv06_DECODE_SYMBOLX4_0(op2, &bitD2);
2572 HUFv06_DECODE_SYMBOLX4_0(op3, &bitD3);
2573 HUFv06_DECODE_SYMBOLX4_0(op4, &bitD4);
2574
2575 endSignal = BITv06_reloadDStream(&bitD1) | BITv06_reloadDStream(&bitD2) | BITv06_reloadDStream(&bitD3) | BITv06_reloadDStream(&bitD4);
2576 }
2577
2578 /* check corruption */
2579 if (op1 > opStart2) return ERROR(corruption_detected);
2580 if (op2 > opStart3) return ERROR(corruption_detected);
2581 if (op3 > opStart4) return ERROR(corruption_detected);
2582 /* note : op4 supposed already verified within main loop */
2583
2584 /* finish bitStreams one by one */
2585 HUFv06_decodeStreamX4(op1, &bitD1, opStart2, dt, dtLog);
2586 HUFv06_decodeStreamX4(op2, &bitD2, opStart3, dt, dtLog);
2587 HUFv06_decodeStreamX4(op3, &bitD3, opStart4, dt, dtLog);
2588 HUFv06_decodeStreamX4(op4, &bitD4, oend, dt, dtLog);
2589
2590 /* check */
2591 endSignal = BITv06_endOfDStream(&bitD1) & BITv06_endOfDStream(&bitD2) & BITv06_endOfDStream(&bitD3) & BITv06_endOfDStream(&bitD4);
2592 if (!endSignal) return ERROR(corruption_detected);
2593
2594 /* decoded size */
2595 return dstSize;
2596 }
2597}
2598
2599
2600size_t HUFv06_decompress4X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
2601{
2602 HUFv06_CREATE_STATIC_DTABLEX4(DTable, HUFv06_MAX_TABLELOG);
2603 const BYTE* ip = (const BYTE*) cSrc;
2604
2605 size_t hSize = HUFv06_readDTableX4 (DTable, cSrc, cSrcSize);
2606 if (HUFv06_isError(hSize)) return hSize;
2607 if (hSize >= cSrcSize) return ERROR(srcSize_wrong);
2608 ip += hSize;
2609 cSrcSize -= hSize;
2610
2611 return HUFv06_decompress4X4_usingDTable (dst, dstSize, ip, cSrcSize, DTable);
2612}
2613
2614
2615
2616
2617/* ********************************/
2618/* Generic decompression selector */
2619/* ********************************/
2620
2621typedef struct { U32 tableTime; U32 decode256Time; } algo_time_t;
2622static const algo_time_t algoTime[16 /* Quantization */][3 /* single, double, quad */] =
2623{
2624 /* single, double, quad */
2625 {{0,0}, {1,1}, {2,2}}, /* Q==0 : impossible */
2626 {{0,0}, {1,1}, {2,2}}, /* Q==1 : impossible */
2627 {{ 38,130}, {1313, 74}, {2151, 38}}, /* Q == 2 : 12-18% */
2628 {{ 448,128}, {1353, 74}, {2238, 41}}, /* Q == 3 : 18-25% */
2629 {{ 556,128}, {1353, 74}, {2238, 47}}, /* Q == 4 : 25-32% */
2630 {{ 714,128}, {1418, 74}, {2436, 53}}, /* Q == 5 : 32-38% */
2631 {{ 883,128}, {1437, 74}, {2464, 61}}, /* Q == 6 : 38-44% */
2632 {{ 897,128}, {1515, 75}, {2622, 68}}, /* Q == 7 : 44-50% */
2633 {{ 926,128}, {1613, 75}, {2730, 75}}, /* Q == 8 : 50-56% */
2634 {{ 947,128}, {1729, 77}, {3359, 77}}, /* Q == 9 : 56-62% */
2635 {{1107,128}, {2083, 81}, {4006, 84}}, /* Q ==10 : 62-69% */
2636 {{1177,128}, {2379, 87}, {4785, 88}}, /* Q ==11 : 69-75% */
2637 {{1242,128}, {2415, 93}, {5155, 84}}, /* Q ==12 : 75-81% */
2638 {{1349,128},