2 * Copyright (c) 2016-present, Facebook, Inc.
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).
10 #include <stddef.h> /* size_t */
12 /******* EXPOSED TYPES ********************************************************/
14 * Contains the parsed contents of a dictionary
15 * This includes Huffman and FSE tables used for decoding and data on offsets
17 typedef struct dictionary_s dictionary_t;
18 /******* END EXPOSED TYPES ****************************************************/
20 /******* DECOMPRESSION FUNCTIONS **********************************************/
21 /// Zstandard decompression functions.
22 /// `dst` must point to a space at least as large as the reconstructed output.
23 size_t ZSTD_decompress(void *const dst, const size_t dst_len,
24 const void *const src, const size_t src_len);
26 /// If `dict != NULL` and `dict_len >= 8`, does the same thing as
27 /// `ZSTD_decompress` but uses the provided dict
28 size_t ZSTD_decompress_with_dict(void *const dst, const size_t dst_len,
29 const void *const src, const size_t src_len,
30 dictionary_t* parsed_dict);
32 /// Get the decompressed size of an input stream so memory can be allocated in
34 /// Returns -1 if the size can't be determined
35 /// Assumes decompression of a single frame
36 size_t ZSTD_get_decompressed_size(const void *const src, const size_t src_len);
37 /******* END DECOMPRESSION FUNCTIONS ******************************************/
39 /******* DICTIONARY MANAGEMENT ***********************************************/
41 * Return a valid dictionary_t pointer for use with dictionary initialization
44 dictionary_t* create_dictionary(void);
47 * Parse a provided dictionary blob for use in decompression
48 * `src` -- must point to memory space representing the dictionary
49 * `src_len` -- must provide the dictionary size
50 * `dict` -- will contain the parsed contents of the dictionary and
51 * can be used for decompression
53 void parse_dictionary(dictionary_t *const dict, const void *src,
57 * Free internal Huffman tables, FSE tables, and dictionary content
59 void free_dictionary(dictionary_t *const dict);
60 /******* END DICTIONARY MANAGEMENT *******************************************/