2017-08-27 10:05:17 +00:00
/*
2017-06-09 01:43:56 +00:00
* Copyright ( c ) 2016 - present , Yann Collet , Facebook , Inc .
* All rights reserved .
*
2017-08-27 10:05:17 +00:00
* This source code is licensed under both the BSD - style license ( found in the
* LICENSE file in the root directory of this source tree ) and the GPLv2 ( found
* in the COPYING file in the root directory of this source tree ) .
2017-06-09 01:43:56 +00:00
*/
# ifndef ZSTDMT_COMPRESS_H
# define ZSTDMT_COMPRESS_H
# if defined (__cplusplus)
extern " C " {
# endif
2017-08-27 10:05:17 +00:00
/* Note : This is an internal API.
* Some methods are still exposed ( ZSTDLIB_API ) ,
* because it used to be the only way to invoke MT compression .
* Now , it ' s recommended to use ZSTD_compress_generic ( ) instead .
* These methods will stop being exposed in a future version */
2017-06-09 01:43:56 +00:00
/* === Dependencies === */
2017-07-22 21:46:05 +00:00
# include <stddef.h> /* size_t */
2017-06-09 01:43:56 +00:00
# define ZSTD_STATIC_LINKING_ONLY /* ZSTD_parameters */
2017-07-22 21:46:05 +00:00
# include "zstd.h" /* ZSTD_inBuffer, ZSTD_outBuffer, ZSTDLIB_API */
2017-06-09 01:43:56 +00:00
2017-07-22 21:46:05 +00:00
/* === Memory management === */
2017-06-09 01:43:56 +00:00
typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx ;
ZSTDLIB_API ZSTDMT_CCtx * ZSTDMT_createCCtx ( unsigned nbThreads ) ;
2017-07-22 21:46:05 +00:00
ZSTDLIB_API ZSTDMT_CCtx * ZSTDMT_createCCtx_advanced ( unsigned nbThreads ,
ZSTD_customMem cMem ) ;
ZSTDLIB_API size_t ZSTDMT_freeCCtx ( ZSTDMT_CCtx * mtctx ) ;
ZSTDLIB_API size_t ZSTDMT_sizeof_CCtx ( ZSTDMT_CCtx * mtctx ) ;
/* === Simple buffer-to-butter one-pass function === */
ZSTDLIB_API size_t ZSTDMT_compressCCtx ( ZSTDMT_CCtx * mtctx ,
void * dst , size_t dstCapacity ,
const void * src , size_t srcSize ,
int compressionLevel ) ;
2017-06-09 01:43:56 +00:00
/* === Streaming functions === */
ZSTDLIB_API size_t ZSTDMT_initCStream ( ZSTDMT_CCtx * mtctx , int compressionLevel ) ;
ZSTDLIB_API size_t ZSTDMT_resetCStream ( ZSTDMT_CCtx * mtctx , unsigned long long pledgedSrcSize ) ; /**< pledgedSrcSize is optional and can be zero == unknown */
ZSTDLIB_API size_t ZSTDMT_compressStream ( ZSTDMT_CCtx * mtctx , ZSTD_outBuffer * output , ZSTD_inBuffer * input ) ;
ZSTDLIB_API size_t ZSTDMT_flushStream ( ZSTDMT_CCtx * mtctx , ZSTD_outBuffer * output ) ; /**< @return : 0 == all flushed; >0 : still some data to be flushed; or an error code (ZSTD_isError()) */
ZSTDLIB_API size_t ZSTDMT_endStream ( ZSTDMT_CCtx * mtctx , ZSTD_outBuffer * output ) ; /**< @return : 0 == all flushed; >0 : still some data to be flushed; or an error code (ZSTD_isError()) */
/* === Advanced functions and parameters === */
# ifndef ZSTDMT_SECTION_SIZE_MIN
# define ZSTDMT_SECTION_SIZE_MIN (1U << 20) /* 1 MB - Minimum size of each compression job */
# endif
2017-07-22 21:46:05 +00:00
ZSTDLIB_API size_t ZSTDMT_compress_advanced ( ZSTDMT_CCtx * mtctx ,
void * dst , size_t dstCapacity ,
const void * src , size_t srcSize ,
const ZSTD_CDict * cdict ,
ZSTD_parameters const params ,
2017-08-27 10:05:17 +00:00
unsigned overlapLog ) ;
2017-07-22 21:46:05 +00:00
ZSTDLIB_API size_t ZSTDMT_initCStream_advanced ( ZSTDMT_CCtx * mtctx ,
const void * dict , size_t dictSize , /* dict can be released after init, a local copy is preserved within zcs */
ZSTD_parameters params ,
unsigned long long pledgedSrcSize ) ; /* pledgedSrcSize is optional and can be zero == unknown */
ZSTDLIB_API size_t ZSTDMT_initCStream_usingCDict ( ZSTDMT_CCtx * mtctx ,
const ZSTD_CDict * cdict ,
ZSTD_frameParameters fparams ,
unsigned long long pledgedSrcSize ) ; /* note : zero means empty */
2017-06-09 01:43:56 +00:00
/* ZSDTMT_parameter :
* List of parameters that can be set using ZSTDMT_setMTCtxParameter ( ) */
typedef enum {
ZSTDMT_p_sectionSize , /* size of input "section". Each section is compressed in parallel. 0 means default, which is dynamically determined within compression functions */
ZSTDMT_p_overlapSectionLog /* Log of overlapped section; 0 == no overlap, 6(default) == use 1/8th of window, >=9 == use full window */
} ZSDTMT_parameter ;
/* ZSTDMT_setMTCtxParameter() :
* allow setting individual parameters , one at a time , among a list of enums defined in ZSTDMT_parameter .
* The function must be called typically after ZSTD_createCCtx ( ) .
* Parameters not explicitly reset by ZSTDMT_init * ( ) remain the same in consecutive compression sessions .
* @ return : 0 , or an error code ( which can be tested using ZSTD_isError ( ) ) */
ZSTDLIB_API size_t ZSTDMT_setMTCtxParameter ( ZSTDMT_CCtx * mtctx , ZSDTMT_parameter parameter , unsigned value ) ;
2017-07-22 21:46:05 +00:00
/*! ZSTDMT_compressStream_generic() :
* Combines ZSTDMT_compressStream ( ) with ZSTDMT_flushStream ( ) or ZSTDMT_endStream ( )
* depending on flush directive .
* @ return : minimum amount of data still to be flushed
* 0 if fully flushed
* or an error code */
ZSTDLIB_API size_t ZSTDMT_compressStream_generic ( ZSTDMT_CCtx * mtctx ,
ZSTD_outBuffer * output ,
ZSTD_inBuffer * input ,
ZSTD_EndDirective endOp ) ;
2017-06-09 01:43:56 +00:00
# if defined (__cplusplus)
}
# endif
# endif /* ZSTDMT_COMPRESS_H */