]>
Commit | Line | Data |
---|---|---|
11fdf7f2 | 1 | /* |
7c673cae FG |
2 | * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. |
3 | * All rights reserved. | |
4 | * | |
11fdf7f2 TL |
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. | |
7c673cae FG |
9 | */ |
10 | ||
11 | #ifndef ZSTD_V04_H_91868324769238 | |
12 | #define ZSTD_V04_H_91868324769238 | |
13 | ||
14 | #if defined (__cplusplus) | |
15 | extern "C" { | |
16 | #endif | |
17 | ||
18 | /* ************************************* | |
19 | * Includes | |
20 | ***************************************/ | |
21 | #include <stddef.h> /* size_t */ | |
22 | ||
23 | ||
24 | /* ************************************* | |
25 | * Simple one-step function | |
26 | ***************************************/ | |
27 | /** | |
28 | ZSTDv04_decompress() : decompress ZSTD frames compliant with v0.4.x format | |
29 | compressedSize : is the exact source size | |
30 | maxOriginalSize : is the size of the 'dst' buffer, which must be already allocated. | |
31 | It must be equal or larger than originalSize, otherwise decompression will fail. | |
32 | return : the number of bytes decompressed into destination buffer (originalSize) | |
33 | or an errorCode if it fails (which can be tested using ZSTDv01_isError()) | |
34 | */ | |
35 | size_t ZSTDv04_decompress( void* dst, size_t maxOriginalSize, | |
36 | const void* src, size_t compressedSize); | |
37 | ||
11fdf7f2 TL |
38 | /** |
39 | ZSTDv04_getFrameSrcSize() : get the source length of a ZSTD frame compliant with v0.4.x format | |
40 | compressedSize : The size of the 'src' buffer, at least as large as the frame pointed to by 'src' | |
41 | return : the number of bytes that would be read to decompress this frame | |
42 | or an errorCode if it fails (which can be tested using ZSTDv04_isError()) | |
43 | */ | |
44 | size_t ZSTDv04_findFrameCompressedSize(const void* src, size_t compressedSize); | |
45 | ||
7c673cae FG |
46 | /** |
47 | ZSTDv04_isError() : tells if the result of ZSTDv04_decompress() is an error | |
48 | */ | |
49 | unsigned ZSTDv04_isError(size_t code); | |
50 | ||
51 | ||
52 | /* ************************************* | |
53 | * Advanced functions | |
54 | ***************************************/ | |
55 | typedef struct ZSTDv04_Dctx_s ZSTDv04_Dctx; | |
56 | ZSTDv04_Dctx* ZSTDv04_createDCtx(void); | |
57 | size_t ZSTDv04_freeDCtx(ZSTDv04_Dctx* dctx); | |
58 | ||
59 | size_t ZSTDv04_decompressDCtx(ZSTDv04_Dctx* dctx, | |
60 | void* dst, size_t maxOriginalSize, | |
61 | const void* src, size_t compressedSize); | |
62 | ||
63 | ||
64 | /* ************************************* | |
65 | * Direct Streaming | |
66 | ***************************************/ | |
67 | size_t ZSTDv04_resetDCtx(ZSTDv04_Dctx* dctx); | |
68 | ||
69 | size_t ZSTDv04_nextSrcSizeToDecompress(ZSTDv04_Dctx* dctx); | |
70 | size_t ZSTDv04_decompressContinue(ZSTDv04_Dctx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize); | |
71 | /** | |
72 | Use above functions alternatively. | |
73 | ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue(). | |
74 | ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block. | |
75 | Result is the number of bytes regenerated within 'dst'. | |
76 | It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header. | |
77 | */ | |
78 | ||
79 | ||
80 | /* ************************************* | |
81 | * Buffered Streaming | |
82 | ***************************************/ | |
83 | typedef struct ZBUFFv04_DCtx_s ZBUFFv04_DCtx; | |
84 | ZBUFFv04_DCtx* ZBUFFv04_createDCtx(void); | |
85 | size_t ZBUFFv04_freeDCtx(ZBUFFv04_DCtx* dctx); | |
86 | ||
87 | size_t ZBUFFv04_decompressInit(ZBUFFv04_DCtx* dctx); | |
88 | size_t ZBUFFv04_decompressWithDictionary(ZBUFFv04_DCtx* dctx, const void* dict, size_t dictSize); | |
89 | ||
90 | size_t ZBUFFv04_decompressContinue(ZBUFFv04_DCtx* dctx, void* dst, size_t* maxDstSizePtr, const void* src, size_t* srcSizePtr); | |
91 | ||
92 | /** ************************************************ | |
93 | * Streaming decompression | |
94 | * | |
95 | * A ZBUFF_DCtx object is required to track streaming operation. | |
96 | * Use ZBUFF_createDCtx() and ZBUFF_freeDCtx() to create/release resources. | |
97 | * Use ZBUFF_decompressInit() to start a new decompression operation. | |
98 | * ZBUFF_DCtx objects can be reused multiple times. | |
99 | * | |
100 | * Optionally, a reference to a static dictionary can be set, using ZBUFF_decompressWithDictionary() | |
101 | * It must be the same content as the one set during compression phase. | |
102 | * Dictionary content must remain accessible during the decompression process. | |
103 | * | |
104 | * Use ZBUFF_decompressContinue() repetitively to consume your input. | |
105 | * *srcSizePtr and *maxDstSizePtr can be any size. | |
106 | * The function will report how many bytes were read or written by modifying *srcSizePtr and *maxDstSizePtr. | |
107 | * Note that it may not consume the entire input, in which case it's up to the caller to present remaining input again. | |
108 | * The content of dst will be overwritten (up to *maxDstSizePtr) at each function call, so save its content if it matters or change dst. | |
109 | * @return : a hint to preferred nb of bytes to use as input for next function call (it's only a hint, to improve latency) | |
110 | * or 0 when a frame is completely decoded | |
111 | * or an error code, which can be tested using ZBUFF_isError(). | |
112 | * | |
113 | * Hint : recommended buffer sizes (not compulsory) : ZBUFF_recommendedDInSize / ZBUFF_recommendedDOutSize | |
114 | * output : ZBUFF_recommendedDOutSize==128 KB block size is the internal unit, it ensures it's always possible to write a full block when it's decoded. | |
115 | * input : ZBUFF_recommendedDInSize==128Kb+3; just follow indications from ZBUFF_decompressContinue() to minimize latency. It should always be <= 128 KB + 3 . | |
116 | * **************************************************/ | |
117 | unsigned ZBUFFv04_isError(size_t errorCode); | |
118 | const char* ZBUFFv04_getErrorName(size_t errorCode); | |
119 | ||
120 | ||
121 | /** The below functions provide recommended buffer sizes for Compression or Decompression operations. | |
122 | * These sizes are not compulsory, they just tend to offer better latency */ | |
123 | size_t ZBUFFv04_recommendedDInSize(void); | |
124 | size_t ZBUFFv04_recommendedDOutSize(void); | |
125 | ||
126 | ||
127 | /* ************************************* | |
128 | * Prefix - version detection | |
129 | ***************************************/ | |
130 | #define ZSTDv04_magicNumber 0xFD2FB524 /* v0.4 */ | |
131 | ||
132 | ||
133 | #if defined (__cplusplus) | |
134 | } | |
135 | #endif | |
136 | ||
137 | #endif /* ZSTD_V04_H_91868324769238 */ |