1 /*
2  * Copyright (c) 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_DEC_BLOCK_H
12 #define ZSTD_DEC_BLOCK_H
13 
14 /*-*******************************************************
15  *  Dependencies
16  *********************************************************/
17 #include "../common/zstd_deps.h"   /* size_t */
18 #include <linux/zstd.h>    /* DCtx, and some public functions */
19 #include "../common/zstd_internal.h"  /* blockProperties_t, and some public functions */
20 #include "zstd_decompress_internal.h"  /* ZSTD_seqSymbol */
21 
22 /* ===   Prototypes   === */
23 
24 /* note: prototypes already published within `zstd.h` :
25  * ZSTD_decompressBlock()
26  */
27 
28 /* note: prototypes already published within `zstd_internal.h` :
29  * ZSTD_getcBlockSize()
30  * ZSTD_decodeSeqHeaders()
31  */
32 
33  /* Streaming state is used to inform allocation of the literal buffer */
34 typedef enum {
35     not_streaming = 0,
36     is_streaming = 1
37 } streaming_operation;
38 
39 /* ZSTD_decompressBlock_internal() :
40  * decompress block, starting at `src`,
41  * into destination buffer `dst`.
42  * @return : decompressed block size,
43  *           or an error code (which can be tested using ZSTD_isError())
44  */
45 size_t ZSTD_decompressBlock_internal(ZSTD_DCtx* dctx,
46                                void* dst, size_t dstCapacity,
47                          const void* src, size_t srcSize, const int frame, const streaming_operation streaming);
48 
49 /* ZSTD_buildFSETable() :
50  * generate FSE decoding table for one symbol (ll, ml or off)
51  * this function must be called with valid parameters only
52  * (dt is large enough, normalizedCounter distribution total is a power of 2, max is within range, etc.)
53  * in which case it cannot fail.
54  * The workspace must be 4-byte aligned and at least ZSTD_BUILD_FSE_TABLE_WKSP_SIZE bytes, which is
55  * defined in zstd_decompress_internal.h.
56  * Internal use only.
57  */
58 void ZSTD_buildFSETable(ZSTD_seqSymbol* dt,
59              const short* normalizedCounter, unsigned maxSymbolValue,
60              const U32* baseValue, const U8* nbAdditionalBits,
61                    unsigned tableLog, void* wksp, size_t wkspSize,
62                    int bmi2);
63 
64 #endif /* ZSTD_DEC_BLOCK_H */
65