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