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