1*01826a49SYabin Cui /* 2*01826a49SYabin Cui * Copyright (c) Yann Collet, Meta Platforms, Inc. and affiliates. 3*01826a49SYabin Cui * All rights reserved. 4*01826a49SYabin Cui * 5*01826a49SYabin Cui * This source code is licensed under both the BSD-style license (found in the 6*01826a49SYabin Cui * LICENSE file in the root directory of this source tree) and the GPLv2 (found 7*01826a49SYabin Cui * in the COPYING file in the root directory of this source tree). 8*01826a49SYabin Cui * You may select, at your option, one of the above-listed licenses. 9*01826a49SYabin Cui */ 10*01826a49SYabin Cui 11*01826a49SYabin Cui #ifndef ZSTDv07_H_235446 12*01826a49SYabin Cui #define ZSTDv07_H_235446 13*01826a49SYabin Cui 14*01826a49SYabin Cui #if defined (__cplusplus) 15*01826a49SYabin Cui extern "C" { 16*01826a49SYabin Cui #endif 17*01826a49SYabin Cui 18*01826a49SYabin Cui /*====== Dependency ======*/ 19*01826a49SYabin Cui #include <stddef.h> /* size_t */ 20*01826a49SYabin Cui 21*01826a49SYabin Cui 22*01826a49SYabin Cui /*====== Export for Windows ======*/ 23*01826a49SYabin Cui /*! 24*01826a49SYabin Cui * ZSTDv07_DLL_EXPORT : 25*01826a49SYabin Cui * Enable exporting of functions when building a Windows DLL 26*01826a49SYabin Cui */ 27*01826a49SYabin Cui #if defined(_WIN32) && defined(ZSTDv07_DLL_EXPORT) && (ZSTDv07_DLL_EXPORT==1) 28*01826a49SYabin Cui # define ZSTDLIBv07_API __declspec(dllexport) 29*01826a49SYabin Cui #else 30*01826a49SYabin Cui # define ZSTDLIBv07_API 31*01826a49SYabin Cui #endif 32*01826a49SYabin Cui 33*01826a49SYabin Cui 34*01826a49SYabin Cui /* ************************************* 35*01826a49SYabin Cui * Simple API 36*01826a49SYabin Cui ***************************************/ 37*01826a49SYabin Cui /*! ZSTDv07_getDecompressedSize() : 38*01826a49SYabin Cui * @return : decompressed size if known, 0 otherwise. 39*01826a49SYabin Cui note 1 : if `0`, follow up with ZSTDv07_getFrameParams() to know precise failure cause. 40*01826a49SYabin Cui note 2 : decompressed size could be wrong or intentionally modified ! 41*01826a49SYabin Cui always ensure results fit within application's authorized limits */ 42*01826a49SYabin Cui unsigned long long ZSTDv07_getDecompressedSize(const void* src, size_t srcSize); 43*01826a49SYabin Cui 44*01826a49SYabin Cui /*! ZSTDv07_decompress() : 45*01826a49SYabin Cui `compressedSize` : must be _exact_ size of compressed input, otherwise decompression will fail. 46*01826a49SYabin Cui `dstCapacity` must be equal or larger than originalSize. 47*01826a49SYabin Cui @return : the number of bytes decompressed into `dst` (<= `dstCapacity`), 48*01826a49SYabin Cui or an errorCode if it fails (which can be tested using ZSTDv07_isError()) */ 49*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_decompress( void* dst, size_t dstCapacity, 50*01826a49SYabin Cui const void* src, size_t compressedSize); 51*01826a49SYabin Cui 52*01826a49SYabin Cui /** 53*01826a49SYabin Cui ZSTDv07_findFrameSizeInfoLegacy() : get the source length and decompressed bound of a ZSTD frame compliant with v0.7.x format 54*01826a49SYabin Cui srcSize : The size of the 'src' buffer, at least as large as the frame pointed to by 'src' 55*01826a49SYabin Cui cSize (output parameter) : the number of bytes that would be read to decompress this frame 56*01826a49SYabin Cui or an error code if it fails (which can be tested using ZSTDv01_isError()) 57*01826a49SYabin Cui dBound (output parameter) : an upper-bound for the decompressed size of the data in the frame 58*01826a49SYabin Cui or ZSTD_CONTENTSIZE_ERROR if an error occurs 59*01826a49SYabin Cui 60*01826a49SYabin Cui note : assumes `cSize` and `dBound` are _not_ NULL. 61*01826a49SYabin Cui */ 62*01826a49SYabin Cui void ZSTDv07_findFrameSizeInfoLegacy(const void *src, size_t srcSize, 63*01826a49SYabin Cui size_t* cSize, unsigned long long* dBound); 64*01826a49SYabin Cui 65*01826a49SYabin Cui /*====== Helper functions ======*/ 66*01826a49SYabin Cui ZSTDLIBv07_API unsigned ZSTDv07_isError(size_t code); /*!< tells if a `size_t` function result is an error code */ 67*01826a49SYabin Cui ZSTDLIBv07_API const char* ZSTDv07_getErrorName(size_t code); /*!< provides readable string from an error code */ 68*01826a49SYabin Cui 69*01826a49SYabin Cui 70*01826a49SYabin Cui /*-************************************* 71*01826a49SYabin Cui * Explicit memory management 72*01826a49SYabin Cui ***************************************/ 73*01826a49SYabin Cui /** Decompression context */ 74*01826a49SYabin Cui typedef struct ZSTDv07_DCtx_s ZSTDv07_DCtx; 75*01826a49SYabin Cui ZSTDLIBv07_API ZSTDv07_DCtx* ZSTDv07_createDCtx(void); 76*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_freeDCtx(ZSTDv07_DCtx* dctx); /*!< @return : errorCode */ 77*01826a49SYabin Cui 78*01826a49SYabin Cui /** ZSTDv07_decompressDCtx() : 79*01826a49SYabin Cui * Same as ZSTDv07_decompress(), requires an allocated ZSTDv07_DCtx (see ZSTDv07_createDCtx()) */ 80*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_decompressDCtx(ZSTDv07_DCtx* ctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize); 81*01826a49SYabin Cui 82*01826a49SYabin Cui 83*01826a49SYabin Cui /*-************************ 84*01826a49SYabin Cui * Simple dictionary API 85*01826a49SYabin Cui ***************************/ 86*01826a49SYabin Cui /*! ZSTDv07_decompress_usingDict() : 87*01826a49SYabin Cui * Decompression using a pre-defined Dictionary content (see dictBuilder). 88*01826a49SYabin Cui * Dictionary must be identical to the one used during compression. 89*01826a49SYabin Cui * Note : This function load the dictionary, resulting in a significant startup time */ 90*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_decompress_usingDict(ZSTDv07_DCtx* dctx, 91*01826a49SYabin Cui void* dst, size_t dstCapacity, 92*01826a49SYabin Cui const void* src, size_t srcSize, 93*01826a49SYabin Cui const void* dict,size_t dictSize); 94*01826a49SYabin Cui 95*01826a49SYabin Cui 96*01826a49SYabin Cui /*-************************** 97*01826a49SYabin Cui * Advanced Dictionary API 98*01826a49SYabin Cui ****************************/ 99*01826a49SYabin Cui /*! ZSTDv07_createDDict() : 100*01826a49SYabin Cui * Create a digested dictionary, ready to start decompression operation without startup delay. 101*01826a49SYabin Cui * `dict` can be released after creation */ 102*01826a49SYabin Cui typedef struct ZSTDv07_DDict_s ZSTDv07_DDict; 103*01826a49SYabin Cui ZSTDLIBv07_API ZSTDv07_DDict* ZSTDv07_createDDict(const void* dict, size_t dictSize); 104*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_freeDDict(ZSTDv07_DDict* ddict); 105*01826a49SYabin Cui 106*01826a49SYabin Cui /*! ZSTDv07_decompress_usingDDict() : 107*01826a49SYabin Cui * Decompression using a pre-digested Dictionary 108*01826a49SYabin Cui * Faster startup than ZSTDv07_decompress_usingDict(), recommended when same dictionary is used multiple times. */ 109*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_decompress_usingDDict(ZSTDv07_DCtx* dctx, 110*01826a49SYabin Cui void* dst, size_t dstCapacity, 111*01826a49SYabin Cui const void* src, size_t srcSize, 112*01826a49SYabin Cui const ZSTDv07_DDict* ddict); 113*01826a49SYabin Cui 114*01826a49SYabin Cui typedef struct { 115*01826a49SYabin Cui unsigned long long frameContentSize; 116*01826a49SYabin Cui unsigned windowSize; 117*01826a49SYabin Cui unsigned dictID; 118*01826a49SYabin Cui unsigned checksumFlag; 119*01826a49SYabin Cui } ZSTDv07_frameParams; 120*01826a49SYabin Cui 121*01826a49SYabin Cui ZSTDLIBv07_API size_t ZSTDv07_getFrameParams(ZSTDv07_frameParams* fparamsPtr, const void* src, size_t srcSize); /**< doesn't consume input */ 122*01826a49SYabin Cui 123*01826a49SYabin Cui 124*01826a49SYabin Cui 125*01826a49SYabin Cui 126*01826a49SYabin Cui /* ************************************* 127*01826a49SYabin Cui * Streaming functions 128*01826a49SYabin Cui ***************************************/ 129*01826a49SYabin Cui typedef struct ZBUFFv07_DCtx_s ZBUFFv07_DCtx; 130*01826a49SYabin Cui ZSTDLIBv07_API ZBUFFv07_DCtx* ZBUFFv07_createDCtx(void); 131*01826a49SYabin Cui ZSTDLIBv07_API size_t ZBUFFv07_freeDCtx(ZBUFFv07_DCtx* dctx); 132*01826a49SYabin Cui 133*01826a49SYabin Cui ZSTDLIBv07_API size_t ZBUFFv07_decompressInit(ZBUFFv07_DCtx* dctx); 134*01826a49SYabin Cui ZSTDLIBv07_API size_t ZBUFFv07_decompressInitDictionary(ZBUFFv07_DCtx* dctx, const void* dict, size_t dictSize); 135*01826a49SYabin Cui 136*01826a49SYabin Cui ZSTDLIBv07_API size_t ZBUFFv07_decompressContinue(ZBUFFv07_DCtx* dctx, 137*01826a49SYabin Cui void* dst, size_t* dstCapacityPtr, 138*01826a49SYabin Cui const void* src, size_t* srcSizePtr); 139*01826a49SYabin Cui 140*01826a49SYabin Cui /*-*************************************************************************** 141*01826a49SYabin Cui * Streaming decompression howto 142*01826a49SYabin Cui * 143*01826a49SYabin Cui * A ZBUFFv07_DCtx object is required to track streaming operations. 144*01826a49SYabin Cui * Use ZBUFFv07_createDCtx() and ZBUFFv07_freeDCtx() to create/release resources. 145*01826a49SYabin Cui * Use ZBUFFv07_decompressInit() to start a new decompression operation, 146*01826a49SYabin Cui * or ZBUFFv07_decompressInitDictionary() if decompression requires a dictionary. 147*01826a49SYabin Cui * Note that ZBUFFv07_DCtx objects can be re-init multiple times. 148*01826a49SYabin Cui * 149*01826a49SYabin Cui * Use ZBUFFv07_decompressContinue() repetitively to consume your input. 150*01826a49SYabin Cui * *srcSizePtr and *dstCapacityPtr can be any size. 151*01826a49SYabin Cui * The function will report how many bytes were read or written by modifying *srcSizePtr and *dstCapacityPtr. 152*01826a49SYabin Cui * Note that it may not consume the entire input, in which case it's up to the caller to present remaining input again. 153*01826a49SYabin Cui * The content of `dst` will be overwritten (up to *dstCapacityPtr) at each function call, so save its content if it matters, or change `dst`. 154*01826a49SYabin Cui * @return : a hint to preferred nb of bytes to use as input for next function call (it's only a hint, to help latency), 155*01826a49SYabin Cui * or 0 when a frame is completely decoded, 156*01826a49SYabin Cui * or an error code, which can be tested using ZBUFFv07_isError(). 157*01826a49SYabin Cui * 158*01826a49SYabin Cui * Hint : recommended buffer sizes (not compulsory) : ZBUFFv07_recommendedDInSize() and ZBUFFv07_recommendedDOutSize() 159*01826a49SYabin Cui * output : ZBUFFv07_recommendedDOutSize== 128 KB block size is the internal unit, it ensures it's always possible to write a full block when decoded. 160*01826a49SYabin Cui * input : ZBUFFv07_recommendedDInSize == 128KB + 3; 161*01826a49SYabin Cui * just follow indications from ZBUFFv07_decompressContinue() to minimize latency. It should always be <= 128 KB + 3 . 162*01826a49SYabin Cui * *******************************************************************************/ 163*01826a49SYabin Cui 164*01826a49SYabin Cui 165*01826a49SYabin Cui /* ************************************* 166*01826a49SYabin Cui * Tool functions 167*01826a49SYabin Cui ***************************************/ 168*01826a49SYabin Cui ZSTDLIBv07_API unsigned ZBUFFv07_isError(size_t errorCode); 169*01826a49SYabin Cui ZSTDLIBv07_API const char* ZBUFFv07_getErrorName(size_t errorCode); 170*01826a49SYabin Cui 171*01826a49SYabin Cui /** Functions below provide recommended buffer sizes for Compression or Decompression operations. 172*01826a49SYabin Cui * These sizes are just hints, they tend to offer better latency */ 173*01826a49SYabin Cui ZSTDLIBv07_API size_t ZBUFFv07_recommendedDInSize(void); 174*01826a49SYabin Cui ZSTDLIBv07_API size_t ZBUFFv07_recommendedDOutSize(void); 175*01826a49SYabin Cui 176*01826a49SYabin Cui 177*01826a49SYabin Cui /*-************************************* 178*01826a49SYabin Cui * Constants 179*01826a49SYabin Cui ***************************************/ 180*01826a49SYabin Cui #define ZSTDv07_MAGICNUMBER 0xFD2FB527 /* v0.7 */ 181*01826a49SYabin Cui 182*01826a49SYabin Cui 183*01826a49SYabin Cui #if defined (__cplusplus) 184*01826a49SYabin Cui } 185*01826a49SYabin Cui #endif 186*01826a49SYabin Cui 187*01826a49SYabin Cui #endif /* ZSTDv07_H_235446 */ 188