zstd/decompress/zstd_decompress_block.h

0001 /*
0002  * Copyright (c) Yann Collet, Facebook, Inc.
0003  * All rights reserved.
0004  *
0005  * This source code is licensed under both the BSD-style license (found in the
0006  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
0007  * in the COPYING file in the root directory of this source tree).
0008  * You may select, at your option, one of the above-listed licenses.
0009  */
0010
0011
0012 #ifndef ZSTD_DEC_BLOCK_H
0013 #define ZSTD_DEC_BLOCK_H
0014
0015 /*-*******************************************************
0016  *  Dependencies
0017  *********************************************************/
0018 #include "../common/zstd_deps.h"   /* size_t */
0019 #include <linux/zstd.h>    /* DCtx, and some public functions */
0020 #include "../common/zstd_internal.h"  /* blockProperties_t, and some public functions */
0021 #include "zstd_decompress_internal.h"  /* ZSTD_seqSymbol */
0022
0023
0024 /* ===   Prototypes   === */
0025
0026 /* note: prototypes already published within `zstd.h` :
0027  * ZSTD_decompressBlock()
0028  */
0029
0030 /* note: prototypes already published within `zstd_internal.h` :
0031  * ZSTD_getcBlockSize()
0032  * ZSTD_decodeSeqHeaders()
0033  */
0034
0035
0036 /* ZSTD_decompressBlock_internal() :
0037  * decompress block, starting at `src`,
0038  * into destination buffer `dst`.
0039  * @return : decompressed block size,
0040  *           or an error code (which can be tested using ZSTD_isError())
0041  */
0042 size_t ZSTD_decompressBlock_internal(ZSTD_DCtx* dctx,
0043                                void* dst, size_t dstCapacity,
0044                          const void* src, size_t srcSize, const int frame);
0045
0046 /* ZSTD_buildFSETable() :
0047  * generate FSE decoding table for one symbol (ll, ml or off)
0048  * this function must be called with valid parameters only
0049  * (dt is large enough, normalizedCounter distribution total is a power of 2, max is within range, etc.)
0050  * in which case it cannot fail.
0051  * The workspace must be 4-byte aligned and at least ZSTD_BUILD_FSE_TABLE_WKSP_SIZE bytes, which is
0052  * defined in zstd_decompress_internal.h.
0053  * Internal use only.
0054  */
0055 void ZSTD_buildFSETable(ZSTD_seqSymbol* dt,
0056              const short* normalizedCounter, unsigned maxSymbolValue,
0057              const U32* baseValue, const U32* nbAdditionalBits,
0058                    unsigned tableLog, void* wksp, size_t wkspSize,
0059                    int bmi2);
0060
0061
0062 #endif /* ZSTD_DEC_BLOCK_H */