1 /* 2 LZ4 - Fast LZ compression algorithm 3 Header File 4 Copyright (C) 2011-2013, Yann Collet. 5 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) 6 7 Redistribution and use in source and binary forms, with or without 8 modification, are permitted provided that the following conditions are 9 met: 10 11 * Redistributions of source code must retain the above copyright 12 notice, this list of conditions and the following disclaimer. 13 * Redistributions in binary form must reproduce the above 14 copyright notice, this list of conditions and the following disclaimer 15 in the documentation and/or other materials provided with the 16 distribution. 17 18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 30 You can contact the author at : 31 - LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html 32 - LZ4 source repository : http://code.google.com/p/lz4/ 33 */ 34 #pragma once 35 36 #if defined (__cplusplus) 37 extern "C" { 38 #endif 39 40 41 //************************************** 42 // Compiler Options 43 //************************************** 44 //Should go here if they are needed 45 46 //**************************** 47 // Simple Functions 48 //**************************** 49 50 int LZ4_decompress_safe (char* source, char* dest, int inputSize, 51 int maxOutputSize); 52 53 /* 54 LZ4_decompress_safe() : 55 maxOutputSize : 56 is the size of the destination buffer (which must be already allocated) 57 return : 58 the number of bytes decoded in the destination buffer 59 (necessarily <= maxOutputSize) 60 If the source stream is malformed or too large, the function will 61 stop decoding and return a negative result. 62 This function is protected against any kind of buffer overflow attemps 63 (never writes outside of output buffer, and never reads outside of 64 input buffer). It is therefore protected against malicious data packets 65 */ 66 67 68 //**************************** 69 // Advanced Functions 70 //**************************** 71 72 int LZ4_compress_limitedOutput(char* source, char* dest, int inputSize, 73 int maxOutputSize); 74 75 /* 76 LZ4_compress_limitedOutput() : 77 Compress 'inputSize' bytes from 'source' into an output buffer 'dest' 78 of maximum size 'maxOutputSize'. 79 If it cannot achieve it, compression will stop, and result of 80 the function will be zero. 81 This function never writes outside of provided output buffer. 82 83 inputSize : 84 Max supported value is ~1.9GB 85 maxOutputSize : 86 is the size of the destination buffer (which must bealready allocated) 87 return : 88 the number of bytes written in buffer 'dest' or 0 if the compression fails 89 */ 90 91 #if defined (__cplusplus) 92 } 93 #endif 94