]>
Commit | Line | Data |
---|---|---|
11fdf7f2 TL |
1 | /* |
2 | * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. | |
3 | * All rights reserved. | |
4 | * | |
5 | * This source code is licensed under both the BSD-style license (found in the | |
6 | * LICENSE file in the root directory of this source tree) and the GPLv2 (found | |
7 | * in the COPYING file in the root directory of this source tree). | |
8 | * You may select, at your option, one of the above-listed licenses. | |
9 | */ | |
10 | ||
11 | #ifndef ZSTDMT_COMPRESS_H | |
12 | #define ZSTDMT_COMPRESS_H | |
13 | ||
14 | #if defined (__cplusplus) | |
15 | extern "C" { | |
16 | #endif | |
17 | ||
18 | ||
19 | /* Note : This is an internal API. | |
20 | * Some methods are still exposed (ZSTDLIB_API), | |
21 | * because it used to be the only way to invoke MT compression. | |
22 | * Now, it's recommended to use ZSTD_compress_generic() instead. | |
23 | * These methods will stop being exposed in a future version */ | |
24 | ||
25 | /* === Dependencies === */ | |
26 | #include <stddef.h> /* size_t */ | |
27 | #define ZSTD_STATIC_LINKING_ONLY /* ZSTD_parameters */ | |
28 | #include "zstd.h" /* ZSTD_inBuffer, ZSTD_outBuffer, ZSTDLIB_API */ | |
29 | ||
30 | ||
31 | /* === Memory management === */ | |
32 | typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx; | |
33 | ZSTDLIB_API ZSTDMT_CCtx* ZSTDMT_createCCtx(unsigned nbThreads); | |
34 | ZSTDLIB_API ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbThreads, | |
35 | ZSTD_customMem cMem); | |
36 | ZSTDLIB_API size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx); | |
37 | ||
38 | ZSTDLIB_API size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx); | |
39 | ||
40 | ||
41 | /* === Simple buffer-to-butter one-pass function === */ | |
42 | ||
43 | ZSTDLIB_API size_t ZSTDMT_compressCCtx(ZSTDMT_CCtx* mtctx, | |
44 | void* dst, size_t dstCapacity, | |
45 | const void* src, size_t srcSize, | |
46 | int compressionLevel); | |
47 | ||
48 | ||
49 | ||
50 | /* === Streaming functions === */ | |
51 | ||
52 | ZSTDLIB_API size_t ZSTDMT_initCStream(ZSTDMT_CCtx* mtctx, int compressionLevel); | |
53 | ZSTDLIB_API size_t ZSTDMT_resetCStream(ZSTDMT_CCtx* mtctx, unsigned long long pledgedSrcSize); /**< pledgedSrcSize is optional and can be zero == unknown */ | |
54 | ||
55 | ZSTDLIB_API size_t ZSTDMT_compressStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output, ZSTD_inBuffer* input); | |
56 | ||
57 | 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()) */ | |
58 | 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()) */ | |
59 | ||
60 | ||
61 | /* === Advanced functions and parameters === */ | |
62 | ||
63 | #ifndef ZSTDMT_SECTION_SIZE_MIN | |
64 | # define ZSTDMT_SECTION_SIZE_MIN (1U << 20) /* 1 MB - Minimum size of each compression job */ | |
65 | #endif | |
66 | ||
67 | ZSTDLIB_API size_t ZSTDMT_compress_advanced(ZSTDMT_CCtx* mtctx, | |
68 | void* dst, size_t dstCapacity, | |
69 | const void* src, size_t srcSize, | |
70 | const ZSTD_CDict* cdict, | |
71 | ZSTD_parameters const params, | |
72 | unsigned overlapLog); | |
73 | ||
74 | ZSTDLIB_API size_t ZSTDMT_initCStream_advanced(ZSTDMT_CCtx* mtctx, | |
75 | const void* dict, size_t dictSize, /* dict can be released after init, a local copy is preserved within zcs */ | |
76 | ZSTD_parameters params, | |
77 | unsigned long long pledgedSrcSize); /* pledgedSrcSize is optional and can be zero == unknown */ | |
78 | ||
79 | ZSTDLIB_API size_t ZSTDMT_initCStream_usingCDict(ZSTDMT_CCtx* mtctx, | |
80 | const ZSTD_CDict* cdict, | |
81 | ZSTD_frameParameters fparams, | |
82 | unsigned long long pledgedSrcSize); /* note : zero means empty */ | |
83 | ||
84 | /* ZSTDMT_parameter : | |
85 | * List of parameters that can be set using ZSTDMT_setMTCtxParameter() */ | |
86 | typedef enum { | |
87 | ZSTDMT_p_sectionSize, /* size of input "section". Each section is compressed in parallel. 0 means default, which is dynamically determined within compression functions */ | |
88 | ZSTDMT_p_overlapSectionLog /* Log of overlapped section; 0 == no overlap, 6(default) == use 1/8th of window, >=9 == use full window */ | |
89 | } ZSTDMT_parameter; | |
90 | ||
91 | /* ZSTDMT_setMTCtxParameter() : | |
92 | * allow setting individual parameters, one at a time, among a list of enums defined in ZSTDMT_parameter. | |
93 | * The function must be called typically after ZSTD_createCCtx(). | |
94 | * Parameters not explicitly reset by ZSTDMT_init*() remain the same in consecutive compression sessions. | |
95 | * @return : 0, or an error code (which can be tested using ZSTD_isError()) */ | |
96 | ZSTDLIB_API size_t ZSTDMT_setMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, unsigned value); | |
97 | ||
98 | ||
99 | /*! ZSTDMT_compressStream_generic() : | |
100 | * Combines ZSTDMT_compressStream() with ZSTDMT_flushStream() or ZSTDMT_endStream() | |
101 | * depending on flush directive. | |
102 | * @return : minimum amount of data still to be flushed | |
103 | * 0 if fully flushed | |
104 | * or an error code */ | |
105 | ZSTDLIB_API size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx, | |
106 | ZSTD_outBuffer* output, | |
107 | ZSTD_inBuffer* input, | |
108 | ZSTD_EndDirective endOp); | |
109 | ||
110 | ||
111 | /* === Private definitions; never ever use directly === */ | |
112 | ||
113 | size_t ZSTDMT_CCtxParam_setMTCtxParameter(ZSTD_CCtx_params* params, ZSTDMT_parameter parameter, unsigned value); | |
114 | ||
115 | size_t ZSTDMT_initializeCCtxParameters(ZSTD_CCtx_params* params, unsigned nbThreads); | |
116 | ||
117 | /*! ZSTDMT_initCStream_internal() : | |
118 | * Private use only. Init streaming operation. | |
119 | * expects params to be valid. | |
120 | * must receive dict, or cdict, or none, but not both. | |
121 | * @return : 0, or an error code */ | |
122 | size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* zcs, | |
123 | const void* dict, size_t dictSize, ZSTD_dictMode_e dictMode, | |
124 | const ZSTD_CDict* cdict, | |
125 | ZSTD_CCtx_params params, unsigned long long pledgedSrcSize); | |
126 | ||
127 | ||
128 | #if defined (__cplusplus) | |
129 | } | |
130 | #endif | |
131 | ||
132 | #endif /* ZSTDMT_COMPRESS_H */ |