|
@@ -1,5 +1,5 @@
|
|
|
/*
|
|
|
- * Copyright (c) 2016-2020, Yann Collet, Facebook, Inc.
|
|
|
+ * Copyright (c) Yann Collet, Facebook, Inc.
|
|
|
* All rights reserved.
|
|
|
*
|
|
|
* This source code is licensed under both the BSD-style license (found in the
|
|
@@ -71,8 +71,8 @@ extern "C" {
|
|
|
|
|
|
/*------ Version ------*/
|
|
|
#define ZSTD_VERSION_MAJOR 1
|
|
|
-#define ZSTD_VERSION_MINOR 4
|
|
|
-#define ZSTD_VERSION_RELEASE 8
|
|
|
+#define ZSTD_VERSION_MINOR 5
|
|
|
+#define ZSTD_VERSION_RELEASE 0
|
|
|
#define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
|
|
|
|
|
|
/*! ZSTD_versionNumber() :
|
|
@@ -109,7 +109,6 @@ ZSTDLIB_API const char* ZSTD_versionString(void);
|
|
|
#define ZSTD_BLOCKSIZE_MAX (1<<ZSTD_BLOCKSIZELOG_MAX)
|
|
|
|
|
|
|
|
|
-
|
|
|
/***************************************
|
|
|
* Simple API
|
|
|
***************************************/
|
|
@@ -166,7 +165,7 @@ ZSTDLIB_API unsigned long long ZSTD_getFrameContentSize(const void *src, size_t
|
|
|
* @return : decompressed size of `src` frame content _if known and not empty_, 0 otherwise. */
|
|
|
ZSTDLIB_API unsigned long long ZSTD_getDecompressedSize(const void* src, size_t srcSize);
|
|
|
|
|
|
-/*! ZSTD_findFrameCompressedSize() :
|
|
|
+/*! ZSTD_findFrameCompressedSize() : Requires v1.4.0+
|
|
|
* `src` should point to the start of a ZSTD frame or skippable frame.
|
|
|
* `srcSize` must be >= first frame size
|
|
|
* @return : the compressed size of the first frame starting at `src`,
|
|
@@ -180,8 +179,9 @@ ZSTDLIB_API size_t ZSTD_findFrameCompressedSize(const void* src, size_t srcSize)
|
|
|
ZSTDLIB_API size_t ZSTD_compressBound(size_t srcSize); /*!< maximum compressed size in worst case single-pass scenario */
|
|
|
ZSTDLIB_API unsigned ZSTD_isError(size_t code); /*!< tells if a `size_t` function result is an error code */
|
|
|
ZSTDLIB_API const char* ZSTD_getErrorName(size_t code); /*!< provides readable string from an error code */
|
|
|
-ZSTDLIB_API int ZSTD_minCLevel(void); /*!< minimum negative compression level allowed */
|
|
|
+ZSTDLIB_API int ZSTD_minCLevel(void); /*!< minimum negative compression level allowed, requires v1.4.0+ */
|
|
|
ZSTDLIB_API int ZSTD_maxCLevel(void); /*!< maximum compression level available */
|
|
|
+ZSTDLIB_API int ZSTD_defaultCLevel(void); /*!< default compression level, specified by ZSTD_CLEVEL_DEFAULT, requires v1.5.0+ */
|
|
|
|
|
|
|
|
|
/***************************************
|
|
@@ -199,7 +199,7 @@ ZSTDLIB_API int ZSTD_maxCLevel(void); /*!< maximum compres
|
|
|
*/
|
|
|
typedef struct ZSTD_CCtx_s ZSTD_CCtx;
|
|
|
ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
|
|
|
-ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
|
|
|
+ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx); /* accept NULL pointer */
|
|
|
|
|
|
/*! ZSTD_compressCCtx() :
|
|
|
* Same as ZSTD_compress(), using an explicit ZSTD_CCtx.
|
|
@@ -222,7 +222,7 @@ ZSTDLIB_API size_t ZSTD_compressCCtx(ZSTD_CCtx* cctx,
|
|
|
* Use one context per thread for parallel execution. */
|
|
|
typedef struct ZSTD_DCtx_s ZSTD_DCtx;
|
|
|
ZSTDLIB_API ZSTD_DCtx* ZSTD_createDCtx(void);
|
|
|
-ZSTDLIB_API size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx);
|
|
|
+ZSTDLIB_API size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx); /* accept NULL pointer */
|
|
|
|
|
|
/*! ZSTD_decompressDCtx() :
|
|
|
* Same as ZSTD_decompress(),
|
|
@@ -234,9 +234,9 @@ ZSTDLIB_API size_t ZSTD_decompressDCtx(ZSTD_DCtx* dctx,
|
|
|
const void* src, size_t srcSize);
|
|
|
|
|
|
|
|
|
-/***************************************
|
|
|
-* Advanced compression API
|
|
|
-***************************************/
|
|
|
+/*********************************************
|
|
|
+* Advanced compression API (Requires v1.4.0+)
|
|
|
+**********************************************/
|
|
|
|
|
|
/* API design :
|
|
|
* Parameters are pushed one by one into an existing context,
|
|
@@ -266,7 +266,6 @@ typedef enum { ZSTD_fast=1,
|
|
|
Only the order (from fast to strong) is guaranteed */
|
|
|
} ZSTD_strategy;
|
|
|
|
|
|
-
|
|
|
typedef enum {
|
|
|
|
|
|
/* compression parameters
|
|
@@ -332,7 +331,6 @@ typedef enum {
|
|
|
* The higher the value of selected strategy, the more complex it is,
|
|
|
* resulting in stronger and slower compression.
|
|
|
* Special: value 0 means "use default strategy". */
|
|
|
-
|
|
|
/* LDM mode parameters */
|
|
|
ZSTD_c_enableLongDistanceMatching=160, /* Enable long distance matching.
|
|
|
* This parameter is designed to improve compression ratio
|
|
@@ -389,7 +387,7 @@ typedef enum {
|
|
|
ZSTD_c_jobSize=401, /* Size of a compression job. This value is enforced only when nbWorkers >= 1.
|
|
|
* Each compression job is completed in parallel, so this value can indirectly impact the nb of active threads.
|
|
|
* 0 means default, which is dynamically determined based on compression parameters.
|
|
|
- * Job size must be a minimum of overlap size, or 1 MB, whichever is largest.
|
|
|
+ * Job size must be a minimum of overlap size, or ZSTDMT_JOBSIZE_MIN (= 512 KB), whichever is largest.
|
|
|
* The minimum size is automatically and transparently enforced. */
|
|
|
ZSTD_c_overlapLog=402, /* Control the overlap size, as a fraction of window size.
|
|
|
* The overlap size is an amount of data reloaded from previous job at the beginning of a new job.
|
|
@@ -419,6 +417,8 @@ typedef enum {
|
|
|
* ZSTD_c_stableOutBuffer
|
|
|
* ZSTD_c_blockDelimiters
|
|
|
* ZSTD_c_validateSequences
|
|
|
+ * ZSTD_c_splitBlocks
|
|
|
+ * ZSTD_c_useRowMatchFinder
|
|
|
* Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
|
|
|
* note : never ever use experimentalParam? names directly;
|
|
|
* also, the enums values themselves are unstable and can still change.
|
|
@@ -434,7 +434,10 @@ typedef enum {
|
|
|
ZSTD_c_experimentalParam9=1006,
|
|
|
ZSTD_c_experimentalParam10=1007,
|
|
|
ZSTD_c_experimentalParam11=1008,
|
|
|
- ZSTD_c_experimentalParam12=1009
|
|
|
+ ZSTD_c_experimentalParam12=1009,
|
|
|
+ ZSTD_c_experimentalParam13=1010,
|
|
|
+ ZSTD_c_experimentalParam14=1011,
|
|
|
+ ZSTD_c_experimentalParam15=1012
|
|
|
} ZSTD_cParameter;
|
|
|
|
|
|
typedef struct {
|
|
@@ -519,9 +522,9 @@ ZSTDLIB_API size_t ZSTD_compress2( ZSTD_CCtx* cctx,
|
|
|
const void* src, size_t srcSize);
|
|
|
|
|
|
|
|
|
-/***************************************
|
|
|
-* Advanced decompression API
|
|
|
-***************************************/
|
|
|
+/***********************************************
|
|
|
+* Advanced decompression API (Requires v1.4.0+)
|
|
|
+************************************************/
|
|
|
|
|
|
/* The advanced API pushes parameters one by one into an existing DCtx context.
|
|
|
* Parameters are sticky, and remain valid for all following frames
|
|
@@ -546,12 +549,14 @@ typedef enum {
|
|
|
* ZSTD_d_format
|
|
|
* ZSTD_d_stableOutBuffer
|
|
|
* ZSTD_d_forceIgnoreChecksum
|
|
|
+ * ZSTD_d_refMultipleDDicts
|
|
|
* Because they are not stable, it's necessary to define ZSTD_STATIC_LINKING_ONLY to access them.
|
|
|
* note : never ever use experimentalParam? names directly
|
|
|
*/
|
|
|
ZSTD_d_experimentalParam1=1000,
|
|
|
ZSTD_d_experimentalParam2=1001,
|
|
|
- ZSTD_d_experimentalParam3=1002
|
|
|
+ ZSTD_d_experimentalParam3=1002,
|
|
|
+ ZSTD_d_experimentalParam4=1003
|
|
|
|
|
|
} ZSTD_dParameter;
|
|
|
|
|
@@ -665,7 +670,7 @@ typedef ZSTD_CCtx ZSTD_CStream; /**< CCtx and CStream are now effectively same
|
|
|
/* Continue to distinguish them for compatibility with older versions <= v1.2.0 */
|
|
|
/*===== ZSTD_CStream management functions =====*/
|
|
|
ZSTDLIB_API ZSTD_CStream* ZSTD_createCStream(void);
|
|
|
-ZSTDLIB_API size_t ZSTD_freeCStream(ZSTD_CStream* zcs);
|
|
|
+ZSTDLIB_API size_t ZSTD_freeCStream(ZSTD_CStream* zcs); /* accept NULL pointer */
|
|
|
|
|
|
/*===== Streaming compression functions =====*/
|
|
|
typedef enum {
|
|
@@ -681,7 +686,7 @@ typedef enum {
|
|
|
: note : multithreaded compression will block to flush as much output as possible. */
|
|
|
} ZSTD_EndDirective;
|
|
|
|
|
|
-/*! ZSTD_compressStream2() :
|
|
|
+/*! ZSTD_compressStream2() : Requires v1.4.0+
|
|
|
* Behaves about the same as ZSTD_compressStream, with additional control on end directive.
|
|
|
* - Compression parameters are pushed into CCtx before starting compression, using ZSTD_CCtx_set*()
|
|
|
* - Compression parameters cannot be changed once compression is started (save a list of exceptions in multi-threading mode)
|
|
@@ -727,11 +732,11 @@ ZSTDLIB_API size_t ZSTD_CStreamOutSize(void); /**< recommended size for output
|
|
|
|
|
|
|
|
|
/* *****************************************************************************
|
|
|
- * This following is a legacy streaming API.
|
|
|
+ * This following is a legacy streaming API, available since v1.0+ .
|
|
|
* It can be replaced by ZSTD_CCtx_reset() and ZSTD_compressStream2().
|
|
|
* It is redundant, but remains fully supported.
|
|
|
- * Advanced parameters and dictionary compression can only be used through the
|
|
|
- * new API.
|
|
|
+ * Streaming in combination with advanced parameters and dictionary compression
|
|
|
+ * can only be used through the new API.
|
|
|
******************************************************************************/
|
|
|
|
|
|
/*!
|
|
@@ -786,7 +791,7 @@ typedef ZSTD_DCtx ZSTD_DStream; /**< DCtx and DStream are now effectively same
|
|
|
/* For compatibility with versions <= v1.2.0, prefer differentiating them. */
|
|
|
/*===== ZSTD_DStream management functions =====*/
|
|
|
ZSTDLIB_API ZSTD_DStream* ZSTD_createDStream(void);
|
|
|
-ZSTDLIB_API size_t ZSTD_freeDStream(ZSTD_DStream* zds);
|
|
|
+ZSTDLIB_API size_t ZSTD_freeDStream(ZSTD_DStream* zds); /* accept NULL pointer */
|
|
|
|
|
|
/*===== Streaming decompression functions =====*/
|
|
|
|
|
@@ -809,7 +814,7 @@ ZSTDLIB_API size_t ZSTD_DStreamOutSize(void); /*!< recommended size for output
|
|
|
/*! ZSTD_compress_usingDict() :
|
|
|
* Compression at an explicit compression level using a Dictionary.
|
|
|
* A dictionary can be any arbitrary data segment (also called a prefix),
|
|
|
- * or a buffer with specified information (see dictBuilder/zdict.h).
|
|
|
+ * or a buffer with specified information (see zdict.h).
|
|
|
* Note : This function loads the dictionary, resulting in significant startup delay.
|
|
|
* It's intended for a dictionary used only once.
|
|
|
* Note 2 : When `dict == NULL || dictSize < 8` no dictionary is used. */
|
|
@@ -852,7 +857,8 @@ ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict(const void* dictBuffer, size_t dictSize
|
|
|
int compressionLevel);
|
|
|
|
|
|
/*! ZSTD_freeCDict() :
|
|
|
- * Function frees memory allocated by ZSTD_createCDict(). */
|
|
|
+ * Function frees memory allocated by ZSTD_createCDict().
|
|
|
+ * If a NULL pointer is passed, no operation is performed. */
|
|
|
ZSTDLIB_API size_t ZSTD_freeCDict(ZSTD_CDict* CDict);
|
|
|
|
|
|
/*! ZSTD_compress_usingCDict() :
|
|
@@ -874,7 +880,8 @@ typedef struct ZSTD_DDict_s ZSTD_DDict;
|
|
|
ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict(const void* dictBuffer, size_t dictSize);
|
|
|
|
|
|
/*! ZSTD_freeDDict() :
|
|
|
- * Function frees memory allocated with ZSTD_createDDict() */
|
|
|
+ * Function frees memory allocated with ZSTD_createDDict()
|
|
|
+ * If a NULL pointer is passed, no operation is performed. */
|
|
|
ZSTDLIB_API size_t ZSTD_freeDDict(ZSTD_DDict* ddict);
|
|
|
|
|
|
/*! ZSTD_decompress_usingDDict() :
|
|
@@ -890,19 +897,25 @@ ZSTDLIB_API size_t ZSTD_decompress_usingDDict(ZSTD_DCtx* dctx,
|
|
|
* Dictionary helper functions
|
|
|
*******************************/
|
|
|
|
|
|
-/*! ZSTD_getDictID_fromDict() :
|
|
|
+/*! ZSTD_getDictID_fromDict() : Requires v1.4.0+
|
|
|
* Provides the dictID stored within dictionary.
|
|
|
* if @return == 0, the dictionary is not conformant with Zstandard specification.
|
|
|
* It can still be loaded, but as a content-only dictionary. */
|
|
|
ZSTDLIB_API unsigned ZSTD_getDictID_fromDict(const void* dict, size_t dictSize);
|
|
|
|
|
|
-/*! ZSTD_getDictID_fromDDict() :
|
|
|
+/*! ZSTD_getDictID_fromCDict() : Requires v1.5.0+
|
|
|
+ * Provides the dictID of the dictionary loaded into `cdict`.
|
|
|
+ * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
|
|
|
+ * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
|
|
|
+ZSTDLIB_API unsigned ZSTD_getDictID_fromCDict(const ZSTD_CDict* cdict);
|
|
|
+
|
|
|
+/*! ZSTD_getDictID_fromDDict() : Requires v1.4.0+
|
|
|
* Provides the dictID of the dictionary loaded into `ddict`.
|
|
|
* If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
|
|
|
* Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
|
|
|
ZSTDLIB_API unsigned ZSTD_getDictID_fromDDict(const ZSTD_DDict* ddict);
|
|
|
|
|
|
-/*! ZSTD_getDictID_fromFrame() :
|
|
|
+/*! ZSTD_getDictID_fromFrame() : Requires v1.4.0+
|
|
|
* Provides the dictID required to decompressed the frame stored within `src`.
|
|
|
* If @return == 0, the dictID could not be decoded.
|
|
|
* This could for one of the following reasons :
|
|
@@ -916,7 +929,7 @@ ZSTDLIB_API unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
|
|
|
|
|
|
|
|
|
/*******************************************************************************
|
|
|
- * Advanced dictionary and prefix API
|
|
|
+ * Advanced dictionary and prefix API (Requires v1.4.0+)
|
|
|
*
|
|
|
* This API allows dictionaries to be used with ZSTD_compress2(),
|
|
|
* ZSTD_compressStream2(), and ZSTD_decompress(). Dictionaries are sticky, and
|
|
@@ -925,7 +938,7 @@ ZSTDLIB_API unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
|
|
|
******************************************************************************/
|
|
|
|
|
|
|
|
|
-/*! ZSTD_CCtx_loadDictionary() :
|
|
|
+/*! ZSTD_CCtx_loadDictionary() : Requires v1.4.0+
|
|
|
* Create an internal CDict from `dict` buffer.
|
|
|
* Decompression will have to use same dictionary.
|
|
|
* @result : 0, or an error code (which can be tested with ZSTD_isError()).
|
|
@@ -944,11 +957,11 @@ ZSTDLIB_API unsigned ZSTD_getDictID_fromFrame(const void* src, size_t srcSize);
|
|
|
* to precisely select how dictionary content must be interpreted. */
|
|
|
ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary(ZSTD_CCtx* cctx, const void* dict, size_t dictSize);
|
|
|
|
|
|
-/*! ZSTD_CCtx_refCDict() :
|
|
|
+/*! ZSTD_CCtx_refCDict() : Requires v1.4.0+
|
|
|
* Reference a prepared dictionary, to be used for all next compressed frames.
|
|
|
* Note that compression parameters are enforced from within CDict,
|
|
|
* and supersede any compression parameter previously set within CCtx.
|
|
|
- * The parameters ignored are labled as "superseded-by-cdict" in the ZSTD_cParameter enum docs.
|
|
|
+ * The parameters ignored are labelled as "superseded-by-cdict" in the ZSTD_cParameter enum docs.
|
|
|
* The ignored parameters will be used again if the CCtx is returned to no-dictionary mode.
|
|
|
* The dictionary will remain valid for future compressed frames using same CCtx.
|
|
|
* @result : 0, or an error code (which can be tested with ZSTD_isError()).
|
|
@@ -958,7 +971,7 @@ ZSTDLIB_API size_t ZSTD_CCtx_loadDictionary(ZSTD_CCtx* cctx, const void* dict, s
|
|
|
* Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. */
|
|
|
ZSTDLIB_API size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);
|
|
|
|
|
|
-/*! ZSTD_CCtx_refPrefix() :
|
|
|
+/*! ZSTD_CCtx_refPrefix() : Requires v1.4.0+
|
|
|
* Reference a prefix (single-usage dictionary) for next compressed frame.
|
|
|
* A prefix is **only used once**. Tables are discarded at end of frame (ZSTD_e_end).
|
|
|
* Decompression will need same prefix to properly regenerate data.
|
|
@@ -979,7 +992,7 @@ ZSTDLIB_API size_t ZSTD_CCtx_refCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict);
|
|
|
ZSTDLIB_API size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx,
|
|
|
const void* prefix, size_t prefixSize);
|
|
|
|
|
|
-/*! ZSTD_DCtx_loadDictionary() :
|
|
|
+/*! ZSTD_DCtx_loadDictionary() : Requires v1.4.0+
|
|
|
* Create an internal DDict from dict buffer,
|
|
|
* to be used to decompress next frames.
|
|
|
* The dictionary remains valid for all future frames, until explicitly invalidated.
|
|
@@ -996,9 +1009,16 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix(ZSTD_CCtx* cctx,
|
|
|
*/
|
|
|
ZSTDLIB_API size_t ZSTD_DCtx_loadDictionary(ZSTD_DCtx* dctx, const void* dict, size_t dictSize);
|
|
|
|
|
|
-/*! ZSTD_DCtx_refDDict() :
|
|
|
+/*! ZSTD_DCtx_refDDict() : Requires v1.4.0+
|
|
|
* Reference a prepared dictionary, to be used to decompress next frames.
|
|
|
* The dictionary remains active for decompression of future frames using same DCtx.
|
|
|
+ *
|
|
|
+ * If called with ZSTD_d_refMultipleDDicts enabled, repeated calls of this function
|
|
|
+ * will store the DDict references in a table, and the DDict used for decompression
|
|
|
+ * will be determined at decompression time, as per the dict ID in the frame.
|
|
|
+ * The memory for the table is allocated on the first call to refDDict, and can be
|
|
|
+ * freed with ZSTD_freeDCtx().
|
|
|
+ *
|
|
|
* @result : 0, or an error code (which can be tested with ZSTD_isError()).
|
|
|
* Note 1 : Currently, only one dictionary can be managed.
|
|
|
* Referencing a new dictionary effectively "discards" any previous one.
|
|
@@ -1007,7 +1027,7 @@ ZSTDLIB_API size_t ZSTD_DCtx_loadDictionary(ZSTD_DCtx* dctx, const void* dict, s
|
|
|
*/
|
|
|
ZSTDLIB_API size_t ZSTD_DCtx_refDDict(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
|
|
|
|
|
|
-/*! ZSTD_DCtx_refPrefix() :
|
|
|
+/*! ZSTD_DCtx_refPrefix() : Requires v1.4.0+
|
|
|
* Reference a prefix (single-usage dictionary) to decompress next frame.
|
|
|
* This is the reverse operation of ZSTD_CCtx_refPrefix(),
|
|
|
* and must use the same prefix as the one used during compression.
|
|
@@ -1028,7 +1048,7 @@ ZSTDLIB_API size_t ZSTD_DCtx_refPrefix(ZSTD_DCtx* dctx,
|
|
|
|
|
|
/* === Memory management === */
|
|
|
|
|
|
-/*! ZSTD_sizeof_*() :
|
|
|
+/*! ZSTD_sizeof_*() : Requires v1.4.0+
|
|
|
* These functions give the _current_ memory usage of selected object.
|
|
|
* Note that object memory usage can evolve (increase or decrease) over time. */
|
|
|
ZSTDLIB_API size_t ZSTD_sizeof_CCtx(const ZSTD_CCtx* cctx);
|
|
@@ -1053,6 +1073,28 @@ ZSTDLIB_API size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
|
|
|
#if defined(ZSTD_STATIC_LINKING_ONLY) && !defined(ZSTD_H_ZSTD_STATIC_LINKING_ONLY)
|
|
|
#define ZSTD_H_ZSTD_STATIC_LINKING_ONLY
|
|
|
|
|
|
+/* Deprecation warnings :
|
|
|
+ * Should these warnings be a problem, it is generally possible to disable them,
|
|
|
+ * typically with -Wno-deprecated-declarations for gcc or _CRT_SECURE_NO_WARNINGS in Visual.
|
|
|
+ * Otherwise, it's also possible to define ZSTD_DISABLE_DEPRECATE_WARNINGS.
|
|
|
+ */
|
|
|
+#ifdef ZSTD_DISABLE_DEPRECATE_WARNINGS
|
|
|
+# define ZSTD_DEPRECATED(message) ZSTDLIB_API /* disable deprecation warnings */
|
|
|
+#else
|
|
|
+# if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */
|
|
|
+# define ZSTD_DEPRECATED(message) [[deprecated(message)]] ZSTDLIB_API
|
|
|
+# elif (defined(GNUC) && (GNUC > 4 || (GNUC == 4 && GNUC_MINOR >= 5))) || defined(__clang__)
|
|
|
+# define ZSTD_DEPRECATED(message) ZSTDLIB_API __attribute__((deprecated(message)))
|
|
|
+# elif defined(__GNUC__) && (__GNUC__ >= 3)
|
|
|
+# define ZSTD_DEPRECATED(message) ZSTDLIB_API __attribute__((deprecated))
|
|
|
+# elif defined(_MSC_VER)
|
|
|
+# define ZSTD_DEPRECATED(message) ZSTDLIB_API __declspec(deprecated(message))
|
|
|
+# else
|
|
|
+# pragma message("WARNING: You need to implement ZSTD_DEPRECATED for this compiler")
|
|
|
+# define ZSTD_DEPRECATED(message) ZSTDLIB_API
|
|
|
+# endif
|
|
|
+#endif /* ZSTD_DISABLE_DEPRECATE_WARNINGS */
|
|
|
+
|
|
|
/****************************************************************************************
|
|
|
* experimental API (static linking only)
|
|
|
****************************************************************************************
|
|
@@ -1205,6 +1247,12 @@ typedef enum {
|
|
|
ZSTD_d_ignoreChecksum = 1
|
|
|
} ZSTD_forceIgnoreChecksum_e;
|
|
|
|
|
|
+typedef enum {
|
|
|
+ /* Note: this enum controls ZSTD_d_refMultipleDDicts */
|
|
|
+ ZSTD_rmd_refSingleDDict = 0,
|
|
|
+ ZSTD_rmd_refMultipleDDicts = 1
|
|
|
+} ZSTD_refMultipleDDicts_e;
|
|
|
+
|
|
|
typedef enum {
|
|
|
/* Note: this enum and the behavior it controls are effectively internal
|
|
|
* implementation details of the compressor. They are expected to continue
|
|
@@ -1253,6 +1301,11 @@ typedef enum {
|
|
|
ZSTD_lcm_uncompressed = 2 /**< Always emit uncompressed literals. */
|
|
|
} ZSTD_literalCompressionMode_e;
|
|
|
|
|
|
+typedef enum {
|
|
|
+ ZSTD_urm_auto = 0, /* Automatically determine whether or not we use row matchfinder */
|
|
|
+ ZSTD_urm_disableRowMatchFinder = 1, /* Never use row matchfinder */
|
|
|
+ ZSTD_urm_enableRowMatchFinder = 2 /* Always use row matchfinder when applicable */
|
|
|
+} ZSTD_useRowMatchFinderMode_e;
|
|
|
|
|
|
/***************************************
|
|
|
* Frame size functions
|
|
@@ -1286,7 +1339,7 @@ ZSTDLIB_API unsigned long long ZSTD_findDecompressedSize(const void* src, size_t
|
|
|
* `srcSize` must be the _exact_ size of this series
|
|
|
* (i.e. there should be a frame boundary at `src + srcSize`)
|
|
|
* @return : - upper-bound for the decompressed size of all data in all successive frames
|
|
|
- * - if an error occured: ZSTD_CONTENTSIZE_ERROR
|
|
|
+ * - if an error occurred: ZSTD_CONTENTSIZE_ERROR
|
|
|
*
|
|
|
* note 1 : an error can occur if `src` contains an invalid or incorrectly formatted frame.
|
|
|
* note 2 : the upper-bound is exact when the decompressed size field is available in every ZSTD encoded frame of `src`.
|
|
@@ -1372,6 +1425,23 @@ ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size
|
|
|
const void* src, size_t srcSize);
|
|
|
|
|
|
|
|
|
+/*! ZSTD_writeSkippableFrame() :
|
|
|
+ * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
|
|
|
+ *
|
|
|
+ * Skippable frames begin with a a 4-byte magic number. There are 16 possible choices of magic number,
|
|
|
+ * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
|
|
|
+ * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
|
|
|
+ * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
|
|
|
+ *
|
|
|
+ * Returns an error if destination buffer is not large enough, if the source size is not representable
|
|
|
+ * with a 4-byte unsigned int, or if the parameter magicVariant is greater than 15 (and therefore invalid).
|
|
|
+ *
|
|
|
+ * @return : number of bytes written or a ZSTD error.
|
|
|
+ */
|
|
|
+ZSTDLIB_API size_t ZSTD_writeSkippableFrame(void* dst, size_t dstCapacity,
|
|
|
+ const void* src, size_t srcSize, unsigned magicVariant);
|
|
|
+
|
|
|
+
|
|
|
/***************************************
|
|
|
* Memory management
|
|
|
***************************************/
|
|
@@ -1506,13 +1576,14 @@ ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced(const void* dict, size_t dictS
|
|
|
* Note that the lifetime of such pool must exist while being used.
|
|
|
* ZSTD_CCtx_refThreadPool assigns a thread pool to a context (use NULL argument value
|
|
|
* to use an internal thread pool).
|
|
|
- * ZSTD_freeThreadPool frees a thread pool.
|
|
|
+ * ZSTD_freeThreadPool frees a thread pool, accepts NULL pointer.
|
|
|
*/
|
|
|
typedef struct POOL_ctx_s ZSTD_threadPool;
|
|
|
ZSTDLIB_API ZSTD_threadPool* ZSTD_createThreadPool(size_t numThreads);
|
|
|
-ZSTDLIB_API void ZSTD_freeThreadPool (ZSTD_threadPool* pool);
|
|
|
+ZSTDLIB_API void ZSTD_freeThreadPool (ZSTD_threadPool* pool); /* accept NULL pointer */
|
|
|
ZSTDLIB_API size_t ZSTD_CCtx_refThreadPool(ZSTD_CCtx* cctx, ZSTD_threadPool* pool);
|
|
|
|
|
|
+
|
|
|
/*
|
|
|
* This API is temporary and is expected to change or disappear in the future!
|
|
|
*/
|
|
@@ -1523,10 +1594,12 @@ ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced2(
|
|
|
const ZSTD_CCtx_params* cctxParams,
|
|
|
ZSTD_customMem customMem);
|
|
|
|
|
|
-ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_advanced(const void* dict, size_t dictSize,
|
|
|
- ZSTD_dictLoadMethod_e dictLoadMethod,
|
|
|
- ZSTD_dictContentType_e dictContentType,
|
|
|
- ZSTD_customMem customMem);
|
|
|
+ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_advanced(
|
|
|
+ const void* dict, size_t dictSize,
|
|
|
+ ZSTD_dictLoadMethod_e dictLoadMethod,
|
|
|
+ ZSTD_dictContentType_e dictContentType,
|
|
|
+ ZSTD_customMem customMem);
|
|
|
+
|
|
|
|
|
|
/***************************************
|
|
|
* Advanced compression functions
|
|
@@ -1540,12 +1613,6 @@ ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_advanced(const void* dict, size_t dictS
|
|
|
* note: equivalent to ZSTD_createCDict_advanced(), with dictLoadMethod==ZSTD_dlm_byRef */
|
|
|
ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_byReference(const void* dictBuffer, size_t dictSize, int compressionLevel);
|
|
|
|
|
|
-/*! ZSTD_getDictID_fromCDict() :
|
|
|
- * Provides the dictID of the dictionary loaded into `cdict`.
|
|
|
- * If @return == 0, the dictionary is not conformant to Zstandard specification, or empty.
|
|
|
- * Non-conformant dictionaries can still be loaded, but as content-only dictionaries. */
|
|
|
-ZSTDLIB_API unsigned ZSTD_getDictID_fromCDict(const ZSTD_CDict* cdict);
|
|
|
-
|
|
|
/*! ZSTD_getCParams() :
|
|
|
* @return ZSTD_compressionParameters structure for a selected compression level and estimated srcSize.
|
|
|
* `estimatedSrcSize` value is optional, select 0 if not known */
|
|
@@ -1572,18 +1639,20 @@ ZSTDLIB_API ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParame
|
|
|
/*! ZSTD_compress_advanced() :
|
|
|
* Note : this function is now DEPRECATED.
|
|
|
* It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_setParameter() and other parameter setters.
|
|
|
- * This prototype will be marked as deprecated and generate compilation warning on reaching v1.5.x */
|
|
|
-ZSTDLIB_API size_t ZSTD_compress_advanced(ZSTD_CCtx* cctx,
|
|
|
+ * This prototype will generate compilation warnings. */
|
|
|
+ZSTD_DEPRECATED("use ZSTD_compress2")
|
|
|
+size_t ZSTD_compress_advanced(ZSTD_CCtx* cctx,
|
|
|
void* dst, size_t dstCapacity,
|
|
|
const void* src, size_t srcSize,
|
|
|
const void* dict,size_t dictSize,
|
|
|
ZSTD_parameters params);
|
|
|
|
|
|
/*! ZSTD_compress_usingCDict_advanced() :
|
|
|
- * Note : this function is now REDUNDANT.
|
|
|
+ * Note : this function is now DEPRECATED.
|
|
|
* It can be replaced by ZSTD_compress2(), in combination with ZSTD_CCtx_loadDictionary() and other parameter setters.
|
|
|
- * This prototype will be marked as deprecated and generate compilation warning in some future version */
|
|
|
-ZSTDLIB_API size_t ZSTD_compress_usingCDict_advanced(ZSTD_CCtx* cctx,
|
|
|
+ * This prototype will generate compilation warnings. */
|
|
|
+ZSTD_DEPRECATED("use ZSTD_compress2 with ZSTD_CCtx_loadDictionary")
|
|
|
+size_t ZSTD_compress_usingCDict_advanced(ZSTD_CCtx* cctx,
|
|
|
void* dst, size_t dstCapacity,
|
|
|
const void* src, size_t srcSize,
|
|
|
const ZSTD_CDict* cdict,
|
|
@@ -1645,7 +1714,7 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
|
|
|
|
|
|
/* Controls how the literals are compressed (default is auto).
|
|
|
* The value must be of type ZSTD_literalCompressionMode_e.
|
|
|
- * See ZSTD_literalCompressionMode_t enum definition for details.
|
|
|
+ * See ZSTD_literalCompressionMode_e enum definition for details.
|
|
|
*/
|
|
|
#define ZSTD_c_literalCompressionMode ZSTD_c_experimentalParam5
|
|
|
|
|
@@ -1797,12 +1866,52 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
|
|
|
*/
|
|
|
#define ZSTD_c_validateSequences ZSTD_c_experimentalParam12
|
|
|
|
|
|
+/* ZSTD_c_splitBlocks
|
|
|
+ * Default is 0 == disabled. Set to 1 to enable block splitting.
|
|
|
+ *
|
|
|
+ * Will attempt to split blocks in order to improve compression ratio at the cost of speed.
|
|
|
+ */
|
|
|
+#define ZSTD_c_splitBlocks ZSTD_c_experimentalParam13
|
|
|
+
|
|
|
+/* ZSTD_c_useRowMatchFinder
|
|
|
+ * Default is ZSTD_urm_auto.
|
|
|
+ * Controlled with ZSTD_useRowMatchFinderMode_e enum.
|
|
|
+ *
|
|
|
+ * By default, in ZSTD_urm_auto, when finalizing the compression parameters, the library
|
|
|
+ * will decide at runtime whether to use the row-based matchfinder based on support for SIMD
|
|
|
+ * instructions as well as the windowLog.
|
|
|
+ *
|
|
|
+ * Set to ZSTD_urm_disableRowMatchFinder to never use row-based matchfinder.
|
|
|
+ * Set to ZSTD_urm_enableRowMatchFinder to force usage of row-based matchfinder.
|
|
|
+ */
|
|
|
+#define ZSTD_c_useRowMatchFinder ZSTD_c_experimentalParam14
|
|
|
+
|
|
|
+/* ZSTD_c_deterministicRefPrefix
|
|
|
+ * Default is 0 == disabled. Set to 1 to enable.
|
|
|
+ *
|
|
|
+ * Zstd produces different results for prefix compression when the prefix is
|
|
|
+ * directly adjacent to the data about to be compressed vs. when it isn't.
|
|
|
+ * This is because zstd detects that the two buffers are contiguous and it can
|
|
|
+ * use a more efficient match finding algorithm. However, this produces different
|
|
|
+ * results than when the two buffers are non-contiguous. This flag forces zstd
|
|
|
+ * to always load the prefix in non-contiguous mode, even if it happens to be
|
|
|
+ * adjacent to the data, to guarantee determinism.
|
|
|
+ *
|
|
|
+ * If you really care about determinism when using a dictionary or prefix,
|
|
|
+ * like when doing delta compression, you should select this option. It comes
|
|
|
+ * at a speed penalty of about ~2.5% if the dictionary and data happened to be
|
|
|
+ * contiguous, and is free if they weren't contiguous. We don't expect that
|
|
|
+ * intentionally making the dictionary and data contiguous will be worth the
|
|
|
+ * cost to memcpy() the data.
|
|
|
+ */
|
|
|
+#define ZSTD_c_deterministicRefPrefix ZSTD_c_experimentalParam15
|
|
|
+
|
|
|
/*! ZSTD_CCtx_getParameter() :
|
|
|
* Get the requested compression parameter value, selected by enum ZSTD_cParameter,
|
|
|
* and store it into int* value.
|
|
|
* @return : 0, or an error code (which can be tested with ZSTD_isError()).
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t ZSTD_CCtx_getParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param, int* value);
|
|
|
+ZSTDLIB_API size_t ZSTD_CCtx_getParameter(const ZSTD_CCtx* cctx, ZSTD_cParameter param, int* value);
|
|
|
|
|
|
|
|
|
/*! ZSTD_CCtx_params :
|
|
@@ -1817,13 +1926,13 @@ ZSTDLIB_API size_t ZSTD_CCtx_getParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param
|
|
|
* These parameters will be applied to
|
|
|
* all subsequent frames.
|
|
|
* - ZSTD_compressStream2() : Do compression using the CCtx.
|
|
|
- * - ZSTD_freeCCtxParams() : Free the memory.
|
|
|
+ * - ZSTD_freeCCtxParams() : Free the memory, accept NULL pointer.
|
|
|
*
|
|
|
* This can be used with ZSTD_estimateCCtxSize_advanced_usingCCtxParams()
|
|
|
* for static allocation of CCtx for single-threaded compression.
|
|
|
*/
|
|
|
ZSTDLIB_API ZSTD_CCtx_params* ZSTD_createCCtxParams(void);
|
|
|
-ZSTDLIB_API size_t ZSTD_freeCCtxParams(ZSTD_CCtx_params* params);
|
|
|
+ZSTDLIB_API size_t ZSTD_freeCCtxParams(ZSTD_CCtx_params* params); /* accept NULL pointer */
|
|
|
|
|
|
/*! ZSTD_CCtxParams_reset() :
|
|
|
* Reset params to default values.
|
|
@@ -1842,7 +1951,7 @@ ZSTDLIB_API size_t ZSTD_CCtxParams_init(ZSTD_CCtx_params* cctxParams, int compre
|
|
|
*/
|
|
|
ZSTDLIB_API size_t ZSTD_CCtxParams_init_advanced(ZSTD_CCtx_params* cctxParams, ZSTD_parameters params);
|
|
|
|
|
|
-/*! ZSTD_CCtxParams_setParameter() :
|
|
|
+/*! ZSTD_CCtxParams_setParameter() : Requires v1.4.0+
|
|
|
* Similar to ZSTD_CCtx_setParameter.
|
|
|
* Set one compression parameter, selected by enum ZSTD_cParameter.
|
|
|
* Parameters must be applied to a ZSTD_CCtx using
|
|
@@ -1857,7 +1966,7 @@ ZSTDLIB_API size_t ZSTD_CCtxParams_setParameter(ZSTD_CCtx_params* params, ZSTD_c
|
|
|
* Get the requested value of one compression parameter, selected by enum ZSTD_cParameter.
|
|
|
* @result : 0, or an error code (which can be tested with ZSTD_isError()).
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t ZSTD_CCtxParams_getParameter(ZSTD_CCtx_params* params, ZSTD_cParameter param, int* value);
|
|
|
+ZSTDLIB_API size_t ZSTD_CCtxParams_getParameter(const ZSTD_CCtx_params* params, ZSTD_cParameter param, int* value);
|
|
|
|
|
|
/*! ZSTD_CCtx_setParametersUsingCCtxParams() :
|
|
|
* Apply a set of ZSTD_CCtx_params to the compression context.
|
|
@@ -1983,12 +2092,38 @@ ZSTDLIB_API size_t ZSTD_DCtx_getParameter(ZSTD_DCtx* dctx, ZSTD_dParameter param
|
|
|
*/
|
|
|
#define ZSTD_d_forceIgnoreChecksum ZSTD_d_experimentalParam3
|
|
|
|
|
|
+/* ZSTD_d_refMultipleDDicts
|
|
|
+ * Experimental parameter.
|
|
|
+ * Default is 0 == disabled. Set to 1 to enable
|
|
|
+ *
|
|
|
+ * If enabled and dctx is allocated on the heap, then additional memory will be allocated
|
|
|
+ * to store references to multiple ZSTD_DDict. That is, multiple calls of ZSTD_refDDict()
|
|
|
+ * using a given ZSTD_DCtx, rather than overwriting the previous DDict reference, will instead
|
|
|
+ * store all references. At decompression time, the appropriate dictID is selected
|
|
|
+ * from the set of DDicts based on the dictID in the frame.
|
|
|
+ *
|
|
|
+ * Usage is simply calling ZSTD_refDDict() on multiple dict buffers.
|
|
|
+ *
|
|
|
+ * Param has values of byte ZSTD_refMultipleDDicts_e
|
|
|
+ *
|
|
|
+ * WARNING: Enabling this parameter and calling ZSTD_DCtx_refDDict(), will trigger memory
|
|
|
+ * allocation for the hash table. ZSTD_freeDCtx() also frees this memory.
|
|
|
+ * Memory is allocated as per ZSTD_DCtx::customMem.
|
|
|
+ *
|
|
|
+ * Although this function allocates memory for the table, the user is still responsible for
|
|
|
+ * memory management of the underlying ZSTD_DDict* themselves.
|
|
|
+ */
|
|
|
+#define ZSTD_d_refMultipleDDicts ZSTD_d_experimentalParam4
|
|
|
+
|
|
|
+
|
|
|
/*! ZSTD_DCtx_setFormat() :
|
|
|
+ * This function is REDUNDANT. Prefer ZSTD_DCtx_setParameter().
|
|
|
* Instruct the decoder context about what kind of data to decode next.
|
|
|
* This instruction is mandatory to decode data without a fully-formed header,
|
|
|
* such ZSTD_f_zstd1_magicless for example.
|
|
|
* @return : 0, or an error code (which can be tested using ZSTD_isError()). */
|
|
|
-ZSTDLIB_API size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format);
|
|
|
+ZSTD_DEPRECATED("use ZSTD_DCtx_setParameter() instead")
|
|
|
+size_t ZSTD_DCtx_setFormat(ZSTD_DCtx* dctx, ZSTD_format_e format);
|
|
|
|
|
|
/*! ZSTD_decompressStream_simpleArgs() :
|
|
|
* Same as ZSTD_decompressStream(),
|
|
@@ -2012,7 +2147,7 @@ ZSTDLIB_API size_t ZSTD_decompressStream_simpleArgs (
|
|
|
/*===== Advanced Streaming compression functions =====*/
|
|
|
|
|
|
/*! ZSTD_initCStream_srcSize() :
|
|
|
- * This function is deprecated, and equivalent to:
|
|
|
+ * This function is DEPRECATED, and equivalent to:
|
|
|
* ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
|
|
|
* ZSTD_CCtx_refCDict(zcs, NULL); // clear the dictionary (if any)
|
|
|
* ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
|
|
@@ -2021,15 +2156,15 @@ ZSTDLIB_API size_t ZSTD_decompressStream_simpleArgs (
|
|
|
* pledgedSrcSize must be correct. If it is not known at init time, use
|
|
|
* ZSTD_CONTENTSIZE_UNKNOWN. Note that, for compatibility with older programs,
|
|
|
* "0" also disables frame content size field. It may be enabled in the future.
|
|
|
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
|
|
|
+ * This prototype will generate compilation warnings.
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t
|
|
|
-ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
|
|
|
+ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
|
|
|
+size_t ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
|
|
|
int compressionLevel,
|
|
|
unsigned long long pledgedSrcSize);
|
|
|
|
|
|
/*! ZSTD_initCStream_usingDict() :
|
|
|
- * This function is deprecated, and is equivalent to:
|
|
|
+ * This function is DEPRECATED, and is equivalent to:
|
|
|
* ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
|
|
|
* ZSTD_CCtx_setParameter(zcs, ZSTD_c_compressionLevel, compressionLevel);
|
|
|
* ZSTD_CCtx_loadDictionary(zcs, dict, dictSize);
|
|
@@ -2038,15 +2173,15 @@ ZSTD_initCStream_srcSize(ZSTD_CStream* zcs,
|
|
|
* dict == NULL or dictSize < 8, in which case no dict is used.
|
|
|
* Note: dict is loaded with ZSTD_dct_auto (treated as a full zstd dictionary if
|
|
|
* it begins with ZSTD_MAGIC_DICTIONARY, else as raw content) and ZSTD_dlm_byCopy.
|
|
|
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
|
|
|
+ * This prototype will generate compilation warnings.
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t
|
|
|
-ZSTD_initCStream_usingDict(ZSTD_CStream* zcs,
|
|
|
+ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
|
|
|
+size_t ZSTD_initCStream_usingDict(ZSTD_CStream* zcs,
|
|
|
const void* dict, size_t dictSize,
|
|
|
int compressionLevel);
|
|
|
|
|
|
/*! ZSTD_initCStream_advanced() :
|
|
|
- * This function is deprecated, and is approximately equivalent to:
|
|
|
+ * This function is DEPRECATED, and is approximately equivalent to:
|
|
|
* ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
|
|
|
* // Pseudocode: Set each zstd parameter and leave the rest as-is.
|
|
|
* for ((param, value) : params) {
|
|
@@ -2058,23 +2193,24 @@ ZSTD_initCStream_usingDict(ZSTD_CStream* zcs,
|
|
|
* dict is loaded with ZSTD_dct_auto and ZSTD_dlm_byCopy.
|
|
|
* pledgedSrcSize must be correct.
|
|
|
* If srcSize is not known at init time, use value ZSTD_CONTENTSIZE_UNKNOWN.
|
|
|
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
|
|
|
+ * This prototype will generate compilation warnings.
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t
|
|
|
-ZSTD_initCStream_advanced(ZSTD_CStream* zcs,
|
|
|
+ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
|
|
|
+size_t ZSTD_initCStream_advanced(ZSTD_CStream* zcs,
|
|
|
const void* dict, size_t dictSize,
|
|
|
ZSTD_parameters params,
|
|
|
unsigned long long pledgedSrcSize);
|
|
|
|
|
|
/*! ZSTD_initCStream_usingCDict() :
|
|
|
- * This function is deprecated, and equivalent to:
|
|
|
+ * This function is DEPRECATED, and equivalent to:
|
|
|
* ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
|
|
|
* ZSTD_CCtx_refCDict(zcs, cdict);
|
|
|
- *
|
|
|
+ *
|
|
|
* note : cdict will just be referenced, and must outlive compression session
|
|
|
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
|
|
|
+ * This prototype will generate compilation warnings.
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDict* cdict);
|
|
|
+ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instructions")
|
|
|
+size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDict* cdict);
|
|
|
|
|
|
/*! ZSTD_initCStream_usingCDict_advanced() :
|
|
|
* This function is DEPRECATED, and is approximately equivalent to:
|
|
@@ -2089,18 +2225,21 @@ ZSTDLIB_API size_t ZSTD_initCStream_usingCDict(ZSTD_CStream* zcs, const ZSTD_CDi
|
|
|
* same as ZSTD_initCStream_usingCDict(), with control over frame parameters.
|
|
|
* pledgedSrcSize must be correct. If srcSize is not known at init time, use
|
|
|
* value ZSTD_CONTENTSIZE_UNKNOWN.
|
|
|
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
|
|
|
+ * This prototype will generate compilation warnings.
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t
|
|
|
-ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
|
|
|
+ZSTD_DEPRECATED("use ZSTD_CCtx_reset and ZSTD_CCtx_refCDict, see zstd.h for detailed instructions")
|
|
|
+size_t ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
|
|
|
const ZSTD_CDict* cdict,
|
|
|
ZSTD_frameParameters fParams,
|
|
|
unsigned long long pledgedSrcSize);
|
|
|
|
|
|
/*! ZSTD_resetCStream() :
|
|
|
- * This function is deprecated, and is equivalent to:
|
|
|
+ * This function is DEPRECATED, and is equivalent to:
|
|
|
* ZSTD_CCtx_reset(zcs, ZSTD_reset_session_only);
|
|
|
* ZSTD_CCtx_setPledgedSrcSize(zcs, pledgedSrcSize);
|
|
|
+ * Note: ZSTD_resetCStream() interprets pledgedSrcSize == 0 as ZSTD_CONTENTSIZE_UNKNOWN, but
|
|
|
+ * ZSTD_CCtx_setPledgedSrcSize() does not do the same, so ZSTD_CONTENTSIZE_UNKNOWN must be
|
|
|
+ * explicitly specified.
|
|
|
*
|
|
|
* start a new frame, using same parameters from previous frame.
|
|
|
* This is typically useful to skip dictionary loading stage, since it will re-use it in-place.
|
|
@@ -2110,9 +2249,10 @@ ZSTD_initCStream_usingCDict_advanced(ZSTD_CStream* zcs,
|
|
|
* For the time being, pledgedSrcSize==0 is interpreted as "srcSize unknown" for compatibility with older programs,
|
|
|
* but it will change to mean "empty" in future version, so use macro ZSTD_CONTENTSIZE_UNKNOWN instead.
|
|
|
* @return : 0, or an error code (which can be tested using ZSTD_isError())
|
|
|
- * Note : this prototype will be marked as deprecated and generate compilation warnings on reaching v1.5.x
|
|
|
+ * This prototype will generate compilation warnings.
|
|
|
*/
|
|
|
-ZSTDLIB_API size_t ZSTD_resetCStream(ZSTD_CStream* zcs, unsigned long long pledgedSrcSize);
|
|
|
+ZSTD_DEPRECATED("use ZSTD_CCtx_reset, see zstd.h for detailed instructions")
|
|
|
+size_t ZSTD_resetCStream(ZSTD_CStream* zcs, unsigned long long pledgedSrcSize);
|
|
|
|
|
|
|
|
|
typedef struct {
|
|
@@ -2199,8 +2339,7 @@ ZSTDLIB_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
|
|
|
ZSTD_CCtx object can be re-used multiple times within successive compression operations.
|
|
|
|
|
|
Start by initializing a context.
|
|
|
- Use ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression,
|
|
|
- or ZSTD_compressBegin_advanced(), for finer parameter control.
|
|
|
+ Use ZSTD_compressBegin(), or ZSTD_compressBegin_usingDict() for dictionary compression.
|
|
|
It's also possible to duplicate a reference context which has already been initialized, using ZSTD_copyCCtx()
|
|
|
|
|
|
Then, consume your input using ZSTD_compressContinue().
|
|
@@ -2225,15 +2364,17 @@ ZSTDLIB_API size_t ZSTD_resetDStream(ZSTD_DStream* zds);
|
|
|
/*===== Buffer-less streaming compression functions =====*/
|
|
|
ZSTDLIB_API size_t ZSTD_compressBegin(ZSTD_CCtx* cctx, int compressionLevel);
|
|
|
ZSTDLIB_API size_t ZSTD_compressBegin_usingDict(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, int compressionLevel);
|
|
|
-ZSTDLIB_API size_t ZSTD_compressBegin_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_parameters params, unsigned long long pledgedSrcSize); /**< pledgedSrcSize : If srcSize is not known at init time, use ZSTD_CONTENTSIZE_UNKNOWN */
|
|
|
ZSTDLIB_API size_t ZSTD_compressBegin_usingCDict(ZSTD_CCtx* cctx, const ZSTD_CDict* cdict); /**< note: fails if cdict==NULL */
|
|
|
-ZSTDLIB_API size_t ZSTD_compressBegin_usingCDict_advanced(ZSTD_CCtx* const cctx, const ZSTD_CDict* const cdict, ZSTD_frameParameters const fParams, unsigned long long const pledgedSrcSize); /* compression parameters are already set within cdict. pledgedSrcSize must be correct. If srcSize is not known, use macro ZSTD_CONTENTSIZE_UNKNOWN */
|
|
|
ZSTDLIB_API size_t ZSTD_copyCCtx(ZSTD_CCtx* cctx, const ZSTD_CCtx* preparedCCtx, unsigned long long pledgedSrcSize); /**< note: if pledgedSrcSize is not known, use ZSTD_CONTENTSIZE_UNKNOWN */
|
|
|
|
|
|
ZSTDLIB_API size_t ZSTD_compressContinue(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
|
|
|
ZSTDLIB_API size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
|
|
|
|
|
|
-
|
|
|
+/* The ZSTD_compressBegin_advanced() and ZSTD_compressBegin_usingCDict_advanced() are now DEPRECATED and will generate a compiler warning */
|
|
|
+ZSTD_DEPRECATED("use advanced API to access custom parameters")
|
|
|
+size_t ZSTD_compressBegin_advanced(ZSTD_CCtx* cctx, const void* dict, size_t dictSize, ZSTD_parameters params, unsigned long long pledgedSrcSize); /**< pledgedSrcSize : If srcSize is not known at init time, use ZSTD_CONTENTSIZE_UNKNOWN */
|
|
|
+ZSTD_DEPRECATED("use advanced API to access custom parameters")
|
|
|
+size_t ZSTD_compressBegin_usingCDict_advanced(ZSTD_CCtx* const cctx, const ZSTD_CDict* const cdict, ZSTD_frameParameters const fParams, unsigned long long const pledgedSrcSize); /* compression parameters are already set within cdict. pledgedSrcSize must be correct. If srcSize is not known, use macro ZSTD_CONTENTSIZE_UNKNOWN */
|
|
|
/**
|
|
|
Buffer-less streaming decompression (synchronous mode)
|
|
|
|