From 9aff46039f9cab28b4b1f1baa16f9b43cd53d79b Mon Sep 17 00:00:00 2001 From: milesgranger Date: Wed, 31 Mar 2021 23:02:27 +0200 Subject: [PATCH 1/5] Initial prototype --- Cargo.toml | 1 + Makefile | 3 ++ benchmarks/test_bench.py | 21 ++++++++++++++ src/lib.rs | 2 ++ src/lzo.rs | 61 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 88 insertions(+) create mode 100644 src/lzo.rs diff --git a/Cargo.toml b/Cargo.toml index bb8751b6..c1ca81fe 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -29,6 +29,7 @@ lz4 = "^1" flate2 = "^1" zstd = "0.6.1+zstd.1.4.9" numpy = "0.13.0" +minilzo3 = { path = "../minilzo-rs" } [dependencies.mimalloc] version = "0.1.24" diff --git a/Makefile b/Makefile index 857adc95..3eb6bf34 100644 --- a/Makefile +++ b/Makefile @@ -27,6 +27,9 @@ bench-brotli: bench-zstd: $(BASE_BENCH_CMD) zstd +bench-lzo: + $(BASE_BENCH_CMD) lzo + dev-install: rm -rf ./dist maturin build --release --out dist --no-sdist --interpreter $(shell which python) diff --git a/benchmarks/test_bench.py b/benchmarks/test_bench.py index 2151afd0..99752c8d 100644 --- a/benchmarks/test_bench.py +++ b/benchmarks/test_bench.py @@ -223,6 +223,27 @@ def test_zstd(benchmark, file, use_cramjam: bool): ) +@pytest.mark.parametrize( + "use_cramjam", (True, False), ids=lambda val: "cramjam" if val else "lzo" +) +@pytest.mark.parametrize("file", FILES, ids=lambda val: val.name) +def test_lzo(benchmark, file, use_cramjam: bool): + import lzo + + data = file.read_bytes() + if use_cramjam: + benchmark( + round_trip, + compress=cramjam.lzo.compress, + decompress=cramjam.lzo.decompress, + data=data, + ) + else: + benchmark( + round_trip, compress=lzo.compress, decompress=lzo.decompress, data=data, + ) + + @profile def memory_profile(): diff --git a/src/lib.rs b/src/lib.rs index 1304cc79..1eed2201 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -59,6 +59,7 @@ pub mod io; pub mod lz4; pub mod snappy; pub mod zstd; +pub mod lzo; use pyo3::prelude::*; @@ -239,6 +240,7 @@ fn cramjam(py: Python, m: &PyModule) -> PyResult<()> { make_submodule!(py -> m -> gzip); make_submodule!(py -> m -> deflate); make_submodule!(py -> m -> zstd); + make_submodule!(py -> m -> lzo); Ok(()) } diff --git a/src/lzo.rs b/src/lzo.rs new file mode 100644 index 00000000..b17507e0 --- /dev/null +++ b/src/lzo.rs @@ -0,0 +1,61 @@ +//! snappy de/compression interface +use crate::exceptions::{CompressionError, DecompressionError}; +use crate::io::{AsBytes, RustyBuffer}; +use crate::{to_py_err, BytesType}; +use pyo3::prelude::*; +use pyo3::wrap_pyfunction; +use pyo3::PyResult; + +pub(crate) fn init_py_module(m: &PyModule) -> PyResult<()> { + m.add_function(wrap_pyfunction!(compress, m)?)?; + m.add_function(wrap_pyfunction!(decompress, m)?)?; + m.add_function(wrap_pyfunction!(compress_into, m)?)?; + m.add_function(wrap_pyfunction!(decompress_into, m)?)?; + Ok(()) +} + +/// LZO decompression +/// +/// Python Example +/// -------------- +/// ```python +/// >>> cramjam.lzo.decompress(compressed_raw_bytes) +/// ``` +#[pyfunction] +#[allow(unused_variables)] +pub fn decompress(data: BytesType, output_len: Option) -> PyResult { + let output = to_py_err!(DecompressionError -> minilzo3::decompress_vec(data.as_bytes()))?; + Ok(RustyBuffer::from(output)) +} + +/// LZO compression +/// +/// This follows the header format of `python-lzo` where the first byte indicates if it's level 1 +/// compression (default; and only one implemented here thus far) and the next four bytes are +/// u32 big endian formatted bytes indicating the length of the original input, before compression. +/// +/// Python Example +/// -------------- +/// ```python +/// >>> cramjam.lzo.compress(b'some bytes here') +/// ``` +#[pyfunction] +#[allow(unused_variables)] +pub fn compress(data: BytesType, output_len: Option) -> PyResult { + let output = to_py_err!(CompressionError -> minilzo3::compress_vec(data.as_bytes(), true))?; + Ok(RustyBuffer::from(output)) +} + +/// Compress raw format directly into an output buffer +#[pyfunction] +pub fn compress_into(input: BytesType, mut output: BytesType) -> PyResult { + let output = minilzo3::compress(input.as_bytes(), output.as_bytes_mut(), true); + to_py_err!(CompressionError -> output) +} + +/// Decompress raw format directly into an output buffer +#[pyfunction] +pub fn decompress_into(input: BytesType, mut output: BytesType) -> PyResult { + let output = minilzo3::decompress(input.as_bytes(), output.as_bytes_mut()); + to_py_err!(DecompressionError -> output) +} From d0f492d4f784f45783feff549ac5c19d00ed8faf Mon Sep 17 00:00:00 2001 From: milesgranger Date: Wed, 31 Mar 2021 23:10:15 +0200 Subject: [PATCH 2/5] Wrap LZO in feature flag --- Cargo.toml | 5 +++-- src/lib.rs | 4 ++++ src/lzo.rs | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index c1ca81fe..e8a04da7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,8 +12,9 @@ readme = "README.md" crate-type = ["cdylib"] [features] -default = ["mimallocator", "extension-module"] +default = ["mimallocator", "extension-module", "lzo"] mimallocator = ["mimalloc"] +lzo = ["minilzo3"] extension-module = ["pyo3/extension-module"] [profile.release] @@ -29,7 +30,7 @@ lz4 = "^1" flate2 = "^1" zstd = "0.6.1+zstd.1.4.9" numpy = "0.13.0" -minilzo3 = { path = "../minilzo-rs" } +minilzo3 = { path = "../minilzo-rs", optional = true } [dependencies.mimalloc] version = "0.1.24" diff --git a/src/lib.rs b/src/lib.rs index 1eed2201..4067cded 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -59,6 +59,8 @@ pub mod io; pub mod lz4; pub mod snappy; pub mod zstd; + +#[cfg(feature = "lzo")] pub mod lzo; use pyo3::prelude::*; @@ -240,6 +242,8 @@ fn cramjam(py: Python, m: &PyModule) -> PyResult<()> { make_submodule!(py -> m -> gzip); make_submodule!(py -> m -> deflate); make_submodule!(py -> m -> zstd); + + #[cfg(feature = "lzo")] make_submodule!(py -> m -> lzo); Ok(()) diff --git a/src/lzo.rs b/src/lzo.rs index b17507e0..07f77f6b 100644 --- a/src/lzo.rs +++ b/src/lzo.rs @@ -1,4 +1,4 @@ -//! snappy de/compression interface +//! lzo de/compression interface use crate::exceptions::{CompressionError, DecompressionError}; use crate::io::{AsBytes, RustyBuffer}; use crate::{to_py_err, BytesType}; From 300e2c493fe918fbb80187abb9430454bb99fd15 Mon Sep 17 00:00:00 2001 From: milesgranger Date: Wed, 31 Mar 2021 23:31:24 +0200 Subject: [PATCH 3/5] update config wraps and remove lzo as default feature --- Cargo.toml | 4 ++-- src/lib.rs | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index e8a04da7..0fecd403 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,7 +12,7 @@ readme = "README.md" crate-type = ["cdylib"] [features] -default = ["mimallocator", "extension-module", "lzo"] +default = ["mimallocator", "extension-module"] mimallocator = ["mimalloc"] lzo = ["minilzo3"] extension-module = ["pyo3/extension-module"] @@ -30,7 +30,7 @@ lz4 = "^1" flate2 = "^1" zstd = "0.6.1+zstd.1.4.9" numpy = "0.13.0" -minilzo3 = { path = "../minilzo-rs", optional = true } +minilzo3 = { git = "https://github.com/milesgranger/minilzo3.git", optional = true, version = "0.1.0" } [dependencies.mimalloc] version = "0.1.24" diff --git a/src/lib.rs b/src/lib.rs index 4067cded..52f8638a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -61,6 +61,7 @@ pub mod snappy; pub mod zstd; #[cfg(feature = "lzo")] +#[cfg(not(target_os = "windows"))] pub mod lzo; use pyo3::prelude::*; @@ -244,6 +245,7 @@ fn cramjam(py: Python, m: &PyModule) -> PyResult<()> { make_submodule!(py -> m -> zstd); #[cfg(feature = "lzo")] + #[cfg(not(target_os = "windows"))] make_submodule!(py -> m -> lzo); Ok(()) From 42d4b3421b1079ac9b06cbb8165f633dc3d841a9 Mon Sep 17 00:00:00 2001 From: milesgranger Date: Wed, 31 Mar 2021 23:34:57 +0200 Subject: [PATCH 4/5] Add benchmarks for lzo --- benchmarks/README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/benchmarks/README.md b/benchmarks/README.md index da207671..fef0e9ff 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -305,3 +305,42 @@ test_zstd[urls.10K-cramjam] 4,454.6180 (29.67) 6,157 test_zstd[urls.10K-zstd] 4,201.4410 (27.99) 4,969.7730 (12.22) 4,298.6442 (24.33) 103.9367 (6.55) 4,271.2825 (25.25) 69.8585 (202.80) 18;13 232.6315 (0.04) 228 1 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ``` + +### LZO + +`make bench-lzo` + +```bash +---------------------------------------------------------------------------------------------------------- benchmark: 28 tests ---------------------------------------------------------------------------------------------------------- +Name (time in us) Min Max Mean StdDev Median IQR Outliers OPS Rounds Iterations +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +test_lzo[Mark.Twain-Tom.Sawyer.txt-cramjam] 71.3860 (3.74) 149.9000 (2.88) 76.3107 (3.81) 4.9416 (2.77) 75.4021 (3.83) 3.1543 (19.23) 479;468 13,104.3145 (0.26) 7391 1 +test_lzo[Mark.Twain-Tom.Sawyer.txt-lzo] 66.4451 (3.48) 119.3220 (2.30) 69.0805 (3.45) 4.4744 (2.51) 67.8891 (3.45) 0.6841 (4.17) 448;1085 14,475.8556 (0.29) 7197 1 +test_lzo[alice29.txt-cramjam] 827.6199 (43.33) 1,195.3199 (23.00) 849.6277 (42.41) 39.4083 (22.12) 834.0060 (42.32) 22.2070 (135.38) 86;92 1,176.9861 (0.02) 1176 1 +test_lzo[alice29.txt-lzo] 858.3551 (44.94) 1,068.9519 (20.57) 876.0361 (43.73) 23.2309 (13.04) 864.6360 (43.88) 20.8670 (127.22) 161;72 1,141.5055 (0.02) 1076 1 +test_lzo[asyoulik.txt-cramjam] 714.1409 (37.39) 1,070.4539 (20.60) 733.5739 (36.62) 29.1130 (16.34) 721.7090 (36.62) 21.5740 (131.53) 138;86 1,363.1892 (0.03) 1301 1 +test_lzo[asyoulik.txt-lzo] 738.7210 (38.67) 1,023.6730 (19.70) 753.5616 (37.62) 21.0062 (11.79) 743.6920 (37.74) 19.9350 (121.53) 173;64 1,327.0315 (0.03) 1330 1 +test_lzo[fifty-four-mb-random-cramjam] 27,467.8700 (>1000.0) 28,415.7479 (546.71) 27,741.2799 (>1000.0) 229.6713 (128.94) 27,684.2180 (>1000.0) 301.5934 (>1000.0) 7;2 36.0474 (0.00) 35 1 +test_lzo[fifty-four-mb-random-lzo] 54,500.6340 (>1000.0) 55,803.2760 (>1000.0) 54,953.2404 (>1000.0) 385.7472 (216.56) 54,841.4850 (>1000.0) 484.9015 (>1000.0) 5;0 18.1973 (0.00) 19 1 +test_lzo[fifty-four-mb-repeating-cramjam] 16,735.6710 (876.17) 35,315.1960 (679.45) 17,499.6351 (873.59) 3,109.0788 (>1000.0) 16,896.5759 (857.43) 147.1995 (897.40) 1;5 57.1440 (0.00) 35 1 +test_lzo[fifty-four-mb-repeating-lzo] 28,781.7999 (>1000.0) 31,379.0981 (603.72) 29,118.9751 (>1000.0) 447.9825 (251.50) 29,069.6489 (>1000.0) 295.3380 (>1000.0) 2;2 34.3419 (0.00) 34 1 +test_lzo[fireworks.jpeg-cramjam] 29.5170 (1.55) 68.3580 (1.32) 30.3508 (1.52) 2.2480 (1.26) 29.8760 (1.52) 0.1640 (1.0) 501;1528 32,948.1127 (0.66) 14140 1 +test_lzo[fireworks.jpeg-lzo] 19.1010 (1.0) 51.9759 (1.0) 20.0319 (1.0) 1.7813 (1.0) 19.7060 (1.0) 0.3839 (2.34) 786;1860 49,920.4164 (1.0) 29558 1 +test_lzo[geo.protodata-cramjam] 208.8640 (10.93) 376.4411 (7.24) 216.3516 (10.80) 9.7457 (5.47) 213.1091 (10.81) 2.8603 (17.44) 411;670 4,622.1062 (0.09) 4201 1 +test_lzo[geo.protodata-lzo] 198.9040 (10.41) 285.7670 (5.50) 205.2590 (10.25) 8.9124 (5.00) 202.0630 (10.25) 2.1450 (13.08) 444;796 4,871.8945 (0.10) 4333 1 +test_lzo[html-cramjam] 229.1009 (11.99) 295.4110 (5.68) 235.0136 (11.73) 8.9620 (5.03) 232.0290 (11.77) 1.7711 (10.80) 307;488 4,255.0721 (0.09) 3083 1 +test_lzo[html-lzo] 222.2451 (11.64) 320.2440 (6.16) 227.7268 (11.37) 9.1389 (5.13) 224.6010 (11.40) 1.6597 (10.12) 417;635 4,391.2270 (0.09) 3941 1 +test_lzo[html_x_4-cramjam] 908.0720 (47.54) 1,212.6609 (23.33) 926.7142 (46.26) 24.9970 (14.03) 914.4699 (46.41) 22.1749 (135.19) 146;63 1,079.0813 (0.02) 1013 1 +test_lzo[html_x_4-lzo] 890.4270 (46.62) 1,128.3380 (21.71) 909.5622 (45.41) 24.7532 (13.90) 897.9515 (45.57) 20.7745 (126.65) 154;85 1,099.4300 (0.02) 1068 1 +test_lzo[kppkn.gtb-cramjam] 685.0970 (35.87) 886.8390 (17.06) 702.4909 (35.07) 23.3337 (13.10) 693.5750 (35.20) 20.2102 (123.21) 168;89 1,423.5060 (0.03) 1401 1 +test_lzo[kppkn.gtb-lzo] 690.5049 (36.15) 910.5690 (17.52) 705.2198 (35.20) 19.5436 (10.97) 695.0080 (35.27) 19.8465 (120.99) 229;64 1,417.9975 (0.03) 1411 1 +test_lzo[lcet10.txt-cramjam] 2,229.8581 (116.74) 2,697.2240 (51.89) 2,272.3683 (113.44) 51.5769 (28.96) 2,257.0855 (114.54) 47.8630 (291.80) 44;15 440.0695 (0.01) 444 1 +test_lzo[lcet10.txt-lzo] 2,302.0359 (120.52) 2,882.9101 (55.47) 2,345.1378 (117.07) 49.3783 (27.72) 2,331.6385 (118.32) 50.6985 (309.08) 42;11 426.4142 (0.01) 404 1 +test_lzo[paper-100k.pdf-cramjam] 30.6889 (1.61) 70.6050 (1.36) 31.9516 (1.60) 2.8093 (1.58) 31.0800 (1.58) 0.2179 (1.33) 1259;2846 31,297.3057 (0.63) 14775 1 +test_lzo[paper-100k.pdf-lzo] 22.9060 (1.20) 70.6300 (1.36) 23.7881 (1.19) 2.1764 (1.22) 23.3080 (1.18) 0.4090 (2.49) 696;1758 42,037.7894 (0.84) 21124 1 +test_lzo[plrabn12.txt-cramjam] 2,856.4630 (149.55) 3,262.9370 (62.78) 2,916.4901 (145.59) 65.0193 (36.50) 2,895.8830 (146.95) 61.5970 (375.52) 36;18 342.8779 (0.01) 304 1 +test_lzo[plrabn12.txt-lzo] 2,968.7471 (155.42) 3,348.4920 (64.42) 3,021.6969 (150.84) 58.9855 (33.11) 2,999.0551 (152.19) 59.6350 (363.56) 39;16 330.9399 (0.01) 297 1 +test_lzo[urls.10K-cramjam] 2,569.2440 (134.51) 3,112.3650 (59.88) 2,618.0809 (130.70) 56.7014 (31.83) 2,598.5630 (131.87) 55.2737 (336.97) 44;15 381.9592 (0.01) 331 1 +test_lzo[urls.10K-lzo] 2,547.9870 (133.40) 3,008.4450 (57.88) 2,595.6427 (129.58) 57.5765 (32.32) 2,576.2780 (130.74) 51.2695 (312.56) 41;20 385.2610 (0.01) 324 1 +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +``` \ No newline at end of file From 32296fa2e9c59b655077b46f1a62874c114d3378 Mon Sep 17 00:00:00 2001 From: milesgranger Date: Wed, 31 Mar 2021 23:38:31 +0200 Subject: [PATCH 5/5] Add LICENSE-GPL and note on README for LZO feature --- LICENSE-GPL | 339 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 + 2 files changed, 341 insertions(+) create mode 100644 LICENSE-GPL diff --git a/LICENSE-GPL b/LICENSE-GPL new file mode 100644 index 00000000..15f75cf7 --- /dev/null +++ b/LICENSE-GPL @@ -0,0 +1,339 @@ +GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md index 27a6e429..75b73110 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ Available algorithms: - [X] Gzip - [X] Deflate - [X] ZSTD +- [X] LZO (optional, due to GPL license) + - **Note:** If installed/built with LZO feature, then the GPL License applies. All available for use as: