Added header text to sinfl and sdefl

vurtun · Dec 22, 2020 · 956ac04 · 956ac04
1 parent f52887b
commit 956ac04
Show file tree

Hide file tree

Showing 3 changed files with 220 additions and 2 deletions.
diff --git a/Readme.md b/Readme.md
@@ -9,9 +9,11 @@ My single header libraries for C/C++.
 |**sched.h** | 1.00 | multithreading | 699 | zlib | multithreaded task scheduler
 |**vec.h** | 0.02 | math | 2240 | zlib | vector math
 |**web.h** | 1.00 | network | 1455 | BSD |  lightweight webserver
+|**sdefl.h** | 1.00 | compression | 525 | public domain |  deflate compressor
+|**sinfl.h** | 1.00 | decompression | 320 | public domain |  deflate decompressor
 
-Total libraries: 5  
-Total lines of C code: 5608
+Total libraries: 7  
+Total lines of C code: 7137
 
 ## FAQ
 

diff --git a/sdefl.h b/sdefl.h
@@ -1,3 +1,111 @@
+#if 0
+# Small Deflate
+`sdefl` is a small bare bone lossless compression library in ANSI C (ISO C90)
+which implements the Deflate (RFC 1951) compressed data format specification standard.
+It is mainly tuned to get as much speed and compression ratio from as little code
+as needed to keep the implementation as concise as possible.
+
+## Features
+- Portable single header and source file duo written in ANSI C (ISO C90)
+- Dual license with either MIT or public domain
+- Small implementation
+    - Deflate: 525 LoC
+    - Inflate: 320 LoC
+- Webassembly:
+    - Deflate ~3.7 KB (~2.2KB compressed)
+    - Inflate ~3.6 KB (~2.2KB compressed)
+
+## Usage
+For deflating add sdefl source and header into your project and include `sdefl.h`.
+To compress a block of memory call `sdeflate` with your data to compress and a
+memory block to write the compressed output into with size returned by `sdefl_bound`
+
+For inflating add sinfl source and header into your project and include `sinfl.h`.
+To decompress a previously compressed block of memory call `sinflate`. Pass
+your compressed block along with its size and an allocated output buffer
+with size of the uncompressed block.
+
+### Benchmark
+
+| Compressor name         | Compression| Decompress.| Compr. size | Ratio |
+| ------------------------| -----------| -----------| ----------- | ----- |
+| sdefl 1.0 -0            |   127 MB/s |   201 MB/s |    40004116 | 39.88 |
+| sdefl 1.0 -1            |   111 MB/s |   216 MB/s |    38940674 | 38.82 |
+| sdefl 1.0 -5            |    45 MB/s |   230 MB/s |    36577183 | 36.46 |
+| sdefl 1.0 -7            |    38 MB/s |   233 MB/s |    36523781 | 36.41 |
+| zlib 1.2.11 -1          |    72 MB/s |   307 MB/s |    42298774 | 42.30 |
+| zlib 1.2.11 -6          |    24 MB/s |   313 MB/s |    36548921 | 36.55 |
+| zlib 1.2.11 -9          |    20 MB/s |   314 MB/s |    36475792 | 36.48 |
+| miniz 1.0 -1            |   122 MB/s |   208 MB/s |    48510028 | 48.51 |
+| miniz 1.0 -6            |    27 MB/s |   260 MB/s |    36513697 | 36.51 |
+| miniz 1.0 -9            |    23 MB/s |   261 MB/s |    36460101 | 36.46 |
+| libdeflate 1.3 -1       |   147 MB/s |   667 MB/s |    39597378 | 39.60 |
+| libdeflate 1.3 -6       |    69 MB/s |   689 MB/s |    36648318 | 36.65 |
+| libdeflate 1.3 -9       |    13 MB/s |   672 MB/s |    35197141 | 35.20 |
+| libdeflate 1.3 -12      |  8.13 MB/s |   670 MB/s |    35100568 | 35.10 |
+
+### Compression
+Results on the [Silesia compression corpus](http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia):
+
+| File    |   Original | `sdefl 0`  	| `sdefl 5` 	| `sdefl 7` |
+| :------ | ---------: | -----------------: | ---------: | ----------: |
+| dickens | 10.192.446 |  4,260,187|  3,845,261|   3,833,657 |
+| mozilla | 51.220.480 | 20,774,706 | 19,607,009 |  19,565,867 |
+| mr      |  9.970.564 | 3,860,531 |  3,673,460 |   3,665,627 |
+| nci     | 33.553.445 | 4,030,283 |  3,094,526 |   3,006,075 |
+| ooffice |  6.152.192 | 3,320,063 |  3,186,373 |   3,183,815 |
+| osdb    | 10.085.684 | 3,919,646 |  3,649,510 |   3,649,477 |
+| reymont |  6.627.202 | 2,263,378 |  1,857,588 |   1,827,237 |
+| samba   | 21.606.400 | 6,121,797 |  5,462,670 |   5,450,762 |
+| sao     |  7.251.944 | 5,612,421 |  5,485,380 |   5,481,765 |
+| webster | 41.458.703 | 13,972,648 | 12,059,432 |  11,991,421 |
+| xml     |  5.345.280 | 886,620|    674,009 |     662,141 |
+| x-ray   |  8.474.240 | 6,304,655 |  6,244,779 |   6,244,779 |
+
+## License
+```
+------------------------------------------------------------------------------
+This software is available under 2 licenses -- choose whichever you prefer.
+------------------------------------------------------------------------------
+ALTERNATIVE A - MIT License
+Copyright (c) 2020 Micha Mettke
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+------------------------------------------------------------------------------
+ALTERNATIVE B - Public Domain (www.unlicense.org)
+This is free and unencumbered software released into the public domain.
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
+software, either in source code form or as a compiled binary, for any purpose,
+commercial or non-commercial, and by any means.
+In jurisdictions that recognize copyright laws, the author or authors of this
+software dedicate any and all copyright interest in the software to the public
+domain. We make this dedication for the benefit of the public at large and to
+the detriment of our heirs and successors. We intend this dedication to be an
+overt act of relinquishment in perpetuity of all present and future rights to
+this software under copyright law.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+------------------------------------------------------------------------------
+```
+#endif
+
 #ifndef SDEFL_H_INCLUDED
 #define SDEFL_H_INCLUDED
 

diff --git a/sinfl.h b/sinfl.h
@@ -1,3 +1,111 @@
+#if 0
+# Small Deflate
+`sdefl` is a small bare bone lossless compression library in ANSI C (ISO C90)
+which implements the Deflate (RFC 1951) compressed data format specification standard.
+It is mainly tuned to get as much speed and compression ratio from as little code
+as needed to keep the implementation as concise as possible.
+
+## Features
+- Portable single header and source file duo written in ANSI C (ISO C90)
+- Dual license with either MIT or public domain
+- Small implementation
+    - Deflate: 525 LoC
+    - Inflate: 320 LoC
+- Webassembly:
+    - Deflate ~3.7 KB (~2.2KB compressed)
+    - Inflate ~3.6 KB (~2.2KB compressed)
+
+## Usage
+For deflating add sdefl source and header into your project and include `sdefl.h`.
+To compress a block of memory call `sdeflate` with your data to compress and a
+memory block to write the compressed output into with size returned by `sdefl_bound`
+
+For inflating add sinfl source and header into your project and include `sinfl.h`.
+To decompress a previously compressed block of memory call `sinflate`. Pass
+your compressed block along with its size and an allocated output buffer
+with size of the uncompressed block.
+
+### Benchmark
+
+| Compressor name         | Compression| Decompress.| Compr. size | Ratio |
+| ------------------------| -----------| -----------| ----------- | ----- |
+| sdefl 1.0 -0            |   127 MB/s |   201 MB/s |    40004116 | 39.88 |
+| sdefl 1.0 -1            |   111 MB/s |   216 MB/s |    38940674 | 38.82 |
+| sdefl 1.0 -5            |    45 MB/s |   230 MB/s |    36577183 | 36.46 |
+| sdefl 1.0 -7            |    38 MB/s |   233 MB/s |    36523781 | 36.41 |
+| zlib 1.2.11 -1          |    72 MB/s |   307 MB/s |    42298774 | 42.30 |
+| zlib 1.2.11 -6          |    24 MB/s |   313 MB/s |    36548921 | 36.55 |
+| zlib 1.2.11 -9          |    20 MB/s |   314 MB/s |    36475792 | 36.48 |
+| miniz 1.0 -1            |   122 MB/s |   208 MB/s |    48510028 | 48.51 |
+| miniz 1.0 -6            |    27 MB/s |   260 MB/s |    36513697 | 36.51 |
+| miniz 1.0 -9            |    23 MB/s |   261 MB/s |    36460101 | 36.46 |
+| libdeflate 1.3 -1       |   147 MB/s |   667 MB/s |    39597378 | 39.60 |
+| libdeflate 1.3 -6       |    69 MB/s |   689 MB/s |    36648318 | 36.65 |
+| libdeflate 1.3 -9       |    13 MB/s |   672 MB/s |    35197141 | 35.20 |
+| libdeflate 1.3 -12      |  8.13 MB/s |   670 MB/s |    35100568 | 35.10 |
+
+### Compression
+Results on the [Silesia compression corpus](http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia):
+
+| File    |   Original | `sdefl 0`  	| `sdefl 5` 	| `sdefl 7` |
+| :------ | ---------: | -----------------: | ---------: | ----------: |
+| dickens | 10.192.446 |  4,260,187|  3,845,261|   3,833,657 |
+| mozilla | 51.220.480 | 20,774,706 | 19,607,009 |  19,565,867 |
+| mr      |  9.970.564 | 3,860,531 |  3,673,460 |   3,665,627 |
+| nci     | 33.553.445 | 4,030,283 |  3,094,526 |   3,006,075 |
+| ooffice |  6.152.192 | 3,320,063 |  3,186,373 |   3,183,815 |
+| osdb    | 10.085.684 | 3,919,646 |  3,649,510 |   3,649,477 |
+| reymont |  6.627.202 | 2,263,378 |  1,857,588 |   1,827,237 |
+| samba   | 21.606.400 | 6,121,797 |  5,462,670 |   5,450,762 |
+| sao     |  7.251.944 | 5,612,421 |  5,485,380 |   5,481,765 |
+| webster | 41.458.703 | 13,972,648 | 12,059,432 |  11,991,421 |
+| xml     |  5.345.280 | 886,620|    674,009 |     662,141 |
+| x-ray   |  8.474.240 | 6,304,655 |  6,244,779 |   6,244,779 |
+
+## License
+```
+------------------------------------------------------------------------------
+This software is available under 2 licenses -- choose whichever you prefer.
+------------------------------------------------------------------------------
+ALTERNATIVE A - MIT License
+Copyright (c) 2020 Micha Mettke
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+------------------------------------------------------------------------------
+ALTERNATIVE B - Public Domain (www.unlicense.org)
+This is free and unencumbered software released into the public domain.
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
+software, either in source code form or as a compiled binary, for any purpose,
+commercial or non-commercial, and by any means.
+In jurisdictions that recognize copyright laws, the author or authors of this
+software dedicate any and all copyright interest in the software to the public
+domain. We make this dedication for the benefit of the public at large and to
+the detriment of our heirs and successors. We intend this dedication to be an
+overt act of relinquishment in perpetuity of all present and future rights to
+this software under copyright law.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+------------------------------------------------------------------------------
+```
+#endif
+
 #ifndef SINFL_H_INCLUDED
 #define SINFL_H_INCLUDED