commit 9862a54a9feb9f5535fa5a794b3e1a23e227d8f0 truex <truex@equwal.com> 2026-09-25 02:14:39 -0700 Add the SubRead plugin, the clock sources and the page cache SubReadPlugin.java is the bridge to the suite: the player through the content provider of SubRead Overlay (release and debug authorities), the dictionary through ACTION_PROCESS_TEXT (the call resolves when the dictionary closes), the subtitle maker through the intent API of SubRead, the audio picker and the share sheet. The manifest declares the queries that Android 11 needs. clock-source.ts gives the reader one interface over two time sources: OverlayClock polls the overlay every 2 s (5 s after an error), computes the position between two reads with the play clock, marks a jump over 3 s as a seek, and skips one read after its own play, pause or seek. LocalAudioClock wraps the audio element on the web. token-cache.ts keeps the tokens of each page and the subtitles of each book in IndexedDB. The lookup text now has a space between words.
LICENSE | 662 +++++++++++++++++++++ android/app/src/main/AndroidManifest.xml | 16 + .../java/com/equwal/scansubread/MainActivity.java | 11 +- .../java/com/equwal/scansubread/SubReadPlugin.java | 381 ++++++++++++ android/app/src/main/res/xml/file_paths.xml | 4 +- src/clock-source.ts | 237 ++++++++ src/hit-test.ts | 34 +- src/subread.ts | 94 +++ src/token-cache.ts | 67 +++ test/clock-source.test.ts | 135 +++++ test/hit-test.test.ts | 38 +- 11 files changed, 1666 insertions(+), 13 deletions(-)
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/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml index b06ddbf..016c045 100644 --- a/android/app/src/main/AndroidManifest.xml +++ b/android/app/src/main/AndroidManifest.xml @@ -24,6 +24,7 @@ </activity> + <!-- Gives the book text to SubRead, and the finished .srt to the share sheet. --> <provider android:name="androidx.core.content.FileProvider" android:authorities="${applicationId}.fileprovider" @@ -35,6 +36,21 @@ </provider> </application> + <!-- Android 11 and later hide other apps without this. --> + <queries> + <package android:name="space.subread.app" /> + <package android:name="space.subread.overlay" /> + <package android:name="space.subread.overlay.debug" /> + <package android:name="space.subread.dictionary" /> + <!-- The player provider of SubRead Overlay: the release build and the debug build. --> + <provider android:authorities="space.subread.overlay.player;space.subread.overlay.debug.player" /> + <!-- The dictionary apps: each app in the text selection menu. --> + <intent> + <action android:name="android.intent.action.PROCESS_TEXT" /> + <data android:mimeType="text/plain" /> + </intent> + </queries> + <!-- Permissions --> <uses-permission android:name="android.permission.INTERNET" /> diff --git a/android/app/src/main/java/com/equwal/scansubread/MainActivity.java b/android/app/src/main/java/com/equwal/scansubread/MainActivity.java index 075f8ca..8461ac9 100644 --- a/android/app/src/main/java/com/equwal/scansubread/MainActivity.java +++ b/android/app/src/main/java/com/equwal/scansubread/MainActivity.java @@ -1,5 +1,14 @@ package com.equwal.scansubread; +import android.os.Bundle; import com.getcapacitor.BridgeActivity; -public class MainActivity extends BridgeActivity {} +public class MainActivity extends BridgeActivity { + + @Override + public void onCreate(Bundle savedInstanceState) { + // Local plugins register before the bridge is built. + registerPlugin(SubReadPlugin.class); + super.onCreate(savedInstanceState); + } +} diff --git a/android/app/src/main/java/com/equwal/scansubread/SubReadPlugin.java b/android/app/src/main/java/com/equwal/scansubread/SubReadPlugin.java new file mode 100644 index 0000000..f568ab9 --- /dev/null +++ b/android/app/src/main/java/com/equwal/scansubread/SubReadPlugin.java @@ -0,0 +1,381 @@ +package com.equwal.scansubread; + +import android.app.Activity; +import android.content.ActivityNotFoundException; +import android.content.ClipData; +import android.content.ComponentName; +import android.content.ContentResolver; +import android.content.Context; +import android.content.Intent; +import android.content.SharedPreferences; +import android.content.pm.PackageManager; +import android.content.pm.ResolveInfo; +import android.database.Cursor; +import android.net.Uri; +import android.os.Bundle; +import android.provider.OpenableColumns; +import androidx.activity.result.ActivityResult; +import androidx.core.content.FileProvider; +import com.getcapacitor.JSArray; +import com.getcapacitor.JSObject; +import com.getcapacitor.Plugin; +import com.getcapacitor.PluginCall; +import com.getcapacitor.PluginMethod; +import com.getcapacitor.annotation.ActivityCallback; +import com.getcapacitor.annotation.CapacitorPlugin; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.List; + +/** + * The bridge to the SubRead suite. + * + * - The audio player, through the content provider of SubRead Overlay + * (`content://space.subread.overlay.player/state`). The reader has no + * notification access, so the overlay answers for it. + * - A dictionary app, through `Intent.ACTION_PROCESS_TEXT`: SubRead + * Dictionary, Takoboto, AnkiDroid and other apps in the text selection + * menu. The lookup resolves when the dictionary closes. + * - The subtitle maker, through the intent API of the SubRead app + * (`space.subread.app.action.ALIGN`). + */ +@CapacitorPlugin(name = "SubRead") +public class SubReadPlugin extends Plugin { + + /** The release build of SubRead Overlay first, then the debug build. */ + private static final String[] AUTHORITIES = { + "space.subread.overlay.player", + "space.subread.overlay.debug.player", + }; + private static final String COLUMN_STATE = "state"; + private static final String NO_OVERLAY = "error=no_overlay"; + + private static final String PREFS = "subread"; + private static final String PREF_DICTIONARY = "dictionary"; + + private static final String SUBREAD_PACKAGE = "space.subread.app"; + private static final String ACTION_ALIGN = "space.subread.app.action.ALIGN"; + private static final String EXTRA_AUDIO = "space.subread.extra.AUDIO"; + private static final String EXTRA_BOOK = "space.subread.extra.BOOK"; + private static final String EXTRA_LANGUAGE = "space.subread.extra.LANGUAGE"; + private static final String EXTRA_CUES = "space.subread.extra.CUES"; + private static final String EXTRA_MATCH_RATE = "space.subread.extra.MATCH_RATE"; + private static final String EXTRA_ERROR = "space.subread.extra.ERROR"; + + private static final String SHARE_DIR = "share"; + + /** The authority that answered last. It is tried first. */ + private String authority; + + // --- The player, through SubRead Overlay --- + + private List<String> candidates() { + List<String> list = new ArrayList<>(); + if (authority != null) list.add(authority); + for (String a : AUTHORITIES) if (!a.equals(authority)) list.add(a); + return list; + } + + private static Uri stateUri(String authority) { + return Uri.parse("content://" + authority + "/state"); + } + + /** The state line of the first overlay that answers, or `error=no_overlay`. */ + private String queryState() { + ContentResolver resolver = getContext().getContentResolver(); + for (String a : candidates()) { + // query returns null when no app has the provider. It throws when + // the provider is not visible to this app. + try (Cursor c = resolver.query(stateUri(a), null, null, null, null)) { + if (c != null && c.moveToFirst()) { + authority = a; + String line = c.getString(0); + return line == null ? NO_OVERLAY : line; + } + } catch (RuntimeException e) { + // Try the next authority. + } + } + return NO_OVERLAY; + } + + /** Sends play, pause or seek. Returns the state line after the call. */ + private String callPlayer(String method, String arg) { + ContentResolver resolver = getContext().getContentResolver(); + for (String a : candidates()) { + try { + Bundle answer = resolver.call(stateUri(a), method, arg, null); + if (answer != null) { + authority = a; + String line = answer.getString(COLUMN_STATE); + return line == null ? NO_OVERLAY : line; + } + } catch (RuntimeException e) { + // Try the next authority. + } + } + return NO_OVERLAY; + } + + private static JSObject lineObject(String line) { + JSObject ret = new JSObject(); + ret.put("line", line); + return ret; + } + + @PluginMethod + public void playerState(PluginCall call) { + call.resolve(lineObject(queryState())); + } + + @PluginMethod + public void play(PluginCall call) { + call.resolve(lineObject(callPlayer("play", null))); + } + + @PluginMethod + public void pause(PluginCall call) { + call.resolve(lineObject(callPlayer("pause", null))); + } + + @PluginMethod + public void seek(PluginCall call) { + Integer ms = call.getInt("ms"); + if (ms == null) { + call.reject("ms is required."); + return; + } + call.resolve(lineObject(callPlayer("seek", String.valueOf(Math.max(0, ms))))); + } + + // --- The dictionary, through ACTION_PROCESS_TEXT --- + + private SharedPreferences prefs() { + return getContext().getSharedPreferences(PREFS, Context.MODE_PRIVATE); + } + + /** The intent that each app with "process text" in its manifest takes. */ + private static Intent probe() { + return new Intent(Intent.ACTION_PROCESS_TEXT).setType("text/plain"); + } + + @PluginMethod + public void lookup(PluginCall call) { + String text = call.getString("text"); + if (text == null) { + call.reject("text is required."); + return; + } + Intent send = probe() + .putExtra(Intent.EXTRA_PROCESS_TEXT, text) + .putExtra(Intent.EXTRA_PROCESS_TEXT_READONLY, true); + String chosen = prefs().getString(PREF_DICTIONARY, ""); + ComponentName component = chosen.isEmpty() ? null : ComponentName.unflattenFromString(chosen); + if (component != null) { + try { + startActivityForResult(call, new Intent(send).setComponent(component), "lookupResult"); + return; + } catch (ActivityNotFoundException e) { + // The chosen app is gone. Ask. + prefs().edit().remove(PREF_DICTIONARY).apply(); + } + } + startActivityForResult(call, Intent.createChooser(send, null), "lookupResult"); + } + + /** The dictionary closed: the lookup is over. */ + @ActivityCallback + private void lookupResult(PluginCall call, ActivityResult result) { + if (call == null) return; + JSObject ret = new JSObject(); + ret.put("closed", true); + call.resolve(ret); + } + + @PluginMethod + public void dictionaries(PluginCall call) { + PackageManager pm = getContext().getPackageManager(); + JSArray apps = new JSArray(); + for (ResolveInfo info : pm.queryIntentActivities(probe(), PackageManager.MATCH_DEFAULT_ONLY)) { + if (info.activityInfo == null) continue; + JSObject app = new JSObject(); + app.put("label", String.valueOf(info.loadLabel(pm))); + app.put( + "component", + new ComponentName(info.activityInfo.packageName, info.activityInfo.name).flattenToString() + ); + apps.put(app); + } + JSObject ret = new JSObject(); + ret.put("apps", apps); + ret.put("chosen", prefs().getString(PREF_DICTIONARY, "")); + call.resolve(ret); + } + + @PluginMethod + public void setDictionary(PluginCall call) { + String component = call.getString("component", ""); + prefs().edit().putString(PREF_DICTIONARY, component == null ? "" : component).apply(); + call.resolve(); + } + + // --- The subtitle maker, through the SubRead app --- + + /** Writes `text` to cacheDir/share/<name> and returns its FileProvider Uri. */ + private Uri shareFile(String name, String text) throws IOException { + File dir = new File(getContext().getCacheDir(), SHARE_DIR); + if (!dir.isDirectory() && !dir.mkdirs()) throw new IOException("Cannot create " + dir); + File file = new File(dir, name); + try (OutputStream out = new FileOutputStream(file)) { + out.write(text.getBytes(StandardCharsets.UTF_8)); + } + return FileProvider.getUriForFile(getContext(), getContext().getPackageName() + ".fileprovider", file); + } + + private static JSObject errorObject(String error) { + JSObject ret = new JSObject(); + ret.put("error", error); + return ret; + } + + @PluginMethod + public void makeSubtitles(PluginCall call) { + String audio = call.getString("audio"); + String bookText = call.getString("bookText"); + String language = call.getString("language", "auto"); + if (audio == null || bookText == null) { + call.reject("audio and bookText are required."); + return; + } + Uri bookUri; + try { + bookUri = shareFile("book.txt", bookText); + } catch (IOException e) { + call.reject("Cannot write the book text: " + e.getMessage(), e); + return; + } + Uri audioUri = Uri.parse(audio); + Intent ask = new Intent(ACTION_ALIGN) + .setPackage(SUBREAD_PACKAGE) + .putExtra(EXTRA_AUDIO, audioUri) + .putExtra(EXTRA_BOOK, bookUri) + .putExtra(EXTRA_LANGUAGE, language); + // SubRead must be able to read both files. + ClipData clip = ClipData.newRawUri("audio", audioUri); + clip.addItem(new ClipData.Item(bookUri)); + ask.setClipData(clip); + ask.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION); + if (ask.resolveActivity(getContext().getPackageManager()) == null) { + call.resolve(errorObject("not_installed")); + return; + } + startActivityForResult(call, ask, "subtitlesResult"); + } + + private static String readAll(InputStream in) throws IOException { + ByteArrayOutputStream out = new ByteArrayOutputStream(); + byte[] buf = new byte[64 * 1024]; + int n; + while ((n = in.read(buf)) > 0) out.write(buf, 0, n); + return new String(out.toByteArray(), StandardCharsets.UTF_8); + } + + @ActivityCallback + private void subtitlesResult(PluginCall call, ActivityResult result) { + if (call == null) return; + Intent data = result.getData(); + Uri srtUri = data == null ? null : data.getData(); + if (result.getResultCode() != Activity.RESULT_OK || srtUri == null) { + String error = data == null ? null : data.getStringExtra(EXTRA_ERROR); + call.resolve(errorObject(error == null ? "cancelled" : error)); + return; + } + // The grant ends with the calling activity: copy the file now, off the UI thread. + new Thread( + () -> { + try (InputStream in = getContext().getContentResolver().openInputStream(srtUri)) { + if (in == null) { + call.resolve(errorObject("cannot_read")); + return; + } + JSObject ret = new JSObject(); + ret.put("srt", readAll(in)); + ret.put("cues", data.getIntExtra(EXTRA_CUES, -1)); + ret.put("matchRate", data.getDoubleExtra(EXTRA_MATCH_RATE, -1)); + String language = data.getStringExtra(EXTRA_LANGUAGE); + ret.put("language", language == null ? JSObject.NULL : language); + call.resolve(ret); + } catch (IOException | RuntimeException e) { + call.resolve(errorObject("cannot_read: " + e.getMessage())); + } + }, + "SubReadSrt" + ) + .start(); + } + + @PluginMethod + public void pickAudio(PluginCall call) { + Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT); + intent.addCategory(Intent.CATEGORY_OPENABLE); + intent.setType("audio/*"); + intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION); + startActivityForResult(call, intent, "audioResult"); + } + + @ActivityCallback + private void audioResult(PluginCall call, ActivityResult result) { + if (call == null) return; + Intent data = result.getData(); + Uri uri = data == null ? null : data.getData(); + if (result.getResultCode() != Activity.RESULT_OK || uri == null) { + call.reject("No audio file was picked."); + return; + } + ContentResolver resolver = getContext().getContentResolver(); + try { + // Keep the permission, so the Uri can be given to SubRead later. + resolver.takePersistableUriPermission(uri, Intent.FLAG_GRANT_READ_URI_PERMISSION); + } catch (SecurityException e) { + // Some providers give no persistable grant. The Uri still works now. + } + String name = uri.getLastPathSegment(); + try (Cursor c = resolver.query(uri, new String[] { OpenableColumns.DISPLAY_NAME }, null, null, null)) { + if (c != null && c.moveToFirst() && !c.isNull(0)) name = c.getString(0); + } catch (RuntimeException e) { + // Keep the path segment. + } + JSObject ret = new JSObject(); + ret.put("uri", uri.toString()); + ret.put("name", name == null ? "" : name); + call.resolve(ret); + } + + /** Opens the share sheet with a text file, for example the finished .srt. */ + @PluginMethod + public void shareText(PluginCall call) { + String name = call.getString("name"); + String text = call.getString("text"); + if (name == null || text == null) { + call.reject("name and text are required."); + return; + } + try { + Uri uri = shareFile(name, text); + Intent send = new Intent(Intent.ACTION_SEND) + .setType("text/plain") + .putExtra(Intent.EXTRA_STREAM, uri) + .addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION); + getActivity().startActivity(Intent.createChooser(send, name)); + call.resolve(); + } catch (IOException | RuntimeException e) { + call.reject("Cannot share: " + e.getMessage(), e); + } + } +} diff --git a/android/app/src/main/res/xml/file_paths.xml b/android/app/src/main/res/xml/file_paths.xml index bd0c4d8..d2460ee 100644 --- a/android/app/src/main/res/xml/file_paths.xml +++ b/android/app/src/main/res/xml/file_paths.xml @@ -2,4 +2,6 @@ <paths xmlns:android="http://schemas.android.com/apk/res/android"> <external-path name="my_images" path="." /> <cache-path name="my_cache_images" path="." /> -</paths> \ No newline at end of file + <!-- The book text for SubRead and the finished .srt for the share sheet. --> + <cache-path name="share" path="share/" /> +</paths> diff --git a/src/clock-source.ts b/src/clock-source.ts new file mode 100644 index 0000000..9e92349 --- /dev/null +++ b/src/clock-source.ts @@ -0,0 +1,237 @@ +// Where the time of the audio comes from. +// +// On Android the player app plays the audio, and SubRead Overlay reports +// its position (OverlayClock). On the web the page plays the audio itself +// (LocalAudioClock). Both give the same states to the reader. + +import { positionAt, type PlayClock } from './play-clock'; +import { isPlayerError, parseState } from './player-state'; +import type { StateLine } from './subread'; + +export interface ClockState { + /** Position in milliseconds. Null when no player reports one. */ + positionMs: number | null; + playing: boolean; + /** True when the audio jumped: a seek, not the normal run forward. */ + seeked: boolean; + /** `no_overlay`, `no_notification_access`, `no_player`, or null. */ + error: string | null; +} + +export interface ClockSource { + start(onState: (state: ClockState) => void): void; + stop(): void; + play(): Promise<void>; + pause(): Promise<void>; + seek(ms: number): Promise<void>; +} + +/** The part of the SubRead plugin that the overlay clock uses. */ +export interface PlayerBridge { + playerState(): Promise<StateLine>; + play(): Promise<StateLine>; + pause(): Promise<StateLine>; + seek(options: { ms: number }): Promise<StateLine>; +} + +/** Milliseconds between two reads of the player. */ +export const POLL_MS = 2000; +/** Milliseconds between two reads while the last answer was an error. */ +export const POLL_ERROR_MS = 5000; +/** Milliseconds between two computed positions between the reads. */ +export const TICK_MS = 250; +/** A reported position this far from the expected one is a seek. */ +export const JUMP_MS = 3000; + +/** + * The audio player, read through SubRead Overlay. The player reports its + * position and speed, so the clock is exact between two reads. A read + * only has to notice a pause, a seek or a new speed. After play, pause or + * seek sent from here, one read is skipped: the player takes a moment, + * and the read that comes at once after would bring the old state back. + */ +export class OverlayClock implements ClockSource { + private clock: PlayClock | null = null; + private error: string | null = null; + private onState: ((state: ClockState) => void) | null = null; + private pollTimer: ReturnType<typeof setTimeout> | null = null; + private tickTimer: ReturnType<typeof setInterval> | null = null; + private skipPoll = false; + + constructor( + private readonly bridge: PlayerBridge, + private readonly now: () => number = () => performance.now(), + ) {} + + start(onState: (state: ClockState) => void): void { + this.stop(); + this.onState = onState; + void this.poll(); + this.tickTimer = setInterval(() => this.tick(), TICK_MS); + } + + stop(): void { + if (this.pollTimer) clearTimeout(this.pollTimer); + if (this.tickTimer) clearInterval(this.tickTimer); + this.pollTimer = null; + this.tickTimer = null; + this.onState = null; + } + + private schedulePoll(): void { + if (this.pollTimer) clearTimeout(this.pollTimer); + this.pollTimer = setTimeout(() => void this.poll(), this.error ? POLL_ERROR_MS : POLL_MS); + } + + private async poll(): Promise<void> { + if (!this.onState) return; + if (this.skipPoll) { + this.skipPoll = false; + this.schedulePoll(); + return; + } + let line: string; + try { + ({ line } = await this.bridge.playerState()); + } catch { + line = 'error=no_overlay'; + } + if (!this.onState) return; + this.apply(line, this.now()); + this.schedulePoll(); + } + + /** Takes a state line of the player and reports the state it gives. */ + private apply(line: string, at: number): void { + const parsed = parseState(line); + if (isPlayerError(parsed)) { + // The player is gone, or cannot be read. Keep the place, stop the clock. + this.error = parsed.error; + if (this.clock) + this.clock = { + ...this.clock, + positionMs: positionAt(this.clock, at), + reportedAtMs: at, + playing: false, + }; + this.emit(false); + return; + } + this.error = null; + if (parsed.positionMs === null) { + this.clock = null; + this.emit(false); + return; + } + const expected = this.clock ? positionAt(this.clock, at) : null; + const seeked = expected !== null && Math.abs(parsed.positionMs - expected) > JUMP_MS; + this.clock = { + positionMs: parsed.positionMs, + reportedAtMs: at, + speed: parsed.speed, + playing: parsed.playing, + }; + this.emit(seeked); + } + + /** Between two reads: the computed position, while the player plays. */ + private tick(): void { + if (this.clock?.playing) this.emit(false); + } + + private emit(seeked: boolean): void { + if (!this.onState) return; + const clock = this.clock; + this.onState({ + positionMs: clock ? positionAt(clock, this.now()) : null, + playing: clock?.playing ?? false, + seeked, + error: this.error, + }); + } + + /** Sets the local clock as the command will leave the player, and skips one read. */ + private local(playing: boolean, positionMs?: number): void { + const at = this.now(); + const clock = this.clock; + const position = positionMs ?? (clock ? positionAt(clock, at) : null); + if (position === null) return; + this.clock = { positionMs: position, reportedAtMs: at, speed: clock?.speed ?? 1, playing }; + this.skipPoll = true; + this.emit(positionMs !== undefined); + } + + private async send(command: Promise<StateLine>): Promise<string> { + try { + return (await command).line; + } catch { + return 'error=no_overlay'; + } + } + + async play(): Promise<void> { + const line = await this.send(this.bridge.play()); + if (isPlayerError(parseState(line))) this.apply(line, this.now()); + else this.local(true); + } + + async pause(): Promise<void> { + const line = await this.send(this.bridge.pause()); + if (isPlayerError(parseState(line))) this.apply(line, this.now()); + else this.local(false); + } + + async seek(ms: number): Promise<void> { + const line = await this.send(this.bridge.seek({ ms: Math.max(0, Math.round(ms)) })); + if (isPlayerError(parseState(line))) this.apply(line, this.now()); + else this.local(this.clock?.playing ?? false, ms); + } +} + +/** The audio element of the page, for the web. */ +export class LocalAudioClock implements ClockSource { + /** The events that give a new state. `loadedmetadata`: a file was chosen. */ + private static readonly EVENTS = ['timeupdate', 'play', 'pause', 'loadedmetadata']; + private onState: ((state: ClockState) => void) | null = null; + private readonly onTime = (): void => this.emit(false); + private readonly onSeeked = (): void => this.emit(true); + + constructor(private readonly audio: HTMLAudioElement) {} + + start(onState: (state: ClockState) => void): void { + this.stop(); + this.onState = onState; + for (const ev of LocalAudioClock.EVENTS) this.audio.addEventListener(ev, this.onTime); + this.audio.addEventListener('seeked', this.onSeeked); + this.emit(false); + } + + stop(): void { + for (const ev of LocalAudioClock.EVENTS) this.audio.removeEventListener(ev, this.onTime); + this.audio.removeEventListener('seeked', this.onSeeked); + this.onState = null; + } + + private emit(seeked: boolean): void { + this.onState?.({ + positionMs: this.audio.src ? this.audio.currentTime * 1000 : null, + playing: !this.audio.paused, + seeked, + error: this.audio.src ? null : 'no_player', + }); + } + + async play(): Promise<void> { + await this.audio.play(); + } + + pause(): Promise<void> { + this.audio.pause(); + return Promise.resolve(); + } + + seek(ms: number): Promise<void> { + this.audio.currentTime = Math.max(0, ms) / 1000; + return Promise.resolve(); + } +} diff --git a/src/hit-test.ts b/src/hit-test.ts index 0c516b2..deeb7a6 100644 --- a/src/hit-test.ts +++ b/src/hit-test.ts @@ -5,6 +5,7 @@ // 3. `lookupText` is the text that goes to the dictionary app. import type { OcrToken } from './align'; +import { joinWords } from './book-text'; /** Longest scan string, in characters. */ export const SCAN_LENGTH = 16; @@ -57,16 +58,31 @@ export function tokenAt( return best; } -/** Text of token `start` and the following tokens on its line, up to `max` characters. */ +/** + * Text of token `start` and the following tokens on its line, up to `max` + * characters. Spaces are not tokens: a space goes between two words, + * except between two CJK words, and does not count toward `max`. + */ export function scanText(tokens: readonly OcrToken[], start: number, max = SCAN_LENGTH): string { const first = tokens[start]; if (!first) return ''; - let text = ''; + const words: string[] = []; + let word = ''; + let wordId = first.word; + let length = 0; for (let i = start; i < tokens.length && tokens[i]!.line === first.line; i++) { - if (text.length + tokens[i]!.text.length > max) break; - text += tokens[i]!.text; + const t = tokens[i]!; + if (length + t.text.length > max) break; + if (t.word !== wordId) { + words.push(word); + word = ''; + wordId = t.word; + } + word += t.text; + length += t.text.length; } - return text; + words.push(word); + return joinWords(words); } /** Index of the first token after the line of token `start`, or -1 at the end. */ @@ -85,10 +101,10 @@ function nextLine(tokens: readonly OcrToken[], start: number): number { export function lookupText(tokens: readonly OcrToken[], start: number): string { const first = tokens[start]; if (!first) return ''; - let text = scanText(tokens, start, LOOKUP_LENGTH); - if (text.length > LOOKUP_SHORT_LINE) return text; + const text = scanText(tokens, start, LOOKUP_LENGTH); + const length = [...text.replace(/ /g, '')].length; + if (length > LOOKUP_SHORT_LINE) return text; const next = nextLine(tokens, start); if (next < 0 || tokens[next]!.page !== first.page) return text; - text += scanText(tokens, next, LOOKUP_LENGTH - text.length); - return text; + return joinWords([text, scanText(tokens, next, LOOKUP_LENGTH - length)]); } diff --git a/src/subread.ts b/src/subread.ts new file mode 100644 index 0000000..6a104bd --- /dev/null +++ b/src/subread.ts @@ -0,0 +1,94 @@ +// The bridge to the SubRead suite: the typed side of SubReadPlugin.java. +// +// On the web there is no suite. The fallback reports no overlay, copies a +// lookup to the clipboard, and cannot make subtitles. + +import { Capacitor, registerPlugin } from '@capacitor/core'; + +export interface StateLine { + /** One state line of SubRead Overlay, or `error=<reason>`. */ + line: string; +} + +export interface DictionaryApp { + label: string; + /** A flattened ComponentName. */ + component: string; +} + +export interface SubtitlesResult { + srt?: string; + /** The number of cues. */ + cues?: number; + /** 0 to 1: the share of lines whose words were found in the book. */ + matchRate?: number; + language?: string | null; + /** `not_installed`, `cancelled`, or the reason SubRead gave. */ + error?: string; +} + +export interface SubReadPlugin { + playerState(): Promise<StateLine>; + play(): Promise<StateLine>; + pause(): Promise<StateLine>; + seek(options: { ms: number }): Promise<StateLine>; + /** Opens the dictionary with the text. Resolves when the dictionary closes. */ + lookup(options: { text: string }): Promise<{ closed: boolean }>; + dictionaries(): Promise<{ apps: DictionaryApp[]; chosen: string }>; + /** An empty component means: ask each time. */ + setDictionary(options: { component: string }): Promise<void>; + makeSubtitles(options: { + audio: string; + bookText: string; + language: string; + }): Promise<SubtitlesResult>; + pickAudio(): Promise<{ uri: string; name: string }>; + shareText(options: { name: string; text: string }): Promise<void>; +} + +class SubReadWeb implements SubReadPlugin { + private noOverlay(): Promise<StateLine> { + return Promise.resolve({ line: 'error=no_overlay' }); + } + playerState(): Promise<StateLine> { + return this.noOverlay(); + } + play(): Promise<StateLine> { + return this.noOverlay(); + } + pause(): Promise<StateLine> { + return this.noOverlay(); + } + seek(): Promise<StateLine> { + return this.noOverlay(); + } + async lookup({ text }: { text: string }): Promise<{ closed: boolean }> { + try { + await navigator.clipboard.writeText(text); + } catch { + // No clipboard in this context. The status line still shows the text. + } + return { closed: true }; + } + dictionaries(): Promise<{ apps: DictionaryApp[]; chosen: string }> { + return Promise.resolve({ apps: [], chosen: '' }); + } + setDictionary(): Promise<void> { + return Promise.resolve(); + } + makeSubtitles(): Promise<SubtitlesResult> { + return Promise.resolve({ error: 'not_installed' }); + } + pickAudio(): Promise<{ uri: string; name: string }> { + return Promise.reject(new Error('Android only.')); + } + shareText(): Promise<void> { + return Promise.reject(new Error('Android only.')); + } +} + +export const isAndroid = Capacitor.getPlatform() === 'android'; + +export const SubRead = registerPlugin<SubReadPlugin>('SubRead', { + web: () => new SubReadWeb(), +}); diff --git a/src/token-cache.ts b/src/token-cache.ts new file mode 100644 index 0000000..73a6d58 --- /dev/null +++ b/src/token-cache.ts @@ -0,0 +1,67 @@ +// The tokens of each page, and the subtitles of each book, in IndexedDB. +// Thin browser layer. +// +// OCR is slow, so a page is read once. The key names the file, the page, +// the OCR language and the source (text layer or OCR). The subtitles that +// SubRead made are kept under the key of the PDF. + +import { openDB, type DBSchema, type IDBPDatabase } from 'idb'; +import type { OcrToken } from './align'; + +export type TextSource = 'text' | 'ocr'; + +export interface PageEntry { + tokens: OcrToken[]; + /** Size of the page in pixels, the space of the boxes. */ + width: number; + height: number; + source: TextSource; +} + +interface Schema extends DBSchema { + pages: { key: string; value: PageEntry }; + srt: { key: string; value: string }; +} + +let dbPromise: Promise<IDBPDatabase<Schema>> | undefined; + +function db(): Promise<IDBPDatabase<Schema>> { + dbPromise ??= openDB<Schema>('scan-subread', 1, { + upgrade(d) { + d.createObjectStore('pages'); + d.createObjectStore('srt'); + }, + }); + return dbPromise; +} + +type FileId = Pick<File, 'name' | 'size'>; + +/** The key of a book: the file name and size. */ +export function bookKey(file: FileId): string { + return `${file.name}|${file.size}`; +} + +export function pageKey(file: FileId, page: number, lang: string, source: TextSource): string { + return `${bookKey(file)}|${page}|${lang}|${source}`; +} + +export async function getPage(key: string): Promise<PageEntry | undefined> { + return (await db()).get('pages', key); +} + +export async function putPage(key: string, entry: PageEntry): Promise<void> { + await (await db()).put('pages', entry, key); +} + +export async function clearPages(): Promise<void> { + await (await db()).clear('pages'); +} + +export async function getSrt(key: string): Promise<string | undefined> { + return (await db()).get('srt', key); +} + +export async function putSrt(key: string, srt: string): Promise<void> { + await (await db()).put('srt', srt, key); +} diff --git a/test/clock-source.test.ts b/test/clock-source.test.ts new file mode 100644 index 0000000..bdf54ac --- /dev/null +++ b/test/clock-source.test.ts @@ -0,0 +1,135 @@ +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; +import { + JUMP_MS, + OverlayClock, + POLL_ERROR_MS, + POLL_MS, + TICK_MS, + type ClockState, + type PlayerBridge, +} from '../src/clock-source'; + +/** A fake SubRead Overlay: answers the line set in `line`, counts the calls. */ +function fakeBridge(line: string) { + const calls: string[] = []; + const bridge: PlayerBridge & { line: string; calls: string[] } = { + line, + calls, + playerState: () => { + calls.push('state'); + return Promise.resolve({ line: bridge.line }); + }, + play: () => { + calls.push('play'); + return Promise.resolve({ line: bridge.line }); + }, + pause: () => { + calls.push('pause'); + return Promise.resolve({ line: bridge.line }); + }, + seek: ({ ms }) => { + calls.push(`seek ${ms}`); + return Promise.resolve({ line: bridge.line }); + }, + }; + return bridge; +} + +describe('OverlayClock', () => { + beforeEach(() => vi.useFakeTimers()); + afterEach(() => vi.useRealTimers()); + + const now = () => Date.now(); + + it('reads the player and computes the position between two reads', async () => { + const bridge = fakeBridge('playing=1;position=1000;speed=2;package=p'); + const states: ClockState[] = []; + const clock = new OverlayClock(bridge, now); + clock.start((s) => states.push(s)); + await vi.advanceTimersByTimeAsync(0); + expect(bridge.calls).toEqual(['state']); + expect(states.at(-1)).toEqual({ positionMs: 1000, playing: true, seeked: false, error: null }); + await vi.advanceTimersByTimeAsync(TICK_MS); + expect(states.at(-1)!.positionMs).toBe(1000 + 2 * TICK_MS); + await vi.advanceTimersByTimeAsync(POLL_MS - TICK_MS); + expect(bridge.calls).toEqual(['state', 'state']); + clock.stop(); + }); + + it('marks a jump of the player as a seek', async () => { + const bridge = fakeBridge('playing=1;position=1000;speed=1;package=p'); + const states: ClockState[] = []; + const clock = new OverlayClock(bridge, now); + clock.start((s) => states.push(s)); + await vi.advanceTimersByTimeAsync(0); + bridge.line = `playing=1;position=${1000 + POLL_MS + JUMP_MS + 1};speed=1;package=p`; + await vi.advanceTimersByTimeAsync(POLL_MS); + expect(states.at(-1)!.seeked).toBe(true); + bridge.line = `playing=1;position=${1000 + 2 * POLL_MS + JUMP_MS + 1};speed=1;package=p`; + await vi.advanceTimersByTimeAsync(POLL_MS); + expect(states.at(-1)!.seeked).toBe(false); + clock.stop(); + }); + + it('reports an error, keeps the place, and reads less often', async () => { + const bridge = fakeBridge('playing=1;position=5000;speed=1;package=p'); + const states: ClockState[] = []; + const clock = new OverlayClock(bridge, now); + clock.start((s) => states.push(s)); + await vi.advanceTimersByTimeAsync(0); + bridge.line = 'error=no_player'; + await vi.advanceTimersByTimeAsync(POLL_MS); + expect(states.at(-1)).toEqual({ + positionMs: 5000 + POLL_MS, + playing: false, + seeked: false, + error: 'no_player', + }); + const reads = bridge.calls.length; + await vi.advanceTimersByTimeAsync(POLL_MS); + expect(bridge.calls.length).toBe(reads); + await vi.advanceTimersByTimeAsync(POLL_ERROR_MS - POLL_MS); + expect(bridge.calls.length).toBe(reads + 1); + clock.stop(); + }); + + it('reports no overlay when the bridge fails', async () => { + const bridge = fakeBridge(''); + bridge.playerState = () => Promise.reject(new Error('no plugin')); + const states: ClockState[] = []; + const clock = new OverlayClock(bridge, now); + clock.start((s) => states.push(s)); + await vi.advanceTimersByTimeAsync(0); + expect(states.at(-1)).toEqual({ + positionMs: null, + playing: false, + seeked: false, + error: 'no_overlay', + }); + clock.stop(); + }); + + it('sets the clock at once on play, pause and seek, and skips one read', async () => { + const bridge = fakeBridge('playing=0;position=1000;speed=1;package=p'); + const states: ClockState[] = []; + const clock = new OverlayClock(bridge, now); + clock.start((s) => states.push(s)); + await vi.advanceTimersByTimeAsync(0); + await clock.play(); + expect(bridge.calls).toEqual(['state', 'play']); + expect(states.at(-1)!.playing).toBe(true); + // The next read is skipped: the player takes a moment to start. + await vi.advanceTimersByTimeAsync(POLL_MS); + expect(bridge.calls).toEqual(['state', 'play']); + await vi.advanceTimersByTimeAsync(POLL_MS); + expect(bridge.calls).toEqual(['state', 'play', 'state']); + + await clock.seek(30000); + expect(bridge.calls.at(-1)).toBe('seek 30000'); + expect(states.at(-1)).toMatchObject({ positionMs: 30000, seeked: true }); + + await clock.pause(); + expect(states.at(-1)!.playing).toBe(false); + clock.stop(); + }); +}); diff --git a/test/hit-test.test.ts b/test/hit-test.test.ts index 8f94808..222af98 100644 --- a/test/hit-test.test.ts +++ b/test/hit-test.test.ts @@ -50,6 +50,26 @@ describe('tokenAt', () => { }); }); +/** Tokens of one line of words, with a word id per word. Spaces are not tokens. */ +function wordTokens(words: string[], page = 0, line = 0): OcrToken[] { + const tokens: OcrToken[] = []; + let col = 0; + words.forEach((w, wi) => { + for (const ch of w) { + tokens.push({ + text: ch, + page, + line, + word: wi, + bbox: { x0: col * 10, y0: 0, x1: col * 10 + 10, y1: 20 }, + }); + col++; + } + col++; + }); + return tokens; +} + describe('scanText', () => { it('reads to the end of the line, up to the limit', () => { const tokens = tokensOf(['吾輩は猫である', '名前はまだ無い']); @@ -57,6 +77,14 @@ describe('scanText', () => { expect(scanText(tokens, 0, 3)).toBe('吾輩は'); expect(scanText(tokens, 99)).toBe(''); }); + + it('puts a space between words, and the spaces do not count', () => { + const tokens = wordTokens(['who', 'answered', 'with']); + expect(scanText(tokens, 0)).toBe('who answered with'); + expect(scanText(tokens, 1)).toBe('ho answered with'); + expect(scanText(tokens, 0, 10)).toBe('who answere'); + expect(scanText(wordTokens(['吾輩', 'は', 'cat']), 0)).toBe('吾輩は cat'); + }); }); describe('lookupText', () => { @@ -71,6 +99,11 @@ describe('lookupText', () => { expect(lookupText(tokens, 3)).toBe('猫である名前はまだ無い'); }); + it('joins a short line and the next line with a space', () => { + const tokens = [...wordTokens(['the', 'end'], 0, 0), ...wordTokens(['of', 'it'], 0, 1)]; + expect(lookupText(tokens, 3)).toBe('end of it'); + }); + it('does not cross to the next page', () => { const tokens = [...tokensOf(['abcdef'], 0), ...tokensOf(['ghijkl'], 1)]; expect(lookupText(tokens, 4)).toBe('ef'); @@ -80,7 +113,8 @@ describe('lookupText', () => { it('stops at the lookup length', () => { const tokens = tokensOf(['a'.repeat(60), 'b'.repeat(60)]); expect(lookupText(tokens, 0)).toBe('a'.repeat(LOOKUP_LENGTH)); - expect(lookupText(tokens, 58)).toBe('aa' + 'b'.repeat(LOOKUP_LENGTH - 2)); + // A line break is a word break: a space goes between the two lines. + expect(lookupText(tokens, 58)).toBe('aa ' + 'b'.repeat(LOOKUP_LENGTH - 2)); }); it('never returns more than the lookup length, and always starts with the tapped character', () => { @@ -90,7 +124,7 @@ describe('lookupText', () => { const tokens = tokensOf(lines); const start = pick % tokens.length; const text = lookupText(tokens, start); - expect([...text].length).toBeLessThanOrEqual(LOOKUP_LENGTH); + expect([...text.replace(/ /g, '')].length).toBeLessThanOrEqual(LOOKUP_LENGTH); expect(text.startsWith(tokens[start]!.text)).toBe(true); }), );