extlz4 0.2.5 → 0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -32,10 +32,14 @@
32
32
  - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c
33
33
  */
34
34
 
35
- /* LZ4F is a stand-alone API to create LZ4-compressed frames
36
- * conformant with specification v1.5.1.
37
- * It also offers streaming capabilities.
38
- * lz4.h is not required when using lz4frame.h.
35
+ /* LZ4F is a stand-alone API able to create and decode LZ4 frames
36
+ * conformant with specification v1.6.1 in doc/lz4_Frame_format.md .
37
+ * Generated frames are compatible with `lz4` CLI.
38
+ *
39
+ * LZ4F also offers streaming capabilities.
40
+ *
41
+ * lz4.h is not required when using lz4frame.h,
42
+ * except to extract common constant such as LZ4_VERSION_NUMBER.
39
43
  * */
40
44
 
41
45
  #ifndef LZ4F_H_09782039843
@@ -93,8 +97,8 @@ extern "C" {
93
97
  **************************************/
94
98
  typedef size_t LZ4F_errorCode_t;
95
99
 
96
- LZ4FLIB_API unsigned LZ4F_isError(LZ4F_errorCode_t code); /**< tells if a `LZ4F_errorCode_t` function result is an error code */
97
- LZ4FLIB_API const char* LZ4F_getErrorName(LZ4F_errorCode_t code); /**< return error code string; useful for debugging */
100
+ LZ4FLIB_API unsigned LZ4F_isError(LZ4F_errorCode_t code); /**< tells when a function result is an error code */
101
+ LZ4FLIB_API const char* LZ4F_getErrorName(LZ4F_errorCode_t code); /**< return error code string; for debugging */
98
102
 
99
103
 
100
104
  /*-************************************
@@ -159,38 +163,48 @@ typedef LZ4F_contentChecksum_t contentChecksum_t;
159
163
 
160
164
  /*! LZ4F_frameInfo_t :
161
165
  * makes it possible to set or read frame parameters.
162
- * It's not required to set all fields, as long as the structure was initially memset() to zero.
163
- * For all fields, 0 sets it to default value */
166
+ * Structure must be first init to 0, using memset() or LZ4F_INIT_FRAMEINFO,
167
+ * setting all parameters to default.
168
+ * It's then possible to update selectively some parameters */
164
169
  typedef struct {
165
- LZ4F_blockSizeID_t blockSizeID; /* max64KB, max256KB, max1MB, max4MB ; 0 == default */
166
- LZ4F_blockMode_t blockMode; /* LZ4F_blockLinked, LZ4F_blockIndependent ; 0 == default */
167
- LZ4F_contentChecksum_t contentChecksumFlag; /* if enabled, frame is terminated with a 32-bits checksum of decompressed data ; 0 == disabled (default) */
168
- LZ4F_frameType_t frameType; /* read-only field : LZ4F_frame or LZ4F_skippableFrame */
169
- unsigned long long contentSize; /* Size of uncompressed content ; 0 == unknown */
170
- unsigned dictID; /* Dictionary ID, sent by the compressor to help decoder select the correct dictionary; 0 == no dictID provided */
171
- LZ4F_blockChecksum_t blockChecksumFlag; /* if enabled, each block is followed by a checksum of block's compressed data ; 0 == disabled (default) */
170
+ LZ4F_blockSizeID_t blockSizeID; /* max64KB, max256KB, max1MB, max4MB; 0 == default */
171
+ LZ4F_blockMode_t blockMode; /* LZ4F_blockLinked, LZ4F_blockIndependent; 0 == default */
172
+ LZ4F_contentChecksum_t contentChecksumFlag; /* 1: frame terminated with 32-bit checksum of decompressed data; 0: disabled (default) */
173
+ LZ4F_frameType_t frameType; /* read-only field : LZ4F_frame or LZ4F_skippableFrame */
174
+ unsigned long long contentSize; /* Size of uncompressed content ; 0 == unknown */
175
+ unsigned dictID; /* Dictionary ID, sent by compressor to help decoder select correct dictionary; 0 == no dictID provided */
176
+ LZ4F_blockChecksum_t blockChecksumFlag; /* 1: each block followed by a checksum of block's compressed data; 0: disabled (default) */
172
177
  } LZ4F_frameInfo_t;
173
178
 
179
+ #define LZ4F_INIT_FRAMEINFO { 0, 0, 0, 0, 0, 0, 0 } /* v1.8.3+ */
180
+
174
181
  /*! LZ4F_preferences_t :
175
- * makes it possible to supply detailed compression parameters to the stream interface.
176
- * It's not required to set all fields, as long as the structure was initially memset() to zero.
182
+ * makes it possible to supply advanced compression instructions to streaming interface.
183
+ * Structure must be first init to 0, using memset() or LZ4F_INIT_PREFERENCES,
184
+ * setting all parameters to default.
177
185
  * All reserved fields must be set to zero. */
178
186
  typedef struct {
179
187
  LZ4F_frameInfo_t frameInfo;
180
- 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 */
181
- unsigned autoFlush; /* 1 == always flush, to reduce usage of internal buffers */
182
- unsigned reserved[4]; /* must be zero for forward compatibility */
188
+ int compressionLevel; /* 0: default (fast mode); values > LZ4HC_CLEVEL_MAX count as LZ4HC_CLEVEL_MAX; values < 0 trigger "fast acceleration" */
189
+ unsigned autoFlush; /* 1: always flush; reduces usage of internal buffers */
190
+ unsigned favorDecSpeed; /* 1: parser favors decompression speed vs compression ratio. Only works for high compression modes (>= LZ4HC_CLEVEL_OPT_MIN) */ /* v1.8.2+ */
191
+ unsigned reserved[3]; /* must be zero for forward compatibility */
183
192
  } LZ4F_preferences_t;
184
193
 
185
- LZ4FLIB_API int LZ4F_compressionLevel_max(void);
194
+ #define LZ4F_INIT_PREFERENCES { LZ4F_INIT_FRAMEINFO, 0, 0, 0, { 0, 0, 0 } } /* v1.8.3+ */
186
195
 
187
196
 
188
197
  /*-*********************************
189
198
  * Simple compression function
190
199
  ***********************************/
200
+
201
+ LZ4FLIB_API int LZ4F_compressionLevel_max(void); /* v1.8.0+ */
202
+
191
203
  /*! LZ4F_compressFrameBound() :
192
- * Returns the maximum possible size of a frame compressed with LZ4F_compressFrame() given srcSize content and preferences.
193
- * Note : this result is only usable with LZ4F_compressFrame(), not with multi-segments compression.
204
+ * Returns the maximum possible compressed size with LZ4F_compressFrame() given srcSize and preferences.
205
+ * `preferencesPtr` is optional. It can be replaced by NULL, in which case, the function will assume default preferences.
206
+ * Note : this result is only usable with LZ4F_compressFrame().
207
+ * It may also be used with LZ4F_compressUpdate() _if no flush() operation_ is performed.
194
208
  */
195
209
  LZ4FLIB_API size_t LZ4F_compressFrameBound(size_t srcSize, const LZ4F_preferences_t* preferencesPtr);
196
210
 
@@ -219,8 +233,9 @@ typedef struct {
219
233
 
220
234
  /*--- Resource Management ---*/
221
235
 
222
- #define LZ4F_VERSION 100
236
+ #define LZ4F_VERSION 100 /* This number can be used to check for an incompatible API breaking change */
223
237
  LZ4FLIB_API unsigned LZ4F_getVersion(void);
238
+
224
239
  /*! LZ4F_createCompressionContext() :
225
240
  * The first thing to do is to create a compressionContext object, which will be used in all compression operations.
226
241
  * This is achieved using LZ4F_createCompressionContext(), which takes as argument a version.
@@ -235,7 +250,9 @@ LZ4FLIB_API LZ4F_errorCode_t LZ4F_freeCompressionContext(LZ4F_cctx* cctx);
235
250
 
236
251
  /*---- Compression ----*/
237
252
 
253
+ #define LZ4F_HEADER_SIZE_MIN 7 /* LZ4 Frame header size can vary, depending on selected paramaters */
238
254
  #define LZ4F_HEADER_SIZE_MAX 19
255
+
239
256
  /*! LZ4F_compressBegin() :
240
257
  * will write the frame header into dstBuffer.
241
258
  * dstCapacity must be >= LZ4F_HEADER_SIZE_MAX bytes.
@@ -248,45 +265,64 @@ LZ4FLIB_API size_t LZ4F_compressBegin(LZ4F_cctx* cctx,
248
265
  const LZ4F_preferences_t* prefsPtr);
249
266
 
250
267
  /*! LZ4F_compressBound() :
251
- * Provides dstCapacity given a srcSize to guarantee operation success in worst case situations.
252
- * prefsPtr is optional : you can provide NULL as argument, preferences will be set to cover worst case scenario.
253
- * Result is always the same for a srcSize and prefsPtr, so it can be trusted to size reusable buffers.
254
- * When srcSize==0, LZ4F_compressBound() provides an upper bound for LZ4F_flush() and LZ4F_compressEnd() operations.
268
+ * Provides minimum dstCapacity required to guarantee success of
269
+ * LZ4F_compressUpdate(), given a srcSize and preferences, for a worst case scenario.
270
+ * When srcSize==0, LZ4F_compressBound() provides an upper bound for LZ4F_flush() and LZ4F_compressEnd() instead.
271
+ * Note that the result is only valid for a single invocation of LZ4F_compressUpdate().
272
+ * When invoking LZ4F_compressUpdate() multiple times,
273
+ * if the output buffer is gradually filled up instead of emptied and re-used from its start,
274
+ * one must check if there is enough remaining capacity before each invocation, using LZ4F_compressBound().
275
+ * @return is always the same for a srcSize and prefsPtr.
276
+ * prefsPtr is optional : when NULL is provided, preferences will be set to cover worst case scenario.
277
+ * tech details :
278
+ * @return includes the possibility that internal buffer might already be filled by up to (blockSize-1) bytes.
279
+ * It also includes frame footer (ending + checksum), since it might be generated by LZ4F_compressEnd().
280
+ * @return doesn't include frame header, as it was already generated by LZ4F_compressBegin().
255
281
  */
256
282
  LZ4FLIB_API size_t LZ4F_compressBound(size_t srcSize, const LZ4F_preferences_t* prefsPtr);
257
283
 
258
284
  /*! LZ4F_compressUpdate() :
259
- * LZ4F_compressUpdate() can be called repetitively to compress as much data as necessary.
260
- * An important rule is that dstCapacity MUST be large enough to ensure operation success even in worst case situations.
261
- * This value is provided by LZ4F_compressBound().
262
- * If this condition is not respected, LZ4F_compress() will fail (result is an errorCode).
263
- * LZ4F_compressUpdate() doesn't guarantee error recovery. When an error occurs, compression context must be freed or resized.
285
+ * LZ4F_compressUpdate() can be called repetitively to compress as much data as necessary.
286
+ * Important rule: dstCapacity MUST be large enough to ensure operation success even in worst case situations.
287
+ * This value is provided by LZ4F_compressBound().
288
+ * If this condition is not respected, LZ4F_compress() will fail (result is an errorCode).
289
+ * LZ4F_compressUpdate() doesn't guarantee error recovery.
290
+ * When an error occurs, compression context must be freed or resized.
264
291
  * `cOptPtr` is optional : NULL can be provided, in which case all options are set to default.
265
292
  * @return : number of bytes written into `dstBuffer` (it can be zero, meaning input data was just buffered).
266
293
  * or an error code if it fails (which can be tested using LZ4F_isError())
267
294
  */
268
- 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);
295
+ LZ4FLIB_API size_t LZ4F_compressUpdate(LZ4F_cctx* cctx,
296
+ void* dstBuffer, size_t dstCapacity,
297
+ const void* srcBuffer, size_t srcSize,
298
+ const LZ4F_compressOptions_t* cOptPtr);
269
299
 
270
300
  /*! LZ4F_flush() :
271
- * When data must be generated and sent immediately, without waiting for a block to be completely filled,
272
- * it's possible to call LZ4_flush(). It will immediately compress any data buffered within cctx.
301
+ * When data must be generated and sent immediately, without waiting for a block to be completely filled,
302
+ * it's possible to call LZ4_flush(). It will immediately compress any data buffered within cctx.
273
303
  * `dstCapacity` must be large enough to ensure the operation will be successful.
274
304
  * `cOptPtr` is optional : it's possible to provide NULL, all options will be set to default.
275
- * @return : number of bytes written into dstBuffer (it can be zero, which means there was no data stored within cctx)
305
+ * @return : nb of bytes written into dstBuffer (can be zero, when there is no data stored within cctx)
276
306
  * or an error code if it fails (which can be tested using LZ4F_isError())
307
+ * Note : LZ4F_flush() is guaranteed to be successful when dstCapacity >= LZ4F_compressBound(0, prefsPtr).
277
308
  */
278
- LZ4FLIB_API size_t LZ4F_flush(LZ4F_cctx* cctx, void* dstBuffer, size_t dstCapacity, const LZ4F_compressOptions_t* cOptPtr);
309
+ LZ4FLIB_API size_t LZ4F_flush(LZ4F_cctx* cctx,
310
+ void* dstBuffer, size_t dstCapacity,
311
+ const LZ4F_compressOptions_t* cOptPtr);
279
312
 
280
313
  /*! LZ4F_compressEnd() :
281
314
  * To properly finish an LZ4 frame, invoke LZ4F_compressEnd().
282
315
  * It will flush whatever data remained within `cctx` (like LZ4_flush())
283
316
  * and properly finalize the frame, with an endMark and a checksum.
284
317
  * `cOptPtr` is optional : NULL can be provided, in which case all options will be set to default.
285
- * @return : number of bytes written into dstBuffer (necessarily >= 4 (endMark), or 8 if optional frame checksum is enabled)
318
+ * @return : nb of bytes written into dstBuffer, necessarily >= 4 (endMark),
286
319
  * or an error code if it fails (which can be tested using LZ4F_isError())
320
+ * Note : LZ4F_compressEnd() is guaranteed to be successful when dstCapacity >= LZ4F_compressBound(0, prefsPtr).
287
321
  * A successful call to LZ4F_compressEnd() makes `cctx` available again for another compression task.
288
322
  */
289
- LZ4FLIB_API size_t LZ4F_compressEnd(LZ4F_cctx* cctx, void* dstBuffer, size_t dstCapacity, const LZ4F_compressOptions_t* cOptPtr);
323
+ LZ4FLIB_API size_t LZ4F_compressEnd(LZ4F_cctx* cctx,
324
+ void* dstBuffer, size_t dstCapacity,
325
+ const LZ4F_compressOptions_t* cOptPtr);
290
326
 
291
327
 
292
328
  /*-*********************************
@@ -296,21 +332,21 @@ typedef struct LZ4F_dctx_s LZ4F_dctx; /* incomplete type */
296
332
  typedef LZ4F_dctx* LZ4F_decompressionContext_t; /* compatibility with previous API versions */
297
333
 
298
334
  typedef struct {
299
- 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 */
335
+ unsigned stableDst; /* pledges that last 64KB decompressed data will remain available unmodified. This optimization skips storage operations in tmp buffers. */
300
336
  unsigned reserved[3]; /* must be set to zero for forward compatibility */
301
337
  } LZ4F_decompressOptions_t;
302
338
 
303
339
 
304
340
  /* Resource management */
305
341
 
306
- /*!LZ4F_createDecompressionContext() :
307
- * Create an LZ4F_dctx object, to track all decompression operations.
308
- * The version provided MUST be LZ4F_VERSION.
309
- * The function provides a pointer to an allocated and initialized LZ4F_dctx object.
310
- * The result is an errorCode, which can be tested using LZ4F_isError().
311
- * dctx memory can be released using LZ4F_freeDecompressionContext();
312
- * The result of LZ4F_freeDecompressionContext() is indicative of the current state of decompressionContext when being released.
313
- * That is, it should be == 0 if decompression has been completed fully and correctly.
342
+ /*! LZ4F_createDecompressionContext() :
343
+ * Create an LZ4F_dctx object, to track all decompression operations.
344
+ * The version provided MUST be LZ4F_VERSION.
345
+ * The function provides a pointer to an allocated and initialized LZ4F_dctx object.
346
+ * The result is an errorCode, which can be tested using LZ4F_isError().
347
+ * dctx memory can be released using LZ4F_freeDecompressionContext();
348
+ * Result of LZ4F_freeDecompressionContext() indicates current state of decompressionContext when being released.
349
+ * That is, it should be == 0 if decompression has been completed fully and correctly.
314
350
  */
315
351
  LZ4FLIB_API LZ4F_errorCode_t LZ4F_createDecompressionContext(LZ4F_dctx** dctxPtr, unsigned version);
316
352
  LZ4FLIB_API LZ4F_errorCode_t LZ4F_freeDecompressionContext(LZ4F_dctx* dctx);
@@ -320,23 +356,58 @@ LZ4FLIB_API LZ4F_errorCode_t LZ4F_freeDecompressionContext(LZ4F_dctx* dctx);
320
356
  * Streaming decompression functions
321
357
  *************************************/
322
358
 
359
+ #define LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH 5
360
+
361
+ /*! LZ4F_headerSize() : v1.9.0+
362
+ * Provide the header size of a frame starting at `src`.
363
+ * `srcSize` must be >= LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH,
364
+ * which is enough to decode the header length.
365
+ * @return : size of frame header
366
+ * or an error code, which can be tested using LZ4F_isError()
367
+ * note : Frame header size is variable, but is guaranteed to be
368
+ * >= LZ4F_HEADER_SIZE_MIN bytes, and <= LZ4F_HEADER_SIZE_MAX bytes.
369
+ */
370
+ size_t LZ4F_headerSize(const void* src, size_t srcSize);
371
+
323
372
  /*! LZ4F_getFrameInfo() :
324
373
  * This function extracts frame parameters (max blockSize, dictID, etc.).
325
- * Its usage is optional.
326
- * Extracted information is typically useful for allocation and dictionary.
327
- * This function works in 2 situations :
328
- * - At the beginning of a new frame, in which case
329
- * it will decode information from `srcBuffer`, starting the decoding process.
330
- * Input size must be large enough to successfully decode the entire frame header.
331
- * Frame header size is variable, but is guaranteed to be <= LZ4F_HEADER_SIZE_MAX bytes.
332
- * It's allowed to provide more input data than this minimum.
333
- * - After decoding has been started.
334
- * In which case, no input is read, frame parameters are extracted from dctx.
335
- * - If decoding has barely started, but not yet extracted information from header,
374
+ * Its usage is optional: user can call LZ4F_decompress() directly.
375
+ *
376
+ * Extracted information will fill an existing LZ4F_frameInfo_t structure.
377
+ * This can be useful for allocation and dictionary identification purposes.
378
+ *
379
+ * LZ4F_getFrameInfo() can work in the following situations :
380
+ *
381
+ * 1) At the beginning of a new frame, before any invocation of LZ4F_decompress().
382
+ * It will decode header from `srcBuffer`,
383
+ * consuming the header and starting the decoding process.
384
+ *
385
+ * Input size must be large enough to contain the full frame header.
386
+ * Frame header size can be known beforehand by LZ4F_headerSize().
387
+ * Frame header size is variable, but is guaranteed to be >= LZ4F_HEADER_SIZE_MIN bytes,
388
+ * and not more than <= LZ4F_HEADER_SIZE_MAX bytes.
389
+ * Hence, blindly providing LZ4F_HEADER_SIZE_MAX bytes or more will always work.
390
+ * It's allowed to provide more input data than the header size,
391
+ * LZ4F_getFrameInfo() will only consume the header.
392
+ *
393
+ * If input size is not large enough,
394
+ * aka if it's smaller than header size,
395
+ * function will fail and return an error code.
396
+ *
397
+ * 2) After decoding has been started,
398
+ * it's possible to invoke LZ4F_getFrameInfo() anytime
399
+ * to extract already decoded frame parameters stored within dctx.
400
+ *
401
+ * Note that, if decoding has barely started,
402
+ * and not yet read enough information to decode the header,
336
403
  * LZ4F_getFrameInfo() will fail.
337
- * The number of bytes consumed from srcBuffer will be updated within *srcSizePtr (necessarily <= original value).
338
- * Decompression must resume from (srcBuffer + *srcSizePtr).
339
- * @return : an hint about how many srcSize bytes LZ4F_decompress() expects for next call,
404
+ *
405
+ * The number of bytes consumed from srcBuffer will be updated in *srcSizePtr (necessarily <= original value).
406
+ * LZ4F_getFrameInfo() only consumes bytes when decoding has not yet started,
407
+ * and when decoding the header has been successful.
408
+ * Decompression must then resume from (srcBuffer + *srcSizePtr).
409
+ *
410
+ * @return : a hint about how many srcSize bytes LZ4F_decompress() expects for next call,
340
411
  * or an error code which can be tested using LZ4F_isError().
341
412
  * note 1 : in case of error, dctx is not modified. Decoding operation can resume from beginning safely.
342
413
  * note 2 : frame parameters are *copied into* an already allocated LZ4F_frameInfo_t structure.
@@ -347,27 +418,32 @@ LZ4FLIB_API size_t LZ4F_getFrameInfo(LZ4F_dctx* dctx,
347
418
 
348
419
  /*! LZ4F_decompress() :
349
420
  * Call this function repetitively to regenerate compressed data from `srcBuffer`.
350
- * The function will attempt to decode up to *srcSizePtr bytes from srcBuffer, into dstBuffer of capacity *dstSizePtr.
421
+ * The function will read up to *srcSizePtr bytes from srcBuffer,
422
+ * and decompress data into dstBuffer, of capacity *dstSizePtr.
351
423
  *
352
- * The number of bytes regenerated into dstBuffer is provided within *dstSizePtr (necessarily <= original value).
424
+ * The nb of bytes consumed from srcBuffer will be written into *srcSizePtr (necessarily <= original value).
425
+ * The nb of bytes decompressed into dstBuffer will be written into *dstSizePtr (necessarily <= original value).
353
426
  *
354
- * The number of bytes consumed from srcBuffer is provided within *srcSizePtr (necessarily <= original value).
355
- * Number of bytes consumed can be < number of bytes provided.
356
- * It typically happens when dstBuffer is not large enough to contain all decoded data.
427
+ * The function does not necessarily read all input bytes, so always check value in *srcSizePtr.
357
428
  * Unconsumed source data must be presented again in subsequent invocations.
358
429
  *
359
- * `dstBuffer` content is expected to be flushed between each invocation, as its content will be overwritten.
360
- * `dstBuffer` itself can be changed at will between each consecutive function invocation.
430
+ * `dstBuffer` can freely change between each consecutive function invocation.
431
+ * `dstBuffer` content will be overwritten.
361
432
  *
362
433
  * @return : an hint of how many `srcSize` bytes LZ4F_decompress() expects for next call.
363
434
  * Schematically, it's the size of the current (or remaining) compressed block + header of next block.
364
435
  * Respecting the hint provides some small speed benefit, because it skips intermediate buffers.
365
436
  * This is just a hint though, it's always possible to provide any srcSize.
437
+ *
366
438
  * When a frame is fully decoded, @return will be 0 (no more data expected).
439
+ * When provided with more bytes than necessary to decode a frame,
440
+ * LZ4F_decompress() will stop reading exactly at end of current frame, and @return 0.
441
+ *
367
442
  * If decompression failed, @return is an error code, which can be tested using LZ4F_isError().
443
+ * After a decompression error, the `dctx` context is not resumable.
444
+ * Use LZ4F_resetDecompressionContext() to return to clean state.
368
445
  *
369
446
  * After a frame is fully decoded, dctx can be used again to decompress another frame.
370
- * After a decompression error, use LZ4F_resetDecompressionContext() before re-using dctx, to return to clean state.
371
447
  */
372
448
  LZ4FLIB_API size_t LZ4F_decompress(LZ4F_dctx* dctx,
373
449
  void* dstBuffer, size_t* dstSizePtr,
@@ -375,11 +451,11 @@ LZ4FLIB_API size_t LZ4F_decompress(LZ4F_dctx* dctx,
375
451
  const LZ4F_decompressOptions_t* dOptPtr);
376
452
 
377
453
 
378
- /*! LZ4F_resetDecompressionContext() : v1.8.0
454
+ /*! LZ4F_resetDecompressionContext() : added in v1.8.0
379
455
  * In case of an error, the context is left in "undefined" state.
380
456
  * In which case, it's necessary to reset it, before re-using it.
381
- * This method can also be used to abruptly stop an unfinished decompression,
382
- * and start a new one using the same context. */
457
+ * This method can also be used to abruptly stop any unfinished decompression,
458
+ * and start a new one using same context resources. */
383
459
  LZ4FLIB_API void LZ4F_resetDecompressionContext(LZ4F_dctx* dctx); /* always successful */
384
460
 
385
461
 
@@ -389,3 +465,142 @@ LZ4FLIB_API void LZ4F_resetDecompressionContext(LZ4F_dctx* dctx); /* always su
389
465
  #endif
390
466
 
391
467
  #endif /* LZ4F_H_09782039843 */
468
+
469
+ #if defined(LZ4F_STATIC_LINKING_ONLY) && !defined(LZ4F_H_STATIC_09782039843)
470
+ #define LZ4F_H_STATIC_09782039843
471
+
472
+ #if defined (__cplusplus)
473
+ extern "C" {
474
+ #endif
475
+
476
+ /* These declarations are not stable and may change in the future.
477
+ * They are therefore only safe to depend on
478
+ * when the caller is statically linked against the library.
479
+ * To access their declarations, define LZ4F_STATIC_LINKING_ONLY.
480
+ *
481
+ * By default, these symbols aren't published into shared/dynamic libraries.
482
+ * You can override this behavior and force them to be published
483
+ * by defining LZ4F_PUBLISH_STATIC_FUNCTIONS.
484
+ * Use at your own risk.
485
+ */
486
+ #ifdef LZ4F_PUBLISH_STATIC_FUNCTIONS
487
+ #define LZ4FLIB_STATIC_API LZ4FLIB_API
488
+ #else
489
+ #define LZ4FLIB_STATIC_API
490
+ #endif
491
+
492
+
493
+ /* --- Error List --- */
494
+ #define LZ4F_LIST_ERRORS(ITEM) \
495
+ ITEM(OK_NoError) \
496
+ ITEM(ERROR_GENERIC) \
497
+ ITEM(ERROR_maxBlockSize_invalid) \
498
+ ITEM(ERROR_blockMode_invalid) \
499
+ ITEM(ERROR_contentChecksumFlag_invalid) \
500
+ ITEM(ERROR_compressionLevel_invalid) \
501
+ ITEM(ERROR_headerVersion_wrong) \
502
+ ITEM(ERROR_blockChecksum_invalid) \
503
+ ITEM(ERROR_reservedFlag_set) \
504
+ ITEM(ERROR_allocation_failed) \
505
+ ITEM(ERROR_srcSize_tooLarge) \
506
+ ITEM(ERROR_dstMaxSize_tooSmall) \
507
+ ITEM(ERROR_frameHeader_incomplete) \
508
+ ITEM(ERROR_frameType_unknown) \
509
+ ITEM(ERROR_frameSize_wrong) \
510
+ ITEM(ERROR_srcPtr_wrong) \
511
+ ITEM(ERROR_decompressionFailed) \
512
+ ITEM(ERROR_headerChecksum_invalid) \
513
+ ITEM(ERROR_contentChecksum_invalid) \
514
+ ITEM(ERROR_frameDecoding_alreadyStarted) \
515
+ ITEM(ERROR_maxCode)
516
+
517
+ #define LZ4F_GENERATE_ENUM(ENUM) LZ4F_##ENUM,
518
+
519
+ /* enum list is exposed, to handle specific errors */
520
+ typedef enum { LZ4F_LIST_ERRORS(LZ4F_GENERATE_ENUM)
521
+ _LZ4F_dummy_error_enum_for_c89_never_used } LZ4F_errorCodes;
522
+
523
+ LZ4FLIB_STATIC_API LZ4F_errorCodes LZ4F_getErrorCode(size_t functionResult);
524
+
525
+ LZ4FLIB_STATIC_API size_t LZ4F_getBlockSize(unsigned);
526
+
527
+ /**********************************
528
+ * Bulk processing dictionary API
529
+ *********************************/
530
+
531
+ /* A Dictionary is useful for the compression of small messages (KB range).
532
+ * It dramatically improves compression efficiency.
533
+ *
534
+ * LZ4 can ingest any input as dictionary, though only the last 64 KB are useful.
535
+ * Best results are generally achieved by using Zstandard's Dictionary Builder
536
+ * to generate a high-quality dictionary from a set of samples.
537
+ *
538
+ * Loading a dictionary has a cost, since it involves construction of tables.
539
+ * The Bulk processing dictionary API makes it possible to share this cost
540
+ * over an arbitrary number of compression jobs, even concurrently,
541
+ * markedly improving compression latency for these cases.
542
+ *
543
+ * The same dictionary will have to be used on the decompression side
544
+ * for decoding to be successful.
545
+ * To help identify the correct dictionary at decoding stage,
546
+ * the frame header allows optional embedding of a dictID field.
547
+ */
548
+ typedef struct LZ4F_CDict_s LZ4F_CDict;
549
+
550
+ /*! LZ4_createCDict() :
551
+ * When compressing multiple messages / blocks using the same dictionary, it's recommended to load it just once.
552
+ * LZ4_createCDict() will create a digested dictionary, ready to start future compression operations without startup delay.
553
+ * LZ4_CDict can be created once and shared by multiple threads concurrently, since its usage is read-only.
554
+ * `dictBuffer` can be released after LZ4_CDict creation, since its content is copied within CDict */
555
+ LZ4FLIB_STATIC_API LZ4F_CDict* LZ4F_createCDict(const void* dictBuffer, size_t dictSize);
556
+ LZ4FLIB_STATIC_API void LZ4F_freeCDict(LZ4F_CDict* CDict);
557
+
558
+
559
+ /*! LZ4_compressFrame_usingCDict() :
560
+ * Compress an entire srcBuffer into a valid LZ4 frame using a digested Dictionary.
561
+ * cctx must point to a context created by LZ4F_createCompressionContext().
562
+ * If cdict==NULL, compress without a dictionary.
563
+ * dstBuffer MUST be >= LZ4F_compressFrameBound(srcSize, preferencesPtr).
564
+ * If this condition is not respected, function will fail (@return an errorCode).
565
+ * The LZ4F_preferences_t structure is optional : you may provide NULL as argument,
566
+ * but it's not recommended, as it's the only way to provide dictID in the frame header.
567
+ * @return : number of bytes written into dstBuffer.
568
+ * or an error code if it fails (can be tested using LZ4F_isError()) */
569
+ LZ4FLIB_STATIC_API size_t LZ4F_compressFrame_usingCDict(
570
+ LZ4F_cctx* cctx,
571
+ void* dst, size_t dstCapacity,
572
+ const void* src, size_t srcSize,
573
+ const LZ4F_CDict* cdict,
574
+ const LZ4F_preferences_t* preferencesPtr);
575
+
576
+
577
+ /*! LZ4F_compressBegin_usingCDict() :
578
+ * Inits streaming dictionary compression, and writes the frame header into dstBuffer.
579
+ * dstCapacity must be >= LZ4F_HEADER_SIZE_MAX bytes.
580
+ * `prefsPtr` is optional : you may provide NULL as argument,
581
+ * however, it's the only way to provide dictID in the frame header.
582
+ * @return : number of bytes written into dstBuffer for the header,
583
+ * or an error code (which can be tested using LZ4F_isError()) */
584
+ LZ4FLIB_STATIC_API size_t LZ4F_compressBegin_usingCDict(
585
+ LZ4F_cctx* cctx,
586
+ void* dstBuffer, size_t dstCapacity,
587
+ const LZ4F_CDict* cdict,
588
+ const LZ4F_preferences_t* prefsPtr);
589
+
590
+
591
+ /*! LZ4F_decompress_usingDict() :
592
+ * Same as LZ4F_decompress(), using a predefined dictionary.
593
+ * Dictionary is used "in place", without any preprocessing.
594
+ * It must remain accessible throughout the entire frame decoding. */
595
+ LZ4FLIB_STATIC_API size_t LZ4F_decompress_usingDict(
596
+ LZ4F_dctx* dctxPtr,
597
+ void* dstBuffer, size_t* dstSizePtr,
598
+ const void* srcBuffer, size_t* srcSizePtr,
599
+ const void* dict, size_t dictSize,
600
+ const LZ4F_decompressOptions_t* decompressOptionsPtr);
601
+
602
+ #if defined (__cplusplus)
603
+ }
604
+ #endif
605
+
606
+ #endif /* defined(LZ4F_STATIC_LINKING_ONLY) && !defined(LZ4F_H_STATIC_09782039843) */