diff options
| author | Eugene Kliuchnikov <eustas@google.com> | 2019-04-12 13:57:42 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-12 13:57:42 +0200 |
| commit | 4b2b2d4f83ffeaac7708e44409fe34896a01a278 (patch) | |
| tree | 04dff6010a8fad91ba93eff45a8730ed5fc40f14 /docs | |
| parent | 9cd01c0437e8b6010434d3491a348a5645de624b (diff) | |
| download | brotli-4b2b2d4f83ffeaac7708e44409fe34896a01a278.zip brotli-4b2b2d4f83ffeaac7708e44409fe34896a01a278.tar.gz brotli-4b2b2d4f83ffeaac7708e44409fe34896a01a278.tar.bz2 | |
Update (#749)
Update:
* Bazel: fix MSVC configuration
* C: common: extended documentation and helpers around distance codes
* C: common: enable BROTLI_DCHECK in "debug" builds
* C: common: fix implicit trailing zero in `kPrefixSuffix`
* C: dec: fix possible bit reader discharge for "large-window" mode
* C: dec: simplify distance decoding via lookup table
* C: dec: reuse decoder state members memory via union with lookup table
* C: dec: add decoder state diagram
* C: enc: clarify access to static dictionary
* C: enc: improve static dictionary hash
* C: enc: add "stream offset" parameter for parallel encoding
* C: enc: reorganize hasher; now Q2-Q3 require exactly 256KiB
to avoid global TCMalloc lock
* C: enc: fix rare access to uninitialized data in ring-buffer
* C: enc: reorganize logging / checks in `write_bits.h`
* Java: dec: add "large-window" support
* Java: dec: improve speed
* Java: dec: debug and 32-bit mode are now activated via system properties
* Java: dec: demystify some state variables (use better names)
* Dictionary generator: add single input mode
* Java: dec: modernize tests
* Bazel: js: pick working commit for closure rules
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/encode.h.3 | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docs/encode.h.3 b/docs/encode.h.3 index eff57bd..0cab816 100644 --- a/docs/encode.h.3 +++ b/docs/encode.h.3 @@ -298,12 +298,24 @@ Flag that determines if 'Large Window Brotli' is used\&. \fB\fIBROTLI_PARAM_NPOSTFIX \fP\fP Recommended number of postfix bits (NPOSTFIX)\&. Encoder may change this value\&. .PP -Range is from 0 to ::BROTLI_MAX_NPOSTFIX\&. +Range is from 0 to \fBBROTLI_MAX_NPOSTFIX\fP\&. .TP \fB\fIBROTLI_PARAM_NDIRECT \fP\fP Recommended number of direct distance codes (NDIRECT)\&. Encoder may change this value\&. .PP Range is from 0 to (15 << NPOSTFIX) in steps of (1 << NPOSTFIX)\&. +.TP +\fB\fIBROTLI_PARAM_STREAM_OFFSET \fP\fP +Number of bytes of input stream already processed by a different instance\&. +.PP +\fBNote:\fP +.RS 4 +It is important to configure all the encoder instances with same parameters (except this one) in order to allow all the encoded parts obey the same restrictions implied by header\&. +.RE +.PP +If offset is not 0, then stream header is omitted\&. In any case output start is byte aligned, so for proper streams stitching 'predecessor' stream must be flushed\&. +.PP +Range is not artificially limited, but all the values greater or equal to maximal window size have the same effect\&. Values greater than 2**30 are not allowed\&. .SH "Function Documentation" .PP .SS "\fBBROTLI_BOOL\fP BrotliEncoderCompress (int quality, int lgwin, \fBBrotliEncoderMode\fP mode, size_t input_size, const uint8_t input_buffer[input_size], size_t * encoded_size, uint8_t encoded_buffer[*encoded_size])" @@ -314,6 +326,8 @@ Performs one-shot memory-to-memory compression\&. Compresses the data in \fCinpu \fBNote:\fP .RS 4 If \fBBrotliEncoderMaxCompressedSize\fP(\fCinput_size\fP) returns non-zero value, then output is guaranteed to be no longer than that\&. +.PP +If \fClgwin\fP is greater than \fBBROTLI_MAX_WINDOW_BITS\fP then resulting stream might be incompatible with RFC 7932; to decode such streams, decoder should be configured with \fBBROTLI_DECODER_PARAM_LARGE_WINDOW\fP = \fC1\fP .RE .PP \fBParameters:\fP |