diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000000..f288702d2fa --- /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/README.md b/README.md new file mode 100644 index 00000000000..9a65a382a84 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +![Image](pics/dialer.jpg) + +[Original Link](https://github.com/litui/dtmf_dolphin) + +## DTMF Dolphin + +DTMF (Dual-Tone Multi-Frequency) dialer, Bluebox, and Redbox. + +Now in a release-ready state for both Dialer, Bluebox, and Redbox (US/UK) functionality! + +Please note that using the current tone output method, the 2600 tone is scaled about 33 Hz higher than it should be. This is a limitation of the current sample rate. + +### Educational Links: + +* http://www.phrack.org/issues/25/7.html#article +* https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling +* https://en.wikipedia.org/wiki/Blue_box +* https://en.wikipedia.org/wiki/Red_box_(phreaking) diff --git a/application.fam b/application.fam new file mode 100644 index 00000000000..5f01bc9a07e --- /dev/null +++ b/application.fam @@ -0,0 +1,18 @@ +App( + appid="dtmf_dolphin", + name="DTMF Dolphin", + apptype=FlipperAppType.EXTERNAL, + entry_point="dtmf_dolphin_app", + requires=[ + "storage", + "gui", + "dialogs", + ], + fap_icon="phone.png", + stack_size=8 * 1024, + order=20, + fap_category="Tools", + fap_author="@litui & @xMasterX", + fap_version="1.0", + fap_description="DTMF (Dual-Tone Multi-Frequency) dialer, Bluebox, and Redbox.", +) diff --git a/dtmf_dolphin.c b/dtmf_dolphin.c new file mode 100644 index 00000000000..c1b10defa23 --- /dev/null +++ b/dtmf_dolphin.c @@ -0,0 +1,89 @@ +#include "dtmf_dolphin_i.h" + +#include +#include + +static bool dtmf_dolphin_app_custom_event_callback(void* context, uint32_t event) { + furi_assert(context); + DTMFDolphinApp* app = context; + return scene_manager_handle_custom_event(app->scene_manager, event); +} + +static bool dtmf_dolphin_app_back_event_callback(void* context) { + furi_assert(context); + DTMFDolphinApp* app = context; + return scene_manager_handle_back_event(app->scene_manager); +} + +static void dtmf_dolphin_app_tick_event_callback(void* context) { + furi_assert(context); + DTMFDolphinApp* app = context; + + scene_manager_handle_tick_event(app->scene_manager); +} + +static DTMFDolphinApp* app_alloc() { + DTMFDolphinApp* app = malloc(sizeof(DTMFDolphinApp)); + + app->gui = furi_record_open(RECORD_GUI); + app->view_dispatcher = view_dispatcher_alloc(); + app->scene_manager = scene_manager_alloc(&dtmf_dolphin_scene_handlers, app); + view_dispatcher_enable_queue(app->view_dispatcher); + view_dispatcher_set_event_callback_context(app->view_dispatcher, app); + + view_dispatcher_set_custom_event_callback( + app->view_dispatcher, dtmf_dolphin_app_custom_event_callback); + view_dispatcher_set_navigation_event_callback( + app->view_dispatcher, dtmf_dolphin_app_back_event_callback); + view_dispatcher_set_tick_event_callback( + app->view_dispatcher, dtmf_dolphin_app_tick_event_callback, 100); + + view_dispatcher_attach_to_gui(app->view_dispatcher, app->gui, ViewDispatcherTypeFullscreen); + + app->main_menu_list = variable_item_list_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, + DTMFDolphinViewMainMenu, + variable_item_list_get_view(app->main_menu_list)); + + app->dtmf_dolphin_dialer = dtmf_dolphin_dialer_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, + DTMFDolphinViewDialer, + dtmf_dolphin_dialer_get_view(app->dtmf_dolphin_dialer)); + + app->notification = furi_record_open(RECORD_NOTIFICATION); + notification_message(app->notification, &sequence_display_backlight_enforce_on); + + scene_manager_next_scene(app->scene_manager, DTMFDolphinSceneStart); + + return app; +} + +static void app_free(DTMFDolphinApp* app) { + furi_assert(app); + view_dispatcher_remove_view(app->view_dispatcher, DTMFDolphinViewMainMenu); + view_dispatcher_remove_view(app->view_dispatcher, DTMFDolphinViewDialer); + variable_item_list_free(app->main_menu_list); + + dtmf_dolphin_dialer_free(app->dtmf_dolphin_dialer); + + view_dispatcher_free(app->view_dispatcher); + scene_manager_free(app->scene_manager); + + notification_message(app->notification, &sequence_display_backlight_enforce_auto); + + furi_record_close(RECORD_GUI); + furi_record_close(RECORD_NOTIFICATION); + free(app); +} + +int32_t dtmf_dolphin_app(void* p) { + UNUSED(p); + DTMFDolphinApp* app = app_alloc(); + + view_dispatcher_run(app->view_dispatcher); + + app_free(app); + return 0; +} \ No newline at end of file diff --git a/dtmf_dolphin_audio.c b/dtmf_dolphin_audio.c new file mode 100644 index 00000000000..66d17bc2e7d --- /dev/null +++ b/dtmf_dolphin_audio.c @@ -0,0 +1,270 @@ +#include "dtmf_dolphin_audio.h" + +DTMFDolphinAudio* current_player; + +static void dtmf_dolphin_audio_dma_isr(void* ctx) { + FuriMessageQueue* event_queue = ctx; + + if(LL_DMA_IsActiveFlag_HT1(DMA1)) { + LL_DMA_ClearFlag_HT1(DMA1); + + DTMFDolphinCustomEvent event = {.type = DTMFDolphinEventDMAHalfTransfer}; + furi_message_queue_put(event_queue, &event, 0); + } + + if(LL_DMA_IsActiveFlag_TC1(DMA1)) { + LL_DMA_ClearFlag_TC1(DMA1); + + DTMFDolphinCustomEvent event = {.type = DTMFDolphinEventDMAFullTransfer}; + furi_message_queue_put(event_queue, &event, 0); + } +} + +void dtmf_dolphin_audio_clear_samples(DTMFDolphinAudio* player) { + for(size_t i = 0; i < player->buffer_length; i++) { + player->sample_buffer[i] = 0; + } +} + +DTMFDolphinOsc* dtmf_dolphin_osc_alloc() { + DTMFDolphinOsc* osc = malloc(sizeof(DTMFDolphinOsc)); + osc->cached_freq = 0; + osc->offset = 0; + osc->period = 0; + osc->lookup_table = NULL; + return osc; +} + +DTMFDolphinPulseFilter* dtmf_dolphin_pulse_filter_alloc() { + DTMFDolphinPulseFilter* pf = malloc(sizeof(DTMFDolphinPulseFilter)); + pf->duration = 0; + pf->period = 0; + pf->offset = 0; + pf->lookup_table = NULL; + return pf; +} + +DTMFDolphinAudio* dtmf_dolphin_audio_alloc() { + DTMFDolphinAudio* player = malloc(sizeof(DTMFDolphinAudio)); + player->buffer_length = SAMPLE_BUFFER_LENGTH; + player->half_buffer_length = SAMPLE_BUFFER_LENGTH / 2; + player->sample_buffer = malloc(sizeof(uint16_t) * player->buffer_length); + player->osc1 = dtmf_dolphin_osc_alloc(); + player->osc2 = dtmf_dolphin_osc_alloc(); + player->volume = 1.0f; + player->queue = furi_message_queue_alloc(10, sizeof(DTMFDolphinCustomEvent)); + player->filter = dtmf_dolphin_pulse_filter_alloc(); + player->playing = false; + dtmf_dolphin_audio_clear_samples(player); + + return player; +} + +size_t calc_waveform_period(float freq) { + if(!freq) { + return 0; + } + // DMA Rate calculation, thanks to Dr_Zlo + float dma_rate = CPU_CLOCK_FREQ / 2 / DTMF_DOLPHIN_HAL_DMA_PRESCALER / + (DTMF_DOLPHIN_HAL_DMA_AUTORELOAD + 1); + + // Using a constant scaling modifier, which likely represents + // the combined system overhead and isr latency. + return (uint16_t)dma_rate * 2 / freq * 0.801923; +} + +void osc_generate_lookup_table(DTMFDolphinOsc* osc, float freq) { + if(osc->lookup_table != NULL) { + free(osc->lookup_table); + } + osc->offset = 0; + osc->cached_freq = freq; + osc->period = calc_waveform_period(freq); + if(!osc->period) { + osc->lookup_table = NULL; + return; + } + osc->lookup_table = malloc(sizeof(float) * osc->period); + + for(size_t i = 0; i < osc->period; i++) { + osc->lookup_table[i] = sin(i * PERIOD_2_PI / osc->period) + 1; + } +} + +void filter_generate_lookup_table( + DTMFDolphinPulseFilter* pf, + uint16_t pulses, + uint16_t pulse_ms, + uint16_t gap_ms) { + if(pf->lookup_table != NULL) { + free(pf->lookup_table); + } + pf->offset = 0; + + uint16_t gap_period = calc_waveform_period(1000 / (float)gap_ms); + uint16_t pulse_period = calc_waveform_period(1000 / (float)pulse_ms); + pf->period = pulse_period + gap_period; + + if(!pf->period) { + pf->lookup_table = NULL; + return; + } + pf->duration = pf->period * pulses; + pf->lookup_table = malloc(sizeof(bool) * pf->duration); + + for(size_t i = 0; i < pf->duration; i++) { + pf->lookup_table[i] = i % pf->period < pulse_period; + } +} + +float sample_frame(DTMFDolphinOsc* osc) { + float frame = 0.0; + + if(osc->period) { + frame = osc->lookup_table[osc->offset]; + osc->offset = (osc->offset + 1) % osc->period; + } + + return frame; +} + +bool sample_filter(DTMFDolphinPulseFilter* pf) { + bool frame = true; + + if(pf->duration) { + if(pf->offset < pf->duration) { + frame = pf->lookup_table[pf->offset]; + pf->offset = pf->offset + 1; + } else { + frame = false; + } + } + + return frame; +} + +void dtmf_dolphin_osc_free(DTMFDolphinOsc* osc) { + if(osc->lookup_table != NULL) { + free(osc->lookup_table); + } + free(osc); +} + +void dtmf_dolphin_filter_free(DTMFDolphinPulseFilter* pf) { + if(pf->lookup_table != NULL) { + free(pf->lookup_table); + } + free(pf); +} + +void dtmf_dolphin_audio_free(DTMFDolphinAudio* player) { + furi_message_queue_free(player->queue); + dtmf_dolphin_osc_free(player->osc1); + dtmf_dolphin_osc_free(player->osc2); + dtmf_dolphin_filter_free(player->filter); + free(player->sample_buffer); + free(player); + current_player = NULL; +} + +bool generate_waveform(DTMFDolphinAudio* player, uint16_t buffer_index) { + uint16_t* sample_buffer_start = &player->sample_buffer[buffer_index]; + + for(size_t i = 0; i < player->half_buffer_length; i++) { + float data = 0; + if(player->osc2->period) { + data = (sample_frame(player->osc1) / 2) + (sample_frame(player->osc2) / 2); + } else { + data = (sample_frame(player->osc1)); + } + data *= sample_filter(player->filter) ? player->volume : 0.0; + data *= UINT8_MAX / 2; // scale -128..127 + data += UINT8_MAX / 2; // to unsigned + + if(data < 0) { + data = 0; + } + + if(data > 255) { + data = 255; + } + + sample_buffer_start[i] = data; + } + + return true; +} + +bool dtmf_dolphin_audio_play_tones( + float freq1, + float freq2, + uint16_t pulses, + uint16_t pulse_ms, + uint16_t gap_ms) { + if(current_player != NULL && current_player->playing) { + // Cannot start playing while still playing something else + return false; + } + current_player = dtmf_dolphin_audio_alloc(); + + osc_generate_lookup_table(current_player->osc1, freq1); + osc_generate_lookup_table(current_player->osc2, freq2); + filter_generate_lookup_table(current_player->filter, pulses, pulse_ms, gap_ms); + + generate_waveform(current_player, 0); + generate_waveform(current_player, current_player->half_buffer_length); + + dtmf_dolphin_dma_init((uint32_t)current_player->sample_buffer, current_player->buffer_length); + + furi_hal_interrupt_set_isr( + FuriHalInterruptIdDma1Ch1, dtmf_dolphin_audio_dma_isr, current_player->queue); + if(furi_hal_speaker_acquire(1000)) { + dtmf_dolphin_speaker_init(); + dtmf_dolphin_dma_start(); + dtmf_dolphin_speaker_start(); + current_player->playing = true; + return true; + } else { + current_player->playing = false; + return false; + } +} + +bool dtmf_dolphin_audio_stop_tones() { + if(current_player != NULL && !current_player->playing) { + // Can't stop a player that isn't playing. + return false; + } + while(current_player->filter->offset > 0 && + current_player->filter->offset < current_player->filter->duration) { + // run remaining ticks if needed to complete filter sequence + dtmf_dolphin_audio_handle_tick(); + } + dtmf_dolphin_speaker_stop(); + dtmf_dolphin_dma_stop(); + furi_hal_speaker_release(); + + furi_hal_interrupt_set_isr(FuriHalInterruptIdDma1Ch1, NULL, NULL); + + dtmf_dolphin_audio_free(current_player); + + return true; +} + +bool dtmf_dolphin_audio_handle_tick() { + bool handled = false; + + if(current_player) { + DTMFDolphinCustomEvent event; + if(furi_message_queue_get(current_player->queue, &event, 250) == FuriStatusOk) { + if(event.type == DTMFDolphinEventDMAHalfTransfer) { + generate_waveform(current_player, 0); + handled = true; + } else if(event.type == DTMFDolphinEventDMAFullTransfer) { + generate_waveform(current_player, current_player->half_buffer_length); + handled = true; + } + } + } + return handled; +} \ No newline at end of file diff --git a/dtmf_dolphin_audio.h b/dtmf_dolphin_audio.h new file mode 100644 index 00000000000..2dd1d6eb6ec --- /dev/null +++ b/dtmf_dolphin_audio.h @@ -0,0 +1,54 @@ +#pragma once +// #include "dtmf_dolphin_i.h" +#include "dtmf_dolphin_event.h" +#include "dtmf_dolphin_hal.h" + +#define SAMPLE_BUFFER_LENGTH 8192 +#define PERIOD_2_PI 6.2832 +#define CPU_CLOCK_FREQ 64000000 + +typedef struct { + float cached_freq; + size_t period; + float* lookup_table; + uint16_t offset; +} DTMFDolphinOsc; + +typedef struct { + float duration; + size_t period; + bool* lookup_table; + uint16_t offset; +} DTMFDolphinPulseFilter; + +typedef struct { + size_t buffer_length; + size_t half_buffer_length; + uint8_t* buffer_buffer; + uint16_t* sample_buffer; + float volume; + FuriMessageQueue* queue; + DTMFDolphinOsc* osc1; + DTMFDolphinOsc* osc2; + DTMFDolphinPulseFilter* filter; + bool playing; +} DTMFDolphinAudio; + +DTMFDolphinOsc* dtmf_dolphin_osc_alloc(); + +DTMFDolphinAudio* dtmf_dolphin_audio_alloc(); + +void dtmf_dolphin_audio_free(DTMFDolphinAudio* player); + +void dtmf_dolphin_osc_free(DTMFDolphinOsc* osc); + +bool dtmf_dolphin_audio_play_tones( + float freq1, + float freq2, + uint16_t pulses, + uint16_t pulse_ms, + uint16_t gap_ms); + +bool dtmf_dolphin_audio_stop_tones(); + +bool dtmf_dolphin_audio_handle_tick(); diff --git a/dtmf_dolphin_data.c b/dtmf_dolphin_data.c new file mode 100644 index 00000000000..72386b83d66 --- /dev/null +++ b/dtmf_dolphin_data.c @@ -0,0 +1,220 @@ +#include "dtmf_dolphin_data.h" + +typedef struct { + const uint8_t row; + const uint8_t col; + const uint8_t span; +} DTMFDolphinTonePos; + +typedef struct { + const char* name; + const float frequency_1; + const float frequency_2; + const DTMFDolphinTonePos pos; + const uint16_t pulses; // for Redbox + const uint16_t pulse_ms; // for Redbox + const uint16_t gap_duration; // for Redbox +} DTMFDolphinTones; + +typedef struct { + const char* name; + DTMFDolphinToneSection block; + uint8_t tone_count; + DTMFDolphinTones tones[DTMF_DOLPHIN_MAX_TONE_COUNT]; +} DTMFDolphinSceneData; + +DTMFDolphinSceneData DTMFDolphinSceneDataDialer = { + .name = "Dialer", + .block = DTMF_DOLPHIN_TONE_BLOCK_DIALER, + .tone_count = 16, + .tones = { + {"1", 697.0, 1209.0, {0, 0, 1}, 0, 0, 0}, + {"2", 697.0, 1336.0, {0, 1, 1}, 0, 0, 0}, + {"3", 697.0, 1477.0, {0, 2, 1}, 0, 0, 0}, + {"A", 697.0, 1633.0, {0, 3, 1}, 0, 0, 0}, + {"4", 770.0, 1209.0, {1, 0, 1}, 0, 0, 0}, + {"5", 770.0, 1336.0, {1, 1, 1}, 0, 0, 0}, + {"6", 770.0, 1477.0, {1, 2, 1}, 0, 0, 0}, + {"B", 770.0, 1633.0, {1, 3, 1}, 0, 0, 0}, + {"7", 852.0, 1209.0, {2, 0, 1}, 0, 0, 0}, + {"8", 852.0, 1336.0, {2, 1, 1}, 0, 0, 0}, + {"9", 852.0, 1477.0, {2, 2, 1}, 0, 0, 0}, + {"C", 852.0, 1633.0, {2, 3, 1}, 0, 0, 0}, + {"*", 941.0, 1209.0, {3, 0, 1}, 0, 0, 0}, + {"0", 941.0, 1336.0, {3, 1, 1}, 0, 0, 0}, + {"#", 941.0, 1477.0, {3, 2, 1}, 0, 0, 0}, + {"D", 941.0, 1633.0, {3, 3, 1}, 0, 0, 0}, + }}; + +DTMFDolphinSceneData DTMFDolphinSceneDataBluebox = { + .name = "Bluebox", + .block = DTMF_DOLPHIN_TONE_BLOCK_BLUEBOX, + .tone_count = 13, + .tones = { + {"1", 700.0, 900.0, {0, 0, 1}, 0, 0, 0}, + {"2", 700.0, 1100.0, {0, 1, 1}, 0, 0, 0}, + {"3", 900.0, 1100.0, {0, 2, 1}, 0, 0, 0}, + {"4", 700.0, 1300.0, {1, 0, 1}, 0, 0, 0}, + {"5", 900.0, 1300.0, {1, 1, 1}, 0, 0, 0}, + {"6", 1100.0, 1300.0, {1, 2, 1}, 0, 0, 0}, + {"7", 700.0, 1500.0, {2, 0, 1}, 0, 0, 0}, + {"8", 900.0, 1500.0, {2, 1, 1}, 0, 0, 0}, + {"9", 1100.0, 1500.0, {2, 2, 1}, 0, 0, 0}, + {"0", 1300.0, 1500.0, {3, 1, 1}, 0, 0, 0}, + {"KP", 1100.0, 1700.0, {0, 3, 2}, 0, 0, 0}, + {"ST", 1500.0, 1700.0, {1, 3, 2}, 0, 0, 0}, + {"2600", 2600.0, 0.0, {3, 2, 3}, 0, 0, 0}, + }}; + +DTMFDolphinSceneData DTMFDolphinSceneDataRedboxUS = { + .name = "Redbox (US)", + .block = DTMF_DOLPHIN_TONE_BLOCK_REDBOX_US, + .tone_count = 4, + .tones = { + {"Nickel", 1700.0, 2200.0, {0, 0, 5}, 1, 66, 0}, + {"Dime", 1700.0, 2200.0, {1, 0, 5}, 2, 66, 66}, + {"Quarter", 1700.0, 2200.0, {2, 0, 5}, 5, 33, 33}, + {"Dollar", 1700.0, 2200.0, {3, 0, 5}, 1, 650, 0}, + }}; + +DTMFDolphinSceneData DTMFDolphinSceneDataRedboxCA = { + .name = "Redbox (CA)", + .block = DTMF_DOLPHIN_TONE_BLOCK_REDBOX_CA, + .tone_count = 3, + .tones = { + {"Nickel", 2200.0, 0.0, {0, 0, 5}, 1, 66, 0}, + {"Dime", 2200.0, 0.0, {1, 0, 5}, 2, 66, 66}, + {"Quarter", 2200.0, 0.0, {2, 0, 5}, 5, 33, 33}, + }}; + +DTMFDolphinSceneData DTMFDolphinSceneDataRedboxUK = { + .name = "Redbox (UK)", + .block = DTMF_DOLPHIN_TONE_BLOCK_REDBOX_UK, + .tone_count = 2, + .tones = { + {"10p", 1000.0, 0.0, {0, 0, 5}, 1, 200, 0}, + {"50p", 1000.0, 0.0, {1, 0, 5}, 1, 350, 0}, + }}; + +DTMFDolphinSceneData DTMFDolphinSceneDataMisc = { + .name = "Misc", + .block = DTMF_DOLPHIN_TONE_BLOCK_MISC, + .tone_count = 3, + .tones = { + {"CCITT 11", 700.0, 1700.0, {0, 0, 5}, 0, 0, 0}, + {"CCITT 12", 900.0, 1700.0, {1, 0, 5}, 0, 0, 0}, + {"CCITT KP2", 1300.0, 1700.0, {2, 0, 5}, 0, 0, 0}, + }}; + +DTMFDolphinToneSection current_section; +DTMFDolphinSceneData* current_scene_data; + +void dtmf_dolphin_data_set_current_section(DTMFDolphinToneSection section) { + current_section = section; + + switch(current_section) { + case DTMF_DOLPHIN_TONE_BLOCK_BLUEBOX: + current_scene_data = &DTMFDolphinSceneDataBluebox; + break; + case DTMF_DOLPHIN_TONE_BLOCK_REDBOX_US: + current_scene_data = &DTMFDolphinSceneDataRedboxUS; + break; + case DTMF_DOLPHIN_TONE_BLOCK_REDBOX_CA: + current_scene_data = &DTMFDolphinSceneDataRedboxCA; + break; + case DTMF_DOLPHIN_TONE_BLOCK_REDBOX_UK: + current_scene_data = &DTMFDolphinSceneDataRedboxUK; + break; + case DTMF_DOLPHIN_TONE_BLOCK_MISC: + current_scene_data = &DTMFDolphinSceneDataMisc; + break; + default: // DTMF_DOLPHIN_TONE_BLOCK_DIALER: + current_scene_data = &DTMFDolphinSceneDataDialer; + break; + } +} + +DTMFDolphinToneSection dtmf_dolphin_data_get_current_section() { + return current_section; +} + +DTMFDolphinSceneData* dtmf_dolphin_data_get_current_scene_data() { + return current_scene_data; +} + +bool dtmf_dolphin_data_get_tone_frequencies(float* freq1, float* freq2, uint8_t row, uint8_t col) { + for(size_t i = 0; i < current_scene_data->tone_count; i++) { + DTMFDolphinTones tones = current_scene_data->tones[i]; + if(tones.pos.row == row && tones.pos.col == col) { + freq1[0] = tones.frequency_1; + freq2[0] = tones.frequency_2; + return true; + } + } + return false; +} + +bool dtmf_dolphin_data_get_filter_data( + uint16_t* pulses, + uint16_t* pulse_ms, + uint16_t* gap_ms, + uint8_t row, + uint8_t col) { + for(size_t i = 0; i < current_scene_data->tone_count; i++) { + DTMFDolphinTones tones = current_scene_data->tones[i]; + if(tones.pos.row == row && tones.pos.col == col) { + pulses[0] = tones.pulses; + pulse_ms[0] = tones.pulse_ms; + gap_ms[0] = tones.gap_duration; + return true; + } + } + return false; +} + +const char* dtmf_dolphin_data_get_tone_name(uint8_t row, uint8_t col) { + for(size_t i = 0; i < current_scene_data->tone_count; i++) { + DTMFDolphinTones tones = current_scene_data->tones[i]; + if(tones.pos.row == row && tones.pos.col == col) { + return tones.name; + } + } + return NULL; +} + +const char* dtmf_dolphin_data_get_current_section_name() { + if(current_scene_data) { + return current_scene_data->name; + } + return NULL; +} + +void dtmf_dolphin_tone_get_max_pos(uint8_t* max_rows, uint8_t* max_cols, uint8_t* max_span) { + max_rows[0] = 0; + max_cols[0] = 0; + max_span[0] = 0; + uint8_t tmp_rowspan[5] = {0, 0, 0, 0, 0}; + for(size_t i = 0; i < current_scene_data->tone_count; i++) { + DTMFDolphinTones tones = current_scene_data->tones[i]; + if(tones.pos.row > max_rows[0]) { + max_rows[0] = tones.pos.row; + } + if(tones.pos.col > max_cols[0]) { + max_cols[0] = tones.pos.col; + } + tmp_rowspan[tones.pos.row] += tones.pos.span; + if(tmp_rowspan[tones.pos.row] > max_span[0]) max_span[0] = tmp_rowspan[tones.pos.row]; + } + max_rows[0]++; + max_cols[0]++; +} + +uint8_t dtmf_dolphin_get_tone_span(uint8_t row, uint8_t col) { + for(size_t i = 0; i < current_scene_data->tone_count; i++) { + DTMFDolphinTones tones = current_scene_data->tones[i]; + if(tones.pos.row == row && tones.pos.col == col) { + return tones.pos.span; + } + } + return 0; +} diff --git a/dtmf_dolphin_data.h b/dtmf_dolphin_data.h new file mode 100644 index 00000000000..56ceaf03dbd --- /dev/null +++ b/dtmf_dolphin_data.h @@ -0,0 +1,36 @@ +#pragma once +#include +#include +#include + +#define DTMF_DOLPHIN_MAX_TONE_COUNT 16 + +typedef enum { + DTMF_DOLPHIN_TONE_BLOCK_DIALER, + DTMF_DOLPHIN_TONE_BLOCK_BLUEBOX, + DTMF_DOLPHIN_TONE_BLOCK_REDBOX_US, + DTMF_DOLPHIN_TONE_BLOCK_REDBOX_UK, + DTMF_DOLPHIN_TONE_BLOCK_REDBOX_CA, + DTMF_DOLPHIN_TONE_BLOCK_MISC, +} DTMFDolphinToneSection; + +void dtmf_dolphin_data_set_current_section(DTMFDolphinToneSection section); + +DTMFDolphinToneSection dtmf_dolphin_data_get_current_section(); + +bool dtmf_dolphin_data_get_tone_frequencies(float* freq1, float* freq2, uint8_t row, uint8_t col); + +bool dtmf_dolphin_data_get_filter_data( + uint16_t* pulses, + uint16_t* pulse_ms, + uint16_t* gap_ms, + uint8_t row, + uint8_t col); + +const char* dtmf_dolphin_data_get_tone_name(uint8_t row, uint8_t col); + +const char* dtmf_dolphin_data_get_current_section_name(); + +void dtmf_dolphin_tone_get_max_pos(uint8_t* max_rows, uint8_t* max_cols, uint8_t* max_span); + +uint8_t dtmf_dolphin_get_tone_span(uint8_t row, uint8_t col); \ No newline at end of file diff --git a/dtmf_dolphin_event.h b/dtmf_dolphin_event.h new file mode 100644 index 00000000000..525d0eb044d --- /dev/null +++ b/dtmf_dolphin_event.h @@ -0,0 +1,21 @@ +#pragma once + +typedef enum { + DTMFDolphinEventVolumeUp = 0, + DTMFDolphinEventVolumeDown, + DTMFDolphinDialerOkCB, + DTMFDolphinEventStartDialer, + DTMFDolphinEventStartBluebox, + DTMFDolphinEventStartRedboxUS, + DTMFDolphinEventStartRedboxUK, + DTMFDolphinEventStartRedboxCA, + DTMFDolphinEventStartMisc, + DTMFDolphinEventPlayTones, + DTMFDolphinEventStopTones, + DTMFDolphinEventDMAHalfTransfer, + DTMFDolphinEventDMAFullTransfer, +} DTMFDolphinEvent; + +typedef struct { + DTMFDolphinEvent type; +} DTMFDolphinCustomEvent; \ No newline at end of file diff --git a/dtmf_dolphin_hal.c b/dtmf_dolphin_hal.c new file mode 100644 index 00000000000..b556c71452d --- /dev/null +++ b/dtmf_dolphin_hal.c @@ -0,0 +1,52 @@ +#include "dtmf_dolphin_hal.h" + +void dtmf_dolphin_speaker_init() { + LL_TIM_InitTypeDef TIM_InitStruct = {0}; + TIM_InitStruct.Prescaler = DTMF_DOLPHIN_HAL_DMA_PRESCALER; + TIM_InitStruct.Autoreload = DTMF_DOLPHIN_HAL_DMA_AUTORELOAD; + LL_TIM_Init(FURI_HAL_SPEAKER_TIMER, &TIM_InitStruct); + + LL_TIM_OC_InitTypeDef TIM_OC_InitStruct = {0}; + TIM_OC_InitStruct.OCMode = LL_TIM_OCMODE_PWM1; + TIM_OC_InitStruct.OCState = LL_TIM_OCSTATE_ENABLE; + TIM_OC_InitStruct.CompareValue = 127; + LL_TIM_OC_Init(FURI_HAL_SPEAKER_TIMER, FURI_HAL_SPEAKER_CHANNEL, &TIM_OC_InitStruct); +} + +void dtmf_dolphin_speaker_start() { + LL_TIM_EnableAllOutputs(FURI_HAL_SPEAKER_TIMER); + LL_TIM_EnableCounter(FURI_HAL_SPEAKER_TIMER); +} + +void dtmf_dolphin_speaker_stop() { + LL_TIM_DisableAllOutputs(FURI_HAL_SPEAKER_TIMER); + LL_TIM_DisableCounter(FURI_HAL_SPEAKER_TIMER); +} + +void dtmf_dolphin_dma_init(uint32_t address, size_t size) { + uint32_t dma_dst = (uint32_t) & (FURI_HAL_SPEAKER_TIMER->CCR1); + + LL_DMA_ConfigAddresses(DMA_INSTANCE, address, dma_dst, LL_DMA_DIRECTION_MEMORY_TO_PERIPH); + LL_DMA_SetDataLength(DMA_INSTANCE, size); + + LL_DMA_SetPeriphRequest(DMA_INSTANCE, LL_DMAMUX_REQ_TIM16_UP); + LL_DMA_SetDataTransferDirection(DMA_INSTANCE, LL_DMA_DIRECTION_MEMORY_TO_PERIPH); + LL_DMA_SetChannelPriorityLevel(DMA_INSTANCE, LL_DMA_PRIORITY_VERYHIGH); + LL_DMA_SetMode(DMA_INSTANCE, LL_DMA_MODE_CIRCULAR); + LL_DMA_SetPeriphIncMode(DMA_INSTANCE, LL_DMA_PERIPH_NOINCREMENT); + LL_DMA_SetMemoryIncMode(DMA_INSTANCE, LL_DMA_MEMORY_INCREMENT); + LL_DMA_SetPeriphSize(DMA_INSTANCE, LL_DMA_PDATAALIGN_HALFWORD); + LL_DMA_SetMemorySize(DMA_INSTANCE, LL_DMA_MDATAALIGN_HALFWORD); + + LL_DMA_EnableIT_TC(DMA_INSTANCE); + LL_DMA_EnableIT_HT(DMA_INSTANCE); +} + +void dtmf_dolphin_dma_start() { + LL_DMA_EnableChannel(DMA_INSTANCE); + LL_TIM_EnableDMAReq_UPDATE(FURI_HAL_SPEAKER_TIMER); +} + +void dtmf_dolphin_dma_stop() { + LL_DMA_DisableChannel(DMA_INSTANCE); +} diff --git a/dtmf_dolphin_hal.h b/dtmf_dolphin_hal.h new file mode 100644 index 00000000000..5b426f6a0d9 --- /dev/null +++ b/dtmf_dolphin_hal.h @@ -0,0 +1,33 @@ +#pragma once +#include +#include +#include +#include +#include + +#define FURI_HAL_SPEAKER_TIMER TIM16 +#define FURI_HAL_SPEAKER_CHANNEL LL_TIM_CHANNEL_CH1 +#define DMA_INSTANCE DMA1, LL_DMA_CHANNEL_1 + +#define DTMF_DOLPHIN_HAL_DMA_PRESCALER 4 +#define DTMF_DOLPHIN_HAL_DMA_AUTORELOAD 255 + +#ifdef __cplusplus +extern "C" { +#endif + +void dtmf_dolphin_speaker_init(); + +void dtmf_dolphin_speaker_start(); + +void dtmf_dolphin_speaker_stop(); + +void dtmf_dolphin_dma_init(uint32_t address, size_t size); + +void dtmf_dolphin_dma_start(); + +void dtmf_dolphin_dma_stop(); + +#ifdef __cplusplus +} +#endif \ No newline at end of file diff --git a/dtmf_dolphin_i.h b/dtmf_dolphin_i.h new file mode 100644 index 00000000000..f8ae1530fc0 --- /dev/null +++ b/dtmf_dolphin_i.h @@ -0,0 +1,42 @@ +#pragma once + +#include "scenes/dtmf_dolphin_scene.h" + +#include +#include +#include +// #include +// #include +#include +#include +#include + +#include "dtmf_dolphin_event.h" + +#include "views/dtmf_dolphin_dialer.h" + +#define TAG "DTMFDolphin" + +enum DTMFDolphinSceneState { + DTMFDolphinSceneStateDialer, + DTMFDolphinSceneStateBluebox, + DTMFDolphinSceneStateRedboxUS, + DTMFDolphinSceneStateRedboxUK, + DTMFDolphinSceneStateRedboxCA, + DTMFDolphinSceneStateMisc, +}; + +typedef struct { + ViewDispatcher* view_dispatcher; + SceneManager* scene_manager; + VariableItemList* main_menu_list; + DTMFDolphinDialer* dtmf_dolphin_dialer; + + Gui* gui; + // ButtonPanel* dialer_button_panel; + // ButtonPanel* bluebox_button_panel; + // ButtonPanel* redbox_button_panel; + NotificationApp* notification; +} DTMFDolphinApp; + +typedef enum { DTMFDolphinViewMainMenu, DTMFDolphinViewDialer } DTMFDolphinView; diff --git a/phone.png b/phone.png new file mode 100644 index 00000000000..443f847c3cd Binary files /dev/null and b/phone.png differ diff --git a/pics/dialer.jpg b/pics/dialer.jpg new file mode 100644 index 00000000000..ff6fad7a8f6 Binary files /dev/null and b/pics/dialer.jpg differ diff --git a/scenes/dtmf_dolphin_scene.c b/scenes/dtmf_dolphin_scene.c new file mode 100644 index 00000000000..bfb8da1daf1 --- /dev/null +++ b/scenes/dtmf_dolphin_scene.c @@ -0,0 +1,30 @@ +#include "dtmf_dolphin_scene.h" + +// Generate scene on_enter handlers array +#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_enter, +void (*const dtmf_dolphin_scene_on_enter_handlers[])(void*) = { +#include "dtmf_dolphin_scene_config.h" +}; +#undef ADD_SCENE + +// Generate scene on_event handlers array +#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_event, +bool (*const dtmf_dolphin_scene_on_event_handlers[])(void* context, SceneManagerEvent event) = { +#include "dtmf_dolphin_scene_config.h" +}; +#undef ADD_SCENE + +// Generate scene on_exit handlers array +#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_exit, +void (*const dtmf_dolphin_scene_on_exit_handlers[])(void* context) = { +#include "dtmf_dolphin_scene_config.h" +}; +#undef ADD_SCENE + +// Initialize scene handlers configuration structure +const SceneManagerHandlers dtmf_dolphin_scene_handlers = { + .on_enter_handlers = dtmf_dolphin_scene_on_enter_handlers, + .on_event_handlers = dtmf_dolphin_scene_on_event_handlers, + .on_exit_handlers = dtmf_dolphin_scene_on_exit_handlers, + .scene_num = DTMFDolphinSceneNum, +}; diff --git a/scenes/dtmf_dolphin_scene.h b/scenes/dtmf_dolphin_scene.h new file mode 100644 index 00000000000..e45dc68ae35 --- /dev/null +++ b/scenes/dtmf_dolphin_scene.h @@ -0,0 +1,29 @@ +#pragma once + +#include + +// Generate scene id and total number +#define ADD_SCENE(prefix, name, id) DTMFDolphinScene##id, +typedef enum { +#include "dtmf_dolphin_scene_config.h" + DTMFDolphinSceneNum, +} DTMFDolphinScene; +#undef ADD_SCENE + +extern const SceneManagerHandlers dtmf_dolphin_scene_handlers; + +// Generate scene on_enter handlers declaration +#define ADD_SCENE(prefix, name, id) void prefix##_scene_##name##_on_enter(void*); +#include "dtmf_dolphin_scene_config.h" +#undef ADD_SCENE + +// Generate scene on_event handlers declaration +#define ADD_SCENE(prefix, name, id) \ + bool prefix##_scene_##name##_on_event(void* context, SceneManagerEvent event); +#include "dtmf_dolphin_scene_config.h" +#undef ADD_SCENE + +// Generate scene on_exit handlers declaration +#define ADD_SCENE(prefix, name, id) void prefix##_scene_##name##_on_exit(void* context); +#include "dtmf_dolphin_scene_config.h" +#undef ADD_SCENE diff --git a/scenes/dtmf_dolphin_scene_config.h b/scenes/dtmf_dolphin_scene_config.h new file mode 100644 index 00000000000..b6dab07dc7e --- /dev/null +++ b/scenes/dtmf_dolphin_scene_config.h @@ -0,0 +1,2 @@ +ADD_SCENE(dtmf_dolphin, start, Start) +ADD_SCENE(dtmf_dolphin, dialer, Dialer) \ No newline at end of file diff --git a/scenes/dtmf_dolphin_scene_dialer.c b/scenes/dtmf_dolphin_scene_dialer.c new file mode 100644 index 00000000000..06da595e0ca --- /dev/null +++ b/scenes/dtmf_dolphin_scene_dialer.c @@ -0,0 +1,49 @@ +#include "../dtmf_dolphin_i.h" +// #include "../dtmf_dolphin_data.h" +// #include "../dtmf_dolphin_audio.h" + +void dtmf_dolphin_scene_dialer_on_enter(void* context) { + DTMFDolphinApp* app = context; + DTMFDolphinScene scene_id = DTMFDolphinSceneDialer; + enum DTMFDolphinSceneState state = scene_manager_get_scene_state(app->scene_manager, scene_id); + + switch(state) { + case DTMFDolphinSceneStateBluebox: + dtmf_dolphin_data_set_current_section(DTMF_DOLPHIN_TONE_BLOCK_BLUEBOX); + break; + case DTMFDolphinSceneStateRedboxUS: + dtmf_dolphin_data_set_current_section(DTMF_DOLPHIN_TONE_BLOCK_REDBOX_US); + break; + case DTMFDolphinSceneStateRedboxUK: + dtmf_dolphin_data_set_current_section(DTMF_DOLPHIN_TONE_BLOCK_REDBOX_UK); + break; + case DTMFDolphinSceneStateRedboxCA: + dtmf_dolphin_data_set_current_section(DTMF_DOLPHIN_TONE_BLOCK_REDBOX_CA); + break; + case DTMFDolphinSceneStateMisc: + dtmf_dolphin_data_set_current_section(DTMF_DOLPHIN_TONE_BLOCK_MISC); + break; + default: + dtmf_dolphin_data_set_current_section(DTMF_DOLPHIN_TONE_BLOCK_DIALER); + break; + } + + view_dispatcher_switch_to_view(app->view_dispatcher, DTMFDolphinViewDialer); +} + +bool dtmf_dolphin_scene_dialer_on_event(void* context, SceneManagerEvent event) { + DTMFDolphinApp* app = context; + UNUSED(app); + UNUSED(event); + bool consumed = false; + + // if(event.type == SceneManagerEventTypeTick) { + // consumed = true; + // } + + return consumed; +} + +void dtmf_dolphin_scene_dialer_on_exit(void* context) { + UNUSED(context); +} diff --git a/scenes/dtmf_dolphin_scene_start.c b/scenes/dtmf_dolphin_scene_start.c new file mode 100644 index 00000000000..484e9e8eb45 --- /dev/null +++ b/scenes/dtmf_dolphin_scene_start.c @@ -0,0 +1,94 @@ +#include "../dtmf_dolphin_i.h" + +static void dtmf_dolphin_scene_start_main_menu_enter_callback(void* context, uint32_t index) { + DTMFDolphinApp* app = context; + uint8_t cust_event = 255; + switch(index) { + case 0: + cust_event = DTMFDolphinEventStartDialer; + break; + case 1: + cust_event = DTMFDolphinEventStartBluebox; + break; + case 2: + cust_event = DTMFDolphinEventStartRedboxUS; + break; + case 3: + cust_event = DTMFDolphinEventStartRedboxUK; + break; + case 4: + cust_event = DTMFDolphinEventStartRedboxCA; + break; + case 5: + cust_event = DTMFDolphinEventStartMisc; + break; + default: + return; + } + + view_dispatcher_send_custom_event(app->view_dispatcher, cust_event); +} + +void dtmf_dolphin_scene_start_on_enter(void* context) { + DTMFDolphinApp* app = context; + VariableItemList* var_item_list = app->main_menu_list; + + // VariableItem* item; + variable_item_list_set_enter_callback( + var_item_list, dtmf_dolphin_scene_start_main_menu_enter_callback, app); + + variable_item_list_add(var_item_list, "Dialer", 0, NULL, context); + variable_item_list_add(var_item_list, "Bluebox", 0, NULL, context); + variable_item_list_add(var_item_list, "Redbox (US)", 0, NULL, context); + variable_item_list_add(var_item_list, "Redbox (UK)", 0, NULL, context); + variable_item_list_add(var_item_list, "Redbox (CA)", 0, NULL, context); + variable_item_list_add(var_item_list, "Misc", 0, NULL, context); + + variable_item_list_set_selected_item( + var_item_list, scene_manager_get_scene_state(app->scene_manager, DTMFDolphinSceneStart)); + + view_dispatcher_switch_to_view(app->view_dispatcher, DTMFDolphinViewMainMenu); +} + +bool dtmf_dolphin_scene_start_on_event(void* context, SceneManagerEvent event) { + DTMFDolphinApp* app = context; + UNUSED(app); + bool consumed = false; + + if(event.type == SceneManagerEventTypeCustom) { + uint8_t sc_state; + + switch(event.event) { + case DTMFDolphinEventStartDialer: + sc_state = DTMFDolphinSceneStateDialer; + break; + case DTMFDolphinEventStartBluebox: + sc_state = DTMFDolphinSceneStateBluebox; + break; + case DTMFDolphinEventStartRedboxUS: + sc_state = DTMFDolphinSceneStateRedboxUS; + break; + case DTMFDolphinEventStartRedboxUK: + sc_state = DTMFDolphinSceneStateRedboxUK; + break; + case DTMFDolphinEventStartRedboxCA: + sc_state = DTMFDolphinSceneStateRedboxCA; + break; + case DTMFDolphinEventStartMisc: + sc_state = DTMFDolphinSceneStateMisc; + break; + default: + return consumed; + } + scene_manager_set_scene_state(app->scene_manager, DTMFDolphinSceneDialer, sc_state); + scene_manager_next_scene(app->scene_manager, DTMFDolphinSceneDialer); + + consumed = true; + } + return consumed; +} + +void dtmf_dolphin_scene_start_on_exit(void* context) { + DTMFDolphinApp* app = context; + variable_item_list_reset(app->main_menu_list); +} diff --git a/views/dtmf_dolphin_common.h b/views/dtmf_dolphin_common.h new file mode 100644 index 00000000000..f2f4838d61c --- /dev/null +++ b/views/dtmf_dolphin_common.h @@ -0,0 +1,10 @@ +#pragma once +#include "../dtmf_dolphin_event.h" +#include "../dtmf_dolphin_data.h" +#include "../dtmf_dolphin_audio.h" + +#define DTMF_DOLPHIN_NUMPAD_X 1 +#define DTMF_DOLPHIN_NUMPAD_Y 14 +#define DTMF_DOLPHIN_BUTTON_WIDTH 13 +#define DTMF_DOLPHIN_BUTTON_HEIGHT 13 +#define DTMF_DOLPHIN_BUTTON_PADDING 1 // all sides diff --git a/views/dtmf_dolphin_dialer.c b/views/dtmf_dolphin_dialer.c new file mode 100644 index 00000000000..bdffa231331 --- /dev/null +++ b/views/dtmf_dolphin_dialer.c @@ -0,0 +1,350 @@ +#include "dtmf_dolphin_dialer.h" + +#include + +typedef struct DTMFDolphinDialer { + View* view; + DTMFDolphinDialerOkCallback callback; + void* context; +} DTMFDolphinDialer; + +typedef struct { + DTMFDolphinToneSection section; + uint8_t row; + uint8_t col; + float freq1; + float freq2; + bool playing; + uint16_t pulses; + uint16_t pulse_ms; + uint16_t gap_ms; +} DTMFDolphinDialerModel; + +static bool dtmf_dolphin_dialer_process_up(DTMFDolphinDialer* dtmf_dolphin_dialer); +static bool dtmf_dolphin_dialer_process_down(DTMFDolphinDialer* dtmf_dolphin_dialer); +static bool dtmf_dolphin_dialer_process_left(DTMFDolphinDialer* dtmf_dolphin_dialer); +static bool dtmf_dolphin_dialer_process_right(DTMFDolphinDialer* dtmf_dolphin_dialer); +static bool + dtmf_dolphin_dialer_process_ok(DTMFDolphinDialer* dtmf_dolphin_dialer, InputEvent* event); + +void draw_button(Canvas* canvas, uint8_t row, uint8_t col, bool invert) { + uint8_t left = DTMF_DOLPHIN_NUMPAD_X + // ((col + 1) * DTMF_DOLPHIN_BUTTON_PADDING) + + (col * DTMF_DOLPHIN_BUTTON_WIDTH); + // (col * DTMF_DOLPHIN_BUTTON_PADDING); + uint8_t top = DTMF_DOLPHIN_NUMPAD_Y + // ((row + 1) * DTMF_DOLPHIN_BUTTON_PADDING) + + (row * DTMF_DOLPHIN_BUTTON_HEIGHT); + // (row * DTMF_DOLPHIN_BUTTON_PADDING); + + uint8_t span = dtmf_dolphin_get_tone_span(row, col); + + if(span == 0) { + return; + } + + canvas_set_color(canvas, ColorBlack); + + if(invert) + canvas_draw_rbox( + canvas, + left, + top, + (DTMF_DOLPHIN_BUTTON_WIDTH * span) - (DTMF_DOLPHIN_BUTTON_PADDING * 2), + DTMF_DOLPHIN_BUTTON_HEIGHT - (DTMF_DOLPHIN_BUTTON_PADDING * 2), + 2); + else + canvas_draw_rframe( + canvas, + left, + top, + (DTMF_DOLPHIN_BUTTON_WIDTH * span) - (DTMF_DOLPHIN_BUTTON_PADDING * 2), + DTMF_DOLPHIN_BUTTON_HEIGHT - (DTMF_DOLPHIN_BUTTON_PADDING * 2), + 2); + + if(invert) canvas_invert_color(canvas); + + canvas_set_font(canvas, FontSecondary); + // canvas_set_color(canvas, invert ? ColorWhite : ColorBlack); + canvas_draw_str_aligned( + canvas, + left - 1 + (int)((DTMF_DOLPHIN_BUTTON_WIDTH * span) / 2), + top + (int)(DTMF_DOLPHIN_BUTTON_HEIGHT / 2), + AlignCenter, + AlignCenter, + dtmf_dolphin_data_get_tone_name(row, col)); + + if(invert) canvas_invert_color(canvas); +} + +void draw_dialer(Canvas* canvas, void* _model) { + DTMFDolphinDialerModel* model = _model; + uint8_t max_rows; + uint8_t max_cols; + uint8_t max_span; + dtmf_dolphin_tone_get_max_pos(&max_rows, &max_cols, &max_span); + + canvas_set_font(canvas, FontSecondary); + + for(int r = 0; r < max_rows; r++) { + for(int c = 0; c < max_cols; c++) { + if(model->row == r && model->col == c) + draw_button(canvas, r, c, true); + else + draw_button(canvas, r, c, false); + } + } +} + +void update_frequencies(DTMFDolphinDialerModel* model) { + dtmf_dolphin_data_get_tone_frequencies(&model->freq1, &model->freq2, model->row, model->col); + dtmf_dolphin_data_get_filter_data( + &model->pulses, &model->pulse_ms, &model->gap_ms, model->row, model->col); +} + +static void dtmf_dolphin_dialer_draw_callback(Canvas* canvas, void* _model) { + DTMFDolphinDialerModel* model = _model; + if(model->playing) { + // Leverage the prioritized draw callback to handle + // the DMA so that it doesn't skip. + dtmf_dolphin_audio_handle_tick(); + // Don't do any drawing if audio is playing. + canvas_set_font(canvas, FontPrimary); + elements_multiline_text_aligned( + canvas, + canvas_width(canvas) / 2, + canvas_height(canvas) / 2, + AlignCenter, + AlignCenter, + "Playing Tones"); + return; + } + update_frequencies(model); + uint8_t max_rows = 0; + uint8_t max_cols = 0; + uint8_t max_span = 0; + dtmf_dolphin_tone_get_max_pos(&max_rows, &max_cols, &max_span); + + canvas_set_font(canvas, FontPrimary); + elements_multiline_text(canvas, 2, 10, dtmf_dolphin_data_get_current_section_name()); + canvas_draw_line( + canvas, + (max_span * DTMF_DOLPHIN_BUTTON_WIDTH) + 1, + 0, + (max_span * DTMF_DOLPHIN_BUTTON_WIDTH) + 1, + canvas_height(canvas)); + elements_multiline_text(canvas, (max_span * DTMF_DOLPHIN_BUTTON_WIDTH) + 4, 10, "Detail"); + canvas_draw_line( + canvas, 0, DTMF_DOLPHIN_NUMPAD_Y - 3, canvas_width(canvas), DTMF_DOLPHIN_NUMPAD_Y - 3); + // elements_multiline_text_aligned(canvas, 64, 2, AlignCenter, AlignTop, "Dialer Mode"); + + draw_dialer(canvas, model); + + FuriString* output = furi_string_alloc(); + + if(model->freq1 && model->freq2) { + furi_string_cat_printf( + output, + "Dual Tone\nF1: %u Hz\nF2: %u Hz\n", + (unsigned int)model->freq1, + (unsigned int)model->freq2); + } else if(model->freq1) { + furi_string_cat_printf(output, "Single Tone\nF: %u Hz\n", (unsigned int)model->freq1); + } + + canvas_set_font(canvas, FontSecondary); + canvas_set_color(canvas, ColorBlack); + if(model->pulse_ms) { + furi_string_cat_printf(output, "P: %u * %u ms\n", model->pulses, model->pulse_ms); + } + if(model->gap_ms) { + furi_string_cat_printf(output, "Gaps: %u ms\n", model->gap_ms); + } + elements_multiline_text( + canvas, (max_span * DTMF_DOLPHIN_BUTTON_WIDTH) + 4, 21, furi_string_get_cstr(output)); + + furi_string_free(output); +} + +static bool dtmf_dolphin_dialer_input_callback(InputEvent* event, void* context) { + furi_assert(context); + DTMFDolphinDialer* dtmf_dolphin_dialer = context; + bool consumed = false; + + if(event->type == InputTypeShort) { + if(event->key == InputKeyRight) { + consumed = dtmf_dolphin_dialer_process_right(dtmf_dolphin_dialer); + } else if(event->key == InputKeyLeft) { + consumed = dtmf_dolphin_dialer_process_left(dtmf_dolphin_dialer); + } else if(event->key == InputKeyUp) { + consumed = dtmf_dolphin_dialer_process_up(dtmf_dolphin_dialer); + } else if(event->key == InputKeyDown) { + consumed = dtmf_dolphin_dialer_process_down(dtmf_dolphin_dialer); + } + + } else if(event->key == InputKeyOk) { + consumed = dtmf_dolphin_dialer_process_ok(dtmf_dolphin_dialer, event); + } + + return consumed; +} + +static bool dtmf_dolphin_dialer_process_up(DTMFDolphinDialer* dtmf_dolphin_dialer) { + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + uint8_t span = 0; + uint8_t cursor = model->row; + while(span == 0 && cursor > 0) { + cursor--; + span = dtmf_dolphin_get_tone_span(cursor, model->col); + } + if(span != 0) { + model->row = cursor; + } + }, + true); + return true; +} + +static bool dtmf_dolphin_dialer_process_down(DTMFDolphinDialer* dtmf_dolphin_dialer) { + uint8_t max_rows = 0; + uint8_t max_cols = 0; + uint8_t max_span = 0; + dtmf_dolphin_tone_get_max_pos(&max_rows, &max_cols, &max_span); + + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + uint8_t span = 0; + uint8_t cursor = model->row; + while(span == 0 && cursor < max_rows - 1) { + cursor++; + span = dtmf_dolphin_get_tone_span(cursor, model->col); + } + if(span != 0) { + model->row = cursor; + } + }, + true); + return true; +} + +static bool dtmf_dolphin_dialer_process_left(DTMFDolphinDialer* dtmf_dolphin_dialer) { + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + uint8_t span = 0; + uint8_t cursor = model->col; + while(span == 0 && cursor > 0) { + cursor--; + span = dtmf_dolphin_get_tone_span(model->row, cursor); + } + if(span != 0) { + model->col = cursor; + } + }, + true); + return true; +} + +static bool dtmf_dolphin_dialer_process_right(DTMFDolphinDialer* dtmf_dolphin_dialer) { + uint8_t max_rows = 0; + uint8_t max_cols = 0; + uint8_t max_span = 0; + dtmf_dolphin_tone_get_max_pos(&max_rows, &max_cols, &max_span); + + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + uint8_t span = 0; + uint8_t cursor = model->col; + while(span == 0 && cursor < max_cols - 1) { + cursor++; + span = dtmf_dolphin_get_tone_span(model->row, cursor); + } + if(span != 0) { + model->col = cursor; + } + }, + true); + return true; +} + +static bool + dtmf_dolphin_dialer_process_ok(DTMFDolphinDialer* dtmf_dolphin_dialer, InputEvent* event) { + bool consumed = false; + + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + if(event->type == InputTypePress) { + model->playing = dtmf_dolphin_audio_play_tones( + model->freq1, model->freq2, model->pulses, model->pulse_ms, model->gap_ms); + } else if(event->type == InputTypeRelease) { + model->playing = !dtmf_dolphin_audio_stop_tones(); + } + }, + true); + + return consumed; +} + +static void dtmf_dolphin_dialer_enter_callback(void* context) { + furi_assert(context); + DTMFDolphinDialer* dtmf_dolphin_dialer = context; + + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + model->col = 0; + model->row = 0; + model->section = 0; + model->freq1 = 0.0; + model->freq2 = 0.0; + model->playing = false; + }, + true); +} + +DTMFDolphinDialer* dtmf_dolphin_dialer_alloc() { + DTMFDolphinDialer* dtmf_dolphin_dialer = malloc(sizeof(DTMFDolphinDialer)); + + dtmf_dolphin_dialer->view = view_alloc(); + view_allocate_model( + dtmf_dolphin_dialer->view, ViewModelTypeLocking, sizeof(DTMFDolphinDialerModel)); + + with_view_model( + dtmf_dolphin_dialer->view, + DTMFDolphinDialerModel * model, + { + model->col = 0; + model->row = 0; + model->section = 0; + model->freq1 = 0.0; + model->freq2 = 0.0; + model->playing = false; + }, + true); + + view_set_context(dtmf_dolphin_dialer->view, dtmf_dolphin_dialer); + view_set_draw_callback(dtmf_dolphin_dialer->view, dtmf_dolphin_dialer_draw_callback); + view_set_input_callback(dtmf_dolphin_dialer->view, dtmf_dolphin_dialer_input_callback); + view_set_enter_callback(dtmf_dolphin_dialer->view, dtmf_dolphin_dialer_enter_callback); + return dtmf_dolphin_dialer; +} + +void dtmf_dolphin_dialer_free(DTMFDolphinDialer* dtmf_dolphin_dialer) { + furi_assert(dtmf_dolphin_dialer); + view_free(dtmf_dolphin_dialer->view); + free(dtmf_dolphin_dialer); +} + +View* dtmf_dolphin_dialer_get_view(DTMFDolphinDialer* dtmf_dolphin_dialer) { + furi_assert(dtmf_dolphin_dialer); + return dtmf_dolphin_dialer->view; +} diff --git a/views/dtmf_dolphin_dialer.h b/views/dtmf_dolphin_dialer.h new file mode 100644 index 00000000000..1929afbc592 --- /dev/null +++ b/views/dtmf_dolphin_dialer.h @@ -0,0 +1,18 @@ +#pragma once + +#include +#include "dtmf_dolphin_common.h" + +typedef struct DTMFDolphinDialer DTMFDolphinDialer; +typedef void (*DTMFDolphinDialerOkCallback)(InputType type, void* context); + +DTMFDolphinDialer* dtmf_dolphin_dialer_alloc(); + +void dtmf_dolphin_dialer_free(DTMFDolphinDialer* dtmf_dolphin_dialer); + +View* dtmf_dolphin_dialer_get_view(DTMFDolphinDialer* dtmf_dolphin_dialer); + +void dtmf_dolphin_dialer_set_ok_callback( + DTMFDolphinDialer* dtmf_dolphin_dialer, + DTMFDolphinDialerOkCallback callback, + void* context);