2016-08-30 17:04:33 +00:00
|
|
|
/**
|
|
|
|
* Copyright (c) 2016-present, Przemyslaw Skibinski, Facebook, Inc.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* This source code is licensed under the BSD-style license found in the
|
|
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
|
|
*/
|
2016-05-12 15:15:41 +00:00
|
|
|
|
|
|
|
#ifndef ZSTD_ZLIBWRAPPER_H
|
|
|
|
#define ZSTD_ZLIBWRAPPER_H
|
|
|
|
|
|
|
|
#if defined (__cplusplus)
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
#define Z_PREFIX
|
|
|
|
#include <zlib.h>
|
|
|
|
|
2016-05-27 10:33:19 +00:00
|
|
|
#if !defined(z_const)
|
2016-06-02 08:19:35 +00:00
|
|
|
#if ZLIB_VERNUM >= 0x1260
|
2016-08-30 17:04:33 +00:00
|
|
|
#define z_const const
|
2016-06-02 08:19:35 +00:00
|
|
|
#else
|
|
|
|
#define z_const
|
|
|
|
#endif
|
2016-05-27 10:33:19 +00:00
|
|
|
#endif
|
2016-05-12 15:15:41 +00:00
|
|
|
|
2016-09-22 09:52:00 +00:00
|
|
|
/* returns a string with version of zstd library */
|
|
|
|
const char * zstdVersion(void);
|
|
|
|
|
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
/*** COMPRESSION ***/
|
2016-09-21 14:46:35 +00:00
|
|
|
/* enables/disables zstd compression during runtime */
|
2016-09-23 07:08:40 +00:00
|
|
|
void ZWRAP_useZSTDcompression(int turn_on);
|
2016-09-21 14:46:35 +00:00
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
/* checks if zstd compression is turned on */
|
2016-09-23 07:08:40 +00:00
|
|
|
int ZWRAP_isUsingZSTDcompression(void);
|
2016-05-12 15:15:41 +00:00
|
|
|
|
2016-09-21 15:17:29 +00:00
|
|
|
/* Changes a pledged source size for a given compression stream.
|
2016-09-22 08:23:26 +00:00
|
|
|
It will change ZSTD compression parameters what may improve compression speed and/or ratio.
|
2016-09-27 13:25:20 +00:00
|
|
|
The function should be called just after deflateInit() or deflateReset() and before deflate() or deflateSetDictionary().
|
|
|
|
It's only helpful when data is compressed in blocks.
|
|
|
|
There will be no change in case of deflateInit() or deflateReset() immediately followed by deflate(strm, Z_FINISH)
|
2016-09-26 18:49:18 +00:00
|
|
|
as this case is automatically detected. */
|
2016-09-23 07:08:40 +00:00
|
|
|
int ZWRAP_setPledgedSrcSize(z_streamp strm, unsigned long long pledgedSrcSize);
|
2016-09-21 14:46:35 +00:00
|
|
|
|
2016-09-27 15:14:04 +00:00
|
|
|
/* Similar to deflateReset but preserves dictionary set using deflateSetDictionary.
|
|
|
|
It should improve compression speed because there will be less calls to deflateSetDictionary
|
|
|
|
When using zlib compression this method redirects to deflateReset. */
|
2016-09-27 14:56:07 +00:00
|
|
|
int ZWRAP_deflateResetWithoutDict(z_streamp strm);
|
2016-05-12 15:15:41 +00:00
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
|
2016-09-27 15:14:04 +00:00
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
/*** DECOMPRESSION ***/
|
2016-09-23 07:08:40 +00:00
|
|
|
typedef enum { ZWRAP_FORCE_ZLIB, ZWRAP_AUTO } ZWRAP_decompress_type;
|
2016-09-22 09:52:00 +00:00
|
|
|
|
|
|
|
/* enables/disables automatic recognition of zstd/zlib compressed data during runtime */
|
2016-09-23 07:08:40 +00:00
|
|
|
void ZWRAP_setDecompressionType(ZWRAP_decompress_type type);
|
2016-09-22 09:52:00 +00:00
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
/* checks zstd decompression type */
|
2016-09-23 07:08:40 +00:00
|
|
|
ZWRAP_decompress_type ZWRAP_getDecompressionType(void);
|
2016-09-22 09:52:00 +00:00
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
/* checks if zstd decompression is used for a given stream */
|
|
|
|
int ZWRAP_isUsingZSTDdecompression(z_streamp strm);
|
2016-09-22 09:52:00 +00:00
|
|
|
|
2016-09-27 14:56:07 +00:00
|
|
|
/* Similar to inflateReset but preserves dictionary set using inflateSetDictionary.
|
2016-09-27 15:14:04 +00:00
|
|
|
inflate() will return Z_NEED_DICT only for the first time what will improve decompression speed.
|
|
|
|
For zlib streams this method redirects to inflateReset. */
|
2016-09-27 14:56:07 +00:00
|
|
|
int ZWRAP_inflateResetWithoutDict(z_streamp strm);
|
2016-09-22 09:52:00 +00:00
|
|
|
|
|
|
|
|
2016-05-12 15:15:41 +00:00
|
|
|
#if defined (__cplusplus)
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* ZSTD_ZLIBWRAPPER_H */
|