commit 7f196158305327259adf55ae406db020a966d14f Author: Felipe Cotti Date: Sat Nov 23 15:16:22 2024 -0300 Initial commit, includes the plpext-core solution. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4de168d --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +[Oo]bj/ +[Bb]in/ +.nuget/ +_ReSharper.* +packages/ +artifacts/ +*.user +*.suo +*.userprefs +*DS_Store +*.sln.ide \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /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. + + + 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 +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..18fcfec --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +

+ + Plpext Project logo +

+ +

Plpext

+ +
+ +[![Status](https://img.shields.io/badge/status-active-success.svg)]() +[![GitHub Issues](https://img.shields.io/github/issues/cotti/plpext.svg)](https://github.com/cotti/plpext/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/cotti/plpext.svg)](https://github.com/cotti/plpext/pulls) +[![License](https://img.shields.io/badge/license-GPLv3-003300.svg)](/LICENSE) + +
+ +--- + + +

An application to recover, listen and export audio snippets saved in the long-extinct Messenger Plus Library Pack (.plp) format.

+ +

This is phase II of the personal backscratchers project.

+ +## 📝 Table of Contents + + +- [📝 Table of Contents](#-table-of-contents) +- [🧐 About ](#-about-) +- [📑 Documentation ](#-documentation-) +- [🏁 Getting Started ](#-getting-started-) +- [🕸️ Prerequisites](#️-prerequisites) +- [⛏️ Built Using ](#️-built-using-) +- [✍️ Authors ](#️-authors-) + +## 🧐 About + +Plpext (*good luck spelling that any way you want*) is a simple application to retrieve audio snippets that you may have used in MSN Live Messenger with the *very unofficial* add-on Messenger Plus years ago, and somehow left in your backups as a weird, unreadable `.plp` file. + +It is also a rewrite of the very aptly-named *MessengerPlusSoundBankExtractor* with an improved project design. The `plpext-core` solution now contains everything related to file manipulation and playback, leaving the front-end fully free to do as it wishes. + +I am also using a less-problematic implementation of OpenAL, which hopefully will make distribution a whole lot easier. + +## 📑 Documentation + +[Comments and general documentation/musings on the project](docs/comments.md) + +## 🏁 Getting Started + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. + +## 🕸️ Prerequisites + +Building: +- .NET 8.0 + +Hopefully that'll be it. Releases should be made self-contained. + + +## ⛏️ Built Using + +- [.NET](https://dot.net/) - Core +- [AvaloniaUI](https://avaloniaui.net/) - GUI + +## ✍️ Authors + +- [@cotti](https://github.com/cotti) | [cotti.com.br](https://cotti.com.br) \ No newline at end of file diff --git a/docs/comments.md b/docs/comments.md new file mode 100644 index 0000000..d5554da --- /dev/null +++ b/docs/comments.md @@ -0,0 +1,5 @@ +# General Comments + +Oh, hello. In this document, I'll write down some impressions and musings from the development of this project. + +However, only the core is done at the moment. Once I proceed with the GUI, I'll add some stuff here. \ No newline at end of file diff --git a/docs/plpext.png b/docs/plpext.png new file mode 100644 index 0000000..e84c66f Binary files /dev/null and b/docs/plpext.png differ diff --git a/src/Plpext.Core.Windows/Plpext.Core.Windows.csproj b/src/Plpext.Core.Windows/Plpext.Core.Windows.csproj new file mode 100644 index 0000000..0af2c11 --- /dev/null +++ b/src/Plpext.Core.Windows/Plpext.Core.Windows.csproj @@ -0,0 +1,28 @@ + + + + net8.0 + enable + enable + x86;x64 + + + + + + + + + Always + OpenAL32.dll + + + + + + Always + OpenAL32.dll + + + + diff --git a/src/Plpext.Core.Windows/lib/x64/OpenAL32.dll b/src/Plpext.Core.Windows/lib/x64/OpenAL32.dll new file mode 100644 index 0000000..91579d9 Binary files /dev/null and b/src/Plpext.Core.Windows/lib/x64/OpenAL32.dll differ diff --git a/src/Plpext.Core.Windows/lib/x86/OpenAL32.dll b/src/Plpext.Core.Windows/lib/x86/OpenAL32.dll new file mode 100644 index 0000000..66fc199 Binary files /dev/null and b/src/Plpext.Core.Windows/lib/x86/OpenAL32.dll differ diff --git a/src/Plpext.Core.sln b/src/Plpext.Core.sln new file mode 100644 index 0000000..8c77568 --- /dev/null +++ b/src/Plpext.Core.sln @@ -0,0 +1,41 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.11.35312.102 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Plpext.Core", "Plpext.Core\Plpext.Core.csproj", "{72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Plpext.Core.Windows", "Plpext.Core.Windows\Plpext.Core.Windows.csproj", "{38E2302B-2FB7-4C72-904B-18C4D4817503}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 + Release|x64 = Release|x64 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Debug|x64.ActiveCfg = Debug|x64 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Debug|x64.Build.0 = Debug|x64 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Debug|x86.ActiveCfg = Debug|x86 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Debug|x86.Build.0 = Debug|x86 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Release|x64.ActiveCfg = Release|x64 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Release|x64.Build.0 = Release|x64 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Release|x86.ActiveCfg = Release|x86 + {72D79FE4-5D13-4CEB-8F2F-CA07D9D0CEC4}.Release|x86.Build.0 = Release|x86 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Debug|x64.ActiveCfg = Debug|x64 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Debug|x64.Build.0 = Debug|x64 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Debug|x86.ActiveCfg = Debug|x86 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Debug|x86.Build.0 = Debug|x86 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Release|x64.ActiveCfg = Release|x64 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Release|x64.Build.0 = Release|x64 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Release|x86.ActiveCfg = Release|x86 + {38E2302B-2FB7-4C72-904B-18C4D4817503}.Release|x86.Build.0 = Release|x86 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {8AE7A997-0165-42B9-A36A-F0D08F7F62FE} + EndGlobalSection +EndGlobal diff --git a/src/Plpext.Core/AudioConverter/MP3AudioConverter.cs b/src/Plpext.Core/AudioConverter/MP3AudioConverter.cs new file mode 100644 index 0000000..7c9dfb5 --- /dev/null +++ b/src/Plpext.Core/AudioConverter/MP3AudioConverter.cs @@ -0,0 +1,86 @@ +using MP3Sharp; +using Plpext.Core.Interfaces; +using Plpext.Core.Models; + +namespace Plpext.Core.AudioConverter +{ + public class MP3AudioConverter : IAudioConverter + { + private readonly IMP3Parser _parser; + + public MP3AudioConverter(IMP3Parser parser) + { + _parser = parser; + } + public async Task ConvertAudioAsync(ReadOnlyMemory file, CancellationToken cancellationToken) + { + var baseFile = await _parser.ParseIntoMP3(file, cancellationToken); + byte[] pcmData = null!; + using var mp3Stream = new MP3Stream(new MemoryStream(baseFile.Data.ToArray())); + using var pcmStream = new MemoryStream(); + var buffer = new byte[4096]; + int bytesReturned = 1; + int totalBytesRead = 0; + + try + { + while (bytesReturned > 0) + { + try + { + bytesReturned = await mp3Stream.ReadAsync(buffer, 0, buffer.Length); + } + catch (IndexOutOfRangeException ex) + { + Console.WriteLine($"{ex.Message}"); + Console.WriteLine($"File reached a corrupted/non-compliant portion. Total bytes read: {totalBytesRead} | File: {baseFile.Name}"); + break; + } + catch (NullReferenceException ex) + { + Console.WriteLine($"{ex.Message}"); + Console.WriteLine($"File reached a corrupted/non-compliant portion. Total bytes read: {totalBytesRead} | File: {baseFile.Name}"); + break; + } + totalBytesRead += bytesReturned; + await pcmStream.WriteAsync(buffer, 0, bytesReturned); + } + } + catch (Exception ex) + { + Console.WriteLine("Exception details:"); + Console.WriteLine($"Message: {ex.Message}"); + Console.WriteLine($"StackTrace: {ex.StackTrace}"); + if (ex.InnerException != null) + { + Console.WriteLine($"InnerException: {ex.InnerException.Message}"); + Console.WriteLine($"InnerException StackTrace: {ex.InnerException.StackTrace}"); + } + } + pcmData = ResampleToMono(pcmStream.ToArray()); + + var audioDuration = (double)(pcmData.Length / 2) / mp3Stream.Frequency; + + return new AudioFile() { Name = baseFile.Name, Data = pcmData, Duration = TimeSpan.FromSeconds(audioDuration), Format = AudioFormat.Mono16, Frequency = mp3Stream.Frequency }; + } + + private static byte[] ResampleToMono(Span data) + { + byte[] newData = new byte[data.Length / 2]; + + for (int i = 0; i < data.Length / 4; ++i) + { + int HI = 1; + int LO = 0; + short left = (short)((data[i * 4 + HI] << 8) | (data[i * 4 + LO] & 0xff)); + short right = (short)((data[i * 4 + 2 + HI] << 8) | (data[i * 4 + 2 + LO] & 0xff)); + int avg = (left + right) / 2; + + newData[i * 2 + HI] = (byte)((avg >> 8) & 0xff); + newData[i * 2 + LO] = (byte)((avg & 0xff)); + } + + return newData; + } + } +} diff --git a/src/Plpext.Core/AudioPlayer/AudioContext.cs b/src/Plpext.Core/AudioPlayer/AudioContext.cs new file mode 100644 index 0000000..5584461 --- /dev/null +++ b/src/Plpext.Core/AudioPlayer/AudioContext.cs @@ -0,0 +1,48 @@ +using OpenTK.Audio.OpenAL; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.AudioPlayer +{ + public class AudioContext : IDisposable + { + private ALDevice device; + private ALContext context; + private bool disposedValue; + + public AudioContext() + { + + } + + public void Initialize() + { + device = ALC.OpenDevice(null!); + context = ALC.CreateContext(device, (int[])null!); + ALC.MakeContextCurrent(context); + } + + protected virtual void Dispose(bool disposing) + { + if (!disposedValue) + { + if (disposing) + { + ALC.DestroyContext(context); + ALC.CloseDevice(device); + } + + disposedValue = true; + } + } + + public void Dispose() + { + Dispose(true); + GC.SuppressFinalize(this); + } + } +} diff --git a/src/Plpext.Core/AudioPlayer/AudioPlayer.cs b/src/Plpext.Core/AudioPlayer/AudioPlayer.cs new file mode 100644 index 0000000..81d661c --- /dev/null +++ b/src/Plpext.Core/AudioPlayer/AudioPlayer.cs @@ -0,0 +1,224 @@ +using OpenTK.Audio.OpenAL; +using Plpext.Core.Interfaces; +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Xml.Linq; + +namespace Plpext.Core.AudioPlayer; + +public sealed class AudioPlayer : IAudioPlayer, IDisposable +{ + public event EventHandler? OnPlaybackStarted; + public event EventHandler? OnPlaybackStopped; + public event EventHandler? OnProgressUpdated; + + private readonly object _lock = new(); + private CancellationTokenSource? _playbackCts; + private Task? _playbackTask; + private int? _currentSourceId; + private int? _currentBufferId; + private AudioFile? _audioFile; + + public PlaybackState State { get; private set; } = PlaybackState.Stopped; + + public async Task InitAudioPlayerAsync(AudioFile input, CancellationToken cancellationToken) + { + _audioFile = input; + + + _playbackCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); + try + { + int bufferId = AL.GenBuffer(); + int sourceId = AL.GenSource(); + + _currentBufferId = bufferId; + _currentSourceId = sourceId; + + AL.BufferData(bufferId, ALFormat.Mono16, input.Data.Span, input.Frequency); + AL.Source(sourceId, ALSourcei.Buffer, bufferId); + return await Start(); + } + catch (Exception ex) + { + Console.WriteLine($"init error: {ex}"); + await CleanupPlaybackResources(); + return false; + } + } + + private async Task MonitorPlaybackAsync(CancellationToken cancellationToken) + { + if (_audioFile == null || !_currentSourceId.HasValue) + return; + + try + { + while (!cancellationToken.IsCancellationRequested) + { + var sourceState = (ALSourceState)AL.GetSource(_currentSourceId.Value, ALGetSourcei.SourceState); + Console.WriteLine($"source state: {sourceState}"); + if (sourceState == ALSourceState.Stopped) + break; + if (State != PlaybackState.Paused) + { + AL.GetSource(_currentSourceId.Value, ALGetSourcei.ByteOffset, out int bytesPlayed); + var currentPosition = TimeSpan.FromSeconds( + ((double)(_audioFile.Data.Length - (_audioFile.Data.Length - bytesPlayed)) / 2) / _audioFile.Frequency + ); + + Console.WriteLine($"Progress: {currentPosition.TotalSeconds:F2}s / {_audioFile.Duration.TotalSeconds:F2}s"); + + OnProgressUpdated?.Invoke(this, new() + { + CurrentPosition = currentPosition, + TotalDuration = _audioFile.Duration + }); + } + await Task.Delay(100, cancellationToken); + } + } + catch (OperationCanceledException) + { + Console.WriteLine("Playback cancelled"); + } + catch (Exception ex) + { + Console.WriteLine($"Monitor error: {ex}"); + } + finally + { + Console.WriteLine("Monitor task ending"); + OnProgressUpdated?.Invoke(this, new() + { + CurrentPosition = _audioFile.Duration, + TotalDuration = _audioFile.Duration + }); + Stop(); + } + } + + public Task Start() + { + lock (_lock) + { + if (_currentSourceId == null || _audioFile == null) + { + Console.WriteLine("Cannot start - no source or audio file"); + return Task.FromResult(false); + } + + try + { + if (State == PlaybackState.Playing) + return Task.FromResult(false); + if (State == PlaybackState.Paused) + { + Resume(); + return Task.FromResult(true); + } + if (_playbackTask != null) + { + _playbackCts?.Cancel(); + _playbackTask = null; + } + + if (_playbackCts == null || _playbackCts.IsCancellationRequested) + { + _playbackCts = new CancellationTokenSource(); + } + + State = PlaybackState.Playing; + OnPlaybackStarted?.Invoke(this, new PlaybackStartedEventArgs { AudioFile = _audioFile }); + + Console.WriteLine($"Rewind"); + AL.SourceRewind(_currentSourceId.Value); + Console.WriteLine($"Play"); + AL.SourcePlay(_currentSourceId.Value); + _playbackTask = Task.Run(() => MonitorPlaybackAsync(_playbackCts.Token)); + return Task.FromResult(true); + } + catch (Exception ex) + { + Console.WriteLine($"Start error: {ex}"); + return Task.FromResult(false); + } + } + } + + public void Resume() + { + lock (_lock) + { + if (State == PlaybackState.Paused && _currentSourceId.HasValue) + { + AL.SourcePlay(_currentSourceId.Value); + State = PlaybackState.Playing; + } + } + } + public void Pause() + { + lock (_lock) + { + if (State == PlaybackState.Playing && _currentSourceId.HasValue) + { + AL.SourcePause(_currentSourceId.Value); + State = PlaybackState.Paused; + } + } + } + + public void Stop() + { + Console.WriteLine($"STOP called"); + lock (_lock) + { + _playbackCts?.Cancel(); + + if (_currentSourceId.HasValue) + { + AL.SourceStop(_currentSourceId.Value); + } + + _playbackCts?.Cancel(); + State = PlaybackState.Stopped; + } + OnPlaybackStopped?.Invoke(this, new() { AudioFile = _audioFile }); + } + + private Task CleanupPlaybackResources() + { + try + { + if (_currentSourceId.HasValue) + { + AL.DeleteSource(_currentSourceId.Value); + _currentSourceId = null; + } + + if (_currentBufferId.HasValue) + { + AL.DeleteBuffer(_currentBufferId.Value); + _currentBufferId = null; + } + } + catch (Exception ex) + { + Console.WriteLine($"Error during cleanup: {ex}"); + } + return Task.CompletedTask; + } + + public void Dispose() + { + Stop(); + CleanupPlaybackResources().GetAwaiter().GetResult(); + _playbackCts?.Dispose(); + } +} \ No newline at end of file diff --git a/src/Plpext.Core/FileStorage/DiskFileStorage.cs b/src/Plpext.Core/FileStorage/DiskFileStorage.cs new file mode 100644 index 0000000..06a7b70 --- /dev/null +++ b/src/Plpext.Core/FileStorage/DiskFileStorage.cs @@ -0,0 +1,45 @@ +using Plpext.Core.Interfaces; +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.FileStorage +{ + public class DiskFileStorage : IFileStorage + { + public async Task SaveFilesAsync(IEnumerable files, string targetPath) + { + HashSet names = new HashSet(); + try + { + if (!Directory.Exists(targetPath)) + Directory.CreateDirectory(targetPath); + } + catch (Exception e) + { + Debug.WriteLine(e); + return; + } + + foreach (var file in files) + { + var finalFileName = TryAddName(names, string.Join("_", file.Name.Split(Path.GetInvalidFileNameChars()))); + try + { + await File.Create(Path.Combine(targetPath, $"{finalFileName}.mp3")).WriteAsync(file.Data); + } + catch (Exception e) { Debug.WriteLine(e); } + } + } + private static string TryAddName(HashSet names, string newName) + { + if (!names.Add(newName)) + return TryAddName(names, newName + "_"); + return newName; + } + } +} diff --git a/src/Plpext.Core/Interfaces/IAudioConverter.cs b/src/Plpext.Core/Interfaces/IAudioConverter.cs new file mode 100644 index 0000000..ac12c53 --- /dev/null +++ b/src/Plpext.Core/Interfaces/IAudioConverter.cs @@ -0,0 +1,12 @@ +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Interfaces; +public interface IAudioConverter +{ + Task ConvertAudioAsync(ReadOnlyMemory mp3Input, CancellationToken cancellationToken); +} diff --git a/src/Plpext.Core/Interfaces/IAudioPlayer.cs b/src/Plpext.Core/Interfaces/IAudioPlayer.cs new file mode 100644 index 0000000..9504d90 --- /dev/null +++ b/src/Plpext.Core/Interfaces/IAudioPlayer.cs @@ -0,0 +1,22 @@ +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Interfaces; + +public interface IAudioPlayer +{ + Task InitAudioPlayerAsync(AudioFile input, CancellationToken cancellationToken); + void Resume(); + void Pause(); + void Stop(); + Task Start(); + PlaybackState State { get; } + + event EventHandler OnPlaybackStarted; + event EventHandler OnPlaybackStopped; + event EventHandler OnProgressUpdated; +} diff --git a/src/Plpext.Core/Interfaces/IFileStorage.cs b/src/Plpext.Core/Interfaces/IFileStorage.cs new file mode 100644 index 0000000..2228e9c --- /dev/null +++ b/src/Plpext.Core/Interfaces/IFileStorage.cs @@ -0,0 +1,14 @@ +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Interfaces +{ + public interface IFileStorage + { + Task SaveFilesAsync(IEnumerable files, string targetPath); + } +} diff --git a/src/Plpext.Core/Interfaces/IMP3Parser.cs b/src/Plpext.Core/Interfaces/IMP3Parser.cs new file mode 100644 index 0000000..643e1c5 --- /dev/null +++ b/src/Plpext.Core/Interfaces/IMP3Parser.cs @@ -0,0 +1,14 @@ +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Interfaces +{ + public interface IMP3Parser + { + Task ParseIntoMP3(ReadOnlyMemory data, CancellationToken cancellationToken); + } +} diff --git a/src/Plpext.Core/Interfaces/IPackExtractor.cs b/src/Plpext.Core/Interfaces/IPackExtractor.cs new file mode 100644 index 0000000..5f4e5e5 --- /dev/null +++ b/src/Plpext.Core/Interfaces/IPackExtractor.cs @@ -0,0 +1,12 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Interfaces; + +public interface IPackExtractor +{ + Task>> GetFileListAsync(string filePath, CancellationToken cancellationToken); +} diff --git a/src/Plpext.Core/MP3Parser/MP3Parser.cs b/src/Plpext.Core/MP3Parser/MP3Parser.cs new file mode 100644 index 0000000..53b8fa3 --- /dev/null +++ b/src/Plpext.Core/MP3Parser/MP3Parser.cs @@ -0,0 +1,21 @@ +using MP3Sharp; +using Plpext.Core.Interfaces; +using Plpext.Core.Models; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.MP3Parser +{ + public class MP3Parser : IMP3Parser + { + public Task ParseIntoMP3(ReadOnlyMemory data, CancellationToken cancellationToken) + { + var fileName = Encoding.Latin1.GetString(data.Slice(start: 24, length: 260).Span).Split('\0')[0].Normalize().Trim(); + var fileData = data[284..]; + return Task.FromResult(new MP3File() { Name = fileName, Data = fileData }); + } + } +} diff --git a/src/Plpext.Core/Models/AudioFile.cs b/src/Plpext.Core/Models/AudioFile.cs new file mode 100644 index 0000000..6ffcb59 --- /dev/null +++ b/src/Plpext.Core/Models/AudioFile.cs @@ -0,0 +1,17 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Models +{ + public record AudioFile + { + public required string Name { get; init; } + public ReadOnlyMemory Data { get; init; } + public TimeSpan Duration { get; init; } + public AudioFormat Format { get; init; } + public int Frequency { get; init; } + } +} diff --git a/src/Plpext.Core/Models/Enums.cs b/src/Plpext.Core/Models/Enums.cs new file mode 100644 index 0000000..9777353 --- /dev/null +++ b/src/Plpext.Core/Models/Enums.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Models; + +public enum AudioFormat +{ + Unknown, + Mono16, + Stereo16 +} + +public enum PlaybackState +{ + Unknown, + Stopped, + Playing, + Paused +} \ No newline at end of file diff --git a/src/Plpext.Core/Models/EventArgs.cs b/src/Plpext.Core/Models/EventArgs.cs new file mode 100644 index 0000000..9911b36 --- /dev/null +++ b/src/Plpext.Core/Models/EventArgs.cs @@ -0,0 +1,17 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Models; + +public class PlaybackStoppedEventArgs : EventArgs +{ + public AudioFile AudioFile { get; init; } +} + +public class PlaybackStartedEventArgs : EventArgs +{ + public AudioFile AudioFile { get; init; } +} diff --git a/src/Plpext.Core/Models/MP3File.cs b/src/Plpext.Core/Models/MP3File.cs new file mode 100644 index 0000000..b1c8016 --- /dev/null +++ b/src/Plpext.Core/Models/MP3File.cs @@ -0,0 +1,14 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Models +{ + public record MP3File + { + public required string Name { get; init; } + public ReadOnlyMemory Data { get; init; } + } +} diff --git a/src/Plpext.Core/Models/PlaybackProgress.cs b/src/Plpext.Core/Models/PlaybackProgress.cs new file mode 100644 index 0000000..2156736 --- /dev/null +++ b/src/Plpext.Core/Models/PlaybackProgress.cs @@ -0,0 +1,15 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.Models +{ + public record PlaybackProgress + { + public TimeSpan CurrentPosition { get; init; } + public TimeSpan TotalDuration { get; init; } + public double ProgressPercentage => TotalDuration.TotalSeconds > 0 ? (CurrentPosition.TotalSeconds / TotalDuration.TotalSeconds) * 100 : 0; + } +} diff --git a/src/Plpext.Core/PackExtractor/CorePackExtractor.cs b/src/Plpext.Core/PackExtractor/CorePackExtractor.cs new file mode 100644 index 0000000..0d66c82 --- /dev/null +++ b/src/Plpext.Core/PackExtractor/CorePackExtractor.cs @@ -0,0 +1,63 @@ +using Plpext.Core.Interfaces; +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Plpext.Core.PackExtractor +{ + public class CorePackExtractor : IPackExtractor + { + private static readonly byte[] filePattern = { 0x53, 0x4E, 0x44, 0x55, 0x00 }; + public async Task>> GetFileListAsync(string filePath, CancellationToken cancellationToken) + { + try + { + ReadOnlyMemory file = await File.ReadAllBytesAsync(filePath, cancellationToken); + var fileIndexes = FindFileIndexes(file.Span); + + var result = new List>(); + for(int i = 0; i < fileIndexes.Count - 1; ++i) + { + var nextFile = file.Slice(start: fileIndexes[i], length: fileIndexes[i + 1] - fileIndexes[i]); + result.Add(nextFile); + } + return result; + } + catch(Exception e) + { + Debug.WriteLine(e); + throw; + } + } + + private static List FindFileIndexes(ReadOnlySpan file) + { + var result = new List(); + + + int[] skipTable = new int[256]; + for (int i = 0; i < skipTable.Length; i++) skipTable[i] = filePattern.Length; + for (int i = 0; i < filePattern.Length - 1; i++) skipTable[filePattern[i]] = filePattern.Length - i - 1; + + int idx = 0; + while (idx <= file.Length - filePattern.Length) + { + int j = filePattern.Length - 1; + while (j >= 0 && filePattern[j] == file[idx + j]) j--; + + if (j < 0) + { + result.Add(idx); + idx += filePattern.Length; + } + else + idx += skipTable[file[idx + j]]; + } + result.Add(file.Length - 1); + return result; + } + } +} diff --git a/src/Plpext.Core/Plpext.Core.csproj b/src/Plpext.Core/Plpext.Core.csproj new file mode 100644 index 0000000..9d6f66b --- /dev/null +++ b/src/Plpext.Core/Plpext.Core.csproj @@ -0,0 +1,15 @@ + + + + net8.0 + enable + enable + x86;x64 + + + + + + + +