126 lines
4.9 KiB
C
126 lines
4.9 KiB
C
/*
|
|
zstd - standard compression library
|
|
Header File
|
|
Copyright (C) 2014-2015, Yann Collet.
|
|
|
|
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above
|
|
copyright notice, this list of conditions and the following disclaimer
|
|
in the documentation and/or other materials provided with the
|
|
distribution.
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
You can contact the author at :
|
|
- zstd source repository : https://github.com/Cyan4973/zstd
|
|
- ztsd public forum : https://groups.google.com/forum/#!forum/lz4c
|
|
*/
|
|
#ifndef ZSTD_H
|
|
#define ZSTD_H
|
|
|
|
#if defined (__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* *************************************
|
|
* Includes
|
|
***************************************/
|
|
#include <stddef.h> /* size_t */
|
|
|
|
|
|
/* ***************************************************************
|
|
* Tuning parameters
|
|
*****************************************************************/
|
|
/*!
|
|
* ZSTD_DLL_EXPORT :
|
|
* Enable exporting of functions when building a Windows DLL
|
|
*/
|
|
#if defined(_WIN32) && defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
|
|
# define ZSTDLIB_API __declspec(dllexport)
|
|
#else
|
|
# define ZSTDLIB_API
|
|
#endif
|
|
|
|
|
|
/* *************************************
|
|
* Version
|
|
***************************************/
|
|
#define ZSTD_VERSION_MAJOR 0 /* for breaking interface changes */
|
|
#define ZSTD_VERSION_MINOR 4 /* for new (non-breaking) interface capabilities */
|
|
#define ZSTD_VERSION_RELEASE 5 /* for tweaks, bug-fixes, or development */
|
|
#define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
|
|
ZSTDLIB_API unsigned ZSTD_versionNumber (void);
|
|
|
|
|
|
/* *************************************
|
|
* Simple functions
|
|
***************************************/
|
|
ZSTDLIB_API size_t ZSTD_compress( void* dst, size_t maxDstSize,
|
|
const void* src, size_t srcSize,
|
|
int compressionLevel);
|
|
|
|
ZSTDLIB_API size_t ZSTD_decompress( void* dst, size_t maxOriginalSize,
|
|
const void* src, size_t compressedSize);
|
|
|
|
/**
|
|
ZSTD_compress() :
|
|
Compresses 'srcSize' bytes from buffer 'src' into buffer 'dst', of maximum size 'dstSize'.
|
|
Destination buffer must be already allocated.
|
|
Compression runs faster if maxDstSize >= ZSTD_compressBound(srcSize).
|
|
return : the number of bytes written into buffer 'dst'
|
|
or an error code if it fails (which can be tested using ZSTD_isError())
|
|
|
|
ZSTD_decompress() :
|
|
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 (<= maxOriginalSize)
|
|
or an errorCode if it fails (which can be tested using ZSTD_isError())
|
|
*/
|
|
|
|
|
|
/* *************************************
|
|
* Tool functions
|
|
***************************************/
|
|
ZSTDLIB_API size_t ZSTD_compressBound(size_t srcSize); /** maximum compressed size (worst case scenario) */
|
|
|
|
/* Error Management */
|
|
ZSTDLIB_API unsigned ZSTD_isError(size_t code); /** tells if a return value is an error code */
|
|
ZSTDLIB_API const char* ZSTD_getErrorName(size_t code); /** provides error code string */
|
|
|
|
|
|
/* *************************************
|
|
* Advanced functions
|
|
***************************************/
|
|
typedef struct ZSTD_CCtx_s ZSTD_CCtx; /* incomplete type */
|
|
ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
|
|
ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
|
|
|
|
/**
|
|
ZSTD_compressCCtx() :
|
|
Same as ZSTD_compress(), but requires a ZSTD_CCtx working space already allocated
|
|
*/
|
|
ZSTDLIB_API size_t ZSTD_compressCCtx(ZSTD_CCtx* ctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize, int compressionLevel);
|
|
|
|
|
|
#if defined (__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZSTD_H */
|