├── LICENSE ├── README.org ├── src ├── libzstd.lisp ├── package.lisp └── zstd.lisp ├── tests ├── test1.txt ├── test1.txt.zst ├── test2.txt ├── test2.txt.zst └── tests.lisp ├── zstd-tests.asd └── zstd.asd /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: cl-zstd 2 | #+AUTHOR: Guillaume LE VAILLANT 3 | #+DATE: 2022-06-20 4 | #+EMAIL: glv@posteo.net 5 | #+LANGUAGE: en 6 | #+OPTIONS: num:nil toc:nil html-postamble:nil html-scripts:nil 7 | #+HTML_DOCTYPE: html5 8 | 9 | The active repository is at https://codeberg.org/glv/cl-zstd 10 | 11 | * Description 12 | 13 | *cl-zstd* is a Common Lisp library for Zstandard compression/decompression 14 | using bindings to the libzstd C library. 15 | 16 | * License 17 | 18 | *cl-zstd* is released under the GPL-3 license or later. See the [[file:LICENSE][LICENSE]] file 19 | for details. 20 | 21 | * Dependencies 22 | 23 | *cl-zstd* requires: 24 | - [[https://cffi.common-lisp.dev/][cffi]] 25 | - [[https://codeberg.org/glv/cl-octet-streams][cl-octet-streams]] 26 | - [[https://facebook.github.io/zstd/][libzstd]] 27 | - [[https://trivial-gray-streams.common-lisp.dev/][trivial-gray-streams]] 28 | 29 | There should be a package providing *libzstd* in almost every GNU/Linux or *BSD 30 | distribution. For example it is called /libzstd1/ on Debian, /zstd/ on Gentoo, 31 | and /zstd:lib/ on Guix. 32 | 33 | * API 34 | 35 | The library can be loaded with the usual: 36 | 37 | #+BEGIN_SRC lisp 38 | (asdf:load-system "zstd") 39 | #+END_SRC 40 | 41 | or 42 | 43 | #+BEGIN_SRC lisp 44 | (quicklisp:quickload "zstd") 45 | #+END_SRC 46 | 47 | The functions will then be available in the ~zstd~ package. 48 | 49 | ** Compression 50 | 51 | #+BEGIN_SRC lisp 52 | (compress-stream input output &key level) => t 53 | #+END_SRC 54 | 55 | Read the data from the /input/ octet stream, compress it, and write the result 56 | to the /output/ octet stream. 57 | 58 | #+BEGIN_SRC lisp 59 | (compress-file input output &key level) => t 60 | #+END_SRC 61 | 62 | Read the data from the /input/ file, compress it, and write the result to the 63 | /output/ file. 64 | 65 | #+BEGIN_SRC lisp 66 | (compress-buffer buffer &key start end level) => bytes 67 | #+END_SRC 68 | 69 | Read the data between the /start/ and /end/ offsets in the /buffer/, compress 70 | it, and return the resulting octet vector. 71 | 72 | #+BEGIN_SRC lisp 73 | (make-compressing-stream output-stream &key level) => stream 74 | #+END_SRC 75 | 76 | Return a stream that will compress the bytes written to it at the given 77 | compression /level/ and write them to the /output-stream/. 78 | 79 | #+BEGIN_SRC lisp 80 | (with-compressing-stream (stream output-stream &key level) &body body) 81 | #+END_SRC 82 | 83 | Within /body/, /stream/ is bound to a compressing stream for the given 84 | compression /level/ and /output-stream/. The result of the last form of /body/ 85 | is returned. 86 | 87 | ** Decompression 88 | 89 | #+BEGIN_SRC lisp 90 | (decompress-stream input output) => t 91 | #+END_SRC 92 | 93 | Read the data from the /input/ octet stream, decompress it, and write the result 94 | to the /output/ octet stream. 95 | 96 | #+BEGIN_SRC lisp 97 | (decompress-file input output) => t 98 | #+END_SRC 99 | 100 | Read the data from the /input/ file, decompress it, and write the result to the 101 | /output/ file. 102 | 103 | #+BEGIN_SRC lisp 104 | (decompress-buffer buffer &key start end) => bytes 105 | #+END_SRC 106 | 107 | Read the data between the /start/ and /end/ offsets in the /buffer/, decompress 108 | it, and return the resulting octet vector. 109 | 110 | #+BEGIN_SRC lisp 111 | (make-decompressing-stream input-stream) => stream 112 | #+END_SRC 113 | 114 | Return a stream that will supply the bytes resulting from the decompression of 115 | the data read from the /input-stream/. 116 | 117 | #+BEGIN_SRC lisp 118 | (with-decompressing-stream (stream input-stream) &body body) 119 | #+END_SRC 120 | 121 | Within /body/, /stream/ is bound to a decompressing stream for the given 122 | /input-stream/. The result of the last form of /body/ is returned. 123 | 124 | * Tests 125 | 126 | The tests require the [[https://common-lisp.net/project/fiveam/][fiveam]] package. They can be run with: 127 | 128 | #+BEGIN_SRC lisp 129 | (asdf:test-system "zstd") 130 | #+END_SRC 131 | -------------------------------------------------------------------------------- /src/libzstd.lisp: -------------------------------------------------------------------------------- 1 | ;;; This file is part of cl-zstd 2 | ;;; Copyright 2020 Guillaume LE VAILLANT 3 | ;;; Distributed under the GNU GPL v3 or later. 4 | ;;; See the file LICENSE for terms of use and distribution. 5 | 6 | (in-package :zstd) 7 | 8 | 9 | (cffi:define-foreign-library libzstd 10 | (:darwin "libzstd.dylib") 11 | (:unix (:or "libzstd.so" 12 | "libzstd.so.1")) 13 | (t (:default "libzstd"))) 14 | 15 | (cffi:use-foreign-library libzstd) 16 | 17 | 18 | ;;; 19 | ;;; Types 20 | ;;; 21 | 22 | (deftype i32 () '(signed-byte 32)) 23 | (deftype u32 () '(unsigned-byte 32)) 24 | (deftype u64 () '(unsigned-byte 64)) 25 | 26 | (cffi:defcstruct zstd-in-buffer 27 | (src :pointer) 28 | (size :unsigned-long-long) 29 | (pos :unsigned-long-long)) 30 | 31 | (cffi:defcstruct zstd-out-buffer 32 | (dst :pointer) 33 | (size :unsigned-long-long) 34 | (pos :unsigned-long-long)) 35 | 36 | (cffi:defcenum zstd-c-parameter 37 | (:zstd-c-compression-level 100) 38 | (:zstd-c-checksum-flag 201) 39 | (:zstd-c-nb-workers 400)) 40 | 41 | (cffi:defcenum zstd-end-directive 42 | :zstd-e-continue 43 | :zstd-e-flush 44 | :zstd-e-end) 45 | 46 | 47 | ;;; 48 | ;;; Error functions 49 | ;;; 50 | 51 | (declaim (ftype (function (u64) u32) zstd-is-error)) 52 | (cffi:defcfun ("ZSTD_isError" zstd-is-error) :unsigned-int 53 | "Tell if a function result is an error code." 54 | (code :unsigned-long-long)) 55 | 56 | (declaim (ftype (function (u64) t) zstd-get-error-name)) 57 | (cffi:defcfun ("ZSTD_getErrorName" zstd-get-error-name) :string 58 | "Return a readable string from an error code." 59 | (code :unsigned-long-long)) 60 | 61 | 62 | ;;; 63 | ;;; Compression functions 64 | ;;; 65 | 66 | (declaim (ftype (function () t) zstd-create-cctx)) 67 | (cffi:defcfun ("ZSTD_createCCtx" zstd-create-cctx) :pointer 68 | "Create a compression context.") 69 | 70 | (declaim (ftype (function (t) u64) zstd-free-cctx)) 71 | (cffi:defcfun ("ZSTD_freeCCtx" zstd-free-cctx) :unsigned-long-long 72 | "Free a compression context." 73 | (cctx :pointer)) 74 | 75 | (declaim (ftype (function (t t i32) u64) zstd-cctx-set-parameter)) 76 | (cffi:defcfun ("ZSTD_CCtx_setParameter" zstd-cctx-set-parameter) :unsigned-long-long 77 | "Set one compression parameter." 78 | (cctx :pointer) 79 | (param zstd-c-parameter) 80 | (value :int)) 81 | 82 | (declaim (ftype (function () i32) zstd-min-c-level)) 83 | (cffi:defcfun ("ZSTD_minCLevel" zstd-min-c-level) :int 84 | "Minimum compression level available.") 85 | 86 | (declaim (ftype (function () i32) zstd-max-c-level)) 87 | (cffi:defcfun ("ZSTD_maxCLevel" zstd-max-c-level) :int 88 | "Maximum compression level available.") 89 | 90 | (declaim (ftype (function (t t t t) u64) zstd-compress-stream2)) 91 | (cffi:defcfun ("ZSTD_compressStream2" zstd-compress-stream2) :unsigned-long-long 92 | "Compress the data with additional control on end directive." 93 | (cctx :pointer) 94 | (output :pointer) 95 | (input :pointer) 96 | (endop zstd-end-directive)) 97 | 98 | (declaim (ftype (function () u64) zstd-c-stream-in-size)) 99 | (cffi:defcfun ("ZSTD_CStreamInSize" zstd-c-stream-in-size) :unsigned-long-long 100 | "Recommended size for compression input buffer.") 101 | 102 | (declaim (ftype (function () u64) zstd-c-stream-out-size)) 103 | (cffi:defcfun ("ZSTD_CStreamOutSize" zstd-c-stream-out-size) :unsigned-long-long 104 | "Recommended size for compression output buffer.") 105 | 106 | 107 | ;;; 108 | ;;; Decompression functions 109 | ;;; 110 | 111 | (declaim (ftype (function () t) zstd-create-dctx)) 112 | (cffi:defcfun ("ZSTD_createDCtx" zstd-create-dctx) :pointer 113 | "Create a decompression context.") 114 | 115 | (declaim (ftype (function (t) u64) zstd-free-dctx)) 116 | (cffi:defcfun ("ZSTD_freeDCtx" zstd-free-dctx) :unsigned-long-long 117 | "Free a decompression context." 118 | (dctx :pointer)) 119 | 120 | (declaim (ftype (function (t t t) u64) zstd-decompress-stream)) 121 | (cffi:defcfun ("ZSTD_decompressStream" zstd-decompress-stream) :unsigned-long-long 122 | "Decompress the data." 123 | (zds :pointer) 124 | (output :pointer) 125 | (input :pointer)) 126 | 127 | (declaim (ftype (function () u64) zstd-d-stream-in-size)) 128 | (cffi:defcfun ("ZSTD_DStreamInSize" zstd-d-stream-in-size) :unsigned-long-long 129 | "Recommended size for decompression input buffer.") 130 | 131 | (declaim (ftype (function () u64) zstd-d-stream-out-size)) 132 | (cffi:defcfun ("ZSTD_DStreamOutSize" zstd-d-stream-out-size) :unsigned-long-long 133 | "Recommended size for decompression output buffer.") 134 | -------------------------------------------------------------------------------- /src/package.lisp: -------------------------------------------------------------------------------- 1 | ;;; This file is part of cl-zstd 2 | ;;; Copyright 2020-2022 Guillaume LE VAILLANT 3 | ;;; Distributed under the GNU GPL v3 or later. 4 | ;;; See the file LICENSE for terms of use and distribution. 5 | 6 | (defpackage :zstd 7 | (:use :cl :trivial-gray-streams) 8 | (:export #:compress-stream 9 | #:compress-file 10 | #:compress-buffer 11 | #:decompress-stream 12 | #:decompress-file 13 | #:decompress-buffer 14 | #:make-compressing-stream 15 | #:make-decompressing-stream 16 | #:with-compressing-stream 17 | #:with-decompressing-stream 18 | #:zstd-error)) 19 | -------------------------------------------------------------------------------- /src/zstd.lisp: -------------------------------------------------------------------------------- 1 | ;;; This file is part of cl-zstd 2 | ;;; Copyright 2020-2022 Guillaume LE VAILLANT 3 | ;;; Distributed under the GNU GPL v3 or later. 4 | ;;; See the file LICENSE for terms of use and distribution. 5 | 6 | (in-package :zstd) 7 | 8 | 9 | (deftype u8 () '(unsigned-byte 8)) 10 | (defconstant +buffer-size+ 4096) 11 | 12 | 13 | ;;; 14 | ;;; Errors 15 | ;;; 16 | 17 | (define-condition zstd-error (simple-error) 18 | ()) 19 | 20 | (defmacro zstd-error (message &rest args) 21 | `(error 'zstd-error 22 | :format-control ,message 23 | :format-arguments (list ,@args))) 24 | 25 | (defmacro zstd-check (form) 26 | (let ((code (gensym))) 27 | `(let ((,code ,form)) 28 | (declare (type u64 ,code)) 29 | (if (= (zstd-is-error ,code) 1) 30 | (zstd-error (zstd-get-error-name ,code)) 31 | ,code)))) 32 | 33 | 34 | ;;; 35 | ;;; Compression Gray streams 36 | ;;; 37 | 38 | (defclass compressing-stream (fundamental-binary-output-stream) 39 | ((output-stream :accessor output-stream) 40 | (zstd-context :accessor zstd-context) 41 | (input-buffer :accessor input-buffer) 42 | (zstd-in-buffer :accessor zstd-in-buffer) 43 | (output-buffer :accessor output-buffer) 44 | (zstd-out-buffer :accessor zstd-out-buffer))) 45 | 46 | (defmethod stream-element-type ((stream compressing-stream)) 47 | '(unsigned-byte 8)) 48 | 49 | (defun compress-and-write (stream) 50 | (with-slots (output-stream zstd-context 51 | input-buffer zstd-in-buffer 52 | output-buffer zstd-out-buffer) 53 | stream 54 | (zstd-check (zstd-compress-stream2 zstd-context 55 | zstd-out-buffer 56 | zstd-in-buffer 57 | :zstd-e-continue)) 58 | (cffi:with-foreign-slots ((size pos) zstd-in-buffer 59 | (:struct zstd-in-buffer)) 60 | (when (plusp pos) 61 | (replace input-buffer input-buffer :start2 pos :end2 size) 62 | (decf size pos) 63 | (setf pos 0))) 64 | (cffi:with-foreign-slots ((pos) zstd-out-buffer 65 | (:struct zstd-out-buffer)) 66 | (when (plusp pos) 67 | (write-sequence output-buffer output-stream :end pos) 68 | (setf pos 0))))) 69 | 70 | (defmethod stream-write-byte ((stream compressing-stream) byte) 71 | (with-slots (input-buffer zstd-in-buffer) stream 72 | (cffi:with-foreign-slots ((size pos) zstd-in-buffer 73 | (:struct zstd-in-buffer)) 74 | (setf (aref input-buffer size) byte) 75 | (incf size))) 76 | (compress-and-write stream) 77 | byte) 78 | 79 | (defmethod stream-write-sequence ((stream compressing-stream) seq start end 80 | &key &allow-other-keys) 81 | (with-slots (input-buffer zstd-in-buffer) stream 82 | (loop :while (< start end) :do 83 | (cffi:with-foreign-slots ((size) zstd-in-buffer 84 | (:struct zstd-in-buffer)) 85 | (let* ((available-space (- (length input-buffer) size)) 86 | (n (min (- end start) available-space))) 87 | (replace input-buffer seq 88 | :start1 size :start2 start :end2 (+ start n)) 89 | (incf size n) 90 | (incf start n))) 91 | (compress-and-write stream))) 92 | seq) 93 | 94 | (defmethod stream-finish-output ((stream compressing-stream)) 95 | (with-slots (output-stream zstd-context zstd-in-buffer 96 | output-buffer zstd-out-buffer) 97 | stream 98 | (do ((frame-complete-p nil)) 99 | (frame-complete-p) 100 | (setf frame-complete-p 101 | (zerop (zstd-check (zstd-compress-stream2 zstd-context 102 | zstd-out-buffer 103 | zstd-in-buffer 104 | :zstd-e-end)))) 105 | (cffi:with-foreign-slots ((pos) zstd-out-buffer 106 | (:struct zstd-out-buffer)) 107 | (when (plusp pos) 108 | (write-sequence output-buffer output-stream :end pos) 109 | (setf pos 0)))) 110 | (cffi:with-foreign-slots ((size pos) zstd-in-buffer 111 | (:struct zstd-in-buffer)) 112 | (setf pos 0) 113 | (setf size 0)) 114 | (cffi:with-foreign-slots ((pos) zstd-out-buffer 115 | (:struct zstd-out-buffer)) 116 | (setf pos 0)) 117 | (finish-output output-stream)) 118 | nil) 119 | 120 | (defmethod close ((stream compressing-stream) &key &allow-other-keys) 121 | (when (open-stream-p stream) 122 | (finish-output stream) 123 | (with-slots (zstd-context input-buffer zstd-in-buffer 124 | output-buffer zstd-out-buffer) 125 | stream 126 | (zstd-check (zstd-free-cctx zstd-context)) 127 | (setf zstd-context nil) 128 | (setf input-buffer nil) 129 | (cffi:foreign-free zstd-in-buffer) 130 | (setf zstd-in-buffer nil) 131 | (setf output-buffer nil) 132 | (cffi:foreign-free zstd-out-buffer) 133 | (setf zstd-out-buffer nil))) 134 | t) 135 | 136 | (defun initialize-context (context level) 137 | "Initialize the CONTEXT for the given compression LEVEL." 138 | (zstd-check (zstd-cctx-set-parameter context :zstd-c-compression-level level)) 139 | (zstd-check (zstd-cctx-set-parameter context :zstd-c-checksum-flag 1)) 140 | context) 141 | 142 | (defun make-compressing-stream (output-stream &key (level 3)) 143 | "Return a stream that will compress the bytes written to it at the given 144 | compression LEVEL and write them to the OUTPUT-STREAM." 145 | (let ((stream (make-instance 'compressing-stream)) 146 | (input-buffer-size (zstd-c-stream-in-size)) 147 | (output-buffer-size (zstd-c-stream-out-size)) 148 | (min-level (zstd-min-c-level)) 149 | (max-level (zstd-max-c-level))) 150 | (setf (output-stream stream) output-stream) 151 | (with-slots (zstd-context input-buffer zstd-in-buffer 152 | output-buffer zstd-out-buffer) 153 | stream 154 | (if (and (integerp level) (<= min-level level max-level)) 155 | (let ((context (zstd-create-cctx))) 156 | (if (cffi:null-pointer-p context) 157 | (zstd-error "Failed to create compression context.") 158 | (setf zstd-context (initialize-context context level)))) 159 | (zstd-error "LEVEL must be between ~d and ~d." min-level max-level)) 160 | 161 | (setf input-buffer (cffi:make-shareable-byte-vector input-buffer-size)) 162 | (setf zstd-in-buffer (cffi:foreign-alloc '(:struct zstd-in-buffer))) 163 | (cffi:with-pointer-to-vector-data (ffi-input-buffer input-buffer) 164 | (cffi:with-foreign-slots ((src size pos) zstd-in-buffer 165 | (:struct zstd-in-buffer)) 166 | (setf src ffi-input-buffer) 167 | (setf size 0) 168 | (setf pos 0))) 169 | 170 | (setf output-buffer (cffi:make-shareable-byte-vector output-buffer-size)) 171 | (setf zstd-out-buffer (cffi:foreign-alloc '(:struct zstd-out-buffer))) 172 | (cffi:with-pointer-to-vector-data (ffi-output-buffer output-buffer) 173 | (cffi:with-foreign-slots ((dst size pos) (zstd-out-buffer stream) 174 | (:struct zstd-out-buffer)) 175 | (setf dst ffi-output-buffer) 176 | (setf size output-buffer-size) 177 | (setf pos 0)))) 178 | stream)) 179 | 180 | (defmacro with-compressing-stream ((stream output-stream &key (level 3)) 181 | &body body) 182 | "Within BODY, STREAM is bound to a compressing stream for the given 183 | compression LEVEL and OUTPUT-STREAM. The result of the last form of BODY is 184 | returned." 185 | `(with-open-stream (,stream (make-compressing-stream ,output-stream 186 | :level ,level)) 187 | ,@body)) 188 | 189 | 190 | ;;; 191 | ;;; Decompression Gray streams 192 | ;;; 193 | 194 | (defclass decompressing-stream (fundamental-binary-input-stream) 195 | ((input-stream :accessor input-stream) 196 | (zstd-context :accessor zstd-context) 197 | (input-buffer :accessor input-buffer) 198 | (zstd-in-buffer :accessor zstd-in-buffer) 199 | (output-buffer :accessor output-buffer) 200 | (zstd-out-buffer :accessor zstd-out-buffer) 201 | (frame-complete-p :accessor frame-complete-p))) 202 | 203 | (defmethod stream-element-type ((stream decompressing-stream)) 204 | '(unsigned-byte 8)) 205 | 206 | (defun read-and-decompress (stream) 207 | (with-slots (input-stream zstd-context input-buffer zstd-in-buffer 208 | zstd-out-buffer frame-complete-p) 209 | stream 210 | (let ((end-of-input-p nil)) 211 | (cffi:with-foreign-slots ((size) zstd-in-buffer 212 | (:struct zstd-in-buffer)) 213 | (setf size (read-sequence input-buffer input-stream :start size)) 214 | (setf end-of-input-p (zerop size))) 215 | (unless end-of-input-p 216 | (setf frame-complete-p 217 | (zerop (zstd-check (zstd-decompress-stream zstd-context 218 | zstd-out-buffer 219 | zstd-in-buffer)))) 220 | (cffi:with-foreign-slots ((size pos) zstd-in-buffer 221 | (:struct zstd-in-buffer)) 222 | (when (plusp pos) 223 | (replace input-buffer input-buffer :start2 pos :end2 size) 224 | (decf size pos) 225 | (setf pos 0)))) 226 | end-of-input-p))) 227 | 228 | (defmethod stream-listen ((stream decompressing-stream)) 229 | (with-slots (input-stream zstd-in-buffer zstd-out-buffer) stream 230 | (or (plusp (cffi:foreign-slot-value zstd-out-buffer 231 | '(:struct zstd-out-buffer) 232 | 'pos)) 233 | (plusp (cffi:foreign-slot-value zstd-in-buffer 234 | '(:struct zstd-in-buffer) 235 | 'size)) 236 | (listen input-stream)))) 237 | 238 | (defmethod stream-read-byte ((stream decompressing-stream)) 239 | (with-slots (output-buffer zstd-out-buffer) stream 240 | (let ((end-of-input-p (read-and-decompress stream))) 241 | (cffi:with-foreign-slots ((pos) zstd-out-buffer 242 | (:struct zstd-out-buffer)) 243 | (cond 244 | ((plusp pos) 245 | (let ((byte (aref output-buffer 0))) 246 | (replace output-buffer output-buffer :start2 1 :end2 pos) 247 | (decf pos) 248 | byte)) 249 | ((and end-of-input-p (not (frame-complete-p stream))) 250 | (zstd-error "Truncated stream.")) 251 | (t 252 | :eof)))))) 253 | 254 | (defmethod stream-read-sequence ((stream decompressing-stream) seq start end 255 | &key &allow-other-keys) 256 | (with-slots (output-buffer zstd-out-buffer) stream 257 | (let ((end-of-input-p nil)) 258 | (loop :until (or (= start end) end-of-input-p) :do 259 | (setf end-of-input-p (read-and-decompress stream)) 260 | (cffi:with-foreign-slots ((pos) zstd-out-buffer 261 | (:struct zstd-out-buffer)) 262 | (loop :while (and (< start end) (plusp pos)) :do 263 | (let ((n (min (- end start) pos))) 264 | (replace seq output-buffer :start1 start :end2 n) 265 | (replace output-buffer output-buffer :start2 n :end2 pos) 266 | (decf pos n) 267 | (incf start n))))) 268 | (when (and end-of-input-p (not (frame-complete-p stream))) 269 | (zstd-error "Truncated stream.")))) 270 | start) 271 | 272 | (defmethod close ((stream decompressing-stream) &key &allow-other-keys) 273 | (when (open-stream-p stream) 274 | (with-slots (zstd-context input-buffer zstd-in-buffer 275 | output-buffer zstd-out-buffer) 276 | stream 277 | (zstd-check (zstd-free-dctx zstd-context)) 278 | (setf zstd-context nil) 279 | (setf input-buffer nil) 280 | (cffi:foreign-free zstd-in-buffer) 281 | (setf zstd-in-buffer nil) 282 | (setf output-buffer nil) 283 | (cffi:foreign-free zstd-out-buffer) 284 | (setf zstd-out-buffer nil))) 285 | t) 286 | 287 | (defun make-decompressing-stream (input-stream) 288 | "Return a stream that will supply the bytes resulting from the decompression 289 | of the data read from the INPUT-STREAM." 290 | (let ((stream (make-instance 'decompressing-stream)) 291 | (input-buffer-size (zstd-d-stream-in-size)) 292 | (output-buffer-size (zstd-d-stream-out-size))) 293 | (setf (input-stream stream) input-stream) 294 | (with-slots (zstd-context input-buffer zstd-in-buffer 295 | output-buffer zstd-out-buffer frame-complete-p) 296 | stream 297 | (let ((context (zstd-create-dctx))) 298 | (if (cffi:null-pointer-p context) 299 | (zstd-error "Failed to create decompression context.") 300 | (setf zstd-context context))) 301 | 302 | (setf input-buffer (cffi:make-shareable-byte-vector input-buffer-size)) 303 | (setf zstd-in-buffer (cffi:foreign-alloc '(:struct zstd-in-buffer))) 304 | (cffi:with-pointer-to-vector-data (ffi-input-buffer input-buffer) 305 | (cffi:with-foreign-slots ((src size pos) zstd-in-buffer 306 | (:struct zstd-in-buffer)) 307 | (setf src ffi-input-buffer) 308 | (setf size 0) 309 | (setf pos 0))) 310 | 311 | (setf output-buffer (cffi:make-shareable-byte-vector output-buffer-size)) 312 | (setf zstd-out-buffer (cffi:foreign-alloc '(:struct zstd-out-buffer))) 313 | (cffi:with-pointer-to-vector-data (ffi-output-buffer output-buffer) 314 | (cffi:with-foreign-slots ((dst size pos) zstd-out-buffer 315 | (:struct zstd-out-buffer)) 316 | (setf dst ffi-output-buffer) 317 | (setf size output-buffer-size) 318 | (setf pos 0))) 319 | 320 | (setf frame-complete-p t)) 321 | stream)) 322 | 323 | (defmacro with-decompressing-stream ((stream input-stream) &body body) 324 | "Within BODY, STREAM is bound to a decompressing stream for the given 325 | INPUT-STREAM. The result of the last form of BODY is returned." 326 | `(with-open-stream (,stream (make-decompressing-stream ,input-stream)) 327 | ,@body)) 328 | 329 | 330 | ;;; 331 | ;;; Compression functions 332 | ;;; 333 | 334 | (defun compress-stream (input output &key (level 3)) 335 | "Read the data from the INPUT octet stream, compress it, and write the result 336 | to the OUTPUT octet stream." 337 | (with-compressing-stream (stream output :level level) 338 | (let ((buffer (make-array +buffer-size+ :element-type 'u8))) 339 | (do ((n (read-sequence buffer input) (read-sequence buffer input))) 340 | ((zerop n) t) 341 | (write-sequence buffer stream :end n))))) 342 | 343 | (defun compress-file (input output &key (level 3)) 344 | "Read the data from the INPUT file, compress it, and write the result to the 345 | OUTPUT file." 346 | (with-open-file (input-stream input :element-type 'u8) 347 | (with-open-file (output-stream output :direction :output :element-type 'u8) 348 | (compress-stream input-stream output-stream :level level)))) 349 | 350 | (defun compress-buffer (buffer &key (start 0) end (level 3)) 351 | "Read the data between the START and END offsets in the BUFFER, compress it, 352 | and return the resulting octet vector." 353 | (let ((end (or end (length buffer)))) 354 | (octet-streams:with-octet-output-stream (output) 355 | (with-compressing-stream (stream output :level level) 356 | (write-sequence buffer stream :start start :end end))))) 357 | 358 | 359 | ;;; 360 | ;;; Decompression functions 361 | ;;; 362 | 363 | (defun decompress-stream (input output) 364 | "Read the data from the INPUT octet stream, decompress it, and write the 365 | result to the OUTPUT octet stream." 366 | (with-decompressing-stream (stream input) 367 | (let ((buffer (make-array +buffer-size+ :element-type 'u8))) 368 | (do ((n (read-sequence buffer stream) (read-sequence buffer stream))) 369 | ((zerop n) t) 370 | (write-sequence buffer output :end n))))) 371 | 372 | (defun decompress-file (input output) 373 | "Read the data from the INPUT file, decompress it, and write the result to 374 | the OUTPUT file." 375 | (with-open-file (input-stream input :element-type 'u8) 376 | (with-open-file (output-stream output :direction :output :element-type 'u8) 377 | (decompress-stream input-stream output-stream)))) 378 | 379 | (defun decompress-buffer (buffer &key (start 0) end) 380 | "Read the data between the START and END offsets in the BUFFER, decompress 381 | it, and return the resulting octet vector." 382 | (let ((end (or end (length buffer)))) 383 | (octet-streams:with-octet-output-stream (output) 384 | (octet-streams:with-octet-input-stream (input buffer start end) 385 | (decompress-stream input output))))) 386 | -------------------------------------------------------------------------------- /tests/test1.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software: you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation, either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License 307 | along with this program. If not, see . 308 | 309 | Also add information on how to contact you by electronic and paper mail. 310 | 311 | If the program is interactive, make it output a short notice like this 312 | when it starts in an interactive mode: 313 | 314 | Gnomovision version 69, Copyright (C) 315 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 316 | This is free software, and you are welcome to redistribute it 317 | under certain conditions; type `show c' for details. 318 | 319 | The hypothetical commands `show w' and `show c' should show the appropriate 320 | parts of the General Public License. Of course, the commands you use may 321 | be called something other than `show w' and `show c'; they could even be 322 | mouse-clicks or menu items--whatever suits your program. 323 | 324 | You should also get your employer (if you work as a programmer) or your 325 | school, if any, to sign a "copyright disclaimer" for the program, if 326 | necessary. Here is a sample; alter the names: 327 | 328 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 329 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 330 | 331 | , 1 April 1989 332 | Ty Coon, President of Vice 333 | 334 | This General Public License does not permit incorporating your program into 335 | proprietary programs. If your program is a subroutine library, you may 336 | consider it more useful to permit linking proprietary applications with the 337 | library. If this is what you want to do, use the GNU Lesser General 338 | Public License instead of this License. 339 | GNU GENERAL PUBLIC LICENSE 340 | Version 2, June 1991 341 | 342 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 343 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 344 | Everyone is permitted to copy and distribute verbatim copies 345 | of this license document, but changing it is not allowed. 346 | 347 | Preamble 348 | 349 | The licenses for most software are designed to take away your 350 | freedom to share and change it. By contrast, the GNU General Public 351 | License is intended to guarantee your freedom to share and change free 352 | software--to make sure the software is free for all its users. This 353 | General Public License applies to most of the Free Software 354 | Foundation's software and to any other program whose authors commit to 355 | using it. (Some other Free Software Foundation software is covered by 356 | the GNU Lesser General Public License instead.) You can apply it to 357 | your programs, too. 358 | 359 | When we speak of free software, we are referring to freedom, not 360 | price. Our General Public Licenses are designed to make sure that you 361 | have the freedom to distribute copies of free software (and charge for 362 | this service if you wish), that you receive source code or can get it 363 | if you want it, that you can change the software or use pieces of it 364 | in new free programs; and that you know you can do these things. 365 | 366 | To protect your rights, we need to make restrictions that forbid 367 | anyone to deny you these rights or to ask you to surrender the rights. 368 | These restrictions translate to certain responsibilities for you if you 369 | distribute copies of the software, or if you modify it. 370 | 371 | For example, if you distribute copies of such a program, whether 372 | gratis or for a fee, you must give the recipients all the rights that 373 | you have. You must make sure that they, too, receive or can get the 374 | source code. And you must show them these terms so they know their 375 | rights. 376 | 377 | We protect your rights with two steps: (1) copyright the software, and 378 | (2) offer you this license which gives you legal permission to copy, 379 | distribute and/or modify the software. 380 | 381 | Also, for each author's protection and ours, we want to make certain 382 | that everyone understands that there is no warranty for this free 383 | software. If the software is modified by someone else and passed on, we 384 | want its recipients to know that what they have is not the original, so 385 | that any problems introduced by others will not reflect on the original 386 | authors' reputations. 387 | 388 | Finally, any free program is threatened constantly by software 389 | patents. We wish to avoid the danger that redistributors of a free 390 | program will individually obtain patent licenses, in effect making the 391 | program proprietary. To prevent this, we have made it clear that any 392 | patent must be licensed for everyone's free use or not licensed at all. 393 | 394 | The precise terms and conditions for copying, distribution and 395 | modification follow. 396 | 397 | GNU GENERAL PUBLIC LICENSE 398 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 399 | 400 | 0. This License applies to any program or other work which contains 401 | a notice placed by the copyright holder saying it may be distributed 402 | under the terms of this General Public License. The "Program", below, 403 | refers to any such program or work, and a "work based on the Program" 404 | means either the Program or any derivative work under copyright law: 405 | that is to say, a work containing the Program or a portion of it, 406 | either verbatim or with modifications and/or translated into another 407 | language. (Hereinafter, translation is included without limitation in 408 | the term "modification".) Each licensee is addressed as "you". 409 | 410 | Activities other than copying, distribution and modification are not 411 | covered by this License; they are outside its scope. The act of 412 | running the Program is not restricted, and the output from the Program 413 | is covered only if its contents constitute a work based on the 414 | Program (independent of having been made by running the Program). 415 | Whether that is true depends on what the Program does. 416 | 417 | 1. You may copy and distribute verbatim copies of the Program's 418 | source code as you receive it, in any medium, provided that you 419 | conspicuously and appropriately publish on each copy an appropriate 420 | copyright notice and disclaimer of warranty; keep intact all the 421 | notices that refer to this License and to the absence of any warranty; 422 | and give any other recipients of the Program a copy of this License 423 | along with the Program. 424 | 425 | You may charge a fee for the physical act of transferring a copy, and 426 | you may at your option offer warranty protection in exchange for a fee. 427 | 428 | 2. You may modify your copy or copies of the Program or any portion 429 | of it, thus forming a work based on the Program, and copy and 430 | distribute such modifications or work under the terms of Section 1 431 | above, provided that you also meet all of these conditions: 432 | 433 | a) You must cause the modified files to carry prominent notices 434 | stating that you changed the files and the date of any change. 435 | 436 | b) You must cause any work that you distribute or publish, that in 437 | whole or in part contains or is derived from the Program or any 438 | part thereof, to be licensed as a whole at no charge to all third 439 | parties under the terms of this License. 440 | 441 | c) If the modified program normally reads commands interactively 442 | when run, you must cause it, when started running for such 443 | interactive use in the most ordinary way, to print or display an 444 | announcement including an appropriate copyright notice and a 445 | notice that there is no warranty (or else, saying that you provide 446 | a warranty) and that users may redistribute the program under 447 | these conditions, and telling the user how to view a copy of this 448 | License. (Exception: if the Program itself is interactive but 449 | does not normally print such an announcement, your work based on 450 | the Program is not required to print an announcement.) 451 | 452 | These requirements apply to the modified work as a whole. If 453 | identifiable sections of that work are not derived from the Program, 454 | and can be reasonably considered independent and separate works in 455 | themselves, then this License, and its terms, do not apply to those 456 | sections when you distribute them as separate works. But when you 457 | distribute the same sections as part of a whole which is a work based 458 | on the Program, the distribution of the whole must be on the terms of 459 | this License, whose permissions for other licensees extend to the 460 | entire whole, and thus to each and every part regardless of who wrote it. 461 | 462 | Thus, it is not the intent of this section to claim rights or contest 463 | your rights to work written entirely by you; rather, the intent is to 464 | exercise the right to control the distribution of derivative or 465 | collective works based on the Program. 466 | 467 | In addition, mere aggregation of another work not based on the Program 468 | with the Program (or with a work based on the Program) on a volume of 469 | a storage or distribution medium does not bring the other work under 470 | the scope of this License. 471 | 472 | 3. You may copy and distribute the Program (or a work based on it, 473 | under Section 2) in object code or executable form under the terms of 474 | Sections 1 and 2 above provided that you also do one of the following: 475 | 476 | a) Accompany it with the complete corresponding machine-readable 477 | source code, which must be distributed under the terms of Sections 478 | 1 and 2 above on a medium customarily used for software interchange; or, 479 | 480 | b) Accompany it with a written offer, valid for at least three 481 | years, to give any third party, for a charge no more than your 482 | cost of physically performing source distribution, a complete 483 | machine-readable copy of the corresponding source code, to be 484 | distributed under the terms of Sections 1 and 2 above on a medium 485 | customarily used for software interchange; or, 486 | 487 | c) Accompany it with the information you received as to the offer 488 | to distribute corresponding source code. (This alternative is 489 | allowed only for noncommercial distribution and only if you 490 | received the program in object code or executable form with such 491 | an offer, in accord with Subsection b above.) 492 | 493 | The source code for a work means the preferred form of the work for 494 | making modifications to it. For an executable work, complete source 495 | code means all the source code for all modules it contains, plus any 496 | associated interface definition files, plus the scripts used to 497 | control compilation and installation of the executable. However, as a 498 | special exception, the source code distributed need not include 499 | anything that is normally distributed (in either source or binary 500 | form) with the major components (compiler, kernel, and so on) of the 501 | operating system on which the executable runs, unless that component 502 | itself accompanies the executable. 503 | 504 | If distribution of executable or object code is made by offering 505 | access to copy from a designated place, then offering equivalent 506 | access to copy the source code from the same place counts as 507 | distribution of the source code, even though third parties are not 508 | compelled to copy the source along with the object code. 509 | 510 | 4. You may not copy, modify, sublicense, or distribute the Program 511 | except as expressly provided under this License. Any attempt 512 | otherwise to copy, modify, sublicense or distribute the Program is 513 | void, and will automatically terminate your rights under this License. 514 | However, parties who have received copies, or rights, from you under 515 | this License will not have their licenses terminated so long as such 516 | parties remain in full compliance. 517 | 518 | 5. You are not required to accept this License, since you have not 519 | signed it. However, nothing else grants you permission to modify or 520 | distribute the Program or its derivative works. These actions are 521 | prohibited by law if you do not accept this License. Therefore, by 522 | modifying or distributing the Program (or any work based on the 523 | Program), you indicate your acceptance of this License to do so, and 524 | all its terms and conditions for copying, distributing or modifying 525 | the Program or works based on it. 526 | 527 | 6. Each time you redistribute the Program (or any work based on the 528 | Program), the recipient automatically receives a license from the 529 | original licensor to copy, distribute or modify the Program subject to 530 | these terms and conditions. You may not impose any further 531 | restrictions on the recipients' exercise of the rights granted herein. 532 | You are not responsible for enforcing compliance by third parties to 533 | this License. 534 | 535 | 7. If, as a consequence of a court judgment or allegation of patent 536 | infringement or for any other reason (not limited to patent issues), 537 | conditions are imposed on you (whether by court order, agreement or 538 | otherwise) that contradict the conditions of this License, they do not 539 | excuse you from the conditions of this License. If you cannot 540 | distribute so as to satisfy simultaneously your obligations under this 541 | License and any other pertinent obligations, then as a consequence you 542 | may not distribute the Program at all. For example, if a patent 543 | license would not permit royalty-free redistribution of the Program by 544 | all those who receive copies directly or indirectly through you, then 545 | the only way you could satisfy both it and this License would be to 546 | refrain entirely from distribution of the Program. 547 | 548 | If any portion of this section is held invalid or unenforceable under 549 | any particular circumstance, the balance of the section is intended to 550 | apply and the section as a whole is intended to apply in other 551 | circumstances. 552 | 553 | It is not the purpose of this section to induce you to infringe any 554 | patents or other property right claims or to contest validity of any 555 | such claims; this section has the sole purpose of protecting the 556 | integrity of the free software distribution system, which is 557 | implemented by public license practices. Many people have made 558 | generous contributions to the wide range of software distributed 559 | through that system in reliance on consistent application of that 560 | system; it is up to the author/donor to decide if he or she is willing 561 | to distribute software through any other system and a licensee cannot 562 | impose that choice. 563 | 564 | This section is intended to make thoroughly clear what is believed to 565 | be a consequence of the rest of this License. 566 | 567 | 8. If the distribution and/or use of the Program is restricted in 568 | certain countries either by patents or by copyrighted interfaces, the 569 | original copyright holder who places the Program under this License 570 | may add an explicit geographical distribution limitation excluding 571 | those countries, so that distribution is permitted only in or among 572 | countries not thus excluded. In such case, this License incorporates 573 | the limitation as if written in the body of this License. 574 | 575 | 9. The Free Software Foundation may publish revised and/or new versions 576 | of the General Public License from time to time. Such new versions will 577 | be similar in spirit to the present version, but may differ in detail to 578 | address new problems or concerns. 579 | 580 | Each version is given a distinguishing version number. If the Program 581 | specifies a version number of this License which applies to it and "any 582 | later version", you have the option of following the terms and conditions 583 | either of that version or of any later version published by the Free 584 | Software Foundation. If the Program does not specify a version number of 585 | this License, you may choose any version ever published by the Free Software 586 | Foundation. 587 | 588 | 10. If you wish to incorporate parts of the Program into other free 589 | programs whose distribution conditions are different, write to the author 590 | to ask for permission. For software which is copyrighted by the Free 591 | Software Foundation, write to the Free Software Foundation; we sometimes 592 | make exceptions for this. Our decision will be guided by the two goals 593 | of preserving the free status of all derivatives of our free software and 594 | of promoting the sharing and reuse of software generally. 595 | 596 | NO WARRANTY 597 | 598 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 599 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 600 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 601 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 602 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 603 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 604 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 605 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 606 | REPAIR OR CORRECTION. 607 | 608 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 609 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 610 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 611 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 612 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 613 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 614 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 615 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 616 | POSSIBILITY OF SUCH DAMAGES. 617 | 618 | END OF TERMS AND CONDITIONS 619 | 620 | How to Apply These Terms to Your New Programs 621 | 622 | If you develop a new program, and you want it to be of the greatest 623 | possible use to the public, the best way to achieve this is to make it 624 | free software which everyone can redistribute and change under these terms. 625 | 626 | To do so, attach the following notices to the program. It is safest 627 | to attach them to the start of each source file to most effectively 628 | convey the exclusion of warranty; and each file should have at least 629 | the "copyright" line and a pointer to where the full notice is found. 630 | 631 | 632 | Copyright (C) 633 | 634 | This program is free software: you can redistribute it and/or modify 635 | it under the terms of the GNU General Public License as published by 636 | the Free Software Foundation, either version 2 of the License, or 637 | (at your option) any later version. 638 | 639 | This program is distributed in the hope that it will be useful, 640 | but WITHOUT ANY WARRANTY; without even the implied warranty of 641 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 642 | GNU General Public License for more details. 643 | 644 | You should have received a copy of the GNU General Public License 645 | along with this program. If not, see . 646 | 647 | Also add information on how to contact you by electronic and paper mail. 648 | 649 | If the program is interactive, make it output a short notice like this 650 | when it starts in an interactive mode: 651 | 652 | Gnomovision version 69, Copyright (C) 653 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 654 | This is free software, and you are welcome to redistribute it 655 | under certain conditions; type `show c' for details. 656 | 657 | The hypothetical commands `show w' and `show c' should show the appropriate 658 | parts of the General Public License. Of course, the commands you use may 659 | be called something other than `show w' and `show c'; they could even be 660 | mouse-clicks or menu items--whatever suits your program. 661 | 662 | You should also get your employer (if you work as a programmer) or your 663 | school, if any, to sign a "copyright disclaimer" for the program, if 664 | necessary. Here is a sample; alter the names: 665 | 666 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 667 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 668 | 669 | , 1 April 1989 670 | Ty Coon, President of Vice 671 | 672 | This General Public License does not permit incorporating your program into 673 | proprietary programs. If your program is a subroutine library, you may 674 | consider it more useful to permit linking proprietary applications with the 675 | library. If this is what you want to do, use the GNU Lesser General 676 | Public License instead of this License. 677 | -------------------------------------------------------------------------------- /tests/test1.txt.zst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/glv2/cl-zstd/2f0c95e7451def47df5919227f299b64d4a0464e/tests/test1.txt.zst -------------------------------------------------------------------------------- /tests/test2.txt.zst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/glv2/cl-zstd/2f0c95e7451def47df5919227f299b64d4a0464e/tests/test2.txt.zst -------------------------------------------------------------------------------- /tests/tests.lisp: -------------------------------------------------------------------------------- 1 | ;;; This file is part of cl-zstd 2 | ;;; Copyright 2020-2022 Guillaume LE VAILLANT 3 | ;;; Distributed under the GNU GPL v3 or later. 4 | ;;; See the file LICENSE for terms of use and distribution. 5 | 6 | (defpackage :zstd-tests 7 | (:use :cl :cl-octet-streams :fiveam :zstd)) 8 | 9 | (in-package :zstd-tests) 10 | 11 | 12 | (defun data-file-path (filename) 13 | (let ((path (concatenate 'string "tests/" filename))) 14 | (asdf:system-relative-pathname "zstd-tests" path))) 15 | 16 | (defun load-data-file (filename) 17 | (with-open-file (file (data-file-path filename) 18 | :element-type '(unsigned-byte 8)) 19 | (let* ((size (file-length file)) 20 | (buffer (make-array size :element-type '(unsigned-byte 8)))) 21 | (read-sequence buffer file) 22 | buffer))) 23 | 24 | (defun same-files-p (path-1 path-2) 25 | (with-open-file (file-1 path-1 :element-type '(unsigned-byte 8)) 26 | (with-open-file (file-2 path-2 :element-type '(unsigned-byte 8)) 27 | (let ((buffer-1 (make-array 16384 :element-type '(unsigned-byte 8))) 28 | (buffer-2 (make-array 16384 :element-type '(unsigned-byte 8)))) 29 | (loop for read-1 = (read-sequence buffer-1 file-1) 30 | for read-2 = (read-sequence buffer-2 file-2) 31 | never (or (/= read-1 read-2) 32 | (mismatch buffer-1 buffer-2 :end1 read-1 :end2 read-1)) 33 | until (zerop read-1)))))) 34 | 35 | 36 | (def-suite zstd-unit-tests 37 | :description "Unit tests for Zstandard (de)compression.") 38 | 39 | (in-suite zstd-unit-tests) 40 | 41 | 42 | (test decompressing-stream 43 | (with-octet-input-stream (input #(40 181 47 253 36 5 41 0 44 | 0 1 2 3 4 5 47 214 45 | 192 132)) 46 | (let ((stream (make-decompressing-stream input)) 47 | (tmp (make-array 2 :element-type '(unsigned-byte 8)))) 48 | (is (= 1 (read-byte stream))) 49 | (is (= 2 (read-byte stream))) 50 | (is (= 2 (read-sequence tmp stream))) 51 | (is (equalp #(3 4) tmp)) 52 | (is (= 5 (read-byte stream))) 53 | (is (eql :eof (read-byte stream nil :eof))) 54 | (close stream)))) 55 | 56 | (test decompress-stream 57 | (is (equalp #() 58 | (with-octet-output-stream (output) 59 | (with-octet-input-stream (input #(40 181 47 253 36 0 1 0 60 | 0 153 233 216 81)) 61 | (decompress-stream input output))))) 62 | (is (equalp #(1 2 3 4 5) 63 | (with-octet-output-stream (output) 64 | (with-octet-input-stream (input #(40 181 47 253 36 5 41 0 65 | 0 1 2 3 4 5 47 214 66 | 192 132)) 67 | (decompress-stream input output))))) 68 | (let ((tmp (with-octet-output-stream (output) 69 | (with-octet-input-stream (input #(40 181 47 253 164 160 134 1 70 | 0 85 0 0 16 115 115 1 71 | 0 155 134 57 192 2 13 41 72 | 68 46)) 73 | (decompress-stream input output))))) 74 | (is (= 100000 (length tmp))) 75 | (is-true (every (lambda (x) (= x 115)) tmp)))) 76 | 77 | (test decompress-file 78 | (let ((decompressed (data-file-path "test1.txt")) 79 | (compressed (data-file-path "test1.txt.zst")) 80 | (tmp "/tmp/zstd-test1.txt")) 81 | (unwind-protect 82 | (progn 83 | (is-true (decompress-file compressed tmp)) 84 | (is (same-files-p decompressed tmp))) 85 | (uiop:delete-file-if-exists tmp))) 86 | (let ((decompressed (data-file-path "test2.txt")) 87 | (compressed (data-file-path "test2.txt.zst")) 88 | (tmp "/tmp/zstd-test2.txt")) 89 | (unwind-protect 90 | (progn 91 | (is-true (decompress-file compressed tmp)) 92 | (is (same-files-p decompressed tmp))) 93 | (uiop:delete-file-if-exists tmp)))) 94 | 95 | (test decompress-buffer 96 | (let ((decompressed (load-data-file "test1.txt")) 97 | (compressed (load-data-file "test1.txt.zst"))) 98 | (is (equalp decompressed (decompress-buffer compressed)))) 99 | (is (equalp #(1 2 3 4 5) (decompress-buffer #(40 181 47 253 36 5 41 0 100 | 0 1 2 3 4 5 47 214 101 | 192 132))))) 102 | 103 | (test decompress-corrupt-archive 104 | (signals zstd-error (decompress-buffer #(1 1 1 1))) 105 | (signals zstd-error (decompress-buffer #(40 181 47 253))) 106 | (signals zstd-error (decompress-buffer #(40 181 47 253 36 5 41 0 107 | 0 1 2 3)))) 108 | 109 | (test compressing-stream 110 | (let ((compressed (with-octet-output-stream (output) 111 | (let ((stream (make-compressing-stream output :level 9))) 112 | (write-byte 1 stream) 113 | (write-byte 2 stream) 114 | (write-sequence #(3 4 1 2 3 4 1 2 3 4) stream) 115 | (write-byte 5 stream) 116 | (close stream))))) 117 | (is (equalp #(1 2 3 4 1 2 3 4 1 2 3 4 5) 118 | (decompress-buffer compressed))))) 119 | 120 | (test compress-stream 121 | (is (equalp #() 122 | (with-octet-output-stream (output) 123 | (with-octet-pipe (pipe) 124 | (with-octet-input-stream (input #()) 125 | (compress-stream input pipe) 126 | (decompress-stream pipe output)))))) 127 | (is (equalp #(1 2 3 4 5) 128 | (with-octet-output-stream (output) 129 | (with-octet-pipe (pipe) 130 | (with-octet-input-stream (input #(1 2 3 4 5)) 131 | (compress-stream input pipe) 132 | (decompress-stream pipe output)))))) 133 | (let* ((data (make-array 100000 134 | :element-type '(unsigned-byte 8) 135 | :initial-element 115)) 136 | (tmp (with-octet-output-stream (output) 137 | (with-octet-pipe (pipe) 138 | (with-octet-input-stream (input data) 139 | (compress-stream input pipe) 140 | (decompress-stream pipe output)))))) 141 | (is (equalp data tmp)))) 142 | 143 | (test compress-file 144 | (let ((decompressed (data-file-path "test1.txt")) 145 | (tmp-1 "/tmp/zstd-test1.txt.lz") 146 | (tmp-2 "/tmp/zstd-test1.txt")) 147 | (unwind-protect 148 | (progn 149 | (is-true (compress-file decompressed tmp-1)) 150 | (is-true (decompress-file tmp-1 tmp-2)) 151 | (is (same-files-p decompressed tmp-2))) 152 | (uiop:delete-file-if-exists tmp-1) 153 | (uiop:delete-file-if-exists tmp-2))) 154 | (let ((decompressed (data-file-path "test2.txt")) 155 | (tmp-1 "/tmp/zstd-test2.txt.lz") 156 | (tmp-2 "/tmp/zstd-test2.txt")) 157 | (unwind-protect 158 | (progn 159 | (is-true (compress-file decompressed tmp-1)) 160 | (is-true (decompress-file tmp-1 tmp-2)) 161 | (is (same-files-p decompressed tmp-2))) 162 | (uiop:delete-file-if-exists tmp-1) 163 | (uiop:delete-file-if-exists tmp-2)))) 164 | 165 | (test compress-buffer 166 | (let* ((decompressed (load-data-file "test1.txt")) 167 | (tmp-1 (compress-buffer decompressed)) 168 | (tmp-2 (decompress-buffer tmp-1))) 169 | (is (< (length tmp-1) (length decompressed))) 170 | (is-false (mismatch decompressed tmp-2))) 171 | (let* ((decompressed (make-array 123456 172 | :element-type '(unsigned-byte 8) 173 | :initial-element 55)) 174 | (tmp-1 (compress-buffer decompressed)) 175 | (tmp-2 (decompress-buffer tmp-1))) 176 | (is (< (length tmp-1) (length decompressed))) 177 | (is-false (mismatch decompressed tmp-2)))) 178 | 179 | (test compress-bad-options 180 | (signals zstd-error (compress-buffer #(7 6 6 7 6 6) :level nil)) 181 | (signals zstd-error (compress-buffer #(7 6 6 7 6 6) :level 200))) 182 | -------------------------------------------------------------------------------- /zstd-tests.asd: -------------------------------------------------------------------------------- 1 | ;;; This file is part of cl-zstd 2 | ;;; Copyright 2020-2022 Guillaume LE VAILLANT 3 | ;;; Distributed under the GNU GPL v3 or later. 4 | ;;; See the file LICENSE for terms of use and distribution. 5 | 6 | (defsystem "zstd-tests" 7 | :name "zstd-tests" 8 | :description "Tests for zstd" 9 | :version "2.0" 10 | :author "Guillaume Le Vaillant" 11 | :license "GPL-3" 12 | :depends-on ("cl-octet-streams" "fiveam" "uiop" "zstd") 13 | :in-order-to ((test-op (load-op "zstd-tests"))) 14 | :perform (test-op (op s) 15 | (let ((tests (uiop:find-symbol* 'zstd-unit-tests :zstd-tests))) 16 | (uiop:symbol-call :fiveam 'run! tests))) 17 | :components ((:module "tests" 18 | :serial t 19 | :components ((:static-file "test1.txt") 20 | (:static-file "test1.txt.zst") 21 | (:static-file "test2.txt") 22 | (:static-file "test2.txt.zst") 23 | (:file "tests"))))) 24 | -------------------------------------------------------------------------------- /zstd.asd: -------------------------------------------------------------------------------- 1 | ;;; This file is part of cl-zstd 2 | ;;; Copyright 2020-2022 Guillaume LE VAILLANT 3 | ;;; Distributed under the GNU GPL v3 or later. 4 | ;;; See the file LICENSE for terms of use and distribution. 5 | 6 | (defsystem "zstd" 7 | :name "zstd" 8 | :description "Zstandard (de)compression using bindings to libzstd" 9 | :version "2.0" 10 | :author "Guillaume Le Vaillant" 11 | :license "GPL-3" 12 | :depends-on ("cffi" "cl-octet-streams" "trivial-gray-streams") 13 | :in-order-to ((test-op (test-op "zstd-tests"))) 14 | :components ((:module "src" 15 | :serial t 16 | :components ((:file "package") 17 | (:file "libzstd") 18 | (:file "zstd"))))) 19 | --------------------------------------------------------------------------------