mirror of
https://github.com/facebook/zstd.git
synced 2024-12-26 06:30:32 +08:00
90 lines
3.4 KiB
C
90 lines
3.4 KiB
C
/*
|
|
* 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_V01_H_28739879432
|
|
#define ZSTD_V01_H_28739879432
|
|
|
|
#if defined (__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* *************************************
|
|
* Includes
|
|
***************************************/
|
|
#include <stddef.h> /* size_t */
|
|
|
|
|
|
/* *************************************
|
|
* Simple one-step function
|
|
***************************************/
|
|
/**
|
|
ZSTDv01_decompress() : decompress ZSTD frames compliant with v0.1.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 ZSTDv01_decompress( void* dst, size_t maxOriginalSize,
|
|
const void* src, size_t compressedSize);
|
|
|
|
/**
|
|
ZSTDv01_getFrameSrcSize() : get the source length of a ZSTD frame compliant with v0.1.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 ZSTDv01_isError())
|
|
*/
|
|
size_t ZSTDv01_findFrameCompressedSize(const void* src, size_t compressedSize);
|
|
|
|
/**
|
|
ZSTDv01_isError() : tells if the result of ZSTDv01_decompress() is an error
|
|
*/
|
|
unsigned ZSTDv01_isError(size_t code);
|
|
|
|
|
|
/* *************************************
|
|
* Advanced functions
|
|
***************************************/
|
|
typedef struct ZSTDv01_Dctx_s ZSTDv01_Dctx;
|
|
ZSTDv01_Dctx* ZSTDv01_createDCtx(void);
|
|
size_t ZSTDv01_freeDCtx(ZSTDv01_Dctx* dctx);
|
|
|
|
size_t ZSTDv01_decompressDCtx(void* ctx,
|
|
void* dst, size_t maxOriginalSize,
|
|
const void* src, size_t compressedSize);
|
|
|
|
/* *************************************
|
|
* Streaming functions
|
|
***************************************/
|
|
size_t ZSTDv01_resetDCtx(ZSTDv01_Dctx* dctx);
|
|
|
|
size_t ZSTDv01_nextSrcSizeToDecompress(ZSTDv01_Dctx* dctx);
|
|
size_t ZSTDv01_decompressContinue(ZSTDv01_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 ZSTDv01_magicNumber 0xFD2FB51E /* Big Endian version */
|
|
#define ZSTDv01_magicNumberLE 0x1EB52FFD /* Little Endian version */
|
|
|
|
|
|
#if defined (__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZSTD_V01_H_28739879432 */
|