summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormtolly <>2014-04-27 19:35:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2014-04-27 19:35:00 (GMT)
commitc7ab62a760dbba543cbeffd2ed4906fbe343b498 (patch)
treeb5b7ec25d00a1dc7fe4ba7fde1557f1fc383a944
version 0.10.1
-rw-r--r--LICENSE675
-rw-r--r--Setup.hs2
-rw-r--r--rubberband.cabal40
-rw-r--r--src/Sound/RubberBand.hs7
-rw-r--r--src/Sound/RubberBand/Nice.hs461
-rw-r--r--src/Sound/RubberBand/Option.hs459
-rw-r--r--src/Sound/RubberBand/Raw.chs142
7 files changed, 1786 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..12fc7e0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,675 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
diff --git a/Setup.hs b/Setup.hs
new file mode 100644
index 0000000..9a994af
--- /dev/null
+++ b/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/rubberband.cabal b/rubberband.cabal
new file mode 100644
index 0000000..242897e
--- /dev/null
+++ b/rubberband.cabal
@@ -0,0 +1,40 @@
+name: rubberband
+version: 0.1
+synopsis: Binding to the C++ audio stretching library Rubber Band
+
+description: Rubber Band is a high quality software library for audio
+ time-stretching and pitch-shifting. It permits you to
+ change the tempo and pitch of an audio stream or recording
+ dynamically and independently of one another.
+ .
+ Rubber Band is open source software under the GNU General
+ Public License. If you want to distribute it in a
+ proprietary commercial application, you need to buy a
+ license: <http://breakfastquay.com/rubberband/license.html>
+ .
+ This is a binding to Rubber Band library v1.8.1.
+
+homepage: http://breakfastquay.com/rubberband/
+license: GPL-3
+license-file: LICENSE
+author: Michael Tolly
+maintainer: miketolly@gmail.com
+category: Sound
+build-type: Simple
+cabal-version: >=1.10
+
+library
+ exposed-modules: Sound.RubberBand
+ Sound.RubberBand.Raw
+ Sound.RubberBand.Nice
+ Sound.RubberBand.Option
+ build-depends: base >= 4.6 && < 4.8, vector >= 0.10.9 && < 0.11
+ hs-source-dirs: src
+ default-language: Haskell2010
+ includes: rubberband/rubberband-c.h
+ extra-libraries: rubberband
+ ghc-options: -Wall
+
+Source-Repository head
+ type: git
+ location: git://github.com/mtolly/rubberband.git
diff --git a/src/Sound/RubberBand.hs b/src/Sound/RubberBand.hs
new file mode 100644
index 0000000..a791279
--- /dev/null
+++ b/src/Sound/RubberBand.hs
@@ -0,0 +1,7 @@
+module Sound.RubberBand
+( module Sound.RubberBand.Nice
+, module Sound.RubberBand.Option
+) where
+
+import Sound.RubberBand.Nice
+import Sound.RubberBand.Option
diff --git a/src/Sound/RubberBand/Nice.hs b/src/Sound/RubberBand/Nice.hs
new file mode 100644
index 0000000..2c140a9
--- /dev/null
+++ b/src/Sound/RubberBand/Nice.hs
@@ -0,0 +1,461 @@
+{- |
+
+Threading notes for real-time applications:
+
+Multiple instances of 'Stretcher' may be created and used
+in separate threads concurrently. However, for any single instance
+of 'Stretcher', you may not call 'process' more than once
+concurrently, and you may not change the time or pitch ratio while
+a 'process' call is being executed (if the stretcher was created in
+"real-time mode"; in "offline mode" you can't change the ratios
+during use anyway).
+
+So you can run 'process' in its own thread if you like, but if you
+want to change ratios dynamically from a different thread, you will
+need some form of mutex in your code. Changing the time or pitch
+ratio is real-time safe except in extreme circumstances, so for
+most applications that may change these dynamically it probably
+makes most sense to do so from the same thread as calls 'process',
+even if that is a real-time thread.
+
+Differences from "Sound.RubberBand.Raw":
+
+ * The 'Stretcher' object is garbage-collected by Haskell.
+
+ * The 'study', 'process', and 'retrieve' functions use storable
+ 'Vector's instead of raw pointers.
+
+ * Some error checking is done in cases like giving arrays of different
+ lengths to 'study' and 'process', or giving a different number of arrays
+ from how many channels the 'Stretcher' was constructed with.
+
+-}
+module Sound.RubberBand.Nice
+
+( Stretcher()
+
+, new, reset
+, SampleRate, NumChannels, TimeRatio, PitchScale
+, withRaw
+
+, setTimeRatio, setPitchScale
+, getTimeRatio, getPitchScale
+, getLatency
+
+, setTransientsOption
+, setDetectorOption
+, setPhaseOption
+, setFormantOption
+, setPitchOption
+
+, setExpectedInputDuration
+, setMaxProcessSize
+, getSamplesRequired
+, setKeyFrameMap
+
+, study, process
+, available, retrieve
+
+, getChannelCount
+
+, calculateStretch
+
+, setDebugLevel
+, setDefaultDebugLevel
+
+) where
+
+import qualified Sound.RubberBand.Raw as Raw
+import Sound.RubberBand.Raw (SampleRate, NumChannels, TimeRatio, PitchScale)
+import Sound.RubberBand.Option
+
+import Foreign
+ (Ptr, ForeignPtr, newForeignPtr, withForeignPtr, finalizerFree, castPtr)
+import Control.Applicative ((<$>))
+import Foreign.Marshal.Array (withArray, withArrayLen, mallocArray)
+import qualified Data.Vector.Storable as V
+import Foreign.C.Types (CFloat)
+import Control.Monad (guard, forM, replicateM)
+
+-- | An audio stretching machine. This object is garbage-collected on the
+-- Haskell side, so it will be deleted automatically.
+newtype Stretcher = Stretcher (ForeignPtr Raw.Stretcher)
+ deriving (Eq, Ord, Show)
+
+-- | Allows you to use the functions in "Sound.RubberBand.Nice" if needed.
+withRaw :: Stretcher -> (Raw.Stretcher -> IO a) -> IO a
+withRaw (Stretcher fp) f = withForeignPtr fp $ f . Raw.Stretcher
+
+{- |
+Construct a time and pitch stretcher object to run at the given
+sample rate, with the given number of channels. Processing
+options and the time and pitch scaling ratios may be provided.
+The time and pitch ratios may be changed after construction,
+but most of the options may not. See the "Sound.RubberBand.Option"
+documentation for more details.
+-}
+new :: SampleRate -> NumChannels -> Options -> TimeRatio -> PitchScale ->
+ IO Stretcher
+new a b c d e = do
+ Raw.Stretcher p <- Raw.new a b c d e
+ Stretcher <$> newForeignPtr Raw.p_delete p
+
+{- |
+Reset the stretcher's internal buffers. The stretcher should
+subsequently behave as if it had just been constructed
+(although retaining the current time and pitch ratio).
+-}
+reset :: Stretcher -> IO ()
+reset s = withRaw s Raw.reset
+
+{- |
+Set the time ratio for the stretcher. This is the ratio of
+stretched to unstretched duration -- not tempo. For example, a
+ratio of 2.0 would make the audio twice as long (i.e. halve the
+tempo); 0.5 would make it half as long (i.e. double the tempo);
+1.0 would leave the duration unaffected.
+
+If the stretcher was constructed in 'Offline' mode, the time
+ratio is fixed throughout operation; this function may be
+called any number of times between construction (or a call to
+'reset') and the first call to 'study' or 'process', but may
+not be called after 'study' or 'process' has been called.
+
+If the stretcher was constructed in 'RealTime' mode, the time
+ratio may be varied during operation; this function may be
+called at any time, so long as it is not called concurrently
+with 'process'. You should either call this function from the
+same thread as 'process', or provide your own mutex or similar
+mechanism to ensure that 'setTimeRatio' and 'process' cannot be
+run at once (there is no internal mutex for this purpose).
+-}
+setTimeRatio :: Stretcher -> TimeRatio -> IO ()
+setTimeRatio s d = withRaw s $ \r -> Raw.setTimeRatio r d
+
+{- |
+Set the pitch scaling ratio for the stretcher. This is the
+ratio of target frequency to source frequency. For example, a
+ratio of 2.0 would shift up by one octave; 0.5 down by one
+octave; or 1.0 leave the pitch unaffected.
+
+To put this in musical terms, a pitch scaling ratio
+corresponding to a shift of @s@ equal-tempered semitones (where @s@
+is positive for an upwards shift and negative for downwards) is
+@2 ** (s / 12)@.
+
+If the stretcher was constructed in Offline mode, the pitch
+scaling ratio is fixed throughout operation; this function may
+be called any number of times between construction (or a call
+to 'reset') and the first call to 'study' or 'process', but may
+not be called after 'study' or 'process' has been called.
+
+If the stretcher was constructed in RealTime mode, the pitch
+scaling ratio may be varied during operation; this function may
+be called at any time, so long as it is not called concurrently
+with 'process'. You should either call this function from the
+same thread as 'process', or provide your own mutex or similar
+mechanism to ensure that setPitchScale and 'process' cannot be
+run at once (there is no internal mutex for this purpose).
+-}
+setPitchScale :: Stretcher -> PitchScale -> IO ()
+setPitchScale s d = withRaw s $ \r -> Raw.setPitchScale r d
+
+{- |
+Return the last time ratio value that was set (either on
+construction or with 'setTimeRatio').
+-}
+getTimeRatio :: Stretcher -> IO TimeRatio
+getTimeRatio s = withRaw s Raw.getTimeRatio
+
+{- |
+Return the last pitch scaling ratio value that was set (either
+on construction or with 'setPitchScale').
+-}
+getPitchScale :: Stretcher -> IO PitchScale
+getPitchScale s = withRaw s Raw.getPitchScale
+
+{- |
+Return the processing latency of the stretcher. This is the
+number of audio samples that one would have to discard at the
+start of the output in order to ensure that the resulting audio
+aligned with the input audio at the start. In 'Offline' mode,
+latency is automatically adjusted for and the result is zero.
+In 'RealTime' mode, the latency may depend on the time and pitch
+ratio and other options.
+-}
+getLatency :: Stretcher -> IO Int
+getLatency s = withRaw s Raw.getLatency
+
+{- |
+Change a 'Transients' configuration setting. This may be
+called at any time in 'RealTime' mode. It may not be called in
+'Offline' mode (for which the 'Transients' option is fixed on
+construction).
+-}
+setTransientsOption :: Stretcher -> Transients -> IO ()
+setTransientsOption s o = withRaw s $ \r -> Raw.setTransientsOption r o
+
+{- |
+Change a 'Detector' configuration setting. This may be
+called at any time in 'RealTime' mode. It may not be called in
+'Offline' mode (for which the 'Detector' option is fixed on
+construction).
+-}
+setDetectorOption :: Stretcher -> Detector -> IO ()
+setDetectorOption s o = withRaw s $ \r -> Raw.setDetectorOption r o
+
+{- |
+Change a 'Phase' configuration setting. This may be
+called at any time in any mode.
+
+Note that if running multi-threaded in 'Offline' mode, the change
+may not take effect immediately if processing is already under
+way when this function is called.
+-}
+setPhaseOption :: Stretcher -> Phase -> IO ()
+setPhaseOption s o = withRaw s $ \r -> Raw.setPhaseOption r o
+
+{- |
+Change a 'Formant' configuration setting. This may be
+called at any time in any mode.
+
+Note that if running multi-threaded in 'Offline' mode, the change
+may not take effect immediately if processing is already under
+way when this function is called.
+-}
+setFormantOption :: Stretcher -> Formant -> IO ()
+setFormantOption s o = withRaw s $ \r -> Raw.setFormantOption r o
+
+{- |
+Change a 'Pitch' configuration setting. This may be
+called at any time in 'RealTime' mode. It may not be called in
+'Offline' mode (for which the 'Pitch' option is fixed on
+construction).
+-}
+setPitchOption :: Stretcher -> Pitch -> IO ()
+setPitchOption s o = withRaw s $ \r -> Raw.setPitchOption r o
+
+{- |
+Tell the 'Stretcher' exactly how many input samples it will
+receive. This is only useful in 'Offline' mode, when it allows
+the 'Stretcher' to ensure that the number of output samples is
+exactly correct. In 'RealTime' mode no such guarantee is
+possible and this value is ignored.
+-}
+setExpectedInputDuration :: Stretcher -> Int -> IO ()
+setExpectedInputDuration s n =
+ withRaw s $ \r -> Raw.setExpectedInputDuration r n
+
+{- |
+Tell the 'Stretcher' the maximum number of sample frames that you
+will ever be passing in to a single 'process' call. If you
+don't call this, the 'Stretcher' will assume that you are calling
+'getSamplesRequired' at each cycle and are never passing more
+samples than are suggested by that function.
+
+If your application has some external constraint that means you
+prefer a fixed block size, then your normal mode of operation
+would be to provide that block size to this function; to loop
+calling 'process' with that size of block; after each call to
+'process', test whether output has been generated by calling
+'available'; and, if so, call 'retrieve' to obtain it. See
+'getSamplesRequired' for a more suitable operating mode for
+applications without such external constraints.
+
+This function may not be called after the first call to 'study'
+or 'process'.
+
+Note that this value is only relevant to 'process', not to
+'study' (to which you may pass any number of samples at a time,
+and from which there is no output).
+-}
+setMaxProcessSize :: Stretcher -> Int -> IO ()
+setMaxProcessSize s n = withRaw s $ \r -> Raw.setMaxProcessSize r n
+
+{- |
+Ask the stretcher how many audio sample frames should be
+provided as input in order to ensure that some more output
+becomes available.
+
+If your application has no particular constraint on processing
+block size and you are able to provide any block size as input
+for each cycle, then your normal mode of operation would be to
+loop querying this function; providing that number of samples
+to 'process'; and reading the output using 'available' and
+'retrieve'. See 'setMaxProcessSize' for a more suitable
+operating mode for applications that do have external block
+size constraints.
+
+Note that this value is only relevant to 'process', not to
+'study' (to which you may pass any number of samples at a time,
+and from which there is no output).
+-}
+getSamplesRequired :: Stretcher -> IO Int
+getSamplesRequired s = withRaw s Raw.getSamplesRequired
+
+{- |
+Provide a set of mappings from "before" to "after" sample
+numbers so as to enforce a particular stretch profile. The
+argument is a map from audio sample frame number in the source
+material, to the corresponding sample frame number in the
+stretched output. The mapping should be for key frames only,
+with a "reasonable" gap between mapped samples.
+
+This function cannot be used in 'RealTime' mode.
+
+This function may not be called after the first call to
+'process'. It should be called after the time and pitch ratios
+have been set; the results of changing the time and pitch
+ratios after calling this function are undefined. Calling
+'reset' will clear this mapping.
+
+The key frame map only affects points within the material; it
+does not determine the overall stretch ratio (that is, the
+ratio between the output material's duration and the source
+material's duration). You need to provide this ratio
+separately to 'setTimeRatio', otherwise the results may be
+truncated or extended in unexpected ways regardless of the
+extent of the frame numbers found in the key frame map.
+-}
+setKeyFrameMap :: Stretcher -> [(Int, Int)] -> IO ()
+setKeyFrameMap s pairs = withRaw s $ \r ->
+ withArray (map (fromIntegral . fst) pairs) $ \p1 ->
+ withArray (map (fromIntegral . snd) pairs) $ \p2 ->
+ Raw.setKeyFrameMap r (length pairs) p1 p2
+
+unsafeWiths :: (V.Storable e) => [V.Vector e] -> ([Ptr e] -> IO a) -> IO a
+unsafeWiths [] f = f []
+unsafeWiths (x : xs) f =
+ V.unsafeWith x $ \p ->
+ unsafeWiths xs $ \ps ->
+ f $ p : ps
+
+getUniform :: (Eq a) => [a] -> Maybe a
+getUniform (x : xs) = guard (all (== x) xs) >> Just x
+getUniform [] = Nothing
+
+-- | Ugly, but needed to share the code for 'study' and 'process'.
+studyProcess ::
+ String -> (Raw.Stretcher -> Ptr (Ptr CFloat) -> Int -> Bool -> IO ()) ->
+ Stretcher -> [V.Vector Float] -> Bool -> IO ()
+studyProcess fname f s chans final = do
+ samples <- case getUniform $ map V.length chans of
+ Nothing -> error $ fname ++ ": " ++ if null chans
+ then "no input arrays given"
+ else "input arrays have differing lengths"
+ Just sam -> return sam
+ unsafeWiths chans $ \pfs ->
+ withArrayLen pfs $ \len ppf -> do
+ numchans <- getChannelCount s
+ if numchans == len
+ then withRaw s $ \r -> f r (castPtr ppf) samples final
+ else error $ unwords
+ [ fname ++ ": passed"
+ , show len
+ , "channels but Stretcher needs"
+ , show numchans
+ ]
+
+{- |
+Provide a block of "samples" sample frames for the stretcher to
+study and calculate a stretch profile from.
+
+This is only meaningful in 'Offline' mode, and is required if
+running in that mode. You should pass the entire input through
+'study' before any 'process' calls are made, as a sequence of
+blocks in individual 'study' calls, or as a single large block.
+
+The input list should be de-interleaved audio data with one float vector
+per channel. The 'Bool' should be 'True' if this is the last block of data
+that will be provided to 'study' before the first 'process' call.
+-}
+study :: Stretcher -> [V.Vector Float] -> Bool -> IO ()
+study = studyProcess "study" Raw.study
+
+{- |
+Provide a block of sample frames for processing.
+See also 'getSamplesRequired' and 'setMaxProcessSize'.
+
+Set the 'Bool' to 'True' if this is the last block of input data.
+-}
+process :: Stretcher -> [V.Vector Float] -> Bool -> IO ()
+process = studyProcess "process" Raw.process
+
+{- |
+Ask the stretcher how many audio sample frames of output data
+are available for reading (via 'retrieve').
+
+This function returns @Just 0@ if no frames are available: this
+usually means more input data needs to be provided, but if the
+stretcher is running in threaded mode it may just mean that not
+enough data has yet been processed. Call 'getSamplesRequired'
+to discover whether more input is needed.
+
+This function returns @Nothing@ if all data has been fully processed
+and all output read, and the stretch process is now finished.
+-}
+available :: Stretcher -> IO (Maybe Int)
+available s = withRaw s $ \r -> do
+ i <- Raw.available r
+ return $ guard (i /= (-1)) >> Just i
+
+retrieveInto :: Stretcher -> [Ptr Float] -> Int -> IO Int
+retrieveInto s pfs samples = do
+ numchans <- getChannelCount s
+ withArrayLen pfs $ \len ppf ->
+ if len == numchans
+ then withRaw s $ \r -> Raw.retrieve r (castPtr ppf) samples
+ else error $ unwords
+ [ "retrieveInto: passed"
+ , show len
+ , "channels but Stretcher needs"
+ , show numchans
+ ]
+
+{- |
+Obtain some processed output data from the stretcher. Up to
+the given 'Int' of samples will be in the output vectors (one per
+channel for de-interleaved audio data), though it may be
+less than the given number.
+-}
+retrieve :: Stretcher -> Int -> IO [V.Vector Float]
+retrieve s samples = do
+ numchans <- getChannelCount s
+ ps <- replicateM numchans $ mallocArray samples
+ actual <- retrieveInto s ps samples
+ forM ps $ \p -> do
+ fp <- newForeignPtr finalizerFree $ castPtr p
+ return $ V.unsafeFromForeignPtr0 fp actual
+
+{- |
+Return the number of channels this stretcher was constructed with.
+-}
+getChannelCount :: Stretcher -> IO Int
+getChannelCount s = withRaw s Raw.getChannelCount
+
+{- |
+Force the stretcher to calculate a stretch profile. Normally
+this happens automatically for the first 'process' call in
+offline mode.
+
+This function is provided for diagnostic purposes only.
+-}
+calculateStretch :: Stretcher -> IO ()
+calculateStretch s = withRaw s Raw.calculateStretch
+
+{- |
+Set the level of debug output. The value may be from 0 (errors
+only) to 3 (very verbose, with audible ticks in the output at
+phase reset points). The default is whatever has been set
+using 'setDefaultDebugLevel', or 0 if that function has not been
+called.
+-}
+setDebugLevel :: Stretcher -> Int -> IO ()
+setDebugLevel s n = withRaw s $ \r -> Raw.setDebugLevel r n
+
+{- |
+Set the default level of debug output for subsequently
+constructed stretchers.
+-}
+setDefaultDebugLevel :: Int -> IO ()
+setDefaultDebugLevel = Raw.setDefaultDebugLevel
diff --git a/src/Sound/RubberBand/Option.hs b/src/Sound/RubberBand/Option.hs
new file mode 100644
index 0000000..2bef7dc
--- /dev/null
+++ b/src/Sound/RubberBand/Option.hs
@@ -0,0 +1,459 @@
+module Sound.RubberBand.Option
+( Options(..)
+
+, Process(..)
+, Stretch(..)
+, Transients(..)
+, Detector(..)
+, Phase(..)
+, Threading(..)
+, Window(..)
+, Smoothing(..)
+, Formant(..)
+, Pitch(..)
+, Channels(..)
+
+, Option(..)
+
+, setOption
+, getOption
+
+, toOptions
+, fromOptions
+
+, defaultOptions
+, percussiveOptions
+) where
+
+import Data.Bits ((.|.), (.&.), complement)
+import Data.Maybe (fromMaybe)
+
+{- |
+Processing options for the timestretcher. The preferred
+options should normally be set when calling 'Sound.RubberBand.Nice.new'.
+-}
+data Options = Options
+ { oProcess :: Process
+ , oStretch :: Stretch
+ , oTransients :: Transients
+ , oDetector :: Detector
+ , oPhase :: Phase
+ , oThreading :: Threading
+ , oWindow :: Window
+ , oSmoothing :: Smoothing
+ , oFormant :: Formant
+ , oPitch :: Pitch
+ , oChannels :: Channels
+ } deriving (Eq, Ord, Show, Read)
+
+{- |
+'Process' flags determine how the timestretcher
+will be invoked. These options may not be changed after
+construction.
+
+The 'Process' setting is likely to depend on your architecture:
+non-real-time operation on seekable files: 'Offline'; real-time
+or streaming operation: 'RealTime'.
+-}
+data Process
+ = Offline
+ {- ^
+ Run the stretcher in offline mode. In this mode the input data needs to
+ be provided twice, once to 'Sound.RubberBand.Nice.study', which calculates
+ a stretch profile for the audio, and once to
+ 'Sound.RubberBand.Nice.process', which stretches it.
+ -}
+ | RealTime
+ {- ^
+ Run the stretcher in real-time mode. In this mode only
+ 'Sound.RubberBand.Nice.process' should be called, and the
+ stretcher adjusts dynamically in response to the input audio.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Stretch' flags control the profile used for
+variable timestretching. Rubber Band always adjusts the
+stretch profile to minimise stretching of busy broadband
+transient sounds, but the degree to which it does so is
+adjustable. These options may not be changed after
+construction.
+-}
+data Stretch
+ = Elastic
+ {- ^
+ Only meaningful in offline
+ mode, and the default in that mode. The audio will be
+ stretched at a variable rate, aimed at preserving the quality
+ of transient sounds as much as possible. The timings of low
+ activity regions between transients may be less exact than
+ when the precise flag is set.
+ -}
+ | Precise
+ {- ^
+ Although still using a variable
+ stretch rate, the audio will be stretched so as to maintain
+ as close as possible to a linear stretch ratio throughout.
+ Timing may be better than when using 'Elastic', at
+ slight cost to the sound quality of transients. This setting
+ is always used when running in real-time mode.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Transients' flags control the component
+frequency phase-reset mechanism that may be used at transient
+points to provide clarity and realism to percussion and other
+significant transient sounds. These options may be changed
+after construction when running in real-time mode, but not when
+running in offline mode.
+-}
+data Transients
+ = Crisp
+ {- ^
+ Reset component phases at the
+ peak of each transient (the start of a significant note or
+ percussive event). This, the default setting, usually
+ results in a clear-sounding output; but it is not always
+ consistent, and may cause interruptions in stable sounds
+ present at the same time as transient events. The
+ 'Detector' flags can be used to tune this to some
+ extent.
+ -}
+ | Mixed
+ {- ^
+ Reset component phases at the
+ peak of each transient, outside a frequency range typical of
+ musical fundamental frequencies. The results may be more
+ regular for mixed stable and percussive notes than
+ 'Crisp', but with a "phasier" sound. The
+ balance may sound very good for certain types of music and
+ fairly bad for others.
+ -}
+ | Smooth
+ {- ^
+ Do not reset component phases
+ at any point. The results will be smoother and more regular
+ but may be less clear than with either of the other
+ 'Transients' flags.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Detector' flags control the type of
+transient detector used. These options may be changed
+after construction when running in real-time mode, but not when
+running in offline mode.
+-}
+data Detector
+ = Compound
+ {- ^
+ Use a general-purpose
+ transient detector which is likely to be good for most
+ situations. This is the default.
+ -}
+ | Percussive
+ {- ^
+ Detect percussive
+ transients. Note that this was the default and only option
+ in Rubber Band versions prior to 1.5.
+ -}
+ | Soft
+ {- ^
+ Use an onset detector with less
+ of a bias toward percussive transients. This may give better
+ results with certain material (e.g. relatively monophonic
+ piano music).
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Phase' flags control the adjustment of
+component frequency phases from one analysis window to the next
+during non-transient segments. These options may be changed at
+any time.
+-}
+data Phase
+ = Laminar
+ {- ^
+ Adjust phases when stretching in
+ such a way as to try to retain the continuity of phase
+ relationships between adjacent frequency bins whose phases
+ are behaving in similar ways. This, the default setting,
+ should give good results in most situations.
+ -}
+ | Independent
+ {- ^
+ Adjust the phase in each
+ frequency bin independently from its neighbours. This
+ usually results in a slightly softer, phasier sound.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Threading' flags control the threading
+model of the stretcher. These options may not be changed after
+construction.
+-}
+data Threading
+ = Auto
+ {- ^
+ Permit the stretcher to
+ determine its own threading model. Usually this means using
+ one processing thread per audio channel in offline mode if
+ the stretcher is able to determine that more than one CPU is
+ available, and one thread only in realtime mode. This is the
+ defafult.
+ -}
+ | Never
+ {- ^
+ Never use more than one thread.
+ -}
+ | Always
+ {- ^
+ Use multiple threads in any
+ situation where 'Auto' would do so, except omit
+ the check for multiple CPUs and instead assume it to be true.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Window' flags control the window size for
+FFT processing. The window size actually used will depend on
+many factors, but it can be influenced. These options may not
+be changed after construction.
+-}
+data Window
+ = Standard
+ {- ^
+ Use the default window size.
+ The actual size will vary depending on other parameters.
+ This option is expected to produce better results than the
+ other window options in most situations.
+ -}
+ | Short
+ {- ^
+ Use a shorter window. This may
+ result in crisper sound for audio that depends strongly on
+ its timing qualities.
+ -}
+ | Long
+ {- ^
+ Use a longer window. This is
+ likely to result in a smoother sound at the expense of
+ clarity and timing.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Smoothing' flags control the use of
+window-presum FFT and time-domain smoothing. These options may
+not be changed after construction.
+-}
+data Smoothing
+ = SmoothingOff
+ {- ^
+ Do not use time-domain smoothing.
+ This is the default.
+ -}
+ | SmoothingOn
+ {- ^
+ Use time-domain smoothing. This
+ will result in a softer sound with some audible artifacts
+ around sharp transients, but it may be appropriate for longer
+ stretches of some instruments and can mix well with a 'Window' setting of
+ 'Short'.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Formant' flags control the handling of
+formant shape (spectral envelope) when pitch-shifting. These
+options may be changed at any time.
+-}
+data Formant
+ = Shifted
+ {- ^
+ Apply no special formant
+ processing. The spectral envelope will be pitch shifted as
+ normal. This is the default.
+ -}
+ | Preserved
+ {- ^
+ Preserve the spectral
+ envelope of the unshifted signal. This permits shifting the
+ note frequency without so substantially affecting the
+ perceived pitch profile of the voice or instrument.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Pitch' flags control the method used for
+pitch shifting. These options may be changed at any time.
+They are only effective in realtime mode; in offline mode, the
+pitch-shift method is fixed.
+-}
+data Pitch
+ = HighSpeed
+ {- ^
+ Use a method with a CPU cost
+ that is relatively moderate and predictable. This may
+ sound less clear than 'HighQuality', especially
+ for large pitch shifts. This is the default.
+ -}
+ | HighQuality
+ {- ^
+ Use the highest quality
+ method for pitch shifting. This method has a CPU cost
+ approximately proportional to the required frequency shift.
+ -}
+ | HighConsistency
+ {- ^
+ Use the method that gives
+ greatest consistency when used to create small variations in
+ pitch around the 1.0-ratio level. Unlike the previous two
+ options, this avoids discontinuities when moving across the
+ 1.0 pitch scale in real-time; it also consumes more CPU than
+ the others in the case where the pitch scale is exactly 1.0.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+{- |
+'Channels' flags control the method used for
+processing two-channel audio. These options may not be changed
+after construction.
+-}
+data Channels
+ = Apart
+ {- ^
+ Each channel is processed
+ individually, though timing is synchronised and phases are
+ synchronised at transients (depending on the 'Transients'
+ setting). This gives the highest quality for the individual
+ channels but a relative lack of stereo focus and unrealistic
+ increase in "width". This is the default.
+ -}
+ | Together
+ {- ^
+ The first two channels (where
+ two or more are present) are considered to be a stereo pair
+ and are processed in mid-side format; mid and side are
+ processed individually, with timing synchronised and phases
+ synchronised at transients (depending on the 'Transients'
+ setting). This usually leads to better focus in the centre
+ but a loss of stereo space and width. Any channels beyond
+ the first two are processed individually.
+ -}
+ deriving (Eq, Ord, Show, Read, Enum, Bounded)
+
+-- | A more limited enumeration class, without the extra functionality of
+-- Haskell's 'Enum'.
+class (Enum o, Bounded o) => Option o where
+ -- | Note that 'optionEnum' returns different values from 'toEnum'.
+ optionEnum :: o -> Int
+
+setOption :: (Option o) => o -> Int -> Int
+setOption o i = let
+ allOptions = [minBound..maxBound] `asTypeOf` [o]
+ mask = foldr (.|.) 0 $ map optionEnum allOptions
+ in (i .&. complement mask) .|. optionEnum o
+ -- Each option type uses some bits of an 'Int' for its value.
+ -- Conveniently only the low 29 bits are used, fitting nicely
+ -- into the Haskell Report's 30-bit guaranteed 'Int' size.
+
+getOption :: (Option o) => Int -> o
+getOption i = let
+ allOptions = [minBound..maxBound] `asTypeOf` [o]
+ lookupList = zip (map optionEnum allOptions) allOptions
+ mask = foldr (.|.) 0 $ map fst lookupList
+ masked = i .&. mask
+ o = fromMaybe
+ (error $ "getOption: no result for masked value " ++ show masked)
+ (lookup masked lookupList)
+ in o
+
+toOptions :: Int -> Options
+toOptions i = Options
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+ (getOption i)
+
+fromOptions :: Options -> Int
+fromOptions (Options a b c d e f g h i j k) = foldr (.|.) 0
+ [ optionEnum a
+ , optionEnum b
+ , optionEnum c
+ , optionEnum d
+ , optionEnum e
+ , optionEnum f
+ , optionEnum g
+ , optionEnum h
+ , optionEnum i
+ , optionEnum j
+ , optionEnum k
+ ]
+
+instance Option Process where
+ optionEnum Offline = 0x00000000
+ optionEnum RealTime = 0x00000001
+
+instance Option Stretch where
+ optionEnum Elastic = 0x00000000
+ optionEnum Precise = 0x00000010
+
+instance Option Transients where
+ optionEnum Crisp = 0x00000000
+ optionEnum Mixed = 0x00000100
+ optionEnum Smooth = 0x00000200
+
+instance Option Detector where
+ optionEnum Compound = 0x00000000
+ optionEnum Percussive = 0x00000400
+ optionEnum Soft = 0x00000800
+
+instance Option Phase where
+ optionEnum Laminar = 0x00000000
+ optionEnum Independent = 0x00002000
+
+instance Option Threading where
+ optionEnum Auto = 0x00000000
+ optionEnum Never = 0x00010000
+ optionEnum Always = 0x00020000
+
+instance Option Window where
+ optionEnum Standard = 0x00000000
+ optionEnum Short = 0x00100000
+ optionEnum Long = 0x00200000
+
+instance Option Smoothing where
+ optionEnum SmoothingOff = 0x00000000
+ optionEnum SmoothingOn = 0x00800000
+
+instance Option Formant where
+ optionEnum Shifted = 0x00000000
+ optionEnum Preserved = 0x01000000
+
+instance Option Pitch where
+ optionEnum HighSpeed = 0x00000000
+ optionEnum HighQuality = 0x02000000
+ optionEnum HighConsistency = 0x04000000
+
+instance Option Channels where
+ optionEnum Apart = 0x00000000
+ optionEnum Together = 0x10000000
+
+-- | Intended to give good results in most situations.
+defaultOptions :: Options
+defaultOptions = toOptions 0x00000000
+
+percussiveOptions :: Options
+percussiveOptions = toOptions 0x00102000
+ \ No newline at end of file
diff --git a/src/Sound/RubberBand/Raw.chs b/src/Sound/RubberBand/Raw.chs
new file mode 100644
index 0000000..828913c
--- /dev/null
+++ b/src/Sound/RubberBand/Raw.chs
@@ -0,0 +1,142 @@
+module Sound.RubberBand.Raw
+
+( Stretcher(..)
+, SampleRate, NumChannels, TimeRatio, PitchScale
+
+, new, delete, p_delete, reset
+
+, setTimeRatio, setPitchScale
+, getTimeRatio, getPitchScale
+, getLatency
+
+, setTransientsOption
+, setDetectorOption
+, setPhaseOption
+, setFormantOption
+, setPitchOption
+
+, setExpectedInputDuration
+, getSamplesRequired
+
+, setMaxProcessSize
+, setKeyFrameMap
+
+, study, process
+, available, retrieve
+
+, getChannelCount
+
+, calculateStretch
+
+, setDebugLevel
+, setDefaultDebugLevel
+
+) where
+
+import Foreign.Ptr (Ptr, FunPtr)
+import Foreign.C.Types
+import Foreign.Marshal.Utils (fromBool)
+
+import Sound.RubberBand.Option
+
+#include <rubberband/rubberband-c.h>
+
+fromOptions' :: (Integral a) => Options -> a
+fromOptions' = fromIntegral . fromOptions
+
+optionEnum' :: (Option o, Integral a) => o -> a
+optionEnum' = fromIntegral . optionEnum
+
+{#pointer RubberBandState as Stretcher newtype #}
+
+{#context prefix="rubberband_"#}
+
+-- | Samples per second of the input and output audio.
+type SampleRate = Int
+
+-- | The number of channels processed by a stretcher.
+type NumChannels = Int
+
+-- | A ratio of stretched duration to unstretched (original) duration.
+type TimeRatio = Double
+
+{- |
+A ratio of output frequencies to input frequencies. For example, a ratio of
+2 will increase the audio by one octave, and 0.5 will decrease it by one
+octave.
+-}
+type PitchScale = Double
+
+{#fun new as ^
+ { fromIntegral `SampleRate'
+ , fromIntegral `NumChannels'
+ , fromOptions' `Options'
+ , realToFrac `TimeRatio'
+ , realToFrac `PitchScale'
+ } -> `Stretcher' #}
+
+{#fun delete as ^
+ { `Stretcher' } -> `()' #}
+
+-- | Suitable for a 'Foreign.ForeignPtr' finalizer.
+foreign import ccall "&rubberband_delete"
+ p_delete :: FunPtr (Ptr Stretcher -> IO ())
+
+{#fun reset as ^
+ { `Stretcher' } -> `()' #}
+
+{#fun set_time_ratio as ^
+ { `Stretcher', realToFrac `TimeRatio' } -> `()' #}
+{#fun set_pitch_scale as ^
+ { `Stretcher', realToFrac `PitchScale' } -> `()' #}
+
+{#fun get_time_ratio as ^
+ { `Stretcher' } -> `TimeRatio' realToFrac #}
+{#fun get_pitch_scale as ^
+ { `Stretcher' } -> `PitchScale' realToFrac #}
+
+{#fun get_latency as ^
+ { `Stretcher' } -> `Int' #}
+
+{#fun set_transients_option as ^
+ { `Stretcher', optionEnum' `Transients' } -> `()' #}
+{#fun set_detector_option as ^
+ { `Stretcher', optionEnum' `Detector' } -> `()' #}
+{#fun set_phase_option as ^
+ { `Stretcher', optionEnum' `Phase' } -> `()' #}
+{#fun set_formant_option as ^
+ { `Stretcher', optionEnum' `Formant' } -> `()' #}
+{#fun set_pitch_option as ^
+ { `Stretcher', optionEnum' `Pitch' } -> `()' #}
+
+{#fun set_expected_input_duration as ^
+ { `Stretcher', `Int' } -> `()' #}
+
+{#fun get_samples_required as ^
+ { `Stretcher' } -> `Int' #}
+
+{#fun set_max_process_size as ^
+ { `Stretcher', `Int' } -> `()' #}
+{#fun set_key_frame_map as ^
+ { `Stretcher', `Int', id `Ptr CUInt', id `Ptr CUInt' } -> `()' #}
+
+{#fun study as ^
+ { `Stretcher', id `Ptr (Ptr CFloat)', `Int', `Bool' } -> `()' #}
+{#fun process as ^
+ { `Stretcher', id `Ptr (Ptr CFloat)', `Int', `Bool' } -> `()' #}
+
+{#fun available as ^
+ { `Stretcher' } -> `Int' #}
+{#fun retrieve as ^
+ { `Stretcher', id `Ptr (Ptr CFloat)', `Int' } -> `Int' #}
+
+{#fun get_channel_count as ^
+ { `Stretcher' } -> `Int' #}
+
+{#fun calculate_stretch as ^
+ { `Stretcher' } -> `()' #}
+
+{#fun set_debug_level as ^
+ { `Stretcher', `Int' } -> `()' #}
+{#fun set_default_debug_level as ^
+ { `Int' } -> `()' #}