101 lines
4.1 KiB
C
101 lines
4.1 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
|
||
|
|
*/
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#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_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
|