diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..733c072 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/README-zh_cn.md b/README-zh_cn.md new file mode 100644 index 0000000..6782216 --- /dev/null +++ b/README-zh_cn.md @@ -0,0 +1,223 @@ +# Air [![Go](https://github.com/air-verse/air/workflows/Go/badge.svg)](https://github.com/air-verse/air/actions?query=workflow%3AGo+branch%3Amaster) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/dcb95264cc504cad9c2a3d8b0795a7f8)](https://www.codacy.com/gh/air-verse/air/dashboard?utm_source=github.com&utm_medium=referral&utm_content=air-verse/air&utm_campaign=Badge_Grade) [![Go Report Card](https://goreportcard.com/badge/github.com/air-verse/air)](https://goreportcard.com/report/github.com/air-verse/air) [![codecov](https://codecov.io/gh/air-verse/air/branch/master/graph/badge.svg)](https://codecov.io/gh/air-verse/air) + +:cloud: 热重载 Go 应用的工具 + +![air](docs/air.png) + +[English](README.md) | 简体中文 + +## 开发动机 + +当我用 Go 和 [gin](https://github.com/gin-gonic/gin) 框架开发网站时,gin 缺乏实时重载的功能是令人遗憾的。我曾经尝试过 [fresh](https://github.com/pilu/fresh) ,但是它用起来不太灵活,所以我试着用更好的方式来重写它。Air 就这样诞生了。此外,非常感谢 [pilu](https://github.com/pilu)。没有 fresh 就不会有 air :) + +Air 是为 Go 应用开发设计的另外一个热重载的命令行工具。只需在你的项目根目录下输入 `air`,然后把它放在一边,专注于你的代码即可。 + +**注意**:该工具与生产环境的热部署无关。 + +## 特色 + +* 彩色的日志输出 +* 自定义构建或必要的命令 +* 支持外部子目录 +* 在 Air 启动之后,允许监听新创建的路径 +* 更棒的构建过程 + +### ✨ beta 版本的特性 + +支持使用参数来配置 air 字段: + +如果你只是想配置构建命令和运行命令,您可以直接使用以下命令,而无需配置文件: + +```shell +air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api" +``` + +对于以列表形式输入的参数,使用逗号来分隔项目: + +```shell +air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api" --build.exclude_dir "templates,build" +``` + +## 安装 + +### 推荐使用 install.sh + +```shell +# binary 文件会是在 $(go env GOPATH)/bin/air +curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin + +# 或者把它安装在 ./bin/ 路径下 +curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s + +air -v +``` + +P.S. 非常感谢 mattn 的 [PR](https://github.com/air-verse/air/pull/1),使得 Air 支持 Windows 平台。 + +### 使用 `go install` + +使用 Go 的版本为 1.22 或更高: + +```bash +go install github.com/air-verse/air@latest +``` + +### Docker + +请拉取这个 Docker 镜像 [cosmtrek/air](https://hub.docker.com/r/cosmtrek/air). + +```shell +docker run -it --rm \ + -w "" \ + -e "air_wd=" \ + -v $(pwd): \ + -p : \ + cosmtrek/air + -c +``` + +例如,我的项目之一是在 Docker 上运行的: + +```shell +docker run -it --rm \ + -w "/go/src/github.com/cosmtrek/hub" \ + -v $(pwd):/go/src/github.com/cosmtrek/hub \ + -p 9090:9090 \ + cosmtrek/air +``` + +## 使用方法 + +您可以添加 `alias air='~/.air'` 到您的 `.bashrc` 或 `.zshrc` 后缀的文件. + +首先,进入你的项目文件夹 + +```shell +cd /path/to/your_project +``` + +最简单的方法是执行 + +```shell +# 优先在当前路径查找 `.air.toml` 后缀的文件,如果没有找到,则使用默认的 +air -c .air.toml +``` + +您可以运行以下命令初始化,把默认配置添加到当前路径下的`.air.toml` 文件。 + +```shell +air init +``` + +在这之后,你只需执行 `air` 命令,无需添加额外的变量,它就能使用 `.air.toml` 文件中的配置了。 + +```shell +air +``` + +如欲修改配置信息,请参考 [air_example.toml](air_example.toml) 文件. + +### 运行时参数 + +您可以通过把变量添加在 air 命令之后来传递参数。 + +```shell +# 会执行 ./tmp/main bench +air bench + +# 会执行 ./tmp/main server --port 8080 +air server --port 8080 +``` + +You can separate the arguments passed for the air command and the built binary with `--` argument. + +```shell +# 会运行 ./tmp/main -h +air -- -h + +# 会使用个性化配置来运行 air,然后把 -h 后的变量和值添加到运行的参数中 +air -c .air.toml -- -h +``` + +### Docker Compose + +```yaml +services: + my-project-with-air: + image: cosmtrek/air + # working_dir value has to be the same of mapped volume + working_dir: /project-package + ports: + - : + environment: + - ENV_A=${ENV_A} + - ENV_B=${ENV_B} + - ENV_C=${ENV_C} + volumes: + - ./project-relative-path/:/project-package/ +``` + +### 调试 + +运行 `air -d` 命令能打印所有日志。 + +## Q&A + +### 遇到 "command not found: air" 或 "No such file or directory" 该怎么办? + +```shell +export GOPATH=$HOME/xxxxx +export PATH=$PATH:$GOROOT/bin:$GOPATH/bin +export PATH=$PATH:$(go env GOPATH)/bin <---- 请确认这行在您的配置信息中!!! +``` + +## 部署 + +请注意:这需要 Go 1.16+ ,因为我使用 `go mod` 来管理依赖。 + +```shell +# 1. 首先复刻(fork)这个项目 + +# 2. 其次克隆(clone)它 +mkdir -p $GOPATH/src/github.com/cosmtrek +cd $GOPATH/src/github.com/cosmtrek +git clone git@github.com:/air.git + +# 3. 再次安装依赖 +cd air +make ci + +# 4. 这样就可以快乐地探索和玩耍啦! +make install +``` + +顺便说一句: 欢迎 PR~ + +### 发布新版本 + +```shell +# 1. checkout 到 master 分支 +git checkout master + +# 2. 添加需要发布的版本号 +git tag v1.xx.x + +# 3. 推送到远程 +git push origin v1.xx.x + +ci 会加工和处理,然后会发布新版本。等待大约五分钟,你就能获取到新版本了。 +``` + +## 赞助 + +Buy Me A Coffee + +衷心感谢以下的支持者。我一直铭记着你们的善意。 + +* Peter Aba +* Apostolis Anastasiou +* keita koga + +## 许可证 + +[GNU General Public License v3.0](LICENSE) diff --git a/README-zh_tw.md b/README-zh_tw.md new file mode 100644 index 0000000..08cc6f4 --- /dev/null +++ b/README-zh_tw.md @@ -0,0 +1,307 @@ +# :cloud: Air - Live reload for Go apps + +[![Go](https://github.com/air-verse/air/actions/workflows/release.yml/badge.svg)](https://github.com/air-verse/air/actions?query=workflow%3AGo+branch%3Amaster) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/dcb95264cc504cad9c2a3d8b0795a7f8)](https://www.codacy.com/gh/air-verse/air/dashboard?utm_source=github.com&utm_medium=referral&utm_content=air-verse/air&utm_campaign=Badge_Grade) [![Go Report Card](https://goreportcard.com/badge/github.com/air-verse/air)](https://goreportcard.com/report/github.com/air-verse/air) [![codecov](https://codecov.io/gh/air-verse/air/branch/master/graph/badge.svg)](https://codecov.io/gh/air-verse/air) + +![air](docs/air.png) + +[English](README.md) | [简体中文](README-zh_cn.md) | 繁體中文 + +## 開發動機 + +當我開始用 Go 開發網站並使用[gin](https://github.com/gin-gonic/gin)框架時,感到可惜的是 gin 缺乏自動重新編譯執行的方式。因此,我四處搜尋並嘗試使用[fresh](https://github.com/pilu/fresh),但它似乎不夠彈性,所以我打算重新寫得更好。最後,Air 就這麼誕生了。另外,非常感謝[pilu](https://github.com/pilu),如果沒有 fresh,就不會有 air :) + +Air 是一個另類的自動重新編譯執行命令列工具,用於開發 Go 應用。在你的項目根目錄下運行 `air`,將它執行於背景中,並專注於你的程式碼。 + +注意:此工具與生產環境的熱部署無關。 + +## 功能列表 + +* 彩色的日誌輸出 +* 自訂建立或任何命令 +* 支援排除子目錄 +* 允許在 Air 開始後監視新目錄 +* 更佳的建置過程 + +### 用參數覆寫指定的配置 + +支援將 air 做為參數的配置字段: + +如果你想設定建置命令和執行命令,你可以在不需要配置檔案的情況下如下使用命令: + +```shell +air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api"` +``` + +對於需要輸入列表的參數,可以使用逗號將項目分隔: + +```shell +air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api" --build.exclude_dir "templates,build" +``` + +## 安裝 + +### 使用 `go install` (推薦) + +需要使用 go 1.22 或更高版本: + +```bash +go install github.com/air-verse/air@latest +``` + +### 透過 install.sh + +```shell +# binary will be $(go env GOPATH)/bin/air +curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin + +# or install it into ./bin/ +curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s + +air -v +``` + +### 透過 [goblin.run](https://goblin.run) + +```shell +# binary will be /usr/local/bin/air +curl -sSfL https://goblin.run/github.com/air-verse/air | sh + +# to put to a custom path +curl -sSfL https://goblin.run/github.com/air-verse/air | PREFIX=/tmp sh +``` + +### 透過 `go install` + +使用 go 1.18 或更高版本: + +```bash +go install github.com/air-verse/air@latest +``` + +### Docker/Podman + +請讀取 Docker 映像檔 [cosmtrek/air](https://hub.docker.com/r/cosmtrek/air). + +```shell +docker/podman run -it --rm \ + -w "" \ + -e "air_wd=" \ + -v $(pwd): \ + -p : \ + cosmtrek/air + -c +``` + +#### Docker/Podman .${SHELL}rc + +如果你想像常規應用程式一樣持續使用 air,你可以在你的 ${SHELL}rc (Bash, Zsh, etc…) 中創建一個函數。 + +```shell +air() { + podman/docker run -it --rm \ + -w "$PWD" -v "$PWD":"$PWD" \ + -p "$AIR_PORT":"$AIR_PORT" \ + docker.io/cosmtrek/air "$@" +} +``` + +`` 是你的容器中的專案路徑,例如:/go/example 如果你想要進入容器,請加上 --entrypoint=bash。 + +
+ For example + +我其中一個專案是在 Docker 中運行 + +```shell +docker run -it --rm \ + -w "/go/src/github.com/cosmtrek/hub" \ + -v $(pwd):/go/src/github.com/cosmtrek/hub \ + -p 9090:9090 \ + cosmtrek/air +``` + +另一個例子 + +```shell +cd /go/src/github.com/cosmtrek/hub +AIR_PORT=8080 air -c "config.toml" +``` + +這將會用當前目錄替換 `$PWD`,`$AIR_PORT` 是發佈的端口,`$@` 是用來接受應用程式本身的參數,例如 -c + +
+ +## 使用方式 + +為了減少輸入,你可以將 `alias air='~/.air'` 加到你的 `.bashrc` 或者 `.zshrc`。 + +首先,進入你的專案目錄 + +```shell +cd /path/to/your_project +``` + +最簡單的使用方式是運行 + +```shell +# firstly find `.air.toml` in current directory, if not found, use defaults +air -c .air.toml +``` + +你可以用以下命令初始化 `.air.toml` 配置檔到當前目錄,並使用預設設置。 + +```shell +air init +``` + +此後,你可以只運行 `air` 命令,而不需要額外的參數,它將使用 `.air.toml` 檔案作為配置。 + +```shell +air +``` + +要修改配置,請參閱 [air_example.toml](air_example.toml) 檔案。 + +### 運行時參數 + +你可以在 air 命令後添加參數來運行已構建的二進制檔。 + +```shell +# Will run ./tmp/main bench +air bench + +# Will run ./tmp/main server --port 8080 +air server --port 8080 +``` + +你可以使用 `--` 參數來分隔傳遞給 air 命令和已建構的二進制檔的參數。 + +```shell +# Will run ./tmp/main -h +air -- -h + +# Will run air with custom config and pass -h argument to the built binary +air -c .air.toml -- -h +``` + +### Docker Compose + +```yaml +services: + my-project-with-air: + image: cosmtrek/air + # working_dir value has to be the same of mapped volume + working_dir: /project-package + ports: + - : + environment: + - ENV_A=${ENV_A} + - ENV_B=${ENV_B} + - ENV_C=${ENV_C} + volumes: + - ./project-relative-path/:/project-package/ +``` + +### 除錯 + +`air -d` prints all logs. + +## 對於不想使用 air 映像的 Docker 使用者的安裝與使用方法 + +`Dockerfile` + +```Dockerfile +# Choose whatever you want, version >= 1.16 +FROM golang:1.21-alpine + +WORKDIR /app + +RUN go install github.com/air-verse/air@latest + +COPY go.mod go.sum ./ +RUN go mod download + +CMD ["air", "-c", ".air.toml"] +``` + +`docker-compose.yaml` + +```yaml +version: "3.8" +services: + web: + build: + context: . + # Correct the path to your Dockerfile + dockerfile: Dockerfile + ports: + - 8080:3000 + # Important to bind/mount your codebase dir to /app dir for live reload + volumes: + - ./:/app +``` + +## Q&A + +### "找不到命令:air" 或者 "找不到檔案或目錄" + +```shell +export GOPATH=$HOME/xxxxx +export PATH=$PATH:$GOROOT/bin:$GOPATH/bin +export PATH=$PATH:$(go env GOPATH)/bin <---- Confirm this line in you profile!!! +``` + +### 當 bin 中包含 ' 時,在 wsl 下的錯誤 + +應該使用 `\` 來轉義 bin 中的 `'。相關議題:[#305](https://github.com/air-verse/air/issues/305) + +## 開發 + +請注意,由於我使用 `go mod` 來管理依賴,所以需要 Go 1.16+。 + +```shell +# Fork this project + +# Clone it +mkdir -p $GOPATH/src/github.com/cosmtrek +cd $GOPATH/src/github.com/cosmtrek +git clone git@github.com:/air.git + +# Install dependencies +cd air +make ci + +# Explore it and happy hacking! +make install +``` + +歡迎提出 Pull Request + +### 發佈版本 + +```shell +# Checkout to master +git checkout master + +# Add the version that needs to be released +git tag v1.xx.x + +# Push to remote +git push origin v1.xx.x + +# The CI will process and release a new version. Wait about 5 min, and you can fetch the latest version +``` + +## 星星歷史 + +[![Star History Chart](https://api.star-history.com/svg?repos=air-verse/air&type=Date)](https://star-history.com/#air-verse/air&Date) + +## 贊助專案 + +[![Buy Me A Coffee](https://cdn.buymeacoffee.com/buttons/default-orange.png)](https://www.buymeacoffee.com/cosmtrek) + +非常感謝大量的支持者。我一直記得你們的善意。 + +## 授權 + +[GNU General Public License v3.0](LICENSE) diff --git a/README.md b/README.md new file mode 100644 index 0000000..59ad8a0 --- /dev/null +++ b/README.md @@ -0,0 +1,329 @@ +# :cloud: Air - Live reload for Go apps + +[![Go](https://github.com/air-verse/air/actions/workflows/release.yml/badge.svg)](https://github.com/air-verse/air/actions?query=workflow%3AGo+branch%3Amaster) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/dcb95264cc504cad9c2a3d8b0795a7f8)](https://www.codacy.com/gh/air-verse/air/dashboard?utm_source=github.com&utm_medium=referral&utm_content=air-verse/air&utm_campaign=Badge_Grade) [![Go Report Card](https://goreportcard.com/badge/github.com/air-verse/air)](https://goreportcard.com/report/github.com/air-verse/air) [![codecov](https://codecov.io/gh/air-verse/air/branch/master/graph/badge.svg)](https://codecov.io/gh/air-verse/air) + +![air](docs/air.png) + +English | [简体中文](README-zh_cn.md) | [繁體中文](README-zh_tw.md) + +## Motivation + +When I started developing websites in Go and using [gin](https://github.com/gin-gonic/gin) framework, it was a pity +that gin lacked a live-reloading function. So I searched around and tried [fresh](https://github.com/pilu/fresh), it seems not much +flexible, so I intended to rewrite it better. Finally, Air's born. +In addition, great thanks to [pilu](https://github.com/pilu), no fresh, no air :) + +Air is yet another live-reloading command line utility for developing Go applications. Run `air` in your project root directory, leave it alone, +and focus on your code. + +Note: This tool has nothing to do with hot-deploy for production. + +## Features + +* Colorful log output +* Customize build or any command +* Support excluding subdirectories +* Allow watching new directories after Air started +* Better building process + +### Overwrite specify configuration from arguments + +Support air config fields as arguments: + +If you want to config build command and run command, you can use like the following command without the config file: + +```shell +air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api" +``` + +Use a comma to separate items for arguments that take a list as input: + +```shell +air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api" --build.exclude_dir "templates,build" +``` + +## Installation + +### Via `go install` (Recommended) + +With go 1.22 or higher: + +```bash +go install github.com/air-verse/air@latest +``` + +### Via install.sh + +```shell +# binary will be $(go env GOPATH)/bin/air +curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin + +# or install it into ./bin/ +curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s + +air -v +``` + +### Via [goblin.run](https://goblin.run) + +```shell +# binary will be /usr/local/bin/air +curl -sSfL https://goblin.run/github.com/air-verse/air | sh + +# to put to a custom path +curl -sSfL https://goblin.run/github.com/air-verse/air | PREFIX=/tmp sh +``` + +### Docker/Podman + +Please pull this Docker image [cosmtrek/air](https://hub.docker.com/r/cosmtrek/air). + +```shell +docker/podman run -it --rm \ + -w "" \ + -e "air_wd=" \ + -v $(pwd): \ + -p : \ + cosmtrek/air + -c +``` + +#### Docker/Podman .${SHELL}rc + +if you want to use air continuously like a normal app, you can create a function in your ${SHELL}rc (Bash, Zsh, etc…) + +```shell +air() { + podman/docker run -it --rm \ + -w "$PWD" -v "$PWD":"$PWD" \ + -p "$AIR_PORT":"$AIR_PORT" \ + docker.io/cosmtrek/air "$@" +} +``` + +`` is your project path in container, eg: /go/example +if you want to enter the container, Please add --entrypoint=bash. + +
+ For example + +One of my project runs in Docker: + +```shell +docker run -it --rm \ + -w "/go/src/github.com/cosmtrek/hub" \ + -v $(pwd):/go/src/github.com/cosmtrek/hub \ + -p 9090:9090 \ + cosmtrek/air +``` + +Another example: + +```shell +cd /go/src/github.com/cosmtrek/hub +AIR_PORT=8080 air -c "config.toml" +``` + +this will replace `$PWD` with the current directory, `$AIR_PORT` is the port where to publish and `$@` is to accept arguments of the application itself for example -c + +
+ +## Usage + +For less typing, you could add `alias air='~/.air'` to your `.bashrc` or `.zshrc`. + +First enter into your project + +```shell +cd /path/to/your_project +``` + +The simplest usage is run + +```shell +# firstly find `.air.toml` in current directory, if not found, use defaults +air -c .air.toml +``` + +You can initialize the `.air.toml` configuration file to the current directory with the default settings running the following command. + +```shell +air init +``` + +After this, you can just run the `air` command without additional arguments, and it will use the `.air.toml` file for configuration. + +```shell +air +``` + +For modifying the configuration refer to the [air_example.toml](air_example.toml) file. + +### Runtime arguments + +You can pass arguments for running the built binary by adding them after the air command. + +```shell +# Will run ./tmp/main bench +air bench + +# Will run ./tmp/main server --port 8080 +air server --port 8080 +``` + +You can separate the arguments passed for the air command and the built binary with `--` argument. + +```shell +# Will run ./tmp/main -h +air -- -h + +# Will run air with custom config and pass -h argument to the built binary +air -c .air.toml -- -h +``` + +### Docker Compose + +```yaml +services: + my-project-with-air: + image: cosmtrek/air + # working_dir value has to be the same of mapped volume + working_dir: /project-package + ports: + - : + environment: + - ENV_A=${ENV_A} + - ENV_B=${ENV_B} + - ENV_C=${ENV_C} + volumes: + - ./project-relative-path/:/project-package/ +``` + +### Debug + +`air -d` prints all logs. + +## Installation and Usage for Docker users who don't want to use air image + +`Dockerfile` + +```Dockerfile +# Choose whatever you want, version >= 1.16 +FROM golang:1.22-alpine + +WORKDIR /app + +RUN go install github.com/air-verse/air@latest + +COPY go.mod go.sum ./ +RUN go mod download + +CMD ["air", "-c", ".air.toml"] +``` + +`docker-compose.yaml` + +```yaml +version: "3.8" +services: + web: + build: + context: . + # Correct the path to your Dockerfile + dockerfile: Dockerfile + ports: + - 8080:3000 + # Important to bind/mount your codebase dir to /app dir for live reload + volumes: + - ./:/app +``` + +## Q&A + +### "command not found: air" or "No such file or directory" + +```shell +export GOPATH=$HOME/xxxxx +export PATH=$PATH:$GOROOT/bin:$GOPATH/bin +export PATH=$PATH:$(go env GOPATH)/bin <---- Confirm this line in you profile!!! +``` + +### Error under wsl when ' is included in the bin + +Should use `\` to escape the `' in the bin. related issue: [#305](https://github.com/air-verse/air/issues/305) + +### Question: how to do hot compile only and do not run anything? + +[#365](https://github.com/air-verse/air/issues/365) + +```toml +[build] + cmd = "/usr/bin/true" +``` + +### How to Reload the Browser Automatically on Static File Changes + + +Refer to issue [#512](https://github.com/air-verse/air/issues/512) for additional details. + +* Ensure your static files in `include_dir`, `include_ext`, or `include_file`. +* Ensure your HTML has a `` tag +* Activate the proxy by configuring the following config: + +```toml +[proxy] + enabled = true + proxy_port = + app_port = +``` + +## Development + +Please note that it requires Go 1.16+ since I use `go mod` to manage dependencies. + +```shell +# Fork this project + +# Clone it +mkdir -p $GOPATH/src/github.com/cosmtrek +cd $GOPATH/src/github.com/cosmtrek +git clone git@github.com:/air.git + +# Install dependencies +cd air +make ci + +# Explore it and happy hacking! +make install +``` + +Pull requests are welcome. + +### Release + +```shell +# Checkout to master +git checkout master + +# Add the version that needs to be released +git tag v1.xx.x + +# Push to remote +git push origin v1.xx.x + +# The CI will process and release a new version. Wait about 5 min, and you can fetch the latest version +``` + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=air-verse/air&type=Date)](https://star-history.com/#air-verse/air&Date) + +## Sponsor + +[![Buy Me A Coffee](https://cdn.buymeacoffee.com/buttons/default-orange.png)](https://www.buymeacoffee.com/cosmtrek) + +Give huge thanks to lots of supporters. I've always been remembering your kindness. + +## License + +[GNU General Public License v3.0](LICENSE) diff --git a/air b/air new file mode 100755 index 0000000..2e0ff5b Binary files /dev/null and b/air differ diff --git a/air_1.52.2_linux_amd64.tar.gz b/air_1.52.2_linux_amd64.tar.gz new file mode 100644 index 0000000..e117d2e Binary files /dev/null and b/air_1.52.2_linux_amd64.tar.gz differ diff --git a/assets/aparna.jpg b/assets/aparna.jpg new file mode 100755 index 0000000..c30f7b1 Binary files /dev/null and b/assets/aparna.jpg differ diff --git a/backup.py b/backup.py new file mode 100644 index 0000000..888355c --- /dev/null +++ b/backup.py @@ -0,0 +1,162 @@ +import math +import cv2 +import mediapipe as mp +import matplotlib.pyplot as plt +import numpy as np + +front_image = cv2.imread( + "/home/aparna/body_measurements_mp/assests/aparna.jpg") +side_image = cv2.imread( + "/home/aparna/body_measurements_mp/body_measurement_using_cv/Images/final3.jpg" +) + +resized_height = 256 +resized_width = int(front_image.shape[1] * + (resized_height / front_image.shape[0])) +front_image_resized = cv2.resize(front_image, (resized_width, resized_height)) +side_image_resized = cv2.resize(side_image, (resized_width, resized_height)) + +front_image_gray = cv2.cvtColor(front_image_resized, cv2.COLOR_BGR2GRAY) +side_image_gray = cv2.cvtColor(side_image_resized, cv2.COLOR_BGR2GRAY) + +front_image_normalized = front_image_gray.astype("float32") / 255.0 +side_image_normalized = side_image_gray.astype("float32") / 255.0 + +cv2.imshow("front_img", front_image_normalized) +cv2.imshow("side_image", side_image_normalized) + +mp_pose = mp.solutions.pose +pose = mp_pose.Pose(static_image_mode=True, + min_detection_confidence=0.5, + min_tracking_confidence=0.5) + +resized_height = 256 +resized_width = int(front_image.shape[1] * + (resized_height / front_image.shape[0])) +front_image_resized = cv2.resize(front_image, (resized_width, resized_height)) + +landmark_indices = [11, 12, 13, 14, 15, 16, 23, 24, 25, 26, 27, 28] + +front_results = pose.process( + cv2.cvtColor(front_image_resized, cv2.COLOR_BGR2RGB)) +side_results = pose.process(cv2.cvtColor(side_image_resized, + cv2.COLOR_BGR2RGB)) + +front_image_keypoints = front_image_resized.copy() +side_image_keypoints = side_image_resized.copy() + + +def calculate_distance(landmark1, landmark2, pixel_to_metric_ratio): + l1 = landmark1.x, landmark1.y + l1 = int(l1[0] * resized_width), int(l1[1] * resized_height) + x1, y1 = l1 + l2 = landmark2.x, landmark2.y + l2 = int(l2[0] * resized_width), int(l2[1] * resized_height) + x2, y2 = l2 + print( + "x1: ", + landmark1.x, + "y1: ", + landmark1.y, + "x2: ", + landmark2.x, + "y2: ", + landmark2.y, + ) + pixel_distance = math.sqrt((x2 - x1)**2 + (y2 - y1)**2) + real_life_distance = pixel_distance * pixel_to_metric_ratio + return real_life_distance + + +def draw_landmarks(image, landmarks, indices): + for idx in indices: + landmark = landmarks.landmark[idx] + h, w, _ = image.shape + cx, cy = int(landmark.x * w), int(landmark.y * h) + cv2.circle(image, (cx, cy), 2, (255, 0, 0), -1) + + +if front_results.pose_landmarks: + draw_landmarks(front_image_keypoints, front_results.pose_landmarks, + landmark_indices) + +if side_results.pose_landmarks: + draw_landmarks(side_image_keypoints, side_results.pose_landmarks, + landmark_indices) + +h, w, _ = front_image_keypoints.shape +height_cm = 150 +pixel_distance_height = 126.32 * 2 +pixel_to_metric_ratio = height_cm / pixel_distance_height + +if front_results.pose_landmarks: + shoulder_left = front_results.pose_landmarks.landmark[11] + elbow_left = front_results.pose_landmarks.landmark[13] + distance_left_hand_up = calculate_distance(shoulder_left, elbow_left, + pixel_to_metric_ratio) + print("Distance between left shoulder and left elbow:", + distance_left_hand_up) + + elbow_left = front_results.pose_landmarks.landmark[13] + wrist_left = front_results.pose_landmarks.landmark[15] + distance_left_hand_down = calculate_distance(elbow_left, wrist_left, + pixel_to_metric_ratio) + print("Distance between left elbow and left wrist:", + distance_left_hand_down) + + hip_left = front_results.pose_landmarks.landmark[23] + knee_left = front_results.pose_landmarks.landmark[25] + distance_left_leg_up = calculate_distance(hip_left, knee_left, + pixel_to_metric_ratio) + print("Distance between left hip and left knee:", distance_left_leg_up) + + knee_left = front_results.pose_landmarks.landmark[25] + ankle_left = front_results.pose_landmarks.landmark[27] + distance_left_leg_down = calculate_distance(knee_left, ankle_left, + pixel_to_metric_ratio) + print("Distance between left knee and left ankle:", distance_left_leg_down) + +gray_image = cv2.cvtColor(front_image_keypoints, cv2.COLOR_BGR2GRAY) +blurred_image = cv2.GaussianBlur(gray_image, (5, 5), 0) +roi = blurred_image[0:int(resized_height / 2), :] +edges = cv2.Canny(roi, 50, 150) + +contours, hierarchy = cv2.findContours(edges, cv2.RETR_TREE, + cv2.CHAIN_APPROX_SIMPLE) + +outermost_contours = [ + contours[i] for i in range(len(contours)) if hierarchy[0][i][3] == -1 +] + +topmost_point = None +if outermost_contours: + largest_contour = max(outermost_contours, key=cv2.contourArea) + topmost_point = tuple(largest_contour[largest_contour[:, :, + 1].argmin()][0]) + topmost_point = (topmost_point[0], topmost_point[1]) + cv2.circle(front_image_keypoints, topmost_point, 2, (255, 0, 0), -1) + +left_hip_idx = 23 +right_hip_idx = 24 + +center_point = None +if front_results.pose_landmarks: + left_hip = front_results.pose_landmarks.landmark[left_hip_idx] + right_hip = front_results.pose_landmarks.landmark[right_hip_idx] + center_point = ((left_hip.x + right_hip.x) / 2, + (left_hip.y + right_hip.y) / 2) + center_point = ( + int(center_point[0] * resized_width), + int(center_point[1] * resized_height), + ) + cv2.circle(front_image_keypoints, center_point, 2, (255, 0, 0), -1) + +print("Pixel distance for height:", pixel_distance_height) +print("Pixel-to-metric ratio:", pixel_to_metric_ratio) + +cv2.imshow("front_img_keypoints", front_image_keypoints) +cv2.imshow("side_img_keypoints", side_image_keypoints) + +cv2.waitKey(0) +cv2.destroyAllWindows() +pose.close() diff --git a/landmarks.py b/landmarks.py index b15ed9b..61d4780 100644 --- a/landmarks.py +++ b/landmarks.py @@ -1,156 +1,243 @@ +import argparse import math import cv2 -import mediapipe as mp -import matplotlib.pyplot as plt -import numpy as np - -front_image = cv2.imread("/home/aparna/body_measurements_mp/assests/aparna.jpg") -side_image = cv2.imread( - "/home/aparna/body_measurements_mp/body_measurement_using_cv/Images/final3.jpg" -) - -resized_height = 256 -resized_width = int(front_image.shape[1] * (resized_height / front_image.shape[0])) -front_image_resized = cv2.resize(front_image, (resized_width, resized_height)) -side_image_resized = cv2.resize(side_image, (resized_width, resized_height)) - -front_image_gray = cv2.cvtColor(front_image_resized, cv2.COLOR_BGR2GRAY) -side_image_gray = cv2.cvtColor(side_image_resized, cv2.COLOR_BGR2GRAY) - -front_image_normalized = front_image_gray.astype("float32") / 255.0 -side_image_normalized = side_image_gray.astype("float32") / 255.0 - -cv2.imshow("front_img", front_image_normalized) -cv2.imshow("side_image", side_image_normalized) - -mp_pose = mp.solutions.pose -pose = mp_pose.Pose( - static_image_mode=True, min_detection_confidence=0.5, min_tracking_confidence=0.5 -) - -resized_height = 256 -resized_width = int(front_image.shape[1] * (resized_height / front_image.shape[0])) -front_image_resized = cv2.resize(front_image, (resized_width, resized_height)) - -landmark_indices = [11, 12, 13, 14, 15, 16, 23, 24, 25, 26, 27, 28] - -front_results = pose.process(cv2.cvtColor(front_image_resized, cv2.COLOR_BGR2RGB)) -side_results = pose.process(cv2.cvtColor(side_image_resized, cv2.COLOR_BGR2RGB)) - -front_image_keypoints = front_image_resized.copy() -side_image_keypoints = side_image_resized.copy() +from mediapipe.python.solutions import pose -def calculate_distance(landmark1, landmark2, pixel_to_metric_ratio): - l1 = landmark1.x, landmark1.y - l1 = int(l1[0] * resized_width), int(l1[1] * resized_height) - x1, y1 = l1 - l2 = landmark2.x, landmark2.y - l2 = int(l2[0] * resized_width), int(l2[1] * resized_height) - x2, y2 = l2 - print( - "x1: ", - landmark1.x, - "y1: ", - landmark1.y, - "x2: ", - landmark2.x, - "y2: ", - landmark2.y, - ) - pixel_distance = math.sqrt((x2 - x1) ** 2 + (y2 - y1) ** 2) - real_life_distance = pixel_distance * pixel_to_metric_ratio - return real_life_distance +class Landmarker: + + def __init__(self) -> None: + args = self.parse_args() + if args.front_image == None: + raise Exception("front image needs to be passed") + if args.side_image == None: + raise Exception("side image needs to be passed") + + self.front_image = cv2.imread(args.front_image) + self.side_image = cv2.imread(args.side_image) + + self.person_height = args.person_height + self.pixel_height = args.pixel_height + + self.pose = pose.Pose( + static_image_mode=True, + min_detection_confidence=args.pose_detection_confidence, + min_tracking_confidence=args.pose_tracking_confidence, + ) + + self.landmarks_indices = [ + pose.PoseLandmark.LEFT_SHOULDER.value, + pose.PoseLandmark.RIGHT_SHOULDER.value, + pose.PoseLandmark.LEFT_ELBOW.value, + pose.PoseLandmark.RIGHT_ELBOW.value, + pose.PoseLandmark.LEFT_WRIST.value, + pose.PoseLandmark.RIGHT_WRIST.value, + pose.PoseLandmark.LEFT_HIP.value, + pose.PoseLandmark.RIGHT_HIP.value, + pose.PoseLandmark.LEFT_KNEE.value, + pose.PoseLandmark.RIGHT_KNEE.value, + pose.PoseLandmark.LEFT_ANKLE.value, + pose.PoseLandmark.RIGHT_ANKLE.value, + ] + + def parse_args(self): + parser = argparse.ArgumentParser() + parser.add_argument("--front", + dest="front_image", + type=str, + help="Front image") + parser.add_argument("--side", + dest="side_image", + type=str, + help="Side image") + parser.add_argument( + "--pose_detection_confidence", + dest="pose_detection_confidence", + default=0.5, + type=float, + help="Confidence score for pose detection", + ) + parser.add_argument( + "--pose_tracking_confidence", + dest="pose_tracking_confidence", + default=0.5, + type=float, + help="Confidence score for pose tracking", + ) + parser.add_argument( + "--person_height", + default=153, + dest="person_height", + type=int, + help="person height of person", + ) + parser.add_argument( + "--pixel_height", + default=255, + dest="pixel_height", + type=int, + help="pixel height of person", + ) + return parser.parse_args() + + def run(self): + + front_results = self.process_images() + + self.get_center_top_point(front_results) + + self.print_distance(front_results) + + self.display_images() + + self.pose.close() + + def process_images(self): + front_results = self.pose.process( + cv2.cvtColor(self.front_image, cv2.COLOR_BGR2RGB)) + side_results = self.pose.process( + cv2.cvtColor(self.side_image, cv2.COLOR_BGR2RGB)) + + self.side_image_keypoints = self.side_image.copy() + self.front_image_keypoints = self.front_image.copy() + + if front_results.pose_landmarks: # type: ignore + self.draw_landmarks( + self.front_image_keypoints, + front_results.pose_landmarks, # type: ignore + self.landmarks_indices, + ) + if side_results.pose_landmarks: # type: ignore + self.draw_landmarks( + self.side_image_keypoints, + side_results.pose_landmarks, # type: ignore# type: ignore + self.landmarks_indices, + ) + return front_results + + def calculate_distance(self, landmark1, landmark2): + l1 = landmark1.x, landmark1.y + l1 = int(l1[0]), int(l1[1]) + x1, y1 = l1 + l2 = landmark2.x, landmark2.y + l2 = int(l2[0]), int(l2[1]) + x2, y2 = l2 + pixel_distance = self.euclidean_distance(x1, x2, y1, y2) + real_distance = pixel_distance * self.pixel_to_metric_ratio() + return real_distance + + def pixel_to_metric_ratio(self): + pixel_to_metric_ratio = self.person_height / self.pixel_height + return pixel_to_metric_ratio + + def draw_landmarks(self, image, landmarks, indices): + for idx in indices: + landmark = landmarks.landmark[idx] + h, w, _ = image.shape + cx, cy = int(landmark.x * w), int(landmark.y * h) + self.circle(image, cx, cy) + + def circle(self, image, cx, cy): + return cv2.circle(image, (cx, cy), 2, (255, 0, 0), -1) + + def print_distance(self, front_results): + if not front_results.pose_landmarks: + return + + landmarks = front_results.pose_landmarks.landmark + + shoulder_left = landmarks[pose.PoseLandmark.LEFT_SHOULDER.value] + elbow_left = landmarks[pose.PoseLandmark.LEFT_ELBOW.value] + wrist_left = landmarks[pose.PoseLandmark.LEFT_WRIST.value] + hip_left = landmarks[pose.PoseLandmark.LEFT_HIP.value] + knee_left = landmarks[pose.PoseLandmark.LEFT_KNEE.value] + ankle_left = landmarks[pose.PoseLandmark.LEFT_ANKLE.value] + + distance_left_hand_up = self.calculate_distance( + shoulder_left, elbow_left) + print("Distance between left shoulder and left elbow:", + distance_left_hand_up) + + distance_left_hand_down = self.calculate_distance( + elbow_left, wrist_left) + print("Distance between left elbow and left wrist:", + distance_left_hand_down) + + distance_left_leg_up = self.calculate_distance(hip_left, knee_left) + print("Distance between left hip and left knee:", distance_left_leg_up) + + distance_left_leg_down = self.calculate_distance(knee_left, ankle_left) + print("Distance between left knee and left ankle:", + distance_left_leg_down) + + def euclidean_distance(self, x1, x2, y1, y2): + distance = math.sqrt((x2 - x1)**2 + (y2 - y1)**2) + return distance + + def destroy(self): + cv2.destroyAllWindows() + + def display_images(self): + cv2.imshow("front_image_keypoints", self.front_image_keypoints) + cv2.imshow("side_image_keypoints", self.side_image_keypoints) + cv2.waitKey(0) + + def get_center_top_point(self, front_results): + gray_image = cv2.cvtColor(self.front_image_keypoints, + cv2.COLOR_BGR2GRAY) + blurred_image = cv2.GaussianBlur(gray_image, (5, 5), 0) + roi = blurred_image[0:int(self.front_image.shape[0] / 2), :] + edges = cv2.Canny(roi, 50, 150) + contours, hierarchy = cv2.findContours(edges, cv2.RETR_TREE, + cv2.CHAIN_APPROX_SIMPLE) + + self.topmost_point = None + + outermost_contours = [ + contours[i] for i in range(len(contours)) + if hierarchy[0][i][3] == -1 + ] + if outermost_contours: + largest_contour = max(outermost_contours, key=cv2.contourArea) + self.topmost_point = tuple( + largest_contour[largest_contour[:, :, 1].argmin()][0]) + topmost_point = ( + int(self.topmost_point[0] * self.front_image.shape[1]), + int(self.topmost_point[1] * self.front_image.shape[0]), + ) + cv2.circle(self.front_image_keypoints, topmost_point, 2, + (255, 0, 0), -1) + + self.left_hip_idx = 23 + self.right_hip_idx = 24 + + self.center_point = None + + if front_results.pose_landmarks: + left_hip = front_results.pose_landmarks.landmark[self.left_hip_idx] + right_hip = front_results.pose_landmarks.landmark[ + self.right_hip_idx] + center_point = ( + (left_hip.x + right_hip.x) / 2, + (left_hip.y + right_hip.y) / 2, + ) + center_point = ( + int(center_point[0] * self.front_image.shape[1]), + int(center_point[1] * self.front_image.shape[0]), + ) + cv2.circle(self.front_image_keypoints, center_point, 2, + (255, 0, 0), -1) + #xc, yc = center_point + #xt, yt = topmost_point + #distance = self.euclidean_distance(xc, xt, yc, yt) + # return distance + return center_point -def draw_landmarks(image, landmarks, indices): - for idx in indices: - landmark = landmarks.landmark[idx] - h, w, _ = image.shape - cx, cy = int(landmark.x * w), int(landmark.y * h) - cv2.circle(image, (cx, cy), 2, (255, 0, 0), -1) - - -if front_results.pose_landmarks: - draw_landmarks( - front_image_keypoints, front_results.pose_landmarks, landmark_indices - ) - -if side_results.pose_landmarks: - draw_landmarks(side_image_keypoints, side_results.pose_landmarks, landmark_indices) - -h, w, _ = front_image_keypoints.shape -height_cm = 150 -pixel_distance_height = 126.32 * 2 -pixel_to_metric_ratio = height_cm / pixel_distance_height - -if front_results.pose_landmarks: - shoulder_left = front_results.pose_landmarks.landmark[11] - elbow_left = front_results.pose_landmarks.landmark[13] - distance_left_hand_up = calculate_distance( - shoulder_left, elbow_left, pixel_to_metric_ratio - ) - print("Distance between left shoulder and left elbow:", distance_left_hand_up) - - elbow_left = front_results.pose_landmarks.landmark[13] - wrist_left = front_results.pose_landmarks.landmark[15] - distance_left_hand_down = calculate_distance( - elbow_left, wrist_left, pixel_to_metric_ratio - ) - print("Distance between left elbow and left wrist:", distance_left_hand_down) - - hip_left = front_results.pose_landmarks.landmark[23] - knee_left = front_results.pose_landmarks.landmark[25] - distance_left_leg_up = calculate_distance( - hip_left, knee_left, pixel_to_metric_ratio - ) - print("Distance between left hip and left knee:", distance_left_leg_up) - - knee_left = front_results.pose_landmarks.landmark[25] - ankle_left = front_results.pose_landmarks.landmark[27] - distance_left_leg_down = calculate_distance( - knee_left, ankle_left, pixel_to_metric_ratio - ) - print("Distance between left knee and left ankle:", distance_left_leg_down) - -gray_image = cv2.cvtColor(front_image_keypoints, cv2.COLOR_BGR2GRAY) -blurred_image = cv2.GaussianBlur(gray_image, (5, 5), 0) -roi = blurred_image[0 : int(resized_height / 2), :] -edges = cv2.Canny(roi, 50, 150) - -contours, hierarchy = cv2.findContours(edges, cv2.RETR_TREE, cv2.CHAIN_APPROX_SIMPLE) - -outermost_contours = [ - contours[i] for i in range(len(contours)) if hierarchy[0][i][3] == -1 -] - -topmost_point = None -if outermost_contours: - largest_contour = max(outermost_contours, key=cv2.contourArea) - topmost_point = tuple(largest_contour[largest_contour[:, :, 1].argmin()][0]) - topmost_point = (topmost_point[0], topmost_point[1]) - cv2.circle(front_image_keypoints, topmost_point, 2, (255, 0, 0), -1) - -left_hip_idx = 23 -right_hip_idx = 24 - -center_point = None -if front_results.pose_landmarks: - left_hip = front_results.pose_landmarks.landmark[left_hip_idx] - right_hip = front_results.pose_landmarks.landmark[right_hip_idx] - center_point = ((left_hip.x + right_hip.x) / 2, (left_hip.y + right_hip.y) / 2) - center_point = ( - int(center_point[0] * resized_width), - int(center_point[1] * resized_height), - ) - cv2.circle(front_image_keypoints, center_point, 2, (255, 0, 0), -1) - -print("Pixel distance for height:", pixel_distance_height) -print("Pixel-to-metric ratio:", pixel_to_metric_ratio) - -cv2.imshow("front_img_keypoints", front_image_keypoints) -cv2.imshow("side_img_keypoints", side_image_keypoints) - -cv2.waitKey(0) -cv2.destroyAllWindows() -pose.close() +l = Landmarker() +try: + l.run() +except: + print("error") +finally: + l.destroy() diff --git a/temp.py b/temp.py new file mode 100644 index 0000000..94f3df6 --- /dev/null +++ b/temp.py @@ -0,0 +1,210 @@ +import argparse +import math +import cv2 +import mediapipe as mp + + +class Landmarker: + + def __init__(self) -> None: + args = self.parse_args() + if args.front_image == None: + raise Exception("front image needs to be passed") + if args.side_image == None: + raise Exception("side image needs to be passed") + + self.front_image = cv2.imread(args.front_image) + self.side_image = cv2.imread(args.side_image) + + mp_pose = mp.solutions.pose + self.pose = mp_pose.Pose( + static_image_mode=True, + min_detection_confidence=args.pose_detection_confidence, + min_tracking_confidence=args.pose_tracking_confidence, + ) + + self.resized_height = 256 + self.resized_width = int( + self.front_image.shape[1] * + (self.resized_height / self.front_image.shape[0])) + + self.front_image_resized = cv2.resize( + self.front_image, (self.resized_width, self.resized_height)) + self.side_image_resized = cv2.resize( + self.side_image, (self.resized_width, self.resized_height)) + + self.landmarks_indices = [ + 11, 12, 13, 14, 15, 16, 23, 24, 25, 26, 27, 28 + ] + + def parse_args(self): + parser = argparse.ArgumentParser() + parser.add_argument("--front", + dest="front_image", + type=str, + help="Front image") + parser.add_argument("--side", + dest="side_image", + type=str, + help="Side image") + parser.add_argument("--pose_detection_confidence", + deafult=0.5, + dest="Pose detection confidence", + type=float, + help="Confidence score for pose detection") + parser.add_argument("--pose_tracking_confidence", + default=0.5, + dest="Pose detection tracking", + type=float, + help="Confidence score for pose tracking") + return parser.parse_args() + + def run(self): + front_results = self.pose.process( + cv2.cvtColor(self.front_image_resized, cv2.COLOR_BGR2RGB)) + side_results = self.pose.process( + cv2.cvtColor(self.side_image_resized, cv2.COLOR_BGR2RGB)) + + self.side_image_keypoints = self.side_image_resized.copy() + self.front_image_keypoints = self.front_image_resized.copy() + + if front_results.pose_landmarks: + self.draw_landmarks( + self.front_image_keypoints, + front_results.pose_landmarks, + self.landmarks_indices, + ) + if side_results.pose_landmarks: + self.draw_landmarks( + self.side_image_keypoints, + side_results.pose_landmarks, + self.landmarks_indices, + ) + + self.get_center_top_point(front_results) + + self.print_distance(front_results) + + self.display_images() + + self.pose.close() + + def calculate_distance(self, landmark1, landmark2): + l1 = landmark1.x, landmark1.y + l1 = int(l1[0] * self.resized_width), int(l1[1] * self.resized_height) + x1, y1 = l1 + l2 = landmark2.x, landmark2.y + l2 = int(l2[0] * self.resized_width), int(l2[1] * self.resized_height) + x2, y2 = l2 + pixel_distance = math.sqrt((x2 - x1)**2 + (y2 - y1)**2) + real_distance = pixel_distance * self.pixel_to_metric_ratio() + return real_distance + + def pixel_to_metric_ratio(self): + height_person = 153 + pixel_distance_height = 255 + pixel_to_metric_ratio = height_person / pixel_distance_height + pixel_to_metric_ratio = round(pixel_to_metric_ratio) + return pixel_to_metric_ratio + + def draw_landmarks(self, image, landmarks, indices): + for idx in indices: + landmark = landmarks.landmark[idx] + h, w, _ = image.shape + cx, cy = int(landmark.x * w), int(landmark.y * h) + cv2.circle(image, (cx, cy), 2, (255, 0, 0), -1) + + def print_distance(self, front_results): + if not front_results.pose_landmarks: + return + + landmarks = front_results.pose_landmarks.landmark + + shoulder_left = landmarks[11] + elbow_left = landmarks[13] + wrist_left = landmarks[15] + hip_left = landmarks[23] + knee_left = landmarks[25] + ankle_left = landmarks[27] + + distance_left_hand_up = self.calculate_distance( + shoulder_left, elbow_left) + print("Distance between left shoulder and left elbow:", + distance_left_hand_up) + + distance_left_hand_down = self.calculate_distance( + elbow_left, wrist_left) + print("Distance between left elbow and left wrist:", + distance_left_hand_down) + + distance_left_leg_up = self.calculate_distance(hip_left, knee_left) + print("Distance between left hip and left knee:", distance_left_leg_up) + + distance_left_leg_down = self.calculate_distance(knee_left, ankle_left) + print("Distance between left knee and left ankle:", + distance_left_leg_down) + + def destroy(): + cv2.destroyAllWindows() + + def display_images(self): + cv2.imshow("front_image_keypoints", self.front_image_keypoints) + cv2.imshow("side_image_keypoints", self.side_image_keypoints) + + def get_center_top_point(self, front_results): + gray_image = cv2.cvtColor(self.front_image_keypoints, + cv2.COLOR_BGR2GRAY) + blurred_image = cv2.GaussianBlur(gray_image, (5, 5), 0) + roi = blurred_image[0:int(self.resized_height / 2), :] + edges = cv2.Canny(roi, 50, 150) + contours, hierarchy = cv2.findContours(edges, cv2.RETR_TREE, + cv2.CHAIN_APPROX_SIMPLE) + + self.topmost_point = None + + outermost_contours = [ + contours[i] for i in range(len(contours)) + if hierarchy[0][i][3] == -1 + ] + if outermost_contours: + largest_contour = max(outermost_contours, key=cv2.contourArea) + self.topmost_point = tuple( + largest_contour[largest_contour[:, :, 1].argmin()][0]) + # topmost_point = (int(topmost_point[0]*self.resized_width), int(topmost_point[1] * self.resized_height)) + topmost_point = (self.topmost_point[0], self.topmost_point[1]) + cv2.circle(self.front_image_keypoints, topmost_point, 2, + (255, 0, 0), -1) + + self.left_hip_idx = 23 + self.right_hip_idx = 24 + + self.center_point = None + + if front_results.pose_landmarks: + left_hip = front_results.pose_landmarks.landmark[self.left_hip_idx] + right_hip = front_results.pose_landmarks.landmark[ + self.right_hip_idx] + center_point = ( + (left_hip.x + right_hip.x) / 2, + (left_hip.y + right_hip.y) / 2, + ) + center_point = ( + int(center_point[0] * self.resized_width), + int(center_point[1] * self.resized_height), + ) + cv2.circle(self.front_image_keypoints, center_point, 2, + (255, 0, 0), -1) + xc, yc = center_point + xt, yt = topmost_point + distance = math.sqrt((xc - xt)**2 + (yc - yt)**2) + #return distance + return center_point + + +l = Landmarker() +try: + l.run() +except: + pass +finally: + l.destroy() diff --git a/tmp/build-errors.log b/tmp/build-errors.log new file mode 100644 index 0000000..42faefa --- /dev/null +++ b/tmp/build-errors.log @@ -0,0 +1 @@ +exit status 127 \ No newline at end of file