extzstd 0.3.2 → 0.3.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (108) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/contrib/zstd/CHANGELOG +188 -1
  4. data/contrib/zstd/CONTRIBUTING.md +157 -74
  5. data/contrib/zstd/LICENSE +4 -4
  6. data/contrib/zstd/Makefile +81 -58
  7. data/contrib/zstd/Package.swift +36 -0
  8. data/contrib/zstd/README.md +59 -35
  9. data/contrib/zstd/TESTING.md +2 -3
  10. data/contrib/zstd/appveyor.yml +49 -136
  11. data/contrib/zstd/lib/BUCK +5 -7
  12. data/contrib/zstd/lib/Makefile +87 -181
  13. data/contrib/zstd/lib/README.md +23 -6
  14. data/contrib/zstd/lib/common/allocations.h +55 -0
  15. data/contrib/zstd/lib/common/bits.h +200 -0
  16. data/contrib/zstd/lib/common/bitstream.h +33 -59
  17. data/contrib/zstd/lib/common/compiler.h +115 -45
  18. data/contrib/zstd/lib/common/cpu.h +1 -1
  19. data/contrib/zstd/lib/common/debug.c +1 -1
  20. data/contrib/zstd/lib/common/debug.h +1 -1
  21. data/contrib/zstd/lib/common/entropy_common.c +15 -37
  22. data/contrib/zstd/lib/common/error_private.c +9 -2
  23. data/contrib/zstd/lib/common/error_private.h +82 -3
  24. data/contrib/zstd/lib/common/fse.h +9 -85
  25. data/contrib/zstd/lib/common/fse_decompress.c +29 -111
  26. data/contrib/zstd/lib/common/huf.h +84 -172
  27. data/contrib/zstd/lib/common/mem.h +58 -49
  28. data/contrib/zstd/lib/common/pool.c +37 -16
  29. data/contrib/zstd/lib/common/pool.h +9 -3
  30. data/contrib/zstd/lib/common/portability_macros.h +156 -0
  31. data/contrib/zstd/lib/common/threading.c +68 -14
  32. data/contrib/zstd/lib/common/threading.h +5 -10
  33. data/contrib/zstd/lib/common/xxhash.c +7 -809
  34. data/contrib/zstd/lib/common/xxhash.h +5568 -167
  35. data/contrib/zstd/lib/common/zstd_common.c +1 -36
  36. data/contrib/zstd/lib/common/zstd_deps.h +1 -1
  37. data/contrib/zstd/lib/common/zstd_internal.h +64 -150
  38. data/contrib/zstd/lib/common/zstd_trace.h +163 -0
  39. data/contrib/zstd/lib/compress/clevels.h +134 -0
  40. data/contrib/zstd/lib/compress/fse_compress.c +69 -150
  41. data/contrib/zstd/lib/compress/hist.c +1 -1
  42. data/contrib/zstd/lib/compress/hist.h +1 -1
  43. data/contrib/zstd/lib/compress/huf_compress.c +773 -251
  44. data/contrib/zstd/lib/compress/zstd_compress.c +2650 -826
  45. data/contrib/zstd/lib/compress/zstd_compress_internal.h +509 -180
  46. data/contrib/zstd/lib/compress/zstd_compress_literals.c +117 -40
  47. data/contrib/zstd/lib/compress/zstd_compress_literals.h +16 -6
  48. data/contrib/zstd/lib/compress/zstd_compress_sequences.c +28 -19
  49. data/contrib/zstd/lib/compress/zstd_compress_sequences.h +1 -1
  50. data/contrib/zstd/lib/compress/zstd_compress_superblock.c +33 -305
  51. data/contrib/zstd/lib/compress/zstd_compress_superblock.h +1 -1
  52. data/contrib/zstd/lib/compress/zstd_cwksp.h +266 -85
  53. data/contrib/zstd/lib/compress/zstd_double_fast.c +369 -132
  54. data/contrib/zstd/lib/compress/zstd_double_fast.h +3 -2
  55. data/contrib/zstd/lib/compress/zstd_fast.c +722 -258
  56. data/contrib/zstd/lib/compress/zstd_fast.h +3 -2
  57. data/contrib/zstd/lib/compress/zstd_lazy.c +1105 -360
  58. data/contrib/zstd/lib/compress/zstd_lazy.h +41 -1
  59. data/contrib/zstd/lib/compress/zstd_ldm.c +272 -208
  60. data/contrib/zstd/lib/compress/zstd_ldm.h +3 -2
  61. data/contrib/zstd/lib/compress/zstd_ldm_geartab.h +106 -0
  62. data/contrib/zstd/lib/compress/zstd_opt.c +324 -197
  63. data/contrib/zstd/lib/compress/zstd_opt.h +1 -1
  64. data/contrib/zstd/lib/compress/zstdmt_compress.c +109 -53
  65. data/contrib/zstd/lib/compress/zstdmt_compress.h +9 -6
  66. data/contrib/zstd/lib/decompress/huf_decompress.c +1071 -539
  67. data/contrib/zstd/lib/decompress/huf_decompress_amd64.S +576 -0
  68. data/contrib/zstd/lib/decompress/zstd_ddict.c +4 -4
  69. data/contrib/zstd/lib/decompress/zstd_ddict.h +1 -1
  70. data/contrib/zstd/lib/decompress/zstd_decompress.c +507 -82
  71. data/contrib/zstd/lib/decompress/zstd_decompress_block.c +962 -310
  72. data/contrib/zstd/lib/decompress/zstd_decompress_block.h +14 -3
  73. data/contrib/zstd/lib/decompress/zstd_decompress_internal.h +54 -6
  74. data/contrib/zstd/lib/deprecated/zbuff.h +1 -1
  75. data/contrib/zstd/lib/deprecated/zbuff_common.c +1 -1
  76. data/contrib/zstd/lib/deprecated/zbuff_compress.c +24 -4
  77. data/contrib/zstd/lib/deprecated/zbuff_decompress.c +3 -1
  78. data/contrib/zstd/lib/dictBuilder/cover.c +44 -32
  79. data/contrib/zstd/lib/dictBuilder/cover.h +6 -5
  80. data/contrib/zstd/lib/dictBuilder/divsufsort.c +1 -1
  81. data/contrib/zstd/lib/dictBuilder/fastcover.c +24 -16
  82. data/contrib/zstd/lib/dictBuilder/zdict.c +88 -95
  83. data/contrib/zstd/lib/legacy/zstd_legacy.h +8 -1
  84. data/contrib/zstd/lib/legacy/zstd_v01.c +16 -53
  85. data/contrib/zstd/lib/legacy/zstd_v01.h +1 -1
  86. data/contrib/zstd/lib/legacy/zstd_v02.c +24 -69
  87. data/contrib/zstd/lib/legacy/zstd_v02.h +1 -1
  88. data/contrib/zstd/lib/legacy/zstd_v03.c +25 -72
  89. data/contrib/zstd/lib/legacy/zstd_v03.h +1 -1
  90. data/contrib/zstd/lib/legacy/zstd_v04.c +23 -69
  91. data/contrib/zstd/lib/legacy/zstd_v04.h +1 -1
  92. data/contrib/zstd/lib/legacy/zstd_v05.c +35 -85
  93. data/contrib/zstd/lib/legacy/zstd_v05.h +1 -1
  94. data/contrib/zstd/lib/legacy/zstd_v06.c +42 -87
  95. data/contrib/zstd/lib/legacy/zstd_v06.h +1 -1
  96. data/contrib/zstd/lib/legacy/zstd_v07.c +35 -82
  97. data/contrib/zstd/lib/legacy/zstd_v07.h +1 -1
  98. data/contrib/zstd/lib/libzstd.mk +214 -0
  99. data/contrib/zstd/lib/libzstd.pc.in +4 -3
  100. data/contrib/zstd/lib/module.modulemap +35 -0
  101. data/contrib/zstd/lib/{dictBuilder/zdict.h → zdict.h} +202 -33
  102. data/contrib/zstd/lib/zstd.h +922 -293
  103. data/contrib/zstd/lib/{common/zstd_errors.h → zstd_errors.h} +27 -8
  104. data/ext/extconf.rb +7 -6
  105. data/ext/extzstd.c +13 -10
  106. data/ext/libzstd_conf.h +0 -1
  107. data/ext/zstd_decompress_asm.S +1 -0
  108. metadata +16 -5
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Copyright (c) 2016-2020, Yann Collet, Facebook, Inc.
2
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
3
3
  * All rights reserved.
4
4
  *
5
5
  * This source code is licensed under both the BSD-style license (found in the
@@ -14,27 +14,61 @@ extern "C" {
14
14
  #ifndef ZSTD_H_235446
15
15
  #define ZSTD_H_235446
16
16
 
17
- /* ====== Dependency ======*/
17
+ /* ====== Dependencies ======*/
18
18
  #include <limits.h> /* INT_MAX */
19
19
  #include <stddef.h> /* size_t */
20
20
 
21
21
 
22
22
  /* ===== ZSTDLIB_API : control library symbols visibility ===== */
23
- #ifndef ZSTDLIB_VISIBILITY
24
- # if defined(__GNUC__) && (__GNUC__ >= 4)
25
- # define ZSTDLIB_VISIBILITY __attribute__ ((visibility ("default")))
23
+ #ifndef ZSTDLIB_VISIBLE
24
+ /* Backwards compatibility with old macro name */
25
+ # ifdef ZSTDLIB_VISIBILITY
26
+ # define ZSTDLIB_VISIBLE ZSTDLIB_VISIBILITY
27
+ # elif defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__)
28
+ # define ZSTDLIB_VISIBLE __attribute__ ((visibility ("default")))
26
29
  # else
27
- # define ZSTDLIB_VISIBILITY
30
+ # define ZSTDLIB_VISIBLE
28
31
  # endif
29
32
  #endif
33
+
34
+ #ifndef ZSTDLIB_HIDDEN
35
+ # if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__)
36
+ # define ZSTDLIB_HIDDEN __attribute__ ((visibility ("hidden")))
37
+ # else
38
+ # define ZSTDLIB_HIDDEN
39
+ # endif
40
+ #endif
41
+
30
42
  #if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
31
- # define ZSTDLIB_API __declspec(dllexport) ZSTDLIB_VISIBILITY
43
+ # define ZSTDLIB_API __declspec(dllexport) ZSTDLIB_VISIBLE
32
44
  #elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
33
- # define ZSTDLIB_API __declspec(dllimport) ZSTDLIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/
45
+ # define ZSTDLIB_API __declspec(dllimport) ZSTDLIB_VISIBLE /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/
34
46
  #else
35
- # define ZSTDLIB_API ZSTDLIB_VISIBILITY
47
+ # define ZSTDLIB_API ZSTDLIB_VISIBLE
36
48
  #endif
37
49
 
50
+ /* Deprecation warnings :
51
+ * Should these warnings be a problem, it is generally possible to disable them,
52
+ * typically with -Wno-deprecated-declarations for gcc or _CRT_SECURE_NO_WARNINGS in Visual.
53
+ * Otherwise, it's also possible to define ZSTD_DISABLE_DEPRECATE_WARNINGS.
54
+ */
55
+ #ifdef ZSTD_DISABLE_DEPRECATE_WARNINGS
56
+ # define ZSTD_DEPRECATED(message) /* disable deprecation warnings */
57
+ #else
58
+ # if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */
59
+ # define ZSTD_DEPRECATED(message) [[deprecated(message)]]
60
+ # elif (defined(GNUC) && (GNUC > 4 || (GNUC == 4 && GNUC_MINOR >= 5))) || defined(__clang__)
61
+ # define ZSTD_DEPRECATED(message) __attribute__((deprecated(message)))
62
+ # elif defined(__GNUC__) && (__GNUC__ >= 3)
63
+ # define ZSTD_DEPRECATED(message) __attribute__((deprecated))
64
+ # elif defined(_MSC_VER)
65
+ # define ZSTD_DEPRECATED(message) __declspec(deprecated(message))
66
+ # else
67
+ # pragma message("WARNING: You need to implement ZSTD_DEPRECATED for this compiler")
68
+ # define ZSTD_DEPRECATED(message)
69
+ # endif
70
+ #endif /* ZSTD_DISABLE_DEPRECATE_WARNINGS */
71
+
38
72
 
39
73
  /*******************************************************************************
40
74
  Introduction
@@ -71,8 +105,8 @@ extern "C" {
71
105
 
72
106
  /*------ Version ------*/
73
107
  #define ZSTD_VERSION_MAJOR 1
74
- #define ZSTD_VERSION_MINOR 4
75
- #define ZSTD_VERSION_RELEASE 7
108
+ #define ZSTD_VERSION_MINOR 5
109
+ #define ZSTD_VERSION_RELEASE 5
76
110
  #define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
77
111
 
78
112
  /*! ZSTD_versionNumber() :
@@ -109,13 +143,13 @@ ZSTDLIB_API const char* ZSTD_versionString(void);
109
143
  #define ZSTD_BLOCKSIZE_MAX (1<<ZSTD_BLOCKSIZELOG_MAX)
110
144
 
111
145
 
112
-
113
146
  /***************************************
114
147
  * Simple API
115
148
  ***************************************/
116
149
  /*! ZSTD_compress() :
117
150
  * Compresses `src` content as a single zstd compressed frame into already allocated `dst`.
118
- * Hint : compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
151
+ * NOTE: Providing `dstCapacity >= ZSTD_compressBound(srcSize)` guarantees that zstd will have
152
+ * enough space to successfully compress the data.
119
153
  * @return : compressed size written into `dst` (<= `dstCapacity),
120
154
  * or an error code if it fails (which can be tested using ZSTD_isError()). */
121
155
  ZSTDLIB_API size_t ZSTD_compress( void* dst, size_t dstCapacity,
@@ -164,9 +198,11 @@ ZSTDLIB_API unsigned long long ZSTD_getFrameContentSize(const void *src, size_t
164
198
  * "empty", "unknown" and "error" results to the same return value (0),
165
199
  * while ZSTD_getFrameContentSize() gives them separate return values.
166
200
  * @return : decompressed size of `src` frame content _if known and not empty_, 0 otherwise. */
167
- ZSTDLIB_API unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize);
201
+ ZSTD_DEPRECATED("Replaced by ZSTD_getFrameContentSize")
202
+ ZSTDLIB_API
203
+ unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize);
168
204
 
169
- /*! ZSTD_findFrameCompressedSize() :
205
+ /*! ZSTD_findFrameCompressedSize() : Requires v1.4.0+
170
206
  * `src` should point to the start of a ZSTD frame or skippable frame.
171
207
  * `srcSize` must be >= first frame size
172
208
  * @return : the compressed size of the first frame starting at `src`,
@@ -176,12 +212,35 @@ ZSTDLIB_API size_t ZSTD_findFrameCompressedSize(const void* src, size_t srcSize)
176
212
 
177
213
 
178
214
  /*====== Helper functions ======*/
179
- #define ZSTD_COMPRESSBOUND(srcSize) ((srcSize) + ((srcSize)>>8) + (((srcSize) < (128<<10)) ? (((128<<10) - (srcSize)) >> 11) /* margin, from 64 to 0 */ : 0)) /* this formula ensures that bound(A) + bound(B) <= bound(A+B) as long as A and B >= 128 KB */
180
- ZSTDLIB_API size_t ZSTD_compressBound(size_t srcSize); /*!< maximum compressed size in worst case single-pass scenario */
215
+ /* ZSTD_compressBound() :
216
+ * maximum compressed size in worst case single-pass scenario.
217
+ * When invoking `ZSTD_compress()` or any other one-pass compression function,
218
+ * it's recommended to provide @dstCapacity >= ZSTD_compressBound(srcSize)
219
+ * as it eliminates one potential failure scenario,
220
+ * aka not enough room in dst buffer to write the compressed frame.
221
+ * Note : ZSTD_compressBound() itself can fail, if @srcSize > ZSTD_MAX_INPUT_SIZE .
222
+ * In which case, ZSTD_compressBound() will return an error code
223
+ * which can be tested using ZSTD_isError().
224
+ *
225
+ * ZSTD_COMPRESSBOUND() :
226
+ * same as ZSTD_compressBound(), but as a macro.
227
+ * It can be used to produce constants, which can be useful for static allocation,
228
+ * for example to size a static array on stack.
229
+ * Will produce constant value 0 if srcSize too large.
230
+ */
231
+ #define ZSTD_MAX_INPUT_SIZE ((sizeof(size_t)==8) ? 0xFF00FF00FF00FF00LLU : 0xFF00FF00U)
232
+ #define ZSTD_COMPRESSBOUND(srcSize) (((size_t)(srcSize) >= ZSTD_MAX_INPUT_SIZE) ? 0 : (srcSize) + ((srcSize)>>8) + (((srcSize) < (128<<10)) ? (((128<<10) - (srcSize)) >> 11) /* margin, from 64 to 0 */ : 0)) /* this formula ensures that bound(A) + bound(B) <= bound(A+B) as long as A and B >= 128 KB */
233
+ ZSTDLIB_API size_t ZSTD_compressBound(size_t srcSize); /*!< maximum compressed size in worst case single-pass scenario */
234
+ /* ZSTD_isError() :
235
+ * Most ZSTD_* functions returning a size_t value can be tested for error,
236
+ * using ZSTD_isError().
237
+ * @return 1 if error, 0 otherwise
238
+ */
181
239
  ZSTDLIB_API unsigned ZSTD_isError(size_t code); /*!< tells if a `size_t` function result is an error code */
182
240
  ZSTDLIB_API const char* ZSTD_getErrorName(size_t code); /*!< provides readable string from an error code */
183
- ZSTDLIB_API int ZSTD_minCLevel(void); /*!< minimum negative compression level allowed */
241
+ ZSTDLIB_API int ZSTD_minCLevel(void); /*!< minimum negative compression level allowed, requires v1.4.0+ */
184
242
  ZSTDLIB_API int ZSTD_maxCLevel(void); /*!< maximum compression level available */
243
+ ZSTDLIB_API int ZSTD_defaultCLevel(void); /*!< default compression level, specified by ZSTD_CLEVEL_DEFAULT, requires v1.5.0+ */
185
244
 
186
245
 
187
246
  /***************************************
@@ -199,7 +258,7 @@ ZSTDLIB_API int ZSTD_maxCLevel(void); /*!< maximum compres
199
258
  */
200
259
  typedef struct ZSTD_CCtx_s ZSTD_CCtx;
201
260
  ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
202
- ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
261
+ ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx); /* accept NULL pointer */
203
262
 
204
263
  /*! ZSTD_compressCCtx() :
205
264
  * Same as ZSTD_compress(), using an explicit ZSTD_CCtx.
@@ -222,7 +281,7 @@ ZSTDLIB_API size_t ZSTD_compressCCtx(ZSTD_CCtx* cctx,
222
281
  * Use one context per thread for parallel execution. */
223
282
  typedef struct ZSTD_DCtx_s ZSTD_DCtx;
224
283
  ZSTDLIB_API ZSTD_DCtx* ZSTD_createDCtx(void);
225
- ZSTDLIB_API size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx);
284
+ ZSTDLIB_API size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx); /* accept NULL pointer */
226
285
 
227
286
  /*! ZSTD_decompressDCtx() :
228
287
  * Same as ZSTD_decompress(),
@@ -234,9 +293,9 @@ ZSTDLIB_API size_t ZSTD_decompressDCtx(ZSTD_DCtx* dctx,
234
293
  const void* src, size_t srcSize);
235
294
 
236
295
 
237
- /***************************************
238
- * Advanced compression API
239
- ***************************************/
296
+ /*********************************************
297
+ * Advanced compression API (Requires v1.4.0+)
298
+ **********************************************/
240
299
 
241
300
  /* API design :
242
301
  * Parameters are pushed one by one into an existing context,
@@ -247,7 +306,7 @@ ZSTDLIB_API size_t ZSTD_decompressDCtx(ZSTD_DCtx* dctx,
247
306
  *
248
307
  * It's possible to reset all parameters to "default" using ZSTD_CCtx_reset().
249
308
  *
250
- * This API supercedes all other "advanced" API entry points in the experimental section.
309
+ * This API supersedes all other "advanced" API entry points in the experimental section.
251
310
  * In the future, we expect to remove from experimental API entry points which are redundant with this API.
252
311
  */
253
312
 
@@ -266,7 +325,6 @@ typedef enum { ZSTD_fast=1,
266
325
  Only the order (from fast to strong) is guaranteed */
267
326
  } ZSTD_strategy;
268
327
 
269
-
270
328
  typedef enum {
271
329
 
272
330
  /* compression parameters
@@ -332,7 +390,6 @@ typedef enum {
332
390
  * The higher the value of selected strategy, the more complex it is,
333
391
  * resulting in stronger and slower compression.
334
392
  * Special: value 0 means "use default strategy". */
335
-
336
393
  /* LDM mode parameters */
337
394
  ZSTD_c_enableLongDistanceMatching=160, /* Enable long distance matching.
338
395
  * This parameter is designed to improve compression ratio
@@ -389,7 +446,7 @@ typedef enum {
389
446
  ZSTD_c_jobSize=401, /* Size of a compression job. This value is enforced only when nbWorkers >= 1.
390
447
  * Each compression job is completed in parallel, so this value can indirectly impact the nb of active threads.
391
448
  * 0 means default, which is dynamically determined based on compression parameters.
392
- * Job size must be a minimum of overlap size, or 1 MB, whichever is largest.
449
+ * Job size must be a minimum of overlap size, or ZSTDMT_JOBSIZE_MIN (= 512 KB), whichever is largest.
393
450
  * The minimum size is automatically and transparently enforced. */
394
451
  ZSTD_c_overlapLog=402, /* Control the overlap size, as a fraction of window size.
395
452
  * The overlap size is an amount of data reloaded from previous job at the beginning of a new job.
@@ -419,6 +476,11 @@ typedef enum {
419
476
  * ZSTD_c_stableOutBuffer
420
477
  * ZSTD_c_blockDelimiters
421
478
  * ZSTD_c_validateSequences
479
+ * ZSTD_c_useBlockSplitter
480
+ * ZSTD_c_useRowMatchFinder
481
+ * ZSTD_c_prefetchCDictTables
482
+ * ZSTD_c_enableSeqProducerFallback
483
+ * ZSTD_c_maxBlockSize
422
484
  * Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
423
485
  * note : never ever use experimentalParam? names directly;
424
486
  * also, the enums values themselves are unstable and can still change.
@@ -434,7 +496,14 @@ typedef enum {
434
496
  ZSTD_c_experimentalParam9=1006,
435
497
  ZSTD_c_experimentalParam10=1007,
436
498
  ZSTD_c_experimentalParam11=1008,
437
- ZSTD_c_experimentalParam12=1009
499
+ ZSTD_c_experimentalParam12=1009,
500
+ ZSTD_c_experimentalParam13=1010,
501
+ ZSTD_c_experimentalParam14=1011,
502
+ ZSTD_c_experimentalParam15=1012,
503
+ ZSTD_c_experimentalParam16=1013,
504
+ ZSTD_c_experimentalParam17=1014,
505
+ ZSTD_c_experimentalParam18=1015,
506
+ ZSTD_c_experimentalParam19=1016
438
507
  } ZSTD_cParameter;
439
508
 
440
509
  typedef struct {
@@ -497,7 +566,7 @@ typedef enum {
497
566
  * They will be used to compress next frame.
498
567
  * Resetting session never fails.
499
568
  * - The parameters : changes all parameters back to "default".
500
- * This removes any reference to any dictionary too.
569
+ * This also removes any reference to any dictionary or external sequence producer.
501
570
  * Parameters can only be changed between 2 sessions (i.e. no compression is currently ongoing)
502
571
  * otherwise the reset fails, and function returns an error value (which can be tested using ZSTD_isError())
503
572
  * - Both : similar to resetting the session, followed by resetting parameters.
@@ -510,7 +579,8 @@ ZSTDLIB_API size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_ResetDirective reset);
510
579
  * Should cctx hold data from a previously unfinished frame, everything about it is forgotten.
511
580
  * - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()
512
581
  * - The function is always blocking, returns when compression is completed.
513
- * Hint : compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
582
+ * NOTE: Providing `dstCapacity >= ZSTD_compressBound(srcSize)` guarantees that zstd will have
583
+ * enough space to successfully compress the data, though it is possible it fails for other reasons.
514
584
  * @return : compressed size written into `dst` (<= `dstCapacity),
515
585
  * or an error code if it fails (which can be tested using ZSTD_isError()).
516
586
  */
@@ -519,9 +589,9 @@ ZSTDLIB_API size_t ZSTD_compress2( ZSTD_CCtx* cctx,
519
589
  const void* src, size_t srcSize);
520
590
 
521
591
 
522
- /***************************************
523
- * Advanced decompression API
524
- ***************************************/
592
+ /***********************************************
593
+ * Advanced decompression API (Requires v1.4.0+)
594
+ ************************************************/
525
595
 
526
596
  /* The advanced API pushes parameters one by one into an existing DCtx context.
527
597
  * Parameters are sticky, and remain valid for all following frames
@@ -546,12 +616,16 @@ typedef enum {
546
616
  * ZSTD_d_format
547
617
  * ZSTD_d_stableOutBuffer
548
618
  * ZSTD_d_forceIgnoreChecksum
619
+ * ZSTD_d_refMultipleDDicts
620
+ * ZSTD_d_disableHuffmanAssembly
549
621
  * Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
550
622
  * note : never ever use experimentalParam? names directly
551
623
  */
552
624
  ZSTD_d_experimentalParam1=1000,
553
625
  ZSTD_d_experimentalParam2=1001,
554
- ZSTD_d_experimentalParam3=1002
626
+ ZSTD_d_experimentalParam3=1002,
627
+ ZSTD_d_experimentalParam4=1003,
628
+ ZSTD_d_experimentalParam5=1004
555
629
 
556
630
  } ZSTD_dParameter;
557
631
 
@@ -665,7 +739,7 @@ typedef ZSTD_CCtx ZSTD_CStream; /**< CCtx and CStream are now effectively same
665
739
  /* Continue to distinguish them for compatibility with older versions <= v1.2.0 */
666
740
  /*===== ZSTD_CStream management functions =====*/
667
741
  ZSTDLIB_API ZSTD_CStream* ZSTD_createCStream(void);
668
- ZSTDLIB_API size_t ZSTD_freeCStream(ZSTD_CStream* zcs);
742
+ ZSTDLIB_API size_t ZSTD_freeCStream(ZSTD_CStream* zcs); /* accept NULL pointer */
669
743
 
670
744
  /*===== Streaming compression functions =====*/
671
745
  typedef enum {
@@ -681,7 +755,7 @@ typedef enum {
681
755
  : note : multithreaded compression will block to flush as much output as possible. */
682
756
  } ZSTD_EndDirective;
683
757
 
684
- /*! ZSTD_compressStream2() :
758
+ /*! ZSTD_compressStream2() : Requires v1.4.0+
685
759
  * Behaves about the same as ZSTD_compressStream, with additional control on end directive.
686
760
  * - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()
687
761
  * - Compression parameters cannot be changed once compression is started (save a list of exceptions in multi-threading mode)
@@ -727,11 +801,9 @@ ZSTDLIB_API size_t ZSTD_CStreamOutSize(void); /**< recommended size for output
727
801
 
728
802
 
729
803
  /* *****************************************************************************
730
- * This following is a legacy streaming API.
804
+ * This following is a legacy streaming API, available since v1.0+ .
731
805
  * It can be replaced by ZSTD_CCtx_reset() and ZSTD_compressStream2().
732
806
  * It is redundant, but remains fully supported.
733
- * Advanced parameters and dictionary compression can only be used through the
734
- * new API.
735
807
  ******************************************************************************/
736
808
 
737
809
  /*!
@@ -740,6 +812,9 @@ ZSTDLIB_API size_t ZSTD_CStreamOutSize(void); /**< recommended size for output
740
812
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
741
813
  * ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)
742
814
  * ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
815
+ *
816
+ * Note that ZSTD_initCStream() clears any previously set dictionary. Use the new API
817
+ * to compress with a dictionary.
743
818
  */
744
819
  ZSTDLIB_API size_t ZSTD_initCStream(ZSTD_CStream* zcs, int compressionLevel);
745
820
  /*!
@@ -786,17 +861,35 @@ typedef ZSTD_DCtx ZSTD_DStream; /**< DCtx and DStream are now effectively same
786
861
  /* For compatibility with versions <= v1.2.0, prefer differentiating them. */
787
862
  /*===== ZSTD_DStream management functions =====*/
788
863
  ZSTDLIB_API ZSTD_DStream* ZSTD_createDStream(void);
789
- ZSTDLIB_API size_t ZSTD_freeDStream(ZSTD_DStream* zds);
864
+ ZSTDLIB_API size_t ZSTD_freeDStream(ZSTD_DStream* zds); /* accept NULL pointer */
790
865
 
791
866
  /*===== Streaming decompression functions =====*/
792
867
 
793
- /* This function is redundant with the advanced API and equivalent to:
868
+ /*! ZSTD_initDStream() :
869
+ * Initialize/reset DStream state for new decompression operation.
870
+ * Call before new decompression operation using same DStream.
794
871
  *
872
+ * Note : This function is redundant with the advanced API and equivalent to:
795
873
  * ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);
796
874
  * ZSTD_DCtx_refDDict(zds, NULL);
797
875
  */
798
876
  ZSTDLIB_API size_t ZSTD_initDStream(ZSTD_DStream* zds);
799
877
 
878
+ /*! ZSTD_decompressStream() :
879
+ * Streaming decompression function.
880
+ * Call repetitively to consume full input updating it as necessary.
881
+ * Function will update both input and output `pos` fields exposing current state via these fields:
882
+ * - `input.pos < input.size`, some input remaining and caller should provide remaining input
883
+ * on the next call.
884
+ * - `output.pos < output.size`, decoder finished and flushed all remaining buffers.
885
+ * - `output.pos == output.size`, potentially uncflushed data present in the internal buffers,
886
+ * call ZSTD_decompressStream() again to flush remaining data to output.
887
+ * Note : with no additional input, amount of data flushed <= ZSTD_BLOCKSIZE_MAX.
888
+ *
889
+ * @return : 0 when a frame is completely decoded and fully flushed,
890
+ * or an error code, which can be tested using ZSTD_isError(),
891
+ * or any other value > 0, which means there is some decoding or flushing to do to complete current frame.
892
+ */
800
893
  ZSTDLIB_API size_t ZSTD_decompressStream(ZSTD_DStream* zds, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
801
894
 
802
895
  ZSTDLIB_API size_t ZSTD_DStreamInSize(void); /*!< recommended size for input buffer */
@@ -809,7 +902,7 @@ ZSTDLIB_API size_t ZSTD_DStreamOutSize(void); /*!< recommended size for output
809
902
  /*! ZSTD_compress_usingDict() :
810
903
  * Compression at an explicit compression level using a Dictionary.
811
904
  * A dictionary can be any arbitrary data segment (also called a prefix),
812
- * or a buffer with specified information (see dictBuilder/zdict.h).
905
+ * or a buffer with specified information (see zdict.h).
813
906
  * Note : This function loads the dictionary, resulting in significant startup delay.
814
907
  * It's intended for a dictionary used only once.
815
908
  * Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used. */
@@ -852,7 +945,8 @@ ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict(const void* dictBuffer, size_t dictSize
852
945
  int compressionLevel);
853
946
 
854
947
  /*! ZSTD_freeCDict() :
855
- * Function frees memory allocated by ZSTD_createCDict(). */
948
+ * Function frees memory allocated by ZSTD_createCDict().
949
+ * If a NULL pointer is passed, no operation is performed. */
856
950
  ZSTDLIB_API size_t ZSTD_freeCDict(ZSTD_CDict* CDict);
857
951
 
858
952
  /*! ZSTD_compress_usingCDict() :
@@ -874,7 +968,8 @@ typedef struct ZSTD_DDict_s ZSTD_DDict;
874
968
  ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict(const void* dictBuffer, size_t dictSize);
875
969
 
876
970
  /*! ZSTD_freeDDict() :
877
- * Function frees memory allocated with ZSTD_createDDict() */
971
+ * Function frees memory allocated with ZSTD_createDDict()
972
+ * If a NULL pointer is passed, no operation is performed. */
878
973
  ZSTDLIB_API size_t ZSTD_freeDDict(ZSTD_DDict* ddict);
879
974
 
880
975
  /*! ZSTD_decompress_usingDDict() :
@@ -890,24 +985,30 @@ ZSTDLIB_API size_t ZSTD_decompress_usingDDict(ZSTD_DCtx* dctx,
890
985
  * Dictionary helper functions
891
986
  *******************************/
892
987
 
893
- /*! ZSTD_getDictID_fromDict() :
988
+ /*! ZSTD_getDictID_fromDict() : Requires v1.4.0+
894
989
  * Provides the dictID stored within dictionary.
895
990
  * if @return == 0, the dictionary is not conformant with Zstandard specification.
896
991
  * It can still be loaded, but as a content-only dictionary. */
897
992
  ZSTDLIB_API unsigned ZSTD_getDictID_fromDict(const void* dict, size_t dictSize);
898
993
 
899
- /*! ZSTD_getDictID_fromDDict() :
994
+ /*! ZSTD_getDictID_fromCDict() : Requires v1.5.0+
995
+ * Provides the dictID of the dictionary loaded into `cdict`.
996
+ * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
997
+ * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
998
+ ZSTDLIB_API unsigned ZSTD_getDictID_fromCDict(const ZSTD_CDict* cdict);
999
+
1000
+ /*! ZSTD_getDictID_fromDDict() : Requires v1.4.0+
900
1001
  * Provides the dictID of the dictionary loaded into `ddict`.
901
1002
  * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
902
1003
  * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
903
1004
  ZSTDLIB_API unsigned ZSTD_getDictID_fromDDict(const ZSTD_DDict* ddict);
904
1005
 
905
- /*! ZSTD_getDictID_fromFrame() :
1006
+ /*! ZSTD_getDictID_fromFrame() : Requires v1.4.0+
906
1007
  * Provides the dictID required to decompressed the frame stored within `src`.
907
1008
  * If @return == 0, the dictID could not be decoded.
908
1009
  * This could for one of the following reasons :
909
1010
  * - The frame does not require a dictionary to be decoded (most common case).
910
- * - The frame was built with dictID intentionally removed. Whatever dictionary is necessary is a hidden information.
1011
+ * - The frame was built with dictID intentionally removed. Whatever dictionary is necessary is a hidden piece of information.
911
1012
  * Note : this use case also happens when using a non-conformant dictionary.
912
1013
  * - `srcSize` is too small, and as a result, the frame header could not be decoded (only possible if `srcSize < ZSTD_FRAMEHEADERSIZE_MAX`).
913
1014
  * - This is not a Zstandard frame.
@@ -916,23 +1017,26 @@ ZSTDLIB_API unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
916
1017
 
917
1018
 
918
1019
  /*******************************************************************************
919
- * Advanced dictionary and prefix API
1020
+ * Advanced dictionary and prefix API (Requires v1.4.0+)
920
1021
  *
921
1022
  * This API allows dictionaries to be used with ZSTD_compress2(),
922
- * ZSTD_compressStream2(), and ZSTD_decompress(). Dictionaries are sticky, and
923
- * only reset with the context is reset with ZSTD_reset_parameters or
924
- * ZSTD_reset_session_and_parameters. Prefixes are single-use.
1023
+ * ZSTD_compressStream2(), and ZSTD_decompressDCtx().
1024
+ * Dictionaries are sticky, they remain valid when same context is re-used,
1025
+ * they only reset when the context is reset
1026
+ * with ZSTD_reset_parameters or ZSTD_reset_session_and_parameters.
1027
+ * In contrast, Prefixes are single-use.
925
1028
  ******************************************************************************/
926
1029
 
927
1030
 
928
- /*! ZSTD_CCtx_loadDictionary() :
1031
+ /*! ZSTD_CCtx_loadDictionary() : Requires v1.4.0+
929
1032
  * Create an internal CDict from `dict` buffer.
930
1033
  * Decompression will have to use same dictionary.
931
1034
  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
932
1035
  * Special: Loading a NULL (or 0-size) dictionary invalidates previous dictionary,
933
1036
  * meaning "return to no-dictionary mode".
934
- * Note 1 : Dictionary is sticky, it will be used for all future compressed frames.
935
- * To return to "no-dictionary" situation, load a NULL dictionary (or reset parameters).
1037
+ * Note 1 : Dictionary is sticky, it will be used for all future compressed frames,
1038
+ * until parameters are reset, a new dictionary is loaded, or the dictionary
1039
+ * is explicitly invalidated by loading a NULL dictionary.
936
1040
  * Note 2 : Loading a dictionary involves building tables.
937
1041
  * It's also a CPU consuming operation, with non-negligible impact on latency.
938
1042
  * Tables are dependent on compression parameters, and for this reason,
@@ -941,14 +1045,18 @@ ZSTDLIB_API unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
941
1045
  * Use experimental ZSTD_CCtx_loadDictionary_byReference() to reference content instead.
942
1046
  * In such a case, dictionary buffer must outlive its users.
943
1047
  * Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()
944
- * to precisely select how dictionary content must be interpreted. */
1048
+ * to precisely select how dictionary content must be interpreted.
1049
+ * Note 5 : This method does not benefit from LDM (long distance mode).
1050
+ * If you want to employ LDM on some large dictionary content,
1051
+ * prefer employing ZSTD_CCtx_refPrefix() described below.
1052
+ */
945
1053
  ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
946
1054
 
947
- /*! ZSTD_CCtx_refCDict() :
948
- * Reference a prepared dictionary, to be used for all next compressed frames.
1055
+ /*! ZSTD_CCtx_refCDict() : Requires v1.4.0+
1056
+ * Reference a prepared dictionary, to be used for all future compressed frames.
949
1057
  * Note that compression parameters are enforced from within CDict,
950
1058
  * and supersede any compression parameter previously set within CCtx.
951
- * The parameters ignored are labled as "superseded-by-cdict" in the ZSTD_cParameter enum docs.
1059
+ * The parameters ignored are labelled as "superseded-by-cdict" in the ZSTD_cParameter enum docs.
952
1060
  * The ignored parameters will be used again if the CCtx is returned to no-dictionary mode.
953
1061
  * The dictionary will remain valid for future compressed frames using same CCtx.
954
1062
  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
@@ -958,12 +1066,13 @@ ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary(ZSTD_CCtx* cctx, const void* dict, s
958
1066
  * Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. */
959
1067
  ZSTDLIB_API size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);
960
1068
 
961
- /*! ZSTD_CCtx_refPrefix() :
1069
+ /*! ZSTD_CCtx_refPrefix() : Requires v1.4.0+
962
1070
  * Reference a prefix (single-usage dictionary) for next compressed frame.
963
1071
  * A prefix is **only used once**. Tables are discarded at end of frame (ZSTD_e_end).
964
1072
  * Decompression will need same prefix to properly regenerate data.
965
1073
  * Compressing with a prefix is similar in outcome as performing a diff and compressing it,
966
1074
  * but performs much faster, especially during decompression (compression speed is tunable with compression level).
1075
+ * This method is compatible with LDM (long distance mode).
967
1076
  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
968
1077
  * Special: Adding any prefix (including NULL) invalidates any previous prefix or dictionary
969
1078
  * Note 1 : Prefix buffer is referenced. It **must** outlive compression.
@@ -979,10 +1088,10 @@ ZSTDLIB_API size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);
979
1088
  ZSTDLIB_API size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx,
980
1089
  const void* prefix, size_t prefixSize);
981
1090
 
982
- /*! ZSTD_DCtx_loadDictionary() :
983
- * Create an internal DDict from dict buffer,
984
- * to be used to decompress next frames.
985
- * The dictionary remains valid for all future frames, until explicitly invalidated.
1091
+ /*! ZSTD_DCtx_loadDictionary() : Requires v1.4.0+
1092
+ * Create an internal DDict from dict buffer, to be used to decompress all future frames.
1093
+ * The dictionary remains valid for all future frames, until explicitly invalidated, or
1094
+ * a new dictionary is loaded.
986
1095
  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
987
1096
  * Special : Adding a NULL (or 0-size) dictionary invalidates any previous dictionary,
988
1097
  * meaning "return to no-dictionary mode".
@@ -996,18 +1105,26 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx,
996
1105
  */
997
1106
  ZSTDLIB_API size_t ZSTD_DCtx_loadDictionary(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
998
1107
 
999
- /*! ZSTD_DCtx_refDDict() :
1108
+ /*! ZSTD_DCtx_refDDict() : Requires v1.4.0+
1000
1109
  * Reference a prepared dictionary, to be used to decompress next frames.
1001
1110
  * The dictionary remains active for decompression of future frames using same DCtx.
1111
+ *
1112
+ * If called with ZSTD_d_refMultipleDDicts enabled, repeated calls of this function
1113
+ * will store the DDict references in a table, and the DDict used for decompression
1114
+ * will be determined at decompression time, as per the dict ID in the frame.
1115
+ * The memory for the table is allocated on the first call to refDDict, and can be
1116
+ * freed with ZSTD_freeDCtx().
1117
+ *
1118
+ * If called with ZSTD_d_refMultipleDDicts disabled (the default), only one dictionary
1119
+ * will be managed, and referencing a dictionary effectively "discards" any previous one.
1120
+ *
1002
1121
  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1003
- * Note 1 : Currently, only one dictionary can be managed.
1004
- * Referencing a new dictionary effectively "discards" any previous one.
1005
1122
  * Special: referencing a NULL DDict means "return to no-dictionary mode".
1006
1123
  * Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx.
1007
1124
  */
1008
1125
  ZSTDLIB_API size_t ZSTD_DCtx_refDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
1009
1126
 
1010
- /*! ZSTD_DCtx_refPrefix() :
1127
+ /*! ZSTD_DCtx_refPrefix() : Requires v1.4.0+
1011
1128
  * Reference a prefix (single-usage dictionary) to decompress next frame.
1012
1129
  * This is the reverse operation of ZSTD_CCtx_refPrefix(),
1013
1130
  * and must use the same prefix as the one used during compression.
@@ -1028,7 +1145,7 @@ ZSTDLIB_API size_t ZSTD_DCtx_refPrefix(ZSTD_DCtx* dctx,
1028
1145
 
1029
1146
  /* === Memory management === */
1030
1147
 
1031
- /*! ZSTD_sizeof_*() :
1148
+ /*! ZSTD_sizeof_*() : Requires v1.4.0+
1032
1149
  * These functions give the _current_ memory usage of selected object.
1033
1150
  * Note that object memory usage can evolve (increase or decrease) over time. */
1034
1151
  ZSTDLIB_API size_t ZSTD_sizeof_CCtx(const ZSTD_CCtx* cctx);
@@ -1053,6 +1170,17 @@ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
1053
1170
  #if defined(ZSTD_STATIC_LINKING_ONLY) && !defined(ZSTD_H_ZSTD_STATIC_LINKING_ONLY)
1054
1171
  #define ZSTD_H_ZSTD_STATIC_LINKING_ONLY
1055
1172
 
1173
+ /* This can be overridden externally to hide static symbols. */
1174
+ #ifndef ZSTDLIB_STATIC_API
1175
+ # if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
1176
+ # define ZSTDLIB_STATIC_API __declspec(dllexport) ZSTDLIB_VISIBLE
1177
+ # elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
1178
+ # define ZSTDLIB_STATIC_API __declspec(dllimport) ZSTDLIB_VISIBLE
1179
+ # else
1180
+ # define ZSTDLIB_STATIC_API ZSTDLIB_VISIBLE
1181
+ # endif
1182
+ #endif
1183
+
1056
1184
  /****************************************************************************************
1057
1185
  * experimental API (static linking only)
1058
1186
  ****************************************************************************************
@@ -1087,6 +1215,7 @@ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
1087
1215
  #define ZSTD_TARGETLENGTH_MIN 0 /* note : comparing this constant to an unsigned results in a tautological test */
1088
1216
  #define ZSTD_STRATEGY_MIN ZSTD_fast
1089
1217
  #define ZSTD_STRATEGY_MAX ZSTD_btultra2
1218
+ #define ZSTD_BLOCKSIZE_MAX_MIN (1 << 10) /* The minimum valid max blocksize. Maximum blocksizes smaller than this make compressBound() inaccurate. */
1090
1219
 
1091
1220
 
1092
1221
  #define ZSTD_OVERLAPLOG_MIN 0
@@ -1115,9 +1244,6 @@ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
1115
1244
  #define ZSTD_SRCSIZEHINT_MIN 0
1116
1245
  #define ZSTD_SRCSIZEHINT_MAX INT_MAX
1117
1246
 
1118
- /* internal */
1119
- #define ZSTD_HASHLOG3_MAX 17
1120
-
1121
1247
 
1122
1248
  /* --- Advanced types --- */
1123
1249
 
@@ -1205,6 +1331,12 @@ typedef enum {
1205
1331
  ZSTD_d_ignoreChecksum = 1
1206
1332
  } ZSTD_forceIgnoreChecksum_e;
1207
1333
 
1334
+ typedef enum {
1335
+ /* Note: this enum controls ZSTD_d_refMultipleDDicts */
1336
+ ZSTD_rmd_refSingleDDict = 0,
1337
+ ZSTD_rmd_refMultipleDDicts = 1
1338
+ } ZSTD_refMultipleDDicts_e;
1339
+
1208
1340
  typedef enum {
1209
1341
  /* Note: this enum and the behavior it controls are effectively internal
1210
1342
  * implementation details of the compressor. They are expected to continue
@@ -1253,9 +1385,18 @@ typedef enum {
1253
1385
  ZSTD_lcm_uncompressed = 2 /**< Always emit uncompressed literals. */
1254
1386
  } ZSTD_literalCompressionMode_e;
1255
1387
 
1388
+ typedef enum {
1389
+ /* Note: This enum controls features which are conditionally beneficial. Zstd typically will make a final
1390
+ * decision on whether or not to enable the feature (ZSTD_ps_auto), but setting the switch to ZSTD_ps_enable
1391
+ * or ZSTD_ps_disable allow for a force enable/disable the feature.
1392
+ */
1393
+ ZSTD_ps_auto = 0, /* Let the library automatically determine whether the feature shall be enabled */
1394
+ ZSTD_ps_enable = 1, /* Force-enable the feature */
1395
+ ZSTD_ps_disable = 2 /* Do not use the feature */
1396
+ } ZSTD_paramSwitch_e;
1256
1397
 
1257
1398
  /***************************************
1258
- * Frame size functions
1399
+ * Frame header and size functions
1259
1400
  ***************************************/
1260
1401
 
1261
1402
  /*! ZSTD_findDecompressedSize() :
@@ -1279,14 +1420,14 @@ typedef enum {
1279
1420
  * note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input to
1280
1421
  * read each contained frame header. This is fast as most of the data is skipped,
1281
1422
  * however it does mean that all frame data must be present and valid. */
1282
- ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
1423
+ ZSTDLIB_STATIC_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
1283
1424
 
1284
1425
  /*! ZSTD_decompressBound() :
1285
1426
  * `src` should point to the start of a series of ZSTD encoded and/or skippable frames
1286
1427
  * `srcSize` must be the _exact_ size of this series
1287
1428
  * (i.e. there should be a frame boundary at `src + srcSize`)
1288
1429
  * @return : - upper-bound for the decompressed size of all data in all successive frames
1289
- * - if an error occured: ZSTD_CONTENTSIZE_ERROR
1430
+ * - if an error occurred: ZSTD_CONTENTSIZE_ERROR
1290
1431
  *
1291
1432
  * note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1292
1433
  * note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD encoded frame of `src`.
@@ -1294,41 +1435,121 @@ ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t
1294
1435
  * note 3 : when the decompressed size field isn't available, the upper-bound for that frame is calculated by:
1295
1436
  * upper-bound = # blocks * min(128 KB, Window_Size)
1296
1437
  */
1297
- ZSTDLIB_API unsigned long long ZSTD_decompressBound(const void* src, size_t srcSize);
1438
+ ZSTDLIB_STATIC_API unsigned long long ZSTD_decompressBound(const void* src, size_t srcSize);
1298
1439
 
1299
1440
  /*! ZSTD_frameHeaderSize() :
1300
1441
  * srcSize must be >= ZSTD_FRAMEHEADERSIZE_PREFIX.
1301
1442
  * @return : size of the Frame Header,
1302
1443
  * or an error code (if srcSize is too small) */
1303
- ZSTDLIB_API size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize);
1444
+ ZSTDLIB_STATIC_API size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize);
1445
+
1446
+ typedef enum { ZSTD_frame, ZSTD_skippableFrame } ZSTD_frameType_e;
1447
+ typedef struct {
1448
+ unsigned long long frameContentSize; /* if == ZSTD_CONTENTSIZE_UNKNOWN, it means this field is not available. 0 means "empty" */
1449
+ unsigned long long windowSize; /* can be very large, up to <= frameContentSize */
1450
+ unsigned blockSizeMax;
1451
+ ZSTD_frameType_e frameType; /* if == ZSTD_skippableFrame, frameContentSize is the size of skippable content */
1452
+ unsigned headerSize;
1453
+ unsigned dictID;
1454
+ unsigned checksumFlag;
1455
+ unsigned _reserved1;
1456
+ unsigned _reserved2;
1457
+ } ZSTD_frameHeader;
1458
+
1459
+ /*! ZSTD_getFrameHeader() :
1460
+ * decode Frame Header, or requires larger `srcSize`.
1461
+ * @return : 0, `zfhPtr` is correctly filled,
1462
+ * >0, `srcSize` is too small, value is wanted `srcSize` amount,
1463
+ * or an error code, which can be tested using ZSTD_isError() */
1464
+ ZSTDLIB_STATIC_API size_t ZSTD_getFrameHeader(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize); /**< doesn't consume input */
1465
+ /*! ZSTD_getFrameHeader_advanced() :
1466
+ * same as ZSTD_getFrameHeader(),
1467
+ * with added capability to select a format (like ZSTD_f_zstd1_magicless) */
1468
+ ZSTDLIB_STATIC_API size_t ZSTD_getFrameHeader_advanced(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize, ZSTD_format_e format);
1469
+
1470
+ /*! ZSTD_decompressionMargin() :
1471
+ * Zstd supports in-place decompression, where the input and output buffers overlap.
1472
+ * In this case, the output buffer must be at least (Margin + Output_Size) bytes large,
1473
+ * and the input buffer must be at the end of the output buffer.
1474
+ *
1475
+ * _______________________ Output Buffer ________________________
1476
+ * | |
1477
+ * | ____ Input Buffer ____|
1478
+ * | | |
1479
+ * v v v
1480
+ * |---------------------------------------|-----------|----------|
1481
+ * ^ ^ ^
1482
+ * |___________________ Output_Size ___________________|_ Margin _|
1483
+ *
1484
+ * NOTE: See also ZSTD_DECOMPRESSION_MARGIN().
1485
+ * NOTE: This applies only to single-pass decompression through ZSTD_decompress() or
1486
+ * ZSTD_decompressDCtx().
1487
+ * NOTE: This function supports multi-frame input.
1488
+ *
1489
+ * @param src The compressed frame(s)
1490
+ * @param srcSize The size of the compressed frame(s)
1491
+ * @returns The decompression margin or an error that can be checked with ZSTD_isError().
1492
+ */
1493
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressionMargin(const void* src, size_t srcSize);
1494
+
1495
+ /*! ZSTD_DECOMPRESS_MARGIN() :
1496
+ * Similar to ZSTD_decompressionMargin(), but instead of computing the margin from
1497
+ * the compressed frame, compute it from the original size and the blockSizeLog.
1498
+ * See ZSTD_decompressionMargin() for details.
1499
+ *
1500
+ * WARNING: This macro does not support multi-frame input, the input must be a single
1501
+ * zstd frame. If you need that support use the function, or implement it yourself.
1502
+ *
1503
+ * @param originalSize The original uncompressed size of the data.
1504
+ * @param blockSize The block size == MIN(windowSize, ZSTD_BLOCKSIZE_MAX).
1505
+ * Unless you explicitly set the windowLog smaller than
1506
+ * ZSTD_BLOCKSIZELOG_MAX you can just use ZSTD_BLOCKSIZE_MAX.
1507
+ */
1508
+ #define ZSTD_DECOMPRESSION_MARGIN(originalSize, blockSize) ((size_t)( \
1509
+ ZSTD_FRAMEHEADERSIZE_MAX /* Frame header */ + \
1510
+ 4 /* checksum */ + \
1511
+ ((originalSize) == 0 ? 0 : 3 * (((originalSize) + (blockSize) - 1) / blockSize)) /* 3 bytes per block */ + \
1512
+ (blockSize) /* One block of margin */ \
1513
+ ))
1304
1514
 
1305
1515
  typedef enum {
1306
1516
  ZSTD_sf_noBlockDelimiters = 0, /* Representation of ZSTD_Sequence has no block delimiters, sequences only */
1307
1517
  ZSTD_sf_explicitBlockDelimiters = 1 /* Representation of ZSTD_Sequence contains explicit block delimiters */
1308
1518
  } ZSTD_sequenceFormat_e;
1309
1519
 
1520
+ /*! ZSTD_sequenceBound() :
1521
+ * `srcSize` : size of the input buffer
1522
+ * @return : upper-bound for the number of sequences that can be generated
1523
+ * from a buffer of srcSize bytes
1524
+ *
1525
+ * note : returns number of sequences - to get bytes, multiply by sizeof(ZSTD_Sequence).
1526
+ */
1527
+ ZSTDLIB_STATIC_API size_t ZSTD_sequenceBound(size_t srcSize);
1528
+
1310
1529
  /*! ZSTD_generateSequences() :
1311
- * Generate sequences using ZSTD_compress2, given a source buffer.
1530
+ * Generate sequences using ZSTD_compress2(), given a source buffer.
1312
1531
  *
1313
1532
  * Each block will end with a dummy sequence
1314
1533
  * with offset == 0, matchLength == 0, and litLength == length of last literals.
1315
1534
  * litLength may be == 0, and if so, then the sequence of (of: 0 ml: 0 ll: 0)
1316
1535
  * simply acts as a block delimiter.
1317
1536
  *
1318
- * zc can be used to insert custom compression params.
1319
- * This function invokes ZSTD_compress2
1537
+ * @zc can be used to insert custom compression params.
1538
+ * This function invokes ZSTD_compress2().
1320
1539
  *
1321
1540
  * The output of this function can be fed into ZSTD_compressSequences() with CCtx
1322
1541
  * setting of ZSTD_c_blockDelimiters as ZSTD_sf_explicitBlockDelimiters
1323
1542
  * @return : number of sequences generated
1324
1543
  */
1325
1544
 
1326
- ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
1327
- size_t outSeqsSize, const void* src, size_t srcSize);
1545
+ ZSTDLIB_STATIC_API size_t
1546
+ ZSTD_generateSequences( ZSTD_CCtx* zc,
1547
+ ZSTD_Sequence* outSeqs, size_t outSeqsSize,
1548
+ const void* src, size_t srcSize);
1328
1549
 
1329
1550
  /*! ZSTD_mergeBlockDelimiters() :
1330
1551
  * Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals
1331
- * by merging them into into the literals of the next sequence.
1552
+ * by merging them into the literals of the next sequence.
1332
1553
  *
1333
1554
  * As such, the final generated result has no explicit representation of block boundaries,
1334
1555
  * and the final last literals segment is not represented in the sequences.
@@ -1337,10 +1558,12 @@ ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
1337
1558
  * setting of ZSTD_c_blockDelimiters as ZSTD_sf_noBlockDelimiters
1338
1559
  * @return : number of sequences left after merging
1339
1560
  */
1340
- ZSTDLIB_API size_t ZSTD_mergeBlockDelimiters(ZSTD_Sequence* sequences, size_t seqsSize);
1561
+ ZSTDLIB_STATIC_API size_t ZSTD_mergeBlockDelimiters(ZSTD_Sequence* sequences, size_t seqsSize);
1341
1562
 
1342
1563
  /*! ZSTD_compressSequences() :
1343
- * Compress an array of ZSTD_Sequence, generated from the original source buffer, into dst.
1564
+ * Compress an array of ZSTD_Sequence, associated with @src buffer, into dst.
1565
+ * @src contains the entire input (not just the literals).
1566
+ * If @srcSize > sum(sequence.length), the remaining bytes are considered all literals
1344
1567
  * If a dictionary is included, then the cctx should reference the dict. (see: ZSTD_CCtx_refCDict(), ZSTD_CCtx_loadDictionary(), etc.)
1345
1568
  * The entire source is compressed into a single frame.
1346
1569
  *
@@ -1365,11 +1588,49 @@ ZSTDLIB_API size_t ZSTD_mergeBlockDelimiters(ZSTD_Sequence* sequences, size_t se
1365
1588
  * Note: Repcodes are, as of now, always re-calculated within this function, so ZSTD_Sequence::rep is unused.
1366
1589
  * Note 2: Once we integrate ability to ingest repcodes, the explicit block delims mode must respect those repcodes exactly,
1367
1590
  * and cannot emit an RLE block that disagrees with the repcode history
1368
- * @return : final compressed size or a ZSTD error.
1591
+ * @return : final compressed size, or a ZSTD error code.
1592
+ */
1593
+ ZSTDLIB_STATIC_API size_t
1594
+ ZSTD_compressSequences( ZSTD_CCtx* cctx, void* dst, size_t dstSize,
1595
+ const ZSTD_Sequence* inSeqs, size_t inSeqsSize,
1596
+ const void* src, size_t srcSize);
1597
+
1598
+
1599
+ /*! ZSTD_writeSkippableFrame() :
1600
+ * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
1601
+ *
1602
+ * Skippable frames begin with a 4-byte magic number. There are 16 possible choices of magic number,
1603
+ * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
1604
+ * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
1605
+ * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
1606
+ *
1607
+ * Returns an error if destination buffer is not large enough, if the source size is not representable
1608
+ * with a 4-byte unsigned int, or if the parameter magicVariant is greater than 15 (and therefore invalid).
1609
+ *
1610
+ * @return : number of bytes written or a ZSTD error.
1369
1611
  */
1370
- ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size_t dstSize,
1371
- const ZSTD_Sequence* inSeqs, size_t inSeqsSize,
1372
- const void* src, size_t srcSize);
1612
+ ZSTDLIB_STATIC_API size_t ZSTD_writeSkippableFrame(void* dst, size_t dstCapacity,
1613
+ const void* src, size_t srcSize, unsigned magicVariant);
1614
+
1615
+ /*! ZSTD_readSkippableFrame() :
1616
+ * Retrieves a zstd skippable frame containing data given by src, and writes it to dst buffer.
1617
+ *
1618
+ * The parameter magicVariant will receive the magicVariant that was supplied when the frame was written,
1619
+ * i.e. magicNumber - ZSTD_MAGIC_SKIPPABLE_START. This can be NULL if the caller is not interested
1620
+ * in the magicVariant.
1621
+ *
1622
+ * Returns an error if destination buffer is not large enough, or if the frame is not skippable.
1623
+ *
1624
+ * @return : number of bytes written or a ZSTD error.
1625
+ */
1626
+ ZSTDLIB_API size_t ZSTD_readSkippableFrame(void* dst, size_t dstCapacity, unsigned* magicVariant,
1627
+ const void* src, size_t srcSize);
1628
+
1629
+ /*! ZSTD_isSkippableFrame() :
1630
+ * Tells if the content of `buffer` starts with a valid Frame Identifier for a skippable frame.
1631
+ */
1632
+ ZSTDLIB_API unsigned ZSTD_isSkippableFrame(const void* buffer, size_t size);
1633
+
1373
1634
 
1374
1635
 
1375
1636
  /***************************************
@@ -1396,13 +1657,16 @@ ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size
1396
1657
  * and ZSTD_estimateCCtxSize_usingCCtxParams(), which can be used in tandem with ZSTD_CCtxParams_setParameter().
1397
1658
  * Both can be used to estimate memory using custom compression parameters and arbitrary srcSize limits.
1398
1659
  *
1399
- * Note 2 : only single-threaded compression is supported.
1660
+ * Note : only single-threaded compression is supported.
1400
1661
  * ZSTD_estimateCCtxSize_usingCCtxParams() will return an error code if ZSTD_c_nbWorkers is >= 1.
1662
+ *
1663
+ * Note 2 : ZSTD_estimateCCtxSize* functions are not compatible with the Block-Level Sequence Producer API at this time.
1664
+ * Size estimates assume that no external sequence producer is registered.
1401
1665
  */
1402
- ZSTDLIB_API size_t ZSTD_estimateCCtxSize(int compressionLevel);
1403
- ZSTDLIB_API size_t ZSTD_estimateCCtxSize_usingCParams(ZSTD_compressionParameters cParams);
1404
- ZSTDLIB_API size_t ZSTD_estimateCCtxSize_usingCCtxParams(const ZSTD_CCtx_params* params);
1405
- ZSTDLIB_API size_t ZSTD_estimateDCtxSize(void);
1666
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize(int compressionLevel);
1667
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize_usingCParams(ZSTD_compressionParameters cParams);
1668
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize_usingCCtxParams(const ZSTD_CCtx_params* params);
1669
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDCtxSize(void);
1406
1670
 
1407
1671
  /*! ZSTD_estimateCStreamSize() :
1408
1672
  * ZSTD_estimateCStreamSize() will provide a budget large enough for any compression level up to selected one.
@@ -1416,21 +1680,26 @@ ZSTDLIB_API size_t ZSTD_estimateDCtxSize(void);
1416
1680
  * or deducted from a valid frame Header, using ZSTD_estimateDStreamSize_fromFrame();
1417
1681
  * Note : if streaming is init with function ZSTD_init?Stream_usingDict(),
1418
1682
  * an internal ?Dict will be created, which additional size is not estimated here.
1419
- * In this case, get total size by adding ZSTD_estimate?DictSize */
1420
- ZSTDLIB_API size_t ZSTD_estimateCStreamSize(int compressionLevel);
1421
- ZSTDLIB_API size_t ZSTD_estimateCStreamSize_usingCParams(ZSTD_compressionParameters cParams);
1422
- ZSTDLIB_API size_t ZSTD_estimateCStreamSize_usingCCtxParams(const ZSTD_CCtx_params* params);
1423
- ZSTDLIB_API size_t ZSTD_estimateDStreamSize(size_t windowSize);
1424
- ZSTDLIB_API size_t ZSTD_estimateDStreamSize_fromFrame(const void* src, size_t srcSize);
1683
+ * In this case, get total size by adding ZSTD_estimate?DictSize
1684
+ * Note 2 : only single-threaded compression is supported.
1685
+ * ZSTD_estimateCStreamSize_usingCCtxParams() will return an error code if ZSTD_c_nbWorkers is >= 1.
1686
+ * Note 3 : ZSTD_estimateCStreamSize* functions are not compatible with the Block-Level Sequence Producer API at this time.
1687
+ * Size estimates assume that no external sequence producer is registered.
1688
+ */
1689
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize(int compressionLevel);
1690
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize_usingCParams(ZSTD_compressionParameters cParams);
1691
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize_usingCCtxParams(const ZSTD_CCtx_params* params);
1692
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDStreamSize(size_t windowSize);
1693
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDStreamSize_fromFrame(const void* src, size_t srcSize);
1425
1694
 
1426
1695
  /*! ZSTD_estimate?DictSize() :
1427
1696
  * ZSTD_estimateCDictSize() will bet that src size is relatively "small", and content is copied, like ZSTD_createCDict().
1428
1697
  * ZSTD_estimateCDictSize_advanced() makes it possible to control compression parameters precisely, like ZSTD_createCDict_advanced().
1429
1698
  * Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller.
1430
1699
  */
1431
- ZSTDLIB_API size_t ZSTD_estimateCDictSize(size_t dictSize, int compressionLevel);
1432
- ZSTDLIB_API size_t ZSTD_estimateCDictSize_advanced(size_t dictSize, ZSTD_compressionParameters cParams, ZSTD_dictLoadMethod_e dictLoadMethod);
1433
- ZSTDLIB_API size_t ZSTD_estimateDDictSize(size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod);
1700
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCDictSize(size_t dictSize, int compressionLevel);
1701
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCDictSize_advanced(size_t dictSize, ZSTD_compressionParameters cParams, ZSTD_dictLoadMethod_e dictLoadMethod);
1702
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDDictSize(size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod);
1434
1703
 
1435
1704
  /*! ZSTD_initStatic*() :
1436
1705
  * Initialize an object using a pre-allocated fixed-size buffer.
@@ -1453,20 +1722,20 @@ ZSTDLIB_API size_t ZSTD_estimateDDictSize(size_t dictSize, ZSTD_dictLoadMethod_e
1453
1722
  * Limitation 2 : static cctx currently not compatible with multi-threading.
1454
1723
  * Limitation 3 : static dctx is incompatible with legacy support.
1455
1724
  */
1456
- ZSTDLIB_API ZSTD_CCtx* ZSTD_initStaticCCtx(void* workspace, size_t workspaceSize);
1457
- ZSTDLIB_API ZSTD_CStream* ZSTD_initStaticCStream(void* workspace, size_t workspaceSize); /**< same as ZSTD_initStaticCCtx() */
1725
+ ZSTDLIB_STATIC_API ZSTD_CCtx* ZSTD_initStaticCCtx(void* workspace, size_t workspaceSize);
1726
+ ZSTDLIB_STATIC_API ZSTD_CStream* ZSTD_initStaticCStream(void* workspace, size_t workspaceSize); /**< same as ZSTD_initStaticCCtx() */
1458
1727
 
1459
- ZSTDLIB_API ZSTD_DCtx* ZSTD_initStaticDCtx(void* workspace, size_t workspaceSize);
1460
- ZSTDLIB_API ZSTD_DStream* ZSTD_initStaticDStream(void* workspace, size_t workspaceSize); /**< same as ZSTD_initStaticDCtx() */
1728
+ ZSTDLIB_STATIC_API ZSTD_DCtx* ZSTD_initStaticDCtx(void* workspace, size_t workspaceSize);
1729
+ ZSTDLIB_STATIC_API ZSTD_DStream* ZSTD_initStaticDStream(void* workspace, size_t workspaceSize); /**< same as ZSTD_initStaticDCtx() */
1461
1730
 
1462
- ZSTDLIB_API const ZSTD_CDict* ZSTD_initStaticCDict(
1731
+ ZSTDLIB_STATIC_API const ZSTD_CDict* ZSTD_initStaticCDict(
1463
1732
  void* workspace, size_t workspaceSize,
1464
1733
  const void* dict, size_t dictSize,
1465
1734
  ZSTD_dictLoadMethod_e dictLoadMethod,
1466
1735
  ZSTD_dictContentType_e dictContentType,
1467
1736
  ZSTD_compressionParameters cParams);
1468
1737
 
1469
- ZSTDLIB_API const ZSTD_DDict* ZSTD_initStaticDDict(
1738
+ ZSTDLIB_STATIC_API const ZSTD_DDict* ZSTD_initStaticDDict(
1470
1739
  void* workspace, size_t workspaceSize,
1471
1740
  const void* dict, size_t dictSize,
1472
1741
  ZSTD_dictLoadMethod_e dictLoadMethod,
@@ -1487,46 +1756,49 @@ __attribute__((__unused__))
1487
1756
  #endif
1488
1757
  ZSTD_customMem const ZSTD_defaultCMem = { NULL, NULL, NULL }; /**< this constant defers to stdlib's functions */
1489
1758
 
1490
- ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx_advanced(ZSTD_customMem customMem);
1491
- ZSTDLIB_API ZSTD_CStream* ZSTD_createCStream_advanced(ZSTD_customMem customMem);
1492
- ZSTDLIB_API ZSTD_DCtx* ZSTD_createDCtx_advanced(ZSTD_customMem customMem);
1493
- ZSTDLIB_API ZSTD_DStream* ZSTD_createDStream_advanced(ZSTD_customMem customMem);
1759
+ ZSTDLIB_STATIC_API ZSTD_CCtx* ZSTD_createCCtx_advanced(ZSTD_customMem customMem);
1760
+ ZSTDLIB_STATIC_API ZSTD_CStream* ZSTD_createCStream_advanced(ZSTD_customMem customMem);
1761
+ ZSTDLIB_STATIC_API ZSTD_DCtx* ZSTD_createDCtx_advanced(ZSTD_customMem customMem);
1762
+ ZSTDLIB_STATIC_API ZSTD_DStream* ZSTD_createDStream_advanced(ZSTD_customMem customMem);
1494
1763
 
1495
- ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced(const void* dict, size_t dictSize,
1764
+ ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_advanced(const void* dict, size_t dictSize,
1496
1765
  ZSTD_dictLoadMethod_e dictLoadMethod,
1497
1766
  ZSTD_dictContentType_e dictContentType,
1498
1767
  ZSTD_compressionParameters cParams,
1499
1768
  ZSTD_customMem customMem);
1500
1769
 
1501
- /* ! Thread pool :
1502
- * These prototypes make it possible to share a thread pool among multiple compression contexts.
1503
- * This can limit resources for applications with multiple threads where each one uses
1504
- * a threaded compression mode (via ZSTD_c_nbWorkers parameter).
1505
- * ZSTD_createThreadPool creates a new thread pool with a given number of threads.
1506
- * Note that the lifetime of such pool must exist while being used.
1507
- * ZSTD_CCtx_refThreadPool assigns a thread pool to a context (use NULL argument value
1508
- * to use an internal thread pool).
1509
- * ZSTD_freeThreadPool frees a thread pool.
1770
+ /*! Thread pool :
1771
+ * These prototypes make it possible to share a thread pool among multiple compression contexts.
1772
+ * This can limit resources for applications with multiple threads where each one uses
1773
+ * a threaded compression mode (via ZSTD_c_nbWorkers parameter).
1774
+ * ZSTD_createThreadPool creates a new thread pool with a given number of threads.
1775
+ * Note that the lifetime of such pool must exist while being used.
1776
+ * ZSTD_CCtx_refThreadPool assigns a thread pool to a context (use NULL argument value
1777
+ * to use an internal thread pool).
1778
+ * ZSTD_freeThreadPool frees a thread pool, accepts NULL pointer.
1510
1779
  */
1511
1780
  typedef struct POOL_ctx_s ZSTD_threadPool;
1512
- ZSTDLIB_API ZSTD_threadPool* ZSTD_createThreadPool(size_t numThreads);
1513
- ZSTDLIB_API void ZSTD_freeThreadPool (ZSTD_threadPool* pool);
1514
- ZSTDLIB_API size_t ZSTD_CCtx_refThreadPool(ZSTD_CCtx* cctx, ZSTD_threadPool* pool);
1781
+ ZSTDLIB_STATIC_API ZSTD_threadPool* ZSTD_createThreadPool(size_t numThreads);
1782
+ ZSTDLIB_STATIC_API void ZSTD_freeThreadPool (ZSTD_threadPool* pool); /* accept NULL pointer */
1783
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_refThreadPool(ZSTD_CCtx* cctx, ZSTD_threadPool* pool);
1784
+
1515
1785
 
1516
1786
  /*
1517
1787
  * This API is temporary and is expected to change or disappear in the future!
1518
1788
  */
1519
- ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced2(
1789
+ ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_advanced2(
1520
1790
  const void* dict, size_t dictSize,
1521
1791
  ZSTD_dictLoadMethod_e dictLoadMethod,
1522
1792
  ZSTD_dictContentType_e dictContentType,
1523
1793
  const ZSTD_CCtx_params* cctxParams,
1524
1794
  ZSTD_customMem customMem);
1525
1795
 
1526
- ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_advanced(const void* dict, size_t dictSize,
1527
- ZSTD_dictLoadMethod_e dictLoadMethod,
1528
- ZSTD_dictContentType_e dictContentType,
1529
- ZSTD_customMem customMem);
1796
+ ZSTDLIB_STATIC_API ZSTD_DDict* ZSTD_createDDict_advanced(
1797
+ const void* dict, size_t dictSize,
1798
+ ZSTD_dictLoadMethod_e dictLoadMethod,
1799
+ ZSTD_dictContentType_e dictContentType,
1800
+ ZSTD_customMem customMem);
1801
+
1530
1802
 
1531
1803
  /***************************************
1532
1804
  * Advanced compression functions
@@ -1538,28 +1810,22 @@ ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_advanced(const void* dict, size_t dictS
1538
1810
  * As a consequence, `dictBuffer` **must** outlive CDict,
1539
1811
  * and its content must remain unmodified throughout the lifetime of CDict.
1540
1812
  * note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef */
1541
- ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_byReference(const void* dictBuffer, size_t dictSize, int compressionLevel);
1542
-
1543
- /*! ZSTD_getDictID_fromCDict() :
1544
- * Provides the dictID of the dictionary loaded into `cdict`.
1545
- * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
1546
- * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
1547
- ZSTDLIB_API unsigned ZSTD_getDictID_fromCDict(const ZSTD_CDict* cdict);
1813
+ ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_byReference(const void* dictBuffer, size_t dictSize, int compressionLevel);
1548
1814
 
1549
1815
  /*! ZSTD_getCParams() :
1550
1816
  * @return ZSTD_compressionParameters structure for a selected compression level and estimated srcSize.
1551
1817
  * `estimatedSrcSize` value is optional, select 0 if not known */
1552
- ZSTDLIB_API ZSTD_compressionParameters ZSTD_getCParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
1818
+ ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_getCParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
1553
1819
 
1554
1820
  /*! ZSTD_getParams() :
1555
1821
  * same as ZSTD_getCParams(), but @return a full `ZSTD_parameters` object instead of sub-component `ZSTD_compressionParameters`.
1556
1822
  * All fields of `ZSTD_frameParameters` are set to default : contentSize=1, checksum=0, noDictID=0 */
1557
- ZSTDLIB_API ZSTD_parameters ZSTD_getParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
1823
+ ZSTDLIB_STATIC_API ZSTD_parameters ZSTD_getParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
1558
1824
 
1559
1825
  /*! ZSTD_checkCParams() :
1560
1826
  * Ensure param values remain within authorized range.
1561
1827
  * @return 0 on success, or an error code (can be checked with ZSTD_isError()) */
1562
- ZSTDLIB_API size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
1828
+ ZSTDLIB_STATIC_API size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
1563
1829
 
1564
1830
  /*! ZSTD_adjustCParams() :
1565
1831
  * optimize params for a given `srcSize` and `dictSize`.
@@ -1567,23 +1833,48 @@ ZSTDLIB_API size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
1567
1833
  * `dictSize` must be `0` when there is no dictionary.
1568
1834
  * cPar can be invalid : all parameters will be clamped within valid range in the @return struct.
1569
1835
  * This function never fails (wide contract) */
1570
- ZSTDLIB_API ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParameters cPar, unsigned long long srcSize, size_t dictSize);
1836
+ ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParameters cPar, unsigned long long srcSize, size_t dictSize);
1837
+
1838
+ /*! ZSTD_CCtx_setCParams() :
1839
+ * Set all parameters provided within @p cparams into the working @p cctx.
1840
+ * Note : if modifying parameters during compression (MT mode only),
1841
+ * note that changes to the .windowLog parameter will be ignored.
1842
+ * @return 0 on success, or an error code (can be checked with ZSTD_isError()).
1843
+ * On failure, no parameters are updated.
1844
+ */
1845
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setCParams(ZSTD_CCtx* cctx, ZSTD_compressionParameters cparams);
1846
+
1847
+ /*! ZSTD_CCtx_setFParams() :
1848
+ * Set all parameters provided within @p fparams into the working @p cctx.
1849
+ * @return 0 on success, or an error code (can be checked with ZSTD_isError()).
1850
+ */
1851
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setFParams(ZSTD_CCtx* cctx, ZSTD_frameParameters fparams);
1852
+
1853
+ /*! ZSTD_CCtx_setParams() :
1854
+ * Set all parameters provided within @p params into the working @p cctx.
1855
+ * @return 0 on success, or an error code (can be checked with ZSTD_isError()).
1856
+ */
1857
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setParams(ZSTD_CCtx* cctx, ZSTD_parameters params);
1571
1858
 
1572
1859
  /*! ZSTD_compress_advanced() :
1573
1860
  * Note : this function is now DEPRECATED.
1574
1861
  * It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_setParameter() and other parameter setters.
1575
- * This prototype will be marked as deprecated and generate compilation warning on reaching v1.5.x */
1576
- ZSTDLIB_API size_t ZSTD_compress_advanced(ZSTD_CCtx* cctx,
1577
- void* dst, size_t dstCapacity,
1578
- const void* src, size_t srcSize,
1579
- const void* dict,size_t dictSize,
1580
- ZSTD_parameters params);
1862
+ * This prototype will generate compilation warnings. */
1863
+ ZSTD_DEPRECATED("use ZSTD_compress2")
1864
+ ZSTDLIB_STATIC_API
1865
+ size_t ZSTD_compress_advanced(ZSTD_CCtx* cctx,
1866
+ void* dst, size_t dstCapacity,
1867
+ const void* src, size_t srcSize,
1868
+ const void* dict,size_t dictSize,
1869
+ ZSTD_parameters params);
1581
1870
 
1582
1871
  /*! ZSTD_compress_usingCDict_advanced() :
1583
- * Note : this function is now REDUNDANT.
1872
+ * Note : this function is now DEPRECATED.
1584
1873
  * It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_loadDictionary() and other parameter setters.
1585
- * This prototype will be marked as deprecated and generate compilation warning in some future version */
1586
- ZSTDLIB_API size_t ZSTD_compress_usingCDict_advanced(ZSTD_CCtx* cctx,
1874
+ * This prototype will generate compilation warnings. */
1875
+ ZSTD_DEPRECATED("use ZSTD_compress2 with ZSTD_CCtx_loadDictionary")
1876
+ ZSTDLIB_STATIC_API
1877
+ size_t ZSTD_compress_usingCDict_advanced(ZSTD_CCtx* cctx,
1587
1878
  void* dst, size_t dstCapacity,
1588
1879
  const void* src, size_t srcSize,
1589
1880
  const ZSTD_CDict* cdict,
@@ -1593,18 +1884,18 @@ ZSTDLIB_API size_t ZSTD_compress_usingCDict_advanced(ZSTD_CCtx* cctx,
1593
1884
  /*! ZSTD_CCtx_loadDictionary_byReference() :
1594
1885
  * Same as ZSTD_CCtx_loadDictionary(), but dictionary content is referenced, instead of being copied into CCtx.
1595
1886
  * It saves some memory, but also requires that `dict` outlives its usage within `cctx` */
1596
- ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary_byReference(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
1887
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_loadDictionary_byReference(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
1597
1888
 
1598
1889
  /*! ZSTD_CCtx_loadDictionary_advanced() :
1599
1890
  * Same as ZSTD_CCtx_loadDictionary(), but gives finer control over
1600
1891
  * how to load the dictionary (by copy ? by reference ?)
1601
1892
  * and how to interpret it (automatic ? force raw mode ? full mode only ?) */
1602
- ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod, ZSTD_dictContentType_e dictContentType);
1893
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_loadDictionary_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod, ZSTD_dictContentType_e dictContentType);
1603
1894
 
1604
1895
  /*! ZSTD_CCtx_refPrefix_advanced() :
1605
1896
  * Same as ZSTD_CCtx_refPrefix(), but gives finer control over
1606
1897
  * how to interpret prefix content (automatic ? force raw mode (default) ? full mode only ?) */
1607
- ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType);
1898
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType);
1608
1899
 
1609
1900
  /* === experimental parameters === */
1610
1901
  /* these parameters can be used with ZSTD_setParameter()
@@ -1643,9 +1934,15 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
1643
1934
  * See the comments on that enum for an explanation of the feature. */
1644
1935
  #define ZSTD_c_forceAttachDict ZSTD_c_experimentalParam4
1645
1936
 
1646
- /* Controls how the literals are compressed (default is auto).
1647
- * The value must be of type ZSTD_literalCompressionMode_e.
1648
- * See ZSTD_literalCompressionMode_t enum definition for details.
1937
+ /* Controlled with ZSTD_paramSwitch_e enum.
1938
+ * Default is ZSTD_ps_auto.
1939
+ * Set to ZSTD_ps_disable to never compress literals.
1940
+ * Set to ZSTD_ps_enable to always compress literals. (Note: uncompressed literals
1941
+ * may still be emitted if huffman is not beneficial to use.)
1942
+ *
1943
+ * By default, in ZSTD_ps_auto, the library will decide at runtime whether to use
1944
+ * literals compression based on the compression parameters - specifically,
1945
+ * negative compression levels do not use literal compression.
1649
1946
  */
1650
1947
  #define ZSTD_c_literalCompressionMode ZSTD_c_experimentalParam5
1651
1948
 
@@ -1708,7 +2005,7 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
1708
2005
  *
1709
2006
  * Note that this means that the CDict tables can no longer be copied into the
1710
2007
  * CCtx, so the dict attachment mode ZSTD_dictForceCopy will no longer be
1711
- * useable. The dictionary can only be attached or reloaded.
2008
+ * usable. The dictionary can only be attached or reloaded.
1712
2009
  *
1713
2010
  * In general, you should expect compression to be faster--sometimes very much
1714
2011
  * so--and CDict creation to be slightly slower. Eventually, we will probably
@@ -1720,13 +2017,16 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
1720
2017
  * Experimental parameter.
1721
2018
  * Default is 0 == disabled. Set to 1 to enable.
1722
2019
  *
1723
- * Tells the compressor that the ZSTD_inBuffer will ALWAYS be the same
1724
- * between calls, except for the modifications that zstd makes to pos (the
1725
- * caller must not modify pos). This is checked by the compressor, and
1726
- * compression will fail if it ever changes. This means the only flush
1727
- * mode that makes sense is ZSTD_e_end, so zstd will error if ZSTD_e_end
1728
- * is not used. The data in the ZSTD_inBuffer in the range [src, src + pos)
1729
- * MUST not be modified during compression or you will get data corruption.
2020
+ * Tells the compressor that input data presented with ZSTD_inBuffer
2021
+ * will ALWAYS be the same between calls.
2022
+ * Technically, the @src pointer must never be changed,
2023
+ * and the @pos field can only be updated by zstd.
2024
+ * However, it's possible to increase the @size field,
2025
+ * allowing scenarios where more data can be appended after compressions starts.
2026
+ * These conditions are checked by the compressor,
2027
+ * and compression will fail if they are not respected.
2028
+ * Also, data in the ZSTD_inBuffer within the range [src, src + pos)
2029
+ * MUST not be modified during compression or it will result in data corruption.
1730
2030
  *
1731
2031
  * When this flag is enabled zstd won't allocate an input window buffer,
1732
2032
  * because the user guarantees it can reference the ZSTD_inBuffer until
@@ -1734,18 +2034,15 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
1734
2034
  * large enough to fit a block (see ZSTD_c_stableOutBuffer). This will also
1735
2035
  * avoid the memcpy() from the input buffer to the input window buffer.
1736
2036
  *
1737
- * NOTE: ZSTD_compressStream2() will error if ZSTD_e_end is not used.
1738
- * That means this flag cannot be used with ZSTD_compressStream().
1739
- *
1740
2037
  * NOTE: So long as the ZSTD_inBuffer always points to valid memory, using
1741
2038
  * this flag is ALWAYS memory safe, and will never access out-of-bounds
1742
- * memory. However, compression WILL fail if you violate the preconditions.
2039
+ * memory. However, compression WILL fail if conditions are not respected.
1743
2040
  *
1744
- * WARNING: The data in the ZSTD_inBuffer in the range [dst, dst + pos) MUST
1745
- * not be modified during compression or you will get data corruption. This
1746
- * is because zstd needs to reference data in the ZSTD_inBuffer to find
2041
+ * WARNING: The data in the ZSTD_inBuffer in the range [src, src + pos) MUST
2042
+ * not be modified during compression or it will result in data corruption.
2043
+ * This is because zstd needs to reference data in the ZSTD_inBuffer to find
1747
2044
  * matches. Normally zstd maintains its own window buffer for this purpose,
1748
- * but passing this flag tells zstd to use the user provided buffer.
2045
+ * but passing this flag tells zstd to rely on user provided buffer instead.
1749
2046
  */
1750
2047
  #define ZSTD_c_stableInBuffer ZSTD_c_experimentalParam9
1751
2048
 
@@ -1790,19 +2087,135 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
1790
2087
  * Without validation, providing a sequence that does not conform to the zstd spec will cause
1791
2088
  * undefined behavior, and may produce a corrupted block.
1792
2089
  *
1793
- * With validation enabled, a if sequence is invalid (see doc/zstd_compression_format.md for
2090
+ * With validation enabled, if sequence is invalid (see doc/zstd_compression_format.md for
1794
2091
  * specifics regarding offset/matchlength requirements) then the function will bail out and
1795
2092
  * return an error.
1796
2093
  *
1797
2094
  */
1798
2095
  #define ZSTD_c_validateSequences ZSTD_c_experimentalParam12
1799
2096
 
2097
+ /* ZSTD_c_useBlockSplitter
2098
+ * Controlled with ZSTD_paramSwitch_e enum.
2099
+ * Default is ZSTD_ps_auto.
2100
+ * Set to ZSTD_ps_disable to never use block splitter.
2101
+ * Set to ZSTD_ps_enable to always use block splitter.
2102
+ *
2103
+ * By default, in ZSTD_ps_auto, the library will decide at runtime whether to use
2104
+ * block splitting based on the compression parameters.
2105
+ */
2106
+ #define ZSTD_c_useBlockSplitter ZSTD_c_experimentalParam13
2107
+
2108
+ /* ZSTD_c_useRowMatchFinder
2109
+ * Controlled with ZSTD_paramSwitch_e enum.
2110
+ * Default is ZSTD_ps_auto.
2111
+ * Set to ZSTD_ps_disable to never use row-based matchfinder.
2112
+ * Set to ZSTD_ps_enable to force usage of row-based matchfinder.
2113
+ *
2114
+ * By default, in ZSTD_ps_auto, the library will decide at runtime whether to use
2115
+ * the row-based matchfinder based on support for SIMD instructions and the window log.
2116
+ * Note that this only pertains to compression strategies: greedy, lazy, and lazy2
2117
+ */
2118
+ #define ZSTD_c_useRowMatchFinder ZSTD_c_experimentalParam14
2119
+
2120
+ /* ZSTD_c_deterministicRefPrefix
2121
+ * Default is 0 == disabled. Set to 1 to enable.
2122
+ *
2123
+ * Zstd produces different results for prefix compression when the prefix is
2124
+ * directly adjacent to the data about to be compressed vs. when it isn't.
2125
+ * This is because zstd detects that the two buffers are contiguous and it can
2126
+ * use a more efficient match finding algorithm. However, this produces different
2127
+ * results than when the two buffers are non-contiguous. This flag forces zstd
2128
+ * to always load the prefix in non-contiguous mode, even if it happens to be
2129
+ * adjacent to the data, to guarantee determinism.
2130
+ *
2131
+ * If you really care about determinism when using a dictionary or prefix,
2132
+ * like when doing delta compression, you should select this option. It comes
2133
+ * at a speed penalty of about ~2.5% if the dictionary and data happened to be
2134
+ * contiguous, and is free if they weren't contiguous. We don't expect that
2135
+ * intentionally making the dictionary and data contiguous will be worth the
2136
+ * cost to memcpy() the data.
2137
+ */
2138
+ #define ZSTD_c_deterministicRefPrefix ZSTD_c_experimentalParam15
2139
+
2140
+ /* ZSTD_c_prefetchCDictTables
2141
+ * Controlled with ZSTD_paramSwitch_e enum. Default is ZSTD_ps_auto.
2142
+ *
2143
+ * In some situations, zstd uses CDict tables in-place rather than copying them
2144
+ * into the working context. (See docs on ZSTD_dictAttachPref_e above for details).
2145
+ * In such situations, compression speed is seriously impacted when CDict tables are
2146
+ * "cold" (outside CPU cache). This parameter instructs zstd to prefetch CDict tables
2147
+ * when they are used in-place.
2148
+ *
2149
+ * For sufficiently small inputs, the cost of the prefetch will outweigh the benefit.
2150
+ * For sufficiently large inputs, zstd will by default memcpy() CDict tables
2151
+ * into the working context, so there is no need to prefetch. This parameter is
2152
+ * targeted at a middle range of input sizes, where a prefetch is cheap enough to be
2153
+ * useful but memcpy() is too expensive. The exact range of input sizes where this
2154
+ * makes sense is best determined by careful experimentation.
2155
+ *
2156
+ * Note: for this parameter, ZSTD_ps_auto is currently equivalent to ZSTD_ps_disable,
2157
+ * but in the future zstd may conditionally enable this feature via an auto-detection
2158
+ * heuristic for cold CDicts.
2159
+ * Use ZSTD_ps_disable to opt out of prefetching under any circumstances.
2160
+ */
2161
+ #define ZSTD_c_prefetchCDictTables ZSTD_c_experimentalParam16
2162
+
2163
+ /* ZSTD_c_enableSeqProducerFallback
2164
+ * Allowed values are 0 (disable) and 1 (enable). The default setting is 0.
2165
+ *
2166
+ * Controls whether zstd will fall back to an internal sequence producer if an
2167
+ * external sequence producer is registered and returns an error code. This fallback
2168
+ * is block-by-block: the internal sequence producer will only be called for blocks
2169
+ * where the external sequence producer returns an error code. Fallback parsing will
2170
+ * follow any other cParam settings, such as compression level, the same as in a
2171
+ * normal (fully-internal) compression operation.
2172
+ *
2173
+ * The user is strongly encouraged to read the full Block-Level Sequence Producer API
2174
+ * documentation (below) before setting this parameter. */
2175
+ #define ZSTD_c_enableSeqProducerFallback ZSTD_c_experimentalParam17
2176
+
2177
+ /* ZSTD_c_maxBlockSize
2178
+ * Allowed values are between 1KB and ZSTD_BLOCKSIZE_MAX (128KB).
2179
+ * The default is ZSTD_BLOCKSIZE_MAX, and setting to 0 will set to the default.
2180
+ *
2181
+ * This parameter can be used to set an upper bound on the blocksize
2182
+ * that overrides the default ZSTD_BLOCKSIZE_MAX. It cannot be used to set upper
2183
+ * bounds greater than ZSTD_BLOCKSIZE_MAX or bounds lower than 1KB (will make
2184
+ * compressBound() inaccurate). Only currently meant to be used for testing.
2185
+ *
2186
+ */
2187
+ #define ZSTD_c_maxBlockSize ZSTD_c_experimentalParam18
2188
+
2189
+ /* ZSTD_c_searchForExternalRepcodes
2190
+ * This parameter affects how zstd parses external sequences, such as sequences
2191
+ * provided through the compressSequences() API or from an external block-level
2192
+ * sequence producer.
2193
+ *
2194
+ * If set to ZSTD_ps_enable, the library will check for repeated offsets in
2195
+ * external sequences, even if those repcodes are not explicitly indicated in
2196
+ * the "rep" field. Note that this is the only way to exploit repcode matches
2197
+ * while using compressSequences() or an external sequence producer, since zstd
2198
+ * currently ignores the "rep" field of external sequences.
2199
+ *
2200
+ * If set to ZSTD_ps_disable, the library will not exploit repeated offsets in
2201
+ * external sequences, regardless of whether the "rep" field has been set. This
2202
+ * reduces sequence compression overhead by about 25% while sacrificing some
2203
+ * compression ratio.
2204
+ *
2205
+ * The default value is ZSTD_ps_auto, for which the library will enable/disable
2206
+ * based on compression level.
2207
+ *
2208
+ * Note: for now, this param only has an effect if ZSTD_c_blockDelimiters is
2209
+ * set to ZSTD_sf_explicitBlockDelimiters. That may change in the future.
2210
+ */
2211
+ #define ZSTD_c_searchForExternalRepcodes ZSTD_c_experimentalParam19
2212
+
1800
2213
  /*! ZSTD_CCtx_getParameter() :
1801
2214
  * Get the requested compression parameter value, selected by enum ZSTD_cParameter,
1802
2215
  * and store it into int* value.
1803
2216
  * @return : 0, or an error code (which can be tested with ZSTD_isError()).
1804
2217
  */
1805
- ZSTDLIB_API size_t ZSTD_CCtx_getParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param, int* value);
2218
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_getParameter(const ZSTD_CCtx* cctx, ZSTD_cParameter param, int* value);
1806
2219
 
1807
2220
 
1808
2221
  /*! ZSTD_CCtx_params :
@@ -1817,32 +2230,32 @@ ZSTDLIB_API size_t ZSTD_CCtx_getParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param
1817
2230
  * These parameters will be applied to
1818
2231
  * all subsequent frames.
1819
2232
  * - ZSTD_compressStream2() : Do compression using the CCtx.
1820
- * - ZSTD_freeCCtxParams() : Free the memory.
2233
+ * - ZSTD_freeCCtxParams() : Free the memory, accept NULL pointer.
1821
2234
  *
1822
2235
  * This can be used with ZSTD_estimateCCtxSize_advanced_usingCCtxParams()
1823
2236
  * for static allocation of CCtx for single-threaded compression.
1824
2237
  */
1825
- ZSTDLIB_API ZSTD_CCtx_params* ZSTD_createCCtxParams(void);
1826
- ZSTDLIB_API size_t ZSTD_freeCCtxParams(ZSTD_CCtx_params* params);
2238
+ ZSTDLIB_STATIC_API ZSTD_CCtx_params* ZSTD_createCCtxParams(void);
2239
+ ZSTDLIB_STATIC_API size_t ZSTD_freeCCtxParams(ZSTD_CCtx_params* params); /* accept NULL pointer */
1827
2240
 
1828
2241
  /*! ZSTD_CCtxParams_reset() :
1829
2242
  * Reset params to default values.
1830
2243
  */
1831
- ZSTDLIB_API size_t ZSTD_CCtxParams_reset(ZSTD_CCtx_params* params);
2244
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_reset(ZSTD_CCtx_params* params);
1832
2245
 
1833
2246
  /*! ZSTD_CCtxParams_init() :
1834
2247
  * Initializes the compression parameters of cctxParams according to
1835
2248
  * compression level. All other parameters are reset to their default values.
1836
2249
  */
1837
- ZSTDLIB_API size_t ZSTD_CCtxParams_init(ZSTD_CCtx_params* cctxParams, int compressionLevel);
2250
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_init(ZSTD_CCtx_params* cctxParams, int compressionLevel);
1838
2251
 
1839
2252
  /*! ZSTD_CCtxParams_init_advanced() :
1840
2253
  * Initializes the compression and frame parameters of cctxParams according to
1841
2254
  * params. All other parameters are reset to their default values.
1842
2255
  */
1843
- ZSTDLIB_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, ZSTD_parameters params);
2256
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, ZSTD_parameters params);
1844
2257
 
1845
- /*! ZSTD_CCtxParams_setParameter() :
2258
+ /*! ZSTD_CCtxParams_setParameter() : Requires v1.4.0+
1846
2259
  * Similar to ZSTD_CCtx_setParameter.
1847
2260
  * Set one compression parameter, selected by enum ZSTD_cParameter.
1848
2261
  * Parameters must be applied to a ZSTD_CCtx using
@@ -1850,14 +2263,14 @@ ZSTDLIB_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, Z
1850
2263
  * @result : a code representing success or failure (which can be tested with
1851
2264
  * ZSTD_isError()).
1852
2265
  */
1853
- ZSTDLIB_API size_t ZSTD_CCtxParams_setParameter(ZSTD_CCtx_params* params, ZSTD_cParameter param, int value);
2266
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_setParameter(ZSTD_CCtx_params* params, ZSTD_cParameter param, int value);
1854
2267
 
1855
2268
  /*! ZSTD_CCtxParams_getParameter() :
1856
2269
  * Similar to ZSTD_CCtx_getParameter.
1857
2270
  * Get the requested value of one compression parameter, selected by enum ZSTD_cParameter.
1858
2271
  * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1859
2272
  */
1860
- ZSTDLIB_API size_t ZSTD_CCtxParams_getParameter(ZSTD_CCtx_params* params, ZSTD_cParameter param, int* value);
2273
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_getParameter(const ZSTD_CCtx_params* params, ZSTD_cParameter param, int* value);
1861
2274
 
1862
2275
  /*! ZSTD_CCtx_setParametersUsingCCtxParams() :
1863
2276
  * Apply a set of ZSTD_CCtx_params to the compression context.
@@ -1866,7 +2279,7 @@ ZSTDLIB_API size_t ZSTD_CCtxParams_getParameter(ZSTD_CCtx_params* params, ZSTD_c
1866
2279
  * if nbWorkers>=1, new parameters will be picked up at next job,
1867
2280
  * with a few restrictions (windowLog, pledgedSrcSize, nbWorkers, jobSize, and overlapLog are not updated).
1868
2281
  */
1869
- ZSTDLIB_API size_t ZSTD_CCtx_setParametersUsingCCtxParams(
2282
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setParametersUsingCCtxParams(
1870
2283
  ZSTD_CCtx* cctx, const ZSTD_CCtx_params* params);
1871
2284
 
1872
2285
  /*! ZSTD_compressStream2_simpleArgs() :
@@ -1875,7 +2288,7 @@ ZSTDLIB_API size_t ZSTD_CCtx_setParametersUsingCCtxParams(
1875
2288
  * This variant might be helpful for binders from dynamic languages
1876
2289
  * which have troubles handling structures containing memory pointers.
1877
2290
  */
1878
- ZSTDLIB_API size_t ZSTD_compressStream2_simpleArgs (
2291
+ ZSTDLIB_STATIC_API size_t ZSTD_compressStream2_simpleArgs (
1879
2292
  ZSTD_CCtx* cctx,
1880
2293
  void* dst, size_t dstCapacity, size_t* dstPos,
1881
2294
  const void* src, size_t srcSize, size_t* srcPos,
@@ -1891,33 +2304,33 @@ ZSTDLIB_API size_t ZSTD_compressStream2_simpleArgs (
1891
2304
  * Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
1892
2305
  * Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
1893
2306
  * Note 3 : Skippable Frame Identifiers are considered valid. */
1894
- ZSTDLIB_API unsigned ZSTD_isFrame(const void* buffer, size_t size);
2307
+ ZSTDLIB_STATIC_API unsigned ZSTD_isFrame(const void* buffer, size_t size);
1895
2308
 
1896
2309
  /*! ZSTD_createDDict_byReference() :
1897
2310
  * Create a digested dictionary, ready to start decompression operation without startup delay.
1898
2311
  * Dictionary content is referenced, and therefore stays in dictBuffer.
1899
2312
  * It is important that dictBuffer outlives DDict,
1900
2313
  * it must remain read accessible throughout the lifetime of DDict */
1901
- ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_byReference(const void* dictBuffer, size_t dictSize);
2314
+ ZSTDLIB_STATIC_API ZSTD_DDict* ZSTD_createDDict_byReference(const void* dictBuffer, size_t dictSize);
1902
2315
 
1903
2316
  /*! ZSTD_DCtx_loadDictionary_byReference() :
1904
2317
  * Same as ZSTD_DCtx_loadDictionary(),
1905
2318
  * but references `dict` content instead of copying it into `dctx`.
1906
2319
  * This saves memory if `dict` remains around.,
1907
2320
  * However, it's imperative that `dict` remains accessible (and unmodified) while being used, so it must outlive decompression. */
1908
- ZSTDLIB_API size_t ZSTD_DCtx_loadDictionary_byReference(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
2321
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_loadDictionary_byReference(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
1909
2322
 
1910
2323
  /*! ZSTD_DCtx_loadDictionary_advanced() :
1911
2324
  * Same as ZSTD_DCtx_loadDictionary(),
1912
2325
  * but gives direct control over
1913
2326
  * how to load the dictionary (by copy ? by reference ?)
1914
2327
  * and how to interpret it (automatic ? force raw mode ? full mode only ?). */
1915
- ZSTDLIB_API size_t ZSTD_DCtx_loadDictionary_advanced(ZSTD_DCtx* dctx, const void* dict, size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod, ZSTD_dictContentType_e dictContentType);
2328
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_loadDictionary_advanced(ZSTD_DCtx* dctx, const void* dict, size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod, ZSTD_dictContentType_e dictContentType);
1916
2329
 
1917
2330
  /*! ZSTD_DCtx_refPrefix_advanced() :
1918
2331
  * Same as ZSTD_DCtx_refPrefix(), but gives finer control over
1919
2332
  * how to interpret prefix content (automatic ? force raw mode (default) ? full mode only ?) */
1920
- ZSTDLIB_API size_t ZSTD_DCtx_refPrefix_advanced(ZSTD_DCtx* dctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType);
2333
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_refPrefix_advanced(ZSTD_DCtx* dctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType);
1921
2334
 
1922
2335
  /*! ZSTD_DCtx_setMaxWindowSize() :
1923
2336
  * Refuses allocating internal buffers for frames requiring a window size larger than provided limit.
@@ -1926,14 +2339,14 @@ ZSTDLIB_API size_t ZSTD_DCtx_refPrefix_advanced(ZSTD_DCtx* dctx, const void* pre
1926
2339
  * By default, a decompression context accepts all window sizes <= (1 << ZSTD_WINDOWLOG_LIMIT_DEFAULT)
1927
2340
  * @return : 0, or an error code (which can be tested using ZSTD_isError()).
1928
2341
  */
1929
- ZSTDLIB_API size_t ZSTD_DCtx_setMaxWindowSize(ZSTD_DCtx* dctx, size_t maxWindowSize);
2342
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_setMaxWindowSize(ZSTD_DCtx* dctx, size_t maxWindowSize);
1930
2343
 
1931
2344
  /*! ZSTD_DCtx_getParameter() :
1932
2345
  * Get the requested decompression parameter value, selected by enum ZSTD_dParameter,
1933
2346
  * and store it into int* value.
1934
2347
  * @return : 0, or an error code (which can be tested with ZSTD_isError()).
1935
2348
  */
1936
- ZSTDLIB_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, int* value);
2349
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, int* value);
1937
2350
 
1938
2351
  /* ZSTD_d_format
1939
2352
  * experimental parameter,
@@ -1953,7 +2366,7 @@ ZSTDLIB_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param
1953
2366
  * in the range [dst, dst + pos) MUST not be modified during decompression
1954
2367
  * or you will get data corruption.
1955
2368
  *
1956
- * When this flags is enabled zstd won't allocate an output buffer, because
2369
+ * When this flag is enabled zstd won't allocate an output buffer, because
1957
2370
  * it can write directly to the ZSTD_outBuffer, but it will still allocate
1958
2371
  * an input buffer large enough to fit any compressed block. This will also
1959
2372
  * avoid the memcpy() from the internal output buffer to the ZSTD_outBuffer.
@@ -1983,12 +2396,50 @@ ZSTDLIB_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param
1983
2396
  */
1984
2397
  #define ZSTD_d_forceIgnoreChecksum ZSTD_d_experimentalParam3
1985
2398
 
2399
+ /* ZSTD_d_refMultipleDDicts
2400
+ * Experimental parameter.
2401
+ * Default is 0 == disabled. Set to 1 to enable
2402
+ *
2403
+ * If enabled and dctx is allocated on the heap, then additional memory will be allocated
2404
+ * to store references to multiple ZSTD_DDict. That is, multiple calls of ZSTD_refDDict()
2405
+ * using a given ZSTD_DCtx, rather than overwriting the previous DDict reference, will instead
2406
+ * store all references. At decompression time, the appropriate dictID is selected
2407
+ * from the set of DDicts based on the dictID in the frame.
2408
+ *
2409
+ * Usage is simply calling ZSTD_refDDict() on multiple dict buffers.
2410
+ *
2411
+ * Param has values of byte ZSTD_refMultipleDDicts_e
2412
+ *
2413
+ * WARNING: Enabling this parameter and calling ZSTD_DCtx_refDDict(), will trigger memory
2414
+ * allocation for the hash table. ZSTD_freeDCtx() also frees this memory.
2415
+ * Memory is allocated as per ZSTD_DCtx::customMem.
2416
+ *
2417
+ * Although this function allocates memory for the table, the user is still responsible for
2418
+ * memory management of the underlying ZSTD_DDict* themselves.
2419
+ */
2420
+ #define ZSTD_d_refMultipleDDicts ZSTD_d_experimentalParam4
2421
+
2422
+ /* ZSTD_d_disableHuffmanAssembly
2423
+ * Set to 1 to disable the Huffman assembly implementation.
2424
+ * The default value is 0, which allows zstd to use the Huffman assembly
2425
+ * implementation if available.
2426
+ *
2427
+ * This parameter can be used to disable Huffman assembly at runtime.
2428
+ * If you want to disable it at compile time you can define the macro
2429
+ * ZSTD_DISABLE_ASM.
2430
+ */
2431
+ #define ZSTD_d_disableHuffmanAssembly ZSTD_d_experimentalParam5
2432
+
2433
+
1986
2434
  /*! ZSTD_DCtx_setFormat() :
2435
+ * This function is REDUNDANT. Prefer ZSTD_DCtx_setParameter().
1987
2436
  * Instruct the decoder context about what kind of data to decode next.
1988
2437
  * This instruction is mandatory to decode data without a fully-formed header,
1989
2438
  * such ZSTD_f_zstd1_magicless for example.
1990
2439
  * @return : 0, or an error code (which can be tested using ZSTD_isError()). */
1991
- ZSTDLIB_API size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format);
2440
+ ZSTD_DEPRECATED("use ZSTD_DCtx_setParameter() instead")
2441
+ ZSTDLIB_STATIC_API
2442
+ size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format);
1992
2443
 
1993
2444
  /*! ZSTD_decompressStream_simpleArgs() :
1994
2445
  * Same as ZSTD_decompressStream(),
@@ -1996,7 +2447,7 @@ ZSTDLIB_API size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format);
1996
2447
  * This can be helpful for binders from dynamic languages
1997
2448
  * which have troubles handling structures containing memory pointers.
1998
2449
  */
1999
- ZSTDLIB_API size_t ZSTD_decompressStream_simpleArgs (
2450
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressStream_simpleArgs (
2000
2451
  ZSTD_DCtx* dctx,
2001
2452
  void* dst, size_t dstCapacity, size_t* dstPos,
2002
2453
  const void* src, size_t srcSize, size_t* srcPos);
@@ -2012,7 +2463,7 @@ ZSTDLIB_API size_t ZSTD_decompressStream_simpleArgs (
2012
2463
  /*===== Advanced Streaming compression functions =====*/
2013
2464
 
2014
2465
  /*! ZSTD_initCStream_srcSize() :
2015
- * This function is deprecated, and equivalent to:
2466
+ * This function is DEPRECATED, and equivalent to:
2016
2467
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2017
2468
  * ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)
2018
2469
  * ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
@@ -2021,15 +2472,16 @@ ZSTDLIB_API size_t ZSTD_decompressStream_simpleArgs (
2021
2472
  * pledgedSrcSize must be correct. If it is not known at init time, use
2022
2473
  * ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
2023
2474
  * "0" also disables frame content size field. It may be enabled in the future.
2024
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2475
+ * This prototype will generate compilation warnings.
2025
2476
  */
2026
- ZSTDLIB_API size_t
2027
- ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
2477
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2478
+ ZSTDLIB_STATIC_API
2479
+ size_t ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
2028
2480
  int compressionLevel,
2029
2481
  unsigned long long pledgedSrcSize);
2030
2482
 
2031
2483
  /*! ZSTD_initCStream_usingDict() :
2032
- * This function is deprecated, and is equivalent to:
2484
+ * This function is DEPRECATED, and is equivalent to:
2033
2485
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2034
2486
  * ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
2035
2487
  * ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);
@@ -2038,69 +2490,71 @@ ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
2038
2490
  * dict == NULL or dictSize < 8, in which case no dict is used.
2039
2491
  * Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
2040
2492
  * it begins with ZSTD_MAGIC_DICTIONARY, else as raw content) and ZSTD_dlm_byCopy.
2041
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2493
+ * This prototype will generate compilation warnings.
2042
2494
  */
2043
- ZSTDLIB_API size_t
2044
- ZSTD_initCStream_usingDict(ZSTD_CStream* zcs,
2495
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2496
+ ZSTDLIB_STATIC_API
2497
+ size_t ZSTD_initCStream_usingDict(ZSTD_CStream* zcs,
2045
2498
  const void* dict, size_t dictSize,
2046
2499
  int compressionLevel);
2047
2500
 
2048
2501
  /*! ZSTD_initCStream_advanced() :
2049
- * This function is deprecated, and is approximately equivalent to:
2502
+ * This function is DEPRECATED, and is equivalent to:
2050
2503
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2051
- * // Pseudocode: Set each zstd parameter and leave the rest as-is.
2052
- * for ((param, value) : params) {
2053
- * ZSTD_CCtx_setParameter(zcs, param, value);
2054
- * }
2504
+ * ZSTD_CCtx_setParams(zcs, params);
2055
2505
  * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2056
2506
  * ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);
2057
2507
  *
2058
2508
  * dict is loaded with ZSTD_dct_auto and ZSTD_dlm_byCopy.
2059
2509
  * pledgedSrcSize must be correct.
2060
2510
  * If srcSize is not known at init time, use value ZSTD_CONTENTSIZE_UNKNOWN.
2061
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2511
+ * This prototype will generate compilation warnings.
2062
2512
  */
2063
- ZSTDLIB_API size_t
2064
- ZSTD_initCStream_advanced(ZSTD_CStream* zcs,
2513
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2514
+ ZSTDLIB_STATIC_API
2515
+ size_t ZSTD_initCStream_advanced(ZSTD_CStream* zcs,
2065
2516
  const void* dict, size_t dictSize,
2066
2517
  ZSTD_parameters params,
2067
2518
  unsigned long long pledgedSrcSize);
2068
2519
 
2069
2520
  /*! ZSTD_initCStream_usingCDict() :
2070
- * This function is deprecated, and equivalent to:
2521
+ * This function is DEPRECATED, and equivalent to:
2071
2522
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2072
2523
  * ZSTD_CCtx_refCDict(zcs, cdict);
2073
2524
  *
2074
2525
  * note : cdict will just be referenced, and must outlive compression session
2075
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2526
+ * This prototype will generate compilation warnings.
2076
2527
  */
2077
- ZSTDLIB_API size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDict* cdict);
2528
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instructions")
2529
+ ZSTDLIB_STATIC_API
2530
+ size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDict* cdict);
2078
2531
 
2079
2532
  /*! ZSTD_initCStream_usingCDict_advanced() :
2080
- * This function is DEPRECATED, and is approximately equivalent to:
2533
+ * This function is DEPRECATED, and is equivalent to:
2081
2534
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2082
- * // Pseudocode: Set each zstd frame parameter and leave the rest as-is.
2083
- * for ((fParam, value) : fParams) {
2084
- * ZSTD_CCtx_setParameter(zcs, fParam, value);
2085
- * }
2535
+ * ZSTD_CCtx_setFParams(zcs, fParams);
2086
2536
  * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2087
2537
  * ZSTD_CCtx_refCDict(zcs, cdict);
2088
2538
  *
2089
2539
  * same as ZSTD_initCStream_usingCDict(), with control over frame parameters.
2090
2540
  * pledgedSrcSize must be correct. If srcSize is not known at init time, use
2091
2541
  * value ZSTD_CONTENTSIZE_UNKNOWN.
2092
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2542
+ * This prototype will generate compilation warnings.
2093
2543
  */
2094
- ZSTDLIB_API size_t
2095
- ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
2544
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instructions")
2545
+ ZSTDLIB_STATIC_API
2546
+ size_t ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
2096
2547
  const ZSTD_CDict* cdict,
2097
2548
  ZSTD_frameParameters fParams,
2098
2549
  unsigned long long pledgedSrcSize);
2099
2550
 
2100
2551
  /*! ZSTD_resetCStream() :
2101
- * This function is deprecated, and is equivalent to:
2552
+ * This function is DEPRECATED, and is equivalent to:
2102
2553
  * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2103
2554
  * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2555
+ * Note: ZSTD_resetCStream() interprets pledgedSrcSize == 0 as ZSTD_CONTENTSIZE_UNKNOWN, but
2556
+ * ZSTD_CCtx_setPledgedSrcSize() does not do the same, so ZSTD_CONTENTSIZE_UNKNOWN must be
2557
+ * explicitly specified.
2104
2558
  *
2105
2559
  * start a new frame, using same parameters from previous frame.
2106
2560
  * This is typically useful to skip dictionary loading stage, since it will re-use it in-place.
@@ -2110,9 +2564,11 @@ ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
2110
2564
  * For the time being, pledgedSrcSize==0 is interpreted as "srcSize unknown" for compatibility with older programs,
2111
2565
  * but it will change to mean "empty" in future version, so use macro ZSTD_CONTENTSIZE_UNKNOWN instead.
2112
2566
  * @return : 0, or an error code (which can be tested using ZSTD_isError())
2113
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2567
+ * This prototype will generate compilation warnings.
2114
2568
  */
2115
- ZSTDLIB_API size_t ZSTD_resetCStream(ZSTD_CStream* zcs, unsigned long long pledgedSrcSize);
2569
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2570
+ ZSTDLIB_STATIC_API
2571
+ size_t ZSTD_resetCStream(ZSTD_CStream* zcs, unsigned long long pledgedSrcSize);
2116
2572
 
2117
2573
 
2118
2574
  typedef struct {
@@ -2130,7 +2586,7 @@ typedef struct {
2130
2586
  * Note : (ingested - consumed) is amount of input data buffered internally, not yet compressed.
2131
2587
  * Aggregates progression inside active worker threads.
2132
2588
  */
2133
- ZSTDLIB_API ZSTD_frameProgression ZSTD_getFrameProgression(const ZSTD_CCtx* cctx);
2589
+ ZSTDLIB_STATIC_API ZSTD_frameProgression ZSTD_getFrameProgression(const ZSTD_CCtx* cctx);
2134
2590
 
2135
2591
  /*! ZSTD_toFlushNow() :
2136
2592
  * Tell how many bytes are ready to be flushed immediately.
@@ -2145,7 +2601,7 @@ ZSTDLIB_API ZSTD_frameProgression ZSTD_getFrameProgression(const ZSTD_CCtx* cctx
2145
2601
  * therefore flush speed is limited by production speed of oldest job
2146
2602
  * irrespective of the speed of concurrent (and newer) jobs.
2147
2603
  */
2148
- ZSTDLIB_API size_t ZSTD_toFlushNow(ZSTD_CCtx* cctx);
2604
+ ZSTDLIB_STATIC_API size_t ZSTD_toFlushNow(ZSTD_CCtx* cctx);
2149
2605
 
2150
2606
 
2151
2607
  /*===== Advanced Streaming decompression functions =====*/
@@ -2157,9 +2613,9 @@ ZSTDLIB_API size_t ZSTD_toFlushNow(ZSTD_CCtx* cctx);
2157
2613
  * ZSTD_DCtx_loadDictionary(zds, dict, dictSize);
2158
2614
  *
2159
2615
  * note: no dictionary will be used if dict == NULL or dictSize < 8
2160
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2161
2616
  */
2162
- ZSTDLIB_API size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dict, size_t dictSize);
2617
+ ZSTD_DEPRECATED("use ZSTD_DCtx_reset + ZSTD_DCtx_loadDictionary, see zstd.h for detailed instructions")
2618
+ ZSTDLIB_STATIC_API size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dict, size_t dictSize);
2163
2619
 
2164
2620
  /*!
2165
2621
  * This function is deprecated, and is equivalent to:
@@ -2168,9 +2624,9 @@ ZSTDLIB_API size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dic
2168
2624
  * ZSTD_DCtx_refDDict(zds, ddict);
2169
2625
  *
2170
2626
  * note : ddict is referenced, it must outlive decompression session
2171
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2172
2627
  */
2173
- ZSTDLIB_API size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* zds, const ZSTD_DDict* ddict);
2628
+ ZSTD_DEPRECATED("use ZSTD_DCtx_reset + ZSTD_DCtx_refDDict, see zstd.h for detailed instructions")
2629
+ ZSTDLIB_STATIC_API size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* zds, const ZSTD_DDict* ddict);
2174
2630
 
2175
2631
  /*!
2176
2632
  * This function is deprecated, and is equivalent to:
@@ -2178,17 +2634,185 @@ ZSTDLIB_API size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* zds, const ZSTD_DDi
2178
2634
  * ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);
2179
2635
  *
2180
2636
  * re-use decompression parameters from previous init; saves dictionary loading
2181
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2182
2637
  */
2183
- ZSTDLIB_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
2638
+ ZSTD_DEPRECATED("use ZSTD_DCtx_reset, see zstd.h for detailed instructions")
2639
+ ZSTDLIB_STATIC_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
2640
+
2641
+
2642
+ /* ********************* BLOCK-LEVEL SEQUENCE PRODUCER API *********************
2643
+ *
2644
+ * *** OVERVIEW ***
2645
+ * The Block-Level Sequence Producer API allows users to provide their own custom
2646
+ * sequence producer which libzstd invokes to process each block. The produced list
2647
+ * of sequences (literals and matches) is then post-processed by libzstd to produce
2648
+ * valid compressed blocks.
2649
+ *
2650
+ * This block-level offload API is a more granular complement of the existing
2651
+ * frame-level offload API compressSequences() (introduced in v1.5.1). It offers
2652
+ * an easier migration story for applications already integrated with libzstd: the
2653
+ * user application continues to invoke the same compression functions
2654
+ * ZSTD_compress2() or ZSTD_compressStream2() as usual, and transparently benefits
2655
+ * from the specific advantages of the external sequence producer. For example,
2656
+ * the sequence producer could be tuned to take advantage of known characteristics
2657
+ * of the input, to offer better speed / ratio, or could leverage hardware
2658
+ * acceleration not available within libzstd itself.
2659
+ *
2660
+ * See contrib/externalSequenceProducer for an example program employing the
2661
+ * Block-Level Sequence Producer API.
2662
+ *
2663
+ * *** USAGE ***
2664
+ * The user is responsible for implementing a function of type
2665
+ * ZSTD_sequenceProducer_F. For each block, zstd will pass the following
2666
+ * arguments to the user-provided function:
2667
+ *
2668
+ * - sequenceProducerState: a pointer to a user-managed state for the sequence
2669
+ * producer.
2670
+ *
2671
+ * - outSeqs, outSeqsCapacity: an output buffer for the sequence producer.
2672
+ * outSeqsCapacity is guaranteed >= ZSTD_sequenceBound(srcSize). The memory
2673
+ * backing outSeqs is managed by the CCtx.
2674
+ *
2675
+ * - src, srcSize: an input buffer for the sequence producer to parse.
2676
+ * srcSize is guaranteed to be <= ZSTD_BLOCKSIZE_MAX.
2677
+ *
2678
+ * - dict, dictSize: a history buffer, which may be empty, which the sequence
2679
+ * producer may reference as it parses the src buffer. Currently, zstd will
2680
+ * always pass dictSize == 0 into external sequence producers, but this will
2681
+ * change in the future.
2682
+ *
2683
+ * - compressionLevel: a signed integer representing the zstd compression level
2684
+ * set by the user for the current operation. The sequence producer may choose
2685
+ * to use this information to change its compression strategy and speed/ratio
2686
+ * tradeoff. Note: the compression level does not reflect zstd parameters set
2687
+ * through the advanced API.
2688
+ *
2689
+ * - windowSize: a size_t representing the maximum allowed offset for external
2690
+ * sequences. Note that sequence offsets are sometimes allowed to exceed the
2691
+ * windowSize if a dictionary is present, see doc/zstd_compression_format.md
2692
+ * for details.
2693
+ *
2694
+ * The user-provided function shall return a size_t representing the number of
2695
+ * sequences written to outSeqs. This return value will be treated as an error
2696
+ * code if it is greater than outSeqsCapacity. The return value must be non-zero
2697
+ * if srcSize is non-zero. The ZSTD_SEQUENCE_PRODUCER_ERROR macro is provided
2698
+ * for convenience, but any value greater than outSeqsCapacity will be treated as
2699
+ * an error code.
2700
+ *
2701
+ * If the user-provided function does not return an error code, the sequences
2702
+ * written to outSeqs must be a valid parse of the src buffer. Data corruption may
2703
+ * occur if the parse is not valid. A parse is defined to be valid if the
2704
+ * following conditions hold:
2705
+ * - The sum of matchLengths and literalLengths must equal srcSize.
2706
+ * - All sequences in the parse, except for the final sequence, must have
2707
+ * matchLength >= ZSTD_MINMATCH_MIN. The final sequence must have
2708
+ * matchLength >= ZSTD_MINMATCH_MIN or matchLength == 0.
2709
+ * - All offsets must respect the windowSize parameter as specified in
2710
+ * doc/zstd_compression_format.md.
2711
+ * - If the final sequence has matchLength == 0, it must also have offset == 0.
2712
+ *
2713
+ * zstd will only validate these conditions (and fail compression if they do not
2714
+ * hold) if the ZSTD_c_validateSequences cParam is enabled. Note that sequence
2715
+ * validation has a performance cost.
2716
+ *
2717
+ * If the user-provided function returns an error, zstd will either fall back
2718
+ * to an internal sequence producer or fail the compression operation. The user can
2719
+ * choose between the two behaviors by setting the ZSTD_c_enableSeqProducerFallback
2720
+ * cParam. Fallback compression will follow any other cParam settings, such as
2721
+ * compression level, the same as in a normal compression operation.
2722
+ *
2723
+ * The user shall instruct zstd to use a particular ZSTD_sequenceProducer_F
2724
+ * function by calling
2725
+ * ZSTD_registerSequenceProducer(cctx,
2726
+ * sequenceProducerState,
2727
+ * sequenceProducer)
2728
+ * This setting will persist until the next parameter reset of the CCtx.
2729
+ *
2730
+ * The sequenceProducerState must be initialized by the user before calling
2731
+ * ZSTD_registerSequenceProducer(). The user is responsible for destroying the
2732
+ * sequenceProducerState.
2733
+ *
2734
+ * *** LIMITATIONS ***
2735
+ * This API is compatible with all zstd compression APIs which respect advanced parameters.
2736
+ * However, there are three limitations:
2737
+ *
2738
+ * First, the ZSTD_c_enableLongDistanceMatching cParam is not currently supported.
2739
+ * COMPRESSION WILL FAIL if it is enabled and the user tries to compress with a block-level
2740
+ * external sequence producer.
2741
+ * - Note that ZSTD_c_enableLongDistanceMatching is auto-enabled by default in some
2742
+ * cases (see its documentation for details). Users must explicitly set
2743
+ * ZSTD_c_enableLongDistanceMatching to ZSTD_ps_disable in such cases if an external
2744
+ * sequence producer is registered.
2745
+ * - As of this writing, ZSTD_c_enableLongDistanceMatching is disabled by default
2746
+ * whenever ZSTD_c_windowLog < 128MB, but that's subject to change. Users should
2747
+ * check the docs on ZSTD_c_enableLongDistanceMatching whenever the Block-Level Sequence
2748
+ * Producer API is used in conjunction with advanced settings (like ZSTD_c_windowLog).
2749
+ *
2750
+ * Second, history buffers are not currently supported. Concretely, zstd will always pass
2751
+ * dictSize == 0 to the external sequence producer (for now). This has two implications:
2752
+ * - Dictionaries are not currently supported. Compression will *not* fail if the user
2753
+ * references a dictionary, but the dictionary won't have any effect.
2754
+ * - Stream history is not currently supported. All advanced compression APIs, including
2755
+ * streaming APIs, work with external sequence producers, but each block is treated as
2756
+ * an independent chunk without history from previous blocks.
2757
+ *
2758
+ * Third, multi-threading within a single compression is not currently supported. In other words,
2759
+ * COMPRESSION WILL FAIL if ZSTD_c_nbWorkers > 0 and an external sequence producer is registered.
2760
+ * Multi-threading across compressions is fine: simply create one CCtx per thread.
2761
+ *
2762
+ * Long-term, we plan to overcome all three limitations. There is no technical blocker to
2763
+ * overcoming them. It is purely a question of engineering effort.
2764
+ */
2765
+
2766
+ #define ZSTD_SEQUENCE_PRODUCER_ERROR ((size_t)(-1))
2767
+
2768
+ typedef size_t ZSTD_sequenceProducer_F (
2769
+ void* sequenceProducerState,
2770
+ ZSTD_Sequence* outSeqs, size_t outSeqsCapacity,
2771
+ const void* src, size_t srcSize,
2772
+ const void* dict, size_t dictSize,
2773
+ int compressionLevel,
2774
+ size_t windowSize
2775
+ );
2776
+
2777
+ /*! ZSTD_registerSequenceProducer() :
2778
+ * Instruct zstd to use a block-level external sequence producer function.
2779
+ *
2780
+ * The sequenceProducerState must be initialized by the caller, and the caller is
2781
+ * responsible for managing its lifetime. This parameter is sticky across
2782
+ * compressions. It will remain set until the user explicitly resets compression
2783
+ * parameters.
2784
+ *
2785
+ * Sequence producer registration is considered to be an "advanced parameter",
2786
+ * part of the "advanced API". This means it will only have an effect on compression
2787
+ * APIs which respect advanced parameters, such as compress2() and compressStream2().
2788
+ * Older compression APIs such as compressCCtx(), which predate the introduction of
2789
+ * "advanced parameters", will ignore any external sequence producer setting.
2790
+ *
2791
+ * The sequence producer can be "cleared" by registering a NULL function pointer. This
2792
+ * removes all limitations described above in the "LIMITATIONS" section of the API docs.
2793
+ *
2794
+ * The user is strongly encouraged to read the full API documentation (above) before
2795
+ * calling this function. */
2796
+ ZSTDLIB_STATIC_API void
2797
+ ZSTD_registerSequenceProducer(
2798
+ ZSTD_CCtx* cctx,
2799
+ void* sequenceProducerState,
2800
+ ZSTD_sequenceProducer_F* sequenceProducer
2801
+ );
2184
2802
 
2185
2803
 
2186
2804
  /*********************************************************************
2187
- * Buffer-less and synchronous inner streaming functions
2805
+ * Buffer-less and synchronous inner streaming functions (DEPRECATED)
2806
+ *
2807
+ * This API is deprecated, and will be removed in a future version.
2808
+ * It allows streaming (de)compression with user allocated buffers.
2809
+ * However, it is hard to use, and not as well tested as the rest of
2810
+ * our API.
2188
2811
  *
2189
- * This is an advanced API, giving full control over buffer management, for users which need direct control over memory.
2190
- * But it's also a complex one, with several restrictions, documented below.
2191
- * Prefer normal streaming API for an easier experience.
2812
+ * Please use the normal streaming API instead: ZSTD_compressStream2,
2813
+ * and ZSTD_decompressStream.
2814
+ * If there is functionality that you need, but it doesn't provide,
2815
+ * please open an issue on our GitHub.
2192
2816
  ********************************************************************* */
2193
2817
 
2194
2818
  /**
@@ -2199,9 +2823,7 @@ ZSTDLIB_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
2199
2823
  ZSTD_CCtx object can be re-used multiple times within successive compression operations.
2200
2824
 
2201
2825
  Start by initializing a context.
2202
- Use ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression,
2203
- or ZSTD_compressBegin_advanced(), for finer parameter control.
2204
- It's also possible to duplicate a reference context which has already been initialized, using ZSTD_copyCCtx()
2826
+ Use ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression.
2205
2827
 
2206
2828
  Then, consume your input using ZSTD_compressContinue().
2207
2829
  There are some important considerations to keep in mind when using this advanced function :
@@ -2223,17 +2845,29 @@ ZSTDLIB_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
2223
2845
  */
2224
2846
 
2225
2847
  /*===== Buffer-less streaming compression functions =====*/
2226
- ZSTDLIB_API size_t ZSTD_compressBegin(ZSTD_CCtx* cctx, int compressionLevel);
2227
- ZSTDLIB_API size_t ZSTD_compressBegin_usingDict(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, int compressionLevel);
2228
- ZSTDLIB_API size_t ZSTD_compressBegin_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_parameters params, unsigned long long pledgedSrcSize); /**< pledgedSrcSize : If srcSize is not known at init time, use ZSTD_CONTENTSIZE_UNKNOWN */
2229
- ZSTDLIB_API size_t ZSTD_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /**< note: fails if cdict==NULL */
2230
- ZSTDLIB_API size_t ZSTD_compressBegin_usingCDict_advanced(ZSTD_CCtx* const cctx, const ZSTD_CDict* const cdict, ZSTD_frameParameters const fParams, unsigned long long const pledgedSrcSize); /* compression parameters are already set within cdict. pledgedSrcSize must be correct. If srcSize is not known, use macro ZSTD_CONTENTSIZE_UNKNOWN */
2231
- ZSTDLIB_API size_t ZSTD_copyCCtx(ZSTD_CCtx* cctx, const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); /**< note: if pledgedSrcSize is not known, use ZSTD_CONTENTSIZE_UNKNOWN */
2232
-
2233
- ZSTDLIB_API size_t ZSTD_compressContinue(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2234
- ZSTDLIB_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2235
-
2236
-
2848
+ ZSTD_DEPRECATED("The buffer-less API is deprecated in favor of the normal streaming API. See docs.")
2849
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBegin(ZSTD_CCtx* cctx, int compressionLevel);
2850
+ ZSTD_DEPRECATED("The buffer-less API is deprecated in favor of the normal streaming API. See docs.")
2851
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBegin_usingDict(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, int compressionLevel);
2852
+ ZSTD_DEPRECATED("The buffer-less API is deprecated in favor of the normal streaming API. See docs.")
2853
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /**< note: fails if cdict==NULL */
2854
+
2855
+ ZSTD_DEPRECATED("This function will likely be removed in a future release. It is misleading and has very limited utility.")
2856
+ ZSTDLIB_STATIC_API
2857
+ size_t ZSTD_copyCCtx(ZSTD_CCtx* cctx, const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); /**< note: if pledgedSrcSize is not known, use ZSTD_CONTENTSIZE_UNKNOWN */
2858
+
2859
+ ZSTD_DEPRECATED("The buffer-less API is deprecated in favor of the normal streaming API. See docs.")
2860
+ ZSTDLIB_STATIC_API size_t ZSTD_compressContinue(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2861
+ ZSTD_DEPRECATED("The buffer-less API is deprecated in favor of the normal streaming API. See docs.")
2862
+ ZSTDLIB_STATIC_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2863
+
2864
+ /* The ZSTD_compressBegin_advanced() and ZSTD_compressBegin_usingCDict_advanced() are now DEPRECATED and will generate a compiler warning */
2865
+ ZSTD_DEPRECATED("use advanced API to access custom parameters")
2866
+ ZSTDLIB_STATIC_API
2867
+ size_t ZSTD_compressBegin_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_parameters params, unsigned long long pledgedSrcSize); /**< pledgedSrcSize : If srcSize is not known at init time, use ZSTD_CONTENTSIZE_UNKNOWN */
2868
+ ZSTD_DEPRECATED("use advanced API to access custom parameters")
2869
+ ZSTDLIB_STATIC_API
2870
+ size_t ZSTD_compressBegin_usingCDict_advanced(ZSTD_CCtx* const cctx, const ZSTD_CDict* const cdict, ZSTD_frameParameters const fParams, unsigned long long const pledgedSrcSize); /* compression parameters are already set within cdict. pledgedSrcSize must be correct. If srcSize is not known, use macro ZSTD_CONTENTSIZE_UNKNOWN */
2237
2871
  /**
2238
2872
  Buffer-less streaming decompression (synchronous mode)
2239
2873
 
@@ -2245,8 +2879,8 @@ ZSTDLIB_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapaci
2245
2879
  Frame header is extracted from the beginning of compressed frame, so providing only the frame's beginning is enough.
2246
2880
  Data fragment must be large enough to ensure successful decoding.
2247
2881
  `ZSTD_frameHeaderSize_max` bytes is guaranteed to always be large enough.
2248
- @result : 0 : successful decoding, the `ZSTD_frameHeader` structure is correctly filled.
2249
- >0 : `srcSize` is too small, please provide at least @result bytes on next attempt.
2882
+ result : 0 : successful decoding, the `ZSTD_frameHeader` structure is correctly filled.
2883
+ >0 : `srcSize` is too small, please provide at least result bytes on next attempt.
2250
2884
  errorCode, which can be tested using ZSTD_isError().
2251
2885
 
2252
2886
  It fills a ZSTD_frameHeader structure with important information to correctly decode the frame,
@@ -2265,7 +2899,7 @@ ZSTDLIB_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapaci
2265
2899
 
2266
2900
  The most memory efficient way is to use a round buffer of sufficient size.
2267
2901
  Sufficient size is determined by invoking ZSTD_decodingBufferSize_min(),
2268
- which can @return an error code if required value is too large for current system (in 32-bits mode).
2902
+ which can return an error code if required value is too large for current system (in 32-bits mode).
2269
2903
  In a round buffer methodology, ZSTD_decompressContinue() decompresses each block next to previous one,
2270
2904
  up to the moment there is not enough room left in the buffer to guarantee decoding another full block,
2271
2905
  which maximum size is provided in `ZSTD_frameHeader` structure, field `blockSizeMax`.
@@ -2285,7 +2919,7 @@ ZSTDLIB_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapaci
2285
2919
  ZSTD_nextSrcSizeToDecompress() tells how many bytes to provide as 'srcSize' to ZSTD_decompressContinue().
2286
2920
  ZSTD_decompressContinue() requires this _exact_ amount of bytes, or it will fail.
2287
2921
 
2288
- @result of ZSTD_decompressContinue() is the number of bytes regenerated within 'dst' (necessarily <= dstCapacity).
2922
+ result of ZSTD_decompressContinue() is the number of bytes regenerated within 'dst' (necessarily <= dstCapacity).
2289
2923
  It can be zero : it just means ZSTD_decompressContinue() has decoded some metadata item.
2290
2924
  It can also be an error code, which can be tested with ZSTD_isError().
2291
2925
 
@@ -2308,49 +2942,42 @@ ZSTDLIB_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapaci
2308
2942
  */
2309
2943
 
2310
2944
  /*===== Buffer-less streaming decompression functions =====*/
2311
- typedef enum { ZSTD_frame, ZSTD_skippableFrame } ZSTD_frameType_e;
2312
- typedef struct {
2313
- unsigned long long frameContentSize; /* if == ZSTD_CONTENTSIZE_UNKNOWN, it means this field is not available. 0 means "empty" */
2314
- unsigned long long windowSize; /* can be very large, up to <= frameContentSize */
2315
- unsigned blockSizeMax;
2316
- ZSTD_frameType_e frameType; /* if == ZSTD_skippableFrame, frameContentSize is the size of skippable content */
2317
- unsigned headerSize;
2318
- unsigned dictID;
2319
- unsigned checksumFlag;
2320
- } ZSTD_frameHeader;
2321
2945
 
2322
- /*! ZSTD_getFrameHeader() :
2323
- * decode Frame Header, or requires larger `srcSize`.
2324
- * @return : 0, `zfhPtr` is correctly filled,
2325
- * >0, `srcSize` is too small, value is wanted `srcSize` amount,
2326
- * or an error code, which can be tested using ZSTD_isError() */
2327
- ZSTDLIB_API size_t ZSTD_getFrameHeader(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize); /**< doesn't consume input */
2328
- /*! ZSTD_getFrameHeader_advanced() :
2329
- * same as ZSTD_getFrameHeader(),
2330
- * with added capability to select a format (like ZSTD_f_zstd1_magicless) */
2331
- ZSTDLIB_API size_t ZSTD_getFrameHeader_advanced(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize, ZSTD_format_e format);
2332
- ZSTDLIB_API size_t ZSTD_decodingBufferSize_min(unsigned long long windowSize, unsigned long long frameContentSize); /**< when frame content size is not known, pass in frameContentSize == ZSTD_CONTENTSIZE_UNKNOWN */
2946
+ ZSTDLIB_STATIC_API size_t ZSTD_decodingBufferSize_min(unsigned long long windowSize, unsigned long long frameContentSize); /**< when frame content size is not known, pass in frameContentSize == ZSTD_CONTENTSIZE_UNKNOWN */
2333
2947
 
2334
- ZSTDLIB_API size_t ZSTD_decompressBegin(ZSTD_DCtx* dctx);
2335
- ZSTDLIB_API size_t ZSTD_decompressBegin_usingDict(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
2336
- ZSTDLIB_API size_t ZSTD_decompressBegin_usingDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
2948
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBegin(ZSTD_DCtx* dctx);
2949
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBegin_usingDict(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
2950
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBegin_usingDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
2337
2951
 
2338
- ZSTDLIB_API size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx);
2339
- ZSTDLIB_API size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2952
+ ZSTDLIB_STATIC_API size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx);
2953
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2340
2954
 
2341
2955
  /* misc */
2342
- ZSTDLIB_API void ZSTD_copyDCtx(ZSTD_DCtx* dctx, const ZSTD_DCtx* preparedDCtx);
2956
+ ZSTD_DEPRECATED("This function will likely be removed in the next minor release. It is misleading and has very limited utility.")
2957
+ ZSTDLIB_STATIC_API void ZSTD_copyDCtx(ZSTD_DCtx* dctx, const ZSTD_DCtx* preparedDCtx);
2343
2958
  typedef enum { ZSTDnit_frameHeader, ZSTDnit_blockHeader, ZSTDnit_block, ZSTDnit_lastBlock, ZSTDnit_checksum, ZSTDnit_skippableFrame } ZSTD_nextInputType_e;
2344
- ZSTDLIB_API ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
2959
+ ZSTDLIB_STATIC_API ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
2345
2960
 
2346
2961
 
2347
2962
 
2348
2963
 
2349
- /* ============================ */
2350
- /** Block level API */
2351
- /* ============================ */
2964
+ /* ========================================= */
2965
+ /** Block level API (DEPRECATED) */
2966
+ /* ========================================= */
2352
2967
 
2353
2968
  /*!
2969
+
2970
+ This API is deprecated in favor of the regular compression API.
2971
+ You can get the frame header down to 2 bytes by setting:
2972
+ - ZSTD_c_format = ZSTD_f_zstd1_magicless
2973
+ - ZSTD_c_contentSizeFlag = 0
2974
+ - ZSTD_c_checksumFlag = 0
2975
+ - ZSTD_c_dictIDFlag = 0
2976
+
2977
+ This API is not as well tested as our normal API, so we recommend not using it.
2978
+ We will be removing it in a future version. If the normal API doesn't provide
2979
+ the functionality you need, please open a GitHub issue.
2980
+
2354
2981
  Block functions produce and decode raw zstd blocks, without frame metadata.
2355
2982
  Frame metadata cost is typically ~12 bytes, which can be non-negligible for very small blocks (< 100 bytes).
2356
2983
  But users will have to take in charge needed metadata to regenerate data, such as compressed and content sizes.
@@ -2361,7 +2988,6 @@ ZSTDLIB_API ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
2361
2988
  - It is necessary to init context before starting
2362
2989
  + compression : any ZSTD_compressBegin*() variant, including with dictionary
2363
2990
  + decompression : any ZSTD_decompressBegin*() variant, including with dictionary
2364
- + copyCCtx() and copyDCtx() can be used too
2365
2991
  - Block size is limited, it must be <= ZSTD_getBlockSize() <= ZSTD_BLOCKSIZE_MAX == 128 KB
2366
2992
  + If input is larger than a block size, it's necessary to split input data into multiple blocks
2367
2993
  + For inputs larger than a single block, consider using regular ZSTD_compress() instead.
@@ -2378,11 +3004,14 @@ ZSTDLIB_API ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
2378
3004
  */
2379
3005
 
2380
3006
  /*===== Raw zstd block functions =====*/
2381
- ZSTDLIB_API size_t ZSTD_getBlockSize (const ZSTD_CCtx* cctx);
2382
- ZSTDLIB_API size_t ZSTD_compressBlock (ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2383
- ZSTDLIB_API size_t ZSTD_decompressBlock(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2384
- ZSTDLIB_API size_t ZSTD_insertBlock (ZSTD_DCtx* dctx, const void* blockStart, size_t blockSize); /**< insert uncompressed block into `dctx` history. Useful for multi-blocks decompression. */
2385
-
3007
+ ZSTD_DEPRECATED("The block API is deprecated in favor of the normal compression API. See docs.")
3008
+ ZSTDLIB_STATIC_API size_t ZSTD_getBlockSize (const ZSTD_CCtx* cctx);
3009
+ ZSTD_DEPRECATED("The block API is deprecated in favor of the normal compression API. See docs.")
3010
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBlock (ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
3011
+ ZSTD_DEPRECATED("The block API is deprecated in favor of the normal compression API. See docs.")
3012
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBlock(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
3013
+ ZSTD_DEPRECATED("The block API is deprecated in favor of the normal compression API. See docs.")
3014
+ ZSTDLIB_STATIC_API size_t ZSTD_insertBlock (ZSTD_DCtx* dctx, const void* blockStart, size_t blockSize); /**< insert uncompressed block into `dctx` history. Useful for multi-blocks decompression. */
2386
3015
 
2387
3016
  #endif /* ZSTD_H_ZSTD_STATIC_LINKING_ONLY */
2388
3017