12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788 |
- /*
- * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under both the BSD-style license (found in the
- * LICENSE file in the root directory of this source tree) and the GPLv2 (found
- * in the COPYING file in the root directory of this source tree).
- * You may select, at your option, one of the above-listed licenses.
- */
- #ifndef ZSTD_V02_H_4174539423
- #define ZSTD_V02_H_4174539423
- #if defined (__cplusplus)
- extern "C" {
- #endif
- /* *************************************
- * Includes
- ***************************************/
- #include <stddef.h> /* size_t */
- /* *************************************
- * Simple one-step function
- ***************************************/
- /**
- ZSTDv02_decompress() : decompress ZSTD frames compliant with v0.2.x format
- compressedSize : is the exact source size
- maxOriginalSize : is the size of the 'dst' buffer, which must be already allocated.
- It must be equal or larger than originalSize, otherwise decompression will fail.
- return : the number of bytes decompressed into destination buffer (originalSize)
- or an errorCode if it fails (which can be tested using ZSTDv01_isError())
- */
- size_t ZSTDv02_decompress( void* dst, size_t maxOriginalSize,
- const void* src, size_t compressedSize);
- /**
- ZSTDv02_getFrameSrcSize() : get the source length of a ZSTD frame compliant with v0.2.x format
- compressedSize : The size of the 'src' buffer, at least as large as the frame pointed to by 'src'
- return : the number of bytes that would be read to decompress this frame
- or an errorCode if it fails (which can be tested using ZSTDv02_isError())
- */
- size_t ZSTDv02_findFrameCompressedSize(const void* src, size_t compressedSize);
- /**
- ZSTDv02_isError() : tells if the result of ZSTDv02_decompress() is an error
- */
- unsigned ZSTDv02_isError(size_t code);
- /* *************************************
- * Advanced functions
- ***************************************/
- typedef struct ZSTDv02_Dctx_s ZSTDv02_Dctx;
- ZSTDv02_Dctx* ZSTDv02_createDCtx(void);
- size_t ZSTDv02_freeDCtx(ZSTDv02_Dctx* dctx);
- size_t ZSTDv02_decompressDCtx(void* ctx,
- void* dst, size_t maxOriginalSize,
- const void* src, size_t compressedSize);
- /* *************************************
- * Streaming functions
- ***************************************/
- size_t ZSTDv02_resetDCtx(ZSTDv02_Dctx* dctx);
- size_t ZSTDv02_nextSrcSizeToDecompress(ZSTDv02_Dctx* dctx);
- size_t ZSTDv02_decompressContinue(ZSTDv02_Dctx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize);
- /**
- Use above functions alternatively.
- ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue().
- ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block.
- Result is the number of bytes regenerated within 'dst'.
- It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header.
- */
- /* *************************************
- * Prefix - version detection
- ***************************************/
- #define ZSTDv02_magicNumber 0xFD2FB522 /* v0.2 */
- #if defined (__cplusplus)
- }
- #endif
- #endif /* ZSTD_V02_H_4174539423 */
|