diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + 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. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/FeaturesMain.cpp b/FeaturesMain.cpp new file mode 100755 index 0000000..c01eda8 --- /dev/null +++ b/FeaturesMain.cpp @@ -0,0 +1,102 @@ + +/* + Copyright 2012 Andrew Perrault and Saurav Kumar. + + This file is part of DetectText. + + DetectText 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. + + DetectText 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 DetectText. If not, see . +*/ +#include +#include +#include "TextDetection.h" +#include +#include + +void convertToFloatImage ( IplImage * byteImage, IplImage * floatImage ) +{ + cvConvertScale ( byteImage, floatImage, 1 / 255., 0 ); +} + +class FeatureError : public std::exception +{ +std::string message; +public: +FeatureError ( const std::string & msg, const std::string & file ) +{ + std::stringstream ss; + + ss << msg << " " << file; + message = msg.c_str (); +} +~FeatureError () throw ( ) +{ +} +}; + +IplImage * loadByteImage ( const char * name ) +{ + IplImage * image = cvLoadImage ( name ); + + if ( !image ) + { + return 0; + } + cvCvtColor ( image, image, CV_BGR2RGB ); + return image; +} + +IplImage * loadFloatImage ( const char * name ) +{ + IplImage * image = cvLoadImage ( name ); + + if ( !image ) + { + return 0; + } + cvCvtColor ( image, image, CV_BGR2RGB ); + IplImage * floatingImage = cvCreateImage ( cvGetSize ( image ), + IPL_DEPTH_32F, 3 ); + cvConvertScale ( image, floatingImage, 1 / 255., 0 ); + cvReleaseImage ( &image ); + return floatingImage; +} + +int mainTextDetection ( int argc, char * * argv ) +{ + IplImage * byteQueryImage = loadByteImage ( argv[1] ); + if ( !byteQueryImage ) + { + printf ( "couldn't load query image\n" ); + return -1; + } + + // Detect text in the image + IplImage * output = textDetection ( byteQueryImage, atoi(argv[3]) ); + cvReleaseImage ( &byteQueryImage ); + cvSaveImage ( argv[2], output ); + cvReleaseImage ( &output ); + return 0; +} + +int main ( int argc, char * * argv ) +{ + if ( ( argc != 4 ) ) + { + printf ( "usage: %s imagefile resultImage darkText\n", + argv[0] ); + + return -1; + } + return mainTextDetection ( argc, argv ); +} diff --git a/README b/README new file mode 100644 index 0000000..53416a3 --- /dev/null +++ b/README @@ -0,0 +1,23 @@ +DetectText +========== + +Detect text with stroke width transform. + +Dependencies: OpenCV, boost. + +To compile: +g++ -o TextDetection FeaturesMain.cpp TextDetection.cpp -Ipath_to_current_directory +where path_to_current_directory is replaced with the path to the current directory. + +To run: +./TextDetection input_file output_file dark_on_light +where dark_on_light is 1 or 0, indicating whether the text is darker or lighter than the background. + +GitHub repository: +https://github.com/aperrau/DetectText + +A similar implementation can be found here: +https://github.com/mfarre/textdetection + +More details on the algorithm can be found in: +http://www.cs.cornell.edu/courses/cs4670/2010fa/projects/final/results/group_of_arp86_sk2357/Writeup.pdf \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 2b0baf9..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -DetectText -========== - -Detect text with stroke width transform. \ No newline at end of file diff --git a/TextDetection.cpp b/TextDetection.cpp new file mode 100755 index 0000000..5f89ae1 --- /dev/null +++ b/TextDetection.cpp @@ -0,0 +1,1124 @@ +/* + Copyright 2012 Andrew Perrault and Saurav Kumar. + + This file is part of DetectText. + + DetectText 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. + + DetectText 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 DetectText. If not, see . +*/ +#include +#include +#include +#include +#include +#include +#include +/*#include +#include +#include +#include +#include +#include +#include */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define PI 3.14159265 + +std::vector > findBoundingBoxes( std::vector > & components, + std::vector & chains, + std::vector > & compBB, + IplImage * output) { + std::vector > bb; + bb.reserve(chains.size()); + for (std::vector::iterator chainit = chains.begin(); chainit != chains.end(); chainit++) { + int minx = output->width; + int miny = output->height; + int maxx = 0; + int maxy = 0; + for (std::vector::const_iterator cit = chainit->components.begin(); cit != chainit->components.end(); cit++) { + miny = std::min(miny,compBB[*cit].first.y); + minx = std::min(minx,compBB[*cit].first.x); + maxy = std::max(maxy,compBB[*cit].second.y); + maxx = std::max(maxx,compBB[*cit].second.x); + } + CvPoint p0 = cvPoint(minx,miny); + CvPoint p1 = cvPoint(maxx,maxy); + std::pair pair(p0,p1); + bb.push_back(pair); + } + return bb; +} + +std::vector > findBoundingBoxes( std::vector > & components, + IplImage * output) { + std::vector > bb; + bb.reserve(components.size()); + for (std::vector >::iterator compit = components.begin(); compit != components.end(); compit++) { + int minx = output->width; + int miny = output->height; + int maxx = 0; + int maxy = 0; + for (std::vector::iterator it = compit->begin(); it != compit->end(); it++) { + miny = std::min(miny,it->y); + minx = std::min(minx,it->x); + maxy = std::max(maxy,it->y); + maxx = std::max(maxx,it->x); + } + CvPoint p0 = cvPoint(minx,miny); + CvPoint p1 = cvPoint(maxx,maxy); + std::pair pair(p0,p1); + bb.push_back(pair); + } + return bb; +} + +void normalizeImage (IplImage * input, IplImage * output) { + assert ( input->depth == IPL_DEPTH_32F ); + assert ( input->nChannels == 1 ); + assert ( output->depth == IPL_DEPTH_32F ); + assert ( output->nChannels == 1 ); + float maxVal = 0; + float minVal = 1e100; + for( int row = 0; row < input->height; row++ ){ + const float* ptr = (const float*)(input->imageData + row * input->widthStep); + for ( int col = 0; col < input->width; col++ ){ + if (*ptr < 0) { } + else { + maxVal = std::max(*ptr, maxVal); + minVal = std::min(*ptr, minVal); + } + ptr++; + } + } + + float difference = maxVal - minVal; + for( int row = 0; row < input->height; row++ ){ + const float* ptrin = (const float*)(input->imageData + row * input->widthStep);\ + float* ptrout = (float*)(output->imageData + row * output->widthStep);\ + for ( int col = 0; col < input->width; col++ ){ + if (*ptrin < 0) { + *ptrout = 1; + } else { + *ptrout = ((*ptrin) - minVal)/difference; + } + ptrout++; + ptrin++; + } + } +} + +void renderComponents (IplImage * SWTImage, std::vector > & components, IplImage * output) { + for (std::vector >::iterator it = components.begin(); it != components.end();it++) { + for (std::vector::iterator pit = it->begin(); pit != it->end(); pit++) { + CV_IMAGE_ELEM(output, float, pit->y, pit->x) = CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x); + } + } + for( int row = 0; row < output->height; row++ ){ + float* ptr = (float*)(output->imageData + row * output->widthStep); + for ( int col = 0; col < output->width; col++ ){ + if (*ptr == 0) { + *ptr = -1; + } + ptr++; + } + } + float maxVal = 0; + float minVal = 1e100; + for( int row = 0; row < output->height; row++ ){ + const float* ptr = (const float*)(output->imageData + row * output->widthStep); + for ( int col = 0; col < output->width; col++ ){ + if (*ptr == 0) { } + else { + maxVal = std::max(*ptr, maxVal); + minVal = std::min(*ptr, minVal); + } + ptr++; + } + } + float difference = maxVal - minVal; + for( int row = 0; row < output->height; row++ ){ + float* ptr = (float*)(output->imageData + row * output->widthStep);\ + for ( int col = 0; col < output->width; col++ ){ + if (*ptr < 1) { + *ptr = 1; + } else { + *ptr = ((*ptr) - minVal)/difference; + } + ptr++; + } + } + +} + +void renderComponentsWithBoxes (IplImage * SWTImage, std::vector > & components, + std::vector > & compBB, IplImage * output) { + IplImage * outTemp = + cvCreateImage ( cvGetSize ( output ), IPL_DEPTH_32F, 1 ); + + renderComponents(SWTImage,components,outTemp); + std::vector > bb; + bb.reserve(compBB.size()); + for (std::vector >::iterator it=compBB.begin(); it != compBB.end(); it++ ) { + CvPoint p0 = cvPoint(it->first.x,it->first.y); + CvPoint p1 = cvPoint(it->second.x,it->second.y); + std::pair pair(p0,p1); + bb.push_back(pair); + } + + IplImage * out = + cvCreateImage ( cvGetSize ( output ), IPL_DEPTH_8U, 1 ); + cvConvertScale(outTemp, out, 255, 0); + cvCvtColor (out, output, CV_GRAY2RGB); + //cvReleaseImage ( &outTemp ); + //cvReleaseImage ( &out ); + + int count = 0; + for (std::vector >::iterator it= bb.begin(); it != bb.end(); it++) { + CvScalar c; + if (count % 3 == 0) c=cvScalar(255,0,0); + else if (count % 3 == 1) c=cvScalar(0,255,0); + else c=cvScalar(0,0,255); + count++; + cvRectangle(output,it->first,it->second,c,2); + } +} + +void renderChainsWithBoxes (IplImage * SWTImage, + std::vector > & components, + std::vector & chains, + std::vector > & compBB, + IplImage * output) { + // keep track of included components + std::vector included; + included.reserve(components.size()); + for (unsigned int i = 0; i != components.size(); i++) { + included.push_back(false); + } + for (std::vector::iterator it = chains.begin(); it != chains.end();it++) { + for (std::vector::iterator cit = it->components.begin(); cit != it->components.end(); cit++) { + included[*cit] = true; + } + } + std::vector > componentsRed; + for (unsigned int i = 0; i != components.size(); i++ ) { + if (included[i]) { + componentsRed.push_back(components[i]); + } + } + IplImage * outTemp = + cvCreateImage ( cvGetSize ( output ), IPL_DEPTH_32F, 1 ); + + std::cout << componentsRed.size() << " components after chaining" << std::endl; + renderComponents(SWTImage,componentsRed,outTemp); + std::vector > bb; + bb = findBoundingBoxes(components, chains, compBB, outTemp); + + IplImage * out = + cvCreateImage ( cvGetSize ( output ), IPL_DEPTH_8U, 1 ); + cvConvertScale(outTemp, out, 255, 0); + cvCvtColor (out, output, CV_GRAY2RGB); + cvReleaseImage ( &out ); + cvReleaseImage ( &outTemp); + + int count = 0; + for (std::vector >::iterator it= bb.begin(); it != bb.end(); it++) { + CvScalar c; + if (count % 3 == 0) c=cvScalar(255,0,0); + else if (count % 3 == 1) c=cvScalar(0,255,0); + else c=cvScalar(0,0,255); + count++; + cvRectangle(output,it->first,it->second,c,2); + } +} + +void renderChains (IplImage * SWTImage, + std::vector > & components, + std::vector & chains, + IplImage * output) { + // keep track of included components + std::vector included; + included.reserve(components.size()); + for (unsigned int i = 0; i != components.size(); i++) { + included.push_back(false); + } + for (std::vector::iterator it = chains.begin(); it != chains.end();it++) { + for (std::vector::iterator cit = it->components.begin(); cit != it->components.end(); cit++) { + included[*cit] = true; + } + } + std::vector > componentsRed; + for (unsigned int i = 0; i != components.size(); i++ ) { + if (included[i]) { + componentsRed.push_back(components[i]); + } + } + std::cout << componentsRed.size() << " components after chaining" << std::endl; + IplImage * outTemp = + cvCreateImage ( cvGetSize ( output ), IPL_DEPTH_32F, 1 ); + renderComponents(SWTImage,componentsRed,outTemp); + cvConvertScale(outTemp, output, 255, 0); + +} + +IplImage * textDetection (IplImage * input, bool dark_on_light) +{ + assert ( input->depth == IPL_DEPTH_8U ); + assert ( input->nChannels == 3 ); + std::cout << "Running textDetection with dark_on_light " << dark_on_light << std::endl; + // Convert to grayscale + IplImage * grayImage = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_8U, 1 ); + cvCvtColor ( input, grayImage, CV_RGB2GRAY ); + // Create Canny Image + double threshold_low = 175; + double threshold_high = 320; + IplImage * edgeImage = + cvCreateImage( cvGetSize (input),IPL_DEPTH_8U, 1 ); + cvCanny(grayImage, edgeImage, threshold_low, threshold_high, 3) ; + cvSaveImage ( "canny.png", edgeImage); + + // Create gradient X, gradient Y + IplImage * gaussianImage = + cvCreateImage ( cvGetSize(input), IPL_DEPTH_32F, 1); + cvConvertScale (grayImage, gaussianImage, 1./255., 0); + cvSmooth( gaussianImage, gaussianImage, CV_GAUSSIAN, 5, 5); + IplImage * gradientX = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_32F, 1 ); + IplImage * gradientY = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_32F, 1 ); + cvSobel(gaussianImage, gradientX , 1, 0, CV_SCHARR); + cvSobel(gaussianImage, gradientY , 0, 1, CV_SCHARR); + cvSmooth(gradientX, gradientX, 3, 3); + cvSmooth(gradientY, gradientY, 3, 3); + cvReleaseImage ( &gaussianImage ); + cvReleaseImage ( &grayImage ); + + // Calculate SWT and return ray vectors + std::vector rays; + IplImage * SWTImage = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_32F, 1 ); + for( int row = 0; row < input->height; row++ ){ + float* ptr = (float*)(SWTImage->imageData + row * SWTImage->widthStep); + for ( int col = 0; col < input->width; col++ ){ + *ptr++ = -1; + } + } + strokeWidthTransform ( edgeImage, gradientX, gradientY, dark_on_light, SWTImage, rays ); + SWTMedianFilter ( SWTImage, rays ); + + IplImage * output2 = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_32F, 1 ); + normalizeImage (SWTImage, output2); + IplImage * saveSWT = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_8U, 1 ); + cvConvertScale(output2, saveSWT, 255, 0); + cvSaveImage ( "SWT.png", saveSWT); + cvReleaseImage ( &output2 ); + cvReleaseImage( &saveSWT ); + + // Calculate legally connect components from SWT and gradient image. + // return type is a vector of vectors, where each outer vector is a component and + // the inner vector contains the (y,x) of each pixel in that component. + std::vector > components = findLegallyConnectedComponents(SWTImage, rays); + + // Filter the components + std::vector > validComponents; + std::vector > compBB; + std::vector compCenters; + std::vector compMedians; + std::vector compDimensions; + filterComponents(SWTImage, components, validComponents, compCenters, compMedians, compDimensions, compBB ); + + IplImage * output3 = + cvCreateImage ( cvGetSize ( input ), 8U, 3 ); + renderComponentsWithBoxes (SWTImage, validComponents, compBB, output3); + cvSaveImage ( "components.png",output3); + //cvReleaseImage ( &output3 ); + + // Make chains of components + std::vector chains; + chains = makeChains(input, validComponents, compCenters, compMedians, compDimensions, compBB); + + IplImage * output4 = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_8U, 1 ); + renderChains ( SWTImage, validComponents, chains, output4 ); + //cvSaveImage ( "text.png", output4); + + IplImage * output5 = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_8U, 3 ); + cvCvtColor (output4, output5, CV_GRAY2RGB); + cvReleaseImage ( &output4 ); + + /*IplImage * output = + cvCreateImage ( cvGetSize ( input ), IPL_DEPTH_8U, 3 ); + renderChainsWithBoxes ( SWTImage, validComponents, chains, compBB, output); */ + cvReleaseImage ( &gradientX ); + cvReleaseImage ( &gradientY ); + cvReleaseImage ( &SWTImage ); + cvReleaseImage ( &edgeImage ); + return output5; +} + +void strokeWidthTransform (IplImage * edgeImage, + IplImage * gradientX, + IplImage * gradientY, + bool dark_on_light, + IplImage * SWTImage, + std::vector & rays) { + // First pass + float prec = .05; + for( int row = 0; row < edgeImage->height; row++ ){ + const uchar* ptr = (const uchar*)(edgeImage->imageData + row * edgeImage->widthStep); + for ( int col = 0; col < edgeImage->width; col++ ){ + if (*ptr > 0) { + Ray r; + + Point2d p; + p.x = col; + p.y = row; + r.p = p; + std::vector points; + points.push_back(p); + + float curX = (float)col + 0.5; + float curY = (float)row + 0.5; + int curPixX = col; + int curPixY = row; + float G_x = CV_IMAGE_ELEM ( gradientX, float, row, col); + float G_y = CV_IMAGE_ELEM ( gradientY, float, row, col); + // normalize gradient + float mag = sqrt( (G_x * G_x) + (G_y * G_y) ); + if (dark_on_light){ + G_x = -G_x/mag; + G_y = -G_y/mag; + } else { + G_x = G_x/mag; + G_y = G_y/mag; + + } + while (true) { + curX += G_x*prec; + curY += G_y*prec; + if ((int)(floor(curX)) != curPixX || (int)(floor(curY)) != curPixY) { + curPixX = (int)(floor(curX)); + curPixY = (int)(floor(curY)); + // check if pixel is outside boundary of image + if (curPixX < 0 || (curPixX >= SWTImage->width) || curPixY < 0 || (curPixY >= SWTImage->height)) { + break; + } + Point2d pnew; + pnew.x = curPixX; + pnew.y = curPixY; + points.push_back(pnew); + + if (CV_IMAGE_ELEM ( edgeImage, uchar, curPixY, curPixX) > 0) { + r.q = pnew; + // dot product + float G_xt = CV_IMAGE_ELEM(gradientX,float,curPixY,curPixX); + float G_yt = CV_IMAGE_ELEM(gradientY,float,curPixY,curPixX); + mag = sqrt( (G_xt * G_xt) + (G_yt * G_yt) ); + if (dark_on_light){ + G_xt = -G_xt/mag; + G_yt = -G_yt/mag; + } else { + G_xt = G_xt/mag; + G_yt = G_yt/mag; + + } + + if (acos(G_x * -G_xt + G_y * -G_yt) < PI/2.0 ) { + float length = sqrt( ((float)r.q.x - (float)r.p.x)*((float)r.q.x - (float)r.p.x) + ((float)r.q.y - (float)r.p.y)*((float)r.q.y - (float)r.p.y)); + for (std::vector::iterator pit = points.begin(); pit != points.end(); pit++) { + if (CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x) < 0) { + CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x) = length; + } else { + CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x) = std::min(length, CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x)); + } + } + r.points = points; + rays.push_back(r); + } + break; + } + } + } + } + ptr++; + } + } + +} + +void SWTMedianFilter (IplImage * SWTImage, + std::vector & rays) { + for (std::vector::iterator rit = rays.begin(); rit != rays.end(); rit++) { + for (std::vector::iterator pit = rit->points.begin(); pit != rit->points.end(); pit++) { + pit->SWT = CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x); + } + std::sort(rit->points.begin(), rit->points.end(), &Point2dSort); + float median = (rit->points[rit->points.size()/2]).SWT; + for (std::vector::iterator pit = rit->points.begin(); pit != rit->points.end(); pit++) { + CV_IMAGE_ELEM(SWTImage, float, pit->y, pit->x) = std::min(pit->SWT, median); + } + } + +} + +bool Point2dSort (const Point2d &lhs, const Point2d &rhs) { + return lhs.SWT < rhs.SWT; +} + +std::vector< std::vector > +findLegallyConnectedComponents (IplImage * SWTImage, + std::vector & rays) +{ + boost::unordered_map map; + boost::unordered_map revmap; + + typedef boost::adjacency_list Graph; + int num_vertices = 0; + // Number vertices for graph. Associate each point with number + for( int row = 0; row < SWTImage->height; row++ ){ + float * ptr = (float*)(SWTImage->imageData + row * SWTImage->widthStep); + for (int col = 0; col < SWTImage->width; col++ ){ + if (*ptr > 0) { + map[row * SWTImage->width + col] = num_vertices; + Point2d p; + p.x = col; + p.y = row; + revmap[num_vertices] = p; + num_vertices++; + } + ptr++; + } + } + + Graph g(num_vertices); + + for( int row = 0; row < SWTImage->height; row++ ){ + float * ptr = (float*)(SWTImage->imageData + row * SWTImage->widthStep); + for (int col = 0; col < SWTImage->width; col++ ){ + if (*ptr > 0) { + // check pixel to the right, right-down, down, left-down + int this_pixel = map[row * SWTImage->width + col]; + if (col+1 < SWTImage->width) { + float right = CV_IMAGE_ELEM(SWTImage, float, row, col+1); + if (right > 0 && ((*ptr)/right <= 3.0 || right/(*ptr) <= 3.0)) + boost::add_edge(this_pixel, map.at(row * SWTImage->width + col + 1), g); + } + if (row+1 < SWTImage->height) { + if (col+1 < SWTImage->width) { + float right_down = CV_IMAGE_ELEM(SWTImage, float, row+1, col+1); + if (right_down > 0 && ((*ptr)/right_down <= 3.0 || right_down/(*ptr) <= 3.0)) + boost::add_edge(this_pixel, map.at((row+1) * SWTImage->width + col + 1), g); + } + float down = CV_IMAGE_ELEM(SWTImage, float, row+1, col); + if (down > 0 && ((*ptr)/down <= 3.0 || down/(*ptr) <= 3.0)) + boost::add_edge(this_pixel, map.at((row+1) * SWTImage->width + col), g); + if (col-1 >= 0) { + float left_down = CV_IMAGE_ELEM(SWTImage, float, row+1, col-1); + if (left_down > 0 && ((*ptr)/left_down <= 3.0 || left_down/(*ptr) <= 3.0)) + boost::add_edge(this_pixel, map.at((row+1) * SWTImage->width + col - 1), g); + } + } + } + ptr++; + } + } + + std::vector c(num_vertices); + + int num_comp = connected_components(g, &c[0]); + + std::vector > components; + components.reserve(num_comp); + std::cout << "Before filtering, " << num_comp << " components and " << num_vertices << " vertices" << std::endl; + for (int j = 0; j < num_comp; j++) { + std::vector tmp; + components.push_back( tmp ); + } + for (int j = 0; j < num_vertices; j++) { + Point2d p = revmap[j]; + (components[c[j]]).push_back(p); + } + + return components; +} + +std::vector< std::vector > +findLegallyConnectedComponentsRAY (IplImage * SWTImage, + std::vector & rays) +{ + boost::unordered_map map; + boost::unordered_map revmap; + + typedef boost::adjacency_list Graph; + int num_vertices = 0; + // Number vertices for graph. Associate each point with number + for( int row = 0; row < SWTImage->height; row++ ){ + float * ptr = (float*)(SWTImage->imageData + row * SWTImage->widthStep); + for (int col = 0; col < SWTImage->width; col++ ){ + if (*ptr > 0) { + map[row * SWTImage->width + col] = num_vertices; + Point2d p; + p.x = col; + p.y = row; + revmap[num_vertices] = p; + num_vertices++; + } + ptr++; + } + } + + Graph g(num_vertices); + + // Traverse and add edges to graph + for (std::vector::const_iterator it = rays.begin(); it != rays.end(); it++) { + float lastSW = 0; + int lastRow = 0; + int lastCol = 0; + for (std::vector::const_iterator it2 = it->points.begin(); it2 != it->points.end(); it2++) { + float currentSW = CV_IMAGE_ELEM(SWTImage, float, it2->y, it2->x); + if (lastSW == 0) {} + else if (lastSW/currentSW<=3.0 || currentSW/lastSW<=3.0){ + boost::add_edge(map.at(it2->y * SWTImage->width + it2->x), map.at(lastRow * SWTImage->width + lastCol), g); + } + lastSW = currentSW; + lastRow = it2->y; + lastCol = it2->x; + } + lastSW = 0; + lastRow = 0; + lastCol = 0; + } + + std::vector c(num_vertices); + + int num_comp = connected_components(g, &c[0]); + + std::vector > components; + components.reserve(num_comp); + std::cout << "Before filtering, " << num_comp << " components and " << num_vertices << " vertices" << std::endl; + for (int j = 0; j < num_comp; j++) { + std::vector tmp; + components.push_back( tmp ); + } + for (int j = 0; j < num_vertices; j++) { + Point2d p = revmap[j]; + (components[c[j]]).push_back(p); + } + + return components; +} + +void componentStats(IplImage * SWTImage, + const std::vector & component, + float & mean, float & variance, float & median, + int & minx, int & miny, int & maxx, int & maxy) +{ + std::vector temp; + temp.reserve(component.size()); + mean = 0; + variance = 0; + minx = 1000000; + miny = 1000000; + maxx = 0; + maxy = 0; + for (std::vector::const_iterator it = component.begin(); it != component.end(); it++) { + float t = CV_IMAGE_ELEM(SWTImage, float, it->y, it->x); + mean += t; + temp.push_back(t); + miny = std::min(miny,it->y); + minx = std::min(minx,it->x); + maxy = std::max(maxy,it->y); + maxx = std::max(maxx,it->x); + } + mean = mean / ((float)component.size()); + for (std::vector::const_iterator it = temp.begin(); it != temp.end(); it++) { + variance += (*it - mean) * (*it - mean); + } + variance = variance / ((float)component.size()); + std::sort(temp.begin(),temp.end()); + median = temp[temp.size()/2]; +} + + +void filterComponents(IplImage * SWTImage, + std::vector > & components, + std::vector > & validComponents, + std::vector & compCenters, + std::vector & compMedians, + std::vector & compDimensions, + std::vector > & compBB ) +{ + validComponents.reserve(components.size()); + compCenters.reserve(components.size()); + compMedians.reserve(components.size()); + compDimensions.reserve(components.size()); + // bounding boxes + compBB.reserve(components.size()); + for (std::vector >::iterator it = components.begin(); it != components.end();it++) { + // compute the stroke width mean, variance, median + float mean, variance, median; + int minx, miny, maxx, maxy; + componentStats(SWTImage, (*it), mean, variance, median, minx, miny, maxx, maxy); + + // check if variance is less than half the mean + if (variance > 0.5 * mean) { + continue; + } + + float length = (float)(maxx-minx+1); + float width = (float)(maxy-miny+1); + + // check font height + if (width > 300) { + continue; + } + + float area = length * width; + float rminx = (float)minx; + float rmaxx = (float)maxx; + float rminy = (float)miny; + float rmaxy = (float)maxy; + // compute the rotated bounding box + float increment = 1./36.; + for (float theta = increment * PI; theta 10.) { + continue; + } + + // compute the diameter TODO finish + // compute dense representation of component + std::vector > denseRepr; + denseRepr.reserve(maxx-minx+1); + for (int i = 0; i < maxx-minx+1; i++) { + std::vector tmp; + tmp.reserve(maxy-miny+1); + denseRepr.push_back(tmp); + for (int j = 0; j < maxy-miny+1; j++) {\ + denseRepr[i].push_back(0); + } + } + for (std::vector::iterator pit = it->begin(); pit != it->end(); pit++) { + (denseRepr[pit->x - minx])[pit->y - miny] = 1; + } + // create graph representing components + const int num_nodes = it->size(); + /* + E edges[] = { E(0,2), + E(1,1), E(1,3), E(1,4), + E(2,1), E(2,3), + E(3,4), + E(4,0), E(4,1) }; + + Graph G(edges + sizeof(edges) / sizeof(E), weights, num_nodes); + */ + Point2dFloat center; + center.x = ((float)(maxx+minx))/2.0; + center.y = ((float)(maxy+miny))/2.0; + + Point2d dimensions; + dimensions.x = maxx - minx + 1; + dimensions.y = maxy - miny + 1; + + Point2d bb1; + bb1.x = minx; + bb1.y = miny; + + Point2d bb2; + bb2.x = maxx; + bb2.y = maxy; + std::pair pair(bb1,bb2); + + compBB.push_back(pair); + compDimensions.push_back(dimensions); + compMedians.push_back(median); + compCenters.push_back(center); + validComponents.push_back(*it); + } + std::vector > tempComp; + std::vector tempDim; + std::vector tempMed; + std::vector tempCenters; + std::vector > tempBB; + tempComp.reserve(validComponents.size()); + tempCenters.reserve(validComponents.size()); + tempDim.reserve(validComponents.size()); + tempMed.reserve(validComponents.size()); + tempBB.reserve(validComponents.size()); + for (unsigned int i = 0; i < validComponents.size(); i++) { + int count = 0; + for (unsigned int j = 0; j < validComponents.size(); j++) { + if (i != j) { + if (compBB[i].first.x <= compCenters[j].x && compBB[i].second.x >= compCenters[j].x && + compBB[i].first.y <= compCenters[j].y && compBB[i].second.y >= compCenters[j].y) { + count++; + } + } + } + if (count < 2) { + tempComp.push_back(validComponents[i]); + tempCenters.push_back(compCenters[i]); + tempMed.push_back(compMedians[i]); + tempDim.push_back(compDimensions[i]); + tempBB.push_back(compBB[i]); + } + } + validComponents = tempComp; + compDimensions = tempDim; + compMedians = tempMed; + compCenters = tempCenters; + compBB = tempBB; + + compDimensions.reserve(tempComp.size()); + compMedians.reserve(tempComp.size()); + compCenters.reserve(tempComp.size()); + validComponents.reserve(tempComp.size()); + compBB.reserve(tempComp.size()); + + std::cout << "After filtering " << validComponents.size() << " components" << std::endl; +} + +bool sharesOneEnd( Chain c0, Chain c1) { + if (c0.p == c1.p || c0.p == c1.q || c0.q == c1.q || c0.q == c1.p) { + return true; + } + else { + return false; + } +} + +bool chainSortDist (const Chain &lhs, const Chain &rhs) { + return lhs.dist < rhs.dist; +} + +bool chainSortLength (const Chain &lhs, const Chain &rhs) { + return lhs.components.size() > rhs.components.size(); +} + +std::vector makeChains( IplImage * colorImage, + std::vector > & components, + std::vector & compCenters, + std::vector & compMedians, + std::vector & compDimensions, + std::vector > & compBB) { + assert (compCenters.size() == components.size()); + // make vector of color averages + std::vector colorAverages; + colorAverages.reserve(components.size()); + for (std::vector >::iterator it = components.begin(); it != components.end();it++) { + Point3dFloat mean; + mean.x = 0; + mean.y = 0; + mean.z = 0; + int num_points = 0; + for (std::vector::iterator pit = it->begin(); pit != it->end(); pit++) { + mean.x += (float) CV_IMAGE_ELEM (colorImage, unsigned char, pit->y, (pit->x)*3 ); + mean.y += (float) CV_IMAGE_ELEM (colorImage, unsigned char, pit->y, (pit->x)*3+1 ); + mean.z += (float) CV_IMAGE_ELEM (colorImage, unsigned char, pit->y, (pit->x)*3+2 ); + num_points++; + } + mean.x = mean.x / ((float)num_points); + mean.y = mean.y / ((float)num_points); + mean.z = mean.z / ((float)num_points); + colorAverages.push_back(mean); + } + + // form all eligible pairs and calculate the direction of each + std::vector chains; + for ( unsigned int i = 0; i < components.size() - 1; i++ ) { + for ( unsigned int j = i + 1; j < components.size(); j++ ) { + // TODO add color metric + if ( (compMedians[i]/compMedians[j] <= 2.0 || compMedians[j]/compMedians[i] <= 2.0) && + (compDimensions[i].y/compDimensions[j].y <= 2.0 || compDimensions[j].y/compDimensions[i].y <= 2.0)) { + float dist = (compCenters[i].x - compCenters[j].x) * (compCenters[i].x - compCenters[j].x) + + (compCenters[i].y - compCenters[j].y) * (compCenters[i].y - compCenters[j].y); + float colorDist = (colorAverages[i].x - colorAverages[j].x) * (colorAverages[i].x - colorAverages[j].x) + + (colorAverages[i].y - colorAverages[j].y) * (colorAverages[i].y - colorAverages[j].y) + + (colorAverages[i].z - colorAverages[j].z) * (colorAverages[i].z - colorAverages[j].z); + if (dist < 9*(float)(std::max(std::min(compDimensions[i].x,compDimensions[i].y),std::min(compDimensions[j].x,compDimensions[j].y))) + *(float)(std::max(std::min(compDimensions[i].x,compDimensions[i].y),std::min(compDimensions[j].x,compDimensions[j].y))) + && colorDist < 1600) { + Chain c; + c.p = i; + c.q = j; + std::vector comps; + comps.push_back(c.p); + comps.push_back(c.q); + c.components = comps; + c.dist = dist; + float d_x = (compCenters[i].x - compCenters[j].x); + float d_y = (compCenters[i].y - compCenters[j].y); + /* + float d_x = (compBB[i].first.x - compBB[j].second.x); + float d_y = (compBB[i].second.y - compBB[j].second.y); + */ + float mag = sqrt(d_x*d_x + d_y*d_y); + d_x = d_x / mag; + d_y = d_y / mag; + Point2dFloat dir; + dir.x = d_x; + dir.y = d_y; + c.direction = dir; + chains.push_back(c); + + /*std::cerr << c.p << " " << c.q << std::endl; + std::cerr << c.direction.x << " " << c.direction.y << std::endl; + std::cerr << compCenters[c.p].x << " " << compCenters[c.p].y << std::endl; + std::cerr << compCenters[c.q].x << " " << compCenters[c.q].y << std::endl; + std::cerr << std::endl; + std::cerr << colorDist << std::endl; */ + } + } + } + } + std::cout << chains.size() << " eligible pairs" << std::endl; + std::sort(chains.begin(), chains.end(), &chainSortDist); + + std::cerr << std::endl; + const float strictness = PI/6.0; + //merge chains + int merges = 1; + while (merges > 0) { + for (unsigned int i = 0; i < chains.size(); i++) { + chains[i].merged = false; + } + merges = 0; + std::vector newchains; + for (unsigned int i = 0; i < chains.size(); i++) { + for (unsigned int j = 0; j < chains.size(); j++) { + if (i != j) { + if (!chains[i].merged && !chains[j].merged && sharesOneEnd(chains[i],chains[j])) { + if (chains[i].p == chains[j].p) { + if (acos(chains[i].direction.x * -chains[j].direction.x + chains[i].direction.y * -chains[j].direction.y) < strictness) { + /* if (chains[i].p == chains[i].q || chains[j].p == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].p && chains[i].q == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].q && chains[i].q == chains[j].p) { + std::cout << "CRAZY ERROR" << std::endl; + } + std::cerr << 1 <::iterator it = chains[j].components.begin(); it != chains[j].components.end(); it++) { + chains[i].components.push_back(*it); + } + float d_x = (compCenters[chains[i].p].x - compCenters[chains[i].q].x); + float d_y = (compCenters[chains[i].p].y - compCenters[chains[i].q].y); + chains[i].dist = d_x * d_x + d_y * d_y; + + float mag = sqrt(d_x*d_x + d_y*d_y); + d_x = d_x / mag; + d_y = d_y / mag; + Point2dFloat dir; + dir.x = d_x; + dir.y = d_y; + chains[i].direction = dir; + chains[j].merged = true; + merges++; + /*j=-1; + i=0; + if (i == chains.size() - 1) i=-1; + std::stable_sort(chains.begin(), chains.end(), &chainSortLength);*/ + } + } else if (chains[i].p == chains[j].q) { + if (acos(chains[i].direction.x * chains[j].direction.x + chains[i].direction.y * chains[j].direction.y) < strictness) { +/* + if (chains[i].p == chains[i].q || chains[j].p == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].p && chains[i].q == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].q && chains[i].q == chains[j].p) { + std::cout << "CRAZY ERROR" << std::endl; + } + std::cerr << 2 <::iterator it = chains[j].components.begin(); it != chains[j].components.end(); it++) { + chains[i].components.push_back(*it); + } + float d_x = (compCenters[chains[i].p].x - compCenters[chains[i].q].x); + float d_y = (compCenters[chains[i].p].y - compCenters[chains[i].q].y); + float mag = sqrt(d_x*d_x + d_y*d_y); + chains[i].dist = d_x * d_x + d_y * d_y; + + d_x = d_x / mag; + d_y = d_y / mag; + + Point2dFloat dir; + dir.x = d_x; + dir.y = d_y; + chains[i].direction = dir; + chains[j].merged = true; + merges++; + /*j=-1; + i=0; + if (i == chains.size() - 1) i=-1; + std::stable_sort(chains.begin(), chains.end(), &chainSortLength); */ + } + } else if (chains[i].q == chains[j].p) { + if (acos(chains[i].direction.x * chains[j].direction.x + chains[i].direction.y * chains[j].direction.y) < strictness) { + /* if (chains[i].p == chains[i].q || chains[j].p == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].p && chains[i].q == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].q && chains[i].q == chains[j].p) { + std::cout << "CRAZY ERROR" << std::endl; + } + std::cerr << 3 <::iterator it = chains[j].components.begin(); it != chains[j].components.end(); it++) { + chains[i].components.push_back(*it); + } + float d_x = (compCenters[chains[i].p].x - compCenters[chains[i].q].x); + float d_y = (compCenters[chains[i].p].y - compCenters[chains[i].q].y); + float mag = sqrt(d_x*d_x + d_y*d_y); + chains[i].dist = d_x * d_x + d_y * d_y; + + + d_x = d_x / mag; + d_y = d_y / mag; + Point2dFloat dir; + dir.x = d_x; + dir.y = d_y; + + chains[i].direction = dir; + chains[j].merged = true; + merges++; + /*j=-1; + i=0; + if (i == chains.size() - 1) i=-1; + std::stable_sort(chains.begin(), chains.end(), &chainSortLength); */ + } + } else if (chains[i].q == chains[j].q) { + if (acos(chains[i].direction.x * -chains[j].direction.x + chains[i].direction.y * -chains[j].direction.y) < strictness) { + /* if (chains[i].p == chains[i].q || chains[j].p == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].p && chains[i].q == chains[j].q) { + std::cout << "CRAZY ERROR" << std::endl; + } else if (chains[i].p == chains[j].q && chains[i].q == chains[j].p) { + std::cout << "CRAZY ERROR" << std::endl; + } + std::cerr << 4 <::iterator it = chains[j].components.begin(); it != chains[j].components.end(); it++) { + chains[i].components.push_back(*it); + } + float d_x = (compCenters[chains[i].p].x - compCenters[chains[i].q].x); + float d_y = (compCenters[chains[i].p].y - compCenters[chains[i].q].y); + chains[i].dist = d_x * d_x + d_y * d_y; + + float mag = sqrt(d_x*d_x + d_y*d_y); + d_x = d_x / mag; + d_y = d_y / mag; + Point2dFloat dir; + dir.x = d_x; + dir.y = d_y; + chains[i].direction = dir; + chains[j].merged = true; + merges++; + /*j=-1; + i=0; + if (i == chains.size() - 1) i=-1; + std::stable_sort(chains.begin(), chains.end(), &chainSortLength);*/ + } + } + } + } + } + } + for (unsigned int i = 0; i < chains.size(); i++) { + if (!chains[i].merged) { + newchains.push_back(chains[i]); + } + } + chains = newchains; + std::stable_sort(chains.begin(), chains.end(), &chainSortLength); + } + + std::vector newchains; + newchains.reserve(chains.size()); + for (std::vector::iterator cit = chains.begin(); cit != chains.end(); cit++) { + if (cit->components.size() >= 3) { + newchains.push_back(*cit); + } + } + chains = newchains; + std::cout << chains.size() << " chains after merging" << std::endl; + return chains; +} diff --git a/TextDetection.h b/TextDetection.h new file mode 100755 index 0000000..3e619fb --- /dev/null +++ b/TextDetection.h @@ -0,0 +1,102 @@ +/* + Copyright 2012 Andrew Perrault and Saurav Kumar. + + This file is part of DetectText. + + DetectText 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. + + DetectText 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 DetectText. If not, see . +*/ +#ifndef TEXTDETECTION_H +#define TEXTDETECTION_H + +#include + +struct Point2d { + int x; + int y; + float SWT; +}; + +struct Point2dFloat { + float x; + float y; +}; + +struct Ray { + Point2d p; + Point2d q; + std::vector points; +}; + +struct Point3dFloat { + float x; + float y; + float z; +}; + + +struct Chain { + int p; + int q; + float dist; + bool merged; + Point2dFloat direction; + std::vector components; +}; + +bool Point2dSort (Point2d const & lhs, + Point2d const & rhs); + +IplImage * textDetection (IplImage * float_input, + bool dark_on_light); + +void strokeWidthTransform (IplImage * edgeImage, + IplImage * gradientX, + IplImage * gradientY, + bool dark_on_light, + IplImage * SWTImage, + std::vector & rays); + +void SWTMedianFilter (IplImage * SWTImage, + std::vector & rays); + +std::vector< std::vector > +findLegallyConnectedComponents (IplImage * SWTImage, + std::vector & rays); + +std::vector< std::vector > +findLegallyConnectedComponentsRAY (IplImage * SWTImage, + std::vector & rays); + +void componentStats(IplImage * SWTImage, + const std::vector & component, + float & mean, float & variance, float & median, + int & minx, int & miny, int & maxx, int & maxy); + +void filterComponents(IplImage * SWTImage, + std::vector > & components, + std::vector > & validComponents, + std::vector & compCenters, + std::vector & compMedians, + std::vector & compDimensions, + std::vector > & compBB ); + +std::vector makeChains( IplImage * colorImage, + std::vector > & components, + std::vector & compCenters, + std::vector & compMedians, + std::vector & compDimensions, + std::vector > & compBB); + +#endif // TEXTDETECTION_H +