Initial commit
This commit is contained in:
commit
3785f97e1e
|
@ -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>.
|
|
@ -0,0 +1,54 @@
|
|||
CC := $(CROSS_COMPILE)gcc
|
||||
LD := $(CROSS_COMPILE)gcc
|
||||
STRIP := $(CROSS_COMPILE)strip
|
||||
|
||||
# -Wno-multichar is used for vban.h:25 define.
|
||||
CFLAGS := -DLINUX -ansi -Wpedantic -Wall -Wno-multichar
|
||||
LDFLAGS := -lasound
|
||||
|
||||
# Defaultly compiles release version of the application
|
||||
CONFIG := release
|
||||
|
||||
ifneq ($(filter release%,$(CONFIG)),)
|
||||
LDFLAGS += -O3
|
||||
endif
|
||||
|
||||
ifneq ($(filter debug%,$(CONFIG)),)
|
||||
CFLAGS += -g
|
||||
endif
|
||||
|
||||
SOURCES := main.c \
|
||||
socket.c \
|
||||
audio.c \
|
||||
|
||||
OBJECTS := $(SOURCES:.c=.o)
|
||||
DEPENDENCIES:= $(SOURCES:.c=.d)
|
||||
EXECUTABLE := vban_receptor
|
||||
|
||||
all: $(EXECUTABLE)
|
||||
|
||||
$(EXECUTABLE): $(OBJECTS)
|
||||
@echo "Linking $@"
|
||||
@$(LD) $(LDFLAGS) -o "$@" $^
|
||||
ifneq ($(filter release%,$(CONFIG)),)
|
||||
@echo "Stripping $@"
|
||||
@$(STRIP) "$@"
|
||||
endif
|
||||
|
||||
%.o:%.c
|
||||
@echo "Compiling $<"
|
||||
@$(CC) -c $(CFLAGS) -MMD -MF "$(patsubst %.o,%.d,$@)" -o "$@" "$<"
|
||||
|
||||
-include $(DEPENDENCIES)
|
||||
|
||||
install:
|
||||
@mkdir -p $(DESTDIR)/usr/sbin
|
||||
@cp $(EXECUTABLE) $(DESTDIR)/usr/sbin
|
||||
|
||||
clean:
|
||||
@echo "Cleaning artifacts and objects"
|
||||
@rm -f $(OBJECTS) $(DEPENDENCIES) $(EXECUTABLE)
|
||||
@rm -f *~*
|
||||
|
||||
distclean: clean
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
vban_receptor - Linux command-line VBAN to alsa player
|
||||
======================================================
|
||||
|
||||
© 2015 Benoît Quiniou - quiniouben[at]yahoo(.)fr
|
||||
|
||||
vban_receptor is an open-source implementation of VBAN protocol.
|
||||
It currently takes the form of a Linux command-line player to play a VBAN audio stream to alsa local audio device.
|
||||
VBAN is a simple audio over UDP protocol proposed by VB-Audio, see [VBAN Audio webpage](http://vb-audio.pagesperso-orange.fr/Voicemeeter/vban.htm).
|
||||
|
||||
Compilation and installation
|
||||
----------------------------
|
||||
|
||||
vban_receptor doesn't have a configure script. Nevertheless the makefile is very simple and has some basic variables (CC, LD, STRIP, CROSS_COMPILE, DESTDIR) to define whatever compilation toolchain you wish to use and where you want to install. This will probably evolve in future releases.
|
||||
So simply use:
|
||||
|
||||
$ make
|
||||
# make install
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Invoking vban_receptor without any parameter will give hints on how to use it :
|
||||
|
||||
Usage: vban_receptor [OPTIONS]...
|
||||
|
||||
-i, --ipaddress=IP : ipaddress to get stream from
|
||||
-p, --port=PORT : port to listen to
|
||||
-s, --streamname=NAME : streamname to play
|
||||
-q, --quality=ID : network quality indicator from 0 (low latency) to 4. default is 1
|
||||
-h, --help : display this message
|
||||
|
||||
|
|
@ -0,0 +1,332 @@
|
|||
/*
|
||||
* This file is part of vban_receptor.
|
||||
* Copyright (c) 2015 by Benoît Quiniou <quiniouben@yahoo.fr>
|
||||
*
|
||||
* vban_receptor 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.
|
||||
*
|
||||
* vban_receptor 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 vban_receptor. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "audio.h"
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
#define AUDIO_DEVICE "default"
|
||||
|
||||
struct audio_t
|
||||
{
|
||||
snd_pcm_t* alsa_handle;
|
||||
enum VBanBitResolution bitResolution;
|
||||
unsigned int nbChannels;
|
||||
unsigned int rate;
|
||||
size_t buffer_size;
|
||||
};
|
||||
|
||||
static int audio_is_format_supported(audio_handle_t handle, enum VBanBitResolution bit_resolution, unsigned int nb_channels, unsigned int rate);
|
||||
static int audio_open(audio_handle_t handle, enum VBanBitResolution bit_resolution, unsigned int nb_channels, unsigned int rate);
|
||||
static int audio_close(audio_handle_t handle);
|
||||
static int audio_write(audio_handle_t handle, char const* data, size_t size);
|
||||
static size_t computeSize(unsigned char quality);
|
||||
|
||||
static snd_pcm_format_t vban_to_alsa_format(enum VBanBitResolution bit_resolution)
|
||||
{
|
||||
switch (bit_resolution)
|
||||
{
|
||||
case VBAN_BITFMT_8_INT:
|
||||
return SND_PCM_FORMAT_S8;
|
||||
|
||||
case VBAN_BITFMT_16_INT:
|
||||
return SND_PCM_FORMAT_S16;
|
||||
|
||||
case VBAN_BITFMT_24_INT:
|
||||
return SND_PCM_FORMAT_S24;
|
||||
|
||||
case VBAN_BITFMT_32_INT:
|
||||
return SND_PCM_FORMAT_S32;
|
||||
|
||||
case VBAN_BITFMT_32_FLOAT:
|
||||
return SND_PCM_FORMAT_FLOAT;
|
||||
|
||||
case VBAN_BITFMT_64_FLOAT:
|
||||
return SND_PCM_FORMAT_FLOAT64;
|
||||
|
||||
default:
|
||||
return SND_PCM_FORMAT_UNKNOWN;
|
||||
}
|
||||
}
|
||||
|
||||
size_t computeSize(unsigned char quality)
|
||||
{
|
||||
size_t const nmin = VBAN_PROTOCOL_MAX_SIZE;
|
||||
size_t nnn = 0;
|
||||
|
||||
switch(quality)
|
||||
{
|
||||
case 0:
|
||||
nnn = 512;
|
||||
break;
|
||||
|
||||
case 1:
|
||||
nnn = 1024;
|
||||
break;
|
||||
|
||||
case 2:
|
||||
nnn = 2048;
|
||||
break;
|
||||
|
||||
case 3:
|
||||
nnn = 4096;
|
||||
break;
|
||||
|
||||
case 4:
|
||||
nnn = 8192;
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
nnn=nnn*3;
|
||||
|
||||
if (nnn < nmin)
|
||||
{
|
||||
nnn = nmin;
|
||||
}
|
||||
|
||||
return nnn;
|
||||
}
|
||||
|
||||
int audio_init(audio_handle_t* handle, unsigned char quality)
|
||||
{
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("audio_init: null handle pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
*handle = (struct audio_t*)malloc(sizeof(struct audio_t));
|
||||
if (*handle == 0)
|
||||
{
|
||||
printf("audio_init: could not allocate memory\n");
|
||||
return -ENOMEM;
|
||||
}
|
||||
|
||||
(*handle)->buffer_size = computeSize(quality);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
int audio_release(audio_handle_t* handle)
|
||||
{
|
||||
int ret = 0;
|
||||
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("audio_release: null handle pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (*handle != 0)
|
||||
{
|
||||
ret = audio_close(*handle);
|
||||
free(*handle);
|
||||
*handle = 0;
|
||||
}
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
int audio_process_packet(audio_handle_t handle, char const* buffer, int size)
|
||||
{
|
||||
struct VBanHeader const* const hdr = (struct VBanHeader const*)buffer;
|
||||
int payload_size = 0;
|
||||
int ret = 0;
|
||||
long sample_rate = 0;
|
||||
int nb_samples = 0;
|
||||
int nb_channels = 0;
|
||||
int sample_size = 0;
|
||||
enum VBanBitResolution bit_resolution = VBAN_BIT_RESOLUTION_MAX;
|
||||
|
||||
if ((handle == 0) || (buffer == 0))
|
||||
{
|
||||
printf("audio_process_packet: handle pointer or buffer pointer is null\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
/** extract audio parameters from header */
|
||||
nb_samples = hdr->format_nbs + 1;
|
||||
nb_channels = hdr->format_nbc + 1;
|
||||
bit_resolution = (hdr->format_bit & VBAN_BIT_RESOLUTION_MASK);
|
||||
|
||||
/** error in bit_resolution */
|
||||
if (bit_resolution >= VBAN_BIT_RESOLUTION_MAX)
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
sample_size = VBanBitResolutionSize[bit_resolution];
|
||||
payload_size = nb_samples * sample_size * nb_channels;
|
||||
|
||||
/** check expected payload size */
|
||||
if (payload_size != (size - VBAN_HEADER_SIZE))
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
/** check that format is supported */
|
||||
sample_rate = ((hdr->format_SR & VBAN_SR_MASK) < VBAN_SR_MAXNUMBER)
|
||||
? VBanSRList[(hdr->format_SR & VBAN_SR_MASK)]
|
||||
: 0;
|
||||
ret = audio_is_format_supported(handle, bit_resolution, nb_channels, sample_rate);
|
||||
if (ret <= 0)
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
/** check that audio device is configured at correct format */
|
||||
if ((bit_resolution != handle->bitResolution)
|
||||
|| (nb_channels != handle->nbChannels)
|
||||
|| (sample_rate != handle->rate))
|
||||
{
|
||||
/* we have to (re-)open the device with correct format */
|
||||
ret = audio_open(handle, bit_resolution, nb_channels, sample_rate);
|
||||
if (ret < 0)
|
||||
{
|
||||
/* some error occured */
|
||||
goto end;
|
||||
}
|
||||
}
|
||||
|
||||
/** write payload to the audio device */
|
||||
ret = audio_write(handle, (char const*)(hdr + 1), nb_samples);
|
||||
|
||||
end:
|
||||
return ret;
|
||||
}
|
||||
|
||||
int audio_is_format_supported(audio_handle_t handle, enum VBanBitResolution bit_resolution, unsigned int nb_channels, unsigned int rate)
|
||||
{
|
||||
/*XXX todo */
|
||||
return 1;
|
||||
}
|
||||
|
||||
int audio_open(audio_handle_t handle, enum VBanBitResolution bit_resolution, unsigned int nb_channels, unsigned int rate)
|
||||
{
|
||||
int ret = 0;
|
||||
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("audio_open: handle pointer is null\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
ret = audio_close(handle);
|
||||
if (ret < 0)
|
||||
{
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = snd_pcm_open(&handle->alsa_handle, AUDIO_DEVICE, SND_PCM_STREAM_PLAYBACK, 0);
|
||||
if (ret < 0)
|
||||
{
|
||||
printf("audio_open: open error: %s\n", snd_strerror(ret));
|
||||
handle->alsa_handle = 0;
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = snd_pcm_set_params(handle->alsa_handle,
|
||||
vban_to_alsa_format(bit_resolution),
|
||||
SND_PCM_ACCESS_RW_INTERLEAVED,
|
||||
nb_channels,
|
||||
rate,
|
||||
1,
|
||||
((unsigned int)handle->buffer_size * 1000000) / rate);
|
||||
|
||||
if (ret < 0)
|
||||
{
|
||||
printf("audio_open: set_params error: %s", snd_strerror(ret));
|
||||
audio_close(handle);
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = snd_pcm_prepare(handle->alsa_handle);
|
||||
if (ret < 0)
|
||||
{
|
||||
printf("audio_open: prepare error: %s", snd_strerror(ret));
|
||||
audio_close(handle);
|
||||
return ret;
|
||||
}
|
||||
|
||||
handle->bitResolution = bit_resolution;
|
||||
handle->nbChannels = nb_channels;
|
||||
handle->rate = rate;
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
int audio_close(audio_handle_t handle)
|
||||
{
|
||||
int ret = 0;
|
||||
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("audio_close: handle pointer is null\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (handle->alsa_handle == 0)
|
||||
{
|
||||
/** nothing to do */
|
||||
return 0;
|
||||
}
|
||||
|
||||
ret = snd_pcm_close(handle->alsa_handle);
|
||||
handle->alsa_handle = 0;
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
int audio_write(audio_handle_t handle, char const* data, size_t size)
|
||||
{
|
||||
int ret = 0;
|
||||
|
||||
if ((handle == 0) || (data == 0))
|
||||
{
|
||||
printf("audio_write: handle or data pointer is null\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (handle->alsa_handle == 0)
|
||||
{
|
||||
printf("audio_write: device not open\n");
|
||||
return -ENODEV;
|
||||
}
|
||||
|
||||
ret = snd_pcm_writei(handle->alsa_handle, data, size);
|
||||
if (ret < 0)
|
||||
{
|
||||
printf("audio_write: snd_pcm_writei failed: %s\n", snd_strerror(ret));
|
||||
ret = snd_pcm_recover(handle->alsa_handle, ret, 0);
|
||||
if (ret < 0)
|
||||
{
|
||||
printf("audio_write: snd_pcm_writei failed: %s\n", snd_strerror(ret));
|
||||
}
|
||||
}
|
||||
else if (ret > 0 && ret < size)
|
||||
{
|
||||
printf("audio_write: short write (expected %lu, wrote %i)\n", size, ret);
|
||||
}
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
/*
|
||||
* This file is part of vban_receptor.
|
||||
* Copyright (c) 2015 by Benoît Quiniou <quiniouben@yahoo.fr>
|
||||
*
|
||||
* vban_receptor 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.
|
||||
*
|
||||
* vban_receptor 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 vban_receptor. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef __AUDIO_H__
|
||||
#define __AUDIO_H__
|
||||
|
||||
#include "vban.h"
|
||||
#include <alsa/asoundlib.h>
|
||||
#include <stddef.h>
|
||||
#include <errno.h>
|
||||
|
||||
struct audio_t;
|
||||
typedef struct audio_t* audio_handle_t;
|
||||
|
||||
int audio_init(audio_handle_t* handle, unsigned char quality);
|
||||
int audio_release(audio_handle_t* handle);
|
||||
|
||||
int audio_process_packet(audio_handle_t handle, char const* buffer, int size);
|
||||
|
||||
#endif /*__AUDIO_H__*/
|
|
@ -0,0 +1,231 @@
|
|||
/*
|
||||
* This file is part of vban_receptor.
|
||||
* Copyright (c) 2015 by Benoît Quiniou <quiniouben@yahoo.fr>
|
||||
*
|
||||
* vban_receptor 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.
|
||||
*
|
||||
* vban_receptor 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 vban_receptor. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <signal.h>
|
||||
#include <getopt.h>
|
||||
#include "vban.h"
|
||||
#include "socket.h"
|
||||
#include "audio.h"
|
||||
|
||||
#define VBAN_RECEPTOR_VERSION "v0.5"
|
||||
#define MAIN_IP_ADDRESS_SIZE 32
|
||||
|
||||
struct config_t
|
||||
{
|
||||
char ip_address[MAIN_IP_ADDRESS_SIZE];
|
||||
unsigned short port;
|
||||
char stream_name[VBAN_STREAM_NAME_SIZE];
|
||||
unsigned char quality;
|
||||
};
|
||||
|
||||
struct main_t
|
||||
{
|
||||
socket_handle_t socket;
|
||||
audio_handle_t audio;
|
||||
struct config_t config;
|
||||
char buffer[VBAN_PROTOCOL_MAX_SIZE];
|
||||
};
|
||||
|
||||
static int MainRun = 1;
|
||||
void signalHandler(int signum)
|
||||
{
|
||||
MainRun = 0;
|
||||
}
|
||||
|
||||
void usage()
|
||||
{
|
||||
printf("Usage: vban_receptor [OPTIONS]...\n\n");
|
||||
printf("-i, --ipaddress=IP : ipaddress to get stream from\n");
|
||||
printf("-p, --port=PORT : port to listen to\n");
|
||||
printf("-s, --streamname=NAME : streamname to play\n");
|
||||
printf("-q, --quality=ID : network quality indicator from 0 (low latency) to 4. default is 1\n");
|
||||
printf("-h, --help : display this message\n\n");
|
||||
}
|
||||
|
||||
int get_options(struct config_t* config, int argc, char* const* argv)
|
||||
{
|
||||
int c = 0;
|
||||
int index = 0;
|
||||
static const struct option options[] =
|
||||
{
|
||||
{"ipaddress", required_argument, 0, 'i'},
|
||||
{"port", required_argument, 0, 'p'},
|
||||
{"streamname", required_argument, 0, 's'},
|
||||
{"quality", required_argument, 0, 'd'},
|
||||
{"help", no_argument, 0, 'h'}
|
||||
};
|
||||
|
||||
/* yes, I assume config is not 0 */
|
||||
while (1)
|
||||
{
|
||||
c = getopt_long(argc, argv, "i:p:s:q:h", options, &index);
|
||||
if (c == -1)
|
||||
break;
|
||||
|
||||
switch (c)
|
||||
{
|
||||
case 'i':
|
||||
memcpy(config->ip_address, optarg, MAIN_IP_ADDRESS_SIZE);
|
||||
break;
|
||||
|
||||
case 'p':
|
||||
config->port = atoi(optarg);
|
||||
break;
|
||||
|
||||
case 's':
|
||||
memcpy(config->stream_name, optarg, VBAN_STREAM_NAME_SIZE);
|
||||
break;
|
||||
|
||||
case 'q':
|
||||
config->quality = atoi(optarg);
|
||||
break;
|
||||
|
||||
case 'h':
|
||||
default:
|
||||
usage();
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
/** check if we got all arguments */
|
||||
if ((config->ip_address[0] == 0)
|
||||
|| (config->port == 0)
|
||||
|| (config->stream_name[0] == 0))
|
||||
{
|
||||
usage();
|
||||
return 1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** This is where all VBan specific handling is done */
|
||||
int process_packet(struct main_t* s_main, int size, char const* ipfrom)
|
||||
{
|
||||
int ret = 0;
|
||||
enum VBanProtocol protocol = VBAN_PROTOCOL_UNDEFINED_4;
|
||||
enum VBanCodec codec = VBAN_BIT_RESOLUTION_MAX;
|
||||
|
||||
/* yes, I assume s_main is not 0, neither s_main->buffer */
|
||||
struct VBanHeader const* const hdr = (struct VBanHeader const*)s_main->buffer;
|
||||
|
||||
/** check size */
|
||||
if (size <= VBAN_HEADER_SIZE)
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
/** check header magic bytes */
|
||||
if (hdr->vban != VBAN_HEADER_FOURC)
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
/** check stream identity */
|
||||
if (strcmp(ipfrom, s_main->config.ip_address)
|
||||
|| strcmp(s_main->config.stream_name, hdr->streamname))
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
/** check the reserved bit : it must be 0 */
|
||||
if (hdr->format_bit & VBAN_RESERVED_MASK)
|
||||
{
|
||||
goto end;
|
||||
}
|
||||
|
||||
/** check protocol and codec */
|
||||
protocol = hdr->format_SR & VBAN_PROTOCOL_MASK;
|
||||
codec = hdr->format_bit & VBAN_CODEC_MASK;
|
||||
|
||||
switch (protocol)
|
||||
{
|
||||
case VBAN_PROTOCOL_AUDIO:
|
||||
if (codec == VBAN_CODEC_PCM)
|
||||
{
|
||||
ret = audio_process_packet(s_main->audio, s_main->buffer, size);
|
||||
}
|
||||
break;
|
||||
|
||||
case VBAN_PROTOCOL_SERIAL:
|
||||
case VBAN_PROTOCOL_TXT:
|
||||
case VBAN_PROTOCOL_UNDEFINED_1:
|
||||
case VBAN_PROTOCOL_UNDEFINED_2:
|
||||
case VBAN_PROTOCOL_UNDEFINED_3:
|
||||
case VBAN_PROTOCOL_UNDEFINED_4:
|
||||
/** not supported yet */
|
||||
break;
|
||||
|
||||
default:
|
||||
printf("process_packet: packet with unknown protocol\n");
|
||||
ret = -EINVAL;
|
||||
break;
|
||||
}
|
||||
|
||||
end:
|
||||
return (ret < 0) ? ret : size;
|
||||
}
|
||||
|
||||
int main(int argc, char* const* argv)
|
||||
{
|
||||
int ret = 0;
|
||||
struct main_t s_main;
|
||||
char ipfrom[MAIN_IP_ADDRESS_SIZE];
|
||||
|
||||
printf("vban_receptor version %s\n", VBAN_RECEPTOR_VERSION);
|
||||
|
||||
memset(&s_main, 0, sizeof(struct main_t));
|
||||
if (get_options(&s_main.config, argc, argv))
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
|
||||
signal(SIGINT, signalHandler);
|
||||
signal(SIGTERM, signalHandler);
|
||||
|
||||
ret = socket_init(&s_main.socket);
|
||||
if (ret != 0)
|
||||
{
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = audio_init(&s_main.audio, s_main.config.quality);
|
||||
if (ret != 0)
|
||||
{
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = socket_open(s_main.socket, s_main.config.port, 0);
|
||||
|
||||
while ((ret >= 0) && MainRun)
|
||||
{
|
||||
ret = socket_recvfrom(s_main.socket, s_main.buffer, VBAN_PROTOCOL_MAX_SIZE, ipfrom);
|
||||
if (ret > 0)
|
||||
{
|
||||
ret = process_packet(&s_main, ret, ipfrom);
|
||||
}
|
||||
}
|
||||
|
||||
audio_release(&s_main.audio);
|
||||
socket_release(&s_main.socket);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
|
@ -0,0 +1,174 @@
|
|||
/*
|
||||
* This file is part of vban_receptor.
|
||||
* Copyright (c) 2015 by Benoît Quiniou <quiniouben@yahoo.fr>
|
||||
*
|
||||
* vban_receptor 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.
|
||||
*
|
||||
* vban_receptor 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 vban_receptor. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "socket.h"
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <sys/socket.h>
|
||||
#include <netinet/in.h>
|
||||
#include <arpa/inet.h>
|
||||
#include <sys/poll.h>
|
||||
#include <unistd.h>
|
||||
|
||||
struct socket_t
|
||||
{
|
||||
int fd;
|
||||
};
|
||||
|
||||
int socket_init(socket_handle_t* handle)
|
||||
{
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("socket_init: null handle pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
*handle = (struct socket_t*)malloc(sizeof(struct socket_t));
|
||||
if (*handle == 0)
|
||||
{
|
||||
printf("socket_init: could not allocate memory\n");
|
||||
return -ENOMEM;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
int socket_release(socket_handle_t* handle)
|
||||
{
|
||||
int ret = 0;
|
||||
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("socket_release: null handle pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (*handle != 0)
|
||||
{
|
||||
ret = socket_close(*handle);
|
||||
free(*handle);
|
||||
*handle = 0;
|
||||
}
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
int socket_open(socket_handle_t handle, short port, unsigned int timeout)
|
||||
{
|
||||
int ret = 0;
|
||||
struct sockaddr_in si_me;
|
||||
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("socket_open: one parameter is a null pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (handle->fd != 0)
|
||||
{
|
||||
ret = socket_close(handle);
|
||||
if (ret != 0)
|
||||
{
|
||||
printf("socket_open: socket was open and unable to close it\n");
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
|
||||
handle->fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
|
||||
if (handle->fd < 0)
|
||||
{
|
||||
printf("socket_open: unable to create socket\n");
|
||||
ret = handle->fd;
|
||||
handle->fd = 0;
|
||||
return ret;
|
||||
}
|
||||
|
||||
memset(&si_me, 0, sizeof(si_me));
|
||||
si_me.sin_family = AF_INET;
|
||||
si_me.sin_port = htons(port);
|
||||
si_me.sin_addr.s_addr = htonl(INADDR_ANY);
|
||||
ret = bind(handle->fd, (struct sockaddr const*)&si_me, sizeof(si_me));
|
||||
|
||||
if (ret < 0)
|
||||
{
|
||||
printf("socket_open: unable to bind socket\n");
|
||||
socket_close(handle);
|
||||
return errno;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
int socket_close(socket_handle_t handle)
|
||||
{
|
||||
int ret = 0;
|
||||
|
||||
if (handle == 0)
|
||||
{
|
||||
printf("socket_close: handle parameter is a null pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (handle->fd != 0)
|
||||
{
|
||||
ret = close(handle->fd);
|
||||
handle->fd = 0;
|
||||
if (ret != 0)
|
||||
{
|
||||
printf("socket_close: unable to close socket\n");
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
int socket_recvfrom(socket_handle_t handle, char* buffer, size_t size, char* ipfrom)
|
||||
{
|
||||
int ret = 0;
|
||||
struct sockaddr_in si_other;
|
||||
socklen_t slen = sizeof(si_other);
|
||||
|
||||
if ((handle == 0) || (buffer == 0) || (ipfrom == 0))
|
||||
{
|
||||
printf("socket_readfrom: one parameter is a null pointer\n");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (handle->fd == 0)
|
||||
{
|
||||
printf("socket_readfrom: socket is not open\n");
|
||||
return -ENODEV;
|
||||
}
|
||||
|
||||
ret = recvfrom(handle->fd, buffer, size, 0, (struct sockaddr *) &si_other, &slen);
|
||||
if (ret < 0)
|
||||
{
|
||||
if (errno != EINTR)
|
||||
{
|
||||
printf("socket_readfrom: recvfrom error %d %s\n", errno, strerror(errno));
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
strncpy(ipfrom, inet_ntoa(si_other.sin_addr), 32);
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
/*
|
||||
* This file is part of vban_receptor.
|
||||
* Copyright (c) 2015 by Benoît Quiniou <quiniouben@yahoo.fr>
|
||||
*
|
||||
* vban_receptor 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.
|
||||
*
|
||||
* vban_receptor 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 vban_receptor. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef __SOCKET_HPP__
|
||||
#define __SOCKET_HPP__
|
||||
|
||||
#include <stddef.h>
|
||||
#include <errno.h>
|
||||
|
||||
struct socket_t;
|
||||
typedef struct socket_t* socket_handle_t;
|
||||
|
||||
int socket_init(socket_handle_t* handle);
|
||||
int socket_release(socket_handle_t* handle);
|
||||
|
||||
int socket_open(socket_handle_t handle, short port, unsigned int timeout);
|
||||
int socket_close(socket_handle_t handle);
|
||||
int socket_recvfrom(socket_handle_t handle, char* buffer, size_t size, char* ipfrom);
|
||||
|
||||
#endif /*__SOCKET_HPP__*/
|
||||
|
|
@ -0,0 +1,103 @@
|
|||
/*
|
||||
* This file is part of vban_receptor.
|
||||
* Copyright (c) 2015 by Benoît Quiniou <quiniouben@yahoo.fr>
|
||||
*
|
||||
* vban_receptor 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.
|
||||
*
|
||||
* vban_receptor 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 vban_receptor. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef __VBAN_H__
|
||||
#define __VBAN_H__
|
||||
|
||||
#include <inttypes.h>
|
||||
|
||||
#define VBAN_HEADER_SIZE (4 + 4 + 16 + 4)
|
||||
#define VBAN_HEADER_FOURC 'NABV'
|
||||
#define VBAN_STREAM_NAME_SIZE 16
|
||||
#define VBAN_PROTOCOL_MAX_SIZE 1436
|
||||
|
||||
struct VBanHeader
|
||||
{
|
||||
uint32_t vban; /* contains 'V' 'B', 'A', 'N' */
|
||||
uint8_t format_SR; /* SR index (see SRList above) */
|
||||
uint8_t format_nbs; /* nb sample per frame (1 to 256) */
|
||||
uint8_t format_nbc; /* nb channel (1 to 256) */
|
||||
uint8_t format_bit; /* mask = 0x07 (nb Byte integer from 1 to 4) */
|
||||
char streamname[VBAN_STREAM_NAME_SIZE]; /* stream name */
|
||||
uint32_t nuFrame; /* growing frame number. */
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
#define VBAN_SR_MASK 0x1F
|
||||
#define VBAN_SR_MAXNUMBER 21
|
||||
static long const VBanSRList[VBAN_SR_MAXNUMBER]=
|
||||
{
|
||||
6000, 12000, 24000, 48000, 96000, 192000, 384000,
|
||||
8000, 16000, 32000, 64000, 128000, 256000, 512000,
|
||||
11025, 22050, 44100, 88200, 176400, 352800, 705600
|
||||
};
|
||||
|
||||
#define VBAN_PROTOCOL_MASK 0xE0
|
||||
enum VBanProtocol
|
||||
{
|
||||
VBAN_PROTOCOL_AUDIO = 0x00,
|
||||
VBAN_PROTOCOL_SERIAL = 0x20,
|
||||
VBAN_PROTOCOL_TXT = 0x40,
|
||||
VBAN_PROTOCOL_UNDEFINED_1 = 0x80,
|
||||
VBAN_PROTOCOL_UNDEFINED_2 = 0xA0,
|
||||
VBAN_PROTOCOL_UNDEFINED_3 = 0xC0,
|
||||
VBAN_PROTOCOL_UNDEFINED_4 = 0xE0
|
||||
};
|
||||
|
||||
#define VBAN_BIT_RESOLUTION_MASK 0x07
|
||||
enum VBanBitResolution
|
||||
{
|
||||
VBAN_BITFMT_8_INT = 0,
|
||||
VBAN_BITFMT_16_INT,
|
||||
VBAN_BITFMT_24_INT,
|
||||
VBAN_BITFMT_32_INT,
|
||||
VBAN_BITFMT_32_FLOAT,
|
||||
VBAN_BITFMT_64_FLOAT,
|
||||
VBAN_BIT_RESOLUTION_MAX
|
||||
};
|
||||
|
||||
static int const VBanBitResolutionSize[VBAN_BIT_RESOLUTION_MAX] =
|
||||
{
|
||||
1, 2, 3, 4, 4, 8,
|
||||
};
|
||||
|
||||
#define VBAN_RESERVED_MASK 0x08
|
||||
|
||||
#define VBAN_CODEC_MASK 0xF0
|
||||
enum VBanCodec
|
||||
{
|
||||
VBAN_CODEC_PCM = 0x00,
|
||||
VBAN_CODEC_VBCA = 0x10,
|
||||
VBAN_CODEC_VBCV = 0x20,
|
||||
VBAN_CODEC_UNDEFINED_3 = 0x30,
|
||||
VBAN_CODEC_UNDEFINED_4 = 0x40,
|
||||
VBAN_CODEC_UNDEFINED_5 = 0x50,
|
||||
VBAN_CODEC_UNDEFINED_6 = 0x60,
|
||||
VBAN_CODEC_UNDEFINED_7 = 0x70,
|
||||
VBAN_CODEC_UNDEFINED_8 = 0x80,
|
||||
VBAN_CODEC_UNDEFINED_9 = 0x90,
|
||||
VBAN_CODEC_UNDEFINED_10 = 0xA0,
|
||||
VBAN_CODEC_UNDEFINED_11 = 0xB0,
|
||||
VBAN_CODEC_UNDEFINED_12 = 0xC0,
|
||||
VBAN_CODEC_UNDEFINED_13 = 0xD0,
|
||||
VBAN_CODEC_UNDEFINED_14 = 0xE0,
|
||||
VBAN_CODEC_USER = 0xF0
|
||||
};
|
||||
|
||||
#endif /*__VBAN_H__*/
|
||||
|
Loading…
Reference in New Issue