commit fd3a6d87c4c96530f5bb5923c16a77bb558109c5 Author: Arsen Musayelyan Date: Wed Apr 21 19:29:14 2021 -0700 Initial Commit diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..5a833ec --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +export LD_LIBRARY_PATH="." diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8882a33 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.idea/ +/deepspeech.pbmm +/deepspeech.scorer +/trident +/trident.toml \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -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/Makefile b/Makefile new file mode 100644 index 0000000..071bfb3 --- /dev/null +++ b/Makefile @@ -0,0 +1,13 @@ +all: action.go config.go audio.go logging.go main.go plugins.go + go build + +install: trident trident.example.toml deepspeech.pbmm deepspeech.scorer + rm -rf /opt/trident/ + mkdir -p /opt/trident/ + install -Dm755 trident /opt/trident/trident + cp model.pbmm /opt/trident/ + cp model.scorer /opt/trident/ + cp trident.example.toml /opt/trident/trident.toml + cp -r plugins /opt/trident/ + +.PHONY: all install \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..861c573 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Trident + +Personal voice assistant written in go using DeepSpeech. This was mainly created for personal use, so there may be some edge cases unaccounted for. + +--- + +#### Prerequisites + +The prerequisites for trident are: +- libdeepspeech and DeepSpeech models (speech to text) +- mimic (text to speech) +- go + +`libdeepspeech` along with its models can be found in [its github releases](https://github.com/mozilla/DeepSpeech/releases/). Be sure to download the `native_client` tarball for your platform and the `.pbmm` and `.scorer` files. + +`mimic` can be installed via an [install script](https://github.com/MycroftAI/mycroft-core/blob/dev/scripts/install-mimic.sh) or its AUR package if using Arch Linux or its derivatives. + +### Installation + +Move the previously downloaded models (`.pbmm` and `.scorer`) into this repo as `deepspeech.pbmm` and `deepspeech.scorer`. Then, follow the next steps. + +To build trident, run: +```shell +make +``` +After that, install by running: +```shell +sudo make install +``` + +### Customization + +To change the activation tone, replace the `activate.wav` file with any valid wav file and rebuild. The file will be embedded in the executable via `//go:embed`. + +Trident has a config file called `trident.toml`. It will first look for it in `/trident.toml` (config directory as defined by `os.UserConfigDir()`), then it will look for it in the same directory as the executable. \ No newline at end of file diff --git a/action.go b/action.go new file mode 100644 index 0000000..3d19b9d --- /dev/null +++ b/action.go @@ -0,0 +1,93 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "os" + "regexp" + "strconv" +) + +// Attempt to match function in config to provided string +func getAction(c *Config, tts *string) (*Action, bool) { + // For every action in config + for _, action := range c.Actions { + // Attempt to compile configured regular expression + regex, err := regexp.Compile(action.Phrase) + if err != nil { + return nil, false + } + // Check if string matches action + matched := regex.MatchString(*tts) + if matched { + return &action, true + } + } + return nil, false +} + +// Perform action with input +func performAction(a *Action, tts *string, plugins map[string]pluginFunc) (bool, error) { + // Attempt to compile configured regular expression + regex, err := regexp.Compile(a.Phrase) + if err != nil { + return false, err + } + // Find string submatches in string using regular expression + match := regex.FindStringSubmatch(*tts) + strExpanded := false + // Expand instances of $var in action input + retCmd := os.Expand(a.Input, func(in string) string { + strExpanded = true + // Attempt to convert string to integer + inputInt, err := strconv.Atoi(in) + // If successful + if err == nil { + // If index nonexistent, return empty string + if len(match) <= inputInt { + return "" + } + // Return match at index + return match[inputInt] + } + + // Get subexpression index for input string + subIndex := regex.SubexpIndex(in) + // If regex contains subexpression with specified name and match contains index + if subIndex != -1 && len(match) >= subIndex { + // Return string matched at index + return match[subIndex] + } + // If nothing worked, put variable back + return "$" + in + }) + + // If output remained the same and string was expanded + if a.Input == retCmd && strExpanded { + return false, nil + } + + // If type of action is noop, do nothing and return + if a.Type == "noop" { + return true, nil + } + + // Run plugin with input + plugins[a.Type](retCmd, a.Data) + return true, nil +} diff --git a/activate.wav b/activate.wav new file mode 100644 index 0000000..90b1b8e Binary files /dev/null and b/activate.wav differ diff --git a/audio.go b/audio.go new file mode 100644 index 0000000..2ef3ebd --- /dev/null +++ b/audio.go @@ -0,0 +1,116 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "bytes" + _ "embed" + "encoding/binary" + "errors" + ds "github.com/asticode/go-astideepspeech" + "github.com/gen2brain/malgo" + "github.com/youpy/go-wav" + "io" + "sync" +) + +// Safe stream using mutex to fix race conditions +type SafeStream struct { + sync.Mutex + *ds.Stream +} + +// Convert raw audio to slice of int16 +func convToInt16Slice(r io.Reader) ([]int16, error) { + // Create nil output array + var out []int16 + for { + var sample int16 + // Attempt to read little endian binary from sample into int16 + err := binary.Read(r, binary.LittleEndian, &sample) + switch { + case errors.Is(err, io.EOF): + // If error is EOF, return output with no error + return out, nil + case err != nil: + // If error is something other than EOF, return error + return nil, err + } + // If sample contains audio + if sample != 0 { + // Add it to output + out = append(out, sample) + } + } +} + +//go:embed activate.wav +var activationTone []byte + +// Play activation tone to audio device +func playActivationTone(ctx *malgo.AllocatedContext) error { + // Create new reader for embedded activation tone + buf := bytes.NewReader(activationTone) + + // Create new wav reader for activation tone reader + wavReader := wav.NewReader(buf) + // Get wav file format + format, err := wavReader.Format() + if err != nil { + return err + } + + // Set device configuration options + deviceConfig := malgo.DefaultDeviceConfig(malgo.Playback) + deviceConfig.Playback.Format = malgo.FormatS16 + deviceConfig.Playback.Channels = uint32(format.NumChannels) + deviceConfig.SampleRate = format.SampleRate + deviceConfig.Alsa.NoMMap = 1 + + // Create new channel waiting for completion + done := make(chan bool) + onSamples := func(output, _ []byte, _ uint32) { + // Read as much audio into output as will fit + n, err := io.ReadFull(wavReader, output) + // If error occurred or no bytes read + if err != nil || n == 0 { + // Signal completion + done <- true + } + } + + // Initialize audio device using configuration + device, err := malgo.InitDevice(ctx.Context, deviceConfig, malgo.DeviceCallbacks{ + Data: onSamples, + }) + if err != nil { + return err + } + // Uninitialize at end of function + defer device.Uninit() + + // Start audio device + err = device.Start() + if err != nil { + return err + } + + // Wait for completion signal + <-done + return nil +} diff --git a/config.go b/config.go new file mode 100644 index 0000000..b2b9dea --- /dev/null +++ b/config.go @@ -0,0 +1,96 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "github.com/pelletier/go-toml" + "go/build" + "os" + "path/filepath" + "time" +) + +// Config stores the root of the TOML config +type Config struct { + ActivationPhrase string `toml:"activationPhrase"` + ActivationTime time.Duration `toml:"activationTime"` + IPCEnabled bool `toml:"ipcEnabled"` + Actions []Action `toml:"action"` +} + +// Action stores voice-activated actions in config +type Action struct { + Name string `toml:"name"` + Type string `toml:"type"` + Phrase string `toml:"phrase"` + Input string `toml:"input,omitempty"` + Data map[string]interface{} `toml:"data,omitempty"` +} + +// getConfig parses and returns a TOML config +func getConfig(path string) (*Config, error) { + // Open file at given path + file, err := os.Open(filepath.Clean(path)) + if err != nil { + return nil, err + } + // Create new nil struct + var out Config + // Create new TOML decoder reading from file + dec := toml.NewDecoder(file) + // Decode contents of file to struct + err = dec.Decode(&out) + if err != nil { + return nil, err + } + return &out, nil +} + +// Get all relevant paths +func configEnv() (gopath, configDir, execDir, confPath string) { + // Get path to currently running executable + execPath, err := os.Executable() + if err != nil { + log.Fatal().Err(err).Msg("Error getting executable path") + } + // Get current user's configuration directory + confDir, err := os.UserConfigDir() + if err != nil { + log.Fatal().Err(err).Msg("Error getting config directory") + } + // Try to get GOPATH environment variable + gopath = os.Getenv("GOPATH") + // If not set + if gopath == "" { + // Use default GOPATH + gopath = build.Default.GOPATH + } + // Set configuration directory to /trident + configDir = filepath.Join(confDir, "trident") + // Set executable directory to the directory of execPath + execDir = filepath.Dir(execPath) + // Set config path to file trident.toml inside config directory + confPath = filepath.Join(configDir, "trident.toml") + // If file is not accessible + if _, err := os.Stat(confPath); err != nil { + // Use config in same executable directory + confPath = filepath.Join(execDir, "trident.toml") + } + // Return all variables + return +} \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..c3b87de --- /dev/null +++ b/go.mod @@ -0,0 +1,14 @@ +module trident + +go 1.16 + +require ( + github.com/asticode/go-astideepspeech v0.10.0 + github.com/gen2brain/malgo v0.10.29 + github.com/pelletier/go-toml v1.9.0 + github.com/rs/zerolog v1.21.0 + github.com/spf13/pflag v1.0.5 + github.com/stretchr/testify v1.7.0 // indirect + github.com/traefik/yaegi v0.9.17 + github.com/youpy/go-wav v0.1.0 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..39cf1ae --- /dev/null +++ b/go.sum @@ -0,0 +1,54 @@ +github.com/asticode/go-astideepspeech v0.10.0 h1:iMns9KIFdNrzmR77akHIsNM/qUO4IP6/N/WKX5SZr1o= +github.com/asticode/go-astideepspeech v0.10.0/go.mod h1:SJCkfh5e79BgSQqKEEAtfjZT0yOekjKEiB3FVOTrpog= +github.com/cheekybits/is v0.0.0-20150225183255-68e9c0620927/go.mod h1:h/aW8ynjgkuj+NQRlZcDbAbM1ORAbXjXX77sX7T289U= +github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/cryptix/wav v0.0.0-20180415113528-8bdace674401/go.mod h1:knK8fd+KPlGGqSUWogv1DQzGTwnfUvAi0cIoWyOG7+U= +github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gen2brain/malgo v0.10.29 h1:bTYiUTUKJsEomNby+W0hgyLrOttUXIk4lTEnKA54iqM= +github.com/gen2brain/malgo v0.10.29/go.mod h1:zHSUNZAXfCeNsZou0RtQ6Zk7gDYLIcKOrUWtAdksnEs= +github.com/pelletier/go-toml v1.9.0 h1:NOd0BRdOKpPf0SxkL3HxSQOG7rNh+4kl6PHcBPFs7Q0= +github.com/pelletier/go-toml v1.9.0/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ= +github.com/rs/zerolog v1.21.0 h1:Q3vdXlfLNT+OftyBHsU0Y445MD+8m8axjKgf2si0QcM= +github.com/rs/zerolog v1.21.0/go.mod h1:ZPhntP/xmq1nnND05hhpAh2QMhSsA4UN3MGZ6O2J3hM= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/traefik/yaegi v0.9.17 h1:sJ4Wk6S7HHHXtJnOuxC/3qjdQKRy3q9ZhNP0ZGL7Ltw= +github.com/traefik/yaegi v0.9.17/go.mod h1:FAYnRlZyuVlEkvnkHq3bvJ1lW5be6XuwgLdkYgYG6Lk= +github.com/youpy/go-riff v0.0.0-20131220112943-557d78c11efb h1:RDh7U5Di6o7fblIBe7rVi9KnrcOXUbLwvvLLdP2InSI= +github.com/youpy/go-riff v0.0.0-20131220112943-557d78c11efb/go.mod h1:83nxdDV4Z9RzrTut9losK7ve4hUnxUR8ASSz4BsKXwQ= +github.com/youpy/go-wav v0.1.0 h1:MehxSoflnZoDmiILNQ6WMQpTuRuFpRnq213YqQ7WPRk= +github.com/youpy/go-wav v0.1.0/go.mod h1:ZyTUfNrGKaH/wPNGf2W9Se6sNtZRlY+b98kckKmYLS8= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/logging.go b/logging.go new file mode 100644 index 0000000..0d5db03 --- /dev/null +++ b/logging.go @@ -0,0 +1,27 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "github.com/rs/zerolog" + zlog "github.com/rs/zerolog/log" + "os" +) + +// Set global logger to zerolog +var log = zlog.Output(zerolog.ConsoleWriter{Out: os.Stderr}) diff --git a/main.go b/main.go new file mode 100644 index 0000000..a2386d9 --- /dev/null +++ b/main.go @@ -0,0 +1,327 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "bufio" + "bytes" + ds "github.com/asticode/go-astideepspeech" + "github.com/gen2brain/malgo" + flag "github.com/spf13/pflag" + "net" + "os" + "os/signal" + "path/filepath" + "strconv" + "strings" + "syscall" + "time" +) + +var verbose *bool +var execDir string +var configDir string + +func main() { + // Configure environment (paths to resources) + var gopath, confPath string + gopath, configDir, execDir, confPath = configEnv() + + // Define and parse command line flags + tfLogLevel := flag.Int("tf-log-level", 2, "Log level for TensorFlow") + verbose = flag.BoolP("verbose", "v", false, "Log more events") + configPath := flag.StringP("config", "c", confPath, "Location of trident TOML config") + modelPath := flag.StringP("model", "m", filepath.Join(execDir, "deepspeech.pbmm"), "Path to DeepSpeech model") + scorerPath := flag.StringP("scorer", "s", filepath.Join(execDir, "deepspeech.scorer"), "Path to DeepSpeech scorer") + socketPath := flag.StringP("socket", "S", filepath.Join(configDir, "trident.sock"), "Path to UNIX socket for IPC") + GOPATH := flag.String("gopath", gopath, "GOPATH for use with plugins") + flag.Parse() + + // Set TensorFlow log level to specified level (default 2) + _ = os.Setenv("TF_CPP_MIN_LOG_LEVEL", strconv.Itoa(*tfLogLevel)) + + // Get and parse TOML config + config, err := getConfig(*configPath) + if err != nil { + log.Fatal().Err(err).Msg("Error getting TOML config") + } + + // Create new channel storing os.Signal + sigChannel := make(chan os.Signal, 1) + // Notify channel upon reception of specified signals + signal.Notify(sigChannel, + syscall.SIGINT, + syscall.SIGTERM, + syscall.SIGHUP, + syscall.SIGQUIT, + ) + // Create new goroutine to handle signals gracefully + go func() { + // Wait for signal + sig := <-sigChannel + // Log reception of signal + log.Info().Str("signal", sig.String()).Msg("Received signal, shutting down") + // If IPC is enabled in the config, remove the UNIX socket + if config.IPCEnabled { + _ = os.RemoveAll(*socketPath) + } + // Exit with code 0 + os.Exit(0) + }() + + // Create new DeepSpeech model + model, err := ds.New(*modelPath) + if err != nil { + log.Fatal().Err(err).Msg("Error opening DeepSpeech model") + } + + //model.SetBeamWidth(50) + + // Initialize available plugins + plugins := initPlugins(*GOPATH) + + // If IPC is enabled in config + if config.IPCEnabled { + // Remove UNIX socket ignoring error + _ = os.RemoveAll(*socketPath) + // Listen on UNIX socket + ln, err := net.Listen("unix", *socketPath) + if err != nil { + log.Fatal().Err(err).Msg("Error listening on UNIX socket") + } + go func() { + for { + // Accept any connection when it arrives + conn, err := ln.Accept() + if err != nil { + log.Fatal().Err(err).Msg("Error accepting connection") + } + go func(conn net.Conn) { + // Close connection at end of function + defer conn.Close() + // Create new scanner for connection (default is ScanLines) + scanner := bufio.NewScanner(conn) + // Scan until EOF + for scanner.Scan() { + // If error encountered, return from function + if scanner.Err() != nil { + return + } + // Get text from scanner + input := scanner.Text() + // Attempt to match text to action and return action + action, ok := getAction(config, &input) + // If match founc + if ok { + // Log performing action + log.Info().Str("action", action.Name).Str("source", "socket").Msg("Performing action") + // Perform returned action + done, err := performAction(action, &input, plugins) + if err != nil { + log.Warn().Err(err).Str("action", action.Name).Msg("Error performing configured action") + } + // If action complete, close connection and return + if done { + conn.Close() + return + } + } + } + }(conn) + } + }() + } + + // Initialize audio context + ctx, err := malgo.InitContext(nil, malgo.ContextConfig{}, func(message string) { + log.Warn().Msg(message) + }) + if err != nil { + log.Fatal().Err(err).Msg("Error initializing malgo context") + } + // Uninitialize and free at end of function + defer func() { + _ = ctx.Uninit() + ctx.Free() + }() + + // Set device configuration options + deviceConfig := malgo.DefaultDeviceConfig(malgo.Capture) + deviceConfig.Capture.Format = malgo.FormatS16 + deviceConfig.Capture.Channels = 1 + deviceConfig.Playback.Format = malgo.FormatS16 + deviceConfig.Playback.Channels = 1 + deviceConfig.SampleRate = uint32(model.SampleRate()) + deviceConfig.Alsa.NoMMap = 1 + + // Create new buffer to store audio samples + captured := &bytes.Buffer{} + onRecvFrames := func(_, sample []byte, _ uint32) { + // Upon receipt of sample, write to buffer + captured.Write(sample) + } + log.Info().Msg("Listening to audio events") + // Initialize audio device using configuration options + device, err := malgo.InitDevice(ctx.Context, deviceConfig, malgo.DeviceCallbacks{ + Data: onRecvFrames, + }) + if err != nil { + log.Fatal().Err(err).Msg("Error initializing audio device") + } + // Uninitialize at end of function + defer device.Uninit() + + // Start capture device (begin recording) + err = device.Start() + if err != nil { + log.Fatal().Err(err).Msg("Error starting capture device") + } + + // Set DeepSpeech scorer + err = model.EnableExternalScorer(*scorerPath) + if err != nil { + log.Fatal().Err(err).Msg("Error opening DeepSpeech scorer") + } + + // Create new stream for DeepSpeech model + sttStream, err := model.NewStream() + if err != nil { + log.Fatal().Err(err).Msg("Error creating DeepSpeech stream") + } + // Create a safe stream using sync.Mutex + safeStream := &SafeStream{Stream: sttStream} + + // Create goroutine to clean stream every minute + go func() { + for { + time.Sleep(time.Minute) + // Lock mutex of stream + safeStream.Lock() + // Reset stream and buffer + resetStream(safeStream, model, captured) + if *verbose { + log.Debug().Msg("1m passed; cleaning stream") + } + // Unlock mutex of stream + safeStream.Unlock() + } + }() + + var tts string + listenForActivation := true + for { + time.Sleep(time.Second) + // Convert captured raw audio to slice of int16 + slice, err := convToInt16Slice(captured) + if err != nil { + log.Fatal().Err(err).Msg("Error converting captured audio feed") + } + // Reset buffer + captured.Reset() + // Lock mutex of stream + safeStream.Lock() + // Feed converted audio to stream + safeStream.FeedAudioContent(slice) + // Decode stream without destroying + tts, err = safeStream.IntermediateDecode() + if err != nil { + log.Fatal().Err(err).Msg("Error intermediate decoding stream") + } + // If decoded string contains activation phrase and listenForActivation is true + if strings.Contains(tts, config.ActivationPhrase) && listenForActivation { + // Play activation tone + err = playActivationTone(ctx) + if err != nil { + log.Fatal().Err(err).Msg("Error playing activation tone") + } + // Log detection of activation phrase + log.Info().Msg("Activation phrase detected") + // Reset stream and buffer + resetStream(safeStream, model, captured) + // Create new goroutine to listen for commands + go func() { + // Disable activation + listenForActivation = false + // Enable activation at end of function + defer func() { + listenForActivation = true + }() + // Create timeout channel to trigger after configured time + timeout := time.After(config.ActivationTime) + activationLoop: + for { + time.Sleep(100 * time.Millisecond) + select { + // If timeout has elapsed + case <-timeout: + log.Warn().Msg("Unknown command") + break activationLoop + // If timeout has not elapsed + default: + // Attempt to match decoded string to action + action, ok := getAction(config, &tts) + // If match found + if ok { + // Keep listening if user is talking + for { + // Get length of text to speech string + ttsLen := len(tts) + time.Sleep(time.Second) + // If length has not changed + if ttsLen == len(tts) { + // Break out of for loop + break + } + } + // Log performing action + log.Info().Str("action", action.Name).Str("source", "voice").Msg("Performing action") + // Perform action matched by getAction() + done, err := performAction(action, &tts, plugins) + if err != nil { + log.Warn().Err(err).Str("action", action.Name).Msg("Error performing configured action") + } + // If action is complete + if done { + // Lock mutex of stream + safeStream.Lock() + // Reset stream and buffer + resetStream(safeStream, model, captured) + // Unlock mutex of stream + safeStream.Unlock() + // Return from goroutine + return + } + } + } + } + }() + } + // Unlock mutex of stream + safeStream.Unlock() + } +} + +// Function to reset stream and buffer +func resetStream(s *SafeStream, model *ds.Model, captured *bytes.Buffer) { + // Reset buffer + captured.Reset() + // Discard stream (workaround for lack of Clear function) + s.Discard() + // Create new stream, setting it to same location as old + s.Stream, _ = model.NewStream() +} diff --git a/plugins.go b/plugins.go new file mode 100644 index 0000000..06b29b5 --- /dev/null +++ b/plugins.go @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "fmt" + "github.com/traefik/yaegi/interp" + "github.com/traefik/yaegi/stdlib" + "github.com/traefik/yaegi/stdlib/unrestricted" + "io/fs" + "path/filepath" +) + +// Create type for plugin functions +type pluginFunc func(string, map[string]interface{}) + +// Initialize all available plugins +func initPlugins(gopath string) map[string]pluginFunc { + log.Info().Msg("Initializing plugins") + out := map[string]pluginFunc{} + + // Create new yaegi Go interpreter with appropriate GOPATH + i := interp.New(interp.Options{GoPath: gopath}) + // Use standard library symbols + i.Use(stdlib.Symbols) + // Use unrestricted symbols (os/exec, syscall, etc.) + i.Use(unrestricted.Symbols) + // Use custom package + i.Use(tridentSymbols) + + // Walk plugin directory + err := filepath.WalkDir(filepath.Join(execDir, "plugins"), func(path string, d fs.DirEntry, err error) error { + // If error encountered, return + if err != nil { + return err + } + // If current path is not a directory or it is the plugin root + if !d.IsDir() || d.Name() == "plugins" { + return nil + } + + // Get name of plugin from directory name + pluginName := filepath.Base(path) + // IF plugin already exists, return error + if _, ok := out[pluginName]; ok { + return fmt.Errorf("plugin %s has already been initialized", pluginName) + } + // If verbose, log which plugin is being initialized + if *verbose { + log.Debug().Str("plugin", pluginName).Msg("Initializing plugin") + } + // Walk directory of specific plugin + err = filepath.WalkDir(path, func(path string, d fs.DirEntry, err error) error { + // If error encountered, return + if err != nil { + return err + } + // If file is not go source, skip + if filepath.Ext(path) != ".go" { + return nil + } + // Evaluate go file + _, err = i.EvalPath(path) + if err != nil { + return err + } + return nil + }) + // If error encountered walking plugin, return + if err != nil { + return err + } + // Get RunPlugin symbol from current plugin + v, err := i.Eval(fmt.Sprintf("%s.RunPlugin", pluginName)) + if err != nil { + return err + } + // Assert RunPlugin symbol as a plugin function and add it to out map + out[pluginName] = v.Interface().(func(string, map[string]interface{})) + return nil + }) + // If error occurred walking directory, log fatally + if err != nil { + log.Fatal().Err(err).Msg("Error initializing plugins") + } + return out +} + diff --git a/plugins/shell/shell.go b/plugins/shell/shell.go new file mode 100644 index 0000000..44d994c --- /dev/null +++ b/plugins/shell/shell.go @@ -0,0 +1,44 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +// shell is a Trident plugin that runs a command in a shell +package shell + +import ( + "os" + "os/exec" +) + +func RunPlugin(program string, data map[string]interface{}) { + var shell string + var ok bool + // Attempt to get shell from config, asserting as string + shell, ok = data["shell"].(string) + // If unsuccessful + if !ok { + // Set shell to default (/bin/sh) + shell = "/bin/sh" + } + // Create command using configured shell or default (/bin/sh) + cmd := exec.Command(shell, "-c", program) + // Set command environment to system environment + cmd.Env = os.Environ() + // Set command's standard error to system standard error + cmd.Stderr = os.Stderr + // Run command, ignoring error + _ = cmd.Run() +} diff --git a/plugins/time/time.go b/plugins/time/time.go new file mode 100644 index 0000000..327171e --- /dev/null +++ b/plugins/time/time.go @@ -0,0 +1,31 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +// time is a Trident plugin that says the current time using a synthesized voice +package time + +import ( + "time" + "trident" +) + +func RunPlugin(_ string, _ map[string]interface{}) { + // Format time in a way the synthesized voice will understand + formattedTime := time.Now().Format("3 04 PM") + // Say formatted time using voice + trident.Say(formattedTime) +} diff --git a/plugins/wolframalpha/wolframalpha.go b/plugins/wolframalpha/wolframalpha.go new file mode 100644 index 0000000..fa57281 --- /dev/null +++ b/plugins/wolframalpha/wolframalpha.go @@ -0,0 +1,90 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +// wolframalpha is a Trident plugin that queries the WolframAlpha API and says the result +package wolframalpha + +import ( + "encoding/xml" + "fmt" + "log" + "net/http" + "net/url" + "strings" + "trident" +) + +// Result stores the result of the WolframAlpha query +type Result struct { + Pods []Pod `xml:"pod"` +} + +// Pod stores pod tags from result +type Pod struct { + XMLName xml.Name `xml:"pod"` + ID string `xml:"id,attr"` + SubPods []SubPod `xml:"subpod"` +} + +// SubPod stores subpod tags from pod +type SubPod struct { + XMLName xml.Name `xml:"subpod,omitempty"` + Plaintext *Plaintext `xml:"plaintext,omitempty"` +} + +// Plaintext stores plaintext tags from subpod +type Plaintext struct { + XMLName xml.Name `xml:"plaintext"` + String string `xml:",chardata"` +} + +func RunPlugin(query string, data map[string]interface{}) { + // Escape query for inclusion in URL + escapedQuery := url.QueryEscape(query) + // Query WolframAlpha API + res, err := http.Get(fmt.Sprintf("https://api.wolframalpha.com/v2/query?input=%s&appid=%s", escapedQuery, data["appid"].(string))) + if err != nil { + log.Fatalln(err) + } + // Close response body at end of function + defer res.Body.Close() + // Create new nil struct to store query results + var resStruct Result + // Create new XML decoder reading from API response body + dec := xml.NewDecoder(res.Body) + // Decode contents of response body into struct + err = dec.Decode(&resStruct) + if err != nil { + log.Fatalln(err) + } + + // Create string builder to combine results + all := strings.Builder{} + for _, pod := range resStruct.Pods { + switch pod.ID { + case "Result", "RealSolution", "Solution": + // If pod ID is one of the above cases, write it to builder + all.WriteString(pod.ID) + for _, subpod := range pod.SubPods { + // Write string from subpod plaintext tag to builder + all.WriteString(subpod.Plaintext.String) + } + } + } + // Use voice to say built string + trident.Say(all.String()) +} diff --git a/symbols.go b/symbols.go new file mode 100644 index 0000000..ab2ccfb --- /dev/null +++ b/symbols.go @@ -0,0 +1,45 @@ +/* + * Copyright (C) 2021 Arsen Musayelyan + * + * 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 . + */ + +package main + +import ( + "github.com/traefik/yaegi/interp" + "os/exec" + "reflect" +) + +// Create custom package for trident +var tridentSymbols = interp.Exports{"trident": { + "Say": reflect.ValueOf(Say), +}} + +// Function to say text using mimic text-to-speech +func Say(text string, args ...string) { + // If mimic exists in PATH + if _, err := exec.LookPath("mimic"); err == nil { + // Set initial argument slice to contain text + argSlice := []string{"-t", text} + // Add any additional arguments to slice + argSlice = append(argSlice, args...) + // Create and run command + exec.Command("mimic", argSlice...).Run() + } else { + // If mimic does not exist in PATH, warn user + log.Warn().Err(err).Str("text", text).Msg("Cannot perform text to speech") + } +} \ No newline at end of file diff --git a/trident.example.toml b/trident.example.toml new file mode 100644 index 0000000..812ef82 --- /dev/null +++ b/trident.example.toml @@ -0,0 +1,26 @@ +activationPhrase = "trident" +activationTime = "10s" +ipcEnabled = true + +[[action]] +name = "dismiss" +type = "noop" +phrase = "dismiss" + +[[action]] +name = "open" +type = "shell" +phrase = "open (?P.+)" +input = "$program" + +[[action]] +name = "time" +type = "time" +phrase = "what time is it|what is the time" + +[[action]] +name = "ask" +type = "wolframalpha" +phrase = "calculate (?P.+)" +input = '$question' +data = {"appid" = "someWolframAlphaAppID"} \ No newline at end of file