Upgrade LZ4 to latest version.

This commit is contained in:
Adam Ierymenko 2014-07-30 15:34:15 -07:00
parent 59ebc9d41e
commit 9b93141dd0
5 changed files with 2641 additions and 1956 deletions

File diff suppressed because it is too large Load Diff

View File

@ -1,205 +1,326 @@
/* /*
LZ4 - Fast LZ compression algorithm LZ4 - Fast LZ compression algorithm
Header File Header File
Copyright (C) 2011-2013, Yann Collet. Copyright (C) 2011-2014, Yann Collet.
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are modification, are permitted provided that the following conditions are
met: met:
* Redistributions of source code must retain the above copyright * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer. notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the in the documentation and/or other materials provided with the
distribution. distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
You can contact the author at : You can contact the author at :
- LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html - LZ4 source repository : http://code.google.com/p/lz4/
- LZ4 source repository : http://code.google.com/p/lz4/ - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c
*/ */
#pragma once #pragma once
#if defined (__cplusplus) #if defined (__cplusplus)
extern "C" { extern "C" {
#endif #endif
//************************************** /**************************************
// Compiler Options Version
//************************************** **************************************/
#if defined(_MSC_VER) && !defined(__cplusplus) // Visual Studio #define LZ4_VERSION_MAJOR 1 /* for major interface/format changes */
# define inline __inline // Visual C is not C99, but supports some kind of inline #define LZ4_VERSION_MINOR 3 /* for minor interface/format changes */
#endif #define LZ4_VERSION_RELEASE 0 /* for tweaks, bug-fixes, or development */
#define LZ4_VERSION_NUMBER (LZ4_VERSION_MAJOR *100*100 + LZ4_VERSION_MINOR *100 + LZ4_VERSION_RELEASE)
int LZ4_versionNumber (void);
//****************************
// Simple Functions /**************************************
//**************************** Tuning parameter
**************************************/
int LZ4_compress (const char* source, char* dest, int inputSize); /*
int LZ4_decompress_safe (const char* source, char* dest, int inputSize, int maxOutputSize); * LZ4_MEMORY_USAGE :
* Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.)
/* * Increasing memory usage improves compression ratio
LZ4_compress() : * Reduced memory usage can improve speed, due to cache effect
Compresses 'inputSize' bytes from 'source' into 'dest'. * Default value is 14, for 16KB, which nicely fits into Intel x86 L1 cache
Destination buffer must be already allocated, */
and must be sized to handle worst cases situations (input data not compressible) #define LZ4_MEMORY_USAGE 14
Worst case size evaluation is provided by function LZ4_compressBound()
inputSize : Max supported value is LZ4_MAX_INPUT_VALUE
return : the number of bytes written in buffer dest /**************************************
or 0 if the compression fails Simple Functions
**************************************/
LZ4_decompress_safe() :
maxOutputSize : is the size of the destination buffer (which must be already allocated) int LZ4_compress (const char* source, char* dest, int inputSize);
return : the number of bytes decoded in the destination buffer (necessarily <= maxOutputSize) int LZ4_decompress_safe (const char* source, char* dest, int compressedSize, int maxDecompressedSize);
If the source stream is detected malformed, the function will stop decoding and return a negative result.
This function is protected against buffer overflow exploits (never writes outside of output buffer, and never reads outside of input buffer). Therefore, it is protected against malicious data packets /*
*/ LZ4_compress() :
Compresses 'inputSize' bytes from 'source' into 'dest'.
Destination buffer must be already allocated,
//**************************** and must be sized to handle worst cases situations (input data not compressible)
// Advanced Functions Worst case size evaluation is provided by function LZ4_compressBound()
//**************************** inputSize : Max supported value is LZ4_MAX_INPUT_SIZE
#define LZ4_MAX_INPUT_SIZE 0x7E000000 // 2 113 929 216 bytes return : the number of bytes written in buffer dest
#define LZ4_COMPRESSBOUND(isize) ((unsigned int)(isize) > (unsigned int)LZ4_MAX_INPUT_SIZE ? 0 : (isize) + ((isize)/255) + 16) or 0 if the compression fails
static inline int LZ4_compressBound(int isize) { return LZ4_COMPRESSBOUND(isize); }
LZ4_decompress_safe() :
/* compressedSize : is obviously the source size
LZ4_compressBound() : maxDecompressedSize : is the size of the destination buffer, which must be already allocated.
Provides the maximum size that LZ4 may output in a "worst case" scenario (input data not compressible) return : the number of bytes decompressed into the destination buffer (necessarily <= maxDecompressedSize)
primarily useful for memory allocation of output buffer. If the destination buffer is not large enough, decoding will stop and output an error code (<0).
inline function is recommended for the general case, If the source stream is detected malformed, the function will stop decoding and return a negative result.
macro is also provided when result needs to be evaluated at compilation (such as stack memory allocation). This function is protected against buffer overflow exploits :
it never writes outside of output buffer, and never reads outside of input buffer.
isize : is the input size. Max supported value is LZ4_MAX_INPUT_SIZE Therefore, it is protected against malicious data packets.
return : maximum output size in a "worst case" scenario */
or 0, if input size is too large ( > LZ4_MAX_INPUT_SIZE)
*/
/*
Note :
int LZ4_compress_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize); Should you prefer to explicitly allocate compression-table memory using your own allocation method,
use the streaming functions provided below, simply reset the memory area between each call to LZ4_compress_continue()
/* */
LZ4_compress_limitedOutput() :
Compress 'inputSize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'.
If it cannot achieve it, compression will stop, and result of the function will be zero. /**************************************
This function never writes outside of provided output buffer. Advanced Functions
**************************************/
inputSize : Max supported value is LZ4_MAX_INPUT_VALUE #define LZ4_MAX_INPUT_SIZE 0x7E000000 /* 2 113 929 216 bytes */
maxOutputSize : is the size of the destination buffer (which must be already allocated) #define LZ4_COMPRESSBOUND(isize) ((unsigned int)(isize) > (unsigned int)LZ4_MAX_INPUT_SIZE ? 0 : (isize) + ((isize)/255) + 16)
return : the number of bytes written in buffer 'dest'
or 0 if the compression fails /*
*/ LZ4_compressBound() :
Provides the maximum size that LZ4 may output in a "worst case" scenario (input data not compressible)
primarily useful for memory allocation of output buffer.
int LZ4_decompress_fast (const char* source, char* dest, int outputSize); macro is also provided when result needs to be evaluated at compilation (such as stack memory allocation).
/* isize : is the input size. Max supported value is LZ4_MAX_INPUT_SIZE
LZ4_decompress_fast() : return : maximum output size in a "worst case" scenario
outputSize : is the original (uncompressed) size or 0, if input size is too large ( > LZ4_MAX_INPUT_SIZE)
return : the number of bytes read from the source buffer (in other words, the compressed size) */
If the source stream is malformed, the function will stop decoding and return a negative result. int LZ4_compressBound(int isize);
note : This function is a bit faster than LZ4_decompress_safe()
This function never writes outside of output buffers, but may read beyond input buffer in case of malicious data packet.
Use this function preferably into a trusted environment (data to decode comes from a trusted source). /*
Destination buffer must be already allocated. Its size must be a minimum of 'outputSize' bytes. LZ4_compress_limitedOutput() :
*/ Compress 'inputSize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'.
If it cannot achieve it, compression will stop, and result of the function will be zero.
int LZ4_decompress_safe_partial (const char* source, char* dest, int inputSize, int targetOutputSize, int maxOutputSize); This function never writes outside of provided output buffer.
/* inputSize : Max supported value is LZ4_MAX_INPUT_VALUE
LZ4_decompress_safe_partial() : maxOutputSize : is the size of the destination buffer (which must be already allocated)
This function decompress a compressed block of size 'inputSize' at position 'source' return : the number of bytes written in buffer 'dest'
into output buffer 'dest' of size 'maxOutputSize'. or 0 if the compression fails
The function tries to stop decompressing operation as soon as 'targetOutputSize' has been reached, */
reducing decompression time. int LZ4_compress_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize);
return : the number of bytes decoded in the destination buffer (necessarily <= maxOutputSize)
Note : this number can be < 'targetOutputSize' should the compressed block to decode be smaller.
Always control how many bytes were decoded. /*
If the source stream is detected malformed, the function will stop decoding and return a negative result. LZ4_compress_withState() :
This function never writes outside of output buffer, and never reads outside of input buffer. It is therefore protected against malicious data packets Same compression functions, but using an externally allocated memory space to store compression state.
*/ Use LZ4_sizeofState() to know how much memory must be allocated,
and then, provide it as 'void* state' to compression functions.
*/
//**************************** int LZ4_sizeofState(void);
// Stream Functions int LZ4_compress_withState (void* state, const char* source, char* dest, int inputSize);
//**************************** int LZ4_compress_limitedOutput_withState (void* state, const char* source, char* dest, int inputSize, int maxOutputSize);
void* LZ4_create (const char* inputBuffer);
int LZ4_compress_continue (void* LZ4_Data, const char* source, char* dest, int inputSize); /*
int LZ4_compress_limitedOutput_continue (void* LZ4_Data, const char* source, char* dest, int inputSize, int maxOutputSize); LZ4_decompress_fast() :
char* LZ4_slideInputBuffer (void* LZ4_Data); originalSize : is the original and therefore uncompressed size
int LZ4_free (void* LZ4_Data); return : the number of bytes read from the source buffer (in other words, the compressed size)
If the source stream is detected malformed, the function will stop decoding and return a negative result.
/* Destination buffer must be already allocated. Its size must be a minimum of 'originalSize' bytes.
These functions allow the compression of dependent blocks, where each block benefits from prior 64 KB within preceding blocks. note : This function fully respect memory boundaries for properly formed compressed data.
In order to achieve this, it is necessary to start creating the LZ4 Data Structure, thanks to the function : It is a bit faster than LZ4_decompress_safe().
However, it does not provide any protection against intentionnally modified data stream (malicious input).
void* LZ4_create (const char* inputBuffer); Use this function in trusted environment only (data to decode comes from a trusted source).
The result of the function is the (void*) pointer on the LZ4 Data Structure. */
This pointer will be needed in all other functions. int LZ4_decompress_fast (const char* source, char* dest, int originalSize);
If the pointer returned is NULL, then the allocation has failed, and compression must be aborted.
The only parameter 'const char* inputBuffer' must, obviously, point at the beginning of input buffer.
The input buffer must be already allocated, and size at least 192KB. /*
'inputBuffer' will also be the 'const char* source' of the first block. LZ4_decompress_safe_partial() :
This function decompress a compressed block of size 'compressedSize' at position 'source'
All blocks are expected to lay next to each other within the input buffer, starting from 'inputBuffer'. into destination buffer 'dest' of size 'maxDecompressedSize'.
To compress each block, use either LZ4_compress_continue() or LZ4_compress_limitedOutput_continue(). The function tries to stop decompressing operation as soon as 'targetOutputSize' has been reached,
Their behavior are identical to LZ4_compress() or LZ4_compress_limitedOutput(), reducing decompression time.
but require the LZ4 Data Structure as their first argument, and check that each block starts right after the previous one. return : the number of bytes decoded in the destination buffer (necessarily <= maxDecompressedSize)
If next block does not begin immediately after the previous one, the compression will fail (return 0). Note : this number can be < 'targetOutputSize' should the compressed block to decode be smaller.
Always control how many bytes were decoded.
When it's no longer possible to lay the next block after the previous one (not enough space left into input buffer), a call to : If the source stream is detected malformed, the function will stop decoding and return a negative result.
char* LZ4_slideInputBuffer(void* LZ4_Data); This function never writes outside of output buffer, and never reads outside of input buffer. It is therefore protected against malicious data packets
must be performed. It will typically copy the latest 64KB of input at the beginning of input buffer. */
Note that, for this function to work properly, minimum size of an input buffer must be 192KB. int LZ4_decompress_safe_partial (const char* source, char* dest, int compressedSize, int targetOutputSize, int maxDecompressedSize);
==> The memory position where the next input data block must start is provided as the result of the function.
Compression can then resume, using LZ4_compress_continue() or LZ4_compress_limitedOutput_continue(), as usual. /***********************************************
Experimental Streaming Compression Functions
When compression is completed, a call to LZ4_free() will release the memory used by the LZ4 Data Structure. ***********************************************/
*/
#define LZ4_STREAMSIZE_U32 ((1 << (LZ4_MEMORY_USAGE-2)) + 8)
#define LZ4_STREAMSIZE (LZ4_STREAMSIZE_U32 * sizeof(unsigned int))
int LZ4_decompress_safe_withPrefix64k (const char* source, char* dest, int inputSize, int maxOutputSize); /*
int LZ4_decompress_fast_withPrefix64k (const char* source, char* dest, int outputSize); * LZ4_stream_t
* information structure to track an LZ4 stream.
/* * important : init this structure content before first use !
*_withPrefix64k() : */
These decoding functions work the same as their "normal name" versions, typedef struct { unsigned int table[LZ4_STREAMSIZE_U32]; } LZ4_stream_t;
but can use up to 64KB of data in front of 'char* dest'.
These functions are necessary to decode inter-dependant blocks. /*
*/ * LZ4_resetStream
* Use this function to init a newly allocated LZ4_stream_t structure
* You can also reset an existing LZ4_stream_t structure
//**************************** */
// Obsolete Functions void LZ4_resetStream (LZ4_stream_t* LZ4_stream);
//****************************
/*
static inline int LZ4_uncompress (const char* source, char* dest, int outputSize) { return LZ4_decompress_fast(source, dest, outputSize); } * If you prefer dynamic allocation methods,
static inline int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize) { return LZ4_decompress_safe(source, dest, isize, maxOutputSize); } * LZ4_createStream will allocate and initialize an LZ4_stream_t structure
* LZ4_freeStream releases its memory.
/* */
These functions are deprecated and should no longer be used. LZ4_stream_t* LZ4_createStream(void);
They are provided here for compatibility with existing user programs. int LZ4_freeStream (LZ4_stream_t* LZ4_stream);
*/
/*
* LZ4_loadDict
* Use this function to load a static dictionary into LZ4_stream.
#if defined (__cplusplus) * Any previous data will be forgotten, only 'dictionary' will remain in memory.
} * Loading a size of 0 is allowed.
#endif * Return : 1 if OK, 0 if error
*/
int LZ4_loadDict (LZ4_stream_t* LZ4_stream, const char* dictionary, int dictSize);
/*
* LZ4_compress_continue
* Compress data block 'source', using blocks compressed before as dictionary to improve compression ratio
* Previous data blocks are assumed to still be present at their previous location.
*/
int LZ4_compress_continue (LZ4_stream_t* LZ4_stream, const char* source, char* dest, int inputSize);
/*
* LZ4_compress_limitedOutput_continue
* Same as before, but also specify a maximum target compressed size (maxOutputSize)
* If objective cannot be met, compression exits, and returns a zero.
*/
int LZ4_compress_limitedOutput_continue (LZ4_stream_t* LZ4_stream, const char* source, char* dest, int inputSize, int maxOutputSize);
/*
* LZ4_saveDict
* If previously compressed data block is not guaranteed to remain available at its memory location
* save it into a safe place (char* safeBuffer)
* Note : you don't need to call LZ4_loadDict() afterwards,
* dictionary is immediately usable, you can therefore call again LZ4_compress_continue()
* Return : 1 if OK, 0 if error
* Note : any dictSize > 64 KB will be interpreted as 64KB.
*/
int LZ4_saveDict (LZ4_stream_t* LZ4_stream, char* safeBuffer, int dictSize);
/************************************************
Experimental Streaming Decompression Functions
************************************************/
#define LZ4_STREAMDECODESIZE_U32 4
#define LZ4_STREAMDECODESIZE (LZ4_STREAMDECODESIZE_U32 * sizeof(unsigned int))
/*
* LZ4_streamDecode_t
* information structure to track an LZ4 stream.
* important : init this structure content using LZ4_setStreamDecode or memset() before first use !
*/
typedef struct { unsigned int table[LZ4_STREAMDECODESIZE_U32]; } LZ4_streamDecode_t;
/*
* LZ4_setStreamDecode
* Use this function to instruct where to find the dictionary.
* This function can be used to specify a static dictionary,
* or to instruct where to find some previously decoded data saved into a different memory space.
* Setting a size of 0 is allowed (same effect as no dictionary).
* Return : 1 if OK, 0 if error
*/
int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const char* dictionary, int dictSize);
/*
* If you prefer dynamic allocation methods,
* LZ4_createStreamDecode will allocate and initialize an LZ4_streamDecode_t structure
* LZ4_freeStreamDecode releases its memory.
*/
LZ4_streamDecode_t* LZ4_createStreamDecode(void);
int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream);
/*
*_continue() :
These decoding functions allow decompression of multiple blocks in "streaming" mode.
Previously decoded blocks must still be available at the memory position where they were decoded.
If it's not possible, save the relevant part of decoded data into a safe buffer,
and indicate where its new address using LZ4_setDictDecode()
*/
int LZ4_decompress_safe_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int compressedSize, int maxOutputSize);
int LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int originalSize);
/*
Advanced decoding functions :
*_usingDict() :
These decoding functions work the same as
a combination of LZ4_setDictDecode() followed by LZ4_decompress_x_continue()
all together into a single function call.
It doesn't use nor update an LZ4_streamDecode_t structure.
*/
int LZ4_decompress_safe_usingDict (const char* source, char* dest, int compressedSize, int maxOutputSize, const char* dictStart, int dictSize);
int LZ4_decompress_fast_usingDict (const char* source, char* dest, int originalSize, const char* dictStart, int dictSize);
/**************************************
Obsolete Functions
**************************************/
/*
Obsolete decompression functions
These function names are deprecated and should no longer be used.
They are only provided here for compatibility with older user programs.
- LZ4_uncompress is the same as LZ4_decompress_fast
- LZ4_uncompress_unknownOutputSize is the same as LZ4_decompress_safe
These function prototypes are now disabled; uncomment them if you really need them.
It is highly recommended to stop using these functions and migrated to newer ones */
/* int LZ4_uncompress (const char* source, char* dest, int outputSize); */
/* int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize); */
/*
* If you prefer dynamic allocation methods,
* LZ4_createStreamDecode()
* provides a pointer (void*) towards an initialized LZ4_streamDecode_t structure.
* LZ4_free just frees it.
*/
/* void* LZ4_createStreamDecode(void); */
/*int LZ4_free (void* LZ4_stream); yes, it's the same one as for compression */
/* Obsolete streaming functions; use new streaming interface whenever possible */
void* LZ4_create (const char* inputBuffer);
int LZ4_sizeofStreamState(void);
int LZ4_resetStreamState(void* state, const char* inputBuffer);
char* LZ4_slideInputBuffer (void* state);
/* Obsolete streaming decoding functions */
int LZ4_decompress_safe_withPrefix64k (const char* source, char* dest, int compressedSize, int maxOutputSize);
int LZ4_decompress_fast_withPrefix64k (const char* source, char* dest, int originalSize);
#if defined (__cplusplus)
}
#endif

File diff suppressed because it is too large Load Diff

View File

@ -1,111 +1,173 @@
/* /*
LZ4 HC - High Compression Mode of LZ4 LZ4 HC - High Compression Mode of LZ4
Header File Header File
Copyright (C) 2011-2013, Yann Collet. Copyright (C) 2011-2014, Yann Collet.
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are modification, are permitted provided that the following conditions are
met: met:
* Redistributions of source code must retain the above copyright * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer. notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the in the documentation and/or other materials provided with the
distribution. distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
You can contact the author at : You can contact the author at :
- LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html - LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html
- LZ4 source repository : http://code.google.com/p/lz4/ - LZ4 source repository : http://code.google.com/p/lz4/
*/ */
#pragma once #pragma once
#if defined (__cplusplus) #if defined (__cplusplus)
extern "C" { extern "C" {
#endif #endif
int LZ4_compressHC (const char* source, char* dest, int inputSize); int LZ4_compressHC (const char* source, char* dest, int inputSize);
/* /*
LZ4_compressHC : LZ4_compressHC :
return : the number of bytes in compressed buffer dest return : the number of bytes in compressed buffer dest
or 0 if compression fails. or 0 if compression fails.
note : destination buffer must be already allocated. note : destination buffer must be already allocated.
To avoid any problem, size it to handle worst cases situations (input data not compressible) To avoid any problem, size it to handle worst cases situations (input data not compressible)
Worst case size evaluation is provided by function LZ4_compressBound() (see "lz4.h") Worst case size evaluation is provided by function LZ4_compressBound() (see "lz4.h")
*/ */
int LZ4_compressHC_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize); int LZ4_compressHC_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize);
/* /*
LZ4_compress_limitedOutput() : LZ4_compress_limitedOutput() :
Compress 'inputSize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'. Compress 'inputSize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'.
If it cannot achieve it, compression will stop, and result of the function will be zero. If it cannot achieve it, compression will stop, and result of the function will be zero.
This function never writes outside of provided output buffer. This function never writes outside of provided output buffer.
inputSize : Max supported value is 1 GB inputSize : Max supported value is 1 GB
maxOutputSize : is maximum allowed size into the destination buffer (which must be already allocated) maxOutputSize : is maximum allowed size into the destination buffer (which must be already allocated)
return : the number of output bytes written in buffer 'dest' return : the number of output bytes written in buffer 'dest'
or 0 if compression fails. or 0 if compression fails.
*/ */
/* Note : int LZ4_compressHC2 (const char* source, char* dest, int inputSize, int compressionLevel);
Decompression functions are provided within LZ4 source code (see "lz4.h") (BSD license) int LZ4_compressHC2_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize, int compressionLevel);
*/ /*
Same functions as above, but with programmable 'compressionLevel'.
Recommended values are between 4 and 9, although any value between 0 and 16 will work.
/* Advanced Functions */ 'compressionLevel'==0 means use default 'compressionLevel' value.
Values above 16 behave the same as 16.
void* LZ4_createHC (const char* inputBuffer); Equivalent variants exist for all other compression functions below.
int LZ4_compressHC_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize); */
int LZ4_compressHC_limitedOutput_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int maxOutputSize);
char* LZ4_slideInputBufferHC (void* LZ4HC_Data); /* Note :
int LZ4_freeHC (void* LZ4HC_Data); Decompression functions are provided within LZ4 source code (see "lz4.h") (BSD license)
*/
/*
These functions allow the compression of dependent blocks, where each block benefits from prior 64 KB within preceding blocks.
In order to achieve this, it is necessary to start creating the LZ4HC Data Structure, thanks to the function : /**************************************
Using an external allocation
void* LZ4_createHC (const char* inputBuffer); **************************************/
The result of the function is the (void*) pointer on the LZ4HC Data Structure. int LZ4_sizeofStateHC(void);
This pointer will be needed in all other functions. int LZ4_compressHC_withStateHC (void* state, const char* source, char* dest, int inputSize);
If the pointer returned is NULL, then the allocation has failed, and compression must be aborted. int LZ4_compressHC_limitedOutput_withStateHC (void* state, const char* source, char* dest, int inputSize, int maxOutputSize);
The only parameter 'const char* inputBuffer' must, obviously, point at the beginning of input buffer.
The input buffer must be already allocated, and size at least 192KB. int LZ4_compressHC2_withStateHC (void* state, const char* source, char* dest, int inputSize, int compressionLevel);
'inputBuffer' will also be the 'const char* source' of the first block. int LZ4_compressHC2_limitedOutput_withStateHC(void* state, const char* source, char* dest, int inputSize, int maxOutputSize, int compressionLevel);
All blocks are expected to lay next to each other within the input buffer, starting from 'inputBuffer'. /*
To compress each block, use either LZ4_compressHC_continue() or LZ4_compressHC_limitedOutput_continue(). These functions are provided should you prefer to allocate memory for compression tables with your own allocation methods.
Their behavior are identical to LZ4_compressHC() or LZ4_compressHC_limitedOutput(), To know how much memory must be allocated for the compression tables, use :
but require the LZ4HC Data Structure as their first argument, and check that each block starts right after the previous one. int LZ4_sizeofStateHC();
If next block does not begin immediately after the previous one, the compression will fail (return 0).
Note that tables must be aligned for pointer (32 or 64 bits), otherwise compression will fail (return code 0).
When it's no longer possible to lay the next block after the previous one (not enough space left into input buffer), a call to :
char* LZ4_slideInputBufferHC(void* LZ4HC_Data); The allocated memory can be provided to the compressions functions using 'void* state' parameter.
must be performed. It will typically copy the latest 64KB of input at the beginning of input buffer. LZ4_compress_withStateHC() and LZ4_compress_limitedOutput_withStateHC() are equivalent to previously described functions.
Note that, for this function to work properly, minimum size of an input buffer must be 192KB. They just use the externally allocated memory area instead of allocating their own (on stack, or on heap).
==> The memory position where the next input data block must start is provided as the result of the function. */
Compression can then resume, using LZ4_compressHC_continue() or LZ4_compressHC_limitedOutput_continue(), as usual.
/**************************************
When compression is completed, a call to LZ4_freeHC() will release the memory used by the LZ4HC Data Structure. Streaming Functions
*/ **************************************/
/* Note : these streaming functions still follows the older model */
void* LZ4_createHC (const char* inputBuffer);
#if defined (__cplusplus) int LZ4_compressHC_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize);
} int LZ4_compressHC_limitedOutput_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int maxOutputSize);
#endif char* LZ4_slideInputBufferHC (void* LZ4HC_Data);
int LZ4_freeHC (void* LZ4HC_Data);
int LZ4_compressHC2_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int compressionLevel);
int LZ4_compressHC2_limitedOutput_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int maxOutputSize, int compressionLevel);
/*
These functions allow the compression of dependent blocks, where each block benefits from prior 64 KB within preceding blocks.
In order to achieve this, it is necessary to start creating the LZ4HC Data Structure, thanks to the function :
void* LZ4_createHC (const char* inputBuffer);
The result of the function is the (void*) pointer on the LZ4HC Data Structure.
This pointer will be needed in all other functions.
If the pointer returned is NULL, then the allocation has failed, and compression must be aborted.
The only parameter 'const char* inputBuffer' must, obviously, point at the beginning of input buffer.
The input buffer must be already allocated, and size at least 192KB.
'inputBuffer' will also be the 'const char* source' of the first block.
All blocks are expected to lay next to each other within the input buffer, starting from 'inputBuffer'.
To compress each block, use either LZ4_compressHC_continue() or LZ4_compressHC_limitedOutput_continue().
Their behavior are identical to LZ4_compressHC() or LZ4_compressHC_limitedOutput(),
but require the LZ4HC Data Structure as their first argument, and check that each block starts right after the previous one.
If next block does not begin immediately after the previous one, the compression will fail (return 0).
When it's no longer possible to lay the next block after the previous one (not enough space left into input buffer), a call to :
char* LZ4_slideInputBufferHC(void* LZ4HC_Data);
must be performed. It will typically copy the latest 64KB of input at the beginning of input buffer.
Note that, for this function to work properly, minimum size of an input buffer must be 192KB.
==> The memory position where the next input data block must start is provided as the result of the function.
Compression can then resume, using LZ4_compressHC_continue() or LZ4_compressHC_limitedOutput_continue(), as usual.
When compression is completed, a call to LZ4_freeHC() will release the memory used by the LZ4HC Data Structure.
*/
int LZ4_sizeofStreamStateHC(void);
int LZ4_resetStreamStateHC(void* state, const char* inputBuffer);
/*
These functions achieve the same result as :
void* LZ4_createHC (const char* inputBuffer);
They are provided here to allow the user program to allocate memory using its own routines.
To know how much space must be allocated, use LZ4_sizeofStreamStateHC();
Note also that space must be aligned for pointers (32 or 64 bits).
Once space is allocated, you must initialize it using : LZ4_resetStreamStateHC(void* state, const char* inputBuffer);
void* state is a pointer to the space allocated.
It must be aligned for pointers (32 or 64 bits), and be large enough.
The parameter 'const char* inputBuffer' must, obviously, point at the beginning of input buffer.
The input buffer must be already allocated, and size at least 192KB.
'inputBuffer' will also be the 'const char* source' of the first block.
The same space can be re-used multiple times, just by initializing it each time with LZ4_resetStreamState().
return value of LZ4_resetStreamStateHC() must be 0 is OK.
Any other value means there was an error (typically, state is not aligned for pointers (32 or 64 bits)).
*/
#if defined (__cplusplus)
}
#endif

View File

@ -993,7 +993,7 @@ public:
if ((compressed())&&(size() >= ZT_PROTO_MIN_PACKET_LENGTH)) { if ((compressed())&&(size() >= ZT_PROTO_MIN_PACKET_LENGTH)) {
if (size() > ZT_PACKET_IDX_PAYLOAD) { if (size() > ZT_PACKET_IDX_PAYLOAD) {
unsigned int compLen = size() - ZT_PACKET_IDX_PAYLOAD; unsigned int compLen = size() - ZT_PACKET_IDX_PAYLOAD;
int ucl = LZ4_uncompress_unknownOutputSize((const char *)field(ZT_PACKET_IDX_PAYLOAD,compLen),(char *)buf,compLen,sizeof(buf)); int ucl = LZ4_decompress_safe((const char *)field(ZT_PACKET_IDX_PAYLOAD,compLen),(char *)buf,compLen,sizeof(buf));
if ((ucl > 0)&&(ucl <= (int)(capacity() - ZT_PACKET_IDX_PAYLOAD))) { if ((ucl > 0)&&(ucl <= (int)(capacity() - ZT_PACKET_IDX_PAYLOAD))) {
setSize((unsigned int)ucl + ZT_PACKET_IDX_PAYLOAD); setSize((unsigned int)ucl + ZT_PACKET_IDX_PAYLOAD);
memcpy(field(ZT_PACKET_IDX_PAYLOAD,(unsigned int)ucl),buf,ucl); memcpy(field(ZT_PACKET_IDX_PAYLOAD,(unsigned int)ucl),buf,ucl);