1*01826a49SYabin Cui /* 2*01826a49SYabin Cui * Copyright (c) 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 /* *************************************************************** 12*01826a49SYabin Cui * NOTES/WARNINGS 13*01826a49SYabin Cui ******************************************************************/ 14*01826a49SYabin Cui /* The streaming API defined here is deprecated. 15*01826a49SYabin Cui * Consider migrating towards ZSTD_compressStream() API in `zstd.h` 16*01826a49SYabin Cui * See 'lib/README.md'. 17*01826a49SYabin Cui *****************************************************************/ 18*01826a49SYabin Cui 19*01826a49SYabin Cui 20*01826a49SYabin Cui #if defined (__cplusplus) 21*01826a49SYabin Cui extern "C" { 22*01826a49SYabin Cui #endif 23*01826a49SYabin Cui 24*01826a49SYabin Cui #ifndef ZSTD_BUFFERED_H_23987 25*01826a49SYabin Cui #define ZSTD_BUFFERED_H_23987 26*01826a49SYabin Cui 27*01826a49SYabin Cui /* ************************************* 28*01826a49SYabin Cui * Dependencies 29*01826a49SYabin Cui ***************************************/ 30*01826a49SYabin Cui #include <stddef.h> /* size_t */ 31*01826a49SYabin Cui #include "../zstd.h" /* ZSTD_CStream, ZSTD_DStream, ZSTDLIB_API */ 32*01826a49SYabin Cui 33*01826a49SYabin Cui 34*01826a49SYabin Cui /* *************************************************************** 35*01826a49SYabin Cui * Compiler specifics 36*01826a49SYabin Cui *****************************************************************/ 37*01826a49SYabin Cui /* Deprecation warnings */ 38*01826a49SYabin Cui /* Should these warnings be a problem, 39*01826a49SYabin Cui * it is generally possible to disable them, 40*01826a49SYabin Cui * typically with -Wno-deprecated-declarations for gcc 41*01826a49SYabin Cui * or _CRT_SECURE_NO_WARNINGS in Visual. 42*01826a49SYabin Cui * Otherwise, it's also possible to define ZBUFF_DISABLE_DEPRECATE_WARNINGS 43*01826a49SYabin Cui */ 44*01826a49SYabin Cui #ifdef ZBUFF_DISABLE_DEPRECATE_WARNINGS 45*01826a49SYabin Cui # define ZBUFF_DEPRECATED(message) ZSTDLIB_API /* disable deprecation warnings */ 46*01826a49SYabin Cui #else 47*01826a49SYabin Cui # if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */ 48*01826a49SYabin Cui # define ZBUFF_DEPRECATED(message) [[deprecated(message)]] ZSTDLIB_API 49*01826a49SYabin Cui # elif (defined(GNUC) && (GNUC > 4 || (GNUC == 4 && GNUC_MINOR >= 5))) || defined(__clang__) 50*01826a49SYabin Cui # define ZBUFF_DEPRECATED(message) ZSTDLIB_API __attribute__((deprecated(message))) 51*01826a49SYabin Cui # elif defined(__GNUC__) && (__GNUC__ >= 3) 52*01826a49SYabin Cui # define ZBUFF_DEPRECATED(message) ZSTDLIB_API __attribute__((deprecated)) 53*01826a49SYabin Cui # elif defined(_MSC_VER) 54*01826a49SYabin Cui # define ZBUFF_DEPRECATED(message) ZSTDLIB_API __declspec(deprecated(message)) 55*01826a49SYabin Cui # else 56*01826a49SYabin Cui # pragma message("WARNING: You need to implement ZBUFF_DEPRECATED for this compiler") 57*01826a49SYabin Cui # define ZBUFF_DEPRECATED(message) ZSTDLIB_API 58*01826a49SYabin Cui # endif 59*01826a49SYabin Cui #endif /* ZBUFF_DISABLE_DEPRECATE_WARNINGS */ 60*01826a49SYabin Cui 61*01826a49SYabin Cui 62*01826a49SYabin Cui /* ************************************* 63*01826a49SYabin Cui * Streaming functions 64*01826a49SYabin Cui ***************************************/ 65*01826a49SYabin Cui /* This is the easier "buffered" streaming API, 66*01826a49SYabin Cui * using an internal buffer to lift all restrictions on user-provided buffers 67*01826a49SYabin Cui * which can be any size, any place, for both input and output. 68*01826a49SYabin Cui * ZBUFF and ZSTD are 100% interoperable, 69*01826a49SYabin Cui * frames created by one can be decoded by the other one */ 70*01826a49SYabin Cui 71*01826a49SYabin Cui typedef ZSTD_CStream ZBUFF_CCtx; 72*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_createCStream") ZBUFF_CCtx* ZBUFF_createCCtx(void); 73*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_freeCStream") size_t ZBUFF_freeCCtx(ZBUFF_CCtx* cctx); 74*01826a49SYabin Cui 75*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_initCStream") size_t ZBUFF_compressInit(ZBUFF_CCtx* cctx, int compressionLevel); 76*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_initCStream_usingDict") size_t ZBUFF_compressInitDictionary(ZBUFF_CCtx* cctx, const void* dict, size_t dictSize, int compressionLevel); 77*01826a49SYabin Cui 78*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_compressStream") size_t ZBUFF_compressContinue(ZBUFF_CCtx* cctx, void* dst, size_t* dstCapacityPtr, const void* src, size_t* srcSizePtr); 79*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_flushStream") size_t ZBUFF_compressFlush(ZBUFF_CCtx* cctx, void* dst, size_t* dstCapacityPtr); 80*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_endStream") size_t ZBUFF_compressEnd(ZBUFF_CCtx* cctx, void* dst, size_t* dstCapacityPtr); 81*01826a49SYabin Cui 82*01826a49SYabin Cui /*-************************************************* 83*01826a49SYabin Cui * Streaming compression - howto 84*01826a49SYabin Cui * 85*01826a49SYabin Cui * A ZBUFF_CCtx object is required to track streaming operation. 86*01826a49SYabin Cui * Use ZBUFF_createCCtx() and ZBUFF_freeCCtx() to create/release resources. 87*01826a49SYabin Cui * ZBUFF_CCtx objects can be reused multiple times. 88*01826a49SYabin Cui * 89*01826a49SYabin Cui * Start by initializing ZBUF_CCtx. 90*01826a49SYabin Cui * Use ZBUFF_compressInit() to start a new compression operation. 91*01826a49SYabin Cui * Use ZBUFF_compressInitDictionary() for a compression which requires a dictionary. 92*01826a49SYabin Cui * 93*01826a49SYabin Cui * Use ZBUFF_compressContinue() repetitively to consume input stream. 94*01826a49SYabin Cui * *srcSizePtr and *dstCapacityPtr can be any size. 95*01826a49SYabin Cui * The function will report how many bytes were read or written within *srcSizePtr and *dstCapacityPtr. 96*01826a49SYabin Cui * Note that it may not consume the entire input, in which case it's up to the caller to present again remaining data. 97*01826a49SYabin Cui * The content of `dst` will be overwritten (up to *dstCapacityPtr) at each call, so save its content if it matters or change @dst . 98*01826a49SYabin Cui * @return : a hint to preferred nb of bytes to use as input for next function call (it's just a hint, to improve latency) 99*01826a49SYabin Cui * or an error code, which can be tested using ZBUFF_isError(). 100*01826a49SYabin Cui * 101*01826a49SYabin Cui * At any moment, it's possible to flush whatever data remains within buffer, using ZBUFF_compressFlush(). 102*01826a49SYabin Cui * The nb of bytes written into `dst` will be reported into *dstCapacityPtr. 103*01826a49SYabin Cui * Note that the function cannot output more than *dstCapacityPtr, 104*01826a49SYabin Cui * therefore, some content might still be left into internal buffer if *dstCapacityPtr is too small. 105*01826a49SYabin Cui * @return : nb of bytes still present into internal buffer (0 if it's empty) 106*01826a49SYabin Cui * or an error code, which can be tested using ZBUFF_isError(). 107*01826a49SYabin Cui * 108*01826a49SYabin Cui * ZBUFF_compressEnd() instructs to finish a frame. 109*01826a49SYabin Cui * It will perform a flush and write frame epilogue. 110*01826a49SYabin Cui * The epilogue is required for decoders to consider a frame completed. 111*01826a49SYabin Cui * Similar to ZBUFF_compressFlush(), it may not be able to output the entire internal buffer content if *dstCapacityPtr is too small. 112*01826a49SYabin Cui * In which case, call again ZBUFF_compressFlush() to complete the flush. 113*01826a49SYabin Cui * @return : nb of bytes still present into internal buffer (0 if it's empty) 114*01826a49SYabin Cui * or an error code, which can be tested using ZBUFF_isError(). 115*01826a49SYabin Cui * 116*01826a49SYabin Cui * Hint : _recommended buffer_ sizes (not compulsory) : ZBUFF_recommendedCInSize() / ZBUFF_recommendedCOutSize() 117*01826a49SYabin Cui * input : ZBUFF_recommendedCInSize==128 KB block size is the internal unit, use this value to reduce intermediate stages (better latency) 118*01826a49SYabin Cui * output : ZBUFF_recommendedCOutSize==ZSTD_compressBound(128 KB) + 3 + 3 : ensures it's always possible to write/flush/end a full block. Skip some buffering. 119*01826a49SYabin Cui * By using both, it ensures that input will be entirely consumed, and output will always contain the result, reducing intermediate buffering. 120*01826a49SYabin Cui * **************************************************/ 121*01826a49SYabin Cui 122*01826a49SYabin Cui 123*01826a49SYabin Cui typedef ZSTD_DStream ZBUFF_DCtx; 124*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_createDStream") ZBUFF_DCtx* ZBUFF_createDCtx(void); 125*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_freeDStream") size_t ZBUFF_freeDCtx(ZBUFF_DCtx* dctx); 126*01826a49SYabin Cui 127*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_initDStream") size_t ZBUFF_decompressInit(ZBUFF_DCtx* dctx); 128*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_initDStream_usingDict") size_t ZBUFF_decompressInitDictionary(ZBUFF_DCtx* dctx, const void* dict, size_t dictSize); 129*01826a49SYabin Cui 130*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_decompressStream") size_t ZBUFF_decompressContinue(ZBUFF_DCtx* dctx, 131*01826a49SYabin Cui void* dst, size_t* dstCapacityPtr, 132*01826a49SYabin Cui const void* src, size_t* srcSizePtr); 133*01826a49SYabin Cui 134*01826a49SYabin Cui /*-*************************************************************************** 135*01826a49SYabin Cui * Streaming decompression howto 136*01826a49SYabin Cui * 137*01826a49SYabin Cui * A ZBUFF_DCtx object is required to track streaming operations. 138*01826a49SYabin Cui * Use ZBUFF_createDCtx() and ZBUFF_freeDCtx() to create/release resources. 139*01826a49SYabin Cui * Use ZBUFF_decompressInit() to start a new decompression operation, 140*01826a49SYabin Cui * or ZBUFF_decompressInitDictionary() if decompression requires a dictionary. 141*01826a49SYabin Cui * Note that ZBUFF_DCtx objects can be re-init multiple times. 142*01826a49SYabin Cui * 143*01826a49SYabin Cui * Use ZBUFF_decompressContinue() repetitively to consume your input. 144*01826a49SYabin Cui * *srcSizePtr and *dstCapacityPtr can be any size. 145*01826a49SYabin Cui * The function will report how many bytes were read or written by modifying *srcSizePtr and *dstCapacityPtr. 146*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. 147*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`. 148*01826a49SYabin Cui * @return : 0 when a frame is completely decoded and fully flushed, 149*01826a49SYabin Cui * 1 when there is still some data left within internal buffer to flush, 150*01826a49SYabin Cui * >1 when more data is expected, with value being a suggested next input size (it's just a hint, which helps latency), 151*01826a49SYabin Cui * or an error code, which can be tested using ZBUFF_isError(). 152*01826a49SYabin Cui * 153*01826a49SYabin Cui * Hint : recommended buffer sizes (not compulsory) : ZBUFF_recommendedDInSize() and ZBUFF_recommendedDOutSize() 154*01826a49SYabin Cui * output : ZBUFF_recommendedDOutSize== 128 KB block size is the internal unit, it ensures it's always possible to write a full block when decoded. 155*01826a49SYabin Cui * input : ZBUFF_recommendedDInSize == 128KB + 3; 156*01826a49SYabin Cui * just follow indications from ZBUFF_decompressContinue() to minimize latency. It should always be <= 128 KB + 3 . 157*01826a49SYabin Cui * *******************************************************************************/ 158*01826a49SYabin Cui 159*01826a49SYabin Cui 160*01826a49SYabin Cui /* ************************************* 161*01826a49SYabin Cui * Tool functions 162*01826a49SYabin Cui ***************************************/ 163*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_isError") unsigned ZBUFF_isError(size_t errorCode); 164*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_getErrorName") const char* ZBUFF_getErrorName(size_t errorCode); 165*01826a49SYabin Cui 166*01826a49SYabin Cui /** Functions below provide recommended buffer sizes for Compression or Decompression operations. 167*01826a49SYabin Cui * These sizes are just hints, they tend to offer better latency */ 168*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_CStreamInSize") size_t ZBUFF_recommendedCInSize(void); 169*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_CStreamOutSize") size_t ZBUFF_recommendedCOutSize(void); 170*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_DStreamInSize") size_t ZBUFF_recommendedDInSize(void); 171*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_DStreamOutSize") size_t ZBUFF_recommendedDOutSize(void); 172*01826a49SYabin Cui 173*01826a49SYabin Cui #endif /* ZSTD_BUFFERED_H_23987 */ 174*01826a49SYabin Cui 175*01826a49SYabin Cui 176*01826a49SYabin Cui #ifdef ZBUFF_STATIC_LINKING_ONLY 177*01826a49SYabin Cui #ifndef ZBUFF_STATIC_H_30298098432 178*01826a49SYabin Cui #define ZBUFF_STATIC_H_30298098432 179*01826a49SYabin Cui 180*01826a49SYabin Cui /* ==================================================================================== 181*01826a49SYabin Cui * The definitions in this section are considered experimental. 182*01826a49SYabin Cui * They should never be used in association with a dynamic library, as they may change in the future. 183*01826a49SYabin Cui * They are provided for advanced usages. 184*01826a49SYabin Cui * Use them only in association with static linking. 185*01826a49SYabin Cui * ==================================================================================== */ 186*01826a49SYabin Cui 187*01826a49SYabin Cui /*--- Dependency ---*/ 188*01826a49SYabin Cui #define ZSTD_STATIC_LINKING_ONLY /* ZSTD_parameters, ZSTD_customMem */ 189*01826a49SYabin Cui #include "../zstd.h" 190*01826a49SYabin Cui 191*01826a49SYabin Cui 192*01826a49SYabin Cui /*--- Custom memory allocator ---*/ 193*01826a49SYabin Cui /*! ZBUFF_createCCtx_advanced() : 194*01826a49SYabin Cui * Create a ZBUFF compression context using external alloc and free functions */ 195*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_createCStream_advanced") ZBUFF_CCtx* ZBUFF_createCCtx_advanced(ZSTD_customMem customMem); 196*01826a49SYabin Cui 197*01826a49SYabin Cui /*! ZBUFF_createDCtx_advanced() : 198*01826a49SYabin Cui * Create a ZBUFF decompression context using external alloc and free functions */ 199*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_createDStream_advanced") ZBUFF_DCtx* ZBUFF_createDCtx_advanced(ZSTD_customMem customMem); 200*01826a49SYabin Cui 201*01826a49SYabin Cui 202*01826a49SYabin Cui /*--- Advanced Streaming Initialization ---*/ 203*01826a49SYabin Cui ZBUFF_DEPRECATED("use ZSTD_initDStream_usingDict") size_t ZBUFF_compressInit_advanced(ZBUFF_CCtx* zbc, 204*01826a49SYabin Cui const void* dict, size_t dictSize, 205*01826a49SYabin Cui ZSTD_parameters params, unsigned long long pledgedSrcSize); 206*01826a49SYabin Cui 207*01826a49SYabin Cui 208*01826a49SYabin Cui #endif /* ZBUFF_STATIC_H_30298098432 */ 209*01826a49SYabin Cui #endif /* ZBUFF_STATIC_LINKING_ONLY */ 210*01826a49SYabin Cui 211*01826a49SYabin Cui 212*01826a49SYabin Cui #if defined (__cplusplus) 213*01826a49SYabin Cui } 214*01826a49SYabin Cui #endif 215