diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -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/ff5reader.py b/ff5reader.py index 620361d..251e706 100755 --- a/ff5reader.py +++ b/ff5reader.py @@ -1,6 +1,19 @@ #!/usr/bin/python3 -i ''' -No license for now + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . ''' import sys @@ -8,11 +21,22 @@ import os from struct import unpack from itertools import chain from array import array -from snestile import generate_glyphs, generate_glyphs_large, generate_palette, create_tile, create_tile_indexed, create_tile_mode7_compressed, create_tile_mode7_compressed_indexed -from snestile import Canvas, Canvas_Indexed -from snestile import bg_color, bg_trans -import const import time +import functools + +from includes.helpers import * +from includes.qthelpers import * +from includes.snestile import ( + generate_glyphs, generate_glyphs_large, generate_palette, + create_tile, create_tile_indexed, + create_tile_mode7_compressed, create_tile_mode7_compressed_indexed, + bg_color, bg_trans, + Canvas, Canvas_Indexed + ) +from includes.snes import * +import includes.const as const +import includes.ff4 as ff4 +import includes.ff6 as ff6 pyqt_version = 0 skip_pyqt5 = 'PYQT4' in os.environ @@ -73,24 +97,6 @@ if pyqt_version == 0: 'Make sure you installed the PyQt4 package.') sys.exit(-1) - - -HEX_PREFIX = '#' # '$' or '0x' are also nice - -monofont = QFont() -monofont.setStyleHint(QFont.Monospace) -if not monofont.fixedPitch(): - monofont.setStyleHint(QFont.TypeWriter) -if not monofont.fixedPitch(): - monofont.setFamily('Monospace') - -def divceil(numerator, denominator): - # Reverse floor division for ceil - return -(-numerator // denominator) - -def hex_length(i): - return divceil(i.bit_length(), 4) - with open(filename_en, 'rb') as file: ROM_en = file.read() print(len(ROM_en), filename_en) @@ -109,22 +115,24 @@ imglist_headers = stringlist_headers + ['Img', 'Name JP', 'Img JP'] class FF5Reader(QMainWindow): - """ + ''' Main GUI class - """ + ''' def __init__(self): QMainWindow.__init__(self, None) global glyph_sprites_en_large, glyph_sprites_en_small, glyph_sprites_jp_small, glyph_sprites_jp_large, glyph_sprites_kanji, glyph_sprites_jp_dialogue perfcount() print('Generating Glyphs') - glyph_sprites_en_small = generate_glyphs(ROM_en, 0x11F000) - glyph_sprites_en_large = generate_glyphs_large(ROM_en, 0x03E800) - glyph_sprites_jp_small = generate_glyphs(ROM_jp, 0x11F000) - glyph_sprites_jp_large = generate_glyphs_large(ROM_jp, 0x03E800) - glyph_sprites_kanji = generate_glyphs_large(ROM_jp, 0x1BD000, 0x1AA) # Kanji are unchanged in EN version + self.glyph_sprites = { + 'glyphs_en_s': generate_glyphs(ROM_en, 0x11F000), + 'glyphs_en_l': generate_glyphs_large(ROM_en, 0x03E800), + 'glyphs_jp_s': generate_glyphs(ROM_jp, 0x11F000), + 'glyphs_jp_l': generate_glyphs_large(ROM_jp, 0x03E800), + 'glyphs_kanji': generate_glyphs_large(ROM_jp, 0x1BD000, 0x1AA), # Kanji are unchanged in EN version + } + make_string_img_list = functools.partial(_make_string_img_list, **self.glyph_sprites) perfcount() - global zone_names print('Generating Strings') zone_names = make_string_img_list(0x107000, 2, 0x100, start_str=0x270000, start_jp_str=0x107200, indirect=True, large=True) items = make_string_img_list(0x111380, 9, 256) @@ -178,8 +186,8 @@ class FF5Reader(QMainWindow): ('TerrainID', 1, None), ('TerrainFlipID', 1, None), (hex(5, 1), 1, None), - ('Movement', 1, None), - (hex(7, 1), 1, None),] + ('AnimationID', 1, None), + ('PaletteCycleID',1, None),] battle_bg_headers = ['Address'] + [z[0] for z in battle_bg_structure] battle_bg_data = [parse_struct(ROM_jp, 0x14BA21 + (i*8), battle_bg_structure) for i in range(34)] @@ -206,7 +214,7 @@ class FF5Reader(QMainWindow): enemy_sprite_structure = [ ('Sprite data offset', 2, None), ('Multiple things', 2, None), - ('Tile Layout ID', 1, None) + ('Tile Layout ID', 1, None), ] enemy_sprite_headers = ['Address']+[i[0] for i in enemy_sprite_structure]+['EN Name','EN Name'] address = 0x14B180 @@ -251,11 +259,11 @@ class FF5Reader(QMainWindow): perfcount() print('Generating FF4 and FF6 stuff') - self.battle_strips_ff4 = make_character_battle_sprites_ff4(ROM_FF4jp) - self.field_strips_ff4 = make_character_field_sprites_ff4(ROM_FF4jp) - self.portraits_ff4 = make_character_portrait_sprites_ff4(ROM_FF4jp) - self.battle_strips_ff6 = make_character_battle_sprites_ff6(ROM_FF6jp) - self.portraits_ff6 = make_character_portrait_sprites_ff6(ROM_FF6jp) + self.battle_strips_ff4 = ff4.make_character_battle_sprites(ROM_FF4jp) + self.field_strips_ff4 = ff4.make_character_field_sprites(ROM_FF4jp) + self.portraits_ff4 = ff4.make_character_portrait_sprites(ROM_FF4jp) + self.battle_strips_ff6 = ff6.make_character_battle_sprites(ROM_FF6jp) + self.portraits_ff6 = ff6.make_character_portrait_sprites(ROM_FF6jp) perfcount() @@ -273,11 +281,11 @@ class FF5Reader(QMainWindow): self.ff5widget.addTab(structs_tab, 'Structs') self.ff5widget.addTab(sprites_tab, 'Images') - sprites_tab.addTab(make_pixmap_table(glyph_sprites_en_small, scale=4), 'Glyphs (EN)') - sprites_tab.addTab(make_pixmap_table(glyph_sprites_en_large, scale=2), 'Glyphs (Dialogue EN)') - sprites_tab.addTab(make_pixmap_table(glyph_sprites_jp_small, scale=4), 'Glyphs (JP)') - sprites_tab.addTab(make_pixmap_table(glyph_sprites_jp_large, scale=2), 'Glyphs (Large JP)') - sprites_tab.addTab(make_pixmap_table(glyph_sprites_kanji, scale=2), 'Glyphs (Kanji)') + sprites_tab.addTab(make_pixmap_table(self.glyph_sprites['glyphs_en_s'], scale=4), 'Glyphs (EN)') + sprites_tab.addTab(make_pixmap_table(self.glyph_sprites['glyphs_en_l'], scale=2), 'Glyphs (Dialogue EN)') + sprites_tab.addTab(make_pixmap_table(self.glyph_sprites['glyphs_jp_s'], scale=4), 'Glyphs (JP)') + sprites_tab.addTab(make_pixmap_table(self.glyph_sprites['glyphs_jp_l'], scale=2), 'Glyphs (Large JP)') + sprites_tab.addTab(make_pixmap_table(self.glyph_sprites['glyphs_kanji'], scale=2),'Glyphs (Kanji)') sprites_tab.addTab(make_pixmap_table(worldmap_subtiles, cols=16, scale=4), 'Worldmap Subtiles') sprites_tab.addTab(make_pixmap_table(world_tiles_pixmaps[0], cols=16, scale=4), 'World 1 Tiles') sprites_tab.addTab(make_pixmap_table(world_tiles_pixmaps[1], cols=16, scale=4), 'World 2 Tiles') @@ -334,7 +342,7 @@ class FF5Reader(QMainWindow): if len(string) % 1: string += '0' bytelist = [int(string[i:i+2], 16) for i in range(0, len(string), 2)] - tups = make_string_img_small(bytes(bytelist)) + tups = make_string_img_small(bytes(bytelist), self.glyph_sprites['glyphs_en_s']) print(tups[0]) img = QLabel() img.setPixmap(tups[1]) @@ -342,495 +350,13 @@ class FF5Reader(QMainWindow): self.decoder_input.setText('') - -def parse_struct(rom, offset, structure): - out = [hex(offset, 6)] - j = 0 - for title, length, handler in structure: - val = indirect(rom, offset+j, length=length) - if callable(handler): - out.append(handler(val)) - elif handler and val < len(handler): - out.append(handler[val]) - else: - out.append(hex(val, length*2)) - j += length - return out - - -def make_enemy_sprites(rom): - sprites = [] - for e_id in range(0, 0x180*5, 5): - triplane = bool(rom[0x14B180+e_id]&0x80) # True if 3 planes, False if 4 - bytes_per_tile = 24 if triplane else 32 - tile_offset = ((((rom[0x14B180+e_id]&0x7F)<<8)| rom[0x14B181+e_id]) << 3) + 0x150000 # For whatever reason this is big endian - pal_offset = ((((rom[0x14B182+e_id]&0x03)<<8)| rom[0x14B183+e_id]) << 4) + 0x0ED000 # For whatever reason this is big endian - pal_size = 16 if triplane else 32 - palette = generate_palette(rom, pal_offset, pal_size, transparent=True) - layout_id = rom[0x14B184+e_id] - boss_layout = bool(rom[0x14B182+e_id]&0x80) - if boss_layout: - layout = rom[0x10D334+(layout_id<<5):0x10D334+(layout_id<<5)+32] - sprite = Canvas(16, 16) - for x, y in [(x,y) for y in range(16) for x in range(16)]: - if (int.from_bytes(layout[y*2:y*2+2], 'little') & (0x8000 >> x)): - sprite.draw_pixmap(x, y, create_tile(rom[tile_offset:tile_offset+bytes_per_tile], palette)) - tile_offset += bytes_per_tile - else: - layout = rom[0x10D004+(layout_id<<3):0x10D004+(layout_id<<3)+8] - sprite = Canvas(8, 8) - for x, y in [(x,y) for y in range(8) for x in range(8)]: - if (layout[y] & (0x80 >> x)): - sprite.draw_pixmap(x, y, create_tile(rom[tile_offset:tile_offset+bytes_per_tile], palette)) - tile_offset += bytes_per_tile - - # TODO: Shadow stuff - sprites.append(sprite.pixmap(True)) - return sprites - - -def make_worldmap_subtiles(rom, tiles_address, lut_address, length=0x100): - subtiles = [] - for i in range(length): - pal_index = rom[lut_address+i]//16 - subtiles.append(create_tile_mode7_compressed_indexed(rom[tiles_address+i*32:tiles_address+i*32+32], pal_index)) - return subtiles - -def stitch_worldmap_tiles(rom, subtiles, offset=0x0FF0C0): - tiles = [] - for i in range(0xC0): - canvas = Canvas_Indexed(2, 2) - for j in range(4): - k = indirect(rom, offset+(j*0xC0)+i, length=1) - canvas.draw_tile(j%2, j//2, subtiles[k]) - tiles.append(canvas.image) - return tiles - -def make_worldmap_tiles(rom, tiles_address, subtiles_address, lut_address, length=0x100): - return stitch_worldmap_tiles(rom, make_worldmap_subtiles(rom, subtiles_address, lut_address, length=length), tiles_address) - -def make_worldmap_subtiles_pixmap(rom, tiles_address, lut_address, palette_address, length=0x100): - tiles = [] - palettes = [generate_palette(rom, palette_address+i*32, transparent=True) for i in range(16)] - for i in range(length): - palette = palettes[rom[lut_address+i]//16] - tiles.append(create_tile_mode7_compressed(rom[tiles_address+i*32:tiles_address+i*32+32], palette)) - return tiles - -def make_worldmap_chunk(rom, id, length=256): - i = indirect(rom, 0x0FE000+(id*2)) + 0x070000 - if id > 0x433: - i += 0x010000 - mountains = [0x0C, 0x1C, 0x2C] - chunk = [] - while len(chunk) < length: - j = indirect(rom, i, 1) - if j >= 0xC0: - k = j-0xBF - i += 1 - j = indirect(rom, i, 1) - chunk += [j]*k - elif j in mountains: - chunk += [j, j+1, j+2] - else: - chunk.append(j) - i += 1 - return chunk - -def make_worldmap_chunk_pixmap(rom, id, palette_address, tiles): - chunk = make_worldmap_chunk(rom, id) - palette = generate_palette(rom, palette_address, length=0x320, transparent=True) - canvas = Canvas_Indexed(len(chunk), 1, tilesize=16) - for i, c in enumerate(chunk): - canvas.draw_tile(i, 0, tiles[c]) - return canvas.pixmap(palette) - -def make_worldmap_pixmap(rom, map_id, palette_address, tiles): - id_offset = map_id*256 - palette = generate_palette(rom, palette_address, length=0x320, transparent=True) - canvas = Canvas_Indexed(256, 256, tilesize=16) - for j in range(256): - chunk = make_worldmap_chunk(rom, j+id_offset) - for i, c in enumerate(chunk): - canvas.draw_tile(i, j, tiles[c]) - return canvas.pixmap(palette) - -def make_field_tiles(rom, id): - tiles_address = indirect(rom, 0x1C2D84 + id*4, length=4) + 0x1C2E24 - return [create_tile_indexed(rom[tiles_address+i*32:tiles_address+i*32+32]) for i in range(256)] - -def make_field_minitiles(rom, id): - tiles_address = indirect(rom, 0x1C0000 + id*2) + 0x1C0024 - return [create_tile_indexed(rom[tiles_address+i*16:tiles_address+i*16+16]) for i in range(256)] - -def make_all_field_tiles(rom): - return [make_field_tiles(rom, i) for i in range(40)] - -def make_all_field_minitiles(rom): - return [make_field_minitiles(rom, i) for i in range(18)] - -def stitch_tileset(tiles): - canvas = Canvas_Indexed(16, len(tiles)//16) - for i, tile in enumerate(tiles): - canvas.draw_tile(i%16, i//16, tile) - return canvas - -def get_field_map_tiles(rom, id): +def make_string_img_small(bytestring, glyphs, jp=False): ''' - This is a bit of a mess of pointer chains for now, so generalising it will have to wait. - Palette selection is probably determined by the tilemap which is outside the scope of this, so we'll just use #1. - UPDATE: i2-i7 merely obtain a zone ID. Whoops. + JP version is not as fancy as this with dakuten, it just puts them on the row above and clips. ''' - #i2 = indirect(rom, 0x0E2400 + id*2) - #i3 = indirect(rom, 0x0E2402 + i2)*2 - #i4 = indirect(rom, 0x18E080 + i3) - #i5 = indirect(rom, 0x18E081 + i4+4)*3 - #i6 = indirect(rom, 0x083320 + i5) - #i7 = indirect(rom, 0x080001 + i6) & 0x03FF - i8 = id * 0x1A - tilesets = indirect(rom, 0x0E9C09 + i8, length=3) - tile_index_0 = (tilesets & 0x00003F) # (indirect(rom, 0x0E9C09 + i8) & 0x003F) - tile_index_1 = (tilesets & 0x000FC0) >> 6 # (indirect(rom, 0x0E9C09 + i8) & 0x0FC0)>>6 - tile_index_2 = (tilesets & 0x03F000) >> 12 # (indirect(rom, 0x0E9C0A + i8) & 0x03F0)>>4 - minitile_index = (tilesets & 0xFC0000) >> 18 # (indirect(rom, 0x0E9C0A + i8) & 0x03F0)>>4 - pal_offset = indirect(rom, 0x0E9C16 + i8) * 0x100 - palette_address = 0x03BB00 + pal_offset - palettes = [generate_palette(rom, palette_address+i*32, transparent=True) for i in range(8)] - return tile_index_0, tile_index_1, tile_index_2, minitile_index, palettes - -def make_field_map_tile_pixmap(rom, id, st_tiles, st_minitiles): - *tiles, minitile, palettes = get_field_map_tiles(rom, id) - p = palettes[1] - canvas = Canvas(16, 64) - for i, ts in enumerate(tiles): - canvas.draw_pixmap(0, i*16, st_tiles[ts].pixmap(p)) - canvas.draw_pixmap(0, 48, st_minitiles[minitile].pixmap(p)) - return canvas.pixmap() - -def decompress_lzss(rom, start, header=False): - ''' - Algorithm from http://slickproductions.org/slickwiki/index.php/Noisecross:Final_Fantasy_V_Compression - ''' - uncompressed_length = indirect(rom, start) - ptr = start+2 - output = [] - buffer = [0 for i in range(0x800)] - buffer_p = 0x07DE - while len(output) < uncompressed_length: - bitmap_byte = rom[ptr] - ptr += 1 - for i in range(8): - bit = (bitmap_byte >> i) & 1 - if bit: - b = rom[ptr] - ptr += 1 - output.append(b) - buffer[buffer_p] = b - buffer_p = (buffer_p+1) % 0x800 - else: - b1 = rom[ptr] - b2 = rom[ptr+1] - ptr += 2 - offset = b1|((b2 & 0xE0)<<3) - length = b2 & 0x1F - for j in range(length+3): - b = buffer[offset] - output.append(b) - buffer[buffer_p] = b - buffer_p = (buffer_p+1) % 0x800 - offset = (offset+1) % 0x800 - return bytes(output[:uncompressed_length]) - -def decompress_battle_terrain(rom, address): - ''' - Decompresses the tilemap for a battle background. - ''' - length = 0x500 - output = [0 for i in range(length)] - o1 = [] - ptr = address - while len(o1) < length//2: - a = rom[ptr] - ptr += 1 - if a != 0xFF: - o1.append(a) - else: - repeat = rom[ptr] - ptr += 1 - if repeat & 0x80: # Repeat 2 tiles - repeat &= 0x3F - a, b = rom[ptr:ptr+2] - ptr += 2 - o1 += [a, b]*repeat - else: # Incremental repeat - a, inc = rom[ptr:ptr+2] - ptr += 2 - if repeat & 0x40: # Negative increment - inc = -inc - repeat &= 0x3F - o1 += [a+(i*inc) for i in range(repeat)] - o2 = [4*(1+(i>>7)) for i in o1] - output[::2] = [i|0x80 for i in o1[:length//2]] - output[1::2] = [i&0xDF for i in o2[:length//2]] - return bytes(output) - -def apply_battle_terrain_flips(rom, id, battle_terrain): - if id==0xFF: - return battle_terrain - ptr = indirect(rom, 0x14C736+(id*2))+0x140000 - length = len(battle_terrain)//2 - output = list(battle_terrain) - buffer = [] - - while len(buffer) < length: - a = rom[ptr] - ptr += 1 - if a == 0x00: - skip = rom[ptr] - ptr += 1 - buffer += [0]*skip*8 - else: - for b in reversed(range(0, 8, 1)): - buffer.append((a>>b)&0x01) - - for i in range(len(battle_terrain)//2): - output[i*2+1] |= (buffer[i] << 6) - return bytes(output) - -def make_tilemap_pixmap(tilemap, tiles, palettes, tile_adjust=0): - ''' - Battle bg is 64x64 map size, 8x8 tile size - 4bpp tiles - ''' - canvas = Canvas(64, 64) - for i in range(len(tilemap)//2): - a, b = tilemap[i*2:(i+1)*2] - tile_index = a|((b & 0x02) << 8) - p = (b & 0x1C) >> 2 - priority = (b & 0x20) >> 5 - h_flip = (b & 0x40) >> 6 - v_flip = (b & 0x80) >> 7 - - x = (i % 32) + 32*((i//1024) % 2) - y = (i //32) - 32*((i//1024) % 2) - try: - palette = palettes[p] - tile = tiles[(tile_index+tile_adjust)%0x80] - tile.setColorTable(palette) - tile_px = QPixmap.fromImage(tile) - canvas.draw_pixmap(x, y, tile_px, h_flip, v_flip) - except BaseException as e: - print(e, p, hex(tile_index,2), hex(tile_adjust,2), hex(tile_index+tile_adjust,2)) - return canvas.pixmap(True) - -def make_battle_backgrounds(rom): - ''' - 21 pointers in memory for the compressed data of the tilesets. - Most of these are not unique, and only a subset of the resulting block is used. - The block appears to get DMA'd to 0x0400 in VRAM - - Terrain gets DMA'd to 0x2000 (size 0x500) in VRAM from 0x7f0000 in RAM - ''' - palettes = [generate_palette(rom, 0x14BB31+(i*0x20)) for i in range(84)] - battle_bgs = [] - for i in range(34): - bg = { - 'tiles_id': rom[0x14BA21+(i*8)], - 'pal1_id': rom[0x14BA22+(i*8)], - 'pal2_id': rom[0x14BA23+(i*8)], - 'terrain_id': rom[0x14BA24+(i*8)], - 'terrain_flips_id': rom[0x14BA25+(i*8)], - } - bg['palette'] = [palettes[0], palettes[bg['pal1_id']], palettes[bg['pal2_id']]] - battle_bgs.append(bg) - - tiles_pointer_start = 0x184196 - tiles_RAM_pointer_start = 0x184157 - tiles_pointers = [indirect(rom, tiles_pointer_start+(i*3), length=3)-0xC00000 for i in range(21)] - tiles_raw = [decompress_lzss(rom, p) for p in tiles_pointers] - tiles_skips = [indirect(rom, tiles_RAM_pointer_start+(i*3), length=3)-0x7FC000 for i in range(21)] - tiles = [] - for raw, skip in zip(tiles_raw, tiles_skips): - r = raw[skip:] - tiles.append([create_tile_indexed(r[i*32:(i+1)*32]) for i in range(len(r)//32)]) - - terrain_pointer_start = 0x14C86D - terrain_pointers = [indirect(rom, terrain_pointer_start+(i*2))+0x140000 for i in range(28)] - terrains = [decompress_battle_terrain(rom, p) for p in terrain_pointers] - - pixmaps = [] - for bg in battle_bgs: - terrain = apply_battle_terrain_flips(rom, bg['terrain_flips_id'], terrains[bg['terrain_id']]) - pixmaps.append(make_tilemap_pixmap(terrain, tiles[bg['tiles_id']], bg['palette'])) - #[make_tilemap_pixmap(terrains[5], tiles[2], palettes)] - return pixmaps - - -def make_battle_strip(rom, palette_address, tile_address, num_tiles, bpp=4): - if isinstance(palette_address, int): - palette = generate_palette(rom, palette_address, transparent=True) - else: - palette = palette_address - b = 24 if bpp==3 else 32 - battle_strip = Canvas(2, divceil(num_tiles, 2)) - for j in range(num_tiles): - offset = tile_address+(j*b) - battle_strip.draw_pixmap(j%2, j//2, create_tile(rom[offset:offset+b], palette)) - return battle_strip.pixmap() - -def get_zone_tiles_start(rom, id): - i1 = indirect(rom, 0x0E59C0+(id*2))+7 - i2 = indirect(rom, 0x0E59C2+i1, 1) - # There is a divergent path here based on the value. Other things appear to be affected by this. - if i2 > 0x67: - i3 = ((i2 - 0x67) << 11) + 0x1A0000 - elif i2 > 0x52: - i3 = ((i2 - 0x52) << 9) + 0x1A0000 - elif i2 > 0x4B: - i3 = ((i2 - 0x4B) << 11) + 0x1AC800 - elif i2 > 0x32: - i3 = ((i2 - 0x32) << 10) + 0x1A0000 - else: - i3 = (i2 << 9) + 0x1A0000 - return i3 - - -def make_character_battle_sprites_ff4(rom): - tile_address = 0xD0000 - pig_tile_address = 0xD7000 - golbez_tile_address = 0xD7600 - anna_tile_address = 0xD7960 - palette_address = 0xE7D00 - golbez_palette_address = 0xE7EC0 - anna_palette_address = 0xE7EE0 - battle_strips = [] - for i in range(0, 14*32, 32): # 14 regular characters. Pig, Golbez and Anna follow with different tile spacing and palette order. - battle_strips.append(make_battle_strip(rom, palette_address+i, tile_address+(i*64), 64)) # KO sprites are here which means more tiles per strip than FFV - battle_strips.append(make_battle_strip(rom, golbez_palette_address, golbez_tile_address, 27)) - battle_strips.append(make_battle_strip(rom, anna_palette_address, anna_tile_address, 14)) - for i in range(0, 16*32, 32): # 16 pigs. - battle_strips.append(make_battle_strip(rom, palette_address+i, pig_tile_address, 48)) - return battle_strips - -def make_character_field_sprites_ff4(rom): - tile_address = 0xD8000 - palette_address = 0x68000 - palettes = [generate_palette(rom, palette_address+i*16, transparent=True) for i in range(8)] - LUT = [0, 0, 1, 2, 2, 2, 0, 1, 1, 3, 0, 1, 0, 0, 0,0,0] - strips = [] - for p, i in zip(LUT, range(0, 17*24*32, 24*32)): # 14 regular characters. Mini, toad, pig. - strips.append(make_battle_strip(rom, palettes[p], tile_address+(i), 32, bpp=3)) - for palette in palettes: - for i in range(0, 42*24*16, 24*16): # 42 others - strips.append(make_battle_strip(rom, palette, tile_address+(17*24*32)+(i), 16, bpp=3)) - #for i in range(0, 16*24, 24): # 16 pigs. - #strips.append(make_battle_strip(rom, palette_address+i, tile_address, 48)) - return strips - -def make_character_portrait_sprites_ff4(rom): - # 4x4 tiles per character, all 3bpp - tile_address = 0xED3C0 - palette_address = 0x686D0 - palettes = [generate_palette(rom, palette_address+i*16, transparent=True) for i in range(14)] - portrait_images = [] - for t_start in [tile_address+i*16*24 for i in range(17)]: - canvas = Canvas_Indexed(4, 4) - for t in range(16): - offset = t_start+(t*24) - canvas.draw_tile(t%4, t//4, create_tile_indexed(rom[offset:offset+24])) - portrait_images.append(canvas) - - portraits = [] - for palette, portrait in zip(palettes, portrait_images): - portraits.append(portrait.pixmap(palette)) - for portrait in portrait_images[14:]: # 14, 15, 16 are Pig, Mini, Toad and use character palettes - for palette in palettes: - portraits.append(portrait.pixmap(palette)) - for palette in palettes: - for portrait in portrait_images[:14]: - portraits.append(portrait.pixmap(palette)) - return portraits - - -def make_character_battle_sprites_ff6(rom): - # Palettes are non-trivial for this, will need a LUT - tile_address = 0x150000 - palette_address = 0x268000 - battle_strips = [] - for i in range(0, 16*32, 32): # quite a few characters - battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*181), 181)) - tile_address += 16*181*32 - for i in range(0, 6*32, 32): # bonus memes - battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*171), 171)) - tile_address += 6*171*32 - for i in range(0, 4*32, 32): # bonus memes - battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*55), 55)) - tile_address += 4*55*32 - for i in range(0, 40*32, 32): # bonus memes - battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*56), 56)) - return battle_strips - -def make_character_portrait_sprites_ff6(rom): - # 5x5 tiles per character, annoying arrangement but palettes are good - tile_address = 0x2D1D00 - palette_address = 0x2D5860 - palettes = [generate_palette(rom, palette_address+i*32, transparent=True) for i in range(19)] - # Coordinates for each tile - LUT = [(0,0), (1,0), (2,0), (3,0), (0,2), (1,2), (2,2), (3,2), (4,0), (4,1), (4,2), (4,3), (4,4), (0,4), (1,4), (2,4), (0,1), (1,1), (2,1), (3,1), (0,3), (1,3), (2,3), (3,3), (3,4)] - portrait_images = [] - for t_start in [tile_address+i*25*32 for i in range(19)]: - canvas = Canvas_Indexed(5, 5) - for t in range(25): - offset = t_start+(t*32) - canvas.draw_tile(*LUT[t], create_tile_indexed(rom[offset:offset+32])) - portrait_images.append(canvas) - - portraits = [] - for palette, portrait in zip(palettes, portrait_images): - portraits.append(portrait.pixmap(palette)) - for palette in palettes: - for portrait in portrait_images: - portraits.append(portrait.pixmap(palette)) - return portraits - - -def make_character_battle_sprites(rom): - tile_address = 0x120000 - palette_address = 0x14A3C0 - battle_strips = [] - for i in range(0, (22*5)*32, 32): # 22 jobs 5 characters - battle_strips.append(make_battle_strip(rom, palette_address+i, tile_address+(i*48), 48)) - return battle_strips - - -def make_character_status_sprites(rom): - tile_address = 0x149400 - palette_address = 0x14A660 - pixmaps = [] - for i in range(5): - palette = generate_palette(rom, palette_address + (i*22*32), transparent=True) # Freelance palette per character - wounded = Canvas(3, 2) - for j in range(6): - offset = tile_address+(i*192)+(j*32) - wounded.draw_pixmap(j%3, j//3, create_tile(rom[offset:offset+32], palette)) - pixmaps.append(wounded.pixmap()) - mini_strip = Canvas(2, 19) - for j in range(38): - offset = tile_address+0x3C0+(j*24) - mini_strip.draw_pixmap(j%2, j//2, create_tile(rom[offset:offset+24], palette)) - pixmaps.append(mini_strip.pixmap()) - frog_strip = Canvas(2, 15) - for j in range(30): - offset = tile_address+0x750+(j*24) - frog_strip.draw_pixmap(j%2, j//2, create_tile(rom[offset:offset+24], palette)) - pixmaps.append(frog_strip.pixmap()) - return pixmaps - - -def make_string_img_small(bytestring, jp=False): if len(bytestring) < 1: raise ValueError('Empty bytestring was passed') - string = "" + string = '' img = QImage(len(bytestring)*8, 10, QImage.Format_RGB16) img.fill(bg_color) painter = QtGui.QPainter(img) @@ -839,22 +365,22 @@ def make_string_img_small(bytestring, jp=False): string = string + const.Glyphs_JP2[j] if 0x20 <= j < 0x52: if j > 0x48: - painter.drawPixmap(x*8, 2, glyph_sprites_jp_small[j+0x17]) - painter.drawPixmap(x*8+1,-5, glyph_sprites_jp_small[0x52]) + painter.drawPixmap(x*8, 2, glyphs[j+0x17]) + painter.drawPixmap(x*8+1,-5, glyphs[0x52]) else: - painter.drawPixmap(x*8, 2, glyph_sprites_jp_small[j+0x40]) - painter.drawPixmap(x*8+1,-6, glyph_sprites_jp_small[0x51]) + painter.drawPixmap(x*8, 2, glyphs[j+0x40]) + painter.drawPixmap(x*8+1,-6, glyphs[0x51]) else: - painter.drawPixmap(x*8, 2, glyph_sprites_jp_small[j]) + painter.drawPixmap(x*8, 2, glyphs[j]) else: for x, j in enumerate(bytestring): string = string + const.Glyphs[j] - painter.drawPixmap(x*8, 1, glyph_sprites_en_small[j]) + painter.drawPixmap(x*8, 1, glyphs[j]) del painter return string, QPixmap.fromImage(img) -def make_string_img_large(bytestring, macros=None, jp=False): +def make_string_img_large(bytestring, glyphs, glyphs_kanji, macros=None, jp=False): ''' This is how we decipher dialogue data, which has multiple lines, macro expansions and kanji. English characters have varying widths. In the japanese version, everything is fullwidth (16px) @@ -874,7 +400,7 @@ def make_string_img_large(bytestring, macros=None, jp=False): else: newstring.append(b) - string = "" + string = '' # Because the length of the input has little bearing on the size of the image thanks to linebreaks and macros, we overprovision then clip away. max_width = 256 # This seems to check out, but the EN dialogue has linebreaks virtually everywhere anyway max_height = 1024 # I've seen up to 58 rows in EN, 36 in JP. Stay safe. @@ -896,26 +422,29 @@ def make_string_img_large(bytestring, macros=None, jp=False): y += 16 elif 0x1E00 <= j < 0x1FAA: # Kanji live in this range string += const.Glyphs_Kanji[j-0x1E00] - painter.drawPixmap(x, y+2, glyph_sprites_kanji[j-0x1E00]) + painter.drawPixmap(x, y+2, glyphs_kanji[j-0x1E00]) x += 16 elif j < 0x13 or j > 0xFF: # Everything remaining outside this is a control char string += '[0x{:02X}]'.format(j) else: if jp: string += const.Glyphs_JP_large[j] - painter.drawPixmap(x, y+2, glyph_sprites_jp_large[j]) + painter.drawPixmap(x, y+2, glyphs[j]) x += 16 else: string += const.Glyphs[j] - painter.drawPixmap(x, y+4, glyph_sprites_en_large[j]) + painter.drawPixmap(x, y+4, glyphs[j]) x += const.Dialogue_Width[j] del painter xmax = x if x > xmax else xmax return string, QPixmap.fromImage(img.copy(0, 0, xmax, y+16)) -def make_string_img_list(start, length, num, start_jp=None, len_jp=None, start_str=None, start_jp_str=None, - indirect=False, large=False, macros_en=None, macros_jp=None): +def _make_string_img_list(start, length, num, + start_jp=None, len_jp=None, start_str=None, start_jp_str=None, + indirect=False, large=False, macros_en=None, macros_jp=None, + glyphs_en_s=None, glyphs_en_l=None, + glyphs_jp_s=None, glyphs_jp_l=None, glyphs_kanji=None): start_jp = start if start_jp is None else start_jp len_jp = length if len_jp is None else len_jp start_str = start if start_str is None else start_str @@ -941,17 +470,17 @@ def make_string_img_list(start, length, num, start_jp=None, len_jp=None, start_s break try: # When dealing with pointer redirection we might end up passing empty strings if large: - str_en, img_en = make_string_img_large(ROM_en[en_start:en_end], macros_en) + str_en, img_en = make_string_img_large(ROM_en[en_start:en_end], glyphs_en_l, glyphs_kanji, macros_en) else: - str_en, img_en = make_string_img_small(ROM_en[en_start:en_end]) + str_en, img_en = make_string_img_small(ROM_en[en_start:en_end], glyphs_en_s) except ValueError: str_en = '' img_en = None try: if large: - str_jp, img_jp = make_string_img_large(ROM_jp[jp_start:jp_end], macros_jp, jp=True) + str_jp, img_jp = make_string_img_large(ROM_jp[jp_start:jp_end], glyphs_jp_l, glyphs_kanji, macros_jp, jp=True) else: - str_jp, img_jp = make_string_img_small(ROM_jp[jp_start:jp_end], jp=True) + str_jp, img_jp = make_string_img_small(ROM_jp[jp_start:jp_end], glyphs_jp_s, jp=True) except ValueError: str_jp = '' img_jp = None @@ -964,114 +493,14 @@ def make_string_img_list(start, length, num, start_jp=None, len_jp=None, start_s j1 = start + (id*length) j2 = start_jp + (id*len_jp) if large: - str_en, img_en = make_string_img_large(ROM_en[j1:j1+length], macros_en) - str_jp, img_jp = make_string_img_large(ROM_jp[j2:j2+len_jp], macros_jp, jp=True) + str_en, img_en = make_string_img_large(ROM_en[j1:j1+length], glyphs_en_l, glyphs_kanji, macros_en) + str_jp, img_jp = make_string_img_large(ROM_jp[j2:j2+len_jp], glyphs_jp_l, glyphs_kanji, macros_jp, jp=True) else: - str_en, img_en = make_string_img_small(ROM_en[j1:j1+length]) - str_jp, img_jp = make_string_img_small(ROM_jp[j2:j2+len_jp], jp=True) + str_en, img_en = make_string_img_small(ROM_en[j1:j1+length], glyphs_en_s) + str_jp, img_jp = make_string_img_small(ROM_jp[j2:j2+len_jp], glyphs_jp_s, jp=True) stringlist.append([hex(j1, 6), hex(id, id_digits), str_en, img_en, str_jp, img_jp]) return stringlist - -def table_size_to_contents(table): - # Stupid hack to get table to size correctly - table.hide() - geometry = table.viewport().geometry() - table.viewport().setGeometry(QtCore.QRect(0, 0, 0x7FFFFFFF, 0x7FFFFFFF)) - table.resizeColumnsToContents() - table.resizeRowsToContents() - table.viewport().setGeometry(geometry) - table.show() - - -def make_table(headers, items, sortable=False, row_labels=True, scale=2): - ''' - Helper function to tabulate 2d lists - ''' - cols = len(headers) - rows = len(items) - rd = hex_length(rows-1) - table = QTableWidget(rows, cols) - if row_labels: - table.setVerticalHeaderLabels([hex(v, rd) for v in range(rows)]) - else: - table.verticalHeader().setVisible(False) - table.setHorizontalHeaderLabels(headers) - for row, col, item in [(x,y,items[x][y]) for x in range(rows) for y in range(cols)]: - if isinstance(item, QWidget): - table.setCellWidget(row, col, item) - elif isinstance(item, QPixmap): - pix = item.scaled(item.size() * scale) - lab = QLabel() - lab.setPixmap(pix) - table.setCellWidget(row, col, lab) - elif item is not None: - if item.endswith('₁₆'): - s = '{}16'.format(item[:-2]) - lab = QLabel(s) - table.setCellWidget(row, col, lab) - else: - q_item = QTableWidgetItem(item) - if item.startswith(HEX_PREFIX): - q_item.setFont(monofont) - table.setItem(row, col, q_item) - table_size_to_contents(table) - if sortable: - table.setSortingEnabled(True) - table.sortItems(0) - return table - - -def make_pixmap_table(items, cols=16, scale=4, large=False): - rows = divceil(len(items), cols) - rd = hex_length(rows-1)+1 - cd = hex_length(cols-1) - table = QTableWidget(rows, cols) - if large: - table.setHorizontalScrollMode(QAbstractItemView.ScrollPerPixel) - table.setVerticalScrollMode(QAbstractItemView.ScrollPerPixel) - table.setVerticalHeaderLabels([hex(v*cols, rd) for v in range(rows)]) - table.setHorizontalHeaderLabels([hex(v, cd) for v in range(cols)]) - for i, item in enumerate(items): - if isinstance(item, QWidget): - table.setCellWidget(i // cols, i % cols, item) - elif isinstance(item, QPixmap): - lab = QLabel() - lab.setPixmap(item.scaled(item.size() * scale)) - lab.setAlignment(QtCore.Qt.AlignCenter) - table.setCellWidget(i // cols, i % cols, lab) - table_size_to_contents(table) - return table - - -def stack_labels(*items): - w = QWidget() - w.setContentsMargins(0, 0, 0, 0) - l = QVBoxLayout() - l.setAlignment(QtCore.Qt.AlignCenter) - l.setSpacing(0) - l.setContentsMargins(0, 0, 0, 0) - for item in items: - lab = QLabel() - if isinstance(item, QPixmap): - lab.setPixmap(item) - else: - lab.setText(item.strip()) - lab.setAlignment(QtCore.Qt.AlignCenter) - lab.setMargin(0) - l.addWidget(lab) - w.setLayout(l) - return w - - -def hex(num, digits): - # Consolidate formatting for consistency - #return '{:0{}X}₁₆'.format(num, digits) - return HEX_PREFIX + '{:0{}X}'.format(num, digits) - -def indirect(rom, start, length=2): - return int.from_bytes(rom[start:start+length], 'little') - last_perfcount = None def perfcount(): ''' diff --git a/const.py b/includes/const.py similarity index 95% rename from const.py rename to includes/const.py index 736a3f7..2f4ac31 100644 --- a/const.py +++ b/includes/const.py @@ -1,5 +1,18 @@ ''' -No license for now + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . ''' small_palette = [0xFF000000, 0x00000080, 0xFF808080, 0xFFFFFFFF] dialogue_palette = [0xFF000080, 0xFFFFFFFF] @@ -107,7 +120,6 @@ Glyphs_Kanji = ( '滅', '囗', '極', '湖', '利', '周', '緑', '切', # 0x198 '紙', '胸', '平', '和', '宇', '宙', '則', '孤', # 0x1A0 '溝', '　') # 0x1A8 -#Glyphs_Kanji = [g if g != '　' else '<${:03X}>'.format(i) for (i, g) in enumerate(Glyphs_Kanji1)] # This is only until they are fully transcribed Dialogue_Macros_EN = { 0x02: [0x61, 0x7A, 0x8B, 0x8D, 0x93], # expands to Bartz (or whatever his name is) diff --git a/includes/ff4.py b/includes/ff4.py new file mode 100644 index 0000000..87206fb --- /dev/null +++ b/includes/ff4.py @@ -0,0 +1,82 @@ +''' + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . +''' + +from includes.snes import * +from includes.snestile import ( + generate_glyphs, generate_glyphs_large, generate_palette, + create_tile, create_tile_indexed, + create_tile_mode7_compressed, create_tile_mode7_compressed_indexed, + bg_color, bg_trans, + Canvas, Canvas_Indexed + ) + + +def make_character_battle_sprites(rom): + tile_address = 0xD0000 + pig_tile_address = 0xD7000 + golbez_tile_address = 0xD7600 + anna_tile_address = 0xD7960 + palette_address = 0xE7D00 + golbez_palette_address = 0xE7EC0 + anna_palette_address = 0xE7EE0 + battle_strips = [] + for i in range(0, 14*32, 32): # 14 regular characters. Pig, Golbez and Anna follow with different tile spacing and palette order. + battle_strips.append(make_battle_strip(rom, palette_address+i, tile_address+(i*64), 64)) # KO sprites are here which means more tiles per strip than FFV + battle_strips.append(make_battle_strip(rom, golbez_palette_address, golbez_tile_address, 27)) + battle_strips.append(make_battle_strip(rom, anna_palette_address, anna_tile_address, 14)) + for i in range(0, 16*32, 32): # 16 pigs. + battle_strips.append(make_battle_strip(rom, palette_address+i, pig_tile_address, 48)) + return battle_strips + +def make_character_field_sprites(rom): + tile_address = 0xD8000 + palette_address = 0x68000 + palettes = [generate_palette(rom, palette_address+i*16, transparent=True) for i in range(8)] + LUT = [0, 0, 1, 2, 2, 2, 0, 1, 1, 3, 0, 1, 0, 0, 0,0,0] + strips = [] + for p, i in zip(LUT, range(0, 17*24*32, 24*32)): # 14 regular characters. Mini, toad, pig. + strips.append(make_battle_strip(rom, palettes[p], tile_address+(i), 32, bpp=3)) + for palette in palettes: + for i in range(0, 42*24*16, 24*16): # 42 others + strips.append(make_battle_strip(rom, palette, tile_address+(17*24*32)+(i), 16, bpp=3)) + #for i in range(0, 16*24, 24): # 16 pigs. + #strips.append(make_battle_strip(rom, palette_address+i, tile_address, 48)) + return strips + +def make_character_portrait_sprites(rom): + # 4x4 tiles per character, all 3bpp + tile_address = 0xED3C0 + palette_address = 0x686D0 + palettes = [generate_palette(rom, palette_address+i*16, transparent=True) for i in range(14)] + portrait_images = [] + for t_start in [tile_address+i*16*24 for i in range(17)]: + canvas = Canvas_Indexed(4, 4) + for t in range(16): + offset = t_start+(t*24) + canvas.draw_tile(t%4, t//4, create_tile_indexed(rom[offset:offset+24])) + portrait_images.append(canvas) + + portraits = [] + for palette, portrait in zip(palettes, portrait_images): + portraits.append(portrait.pixmap(palette)) + for portrait in portrait_images[14:]: # 14, 15, 16 are Pig, Mini, Toad and use character palettes + for palette in palettes: + portraits.append(portrait.pixmap(palette)) + for palette in palettes: + for portrait in portrait_images[:14]: + portraits.append(portrait.pixmap(palette)) + return portraits diff --git a/includes/ff6.py b/includes/ff6.py new file mode 100644 index 0000000..dc5f7a1 --- /dev/null +++ b/includes/ff6.py @@ -0,0 +1,67 @@ +''' + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . +''' + +from includes.snes import * +from includes.snestile import ( + generate_glyphs, generate_glyphs_large, generate_palette, + create_tile, create_tile_indexed, + create_tile_mode7_compressed, create_tile_mode7_compressed_indexed, + bg_color, bg_trans, + Canvas, Canvas_Indexed + ) + + +def make_character_battle_sprites(rom): + # Palettes are non-trivial for this, will need a LUT + tile_address = 0x150000 + palette_address = 0x268000 + battle_strips = [] + for i in range(0, 16*32, 32): # quite a few characters + battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*181), 181)) + tile_address += 16*181*32 + for i in range(0, 6*32, 32): # bonus memes + battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*171), 171)) + tile_address += 6*171*32 + for i in range(0, 4*32, 32): # bonus memes + battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*55), 55)) + tile_address += 4*55*32 + for i in range(0, 40*32, 32): # bonus memes + battle_strips.append(make_battle_strip(rom, palette_address+0x80, tile_address+(i*56), 56)) + return battle_strips + +def make_character_portrait_sprites(rom): + # 5x5 tiles per character, annoying arrangement but palettes are good + tile_address = 0x2D1D00 + palette_address = 0x2D5860 + palettes = [generate_palette(rom, palette_address+i*32, transparent=True) for i in range(19)] + # Coordinates for each tile + LUT = [(0,0), (1,0), (2,0), (3,0), (0,2), (1,2), (2,2), (3,2), (4,0), (4,1), (4,2), (4,3), (4,4), (0,4), (1,4), (2,4), (0,1), (1,1), (2,1), (3,1), (0,3), (1,3), (2,3), (3,3), (3,4)] + portrait_images = [] + for t_start in [tile_address+i*25*32 for i in range(19)]: + canvas = Canvas_Indexed(5, 5) + for t in range(25): + offset = t_start+(t*32) + canvas.draw_tile(*LUT[t], create_tile_indexed(rom[offset:offset+32])) + portrait_images.append(canvas) + + portraits = [] + for palette, portrait in zip(palettes, portrait_images): + portraits.append(portrait.pixmap(palette)) + for palette in palettes: + for portrait in portrait_images: + portraits.append(portrait.pixmap(palette)) + return portraits diff --git a/includes/helpers.py b/includes/helpers.py new file mode 100644 index 0000000..e335941 --- /dev/null +++ b/includes/helpers.py @@ -0,0 +1,95 @@ +''' + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . +''' + +HEX_PREFIX = '#' # '$' or '0x' are also nice + +def divceil(numerator, denominator): + ''' + Reverse floor division for fast ceil + ''' + return -(-numerator // denominator) + +def hex_length(i): + ''' + String length of hexadecimal representation of integer + ''' + return divceil(i.bit_length(), 4) + +def hex(num, digits): + ''' + Consolidate hex formatting for consistency + ''' + #return '{:0{}X}₁₆'.format(num, digits) + return HEX_PREFIX + '{:0{}X}'.format(num, digits) + +def indirect(rom, start, length=2): + ''' + Read little-endian value at start address in rom + ''' + return int.from_bytes(rom[start:start+length], 'little') + +def parse_struct(rom, offset, structure): + ''' + Read in a section of rom with a given structure, output a list + ''' + out = [hex(offset, 6)] + j = 0 + for title, length, handler in structure: + val = indirect(rom, offset+j, length=length) + if callable(handler): + out.append(handler(val)) + elif handler and val < len(handler): + out.append(handler[val]) + else: + out.append(hex(val, length*2)) + j += length + return out + + +def decompress_lzss(rom, start, header=False): + ''' + Algorithm from http://slickproductions.org/slickwiki/index.php/Noisecross:Final_Fantasy_V_Compression + ''' + uncompressed_length = indirect(rom, start) + ptr = start+2 + output = [] + buffer = [0 for i in range(0x800)] + buffer_p = 0x07DE + while len(output) < uncompressed_length: + bitmap_byte = rom[ptr] + ptr += 1 + for i in range(8): + bit = (bitmap_byte >> i) & 1 + if bit: + b = rom[ptr] + ptr += 1 + output.append(b) + buffer[buffer_p] = b + buffer_p = (buffer_p+1) % 0x800 + else: + b1 = rom[ptr] + b2 = rom[ptr+1] + ptr += 2 + offset = b1|((b2 & 0xE0)<<3) + length = b2 & 0x1F + for j in range(length+3): + b = buffer[offset] + output.append(b) + buffer[buffer_p] = b + buffer_p = (buffer_p+1) % 0x800 + offset = (offset+1) % 0x800 + return bytes(output[:uncompressed_length]) diff --git a/includes/qthelpers.py b/includes/qthelpers.py new file mode 100644 index 0000000..e72d96e --- /dev/null +++ b/includes/qthelpers.py @@ -0,0 +1,173 @@ +''' + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . +''' + +import sys, os +from includes.helpers import * + +pyqt_version = 0 +skip_pyqt5 = 'PYQT4' in os.environ + +if not skip_pyqt5: + try: + from PyQt5 import QtGui, QtCore + from PyQt5.QtGui import QIcon, QPalette, QColor, QFont, QFontInfo, QImage, QPixmap + from PyQt5.QtWidgets import ( + QApplication, QMainWindow, QFormLayout, + QGridLayout, QHBoxLayout, QVBoxLayout, + QAbstractItemView, QHeaderView, QListWidget, + QListWidgetItem, QTabWidget, QTableWidget, + QTableWidgetItem, QFrame, QScrollArea, + QStackedWidget, QWidget, QCheckBox, QComboBox, + QDoubleSpinBox, QGroupBox, QLineEdit, + QPushButton, QRadioButton, QSpinBox, + QStyleOptionButton, QToolButton, QProgressBar, + QDialog, QColorDialog, QDialogButtonBox, + QFileDialog, QInputDialog, QMessageBox, + QAction, QActionGroup, QLabel, QMenu, QStyle, + QSystemTrayIcon, QStyleOptionProgressBar + ) + pyqt_version = 5 + except ImportError: + print("Couldn't import Qt5 dependencies. " + 'Make sure you installed the PyQt5 package.') +if pyqt_version == 0: + try: + import sip + sip.setapi('QVariant', 2) + from PyQt4 import QtGui, QtCore + from PyQt4.QtGui import ( + QApplication, QMainWindow, QFormLayout, + QGridLayout, QHBoxLayout, QVBoxLayout, + QAbstractItemView, QHeaderView, QListWidget, + QListWidgetItem, QTabWidget, QTableWidget, + QTableWidgetItem, QFrame, QScrollArea, + QStackedWidget, QWidget, QCheckBox, + QComboBox, QDoubleSpinBox, QGroupBox, + QLineEdit, QPushButton, QRadioButton, + QSpinBox, QStyleOptionButton, QToolButton, + QProgressBar, QDialog, QColorDialog, + QDialogButtonBox, QFileDialog, QInputDialog, + QMessageBox, QAction, QActionGroup, + QLabel, QMenu, QStyle, + QSystemTrayIcon, QIcon, QPalette, QColor, + QValidator, QFont, QFontInfo, QImage, QPixmap + ) + from PyQt4.QtGui import QStyleOptionProgressBarV2 as QStyleOptionProgressBar + pyqt_version = 4 + except ImportError: + print("Couldn't import Qt dependencies. " + 'Make sure you installed the PyQt4 package.') + sys.exit(-1) + + +monofont = QFont() +monofont.setStyleHint(QFont.Monospace) +if not monofont.fixedPitch(): + monofont.setStyleHint(QFont.TypeWriter) +if not monofont.fixedPitch(): + monofont.setFamily('Monospace') + + +def table_size_to_contents(table): + # Stupid hack to get table to size correctly + table.hide() + geometry = table.viewport().geometry() + table.viewport().setGeometry(QtCore.QRect(0, 0, 0x7FFFFFFF, 0x7FFFFFFF)) + table.resizeColumnsToContents() + table.resizeRowsToContents() + table.viewport().setGeometry(geometry) + table.show() + + +def make_table(headers, items, sortable=False, row_labels=True, scale=2): + ''' + Helper function to tabulate 2d lists + ''' + cols = len(headers) + rows = len(items) + rd = hex_length(rows-1) + table = QTableWidget(rows, cols) + if row_labels: + table.setVerticalHeaderLabels([hex(v, rd) for v in range(rows)]) + else: + table.verticalHeader().setVisible(False) + table.setHorizontalHeaderLabels(headers) + for row, col, item in [(x,y,items[x][y]) for x in range(rows) for y in range(cols)]: + if isinstance(item, QWidget): + table.setCellWidget(row, col, item) + elif isinstance(item, QPixmap): + pix = item.scaled(item.size() * scale) + lab = QLabel() + lab.setPixmap(pix) + table.setCellWidget(row, col, lab) + elif item is not None: + if item.endswith('₁₆'): + s = '{}16'.format(item[:-2]) + lab = QLabel(s) + table.setCellWidget(row, col, lab) + else: + q_item = QTableWidgetItem(item) + if item.startswith(HEX_PREFIX): + q_item.setFont(monofont) + table.setItem(row, col, q_item) + table_size_to_contents(table) + if sortable: + table.setSortingEnabled(True) + table.sortItems(0) + return table + + +def make_pixmap_table(items, cols=16, scale=4, large=False): + rows = divceil(len(items), cols) + rd = hex_length(rows-1)+1 + cd = hex_length(cols-1) + table = QTableWidget(rows, cols) + if large: + table.setHorizontalScrollMode(QAbstractItemView.ScrollPerPixel) + table.setVerticalScrollMode(QAbstractItemView.ScrollPerPixel) + table.setVerticalHeaderLabels([hex(v*cols, rd) for v in range(rows)]) + table.setHorizontalHeaderLabels([hex(v, cd) for v in range(cols)]) + for i, item in enumerate(items): + if isinstance(item, QWidget): + table.setCellWidget(i // cols, i % cols, item) + elif isinstance(item, QPixmap): + lab = QLabel() + lab.setPixmap(item.scaled(item.size() * scale)) + lab.setAlignment(QtCore.Qt.AlignCenter) + table.setCellWidget(i // cols, i % cols, lab) + table_size_to_contents(table) + return table + + +def stack_labels(*items): + w = QWidget() + w.setContentsMargins(0, 0, 0, 0) + l = QVBoxLayout() + l.setAlignment(QtCore.Qt.AlignCenter) + l.setSpacing(0) + l.setContentsMargins(0, 0, 0, 0) + for item in items: + lab = QLabel() + if isinstance(item, QPixmap): + lab.setPixmap(item) + else: + lab.setText(item.strip()) + lab.setAlignment(QtCore.Qt.AlignCenter) + lab.setMargin(0) + l.addWidget(lab) + w.setLayout(l) + return w diff --git a/includes/snes.py b/includes/snes.py new file mode 100644 index 0000000..fbaeee7 --- /dev/null +++ b/includes/snes.py @@ -0,0 +1,356 @@ +''' +Functions common to SNES FFs +''' +''' + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . +''' + +from includes.helpers import * +from includes.snestile import * + + +def make_battle_strip(rom, palette_address, tile_address, num_tiles, bpp=4): + if isinstance(palette_address, int): + palette = generate_palette(rom, palette_address, transparent=True) + else: + palette = palette_address + b = 24 if bpp==3 else 32 + battle_strip = Canvas(2, divceil(num_tiles, 2)) + for j in range(num_tiles): + offset = tile_address+(j*b) + battle_strip.draw_pixmap(j%2, j//2, create_tile(rom[offset:offset+b], palette)) + return battle_strip.pixmap() + +def make_enemy_sprites(rom): + sprites = [] + for e_id in range(0, 0x180*5, 5): + triplane = bool(rom[0x14B180+e_id]&0x80) # True if 3 planes, False if 4 + bytes_per_tile = 24 if triplane else 32 + tile_offset = ((((rom[0x14B180+e_id]&0x7F)<<8)| rom[0x14B181+e_id]) << 3) + 0x150000 # For whatever reason this is big endian + pal_offset = ((((rom[0x14B182+e_id]&0x03)<<8)| rom[0x14B183+e_id]) << 4) + 0x0ED000 # For whatever reason this is big endian + pal_size = 16 if triplane else 32 + palette = generate_palette(rom, pal_offset, pal_size, transparent=True) + layout_id = rom[0x14B184+e_id] + boss_layout = bool(rom[0x14B182+e_id]&0x80) + if boss_layout: + layout = rom[0x10D334+(layout_id<<5):0x10D334+(layout_id<<5)+32] + sprite = Canvas(16, 16) + for x, y in [(x,y) for y in range(16) for x in range(16)]: + if (int.from_bytes(layout[y*2:y*2+2], 'little') & (0x8000 >> x)): + sprite.draw_pixmap(x, y, create_tile(rom[tile_offset:tile_offset+bytes_per_tile], palette)) + tile_offset += bytes_per_tile + else: + layout = rom[0x10D004+(layout_id<<3):0x10D004+(layout_id<<3)+8] + sprite = Canvas(8, 8) + for x, y in [(x,y) for y in range(8) for x in range(8)]: + if (layout[y] & (0x80 >> x)): + sprite.draw_pixmap(x, y, create_tile(rom[tile_offset:tile_offset+bytes_per_tile], palette)) + tile_offset += bytes_per_tile + + # TODO: Shadow stuff + sprites.append(sprite.pixmap(True)) + return sprites + +def make_character_battle_sprites(rom): + tile_address = 0x120000 + palette_address = 0x14A3C0 + battle_strips = [] + for i in range(0, (22*5)*32, 32): # 22 jobs 5 characters + battle_strips.append(make_battle_strip(rom, palette_address+i, tile_address+(i*48), 48)) + return battle_strips + +def make_character_status_sprites(rom): + tile_address = 0x149400 + palette_address = 0x14A660 + pixmaps = [] + for i in range(5): + palette = generate_palette(rom, palette_address + (i*22*32), transparent=True) # Freelance palette per character + wounded = Canvas(3, 2) + for j in range(6): + offset = tile_address+(i*192)+(j*32) + wounded.draw_pixmap(j%3, j//3, create_tile(rom[offset:offset+32], palette)) + pixmaps.append(wounded.pixmap()) + mini_strip = Canvas(2, 19) + for j in range(38): + offset = tile_address+0x3C0+(j*24) + mini_strip.draw_pixmap(j%2, j//2, create_tile(rom[offset:offset+24], palette)) + pixmaps.append(mini_strip.pixmap()) + frog_strip = Canvas(2, 15) + for j in range(30): + offset = tile_address+0x750+(j*24) + frog_strip.draw_pixmap(j%2, j//2, create_tile(rom[offset:offset+24], palette)) + pixmaps.append(frog_strip.pixmap()) + return pixmaps + + +def make_worldmap_subtiles(rom, tiles_address, lut_address, length=0x100): + subtiles = [] + for i in range(length): + pal_index = rom[lut_address+i]//16 + subtiles.append(create_tile_mode7_compressed_indexed(rom[tiles_address+i*32:tiles_address+i*32+32], pal_index)) + return subtiles + +def stitch_worldmap_tiles(rom, subtiles, offset=0x0FF0C0): + tiles = [] + for i in range(0xC0): + canvas = Canvas_Indexed(2, 2) + for j in range(4): + k = indirect(rom, offset+(j*0xC0)+i, length=1) + canvas.draw_tile(j%2, j//2, subtiles[k]) + tiles.append(canvas.image) + return tiles + +def make_worldmap_tiles(rom, tiles_address, subtiles_address, lut_address, length=0x100): + return stitch_worldmap_tiles(rom, make_worldmap_subtiles(rom, subtiles_address, lut_address, length=length), tiles_address) + +def make_worldmap_subtiles_pixmap(rom, tiles_address, lut_address, palette_address, length=0x100): + tiles = [] + palettes = [generate_palette(rom, palette_address+i*32, transparent=True) for i in range(16)] + for i in range(length): + palette = palettes[rom[lut_address+i]//16] + tiles.append(create_tile_mode7_compressed(rom[tiles_address+i*32:tiles_address+i*32+32], palette)) + return tiles + +def make_worldmap_chunk(rom, id, length=256): + i = indirect(rom, 0x0FE000+(id*2)) + 0x070000 + if id > 0x433: + i += 0x010000 + mountains = (0x0C, 0x1C, 0x2C) + chunk = [] + while len(chunk) < length: + j = indirect(rom, i, 1) + if j >= 0xC0: + k = j-0xBF + i += 1 + j = indirect(rom, i, 1) + chunk += [j]*k + elif j in mountains: + chunk += [j, j+1, j+2] + else: + chunk.append(j) + i += 1 + return chunk + +def make_worldmap_chunk_pixmap(rom, id, palette_address, tiles): + chunk = make_worldmap_chunk(rom, id) + palette = generate_palette(rom, palette_address, length=0x320, transparent=True) + canvas = Canvas_Indexed(len(chunk), 1, tilesize=16) + for i, c in enumerate(chunk): + canvas.draw_tile(i, 0, tiles[c]) + return canvas.pixmap(palette) + +def make_worldmap_pixmap(rom, map_id, palette_address, tiles): + id_offset = map_id*256 + palette = generate_palette(rom, palette_address, length=0x320, transparent=True) + canvas = Canvas_Indexed(256, 256, tilesize=16) + for j in range(256): + chunk = make_worldmap_chunk(rom, j+id_offset) + for i, c in enumerate(chunk): + canvas.draw_tile(i, j, tiles[c]) + return canvas.pixmap(palette) + +def make_field_tiles(rom, id): + tiles_address = indirect(rom, 0x1C2D84 + id*4, length=4) + 0x1C2E24 + return [create_tile_indexed(rom[tiles_address+i*32:tiles_address+i*32+32]) for i in range(256)] + +def make_field_minitiles(rom, id): + tiles_address = indirect(rom, 0x1C0000 + id*2) + 0x1C0024 + return [create_tile_indexed(rom[tiles_address+i*16:tiles_address+i*16+16]) for i in range(256)] + +def make_all_field_tiles(rom): + return [make_field_tiles(rom, i) for i in range(40)] + +def make_all_field_minitiles(rom): + return [make_field_minitiles(rom, i) for i in range(18)] + +def stitch_tileset(tiles): + canvas = Canvas_Indexed(16, len(tiles)//16) + for i, tile in enumerate(tiles): + canvas.draw_tile(i%16, i//16, tile) + return canvas + +def get_field_map_tiles(rom, id): + ''' + This is a bit of a mess of pointer chains for now, so generalising it will have to wait. + Palette selection is probably determined by the tilemap which is outside the scope of this, so we'll just use #1. + UPDATE: i2-i7 merely obtain a zone ID. Whoops. + ''' + #i2 = indirect(rom, 0x0E2400 + id*2) + #i3 = indirect(rom, 0x0E2402 + i2)*2 + #i4 = indirect(rom, 0x18E080 + i3) + #i5 = indirect(rom, 0x18E081 + i4+4)*3 + #i6 = indirect(rom, 0x083320 + i5) + #i7 = indirect(rom, 0x080001 + i6) & 0x03FF + i8 = id * 0x1A + tilesets = indirect(rom, 0x0E9C09 + i8, length=3) + tile_index_0 = (tilesets & 0x00003F) # (indirect(rom, 0x0E9C09 + i8) & 0x003F) + tile_index_1 = (tilesets & 0x000FC0) >> 6 # (indirect(rom, 0x0E9C09 + i8) & 0x0FC0)>>6 + tile_index_2 = (tilesets & 0x03F000) >> 12 # (indirect(rom, 0x0E9C0A + i8) & 0x03F0)>>4 + minitile_index = (tilesets & 0xFC0000) >> 18 # (indirect(rom, 0x0E9C0A + i8) & 0x03F0)>>4 + pal_offset = indirect(rom, 0x0E9C16 + i8) * 0x100 + palette_address = 0x03BB00 + pal_offset + palettes = [generate_palette(rom, palette_address+i*32, transparent=True) for i in range(8)] + return tile_index_0, tile_index_1, tile_index_2, minitile_index, palettes + +def make_field_map_tile_pixmap(rom, id, st_tiles, st_minitiles): + *tiles, minitile, palettes = get_field_map_tiles(rom, id) + p = palettes[1] + canvas = Canvas(16, 64) + for i, ts in enumerate(tiles): + canvas.draw_pixmap(0, i*16, st_tiles[ts].pixmap(p)) + canvas.draw_pixmap(0, 48, st_minitiles[minitile].pixmap(p)) + return canvas.pixmap() + +def decompress_battle_terrain(rom, address): + ''' + Decompresses the tilemap for a battle background. + Battle BGs use a type of RLE with 2byte repeat and 1byte incremental repeat. + ''' + length = 0x500 + output = [0 for i in range(length)] + o1 = [] + ptr = address + while len(o1) < length//2: + a = rom[ptr] + ptr += 1 + if a != 0xFF: + o1.append(a) + else: + repeat = rom[ptr] + ptr += 1 + if repeat & 0x80: # Repeat 2 tiles + repeat &= 0x3F + a, b = rom[ptr:ptr+2] + ptr += 2 + o1 += [a, b]*repeat + else: # Incremental repeat + a, inc = rom[ptr:ptr+2] + ptr += 2 + if repeat & 0x40: # Negative increment + inc = -inc + repeat &= 0x3F + o1 += [a+(i*inc) for i in range(repeat)] + o2 = [4*(1+(i>>7)) for i in o1] + output[::2] = [i|0x80 for i in o1[:length//2]] + output[1::2] = [i&0xDF for i in o2[:length//2]] + return bytes(output) + +def apply_battle_terrain_flips(rom, id, battle_terrain): + if id==0xFF: + return battle_terrain + ptr = indirect(rom, 0x14C736+(id*2))+0x140000 + length = len(battle_terrain)//2 + output = list(battle_terrain) + buffer = [] + + while len(buffer) < length: + a = rom[ptr] + ptr += 1 + if a == 0x00: + skip = rom[ptr] + ptr += 1 + buffer += [0]*skip*8 + else: + for b in reversed(range(0, 8, 1)): + buffer.append((a>>b)&0x01) + + for i in range(len(battle_terrain)//2): + output[i*2+1] |= (buffer[i] << 6) + return bytes(output) + +def make_tilemap_pixmap(tilemap, tiles, palettes, tile_adjust=0): + ''' + Battle bg is 64x64 map size, 8x8 tile size + 4bpp tiles + ''' + canvas = Canvas(64, 64) + for i in range(len(tilemap)//2): + a, b = tilemap[i*2:(i+1)*2] + tile_index = a|((b & 0x02) << 8) + p = (b & 0x1C) >> 2 + priority = (b & 0x20) >> 5 + h_flip = (b & 0x40) >> 6 + v_flip = (b & 0x80) >> 7 + + x = (i % 32) + 32*((i//1024) % 2) + y = (i //32) - 32*((i//1024) % 2) + try: + palette = palettes[p] + tile = tiles[(tile_index+tile_adjust)%0x80] + tile.setColorTable(palette) + tile_px = QPixmap.fromImage(tile) + canvas.draw_pixmap(x, y, tile_px, h_flip, v_flip) + except BaseException as e: + print(e, p, hex(tile_index,2), hex(tile_adjust,2), hex(tile_index+tile_adjust,2)) + return canvas.pixmap(True) + +def make_battle_backgrounds(rom): + ''' + 21 pointers in memory for the compressed data of the tilesets. + Most of these are not unique, and only a subset of the resulting block is used. + The block appears to get DMA'd to 0x0400 in VRAM + + Terrain gets DMA'd to 0x2000 (size 0x500) in VRAM from 0x7f0000 in RAM + ''' + palettes = [generate_palette(rom, 0x14BB31+(i*0x20)) for i in range(84)] + battle_bgs = [] + for i in range(34): + bg = { + 'tiles_id': rom[0x14BA21+(i*8)], + 'pal1_id': rom[0x14BA22+(i*8)], + 'pal2_id': rom[0x14BA23+(i*8)], + 'terrain_id': rom[0x14BA24+(i*8)], + 'terrain_flips_id': rom[0x14BA25+(i*8)], + } + bg['palette'] = [palettes[0], palettes[bg['pal1_id']], palettes[bg['pal2_id']]] + battle_bgs.append(bg) + + tiles_pointer_start = 0x184196 + tiles_RAM_pointer_start = 0x184157 + tiles_pointers = [indirect(rom, tiles_pointer_start+(i*3), length=3)-0xC00000 for i in range(21)] + tiles_raw = [decompress_lzss(rom, p) for p in tiles_pointers] + tiles_skips = [indirect(rom, tiles_RAM_pointer_start+(i*3), length=3)-0x7FC000 for i in range(21)] + tiles = [] + for raw, skip in zip(tiles_raw, tiles_skips): + r = raw[skip:] + tiles.append([create_tile_indexed(r[i*32:(i+1)*32]) for i in range(len(r)//32)]) + + terrain_pointer_start = 0x14C86D + terrain_pointers = [indirect(rom, terrain_pointer_start+(i*2))+0x140000 for i in range(28)] + terrains = [decompress_battle_terrain(rom, p) for p in terrain_pointers] + + pixmaps = [] + for bg in battle_bgs: + terrain = apply_battle_terrain_flips(rom, bg['terrain_flips_id'], terrains[bg['terrain_id']]) + pixmaps.append(make_tilemap_pixmap(terrain, tiles[bg['tiles_id']], bg['palette'])) + #[make_tilemap_pixmap(terrains[5], tiles[2], palettes)] + return pixmaps + +def get_zone_tiles_start(rom, id): + i1 = indirect(rom, 0x0E59C0+(id*2))+7 + i2 = indirect(rom, 0x0E59C2+i1, 1) + # There is a divergent path here based on the value. Other things appear to be affected by this. + if i2 > 0x67: + i3 = ((i2 - 0x67) << 11) + 0x1A0000 + elif i2 > 0x52: + i3 = ((i2 - 0x52) << 9) + 0x1A0000 + elif i2 > 0x4B: + i3 = ((i2 - 0x4B) << 11) + 0x1AC800 + elif i2 > 0x32: + i3 = ((i2 - 0x32) << 10) + 0x1A0000 + else: + i3 = (i2 << 9) + 0x1A0000 + return i3 diff --git a/snestile.py b/includes/snestile.py similarity index 92% rename from snestile.py rename to includes/snestile.py index f2390fa..3dc77ff 100644 --- a/snestile.py +++ b/includes/snestile.py @@ -1,10 +1,23 @@ ''' -No license for now + This file is part of ff5reader. + + ff5reader 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. + + ff5reader 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 ff5reader. If not, see . ''' import os from array import array from struct import unpack -import const +import includes.const as const pyqt_version = 0 skip_pyqt5 = "PYQT4" in os.environ