commit 4eb003876942dd6ba73faa3d186cba2f94a2d5e1 equwal <truex@equwal.com> 2026-09-21 02:16:02 -0700 SubRead for YouTube 0.1.0: show your own .srt over a YouTube video A Manifest V3 extension for Chrome and Firefox. The user chooses an .srt, and the extension shows each line over the player in time with the video. A start offset and a speed control cover an upload that has an intro or runs a little fast. The subtitles are kept for each video. The extension does not read, record or download the video or its sound: the stores and YouTube's terms do not allow that. It points to subread.space for the subtitles.
.gitignore | 2 + LICENSE | 662 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 43 ++++ icons/128.png | Bin 0 -> 2285 bytes icons/16.png | Bin 0 -> 360 bytes icons/32.png | Bin 0 -> 834 bytes icons/48.png | Bin 0 -> 1151 bytes manifest.json | 22 ++ popup.html | 22 ++ src/content.css | 37 +++ src/content.js | 172 +++++++++++++ src/srt.js | 54 +++++ store/listing.md | 50 ++++ tests/mock/server.py | 33 +++ tests/srt.test.cjs | 56 +++++ tools/pack.py | 23 ++ 16 files changed, 1176 insertions(+)
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1eae0cf --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +dist/ +node_modules/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fe6b903 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 <https://www.gnu.org/licenses/>. + +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 +<https://www.gnu.org/licenses/>. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..eca4f81 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# SubRead for YouTube (Chrome and Firefox) + +Shows your own `.srt` over a YouTube video, in time with it. It is made for +audiobooks on YouTube: make book-accurate subtitles at +[subread.space](https://subread.space) from the audiobook and its ebook (free, +in the browser), then read along on the video. + +Press **SR** at the top right of the player, and choose the `.srt`. + +- **Start**: the video on YouTube often has an intro that your audio file does + not. Play to where the narrator reads the first line and press + **First line is now**, or move the start by 0.1 s and 1 s. +- **Speed**: for an upload that runs a little faster or slower than your file. +- The subtitles and these settings are kept for each video (the newest 8). + +## What it does not do + +It does not read, record or download the video or its sound, and it sends +nothing anywhere. The one permission is `storage`, to keep your subtitles in +the browser. The stores do not allow an extension that takes media from +YouTube, and YouTube's terms do not allow it; this one only draws text. + +## Layout + +| Path | What | +|---|---| +| `manifest.json` | Manifest V3, the same for both browsers (`browser_specific_settings` is for Firefox) | +| `src/srt.js` | Reads .srt and .vtt; finds the cue for a moment. No browser APIs, so Node tests it | +| `src/content.js`, `src/content.css` | The caption box, the **SR** button and the panel, inside `#movie_player` | +| `popup.html` | How to use it | +| `tests/srt.test.cjs` | `node --test tests/srt.test.cjs` | +| `tests/mock/server.py` | A stand-in for a watch page, to try the content script by hand | +| `tools/pack.py` | Makes `dist/subread-chrome.zip` and `dist/subread-firefox.zip` | +| `store/listing.md` | The texts and answers for the two stores | + +## Try it + +Chrome: `chrome://extensions` > Developer mode > Load unpacked > this folder. +Firefox: `about:debugging` > This Firefox > Load Temporary Add-on > `manifest.json`. + +## Licence + +AGPL-3.0: see `LICENSE`. diff --git a/icons/128.png b/icons/128.png new file mode 100644 index 0000000..04833e9 Binary files /dev/null and b/icons/128.png differ diff --git a/icons/16.png b/icons/16.png new file mode 100644 index 0000000..be8f34d Binary files /dev/null and b/icons/16.png differ diff --git a/icons/32.png b/icons/32.png new file mode 100644 index 0000000..74b43bb Binary files /dev/null and b/icons/32.png differ diff --git a/icons/48.png b/icons/48.png new file mode 100644 index 0000000..4044165 Binary files /dev/null and b/icons/48.png differ diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..4e4a8c3 --- /dev/null +++ b/manifest.json @@ -0,0 +1,22 @@ +{ + "manifest_version": 3, + "name": "SubRead: your subtitles on YouTube", + "short_name": "SubRead", + "version": "0.1.0", + "description": "Show your own .srt over a YouTube video, in time with it. Made for audiobooks with book-accurate subtitles from subread.space.", + "homepage_url": "https://subread.space", + "icons": { "16": "icons/16.png", "32": "icons/32.png", "48": "icons/48.png", "128": "icons/128.png" }, + "action": { "default_title": "SubRead", "default_popup": "popup.html" }, + "permissions": ["storage"], + "content_scripts": [ + { + "matches": ["https://www.youtube.com/*"], + "js": ["src/srt.js", "src/content.js"], + "css": ["src/content.css"], + "run_at": "document_idle" + } + ], + "browser_specific_settings": { + "gecko": { "id": "youtube@subread.space", "strict_min_version": "115.0" } + } +} diff --git a/popup.html b/popup.html new file mode 100644 index 0000000..03de722 --- /dev/null +++ b/popup.html @@ -0,0 +1,22 @@ +<!doctype html> +<meta charset="utf-8"> +<title>SubRead</title> +<style> + body { width: 320px; margin: 0; padding: 14px 16px; font: 14px/1.45 system-ui, Arial, sans-serif; color: #111; background: #fff; } + h1 { font-size: 16px; margin: 0 0 8px; } + ol { padding-left: 20px; margin: 8px 0; } + li { margin: 5px 0; } + p { margin: 8px 0; } + .muted { color: #555; font-size: 12.5px; } + @media (prefers-color-scheme: dark) { body { background: #1b1b1f; color: #eee; } .muted { color: #aaa; } a { color: #9cc3ff; } } +</style> +<h1>SubRead: your subtitles on YouTube</h1> +<ol> + <li>Open a video on YouTube, for example an audiobook.</li> + <li>Press <b>SR</b> at the top right of the player.</li> + <li>Choose the <b>.srt</b> of that recording. If the video has an intro, play to the first line and press <b>First line is now</b>.</li> +</ol> +<p>No subtitles yet? <a href="https://subread.space" target="_blank" rel="noopener">subread.space</a> makes them from + the audiobook and its ebook, free, in your browser. The words come from the book, so names and spelling are right.</p> +<p class="muted">The extension does not read, record or download the video. Your subtitles stay in this browser. + Open source: <a href="https://github.com/equwal/subread-extension" target="_blank" rel="noopener">GitHub</a>.</p> diff --git a/src/content.css b/src/content.css new file mode 100644 index 0000000..dd696a3 --- /dev/null +++ b/src/content.css @@ -0,0 +1,37 @@ +/* Over the YouTube player. Each name starts with subread- so that nothing of the page is touched. */ +#movie_player .subread-box { + position: absolute; left: 5%; right: 5%; bottom: 12%; z-index: 60; + text-align: center; pointer-events: none; line-height: 1.35; + font-family: "Noto Sans", "Hiragino Sans", "Yu Gothic", Roboto, Arial, sans-serif; +} +#movie_player .subread-box[hidden] { display: none; } +#movie_player .subread-line { + display: inline; white-space: pre-line; padding: 2px 8px; + color: #fff; background: rgba(8, 8, 8, .78); border-radius: 3px; + -webkit-box-decoration-break: clone; box-decoration-break: clone; +} +#movie_player .subread-button { + position: absolute; top: 12px; right: 12px; z-index: 61; + width: 34px; height: 26px; padding: 0; border: 1px solid rgba(255, 255, 255, .7); border-radius: 4px; + background: rgba(8, 8, 8, .6); color: #fff; font: 600 12px/1 Arial, sans-serif; cursor: pointer; opacity: .55; +} +#movie_player .subread-button:hover, #movie_player .subread-button.subread-on { opacity: 1; } +#movie_player .subread-button.subread-on { background: #fff; color: #000; } +#movie_player.ytp-autohide .subread-button:not(.subread-on) { opacity: 0; } +#movie_player .subread-panel { + position: absolute; top: 46px; right: 12px; z-index: 62; width: 300px; padding: 12px 14px; + background: rgba(16, 16, 16, .94); color: #eee; border-radius: 8px; font: 13px/1.4 Arial, sans-serif; text-align: left; +} +#movie_player .subread-panel[hidden] { display: none; } +#movie_player .subread-title { font-weight: 700; margin-bottom: 4px; } +#movie_player .subread-status { color: #bbb; margin-bottom: 8px; overflow-wrap: anywhere; } +#movie_player .subread-row { display: flex; align-items: center; gap: 6px; margin: 7px 0; flex-wrap: wrap; } +#movie_player .subread-panel button { + background: #2c2c2c; color: #eee; border: 1px solid #555; border-radius: 4px; padding: 3px 8px; cursor: pointer; font: inherit; +} +#movie_player .subread-panel button:hover { background: #3a3a3a; } +#movie_player .subread-offset { min-width: 58px; text-align: center; font-variant-numeric: tabular-nums; } +#movie_player .subread-rate { width: 84px; background: #222; color: #eee; border: 1px solid #555; border-radius: 4px; padding: 2px 4px; } +#movie_player .subread-file { max-width: 190px; color: #ccc; font-size: 12px; } +#movie_player .subread-help { color: #bbb; display: block; font-size: 12px; } +#movie_player .subread-help a { color: #9cc3ff; } diff --git a/src/content.js b/src/content.js new file mode 100644 index 0000000..18e17ca --- /dev/null +++ b/src/content.js @@ -0,0 +1,172 @@ +/* Your own subtitles over a YouTube video. + * + * The extension reads an .srt that you give it, and shows each line over the + * player in time with the video. It does not read, record or download the + * video or its sound, and it sends nothing anywhere: the subtitles stay in + * this browser, kept for each video so that they are there the next time. + */ +(function () { + 'use strict'; + if (window.__subreadLoaded) return; + window.__subreadLoaded = true; + + const { parse, cueAt, subtitleTime } = globalThis.SubReadSrt; + const store = (typeof chrome !== 'undefined' && chrome.storage?.local) || null; + const KEEP = 8; // videos whose subtitles are kept + const DEFAULTS = { offset: 0, rate: 1, size: 26, shown: true }; + + let videoId = null, cues = [], settings = { ...DEFAULTS }, fileName = ''; + let box, panel, button, line, status, shownCue = null; + + const get = (key) => new Promise((done) => (store ? store.get(key, (v) => done(v?.[key])) : done(undefined))); + const set = (key, value) => new Promise((done) => (store ? store.set({ [key]: value }, done) : done())); + const remove = (key) => new Promise((done) => (store ? store.remove(key, done) : done())); + + const currentId = () => (location.pathname === '/watch' ? new URLSearchParams(location.search).get('v') : null); + const player = () => document.querySelector('#movie_player'); + const video = () => document.querySelector('#movie_player video'); + + function el(tag, props = {}, children = []) { + const node = Object.assign(document.createElement(tag), props); + for (const c of children) node.append(c); + return node; + } + + /* ------------------------------------------------------------------ build */ + + function build() { + const host = player(); + if (!host || host.querySelector('.subread-box')) return !!host; + + line = el('span', { className: 'subread-line' }); + box = el('div', { className: 'subread-box' }, [line]); + + status = el('div', { className: 'subread-status' }); + const file = el('input', { type: 'file', accept: '.srt,.vtt,text/plain', className: 'subread-file' }); + file.addEventListener('change', async () => { + const f = file.files[0]; + if (!f) return; + await load(await f.text(), f.name); + file.value = ''; + }); + + const nudge = (label, title, by) => { + const b = el('button', { type: 'button', textContent: label, title }); + b.addEventListener('click', () => change({ offset: Math.round((settings.offset + by) * 10) / 10 })); + return b; + }; + const offsetOut = el('output', { className: 'subread-offset' }); + const here = el('button', { type: 'button', textContent: 'First line is now', + title: 'Play to where the narrator reads the first line of the subtitles, then press this' }); + here.addEventListener('click', () => { + if (cues.length && video()) change({ offset: Math.round((video().currentTime - cues[0].start / settings.rate) * 10) / 10 }); + }); + + const rate = el('input', { type: 'number', step: '0.0005', min: '0.9', max: '1.1', className: 'subread-rate', + title: 'Above 1 if the subtitles fall behind as the book goes on; below 1 if they run ahead' }); + rate.addEventListener('change', () => change({ rate: Math.min(1.1, Math.max(0.9, +rate.value || 1)) })); + const size = el('input', { type: 'range', min: '14', max: '48', className: 'subread-size', title: 'Text size' }); + size.addEventListener('input', () => change({ size: +size.value })); + const shown = el('input', { type: 'checkbox' }); + shown.addEventListener('change', () => change({ shown: shown.checked })); + const forget = el('button', { type: 'button', textContent: 'Remove' }); + forget.addEventListener('click', async () => { await remove('v:' + videoId); cues = []; fileName = ''; render(); }); + + panel = el('div', { className: 'subread-panel', hidden: true }, [ + el('div', { className: 'subread-title', textContent: 'SubRead: your subtitles' }), + status, + el('label', { className: 'subread-row' }, ['Subtitles (.srt) ', file]), + el('div', { className: 'subread-row' }, ['Start ', nudge('−1s', 'Subtitles earlier', -1), nudge('−0.1', 'Subtitles earlier', -0.1), + offsetOut, nudge('+0.1', 'Subtitles later', 0.1), nudge('+1s', 'Subtitles later', 1)]), + el('div', { className: 'subread-row' }, [here]), + el('label', { className: 'subread-row' }, ['Speed ', rate]), + el('label', { className: 'subread-row' }, ['Size ', size]), + el('label', { className: 'subread-row' }, [shown, ' Show', ' ', forget]), + el('div', { className: 'subread-row subread-help' }, [ + 'No subtitles for this book? ', + el('a', { href: 'https://subread.space', target: '_blank', rel: 'noopener', textContent: 'Make them from the audiobook and its ebook' }), + ': free, in your browser.', + ]), + ]); + panel._controls = { offsetOut, rate, size, shown }; + for (const type of ['click', 'dblclick', 'keydown', 'keyup', 'keypress', 'wheel']) { + panel.addEventListener(type, (e) => e.stopPropagation()); // or the player takes the keys and the clicks + } + + button = el('button', { type: 'button', className: 'subread-button', textContent: 'SR', title: 'SubRead: your subtitles' }); + button.addEventListener('click', (e) => { e.stopPropagation(); panel.hidden = !panel.hidden; }); + + host.append(box, button, panel); + return true; + } + + /* ------------------------------------------------------------------- state */ + + async function load(source, name) { + const parsed = parse(source); + if (!parsed.length) { status.textContent = `No subtitles could be read from ${name}.`; return; } + cues = parsed; + fileName = name; + settings = { ...settings, shown: true }; + await save(); + render(); + } + + async function save() { + if (!videoId) return; + await set('v:' + videoId, { cues, fileName, settings, at: Date.now() }); + // Keep the newest few: a book of subtitles is megabytes. + const index = ((await get('index')) || []).filter((id) => id !== videoId); + index.unshift(videoId); + for (const old of index.splice(KEEP)) await remove('v:' + old); + await set('index', index); + } + + function change(patch) { + settings = { ...settings, ...patch }; + render(); + if (cues.length) save(); + } + + function render() { + if (!panel) return; + const c = panel._controls; + c.offsetOut.textContent = `${settings.offset >= 0 ? '+' : ''}${settings.offset.toFixed(1)} s`; + c.rate.value = settings.rate; + c.size.value = settings.size; + c.shown.checked = settings.shown; + status.textContent = cues.length ? `${fileName}: ${cues.length} lines` : 'Choose the .srt of this video.'; + box.style.fontSize = settings.size + 'px'; + button.classList.toggle('subread-on', cues.length > 0 && settings.shown); + shownCue = undefined; // draw again + tick(); + } + + function tick() { + const v = video(); + if (!box || !v) return; + const cue = cues.length && settings.shown ? cueAt(cues, subtitleTime(v.currentTime, settings.offset, settings.rate)) : null; + if (cue === shownCue) return; + shownCue = cue; + line.textContent = cue ? cue.text : ''; + box.hidden = !cue; + } + + async function arrive() { + const id = currentId(); + if (id === videoId && box?.isConnected) return; + videoId = id; + cues = []; fileName = ''; settings = { ...DEFAULTS }; + if (!id) { if (box) box.hidden = true; return; } + if (!build()) return; + const saved = await get('v:' + id); + if (saved && id === videoId) ({ cues, fileName } = saved), (settings = { ...DEFAULTS, ...saved.settings }); + render(); + } + + // YouTube changes pages without loading a new one, and builds its player late. + document.addEventListener('yt-navigate-finish', arrive); + setInterval(() => { if (currentId() && (!box || !box.isConnected || currentId() !== videoId)) arrive(); }, 1500); + setInterval(tick, 100); + arrive(); +})(); diff --git a/src/srt.js b/src/srt.js new file mode 100644 index 0000000..b9dc846 --- /dev/null +++ b/src/srt.js @@ -0,0 +1,54 @@ +/* Subtitles as data: read an .srt (or .vtt), and find the cue for a moment of + * the video. No browser APIs here, so Node can test it. + * + * The video on YouTube is often not the same file as the audio the subtitles + * were made from: an intro was added, or the speed differs a little. So the + * time of the video is first moved onto the clock of the subtitles: + * + * subtitle time = (video time - offset) * rate + */ +(function (root) { + 'use strict'; + + const STAMP = /(?:(\d+):)?(\d{1,2}):(\d{2})[.,](\d{1,3})/; + + function seconds(stamp) { + const m = STAMP.exec(stamp); + if (!m) return NaN; + return (+(m[1] || 0)) * 3600 + (+m[2]) * 60 + (+m[3]) + (+m[4].padEnd(3, '0')) / 1000; + } + + /** Cues in order of start: [{ start, end, text }]. Blocks that are not cues are passed over. */ + function parse(source) { + const cues = []; + const blocks = String(source).replace(/^/, '').replace(/\r\n?/g, '\n').split(/\n{2,}/); + for (const block of blocks) { + const lines = block.split('\n'); + const at = lines.findIndex((l) => l.includes('-->')); + if (at < 0) continue; + const [from, to] = lines[at].split('-->'); + const start = seconds(from), end = seconds(to); + const text = lines.slice(at + 1).join('\n').replace(/<[^>]*>/g, '').trim(); + if (Number.isFinite(start) && Number.isFinite(end) && end > start && text) cues.push({ start, end, text }); + } + return cues.sort((a, b) => a.start - b.start); + } + + /** The cue that is on at `t` (seconds on the clock of the subtitles), or null. */ + function cueAt(cues, t) { + let lo = 0, hi = cues.length - 1, found = -1; + while (lo <= hi) { // the last cue that starts at or before t + const mid = (lo + hi) >> 1; + if (cues[mid].start <= t) { found = mid; lo = mid + 1; } else hi = mid - 1; + } + // Cues can overlap a little; the latest one that is still on wins. + for (let i = found; i >= 0 && i > found - 4; i--) if (t < cues[i].end) return cues[i]; + return null; + } + + const subtitleTime = (videoTime, offset, rate) => (videoTime - offset) * rate; + + const api = { parse, cueAt, subtitleTime, seconds }; + if (typeof module !== 'undefined' && module.exports) module.exports = api; + else root.SubReadSrt = api; +})(typeof globalThis !== 'undefined' ? globalThis : this); diff --git a/store/listing.md b/store/listing.md new file mode 100644 index 0000000..8732e91 --- /dev/null +++ b/store/listing.md @@ -0,0 +1,50 @@ +# Store listings + +Upload `dist/subread-chrome.zip` to the Chrome Web Store and +`dist/subread-firefox.zip` to addons.mozilla.org (`python tools/pack.py`). +AMO asks for source code only when the upload is minified or built; this one +is plain source, so answer "No". + +| Field | Value | +|---|---| +| Name | SubRead: your subtitles on YouTube | +| Summary (132) | Show your own .srt over a YouTube video, in time with it. Made for audiobooks, with book-accurate subtitles from subread.space. | +| Category | Chrome: Accessibility (or Education). Firefox: Language Support / Photos, Music & Videos | +| Language | English | +| Homepage | https://subread.space | +| Support | https://github.com/equwal/subread-extension/issues | +| Privacy policy | https://subread.space/terms.html | +| Licence (AMO) | GNU Affero General Public License v3.0 | + +## Description + +``` +Read along with an audiobook on YouTube, with subtitles whose words come from the book itself. + +1. Open the video. Press SR at the top right of the player. +2. Choose the .srt of that recording. +3. If the video has an intro that your file does not have, play to the first line and press "First line is now". A speed control is there for an upload that runs a little fast or slow. + +The subtitles and the settings are kept for each video, so they are there the next time. + +No subtitles yet? https://subread.space makes them from the audiobook and its ebook: free, in your browser, nothing uploaded. A small speech model only listens for where the narrator is; the text of each line is the book's own, so names, spelling and punctuation are right. For language learners, and for anyone who wants text and voice together. + +Private: the extension does not read, record or download the video or its sound, and it sends nothing anywhere. Its one permission keeps your subtitles in your browser. Open source (AGPL-3.0). +``` + +## Chrome Web Store: privacy tab + +| Question | Answer | +|---|---| +| Single purpose | Shows a subtitle file that the user chooses over the YouTube video player, in time with the video. | +| `storage` justification | Keeps the subtitle file that the user chose, and its timing settings, for each video, in the browser. | +| Host permission (`https://www.youtube.com/*`, content script) | The caption box and its controls are drawn inside the YouTube player, and the script reads the current time of the video element to pick the line. | +| Remote code | No | +| Data usage | Collects none of the listed kinds of data. All three certifications: yes | + +## Graphics still to make + +Chrome wants at least one screenshot of 1280 x 800 (or 640 x 400) and a +440 x 280 promo tile; AMO wants none but shows screenshots when there are +some. Take them from a real YouTube audiobook with the panel open and a line +on screen. The icon is `icons/128.png`. diff --git a/tests/mock/server.py b/tests/mock/server.py new file mode 100644 index 0000000..e3d9f03 --- /dev/null +++ b/tests/mock/server.py @@ -0,0 +1,33 @@ +"""A stand-in for a YouTube watch page, to try the content script by hand: + + python tests/mock/server.py then open http://localhost:8432/watch?v=mock + +It has what the script looks for (#movie_player with a <video>, the /watch?v= +address) and a silent video made in the page, so no media file is needed. +""" +import http.server, pathlib + +ROOT = pathlib.Path(__file__).resolve().parent.parent.parent +PAGE = b"""<!doctype html><meta charset=utf-8><title>mock watch page</title> +<link rel=stylesheet href=/src/content.css> +<body style="margin:0;background:#111"> +<div id=movie_player style="position:relative;width:960px;height:540px;background:#000;overflow:hidden"> + <video style="width:100%;height:100%" muted loop></video> +</div> +<script> + // A silent moving picture from a canvas: a video element with a real clock. + const c = document.createElement('canvas'); c.width = 320; c.height = 180; + const g = c.getContext('2d'); let n = 0; + setInterval(() => { g.fillStyle = '#123'; g.fillRect(0, 0, 320, 180); g.fillStyle = '#fff'; g.fillText(String(n++), 10, 20); }, 100); + const v = document.querySelector('video'); v.srcObject = c.captureStream(10); v.play(); +</script> +<script src=/src/srt.js></script><script src=/src/content.js></script>""" + +class Handler(http.server.SimpleHTTPRequestHandler): + def __init__(self, *a, **k): super().__init__(*a, directory=str(ROOT), **k) + def do_GET(self): + if self.path.split('?')[0] == '/watch': + self.send_response(200); self.send_header('Content-Type', 'text/html'); self.end_headers(); self.wfile.write(PAGE) + else: super().do_GET() + +http.server.ThreadingHTTPServer(('127.0.0.1', 8432), Handler).serve_forever() diff --git a/tests/srt.test.cjs b/tests/srt.test.cjs new file mode 100644 index 0000000..df5e956 --- /dev/null +++ b/tests/srt.test.cjs @@ -0,0 +1,56 @@ +/* node --test tests */ +const test = require('node:test'); +const assert = require('node:assert/strict'); +const { parse, cueAt, subtitleTime, seconds } = require('../src/srt.js'); + +test('an .srt is read: numbers, stamps, text of more than one line, tags removed', () => { + const cues = parse('1\r\n00:00:01,500 --> 00:00:04,000\r\nIt was a <i>dark</i> night;\r\nthe rain fell.\r\n\r\n' + + '2\r\n01:02:03,004 --> 01:02:05,000\r\n吾輩は猫である。\r\n'); + assert.deepEqual(cues, [ + { start: 1.5, end: 4, text: 'It was a dark night;\nthe rain fell.' }, + { start: 3723.004, end: 3725, text: '吾輩は猫である。' }, + ]); +}); + +test('a .vtt is read too, and what is not a cue is passed over', () => { + const cues = parse('WEBVTT\n\nNOTE made by hand\n\n00:01.000 --> 00:02.5\nHello\n\nbroken --> block\nx\n\n3\n00:00:09,000 --> 00:00:08,000\nends before it starts\n'); + assert.deepEqual(cues, [{ start: 1, end: 2.5, text: 'Hello' }]); +}); + +test('stamps', () => { + assert.equal(seconds('00:00:00,004'), 0.004); + assert.equal(seconds('10:00:00.5'), 36000.5); + assert.ok(Number.isNaN(seconds('soon'))); +}); + +test('the cue for a moment is the one a slow search finds, for any cues and any moment', () => { + let seed = 11; + const random = () => (seed = (seed * 1103515245 + 12345) >>> 0) / 2 ** 32; + for (let round = 0; round < 300; round++) { + const cues = []; + let t = random() * 5; + for (let i = 0; i < Math.floor(random() * 40); i++) { + const start = t, end = start + 0.2 + random() * 5; + cues.push({ start, end, text: String(i) }); + t = end + (random() < 0.5 ? 0 : random() * 3); // back to back, or a gap + } + for (let k = 0; k < 60; k++) { + const at = random() * (t + 5) - 1; + const slow = cues.filter((c) => c.start <= at && at < c.end).pop() ?? null; + assert.equal(cueAt(cues, at), slow); + } + } + assert.equal(cueAt([], 3), null); +}); + +test('a cue that overlaps the one after it gives way to the later one', () => { + const cues = [{ start: 0, end: 10, text: 'long' }, { start: 4, end: 6, text: 'short' }]; + assert.equal(cueAt(cues, 5).text, 'short'); + assert.equal(cueAt(cues, 8).text, 'long'); +}); + +test('the time of the video is moved onto the clock of the subtitles', () => { + assert.equal(subtitleTime(100, 0, 1), 100); + assert.equal(subtitleTime(100, 12.5, 1), 87.5); // the upload has a 12.5 s intro + assert.ok(Math.abs(subtitleTime(3600, 0, 1.001) - 3603.6) < 1e-9); // and runs a little slow +}); diff --git a/tools/pack.py b/tools/pack.py new file mode 100644 index 0000000..2031771 --- /dev/null +++ b/tools/pack.py @@ -0,0 +1,23 @@ +"""Make the two store uploads: dist/subread-chrome.zip and dist/subread-firefox.zip. + +The same files go to both stores. Chrome does not know the key +"browser_specific_settings" and warns about it, so the Chrome zip leaves it out. +""" +import json, pathlib, zipfile + +ROOT = pathlib.Path(__file__).resolve().parent.parent +FILES = ["popup.html", "LICENSE", *sorted(str(p.relative_to(ROOT)).replace("\\", "/") + for d in ("src", "icons") for p in (ROOT / d).iterdir())] + +def pack(name: str, manifest: dict) -> None: + out = ROOT / "dist" / name + out.parent.mkdir(exist_ok=True) + with zipfile.ZipFile(out, "w", zipfile.ZIP_DEFLATED) as z: + z.writestr("manifest.json", json.dumps(manifest, indent=2)) + for f in FILES: + z.write(ROOT / f, f) + print(out.relative_to(ROOT), out.stat().st_size, "bytes") + +manifest = json.loads((ROOT / "manifest.json").read_text(encoding="utf-8")) +pack("subread-firefox.zip", manifest) +pack("subread-chrome.zip", {k: v for k, v in manifest.items() if k != "browser_specific_settings"})