dictionary.h

Go to the documentation of this file.

/* Copyright 2013 Google Inc. All Rights Reserved.
 
   Distributed under MIT license.
   See file LICENSE for detail or copy at https://opensource.org/licenses/MIT
*/
 
/* Collection of static dictionary words. */
 
#ifndef BROTLI_COMMON_DICTIONARY_H_
#define BROTLI_COMMON_DICTIONARY_H_
 
#include <brotli/port.h>
#include <brotli/types.h>
 
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
 
typedef struct BrotliDictionary {
  uint8_t size_bits_by_length[32];
 
  /* assert(offset[i + 1] == offset[i] + (bits[i] ? (i << bits[i]) : 0)) */
  uint32_t offsets_by_length[32];
 
  /* assert(data_size == offsets_by_length[31]) */
  size_t data_size;
 
  /* Data array is not bound, and should obey to size_bits_by_length values.
     Specified size matches default (RFC 7932) dictionary. Its size is
     defined by data_size */
  const uint8_t* data;
} BrotliDictionary;
 
BROTLI_COMMON_API const BrotliDictionary* BrotliGetDictionary(void);
 
BROTLI_COMMON_API void BrotliSetDictionaryData(const uint8_t* data);
 
#define BROTLI_MIN_DICTIONARY_WORD_LENGTH 4
#define BROTLI_MAX_DICTIONARY_WORD_LENGTH 24
 
#if defined(__cplusplus) || defined(c_plusplus)
}  /* extern "C" */
#endif
 
#endif  /* BROTLI_COMMON_DICTIONARY_H_ */