summaryrefslogtreecommitdiffstats
path: root/doc/lz4_Frame_format.md
Commit message (Collapse)AuthorAgeFilesLines
* minor frame format clarificationYann Collet2022-07-101-2/+1
| | | | no need to specify that a decoder can "ignore the checksum".
* fix spellinga13460542021-08-211-4/+4
|
* updated license & header datesYann Collet2020-11-251-1/+1
|
* update docYann Collet2020-11-151-2/+2
|
* clarify endMark definitionYann Collet2020-08-141-4/+4
|
* Clarifies and fix EndMarkYann Collet2020-08-131-18/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | EndMark, the 4-bytes value indicating the end of frame, must be `0x00000000`. Previously, it was just mentioned as a `0-size` block. But such definition could encompass uncompressed blocks of size 0, with a header of value `0x80000000`. But the intention was to also support uncompressed empty blocks. They could be used as a keep-alive signal. Note that compressed empty blocks are already supported, it's just that they have a size 1 instead of 0 (for the `0` token). Unfortunately, the decoder implementation was also wrong, and would also interpret a `0x80000000` block header as an endMark. This issue evaded detection so far simply because this situation never happens, as LZ4Frame always issues a clean 0x00000000 value as a endMark. It also does not flush empty blocks. This is fixed in this PR. The decoder can now deal with empty uncompressed blocks, and do not confuse them with EndMark. The specification is also clarified. Finally, FrameTest is updated to randomly insert empty blocks during fuzzing.
* updated frame formatYann Collet2019-01-021-7/+10
| | | | | re-wording non-full blocks, for clarity.
* lz4_Frame_format.md: Fix typo HexaBytes -> ExabytesNiklas Hambüchen2018-11-241-1/+1
|
* fix typos as suggested by @psteinbYann Collet2018-01-311-2/+2
|
* proposed a minor change to LZ4 Frame format specificationYann Collet2018-01-311-4/+12
| | | | add new terms "LZ4 Frame Header" and "LZ4 Frame Footer"
* added dictID inside LZ4F_frameInfo_tYann Collet2017-08-091-2/+1
| | | | | Compressor can set dictID on LZ4F_compressBegin() Decompressor can retrieve it using LZ4F_getFrameInfo()
* updated Frame specificationYann Collet2017-08-081-25/+52
| | | | | Restored DictID field in Frame header Bumped specification version to v1.6.0
* [Doc] Fix markdownChocobo12017-05-251-2/+2
|
* documentation moved to doc/Przemyslaw Skibinski2016-11-031-0/+385