lz4frame.h 18.6 KB
Newer Older
lz4 Upstream's avatar
lz4 Upstream committed
1
2
3
/*
   LZ4 auto-framing library
   Header File
lz4 Upstream's avatar
lz4 Upstream committed
4
   Copyright (C) 2011-2017, Yann Collet.
lz4 Upstream's avatar
lz4 Upstream committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
   BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are
   met:

       * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
       * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following disclaimer
   in the documentation and/or other materials provided with the
   distribution.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

   You can contact the author at :
lz4 Upstream's avatar
lz4 Upstream committed
31
   - LZ4 source repository : https://github.com/lz4/lz4
lz4 Upstream's avatar
lz4 Upstream committed
32
33
34
35
   - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c
*/

/* LZ4F is a stand-alone API to create LZ4-compressed frames
lz4 Upstream's avatar
lz4 Upstream committed
36
37
38
 * conformant with specification v1.5.1.
 * It also offers streaming capabilities.
 * lz4.h is not required when using lz4frame.h.
lz4 Upstream's avatar
lz4 Upstream committed
39
40
 * */

lz4 Upstream's avatar
lz4 Upstream committed
41
42
#ifndef LZ4F_H_09782039843
#define LZ4F_H_09782039843
lz4 Upstream's avatar
lz4 Upstream committed
43

lz4 Upstream's avatar
lz4 Upstream committed
44
#include "vtk_lz4_mangle.h"
lz4 Upstream's avatar
lz4 Upstream committed
45
46
47
48
49

#if defined (__cplusplus)
extern "C" {
#endif

lz4 Upstream's avatar
lz4 Upstream committed
50
/* ---   Dependency   --- */
lz4 Upstream's avatar
lz4 Upstream committed
51
52
53
#include <stddef.h>   /* size_t */


lz4 Upstream's avatar
lz4 Upstream committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/**
  Introduction

  lz4frame.h implements LZ4 frame specification (doc/lz4_Frame_format.md).
  lz4frame.h provides frame compression functions that take care
  of encoding standard metadata alongside LZ4-compressed blocks.
*/

/*-***************************************************************
 *  Compiler specifics
 *****************************************************************/
/*  LZ4_DLL_EXPORT :
 *  Enable exporting of functions when building a Windows DLL
 *  LZ4FLIB_API :
 *  Control library symbols visibility.
 */
#if defined(LZ4_DLL_EXPORT) && (LZ4_DLL_EXPORT==1)
#  define LZ4FLIB_API __declspec(dllexport)
#elif defined(LZ4_DLL_IMPORT) && (LZ4_DLL_IMPORT==1)
#  define LZ4FLIB_API __declspec(dllimport)
#elif defined(__GNUC__) && (__GNUC__ >= 4)
#  define LZ4FLIB_API __attribute__ ((__visibility__ ("default")))
#else
#  define LZ4FLIB_API
#endif

#ifdef LZ4F_DISABLE_DEPRECATE_WARNINGS
#  define LZ4F_DEPRECATE(x) x
#else
#  if defined(_MSC_VER)
#    define LZ4F_DEPRECATE(x) x   /* __declspec(deprecated) x - only works with C++ */
#  elif defined(__clang__) || (defined(__GNUC__) && (__GNUC__ >= 6))
#    define LZ4F_DEPRECATE(x) x __attribute__((deprecated))
#  else
#    define LZ4F_DEPRECATE(x) x   /* no deprecation warning for this compiler */
#  endif
#endif


/*-************************************
 *  Error management
 **************************************/
lz4 Upstream's avatar
lz4 Upstream committed
96
97
typedef size_t LZ4F_errorCode_t;

lz4 Upstream's avatar
lz4 Upstream committed
98
99
LZ4FLIB_API unsigned    LZ4F_isError(LZ4F_errorCode_t code);   /**< tells if a `LZ4F_errorCode_t` function result is an error code */
LZ4FLIB_API const char* LZ4F_getErrorName(LZ4F_errorCode_t code);   /**< return error code string; useful for debugging */
lz4 Upstream's avatar
lz4 Upstream committed
100
101


lz4 Upstream's avatar
lz4 Upstream committed
102
103
104
105
106
107
/*-************************************
 *  Frame compression types
 **************************************/
/* #define LZ4F_ENABLE_OBSOLETE_ENUMS   // uncomment to enable obsolete enums */
#ifdef LZ4F_ENABLE_OBSOLETE_ENUMS
#  define LZ4F_OBSOLETE_ENUM(x) , LZ4F_DEPRECATE(x) = LZ4F_##x
lz4 Upstream's avatar
lz4 Upstream committed
108
109
110
111
#else
#  define LZ4F_OBSOLETE_ENUM(x)
#endif

lz4 Upstream's avatar
lz4 Upstream committed
112
113
114
/* The larger the block size, the (slightly) better the compression ratio,
 * though there are diminishing returns.
 * Larger blocks also increase memory usage on both compression and decompression sides. */
lz4 Upstream's avatar
lz4 Upstream committed
115
116
117
118
119
120
typedef enum {
    LZ4F_default=0,
    LZ4F_max64KB=4,
    LZ4F_max256KB=5,
    LZ4F_max1MB=6,
    LZ4F_max4MB=7
lz4 Upstream's avatar
lz4 Upstream committed
121
122
123
124
    LZ4F_OBSOLETE_ENUM(max64KB)
    LZ4F_OBSOLETE_ENUM(max256KB)
    LZ4F_OBSOLETE_ENUM(max1MB)
    LZ4F_OBSOLETE_ENUM(max4MB)
lz4 Upstream's avatar
lz4 Upstream committed
125
126
} LZ4F_blockSizeID_t;

lz4 Upstream's avatar
lz4 Upstream committed
127
128
129
/* Linked blocks sharply reduce inefficiencies when using small blocks,
 * they compress better.
 * However, some LZ4 decoders are only compatible with independent blocks */
lz4 Upstream's avatar
lz4 Upstream committed
130
131
132
typedef enum {
    LZ4F_blockLinked=0,
    LZ4F_blockIndependent
lz4 Upstream's avatar
lz4 Upstream committed
133
134
    LZ4F_OBSOLETE_ENUM(blockLinked)
    LZ4F_OBSOLETE_ENUM(blockIndependent)
lz4 Upstream's avatar
lz4 Upstream committed
135
136
137
138
139
} LZ4F_blockMode_t;

typedef enum {
    LZ4F_noContentChecksum=0,
    LZ4F_contentChecksumEnabled
lz4 Upstream's avatar
lz4 Upstream committed
140
141
    LZ4F_OBSOLETE_ENUM(noContentChecksum)
    LZ4F_OBSOLETE_ENUM(contentChecksumEnabled)
lz4 Upstream's avatar
lz4 Upstream committed
142
143
} LZ4F_contentChecksum_t;

lz4 Upstream's avatar
lz4 Upstream committed
144
145
146
147
148
typedef enum {
    LZ4F_noBlockChecksum=0,
    LZ4F_blockChecksumEnabled
} LZ4F_blockChecksum_t;

lz4 Upstream's avatar
lz4 Upstream committed
149
150
151
typedef enum {
    LZ4F_frame=0,
    LZ4F_skippableFrame
lz4 Upstream's avatar
lz4 Upstream committed
152
    LZ4F_OBSOLETE_ENUM(skippableFrame)
lz4 Upstream's avatar
lz4 Upstream committed
153
154
} LZ4F_frameType_t;

lz4 Upstream's avatar
lz4 Upstream committed
155
#ifdef LZ4F_ENABLE_OBSOLETE_ENUMS
lz4 Upstream's avatar
lz4 Upstream committed
156
157
158
159
160
161
typedef LZ4F_blockSizeID_t blockSizeID_t;
typedef LZ4F_blockMode_t blockMode_t;
typedef LZ4F_frameType_t frameType_t;
typedef LZ4F_contentChecksum_t contentChecksum_t;
#endif

lz4 Upstream's avatar
lz4 Upstream committed
162
163
164
165
/*! LZ4F_frameInfo_t :
 *  makes it possible to set or read frame parameters.
 *  It's not required to set all fields, as long as the structure was initially memset() to zero.
 *  For all fields, 0 sets it to default value */
lz4 Upstream's avatar
lz4 Upstream committed
166
typedef struct {
lz4 Upstream's avatar
lz4 Upstream committed
167
168
169
170
171
172
173
  LZ4F_blockSizeID_t     blockSizeID;          /* max64KB, max256KB, max1MB, max4MB ; 0 == default */
  LZ4F_blockMode_t       blockMode;            /* LZ4F_blockLinked, LZ4F_blockIndependent ; 0 == default */
  LZ4F_contentChecksum_t contentChecksumFlag;  /* if enabled, frame is terminated with a 32-bits checksum of decompressed data ; 0 == disabled (default)  */
  LZ4F_frameType_t       frameType;            /* read-only field : LZ4F_frame or LZ4F_skippableFrame */
  unsigned long long     contentSize;          /* Size of uncompressed content ; 0 == unknown */
  unsigned               dictID;               /* Dictionary ID, sent by the compressor to help decoder select the correct dictionary; 0 == no dictID provided */
  LZ4F_blockChecksum_t   blockChecksumFlag;    /* if enabled, each block is followed by a checksum of block's compressed data ; 0 == disabled (default)  */
lz4 Upstream's avatar
lz4 Upstream committed
174
175
} LZ4F_frameInfo_t;

lz4 Upstream's avatar
lz4 Upstream committed
176
177
178
179
/*! LZ4F_preferences_t :
 *  makes it possible to supply detailed compression parameters to the stream interface.
 *  It's not required to set all fields, as long as the structure was initially memset() to zero.
 *  All reserved fields must be set to zero. */
lz4 Upstream's avatar
lz4 Upstream committed
180
181
typedef struct {
  LZ4F_frameInfo_t frameInfo;
lz4 Upstream's avatar
lz4 Upstream committed
182
183
  int      compressionLevel;       /* 0 == default (fast mode); values above LZ4HC_CLEVEL_MAX count as LZ4HC_CLEVEL_MAX; values below 0 trigger "fast acceleration", proportional to value */
  unsigned autoFlush;              /* 1 == always flush, to reduce usage of internal buffers */
lz4 Upstream's avatar
lz4 Upstream committed
184
185
186
  unsigned reserved[4];            /* must be zero for forward compatibility */
} LZ4F_preferences_t;

lz4 Upstream's avatar
lz4 Upstream committed
187
LZ4FLIB_API int LZ4F_compressionLevel_max(void);
lz4 Upstream's avatar
lz4 Upstream committed
188
189


lz4 Upstream's avatar
lz4 Upstream committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*-*********************************
*  Simple compression function
***********************************/
/*! LZ4F_compressFrameBound() :
 *  Returns the maximum possible size of a frame compressed with LZ4F_compressFrame() given srcSize content and preferences.
 *  Note : this result is only usable with LZ4F_compressFrame(), not with multi-segments compression.
 */
LZ4FLIB_API size_t LZ4F_compressFrameBound(size_t srcSize, const LZ4F_preferences_t* preferencesPtr);

/*! LZ4F_compressFrame() :
 *  Compress an entire srcBuffer into a valid LZ4 frame.
 *  dstCapacity MUST be >= LZ4F_compressFrameBound(srcSize, preferencesPtr).
 *  The LZ4F_preferences_t structure is optional : you can provide NULL as argument. All preferences will be set to default.
 * @return : number of bytes written into dstBuffer.
 *           or an error code if it fails (can be tested using LZ4F_isError())
 */
LZ4FLIB_API size_t LZ4F_compressFrame(void* dstBuffer, size_t dstCapacity,
                                const void* srcBuffer, size_t srcSize,
                                const LZ4F_preferences_t* preferencesPtr);
lz4 Upstream's avatar
lz4 Upstream committed
209
210


lz4 Upstream's avatar
lz4 Upstream committed
211
/*-***********************************
lz4 Upstream's avatar
lz4 Upstream committed
212
*  Advanced compression functions
lz4 Upstream's avatar
lz4 Upstream committed
213
214
215
*************************************/
typedef struct LZ4F_cctx_s LZ4F_cctx;   /* incomplete type */
typedef LZ4F_cctx* LZ4F_compressionContext_t;   /* for compatibility with previous API version */
lz4 Upstream's avatar
lz4 Upstream committed
216
217

typedef struct {
lz4 Upstream's avatar
lz4 Upstream committed
218
  unsigned stableSrc;    /* 1 == src content will remain present on future calls to LZ4F_compress(); skip copying src content within tmp buffer */
lz4 Upstream's avatar
lz4 Upstream committed
219
220
221
  unsigned reserved[3];
} LZ4F_compressOptions_t;

lz4 Upstream's avatar
lz4 Upstream committed
222
/*---   Resource Management   ---*/
lz4 Upstream's avatar
lz4 Upstream committed
223
224

#define LZ4F_VERSION 100
lz4 Upstream's avatar
lz4 Upstream committed
225
226
LZ4FLIB_API unsigned LZ4F_getVersion(void);
/*! LZ4F_createCompressionContext() :
lz4 Upstream's avatar
lz4 Upstream committed
227
 * The first thing to do is to create a compressionContext object, which will be used in all compression operations.
lz4 Upstream's avatar
lz4 Upstream committed
228
229
230
231
 * This is achieved using LZ4F_createCompressionContext(), which takes as argument a version.
 * The version provided MUST be LZ4F_VERSION. It is intended to track potential version mismatch, notably when using DLL.
 * The function will provide a pointer to a fully allocated LZ4F_cctx object.
 * If @return != zero, there was an error during context creation.
lz4 Upstream's avatar
lz4 Upstream committed
232
233
 * Object can release its memory using LZ4F_freeCompressionContext();
 */
lz4 Upstream's avatar
lz4 Upstream committed
234
235
LZ4FLIB_API LZ4F_errorCode_t LZ4F_createCompressionContext(LZ4F_cctx** cctxPtr, unsigned version);
LZ4FLIB_API LZ4F_errorCode_t LZ4F_freeCompressionContext(LZ4F_cctx* cctx);
lz4 Upstream's avatar
lz4 Upstream committed
236
237


lz4 Upstream's avatar
lz4 Upstream committed
238
/*----    Compression    ----*/
lz4 Upstream's avatar
lz4 Upstream committed
239

lz4 Upstream's avatar
lz4 Upstream committed
240
241
242
243
244
245
246
#define LZ4F_HEADER_SIZE_MAX 19
/*! LZ4F_compressBegin() :
 *  will write the frame header into dstBuffer.
 *  dstCapacity must be >= LZ4F_HEADER_SIZE_MAX bytes.
 * `prefsPtr` is optional : you can provide NULL as argument, all preferences will then be set to default.
 * @return : number of bytes written into dstBuffer for the header
 *           or an error code (which can be tested using LZ4F_isError())
lz4 Upstream's avatar
lz4 Upstream committed
247
 */
lz4 Upstream's avatar
lz4 Upstream committed
248
249
250
251
252
253
254
255
256
LZ4FLIB_API size_t LZ4F_compressBegin(LZ4F_cctx* cctx,
                                      void* dstBuffer, size_t dstCapacity,
                                      const LZ4F_preferences_t* prefsPtr);

/*! LZ4F_compressBound() :
 * Provides dstCapacity given a srcSize to guarantee operation success in worst case situations.
 * prefsPtr is optional : you can provide NULL as argument, preferences will be set to cover worst case scenario.
 * Result is always the same for a srcSize and prefsPtr, so it can be trusted to size reusable buffers.
 * When srcSize==0, LZ4F_compressBound() provides an upper bound for LZ4F_flush() and LZ4F_compressEnd() operations.
lz4 Upstream's avatar
lz4 Upstream committed
257
 */
lz4 Upstream's avatar
lz4 Upstream committed
258
LZ4FLIB_API size_t LZ4F_compressBound(size_t srcSize, const LZ4F_preferences_t* prefsPtr);
lz4 Upstream's avatar
lz4 Upstream committed
259

lz4 Upstream's avatar
lz4 Upstream committed
260
/*! LZ4F_compressUpdate() :
lz4 Upstream's avatar
lz4 Upstream committed
261
 * LZ4F_compressUpdate() can be called repetitively to compress as much data as necessary.
lz4 Upstream's avatar
lz4 Upstream committed
262
263
 * An important rule is that dstCapacity MUST be large enough to ensure operation success even in worst case situations.
 * This value is provided by LZ4F_compressBound().
lz4 Upstream's avatar
lz4 Upstream committed
264
 * If this condition is not respected, LZ4F_compress() will fail (result is an errorCode).
lz4 Upstream's avatar
lz4 Upstream committed
265
266
267
268
 * LZ4F_compressUpdate() doesn't guarantee error recovery. When an error occurs, compression context must be freed or resized.
 * `cOptPtr` is optional : NULL can be provided, in which case all options are set to default.
 * @return : number of bytes written into `dstBuffer` (it can be zero, meaning input data was just buffered).
 *           or an error code if it fails (which can be tested using LZ4F_isError())
lz4 Upstream's avatar
lz4 Upstream committed
269
 */
lz4 Upstream's avatar
lz4 Upstream committed
270
271
272
273
274
275
276
277
278
LZ4FLIB_API size_t LZ4F_compressUpdate(LZ4F_cctx* cctx, void* dstBuffer, size_t dstCapacity, const void* srcBuffer, size_t srcSize, const LZ4F_compressOptions_t* cOptPtr);

/*! LZ4F_flush() :
 * When data must be generated and sent immediately, without waiting for a block to be completely filled,
 * it's possible to call LZ4_flush(). It will immediately compress any data buffered within cctx.
 * `dstCapacity` must be large enough to ensure the operation will be successful.
 * `cOptPtr` is optional : it's possible to provide NULL, all options will be set to default.
 * @return : number of bytes written into dstBuffer (it can be zero, which means there was no data stored within cctx)
 *           or an error code if it fails (which can be tested using LZ4F_isError())
lz4 Upstream's avatar
lz4 Upstream committed
279
 */
lz4 Upstream's avatar
lz4 Upstream committed
280
281
282
283
284
285
286
287
288
289
LZ4FLIB_API size_t LZ4F_flush(LZ4F_cctx* cctx, void* dstBuffer, size_t dstCapacity, const LZ4F_compressOptions_t* cOptPtr);

/*! LZ4F_compressEnd() :
 *  To properly finish an LZ4 frame, invoke LZ4F_compressEnd().
 *  It will flush whatever data remained within `cctx` (like LZ4_flush())
 *  and properly finalize the frame, with an endMark and a checksum.
 * `cOptPtr` is optional : NULL can be provided, in which case all options will be set to default.
 * @return : number of bytes written into dstBuffer (necessarily >= 4 (endMark), or 8 if optional frame checksum is enabled)
 *           or an error code if it fails (which can be tested using LZ4F_isError())
 *  A successful call to LZ4F_compressEnd() makes `cctx` available again for another compression task.
lz4 Upstream's avatar
lz4 Upstream committed
290
 */
lz4 Upstream's avatar
lz4 Upstream committed
291
LZ4FLIB_API size_t LZ4F_compressEnd(LZ4F_cctx* cctx, void* dstBuffer, size_t dstCapacity, const LZ4F_compressOptions_t* cOptPtr);
lz4 Upstream's avatar
lz4 Upstream committed
292
293


lz4 Upstream's avatar
lz4 Upstream committed
294
/*-*********************************
lz4 Upstream's avatar
lz4 Upstream committed
295
296
*  Decompression functions
***********************************/
lz4 Upstream's avatar
lz4 Upstream committed
297
298
typedef struct LZ4F_dctx_s LZ4F_dctx;   /* incomplete type */
typedef LZ4F_dctx* LZ4F_decompressionContext_t;   /* compatibility with previous API versions */
lz4 Upstream's avatar
lz4 Upstream committed
299
300

typedef struct {
lz4 Upstream's avatar
lz4 Upstream committed
301
302
  unsigned stableDst;    /* pledge that at least 64KB+64Bytes of previously decompressed data remain unmodifed where it was decoded. This optimization skips storage operations in tmp buffers */
  unsigned reserved[3];  /* must be set to zero for forward compatibility */
lz4 Upstream's avatar
lz4 Upstream committed
303
304
305
306
307
} LZ4F_decompressOptions_t;


/* Resource management */

lz4 Upstream's avatar
lz4 Upstream committed
308
309
310
311
/*!LZ4F_createDecompressionContext() :
 * Create an LZ4F_dctx object, to track all decompression operations.
 * The version provided MUST be LZ4F_VERSION.
 * The function provides a pointer to an allocated and initialized LZ4F_dctx object.
lz4 Upstream's avatar
lz4 Upstream committed
312
313
314
315
316
 * The result is an errorCode, which can be tested using LZ4F_isError().
 * dctx memory can be released using LZ4F_freeDecompressionContext();
 * The result of LZ4F_freeDecompressionContext() is indicative of the current state of decompressionContext when being released.
 * That is, it should be == 0 if decompression has been completed fully and correctly.
 */
lz4 Upstream's avatar
lz4 Upstream committed
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
LZ4FLIB_API LZ4F_errorCode_t LZ4F_createDecompressionContext(LZ4F_dctx** dctxPtr, unsigned version);
LZ4FLIB_API LZ4F_errorCode_t LZ4F_freeDecompressionContext(LZ4F_dctx* dctx);


/*-***********************************
*  Streaming decompression functions
*************************************/

/*! LZ4F_getFrameInfo() :
 *  This function extracts frame parameters (max blockSize, dictID, etc.).
 *  Its usage is optional.
 *  Extracted information is typically useful for allocation and dictionary.
 *  This function works in 2 situations :
 *   - At the beginning of a new frame, in which case
 *     it will decode information from `srcBuffer`, starting the decoding process.
 *     Input size must be large enough to successfully decode the entire frame header.
 *     Frame header size is variable, but is guaranteed to be <= LZ4F_HEADER_SIZE_MAX bytes.
 *     It's allowed to provide more input data than this minimum.
 *   - After decoding has been started.
 *     In which case, no input is read, frame parameters are extracted from dctx.
 *   - If decoding has barely started, but not yet extracted information from header,
 *     LZ4F_getFrameInfo() will fail.
 *  The number of bytes consumed from srcBuffer will be updated within *srcSizePtr (necessarily <= original value).
 *  Decompression must resume from (srcBuffer + *srcSizePtr).
 * @return : an hint about how many srcSize bytes LZ4F_decompress() expects for next call,
 *           or an error code which can be tested using LZ4F_isError().
 *  note 1 : in case of error, dctx is not modified. Decoding operation can resume from beginning safely.
 *  note 2 : frame parameters are *copied into* an already allocated LZ4F_frameInfo_t structure.
lz4 Upstream's avatar
lz4 Upstream committed
345
 */
lz4 Upstream's avatar
lz4 Upstream committed
346
347
348
LZ4FLIB_API size_t LZ4F_getFrameInfo(LZ4F_dctx* dctx,
                                     LZ4F_frameInfo_t* frameInfoPtr,
                                     const void* srcBuffer, size_t* srcSizePtr);
lz4 Upstream's avatar
lz4 Upstream committed
349

lz4 Upstream's avatar
lz4 Upstream committed
350
351
352
/*! LZ4F_decompress() :
 *  Call this function repetitively to regenerate compressed data from `srcBuffer`.
 *  The function will attempt to decode up to *srcSizePtr bytes from srcBuffer, into dstBuffer of capacity *dstSizePtr.
lz4 Upstream's avatar
lz4 Upstream committed
353
 *
lz4 Upstream's avatar
lz4 Upstream committed
354
 *  The number of bytes regenerated into dstBuffer is provided within *dstSizePtr (necessarily <= original value).
lz4 Upstream's avatar
lz4 Upstream committed
355
 *
lz4 Upstream's avatar
lz4 Upstream committed
356
357
358
359
 *  The number of bytes consumed from srcBuffer is provided within *srcSizePtr (necessarily <= original value).
 *  Number of bytes consumed can be < number of bytes provided.
 *  It typically happens when dstBuffer is not large enough to contain all decoded data.
 *  Unconsumed source data must be presented again in subsequent invocations.
lz4 Upstream's avatar
lz4 Upstream committed
360
 *
lz4 Upstream's avatar
lz4 Upstream committed
361
362
 * `dstBuffer` content is expected to be flushed between each invocation, as its content will be overwritten.
 * `dstBuffer` itself can be changed at will between each consecutive function invocation.
lz4 Upstream's avatar
lz4 Upstream committed
363
 *
lz4 Upstream's avatar
lz4 Upstream committed
364
365
366
367
368
369
 * @return : an hint of how many `srcSize` bytes LZ4F_decompress() expects for next call.
 *  Schematically, it's the size of the current (or remaining) compressed block + header of next block.
 *  Respecting the hint provides some small speed benefit, because it skips intermediate buffers.
 *  This is just a hint though, it's always possible to provide any srcSize.
 *  When a frame is fully decoded, @return will be 0 (no more data expected).
 *  If decompression failed, @return is an error code, which can be tested using LZ4F_isError().
lz4 Upstream's avatar
lz4 Upstream committed
370
 *
lz4 Upstream's avatar
lz4 Upstream committed
371
372
 *  After a frame is fully decoded, dctx can be used again to decompress another frame.
 *  After a decompression error, use LZ4F_resetDecompressionContext() before re-using dctx, to return to clean state.
lz4 Upstream's avatar
lz4 Upstream committed
373
 */
lz4 Upstream's avatar
lz4 Upstream committed
374
375
376
377
378
379
380
381
382
383
384
385
386
LZ4FLIB_API size_t LZ4F_decompress(LZ4F_dctx* dctx,
                                   void* dstBuffer, size_t* dstSizePtr,
                                   const void* srcBuffer, size_t* srcSizePtr,
                                   const LZ4F_decompressOptions_t* dOptPtr);


/*! LZ4F_resetDecompressionContext() : v1.8.0
 *  In case of an error, the context is left in "undefined" state.
 *  In which case, it's necessary to reset it, before re-using it.
 *  This method can also be used to abruptly stop an unfinished decompression,
 *  and start a new one using the same context. */
LZ4FLIB_API void LZ4F_resetDecompressionContext(LZ4F_dctx* dctx);   /* always successful */

lz4 Upstream's avatar
lz4 Upstream committed
387
388
389
390
391


#if defined (__cplusplus)
}
#endif
lz4 Upstream's avatar
lz4 Upstream committed
392
393

#endif  /* LZ4F_H_09782039843 */