commit 4ee664e6e9684c8cb3d758ee931ec88dbef8be6e Author: Rob Date: Mon Sep 12 22:21:41 2016 -0500 Initial migration to Maven and Git. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8bd3a05 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target/ +/.settings/ +/.classpath +/.project diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f787784 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Overview + +This application will convert a modern image into a format usable by an Apple II - lores, double lores, and super hires are currently supported. It also includes basic compression capabilities. The color palettes go through an optimization phase to the standard 16 color palette, or, of the existing palette in the case of a super hires. + +**Requires:** Java 1.8 (originally implemented for Java 1.4, but being rebuilt with modern tools, hence Java 1.8 requirement). + +**Tip:** You can drag an image into the original tab instead of digging around for it. + +Currently supported Apple II graphic formats: + +Format | Width | Height | Colors +------ | ----- | ------ | ------ +Lores | 40 | 40 | Standard Apple 16 colors +Double | Lores | 80 | 40 | Standard Apple 16 colors +Super Hires | 320 | 200 | 16 palettes of 16 colors; each palette entry is 12 bit color (4 bits per red, green, blue). + +Currently supported "compression" formats: RLE, Variable RLE, PackBits, 'deflate' method of Zip, GZip, BitPack #1 - #3 (my attempts and they're worthless). + +The [original TODO list](TODO.md) has been preserved for any future efforts. + +# Screen Shots + +This is the original tab with a 2048x1536 image taken on my digital camera. If you're not sure what you are looking at, it is the upper-left corner of the image in the next picture. + +!(doc/images/a2ie-original.png) + +Choose the image type to convert to and click the convert button. If you wish, you can save the raw Apple II data. Note that for lores and double lores, no screen holes are saved. + +!(doc/images/a2ie-convert.png) + +If you want some ideas about compressability, click the compression tab. You can enter the "max size allowed" which I use to figure out if the image can fit into the memory I've allocated for it on the Apple II. Click the Compress button to run through all the possibilities. Those that fit in the size given are colored green, the rest are red. If the compression method fails for some reason, it does not show up (note that Bit Pack #1 is missing - it only works on images less than 64 pixels wide or high or something like that). Note that each compression method's results can be saved to disk. + +!(doc/images/a2ie-compression.png) + +# Installation + +Apple Image Encoder is distributed in a self-executing Java JAR file. What this means is that once Java has been installed on your system, you just need to (a) click the link and open the program to run it or (b) save the file to your hard disk and then double-click on that file. Use whichever works best for you. + +# Version History + +* 09/12/2016 - 4.4.0 - Migrated to GitHub, Maven, rebuilt application. +* 08/06/2005 - 4.3.1 - Initial public release. Prior (internal) releases include command-line only, proof-of-concept work, etc. *This is the only version that will still work with Java 1.5 or later. This is the original package from 2005. diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..5da8bed --- /dev/null +++ b/TODO.md @@ -0,0 +1,17 @@ +> This is the historical ideas list, tweaked for markdown. + +# TODO +* [x] Allow sorting compression results +* [ ] View palette(s) after compression +* [x] Highlight compressed image as red/green +* [x] Save settings - last folder, max size +* [x] Progress bar +* [ ] Demo with Harry pictures for all modes - RLE +* [ ] Add HGR, DHR? +* [ ] Rotate original before conversion? +* [x] Drop files into Original pane instead of loading. +* [ ] Color fixing - bands (currently done), interlaced, closest colors +* [ ] Add Floyd-Steinberg Dithering (and none) +* [ ] Move convert options to popup dialog? (color fixing, aspect ratio) +* [ ] Do something else with compression errors +* [ ] Implement encoders as ServiceLoader modules diff --git a/doc/images/a2ie-compression.png b/doc/images/a2ie-compression.png new file mode 100644 index 0000000..8398a10 Binary files /dev/null and b/doc/images/a2ie-compression.png differ diff --git a/doc/images/a2ie-convert.png b/doc/images/a2ie-convert.png new file mode 100644 index 0000000..dce3d97 Binary files /dev/null and b/doc/images/a2ie-convert.png differ diff --git a/doc/images/a2ie-original.png b/doc/images/a2ie-original.png new file mode 100644 index 0000000..c2ebcfe Binary files /dev/null and b/doc/images/a2ie-original.png differ diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..d1e4815 --- /dev/null +++ b/pom.xml @@ -0,0 +1,55 @@ + + + 4.0.0 + a2geek.apple2 + apple2-image-encoder + 4.4.0-FINAL + Apple II Image Encoder + A utility that got out of hand and became an application to move modern images to the Apple II platform. + + + 1.8 + 1.8 + 2.4.3 + 4.12 + + + + + junit + junit + ${junit.version} + test + + + + + + + org.apache.maven.plugins + maven-shade-plugin + ${maven.shade.version} + + + package + + shade + + + + + + a2geek.apple2.image.encoder.ui.ImageEncoderApp + Apple II Image Encoder + ${project.version} + + + + + + + + + \ No newline at end of file diff --git a/src/main/java/a2geek/apple2/image/encoder/A2DoubleLoresImage.java b/src/main/java/a2geek/apple2/image/encoder/A2DoubleLoresImage.java new file mode 100644 index 0000000..51a4cc3 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/A2DoubleLoresImage.java @@ -0,0 +1,17 @@ +package a2geek.apple2.image.encoder; +import java.awt.image.BufferedImage; + +import a2geek.apple2.image.encoder.util.ProgressListener; + +/** + * Represents an Apple II double lores image. + * @author a2geek@users.noreply.github.com + */ +public class A2DoubleLoresImage extends A2LoresImage { + public A2DoubleLoresImage(BufferedImage image, boolean keepAspectRatio) { + this(image, keepAspectRatio, null); + } + public A2DoubleLoresImage(BufferedImage image, boolean keepAspectRatio, ProgressListener listener) { + super(image, 80, keepAspectRatio, listener); + } +} diff --git a/src/main/java/a2geek/apple2/image/encoder/A2Image.java b/src/main/java/a2geek/apple2/image/encoder/A2Image.java new file mode 100644 index 0000000..b7c5737 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/A2Image.java @@ -0,0 +1,120 @@ +package a2geek.apple2.image.encoder; +import java.awt.Graphics; +import java.awt.image.BufferedImage; + +/** + * Represents an abstract Apple II image. + * @author a2geek@users.noreply.github.com + */ +public abstract class A2Image { + private BufferedImage image; + private int height; + private int width; + + public A2Image(BufferedImage originalImage, int physicalHeight, int physicalWidth, boolean keepAspectRatio) { + this.height = physicalHeight; + this.width = physicalWidth; + + this.image = new BufferedImage(physicalWidth, physicalHeight, BufferedImage.TYPE_INT_RGB); + int x = 0; + int y = 0; + if (keepAspectRatio) { + double aspectRatioH = (double)physicalHeight / (double)originalImage.getHeight(); + double aspectRatioW = (double)physicalWidth / (double)originalImage.getWidth(); + double aspectRatio = (aspectRatioH < aspectRatioW) ? + aspectRatioH : aspectRatioW; + height = (int)(originalImage.getHeight() * aspectRatio); + width = (int)(originalImage.getWidth() * aspectRatio); + x = (physicalWidth - width) / 2; + y = (physicalHeight - height) / 2; + } + Graphics g = this.image.getGraphics(); + g.drawImage(originalImage, x, y, width, height, null); + g.dispose(); + + this.height = physicalHeight; + this.width = physicalWidth; + } + + public int getHeight() { + return height; + } + public int getWidth() { + return width; + } + public int getTotalBytes() { + return getTotalPixels() / 2; + } + public int getTotalPixels() { + return height * width; + } + protected int getRGB(int x, int y) { + return image.getRGB(x,y); + } + protected void setRGB(int x, int y, int color) { + image.setRGB(x, y, color); + } + public BufferedImage getImage() { + return image; + } + /** + * Get Apple II color at X, Y. + */ + public abstract int getColor(int x, int y); + /** + * Get Apple II color treating the screen as an array of pixels. + */ + public int getColor(int pos) { + if (pos >= getTotalPixels()) return -1; + int y = (pos / getWidth()); + int x = pos % getWidth(); + return getColor(x,y); + } + /** + * Get a byte of memory as stored by the hardware. + */ + public abstract int getMemoryByte(int x, int y); + /** + * Treat the screen as an array of bytes. + */ + public abstract int getMemoryByte(int pos); + /** + * Test if, from a given coordinate, the rest of the row is a given color. + */ + public boolean checkRowColor(int y, int xStart, int color) { + for (int x=xStart; x> 12 | (color & 0x00f000) >> 8 | (color & 0x0000f0) >> 4; + for (int i=0; i= getWidth()) { + throw new InvalidParameterException("X(=" + x + ") must be between 0 and " + + getWidth() + "."); + } + if (y < 0 || y >= getHeight() || y%2 == 1) { + throw new InvalidParameterException("Y(=" + y + ") must be between 0 and " + + getHeight() + " and even."); + } + return getColor(x,y) | (getColor(x,y+1) << 4); + } + /** + * Treat the screen as an array of bytes. + */ + public int getMemoryByte(int pos) { + if (pos >= getTotalBytes()) return -1; + int y = (pos / getWidth()) * 2; + int x = pos % getWidth(); + return getMemoryByte(x,y); + } + /** + * Create a byte array of a physical memory dump for the image. + * Note that this is organized vertically - line 0/1 to line 38/39 + * instead of the actual physical memory map. + */ + public byte[] getBytes() { + byte[] data = new byte[getTotalBytes()]; + for (int i=0; i> 8, // red + (color & 0x0f0) >> 4, // green + color & 0x00f // blue + ); + image.setRGB(x, y, paletteColors[0][entry].getMergedColor16()); + } + } + } + /** + * Process a band of the image. This is where the bulk of the work is done. + */ + private PaletteEntry[] processBand(int paletteNumber, int yStart, int yEnd) { + PaletteEntry[] palette = new PaletteEntry[0x1000]; + // Setup all starting PaletteEntries + for (int c=0; c 16) { + if (progressListener != null) { + if (progressListener.isCancelled()) return null; + progressListener.update(yStart, image.getHeight(), "Palette #" + (paletteNumber+1) + " (" + colors + " colors)"); + } + // Locate least popular color + int leastPopular = -1; + double leastPopularFactor = Double.MAX_VALUE; + for (int c=0; c> 12 + | (color & 0x00f000) >> 8 + | (color & 0x0000f0) >> 4; + } + + /** + * Locate the closest color to the given PaletteEntry. + * Returns with the palette index entry. + */ + private int getClosestColor(PaletteEntry[] paletteEntries, PaletteEntry paletteEntry) { + int r0 = paletteEntry.getRed(); + int g0 = paletteEntry.getGreen(); + int b0 = paletteEntry.getBlue(); + return getClosestColor(paletteEntries, r0, g0, b0); + } + /** + * Locate the closest color to the given R,G,B coordinates in the given palette. + * Returns with the palette index entry. + */ + private int getClosestColor(PaletteEntry[] paletteEntries, int r0, int g0, int b0) { + double targetDistance = Double.MAX_VALUE; + int closestColor = -1; + for (int activeColor=0; activeColor> 8; } + public int getGreen() { return (color & 0x0f0) >> 4; } + public int getBlue() { return color & 0x00f; } +} \ No newline at end of file diff --git a/src/main/java/a2geek/apple2/image/encoder/SuperHiresImage.java b/src/main/java/a2geek/apple2/image/encoder/SuperHiresImage.java new file mode 100644 index 0000000..5100c34 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/SuperHiresImage.java @@ -0,0 +1,124 @@ +package a2geek.apple2.image.encoder; +import java.awt.image.BufferedImage; +import java.security.InvalidParameterException; + +import a2geek.apple2.image.encoder.util.ProgressListener; + +/** + * Represents an Apple II super hires image. Images are 320x200 and can + * have upto 16 palettes of 16 4-bit colors each. That is, 4096 possible + * colors in 16 entries in the 16 palettes. Max number of colors available + * in one image is 256. + * + * @author a2geek@users.noreply.github.com + */ +public class SuperHiresImage extends A2Image { + private int[][] paletteColors; + private int[] paletteNumbers; + /** + * Construct a Super Hires image. + */ + public SuperHiresImage(BufferedImage image, boolean keepAspectRatio) { + this(image, keepAspectRatio, null); + } + /** + * Construct a Super Hires image. + * The image must be 320x200. + * If the image is not limited to 16 colors per palette, it will be reduced + * by a hand-crafted algorithm. + */ + public SuperHiresImage(BufferedImage image, boolean keepAspectRatio, ProgressListener listener) { + super(image, 200, 320, keepAspectRatio); + // Need to be careful and use OUR image instead of the original... + ColorDepthReducer cdr = new ColorDepthReducer(getImage()); + cdr.setProgressListener(listener); + cdr.process(); + // Copy results locally + // (The structure is assumed to be 16x16) + if (listener != null) { + if (listener.isCancelled()) return; + listener.update(image.getHeight(), image.getHeight(), "Remembering palettes..."); + } + PaletteEntry[][] paletteEntries = cdr.getPaletteColors(); + paletteColors = new int[16][16]; + for (int paletteNumber=0; paletteNumber<16; paletteNumber++) { + for (int entryNumber=0; entryNumber<16; entryNumber++) { + PaletteEntry paletteEntry = paletteEntries[paletteNumber][entryNumber]; + if (paletteEntry != null) { + paletteColors[paletteNumber][entryNumber] = paletteEntry.getMergedColor(); + } + } + } + paletteNumbers = cdr.getPaletteNumbers(); + } + /** + * Convert 8-bit color to 4-bit IIgs color. + * (That's from 16 million colors to 4096 colors.) + */ + protected int rgb8to4(int rgb8) { + return (rgb8 & 0x00f00000) >> 12 + | (rgb8 & 0x0000f000) >> 8 + | (rgb8 & 0x000000f0) >> 4; + } + /** + * Get the palette entry at X,Y. + */ + public int getColor(int x, int y) { + int color = rgb8to4(getRGB(x,y)); + int paletteNumber = paletteNumbers[y]; + for (int c=0; c= getWidth() || x%2 == 1) { + throw new InvalidParameterException("X(=" + x + ") must be between 0 and " + + getWidth() + " and even."); + } + if (y < 0 || y >= getHeight()) { + throw new InvalidParameterException("Y(=" + y + ") must be between 0 and " + + getHeight() + "."); + } + return (getColor(x,y) << 4) | getColor(x+1,y); + } + /** + * Treat the screen as an array of bytes. + */ + public int getMemoryByte(int pos) { + if (pos >= getTotalBytes()) return -1; + int y = pos / (getWidth() / 2); + int x = (pos % (getWidth() / 2)) * 2; + return getMemoryByte(x,y); + } + /** + * Create a byte array of a physical memory dump for the image. + */ + public byte[] getBytes() { + byte[] data = new byte[0x8000]; + int offset = 0; + // Pixel data (physical memory location $E1:2000 to $E1:9CFF + for (int i=0; i> 8; + int green = (color & 0x0f0) >> 4; + int blue = (color & 0x00f); + data[offset++]= (byte)( (green << 4) | blue ); + data[offset++]= (byte)( red ); + } + } + return data; + } +} diff --git a/src/main/java/a2geek/apple2/image/encoder/encode/A2Encoder.java b/src/main/java/a2geek/apple2/image/encoder/encode/A2Encoder.java new file mode 100644 index 0000000..05efa71 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/encode/A2Encoder.java @@ -0,0 +1,70 @@ +package a2geek.apple2.image.encoder.encode; + +import java.io.ByteArrayOutputStream; + +import a2geek.apple2.image.encoder.A2Image; + +public abstract class A2Encoder { + private ByteArrayOutputStream encodedData = new ByteArrayOutputStream(); + + public abstract void encode(A2Image a2image, int maxSize); + public abstract String getTitle(); + public void reset(int maxSize) { + encodedData.reset(); + } + public void addByte(int value) { + encodedData.write(value & 0xff); + } + public void addBytes(int[] bytes) { + for (int b : bytes) { + addByte(b); + } + } + public int getSize() { + return encodedData.size(); + } + public byte[] getData() { + return encodedData.toByteArray(); + } + /** + * Compute the run size of the given byte pattern. + * Specifically, the number of iterations of the given byte pattern. + */ + protected int getRunSize(byte[] data, int start, int runLengthSize, int maxIterations) { + if (start + runLengthSize >= data.length) return 0; + byte[] run = new byte[runLengthSize]; + System.arraycopy(data, start, run, 0, runLengthSize); + int runLength = 0; + for (int i=0; start+i= data.length) return runLength; + int byt = data[pos]; + if (run[j] != byt) return runLength; + } + runLength++; + } + return runLength; + } + /** + * Find the best run of bytes with varying lengths. + */ + protected int[] findBestRun(byte[] data, int maxRunSize, int position, int maxRunLength, int bytesUsedFactor) { + int maxBytesSaved = 0; // We don't want to encode unless we save some space!! + int bestRunLength = Integer.MIN_VALUE; + int[] run = null; + for (int s=0; s maxBytesSaved) { + maxBytesSaved = bytesSaved; + bestRunLength = runLength; + run = new int[runSize]; + for (int j=0; j 1 ? run : null; + } +} diff --git a/src/main/java/a2geek/apple2/image/encoder/encode/BitPack1.java b/src/main/java/a2geek/apple2/image/encoder/encode/BitPack1.java new file mode 100644 index 0000000..813089d --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/encode/BitPack1.java @@ -0,0 +1,65 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.A2Image; + +/** + * Perform bit pack #1. + *

+ * Image encoding:
+ * 0000 0000 $00 End of picture
+ * 0000 0001 $01 Color the line current color
+ * 0000 0010 $02 Next line (duplicate of $4n?)
+ * 0001 nnnn $1n Set color to n
+ * 01nn nnnn >$40 Goto line n
+ * 10nn nnnn >$80 Plot x1 coordinate
+ * 11nn nnnn >$C0 HLIN from x1 coordinate to x2 coordinate
+ * + * @author a2geek@users.noreply.github.com (sort of) + */ +public class BitPack1 extends A2Encoder { + public String getTitle() { + return "Bit Pack #1"; + } + public void encode(A2Image a2image, int maxSize) { + if (a2image.getWidth() > 64 || a2image.getHeight() > 64) { + throw new NumberFormatException("Maximum X or Y coordinate supported is 64!"); + } + int currentColor = 0; + int rowMoves = 0; + reset(maxSize); + for (int y=0; y 1) { + addByte(0x40 + y); + } + rowMoves = 0; + for (int x=0; x x) { + addByte(0xc0 + i - 1); // i is always 1 past end + } + x = i; + } + } + rowMoves++; + } + } + if (rowMoves == 1) { + addByte(0x02); + rowMoves = 0; + } + addByte(0x00); + } +} diff --git a/src/main/java/a2geek/apple2/image/encoder/encode/BitPack2.java b/src/main/java/a2geek/apple2/image/encoder/encode/BitPack2.java new file mode 100644 index 0000000..28ef5d0 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/encode/BitPack2.java @@ -0,0 +1,74 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.A2Image; + +/** + * Perform bit pack #2. + *

+ * Image is encoded as such:
+ * 1nnn nnnn = plot current color n pixels (1..128)
+ * 01nn cccc = set color, plot n pixels (n = 0 to 3; 0 = setcolor)
+ * 0000 0000 = end
+ * 001n nnnn = move down n (1..32) lines (reset X to 0, line CR)
+ * 0001 ???? = undef
+ * + * @author a2geek@users.noreply.github.com (sort of) + */ +public class BitPack2 extends A2Encoder { + public String getTitle() { + return "Bit Pack #2"; + } + public void encode(A2Image a2image, int maxSize) { + int currentColor = 0; + // FIXME: Should implement this as endOfLine... + int solidBlackLines = 0; + reset(maxSize); + for (int i=0; i 0) { + if (solidBlackLines > 32) { + addByte(0x20 + 31); + solidBlackLines-= 32; + } else { + addByte(0x20 + solidBlackLines-1); + solidBlackLines = 0; + } + i--; // we need to remain at the current position + } else if (color == currentColor) { + int number = 1; + while (number <= 128 && a2image.getColor(i+1) == currentColor) { + i++; + number++; + } + addByte(0x80 + number-1); + } else { // color != currentColor + int number = 1; + while (number < 3 && a2image.getColor(i+1) == color) { + i++; + number++; + } + addByte(0x40 + (number << 4) + color); + currentColor = color; + } + } + } + if (solidBlackLines > 0) { + addByte(0x20 + solidBlackLines); + solidBlackLines = 0; + } + addByte(0x00); + } + +} diff --git a/src/main/java/a2geek/apple2/image/encoder/encode/BitPack3.java b/src/main/java/a2geek/apple2/image/encoder/encode/BitPack3.java new file mode 100644 index 0000000..2fcbc26 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/encode/BitPack3.java @@ -0,0 +1,59 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.A2Image; + +/** + * Bit pack #3. + *

+ * Pack image with the following format:
+ * %1nnn rrrr Repeat the next n+1 bytes r+1 times.
+ * %0nnn nnnn Copy the next n+1 bytes. + *

+ * @author a2geek@users.noreply.github.com (sort of) + */ +public class BitPack3 extends A2Encoder { + public String getTitle() { + return "Bit Pack #3"; + } + public void encode(A2Image image, int maxSize) { + byte[] data = image.getBytes(); + encode(data, maxSize); + } + public void encode(byte[] data, int maxSize) { + reset(maxSize); + int unencodeStart = -1; + for (int i=0; i 128) count = 128; + addByte(0x00 + count - 1); + for (int j=0; j + * PackBits is a fast, simple compression scheme for run-length encoding of data. + *

+ * Apple introduced the PackBits format with the release of MacPaint on the Macintosh computer. + * This compression scheme is one of the types of compression that can be used in TIFF-files. + *

+ * A PackBits data stream consists of packets of one byte of header followed by data. The header + * is a signed byte; the data can be signed, unsigned, or packed (such as MacPaint pixels). + *

+ * + * + * + * + * + *
Header byteData
0 to 1271 + n literal bytes of data
0 to -127One byte of data, repeated 1 - n times in the decompressed output
-128No operation
+ *

+ * Note that interpreting 0 as positive or negative makes no difference in the output. Runs of + * two bytes adjacent to non-runs are typically written as literal data. + *

+ * Looking at the bits, setup is:
+ * + * + * + * + *
%0nnn nnnn1 + n literal bytes of data
%1nnn nnnnOne byte of data repeated 1 - n times.
%1000 0000No operation (used to flag END OF FILE; this is a variance)
+ * + * @author a2geek@users.noreply.github.com (sort of) + * @see http://en.wikipedia.org/wiki/PackBits + * @see http://developer.apple.com/technotes/tn/tn1023.html + * @see http://web.archive.org/web/20080705155158/http://developer.apple.com/technotes/tn/tn1023.html + */ +public class PackBitsEncoder extends A2Encoder { + public String getTitle() { + return "PackBits (Apple)"; + } + public void encode(A2Image image, int maxSize) { + byte[] data = image.getBytes(); + encode(data, maxSize); + } + public void encode(byte[] data, int maxSize) { + reset(maxSize); + for (int i=0; i 2) { + // Compress run of repeated bytes: + addByte(- runSize + 1); + addByte(b); + i+= runSize - 1; + } else { + // Gather up nonrepeating bytes: + int count=0; + for (count=1; i+count 2) break; + } + addByte(count - 1); + for (int k=0; k + * Encoding becomes: RR [ XX | RR XX NN ] + * where:

    + *
  • RR is the repeat toggle byte (1st entry is to identify it).
    • + *
  • XX is the color byte to place in Apple II memory.
    • + *
  • NN is the number of bytes repeated.
    • + *
+ * + * @author a2geek@users.noreply.github.com + */ +public class RleEncoder extends A2Encoder { + public String getTitle() { + return "RLE (Standard)"; + } + public void encode(A2Image a2, int maxSize) { + byte[] data = a2.getBytes(); + encode(data, maxSize); + } + public void encode(byte[] data, int maxSize) { + reset(maxSize); + // Identify an unused value: + int count[] = new int[256]; + for (int i=0; i + * Encoding becomes: ## R1 R2 ... [ XX | Rn XX NN ] + * where:
    + *
  • ## is the number of repeat toggle bytes.
    • + *
  • Rn is the repeat toggle byte.
    • + *
  • XX is the color byte to place in Apple II memory.
    • + *
  • NN is the number of bytes repeated.
    • + *
+ * Each succeeding repeat toggle byte is for a run of N bytes. + * For example, "02 55 66" identifes two repeat toggle bytes with "55" + * indicating a run of 1 byte and "66" indicating a run of 2 bytes. + * + * @author a2geek@users.noreply.github.com + */ +public class VariableRleEncoder extends A2Encoder { + public String getTitle() { + return "RLE (Variable)"; + } + public void encode(A2Image a2, int maxSize) { + byte[] data = a2.getBytes(); + encode(data, maxSize); + } + protected void encode(byte[] data, int maxSize) { + int[] repeatBytes = new int[8]; + reset(maxSize); + // Identify an unused value: + int count[] = new int[256]; + for (int i=0; i encoders = new ArrayList(); + private byte[] data = null; + private String[] headers = new String[] { "Type", "Original", "Compressed", "%" }; + /** + * Construct the TableModel and setup all the A2Encoders. + */ + public EncoderTableModel(A2Image image, int maxSize, ProgressListener listener) { + this.data = image.getBytes(); + + Class[] encoderClasses = new Class[] { + RleEncoder.class, + VariableRleEncoder.class, + PackBitsEncoder.class, + BitPack1.class, + BitPack2.class, + BitPack3.class, + GZipEncoder.class, + ZipEncoder.class + }; + int count = 0; + for (Class encoderClass : encoderClasses) { + if (listener != null && listener.isCancelled()) return; + A2Encoder a2encoder = null; + try { + a2encoder = (A2Encoder)encoderClass.newInstance(); + count++; + if (listener != null) listener.update(count, encoderClasses.length, a2encoder.getTitle()); + a2encoder.encode(image, maxSize); + encoders.add(a2encoder); + } catch (Throwable t) { + // FIXME ignore errors... + //ImageEncoderApp.showErrorDialog(a2encoder.getTitle(), t); + } + } + } + /** + * Answer with the name of the column. + */ + public String getColumnName(int column) { + return headers[column]; + } + /** + * Answer with the number of rows. + */ + public int getRowCount() { + return encoders.size(); + } + /** + * Answer with the number of columns. + */ + public int getColumnCount() { + return headers.length; + } + /** + * Answer with a specific cell value in the table. + */ + public Object getValueAt(int rowIndex, int columnIndex) { + switch (columnIndex) { + case 0: + return encoders.get(rowIndex).getTitle(); + case 1: + return data.length; + case 2: + return encoders.get(rowIndex).getSize(); + case 3: + return (encoders.get(rowIndex).getSize() * 100) / data.length; + default: + return "Unknown"; + } + } + /** + * Anwwer with the specific Class to indicate formatting in the cell. + */ + public Class getColumnClass(int columnIndex) { + switch (columnIndex) { + case 0: + return String.class; + case 1: + return Integer.class; + case 2: + return Integer.class; + case 3: + return Integer.class; + default: + return Object.class; + } + } + /** + * Answer with the specific A2Encoder. + */ + public A2Encoder getSelectedEncoder(int rowIndex) { + return encoders.get(rowIndex); + } +} diff --git a/src/main/java/a2geek/apple2/image/encoder/ui/GraphicsModeComboBoxModel.java b/src/main/java/a2geek/apple2/image/encoder/ui/GraphicsModeComboBoxModel.java new file mode 100644 index 0000000..fa7a666 --- /dev/null +++ b/src/main/java/a2geek/apple2/image/encoder/ui/GraphicsModeComboBoxModel.java @@ -0,0 +1,49 @@ +package a2geek.apple2.image.encoder.ui; + +import javax.swing.ComboBoxModel; +import javax.swing.event.ListDataListener; + +import a2geek.apple2.image.encoder.A2DoubleLoresImage; +import a2geek.apple2.image.encoder.A2LoresImage; +import a2geek.apple2.image.encoder.SuperHiresImage; + +public class GraphicsModeComboBoxModel implements ComboBoxModel { + private int selectedItem = 0; + private String[] itemNames = { + "Super Hi-Res (320x200)", + "Lo-Res (40x40)", + "Double Lo-Res (80x40)" + }; + private Class[] itemClasses = { + SuperHiresImage.class, + A2LoresImage.class, + A2DoubleLoresImage.class + }; + + public void setSelectedItem(Object anItem) { + for (int i=0; i + * TableSorter registers itself as a listener to the underlying model, + * just as the JTable itself would. Events recieved from the model + * are examined, sometimes manipulated (typically widened), and then + * passed on to the TableSorter's listeners (typically the JTable). + * If a change to the model has invalidated the order of TableSorter's + * rows, a note of this is made and the sorter will resort the + * rows the next time a value is requested. + *

+ * When the tableHeader property is set, either by using the + * setTableHeader() method or the two argument constructor, the + * table header may be used as a complete UI for TableSorter. + * The default renderer of the tableHeader is decorated with a renderer + * that indicates the sorting status of each column. In addition, + * a mouse listener is installed with the following behavior: + *

    + *
  • + * Mouse-click: Clears the sorting status of all other columns + * and advances the sorting status of that column through three + * values: {NOT_SORTED, ASCENDING, DESCENDING} (then back to + * NOT_SORTED again). + *
  • + * SHIFT-mouse-click: Clears the sorting status of all other columns + * and cycles the sorting status of the column through the same + * three values, in the opposite order: {NOT_SORTED, DESCENDING, ASCENDING}. + *
  • + * CONTROL-mouse-click and CONTROL-SHIFT-mouse-click: as above except + * that the changes to the column do not cancel the statuses of columns + * that are already sorting - giving a way to initiate a compound + * sort. + *
+ *

+ * This is a long overdue rewrite of a class of the same name that + * first appeared in the swing table demos in 1997. + * + * @author Philip Milne + * @author Brendon McLean + * @author Dan van Enckevort + * @author Parwinder Sekhon + * @version 2.0 02/27/04 + * @see http://java.sun.com/docs/books/tutorial/uiswing/components/table.html + */ +@SuppressWarnings("serial") +public class TableSorter extends AbstractTableModel { + protected TableModel tableModel; + + public static final int DESCENDING = -1; + public static final int NOT_SORTED = 0; + public static final int ASCENDING = 1; + + private static Directive EMPTY_DIRECTIVE = new Directive(-1, NOT_SORTED); + + public static final Comparator COMPARABLE_COMAPRATOR = new Comparator() { + public int compare(Object o1, Object o2) { + return ((Comparable) o1).compareTo(o2); + } + }; + public static final Comparator LEXICAL_COMPARATOR = new Comparator() { + public int compare(Object o1, Object o2) { + return o1.toString().compareTo(o2.toString()); + } + }; + + private Row[] viewToModel; + private int[] modelToView; + + private JTableHeader tableHeader; + private MouseListener mouseListener; + private TableModelListener tableModelListener; + private Map columnComparators = new HashMap(); + private List sortingColumns = new ArrayList(); + + public TableSorter() { + this.mouseListener = new MouseHandler(); + this.tableModelListener = new TableModelHandler(); + } + + public TableSorter(TableModel tableModel) { + this(); + setTableModel(tableModel); + } + + public TableSorter(TableModel tableModel, JTableHeader tableHeader) { + this(); + setTableHeader(tableHeader); + setTableModel(tableModel); + } + + private void clearSortingState() { + viewToModel = null; + modelToView = null; + } + + public TableModel getTableModel() { + return tableModel; + } + + public void setTableModel(TableModel tableModel) { + if (this.tableModel != null) { + this.tableModel.removeTableModelListener(tableModelListener); + } + + this.tableModel = tableModel; + if (this.tableModel != null) { + this.tableModel.addTableModelListener(tableModelListener); + } + + clearSortingState(); + fireTableStructureChanged(); + } + + public JTableHeader getTableHeader() { + return tableHeader; + } + + public void setTableHeader(JTableHeader tableHeader) { + if (this.tableHeader != null) { + this.tableHeader.removeMouseListener(mouseListener); + TableCellRenderer defaultRenderer = this.tableHeader.getDefaultRenderer(); + if (defaultRenderer instanceof SortableHeaderRenderer) { + this.tableHeader.setDefaultRenderer(((SortableHeaderRenderer) defaultRenderer).tableCellRenderer); + } + } + this.tableHeader = tableHeader; + if (this.tableHeader != null) { + this.tableHeader.addMouseListener(mouseListener); + this.tableHeader.setDefaultRenderer( + new SortableHeaderRenderer(this.tableHeader.getDefaultRenderer())); + } + } + + public boolean isSorting() { + return sortingColumns.size() != 0; + } + + private Directive getDirective(int column) { + for (int i = 0; i < sortingColumns.size(); i++) { + Directive directive = (Directive)sortingColumns.get(i); + if (directive.column == column) { + return directive; + } + } + return EMPTY_DIRECTIVE; + } + + public int getSortingStatus(int column) { + return getDirective(column).direction; + } + + private void sortingStatusChanged() { + clearSortingState(); + fireTableDataChanged(); + if (tableHeader != null) { + tableHeader.repaint(); + } + } + + public void setSortingStatus(int column, int status) { + Directive directive = getDirective(column); + if (directive != EMPTY_DIRECTIVE) { + sortingColumns.remove(directive); + } + if (status != NOT_SORTED) { + sortingColumns.add(new Directive(column, status)); + } + sortingStatusChanged(); + } + + protected Icon getHeaderRendererIcon(int column, int size) { + Directive directive = getDirective(column); + if (directive == EMPTY_DIRECTIVE) { + return null; + } + return new Arrow(directive.direction == DESCENDING, size, sortingColumns.indexOf(directive)); + } + + private void cancelSorting() { + sortingColumns.clear(); + sortingStatusChanged(); + } + + public void setColumnComparator(Class type, Comparator comparator) { + if (comparator == null) { + columnComparators.remove(type); + } else { + columnComparators.put(type, comparator); + } + } + + protected Comparator getComparator(int column) { + Class columnType = tableModel.getColumnClass(column); + Comparator comparator = (Comparator) columnComparators.get(columnType); + if (comparator != null) { + return comparator; + } + if (Comparable.class.isAssignableFrom(columnType)) { + return COMPARABLE_COMAPRATOR; + } + return LEXICAL_COMPARATOR; + } + + private Row[] getViewToModel() { + if (viewToModel == null) { + int tableModelRowCount = tableModel.getRowCount(); + viewToModel = new Row[tableModelRowCount]; + for (int row = 0; row < tableModelRowCount; row++) { + viewToModel[row] = new Row(row); + } + + if (isSorting()) { + Arrays.sort(viewToModel); + } + } + return viewToModel; + } + + public int modelIndex(int viewIndex) { + return getViewToModel()[viewIndex].modelIndex; + } + + private int[] getModelToView() { + if (modelToView == null) { + int n = getViewToModel().length; + modelToView = new int[n]; + for (int i = 0; i < n; i++) { + modelToView[modelIndex(i)] = i; + } + } + return modelToView; + } + + // TableModel interface methods + + public int getRowCount() { + return (tableModel == null) ? 0 : tableModel.getRowCount(); + } + + public int getColumnCount() { + return (tableModel == null) ? 0 : tableModel.getColumnCount(); + } + + public String getColumnName(int column) { + return tableModel.getColumnName(column); + } + + public Class getColumnClass(int column) { + return tableModel.getColumnClass(column); + } + + public boolean isCellEditable(int row, int column) { + return tableModel.isCellEditable(modelIndex(row), column); + } + + public Object getValueAt(int row, int column) { + return tableModel.getValueAt(modelIndex(row), column); + } + + public void setValueAt(Object aValue, int row, int column) { + tableModel.setValueAt(aValue, modelIndex(row), column); + } + + // Helper classes + + private class Row implements Comparable { + private int modelIndex; + + public Row(int index) { + this.modelIndex = index; + } + + public int compareTo(Object o) { + int row1 = modelIndex; + int row2 = ((Row) o).modelIndex; + + for (Iterator it = sortingColumns.iterator(); it.hasNext();) { + Directive directive = (Directive) it.next(); + int column = directive.column; + Object o1 = tableModel.getValueAt(row1, column); + Object o2 = tableModel.getValueAt(row2, column); + + int comparison = 0; + // Define null less than everything, except null. + if (o1 == null && o2 == null) { + comparison = 0; + } else if (o1 == null) { + comparison = -1; + } else if (o2 == null) { + comparison = 1; + } else { + comparison = getComparator(column).compare(o1, o2); + } + if (comparison != 0) { + return directive.direction == DESCENDING ? -comparison : comparison; + } + } + return 0; + } + } + + private class TableModelHandler implements TableModelListener { + public void tableChanged(TableModelEvent e) { + // If we're not sorting by anything, just pass the event along. + if (!isSorting()) { + clearSortingState(); + fireTableChanged(e); + return; + } + + // If the table structure has changed, cancel the sorting; the + // sorting columns may have been either moved or deleted from + // the model. + if (e.getFirstRow() == TableModelEvent.HEADER_ROW) { + cancelSorting(); + fireTableChanged(e); + return; + } + + // We can map a cell event through to the view without widening + // when the following conditions apply: + // + // a) all the changes are on one row (e.getFirstRow() == e.getLastRow()) and, + // b) all the changes are in one column (column != TableModelEvent.ALL_COLUMNS) and, + // c) we are not sorting on that column (getSortingStatus(column) == NOT_SORTED) and, + // d) a reverse lookup will not trigger a sort (modelToView != null) + // + // Note: INSERT and DELETE events fail this test as they have column == ALL_COLUMNS. + // + // The last check, for (modelToView != null) is to see if modelToView + // is already allocated. If we don't do this check; sorting can become + // a performance bottleneck for applications where cells + // change rapidly in different parts of the table. If cells + // change alternately in the sorting column and then outside of + // it this class can end up re-sorting on alternate cell updates - + // which can be a performance problem for large tables. The last + // clause avoids this problem. + int column = e.getColumn(); + if (e.getFirstRow() == e.getLastRow() + && column != TableModelEvent.ALL_COLUMNS + && getSortingStatus(column) == NOT_SORTED + && modelToView != null) { + int viewIndex = getModelToView()[e.getFirstRow()]; + fireTableChanged(new TableModelEvent(TableSorter.this, + viewIndex, viewIndex, + column, e.getType())); + return; + } + + // Something has happened to the data that may have invalidated the row order. + clearSortingState(); + fireTableDataChanged(); + return; + } + } + + private class MouseHandler extends MouseAdapter { + public void mouseClicked(MouseEvent e) { + JTableHeader h = (JTableHeader) e.getSource(); + TableColumnModel columnModel = h.getColumnModel(); + int viewColumn = columnModel.getColumnIndexAtX(e.getX()); + int column = columnModel.getColumn(viewColumn).getModelIndex(); + if (column != -1) { + int status = getSortingStatus(column); + if (!e.isControlDown()) { + cancelSorting(); + } + // Cycle the sorting states through {NOT_SORTED, ASCENDING, DESCENDING} or + // {NOT_SORTED, DESCENDING, ASCENDING} depending on whether shift is pressed. + status = status + (e.isShiftDown() ? -1 : 1); + status = (status + 4) % 3 - 1; // signed mod, returning {-1, 0, 1} + setSortingStatus(column, status); + } + } + } + + private static class Arrow implements Icon { + private boolean descending; + private int size; + private int priority; + + public Arrow(boolean descending, int size, int priority) { + this.descending = descending; + this.size = size; + this.priority = priority; + } + + public void paintIcon(Component c, Graphics g, int x, int y) { + Color color = c == null ? Color.GRAY : c.getBackground(); + // In a compound sort, make each succesive triangle 20% + // smaller than the previous one. + int dx = (int)(size/2*Math.pow(0.8, priority)); + int dy = descending ? dx : -dx; + // Align icon (roughly) with font baseline. + y = y + 5*size/6 + (descending ? -dy : 0); + int shift = descending ? 1 : -1; + g.translate(x, y); + + // Right diagonal. + g.setColor(color.darker()); + g.drawLine(dx / 2, dy, 0, 0); + g.drawLine(dx / 2, dy + shift, 0, shift); + + // Left diagonal. + g.setColor(color.brighter()); + g.drawLine(dx / 2, dy, dx, 0); + g.drawLine(dx / 2, dy + shift, dx, shift); + + // Horizontal line. + if (descending) { + g.setColor(color.darker().darker()); + } else { + g.setColor(color.brighter().brighter()); + } + g.drawLine(dx, 0, 0, 0); + + g.setColor(color); + g.translate(-x, -y); + } + + public int getIconWidth() { + return size; + } + + public int getIconHeight() { + return size; + } + } + + private class SortableHeaderRenderer implements TableCellRenderer { + private TableCellRenderer tableCellRenderer; + + public SortableHeaderRenderer(TableCellRenderer tableCellRenderer) { + this.tableCellRenderer = tableCellRenderer; + } + + public Component getTableCellRendererComponent(JTable table, + Object value, + boolean isSelected, + boolean hasFocus, + int row, + int column) { + Component c = tableCellRenderer.getTableCellRendererComponent(table, + value, isSelected, hasFocus, row, column); + if (c instanceof JLabel) { + JLabel l = (JLabel) c; + l.setHorizontalTextPosition(JLabel.LEFT); + int modelColumn = table.convertColumnIndexToModel(column); + l.setIcon(getHeaderRendererIcon(modelColumn, l.getFont().getSize())); + } + return c; + } + } + + private static class Directive { + private int column; + private int direction; + + public Directive(int column, int direction) { + this.column = column; + this.direction = direction; + } + } +} + diff --git a/src/main/resources/images/a2gssmall.jpg b/src/main/resources/images/a2gssmall.jpg new file mode 100644 index 0000000..0e43b9b Binary files /dev/null and b/src/main/resources/images/a2gssmall.jpg differ diff --git a/src/test/java/a2geek/apple2/image/encoder/SuperHiresImageTest.java b/src/test/java/a2geek/apple2/image/encoder/SuperHiresImageTest.java new file mode 100644 index 0000000..1173eeb --- /dev/null +++ b/src/test/java/a2geek/apple2/image/encoder/SuperHiresImageTest.java @@ -0,0 +1,17 @@ +package a2geek.apple2.image.encoder; +import a2geek.apple2.image.encoder.SuperHiresImage; +import junit.framework.TestCase; + +public class SuperHiresImageTest extends TestCase { +// public void testRgb4to8() { +// SuperHiresImage image = new SuperHiresImage(null); +// assertEquals(0xf0f0f0, image.rgb4to8(0xfff)); +// assertEquals(0xf0f000, image.rgb4to8(0xff0)); +// } + + public void testRgb8to4() { + SuperHiresImage image = new SuperHiresImage(null, false, null); + assertEquals(0xfff, image.rgb8to4(0x00f0f0f0)); + assertEquals(0xff0, image.rgb8to4(0x00ffff00)); + } +} diff --git a/src/test/java/a2geek/apple2/image/encoder/encode/BitPack3EncoderTest.java b/src/test/java/a2geek/apple2/image/encoder/encode/BitPack3EncoderTest.java new file mode 100644 index 0000000..6baa4cd --- /dev/null +++ b/src/test/java/a2geek/apple2/image/encoder/encode/BitPack3EncoderTest.java @@ -0,0 +1,38 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.encode.BitPack3; + +/** + * Exercise BitPack3. + * + * @author a2geek@users.noreply.github.com + * @see a2geek.apple2.image.encoder.encode.RleEncoder; + * @see a2geek.apple2.image.encoder.encode.EncoderTestCase; + */ +public class BitPack3EncoderTest extends EncoderTestCase { + /** + * Test the RleEncoder with the given input and output. + */ + protected void test(String input, String output) { + byte[] data = toBytes(input); + byte[] answer = toBytes(output); + BitPack3 e = new BitPack3(); + e.encode(data, 100); + byte[] result = e.getData(); + assertEquals(answer.length, e.getSize()); + assertEquals(answer, result); + } + + public void testNoRuns() { + test("01020304", "0301020304"); + } + public void testOneByteRun() { + test(repeat("12",10), "8912"); + } + public void testTwoByteRun() { + test(repeat("5566",6), "955566"); + } + public void testMixedData() { + test("1122" + repeat("55",25) + "3344", "0111229b555502553344"); + } +} diff --git a/src/test/java/a2geek/apple2/image/encoder/encode/EncoderTestCase.java b/src/test/java/a2geek/apple2/image/encoder/encode/EncoderTestCase.java new file mode 100644 index 0000000..1b353fd --- /dev/null +++ b/src/test/java/a2geek/apple2/image/encoder/encode/EncoderTestCase.java @@ -0,0 +1,47 @@ +package a2geek.apple2.image.encoder.encode; + +import junit.framework.TestCase; + +/** + * Contains helper methods that can be imported into any of the encoder tests. + * + * @author a2geek@users.noreply.github.com + */ +public abstract class EncoderTestCase extends TestCase { + /** + * Convert a hex string into an array of bytes. + * String is in the format "112233" which is decoded as the array + * of bytes 0x11, 0x22, 0x33. + */ + public byte[] toBytes(String hexString) { + if (hexString == null || hexString.length() % 2 == 1) { + throw new NumberFormatException("String must be an even length and not null"); + } + byte[] data = new byte[hexString.length() / 2]; + for (int i=0; i 0) data.append(repeatedBytes); + return data.toString(); + } +} diff --git a/src/test/java/a2geek/apple2/image/encoder/encode/PackBitsEncoderTest.java b/src/test/java/a2geek/apple2/image/encoder/encode/PackBitsEncoderTest.java new file mode 100644 index 0000000..fc9f617 --- /dev/null +++ b/src/test/java/a2geek/apple2/image/encoder/encode/PackBitsEncoderTest.java @@ -0,0 +1,43 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.encode.PackBitsEncoder; + +/** + * Exercise the PackBitsEncoder + * + * @author a2geek@users.noreply.github.com + * @see a2geek.apple2.image.encoder.encode.PackBitsEncoder; + * @see a2geek.apple2.image.encoder.encode.EncoderTestCase; + */ +public class PackBitsEncoderTest extends EncoderTestCase { + /** + * Test the PackBitsEncoder with the given input and output. + */ + protected void test(String input, String output) { + byte[] data = toBytes(input); + byte[] answer = toBytes(output); + PackBitsEncoder e = new PackBitsEncoder(); + e.encode(data, 100); + byte[] result = e.getData(); + assertEquals(answer.length, e.getSize()); + assertEquals(answer, result); + } + + public void testNoRuns() { + test("01020304", "0301020304"); + } + public void testOneByteRun() { + test(repeat("12",10), "F712"); + } + public void testTwoByteRun() { + test(repeat("5566",6), "0b" + repeat("5566",6)); + } + public void testMixedData() { + test("1122" + repeat("55",25) + "3344", "011122e855013344"); + } + public void testFromAppleSite() { + test("AAAAAA80002AAAAAAAAA80002A22AAAAAAAAAAAAAAAAAAAA", + "FEAA0280002AFDAA0380002A22F7AA"); + + } +} diff --git a/src/test/java/a2geek/apple2/image/encoder/encode/RleEncoderTest.java b/src/test/java/a2geek/apple2/image/encoder/encode/RleEncoderTest.java new file mode 100644 index 0000000..a2b7bc9 --- /dev/null +++ b/src/test/java/a2geek/apple2/image/encoder/encode/RleEncoderTest.java @@ -0,0 +1,41 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.encode.RleEncoder; + +/** + * Exercise the RleEncoder. + *

+ * Note that the RleEncoder and VariableRleEncoder actually encode the repeated byte + * and the number of repeats in a different order. + * + * @author a2geek@users.noreply.github.com + * @see a2geek.apple2.image.encoder.encode.RleEncoder; + * @see a2geek.apple2.image.encoder.encode.EncoderTestCase; + */ +public class RleEncoderTest extends EncoderTestCase { + /** + * Test the RleEncoder with the given input and output. + */ + protected void test(String input, String output) { + byte[] data = toBytes(input); + byte[] answer = toBytes(output); + RleEncoder e = new RleEncoder(); + e.encode(data, 100); + byte[] result = e.getData(); + assertEquals(answer.length, e.getSize()); + assertEquals(answer, result); + } + + public void testNoRuns() { + test("01020304", "0001020304"); + } + public void testOneByteRun() { + test(repeat("12",10), "0000120a"); + } + public void testTwoByteRun() { + test(repeat("5566",6), "00" + repeat("5566",6)); + } + public void testMixedData() { + test("1122" + repeat("55",25) + "3344", "0011220055193344"); + } +} diff --git a/src/test/java/a2geek/apple2/image/encoder/encode/VariableRleEncoderTest.java b/src/test/java/a2geek/apple2/image/encoder/encode/VariableRleEncoderTest.java new file mode 100644 index 0000000..a091dd0 --- /dev/null +++ b/src/test/java/a2geek/apple2/image/encoder/encode/VariableRleEncoderTest.java @@ -0,0 +1,41 @@ +package a2geek.apple2.image.encoder.encode; + +import a2geek.apple2.image.encoder.encode.VariableRleEncoder; + +/** + * Exercise the VariableRleEncoder. + *

+ * Note that the RleEncoder and VariableRleEncoder actually encode the repeated byte + * and the number of repeats in a different order. + * + * @author a2geek@users.noreply.github.com + * @see a2geek.apple2.image.encoder.encode.VariableRleEncoder; + * @see a2geek.apple2.image.encoder.encode.EncoderTestCase; + */ +public class VariableRleEncoderTest extends EncoderTestCase { + /** + * Test the VariableRleEncoder with the given input and output. + */ + protected void test(String input, String output) { + byte[] data = toBytes(input); + byte[] answer = toBytes(output); + VariableRleEncoder e = new VariableRleEncoder(); + e.encode(data, 100); + byte[] result = e.getData(); + assertEquals(answer.length, e.getSize()); + assertEquals(answer, result); + } + + public void testNoRuns() { + test("01020304", "080005060708090a0b01020304"); + } + public void testOneByteRun() { + test(repeat("12",10), "080001020304050607000a12"); + } + public void testTwoByteRun() { + test(repeat("5566",6), "08000102030405060701065566"); + } + public void testThreeByteRun() { + test(repeat("112233",32), "0800010203040506070220112233"); + } +}