diff options
| author | Eugene Kliuchnikov <eustas.ru@gmail.com> | 2020-05-15 11:06:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-15 11:06:21 +0200 |
| commit | 7f740f1308336e9ec0afdb9434896307859f5dc9 (patch) | |
| tree | 72841d92798fabcfaec0b95091420ac37c82b86f /docs | |
| parent | f83aa5169e3c09afa8db84d1180fd1fe8813118a (diff) | |
| download | brotli-7f740f1308336e9ec0afdb9434896307859f5dc9.zip brotli-7f740f1308336e9ec0afdb9434896307859f5dc9.tar.gz brotli-7f740f1308336e9ec0afdb9434896307859f5dc9.tar.bz2 | |
Update (#807)
- fix formatting
- fix type conversion
- fix no-op arithmetic with null-pointer
- improve performance of hash_longest_match64
- go: detect read after close
- java decoder: support compound dictionary
- remove executable flag on non-scripts
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/constants.h.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/constants.h.3 b/docs/constants.h.3 new file mode 100644 index 0000000..edf071c --- /dev/null +++ b/docs/constants.h.3 @@ -0,0 +1,47 @@ +.TH "constants.h" 3 "Wed May 13 2020" "Brotli" \" -*- nroff -*- +.ad l +.nh +.SH NAME +constants.h \- Common constants used in decoder and encoder API\&. + +.SH SYNOPSIS +.br +.PP +.SS "Macros" + +.in +1c +.ti -1c +.RI "#define \fBBROTLI_LARGE_MAX_DISTANCE_BITS\fP 62U" +.br +.RI "\fIThe theoretical maximum number of distance bits specified for large window brotli, for 64-bit encoders and decoders\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_LARGE_MAX_WBITS\fP 30" +.br +.RI "\fIThe maximum supported large brotli window bits by the encoder and decoder\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MAX_NPOSTFIX\fP 3" +.br +.RI "\fIMaximal number of 'postfix' bits\&. \fP" +.in -1c +.SH "Detailed Description" +.PP +Common constants used in decoder and encoder API\&. + + +.SH "Macro Definition Documentation" +.PP +.SS "#define BROTLI_LARGE_MAX_DISTANCE_BITS 62U" + +.PP +The theoretical maximum number of distance bits specified for large window brotli, for 64-bit encoders and decoders\&. Even when in practice 32-bit encoders and decoders only support up to 30 max distance bits, the value is set to 62 because it affects the large window brotli file format\&. Specifically, it affects the encoding of simple huffman tree for distances, see Specification RFC 7932 chapter 3\&.4\&. +.SS "#define BROTLI_LARGE_MAX_WBITS 30" + +.PP +The maximum supported large brotli window bits by the encoder and decoder\&. Large window brotli allows up to 62 bits, however the current encoder and decoder, designed for 32-bit integers, only support up to 30 bits maximum\&. +.SS "#define BROTLI_MAX_NPOSTFIX 3" + +.PP +Maximal number of 'postfix' bits\&. Number of 'postfix' bits is stored as 2 bits in meta-block header\&. +.SH "Author" +.PP +Generated automatically by Doxygen for Brotli from the source code\&. |