zstdlib 0.9.0-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (118) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +6 -0
  3. data/CHANGES.md +78 -0
  4. data/Gemfile +3 -0
  5. data/README.md +107 -0
  6. data/Rakefile +59 -0
  7. data/ext/zstdlib_c/extconf.rb +54 -0
  8. data/ext/zstdlib_c/ruby/zlib-2.2/zstdlib.c +4675 -0
  9. data/ext/zstdlib_c/ruby/zlib-2.3/zstdlib.c +4702 -0
  10. data/ext/zstdlib_c/ruby/zlib-2.4/zstdlib.c +4859 -0
  11. data/ext/zstdlib_c/ruby/zlib-2.5/zstdlib.c +4864 -0
  12. data/ext/zstdlib_c/ruby/zlib-2.6/zstdlib.c +4906 -0
  13. data/ext/zstdlib_c/ruby/zlib-2.7/zstdlib.c +4895 -0
  14. data/ext/zstdlib_c/ruby/zlib-3.0/zstdlib.c +4994 -0
  15. data/ext/zstdlib_c/ruby/zlib-3.1/zstdlib.c +5076 -0
  16. data/ext/zstdlib_c/zlib-1.2.11/adler32.c +186 -0
  17. data/ext/zstdlib_c/zlib-1.2.11/compress.c +86 -0
  18. data/ext/zstdlib_c/zlib-1.2.11/crc32.c +442 -0
  19. data/ext/zstdlib_c/zlib-1.2.11/crc32.h +441 -0
  20. data/ext/zstdlib_c/zlib-1.2.11/deflate.c +2163 -0
  21. data/ext/zstdlib_c/zlib-1.2.11/deflate.h +349 -0
  22. data/ext/zstdlib_c/zlib-1.2.11/gzclose.c +25 -0
  23. data/ext/zstdlib_c/zlib-1.2.11/gzguts.h +218 -0
  24. data/ext/zstdlib_c/zlib-1.2.11/gzlib.c +637 -0
  25. data/ext/zstdlib_c/zlib-1.2.11/gzread.c +654 -0
  26. data/ext/zstdlib_c/zlib-1.2.11/gzwrite.c +665 -0
  27. data/ext/zstdlib_c/zlib-1.2.11/infback.c +640 -0
  28. data/ext/zstdlib_c/zlib-1.2.11/inffast.c +323 -0
  29. data/ext/zstdlib_c/zlib-1.2.11/inffast.h +11 -0
  30. data/ext/zstdlib_c/zlib-1.2.11/inffixed.h +94 -0
  31. data/ext/zstdlib_c/zlib-1.2.11/inflate.c +1561 -0
  32. data/ext/zstdlib_c/zlib-1.2.11/inflate.h +125 -0
  33. data/ext/zstdlib_c/zlib-1.2.11/inftrees.c +304 -0
  34. data/ext/zstdlib_c/zlib-1.2.11/inftrees.h +62 -0
  35. data/ext/zstdlib_c/zlib-1.2.11/trees.c +1203 -0
  36. data/ext/zstdlib_c/zlib-1.2.11/trees.h +128 -0
  37. data/ext/zstdlib_c/zlib-1.2.11/uncompr.c +93 -0
  38. data/ext/zstdlib_c/zlib-1.2.11/zconf.h +534 -0
  39. data/ext/zstdlib_c/zlib-1.2.11/zlib.h +1912 -0
  40. data/ext/zstdlib_c/zlib-1.2.11/zutil.c +325 -0
  41. data/ext/zstdlib_c/zlib-1.2.11/zutil.h +271 -0
  42. data/ext/zstdlib_c/zlib.mk +14 -0
  43. data/ext/zstdlib_c/zlibwrapper/zlibwrapper.c +10 -0
  44. data/ext/zstdlib_c/zlibwrapper.mk +14 -0
  45. data/ext/zstdlib_c/zstd-1.5.2/lib/common/bitstream.h +478 -0
  46. data/ext/zstdlib_c/zstd-1.5.2/lib/common/compiler.h +335 -0
  47. data/ext/zstdlib_c/zstd-1.5.2/lib/common/cpu.h +213 -0
  48. data/ext/zstdlib_c/zstd-1.5.2/lib/common/debug.c +24 -0
  49. data/ext/zstdlib_c/zstd-1.5.2/lib/common/debug.h +107 -0
  50. data/ext/zstdlib_c/zstd-1.5.2/lib/common/entropy_common.c +368 -0
  51. data/ext/zstdlib_c/zstd-1.5.2/lib/common/error_private.c +56 -0
  52. data/ext/zstdlib_c/zstd-1.5.2/lib/common/error_private.h +159 -0
  53. data/ext/zstdlib_c/zstd-1.5.2/lib/common/fse.h +717 -0
  54. data/ext/zstdlib_c/zstd-1.5.2/lib/common/fse_decompress.c +403 -0
  55. data/ext/zstdlib_c/zstd-1.5.2/lib/common/huf.h +364 -0
  56. data/ext/zstdlib_c/zstd-1.5.2/lib/common/mem.h +442 -0
  57. data/ext/zstdlib_c/zstd-1.5.2/lib/common/pool.c +355 -0
  58. data/ext/zstdlib_c/zstd-1.5.2/lib/common/pool.h +84 -0
  59. data/ext/zstdlib_c/zstd-1.5.2/lib/common/portability_macros.h +137 -0
  60. data/ext/zstdlib_c/zstd-1.5.2/lib/common/threading.c +122 -0
  61. data/ext/zstdlib_c/zstd-1.5.2/lib/common/threading.h +155 -0
  62. data/ext/zstdlib_c/zstd-1.5.2/lib/common/xxhash.c +24 -0
  63. data/ext/zstdlib_c/zstd-1.5.2/lib/common/xxhash.h +5686 -0
  64. data/ext/zstdlib_c/zstd-1.5.2/lib/common/zstd_common.c +83 -0
  65. data/ext/zstdlib_c/zstd-1.5.2/lib/common/zstd_deps.h +111 -0
  66. data/ext/zstdlib_c/zstd-1.5.2/lib/common/zstd_internal.h +493 -0
  67. data/ext/zstdlib_c/zstd-1.5.2/lib/common/zstd_trace.h +163 -0
  68. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/clevels.h +134 -0
  69. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/fse_compress.c +741 -0
  70. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/hist.c +181 -0
  71. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/hist.h +75 -0
  72. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/huf_compress.c +1370 -0
  73. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress.c +6327 -0
  74. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_internal.h +1458 -0
  75. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_literals.c +159 -0
  76. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_literals.h +31 -0
  77. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_sequences.c +442 -0
  78. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_sequences.h +54 -0
  79. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_superblock.c +573 -0
  80. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_compress_superblock.h +32 -0
  81. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_cwksp.h +676 -0
  82. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_double_fast.c +696 -0
  83. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_double_fast.h +38 -0
  84. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_fast.c +675 -0
  85. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_fast.h +37 -0
  86. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_lazy.c +2104 -0
  87. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_lazy.h +125 -0
  88. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_ldm.c +724 -0
  89. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_ldm.h +117 -0
  90. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_ldm_geartab.h +106 -0
  91. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_opt.c +1446 -0
  92. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstd_opt.h +56 -0
  93. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstdmt_compress.c +1859 -0
  94. data/ext/zstdlib_c/zstd-1.5.2/lib/compress/zstdmt_compress.h +113 -0
  95. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/huf_decompress.c +1889 -0
  96. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/huf_decompress_amd64.S +585 -0
  97. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/zstd_ddict.c +244 -0
  98. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/zstd_ddict.h +44 -0
  99. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/zstd_decompress.c +2230 -0
  100. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/zstd_decompress_block.c +2072 -0
  101. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/zstd_decompress_block.h +68 -0
  102. data/ext/zstdlib_c/zstd-1.5.2/lib/decompress/zstd_decompress_internal.h +236 -0
  103. data/ext/zstdlib_c/zstd-1.5.2/lib/zdict.h +452 -0
  104. data/ext/zstdlib_c/zstd-1.5.2/lib/zstd.h +2575 -0
  105. data/ext/zstdlib_c/zstd-1.5.2/lib/zstd_errors.h +95 -0
  106. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/gzclose.c +28 -0
  107. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/gzcompatibility.h +68 -0
  108. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/gzguts.h +229 -0
  109. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/gzlib.c +640 -0
  110. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/gzread.c +678 -0
  111. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/gzwrite.c +671 -0
  112. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/zstd_zlibwrapper.c +1198 -0
  113. data/ext/zstdlib_c/zstd-1.5.2/zlibWrapper/zstd_zlibwrapper.h +88 -0
  114. data/ext/zstdlib_c/zstd.mk +15 -0
  115. data/lib/3.1/zstdlib_c.so +0 -0
  116. data/lib/zstdlib.rb +6 -0
  117. data/test/zstdlib_test.rb +21 -0
  118. metadata +232 -0
@@ -0,0 +1,2575 @@
1
+ /*
2
+ * Copyright (c) Yann Collet, Facebook, Inc.
3
+ * All rights reserved.
4
+ *
5
+ * This source code is licensed under both the BSD-style license (found in the
6
+ * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7
+ * in the COPYING file in the root directory of this source tree).
8
+ * You may select, at your option, one of the above-listed licenses.
9
+ */
10
+ #if defined (__cplusplus)
11
+ extern "C" {
12
+ #endif
13
+
14
+ #ifndef ZSTD_H_235446
15
+ #define ZSTD_H_235446
16
+
17
+ /* ====== Dependency ======*/
18
+ #include <limits.h> /* INT_MAX */
19
+ #include <stddef.h> /* size_t */
20
+
21
+
22
+ /* ===== ZSTDLIB_API : control library symbols visibility ===== */
23
+ #ifndef ZSTDLIB_VISIBLE
24
+ # if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__)
25
+ # define ZSTDLIB_VISIBLE __attribute__ ((visibility ("default")))
26
+ # define ZSTDLIB_HIDDEN __attribute__ ((visibility ("hidden")))
27
+ # else
28
+ # define ZSTDLIB_VISIBLE
29
+ # define ZSTDLIB_HIDDEN
30
+ # endif
31
+ #endif
32
+ #if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
33
+ # define ZSTDLIB_API __declspec(dllexport) ZSTDLIB_VISIBLE
34
+ #elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
35
+ # 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.*/
36
+ #else
37
+ # define ZSTDLIB_API ZSTDLIB_VISIBLE
38
+ #endif
39
+
40
+
41
+ /*******************************************************************************
42
+ Introduction
43
+
44
+ zstd, short for Zstandard, is a fast lossless compression algorithm, targeting
45
+ real-time compression scenarios at zlib-level and better compression ratios.
46
+ The zstd compression library provides in-memory compression and decompression
47
+ functions.
48
+
49
+ The library supports regular compression levels from 1 up to ZSTD_maxCLevel(),
50
+ which is currently 22. Levels >= 20, labeled `--ultra`, should be used with
51
+ caution, as they require more memory. The library also offers negative
52
+ compression levels, which extend the range of speed vs. ratio preferences.
53
+ The lower the level, the faster the speed (at the cost of compression).
54
+
55
+ Compression can be done in:
56
+ - a single step (described as Simple API)
57
+ - a single step, reusing a context (described as Explicit context)
58
+ - unbounded multiple steps (described as Streaming compression)
59
+
60
+ The compression ratio achievable on small data can be highly improved using
61
+ a dictionary. Dictionary compression can be performed in:
62
+ - a single step (described as Simple dictionary API)
63
+ - a single step, reusing a dictionary (described as Bulk-processing
64
+ dictionary API)
65
+
66
+ Advanced experimental functions can be accessed using
67
+ `#define ZSTD_STATIC_LINKING_ONLY` before including zstd.h.
68
+
69
+ Advanced experimental APIs should never be used with a dynamically-linked
70
+ library. They are not "stable"; their definitions or signatures may change in
71
+ the future. Only static linking is allowed.
72
+ *******************************************************************************/
73
+
74
+ /*------ Version ------*/
75
+ #define ZSTD_VERSION_MAJOR 1
76
+ #define ZSTD_VERSION_MINOR 5
77
+ #define ZSTD_VERSION_RELEASE 2
78
+ #define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
79
+
80
+ /*! ZSTD_versionNumber() :
81
+ * Return runtime library version, the value is (MAJOR*100*100 + MINOR*100 + RELEASE). */
82
+ ZSTDLIB_API unsigned ZSTD_versionNumber(void);
83
+
84
+ #define ZSTD_LIB_VERSION ZSTD_VERSION_MAJOR.ZSTD_VERSION_MINOR.ZSTD_VERSION_RELEASE
85
+ #define ZSTD_QUOTE(str) #str
86
+ #define ZSTD_EXPAND_AND_QUOTE(str) ZSTD_QUOTE(str)
87
+ #define ZSTD_VERSION_STRING ZSTD_EXPAND_AND_QUOTE(ZSTD_LIB_VERSION)
88
+
89
+ /*! ZSTD_versionString() :
90
+ * Return runtime library version, like "1.4.5". Requires v1.3.0+. */
91
+ ZSTDLIB_API const char* ZSTD_versionString(void);
92
+
93
+ /* *************************************
94
+ * Default constant
95
+ ***************************************/
96
+ #ifndef ZSTD_CLEVEL_DEFAULT
97
+ # define ZSTD_CLEVEL_DEFAULT 3
98
+ #endif
99
+
100
+ /* *************************************
101
+ * Constants
102
+ ***************************************/
103
+
104
+ /* All magic numbers are supposed read/written to/from files/memory using little-endian convention */
105
+ #define ZSTD_MAGICNUMBER 0xFD2FB528 /* valid since v0.8.0 */
106
+ #define ZSTD_MAGIC_DICTIONARY 0xEC30A437 /* valid since v0.7.0 */
107
+ #define ZSTD_MAGIC_SKIPPABLE_START 0x184D2A50 /* all 16 values, from 0x184D2A50 to 0x184D2A5F, signal the beginning of a skippable frame */
108
+ #define ZSTD_MAGIC_SKIPPABLE_MASK 0xFFFFFFF0
109
+
110
+ #define ZSTD_BLOCKSIZELOG_MAX 17
111
+ #define ZSTD_BLOCKSIZE_MAX (1<<ZSTD_BLOCKSIZELOG_MAX)
112
+
113
+
114
+ /***************************************
115
+ * Simple API
116
+ ***************************************/
117
+ /*! ZSTD_compress() :
118
+ * Compresses `src` content as a single zstd compressed frame into already allocated `dst`.
119
+ * Hint : compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
120
+ * @return : compressed size written into `dst` (<= `dstCapacity),
121
+ * or an error code if it fails (which can be tested using ZSTD_isError()). */
122
+ ZSTDLIB_API size_t ZSTD_compress( void* dst, size_t dstCapacity,
123
+ const void* src, size_t srcSize,
124
+ int compressionLevel);
125
+
126
+ /*! ZSTD_decompress() :
127
+ * `compressedSize` : must be the _exact_ size of some number of compressed and/or skippable frames.
128
+ * `dstCapacity` is an upper bound of originalSize to regenerate.
129
+ * If user cannot imply a maximum upper bound, it's better to use streaming mode to decompress data.
130
+ * @return : the number of bytes decompressed into `dst` (<= `dstCapacity`),
131
+ * or an errorCode if it fails (which can be tested using ZSTD_isError()). */
132
+ ZSTDLIB_API size_t ZSTD_decompress( void* dst, size_t dstCapacity,
133
+ const void* src, size_t compressedSize);
134
+
135
+ /*! ZSTD_getFrameContentSize() : requires v1.3.0+
136
+ * `src` should point to the start of a ZSTD encoded frame.
137
+ * `srcSize` must be at least as large as the frame header.
138
+ * hint : any size >= `ZSTD_frameHeaderSize_max` is large enough.
139
+ * @return : - decompressed size of `src` frame content, if known
140
+ * - ZSTD_CONTENTSIZE_UNKNOWN if the size cannot be determined
141
+ * - ZSTD_CONTENTSIZE_ERROR if an error occurred (e.g. invalid magic number, srcSize too small)
142
+ * note 1 : a 0 return value means the frame is valid but "empty".
143
+ * note 2 : decompressed size is an optional field, it may not be present, typically in streaming mode.
144
+ * When `return==ZSTD_CONTENTSIZE_UNKNOWN`, data to decompress could be any size.
145
+ * In which case, it's necessary to use streaming mode to decompress data.
146
+ * Optionally, application can rely on some implicit limit,
147
+ * as ZSTD_decompress() only needs an upper bound of decompressed size.
148
+ * (For example, data could be necessarily cut into blocks <= 16 KB).
149
+ * note 3 : decompressed size is always present when compression is completed using single-pass functions,
150
+ * such as ZSTD_compress(), ZSTD_compressCCtx() ZSTD_compress_usingDict() or ZSTD_compress_usingCDict().
151
+ * note 4 : decompressed size can be very large (64-bits value),
152
+ * potentially larger than what local system can handle as a single memory segment.
153
+ * In which case, it's necessary to use streaming mode to decompress data.
154
+ * note 5 : If source is untrusted, decompressed size could be wrong or intentionally modified.
155
+ * Always ensure return value fits within application's authorized limits.
156
+ * Each application can set its own limits.
157
+ * note 6 : This function replaces ZSTD_getDecompressedSize() */
158
+ #define ZSTD_CONTENTSIZE_UNKNOWN (0ULL - 1)
159
+ #define ZSTD_CONTENTSIZE_ERROR (0ULL - 2)
160
+ ZSTDLIB_API unsigned long long ZSTD_getFrameContentSize(const void *src, size_t srcSize);
161
+
162
+ /*! ZSTD_getDecompressedSize() :
163
+ * NOTE: This function is now obsolete, in favor of ZSTD_getFrameContentSize().
164
+ * Both functions work the same way, but ZSTD_getDecompressedSize() blends
165
+ * "empty", "unknown" and "error" results to the same return value (0),
166
+ * while ZSTD_getFrameContentSize() gives them separate return values.
167
+ * @return : decompressed size of `src` frame content _if known and not empty_, 0 otherwise. */
168
+ ZSTDLIB_API unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize);
169
+
170
+ /*! ZSTD_findFrameCompressedSize() : Requires v1.4.0+
171
+ * `src` should point to the start of a ZSTD frame or skippable frame.
172
+ * `srcSize` must be >= first frame size
173
+ * @return : the compressed size of the first frame starting at `src`,
174
+ * suitable to pass as `srcSize` to `ZSTD_decompress` or similar,
175
+ * or an error code if input is invalid */
176
+ ZSTDLIB_API size_t ZSTD_findFrameCompressedSize(const void* src, size_t srcSize);
177
+
178
+
179
+ /*====== Helper functions ======*/
180
+ #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 */
181
+ ZSTDLIB_API size_t ZSTD_compressBound(size_t srcSize); /*!< maximum compressed size in worst case single-pass scenario */
182
+ ZSTDLIB_API unsigned ZSTD_isError(size_t code); /*!< tells if a `size_t` function result is an error code */
183
+ ZSTDLIB_API const char* ZSTD_getErrorName(size_t code); /*!< provides readable string from an error code */
184
+ ZSTDLIB_API int ZSTD_minCLevel(void); /*!< minimum negative compression level allowed, requires v1.4.0+ */
185
+ ZSTDLIB_API int ZSTD_maxCLevel(void); /*!< maximum compression level available */
186
+ ZSTDLIB_API int ZSTD_defaultCLevel(void); /*!< default compression level, specified by ZSTD_CLEVEL_DEFAULT, requires v1.5.0+ */
187
+
188
+
189
+ /***************************************
190
+ * Explicit context
191
+ ***************************************/
192
+ /*= Compression context
193
+ * When compressing many times,
194
+ * it is recommended to allocate a context just once,
195
+ * and re-use it for each successive compression operation.
196
+ * This will make workload friendlier for system's memory.
197
+ * Note : re-using context is just a speed / resource optimization.
198
+ * It doesn't change the compression ratio, which remains identical.
199
+ * Note 2 : In multi-threaded environments,
200
+ * use one different context per thread for parallel execution.
201
+ */
202
+ typedef struct ZSTD_CCtx_s ZSTD_CCtx;
203
+ ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
204
+ ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx); /* accept NULL pointer */
205
+
206
+ /*! ZSTD_compressCCtx() :
207
+ * Same as ZSTD_compress(), using an explicit ZSTD_CCtx.
208
+ * Important : in order to behave similarly to `ZSTD_compress()`,
209
+ * this function compresses at requested compression level,
210
+ * __ignoring any other parameter__ .
211
+ * If any advanced parameter was set using the advanced API,
212
+ * they will all be reset. Only `compressionLevel` remains.
213
+ */
214
+ ZSTDLIB_API size_t ZSTD_compressCCtx(ZSTD_CCtx* cctx,
215
+ void* dst, size_t dstCapacity,
216
+ const void* src, size_t srcSize,
217
+ int compressionLevel);
218
+
219
+ /*= Decompression context
220
+ * When decompressing many times,
221
+ * it is recommended to allocate a context only once,
222
+ * and re-use it for each successive compression operation.
223
+ * This will make workload friendlier for system's memory.
224
+ * Use one context per thread for parallel execution. */
225
+ typedef struct ZSTD_DCtx_s ZSTD_DCtx;
226
+ ZSTDLIB_API ZSTD_DCtx* ZSTD_createDCtx(void);
227
+ ZSTDLIB_API size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx); /* accept NULL pointer */
228
+
229
+ /*! ZSTD_decompressDCtx() :
230
+ * Same as ZSTD_decompress(),
231
+ * requires an allocated ZSTD_DCtx.
232
+ * Compatible with sticky parameters.
233
+ */
234
+ ZSTDLIB_API size_t ZSTD_decompressDCtx(ZSTD_DCtx* dctx,
235
+ void* dst, size_t dstCapacity,
236
+ const void* src, size_t srcSize);
237
+
238
+
239
+ /*********************************************
240
+ * Advanced compression API (Requires v1.4.0+)
241
+ **********************************************/
242
+
243
+ /* API design :
244
+ * Parameters are pushed one by one into an existing context,
245
+ * using ZSTD_CCtx_set*() functions.
246
+ * Pushed parameters are sticky : they are valid for next compressed frame, and any subsequent frame.
247
+ * "sticky" parameters are applicable to `ZSTD_compress2()` and `ZSTD_compressStream*()` !
248
+ * __They do not apply to "simple" one-shot variants such as ZSTD_compressCCtx()__ .
249
+ *
250
+ * It's possible to reset all parameters to "default" using ZSTD_CCtx_reset().
251
+ *
252
+ * This API supersedes all other "advanced" API entry points in the experimental section.
253
+ * In the future, we expect to remove from experimental API entry points which are redundant with this API.
254
+ */
255
+
256
+
257
+ /* Compression strategies, listed from fastest to strongest */
258
+ typedef enum { ZSTD_fast=1,
259
+ ZSTD_dfast=2,
260
+ ZSTD_greedy=3,
261
+ ZSTD_lazy=4,
262
+ ZSTD_lazy2=5,
263
+ ZSTD_btlazy2=6,
264
+ ZSTD_btopt=7,
265
+ ZSTD_btultra=8,
266
+ ZSTD_btultra2=9
267
+ /* note : new strategies _might_ be added in the future.
268
+ Only the order (from fast to strong) is guaranteed */
269
+ } ZSTD_strategy;
270
+
271
+ typedef enum {
272
+
273
+ /* compression parameters
274
+ * Note: When compressing with a ZSTD_CDict these parameters are superseded
275
+ * by the parameters used to construct the ZSTD_CDict.
276
+ * See ZSTD_CCtx_refCDict() for more info (superseded-by-cdict). */
277
+ ZSTD_c_compressionLevel=100, /* Set compression parameters according to pre-defined cLevel table.
278
+ * Note that exact compression parameters are dynamically determined,
279
+ * depending on both compression level and srcSize (when known).
280
+ * Default level is ZSTD_CLEVEL_DEFAULT==3.
281
+ * Special: value 0 means default, which is controlled by ZSTD_CLEVEL_DEFAULT.
282
+ * Note 1 : it's possible to pass a negative compression level.
283
+ * Note 2 : setting a level does not automatically set all other compression parameters
284
+ * to default. Setting this will however eventually dynamically impact the compression
285
+ * parameters which have not been manually set. The manually set
286
+ * ones will 'stick'. */
287
+ /* Advanced compression parameters :
288
+ * It's possible to pin down compression parameters to some specific values.
289
+ * In which case, these values are no longer dynamically selected by the compressor */
290
+ ZSTD_c_windowLog=101, /* Maximum allowed back-reference distance, expressed as power of 2.
291
+ * This will set a memory budget for streaming decompression,
292
+ * with larger values requiring more memory
293
+ * and typically compressing more.
294
+ * Must be clamped between ZSTD_WINDOWLOG_MIN and ZSTD_WINDOWLOG_MAX.
295
+ * Special: value 0 means "use default windowLog".
296
+ * Note: Using a windowLog greater than ZSTD_WINDOWLOG_LIMIT_DEFAULT
297
+ * requires explicitly allowing such size at streaming decompression stage. */
298
+ ZSTD_c_hashLog=102, /* Size of the initial probe table, as a power of 2.
299
+ * Resulting memory usage is (1 << (hashLog+2)).
300
+ * Must be clamped between ZSTD_HASHLOG_MIN and ZSTD_HASHLOG_MAX.
301
+ * Larger tables improve compression ratio of strategies <= dFast,
302
+ * and improve speed of strategies > dFast.
303
+ * Special: value 0 means "use default hashLog". */
304
+ ZSTD_c_chainLog=103, /* Size of the multi-probe search table, as a power of 2.
305
+ * Resulting memory usage is (1 << (chainLog+2)).
306
+ * Must be clamped between ZSTD_CHAINLOG_MIN and ZSTD_CHAINLOG_MAX.
307
+ * Larger tables result in better and slower compression.
308
+ * This parameter is useless for "fast" strategy.
309
+ * It's still useful when using "dfast" strategy,
310
+ * in which case it defines a secondary probe table.
311
+ * Special: value 0 means "use default chainLog". */
312
+ ZSTD_c_searchLog=104, /* Number of search attempts, as a power of 2.
313
+ * More attempts result in better and slower compression.
314
+ * This parameter is useless for "fast" and "dFast" strategies.
315
+ * Special: value 0 means "use default searchLog". */
316
+ ZSTD_c_minMatch=105, /* Minimum size of searched matches.
317
+ * Note that Zstandard can still find matches of smaller size,
318
+ * it just tweaks its search algorithm to look for this size and larger.
319
+ * Larger values increase compression and decompression speed, but decrease ratio.
320
+ * Must be clamped between ZSTD_MINMATCH_MIN and ZSTD_MINMATCH_MAX.
321
+ * Note that currently, for all strategies < btopt, effective minimum is 4.
322
+ * , for all strategies > fast, effective maximum is 6.
323
+ * Special: value 0 means "use default minMatchLength". */
324
+ ZSTD_c_targetLength=106, /* Impact of this field depends on strategy.
325
+ * For strategies btopt, btultra & btultra2:
326
+ * Length of Match considered "good enough" to stop search.
327
+ * Larger values make compression stronger, and slower.
328
+ * For strategy fast:
329
+ * Distance between match sampling.
330
+ * Larger values make compression faster, and weaker.
331
+ * Special: value 0 means "use default targetLength". */
332
+ ZSTD_c_strategy=107, /* See ZSTD_strategy enum definition.
333
+ * The higher the value of selected strategy, the more complex it is,
334
+ * resulting in stronger and slower compression.
335
+ * Special: value 0 means "use default strategy". */
336
+ /* LDM mode parameters */
337
+ ZSTD_c_enableLongDistanceMatching=160, /* Enable long distance matching.
338
+ * This parameter is designed to improve compression ratio
339
+ * for large inputs, by finding large matches at long distance.
340
+ * It increases memory usage and window size.
341
+ * Note: enabling this parameter increases default ZSTD_c_windowLog to 128 MB
342
+ * except when expressly set to a different value.
343
+ * Note: will be enabled by default if ZSTD_c_windowLog >= 128 MB and
344
+ * compression strategy >= ZSTD_btopt (== compression level 16+) */
345
+ ZSTD_c_ldmHashLog=161, /* Size of the table for long distance matching, as a power of 2.
346
+ * Larger values increase memory usage and compression ratio,
347
+ * but decrease compression speed.
348
+ * Must be clamped between ZSTD_HASHLOG_MIN and ZSTD_HASHLOG_MAX
349
+ * default: windowlog - 7.
350
+ * Special: value 0 means "automatically determine hashlog". */
351
+ ZSTD_c_ldmMinMatch=162, /* Minimum match size for long distance matcher.
352
+ * Larger/too small values usually decrease compression ratio.
353
+ * Must be clamped between ZSTD_LDM_MINMATCH_MIN and ZSTD_LDM_MINMATCH_MAX.
354
+ * Special: value 0 means "use default value" (default: 64). */
355
+ ZSTD_c_ldmBucketSizeLog=163, /* Log size of each bucket in the LDM hash table for collision resolution.
356
+ * Larger values improve collision resolution but decrease compression speed.
357
+ * The maximum value is ZSTD_LDM_BUCKETSIZELOG_MAX.
358
+ * Special: value 0 means "use default value" (default: 3). */
359
+ ZSTD_c_ldmHashRateLog=164, /* Frequency of inserting/looking up entries into the LDM hash table.
360
+ * Must be clamped between 0 and (ZSTD_WINDOWLOG_MAX - ZSTD_HASHLOG_MIN).
361
+ * Default is MAX(0, (windowLog - ldmHashLog)), optimizing hash table usage.
362
+ * Larger values improve compression speed.
363
+ * Deviating far from default value will likely result in a compression ratio decrease.
364
+ * Special: value 0 means "automatically determine hashRateLog". */
365
+
366
+ /* frame parameters */
367
+ ZSTD_c_contentSizeFlag=200, /* Content size will be written into frame header _whenever known_ (default:1)
368
+ * Content size must be known at the beginning of compression.
369
+ * This is automatically the case when using ZSTD_compress2(),
370
+ * For streaming scenarios, content size must be provided with ZSTD_CCtx_setPledgedSrcSize() */
371
+ ZSTD_c_checksumFlag=201, /* A 32-bits checksum of content is written at end of frame (default:0) */
372
+ ZSTD_c_dictIDFlag=202, /* When applicable, dictionary's ID is written into frame header (default:1) */
373
+
374
+ /* multi-threading parameters */
375
+ /* These parameters are only active if multi-threading is enabled (compiled with build macro ZSTD_MULTITHREAD).
376
+ * Otherwise, trying to set any other value than default (0) will be a no-op and return an error.
377
+ * In a situation where it's unknown if the linked library supports multi-threading or not,
378
+ * setting ZSTD_c_nbWorkers to any value >= 1 and consulting the return value provides a quick way to check this property.
379
+ */
380
+ ZSTD_c_nbWorkers=400, /* Select how many threads will be spawned to compress in parallel.
381
+ * When nbWorkers >= 1, triggers asynchronous mode when invoking ZSTD_compressStream*() :
382
+ * ZSTD_compressStream*() consumes input and flush output if possible, but immediately gives back control to caller,
383
+ * while compression is performed in parallel, within worker thread(s).
384
+ * (note : a strong exception to this rule is when first invocation of ZSTD_compressStream2() sets ZSTD_e_end :
385
+ * in which case, ZSTD_compressStream2() delegates to ZSTD_compress2(), which is always a blocking call).
386
+ * More workers improve speed, but also increase memory usage.
387
+ * Default value is `0`, aka "single-threaded mode" : no worker is spawned,
388
+ * compression is performed inside Caller's thread, and all invocations are blocking */
389
+ ZSTD_c_jobSize=401, /* Size of a compression job. This value is enforced only when nbWorkers >= 1.
390
+ * Each compression job is completed in parallel, so this value can indirectly impact the nb of active threads.
391
+ * 0 means default, which is dynamically determined based on compression parameters.
392
+ * Job size must be a minimum of overlap size, or ZSTDMT_JOBSIZE_MIN (= 512 KB), whichever is largest.
393
+ * The minimum size is automatically and transparently enforced. */
394
+ ZSTD_c_overlapLog=402, /* Control the overlap size, as a fraction of window size.
395
+ * The overlap size is an amount of data reloaded from previous job at the beginning of a new job.
396
+ * It helps preserve compression ratio, while each job is compressed in parallel.
397
+ * This value is enforced only when nbWorkers >= 1.
398
+ * Larger values increase compression ratio, but decrease speed.
399
+ * Possible values range from 0 to 9 :
400
+ * - 0 means "default" : value will be determined by the library, depending on strategy
401
+ * - 1 means "no overlap"
402
+ * - 9 means "full overlap", using a full window size.
403
+ * Each intermediate rank increases/decreases load size by a factor 2 :
404
+ * 9: full window; 8: w/2; 7: w/4; 6: w/8; 5:w/16; 4: w/32; 3:w/64; 2:w/128; 1:no overlap; 0:default
405
+ * default value varies between 6 and 9, depending on strategy */
406
+
407
+ /* note : additional experimental parameters are also available
408
+ * within the experimental section of the API.
409
+ * At the time of this writing, they include :
410
+ * ZSTD_c_rsyncable
411
+ * ZSTD_c_format
412
+ * ZSTD_c_forceMaxWindow
413
+ * ZSTD_c_forceAttachDict
414
+ * ZSTD_c_literalCompressionMode
415
+ * ZSTD_c_targetCBlockSize
416
+ * ZSTD_c_srcSizeHint
417
+ * ZSTD_c_enableDedicatedDictSearch
418
+ * ZSTD_c_stableInBuffer
419
+ * ZSTD_c_stableOutBuffer
420
+ * ZSTD_c_blockDelimiters
421
+ * ZSTD_c_validateSequences
422
+ * ZSTD_c_useBlockSplitter
423
+ * ZSTD_c_useRowMatchFinder
424
+ * Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
425
+ * note : never ever use experimentalParam? names directly;
426
+ * also, the enums values themselves are unstable and can still change.
427
+ */
428
+ ZSTD_c_experimentalParam1=500,
429
+ ZSTD_c_experimentalParam2=10,
430
+ ZSTD_c_experimentalParam3=1000,
431
+ ZSTD_c_experimentalParam4=1001,
432
+ ZSTD_c_experimentalParam5=1002,
433
+ ZSTD_c_experimentalParam6=1003,
434
+ ZSTD_c_experimentalParam7=1004,
435
+ ZSTD_c_experimentalParam8=1005,
436
+ ZSTD_c_experimentalParam9=1006,
437
+ ZSTD_c_experimentalParam10=1007,
438
+ ZSTD_c_experimentalParam11=1008,
439
+ ZSTD_c_experimentalParam12=1009,
440
+ ZSTD_c_experimentalParam13=1010,
441
+ ZSTD_c_experimentalParam14=1011,
442
+ ZSTD_c_experimentalParam15=1012
443
+ } ZSTD_cParameter;
444
+
445
+ typedef struct {
446
+ size_t error;
447
+ int lowerBound;
448
+ int upperBound;
449
+ } ZSTD_bounds;
450
+
451
+ /*! ZSTD_cParam_getBounds() :
452
+ * All parameters must belong to an interval with lower and upper bounds,
453
+ * otherwise they will either trigger an error or be automatically clamped.
454
+ * @return : a structure, ZSTD_bounds, which contains
455
+ * - an error status field, which must be tested using ZSTD_isError()
456
+ * - lower and upper bounds, both inclusive
457
+ */
458
+ ZSTDLIB_API ZSTD_bounds ZSTD_cParam_getBounds(ZSTD_cParameter cParam);
459
+
460
+ /*! ZSTD_CCtx_setParameter() :
461
+ * Set one compression parameter, selected by enum ZSTD_cParameter.
462
+ * All parameters have valid bounds. Bounds can be queried using ZSTD_cParam_getBounds().
463
+ * Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter).
464
+ * Setting a parameter is generally only possible during frame initialization (before starting compression).
465
+ * Exception : when using multi-threading mode (nbWorkers >= 1),
466
+ * the following parameters can be updated _during_ compression (within same frame):
467
+ * => compressionLevel, hashLog, chainLog, searchLog, minMatch, targetLength and strategy.
468
+ * new parameters will be active for next job only (after a flush()).
469
+ * @return : an error code (which can be tested using ZSTD_isError()).
470
+ */
471
+ ZSTDLIB_API size_t ZSTD_CCtx_setParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param, int value);
472
+
473
+ /*! ZSTD_CCtx_setPledgedSrcSize() :
474
+ * Total input data size to be compressed as a single frame.
475
+ * Value will be written in frame header, unless if explicitly forbidden using ZSTD_c_contentSizeFlag.
476
+ * This value will also be controlled at end of frame, and trigger an error if not respected.
477
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
478
+ * Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.
479
+ * In order to mean "unknown content size", pass constant ZSTD_CONTENTSIZE_UNKNOWN.
480
+ * ZSTD_CONTENTSIZE_UNKNOWN is default value for any new frame.
481
+ * Note 2 : pledgedSrcSize is only valid once, for the next frame.
482
+ * It's discarded at the end of the frame, and replaced by ZSTD_CONTENTSIZE_UNKNOWN.
483
+ * Note 3 : Whenever all input data is provided and consumed in a single round,
484
+ * for example with ZSTD_compress2(),
485
+ * or invoking immediately ZSTD_compressStream2(,,,ZSTD_e_end),
486
+ * this value is automatically overridden by srcSize instead.
487
+ */
488
+ ZSTDLIB_API size_t ZSTD_CCtx_setPledgedSrcSize(ZSTD_CCtx* cctx, unsigned long long pledgedSrcSize);
489
+
490
+ typedef enum {
491
+ ZSTD_reset_session_only = 1,
492
+ ZSTD_reset_parameters = 2,
493
+ ZSTD_reset_session_and_parameters = 3
494
+ } ZSTD_ResetDirective;
495
+
496
+ /*! ZSTD_CCtx_reset() :
497
+ * There are 2 different things that can be reset, independently or jointly :
498
+ * - The session : will stop compressing current frame, and make CCtx ready to start a new one.
499
+ * Useful after an error, or to interrupt any ongoing compression.
500
+ * Any internal data not yet flushed is cancelled.
501
+ * Compression parameters and dictionary remain unchanged.
502
+ * They will be used to compress next frame.
503
+ * Resetting session never fails.
504
+ * - The parameters : changes all parameters back to "default".
505
+ * This removes any reference to any dictionary too.
506
+ * Parameters can only be changed between 2 sessions (i.e. no compression is currently ongoing)
507
+ * otherwise the reset fails, and function returns an error value (which can be tested using ZSTD_isError())
508
+ * - Both : similar to resetting the session, followed by resetting parameters.
509
+ */
510
+ ZSTDLIB_API size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_ResetDirective reset);
511
+
512
+ /*! ZSTD_compress2() :
513
+ * Behave the same as ZSTD_compressCCtx(), but compression parameters are set using the advanced API.
514
+ * ZSTD_compress2() always starts a new frame.
515
+ * Should cctx hold data from a previously unfinished frame, everything about it is forgotten.
516
+ * - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()
517
+ * - The function is always blocking, returns when compression is completed.
518
+ * Hint : compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
519
+ * @return : compressed size written into `dst` (<= `dstCapacity),
520
+ * or an error code if it fails (which can be tested using ZSTD_isError()).
521
+ */
522
+ ZSTDLIB_API size_t ZSTD_compress2( ZSTD_CCtx* cctx,
523
+ void* dst, size_t dstCapacity,
524
+ const void* src, size_t srcSize);
525
+
526
+
527
+ /***********************************************
528
+ * Advanced decompression API (Requires v1.4.0+)
529
+ ************************************************/
530
+
531
+ /* The advanced API pushes parameters one by one into an existing DCtx context.
532
+ * Parameters are sticky, and remain valid for all following frames
533
+ * using the same DCtx context.
534
+ * It's possible to reset parameters to default values using ZSTD_DCtx_reset().
535
+ * Note : This API is compatible with existing ZSTD_decompressDCtx() and ZSTD_decompressStream().
536
+ * Therefore, no new decompression function is necessary.
537
+ */
538
+
539
+ typedef enum {
540
+
541
+ ZSTD_d_windowLogMax=100, /* Select a size limit (in power of 2) beyond which
542
+ * the streaming API will refuse to allocate memory buffer
543
+ * in order to protect the host from unreasonable memory requirements.
544
+ * This parameter is only useful in streaming mode, since no internal buffer is allocated in single-pass mode.
545
+ * By default, a decompression context accepts window sizes <= (1 << ZSTD_WINDOWLOG_LIMIT_DEFAULT).
546
+ * Special: value 0 means "use default maximum windowLog". */
547
+
548
+ /* note : additional experimental parameters are also available
549
+ * within the experimental section of the API.
550
+ * At the time of this writing, they include :
551
+ * ZSTD_d_format
552
+ * ZSTD_d_stableOutBuffer
553
+ * ZSTD_d_forceIgnoreChecksum
554
+ * ZSTD_d_refMultipleDDicts
555
+ * Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
556
+ * note : never ever use experimentalParam? names directly
557
+ */
558
+ ZSTD_d_experimentalParam1=1000,
559
+ ZSTD_d_experimentalParam2=1001,
560
+ ZSTD_d_experimentalParam3=1002,
561
+ ZSTD_d_experimentalParam4=1003
562
+
563
+ } ZSTD_dParameter;
564
+
565
+ /*! ZSTD_dParam_getBounds() :
566
+ * All parameters must belong to an interval with lower and upper bounds,
567
+ * otherwise they will either trigger an error or be automatically clamped.
568
+ * @return : a structure, ZSTD_bounds, which contains
569
+ * - an error status field, which must be tested using ZSTD_isError()
570
+ * - both lower and upper bounds, inclusive
571
+ */
572
+ ZSTDLIB_API ZSTD_bounds ZSTD_dParam_getBounds(ZSTD_dParameter dParam);
573
+
574
+ /*! ZSTD_DCtx_setParameter() :
575
+ * Set one compression parameter, selected by enum ZSTD_dParameter.
576
+ * All parameters have valid bounds. Bounds can be queried using ZSTD_dParam_getBounds().
577
+ * Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter).
578
+ * Setting a parameter is only possible during frame initialization (before starting decompression).
579
+ * @return : 0, or an error code (which can be tested using ZSTD_isError()).
580
+ */
581
+ ZSTDLIB_API size_t ZSTD_DCtx_setParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, int value);
582
+
583
+ /*! ZSTD_DCtx_reset() :
584
+ * Return a DCtx to clean state.
585
+ * Session and parameters can be reset jointly or separately.
586
+ * Parameters can only be reset when no active frame is being decompressed.
587
+ * @return : 0, or an error code, which can be tested with ZSTD_isError()
588
+ */
589
+ ZSTDLIB_API size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_ResetDirective reset);
590
+
591
+
592
+ /****************************
593
+ * Streaming
594
+ ****************************/
595
+
596
+ typedef struct ZSTD_inBuffer_s {
597
+ const void* src; /**< start of input buffer */
598
+ size_t size; /**< size of input buffer */
599
+ size_t pos; /**< position where reading stopped. Will be updated. Necessarily 0 <= pos <= size */
600
+ } ZSTD_inBuffer;
601
+
602
+ typedef struct ZSTD_outBuffer_s {
603
+ void* dst; /**< start of output buffer */
604
+ size_t size; /**< size of output buffer */
605
+ size_t pos; /**< position where writing stopped. Will be updated. Necessarily 0 <= pos <= size */
606
+ } ZSTD_outBuffer;
607
+
608
+
609
+
610
+ /*-***********************************************************************
611
+ * Streaming compression - HowTo
612
+ *
613
+ * A ZSTD_CStream object is required to track streaming operation.
614
+ * Use ZSTD_createCStream() and ZSTD_freeCStream() to create/release resources.
615
+ * ZSTD_CStream objects can be reused multiple times on consecutive compression operations.
616
+ * It is recommended to re-use ZSTD_CStream since it will play nicer with system's memory, by re-using already allocated memory.
617
+ *
618
+ * For parallel execution, use one separate ZSTD_CStream per thread.
619
+ *
620
+ * note : since v1.3.0, ZSTD_CStream and ZSTD_CCtx are the same thing.
621
+ *
622
+ * Parameters are sticky : when starting a new compression on the same context,
623
+ * it will re-use the same sticky parameters as previous compression session.
624
+ * When in doubt, it's recommended to fully initialize the context before usage.
625
+ * Use ZSTD_CCtx_reset() to reset the context and ZSTD_CCtx_setParameter(),
626
+ * ZSTD_CCtx_setPledgedSrcSize(), or ZSTD_CCtx_loadDictionary() and friends to
627
+ * set more specific parameters, the pledged source size, or load a dictionary.
628
+ *
629
+ * Use ZSTD_compressStream2() with ZSTD_e_continue as many times as necessary to
630
+ * consume input stream. The function will automatically update both `pos`
631
+ * fields within `input` and `output`.
632
+ * Note that the function may not consume the entire input, for example, because
633
+ * the output buffer is already full, in which case `input.pos < input.size`.
634
+ * The caller must check if input has been entirely consumed.
635
+ * If not, the caller must make some room to receive more compressed data,
636
+ * and then present again remaining input data.
637
+ * note: ZSTD_e_continue is guaranteed to make some forward progress when called,
638
+ * but doesn't guarantee maximal forward progress. This is especially relevant
639
+ * when compressing with multiple threads. The call won't block if it can
640
+ * consume some input, but if it can't it will wait for some, but not all,
641
+ * output to be flushed.
642
+ * @return : provides a minimum amount of data remaining to be flushed from internal buffers
643
+ * or an error code, which can be tested using ZSTD_isError().
644
+ *
645
+ * At any moment, it's possible to flush whatever data might remain stuck within internal buffer,
646
+ * using ZSTD_compressStream2() with ZSTD_e_flush. `output->pos` will be updated.
647
+ * Note that, if `output->size` is too small, a single invocation with ZSTD_e_flush might not be enough (return code > 0).
648
+ * In which case, make some room to receive more compressed data, and call again ZSTD_compressStream2() with ZSTD_e_flush.
649
+ * You must continue calling ZSTD_compressStream2() with ZSTD_e_flush until it returns 0, at which point you can change the
650
+ * operation.
651
+ * note: ZSTD_e_flush will flush as much output as possible, meaning when compressing with multiple threads, it will
652
+ * block until the flush is complete or the output buffer is full.
653
+ * @return : 0 if internal buffers are entirely flushed,
654
+ * >0 if some data still present within internal buffer (the value is minimal estimation of remaining size),
655
+ * or an error code, which can be tested using ZSTD_isError().
656
+ *
657
+ * Calling ZSTD_compressStream2() with ZSTD_e_end instructs to finish a frame.
658
+ * It will perform a flush and write frame epilogue.
659
+ * The epilogue is required for decoders to consider a frame completed.
660
+ * flush operation is the same, and follows same rules as calling ZSTD_compressStream2() with ZSTD_e_flush.
661
+ * You must continue calling ZSTD_compressStream2() with ZSTD_e_end until it returns 0, at which point you are free to
662
+ * start a new frame.
663
+ * note: ZSTD_e_end will flush as much output as possible, meaning when compressing with multiple threads, it will
664
+ * block until the flush is complete or the output buffer is full.
665
+ * @return : 0 if frame fully completed and fully flushed,
666
+ * >0 if some data still present within internal buffer (the value is minimal estimation of remaining size),
667
+ * or an error code, which can be tested using ZSTD_isError().
668
+ *
669
+ * *******************************************************************/
670
+
671
+ typedef ZSTD_CCtx ZSTD_CStream; /**< CCtx and CStream are now effectively same object (>= v1.3.0) */
672
+ /* Continue to distinguish them for compatibility with older versions <= v1.2.0 */
673
+ /*===== ZSTD_CStream management functions =====*/
674
+ ZSTDLIB_API ZSTD_CStream* ZSTD_createCStream(void);
675
+ ZSTDLIB_API size_t ZSTD_freeCStream(ZSTD_CStream* zcs); /* accept NULL pointer */
676
+
677
+ /*===== Streaming compression functions =====*/
678
+ typedef enum {
679
+ ZSTD_e_continue=0, /* collect more data, encoder decides when to output compressed result, for optimal compression ratio */
680
+ ZSTD_e_flush=1, /* flush any data provided so far,
681
+ * it creates (at least) one new block, that can be decoded immediately on reception;
682
+ * frame will continue: any future data can still reference previously compressed data, improving compression.
683
+ * note : multithreaded compression will block to flush as much output as possible. */
684
+ ZSTD_e_end=2 /* flush any remaining data _and_ close current frame.
685
+ * note that frame is only closed after compressed data is fully flushed (return value == 0).
686
+ * After that point, any additional data starts a new frame.
687
+ * note : each frame is independent (does not reference any content from previous frame).
688
+ : note : multithreaded compression will block to flush as much output as possible. */
689
+ } ZSTD_EndDirective;
690
+
691
+ /*! ZSTD_compressStream2() : Requires v1.4.0+
692
+ * Behaves about the same as ZSTD_compressStream, with additional control on end directive.
693
+ * - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()
694
+ * - Compression parameters cannot be changed once compression is started (save a list of exceptions in multi-threading mode)
695
+ * - output->pos must be <= dstCapacity, input->pos must be <= srcSize
696
+ * - output->pos and input->pos will be updated. They are guaranteed to remain below their respective limit.
697
+ * - endOp must be a valid directive
698
+ * - When nbWorkers==0 (default), function is blocking : it completes its job before returning to caller.
699
+ * - When nbWorkers>=1, function is non-blocking : it copies a portion of input, distributes jobs to internal worker threads, flush to output whatever is available,
700
+ * and then immediately returns, just indicating that there is some data remaining to be flushed.
701
+ * The function nonetheless guarantees forward progress : it will return only after it reads or write at least 1+ byte.
702
+ * - Exception : if the first call requests a ZSTD_e_end directive and provides enough dstCapacity, the function delegates to ZSTD_compress2() which is always blocking.
703
+ * - @return provides a minimum amount of data remaining to be flushed from internal buffers
704
+ * or an error code, which can be tested using ZSTD_isError().
705
+ * if @return != 0, flush is not fully completed, there is still some data left within internal buffers.
706
+ * This is useful for ZSTD_e_flush, since in this case more flushes are necessary to empty all buffers.
707
+ * For ZSTD_e_end, @return == 0 when internal buffers are fully flushed and frame is completed.
708
+ * - after a ZSTD_e_end directive, if internal buffer is not fully flushed (@return != 0),
709
+ * only ZSTD_e_end or ZSTD_e_flush operations are allowed.
710
+ * Before starting a new compression job, or changing compression parameters,
711
+ * it is required to fully flush internal buffers.
712
+ */
713
+ ZSTDLIB_API size_t ZSTD_compressStream2( ZSTD_CCtx* cctx,
714
+ ZSTD_outBuffer* output,
715
+ ZSTD_inBuffer* input,
716
+ ZSTD_EndDirective endOp);
717
+
718
+
719
+ /* These buffer sizes are softly recommended.
720
+ * They are not required : ZSTD_compressStream*() happily accepts any buffer size, for both input and output.
721
+ * Respecting the recommended size just makes it a bit easier for ZSTD_compressStream*(),
722
+ * reducing the amount of memory shuffling and buffering, resulting in minor performance savings.
723
+ *
724
+ * However, note that these recommendations are from the perspective of a C caller program.
725
+ * If the streaming interface is invoked from some other language,
726
+ * especially managed ones such as Java or Go, through a foreign function interface such as jni or cgo,
727
+ * a major performance rule is to reduce crossing such interface to an absolute minimum.
728
+ * It's not rare that performance ends being spent more into the interface, rather than compression itself.
729
+ * In which cases, prefer using large buffers, as large as practical,
730
+ * for both input and output, to reduce the nb of roundtrips.
731
+ */
732
+ ZSTDLIB_API size_t ZSTD_CStreamInSize(void); /**< recommended size for input buffer */
733
+ ZSTDLIB_API size_t ZSTD_CStreamOutSize(void); /**< recommended size for output buffer. Guarantee to successfully flush at least one complete compressed block. */
734
+
735
+
736
+ /* *****************************************************************************
737
+ * This following is a legacy streaming API, available since v1.0+ .
738
+ * It can be replaced by ZSTD_CCtx_reset() and ZSTD_compressStream2().
739
+ * It is redundant, but remains fully supported.
740
+ * Streaming in combination with advanced parameters and dictionary compression
741
+ * can only be used through the new API.
742
+ ******************************************************************************/
743
+
744
+ /*!
745
+ * Equivalent to:
746
+ *
747
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
748
+ * ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)
749
+ * ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
750
+ */
751
+ ZSTDLIB_API size_t ZSTD_initCStream(ZSTD_CStream* zcs, int compressionLevel);
752
+ /*!
753
+ * Alternative for ZSTD_compressStream2(zcs, output, input, ZSTD_e_continue).
754
+ * NOTE: The return value is different. ZSTD_compressStream() returns a hint for
755
+ * the next read size (if non-zero and not an error). ZSTD_compressStream2()
756
+ * returns the minimum nb of bytes left to flush (if non-zero and not an error).
757
+ */
758
+ ZSTDLIB_API size_t ZSTD_compressStream(ZSTD_CStream* zcs, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
759
+ /*! Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_flush). */
760
+ ZSTDLIB_API size_t ZSTD_flushStream(ZSTD_CStream* zcs, ZSTD_outBuffer* output);
761
+ /*! Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_end). */
762
+ ZSTDLIB_API size_t ZSTD_endStream(ZSTD_CStream* zcs, ZSTD_outBuffer* output);
763
+
764
+
765
+ /*-***************************************************************************
766
+ * Streaming decompression - HowTo
767
+ *
768
+ * A ZSTD_DStream object is required to track streaming operations.
769
+ * Use ZSTD_createDStream() and ZSTD_freeDStream() to create/release resources.
770
+ * ZSTD_DStream objects can be re-used multiple times.
771
+ *
772
+ * Use ZSTD_initDStream() to start a new decompression operation.
773
+ * @return : recommended first input size
774
+ * Alternatively, use advanced API to set specific properties.
775
+ *
776
+ * Use ZSTD_decompressStream() repetitively to consume your input.
777
+ * The function will update both `pos` fields.
778
+ * If `input.pos < input.size`, some input has not been consumed.
779
+ * It's up to the caller to present again remaining data.
780
+ * The function tries to flush all data decoded immediately, respecting output buffer size.
781
+ * If `output.pos < output.size`, decoder has flushed everything it could.
782
+ * But if `output.pos == output.size`, there might be some data left within internal buffers.,
783
+ * In which case, call ZSTD_decompressStream() again to flush whatever remains in the buffer.
784
+ * Note : with no additional input provided, amount of data flushed is necessarily <= ZSTD_BLOCKSIZE_MAX.
785
+ * @return : 0 when a frame is completely decoded and fully flushed,
786
+ * or an error code, which can be tested using ZSTD_isError(),
787
+ * or any other value > 0, which means there is still some decoding or flushing to do to complete current frame :
788
+ * the return value is a suggested next input size (just a hint for better latency)
789
+ * that will never request more than the remaining frame size.
790
+ * *******************************************************************************/
791
+
792
+ typedef ZSTD_DCtx ZSTD_DStream; /**< DCtx and DStream are now effectively same object (>= v1.3.0) */
793
+ /* For compatibility with versions <= v1.2.0, prefer differentiating them. */
794
+ /*===== ZSTD_DStream management functions =====*/
795
+ ZSTDLIB_API ZSTD_DStream* ZSTD_createDStream(void);
796
+ ZSTDLIB_API size_t ZSTD_freeDStream(ZSTD_DStream* zds); /* accept NULL pointer */
797
+
798
+ /*===== Streaming decompression functions =====*/
799
+
800
+ /* This function is redundant with the advanced API and equivalent to:
801
+ *
802
+ * ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);
803
+ * ZSTD_DCtx_refDDict(zds, NULL);
804
+ */
805
+ ZSTDLIB_API size_t ZSTD_initDStream(ZSTD_DStream* zds);
806
+
807
+ ZSTDLIB_API size_t ZSTD_decompressStream(ZSTD_DStream* zds, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
808
+
809
+ ZSTDLIB_API size_t ZSTD_DStreamInSize(void); /*!< recommended size for input buffer */
810
+ ZSTDLIB_API size_t ZSTD_DStreamOutSize(void); /*!< recommended size for output buffer. Guarantee to successfully flush at least one complete block in all circumstances. */
811
+
812
+
813
+ /**************************
814
+ * Simple dictionary API
815
+ ***************************/
816
+ /*! ZSTD_compress_usingDict() :
817
+ * Compression at an explicit compression level using a Dictionary.
818
+ * A dictionary can be any arbitrary data segment (also called a prefix),
819
+ * or a buffer with specified information (see zdict.h).
820
+ * Note : This function loads the dictionary, resulting in significant startup delay.
821
+ * It's intended for a dictionary used only once.
822
+ * Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used. */
823
+ ZSTDLIB_API size_t ZSTD_compress_usingDict(ZSTD_CCtx* ctx,
824
+ void* dst, size_t dstCapacity,
825
+ const void* src, size_t srcSize,
826
+ const void* dict,size_t dictSize,
827
+ int compressionLevel);
828
+
829
+ /*! ZSTD_decompress_usingDict() :
830
+ * Decompression using a known Dictionary.
831
+ * Dictionary must be identical to the one used during compression.
832
+ * Note : This function loads the dictionary, resulting in significant startup delay.
833
+ * It's intended for a dictionary used only once.
834
+ * Note : When `dict == NULL || dictSize < 8` no dictionary is used. */
835
+ ZSTDLIB_API size_t ZSTD_decompress_usingDict(ZSTD_DCtx* dctx,
836
+ void* dst, size_t dstCapacity,
837
+ const void* src, size_t srcSize,
838
+ const void* dict,size_t dictSize);
839
+
840
+
841
+ /***********************************
842
+ * Bulk processing dictionary API
843
+ **********************************/
844
+ typedef struct ZSTD_CDict_s ZSTD_CDict;
845
+
846
+ /*! ZSTD_createCDict() :
847
+ * When compressing multiple messages or blocks using the same dictionary,
848
+ * it's recommended to digest the dictionary only once, since it's a costly operation.
849
+ * ZSTD_createCDict() will create a state from digesting a dictionary.
850
+ * The resulting state can be used for future compression operations with very limited startup cost.
851
+ * ZSTD_CDict can be created once and shared by multiple threads concurrently, since its usage is read-only.
852
+ * @dictBuffer can be released after ZSTD_CDict creation, because its content is copied within CDict.
853
+ * Note 1 : Consider experimental function `ZSTD_createCDict_byReference()` if you prefer to not duplicate @dictBuffer content.
854
+ * Note 2 : A ZSTD_CDict can be created from an empty @dictBuffer,
855
+ * in which case the only thing that it transports is the @compressionLevel.
856
+ * This can be useful in a pipeline featuring ZSTD_compress_usingCDict() exclusively,
857
+ * expecting a ZSTD_CDict parameter with any data, including those without a known dictionary. */
858
+ ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict(const void* dictBuffer, size_t dictSize,
859
+ int compressionLevel);
860
+
861
+ /*! ZSTD_freeCDict() :
862
+ * Function frees memory allocated by ZSTD_createCDict().
863
+ * If a NULL pointer is passed, no operation is performed. */
864
+ ZSTDLIB_API size_t ZSTD_freeCDict(ZSTD_CDict* CDict);
865
+
866
+ /*! ZSTD_compress_usingCDict() :
867
+ * Compression using a digested Dictionary.
868
+ * Recommended when same dictionary is used multiple times.
869
+ * Note : compression level is _decided at dictionary creation time_,
870
+ * and frame parameters are hardcoded (dictID=yes, contentSize=yes, checksum=no) */
871
+ ZSTDLIB_API size_t ZSTD_compress_usingCDict(ZSTD_CCtx* cctx,
872
+ void* dst, size_t dstCapacity,
873
+ const void* src, size_t srcSize,
874
+ const ZSTD_CDict* cdict);
875
+
876
+
877
+ typedef struct ZSTD_DDict_s ZSTD_DDict;
878
+
879
+ /*! ZSTD_createDDict() :
880
+ * Create a digested dictionary, ready to start decompression operation without startup delay.
881
+ * dictBuffer can be released after DDict creation, as its content is copied inside DDict. */
882
+ ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict(const void* dictBuffer, size_t dictSize);
883
+
884
+ /*! ZSTD_freeDDict() :
885
+ * Function frees memory allocated with ZSTD_createDDict()
886
+ * If a NULL pointer is passed, no operation is performed. */
887
+ ZSTDLIB_API size_t ZSTD_freeDDict(ZSTD_DDict* ddict);
888
+
889
+ /*! ZSTD_decompress_usingDDict() :
890
+ * Decompression using a digested Dictionary.
891
+ * Recommended when same dictionary is used multiple times. */
892
+ ZSTDLIB_API size_t ZSTD_decompress_usingDDict(ZSTD_DCtx* dctx,
893
+ void* dst, size_t dstCapacity,
894
+ const void* src, size_t srcSize,
895
+ const ZSTD_DDict* ddict);
896
+
897
+
898
+ /********************************
899
+ * Dictionary helper functions
900
+ *******************************/
901
+
902
+ /*! ZSTD_getDictID_fromDict() : Requires v1.4.0+
903
+ * Provides the dictID stored within dictionary.
904
+ * if @return == 0, the dictionary is not conformant with Zstandard specification.
905
+ * It can still be loaded, but as a content-only dictionary. */
906
+ ZSTDLIB_API unsigned ZSTD_getDictID_fromDict(const void* dict, size_t dictSize);
907
+
908
+ /*! ZSTD_getDictID_fromCDict() : Requires v1.5.0+
909
+ * Provides the dictID of the dictionary loaded into `cdict`.
910
+ * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
911
+ * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
912
+ ZSTDLIB_API unsigned ZSTD_getDictID_fromCDict(const ZSTD_CDict* cdict);
913
+
914
+ /*! ZSTD_getDictID_fromDDict() : Requires v1.4.0+
915
+ * Provides the dictID of the dictionary loaded into `ddict`.
916
+ * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
917
+ * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
918
+ ZSTDLIB_API unsigned ZSTD_getDictID_fromDDict(const ZSTD_DDict* ddict);
919
+
920
+ /*! ZSTD_getDictID_fromFrame() : Requires v1.4.0+
921
+ * Provides the dictID required to decompressed the frame stored within `src`.
922
+ * If @return == 0, the dictID could not be decoded.
923
+ * This could for one of the following reasons :
924
+ * - The frame does not require a dictionary to be decoded (most common case).
925
+ * - The frame was built with dictID intentionally removed. Whatever dictionary is necessary is a hidden information.
926
+ * Note : this use case also happens when using a non-conformant dictionary.
927
+ * - `srcSize` is too small, and as a result, the frame header could not be decoded (only possible if `srcSize < ZSTD_FRAMEHEADERSIZE_MAX`).
928
+ * - This is not a Zstandard frame.
929
+ * When identifying the exact failure cause, it's possible to use ZSTD_getFrameHeader(), which will provide a more precise error code. */
930
+ ZSTDLIB_API unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
931
+
932
+
933
+ /*******************************************************************************
934
+ * Advanced dictionary and prefix API (Requires v1.4.0+)
935
+ *
936
+ * This API allows dictionaries to be used with ZSTD_compress2(),
937
+ * ZSTD_compressStream2(), and ZSTD_decompressDCtx(). Dictionaries are sticky, and
938
+ * only reset with the context is reset with ZSTD_reset_parameters or
939
+ * ZSTD_reset_session_and_parameters. Prefixes are single-use.
940
+ ******************************************************************************/
941
+
942
+
943
+ /*! ZSTD_CCtx_loadDictionary() : Requires v1.4.0+
944
+ * Create an internal CDict from `dict` buffer.
945
+ * Decompression will have to use same dictionary.
946
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
947
+ * Special: Loading a NULL (or 0-size) dictionary invalidates previous dictionary,
948
+ * meaning "return to no-dictionary mode".
949
+ * Note 1 : Dictionary is sticky, it will be used for all future compressed frames.
950
+ * To return to "no-dictionary" situation, load a NULL dictionary (or reset parameters).
951
+ * Note 2 : Loading a dictionary involves building tables.
952
+ * It's also a CPU consuming operation, with non-negligible impact on latency.
953
+ * Tables are dependent on compression parameters, and for this reason,
954
+ * compression parameters can no longer be changed after loading a dictionary.
955
+ * Note 3 :`dict` content will be copied internally.
956
+ * Use experimental ZSTD_CCtx_loadDictionary_byReference() to reference content instead.
957
+ * In such a case, dictionary buffer must outlive its users.
958
+ * Note 4 : Use ZSTD_CCtx_loadDictionary_advanced()
959
+ * to precisely select how dictionary content must be interpreted. */
960
+ ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
961
+
962
+ /*! ZSTD_CCtx_refCDict() : Requires v1.4.0+
963
+ * Reference a prepared dictionary, to be used for all next compressed frames.
964
+ * Note that compression parameters are enforced from within CDict,
965
+ * and supersede any compression parameter previously set within CCtx.
966
+ * The parameters ignored are labelled as "superseded-by-cdict" in the ZSTD_cParameter enum docs.
967
+ * The ignored parameters will be used again if the CCtx is returned to no-dictionary mode.
968
+ * The dictionary will remain valid for future compressed frames using same CCtx.
969
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
970
+ * Special : Referencing a NULL CDict means "return to no-dictionary mode".
971
+ * Note 1 : Currently, only one dictionary can be managed.
972
+ * Referencing a new dictionary effectively "discards" any previous one.
973
+ * Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. */
974
+ ZSTDLIB_API size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);
975
+
976
+ /*! ZSTD_CCtx_refPrefix() : Requires v1.4.0+
977
+ * Reference a prefix (single-usage dictionary) for next compressed frame.
978
+ * A prefix is **only used once**. Tables are discarded at end of frame (ZSTD_e_end).
979
+ * Decompression will need same prefix to properly regenerate data.
980
+ * Compressing with a prefix is similar in outcome as performing a diff and compressing it,
981
+ * but performs much faster, especially during decompression (compression speed is tunable with compression level).
982
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
983
+ * Special: Adding any prefix (including NULL) invalidates any previous prefix or dictionary
984
+ * Note 1 : Prefix buffer is referenced. It **must** outlive compression.
985
+ * Its content must remain unmodified during compression.
986
+ * Note 2 : If the intention is to diff some large src data blob with some prior version of itself,
987
+ * ensure that the window size is large enough to contain the entire source.
988
+ * See ZSTD_c_windowLog.
989
+ * Note 3 : Referencing a prefix involves building tables, which are dependent on compression parameters.
990
+ * It's a CPU consuming operation, with non-negligible impact on latency.
991
+ * If there is a need to use the same prefix multiple times, consider loadDictionary instead.
992
+ * Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dct_rawContent).
993
+ * Use experimental ZSTD_CCtx_refPrefix_advanced() to alter dictionary interpretation. */
994
+ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx,
995
+ const void* prefix, size_t prefixSize);
996
+
997
+ /*! ZSTD_DCtx_loadDictionary() : Requires v1.4.0+
998
+ * Create an internal DDict from dict buffer,
999
+ * to be used to decompress next frames.
1000
+ * The dictionary remains valid for all future frames, until explicitly invalidated.
1001
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1002
+ * Special : Adding a NULL (or 0-size) dictionary invalidates any previous dictionary,
1003
+ * meaning "return to no-dictionary mode".
1004
+ * Note 1 : Loading a dictionary involves building tables,
1005
+ * which has a non-negligible impact on CPU usage and latency.
1006
+ * It's recommended to "load once, use many times", to amortize the cost
1007
+ * Note 2 :`dict` content will be copied internally, so `dict` can be released after loading.
1008
+ * Use ZSTD_DCtx_loadDictionary_byReference() to reference dictionary content instead.
1009
+ * Note 3 : Use ZSTD_DCtx_loadDictionary_advanced() to take control of
1010
+ * how dictionary content is loaded and interpreted.
1011
+ */
1012
+ ZSTDLIB_API size_t ZSTD_DCtx_loadDictionary(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
1013
+
1014
+ /*! ZSTD_DCtx_refDDict() : Requires v1.4.0+
1015
+ * Reference a prepared dictionary, to be used to decompress next frames.
1016
+ * The dictionary remains active for decompression of future frames using same DCtx.
1017
+ *
1018
+ * If called with ZSTD_d_refMultipleDDicts enabled, repeated calls of this function
1019
+ * will store the DDict references in a table, and the DDict used for decompression
1020
+ * will be determined at decompression time, as per the dict ID in the frame.
1021
+ * The memory for the table is allocated on the first call to refDDict, and can be
1022
+ * freed with ZSTD_freeDCtx().
1023
+ *
1024
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1025
+ * Note 1 : Currently, only one dictionary can be managed.
1026
+ * Referencing a new dictionary effectively "discards" any previous one.
1027
+ * Special: referencing a NULL DDict means "return to no-dictionary mode".
1028
+ * Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx.
1029
+ */
1030
+ ZSTDLIB_API size_t ZSTD_DCtx_refDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
1031
+
1032
+ /*! ZSTD_DCtx_refPrefix() : Requires v1.4.0+
1033
+ * Reference a prefix (single-usage dictionary) to decompress next frame.
1034
+ * This is the reverse operation of ZSTD_CCtx_refPrefix(),
1035
+ * and must use the same prefix as the one used during compression.
1036
+ * Prefix is **only used once**. Reference is discarded at end of frame.
1037
+ * End of frame is reached when ZSTD_decompressStream() returns 0.
1038
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
1039
+ * Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary
1040
+ * Note 2 : Prefix buffer is referenced. It **must** outlive decompression.
1041
+ * Prefix buffer must remain unmodified up to the end of frame,
1042
+ * reached when ZSTD_decompressStream() returns 0.
1043
+ * Note 3 : By default, the prefix is treated as raw content (ZSTD_dct_rawContent).
1044
+ * Use ZSTD_CCtx_refPrefix_advanced() to alter dictMode (Experimental section)
1045
+ * Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost.
1046
+ * A full dictionary is more costly, as it requires building tables.
1047
+ */
1048
+ ZSTDLIB_API size_t ZSTD_DCtx_refPrefix(ZSTD_DCtx* dctx,
1049
+ const void* prefix, size_t prefixSize);
1050
+
1051
+ /* === Memory management === */
1052
+
1053
+ /*! ZSTD_sizeof_*() : Requires v1.4.0+
1054
+ * These functions give the _current_ memory usage of selected object.
1055
+ * Note that object memory usage can evolve (increase or decrease) over time. */
1056
+ ZSTDLIB_API size_t ZSTD_sizeof_CCtx(const ZSTD_CCtx* cctx);
1057
+ ZSTDLIB_API size_t ZSTD_sizeof_DCtx(const ZSTD_DCtx* dctx);
1058
+ ZSTDLIB_API size_t ZSTD_sizeof_CStream(const ZSTD_CStream* zcs);
1059
+ ZSTDLIB_API size_t ZSTD_sizeof_DStream(const ZSTD_DStream* zds);
1060
+ ZSTDLIB_API size_t ZSTD_sizeof_CDict(const ZSTD_CDict* cdict);
1061
+ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
1062
+
1063
+ #endif /* ZSTD_H_235446 */
1064
+
1065
+
1066
+ /* **************************************************************************************
1067
+ * ADVANCED AND EXPERIMENTAL FUNCTIONS
1068
+ ****************************************************************************************
1069
+ * The definitions in the following section are considered experimental.
1070
+ * They are provided for advanced scenarios.
1071
+ * They should never be used with a dynamic library, as prototypes may change in the future.
1072
+ * Use them only in association with static linking.
1073
+ * ***************************************************************************************/
1074
+
1075
+ #if defined(ZSTD_STATIC_LINKING_ONLY) && !defined(ZSTD_H_ZSTD_STATIC_LINKING_ONLY)
1076
+ #define ZSTD_H_ZSTD_STATIC_LINKING_ONLY
1077
+
1078
+ /* This can be overridden externally to hide static symbols. */
1079
+ #ifndef ZSTDLIB_STATIC_API
1080
+ # if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
1081
+ # define ZSTDLIB_STATIC_API __declspec(dllexport) ZSTDLIB_VISIBLE
1082
+ # elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
1083
+ # define ZSTDLIB_STATIC_API __declspec(dllimport) ZSTDLIB_VISIBLE
1084
+ # else
1085
+ # define ZSTDLIB_STATIC_API ZSTDLIB_VISIBLE
1086
+ # endif
1087
+ #endif
1088
+
1089
+ /* Deprecation warnings :
1090
+ * Should these warnings be a problem, it is generally possible to disable them,
1091
+ * typically with -Wno-deprecated-declarations for gcc or _CRT_SECURE_NO_WARNINGS in Visual.
1092
+ * Otherwise, it's also possible to define ZSTD_DISABLE_DEPRECATE_WARNINGS.
1093
+ */
1094
+ #ifdef ZSTD_DISABLE_DEPRECATE_WARNINGS
1095
+ # define ZSTD_DEPRECATED(message) ZSTDLIB_STATIC_API /* disable deprecation warnings */
1096
+ #else
1097
+ # if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */
1098
+ # define ZSTD_DEPRECATED(message) [[deprecated(message)]] ZSTDLIB_STATIC_API
1099
+ # elif (defined(GNUC) && (GNUC > 4 || (GNUC == 4 && GNUC_MINOR >= 5))) || defined(__clang__)
1100
+ # define ZSTD_DEPRECATED(message) ZSTDLIB_STATIC_API __attribute__((deprecated(message)))
1101
+ # elif defined(__GNUC__) && (__GNUC__ >= 3)
1102
+ # define ZSTD_DEPRECATED(message) ZSTDLIB_STATIC_API __attribute__((deprecated))
1103
+ # elif defined(_MSC_VER)
1104
+ # define ZSTD_DEPRECATED(message) ZSTDLIB_STATIC_API __declspec(deprecated(message))
1105
+ # else
1106
+ # pragma message("WARNING: You need to implement ZSTD_DEPRECATED for this compiler")
1107
+ # define ZSTD_DEPRECATED(message) ZSTDLIB_STATIC_API
1108
+ # endif
1109
+ #endif /* ZSTD_DISABLE_DEPRECATE_WARNINGS */
1110
+
1111
+ /****************************************************************************************
1112
+ * experimental API (static linking only)
1113
+ ****************************************************************************************
1114
+ * The following symbols and constants
1115
+ * are not planned to join "stable API" status in the near future.
1116
+ * They can still change in future versions.
1117
+ * Some of them are planned to remain in the static_only section indefinitely.
1118
+ * Some of them might be removed in the future (especially when redundant with existing stable functions)
1119
+ * ***************************************************************************************/
1120
+
1121
+ #define ZSTD_FRAMEHEADERSIZE_PREFIX(format) ((format) == ZSTD_f_zstd1 ? 5 : 1) /* minimum input size required to query frame header size */
1122
+ #define ZSTD_FRAMEHEADERSIZE_MIN(format) ((format) == ZSTD_f_zstd1 ? 6 : 2)
1123
+ #define ZSTD_FRAMEHEADERSIZE_MAX 18 /* can be useful for static allocation */
1124
+ #define ZSTD_SKIPPABLEHEADERSIZE 8
1125
+
1126
+ /* compression parameter bounds */
1127
+ #define ZSTD_WINDOWLOG_MAX_32 30
1128
+ #define ZSTD_WINDOWLOG_MAX_64 31
1129
+ #define ZSTD_WINDOWLOG_MAX ((int)(sizeof(size_t) == 4 ? ZSTD_WINDOWLOG_MAX_32 : ZSTD_WINDOWLOG_MAX_64))
1130
+ #define ZSTD_WINDOWLOG_MIN 10
1131
+ #define ZSTD_HASHLOG_MAX ((ZSTD_WINDOWLOG_MAX < 30) ? ZSTD_WINDOWLOG_MAX : 30)
1132
+ #define ZSTD_HASHLOG_MIN 6
1133
+ #define ZSTD_CHAINLOG_MAX_32 29
1134
+ #define ZSTD_CHAINLOG_MAX_64 30
1135
+ #define ZSTD_CHAINLOG_MAX ((int)(sizeof(size_t) == 4 ? ZSTD_CHAINLOG_MAX_32 : ZSTD_CHAINLOG_MAX_64))
1136
+ #define ZSTD_CHAINLOG_MIN ZSTD_HASHLOG_MIN
1137
+ #define ZSTD_SEARCHLOG_MAX (ZSTD_WINDOWLOG_MAX-1)
1138
+ #define ZSTD_SEARCHLOG_MIN 1
1139
+ #define ZSTD_MINMATCH_MAX 7 /* only for ZSTD_fast, other strategies are limited to 6 */
1140
+ #define ZSTD_MINMATCH_MIN 3 /* only for ZSTD_btopt+, faster strategies are limited to 4 */
1141
+ #define ZSTD_TARGETLENGTH_MAX ZSTD_BLOCKSIZE_MAX
1142
+ #define ZSTD_TARGETLENGTH_MIN 0 /* note : comparing this constant to an unsigned results in a tautological test */
1143
+ #define ZSTD_STRATEGY_MIN ZSTD_fast
1144
+ #define ZSTD_STRATEGY_MAX ZSTD_btultra2
1145
+
1146
+
1147
+ #define ZSTD_OVERLAPLOG_MIN 0
1148
+ #define ZSTD_OVERLAPLOG_MAX 9
1149
+
1150
+ #define ZSTD_WINDOWLOG_LIMIT_DEFAULT 27 /* by default, the streaming decoder will refuse any frame
1151
+ * requiring larger than (1<<ZSTD_WINDOWLOG_LIMIT_DEFAULT) window size,
1152
+ * to preserve host's memory from unreasonable requirements.
1153
+ * This limit can be overridden using ZSTD_DCtx_setParameter(,ZSTD_d_windowLogMax,).
1154
+ * The limit does not apply for one-pass decoders (such as ZSTD_decompress()), since no additional memory is allocated */
1155
+
1156
+
1157
+ /* LDM parameter bounds */
1158
+ #define ZSTD_LDM_HASHLOG_MIN ZSTD_HASHLOG_MIN
1159
+ #define ZSTD_LDM_HASHLOG_MAX ZSTD_HASHLOG_MAX
1160
+ #define ZSTD_LDM_MINMATCH_MIN 4
1161
+ #define ZSTD_LDM_MINMATCH_MAX 4096
1162
+ #define ZSTD_LDM_BUCKETSIZELOG_MIN 1
1163
+ #define ZSTD_LDM_BUCKETSIZELOG_MAX 8
1164
+ #define ZSTD_LDM_HASHRATELOG_MIN 0
1165
+ #define ZSTD_LDM_HASHRATELOG_MAX (ZSTD_WINDOWLOG_MAX - ZSTD_HASHLOG_MIN)
1166
+
1167
+ /* Advanced parameter bounds */
1168
+ #define ZSTD_TARGETCBLOCKSIZE_MIN 64
1169
+ #define ZSTD_TARGETCBLOCKSIZE_MAX ZSTD_BLOCKSIZE_MAX
1170
+ #define ZSTD_SRCSIZEHINT_MIN 0
1171
+ #define ZSTD_SRCSIZEHINT_MAX INT_MAX
1172
+
1173
+
1174
+ /* --- Advanced types --- */
1175
+
1176
+ typedef struct ZSTD_CCtx_params_s ZSTD_CCtx_params;
1177
+
1178
+ typedef struct {
1179
+ unsigned int offset; /* The offset of the match. (NOT the same as the offset code)
1180
+ * If offset == 0 and matchLength == 0, this sequence represents the last
1181
+ * literals in the block of litLength size.
1182
+ */
1183
+
1184
+ unsigned int litLength; /* Literal length of the sequence. */
1185
+ unsigned int matchLength; /* Match length of the sequence. */
1186
+
1187
+ /* Note: Users of this API may provide a sequence with matchLength == litLength == offset == 0.
1188
+ * In this case, we will treat the sequence as a marker for a block boundary.
1189
+ */
1190
+
1191
+ unsigned int rep; /* Represents which repeat offset is represented by the field 'offset'.
1192
+ * Ranges from [0, 3].
1193
+ *
1194
+ * Repeat offsets are essentially previous offsets from previous sequences sorted in
1195
+ * recency order. For more detail, see doc/zstd_compression_format.md
1196
+ *
1197
+ * If rep == 0, then 'offset' does not contain a repeat offset.
1198
+ * If rep > 0:
1199
+ * If litLength != 0:
1200
+ * rep == 1 --> offset == repeat_offset_1
1201
+ * rep == 2 --> offset == repeat_offset_2
1202
+ * rep == 3 --> offset == repeat_offset_3
1203
+ * If litLength == 0:
1204
+ * rep == 1 --> offset == repeat_offset_2
1205
+ * rep == 2 --> offset == repeat_offset_3
1206
+ * rep == 3 --> offset == repeat_offset_1 - 1
1207
+ *
1208
+ * Note: This field is optional. ZSTD_generateSequences() will calculate the value of
1209
+ * 'rep', but repeat offsets do not necessarily need to be calculated from an external
1210
+ * sequence provider's perspective. For example, ZSTD_compressSequences() does not
1211
+ * use this 'rep' field at all (as of now).
1212
+ */
1213
+ } ZSTD_Sequence;
1214
+
1215
+ typedef struct {
1216
+ unsigned windowLog; /**< largest match distance : larger == more compression, more memory needed during decompression */
1217
+ unsigned chainLog; /**< fully searched segment : larger == more compression, slower, more memory (useless for fast) */
1218
+ unsigned hashLog; /**< dispatch table : larger == faster, more memory */
1219
+ unsigned searchLog; /**< nb of searches : larger == more compression, slower */
1220
+ unsigned minMatch; /**< match length searched : larger == faster decompression, sometimes less compression */
1221
+ unsigned targetLength; /**< acceptable match size for optimal parser (only) : larger == more compression, slower */
1222
+ ZSTD_strategy strategy; /**< see ZSTD_strategy definition above */
1223
+ } ZSTD_compressionParameters;
1224
+
1225
+ typedef struct {
1226
+ int contentSizeFlag; /**< 1: content size will be in frame header (when known) */
1227
+ int checksumFlag; /**< 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection */
1228
+ int noDictIDFlag; /**< 1: no dictID will be saved into frame header (dictID is only useful for dictionary compression) */
1229
+ } ZSTD_frameParameters;
1230
+
1231
+ typedef struct {
1232
+ ZSTD_compressionParameters cParams;
1233
+ ZSTD_frameParameters fParams;
1234
+ } ZSTD_parameters;
1235
+
1236
+ typedef enum {
1237
+ ZSTD_dct_auto = 0, /* dictionary is "full" when starting with ZSTD_MAGIC_DICTIONARY, otherwise it is "rawContent" */
1238
+ ZSTD_dct_rawContent = 1, /* ensures dictionary is always loaded as rawContent, even if it starts with ZSTD_MAGIC_DICTIONARY */
1239
+ ZSTD_dct_fullDict = 2 /* refuses to load a dictionary if it does not respect Zstandard's specification, starting with ZSTD_MAGIC_DICTIONARY */
1240
+ } ZSTD_dictContentType_e;
1241
+
1242
+ typedef enum {
1243
+ ZSTD_dlm_byCopy = 0, /**< Copy dictionary content internally */
1244
+ ZSTD_dlm_byRef = 1 /**< Reference dictionary content -- the dictionary buffer must outlive its users. */
1245
+ } ZSTD_dictLoadMethod_e;
1246
+
1247
+ typedef enum {
1248
+ ZSTD_f_zstd1 = 0, /* zstd frame format, specified in zstd_compression_format.md (default) */
1249
+ ZSTD_f_zstd1_magicless = 1 /* Variant of zstd frame format, without initial 4-bytes magic number.
1250
+ * Useful to save 4 bytes per generated frame.
1251
+ * Decoder cannot recognise automatically this format, requiring this instruction. */
1252
+ } ZSTD_format_e;
1253
+
1254
+ typedef enum {
1255
+ /* Note: this enum controls ZSTD_d_forceIgnoreChecksum */
1256
+ ZSTD_d_validateChecksum = 0,
1257
+ ZSTD_d_ignoreChecksum = 1
1258
+ } ZSTD_forceIgnoreChecksum_e;
1259
+
1260
+ typedef enum {
1261
+ /* Note: this enum controls ZSTD_d_refMultipleDDicts */
1262
+ ZSTD_rmd_refSingleDDict = 0,
1263
+ ZSTD_rmd_refMultipleDDicts = 1
1264
+ } ZSTD_refMultipleDDicts_e;
1265
+
1266
+ typedef enum {
1267
+ /* Note: this enum and the behavior it controls are effectively internal
1268
+ * implementation details of the compressor. They are expected to continue
1269
+ * to evolve and should be considered only in the context of extremely
1270
+ * advanced performance tuning.
1271
+ *
1272
+ * Zstd currently supports the use of a CDict in three ways:
1273
+ *
1274
+ * - The contents of the CDict can be copied into the working context. This
1275
+ * means that the compression can search both the dictionary and input
1276
+ * while operating on a single set of internal tables. This makes
1277
+ * the compression faster per-byte of input. However, the initial copy of
1278
+ * the CDict's tables incurs a fixed cost at the beginning of the
1279
+ * compression. For small compressions (< 8 KB), that copy can dominate
1280
+ * the cost of the compression.
1281
+ *
1282
+ * - The CDict's tables can be used in-place. In this model, compression is
1283
+ * slower per input byte, because the compressor has to search two sets of
1284
+ * tables. However, this model incurs no start-up cost (as long as the
1285
+ * working context's tables can be reused). For small inputs, this can be
1286
+ * faster than copying the CDict's tables.
1287
+ *
1288
+ * - The CDict's tables are not used at all, and instead we use the working
1289
+ * context alone to reload the dictionary and use params based on the source
1290
+ * size. See ZSTD_compress_insertDictionary() and ZSTD_compress_usingDict().
1291
+ * This method is effective when the dictionary sizes are very small relative
1292
+ * to the input size, and the input size is fairly large to begin with.
1293
+ *
1294
+ * Zstd has a simple internal heuristic that selects which strategy to use
1295
+ * at the beginning of a compression. However, if experimentation shows that
1296
+ * Zstd is making poor choices, it is possible to override that choice with
1297
+ * this enum.
1298
+ */
1299
+ ZSTD_dictDefaultAttach = 0, /* Use the default heuristic. */
1300
+ ZSTD_dictForceAttach = 1, /* Never copy the dictionary. */
1301
+ ZSTD_dictForceCopy = 2, /* Always copy the dictionary. */
1302
+ ZSTD_dictForceLoad = 3 /* Always reload the dictionary */
1303
+ } ZSTD_dictAttachPref_e;
1304
+
1305
+ typedef enum {
1306
+ ZSTD_lcm_auto = 0, /**< Automatically determine the compression mode based on the compression level.
1307
+ * Negative compression levels will be uncompressed, and positive compression
1308
+ * levels will be compressed. */
1309
+ ZSTD_lcm_huffman = 1, /**< Always attempt Huffman compression. Uncompressed literals will still be
1310
+ * emitted if Huffman compression is not profitable. */
1311
+ ZSTD_lcm_uncompressed = 2 /**< Always emit uncompressed literals. */
1312
+ } ZSTD_literalCompressionMode_e;
1313
+
1314
+ typedef enum {
1315
+ /* Note: This enum controls features which are conditionally beneficial. Zstd typically will make a final
1316
+ * decision on whether or not to enable the feature (ZSTD_ps_auto), but setting the switch to ZSTD_ps_enable
1317
+ * or ZSTD_ps_disable allow for a force enable/disable the feature.
1318
+ */
1319
+ ZSTD_ps_auto = 0, /* Let the library automatically determine whether the feature shall be enabled */
1320
+ ZSTD_ps_enable = 1, /* Force-enable the feature */
1321
+ ZSTD_ps_disable = 2 /* Do not use the feature */
1322
+ } ZSTD_paramSwitch_e;
1323
+
1324
+ /***************************************
1325
+ * Frame size functions
1326
+ ***************************************/
1327
+
1328
+ /*! ZSTD_findDecompressedSize() :
1329
+ * `src` should point to the start of a series of ZSTD encoded and/or skippable frames
1330
+ * `srcSize` must be the _exact_ size of this series
1331
+ * (i.e. there should be a frame boundary at `src + srcSize`)
1332
+ * @return : - decompressed size of all data in all successive frames
1333
+ * - if the decompressed size cannot be determined: ZSTD_CONTENTSIZE_UNKNOWN
1334
+ * - if an error occurred: ZSTD_CONTENTSIZE_ERROR
1335
+ *
1336
+ * note 1 : decompressed size is an optional field, that may not be present, especially in streaming mode.
1337
+ * When `return==ZSTD_CONTENTSIZE_UNKNOWN`, data to decompress could be any size.
1338
+ * In which case, it's necessary to use streaming mode to decompress data.
1339
+ * note 2 : decompressed size is always present when compression is done with ZSTD_compress()
1340
+ * note 3 : decompressed size can be very large (64-bits value),
1341
+ * potentially larger than what local system can handle as a single memory segment.
1342
+ * In which case, it's necessary to use streaming mode to decompress data.
1343
+ * note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
1344
+ * Always ensure result fits within application's authorized limits.
1345
+ * Each application can set its own limits.
1346
+ * note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input to
1347
+ * read each contained frame header. This is fast as most of the data is skipped,
1348
+ * however it does mean that all frame data must be present and valid. */
1349
+ ZSTDLIB_STATIC_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
1350
+
1351
+ /*! ZSTD_decompressBound() :
1352
+ * `src` should point to the start of a series of ZSTD encoded and/or skippable frames
1353
+ * `srcSize` must be the _exact_ size of this series
1354
+ * (i.e. there should be a frame boundary at `src + srcSize`)
1355
+ * @return : - upper-bound for the decompressed size of all data in all successive frames
1356
+ * - if an error occurred: ZSTD_CONTENTSIZE_ERROR
1357
+ *
1358
+ * note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
1359
+ * note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD encoded frame of `src`.
1360
+ * in this case, `ZSTD_findDecompressedSize` and `ZSTD_decompressBound` return the same value.
1361
+ * note 3 : when the decompressed size field isn't available, the upper-bound for that frame is calculated by:
1362
+ * upper-bound = # blocks * min(128 KB, Window_Size)
1363
+ */
1364
+ ZSTDLIB_STATIC_API unsigned long long ZSTD_decompressBound(const void* src, size_t srcSize);
1365
+
1366
+ /*! ZSTD_frameHeaderSize() :
1367
+ * srcSize must be >= ZSTD_FRAMEHEADERSIZE_PREFIX.
1368
+ * @return : size of the Frame Header,
1369
+ * or an error code (if srcSize is too small) */
1370
+ ZSTDLIB_STATIC_API size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize);
1371
+
1372
+ typedef enum {
1373
+ ZSTD_sf_noBlockDelimiters = 0, /* Representation of ZSTD_Sequence has no block delimiters, sequences only */
1374
+ ZSTD_sf_explicitBlockDelimiters = 1 /* Representation of ZSTD_Sequence contains explicit block delimiters */
1375
+ } ZSTD_sequenceFormat_e;
1376
+
1377
+ /*! ZSTD_generateSequences() :
1378
+ * Generate sequences using ZSTD_compress2, given a source buffer.
1379
+ *
1380
+ * Each block will end with a dummy sequence
1381
+ * with offset == 0, matchLength == 0, and litLength == length of last literals.
1382
+ * litLength may be == 0, and if so, then the sequence of (of: 0 ml: 0 ll: 0)
1383
+ * simply acts as a block delimiter.
1384
+ *
1385
+ * zc can be used to insert custom compression params.
1386
+ * This function invokes ZSTD_compress2
1387
+ *
1388
+ * The output of this function can be fed into ZSTD_compressSequences() with CCtx
1389
+ * setting of ZSTD_c_blockDelimiters as ZSTD_sf_explicitBlockDelimiters
1390
+ * @return : number of sequences generated
1391
+ */
1392
+
1393
+ ZSTDLIB_STATIC_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
1394
+ size_t outSeqsSize, const void* src, size_t srcSize);
1395
+
1396
+ /*! ZSTD_mergeBlockDelimiters() :
1397
+ * Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals
1398
+ * by merging them into into the literals of the next sequence.
1399
+ *
1400
+ * As such, the final generated result has no explicit representation of block boundaries,
1401
+ * and the final last literals segment is not represented in the sequences.
1402
+ *
1403
+ * The output of this function can be fed into ZSTD_compressSequences() with CCtx
1404
+ * setting of ZSTD_c_blockDelimiters as ZSTD_sf_noBlockDelimiters
1405
+ * @return : number of sequences left after merging
1406
+ */
1407
+ ZSTDLIB_STATIC_API size_t ZSTD_mergeBlockDelimiters(ZSTD_Sequence* sequences, size_t seqsSize);
1408
+
1409
+ /*! ZSTD_compressSequences() :
1410
+ * Compress an array of ZSTD_Sequence, generated from the original source buffer, into dst.
1411
+ * If a dictionary is included, then the cctx should reference the dict. (see: ZSTD_CCtx_refCDict(), ZSTD_CCtx_loadDictionary(), etc.)
1412
+ * The entire source is compressed into a single frame.
1413
+ *
1414
+ * The compression behavior changes based on cctx params. In particular:
1415
+ * If ZSTD_c_blockDelimiters == ZSTD_sf_noBlockDelimiters, the array of ZSTD_Sequence is expected to contain
1416
+ * no block delimiters (defined in ZSTD_Sequence). Block boundaries are roughly determined based on
1417
+ * the block size derived from the cctx, and sequences may be split. This is the default setting.
1418
+ *
1419
+ * If ZSTD_c_blockDelimiters == ZSTD_sf_explicitBlockDelimiters, the array of ZSTD_Sequence is expected to contain
1420
+ * block delimiters (defined in ZSTD_Sequence). Behavior is undefined if no block delimiters are provided.
1421
+ *
1422
+ * If ZSTD_c_validateSequences == 0, this function will blindly accept the sequences provided. Invalid sequences cause undefined
1423
+ * behavior. If ZSTD_c_validateSequences == 1, then if sequence is invalid (see doc/zstd_compression_format.md for
1424
+ * specifics regarding offset/matchlength requirements) then the function will bail out and return an error.
1425
+ *
1426
+ * In addition to the two adjustable experimental params, there are other important cctx params.
1427
+ * - ZSTD_c_minMatch MUST be set as less than or equal to the smallest match generated by the match finder. It has a minimum value of ZSTD_MINMATCH_MIN.
1428
+ * - ZSTD_c_compressionLevel accordingly adjusts the strength of the entropy coder, as it would in typical compression.
1429
+ * - ZSTD_c_windowLog affects offset validation: this function will return an error at higher debug levels if a provided offset
1430
+ * is larger than what the spec allows for a given window log and dictionary (if present). See: doc/zstd_compression_format.md
1431
+ *
1432
+ * Note: Repcodes are, as of now, always re-calculated within this function, so ZSTD_Sequence::rep is unused.
1433
+ * Note 2: Once we integrate ability to ingest repcodes, the explicit block delims mode must respect those repcodes exactly,
1434
+ * and cannot emit an RLE block that disagrees with the repcode history
1435
+ * @return : final compressed size or a ZSTD error.
1436
+ */
1437
+ ZSTDLIB_STATIC_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size_t dstSize,
1438
+ const ZSTD_Sequence* inSeqs, size_t inSeqsSize,
1439
+ const void* src, size_t srcSize);
1440
+
1441
+
1442
+ /*! ZSTD_writeSkippableFrame() :
1443
+ * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
1444
+ *
1445
+ * Skippable frames begin with a a 4-byte magic number. There are 16 possible choices of magic number,
1446
+ * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
1447
+ * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
1448
+ * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
1449
+ *
1450
+ * Returns an error if destination buffer is not large enough, if the source size is not representable
1451
+ * with a 4-byte unsigned int, or if the parameter magicVariant is greater than 15 (and therefore invalid).
1452
+ *
1453
+ * @return : number of bytes written or a ZSTD error.
1454
+ */
1455
+ ZSTDLIB_STATIC_API size_t ZSTD_writeSkippableFrame(void* dst, size_t dstCapacity,
1456
+ const void* src, size_t srcSize, unsigned magicVariant);
1457
+
1458
+ /*! ZSTD_readSkippableFrame() :
1459
+ * Retrieves a zstd skippable frame containing data given by src, and writes it to dst buffer.
1460
+ *
1461
+ * The parameter magicVariant will receive the magicVariant that was supplied when the frame was written,
1462
+ * i.e. magicNumber - ZSTD_MAGIC_SKIPPABLE_START. This can be NULL if the caller is not interested
1463
+ * in the magicVariant.
1464
+ *
1465
+ * Returns an error if destination buffer is not large enough, or if the frame is not skippable.
1466
+ *
1467
+ * @return : number of bytes written or a ZSTD error.
1468
+ */
1469
+ ZSTDLIB_API size_t ZSTD_readSkippableFrame(void* dst, size_t dstCapacity, unsigned* magicVariant,
1470
+ const void* src, size_t srcSize);
1471
+
1472
+ /*! ZSTD_isSkippableFrame() :
1473
+ * Tells if the content of `buffer` starts with a valid Frame Identifier for a skippable frame.
1474
+ */
1475
+ ZSTDLIB_API unsigned ZSTD_isSkippableFrame(const void* buffer, size_t size);
1476
+
1477
+
1478
+
1479
+ /***************************************
1480
+ * Memory management
1481
+ ***************************************/
1482
+
1483
+ /*! ZSTD_estimate*() :
1484
+ * These functions make it possible to estimate memory usage
1485
+ * of a future {D,C}Ctx, before its creation.
1486
+ *
1487
+ * ZSTD_estimateCCtxSize() will provide a memory budget large enough
1488
+ * for any compression level up to selected one.
1489
+ * Note : Unlike ZSTD_estimateCStreamSize*(), this estimate
1490
+ * does not include space for a window buffer.
1491
+ * Therefore, the estimation is only guaranteed for single-shot compressions, not streaming.
1492
+ * The estimate will assume the input may be arbitrarily large,
1493
+ * which is the worst case.
1494
+ *
1495
+ * When srcSize can be bound by a known and rather "small" value,
1496
+ * this fact can be used to provide a tighter estimation
1497
+ * because the CCtx compression context will need less memory.
1498
+ * This tighter estimation can be provided by more advanced functions
1499
+ * ZSTD_estimateCCtxSize_usingCParams(), which can be used in tandem with ZSTD_getCParams(),
1500
+ * and ZSTD_estimateCCtxSize_usingCCtxParams(), which can be used in tandem with ZSTD_CCtxParams_setParameter().
1501
+ * Both can be used to estimate memory using custom compression parameters and arbitrary srcSize limits.
1502
+ *
1503
+ * Note 2 : only single-threaded compression is supported.
1504
+ * ZSTD_estimateCCtxSize_usingCCtxParams() will return an error code if ZSTD_c_nbWorkers is >= 1.
1505
+ */
1506
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize(int compressionLevel);
1507
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize_usingCParams(ZSTD_compressionParameters cParams);
1508
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize_usingCCtxParams(const ZSTD_CCtx_params* params);
1509
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDCtxSize(void);
1510
+
1511
+ /*! ZSTD_estimateCStreamSize() :
1512
+ * ZSTD_estimateCStreamSize() will provide a budget large enough for any compression level up to selected one.
1513
+ * It will also consider src size to be arbitrarily "large", which is worst case.
1514
+ * If srcSize is known to always be small, ZSTD_estimateCStreamSize_usingCParams() can provide a tighter estimation.
1515
+ * ZSTD_estimateCStreamSize_usingCParams() can be used in tandem with ZSTD_getCParams() to create cParams from compressionLevel.
1516
+ * ZSTD_estimateCStreamSize_usingCCtxParams() can be used in tandem with ZSTD_CCtxParams_setParameter(). Only single-threaded compression is supported. This function will return an error code if ZSTD_c_nbWorkers is >= 1.
1517
+ * Note : CStream size estimation is only correct for single-threaded compression.
1518
+ * ZSTD_DStream memory budget depends on window Size.
1519
+ * This information can be passed manually, using ZSTD_estimateDStreamSize,
1520
+ * or deducted from a valid frame Header, using ZSTD_estimateDStreamSize_fromFrame();
1521
+ * Note : if streaming is init with function ZSTD_init?Stream_usingDict(),
1522
+ * an internal ?Dict will be created, which additional size is not estimated here.
1523
+ * In this case, get total size by adding ZSTD_estimate?DictSize */
1524
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize(int compressionLevel);
1525
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize_usingCParams(ZSTD_compressionParameters cParams);
1526
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize_usingCCtxParams(const ZSTD_CCtx_params* params);
1527
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDStreamSize(size_t windowSize);
1528
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDStreamSize_fromFrame(const void* src, size_t srcSize);
1529
+
1530
+ /*! ZSTD_estimate?DictSize() :
1531
+ * ZSTD_estimateCDictSize() will bet that src size is relatively "small", and content is copied, like ZSTD_createCDict().
1532
+ * ZSTD_estimateCDictSize_advanced() makes it possible to control compression parameters precisely, like ZSTD_createCDict_advanced().
1533
+ * Note : dictionaries created by reference (`ZSTD_dlm_byRef`) are logically smaller.
1534
+ */
1535
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCDictSize(size_t dictSize, int compressionLevel);
1536
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateCDictSize_advanced(size_t dictSize, ZSTD_compressionParameters cParams, ZSTD_dictLoadMethod_e dictLoadMethod);
1537
+ ZSTDLIB_STATIC_API size_t ZSTD_estimateDDictSize(size_t dictSize, ZSTD_dictLoadMethod_e dictLoadMethod);
1538
+
1539
+ /*! ZSTD_initStatic*() :
1540
+ * Initialize an object using a pre-allocated fixed-size buffer.
1541
+ * workspace: The memory area to emplace the object into.
1542
+ * Provided pointer *must be 8-bytes aligned*.
1543
+ * Buffer must outlive object.
1544
+ * workspaceSize: Use ZSTD_estimate*Size() to determine
1545
+ * how large workspace must be to support target scenario.
1546
+ * @return : pointer to object (same address as workspace, just different type),
1547
+ * or NULL if error (size too small, incorrect alignment, etc.)
1548
+ * Note : zstd will never resize nor malloc() when using a static buffer.
1549
+ * If the object requires more memory than available,
1550
+ * zstd will just error out (typically ZSTD_error_memory_allocation).
1551
+ * Note 2 : there is no corresponding "free" function.
1552
+ * Since workspace is allocated externally, it must be freed externally too.
1553
+ * Note 3 : cParams : use ZSTD_getCParams() to convert a compression level
1554
+ * into its associated cParams.
1555
+ * Limitation 1 : currently not compatible with internal dictionary creation, triggered by
1556
+ * ZSTD_CCtx_loadDictionary(), ZSTD_initCStream_usingDict() or ZSTD_initDStream_usingDict().
1557
+ * Limitation 2 : static cctx currently not compatible with multi-threading.
1558
+ * Limitation 3 : static dctx is incompatible with legacy support.
1559
+ */
1560
+ ZSTDLIB_STATIC_API ZSTD_CCtx* ZSTD_initStaticCCtx(void* workspace, size_t workspaceSize);
1561
+ ZSTDLIB_STATIC_API ZSTD_CStream* ZSTD_initStaticCStream(void* workspace, size_t workspaceSize); /**< same as ZSTD_initStaticCCtx() */
1562
+
1563
+ ZSTDLIB_STATIC_API ZSTD_DCtx* ZSTD_initStaticDCtx(void* workspace, size_t workspaceSize);
1564
+ ZSTDLIB_STATIC_API ZSTD_DStream* ZSTD_initStaticDStream(void* workspace, size_t workspaceSize); /**< same as ZSTD_initStaticDCtx() */
1565
+
1566
+ ZSTDLIB_STATIC_API const ZSTD_CDict* ZSTD_initStaticCDict(
1567
+ void* workspace, size_t workspaceSize,
1568
+ const void* dict, size_t dictSize,
1569
+ ZSTD_dictLoadMethod_e dictLoadMethod,
1570
+ ZSTD_dictContentType_e dictContentType,
1571
+ ZSTD_compressionParameters cParams);
1572
+
1573
+ ZSTDLIB_STATIC_API const ZSTD_DDict* ZSTD_initStaticDDict(
1574
+ void* workspace, size_t workspaceSize,
1575
+ const void* dict, size_t dictSize,
1576
+ ZSTD_dictLoadMethod_e dictLoadMethod,
1577
+ ZSTD_dictContentType_e dictContentType);
1578
+
1579
+
1580
+ /*! Custom memory allocation :
1581
+ * These prototypes make it possible to pass your own allocation/free functions.
1582
+ * ZSTD_customMem is provided at creation time, using ZSTD_create*_advanced() variants listed below.
1583
+ * All allocation/free operations will be completed using these custom variants instead of regular <stdlib.h> ones.
1584
+ */
1585
+ typedef void* (*ZSTD_allocFunction) (void* opaque, size_t size);
1586
+ typedef void (*ZSTD_freeFunction) (void* opaque, void* address);
1587
+ typedef struct { ZSTD_allocFunction customAlloc; ZSTD_freeFunction customFree; void* opaque; } ZSTD_customMem;
1588
+ static
1589
+ #ifdef __GNUC__
1590
+ __attribute__((__unused__))
1591
+ #endif
1592
+ ZSTD_customMem const ZSTD_defaultCMem = { NULL, NULL, NULL }; /**< this constant defers to stdlib's functions */
1593
+
1594
+ ZSTDLIB_STATIC_API ZSTD_CCtx* ZSTD_createCCtx_advanced(ZSTD_customMem customMem);
1595
+ ZSTDLIB_STATIC_API ZSTD_CStream* ZSTD_createCStream_advanced(ZSTD_customMem customMem);
1596
+ ZSTDLIB_STATIC_API ZSTD_DCtx* ZSTD_createDCtx_advanced(ZSTD_customMem customMem);
1597
+ ZSTDLIB_STATIC_API ZSTD_DStream* ZSTD_createDStream_advanced(ZSTD_customMem customMem);
1598
+
1599
+ ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_advanced(const void* dict, size_t dictSize,
1600
+ ZSTD_dictLoadMethod_e dictLoadMethod,
1601
+ ZSTD_dictContentType_e dictContentType,
1602
+ ZSTD_compressionParameters cParams,
1603
+ ZSTD_customMem customMem);
1604
+
1605
+ /*! Thread pool :
1606
+ * These prototypes make it possible to share a thread pool among multiple compression contexts.
1607
+ * This can limit resources for applications with multiple threads where each one uses
1608
+ * a threaded compression mode (via ZSTD_c_nbWorkers parameter).
1609
+ * ZSTD_createThreadPool creates a new thread pool with a given number of threads.
1610
+ * Note that the lifetime of such pool must exist while being used.
1611
+ * ZSTD_CCtx_refThreadPool assigns a thread pool to a context (use NULL argument value
1612
+ * to use an internal thread pool).
1613
+ * ZSTD_freeThreadPool frees a thread pool, accepts NULL pointer.
1614
+ */
1615
+ typedef struct POOL_ctx_s ZSTD_threadPool;
1616
+ ZSTDLIB_STATIC_API ZSTD_threadPool* ZSTD_createThreadPool(size_t numThreads);
1617
+ ZSTDLIB_STATIC_API void ZSTD_freeThreadPool (ZSTD_threadPool* pool); /* accept NULL pointer */
1618
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_refThreadPool(ZSTD_CCtx* cctx, ZSTD_threadPool* pool);
1619
+
1620
+
1621
+ /*
1622
+ * This API is temporary and is expected to change or disappear in the future!
1623
+ */
1624
+ ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_advanced2(
1625
+ const void* dict, size_t dictSize,
1626
+ ZSTD_dictLoadMethod_e dictLoadMethod,
1627
+ ZSTD_dictContentType_e dictContentType,
1628
+ const ZSTD_CCtx_params* cctxParams,
1629
+ ZSTD_customMem customMem);
1630
+
1631
+ ZSTDLIB_STATIC_API ZSTD_DDict* ZSTD_createDDict_advanced(
1632
+ const void* dict, size_t dictSize,
1633
+ ZSTD_dictLoadMethod_e dictLoadMethod,
1634
+ ZSTD_dictContentType_e dictContentType,
1635
+ ZSTD_customMem customMem);
1636
+
1637
+
1638
+ /***************************************
1639
+ * Advanced compression functions
1640
+ ***************************************/
1641
+
1642
+ /*! ZSTD_createCDict_byReference() :
1643
+ * Create a digested dictionary for compression
1644
+ * Dictionary content is just referenced, not duplicated.
1645
+ * As a consequence, `dictBuffer` **must** outlive CDict,
1646
+ * and its content must remain unmodified throughout the lifetime of CDict.
1647
+ * note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef */
1648
+ ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_byReference(const void* dictBuffer, size_t dictSize, int compressionLevel);
1649
+
1650
+ /*! ZSTD_getCParams() :
1651
+ * @return ZSTD_compressionParameters structure for a selected compression level and estimated srcSize.
1652
+ * `estimatedSrcSize` value is optional, select 0 if not known */
1653
+ ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_getCParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
1654
+
1655
+ /*! ZSTD_getParams() :
1656
+ * same as ZSTD_getCParams(), but @return a full `ZSTD_parameters` object instead of sub-component `ZSTD_compressionParameters`.
1657
+ * All fields of `ZSTD_frameParameters` are set to default : contentSize=1, checksum=0, noDictID=0 */
1658
+ ZSTDLIB_STATIC_API ZSTD_parameters ZSTD_getParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
1659
+
1660
+ /*! ZSTD_checkCParams() :
1661
+ * Ensure param values remain within authorized range.
1662
+ * @return 0 on success, or an error code (can be checked with ZSTD_isError()) */
1663
+ ZSTDLIB_STATIC_API size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
1664
+
1665
+ /*! ZSTD_adjustCParams() :
1666
+ * optimize params for a given `srcSize` and `dictSize`.
1667
+ * `srcSize` can be unknown, in which case use ZSTD_CONTENTSIZE_UNKNOWN.
1668
+ * `dictSize` must be `0` when there is no dictionary.
1669
+ * cPar can be invalid : all parameters will be clamped within valid range in the @return struct.
1670
+ * This function never fails (wide contract) */
1671
+ ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParameters cPar, unsigned long long srcSize, size_t dictSize);
1672
+
1673
+ /*! ZSTD_compress_advanced() :
1674
+ * Note : this function is now DEPRECATED.
1675
+ * It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_setParameter() and other parameter setters.
1676
+ * This prototype will generate compilation warnings. */
1677
+ ZSTD_DEPRECATED("use ZSTD_compress2")
1678
+ size_t ZSTD_compress_advanced(ZSTD_CCtx* cctx,
1679
+ void* dst, size_t dstCapacity,
1680
+ const void* src, size_t srcSize,
1681
+ const void* dict,size_t dictSize,
1682
+ ZSTD_parameters params);
1683
+
1684
+ /*! ZSTD_compress_usingCDict_advanced() :
1685
+ * Note : this function is now DEPRECATED.
1686
+ * It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_loadDictionary() and other parameter setters.
1687
+ * This prototype will generate compilation warnings. */
1688
+ ZSTD_DEPRECATED("use ZSTD_compress2 with ZSTD_CCtx_loadDictionary")
1689
+ size_t ZSTD_compress_usingCDict_advanced(ZSTD_CCtx* cctx,
1690
+ void* dst, size_t dstCapacity,
1691
+ const void* src, size_t srcSize,
1692
+ const ZSTD_CDict* cdict,
1693
+ ZSTD_frameParameters fParams);
1694
+
1695
+
1696
+ /*! ZSTD_CCtx_loadDictionary_byReference() :
1697
+ * Same as ZSTD_CCtx_loadDictionary(), but dictionary content is referenced, instead of being copied into CCtx.
1698
+ * It saves some memory, but also requires that `dict` outlives its usage within `cctx` */
1699
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_loadDictionary_byReference(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
1700
+
1701
+ /*! ZSTD_CCtx_loadDictionary_advanced() :
1702
+ * Same as ZSTD_CCtx_loadDictionary(), but gives finer control over
1703
+ * how to load the dictionary (by copy ? by reference ?)
1704
+ * and how to interpret it (automatic ? force raw mode ? full mode only ?) */
1705
+ 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);
1706
+
1707
+ /*! ZSTD_CCtx_refPrefix_advanced() :
1708
+ * Same as ZSTD_CCtx_refPrefix(), but gives finer control over
1709
+ * how to interpret prefix content (automatic ? force raw mode (default) ? full mode only ?) */
1710
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType);
1711
+
1712
+ /* === experimental parameters === */
1713
+ /* these parameters can be used with ZSTD_setParameter()
1714
+ * they are not guaranteed to remain supported in the future */
1715
+
1716
+ /* Enables rsyncable mode,
1717
+ * which makes compressed files more rsync friendly
1718
+ * by adding periodic synchronization points to the compressed data.
1719
+ * The target average block size is ZSTD_c_jobSize / 2.
1720
+ * It's possible to modify the job size to increase or decrease
1721
+ * the granularity of the synchronization point.
1722
+ * Once the jobSize is smaller than the window size,
1723
+ * it will result in compression ratio degradation.
1724
+ * NOTE 1: rsyncable mode only works when multithreading is enabled.
1725
+ * NOTE 2: rsyncable performs poorly in combination with long range mode,
1726
+ * since it will decrease the effectiveness of synchronization points,
1727
+ * though mileage may vary.
1728
+ * NOTE 3: Rsyncable mode limits maximum compression speed to ~400 MB/s.
1729
+ * If the selected compression level is already running significantly slower,
1730
+ * the overall speed won't be significantly impacted.
1731
+ */
1732
+ #define ZSTD_c_rsyncable ZSTD_c_experimentalParam1
1733
+
1734
+ /* Select a compression format.
1735
+ * The value must be of type ZSTD_format_e.
1736
+ * See ZSTD_format_e enum definition for details */
1737
+ #define ZSTD_c_format ZSTD_c_experimentalParam2
1738
+
1739
+ /* Force back-reference distances to remain < windowSize,
1740
+ * even when referencing into Dictionary content (default:0) */
1741
+ #define ZSTD_c_forceMaxWindow ZSTD_c_experimentalParam3
1742
+
1743
+ /* Controls whether the contents of a CDict
1744
+ * are used in place, or copied into the working context.
1745
+ * Accepts values from the ZSTD_dictAttachPref_e enum.
1746
+ * See the comments on that enum for an explanation of the feature. */
1747
+ #define ZSTD_c_forceAttachDict ZSTD_c_experimentalParam4
1748
+
1749
+ /* Controlled with ZSTD_paramSwitch_e enum.
1750
+ * Default is ZSTD_ps_auto.
1751
+ * Set to ZSTD_ps_disable to never compress literals.
1752
+ * Set to ZSTD_ps_enable to always compress literals. (Note: uncompressed literals
1753
+ * may still be emitted if huffman is not beneficial to use.)
1754
+ *
1755
+ * By default, in ZSTD_ps_auto, the library will decide at runtime whether to use
1756
+ * literals compression based on the compression parameters - specifically,
1757
+ * negative compression levels do not use literal compression.
1758
+ */
1759
+ #define ZSTD_c_literalCompressionMode ZSTD_c_experimentalParam5
1760
+
1761
+ /* Tries to fit compressed block size to be around targetCBlockSize.
1762
+ * No target when targetCBlockSize == 0.
1763
+ * There is no guarantee on compressed block size (default:0) */
1764
+ #define ZSTD_c_targetCBlockSize ZSTD_c_experimentalParam6
1765
+
1766
+ /* User's best guess of source size.
1767
+ * Hint is not valid when srcSizeHint == 0.
1768
+ * There is no guarantee that hint is close to actual source size,
1769
+ * but compression ratio may regress significantly if guess considerably underestimates */
1770
+ #define ZSTD_c_srcSizeHint ZSTD_c_experimentalParam7
1771
+
1772
+ /* Controls whether the new and experimental "dedicated dictionary search
1773
+ * structure" can be used. This feature is still rough around the edges, be
1774
+ * prepared for surprising behavior!
1775
+ *
1776
+ * How to use it:
1777
+ *
1778
+ * When using a CDict, whether to use this feature or not is controlled at
1779
+ * CDict creation, and it must be set in a CCtxParams set passed into that
1780
+ * construction (via ZSTD_createCDict_advanced2()). A compression will then
1781
+ * use the feature or not based on how the CDict was constructed; the value of
1782
+ * this param, set in the CCtx, will have no effect.
1783
+ *
1784
+ * However, when a dictionary buffer is passed into a CCtx, such as via
1785
+ * ZSTD_CCtx_loadDictionary(), this param can be set on the CCtx to control
1786
+ * whether the CDict that is created internally can use the feature or not.
1787
+ *
1788
+ * What it does:
1789
+ *
1790
+ * Normally, the internal data structures of the CDict are analogous to what
1791
+ * would be stored in a CCtx after compressing the contents of a dictionary.
1792
+ * To an approximation, a compression using a dictionary can then use those
1793
+ * data structures to simply continue what is effectively a streaming
1794
+ * compression where the simulated compression of the dictionary left off.
1795
+ * Which is to say, the search structures in the CDict are normally the same
1796
+ * format as in the CCtx.
1797
+ *
1798
+ * It is possible to do better, since the CDict is not like a CCtx: the search
1799
+ * structures are written once during CDict creation, and then are only read
1800
+ * after that, while the search structures in the CCtx are both read and
1801
+ * written as the compression goes along. This means we can choose a search
1802
+ * structure for the dictionary that is read-optimized.
1803
+ *
1804
+ * This feature enables the use of that different structure.
1805
+ *
1806
+ * Note that some of the members of the ZSTD_compressionParameters struct have
1807
+ * different semantics and constraints in the dedicated search structure. It is
1808
+ * highly recommended that you simply set a compression level in the CCtxParams
1809
+ * you pass into the CDict creation call, and avoid messing with the cParams
1810
+ * directly.
1811
+ *
1812
+ * Effects:
1813
+ *
1814
+ * This will only have any effect when the selected ZSTD_strategy
1815
+ * implementation supports this feature. Currently, that's limited to
1816
+ * ZSTD_greedy, ZSTD_lazy, and ZSTD_lazy2.
1817
+ *
1818
+ * Note that this means that the CDict tables can no longer be copied into the
1819
+ * CCtx, so the dict attachment mode ZSTD_dictForceCopy will no longer be
1820
+ * usable. The dictionary can only be attached or reloaded.
1821
+ *
1822
+ * In general, you should expect compression to be faster--sometimes very much
1823
+ * so--and CDict creation to be slightly slower. Eventually, we will probably
1824
+ * make this mode the default.
1825
+ */
1826
+ #define ZSTD_c_enableDedicatedDictSearch ZSTD_c_experimentalParam8
1827
+
1828
+ /* ZSTD_c_stableInBuffer
1829
+ * Experimental parameter.
1830
+ * Default is 0 == disabled. Set to 1 to enable.
1831
+ *
1832
+ * Tells the compressor that the ZSTD_inBuffer will ALWAYS be the same
1833
+ * between calls, except for the modifications that zstd makes to pos (the
1834
+ * caller must not modify pos). This is checked by the compressor, and
1835
+ * compression will fail if it ever changes. This means the only flush
1836
+ * mode that makes sense is ZSTD_e_end, so zstd will error if ZSTD_e_end
1837
+ * is not used. The data in the ZSTD_inBuffer in the range [src, src + pos)
1838
+ * MUST not be modified during compression or you will get data corruption.
1839
+ *
1840
+ * When this flag is enabled zstd won't allocate an input window buffer,
1841
+ * because the user guarantees it can reference the ZSTD_inBuffer until
1842
+ * the frame is complete. But, it will still allocate an output buffer
1843
+ * large enough to fit a block (see ZSTD_c_stableOutBuffer). This will also
1844
+ * avoid the memcpy() from the input buffer to the input window buffer.
1845
+ *
1846
+ * NOTE: ZSTD_compressStream2() will error if ZSTD_e_end is not used.
1847
+ * That means this flag cannot be used with ZSTD_compressStream().
1848
+ *
1849
+ * NOTE: So long as the ZSTD_inBuffer always points to valid memory, using
1850
+ * this flag is ALWAYS memory safe, and will never access out-of-bounds
1851
+ * memory. However, compression WILL fail if you violate the preconditions.
1852
+ *
1853
+ * WARNING: The data in the ZSTD_inBuffer in the range [dst, dst + pos) MUST
1854
+ * not be modified during compression or you will get data corruption. This
1855
+ * is because zstd needs to reference data in the ZSTD_inBuffer to find
1856
+ * matches. Normally zstd maintains its own window buffer for this purpose,
1857
+ * but passing this flag tells zstd to use the user provided buffer.
1858
+ */
1859
+ #define ZSTD_c_stableInBuffer ZSTD_c_experimentalParam9
1860
+
1861
+ /* ZSTD_c_stableOutBuffer
1862
+ * Experimental parameter.
1863
+ * Default is 0 == disabled. Set to 1 to enable.
1864
+ *
1865
+ * Tells he compressor that the ZSTD_outBuffer will not be resized between
1866
+ * calls. Specifically: (out.size - out.pos) will never grow. This gives the
1867
+ * compressor the freedom to say: If the compressed data doesn't fit in the
1868
+ * output buffer then return ZSTD_error_dstSizeTooSmall. This allows us to
1869
+ * always decompress directly into the output buffer, instead of decompressing
1870
+ * into an internal buffer and copying to the output buffer.
1871
+ *
1872
+ * When this flag is enabled zstd won't allocate an output buffer, because
1873
+ * it can write directly to the ZSTD_outBuffer. It will still allocate the
1874
+ * input window buffer (see ZSTD_c_stableInBuffer).
1875
+ *
1876
+ * Zstd will check that (out.size - out.pos) never grows and return an error
1877
+ * if it does. While not strictly necessary, this should prevent surprises.
1878
+ */
1879
+ #define ZSTD_c_stableOutBuffer ZSTD_c_experimentalParam10
1880
+
1881
+ /* ZSTD_c_blockDelimiters
1882
+ * Default is 0 == ZSTD_sf_noBlockDelimiters.
1883
+ *
1884
+ * For use with sequence compression API: ZSTD_compressSequences().
1885
+ *
1886
+ * Designates whether or not the given array of ZSTD_Sequence contains block delimiters
1887
+ * and last literals, which are defined as sequences with offset == 0 and matchLength == 0.
1888
+ * See the definition of ZSTD_Sequence for more specifics.
1889
+ */
1890
+ #define ZSTD_c_blockDelimiters ZSTD_c_experimentalParam11
1891
+
1892
+ /* ZSTD_c_validateSequences
1893
+ * Default is 0 == disabled. Set to 1 to enable sequence validation.
1894
+ *
1895
+ * For use with sequence compression API: ZSTD_compressSequences().
1896
+ * Designates whether or not we validate sequences provided to ZSTD_compressSequences()
1897
+ * during function execution.
1898
+ *
1899
+ * Without validation, providing a sequence that does not conform to the zstd spec will cause
1900
+ * undefined behavior, and may produce a corrupted block.
1901
+ *
1902
+ * With validation enabled, a if sequence is invalid (see doc/zstd_compression_format.md for
1903
+ * specifics regarding offset/matchlength requirements) then the function will bail out and
1904
+ * return an error.
1905
+ *
1906
+ */
1907
+ #define ZSTD_c_validateSequences ZSTD_c_experimentalParam12
1908
+
1909
+ /* ZSTD_c_useBlockSplitter
1910
+ * Controlled with ZSTD_paramSwitch_e enum.
1911
+ * Default is ZSTD_ps_auto.
1912
+ * Set to ZSTD_ps_disable to never use block splitter.
1913
+ * Set to ZSTD_ps_enable to always use block splitter.
1914
+ *
1915
+ * By default, in ZSTD_ps_auto, the library will decide at runtime whether to use
1916
+ * block splitting based on the compression parameters.
1917
+ */
1918
+ #define ZSTD_c_useBlockSplitter ZSTD_c_experimentalParam13
1919
+
1920
+ /* ZSTD_c_useRowMatchFinder
1921
+ * Controlled with ZSTD_paramSwitch_e enum.
1922
+ * Default is ZSTD_ps_auto.
1923
+ * Set to ZSTD_ps_disable to never use row-based matchfinder.
1924
+ * Set to ZSTD_ps_enable to force usage of row-based matchfinder.
1925
+ *
1926
+ * By default, in ZSTD_ps_auto, the library will decide at runtime whether to use
1927
+ * the row-based matchfinder based on support for SIMD instructions and the window log.
1928
+ * Note that this only pertains to compression strategies: greedy, lazy, and lazy2
1929
+ */
1930
+ #define ZSTD_c_useRowMatchFinder ZSTD_c_experimentalParam14
1931
+
1932
+ /* ZSTD_c_deterministicRefPrefix
1933
+ * Default is 0 == disabled. Set to 1 to enable.
1934
+ *
1935
+ * Zstd produces different results for prefix compression when the prefix is
1936
+ * directly adjacent to the data about to be compressed vs. when it isn't.
1937
+ * This is because zstd detects that the two buffers are contiguous and it can
1938
+ * use a more efficient match finding algorithm. However, this produces different
1939
+ * results than when the two buffers are non-contiguous. This flag forces zstd
1940
+ * to always load the prefix in non-contiguous mode, even if it happens to be
1941
+ * adjacent to the data, to guarantee determinism.
1942
+ *
1943
+ * If you really care about determinism when using a dictionary or prefix,
1944
+ * like when doing delta compression, you should select this option. It comes
1945
+ * at a speed penalty of about ~2.5% if the dictionary and data happened to be
1946
+ * contiguous, and is free if they weren't contiguous. We don't expect that
1947
+ * intentionally making the dictionary and data contiguous will be worth the
1948
+ * cost to memcpy() the data.
1949
+ */
1950
+ #define ZSTD_c_deterministicRefPrefix ZSTD_c_experimentalParam15
1951
+
1952
+ /*! ZSTD_CCtx_getParameter() :
1953
+ * Get the requested compression parameter value, selected by enum ZSTD_cParameter,
1954
+ * and store it into int* value.
1955
+ * @return : 0, or an error code (which can be tested with ZSTD_isError()).
1956
+ */
1957
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_getParameter(const ZSTD_CCtx* cctx, ZSTD_cParameter param, int* value);
1958
+
1959
+
1960
+ /*! ZSTD_CCtx_params :
1961
+ * Quick howto :
1962
+ * - ZSTD_createCCtxParams() : Create a ZSTD_CCtx_params structure
1963
+ * - ZSTD_CCtxParams_setParameter() : Push parameters one by one into
1964
+ * an existing ZSTD_CCtx_params structure.
1965
+ * This is similar to
1966
+ * ZSTD_CCtx_setParameter().
1967
+ * - ZSTD_CCtx_setParametersUsingCCtxParams() : Apply parameters to
1968
+ * an existing CCtx.
1969
+ * These parameters will be applied to
1970
+ * all subsequent frames.
1971
+ * - ZSTD_compressStream2() : Do compression using the CCtx.
1972
+ * - ZSTD_freeCCtxParams() : Free the memory, accept NULL pointer.
1973
+ *
1974
+ * This can be used with ZSTD_estimateCCtxSize_advanced_usingCCtxParams()
1975
+ * for static allocation of CCtx for single-threaded compression.
1976
+ */
1977
+ ZSTDLIB_STATIC_API ZSTD_CCtx_params* ZSTD_createCCtxParams(void);
1978
+ ZSTDLIB_STATIC_API size_t ZSTD_freeCCtxParams(ZSTD_CCtx_params* params); /* accept NULL pointer */
1979
+
1980
+ /*! ZSTD_CCtxParams_reset() :
1981
+ * Reset params to default values.
1982
+ */
1983
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_reset(ZSTD_CCtx_params* params);
1984
+
1985
+ /*! ZSTD_CCtxParams_init() :
1986
+ * Initializes the compression parameters of cctxParams according to
1987
+ * compression level. All other parameters are reset to their default values.
1988
+ */
1989
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_init(ZSTD_CCtx_params* cctxParams, int compressionLevel);
1990
+
1991
+ /*! ZSTD_CCtxParams_init_advanced() :
1992
+ * Initializes the compression and frame parameters of cctxParams according to
1993
+ * params. All other parameters are reset to their default values.
1994
+ */
1995
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, ZSTD_parameters params);
1996
+
1997
+ /*! ZSTD_CCtxParams_setParameter() : Requires v1.4.0+
1998
+ * Similar to ZSTD_CCtx_setParameter.
1999
+ * Set one compression parameter, selected by enum ZSTD_cParameter.
2000
+ * Parameters must be applied to a ZSTD_CCtx using
2001
+ * ZSTD_CCtx_setParametersUsingCCtxParams().
2002
+ * @result : a code representing success or failure (which can be tested with
2003
+ * ZSTD_isError()).
2004
+ */
2005
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_setParameter(ZSTD_CCtx_params* params, ZSTD_cParameter param, int value);
2006
+
2007
+ /*! ZSTD_CCtxParams_getParameter() :
2008
+ * Similar to ZSTD_CCtx_getParameter.
2009
+ * Get the requested value of one compression parameter, selected by enum ZSTD_cParameter.
2010
+ * @result : 0, or an error code (which can be tested with ZSTD_isError()).
2011
+ */
2012
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_getParameter(const ZSTD_CCtx_params* params, ZSTD_cParameter param, int* value);
2013
+
2014
+ /*! ZSTD_CCtx_setParametersUsingCCtxParams() :
2015
+ * Apply a set of ZSTD_CCtx_params to the compression context.
2016
+ * This can be done even after compression is started,
2017
+ * if nbWorkers==0, this will have no impact until a new compression is started.
2018
+ * if nbWorkers>=1, new parameters will be picked up at next job,
2019
+ * with a few restrictions (windowLog, pledgedSrcSize, nbWorkers, jobSize, and overlapLog are not updated).
2020
+ */
2021
+ ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setParametersUsingCCtxParams(
2022
+ ZSTD_CCtx* cctx, const ZSTD_CCtx_params* params);
2023
+
2024
+ /*! ZSTD_compressStream2_simpleArgs() :
2025
+ * Same as ZSTD_compressStream2(),
2026
+ * but using only integral types as arguments.
2027
+ * This variant might be helpful for binders from dynamic languages
2028
+ * which have troubles handling structures containing memory pointers.
2029
+ */
2030
+ ZSTDLIB_STATIC_API size_t ZSTD_compressStream2_simpleArgs (
2031
+ ZSTD_CCtx* cctx,
2032
+ void* dst, size_t dstCapacity, size_t* dstPos,
2033
+ const void* src, size_t srcSize, size_t* srcPos,
2034
+ ZSTD_EndDirective endOp);
2035
+
2036
+
2037
+ /***************************************
2038
+ * Advanced decompression functions
2039
+ ***************************************/
2040
+
2041
+ /*! ZSTD_isFrame() :
2042
+ * Tells if the content of `buffer` starts with a valid Frame Identifier.
2043
+ * Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
2044
+ * Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
2045
+ * Note 3 : Skippable Frame Identifiers are considered valid. */
2046
+ ZSTDLIB_STATIC_API unsigned ZSTD_isFrame(const void* buffer, size_t size);
2047
+
2048
+ /*! ZSTD_createDDict_byReference() :
2049
+ * Create a digested dictionary, ready to start decompression operation without startup delay.
2050
+ * Dictionary content is referenced, and therefore stays in dictBuffer.
2051
+ * It is important that dictBuffer outlives DDict,
2052
+ * it must remain read accessible throughout the lifetime of DDict */
2053
+ ZSTDLIB_STATIC_API ZSTD_DDict* ZSTD_createDDict_byReference(const void* dictBuffer, size_t dictSize);
2054
+
2055
+ /*! ZSTD_DCtx_loadDictionary_byReference() :
2056
+ * Same as ZSTD_DCtx_loadDictionary(),
2057
+ * but references `dict` content instead of copying it into `dctx`.
2058
+ * This saves memory if `dict` remains around.,
2059
+ * However, it's imperative that `dict` remains accessible (and unmodified) while being used, so it must outlive decompression. */
2060
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_loadDictionary_byReference(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
2061
+
2062
+ /*! ZSTD_DCtx_loadDictionary_advanced() :
2063
+ * Same as ZSTD_DCtx_loadDictionary(),
2064
+ * but gives direct control over
2065
+ * how to load the dictionary (by copy ? by reference ?)
2066
+ * and how to interpret it (automatic ? force raw mode ? full mode only ?). */
2067
+ 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);
2068
+
2069
+ /*! ZSTD_DCtx_refPrefix_advanced() :
2070
+ * Same as ZSTD_DCtx_refPrefix(), but gives finer control over
2071
+ * how to interpret prefix content (automatic ? force raw mode (default) ? full mode only ?) */
2072
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_refPrefix_advanced(ZSTD_DCtx* dctx, const void* prefix, size_t prefixSize, ZSTD_dictContentType_e dictContentType);
2073
+
2074
+ /*! ZSTD_DCtx_setMaxWindowSize() :
2075
+ * Refuses allocating internal buffers for frames requiring a window size larger than provided limit.
2076
+ * This protects a decoder context from reserving too much memory for itself (potential attack scenario).
2077
+ * This parameter is only useful in streaming mode, since no internal buffer is allocated in single-pass mode.
2078
+ * By default, a decompression context accepts all window sizes <= (1 << ZSTD_WINDOWLOG_LIMIT_DEFAULT)
2079
+ * @return : 0, or an error code (which can be tested using ZSTD_isError()).
2080
+ */
2081
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_setMaxWindowSize(ZSTD_DCtx* dctx, size_t maxWindowSize);
2082
+
2083
+ /*! ZSTD_DCtx_getParameter() :
2084
+ * Get the requested decompression parameter value, selected by enum ZSTD_dParameter,
2085
+ * and store it into int* value.
2086
+ * @return : 0, or an error code (which can be tested with ZSTD_isError()).
2087
+ */
2088
+ ZSTDLIB_STATIC_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, int* value);
2089
+
2090
+ /* ZSTD_d_format
2091
+ * experimental parameter,
2092
+ * allowing selection between ZSTD_format_e input compression formats
2093
+ */
2094
+ #define ZSTD_d_format ZSTD_d_experimentalParam1
2095
+ /* ZSTD_d_stableOutBuffer
2096
+ * Experimental parameter.
2097
+ * Default is 0 == disabled. Set to 1 to enable.
2098
+ *
2099
+ * Tells the decompressor that the ZSTD_outBuffer will ALWAYS be the same
2100
+ * between calls, except for the modifications that zstd makes to pos (the
2101
+ * caller must not modify pos). This is checked by the decompressor, and
2102
+ * decompression will fail if it ever changes. Therefore the ZSTD_outBuffer
2103
+ * MUST be large enough to fit the entire decompressed frame. This will be
2104
+ * checked when the frame content size is known. The data in the ZSTD_outBuffer
2105
+ * in the range [dst, dst + pos) MUST not be modified during decompression
2106
+ * or you will get data corruption.
2107
+ *
2108
+ * When this flags is enabled zstd won't allocate an output buffer, because
2109
+ * it can write directly to the ZSTD_outBuffer, but it will still allocate
2110
+ * an input buffer large enough to fit any compressed block. This will also
2111
+ * avoid the memcpy() from the internal output buffer to the ZSTD_outBuffer.
2112
+ * If you need to avoid the input buffer allocation use the buffer-less
2113
+ * streaming API.
2114
+ *
2115
+ * NOTE: So long as the ZSTD_outBuffer always points to valid memory, using
2116
+ * this flag is ALWAYS memory safe, and will never access out-of-bounds
2117
+ * memory. However, decompression WILL fail if you violate the preconditions.
2118
+ *
2119
+ * WARNING: The data in the ZSTD_outBuffer in the range [dst, dst + pos) MUST
2120
+ * not be modified during decompression or you will get data corruption. This
2121
+ * is because zstd needs to reference data in the ZSTD_outBuffer to regenerate
2122
+ * matches. Normally zstd maintains its own buffer for this purpose, but passing
2123
+ * this flag tells zstd to use the user provided buffer.
2124
+ */
2125
+ #define ZSTD_d_stableOutBuffer ZSTD_d_experimentalParam2
2126
+
2127
+ /* ZSTD_d_forceIgnoreChecksum
2128
+ * Experimental parameter.
2129
+ * Default is 0 == disabled. Set to 1 to enable
2130
+ *
2131
+ * Tells the decompressor to skip checksum validation during decompression, regardless
2132
+ * of whether checksumming was specified during compression. This offers some
2133
+ * slight performance benefits, and may be useful for debugging.
2134
+ * Param has values of type ZSTD_forceIgnoreChecksum_e
2135
+ */
2136
+ #define ZSTD_d_forceIgnoreChecksum ZSTD_d_experimentalParam3
2137
+
2138
+ /* ZSTD_d_refMultipleDDicts
2139
+ * Experimental parameter.
2140
+ * Default is 0 == disabled. Set to 1 to enable
2141
+ *
2142
+ * If enabled and dctx is allocated on the heap, then additional memory will be allocated
2143
+ * to store references to multiple ZSTD_DDict. That is, multiple calls of ZSTD_refDDict()
2144
+ * using a given ZSTD_DCtx, rather than overwriting the previous DDict reference, will instead
2145
+ * store all references. At decompression time, the appropriate dictID is selected
2146
+ * from the set of DDicts based on the dictID in the frame.
2147
+ *
2148
+ * Usage is simply calling ZSTD_refDDict() on multiple dict buffers.
2149
+ *
2150
+ * Param has values of byte ZSTD_refMultipleDDicts_e
2151
+ *
2152
+ * WARNING: Enabling this parameter and calling ZSTD_DCtx_refDDict(), will trigger memory
2153
+ * allocation for the hash table. ZSTD_freeDCtx() also frees this memory.
2154
+ * Memory is allocated as per ZSTD_DCtx::customMem.
2155
+ *
2156
+ * Although this function allocates memory for the table, the user is still responsible for
2157
+ * memory management of the underlying ZSTD_DDict* themselves.
2158
+ */
2159
+ #define ZSTD_d_refMultipleDDicts ZSTD_d_experimentalParam4
2160
+
2161
+
2162
+ /*! ZSTD_DCtx_setFormat() :
2163
+ * This function is REDUNDANT. Prefer ZSTD_DCtx_setParameter().
2164
+ * Instruct the decoder context about what kind of data to decode next.
2165
+ * This instruction is mandatory to decode data without a fully-formed header,
2166
+ * such ZSTD_f_zstd1_magicless for example.
2167
+ * @return : 0, or an error code (which can be tested using ZSTD_isError()). */
2168
+ ZSTD_DEPRECATED("use ZSTD_DCtx_setParameter() instead")
2169
+ size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format);
2170
+
2171
+ /*! ZSTD_decompressStream_simpleArgs() :
2172
+ * Same as ZSTD_decompressStream(),
2173
+ * but using only integral types as arguments.
2174
+ * This can be helpful for binders from dynamic languages
2175
+ * which have troubles handling structures containing memory pointers.
2176
+ */
2177
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressStream_simpleArgs (
2178
+ ZSTD_DCtx* dctx,
2179
+ void* dst, size_t dstCapacity, size_t* dstPos,
2180
+ const void* src, size_t srcSize, size_t* srcPos);
2181
+
2182
+
2183
+ /********************************************************************
2184
+ * Advanced streaming functions
2185
+ * Warning : most of these functions are now redundant with the Advanced API.
2186
+ * Once Advanced API reaches "stable" status,
2187
+ * redundant functions will be deprecated, and then at some point removed.
2188
+ ********************************************************************/
2189
+
2190
+ /*===== Advanced Streaming compression functions =====*/
2191
+
2192
+ /*! ZSTD_initCStream_srcSize() :
2193
+ * This function is DEPRECATED, and equivalent to:
2194
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2195
+ * ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)
2196
+ * ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
2197
+ * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2198
+ *
2199
+ * pledgedSrcSize must be correct. If it is not known at init time, use
2200
+ * ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
2201
+ * "0" also disables frame content size field. It may be enabled in the future.
2202
+ * This prototype will generate compilation warnings.
2203
+ */
2204
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2205
+ size_t ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
2206
+ int compressionLevel,
2207
+ unsigned long long pledgedSrcSize);
2208
+
2209
+ /*! ZSTD_initCStream_usingDict() :
2210
+ * This function is DEPRECATED, and is equivalent to:
2211
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2212
+ * ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
2213
+ * ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);
2214
+ *
2215
+ * Creates of an internal CDict (incompatible with static CCtx), except if
2216
+ * dict == NULL or dictSize < 8, in which case no dict is used.
2217
+ * Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
2218
+ * it begins with ZSTD_MAGIC_DICTIONARY, else as raw content) and ZSTD_dlm_byCopy.
2219
+ * This prototype will generate compilation warnings.
2220
+ */
2221
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2222
+ size_t ZSTD_initCStream_usingDict(ZSTD_CStream* zcs,
2223
+ const void* dict, size_t dictSize,
2224
+ int compressionLevel);
2225
+
2226
+ /*! ZSTD_initCStream_advanced() :
2227
+ * This function is DEPRECATED, and is approximately equivalent to:
2228
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2229
+ * // Pseudocode: Set each zstd parameter and leave the rest as-is.
2230
+ * for ((param, value) : params) {
2231
+ * ZSTD_CCtx_setParameter(zcs, param, value);
2232
+ * }
2233
+ * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2234
+ * ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);
2235
+ *
2236
+ * dict is loaded with ZSTD_dct_auto and ZSTD_dlm_byCopy.
2237
+ * pledgedSrcSize must be correct.
2238
+ * If srcSize is not known at init time, use value ZSTD_CONTENTSIZE_UNKNOWN.
2239
+ * This prototype will generate compilation warnings.
2240
+ */
2241
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2242
+ size_t ZSTD_initCStream_advanced(ZSTD_CStream* zcs,
2243
+ const void* dict, size_t dictSize,
2244
+ ZSTD_parameters params,
2245
+ unsigned long long pledgedSrcSize);
2246
+
2247
+ /*! ZSTD_initCStream_usingCDict() :
2248
+ * This function is DEPRECATED, and equivalent to:
2249
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2250
+ * ZSTD_CCtx_refCDict(zcs, cdict);
2251
+ *
2252
+ * note : cdict will just be referenced, and must outlive compression session
2253
+ * This prototype will generate compilation warnings.
2254
+ */
2255
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instructions")
2256
+ size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDict* cdict);
2257
+
2258
+ /*! ZSTD_initCStream_usingCDict_advanced() :
2259
+ * This function is DEPRECATED, and is approximately equivalent to:
2260
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2261
+ * // Pseudocode: Set each zstd frame parameter and leave the rest as-is.
2262
+ * for ((fParam, value) : fParams) {
2263
+ * ZSTD_CCtx_setParameter(zcs, fParam, value);
2264
+ * }
2265
+ * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2266
+ * ZSTD_CCtx_refCDict(zcs, cdict);
2267
+ *
2268
+ * same as ZSTD_initCStream_usingCDict(), with control over frame parameters.
2269
+ * pledgedSrcSize must be correct. If srcSize is not known at init time, use
2270
+ * value ZSTD_CONTENTSIZE_UNKNOWN.
2271
+ * This prototype will generate compilation warnings.
2272
+ */
2273
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instructions")
2274
+ size_t ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
2275
+ const ZSTD_CDict* cdict,
2276
+ ZSTD_frameParameters fParams,
2277
+ unsigned long long pledgedSrcSize);
2278
+
2279
+ /*! ZSTD_resetCStream() :
2280
+ * This function is DEPRECATED, and is equivalent to:
2281
+ * ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
2282
+ * ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
2283
+ * Note: ZSTD_resetCStream() interprets pledgedSrcSize == 0 as ZSTD_CONTENTSIZE_UNKNOWN, but
2284
+ * ZSTD_CCtx_setPledgedSrcSize() does not do the same, so ZSTD_CONTENTSIZE_UNKNOWN must be
2285
+ * explicitly specified.
2286
+ *
2287
+ * start a new frame, using same parameters from previous frame.
2288
+ * This is typically useful to skip dictionary loading stage, since it will re-use it in-place.
2289
+ * Note that zcs must be init at least once before using ZSTD_resetCStream().
2290
+ * If pledgedSrcSize is not known at reset time, use macro ZSTD_CONTENTSIZE_UNKNOWN.
2291
+ * If pledgedSrcSize > 0, its value must be correct, as it will be written in header, and controlled at the end.
2292
+ * For the time being, pledgedSrcSize==0 is interpreted as "srcSize unknown" for compatibility with older programs,
2293
+ * but it will change to mean "empty" in future version, so use macro ZSTD_CONTENTSIZE_UNKNOWN instead.
2294
+ * @return : 0, or an error code (which can be tested using ZSTD_isError())
2295
+ * This prototype will generate compilation warnings.
2296
+ */
2297
+ ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
2298
+ size_t ZSTD_resetCStream(ZSTD_CStream* zcs, unsigned long long pledgedSrcSize);
2299
+
2300
+
2301
+ typedef struct {
2302
+ unsigned long long ingested; /* nb input bytes read and buffered */
2303
+ unsigned long long consumed; /* nb input bytes actually compressed */
2304
+ unsigned long long produced; /* nb of compressed bytes generated and buffered */
2305
+ unsigned long long flushed; /* nb of compressed bytes flushed : not provided; can be tracked from caller side */
2306
+ unsigned currentJobID; /* MT only : latest started job nb */
2307
+ unsigned nbActiveWorkers; /* MT only : nb of workers actively compressing at probe time */
2308
+ } ZSTD_frameProgression;
2309
+
2310
+ /* ZSTD_getFrameProgression() :
2311
+ * tells how much data has been ingested (read from input)
2312
+ * consumed (input actually compressed) and produced (output) for current frame.
2313
+ * Note : (ingested - consumed) is amount of input data buffered internally, not yet compressed.
2314
+ * Aggregates progression inside active worker threads.
2315
+ */
2316
+ ZSTDLIB_STATIC_API ZSTD_frameProgression ZSTD_getFrameProgression(const ZSTD_CCtx* cctx);
2317
+
2318
+ /*! ZSTD_toFlushNow() :
2319
+ * Tell how many bytes are ready to be flushed immediately.
2320
+ * Useful for multithreading scenarios (nbWorkers >= 1).
2321
+ * Probe the oldest active job, defined as oldest job not yet entirely flushed,
2322
+ * and check its output buffer.
2323
+ * @return : amount of data stored in oldest job and ready to be flushed immediately.
2324
+ * if @return == 0, it means either :
2325
+ * + there is no active job (could be checked with ZSTD_frameProgression()), or
2326
+ * + oldest job is still actively compressing data,
2327
+ * but everything it has produced has also been flushed so far,
2328
+ * therefore flush speed is limited by production speed of oldest job
2329
+ * irrespective of the speed of concurrent (and newer) jobs.
2330
+ */
2331
+ ZSTDLIB_STATIC_API size_t ZSTD_toFlushNow(ZSTD_CCtx* cctx);
2332
+
2333
+
2334
+ /*===== Advanced Streaming decompression functions =====*/
2335
+
2336
+ /*!
2337
+ * This function is deprecated, and is equivalent to:
2338
+ *
2339
+ * ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);
2340
+ * ZSTD_DCtx_loadDictionary(zds, dict, dictSize);
2341
+ *
2342
+ * note: no dictionary will be used if dict == NULL or dictSize < 8
2343
+ * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2344
+ */
2345
+ ZSTDLIB_STATIC_API size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dict, size_t dictSize);
2346
+
2347
+ /*!
2348
+ * This function is deprecated, and is equivalent to:
2349
+ *
2350
+ * ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);
2351
+ * ZSTD_DCtx_refDDict(zds, ddict);
2352
+ *
2353
+ * note : ddict is referenced, it must outlive decompression session
2354
+ * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2355
+ */
2356
+ ZSTDLIB_STATIC_API size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* zds, const ZSTD_DDict* ddict);
2357
+
2358
+ /*!
2359
+ * This function is deprecated, and is equivalent to:
2360
+ *
2361
+ * ZSTD_DCtx_reset(zds, ZSTD_reset_session_only);
2362
+ *
2363
+ * re-use decompression parameters from previous init; saves dictionary loading
2364
+ * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
2365
+ */
2366
+ ZSTDLIB_STATIC_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
2367
+
2368
+
2369
+ /*********************************************************************
2370
+ * Buffer-less and synchronous inner streaming functions
2371
+ *
2372
+ * This is an advanced API, giving full control over buffer management, for users which need direct control over memory.
2373
+ * But it's also a complex one, with several restrictions, documented below.
2374
+ * Prefer normal streaming API for an easier experience.
2375
+ ********************************************************************* */
2376
+
2377
+ /**
2378
+ Buffer-less streaming compression (synchronous mode)
2379
+
2380
+ A ZSTD_CCtx object is required to track streaming operations.
2381
+ Use ZSTD_createCCtx() / ZSTD_freeCCtx() to manage resource.
2382
+ ZSTD_CCtx object can be re-used multiple times within successive compression operations.
2383
+
2384
+ Start by initializing a context.
2385
+ Use ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression.
2386
+ It's also possible to duplicate a reference context which has already been initialized, using ZSTD_copyCCtx()
2387
+
2388
+ Then, consume your input using ZSTD_compressContinue().
2389
+ There are some important considerations to keep in mind when using this advanced function :
2390
+ - ZSTD_compressContinue() has no internal buffer. It uses externally provided buffers only.
2391
+ - Interface is synchronous : input is consumed entirely and produces 1+ compressed blocks.
2392
+ - Caller must ensure there is enough space in `dst` to store compressed data under worst case scenario.
2393
+ Worst case evaluation is provided by ZSTD_compressBound().
2394
+ ZSTD_compressContinue() doesn't guarantee recover after a failed compression.
2395
+ - ZSTD_compressContinue() presumes prior input ***is still accessible and unmodified*** (up to maximum distance size, see WindowLog).
2396
+ It remembers all previous contiguous blocks, plus one separated memory segment (which can itself consists of multiple contiguous blocks)
2397
+ - ZSTD_compressContinue() detects that prior input has been overwritten when `src` buffer overlaps.
2398
+ In which case, it will "discard" the relevant memory section from its history.
2399
+
2400
+ Finish a frame with ZSTD_compressEnd(), which will write the last block(s) and optional checksum.
2401
+ It's possible to use srcSize==0, in which case, it will write a final empty block to end the frame.
2402
+ Without last block mark, frames are considered unfinished (hence corrupted) by compliant decoders.
2403
+
2404
+ `ZSTD_CCtx` object can be re-used (ZSTD_compressBegin()) to compress again.
2405
+ */
2406
+
2407
+ /*===== Buffer-less streaming compression functions =====*/
2408
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBegin(ZSTD_CCtx* cctx, int compressionLevel);
2409
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBegin_usingDict(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, int compressionLevel);
2410
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /**< note: fails if cdict==NULL */
2411
+ ZSTDLIB_STATIC_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 */
2412
+
2413
+ ZSTDLIB_STATIC_API size_t ZSTD_compressContinue(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2414
+ ZSTDLIB_STATIC_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2415
+
2416
+ /* The ZSTD_compressBegin_advanced() and ZSTD_compressBegin_usingCDict_advanced() are now DEPRECATED and will generate a compiler warning */
2417
+ ZSTD_DEPRECATED("use advanced API to access custom parameters")
2418
+ 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 */
2419
+ ZSTD_DEPRECATED("use advanced API to access custom parameters")
2420
+ 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 */
2421
+ /**
2422
+ Buffer-less streaming decompression (synchronous mode)
2423
+
2424
+ A ZSTD_DCtx object is required to track streaming operations.
2425
+ Use ZSTD_createDCtx() / ZSTD_freeDCtx() to manage it.
2426
+ A ZSTD_DCtx object can be re-used multiple times.
2427
+
2428
+ First typical operation is to retrieve frame parameters, using ZSTD_getFrameHeader().
2429
+ Frame header is extracted from the beginning of compressed frame, so providing only the frame's beginning is enough.
2430
+ Data fragment must be large enough to ensure successful decoding.
2431
+ `ZSTD_frameHeaderSize_max` bytes is guaranteed to always be large enough.
2432
+ @result : 0 : successful decoding, the `ZSTD_frameHeader` structure is correctly filled.
2433
+ >0 : `srcSize` is too small, please provide at least @result bytes on next attempt.
2434
+ errorCode, which can be tested using ZSTD_isError().
2435
+
2436
+ It fills a ZSTD_frameHeader structure with important information to correctly decode the frame,
2437
+ such as the dictionary ID, content size, or maximum back-reference distance (`windowSize`).
2438
+ Note that these values could be wrong, either because of data corruption, or because a 3rd party deliberately spoofs false information.
2439
+ As a consequence, check that values remain within valid application range.
2440
+ For example, do not allocate memory blindly, check that `windowSize` is within expectation.
2441
+ Each application can set its own limits, depending on local restrictions.
2442
+ For extended interoperability, it is recommended to support `windowSize` of at least 8 MB.
2443
+
2444
+ ZSTD_decompressContinue() needs previous data blocks during decompression, up to `windowSize` bytes.
2445
+ ZSTD_decompressContinue() is very sensitive to contiguity,
2446
+ if 2 blocks don't follow each other, make sure that either the compressor breaks contiguity at the same place,
2447
+ or that previous contiguous segment is large enough to properly handle maximum back-reference distance.
2448
+ There are multiple ways to guarantee this condition.
2449
+
2450
+ The most memory efficient way is to use a round buffer of sufficient size.
2451
+ Sufficient size is determined by invoking ZSTD_decodingBufferSize_min(),
2452
+ which can @return an error code if required value is too large for current system (in 32-bits mode).
2453
+ In a round buffer methodology, ZSTD_decompressContinue() decompresses each block next to previous one,
2454
+ up to the moment there is not enough room left in the buffer to guarantee decoding another full block,
2455
+ which maximum size is provided in `ZSTD_frameHeader` structure, field `blockSizeMax`.
2456
+ At which point, decoding can resume from the beginning of the buffer.
2457
+ Note that already decoded data stored in the buffer should be flushed before being overwritten.
2458
+
2459
+ There are alternatives possible, for example using two or more buffers of size `windowSize` each, though they consume more memory.
2460
+
2461
+ Finally, if you control the compression process, you can also ignore all buffer size rules,
2462
+ as long as the encoder and decoder progress in "lock-step",
2463
+ aka use exactly the same buffer sizes, break contiguity at the same place, etc.
2464
+
2465
+ Once buffers are setup, start decompression, with ZSTD_decompressBegin().
2466
+ If decompression requires a dictionary, use ZSTD_decompressBegin_usingDict() or ZSTD_decompressBegin_usingDDict().
2467
+
2468
+ Then use ZSTD_nextSrcSizeToDecompress() and ZSTD_decompressContinue() alternatively.
2469
+ ZSTD_nextSrcSizeToDecompress() tells how many bytes to provide as 'srcSize' to ZSTD_decompressContinue().
2470
+ ZSTD_decompressContinue() requires this _exact_ amount of bytes, or it will fail.
2471
+
2472
+ @result of ZSTD_decompressContinue() is the number of bytes regenerated within 'dst' (necessarily <= dstCapacity).
2473
+ It can be zero : it just means ZSTD_decompressContinue() has decoded some metadata item.
2474
+ It can also be an error code, which can be tested with ZSTD_isError().
2475
+
2476
+ A frame is fully decoded when ZSTD_nextSrcSizeToDecompress() returns zero.
2477
+ Context can then be reset to start a new decompression.
2478
+
2479
+ Note : it's possible to know if next input to present is a header or a block, using ZSTD_nextInputType().
2480
+ This information is not required to properly decode a frame.
2481
+
2482
+ == Special case : skippable frames ==
2483
+
2484
+ Skippable frames allow integration of user-defined data into a flow of concatenated frames.
2485
+ Skippable frames will be ignored (skipped) by decompressor.
2486
+ The format of skippable frames is as follows :
2487
+ a) Skippable frame ID - 4 Bytes, Little endian format, any value from 0x184D2A50 to 0x184D2A5F
2488
+ b) Frame Size - 4 Bytes, Little endian format, unsigned 32-bits
2489
+ c) Frame Content - any content (User Data) of length equal to Frame Size
2490
+ For skippable frames ZSTD_getFrameHeader() returns zfhPtr->frameType==ZSTD_skippableFrame.
2491
+ For skippable frames ZSTD_decompressContinue() always returns 0 : it only skips the content.
2492
+ */
2493
+
2494
+ /*===== Buffer-less streaming decompression functions =====*/
2495
+ typedef enum { ZSTD_frame, ZSTD_skippableFrame } ZSTD_frameType_e;
2496
+ typedef struct {
2497
+ unsigned long long frameContentSize; /* if == ZSTD_CONTENTSIZE_UNKNOWN, it means this field is not available. 0 means "empty" */
2498
+ unsigned long long windowSize; /* can be very large, up to <= frameContentSize */
2499
+ unsigned blockSizeMax;
2500
+ ZSTD_frameType_e frameType; /* if == ZSTD_skippableFrame, frameContentSize is the size of skippable content */
2501
+ unsigned headerSize;
2502
+ unsigned dictID;
2503
+ unsigned checksumFlag;
2504
+ } ZSTD_frameHeader;
2505
+
2506
+ /*! ZSTD_getFrameHeader() :
2507
+ * decode Frame Header, or requires larger `srcSize`.
2508
+ * @return : 0, `zfhPtr` is correctly filled,
2509
+ * >0, `srcSize` is too small, value is wanted `srcSize` amount,
2510
+ * or an error code, which can be tested using ZSTD_isError() */
2511
+ ZSTDLIB_STATIC_API size_t ZSTD_getFrameHeader(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize); /**< doesn't consume input */
2512
+ /*! ZSTD_getFrameHeader_advanced() :
2513
+ * same as ZSTD_getFrameHeader(),
2514
+ * with added capability to select a format (like ZSTD_f_zstd1_magicless) */
2515
+ ZSTDLIB_STATIC_API size_t ZSTD_getFrameHeader_advanced(ZSTD_frameHeader* zfhPtr, const void* src, size_t srcSize, ZSTD_format_e format);
2516
+ 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 */
2517
+
2518
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBegin(ZSTD_DCtx* dctx);
2519
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBegin_usingDict(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
2520
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBegin_usingDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
2521
+
2522
+ ZSTDLIB_STATIC_API size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx);
2523
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2524
+
2525
+ /* misc */
2526
+ ZSTDLIB_STATIC_API void ZSTD_copyDCtx(ZSTD_DCtx* dctx, const ZSTD_DCtx* preparedDCtx);
2527
+ typedef enum { ZSTDnit_frameHeader, ZSTDnit_blockHeader, ZSTDnit_block, ZSTDnit_lastBlock, ZSTDnit_checksum, ZSTDnit_skippableFrame } ZSTD_nextInputType_e;
2528
+ ZSTDLIB_STATIC_API ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
2529
+
2530
+
2531
+
2532
+
2533
+ /* ============================ */
2534
+ /** Block level API */
2535
+ /* ============================ */
2536
+
2537
+ /*!
2538
+ Block functions produce and decode raw zstd blocks, without frame metadata.
2539
+ Frame metadata cost is typically ~12 bytes, which can be non-negligible for very small blocks (< 100 bytes).
2540
+ But users will have to take in charge needed metadata to regenerate data, such as compressed and content sizes.
2541
+
2542
+ A few rules to respect :
2543
+ - Compressing and decompressing require a context structure
2544
+ + Use ZSTD_createCCtx() and ZSTD_createDCtx()
2545
+ - It is necessary to init context before starting
2546
+ + compression : any ZSTD_compressBegin*() variant, including with dictionary
2547
+ + decompression : any ZSTD_decompressBegin*() variant, including with dictionary
2548
+ + copyCCtx() and copyDCtx() can be used too
2549
+ - Block size is limited, it must be <= ZSTD_getBlockSize() <= ZSTD_BLOCKSIZE_MAX == 128 KB
2550
+ + If input is larger than a block size, it's necessary to split input data into multiple blocks
2551
+ + For inputs larger than a single block, consider using regular ZSTD_compress() instead.
2552
+ Frame metadata is not that costly, and quickly becomes negligible as source size grows larger than a block.
2553
+ - When a block is considered not compressible enough, ZSTD_compressBlock() result will be 0 (zero) !
2554
+ ===> In which case, nothing is produced into `dst` !
2555
+ + User __must__ test for such outcome and deal directly with uncompressed data
2556
+ + A block cannot be declared incompressible if ZSTD_compressBlock() return value was != 0.
2557
+ Doing so would mess up with statistics history, leading to potential data corruption.
2558
+ + ZSTD_decompressBlock() _doesn't accept uncompressed data as input_ !!
2559
+ + In case of multiple successive blocks, should some of them be uncompressed,
2560
+ decoder must be informed of their existence in order to follow proper history.
2561
+ Use ZSTD_insertBlock() for such a case.
2562
+ */
2563
+
2564
+ /*===== Raw zstd block functions =====*/
2565
+ ZSTDLIB_STATIC_API size_t ZSTD_getBlockSize (const ZSTD_CCtx* cctx);
2566
+ ZSTDLIB_STATIC_API size_t ZSTD_compressBlock (ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2567
+ ZSTDLIB_STATIC_API size_t ZSTD_decompressBlock(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
2568
+ 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. */
2569
+
2570
+
2571
+ #endif /* ZSTD_H_ZSTD_STATIC_LINKING_ONLY */
2572
+
2573
+ #if defined (__cplusplus)
2574
+ }
2575
+ #endif