From 864ff655473ad5b99d82790eaa5fb7633d192bad Mon Sep 17 00:00:00 2001 From: josephm1 <6561307+josephm1@users.noreply.github.com> Date: Wed, 21 Oct 2026 00:43:55 +0100 Subject: [PATCH] Add opt-in standard Android ink capture and editing controller --- README.md | 44 ++ docs/licenses/GPL-3.0-only.txt | 674 ++++++++++++++++++ docs/standard-android-NOTICE.md | 15 + .../com/inksdk/ink/InkControllerFactory.kt | 3 + .../main/java/com/inksdk/ink/InkDefaults.kt | 7 + .../com/inksdk/ink/InkEditingController.kt | 36 + .../com/inksdk/ink/StandardInkController.kt | 497 +++++++++++++ .../inksdk/ink/InkControllerFactoryTest.kt | 9 + .../com/inksdk/ink/StandardInkEditingTest.kt | 180 +++++ 9 files changed, 1465 insertions(+) create mode 100644 docs/licenses/GPL-3.0-only.txt create mode 100644 docs/standard-android-NOTICE.md create mode 100644 inkcontroller/src/main/java/com/inksdk/ink/InkEditingController.kt create mode 100644 inkcontroller/src/main/java/com/inksdk/ink/StandardInkController.kt create mode 100644 inkcontroller/src/test/java/com/inksdk/ink/StandardInkEditingTest.kt diff --git a/README.md b/README.md index 84c2380..fa6bee3 100644 --- a/README.md +++ b/README.md @@ -137,3 +137,47 @@ devices. firmware, e.g. HiBreak Plus). Reflective; no permission needed. - **Onyx**: requires the Boox vendor SDK runtime. The class load succeeds on any device but `attach` throws on non-Onyx and we return false. + +## Optional standard Android controller + +`InkControllerFactory.createStandard()` provides a public-API stylus implementation +for tablets without a vendor overlay. It is opt-in: `create()` still selects the +existing Bigme/Onyx implementations, and `createNoop()` is unchanged. This path uses +ordinary SurfaceView composition and makes no hardware-overlay latency guarantee. + +```kotlin +val ink = InkControllerFactory.createStandard() +// Call from SurfaceHolder.Callback after layout, when the surface is valid. +ink.attach(surfaceView, Rect(0, 0, surfaceView.width, surfaceView.height), callback) +ink.setStrokeStyle(widthPx = 5f, color = Color.BLACK) +// Supply the authoritative page before writing and after host document edits. +ink.syncOverlay(pageBitmap) +``` + +The controller installs an OnTouchListener on the attached SurfaceView. Do not +also forward the same events manually. NativeActivity hosts that bypass View +dispatch may instead call `onMotionEvent` once per event. Input, presentation and +configuration belong on the main thread. Detach before the surface is destroyed. +The host owns document persistence, undo, scrolling and eraser behavior. + +- Stylus input is captured; finger and eraser contacts are not consumed. This does + not itself dispatch touches to sibling views: the host chooses their routing. +- Coalesced historical points are delivered in order. Presentations are batched + per MotionEvent, including the final UP segment. +- Writing bounds and exclusions prevent control contacts from becoming ink. + `setExcludedPenTouch` can route excluded pen contacts to host controls. +- `setCaptureOnly` or `setCaptureOnlyAt` delivers gestures without painting them, + allowing host-owned selection, checkboxes and erasing without a temporary dot. +- `syncOverlay` replaces authoritative pixels, including transparent pixels; + `syncChrome` updates a cropped control area without clearing the page. +- Call `setEnabled(false)` before host redraws. The current stroke is completed + once. Size changes require reattachment and a fresh authoritative bitmap. +- Recorded timings are handler/draw/presentation-call durations, not measured + kernel-to-panel latency. Unit tests do not establish palm rejection or e-ink + refresh behavior; device acceptance remains necessary. + +This contribution is adapted from [Kalamos InkSDK](https://github.com/josephm1/kalamos-inksdk), +which builds on **InkSDK by Ed Wei (imedwei) and contributors**. The new standard +controller, editing interface and their test are contributed under GPL-3.0-only; +see [docs/standard-android-NOTICE.md](docs/standard-android-NOTICE.md). Existing +upstream files retain their authorship and licensing status. diff --git a/docs/licenses/GPL-3.0-only.txt b/docs/licenses/GPL-3.0-only.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/docs/licenses/GPL-3.0-only.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/docs/standard-android-NOTICE.md b/docs/standard-android-NOTICE.md new file mode 100644 index 0000000..fc492c3 --- /dev/null +++ b/docs/standard-android-NOTICE.md @@ -0,0 +1,15 @@ +# Standard Android contribution + +The new `StandardInkController.kt`, `InkEditingController.kt` and +`StandardInkEditingTest.kt` are adapted from the Kalamos InkSDK adaptation by +josephm1 and contributed under **GPL-3.0-only**. The complete licence is in +[GPL-3.0-only.txt](licenses/GPL-3.0-only.txt). + +Kalamos InkSDK builds on **[InkSDK](https://github.com/imedwei/inksdk) by Ed Wei +(imedwei) and contributors**, whose original authorship and credit are preserved. +The pressure/dash helpers and opt-in factory entry accompany this contribution. +This notice does not relicense existing upstream files or third-party libraries. + +Source: https://github.com/josephm1/kalamos-inksdk at +b316946d67013a457170c15664c882e6d628561d. The implementation is adapted to the +upstream package/API, with final-UP presentation and disjoint-region guards. diff --git a/inkcontroller/src/main/java/com/inksdk/ink/InkControllerFactory.kt b/inkcontroller/src/main/java/com/inksdk/ink/InkControllerFactory.kt index c39cd89..8876e97 100644 --- a/inkcontroller/src/main/java/com/inksdk/ink/InkControllerFactory.kt +++ b/inkcontroller/src/main/java/com/inksdk/ink/InkControllerFactory.kt @@ -22,6 +22,9 @@ object InkControllerFactory { if (BigmeInkController.isBigmeDevice()) BigmeInkController() else OnyxInkController() + /** Opt-in public Android stylus path; vendor auto-selection remains unchanged. */ + fun createStandard(): InkEditingController = StandardInkController() + fun createNoop(): InkController = NoopInkController /** True iff the current device is identified as a Bigme device. */ diff --git a/inkcontroller/src/main/java/com/inksdk/ink/InkDefaults.kt b/inkcontroller/src/main/java/com/inksdk/ink/InkDefaults.kt index 9c4ba83..9b96c4c 100644 --- a/inkcontroller/src/main/java/com/inksdk/ink/InkDefaults.kt +++ b/inkcontroller/src/main/java/com/inksdk/ink/InkDefaults.kt @@ -9,4 +9,11 @@ import android.graphics.Color object InkDefaults { const val DEFAULT_STROKE_WIDTH_PX: Float = 5f const val DEFAULT_STROKE_COLOR: Int = Color.BLACK + + /** Shared live/replay pressure curve: 0.3x to 2x of the base width. */ + fun pressureToWidth(baseWidthPx: Float, pressure: Float): Float = + baseWidthPx * (0.3f + 1.7f * pressure.coerceIn(0f, 1f)) + + /** Surface-pixel dash pattern for selection trails. */ + fun dashIntervals(): FloatArray = floatArrayOf(16f, 24f) } diff --git a/inkcontroller/src/main/java/com/inksdk/ink/InkEditingController.kt b/inkcontroller/src/main/java/com/inksdk/ink/InkEditingController.kt new file mode 100644 index 0000000..616cfe1 --- /dev/null +++ b/inkcontroller/src/main/java/com/inksdk/ink/InkEditingController.kt @@ -0,0 +1,36 @@ +// SPDX-License-Identifier: GPL-3.0-only +// Adapted from Kalamos InkSDK by josephm1; builds on InkSDK by Ed Wei and contributors. +package com.inksdk.ink + +import android.graphics.Bitmap +import android.graphics.Rect + +/** Optional native editing capabilities shared by reader hosts; no document or vendor policy. */ +interface InkEditingController : InkController { + /** Input clipping and pen presentation options; all coordinates are view-local pixels. */ + fun setWritingTop(topPx: Int) + fun setWritingExclusion(left: Int, top: Int, right: Int, bottom: Int) + fun setWritingBounds(left: Int, top: Int, right: Int, bottom: Int) + /** Leave eraser gestures to the host instead of painting ink. */ + fun setEraserMode(active: Boolean) + fun setPressureMode(active: Boolean) + fun setDashMode(active: Boolean) + /** Ordinary surface presentation; no vendor fast-waveform claim. */ + fun refreshRegionFast(bitmap: Bitmap, region: Rect) = syncOverlay(bitmap, region) + + val isAvailable: Boolean get() = true + /** NativeActivity hosts must forward their raw input queue; normal View hosts do not. */ + val requiresMotionForwarding: Boolean get() = false + fun onMotionEvent(event: android.view.MotionEvent): Boolean = false + /** Deliver gestures without drawing their temporary trail (eraser/selection manipulation). */ + fun setCaptureOnly(active: Boolean) + /** Decide capture-only ownership at DOWN, before painting the first sample. */ + fun setCaptureOnlyAt(decision: ((Float, Float) -> Boolean)?) + /** Optional daemon visibility; ordinary Android already uses the host's surface. */ + fun setOverlayVisible(visible: Boolean) {} + /** Excluded control contacts must not become saved strokes. Action uses MotionEvent constants. */ + fun setExcludedPenTouch(listener: ((Int, Float, Float) -> Unit)?) + /** A cropped chrome bitmap at region's surface-local origin; preserve all other pixels. */ + fun syncChrome(bitmap: Bitmap, region: Rect) + fun syncOverlayRubber(bitmap: Bitmap, region: Rect) = syncOverlay(bitmap, region, true) +} diff --git a/inkcontroller/src/main/java/com/inksdk/ink/StandardInkController.kt b/inkcontroller/src/main/java/com/inksdk/ink/StandardInkController.kt new file mode 100644 index 0000000..09d81ca --- /dev/null +++ b/inkcontroller/src/main/java/com/inksdk/ink/StandardInkController.kt @@ -0,0 +1,497 @@ +// SPDX-License-Identifier: GPL-3.0-only +// Adapted from Kalamos InkSDK by josephm1; builds on InkSDK by Ed Wei and contributors. +package com.inksdk.ink + +import android.graphics.Bitmap +import android.graphics.Canvas +import android.graphics.Color +import android.graphics.DashPathEffect +import android.graphics.Paint +import android.graphics.Rect +import android.os.SystemClock +import android.util.Log +import android.view.InputDevice +import android.view.MotionEvent +import android.view.SurfaceView +import android.view.View +import kotlin.math.hypot + +/** + * Public-API Android pen capture and SurfaceView rendering (no vendor latency guarantee). + * + * The controller consumes only stylus gestures that begin inside the active writing area. Finger + * and eraser gestures are not consumed; the host owns their dispatch policy. Historical points are + * delivered before the current sample so fast pen motion does not lose Android's coalesced data. + */ +class StandardInkController : InkEditingController { + override val requiresMotionForwarding: Boolean = true + override fun onMotionEvent(event: MotionEvent): Boolean = handleTouch(event) + @Volatile + override var isActive: Boolean = false + private set + + override val consumesMotionEvents: Boolean + get() = isActive + + private var view: SurfaceView? = null + private var callback: StrokeCallback? = null + private val attachLimit = Rect() + private val exclusion = Rect() + private val writingBounds = Rect() + private var writingTop = 0 + private var enabled = true + private var eraserMode = false + private var pressureMode = false + private var captureOnly = false + private var gestureCaptureOnly = false + private var captureOnlyAt: ((Float, Float) -> Boolean)? = null + private var excludedPenTouch: ((Int, Float, Float) -> Unit)? = null + private var excludedPointerId = MotionEvent.INVALID_POINTER_ID + private var dashMode = false + private var strokeWidth = InkDefaults.DEFAULT_STROKE_WIDTH_PX + private var strokeColor = InkDefaults.DEFAULT_STROKE_COLOR + + private var activePointerId = MotionEvent.INVALID_POINTER_ID + private var strokeStarted = false + private var lastX = 0f + private var lastY = 0f + private var lastPressure = 0.5f + private var lastTimestamp = 0L + private var dashPhase = 0f + private var pointCount = 0 + private var historicalPointCount = 0 + private var minPressure = 1f + private var maxPressure = 0f + private var moveEventCount = 0 + private var livePresentCount = 0 + + private var backingBitmap: Bitmap? = null + private var backingCanvas: Canvas? = null + private val paint = Paint(Paint.ANTI_ALIAS_FLAG).apply { + style = Paint.Style.STROKE + strokeCap = Paint.Cap.ROUND + strokeJoin = Paint.Join.ROUND + } + private val bitmapPaint = Paint(Paint.ANTI_ALIAS_FLAG or Paint.FILTER_BITMAP_FLAG).apply { + xfermode = android.graphics.PorterDuffXfermode(android.graphics.PorterDuff.Mode.SRC) + } + private val dirty = Rect() + private val motionDirty = Rect() + + private val touchListener = View.OnTouchListener { _, event -> handleTouch(event) } + + override fun attach(view: SurfaceView, limit: Rect, callback: StrokeCallback): Boolean { + detach() + if (view.width <= 0 || view.height <= 0 || view.holder.surface?.isValid != true) { + Log.w(TAG, "attach rejected: invalid surface ${view.width}x${view.height}") + return false + } + this.view = view + this.callback = callback + attachLimit.set(limit) + enabled = true + ensureBacking(view.width, view.height) + view.setOnTouchListener(touchListener) + isActive = true + Log.i(TAG, "attached standard stylus surface=${view.width}x${view.height} limit=$attachLimit") + return true + } + + override fun setStrokeStyle(widthPx: Float, color: Int) { + strokeWidth = widthPx.coerceAtLeast(0.5f) + strokeColor = color + } + + override fun setWritingTop(topPx: Int) { + writingTop = topPx.coerceAtLeast(0) + } + + override fun setWritingExclusion(left: Int, top: Int, right: Int, bottom: Int) { + exclusion.set(left, top, right, bottom) + } + + override fun setWritingBounds(left: Int, top: Int, right: Int, bottom: Int) { + writingBounds.set(left, top, right, bottom) + } + + override fun setEraserMode(active: Boolean) { + eraserMode = active + } + + override fun setPressureMode(active: Boolean) { + pressureMode = active + } + + override fun setDashMode(active: Boolean) { + dashMode = active + } + + override fun setCaptureOnly(active: Boolean) { captureOnly = active } + override fun setCaptureOnlyAt(decision: ((Float, Float) -> Boolean)?) { captureOnlyAt = decision } + override fun setExcludedPenTouch(listener: ((Int, Float, Float) -> Unit)?) { excludedPenTouch = listener } + + override fun syncChrome(bitmap: Bitmap, region: Rect) { + val surface = view ?: return + ensureBacking(surface.width, surface.height) + val canvas = backingCanvas ?: return + val clipped = Rect(region) + if (!clipped.intersect(0, 0, surface.width, surface.height)) return + canvas.save() + canvas.clipRect(clipped) + canvas.drawBitmap(bitmap, region.left.toFloat(), region.top.toFloat(), bitmapPaint) + canvas.restore() + present(surface, clipped) + } + + override fun setEnabled(enabled: Boolean) { + if (!enabled) finishAtLastPoint() + this.enabled = enabled + } + + override fun syncOverlay(bitmap: Bitmap, region: Rect?, force: Boolean) { + val surface = view ?: return + ensureBacking(bitmap.width, bitmap.height) + val target = backingCanvas ?: return + val copyRegion = clampedRegion(region, bitmap.width, bitmap.height) + if (copyRegion.isEmpty) return + target.drawBitmap(bitmap, copyRegion, copyRegion, bitmapPaint) + present(surface, copyRegion) + } + + override fun refreshRegionFast(bitmap: Bitmap, region: Rect) { + syncOverlay(bitmap, region, false) + } + + override fun mirrorOverlay(target: Bitmap): Boolean { + val source = backingBitmap ?: return false + if (target.width != source.width || target.height != source.height) return false + Canvas(target).drawBitmap(source, 0f, 0f, bitmapPaint) + return true + } + + override fun detach() { + finishAtLastPoint() + view?.setOnTouchListener(null) + view = null + callback = null + isActive = false + activePointerId = MotionEvent.INVALID_POINTER_ID + excludedPointerId = MotionEvent.INVALID_POINTER_ID + strokeStarted = false + backingBitmap = null + backingCanvas = null + Log.i(TAG, "detached standard stylus surface") + } + + private fun handleTouch(event: MotionEvent): Boolean { + val startedNs = System.nanoTime() + try { + if (!isActive || !enabled) return false + if (excludedPointerId != MotionEvent.INVALID_POINTER_ID) { + val index = event.findPointerIndex(excludedPointerId) + if (index >= 0) excludedPenTouch?.invoke(event.actionMasked, event.getX(index), event.getY(index)) + if (event.actionMasked in listOf(MotionEvent.ACTION_UP, MotionEvent.ACTION_CANCEL) || + event.actionMasked == MotionEvent.ACTION_POINTER_UP && event.getPointerId(event.actionIndex) == excludedPointerId) { + excludedPointerId = MotionEvent.INVALID_POINTER_ID + } + return true + } + return when (event.actionMasked) { + MotionEvent.ACTION_DOWN -> beginGesture(event) + MotionEvent.ACTION_MOVE -> moveGesture(event) + MotionEvent.ACTION_UP -> endGesture(event, event.actionIndex) + MotionEvent.ACTION_POINTER_UP -> { + if (event.getPointerId(event.actionIndex) == activePointerId) { + endGesture(event, event.actionIndex) + } else { + activePointerId != MotionEvent.INVALID_POINTER_ID + } + } + MotionEvent.ACTION_CANCEL, MotionEvent.ACTION_OUTSIDE -> { + val consumed = activePointerId != MotionEvent.INVALID_POINTER_ID + finishAtLastPoint() + resetGesture() + consumed + } + else -> activePointerId != MotionEvent.INVALID_POINTER_ID + } + } finally { + PerfCounters.recordDirect(PerfMetric.EVENT_HANDLER, System.nanoTime() - startedNs) + } + } + + private fun beginGesture(event: MotionEvent): Boolean { + val index = event.actionIndex + val tool = event.getToolType(index) + val isStylus = tool == MotionEvent.TOOL_TYPE_STYLUS || + event.isFromSource(InputDevice.SOURCE_STYLUS) + if (!isStylus || tool == MotionEvent.TOOL_TYPE_ERASER || eraserMode) return false + + val x = event.getX(index) + val y = event.getY(index) + if (!accepts(x, y)) { + if (excludedPenTouch == null) return false + excludedPointerId = event.getPointerId(index) + excludedPenTouch?.invoke(MotionEvent.ACTION_DOWN, x, y) + return true + } + gestureCaptureOnly = captureOnly || captureOnlyAt?.invoke(x, y) == true + + activePointerId = event.getPointerId(index) + pointCount = 0 + historicalPointCount = 0 + minPressure = 1f + maxPressure = 0f + moveEventCount = 0 + livePresentCount = 0 + startStroke(x, y, pressure(event.getPressure(index)), event.eventTime) + return true + } + + private fun moveGesture(event: MotionEvent): Boolean { + if (activePointerId == MotionEvent.INVALID_POINTER_ID) return false + val index = event.findPointerIndex(activePointerId) + if (index < 0) { + finishAtLastPoint() + resetGesture() + return true + } + motionDirty.setEmpty() + for (historyIndex in 0 until event.historySize) { + sample( + event.getHistoricalX(index, historyIndex), + event.getHistoricalY(index, historyIndex), + pressure(event.getHistoricalPressure(index, historyIndex)), + event.getHistoricalEventTime(historyIndex), + ) + historicalPointCount++ + } + sample(event.getX(index), event.getY(index), pressure(event.getPressure(index)), event.eventTime) + moveEventCount++ + presentMotionBatch() + return true + } + + private fun endGesture(event: MotionEvent, index: Int): Boolean { + if (activePointerId == MotionEvent.INVALID_POINTER_ID || + event.getPointerId(index) != activePointerId + ) { + return false + } + motionDirty.setEmpty() + for (historyIndex in 0 until event.historySize) { + sample( + event.getHistoricalX(index, historyIndex), + event.getHistoricalY(index, historyIndex), + pressure(event.getHistoricalPressure(index, historyIndex)), + event.getHistoricalEventTime(historyIndex), + ) + historicalPointCount++ + } + val x = event.getX(index) + val y = event.getY(index) + val p = pressure(event.getPressure(index)) + if (accepts(x, y)) { + if (!strokeStarted) { + startStroke(x, y, p, event.eventTime) + } else { + drawSegment(lastX, lastY, x, y, lastPressure, p) + callback?.onStrokeEnd(x, y, p, event.eventTime) + remember(x, y, p, event.eventTime) + pointCount++ + logCompletedStroke() + strokeStarted = false + } + } else { + finishAtLastPoint() + } + presentMotionBatch() + resetGesture() + return true + } + + private fun sample(x: Float, y: Float, pressure: Float, timestamp: Long) { + if (!accepts(x, y)) { + finishAtLastPoint() + return + } + if (!strokeStarted) { + startStroke(x, y, pressure, timestamp) + return + } + drawSegment(lastX, lastY, x, y, lastPressure, pressure) + callback?.onStrokeMove(x, y, pressure, timestamp) + remember(x, y, pressure, timestamp) + pointCount++ + } + + private fun startStroke(x: Float, y: Float, pressure: Float, timestamp: Long) { + dashPhase = 0f + drawDot(x, y, pressure) + callback?.onStrokeBegin(x, y, pressure, timestamp) + remember(x, y, pressure, timestamp) + pointCount++ + strokeStarted = true + } + + private fun finishAtLastPoint() { + if (!strokeStarted) return + callback?.onStrokeEnd(lastX, lastY, lastPressure, lastTimestamp) + pointCount++ + logCompletedStroke() + strokeStarted = false + } + + private fun resetGesture() { + activePointerId = MotionEvent.INVALID_POINTER_ID + strokeStarted = false + } + + private fun remember(x: Float, y: Float, pressure: Float, timestamp: Long) { + lastX = x + lastY = y + lastPressure = pressure + lastTimestamp = timestamp + minPressure = minOf(minPressure, pressure) + maxPressure = maxOf(maxPressure, pressure) + } + + private fun accepts(x: Float, y: Float): Boolean { + if (!attachLimit.contains(x.toInt(), y.toInt())) return false + if (writingTop > 0 && y < writingTop) return false + if (!exclusion.isEmpty && exclusion.contains(x.toInt(), y.toInt())) return false + if (!writingBounds.isEmpty && !writingBounds.contains(x.toInt(), y.toInt())) return false + return true + } + + private fun drawDot(x: Float, y: Float, pressure: Float) { + if (gestureCaptureOnly) return + val canvas = backingCanvas ?: return + configurePaint(pressure) + val radius = paint.strokeWidth / 2f + val dotPaint = Paint(paint).apply { style = Paint.Style.FILL } + canvas.drawCircle(x, y, radius, dotPaint) + val pad = paint.strokeWidth.toInt() + 3 + dirty.set( + (x.toInt() - pad).coerceAtLeast(0), + (y.toInt() - pad).coerceAtLeast(0), + (x.toInt() + pad).coerceAtMost(backingBitmap?.width ?: 0), + (y.toInt() + pad).coerceAtMost(backingBitmap?.height ?: 0), + ) + view?.let { + present(it, dirty) + livePresentCount++ + } + } + + private fun drawSegment( + fromX: Float, + fromY: Float, + toX: Float, + toY: Float, + fromPressure: Float, + toPressure: Float, + ) { + if (gestureCaptureOnly) return + val startedNs = System.nanoTime() + val canvas = backingCanvas ?: return + configurePaint((fromPressure + toPressure) / 2f) + if (dashMode) { + paint.pathEffect = DashPathEffect(InkDefaults.dashIntervals(), dashPhase) + dashPhase += hypot((toX - fromX).toDouble(), (toY - fromY).toDouble()).toFloat() + } else { + paint.pathEffect = null + } + canvas.drawLine(fromX, fromY, toX, toY, paint) + PerfCounters.recordDirect(PerfMetric.PAINT_DRAW_SEGMENT, System.nanoTime() - startedNs) + + val pad = paint.strokeWidth.toInt() + 3 + val width = backingBitmap?.width ?: return + val height = backingBitmap?.height ?: return + dirty.set( + (minOf(fromX, toX).toInt() - pad).coerceAtLeast(0), + (minOf(fromY, toY).toInt() - pad).coerceAtLeast(0), + (maxOf(fromX, toX).toInt() + pad).coerceAtMost(width), + (maxOf(fromY, toY).toInt() + pad).coerceAtMost(height), + ) + if (motionDirty.isEmpty) motionDirty.set(dirty) else motionDirty.union(dirty) + } + + /** + * Android may deliver many historical samples in one MOVE. Drawing all of them into the backing + * bitmap is cheap; posting one Surface transaction per sample is not. Present their union once + * per MotionEvent so the surface tracks input cadence instead of replaying a long commit queue. + */ + private fun presentMotionBatch() { + if (motionDirty.isEmpty) return + view?.let { + present(it, motionDirty) + livePresentCount++ + } + motionDirty.setEmpty() + } + + private fun configurePaint(pressure: Float) { + paint.color = strokeColor + paint.strokeWidth = if (pressureMode) { + InkDefaults.pressureToWidth(strokeWidth, pressure) + } else { + strokeWidth + } + } + + private fun present(surfaceView: SurfaceView, region: Rect) { + val bitmap = backingBitmap ?: return + if (region.isEmpty || surfaceView.holder.surface?.isValid != true) return + val startedNs = System.nanoTime() + var canvas: Canvas? = null + try { + canvas = surfaceView.holder.lockCanvas(region) + canvas?.drawBitmap(bitmap, region, region, bitmapPaint) + } catch (t: Throwable) { + Log.w(TAG, "surface present failed: ${t.message}") + } finally { + if (canvas != null) { + surfaceView.holder.unlockCanvasAndPost(canvas) + PerfCounters.recordDirect( + PerfMetric.PAINT_INVALIDATE_CALL, + System.nanoTime() - startedNs, + ) + } + } + } + + private fun ensureBacking(width: Int, height: Int) { + val current = backingBitmap + if (current != null && current.width == width && current.height == height) return + val fresh = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888) + val canvas = Canvas(fresh) + canvas.drawColor(Color.WHITE) + current?.let { canvas.drawBitmap(it, 0f, 0f, bitmapPaint) } + backingBitmap = fresh + backingCanvas = canvas + } + + private fun clampedRegion(region: Rect?, width: Int, height: Int): Rect { + val result = region?.let(::Rect) ?: Rect(0, 0, width, height) + if (!result.intersect(0, 0, width, height)) result.setEmpty() + return result + } + + private fun pressure(value: Float): Float = + if (value.isFinite()) value.coerceIn(0f, 1f) else 0.5f + + private fun logCompletedStroke() { + Log.i( + TAG, + "DIAG standardInkStroke points=$pointCount historical=$historicalPointCount " + + "moveEvents=$moveEventCount livePresents=$livePresentCount " + + "pressure=${"%.3f".format(java.util.Locale.US, minPressure)}.." + + "${"%.3f".format(java.util.Locale.US, maxPressure)} t=${SystemClock.uptimeMillis()}", + ) + } + + private companion object { + const val TAG = "StandardInkController" + } +} diff --git a/inkcontroller/src/test/java/com/inksdk/ink/InkControllerFactoryTest.kt b/inkcontroller/src/test/java/com/inksdk/ink/InkControllerFactoryTest.kt index 32b40d0..04ac0d1 100644 --- a/inkcontroller/src/test/java/com/inksdk/ink/InkControllerFactoryTest.kt +++ b/inkcontroller/src/test/java/com/inksdk/ink/InkControllerFactoryTest.kt @@ -16,6 +16,15 @@ import org.robolectric.util.ReflectionHelpers @Config(sdk = [34], application = Application::class) class InkControllerFactoryTest { + @Test + fun createStandardIsOptInAndInitiallyInactive() { + val controller = InkControllerFactory.createStandard() + assertTrue(controller is StandardInkController) + assertFalse(controller.isActive) + assertFalse(controller.consumesMotionEvents) + assertFalse(controller.ownsSurface) + } + @Test fun createNoopAlwaysReturnsTheSingleton() { assertSame(NoopInkController, InkControllerFactory.createNoop()) diff --git a/inkcontroller/src/test/java/com/inksdk/ink/StandardInkEditingTest.kt b/inkcontroller/src/test/java/com/inksdk/ink/StandardInkEditingTest.kt new file mode 100644 index 0000000..87bc35e --- /dev/null +++ b/inkcontroller/src/test/java/com/inksdk/ink/StandardInkEditingTest.kt @@ -0,0 +1,180 @@ +// SPDX-License-Identifier: GPL-3.0-only +// Adapted from Kalamos InkSDK by josephm1; builds on InkSDK by Ed Wei and contributors. +package com.inksdk.ink + +import android.app.Activity +import android.graphics.Bitmap +import android.graphics.Color +import android.graphics.Rect +import android.view.InputDevice +import android.view.MotionEvent +import android.view.SurfaceView +import org.junit.Assert.* +import org.junit.Test +import org.junit.runner.RunWith +import org.robolectric.Robolectric +import org.robolectric.RobolectricTestRunner +import org.robolectric.annotation.Config +import org.robolectric.annotation.GraphicsMode + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [34]) +@GraphicsMode(GraphicsMode.Mode.NATIVE) +class StandardInkEditingTest { + private class Sink : StrokeCallback { + val samples = mutableListOf() + val moves = mutableListOf>() + override fun onStrokeBegin(x: Float, y: Float, pressure: Float, timestampMs: Long) { samples.add("down") } + override fun onStrokeMove(x: Float, y: Float, pressure: Float, timestampMs: Long) { samples.add("move"); moves.add(Triple(x, pressure, timestampMs)) } + override fun onStrokeEnd(x: Float, y: Float, pressure: Float, timestampMs: Long) { samples.add("up") } + } + private fun ready(): Triple { + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + val surface = SurfaceView(activity) + activity.setContentView(surface) + surface.layout(0, 0, 200, 300) + val controller = StandardInkController() + val sink = Sink() + // Robolectric does not create a display Surface. Bind the same model/input owners while + // keeping presentation inert; graphics assertions inspect the retained backing pixels. + for ((name,value) in listOf("view" to surface,"callback" to sink,"isActive" to true)) { + controller.javaClass.getDeclaredField(name).apply { isAccessible=true }.set(controller,value) + } + val limit=controller.javaClass.getDeclaredField("attachLimit").apply { isAccessible=true }.get(controller) as Rect + limit.set(20,40,200,300) + surface.setOnTouchListener { _,event -> controller.onMotionEvent(event) } + controller.syncOverlay(Bitmap.createBitmap(200,300,Bitmap.Config.ARGB_8888).apply { eraseColor(Color.WHITE) }) + return Triple(controller, surface, sink) + } + private fun send(surface: SurfaceView, action: Int, x: Float, y: Float, tool: Int = MotionEvent.TOOL_TYPE_STYLUS): Boolean { + val properties = MotionEvent.PointerProperties().apply { id = 0; toolType = tool } + val coords = MotionEvent.PointerCoords().apply { this.x=x; this.y=y; pressure=.6f } + val event = MotionEvent.obtain(1, 10, action, 1, arrayOf(properties), arrayOf(coords), 0,0,1f,1f,0,0, + if (tool == MotionEvent.TOOL_TYPE_FINGER) InputDevice.SOURCE_TOUCHSCREEN else InputDevice.SOURCE_STYLUS,0) + return try { surface.dispatchTouchEvent(event) } finally { event.recycle() } + } + private fun pixels(controller: StandardInkController) = Bitmap.createBitmap(200,300,Bitmap.Config.ARGB_8888).also { assertTrue(controller.mirrorOverlay(it)) } + + @Test fun captureOnlyDeliversPenWithoutPaintingAndNextWritingGesturePaints() { + val (controller,surface,sink)=ready() + controller.setCaptureOnly(true) + send(surface,MotionEvent.ACTION_DOWN,50f,60f) + send(surface,MotionEvent.ACTION_MOVE,70f,80f) + send(surface,MotionEvent.ACTION_UP,80f,90f) + assertEquals(listOf("down","move","up"),sink.samples) + assertEquals(Color.WHITE,pixels(controller).getPixel(50,60)) + controller.setCaptureOnly(false) + send(surface,MotionEvent.ACTION_DOWN,50f,60f) + send(surface,MotionEvent.ACTION_UP,70f,80f) + assertNotEquals(Color.WHITE,pixels(controller).getPixel(50,60)) + } + @Test fun excludedToolbarContactIsRoutedOnceAndFingerIsNotInk() { + val (controller,surface,sink)=ready() + val actions=mutableListOf() + controller.setExcludedPenTouch { action,_,_ -> actions.add(action) } + send(surface,MotionEvent.ACTION_DOWN,5f,10f) + send(surface,MotionEvent.ACTION_UP,5f,10f) + assertEquals(listOf(MotionEvent.ACTION_DOWN,MotionEvent.ACTION_UP),actions) + assertTrue(sink.samples.isEmpty()) + send(surface,MotionEvent.ACTION_DOWN,50f,60f,MotionEvent.TOOL_TYPE_FINGER) + send(surface,MotionEvent.ACTION_UP,50f,60f,MotionEvent.TOOL_TYPE_FINGER) + assertTrue(sink.samples.isEmpty()) + } + @Test fun croppedChromePreservesRetainedPageInk() { + val (controller,surface,_)=ready() + send(surface,MotionEvent.ACTION_DOWN,50f,60f) + send(surface,MotionEvent.ACTION_UP,50f,60f) + val before=pixels(controller).getPixel(50,60) + val chrome=Bitmap.createBitmap(10,10,Bitmap.Config.ARGB_8888).apply { eraseColor(Color.BLACK) } + controller.syncChrome(chrome,Rect(100,100,110,110)) + val after=pixels(controller) + assertEquals(before,after.getPixel(50,60)) + assertEquals(Color.BLACK,after.getPixel(105,105)) + assertEquals(Color.WHITE,after.getPixel(120,120)) + } + @Test fun transparentAuthoritativeFrameClearsOldLivePixels() { + val (controller,surface,_)=ready() + send(surface,MotionEvent.ACTION_DOWN,50f,60f) + send(surface,MotionEvent.ACTION_UP,50f,60f) + val blank=Bitmap.createBitmap(200,300,Bitmap.Config.ARGB_8888) + controller.syncOverlay(blank) + assertEquals(Color.TRANSPARENT,pixels(controller).getPixel(50,60)) + } + @Test fun perGestureCaptureDecisionAndDisableCompleteTheActiveStrokeOnce() { + val (controller,surface,sink)=ready() + controller.setCaptureOnlyAt { x,_ -> x<100 } + send(surface,MotionEvent.ACTION_DOWN,50f,60f) + controller.setEnabled(false) + send(surface,MotionEvent.ACTION_UP,70f,80f) + assertEquals(listOf("down","up"),sink.samples) + assertEquals(Color.WHITE,pixels(controller).getPixel(50,60)) + controller.setEnabled(true) + send(surface,MotionEvent.ACTION_DOWN,150f,160f) + send(surface,MotionEvent.ACTION_UP,155f,165f) + assertNotEquals(Color.WHITE,pixels(controller).getPixel(150,160)) + } + @Test fun finalUpSegmentIsRetainedAndDisjointSyncLeavesInkIntact() { + val (controller, surface, sink) = ready() + send(surface, MotionEvent.ACTION_DOWN, 50f, 60f) + send(surface, MotionEvent.ACTION_UP, 90f, 60f) + assertEquals(listOf("down", "up"), sink.samples) + assertNotEquals(Color.WHITE, pixels(controller).getPixel(85, 60)) + val blank = Bitmap.createBitmap(200, 300, Bitmap.Config.ARGB_8888) + controller.syncOverlay(blank, Rect(300, 400, 350, 450)) + assertNotEquals(Color.WHITE, pixels(controller).getPixel(85, 60)) + } + + @Test fun cancelEndsOnceAndReentryStartsANewStroke() { + val (controller, surface, sink) = ready() + send(surface, MotionEvent.ACTION_DOWN, 50f, 60f) + send(surface, MotionEvent.ACTION_MOVE, 5f, 10f) + send(surface, MotionEvent.ACTION_MOVE, 60f, 70f) + send(surface, MotionEvent.ACTION_CANCEL, 60f, 70f) + controller.detach() + assertEquals(listOf("down", "up", "down", "up"), sink.samples) + assertFalse(controller.isActive) + assertFalse(controller.consumesMotionEvents) + } + + @Test fun invalidSurfaceAttachDoesNotCaptureInput() { + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + val controller = StandardInkController() + val sink = Sink() + assertFalse(controller.attach(SurfaceView(activity), Rect(0, 0, 200, 300), sink)) + assertFalse(controller.isActive) + assertFalse(controller.consumesMotionEvents) + assertTrue(sink.samples.isEmpty()) + } + + @Test fun historicalSamplesPreserveOrderPressureAndTime() { + val (_, surface, sink) = ready() + send(surface, MotionEvent.ACTION_DOWN, 50f, 60f) + val pointer = MotionEvent.PointerProperties().apply { + id = 0 + toolType = MotionEvent.TOOL_TYPE_STYLUS + } + fun point(x: Float, p: Float) = MotionEvent.PointerCoords().apply { + this.x = x + y = 60f + pressure = p + } + val event = MotionEvent.obtain( + 1, 10, MotionEvent.ACTION_MOVE, 1, arrayOf(pointer), arrayOf(point(60f, .2f)), + 0, 0, 1f, 1f, 0, 0, InputDevice.SOURCE_STYLUS, 0, + ) + try { + event.addBatch(20, arrayOf(point(70f, .4f)), 0) + event.addBatch(30, arrayOf(point(80f, .8f)), 0) + assertTrue(surface.dispatchTouchEvent(event)) + } finally { + event.recycle() + } + assertEquals( + listOf(Triple(60f, .2f, 10L), Triple(70f, .4f, 20L), Triple(80f, .8f, 30L)), + sink.moves, + ) + send(surface, MotionEvent.ACTION_CANCEL, 80f, 60f) + assertEquals(listOf("down", "move", "move", "move", "up"), sink.samples) + } + +}