diff --git a/COPYING.TXT b/COPYING.TXT index f95d0f6..5b2161b 100644 --- a/COPYING.TXT +++ b/COPYING.TXT @@ -1,458 +1,458 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -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 this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser 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 Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "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 -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY 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 -LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authoried party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS diff --git a/Makefile.am b/Makefile.am index bd9125d..c5f6c2e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,70 +1,70 @@ -## Process this file with automake to create Makefile.in -## -## $Id$ -## -## Copyright (C) 2003 - David W. Durham -## -## This file is part of SoundTouch, an audio processing library for pitch/time adjustments -## -## SoundTouch 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 2 of the License, or (at your option) any later -## version. -## -## SoundTouch 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, write to the Free Software Foundation, Inc., 59 Temple -## Place - Suite 330, Boston, MA 02111-1307, USA - -## I used config/am_include.mk for common definitions -include $(top_srcdir)/config/am_include.mk - -## Descend into SUBDIRS and run make. Look at the Makefile.am files in the -## subdirectories Start at frontend_fox/Makefile.am to see how everything works. -SUBDIRS=include source - - -# list files that are documentation to be packaged in a release tarball and installed -pkgdoc_DATA=COPYING.TXT README.html - -# extra data files that are to be pacakged in a release tarball and installed into the data directory -#pkgdata_DATA= - -# sets up for soundtouch.m4 to be installed -m4datadir=$(datadir)/aclocal -m4data_DATA=soundtouch.m4 - -## These extra files and directories will be included in the distribution. by -## using make-dist by default many common filenames are automatically included -## such as AUTHORS, COPYING, etc the bootstrap script really shouldn't be a part -## of a final package, but it is useful for developers who might want to make -## changes to the configure scripts or makefiles. -# NOTE: wouldn't have to list the .TXT file if it were named without the .TXT -EXTRA_DIST= \ - soundtouch.m4 \ - config/m4 \ - bootstrap \ - make-win.bat \ - COPYING.TXT \ - README.html - -pkgconfigdir = $(libdir)/pkgconfig -pkgconfig_DATA = soundtouch-1.0.pc - -## This removes stuff from the distribution which may be present -## from a cvs checkout or other build reasons -dist-hook: - rm -rf `find $(distdir) -type d -name CVS` # remove all CVS directories - echo rm -rf `find $(distdir) -type f -name \.\#\*` # CVS revision files left around for some reason - -## This happens at 'make distclean' -#distcleancheck: -# rm -rf files-that-may-also-need-to-be-deleted-on-'make distclean' - - -# flag to aclocal where to find m4 macros for tests -ACLOCAL_AMFLAGS = -I config/m4 - +## Process this file with automake to create Makefile.in +## +## $Id$ +## +## Copyright (C) 2003 - David W. Durham +## +## This file is part of SoundTouch, an audio processing library for pitch/time adjustments +## +## SoundTouch 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 2 of the License, or (at your option) any later +## version. +## +## SoundTouch 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, write to the Free Software Foundation, Inc., 59 Temple +## Place - Suite 330, Boston, MA 02111-1307, USA + +## I used config/am_include.mk for common definitions +include $(top_srcdir)/config/am_include.mk + +## Descend into SUBDIRS and run make. Look at the Makefile.am files in the +## subdirectories Start at frontend_fox/Makefile.am to see how everything works. +SUBDIRS=include source + + +# list files that are documentation to be packaged in a release tarball and installed +pkgdoc_DATA=COPYING.TXT README.html + +# extra data files that are to be pacakged in a release tarball and installed into the data directory +#pkgdata_DATA= + +# sets up for soundtouch.m4 to be installed +m4datadir=$(datadir)/aclocal +m4data_DATA=soundtouch.m4 + +## These extra files and directories will be included in the distribution. by +## using make-dist by default many common filenames are automatically included +## such as AUTHORS, COPYING, etc the bootstrap script really shouldn't be a part +## of a final package, but it is useful for developers who might want to make +## changes to the configure scripts or makefiles. +# NOTE: wouldn't have to list the .TXT file if it were named without the .TXT +EXTRA_DIST= \ + soundtouch.m4 \ + config/m4 \ + bootstrap \ + make-win.bat \ + COPYING.TXT \ + README.html + +pkgconfigdir = $(libdir)/pkgconfig +pkgconfig_DATA = soundtouch-1.0.pc + +## This removes stuff from the distribution which may be present +## from a cvs checkout or other build reasons +dist-hook: + rm -rf `find $(distdir) -type d -name CVS` # remove all CVS directories + echo rm -rf `find $(distdir) -type f -name \.\#\*` # CVS revision files left around for some reason + +## This happens at 'make distclean' +#distcleancheck: +# rm -rf files-that-may-also-need-to-be-deleted-on-'make distclean' + + +# flag to aclocal where to find m4 macros for tests +ACLOCAL_AMFLAGS = -I config/m4 +AUTOMAKE_OPTIONS = foreign diff --git a/README.html b/README.html index 230c0c8..fc2ebf9 100644 --- a/README.html +++ b/README.html @@ -1,675 +1,675 @@ - - - - - - - - - - SoundTouch library README - - - -
-

SoundTouch audio processing library v1.3.1 -

-

SoundTouch library Copyright (c) Olli -Parviainen 2002-2006

-
-

1. Introduction

-

SoundTouch is an open-source audio -processing library that allows changing the sound tempo, pitch -and playback rate parameters independently from each other, i.e.:

- -

1.1 Contact information

-

Author email: oparviai 'at' iki.fi

-

SoundTouch WWW page: http://www.surina.net/soundtouch

-
-

2. Compiling SoundTouch

-

Before compiling, notice that you can choose the sample data format -if it's desirable to use floating point sample -data instead of 16bit integers. See section "sample data format" -for more information.

-

2.1. Building in Microsoft Windows

-

Project files for Microsoft Visual C++ 6.0 and Visual C++ .NET are -supplied with the source code package. Please notice that SoundTouch -library uses processor-specific optimizations for Pentium III and AMD -processors that require a processor pack upgrade for -the Visual Studio 6.0 to be installed in order to support these -optimizations. The processor pack upgrade can be downloaded from -Microsoft site at this URL:

-

-http://msdn.microsoft.com/vstudio/downloads/tools/ppack/default.aspx

-

If the above URL is unavailable or removed, go -to http://msdn.microsoft.com -and perform a search with keywords processor pack.

-

Visual Studio .NET supports required -instructions by default and thus doesn't require installing the -processor pack.

-

To build the binaries with Visual C++ 6.0 -compiler, either run "make-win.bat" script or open the -appropriate project files in source code directories with Visual -Studio. The final executable will appear under the "SoundTouch\bin" -directory. If using the Visual Studio IDE instead of the -make-win.bat script, directories bin and -lib have to be created manually to the SoundTouch -package root for the final executables. The make-win.bat script -creates these directories automatically. -

-

Also other C++ compilers than Visual C++ can be -used, but project or makefiles then have to be adapted accordingly. -Performance optimizations are written in Visual C++ compatible -syntax, they may or may not be compatible with other compilers. If -using GCC (Gnu C Compiler) compiler package such as DJGPP or Cygwin, -please see next chapter for instructions.

-

2.2. Building in Gnu platforms

-

The SoundTouch library can be compiled in -practically any platform supporting GNU compiler (GCC) tools. -SoundTouch have been tested with gcc version 3.3.4., but it -shouldn't be very specific about the gcc version. Assembler-level -performance optimizations for GNU platform are currently available in -x86 platforms only, they are automatically disabled and replaced with -standard C routines in other processor platforms.

-

To build and install the binaries, run the -following commands in SoundTouch/ directory:

- - - - - - - - - - - - - - - -
- 
./configure  -
- 		-

Configures the SoundTouch package for the local -environment.

-
- 
make         -
- 		-

Builds the SoundTouch library & -SoundStretch utility.

-
- 
make install -
- 		-

Installs the SoundTouch & BPM libraries -to /usr/local/lib and SoundStretch utility to /usr/local/bin. -Please notice that 'root' privileges may be required to install the -binaries to the destination locations.

-
-

NOTE: At the time of release the SoundTouch package has been -tested -to compile in GNU/Linux platform. However, in past it's happened that -new -gcc versions aren't necessarily compatible with the assembler setttings -used in the optimized routines. If you have problems getting the -SoundTouch library compiled, try the workaround of disabling the -optimizations by editing the file "include/STTypes.h" and removing -the following definition there:

-
- 
#define ALLOW_OPTIMIZATIONS 1
-
-
-

3. About implementation & Usage tips

-

3.1. Supported sample data formats

-

The sample data format can be chosen -between 16bit signed integer and 32bit floating point values, the -default is 32bit floating point.

- -

-In Windows environment, the sample data format is chosen -in file "STTypes.h" by choosing one of the following -defines:

- -

-In GNU environment, the floating sample format is used by default, but -integer sample format can be chosen by giving the -following switch to the configure script: -

-
./configure --enable-integer-samples
-
- -

The sample data can have either single (mono) -or double (stereo) audio channel. Stereo data is interleaved so -that every other data value is for left channel and every second -for right channel. Notice that while it'd be possible in theory -to process stereo sound as two separate mono channels, this isn't -recommended because processing the channels separately would -result in losing the phase coherency between the channels, which -consequently would ruin the stereo effect.

-

Sample rates between 8000-48000Hz are -supported.

-

3.2. Processing latency

-

The processing and latency constraints of -the SoundTouch library are:

- -

3.3. About algorithms

-

SoundTouch provides three seemingly -independent effects: tempo, pitch and playback rate control. -These three controls are implemented as combination of two primary -effects, sample rate transposing and time-stretching.

-

Sample rate transposing affects -both the audio stream duration and pitch. It's implemented simply -by converting the original audio sample stream to the  desired -duration by interpolating from the original audio samples. In -SoundTouch, linear interpolation with anti-alias filtering is -used. Theoretically a higher-order interpolation provide better -result than 1st order linear interpolation, but in audio -application linear interpolation together with anti-alias -filtering performs subjectively about as well as higher-order -filtering would.

-

Time-stretching means changing -the audio stream duration without affecting it's pitch. SoundTouch -uses WSOLA-like time-stretching routines that operate in the time -domain. Compared to sample rate transposing, time-stretching is a -much heavier operation and also requires a longer processing -"window" of sound samples used by the -processing algorithm, thus increasing the algorithm input/output -latency. Typical i/o latency for the SoundTouch -time-stretch algorithm is around 100 ms.

-

Sample rate transposing and time-stretching -are then used together to produce the tempo, pitch and rate -controls:

- -

3.4 Tuning the algorithm parameters

-

The time-stretch algorithm has few -parameters that can be tuned to optimize sound quality for -certain application. The current default parameters have been -chosen by iterative if-then analysis (read: "trial and error") -to obtain best subjective sound quality in pop/rock music -processing, but in applications processing different kind of -sound the default parameter set may result into a sub-optimal -result.

-

The time-stretch algorithm default -parameter values are set by these #defines in file "TDStretch.h":

-
- 
#define DEFAULT_SEQUENCE_MS     82
-#define DEFAULT_SEEKWINDOW_MS   28
-#define DEFAULT_OVERLAP_MS      12
-
-

These parameters affect to the time-stretch -algorithm as follows:

- -

Notice that these parameters can also be -set during execution time with functions "TDStretch::setParameters()" -and "SoundTouch::setSetting()".

-

The table below summarizes how the -parameters can be adjusted for different applications:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter nameDefault value -magnitudeLarger value -affects...Smaller value -affects...MusicSpeechEffect in CPU burden
- 
SEQUENCE_MS
- 		Default value is relatively -large, chosen for slowing down music tempoLarger value is usually -better for slowing down tempo. Growing the value decelerates the -"echoing" artifact when slowing down the tempo.Smaller value might be better -for speeding up tempo. Reducing the value accelerates the "echoing" -artifact when slowing down the tempo Default value usually goodA smaller value than default -might be betterIncreasing the parameter -value reduces computation burden
- 
SEEKWINDOW_MS
- 		Default value is relatively -large, chosen for slowing down music tempoLarger value eases finding a -good mixing position, but may cause a "drifting" artifactSmaller reduce possibility to -find a good mixing position, but reduce the "drifting" artifact.Default value usually good, -unless a "drifting" artifact is disturbing.Default value usually goodIncreasing the parameter -value increases computation burden
- 
OVERLAP_MS
- 		Default value is relatively -large, chosen to suit with above parameters. If you reduce the "sequence -ms" setting, you might wish to try a smaller value.  Increasing the parameter -value increases computation burden
-

3.5 Performance Optimizations

-

General optimizations:

-

The time-stretch routine has a 'quick' mode -that substantially speeds up the algorithm but may degrade the -sound quality by a small amount. This mode is activated by -calling SoundTouch::setSetting() function with parameter  id -of SETTING_USE_QUICKSEEK and value "1", i.e.

-
-

setSetting(SETTING_USE_QUICKSEEK, 1);

-
-

CPU-specific optimizations:

- -
-

4. SoundStretch audio processing utility -

-

SoundStretch audio processing utility
-Copyright (c) Olli Parviainen 2002-2005

-

SoundStretch is a simple command-line -application that can change tempo, pitch and playback rates of -WAV sound files. This program is intended primarily to -demonstrate how the "SoundTouch" library can be used to -process sound in your own program, but it can as well be used for -processing sound files.

-

4.1. SoundStretch Usage Instructions

-

SoundStretch Usage syntax:

-
- 
soundstretch infile.wav outfile.wav [switches]
-
-

Where:

- - - - - - - - - - - - - - - -
- 
"infile.wav"
- 		is the name of the input sound -data file (in .WAV audio file format).
- 
"outfile.wav"
- 		is the name of the output sound -file where the resulting sound is saved (in .WAV audio file format). -This parameter may be omitted if you  don't want to save the -output -(e.g. when only calculating BPM rate with '-bpm' switch).
- 
 [switches]
- 		Are one or more control -switches.
-

Available control switches are:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 
-tempo=n
- 		Change the sound tempo by n -percents (n = -95.0 .. +5000.0 %)
- 
-pitch=n
- 		Change the sound pitch by n -semitones (n = -60.0 .. + 60.0 semitones)
- 
-rate=n
- 		Change the sound playback rate by -n percents (n = -95.0 .. +5000.0 %)
- 
-bpm=n
- 		Detect the Beats-Per-Minute -(BPM) rate of the sound and adjust the tempo to meet 'n' BPMs. If this -switch is defined, the "-tempo=n" switch value is ignored. If "=n" is -omitted, i.e. switch "-bpm" is used alone, the program just calculates -and displays the BPM rate but doesn't adjust tempo according to the BPM -value.
- 
-quick
- 		Use quicker tempo change -algorithm. Gains speed but loses sound quality.
- 
-naa
- 		Don't use anti-alias -filtering in sample rate transposing. Gains speed but loses sound -quality.
- 
-license
- 		Displays the program license -text (LGPL)
-

Notes:

- -

4.2. SoundStretch usage examples

-

Example 1

-

The following command increases tempo of -the sound file "originalfile.wav" by 12.5% and saves -result to file "destinationfile.wav":

-
- 
soundstretch originalfile.wav destinationfile.wav -tempo=12.5
-
-

Example 2

-

The following command decreases the sound -pitch (key) of the sound file "orig.wav" by two -semitones and saves the result to file "dest.wav":

-
- 
soundstretch orig.wav dest.wav -pitch=-2
-
-

Example 3

-

The following command processes the file "orig.wav" by decreasing the sound tempo by 25.3% and -increasing the sound pitch (key) by 1.5 semitones. Result is -saved to file "dest.wav":

-
- 
soundstretch orig.wav dest.wav -tempo=-25.3 -pitch=1.5
-
-

Example 4

-

The following command detects the BPM rate -of the file "orig.wav" and adjusts the tempo to match -100 beats per minute. Result is saved to file "dest.wav":

-
- 
soundstretch orig.wav dest.wav -bpm=100
-
-
-

5. Change History

-

5.1. SoundTouch library Change History

- -

v1.3.1: -

- - -

v1.3.0: -

- -

v1.2.1:

- -

v1.2.0:

- -

v1.1.1:

- -

v1.01:

- -

v1.0:

- -

 

-

5.2. SoundStretch application Change -History

-

v1.3.0:

- -

v1.2.1:

- -

v1.2.0:

- -

v1.1.1:

- -

v1.1:

- -

v1.01:

- -
-

6. LICENSE

-

SoundTouch audio processing library
-Copyright (c) Olli Parviainen

-

This library is free software; you can -redistribute it and/or modify it under the terms of the GNU -Lesser General Public License as published by the Free Software -Foundation; either version 2.1 of the License, or (at your option) -any later version.

-

This library 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 Lesser General Public License for -more details.

-

You should have received a copy of the GNU -Lesser General Public License along with this library; if not, -write to the Free Software Foundation, Inc., 59 Temple Place, -Suite 330, Boston, MA 02111-1307 USA

-
- - - + + + + + + + + + + SoundTouch library README + + + +
+

SoundTouch audio processing library v1.3.1 +

+

SoundTouch library Copyright (c) Olli +Parviainen 2002-2006

+
+

1. Introduction

+

SoundTouch is an open-source audio +processing library that allows changing the sound tempo, pitch +and playback rate parameters independently from each other, i.e.:

+ +

1.1 Contact information

+

Author email: oparviai 'at' iki.fi

+

SoundTouch WWW page: http://www.surina.net/soundtouch

+
+

2. Compiling SoundTouch

+

Before compiling, notice that you can choose the sample data format +if it's desirable to use floating point sample +data instead of 16bit integers. See section "sample data format" +for more information.

+

2.1. Building in Microsoft Windows

+

Project files for Microsoft Visual C++ 6.0 and Visual C++ .NET are +supplied with the source code package. Please notice that SoundTouch +library uses processor-specific optimiations for Pentium III and AMD +processors that require a processor pack upgrade for +the Visual Studio 6.0 to be installed in order to support these +optimiations. The processor pack upgrade can be downloaded from +Microsoft site at this URL:

+

+http://msdn.microsoft.com/vstudio/downloads/tools/ppack/default.aspx

+

If the above URL is unavailable or removed, go +to http://msdn.microsoft.com +and perform a search with keywords processor pack.

+

Visual Studio .NET supports required +instructions by default and thus doesn't require installing the +processor pack.

+

To build the binaries with Visual C++ 6.0 +compiler, either run "make-win.bat" script or open the +appropriate project files in source code directories with Visual +Studio. The final executable will appear under the "SoundTouch\bin" +directory. If using the Visual Studio IDE instead of the +make-win.bat script, directories bin and +lib have to be created manually to the SoundTouch +package root for the final executables. The make-win.bat script +creates these directories automatically. +

+

Also other C++ compilers than Visual C++ can be +used, but project or makefiles then have to be adapted accordingly. +Performance optimiations are written in Visual C++ compatible +syntax, they may or may not be compatible with other compilers. If +using GCC (Gnu C Compiler) compiler package such as DJGPP or Cygwin, +please see next chapter for instructions.

+

2.2. Building in Gnu platforms

+

The SoundTouch library can be compiled in +practically any platform supporting GNU compiler (GCC) tools. +SoundTouch have been tested with gcc version 3.3.4., but it +shouldn't be very specific about the gcc version. Assembler-level +performance optimiations for GNU platform are currently available in +x86 platforms only, they are automatically disabled and replaced with +standard C routines in other processor platforms.

+

To build and install the binaries, run the +following commands in SoundTouch/ directory:

+ + + + + + + + + + + + + + + +
+ 
./configure  -
+ 		+

Configures the SoundTouch package for the local +environment.

+
+ 
make         -
+ 		+

Builds the SoundTouch library & +SoundStretch utility.

+
+ 
make install -
+ 		+

Installs the SoundTouch & BPM libraries +to /usr/local/lib and SoundStretch utility to /usr/local/bin. +Please notice that 'root' privileges may be required to install the +binaries to the destination locations.

+
+

NOTE: At the time of release the SoundTouch package has been +tested +to compile in GNU/Linux platform. However, in past it's happened that +new +gcc versions aren't necessarily compatible with the assembler setttings +used in the optimied routines. If you have problems getting the +SoundTouch library compiled, try the workaround of disabling the +optimiations by editing the file "include/STTypes.h" and removing +the following definition there:

+
+ 
#define ALLOW_OPTIMIZATIONS 1
+
+
+

3. About implementation & Usage tips

+

3.1. Supported sample data formats

+

The sample data format can be chosen +between 16bit signed integer and 32bit floating point values, the +default is 32bit floating point.

+ +

+In Windows environment, the sample data format is chosen +in file "STTypes.h" by choosing one of the following +defines:

+ +

+In GNU environment, the floating sample format is used by default, but +integer sample format can be chosen by giving the +following switch to the configure script: +

+
./configure --enable-integer-samples
+
+ +

The sample data can have either single (mono) +or double (stereo) audio channel. Stereo data is interleaved so +that every other data value is for left channel and every second +for right channel. Notice that while it'd be possible in theory +to process stereo sound as two separate mono channels, this isn't +recommended because processing the channels separately would +result in losing the phase coherency between the channels, which +consequently would ruin the stereo effect.

+

Sample rates between 8000-48000H are +supported.

+

3.2. Processing latency

+

The processing and latency constraints of +the SoundTouch library are:

+ +

3.3. About algorithms

+

SoundTouch provides three seemingly +independent effects: tempo, pitch and playback rate control. +These three controls are implemented as combination of two primary +effects, sample rate transposing and time-stretching.

+

Sample rate transposing affects +both the audio stream duration and pitch. It's implemented simply +by converting the original audio sample stream to the  desired +duration by interpolating from the original audio samples. In +SoundTouch, linear interpolation with anti-alias filtering is +used. Theoretically a higher-order interpolation provide better +result than 1st order linear interpolation, but in audio +application linear interpolation together with anti-alias +filtering performs subjectively about as well as higher-order +filtering would.

+

Time-stretching means changing +the audio stream duration without affecting it's pitch. SoundTouch +uses WSOLA-like time-stretching routines that operate in the time +domain. Compared to sample rate transposing, time-stretching is a +much heavier operation and also requires a longer processing +"window" of sound samples used by the +processing algorithm, thus increasing the algorithm input/output +latency. Typical i/o latency for the SoundTouch +time-stretch algorithm is around 100 ms.

+

Sample rate transposing and time-stretching +are then used together to produce the tempo, pitch and rate +controls:

+ +

3.4 Tuning the algorithm parameters

+

The time-stretch algorithm has few +parameters that can be tuned to optimie sound quality for +certain application. The current default parameters have been +chosen by iterative if-then analysis (read: "trial and error") +to obtain best subjective sound quality in pop/rock music +processing, but in applications processing different kind of +sound the default parameter set may result into a sub-optimal +result.

+

The time-stretch algorithm default +parameter values are set by these #defines in file "TDStretch.h":

+
+ 
#define DEFAULT_SEQUENCE_MS     82
+#define DEFAULT_SEEKWINDOW_MS   28
+#define DEFAULT_OVERLAP_MS      12
+
+

These parameters affect to the time-stretch +algorithm as follows:

+ +

Notice that these parameters can also be +set during execution time with functions "TDStretch::setParameters()" +and "SoundTouch::setSetting()".

+

The table below summaries how the +parameters can be adjusted for different applications:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter nameDefault value +magnitudeLarger value +affects...Smaller value +affects...MusicSpeechEffect in CPU burden
+ 
SEQUENCE_MS
+ 		Default value is relatively +large, chosen for slowing down music tempoLarger value is usually +better for slowing down tempo. Growing the value decelerates the +"echoing" artifact when slowing down the tempo.Smaller value might be better +for speeding up tempo. Reducing the value accelerates the "echoing" +artifact when slowing down the tempo Default value usually goodA smaller value than default +might be betterIncreasing the parameter +value reduces computation burden
+ 
SEEKWINDOW_MS
+ 		Default value is relatively +large, chosen for slowing down music tempoLarger value eases finding a +good mixing position, but may cause a "drifting" artifactSmaller reduce possibility to +find a good mixing position, but reduce the "drifting" artifact.Default value usually good, +unless a "drifting" artifact is disturbing.Default value usually goodIncreasing the parameter +value increases computation burden
+ 
OVERLAP_MS
+ 		Default value is relatively +large, chosen to suit with above parameters. If you reduce the "sequence +ms" setting, you might wish to try a smaller value.  Increasing the parameter +value increases computation burden
+

3.5 Performance Optimiations

+

General optimiations:

+

The time-stretch routine has a 'quick' mode +that substantially speeds up the algorithm but may degrade the +sound quality by a small amount. This mode is activated by +calling SoundTouch::setSetting() function with parameter  id +of SETTING_USE_QUICKSEEK and value "1", i.e.

+
+

setSetting(SETTING_USE_QUICKSEEK, 1);

+
+

CPU-specific optimiations:

+ +
+

4. SoundStretch audio processing utility +

+

SoundStretch audio processing utility
+Copyright (c) Olli Parviainen 2002-2005

+

SoundStretch is a simple command-line +application that can change tempo, pitch and playback rates of +WAV sound files. This program is intended primarily to +demonstrate how the "SoundTouch" library can be used to +process sound in your own program, but it can as well be used for +processing sound files.

+

4.1. SoundStretch Usage Instructions

+

SoundStretch Usage syntax:

+
+ 
soundstretch infile.wav outfile.wav [switches]
+
+

Where:

+ + + + + + + + + + + + + + + +
+ 
"infile.wav"
+ 		is the name of the input sound +data file (in .WAV audio file format).
+ 
"outfile.wav"
+ 		is the name of the output sound +file where the resulting sound is saved (in .WAV audio file format). +This parameter may be omitted if you  don't want to save the +output +(e.g. when only calculating BPM rate with '-bpm' switch).
+ 
 [switches]
+ 		Are one or more control +switches.
+

Available control switches are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 
-tempo=n
+ 		Change the sound tempo by n +percents (n = -95.0 .. +5000.0 %)
+ 
-pitch=n
+ 		Change the sound pitch by n +semitones (n = -60.0 .. + 60.0 semitones)
+ 
-rate=n
+ 		Change the sound playback rate by +n percents (n = -95.0 .. +5000.0 %)
+ 
-bpm=n
+ 		Detect the Beats-Per-Minute +(BPM) rate of the sound and adjust the tempo to meet 'n' BPMs. If this +switch is defined, the "-tempo=n" switch value is ignored. If "=n" is +omitted, i.e. switch "-bpm" is used alone, the program just calculates +and displays the BPM rate but doesn't adjust tempo according to the BPM +value.
+ 
-quick
+ 		Use quicker tempo change +algorithm. Gains speed but loses sound quality.
+ 
-naa
+ 		Don't use anti-alias +filtering in sample rate transposing. Gains speed but loses sound +quality.
+ 
-license
+ 		Displays the program license +text (LGPL)
+

Notes:

+ +

4.2. SoundStretch usage examples

+

Example 1

+

The following command increases tempo of +the sound file "originalfile.wav" by 12.5% and saves +result to file "destinationfile.wav":

+
+ 
soundstretch originalfile.wav destinationfile.wav -tempo=12.5
+
+

Example 2

+

The following command decreases the sound +pitch (key) of the sound file "orig.wav" by two +semitones and saves the result to file "dest.wav":

+
+ 
soundstretch orig.wav dest.wav -pitch=-2
+
+

Example 3

+

The following command processes the file "orig.wav" by decreasing the sound tempo by 25.3% and +increasing the sound pitch (key) by 1.5 semitones. Result is +saved to file "dest.wav":

+
+ 
soundstretch orig.wav dest.wav -tempo=-25.3 -pitch=1.5
+
+

Example 4

+

The following command detects the BPM rate +of the file "orig.wav" and adjusts the tempo to match +100 beats per minute. Result is saved to file "dest.wav":

+
+ 
soundstretch orig.wav dest.wav -bpm=100
+
+
+

5. Change History

+

5.1. SoundTouch library Change History

+ +

v1.3.1: +

+ + +

v1.3.0: +

+ +

v1.2.1:

+ +

v1.2.0:

+ +

v1.1.1:

+ +

v1.01:

+ +

v1.0:

+ +

 

+

5.2. SoundStretch application Change +History

+

v1.3.0:

+ +

v1.2.1:

+ +

v1.2.0:

+ +

v1.1.1:

+ +

v1.1:

+ +

v1.01:

+ +
+

6. LICENSE

+

SoundTouch audio processing library
+Copyright (c) Olli Parviainen

+

This library is free software; you can +redistribute it and/or modify it under the terms of the GNU +Lesser General Public License as published by the Free Software +Foundation; either version 2.1 of the License, or (at your option) +any later version.

+

This library 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 Lesser General Public License for +more details.

+

You should have received a copy of the GNU +Lesser General Public License along with this library; if not, +write to the Free Software Foundation, Inc., 59 Temple Place, +Suite 330, Boston, MA 02111-1307 USA

+
+ + + diff --git a/bootstrap b/bootstrap index c90be2c..341d822 100644 --- a/bootstrap +++ b/bootstrap @@ -1,26 +1,26 @@ -# $Id$ - -#!/bin/sh - -if [ "$1" = "--clean" ] -then - if [ -a Makefile ] - then - make maintainer-clean - elif [ -a configure ] - then - configure && $0 --clean - else - bootstrap && configure && $0 --clean - fi - - rm -rf configure libtool aclocal.m4 `find . -name Makefile.in` autom4te*.cache config/config.guess config/config.h.in config/config.sub config/depcomp config/install-sh config/ltmain.sh config/missing config/mkinstalldirs config/stamp-h config/stamp-h.in - - #gettextize files - #rm -f ABOUT-NLS config/config.rpath config/m4/codeset.m4 config/m4/gettext.m4 config/m4/glibc21.m4 config/m4/iconv.m4 config/m4/intdiv0.m4 config/m4/inttypes-pri.m4 config/m4/inttypes.m4 config/m4/inttypes_h.m4 config/m4/isc-posix.m4 config/m4/lcmessage.m4 config/m4/lib-ld.m4 config/m4/lib-link.m4 config/m4/lib-prefix.m4 config/m4/progtest.m4 config/m4/stdint_h.m4 config/m4/uintmax_t.m4 config/m4/ulonglong.m4 po/Makefile.in.in po/Rules-quot po/boldquot.sed po/en@boldquot.header po/en@quot.header po/insert-header.sin po/quot.sed po/remove-potcdate.sin - -else - export AUTOMAKE="automake --add-missing --foreign" - autoreconf -fisv && rm -f `find . -name "*~"` && rm -f ChangeLog - exit $? -fi +# $Id$ + +#!/bin/sh + +if [ "$1" = "--clean" ] +then + if [ -a Makefile ] + then + make maintainer-clean + elif [ -a configure ] + then + configure && $0 --clean + else + bootstrap && configure && $0 --clean + fi + + rm -rf configure libtool aclocal.m4 `find . -name Makefile.in` autom4te*.cache config/config.guess config/config.h.in config/config.sub config/depcomp config/install-sh config/ltmain.sh config/missing config/mkinstalldirs config/stamp-h config/stamp-h.in + + #gettextie files + #rm -f ABOUT-NLS config/config.rpath config/m4/codeset.m4 config/m4/gettext.m4 config/m4/glibc21.m4 config/m4/iconv.m4 config/m4/intdiv0.m4 config/m4/inttypes-pri.m4 config/m4/inttypes.m4 config/m4/inttypes_h.m4 config/m4/isc-posix.m4 config/m4/lcmessage.m4 config/m4/lib-ld.m4 config/m4/lib-link.m4 config/m4/lib-prefix.m4 config/m4/progtest.m4 config/m4/stdint_h.m4 config/m4/uintmax_t.m4 config/m4/ulonglong.m4 po/Makefile.in.in po/Rules-quot po/boldquot.sed po/en@boldquot.header po/en@quot.header po/insert-header.sin po/quot.sed po/remove-potcdate.sin + +else + export AUTOMAKE="automake --add-missing --foreign --copy" + autoreconf -fisv && rm -f `find . -name "*~"` && rm -f ChangeLog + exit $? +fi diff --git a/config/am_include.mk b/config/am_include.mk index b11f744..475e53a 100644 --- a/config/am_include.mk +++ b/config/am_include.mk @@ -32,19 +32,6 @@ INCLUDES=-I$(top_srcdir)/include -## CXXFLAGS is also automatically added to the $(CXX) macro at compile time, and -## is passed down to the children as well -## I list these here in case there needs to always be some flags passed to the compiler -CXXFLAGS=@CXXFLAGS@ - - -## LDFLAGS will be added at link time -## note that the -l flags are set by the LIBS macro that is set by configure -## This line doesn't need to be here, configure will add LDFLAGS on it's own, -## but I'm leaving here as a place to add LDFLAGS if so desired -LDFLAGS=@LDFLAGS@ - - # doc directory pkgdocdir=$(prefix)/doc/@PACKAGE@ diff --git a/configure.ac b/configure.ac index 3cfc4ea..9d1480a 100644 --- a/configure.ac +++ b/configure.ac @@ -1,139 +1,138 @@ -dnl SoundTouch configure.ac, by David W. Durham -dnl -dnl $Id$ -dnl -dnl This file is part of SoundTouch, an audio processing library for pitch/time adjustments -dnl -dnl SoundTouch is free software; you can redistribute it and/or modify it under the -dnl terms of the GNU General Public License as published by the Free Software -dnl Foundation; either version 2 of the License, or (at your option) any later -dnl version. -dnl -dnl SoundTouch is distributed in the hope that it will be useful, but WITHOUT ANY -dnl WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -dnl FOR A PARTICULAR PURPOSE. See the GNU General Public License for more -dnl details. -dnl -dnl You should have received a copy of the GNU General Public License along with -dnl this program; if not, write to the Free Software Foundation, Inc., 59 Temple -dnl Place - Suite 330, Boston, MA 02111-1307, USA -# Process this file with autoconf to produce a configure script. - -AC_INIT(SoundTouch, 1.3.1, [http://www.surina.net/soundtouch]) -AC_CONFIG_AUX_DIR(config) -AM_CONFIG_HEADER([include/soundtouch_config.h]) -AM_INIT_AUTOMAKE -AC_DISABLE_SHARED dnl This makes libtool only build static libs -#AC_GNU_SOURCE dnl enable posix extensions in glibc - -AC_LANG(C++) - - - - - -dnl ############################################################################ -dnl # Checks for programs # -dnl ############################################################################ -CXXFLAGS= dnl AC_PROG_CXX automatically sets CXXFLAGS to -g -O2 if g++ is the C++ compiler and CXXFLAGS hasn't been set, so by setting CXXFLAGS, we can avoid this. -AC_PROG_CXX -#AC_PROG_AWK -AC_PROG_CC -AC_PROG_CPP -AC_PROG_CXXCPP -AC_PROG_INSTALL -#AC_PROG_LN_S -AC_PROG_MAKE_SET - -AM_PROG_LIBTOOL dnl turn on using libtool - - - - -dnl ############################################################################ -dnl # Checks for header files # -dnl ############################################################################ -AC_HEADER_STDC -#AC_HEADER_SYS_WAIT -# add any others you want to check for here -#AC_CHECK_HEADERS([fcntl.h limits.h stddef.h stdlib.h string.h sys/ioctl.h sys/vfs.h unistd.h]) - - - - - - -dnl ############################################################################ -dnl # Checks for typedefs, structures, and compiler characteristics $ -dnl ############################################################################ -AC_C_CONST -AC_C_INLINE -#AC_TYPE_OFF_T -#AC_TYPE_SIZE_T - - -AC_ARG_ENABLE(integer-samples, - [AC_HELP_STRING([--enable-integer-samples], - [use integer samples instead of floats -[default=yes]])],, - [enable_integer_samples=no]) - - -if test "x$enable_integer_samples" = "xyes"; then - echo "****** Integer sample type enabled ******" - AC_DEFINE(INTEGER_SAMPLES,1,[Use Integer as Sample type]) -else - echo "****** Float sample type enabled ******" - AC_DEFINE(FLOAT_SAMPLES,1,[Use Float as Sample type]) -fi - - - - -dnl ############################################################################ -dnl # Checks for library functions/classes # -dnl ############################################################################ -AC_FUNC_MALLOC -AC_TYPE_SIGNAL - -dnl make -lm get added to the LIBS -AC_CHECK_LIB(m, sqrt,,AC_MSG_ERROR([compatible libc math library not found])) - -dnl add whatever functions you might want to check for here -#AC_CHECK_FUNCS([floor ftruncate memmove memset mkdir modf pow realpath sqrt strchr strdup strerror strrchr strstr strtol]) - - - - - - - -dnl ############################################################################ -dnl # Internationalization and Localization # -dnl ############################################################################ -#AM_GNU_GETTEXT_VERSION([0.11.5]) -#AM_GNU_GETTEXT([external]) - - - - - -dnl ############################################################################ -dnl # Final # -dnl ############################################################################ - -AC_CONFIG_FILES([ - Makefile - source/Makefile - source/SoundTouch/Makefile - source/example/Makefile - source/example/SoundStretch/Makefile - source/example/bpm/Makefile - include/Makefile -]) - -AC_OUTPUT( - soundtouch-1.0.pc -) - -dnl use 'echo' to put stuff here if you want a message to the builder +dnl SoundTouch configure.ac, by David W. Durham +dnl +dnl $Id$ +dnl +dnl This file is part of SoundTouch, an audio processing library for pitch/time adjustments +dnl +dnl SoundTouch is free software; you can redistribute it and/or modify it under the +dnl terms of the GNU General Public License as published by the Free Software +dnl Foundation; either version 2 of the License, or (at your option) any later +dnl version. +dnl +dnl SoundTouch is distributed in the hope that it will be useful, but WITHOUT ANY +dnl WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +dnl FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +dnl details. +dnl +dnl You should have received a copy of the GNU General Public License along with +dnl this program; if not, write to the Free Software Foundation, Inc., 59 Temple +dnl Place - Suite 330, Boston, MA 02111-1307, USA +# Process this file with autoconf to produce a configure script. + +AC_INIT(SoundTouch, 1.3.1, [http://www.surina.net/soundtouch]) +AC_CONFIG_AUX_DIR(config) +AM_CONFIG_HEADER([include/soundtouch_config.h]) +AM_INIT_AUTOMAKE +AC_DISABLE_SHARED dnl This makes libtool only build static libs +#AC_GNU_SOURCE dnl enable posix extensions in glibc + +AC_LANG(C++) + + + + + +dnl ############################################################################ +dnl # Checks for programs # +dnl ############################################################################ +AC_PROG_CXX +#AC_PROG_AWK +AC_PROG_CC +AC_PROG_CPP +AC_PROG_CXXCPP +AC_PROG_INSTALL +#AC_PROG_LN_S +AC_PROG_MAKE_SET + +AM_PROG_LIBTOOL dnl turn on using libtool + + + + +dnl ############################################################################ +dnl # Checks for header files # +dnl ############################################################################ +AC_HEADER_STDC +#AC_HEADER_SYS_WAIT +# add any others you want to check for here +#AC_CHECK_HEADERS([fcntl.h limits.h stddef.h stdlib.h string.h sys/ioctl.h sys/vfs.h unistd.h]) + + + + + + +dnl ############################################################################ +dnl # Checks for typedefs, structures, and compiler characteristics $ +dnl ############################################################################ +AC_C_CONST +AC_C_INLINE +#AC_TYPE_OFF_T +#AC_TYPE_SIZE_T + + +AC_ARG_ENABLE(integer-samples, + [AC_HELP_STRING([--enable-integer-samples], + [use integer samples instead of floats +[default=yes]])],, + [enable_integer_samples=no]) + + +if test "x$enable_integer_samples" = "xyes"; then + echo "****** Integer sample type enabled ******" + AC_DEFINE(INTEGER_SAMPLES,1,[Use Integer as Sample type]) +else + echo "****** Float sample type enabled ******" + AC_DEFINE(FLOAT_SAMPLES,1,[Use Float as Sample type]) +fi + + + + +dnl ############################################################################ +dnl # Checks for library functions/classes # +dnl ############################################################################ +AC_FUNC_MALLOC +AC_TYPE_SIGNAL + +dnl make -lm get added to the LIBS +AC_CHECK_LIB(m, sqrt,,AC_MSG_ERROR([compatible libc math library not found])) + +dnl add whatever functions you might want to check for here +#AC_CHECK_FUNCS([floor ftruncate memmove memset mkdir modf pow realpath sqrt strchr strdup strerror strrchr strstr strtol]) + + + + + + + +dnl ############################################################################ +dnl # Internationaliation and Localiation # +dnl ############################################################################ +#AM_GNU_GETTEXT_VERSION([0.11.5]) +#AM_GNU_GETTEXT([external]) + + + + + +dnl ############################################################################ +dnl # Final # +dnl ############################################################################ + +AC_CONFIG_FILES([ + Makefile + source/Makefile + source/SoundTouch/Makefile + source/example/Makefile + source/example/SoundStretch/Makefile + source/example/bpm/Makefile + include/Makefile +]) + +AC_OUTPUT( + soundtouch-1.0.pc +) + +dnl use 'echo' to put stuff here if you want a message to the builder diff --git a/make-win.bat b/make-win.bat index 5b13aaf..fb53338 100644 --- a/make-win.bat +++ b/make-win.bat @@ -1,34 +1,34 @@ -@REM -@REM SoundTouch & SoundStretch Build script for Win32 platform -@REM -@REM You'll need Visual C++ 6.0 installed to compile - also execute the -@REM "vcvars32.bat" in VC install directotry before running this one. -@REM -@REM Copyright (c) Olli Parviainen -@REM File Created: 09/Sep/2003 -@REM -@REM $Id$ - -@if "%MsDevDir%"=="" goto nodevdir - -md bin -md lib -msdev source\SoundTouch\SoundTouch.dsw /MAKE ALL -msdev source\example\bpm\bpm.dsw /MAKE ALL -msdev source\example\SoundStretch\SoundStretch.dsw /MAKE "SoundStretch - Win32 Release" - -goto end - -:nodevdir - -@echo off -echo ********************************************************************* -echo ** -echo ** ERROR: Visual Studio path not set. -echo ** -echo ** Run "vcvars32.bat" from Visual Studio installation directory, e.g. -echo ** "\Program Files\Microsoft Visual Studio\VC98\Bin", then try again. -echo ** -echo ********************************************************************* - +@REM +@REM SoundTouch & SoundStretch Build script for Win32 platform +@REM +@REM You'll need Visual C++ 6.0 installed to compile - also execute the +@REM "vcvars32.bat" in VC install directotry before running this one. +@REM +@REM Copyright (c) Olli Parviainen +@REM File Created: 09/Sep/2003 +@REM +@REM $Id$ + +@if "%MsDevDir%"=="" goto nodevdir + +md bin +md lib +msdev source\SoundTouch\SoundTouch.dsw /MAKE ALL +msdev source\example\bpm\bpm.dsw /MAKE ALL +msdev source\example\SoundStretch\SoundStretch.dsw /MAKE "SoundStretch - Win32 Release" + +goto end + +:nodevdir + +@echo off +echo ********************************************************************* +echo ** +echo ** ERROR: Visual Studio path not set. +echo ** +echo ** Run "vcvars32.bat" from Visual Studio installation directory, e.g. +echo ** "\Program Files\Microsoft Visual Studio\VC98\Bin", then try again. +echo ** +echo ********************************************************************* + :end \ No newline at end of file diff --git a/soundtouch-1.0.pc.in b/soundtouch-1.0.pc.in index cbc7a28..03d0360 100644 --- a/soundtouch-1.0.pc.in +++ b/soundtouch-1.0.pc.in @@ -1,11 +1,11 @@ -prefix=@prefix@ -exec_prefix=@exec_prefix@ -libdir=@libdir@ -includedir=@includedir@ - -Name: SoundTouch -Description: SoundTouch is an open-source audio processing library for changing the Tempo, Pitch and Playback Rates of audio streams or files -Version: @VERSION@ -Libs: -L${libdir} -lSoundTouch -Cflags: -I${includedir}/soundtouch - +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: SoundTouch +Description: SoundTouch is an open-source audio processing library for changing the Tempo, Pitch and Playback Rates of audio streams or files +Version: @VERSION@ +Libs: -L${libdir} -lSoundTouch +Cflags: -I${includedir}/soundtouch + diff --git a/soundtouch.m4 b/soundtouch.m4 index 5688159..ff3eb0f 100644 --- a/soundtouch.m4 +++ b/soundtouch.m4 @@ -1,70 +1,70 @@ -# m4 configure test script for the SoundTouch library -# (c)2003 David W. Durham -# -# $Id$ -# -# This file can be included with other packages that need to test -# for libSoundTouch. -# -# It will #define HAVE_LIBSOUNDTOUCH iff the library is found -# It will AC_SUBST SOUNDTOUCH_LIBS and SOUNDTOUCH_CXXFLAGS as well -# It also defines some flags to the configure script for specifying -# the location to search for libSoundTouch -# -# A user of libSoundTouch should add @SOUNDTOUCH_LIBS@ and -# @SOUNDTOUCH_CXXFLAGS@ to the appropriate variables in his -# Makefile.am files -# -# This script works with autoconf-2.5x and automake-1.6 but I have -# not tested it with older versions. - - -dnl min version not supported yet -dnl AM_PATH_SOUNDTOUCH([MINMUM-VERSION, [(additional) ACTION-IF-FOUND] [, ACTION-IF-NOT-FOUND]]]) - -AH_TEMPLATE([HAVE_LIBSOUNDTOUCH], [defined by $0]) -SOUNDTOUCH_CXXFLAGS="" -SOUNDTOUCH_LIBS="" - -AC_DEFUN([AM_PATH_SOUNDTOUCH],[ - AC_ARG_WITH(soundtouch-prefix,[ --with-soundtouch-prefix=DIR Prefix where SoundTouch was installed (optional)], [soundtouch_prefix="$withval"],[soundtouch_prefix=""]) - - AC_ARG_ENABLE(soundtouch-check,[ --disable-soundtouch-check Do not look for the SoundTouch Library],[enable_soundtouch_check="$enableval"],[enable_soundtouch_check="yes"]) - - if test "$enable_soundtouch_check" = "yes" - then - saved_CPPFLAGS="$CPPFLAGS" - saved_LDFLAGS="$LDFLAGS" - - CPPFLAGS="$CPPFLAGS -I$soundtouch_prefix/include" - LDFLAGS="$LDFLAGS -L$soundtouch_prefix/lib" - - dnl make sure SoundTouch.h header file exists - dnl could use AC_CHECK_HEADERS to check for all of them, but the supporting .h file names may change later - AC_CHECK_HEADER([soundtouch/SoundTouch.h],[ - dnl SoundTouch.h found - dnl make sure libSoundTouch is linkable - AC_CHECK_LIB([SoundTouch],[soundtouch_ac_test],[ - dnl libSoundTouch found - SOUNDTOUCH_CXXFLAGS="-I$soundtouch_prefix/include" - SOUNDTOUCH_LIBS="-L$soundtouch_prefix/lib -lSoundTouch" - AC_DEFINE([HAVE_LIBSOUNDTOUCH]) - - dnl run action-if-found - ifelse([$2], , :, [$2]) - ],[ - dnl run action-if-not-found - ifelse([$3], , :, [$3]) - ]) - ],[ - dnl run action-if-not-found - ifelse([$3], , :, [$3]) - ]) - - CPPFLAGS="$saved_CPPFLAGS" - LDFLAGS="$saved_LDFLAGS" - fi - - AC_SUBST(SOUNDTOUCH_CXXFLAGS) - AC_SUBST(SOUNDTOUCH_LIBS) -]) +# m4 configure test script for the SoundTouch library +# (c)2003 David W. Durham +# +# $Id$ +# +# This file can be included with other packages that need to test +# for libSoundTouch. +# +# It will #define HAVE_LIBSOUNDTOUCH iff the library is found +# It will AC_SUBST SOUNDTOUCH_LIBS and SOUNDTOUCH_CXXFLAGS as well +# It also defines some flags to the configure script for specifying +# the location to search for libSoundTouch +# +# A user of libSoundTouch should add @SOUNDTOUCH_LIBS@ and +# @SOUNDTOUCH_CXXFLAGS@ to the appropriate variables in his +# Makefile.am files +# +# This script works with autoconf-2.5x and automake-1.6 but I have +# not tested it with older versions. + + +dnl min version not supported yet +dnl AM_PATH_SOUNDTOUCH([MINMUM-VERSION, [(additional) ACTION-IF-FOUND] [, ACTION-IF-NOT-FOUND]]]) + +AH_TEMPLATE([HAVE_LIBSOUNDTOUCH], [defined by $0]) +SOUNDTOUCH_CXXFLAGS="" +SOUNDTOUCH_LIBS="" + +AC_DEFUN([AM_PATH_SOUNDTOUCH],[ + AC_ARG_WITH(soundtouch-prefix,[ --with-soundtouch-prefix=DIR Prefix where SoundTouch was installed (optional)], [soundtouch_prefix="$withval"],[soundtouch_prefix=""]) + + AC_ARG_ENABLE(soundtouch-check,[ --disable-soundtouch-check Do not look for the SoundTouch Library],[enable_soundtouch_check="$enableval"],[enable_soundtouch_check="yes"]) + + if test "$enable_soundtouch_check" = "yes" + then + saved_CPPFLAGS="$CPPFLAGS" + saved_LDFLAGS="$LDFLAGS" + + CPPFLAGS="$CPPFLAGS -I$soundtouch_prefix/include" + LDFLAGS="$LDFLAGS -L$soundtouch_prefix/lib" + + dnl make sure SoundTouch.h header file exists + dnl could use AC_CHECK_HEADERS to check for all of them, but the supporting .h file names may change later + AC_CHECK_HEADER([soundtouch/SoundTouch.h],[ + dnl SoundTouch.h found + dnl make sure libSoundTouch is linkable + AC_CHECK_LIB([SoundTouch],[soundtouch_ac_test],[ + dnl libSoundTouch found + SOUNDTOUCH_CXXFLAGS="-I$soundtouch_prefix/include" + SOUNDTOUCH_LIBS="-L$soundtouch_prefix/lib -lSoundTouch" + AC_DEFINE([HAVE_LIBSOUNDTOUCH]) + + dnl run action-if-found + ifelse([$2], , :, [$2]) + ],[ + dnl run action-if-not-found + ifelse([$3], , :, [$3]) + ]) + ],[ + dnl run action-if-not-found + ifelse([$3], , :, [$3]) + ]) + + CPPFLAGS="$saved_CPPFLAGS" + LDFLAGS="$saved_LDFLAGS" + fi + + AC_SUBST(SOUNDTOUCH_CXXFLAGS) + AC_SUBST(SOUNDTOUCH_LIBS) +]) diff --git a/source/SoundTouch/Makefile.am b/source/SoundTouch/Makefile.am index 07bf0fe..bfb73d6 100644 --- a/source/SoundTouch/Makefile.am +++ b/source/SoundTouch/Makefile.am @@ -30,13 +30,18 @@ noinst_HEADERS=AAFilter.h cpu_detect.h cpu_detect_x86_gcc.cpp FIRFilter.h RateTr lib_LTLIBRARIES=libSoundTouch.la # the mmx_gcc.cpp and cpu_detect_x86_gcc.cpp may need to be conditionally included here from things discovered in configure.ac -libSoundTouch_la_SOURCES=AAFilter.cpp FIRFilter.cpp FIFOSampleBuffer.cpp mmx_optimized.cpp sse_optimized.cpp RateTransposer.cpp SoundTouch.cpp TDStretch.cpp cpu_detect_x86_gcc.cpp +# libSoundTouch_la_SOURCES=AAFilter.cpp FIRFilter.cpp FIFOSampleBuffer.cpp mmx_optimized.cpp sse_optimized.cpp RateTransposer.cpp SoundTouch.cpp TDStretch.cpp cpu_detect_x86_gcc.cpp +libSoundTouch_la_SOURCES=AAFilter.cpp FIRFilter.cpp FIFOSampleBuffer.cpp RateTransposer.cpp SoundTouch.cpp TDStretch.cpp cpu_detect_x86_gcc.cpp # ??? test for -fcheck-new in configure.ac # other compiler flags to add -AM_CXXFLAGS=-O3 -msse -fcheck-new -I../../include +# AM_CXXFLAGS=-O3 -msse -fcheck-new -I../../include +AM_CXXFLAGS=-O3 -fcheck-new -I../../include # other linking flags to add -#libSoundTouch_la_LIBADD= +noinst_LTLIBRARIES = libSoundTouchOpt.la +libSoundTouch_la_LIBADD = libSoundTouchOpt.la +libSoundTouchOpt_la_SOURCES = mmx_optimized.cpp sse_optimized.cpp +libSoundTouchOpt_la_CXXFLAGS = -O3 -msse2 -fcheck-new -I../../include