Commit Graph

441 Commits

Author SHA1 Message Date
Joe Tsai
166edb0287 Minor formatting of Section 9.2. and Section 9.3.
Many of the fields are copy-pastes of each other, but differ slightly
in placement of words, capitalization, or other random
oddities. This commit makes it so that if you simply do a search
replace on these following passages, you get the same thing:

s/NBLTYPESX/(NBLTYPESI|NBLTYPESL|NBLTYPESD)/g
s/CATEGORY/(insert-and-copy|literal|distance)/g

>>>
   1-11 bits: NBLTYPESX, # of CATEGORY block types, encoded
              with the same variable length code as above

      Prefix code over the block type code alphabet for
         CATEGORY block types, appears only if NBLTYPESX >= 2

      Prefix code over the block count code alphabet for
         CATEGORY block counts, appears only if NBLTYPESX >= 2

      Block count code + Extra bits for first CATEGORY
         block count, appears only if NBLTYPESX >= 2
<<<

>>>
      Block type code for next CATEGORY block type, appears
         only if NBLTYPESX >= 2 and the previous CATEGORY
         block count is zero

      Block count code + extra bits for next CATEGORY
         block count, appears only if NBLTYPESX >= 2 and the
         previous CATEGORY block count is zero
<<<
2015-11-01 16:28:25 -08:00
Joe Tsai
542a8b776e Clarify Section 7.3
* Acknowledge the fact that the context map is conceptually really a
two-dimensional matrix with 2 different keys, but in reality stored
as a one-dimensional array.

* Mention that InverseMoveToFrontTransform will not cause the
context map to have invalid indexes. This gives someone implementing
a decoder sanity that they do not have to go through the context
map again and check that all values are less than NTREES.
2015-10-29 09:50:19 -07:00
Joe Tsai
ff3897df2d Clarify Section 8.
* The phrase "difference between these distances" can either refer to
the conceptual difference (i.e. they hae different semantic meaning)
or to the mathematical difference (i.e. use substraction for the two).
Instead, just remove the sentence since the equations below make it
clear what we're supposed to do here.
2015-10-29 09:44:23 -07:00
Joe Tsai
2ffe45bd67 Clarify Section 4.
* If NDIRECT is zero, then the paragraph reads "from 16 to 15", which
doesn't make much sense. Thus, add a conditional to avoid this minor
oddity.
2015-10-29 09:42:00 -07:00
Joe Tsai
185cb9eada Define the maximum number of bytes transforms may add to a word
* This value is useful in implementing the decoder since we can know
ahead-of-time what size buffer is needed to contain the output of a
transformed word.
2015-10-29 09:40:41 -07:00
Joe Tsai
6d2575eab3 Use consistent bit convention in Section 5.
* Rather than say "lower 3 bits" in one sentence and "bits 3-5" in
the sentence right after, just consistently use the same convention
and say "0-2" and "3-5".
2015-10-29 09:39:06 -07:00
Joe Tsai
0e4cb52a8b Clarify Section 7.1.
* Provide exhaustive list of all the ways the last two bytes can be
sourced from.

* Also make a clear connection in this section that there are only 64
context IDs for literals. This is important for the indexing math
in context maps to make sense.
2015-10-29 08:32:11 -07:00
Joe Tsai
6db33debac Merge pull request #1 from google/master
Sync with tip
2015-10-28 10:32:27 -07:00
szabadka
8523d36e69 Merge pull request #242 from ende76/spec_suggest_block_switch
Added note about invalid block type value in block switch commands
2015-10-27 12:19:53 +01:00
Ende
11286539a5 Removed previous change, fixed typo NBLTYPES -> NBLTYPESL #242 2015-10-27 07:07:32 -04:00
szabadka
a48c2e23e4 Merge pull request #240 from ende76/master
Added note about invalid distance values
2015-10-27 11:43:22 +01:00
szabadka
7a14e58d73 Merge pull request #241 from rockdaboot/master
Fix a few prototypes/declarations in decoder
2015-10-27 11:40:49 +01:00
Ende
d1cd34f6d9 Moved not about invalid distances up to 0-15 section 2015-10-27 06:35:30 -04:00
Tim Rühsen
b9e413faa6 Make internal decoder functions static
Affected functions: WriteRingBuffer, CopyUncompressedBlockToOutput,
                    BrotliAllocateRingBuffer
2015-10-27 11:22:16 +01:00
Ende
e544a185f9 Added note about invalid block type value 2015-10-26 16:22:28 -04:00
Tim Rühsen
f769ba85bf Fix function prototypes 2015-10-26 21:04:12 +01:00
Ende
a05fa62501 Added note about invalid distance values 2015-10-26 16:00:20 -04:00
szabadka
10522411f1 Merge pull request #239 from szabadka/master
Use uint32_t positions in the hasher and compute distances modulo 2^32.
2015-10-26 17:26:00 +01:00
Zoltan Szabadka
a89b57b90c Use uint32_t positions in the hasher and compute distances modulo 2^32. 2015-10-26 17:08:57 +01:00
szabadka
0be6b0af54 Merge pull request #238 from szabadka/master
Generate new .txt version of the spec.
2015-10-26 12:08:08 +01:00
Zoltan Szabadka
ae04a34ce5 Generate new .txt version of the spec.
Based on the changes in the .nroff source in PR #231.
2015-10-26 12:06:29 +01:00
szabadka
816153cc79 Merge pull request #231 from dsnet/master
Use consistent bit ordering and variable names
2015-10-26 12:02:36 +01:00
szabadka
6addb5ac96 Merge pull request #237 from maxnordlund/fix-markdown-not-rendering
Fix CONTRIBUTING not rendered as markdown on GitHub
2015-10-26 10:47:14 +01:00
Joe Tsai
ec8756d79c Remove note at end of section 3.1 about switching prefix conventions 2015-10-23 15:38:45 -07:00
Max Nordlund
156038be37 Fix CONTRIBUTING not rendered as markdown on GitHub 2015-10-23 20:26:30 +02:00
szabadka
87281b127c Merge pull request #235 from szabadka/master
Add more error handling to the command-line tool.
2015-10-23 13:36:18 +02:00
Zoltan Szabadka
4f94530d7d Add more error handling to the command-line tool. 2015-10-23 12:05:43 +02:00
szabadka
9f7e4ce34f Merge pull request #233 from szabadka/master
Fix integer overflow and slowness in entropy estimation.
2015-10-23 11:54:56 +02:00
Zoltan Szabadka
d2e857d83e Fix integer overflow and slowness in entropy estimation. 2015-10-23 11:19:04 +02:00
Joe Tsai
0a9f65aadc s/static prefix code/variable length code/g 2015-10-22 09:13:59 -07:00
Joe Tsai
efeb59c4a2 Placed explicit bit pattern table for MNIBBLES to avoid any doubts 2015-10-22 09:11:04 -07:00
szabadka
6ef2049279 Merge pull request #232 from MayhemYDG/patch-1
Remove useless BrotliCompressor instantiation in BrotliCompressBuffer
2015-10-22 09:59:45 +02:00
Mayhem
2a1a1f7282 Remove useless BrotliCompressor instantiation in BrotliCompressBuffer 2015-10-21 19:54:35 +02:00
Joe Tsai
c996c06e8d Use consistent bit ordering and variable names
If bit-orderings are to be parsed from left-to-right,
then make the bit-strings left-justified.
If bit-orderings are to be parsed from right-to-left,
then make the bit-strings right-justified.

Section 3.1, which describes how prefix codes work
shows prefix codes that are "left-to-right", which
is better for demonstrating how the work. However,
most of the rest of the document uses a "right-to-left"
convention. We should distinctly say at the end of
section 3.1 that we are switching conventions.

Thus, change the prefix code in section 3.5 to be
"right-to-left" to be consistent with sections 9.1
and 9.2.

Also, change the variable names in section 7.3 to
be consistent with those used in section 10.

Also, change the description of MNIBBLES to be
"MNIBBLES - 4", similar to the convention of saying
"MLEN - 1". Beforehand, the phrase
"If MNIBBLES is 0, then ..." was unclear whether it
meant MNIBBLES before the "plus 4" or after.
2015-10-20 14:54:51 -07:00
szabadka
83b8de7cb5 Merge pull request #230 from szabadka/master
Generate new .txt version of the spec.
2015-10-20 13:13:02 +02:00
Zoltan Szabadka
676bc91cc4 Generate new .txt version of the spec.
Based on the changes in the .nroff source in PR #229
2015-10-20 12:27:09 +02:00
szabadka
b7a613fd51 Merge pull request #229 from dsnet/master
Fixed minor white-space formatting and ordering of elements
2015-10-20 12:16:32 +02:00
Joe Tsai
4f1fce1681 Make code and paragraph both use 3-space indents 2015-10-20 03:02:55 -07:00
Joe Tsai
f908a4ebe4 Fix spelling of "Acknowledgments"
Made tab-space of code snippet to be 3-space instead of 2-space
2015-10-20 02:43:25 -07:00
Joe Tsai
fa1c60e35d Addressed comments about whitespace 2015-10-20 02:39:09 -07:00
Joe Tsai
1486df764e Fixed minor whitespace formatting and ordering of elements
Fixed minor whitespacing issues that caused print-out to be slightly
confusing. Biggest change is in section 9.2, where an indent seemed
to indicate that some fields were part of the previous field, when
they were not related.

Also, changed the order that transforms are described in section 8
to match the enumeration values that are explicitly defined in
Appendix B.
2015-10-19 13:53:24 -07:00
szabadka
20e838f6ad Merge pull request #228 from szabadka/master
Add a summary table of alphabet sizes to the spec.
2015-10-19 15:35:06 +02:00
Zoltan Szabadka
e92afe0737 Add a summary table of alphabet sizes to the spec.
Based on a suggestion from Thomas Pickert.
2015-10-19 14:10:58 +02:00
szabadka
2b82073492 Merge pull request #227 from szabadka/master
Create -07 version of the draft.
2015-10-19 13:23:18 +02:00
Zoltan Szabadka
2c3d8eaea3 Change the title and the expiration date of the -07 draft. 2015-10-19 12:16:00 +02:00
Zoltan Szabadka
9bc4008fa2 Create -07 version of the draft. 2015-10-19 12:15:05 +02:00
szabadka
1886f77ac7 Merge pull request #223 from szabadka/master
Remove 'static' from kBitCostThreshold declaration.
2015-10-11 13:32:54 +02:00
Zoltan Szabadka
512b9b8a3c Remove 'static' from kBitCostThreshold declaration. 2015-10-11 13:03:51 +02:00
szabadka
672f6da4d0 Merge pull request #216 from anthrotype/py35
add Python 3.5.0 support in Travis and Appveyor builds
2015-10-07 17:34:14 +02:00
Cosimo Lupo
a1d03f76ea [appveyor/install.ps1] remove unused functions for miniconda 2015-10-07 12:46:16 +01:00