blob: 245f9dd314685e54710d4f77ee1bf17c9f56a757 [file] [log] [blame]
Scott Bakere7144bc2019-10-01 14:16:47 -07001/*
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 ZSTD_V01_H_28739879432
12#define ZSTD_V01_H_28739879432
13
14#if defined (__cplusplus)
15extern "C" {
16#endif
17
18/* *************************************
19* Includes
20***************************************/
21#include <stddef.h> /* size_t */
22
23
24/* *************************************
25* Simple one-step function
26***************************************/
27/**
28ZSTDv01_decompress() : decompress ZSTD frames compliant with v0.1.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*/
35size_t ZSTDv01_decompress( void* dst, size_t maxOriginalSize,
36 const void* src, size_t compressedSize);
37
Scott Bakerf579f132019-10-24 14:31:41 -070038 /**
39 ZSTDv01_findFrameSizeInfoLegacy() : get the source length and decompressed bound of a ZSTD frame compliant with v0.1.x format
40 srcSize : The size of the 'src' buffer, at least as large as the frame pointed to by 'src'
41 cSize (output parameter) : the number of bytes that would be read to decompress this frame
42 or an error code if it fails (which can be tested using ZSTDv01_isError())
43 dBound (output parameter) : an upper-bound for the decompressed size of the data in the frame
44 or ZSTD_CONTENTSIZE_ERROR if an error occurs
45
46 note : assumes `cSize` and `dBound` are _not_ NULL.
47 */
48void ZSTDv01_findFrameSizeInfoLegacy(const void *src, size_t srcSize,
49 size_t* cSize, unsigned long long* dBound);
Scott Bakere7144bc2019-10-01 14:16:47 -070050
51/**
52ZSTDv01_isError() : tells if the result of ZSTDv01_decompress() is an error
53*/
54unsigned ZSTDv01_isError(size_t code);
55
56
57/* *************************************
58* Advanced functions
59***************************************/
60typedef struct ZSTDv01_Dctx_s ZSTDv01_Dctx;
61ZSTDv01_Dctx* ZSTDv01_createDCtx(void);
62size_t ZSTDv01_freeDCtx(ZSTDv01_Dctx* dctx);
63
64size_t ZSTDv01_decompressDCtx(void* ctx,
65 void* dst, size_t maxOriginalSize,
66 const void* src, size_t compressedSize);
67
68/* *************************************
69* Streaming functions
70***************************************/
71size_t ZSTDv01_resetDCtx(ZSTDv01_Dctx* dctx);
72
73size_t ZSTDv01_nextSrcSizeToDecompress(ZSTDv01_Dctx* dctx);
74size_t ZSTDv01_decompressContinue(ZSTDv01_Dctx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize);
75/**
76 Use above functions alternatively.
77 ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue().
78 ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block.
79 Result is the number of bytes regenerated within 'dst'.
80 It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header.
81*/
82
83/* *************************************
84* Prefix - version detection
85***************************************/
86#define ZSTDv01_magicNumber 0xFD2FB51E /* Big Endian version */
87#define ZSTDv01_magicNumberLE 0x1EB52FFD /* Little Endian version */
88
89
90#if defined (__cplusplus)
91}
92#endif
93
94#endif /* ZSTD_V01_H_28739879432 */