Merge branch 'feat-typing'

Cargo.toml

@@ -6,10 +6,11 @@ edition = "2021"
 [dependencies]
 anyhow = "1.0.86"
 crossbeam = "0.8.4"
-eframe = "0.29.1"
+eframe = "0.31.0"
-egui = "0.29.1"
+egui = { version = "0.31.0", features = ["log"] }
 enigo = { version = "0.2.1", features = ["serde"] }
 hex = "0.4.3"
+itertools = "0.14.0"
 midir = "0.10.0"
 nom = "7.1.3"
 thiserror = "1.0.63"

LICENSE/AGPL-3.0

@@ -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/>.
+

LICENSE/GAL-1.0

@@ -0,0 +1,33 @@
+# Gay Agenda License - 1.0
+
+Copyright (c) 2025 Nicole Tietz-Sokolskaya <me@ntietz.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+  - The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+  - The grantee shall actively support rights for all LGBTQ+ people, respecting
+    their gender identities.
+  - The grantee shall say "be gay, do crime" at least once during use of the
+    software.
+
+The license is immediately revoked if the grantee supports restricting the
+rights of LGBTQ+ people.
+
+If the grantee is found to not have said "be gay, do crime" during use of the
+software, the grantee has thirty (30) days to remediate this violation without
+loss of the license. If it is not remediated, then the grantee's grants via
+this license are permanently retracted.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,21 @@
-# midi-keys
+# Midi Keys
-type using a synthesizer
+
+Type using a midi instrument.
+
+No instructions provided, probably for the best.
+Please report any bugs, comments, or commercial license requests to [me@ntietz.com](mailto:me@ntietz.com).
+
+
+# Licenses
+
+This software is licensed under the following licenses:
+
+- Under AGPL-3.0
+- Under [GAL-1.0 (Gay Agenda License)](https://gal.gay)
+- Under a commercial license
+
+You may use the software under any one of these licenses, without regard for the others.
+
+
+
+

TASKS.md

@@ -0,0 +1,42 @@
+# a task breakdown in possibly absurd detail because adhd
+
+
+- [ ] drums
+    - [ ] turn on the drums
+    - [ ] open midi-keys
+    - [ ] hit some drums
+    - [ ] open a text file `drum_mapping.md`
+    - [ ] write in text file which midi notes are which drums
+    - [ ] write the encode/decode function for drums
+    - [ ] print to console what the letters are in base-2
+    - [ ] save the notes into `notes_cheat_sheet.md`
+    - [ ] write the drum hot loop
+- [x] wind synth
+    - [x] add min length of note
+    - [x] take into account velocity
+    - [x] change `decode` and `encode` to both be the new alt variant
+    - [x] add punctuation to decode/encode
+    - [x] refactor the hot loop
+    - [x] fix the output of cheat sheet to be correct with new variant
+    - [x] print to console what the letters are in base-7 / notes
+    - [x] save the notes into `notes_cheat_sheet.md`
+    - [x] experiment with mode where shift and caps lock are keys I can press
+- [ ] composing
+    - [ ] open musescore
+    - [ ] create a new score with 3 parts (wind synth, keyboard synth, drum set)
+    - [ ] enter the wind synth notes for "hello" as straight quarternotes
+    - [ ] experiment with rhythms on the wind synth notes
+- [ ] ui
+    - [ ] make default size larger
+    - [ ] fix disconnect/reconnect bug
+        - [ ] recreate disconnect/reconnect bug
+        - [ ] add print statements into some of the queue receives
+        - [ ] debug the bug
+    - [ ] make display of typing state
+        - [ ] expose typing state to the UI
+        - [ ] show current bytes in buffer (raw)
+        - [ ] show current bytes as note names
+        - [ ] show remaining partials as: next note, list of things you can type from there (in alphanum order)
+- [ ] improvements
+    - [ ] swap out printlns for logging
+

cheat_sheet.md

@@ -0,0 +1,50 @@
+
+# Melodic
+
+C C => Modifier(Shift)
+C D => Special(CapsLock)
+C E => Special(Backspace)
+C F => Char('a')
+C G => Char('b')
+C A => Char('c')
+C B => Char('d')
+D C => Char('e')
+D D => Char('f')
+D E => Char('g')
+D F => Char('h')
+D G => Char('i')
+D A => Char('j')
+D B => Char('k')
+E C => Char('l')
+E D => Char('m')
+E E => Char('n')
+E F => Char('o')
+E G => Char('p')
+E A => Char('q')
+E B => Char('r')
+F C => Char('s')
+F D => Char('t')
+F E => Char('u')
+F F => Char('v')
+F G => Char('w')
+F A => Char('x')
+F B => Char('y')
+G C => Char('z')
+G D => Char('0')
+G E => Char('1')
+G F => Char('2')
+G G => Char('3')
+G A => Char('4')
+G B => Char('5')
+A C => Char('6')
+A D => Char('7')
+A E => Char('8')
+A F => Char('9')
+A G => Char('.')
+A A => Char(',')
+A B => Char('!')
+B C => Char(' ')
+B D => Char('\n')
+
+
+

doc/typing.md

@@ -0,0 +1,61 @@
+
+# Typing system design
+
+
+This document talks about how data flows through the system, and how it's
+displayed, so that users can enter text using a MIDI device.
+
+There are a few distinct pieces:
+- **data flow**: how do we get from MIDI to the display and to the typing portion?
+- **encoding**: how do we represent text so that we can enter it?
+- **parsing**: how do we read a MIDI stream to convert it into our text encoding?
+- **display**: how do we present the state to a user so that they can see what they're doing?
+
+
+## Data flow and architecture
+
+We already have the ability for data to flow in, and for devices to be added
+and removed. What we need here is another piece that will keep track of state
+for the typing daemon.
+
+The typing daemon will be a state machine, with state transitions for entering
+new bits and for emitting text (which will then move back to a clear state).
+
+It will be subscribed to all incoming MIDI messages, and it will store a
+separate state for each connection ID, so things you enter on the drums will
+not alter what you're entering on the wind synth, for example.
+
+It will emit text directly, via `enigo` (or, in debug mode, to the console).
+And it will emit its current state on another queue, which can be used to
+display the characters which can be typed.
+
+
+## Encoding
+
+Each MIDI device will be in a given *base*. Wind synth will be in base 11 by
+default, so we can read the semitone and ignore which octave it's in. We could
+expand this to use a wider range, or narrow it to belong to a particular key,
+but this is the starting point. Drums will be in base 2 by default, with the
+snare and kick drum providing the bits and everything else being ignored.
+
+We will support a given range of characters, and some modifiers as well. Other
+keys can be added, but this is where we'll start: just text! the characters
+supported initially will be 'a'..'z', 'A'..'Z', '0'..'9', '.', and ','.
+
+Each of these will be assigned a number, which will then be converted to base 2
+for entry.
+
+
+
+## Display
+
+Given a list of
+
+
+
+
+
+
+
+
+

src/bin/main.rs

@@ -4,21 +4,20 @@ use std::{
 };
 
 use anyhow::{anyhow, Result};
+use enigo::{Direction, Enigo, Key, Keyboard, Settings};
 use midi_keys::{
     log::load_raw_log,
     midi::daemon::Category,
     parser::parse_message,
+    typing::{
+        midi_to_scale_degree, standard_melodic_mapping, Keystroke, Modifier, Special
+    },
     ui::{display_state_daemon, DisplayQueues, DisplayState},
 };
-//use enigo::{Direction, Enigo, Key, Keyboard, Settings};
 use midir::{MidiInput, MidiInputPort};
 
 fn main() {
-    //let mut enigo = Enigo::new(&Settings::default()).unwrap();
+    let (dbg_send, _dbg_recv) = crossbeam::channel::unbounded();
-    //enigo.text("echo \"hello world\"").unwrap();
-    //enigo.key(Key::Return, Direction::Press).unwrap();
-
-    let (dbg_send, dbg_recv) = crossbeam::channel::unbounded();
     let (ws_send, ws_recv) = crossbeam::channel::unbounded();
     let (drum_send, drum_recv) = crossbeam::channel::unbounded();
 
@@ -37,17 +36,61 @@ fn main() {
     let _handle = display_state_daemon(queues, state.clone());
     println!("started daemon");
 
-    std::thread::spawn(move || loop {
+    let melodic_mapping = standard_melodic_mapping();
-        match dbg_recv.recv() {
+    melodic_mapping.print_sequences();
-            Ok(m) => println!("debug: {m:?}"),
+
-            Err(err) => println!("err: {err:?}"),
+    let typing_state = state.melodic_typing_state.clone();
-        }
+
-    });
+    std::thread::spawn(move || {
-    std::thread::spawn(move || loop {
+        let mut enigo = Enigo::new(&Settings::default()).unwrap();
+        let mut shift = false;
+
+        loop {
             match ws_recv.recv() {
-            Ok(m) => println!("windsynth: {m:?}"),
+                Ok((_cid, _ts, m)) => {
+                    let note = match m.note_on_values() {
+                        Some((note, _velocity)) => note,
+                        None => continue,
+                    };
+                    let scale_degree = match midi_to_scale_degree(60, note) {
+                        Some(deg) => deg,
+                        None => continue,
+                    };
+
+                    let mut state = typing_state.lock();
+                    state.enter(scale_degree);
+
+                    match state.emit() {
+                        midi_keys::typing::Decoded::Keystroke(keystroke) => match keystroke {
+                            Keystroke::Char(mut c) => {
+                                if shift {
+                                    c = c.to_ascii_uppercase();
+                                    shift = false;
+                                }
+                                enigo.text(&format!("{c}")).unwrap();
+                            }
+                            Keystroke::Modifier(Modifier::Shift) => {
+                                println!("Shifting!");
+                                shift = !shift;
+                            }
+                            Keystroke::Special(Special::CapsLock) => {
+                                enigo.key(Key::CapsLock, Direction::Click).unwrap()
+                            }
+                            Keystroke::Special(Special::Backspace) => {
+                                enigo.key(Key::Backspace, Direction::Click).unwrap()
+                            }
+                        },
+                        midi_keys::typing::Decoded::Partial(notes, _keys) => {
+                            println!("Buffer: {notes:?}");
+                        }
+                        midi_keys::typing::Decoded::Invalid(notes) => {
+                            println!("Invalid: {notes:?}");
+                        }
+                    }
+                }
                 Err(err) => println!("err(ws): {err:?}"),
             }
+        }
     });
     std::thread::spawn(move || loop {
         match drum_recv.recv() {
@@ -59,6 +102,13 @@ fn main() {
     midi_keys::ui::run(state);
 }
 
+pub fn press_modifier(keyboard: &mut Enigo, modifier: &Modifier, direction: Direction) {
+    match modifier {
+        Modifier::Shift => keyboard.key(Key::Shift, direction),
+    }
+    .unwrap();
+}
+
 pub fn run() -> Result<()> {
     let midi_in = MidiInput::new("keyboard")?;
 

src/lib.rs

@@ -1,4 +1,5 @@
 pub mod log;
 pub mod midi;
 pub mod parser;
+pub mod typing;
 pub mod ui;

src/midi.rs

@@ -10,6 +10,32 @@ impl Message {
     pub fn new(raw: Vec<u8>, parsed: ParsedMessage) -> Self {
         Message { raw, parsed }
     }
+
+    /// Extracts the note value and velocity for any NoteOn messages.
+    /// This is a convenience function to let us avoid a match in all the places
+    /// we need to extract this.
+    pub fn note_on_values(&self) -> Option<(u8, u8)> {
+        match &self.parsed {
+            ParsedMessage::Voice(VoiceMessage {
+                category: VoiceCategory::NoteOn { note, velocity },
+                ..
+            }) => Some((*note, *velocity)),
+            _ => None,
+        }
+    }
+
+    /// Extracts the note value and velocity for any NoteOff messages.
+    /// This is a convenience function to let us avoid a match in all the places
+    /// we need to extract this.
+    pub fn note_off_values(&self) -> Option<(u8, u8)> {
+        match &self.parsed {
+            ParsedMessage::Voice(VoiceMessage {
+                category: VoiceCategory::NoteOff { note, velocity },
+                ..
+            }) => Some((*note, *velocity)),
+            _ => None,
+        }
+    }
 }
 
 #[derive(PartialEq, Eq, Debug, Clone)]

src/parser.rs

@@ -149,11 +149,11 @@ mod tests {
 
         let note = 0x24;
         let velocity = 0x51;
-        let expected = Message::Voice(VoiceMessage::new(
+        let expected = ParsedMessage::Voice(VoiceMessage::new(
             VoiceCategory::NoteOn { note, velocity },
             0,
         ));
-        assert_eq!(parsed, expected,);
+        assert_eq!(parsed.parsed, expected,);
         assert_eq!(remainder.len(), 0);
     }
 

src/typing.rs

@@ -0,0 +1,257 @@
+use itertools::Itertools;
+use std::collections::HashMap;
+
+#[derive(Debug, Clone)]
+pub enum Decoded {
+    Keystroke(Keystroke),
+    Partial(Vec<u8>, Vec<(Vec<u8>, Keystroke)>),
+    Invalid(Vec<u8>),
+}
+
+#[derive(Debug, Clone)]
+pub struct Mapping {
+    sequences: Vec<(Vec<u8>, Keystroke)>,
+    key_to_seq: HashMap<Keystroke, Vec<u8>>,
+}
+
+impl Mapping {
+    pub fn new(mut sequences: Vec<(Vec<u8>, Keystroke)>) -> Mapping {
+        sequences.sort();
+        let key_to_seq = sequences.iter().cloned().map(|(a, b)| (b, a)).collect();
+
+        Mapping {
+            sequences,
+            key_to_seq,
+        }
+    }
+
+    pub fn encode(&self, key: Keystroke) -> Option<Vec<u8>> {
+        self.key_to_seq.get(&key).cloned()
+    }
+
+    pub fn decode(&self, notes: &Vec<u8>) -> Decoded {
+        if let Some(key) = self.decode_exact(notes) {
+            return Decoded::Keystroke(key.clone());
+        } else if let Some(keys) = self.prefix_range(notes) {
+            return Decoded::Partial(notes.clone(), keys);
+        } else {
+            return Decoded::Invalid(notes.clone());
+        }
+    }
+
+    pub fn decode_exact(&self, notes: &Vec<u8>) -> Option<Keystroke> {
+        let index = self
+            .sequences
+            .binary_search_by(|(n, _key)| n.cmp(&notes))
+            .ok()?;
+        let (_notes, key) = self.sequences.get(index)?;
+        Some(key.clone())
+    }
+
+    pub fn prefix_range(&self, notes: &Vec<u8>) -> Option<Vec<(Vec<u8>, Keystroke)>> {
+        // we only want to match prefixes with exactly this length of notes
+        let valid_seqs: Vec<_> = self
+            .sequences
+            .iter()
+            .filter(|(n, _key)| n.starts_with(&notes))
+            .cloned()
+            .collect();
+
+        if valid_seqs.is_empty() {
+            None
+        } else {
+            Some(valid_seqs)
+        }
+    }
+
+    pub fn collated_remaining(&self, notes: &Vec<u8>) -> Option<Vec<(u8, Vec<Keystroke>)>> {
+        let seqs = self
+            .sequences
+            .iter()
+            .filter(|(n, _key)| n.starts_with(&notes))
+            .map(|(n, key)| (*n.get(notes.len()).unwrap(), key.clone()));
+
+        let mut grouped_seqs = Vec::new();
+
+        for (note, keys) in &seqs.chunk_by(|(n, _key)| *n) {
+            let all_keys: Vec<_> = keys.map(|(_n,k)| k.clone()).collect();
+            grouped_seqs.push((note, all_keys));
+        }
+
+        Some(grouped_seqs)
+    }
+
+    pub fn print_sequences(&self) {
+        for (seq, key) in self.sequences.iter() {
+            for deg in seq {
+                print!("{} ", c_scale_note_name(*deg));
+            }
+            println!("=> {key:?}");
+        }
+    }
+}
+
+pub fn c_scale_note_name(degree: u8) -> String {
+    match degree {
+        0 => "C",
+        1 => "D",
+        2 => "E",
+        3 => "F",
+        4 => "G",
+        5 => "A",
+        6 => "B",
+        _ => "?",
+    }
+    .to_string()
+}
+
+pub fn standard_melodic_mapping() -> Mapping {
+    let modspecial = [
+        Keystroke::Modifier(Modifier::Shift),
+        Keystroke::Special(Special::CapsLock),
+        Keystroke::Special(Special::Backspace),
+    ];
+
+    let alpha = 'a'..='z';
+    let num = '0'..='9';
+    let punct = ".,! \n".chars();
+    let chars = alpha.chain(num).chain(punct).map(|c| Keystroke::Char(c));
+
+    let keys = modspecial.iter().cloned().chain(chars);
+
+    let sequences: Vec<_> = keys
+        .enumerate()
+        .map(|(k, key)| (base_values(k as u32, 7, 2), key))
+        .collect();
+
+    Mapping::new(sequences)
+}
+
+#[derive(Debug, Clone)]
+pub struct TypingState {
+    mapping: Mapping,
+    current: Vec<u8>,
+}
+
+impl TypingState {
+    pub fn new(mapping: Mapping) -> TypingState {
+        TypingState {
+            mapping,
+            current: vec![],
+        }
+    }
+
+    /// Add the value into the typing state.
+    pub fn enter(&mut self, value: u8) {
+        self.current.push(value);
+    }
+
+    /// Attempts to decode the current value stored. It will reset if it's either
+    /// invalid or valid, but will retain the current buffer if it's partial.
+    pub fn emit(&mut self) -> Decoded {
+        let decoded = self.mapping.decode(&self.current);
+
+        if !matches!(decoded, Decoded::Partial(..)) {
+            self.current.clear();
+        }
+
+        decoded
+    }
+
+    pub fn current_notes(&self) -> Vec<u8> {
+        self.current.clone()
+    }
+
+    pub fn mapping(&self) -> &Mapping {
+        &self.mapping
+    }
+}
+
+/// Chunks a u8 into a sequence of values in a given base.
+pub fn base_values(mut x: u32, base: u32, len: usize) -> Vec<u8> {
+    let mut vals = vec![];
+    for _ in 0..len {
+        let digit = x % (base as u32);
+        vals.push(digit as u8);
+        x = x / base;
+    }
+    vals.reverse();
+
+    vals
+}
+
+/// Determines the scale degree of a given MIDI note relative to the provided
+/// scale root.
+pub fn midi_to_scale_degree(root: u8, note: u8) -> Option<u8> {
+    let semitones = (note as i32 - root as i32).rem_euclid(12);
+    Some(match semitones {
+        0 => 0,
+        2 => 1,
+        4 => 2,
+        5 => 3,
+        7 => 4,
+        9 => 5,
+        11 => 6,
+        _ => return None,
+    })
+}
+
+#[derive(Debug, PartialEq, Eq, Hash, Clone, PartialOrd, Ord)]
+pub enum Keystroke {
+    Char(char),
+    Modifier(Modifier),
+    Special(Special),
+}
+
+#[derive(Debug, PartialEq, Eq, Hash, Clone, PartialOrd, Ord)]
+pub enum Modifier {
+    Shift,
+}
+
+#[derive(Debug, PartialEq, Eq, Hash, Clone, PartialOrd, Ord)]
+pub enum Special {
+    CapsLock,
+    Backspace,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn encodes_lowercase() {
+        let mapping = standard_melodic_mapping();
+        assert_eq!(mapping.encode(Keystroke::Char('a')), Some(vec![0, 3]));
+        assert_eq!(mapping.encode(Keystroke::Char('b')), Some(vec![0, 4]));
+        assert_eq!(mapping.encode(Keystroke::Char('z')), Some(vec![4, 0]));
+    }
+
+    #[test]
+    fn encodes_numbers() {
+        let mapping = standard_melodic_mapping();
+        assert_eq!(mapping.encode(Keystroke::Char('0')), Some(vec![4, 1]));
+        assert_eq!(mapping.encode(Keystroke::Char('1')), Some(vec![4, 2]));
+        assert_eq!(mapping.encode(Keystroke::Char('9')), Some(vec![5, 3]));
+    }
+
+    #[test]
+    fn converts_to_scale_degree() {
+        assert_eq!(midi_to_scale_degree(60, 58), None);
+        assert_eq!(midi_to_scale_degree(60, 59), Some(6));
+        assert_eq!(midi_to_scale_degree(60, 60), Some(0));
+        assert_eq!(midi_to_scale_degree(60, 61), None);
+        assert_eq!(midi_to_scale_degree(60, 62), Some(1));
+        assert_eq!(midi_to_scale_degree(60, 63), None);
+        assert_eq!(midi_to_scale_degree(60, 64), Some(2));
+        assert_eq!(midi_to_scale_degree(60, 65), Some(3));
+        assert_eq!(midi_to_scale_degree(60, 66), None);
+        assert_eq!(midi_to_scale_degree(60, 67), Some(4));
+        assert_eq!(midi_to_scale_degree(60, 68), None);
+        assert_eq!(midi_to_scale_degree(60, 69), Some(5));
+        assert_eq!(midi_to_scale_degree(60, 70), None);
+        assert_eq!(midi_to_scale_degree(60, 71), Some(6));
+        assert_eq!(midi_to_scale_degree(60, 72), Some(0));
+        assert_eq!(midi_to_scale_degree(60, 73), None);
+        assert_eq!(midi_to_scale_degree(60, 74), Some(1));
+    }
+}

src/ui.rs

@@ -7,11 +7,15 @@ use std::{
     thread::JoinHandle,
 };
 
+use itertools::Itertools;
 use crossbeam::{channel::Receiver, select};
-use egui::{mutex::Mutex, Color32, Frame, Grid, RichText, Rounding, ScrollArea, SelectableLabel};
+use egui::{mutex::Mutex, Color32, Frame, Grid, RichText, ScrollArea, SelectableLabel};
 use midir::{MidiInput, MidiInputPort};
 
-use crate::midi::{daemon::CTM, Message, ParsedMessage, VoiceCategory, VoiceMessage};
+use crate::{
+    midi::{daemon::CTM, Message, ParsedMessage, VoiceCategory, VoiceMessage},
+    typing::{c_scale_note_name, standard_melodic_mapping, Keystroke, TypingState},
+};
 
 /// State used to display the UI. It's intended to be shared between the
 /// renderer and the daemon which updates the state.
@@ -23,10 +27,16 @@ pub struct DisplayState {
     pub max_messages: usize,
     pub only_note_on_off: Arc<AtomicBool>,
     pub show_raw: Arc<AtomicBool>,
+    pub selected_tab: Tabs,
+    pub melodic_typing_state: Arc<Mutex<TypingState>>,
+    pub scratchpad: String,
 }
 
 impl DisplayState {
     pub fn new() -> DisplayState {
+        let melodic_mapping = standard_melodic_mapping();
+        let melodic_typing_state = TypingState::new(melodic_mapping);
+
         DisplayState {
             midi_input_ports: Arc::new(Mutex::new(vec![])),
             midi_messages: Arc::new(Mutex::new(VecDeque::new())),
@@ -34,6 +44,9 @@ impl DisplayState {
             max_messages: 10_000_usize,
             only_note_on_off: Arc::new(AtomicBool::new(true)),
             show_raw: Arc::new(AtomicBool::new(true)),
+            selected_tab: Tabs::WindSynthTyping,
+            melodic_typing_state: Arc::new(Mutex::new(melodic_typing_state)),
+            scratchpad: String::new(),
         }
     }
 
@@ -112,48 +125,47 @@ pub fn run(state: DisplayState) {
     );
 }
 
+#[derive(Debug, PartialEq, Copy, Clone)]
+pub enum Tabs {
+    Messages,
+    WindSynthTyping,
+}
+
 struct MidiKeysApp {
     midi_in: MidiInput,
+    ports: Vec<MidiInputPort>,
+    messages: Vec<CTM>,
+
     state: DisplayState,
+
+    first_render: bool,
 }
 
 impl MidiKeysApp {
-    fn new(_cc: &eframe::CreationContext<'_>, state: DisplayState) -> Self {
+    fn new(cc: &eframe::CreationContext<'_>, state: DisplayState) -> Self {
-        // this is where to hook in for customizing eguji, like fonts and visuals.
+        // this is where to hook in for customizing egui, like fonts and visuals.
 
         let midi_in: MidiInput =
             MidiInput::new("midi-keys").expect("could not connect to system MIDI");
+        let ports = vec![];
+        let messages = vec![];
 
-        MidiKeysApp { midi_in, state }
+        cc.egui_ctx.set_zoom_factor(1.25);
+
+        MidiKeysApp {
+            midi_in,
+            ports,
+            messages,
+            state,
+            first_render: true,
         }
     }
 
-impl eframe::App for MidiKeysApp {
+    pub fn instrument_panel(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        ctx.set_theme(egui::Theme::Light);
-
-        let ports = self.state.midi_input_ports.lock().clone();
-        let messages = self.state.midi_messages.lock().clone();
-
-        egui::TopBottomPanel::top("menu_bar_panel").show(ctx, |ui| {
-            egui::menu::bar(ui, |ui| {
-                ui.menu_button("File", |ui| {
-                    if ui.button("Quit").clicked() {
-                        ctx.send_viewport_cmd(egui::ViewportCommand::Close);
-                    }
-                });
-                ui.menu_button("Help", |ui| {
-                    if ui.button("About").clicked() {
-                        // TODO: implement something
-                    }
-                });
-            });
-        });
-
         egui::SidePanel::left("instrument_panel").show(ctx, |ui| {
             ui.heading("Connections");
 
-            for port in ports.iter() {
+            for port in self.ports.iter() {
                 let port_name = self
                     .midi_in
                     .port_name(port)
@@ -171,11 +183,15 @@ impl eframe::App for MidiKeysApp {
                 }
             }
         });
+    }
+
+    pub fn messages_tab(&mut self, ctx: &egui::Context, frame: &mut eframe::Frame) {
+        self.instrument_panel(ctx, frame);
 
         let mut only_note_on_off = self.state.only_note_on_off.load(Ordering::Relaxed);
         let mut show_raw = self.state.show_raw.load(Ordering::Relaxed);
 
-        egui::TopBottomPanel::top("filter_panel").show(ctx, |ui| {
+        egui::TopBottomPanel::bottom("filter_panel").show(ctx, |ui| {
             ui.horizontal_wrapped(|ui| {
                 ui.checkbox(&mut only_note_on_off, "Only note on/off");
                 ui.checkbox(&mut show_raw, "Display raw bytes");
@@ -192,7 +208,7 @@ impl eframe::App for MidiKeysApp {
                 .max_width(f32::INFINITY)
                 .show(ui, |ui| {
                     ui.vertical_centered_justified(|ui| {
-                        for (idx, (conn, _ts, msg)) in messages.iter().rev().enumerate() {
+                        for (idx, (conn, _ts, msg)) in self.messages.iter().rev().enumerate() {
                             if only_note_on_off
                                 && !matches!(
                                     &msg.parsed,
@@ -213,7 +229,7 @@ impl eframe::App for MidiKeysApp {
                             {
                                 continue;
                             }
-                            let port = match ports.iter().find(|p| &p.id() == conn) {
+                            let port = match self.ports.iter().find(|p| &p.id() == conn) {
                                 Some(p) => p,
                                 None => continue,
                             };
@@ -222,7 +238,7 @@ impl eframe::App for MidiKeysApp {
                                 .inner_margin(4.0)
                                 .outer_margin(4.0)
                                 .stroke((1.0, Color32::BLACK))
-                                .rounding(Rounding::same(2.0))
+                                .corner_radius(2)
                                 .begin(ui);
 
                             let port_name = self
@@ -241,6 +257,92 @@ impl eframe::App for MidiKeysApp {
                 });
         });
     }
+
+    pub fn typing_tab(&mut self, ctx: &egui::Context, frame: &mut eframe::Frame) {
+        self.instrument_panel(ctx, frame);
+
+        egui::CentralPanel::default().show(ctx, |ui| {
+            let typing_state = self.state.melodic_typing_state.lock();
+            let current_notes = typing_state.current_notes();
+            let options = typing_state.mapping().collated_remaining(&current_notes);
+
+            Grid::new("typing_melodic_grid".to_string()).show(ui, |ui| {
+                ui.label("Current notes:");
+                for note in &current_notes {
+                    ui.label(c_scale_note_name(*note));
+                }
+                ui.end_row();
+            });
+
+            if let Some(options) = options {
+                Grid::new("typing_melodic_options_grid".to_string()).show(ui, |ui| {
+                    for (next_note, keys) in options {
+                        ui.label(c_scale_note_name(next_note));
+                        let keys_disp = keys.iter().map(|k| match k {
+                            Keystroke::Char(' ') => format!("<space>"),
+                            Keystroke::Char('\n') => format!("<newline>"),
+                            Keystroke::Char(c) => format!("{c}"),
+                            Keystroke::Modifier(modifier) => format!("<{modifier:?}>"),
+                            Keystroke::Special(special) => format!("<{special:?}>"),
+                        }).join(", ");
+                        ui.label(format!("{keys_disp}"));
+                        ui.end_row();
+                    }
+                });
+            } else {
+                ui.label("Nothing you can do from here. Sorry.");
+            }
+            ctx.request_repaint();
+        });
+    }
+}
+
+impl eframe::App for MidiKeysApp {
+    fn update(&mut self, ctx: &egui::Context, frame: &mut eframe::Frame) {
+        if self.first_render {
+            let window_size = (1200., 800.).into();
+            ctx.send_viewport_cmd(egui::ViewportCommand::InnerSize(window_size));
+
+            self.first_render = false;
+        }
+
+        ctx.set_theme(egui::Theme::Light);
+
+        self.ports = self.state.midi_input_ports.lock().clone();
+        self.messages = self.state.midi_messages.lock().clone().into();
+
+        egui::TopBottomPanel::top("menu_bar_panel").show(ctx, |ui| {
+            egui::menu::bar(ui, |ui| {
+                ui.menu_button("File", |ui| {
+                    if ui.button("Quit").clicked() {
+                        ctx.send_viewport_cmd(egui::ViewportCommand::Close);
+                    }
+                });
+                ui.menu_button("Help", |ui| {
+                    if ui.button("About").clicked() {
+                        // TODO: implement something
+                    }
+                });
+            });
+        });
+
+        egui::TopBottomPanel::top("tab_selector").show(ctx, |ui| {
+            ui.horizontal_wrapped(|ui| {
+                ui.radio_value(&mut self.state.selected_tab, Tabs::Messages, "Messages");
+                ui.radio_value(
+                    &mut self.state.selected_tab,
+                    Tabs::WindSynthTyping,
+                    "Typing",
+                );
+            });
+        });
+
+        if self.state.selected_tab == Tabs::Messages {
+            self.messages_tab(ctx, frame);
+        } else if self.state.selected_tab == Tabs::WindSynthTyping {
+            self.typing_tab(ctx, frame);
+        }
+    }
 }
 
 fn display_midi_message(idx: usize, msg: &Message, ui: &mut egui::Ui, raw: bool) {
@@ -251,21 +353,21 @@ fn display_midi_message(idx: usize, msg: &Message, ui: &mut egui::Ui, raw: bool)
                     VoiceCategory::NoteOff { note, velocity } => (
                         "NoteOff",
                         vec![
-                            ("note", note_name(note)),
+                            ("note", midi_note_name(note)),
                             ("velocity", format!("{}", velocity)),
                         ],
                     ),
                     VoiceCategory::NoteOn { note, velocity } => (
                         "NoteOn",
                         vec![
-                            ("note", note_name(note)),
+                            ("note", midi_note_name(note)),
                             ("velocity", format!("{}", velocity)),
                         ],
                     ),
                     VoiceCategory::AfterTouch { note, pressure } => (
                         "AfterTouch",
                         vec![
-                            ("note", note_name(note)),
+                            ("note", midi_note_name(note)),
                             ("pressure", format!("{}", pressure)),
                         ],
                     ),
@@ -299,6 +401,7 @@ fn display_midi_message(idx: usize, msg: &Message, ui: &mut egui::Ui, raw: bool)
                 }
             });
         }
+
         ParsedMessage::System(_system_common) => {}
         ParsedMessage::Realtime(_system_realtime) => {}
     }
@@ -306,10 +409,10 @@ fn display_midi_message(idx: usize, msg: &Message, ui: &mut egui::Ui, raw: bool)
     if raw {
         ui.horizontal_top(|ui| {
             ui.label("Bytes:");
-            Frame::none().show(ui, |ui| {
+            Frame::new().show(ui, |ui| {
                 ui.spacing_mut().item_spacing = (0.0, 0.0).into();
                 for byte in &msg.raw {
-                    Frame::none()
+                    Frame::new()
                         .inner_margin(2.0)
                         .stroke((0.5, Color32::GRAY))
                         .outer_margin(0.0)
@@ -322,7 +425,7 @@ fn display_midi_message(idx: usize, msg: &Message, ui: &mut egui::Ui, raw: bool)
     }
 }
 
-fn note_name(midi_note: u8) -> String {
+pub fn midi_note_name(midi_note: u8) -> String {
     let octave = ((midi_note as i32) - 12) / 12;
     let note = match midi_note % 12 {
         0 => "C",
@@ -345,13 +448,13 @@ fn note_name(midi_note: u8) -> String {
 
 #[cfg(test)]
 mod tests {
-    use crate::ui::note_name;
+    use crate::ui::midi_note_name;
 
     #[test]
     pub fn names_of_notes() {
-        assert_eq!(note_name(60), "C4");
+        assert_eq!(midi_note_name(60), "C4");
-        assert_eq!(note_name(36), "C2");
+        assert_eq!(midi_note_name(36), "C2");
-        assert_eq!(note_name(57), "A3");
+        assert_eq!(midi_note_name(57), "A3");
-        assert_eq!(note_name(35), "B1");
+        assert_eq!(midi_note_name(35), "B1");
     }
 }