From 5151385681266818cc1314694e8d4f17c85df4c9 Mon Sep 17 00:00:00 2001 From: root670 Date: Sun, 17 May 2020 09:53:02 -0700 Subject: [PATCH] Update libpngquant to v2.12.5. --- pngquant/._MANUAL.md | Bin 4096 -> 0 bytes pngquant/.gitignore | 27 + pngquant/.travis.yml | 17 + pngquant/CHANGELOG | 65 + pngquant/CODE_OF_CONDUCT.md | 74 ++ pngquant/CONTRIBUTING.md | 26 + pngquant/COPYRIGHT | 645 ++++++++- pngquant/Cargo.toml | 39 + pngquant/MANUAL.md | 472 ------- pngquant/Makefile | 110 +- pngquant/README.md | 679 ++++++++++ pngquant/blur.c | 20 + pngquant/configure | 126 +- pngquant/imagequant.pc.in | 10 + pngquant/kmeans.c | 98 ++ pngquant/kmeans.h | 19 + pngquant/libimagequant.c | 1252 +++++++++++++----- pngquant/libimagequant.cs | 164 +++ pngquant/libimagequant.h | 120 +- pngquant/mediancut.c | 269 ++-- pngquant/mediancut.h | 2 +- pngquant/mempool.c | 17 +- pngquant/mempool.h | 8 +- pngquant/nearest.c | 336 ++--- pngquant/nearest.h | 4 +- pngquant/org/pngquant/Image.java | 74 ++ pngquant/org/pngquant/LiqObject.java | 19 + pngquant/org/pngquant/PngQuant.c | 156 +++ pngquant/org/pngquant/PngQuant.java | 111 ++ pngquant/org/pngquant/PngQuantException.java | 4 + pngquant/org/pngquant/Result.java | 90 ++ pngquant/pam.c | 146 +- pngquant/pam.h | 53 +- pngquant/pom.xml | 87 ++ pngquant/rust/build.rs | 63 + pngquant/rust/libimagequant.rs | 307 +++++ pngquant/viter.c | 89 -- pngquant/viter.h | 19 - 38 files changed, 4319 insertions(+), 1498 deletions(-) delete mode 100644 pngquant/._MANUAL.md create mode 100644 pngquant/.gitignore create mode 100644 pngquant/.travis.yml create mode 100644 pngquant/CHANGELOG create mode 100644 pngquant/CODE_OF_CONDUCT.md create mode 100644 pngquant/CONTRIBUTING.md create mode 100644 pngquant/Cargo.toml delete mode 100644 pngquant/MANUAL.md create mode 100644 pngquant/README.md create mode 100644 pngquant/imagequant.pc.in create mode 100644 pngquant/kmeans.c create mode 100644 pngquant/kmeans.h create mode 100644 pngquant/libimagequant.cs create mode 100644 pngquant/org/pngquant/Image.java create mode 100644 pngquant/org/pngquant/LiqObject.java create mode 100644 pngquant/org/pngquant/PngQuant.c create mode 100644 pngquant/org/pngquant/PngQuant.java create mode 100644 pngquant/org/pngquant/PngQuantException.java create mode 100644 pngquant/org/pngquant/Result.java create mode 100644 pngquant/pom.xml create mode 100644 pngquant/rust/build.rs create mode 100644 pngquant/rust/libimagequant.rs delete mode 100644 pngquant/viter.c delete mode 100644 pngquant/viter.h diff --git a/pngquant/._MANUAL.md b/pngquant/._MANUAL.md deleted file mode 100644 index f6005ddf7f195022691404497386866aab3bd57e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4096 zcmZQz6=P>$Vqox1Ojhs@R)|o50+1L3ClDJkFz{^v(m+1nBL)UWIUt(=a103v0xDsI z=wMg?WDB5a0m{L|rIPb=^%4sTa#Hnj5{pYpi&Ill5=&B*1A;+%KKZ0agXlASye1%e z6pV(zXb6mkz-S1JhQMeDjE2By2#kinXb6mkz-S1Jh5)V*0ChG&7!2e>GBS%5ic*X7 zON)|I71HvHvK2D(N>cMmGV}8ib8;#ba#GVu6q0fh^Rj_`VW_SlO`-Z9?iCpZx&QwG Dz8NVS diff --git a/pngquant/.gitignore b/pngquant/.gitignore new file mode 100644 index 0000000..8551194 --- /dev/null +++ b/pngquant/.gitignore @@ -0,0 +1,27 @@ +config.mk +imagequant.pc +*.lo +*.o +*.a +*.so.0 +*.so +*.bz2 +*.dylib +*.dylib.0 +*.jnilib +*.dSYM +org/pngquant/*.class +org/pngquant/*.h +target/ +msvc-dist/org/ +msvc-dist/*.md +msvc-dist/Makefile* +msvc-dist/*.cs +msvc-dist/*.xml +msvc-dist/CHANGELOG +msvc-dist/COPYRIGHT +msvc-dist/configure +msvc-dist/.gitignore +quantized_example.png +example +lodepng.? diff --git a/pngquant/.travis.yml b/pngquant/.travis.yml new file mode 100644 index 0000000..1a45e51 --- /dev/null +++ b/pngquant/.travis.yml @@ -0,0 +1,17 @@ +matrix: + include: + - os: linux + language: java + jdk: oraclejdk9 + env: CFLAGS="-fPIC" + install: true + script: make java + - os: linux + language: rust + script: cargo build --verbose --all && cargo test --verbose --all + - os: linux + language: generic + script: make static + - os: linux + language: generic + script: ./configure --prefix=/tmp && make libimagequant.so && make install diff --git a/pngquant/CHANGELOG b/pngquant/CHANGELOG new file mode 100644 index 0000000..8eac358 --- /dev/null +++ b/pngquant/CHANGELOG @@ -0,0 +1,65 @@ +version 2.12 +------------ + - new liq_histogram_add_fixed_color() + - faster for large/complex images + - workarounds for Microsoft's outdated C compiler + +version 2.11 +------------ + - new liq_image_set_background() for high-quality remapping of GIF frames + - new liq_image_set_importance_map() for controlling which parts of the image get more palette colors + - improved OpenMP support + +version 2.10 +----------- + - supports building with Rust/Cargo + +version 2.9 +----------- + - new liq_histogram_add_colors() + +version 2.8 +----------- + - standalone version + - added Java interface (JNI) + - new API for remapping multiple images to a single shared palette + +version 2.7 +----------- + - improved dithering of saturated and semitransparent colors + - libimagequant reports detailed progress and supports aborting of operations via callbacks + - fixed order of log output when using openmp + +version 2.5 +----------- + - replaced color search algorithm with vantage point tree, which is much faster and more reliable + - deprecated IE6 workaround + - warn when compiled without color profile support + - improved support for predefined colors in libimagequant + +version 2.4 +----------- + - fixed remapping of bright colors when dithering + - added libimagequant API to add fixed preset colors to the palette + +version 2.3 +----------- + - added ./configure script for better support of Intel C compiler and dependencies [thanks to pdknsk] + - tweaked quality metric to better estimate quality of images with large solid backgrounds [thanks to Rolf Timmermans] + - avoid applying quality setting to images that use palette already + +version 2.2 +----------- + - OpenMP acceleration + - improved support for Intel C Compiler, speedup in 32-bit GCC, and some workarounds for Visual Studio's incomplete C support + +version 2.1 +----------- + - option to generate posterized output (for use with 16-bit textures) + +version 2.0 +----------- + - refactored codebase into pngquant and standalone libimagequant + - reduced memory usage by further 30% (and more for very large images) + - less precise remapping improving speed by 25% in higher speed settings + - fixed regression in dithering of alpha channel diff --git a/pngquant/CODE_OF_CONDUCT.md b/pngquant/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9b40810 --- /dev/null +++ b/pngquant/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at kornel@geekhood.net. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/pngquant/CONTRIBUTING.md b/pngquant/CONTRIBUTING.md new file mode 100644 index 0000000..2c1e8e9 --- /dev/null +++ b/pngquant/CONTRIBUTING.md @@ -0,0 +1,26 @@ + +Thank you for contributing! pngquant and libimagequant are licensed under multiple +licenses, so to make things clear, I'm accepting contributions as licensed under +the BSD 2-clause license: + + Redistribution and use in source and binary forms, with or without modification, + are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/pngquant/COPYRIGHT b/pngquant/COPYRIGHT index 98de36b..4297b94 100644 --- a/pngquant/COPYRIGHT +++ b/pngquant/COPYRIGHT @@ -1,32 +1,637 @@ -© 1997-2002 by Greg Roelofs; based on an idea by Stefan Schneider. -© 2009-2014 by Kornel Lesiński. -All rights reserved. +libimagequant is derived from code by Jef Poskanzer and Greg Roelofs +licensed under pngquant's original license (at the end of this file), +and contains extensive changes and additions by Kornel Lesiński +licensed under GPL v3 or later. -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1. Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. +libimagequant © 2009-2018 by Kornel Lesiński. -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - © 1989, 1991 by Jef Poskanzer. +© 1997, 2000, 2002 by Greg Roelofs. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided diff --git a/pngquant/Cargo.toml b/pngquant/Cargo.toml new file mode 100644 index 0000000..c81176c --- /dev/null +++ b/pngquant/Cargo.toml @@ -0,0 +1,39 @@ +# libimagequant is a pure C library. +# Rust/Cargo is entirely optional. You can also use ./configure && make +[package] +version = "2.12.5" +authors = ["Kornel Lesiński "] +build = "rust/build.rs" +categories = ["external-ffi-bindings"] +homepage = "https://pngquant.org/lib" +include = ["COPYRIGHT", "rust/*", "*.c", "*.h", "README.md", "Cargo.toml"] +keywords = ["pngquant"] +license = "GPL-3.0+" +links = "imagequant" +name = "imagequant-sys" +readme = "README.md" +repository = "https://github.com/ImageOptim/libimagequant" +description = "Statically linked C part of imagequant library powering tools such as pngquant.\n\nThis library is dual-licensed like pngquant: either GPL or a commercial license. See website for details: https://pngquant.org" +edition = "2018" + +[build-dependencies] +cc = "1.0.38" + +[dependencies] +rgb = "0.8.13" + +[dependencies.openmp-sys] +optional = true +version = "0.1.5" + +[features] +default = ["sse"] +openmp = ["openmp-sys"] +openmp-static = ["openmp", "openmp-sys/static"] +sse = [] + +[lib] +crate-type = ["cdylib", "staticlib", "lib"] +name = "imagequant_sys" +path = "rust/libimagequant.rs" +doctest = false diff --git a/pngquant/MANUAL.md b/pngquant/MANUAL.md deleted file mode 100644 index 55cfa3d..0000000 --- a/pngquant/MANUAL.md +++ /dev/null @@ -1,472 +0,0 @@ -# libimagequant—Image Quantization Library - -Small, portable C library for high-quality conversion of RGBA images to 8-bit indexed-color (palette) images. -It's powering [pngquant2](http://pngquant.org). - -## License - -[BSD](https://raw.github.com/pornel/improved-pngquant/master/lib/COPYRIGHT). -It can be linked with both free and closed-source software. - -## Download - -The [library](http://pngquant.org/lib) is currently a part of the [pngquant2 project](https://github.com/pornel/improved-pngquant/tree/lib/lib). - -Files needed for the library are only in the `lib/` directory inside the repository (and you can ignore the rest). - -## Compiling and Linking - -The library can be linked with ANSI C and C++ programs. It has no external dependencies. - -To build on Unix-like systems run: - - make -C lib - -it will create `lib/libimagequant.a` which you can link with your program. - - gcc yourprogram.c /path/to/lib/libimagequant.a - -On BSD, use `gmake` (GNU make) rather than the native `make`. - -Alternatively you can compile the library with your program simply by including all `.c` files (and define `NDEBUG` to get a fast version): - - gcc -std=c99 -O3 -DNDEBUG lib/*.c yourprogram.c - -### Compiling on Windows/Visual Studio - -The library can be compiled with any C compiler that has at least basic support for C99 (GCC, clang, ICC, C++ Builder, even Tiny C Compiler), but Visual Studio 2012 and older are not up to date with the 1999 C standard. There are 2 options for using `libimagequant` on Windows: - - * Use Visual Studio **2013** (MSVC 18) and an [MSVC-compatible branch of the library](https://github.com/pornel/pngquant/tree/msvc/lib) - * Or use GCC from [MinGW](http://www.mingw.org). Use GCC to build `libimagequant.a` (using the instructions above for Unix) and add it along with `libgcc.a` (shipped with the MinGW compiler) to your VC project. - -## Overview - -The basic flow is: - -1. Create attributes object and configure the library. -2. Create image object from RGBA bitmap or data source. -3. Perform quantization (generate palette). -4. Store remapped image and final palette. -5. Free memory. - -

- - #include "lib/libimagequant.h" - - liq_attr *attr = liq_attr_create(); - liq_image *image = liq_image_create_rgba(attr, bitmap, width, height, 0); - liq_result *res = liq_quantize_image(attr, image); - - liq_write_remapped_image(res, image, bitmap, bitmap_size); - const liq_palette *pal = liq_get_palette(res); - - // use image and palette here - - liq_attr_destroy(attr); - liq_image_destroy(image); - liq_result_destroy(res); - -Functions returning `liq_error` return `LIQ_OK` (`0`) on success and non-zero on error. - -It's safe to pass `NULL` to any function accepting `liq_attr`, `liq_image`, `liq_result` (in that case the error code `LIQ_INVALID_POINTER` will be returned). These objects can be reused multiple times. - -There are 3 ways to create image object for quantization: - - * `liq_image_create_rgba()` for simple, contiguous RGBA bitmaps (width×height×4 bytes large array). - * `liq_image_create_rgba_rows()` for non-contiguous RGBA bitmaps (that have padding between rows or reverse order, e.g. BMP). - * `liq_image_create_custom()` for RGB, ABGR, YUV and all other formats that can be converted on-the-fly to RGBA (you have to supply the conversion function). - -## Functions - ----- - - liq_attr* liq_attr_create(void); - -Returns object that will hold initial settings (attributes) for the library. The object should be freed using `liq_attr_destroy()` after it's no longer needed. - -Returns `NULL` in the unlikely case that the library cannot run on the current machine (e.g. the library has been compiled for SSE-capable x86 CPU and run on VIA C3 CPU). - ----- - - liq_error liq_set_max_colors(liq_attr* attr, int colors); - -Specifies maximum number of colors to use. The default is 256. Instead of setting a fixed limit it's better to use `liq_set_quality()`. - -Returns `LIQ_VALUE_OUT_OF_RANGE` if number of colors is outside the range 2-256. - ----- - - int liq_get_max_colors(liq_attr* attr); - -Returns the value set by `liq_set_max_colors()`. - ----- - - liq_error liq_set_quality(liq_attr* attr, int minimum, int maximum); - -Quality is in range `0` (worst) to `100` (best) and values are analoguous to JPEG quality (i.e. `80` is usually good enough). - -Quantization will attempt to use the lowest number of colors needed to achieve `maximum` quality. `maximum` value of `100` is the default and means conversion as good as possible. - -If it's not possible to convert the image with at least `minimum` quality (i.e. 256 colors is not enough to meet the minimum quality), then `liq_quantize_image()` will fail. The default minumum is `0` (proceeds regardless of quality). - -Quality measures how well the generated palette fits image given to `liq_quantize_image()`. If a different image is remapped with `liq_write_remapped_image()` then actual quality may be different. - -Regardless of the quality settings the number of colors won't exceed the maximum (see `liq_set_max_colors()`). - -Returns `LIQ_VALUE_OUT_OF_RANGE` if target is lower than minimum or any of them is outside the 0-100 range. -Returns `LIQ_INVALID_POINTER` if `attr` appears to be invalid. - - liq_attr *attr = liq_attr_create(); - liq_set_quality(attr, 50, 80); // use quality 80 if possible. Give up if quality drops below 50. - ----- - - int liq_get_min_quality(liq_attr* attr); - -Returns the lower bound set by `liq_set_quality()`. - ----- - - int liq_get_max_quality(liq_attr* attr); - -Returns the upper bound set by `liq_set_quality()`. - ----- - - liq_image *liq_image_create_rgba(liq_attr *attr, void* bitmap, int width, int height, double gamma); - -Creates image object that represents a bitmap later used for quantization and remapping. The bitmap must be contiguous run of RGBA pixels (alpha is the last component, 0 = transparent, 255 = opaque). - -The bitmap must not be modified or freed until this object is freed with `liq_image_destroy()`. See also `liq_image_set_memory_ownership()`. - -`width` and `height` are dimensions in pixels. An image 10x10 pixel large will need 400-byte bitmap. - -`gamma` can be `0` for images with the typical 1/2.2 [gamma](http://en.wikipedia.org/wiki/Gamma_correction). -Otherwise `gamma` must be > 0 and < 1, e.g. `0.45455` (1/2.2) or `0.55555` (1/1.8). Generated palette will use the same gamma unless `liq_set_output_gamma()` is used. If `liq_set_output_gamma` is not used, then it only affects whether brighter or darker areas of the image will get more palette colors allocated. - -Returns `NULL` on failure, e.g. if `bitmap` is `NULL` or `width`/`height` is <= 0. - ----- - - liq_image *liq_image_create_rgba_rows(liq_attr *attr, void* rows[], int width, int height, double gamma); - -Same as `liq_image_create_rgba()`, but takes array of pointers to rows in the bitmap. This allows defining bitmaps with reversed rows (like in BMP), "stride" different than width or using only fragment of a larger bitmap, etc. - -`rows` array must have at least `height` elements and each row must be at least `width` RGBA pixels wide. - - unsigned char *bitmap = …; - void *rows = malloc(height * sizeof(void*)); - int bytes_per_row = width * 4 + padding; // stride - for(int i=0; i < height; i++) { - rows[i] = bitmap + i * bytes_per_row; - } - liq_image *img = liq_image_create_rgba_rows(attr, rows, width, height, 0); - // … - liq_image_destroy(img); - free(rows); - -The row pointers and bitmap must not be modified or freed until this object is freed with `liq_image_destroy()` (you can change that with `liq_image_set_memory_ownership()`). - -See also `liq_image_create_rgba()` and `liq_image_create_custom()`. - ----- - - liq_result *liq_quantize_image(liq_attr *attr, liq_image *input_image); - -Performs quantization (palette generation) based on settings in `attr` and pixels of the image. - -Returns `NULL` if quantization fails, e.g. due to limit set in `liq_set_quality()`. - -See `liq_write_remapped_image()`. - ----- - - liq_error liq_set_dithering_level(liq_result *res, float dither_level); - -Enables/disables dithering in `liq_write_remapped_image()`. Dithering level must be between `0` and `1` (inclusive). Dithering level `0` enables fast non-dithered remapping. Otherwise a variation of Floyd-Steinberg error diffusion is used. - -Precision of the dithering algorithm depends on the speed setting, see `liq_set_speed()`. - -Returns `LIQ_VALUE_OUT_OF_RANGE` if the dithering level is outside the 0-1 range. - ----- - - liq_error liq_write_remapped_image(liq_result *result, liq_image *input_image, void *buffer, size_t buffer_size); - -Remaps the image to palette and writes its pixels to the given buffer, 1 pixel per byte. Buffer must be large enough to fit the entire image, i.e. width×height bytes large. For safety, pass size of the buffer as `buffer_size`. - -For best performance call `liq_get_palette()` *after* this function, as palette is improved during remapping. - -Returns `LIQ_BUFFER_TOO_SMALL` if given size of the buffer is not enough to fit the entire image. - - int buffer_size = width*height; - char *buffer = malloc(buffer_size); - if (LIQ_OK == liq_write_remapped_image(result, input_image, buffer, buffer_size)) { - liq_palette *pal = liq_get_palette(result); - // save image - } - -See `liq_get_palette()` and `liq_write_remapped_image_rows()`. - ----- - - const liq_palette *liq_get_palette(liq_result *result); - -Returns pointer to palette optimized for image that has been quantized or remapped (final refinements are applied to the palette during remapping). - -It's valid to call this method before remapping, if you don't plan to remap any images or want to use same palette for multiple images. - -`liq_palette->count` contains number of colors (up to 256), `liq_palette->entries[n]` contains RGBA value for nth palette color. - -The palette is **temporary and read-only**. You must copy the palette elsewhere *before* calling `liq_result_destroy()`. - -Returns `NULL` on error. - ----- - - void liq_attr_destroy(liq_attr *); - void liq_image_destroy(liq_image *); - void liq_result_destroy(liq_result *); - -Releases memory owned by the given object. Object must not be used any more after it has been freed. - -Freeing `liq_result` also frees any `liq_palette` obtained from it. - -## Advanced Functions - ----- - - liq_error liq_set_speed(liq_attr* attr, int speed); - -Higher speed levels disable expensive algorithms and reduce quantization precision. The default speed is `3`. Speed `1` gives marginally better quality at significant CPU cost. Speed `10` has usually 5% lower quality, but is 8 times faster than the default. - -High speeds combined with `liq_set_quality()` will use more colors than necessary and will be less likely to meet minimum required quality. - - - - - - -
Features dependent on speed
Noise-sensitive ditheringspeed 1 to 5
Forced posterization8-10 or if image has more than million colors
Quantization error known1-7 or if minimum quality is set
Additional quantization techniques1-6
- -Returns `LIQ_VALUE_OUT_OF_RANGE` if the speed is outside the 1-10 range. - ----- - - int liq_get_speed(liq_attr* attr); - -Returns the value set by `liq_set_speed()`. - ----- - - liq_error liq_set_min_opacity(liq_attr* attr, int min); - -Alpha values higher than this will be rounded to opaque. This is a workaround for Internet Explorer 6 that truncates semitransparent values to completely transparent. The default is `255` (no change). 238 is a suggested value. - -Returns `LIQ_VALUE_OUT_OF_RANGE` if the value is outside the 0-255 range. - ----- - - int liq_get_min_opacity(liq_attr* attr); - -Returns the value set by `liq_set_min_opacity()`. - ----- - - liq_set_min_posterization(liq_attr* attr, int bits); - -Ignores given number of least significant bits in all channels, posterizing image to `2^bits` levels. `0` gives full quality. Use `2` for VGA or 16-bit RGB565 displays, `4` if image is going to be output on a RGB444/RGBA4444 display (e.g. low-quality textures on Android). - -Returns `LIQ_VALUE_OUT_OF_RANGE` if the value is outside the 0-4 range. - ----- - - int liq_get_min_posterization(liq_attr* attr); - -Returns the value set by `liq_set_min_posterization()`. - ----- - - liq_set_last_index_transparent(liq_attr* attr, int is_last); - -`0` (default) makes alpha colors sorted before opaque colors. Non-`0` mixes colors together except completely transparent color, which is moved to the end of the palette. This is a workaround for programs that blindly assume the last palette entry is transparent. - ----- - - liq_image *liq_image_create_custom(liq_attr *attr, liq_image_get_rgba_row_callback *row_callback, void *user_info, int width, int height, double gamma); - -

- - void image_get_rgba_row_callback(liq_color row_out[], int row_index, int width, void *user_info) { - for(int column_index=0; column_index < width; column_index++) { - row_out[column_index] = /* generate pixel at (row_index, column_index) */; - } - } - -Creates image object that will use callback to read image data. This allows on-the-fly conversion of images that are not in the RGBA color space. - -`user_info` value will be passed to the callback. It may be useful for storing pointer to program's internal representation of the image. - -The callback must read/generate `row_index`-th row and write its RGBA pixels to the `row_out` array. Row `width` is given for convenience and will always equal to image width. - -The callback will be called multiple times for each row. Quantization and remapping require at least two full passes over image data, so caching of callback's work makes no sense — in such case it's better to convert entire image and use `liq_image_create_rgba()` instead. - -To use RGB image: - - void rgb_to_rgba_callback(liq_color row_out[], int row_index, int width, void *user_info) { - unsigned char *rgb_row = ((unsigned char *)user_info) + 3*width*row_index; - - for(int i=0; i < width; i++) { - row_out[i].r = rgb_row[i*3]; - row_out[i].g = rgb_row[i*3+1]; - row_out[i].b = rgb_row[i*3+2]; - row_out[i].a = 255; - } - } - liq_image *img = liq_image_create_custom(attr, rgb_to_rgba_callback, rgb_bitmap, width, height, 0); - -The library doesn't support RGB bitmaps "natively", because supporting only single format allows compiler to inline more code, 4-byte pixel alignment is faster, and SSE instructions operate on 4 values at once, so alpha support is almost free. - ----- - - liq_error liq_image_set_memory_ownership(liq_image *image, int ownership_flags); - -Passes ownership of bitmap and/or rows memory to the `liq_image` object, so you don't have to free it yourself. Memory owned by the object will be freed at its discretion with `free` function specified in `liq_attr_create_with_allocator()` (by default it's stdlib's `free()`). - -* `LIQ_OWN_PIXELS` makes bitmap owned by the object. The bitmap will be freed automatically at any point when it's no longer needed. If you set this flag you must **not** free the bitmap yourself. If the image has been created with `liq_image_create_rgba_rows()` then the bitmap address is assumed to be the lowest address of any row. - -* `LIQ_OWN_ROWS` makes array of row pointers (but not bitmap pointed by these rows) owned by the object. Rows will be freed when object is deallocated. If you set this flag you must **not** free the rows array yourself. This flag is valid only if the object has been created with `liq_image_create_rgba_rows()`. - -These flags can be combined with binary *or*, i.e. `LIQ_OWN_PIXELS | LIQ_OWN_ROWS`. - -This function must not be used if the image has been created with `liq_image_create_custom()`. - -Returns `LIQ_VALUE_OUT_OF_RANGE` if invalid flags are specified or image is not backed by a bitmap. - ----- - - liq_error liq_write_remapped_image_rows(liq_result *result, liq_image *input_image, unsigned char **row_pointers); - -Similar to `liq_write_remapped_image()`. Writes remapped image, at 1 byte per pixel, to each row pointed by `row_pointers` array. The array must have at least as many elements as height of the image, and each row must have at least as many bytes as width of the image. Rows must not overlap. - -For best performance call `liq_get_palette()` *after* this function, as remapping may change the palette. - -Returns `LIQ_INVALID_POINTER` if `result` or `input_image` is `NULL`. - ----- - - double liq_get_quantization_error(liq_result *result); - -Returns mean square error of quantization (square of difference between pixel values in the original image and remapped image). Alpha channel and gamma correction are taken into account, so the result isn't exactly the mean square error of all channels. - -For most images MSE 1-5 is excellent. 7-10 is OK. 20-30 will have noticeable errors. 100 is awful. - -This function should be called *after* `liq_write_remapped_image()`. It may return `-1` if the value is not available (this is affected by `liq_set_speed()` and `liq_set_quality()`). - ----- - - double liq_get_quantization_quality(liq_result *result); - -Analoguous to `liq_get_quantization_error()`, but returns quantization error as quality value in the same 0-100 range that is used by `liq_set_quality()`. - -This function should be called *after* `liq_write_remapped_image()`. It may return `-1` if the value is not available (this is affected by `liq_set_speed()` and `liq_set_quality()`). - -This function can be used to add upper limit to quality options presented to the user, e.g. - - liq_attr *attr = liq_attr_create(); - liq_image *img = liq_image_create_rgba(…); - liq_result *res = liq_quantize_image(attr, img); - int max_attainable_quality = liq_get_quantization_quality(res); - printf("Please select quality between 0 and %d: ", max_attainable_quality); - int user_selected_quality = prompt(); - if (user_selected_quality < max_attainable_quality) { - liq_set_quality(user_selected_quality, 0); - liq_result_destroy(res); - res = liq_quantize_image(attr, img); - } - liq_write_remapped_image(…); - ----- - - void liq_set_log_callback(liq_attr*, liq_log_callback_function*, void *user_info); - -

- - void log_callback_function(const liq_attr*, const char *message, void *user_info) {} - ----- - - void liq_set_log_flush_callback(liq_attr*, liq_log_flush_callback_function*, void *user_info); -

- - void log_flush_callback_function(const liq_attr*, void *user_info) {} - -Sets up callback function to be called when the library reports work progress or errors. The callback must not call any library functions. - -`user_info` value will be passed to the callback. - -`NULL` callback clears the current callback. - -In the log callback the `message` is a zero-terminated string containing informative message to output. It is valid only until the callback returns. - -`liq_set_log_flush_callback()` sets up callback function that will be called after the last log callback, which can be used to flush buffers and free resources used by the log callback. - ----- - - liq_attr* liq_attr_create_with_allocator(void* (*malloc)(size_t), void (*free)(void*)); - -Same as `liq_attr_create`, but uses given `malloc` and `free` replacements to allocate all memory used by the library. - -The `malloc` function must return 16-byte aligned memory on x86 (and on other architectures memory aligned for `double` and pointers). Conversely, if your stdlib's `malloc` doesn't return appropriately aligned memory, you should use this function to provide aligned replacements. - ----- - - liq_attr* liq_attr_copy(liq_attr *orig); - -Creates an independent copy of `liq_attr`. The copy should also be freed using `liq_attr_destroy()`. - ---- - - liq_error liq_set_output_gamma(liq_result* res, double gamma); - -Sets gamma correction for generated palette and remapped image. Must be > 0 and < 1, e.g. `0.45455` for gamma 1/2.2 in PNG images. By default output gamma is same as gamma of the input image. - ----- - - int liq_image_get_width(const liq_image *img); - int liq_image_get_height(const liq_image *img); - double liq_get_output_gamma(const liq_result *result); - -Getters for `width`, `height` and `gamma` of the input image. - -If the input is invalid, these all return -1. - ---- - - int liq_version(); - -Returns version of the library as an integer. Same as `LIQ_VERSION`. Human-readable version is defined as `LIQ_VERSION_STRING`. - -## Multithreading - -The library is stateless and doesn't use any global or thread-local storage. It doesn't use any locks. - -* Different threads can perform unrelated quantizations/remappings at the same time (e.g. each thread working on a different image). -* The same `liq_attr`, `liq_result`, etc. can be accessed from different threads, but not at the same time (e.g. you can create `liq_attr` in one thread and free it in another). - -The library needs to sort unique colors present in the image. Although the sorting algorithm does few things to make stack usage minimal in typical cases, there is no guarantee against extremely degenerate cases, so threads should have automatically growing stack. - -### OpenMP - -The library will parallelize some operations if compiled with OpenMP. - -You must not increase number of maximum threads after `liq_image` has been created, as it allocates some per-thread buffers. - -Callback of `liq_image_create_custom()` may be called from different threads at the same time. - -## Acknowledgements - -Thanks to Irfan Skiljan for helping test the first version of the library. - -The library is developed by [Kornel Lesiński](mailto:%20kornel@pngquant.org). diff --git a/pngquant/Makefile b/pngquant/Makefile index 9be5889..ae8f896 100644 --- a/pngquant/Makefile +++ b/pngquant/Makefile @@ -1,36 +1,82 @@ -include config.mk STATICLIB=libimagequant.a +SHAREDLIB=libimagequant.$(SOLIBSUFFIX) +SOVER=0 +ifeq ($(SOLIBSUFFIX),dylib) + SHAREDLIBVER=libimagequant.$(SOVER).$(SOLIBSUFFIX) + FIX_INSTALL_NAME=install_name_tool -id $(LIBDIR)/$(SHAREDLIBVER) $(DESTDIR)$(LIBDIR)/$(SHAREDLIBVER) +else + SHAREDLIBVER=libimagequant.$(SOLIBSUFFIX).$(SOVER) + FIX_INSTALL_NAME= +endif -DLL=libimagequant.dll -DLLIMP=libimagequant_dll.a -DLLDEF=libimagequant_dll.def +JNILIB=libimagequant.jnilib +DLL=imagequant.dll +DLLIMP=imagequant_dll.a +DLLDEF=imagequant_dll.def +JNIDLL=libimagequant.dll +JNIDLLIMP=libimagequant_dll.a +JNIDLLDEF=libimagequant_dll.def -OBJS = pam.o mediancut.o blur.o mempool.o viter.o nearest.o libimagequant.o +OBJS = pam.o mediancut.o blur.o mempool.o kmeans.o nearest.o libimagequant.o +SHAREDOBJS = $(subst .o,.lo,$(OBJS)) -BUILD_CONFIGURATION="$(CC) $(CFLAGS) $(LDFLAGS)" +JAVACLASSES = org/pngquant/LiqObject.class org/pngquant/PngQuant.class org/pngquant/Image.class org/pngquant/Result.class +JAVAHEADERS = $(JAVACLASSES:.class=.h) +JAVAINCLUDE = -I'$(JAVA_HOME)/include' -I'$(JAVA_HOME)/include/linux' -I'$(JAVA_HOME)/include/win32' -I'$(JAVA_HOME)/include/darwin' -DISTFILES = $(OBJS:.o=.c) *.h MANUAL.md COPYRIGHT Makefile configure +DISTFILES = $(OBJS:.o=.c) *.h README.md CHANGELOG COPYRIGHT Makefile configure imagequant.pc.in TARNAME = libimagequant-$(VERSION) TARFILE = $(TARNAME)-src.tar.bz2 +PKGCONFIG = imagequant.pc -all: static +all: static shared static: $(STATICLIB) -dll: - $(MAKE) CFLAGSADD="-DLIQ_EXPORT='__declspec(dllexport)'" $(DLL) +shared: $(SHAREDLIB) +dll: + $(MAKE) CFLAGS="$(CFLAGS) -DIMAGEQUANT_EXPORTS" $(DLL) + +java: $(JNILIB) + +java-dll: + $(MAKE) CFLAGS="$(CFLAGS) -DIMAGEQUANT_EXPORTS" $(JNIDLL) $(DLL) $(DLLIMP): $(OBJS) - $(CC) -fPIC -shared -o $(DLL) $(OBJS) $(LDFLAGS) -Wl,--out-implib,$(DLLIMP),--output-def,$(DLLDEF) + $(CC) -fPIC -shared -o $(DLL) $^ $(LDFLAGS) -Wl,--out-implib,$(DLLIMP),--output-def,$(DLLDEF) $(STATICLIB): $(OBJS) $(AR) $(ARFLAGS) $@ $^ +$(SHAREDOBJS): + $(CC) -fPIC $(CFLAGS) -c $(@:.lo=.c) -o $@ + +libimagequant.so: $(SHAREDOBJS) + $(CC) -shared -Wl,-soname,$(SHAREDLIBVER) -o $(SHAREDLIBVER) $^ $(LDFLAGS) + ln -fs $(SHAREDLIBVER) $(SHAREDLIB) + +libimagequant.dylib: $(SHAREDOBJS) + $(CC) -shared -o $(SHAREDLIBVER) $^ $(LDFLAGS) + ln -fs $(SHAREDLIBVER) $(SHAREDLIB) + $(OBJS): $(wildcard *.h) config.mk -dist: $(TARFILE) +$(JNILIB): $(JAVAHEADERS) $(STATICLIB) org/pngquant/PngQuant.c + $(CC) -g $(CFLAGS) $(LDFLAGS) $(JAVAINCLUDE) -shared -o $@ org/pngquant/PngQuant.c $(STATICLIB) + +$(JNIDLL) $(JNIDLLIMP): $(JAVAHEADERS) $(OBJS) org/pngquant/PngQuant.c + $(CC) -fPIC -shared -I. $(JAVAINCLUDE) -o $(JNIDLL) $^ $(LDFLAGS) -Wl,--out-implib,$(JNIDLLIMP),--output-def,$(JNIDLLDEF) + +$(JAVACLASSES): %.class: %.java + javac $< + +$(JAVAHEADERS): %.h: %.class + javah -o $@ $(subst /,., $(patsubst %.class,%,$<)) && touch $@ + +dist: $(TARFILE) cargo $(TARFILE): $(DISTFILES) rm -rf $(TARFILE) $(TARNAME) @@ -40,16 +86,54 @@ $(TARFILE): $(DISTFILES) rm -rf $(TARNAME) -shasum $(TARFILE) +cargo: + rm -rf msvc-dist + git clone . -b msvc msvc-dist + rm -rf msvc-dist/Cargo.toml msvc-dist/org msvc-dist/rust msvc-dist/README.md msvc-dist/COPYRIGHT + cargo test + +example: example.c lodepng.h lodepng.c $(STATICLIB) + $(CC) -g $(CFLAGS) -Wall example.c $(STATICLIB) -o example + +lodepng.h: + curl -o lodepng.h -L https://raw.githubusercontent.com/lvandeve/lodepng/master/lodepng.h + +lodepng.c: + curl -o lodepng.c -L https://raw.githubusercontent.com/lvandeve/lodepng/master/lodepng.cpp + clean: - rm -f $(OBJS) $(STATICLIB) $(TARFILE) $(DLL) $(DLLIMP) $(DLLDEF) + rm -f $(OBJS) $(SHAREDOBJS) $(SHAREDLIBVER) $(SHAREDLIB) $(STATICLIB) $(TARFILE) $(DLL) '$(DLLIMP)' '$(DLLDEF)' + rm -f $(JAVAHEADERS) $(JAVACLASSES) $(JNILIB) example distclean: clean rm -f config.mk + rm -f imagequant.pc + +install: all $(PKGCONFIG) + install -d $(DESTDIR)$(LIBDIR) + install -d $(DESTDIR)$(PKGCONFIGDIR) + install -d $(DESTDIR)$(INCLUDEDIR) + install -m 644 $(STATICLIB) $(DESTDIR)$(LIBDIR)/$(STATICLIB) + install -m 644 $(SHAREDLIBVER) $(DESTDIR)$(LIBDIR)/$(SHAREDLIBVER) + ln -sf $(SHAREDLIBVER) $(DESTDIR)$(LIBDIR)/$(SHAREDLIB) + install -m 644 $(PKGCONFIG) $(DESTDIR)$(PKGCONFIGDIR)/$(PKGCONFIG) + install -m 644 libimagequant.h $(DESTDIR)$(INCLUDEDIR)/libimagequant.h + $(FIX_INSTALL_NAME) + +uninstall: + rm -f $(DESTDIR)$(LIBDIR)/$(STATICLIB) + rm -f $(DESTDIR)$(LIBDIR)/$(SHAREDLIBVER) + rm -f $(DESTDIR)$(LIBDIR)/$(SHAREDLIB) + rm -f $(DESTDIR)$(PKGCONFIGDIR)/$(PKGCONFIG) + rm -f $(DESTDIR)$(INCLUDEDIR)/libimagequant.h config.mk: ifeq ($(filter %clean %distclean, $(MAKECMDGOALS)), ) ./configure endif -.PHONY: all static clean dist distclean dll +$(PKGCONFIG): config.mk + sed 's|PREFIX|$(PREFIX)|;s|VERSION|$(VERSION)|' < imagequant.pc.in > $(PKGCONFIG) + +.PHONY: all static shared clean dist distclean dll java cargo .DELETE_ON_ERROR: diff --git a/pngquant/README.md b/pngquant/README.md new file mode 100644 index 0000000..6b47af9 --- /dev/null +++ b/pngquant/README.md @@ -0,0 +1,679 @@ +# libimagequant—Image Quantization Library + +Small, portable C library for high-quality conversion of RGBA images to 8-bit indexed-color (palette) images. +It's powering [pngquant2](https://pngquant.org). + +## License + +Libimagequant is dual-licensed: + +* For Free/Libre Open Source Software it's available under GPL v3 or later with additional [copyright notices](https://raw.github.com/ImageOptim/libimagequant/master/COPYRIGHT) for older parts of the code. +* For use in closed-source software, AppStore distribution, and other non-GPL uses, you can [obtain a commercial license](https://supso.org/projects/pngquant). Feel free to ask kornel@pngquant.org for details and custom licensing terms if you need them. + +## Download + +The [library](https://pngquant.org/lib) is currently a part of the [pngquant2 project](https://pngquant.org). [Repository](https://github.com/ImageOptim/libimagequant). + +## Compiling and Linking + +The library can be linked with ANSI C, C++, [C#](https://github.com/ImageOptim/libimagequant/blob/master/libimagequant.cs), [Rust](https://github.com/pornel/libimagequant-rust), [Java](https://github.com/ImageOptim/libimagequant/tree/master/org/pngquant) and [Golang](https://github.com/larrabee/go-imagequant) programs. It has no external dependencies. + +To build on Unix-like systems run: + + make static + +it will create `libimagequant.a` which you can link with your program. + + gcc yourprogram.c /path/to/libimagequant.a + +On BSD, use `gmake` (GNU make) rather than the native `make`. + +Alternatively you can compile the library with your program simply by including all `.c` files (and define `NDEBUG` to get a fast version): + + gcc -std=c99 -O3 -DNDEBUG libimagequant/*.c yourprogram.c + +### Building for use in Rust programs + +In [Rust](https://www.rust-lang.org/) you can use Cargo to build the library. Add [`imagequant`](https://crates.io/crates/imagequant) to dependencies of the Rust program. You can also use `cargo build` in [`imagequant-sys`](https://crates.io/crates/imagequant-sys) to build `libimagequant.a` for any C-compatible language. + +### Building for Java JNI + +To build Java JNI interface, ensure `JAVA_HOME` is set to your JDK directory, and run: + + # export JAVA_HOME=$(locate include/jni.h) # you may need to set JAVA_HOME first + make java + +It will create `libimagequant.jnilib` and classes in `org/pngquant/`. + +On Windows run `make java-dll` and it'll create `libimagequant.dll` instead. + +### Compiling on Windows/Visual Studio + +The library can be compiled with any C compiler that has at least basic support for C99 (GCC, clang, ICC, C++ Builder, even Tiny C Compiler), but Visual Studio 2012 and older are not up to date with the 1999 C standard. There are 2 options for using `libimagequant` on Windows: + + * Use Visual Studio **2015** and an [MSVC-compatible branch of the library](https://github.com/ImageOptim/libimagequant/tree/msvc) + * Or use GCC from [MinGW](http://www.mingw.org) or [MSYS2](http://www.msys2.org/). Use GCC to build `libimagequant.a` (using the instructions above for Unix) and add it along with `libgcc.a` (shipped with the MinGW compiler) to your VC project. + +### Building as shared library + +To build on Unix-like systems run: + + ./configure --prefix=/usr + make libimagequant.so + +To install on Unix-like systems run: + + make install + + + +## Overview + +The basic flow is: + +1. Create attributes object and configure the library. +2. Create image object from RGBA pixels or data source. +3. Perform quantization (generate palette). +4. Store remapped image and final palette. +5. Free memory. + +Please note that libimagequant only handles raw uncompressed arrays of pixels in memory and is completely independent of any file format. + +

+ /* See example.c for the full code! */ + + #include "libimagequant.h" + + liq_attr *attr = liq_attr_create(); + liq_image *image = liq_image_create_rgba(attr, example_bitmap_rgba, width, height, 0); + liq_result *res; + liq_image_quantize(image, attr, &res); + + liq_write_remapped_image(res, image, example_bitmap_8bpp, example_bitmap_size); + const liq_palette *pal = liq_get_palette(res); + + // Save the image and the palette now. + for(int i=0; i < pal->count; i++) { + example_copy_palette_entry(pal->entries[i]); + } + // You'll need a PNG library to write to a file. + example_write_image(example_bitmap_8bpp); + + liq_result_destroy(res); + liq_image_destroy(image); + liq_attr_destroy(attr); + +Functions returning `liq_error` return `LIQ_OK` (`0`) on success and non-zero on error. + +It's safe to pass `NULL` to any function accepting `liq_attr`, `liq_image`, `liq_result` (in that case the error code `LIQ_INVALID_POINTER` will be returned). These objects can be reused multiple times. + +There are 3 ways to create image object for quantization: + + * `liq_image_create_rgba()` for simple, contiguous RGBA pixel arrays (width×height×4 bytes large bitmap). + * `liq_image_create_rgba_rows()` for non-contiguous RGBA pixel arrays (that have padding between rows or reverse order, e.g. BMP). + * `liq_image_create_custom()` for RGB, ABGR, YUV and all other formats that can be converted on-the-fly to RGBA (you have to supply the conversion function). + +Note that "image" here means raw uncompressed pixels. If you have a compressed image file, such as PNG, you must use another library (e.g. libpng or lodepng) to decode it first. + +You'll find full example code in "example.c" file in the library source directory. + +## Functions + +---- + + liq_attr* liq_attr_create(void); + +Returns object that will hold initial settings (attributes) for the library. The object should be freed using `liq_attr_destroy()` after it's no longer needed. + +Returns `NULL` in the unlikely case that the library cannot run on the current machine (e.g. the library has been compiled for SSE-capable x86 CPU and run on VIA C3 CPU). + +---- + + liq_error liq_set_max_colors(liq_attr* attr, int colors); + +Specifies maximum number of colors to use. The default is 256. Instead of setting a fixed limit it's better to use `liq_set_quality()`. + +The first argument is attributes object from `liq_attr_create()`. + +Returns `LIQ_VALUE_OUT_OF_RANGE` if number of colors is outside the range 2-256. + +---- + + int liq_get_max_colors(liq_attr* attr); + +Returns the value set by `liq_set_max_colors()`. + +---- + + liq_error liq_set_quality(liq_attr* attr, int minimum, int maximum); + +Quality is in range `0` (worst) to `100` (best) and values are analoguous to JPEG quality (i.e. `80` is usually good enough). + +Quantization will attempt to use the lowest number of colors needed to achieve `maximum` quality. `maximum` value of `100` is the default and means conversion as good as possible. + +If it's not possible to convert the image with at least `minimum` quality (i.e. 256 colors is not enough to meet the minimum quality), then `liq_image_quantize()` will fail. The default minimum is `0` (proceeds regardless of quality). + +Quality measures how well the generated palette fits image given to `liq_image_quantize()`. If a different image is remapped with `liq_write_remapped_image()` then actual quality may be different. + +Regardless of the quality settings the number of colors won't exceed the maximum (see `liq_set_max_colors()`). + +The first argument is attributes object from `liq_attr_create()`. + +Returns `LIQ_VALUE_OUT_OF_RANGE` if target is lower than minimum or any of them is outside the 0-100 range. +Returns `LIQ_INVALID_POINTER` if `attr` appears to be invalid. + + liq_attr *attr = liq_attr_create(); + liq_set_quality(attr, 50, 80); // use quality 80 if possible. Give up if quality drops below 50. + +---- + + int liq_get_min_quality(liq_attr* attr); + +Returns the lower bound set by `liq_set_quality()`. + +---- + + int liq_get_max_quality(liq_attr* attr); + +Returns the upper bound set by `liq_set_quality()`. + +---- + + liq_image *liq_image_create_rgba(liq_attr *attr, void* pixels, int width, int height, double gamma); + +Creates an object that represents the image pixels to be used for quantization and remapping. The pixel array must be contiguous run of RGBA pixels (alpha is the last component, 0 = transparent, 255 = opaque). + +The first argument is attributes object from `liq_attr_create()`. The same `attr` object should be used for the entire process, from creation of images to quantization. + +The `pixels` array must not be modified or freed until this object is freed with `liq_image_destroy()`. See also `liq_image_set_memory_ownership()`. + +`width` and `height` are dimensions in pixels. An image 10x10 pixel large will need a 400-byte array. + +If the `gamma` argument is `0`, then the default of 1/2.2 [gamma](https://en.wikipedia.org/wiki/Gamma_correction) is assumed, which is good for most sRGB images. +Otherwise `gamma` must be > 0 and < 1, e.g. `0.45455` (1/2.2) or `0.55555` (1/1.8). Generated palette will use the same gamma unless `liq_set_output_gamma()` is used. If `liq_set_output_gamma` is not used, then it only affects whether brighter or darker areas of the image will get more palette colors allocated. + +Returns `NULL` on failure, e.g. if `pixels` is `NULL` or `width`/`height` is <= 0. + +---- + + liq_image *liq_image_create_rgba_rows(liq_attr *attr, void* rows[], int width, int height, double gamma); + +Same as `liq_image_create_rgba()`, but takes an array of pointers to rows of pixels. This allows defining images with reversed rows (like in BMP), "stride" different than width or using only fragment of a larger bitmap, etc. + +The `rows` array must have at least `height` elements, and each row must be at least `width` RGBA pixels wide. + + unsigned char *bitmap = …; + void *rows = malloc(height * sizeof(void*)); + int bytes_per_row = width * 4 + padding; // stride + for(int i=0; i < height; i++) { + rows[i] = bitmap + i * bytes_per_row; + } + liq_image *img = liq_image_create_rgba_rows(attr, rows, width, height, 0); + // … + liq_image_destroy(img); + free(rows); + +The row pointers and pixels must not be modified or freed until this object is freed with `liq_image_destroy()` (you can change that with `liq_image_set_memory_ownership()`). + +See also `liq_image_create_rgba()` and `liq_image_create_custom()`. + +---- + + liq_error liq_image_quantize(liq_image *const input_image, liq_attr *const attr, liq_result **out_result); + +Performs quantization (palette generation) based on settings in `attr` (from `liq_attr_create()`) and pixels of the image. + +Returns `LIQ_OK` if quantization succeeds and sets `liq_result` pointer in `out_result`. The last argument is used for receiving the `result` object: + + liq_result *result; + if (LIQ_OK == liq_image_quantize(img, attr, &result)) { // Note &result + // result pointer is valid here + } + +Returns `LIQ_QUALITY_TOO_LOW` if quantization fails due to limit set in `liq_set_quality()`. + +See `liq_write_remapped_image()`. + +If you want to generate one palette for multiple images at once, see `liq_histogram_create()`. + +---- + + liq_error liq_set_dithering_level(liq_result *res, float dither_level); + +Enables/disables dithering in `liq_write_remapped_image()`. Dithering level must be between `0` and `1` (inclusive). Dithering level `0` enables fast non-dithered remapping. Otherwise a variation of Floyd-Steinberg error diffusion is used. + +Precision of the dithering algorithm depends on the speed setting, see `liq_set_speed()`. + +Returns `LIQ_VALUE_OUT_OF_RANGE` if the dithering level is outside the 0-1 range. + +---- + + liq_error liq_write_remapped_image(liq_result *result, liq_image *input_image, void *buffer, size_t buffer_size); + +Remaps the image to palette and writes its pixels to the given buffer, 1 pixel per byte. + +The buffer must be large enough to fit the entire image, i.e. width×height bytes large. For safety, pass the size of the buffer as `buffer_size`. + +For best performance call `liq_get_palette()` *after* this function, as palette is improved during remapping (except when `liq_histogram_quantize()` is used). + +Returns `LIQ_BUFFER_TOO_SMALL` if given size of the buffer is not enough to fit the entire image. + + int buffer_size = width*height; + char *buffer = malloc(buffer_size); + if (LIQ_OK == liq_write_remapped_image(result, input_image, buffer, buffer_size)) { + liq_palette *pal = liq_get_palette(result); + // save image + } + +See `liq_get_palette()`. + +The buffer is assumed to be contiguous, with rows ordered from top to bottom, and no gaps between rows. If you need to write rows with padding or upside-down order, then use `liq_write_remapped_image_rows()`. + +Please note that it only writes raw uncompressed pixels to memory. It does not perform any PNG compression. If you'd like to create a PNG file then you need to pass the raw pixel data to another library, e.g. libpng or lodepng. See `rwpng.c` in `pngquant` project for an example how to do that. + +---- + + const liq_palette *liq_get_palette(liq_result *result); + +Returns pointer to palette optimized for image that has been quantized or remapped (final refinements are applied to the palette during remapping). + +It's valid to call this method before remapping, if you don't plan to remap any images or want to use same palette for multiple images. + +`liq_palette->count` contains number of colors (up to 256), `liq_palette->entries[n]` contains RGBA value for nth palette color. + +The palette is **temporary and read-only**. You must copy the palette elsewhere *before* calling `liq_result_destroy()`. + +Returns `NULL` on error. + +---- + + void liq_attr_destroy(liq_attr *); + void liq_image_destroy(liq_image *); + void liq_result_destroy(liq_result *); + void liq_histogram_destroy(liq_histogram *); + +Releases memory owned by the given object. Object must not be used any more after it has been freed. + +Freeing `liq_result` also frees any `liq_palette` obtained from it. + +## Advanced Functions + +---- + + liq_error liq_set_speed(liq_attr* attr, int speed); + +Higher speed levels disable expensive algorithms and reduce quantization precision. The default speed is `4`. Speed `1` gives marginally better quality at significant CPU cost. Speed `10` has usually 5% lower quality, but is 8 times faster than the default. + +High speeds combined with `liq_set_quality()` will use more colors than necessary and will be less likely to meet minimum required quality. + + + + + + +
Features dependent on speed
Noise-sensitive ditheringspeed 1 to 5
Forced posterization8-10 or if image has more than million colors
Quantization error known1-7 or if minimum quality is set
Additional quantization techniques1-6
+ +Returns `LIQ_VALUE_OUT_OF_RANGE` if the speed is outside the 1-10 range. + +---- + + int liq_get_speed(liq_attr* attr); + +Returns the value set by `liq_set_speed()`. + +---- + + liq_error liq_set_min_opacity(liq_attr* attr, int min); + +Alpha values higher than this will be rounded to opaque. This is a workaround for Internet Explorer 6, but because this browser is not used any more, this option is deprecated and will be removed. The default is `255` (no change). + +Returns `LIQ_VALUE_OUT_OF_RANGE` if the value is outside the 0-255 range. + +---- + + int liq_get_min_opacity(liq_attr* attr); + +Returns the value set by `liq_set_min_opacity()`. + +---- + + liq_set_min_posterization(liq_attr* attr, int bits); + +Ignores given number of least significant bits in all channels, posterizing image to `2^bits` levels. `0` gives full quality. Use `2` for VGA or 16-bit RGB565 displays, `4` if image is going to be output on a RGB444/RGBA4444 display (e.g. low-quality textures on Android). + +Returns `LIQ_VALUE_OUT_OF_RANGE` if the value is outside the 0-4 range. + +---- + + int liq_get_min_posterization(liq_attr* attr); + +Returns the value set by `liq_set_min_posterization()`. + +---- + + liq_set_last_index_transparent(liq_attr* attr, int is_last); + +`0` (default) makes alpha colors sorted before opaque colors. Non-`0` mixes colors together except completely transparent color, which is moved to the end of the palette. This is a workaround for programs that blindly assume the last palette entry is transparent. + +---- + + liq_image *liq_image_create_custom(liq_attr *attr, liq_image_get_rgba_row_callback *row_callback, void *user_info, int width, int height, double gamma); + +

+ + void image_get_rgba_row_callback(liq_color row_out[], int row_index, int width, void *user_info) { + for(int column_index=0; column_index < width; column_index++) { + row_out[column_index] = /* generate pixel at (row_index, column_index) */; + } + } + +Creates image object that will use callback to read image data. This allows on-the-fly conversion of images that are not in the RGBA color space. + +`user_info` value will be passed to the callback. It may be useful for storing pointer to program's internal representation of the image. + +The callback must read/generate `row_index`-th row and write its RGBA pixels to the `row_out` array. Row `width` is given for convenience and will always equal to image width. + +The callback will be called multiple times for each row. Quantization and remapping require at least two full passes over image data, so caching of callback's work makes no sense — in such case it's better to convert entire image and use `liq_image_create_rgba()` instead. + +To use RGB image: + + void rgb_to_rgba_callback(liq_color row_out[], int row_index, int width, void *user_info) { + unsigned char *rgb_row = ((unsigned char *)user_info) + 3*width*row_index; + + for(int i=0; i < width; i++) { + row_out[i].r = rgb_row[i*3]; + row_out[i].g = rgb_row[i*3+1]; + row_out[i].b = rgb_row[i*3+2]; + row_out[i].a = 255; + } + } + liq_image *img = liq_image_create_custom(attr, rgb_to_rgba_callback, rgb_bitmap, width, height, 0); + +The library doesn't support RGB bitmaps "natively", because supporting only single format allows compiler to inline more code, 4-byte pixel alignment is faster, and SSE instructions operate on 4 values at once, so alpha support is almost free. + +---- + + liq_error liq_image_set_memory_ownership(liq_image *image, int ownership_flags); + +Passes ownership of image pixel data and/or its rows array to the `liq_image` object, so you don't have to free it yourself. Memory owned by the object will be freed at its discretion with `free` function specified in `liq_attr_create_with_allocator()` (by default it's stdlib's `free()`). + +* `LIQ_OWN_PIXELS` makes pixel array owned by the object. The pixels will be freed automatically at any point when it's no longer needed. If you set this flag you must **not** free the pixel array yourself. If the image has been created with `liq_image_create_rgba_rows()` then the starting address of the array of pixels is assumed to be the lowest address of any row. + +* `LIQ_OWN_ROWS` makes array of row pointers (but not the pixels pointed by these rows) owned by the object. Rows will be freed when object is deallocated. If you set this flag you must **not** free the rows array yourself. This flag is valid only if the object has been created with `liq_image_create_rgba_rows()`. + +These flags can be combined with binary *or*, i.e. `LIQ_OWN_PIXELS | LIQ_OWN_ROWS`. + +This function must not be used if the image has been created with `liq_image_create_custom()`. + +Returns `LIQ_VALUE_OUT_OF_RANGE` if invalid flags are specified or the image object only takes pixels from a callback. + +---- + + liq_error liq_image_set_background(liq_image *image, liq_image *background_image); + +Analyze and remap this image with assumption that it will be always presented exactly on top of this background. + +When this image is remapped to a palette with a fully transparent color (use `liq_image_add_fixed_color()` to ensure this) pixels that are better represented by the background than the palette will be made transparent. This function can be used to improve quality of animated GIFs by setting previous animation frame as the background. + +This function takes full ownership of the background image, so you should **not** free the background object. It will be freed automatically together with the foreground image. + +Returns `LIQ_BUFFER_TOO_SMALL` if the background image has a different size than the foreground. + +---- + + liq_error liq_image_set_importance_map(liq_image *image, unsigned char map[], size_t buffer_size, liq_ownership ownership); + +Impotance map controls which areas of the image get more palette colors. Pixels corresponding to 0 values in the map are completely ignored. The higher the value the more weight is placed on the given pixel, giving it higher chance of influencing the final palette. + +The map is one byte per pixel and must have the same size as the image (width×height bytes). `buffer_size` argument is used to double-check that. + +If the `ownership` is `LIQ_COPY_PIXELS` then the `map` content be copied immediately (it's up to you to ensure the `map` memory is freed). + +If the `ownership` is `LIQ_OWN_PIXELS` then the `map` memory will be owned by the image and will be freed automatically when the image is freed. If a custom allocator has been set using `liq_attr_create_with_allocator()`, the `map` must be allocated using the same allocator. + +Returns `LIQ_INVALID_POINTER` if any pointer is `NULL`, `LIQ_BUFFER_TOO_SMALL` if the `buffer_size` does not match the image size, and `LIQ_UNSUPPORTED` if `ownership` isn't a valid value. + +---- + + liq_error liq_write_remapped_image_rows(liq_result *result, liq_image *input_image, unsigned char **row_pointers); + +Similar to `liq_write_remapped_image()`. Writes remapped image, at 1 byte per pixel, to each row pointed by `row_pointers` array. The array must have at least as many elements as height of the image, and each row must have at least as many bytes as width of the image. Rows must not overlap. + +For best performance call `liq_get_palette()` *after* this function, as remapping may change the palette (except when `liq_histogram_quantize()` is used). + +Returns `LIQ_INVALID_POINTER` if `result` or `input_image` is `NULL`. + +---- + + double liq_get_quantization_error(liq_result *result); + +Returns mean square error of quantization (square of difference between pixel values in the source image and its remapped version). Alpha channel, gamma correction and approximate importance of pixels is taken into account, so the result isn't exactly the mean square error of all channels. + +For most images MSE 1-5 is excellent. 7-10 is OK. 20-30 will have noticeable errors. 100 is awful. + +This function may return `-1` if the value is not available (this happens when a high speed has been requested, the image hasn't been remapped yet, and quality limit hasn't been set, see `liq_set_speed()` and `liq_set_quality()`). The value is not updated when multiple images are remapped, it applies only to the image used in `liq_image_quantize()` or the first image that has been remapped. See `liq_get_remapping_error()`. + +---- + + double liq_get_remapping_error(liq_result *result); + +Returns mean square error of last remapping done (square of difference between pixel values in the remapped image and its remapped version). Alpha channel and gamma correction are taken into account, so the result isn't exactly the mean square error of all channels. + +This function may return `-1` if the value is not available (this happens when a high speed has been requested or the image hasn't been remapped yet). + +---- + + double liq_get_quantization_quality(liq_result *result); + +Analoguous to `liq_get_quantization_error()`, but returns quantization error as quality value in the same 0-100 range that is used by `liq_set_quality()`. + +It may return `-1` if the value is not available (see note in `liq_get_quantization_error()`). + +This function can be used to add upper limit to quality options presented to the user, e.g. + + liq_attr *attr = liq_attr_create(); + liq_image *img = liq_image_create_rgba(…); + liq_result *res; + liq_image_quantize(img, attr, &res); + int max_attainable_quality = liq_get_quantization_quality(res); + printf("Please select quality between 0 and %d: ", max_attainable_quality); + int user_selected_quality = prompt(); + if (user_selected_quality < max_attainable_quality) { + liq_set_quality(user_selected_quality, 0); + liq_result_destroy(res); + liq_image_quantize(img, attr, &res); + } + liq_write_remapped_image(…); + +---- + + double liq_get_remapping_quality(liq_result *result); + +Analoguous to `liq_get_remapping_error()`, but returns quantization error as quality value in the same 0-100 range that is used by `liq_set_quality()`. + +---- + + void liq_set_log_callback(liq_attr*, liq_log_callback_function*, void *user_info); + +

+ + void log_callback_function(const liq_attr*, const char *message, void *user_info) {} + +---- + + void liq_set_log_flush_callback(liq_attr*, liq_log_flush_callback_function*, void *user_info); +

+ + void log_flush_callback_function(const liq_attr*, void *user_info) {} + +Sets up callback function to be called when the library reports status or errors. The callback must not call any library functions. + +`user_info` value will be passed through to the callback. It can be `NULL`. + +`NULL` callback clears the current callback. + +In the log callback the `message` is a zero-terminated string containing informative message to output. It is valid only until the callback returns, so you must copy it. + +`liq_set_log_flush_callback()` sets up callback function that will be called after the last log callback, which can be used to flush buffers and free resources used by the log callback. + +---- + + void liq_set_progress_callback(liq_attr*, liq_progress_callback_function*, void *user_info); + void liq_result_set_progress_callback(liq_result*, liq_progress_callback_function*, void *user_info); + +

+ + int progress_callback_function(const liq_attr*, float progress_percent, void *user_info) {} + +Sets up callback function to be called while the library is processing images. The callback may abort processing by returning `0`. + +Setting callback to `NULL` clears the current callback. `liq_set_progress_callback` is for quantization progress, and `liq_result_set_progress_callback` is for remapping progress (currently only dithered remapping reports progress). + +`user_info` value will be passed through to the callback. It can be `NULL`. + +The callback must not call any library functions. + +`progress_percent` is a value between 0 and 100 that estimates how much of the current task has been done. + +The callback should return `1` to continue the operation, and `0` to abort current operation. + +---- + + liq_attr* liq_attr_create_with_allocator(void* (*malloc)(size_t), void (*free)(void*)); + +Same as `liq_attr_create`, but uses given `malloc` and `free` replacements to allocate all memory used by the library. + +The `malloc` function must return 16-byte aligned memory on x86 (and on other architectures memory aligned for `double` and pointers). Conversely, if your stdlib's `malloc` doesn't return appropriately aligned memory, you should use this function to provide aligned replacements. + +---- + + liq_attr* liq_attr_copy(liq_attr *orig); + +Creates an independent copy of `liq_attr`. The copy should also be freed using `liq_attr_destroy()`. + +--- + + liq_error liq_set_output_gamma(liq_result* res, double gamma); + +Sets gamma correction for generated palette and remapped image. Must be > 0 and < 1, e.g. `0.45455` for gamma 1/2.2 in PNG images. By default output gamma is same as gamma of the input image. + +---- + + int liq_image_get_width(const liq_image *img); + int liq_image_get_height(const liq_image *img); + double liq_get_output_gamma(const liq_result *result); + +Getters for `width`, `height` and `gamma` of the input image. + +If the input is invalid, these all return -1. + +--- + + liq_error liq_image_add_fixed_color(liq_image* img, liq_color color); + liq_error liq_histogram_add_fixed_color(liq_histogram* hist, liq_color color, double gamma); + +Reserves a color in the output palette created from this image. It behaves as if the given color was used in the image and was very important. + +RGB values of `liq_color` are assumed to have the same gamma as the image. For the histogram function, the `gamma` can be `0` (see `liq_image_create_rgba()`). + +It must be called before the image is quantized. + +Returns error if more than 256 colors are added. If image is quantized to fewer colors than the number of fixed colors added, then excess fixed colors will be ignored. + +For histograms see also a more flexible `liq_histogram_add_colors()`. + +--- + + int liq_version(); + +Returns version of the library as an integer. Same as `LIQ_VERSION`. Human-readable version is defined as `LIQ_VERSION_STRING`. + +## Multiple images with the same palette + +It's possible to efficiently generate a single palette that is optimal for multiple images, e.g. for an APNG animation. This is done by collecting statistics of images in a `liq_histogram` object. + + liq_attr *attr = liq_attr_create(); + liq_histogram *hist = liq_histogram_create(attr); + + liq_image *image1 = liq_image_create_rgba(attr, example_bitmap_rgba1, width, height, 0); + liq_histogram_add_image(hist, attr, image1); + + liq_image *image2 = liq_image_create_rgba(attr, example_bitmap_rgba2, width, height, 0); + liq_histogram_add_image(hist, attr, image2); + + liq_result *result; + liq_error err = liq_histogram_quantize(attr, hist, &result); + if (LIQ_OK == err) { + // result will contain shared palette best for both image1 and image2 + } + +--- + + liq_histogram *liq_histogram_create(liq_attr *attr); + +Creates histogram object that will be used to collect color statistics from multiple images. It must be freed using `liq_histogram_destroy()`. + +All options should be set on `attr` before the histogram object is created. Options changed later may not have effect. + +--- + + liq_error liq_histogram_add_image(liq_histogram *hist, liq_attr *attr, liq_image* image); + +"Learns" colors from the image, which will be later used to generate the palette. + +After the image is added to the histogram it may be freed to save memory (but it's more efficient to keep the image object if it's going to be used for remapping). + +Fixed colors added to the image are also added to the histogram. If total number of fixed colors exceeds 256, this function will fail with `LIQ_BUFFER_TOO_SMALL`. + +--- + + liq_error liq_histogram_add_colors(liq_histogram *hist, liq_attr *attr, liq_histogram_entry entries[], int num_entries, double gamma); + +Alternative to `liq_histogram_add_image()`. Intead of counting colors in an image, it directly takes an array of colors and their counts (see `liq_histogram_entry` in `libimagequant.h`). This function is only useful if you already have a histogram of the image from another source. + +For description of gamma, see `liq_image_create_rgba()`. + +--- + + liq_error liq_histogram_quantize(liq_histogram *const hist, liq_attr *const attr, liq_result **out_result); + +Generates palette from the histogram. On success returns `LIQ_OK` and writes `liq_result*` pointer to `out_result`. Use it as follows: + + liq_result *result; + liq_error err = liq_histogram_quantize(attr, hist, &result); + if (LIQ_OK == err) { + // Use result here to remap and get palette + } + +Returns `LIQ_QUALITY_TOO_LOW` if the palette is worse than limit set in `liq_set_quality()`. One histogram object can be quantized only once. + +Palette generated using this function won't be improved during remapping. If you're generating palette for only one image, it's better to use `liq_image_quantize()`. + +## Working with GIF + +The library can generate palettes for GIF images. To ensure correct transparency is used you need to preprocess the image yourself and replace alpha values other than 0 or 255 with one of these. + +For animated GIFs see `liq_image_set_background()` which remaps images for GIF's "keep" frame disposal method. See [gif.ski](https://gif.ski). + +## Multithreading + +The library is stateless and doesn't use any global or thread-local storage. It doesn't use any locks. + +* Different threads can perform unrelated quantizations/remappings at the same time (e.g. each thread working on a different image). +* The same `liq_attr`, `liq_result`, etc. can be accessed from different threads, but not at the same time (e.g. you can create `liq_attr` in one thread and free it in another). + +The library needs to sort unique colors present in the image. Although the sorting algorithm does few things to make stack usage minimal in typical cases, there is no guarantee against extremely degenerate cases, so threads should have automatically growing stack. + +### OpenMP + +The library will parallelize some operations if compiled with OpenMP. + +You must not increase number of maximum threads after `liq_image` has been created, as it allocates some per-thread buffers. + +Callback of `liq_image_create_custom()` may be called from different threads at the same time. + +## Acknowledgements + +Thanks to Irfan Skiljan for helping test the first version of the library. + +The library is developed by [Kornel Lesiński](mailto:%20kornel@pngquant.org). diff --git a/pngquant/blur.c b/pngquant/blur.c index 9158ad4..7f0a716 100644 --- a/pngquant/blur.c +++ b/pngquant/blur.c @@ -1,3 +1,21 @@ +/* +© 2011-2015 by Kornel Lesiński. + +This file is part of libimagequant. + +libimagequant is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +libimagequant is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with libimagequant. If not, see . +*/ #include "libimagequant.h" #include "pam.h" @@ -8,6 +26,8 @@ */ static void transposing_1d_blur(unsigned char *restrict src, unsigned char *restrict dst, unsigned int width, unsigned int height, const unsigned int size) { + assert(size > 0); + for(unsigned int j=0; j < height; j++) { unsigned char *restrict row = src + j*width; diff --git a/pngquant/configure b/pngquant/configure index 832c5bc..31da186 100644 --- a/pngquant/configure +++ b/pngquant/configure @@ -2,9 +2,13 @@ CONFIG="config.mk" PREFIX="/usr/local" +LIBDIR="$PREFIX/lib" +INCLUDEDIR="$PREFIX/include" +PKGCONFIGDIR="$LIBDIR/pkgconfig" VERSION=$(grep LIQ_VERSION_STRING libimagequant.h | grep -Eo "2\.[0-9.]+") DEBUG= +QUIET=0 SSE=auto OPENMP= EXTRA_CFLAGS= @@ -19,16 +23,23 @@ help() { for i in "$@"; do case $i in - --help) + --help|-h) echo - help "--prefix= installation directory [$PREFIX]" - help "--extra-cflags= append to CFLAGS" - help "--extra-ldflags= append to LDFLAGS" + help "--prefix=

installation directory [$PREFIX]" + help "--libdir= installation directory [$LIBDIR]" + help "--includedir= installation directory [$INCLUDEDIR]" + help "--pkgconfigdir= installation directory [$PKGCONFIGDIR]" + help "--extra-cflags= append to CFLAGS" + help "--extra-ldflags= append to LDFLAGS" echo help "--enable-debug" help "--enable-sse/--disable-sse enable/disable SSE instructions" echo - help "--with-openmp compile with multicore support" + help "--with-openmp=static compile with multicore support" + echo + help "CC= use given compiler command" + help "CFLAGS= pass options to the compiler" + help "LDFLAGS= pass options to the linker" echo exit 0 ;; @@ -51,11 +62,33 @@ for i in "$@"; do --disable-sse) SSE=0 ;; + --quiet) + QUIET=1 + ;; + '') + # allows a bash quirk + ;; --with-openmp) OPENMP=1 ;; + --with-openmp=static) + OPENMP=static + ;; --prefix=*) PREFIX=${i#*=} + LIBDIR="$PREFIX/lib" + INCLUDEDIR="$PREFIX/include" + PKGCONFIGDIR="$LIBDIR/pkgconfig" + ;; + --libdir=*) + LIBDIR=${i#*=} + PKGCONFIGDIR="$LIBDIR/pkgconfig" + ;; + --includedir=*) + INCLUDEDIR=${i#*=} + ;; + --pkgconfigdir=*) + PKGCONFIGDIR=${i#*=} ;; # can be used multiple times or in quotes to set multiple flags --extra-cflags=*) @@ -65,8 +98,7 @@ for i in "$@"; do EXTRA_LDFLAGS="$EXTRA_LDFLAGS ${i#*=}" ;; *) - echo "error: unknown switch ${i%%=*}" - exit 1 + echo "warning: unknown switch '${i%%=*}' (see $0 --help for the list)" ;; esac done @@ -87,13 +119,15 @@ lflags() { } status() { - printf "%10s: %s\n" "$1" "$2" + if [ "$QUIET" -ne 1 ]; then + printf "%10s: %s\n" "$1" "$2" + fi } # Append to CFLAGS if compiler supports flag, with optional prerequisite. # Fails on errors and warnings. conditional_cflags() { - if [ -z "$("$CC" -xc -S -o /dev/null $2 $1 <(echo) 2>&1)" ]; then + if [ -z "$(echo | "$CC" -xc -S -o /dev/null $2 $1 - 2>&1)" ]; then cflags "$1" fi } @@ -104,34 +138,40 @@ error() { exit 1 } -echo - -# basic check -if ! "$CC" -xc -std=c99 <(echo "int main(){}") -o /dev/null &> /dev/null; then - error "Compiler" "$CC is no C compiler" +if [ "$QUIET" -ne 1 ]; then + echo fi +echo > pngquant-gcccheck.c "int main(){}" +if ! "$CC" -std=c99 -o pngquant-gcccheck pngquant-gcccheck.c; then + rm -f pngquant-gcccheck pngquant-gcccheck.c + error "Compiler" "$CC failed to compile anything (make sure it's installed and supports C99)" +fi +rm -f pngquant-gcccheck pngquant-gcccheck.c + status "Compiler" "$CC" # init flags -CFLAGS=${CFLAGS:--O3 -fno-math-errno -funroll-loops -fomit-frame-pointer -Wall} +CFLAGS=${CFLAGS:--fno-math-errno -funroll-loops -fomit-frame-pointer -Wall} cflags "-std=c99 -I." -lflags "-lm lib/libimagequant.a" # DEBUG if [ -z "$DEBUG" ]; then - cflags "-DNDEBUG" + cflags "-O3 -DNDEBUG" status "Debug" "no" else - cflags "-g" + cflags "-O1 -g -DDEBUG" status "Debug" "yes" fi # SSE if [ "$SSE" = 'auto' ]; then - if [[ "$(uname -m)" =~ (amd|x86_)64 || - "$(grep -E -m1 "^flags" /proc/cpuinfo)" =~ "sse" ]]; then - SSE=1 + SSE=0 + if type uname > /dev/null; then + if [[ "$(uname -m)" =~ "amd64" || "$(uname -m)" =~ "x86_64" || + "$(grep -E -m1 "^flags" /proc/cpuinfo)" =~ "sse" ]]; then + SSE=1 + fi fi fi @@ -150,15 +190,19 @@ fi # OpenMP if [ -n "$OPENMP" ]; then - if [[ "$("$CC" -xc -E -fopenmp <(echo -e \ - "#ifdef _OPENMP + if [ "static" = "$OPENMP" ]; then + OPENMPFLAGS="-static-libgcc -Bstatic -fopenmp -Bdynamic" + else + OPENMPFLAGS="-fopenmp" + fi + if [[ "$("$CC" -xc -E $OPENMPFLAGS <(echo "#ifdef _OPENMP #include #endif") 2>&1)" =~ "omp_get_thread_num" ]]; then - cflags "-fopenmp" - lflags "-fopenmp" + cflags "$OPENMPFLAGS" + lflags "$OPENMPFLAGS" status "OpenMP" "yes" else - error "OpenMP" "not supported by compiler" + error "OpenMP" "not supported by compiler (please install a compiler that supports OpenMP (e.g. gcc) and specify it with the CC= argument)" fi else # silence warnings about omp pragmas @@ -167,7 +211,29 @@ else status "OpenMP" "no" fi -echo +# Cocoa +if [[ "$OSTYPE" =~ "darwin" ]]; then + cflags "-mmacosx-version-min=10.7" + lflags "-mmacosx-version-min=10.7" +fi + +if [[ "$OSTYPE" =~ "darwin" ]]; then + SOLIBSUFFIX=dylib + + # Search Developer SDK paths, since Apple seems to have dropped the standard Unixy ones + XCODE_CMD="xcode-select" + XCODE_PATH=$($XCODE_CMD -p) + DIRS+=("$XCODE_PATH/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.10.sdk/usr/include $XCODE_PATH/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.10.sdk/usr/lib") + DIRS+=("$XCODE_PATH/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.8.sdk/usr/include $XCODE_PATH/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.8.sdk/usr/lib") +elif [[ "$OSTYPE" =~ "msys" ]]; then + SOLIBSUFFIX=dll +else + SOLIBSUFFIX=so +fi + +if [ "$QUIET" -ne 1 ]; then + echo +fi # As of GCC 4.5, 387 fp math is significantly slower in C99 mode without this. # Note: CPUs without SSE2 use 387 for doubles, even when SSE fp math is set. @@ -199,8 +265,12 @@ fi echo " # auto-generated by configure PREFIX = $PREFIX +LIBDIR = $LIBDIR +INCLUDEDIR = $INCLUDEDIR +PKGCONFIGDIR = $PKGCONFIGDIR VERSION = $VERSION CC = $CC CFLAGS = $CFLAGS LDFLAGS = $LDFLAGS -" > $CONFIG +SOLIBSUFFIX = $SOLIBSUFFIX +" > "$CONFIG" diff --git a/pngquant/imagequant.pc.in b/pngquant/imagequant.pc.in new file mode 100644 index 0000000..980da8c --- /dev/null +++ b/pngquant/imagequant.pc.in @@ -0,0 +1,10 @@ +prefix=PREFIX +includedir=${prefix}/include +libdir=${prefix}/lib + +Name: imagequant +Description: Small, portable C library for high-quality conversion of RGBA images to 8-bit indexed-color (palette) images. +URL: https://pngquant.org/lib/ +Version: VERSION +Libs: -L${libdir} -limagequant +Cflags: -I${includedir} diff --git a/pngquant/kmeans.c b/pngquant/kmeans.c new file mode 100644 index 0000000..c8630ae --- /dev/null +++ b/pngquant/kmeans.c @@ -0,0 +1,98 @@ +/* +** © 2011-2016 by Kornel Lesiński. +** See COPYRIGHT file for license. +*/ + +#include "libimagequant.h" +#include "pam.h" +#include "kmeans.h" +#include "nearest.h" +#include +#include + +#ifdef _OPENMP +#include +#else +#define omp_get_max_threads() 1 +#define omp_get_thread_num() 0 +#endif + +/* + * K-Means iteration: new palette color is computed from weighted average of colors that map to that palette entry. + */ +LIQ_PRIVATE void kmeans_init(const colormap *map, const unsigned int max_threads, kmeans_state average_color[]) +{ + memset(average_color, 0, sizeof(average_color[0])*(KMEANS_CACHE_LINE_GAP+map->colors)*max_threads); +} + +LIQ_PRIVATE void kmeans_update_color(const f_pixel acolor, const float value, const colormap *map, unsigned int match, const unsigned int thread, kmeans_state average_color[]) +{ + match += thread * (KMEANS_CACHE_LINE_GAP+map->colors); + average_color[match].a += acolor.a * value; + average_color[match].r += acolor.r * value; + average_color[match].g += acolor.g * value; + average_color[match].b += acolor.b * value; + average_color[match].total += value; +} + +LIQ_PRIVATE void kmeans_finalize(colormap *map, const unsigned int max_threads, const kmeans_state average_color[]) +{ + for (unsigned int i=0; i < map->colors; i++) { + double a=0, r=0, g=0, b=0, total=0; + + // Aggregate results from all threads + for(unsigned int t=0; t < max_threads; t++) { + const unsigned int offset = (KMEANS_CACHE_LINE_GAP+map->colors) * t + i; + + a += average_color[offset].a; + r += average_color[offset].r; + g += average_color[offset].g; + b += average_color[offset].b; + total += average_color[offset].total; + } + + if (total && !map->palette[i].fixed) { + map->palette[i].acolor = (f_pixel){ + .a = a / total, + .r = r / total, + .g = g / total, + .b = b / total, + }; + map->palette[i].popularity = total; + } + } +} + +LIQ_PRIVATE double kmeans_do_iteration(histogram *hist, colormap *const map, kmeans_callback callback) +{ + const unsigned int max_threads = omp_get_max_threads(); + LIQ_ARRAY(kmeans_state, average_color, (KMEANS_CACHE_LINE_GAP+map->colors) * max_threads); + kmeans_init(map, max_threads, average_color); + struct nearest_map *const n = nearest_init(map); + hist_item *const achv = hist->achv; + const int hist_size = hist->size; + + double total_diff=0; +#if __GNUC__ >= 9 + #pragma omp parallel for if (hist_size > 2000) \ + schedule(static) default(none) shared(achv,average_color,callback,hist_size,map,n) reduction(+:total_diff) +#else + #pragma omp parallel for if (hist_size > 2000) \ + schedule(static) default(none) shared(average_color,callback) reduction(+:total_diff) +#endif + for(int j=0; j < hist_size; j++) { + float diff; + unsigned int match = nearest_search(n, &achv[j].acolor, achv[j].tmp.likely_colormap_index, &diff); + achv[j].tmp.likely_colormap_index = match; + total_diff += diff * achv[j].perceptual_weight; + + kmeans_update_color(achv[j].acolor, achv[j].perceptual_weight, map, match, omp_get_thread_num(), average_color); + + if (callback) callback(&achv[j], diff); + } + + nearest_free(n); + kmeans_finalize(map, max_threads, average_color); + + return total_diff / hist->total_perceptual_weight; +} diff --git a/pngquant/kmeans.h b/pngquant/kmeans.h new file mode 100644 index 0000000..c51d7bb --- /dev/null +++ b/pngquant/kmeans.h @@ -0,0 +1,19 @@ + +#ifndef KMEANS_H +#define KMEANS_H + +// Spread memory touched by different threads at least 64B apart which I assume is the cache line size. This should avoid memory write contention. +#define KMEANS_CACHE_LINE_GAP ((64+sizeof(kmeans_state)-1)/sizeof(kmeans_state)) + +typedef struct { + double a, r, g, b, total; +} kmeans_state; + +typedef void (*kmeans_callback)(hist_item *item, float diff); + +LIQ_PRIVATE void kmeans_init(const colormap *map, const unsigned int max_threads, kmeans_state state[]); +LIQ_PRIVATE void kmeans_update_color(const f_pixel acolor, const float value, const colormap *map, unsigned int match, const unsigned int thread, kmeans_state average_color[]); +LIQ_PRIVATE void kmeans_finalize(colormap *map, const unsigned int max_threads, const kmeans_state state[]); +LIQ_PRIVATE double kmeans_do_iteration(histogram *hist, colormap *const map, kmeans_callback callback); + +#endif diff --git a/pngquant/libimagequant.c b/pngquant/libimagequant.c index 9b55a2f..fdefb7e 100644 --- a/pngquant/libimagequant.c +++ b/pngquant/libimagequant.c @@ -1,16 +1,9 @@ -/* pngquant.c - quantize the colors in an alphamap down to a specified number +/* +** © 2009-2018 by Kornel Lesiński. +** © 1989, 1991 by Jef Poskanzer. +** © 1997, 2000, 2002 by Greg Roelofs; based on an idea by Stefan Schneider. ** -** Copyright (C) 1989, 1991 by Jef Poskanzer. -** Copyright (C) 1997, 2000, 2002 by Greg Roelofs; based on an idea by -** Stefan Schneider. -** © 2009-2013 by Kornel Lesinski. -** -** Permission to use, copy, modify, and distribute this software and its -** documentation for any purpose and without fee is hereby granted, provided -** that the above copyright notice appear in all copies and that both that -** copyright notice and this permission notice appear in supporting -** documentation. This software is provided "as is" without express or -** implied warranty. +** See COPYRIGHT file for license. */ #include @@ -28,7 +21,9 @@ #ifdef _OPENMP #include +#define LIQ_TEMP_ROW_WIDTH(img_width) (((img_width) | 15) + 1) /* keep alignment & leave space between rows to avoid cache line contention */ #else +#define LIQ_TEMP_ROW_WIDTH(img_width) (img_width) #define omp_get_max_threads() 1 #define omp_get_thread_num() 0 #endif @@ -39,14 +34,17 @@ #include "mediancut.h" #include "nearest.h" #include "blur.h" -#include "viter.h" +#include "kmeans.h" #define LIQ_HIGH_MEMORY_LIMIT (1<<26) /* avoid allocating buffers larger than 64MB */ // each structure has a pointer as a unique identifier that allows type checking at run time -static const char *const liq_attr_magic = "liq_attr", *const liq_image_magic = "liq_image", - *const liq_result_magic = "liq_result", *const liq_remapping_result_magic = "liq_remapping_result", - *const liq_freed_magic = "free"; +static const char liq_attr_magic[] = "liq_attr"; +static const char liq_image_magic[] = "liq_image"; +static const char liq_result_magic[] = "liq_result"; +static const char liq_histogram_magic[] = "liq_histogram"; +static const char liq_remapping_result_magic[] = "liq_remapping_result"; +static const char liq_freed_magic[] = "free"; #define CHECK_STRUCT_TYPE(attr, kind) liq_crash_if_invalid_handle_pointer_given((const liq_attr*)attr, kind ## _magic) #define CHECK_USER_POINTER(ptr) liq_crash_if_invalid_pointer_given(ptr) @@ -55,13 +53,19 @@ struct liq_attr { void* (*malloc)(size_t); void (*free)(void*); - double target_mse, max_mse, voronoi_iteration_limit; + double target_mse, max_mse, kmeans_iteration_limit; float min_opaque_val; unsigned int max_colors, max_histogram_entries; unsigned int min_posterization_output /* user setting */, min_posterization_input /* speed setting */; - unsigned int voronoi_iterations, feedback_loop_trials; - bool last_index_transparent, use_contrast_maps, use_dither_map, fast_palette; - unsigned int speed; + unsigned int kmeans_iterations, feedback_loop_trials; + bool last_index_transparent, use_contrast_maps; + unsigned char use_dither_map; + unsigned char speed; + + unsigned char progress_stage1, progress_stage2, progress_stage3; + liq_progress_callback_function *progress_callback; + void *progress_callback_user_info; + liq_log_callback_function *log_callback; void *log_callback_user_info; liq_log_flush_callback_function *log_flush_callback; @@ -77,12 +81,15 @@ struct liq_image { rgba_pixel **rows; double gamma; unsigned int width, height; - unsigned char *noise, *edges, *dither_map; + unsigned char *importance_map, *edges, *dither_map; rgba_pixel *pixels, *temp_row; f_pixel *temp_f_row; liq_image_get_rgba_row_callback *row_callback; void *row_callback_user_info; + liq_image *background; float min_opaque_val; + f_pixel fixed_colors[256]; + unsigned short fixed_colors_count; bool free_pixels, free_rows, free_rows_internal; }; @@ -93,10 +100,14 @@ typedef struct liq_remapping_result { unsigned char *pixels; colormap *palette; + liq_progress_callback_function *progress_callback; + void *progress_callback_user_info; + liq_palette int_palette; double gamma, palette_error; float dither_level; - bool use_dither_map; + unsigned char use_dither_map; + unsigned char progress_stage1; } liq_remapping_result; struct liq_result { @@ -106,22 +117,40 @@ struct liq_result { liq_remapping_result *remapping; colormap *palette; + liq_progress_callback_function *progress_callback; + void *progress_callback_user_info; + liq_palette int_palette; float dither_level; double gamma, palette_error; int min_posterization_output; - bool use_dither_map, fast_palette; + unsigned char use_dither_map; }; -static liq_result *pngquant_quantize(histogram *hist, const liq_attr *options, double gamma); -static void modify_alpha(liq_image *input_image, rgba_pixel *const row_pixels); -static void contrast_maps(liq_image *image); -static histogram *get_histogram(liq_image *input_image, const liq_attr *options); -static const rgba_pixel *liq_image_get_row_rgba(liq_image *input_image, unsigned int row); -static const f_pixel *liq_image_get_row_f(liq_image *input_image, unsigned int row); -static void liq_remapping_result_destroy(liq_remapping_result *result); +struct liq_histogram { + const char *magic_header; + void* (*malloc)(size_t); + void (*free)(void*); -static void liq_verbose_printf(const liq_attr *context, const char *fmt, ...) + struct acolorhash_table *acht; + double gamma; + f_pixel fixed_colors[256]; + unsigned short fixed_colors_count; + unsigned short ignorebits; + bool had_image_added; +}; + +static void modify_alpha(liq_image *input_image, rgba_pixel *const row_pixels) LIQ_NONNULL; +static void contrast_maps(liq_image *image) LIQ_NONNULL; +static liq_error finalize_histogram(liq_histogram *input_hist, liq_attr *options, histogram **hist_output) LIQ_NONNULL; +static const rgba_pixel *liq_image_get_row_rgba(liq_image *input_image, unsigned int row) LIQ_NONNULL; +static bool liq_image_get_row_f_init(liq_image *img) LIQ_NONNULL; +static const f_pixel *liq_image_get_row_f(liq_image *input_image, unsigned int row) LIQ_NONNULL; +static void liq_remapping_result_destroy(liq_remapping_result *result) LIQ_NONNULL; +static liq_error pngquant_quantize(histogram *hist, const liq_attr *options, const int fixed_colors_count, const f_pixel fixed_colors[], const double gamma, bool fixed_result_colors, liq_result **) LIQ_NONNULL; +static liq_error liq_histogram_quantize_internal(liq_histogram *input_hist, liq_attr *attr, bool fixed_result_colors, liq_result **result_output) LIQ_NONNULL; + +LIQ_NONNULL static void liq_verbose_printf(const liq_attr *context, const char *fmt, ...) { if (context->log_callback) { va_list va; @@ -129,7 +158,7 @@ static void liq_verbose_printf(const liq_attr *context, const char *fmt, ...) int required_space = vsnprintf(NULL, 0, fmt, va)+1; // +\0 va_end(va); - char buf[required_space]; + LIQ_ARRAY(char, buf, required_space); va_start(va, fmt); vsnprintf(buf, required_space, fmt, va); va_end(va); @@ -138,25 +167,40 @@ static void liq_verbose_printf(const liq_attr *context, const char *fmt, ...) } } -inline static void verbose_print(const liq_attr *attr, const char *msg) +LIQ_NONNULL inline static void verbose_print(const liq_attr *attr, const char *msg) { if (attr->log_callback) { attr->log_callback(attr, msg, attr->log_callback_user_info); } } -static void liq_verbose_printf_flush(liq_attr *attr) +LIQ_NONNULL static void liq_verbose_printf_flush(liq_attr *attr) { if (attr->log_flush_callback) { attr->log_flush_callback(attr, attr->log_flush_callback_user_info); } } +LIQ_NONNULL static bool liq_progress(const liq_attr *attr, const float percent) +{ + return attr->progress_callback && !attr->progress_callback(percent, attr->progress_callback_user_info); +} + +LIQ_NONNULL static bool liq_remap_progress(const liq_remapping_result *quant, const float percent) +{ + return quant->progress_callback && !quant->progress_callback(percent, quant->progress_callback_user_info); +} + #if USE_SSE inline static bool is_sse_available() { -#if (defined(__x86_64__) || defined(__amd64)) +#if (defined(__x86_64__) || defined(__amd64) || defined(_WIN64)) return true; +#elif _MSC_VER + int info[4]; + __cpuid(info, 1); + /* bool is implemented as a built-in type of size 1 in MSVC */ + return info[3] & (1<<26) ? true : false; #else int a,b,c,d; cpuid(1, a, b, c, d); @@ -184,8 +228,8 @@ LIQ_EXPORT bool liq_crash_if_invalid_handle_pointer_given(const liq_attr *user_s return user_supplied_pointer->magic_header == expected_magic_header; } -NEVER_INLINE LIQ_EXPORT bool liq_crash_if_invalid_pointer_given(void *pointer); -LIQ_EXPORT bool liq_crash_if_invalid_pointer_given(void *pointer) +NEVER_INLINE LIQ_EXPORT bool liq_crash_if_invalid_pointer_given(const void *pointer); +LIQ_EXPORT bool liq_crash_if_invalid_pointer_given(const void *pointer) { if (!pointer) { return false; @@ -196,7 +240,8 @@ LIQ_EXPORT bool liq_crash_if_invalid_pointer_given(void *pointer) return test_access || true; } -static void liq_log_error(const liq_attr *attr, const char *msg) { +LIQ_NONNULL static void liq_log_error(const liq_attr *attr, const char *msg) +{ if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return; liq_verbose_printf(attr, " error: %s", msg); } @@ -226,7 +271,13 @@ static unsigned int mse_to_quality(double mse) return 0; } -LIQ_EXPORT liq_error liq_set_quality(liq_attr* attr, int minimum, int target) +/** internally MSE is a sum of all channels with pixels 0..1 range, + but other software gives per-RGB-channel MSE for 0..255 range */ +static double mse_to_standard_mse(double mse) { + return mse * 65536.0/6.0; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_quality(liq_attr* attr, int minimum, int target) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; if (target < 0 || target > 100 || target < minimum || minimum < 0) return LIQ_VALUE_OUT_OF_RANGE; @@ -236,20 +287,20 @@ LIQ_EXPORT liq_error liq_set_quality(liq_attr* attr, int minimum, int target) return LIQ_OK; } -LIQ_EXPORT int liq_get_min_quality(const liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL int liq_get_min_quality(const liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return -1; return mse_to_quality(attr->max_mse); } -LIQ_EXPORT int liq_get_max_quality(const liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL int liq_get_max_quality(const liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return -1; return mse_to_quality(attr->target_mse); } -LIQ_EXPORT liq_error liq_set_max_colors(liq_attr* attr, int colors) +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_max_colors(liq_attr* attr, int colors) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; if (colors < 2 || colors > 256) return LIQ_VALUE_OUT_OF_RANGE; @@ -258,14 +309,14 @@ LIQ_EXPORT liq_error liq_set_max_colors(liq_attr* attr, int colors) return LIQ_OK; } -LIQ_EXPORT int liq_get_max_colors(const liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL int liq_get_max_colors(const liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return -1; return attr->max_colors; } -LIQ_EXPORT liq_error liq_set_min_posterization(liq_attr *attr, int bits) +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_min_posterization(liq_attr *attr, int bits) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; if (bits < 0 || bits > 4) return LIQ_VALUE_OUT_OF_RANGE; @@ -274,40 +325,50 @@ LIQ_EXPORT liq_error liq_set_min_posterization(liq_attr *attr, int bits) return LIQ_OK; } -LIQ_EXPORT int liq_get_min_posterization(const liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL int liq_get_min_posterization(const liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return -1; return attr->min_posterization_output; } -LIQ_EXPORT liq_error liq_set_speed(liq_attr* attr, int speed) +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_speed(liq_attr* attr, int speed) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; if (speed < 1 || speed > 10) return LIQ_VALUE_OUT_OF_RANGE; - int iterations = MAX(8-speed,0); iterations += iterations * iterations/2; - attr->voronoi_iterations = iterations; - attr->voronoi_iteration_limit = 1.0/(double)(1<<(23-speed)); + unsigned int iterations = MAX(8-speed, 0); + iterations += iterations * iterations/2; + attr->kmeans_iterations = iterations; + attr->kmeans_iteration_limit = 1.0/(double)(1<<(23-speed)); attr->feedback_loop_trials = MAX(56-9*speed, 0); attr->max_histogram_entries = (1<<17) + (1<<18)*(10-speed); attr->min_posterization_input = (speed >= 8) ? 1 : 0; - attr->fast_palette = (speed >= 7); attr->use_dither_map = (speed <= (omp_get_max_threads() > 1 ? 7 : 5)); // parallelized dither map might speed up floyd remapping + if (attr->use_dither_map && speed < 3) { + attr->use_dither_map = 2; // always + } attr->use_contrast_maps = (speed <= 7) || attr->use_dither_map; attr->speed = speed; + + attr->progress_stage1 = attr->use_contrast_maps ? 20 : 8; + if (attr->feedback_loop_trials < 2) { + attr->progress_stage1 += 30; + } + attr->progress_stage3 = 50 / (1+speed); + attr->progress_stage2 = 100 - attr->progress_stage1 - attr->progress_stage3; return LIQ_OK; } -LIQ_EXPORT int liq_get_speed(const liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL int liq_get_speed(const liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return -1; return attr->speed; } -LIQ_EXPORT liq_error liq_set_output_gamma(liq_result* res, double gamma) +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_output_gamma(liq_result* res, double gamma) { if (!CHECK_STRUCT_TYPE(res, liq_result)) return LIQ_INVALID_POINTER; if (gamma <= 0 || gamma >= 1.0) return LIQ_VALUE_OUT_OF_RANGE; @@ -321,7 +382,7 @@ LIQ_EXPORT liq_error liq_set_output_gamma(liq_result* res, double gamma) return LIQ_OK; } -LIQ_EXPORT liq_error liq_set_min_opacity(liq_attr* attr, int min) +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_min_opacity(liq_attr* attr, int min) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; if (min < 0 || min > 255) return LIQ_VALUE_OUT_OF_RANGE; @@ -330,20 +391,36 @@ LIQ_EXPORT liq_error liq_set_min_opacity(liq_attr* attr, int min) return LIQ_OK; } -LIQ_EXPORT int liq_get_min_opacity(const liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL int liq_get_min_opacity(const liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return -1; - return MIN(255, 256.0 * attr->min_opaque_val); + return MIN(255.f, 256.f * attr->min_opaque_val); } -LIQ_EXPORT void liq_set_last_index_transparent(liq_attr* attr, int is_last) +LIQ_EXPORT LIQ_NONNULL void liq_set_last_index_transparent(liq_attr* attr, int is_last) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return; attr->last_index_transparent = !!is_last; } +LIQ_EXPORT void liq_attr_set_progress_callback(liq_attr *attr, liq_progress_callback_function *callback, void *user_info) +{ + if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return; + + attr->progress_callback = callback; + attr->progress_callback_user_info = user_info; +} + +LIQ_EXPORT void liq_result_set_progress_callback(liq_result *result, liq_progress_callback_function *callback, void *user_info) +{ + if (!CHECK_STRUCT_TYPE(result, liq_result)) return; + + result->progress_callback = callback; + result->progress_callback_user_info = user_info; +} + LIQ_EXPORT void liq_set_log_callback(liq_attr *attr, liq_log_callback_function *callback, void* user_info) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return; @@ -366,7 +443,7 @@ LIQ_EXPORT liq_attr* liq_attr_create() return liq_attr_create_with_allocator(NULL, NULL); } -LIQ_EXPORT void liq_attr_destroy(liq_attr *attr) +LIQ_EXPORT LIQ_NONNULL void liq_attr_destroy(liq_attr *attr) { if (!CHECK_STRUCT_TYPE(attr, liq_attr)) { return; @@ -378,7 +455,7 @@ LIQ_EXPORT void liq_attr_destroy(liq_attr *attr) attr->free(attr); } -LIQ_EXPORT liq_attr* liq_attr_copy(liq_attr *orig) +LIQ_EXPORT LIQ_NONNULL liq_attr* liq_attr_copy(const liq_attr *orig) { if (!CHECK_STRUCT_TYPE(orig, liq_attr)) { return NULL; @@ -404,7 +481,7 @@ static void *liq_aligned_malloc(size_t size) return ptr; } -static void liq_aligned_free(void *inptr) +LIQ_NONNULL static void liq_aligned_free(void *inptr) { unsigned char *ptr = inptr; size_t offset = ptr[-1] ^ 0x59; @@ -438,30 +515,62 @@ LIQ_EXPORT liq_attr* liq_attr_create_with_allocator(void* (*custom_malloc)(size_ .target_mse = 0, .max_mse = MAX_DIFF, }; - liq_set_speed(attr, 3); + liq_set_speed(attr, 4); return attr; } -static bool liq_image_use_low_memory(liq_image *img) +LIQ_EXPORT LIQ_NONNULL liq_error liq_image_add_fixed_color(liq_image *img, liq_color color) { - img->temp_f_row = img->malloc(sizeof(img->f_pixels[0]) * img->width * omp_get_max_threads()); + if (!CHECK_STRUCT_TYPE(img, liq_image)) return LIQ_INVALID_POINTER; + if (img->fixed_colors_count > 255) return LIQ_UNSUPPORTED; + + float gamma_lut[256]; + to_f_set_gamma(gamma_lut, img->gamma); + img->fixed_colors[img->fixed_colors_count++] = rgba_to_f(gamma_lut, (rgba_pixel){ + .r = color.r, + .g = color.g, + .b = color.b, + .a = color.a, + }); + return LIQ_OK; +} + +LIQ_NONNULL static liq_error liq_histogram_add_fixed_color_f(liq_histogram *hist, f_pixel color) +{ + if (hist->fixed_colors_count > 255) return LIQ_UNSUPPORTED; + + hist->fixed_colors[hist->fixed_colors_count++] = color; + return LIQ_OK; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_histogram_add_fixed_color(liq_histogram *hist, liq_color color, double gamma) +{ + if (!CHECK_STRUCT_TYPE(hist, liq_histogram)) return LIQ_INVALID_POINTER; + + float gamma_lut[256]; + to_f_set_gamma(gamma_lut, gamma ? gamma : 0.45455); + const f_pixel px = rgba_to_f(gamma_lut, (rgba_pixel){ + .r = color.r, + .g = color.g, + .b = color.b, + .a = color.a, + }); + return liq_histogram_add_fixed_color_f(hist, px); +} + +LIQ_NONNULL static bool liq_image_use_low_memory(liq_image *img) +{ + img->temp_f_row = img->malloc(sizeof(img->f_pixels[0]) * LIQ_TEMP_ROW_WIDTH(img->width) * omp_get_max_threads()); return img->temp_f_row != NULL; } -static bool liq_image_should_use_low_memory(liq_image *img, const bool low_memory_hint) +LIQ_NONNULL static bool liq_image_should_use_low_memory(liq_image *img, const bool low_memory_hint) { - return img->width * img->height * sizeof(f_pixel) > (low_memory_hint ? LIQ_HIGH_MEMORY_LIMIT/8 : LIQ_HIGH_MEMORY_LIMIT); + return img->width * img->height > (low_memory_hint ? LIQ_HIGH_MEMORY_LIMIT/8 : LIQ_HIGH_MEMORY_LIMIT) / sizeof(f_pixel); // Watch out for integer overflow } -static liq_image *liq_image_create_internal(liq_attr *attr, rgba_pixel* rows[], liq_image_get_rgba_row_callback *row_callback, void *row_callback_user_info, int width, int height, double gamma) +static liq_image *liq_image_create_internal(const liq_attr *attr, rgba_pixel* rows[], liq_image_get_rgba_row_callback *row_callback, void *row_callback_user_info, int width, int height, double gamma) { - if (!CHECK_STRUCT_TYPE(attr, liq_attr)) { - return NULL; - } - if (width <= 0 || height <= 0) { - liq_log_error(attr, "width and height must be > 0"); - return NULL; - } if (gamma < 0 || gamma > 1.0) { liq_log_error(attr, "gamma must be >= 0 and <= 1 (try 1/gamma instead)"); return NULL; @@ -487,7 +596,7 @@ static liq_image *liq_image_create_internal(liq_attr *attr, rgba_pixel* rows[], }; if (!rows || attr->min_opaque_val < 1.f) { - img->temp_row = attr->malloc(sizeof(img->temp_row[0]) * width * omp_get_max_threads()); + img->temp_row = attr->malloc(sizeof(img->temp_row[0]) * LIQ_TEMP_ROW_WIDTH(width) * omp_get_max_threads()); if (!img->temp_row) return NULL; } @@ -504,7 +613,7 @@ static liq_image *liq_image_create_internal(liq_attr *attr, rgba_pixel* rows[], return img; } -LIQ_EXPORT liq_error liq_image_set_memory_ownership(liq_image *img, int ownership_flags) +LIQ_EXPORT LIQ_NONNULL liq_error liq_image_set_memory_ownership(liq_image *img, int ownership_flags) { if (!CHECK_STRUCT_TYPE(img, liq_image)) return LIQ_INVALID_POINTER; if (!img->rows || !ownership_flags || (ownership_flags & ~(LIQ_OWN_ROWS|LIQ_OWN_PIXELS))) { @@ -531,19 +640,86 @@ LIQ_EXPORT liq_error liq_image_set_memory_ownership(liq_image *img, int ownershi return LIQ_OK; } -LIQ_EXPORT liq_image *liq_image_create_custom(liq_attr *attr, liq_image_get_rgba_row_callback *row_callback, void* user_info, int width, int height, double gamma) +LIQ_NONNULL static void liq_image_free_maps(liq_image *input_image); +LIQ_NONNULL static void liq_image_free_importance_map(liq_image *input_image); + +LIQ_EXPORT LIQ_NONNULL liq_error liq_image_set_importance_map(liq_image *img, unsigned char importance_map[], size_t buffer_size, enum liq_ownership ownership) { + if (!CHECK_STRUCT_TYPE(img, liq_image)) return LIQ_INVALID_POINTER; + if (!CHECK_USER_POINTER(importance_map)) return LIQ_INVALID_POINTER; + + const size_t required_size = img->width * img->height; + if (buffer_size < required_size) { + return LIQ_BUFFER_TOO_SMALL; + } + + if (ownership == LIQ_COPY_PIXELS) { + unsigned char *tmp = img->malloc(required_size); + if (!tmp) { + return LIQ_OUT_OF_MEMORY; + } + memcpy(tmp, importance_map, required_size); + importance_map = tmp; + } else if (ownership != LIQ_OWN_PIXELS) { + return LIQ_UNSUPPORTED; + } + + liq_image_free_importance_map(img); + img->importance_map = importance_map; + + return LIQ_OK; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_image_set_background(liq_image *img, liq_image *background) { + if (!CHECK_STRUCT_TYPE(img, liq_image)) return LIQ_INVALID_POINTER; + if (!CHECK_STRUCT_TYPE(background, liq_image)) return LIQ_INVALID_POINTER; + + if (background->background) { + return LIQ_UNSUPPORTED; + } + if (img->width != background->width || img->height != background->height) { + return LIQ_BUFFER_TOO_SMALL; + } + + if (img->background) { + liq_image_destroy(img->background); + } + + img->background = background; + liq_image_free_maps(img); // Force them to be re-analyzed with the background + + return LIQ_OK; +} + +LIQ_NONNULL static bool check_image_size(const liq_attr *attr, const int width, const int height) +{ + if (!CHECK_STRUCT_TYPE(attr, liq_attr)) { + return false; + } + + if (width <= 0 || height <= 0) { + liq_log_error(attr, "width and height must be > 0"); + return false; + } + + if (width > INT_MAX/sizeof(rgba_pixel)/height || width > INT_MAX/16/sizeof(f_pixel) || height > INT_MAX/sizeof(size_t)) { + liq_log_error(attr, "image too large"); + return false; + } + return true; +} + +LIQ_EXPORT liq_image *liq_image_create_custom(const liq_attr *attr, liq_image_get_rgba_row_callback *row_callback, void* user_info, int width, int height, double gamma) +{ + if (!check_image_size(attr, width, height)) { + return NULL; + } return liq_image_create_internal(attr, NULL, row_callback, user_info, width, height, gamma); } -LIQ_EXPORT liq_image *liq_image_create_rgba_rows(liq_attr *attr, void* rows[], int width, int height, double gamma) +LIQ_EXPORT liq_image *liq_image_create_rgba_rows(const liq_attr *attr, void *const rows[], int width, int height, double gamma) { - if (width <= 0 || height <= 0) { - liq_log_error(attr, "width and height must be > 0"); - return NULL; - } - if (width > INT_MAX/16/height || height > INT_MAX/16/width) { - liq_log_error(attr, "image too large"); + if (!check_image_size(attr, width, height)) { return NULL; } @@ -556,15 +732,9 @@ LIQ_EXPORT liq_image *liq_image_create_rgba_rows(liq_attr *attr, void* rows[], i return liq_image_create_internal(attr, (rgba_pixel**)rows, NULL, NULL, width, height, gamma); } -LIQ_EXPORT liq_image *liq_image_create_rgba(liq_attr *attr, void* bitmap, int width, int height, double gamma) +LIQ_EXPORT LIQ_NONNULL liq_image *liq_image_create_rgba(const liq_attr *attr, const void* bitmap, int width, int height, double gamma) { - if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return NULL; - if (width <= 0 || height <= 0) { - liq_log_error(attr, "width and height must be > 0"); - return NULL; - } - if (width > INT_MAX/16/height || height > INT_MAX/16/width) { - liq_log_error(attr, "image too large"); + if (!check_image_size(attr, width, height)) { return NULL; } if (!CHECK_USER_POINTER(bitmap)) { @@ -572,7 +742,7 @@ LIQ_EXPORT liq_image *liq_image_create_rgba(liq_attr *attr, void* bitmap, int wi return NULL; } - rgba_pixel *pixels = bitmap; + rgba_pixel *const pixels = (rgba_pixel *const)bitmap; rgba_pixel **rows = attr->malloc(sizeof(rows[0])*height); if (!rows) return NULL; @@ -581,6 +751,10 @@ LIQ_EXPORT liq_image *liq_image_create_rgba(liq_attr *attr, void* bitmap, int wi } liq_image *image = liq_image_create_internal(attr, rows, NULL, NULL, width, height, gamma); + if (!image) { + attr->free(rows); + return NULL; + } image->free_rows = true; image->free_rows_internal = true; return image; @@ -594,20 +768,30 @@ LIQ_EXPORT void liq_executing_user_callback(liq_image_get_rgba_row_callback *cal callback(temp_row, row, width, user_info); } -inline static bool liq_image_can_use_rows(liq_image *img) +LIQ_NONNULL inline static bool liq_image_has_rgba_pixels(const liq_image *img) { + if (!CHECK_STRUCT_TYPE(img, liq_image)) { + return false; + } + return img->rows || (img->temp_row && img->row_callback); +} + +LIQ_NONNULL inline static bool liq_image_can_use_rgba_rows(const liq_image *img) +{ + assert(liq_image_has_rgba_pixels(img)); + const bool iebug = img->min_opaque_val < 1.f; return (img->rows && !iebug); } -static const rgba_pixel *liq_image_get_row_rgba(liq_image *img, unsigned int row) +LIQ_NONNULL static const rgba_pixel *liq_image_get_row_rgba(liq_image *img, unsigned int row) { - if (liq_image_can_use_rows(img)) { + if (liq_image_can_use_rgba_rows(img)) { return img->rows[row]; } assert(img->temp_row); - rgba_pixel *temp_row = img->temp_row + img->width * omp_get_thread_num(); + rgba_pixel *temp_row = img->temp_row + LIQ_TEMP_ROW_WIDTH(img->width) * omp_get_thread_num(); if (img->rows) { memcpy(temp_row, img->rows[row], img->width * sizeof(temp_row[0])); } else { @@ -618,7 +802,7 @@ static const rgba_pixel *liq_image_get_row_rgba(liq_image *img, unsigned int row return temp_row; } -static void convert_row_to_f(liq_image *img, f_pixel *row_f_pixels, const unsigned int row, const float gamma_lut[]) +LIQ_NONNULL static void convert_row_to_f(liq_image *img, f_pixel *row_f_pixels, const unsigned int row, const float gamma_lut[]) { assert(row_f_pixels); assert(!USE_SSE || 0 == ((uintptr_t)row_f_pixels & 15)); @@ -626,46 +810,55 @@ static void convert_row_to_f(liq_image *img, f_pixel *row_f_pixels, const unsign const rgba_pixel *const row_pixels = liq_image_get_row_rgba(img, row); for(unsigned int col=0; col < img->width; col++) { - row_f_pixels[col] = to_f(gamma_lut, row_pixels[col]); + row_f_pixels[col] = rgba_to_f(gamma_lut, row_pixels[col]); } } -static const f_pixel *liq_image_get_row_f(liq_image *img, unsigned int row) +LIQ_NONNULL static bool liq_image_get_row_f_init(liq_image *img) +{ + assert(omp_get_thread_num() == 0); + if (img->f_pixels) { + return true; + } + if (!liq_image_should_use_low_memory(img, false)) { + img->f_pixels = img->malloc(sizeof(img->f_pixels[0]) * img->width * img->height); + } + if (!img->f_pixels) { + return liq_image_use_low_memory(img); + } + + if (!liq_image_has_rgba_pixels(img)) { + return false; + } + + float gamma_lut[256]; + to_f_set_gamma(gamma_lut, img->gamma); + for(unsigned int i=0; i < img->height; i++) { + convert_row_to_f(img, &img->f_pixels[i*img->width], i, gamma_lut); + } + return true; +} + +LIQ_NONNULL static const f_pixel *liq_image_get_row_f(liq_image *img, unsigned int row) { if (!img->f_pixels) { - if (img->temp_f_row) { - float gamma_lut[256]; - to_f_set_gamma(gamma_lut, img->gamma); - f_pixel *row_for_thread = img->temp_f_row + img->width * omp_get_thread_num(); - convert_row_to_f(img, row_for_thread, row, gamma_lut); - return row_for_thread; - } - - assert(omp_get_thread_num() == 0); - if (!liq_image_should_use_low_memory(img, false)) { - img->f_pixels = img->malloc(sizeof(img->f_pixels[0]) * img->width * img->height); - } - if (!img->f_pixels) { - if (!liq_image_use_low_memory(img)) return NULL; - return liq_image_get_row_f(img, row); - } - + assert(img->temp_f_row); // init should have done that float gamma_lut[256]; to_f_set_gamma(gamma_lut, img->gamma); - for(unsigned int i=0; i < img->height; i++) { - convert_row_to_f(img, &img->f_pixels[i*img->width], i, gamma_lut); - } + f_pixel *row_for_thread = img->temp_f_row + LIQ_TEMP_ROW_WIDTH(img->width) * omp_get_thread_num(); + convert_row_to_f(img, row_for_thread, row, gamma_lut); + return row_for_thread; } return img->f_pixels + img->width * row; } -LIQ_EXPORT int liq_image_get_width(const liq_image *input_image) +LIQ_EXPORT LIQ_NONNULL int liq_image_get_width(const liq_image *input_image) { if (!CHECK_STRUCT_TYPE(input_image, liq_image)) return -1; return input_image->width; } -LIQ_EXPORT int liq_image_get_height(const liq_image *input_image) +LIQ_EXPORT LIQ_NONNULL int liq_image_get_height(const liq_image *input_image) { if (!CHECK_STRUCT_TYPE(input_image, liq_image)) return -1; return input_image->height; @@ -673,7 +866,7 @@ LIQ_EXPORT int liq_image_get_height(const liq_image *input_image) typedef void free_func(void*); -free_func *get_default_free_func(liq_image *img) +LIQ_NONNULL static free_func *get_default_free_func(liq_image *img) { // When default allocator is used then user-supplied pointers must be freed with free() if (img->free_rows_internal || img->free != liq_aligned_free) { @@ -682,7 +875,7 @@ free_func *get_default_free_func(liq_image *img) return free; } -static void liq_image_free_rgba_source(liq_image *input_image) +LIQ_NONNULL static void liq_image_free_rgba_source(liq_image *input_image) { if (input_image->free_pixels && input_image->pixels) { get_default_free_func(input_image)(input_image->pixels); @@ -695,23 +888,34 @@ static void liq_image_free_rgba_source(liq_image *input_image) } } -LIQ_EXPORT void liq_image_destroy(liq_image *input_image) +LIQ_NONNULL static void liq_image_free_importance_map(liq_image *input_image) { + if (input_image->importance_map) { + input_image->free(input_image->importance_map); + input_image->importance_map = NULL; + } +} + +LIQ_NONNULL static void liq_image_free_maps(liq_image *input_image) { + liq_image_free_importance_map(input_image); + + if (input_image->edges) { + input_image->free(input_image->edges); + input_image->edges = NULL; + } + + if (input_image->dither_map) { + input_image->free(input_image->dither_map); + input_image->dither_map = NULL; + } +} + +LIQ_EXPORT LIQ_NONNULL void liq_image_destroy(liq_image *input_image) { if (!CHECK_STRUCT_TYPE(input_image, liq_image)) return; liq_image_free_rgba_source(input_image); - if (input_image->noise) { - input_image->free(input_image->noise); - } - - if (input_image->edges) { - input_image->free(input_image->edges); - } - - if (input_image->dither_map) { - input_image->free(input_image->dither_map); - } + liq_image_free_maps(input_image); if (input_image->f_pixels) { input_image->free(input_image->f_pixels); @@ -721,30 +925,103 @@ LIQ_EXPORT void liq_image_destroy(liq_image *input_image) input_image->free(input_image->temp_row); } + if (input_image->temp_f_row) { + input_image->free(input_image->temp_f_row); + } + + if (input_image->background) { + liq_image_destroy(input_image->background); + } + input_image->magic_header = liq_freed_magic; input_image->free(input_image); } -LIQ_EXPORT liq_result *liq_quantize_image(liq_attr *attr, liq_image *img) +LIQ_EXPORT liq_histogram* liq_histogram_create(const liq_attr* attr) { - if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return NULL; - if (!CHECK_STRUCT_TYPE(img, liq_image)) { - liq_log_error(attr, "invalid image pointer"); + if (!CHECK_STRUCT_TYPE(attr, liq_attr)) { return NULL; } - histogram *hist = get_histogram(img, attr); - if (!hist) { - return NULL; - } + liq_histogram *hist = attr->malloc(sizeof(liq_histogram)); + if (!hist) return NULL; + *hist = (liq_histogram) { + .magic_header = liq_histogram_magic, + .malloc = attr->malloc, + .free = attr->free, - liq_result *result = pngquant_quantize(hist, attr, img->gamma); - - pam_freeacolorhist(hist); - return result; + .ignorebits = MAX(attr->min_posterization_output, attr->min_posterization_input), + }; + return hist; } -LIQ_EXPORT liq_error liq_set_dithering_level(liq_result *res, float dither_level) +LIQ_EXPORT LIQ_NONNULL void liq_histogram_destroy(liq_histogram *hist) +{ + if (!CHECK_STRUCT_TYPE(hist, liq_histogram)) return; + hist->magic_header = liq_freed_magic; + + pam_freeacolorhash(hist->acht); + hist->free(hist); +} + +LIQ_EXPORT LIQ_NONNULL liq_result *liq_quantize_image(liq_attr *attr, liq_image *img) +{ + liq_result *res; + if (LIQ_OK != liq_image_quantize(img, attr, &res)) { + return NULL; + } + return res; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_image_quantize(liq_image *const img, liq_attr *const attr, liq_result **result_output) +{ + if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; + if (!liq_image_has_rgba_pixels(img)) { + return LIQ_UNSUPPORTED; + } + + liq_histogram *hist = liq_histogram_create(attr); + if (!hist) { + return LIQ_OUT_OF_MEMORY; + } + liq_error err = liq_histogram_add_image(hist, attr, img); + if (LIQ_OK != err) { + return err; + } + + err = liq_histogram_quantize_internal(hist, attr, false, result_output); + liq_histogram_destroy(hist); + + return err; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_histogram_quantize(liq_histogram *input_hist, liq_attr *attr, liq_result **result_output) { + return liq_histogram_quantize_internal(input_hist, attr, true, result_output); +} + +LIQ_NONNULL static liq_error liq_histogram_quantize_internal(liq_histogram *input_hist, liq_attr *attr, bool fixed_result_colors, liq_result **result_output) +{ + if (!CHECK_USER_POINTER(result_output)) return LIQ_INVALID_POINTER; + *result_output = NULL; + + if (!CHECK_STRUCT_TYPE(attr, liq_attr)) return LIQ_INVALID_POINTER; + if (!CHECK_STRUCT_TYPE(input_hist, liq_histogram)) return LIQ_INVALID_POINTER; + + if (liq_progress(attr, 0)) return LIQ_ABORTED; + + histogram *hist; + liq_error err = finalize_histogram(input_hist, attr, &hist); + if (err != LIQ_OK) { + return err; + } + + err = pngquant_quantize(hist, attr, input_hist->fixed_colors_count, input_hist->fixed_colors, input_hist->gamma, fixed_result_colors, result_output); + pam_freeacolorhist(hist); + + return err; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_set_dithering_level(liq_result *res, float dither_level) { if (!CHECK_STRUCT_TYPE(res, liq_result)) return LIQ_INVALID_POINTER; @@ -753,12 +1030,12 @@ LIQ_EXPORT liq_error liq_set_dithering_level(liq_result *res, float dither_level res->remapping = NULL; } - if (res->dither_level < 0 || res->dither_level > 1.0f) return LIQ_VALUE_OUT_OF_RANGE; + if (dither_level < 0 || dither_level > 1.0f) return LIQ_VALUE_OUT_OF_RANGE; res->dither_level = dither_level; return LIQ_OK; } -static liq_remapping_result *liq_remapping_result_create(liq_result *result) +LIQ_NONNULL static liq_remapping_result *liq_remapping_result_create(liq_result *result) { if (!CHECK_STRUCT_TYPE(result, liq_result)) { return NULL; @@ -775,18 +1052,21 @@ static liq_remapping_result *liq_remapping_result_create(liq_result *result) .palette_error = result->palette_error, .gamma = result->gamma, .palette = pam_duplicate_colormap(result->palette), + .progress_callback = result->progress_callback, + .progress_callback_user_info = result->progress_callback_user_info, + .progress_stage1 = result->use_dither_map ? 20 : 0, }; return res; } -LIQ_EXPORT double liq_get_output_gamma(const liq_result *result) +LIQ_EXPORT LIQ_NONNULL double liq_get_output_gamma(const liq_result *result) { if (!CHECK_STRUCT_TYPE(result, liq_result)) return -1; return result->gamma; } -static void liq_remapping_result_destroy(liq_remapping_result *result) +LIQ_NONNULL static void liq_remapping_result_destroy(liq_remapping_result *result) { if (!CHECK_STRUCT_TYPE(result, liq_remapping_result)) return; @@ -797,7 +1077,7 @@ static void liq_remapping_result_destroy(liq_remapping_result *result) result->free(result); } -LIQ_EXPORT void liq_result_destroy(liq_result *res) +LIQ_EXPORT LIQ_NONNULL void liq_result_destroy(liq_result *res) { if (!CHECK_STRUCT_TYPE(res, liq_result)) return; @@ -814,45 +1094,57 @@ LIQ_EXPORT void liq_result_destroy(liq_result *res) res->free(res); } -LIQ_EXPORT double liq_get_quantization_error(liq_result *result) -{ + +LIQ_EXPORT LIQ_NONNULL double liq_get_quantization_error(const liq_result *result) { if (!CHECK_STRUCT_TYPE(result, liq_result)) return -1; if (result->palette_error >= 0) { - return result->palette_error*65536.0/6.0; + return mse_to_standard_mse(result->palette_error); } - if (result->remapping && result->remapping->palette_error >= 0) { - return result->remapping->palette_error*65536.0/6.0; - } - - return result->palette_error; + return -1; } -LIQ_EXPORT int liq_get_quantization_quality(liq_result *result) -{ +LIQ_EXPORT LIQ_NONNULL double liq_get_remapping_error(const liq_result *result) { + if (!CHECK_STRUCT_TYPE(result, liq_result)) return -1; + + if (result->remapping && result->remapping->palette_error >= 0) { + return mse_to_standard_mse(result->remapping->palette_error); + } + + return -1; +} + +LIQ_EXPORT LIQ_NONNULL int liq_get_quantization_quality(const liq_result *result) { if (!CHECK_STRUCT_TYPE(result, liq_result)) return -1; if (result->palette_error >= 0) { return mse_to_quality(result->palette_error); } + return -1; +} + +LIQ_EXPORT LIQ_NONNULL int liq_get_remapping_quality(const liq_result *result) { + if (!CHECK_STRUCT_TYPE(result, liq_result)) return -1; + if (result->remapping && result->remapping->palette_error >= 0) { return mse_to_quality(result->remapping->palette_error); } - return result->palette_error; + return -1; } -static int compare_popularity(const void *ch1, const void *ch2) +LIQ_NONNULL static int compare_popularity(const void *ch1, const void *ch2) { const float v1 = ((const colormap_item*)ch1)->popularity; const float v2 = ((const colormap_item*)ch2)->popularity; return v1 > v2 ? -1 : 1; } -static void sort_palette_qsort(colormap *map, int start, int nelem) +LIQ_NONNULL static void sort_palette_qsort(colormap *map, int start, int nelem) { + if (!nelem) return; qsort(map->palette + start, nelem, sizeof(map->palette[0]), compare_popularity); } @@ -861,7 +1153,7 @@ static void sort_palette_qsort(colormap *map, int start, int nelem) (map)->palette[(a)] = (map)->palette[(b)]; \ (map)->palette[(b)] = tmp; } -static void sort_palette(colormap *map, const liq_attr *options) +LIQ_NONNULL static void sort_palette(colormap *map, const liq_attr *options) { /* ** Step 3.5 [GRR]: remap the palette colors so that all entries with @@ -869,22 +1161,31 @@ static void sort_palette(colormap *map, const liq_attr *options) ** therefore be omitted from the tRNS chunk. */ if (options->last_index_transparent) { - for(unsigned int i=0; i < map->colors; i++) { - if (map->palette[i].acolor.a < 1.0/256.0) { - const unsigned int old = i, transparent_dest = map->colors-1; + for(unsigned int i=0; i < map->colors; i++) { + if (map->palette[i].acolor.a < 1.f/256.f) { + const unsigned int old = i, transparent_dest = map->colors-1; - SWAP_PALETTE(map, transparent_dest, old); + SWAP_PALETTE(map, transparent_dest, old); - /* colors sorted by popularity make pngs slightly more compressible */ - sort_palette_qsort(map, 0, map->colors-1); - return; + /* colors sorted by popularity make pngs slightly more compressible */ + sort_palette_qsort(map, 0, map->colors-1); + return; } } } + + unsigned int non_fixed_colors = 0; + for(unsigned int i = 0; i < map->colors; i++) { + if (map->palette[i].fixed) { + break; + } + non_fixed_colors++; + } + /* move transparent colors to the beginning to shrink trns chunk */ - unsigned int num_transparent=0; - for(unsigned int i=0; i < map->colors; i++) { - if (map->palette[i].acolor.a < 255.0/256.0) { + unsigned int num_transparent = 0; + for(unsigned int i = 0; i < non_fixed_colors; i++) { + if (map->palette[i].acolor.a < 255.f/256.f) { // current transparent color is swapped with earlier opaque one if (i != num_transparent) { SWAP_PALETTE(map, num_transparent, i); @@ -900,9 +1201,9 @@ static void sort_palette(colormap *map, const liq_attr *options) * opaque and transparent are sorted separately */ sort_palette_qsort(map, 0, num_transparent); - sort_palette_qsort(map, num_transparent, map->colors-num_transparent); + sort_palette_qsort(map, num_transparent, non_fixed_colors - num_transparent); - if (map->colors > 16) { + if (non_fixed_colors > 9 && map->colors > 16) { SWAP_PALETTE(map, 7, 1); // slightly improves compression SWAP_PALETTE(map, 8, 2); SWAP_PALETTE(map, 9, 3); @@ -914,31 +1215,31 @@ inline static unsigned int posterize_channel(unsigned int color, unsigned int bi return (color & ~((1<> (8-bits)); } -static void set_rounded_palette(liq_palette *const dest, colormap *const map, const double gamma, unsigned int posterize) +LIQ_NONNULL static void set_rounded_palette(liq_palette *const dest, colormap *const map, const double gamma, unsigned int posterize) { float gamma_lut[256]; to_f_set_gamma(gamma_lut, gamma); dest->count = map->colors; for(unsigned int x = 0; x < map->colors; ++x) { - rgba_pixel px = to_rgb(gamma, map->palette[x].acolor); + rgba_pixel px = f_to_rgb(gamma, map->palette[x].acolor); px.r = posterize_channel(px.r, posterize); px.g = posterize_channel(px.g, posterize); px.b = posterize_channel(px.b, posterize); px.a = posterize_channel(px.a, posterize); - map->palette[x].acolor = to_f(gamma_lut, px); /* saves rounding error introduced by to_rgb, which makes remapping & dithering more accurate */ + map->palette[x].acolor = rgba_to_f(gamma_lut, px); /* saves rounding error introduced by to_rgb, which makes remapping & dithering more accurate */ - if (!px.a) { - px.r = 'L'; px.g = 'i'; px.b = 'q'; + if (!px.a && !map->palette[x].fixed) { + px.r = 71; px.g = 112; px.b = 76; } dest->entries[x] = (liq_color){.r=px.r,.g=px.g,.b=px.b,.a=px.a}; } } -LIQ_EXPORT const liq_palette *liq_get_palette(liq_result *result) +LIQ_EXPORT LIQ_NONNULL const liq_palette *liq_get_palette(liq_result *result) { if (!CHECK_STRUCT_TYPE(result, liq_result)) return NULL; @@ -952,40 +1253,55 @@ LIQ_EXPORT const liq_palette *liq_get_palette(liq_result *result) return &result->int_palette; } -static float remap_to_palette(liq_image *const input_image, unsigned char *const *const output_pixels, colormap *const map, const bool fast) +LIQ_NONNULL static float remap_to_palette(liq_image *const input_image, unsigned char *const *const output_pixels, colormap *const map) { const int rows = input_image->height; const unsigned int cols = input_image->width; - const float min_opaque_val = input_image->min_opaque_val; double remapping_error=0; - if (!liq_image_get_row_f(input_image, 0)) { // trigger lazy conversion + if (!liq_image_get_row_f_init(input_image)) { + return -1; + } + if (input_image->background && !liq_image_get_row_f_init(input_image->background)) { return -1; } - struct nearest_map *const n = nearest_init(map, fast); + const colormap_item *acolormap = map->palette; + + struct nearest_map *const n = nearest_init(map); + const int transparent_index = input_image->background ? nearest_search(n, &(f_pixel){0,0,0,0}, 0, NULL) : 0; + const unsigned int max_threads = omp_get_max_threads(); - viter_state average_color[(VITER_CACHE_LINE_GAP+map->colors) * max_threads]; - viter_init(map, max_threads, average_color); + LIQ_ARRAY(kmeans_state, average_color, (KMEANS_CACHE_LINE_GAP+map->colors) * max_threads); + kmeans_init(map, max_threads, average_color); +#if __GNUC__ >= 9 #pragma omp parallel for if (rows*cols > 3000) \ - schedule(static) default(none) shared(average_color) reduction(+:remapping_error) + schedule(static) default(none) shared(acolormap,average_color,cols,input_image,map,n,output_pixels,rows,transparent_index) reduction(+:remapping_error) +#else + #pragma omp parallel for if (rows*cols > 3000) \ + schedule(static) default(none) shared(acolormap) shared(average_color) reduction(+:remapping_error) +#endif for(int row = 0; row < rows; ++row) { const f_pixel *const row_pixels = liq_image_get_row_f(input_image, row); + const f_pixel *const bg_pixels = input_image->background && acolormap[transparent_index].acolor.a < 1.f/256.f ? liq_image_get_row_f(input_image->background, row) : NULL; + unsigned int last_match=0; for(unsigned int col = 0; col < cols; ++col) { - f_pixel px = row_pixels[col]; float diff; - - output_pixels[row][col] = last_match = nearest_search(n, px, last_match, min_opaque_val, &diff); + last_match = nearest_search(n, &row_pixels[col], last_match, &diff); + if (bg_pixels && colordifference(bg_pixels[col], acolormap[last_match].acolor) <= diff) { + last_match = transparent_index; + } + output_pixels[row][col] = last_match; remapping_error += diff; - viter_update_color(px, 1.0, map, last_match, omp_get_thread_num(), average_color); + kmeans_update_color(row_pixels[col], 1.0, map, last_match, omp_get_thread_num(), average_color); } } - viter_finalize(map, max_threads, average_color); + kmeans_finalize(map, max_threads, average_color); nearest_free(n); @@ -1001,35 +1317,37 @@ inline static f_pixel get_dithered_pixel(const float dither_level, const float m sa = thiserr.a * dither_level; float ratio = 1.0; + const float max_overflow = 1.1f; + const float max_underflow = -0.1f; // allowing some overflow prevents undithered bands caused by clamping of all channels - if (px.r + sr > 1.03) ratio = MIN(ratio, (1.03-px.r)/sr); - else if (px.r + sr < 0) ratio = MIN(ratio, px.r/-sr); - if (px.g + sg > 1.03) ratio = MIN(ratio, (1.03-px.g)/sg); - else if (px.g + sg < 0) ratio = MIN(ratio, px.g/-sg); - if (px.b + sb > 1.03) ratio = MIN(ratio, (1.03-px.b)/sb); - else if (px.b + sb < 0) ratio = MIN(ratio, px.b/-sb); + if (px.r + sr > max_overflow) ratio = MIN(ratio, (max_overflow -px.r)/sr); + else { if (px.r + sr < max_underflow) ratio = MIN(ratio, (max_underflow-px.r)/sr); } + if (px.g + sg > max_overflow) ratio = MIN(ratio, (max_overflow -px.g)/sg); + else { if (px.g + sg < max_underflow) ratio = MIN(ratio, (max_underflow-px.g)/sg); } + if (px.b + sb > max_overflow) ratio = MIN(ratio, (max_overflow -px.b)/sb); + else { if (px.b + sb < max_underflow) ratio = MIN(ratio, (max_underflow-px.b)/sb); } float a = px.a + sa; - if (a > 1.0) { a = 1.0; } + if (a > 1.f) { a = 1.f; } else if (a < 0) { a = 0; } - // If dithering error is crazy high, don't propagate it that much - // This prevents crazy geen pixels popping out of the blue (or red or black! ;) - const float dither_error = sr*sr + sg*sg + sb*sb + sa*sa; - if (dither_error > max_dither_error) { - ratio *= 0.8; - } else if (dither_error < 2.f/256.f/256.f) { + // If dithering error is crazy high, don't propagate it that much + // This prevents crazy geen pixels popping out of the blue (or red or black! ;) + const float dither_error = sr*sr + sg*sg + sb*sb + sa*sa; + if (dither_error > max_dither_error) { + ratio *= 0.8f; + } else if (dither_error < 2.f/256.f/256.f) { // don't dither areas that don't have noticeable error — makes file smaller return px; } - return (f_pixel){ - .r=px.r + sr * ratio, - .g=px.g + sg * ratio, - .b=px.b + sb * ratio, - .a=a, - }; + return (f_pixel) { + .r=px.r + sr * ratio, + .g=px.g + sg * ratio, + .b=px.b + sb * ratio, + .a=a, + }; } /** @@ -1037,46 +1355,54 @@ inline static f_pixel get_dithered_pixel(const float dither_level, const float m If output_image_is_remapped is true, only pixels noticeably changed by error diffusion will be written to output image. */ -static void remap_to_palette_floyd(liq_image *input_image, unsigned char *const output_pixels[], const colormap *map, const float max_dither_error, const bool use_dither_map, const bool output_image_is_remapped, float base_dithering_level) +LIQ_NONNULL static bool remap_to_palette_floyd(liq_image *input_image, unsigned char *const output_pixels[], liq_remapping_result *quant, const float max_dither_error, const bool output_image_is_remapped) { - const unsigned int rows = input_image->height, cols = input_image->width; - const unsigned char *dither_map = use_dither_map ? (input_image->dither_map ? input_image->dither_map : input_image->edges) : NULL; - const float min_opaque_val = input_image->min_opaque_val; + const int rows = input_image->height, cols = input_image->width; + const unsigned char *dither_map = quant->use_dither_map ? (input_image->dither_map ? input_image->dither_map : input_image->edges) : NULL; + const colormap *map = quant->palette; const colormap_item *acolormap = map->palette; - struct nearest_map *const n = nearest_init(map, false); + if (!liq_image_get_row_f_init(input_image)) { + return false; + } + if (input_image->background && !liq_image_get_row_f_init(input_image->background)) { + return false; + } /* Initialize Floyd-Steinberg error vectors. */ - f_pixel *restrict thiserr, *restrict nexterr; - thiserr = input_image->malloc((cols + 2) * sizeof(*thiserr) * 2); // +2 saves from checking out of bounds access - nexterr = thiserr + (cols + 2); - srand(12345); /* deterministic dithering is better for comparing results */ - if (!thiserr) return; + const size_t errwidth = cols+2; + f_pixel *restrict thiserr = input_image->malloc(errwidth * sizeof(thiserr[0]) * 2); // +2 saves from checking out of bounds access + if (!thiserr) return false; + f_pixel *restrict nexterr = thiserr + errwidth; + memset(thiserr, 0, errwidth * sizeof(thiserr[0])); - for (unsigned int col = 0; col < cols + 2; ++col) { - const double rand_max = RAND_MAX; - thiserr[col].r = ((double)rand() - rand_max/2.0)/rand_max/255.0; - thiserr[col].g = ((double)rand() - rand_max/2.0)/rand_max/255.0; - thiserr[col].b = ((double)rand() - rand_max/2.0)/rand_max/255.0; - thiserr[col].a = ((double)rand() - rand_max/2.0)/rand_max/255.0; - } + bool ok = true; + struct nearest_map *const n = nearest_init(map); + const int transparent_index = input_image->background ? nearest_search(n, &(f_pixel){0,0,0,0}, 0, NULL) : 0; // response to this value is non-linear and without it any value < 0.8 would give almost no dithering - base_dithering_level = 1.0 - (1.0-base_dithering_level)*(1.0-base_dithering_level)*(1.0-base_dithering_level); + float base_dithering_level = quant->dither_level; + base_dithering_level = 1.f - (1.f-base_dithering_level)*(1.f-base_dithering_level); if (dither_map) { - base_dithering_level *= 1.0/255.0; // convert byte to float + base_dithering_level *= 1.f/255.f; // convert byte to float } - base_dithering_level *= 15.0/16.0; // prevent small errors from accumulating + base_dithering_level *= 15.f/16.f; // prevent small errors from accumulating - bool fs_direction = true; + int fs_direction = 1; unsigned int last_match=0; - for (unsigned int row = 0; row < rows; ++row) { - memset(nexterr, 0, (cols + 2) * sizeof(*nexterr)); + for (int row = 0; row < rows; ++row) { + if (liq_remap_progress(quant, quant->progress_stage1 + row * (100.f - quant->progress_stage1) / rows)) { + ok = false; + break; + } - unsigned int col = (fs_direction) ? 0 : (cols - 1); + memset(nexterr, 0, errwidth * sizeof(nexterr[0])); + + int col = (fs_direction > 0) ? 0 : (cols - 1); const f_pixel *const row_pixels = liq_image_get_row_f(input_image, row); + const f_pixel *const bg_pixels = input_image->background && acolormap[transparent_index].acolor.a < 1.f/256.f ? liq_image_get_row_f(input_image->background, row) : NULL; do { float dither_level = base_dithering_level; @@ -1087,30 +1413,34 @@ static void remap_to_palette_floyd(liq_image *input_image, unsigned char *const const f_pixel spx = get_dithered_pixel(dither_level, max_dither_error, thiserr[col + 1], row_pixels[col]); const unsigned int guessed_match = output_image_is_remapped ? output_pixels[row][col] : last_match; - output_pixels[row][col] = last_match = nearest_search(n, spx, guessed_match, min_opaque_val, NULL); + float diff; + last_match = nearest_search(n, &spx, guessed_match, &diff); + f_pixel output_px = acolormap[last_match].acolor; + if (bg_pixels && colordifference(bg_pixels[col], output_px) <= diff) { + output_px = bg_pixels[col]; + output_pixels[row][col] = transparent_index; + } else { + output_pixels[row][col] = last_match; + } - const f_pixel xp = acolormap[last_match].acolor; f_pixel err = { - .r = (spx.r - xp.r), - .g = (spx.g - xp.g), - .b = (spx.b - xp.b), - .a = (spx.a - xp.a), + .r = (spx.r - output_px.r), + .g = (spx.g - output_px.g), + .b = (spx.b - output_px.b), + .a = (spx.a - output_px.a), }; // If dithering error is crazy high, don't propagate it that much // This prevents crazy geen pixels popping out of the blue (or red or black! ;) if (err.r*err.r + err.g*err.g + err.b*err.b + err.a*err.a > max_dither_error) { - dither_level *= 0.75; + err.r *= 0.75f; + err.g *= 0.75f; + err.b *= 0.75f; + err.a *= 0.75f; } - const float colorimp = (3.0f + acolormap[last_match].acolor.a)/4.0f * dither_level; - err.r *= colorimp; - err.g *= colorimp; - err.b *= colorimp; - err.a *= dither_level; - /* Propagate Floyd-Steinberg error terms. */ - if (fs_direction) { + if (fs_direction > 0) { thiserr[col + 2].a += err.a * (7.f/16.f); thiserr[col + 2].r += err.r * (7.f/16.f); thiserr[col + 2].g += err.g * (7.f/16.f); @@ -1154,90 +1484,193 @@ static void remap_to_palette_floyd(liq_image *input_image, unsigned char *const } // remapping is done in zig-zag - if (fs_direction) { - ++col; + col += fs_direction; + if (fs_direction > 0) { if (col >= cols) break; } else { - if (col <= 0) break; - --col; + if (col < 0) break; } } while(1); f_pixel *const temperr = thiserr; thiserr = nexterr; nexterr = temperr; - fs_direction = !fs_direction; + fs_direction = -fs_direction; } input_image->free(MIN(thiserr, nexterr)); // MIN because pointers were swapped nearest_free(n); + + return ok; } - -/* histogram contains information how many times each color is present in the image, weighted by importance_map */ -static histogram *get_histogram(liq_image *input_image, const liq_attr *options) +/* fixed colors are always included in the palette, so it would be wasteful to duplicate them in palette from histogram */ +LIQ_NONNULL static void remove_fixed_colors_from_histogram(histogram *hist, const int fixed_colors_count, const f_pixel fixed_colors[], const float target_mse) { - unsigned int ignorebits=MAX(options->min_posterization_output, options->min_posterization_input); + const float max_difference = MAX(target_mse/2.f, 2.f/256.f/256.f); + if (fixed_colors_count) { + for(int j=0; j < hist->size; j++) { + for(unsigned int i=0; i < fixed_colors_count; i++) { + if (colordifference(hist->achv[j].acolor, fixed_colors[i]) < max_difference) { + hist->achv[j] = hist->achv[--hist->size]; // remove color from histogram by overwriting with the last entry + j--; break; // continue searching histogram + } + } + } + } +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_histogram_add_colors(liq_histogram *input_hist, const liq_attr *options, const liq_histogram_entry entries[], int num_entries, double gamma) +{ + if (!CHECK_STRUCT_TYPE(options, liq_attr)) return LIQ_INVALID_POINTER; + if (!CHECK_STRUCT_TYPE(input_hist, liq_histogram)) return LIQ_INVALID_POINTER; + if (!CHECK_USER_POINTER(entries)) return LIQ_INVALID_POINTER; + if (gamma < 0 || gamma >= 1.0) return LIQ_VALUE_OUT_OF_RANGE; + if (num_entries <= 0 || num_entries > 1<<30) return LIQ_VALUE_OUT_OF_RANGE; + + if (input_hist->ignorebits > 0 && input_hist->had_image_added) { + return LIQ_UNSUPPORTED; + } + input_hist->ignorebits = 0; + + input_hist->had_image_added = true; + input_hist->gamma = gamma ? gamma : 0.45455; + + if (!input_hist->acht) { + input_hist->acht = pam_allocacolorhash(~0, num_entries*num_entries, 0, options->malloc, options->free); + if (!input_hist->acht) { + return LIQ_OUT_OF_MEMORY; + } + } + // Fake image size. It's only for hash size estimates. + if (!input_hist->acht->cols) { + input_hist->acht->cols = num_entries; + } + input_hist->acht->rows += num_entries; + + const unsigned int hash_size = input_hist->acht->hash_size; + for(int i=0; i < num_entries; i++) { + const rgba_pixel rgba = { + .r = entries[i].color.r, + .g = entries[i].color.g, + .b = entries[i].color.b, + .a = entries[i].color.a, + }; + union rgba_as_int px = {rgba}; + unsigned int hash; + if (px.rgba.a) { + hash = px.l % hash_size; + } else { + hash=0; px.l=0; + } + if (!pam_add_to_hash(input_hist->acht, hash, entries[i].count, px, i, num_entries)) { + return LIQ_OUT_OF_MEMORY; + } + } + + return LIQ_OK; +} + +LIQ_EXPORT LIQ_NONNULL liq_error liq_histogram_add_image(liq_histogram *input_hist, const liq_attr *options, liq_image *input_image) +{ + if (!CHECK_STRUCT_TYPE(options, liq_attr)) return LIQ_INVALID_POINTER; + if (!CHECK_STRUCT_TYPE(input_hist, liq_histogram)) return LIQ_INVALID_POINTER; + if (!CHECK_STRUCT_TYPE(input_image, liq_image)) return LIQ_INVALID_POINTER; + const unsigned int cols = input_image->width, rows = input_image->height; - if (!input_image->noise && options->use_contrast_maps) { + if (!input_image->importance_map && options->use_contrast_maps) { contrast_maps(input_image); } - /* - ** Step 2: attempt to make a histogram of the colors, unclustered. - ** If at first we don't succeed, increase ignorebits to increase color - ** coherence and try again. - */ + input_hist->gamma = input_image->gamma; - unsigned int maxcolors = options->max_histogram_entries; + for(int i = 0; i < input_image->fixed_colors_count; i++) { + liq_error res = liq_histogram_add_fixed_color_f(input_hist, input_image->fixed_colors[i]); + if (res != LIQ_OK) { + return res; + } + } - struct acolorhash_table *acht; - const bool all_rows_at_once = liq_image_can_use_rows(input_image); + /* + ** Step 2: attempt to make a histogram of the colors, unclustered. + ** If at first we don't succeed, increase ignorebits to increase color + ** coherence and try again. + */ + + if (liq_progress(options, options->progress_stage1 * 0.4f)) { + return LIQ_ABORTED; + } + + const bool all_rows_at_once = liq_image_can_use_rgba_rows(input_image); + + // Usual solution is to start from scratch when limit is exceeded, but that's not possible if it's not + // the first image added + const unsigned int max_histogram_entries = input_hist->had_image_added ? ~0 : options->max_histogram_entries; do { - acht = pam_allocacolorhash(maxcolors, rows*cols, ignorebits, options->malloc, options->free); - if (!acht) return NULL; + if (!input_hist->acht) { + input_hist->acht = pam_allocacolorhash(max_histogram_entries, rows*cols, input_hist->ignorebits, options->malloc, options->free); + } + if (!input_hist->acht) return LIQ_OUT_OF_MEMORY; // histogram uses noise contrast map for importance. Color accuracy in noisy areas is not very important. // noise map does not include edges to avoid ruining anti-aliasing for(unsigned int row=0; row < rows; row++) { bool added_ok; if (all_rows_at_once) { - added_ok = pam_computeacolorhash(acht, (const rgba_pixel *const *)input_image->rows, cols, rows, input_image->noise); + added_ok = pam_computeacolorhash(input_hist->acht, (const rgba_pixel *const *)input_image->rows, cols, rows, input_image->importance_map); if (added_ok) break; } else { const rgba_pixel* rows_p[1] = { liq_image_get_row_rgba(input_image, row) }; - added_ok = pam_computeacolorhash(acht, rows_p, cols, 1, input_image->noise ? &input_image->noise[row * cols] : NULL); + added_ok = pam_computeacolorhash(input_hist->acht, rows_p, cols, 1, input_image->importance_map ? &input_image->importance_map[row * cols] : NULL); } if (!added_ok) { - ignorebits++; - liq_verbose_printf(options, " too many colors! Scaling colors to improve clustering... %d", ignorebits); - pam_freeacolorhash(acht); - acht = NULL; + input_hist->ignorebits++; + liq_verbose_printf(options, " too many colors! Scaling colors to improve clustering... %d", input_hist->ignorebits); + pam_freeacolorhash(input_hist->acht); + input_hist->acht = NULL; + if (liq_progress(options, options->progress_stage1 * 0.6f)) return LIQ_ABORTED; break; } } - } while(!acht); + } while(!input_hist->acht); - if (input_image->noise) { - input_image->free(input_image->noise); - input_image->noise = NULL; - } + input_hist->had_image_added = true; + + liq_image_free_importance_map(input_image); if (input_image->free_pixels && input_image->f_pixels) { liq_image_free_rgba_source(input_image); // bow can free the RGBA source if copy has been made in f_pixels } - histogram *hist = pam_acolorhashtoacolorhist(acht, input_image->gamma, options->malloc, options->free); - pam_freeacolorhash(acht); - - if (hist) { - liq_verbose_printf(options, " made histogram...%d colors found", hist->size); - } - return hist; + return LIQ_OK; } -static void modify_alpha(liq_image *input_image, rgba_pixel *const row_pixels) +LIQ_NONNULL static liq_error finalize_histogram(liq_histogram *input_hist, liq_attr *options, histogram **hist_output) +{ + if (liq_progress(options, options->progress_stage1 * 0.9f)) { + return LIQ_ABORTED; + } + + if (!input_hist->acht) { + return LIQ_BITMAP_NOT_AVAILABLE; + } + + histogram *hist = pam_acolorhashtoacolorhist(input_hist->acht, input_hist->gamma, options->malloc, options->free); + pam_freeacolorhash(input_hist->acht); + input_hist->acht = NULL; + + if (!hist) { + return LIQ_OUT_OF_MEMORY; + } + liq_verbose_printf(options, " made histogram...%d colors found", hist->size); + remove_fixed_colors_from_histogram(hist, input_hist->fixed_colors_count, input_hist->fixed_colors, options->target_mse); + + *hist_output = hist; + return LIQ_OK; +} + +LIQ_NONNULL static void modify_alpha(liq_image *input_image, rgba_pixel *const row_pixels) { /* IE6 makes colors with even slightest transparency completely transparent, thus to improve situation in IE, make colors that are less than ~10% transparent @@ -1262,34 +1695,40 @@ static void modify_alpha(liq_image *input_image, rgba_pixel *const row_pixels) /** Builds two maps: - noise - approximation of areas with high-frequency noise, except straight edges. 1=flat, 0=noisy. + importance_map - approximation of areas with high-frequency noise, except straight edges. 1=flat, 0=noisy. edges - noise map including all edges */ -static void contrast_maps(liq_image *image) +LIQ_NONNULL static void contrast_maps(liq_image *image) { - const int cols = image->width, rows = image->height; + const unsigned int cols = image->width, rows = image->height; if (cols < 4 || rows < 4 || (3*cols*rows) > LIQ_HIGH_MEMORY_LIMIT) { return; } - unsigned char *restrict noise = image->malloc(cols*rows); - unsigned char *restrict edges = image->malloc(cols*rows); + unsigned char *restrict noise = image->importance_map ? image->importance_map : image->malloc(cols*rows); + image->importance_map = NULL; + unsigned char *restrict edges = image->edges ? image->edges : image->malloc(cols*rows); + image->edges = NULL; + unsigned char *restrict tmp = image->malloc(cols*rows); - if (!noise || !edges || !tmp) { + if (!noise || !edges || !tmp || !liq_image_get_row_f_init(image)) { + image->free(noise); + image->free(edges); + image->free(tmp); return; } const f_pixel *curr_row, *prev_row, *next_row; curr_row = prev_row = next_row = liq_image_get_row_f(image, 0); - for (int j=0; j < rows; j++) { + for (unsigned int j=0; j < rows; j++) { prev_row = curr_row; curr_row = next_row; next_row = liq_image_get_row_f(image, MIN(rows-1,j+1)); f_pixel prev, curr = curr_row[0], next=curr; - for (int i=0; i < cols; i++) { + for (unsigned int i=0; i < cols; i++) { prev=curr; curr=next; next = curr_row[MIN(cols-1,i+1)]; @@ -1315,11 +1754,11 @@ static void contrast_maps(liq_image *image) z = 1.f - MAX(z,MIN(horiz,vert)); z *= z; // noise is amplified z *= z; - - z *= 256.f; - noise[j*cols+i] = z < 256 ? z : 255; - z = (1.f-edge)*256.f; - edges[j*cols+i] = z < 256 ? z : 255; + // 85 is about 1/3rd of weight (not 0, because noisy pixels still need to be included, just not as precisely). + const unsigned int z_int = 85 + (unsigned int)(z * 171.f); + noise[j*cols+i] = MIN(z_int, 255); + const int e_int = 255 - (int)(edge * 256.f); + edges[j*cols+i] = e_int > 0 ? MIN(e_int, 255) : 0; } } @@ -1337,11 +1776,11 @@ static void contrast_maps(liq_image *image) liq_min3(edges, tmp, cols, rows); liq_max3(tmp, edges, cols, rows); - for(int i=0; i < cols*rows; i++) edges[i] = MIN(noise[i], edges[i]); + for(unsigned int i=0; i < cols*rows; i++) edges[i] = MIN(noise[i], edges[i]); image->free(tmp); - image->noise = noise; + image->importance_map = noise; image->edges = edges; } @@ -1352,7 +1791,7 @@ static void contrast_maps(liq_image *image) * and peeks 1 pixel above/below. Full 2d algorithm doesn't improve it significantly. * Correct flood fill doesn't have visually good properties. */ -static void update_dither_map(unsigned char *const *const row_pointers, liq_image *input_image) +LIQ_NONNULL static void update_dither_map(liq_image *input_image, unsigned char *const *const row_pointers, colormap *map) { const unsigned int width = input_image->width; const unsigned int height = input_image->height; @@ -1364,27 +1803,30 @@ static void update_dither_map(unsigned char *const *const row_pointers, liq_imag for(unsigned int col=1; col < width; col++) { const unsigned char px = row_pointers[row][col]; + if (input_image->background && map->palette[px].acolor.a < 1.f/256.f) { + // Transparency may or may not create an edge. When there's an explicit background set, assume no edge. + continue; + } if (px != lastpixel || col == width-1) { - float neighbor_count = 2.5f + col-lastcol; + int neighbor_count = 10 * (col-lastcol); unsigned int i=lastcol; while(i < col) { if (row > 0) { unsigned char pixelabove = row_pointers[row-1][i]; - if (pixelabove == lastpixel) neighbor_count += 1.f; + if (pixelabove == lastpixel) neighbor_count += 15; } if (row < height-1) { unsigned char pixelbelow = row_pointers[row+1][i]; - if (pixelbelow == lastpixel) neighbor_count += 1.f; + if (pixelbelow == lastpixel) neighbor_count += 15; } i++; } while(lastcol <= col) { - float e = edges[row*width + lastcol] / 255.f; - e *= 1.f - 2.5f/neighbor_count; - edges[row*width + lastcol++] = e * 255.f; + int e = edges[row*width + lastcol]; + edges[row*width + lastcol++] = (e+128) * (255.f/(255+128)) * (1.f - 20.f / (20 + neighbor_count)); } lastpixel = px; } @@ -1394,7 +1836,32 @@ static void update_dither_map(unsigned char *const *const row_pointers, liq_imag input_image->edges = NULL; } -static void adjust_histogram_callback(hist_item *item, float diff) +/** + * Palette can be NULL, in which case it creates a new palette from scratch. + */ +static colormap *add_fixed_colors_to_palette(colormap *palette, const int max_colors, const f_pixel fixed_colors[], const int fixed_colors_count, void* (*malloc)(size_t), void (*free)(void*)) +{ + if (!fixed_colors_count) return palette; + + colormap *newpal = pam_colormap(MIN(max_colors, (palette ? palette->colors : 0) + fixed_colors_count), malloc, free); + unsigned int i=0; + if (palette && fixed_colors_count < max_colors) { + unsigned int palette_max = MIN(palette->colors, max_colors - fixed_colors_count); + for(; i < palette_max; i++) { + newpal->palette[i] = palette->palette[i]; + } + } + for(int j=0; j < MIN(max_colors, fixed_colors_count); j++) { + newpal->palette[i++] = (colormap_item){ + .acolor = fixed_colors[j], + .fixed = true, + }; + } + if (palette) pam_freecolormap(palette); + return newpal; +} + +LIQ_NONNULL static void adjust_histogram_callback(hist_item *item, float diff) { item->adjusted_weight = (item->perceptual_weight+item->adjusted_weight) * (sqrtf(1.f+diff)); } @@ -1404,22 +1871,33 @@ static void adjust_histogram_callback(hist_item *item, float diff) feedback_loop_trials controls how long the search will take. < 0 skips the iteration. */ -static colormap *find_best_palette(histogram *hist, const liq_attr *options, double *palette_error_p) +static colormap *find_best_palette(histogram *hist, const liq_attr *options, const double max_mse, const f_pixel fixed_colors[], const unsigned int fixed_colors_count, double *palette_error_p) { unsigned int max_colors = options->max_colors; + // if output is posterized it doesn't make sense to aim for perfrect colors, so increase target_mse // at this point actual gamma is not set, so very conservative posterization estimate is used - const double target_mse = MAX(options->target_mse, pow((1<min_posterization_output)/1024.0, 2)); + const double target_mse = MIN(max_mse, MAX(options->target_mse, pow((1<min_posterization_output)/1024.0, 2))); int feedback_loop_trials = options->feedback_loop_trials; + if (hist->size > 5000) {feedback_loop_trials = (feedback_loop_trials*3 + 3)/4;} + if (hist->size > 25000) {feedback_loop_trials = (feedback_loop_trials*3 + 3)/4;} + if (hist->size > 50000) {feedback_loop_trials = (feedback_loop_trials*3 + 3)/4;} + if (hist->size > 100000) {feedback_loop_trials = (feedback_loop_trials*3 + 3)/4;} colormap *acolormap = NULL; double least_error = MAX_DIFF; double target_mse_overshoot = feedback_loop_trials>0 ? 1.05 : 1.0; - const double percent = (double)(feedback_loop_trials>0?feedback_loop_trials:1)/100.0; + const float total_trials = (float)(feedback_loop_trials>0?feedback_loop_trials:1); do { - colormap *newmap = mediancut(hist, options->min_opaque_val, max_colors, - target_mse * target_mse_overshoot, MAX(MAX(90.0/65536.0, target_mse), least_error)*1.2, - options->malloc, options->free); + colormap *newmap; + if (hist->size && fixed_colors_count < max_colors) { + newmap = mediancut(hist, max_colors-fixed_colors_count, target_mse * target_mse_overshoot, MAX(MAX(45.0/65536.0, target_mse), least_error)*1.2, + options->malloc, options->free); + } else { + feedback_loop_trials = 0; + newmap = NULL; + } + newmap = add_fixed_colors_to_palette(newmap, max_colors, fixed_colors, fixed_colors_count, options->malloc, options->free); if (!newmap) { return NULL; } @@ -1429,11 +1907,11 @@ static colormap *find_best_palette(histogram *hist, const liq_attr *options, dou } // after palette has been created, total error (MSE) is calculated to keep the best palette - // at the same time Voronoi iteration is done to improve the palette + // at the same time K-Means iteration is done to improve the palette // and histogram weights are adjusted based on remapping error to give more weight to poorly matched colors const bool first_run_of_target_mse = !acolormap && target_mse > 0; - double total_error = viter_do_iteration(hist, newmap, options->min_opaque_val, first_run_of_target_mse ? NULL : adjust_histogram_callback, !acolormap || options->fast_palette); + double total_error = kmeans_do_iteration(hist, newmap, first_run_of_target_mse ? NULL : adjust_histogram_callback); // goal is to increase quality or to reduce number of colors used if quality is good enough if (!acolormap || total_error < least_error || (total_error <= target_mse && newmap->colors < max_colors)) { @@ -1441,7 +1919,7 @@ static colormap *find_best_palette(histogram *hist, const liq_attr *options, dou acolormap = newmap; if (total_error < target_mse && total_error > 0) { - // voronoi iteration improves quality above what mediancut aims for + // K-Means iteration improves quality above what mediancut aims for // this compensates for it, making mediancut aim for worse target_mse_overshoot = MIN(target_mse_overshoot*1.25, target_mse/total_error); } @@ -1465,60 +1943,80 @@ static colormap *find_best_palette(histogram *hist, const liq_attr *options, dou pam_freecolormap(newmap); } - liq_verbose_printf(options, " selecting colors...%d%%",100-MAX(0,(int)(feedback_loop_trials/percent))); + float fraction_done = 1.f-MAX(0.f, feedback_loop_trials/total_trials); + if (liq_progress(options, options->progress_stage1 + fraction_done * options->progress_stage2)) break; + liq_verbose_printf(options, " selecting colors...%d%%", (int)(100.f * fraction_done)); } while(feedback_loop_trials > 0); - // likely_colormap_index (used and set in viter_do_iteration) can't point to index outside colormap - if (acolormap->colors < 256) { - for(unsigned int j=0; j < hist->size; j++) { - if (hist->achv[j].tmp.likely_colormap_index >= acolormap->colors) { - hist->achv[j].tmp.likely_colormap_index = 0; // actual value doesn't matter, as the guess is out of date anyway - } - } - } *palette_error_p = least_error; return acolormap; } -static liq_result *pngquant_quantize(histogram *hist, const liq_attr *options, const double gamma) +static colormap *histogram_to_palette(const histogram *hist, const liq_attr *options) { + if (!hist->size) { + return NULL; + } + colormap *acolormap = pam_colormap(hist->size, options->malloc, options->free); + for(unsigned int i=0; i < hist->size; i++) { + acolormap->palette[i].acolor = hist->achv[i].acolor; + acolormap->palette[i].popularity = hist->achv[i].perceptual_weight; + } + return acolormap; +} + +LIQ_NONNULL static liq_error pngquant_quantize(histogram *hist, const liq_attr *options, const int fixed_colors_count, const f_pixel fixed_colors[], const double gamma, bool fixed_result_colors, liq_result **result_output) { colormap *acolormap; double palette_error = -1; - // no point having perfect match with imperfect colors (ignorebits > 0) - const bool fast_palette = options->fast_palette || hist->ignorebits > 0; - const bool few_input_colors = hist->size <= options->max_colors; + assert((verbose_print(options, "SLOW debug checks enabled. Recompile with NDEBUG for normal operation."),1)); + + const bool few_input_colors = hist->size+fixed_colors_count <= options->max_colors; + + if (liq_progress(options, options->progress_stage1)) return LIQ_ABORTED; // If image has few colors to begin with (and no quality degradation is required) // then it's possible to skip quantization entirely if (few_input_colors && options->target_mse == 0) { - acolormap = pam_colormap(hist->size, options->malloc, options->free); - for(unsigned int i=0; i < hist->size; i++) { - acolormap->palette[i].acolor = hist->achv[i].acolor; - acolormap->palette[i].popularity = hist->achv[i].perceptual_weight; - } + acolormap = add_fixed_colors_to_palette(histogram_to_palette(hist, options), options->max_colors, fixed_colors, fixed_colors_count, options->malloc, options->free); palette_error = 0; } else { - acolormap = find_best_palette(hist, options, &palette_error); + const double max_mse = options->max_mse * (few_input_colors ? 0.33 : 1.0); // when degrading image that's already paletted, require much higher improvement, since pal2pal often looks bad and there's little gain + acolormap = find_best_palette(hist, options, max_mse, fixed_colors, fixed_colors_count, &palette_error); if (!acolormap) { - return NULL; + return LIQ_VALUE_OUT_OF_RANGE; } - // Voronoi iteration approaches local minimum for the palette - const double max_mse = options->max_mse * (few_input_colors ? 0.33 : 1.0); // when degrading image that's already paletted, require much higher improvement, since pal2pal often looks bad and there's little gain - const double iteration_limit = options->voronoi_iteration_limit; - unsigned int iterations = options->voronoi_iterations; + // K-Means iteration approaches local minimum for the palette + double iteration_limit = options->kmeans_iteration_limit; + unsigned int iterations = options->kmeans_iterations; if (!iterations && palette_error < 0 && max_mse < MAX_DIFF) iterations = 1; // otherwise total error is never calculated and MSE limit won't work if (iterations) { + // likely_colormap_index (used and set in kmeans_do_iteration) can't point to index outside colormap + if (acolormap->colors < 256) for(unsigned int j=0; j < hist->size; j++) { + if (hist->achv[j].tmp.likely_colormap_index >= acolormap->colors) { + hist->achv[j].tmp.likely_colormap_index = 0; // actual value doesn't matter, as the guess is out of date anyway + } + } + + if (hist->size > 5000) {iterations = (iterations*3 + 3)/4;} + if (hist->size > 25000) {iterations = (iterations*3 + 3)/4;} + if (hist->size > 50000) {iterations = (iterations*3 + 3)/4;} + if (hist->size > 100000) {iterations = (iterations*3 + 3)/4; iteration_limit *= 2;} + verbose_print(options, " moving colormap towards local minimum"); double previous_palette_error = MAX_DIFF; for(unsigned int i=0; i < iterations; i++) { - palette_error = viter_do_iteration(hist, acolormap, options->min_opaque_val, NULL, i==0 || options->fast_palette); + palette_error = kmeans_do_iteration(hist, acolormap, NULL); + + if (liq_progress(options, options->progress_stage1 + options->progress_stage2 + (i * options->progress_stage3 * 0.9f) / iterations)) { + break; + } if (fabs(previous_palette_error-palette_error) < iteration_limit) { break; @@ -1535,32 +2033,45 @@ static liq_result *pngquant_quantize(histogram *hist, const liq_attr *options, c if (palette_error > max_mse) { liq_verbose_printf(options, " image degradation MSE=%.3f (Q=%d) exceeded limit of %.3f (%d)", - palette_error*65536.0/6.0, mse_to_quality(palette_error), - max_mse*65536.0/6.0, mse_to_quality(max_mse)); + mse_to_standard_mse(palette_error), mse_to_quality(palette_error), + mse_to_standard_mse(max_mse), mse_to_quality(max_mse)); pam_freecolormap(acolormap); - return NULL; + return LIQ_QUALITY_TOO_LOW; } } + if (liq_progress(options, options->progress_stage1 + options->progress_stage2 + options->progress_stage3 * 0.95f)) { + pam_freecolormap(acolormap); + return LIQ_ABORTED; + } + sort_palette(acolormap, options); + // If palette was created from a multi-image histogram, + // then it shouldn't be optimized for one image during remapping + if (fixed_result_colors) { + for(unsigned int i=0; i < acolormap->colors; i++) { + acolormap->palette[i].fixed = true; + } + } + liq_result *result = options->malloc(sizeof(liq_result)); - if (!result) return NULL; + if (!result) return LIQ_OUT_OF_MEMORY; *result = (liq_result){ .magic_header = liq_result_magic, .malloc = options->malloc, .free = options->free, .palette = acolormap, .palette_error = palette_error, - .fast_palette = fast_palette, .use_dither_map = options->use_dither_map, .gamma = gamma, .min_posterization_output = options->min_posterization_output, }; - return result; + *result_output = result; + return LIQ_OK; } -LIQ_EXPORT liq_error liq_write_remapped_image(liq_result *result, liq_image *input_image, void *buffer, size_t buffer_size) +LIQ_EXPORT LIQ_NONNULL liq_error liq_write_remapped_image(liq_result *result, liq_image *input_image, void *buffer, size_t buffer_size) { if (!CHECK_STRUCT_TYPE(result, liq_result)) { return LIQ_INVALID_POINTER; @@ -1577,7 +2088,7 @@ LIQ_EXPORT liq_error liq_write_remapped_image(liq_result *result, liq_image *inp return LIQ_BUFFER_TOO_SMALL; } - unsigned char *rows[input_image->height]; + LIQ_ARRAY(unsigned char *, rows, input_image->height); unsigned char *buffer_bytes = buffer; for(unsigned int i=0; i < input_image->height; i++) { rows[i] = &buffer_bytes[input_image->width * i]; @@ -1585,7 +2096,7 @@ LIQ_EXPORT liq_error liq_write_remapped_image(liq_result *result, liq_image *inp return liq_write_remapped_image_rows(result, input_image, rows); } -LIQ_EXPORT liq_error liq_write_remapped_image_rows(liq_result *quant, liq_image *input_image, unsigned char **row_pointers) +LIQ_EXPORT LIQ_NONNULL liq_error liq_write_remapped_image_rows(liq_result *quant, liq_image *input_image, unsigned char **row_pointers) { if (!CHECK_STRUCT_TYPE(quant, liq_result)) return LIQ_INVALID_POINTER; if (!CHECK_STRUCT_TYPE(input_image, liq_image)) return LIQ_INVALID_POINTER; @@ -1603,6 +2114,10 @@ LIQ_EXPORT liq_error liq_write_remapped_image_rows(liq_result *quant, liq_image contrast_maps(input_image); } + if (liq_remap_progress(result, result->progress_stage1 * 0.25f)) { + return LIQ_ABORTED; + } + /* ** Step 4: map the colors in the image to their closest match in the ** new colormap, and write 'em out. @@ -1611,20 +2126,27 @@ LIQ_EXPORT liq_error liq_write_remapped_image_rows(liq_result *quant, liq_image float remapping_error = result->palette_error; if (result->dither_level == 0) { set_rounded_palette(&result->int_palette, result->palette, result->gamma, quant->min_posterization_output); - remapping_error = remap_to_palette(input_image, row_pointers, result->palette, quant->fast_palette); + remapping_error = remap_to_palette(input_image, row_pointers, result->palette); } else { - const bool generate_dither_map = result->use_dither_map && (input_image->edges && !input_image->dither_map); + const bool is_image_huge = (input_image->width * input_image->height) > 2000 * 2000; + const bool allow_dither_map = result->use_dither_map == 2 || (!is_image_huge && result->use_dither_map); + const bool generate_dither_map = allow_dither_map && (input_image->edges && !input_image->dither_map); if (generate_dither_map) { // If dithering (with dither map) is required, this image is used to find areas that require dithering - remapping_error = remap_to_palette(input_image, row_pointers, result->palette, quant->fast_palette); - update_dither_map(row_pointers, input_image); + remapping_error = remap_to_palette(input_image, row_pointers, result->palette); + update_dither_map(input_image, row_pointers, result->palette); } - // remapping above was the last chance to do voronoi iteration, hence the final palette is set after remapping + if (liq_remap_progress(result, result->progress_stage1 * 0.5f)) { + return LIQ_ABORTED; + } + + // remapping above was the last chance to do K-Means iteration, hence the final palette is set after remapping set_rounded_palette(&result->int_palette, result->palette, result->gamma, quant->min_posterization_output); - remap_to_palette_floyd(input_image, row_pointers, result->palette, - MAX(remapping_error*2.4, 16.f/256.f), result->use_dither_map, generate_dither_map, result->dither_level); + if (!remap_to_palette_floyd(input_image, row_pointers, result, MAX(remapping_error*2.4, 16.f/256.f), generate_dither_map)) { + return LIQ_ABORTED; + } } // remapping error from dithered image is absurd, so always non-dithered value is used diff --git a/pngquant/libimagequant.cs b/pngquant/libimagequant.cs new file mode 100644 index 0000000..98ee53e --- /dev/null +++ b/pngquant/libimagequant.cs @@ -0,0 +1,164 @@ +/* +This is an example demonstrating use of libimagequant from C#. + +This example code can be freely copied under CC0 (public domain) license. +*/ + +using System; +using System.Collections.Generic; +using System.Runtime.InteropServices; + +[StructLayout(LayoutKind.Sequential)] +struct liq_color +{ + public byte r, g, b, a; +}; + +[StructLayout(LayoutKind.Sequential)] +struct liq_palette +{ + public int count; + [MarshalAs(UnmanagedType.ByValArray, SizeConst = 256)] + public liq_color[] entries; +}; + +enum liq_error +{ + LIQ_OK = 0, + LIQ_QUALITY_TOO_LOW = 99, + LIQ_VALUE_OUT_OF_RANGE = 100, + LIQ_OUT_OF_MEMORY, + LIQ_ABORTED, + LIQ_BITMAP_NOT_AVAILABLE, + LIQ_BUFFER_TOO_SMALL, + LIQ_INVALID_POINTER, +}; + +namespace liq +{ + using liq_attr_ptr = IntPtr; + using liq_image_ptr = IntPtr; + using liq_result_ptr = IntPtr; + using size_t = UIntPtr; + + class Liq + { + [DllImport(@"imagequant.dll")] + public static extern liq_attr_ptr liq_attr_create(); + [DllImport(@"imagequant.dll")] + public static extern liq_attr_ptr liq_attr_copy(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern void liq_attr_destroy(liq_attr_ptr attr); + + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_max_colors(liq_attr_ptr attr, int colors); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_max_colors(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_speed(liq_attr_ptr attr, int speed); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_speed(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_min_opacity(liq_attr_ptr attr, int min); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_min_opacity(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_min_posterization(liq_attr_ptr attr, int bits); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_min_posterization(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_quality(liq_attr_ptr attr, int minimum, int maximum); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_min_quality(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_max_quality(liq_attr_ptr attr); + [DllImport(@"imagequant.dll")] + public static extern void liq_set_last_index_transparent(liq_attr_ptr attr, int is_last); + + [DllImport(@"imagequant.dll")] + public static extern liq_image_ptr liq_image_create_rgba(liq_attr_ptr attr, [In, MarshalAs(UnmanagedType.LPArray)] byte[] bitmap, int width, int height, double gamma); + + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_image_set_memory_ownership(liq_image_ptr image, int ownership_flags); + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_image_add_fixed_color(liq_image_ptr img, liq_color color); + [DllImport(@"imagequant.dll")] + public static extern int liq_image_get_width(liq_image_ptr img); + [DllImport(@"imagequant.dll")] + public static extern int liq_image_get_height(liq_image_ptr img); + [DllImport(@"imagequant.dll")] + public static extern void liq_image_destroy(liq_image_ptr img); + + [DllImport(@"imagequant.dll")] + public static extern liq_result_ptr liq_quantize_image(liq_attr_ptr attr, liq_image_ptr input_image); + + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_dithering_level(liq_result_ptr res, float dither_level); + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_set_output_gamma(liq_result_ptr res, double gamma); + [DllImport(@"imagequant.dll")] + public static extern double liq_get_output_gamma(liq_result_ptr res); + + [DllImport(@"imagequant.dll")] + public static extern IntPtr liq_get_palette(liq_result_ptr res); + + [DllImport(@"imagequant.dll")] + public static extern liq_error liq_write_remapped_image(liq_result_ptr res, liq_image_ptr input_image, [Out, MarshalAs(UnmanagedType.LPArray)] byte[] buffer, size_t buffer_size); + + [DllImport(@"imagequant.dll")] + public static extern double liq_get_quantization_error(liq_result_ptr res); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_quantization_quality(liq_result_ptr res); + [DllImport(@"imagequant.dll")] + public static extern double liq_get_remapping_error(liq_result_ptr res); + [DllImport(@"imagequant.dll")] + public static extern int liq_get_remapping_quality(liq_result_ptr res); + + [DllImport(@"imagequant.dll")] + public static extern void liq_result_destroy(liq_result_ptr res); + + [DllImport(@"imagequant.dll")] + public static extern int liq_version(); + + static void Main(string[] args) + { + Console.WriteLine("library version: {0}", liq_version()); + + int width = 3; + int height = 1; + + var attr = liq_attr_create(); + if (attr == IntPtr.Zero) throw new Exception("can't create attr"); + + byte[] bitmap = { // R, G, B, A, R, G, B, A, ... + 111, 222, 33, 255, + 255, 0, 255, 255, + 255, 0, 255, 255, + }; + var img = liq_image_create_rgba(attr, bitmap, width, height, 0); + if (img == IntPtr.Zero) throw new Exception("can't create image"); + + var res = liq_quantize_image(attr, img); + if (res == IntPtr.Zero) throw new Exception("can't quantize image"); + + var buffer_size = width * height; + var remapped = new byte[buffer_size]; + + var err = liq_write_remapped_image(res, img, remapped, (UIntPtr)buffer_size); + if (err != liq_error.LIQ_OK) + { + throw new Exception("remapping error"); + } + + Console.WriteLine("first pixel is {0}th palette entry", remapped[0]); + + liq_palette pal = (liq_palette)Marshal.PtrToStructure(liq_get_palette(res), typeof(liq_palette)); + + Console.WriteLine("palette entries: {0}; red of first entry: {1}", pal.count, pal.entries[0].r); + + liq_image_destroy(img); + liq_result_destroy(res); + liq_attr_destroy(attr); + } + } +} diff --git a/pngquant/libimagequant.h b/pngquant/libimagequant.h index dce8dd0..44a232e 100644 --- a/pngquant/libimagequant.h +++ b/pngquant/libimagequant.h @@ -1,22 +1,30 @@ /* - * http://pngquant.org + * https://pngquant.org */ #ifndef LIBIMAGEQUANT_H #define LIBIMAGEQUANT_H +#ifdef IMAGEQUANT_EXPORTS +#define LIQ_EXPORT __declspec(dllexport) +#endif + #ifndef LIQ_EXPORT #define LIQ_EXPORT extern #endif -#define LIQ_VERSION 20301 -#define LIQ_VERSION_STRING "2.3.1" +#define LIQ_VERSION 21205 +#define LIQ_VERSION_STRING "2.12.5" #ifndef LIQ_PRIVATE #if defined(__GNUC__) || defined (__llvm__) #define LIQ_PRIVATE __attribute__((visibility("hidden"))) +#define LIQ_NONNULL __attribute__((nonnull)) +#define LIQ_USERESULT __attribute__((warn_unused_result)) #else #define LIQ_PRIVATE +#define LIQ_NONNULL +#define LIQ_USERESULT #endif #endif @@ -29,6 +37,7 @@ extern "C" { typedef struct liq_attr liq_attr; typedef struct liq_image liq_image; typedef struct liq_result liq_result; +typedef struct liq_histogram liq_histogram; typedef struct liq_color { unsigned char r, g, b, a; @@ -44,63 +53,96 @@ typedef enum liq_error { LIQ_QUALITY_TOO_LOW = 99, LIQ_VALUE_OUT_OF_RANGE = 100, LIQ_OUT_OF_MEMORY, - LIQ_NOT_READY, + LIQ_ABORTED, LIQ_BITMAP_NOT_AVAILABLE, LIQ_BUFFER_TOO_SMALL, LIQ_INVALID_POINTER, + LIQ_UNSUPPORTED, } liq_error; -enum liq_ownership {LIQ_OWN_ROWS=4, LIQ_OWN_PIXELS=8}; +enum liq_ownership { + LIQ_OWN_ROWS=4, + LIQ_OWN_PIXELS=8, + LIQ_COPY_PIXELS=16, +}; -LIQ_EXPORT liq_attr* liq_attr_create(void); -LIQ_EXPORT liq_attr* liq_attr_create_with_allocator(void* (*malloc)(size_t), void (*free)(void*)); -LIQ_EXPORT liq_attr* liq_attr_copy(liq_attr* orig); -LIQ_EXPORT void liq_attr_destroy(liq_attr* attr); +typedef struct liq_histogram_entry { + liq_color color; + unsigned int count; +} liq_histogram_entry; -LIQ_EXPORT liq_error liq_set_max_colors(liq_attr* attr, int colors); -LIQ_EXPORT int liq_get_max_colors(const liq_attr* attr); -LIQ_EXPORT liq_error liq_set_speed(liq_attr* attr, int speed); -LIQ_EXPORT int liq_get_speed(const liq_attr* attr); -LIQ_EXPORT liq_error liq_set_min_opacity(liq_attr* attr, int min); -LIQ_EXPORT int liq_get_min_opacity(const liq_attr* attr); -LIQ_EXPORT liq_error liq_set_min_posterization(liq_attr* attr, int bits); -LIQ_EXPORT int liq_get_min_posterization(const liq_attr* attr); -LIQ_EXPORT liq_error liq_set_quality(liq_attr* attr, int minimum, int maximum); -LIQ_EXPORT int liq_get_min_quality(const liq_attr* attr); -LIQ_EXPORT int liq_get_max_quality(const liq_attr* attr); -LIQ_EXPORT void liq_set_last_index_transparent(liq_attr* attr, int is_last); +LIQ_EXPORT LIQ_USERESULT liq_attr* liq_attr_create(void); +LIQ_EXPORT LIQ_USERESULT liq_attr* liq_attr_create_with_allocator(void* (*malloc)(size_t), void (*free)(void*)); +LIQ_EXPORT LIQ_USERESULT liq_attr* liq_attr_copy(const liq_attr *orig) LIQ_NONNULL; +LIQ_EXPORT void liq_attr_destroy(liq_attr *attr) LIQ_NONNULL; -typedef void liq_log_callback_function(const liq_attr*, const char* message, void* user_info); +LIQ_EXPORT LIQ_USERESULT liq_histogram* liq_histogram_create(const liq_attr* attr); +LIQ_EXPORT liq_error liq_histogram_add_image(liq_histogram *hist, const liq_attr *attr, liq_image* image) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_histogram_add_colors(liq_histogram *hist, const liq_attr *attr, const liq_histogram_entry entries[], int num_entries, double gamma) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_histogram_add_fixed_color(liq_histogram *hist, liq_color color, double gamma) LIQ_NONNULL; +LIQ_EXPORT void liq_histogram_destroy(liq_histogram *hist) LIQ_NONNULL; + +LIQ_EXPORT liq_error liq_set_max_colors(liq_attr* attr, int colors) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_get_max_colors(const liq_attr* attr) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_set_speed(liq_attr* attr, int speed) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_get_speed(const liq_attr* attr) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_set_min_opacity(liq_attr* attr, int min) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_get_min_opacity(const liq_attr* attr) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_set_min_posterization(liq_attr* attr, int bits) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_get_min_posterization(const liq_attr* attr) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_set_quality(liq_attr* attr, int minimum, int maximum) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_get_min_quality(const liq_attr* attr) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_get_max_quality(const liq_attr* attr) LIQ_NONNULL; +LIQ_EXPORT void liq_set_last_index_transparent(liq_attr* attr, int is_last) LIQ_NONNULL; + +typedef void liq_log_callback_function(const liq_attr*, const char *message, void* user_info); typedef void liq_log_flush_callback_function(const liq_attr*, void* user_info); LIQ_EXPORT void liq_set_log_callback(liq_attr*, liq_log_callback_function*, void* user_info); LIQ_EXPORT void liq_set_log_flush_callback(liq_attr*, liq_log_flush_callback_function*, void* user_info); -LIQ_EXPORT liq_image* liq_image_create_rgba_rows(liq_attr* attr, void* rows[], int width, int height, double gamma); -LIQ_EXPORT liq_image* liq_image_create_rgba(liq_attr* attr, void* bitmap, int width, int height, double gamma); +typedef int liq_progress_callback_function(float progress_percent, void* user_info); +LIQ_EXPORT void liq_attr_set_progress_callback(liq_attr*, liq_progress_callback_function*, void* user_info); +LIQ_EXPORT void liq_result_set_progress_callback(liq_result*, liq_progress_callback_function*, void* user_info); + +// The rows and their data are not modified. The type of `rows` is non-const only due to a bug in C's typesystem design. +LIQ_EXPORT LIQ_USERESULT liq_image *liq_image_create_rgba_rows(const liq_attr *attr, void *const rows[], int width, int height, double gamma) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT liq_image *liq_image_create_rgba(const liq_attr *attr, const void *bitmap, int width, int height, double gamma) LIQ_NONNULL; typedef void liq_image_get_rgba_row_callback(liq_color row_out[], int row, int width, void* user_info); -LIQ_EXPORT liq_image* liq_image_create_custom(liq_attr* attr, liq_image_get_rgba_row_callback* row_callback, void* user_info, int width, int height, double gamma); +LIQ_EXPORT LIQ_USERESULT liq_image *liq_image_create_custom(const liq_attr *attr, liq_image_get_rgba_row_callback *row_callback, void* user_info, int width, int height, double gamma); -LIQ_EXPORT liq_error liq_image_set_memory_ownership(liq_image* image, int ownership_flags); -LIQ_EXPORT int liq_image_get_width(const liq_image* img); -LIQ_EXPORT int liq_image_get_height(const liq_image* img); -LIQ_EXPORT void liq_image_destroy(liq_image* img); +LIQ_EXPORT liq_error liq_image_set_memory_ownership(liq_image *image, int ownership_flags) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_image_set_background(liq_image *img, liq_image *background_image) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_image_set_importance_map(liq_image *img, unsigned char buffer[], size_t buffer_size, enum liq_ownership memory_handling) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_image_add_fixed_color(liq_image *img, liq_color color) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_image_get_width(const liq_image *img) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT int liq_image_get_height(const liq_image *img) LIQ_NONNULL; +LIQ_EXPORT void liq_image_destroy(liq_image *img) LIQ_NONNULL; -LIQ_EXPORT liq_result* liq_quantize_image(liq_attr* options, liq_image* input_image); +LIQ_EXPORT LIQ_USERESULT liq_error liq_histogram_quantize(liq_histogram *const input_hist, liq_attr *const options, liq_result **result_output) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT liq_error liq_image_quantize(liq_image *const input_image, liq_attr *const options, liq_result **result_output) LIQ_NONNULL; -LIQ_EXPORT liq_error liq_set_dithering_level(liq_result* res, float dither_level); -LIQ_EXPORT liq_error liq_set_output_gamma(liq_result* res, double gamma); -LIQ_EXPORT double liq_get_output_gamma(const liq_result* result); +LIQ_EXPORT liq_error liq_set_dithering_level(liq_result *res, float dither_level) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_set_output_gamma(liq_result* res, double gamma) LIQ_NONNULL; +LIQ_EXPORT LIQ_USERESULT double liq_get_output_gamma(const liq_result *result) LIQ_NONNULL; -LIQ_EXPORT const liq_palette* liq_get_palette(liq_result* result); +LIQ_EXPORT LIQ_USERESULT const liq_palette *liq_get_palette(liq_result *result) LIQ_NONNULL; -LIQ_EXPORT liq_error liq_write_remapped_image(liq_result* result, liq_image* input_image, void* buffer, size_t buffer_size); -LIQ_EXPORT liq_error liq_write_remapped_image_rows(liq_result* result, liq_image* input_image, unsigned char** row_pointers); +LIQ_EXPORT liq_error liq_write_remapped_image(liq_result *result, liq_image *input_image, void *buffer, size_t buffer_size) LIQ_NONNULL; +LIQ_EXPORT liq_error liq_write_remapped_image_rows(liq_result *result, liq_image *input_image, unsigned char **row_pointers) LIQ_NONNULL; -LIQ_EXPORT double liq_get_quantization_error(liq_result* result); -LIQ_EXPORT int liq_get_quantization_quality(liq_result* result); +LIQ_EXPORT double liq_get_quantization_error(const liq_result *result) LIQ_NONNULL; +LIQ_EXPORT int liq_get_quantization_quality(const liq_result *result) LIQ_NONNULL; +LIQ_EXPORT double liq_get_remapping_error(const liq_result *result) LIQ_NONNULL; +LIQ_EXPORT int liq_get_remapping_quality(const liq_result *result) LIQ_NONNULL; -LIQ_EXPORT void liq_result_destroy(liq_result*); +LIQ_EXPORT void liq_result_destroy(liq_result *) LIQ_NONNULL; + +LIQ_EXPORT int liq_version(void); + + +// Deprecated +LIQ_EXPORT LIQ_USERESULT liq_result *liq_quantize_image(liq_attr *options, liq_image *input_image) LIQ_NONNULL; #ifdef __cplusplus } diff --git a/pngquant/mediancut.c b/pngquant/mediancut.c index b376c52..4421cb4 100644 --- a/pngquant/mediancut.c +++ b/pngquant/mediancut.c @@ -1,15 +1,9 @@ /* -** Copyright (C) 1989, 1991 by Jef Poskanzer. -** Copyright (C) 1997, 2000, 2002 by Greg Roelofs; based on an idea by -** Stefan Schneider. -** © 2009-2013 by Kornel Lesinski. +** © 2009-2018 by Kornel Lesiński. +** © 1989, 1991 by Jef Poskanzer. +** © 1997, 2000, 2002 by Greg Roelofs; based on an idea by Stefan Schneider. ** -** Permission to use, copy, modify, and distribute this software and its -** documentation for any purpose and without fee is hereby granted, provided -** that the above copyright notice appear in all copies and that both that -** copyright notice and this permission notice appear in supporting -** documentation. This software is provided "as is" without express or -** implied warranty. +** See COPYRIGHT file for license. */ #include @@ -21,7 +15,7 @@ #define index_of_channel(ch) (offsetof(f_pixel,ch)/sizeof(float)) -static f_pixel averagepixels(unsigned int clrs, const hist_item achv[], float min_opaque_val, const f_pixel center); +static f_pixel averagepixels(unsigned int clrs, const hist_item achv[]); struct box { f_pixel color; @@ -46,7 +40,7 @@ static f_pixel box_variance(const hist_item achv[], const struct box *box) double variancea=0, variancer=0, varianceg=0, varianceb=0; for(unsigned int i = 0; i < box->colors; ++i) { - f_pixel px = achv[box->ind + i].acolor; + const f_pixel px = achv[box->ind + i].acolor; double weight = achv[box->ind + i].adjusted_weight; variancea += variance_diff(mean.a - px.a, 2.0/256.0)*weight; variancer += variance_diff(mean.r - px.r, 1.0/256.0)*weight; @@ -97,7 +91,7 @@ inline static unsigned int qsort_pivot(const hist_item *const base, const unsign const unsigned int aidx=8, bidx=len/2, cidx=len-1; const unsigned int a=base[aidx].tmp.sort_value, b=base[bidx].tmp.sort_value, c=base[cidx].tmp.sort_value; return (a < b) ? ((b < c) ? bidx : ((a < c) ? cidx : aidx )) - : ((b > c) ? bidx : ((a < c) ? aidx : cidx )); + : ((b > c) ? bidx : ((a < c) ? aidx : cidx )); } ALWAYS_INLINE static unsigned int qsort_partition(hist_item *const base, const unsigned int len); @@ -124,7 +118,7 @@ inline static unsigned int qsort_partition(hist_item *const base, const unsigned } /** quick select algorithm */ -static void hist_item_sort_range(hist_item *base, unsigned int len, unsigned int sort_start) +static void hist_item_sort_range(hist_item base[], unsigned int len, unsigned int sort_start) { for(;;) { const unsigned int l = qsort_partition(base, len), r = l+1; @@ -140,7 +134,7 @@ static void hist_item_sort_range(hist_item *base, unsigned int len, unsigned int } /** sorts array to make sum of weights lower than halfvar one side, returns edge between halfvar parts of the set */ -static hist_item *hist_item_sort_halfvar(hist_item *base, unsigned int len, double *const lowervar, const double halfvar) +static hist_item *hist_item_sort_halfvar(hist_item base[], unsigned int len, double *const lowervar, const double halfvar) { do { const unsigned int l = qsort_partition(base, len), r = l+1; @@ -181,7 +175,7 @@ typedef struct { static int comparevariance(const void *ch1, const void *ch2) { return ((const channelvariance*)ch1)->variance > ((const channelvariance*)ch2)->variance ? -1 : - (((const channelvariance*)ch1)->variance < ((const channelvariance*)ch2)->variance ? 1 : 0); + (((const channelvariance*)ch1)->variance < ((const channelvariance*)ch2)->variance ? 1 : 0); } /** Finds which channels need to be sorted first and preproceses achv for fast sort */ @@ -191,20 +185,29 @@ static double prepare_sort(struct box *b, hist_item achv[]) ** Sort dimensions by their variance, and then sort colors first by dimension with highest variance */ channelvariance channels[4] = { + {index_of_channel(a), b->variance.a}, {index_of_channel(r), b->variance.r}, {index_of_channel(g), b->variance.g}, {index_of_channel(b), b->variance.b}, - {index_of_channel(a), b->variance.a}, }; qsort(channels, 4, sizeof(channels[0]), comparevariance); - for(unsigned int i=0; i < b->colors; i++) { - const float *chans = (const float *)&achv[b->ind + i].acolor; + const unsigned int ind1 = b->ind; + const unsigned int colors = b->colors; +#if __GNUC__ >= 9 + #pragma omp parallel for if (colors > 25000) \ + schedule(static) default(none) shared(achv, channels, colors, ind1) +#else + #pragma omp parallel for if (colors > 25000) \ + schedule(static) default(none) shared(achv, channels) +#endif + for(unsigned int i=0; i < colors; i++) { + const float *chans = (const float *)&achv[ind1 + i].acolor; // Only the first channel really matters. When trying median cut many times // with different histogram weights, I don't want sort randomness to influence outcome. - achv[b->ind + i].tmp.sort_value = ((unsigned int)(chans[channels[0].chan]*65535.0)<<16) | - (unsigned int)((chans[channels[2].chan] + chans[channels[1].chan]/2.0 + chans[channels[3].chan]/4.0)*65535.0); + achv[ind1 + i].tmp.sort_value = ((unsigned int)(chans[channels[0].chan]*65535.0)<<16) | + (unsigned int)((chans[channels[2].chan] + chans[channels[1].chan]/2.0 + chans[channels[3].chan]/4.0)*65535.0); } const f_pixel median = get_median(b, achv); @@ -212,6 +215,8 @@ static double prepare_sort(struct box *b, hist_item achv[]) // box will be split to make color_weight of each side even const unsigned int ind = b->ind, end = ind+b->colors; double totalvar = 0; + #pragma omp parallel for if (end - ind > 15000) \ + schedule(static) default(shared) reduction(+:totalvar) for(unsigned int j=ind; j < end; j++) totalvar += (achv[j].color_weight = color_weight(median, achv[j])); return totalvar / 2.0; } @@ -228,13 +233,13 @@ static f_pixel get_median(const struct box *b, hist_item achv[]) // technically the second color is not guaranteed to be sorted correctly // but most of the time it is good enough to be useful - return averagepixels(2, &achv[b->ind + median_start], 1.0, (f_pixel){0.5,0.5,0.5,0.5}); + return averagepixels(2, &achv[b->ind + median_start]); } /* ** Find the best splittable box. -1 if no boxes are splittable. */ -static int best_splittable_box(struct box* bv, unsigned int boxes, const double max_mse) +static int best_splittable_box(struct box bv[], unsigned int boxes, const double max_mse) { int bi=-1; double maxsum=0; for(unsigned int i=0; i < boxes; i++) { @@ -261,15 +266,13 @@ static int best_splittable_box(struct box* bv, unsigned int boxes, const double inline static double color_weight(f_pixel median, hist_item h) { float diff = colordifference(median, h.acolor); - // if color is "good enough", don't split further - if (diff < 2.f/256.f/256.f) diff /= 2.f; return sqrt(diff) * (sqrt(1.0+h.adjusted_weight)-1.0); } -static void set_colormap_from_boxes(colormap *map, struct box* bv, unsigned int boxes, hist_item *achv); -static void adjust_histogram(hist_item *achv, const colormap *map, const struct box* bv, unsigned int boxes); +static void set_colormap_from_boxes(colormap *map, struct box bv[], unsigned int boxes, hist_item *achv); +static void adjust_histogram(hist_item *achv, const struct box bv[], unsigned int boxes); -double box_error(const struct box *box, const hist_item achv[]) +static double box_error(const struct box *box, const hist_item achv[]) { f_pixel avg = box->color; @@ -306,107 +309,106 @@ static bool total_box_error_below_target(double target_mse, struct box bv[], uns return true; } +static void box_init(struct box *box, const hist_item *achv, const unsigned int ind, const unsigned int colors, const double sum) { + box->ind = ind; + box->colors = colors; + box->sum = sum; + box->total_error = -1; + + box->color = averagepixels(colors, &achv[ind]); + #pragma omp task if (colors > 5000) + box->variance = box_variance(achv, box); + #pragma omp task if (colors > 8000) + box->max_error = box_max_error(achv, box); +} + /* ** Here is the fun part, the median-cut colormap generator. This is based ** on Paul Heckbert's paper, "Color Image Quantization for Frame Buffer ** Display," SIGGRAPH 1982 Proceedings, page 297. */ -LIQ_PRIVATE colormap *mediancut(histogram *hist, const float min_opaque_val, unsigned int newcolors, const double target_mse, const double max_mse, void* (*malloc)(size_t), void (*free)(void*)) +LIQ_PRIVATE colormap *mediancut(histogram *hist, unsigned int newcolors, const double target_mse, const double max_mse, void* (*malloc)(size_t), void (*free)(void*)) { hist_item *achv = hist->achv; - struct box bv[newcolors]; + LIQ_ARRAY(struct box, bv, newcolors); + unsigned int boxes = 1; /* ** Set up the initial box. */ - bv[0].ind = 0; - bv[0].colors = hist->size; - bv[0].color = averagepixels(bv[0].colors, &achv[bv[0].ind], min_opaque_val, (f_pixel){0.5,0.5,0.5,0.5}); - bv[0].variance = box_variance(achv, &bv[0]); - bv[0].max_error = box_max_error(achv, &bv[0]); - bv[0].sum = 0; - bv[0].total_error = -1; - for(unsigned int i=0; i < bv[0].colors; i++) bv[0].sum += achv[i].adjusted_weight; - - unsigned int boxes = 1; - - // remember smaller palette for fast searching - colormap *representative_subset = NULL; - unsigned int subset_size = ceilf(powf(newcolors,0.7f)); - - /* - ** Main loop: split boxes until we have enough. - */ - while (boxes < newcolors) { - - if (boxes == subset_size) { - representative_subset = pam_colormap(boxes, malloc, free); - set_colormap_from_boxes(representative_subset, bv, boxes, achv); + #pragma omp parallel + #pragma omp single + { + double sum = 0; + for(unsigned int i=0; i < hist->size; i++) { + sum += achv[i].adjusted_weight; + } + #pragma omp taskgroup + { + box_init(&bv[0], achv, 0, hist->size, sum); } - // first splits boxes that exceed quality limit (to have colors for things like odd green pixel), - // later raises the limit to allow large smooth areas/gradients get colors. - const double current_max_mse = max_mse + (boxes/(double)newcolors)*16.0*max_mse; - const int bi = best_splittable_box(bv, boxes, current_max_mse); - if (bi < 0) - break; /* ran out of colors! */ - - unsigned int indx = bv[bi].ind; - unsigned int clrs = bv[bi].colors; /* - Classic implementation tries to get even number of colors or pixels in each subdivision. - - Here, instead of popularity I use (sqrt(popularity)*variance) metric. - Each subdivision balances number of pixels (popular colors) and low variance - - boxes can be large if they have similar colors. Later boxes with high variance - will be more likely to be split. - - Median used as expected value gives much better results than mean. + ** Main loop: split boxes until we have enough. */ + while (boxes < newcolors) { - const double halfvar = prepare_sort(&bv[bi], achv); - double lowervar=0; + // first splits boxes that exceed quality limit (to have colors for things like odd green pixel), + // later raises the limit to allow large smooth areas/gradients get colors. + const double current_max_mse = max_mse + (boxes/(double)newcolors)*16.0*max_mse; + const int bi = best_splittable_box(bv, boxes, current_max_mse); + if (bi < 0) { + break; /* ran out of colors! */ + } - // hist_item_sort_halfvar sorts and sums lowervar at the same time - // returns item to break at …minus one, which does smell like an off-by-one error. - hist_item *break_p = hist_item_sort_halfvar(&achv[indx], clrs, &lowervar, halfvar); - unsigned int break_at = MIN(clrs-1, break_p - &achv[indx] + 1); + unsigned int indx = bv[bi].ind; + unsigned int clrs = bv[bi].colors; - /* - ** Split the box. - */ - double sm = bv[bi].sum; - double lowersum = 0; - for(unsigned int i=0; i < break_at; i++) lowersum += achv[indx + i].adjusted_weight; + /* + Classic implementation tries to get even number of colors or pixels in each subdivision. - const f_pixel previous_center = bv[bi].color; - bv[bi].colors = break_at; - bv[bi].sum = lowersum; - bv[bi].color = averagepixels(bv[bi].colors, &achv[bv[bi].ind], min_opaque_val, previous_center); - bv[bi].total_error = -1; - bv[bi].variance = box_variance(achv, &bv[bi]); - bv[bi].max_error = box_max_error(achv, &bv[bi]); - bv[boxes].ind = indx + break_at; - bv[boxes].colors = clrs - break_at; - bv[boxes].sum = sm - lowersum; - bv[boxes].color = averagepixels(bv[boxes].colors, &achv[bv[boxes].ind], min_opaque_val, previous_center); - bv[boxes].total_error = -1; - bv[boxes].variance = box_variance(achv, &bv[boxes]); - bv[boxes].max_error = box_max_error(achv, &bv[boxes]); + Here, instead of popularity I use (sqrt(popularity)*variance) metric. + Each subdivision balances number of pixels (popular colors) and low variance - + boxes can be large if they have similar colors. Later boxes with high variance + will be more likely to be split. - ++boxes; + Median used as expected value gives much better results than mean. + */ - if (total_box_error_below_target(target_mse, bv, boxes, hist)) { - break; + const double halfvar = prepare_sort(&bv[bi], achv); + double lowervar=0; + + // hist_item_sort_halfvar sorts and sums lowervar at the same time + // returns item to break at …minus one, which does smell like an off-by-one error. + hist_item *break_p = hist_item_sort_halfvar(&achv[indx], clrs, &lowervar, halfvar); + unsigned int break_at = MIN(clrs-1, break_p - &achv[indx] + 1); + + /* + ** Split the box. + */ + double sm = bv[bi].sum; + double lowersum = 0; + for(unsigned int i=0; i < break_at; i++) lowersum += achv[indx + i].adjusted_weight; + + #pragma omp taskgroup + { + box_init(&bv[bi], achv, indx, break_at, lowersum); + box_init(&bv[boxes], achv, indx + break_at, clrs - break_at, sm - lowersum); + } + + ++boxes; + + if (total_box_error_below_target(target_mse, bv, boxes, hist)) { + break; + } } } colormap *map = pam_colormap(boxes, malloc, free); set_colormap_from_boxes(map, bv, boxes, achv); - map->subset_palette = representative_subset; - adjust_histogram(achv, map, bv, boxes); + adjust_histogram(achv, bv, boxes); return map; } @@ -433,72 +435,37 @@ static void set_colormap_from_boxes(colormap *map, struct box* bv, unsigned int } /* increase histogram popularity by difference from the final color (this is used as part of feedback loop) */ -static void adjust_histogram(hist_item *achv, const colormap *map, const struct box* bv, unsigned int boxes) +static void adjust_histogram(hist_item *achv, const struct box* bv, unsigned int boxes) { for(unsigned int bi = 0; bi < boxes; ++bi) { for(unsigned int i=bv[bi].ind; i < bv[bi].ind+bv[bi].colors; i++) { - achv[i].adjusted_weight *= sqrt(1.0 +colordifference(map->palette[bi].acolor, achv[i].acolor)/4.0); achv[i].tmp.likely_colormap_index = bi; } } } -static f_pixel averagepixels(unsigned int clrs, const hist_item achv[], const float min_opaque_val, const f_pixel center) +static f_pixel averagepixels(unsigned int clrs, const hist_item achv[]) { - double r = 0, g = 0, b = 0, a = 0, new_a=0, sum = 0; - float maxa = 0; + double r = 0, g = 0, b = 0, a = 0, sum = 0; - // first find final opacity in order to blend colors at that opacity - for(unsigned int i = 0; i < clrs; ++i) { + #pragma omp parallel for if (clrs > 25000) \ + schedule(static) default(shared) reduction(+:a) reduction(+:r) reduction(+:g) reduction(+:b) reduction(+:sum) + for(unsigned int i = 0; i < clrs; i++) { const f_pixel px = achv[i].acolor; - new_a += px.a * achv[i].adjusted_weight; - sum += achv[i].adjusted_weight; + const double weight = achv[i].adjusted_weight; - /* find if there are opaque colors, in case we're supposed to preserve opacity exactly (ie_bug) */ - if (px.a > maxa) maxa = px.a; - } - - if (sum) new_a /= sum; - - /** if there was at least one completely opaque color, "round" final color to opaque */ - if (new_a >= min_opaque_val && maxa >= (255.0/256.0)) new_a = 1; - - sum=0; - // reverse iteration for cache locality with previous loop - for(int i = clrs-1; i >= 0; i--) { - double tmp, weight = 1.0f; - f_pixel px = achv[i].acolor; - - /* give more weight to colors that are further away from average - this is intended to prevent desaturation of images and fading of whites - */ - tmp = (center.r - px.r); - weight += tmp*tmp; - tmp = (center.g - px.g); - weight += tmp*tmp; - tmp = (center.b - px.b); - weight += tmp*tmp; - - weight *= achv[i].adjusted_weight; sum += weight; - - if (px.a) { - px.r /= px.a; - px.g /= px.a; - px.b /= px.a; - } - - r += px.r * new_a * weight; - g += px.g * new_a * weight; - b += px.b * new_a * weight; - a += new_a * weight; + a += px.a * weight; + r += px.r * weight; + g += px.g * weight; + b += px.b * weight; } if (sum) { - a /= sum; - r /= sum; - g /= sum; - b /= sum; + a /= sum; + r /= sum; + g /= sum; + b /= sum; } assert(!isnan(r) && !isnan(g) && !isnan(b) && !isnan(a)); diff --git a/pngquant/mediancut.h b/pngquant/mediancut.h index e615c8d..d97696c 100644 --- a/pngquant/mediancut.h +++ b/pngquant/mediancut.h @@ -1,2 +1,2 @@ -LIQ_PRIVATE colormap *mediancut(histogram *hist, const float min_opaque_val, unsigned int newcolors, const double target_mse, const double max_mse, void* (*malloc)(size_t), void (*free)(void*)); +LIQ_PRIVATE colormap *mediancut(histogram *hist, unsigned int newcolors, const double target_mse, const double max_mse, void* (*malloc)(size_t), void (*free)(void*)); diff --git a/pngquant/mempool.c b/pngquant/mempool.c index 032d80a..cd49f59 100644 --- a/pngquant/mempool.c +++ b/pngquant/mempool.c @@ -1,3 +1,10 @@ +/* +** © 2009-2017 by Kornel Lesiński. +** © 1989, 1991 by Jef Poskanzer. +** © 1997, 2000, 2002 by Greg Roelofs; based on an idea by Stefan Schneider. +** +** See COPYRIGHT file for license. +*/ #include "libimagequant.h" #include "mempool.h" @@ -14,7 +21,7 @@ struct mempool { void (*free)(void*); struct mempool *next; }; -LIQ_PRIVATE void* mempool_create(mempool *mptr, const unsigned int size, unsigned int max_size, void* (*malloc)(size_t), void (*free)(void*)) +LIQ_PRIVATE void* mempool_create(mempoolptr *mptr, const unsigned int size, unsigned int max_size, void* (*malloc)(size_t), void (*free)(void*)) { if (*mptr && ((*mptr)->used+size) <= (*mptr)->size) { unsigned int prevused = (*mptr)->used; @@ -22,7 +29,7 @@ LIQ_PRIVATE void* mempool_create(mempool *mptr, const unsigned int size, unsigne return ((char*)(*mptr)) + prevused; } - mempool old = *mptr; + mempoolptr old = *mptr; if (!max_size) max_size = (1<<17); max_size = size+ALIGN_MASK > max_size ? size+ALIGN_MASK : max_size; @@ -42,7 +49,7 @@ LIQ_PRIVATE void* mempool_create(mempool *mptr, const unsigned int size, unsigne return mempool_alloc(mptr, size, size); } -LIQ_PRIVATE void* mempool_alloc(mempool *mptr, unsigned int size, unsigned int max_size) +LIQ_PRIVATE void* mempool_alloc(mempoolptr *mptr, const unsigned int size, const unsigned int max_size) { if (((*mptr)->used+size) <= (*mptr)->size) { unsigned int prevused = (*mptr)->used; @@ -53,10 +60,10 @@ LIQ_PRIVATE void* mempool_alloc(mempool *mptr, unsigned int size, unsigned int m return mempool_create(mptr, size, max_size, (*mptr)->malloc, (*mptr)->free); } -LIQ_PRIVATE void mempool_destroy(mempool m) +LIQ_PRIVATE void mempool_destroy(mempoolptr m) { while (m) { - mempool next = m->next; + mempoolptr next = m->next; m->free(m); m = next; } diff --git a/pngquant/mempool.h b/pngquant/mempool.h index e61b8dd..9b7333b 100644 --- a/pngquant/mempool.h +++ b/pngquant/mempool.h @@ -4,10 +4,10 @@ #include struct mempool; -typedef struct mempool *mempool; +typedef struct mempool *mempoolptr; -LIQ_PRIVATE void* mempool_create(mempool *mptr, unsigned int size, unsigned int capacity, void* (*malloc)(size_t), void (*free)(void*)); -LIQ_PRIVATE void* mempool_alloc(mempool *mptr, unsigned int size, unsigned int capacity); -LIQ_PRIVATE void mempool_destroy(mempool m); +LIQ_PRIVATE void* mempool_create(mempoolptr *mptr, const unsigned int size, unsigned int capacity, void* (*malloc)(size_t), void (*free)(void*)); +LIQ_PRIVATE void* mempool_alloc(mempoolptr *mptr, const unsigned int size, const unsigned int capacity); +LIQ_PRIVATE void mempool_destroy(mempoolptr m); #endif diff --git a/pngquant/nearest.c b/pngquant/nearest.c index e0a14d9..aeb4dc1 100644 --- a/pngquant/nearest.c +++ b/pngquant/nearest.c @@ -1,3 +1,10 @@ +/* +** © 2009-2015 by Kornel Lesiński. +** © 1989, 1991 by Jef Poskanzer. +** © 1997, 2000, 2002 by Greg Roelofs; based on an idea by Stefan Schneider. +** +** See COPYRIGHT file for license. +*/ #include "libimagequant.h" #include "pam.h" @@ -5,234 +12,181 @@ #include "mempool.h" #include -struct sorttmp { - float radius; - unsigned int index; -}; +typedef struct vp_sort_tmp { + float distance_squared; + unsigned int idx; +} vp_sort_tmp; -struct head { - // colors less than radius away from vantage_point color will have best match in candidates +typedef struct vp_search_tmp { + float distance; + unsigned int idx; + int exclude; +} vp_search_tmp; + +typedef struct vp_node { + struct vp_node *near, *far; f_pixel vantage_point; float radius; - unsigned int num_candidates; - f_pixel *candidates_color; - unsigned short *candidates_index; -}; + unsigned int idx; +} vp_node; struct nearest_map { - const colormap *map; + vp_node *root; + const colormap_item *palette; float nearest_other_color_dist[256]; - mempool mempool; - struct head heads[]; + mempoolptr mempool; }; -static unsigned int find_slow(const f_pixel px, const colormap *map) -{ - unsigned int best=0; - float bestdiff = colordifference(px, map->palette[0].acolor); +static void vp_search_node(const vp_node *node, const f_pixel *const needle, vp_search_tmp *const best_candidate); - for(unsigned int i=1; i < map->colors; i++) { - float diff = colordifference(px, map->palette[i].acolor); - if (diff < bestdiff) { +static int vp_compare_distance(const void *ap, const void *bp) { + float a = ((const vp_sort_tmp*)ap)->distance_squared; + float b = ((const vp_sort_tmp*)bp)->distance_squared; + return a > b ? 1 : -1; +} + +static void vp_sort_indexes_by_distance(const f_pixel vantage_point, vp_sort_tmp indexes[], int num_indexes, const colormap_item items[]) { + for(int i=0; i < num_indexes; i++) { + indexes[i].distance_squared = colordifference(vantage_point, items[indexes[i].idx].acolor); + } + qsort(indexes, num_indexes, sizeof(indexes[0]), vp_compare_distance); +} + +/* + * Usually it should pick farthest point, but picking most popular point seems to make search quicker anyway + */ +static int vp_find_best_vantage_point_index(vp_sort_tmp indexes[], int num_indexes, const colormap_item items[]) { + int best = 0; + float best_popularity = items[indexes[0].idx].popularity; + for(int i = 1; i < num_indexes; i++) { + if (items[indexes[i].idx].popularity > best_popularity) { + best_popularity = items[indexes[i].idx].popularity; best = i; - bestdiff = diff; } } return best; } -static float distance_from_nearest_other_color(const colormap *map, const unsigned int i) -{ - float second_best=MAX_DIFF; - for(unsigned int j=0; j < map->colors; j++) { - if (i == j) continue; - float diff = colordifference(map->palette[i].acolor, map->palette[j].acolor); - if (diff <= second_best) { - second_best = diff; - } +static vp_node *vp_create_node(mempoolptr *m, vp_sort_tmp indexes[], int num_indexes, const colormap_item items[]) { + if (num_indexes <= 0) { + return NULL; } - return second_best; + + vp_node *node = mempool_alloc(m, sizeof(node[0]), 0); + + if (num_indexes == 1) { + *node = (vp_node){ + .vantage_point = items[indexes[0].idx].acolor, + .idx = indexes[0].idx, + .radius = MAX_DIFF, + }; + return node; + } + + const int ref = vp_find_best_vantage_point_index(indexes, num_indexes, items); + const int ref_idx = indexes[ref].idx; + + // Removes the `ref_idx` item from remaining items, because it's included in the current node + num_indexes -= 1; + indexes[ref] = indexes[num_indexes]; + + vp_sort_indexes_by_distance(items[ref_idx].acolor, indexes, num_indexes, items); + + // Remaining items are split by the median distance + const int half_idx = num_indexes/2; + + *node = (vp_node){ + .vantage_point = items[ref_idx].acolor, + .idx = ref_idx, + .radius = sqrtf(indexes[half_idx].distance_squared), + }; + node->near = vp_create_node(m, indexes, half_idx, items); + node->far = vp_create_node(m, &indexes[half_idx], num_indexes - half_idx, items); + + return node; } -static int compareradius(const void *ap, const void *bp) -{ - float a = ((const struct sorttmp*)ap)->radius; - float b = ((const struct sorttmp*)bp)->radius; - return a > b ? 1 : (a < b ? -1 : 0); -} +LIQ_PRIVATE struct nearest_map *nearest_init(const colormap *map) { + mempoolptr m = NULL; + struct nearest_map *handle = mempool_create(&m, sizeof(handle[0]), sizeof(handle[0]) + sizeof(vp_node)*map->colors+16, map->malloc, map->free); -static struct head build_head(f_pixel px, const colormap *map, unsigned int num_candidates, mempool *m, float error_margin, bool skip_index[], unsigned int *skipped) -{ - struct sorttmp colors[map->colors]; - unsigned int colorsused=0; + LIQ_ARRAY(vp_sort_tmp, indexes, map->colors); for(unsigned int i=0; i < map->colors; i++) { - if (skip_index[i]) continue; // colors in skip_index have been eliminated already in previous heads - colors[colorsused].index = i; - colors[colorsused].radius = colordifference(px, map->palette[i].acolor); - colorsused++; + indexes[i].idx = i; } - qsort(&colors, colorsused, sizeof(colors[0]), compareradius); - assert(colorsused < 2 || colors[0].radius <= colors[1].radius); // closest first - - num_candidates = MIN(colorsused, num_candidates); - - struct head h = { - .candidates_color = mempool_alloc(m, num_candidates * sizeof(h.candidates_color[0]), 0), - .candidates_index = mempool_alloc(m, num_candidates * sizeof(h.candidates_index[0]), 0), - .vantage_point = px, - .num_candidates = num_candidates, + vp_node *root = vp_create_node(&m, indexes, map->colors, map->palette); + *handle = (struct nearest_map){ + .root = root, + .palette = map->palette, + .mempool = m, }; - for(unsigned int i=0; i < num_candidates; i++) { - h.candidates_color[i] = map->palette[colors[i].index].acolor; - h.candidates_index[i] = colors[i].index; - } - // if all colors within this radius are included in candidates, then there cannot be any other better match - // farther away from the vantage point than half of the radius. Due to alpha channel must assume pessimistic radius. - h.radius = min_colordifference(px, h.candidates_color[num_candidates-1])/4.0f; // /4 = half of radius, but radius is squared - - for(unsigned int i=0; i < num_candidates; i++) { - // divide again as that's matching certain subset within radius-limited subset - // - 1/256 is a tolerance for miscalculation (seems like colordifference isn't exact) - if (colors[i].radius < h.radius/4.f - error_margin) { - skip_index[colors[i].index]=true; - (*skipped)++; - } - } - return h; -} - -static colormap *get_subset_palette(const colormap *map) -{ - if (map->subset_palette) { - return map->subset_palette; - } - - unsigned int subset_size = (map->colors+3)/4; - colormap *subset_palette = pam_colormap(subset_size, map->malloc, map->free); - - for(unsigned int i=0; i < subset_size; i++) { - subset_palette->palette[i] = map->palette[i]; - } - - return subset_palette; -} - -LIQ_PRIVATE struct nearest_map *nearest_init(const colormap *map, bool fast) -{ - colormap *subset_palette = get_subset_palette(map); - const unsigned int num_vantage_points = map->colors > 16 ? MIN(map->colors/4, subset_palette->colors) : 0; - const unsigned long heads_size = sizeof(struct head) * (num_vantage_points+1); // +1 is fallback head - - const unsigned long mempool_size = (sizeof(f_pixel) + sizeof(unsigned int)) * subset_palette->colors * map->colors/5 + (1<<14); - mempool m = NULL; - struct nearest_map *centroids = mempool_create(&m, sizeof(*centroids) + heads_size /* heads array is appended to it */, mempool_size, map->malloc, map->free); - centroids->mempool = m; for(unsigned int i=0; i < map->colors; i++) { - const float dist = distance_from_nearest_other_color(map,i); - centroids->nearest_other_color_dist[i] = dist / 4.f; // half of squared distance + vp_search_tmp best = { + .distance = MAX_DIFF, + .exclude = i, + }; + vp_search_node(root, &map->palette[i].acolor, &best); + handle->nearest_other_color_dist[i] = best.distance * best.distance / 4.0; // half of squared distance } - centroids->map = map; - - unsigned int skipped=0; - assert(map->colors > 0); - bool skip_index[map->colors]; for(unsigned int j=0; j < map->colors; j++) skip_index[j]=false; - - // floats and colordifference calculations are not perfect - const float error_margin = fast ? 0 : 8.f/256.f/256.f; - unsigned int h=0; - for(; h < num_vantage_points; h++) { - unsigned int num_candiadtes = 1+(map->colors - skipped)/((1+num_vantage_points-h)/2); - - centroids->heads[h] = build_head(subset_palette->palette[h].acolor, map, num_candiadtes, ¢roids->mempool, error_margin, skip_index, &skipped); - if (centroids->heads[h].num_candidates == 0) { - break; - } - } - - // assumption that there is no better color within radius of vantage point color - // holds true only for colors within convex hull formed by palette colors. - // since finding proper convex hull is more than a few lines, this - // is a cheap shot at finding just few key points. - const f_pixel extrema[] = { - {.a=0,0,0,0}, - - {.a=.5,0,0,0}, {.a=.5,1,0,0}, - {.a=.5,0,0,1}, {.a=.5,1,0,1}, - {.a=.5,0,1,0}, {.a=.5,1,1,0}, - {.a=.5,0,1,1}, {.a=.5,1,1,1}, - - {.a=1,0,0,0}, {.a=1,1,0,0}, - {.a=1,0,0,1}, {.a=1,1,0,1}, - {.a=1,0,1,0}, {.a=1,1,1,0}, - {.a=1,0,1,1}, {.a=1,1,1,1}, - - {.a=1,.5, 0, 0}, {.a=1, 0,.5, 0}, {.a=1, 0, 0, .5}, - {.a=1,.5, 0, 1}, {.a=1, 0,.5, 1}, {.a=1, 0, 1, .5}, - {.a=1,.5, 1, 0}, {.a=1, 1,.5, 0}, {.a=1, 1, 0, .5}, - {.a=1,.5, 1, 1}, {.a=1, 1,.5, 1}, {.a=1, 1, 1, .5}, - }; - for(unsigned int i=0; i < sizeof(extrema)/sizeof(extrema[0]); i++) { - skip_index[find_slow(extrema[i], map)]=0; - } - - centroids->heads[h] = build_head((f_pixel){0,0,0,0}, map, map->colors, ¢roids->mempool, error_margin, skip_index, &skipped); - centroids->heads[h].radius = MAX_DIFF; - - // get_subset_palette could have created a copy - if (subset_palette != map->subset_palette) { - pam_freecolormap(subset_palette); - } - - return centroids; + return handle; } -LIQ_PRIVATE unsigned int nearest_search(const struct nearest_map *centroids, const f_pixel px, int likely_colormap_index, const float min_opaque_val, float *diff) -{ - const bool iebug = px.a > min_opaque_val; +static void vp_search_node(const vp_node *node, const f_pixel *const needle, vp_search_tmp *const best_candidate) { + do { + const float distance = sqrtf(colordifference(node->vantage_point, *needle)); - const struct head *const heads = centroids->heads; + if (distance < best_candidate->distance && best_candidate->exclude != node->idx) { + best_candidate->distance = distance; + best_candidate->idx = node->idx; + } - assert(likely_colormap_index < centroids->map->colors); - const float guess_diff = colordifference(centroids->map->palette[likely_colormap_index].acolor, px); - if (guess_diff < centroids->nearest_other_color_dist[likely_colormap_index]) { + // Recurse towards most likely candidate first to narrow best candidate's distance as soon as possible + if (distance < node->radius) { + if (node->near) { + vp_search_node(node->near, needle, best_candidate); + } + // The best node (final answer) may be just ouside the radius, but not farther than + // the best distance we know so far. The vp_search_node above should have narrowed + // best_candidate->distance, so this path is rarely taken. + if (node->far && distance >= node->radius - best_candidate->distance) { + node = node->far; // Fast tail recursion + } else { + break; + } + } else { + if (node->far) { + vp_search_node(node->far, needle, best_candidate); + } + if (node->near && distance <= node->radius + best_candidate->distance) { + node = node->near; // Fast tail recursion + } else { + break; + } + } + } while(true); +} + +LIQ_PRIVATE unsigned int nearest_search(const struct nearest_map *handle, const f_pixel *px, const int likely_colormap_index, float *diff) { + const float guess_diff = colordifference(handle->palette[likely_colormap_index].acolor, *px); + if (guess_diff < handle->nearest_other_color_dist[likely_colormap_index]) { if (diff) *diff = guess_diff; return likely_colormap_index; } - for(unsigned int i=0; /* last head will always be selected */ ; i++) { - float vantage_point_dist = colordifference(px, heads[i].vantage_point); - - if (vantage_point_dist <= heads[i].radius) { - assert(heads[i].num_candidates); - unsigned int ind=0; - float dist = colordifference(px, heads[i].candidates_color[0]); - - /* penalty for making holes in IE */ - if (iebug && heads[i].candidates_color[0].a < 1) { - dist += 1.f/1024.f; - } - - for(unsigned int j=1; j < heads[i].num_candidates; j++) { - float newdist = colordifference(px, heads[i].candidates_color[j]); - - /* penalty for making holes in IE */ - if (iebug && heads[i].candidates_color[j].a < 1) { - newdist += 1.f/1024.f; - } - - if (newdist < dist) { - dist = newdist; - ind = j; - } - } - if (diff) *diff = dist; - return heads[i].candidates_index[ind]; - } + vp_search_tmp best_candidate = { + .distance = sqrtf(guess_diff), + .idx = likely_colormap_index, + .exclude = -1, + }; + vp_search_node(handle->root, px, &best_candidate); + if (diff) { + *diff = best_candidate.distance * best_candidate.distance; } + return best_candidate.idx; } LIQ_PRIVATE void nearest_free(struct nearest_map *centroids) diff --git a/pngquant/nearest.h b/pngquant/nearest.h index 9745d95..e20233b 100644 --- a/pngquant/nearest.h +++ b/pngquant/nearest.h @@ -3,6 +3,6 @@ // pngquant // struct nearest_map; -LIQ_PRIVATE struct nearest_map *nearest_init(const colormap *palette, const bool fast); -LIQ_PRIVATE unsigned int nearest_search(const struct nearest_map *map, const f_pixel px, const int palette_index_guess, const float min_opaque, float *diff); +LIQ_PRIVATE struct nearest_map *nearest_init(const colormap *palette); +LIQ_PRIVATE unsigned int nearest_search(const struct nearest_map *map, const f_pixel *px, const int palette_index_guess, float *diff); LIQ_PRIVATE void nearest_free(struct nearest_map *map); diff --git a/pngquant/org/pngquant/Image.java b/pngquant/org/pngquant/Image.java new file mode 100644 index 0000000..676d164 --- /dev/null +++ b/pngquant/org/pngquant/Image.java @@ -0,0 +1,74 @@ +package org.pngquant; + +import org.pngquant.*; +import java.awt.image.*; + +/** + * PngQuant's representation of an Image constructed from BufferedImage. + */ +public class Image extends LiqObject { + + /** + * Converts BufferedImage to internal representation (pixel data is copied). + * It's best to use BufferedImage in RGB/RGBA format backed by DataBufferByte. + * Throws if conversion fails. + */ + public Image(BufferedImage image) throws PngQuantException { + this(new PngQuant(), image); + } + + public Image(PngQuant attr, BufferedImage image) throws PngQuantException { + handle = handleFromImage(attr, image); + + if (handle == 0) { + BufferedImage converted = new BufferedImage(image.getWidth(), image.getHeight(), BufferedImage.TYPE_4BYTE_ABGR); + converted.getGraphics().drawImage(image, 0, 0, null); + handle = handleFromImage(attr, converted); + + if (handle == 0) { + throw new PngQuantException(); + } + } + } + + /** + * Guarantees presence of the given color in the palette (subject to setMaxColors()) + * if this image is used for quantization. + */ + public native boolean addFixedColor(int r, int g, int b, int a); + public boolean addFixedColor(int r, int g, int b) { + return addFixedColor(r, g, b, 255); + } + public native int getWidth(); + public native int getHeight(); + + public void close() { + if (handle != 0) { + liq_image_destroy(handle); + handle = 0; + } + } + + private static long handleFromImage(PngQuant attr, BufferedImage image) { + // The JNI wrapper will accept non-premultiplied ABGR and BGR only. + int type = image.getType(); + if (type != BufferedImage.TYPE_3BYTE_BGR && + type != BufferedImage.TYPE_4BYTE_ABGR && + type != BufferedImage.TYPE_4BYTE_ABGR_PRE) return 0; + + WritableRaster raster = image.getRaster(); + ColorModel color = image.getColorModel(); + if (type == BufferedImage.TYPE_4BYTE_ABGR_PRE) color.coerceData(raster, false); + + DataBuffer buffer = raster.getDataBuffer(); + if (buffer instanceof DataBufferByte) { + byte[] imageData = ((DataBufferByte)buffer).getData(); + return liq_image_create(attr.handle, imageData, + raster.getWidth(), raster.getHeight(), color.getNumComponents()); + } + return 0; + } + + private static native long liq_image_create(long attr, byte[] bitmap, int width, int height, int components); + private static native void liq_image_destroy(long handle); +} diff --git a/pngquant/org/pngquant/LiqObject.java b/pngquant/org/pngquant/LiqObject.java new file mode 100644 index 0000000..deaf6e9 --- /dev/null +++ b/pngquant/org/pngquant/LiqObject.java @@ -0,0 +1,19 @@ +package org.pngquant; + +abstract class LiqObject { + static { + // libimagequant.jnilib or libimagequant.so must be in java.library.path + System.loadLibrary("imagequant"); + } + + long handle; + + /** + * Free memory used by the library. The object must not be used after this call. + */ + abstract public void close(); + + protected void finalize() throws Throwable { + close(); + } +} diff --git a/pngquant/org/pngquant/PngQuant.c b/pngquant/org/pngquant/PngQuant.c new file mode 100644 index 0000000..06fa547 --- /dev/null +++ b/pngquant/org/pngquant/PngQuant.c @@ -0,0 +1,156 @@ +#include "org/pngquant/PngQuant.h" +#include "org/pngquant/Image.h" +#include "org/pngquant/Result.h" +#include "libimagequant.h" +#include + +typedef struct { + liq_image *image; + jbyte *data; +} liq_jni_image; + +static void *handle(JNIEnv *env, jobject obj) { + jlong h = (*env)->GetLongField(env, obj, (*env)->GetFieldID(env, (*env)->GetObjectClass(env, obj), "handle", "J")); + return (void*)h; +} + +JNIEXPORT jlong JNICALL Java_org_pngquant_PngQuant_liq_1attr_1create(JNIEnv *env, jclass class) { + return (jlong)liq_attr_create(); +} + +JNIEXPORT jlong JNICALL Java_org_pngquant_PngQuant_liq_1attr_1copy(JNIEnv *env, jclass class, jlong attr) { + return (jlong)liq_attr_copy((liq_attr*)attr); +} + +JNIEXPORT void JNICALL Java_org_pngquant_PngQuant_liq_1attr_1destroy(JNIEnv *env, jclass class, jlong attr) { + return liq_attr_destroy((liq_attr*)attr); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_PngQuant_setMaxColors(JNIEnv *env, jobject obj, jint colors) { + return LIQ_OK == liq_set_max_colors(handle(env, obj), colors); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_PngQuant_setSpeed(JNIEnv *env, jobject obj, jint speed) { + return LIQ_OK == liq_set_speed(handle(env, obj), speed); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_PngQuant_setMinPosterization(JNIEnv *env, jobject obj, jint p) { + return LIQ_OK == liq_set_min_posterization(handle(env, obj), p); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_PngQuant_setQuality__I(JNIEnv *env, jobject obj, jint q) { + return LIQ_OK == liq_set_quality(handle(env, obj), q/2, q); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_PngQuant_setQuality__II(JNIEnv *env, jobject obj, jint qmin, jint qmax) { + return LIQ_OK == liq_set_quality(handle(env, obj), qmin, qmax); +} + +static void convert_abgr(liq_color row_out[], int row_index, int width, void* user_info) { + liq_jni_image *jniimg = user_info; + int column_index; + for(column_index=0; column_index < width; column_index++) { + row_out[column_index].r = jniimg->data[4*(width*row_index + column_index) + 3]; + row_out[column_index].g = jniimg->data[4*(width*row_index + column_index) + 2]; + row_out[column_index].b = jniimg->data[4*(width*row_index + column_index) + 1]; + row_out[column_index].a = jniimg->data[4*(width*row_index + column_index) + 0]; + } +} + +static void convert_bgr(liq_color row_out[], int row_index, int width, void* user_info) { + liq_jni_image *jniimg = user_info; + int column_index; + for(column_index=0; column_index < width; column_index++) { + row_out[column_index].r = jniimg->data[3*(width*row_index + column_index) + 2]; + row_out[column_index].g = jniimg->data[3*(width*row_index + column_index) + 1]; + row_out[column_index].b = jniimg->data[3*(width*row_index + column_index) + 0]; + row_out[column_index].a = 255; + } +} + +JNIEXPORT jlong JNICALL Java_org_pngquant_Image_liq_1image_1create(JNIEnv *env, jclass class, jlong attr, jbyteArray bytearray, jint w, jint h, jint components) { + /* liq_image needs to be wrapped to keep track of allocated buffer */ + liq_jni_image *jniimg = malloc(sizeof(liq_jni_image)); + + /* copying buffer, since ReleaseByteArrayElements was crashing when called from finalize() */ + jsize size = (*env)->GetArrayLength(env, bytearray); + jniimg->data = malloc(size); + (*env)->GetByteArrayRegion(env, bytearray, 0, size, jniimg->data); + + jniimg->image = liq_image_create_custom((liq_attr*)attr, components == 4 ? convert_abgr : convert_bgr, jniimg, w, h, 0); + + if (!jniimg->image) { + free(jniimg->data); + free(jniimg); + return 0; + } + return (jlong)jniimg; +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_Image_addFixedColor(JNIEnv *env, jobject obj, jint r, jint g, jint b, jint a) { + liq_color c = {r,g,b,a}; + return LIQ_OK == liq_image_add_fixed_color(((liq_jni_image*)handle(env,obj))->image, c); +} + +JNIEXPORT jint JNICALL Java_org_pngquant_Image_getWidth(JNIEnv *env, jobject obj) { + return liq_image_get_width(((liq_jni_image*)handle(env,obj))->image); +} + +JNIEXPORT jint JNICALL Java_org_pngquant_Image_getHeight(JNIEnv *env, jobject obj) { + return liq_image_get_height(((liq_jni_image*)handle(env,obj))->image); +} + +JNIEXPORT void JNICALL Java_org_pngquant_Image_liq_1image_1destroy(JNIEnv *env, jclass class, jlong handle) { + liq_jni_image *jniimg = (liq_jni_image*)handle; + liq_image_destroy(jniimg->image); + free(jniimg->data); + free(jniimg); +} + +JNIEXPORT jlong JNICALL Java_org_pngquant_Result_liq_1quantize_1image(JNIEnv *env, jclass class, jlong attr, jlong handle) { + return (jlong)liq_quantize_image((liq_attr*)attr, ((liq_jni_image*)handle)->image); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_Result_setDitheringLevel(JNIEnv *env, jobject obj, jfloat l) { + return LIQ_OK == liq_set_dithering_level(handle(env, obj), l); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_Result_setGamma(JNIEnv *env, jobject obj, jdouble gamma) { + return LIQ_OK == liq_set_output_gamma(handle(env, obj), gamma); +} + +JNIEXPORT jdouble JNICALL Java_org_pngquant_Result_getGamma(JNIEnv *env, jobject obj) { + return liq_get_output_gamma(handle(env, obj)); +} + +JNIEXPORT jboolean JNICALL Java_org_pngquant_Result_liq_1write_1remapped_1image(JNIEnv *env, jclass class, jlong result, jlong image_handle, jbyteArray bytearray) { + jsize size = (*env)->GetArrayLength(env, bytearray); + + jbyte *bitmap = (*env)->GetByteArrayElements(env, bytearray, 0); + liq_error err = liq_write_remapped_image((liq_result*)result, ((liq_jni_image*)image_handle)->image, bitmap, size); + (*env)->ReleaseByteArrayElements(env, bytearray, bitmap, 0); + + return LIQ_OK == err; +} + +JNIEXPORT jdouble JNICALL Java_org_pngquant_Result_getMeanSquareError(JNIEnv *env, jobject obj) { + return liq_get_quantization_error(handle(env, obj)); +} + +JNIEXPORT jint JNICALL Java_org_pngquant_Result_getQuality(JNIEnv *env, jobject obj) { + return liq_get_quantization_quality(handle(env, obj)); +} + +JNIEXPORT void JNICALL Java_org_pngquant_Result_liq_1result_1destroy(JNIEnv *env, jclass class, jlong result) { + return liq_result_destroy((liq_result*)result); +} + +JNIEXPORT jbyteArray JNICALL Java_org_pngquant_Result_liq_1get_1palette(JNIEnv *env, jclass class, jlong result) { + const liq_palette *pal = liq_get_palette((liq_result*)result); + jbyteArray arr = (*env)->NewByteArray(env, pal->count * 4); + int i; + for(i=0; i < pal->count; i++) { + (*env)->SetByteArrayRegion(env, arr, i*4, 4, ((jbyte*)&pal->entries[i])); + } + return arr; +} diff --git a/pngquant/org/pngquant/PngQuant.java b/pngquant/org/pngquant/PngQuant.java new file mode 100644 index 0000000..a8e54d2 --- /dev/null +++ b/pngquant/org/pngquant/PngQuant.java @@ -0,0 +1,111 @@ +package org.pngquant; + +import org.pngquant.*; +import java.awt.image.*; + +/** + * Starting point for the library. Holds configuration. Equivalent of liq_attr* in libimagequant. + */ +public class PngQuant extends LiqObject { + + /** + * Single instance can be "recycled" for many remappings. + */ + public PngQuant() { + handle = liq_attr_create(); + } + + public PngQuant(PngQuant other) { + handle = liq_attr_copy(other.handle); + } + + /** + * 1-shot quantization and remapping with current settings. + * @see quantize() + * + * @return 8-bit indexed image or null on failure + */ + public BufferedImage getRemapped(BufferedImage bufimg) { + try { + Image liqimg = new Image(this, bufimg); + BufferedImage remapped = getRemapped(liqimg); + liqimg.close(); + return remapped; + } catch(PngQuantException e) { + return null; + } + } + + /** @return remapped image or null on failure */ + public BufferedImage getRemapped(Image liqimg) { + Result result = quantize(liqimg); + if (result == null) return null; + BufferedImage remapped = result.getRemapped(liqimg); + result.close(); + return remapped; + } + + /** + * Performs quantization (chooses optimal palette for the given Image). + * Returned object can be used to customize remapping and reused to remap other images to the same palette. + * @link http://pngquant.org/lib/#liq_quantize_image + * + * @return null on failure + */ + public Result quantize(Image img) { + try { + return new Result(this, img); + } catch(PngQuantException e) { + return null; + } + } + + /** + * Remapped images won't use more than given number of colors (may use less if setQuality() is used) + * + * @link http://pngquant.org/lib/#liq_set_max_colors + */ + public native boolean setMaxColors(int colors); + + /** + * Equivalent of setQuality(target/2, target) + * + * @link http://pngquant.org/lib/#liq_set_quality + */ + public native boolean setQuality(int target); + + /** + * Quality in range 0-100. Quantization will fail if minimum quality cannot + * be achieved with given number of colors. + * + * @link http://pngquant.org/lib/#liq_set_quality + */ + public native boolean setQuality(int min, int max); + + /** + * Speed in range 1 (slowest) and 11 (fastest). 3 is the optimum. + * Higher speeds quantize quicker, but at cost of quality and sometimes larger images. + * + * @link http://pngquant.org/lib/#liq_set_speed + */ + public native boolean setSpeed(int speed); + + /** + * Reduces color precision by truncating number of least significant bits. + * Slightly improves speed and helps generating images for low-fidelity displays/textures. + * + * @link http://pngquant.org/lib/#liq_set_min_posterization + */ + public native boolean setMinPosterization(int bits); + + public void close() { + if (handle != 0) { + liq_attr_destroy(handle); + handle = 0; + } + } + + private static native long liq_attr_create(); + private static native long liq_attr_copy(long orig); + private static native void liq_attr_destroy(long handle); +} diff --git a/pngquant/org/pngquant/PngQuantException.java b/pngquant/org/pngquant/PngQuantException.java new file mode 100644 index 0000000..8af2b9f --- /dev/null +++ b/pngquant/org/pngquant/PngQuantException.java @@ -0,0 +1,4 @@ +package org.pngquant; + +public class PngQuantException extends Exception { +} diff --git a/pngquant/org/pngquant/Result.java b/pngquant/org/pngquant/Result.java new file mode 100644 index 0000000..f4ef43c --- /dev/null +++ b/pngquant/org/pngquant/Result.java @@ -0,0 +1,90 @@ +package org.pngquant; + +import org.pngquant.*; +import java.awt.image.*; + +/** + * Quantization result that holds palette and options for remapping. + */ +public class Result extends LiqObject { + + /** + * Throws when quantization fails (e.g. due to failing to achieve minimum quality) + */ + public Result(PngQuant pngquant, Image image) throws PngQuantException { + handle = liq_quantize_image(pngquant.handle, image.handle); + if (handle == 0) { + throw new PngQuantException(); + } + } + + /** + * @return BufferedImage remapped to palette this Result has been created with or null on failure. + */ + public BufferedImage getRemapped(Image orig_image) { + byte[] pal = liq_get_palette(handle); + IndexColorModel color = new IndexColorModel(8, pal.length/4, pal, 0, true); + BufferedImage img = new BufferedImage( + orig_image.getWidth(), orig_image.getHeight(), + BufferedImage.TYPE_BYTE_INDEXED, color); + + byte[] data = get8bitDataFromImage(img); + if (data == null) return null; + + if (!liq_write_remapped_image(handle, orig_image.handle, data)) return null; + + return img; + } + + /** + * Dithering strength. Floyd-Steinberg is always used and in + * speed settings 1-5 high-quality adaptive dithering is used. + * @see PngQuant.setSpeed() + * @link http://pngquant.org/lib/#liq_set_dithering_level + * + * @param dither_level Dithering in range 0 (none) and 1 (full) + */ + public native boolean setDitheringLevel(float dither_level); + + /** + * The default is 0.45455 (1/2.2) which is PNG's approximation of sRGB. + */ + public native boolean setGamma(double gamma); + public native double getGamma(); + + /** + * Mean Square Error of remapping of image used to create this result. + * @link http://pngquant.org/lib/#liq_get_quantization_error + * + * @return MSE or -1 if not available + */ + public native double getMeanSquareError(); + + /** + * @link http://pngquant.org/lib/#liq_get_quantization_quality + * @return Actually achieved quality in 0-100 range on scale compatible with PngQuant.setQuality() + */ + public native int getQuality(); + + public void close() { + if (handle != 0) { + liq_result_destroy(handle); + handle = 0; + } + } + + private static byte[] get8bitDataFromImage(BufferedImage image) { + if (image.getType() == BufferedImage.TYPE_BYTE_INDEXED) { + DataBuffer buffer = image.getRaster().getDataBuffer(); + if (buffer instanceof DataBufferByte) { + return ((DataBufferByte)buffer).getData(); + } + } + return null; + } + + private static native byte[] liq_get_palette(long handle); + private static native long liq_quantize_image(long attr, long image); + private static native boolean liq_write_remapped_image(long handle, long image, byte[] buffer); + private static native void liq_result_destroy(long handle); +} diff --git a/pngquant/pam.c b/pngquant/pam.c index 647a8aa..660f829 100644 --- a/pngquant/pam.c +++ b/pngquant/pam.c @@ -1,16 +1,10 @@ /* pam.c - pam (portable alpha map) utility library ** -** Copyright (C) 1989, 1991 by Jef Poskanzer. -** Copyright (C) 1997, 2000, 2002 by Greg Roelofs; based on an idea by -** Stefan Schneider. -** © 2009-2013 by Kornel Lesinski. +** © 2009-2017 by Kornel Lesiński. +** © 1989, 1991 by Jef Poskanzer. +** © 1997, 2000, 2002 by Greg Roelofs; based on an idea by Stefan Schneider. ** -** Permission to use, copy, modify, and distribute this software and its -** documentation for any purpose and without fee is hereby granted, provided -** that the above copyright notice appear in all copies and that both that -** copyright notice and this permission notice appear in supporting -** documentation. This software is provided "as is" without express or -** implied warranty. +** See COPYRIGHT file for license. */ #include @@ -22,28 +16,19 @@ LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba_pixel *const pixels[], unsigned int cols, unsigned int rows, const unsigned char *importance_map) { - const unsigned int maxacolors = acht->maxcolors, ignorebits = acht->ignorebits; + const unsigned int ignorebits = acht->ignorebits; const unsigned int channel_mask = 255U>>ignorebits<>ignorebits) ^ 0xFFU; const unsigned int posterize_mask = channel_mask << 24 | channel_mask << 16 | channel_mask << 8 | channel_mask; const unsigned int posterize_high_mask = channel_hmask << 24 | channel_hmask << 16 | channel_hmask << 8 | channel_hmask; - struct acolorhist_arr_head *const buckets = acht->buckets; - unsigned int colors = acht->colors; const unsigned int hash_size = acht->hash_size; - const unsigned int stacksize = sizeof(acht->freestack)/sizeof(acht->freestack[0]); - struct acolorhist_arr_item **freestack = acht->freestack; - unsigned int freestackp=acht->freestackp; - /* Go through the entire image, building a hash table of colors. */ for(unsigned int row = 0; row < rows; ++row) { - float boost=1.0; for(unsigned int col = 0; col < cols; ++col) { - if (importance_map) { - boost = 0.5f+ (double)*importance_map++/255.f; - } + unsigned int boost; // RGBA color is casted to long for easier hasing/comparisons union rgba_as_int px = {pixels[row][col]}; @@ -51,26 +36,50 @@ LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba if (!px.rgba.a) { // "dirty alpha" has different RGBA values that end up being the same fully transparent color px.l=0; hash=0; + + boost = 2000; + if (importance_map) { + importance_map++; + } } else { // mask posterizes all 4 channels in one go px.l = (px.l & posterize_mask) | ((px.l & posterize_high_mask) >> (8-ignorebits)); // fancier hashing algorithms didn't improve much hash = px.l % hash_size; + + if (importance_map) { + boost = *importance_map++; + } else { + boost = 255; + } } + if (!pam_add_to_hash(acht, hash, boost, px, row, rows)) { + return false; + } + } + + } + acht->cols = cols; + acht->rows += rows; + return true; +} + +LIQ_PRIVATE bool pam_add_to_hash(struct acolorhash_table *acht, unsigned int hash, unsigned int boost, union rgba_as_int px, unsigned int row, unsigned int rows) +{ /* head of the hash function stores first 2 colors inline (achl->used = 1..2), to reduce number of allocations of achl->other_items. */ - struct acolorhist_arr_head *achl = &buckets[hash]; + struct acolorhist_arr_head *achl = &acht->buckets[hash]; if (achl->inline1.color.l == px.l && achl->used) { achl->inline1.perceptual_weight += boost; - continue; + return true; } if (achl->used) { if (achl->used > 1) { if (achl->inline2.color.l == px.l) { achl->inline2.perceptual_weight += boost; - continue; + return true; } // other items are stored as an array (which gets reallocated if needed) struct acolorhist_arr_item *other_items = achl->other_items; @@ -78,7 +87,7 @@ LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba for (; i < achl->used-2; i++) { if (other_items[i].color.l == px.l) { other_items[i].perceptual_weight += boost; - goto continue_outer_loop; + return true; } } @@ -89,13 +98,11 @@ LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba .perceptual_weight = boost, }; achl->used++; - ++colors; - continue; + ++acht->colors; + return true; } - if (++colors > maxacolors) { - acht->colors = colors; - acht->freestackp = freestackp; + if (++acht->colors > acht->maxcolors) { return false; } @@ -103,22 +110,24 @@ LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba unsigned int capacity; if (!other_items) { // there was no array previously, alloc "small" array capacity = 8; - if (freestackp <= 0) { + if (acht->freestackp <= 0) { // estimate how many colors are going to be + headroom - const int mempool_size = ((acht->rows + rows-row) * 2 * colors / (acht->rows + row + 1) + 1024) * sizeof(struct acolorhist_arr_item); + const size_t mempool_size = ((acht->rows + rows-row) * 2 * acht->colors / (acht->rows + row + 1) + 1024) * sizeof(struct acolorhist_arr_item); new_items = mempool_alloc(&acht->mempool, sizeof(struct acolorhist_arr_item)*capacity, mempool_size); } else { // freestack stores previously freed (reallocated) arrays that can be reused // (all pesimistically assumed to be capacity = 8) - new_items = freestack[--freestackp]; + new_items = acht->freestack[--acht->freestackp]; } } else { + const unsigned int stacksize = sizeof(acht->freestack)/sizeof(acht->freestack[0]); + // simply reallocs and copies array to larger capacity capacity = achl->capacity*2 + 16; - if (freestackp < stacksize-1) { - freestack[freestackp++] = other_items; + if (acht->freestackp < stacksize-1) { + acht->freestack[acht->freestackp++] = other_items; } - const int mempool_size = ((acht->rows + rows-row) * 2 * colors / (acht->rows + row + 1) + 32*capacity) * sizeof(struct acolorhist_arr_item); + const size_t mempool_size = ((acht->rows + rows-row) * 2 * acht->colors / (acht->rows + row + 1) + 32*capacity) * sizeof(struct acolorhist_arr_item); new_items = mempool_alloc(&acht->mempool, sizeof(struct acolorhist_arr_item)*capacity, mempool_size); if (!new_items) return false; memcpy(new_items, other_items, sizeof(other_items[0])*achl->capacity); @@ -136,34 +145,25 @@ LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba achl->inline2.color.l = px.l; achl->inline2.perceptual_weight = boost; achl->used = 2; - ++colors; + ++acht->colors; } } else { achl->inline1.color.l = px.l; achl->inline1.perceptual_weight = boost; achl->used = 1; - ++colors; + ++acht->colors; } - - continue_outer_loop:; - } - - } - acht->colors = colors; - acht->cols = cols; - acht->rows += rows; - acht->freestackp = freestackp; return true; } LIQ_PRIVATE struct acolorhash_table *pam_allocacolorhash(unsigned int maxcolors, unsigned int surface, unsigned int ignorebits, void* (*malloc)(size_t), void (*free)(void*)) { - const unsigned int estimated_colors = MIN(maxcolors, surface/(ignorebits + (surface > 512*512 ? 5 : 4))); - const unsigned int hash_size = estimated_colors < 66000 ? 6673 : (estimated_colors < 200000 ? 12011 : 24019); + const size_t estimated_colors = MIN(maxcolors, surface/(ignorebits + (surface > 512*512 ? 6 : 5))); + const size_t hash_size = estimated_colors < 66000 ? 6673 : (estimated_colors < 200000 ? 12011 : 24019); - mempool m = NULL; - const unsigned int buckets_size = hash_size * sizeof(struct acolorhist_arr_head); - const unsigned int mempool_size = sizeof(struct acolorhash_table) + buckets_size + estimated_colors * sizeof(struct acolorhist_arr_item); + mempoolptr m = NULL; + const size_t buckets_size = hash_size * sizeof(struct acolorhist_arr_head); + const size_t mempool_size = sizeof(struct acolorhash_table) + buckets_size + estimated_colors * sizeof(struct acolorhist_arr_item); struct acolorhash_table *t = mempool_create(&m, sizeof(*t) + buckets_size, mempool_size, malloc, free); if (!t) return NULL; *t = (struct acolorhash_table){ @@ -172,14 +172,20 @@ LIQ_PRIVATE struct acolorhash_table *pam_allocacolorhash(unsigned int maxcolors, .maxcolors = maxcolors, .ignorebits = ignorebits, }; - memset(t->buckets, 0, hash_size * sizeof(struct acolorhist_arr_head)); + memset(t->buckets, 0, buckets_size); return t; } -#define PAM_ADD_TO_HIST(entry) { \ - hist->achv[j].acolor = to_f(gamma_lut, entry.color.rgba); \ - total_weight += hist->achv[j].adjusted_weight = hist->achv[j].perceptual_weight = MIN(entry.perceptual_weight, max_perceptual_weight); \ - ++j; \ +ALWAYS_INLINE static float pam_add_to_hist(const float *gamma_lut, hist_item *achv, unsigned int *j, const struct acolorhist_arr_item *entry, const float max_perceptual_weight) +{ + if (entry->perceptual_weight == 0) { + return 0; + } + const float w = MIN(entry->perceptual_weight/128.f, max_perceptual_weight); + achv[*j].adjusted_weight = achv[*j].perceptual_weight = w; + achv[*j].acolor = rgba_to_f(gamma_lut, entry->color.rgba); + *j += 1; + return w; } LIQ_PRIVATE histogram *pam_acolorhashtoacolorhist(const struct acolorhash_table *acht, const double gamma, void* (*malloc)(size_t), void (*free)(void*)) @@ -187,7 +193,7 @@ LIQ_PRIVATE histogram *pam_acolorhashtoacolorhist(const struct acolorhash_table histogram *hist = malloc(sizeof(hist[0])); if (!hist || !acht) return NULL; *hist = (histogram){ - .achv = malloc(acht->colors * sizeof(hist->achv[0])), + .achv = malloc(MAX(1,acht->colors) * sizeof(hist->achv[0])), .size = acht->colors, .free = free, .ignorebits = acht->ignorebits, @@ -202,29 +208,36 @@ LIQ_PRIVATE histogram *pam_acolorhashtoacolorhist(const struct acolorhash_table float max_perceptual_weight = 0.1f * acht->cols * acht->rows; double total_weight = 0; - for(unsigned int j=0, i=0; i < acht->hash_size; ++i) { + unsigned int j=0; + for(unsigned int i=0; i < acht->hash_size; ++i) { const struct acolorhist_arr_head *const achl = &acht->buckets[i]; if (achl->used) { - PAM_ADD_TO_HIST(achl->inline1); + total_weight += pam_add_to_hist(gamma_lut, hist->achv, &j, &achl->inline1, max_perceptual_weight); if (achl->used > 1) { - PAM_ADD_TO_HIST(achl->inline2); + total_weight += pam_add_to_hist(gamma_lut, hist->achv, &j, &achl->inline2, max_perceptual_weight); for(unsigned int k=0; k < achl->used-2; k++) { - PAM_ADD_TO_HIST(achl->other_items[k]); + total_weight += pam_add_to_hist(gamma_lut, hist->achv, &j, &achl->other_items[k], max_perceptual_weight); } } } } - + hist->size = j; hist->total_perceptual_weight = total_weight; + if (!j) { + pam_freeacolorhist(hist); + return NULL; + } return hist; } LIQ_PRIVATE void pam_freeacolorhash(struct acolorhash_table *acht) { - mempool_destroy(acht->mempool); + if (acht) { + mempool_destroy(acht->mempool); + } } LIQ_PRIVATE void pam_freeacolorhist(histogram *hist) @@ -244,7 +257,6 @@ LIQ_PRIVATE colormap *pam_colormap(unsigned int colors, void* (*malloc)(size_t), *map = (colormap){ .malloc = malloc, .free = free, - .subset_palette = NULL, .colors = colors, }; memset(map->palette, 0, colors_size); @@ -257,15 +269,11 @@ LIQ_PRIVATE colormap *pam_duplicate_colormap(colormap *map) for(unsigned int i=0; i < map->colors; i++) { dupe->palette[i] = map->palette[i]; } - if (map->subset_palette) { - dupe->subset_palette = pam_duplicate_colormap(map->subset_palette); - } return dupe; } LIQ_PRIVATE void pam_freecolormap(colormap *c) { - if (c->subset_palette) pam_freecolormap(c->subset_palette); c->free(c); } diff --git a/pngquant/pam.h b/pngquant/pam.h index 835f852..5a7d50e 100644 --- a/pngquant/pam.h +++ b/pngquant/pam.h @@ -16,6 +16,12 @@ #ifndef PAM_H #define PAM_H +// accidental debug assertions make color search much slower, +// so force assertions off if there's no explicit setting +#if !defined(NDEBUG) && !defined(DEBUG) +#define NDEBUG +#endif + #include #include #include @@ -29,7 +35,7 @@ #define MAX_DIFF 1e20 #ifndef USE_SSE -# if defined(__SSE__) && (defined(WIN32) || defined(__WIN32__)) +# if defined(__SSE__) && (defined(__amd64__) || defined(__X86_64__) || defined(_WIN64) || defined(WIN32) || defined(__WIN32__)) # define USE_SSE 1 # else # define USE_SSE 0 @@ -62,6 +68,12 @@ # define SSE_ALIGN #endif +#ifndef _MSC_VER +#define LIQ_ARRAY(type, var, count) type var[count] +#else +#define LIQ_ARRAY(type, var, count) type* var = (type*)_alloca(sizeof(type)*(count)) +#endif + #if defined(__GNUC__) || defined (__llvm__) #define ALWAYS_INLINE __attribute__((always_inline)) inline #define NEVER_INLINE __attribute__ ((noinline)) @@ -85,7 +97,7 @@ typedef struct { float a, r, g, b; } SSE_ALIGN f_pixel; -static const double internal_gamma = 0.5499; +static const float internal_gamma = 0.5499f; LIQ_PRIVATE void to_f_set_gamma(float gamma_lut[], const double gamma); @@ -93,8 +105,8 @@ LIQ_PRIVATE void to_f_set_gamma(float gamma_lut[], const double gamma); Converts 8-bit color to internal gamma and premultiplied alpha. (premultiplied color space is much better for blending of semitransparent colors) */ -ALWAYS_INLINE static f_pixel to_f(const float gamma_lut[], const rgba_pixel px); -inline static f_pixel to_f(const float gamma_lut[], const rgba_pixel px) +ALWAYS_INLINE static f_pixel rgba_to_f(const float gamma_lut[], const rgba_pixel px); +inline static f_pixel rgba_to_f(const float gamma_lut[], const rgba_pixel px) { float a = px.a/255.f; @@ -106,7 +118,7 @@ inline static f_pixel to_f(const float gamma_lut[], const rgba_pixel px) }; } -inline static rgba_pixel to_rgb(const float gamma, const f_pixel px) +inline static rgba_pixel f_to_rgb(const float gamma, const f_pixel px) { if (px.a < 1.f/256.f) { return (rgba_pixel){0,0,0,0}; @@ -141,7 +153,7 @@ inline static double colordifference_ch(const double x, const double y, const do // maximum of channel blended on white, and blended on black // premultiplied alpha and backgrounds 0/1 shorten the formula const double black = x-y, white = black+alphas; - return black*black + white*white; + return MAX(black*black, white*white); } ALWAYS_INLINE static float colordifference_stdc(const f_pixel px, const f_pixel py); @@ -166,23 +178,6 @@ inline static float colordifference_stdc(const f_pixel px, const f_pixel py) colordifference_ch(px.b, py.b, alphas); } -ALWAYS_INLINE static double min_colordifference_ch(const double x, const double y, const double alphas); -inline static double min_colordifference_ch(const double x, const double y, const double alphas) -{ - const double black = x-y, white = black+alphas; - return MIN(black*black , white*white) * 2.f; -} - -/* least possible difference between colors (difference varies depending on background they're blended on) */ -ALWAYS_INLINE static float min_colordifference(const f_pixel px, const f_pixel py); -inline static float min_colordifference(const f_pixel px, const f_pixel py) -{ - const double alphas = py.a-px.a; - return min_colordifference_ch(px.r, py.r, alphas) + - min_colordifference_ch(px.g, py.g, alphas) + - min_colordifference_ch(px.b, py.b, alphas); -} - ALWAYS_INLINE static float colordifference(f_pixel px, f_pixel py); inline static float colordifference(f_pixel px, f_pixel py) { @@ -199,7 +194,7 @@ inline static float colordifference(f_pixel px, f_pixel py) onblack = _mm_mul_ps(onblack, onblack); onwhite = _mm_mul_ps(onwhite, onwhite); - const __m128 max = _mm_add_ps(onwhite, onblack); + const __m128 max = _mm_max_ps(onwhite, onblack); // add rgb, not a const __m128 maxhl = _mm_movehl_ps(max, max); @@ -243,27 +238,24 @@ typedef struct { typedef struct { f_pixel acolor; float popularity; + bool fixed; // if true it's user-supplied and must not be changed (e.g in K-Means iteration) } colormap_item; typedef struct colormap { unsigned int colors; void* (*malloc)(size_t); void (*free)(void*); - struct colormap *subset_palette; colormap_item palette[]; } colormap; struct acolorhist_arr_item { union rgba_as_int color; - float perceptual_weight; + unsigned int perceptual_weight; }; struct acolorhist_arr_head { + struct acolorhist_arr_item inline1, inline2; unsigned int used, capacity; - struct { - union rgba_as_int color; - float perceptual_weight; - } inline1, inline2; struct acolorhist_arr_item *other_items; }; @@ -280,6 +272,7 @@ LIQ_PRIVATE void pam_freeacolorhash(struct acolorhash_table *acht); LIQ_PRIVATE struct acolorhash_table *pam_allocacolorhash(unsigned int maxcolors, unsigned int surface, unsigned int ignorebits, void* (*malloc)(size_t), void (*free)(void*)); LIQ_PRIVATE histogram *pam_acolorhashtoacolorhist(const struct acolorhash_table *acht, const double gamma, void* (*malloc)(size_t), void (*free)(void*)); LIQ_PRIVATE bool pam_computeacolorhash(struct acolorhash_table *acht, const rgba_pixel *const pixels[], unsigned int cols, unsigned int rows, const unsigned char *importance_map); +LIQ_PRIVATE bool pam_add_to_hash(struct acolorhash_table *acht, unsigned int hash, unsigned int boost, union rgba_as_int px, unsigned int row, unsigned int rows); LIQ_PRIVATE void pam_freeacolorhist(histogram *h); diff --git a/pngquant/pom.xml b/pngquant/pom.xml new file mode 100644 index 0000000..a1fc73d --- /dev/null +++ b/pngquant/pom.xml @@ -0,0 +1,87 @@ + + 4.0.0 + org.pngquant + libimagequant + jar + 2.1.1 + pngquant + http://pngquant.org + + . + + + org.codehaus.mojo + exec-maven-plugin + 1.1 + + + build + compile + exec + + make + + -j8 + USE_SSE=1 + java + + + + + clean + clean + exec + + make + + clean + + + + + + + + + + mac-x64 + + + Mac + x64 + + + + + org.pngquant + libimagequant-jni + 1 + jnilib + mac-x64 + + + + + linux-x64 + + + unix + Linux + x64 + + + + + org.pngquant + libimagequant-jni + so + 1 + linux-x64 + + + + + + + diff --git a/pngquant/rust/build.rs b/pngquant/rust/build.rs new file mode 100644 index 0000000..9efe9fc --- /dev/null +++ b/pngquant/rust/build.rs @@ -0,0 +1,63 @@ +//! This is a build script for Cargo https://crates.io/ +//! It produces a static library that can be used by C or Rust. + +extern crate cc; + +use std::env; +use std::path::PathBuf; +use std::fs::canonicalize; + +fn main() { + let mut cc = cc::Build::new(); + let compiler = cc.get_compiler(); + cc.warnings(false); + + if env::var("PROFILE").map(|p|p != "debug").unwrap_or(true) { + cc.define("NDEBUG", Some("1")); + } else { + cc.define("DEBUG", Some("1")); + } + + if cfg!(feature = "openmp") { + cc.flag(&env::var("DEP_OPENMP_FLAG").unwrap()); + } + + let target_arch = env::var("CARGO_CFG_TARGET_ARCH").expect("Needs CARGO_CFG_TARGET_ARCH"); + if target_arch =="x86_64" || + (target_arch == "x86" && cfg!(feature = "sse")) { + cc.flag(if compiler.is_like_msvc() {"/arch:SSE2"} else {"-msse"}); + cc.define("USE_SSE", Some("1")); + } + + let outdated_c_compiler = env::var("TARGET").unwrap().contains("windows-msvc"); + let has_msvc_files = PathBuf::from("msvc-dist/libimagequant.c").exists(); + + if outdated_c_compiler && has_msvc_files { + println!("cargo:include={}", canonicalize("msvc-dist").unwrap().display()); + cc.file("msvc-dist/libimagequant.c") + .file("msvc-dist/nearest.c") + .file("msvc-dist/kmeans.c") + .file("msvc-dist/mediancut.c") + .file("msvc-dist/mempool.c") + .file("msvc-dist/pam.c") + .file("msvc-dist/blur.c"); + } else { + // This is so that I don't forget to publish MSVC version as well + if !has_msvc_files { + println!("cargo:warning=msvc-dist/ directory not present. MSVC builds may fail"); + } + println!("cargo:include={}", canonicalize(".").unwrap().display()); + if !compiler.is_like_msvc() { + cc.flag("-std=c99"); + } + cc.file("libimagequant.c") + .file("nearest.c") + .file("kmeans.c") + .file("mediancut.c") + .file("mempool.c") + .file("pam.c") + .file("blur.c"); + } + + cc.compile("libimagequant.a"); +} diff --git a/pngquant/rust/libimagequant.rs b/pngquant/rust/libimagequant.rs new file mode 100644 index 0000000..80dba0f --- /dev/null +++ b/pngquant/rust/libimagequant.rs @@ -0,0 +1,307 @@ +//! Small, portable C library for high-quality conversion of RGBA images to 8-bit indexed-color (palette) images. +//! It's powering [pngquant2](https://pngquant.org). +//! +//! This is a low-level crate exposing a C API. If you're looking for a Rust library, see [imagequant](https://crates.io/crates/imagequant). +//! +//! ## License +//! +//! Libimagequant is dual-licensed: +//! +//! * For Free/Libre Open Source Software it's available under [GPL v3 or later](https://raw.github.com/ImageOptim/libimagequant/master/COPYRIGHT) with additional copyright notices for older parts of the code. +//! +//! * For use in non-GPL software (e.g. closed-source or App Store distribution) please ask kornel@pngquant.org for a commercial license. +//! +//! ## Overview +//! +//! The basic flow is: +//! +//! 1. Create attributes object and configure the library. +//! 2. Create image object from RGBA pixels or data source. +//! 3. Perform quantization (generate palette). +//! 4. Store remapped image and final palette. +//! 5. Free memory. +//! +//! Please note that libimagequant only handles raw uncompressed arrays of pixels in memory and is completely independent of any file format. +//! +//! There are 3 ways to create image object for quantization: +//! +//! * `liq_image_create_rgba()` for simple, contiguous RGBA pixel arrays (width×height×4 bytes large bitmap). +//! * `liq_image_create_rgba_rows()` for non-contiguous RGBA pixel arrays (that have padding between rows or reverse order, e.g. BMP). +//! * `liq_image_create_custom()` for RGB, ABGR, YUV and all other formats that can be converted on-the-fly to RGBA (you have to supply the conversion function). +//! +//! Note that "image" here means raw uncompressed pixels. If you have a compressed image file, such as PNG, you must use another library (e.g. lodepng) to decode it first. + +#![allow(non_camel_case_types)] + +#[cfg(feature = "openmp")] +extern crate openmp_sys; + +use std::os::raw::{c_int, c_uint, c_char, c_void}; +use std::error; +use std::fmt; +use std::error::Error; + +pub enum liq_attr {} +pub enum liq_image {} +pub enum liq_result {} +pub enum liq_histogram {} +pub type liq_color = rgb::RGBA8; + +#[repr(C)] +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum liq_error { + LIQ_OK = 0, + LIQ_QUALITY_TOO_LOW = 99, + LIQ_VALUE_OUT_OF_RANGE = 100, + LIQ_OUT_OF_MEMORY, + LIQ_ABORTED, + LIQ_BITMAP_NOT_AVAILABLE, + LIQ_BUFFER_TOO_SMALL, + LIQ_INVALID_POINTER, + LIQ_UNSUPPORTED, +} + +#[repr(C)] +#[derive(Copy, Clone)] +pub enum liq_ownership { + LIQ_OWN_ROWS = 4, + LIQ_OWN_PIXELS = 8, + LIQ_COPY_PIXELS = 16, +} + +#[repr(C)] +pub struct liq_palette { + pub count: c_int, + pub entries: [liq_color; 256], +} + +#[repr(C)] +#[derive(Debug, Copy, Clone)] +pub struct liq_histogram_entry { + pub color: liq_color, + pub count: c_uint, +} + +impl error::Error for liq_error { + fn description(&self) -> &str { + match *self { + liq_error::LIQ_OK => "OK", + liq_error::LIQ_QUALITY_TOO_LOW => "LIQ_QUALITY_TOO_LOW", + liq_error::LIQ_VALUE_OUT_OF_RANGE => "VALUE_OUT_OF_RANGE", + liq_error::LIQ_OUT_OF_MEMORY => "OUT_OF_MEMORY", + liq_error::LIQ_ABORTED => "LIQ_ABORTED", + liq_error::LIQ_BITMAP_NOT_AVAILABLE => "BITMAP_NOT_AVAILABLE", + liq_error::LIQ_BUFFER_TOO_SMALL => "BUFFER_TOO_SMALL", + liq_error::LIQ_INVALID_POINTER => "INVALID_POINTER", + liq_error::LIQ_UNSUPPORTED => "LIQ_UNSUPPORTED", + } + } +} + +impl fmt::Display for liq_error { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", self.description()) + } +} + +impl liq_error { + #[inline] + pub fn is_ok(&self) -> bool { + *self == liq_error::LIQ_OK + } + + pub fn is_err(&self) -> bool { + !self.is_ok() + } + + #[inline] + pub fn ok(&self) -> Result<(), liq_error> { + match *self { + liq_error::LIQ_OK => Ok(()), + e => Err(e), + } + } + + #[inline] + pub fn ok_or(self, err: E) -> Result<(), E> { + if self.is_ok() { + Ok(()) + } else { + Err(err) + } + } + + pub fn unwrap(&self) { + assert!(self.is_ok(), "{}", self); + } + + pub fn expect(&self, msg: &str) { + assert!(self.is_ok(), "{}", msg); + } +} + +pub type liq_log_callback_function = Option; +pub type liq_log_flush_callback_function = Option; +pub type liq_progress_callback_function = Option c_int>; +pub type liq_image_get_rgba_row_callback = unsafe extern "C" fn(row_out: *mut liq_color, row: c_int, width: c_int, user_info: *mut c_void); + +#[link(name="imagequant", kind="static")] +extern "C" { + + /// Returns object that will hold initial settings (attributes) for the library. + /// + /// The object should be freed using `liq_attr_destroy()` after it's no longer needed. + /// Returns `NULL` in the unlikely case that the library cannot run on the current machine (e.g. the library has been compiled for SSE-capable x86 CPU and run on VIA C3 CPU). + pub fn liq_attr_create() -> *mut liq_attr; + pub fn liq_attr_copy(orig: &liq_attr) -> *mut liq_attr; + pub fn liq_attr_destroy(attr: &mut liq_attr); + + /// Specifies maximum number of colors to use. + /// + /// The default is 256. Instead of setting a fixed limit it's better to use `liq_set_quality()`. + /// The first argument is attributes object from `liq_attr_create()`. + /// Returns `LIQ_VALUE_OUT_OF_RANGE` if number of colors is outside the range 2-256. + pub fn liq_set_max_colors(attr: &mut liq_attr, colors: c_int) -> liq_error; + pub fn liq_get_max_colors(attr: &liq_attr) -> c_int; + pub fn liq_set_speed(attr: &mut liq_attr, speed: c_int) -> liq_error; + pub fn liq_get_speed(attr: &liq_attr) -> c_int; + pub fn liq_set_min_posterization(attr: &mut liq_attr, bits: c_int) -> liq_error; + pub fn liq_get_min_posterization(attr: &liq_attr) -> c_int; + /// Quality is in range `0` (worst) to `100` (best) and values are analoguous to JPEG quality (i.e. `80` is usually good enough). + /// + /// Quantization will attempt to use the lowest number of colors needed to achieve `maximum` quality. `maximum` value of `100` is the default and means conversion as good as possible. + /// If it's not possible to convert the image with at least `minimum` quality (i.e. 256 colors is not enough to meet the minimum quality), then `liq_image_quantize()` will fail. The default minumum is `0` (proceeds regardless of quality). + /// Quality measures how well the generated palette fits image given to `liq_image_quantize()`. If a different image is remapped with `liq_write_remapped_image()` then actual quality may be different. + /// Regardless of the quality settings the number of colors won't exceed the maximum (see `liq_set_max_colors()`). + /// The first argument is attributes object from `liq_attr_create()`. + /// + /// Returns `LIQ_VALUE_OUT_OF_RANGE` if target is lower than minimum or any of them is outside the 0-100 range. + /// Returns `LIQ_INVALID_POINTER` if `attr` appears to be invalid. + pub fn liq_set_quality(attr: &mut liq_attr, minimum: c_int, maximum: c_int) -> liq_error; + pub fn liq_get_min_quality(attr: &liq_attr) -> c_int; + pub fn liq_get_max_quality(attr: &liq_attr) -> c_int; + pub fn liq_set_last_index_transparent(attr: &mut liq_attr, is_last: c_int); + + pub fn liq_image_create_rgba_rows(attr: &liq_attr, rows: *const *const u8, width: c_int, height: c_int, gamma: f64) -> *mut liq_image; + /// Creates an object that represents the image pixels to be used for quantization and remapping. + /// + /// The pixel array must be contiguous run of RGBA pixels (alpha is the last component, 0 = transparent, 255 = opaque). + /// + /// The first argument is attributes object from `liq_attr_create()`. The same `attr` object should be used for the entire process, from creation of images to quantization. + /// + /// The `pixels` array must not be modified or freed until this object is freed with `liq_image_destroy()`. See also `liq_image_set_memory_ownership()`. + /// + /// `width` and `height` are dimensions in pixels. An image 10x10 pixel large will need a 400-byte array. + /// + /// `gamma` can be `0` for images with the typical 1/2.2 [gamma](https://en.wikipedia.org/wiki/Gamma_correction). + /// Otherwise `gamma` must be > 0 and < 1, e.g. `0.45455` (1/2.2) or `0.55555` (1/1.8). Generated palette will use the same gamma unless `liq_set_output_gamma()` is used. If `liq_set_output_gamma` is not used, then it only affects whether brighter or darker areas of the image will get more palette colors allocated. + /// + /// Returns `NULL` on failure, e.g. if `pixels` is `NULL` or `width`/`height` is <= 0. + pub fn liq_image_create_rgba(attr: &liq_attr, bitmap: *const u8, width: c_int, height: c_int, gamma: f64) -> *mut liq_image; + /// unsafe: It will crash if the owned memory wasn't allocated using `libc::malloc()` (or whatever allocator C side is using) + pub fn liq_image_set_memory_ownership(image: &liq_image, own: liq_ownership) -> liq_error; + + pub fn liq_set_log_callback(arg1: &mut liq_attr, arg2: liq_log_callback_function, user_info: *mut c_void); + pub fn liq_set_log_flush_callback(arg1: &mut liq_attr, arg2: liq_log_flush_callback_function, user_info: *mut c_void); + pub fn liq_attr_set_progress_callback(arg1: &mut liq_attr, arg2: liq_progress_callback_function, user_info: *mut c_void); + pub fn liq_result_set_progress_callback(arg1: &mut liq_result, arg2: liq_progress_callback_function, user_info: *mut c_void); + pub fn liq_image_create_custom(attr: &liq_attr, row_callback: liq_image_get_rgba_row_callback, user_info: *mut c_void, width: c_int, height: c_int, gamma: f64) -> *mut liq_image; + /// Remap assuming the image will be always presented exactly on top of this background. + /// + /// Takes ownership of the background image (i.e. do NOT use it afterwards, do NOT call liq_image_destroy on it). + /// + /// The background must have the same size. The foreground image must have a transparent color. + pub fn liq_image_set_background(img: &mut liq_image, background: *mut liq_image) -> liq_error; + pub fn liq_image_set_importance_map(img: &mut liq_image, buffer: *mut u8, buffer_size: usize, own: liq_ownership) -> liq_error; + pub fn liq_image_add_fixed_color(img: &mut liq_image, color: liq_color) -> liq_error; + pub fn liq_image_get_width(img: &liq_image) -> c_int; + pub fn liq_image_get_height(img: &liq_image) -> c_int; + pub fn liq_image_destroy(img: &mut liq_image); + + pub fn liq_histogram_create(attr: &liq_attr) -> *mut liq_histogram; + pub fn liq_histogram_add_image(hist: &mut liq_histogram, attr: &liq_attr, image: &mut liq_image) -> liq_error; + pub fn liq_histogram_add_colors(hist: &mut liq_histogram, attr: &liq_attr, entries: *const liq_histogram_entry, num_entries: c_int, gamma: f64) -> liq_error; + pub fn liq_histogram_add_fixed_color(hist: &mut liq_histogram, color: liq_color) -> liq_error; + pub fn liq_histogram_destroy(hist: &mut liq_histogram); + + /// Performs quantization (palette generation) based on settings in `attr` (from `liq_attr_create()`) and pixels of the image. + /// + /// Returns `LIQ_OK` if quantization succeeds and sets `liq_result` pointer in `out_result`. The last argument is used for receiving the `result` object: + /// + /// liq_result *result; + /// if (LIQ_OK == liq_image_quantize(img, attr, &result)) { // Note &result + /// // result pointer is valid here + /// } + /// + /// Returns `LIQ_QUALITY_TOO_LOW` if quantization fails due to limit set in `liq_set_quality()`. + /// + /// See `liq_write_remapped_image()`. + /// + /// If you want to generate one palette for multiple images at once, see `liq_histogram_create()`. + pub fn liq_quantize_image(options: &liq_attr, input_image: &liq_image) -> *mut liq_result; + pub fn liq_histogram_quantize(input_hist: &liq_histogram, options: &liq_attr, result_output: &mut *mut liq_result) -> liq_error; + pub fn liq_image_quantize(input_image: &liq_image, options: &liq_attr, result_output: &mut *mut liq_result) -> liq_error; + /// Enables/disables dithering in `liq_write_remapped_image()`. + /// + /// Dithering level must be between `0` and `1` (inclusive). Dithering level `0` enables fast non-dithered remapping. Otherwise a variation of Floyd-Steinberg error diffusion is used. + /// + /// Precision of the dithering algorithm depends on the speed setting, see `liq_set_speed()`. + /// + /// Returns `LIQ_VALUE_OUT_OF_RANGE` if the dithering level is outside the 0-1 range. + pub fn liq_set_dithering_level(res: &mut liq_result, dither_level: f32) -> liq_error; + pub fn liq_set_output_gamma(res: &mut liq_result, gamma: f64) -> liq_error; + pub fn liq_get_output_gamma(result: &liq_result) -> f64; + /// Returns pointer to palette optimized for image that has been quantized or remapped + /// (final refinements are applied to the palette during remapping). + /// + /// It's valid to call this method before remapping, if you don't plan to remap any images or want to use same palette for multiple images. + /// + /// `liq_palette->count` contains number of colors (up to 256), `liq_palette->entries[n]` contains RGBA value for nth palette color. + pub fn liq_get_palette<'a>(result: &'a mut liq_result) -> &'a liq_palette; + /// Remaps the image to palette and writes its pixels to the given buffer, 1 pixel per byte. + /// + /// The buffer must be large enough to fit the entire image, i.e. width×height bytes large. For safety, pass the size of the buffer as `buffer_size`. + /// + /// For best performance call `liq_get_palette()` *after* this function, as palette is improved during remapping (except when `liq_histogram_quantize()` is used). + /// + /// Returns `LIQ_BUFFER_TOO_SMALL` if given size of the buffer is not enough to fit the entire image. + /// + /// int buffer_size = width*height; + /// char *buffer = malloc(buffer_size); + /// if (LIQ_OK == liq_write_remapped_image(result, input_image, buffer, buffer_size)) { + /// liq_palette *pal = liq_get_palette(result); + /// // save image + /// } + /// + /// See `liq_get_palette()`. + /// + /// The buffer is assumed to be contiguous, with rows ordered from top to bottom, and no gaps between rows. If you need to write rows with padding or upside-down order, then use `liq_write_remapped_image_rows()`. + /// + /// Please note that it only writes raw uncompressed pixels to memory. It does not perform any PNG compression. If you'd like to create a PNG file then you need to pass the raw pixel data to another library, e.g. libpng or lodepng. See `rwpng.c` in `pngquant` project for an example how to do that. + pub fn liq_write_remapped_image(result: &mut liq_result, input_image: &mut liq_image, buffer: *mut u8, buffer_size: usize) -> liq_error; + pub fn liq_write_remapped_image_rows(result: &mut liq_result, input_image: &mut liq_image, row_pointers: *const *mut u8) -> liq_error; + pub fn liq_get_quantization_error(result: &liq_result) -> f64; + pub fn liq_get_quantization_quality(result: &liq_result) -> c_int; + + pub fn liq_result_destroy(res: &mut liq_result); + pub fn liq_get_remapping_error(result: &liq_result) -> f64; + pub fn liq_get_remapping_quality(result: &liq_result) -> c_int; + pub fn liq_version() -> c_int; +} + +#[test] +fn links_and_runs() { + use std::ptr; + unsafe { + assert!(liq_version() >= 20901); + let attr = liq_attr_create(); + assert!(!attr.is_null()); + let hist = liq_histogram_create(&*attr); + assert!(!hist.is_null()); + let mut res = ptr::null_mut(); + liq_histogram_quantize(&*hist, &*attr, &mut res); + assert!(res.is_null()); + liq_histogram_destroy(&mut *hist); + liq_attr_destroy(&mut *attr); + } +} diff --git a/pngquant/viter.c b/pngquant/viter.c deleted file mode 100644 index 109a165..0000000 --- a/pngquant/viter.c +++ /dev/null @@ -1,89 +0,0 @@ - -#include "libimagequant.h" -#include "pam.h" -#include "viter.h" -#include "nearest.h" -#include -#include - -#ifdef _OPENMP -#include -#else -#define omp_get_max_threads() 1 -#define omp_get_thread_num() 0 -#endif - -/* - * Voronoi iteration: new palette color is computed from weighted average of colors that map to that palette entry. - */ -LIQ_PRIVATE void viter_init(const colormap *map, const unsigned int max_threads, viter_state average_color[]) -{ - memset(average_color, 0, sizeof(average_color[0])*(VITER_CACHE_LINE_GAP+map->colors)*max_threads); -} - -LIQ_PRIVATE void viter_update_color(const f_pixel acolor, const float value, const colormap *map, unsigned int match, const unsigned int thread, viter_state average_color[]) -{ - match += thread * (VITER_CACHE_LINE_GAP+map->colors); - average_color[match].a += acolor.a * value; - average_color[match].r += acolor.r * value; - average_color[match].g += acolor.g * value; - average_color[match].b += acolor.b * value; - average_color[match].total += value; -} - -LIQ_PRIVATE void viter_finalize(colormap *map, const unsigned int max_threads, const viter_state average_color[]) -{ - for (unsigned int i=0; i < map->colors; i++) { - double a=0, r=0, g=0, b=0, total=0; - - // Aggregate results from all threads - for(unsigned int t=0; t < max_threads; t++) { - const unsigned int offset = (VITER_CACHE_LINE_GAP+map->colors) * t + i; - - a += average_color[offset].a; - r += average_color[offset].r; - g += average_color[offset].g; - b += average_color[offset].b; - total += average_color[offset].total; - } - - if (total) { - map->palette[i].acolor = (f_pixel){ - .a = a / total, - .r = r / total, - .g = g / total, - .b = b / total, - }; - } - map->palette[i].popularity = total; - } -} - -LIQ_PRIVATE double viter_do_iteration(histogram *hist, colormap *const map, const float min_opaque_val, viter_callback callback, const bool fast_palette) -{ - const unsigned int max_threads = omp_get_max_threads(); - viter_state average_color[(VITER_CACHE_LINE_GAP+map->colors) * max_threads]; - viter_init(map, max_threads, average_color); - struct nearest_map *const n = nearest_init(map, fast_palette); - hist_item *const achv = hist->achv; - const int hist_size = hist->size; - - double total_diff=0; - #pragma omp parallel for if (hist_size > 3000) \ - schedule(static) default(none) shared(average_color,callback) reduction(+:total_diff) - for(int j=0; j < hist_size; j++) { - float diff; - unsigned int match = nearest_search(n, achv[j].acolor, achv[j].tmp.likely_colormap_index, min_opaque_val, &diff); - achv[j].tmp.likely_colormap_index = match; - total_diff += diff * achv[j].perceptual_weight; - - viter_update_color(achv[j].acolor, achv[j].perceptual_weight, map, match, omp_get_thread_num(), average_color); - - if (callback) callback(&achv[j], diff); - } - - nearest_free(n); - viter_finalize(map, max_threads, average_color); - - return total_diff / hist->total_perceptual_weight; -} diff --git a/pngquant/viter.h b/pngquant/viter.h deleted file mode 100644 index c1a5b39..0000000 --- a/pngquant/viter.h +++ /dev/null @@ -1,19 +0,0 @@ - -#ifndef VITER_H -#define VITER_H - -// Spread memory touched by different threads at least 64B apart which I assume is the cache line size. This should avoid memory write contention. -#define VITER_CACHE_LINE_GAP ((64+sizeof(viter_state)-1)/sizeof(viter_state)) - -typedef struct { - double a, r, g, b, total; -} viter_state; - -typedef void (*viter_callback)(hist_item *item, float diff); - -LIQ_PRIVATE void viter_init(const colormap *map, const unsigned int max_threads, viter_state state[]); -LIQ_PRIVATE void viter_update_color(const f_pixel acolor, const float value, const colormap *map, unsigned int match, const unsigned int thread, viter_state average_color[]); -LIQ_PRIVATE void viter_finalize(colormap *map, const unsigned int max_threads, const viter_state state[]); -LIQ_PRIVATE double viter_do_iteration(histogram *hist, colormap *const map, const float min_opaque_val, viter_callback callback, const bool fast_palette); - -#endif