diff --git a/.idea/valib.iml b/.idea/valib.iml index d426c58..3308816 100644 --- a/.idea/valib.iml +++ b/.idea/valib.iml @@ -12,6 +12,7 @@ + diff --git a/Cargo.lock b/Cargo.lock index eebf0ee..1a6419b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3444,6 +3444,16 @@ dependencies = [ "winapi-util", ] +[[package]] +name = "saturators" +version = "0.1.0" +dependencies = [ + "enum-map", + "nih_plug", + "num-traits", + "valib", +] + [[package]] name = "scopeguard" version = "1.2.0" diff --git a/bundler.toml b/bundler.toml index 2d0931b..81e1b93 100644 --- a/bundler.toml +++ b/bundler.toml @@ -10,6 +10,9 @@ name = "Dirty Biquad" [diodeclipper] name = "Diode Clipper" +[saturators] +name = "Saturators" + [slew] name = "Slew" diff --git a/examples/diodeclipper/src/dsp.rs b/examples/diodeclipper/src/dsp.rs index 4d515af..995995f 100644 --- a/examples/diodeclipper/src/dsp.rs +++ b/examples/diodeclipper/src/dsp.rs @@ -1,9 +1,9 @@ -use enum_map::Enum; -use nih_plug::util::gain_to_db_fast; -use num_traits::Zero; use std::fmt; use std::fmt::Formatter; +use enum_map::Enum; +use num_traits::Zero; + use valib::dsp::parameter::{HasParameters, Parameter, SmoothedParam}; use valib::dsp::{DSPBlock, DSP}; use valib::filters::biquad::Biquad; @@ -36,20 +36,20 @@ impl DSP<1, 1> for DcBlocker { self.0.process(x) } - fn set_samplerate(&mut self, samplerate: f32) { - DSP::set_samplerate(&mut self.0, samplerate); - self.0.update_coefficients(&Biquad::highpass( - T::from_f64((Self::CUTOFF_HZ / samplerate) as f64), - T::from_f64(Self::Q as f64), - )); + fn reset(&mut self) { + self.0.reset() } fn latency(&self) -> usize { DSP::latency(&self.0) } - fn reset(&mut self) { - self.0.reset() + fn set_samplerate(&mut self, samplerate: f32) { + DSP::set_samplerate(&mut self.0, samplerate); + self.0.update_coefficients(&Biquad::highpass( + T::from_f64((Self::CUTOFF_HZ / samplerate) as f64), + T::from_f64(Self::Q as f64), + )); } } diff --git a/examples/saturators/COPYING b/examples/saturators/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/examples/saturators/COPYING @@ -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/examples/saturators/Cargo.toml b/examples/saturators/Cargo.toml new file mode 100644 index 0000000..db28bea --- /dev/null +++ b/examples/saturators/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "saturators" +version.workspace = true +rust-version.workspace = true +authors.workspace = true +edition.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true +keywords.workspace = true + +[lib] +crate-type = ["cdylib"] + +[dependencies] +enum-map.workspace = true +nih_plug.workspace = true +num-traits.workspace = true +valib = { path = "../..", features = ["nih-plug"] } \ No newline at end of file diff --git a/examples/saturators/README.md b/examples/saturators/README.md new file mode 100644 index 0000000..4d3356c --- /dev/null +++ b/examples/saturators/README.md @@ -0,0 +1,11 @@ +# Saturators + +A demo plugin of the various saturators implemented in valib, as well as the possible options that can +be applied on them. + +Saturators is provided for demonstration purposes, and is not a fully-featured plugin. It has no custom GUI. + +## Download + +You can download the latest nightly build from a permalink to the latest nightly builds +[here](https://nightly.link/SolarLiner/valib/workflows/build/master). diff --git a/examples/saturators/src/dsp.rs b/examples/saturators/src/dsp.rs new file mode 100644 index 0000000..00ef727 --- /dev/null +++ b/examples/saturators/src/dsp.rs @@ -0,0 +1,388 @@ +use enum_map::{Enum, EnumArray}; +use num_traits::Zero; + +use valib::dsp::parameter::{HasParameters, Parameter, SmoothedParam}; +use valib::dsp::utils::slice_to_mono_block_mut; +use valib::dsp::{DSPBlock, DSP}; +use valib::filters::biquad::Biquad; +use valib::oversample::{Oversample, Oversampled}; +use valib::saturators::adaa::{Adaa, Antiderivative, Antiderivative2}; +use valib::saturators::clippers::DiodeClipperModel; +use valib::saturators::{Asinh, Clipper, Linear, Saturator, Tanh}; +use valib::simd::{AutoF32x2, AutoF64x2, SimdComplexField}; +use valib::{Scalar, SimdCast}; + +struct DcBlocker(Biquad); + +impl DcBlocker { + const CUTOFF_HZ: f32 = 5.0; + const Q: f32 = 0.707; + fn new(samplerate: f32) -> Self + where + T: Scalar, + { + Self(Biquad::highpass( + T::from_f64((Self::CUTOFF_HZ / samplerate) as f64), + T::from_f64(Self::Q as f64), + )) + } +} + +impl DSP<1, 1> for DcBlocker { + type Sample = T; + + fn process(&mut self, x: [Self::Sample; 1]) -> [Self::Sample; 1] { + self.0.process(x) + } + + fn reset(&mut self) { + DSP::reset(&mut self.0); + } + + fn latency(&self) -> usize { + DSP::latency(&self.0) + } + + fn set_samplerate(&mut self, samplerate: f32) { + DSP::set_samplerate(&mut self.0, samplerate); + self.0.update_coefficients(&Biquad::highpass( + T::from_f64((Self::CUTOFF_HZ / samplerate) as f64), + T::from_f64(Self::Q as f64), + )); + } +} + +type Sample = AutoF32x2; +type Sample64 = AutoF64x2; + +#[derive(Debug, Copy, Clone, Eq, PartialEq, Enum)] +pub enum SaturatorType { + HardClip, + Tanh, + Asinh, + DiodeSymmetric, + DiodeAssymetric, +} + +enum DspSaturatorDirect { + HardClip, + Tanh, + Asinh, + Diode(DiodeClipperModel), +} + +impl DSP<1, 1> for DspSaturatorDirect { + type Sample = Sample64; + + fn process(&mut self, [x]: [Self::Sample; 1]) -> [Self::Sample; 1] { + let y = match self { + Self::HardClip => Clipper.saturate(x), + Self::Tanh => Tanh.saturate(x), + Self::Asinh => Asinh.saturate(x), + Self::Diode(clipper) => clipper.saturate(x), + }; + [y] + } +} + +enum DspSaturatorAdaa1 { + HardClip, + Tanh, + Asinh, +} + +impl Antiderivative for DspSaturatorAdaa1 { + fn evaluate(&self, x: Sample64) -> Sample64 { + match self { + Self::HardClip => Clipper.evaluate(x), + Self::Tanh => Tanh.evaluate(x), + Self::Asinh => Asinh.evaluate(x), + } + } + + fn antiderivative(&self, x: Sample64) -> Sample64 { + match self { + DspSaturatorAdaa1::HardClip => Clipper.antiderivative(x), + DspSaturatorAdaa1::Tanh => Tanh.antiderivative(x), + DspSaturatorAdaa1::Asinh => Asinh.antiderivative(x), + } + } +} + +enum DspSaturatorAdaa2 { + HardClip, + Asinh, +} + +impl Antiderivative for DspSaturatorAdaa2 { + fn evaluate(&self, x: Sample64) -> Sample64 { + match self { + Self::HardClip => Clipper.evaluate(x), + Self::Asinh => Asinh.evaluate(x), + } + } + + fn antiderivative(&self, x: Sample64) -> Sample64 { + match self { + Self::HardClip => Clipper.antiderivative(x), + Self::Asinh => Asinh.antiderivative(x), + } + } +} + +impl Antiderivative2 for DspSaturatorAdaa2 { + fn antiderivative2(&self, x: Sample64) -> Sample64 { + match self { + Self::HardClip => Clipper.antiderivative2(x), + Self::Asinh => Asinh.antiderivative2(x), + } + } +} + +enum DspSaturator { + Direct(DspSaturatorDirect), + Adaa1(Adaa), + Adaa2(Adaa), +} + +impl DSP<1, 1> for DspSaturator { + type Sample = Sample64; + + fn process(&mut self, x: [Self::Sample; 1]) -> [Self::Sample; 1] { + match self { + DspSaturator::Direct(sat) => sat.process(x), + DspSaturator::Adaa1(adaa) => adaa.process(x), + DspSaturator::Adaa2(adaa) => adaa.process(x), + } + } +} + +impl SaturatorType { + pub fn name(&self) -> String { + match self { + SaturatorType::HardClip => "Hard clip", + SaturatorType::Tanh => "Tanh", + SaturatorType::Asinh => "Asinh", + SaturatorType::DiodeSymmetric => "Diode (symmetric)", + SaturatorType::DiodeAssymetric => "Diode (assymetric)", + } + .to_string() + } +} + +#[derive(Debug, Copy, Clone, Eq, PartialEq, Enum)] +pub enum DspInnerParams { + Drive, + Saturator, + Feedback, + AdaaLevel, + AdaaEpsilon, +} + +pub struct DspInner { + drive: SmoothedParam, + model_switch: Parameter, + feedback: SmoothedParam, + adaa_level: Parameter, + adaa_epsilon: SmoothedParam, + cur_saturator: DspSaturator, + last_out: Sample64, +} + +impl DspInner { + fn new(samplerate: f32) -> Self { + Self { + drive: Parameter::new(1.0).smoothed_exponential(samplerate, 10.0), + model_switch: Parameter::new(0.0), + feedback: Parameter::new(0.0).smoothed_linear(samplerate, 100.0), + adaa_level: Parameter::new(2.0), + adaa_epsilon: Parameter::new(1e-4).smoothed_linear(samplerate, 100.0), + cur_saturator: DspSaturator::Adaa2(Adaa::new(DspSaturatorAdaa2::HardClip)), + last_out: Sample64::zero(), + } + } + + fn update_from_params(&mut self) { + if self.model_switch.has_changed() || self.adaa_level.has_changed() { + self.cur_saturator = match ( + self.model_switch.get_enum(), + self.adaa_level.get_value() as u8, + ) { + (SaturatorType::HardClip, 0) => DspSaturator::Direct(DspSaturatorDirect::HardClip), + (SaturatorType::HardClip, 1) => { + DspSaturator::Adaa1(Adaa::new(DspSaturatorAdaa1::HardClip)) + } + (SaturatorType::HardClip, _) => { + DspSaturator::Adaa2(Adaa::new(DspSaturatorAdaa2::HardClip)) + } + (SaturatorType::Tanh, 0) => DspSaturator::Direct(DspSaturatorDirect::Tanh), + (SaturatorType::Tanh, _) => DspSaturator::Adaa1(Adaa::new(DspSaturatorAdaa1::Tanh)), + (SaturatorType::Asinh, 0) => DspSaturator::Direct(DspSaturatorDirect::Asinh), + (SaturatorType::Asinh, 1) => { + DspSaturator::Adaa1(Adaa::new(DspSaturatorAdaa1::Asinh)) + } + (SaturatorType::Asinh, _) => { + DspSaturator::Adaa2(Adaa::new(DspSaturatorAdaa2::Asinh)) + } + (SaturatorType::DiodeSymmetric, _) => DspSaturator::Direct( + DspSaturatorDirect::Diode(DiodeClipperModel::new_silicon(1, 1)), + ), + (SaturatorType::DiodeAssymetric, _) => DspSaturator::Direct( + DspSaturatorDirect::Diode(DiodeClipperModel::new_germanium(1, 2)), + ), + } + } + let adaa_epsilon = Sample64::from_f64(self.adaa_epsilon.next_sample() as _); + match &mut self.cur_saturator { + DspSaturator::Adaa1(adaa) => adaa.epsilon = adaa_epsilon, + DspSaturator::Adaa2(adaa) => adaa.epsilon = adaa_epsilon, + _ => {} + } + } +} + +impl HasParameters for DspInner { + type Enum = DspInnerParams; + + fn get_parameter(&self, param: Self::Enum) -> &Parameter { + match param { + DspInnerParams::Drive => &self.drive.param, + DspInnerParams::Saturator => &self.model_switch, + DspInnerParams::Feedback => &self.feedback.param, + DspInnerParams::AdaaLevel => &self.adaa_level, + DspInnerParams::AdaaEpsilon => &self.adaa_epsilon.param, + } + } +} + +impl DSP<1, 1> for DspInner { + type Sample = Sample; + + fn process(&mut self, [x]: [Self::Sample; 1]) -> [Self::Sample; 1] { + self.update_from_params(); + + let drive = Sample64::from_f64(self.drive.next_sample() as _); + let feedback = Sample64::from_f64(self.feedback.next_sample() as _); + let x64 = x.cast() * drive + self.last_out * feedback; + let [y] = self.cur_saturator.process([x64]); + self.last_out = y; + let yout = y / drive.simd_asinh(); + [yout.cast()] + } + + fn set_samplerate(&mut self, samplerate: f32) { + DSP::set_samplerate(&mut self.drive, samplerate); + DSP::set_samplerate(&mut self.feedback, samplerate); + } + + fn latency(&self) -> usize { + DSP::latency(&self.cur_saturator) + } + + fn reset(&mut self) { + DSP::reset(&mut self.cur_saturator); + } +} + +#[derive(Debug, Copy, Clone, Eq, PartialEq)] +pub enum DspParams { + InnerParam(DspInnerParams), + DcBlocker, + Oversampling, +} + +impl Enum for DspParams { + const LENGTH: usize = DspInnerParams::LENGTH + 2; + + fn from_usize(value: usize) -> Self { + if value < DspInnerParams::LENGTH { + DspParams::InnerParam(DspInnerParams::from_usize(value)) + } else { + match value - DspInnerParams::LENGTH { + 0 => Self::DcBlocker, + 1 => Self::Oversampling, + _ => unreachable!(), + } + } + } + + fn into_usize(self) -> usize { + match self { + Self::InnerParam(dsp_param) => dsp_param.into_usize(), + Self::DcBlocker => DspInnerParams::LENGTH, + Self::Oversampling => DspInnerParams::LENGTH + 1, + } + } +} + +impl EnumArray for DspParams { + type Array = [T; Self::LENGTH]; +} + +pub struct Dsp { + use_dc_blocker: Parameter, + oversample_amount: Parameter, + inner: Oversampled, + dc_blocker: DcBlocker, + dc_blocker_staging: Box<[Sample]>, +} + +impl DSPBlock<1, 1> for Dsp { + type Sample = Sample; + + fn process_block(&mut self, inputs: &[[Self::Sample; 1]], outputs: &mut [[Self::Sample; 1]]) { + let staging = slice_to_mono_block_mut(&mut self.dc_blocker_staging[..inputs.len()]); + + self.inner + .set_oversampling_amount(self.oversample_amount.get_value() as _); + self.inner.process_block(inputs, staging); + if self.use_dc_blocker.get_bool() { + self.dc_blocker.process_block(staging, outputs); + } else { + outputs.copy_from_slice(staging); + } + } + + fn set_samplerate(&mut self, samplerate: f32) { + DSPBlock::set_samplerate(&mut self.inner, samplerate); + DSPBlock::set_samplerate(&mut self.dc_blocker, samplerate); + } + + fn latency(&self) -> usize { + let inner_latency = DSPBlock::latency(&self.inner); + if self.use_dc_blocker.get_bool() { + inner_latency + DSPBlock::latency(&self.dc_blocker) + } else { + inner_latency + } + } + + fn reset(&mut self) { + DSPBlock::reset(&mut self.inner); + DSPBlock::reset(&mut self.dc_blocker); + } +} + +impl HasParameters for Dsp { + type Enum = DspParams; + + fn get_parameter(&self, param: Self::Enum) -> &Parameter { + match param { + DspParams::InnerParam(inner) => self.inner.get_parameter(inner), + DspParams::DcBlocker => &self.use_dc_blocker, + DspParams::Oversampling => &self.oversample_amount, + } + } +} + +pub fn create_dsp(samplerate: f32, oversample: usize, max_block_size: usize) -> Dsp { + let inner = + Oversample::new(oversample, max_block_size).with_dsp(samplerate, DspInner::new(samplerate)); + Dsp { + inner, + oversample_amount: Parameter::new(2.0), + use_dc_blocker: Parameter::new(1.0), + dc_blocker: DcBlocker::new(samplerate), + dc_blocker_staging: vec![Sample::zero(); max_block_size].into_boxed_slice(), + } +} diff --git a/examples/saturators/src/lib.rs b/examples/saturators/src/lib.rs new file mode 100644 index 0000000..d81e622 --- /dev/null +++ b/examples/saturators/src/lib.rs @@ -0,0 +1,183 @@ +use std::sync::Arc; + +use enum_map::Enum; +use nih_plug::prelude::*; +use nih_plug::util::db_to_gain; + +use dsp::Dsp; +use valib::contrib::nih_plug::{process_buffer_simd, NihParamsController}; +use valib::dsp::DSPBlock; + +use crate::dsp::{create_dsp, DspInnerParams, DspParams, SaturatorType}; + +mod dsp; + +const OVERSAMPLE: usize = 16; + +const MAX_BLOCK_SIZE: usize = 512; + +struct SaturatorsPlugin { + dsp: Dsp, + params: Arc>, +} + +impl Default for SaturatorsPlugin { + fn default() -> Self { + let dsp = create_dsp(44100.0, OVERSAMPLE, MAX_BLOCK_SIZE); + let params = NihParamsController::new(&dsp, |k, _| match k { + DspParams::InnerParam(DspInnerParams::Drive) => FloatParam::new( + "Drive", + 1.0, + FloatRange::Skewed { + min: db_to_gain(-12.0), + max: db_to_gain(40.0), + factor: FloatRange::gain_skew_factor(-12.0, 40.0), + }, + ) + .with_unit(" dB") + .with_value_to_string(formatters::v2s_f32_gain_to_db(2)) + .with_string_to_value(formatters::s2v_f32_gain_to_db()) + .into(), + DspParams::InnerParam(DspInnerParams::Saturator) => FloatParam::new( + "Saturator", + 0.0, + FloatRange::Linear { + min: 0.0, + max: SaturatorType::LENGTH as f32 - 1.0, + }, + ) + .with_step_size(1.0) + .with_value_to_string(Arc::new(|x| SaturatorType::from_usize(x as _).name())) + .into(), + DspParams::InnerParam(DspInnerParams::Feedback) => FloatParam::new( + "Feedback", + 0.0, + FloatRange::SymmetricalSkewed { + min: -2.0, + max: 2.0, + factor: 1.0, + center: 0.0, + }, + ) + .with_unit(" %") + .with_value_to_string(formatters::v2s_f32_percentage(2)) + .with_string_to_value(formatters::s2v_f32_percentage()) + .into(), + DspParams::InnerParam(DspInnerParams::AdaaLevel) => { + FloatParam::new("ADAA Level", 2.0, FloatRange::Linear { min: 0.0, max: 2.0 }) + .with_step_size(1.0) + .with_value_to_string(formatters::v2s_f32_rounded(0)) + .into() + } + DspParams::InnerParam(DspInnerParams::AdaaEpsilon) => FloatParam::new( + "ADAA Epsilon", + 1e-4, + FloatRange::Skewed { + min: 1e-10, + max: 1.0, + factor: 2.0, + }, + ) + .with_value_to_string(Arc::new(|f| format!("{f:.1e}"))) + .into(), + DspParams::Oversampling => FloatParam::new( + "Oversampling", + OVERSAMPLE as _, + FloatRange::Linear { + min: 2.0, + max: OVERSAMPLE as _, + }, + ) + .with_unit("x") + .with_step_size(1.0) + .into(), + DspParams::DcBlocker => { + FloatParam::new("Block DC", 1.0, FloatRange::Linear { min: 0.0, max: 1.0 }) + .with_step_size(1.0) + .with_value_to_string(Arc::new(|f| format!("{}", f > 0.5))) + .into() + } + }); + Self { + dsp, + params: Arc::new(params), + } + } +} + +impl Plugin for SaturatorsPlugin { + const NAME: &'static str = "Diode Clipper"; + const VENDOR: &'static str = "SolarLiner"; + const URL: &'static str = "https://github.com/SolarLiner/valib"; + const EMAIL: &'static str = "me@solarliner.dev"; + const VERSION: &'static str = "0.0.0"; + const AUDIO_IO_LAYOUTS: &'static [AudioIOLayout] = &[AudioIOLayout { + main_input_channels: Some(new_nonzero_u32(2)), + main_output_channels: Some(new_nonzero_u32(2)), + aux_input_ports: &[], + aux_output_ports: &[], + names: PortNames { + layout: Some("Stereo"), + main_input: Some("Input"), + main_output: Some("Output"), + aux_inputs: &[], + aux_outputs: &[], + }, + }]; + type SysExMessage = (); + type BackgroundTask = (); + + fn params(&self) -> Arc { + self.params.clone() + } + + fn initialize( + &mut self, + _audio_io_layout: &AudioIOLayout, + buffer_config: &BufferConfig, + _context: &mut impl InitContext, + ) -> bool { + self.dsp.set_samplerate(buffer_config.sample_rate); + true + } + + fn reset(&mut self) { + self.dsp.reset(); + } + + fn process( + &mut self, + buffer: &mut Buffer, + _aux: &mut AuxiliaryBuffers, + _context: &mut impl ProcessContext, + ) -> ProcessStatus { + _context.set_latency_samples(self.dsp.latency() as _); + process_buffer_simd::<_, _, MAX_BLOCK_SIZE>(&mut self.dsp, buffer); + ProcessStatus::Normal + } +} + +impl ClapPlugin for SaturatorsPlugin { + const CLAP_ID: &'static str = "com.github.SolarLiner.valib.Saturators"; + const CLAP_DESCRIPTION: Option<&'static str> = None; + const CLAP_MANUAL_URL: Option<&'static str> = None; + const CLAP_SUPPORT_URL: Option<&'static str> = None; + const CLAP_FEATURES: &'static [ClapFeature] = &[ + ClapFeature::AudioEffect, + ClapFeature::Filter, + ClapFeature::Stereo, + ]; +} + +impl Vst3Plugin for SaturatorsPlugin { + const VST3_CLASS_ID: [u8; 16] = *b"VaLibSaturatrSLN"; + const VST3_SUBCATEGORIES: &'static [Vst3SubCategory] = &[ + Vst3SubCategory::Fx, + Vst3SubCategory::Filter, + Vst3SubCategory::Distortion, + Vst3SubCategory::Stereo, + ]; +} + +nih_export_clap!(SaturatorsPlugin); +nih_export_vst3!(SaturatorsPlugin); diff --git a/examples/svfmixer/src/dsp.rs b/examples/svfmixer/src/dsp.rs index c301095..8096034 100644 --- a/examples/svfmixer/src/dsp.rs +++ b/examples/svfmixer/src/dsp.rs @@ -1,6 +1,7 @@ use enum_map::{enum_map, Enum, EnumMap}; use nalgebra::SMatrix; use nih_plug::util::db_to_gain_fast; + use valib::dsp::blocks::ModMatrix; use valib::dsp::parameter::{HasParameters, Parameter, SmoothedParam}; use valib::dsp::DSP; diff --git a/src/oversample/mod.rs b/src/oversample/mod.rs index 4ab6571..08a1daf 100644 --- a/src/oversample/mod.rs +++ b/src/oversample/mod.rs @@ -19,6 +19,7 @@ const CASCADE: usize = 16; #[derive(Debug, Clone)] pub struct Oversample { + max_factor: usize, os_factor: usize, os_buffer: Box<[T]>, pre_filter: Series<[Biquad; CASCADE]>, @@ -39,6 +40,7 @@ impl Oversample { ); let filters = Series([filter; CASCADE]); Self { + max_factor: os_factor, os_factor, os_buffer, pre_filter: filters.clone(), @@ -46,6 +48,23 @@ impl Oversample { } } + pub(crate) fn set_oversampling_amount(&mut self, amt: usize) { + assert!(amt <= self.max_factor); + self.os_factor = amt; + let new_biquad = Biquad::lowpass( + T::from_f64(2.0 * amt as f64).simd_recip(), + T::from_f64(0.707), + ); + for filt in self + .pre_filter + .0 + .iter_mut() + .chain(self.post_filter.0.iter_mut()) + { + filt.update_coefficients(&new_biquad); + } + } + pub fn latency(&self) -> usize { 2 * self.os_factor + DSP::latency(&self.pre_filter) + DSP::latency(&self.post_filter) } @@ -153,12 +172,7 @@ impl Oversampled { pub fn os_factor(&self) -> usize { self.oversampling.os_factor } -} -impl Oversampled -where - T: Scalar, -{ pub fn into_inner(self) -> P { self.inner } diff --git a/src/saturators/adaa.rs b/src/saturators/adaa.rs new file mode 100644 index 0000000..ecf977e --- /dev/null +++ b/src/saturators/adaa.rs @@ -0,0 +1,285 @@ +use num_traits::Zero; +use numeric_literals::replace_float_literals; +use simba::simd::SimdBool; + +use crate::dsp::DSP; +use crate::saturators::{Asinh, Blend, Clipper, Saturator, Tanh}; +use crate::Scalar; + +/// Trait for functions that have antiderivatives. +pub trait Antiderivative { + fn evaluate(&self, x: T) -> T; + + fn antiderivative(&self, x: T) -> T; +} + +pub trait Antiderivative2: Antiderivative { + fn antiderivative2(&self, x: T) -> T; +} + +impl Antiderivative for Tanh { + fn evaluate(&self, x: T) -> T { + x.simd_tanh() + } + + fn antiderivative(&self, x: T) -> T { + x.simd_cosh().simd_ln() + } +} + +impl Antiderivative for Asinh { + fn evaluate(&self, x: T) -> T { + x.simd_asinh() + } + + fn antiderivative(&self, x: T) -> T { + let x0 = x * x + T::one(); + x * x.simd_asinh() - x0.simd_sqrt() + } +} + +impl Antiderivative2 for Asinh { + #[replace_float_literals(T::from_f64(literal))] + fn antiderivative2(&self, x: T) -> T { + let x0 = x * x + 1.0; + let x1 = 2.0 * x * x - 1.0; + let x2 = -x * 3.0 * x0.simd_sqrt() / 4.0; + let x3 = x1 * x.simd_asinh() / 4.0; + x2 + x3 + } +} + +impl Antiderivative for Clipper { + #[replace_float_literals(T::from_f64(literal))] + fn evaluate(&self, x: T) -> T { + x.simd_clamp(-1.0, 1.0) + } + + #[replace_float_literals(T::from_f64(literal))] + fn antiderivative(&self, x: T) -> T { + let lower = -x; + let upper = x; + let middle = (0.5) * (x * x + T::one()); + let is_lower = x.simd_lt(-T::one()); + let is_higher = x.simd_gt(T::one()); + lower.select(is_lower, upper.select(is_higher, middle)) + } +} + +impl Antiderivative2 for Clipper { + #[replace_float_literals(T::from_f64(literal))] + fn antiderivative2(&self, x: T) -> T { + let lower = -0.5 * x * (x - 2.0); + let upper = x * x / 2.0 * x * T::simd_recip(3.0); + let middle = T::simd_recip(6.0) * (x * x * x + 9.0 * x + 1.0); + let is_lower = x.simd_lt(-1.0); + let is_higher = x.simd_gt(1.0); + lower.select(is_lower, upper.select(is_higher, middle)) + } +} + +impl> Antiderivative for Blend { + fn evaluate(&self, x: T) -> T { + x + (self.inner.evaluate(x) - x) * self.amt + } + + #[replace_float_literals(T::from_f64(literal))] + fn antiderivative(&self, x: T) -> T { + let ad_x = 0.5 * x * x; + self.inner.antiderivative(x) * self.amt + ad_x * (1.0 + self.amt) + } +} + +impl> Antiderivative2 for Blend { + #[replace_float_literals(T::from_f64(literal))] + fn antiderivative2(&self, x: T) -> T { + let ad_x = x + x * x * x / 6.0; + self.inner.antiderivative2(x) * self.amt + ad_x * (1.0 + self.amt) + } +} + +#[derive(Debug, Copy, Clone)] +pub struct Adaa { + pub epsilon: T, + pub inner: S, + memory: [T; ORDER], +} + +impl Adaa { + pub fn new(inner: S) -> Self { + Self { + epsilon: T::from_f64(1e-3), + inner, + memory: [T::zero(); ORDER], + } + } +} + +impl Default for Adaa { + fn default() -> Self { + Self::new(S::default()) + } +} + +impl> Adaa { + #[replace_float_literals(T::from_f64(literal))] + pub fn next_sample_immutable(&self, x: T) -> T { + let den = x - self.memory[0]; + let below = den.simd_abs().simd_lt(self.epsilon); + below.if_else( + || self.inner.evaluate((x + self.memory[0]) / 2.0), + || { + let num = self.inner.antiderivative(x) - self.inner.antiderivative(self.memory[0]); + num / den + }, + ) + } + + pub fn commit_sample(&mut self, x: T) { + self.memory = [x]; + } + + pub fn next_sample(&mut self, x: T) -> T { + let y = self.next_sample_immutable(x); + self.commit_sample(x); + y + } +} + +impl> Adaa { + #[replace_float_literals(T::from_f64(literal))] + pub fn next_sample_immutable(&self, x: T) -> T { + let [x1, x2] = self.memory; + let den1 = x - x1; + let den2 = x1 - x2; + let den3 = x - x2; + let below1 = den1.simd_abs().simd_lt(self.epsilon); + let below2 = den2.simd_abs().simd_lt(self.epsilon); + let below3 = den3.simd_abs().simd_lt(self.epsilon); + (below1 | below2 | below3).if_else( + || self.inner.evaluate((x + x1) / 2.0), + || { + let num1 = self.inner.antiderivative(x) - self.inner.antiderivative2(x1); + let num2 = self.inner.antiderivative2(x1) - self.inner.antiderivative2(x2); + den3.simd_recip() * (num1 / den1 + num2 / den2) + }, + ) + } + + pub fn commit_sample(&mut self, x: T) { + self.memory.swap(0, 1); + self.memory[0] = x; + } + + pub fn next_sample(&mut self, x: T) -> T { + let y = self.next_sample_immutable(x); + self.commit_sample(x); + y + } +} + +impl + Saturator> Saturator for Adaa { + fn saturate(&self, x: T) -> T { + self.next_sample_immutable(x) + } + + fn update_state(&mut self, x: T, y: T) { + self.commit_sample(x); + self.inner.update_state(x, y); + } + + fn sat_diff(&self, x: T) -> T { + self.inner.sat_diff(x) + } +} + +impl> DSP<1, 1> for Adaa { + type Sample = T; + + fn process(&mut self, [x]: [Self::Sample; 1]) -> [Self::Sample; 1] { + [self.next_sample(x)] + } +} + +impl + Saturator> Saturator for Adaa { + #[replace_float_literals(T::from_f64(literal))] + fn saturate(&self, x: T) -> T { + self.next_sample_immutable(x) + } + + fn update_state(&mut self, x: T, y: T) { + self.commit_sample(x); + self.inner.update_state(x, y); + } + + fn sat_diff(&self, x: T) -> T { + self.inner.sat_diff(x) + } +} + +impl> DSP<1, 1> for Adaa { + type Sample = T; + + fn process(&mut self, [x]: [Self::Sample; 1]) -> [Self::Sample; 1] { + let y = self.next_sample(x); + [y] + } + + fn latency(&self) -> usize { + 1 + } + + fn reset(&mut self) { + self.memory.fill_with(T::zero); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use rstest::rstest; + use std::f64::consts::TAU; + + #[rstest] + #[case("tanh", Adaa::<_, Tanh, 1>::default())] + #[case("asinh", Adaa::<_, Asinh, 1>::default())] + #[case("clipper", Adaa::<_, Clipper, 1>::default())] + fn test_adaa1 + Saturator>( + #[case] name: &str, + #[case] mut adaa: Adaa, + ) { + let samplerate = 100.0; + let f = 10.0; + let input: [_; 100] = + std::array::from_fn(|i| i as f64 / samplerate).map(|t| 3.0 * f64::sin(TAU * f * t)); + let output = input.map(|x| { + let y = adaa.saturate(x); + adaa.update_state(x, y); + y + }); + + let name = format!("test_adaa1_{name}"); + insta::assert_csv_snapshot!(name, &output as &[_], { "[]" => insta::rounded_redaction(3) }) + } + + #[rstest] + #[case("clipper", Adaa::<_, Clipper, 2>::default())] + #[case("asinh", Adaa::<_, Asinh, 2>::default())] + fn test_adaa2 + Saturator>( + #[case] name: &str, + #[case] mut adaa: Adaa, + ) { + let samplerate = 100.0; + let f = 10.0; + let input: [_; 100] = + std::array::from_fn(|i| i as f64 / samplerate).map(|t| 3.0 * f64::sin(TAU * f * t)); + let output = input.map(|x| { + let y = adaa.saturate(x); + adaa.update_state(x, y); + y + }); + + let name = format!("test_adaa2_{name}",); + insta::assert_csv_snapshot!(name, &output as &[_], { "[]" => insta::rounded_redaction(3) }) + } +} diff --git a/src/saturators/clippers/mod.rs b/src/saturators/clippers/mod.rs index bd64c6e..13d2479 100644 --- a/src/saturators/clippers/mod.rs +++ b/src/saturators/clippers/mod.rs @@ -1,5 +1,3 @@ -mod diode_clipper_model_data; - use std::fmt; use nalgebra::{SMatrix, SVector}; @@ -10,6 +8,10 @@ use simba::simd::SimdBool; use crate::{dsp::DSP, math::newton_rhapson_tol_max_iter}; use crate::{math::RootEq, saturators::Saturator, Scalar}; +use super::adaa::Antiderivative; + +mod diode_clipper_model_data; + #[derive(Debug, Copy, Clone)] pub struct DiodeClipper { pub isat: T, @@ -156,6 +158,38 @@ impl DiodeClipperModel { } } +impl Antiderivative for DiodeClipperModel { + fn evaluate(&self, x: T) -> T { + self.eval(x) / (self.si * self.so) + } + + #[replace_float_literals(T::from_f64(literal))] + fn antiderivative(&self, x: T) -> T { + let cx = self.si * x; + let lower = cx.simd_lt(-self.a); + lower.if_else( + || { + let x0 = self.a + cx - 1.0; + let num = (self.a - 1.0) * cx + x0 * T::simd_ln(-x0); + let den = self.si * self.si; + -num / den + }, + || { + let higher = cx.simd_gt(self.b); + higher.if_else( + || { + let x0 = -self.b + cx + 1.0; + let num = (self.b - 1.0) * cx + x0 * T::simd_ln(x0); + let den = self.si * self.si; + num / den + }, + || x * x / 2.0, + ) + }, + ) / 2.0 + } +} + impl Default for DiodeClipperModel { fn default() -> Self { Self::new_silicon(1, 1) @@ -182,9 +216,10 @@ impl Saturator for DiodeClipperModel { mod tests { use std::hint; - use crate::dsp::DSP; use simba::simd::SimdValue; + use crate::{dsp::DSP, saturators::adaa::Adaa}; + use super::{DiodeClipper, DiodeClipperModel}; fn dc_sweep(name: &str, mut dsp: impl DSP<1, 1, Sample = f32>) { @@ -200,10 +235,10 @@ mod tests { fn drive_test(name: &str, mut dsp: impl DSP<1, 1, Sample = f32>) { let sine_it = (0..).map(|i| i as f64 / 10.).map(f64::sin); let amp = (0..5000).map(|v| v as f64 / 5000. * 500.); - let output = sine_it.zip(amp).map(|(a, b)| a * b).map(|v| { - let out = dsp.process([v as f32])[0]; - hint::black_box(out) - }); + let output = sine_it + .zip(amp) + .map(|(a, b)| a * b) + .map(|v| hint::black_box(dsp.process([v as f32])[0])); let results = Vec::from_iter(output.map(|v| v.extract(0))); let full_name = format!("{name}/drive_test"); insta::assert_csv_snapshot!(&*full_name, results, { "[]" => insta::rounded_redaction(4) }); diff --git a/src/saturators/mod.rs b/src/saturators/mod.rs index 0def44e..b21ff1e 100644 --- a/src/saturators/mod.rs +++ b/src/saturators/mod.rs @@ -1,10 +1,12 @@ use crate::dsp::DSP; use numeric_literals::replace_float_literals; +use crate::saturators::adaa::{Antiderivative, Antiderivative2}; use clippers::DiodeClipperModel; use crate::Scalar; +pub mod adaa; pub mod clippers; #[allow(unused_variables)] @@ -54,6 +56,20 @@ impl Saturator for Tanh { } } +#[derive(Debug, Copy, Clone, Eq, PartialEq, Default)] +pub struct Asinh; + +impl Saturator for Asinh { + fn saturate(&self, x: T) -> T { + x.simd_asinh() + } + + fn sat_diff(&self, x: T) -> T { + let x0 = x * x + T::one(); + x0.simd_sqrt().simd_recip() + } +} + #[derive(Debug, Copy, Clone, Default, Eq, PartialEq)] pub struct Clipper; @@ -108,6 +124,7 @@ impl Default for Blend { pub enum Dynamic { Linear, Tanh, + Asinh, HardClipper, DiodeClipper(DiodeClipperModel), SoftClipper(Blend>), @@ -120,6 +137,7 @@ impl Saturator for Dynamic { Self::Linear => Linear.saturate(x), Self::HardClipper => Clipper.saturate(x), Self::Tanh => Tanh.saturate(x), + Self::Asinh => Asinh.saturate(x), Self::DiodeClipper(clip) => clip.saturate(x), Self::SoftClipper(clip) => clip.saturate(x), } @@ -130,6 +148,7 @@ impl Saturator for Dynamic { match self { Self::Linear => Linear.sat_diff(x), Self::HardClipper => Clipper.sat_diff(x), + Self::Asinh => Asinh.sat_diff(x), Self::Tanh => Tanh.sat_diff(x), Self::DiodeClipper(clip) => clip.sat_diff(x), Self::SoftClipper(clip) => clip.sat_diff(x), diff --git a/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_asinh.snap b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_asinh.snap new file mode 100644 index 0000000..fb44ad6 --- /dev/null +++ b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_asinh.snap @@ -0,0 +1,104 @@ +--- +source: src/saturators/adaa.rs +expression: "&output as &[_]" +--- +0.0 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 +-0.75 +0.75 +1.566 +1.771 +1.566 +0.75 +-0.75 +-1.566 +-1.771 +-1.566 diff --git a/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_clipper.snap b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_clipper.snap new file mode 100644 index 0000000..38ad48d --- /dev/null +++ b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_clipper.snap @@ -0,0 +1,104 @@ +--- +source: src/saturators/adaa.rs +expression: "&output as &[_]" +--- +0.0 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 +-0.716 +0.716 +1.0 +1.0 +1.0 +0.716 +-0.716 +-1.0 +-1.0 +-1.0 diff --git a/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_tanh.snap b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_tanh.snap new file mode 100644 index 0000000..34fab14 --- /dev/null +++ b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa1_tanh.snap @@ -0,0 +1,104 @@ +--- +source: src/saturators/adaa.rs +expression: "&output as &[_]" +--- +0.0 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 +-0.623 +0.623 +0.976 +0.993 +0.976 +0.623 +-0.623 +-0.976 +-0.993 +-0.976 diff --git a/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa2_asinh.snap b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa2_asinh.snap new file mode 100644 index 0000000..526f8b1 --- /dev/null +++ b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa2_asinh.snap @@ -0,0 +1,104 @@ +--- +source: src/saturators/adaa.rs +expression: "&output as &[_]" +--- +0.0 +0.795 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 +0.012 +-0.1 +0.768 +1.771 +1.574 +-0.41 +0.203 +0.537 +-1.771 +-1.574 diff --git a/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa2_clipper.snap b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa2_clipper.snap new file mode 100644 index 0000000..f317d30 --- /dev/null +++ b/src/saturators/snapshots/valib__saturators__adaa__tests__test_adaa2_clipper.snap @@ -0,0 +1,104 @@ +--- +source: src/saturators/adaa.rs +expression: "&output as &[_]" +--- +0.0 +0.882 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0 +1.918 +0.817 +0.772 +1.0 +1.0 +-1.033 +0.137 +1.292 +-1.0 +-1.0