mirror of
https://github.com/facebook/zstd.git
synced 2025-10-26 00:02:22 -04:00
150 lines
6.5 KiB
C
150 lines
6.5 KiB
C
/*
|
|
zstd - standard compression library
|
|
Header File
|
|
Copyright (C) 2014-2016, 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
|
|
*/
|
|
#ifndef ZSTD_H
|
|
#define ZSTD_H
|
|
|
|
#if defined (__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*-*************************************
|
|
* Dependencies
|
|
***************************************/
|
|
#include <stddef.h> /* size_t */
|
|
|
|
|
|
/*-***************************************************************
|
|
* Export 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 6 /* for new (non-breaking) interface capabilities */
|
|
#define ZSTD_VERSION_RELEASE 0 /* 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
|
|
***************************************/
|
|
/*! ZSTD_compress() :
|
|
Compresses `srcSize` bytes from buffer `src` into buffer `dst` of size `dstCapacity`.
|
|
Destination buffer must be already allocated.
|
|
Compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
|
|
@return : the number of bytes written into `dst`,
|
|
or an error code if it fails (which can be tested using ZSTD_isError()) */
|
|
ZSTDLIB_API size_t ZSTD_compress( void* dst, size_t dstCapacity,
|
|
const void* src, size_t srcSize,
|
|
int compressionLevel);
|
|
|
|
/*! ZSTD_decompress() :
|
|
`compressedSize` : is the _exact_ size of the compressed blob, otherwise decompression will fail.
|
|
`dstCapacity` must be large enough, equal or larger than originalSize.
|
|
@return : the number of bytes decompressed into `dst` (<= `dstCapacity`),
|
|
or an errorCode if it fails (which can be tested using ZSTD_isError()) */
|
|
ZSTDLIB_API size_t ZSTD_decompress( void* dst, size_t dstCapacity,
|
|
const void* src, size_t compressedSize);
|
|
|
|
|
|
/* *************************************
|
|
* Helper 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 `size_t` function result is an error code */
|
|
ZSTDLIB_API const char* ZSTD_getErrorName(size_t code); /*!< provides readable string for an error code */
|
|
|
|
|
|
/* *************************************
|
|
* Explicit memory management
|
|
***************************************/
|
|
/** Compression context */
|
|
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); /*!< @return : errorCode */
|
|
|
|
/** ZSTD_compressCCtx() :
|
|
Same as ZSTD_compress(), but requires an already allocated ZSTD_CCtx (see ZSTD_createCCtx()) */
|
|
ZSTDLIB_API size_t ZSTD_compressCCtx(ZSTD_CCtx* ctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize, int compressionLevel);
|
|
|
|
/** Decompression context */
|
|
typedef struct ZSTD_DCtx_s ZSTD_DCtx;
|
|
ZSTDLIB_API ZSTD_DCtx* ZSTD_createDCtx(void);
|
|
ZSTDLIB_API size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx); /*!< @return : errorCode */
|
|
|
|
/** ZSTD_decompressDCtx() :
|
|
* Same as ZSTD_decompress(), but requires an already allocated ZSTD_DCtx (see ZSTD_createDCtx()) */
|
|
ZSTDLIB_API size_t ZSTD_decompressDCtx(ZSTD_DCtx* ctx, void* dst, size_t dstCapacity, const void* src, size_t srcSize);
|
|
|
|
|
|
/*-***********************
|
|
* Dictionary API
|
|
*************************/
|
|
/*! ZSTD_compress_usingDict() :
|
|
* Compression using a pre-defined Dictionary content (see dictBuilder).
|
|
* Note : dict can be NULL, in which case, it's equivalent to ZSTD_compressCCtx() */
|
|
ZSTDLIB_API size_t ZSTD_compress_usingDict(ZSTD_CCtx* ctx,
|
|
void* dst, size_t dstCapacity,
|
|
const void* src, size_t srcSize,
|
|
const void* dict,size_t dictSize,
|
|
int compressionLevel);
|
|
|
|
/*! ZSTD_decompress_usingDict() :
|
|
* Decompression using a pre-defined Dictionary content (see dictBuilder).
|
|
* Dictionary must be identical to the one used during compression, otherwise regenerated data will be corrupted.
|
|
* Note : dict can be NULL, in which case, it's equivalent to ZSTD_decompressDCtx() */
|
|
ZSTDLIB_API size_t ZSTD_decompress_usingDict(ZSTD_DCtx* dctx,
|
|
void* dst, size_t dstCapacity,
|
|
const void* src, size_t srcSize,
|
|
const void* dict,size_t dictSize);
|
|
|
|
|
|
#if defined (__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZSTD_H */
|