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 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
38/**
39ZSTDv01_getFrameSrcSize() : get the source length of a ZSTD frame compliant with v0.1.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 ZSTDv01_isError())
43*/
44size_t ZSTDv01_findFrameCompressedSize(const void* src, size_t compressedSize);
45
46/**
47ZSTDv01_isError() : tells if the result of ZSTDv01_decompress() is an error
48*/
49unsigned ZSTDv01_isError(size_t code);
50
51
52/* *************************************
53* Advanced functions
54***************************************/
55typedef struct ZSTDv01_Dctx_s ZSTDv01_Dctx;
56ZSTDv01_Dctx* ZSTDv01_createDCtx(void);
57size_t ZSTDv01_freeDCtx(ZSTDv01_Dctx* dctx);
58
59size_t ZSTDv01_decompressDCtx(void* ctx,
60 void* dst, size_t maxOriginalSize,
61 const void* src, size_t compressedSize);
62
63/* *************************************
64* Streaming functions
65***************************************/
66size_t ZSTDv01_resetDCtx(ZSTDv01_Dctx* dctx);
67
68size_t ZSTDv01_nextSrcSizeToDecompress(ZSTDv01_Dctx* dctx);
69size_t ZSTDv01_decompressContinue(ZSTDv01_Dctx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize);
70/**
71 Use above functions alternatively.
72 ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue().
73 ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block.
74 Result is the number of bytes regenerated within 'dst'.
75 It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header.
76*/
77
78/* *************************************
79* Prefix - version detection
80***************************************/
81#define ZSTDv01_magicNumber 0xFD2FB51E /* Big Endian version */
82#define ZSTDv01_magicNumberLE 0x1EB52FFD /* Little Endian version */
83
84
85#if defined (__cplusplus)
86}
87#endif
88
89#endif /* ZSTD_V01_H_28739879432 */
90