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 ZSTDv05_H 12*01826a49SYabin Cui #define ZSTDv05_H 13*01826a49SYabin Cui 14*01826a49SYabin Cui #if defined (__cplusplus) 15*01826a49SYabin Cui extern "C" { 16*01826a49SYabin Cui #endif 17*01826a49SYabin Cui 18*01826a49SYabin Cui /*-************************************* 19*01826a49SYabin Cui * Dependencies 20*01826a49SYabin Cui ***************************************/ 21*01826a49SYabin Cui #include <stddef.h> /* size_t */ 22*01826a49SYabin Cui #include "../common/mem.h" /* U64, U32 */ 23*01826a49SYabin Cui 24*01826a49SYabin Cui 25*01826a49SYabin Cui /* ************************************* 26*01826a49SYabin Cui * Simple functions 27*01826a49SYabin Cui ***************************************/ 28*01826a49SYabin Cui /*! ZSTDv05_decompress() : 29*01826a49SYabin Cui `compressedSize` : is the _exact_ size of the compressed blob, otherwise decompression will fail. 30*01826a49SYabin Cui `dstCapacity` must be large enough, equal or larger than originalSize. 31*01826a49SYabin Cui @return : the number of bytes decompressed into `dst` (<= `dstCapacity`), 32*01826a49SYabin Cui or an errorCode if it fails (which can be tested using ZSTDv05_isError()) */ 33*01826a49SYabin Cui size_t ZSTDv05_decompress( void* dst, size_t dstCapacity, 34*01826a49SYabin Cui const void* src, size_t compressedSize); 35*01826a49SYabin Cui 36*01826a49SYabin Cui /** 37*01826a49SYabin Cui ZSTDv05_findFrameSizeInfoLegacy() : get the source length and decompressed bound of a ZSTD frame compliant with v0.5.x format 38*01826a49SYabin Cui srcSize : The size of the 'src' buffer, at least as large as the frame pointed to by 'src' 39*01826a49SYabin Cui cSize (output parameter) : the number of bytes that would be read to decompress this frame 40*01826a49SYabin Cui or an error code if it fails (which can be tested using ZSTDv01_isError()) 41*01826a49SYabin Cui dBound (output parameter) : an upper-bound for the decompressed size of the data in the frame 42*01826a49SYabin Cui or ZSTD_CONTENTSIZE_ERROR if an error occurs 43*01826a49SYabin Cui 44*01826a49SYabin Cui note : assumes `cSize` and `dBound` are _not_ NULL. 45*01826a49SYabin Cui */ 46*01826a49SYabin Cui void ZSTDv05_findFrameSizeInfoLegacy(const void *src, size_t srcSize, 47*01826a49SYabin Cui size_t* cSize, unsigned long long* dBound); 48*01826a49SYabin Cui 49*01826a49SYabin Cui /* ************************************* 50*01826a49SYabin Cui * Helper functions 51*01826a49SYabin Cui ***************************************/ 52*01826a49SYabin Cui /* Error Management */ 53*01826a49SYabin Cui unsigned ZSTDv05_isError(size_t code); /*!< tells if a `size_t` function result is an error code */ 54*01826a49SYabin Cui const char* ZSTDv05_getErrorName(size_t code); /*!< provides readable string for an error code */ 55*01826a49SYabin Cui 56*01826a49SYabin Cui 57*01826a49SYabin Cui /* ************************************* 58*01826a49SYabin Cui * Explicit memory management 59*01826a49SYabin Cui ***************************************/ 60*01826a49SYabin Cui /** Decompression context */ 61*01826a49SYabin Cui typedef struct ZSTDv05_DCtx_s ZSTDv05_DCtx; 62*01826a49SYabin Cui ZSTDv05_DCtx* ZSTDv05_createDCtx(void); 63*01826a49SYabin Cui size_t ZSTDv05_freeDCtx(ZSTDv05_DCtx* dctx); /*!< @return : errorCode */ 64*01826a49SYabin Cui 65*01826a49SYabin Cui /** ZSTDv05_decompressDCtx() : 66*01826a49SYabin Cui * Same as ZSTDv05_decompress(), but requires an already allocated ZSTDv05_DCtx (see ZSTDv05_createDCtx()) */ 67*01826a49SYabin Cui size_t ZSTDv05_decompressDCtx(ZSTDv05_DCtx* ctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize); 68*01826a49SYabin Cui 69*01826a49SYabin Cui 70*01826a49SYabin Cui /*-*********************** 71*01826a49SYabin Cui * Simple Dictionary API 72*01826a49SYabin Cui *************************/ 73*01826a49SYabin Cui /*! ZSTDv05_decompress_usingDict() : 74*01826a49SYabin Cui * Decompression using a pre-defined Dictionary content (see dictBuilder). 75*01826a49SYabin Cui * Dictionary must be identical to the one used during compression, otherwise regenerated data will be corrupted. 76*01826a49SYabin Cui * Note : dict can be NULL, in which case, it's equivalent to ZSTDv05_decompressDCtx() */ 77*01826a49SYabin Cui size_t ZSTDv05_decompress_usingDict(ZSTDv05_DCtx* dctx, 78*01826a49SYabin Cui void* dst, size_t dstCapacity, 79*01826a49SYabin Cui const void* src, size_t srcSize, 80*01826a49SYabin Cui const void* dict,size_t dictSize); 81*01826a49SYabin Cui 82*01826a49SYabin Cui /*-************************ 83*01826a49SYabin Cui * Advanced Streaming API 84*01826a49SYabin Cui ***************************/ 85*01826a49SYabin Cui typedef enum { ZSTDv05_fast, ZSTDv05_greedy, ZSTDv05_lazy, ZSTDv05_lazy2, ZSTDv05_btlazy2, ZSTDv05_opt, ZSTDv05_btopt } ZSTDv05_strategy; 86*01826a49SYabin Cui typedef struct { 87*01826a49SYabin Cui U64 srcSize; 88*01826a49SYabin Cui U32 windowLog; /* the only useful information to retrieve */ 89*01826a49SYabin Cui U32 contentLog; U32 hashLog; U32 searchLog; U32 searchLength; U32 targetLength; ZSTDv05_strategy strategy; 90*01826a49SYabin Cui } ZSTDv05_parameters; 91*01826a49SYabin Cui size_t ZSTDv05_getFrameParams(ZSTDv05_parameters* params, const void* src, size_t srcSize); 92*01826a49SYabin Cui 93*01826a49SYabin Cui size_t ZSTDv05_decompressBegin_usingDict(ZSTDv05_DCtx* dctx, const void* dict, size_t dictSize); 94*01826a49SYabin Cui void ZSTDv05_copyDCtx(ZSTDv05_DCtx* dstDCtx, const ZSTDv05_DCtx* srcDCtx); 95*01826a49SYabin Cui size_t ZSTDv05_nextSrcSizeToDecompress(ZSTDv05_DCtx* dctx); 96*01826a49SYabin Cui size_t ZSTDv05_decompressContinue(ZSTDv05_DCtx* dctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize); 97*01826a49SYabin Cui 98*01826a49SYabin Cui 99*01826a49SYabin Cui /*-*********************** 100*01826a49SYabin Cui * ZBUFF API 101*01826a49SYabin Cui *************************/ 102*01826a49SYabin Cui typedef struct ZBUFFv05_DCtx_s ZBUFFv05_DCtx; 103*01826a49SYabin Cui ZBUFFv05_DCtx* ZBUFFv05_createDCtx(void); 104*01826a49SYabin Cui size_t ZBUFFv05_freeDCtx(ZBUFFv05_DCtx* dctx); 105*01826a49SYabin Cui 106*01826a49SYabin Cui size_t ZBUFFv05_decompressInit(ZBUFFv05_DCtx* dctx); 107*01826a49SYabin Cui size_t ZBUFFv05_decompressInitDictionary(ZBUFFv05_DCtx* dctx, const void* dict, size_t dictSize); 108*01826a49SYabin Cui 109*01826a49SYabin Cui size_t ZBUFFv05_decompressContinue(ZBUFFv05_DCtx* dctx, 110*01826a49SYabin Cui void* dst, size_t* dstCapacityPtr, 111*01826a49SYabin Cui const void* src, size_t* srcSizePtr); 112*01826a49SYabin Cui 113*01826a49SYabin Cui /*-*************************************************************************** 114*01826a49SYabin Cui * Streaming decompression 115*01826a49SYabin Cui * 116*01826a49SYabin Cui * A ZBUFFv05_DCtx object is required to track streaming operations. 117*01826a49SYabin Cui * Use ZBUFFv05_createDCtx() and ZBUFFv05_freeDCtx() to create/release resources. 118*01826a49SYabin Cui * Use ZBUFFv05_decompressInit() to start a new decompression operation, 119*01826a49SYabin Cui * or ZBUFFv05_decompressInitDictionary() if decompression requires a dictionary. 120*01826a49SYabin Cui * Note that ZBUFFv05_DCtx objects can be reused multiple times. 121*01826a49SYabin Cui * 122*01826a49SYabin Cui * Use ZBUFFv05_decompressContinue() repetitively to consume your input. 123*01826a49SYabin Cui * *srcSizePtr and *dstCapacityPtr can be any size. 124*01826a49SYabin Cui * The function will report how many bytes were read or written by modifying *srcSizePtr and *dstCapacityPtr. 125*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. 126*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. 127*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) 128*01826a49SYabin Cui * or 0 when a frame is completely decoded 129*01826a49SYabin Cui * or an error code, which can be tested using ZBUFFv05_isError(). 130*01826a49SYabin Cui * 131*01826a49SYabin Cui * Hint : recommended buffer sizes (not compulsory) : ZBUFFv05_recommendedDInSize() / ZBUFFv05_recommendedDOutSize() 132*01826a49SYabin Cui * output : ZBUFFv05_recommendedDOutSize==128 KB block size is the internal unit, it ensures it's always possible to write a full block when decoded. 133*01826a49SYabin Cui * input : ZBUFFv05_recommendedDInSize==128Kb+3; just follow indications from ZBUFFv05_decompressContinue() to minimize latency. It should always be <= 128 KB + 3 . 134*01826a49SYabin Cui * *******************************************************************************/ 135*01826a49SYabin Cui 136*01826a49SYabin Cui 137*01826a49SYabin Cui /* ************************************* 138*01826a49SYabin Cui * Tool functions 139*01826a49SYabin Cui ***************************************/ 140*01826a49SYabin Cui unsigned ZBUFFv05_isError(size_t errorCode); 141*01826a49SYabin Cui const char* ZBUFFv05_getErrorName(size_t errorCode); 142*01826a49SYabin Cui 143*01826a49SYabin Cui /** Functions below provide recommended buffer sizes for Compression or Decompression operations. 144*01826a49SYabin Cui * These sizes are just hints, and tend to offer better latency */ 145*01826a49SYabin Cui size_t ZBUFFv05_recommendedDInSize(void); 146*01826a49SYabin Cui size_t ZBUFFv05_recommendedDOutSize(void); 147*01826a49SYabin Cui 148*01826a49SYabin Cui 149*01826a49SYabin Cui 150*01826a49SYabin Cui /*-************************************* 151*01826a49SYabin Cui * Constants 152*01826a49SYabin Cui ***************************************/ 153*01826a49SYabin Cui #define ZSTDv05_MAGICNUMBER 0xFD2FB525 /* v0.5 */ 154*01826a49SYabin Cui 155*01826a49SYabin Cui 156*01826a49SYabin Cui 157*01826a49SYabin Cui 158*01826a49SYabin Cui #if defined (__cplusplus) 159*01826a49SYabin Cui } 160*01826a49SYabin Cui #endif 161*01826a49SYabin Cui 162*01826a49SYabin Cui #endif /* ZSTDv0505_H */ 163