added library for audio-processing

This commit is contained in:
Raybz@Raybz 2013-05-16 10:43:33 +02:00
parent 7975382705
commit 6eabb15f07
20 changed files with 4174 additions and 0 deletions

View File

@ -0,0 +1,504 @@
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
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

674
AudioProcessing/LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

52
AudioProcessing/pom.xml Normal file
View File

@ -0,0 +1,52 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.wyrez</groupId>
<artifactId>AudioProcessing</artifactId>
<version>1.0</version>
<packaging>jar</packaging>
<name>AudioProcessing</name>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>javazoom.jl</groupId>
<artifactId>jlayer</artifactId>
<version>1.0.1</version>
<scope>system</scope>
<systemPath>${basedir}/lib/jl1.0.1.jar</systemPath>
</dependency>
<dependency>
<groupId>javazoom.jl</groupId>
<artifactId>mp3spi</artifactId>
<version>1.9.5</version>
<scope>system</scope>
<systemPath>${basedir}/lib/mp3spi1.9.5.jar</systemPath>
</dependency>
<dependency>
<groupId>org.tritonus</groupId>
<artifactId>share</artifactId>
<version>0.3.6</version>
<scope>system</scope>
<systemPath>${basedir}/lib/tritonus_share-0.3.6.jar</systemPath>
</dependency>
<dependency>
<groupId>org.tritonus</groupId>
<artifactId>aos</artifactId>
<version>0.3.6</version>
<scope>system</scope>
<systemPath>${basedir}/lib/tritonus_aos-0.3.6.jar</systemPath>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,97 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* This Code is based on the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/io/AudioDevice.java
*/
package org.wyrez.audio;
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.SourceDataLine;
/**
* Class that allows directly passing PCM float data to the sound card for
* playback.
*
* @author Darth Affe
*/
public class AudioDevice {
private final SourceDataLine out;
private byte[] buffer;
/**
* Constructor, initializes the audio system for 16-bit signed stereo output
* with a sampling rate of 44100 and a buffer size of 2048.
*
* @throws Exception in case the audio system could not be initialized
*/
public AudioDevice() throws Exception {
this(44100, 2);
}
/**
* Constructor, initializes the audio system for 16-bit signed output. Sets
* the buffer size to 1024*channels
*
* @param samplingRate The sampling rate
* @param channels The number of channels
* @throws Exception in case the audio system could not be initialized
*/
public AudioDevice(float samplingRate, int channels) throws Exception {
this(samplingRate, channels, 1024 * channels);
}
/**
* Constructor, initializes the audio system for 16-bit signed output.
*
* @param samplingRate The sampling rate
* @param channels The number of channels
* @param bufferSize The buffer size (have to be a even number)
* @throws Exception in case the audio system could not be initialized
*/
public AudioDevice(float samplingRate, int channels, int bufferSize) throws Exception {
AudioFormat format = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED,
samplingRate, 16, channels, channels * 2, samplingRate, false);
buffer = new byte[bufferSize * 2];
out = AudioSystem.getSourceDataLine(format);
out.open(format);
out.start();
}
/**
* Writes the given samples to the audio device. The samples have to be in
* the range [-1,1].
*
* @param samples The samples.
*/
public void writeSamples(float[] samples) {
fillBuffer(samples);
out.write(buffer, 0, buffer.length);
}
private void fillBuffer(float[] samples) {
for (int i = 0, j = 0; i < samples.length; i++, j += 2) {
short value = (short) (samples[i] * Short.MAX_VALUE);
buffer[j] = (byte) (value | 0xff);
buffer[j + 1] = (byte) (value >> 8);
}
}
}

View File

@ -0,0 +1,418 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* This code is based on a tutorial by http://www.badlogicgames.com (as of 16.05.2013).
* The whole tutorial can be found here:
* http://www.badlogicgames.com/wordpress/?cat=18&paged=3
*/
package org.wyrez.audio;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import org.wyrez.audio.analysis.FFT;
import org.wyrez.audio.decoder.Decoder;
import org.wyrez.audio.util.Band;
import org.wyrez.audio.util.SampleHelper;
/**
* Processor to create analysis-data of audio samples
*
* @author Darth Affe
*/
public class AudioProcessor {
private Band band;
private int bufferSize;
private final float[] samples;
private float[] spectralFlux;
private float[] threshold;
private float[] prunedSpectralFlux;
private float[] peaks;
private float peakAverage;
private final float samplingRate;
private float bpm;
/**
* Constructor, initializes an AudioProcessor for the given Decoder.
*
* @param decoder The decoder to process
*/
public AudioProcessor(Decoder decoder) {
this.samples = SampleHelper.readAllSamples(decoder);
this.samplingRate = decoder.getSamplingRate();
}
/**
* Constructor, initializes an AudioProcessor for the given Decoder and
* band.
*
* @param decoder The decoder to process
* @param band The band to process
*/
public AudioProcessor(Decoder decoder, Band band) {
this.samples = SampleHelper.readAllSamples(decoder);
this.samplingRate = decoder.getSamplingRate();
this.band = band;
}
/**
* Removes cached objects to save some memory.
*/
public void clean() {
spectralFlux = null;
threshold = null;
prunedSpectralFlux = null;
peaks = null;
bpm = 0f;
bufferSize = 0;
}
/**
* Calculates a full analysis of the samples data using default values:
* BufferSize = 1024 ThresholdWindowSize = 10 ThresholdMultiplier = 1.5
*/
public void calculate() {
calculate(1024, 10, 1.5f);
}
/**
* Calculates a full analysis of the samples data using a given threshold.
*
* @param thresholdWindowSize The window -size used to calculate the
* threshold
* @param thresholdMultiplier The multiplier used to calculate the threshold
*/
public void calculate(int thresholdWindowSize, float thresholdMultiplier) {
calculate(1024, thresholdWindowSize, thresholdMultiplier);
}
/**
* Calculates a full analysis of the samples data using a given threshold
* and a custom buffer size.
*
* @param bufferSize The size of the buffer
* @param thresholdWindowSize The window -size used to calculate the
* threshold
* @param thresholdMultiplier The multiplier used to calculate the threshold
*/
public void calculate(int bufferSize, int thresholdWindowSize, float thresholdMultiplier) {
calculate(bufferSize, thresholdWindowSize, thresholdMultiplier, -1f, -1);
}
/**
* Calculates a full analysis of the samples data using a given
* threshold-multiplier and cuts fast peaks.
*
* @param thresholdWindowSize The window -size used to calculate the
* threshold
* @param minPeakDiff The minimum difference in samples between to peaks
*/
public void calculate(int thresholdWindowSize, float thresholdMultiplier, int minPeakDiff) {
calculate(bufferSize, thresholdWindowSize, thresholdMultiplier, -1f, -1);
}
/**
* Calculates a full analysis of the samples data using a given
* threshold-multiplier and cuts low peaks.
*
* @param thresholdWindowSize The window -size used to calculate the
* threshold
* @param percentageToKeep The minimum amplitude in percent of the avarage
* amplitude
*/
public void calculate(int thresholdWindowSize, float thresholdMultiplier, float percentageToKeep) {
calculate(bufferSize, thresholdWindowSize, thresholdMultiplier, percentageToKeep, -1);
}
/**
* Calculates a full analysis of the samples data.
*
* @param bufferSize The size of the buffer
* @param thresholdWindowSize The window -size used to calculate the
* threshold
* @param thresholdMultiplier The multiplier used to calculate the threshold
* @param percentageToKeep The minimum amplitude in percent of the avarage
* amplitude
* @param minPeakDiff The minimum difference in samples between to peaks
*/
public void calculate(int bufferSize, int thresholdWindowSize, float thresholdMultiplier, float percentageToKeep, int minPeakDiff) {
if ((bufferSize & (bufferSize - 1)) != 0) {
throw new IllegalArgumentException("FFT: bufferSize must be a power of two.");
}
this.bufferSize = bufferSize;
calculateSpectralFlux();
calculateThreshold(thresholdWindowSize, thresholdMultiplier);
calculatePrunedSpectralFlux();
calculatePeaks();
if (percentageToKeep > 0f) {
cutLowPeaks(percentageToKeep);
}
if (minPeakDiff > 0) {
cutFastPeaks(minPeakDiff);
}
}
private void calculateSpectralFlux() {
FFT fft = new FFT(bufferSize, samplingRate);
fft.window(FFT.HAMMING);
float[] buffer;
float[] spectrum = new float[fft.getBandSize(band)];
float[] lastSpectrum = new float[spectrum.length];
List<Float> spectralFlux = new ArrayList<Float>();
for (int i = 0; i < samples.length; i += bufferSize) {
buffer = SampleHelper.splitSampleArray(samples, i, bufferSize);
fft.forward(buffer);
System.arraycopy(spectrum, 0, lastSpectrum, 0, spectrum.length);
System.arraycopy(fft.getSpectrum(band), 0, spectrum, 0, spectrum.length);
float flux = 0;
for (int j = 0; j < spectrum.length; j++) {
float value = (spectrum[j] - lastSpectrum[j]);
flux += value < 0 ? 0 : value;
}
spectralFlux.add(flux);
}
this.spectralFlux = SampleHelper.convertToFloatArray(spectralFlux);
}
private void calculateThreshold(int thresholdWindowSize, float multiplier) {
threshold = new float[spectralFlux.length];
for (int i = 0; i < spectralFlux.length; i++) {
int start = Math.max(0, i - thresholdWindowSize);
int end = Math.min(spectralFlux.length - 1, i + thresholdWindowSize);
float mean = 0;
for (int j = start; j <= end; j++) {
mean += spectralFlux[j];
}
mean /= (end - start);
threshold[i] = mean * multiplier;
}
}
private void calculatePrunedSpectralFlux() {
prunedSpectralFlux = new float[threshold.length];
for (int i = 0; i < threshold.length; i++) {
prunedSpectralFlux[i] = (threshold[i] <= spectralFlux[i]) ? spectralFlux[i] - threshold[i] : 0f;
}
}
private void calculatePeaks() {
peaks = new float[prunedSpectralFlux.length - 1];
for (int i = 0; i < prunedSpectralFlux.length - 1; i++) {
peaks[i] = (prunedSpectralFlux[i] > prunedSpectralFlux[i + 1]) ? prunedSpectralFlux[i] : 0f;
}
calculatePeakData();
}
private void calculatePeakData() {
calculatePeakAverage();
calculateBPM();
}
private void calculatePeakAverage() {
int counter = 0;
float sum = 0f;
for (int i = 0; i < peaks.length; i++) {
if (peaks[i] > 0f) {
sum += peaks[i];
counter++;
}
}
peakAverage = sum / counter;
}
private void calculateBPM() {
HashMap<Integer, Integer> peakDiff = new HashMap<Integer, Integer>();
int counter = 0;
boolean first = true;
for (int i = 0; i < peaks.length; i++) {
if (peaks[i] > 0f) {
if (!first) {
Integer value = peakDiff.get(counter);
if (value == null) {
value = 1;
} else {
value += 1;
}
peakDiff.put(counter, value);
} else {
first = false;
}
counter = 1;
} else {
counter++;
}
}
int most = -1;
int highestCount = -1;
for (Integer i : peakDiff.keySet()) {
if (peakDiff.get(i) > highestCount) {
highestCount = peakDiff.get(i);
most = i;
}
}
float timePerPeak = (1 / samplingRate) * bufferSize;
bpm = 1f / (timePerPeak * most) * 60f;
}
/**
* Cuts the last calculated peaks. Removes every peak with a amplitude lower
* than peakAverage*percentageToKeep.
*/
public void cutLowPeaks(float percentageToKeep) {
if (peaks == null) {
return;
}
float valueToKeep = peakAverage * percentageToKeep;
for (int i = 0; i < peaks.length; i++) {
if (peaks[i] < valueToKeep) {
peaks[i] = 0f;
}
}
calculatePeakData();
}
/**
* Cuts the last calculated peaks. Removes peaks witch a sample difference
* lower than minPeakDiff. (This algorithm does NOT analyse the whole data
* therfore the result may be a bit inaccurately)
*/
public void cutFastPeaks(int minPeakDiff) {
if (peaks == null) {
return;
}
int counter = 1;
boolean first = true;
for (int i = 0; i < peaks.length; i++) {
if (peaks[i] > 0f) {
if (!first) {
if (counter < minPeakDiff) {
peaks[i] = 0f;
} else {
counter = 1;
}
} else {
first = false;
}
} else {
counter++;
}
}
calculatePeakData();
}
/**
* Returns the samples which are analysed.
*
* @returns A float array containing the samples
*/
public float[] getSamples() {
return samples;
}
/**
* Returns the last calculated spectral flux.
*
* @returns A float array containing the spectral flux data
*/
public float[] getSpectralFlux() {
return spectralFlux;
}
/**
* Returns the last calculated threshold.
*
* @returns A float array containing the threshold data
*/
public float[] getThreshold() {
return threshold;
}
/**
* Returns the last calculated pruned spectral flux.
*
* @returns A float array containing the pruned spectral flux data
*/
public float[] getPrunedSpectralFlux() {
return prunedSpectralFlux;
}
/**
* Returns the last calculated peaks.
*
* @returns A float array containing the peaks
*/
public float[] getPeaks() {
return peaks;
}
/**
* Returns the last calculated avarage peak amplitude.
*
* @returns The avarage peak amplitude as float
*/
public float getPeakAverage() {
return peakAverage;
}
/**
* Returns the sampling rate of the used samples.
*
* @return The sampling rate as float
*/
public float getSamplingRate() {
return samplingRate;
}
/**
* Returns the last calculated bpm.
*
* @returns The bpm as float
*/
public float getBpm() {
return bpm;
}
/**
* Returns the buffer size used for the last calculation.
*
* @returns The buffer size as int
*/
public int getBufferSize() {
return bufferSize;
}
/**
* Returns the band used for the last calculation.
*
* @returns The band
*/
public Band getBand() {
return band;
}
/**
* Sets the band.
*
* @param band Band to use
*/
public void setBand(Band band) {
this.band = band;
}
}

View File

@ -0,0 +1,135 @@
/*
* Copyright (c) 2007 - 2008 by Damien Di Fede <ddf@compartmental.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as published
* by the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* This Code is taken from the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/analysis/DFT.java
*/
package org.wyrez.audio.analysis;
/**
* DFT stands for Discrete Fourier Transform and is the most widely used Fourier
* Transform. You will never want to use this class due to the fact that it is a
* brute force implementation of the DFT and as such is quite slow. Use an FFT
* instead. This exists primarily as a way to ensure that other implementations
* of the DFT are working properly. This implementation expects an even
* <code>timeSize</code> and will throw and IllegalArgumentException if this is
* not the case.
*
* @author Damien Di Fede
*
* @see FourierTransform
* @see FFT
* @see <a href="http://www.dspguide.com/ch8.htm">The Discrete Fourier
* Transform</a>
*
*/
public class DFT extends FourierTransform {
/**
* Constructs a DFT that expects audio buffers of length
* <code>timeSize</code> that have been recorded with a sample rate of
* <code>sampleRate</code>. Will throw an IllegalArgumentException if
* <code>timeSize</code> is not even.
*
* @param timeSize the length of the audio buffers you plan to analyze
* @param sampleRate the sample rate of the audio samples you plan to
* analyze
*/
public DFT(int timeSize, float sampleRate) {
super(timeSize, sampleRate);
if (timeSize % 2 != 0) {
throw new IllegalArgumentException("DFT: timeSize must be even.");
}
buildTrigTables();
}
protected void allocateArrays() {
spectrum = new float[timeSize / 2 + 1];
real = new float[timeSize / 2 + 1];
imag = new float[timeSize / 2 + 1];
}
/**
* Not currently implemented.
*/
public void scaleBand(int i, float s) {
}
/**
* Not currently implemented.
*/
public void setBand(int i, float a) {
}
public void forward(float[] samples) {
if (samples.length != timeSize) {
throw new IllegalArgumentException("DFT.forward: The length of the passed sample buffer must be equal to DFT.timeSize().");
}
doWindow(samples);
int N = samples.length;
for (int f = 0; f <= N / 2; f++) {
real[f] = 0.0f;
imag[f] = 0.0f;
for (int t = 0; t < N; t++) {
real[f] += samples[t] * cos(t * f);
imag[f] += samples[t] * -sin(t * f);
}
}
fillSpectrum();
}
public void inverse(float[] buffer) {
int N = buffer.length;
real[0] /= N;
imag[0] = -imag[0] / (N / 2);
real[N / 2] /= N;
imag[N / 2] = -imag[0] / (N / 2);
for (int i = 0; i < N / 2; i++) {
real[i] /= (N / 2);
imag[i] = -imag[i] / (N / 2);
}
for (int t = 0; t < N; t++) {
buffer[t] = 0.0f;
for (int f = 0; f < N / 2; f++) {
buffer[t] += real[f] * cos(t * f) + imag[f] * sin(t * f);
}
}
}
// lookup table data and functions
private float[] sinlookup;
private float[] coslookup;
private void buildTrigTables() {
int N = spectrum.length * timeSize;
sinlookup = new float[N];
coslookup = new float[N];
for (int i = 0; i < N; i++) {
sinlookup[i] = (float) Math.sin(i * TWO_PI / timeSize);
coslookup[i] = (float) Math.cos(i * TWO_PI / timeSize);
}
}
private float sin(int i) {
return sinlookup[i];
}
private float cos(int i) {
return coslookup[i];
}
}

View File

@ -0,0 +1,238 @@
/*
* Copyright (c) 2007 - 2008 by Damien Di Fede <ddf@compartmental.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as published
* by the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* This Code is taken from the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/analysis/FFT.java
*/
package org.wyrez.audio.analysis;
/**
* FFT stands for Fast Fourier Transform. It is an efficient way to calculate
* the Complex Discrete Fourier Transform. There is not much to say about this
* class other than the fact that when you want to analyze the spectrum of an
* audio buffer you will almost always use this class. One restriction of this
* class is that the audio buffers you want to analyze must have a length that
* is a power of two. If you try to construct an FFT with a
* <code>timeSize</code> that is not a power of two, an IllegalArgumentException
* will be thrown.
*
* @see FourierTransform
* @see <a href="http://www.dspguide.com/ch12.htm">The Fast Fourier
* Transform</a>
*
* @author Damien Di Fede
*
*/
public class FFT extends FourierTransform {
/**
* Constructs an FFT that will accept sample buffers that are
* <code>timeSize</code> long and have been recorded with a sample rate of
* <code>sampleRate</code>.
* <code>timeSize</code> <em>must</em> be a power of two. This will throw an
* exception if it is not.
*
* @param timeSize the length of the sample buffers you will be analyzing
* @param sampleRate the sample rate of the audio you will be analyzing
*/
public FFT(int timeSize, float sampleRate) {
super(timeSize, sampleRate);
if ((timeSize & (timeSize - 1)) != 0) {
throw new IllegalArgumentException(
"FFT: timeSize must be a power of two.");
}
buildReverseTable();
buildTrigTables();
}
protected void allocateArrays() {
spectrum = new float[timeSize / 2 + 1];
real = new float[timeSize];
imag = new float[timeSize];
}
public void scaleBand(int i, float s) {
if (s < 0) {
throw new IllegalArgumentException("Can't scale a frequency band by a negative value.");
}
if (spectrum[i] != 0) {
real[i] /= spectrum[i];
imag[i] /= spectrum[i];
spectrum[i] *= s;
real[i] *= spectrum[i];
imag[i] *= spectrum[i];
}
if (i != 0 && i != timeSize / 2) {
real[timeSize - i] = real[i];
imag[timeSize - i] = -imag[i];
}
}
public void setBand(int i, float a) {
if (a < 0) {
throw new IllegalArgumentException("Can't set a frequency band to a negative value.");
}
if (real[i] == 0 && imag[i] == 0) {
real[i] = a;
spectrum[i] = a;
} else {
real[i] /= spectrum[i];
imag[i] /= spectrum[i];
spectrum[i] = a;
real[i] *= spectrum[i];
imag[i] *= spectrum[i];
}
if (i != 0 && i != timeSize / 2) {
real[timeSize - i] = real[i];
imag[timeSize - i] = -imag[i];
}
}
// performs an in-place fft on the data in the real and imag arrays
// bit reversing is not necessary as the data will already be bit reversed
private void fft() {
for (int halfSize = 1; halfSize < real.length; halfSize *= 2) {
// float k = -(float)Math.PI/halfSize;
// phase shift step
// float phaseShiftStepR = (float)Math.cos(k);
// float phaseShiftStepI = (float)Math.sin(k);
// using lookup table
float phaseShiftStepR = cos(halfSize);
float phaseShiftStepI = sin(halfSize);
// current phase shift
float currentPhaseShiftR = 1.0f;
float currentPhaseShiftI = 0.0f;
for (int fftStep = 0; fftStep < halfSize; fftStep++) {
for (int i = fftStep; i < real.length; i += 2 * halfSize) {
int off = i + halfSize;
float tr = (currentPhaseShiftR * real[off]) - (currentPhaseShiftI * imag[off]);
float ti = (currentPhaseShiftR * imag[off]) + (currentPhaseShiftI * real[off]);
real[off] = real[i] - tr;
imag[off] = imag[i] - ti;
real[i] += tr;
imag[i] += ti;
}
float tmpR = currentPhaseShiftR;
currentPhaseShiftR = (tmpR * phaseShiftStepR) - (currentPhaseShiftI * phaseShiftStepI);
currentPhaseShiftI = (tmpR * phaseShiftStepI) + (currentPhaseShiftI * phaseShiftStepR);
}
}
}
public void forward(float[] buffer) {
if (buffer.length != timeSize) {
throw new IllegalArgumentException("FFT.forward: The length of the passed sample buffer must be equal to timeSize().");
}
doWindow(buffer);
// copy samples to real/imag in bit-reversed order
bitReverseSamples(buffer);
// perform the fft
fft();
// fill the spectrum buffer with amplitudes
fillSpectrum();
}
/**
* Performs a forward transform on the passed buffers.
*
* @param buffReal the real part of the time domain signal to transform
* @param buffImag the imaginary part of the time domain signal to transform
*/
public void forward(float[] buffReal, float[] buffImag) {
if (buffReal.length != timeSize || buffImag.length != timeSize) {
throw new IllegalArgumentException("FFT.forward: The length of the passed buffers must be equal to timeSize().");
}
setComplex(buffReal, buffImag);
bitReverseComplex();
fft();
fillSpectrum();
}
public void inverse(float[] buffer) {
if (buffer.length > real.length) {
throw new IllegalArgumentException("FFT.inverse: the passed array's length must equal FFT.timeSize().");
}
// conjugate
for (int i = 0; i < timeSize; i++) {
imag[i] *= -1;
}
bitReverseComplex();
fft();
// copy the result in real into buffer, scaling as we do
for (int i = 0; i < buffer.length; i++) {
buffer[i] = real[i] / real.length;
}
}
private int[] reverse;
private void buildReverseTable() {
int N = timeSize;
reverse = new int[N];
// set up the bit reversing table
reverse[0] = 0;
for (int limit = 1, bit = N / 2; limit < N; limit <<= 1, bit >>= 1) {
for (int i = 0; i < limit; i++) {
reverse[i + limit] = reverse[i] + bit;
}
}
}
// copies the values in the samples array into the real array
// in bit reversed order. the imag array is filled with zeros.
private void bitReverseSamples(float[] samples) {
for (int i = 0; i < samples.length; i++) {
real[i] = samples[reverse[i]];
imag[i] = 0.0f;
}
}
// bit reverse real[] and imag[]
private void bitReverseComplex() {
float[] revReal = new float[real.length];
float[] revImag = new float[imag.length];
for (int i = 0; i < real.length; i++) {
revReal[i] = real[reverse[i]];
revImag[i] = imag[reverse[i]];
}
real = revReal;
imag = revImag;
}
// lookup tables
private float[] sinlookup;
private float[] coslookup;
private float sin(int i) {
return sinlookup[i];
}
private float cos(int i) {
return coslookup[i];
}
private void buildTrigTables() {
int N = timeSize;
sinlookup = new float[N];
coslookup = new float[N];
for (int i = 0; i < N; i++) {
sinlookup[i] = (float) Math.sin(-(float) Math.PI / i);
coslookup[i] = (float) Math.cos(-(float) Math.PI / i);
}
}
}

View File

@ -0,0 +1,662 @@
/*
* Copyright (c) 2007 - 2008 by Damien Di Fede <ddf@compartmental.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as published
* by the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* This Code is taken from the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/analysis/FourierTransform.java
*/
//########## Added Code ##########
package org.wyrez.audio.analysis;
import java.util.ArrayList;
import org.wyrez.audio.util.Band;
import org.wyrez.audio.util.SampleHelper;
//#######End of Added Code #######
/**
* A Fourier Transform is an algorithm that transforms a signal in the time
* domain, such as a sample buffer, into a signal in the frequency domain, often
* called the spectrum. The spectrum does not represent individual frequencies,
* but actually represents frequency bands centered on particular frequencies.
* The center frequency of each band is usually expressed as a fraction of the
* sampling rate of the time domain signal and is equal to the index of the
* frequency band divided by the total number of bands. The total number of
* frequency bands is usually equal to the length of the time domain signal, but
* access is only provided to frequency bands with indices less than half the
* length, because they correspond to frequencies below the <a
* href="http://en.wikipedia.org/wiki/Nyquist_frequency">Nyquist frequency</a>.
* In other words, given a signal of length
* <code>N</code>, there will be
* <code>N/2</code> frequency bands in the spectrum.
* <p>
* As an example, if you construct a FourierTransform with a
* <code>timeSize</code> of 1024 and and a
* <code>sampleRate</code> of 44100 Hz, then the spectrum will contain values
* for frequencies below 22010 Hz, which is the Nyquist frequency (half the
* sample rate). If you ask for the value of band number 5, this will correspond
* to a frequency band centered on
* <code>5/1024 * 44100 = 0.0048828125 * 44100 = 215 Hz</code>. The width of
* that frequency band is equal to
* <code>2/1024</code>, expressed as a fraction of the total bandwidth of the
* spectrum. The total bandwith of the spectrum is equal to the Nyquist
* frequency, which in this case is 22100, so the bandwidth is equal to about 50
* Hz. It is not necessary for you to remember all of these relationships,
* though it is good to be aware of them. The function
* <code>getFreq()</code> allows you to query the spectrum with a frequency in
* Hz and the function
* <code>getBandWidth()</code> will return the bandwidth in Hz of each frequency
* band in the spectrum.
* <p>
* <b>Usage</b>
* <p>
* A typical usage of a FourierTransform is to analyze a signal so that the
* frequency spectrum may be represented in some way, typically with vertical
* lines. You could do this in Processing with the following code, where
* <code>audio</code> is an AudioSource and
* <code>fft</code> is an FFT (one of the derived classes of FourierTransform).
*
* <pre>
* fft.forward(audio.left);
* for (int i = 0; i &lt; fft.specSize(); i++)
* {
* // draw the line for frequency band i, scaling it by 4 so we can see it a bit better
* line(i, height, i, height - fft.getBand(i) * 4);
* }
* </pre>
*
* <b>Windowing</b>
* <p>
* Windowing is the process of shaping the audio samples before transforming
* them to the frequency domain. If you call the
* <code>window()</code> function with an appropriate constant, such as
* FourierTransform.HAMMING, the sample buffers passed to the object for
* analysis will be shaped by the current window before being transformed. The
* result of using a window is to reduce the noise in the spectrum somewhat.
* <p>
* <b>Averages</b>
* <p>
* FourierTransform also has functions that allow you to request the creation of
* an average spectrum. An average spectrum is simply a spectrum with fewer
* bands than the full spectrum where each average band is the average of the
* amplitudes of some number of contiguous frequency bands in the full spectrum.
* <p>
* <code>linAverages()</code> allows you to specify the number of averages that
* you want and will group frequency bands into groups of equal number. So if
* you have a spectrum with 512 frequency bands and you ask for 64 averages,
* each average will span 8 bands of the full spectrum.
* <p>
* <code>logAverages()</code> will group frequency bands by octave and allows
* you to specify the size of the smallest octave to use (in Hz) and also how
* many bands to split each octave into. So you might ask for the smallest
* octave to be 60 Hz and to split each octave into two bands. The result is
* that the bandwidth of each average is different. One frequency is an octave
* above another when it's frequency is twice that of the lower frequency. So,
* 120 Hz is an octave above 60 Hz, 240 Hz is an octave above 120 Hz, and so on.
* When octaves are split, they are split based on Hz, so if you split the
* octave 60-120 Hz in half, you will get 60-90Hz and 90-120Hz. You can see how
* these bandwidths increase as your octave sizes grow. For instance, the last
* octave will always span
* <code>sampleRate/4 - sampleRate/2</code>, which in the case of audio sampled
* at 44100 Hz is 11025-22010 Hz. These logarithmically spaced averages are
* usually much more useful than the full spectrum or the linearly spaced
* averages because they map more directly to how humans perceive sound.
* <p>
* <code>calcAvg()</code> allows you to specify the frequency band you want an
* average calculated for. You might ask for 60-500Hz and this function will
* group together the bands from the full spectrum that fall into that range and
* average their amplitudes for you.
* <p>
* If you don't want any averages calculated, then you can call
* <code>noAverages()</code>. This will not impact your ability to use
* <code>calcAvg()</code>, it will merely prevent the object from calculating an
* average array every time you use
* <code>forward()</code>.
* <p>
* <b>Inverse Transform</b>
* <p>
* FourierTransform also supports taking the inverse transform of a spectrum.
* This means that a frequency spectrum will be transformed into a time domain
* signal and placed in a provided sample buffer. The length of the time domain
* signal will be
* <code>timeSize()</code> long. The
* <code>set</code> and
* <code>scale</code> functions allow you the ability to shape the spectrum
* already stored in the object before taking the inverse transform. You might
* use these to filter frequencies in a spectrum or modify it in some other way.
*
* @author Damien Di Fede
* @see <a href="http://www.dspguide.com/ch8.htm">The Discrete Fourier
* Transform</a>
*/
public abstract class FourierTransform {
/**
* A constant indicating no window should be used on sample buffers.
*/
public static final int NONE = 0;
/**
* A constant indicating a Hamming window should be used on sample buffers.
*/
public static final int HAMMING = 1;
protected static final int LINAVG = 2;
protected static final int LOGAVG = 3;
protected static final int NOAVG = 4;
protected static final float TWO_PI = (float) (2 * Math.PI);
protected int timeSize;
protected int sampleRate;
protected float bandWidth;
protected int whichWindow;
protected float[] real;
protected float[] imag;
protected float[] spectrum;
protected float[] averages;
protected int whichAverage;
protected int octaves;
protected int avgPerOctave;
/**
* Construct a FourierTransform that will analyze sample buffers that are
* <code>ts</code> samples long and contain samples with a
* <code>sr</code> sample rate.
*
* @param ts the length of the buffers that will be analyzed
* @param sr the sample rate of the samples that will be analyzed
*/
FourierTransform(int ts, float sr) {
timeSize = ts;
sampleRate = (int) sr;
bandWidth = (2f / timeSize) * ((float) sampleRate / 2f);
noAverages();
allocateArrays();
whichWindow = NONE;
}
// allocating real, imag, and spectrum are the responsibility of derived
// classes
// because the size of the arrays will depend on the implementation being used
// this enforces that responsibility
protected abstract void allocateArrays();
protected void setComplex(float[] r, float[] i) {
if (real.length != r.length && imag.length != i.length) {
throw new IllegalArgumentException("This won't work");
} else {
System.arraycopy(r, 0, real, 0, r.length);
System.arraycopy(i, 0, imag, 0, i.length);
}
}
// fill the spectrum array with the amps of the data in real and imag
// used so that this class can handle creating the average array
// and also do spectrum shaping if necessary
protected void fillSpectrum() {
for (int i = 0; i < spectrum.length; i++) {
spectrum[i] = (float) Math.sqrt(real[i] * real[i] + imag[i] * imag[i]);
}
if (whichAverage == LINAVG) {
int avgWidth = (int) spectrum.length / averages.length;
for (int i = 0; i < averages.length; i++) {
float avg = 0;
int j;
for (j = 0; j < avgWidth; j++) {
int offset = j + i * avgWidth;
if (offset < spectrum.length) {
avg += spectrum[offset];
} else {
break;
}
}
avg /= j + 1;
averages[i] = avg;
}
} else if (whichAverage == LOGAVG) {
for (int i = 0; i < octaves; i++) {
float lowFreq, hiFreq, freqStep;
if (i == 0) {
lowFreq = 0;
} else {
lowFreq = (sampleRate / 2) / (float) Math.pow(2, octaves - i);
}
hiFreq = (sampleRate / 2) / (float) Math.pow(2, octaves - i - 1);
freqStep = (hiFreq - lowFreq) / avgPerOctave;
float f = lowFreq;
for (int j = 0; j < avgPerOctave; j++) {
int offset = j + i * avgPerOctave;
averages[offset] = calcAvg(f, f + freqStep);
f += freqStep;
}
}
}
}
/**
* Sets the object to not compute averages.
*
*/
public void noAverages() {
averages = new float[0];
whichAverage = NOAVG;
}
/**
* Sets the number of averages used when computing the spectrum and spaces
* the averages in a linear manner. In other words, each average band will
* be
* <code>specSize() / numAvg</code> bands wide.
*
* @param numAvg how many averages to compute
*/
public void linAverages(int numAvg) {
if (numAvg > spectrum.length / 2) {
throw new IllegalArgumentException("The number of averages for this transform can be at most " + spectrum.length / 2 + ".");
} else {
averages = new float[numAvg];
}
whichAverage = LINAVG;
}
/**
* Sets the number of averages used when computing the spectrum based on the
* minimum bandwidth for an octave and the number of bands per octave. For
* example, with audio that has a sample rate of 44100 Hz,
* <code>logAverages(11, 1)</code> will result in 12 averages, each
* corresponding to an octave, the first spanning 0 to 11 Hz. To ensure that
* each octave band is a full octave, the number of octaves is computed by
* dividing the Nyquist frequency by two, and then the result of that by
* two, and so on. This means that the actual bandwidth of the lowest octave
* may not be exactly the value specified.
*
* @param minBandwidth the minimum bandwidth used for an octave
* @param bandsPerOctave how many bands to split each octave into
*/
public void logAverages(int minBandwidth, int bandsPerOctave) {
float nyq = (float) sampleRate / 2f;
octaves = 1;
while ((nyq /= 2) > minBandwidth) {
octaves++;
}
avgPerOctave = bandsPerOctave;
averages = new float[octaves * bandsPerOctave];
whichAverage = LOGAVG;
}
/**
* Sets the window to use on the samples before taking the forward
* transform. If an invalid window is asked for, an error will be reported
* and the current window will not be changed.
*
* @param which FourierTransform.HAMMING or FourierTransform.NONE
*/
public void window(int which) {
if (which < 0 || which > 1) {
throw new IllegalArgumentException("Invalid window type.");
} else {
whichWindow = which;
}
}
protected void doWindow(float[] samples) {
switch (whichWindow) {
case HAMMING:
hamming(samples);
break;
}
}
// windows the data in samples with a Hamming window
protected void hamming(float[] samples) {
for (int i = 0; i < samples.length; i++) {
samples[i] *= (0.54f - 0.46f * Math.cos(TWO_PI * i / (samples.length - 1)));
}
}
/**
* Returns the length of the time domain signal expected by this transform.
*
* @return the length of the time domain signal expected by this transform
*/
public int timeSize() {
return timeSize;
}
/**
* Returns the size of the spectrum created by this transform. In other
* words, the number of frequency bands produced by this transform. This is
* typically equal to
* <code>timeSize()/2 + 1</code>, see above for an explanation.
*
* @return the size of the spectrum
*/
public int specSize() {
return spectrum.length;
}
/**
* Returns the amplitude of the requested frequency band.
*
* @param i the index of a frequency band
* @return the amplitude of the requested frequency band
*/
public float getBand(int i) {
if (i < 0) {
i = 0;
}
if (i > spectrum.length - 1) {
i = spectrum.length - 1;
}
return spectrum[i];
}
/**
* Returns the width of each frequency band in the spectrum (in Hz). It
* should be noted that the bandwidth of the first and last frequency bands
* is half as large as the value returned by this function.
*
* @return the width of each frequency band in Hz.
*/
public float getBandWidth() {
return bandWidth;
}
/**
* Sets the amplitude of the
* <code>i<sup>th</sup></code> frequency band to
* <code>a</code>. You can use this to shape the spectrum before using
* <code>inverse()</code>.
*
* @param i the frequency band to modify
* @param a the new amplitude
*/
public abstract void setBand(int i, float a);
/**
* Scales the amplitude of the
* <code>i<sup>th</sup></code> frequency band by
* <code>s</code>. You can use this to shape the spectrum before using
* <code>inverse()</code>.
*
* @param i the frequency band to modify
* @param s the scaling factor
*/
public abstract void scaleBand(int i, float s);
/**
* Returns the index of the frequency band that contains the requested
* frequency.
*
* @param freq the frequency you want the index for (in Hz)
* @return the index of the frequency band that contains freq
*/
public int freqToIndex(float freq) {
// special case: freq is lower than the bandwidth of spectrum[0]
if (freq < getBandWidth() / 2) {
return 0;
}
// special case: freq is within the bandwidth of spectrum[spectrum.length - 1]
if (freq > sampleRate / 2 - getBandWidth() / 2) {
return spectrum.length - 1;
}
// all other cases
float fraction = freq / (float) sampleRate;
int i = Math.round(timeSize * fraction);
return i;
}
/**
* Returns the middle frequency of the i<sup>th</sup> band.
*
* @param i the index of the band you want to middle frequency of
*/
public float indexToFreq(int i) {
float bw = getBandWidth();
// special case: the width of the first bin is half that of the others.
// so the center frequency is a quarter of the way.
if (i == 0) {
return bw * 0.25f;
}
// special case: the width of the last bin is half that of the others.
if (i == spectrum.length - 1) {
float lastBinBeginFreq = (sampleRate / 2) - (bw / 2);
float binHalfWidth = bw * 0.25f;
return lastBinBeginFreq + binHalfWidth;
}
// the center frequency of the ith band is simply i*bw
// because the first band is half the width of all others.
// treating it as if it wasn't offsets us to the middle
// of the band.
return i * bw;
}
/**
* Returns the center frequency of the i<sup>th</sup> average band.
*
* @param i which average band you want the center frequency of.
*/
public float getAverageCenterFrequency(int i) {
if (whichAverage == LINAVG) {
// an average represents a certain number of bands in the spectrum
int avgWidth = (int) spectrum.length / averages.length;
// the "center" bin of the average, this is fudgy.
int centerBinIndex = i * avgWidth + avgWidth / 2;
return indexToFreq(centerBinIndex);
} else if (whichAverage == LOGAVG) {
// which "octave" is this index in?
int octave = i / avgPerOctave;
// which band within that octave is this?
int offset = i % avgPerOctave;
float lowFreq, hiFreq, freqStep;
// figure out the low frequency for this octave
if (octave == 0) {
lowFreq = 0;
} else {
lowFreq = (sampleRate / 2) / (float) Math.pow(2, octaves - octave);
}
// and the high frequency for this octave
hiFreq = (sampleRate / 2) / (float) Math.pow(2, octaves - octave - 1);
// each average band within the octave will be this big
freqStep = (hiFreq - lowFreq) / avgPerOctave;
// figure out the low frequency of the band we care about
float f = lowFreq + offset * freqStep;
// the center of the band will be the low plus half the width
return f + freqStep / 2;
}
return 0;
}
/**
* Gets the amplitude of the requested frequency in the spectrum.
*
* @param freq the frequency in Hz
* @return the amplitude of the frequency in the spectrum
*/
public float getFreq(float freq) {
return getBand(freqToIndex(freq));
}
/**
* Sets the amplitude of the requested frequency in the spectrum to
* <code>a</code>.
*
* @param freq the frequency in Hz
* @param a the new amplitude
*/
public void setFreq(float freq, float a) {
setBand(freqToIndex(freq), a);
}
/**
* Scales the amplitude of the requested frequency by
* <code>a</code>.
*
* @param freq the frequency in Hz
* @param s the scaling factor
*/
public void scaleFreq(float freq, float s) {
scaleBand(freqToIndex(freq), s);
}
/**
* Returns the number of averages currently being calculated.
*
* @return the length of the averages array
*/
public int avgSize() {
return averages.length;
}
/**
* Gets the value of the
* <code>i<sup>th</sup></code> average.
*
* @param i the average you want the value of
* @return the value of the requested average band
*/
public float getAvg(int i) {
float ret;
if (averages.length > 0) {
ret = averages[i];
} else {
ret = 0;
}
return ret;
}
/**
* Calculate the average amplitude of the frequency band bounded by
* <code>lowFreq</code> and
* <code>hiFreq</code>, inclusive.
*
* @param lowFreq the lower bound of the band
* @param hiFreq the upper bound of the band
* @return the average of all spectrum values within the bounds
*/
public float calcAvg(float lowFreq, float hiFreq) {
int lowBound = freqToIndex(lowFreq);
int hiBound = freqToIndex(hiFreq);
float avg = 0;
for (int i = lowBound; i <= hiBound; i++) {
avg += spectrum[i];
}
avg /= (hiBound - lowBound + 1);
return avg;
}
/**
* Performs a forward transform on
* <code>buffer</code>.
*
* @param buffer the buffer to analyze
*/
public abstract void forward(float[] buffer);
/**
* Performs a forward transform on values in
* <code>buffer</code>.
*
* @param buffer the buffer of samples
* @param startAt the index to start at in the buffer. there must be at
* least timeSize() samples between the starting index and the end of the
* buffer. If there aren't, an error will be issued and the operation will
* not be performed.
*
*/
public void forward(float[] buffer, int startAt) {
if (buffer.length - startAt < timeSize) {
throw new IllegalArgumentException("FourierTransform.forward: not enough samples in the buffer between " + startAt + " and " + buffer.length + " to perform a transform.");
}
// copy the section of samples we want to analyze
float[] section = new float[timeSize];
System.arraycopy(buffer, startAt, section, 0, section.length);
forward(section);
}
/**
* Performs an inverse transform of the frequency spectrum and places the
* result in
* <code>buffer</code>.
*
* @param buffer the buffer to place the result of the inverse transform in
*/
public abstract void inverse(float[] buffer);
/**
* Performs an inverse transform of the frequency spectrum represented by
* freqReal and freqImag and places the result in buffer.
*
* @param freqReal the real part of the frequency spectrum
* @param freqImag the imaginary part the frequency spectrum
* @param buffer the buffer to place the inverse transform in
*/
public void inverse(float[] freqReal, float[] freqImag, float[] buffer) {
setComplex(freqReal, freqImag);
inverse(buffer);
}
/**
* @return the spectrum of the last FourierTransform.forward() call.
*/
public float[] getSpectrum() {
return spectrum;
}
//########## Added Code ##########
/**
* @return the spectrum of the last FourierTransform.forward() call for the
* specified range.
*/
public float[] getSpectrum(Band band) {
if (band == null) {
return spectrum;
}
ArrayList<Float> spec = new ArrayList<Float>();
for (float f = band.getLowFrequenzy(); f < band.getHighFrequenzy() + getBandWidth(); f += getBandWidth()) {
spec.add(getFreq(f));
}
return SampleHelper.convertToFloatArray(spec);
}
public int getBandSize(Band band) {
if (band == null) {
return spectrum.length;
}
int counter = 0;
for (float f = band.getLowFrequenzy(); f < band.getHighFrequenzy() + getBandWidth(); f += getBandWidth()) {
counter++;
}
return counter;
}
//#######End of Added Code #######
/**
* @return the real part of the last FourierTransform.forward() call.
*/
public float[] getRealPart() {
return real;
}
/**
* @return the imaginary part of the last FourierTransform.forward() call.
*/
public float[] getImaginaryPart() {
return imag;
}
}

View File

@ -0,0 +1,67 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* This Code is based on the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/io/Decoder.java
*/
package org.wyrez.audio.decoder;
/**
* Interface for audio decoders that return successive amplitude frames.
*
* @author Darth Affe
*/
public interface Decoder {
/**
* Reads in samples.length stereo samples from the decoder. Returns the
* actual number read in. If this number is smaller than samples.length then
* the end of stream has been reached.
*
* @param samples The samples array to write the samples to
* @returns The number of samples actually read
*/
public int readSamplesStereo(float[] samples);
/**
* Reads in samples.length mono samples from the decoder. If the audio
* source isn't mono they channels are merged. Returns the actual number
* read in. If this number is smaller than samples.length then the end of
* stream has been reached. All Channels are merged by calculating the
* average.
*
* @param samples The samples array to write the samples to
* @returns The number of samples actually read
*/
public int readSamplesMergedMono(float[] samples);
/**
* Returns the number of channels in the audio source.
*
* @returns The channel count
*/
public int getChannelCount();
/**
* Returns the sampling rate in Hz of the audio source.
*
* @returns the sampling rate as float
*/
public float getSamplingRate();
}

View File

@ -0,0 +1,73 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.wyrez.audio.decoder;
import java.io.FileInputStream;
import java.io.InputStream;
/**
* Factory used to create Audio-Decoder.
*
* @author Darth Affe
*/
public enum DecoderFactory {
WAVE, MP3;
/**
* Creates a decoder for the selected codec.
*
* @returns The new decoder
* @throws Exception in case the Decoder could not be created
*/
public Decoder create(InputStream is) throws Exception {
switch (this) {
case WAVE:
return new WaveDecoder(is);
case MP3:
return new MP3Decoder(is);
default: //impossible
return null;
}
}
/**
* Creates a decoder for the given file, if there isn't one an exception is
* thrown.
*
* @returns The new decoder
* @throws Exception in case the Decoder could not be created
* @throws IllegalArgumentException in case there is now decoder for the
* given file
*/
public static Decoder create(String file) throws Exception, IllegalArgumentException {
int i = file.lastIndexOf('.');
if (i == 0) {
throw new IllegalArgumentException("Can't detect a filetype");
}
String extension = file.substring(i + 1);
switch (extension.toUpperCase()) {
case "MP3":
return MP3.create(new FileInputStream(file));
case "WAV":
case "WAVE":
return WAVE.create(new FileInputStream(file));
default:
throw new IllegalArgumentException("Filetype \"" + extension + "\" is not supported.");
}
}
}

View File

@ -0,0 +1,365 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* This Code is based on the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/io/MP3Decoder.java
*/
package org.wyrez.audio.decoder;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PushbackInputStream;
import java.util.HashMap;
import javax.sound.sampled.AudioFileFormat;
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioInputStream;
import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.UnsupportedAudioFileException;
import javazoom.jl.decoder.Bitstream;
import javazoom.jl.decoder.Header;
import javazoom.spi.mpeg.sampled.file.MpegAudioFileFormat;
import javazoom.spi.mpeg.sampled.file.MpegAudioFormat;
import javazoom.spi.mpeg.sampled.file.MpegEncoding;
import javazoom.spi.mpeg.sampled.file.MpegFileFormatType;
import org.tritonus.share.TDebug;
import org.tritonus.share.sampled.FloatSampleBuffer;
import org.tritonus.share.sampled.file.TAudioFileReader;
/**
* A decoder for MP3 files with a maximum of 2 channels.
*
* @author Darth Affe
*/
public class MP3Decoder implements Decoder {
private AudioInputStream in;
private FloatSampleBuffer buffer;
private byte[] bytes;
private int channels;
private float samplingRate;
/**
* Constructor, sets the input stream to read the MP3 file from. Audio files
* with more than 2 channels aren't supported!
*
* @param stream The input stream.
* @throws Exception in case the input stream couldn't be read properly
*/
public MP3Decoder(InputStream stream) throws Exception {
InputStream in = new BufferedInputStream(stream, 1024 * 1024);
this.in = new MP3AudioFileReader().getAudioInputStream(in);
AudioFormat baseFormat = this.in.getFormat();
this.channels = baseFormat.getChannels();
if (channels > 2) {
throw new IllegalArgumentException("more than 2 channels aren't supported");
}
this.samplingRate = baseFormat.getSampleRate();
AudioFormat format = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED,
baseFormat.getSampleRate(), 16,
baseFormat.getChannels(),
baseFormat.getChannels() * 2,
baseFormat.getSampleRate(), false);
this.in = AudioSystem.getAudioInputStream(format, this.in);
}
/**
* Tries to read in samples.length stereo samples. Returns the number of
* samples actually read. Guarantees that samples.length samples are read in
* if there was enough data in the stream.
*
* @param samples The samples array to write the samples to
* @return The number of samples actually read
*/
@Override
public int readSamplesStereo(float[] samples) {
if (buffer == null || buffer.getSampleCount() < samples.length / 2) {
buffer = new FloatSampleBuffer(in.getFormat().getChannels(), samples.length / 2, in.getFormat().getSampleRate());
bytes = new byte[buffer.getByteArrayBufferSize(in.getFormat())];
}
int read = 0;
int readBytes = 0;
try {
readBytes = in.read(bytes, read, bytes.length - read);
} catch (IOException e) {
return 0;
}
if (readBytes == -1) {
return 0;
}
read += readBytes;
while (readBytes != -1 && read != bytes.length) {
try {
readBytes = in.read(bytes, read, bytes.length - read);
} catch (IOException e) {
return 0;
}
read += readBytes;
}
int frameCount = bytes.length / in.getFormat().getFrameSize();
buffer.setSamplesFromBytes(bytes, 0, in.getFormat(), 0, frameCount);
for (int i = 0, j = 0; i < buffer.getSampleCount(); i++, j += 2) {
samples[j] = buffer.getChannel(0)[i];
samples[j + 1] = buffer.getChannel(buffer.getChannelCount() == 2 ? 1 : 0)[i];
}
return buffer.getSampleCount() * 2;
}
/**
* Tries to read in samples.length samples, merging stereo to a mono channel
* by averaging. Returns the number of samples actually read. Guarantees
* that samples.length samples are read in if there was enough data in the
* stream.
*
* @param samples The samples array to write the samples to
* @return The number of samples actually read
*/
@Override
public int readSamplesMergedMono(float[] samples) {
if (buffer == null || buffer.getSampleCount() < samples.length) {
buffer = new FloatSampleBuffer(in.getFormat().getChannels(), samples.length, in.getFormat().getSampleRate());
bytes = new byte[buffer.getByteArrayBufferSize(in.getFormat())];
}
int read = 0;
int readBytes = 0;
try {
readBytes = in.read(bytes, read, bytes.length - read);
} catch (IOException e) {
return 0;
}
if (readBytes == -1) {
return 0;
}
read += readBytes;
while (readBytes != -1 && read != bytes.length) {
try {
readBytes = in.read(bytes, read, bytes.length - read);
} catch (IOException e) {
return 0;
}
read += readBytes;
}
int frameCount = bytes.length / in.getFormat().getFrameSize();
buffer.setSamplesFromBytes(bytes, 0, in.getFormat(), 0, frameCount);
for (int i = 0; i < buffer.getSampleCount(); i++) {
if (buffer.getChannelCount() == 2) {
samples[i] = (buffer.getChannel(0)[i] + buffer.getChannel(1)[i]) / 2;
} else {
samples[i] = buffer.getChannel(0)[i];
}
}
return buffer.getSampleCount();
}
/**
* Returns the number of channels in the audio source. (This value can't be
* greater than 2)
*
* @returns The channel count
*/
@Override
public int getChannelCount() {
return channels;
}
/**
* Returns the sampling rate in Hz of the audio source.
*
* @returns the sampling rate as float
*/
@Override
public float getSamplingRate() {
return samplingRate;
}
class MP3AudioFileReader extends TAudioFileReader {
public static final int INITAL_READ_LENGTH = 128000;
private static final int MARK_LIMIT = INITAL_READ_LENGTH + 1;
private final AudioFormat.Encoding[][] sm_aEncodings = {
{MpegEncoding.MPEG2L1, MpegEncoding.MPEG2L2, MpegEncoding.MPEG2L3},
{MpegEncoding.MPEG1L1, MpegEncoding.MPEG1L2, MpegEncoding.MPEG1L3},
{MpegEncoding.MPEG2DOT5L1, MpegEncoding.MPEG2DOT5L2,
MpegEncoding.MPEG2DOT5L3},};
protected MP3AudioFileReader() {
super(MARK_LIMIT, true);
}
@Override
protected AudioFileFormat getAudioFileFormat(InputStream inputStream, long mediaLength)
throws UnsupportedAudioFileException, IOException {
HashMap aff_properties = new HashMap();
HashMap af_properties = new HashMap();
int mLength = (int) mediaLength;
int size = inputStream.available();
PushbackInputStream pis = new PushbackInputStream(inputStream, MARK_LIMIT);
byte head[] = new byte[22];
pis.read(head);
// Check for WAV, AU, and AIFF, Ogg Vorbis, Flac, MAC file formats.
// Next check for Shoutcast (supported) and OGG (unsupported) streams.
if ((head[0] == 'R') && (head[1] == 'I') && (head[2] == 'F')
&& (head[3] == 'F') && (head[8] == 'W') && (head[9] == 'A')
&& (head[10] == 'V') && (head[11] == 'E')) {
int isPCM = ((head[21] << 8) & 0x0000FF00) | ((head[20]) & 0x00000FF);
throw new UnsupportedAudioFileException("WAV PCM stream found");
} else if ((head[0] == '.') && (head[1] == 's') && (head[2] == 'n')
&& (head[3] == 'd')) {
throw new UnsupportedAudioFileException("AU stream found");
} else if ((head[0] == 'F') && (head[1] == 'O') && (head[2] == 'R')
&& (head[3] == 'M') && (head[8] == 'A') && (head[9] == 'I')
&& (head[10] == 'F') && (head[11] == 'F')) {
throw new UnsupportedAudioFileException("AIFF stream found");
} else if (((head[0] == 'M') | (head[0] == 'm'))
&& ((head[1] == 'A') | (head[1] == 'a'))
&& ((head[2] == 'C') | (head[2] == 'c'))) {
throw new UnsupportedAudioFileException("APE stream found");
} else if (((head[0] == 'F') | (head[0] == 'f'))
&& ((head[1] == 'L') | (head[1] == 'l'))
&& ((head[2] == 'A') | (head[2] == 'a'))
&& ((head[3] == 'C') | (head[3] == 'c'))) {
throw new UnsupportedAudioFileException("FLAC stream found");
} // Shoutcast stream ?
else if (((head[0] == 'I') | (head[0] == 'i'))
&& ((head[1] == 'C') | (head[1] == 'c'))
&& ((head[2] == 'Y') | (head[2] == 'y'))) {
pis.unread(head);
// Load shoutcast meta data.
} // Ogg stream ?
else if (((head[0] == 'O') | (head[0] == 'o'))
&& ((head[1] == 'G') | (head[1] == 'g'))
&& ((head[2] == 'G') | (head[2] == 'g'))) {
throw new UnsupportedAudioFileException("Ogg stream found");
} // No, so pushback.
else {
pis.unread(head);
}
// MPEG header info.
int nVersion = AudioSystem.NOT_SPECIFIED;
int nLayer = AudioSystem.NOT_SPECIFIED;
// int nSFIndex = AudioSystem.NOT_SPECIFIED;
int nMode = AudioSystem.NOT_SPECIFIED;
int FrameSize = AudioSystem.NOT_SPECIFIED;
// int nFrameSize = AudioSystem.NOT_SPECIFIED;
int nFrequency = AudioSystem.NOT_SPECIFIED;
int nTotalFrames = AudioSystem.NOT_SPECIFIED;
float FrameRate = AudioSystem.NOT_SPECIFIED;
int BitRate = AudioSystem.NOT_SPECIFIED;
int nChannels = AudioSystem.NOT_SPECIFIED;
int nHeader = AudioSystem.NOT_SPECIFIED;
int nTotalMS = AudioSystem.NOT_SPECIFIED;
boolean nVBR = false;
AudioFormat.Encoding encoding = null;
try {
Bitstream m_bitstream = new Bitstream(pis);
aff_properties.put("mp3.header.pos",
new Integer(m_bitstream.header_pos()));
Header m_header = m_bitstream.readFrame();
// nVersion = 0 => MPEG2-LSF (Including MPEG2.5), nVersion = 1 => MPEG1
nVersion = m_header.version();
if (nVersion == 2) {
aff_properties.put("mp3.version.mpeg", Float.toString(2.5f));
} else {
aff_properties.put("mp3.version.mpeg",
Integer.toString(2 - nVersion));
}
// nLayer = 1,2,3
nLayer = m_header.layer();
aff_properties.put("mp3.version.layer", Integer.toString(nLayer));
// nSFIndex = m_header.sample_frequency();
nMode = m_header.mode();
aff_properties.put("mp3.mode", new Integer(nMode));
nChannels = nMode == 3 ? 1 : 2;
aff_properties.put("mp3.channels", new Integer(nChannels));
nVBR = m_header.vbr();
af_properties.put("vbr", new Boolean(nVBR));
aff_properties.put("mp3.vbr", new Boolean(nVBR));
aff_properties.put("mp3.vbr.scale", new Integer(m_header.vbr_scale()));
FrameSize = m_header.calculate_framesize();
aff_properties.put("mp3.framesize.bytes", new Integer(FrameSize));
if (FrameSize < 0) {
throw new UnsupportedAudioFileException("Invalid FrameSize : " + FrameSize);
}
nFrequency = m_header.frequency();
aff_properties.put("mp3.frequency.hz", new Integer(nFrequency));
FrameRate = (float) ((1.0 / (m_header.ms_per_frame())) * 1000.0);
aff_properties.put("mp3.framerate.fps", new Float(FrameRate));
if (FrameRate < 0) {
throw new UnsupportedAudioFileException("Invalid FrameRate : " + FrameRate);
}
if (mLength != AudioSystem.NOT_SPECIFIED) {
aff_properties.put("mp3.length.bytes", new Integer(mLength));
nTotalFrames = m_header.max_number_of_frames(mLength);
aff_properties.put("mp3.length.frames", new Integer(nTotalFrames));
}
BitRate = m_header.bitrate();
af_properties.put("bitrate", new Integer(BitRate));
aff_properties.put("mp3.bitrate.nominal.bps", new Integer(BitRate));
nHeader = m_header.getSyncHeader();
encoding = sm_aEncodings[nVersion][nLayer - 1];
aff_properties.put("mp3.version.encoding", encoding.toString());
if (mLength != AudioSystem.NOT_SPECIFIED) {
nTotalMS = Math.round(m_header.total_ms(mLength));
aff_properties.put("duration", new Long((long) nTotalMS * 1000L));
}
aff_properties.put("mp3.copyright", new Boolean(m_header.copyright()));
aff_properties.put("mp3.original", new Boolean(m_header.original()));
aff_properties.put("mp3.crc", new Boolean(m_header.checksums()));
aff_properties.put("mp3.padding", new Boolean(m_header.padding()));
InputStream id3v2 = m_bitstream.getRawID3v2();
if (id3v2 != null) {
aff_properties.put("mp3.id3tag.v2", id3v2);
}
if (TDebug.TraceAudioFileReader) {
TDebug.out(m_header.toString());
}
} catch (Exception e) {
throw new UnsupportedAudioFileException("not a MPEG stream:"
+ e.getMessage());
}
// Deeper checks ?
int cVersion = (nHeader >> 19) & 0x3;
if (cVersion == 1) {
throw new UnsupportedAudioFileException(
"not a MPEG stream: wrong version");
}
int cSFIndex = (nHeader >> 10) & 0x3;
if (cSFIndex == 3) {
throw new UnsupportedAudioFileException(
"not a MPEG stream: wrong sampling rate");
}
AudioFormat format = new MpegAudioFormat(encoding, (float) nFrequency,
AudioSystem.NOT_SPECIFIED, nChannels, -1, FrameRate, true, af_properties);
return new MpegAudioFileFormat(MpegFileFormatType.MP3, format,
nTotalFrames, mLength, aff_properties);
}
}
}

View File

@ -0,0 +1,198 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* This Code is based on the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/io/WaveDecoder.java
*/
package org.wyrez.audio.decoder;
import java.io.BufferedInputStream;
import java.io.InputStream;
import org.wyrez.audio.util.EndianDataInputStream;
/**
* A simple converter that can read in the PCM data from a Wav file, converting
* the data to signed 32-bit floats in the range [-1,1]. This only supports
* 16-bit Wav files with a maximum of 2 channels.
*
* @author Darth Affe
*/
public class WaveDecoder implements Decoder {
private final float MAX_VALUE = 1.0f / Short.MAX_VALUE;//inverse max short value as float
private final EndianDataInputStream in;
private final int channels;
private final float samplingRate;
/**
* Constructor, sets the input stream to read the Wav file from. Audio files
* with more than 2 channels aren't supported!
*
* @param stream The input stream.
* @throws Exception in case the input stream couldn't be read properly
*/
public WaveDecoder(InputStream stream) throws Exception {
if (stream == null) {
throw new IllegalArgumentException("Input stream must not be null");
}
in = new EndianDataInputStream(new BufferedInputStream(stream, 1024 * 1024));
if (!in.read4ByteString().equals("RIFF")) {
throw new IllegalArgumentException("not a wav");
}
in.readIntLittleEndian();
if (!in.read4ByteString().equals("WAVE")) {
throw new IllegalArgumentException("expected WAVE tag");
}
if (!in.read4ByteString().equals("fmt ")) {
throw new IllegalArgumentException("expected fmt tag");
}
if (in.readIntLittleEndian() != 16) {
throw new IllegalArgumentException("expected wave chunk size to be 16");
}
if (in.readShortLittleEndian() != 1) {
throw new IllegalArgumentException("expected format to be 1");
}
channels = in.readShortLittleEndian();
if (channels > 2) {
throw new IllegalArgumentException("more than 2 channels aren't supported");
}
samplingRate = in.readIntLittleEndian();
in.readIntLittleEndian();
in.readShortLittleEndian();
int fmt = in.readShortLittleEndian();
if (fmt != 16) {
throw new IllegalArgumentException("Only 16-bit signed format supported");
}
if (!in.read4ByteString().equals("data")) {
throw new RuntimeException("expected data tag");
}
in.readIntLittleEndian();
}
/**
* Tries to read in samples.length stereo samples, converting non float
* formats to float 32-bit. Returns the number of samples actually read.
* Guarantees that samples.length samples are read in if there was enough
* data in the stream.
*
* @param samples The samples array to write the samples to
* @return The number of samples actually read
*/
@Override
public int readSamplesStereo(float[] samples) {
switch (channels) {
case 1:
return readMonoAsStereo(samples);
case 2:
return readRealStereo(samples);
default:
return 0;
}
}
private int readRealStereo(float[] samples) {
int readSamples = 0;
for (int i = 0; i < samples.length - 1; i += 2) {
try {
samples[i] = in.readShortLittleEndian() * MAX_VALUE;
samples[i + 1] = in.readShortLittleEndian() * MAX_VALUE;
readSamples += 2;
} catch (Exception ex) {
break;
}
}
return readSamples;
}
private int readMonoAsStereo(float[] samples) {
int readSamples = 0;
for (int i = 0; i < samples.length - 1; i += 2) {
try {
float sample = in.readShortLittleEndian() * MAX_VALUE;
samples[i] = sample;
samples[i + 1] = sample;
readSamples += 2;
} catch (Exception ex) {
break;
}
}
return readSamples;
}
/**
* Tries to read in samples.length samples, merging stereo to a mono channel
* by averaging and converting non float formats to float 32-bit. Returns
* the number of samples actually read. Guarantees that samples.length
* samples are read in if there was enough data in the stream.
*
* @param samples The samples array to write the samples to
* @return The number of samples actually read
*/
@Override
public int readSamplesMergedMono(float[] samples) {
int readSamples = 0;
for (int i = 0; i < samples.length; i++) {
float sample = 0;
try {
for (int j = 0; j < channels; j++) {
int shortValue = in.readShortLittleEndian();
sample += (shortValue * MAX_VALUE);
}
sample /= channels;
samples[i] = sample;
readSamples++;
} catch (Exception ex) {
break;
}
}
return readSamples;
}
/**
* Returns the number of channels in the audio source. (This value can't be
* greater than 2)
*
* @returns The channel count
*/
@Override
public int getChannelCount() {
return channels;
}
/**
* Returns the sampling rate in Hz of the audio source.
*
* @returns the sampling rate as floatF
*/
@Override
public float getSamplingRate() {
return samplingRate;
}
}

View File

@ -0,0 +1,56 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.wyrez.audio.util;
/**
* Defines a band between of two frequencies.
*
* @author Darth Affe
*/
public class Band {
private float lowFrequenzy;
private float highFrequenzy;
public Band(float lowFrequenzy, float highFrequenzy) {
if (lowFrequenzy <= highFrequenzy) {
this.lowFrequenzy = lowFrequenzy;
this.highFrequenzy = highFrequenzy;
} else {
this.lowFrequenzy = highFrequenzy;
this.highFrequenzy = lowFrequenzy;
}
}
/**
* Returns the lower frequency of the band.
*
* @return The frequency as float
*/
public float getLowFrequenzy() {
return lowFrequenzy;
}
/**
* Returns the higher frequency of the band.
*
* @return The frequency as float
*/
public float getHighFrequenzy() {
return highFrequenzy;
}
}

View File

@ -0,0 +1,54 @@
/*
* This Code is taken from the source provided with a tutorial by
* http://www.badlogicgames.com (as of 16.05.2013).
* The original source can be found here:
* http://code.google.com/p/audio-analysis/source/browse/trunk/src/com/badlogic/audio/io/EndianDataInputStream.java
*/
package org.wyrez.audio.util;
import java.io.DataInputStream;
import java.io.InputStream;
public class EndianDataInputStream extends DataInputStream {
public EndianDataInputStream(InputStream in) {
super(in);
}
public String read4ByteString() throws Exception {
byte[] bytes = new byte[4];
readFully(bytes);
return new String(bytes, "US-ASCII");
}
public short readShortLittleEndian() throws Exception {
int result = readUnsignedByte();
result |= readUnsignedByte() << 8;
return (short) result;
}
public int readIntLittleEndian() throws Exception {
int result = readUnsignedByte();
result |= readUnsignedByte() << 8;
result |= readUnsignedByte() << 16;
result |= readUnsignedByte() << 24;
return result;
}
public int readInt24BitLittleEndian() throws Exception {
int result = readUnsignedByte();
result |= readUnsignedByte() << 8;
result |= readUnsignedByte() << 16;
if ((result & (1 << 23)) == 8388608) {
result |= 0xff000000;
}
return result;
}
public int readInt24Bit() throws Exception {
int result = readUnsignedByte() << 16;
result |= readUnsignedByte() << 8;
result |= readUnsignedByte();
return result;
}
}

View File

@ -0,0 +1,100 @@
/*
* Copyright (C) 2013 Darth Affe <http://wyrez.org> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.wyrez.audio.util;
import java.util.ArrayList;
import java.util.List;
import org.wyrez.audio.decoder.Decoder;
/**
* Helper class for sample-processing.
*
* @author Darth Affe
*/
public class SampleHelper {
/**
* Converts a list of floats to an array of floats.
*
* @param samples The List to convert
* @returns The new float array
*/
public static float[] convertToFloatArray(List<Float> samples) {
float[] array = new float[samples.size()];
for (int i = 0; i < array.length; i++) {
array[i] = samples.get(i);
}
return array;
}
/**
* Creates an float array with the given length containing only the one
* given value.
*
* @param f The value to fill the array with
* @param length The length of the array
* @returns The new array
*/
public static float[] createFloatArray(float f, int length) {
float[] result = new float[length];
for (int i = 0; i < length; i++) {
result[i] = f;
}
return result;
}
/**
* Splits an array of floats.
*
* @param samples The source array to split
* @param offset The offset to split from
* @param length The length of the new array
*
* @retrn The new array
*
* @throws IllegalArgumentException Thrown if there aren't enough samples to
* proceed
*/
public static float[] splitSampleArray(float[] samples, int offset, int length)
throws IllegalArgumentException {
if (offset + length > samples.length) {
throw new IllegalArgumentException("There aren't enough samples in order to do that");
}
float[] result = new float[length];
for (int i = 0, j = offset; i < length; i++, j++) {
result[i] = samples[j];
}
return result;
}
/**
* Reads all samples mono merged from the given decoder.
*
* @param deocder The decoder to read from
* @returns The float array containing the samples
*/
public static float[] readAllSamples(Decoder decoder) {
List<Float> samples = new ArrayList<Float>();
float[] buffer = new float[1024];
while (decoder.readSamplesMergedMono(buffer) > 0) {
for (int i = 0; i < buffer.length; i++) {
samples.add(buffer[i]);
}
}
return convertToFloatArray(samples);
}
}

View File

@ -0,0 +1,481 @@
GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 library GPL. It is
numbered 2 because it goes with version 2 of the ordinary GPL.]
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 Library General Public License, applies to some
specially designated Free Software Foundation software, and to any
other libraries whose authors decide to use it. You can use it for
your libraries, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the 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 a program 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.
Our method of protecting your rights has two steps: (1) copyright
the library, and (2) offer you this license which gives you legal
permission to copy, distribute and/or modify the library.
Also, for each distributor's protection, we want to make certain
that everyone understands that there is no warranty for this free
library. If the library is modified by someone else and passed on, we
want its recipients to know that what they have is not the original
version, so that any problems introduced by others will not reflect on
the original authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that companies distributing free
software will individually obtain patent licenses, thus in effect
transforming the program into proprietary software. To prevent this,
we have made it clear that any patent must be licensed for everyone's
free use or not licensed at all.
Most GNU software, including some libraries, is covered by the ordinary
GNU General Public License, which was designed for utility programs. This
license, the GNU Library General Public License, applies to certain
designated libraries. This license is quite different from the ordinary
one; be sure to read it in full, and don't assume that anything in it is
the same as in the ordinary license.
The reason we have a separate public license for some libraries is that
they blur the distinction we usually make between modifying or adding to a
program and simply using it. Linking a program with a library, without
changing the library, is in some sense simply using the library, and is
analogous to running a utility program or application program. However, in
a textual and legal sense, the linked executable is a combined work, a
derivative of the original library, and the ordinary General Public License
treats it as such.
Because of this blurred distinction, using the ordinary General
Public License for libraries did not effectively promote software
sharing, because most developers did not use the libraries. We
concluded that weaker conditions might promote sharing better.
However, unrestricted linking of non-free programs would deprive the
users of those programs of all benefit from the free status of the
libraries themselves. This Library General Public License is intended to
permit developers of non-free programs to use free libraries, while
preserving your freedom as a user of such programs to change the free
libraries that are incorporated in them. (We have not seen how to achieve
this as regards changes in header files, but we have achieved it as regards
changes in the actual functions of the Library.) The hope is that this
will lead to faster development of free libraries.
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, while the latter only
works together with the library.
Note that it is possible for a library to be covered by the ordinary
General Public License rather than by this special one.
GNU LIBRARY GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library which
contains a notice placed by the copyright holder or other authorized
party saying it may be distributed under the terms of this Library
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 compile 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) 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.
c) 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.
d) 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 source code 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 to
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 Library 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
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!