xref: /dflybsd-src/contrib/zstd/lib/decompress/zstd_decompress_block.h (revision a28cd43d19e8b720a6c852a4bbc5ae147a26165a)
1*a28cd43dSSascha Wildner /*
2*a28cd43dSSascha Wildner  * Copyright (c) 2016-2020, Yann Collet, Facebook, Inc.
3*a28cd43dSSascha Wildner  * All rights reserved.
4*a28cd43dSSascha Wildner  *
5*a28cd43dSSascha Wildner  * This source code is licensed under both the BSD-style license (found in the
6*a28cd43dSSascha Wildner  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7*a28cd43dSSascha Wildner  * in the COPYING file in the root directory of this source tree).
8*a28cd43dSSascha Wildner  * You may select, at your option, one of the above-listed licenses.
9*a28cd43dSSascha Wildner  */
10*a28cd43dSSascha Wildner 
11*a28cd43dSSascha Wildner 
12*a28cd43dSSascha Wildner #ifndef ZSTD_DEC_BLOCK_H
13*a28cd43dSSascha Wildner #define ZSTD_DEC_BLOCK_H
14*a28cd43dSSascha Wildner 
15*a28cd43dSSascha Wildner /*-*******************************************************
16*a28cd43dSSascha Wildner  *  Dependencies
17*a28cd43dSSascha Wildner  *********************************************************/
18*a28cd43dSSascha Wildner #include "../common/zstd_deps.h"   /* size_t */
19*a28cd43dSSascha Wildner #include "../zstd.h"    /* DCtx, and some public functions */
20*a28cd43dSSascha Wildner #include "../common/zstd_internal.h"  /* blockProperties_t, and some public functions */
21*a28cd43dSSascha Wildner #include "zstd_decompress_internal.h"  /* ZSTD_seqSymbol */
22*a28cd43dSSascha Wildner 
23*a28cd43dSSascha Wildner 
24*a28cd43dSSascha Wildner /* ===   Prototypes   === */
25*a28cd43dSSascha Wildner 
26*a28cd43dSSascha Wildner /* note: prototypes already published within `zstd.h` :
27*a28cd43dSSascha Wildner  * ZSTD_decompressBlock()
28*a28cd43dSSascha Wildner  */
29*a28cd43dSSascha Wildner 
30*a28cd43dSSascha Wildner /* note: prototypes already published within `zstd_internal.h` :
31*a28cd43dSSascha Wildner  * ZSTD_getcBlockSize()
32*a28cd43dSSascha Wildner  * ZSTD_decodeSeqHeaders()
33*a28cd43dSSascha Wildner  */
34*a28cd43dSSascha Wildner 
35*a28cd43dSSascha Wildner 
36*a28cd43dSSascha Wildner /* ZSTD_decompressBlock_internal() :
37*a28cd43dSSascha Wildner  * decompress block, starting at `src`,
38*a28cd43dSSascha Wildner  * into destination buffer `dst`.
39*a28cd43dSSascha Wildner  * @return : decompressed block size,
40*a28cd43dSSascha Wildner  *           or an error code (which can be tested using ZSTD_isError())
41*a28cd43dSSascha Wildner  */
42*a28cd43dSSascha Wildner size_t ZSTD_decompressBlock_internal(ZSTD_DCtx* dctx,
43*a28cd43dSSascha Wildner                                void* dst, size_t dstCapacity,
44*a28cd43dSSascha Wildner                          const void* src, size_t srcSize, const int frame);
45*a28cd43dSSascha Wildner 
46*a28cd43dSSascha Wildner /* ZSTD_buildFSETable() :
47*a28cd43dSSascha Wildner  * generate FSE decoding table for one symbol (ll, ml or off)
48*a28cd43dSSascha Wildner  * this function must be called with valid parameters only
49*a28cd43dSSascha Wildner  * (dt is large enough, normalizedCounter distribution total is a power of 2, max is within range, etc.)
50*a28cd43dSSascha Wildner  * in which case it cannot fail.
51*a28cd43dSSascha Wildner  * The workspace must be 4-byte aligned and at least ZSTD_BUILD_FSE_TABLE_WKSP_SIZE bytes, which is
52*a28cd43dSSascha Wildner  * defined in zstd_decompress_internal.h.
53*a28cd43dSSascha Wildner  * Internal use only.
54*a28cd43dSSascha Wildner  */
55*a28cd43dSSascha Wildner void ZSTD_buildFSETable(ZSTD_seqSymbol* dt,
56*a28cd43dSSascha Wildner              const short* normalizedCounter, unsigned maxSymbolValue,
57*a28cd43dSSascha Wildner              const U32* baseValue, const U32* nbAdditionalBits,
58*a28cd43dSSascha Wildner                    unsigned tableLog, void* wksp, size_t wkspSize,
59*a28cd43dSSascha Wildner                    int bmi2);
60*a28cd43dSSascha Wildner 
61*a28cd43dSSascha Wildner 
62*a28cd43dSSascha Wildner #endif /* ZSTD_DEC_BLOCK_H */
63