commit 5e2fb677a2b2c6a32f8ec4cfa950197cdaad8446 Author: 4o1x5 <4o1x5@4o1x5.dev> Date: Sat Nov 9 12:02:49 2024 +0100 0.1.0 diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..e24f76a --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,22 @@ +[package] +name = "subtytle" +version = "0.1.0" +edition = "2021" +license = "AGPL-3.0" +authors = ["4o1x5 <4o1x5@4o1x5.dev>"] + + +[dependencies] +chrono = { version = "0.4.38", features = ["serde"] } +derive-getters = "0.5.0" +derive_builder = "0.20.2" +derive_setters = "0.1.6" +regex = "1.11.1" +serde = { version = "1.0.213", features = ["derive"] } +serde_json = "1.0.132" +tracing = "0.1.40" + +[dev-dependencies] +tracing-test = "0.2.5" +test-log = "0.2.16" +tracing = "0.1.40" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3972c30 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server 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, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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) 2024 + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..aca37cc --- /dev/null +++ b/readme.md @@ -0,0 +1,4 @@ +# Subtytle + +A Subtitle library for rust. +For right now only [ASS](https://breezewiki.4o1x5.dev/fileformats/wiki/SubStation_Alpha) (SubStation Alpha) is implemented, but hopefully there will be more time in the future to make room for SRT,VTT and SUB(microdvd). diff --git a/src/ass.rs b/src/ass.rs new file mode 100644 index 0000000..79c0532 --- /dev/null +++ b/src/ass.rs @@ -0,0 +1,735 @@ +use std::collections::HashMap; +use std::collections::HashSet; +use std::path::Display; +use std::str::FromStr; + +use derive_builder::Builder; +use derive_getters::Getters; +use derive_setters::Setters; +use regex::escape; +use regex::Regex; +use serde::Deserialize; +use serde::Serialize; + +// TODO implement ToString +#[derive(Debug, Builder, Deserialize, Serialize, Clone, Getters, Setters)] +pub struct AssSubtitle { + #[setters(rename = "set_script_info")] + script_info: ScriptInfo, + #[setters(rename = "set_v4_styles")] + v4_styles: Vec, + #[setters(rename = "set_events")] + events: Vec, +} + +impl AssSubtitle { + /// Adds an event to the subtitle object. + /// Be aware it will end up on the end of the list, It's not added based on the timestamp + pub fn add_event(&mut self, event: Event) { + self.events.push(event); + } +} +#[derive(Debug, Deserialize, Serialize, Clone, Builder, Getters)] +pub struct ScriptInfo { + #[builder(default = "Subtitle".to_string())] + title: String, + #[builder(default = r#"Original Script"#.to_string())] + original_script: String, + #[builder(default = r#"v4.00+""#.to_string())] + script_type: String, + #[builder(default = "None")] + collisions: Option, + #[builder(default = "None")] + play_depth: Option, +} + +#[derive(Debug, Clone, Builder, Getters, Setters, Serialize, Deserialize)] +/// An ass V4 Style section +/// All field's documentation has been taken from [a copy specification](http://www.tcax.org/docs/ass-specs.htm) to make options more clear for other developers. +pub struct V4Style { + /// The name of the Style. Case sensitive. Cannot include commas. + #[builder(default = "String::from(\"Default\")")] + #[setters(rename = "set_name")] + name: String, + + /// The name of the Style. Case sensitive. Cannot include commas. + #[builder(default = "String::from(\"Arial\")")] + #[setters(rename = "set_font_name")] + font_name: String, + + /// Size of the displayed font + #[builder(default = "20")] + #[setters(rename = "set_font_size")] + font_size: i32, + + /// A long integer BGR (blue-green-red) value. ie. the byte order in the hexadecimal equivelent of this number is BBGGRR + /// This is the colour that a subtitle will normally appear in. + /// > The color format contains the alpha channel, too. (AABBGGRR) + #[builder(default = "String::from(\"&H00FFFFFF\")")] + #[setters(rename = "set_primary_color")] + primary_color: String, + + /// A long integer BGR (blue-green-red) value. ie. the byte order in the hexadecimal equivelent of this number is BBGGRR + /// This colour may be used instead of the Primary colour when a subtitle is automatically shifted to prevent an onscreen collsion, to distinguish the different subtitles. + /// > The color format contains the alpha channel, too. (AABBGGRR) + #[builder(default = "None")] + #[setters(rename = "set_secondary_color")] + secondary_color: Option, + + /// A long integer BGR (blue-green-red) value. ie. the byte order in the hexadecimal equivelent of this number is BBGGRR + /// This colour may be used instead of the Primary or Secondary colour when a subtitle is automatically shifted to prevent an onscreen collsion, to distinguish the different subtitles + /// > The color format contains the alpha channel, too. (AABBGGRR) + #[builder(default = "String::from(\"&H00000000\")")] + #[setters(rename = "set_outline_color")] + outline_color: String, + + /// This is the colour of the subtitle outline or shadow, if these are used. A long integer BGR (blue-green-red) value. ie. the byte order in the hexadecimal equivelent of this number is BBGGRR. + /// > The color format contains the alpha channel, too. (AABBGGRR) + /// This defines whether text is bold (true) or not (false). -1 is True, 0 is False. This is independant of the Italic attribute - you can have have text which is both bold and italic + #[builder(default = "String::from(\"&H64000000\")")] + #[setters(rename = "set_back_color")] + back_color: String, + + /// This defines whether text is bold (true) or not (false). -1 is True, 0 is False. This is independant of the Italic attribute - you can have have text which is both bold and italic. + #[builder(default = "false")] + #[setters(rename = "set_bold")] + bold: bool, + + /// This defines whether text is italic (true) or not (false). -1 is True, 0 is False. This is independant of the bold attribute - you can have have text which is both bold and italic. + #[builder(default = "false")] + #[setters(rename = "set_italic")] + italic: bool, + + #[builder(default = "Some(false)")] + #[setters(rename = "set_underline")] + underline: Option, + + #[builder(default = "Some(false)")] + #[setters(rename = "set_strikeout")] + strikeout: Option, + + /// Modifies the width of the font. [percent] + #[builder(default = "100")] + #[setters(rename = "set_scale_x")] + scale_x: i8, // Percent + + /// Modifies the height of the font. [percent] + #[builder(default = "100")] + #[setters(rename = "set_scale_y")] + scale_y: i8, // Percent + + // Extra space between characters. [pixels] + #[builder(default = "None")] + #[setters(rename = "set_spacing")] + spacing: Option, // Pixels + + /// The origin of the rotation is defined by the alignment. Can be a floating point number. [degrees] + #[builder(default = "None")] + #[setters(rename = "set_angle")] + angle: Option, // -360-360 (deg) + + /// The style of the subtitles border + /// ### 1=Outline + drop shadow, 3=Opaque box + #[builder(default = "1")] + #[setters(rename = "set_border_style")] + border_style: i32, + + /// If BorderStyle is 1, then this specifies the width of the outline around the text, in pixels. + /// Values may be 0, 1, 2, 3 or 4. + #[builder(default = "1.0")] + #[setters(rename = "set_outline")] + outline: f32, + + /// If BorderStyle is 1, then this specifies the depth of the drop shadow behind the text, in pixels. Values may be 0, 1, 2, 3 or 4. Drop shadow is always used in addition to an outline - SSA will force an outline of 1 pixel if no outline width is given. + #[builder(default = "0.0")] + #[setters(rename = "set_shadow")] + shadow: f32, + + /// This sets how text is "justified" within the Left/Right onscreen margins, and also the vertical placing. Values may be 1=Left, 2=Centered, 3=Right. Add 4 to the value for a "Toptitle". Add 8 to the value for a "Midtitle". + // eg. 5 = left-justified toptitle + #[builder(default = "2")] + #[setters(rename = "set_alignment")] + alignment: i8, + + /// This defines the Left Margin in pixels. It is the distance from the left-hand edge of the screen.The three onscreen margins (MarginL, MarginR, MarginV) define areas in which the subtitle text will be displayed. + #[builder(default = "10")] + #[setters(rename = "set_margin_l")] + margin_l: i32, + + /// This defines the Right Margin in pixels. It is the distance from the right-hand edge of the screen. The three onscreen margins (MarginL, MarginR, MarginV) define areas in which the subtitle text will be displayed. + #[builder(default = "10")] + #[setters(rename = "set_margin_r")] + margin_r: i32, + + /// This defines the vertical Left Margin in pixels. + /// For a subtitle, it is the distance from the bottom of the screen. + /// For a toptitle, it is the distance from the top of the screen. + // For a midtitle, the value is ignored - the text will be vertically centred + #[builder(default = "10")] + #[setters(rename = "set_margin_v")] + margin_v: i32, + + #[builder(default = "None")] + #[setters(rename = "set_alpha_level")] + alpha_level: Option, + + // This specifies the font character set or encoding and on multi-lingual Windows installations it provides access to characters used in multiple than one languages. It is usually 0 (zero) for English (Western, ANSI) Windows. + #[builder(default = "None")] + #[setters(rename = "set_encoding")] + encoding: Option, +} +#[derive(Debug, Clone, Serialize, Deserialize, Builder, Getters, Setters)] +/// A dialogue event in ASS +pub struct Event { + // Marked ignored for now.. + #[setters(rename = "set_layer")] + layer: i32, + #[setters(rename = "set_start")] + start: i128, + #[setters(rename = "set_end")] + end: i128, + #[setters(rename = "set_style")] + style: String, + #[setters(rename = "set_name")] + name: Option, + #[setters(rename = "set_margin_l")] + margin_l: Option, + #[setters(rename = "set_margin_r")] + margin_r: Option, + #[setters(rename = "set_margin_v")] + margin_v: Option, + #[setters(rename = "set_effect")] + effect: Option, + #[setters(rename = "set_text")] + text: String, +} +impl Event { + pub fn from_srt(srt: &str) -> Result, AssConvertError> { + let mut events = Vec::new(); + let mut lines = srt.lines().peekable(); + let mut seqnum = 0; + let mut start_time = 0; + let mut end_time = 0; + let mut text = String::new(); + + while let Some(line) = lines.next() { + if line.is_empty() { + continue; + } + + if line.parse::().is_ok() { + // seq number + seqnum = line.parse::().unwrap(); + tracing::trace!("{line} | Seqnum"); + } else if line.contains(" --> ") { + // timestamp + let times: Vec<&str> = line.split(" --> ").collect(); + start_time = hh_mm_ss_mm_to_miliseconds(times[0])?; + end_time = hh_mm_ss_mm_to_miliseconds(times[1])?; + tracing::trace!("{} | Timestamp", line); + } else { + // Subtitle + tracing::trace!("{line} | Subtitle"); + text.push_str(line); + let event = Event { + layer: 0, + start: start_time, + end: end_time, + style: "Default".to_string(), + name: None, + margin_l: None, + margin_r: None, + margin_v: None, + effect: None, + text: text.clone(), + }; + text.push_str("\n"); + events.push(event); + text.clear(); + } + } + + if events.is_empty() { + return Err(AssConvertError::NoEvents); + } + + Ok(events) + } +} +impl ToString for AssSubtitle { + fn to_string(&self) -> String { + // + let mut lines = String::new(); + + lines.push_str("[Script Info]\n"); + lines.push_str(&format!("Title: {}\n", self.script_info.title)); + lines.push_str(&format!( + "Original Script: {}\n", + self.script_info.original_script + )); + lines.push_str(&format!("ScriptType: {}\n", self.script_info.script_type)); + if let Some(collisions) = &self.script_info.collisions { + lines.push_str(&format!("Collisions: {}\n", collisions)); + } + if let Some(play_depth) = &self.script_info.play_depth { + lines.push_str(&format!("PlayDepth: {}\n", play_depth)); + } + lines.push_str("\n"); + lines.push_str("[V4+ Styles]\n"); + lines.push_str("Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, AlphaLevel, Encoding\n"); + for style in &self.v4_styles { + lines.push_str( + format!( + "Style: {},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}\n", + style.name, + style.font_name, + style.font_size, + style.primary_color, + style.secondary_color.as_ref().unwrap_or(&String::from("")), + style.outline_color, + style.back_color, + if style.bold { "1" } else { "0" }, + if style.italic { "1" } else { "0" }, + match style.underline { + None => "0", + Some(a) => if a {"1"} else {"0"} + }, + match style.strikeout { + None => "0", + Some(a) => if a {"1"} else {"0"} + }, + style.scale_x, + style.scale_y, + style.spacing.unwrap_or(0), + style.angle.unwrap_or(0), + style.border_style, + style.outline, + style.shadow, + style.alignment, + style.margin_l, + style.margin_r, + style.margin_v, + style.alpha_level.unwrap_or(0), + style.encoding.unwrap_or(0), + ) + .as_str(), + ); + } + lines.push_str("\n"); + lines.push_str("[Events]\n"); + lines.push_str( + "Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\n", + ); + for event in &self.events { + lines.push_str( + format!( + "Dialogue: 0,{},{},{},{},{},{},{},{},{}\n", + // TODO convert to timestamp + format_time(event.start), + format_time(event.end), + event.style, + event.name.as_ref().unwrap_or(&String::from("")), + event.margin_l.unwrap_or(0), + event.margin_r.unwrap_or(0), + event.margin_v.unwrap_or(0), + event.effect.as_ref().unwrap_or(&String::from("")), + event.text.replace("\n", "") + ) + .as_str(), + ); + } + + lines + } +} +#[derive(Debug, Clone)] +pub enum AssConvertError { + NoScriptInfo, + InvalidScriptInfo(String), + NoV4Styles, + NoFormatInV4Styles, + NoEvents, + KeyHasNoValue, + DuplicateFormatTagsInStyle, + FieldMissing(String), + InvalidFormat(String), +} + +/// A local variable used to make sure there aren't any typos +enum CurrentSection { + V4Styles, + Events, + ScriptInfo, +} + +impl FromStr for AssSubtitle { + type Err = AssConvertError; + /// Convert a string which obeys the .ass format into an object + fn from_str(s: &str) -> Result { + let mut style_format_tags = vec![]; + let mut styles: Vec> = vec![]; + + let mut dialogue_format_tags = vec![]; + let mut dialogues: Vec> = vec![]; + + let mut script_fields = HashMap::new(); + + // A variable indicating the current section being parsed + let mut current_section = CurrentSection::ScriptInfo; + + for line in s.lines() { + let line = line.trim(); + // Filter out blank lines and comments + if line.is_empty() || line.starts_with(';') { + continue; + } + match line { + "[Script Info]" => current_section = CurrentSection::ScriptInfo, + "[V4+ Styles]" => current_section = CurrentSection::V4Styles, + "[Events]" => current_section = CurrentSection::Events, + _ => match current_section { + CurrentSection::Events => { + if line.starts_with("Format: ") { + // TODO use regex + // TODO build regex based on the amount of paremeters + let format = line.split(":").collect::>()[1]; + let format = format.split(",").collect::>(); + let clone = format.clone().iter().map(|e| e.replace(" ", "")).collect(); + + // Avoiding duplicates + if dialogue_format_tags.len() == 0 { + dialogue_format_tags = clone; + } else { + return Err(AssConvertError::DuplicateFormatTagsInStyle); + } + } else if line.starts_with("Dialogue: ") { + // Building matchers based on the len of the input tags + let mut expr = r#"^Dialogue: "#.to_string(); + for i in 0..dialogue_format_tags.len() + 1 { + if i != dialogue_format_tags.len() { + expr.push_str(r#"([^,]*),"#); + } else { + expr.pop(); + expr.push_str(r#"(.*)$"#); + } + } + tracing::trace!("Query: {}", expr); + let re = Regex::new(&expr).unwrap(); + let data = re.captures(&line).unwrap(); + let mut map = HashMap::new(); + for (index, tag_name) in dialogue_format_tags.clone().iter().enumerate() + { + let r = data.get(index + 1).unwrap().as_str().to_string(); + tracing::trace!("{}={}", tag_name, r); + // Checking if the last format tag + map.insert(tag_name.to_owned(), r); + if tag_name == dialogue_format_tags.last().unwrap() { + dialogues.push(map.clone()); + } + } + } + } + CurrentSection::V4Styles => { + if line.starts_with("Format: ") { + let format = line.split(":").collect::>()[1]; + let format = format.split(",").collect::>(); + let clone = format.clone().iter().map(|e| e.replace(" ", "")).collect(); + // Avoiding duplicates + if style_format_tags.len() == 0 { + style_format_tags = clone; + } else { + return Err(AssConvertError::DuplicateFormatTagsInStyle); + } + } else if line.starts_with("Style: ") { + // Parse the style + let mut expr = r#"^Style: "#.to_string(); + for i in 0..style_format_tags.len() + 1 { + if i != style_format_tags.len() { + expr.push_str(r#"([^,]*),"#); + } else { + expr.pop(); + expr.push_str(r#"(.*)$"#); + } + } + + let re = Regex::new(&expr).unwrap(); + let data = re.captures(&line).unwrap(); + let mut map = HashMap::new(); + for (index, tag_name) in style_format_tags.clone().iter().enumerate() { + // Checking if the last format tag + // FIXME handle unwraps + map.insert( + tag_name.to_owned(), + data.get(index + 1).unwrap().as_str().to_string(), + ); + if tag_name == style_format_tags.last().unwrap() { + styles.push(map.clone()); + } + } + } + } + CurrentSection::ScriptInfo => { + // Do nothing + let parts: Vec = line.split(":").map(|e| e.to_string()).collect(); + let key = parts.first().unwrap().clone(); + let value = parts.get(1).ok_or(AssConvertError::KeyHasNoValue)?.clone(); + script_fields.insert(key, value); + } + }, + } + } // end of iter + + let mut v4_styles = vec![]; + for map in styles { + // turn into V4Style + tracing::trace!("{:?}", map.get("Fontsize")); + tracing::trace!("{:?}", map.get("Name")); + // TODO make some fields optional + v4_styles.push(V4Style { + name: map + .get("Name") + .ok_or(AssConvertError::FieldMissing("Name".to_string()))? + .to_string(), + + font_name: map + .get("Fontname") + .ok_or(AssConvertError::FieldMissing("Fontname".to_string()))? + .to_string(), + font_size: map + .get("Fontsize") + .ok_or(AssConvertError::FieldMissing("Fontsize".to_string()))? + .parse() + .map_err(|e| { + AssConvertError::InvalidFormat(format!("Invalid font size, {e}")) + })?, + primary_color: map + .get("PrimaryColour") + .ok_or(AssConvertError::FieldMissing("PrimaryColour".to_string()))? + .to_string(), + secondary_color: map.get("SecondaryColour").map(|v| v.to_string()), + outline_color: map + .get("OutlineColour") + .ok_or(AssConvertError::FieldMissing("OutlineColour".to_string()))? + .to_string(), + back_color: map + .get("BackColour") + .ok_or(AssConvertError::FieldMissing("BackColour".to_string()))? + .to_string(), + bold: map + .get("Bold") + .map(|v| match v.to_owned().as_str() { + "1" => Some(true), + _ => Some(false), + }) + .flatten() + .ok_or(AssConvertError::FieldMissing("Bold".to_string()))?, + italic: map + .get("Italic") + .map(|v| match v.to_owned().as_str() { + "1" => Some(true), + _ => Some(false), + }) + .flatten() + .ok_or(AssConvertError::FieldMissing("Italic".to_string()))?, + underline: map.get("Underline").map(|v| v.parse().ok()).flatten(), + strikeout: map.get("StrikeOut").map(|v| v.parse().ok()).flatten(), + spacing: map.get("Spacing").map(|v| v.parse().ok()).flatten(), + angle: map.get("Angle").map(|v| v.parse().ok()).flatten(), + border_style: map + .get("BorderStyle") + .ok_or(AssConvertError::FieldMissing("BorderStyle".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid border style value".to_string()) + })?, + outline: map + .get("Outline") + .ok_or(AssConvertError::FieldMissing("Outline".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid outline value".to_string()) + })?, + shadow: map + .get("Shadow") + .ok_or(AssConvertError::FieldMissing("Shadow".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid shadow value".to_string()) + })?, + alignment: map + .get("Alignment") + .ok_or(AssConvertError::FieldMissing("Alignment".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid alignment value".to_string()) + })?, + margin_l: map + .get("MarginL") + .ok_or(AssConvertError::FieldMissing("MarginL".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid margin l value".to_string()) + })?, + margin_r: map + .get("MarginR") + .ok_or(AssConvertError::FieldMissing("MarginR".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid margin r value".to_string()) + })?, + margin_v: map + .get("MarginV") + .ok_or(AssConvertError::FieldMissing("MarginV".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid margin v value".to_string()) + })?, + scale_x: map + .get("ScaleX") + .ok_or(AssConvertError::FieldMissing("ScaleX".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid scale x value".to_string()) + })?, + scale_y: map + .get("ScaleY") + .ok_or(AssConvertError::FieldMissing("ScaleY".to_string()))? + .parse() + .map_err(|_| { + AssConvertError::InvalidFormat("Invalid scale x value".to_string()) + })?, + alpha_level: map.get("AlphaLevel").map(|v| v.parse().ok()).flatten(), + encoding: map.get("Encoding").map(|v| v.parse().ok()).flatten(), + }); + } + let mut events = vec![]; + for dialogue in dialogues { + // push Event into events based on hashmap + tracing::debug!("Current dialog's map: {:?}", dialogue); + events.push(Event { + effect: dialogue.get("Effect").map(|v| v.to_string()), + layer: dialogue + .get("Layer") + .map(|v| v.parse().ok()) + .flatten() + .unwrap(), + margin_l: dialogue.get("MarginL").map(|v| v.parse().ok()).flatten(), + margin_r: dialogue.get("MarginR").map(|v| v.parse().ok()).flatten(), + margin_v: dialogue.get("MarginV").map(|v| v.parse().ok()).flatten(), + name: dialogue.get("Name").map(|v| v.to_string()), + start: ass_hh_mm_ss_mm_to_miliseconds( + dialogue + .get("Start") + .map(|v| v.to_string()) + .unwrap() + .as_str(), + ) + .map_err(|e| { + tracing::error!("Error parsing start time: {:?}", e); + AssConvertError::InvalidFormat("Invalid start time".to_string()) + })?, + end: ass_hh_mm_ss_mm_to_miliseconds( + dialogue.get("End").map(|v| v.to_string()).unwrap().as_str(), + ) + .map_err(|e| { + tracing::error!("Error parsing end time: {:?}", e); + AssConvertError::InvalidFormat("Invalid end time".to_string()) + })?, + style: dialogue.get("Style").map(|v| v.to_string()).unwrap(), + text: dialogue.get("Text").map(|v| v.to_string()).unwrap(), + }); + } + // TODO: Parse ScriptInfo + let script_info = ScriptInfo { + title: "Subtitle".to_string(), + original_script: "Original Script".to_string(), + script_type: "v4.00+".to_string(), + collisions: None, + play_depth: None, + }; + + Ok(Self { + script_info, + v4_styles: v4_styles, + events: events, + }) + } +} + +fn hh_mm_ss_mm_to_miliseconds(timestamp: &str) -> Result { + let parts: Vec<&str> = timestamp.split(',').collect(); + if parts.len() != 2 { + return Err(AssConvertError::InvalidFormat( + "Invalid time format".to_string(), + )); + } + + let time = parts[0]; + let millis = parts[1] + .trim() + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid milliseconds".to_string()))?; + let time_parts: Vec<&str> = time.split(':').collect(); + if time_parts.len() != 3 { + return Err(AssConvertError::InvalidFormat( + "Invalid time format".to_string(), + )); + } + + let hours = time_parts[0] + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid hours".to_string()))?; + let minutes = time_parts[1] + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid minutes".to_string()))?; + let seconds = time_parts[2] + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid seconds".to_string()))?; + + let total_millis = (hours * 3600 * 1000) + (minutes * 60 * 1000) + (seconds * 1000) + millis; + Ok(total_millis) +} + +fn ass_hh_mm_ss_mm_to_miliseconds(timestamp: &str) -> Result { + let parts: Vec<&str> = timestamp.split('.').collect(); + if parts.len() != 2 { + return Err(AssConvertError::InvalidFormat( + "Invalid time format".to_string(), + )); + } + + let time = parts[0]; + let millis = parts[1] + .trim() + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid milliseconds".to_string()))?; + let time_parts: Vec<&str> = time.split(':').collect(); + if time_parts.len() != 3 { + return Err(AssConvertError::InvalidFormat( + "Invalid time format".to_string(), + )); + } + + let hours = time_parts[0] + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid hours".to_string()))?; + let minutes = time_parts[1] + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid minutes".to_string()))?; + let seconds = time_parts[2] + .parse::() + .map_err(|_| AssConvertError::InvalidFormat("Invalid seconds".to_string()))?; + + let total_millis = (hours * 3600 * 1000) + (minutes * 60 * 1000) + (seconds * 1000) + millis; + Ok(total_millis) +} +fn format_time(milliseconds: i128) -> String { + let hours = milliseconds / 3600000; + let minutes = (milliseconds % 3600000) / 60000; + let seconds = (milliseconds % 60000) / 1000; + let centiseconds = (milliseconds % 1000) / 10; + format!( + "{:01}:{:02}:{:02}.{:02}", + hours, minutes, seconds, centiseconds + ) +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..c2d05e0 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,275 @@ +pub mod ass; +#[cfg(test)] + +mod test { + + use std::str::FromStr; + + use test_log::test; + use tracing_test::traced_test; + + use crate::ass::{ + AssSubtitle, AssSubtitleBuilder, Event, ScriptInfo, ScriptInfoBuilder, V4Style, + V4StyleBuilder, + }; + #[test(test)] + #[traced_test] + // Smoke test + fn decode() { + // TODO replace " " with nothing + let ass = r#" +[Script Info] +; This is a simple example of an ASS file +Title: Example Subtitle +Original Script: Original script +ScriptType: v4.00+ + +[V4+ Styles] +Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding +Style: Default,Arial,20,&H00FFFFFF,&H000000FF,&H00000000,&H64000000,-1,0,0,0,100,100,0,0,1,1,0,2,10,10,10,1 +Style: Default,Arial,20,&H00FFFFFF,&H000000FF,&H00000000,&H64000000,-1,0,0,0,100,100,0,0,1,1,0,2,10,10,10,1 + +[Events] +Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text +Dialogue: 0,0:00:01.00,0:00:05.00,Default,,0,0,0,,Hello, this is an example subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +Dialogue: 0,0:00:06.00,0:00:10.00,Default,,0,0,0,,This is another line of subtitle. +"#; + let ass_decoded = AssSubtitle::from_str(ass).unwrap(); + tracing::info!("Amount of events: {}", ass_decoded.events().len()); + + for event in ass_decoded.events() { + tracing::info!("{}", event.text()); + } + } + + #[test(test)] + #[traced_test] + fn complex() { + let ass = r#" +[Script Info] +; Script generated by Aegisub v2.1.1 RELEASE PREVIEW (SVN r1952, amz) +; http://www.aegisub.net +Title: Default Aegisub file +Original Script: Someone +ScriptType: v4.00+ +WrapStyle: 0 +PlayResX: 640 +PlayResY: 480 +ScaledBorderAndShadow: yes +Last Style Storage: Default +Video File: ?dummy:23.976000:40000:640:480:47:163:254: +Video Aspect Ratio: 0 +Video Zoom: 8 +Video Position: 0 + +[V4+ Styles] +Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding +Style: Alt,Times New Roman,40,&H00FFFFFF,&H000000FF,&H00000000,&H00000000,0,0,0,0,100,100,0,0,1,2,2,8,10,10,10,0 +Style: Default,Arial,20,&H00FFFFFF,&H000000FF,&H00000000,&H00000000,0,0,0,0,100,100,0,0,1,2,2,2,10,10,10,0 + +[Events] +Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text +Dialogue: 0,0:00:00.00,0:00:05.00,Default,,0000,0000,0000,,This is a test of the ASS format and some basic features in it. +Dialogue: 0,0:00:05.00,0:00:07.00,Default,,0000,0000,0000,,This and the previous line should both show at the bottom of the video in 20 pixel high white Arial with a 2 pixel black outline and 2 pixel offset shadow. This line is long so it should automatically be broken into several lines that are approximately even length, with upper lines being longer. +Dialogue: 0,0:00:07.00,0:00:09.00,Default,,0000,0000,0000,,Now going to test conflict resolution. {By the way, this is a common abuse, "inline-comments" in override tag groups. They should not be rendered and not generate errors, just be ignored.} +Dialogue: 0,0:00:07.50,0:00:09.00,Default,,0000,0000,0000,,This line should be above the previous. +Dialogue: 0,0:00:09.00,0:00:11.00,Default,,0000,0000,0000,,{\an1}This line should be lower-left aligned using the \an1 override. +Dialogue: 0,0:00:11.00,0:00:13.00,Default,,0000,0000,0000,,{\an9}Upper right +Dialogue: 0,0:00:12.00,0:00:14.00,Alt,,0000,0000,0000,,This one should be below the "Upper right" line and be centered on screen. It should also be in 40 pixel high Times New Roman. +Dialogue: 0,0:00:14.00,0:00:16.00,Alt,,0000,0000,0000,,{\fs10}This should also be a toptitle in Times New Roman, but much smaller. Using an override tag to change size. +Dialogue: 0,0:00:16.00,0:00:18.00,Alt,,0000,0000,0000,,{\a5}Top-left using the legacy \a5 tag +Dialogue: 0,0:00:18.00,0:00:20.00,Default,,0000,0000,0000,,{\an5}This line is centered on screen.\NAt the bottom of the screen should be two lines in different layers, they are rendered on top of each other because conflict resolution only considers lines in the same layer. +Dialogue: 0,0:00:18.00,0:00:20.00,Default,,0000,0000,0000,,This is in layer 0 +Dialogue: 1,0:00:18.00,0:00:20.00,Default,,0000,0000,0000,,And this line is in layer 1 +Dialogue: 0,0:00:20.00,0:00:22.00,Default,,0000,0000,0000,,Another line in layer 0 +Dialogue: 1,0:00:20.00,0:00:22.00,Default,,0050,0000,0020,,And this line is in layer 1, but has changed its margins so it isn't exactly centered, and it's raised above the other line. +Dialogue: 0,0:00:22.00,0:00:24.00,Default,,0000,0000,0000,,Switching {\fnTimes New Roman}font inline, {\r}and resetting styles +Dialogue: 0,0:00:24.00,0:00:26.00,Default,,0000,0000,0000,,Also {\rAlt}switching to a different style {\r}inline +Dialogue: 0,0:00:26.00,0:00:28.00,Default,,0000,0000,0000,,{\an5\pos(258,131)}Positioning... this line should be in an odd place +Dialogue: 0,0:00:26.00,0:00:28.00,Default,,0000,0000,0000,,{\an5\pos(222,338)\frz29.559}So should this one, and be rotated +Dialogue: 0,0:00:28.00,0:00:30.00,Default,,0000,0000,0000,,{\pos(371,314)\frz338.403\frx42\fry30\org(187,165)}Some more rotation tricks, this time in 3D and with a different origin +Dialogue: 0,0:00:30.00,0:00:32.00,Default,,0000,0000,0000,,{\an5\t(\frz360)}This line is animated and rotates 360 degrees over its duration +Dialogue: 0,0:00:32.00,0:00:34.00,Default,,0000,0000,0000,,{\an5\move(182,157,414,311)}This line moves +Dialogue: 0,0:00:34.00,0:00:36.00,Default,,0000,0000,0000,,{\an5\clip(126,192,487,241)}This line is only partially visible\Nso if you can see this, \clip is handled incorrectly +Dialogue: 0,0:00:36.00,0:00:38.00,Default,,0000,0000,0000,,{\an5\clip(m 178 212 l 163 249 212 302 257 232 309 249 366 241 392 285 473 267 487 210 421 241 353 219 207 258)}And this line has a funnily-shaped clip area +Dialogue: 0,0:00:38.00,0:00:40.00,Default,,0000,0000,0000,,{\an5\pos(321,193)}Here should be a pretty feather with a thin border and no shadow: +Dialogue: 0,0:00:38.00,0:00:40.00,Default,,0000,0000,0000,,{\an5\bord1\shad0\p1\fscx300\fscy300\pos(316,312)}m 0 0 b 33 -3 48 -7 61 -19 b 53 -7 31 -1 1 2 m 9 0 b 9 -5 10 -6 14 -12 b 9 -5 10 -3 10 0 m 10 -1 b 10 -5 11 -8 16 -12 b 17 -12 18 -13 22 -14 b 18 -10 16 -6 15 -1 b 17 -6 19 -10 23 -14 l 26 -15 b 22 -11 20 -6 19 -2 b 24 -11 27 -14 28 -15 b 31 -16 35 -16 39 -16 b 37 -14 36 -10 36 -5 b 36 -9 38 -14 39 -16 b 41 -16 43 -16 45 -15 b 44 -13 43 -10 43 -7 l 29 -3 m 43 -7 b 44 -11 45 -13 47 -15 b 46 -13 46 -11 46 -9 b 46 -11 47 -13 49 -15 b 51 -15 48 -13 48 -9 b 49 -11 49 -14 52 -16 b 55 -16 53 -17 51 -11 l 48 -8 m 54 -13 b 53 -14 54 -15 54 -16 b 54 -15 54 -14 55 -13 b 57 -13 60 -12 62 -14 b 61 -12 55 -12 53 -12 b 55 -11 56 -10 61 -10 b 61 -7 53 -9 52 -11 b 53 -8 55 -7 58 -6 b 57 -5 56 -4 54 -3 b 49 -5 48 -6 47 -9 b 47 -6 50 -4 53 -2 b 49 -3 47 -6 45 -8 b 46 -6 49 -3 52 -1 b 46 2 45 3 43 3 b 40 0 39 -3 40 -6 b 39 -3 39 1 42 3 b 40 6 36 1 34 -4 b 35 -1 36 2 38 5 b 32 7 26 9 22 8 b 19 5 17 2 16 -1 b 17 3 19 5 20 7 b 17 4 16 2 15 0 b 15 2 17 5 19 8 b 15 9 13 3 12 0 l 25 -2 l 42 -7 m 12 0 b 13 3 13 7 17 9 b 12 7 10 1 10 0 +Dialogue: 0,0:00:40.00,0:00:42.00,Default,,0000,0000,0000,,Some other basic font style tests:\NNormal, {\b1}Boldface{\r}, {\i1}Italics{\r}, {\u1}Underline{\r}, {\s1}Strikethrough +Dialogue: 0,0:00:42.00,0:00:44.00,Default,,0000,0000,0000,,There should be no linebreak here,\nbut there should be one here\Nso this is on a separate line. +Dialogue: 0,0:00:44.00,0:00:46.00,Default,,0000,0000,0000,,This line is pushed left by adding some hard spaces to the right\h\h\h\h\h\h\h\h\h\h\h\h\h\h\h\h\h\h\h\h +Dialogue: 0,0:00:44.00,0:00:46.00,Default,,0000,0000,0000,, Regular spaces at line start/end are ignored, so this line is centered +Dialogue: 0,0:00:46.00,0:00:48.00,Default,,0000,0000,0000,,{\an8\q2}This is a long line but it is not broken into several because it's using the \q override tag which changes the line-wrapping mode for a single line. The tag can take several values, 0 is the default which is "smart wrapping" with top lines longer, 1 is regular wrapping, 2 is no wrapping and 3 is smart-wrapping with bottom lines longer. +Dialogue: 0,0:00:46.00,0:00:48.00,Default,,0000,0000,0000,,{\an5\q1}This is a long line using the \q1 override tag to get "dumb" wrapping, make as long lines as possible and first wrap when it'd go off screen. This is mostly visible when the last line generated is short. +Dialogue: 0,0:00:46.00,0:00:48.00,Default,,0000,0000,0000,,{\q3}And this line uses the \q3 wrapping style, which is similar to the \q0 default smart-wrap style, but has lower lines longer than the upper ones. +Dialogue: 0,0:00:48.00,0:00:50.00,Default,,0000,0000,0000,,{\an5}{\bord0\t(\bord10)}This text has a growing border\N{\r\shad0\t(\shad10)}This text has an increasing shadow\N{\r\t(\fry360)}This text is rotating around the Y axis\N{\r\t(\frz720)}This text rotates {\t(\frx360)}and this one even more +Dialogue: 0,0:00:50.00,0:00:52.00,Default,,0000,0000,0000,,{\an5\bord0\shad0}All of this has no border or shadow...\N{\1c&H0000FF&}This is bright red, {\1c&H00FF00&}green, {\1c&HFF0000}blue{\1c&HFFFFFF&}\N{\1a&H80&}50% transparent +Dialogue: 0,0:00:52.00,0:00:54.00,Default,,0000,0000,0000,,{\fsp10}Large inter-letter spacing +Dialogue: 0,0:00:54.00,0:00:56.00,Default,,0000,0000,0000,,{\shad0}No shadow here, just regular border, {\be1}but this is \be1 blurred edges! +Dialogue: 0,0:00:56.00,0:00:58.00,Default,,0000,0000,0000,,{\t(1000,2000,\alpha&HFF&)}Fading out after 1 sec on screen, using \alpha. Everything should fade. +Dialogue: 0,0:00:58.00,0:01:00.00,Default,,0000,0000,0000,,{\fad(1000,1000)}Fading in and out using \fad +Dialogue: 0,0:01:00.00,0:01:02.00,Default,,0000,0000,0000,,{\k10}And {\k5}now {\k20}for {\kf50}ka{\kf20}ra{\K70}o{\K10}ke{\k0}! +"#; + + let ass_decoded = AssSubtitle::from_str(ass).unwrap(); + tracing::info!("Complex: {:?}", ass_decoded); + + for event in ass_decoded.events() { + tracing::info!("{:?}", event); + } + } + + #[test(test)] + #[traced_test] + fn less_tags() { + let ass = r#" +[Script Info] +PlayResX: 1280 +PlayResY: 720 +WrapStyle: 1 + +[V4+ Styles] +Format: Name, Fontname, Fontsize, PrimaryColour, Alignment, Encoding +Style: A1, Arial,34,&H3030FF,1,0 +Style: A2, Arial,34,&H3030FF,2,0 +Style: A3, Arial,34,&H3030FF,3,0 +Style: A4, Arial,34,&H3030FF,4,0 +Style: A5, Arial,34,&H3030FF,5,0 +Style: A6, Arial,34,&H3030FF,6,0 +Style: A7, Arial,34,&H3030FF,7,0 +Style: A8, Arial,34,&H3030FF,8,0 +Style: A9, Arial,34,&H3030FF,9,0 + +[Events] +Format: Start, End, Style, Text +Dialogue: 0:00:00.00,0:00:10.00,A1,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:00:10.00,0:00:20.00,A2,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:00:20.00,0:00:30.00,A3,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:00:30.00,0:00:40.00,A4,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:00:40.00,0:00:50.00,A5,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:00:50.00,0:01:00.00,A6,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:01:00.00,0:01:10.00,A7,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:01:10.00,0:01:20.00,A8,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +Dialogue: 0:01:20.00,0:01:30.00,A9,{\pos(600,400)}The quick brown fox jumps over a lazy dog.\NSphinx of black quartz, judge my vow. +"#; + let ass_decoded = AssSubtitle::from_str(ass).unwrap(); + tracing::info!("Less tags: {:?}", ass_decoded); + } + + #[test(test)] + #[traced_test] + fn parse_event_from_srt() { + let srt = r#"1 + 00:00:00,500 --> 00:00:02,000 + Hello, world! + 2 + 00:00:05,500 --> 00:00:09,000 + asdasd + asd + asd + 2 + 00:00:05,500 --> 00:00:09,000 + something"#; + let srt = srt.replace(" ", ""); + let events = Event::from_srt(srt.as_str()).unwrap(); + tracing::info!("Subtitles {:?}", events); + assert_eq!(events.first().unwrap().text(), "Hello, world!\n"); + assert_eq!(events.get(1).unwrap().text(), "asdasd\nasd\nasd\n"); + assert_eq!(events.get(2).unwrap().text(), "something\n"); + } + #[test(test)] + #[traced_test] + fn translate_srt_to_ass() { + let srt = r#" +1 +00:00:00,000 --> 00:00:04,960 +But the thing that was growing was these unregulated offshore gambling sites. + +2 +00:00:04,960 --> 00:00:09,880 +And just for people that don't understand, right, these are sites that there is nobody + +3 +00:00:09,880 --> 00:00:13,320 +overlooking to see, for example, what are the odds on the craps tables? + +4 +00:00:13,320 --> 00:00:15,980 +Are they, or do they tweak with them? + +5 +00:00:15,980 --> 00:00:16,740 +Do they change them? + +6 +00:00:16,740 --> 00:00:17,740 +Because they're not regulated. + +7 +00:00:17,740 --> 00:00:20,180 +The team decides what they want to do. + +8 +00:00:20,180 --> 00:00:28,080 +There's a reason that you have to VPN in and you can't, you know, do it from most major, + +9 +00:00:28,080 --> 00:00:29,680 +you know, major countries. + +10 +00:00:29,680 --> 00:00:35,660 +And so the amount of money that was flowing where our creators was building the community + +11 +00:00:35,660 --> 00:00:40,240 +and connection that they formed on Twitch to drive people through these sites, it was + +12 +00:00:40,240 --> 00:00:43,580 +a significant amount of money to a small number of creators. + +13 +00:00:43,580 --> 00:00:45,940 +And we decided we didn't think that was good for the community. + +14 +00:00:45,940 --> 00:00:49,100 +So we decided we banned the unregulated. + +15 +00:00:49,100 --> 00:00:53,500 +But in general, it's, there's no problem with streaming gambling. + +16 +00:00:53,500 --> 00:00:59,460 +Um, uh, but we do have a problem if you're streaming these unregulated third-party sites. + "#; + let srt = srt.replace(" ", ""); + let ass = "[Script Info]\nTitle: Subtitle\nOriginal Script: Original Script\nScriptType: v4.00+\n\n[V4+ Styles]\nFormat: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, AlphaLevel, Encoding\nStyle: Default,Arial,20,&H00FFFFFF,,&H00000000,&H64000000,-1,-1,-1,-1,100,100,0,0,1,1,0,2,10,10,10,0,0\n[Events]\nFormat: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\nDialogue: 0,0:00:00.50,0:00:02.00,Default,,0,0,0,,asd\nDialogue: 0,0:00:05.50,0:00:09.00,Default,,0,0,0,,hello\nDialogue: 0,0:00:05.50,0:00:09.00,Default,,0,0,0,,something"; + let events = Event::from_srt(srt.as_str()).unwrap(); + + tracing::info!("Subtitles {:?}", events); + let ass_from_srt = AssSubtitleBuilder::default() + .events(events) + .v4_styles(vec![V4StyleBuilder::default().build().unwrap()]) + .script_info(ScriptInfoBuilder::default().build().unwrap()) + .build() + .unwrap() + .to_string(); + + print!("{}", ass); + assert_eq!(ass, ass_from_srt); + } +}