zstd_v01.h File Reference

#include <stddef.h>

Go to the source code of this file.

Macros
#define	ZSTDv01_magicNumber   0xFD2FB51E /* Big Endian version */
#define	ZSTDv01_magicNumberLE   0x1EB52FFD /* Little Endian version */

Functions
size_t	ZSTDv01_decompress (void *dst, size_t maxOriginalSize, const void *src, size_t compressedSize)
void	ZSTDv01_findFrameSizeInfoLegacy (const void *src, size_t srcSize, size_t *cSize, unsigned long long *dBound)
unsigned	ZSTDv01_isError (size_t code)
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)
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)

Macro Definition Documentation

ZSTDv01_magicNumber

#define ZSTDv01_magicNumber   0xFD2FB51E /* Big Endian version */

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.

ZSTDv01_magicNumberLE

#define ZSTDv01_magicNumberLE   0x1EB52FFD /* Little Endian version */

Function Documentation

ZSTDv01_createDCtx()

ZSTDv01_Dctx * ZSTDv01_createDCtx

(

void

)

ZSTDv01_decompress()

size_t ZSTDv01_decompress	(	void *	dst,
		size_t	maxOriginalSize,
		const void *	src,
		size_t	compressedSize )

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())

ZSTDv01_decompressContinue()

size_t ZSTDv01_decompressContinue	(	ZSTDv01_Dctx *	dctx,
		void *	dst,
		size_t	maxDstSize,
		const void *	src,
		size_t	srcSize )

ZSTDv01_decompressDCtx()

size_t ZSTDv01_decompressDCtx	(	void *	ctx,
		void *	dst,
		size_t	maxOriginalSize,
		const void *	src,
		size_t	compressedSize )

ZSTDv01_findFrameSizeInfoLegacy()

void ZSTDv01_findFrameSizeInfoLegacy	(	const void *	src,
		size_t	srcSize,
		size_t *	cSize,
		unsigned long long *	dBound )

ZSTDv01_findFrameSizeInfoLegacy() : get the source length and decompressed bound of a ZSTD frame compliant with v0.1.x format srcSize : The size of the 'src' buffer, at least as large as the frame pointed to by 'src' cSize (output parameter) : the number of bytes that would be read to decompress this frame or an error code if it fails (which can be tested using ZSTDv01_isError()) dBound (output parameter) : an upper-bound for the decompressed size of the data in the frame or ZSTD_CONTENTSIZE_ERROR if an error occurs

note : assumes cSize and dBound are not NULL.

ZSTDv01_freeDCtx()

size_t ZSTDv01_freeDCtx

(

ZSTDv01_Dctx *

dctx

)

ZSTDv01_isError()

unsigned ZSTDv01_isError

(

size_t

code

)

ZSTDv01_isError() : tells if the result of ZSTDv01_decompress() is an error

ZSTDv01_nextSrcSizeToDecompress()

size_t ZSTDv01_nextSrcSizeToDecompress

(

ZSTDv01_Dctx *

dctx

)

ZSTDv01_resetDCtx()

size_t ZSTDv01_resetDCtx

(

ZSTDv01_Dctx *

dctx

)