1 | /* |
2 | * LZ4 - Fast LZ compression algorithm |
3 | * Header File |
4 | * Copyright (C) 2011-2016, Yann Collet. |
5 | |
6 | BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) |
7 | |
8 | Redistribution and use in source and binary forms, with or without |
9 | modification, are permitted provided that the following conditions are |
10 | met: |
11 | |
12 | * Redistributions of source code must retain the above copyright |
13 | notice, this list of conditions and the following disclaimer. |
14 | * Redistributions in binary form must reproduce the above |
15 | copyright notice, this list of conditions and the following disclaimer |
16 | in the documentation and/or other materials provided with the |
17 | distribution. |
18 | |
19 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
20 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
21 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
22 | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
23 | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
24 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
25 | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
26 | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
27 | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
28 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
30 | |
31 | You can contact the author at : |
32 | - LZ4 homepage : http://www.lz4.org |
33 | - LZ4 source repository : https://github.com/lz4/lz4 |
34 | */ |
35 | #ifndef LZ4_H_2983827168210 |
36 | #define LZ4_H_2983827168210 |
37 | |
38 | #if defined (__cplusplus) |
39 | extern "C" { |
40 | #endif |
41 | |
42 | /* --- Dependency --- */ |
43 | #include <stddef.h> /* size_t */ |
44 | |
45 | |
46 | /** |
47 | Introduction |
48 | |
49 | LZ4 is lossless compression algorithm, providing compression speed at 400 MB/s per core, |
50 | scalable with multi-cores CPU. It features an extremely fast decoder, with speed in |
51 | multiple GB/s per core, typically reaching RAM speed limits on multi-core systems. |
52 | |
53 | The LZ4 compression library provides in-memory compression and decompression functions. |
54 | Compression can be done in: |
55 | - a single step (described as Simple Functions) |
56 | - a single step, reusing a context (described in Advanced Functions) |
57 | - unbounded multiple steps (described as Streaming compression) |
58 | |
59 | lz4.h provides block compression functions. It gives full buffer control to user. |
60 | Decompressing an lz4-compressed block also requires metadata (such as compressed size). |
61 | Each application is free to encode such metadata in whichever way it wants. |
62 | |
63 | An additional format, called LZ4 frame specification (doc/lz4_Frame_format.md), |
64 | take care of encoding standard metadata alongside LZ4-compressed blocks. |
65 | If your application requires interoperability, it's recommended to use it. |
66 | A library is provided to take care of it, see lz4frame.h. |
67 | */ |
68 | |
69 | /*^*************************************************************** |
70 | * Export parameters |
71 | *****************************************************************/ |
72 | /* |
73 | * LZ4_DLL_EXPORT : |
74 | * Enable exporting of functions when building a Windows DLL |
75 | */ |
76 | #if defined(LZ4_DLL_EXPORT) && (LZ4_DLL_EXPORT==1) |
77 | # define LZ4LIB_API __declspec(dllexport) |
78 | #elif defined(LZ4_DLL_IMPORT) && (LZ4_DLL_IMPORT==1) |
79 | # define LZ4LIB_API __declspec(dllimport) /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/ |
80 | #else |
81 | # define LZ4LIB_API |
82 | #endif |
83 | |
84 | |
85 | /*========== Version =========== */ |
86 | #define LZ4_VERSION_MAJOR 1 /* for breaking interface changes */ |
87 | #define LZ4_VERSION_MINOR 7 /* for new (non-breaking) interface capabilities */ |
88 | #define LZ4_VERSION_RELEASE 5 /* for tweaks, bug-fixes, or development */ |
89 | |
90 | #define LZ4_VERSION_NUMBER (LZ4_VERSION_MAJOR *100*100 + LZ4_VERSION_MINOR *100 + LZ4_VERSION_RELEASE) |
91 | |
92 | #define LZ4_LIB_VERSION LZ4_VERSION_MAJOR.LZ4_VERSION_MINOR.LZ4_VERSION_RELEASE |
93 | #define LZ4_QUOTE(str) #str |
94 | #define LZ4_EXPAND_AND_QUOTE(str) LZ4_QUOTE(str) |
95 | #define LZ4_VERSION_STRING LZ4_EXPAND_AND_QUOTE(LZ4_LIB_VERSION) |
96 | |
97 | LZ4LIB_API int LZ4_versionNumber (void); |
98 | LZ4LIB_API const char* LZ4_versionString (void); |
99 | |
100 | |
101 | /*-************************************ |
102 | * Tuning parameter |
103 | **************************************/ |
104 | /*! |
105 | * LZ4_MEMORY_USAGE : |
106 | * Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.) |
107 | * Increasing memory usage improves compression ratio |
108 | * Reduced memory usage can improve speed, due to cache effect |
109 | * Default value is 14, for 16KB, which nicely fits into Intel x86 L1 cache |
110 | */ |
111 | #define LZ4_MEMORY_USAGE 14 |
112 | |
113 | |
114 | /*-************************************ |
115 | * Simple Functions |
116 | **************************************/ |
117 | /*! LZ4_compress_default() : |
118 | Compresses 'sourceSize' bytes from buffer 'source' |
119 | into already allocated 'dest' buffer of size 'maxDestSize'. |
120 | Compression is guaranteed to succeed if 'maxDestSize' >= LZ4_compressBound(sourceSize). |
121 | It also runs faster, so it's a recommended setting. |
122 | If the function cannot compress 'source' into a more limited 'dest' budget, |
123 | compression stops *immediately*, and the function result is zero. |
124 | As a consequence, 'dest' content is not valid. |
125 | This function never writes outside 'dest' buffer, nor read outside 'source' buffer. |
126 | sourceSize : Max supported value is LZ4_MAX_INPUT_VALUE |
127 | maxDestSize : full or partial size of buffer 'dest' (which must be already allocated) |
128 | return : the number of bytes written into buffer 'dest' (necessarily <= maxOutputSize) |
129 | or 0 if compression fails */ |
130 | LZ4LIB_API int LZ4_compress_default(const char* source, char* dest, int sourceSize, int maxDestSize); |
131 | |
132 | /*! LZ4_decompress_safe() : |
133 | compressedSize : is the precise full size of the compressed block. |
134 | maxDecompressedSize : is the size of destination buffer, which must be already allocated. |
135 | return : the number of bytes decompressed into destination buffer (necessarily <= maxDecompressedSize) |
136 | If destination buffer is not large enough, decoding will stop and output an error code (<0). |
137 | If the source stream is detected malformed, the function will stop decoding and return a negative result. |
138 | This function is protected against buffer overflow exploits, including malicious data packets. |
139 | It never writes outside output buffer, nor reads outside input buffer. |
140 | */ |
141 | LZ4LIB_API int LZ4_decompress_safe (const char* source, char* dest, int compressedSize, int maxDecompressedSize); |
142 | |
143 | |
144 | /*-************************************ |
145 | * Advanced Functions |
146 | **************************************/ |
147 | #define LZ4_MAX_INPUT_SIZE 0x7E000000 /* 2 113 929 216 bytes */ |
148 | #define LZ4_COMPRESSBOUND(isize) ((unsigned)(isize) > (unsigned)LZ4_MAX_INPUT_SIZE ? 0 : (isize) + ((isize)/255) + 16) |
149 | |
150 | /*! |
151 | LZ4_compressBound() : |
152 | Provides the maximum size that LZ4 compression may output in a "worst case" scenario (input data not compressible) |
153 | This function is primarily useful for memory allocation purposes (destination buffer size). |
154 | Macro LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation (stack memory allocation for example). |
155 | Note that LZ4_compress_default() compress faster when dest buffer size is >= LZ4_compressBound(srcSize) |
156 | inputSize : max supported value is LZ4_MAX_INPUT_SIZE |
157 | return : maximum output size in a "worst case" scenario |
158 | or 0, if input size is too large ( > LZ4_MAX_INPUT_SIZE) |
159 | */ |
160 | LZ4LIB_API int LZ4_compressBound(int inputSize); |
161 | |
162 | /*! |
163 | LZ4_compress_fast() : |
164 | Same as LZ4_compress_default(), but allows to select an "acceleration" factor. |
165 | The larger the acceleration value, the faster the algorithm, but also the lesser the compression. |
166 | It's a trade-off. It can be fine tuned, with each successive value providing roughly +~3% to speed. |
167 | An acceleration value of "1" is the same as regular LZ4_compress_default() |
168 | Values <= 0 will be replaced by ACCELERATION_DEFAULT (see lz4.c), which is 1. |
169 | */ |
170 | LZ4LIB_API int LZ4_compress_fast (const char* source, char* dest, int sourceSize, int maxDestSize, int acceleration); |
171 | |
172 | |
173 | /*! |
174 | LZ4_compress_fast_extState() : |
175 | Same compression function, just using an externally allocated memory space to store compression state. |
176 | Use LZ4_sizeofState() to know how much memory must be allocated, |
177 | and allocate it on 8-bytes boundaries (using malloc() typically). |
178 | Then, provide it as 'void* state' to compression function. |
179 | */ |
180 | LZ4LIB_API int LZ4_sizeofState(void); |
181 | LZ4LIB_API int LZ4_compress_fast_extState (void* state, const char* source, char* dest, int inputSize, int maxDestSize, int acceleration); |
182 | |
183 | |
184 | /*! |
185 | LZ4_compress_destSize() : |
186 | Reverse the logic, by compressing as much data as possible from 'source' buffer |
187 | into already allocated buffer 'dest' of size 'targetDestSize'. |
188 | This function either compresses the entire 'source' content into 'dest' if it's large enough, |
189 | or fill 'dest' buffer completely with as much data as possible from 'source'. |
190 | *sourceSizePtr : will be modified to indicate how many bytes where read from 'source' to fill 'dest'. |
191 | New value is necessarily <= old value. |
192 | return : Nb bytes written into 'dest' (necessarily <= targetDestSize) |
193 | or 0 if compression fails |
194 | */ |
195 | LZ4LIB_API int LZ4_compress_destSize (const char* source, char* dest, int* sourceSizePtr, int targetDestSize); |
196 | |
197 | |
198 | /*! |
199 | LZ4_decompress_fast() : |
200 | originalSize : is the original and therefore uncompressed size |
201 | return : the number of bytes read from the source buffer (in other words, the compressed size) |
202 | If the source stream is detected malformed, the function will stop decoding and return a negative result. |
203 | Destination buffer must be already allocated. Its size must be a minimum of 'originalSize' bytes. |
204 | note : This function fully respect memory boundaries for properly formed compressed data. |
205 | It is a bit faster than LZ4_decompress_safe(). |
206 | However, it does not provide any protection against intentionally modified data stream (malicious input). |
207 | Use this function in trusted environment only (data to decode comes from a trusted source). |
208 | */ |
209 | LZ4LIB_API int LZ4_decompress_fast (const char* source, char* dest, int originalSize); |
210 | |
211 | /*! |
212 | LZ4_decompress_safe_partial() : |
213 | This function decompress a compressed block of size 'compressedSize' at position 'source' |
214 | into destination buffer 'dest' of size 'maxDecompressedSize'. |
215 | The function tries to stop decompressing operation as soon as 'targetOutputSize' has been reached, |
216 | reducing decompression time. |
217 | return : the number of bytes decoded in the destination buffer (necessarily <= maxDecompressedSize) |
218 | Note : this number can be < 'targetOutputSize' should the compressed block to decode be smaller. |
219 | Always control how many bytes were decoded. |
220 | If the source stream is detected malformed, the function will stop decoding and return a negative result. |
221 | This function never writes outside of output buffer, and never reads outside of input buffer. It is therefore protected against malicious data packets |
222 | */ |
223 | LZ4LIB_API int LZ4_decompress_safe_partial (const char* source, char* dest, int compressedSize, int targetOutputSize, int maxDecompressedSize); |
224 | |
225 | |
226 | /*-********************************************* |
227 | * Streaming Compression Functions |
228 | ***********************************************/ |
229 | typedef union LZ4_stream_u LZ4_stream_t; /* incomplete type (defined later) */ |
230 | |
231 | /*! LZ4_createStream() and LZ4_freeStream() : |
232 | * LZ4_createStream() will allocate and initialize an `LZ4_stream_t` structure. |
233 | * LZ4_freeStream() releases its memory. |
234 | */ |
235 | LZ4LIB_API LZ4_stream_t* LZ4_createStream(void); |
236 | LZ4LIB_API int LZ4_freeStream (LZ4_stream_t* streamPtr); |
237 | |
238 | /*! LZ4_resetStream() : |
239 | * An LZ4_stream_t structure can be allocated once and re-used multiple times. |
240 | * Use this function to init an allocated `LZ4_stream_t` structure and start a new compression. |
241 | */ |
242 | LZ4LIB_API void LZ4_resetStream (LZ4_stream_t* streamPtr); |
243 | |
244 | /*! LZ4_loadDict() : |
245 | * Use this function to load a static dictionary into LZ4_stream. |
246 | * Any previous data will be forgotten, only 'dictionary' will remain in memory. |
247 | * Loading a size of 0 is allowed. |
248 | * Return : dictionary size, in bytes (necessarily <= 64 KB) |
249 | */ |
250 | LZ4LIB_API int LZ4_loadDict (LZ4_stream_t* streamPtr, const char* dictionary, int dictSize); |
251 | |
252 | /*! LZ4_compress_fast_continue() : |
253 | * Compress buffer content 'src', using data from previously compressed blocks as dictionary to improve compression ratio. |
254 | * Important : Previous data blocks are assumed to still be present and unmodified ! |
255 | * 'dst' buffer must be already allocated. |
256 | * If maxDstSize >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster. |
257 | * If not, and if compressed data cannot fit into 'dst' buffer size, compression stops, and function returns a zero. |
258 | */ |
259 | LZ4LIB_API int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int maxDstSize, int acceleration); |
260 | |
261 | /*! LZ4_saveDict() : |
262 | * If previously compressed data block is not guaranteed to remain available at its memory location, |
263 | * save it into a safer place (char* safeBuffer). |
264 | * Note : you don't need to call LZ4_loadDict() afterwards, |
265 | * dictionary is immediately usable, you can therefore call LZ4_compress_fast_continue(). |
266 | * Return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error. |
267 | */ |
268 | LZ4LIB_API int LZ4_saveDict (LZ4_stream_t* streamPtr, char* safeBuffer, int dictSize); |
269 | |
270 | |
271 | /*-********************************************** |
272 | * Streaming Decompression Functions |
273 | * Bufferless synchronous API |
274 | ************************************************/ |
275 | typedef union LZ4_streamDecode_u LZ4_streamDecode_t; /* incomplete type (defined later) */ |
276 | |
277 | /* creation / destruction of streaming decompression tracking structure */ |
278 | LZ4LIB_API LZ4_streamDecode_t* LZ4_createStreamDecode(void); |
279 | LZ4LIB_API int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream); |
280 | |
281 | /*! LZ4_setStreamDecode() : |
282 | * Use this function to instruct where to find the dictionary. |
283 | * Setting a size of 0 is allowed (same effect as reset). |
284 | * @return : 1 if OK, 0 if error |
285 | */ |
286 | LZ4LIB_API int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const char* dictionary, int dictSize); |
287 | |
288 | /*! |
289 | LZ4_decompress_*_continue() : |
290 | These decoding functions allow decompression of multiple blocks in "streaming" mode. |
291 | Previously decoded blocks *must* remain available at the memory position where they were decoded (up to 64 KB) |
292 | In the case of a ring buffers, decoding buffer must be either : |
293 | - Exactly same size as encoding buffer, with same update rule (block boundaries at same positions) |
294 | In which case, the decoding & encoding ring buffer can have any size, including very small ones ( < 64 KB). |
295 | - Larger than encoding buffer, by a minimum of maxBlockSize more bytes. |
296 | maxBlockSize is implementation dependent. It's the maximum size you intend to compress into a single block. |
297 | In which case, encoding and decoding buffers do not need to be synchronized, |
298 | and encoding ring buffer can have any size, including small ones ( < 64 KB). |
299 | - _At least_ 64 KB + 8 bytes + maxBlockSize. |
300 | In which case, encoding and decoding buffers do not need to be synchronized, |
301 | and encoding ring buffer can have any size, including larger than decoding buffer. |
302 | Whenever these conditions are not possible, save the last 64KB of decoded data into a safe buffer, |
303 | and indicate where it is saved using LZ4_setStreamDecode() |
304 | */ |
305 | LZ4LIB_API int LZ4_decompress_safe_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int compressedSize, int maxDecompressedSize); |
306 | LZ4LIB_API int LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int originalSize); |
307 | |
308 | |
309 | /*! LZ4_decompress_*_usingDict() : |
310 | * These decoding functions work the same as |
311 | * a combination of LZ4_setStreamDecode() followed by LZ4_decompress_*_continue() |
312 | * They are stand-alone, and don't need an LZ4_streamDecode_t structure. |
313 | */ |
314 | LZ4LIB_API int LZ4_decompress_safe_usingDict (const char* source, char* dest, int compressedSize, int maxDecompressedSize, const char* dictStart, int dictSize); |
315 | LZ4LIB_API int LZ4_decompress_fast_usingDict (const char* source, char* dest, int originalSize, const char* dictStart, int dictSize); |
316 | |
317 | |
318 | /*^********************************************** |
319 | * !!!!!! STATIC LINKING ONLY !!!!!! |
320 | ***********************************************/ |
321 | /*-************************************ |
322 | * Private definitions |
323 | ************************************** |
324 | * Do not use these definitions. |
325 | * They are exposed to allow static allocation of `LZ4_stream_t` and `LZ4_streamDecode_t`. |
326 | * Using these definitions will expose code to API and/or ABI break in future versions of the library. |
327 | **************************************/ |
328 | #define LZ4_HASHLOG (LZ4_MEMORY_USAGE-2) |
329 | #define LZ4_HASHTABLESIZE (1 << LZ4_MEMORY_USAGE) |
330 | #define LZ4_HASH_SIZE_U32 (1 << LZ4_HASHLOG) /* required as macro for static allocation */ |
331 | |
332 | #if defined(__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) |
333 | #include <stdint.h> |
334 | |
335 | typedef struct { |
336 | uint32_t hashTable[LZ4_HASH_SIZE_U32]; |
337 | uint32_t currentOffset; |
338 | uint32_t initCheck; |
339 | const uint8_t* dictionary; |
340 | uint8_t* bufferStart; /* obsolete, used for slideInputBuffer */ |
341 | uint32_t dictSize; |
342 | } LZ4_stream_t_internal; |
343 | |
344 | typedef struct { |
345 | const uint8_t* externalDict; |
346 | size_t extDictSize; |
347 | const uint8_t* prefixEnd; |
348 | size_t prefixSize; |
349 | } LZ4_streamDecode_t_internal; |
350 | |
351 | #else |
352 | |
353 | typedef struct { |
354 | unsigned int hashTable[LZ4_HASH_SIZE_U32]; |
355 | unsigned int currentOffset; |
356 | unsigned int initCheck; |
357 | const unsigned char* dictionary; |
358 | unsigned char* bufferStart; /* obsolete, used for slideInputBuffer */ |
359 | unsigned int dictSize; |
360 | } LZ4_stream_t_internal; |
361 | |
362 | typedef struct { |
363 | const unsigned char* externalDict; |
364 | size_t extDictSize; |
365 | const unsigned char* prefixEnd; |
366 | size_t prefixSize; |
367 | } LZ4_streamDecode_t_internal; |
368 | |
369 | #endif |
370 | |
371 | /*! |
372 | * LZ4_stream_t : |
373 | * information structure to track an LZ4 stream. |
374 | * init this structure before first use. |
375 | * note : only use in association with static linking ! |
376 | * this definition is not API/ABI safe, |
377 | * and may change in a future version ! |
378 | */ |
379 | #define LZ4_STREAMSIZE_U64 ((1 << (LZ4_MEMORY_USAGE-3)) + 4) |
380 | #define LZ4_STREAMSIZE (LZ4_STREAMSIZE_U64 * sizeof(unsigned long long)) |
381 | union LZ4_stream_u { |
382 | unsigned long long table[LZ4_STREAMSIZE_U64]; |
383 | LZ4_stream_t_internal internal_donotuse; |
384 | } ; /* previously typedef'd to LZ4_stream_t */ |
385 | |
386 | |
387 | /*! |
388 | * LZ4_streamDecode_t : |
389 | * information structure to track an LZ4 stream during decompression. |
390 | * init this structure using LZ4_setStreamDecode (or memset()) before first use |
391 | * note : only use in association with static linking ! |
392 | * this definition is not API/ABI safe, |
393 | * and may change in a future version ! |
394 | */ |
395 | #define LZ4_STREAMDECODESIZE_U64 4 |
396 | #define LZ4_STREAMDECODESIZE (LZ4_STREAMDECODESIZE_U64 * sizeof(unsigned long long)) |
397 | union LZ4_streamDecode_u { |
398 | unsigned long long table[LZ4_STREAMDECODESIZE_U64]; |
399 | LZ4_streamDecode_t_internal internal_donotuse; |
400 | } ; /* previously typedef'd to LZ4_streamDecode_t */ |
401 | |
402 | |
403 | /*=************************************ |
404 | * Obsolete Functions |
405 | **************************************/ |
406 | /* Deprecation warnings */ |
407 | /* Should these warnings be a problem, |
408 | it is generally possible to disable them, |
409 | typically with -Wno-deprecated-declarations for gcc |
410 | or _CRT_SECURE_NO_WARNINGS in Visual. |
411 | Otherwise, it's also possible to define LZ4_DISABLE_DEPRECATE_WARNINGS */ |
412 | #ifdef LZ4_DISABLE_DEPRECATE_WARNINGS |
413 | # define LZ4_DEPRECATED(message) /* disable deprecation warnings */ |
414 | #else |
415 | # define LZ4_GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__) |
416 | # if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */ |
417 | # define LZ4_DEPRECATED(message) [[deprecated(message)]] |
418 | # elif (LZ4_GCC_VERSION >= 405) || defined(__clang__) |
419 | # define LZ4_DEPRECATED(message) __attribute__((deprecated(message))) |
420 | # elif (LZ4_GCC_VERSION >= 301) |
421 | # define LZ4_DEPRECATED(message) __attribute__((deprecated)) |
422 | # elif defined(_MSC_VER) |
423 | # define LZ4_DEPRECATED(message) __declspec(deprecated(message)) |
424 | # else |
425 | # pragma message("WARNING: You need to implement LZ4_DEPRECATED for this compiler") |
426 | # define LZ4_DEPRECATED(message) |
427 | # endif |
428 | #endif /* LZ4_DISABLE_DEPRECATE_WARNINGS */ |
429 | |
430 | /* Obsolete compression functions */ |
431 | LZ4_DEPRECATED("use LZ4_compress_default() instead" ) int LZ4_compress (const char* source, char* dest, int sourceSize); |
432 | LZ4_DEPRECATED("use LZ4_compress_default() instead" ) int LZ4_compress_limitedOutput (const char* source, char* dest, int sourceSize, int maxOutputSize); |
433 | LZ4_DEPRECATED("use LZ4_compress_fast_extState() instead" ) int LZ4_compress_withState (void* state, const char* source, char* dest, int inputSize); |
434 | LZ4_DEPRECATED("use LZ4_compress_fast_extState() instead" ) int LZ4_compress_limitedOutput_withState (void* state, const char* source, char* dest, int inputSize, int maxOutputSize); |
435 | LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead" ) int LZ4_compress_continue (LZ4_stream_t* LZ4_streamPtr, const char* source, char* dest, int inputSize); |
436 | LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead" ) int LZ4_compress_limitedOutput_continue (LZ4_stream_t* LZ4_streamPtr, const char* source, char* dest, int inputSize, int maxOutputSize); |
437 | |
438 | /* Obsolete decompression functions */ |
439 | /* These function names are completely deprecated and must no longer be used. |
440 | They are only provided in lz4.c for compatibility with older programs. |
441 | - LZ4_uncompress is the same as LZ4_decompress_fast |
442 | - LZ4_uncompress_unknownOutputSize is the same as LZ4_decompress_safe |
443 | These function prototypes are now disabled; uncomment them only if you really need them. |
444 | It is highly recommended to stop using these prototypes and migrate to maintained ones */ |
445 | /* int LZ4_uncompress (const char* source, char* dest, int outputSize); */ |
446 | /* int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize); */ |
447 | |
448 | /* Obsolete streaming functions; use new streaming interface whenever possible */ |
449 | LZ4_DEPRECATED("use LZ4_createStream() instead" ) void* LZ4_create (char* inputBuffer); |
450 | LZ4_DEPRECATED("use LZ4_createStream() instead" ) int LZ4_sizeofStreamState(void); |
451 | LZ4_DEPRECATED("use LZ4_resetStream() instead" ) int LZ4_resetStreamState(void* state, char* inputBuffer); |
452 | LZ4_DEPRECATED("use LZ4_saveDict() instead" ) char* LZ4_slideInputBuffer (void* state); |
453 | |
454 | /* Obsolete streaming decoding functions */ |
455 | LZ4_DEPRECATED("use LZ4_decompress_safe_usingDict() instead" ) int LZ4_decompress_safe_withPrefix64k (const char* src, char* dst, int compressedSize, int maxDstSize); |
456 | LZ4_DEPRECATED("use LZ4_decompress_fast_usingDict() instead" ) int LZ4_decompress_fast_withPrefix64k (const char* src, char* dst, int originalSize); |
457 | |
458 | |
459 | #if defined (__cplusplus) |
460 | } |
461 | #endif |
462 | |
463 | #endif /* LZ4_H_2983827168210 */ |
464 | |