{"id":13720711,"url":"https://github.com/zephyrproject-rtos/lz4","last_synced_at":"2025-05-07T12:33:05.594Z","repository":{"id":52456462,"uuid":"340032915","full_name":"zephyrproject-rtos/lz4","owner":"zephyrproject-rtos","description":"Extremely Fast Compression algorithm","archived":false,"fork":true,"pushed_at":"2024-08-07T12:45:45.000Z","size":6084,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"zephyr","last_synced_at":"2024-11-14T10:37:32.387Z","etag":null,"topics":["compression","module"],"latest_commit_sha":null,"homepage":"http://www.lz4.org","language":"C","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"lz4/lz4","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zephyrproject-rtos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-18T11:45:21.000Z","updated_at":"2024-08-07T12:47:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/zephyrproject-rtos/lz4","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Flz4","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Flz4/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Flz4/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephyrproject-rtos%2Flz4/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zephyrproject-rtos","download_url":"https://codeload.github.com/zephyrproject-rtos/lz4/tar.gz/refs/heads/zephyr","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252876692,"owners_count":21818227,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compression","module"],"created_at":"2024-08-03T01:01:07.202Z","updated_at":"2025-05-07T12:33:04.378Z","avatar_url":"https://github.com/zephyrproject-rtos.png","language":"C","funding_links":[],"categories":["Libraries"],"sub_categories":["Misc"],"readme":"LZ4 - Extremely fast compression\n================================\n\nLZ4 is lossless compression algorithm,\nproviding compression speed \u003e 500 MB/s per core,\nscalable with multi-cores CPU.\nIt features an extremely fast decoder,\nwith speed in multiple GB/s per core,\ntypically reaching RAM speed limits on multi-core systems.\n\nSpeed can be tuned dynamically, selecting an \"acceleration\" factor\nwhich trades compression ratio for faster speed.\nOn the other end, a high compression derivative, LZ4_HC, is also provided,\ntrading CPU time for improved compression ratio.\nAll versions feature the same decompression speed.\n\nLZ4 is also compatible with [dictionary compression](https://github.com/facebook/zstd#the-case-for-small-data-compression),\nboth at [API](https://github.com/lz4/lz4/blob/v1.8.3/lib/lz4frame.h#L481) and [CLI](https://github.com/lz4/lz4/blob/v1.8.3/programs/lz4.1.md#operation-modifiers) levels.\nIt can ingest any input file as dictionary, though only the final 64KB are used.\nThis capability can be combined with the [Zstandard Dictionary Builder](https://github.com/facebook/zstd/blob/v1.3.5/programs/zstd.1.md#dictionary-builder),\nin order to drastically improve compression performance on small files.\n\n\nLZ4 library is provided as open-source software using BSD 2-Clause license.\n\n\n|Branch      |Status   |\n|------------|---------|\n|dev         | [![Build status][AppveyorDevBadge]][AppveyorLink]  |\n\n[AppveyorDevBadge]: https://ci.appveyor.com/api/projects/status/github/lz4/lz4?branch=dev\u0026svg=true \"Windows test suite\"\n[AppveyorLink]: https://ci.appveyor.com/project/YannCollet/lz4-1lndh\n\n\nBenchmarks\n-------------------------\n\nThe benchmark uses [lzbench], from @inikep\ncompiled with GCC v8.2.0 on Linux 64-bits (Ubuntu 4.18.0-17).\nThe reference system uses a Core i7-9700K CPU @ 4.9GHz (w/ turbo boost).\nBenchmark evaluates the compression of reference [Silesia Corpus]\nin single-thread mode.\n\n[lzbench]: https://github.com/inikep/lzbench\n[Silesia Corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia\n\n|  Compressor             | Ratio   | Compression | Decompression |\n|  ----------             | -----   | ----------- | ------------- |\n|  memcpy                 |  1.000  | 13700 MB/s  |  13700 MB/s   |\n|**LZ4 default (v1.9.0)** |**2.101**| **780 MB/s**| **4970 MB/s** |\n|  LZO 2.09               |  2.108  |   670 MB/s  |    860 MB/s   |\n|  QuickLZ 1.5.0          |  2.238  |   575 MB/s  |    780 MB/s   |\n|  Snappy 1.1.4           |  2.091  |   565 MB/s  |   1950 MB/s   |\n| [Zstandard] 1.4.0 -1    |  2.883  |   515 MB/s  |   1380 MB/s   |\n|  LZF v3.6               |  2.073  |   415 MB/s  |    910 MB/s   |\n| [zlib] deflate 1.2.11 -1|  2.730  |   100 MB/s  |    415 MB/s   |\n|**LZ4 HC -9 (v1.9.0)**   |**2.721**|    41 MB/s  | **4900 MB/s** |\n| [zlib] deflate 1.2.11 -6|  3.099  |    36 MB/s  |    445 MB/s   |\n\n[zlib]: http://www.zlib.net/\n[Zstandard]: http://www.zstd.net/\n\nLZ4 is also compatible and optimized for x32 mode (`-mx32`),\nfor which it provides additional speed performance.\n\n\nInstallation\n-------------------------\n\n```\nmake\nmake install     # this command may require root permissions\n```\n\nLZ4's `Makefile` supports standard [Makefile conventions],\nincluding [staged installs], [redirection], or [command redefinition].\nIt is compatible with parallel builds (`-j#`).\n\n[Makefile conventions]: https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html\n[staged installs]: https://www.gnu.org/prep/standards/html_node/DESTDIR.html\n[redirection]: https://www.gnu.org/prep/standards/html_node/Directory-Variables.html\n[command redefinition]: https://www.gnu.org/prep/standards/html_node/Utilities-in-Makefiles.html\n\n### Building LZ4 - Using vcpkg\n\nYou can download and install LZ4 using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:\n\n    git clone https://github.com/Microsoft/vcpkg.git\n    cd vcpkg\n    ./bootstrap-vcpkg.sh\n    ./vcpkg integrate install\n    ./vcpkg.exe install lz4\n\nThe LZ4 port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.\n\nDocumentation\n-------------------------\n\nThe raw LZ4 block compression format is detailed within [lz4_Block_format].\n\nArbitrarily long files or data streams are compressed using multiple blocks,\nfor streaming requirements. These blocks are organized into a frame,\ndefined into [lz4_Frame_format].\nInteroperable versions of LZ4 must also respect the frame format.\n\n[lz4_Block_format]: doc/lz4_Block_format.md\n[lz4_Frame_format]: doc/lz4_Frame_format.md\n\n\nOther source versions\n-------------------------\n\nBeyond the C reference source,\nmany contributors have created versions of lz4 in multiple languages\n(Java, C#, Python, Perl, Ruby, etc.).\nA list of known source ports is maintained on the [LZ4 Homepage].\n\n[LZ4 Homepage]: http://www.lz4.org\n\n### Packaging status\n\nMost distributions are bundled with a package manager\nwhich allows easy installation of both the `liblz4` library\nand the `lz4` command line interface.\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/lz4.svg)](https://repology.org/project/lz4/versions)\n\n\n### Special Thanks\n\n- Takayuki Matsuoka, aka @t-mat, for exceptional first-class support throughout the lifetime of this project\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephyrproject-rtos%2Flz4","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzephyrproject-rtos%2Flz4","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephyrproject-rtos%2Flz4/lists"}