diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dd462e1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +# Gradle +.gradle/ +build/ +!gradle/wrapper/gradle-wrapper.jar + +# IDE +.idea/ +*.iml +.vscode/ +out/ + +# OS +.DS_Store +Thumbs.db + +# Disc images +*.iso diff --git a/LICENSE b/LICENSE index b1a51ea..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,18 +1,674 @@ -MIT License + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (c) 2026 quoije + 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. -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and -associated documentation files (the "Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the -following conditions: + Preamble -The above copyright notice and this permission notice shall be included in all copies or substantial -portions of the Software. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT -LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO -EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE -USE OR OTHER DEALINGS IN THE SOFTWARE. + 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/README.md b/README.md index 9ecbd39..54c349c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # useless-umd-player -umd video player to enjoy limited dvd menus in 720x480 pixels \ No newline at end of file +umd video player to enjoy limited dvd menus in 720x480 pixels + +A standalone player for PSP UMD Video ISO images: open a disc, render its real +menu, and play the movie (H.264 video + ATRAC3+ audio) with mouse and +keyboard/media-key controls. + +> **Status:** early development. Currently implemented: ISO 9660/UMD reading, +> `param.sfo` metadata parsing, and file listing. + +## Build + +Requires JDK 21 (Gradle auto-provisions it via the Foojay toolchain resolver). + +```sh +./gradlew build +``` + +## Run + +```sh +./gradlew cli:run --args="dump /path/to/disc.iso" +``` + +## License + +GPL-3.0-or-later — see [LICENSE](LICENSE). \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..073131b --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,8 @@ +allprojects { + group = "dev.quoije" + version = "0.1.0" + + repositories { + mavenCentral() + } +} diff --git a/cli/build.gradle.kts b/cli/build.gradle.kts new file mode 100644 index 0000000..36a7b87 --- /dev/null +++ b/cli/build.gradle.kts @@ -0,0 +1,18 @@ +plugins { + application +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +application { + mainModule = "dev.quoije.umd.cli" + mainClass = "dev.quoije.umd.cli.Main" +} + +dependencies { + implementation(project(":core")) +} diff --git a/cli/src/main/java/dev/quoije/umd/cli/Main.java b/cli/src/main/java/dev/quoije/umd/cli/Main.java new file mode 100644 index 0000000..6afc961 --- /dev/null +++ b/cli/src/main/java/dev/quoije/umd/cli/Main.java @@ -0,0 +1,133 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.cli; + +import dev.quoije.umd.iso.UmdIsoFile; +import dev.quoije.umd.iso.UmdIsoReader; +import dev.quoije.umd.sfo.Sfo; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.util.Map; + +/** Command-line front-end for the UMD player library. */ +public final class Main { + + private static final String USAGE = "usage: umdplayer dump "; + + private Main() { + } + + public static void main(String[] args) { + if (args.length == 0) { + System.err.println(USAGE); + System.exit(2); + } + + int exitCode; + try { + exitCode = switch (args[0]) { + case "dump" -> dump(requireArg(args, 1)); + case "help", "--help", "-h" -> { + System.out.println(USAGE); + yield 0; + } + default -> { + System.err.println("unknown command: " + args[0]); + System.err.println(USAGE); + yield 2; + } + }; + } catch (Exception e) { + System.err.println("error: " + e.getMessage()); + exitCode = 1; + } + System.exit(exitCode); + } + + private static String requireArg(String[] args, int index) { + if (args.length <= index) { + System.err.println(USAGE); + System.exit(2); + } + return args[index]; + } + + private static int dump(String imagePath) throws IOException { + Path path = Path.of(imagePath); + try (UmdIsoReader iso = new UmdIsoReader(path)) { + System.out.println("Image: " + path.toAbsolutePath()); + System.out.println("Sectors: " + iso.getNumSectors() + + " (" + (iso.getNumSectors() * 2048L) + " bytes)"); + System.out.println("Joliet: " + iso.hasJolietExtension()); + System.out.println(); + + printSfo(iso); + System.out.println(); + printTree(iso); + } + return 0; + } + + private static void printSfo(UmdIsoReader iso) throws IOException { + byte[] sfoBytes = readFile(iso, "UMD_VIDEO/param.sfo"); + if (sfoBytes == null) { + System.out.println("param.sfo: not found"); + return; + } + + Sfo sfo = Sfo.parse(sfoBytes); + System.out.println("param.sfo entries:"); + for (Map.Entry entry : sfo.entries().entrySet()) { + String value = switch (entry.getValue().format()) { + case Sfo.FORMAT_INT32 -> Integer.toString(entry.getValue().asInt()); + case Sfo.FORMAT_UTF8 -> entry.getValue().asString(); + default -> "(" + entry.getValue().data().length + " bytes)"; + }; + System.out.printf(" %-20s = %s%n", entry.getKey(), value); + } + + String discId = sfo.getString("DISC_ID"); + if (discId == null || discId.isBlank()) { + byte[] umdData = readFile(iso, "UMD_DATA.BIN"); + if (umdData != null && umdData.length >= 9) { + discId = new String(umdData, 0, 9, StandardCharsets.US_ASCII); + System.out.println(" (DISC_ID from UMD_DATA.BIN: " + discId + ")"); + } + } + } + + private static void printTree(UmdIsoReader iso) throws IOException { + System.out.println("Files:"); + printDirectory(iso, "", 0); + } + + private static void printDirectory(UmdIsoReader iso, String path, int depth) throws IOException { + String[] files = iso.listDirectory(path); + for (String file : files) { + if (file.equals(".") || file.equals("\01")) { + continue; + } + String child = path.isEmpty() ? file : path + "/" + file; + if (iso.isDirectory(child)) { + System.out.println(" ".repeat(depth) + "D " + file); + printDirectory(iso, child, depth + 1); + } else { + try (UmdIsoFile umdFile = iso.getFile(child)) { + System.out.printf("%s%10d %s%n", " ".repeat(depth), umdFile.length(), file); + } + } + } + } + + private static byte[] readFile(UmdIsoReader iso, String path) throws IOException { + if (!iso.hasFile(path)) { + return null; + } + try (UmdIsoFile file = iso.getFile(path)) { + byte[] buffer = new byte[(int) file.length()]; + file.readFully(buffer); + return buffer; + } + } +} diff --git a/cli/src/main/java/module-info.java b/cli/src/main/java/module-info.java new file mode 100644 index 0000000..96df579 --- /dev/null +++ b/cli/src/main/java/module-info.java @@ -0,0 +1,4 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +module dev.quoije.umd.cli { + requires dev.quoije.umd.core; +} diff --git a/core/build.gradle.kts b/core/build.gradle.kts new file mode 100644 index 0000000..9545544 --- /dev/null +++ b/core/build.gradle.kts @@ -0,0 +1,20 @@ +plugins { + `java-library` +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +dependencies { + testImplementation(platform(libs.junit.bom)) + testImplementation(libs.junit.jupiter) + testRuntimeOnly(libs.junit.platform.launcher) + testImplementation(libs.assertj.core) +} + +tasks.test { + useJUnitPlatform() +} diff --git a/core/src/main/java/dev/quoije/umd/iso/Iso9660Directory.java b/core/src/main/java/dev/quoije/umd/iso/Iso9660Directory.java new file mode 100644 index 0000000..b46f5ee --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/Iso9660Directory.java @@ -0,0 +1,58 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** The contents of an ISO 9660 directory, parsed from a run of directory records. */ +public class Iso9660Directory { + + private final List files = new ArrayList<>(); + + public Iso9660Directory(UmdIsoReader reader, int directorySector, long directorySize) throws IOException { + try (UmdIsoFile data = new UmdIsoFile(reader, directorySector, directorySize, null)) { + long remaining = directorySize; + while (remaining >= 1) { + int entryLength = data.read(); + if (entryLength < 0) { + break; + } + if (entryLength == 0) { + // Padding byte. + remaining--; + continue; + } + remaining -= entryLength; + + byte[] record = new byte[entryLength - 1]; + int read = data.read(record, 0, record.length); + if (read <= 0) { + break; + } + files.add(new Iso9660File(record, read, reader.hasJolietExtension())); + } + } + } + + public Iso9660File getEntryByIndex(int index) { + return files.get(index); + } + + public int getFileIndex(String fileName) throws IOException { + for (int i = 0; i < files.size(); i++) { + if (files.get(i).getName().equalsIgnoreCase(fileName)) { + return i; + } + } + throw new IOException("File '" + fileName + "' not found in directory"); + } + + public String[] getFileList() { + String[] list = new String[files.size()]; + for (int i = 0; i < files.size(); i++) { + list[i] = files.get(i).getName(); + } + return list; + } +} diff --git a/core/src/main/java/dev/quoije/umd/iso/Iso9660File.java b/core/src/main/java/dev/quoije/umd/iso/Iso9660File.java new file mode 100644 index 0000000..8c6e4b3 --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/Iso9660File.java @@ -0,0 +1,124 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.Calendar; +import java.util.Date; +import java.util.TimeZone; + +/** + * A single ISO 9660 directory entry (a file or a directory). + * + *

The {@code data} array starts at the "extended attribute record length" byte of + * the directory record: the leading length byte has already been consumed by the + * caller.

+ */ +public final class Iso9660File { + + private static final Charset JOLIET_CHARSET = Charset.forName("UTF-16BE"); + + private final int lba; + private final long size; + private final int properties; + private final String name; + private final Date timestamp; + + public Iso9660File(byte[] data, int length, boolean jolietExtension) throws IOException { + lba = ubyte(data[1]) | (ubyte(data[2]) << 8) | (ubyte(data[3]) << 16) | (data[4] << 24); + size = ubyte(data[9]) + | ((long) ubyte(data[10]) << 8) + | ((long) ubyte(data[11]) << 16) + | ((long) ubyte(data[12]) << 24); + + int year = ubyte(data[17]); + int month = ubyte(data[18]); + int day = ubyte(data[19]); + int hour = ubyte(data[20]); + int minute = ubyte(data[21]); + int second = ubyte(data[22]); + int gmtOffset = data[23]; // signed, in 15-minute intervals + + int gmtOffsetHours = gmtOffset / 4; + int gmtOffsetMinutes = (gmtOffset % 4) * 15; + String timeZoneName = "GMT"; + if (gmtOffset >= 0) { + timeZoneName += "+"; + } + timeZoneName += gmtOffsetHours; + if (gmtOffsetMinutes > 0) { + if (gmtOffsetMinutes < 10) { + timeZoneName += "0"; + } + timeZoneName += gmtOffsetMinutes; + } + + TimeZone timeZone = TimeZone.getTimeZone(timeZoneName); + Calendar calendar = Calendar.getInstance(timeZone); + calendar.clear(); + calendar.set(1900 + year, month - 1, day, hour, minute, second); + timestamp = calendar.getTime(); + + properties = ubyte(data[24]); + + if (lba < 0 || size < 0) { + throw new IOException("Invalid ISO entry: lba or size < 0"); + } + + int nameLength = ubyte(data[31]); + if (jolietExtension) { + if (nameLength == 1) { + char c = (char) data[32]; + if (c == 0) { + c = '.'; + } + name = Character.toString(c); + } else { + String raw = new String(data, 32, nameLength, JOLIET_CHARSET); + int version = raw.indexOf(';'); + name = version >= 0 ? raw.substring(0, version) : raw; + } + } else { + for (int i = 0; i < nameLength; i++) { + if (data[32 + i] == 0) { + data[32 + i] = (byte) '.'; + } + } + name = new String(data, 32, nameLength, StandardCharsets.US_ASCII); + } + } + + private static int ubyte(byte b) { + return b & 0xFF; + } + + public int getLba() { + return lba; + } + + public long getSize() { + return size; + } + + public int getProperties() { + return properties; + } + + public String getName() { + return name; + } + + public Date getTimestamp() { + return timestamp; + } + + public boolean isDirectory() { + return (properties & 0x02) != 0; + } + + @Override + public String toString() { + return name; + } +} diff --git a/core/src/main/java/dev/quoije/umd/iso/Iso9660Handler.java b/core/src/main/java/dev/quoije/umd/iso/Iso9660Handler.java new file mode 100644 index 0000000..316f591 --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/Iso9660Handler.java @@ -0,0 +1,46 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.IOException; + +/** + * The root directory of the ISO 9660 filesystem, resolved from the primary or + * Joliet volume descriptor. + */ +public final class Iso9660Handler extends Iso9660Directory { + + private final Iso9660Directory internalDir; + + public Iso9660Handler(UmdIsoReader reader) throws IOException { + super(reader, 0, 0); + + int sector = reader.hasJolietExtension() + ? UmdIsoReader.START_SECTOR_JOLIET + : UmdIsoReader.START_SECTOR; + + byte[] volumeDescriptor = reader.readSector(sector); + + // The root directory record begins at byte 156 of the volume descriptor. + // Skip its leading length byte (157) and read the record body. + byte[] record = new byte[38]; + System.arraycopy(volumeDescriptor, 157, record, 0, record.length); + + Iso9660File rootEntry = new Iso9660File(record, record.length, reader.hasJolietExtension()); + internalDir = new Iso9660Directory(reader, rootEntry.getLba(), rootEntry.getSize()); + } + + @Override + public Iso9660File getEntryByIndex(int index) { + return internalDir.getEntryByIndex(index); + } + + @Override + public int getFileIndex(String fileName) throws IOException { + return internalDir.getFileIndex(fileName); + } + + @Override + public String[] getFileList() { + return internalDir.getFileList(); + } +} diff --git a/core/src/main/java/dev/quoije/umd/iso/RawIsoSectorDevice.java b/core/src/main/java/dev/quoije/umd/iso/RawIsoSectorDevice.java new file mode 100644 index 0000000..cbebda4 --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/RawIsoSectorDevice.java @@ -0,0 +1,50 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.IOException; +import java.io.RandomAccessFile; + +/** A {@link SectorDevice} backed directly by a raw ISO image file. */ +public final class RawIsoSectorDevice implements SectorDevice { + + private final RandomAccessFile file; + private final int numSectors; + + public RawIsoSectorDevice(RandomAccessFile file) throws IOException { + this.file = file; + this.numSectors = (int) (file.length() / SECTOR_LENGTH); + } + + @Override + public int getNumSectors() { + return numSectors; + } + + @Override + public void readSector(int sectorNumber, byte[] buffer, int offset) throws IOException { + if (sectorNumber < 0 || sectorNumber >= numSectors) { + throw new IOException("Sector " + sectorNumber + " out of range (numSectors=" + numSectors + ")"); + } + file.seek((long) sectorNumber * SECTOR_LENGTH); + file.readFully(buffer, offset, SECTOR_LENGTH); + } + + @Override + public int readSectors(int sectorNumber, int numberSectors, byte[] buffer, int offset) throws IOException { + if (numberSectors == 0) { + return 0; + } + if (sectorNumber < 0 || sectorNumber + numberSectors > numSectors) { + throw new IOException("Sector range " + sectorNumber + "+" + numberSectors + + " out of range (numSectors=" + numSectors + ")"); + } + file.seek((long) sectorNumber * SECTOR_LENGTH); + file.readFully(buffer, offset, numberSectors * SECTOR_LENGTH); + return numberSectors; + } + + @Override + public void close() throws IOException { + file.close(); + } +} diff --git a/core/src/main/java/dev/quoije/umd/iso/SectorDevice.java b/core/src/main/java/dev/quoije/umd/iso/SectorDevice.java new file mode 100644 index 0000000..43b0234 --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/SectorDevice.java @@ -0,0 +1,18 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.IOException; + +/** A sector-oriented, read-only storage device. A sector is 2048 bytes. */ +public interface SectorDevice { + + int SECTOR_LENGTH = 2048; + + int getNumSectors() throws IOException; + + void readSector(int sectorNumber, byte[] buffer, int offset) throws IOException; + + int readSectors(int sectorNumber, int numberSectors, byte[] buffer, int offset) throws IOException; + + void close() throws IOException; +} diff --git a/core/src/main/java/dev/quoije/umd/iso/UmdIsoFile.java b/core/src/main/java/dev/quoije/umd/iso/UmdIsoFile.java new file mode 100644 index 0000000..6b0d4b7 --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/UmdIsoFile.java @@ -0,0 +1,175 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.EOFException; +import java.io.IOException; + +/** A file within a UMD image, presented as a seekable, sector-backed stream. */ +public final class UmdIsoFile implements AutoCloseable { + + private final UmdIsoReader reader; + private final int startSector; + private final long maxOffset; + private final String name; + + private long currentOffset; + private int currentSectorNumber; + private int sectorOffset; + private byte[] currentSector; + + UmdIsoFile(UmdIsoReader reader, int startSector, long lengthInBytes, String name) throws IOException { + this.reader = reader; + this.startSector = startSector; + this.currentSectorNumber = startSector; + this.currentOffset = 0; + this.name = name; + this.sectorOffset = 0; + this.maxOffset = computeLength(lengthInBytes); + this.currentSector = maxOffset == 0 ? null : reader.readSector(startSector); + } + + private long computeLength(long lengthInBytes) { + if (lengthInBytes <= 0) { + return 0; + } + int endSector = startSector + + (int) ((lengthInBytes + SectorDevice.SECTOR_LENGTH - 1) / SectorDevice.SECTOR_LENGTH) + - 1; + if (endSector >= reader.getNumSectors()) { + endSector = reader.getNumSectors() - 1; + return (long) (endSector - startSector + 1) * SectorDevice.SECTOR_LENGTH; + } + return lengthInBytes; + } + + public int read() throws IOException { + if (currentOffset >= maxOffset) { + throw new EOFException(); + } + checkSectorAvailable(); + currentOffset++; + return currentSector[sectorOffset++] & 0xFF; + } + + public int read(byte[] b, int off, int len) throws IOException { + if (b == null) { + throw new NullPointerException(); + } + if (off < 0 || len < 0 || len > b.length - off) { + throw new IndexOutOfBoundsException(); + } + if (len > (maxOffset - currentOffset)) { + len = (int) (maxOffset - currentOffset); + } + + int total = 0; + + int first = readInternal(b, off, Math.min(len, SectorDevice.SECTOR_LENGTH - sectorOffset)); + off += first; + len -= first; + total += first; + + if (len >= SectorDevice.SECTOR_LENGTH) { + int n = len / SectorDevice.SECTOR_LENGTH; + reader.readSectors(currentSectorNumber + 1, n, b, off); + currentSectorNumber += n; + sectorOffset = SectorDevice.SECTOR_LENGTH; + int bytes = n * SectorDevice.SECTOR_LENGTH; + currentOffset += bytes; + checkSectorAvailable(); + off += bytes; + len -= bytes; + total += bytes; + } + + if (len > 0) { + checkSectorAvailable(); + total += readInternal(b, off, len); + } + + return total; + } + + public void readFully(byte[] b) throws IOException { + readFully(b, 0, b.length); + } + + public void readFully(byte[] b, int off, int len) throws IOException { + while (len > 0) { + if (currentOffset >= maxOffset) { + throw new EOFException(); + } + int n = read(b, off, len); + if (n <= 0) { + throw new EOFException(); + } + off += n; + len -= n; + } + } + + public void seek(long offset) throws IOException { + if (offset < 0) { + throw new IOException("Negative seek offset: " + offset); + } + int newSectorNumber = startSector + (int) (offset / SectorDevice.SECTOR_LENGTH); + if (newSectorNumber != currentSectorNumber) { + currentSector = reader.readSector(newSectorNumber); + } + currentOffset = offset; + currentSectorNumber = newSectorNumber; + sectorOffset = (int) (offset % SectorDevice.SECTOR_LENGTH); + } + + public long skip(long n) throws IOException { + if (n <= 0) { + return 0; + } + long oldOffset = currentOffset; + seek(Math.min(maxOffset, currentOffset + n)); + return currentOffset - oldOffset; + } + + public long length() { + return maxOffset; + } + + public long getFilePointer() { + return currentOffset; + } + + public int getStartSector() { + return startSector; + } + + public String getName() { + return name; + } + + private int readInternal(byte[] b, int off, int len) { + if (len > 0) { + System.arraycopy(currentSector, sectorOffset, b, off, len); + sectorOffset += len; + currentOffset += len; + } + return len; + } + + private void checkSectorAvailable() throws IOException { + if (sectorOffset == SectorDevice.SECTOR_LENGTH && currentOffset < maxOffset) { + currentSectorNumber++; + currentSector = reader.readSector(currentSectorNumber); + sectorOffset = 0; + } + } + + @Override + public void close() { + // The underlying image is owned by the reader; nothing to release here. + } + + @Override + public String toString() { + return "UmdIsoFile(name=" + name + ", length=" + maxOffset + ", startSector=" + startSector + ")"; + } +} diff --git a/core/src/main/java/dev/quoije/umd/iso/UmdIsoReader.java b/core/src/main/java/dev/quoije/umd/iso/UmdIsoReader.java new file mode 100644 index 0000000..caf0b9b --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/iso/UmdIsoReader.java @@ -0,0 +1,215 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import java.io.IOException; +import java.io.RandomAccessFile; +import java.nio.file.Path; +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; + +/** Reader for UMD disc images (ISO 9660 filesystems). */ +public final class UmdIsoReader implements AutoCloseable { + + public static final int START_SECTOR = 16; + public static final int START_SECTOR_JOLIET = 17; + + private static final System.Logger LOG = System.getLogger(UmdIsoReader.class.getName()); + + private final SectorDevice sectorDevice; + private final int numSectors; + private boolean hasJolietExtension; + + private final Map fileCache = new HashMap<>(); + private final Map dirCache = new HashMap<>(); + + public UmdIsoReader(Path path) throws IOException { + RandomAccessFile file = new RandomAccessFile(path.toFile(), "r"); + this.sectorDevice = new RawIsoSectorDevice(file); + this.numSectors = sectorDevice.getNumSectors(); + if (!hasIsoHeader()) { + sectorDevice.close(); + throw new IOException("Unsupported or corrupted disc image: " + path); + } + } + + public boolean hasJolietExtension() { + return hasJolietExtension; + } + + public int getNumSectors() { + return numSectors; + } + + public byte[] readSector(int sectorNumber) throws IOException { + byte[] buffer = new byte[SectorDevice.SECTOR_LENGTH]; + readSector(sectorNumber, buffer, 0); + return buffer; + } + + public void readSector(int sectorNumber, byte[] buffer, int offset) throws IOException { + if (sectorNumber < 0 || sectorNumber >= numSectors) { + Arrays.fill(buffer, offset, offset + SectorDevice.SECTOR_LENGTH, (byte) 0); + LOG.log(System.Logger.Level.WARNING, "Sector {0} out of range ({1} sectors)", + sectorNumber, numSectors); + return; + } + sectorDevice.readSector(sectorNumber, buffer, offset); + } + + public int readSectors(int sectorNumber, int numberSectors, byte[] buffer, int offset) throws IOException { + if (sectorNumber < 0 || sectorNumber + numberSectors > numSectors) { + Arrays.fill(buffer, offset, offset + numberSectors * SectorDevice.SECTOR_LENGTH, (byte) 0); + LOG.log(System.Logger.Level.WARNING, "Sectors {0}..{1} out of range ({2} sectors)", + sectorNumber, sectorNumber + numberSectors, numSectors); + return numberSectors; + } + return sectorDevice.readSectors(sectorNumber, numberSectors, buffer, offset); + } + + private boolean hasIsoHeader() throws IOException { + if (numSectors <= 0) { + return false; + } + + byte[] sector = readSector(START_SECTOR); + if (sector[1] != 'C' || sector[2] != 'D' || sector[3] != '0' || sector[4] != '0' || sector[5] != '1') { + return false; + } + + hasJolietExtension = false; + if (numSectors > START_SECTOR_JOLIET) { + sector = readSector(START_SECTOR_JOLIET); + if (sector[0] == 2 + && sector[1] == 'C' && sector[2] == 'D' + && sector[3] == '0' && sector[4] == '0' && sector[5] == '1') { + hasJolietExtension = true; + } + } + return true; + } + + public UmdIsoFile getFile(String filePath) throws IOException { + if (numSectors == 0) { + throw new IOException(filePath + ": empty image"); + } + + int fileStart; + long fileLength; + String fileName = null; + + if (filePath.isEmpty()) { + fileStart = 0; + fileLength = (long) numSectors * SectorDevice.SECTOR_LENGTH; + } else { + Iso9660File info = getFileEntry(filePath); + if (info == null || info.isDirectory()) { + throw new IOException("File '" + filePath + "' not found or is not a file"); + } + fileStart = info.getLba(); + fileLength = info.getSize(); + fileName = info.getName(); + } + + return new UmdIsoFile(this, fileStart, fileLength, fileName); + } + + public boolean hasFile(String filePath) { + try (UmdIsoFile file = getFile(filePath)) { + return true; + } catch (IOException e) { + return false; + } + } + + public String[] listDirectory(String filePath) throws IOException { + Iso9660Directory dir; + if (filePath.isEmpty()) { + dir = new Iso9660Handler(this); + } else { + Iso9660File info = getFileEntry(filePath); + if (info == null || !info.isDirectory()) { + throw new IOException("'" + filePath + "' not found or is not a directory"); + } + dir = new Iso9660Directory(this, info.getLba(), info.getSize()); + } + return dir.getFileList(); + } + + public boolean isDirectory(String filePath) throws IOException { + if (filePath.isEmpty()) { + return true; + } + Iso9660File info = getFileEntry(filePath); + return info != null && info.isDirectory(); + } + + private Iso9660File getFileEntry(String filePath) throws IOException { + Iso9660File info = fileCache.get(filePath); + if (info != null) { + return info; + } + + int parentIndex = filePath.lastIndexOf('/'); + if (parentIndex >= 0) { + String parentDirectory = filePath.substring(0, parentIndex); + Iso9660Directory dir = dirCache.get(parentDirectory); + if (dir != null) { + int index = dir.getFileIndex(filePath.substring(parentIndex + 1)); + info = dir.getEntryByIndex(index); + if (info != null) { + fileCache.put(filePath, info); + return info; + } + } + } + + Iso9660Directory dir = new Iso9660Handler(this); + + String[] path = filePath.split("[\\\\/]"); + int pathLength = path.length; + for (int i = 0; i < pathLength; ) { + if (path[i].equals(".")) { + pathLength = removePath(path, i, pathLength); + } else if (path[i].equals("..")) { + pathLength = removePath(path, i, pathLength); + pathLength = removePath(path, i - 1, pathLength); + } else { + i++; + } + } + + for (int i = 0; i < pathLength; i++) { + int index = dir.getFileIndex(path[i]); + info = dir.getEntryByIndex(index); + if (info != null && info.isDirectory()) { + dir = new Iso9660Directory(this, info.getLba(), info.getSize()); + StringBuilder dirPath = new StringBuilder(path[0]); + for (int j = 1; j <= i; j++) { + dirPath.append('/').append(path[j]); + } + dirCache.put(dirPath.toString(), dir); + } + } + + if (info != null) { + fileCache.put(filePath, info); + } + return info; + } + + private static int removePath(String[] path, int index, int length) { + if (index < 0 || index >= length) { + return length; + } + for (int i = index + 1; i < length; i++) { + path[i - 1] = path[i]; + } + return length - 1; + } + + @Override + public void close() throws IOException { + sectorDevice.close(); + } +} diff --git a/core/src/main/java/dev/quoije/umd/sfo/Sfo.java b/core/src/main/java/dev/quoije/umd/sfo/Sfo.java new file mode 100644 index 0000000..62b2890 --- /dev/null +++ b/core/src/main/java/dev/quoije/umd/sfo/Sfo.java @@ -0,0 +1,118 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.sfo; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * Parser for the PSP "SFO" metadata format (for example {@code UMD_VIDEO/param.sfo}). + */ +public final class Sfo { + + public static final int FORMAT_UTF8 = 0x0204; + public static final int FORMAT_INT32 = 0x0404; + + private final Map entries = new LinkedHashMap<>(); + + /** A single SFO key/value entry. */ + public record Entry(int format, byte[] data) { + public String asString() { + int end = data.length; + while (end > 0 && data[end - 1] == 0) { + end--; + } + return new String(data, 0, end, StandardCharsets.UTF_8); + } + + public int asInt() { + return (data[0] & 0xFF) + | ((data[1] & 0xFF) << 8) + | ((data[2] & 0xFF) << 16) + | ((data[3] & 0xFF) << 24); + } + } + + public static Sfo parse(byte[] buf) throws IOException { + if (buf.length < 20) { + throw new IOException("SFO data too short"); + } + if (buf[0] != 0 || buf[1] != 'P' || buf[2] != 'S' || buf[3] != 'F') { + throw new IOException("Invalid SFO magic"); + } + + int keyTableOffset = le32(buf, 8); + int dataTableOffset = le32(buf, 12); + int numEntries = le32(buf, 16); + + Sfo sfo = new Sfo(); + for (int i = 0; i < numEntries; i++) { + int off = 20 + i * 16; + if (off + 16 > buf.length) { + throw new IOException("SFO entry table truncated"); + } + + int keyOffset = le16(buf, off); + int format = le16(buf, off + 2); + int dataLength = le32(buf, off + 4); + int dataUsed = le32(buf, off + 8); + int dataOffset = le32(buf, off + 12); + + String key = readNullTerminated(buf, keyTableOffset + keyOffset); + + int used = dataUsed; + if (used <= 0 || used > dataLength) { + used = dataLength; + } + if (dataTableOffset + dataOffset + used > buf.length) { + throw new IOException("SFO data for '" + key + "' truncated"); + } + + byte[] data = new byte[used]; + System.arraycopy(buf, dataTableOffset + dataOffset, data, 0, used); + sfo.entries.put(key, new Entry(format, data)); + } + return sfo; + } + + public Entry get(String key) { + return entries.get(key); + } + + public String getString(String key) { + Entry entry = entries.get(key); + return entry == null ? null : entry.asString(); + } + + public Integer getInt(String key) { + Entry entry = entries.get(key); + return entry == null ? null : entry.asInt(); + } + + public Map entries() { + return entries; + } + + private static String readNullTerminated(byte[] buf, int offset) throws IOException { + int end = offset; + while (end < buf.length && buf[end] != 0) { + end++; + } + if (end == buf.length) { + throw new IOException("Unterminated SFO key"); + } + return new String(buf, offset, end - offset, StandardCharsets.US_ASCII); + } + + private static int le16(byte[] b, int o) { + return (b[o] & 0xFF) | ((b[o + 1] & 0xFF) << 8); + } + + private static int le32(byte[] b, int o) { + return (b[o] & 0xFF) + | ((b[o + 1] & 0xFF) << 8) + | ((b[o + 2] & 0xFF) << 16) + | ((b[o + 3] & 0xFF) << 24); + } +} diff --git a/core/src/main/java/module-info.java b/core/src/main/java/module-info.java new file mode 100644 index 0000000..26b6455 --- /dev/null +++ b/core/src/main/java/module-info.java @@ -0,0 +1,5 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +module dev.quoije.umd.core { + exports dev.quoije.umd.iso; + exports dev.quoije.umd.sfo; +} diff --git a/core/src/test/java/dev/quoije/umd/iso/UmdIsoReaderTest.java b/core/src/test/java/dev/quoije/umd/iso/UmdIsoReaderTest.java new file mode 100644 index 0000000..186dfad --- /dev/null +++ b/core/src/test/java/dev/quoije/umd/iso/UmdIsoReaderTest.java @@ -0,0 +1,144 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.iso; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +class UmdIsoReaderTest { + + private static final int SECTOR = 2048; + + @TempDir + Path tempDir; + + @Test + void listsAndReadsFiles() throws Exception { + Path isoPath = tempDir.resolve("test.iso"); + Files.write(isoPath, buildImage()); + + try (UmdIsoReader iso = new UmdIsoReader(isoPath)) { + assertThat(iso.hasJolietExtension()).isFalse(); + assertThat(iso.listDirectory("")).containsExactlyInAnyOrder(".", "..", "HELLO.TXT"); + assertThat(iso.isDirectory("")).isTrue(); + + try (UmdIsoFile file = iso.getFile("HELLO.TXT")) { + assertThat(file.length()).isEqualTo(6); + byte[] data = new byte[6]; + file.readFully(data); + assertThat(new String(data, StandardCharsets.US_ASCII)).isEqualTo("hello\n"); + } + } + } + + @Test + void rejectsMissingFile() throws Exception { + Path isoPath = tempDir.resolve("test.iso"); + Files.write(isoPath, buildImage()); + + try (UmdIsoReader iso = new UmdIsoReader(isoPath)) { + assertThatThrownBy(() -> iso.getFile("NOPE.TXT")).isInstanceOf(Exception.class); + } + } + + private static byte[] buildImage() { + int numSectors = 32; + byte[] image = new byte[numSectors * SECTOR]; + + int rootLba = 20; + int fileLba = 21; + + // Primary volume descriptor at sector 16. + int pvd = 16 * SECTOR; + image[pvd] = 1; + image[pvd + 1] = 'C'; + image[pvd + 2] = 'D'; + image[pvd + 3] = '0'; + image[pvd + 4] = '0'; + image[pvd + 5] = '1'; + image[pvd + 6] = 1; + System.arraycopy(dirRecord(rootLba, 2048, true, "."), 0, image, pvd + 156, 34); + + // Root directory at sector 20: ".", "..", "HELLO.TXT". + int dir = rootLba * SECTOR; + int off = dir; + off += writeDirRecord(image, off, rootLba, 2048, true, "."); + off += writeDirRecord(image, off, rootLba, 2048, true, ".."); + off += writeDirRecord(image, off, fileLba, 6, false, "HELLO.TXT"); + + // File content at sector 21. + byte[] content = "hello\n".getBytes(StandardCharsets.US_ASCII); + System.arraycopy(content, 0, image, fileLba * SECTOR, content.length); + + return image; + } + + private static int writeDirRecord(byte[] image, int offset, int lba, int size, boolean directory, String name) { + byte[] record = dirRecord(lba, size, directory, name); + System.arraycopy(record, 0, image, offset, record.length); + return record.length; + } + + private static byte[] dirRecord(int lba, int size, boolean directory, String name) { + byte[] nameBytes = name.getBytes(StandardCharsets.US_ASCII); + int nameLength = nameBytes.length; + int recordLength = 33 + nameLength + (nameLength % 2 == 0 ? 1 : 0); + + byte[] r = new byte[recordLength]; + r[0] = (byte) recordLength; + r[1] = 0; // extended attribute record length + le32(r, 2, lba); + be32(r, 6, lba); + le32(r, 10, size); + be32(r, 14, size); + // Recording date/time: year (since 1900), month, day, hour, min, sec, gmt. + r[18] = 126; + r[19] = 9; + r[20] = 15; + r[21] = 0; + r[22] = 0; + r[23] = 0; + r[24] = 0; + r[25] = (byte) (directory ? 0x02 : 0x00); // file flags + r[26] = 0; // file unit size + r[27] = 0; // interleave gap size + le16(r, 28, 1); // volume sequence number (little) + be16(r, 30, 1); // volume sequence number (big) + r[32] = (byte) nameLength; + System.arraycopy(nameBytes, 0, r, 33, nameLength); + if (nameLength % 2 == 0) { + r[33 + nameLength] = 0; // padding + } + return r; + } + + private static void le16(byte[] b, int o, int v) { + b[o] = (byte) (v & 0xFF); + b[o + 1] = (byte) ((v >> 8) & 0xFF); + } + + private static void be16(byte[] b, int o, int v) { + b[o] = (byte) ((v >> 8) & 0xFF); + b[o + 1] = (byte) (v & 0xFF); + } + + private static void le32(byte[] b, int o, int v) { + b[o] = (byte) (v & 0xFF); + b[o + 1] = (byte) ((v >> 8) & 0xFF); + b[o + 2] = (byte) ((v >> 16) & 0xFF); + b[o + 3] = (byte) ((v >> 24) & 0xFF); + } + + private static void be32(byte[] b, int o, int v) { + b[o] = (byte) ((v >> 24) & 0xFF); + b[o + 1] = (byte) ((v >> 16) & 0xFF); + b[o + 2] = (byte) ((v >> 8) & 0xFF); + b[o + 3] = (byte) (v & 0xFF); + } +} diff --git a/core/src/test/java/dev/quoije/umd/sfo/SfoTest.java b/core/src/test/java/dev/quoije/umd/sfo/SfoTest.java new file mode 100644 index 0000000..e7b4e17 --- /dev/null +++ b/core/src/test/java/dev/quoije/umd/sfo/SfoTest.java @@ -0,0 +1,112 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +package dev.quoije.umd.sfo; + +import org.junit.jupiter.api.Test; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.LinkedHashMap; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +class SfoTest { + + private record TestEntry(String key, int format, byte[] data) { + } + + @Test + void parsesStringAndIntegerEntries() throws Exception { + byte[] sfo = build( + new TestEntry("TITLE", Sfo.FORMAT_UTF8, "Test Disc".getBytes(StandardCharsets.UTF_8)), + new TestEntry("MEMSIZE", Sfo.FORMAT_INT32, le32(1)), + new TestEntry("ATTRIBUTE", Sfo.FORMAT_INT32, le32(0x8000)) + ); + + Sfo parsed = Sfo.parse(sfo); + + assertThat(parsed.getString("TITLE")).isEqualTo("Test Disc"); + assertThat(parsed.getInt("MEMSIZE")).isEqualTo(1); + assertThat(parsed.getInt("ATTRIBUTE")).isEqualTo(0x8000); + assertThat(parsed.entries()).containsOnlyKeys("TITLE", "MEMSIZE", "ATTRIBUTE"); + } + + @Test + void rejectsInvalidMagic() { + byte[] bad = new byte[64]; + assertThatThrownBy(() -> Sfo.parse(bad)).isInstanceOf(IOException.class); + } + + private static byte[] build(TestEntry... entries) { + Map keyBytes = new LinkedHashMap<>(); + Map dataBytes = new LinkedHashMap<>(); + for (TestEntry entry : entries) { + keyBytes.put(entry.key, (entry.key + "\0").getBytes(StandardCharsets.US_ASCII)); + dataBytes.put(entry.key, entry.data); + } + + int keyTableOffset = 20 + entries.length * 16; + int dataTableOffset = keyTableOffset + + keyBytes.values().stream().mapToInt(b -> b.length).sum(); + + ByteArrayOutputStream out = new ByteArrayOutputStream(); + out.writeBytes(new byte[]{0, 'P', 'S', 'F'}); + writeLe32(out, 0x101); // version + writeLe32(out, keyTableOffset); + writeLe32(out, dataTableOffset); + writeLe32(out, entries.length); + + Map keyOffsets = new LinkedHashMap<>(); + int keyOff = 0; + for (String key : keyBytes.keySet()) { + keyOffsets.put(key, keyOff); + keyOff += keyBytes.get(key).length; + } + Map dataOffsets = new LinkedHashMap<>(); + int dataOff = 0; + for (String key : dataBytes.keySet()) { + dataOffsets.put(key, dataOff); + dataOff += dataBytes.get(key).length; + } + + for (TestEntry entry : entries) { + writeLe16(out, keyOffsets.get(entry.key)); + writeLe16(out, entry.format); + writeLe32(out, entry.data.length); + writeLe32(out, entry.data.length); + writeLe32(out, dataOffsets.get(entry.key)); + } + + for (byte[] kb : keyBytes.values()) { + out.writeBytes(kb); + } + for (byte[] db : dataBytes.values()) { + out.writeBytes(db); + } + + return out.toByteArray(); + } + + private static void writeLe16(ByteArrayOutputStream out, int v) { + out.write(v & 0xFF); + out.write((v >> 8) & 0xFF); + } + + private static void writeLe32(ByteArrayOutputStream out, int v) { + out.write(v & 0xFF); + out.write((v >> 8) & 0xFF); + out.write((v >> 16) & 0xFF); + out.write((v >> 24) & 0xFF); + } + + private static byte[] le32(int v) { + return new byte[]{ + (byte) (v & 0xFF), + (byte) ((v >> 8) & 0xFF), + (byte) ((v >> 16) & 0xFF), + (byte) ((v >> 24) & 0xFF) + }; + } +} diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..71d5353 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,18 @@ +[versions] +junit = "5.11.4" +junit-platform = "1.11.4" +assertj = "3.27.3" +slf4j = "2.0.16" +logback = "1.5.16" +javafx = "21.0.5" +ffmpeg = "7.1.1-1.5.11" + +[libraries] +junit-bom = { module = "org.junit:junit-bom", version.ref = "junit" } +junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" } +junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher", version.ref = "junit-platform" } +assertj-core = { module = "org.assertj:assertj-core", version.ref = "assertj" } +slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" } +logback-classic = { module = "ch.qos.logback:logback-classic", version.ref = "logback" } +javafx-controls = { module = "org.openjfx:javafx-controls", version.ref = "javafx" } +ffmpeg-platform = { module = "org.bytedeco:ffmpeg-platform", version.ref = "ffmpeg" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..eddabd2 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ad7845b --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..379a658 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob//platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..8508ef6 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..8b23911 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,5 @@ +rootProject.name = "useless-umd-player" + +include("core") +include("ui") +include("cli") diff --git a/ui/build.gradle.kts b/ui/build.gradle.kts new file mode 100644 index 0000000..01ff93c --- /dev/null +++ b/ui/build.gradle.kts @@ -0,0 +1,9 @@ +plugins { + `java-library` +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +}