Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / zstd / 7757577341bf9bbefeb3686a9127c32bb1fc3d3c / . / doc / zstd_manual.html
blob: 23224d77ab6da1a91d9e89c9d962d4f112886c01 [file] [log] [blame]
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]4<title>zstd 1.1.4 Manual</title>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]5</head>
6<body>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]7<h1>zstd 1.1.4 Manual</h1>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]8<hr>
9<a name="Contents"></a><h2>Contents</h2>
10<ol>
11<li><a href="#Chapter1">Introduction</a></li>
12<li><a href="#Chapter2">Version</a></li>
13<li><a href="#Chapter3">Simple API</a></li>
14<li><a href="#Chapter4">Explicit memory management</a></li>
15<li><a href="#Chapter5">Simple dictionary API</a></li>
16<li><a href="#Chapter6">Fast dictionary API</a></li>
17<li><a href="#Chapter7">Streaming</a></li>
18<li><a href="#Chapter8">Streaming compression - HowTo</a></li>
19<li><a href="#Chapter9">Streaming decompression - HowTo</a></li>
20<li><a href="#Chapter10">START OF ADVANCED AND EXPERIMENTAL FUNCTIONS</a></li>
21<li><a href="#Chapter11">Advanced types</a></li>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]22<li><a href="#Chapter12">Compressed size functions</a></li>
23<li><a href="#Chapter13">Decompressed size functions</a></li>
24<li><a href="#Chapter14">Advanced compression functions</a></li>
25<li><a href="#Chapter15">Advanced decompression functions</a></li>
26<li><a href="#Chapter16">Advanced streaming functions</a></li>
27<li><a href="#Chapter17">Buffer-less and synchronous inner streaming functions</a></li>
28<li><a href="#Chapter18">Buffer-less streaming compression (synchronous mode)</a></li>
29<li><a href="#Chapter19">Buffer-less streaming decompression (synchronous mode)</a></li>
30<li><a href="#Chapter20">Block functions</a></li>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]31</ol>
32<hr>
33<a name="Chapter1"></a><h2>Introduction</h2><pre>
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]34 zstd, short for Zstandard, is a fast lossless compression algorithm, targeting real-time compression scenarios
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]35 at zlib-level and better compression ratios. The zstd compression library provides in-memory compression and
36 decompression functions. The library supports compression levels from 1 up to ZSTD_maxCLevel() which is 22.
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]37 Levels >= 20, labelled `--ultra`, should be used with caution, as they require more memory.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]38 Compression can be done in:
39 - a single step (described as Simple API)
40 - a single step, reusing a context (described as Explicit memory management)
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]41 - unbounded multiple steps (described as Streaming compression)
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]42 The compression ratio achievable on small data can be highly improved using compression with a dictionary in:
43 - a single step (described as Simple dictionary API)
44 - a single step, reusing a dictionary (described as Fast dictionary API)
45
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]46 Advanced experimental functions can be accessed using #define ZSTD_STATIC_LINKING_ONLY before including zstd.h.
47 These APIs shall never be used with a dynamic library.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]48 They are not "stable", their definition may change in the future. Only static linking is allowed.
49<BR></pre>
50
51<a name="Chapter2"></a><h2>Version</h2><pre></pre>
52
Przemyslaw Skibinski4da53212016-12-07 11:18:40 +0100[diff] [blame]53<pre><b>unsigned ZSTD_versionNumber(void); </b>/**< library version number; to be used when checking dll version */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]54</b></pre><BR>
55<a name="Chapter3"></a><h2>Simple API</h2><pre></pre>
56
57<pre><b>size_t ZSTD_compress( void* dst, size_t dstCapacity,
58 const void* src, size_t srcSize,
59 int compressionLevel);
60</b><p> Compresses `src` content as a single zstd compressed frame into already allocated `dst`.
61 Hint : compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
62 @return : compressed size written into `dst` (<= `dstCapacity),
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]63 or an error code if it fails (which can be tested using ZSTD_isError()).
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]64</p></pre><BR>
65
66<pre><b>size_t ZSTD_decompress( void* dst, size_t dstCapacity,
67 const void* src, size_t compressedSize);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]68</b><p> `compressedSize` : must be the _exact_ size of some number of compressed and/or skippable frames.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]69 `dstCapacity` is an upper bound of originalSize.
70 If user cannot imply a maximum upper bound, it's better to use streaming mode to decompress data.
71 @return : the number of bytes decompressed into `dst` (<= `dstCapacity`),
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]72 or an errorCode if it fails (which can be tested using ZSTD_isError()).
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]73</p></pre><BR>
74
75<pre><b>unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]76</b><p> NOTE: This function is planned to be obsolete, in favour of ZSTD_getFrameContentSize.
77 ZSTD_getFrameContentSize functions the same way, returning the decompressed size of a single
78 frame, but distinguishes empty frames from frames with an unknown size, or errors.
79
80 Additionally, ZSTD_findDecompressedSize can be used instead. It can handle multiple
81 concatenated frames in one buffer, and so is more general.
82 As a result however, it requires more computation and entire frames to be passed to it,
83 as opposed to ZSTD_getFrameContentSize which requires only a single frame's header.
84
85 'src' is the start of a zstd compressed frame.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]86 @return : content size to be decompressed, as a 64-bits value _if known_, 0 otherwise.
87 note 1 : decompressed size is an optional field, that may not be present, especially in streaming mode.
88 When `return==0`, data to decompress could be any size.
89 In which case, it's necessary to use streaming mode to decompress data.
90 Optionally, application can still use ZSTD_decompress() while relying on implied limits.
91 (For example, data may be necessarily cut into blocks <= 16 KB).
92 note 2 : decompressed size is always present when compression is done with ZSTD_compress()
93 note 3 : decompressed size can be very large (64-bits value),
94 potentially larger than what local system can handle as a single memory segment.
95 In which case, it's necessary to use streaming mode to decompress data.
96 note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
97 Always ensure result fits within application's authorized limits.
98 Each application can set its own limits.
99 note 5 : when `return==0`, if precise failure cause is needed, use ZSTD_getFrameParams() to know more.
100</p></pre><BR>
101
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]102<h3>Helper functions</h3><pre></pre><b><pre>int ZSTD_maxCLevel(void); </b>/*!< maximum compression level available */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]103size_t ZSTD_compressBound(size_t srcSize); </b>/*!< maximum compressed size in worst case scenario */<b>
104unsigned ZSTD_isError(size_t code); </b>/*!< tells if a `size_t` function result is an error code */<b>
105const char* ZSTD_getErrorName(size_t code); </b>/*!< provides readable string from an error code */<b>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]106</pre></b><BR>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]107<a name="Chapter4"></a><h2>Explicit memory management</h2><pre></pre>
108
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]109<h3>Compression context</h3><pre> When compressing many times,
110 it is recommended to allocate a context just once, and re-use it for each successive compression operation.
111 This will make workload friendlier for system's memory.
112 Use one context per thread for parallel execution in multi-threaded environments.
113</pre><b><pre>typedef struct ZSTD_CCtx_s ZSTD_CCtx;
114ZSTD_CCtx* ZSTD_createCCtx(void);
115size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
116</pre></b><BR>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]117<pre><b>size_t ZSTD_compressCCtx(ZSTD_CCtx* ctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize, int compressionLevel);
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]118</b><p> Same as ZSTD_compress(), requires an allocated ZSTD_CCtx (see ZSTD_createCCtx()).
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]119</p></pre><BR>
120
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]121<h3>Decompression context</h3><pre></pre><b><pre>typedef struct ZSTD_DCtx_s ZSTD_DCtx;
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]122ZSTD_DCtx* ZSTD_createDCtx(void);
123size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]124</pre></b><BR>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]125<pre><b>size_t ZSTD_decompressDCtx(ZSTD_DCtx* ctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]126</b><p> Same as ZSTD_decompress(), requires an allocated ZSTD_DCtx (see ZSTD_createDCtx()).
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]127</p></pre><BR>
128
129<a name="Chapter5"></a><h2>Simple dictionary API</h2><pre></pre>
130
131<pre><b>size_t ZSTD_compress_usingDict(ZSTD_CCtx* ctx,
132 void* dst, size_t dstCapacity,
133 const void* src, size_t srcSize,
134 const void* dict,size_t dictSize,
135 int compressionLevel);
136</b><p> Compression using a predefined Dictionary (see dictBuilder/zdict.h).
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]137 Note : This function loads the dictionary, resulting in significant startup delay.
138 Note : When `dict == NULL || dictSize < 8` no dictionary is used.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]139</p></pre><BR>
140
141<pre><b>size_t ZSTD_decompress_usingDict(ZSTD_DCtx* dctx,
142 void* dst, size_t dstCapacity,
143 const void* src, size_t srcSize,
144 const void* dict,size_t dictSize);
145</b><p> Decompression using a predefined Dictionary (see dictBuilder/zdict.h).
146 Dictionary must be identical to the one used during compression.
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]147 Note : This function loads the dictionary, resulting in significant startup delay.
148 Note : When `dict == NULL || dictSize < 8` no dictionary is used.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]149</p></pre><BR>
150
151<a name="Chapter6"></a><h2>Fast dictionary API</h2><pre></pre>
152
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]153<pre><b>ZSTD_CDict* ZSTD_createCDict(const void* dictBuffer, size_t dictSize, int compressionLevel);
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]154</b><p> When compressing multiple messages / blocks with the same dictionary, it's recommended to load it just once.
155 ZSTD_createCDict() will create a digested dictionary, ready to start future compression operations without startup delay.
156 ZSTD_CDict can be created once and used by multiple threads concurrently, as its usage is read-only.
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]157 `dictBuffer` can be released after ZSTD_CDict creation, as its content is copied within CDict
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]158</p></pre><BR>
159
160<pre><b>size_t ZSTD_freeCDict(ZSTD_CDict* CDict);
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]161</b><p> Function frees memory allocated by ZSTD_createCDict().
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]162</p></pre><BR>
163
164<pre><b>size_t ZSTD_compress_usingCDict(ZSTD_CCtx* cctx,
165 void* dst, size_t dstCapacity,
166 const void* src, size_t srcSize,
167 const ZSTD_CDict* cdict);
168</b><p> Compression using a digested Dictionary.
169 Faster startup than ZSTD_compress_usingDict(), recommended when same dictionary is used multiple times.
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]170 Note that compression level is decided during dictionary creation.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]171</p></pre><BR>
172
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]173<pre><b>ZSTD_DDict* ZSTD_createDDict(const void* dictBuffer, size_t dictSize);
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]174</b><p> Create a digested dictionary, ready to start decompression operation without startup delay.
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]175 dictBuffer can be released after DDict creation, as its content is copied inside DDict
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]176</p></pre><BR>
177
178<pre><b>size_t ZSTD_freeDDict(ZSTD_DDict* ddict);
179</b><p> Function frees memory allocated with ZSTD_createDDict()
180</p></pre><BR>
181
182<pre><b>size_t ZSTD_decompress_usingDDict(ZSTD_DCtx* dctx,
183 void* dst, size_t dstCapacity,
184 const void* src, size_t srcSize,
185 const ZSTD_DDict* ddict);
Nick Terrelld82efd82016-11-02 16:47:53 -0700[diff] [blame]186</b><p> Decompression using a digested Dictionary.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]187 Faster startup than ZSTD_decompress_usingDict(), recommended when same dictionary is used multiple times.
188</p></pre><BR>
189
190<a name="Chapter7"></a><h2>Streaming</h2><pre></pre>
191
192<pre><b>typedef struct ZSTD_inBuffer_s {
193 const void* src; </b>/**< start of input buffer */<b>
194 size_t size; </b>/**< size of input buffer */<b>
195 size_t pos; </b>/**< position where reading stopped. Will be updated. Necessarily 0 <= pos <= size */<b>
196} ZSTD_inBuffer;
197</b></pre><BR>
198<pre><b>typedef struct ZSTD_outBuffer_s {
199 void* dst; </b>/**< start of output buffer */<b>
200 size_t size; </b>/**< size of output buffer */<b>
201 size_t pos; </b>/**< position where writing stopped. Will be updated. Necessarily 0 <= pos <= size */<b>
202} ZSTD_outBuffer;
203</b></pre><BR>
204<a name="Chapter8"></a><h2>Streaming compression - HowTo</h2><pre>
205 A ZSTD_CStream object is required to track streaming operation.
206 Use ZSTD_createCStream() and ZSTD_freeCStream() to create/release resources.
207 ZSTD_CStream objects can be reused multiple times on consecutive compression operations.
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]208 It is recommended to re-use ZSTD_CStream in situations where many streaming operations will be achieved consecutively,
209 since it will play nicer with system's memory, by re-using already allocated memory.
210 Use one separate ZSTD_CStream per thread for parallel execution.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]211
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]212 Start a new compression by initializing ZSTD_CStream.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]213 Use ZSTD_initCStream() to start a new compression operation.
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]214 Use ZSTD_initCStream_usingDict() or ZSTD_initCStream_usingCDict() for a compression which requires a dictionary (experimental section)
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]215
216 Use ZSTD_compressStream() repetitively to consume input stream.
217 The function will automatically update both `pos` fields.
218 Note that it may not consume the entire input, in which case `pos < size`,
219 and it's up to the caller to present again remaining data.
220 @return : a size hint, preferred nb of bytes to use as input for next function call
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]221 or an error code, which can be tested using ZSTD_isError().
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]222 Note 1 : it's just a hint, to help latency a little, any other value will work fine.
223 Note 2 : size hint is guaranteed to be <= ZSTD_CStreamInSize()
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]224
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]225 At any moment, it's possible to flush whatever data remains within internal buffer, using ZSTD_flushStream().
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]226 `output->pos` will be updated.
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]227 Note that some content might still be left within internal buffer if `output->size` is too small.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]228 @return : nb of bytes still present within internal buffer (0 if it's empty)
229 or an error code, which can be tested using ZSTD_isError().
230
231 ZSTD_endStream() instructs to finish a frame.
232 It will perform a flush and write frame epilogue.
233 The epilogue is required for decoders to consider a frame completed.
234 Similar to ZSTD_flushStream(), it may not be able to flush the full content if `output->size` is too small.
235 In which case, call again ZSTD_endStream() to complete the flush.
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]236 @return : nb of bytes still present within internal buffer (0 if it's empty, hence compression completed)
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]237 or an error code, which can be tested using ZSTD_isError().
238
239
240<BR></pre>
241
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]242<pre><b>size_t ZSTD_CStreamInSize(void); </b>/**< recommended size for input buffer */<b>
243</b></pre><BR>
244<pre><b>size_t ZSTD_CStreamOutSize(void); </b>/**< recommended size for output buffer. Guarantee to successfully flush at least one complete compressed block in all circumstances. */<b>
245</b></pre><BR>
246<a name="Chapter9"></a><h2>Streaming decompression - HowTo</h2><pre>
247 A ZSTD_DStream object is required to track streaming operations.
248 Use ZSTD_createDStream() and ZSTD_freeDStream() to create/release resources.
249 ZSTD_DStream objects can be re-used multiple times.
250
251 Use ZSTD_initDStream() to start a new decompression operation,
252 or ZSTD_initDStream_usingDict() if decompression requires a dictionary.
253 @return : recommended first input size
254
255 Use ZSTD_decompressStream() repetitively to consume your input.
256 The function will update both `pos` fields.
257 If `input.pos < input.size`, some input has not been consumed.
258 It's up to the caller to present again remaining data.
259 If `output.pos < output.size`, decoder has flushed everything it could.
260 @return : 0 when a frame is completely decoded and fully flushed,
261 an error code, which can be tested using ZSTD_isError(),
Przemyslaw Skibinski4da53212016-12-07 11:18:40 +0100[diff] [blame]262 any other value > 0, which means there is still some decoding to do to complete current frame.
263 The return value is a suggested next input size (a hint to improve latency) that will never load more than the current frame.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]264
265<BR></pre>
266
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]267<pre><b>size_t ZSTD_DStreamInSize(void); </b>/*!< recommended size for input buffer */<b>
268</b></pre><BR>
269<pre><b>size_t ZSTD_DStreamOutSize(void); </b>/*!< recommended size for output buffer. Guarantee to successfully flush at least one complete block in all circumstances. */<b>
270</b></pre><BR>
271<a name="Chapter10"></a><h2>START OF ADVANCED AND EXPERIMENTAL FUNCTIONS</h2><pre> The definitions in this section are considered experimental.
272 They should never be used with a dynamic library, as they may change in the future.
273 They are provided for advanced usages.
274 Use them only in association with static linking.
275
276<BR></pre>
277
278<a name="Chapter11"></a><h2>Advanced types</h2><pre></pre>
279
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]280<pre><b>typedef enum { ZSTD_fast, ZSTD_dfast, ZSTD_greedy, ZSTD_lazy, ZSTD_lazy2, ZSTD_btlazy2, ZSTD_btopt, ZSTD_btopt2 } ZSTD_strategy; </b>/* from faster to stronger */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]281</b></pre><BR>
282<pre><b>typedef struct {
283 unsigned windowLog; </b>/**< largest match distance : larger == more compression, more memory needed during decompression */<b>
284 unsigned chainLog; </b>/**< fully searched segment : larger == more compression, slower, more memory (useless for fast) */<b>
285 unsigned hashLog; </b>/**< dispatch table : larger == faster, more memory */<b>
286 unsigned searchLog; </b>/**< nb of searches : larger == more compression, slower */<b>
287 unsigned searchLength; </b>/**< match length searched : larger == faster decompression, sometimes less compression */<b>
288 unsigned targetLength; </b>/**< acceptable match size for optimal parser (only) : larger == more compression, slower */<b>
289 ZSTD_strategy strategy;
290} ZSTD_compressionParameters;
291</b></pre><BR>
292<pre><b>typedef struct {
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]293 unsigned contentSizeFlag; </b>/**< 1: content size will be in frame header (when known) */<b>
294 unsigned checksumFlag; </b>/**< 1: generate a 32-bits checksum at end of frame, for error detection */<b>
295 unsigned noDictIDFlag; </b>/**< 1: no dictID will be saved into frame header (if dictionary compression) */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]296} ZSTD_frameParameters;
297</b></pre><BR>
298<pre><b>typedef struct {
299 ZSTD_compressionParameters cParams;
300 ZSTD_frameParameters fParams;
301} ZSTD_parameters;
302</b></pre><BR>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]303<h3>Custom memory allocation functions</h3><pre></pre><b><pre>typedef void* (*ZSTD_allocFunction) (void* opaque, size_t size);
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]304typedef void (*ZSTD_freeFunction) (void* opaque, void* address);
305typedef struct { ZSTD_allocFunction customAlloc; ZSTD_freeFunction customFree; void* opaque; } ZSTD_customMem;
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]306</pre></b><BR>
307<a name="Chapter12"></a><h2>Compressed size functions</h2><pre></pre>
308
309<pre><b>size_t ZSTD_getFrameCompressedSize(const void* src, size_t srcSize);
310</b><p> `src` should point to the start of a ZSTD encoded frame
311 `srcSize` must be at least as large as the frame
312 @return : the compressed size of the frame pointed to by `src`, suitable to pass to
313 `ZSTD_decompress` or similar, or an error code if given invalid input.
314</p></pre><BR>
315
316<a name="Chapter13"></a><h2>Decompressed size functions</h2><pre></pre>
317
318<pre><b>unsigned long long ZSTD_getFrameContentSize(const void *src, size_t srcSize);
319</b><p> `src` should point to the start of a ZSTD encoded frame
320 `srcSize` must be at least as large as the frame header. A value greater than or equal
321 to `ZSTD_frameHeaderSize_max` is guaranteed to be large enough in all cases.
322 @return : decompressed size of the frame pointed to be `src` if known, otherwise
323 - ZSTD_CONTENTSIZE_UNKNOWN if the size cannot be determined
324 - ZSTD_CONTENTSIZE_ERROR if an error occured (e.g. invalid magic number, srcSize too small)
325</p></pre><BR>
326
327<pre><b>unsigned long long ZSTD_findDecompressedSize(const void* src, size_t srcSize);
328</b><p> `src` should point the start of a series of ZSTD encoded and/or skippable frames
329 `srcSize` must be the _exact_ size of this series
330 (i.e. there should be a frame boundary exactly `srcSize` bytes after `src`)
331 @return : the decompressed size of all data in the contained frames, as a 64-bit value _if known_
332 - if the decompressed size cannot be determined: ZSTD_CONTENTSIZE_UNKNOWN
333 - if an error occurred: ZSTD_CONTENTSIZE_ERROR
334
335 note 1 : decompressed size is an optional field, that may not be present, especially in streaming mode.
336 When `return==ZSTD_CONTENTSIZE_UNKNOWN`, data to decompress could be any size.
337 In which case, it's necessary to use streaming mode to decompress data.
338 Optionally, application can still use ZSTD_decompress() while relying on implied limits.
339 (For example, data may be necessarily cut into blocks <= 16 KB).
340 note 2 : decompressed size is always present when compression is done with ZSTD_compress()
341 note 3 : decompressed size can be very large (64-bits value),
342 potentially larger than what local system can handle as a single memory segment.
343 In which case, it's necessary to use streaming mode to decompress data.
344 note 4 : If source is untrusted, decompressed size could be wrong or intentionally modified.
345 Always ensure result fits within application's authorized limits.
346 Each application can set its own limits.
347 note 5 : ZSTD_findDecompressedSize handles multiple frames, and so it must traverse the input to
348 read each contained frame header. This is efficient as most of the data is skipped,
349 however it does mean that all frame data must be present and valid.
350</p></pre><BR>
351
352<a name="Chapter14"></a><h2>Advanced compression functions</h2><pre></pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]353
354<pre><b>size_t ZSTD_estimateCCtxSize(ZSTD_compressionParameters cParams);
355</b><p> Gives the amount of memory allocated for a ZSTD_CCtx given a set of compression parameters.
356 `frameContentSize` is an optional parameter, provide `0` if unknown
357</p></pre><BR>
358
359<pre><b>ZSTD_CCtx* ZSTD_createCCtx_advanced(ZSTD_customMem customMem);
360</b><p> Create a ZSTD compression context using external alloc and free functions
361</p></pre><BR>
362
363<pre><b>size_t ZSTD_sizeof_CCtx(const ZSTD_CCtx* cctx);
364</b><p> Gives the amount of memory used by a given ZSTD_CCtx
365</p></pre><BR>
366
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]367<pre><b>typedef enum {
368 ZSTD_p_forceWindow </b>/* Force back-references to remain < windowSize, even when referencing Dictionary content (default:0)*/<b>
369} ZSTD_CCtxParameter;
370</b></pre><BR>
371<pre><b>size_t ZSTD_setCCtxParameter(ZSTD_CCtx* cctx, ZSTD_CCtxParameter param, unsigned value);
372</b><p> Set advanced parameters, selected through enum ZSTD_CCtxParameter
373 @result : 0, or an error code (which can be tested with ZSTD_isError())
374</p></pre><BR>
375
376<pre><b>ZSTD_CDict* ZSTD_createCDict_byReference(const void* dictBuffer, size_t dictSize, int compressionLevel);
377</b><p> Create a digested dictionary for compression
378 Dictionary content is simply referenced, and therefore stays in dictBuffer.
379 It is important that dictBuffer outlives CDict, it must remain read accessible throughout the lifetime of CDict
380</p></pre><BR>
381
382<pre><b>ZSTD_CDict* ZSTD_createCDict_advanced(const void* dict, size_t dictSize, unsigned byReference,
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]383 ZSTD_parameters params, ZSTD_customMem customMem);
384</b><p> Create a ZSTD_CDict using external alloc and free, and customized compression parameters
385</p></pre><BR>
386
387<pre><b>size_t ZSTD_sizeof_CDict(const ZSTD_CDict* cdict);
388</b><p> Gives the amount of memory used by a given ZSTD_sizeof_CDict
389</p></pre><BR>
390
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]391<pre><b>ZSTD_compressionParameters ZSTD_getCParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
392</b><p> @return ZSTD_compressionParameters structure for a selected compression level and estimated srcSize.
393 `estimatedSrcSize` value is optional, select 0 if not known
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]394</p></pre><BR>
395
Yann Colletdc993122016-12-14 14:53:47 +0100[diff] [blame]396<pre><b>ZSTD_parameters ZSTD_getParams(int compressionLevel, unsigned long long estimatedSrcSize, size_t dictSize);
397</b><p> same as ZSTD_getCParams(), but @return a full `ZSTD_parameters` object instead of sub-component `ZSTD_compressionParameters`.
398 All fields of `ZSTD_frameParameters` are set to default (0)
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]399</p></pre><BR>
400
401<pre><b>size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
402</b><p> Ensure param values remain within authorized range
403</p></pre><BR>
404
405<pre><b>ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParameters cPar, unsigned long long srcSize, size_t dictSize);
406</b><p> optimize params for a given `srcSize` and `dictSize`.
407 both values are optional, select `0` if unknown.
408</p></pre><BR>
409
410<pre><b>size_t ZSTD_compress_advanced (ZSTD_CCtx* ctx,
411 void* dst, size_t dstCapacity,
412 const void* src, size_t srcSize,
413 const void* dict,size_t dictSize,
414 ZSTD_parameters params);
415</b><p> Same as ZSTD_compress_usingDict(), with fine-tune control of each compression parameter
416</p></pre><BR>
417
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]418<a name="Chapter15"></a><h2>Advanced decompression functions</h2><pre></pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]419
Przemyslaw Skibinski4da53212016-12-07 11:18:40 +0100[diff] [blame]420<pre><b>unsigned ZSTD_isFrame(const void* buffer, size_t size);
421</b><p> Tells if the content of `buffer` starts with a valid Frame Identifier.
422 Note : Frame Identifier is 4 bytes. If `size < 4`, @return will always be 0.
423 Note 2 : Legacy Frame Identifiers are considered valid only if Legacy Support is enabled.
424 Note 3 : Skippable Frame Identifiers are considered valid.
425</p></pre><BR>
426
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]427<pre><b>size_t ZSTD_estimateDCtxSize(void);
428</b><p> Gives the potential amount of memory allocated to create a ZSTD_DCtx
429</p></pre><BR>
430
431<pre><b>ZSTD_DCtx* ZSTD_createDCtx_advanced(ZSTD_customMem customMem);
432</b><p> Create a ZSTD decompression context using external alloc and free functions
433</p></pre><BR>
434
435<pre><b>size_t ZSTD_sizeof_DCtx(const ZSTD_DCtx* dctx);
436</b><p> Gives the amount of memory used by a given ZSTD_DCtx
437</p></pre><BR>
438
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]439<pre><b>ZSTD_DDict* ZSTD_createDDict_byReference(const void* dictBuffer, size_t dictSize);
440</b><p> Create a digested dictionary, ready to start decompression operation without startup delay.
441 Dictionary content is simply referenced, and therefore stays in dictBuffer.
442 It is important that dictBuffer outlives DDict, it must remain read accessible throughout the lifetime of DDict
443</p></pre><BR>
444
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]445<pre><b>size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
446</b><p> Gives the amount of memory used by a given ZSTD_DDict
447</p></pre><BR>
448
Przemyslaw Skibinski4da53212016-12-07 11:18:40 +0100[diff] [blame]449<pre><b>unsigned ZSTD_getDictID_fromDict(const void* dict, size_t dictSize);
450</b><p> Provides the dictID stored within dictionary.
451 if @return == 0, the dictionary is not conformant with Zstandard specification.
452 It can still be loaded, but as a content-only dictionary.
453</p></pre><BR>
454
455<pre><b>unsigned ZSTD_getDictID_fromDDict(const ZSTD_DDict* ddict);
456</b><p> Provides the dictID of the dictionary loaded into `ddict`.
457 If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
458 Non-conformant dictionaries can still be loaded, but as content-only dictionaries.
459</p></pre><BR>
460
461<pre><b>unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
462</b><p> Provides the dictID required to decompressed the frame stored within `src`.
463 If @return == 0, the dictID could not be decoded.
464 This could for one of the following reasons :
465 - The frame does not require a dictionary to be decoded (most common case).
466 - The frame was built with dictID intentionally removed. Whatever dictionary is necessary is a hidden information.
467 Note : this use case also happens when using a non-conformant dictionary.
468 - `srcSize` is too small, and as a result, the frame header could not be decoded (only possible if `srcSize < ZSTD_FRAMEHEADERSIZE_MAX`).
469 - This is not a Zstandard frame.
470 When identifying the exact failure cause, it's possible to used ZSTD_getFrameParams(), which will provide a more precise error code.
471</p></pre><BR>
472
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]473<a name="Chapter16"></a><h2>Advanced streaming functions</h2><pre></pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]474
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]475<h3>Advanced Streaming compression functions</h3><pre></pre><b><pre>ZSTD_CStream* ZSTD_createCStream_advanced(ZSTD_customMem customMem);
476size_t ZSTD_initCStream_srcSize(ZSTD_CStream* zcs, int compressionLevel, unsigned long long pledgedSrcSize); </b>/**< pledgedSrcSize must be correct, a size of 0 means unknown. for a frame size of 0 use initCStream_advanced */<b>
477size_t ZSTD_initCStream_usingDict(ZSTD_CStream* zcs, const void* dict, size_t dictSize, int compressionLevel); </b>/**< note: a dict will not be used if dict == NULL or dictSize < 8 */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]478size_t ZSTD_initCStream_advanced(ZSTD_CStream* zcs, const void* dict, size_t dictSize,
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]479 ZSTD_parameters params, unsigned long long pledgedSrcSize); </b>/**< pledgedSrcSize is optional and can be 0 (meaning unknown). note: if the contentSizeFlag is set, pledgedSrcSize == 0 means the source size is actually 0 */<b>
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]480size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDict* cdict); </b>/**< note : cdict will just be referenced, and must outlive compression session */<b>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]481size_t ZSTD_resetCStream(ZSTD_CStream* zcs, unsigned long long pledgedSrcSize); </b>/**< re-use compression parameters from previous init; skip dictionary loading stage; zcs must be init at least once before. note: pledgedSrcSize must be correct, a size of 0 means unknown. for a frame size of 0 use initCStream_advanced */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]482size_t ZSTD_sizeof_CStream(const ZSTD_CStream* zcs);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]483</pre></b><BR>
484<h3>Advanced Streaming decompression functions</h3><pre></pre><b><pre>typedef enum { DStream_p_maxWindowSize } ZSTD_DStreamParameter_e;
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]485ZSTD_DStream* ZSTD_createDStream_advanced(ZSTD_customMem customMem);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]486size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dict, size_t dictSize); </b>/**< note: a dict will not be used if dict == NULL or dictSize < 8 */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]487size_t ZSTD_setDStreamParameter(ZSTD_DStream* zds, ZSTD_DStreamParameter_e paramType, unsigned paramValue);
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]488size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* zds, const ZSTD_DDict* ddict); </b>/**< note : ddict will just be referenced, and must outlive decompression session */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]489size_t ZSTD_resetDStream(ZSTD_DStream* zds); </b>/**< re-use decompression parameters from previous init; saves dictionary loading */<b>
490size_t ZSTD_sizeof_DStream(const ZSTD_DStream* zds);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]491</pre></b><BR>
492<a name="Chapter17"></a><h2>Buffer-less and synchronous inner streaming functions</h2><pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]493 This is an advanced API, giving full control over buffer management, for users which need direct control over memory.
494 But it's also a complex one, with many restrictions (documented below).
Przemyslaw Skibinski1fd5b452016-10-31 10:44:44 +0100[diff] [blame]495 Prefer using normal streaming API for an easier experience
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]496
497<BR></pre>
498
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]499<a name="Chapter18"></a><h2>Buffer-less streaming compression (synchronous mode)</h2><pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]500 A ZSTD_CCtx object is required to track streaming operations.
501 Use ZSTD_createCCtx() / ZSTD_freeCCtx() to manage resource.
502 ZSTD_CCtx object can be re-used multiple times within successive compression operations.
503
504 Start by initializing a context.
505 Use ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression,
506 or ZSTD_compressBegin_advanced(), for finer parameter control.
507 It's also possible to duplicate a reference context which has already been initialized, using ZSTD_copyCCtx()
508
509 Then, consume your input using ZSTD_compressContinue().
510 There are some important considerations to keep in mind when using this advanced function :
511 - ZSTD_compressContinue() has no internal buffer. It uses externally provided buffer only.
512 - Interface is synchronous : input is consumed entirely and produce 1+ (or more) compressed blocks.
513 - Caller must ensure there is enough space in `dst` to store compressed data under worst case scenario.
514 Worst case evaluation is provided by ZSTD_compressBound().
515 ZSTD_compressContinue() doesn't guarantee recover after a failed compression.
516 - ZSTD_compressContinue() presumes prior input ***is still accessible and unmodified*** (up to maximum distance size, see WindowLog).
517 It remembers all previous contiguous blocks, plus one separated memory segment (which can itself consists of multiple contiguous blocks)
518 - ZSTD_compressContinue() detects that prior input has been overwritten when `src` buffer overlaps.
519 In which case, it will "discard" the relevant memory section from its history.
520
521 Finish a frame with ZSTD_compressEnd(), which will write the last block(s) and optional checksum.
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]522 It's possible to use srcSize==0, in which case, it will write a final empty block to end the frame.
523 Without last block mark, frames will be considered unfinished (corrupted) by decoders.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]524
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]525 `ZSTD_CCtx` object can be re-used (ZSTD_compressBegin()) to compress some new frame.
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]526<BR></pre>
527
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]528<h3>Buffer-less streaming compression functions</h3><pre></pre><b><pre>size_t ZSTD_compressBegin(ZSTD_CCtx* cctx, int compressionLevel);
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]529size_t ZSTD_compressBegin_usingDict(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, int compressionLevel);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]530size_t ZSTD_compressBegin_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_parameters params, unsigned long long pledgedSrcSize); </b>/**< pledgedSrcSize is optional and can be 0 (meaning unknown). note: if the contentSizeFlag is set, pledgedSrcSize == 0 means the source size is actually 0 */<b>
531size_t ZSTD_copyCCtx(ZSTD_CCtx* cctx, const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); </b>/**< note: if pledgedSrcSize can be 0, indicating unknown size. if it is non-zero, it must be accurate. for 0 size frames, use compressBegin_advanced */<b>
532size_t ZSTD_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict, unsigned long long pledgedSrcSize); </b>/**< note: if pledgedSrcSize can be 0, indicating unknown size. if it is non-zero, it must be accurate. for 0 size frames, use compressBegin_advanced */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]533size_t ZSTD_compressContinue(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
534size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]535</pre></b><BR>
536<a name="Chapter19"></a><h2>Buffer-less streaming decompression (synchronous mode)</h2><pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]537 A ZSTD_DCtx object is required to track streaming operations.
538 Use ZSTD_createDCtx() / ZSTD_freeDCtx() to manage it.
539 A ZSTD_DCtx object can be re-used multiple times.
540
541 First typical operation is to retrieve frame parameters, using ZSTD_getFrameParams().
542 It fills a ZSTD_frameParams structure which provide important information to correctly decode the frame,
543 such as the minimum rolling buffer size to allocate to decompress data (`windowSize`),
544 and the dictionary ID used.
545 (Note : content size is optional, it may not be present. 0 means : content size unknown).
546 Note that these values could be wrong, either because of data malformation, or because an attacker is spoofing deliberate false information.
547 As a consequence, check that values remain within valid application range, especially `windowSize`, before allocation.
548 Each application can set its own limit, depending on local restrictions. For extended interoperability, it is recommended to support at least 8 MB.
549 Frame parameters are extracted from the beginning of the compressed frame.
550 Data fragment must be large enough to ensure successful decoding, typically `ZSTD_frameHeaderSize_max` bytes.
551 @result : 0 : successful decoding, the `ZSTD_frameParams` structure is correctly filled.
552 >0 : `srcSize` is too small, please provide at least @result bytes on next attempt.
553 errorCode, which can be tested using ZSTD_isError().
554
555 Start decompression, with ZSTD_decompressBegin() or ZSTD_decompressBegin_usingDict().
556 Alternatively, you can copy a prepared context, using ZSTD_copyDCtx().
557
558 Then use ZSTD_nextSrcSizeToDecompress() and ZSTD_decompressContinue() alternatively.
559 ZSTD_nextSrcSizeToDecompress() tells how many bytes to provide as 'srcSize' to ZSTD_decompressContinue().
560 ZSTD_decompressContinue() requires this _exact_ amount of bytes, or it will fail.
561
562 @result of ZSTD_decompressContinue() is the number of bytes regenerated within 'dst' (necessarily <= dstCapacity).
563 It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some metadata item.
564 It can also be an error code, which can be tested with ZSTD_isError().
565
566 ZSTD_decompressContinue() needs previous data blocks during decompression, up to `windowSize`.
567 They should preferably be located contiguously, prior to current block.
568 Alternatively, a round buffer of sufficient size is also possible. Sufficient size is determined by frame parameters.
569 ZSTD_decompressContinue() is very sensitive to contiguity,
570 if 2 blocks don't follow each other, make sure that either the compressor breaks contiguity at the same place,
571 or that previous contiguous segment is large enough to properly handle maximum back-reference.
572
573 A frame is fully decoded when ZSTD_nextSrcSizeToDecompress() returns zero.
574 Context can then be reset to start a new decompression.
575
576 Note : it's possible to know if next input to present is a header or a block, using ZSTD_nextInputType().
577 This information is not required to properly decode a frame.
578
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]579 == Special case : skippable frames
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]580
581 Skippable frames allow integration of user-defined data into a flow of concatenated frames.
582 Skippable frames will be ignored (skipped) by a decompressor. The format of skippable frames is as follows :
583 a) Skippable frame ID - 4 Bytes, Little endian format, any value from 0x184D2A50 to 0x184D2A5F
584 b) Frame Size - 4 Bytes, Little endian format, unsigned 32-bits
585 c) Frame Content - any content (User Data) of length equal to Frame Size
586 For skippable frames ZSTD_decompressContinue() always returns 0.
587 For skippable frames ZSTD_getFrameParams() returns fparamsPtr->windowLog==0 what means that a frame is skippable.
588 It also returns Frame Size as fparamsPtr->frameContentSize.
589<BR></pre>
590
591<pre><b>typedef struct {
592 unsigned long long frameContentSize;
593 unsigned windowSize;
594 unsigned dictID;
595 unsigned checksumFlag;
596} ZSTD_frameParams;
597</b></pre><BR>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]598<h3>Buffer-less streaming decompression functions</h3><pre></pre><b><pre>size_t ZSTD_getFrameParams(ZSTD_frameParams* fparamsPtr, const void* src, size_t srcSize); </b>/**< doesn't consume input, see details below */<b>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]599size_t ZSTD_decompressBegin(ZSTD_DCtx* dctx);
600size_t ZSTD_decompressBegin_usingDict(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
601void ZSTD_copyDCtx(ZSTD_DCtx* dctx, const ZSTD_DCtx* preparedDCtx);
602size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx);
603size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
604typedef enum { ZSTDnit_frameHeader, ZSTDnit_blockHeader, ZSTDnit_block, ZSTDnit_lastBlock, ZSTDnit_checksum, ZSTDnit_skippableFrame } ZSTD_nextInputType_e;
605ZSTD_nextInputType_e ZSTD_nextInputType(ZSTD_DCtx* dctx);
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]606</pre></b><BR>
607<a name="Chapter20"></a><h2>Block functions</h2><pre>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]608 Block functions produce and decode raw zstd blocks, without frame metadata.
609 Frame metadata cost is typically ~18 bytes, which can be non-negligible for very small blocks (< 100 bytes).
610 User will have to take in charge required information to regenerate data, such as compressed and content sizes.
611
612 A few rules to respect :
613 - Compressing and decompressing require a context structure
614 + Use ZSTD_createCCtx() and ZSTD_createDCtx()
615 - It is necessary to init context before starting
616 + compression : ZSTD_compressBegin()
617 + decompression : ZSTD_decompressBegin()
618 + variants _usingDict() are also allowed
619 + copyCCtx() and copyDCtx() work too
620 - Block size is limited, it must be <= ZSTD_getBlockSizeMax()
621 + If you need to compress more, cut data into multiple blocks
622 + Consider using the regular ZSTD_compress() instead, as frame metadata costs become negligible when source size is large.
623 - When a block is considered not compressible enough, ZSTD_compressBlock() result will be zero.
624 In which case, nothing is produced into `dst`.
625 + User must test for such outcome and deal directly with uncompressed data
626 + ZSTD_decompressBlock() doesn't accept uncompressed data as input !!!
627 + In case of multiple successive blocks, decoder must be informed of uncompressed block existence to follow proper history.
628 Use ZSTD_insertBlock() in such a case.
629<BR></pre>
630
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]631<h3>Raw zstd block functions</h3><pre></pre><b><pre>size_t ZSTD_getBlockSizeMax(ZSTD_CCtx* cctx);
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]632size_t ZSTD_compressBlock (ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
633size_t ZSTD_decompressBlock(ZSTD_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
634size_t ZSTD_insertBlock(ZSTD_DCtx* dctx, const void* blockStart, size_t blockSize); </b>/**< insert block into `dctx` history. Useful for uncompressed blocks */<b>
Yann Collet77575772017-02-22 01:10:43 -0800[diff] [blame^]635</pre></b><BR>
Przemyslaw Skibinski86d94242016-10-24 16:07:53 +0200[diff] [blame]636</html>
637</body>