1 /*
2  *  LZ4 - Fast LZ compression algorithm
3  *  Header File
4  *  Copyright (C) 2011-2020, Yann Collet.
5 
6    BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
7 
8    Redistribution and use in source and binary forms, with or without
9    modification, are permitted provided that the following conditions are
10    met:
11 
12        * Redistributions of source code must retain the above copyright
13    notice, this list of conditions and the following disclaimer.
14        * Redistributions in binary form must reproduce the above
15    copyright notice, this list of conditions and the following disclaimer
16    in the documentation and/or other materials provided with the
17    distribution.
18 
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31    You can contact the author at :
32     - LZ4 homepage : http://www.lz4.org
33     - LZ4 source repository : https://github.com/lz4/lz4
34 */
35 
36 #include "../../lv_conf_internal.h"
37 #if LV_USE_LZ4_INTERNAL
38 #if defined (__cplusplus)
39 extern "C" {
40 #endif
41 
42 /**
43  * LVGL's porting
44  */
45 #include "../../lvgl.h"
46 #define LZ4_FREESTANDING    1
47 #define LZ4_memset  lv_memset
48 #define LZ4_memcpy  lv_memcpy
49 #define LZ4_memmove lv_memmove
50 
51 #ifndef LZ4_H_2983827168210
52 #define LZ4_H_2983827168210
53 
54 /* --- Dependency --- */
55 #include <stddef.h>   /* size_t */
56 
57 
58 /**
59   Introduction
60 
61   LZ4 is lossless compression algorithm, providing compression speed >500 MB/s per core,
62   scalable with multi-cores CPU. It features an extremely fast decoder, with speed in
63   multiple GB/s per core, typically reaching RAM speed limits on multi-core systems.
64 
65   The LZ4 compression library provides in-memory compression and decompression functions.
66   It gives full buffer control to user.
67   Compression can be done in:
68     - a single step (described as Simple Functions)
69     - a single step, reusing a context (described in Advanced Functions)
70     - unbounded multiple steps (described as Streaming compression)
71 
72   lz4.h generates and decodes LZ4-compressed blocks (doc/lz4_Block_format.md).
73   Decompressing such a compressed block requires additional metadata.
74   Exact metadata depends on exact decompression function.
75   For the typical case of LZ4_decompress_safe(),
76   metadata includes block's compressed size, and maximum bound of decompressed size.
77   Each application is free to encode and pass such metadata in whichever way it wants.
78 
79   lz4.h only handle blocks, it cannot generate Frames.
80 
81   Blocks are different from Frames (doc/lz4_Frame_format.md).
82   Frames bundle both blocks and metadata in a specified manner.
83   Embedding metadata is required for compressed data to be self-contained and portable.
84   Frame format is delivered through a companion API, declared in lz4frame.h.
85   The `lz4` CLI can only manage frames.
86 */
87 
88 /*^***************************************************************
89 *  Export parameters
90 *****************************************************************/
91 /*
92 *  LZ4_DLL_EXPORT :
93 *  Enable exporting of functions when building a Windows DLL
94 *  LZ4LIB_VISIBILITY :
95 *  Control library symbols visibility.
96 */
97 #ifndef LZ4LIB_VISIBILITY
98 #  if defined(__GNUC__) && (__GNUC__ >= 4)
99 #    define LZ4LIB_VISIBILITY __attribute__ ((visibility ("default")))
100 #  else
101 #    define LZ4LIB_VISIBILITY
102 #  endif
103 #endif
104 #if defined(LZ4_DLL_EXPORT) && (LZ4_DLL_EXPORT==1)
105 #  define LZ4LIB_API __declspec(dllexport) LZ4LIB_VISIBILITY
106 #elif defined(LZ4_DLL_IMPORT) && (LZ4_DLL_IMPORT==1)
107 #  define LZ4LIB_API __declspec(dllimport) LZ4LIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/
108 #else
109 #  define LZ4LIB_API LZ4LIB_VISIBILITY
110 #endif
111 
112 /*! LZ4_FREESTANDING :
113  *  When this macro is set to 1, it enables "freestanding mode" that is
114  *  suitable for typical freestanding environment which doesn't support
115  *  standard C library.
116  *
117  *  - LZ4_FREESTANDING is a compile-time switch.
118  *  - It requires the following macros to be defined:
119  *    LZ4_memcpy, LZ4_memmove, LZ4_memset.
120  *  - It only enables LZ4/HC functions which don't use heap.
121  *    All LZ4F_* functions are not supported.
122  *  - See tests/freestanding.c to check its basic setup.
123  */
124 #if defined(LZ4_FREESTANDING) && (LZ4_FREESTANDING == 1)
125 #  define LZ4_HEAPMODE 0
126 #  define LZ4HC_HEAPMODE 0
127 #  define LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION 1
128 #  if !defined(LZ4_memcpy)
129 #    error "LZ4_FREESTANDING requires macro 'LZ4_memcpy'."
130 #  endif
131 #  if !defined(LZ4_memset)
132 #    error "LZ4_FREESTANDING requires macro 'LZ4_memset'."
133 #  endif
134 #  if !defined(LZ4_memmove)
135 #    error "LZ4_FREESTANDING requires macro 'LZ4_memmove'."
136 #  endif
137 #elif ! defined(LZ4_FREESTANDING)
138 #  define LZ4_FREESTANDING 0
139 #endif
140 
141 
142 /*------   Version   ------*/
143 #define LZ4_VERSION_MAJOR    1    /* for breaking interface changes  */
144 #define LZ4_VERSION_MINOR    9    /* for new (non-breaking) interface capabilities */
145 #define LZ4_VERSION_RELEASE  5    /* for tweaks, bug-fixes, or development */
146 
147 #define LZ4_VERSION_NUMBER (LZ4_VERSION_MAJOR *100*100 + LZ4_VERSION_MINOR *100 + LZ4_VERSION_RELEASE)
148 
149 #define LZ4_LIB_VERSION LZ4_VERSION_MAJOR.LZ4_VERSION_MINOR.LZ4_VERSION_RELEASE
150 #define LZ4_QUOTE(str) #str
151 #define LZ4_EXPAND_AND_QUOTE(str) LZ4_QUOTE(str)
152 #define LZ4_VERSION_STRING LZ4_EXPAND_AND_QUOTE(LZ4_LIB_VERSION)  /* requires v1.7.3+ */
153 
154 LZ4LIB_API int LZ4_versionNumber (void);  /**< library version number; useful to check dll version; requires v1.3.0+ */
155 LZ4LIB_API const char* LZ4_versionString (void);   /**< library version string; useful to check dll version; requires v1.7.5+ */
156 
157 
158 /*-************************************
159 *  Tuning parameter
160 **************************************/
161 #define LZ4_MEMORY_USAGE_MIN 10
162 #define LZ4_MEMORY_USAGE_DEFAULT 14
163 #define LZ4_MEMORY_USAGE_MAX 20
164 
165 /*!
166  * LZ4_MEMORY_USAGE :
167  * Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; )
168  * Increasing memory usage improves compression ratio, at the cost of speed.
169  * Reduced memory usage may improve speed at the cost of ratio, thanks to better cache locality.
170  * Default value is 14, for 16KB, which nicely fits into Intel x86 L1 cache
171  */
172 #ifndef LZ4_MEMORY_USAGE
173 # define LZ4_MEMORY_USAGE LZ4_MEMORY_USAGE_DEFAULT
174 #endif
175 
176 #if (LZ4_MEMORY_USAGE < LZ4_MEMORY_USAGE_MIN)
177 #  error "LZ4_MEMORY_USAGE is too small !"
178 #endif
179 
180 #if (LZ4_MEMORY_USAGE > LZ4_MEMORY_USAGE_MAX)
181 #  error "LZ4_MEMORY_USAGE is too large !"
182 #endif
183 
184 /*-************************************
185 *  Simple Functions
186 **************************************/
187 /*! LZ4_compress_default() :
188  *  Compresses 'srcSize' bytes from buffer 'src'
189  *  into already allocated 'dst' buffer of size 'dstCapacity'.
190  *  Compression is guaranteed to succeed if 'dstCapacity' >= LZ4_compressBound(srcSize).
191  *  It also runs faster, so it's a recommended setting.
192  *  If the function cannot compress 'src' into a more limited 'dst' budget,
193  *  compression stops *immediately*, and the function result is zero.
194  *  In which case, 'dst' content is undefined (invalid).
195  *      srcSize : max supported value is LZ4_MAX_INPUT_SIZE.
196  *      dstCapacity : size of buffer 'dst' (which must be already allocated)
197  *     @return  : the number of bytes written into buffer 'dst' (necessarily <= dstCapacity)
198  *                or 0 if compression fails
199  * Note : This function is protected against buffer overflow scenarios (never writes outside 'dst' buffer, nor read outside 'source' buffer).
200  */
201 LZ4LIB_API int LZ4_compress_default(const char* src, char* dst, int srcSize, int dstCapacity);
202 
203 /*! LZ4_decompress_safe() :
204  * @compressedSize : is the exact complete size of the compressed block.
205  * @dstCapacity : is the size of destination buffer (which must be already allocated),
206  *                is an upper bound of decompressed size.
207  * @return : the number of bytes decompressed into destination buffer (necessarily <= dstCapacity)
208  *           If destination buffer is not large enough, decoding will stop and output an error code (negative value).
209  *           If the source stream is detected malformed, the function will stop decoding and return a negative result.
210  * Note 1 : This function is protected against malicious data packets :
211  *          it will never writes outside 'dst' buffer, nor read outside 'source' buffer,
212  *          even if the compressed block is maliciously modified to order the decoder to do these actions.
213  *          In such case, the decoder stops immediately, and considers the compressed block malformed.
214  * Note 2 : compressedSize and dstCapacity must be provided to the function, the compressed block does not contain them.
215  *          The implementation is free to send / store / derive this information in whichever way is most beneficial.
216  *          If there is a need for a different format which bundles together both compressed data and its metadata, consider looking at lz4frame.h instead.
217  */
218 LZ4LIB_API int LZ4_decompress_safe (const char* src, char* dst, int compressedSize, int dstCapacity);
219 
220 
221 /*-************************************
222 *  Advanced Functions
223 **************************************/
224 #define LZ4_MAX_INPUT_SIZE        0x7E000000   /* 2 113 929 216 bytes */
225 #define LZ4_COMPRESSBOUND(isize)  ((unsigned)(isize) > (unsigned)LZ4_MAX_INPUT_SIZE ? 0 : (isize) + ((isize)/255) + 16)
226 
227 /*! LZ4_compressBound() :
228     Provides the maximum size that LZ4 compression may output in a "worst case" scenario (input data not compressible)
229     This function is primarily useful for memory allocation purposes (destination buffer size).
230     Macro LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation (stack memory allocation for example).
231     Note that LZ4_compress_default() compresses faster when dstCapacity is >= LZ4_compressBound(srcSize)
232         inputSize  : max supported value is LZ4_MAX_INPUT_SIZE
233         return : maximum output size in a "worst case" scenario
234               or 0, if input size is incorrect (too large or negative)
235 */
236 LZ4LIB_API int LZ4_compressBound(int inputSize);
237 
238 /*! LZ4_compress_fast() :
239     Same as LZ4_compress_default(), but allows selection of "acceleration" factor.
240     The larger the acceleration value, the faster the algorithm, but also the lesser the compression.
241     It's a trade-off. It can be fine tuned, with each successive value providing roughly +~3% to speed.
242     An acceleration value of "1" is the same as regular LZ4_compress_default()
243     Values <= 0 will be replaced by LZ4_ACCELERATION_DEFAULT (currently == 1, see lz4.c).
244     Values > LZ4_ACCELERATION_MAX will be replaced by LZ4_ACCELERATION_MAX (currently == 65537, see lz4.c).
245 */
246 LZ4LIB_API int LZ4_compress_fast (const char* src, char* dst, int srcSize, int dstCapacity, int acceleration);
247 
248 
249 /*! LZ4_compress_fast_extState() :
250  *  Same as LZ4_compress_fast(), using an externally allocated memory space for its state.
251  *  Use LZ4_sizeofState() to know how much memory must be allocated,
252  *  and allocate it on 8-bytes boundaries (using `malloc()` typically).
253  *  Then, provide this buffer as `void* state` to compression function.
254  */
255 LZ4LIB_API int LZ4_sizeofState(void);
256 LZ4LIB_API int LZ4_compress_fast_extState (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration);
257 
258 
259 /*! LZ4_compress_destSize() :
260  *  Reverse the logic : compresses as much data as possible from 'src' buffer
261  *  into already allocated buffer 'dst', of size >= 'targetDestSize'.
262  *  This function either compresses the entire 'src' content into 'dst' if it's large enough,
263  *  or fill 'dst' buffer completely with as much data as possible from 'src'.
264  *  note: acceleration parameter is fixed to "default".
265  *
266  * *srcSizePtr : will be modified to indicate how many bytes where read from 'src' to fill 'dst'.
267  *               New value is necessarily <= input value.
268  * @return : Nb bytes written into 'dst' (necessarily <= targetDestSize)
269  *           or 0 if compression fails.
270  *
271  * Note : from v1.8.2 to v1.9.1, this function had a bug (fixed in v1.9.2+):
272  *        the produced compressed content could, in specific circumstances,
273  *        require to be decompressed into a destination buffer larger
274  *        by at least 1 byte than the content to decompress.
275  *        If an application uses `LZ4_compress_destSize()`,
276  *        it's highly recommended to update liblz4 to v1.9.2 or better.
277  *        If this can't be done or ensured,
278  *        the receiving decompression function should provide
279  *        a dstCapacity which is > decompressedSize, by at least 1 byte.
280  *        See https://github.com/lz4/lz4/issues/859 for details
281  */
282 LZ4LIB_API int LZ4_compress_destSize (const char* src, char* dst, int* srcSizePtr, int targetDstSize);
283 
284 
285 /*! LZ4_decompress_safe_partial() :
286  *  Decompress an LZ4 compressed block, of size 'srcSize' at position 'src',
287  *  into destination buffer 'dst' of size 'dstCapacity'.
288  *  Up to 'targetOutputSize' bytes will be decoded.
289  *  The function stops decoding on reaching this objective.
290  *  This can be useful to boost performance
291  *  whenever only the beginning of a block is required.
292  *
293  * @return : the number of bytes decoded in `dst` (necessarily <= targetOutputSize)
294  *           If source stream is detected malformed, function returns a negative result.
295  *
296  *  Note 1 : @return can be < targetOutputSize, if compressed block contains less data.
297  *
298  *  Note 2 : targetOutputSize must be <= dstCapacity
299  *
300  *  Note 3 : this function effectively stops decoding on reaching targetOutputSize,
301  *           so dstCapacity is kind of redundant.
302  *           This is because in older versions of this function,
303  *           decoding operation would still write complete sequences.
304  *           Therefore, there was no guarantee that it would stop writing at exactly targetOutputSize,
305  *           it could write more bytes, though only up to dstCapacity.
306  *           Some "margin" used to be required for this operation to work properly.
307  *           Thankfully, this is no longer necessary.
308  *           The function nonetheless keeps the same signature, in an effort to preserve API compatibility.
309  *
310  *  Note 4 : If srcSize is the exact size of the block,
311  *           then targetOutputSize can be any value,
312  *           including larger than the block's decompressed size.
313  *           The function will, at most, generate block's decompressed size.
314  *
315  *  Note 5 : If srcSize is _larger_ than block's compressed size,
316  *           then targetOutputSize **MUST** be <= block's decompressed size.
317  *           Otherwise, *silent corruption will occur*.
318  */
319 LZ4LIB_API int LZ4_decompress_safe_partial (const char* src, char* dst, int srcSize, int targetOutputSize, int dstCapacity);
320 
321 
322 /*-*********************************************
323 *  Streaming Compression Functions
324 ***********************************************/
325 typedef union LZ4_stream_u LZ4_stream_t;  /* incomplete type (defined later) */
326 
327 /**
328  Note about RC_INVOKED
329 
330  - RC_INVOKED is predefined symbol of rc.exe (the resource compiler which is part of MSVC/Visual Studio).
331    https://docs.microsoft.com/en-us/windows/win32/menurc/predefined-macros
332 
333  - Since rc.exe is a legacy compiler, it truncates long symbol (> 30 chars)
334    and reports warning "RC4011: identifier truncated".
335 
336  - To eliminate the warning, we surround long preprocessor symbol with
337    "#if !defined(RC_INVOKED) ... #endif" block that means
338    "skip this block when rc.exe is trying to read it".
339 */
340 #if !defined(RC_INVOKED) /* https://docs.microsoft.com/en-us/windows/win32/menurc/predefined-macros */
341 #if !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
342 LZ4LIB_API LZ4_stream_t* LZ4_createStream(void);
343 LZ4LIB_API int           LZ4_freeStream (LZ4_stream_t* streamPtr);
344 #endif /* !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION) */
345 #endif
346 
347 /*! LZ4_resetStream_fast() : v1.9.0+
348  *  Use this to prepare an LZ4_stream_t for a new chain of dependent blocks
349  *  (e.g., LZ4_compress_fast_continue()).
350  *
351  *  An LZ4_stream_t must be initialized once before usage.
352  *  This is automatically done when created by LZ4_createStream().
353  *  However, should the LZ4_stream_t be simply declared on stack (for example),
354  *  it's necessary to initialize it first, using LZ4_initStream().
355  *
356  *  After init, start any new stream with LZ4_resetStream_fast().
357  *  A same LZ4_stream_t can be re-used multiple times consecutively
358  *  and compress multiple streams,
359  *  provided that it starts each new stream with LZ4_resetStream_fast().
360  *
361  *  LZ4_resetStream_fast() is much faster than LZ4_initStream(),
362  *  but is not compatible with memory regions containing garbage data.
363  *
364  *  Note: it's only useful to call LZ4_resetStream_fast()
365  *        in the context of streaming compression.
366  *        The *extState* functions perform their own resets.
367  *        Invoking LZ4_resetStream_fast() before is redundant, and even counterproductive.
368  */
369 LZ4LIB_API void LZ4_resetStream_fast (LZ4_stream_t* streamPtr);
370 
371 /*! LZ4_loadDict() :
372  *  Use this function to reference a static dictionary into LZ4_stream_t.
373  *  The dictionary must remain available during compression.
374  *  LZ4_loadDict() triggers a reset, so any previous data will be forgotten.
375  *  The same dictionary will have to be loaded on decompression side for successful decoding.
376  *  Dictionary are useful for better compression of small data (KB range).
377  *  While LZ4 accept any input as dictionary,
378  *  results are generally better when using Zstandard's Dictionary Builder.
379  *  Loading a size of 0 is allowed, and is the same as reset.
380  * @return : loaded dictionary size, in bytes (necessarily <= 64 KB)
381  */
382 LZ4LIB_API int LZ4_loadDict (LZ4_stream_t* streamPtr, const char* dictionary, int dictSize);
383 
384 /*! LZ4_compress_fast_continue() :
385  *  Compress 'src' content using data from previously compressed blocks, for better compression ratio.
386  * 'dst' buffer must be already allocated.
387  *  If dstCapacity >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster.
388  *
389  * @return : size of compressed block
390  *           or 0 if there is an error (typically, cannot fit into 'dst').
391  *
392  *  Note 1 : Each invocation to LZ4_compress_fast_continue() generates a new block.
393  *           Each block has precise boundaries.
394  *           Each block must be decompressed separately, calling LZ4_decompress_*() with relevant metadata.
395  *           It's not possible to append blocks together and expect a single invocation of LZ4_decompress_*() to decompress them together.
396  *
397  *  Note 2 : The previous 64KB of source data is __assumed__ to remain present, unmodified, at same address in memory !
398  *
399  *  Note 3 : When input is structured as a double-buffer, each buffer can have any size, including < 64 KB.
400  *           Make sure that buffers are separated, by at least one byte.
401  *           This construction ensures that each block only depends on previous block.
402  *
403  *  Note 4 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.
404  *
405  *  Note 5 : After an error, the stream status is undefined (invalid), it can only be reset or freed.
406  */
407 LZ4LIB_API int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration);
408 
409 /*! LZ4_saveDict() :
410  *  If last 64KB data cannot be guaranteed to remain available at its current memory location,
411  *  save it into a safer place (char* safeBuffer).
412  *  This is schematically equivalent to a memcpy() followed by LZ4_loadDict(),
413  *  but is much faster, because LZ4_saveDict() doesn't need to rebuild tables.
414  * @return : saved dictionary size in bytes (necessarily <= maxDictSize), or 0 if error.
415  */
416 LZ4LIB_API int LZ4_saveDict (LZ4_stream_t* streamPtr, char* safeBuffer, int maxDictSize);
417 
418 
419 /*-**********************************************
420 *  Streaming Decompression Functions
421 *  Bufferless synchronous API
422 ************************************************/
423 typedef union LZ4_streamDecode_u LZ4_streamDecode_t;   /* tracking context */
424 
425 /*! LZ4_createStreamDecode() and LZ4_freeStreamDecode() :
426  *  creation / destruction of streaming decompression tracking context.
427  *  A tracking context can be re-used multiple times.
428  */
429 #if !defined(RC_INVOKED) /* https://docs.microsoft.com/en-us/windows/win32/menurc/predefined-macros */
430 #if !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
431 LZ4LIB_API LZ4_streamDecode_t* LZ4_createStreamDecode(void);
432 LZ4LIB_API int                 LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream);
433 #endif /* !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION) */
434 #endif
435 
436 /*! LZ4_setStreamDecode() :
437  *  An LZ4_streamDecode_t context can be allocated once and re-used multiple times.
438  *  Use this function to start decompression of a new stream of blocks.
439  *  A dictionary can optionally be set. Use NULL or size 0 for a reset order.
440  *  Dictionary is presumed stable : it must remain accessible and unmodified during next decompression.
441  * @return : 1 if OK, 0 if error
442  */
443 LZ4LIB_API int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const char* dictionary, int dictSize);
444 
445 /*! LZ4_decoderRingBufferSize() : v1.8.2+
446  *  Note : in a ring buffer scenario (optional),
447  *  blocks are presumed decompressed next to each other
448  *  up to the moment there is not enough remaining space for next block (remainingSize < maxBlockSize),
449  *  at which stage it resumes from beginning of ring buffer.
450  *  When setting such a ring buffer for streaming decompression,
451  *  provides the minimum size of this ring buffer
452  *  to be compatible with any source respecting maxBlockSize condition.
453  * @return : minimum ring buffer size,
454  *           or 0 if there is an error (invalid maxBlockSize).
455  */
456 LZ4LIB_API int LZ4_decoderRingBufferSize(int maxBlockSize);
457 #define LZ4_DECODER_RING_BUFFER_SIZE(maxBlockSize) (65536 + 14 + (maxBlockSize))  /* for static allocation; maxBlockSize presumed valid */
458 
459 /*! LZ4_decompress_safe_continue() :
460  *  This decoding function allows decompression of consecutive blocks in "streaming" mode.
461  *  The difference with the usual independent blocks is that
462  *  new blocks are allowed to find references into former blocks.
463  *  A block is an unsplittable entity, and must be presented entirely to the decompression function.
464  *  LZ4_decompress_safe_continue() only accepts one block at a time.
465  *  It's modeled after `LZ4_decompress_safe()` and behaves similarly.
466  *
467  * @LZ4_streamDecode : decompression state, tracking the position in memory of past data
468  * @compressedSize : exact complete size of one compressed block.
469  * @dstCapacity : size of destination buffer (which must be already allocated),
470  *                must be an upper bound of decompressed size.
471  * @return : number of bytes decompressed into destination buffer (necessarily <= dstCapacity)
472  *           If destination buffer is not large enough, decoding will stop and output an error code (negative value).
473  *           If the source stream is detected malformed, the function will stop decoding and return a negative result.
474  *
475  *  The last 64KB of previously decoded data *must* remain available and unmodified
476  *  at the memory position where they were previously decoded.
477  *  If less than 64KB of data has been decoded, all the data must be present.
478  *
479  *  Special : if decompression side sets a ring buffer, it must respect one of the following conditions :
480  *  - Decompression buffer size is _at least_ LZ4_decoderRingBufferSize(maxBlockSize).
481  *    maxBlockSize is the maximum size of any single block. It can have any value > 16 bytes.
482  *    In which case, encoding and decoding buffers do not need to be synchronized.
483  *    Actually, data can be produced by any source compliant with LZ4 format specification, and respecting maxBlockSize.
484  *  - Synchronized mode :
485  *    Decompression buffer size is _exactly_ the same as compression buffer size,
486  *    and follows exactly same update rule (block boundaries at same positions),
487  *    and decoding function is provided with exact decompressed size of each block (exception for last block of the stream),
488  *    _then_ decoding & encoding ring buffer can have any size, including small ones ( < 64 KB).
489  *  - Decompression buffer is larger than encoding buffer, by a minimum of maxBlockSize more bytes.
490  *    In which case, encoding and decoding buffers do not need to be synchronized,
491  *    and encoding ring buffer can have any size, including small ones ( < 64 KB).
492  *
493  *  Whenever these conditions are not possible,
494  *  save the last 64KB of decoded data into a safe buffer where it can't be modified during decompression,
495  *  then indicate where this data is saved using LZ4_setStreamDecode(), before decompressing next block.
496 */
497 LZ4LIB_API int
498 LZ4_decompress_safe_continue (LZ4_streamDecode_t* LZ4_streamDecode,
499                         const char* src, char* dst,
500                         int srcSize, int dstCapacity);
501 
502 
503 /*! LZ4_decompress_safe_usingDict() :
504  *  Works the same as
505  *  a combination of LZ4_setStreamDecode() followed by LZ4_decompress_safe_continue()
506  *  However, it's stateless: it doesn't need any LZ4_streamDecode_t state.
507  *  Dictionary is presumed stable : it must remain accessible and unmodified during decompression.
508  *  Performance tip : Decompression speed can be substantially increased
509  *                    when dst == dictStart + dictSize.
510  */
511 LZ4LIB_API int
512 LZ4_decompress_safe_usingDict(const char* src, char* dst,
513                               int srcSize, int dstCapacity,
514                               const char* dictStart, int dictSize);
515 
516 /*! LZ4_decompress_safe_partial_usingDict() :
517  *  Behaves the same as LZ4_decompress_safe_partial()
518  *  with the added ability to specify a memory segment for past data.
519  *  Performance tip : Decompression speed can be substantially increased
520  *                    when dst == dictStart + dictSize.
521  */
522 LZ4LIB_API int
523 LZ4_decompress_safe_partial_usingDict(const char* src, char* dst,
524                                       int compressedSize,
525                                       int targetOutputSize, int maxOutputSize,
526                                       const char* dictStart, int dictSize);
527 
528 #endif /* LZ4_H_2983827168210 */
529 
530 
531 /*^*************************************
532  * !!!!!!   STATIC LINKING ONLY   !!!!!!
533  ***************************************/
534 
535 /*-****************************************************************************
536  * Experimental section
537  *
538  * Symbols declared in this section must be considered unstable. Their
539  * signatures or semantics may change, or they may be removed altogether in the
540  * future. They are therefore only safe to depend on when the caller is
541  * statically linked against the library.
542  *
543  * To protect against unsafe usage, not only are the declarations guarded,
544  * the definitions are hidden by default
545  * when building LZ4 as a shared/dynamic library.
546  *
547  * In order to access these declarations,
548  * define LZ4_STATIC_LINKING_ONLY in your application
549  * before including LZ4's headers.
550  *
551  * In order to make their implementations accessible dynamically, you must
552  * define LZ4_PUBLISH_STATIC_FUNCTIONS when building the LZ4 library.
553  ******************************************************************************/
554 
555 #ifdef LZ4_STATIC_LINKING_ONLY
556 
557 #ifndef LZ4_STATIC_3504398509
558 #define LZ4_STATIC_3504398509
559 
560 #ifdef LZ4_PUBLISH_STATIC_FUNCTIONS
561 #define LZ4LIB_STATIC_API LZ4LIB_API
562 #else
563 #define LZ4LIB_STATIC_API
564 #endif
565 
566 
567 /*! LZ4_compress_fast_extState_fastReset() :
568  *  A variant of LZ4_compress_fast_extState().
569  *
570  *  Using this variant avoids an expensive initialization step.
571  *  It is only safe to call if the state buffer is known to be correctly initialized already
572  *  (see above comment on LZ4_resetStream_fast() for a definition of "correctly initialized").
573  *  From a high level, the difference is that
574  *  this function initializes the provided state with a call to something like LZ4_resetStream_fast()
575  *  while LZ4_compress_fast_extState() starts with a call to LZ4_resetStream().
576  */
577 LZ4LIB_STATIC_API int LZ4_compress_fast_extState_fastReset (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration);
578 
579 /*! LZ4_attach_dictionary() :
580  *  This is an experimental API that allows
581  *  efficient use of a static dictionary many times.
582  *
583  *  Rather than re-loading the dictionary buffer into a working context before
584  *  each compression, or copying a pre-loaded dictionary's LZ4_stream_t into a
585  *  working LZ4_stream_t, this function introduces a no-copy setup mechanism,
586  *  in which the working stream references the dictionary stream in-place.
587  *
588  *  Several assumptions are made about the state of the dictionary stream.
589  *  Currently, only streams which have been prepared by LZ4_loadDict() should
590  *  be expected to work.
591  *
592  *  Alternatively, the provided dictionaryStream may be NULL,
593  *  in which case any existing dictionary stream is unset.
594  *
595  *  If a dictionary is provided, it replaces any preexisting stream history.
596  *  The dictionary contents are the only history that can be referenced and
597  *  logically immediately precede the data compressed in the first subsequent
598  *  compression call.
599  *
600  *  The dictionary will only remain attached to the working stream through the
601  *  first compression call, at the end of which it is cleared. The dictionary
602  *  stream (and source buffer) must remain in-place / accessible / unchanged
603  *  through the completion of the first compression call on the stream.
604  */
605 LZ4LIB_STATIC_API void
606 LZ4_attach_dictionary(LZ4_stream_t* workingStream,
607                 const LZ4_stream_t* dictionaryStream);
608 
609 
610 /*! In-place compression and decompression
611  *
612  * It's possible to have input and output sharing the same buffer,
613  * for highly constrained memory environments.
614  * In both cases, it requires input to lay at the end of the buffer,
615  * and decompression to start at beginning of the buffer.
616  * Buffer size must feature some margin, hence be larger than final size.
617  *
618  * |<------------------------buffer--------------------------------->|
619  *                             |<-----------compressed data--------->|
620  * |<-----------decompressed size------------------>|
621  *                                                  |<----margin---->|
622  *
623  * This technique is more useful for decompression,
624  * since decompressed size is typically larger,
625  * and margin is short.
626  *
627  * In-place decompression will work inside any buffer
628  * which size is >= LZ4_DECOMPRESS_INPLACE_BUFFER_SIZE(decompressedSize).
629  * This presumes that decompressedSize > compressedSize.
630  * Otherwise, it means compression actually expanded data,
631  * and it would be more efficient to store such data with a flag indicating it's not compressed.
632  * This can happen when data is not compressible (already compressed, or encrypted).
633  *
634  * For in-place compression, margin is larger, as it must be able to cope with both
635  * history preservation, requiring input data to remain unmodified up to LZ4_DISTANCE_MAX,
636  * and data expansion, which can happen when input is not compressible.
637  * As a consequence, buffer size requirements are much higher,
638  * and memory savings offered by in-place compression are more limited.
639  *
640  * There are ways to limit this cost for compression :
641  * - Reduce history size, by modifying LZ4_DISTANCE_MAX.
642  *   Note that it is a compile-time constant, so all compressions will apply this limit.
643  *   Lower values will reduce compression ratio, except when input_size < LZ4_DISTANCE_MAX,
644  *   so it's a reasonable trick when inputs are known to be small.
645  * - Require the compressor to deliver a "maximum compressed size".
646  *   This is the `dstCapacity` parameter in `LZ4_compress*()`.
647  *   When this size is < LZ4_COMPRESSBOUND(inputSize), then compression can fail,
648  *   in which case, the return code will be 0 (zero).
649  *   The caller must be ready for these cases to happen,
650  *   and typically design a backup scheme to send data uncompressed.
651  * The combination of both techniques can significantly reduce
652  * the amount of margin required for in-place compression.
653  *
654  * In-place compression can work in any buffer
655  * which size is >= (maxCompressedSize)
656  * with maxCompressedSize == LZ4_COMPRESSBOUND(srcSize) for guaranteed compression success.
657  * LZ4_COMPRESS_INPLACE_BUFFER_SIZE() depends on both maxCompressedSize and LZ4_DISTANCE_MAX,
658  * so it's possible to reduce memory requirements by playing with them.
659  */
660 
661 #define LZ4_DECOMPRESS_INPLACE_MARGIN(compressedSize)          (((compressedSize) >> 8) + 32)
662 #define LZ4_DECOMPRESS_INPLACE_BUFFER_SIZE(decompressedSize)   ((decompressedSize) + LZ4_DECOMPRESS_INPLACE_MARGIN(decompressedSize))  /**< note: presumes that compressedSize < decompressedSize. note2: margin is overestimated a bit, since it could use compressedSize instead */
663 
664 #ifndef LZ4_DISTANCE_MAX   /* history window size; can be user-defined at compile time */
665 #  define LZ4_DISTANCE_MAX 65535   /* set to maximum value by default */
666 #endif
667 
668 #define LZ4_COMPRESS_INPLACE_MARGIN                           (LZ4_DISTANCE_MAX + 32)   /* LZ4_DISTANCE_MAX can be safely replaced by srcSize when it's smaller */
669 #define LZ4_COMPRESS_INPLACE_BUFFER_SIZE(maxCompressedSize)   ((maxCompressedSize) + LZ4_COMPRESS_INPLACE_MARGIN)  /**< maxCompressedSize is generally LZ4_COMPRESSBOUND(inputSize), but can be set to any lower value, with the risk that compression can fail (return code 0(zero)) */
670 
671 #endif   /* LZ4_STATIC_3504398509 */
672 #endif   /* LZ4_STATIC_LINKING_ONLY */
673 
674 
675 
676 #ifndef LZ4_H_98237428734687
677 #define LZ4_H_98237428734687
678 
679 /*-************************************************************
680  *  Private Definitions
681  **************************************************************
682  * Do not use these definitions directly.
683  * They are only exposed to allow static allocation of `LZ4_stream_t` and `LZ4_streamDecode_t`.
684  * Accessing members will expose user code to API and/or ABI break in future versions of the library.
685  **************************************************************/
686 #define LZ4_HASHLOG   (LZ4_MEMORY_USAGE-2)
687 #define LZ4_HASHTABLESIZE (1 << LZ4_MEMORY_USAGE)
688 #define LZ4_HASH_SIZE_U32 (1 << LZ4_HASHLOG)       /* required as macro for static allocation */
689 
690 #if defined(__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
691 # include <stdint.h>
692   typedef  int8_t  LZ4_i8;
693   typedef uint8_t  LZ4_byte;
694   typedef uint16_t LZ4_u16;
695   typedef uint32_t LZ4_u32;
696 #else
697   typedef   signed char  LZ4_i8;
698   typedef unsigned char  LZ4_byte;
699   typedef unsigned short LZ4_u16;
700   typedef unsigned int   LZ4_u32;
701 #endif
702 
703 /*! LZ4_stream_t :
704  *  Never ever use below internal definitions directly !
705  *  These definitions are not API/ABI safe, and may change in future versions.
706  *  If you need static allocation, declare or allocate an LZ4_stream_t object.
707 **/
708 
709 typedef struct LZ4_stream_t_internal LZ4_stream_t_internal;
710 struct LZ4_stream_t_internal {
711     LZ4_u32 hashTable[LZ4_HASH_SIZE_U32];
712     const LZ4_byte* dictionary;
713     const LZ4_stream_t_internal* dictCtx;
714     LZ4_u32 currentOffset;
715     LZ4_u32 tableType;
716     LZ4_u32 dictSize;
717     /* Implicit padding to ensure structure is aligned */
718 };
719 
720 #define LZ4_STREAM_MINSIZE  ((1UL << LZ4_MEMORY_USAGE) + 32)  /* static size, for inter-version compatibility */
721 union LZ4_stream_u {
722     char minStateSize[LZ4_STREAM_MINSIZE];
723     LZ4_stream_t_internal internal_donotuse;
724 }; /* previously typedef'd to LZ4_stream_t */
725 
726 
727 /*! LZ4_initStream() : v1.9.0+
728  *  An LZ4_stream_t structure must be initialized at least once.
729  *  This is automatically done when invoking LZ4_createStream(),
730  *  but it's not when the structure is simply declared on stack (for example).
731  *
732  *  Use LZ4_initStream() to properly initialize a newly declared LZ4_stream_t.
733  *  It can also initialize any arbitrary buffer of sufficient size,
734  *  and will @return a pointer of proper type upon initialization.
735  *
736  *  Note : initialization fails if size and alignment conditions are not respected.
737  *         In which case, the function will @return NULL.
738  *  Note2: An LZ4_stream_t structure guarantees correct alignment and size.
739  *  Note3: Before v1.9.0, use LZ4_resetStream() instead
740 **/
741 LZ4LIB_API LZ4_stream_t* LZ4_initStream (void* buffer, size_t size);
742 
743 
744 /*! LZ4_streamDecode_t :
745  *  Never ever use below internal definitions directly !
746  *  These definitions are not API/ABI safe, and may change in future versions.
747  *  If you need static allocation, declare or allocate an LZ4_streamDecode_t object.
748 **/
749 typedef struct {
750     const LZ4_byte* externalDict;
751     const LZ4_byte* prefixEnd;
752     size_t extDictSize;
753     size_t prefixSize;
754 } LZ4_streamDecode_t_internal;
755 
756 #define LZ4_STREAMDECODE_MINSIZE 32
757 union LZ4_streamDecode_u {
758     char minStateSize[LZ4_STREAMDECODE_MINSIZE];
759     LZ4_streamDecode_t_internal internal_donotuse;
760 } ;   /* previously typedef'd to LZ4_streamDecode_t */
761 
762 
763 
764 /*-************************************
765 *  Obsolete Functions
766 **************************************/
767 
768 /*! Deprecation warnings
769  *
770  *  Deprecated functions make the compiler generate a warning when invoked.
771  *  This is meant to invite users to update their source code.
772  *  Should deprecation warnings be a problem, it is generally possible to disable them,
773  *  typically with -Wno-deprecated-declarations for gcc
774  *  or _CRT_SECURE_NO_WARNINGS in Visual.
775  *
776  *  Another method is to define LZ4_DISABLE_DEPRECATE_WARNINGS
777  *  before including the header file.
778  */
779 #ifdef LZ4_DISABLE_DEPRECATE_WARNINGS
780 #  define LZ4_DEPRECATED(message)   /* disable deprecation warnings */
781 #else
782 #  if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */
783 #    define LZ4_DEPRECATED(message) [[deprecated(message)]]
784 #  elif defined(_MSC_VER)
785 #    define LZ4_DEPRECATED(message) __declspec(deprecated(message))
786 #  elif defined(__clang__) || (defined(__GNUC__) && (__GNUC__ * 10 + __GNUC_MINOR__ >= 45))
787 #    define LZ4_DEPRECATED(message) __attribute__((deprecated(message)))
788 #  elif defined(__GNUC__) && (__GNUC__ * 10 + __GNUC_MINOR__ >= 31)
789 #    define LZ4_DEPRECATED(message) __attribute__((deprecated))
790 #  else
791 #    pragma message("WARNING: LZ4_DEPRECATED needs custom implementation for this compiler")
792 #    define LZ4_DEPRECATED(message)   /* disabled */
793 #  endif
794 #endif /* LZ4_DISABLE_DEPRECATE_WARNINGS */
795 
796 /*! Obsolete compression functions (since v1.7.3) */
797 LZ4_DEPRECATED("use LZ4_compress_default() instead")       LZ4LIB_API int LZ4_compress               (const char* src, char* dest, int srcSize);
798 LZ4_DEPRECATED("use LZ4_compress_default() instead")       LZ4LIB_API int LZ4_compress_limitedOutput (const char* src, char* dest, int srcSize, int maxOutputSize);
799 LZ4_DEPRECATED("use LZ4_compress_fast_extState() instead") LZ4LIB_API int LZ4_compress_withState               (void* state, const char* source, char* dest, int inputSize);
800 LZ4_DEPRECATED("use LZ4_compress_fast_extState() instead") LZ4LIB_API int LZ4_compress_limitedOutput_withState (void* state, const char* source, char* dest, int inputSize, int maxOutputSize);
801 LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead") LZ4LIB_API int LZ4_compress_continue                (LZ4_stream_t* LZ4_streamPtr, const char* source, char* dest, int inputSize);
802 LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead") LZ4LIB_API int LZ4_compress_limitedOutput_continue  (LZ4_stream_t* LZ4_streamPtr, const char* source, char* dest, int inputSize, int maxOutputSize);
803 
804 /*! Obsolete decompression functions (since v1.8.0) */
805 LZ4_DEPRECATED("use LZ4_decompress_fast() instead") LZ4LIB_API int LZ4_uncompress (const char* source, char* dest, int outputSize);
806 LZ4_DEPRECATED("use LZ4_decompress_safe() instead") LZ4LIB_API int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize);
807 
808 /* Obsolete streaming functions (since v1.7.0)
809  * degraded functionality; do not use!
810  *
811  * In order to perform streaming compression, these functions depended on data
812  * that is no longer tracked in the state. They have been preserved as well as
813  * possible: using them will still produce a correct output. However, they don't
814  * actually retain any history between compression calls. The compression ratio
815  * achieved will therefore be no better than compressing each chunk
816  * independently.
817  */
818 LZ4_DEPRECATED("Use LZ4_createStream() instead") LZ4LIB_API void* LZ4_create (char* inputBuffer);
819 LZ4_DEPRECATED("Use LZ4_createStream() instead") LZ4LIB_API int   LZ4_sizeofStreamState(void);
820 LZ4_DEPRECATED("Use LZ4_resetStream() instead")  LZ4LIB_API int   LZ4_resetStreamState(void* state, char* inputBuffer);
821 LZ4_DEPRECATED("Use LZ4_saveDict() instead")     LZ4LIB_API char* LZ4_slideInputBuffer (void* state);
822 
823 /*! Obsolete streaming decoding functions (since v1.7.0) */
824 LZ4_DEPRECATED("use LZ4_decompress_safe_usingDict() instead") LZ4LIB_API int LZ4_decompress_safe_withPrefix64k (const char* src, char* dst, int compressedSize, int maxDstSize);
825 LZ4_DEPRECATED("use LZ4_decompress_fast_usingDict() instead") LZ4LIB_API int LZ4_decompress_fast_withPrefix64k (const char* src, char* dst, int originalSize);
826 
827 /*! Obsolete LZ4_decompress_fast variants (since v1.9.0) :
828  *  These functions used to be faster than LZ4_decompress_safe(),
829  *  but this is no longer the case. They are now slower.
830  *  This is because LZ4_decompress_fast() doesn't know the input size,
831  *  and therefore must progress more cautiously into the input buffer to not read beyond the end of block.
832  *  On top of that `LZ4_decompress_fast()` is not protected vs malformed or malicious inputs, making it a security liability.
833  *  As a consequence, LZ4_decompress_fast() is strongly discouraged, and deprecated.
834  *
835  *  The last remaining LZ4_decompress_fast() specificity is that
836  *  it can decompress a block without knowing its compressed size.
837  *  Such functionality can be achieved in a more secure manner
838  *  by employing LZ4_decompress_safe_partial().
839  *
840  *  Parameters:
841  *  originalSize : is the uncompressed size to regenerate.
842  *                 `dst` must be already allocated, its size must be >= 'originalSize' bytes.
843  * @return : number of bytes read from source buffer (== compressed size).
844  *           The function expects to finish at block's end exactly.
845  *           If the source stream is detected malformed, the function stops decoding and returns a negative result.
846  *  note : LZ4_decompress_fast*() requires originalSize. Thanks to this information, it never writes past the output buffer.
847  *         However, since it doesn't know its 'src' size, it may read an unknown amount of input, past input buffer bounds.
848  *         Also, since match offsets are not validated, match reads from 'src' may underflow too.
849  *         These issues never happen if input (compressed) data is correct.
850  *         But they may happen if input data is invalid (error or intentional tampering).
851  *         As a consequence, use these functions in trusted environments with trusted data **only**.
852  */
853 LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using LZ4_decompress_safe() instead")
854 LZ4LIB_API int LZ4_decompress_fast (const char* src, char* dst, int originalSize);
855 LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using LZ4_decompress_safe_continue() instead")
856 LZ4LIB_API int LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* src, char* dst, int originalSize);
857 LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using LZ4_decompress_safe_usingDict() instead")
858 LZ4LIB_API int LZ4_decompress_fast_usingDict (const char* src, char* dst, int originalSize, const char* dictStart, int dictSize);
859 
860 /*! LZ4_resetStream() :
861  *  An LZ4_stream_t structure must be initialized at least once.
862  *  This is done with LZ4_initStream(), or LZ4_resetStream().
863  *  Consider switching to LZ4_initStream(),
864  *  invoking LZ4_resetStream() will trigger deprecation warnings in the future.
865  */
866 LZ4LIB_API void LZ4_resetStream (LZ4_stream_t* streamPtr);
867 
868 
869 #endif /* LZ4_H_98237428734687 */
870 
871 
872 #if defined (__cplusplus)
873 }
874 #endif
875 
876 #endif /* LV_USE_LZ4_INTERNAL */
877 
878