Lines Matching full:pre
36 <a name="Chapter1"></a><h2>Introduction</h2><pre>
65 <BR></pre>
67 <a name="Chapter2"></a><h2>Version</h2><pre></pre>
69 <pre><b>unsigned ZSTD_versionNumber(void);
71 </p></pre><BR>
73 <pre><b>const char* ZSTD_versionString(void);
75 </p></pre><BR>
77 <a name="Chapter3"></a><h2>Simple API</h2><pre></pre>
79 <pre><b>size_t ZSTD_compress( void* dst, size_t dstCapacity,
86 </p></pre><BR>
88 <pre><b>size_t ZSTD_decompress( void* dst, size_t dstCapacity,
95 </p></pre><BR>
97 <pre><b>#define ZSTD_CONTENTSIZE_UNKNOWN (0ULL - 1)
122 </p></pre><BR>
124 <pre><b>unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize);
130 </p></pre><BR>
132 <pre><b>size_t ZSTD_findFrameCompressedSize(const void* src, size_t srcSize);
138 </p></pre><BR>
140 <h3>Helper functions</h3><pre></pre><b><pre>#define ZSTD_COMPRESSBOUND(srcSize) ((srcSize) + ((sr…
147 </pre></b><BR>
148 <a name="Chapter4"></a><h2>Explicit context</h2><pre></pre>
150 <h3>Compression context</h3><pre> When compressing many times,
159 </pre><b><pre>typedef struct ZSTD_CCtx_s ZSTD_CCtx;
162 </pre></b><BR>
163 <pre><b>size_t ZSTD_compressCCtx(ZSTD_CCtx* cctx,
174 </p></pre><BR>
176 <h3>Decompression context</h3><pre> When decompressing many times,
181 </pre><b><pre>typedef struct ZSTD_DCtx_s ZSTD_DCtx;
184 </pre></b><BR>
185 <pre><b>size_t ZSTD_decompressDCtx(ZSTD_DCtx* dctx,
192 </p></pre><BR>
194 <a name="Chapter5"></a><h2>Advanced compression API (Requires v1.4.0+)</h2><pre></pre>
196 <pre><b>typedef enum { ZSTD_fast=1,
208 </b></pre><BR>
209 <pre><b>typedef enum {
215 …ZSTD_c_compressionLevel=100, </b>/* Set compression parameters according to pre-defined cLevel tab…
382 </b></pre><BR>
383 <pre><b>typedef struct {
388 </b></pre><BR>
389 <pre><b>ZSTD_bounds ZSTD_cParam_getBounds(ZSTD_cParameter cParam);
396 </p></pre><BR>
398 <pre><b>size_t ZSTD_CCtx_setParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param, int value);
409 </p></pre><BR>
411 <pre><b>size_t ZSTD_CCtx_setPledgedSrcSize(ZSTD_CCtx* cctx, unsigned long long pledgedSrcSize);
426 </p></pre><BR>
428 <pre><b>typedef enum {
433 </b></pre><BR>
434 <pre><b>size_t ZSTD_CCtx_reset(ZSTD_CCtx* cctx, ZSTD_ResetDirective reset);
448 </p></pre><BR>
450 <pre><b>size_t ZSTD_compress2( ZSTD_CCtx* cctx,
462 </p></pre><BR>
464 <a name="Chapter6"></a><h2>Advanced decompression API (Requires v1.4.0+)</h2><pre></pre>
466 <pre><b>typedef enum {
491 </b></pre><BR>
492 <pre><b>ZSTD_bounds ZSTD_dParam_getBounds(ZSTD_dParameter dParam);
499 </p></pre><BR>
501 <pre><b>size_t ZSTD_DCtx_setParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, int value);
508 </p></pre><BR>
510 <pre><b>size_t ZSTD_DCtx_reset(ZSTD_DCtx* dctx, ZSTD_ResetDirective reset);
516 </p></pre><BR>
518 <a name="Chapter7"></a><h2>Streaming</h2><pre></pre>
520 <pre><b>typedef struct ZSTD_inBuffer_s {
525 </b></pre><BR>
526 <pre><b>typedef struct ZSTD_outBuffer_s {
531 </b></pre><BR>
532 <a name="Chapter8"></a><h2>Streaming compression - HowTo</h2><pre>
590 <BR></pre>
592 <pre><b>typedef ZSTD_CCtx ZSTD_CStream; </b>/**< CCtx and CStream are now effectively same object …
593 </b></pre><BR>
594 <h3>ZSTD_CStream management functions</h3><pre></pre><b><pre>ZSTD_CStream* ZSTD_createCStream(void);
596 </pre></b><BR>
597 <h3>Streaming compression functions</h3><pre></pre><b><pre>typedef enum {
609 </pre></b><BR>
610 <pre><b>size_t ZSTD_compressStream2( ZSTD_CCtx* cctx,
635 </p></pre><BR>
637 <pre><b>size_t ZSTD_CStreamInSize(void); </b>/**< recommended size for input buffer */<b>
638 </b></pre><BR>
639 <pre><b>size_t ZSTD_CStreamOutSize(void); </b>/**< recommended size for output buffer. Guarantee …
640 </b></pre><BR>
641 <pre><b>size_t ZSTD_initCStream(ZSTD_CStream* zcs, int compressionLevel);
658 </p></pre><BR>
660 <a name="Chapter9"></a><h2>Streaming decompression - HowTo</h2><pre>
684 <BR></pre>
686 <pre><b>typedef ZSTD_DCtx ZSTD_DStream; </b>/**< DCtx and DStream are now effectively same object …
687 </b></pre><BR>
688 <h3>ZSTD_DStream management functions</h3><pre></pre><b><pre>ZSTD_DStream* ZSTD_createDStream(void);
690 </pre></b><BR>
691 <h3>Streaming decompression functions</h3><pre></pre><b><pre></pre></b><BR>
692 <pre><b>size_t ZSTD_DStreamInSize(void); </b>/*!< recommended size for input buffer */<b>
693 </b></pre><BR>
694 <pre><b>size_t ZSTD_DStreamOutSize(void); </b>/*!< recommended size for output buffer. Guarantee …
695 </b></pre><BR>
696 <a name="Chapter10"></a><h2>Simple dictionary API</h2><pre></pre>
698 <pre><b>size_t ZSTD_compress_usingDict(ZSTD_CCtx* ctx,
709 </p></pre><BR>
711 <pre><b>size_t ZSTD_decompress_usingDict(ZSTD_DCtx* dctx,
720 </p></pre><BR>
722 <a name="Chapter11"></a><h2>Bulk processing dictionary API</h2><pre></pre>
724 <pre><b>ZSTD_CDict* ZSTD_createCDict(const void* dictBuffer, size_t dictSize,
737 </p></pre><BR>
739 <pre><b>size_t ZSTD_freeCDict(ZSTD_CDict* CDict);
742 </p></pre><BR>
744 <pre><b>size_t ZSTD_compress_usingCDict(ZSTD_CCtx* cctx,
752 </p></pre><BR>
754 <pre><b>ZSTD_DDict* ZSTD_createDDict(const void* dictBuffer, size_t dictSize);
757 </p></pre><BR>
759 <pre><b>size_t ZSTD_freeDDict(ZSTD_DDict* ddict);
762 </p></pre><BR>
764 <pre><b>size_t ZSTD_decompress_usingDDict(ZSTD_DCtx* dctx,
770 </p></pre><BR>
772 <a name="Chapter12"></a><h2>Dictionary helper functions</h2><pre></pre>
774 <pre><b>unsigned ZSTD_getDictID_fromDict(const void* dict, size_t dictSize);
778 </p></pre><BR>
780 <pre><b>unsigned ZSTD_getDictID_fromCDict(const ZSTD_CDict* cdict);
784 </p></pre><BR>
786 <pre><b>unsigned ZSTD_getDictID_fromDDict(const ZSTD_DDict* ddict);
790 </p></pre><BR>
792 <pre><b>unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
802 </p></pre><BR>
804 <a name="Chapter13"></a><h2>Advanced dictionary and prefix API (Requires v1.4.0+)</h2><pre>
809 <BR></pre>
811 <pre><b>size_t ZSTD_CCtx_loadDictionary(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
828 </p></pre><BR>
830 <pre><b>size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);
842 </p></pre><BR>
844 <pre><b>size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx,
863 </p></pre><BR>
865 <pre><b>size_t ZSTD_DCtx_loadDictionary(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
880 </p></pre><BR>
882 <pre><b>size_t ZSTD_DCtx_refDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
898 </p></pre><BR>
900 <pre><b>size_t ZSTD_DCtx_refPrefix(ZSTD_DCtx* dctx,
917 </p></pre><BR>
919 <pre><b>size_t ZSTD_sizeof_CCtx(const ZSTD_CCtx* cctx);
927 </p></pre><BR>
929 <a name="Chapter14"></a><h2>experimental API (static linking only)</h2><pre>
936 <BR></pre>
938 <pre><b>typedef struct {
974 </b></pre><BR>
975 <pre><b>typedef struct {
984 </b></pre><BR>
985 <pre><b>typedef struct {
990 </b></pre><BR>
991 <pre><b>typedef struct {
995 </b></pre><BR>
996 <pre><b>typedef enum {
1001 </b></pre><BR>
1002 <pre><b>typedef enum {
1006 </b></pre><BR>
1007 <pre><b>typedef enum {
1013 </b></pre><BR>
1014 <pre><b>typedef enum {
1019 </b></pre><BR>
1020 <pre><b>typedef enum {
1025 </b></pre><BR>
1026 <pre><b>typedef enum {
1064 </b></pre><BR>
1065 <pre><b>typedef enum {
1073 </b></pre><BR>
1074 <pre><b>typedef enum {
1083 </b></pre><BR>
1084 <a name="Chapter15"></a><h2>Frame size functions</h2><pre></pre>
1086 <pre><b>ZSTDLIB_STATIC_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t src…
1107 </p></pre><BR>
1109 <pre><b>ZSTDLIB_STATIC_API unsigned long long ZSTD_decompressBound(const void* src, size_t srcSize);
1122 </p></pre><BR>
1124 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_frameHeaderSize(const void* src, size_t srcSize);
1128 </p></pre><BR>
1130 <pre><b>typedef enum {
1134 </b></pre><BR>
1135 <pre><b></b><p> Generate sequences using ZSTD_compress2, given a source buffer.
1149 </p></pre><BR>
1151 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_mergeBlockDelimiters(ZSTD_Sequence* sequences, size_t seqsSi…
1162 </p></pre><BR>
1164 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size_t d…
1194 </p></pre><BR>
1196 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_writeSkippableFrame(void* dst, size_t dstCapacity,
1210 </p></pre><BR>
1212 <pre><b>size_t ZSTD_readSkippableFrame(void* dst, size_t dstCapacity, unsigned* magicVariant,
1224 </p></pre><BR>
1226 <pre><b>unsigned ZSTD_isSkippableFrame(const void* buffer, size_t size);
1229 </p></pre><BR>
1231 <a name="Chapter16"></a><h2>Memory management</h2><pre></pre>
1233 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_estimateCCtxSize(int compressionLevel);
1259 </p></pre><BR>
1261 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_estimateCStreamSize(int compressionLevel);
1278 </p></pre><BR>
1280 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_estimateCDictSize(size_t dictSize, int compressionLevel);
1287 </p></pre><BR>
1289 <pre><b>ZSTDLIB_STATIC_API ZSTD_CCtx* ZSTD_initStaticCCtx(void* workspace, size_t workspaceSize);
1291 </b><p> Initialize an object using a pre-allocated fixed-size buffer.
1311 </p></pre><BR>
1313 <pre><b>ZSTDLIB_STATIC_API ZSTD_DStream* ZSTD_initStaticDStream(void* workspace, size_t workspaceSi…
1314 </b></pre><BR>
1315 <pre><b>typedef void* (*ZSTD_allocFunction) (void* opaque, size_t size);
1327 </p></pre><BR>
1329 <pre><b>typedef struct POOL_ctx_s ZSTD_threadPool;
1342 </p></pre><BR>
1344 <a name="Chapter17"></a><h2>Advanced compression functions</h2><pre></pre>
1346 <pre><b>ZSTDLIB_STATIC_API ZSTD_CDict* ZSTD_createCDict_byReference(const void* dictBuffer, size_t …
1352 </p></pre><BR>
1354 <pre><b>ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_getCParams(int compressionLevel, unsigne…
1357 </p></pre><BR>
1359 <pre><b>ZSTDLIB_STATIC_API ZSTD_parameters ZSTD_getParams(int compressionLevel, unsigned long long …
1362 </p></pre><BR>
1364 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
1367 </p></pre><BR>
1369 <pre><b>ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParameters…
1375 </p></pre><BR>
1377 <pre><b>ZSTD_DEPRECATED("use ZSTD_compress2")
1386 </p></pre><BR>
1388 <pre><b>ZSTD_DEPRECATED("use ZSTD_compress2 with ZSTD_CCtx_loadDictionary")
1397 </p></pre><BR>
1399 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtx_loadDictionary_byReference(ZSTD_CCtx* cctx, const void*…
1402 </p></pre><BR>
1404 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtx_loadDictionary_advanced(ZSTD_CCtx* cctx, const void* di…
1408 </p></pre><BR>
1410 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* prefix,…
1413 </p></pre><BR>
1415 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtx_getParameter(const ZSTD_CCtx* cctx, ZSTD_cParameter par…
1420 </p></pre><BR>
1422 <pre><b>ZSTDLIB_STATIC_API ZSTD_CCtx_params* ZSTD_createCCtxParams(void);
1440 </p></pre><BR>
1442 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_reset(ZSTD_CCtx_params* params);
1445 </p></pre><BR>
1447 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_init(ZSTD_CCtx_params* cctxParams, int compressio…
1451 </p></pre><BR>
1453 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, ZSTD_…
1457 </p></pre><BR>
1459 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_setParameter(ZSTD_CCtx_params* params, ZSTD_cPara…
1467 </p></pre><BR>
1469 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtxParams_getParameter(const ZSTD_CCtx_params* params, ZSTD…
1474 </p></pre><BR>
1476 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setParametersUsingCCtxParams(
1484 </p></pre><BR>
1486 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_compressStream2_simpleArgs (
1496 </p></pre><BR>
1498 <a name="Chapter18"></a><h2>Advanced decompression functions</h2><pre></pre>
1500 <pre><b>ZSTDLIB_STATIC_API unsigned ZSTD_isFrame(const void* buffer, size_t size);
1505 </p></pre><BR>
1507 <pre><b>ZSTDLIB_STATIC_API ZSTD_DDict* ZSTD_createDDict_byReference(const void* dictBuffer, size_t …
1512 </p></pre><BR>
1514 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_DCtx_loadDictionary_byReference(ZSTD_DCtx* dctx, const void*…
1519 </p></pre><BR>
1521 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_DCtx_loadDictionary_advanced(ZSTD_DCtx* dctx, const void* di…
1526 </p></pre><BR>
1528 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_DCtx_refPrefix_advanced(ZSTD_DCtx* dctx, const void* prefix,…
1531 </p></pre><BR>
1533 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_DCtx_setMaxWindowSize(ZSTD_DCtx* dctx, size_t maxWindowSize);
1540 </p></pre><BR>
1542 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param, in…
1547 </p></pre><BR>
1549 <pre><b>ZSTD_DEPRECATED("use ZSTD_DCtx_setParameter() instead")
1556 </p></pre><BR>
1558 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_decompressStream_simpleArgs (
1567 </p></pre><BR>
1569 <a name="Chapter19"></a><h2>Advanced streaming functions</h2><pre> Warning : most of these functio…
1572 <BR></pre>
1574 <h3>Advanced Streaming compression functions</h3><pre></pre><b><pre></pre></b><BR>
1575 <pre><b>ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
1590 </p></pre><BR>
1592 <pre><b>ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
1607 </p></pre><BR>
1609 <pre><b>ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
1628 </p></pre><BR>
1630 <pre><b>ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instru…
1639 </p></pre><BR>
1641 <pre><b>ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instru…
1660 </p></pre><BR>
1662 <pre><b>ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
1681 </p></pre><BR>
1683 <pre><b>typedef struct {
1691 </b></pre><BR>
1692 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_toFlushNow(ZSTD_CCtx* cctx);
1705 </p></pre><BR>
1707 <h3>Advanced Streaming decompression functions</h3><pre></pre><b><pre></pre></b><BR>
1708 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_initDStream_usingDict(ZSTD_DStream* zds, const void* dict, s…
1716 </p></pre><BR>
1718 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_initDStream_usingDDict(ZSTD_DStream* zds, const ZSTD_DDict* …
1726 </p></pre><BR>
1728 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
1735 </p></pre><BR>
1737 <a name="Chapter20"></a><h2>Buffer-less and synchronous inner streaming functions</h2><pre>
1742 <BR></pre>
1744 <a name="Chapter21"></a><h2>Buffer-less streaming compression (synchronous mode)</h2><pre>
1770 <BR></pre>
1772 <h3>Buffer-less streaming compression functions</h3><pre></pre><b><pre>ZSTDLIB_STATIC_API size_t ZS…
1776 </pre></b><BR>
1777 <pre><b>size_t ZSTD_compressBegin_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD…
1778 </b></pre><BR>
1779 <a name="Chapter22"></a><h2>Buffer-less streaming decompression (synchronous mode)</h2><pre>
1848 <BR></pre>
1850 <h3>Buffer-less streaming decompression functions</h3><pre></pre><b><pre>typedef enum { ZSTD_frame,…
1860 </pre></b><BR>
1861 <pre><b>ZSTDLIB_STATIC_API size_t ZSTD_getFrameHeader(ZSTD_frameHeader* zfhPtr, const void* src, si…
1871 </p></pre><BR>
1873 <pre><b>typedef enum { ZSTDnit_frameHeader, ZSTDnit_blockHeader, ZSTDnit_block, ZSTDnit_lastBlock, …
1874 </b></pre><BR>
1875 <a name="Chapter23"></a><h2>Block level API</h2><pre></pre>
1877 <pre><b></b><p> Frame metadata cost is typically ~12 bytes, which can be non-negligible for very…
1900 </p></pre><BR>
1902 <h3>Raw zstd block functions</h3><pre></pre><b><pre>ZSTDLIB_STATIC_API size_t ZSTD_getBlockSize (…
1906 </pre></b><BR>