Compare commits
18 Commits
8964bb030b
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| d4ad426378 | |||
| c11524c596 | |||
| b506fd83de | |||
| 3cb9220ebd | |||
| b660779ada | |||
| 9f2e787158 | |||
| 60dd1de71d | |||
| 7b2c3fdc1f | |||
| b83476f820 | |||
| 8e9a49b587 | |||
| dc064cba29 | |||
| ab25c69b59 | |||
| 8bc34f3f4e | |||
| a85d796f07 | |||
| 5e4fae092a | |||
| 4cbab3cd38 | |||
| 08ad33e27d | |||
| e3f4505d12 |
@@ -1 +1 @@
|
||||
3.11
|
||||
3.11.12
|
||||
|
||||
691
LICENSE
691
LICENSE
@@ -1,29 +1,674 @@
|
||||
BSD 3-Clause License
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (c) 2020, Jamie Hardt
|
||||
All rights reserved.
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
Preamble
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
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.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
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.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
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 <https://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
|
||||
<https://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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
38
README.md
38
README.md
@@ -1,40 +1,24 @@
|
||||
# soundobjects Blender Add-On
|
||||
|
||||
**NOTE**: _Avid made some changes to ADM file import in Pro Tools and it no longer accepts ADMs made by
|
||||
this plugin. It may still work with other DAWs._
|
||||
**NOTE**: _Avid made some changes to ADM file import in Pro Tools and it no
|
||||
longer accepts ADMs made by this plugin. It may still work with other DAWs._
|
||||
|
||||
This add-on adds three operators for working with immersive 3D audio in [Blender][blender], specifically it allows you to create ADM Broadcast
|
||||
WAVE files for use with [Dolby Atmos][atmos] or other object-based sound mixing workflows.
|
||||
This add-on adds three operators for working with immersive 3D audio in
|
||||
[Blender][blender], specifically it allows you to create ADM Broadcast WAVE
|
||||
files for use with [Dolby Atmos][atmos] or other object-based sound mixing
|
||||
workflows.
|
||||
|
||||
[Here](https://vimeo.com/464569386) you can see a short demo of how to add sounds to an animated Blender scene and import the resulting file
|
||||
into Pro Tools and then play them into a Dolby DAPS Renderer.
|
||||
[Here](https://vimeo.com/464569386) you can see a short demo of how to add
|
||||
sounds to an animated Blender scene and import the resulting file into Pro
|
||||
Tools and then play them into a Dolby DAPS Renderer.
|
||||
|
||||
[blender]: https://www.blender.org
|
||||
[atmos]: https://www.dolby.com/technologies/dolby-atmos/
|
||||
|
||||
## Operators
|
||||
|
||||
### `import_test.wav_file_batch`
|
||||
|
||||
**Import WAV Files:** This operator allows you to add multiple audio files to a .blend file so they'll be available to
|
||||
the *Add Sounds to Meshes* operator.
|
||||
|
||||
### `object.add_speakers_to_obj`
|
||||
|
||||
**Add Sounds to Meshes:** This operator takes all the selected objects in the current scene and attaches a new speaker
|
||||
locked to that object's location throughout the animation. You provide the prefix for the name of a set of sound files
|
||||
added with the _Import WAV Files_ operator, and these are added to each selected object randomly. The sounds can be
|
||||
timed to either begin playing at the beginning of the sequence, at a random time, or when the respective object is
|
||||
closest to the scene's camera.
|
||||
|
||||
### `export.adm_wave_file`
|
||||
|
||||
**Export ADM Wave File:** This operator exports all of the speakers in a scene as an ADM Broadcast-WAV file compartible
|
||||
with a Dolby Atmos rendering workflow. This produces a multichannel WAV file with embedded ADM metadata the passes
|
||||
panning information to the client. (Has been tested and works with Avid Pro Tools 2020).
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
This add-on requires that the [EBU Audio Renderer](https://github.com/ebu/ebu_adm_renderer) (`ear` v2.0) Python package
|
||||
This add-on requires that the [EBU Audio
|
||||
Renderer](https://github.com/ebu/ebu_adm_renderer) (`ear` v2.0) Python package
|
||||
be installed to Blender's Python.
|
||||
|
||||
64
__init__.py
64
__init__.py
@@ -1,66 +1,20 @@
|
||||
import bpy
|
||||
|
||||
from .operator_add_speakers_to_objects import AddSoundToMeshOperator
|
||||
from .operator_adm_export import ADMWaveExport
|
||||
from .operator_wav_import import ImportWav
|
||||
|
||||
bl_info = {
|
||||
"name": "Sound Objects",
|
||||
"description": "Tools for adding sounds to objects and export to immersive format",
|
||||
"author": "Jamie Hardt",
|
||||
"version": (0, 1),
|
||||
"warning": "Requires `ear` EBU ADM Renderer package to be installed",
|
||||
"blender": (2, 93, 1),
|
||||
"category": "Import-Export",
|
||||
"support": "TESTING",
|
||||
"tracker_url": "https://github.com/iluvcapra/soundobjects_blender_addon/issues",
|
||||
"wiki_url": ""
|
||||
}
|
||||
|
||||
# class SoundObjectAttachmentPanel(bpy.types.Panel):
|
||||
# bl_idname = "OBJECT_PT_sound_object_attachment_panel"
|
||||
# bl_space_type = "VIEW_3D"
|
||||
# bl_label = "Attach Sounds"
|
||||
# bl_region_type = "UI"
|
||||
# bl_category = "Tools"
|
||||
# bl_context = "object"
|
||||
# bl_options = {"DEFAULT_CLOSED"}
|
||||
|
||||
# def draw(self, context):
|
||||
# self.layout.label(text="Attach Sounds")
|
||||
from .operator_protools_export import SendToProTools
|
||||
|
||||
|
||||
def import_wav_menu_callback(self, context):
|
||||
self.layout.operator(ImportWav.bl_idname, text="WAV Audio Files (.wav)")
|
||||
def export_pt_menu_callback(self, _):
|
||||
layout = self.layout
|
||||
layout.separator()
|
||||
layout.operator(SendToProTools.bl_idname, text="Send to Pro Tools")
|
||||
|
||||
|
||||
def export_adm_menu_callback(self, context):
|
||||
self.layout.operator(ADMWaveExport.bl_idname, text="ADM Broadcast-WAVE (.wav)")
|
||||
|
||||
|
||||
def add_sound_to_mesh_menu_callback(self, context):
|
||||
self.layout.operator(AddSoundToMeshOperator.bl_idname, icon='SPEAKER')
|
||||
|
||||
|
||||
def register():
|
||||
bpy.utils.register_class(AddSoundToMeshOperator)
|
||||
bpy.utils.register_class(ADMWaveExport)
|
||||
bpy.utils.register_class(ImportWav)
|
||||
bpy.utils.register_class(SendToProTools)
|
||||
bpy.types.VIEW3D_MT_object.append(export_pt_menu_callback)
|
||||
|
||||
bpy.types.TOPBAR_MT_file_import.append(import_wav_menu_callback)
|
||||
bpy.types.TOPBAR_MT_file_export.append(export_adm_menu_callback)
|
||||
bpy.types.VIEW3D_MT_object.append(add_sound_to_mesh_menu_callback)
|
||||
|
||||
# bpy.utils.register_class(SoundObjectAttachmentPanel)
|
||||
|
||||
|
||||
def unregister():
|
||||
bpy.utils.unregister_class(AddSoundToMeshOperator)
|
||||
bpy.utils.unregister_class(ADMWaveExport)
|
||||
bpy.utils.unregister_class(ImportWav)
|
||||
bpy.utils.unregister_class(SendToProTools)
|
||||
bpy.types.VIEW3D_MT_object.remove(export_pt_menu_callback)
|
||||
|
||||
bpy.types.TOPBAR_MT_file_import.remove(import_wav_menu_callback)
|
||||
bpy.types.TOPBAR_MT_file_export.remove(export_adm_menu_callback)
|
||||
bpy.types.VIEW3D_MT_object.remove(add_sound_to_mesh_menu_callback)
|
||||
|
||||
# bpy.utils.unregister_class(SoundObjectAttachmentPanel)
|
||||
|
||||
42
blender_manifest.toml
Normal file
42
blender_manifest.toml
Normal file
@@ -0,0 +1,42 @@
|
||||
# https://docs.blender.org/manual/en/latest/advanced/extensions/getting_started.html
|
||||
schema_version = "1.0.0"
|
||||
|
||||
id = "soundobjects_blender_addon"
|
||||
version = "0.0.2"
|
||||
name = "Send Sounds to Pro Tools"
|
||||
tags = ["Animation", "Object"]
|
||||
tagline = "Render each speaker as a track in Pro Tools with panning"
|
||||
maintainer = "Jamie Hardt"
|
||||
type = "add-on"
|
||||
blender_version_min = "4.5.3"
|
||||
license = [
|
||||
"SPDX:GPL-3.0-or-later",
|
||||
]
|
||||
website = "https://git.squad51.us/jamie/soundobjects_blender_addon"
|
||||
platforms = ["macos-arm64", "windows-x64"]
|
||||
wheels = [
|
||||
'./wheels/grpcio-1.74.0-cp311-cp311-macosx_11_0_universal2.whl',
|
||||
'./wheels/grpcio-1.74.0-cp311-cp311-win_amd64.whl',
|
||||
'./wheels/iniconfig-2.3.0-py3-none-any.whl',
|
||||
'./wheels/packaging-25.0-py3-none-any.whl',
|
||||
'./wheels/pluggy-1.6.0-py3-none-any.whl',
|
||||
'./wheels/protobuf-6.31.1-cp39-abi3-macosx_10_9_universal2.whl',
|
||||
'./wheels/protobuf-6.31.1-cp310-abi3-win_amd64.whl',
|
||||
'./wheels/py_ptsl-600.1.0-py3-none-any.whl',
|
||||
'./wheels/pygments-2.19.2-py3-none-any.whl',
|
||||
'./wheels/pytest-8.4.2-py3-none-any.whl'
|
||||
]
|
||||
|
||||
[permissions]
|
||||
network = "Communicates with Pro Tools via RPC, only localhost"
|
||||
|
||||
|
||||
[build]
|
||||
paths_exclude_pattern = [
|
||||
"__pycache__/",
|
||||
"/.git/",
|
||||
"/*.zip",
|
||||
"/.venv/",
|
||||
".mypy_*",
|
||||
".DS_Store"
|
||||
]
|
||||
@@ -1,8 +1,10 @@
|
||||
import bpy
|
||||
from numpy.linalg import norm
|
||||
from numpy.typing import ArrayLike
|
||||
from random import uniform, gauss
|
||||
from math import floor
|
||||
from enum import Enum
|
||||
from typing import cast
|
||||
|
||||
from dataclasses import dataclass
|
||||
|
||||
@@ -34,10 +36,9 @@ def sound_camera_spatial_envelope(scene: bpy.types.Scene, speaker_obj,
|
||||
enters_range_frame = None
|
||||
exits_range_frame = None
|
||||
|
||||
assert scene.camera
|
||||
|
||||
in_range = False
|
||||
for frame in range(scene.frame_start, scene.frame_end + 1):
|
||||
assert scene.camera
|
||||
scene.frame_set(frame)
|
||||
rel = speaker_obj.matrix_world.to_translation() \
|
||||
- scene.camera.matrix_world.to_translation()
|
||||
@@ -66,14 +67,20 @@ def sound_camera_spatial_envelope(scene: bpy.types.Scene, speaker_obj,
|
||||
min_distance=min_dist)
|
||||
|
||||
|
||||
def closest_approach_to_camera(scene, speaker_object):
|
||||
def closest_approach_to_camera(scene: bpy.types.Scene,
|
||||
speaker_object: bpy.types.Object) -> tuple[float, int]:
|
||||
"""
|
||||
Steps through the scene frame-by-frame and returns a tuple of
|
||||
(minumum_distance, at_frame_index)
|
||||
"""
|
||||
max_dist = sys.float_info.max
|
||||
at_time = scene.frame_start
|
||||
for frame in range(scene.frame_start, scene.frame_end + 1):
|
||||
assert scene.camera
|
||||
scene.frame_set(frame)
|
||||
rel = speaker_object.matrix_world.to_translation(
|
||||
) - scene.camera.matrix_world.to_translation()
|
||||
dist = norm(rel)
|
||||
rel = speaker_object.matrix_world.to_translation() - \
|
||||
scene.camera.matrix_world.to_translation()
|
||||
dist = float(norm(cast(ArrayLike, rel)))
|
||||
|
||||
if dist < max_dist:
|
||||
max_dist = dist
|
||||
@@ -175,6 +182,4 @@ def add_speakers_to_meshes(meshes, context, sound=None,
|
||||
gaussian_stddev=gaussian_stddev,
|
||||
sound_bank=sound_bank, envelope=envelope)
|
||||
|
||||
apply_gain_envelope(speaker_obj, envelope)
|
||||
|
||||
speaker_obj.data.update_tag()
|
||||
|
||||
@@ -1,31 +1,14 @@
|
||||
import bpy
|
||||
|
||||
import lxml
|
||||
import uuid
|
||||
from fractions import Fraction
|
||||
import struct
|
||||
from os.path import dirname
|
||||
|
||||
import numpy
|
||||
|
||||
from time import strftime
|
||||
|
||||
from typing import List
|
||||
|
||||
from ear.fileio.utils import openBw64
|
||||
|
||||
from ear.fileio.bw64.chunks import (FormatInfoChunk, ChnaChunk)
|
||||
|
||||
from ear.fileio.adm import chna as adm_chna
|
||||
from ear.fileio.adm.xml import adm_to_xml
|
||||
from ear.fileio.adm.builder import (ADMBuilder)
|
||||
from ear.fileio.adm.generate_ids import generate_ids
|
||||
|
||||
from .geom_utils import (speaker_active_time_range,
|
||||
speakers_by_min_distance,
|
||||
speakers_by_start_time)
|
||||
|
||||
from .object_mix import (ObjectMix, ObjectMixPool, object_mixes_from_source_groups)
|
||||
from .object_mix import (ObjectMixPool, object_mixes_from_source_groups)
|
||||
|
||||
from .speaker_utils import (all_speakers)
|
||||
|
||||
@@ -56,7 +39,8 @@ def group_speakers(speakers, scene) -> List[List[bpy.types.Object]]:
|
||||
|
||||
ret_val = [[]]
|
||||
for spk in by_priority:
|
||||
success = False # flaggy-flag because I can't do a break->continue from the inner
|
||||
success = False # flaggy-flag because I can't do a break->continue
|
||||
# from the inner
|
||||
for elem in ret_val:
|
||||
if list_can_accept_speaker(elem, spk):
|
||||
elem.append(spk)
|
||||
@@ -71,112 +55,123 @@ def group_speakers(speakers, scene) -> List[List[bpy.types.Object]]:
|
||||
return ret_val
|
||||
|
||||
|
||||
def adm_for_object(scene: bpy.types.Scene, sound_object: ObjectMix, room_size, adm_builder, object_index):
|
||||
fps = scene.render.fps
|
||||
frame_start = scene.frame_start
|
||||
frame_end = scene.frame_end
|
||||
|
||||
block_formats = sound_object.adm_block_formats(room_size=room_size)
|
||||
|
||||
created = adm_builder.create_item_objects(track_index=object_index,
|
||||
name=sound_object.object_name,
|
||||
block_formats=block_formats)
|
||||
|
||||
created.audio_object.start = Fraction(frame_start, fps)
|
||||
created.audio_object.duration = Fraction(frame_end - frame_start, fps)
|
||||
created.track_uid.sampleRate = sound_object.sample_rate
|
||||
created.track_uid.bitDepth = sound_object.bits_per_sample
|
||||
# def adm_for_object(scene: bpy.types.Scene, sound_object: ObjectMix, room_size,
|
||||
# adm_builder, object_index):
|
||||
# fps = scene.render.fps
|
||||
# frame_start = scene.frame_start
|
||||
# frame_end = scene.frame_end
|
||||
#
|
||||
# # block_formats = sound_object.adm_block_formats(room_size=room_size)
|
||||
#
|
||||
# created = adm_builder.create_item_objects(track_index=object_index,
|
||||
# name=sound_object.object_name,
|
||||
# block_formats=block_formats)
|
||||
#
|
||||
# created.audio_object.start = Fraction(frame_start, fps)
|
||||
# created.audio_object.duration = Fraction(frame_end - frame_start, fps)
|
||||
# created.track_uid.sampleRate = sound_object.sample_rate
|
||||
# created.track_uid.bitDepth = sound_object.bits_per_sample
|
||||
|
||||
|
||||
def adm_for_scene(scene: bpy.types.Scene, sound_object_mixes: List[ObjectMix], room_size):
|
||||
adm_builder = ADMBuilder()
|
||||
# def adm_for_scene(scene: bpy.types.Scene, sound_object_mixes: List[ObjectMix],
|
||||
# room_size):
|
||||
# adm_builder = ADMBuilder()
|
||||
#
|
||||
# frame_start = scene.frame_start
|
||||
# frame_end = scene.frame_end
|
||||
# fps = scene.render.fps
|
||||
#
|
||||
# adm_builder.create_programme(audioProgrammeName=scene.name,
|
||||
# start=Fraction(frame_start, fps),
|
||||
# end=Fraction(frame_end, fps))
|
||||
#
|
||||
# adm_builder.create_content(audioContentName="Objects")
|
||||
#
|
||||
# for object_index, sound_object in enumerate(sound_object_mixes):
|
||||
# adm_for_object(scene, sound_object, room_size,
|
||||
# adm_builder, object_index)
|
||||
#
|
||||
# adm = adm_builder.adm
|
||||
#
|
||||
# generate_ids(adm)
|
||||
# chna = ChnaChunk()
|
||||
# adm_chna.populate_chna_chunk(chna, adm)
|
||||
#
|
||||
# return adm_to_xml(adm), chna
|
||||
#
|
||||
|
||||
frame_start = scene.frame_start
|
||||
frame_end = scene.frame_end
|
||||
fps = scene.render.fps
|
||||
|
||||
adm_builder.create_programme(audioProgrammeName=scene.name,
|
||||
start=Fraction(frame_start, fps),
|
||||
end=Fraction(frame_end, fps))
|
||||
|
||||
adm_builder.create_content(audioContentName="Objects")
|
||||
|
||||
for object_index, sound_object in enumerate(sound_object_mixes):
|
||||
adm_for_object(scene, sound_object, room_size, adm_builder, object_index)
|
||||
|
||||
adm = adm_builder.adm
|
||||
|
||||
generate_ids(adm)
|
||||
chna = ChnaChunk()
|
||||
adm_chna.populate_chna_chunk(chna, adm)
|
||||
|
||||
return adm_to_xml(adm), chna
|
||||
# def bext_data(scene, sample_rate, room_size):
|
||||
# description = "SCENE={};ROOM_SIZE={}\n".format(
|
||||
# scene.name, room_size).encode("ascii")
|
||||
# originator_name = "Blender {}".format(
|
||||
# bpy.app.version_string).encode("ascii")
|
||||
# originator_ref = uuid.uuid1().hex.encode("ascii")
|
||||
# date10 = strftime("%Y-%m-%d").encode("ascii")
|
||||
# time8 = strftime("%H:%M:%S").encode("ascii")
|
||||
# timeref = int(float(scene.frame_start) *
|
||||
# sample_rate / float(scene.render.fps))
|
||||
# version = 0
|
||||
# umid = b"\0" * 64
|
||||
# pad = b"\0" * 190
|
||||
#
|
||||
# data = struct.pack("<256s32s32s10s8sQH64s190s", description,
|
||||
# originator_name, originator_ref, date10, time8, timeref,
|
||||
# version, umid, pad)
|
||||
#
|
||||
# return data
|
||||
#
|
||||
#
|
||||
# def attach_outfile_metadata(out_format, outfile, room_size, scene,
|
||||
# sound_objects):
|
||||
# adm, chna = adm_for_scene(scene, sound_objects, room_size=room_size)
|
||||
# outfile.axml = lxml.etree.tostring(adm, pretty_print=True)
|
||||
# outfile.chna = chna
|
||||
# outfile.bext = bext_data(scene, out_format.sampleRate, room_size=room_size)
|
||||
#
|
||||
#
|
||||
# def write_outfile_audio_data(outfile, shortest_file, sound_objects):
|
||||
# READ_BLOCK = 1024
|
||||
# cursor = 0
|
||||
#
|
||||
# # Not sure if this is necessary but lets do it
|
||||
# for obj in sound_objects:
|
||||
# obj.mixdown_reader.seek(0)
|
||||
#
|
||||
# while True:
|
||||
# remainder = shortest_file - cursor
|
||||
# to_read = min(READ_BLOCK, remainder)
|
||||
# if to_read == 0:
|
||||
# break
|
||||
#
|
||||
# buffer = numpy.zeros((to_read, len(sound_objects)))
|
||||
# for i, sound_object in enumerate(sound_objects):
|
||||
# buffer[:, i] = sound_object.mixdown_reader.read(to_read)[:, 0]
|
||||
#
|
||||
# outfile.write(buffer)
|
||||
# cursor = cursor + to_read
|
||||
|
||||
|
||||
def bext_data(scene, sample_rate, room_size):
|
||||
description = "SCENE={};ROOM_SIZE={}\n".format(scene.name, room_size).encode("ascii")
|
||||
originator_name = "Blender {}".format(bpy.app.version_string).encode("ascii")
|
||||
originator_ref = uuid.uuid1().hex.encode("ascii")
|
||||
date10 = strftime("%Y-%m-%d").encode("ascii")
|
||||
time8 = strftime("%H:%M:%S").encode("ascii")
|
||||
timeref = int(float(scene.frame_start) * sample_rate / float(scene.render.fps))
|
||||
version = 0
|
||||
umid = b"\0" * 64
|
||||
pad = b"\0" * 190
|
||||
|
||||
data = struct.pack("<256s32s32s10s8sQH64s190s", description, originator_name,
|
||||
originator_ref, date10, time8, timeref, version, umid, pad)
|
||||
|
||||
return data
|
||||
|
||||
|
||||
def attach_outfile_metadata(out_format, outfile, room_size, scene, sound_objects):
|
||||
adm, chna = adm_for_scene(scene, sound_objects, room_size=room_size)
|
||||
outfile.axml = lxml.etree.tostring(adm, pretty_print=True)
|
||||
outfile.chna = chna
|
||||
outfile.bext = bext_data(scene, out_format.sampleRate, room_size=room_size)
|
||||
|
||||
|
||||
def write_outfile_audio_data(outfile, shortest_file, sound_objects):
|
||||
READ_BLOCK = 1024
|
||||
cursor = 0
|
||||
|
||||
# Not sure if this is necessary but lets do it
|
||||
for obj in sound_objects:
|
||||
obj.mixdown_reader.seek(0)
|
||||
|
||||
while True:
|
||||
remainder = shortest_file - cursor
|
||||
to_read = min(READ_BLOCK, remainder)
|
||||
if to_read == 0:
|
||||
break
|
||||
|
||||
buffer = numpy.zeros((to_read, len(sound_objects)))
|
||||
for i, sound_object in enumerate(sound_objects):
|
||||
buffer[:, i] = sound_object.mixdown_reader.read(to_read)[:, 0]
|
||||
|
||||
outfile.write(buffer)
|
||||
cursor = cursor + to_read
|
||||
|
||||
|
||||
def write_muxed_wav(mix_pool: ObjectMixPool, scene, out_format, room_size, outfile, shortest_file):
|
||||
sound_objects = mix_pool.object_mixes
|
||||
attach_outfile_metadata(out_format, outfile, room_size, scene, sound_objects)
|
||||
write_outfile_audio_data(outfile, shortest_file, sound_objects)
|
||||
|
||||
|
||||
def mux_adm_from_object_mix_pool(scene, mix_pool: ObjectMixPool, output_filename, room_size=1.):
|
||||
object_count = len(mix_pool.object_mixes)
|
||||
assert object_count > 0
|
||||
|
||||
out_format = FormatInfoChunk(channelCount=object_count,
|
||||
sampleRate=scene.render.ffmpeg.audio_mixrate,
|
||||
bitsPerSample=24)
|
||||
|
||||
with openBw64(output_filename, 'w', formatInfo=out_format) as outfile:
|
||||
write_muxed_wav(mix_pool, scene, out_format, room_size,
|
||||
outfile, mix_pool.shortest_file_length)
|
||||
|
||||
# def write_muxed_wav(mix_pool: ObjectMixPool, scene, out_format, room_size,
|
||||
# outfile, shortest_file):
|
||||
# sound_objects = mix_pool.object_mixes
|
||||
# attach_outfile_metadata(out_format, outfile,
|
||||
# room_size, scene, sound_objects)
|
||||
# write_outfile_audio_data(outfile, shortest_file, sound_objects)
|
||||
#
|
||||
#
|
||||
# def mux_adm_from_object_mix_pool(scene, mix_pool: ObjectMixPool,
|
||||
# output_filename, room_size=1.):
|
||||
# object_count = len(mix_pool.object_mixes)
|
||||
# assert object_count > 0
|
||||
#
|
||||
# out_format = FormatInfoChunk(channelCount=object_count,
|
||||
# sampleRate=scene.render.ffmpeg.audio_mixrate,
|
||||
# bitsPerSample=24)
|
||||
#
|
||||
# with openBw64(output_filename, 'w', formatInfo=out_format) as outfile:
|
||||
# write_muxed_wav(mix_pool, scene, out_format, room_size,
|
||||
# outfile, mix_pool.shortest_file_length)
|
||||
#
|
||||
|
||||
def print_partition_results(object_groups, sound_sources, too_far_speakers):
|
||||
print("Will create {} objects for {} sources, ignoring {} sources".format(
|
||||
@@ -188,7 +183,7 @@ def print_partition_results(object_groups, sound_sources, too_far_speakers):
|
||||
|
||||
|
||||
def partition_sounds_to_objects(scene, max_objects) -> \
|
||||
tuple[list[list[bpy.types.Speaker]], list[bpy.types.Speaker]]:
|
||||
tuple[list[list[bpy.types.Object]], list[list[bpy.types.Object]]]:
|
||||
"""
|
||||
Allocates sounds in the scene into non-overlapping lists of sounds. The
|
||||
second return value is the list of sounds that could not be allocated
|
||||
@@ -213,8 +208,9 @@ def partition_sounds_to_objects(scene, max_objects) -> \
|
||||
return object_groups, too_far_speakers
|
||||
|
||||
|
||||
def generate_adm(context: bpy.types.Context, filepath: str, room_size: float,
|
||||
max_objects: int) -> dict:
|
||||
def generate_adm(context: bpy.types.Context, filepath: str,
|
||||
room_size: float,
|
||||
max_objects: int) -> set[str]:
|
||||
scene = context.scene
|
||||
|
||||
object_groups, _ = partition_sounds_to_objects(scene, max_objects)
|
||||
@@ -227,10 +223,8 @@ def generate_adm(context: bpy.types.Context, filepath: str, room_size: float,
|
||||
base_dir=dirname(filepath))
|
||||
|
||||
with ObjectMixPool(object_mixes=mix_groups) as pool:
|
||||
mux_adm_from_object_mix_pool(scene, mix_pool=pool,
|
||||
output_filename=filepath,
|
||||
room_size=room_size)
|
||||
print("Finished muxing ADM")
|
||||
# here is where we place the mix objects into the session
|
||||
pass
|
||||
|
||||
print("generate_adm exiting")
|
||||
# print("generate_adm exiting")
|
||||
return {'FINISHED'}
|
||||
|
||||
@@ -8,17 +8,19 @@ from numpy.linalg import norm
|
||||
|
||||
from mathutils import Vector, Quaternion
|
||||
|
||||
|
||||
class FrameInterval:
|
||||
def __init__(self, start_frame, end_frame):
|
||||
self.start_frame = int(start_frame)
|
||||
self.end_frame = int(end_frame)
|
||||
|
||||
def overlaps(self, other : 'FrameInterval') -> bool:
|
||||
def overlaps(self, other: 'FrameInterval') -> bool:
|
||||
return self.start_frame <= other.start_frame <= self.end_frame or \
|
||||
other.start_frame <= self.start_frame <= other.end_frame
|
||||
|
||||
|
||||
def compute_relative_vector(camera: bpy.types.Camera, target: bpy.types.Object):
|
||||
def compute_relative_vector(camera: bpy.types.Object,
|
||||
target: bpy.types.Object):
|
||||
"""
|
||||
Return a vector from `camera` to `target` in the camera's coordinate space.
|
||||
|
||||
@@ -33,7 +35,7 @@ def compute_relative_vector(camera: bpy.types.Camera, target: bpy.types.Object):
|
||||
|
||||
# The camera's worldvector is norm to the horizon, we want a vector
|
||||
# down the barrel.
|
||||
camera_correction = Quaternion( ( sqrt(2.) / 2. , sqrt(2.) / 2. , 0. , 0.) )
|
||||
camera_correction = Quaternion((sqrt(2.) / 2., sqrt(2.) / 2., 0., 0.))
|
||||
relative_vector.rotate(camera_correction)
|
||||
|
||||
return relative_vector
|
||||
@@ -43,22 +45,24 @@ def room_norm_vector(vec, room_size=1.) -> Vector:
|
||||
"""
|
||||
The Room is tearing me apart, Lisa.
|
||||
|
||||
The room is a cube with the camera at its center. We use a chebyshev normalization
|
||||
to convert a vector in world or camera space into a vector the represents the projection
|
||||
of that vector onto the room's walls. The Room Vector is the immediate the X, Y and Z
|
||||
coordinate of the corresponding ADM Block Format source object position.
|
||||
The room is a cube with the camera at its center. We use a chebyshev
|
||||
normalization to convert a vector in world or camera space into a vector
|
||||
the represents the projection of that vector onto the room's walls. The
|
||||
Room Vector is the immediate the X, Y and Z coordinate of the corresponding
|
||||
ADM Block Format source object position.
|
||||
|
||||
The Pro Tools/Dolby Atmos workflow I am targeting uses "Room Centric" panner coordinates
|
||||
("cartesian allocentric coordinates" in ADM speak) and this process seems to yield good
|
||||
results.
|
||||
|
||||
I also experimented with using normalized camera frame coordinates from the
|
||||
bpy_extras.object_utils.world_to_camera_view method and this gives very good results as
|
||||
long as the object is on-screen; coordinates for objects off the screen are unusable.
|
||||
|
||||
In the future it would be worth exploring wether there's a way to produce ADM
|
||||
coordinates that are "Screen-accurate" while the object is on-screen, but still gives
|
||||
sensible results when the object is off-screen as well.
|
||||
The Pro Tools/Dolby Atmos workflow I am targeting uses "Room Centric"
|
||||
panner coordinates ("cartesian allocentric coordinates" in ADM speak) and
|
||||
this process seems to yield good results.
|
||||
|
||||
I also experimented with using normalized camera frame coordinates from the
|
||||
bpy_extras.object_utils.world_to_camera_view method and this gives very
|
||||
good results as long as the object is on-screen; coordinates for objects
|
||||
off the screen are unusable.
|
||||
|
||||
In the future it would be worth exploring wether there's a way to produce
|
||||
ADM coordinates that are "Screen-accurate" while the object is on-screen,
|
||||
but still gives sensible results when the object is off-screen as well.
|
||||
"""
|
||||
chebyshev = norm(vec, ord=numpy.inf)
|
||||
if chebyshev < room_size:
|
||||
@@ -67,19 +71,20 @@ def room_norm_vector(vec, room_size=1.) -> Vector:
|
||||
return vec / chebyshev
|
||||
|
||||
|
||||
def closest_approach_to_camera(scene, speaker_object) -> (float, int):
|
||||
def closest_approach_to_camera(scene, speaker_object) -> tuple[float, int]:
|
||||
"""
|
||||
The distance and frame number of `speaker_object`s closest point to
|
||||
the scene's camera.
|
||||
|
||||
The distance and frame number of `speaker_object`s closest point to the
|
||||
scene's camera.
|
||||
|
||||
(Works for any object, not just speakers.)
|
||||
"""
|
||||
max_dist = sys.float_info.max
|
||||
at_time = scene.frame_start
|
||||
for frame in range(scene.frame_start, scene.frame_end + 1):
|
||||
scene.frame_set(frame)
|
||||
rel = speaker_object.matrix_world.to_translation() - scene.camera.matrix_world.to_translation()
|
||||
dist = norm(rel)
|
||||
rel = speaker_object.matrix_world.to_translation() - \
|
||||
scene.camera.matrix_world.to_translation()
|
||||
dist = float(norm(rel))
|
||||
|
||||
if dist < max_dist:
|
||||
max_dist = dist
|
||||
@@ -116,4 +121,5 @@ def speakers_by_min_distance(scene, speakers):
|
||||
|
||||
|
||||
def speakers_by_start_time(speaker_objs):
|
||||
return sorted(speaker_objs, key=(lambda spk: speaker_active_time_range(spk).start_frame))
|
||||
return sorted(speaker_objs,
|
||||
key=(lambda spk: speaker_active_time_range(spk).start_frame))
|
||||
|
||||
@@ -1,18 +1,15 @@
|
||||
import os
|
||||
import bpy
|
||||
from contextlib import contextmanager
|
||||
from fractions import Fraction
|
||||
from typing import List
|
||||
|
||||
from ear.fileio.adm.elements import ObjectCartesianPosition, JumpPosition, AudioBlockFormatObjects
|
||||
from ear.fileio.bw64 import Bw64Reader
|
||||
import wave
|
||||
|
||||
from .geom_utils import speaker_active_time_range, compute_relative_vector, room_norm_vector
|
||||
from .speaker_utils import solo_speakers, unmute_all_speakers
|
||||
|
||||
|
||||
@contextmanager
|
||||
def adm_object_rendering_context(scene: bpy.types.Scene):
|
||||
def object_rendering_context(scene: bpy.types.Scene):
|
||||
old_ff = scene.render.image_settings.file_format
|
||||
old_codec = scene.render.ffmpeg.audio_codec
|
||||
old_chans = scene.render.ffmpeg.audio_channels
|
||||
@@ -31,14 +28,12 @@ def adm_object_rendering_context(scene: bpy.types.Scene):
|
||||
|
||||
|
||||
class ObjectMix:
|
||||
def __init__(self, sources: List[bpy.types.Speaker],
|
||||
def __init__(self, sources: List[bpy.types.Object],
|
||||
scene: bpy.types.Scene, base_dir: str):
|
||||
self.sources = sources
|
||||
self.intermediate_filename = None
|
||||
self.base_dir = base_dir
|
||||
self.scene = scene
|
||||
self._mixdown_file_handle = None
|
||||
self._mixdown_reader = None
|
||||
|
||||
@property
|
||||
def frame_start(self):
|
||||
@@ -48,33 +43,27 @@ class ObjectMix:
|
||||
def frame_end(self):
|
||||
return self.scene.frame_end
|
||||
|
||||
@property
|
||||
def sample_rate(self):
|
||||
return self.mixdown_reader.sampleRate
|
||||
@property
|
||||
def sample_rate(self) -> int:
|
||||
with wave.open(self.mixdown_filename, "rb") as f:
|
||||
return f.getframerate()
|
||||
|
||||
@property
|
||||
def bits_per_sample(self):
|
||||
return self.mixdown_reader.bitdepth
|
||||
def bits_per_sample(self) -> int:
|
||||
with wave.open(self.mixdown_filename, "rb") as f:
|
||||
return f.getsampwidth() * 8
|
||||
|
||||
@property
|
||||
def frames_length(self) -> int:
|
||||
with wave.open(self.mixdown_filename, "rb") as f:
|
||||
return f.getnframes()
|
||||
|
||||
@property
|
||||
def mixdown_reader(self) -> Bw64Reader:
|
||||
if self._mixdown_reader is None:
|
||||
self._mixdown_reader = Bw64Reader(self.mixdown_file_handle)
|
||||
|
||||
return self._mixdown_reader
|
||||
|
||||
@property
|
||||
def mixdown_file_handle(self):
|
||||
if self._mixdown_file_handle is None:
|
||||
self._mixdown_file_handle = open(self.mixdown_filename, 'rb')
|
||||
|
||||
return self._mixdown_file_handle
|
||||
|
||||
@property
|
||||
def mixdown_filename(self):
|
||||
def mixdown_filename(self) -> str:
|
||||
if self.intermediate_filename is None:
|
||||
self.mixdown()
|
||||
|
||||
|
||||
assert self.intermediate_filename
|
||||
return self.intermediate_filename
|
||||
|
||||
@property
|
||||
@@ -82,49 +71,23 @@ class ObjectMix:
|
||||
return self.sources[0].name
|
||||
|
||||
def mixdown(self):
|
||||
with adm_object_rendering_context(self.scene) as scene:
|
||||
with object_rendering_context(self.scene) as scene:
|
||||
solo_speakers(scene, self.sources)
|
||||
|
||||
scene_name = bpy.path.clean_name(scene.name)
|
||||
speaker_name = bpy.path.clean_name(self.object_name)
|
||||
|
||||
self.intermediate_filename = os.path.join(self.base_dir, "%s_%s.wav" % (scene_name, speaker_name))
|
||||
self.intermediate_filename = os.path.join(
|
||||
self.base_dir, "%s_%s.wav" % (scene_name, speaker_name))
|
||||
|
||||
bpy.ops.sound.mixdown(filepath=self.intermediate_filename,
|
||||
container='WAV', codec='PCM', format='S24')
|
||||
container='WAV', codec='PCM', format='F32')
|
||||
|
||||
print("Created mixdown named {}".format(self.intermediate_filename))
|
||||
print("Created mixdown named {}"
|
||||
.format(self.intermediate_filename))
|
||||
|
||||
unmute_all_speakers(scene)
|
||||
|
||||
def adm_block_formats(self, room_size=1.):
|
||||
fps = self.scene.render.fps
|
||||
block_formats = []
|
||||
|
||||
for speaker_obj in self.sources:
|
||||
speaker_interval = speaker_active_time_range(speaker_obj)
|
||||
for frame in range(speaker_interval.start_frame, speaker_interval.end_frame + 1):
|
||||
self.scene.frame_set(frame)
|
||||
relative_vector = compute_relative_vector(camera=self.scene.camera, target=speaker_obj)
|
||||
|
||||
norm_vec = room_norm_vector(relative_vector, room_size=room_size)
|
||||
|
||||
pos = ObjectCartesianPosition(X=norm_vec.x, Y=norm_vec.y, Z=norm_vec.z)
|
||||
|
||||
if len(block_formats) == 0 or pos != block_formats[-1].position:
|
||||
jp = JumpPosition(flag=True, interpolationLength=Fraction(1, fps * 2))
|
||||
block = AudioBlockFormatObjects(position=pos,
|
||||
rtime=Fraction(frame, fps),
|
||||
duration=Fraction(1, fps),
|
||||
cartesian=True,
|
||||
jumpPosition=jp)
|
||||
|
||||
block_formats.append(block)
|
||||
else:
|
||||
block_formats[-1].duration = block_formats[-1].duration + Fraction(1, fps)
|
||||
|
||||
return block_formats
|
||||
|
||||
def rm_mixdown(self):
|
||||
if self._mixdown_reader is not None:
|
||||
self._mixdown_reader = None
|
||||
@@ -146,17 +109,20 @@ class ObjectMixPool:
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||
def __exit__(self, _exc_type, _exc_val, _exc_tb):
|
||||
for mix in self.object_mixes:
|
||||
mix.rm_mixdown()
|
||||
|
||||
@property
|
||||
def shortest_file_length(self):
|
||||
lengths = map(lambda f: len(f.mixdown_reader), self.object_mixes)
|
||||
lengths = map(lambda f: f.frames_length, self.object_mixes)
|
||||
return min(lengths)
|
||||
|
||||
|
||||
def object_mixes_from_source_groups(groups: List[List[bpy.types.Speaker]], scene, base_dir):
|
||||
def object_mixes_from_source_groups(
|
||||
groups: List[List[bpy.types.Object]],
|
||||
scene: bpy.types.Scene, base_dir: str) -> list[ObjectMix]:
|
||||
|
||||
mixes = []
|
||||
for group in groups:
|
||||
mixes.append(ObjectMix(sources=group, scene=scene, base_dir=base_dir))
|
||||
|
||||
131
intern/pro_tools.py
Normal file
131
intern/pro_tools.py
Normal file
@@ -0,0 +1,131 @@
|
||||
import pprint
|
||||
|
||||
import bpy
|
||||
import ptsl
|
||||
from ptsl import PTSL_pb2 as pt
|
||||
|
||||
|
||||
from .geom_utils import compute_relative_vector, room_norm_vector, speaker_active_time_range
|
||||
|
||||
|
||||
def mixdown_speaker(speaker: bpy.types.Object, scene: bpy.types.Scene) -> str:
|
||||
return ""
|
||||
|
||||
|
||||
def create_clip(audio_file_path: str, client: ptsl.Client) -> str:
|
||||
return ""
|
||||
|
||||
|
||||
def spot_clip(speaker: bpy.types.Object, clip_id: str, track_id: str,
|
||||
client: ptsl.Client):
|
||||
pass
|
||||
|
||||
def create_track(speaker: bpy.types.Object, client: ptsl.Client):
|
||||
assert speaker.data
|
||||
|
||||
result = client.run_command(pt.CId_CreateNewTracks,
|
||||
{'numuer_of_tracks': 1,
|
||||
'track_name': speaker.data.name,
|
||||
'track_format': "TFormat_Mono",
|
||||
'track_type': "TType_Audio",
|
||||
'track_timebase': "TTimebase_Samples",
|
||||
'pagination_request': {
|
||||
'limit': 1,
|
||||
'offset': 0,
|
||||
},
|
||||
'insertion_point_position': "TIPoint_Unknown",
|
||||
'insertion_point_track_name': ""
|
||||
})
|
||||
|
||||
print(result)
|
||||
assert result
|
||||
assert 'created_track_ids' in result.keys()
|
||||
assert len(result['created_track_ids']) == 1
|
||||
|
||||
return result['created_track_ids'][0]
|
||||
|
||||
|
||||
def insert_audio(speaker: bpy.types.Object, scene: bpy.types.Scene,
|
||||
track_id: str, client: ptsl.Client):
|
||||
|
||||
rendered_audio_file = mixdown_speaker(speaker, scene)
|
||||
clip_id = create_clip(rendered_audio_file, client)
|
||||
spot_clip(speaker, clip_id, track_id, client)
|
||||
|
||||
|
||||
|
||||
def apply_pan_automation(speaker: bpy.types.Object, scene: bpy.types.Scene,
|
||||
track_id: str, room_size: float, client: ptsl.Client):
|
||||
|
||||
CId_SetTrackControlBreakpoints = 150
|
||||
# fps = scene.render.fps
|
||||
speaker_interval = speaker_active_time_range(speaker)
|
||||
assert scene.camera, "Scene does not have a camera"
|
||||
|
||||
values: list[tuple[dict, dict, dict]] = []
|
||||
|
||||
for frame in range(speaker_interval.start_frame,
|
||||
speaker_interval.end_frame + 1):
|
||||
scene.frame_set(frame)
|
||||
relative_vector = compute_relative_vector(camera=scene.camera,
|
||||
target=speaker)
|
||||
norm_vec = room_norm_vector(relative_vector,
|
||||
room_size=room_size)
|
||||
|
||||
time_struct = {'location': str(frame), 'time_type': 'TLType_Frames'}
|
||||
|
||||
x_pos = {'time': time_struct, 'value': round(norm_vec.x, 4)}
|
||||
y_pos = {'time': time_struct, 'value': round(norm_vec.y, 4)}
|
||||
z_pos = {'time': time_struct, 'value': round(norm_vec.z, 4)}
|
||||
|
||||
values.append((x_pos, y_pos, z_pos))
|
||||
|
||||
for i, control in enumerate(['PCParameter_X', 'PCParameter_Y',
|
||||
'PCParameter_Z']):
|
||||
|
||||
params ={
|
||||
'track_id': track_id,
|
||||
'control_id': {
|
||||
'section': 'TSId_MainOut',
|
||||
'control_type': 'TCType_Pan',
|
||||
'pan': {
|
||||
'pan_space': 'PSpace_3dCart3layer',
|
||||
'parameter': control,
|
||||
'channel': 'SChannel_Mono'
|
||||
},
|
||||
},
|
||||
'breakpoints': [v[i] for v in values]
|
||||
|
||||
}
|
||||
|
||||
print("Sending parameter changes:")
|
||||
pprint.pprint(params)
|
||||
|
||||
client.run_command(CId_SetTrackControlBreakpoints, params)
|
||||
|
||||
|
||||
|
||||
def send_to_pro_tools(speakers: list[bpy.types.Object],
|
||||
room_size: float) -> bool:
|
||||
try:
|
||||
print("About to create client.")
|
||||
client = ptsl.Client(company_name="Squad 51",
|
||||
application_name="Send to Pro Tools Blender Extension")
|
||||
|
||||
scene = bpy.context.scene
|
||||
|
||||
for speaker in speakers:
|
||||
new_track_id = create_track(speaker, client)
|
||||
insert_audio(speaker, scene, new_track_id, client)
|
||||
apply_pan_automation(speaker, scene, new_track_id, room_size,
|
||||
client)
|
||||
|
||||
client.close()
|
||||
return True
|
||||
|
||||
except ptsl.CommandError as e:
|
||||
print("Command Error: {}".format(e))
|
||||
return False
|
||||
|
||||
except AssertionError as e:
|
||||
raise e
|
||||
@@ -1,48 +0,0 @@
|
||||
import bpy
|
||||
|
||||
import numpy
|
||||
|
||||
from typing import List
|
||||
from random import choice
|
||||
from aud import Sound
|
||||
|
||||
class SoundBank:
|
||||
def __init__(self, prefix):
|
||||
self.prefix = prefix
|
||||
self.cached_info = {}
|
||||
|
||||
def sounds(self) -> List[Sound]:
|
||||
return [sound for sound in bpy.data.sounds if sound.name.startswith(self.prefix)]
|
||||
|
||||
def random_sound(self) -> Sound:
|
||||
if len(self.sounds()) == 0:
|
||||
return None
|
||||
else:
|
||||
return choice(self.sounds())
|
||||
|
||||
def get_audiofile_info(self, sound, fps) -> (int, int):
|
||||
"""
|
||||
Returns frame of max_peak and duration in frames
|
||||
"""
|
||||
|
||||
if sound.filepath in self.cached_info.keys():
|
||||
return self.cached_info[sound.filepath]
|
||||
else:
|
||||
if sound.filepath.startswith("//"):
|
||||
path = bpy.path.abspath(sound.filepath)
|
||||
else:
|
||||
path = sound.filepath
|
||||
|
||||
aud_sound = Sound(path)
|
||||
samples = aud_sound.data()
|
||||
sample_rate = aud_sound.specs[0]
|
||||
index = numpy.where(samples == numpy.amax(samples))[0][0]
|
||||
max_peak_frame = (index * fps / sample_rate)
|
||||
|
||||
sample_count = aud_sound.length
|
||||
frame_length = sample_count * fps / sample_rate
|
||||
|
||||
retvalue = (max_peak_frame , frame_length)
|
||||
self.cached_info[sound.filepath] = retvalue
|
||||
|
||||
return retvalue
|
||||
@@ -4,8 +4,13 @@ def all_speakers(scene: bpy.types.Scene) -> list[bpy.types.Object]:
|
||||
return [obj for obj in scene.objects if obj.type == 'SPEAKER']
|
||||
|
||||
|
||||
def solo_speakers(scene, solo_group):
|
||||
def solo_speakers(scene: bpy.types.Scene, solo_group: list[bpy.types.Object]):
|
||||
"""
|
||||
Mutes all Objects not in `solo_group` and ensures all objects in this group
|
||||
are not muted.
|
||||
"""
|
||||
for speaker in all_speakers(scene):
|
||||
assert type(speaker.data) is bpy.types.Speaker
|
||||
if speaker in solo_group:
|
||||
speaker.data.muted = False
|
||||
else:
|
||||
@@ -15,6 +20,10 @@ def solo_speakers(scene, solo_group):
|
||||
|
||||
|
||||
def unmute_all_speakers(scene):
|
||||
"""
|
||||
Unmutes all speakers.
|
||||
"""
|
||||
for speaker in all_speakers(scene):
|
||||
assert type(speaker.data) is bpy.types.Speaker
|
||||
speaker.data.muted = False
|
||||
speaker.data.update_tag()
|
||||
|
||||
@@ -1,72 +0,0 @@
|
||||
import bpy
|
||||
|
||||
from bpy.types import Operator
|
||||
from bpy.props import BoolProperty, StringProperty, EnumProperty, FloatProperty
|
||||
|
||||
from .intern.add_sound_to_meshes import add_speakers_to_meshes, TriggerMode
|
||||
|
||||
class AddSoundToMeshOperator(Operator):
|
||||
"""Add a speaker to each selected object"""
|
||||
bl_idname = "object.add_speakers_to_obj"
|
||||
bl_label = "Add Sounds to Meshes"
|
||||
|
||||
TRIGGER_OPTIONS = (
|
||||
(TriggerMode.START_FRAME,
|
||||
"Start Frame",
|
||||
"Sound will play on the first frame of the animation"),
|
||||
(TriggerMode.MIN_DISTANCE,
|
||||
"Minimum Distance",
|
||||
"Sound will play when the object is closest to the camera"),
|
||||
(TriggerMode.RANDOM,
|
||||
"Random",
|
||||
"Sound will play exactly once, at a random time"),
|
||||
(TriggerMode.RANDOM_GAUSSIAN,
|
||||
"Random (Gaussian)",
|
||||
"Sound will play exactly once, at a guassian random time with " +
|
||||
"stdev of 1 and mean in the middle of the animation")
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def poll(cls, context):
|
||||
sounds_avail = bpy.data.sounds
|
||||
return len(context.selected_objects) > 0 and len(sounds_avail) > 0
|
||||
|
||||
use_sounds: StringProperty(
|
||||
name="Sound Prefix",
|
||||
description="Sounds having names starting with thie field will be assigned randomly to each speaker"
|
||||
)
|
||||
|
||||
sync_audio_peak: BoolProperty(
|
||||
name="Sync Audio Peak",
|
||||
default=True,
|
||||
description="Synchronize speaker audio to loudest peak instead of beginning of file"
|
||||
)
|
||||
|
||||
trigger_mode: EnumProperty(
|
||||
items=TRIGGER_OPTIONS,
|
||||
name="Trigger",
|
||||
description="Select when each sound will play",
|
||||
default=TriggerMode.MIN_DISTANCE,
|
||||
|
||||
)
|
||||
|
||||
gaussian_stddev: FloatProperty(
|
||||
name="Gaussian StDev",
|
||||
description="Standard Deviation of Gaussian random time",
|
||||
default=1.,
|
||||
min=0.001,
|
||||
max=6.,
|
||||
)
|
||||
|
||||
def invoke(self, context, event):
|
||||
return context.window_manager.invoke_props_dialog(self)
|
||||
|
||||
def execute(self, context):
|
||||
|
||||
add_speakers_to_meshes(bpy.context.selected_objects, bpy.context,
|
||||
sound=None,
|
||||
sound_name_prefix=self.use_sounds,
|
||||
trigger_mode=self.trigger_mode,
|
||||
sync_peak=self.sync_audio_peak,
|
||||
gaussian_stddev=self.gaussian_stddev)
|
||||
return {'FINISHED'}
|
||||
@@ -1,47 +0,0 @@
|
||||
from bpy_extras.io_utils import ExportHelper
|
||||
from bpy.props import StringProperty, BoolProperty, EnumProperty, FloatProperty, IntProperty
|
||||
from bpy.types import Operator
|
||||
|
||||
from .intern.generate_adm import generate_adm
|
||||
|
||||
class ADMWaveExport(Operator, ExportHelper):
|
||||
"""Export a Broadcast-WAV audio file with each speaker encoded as an ADM object"""
|
||||
bl_idname = "export.adm_wave_file" # important since its how bpy.ops.import_test.some_data is constructed
|
||||
bl_label = "Export ADM Wave File"
|
||||
|
||||
# ExportHelper mixin class uses this
|
||||
filename_ext = ".wav"
|
||||
|
||||
filter_glob: StringProperty(
|
||||
default="*.wav",
|
||||
options={'HIDDEN'},
|
||||
maxlen=255, # Max internal buffer length, longer would be clamped.
|
||||
)
|
||||
|
||||
room_size: FloatProperty(
|
||||
default=1.0,
|
||||
name="Room Size",
|
||||
description="Distance from the lens to the front room boundary",
|
||||
min=0.001,
|
||||
step=1.,
|
||||
unit='LENGTH'
|
||||
)
|
||||
|
||||
max_objects: IntProperty(
|
||||
name="Max Objects",
|
||||
description="Maximum number of object tracks to create",
|
||||
default=24,
|
||||
min=0,
|
||||
max=118
|
||||
)
|
||||
|
||||
create_bed: BoolProperty(
|
||||
name="Create 7.1 Bed",
|
||||
description="Create a bed for all sounds not included on object tracks",
|
||||
default=False,
|
||||
options={'HIDDEN'}
|
||||
)
|
||||
|
||||
def execute(self, context):
|
||||
return generate_adm(context, self.filepath, self.room_size, self.max_objects)
|
||||
|
||||
@@ -1,86 +0,0 @@
|
||||
## This is copied from
|
||||
## https://blender.stackexchange.com/questions/4956/convert-particle-system-to-animated-meshes?answertab=active#tab-top
|
||||
#
|
||||
# And needs to be adapted
|
||||
|
||||
import bpy
|
||||
|
||||
# Set these to False if you don't want to key that property.
|
||||
KEYFRAME_LOCATION = True
|
||||
KEYFRAME_ROTATION = True
|
||||
KEYFRAME_SCALE = True
|
||||
KEYFRAME_VISIBILITY = True # Viewport and render visibility.
|
||||
|
||||
def create_objects_for_particles(ps, obj):
|
||||
# Duplicate the given object for every particle and return the duplicates.
|
||||
# Use instances instead of full copies.
|
||||
obj_list = []
|
||||
mesh = obj.data
|
||||
particles_coll = bpy.data.collections.new(name="particles")
|
||||
bpy.context.scene.collection.children.link(particles_coll)
|
||||
|
||||
for i, _ in enumerate(ps.particles):
|
||||
dupli = bpy.data.objects.new(
|
||||
name="particle.{:03d}".format(i),
|
||||
object_data=mesh)
|
||||
particles_coll.objects.link(dupli)
|
||||
obj_list.append(dupli)
|
||||
return obj_list
|
||||
|
||||
def match_and_keyframe_objects(ps, obj_list, start_frame, end_frame):
|
||||
# Match and keyframe the objects to the particles for every frame in the
|
||||
# given range.
|
||||
for frame in range(start_frame, end_frame + 1):
|
||||
print("frame {} processed".format(frame))
|
||||
bpy.context.scene.frame_set(frame)
|
||||
for p, obj in zip(ps.particles, obj_list):
|
||||
match_object_to_particle(p, obj)
|
||||
keyframe_obj(obj)
|
||||
|
||||
def match_object_to_particle(p, obj):
|
||||
# Match the location, rotation, scale and visibility of the object to
|
||||
# the particle.
|
||||
loc = p.location
|
||||
rot = p.rotation
|
||||
size = p.size
|
||||
if p.alive_state == 'ALIVE':
|
||||
vis = True
|
||||
else:
|
||||
vis = False
|
||||
obj.location = loc
|
||||
# Set rotation mode to quaternion to match particle rotation.
|
||||
obj.rotation_mode = 'QUATERNION'
|
||||
obj.rotation_quaternion = rot
|
||||
obj.scale = (size, size, size)
|
||||
obj.hide_viewport = not(vis) # <<<-- this was called "hide" in <= 2.79
|
||||
obj.hide_render = not(vis)
|
||||
|
||||
def keyframe_obj(obj):
|
||||
# Keyframe location, rotation, scale and visibility if specified.
|
||||
if KEYFRAME_LOCATION:
|
||||
obj.keyframe_insert("location")
|
||||
if KEYFRAME_ROTATION:
|
||||
obj.keyframe_insert("rotation_quaternion")
|
||||
if KEYFRAME_SCALE:
|
||||
obj.keyframe_insert("scale")
|
||||
if KEYFRAME_VISIBILITY:
|
||||
obj.keyframe_insert("hide_viewport") # <<<-- this was called "hide" in <= 2.79
|
||||
obj.keyframe_insert("hide_render")
|
||||
|
||||
def main():
|
||||
#in 2.8 you need to evaluate the Dependency graph in order to get data from animation, modifiers, etc
|
||||
depsgraph = bpy.context.evaluated_depsgraph_get()
|
||||
|
||||
# Assume only 2 objects are selected.
|
||||
# The active object should be the one with the particle system.
|
||||
ps_obj = bpy.context.object
|
||||
ps_obj_evaluated = depsgraph.objects[ ps_obj.name ]
|
||||
obj = [obj for obj in bpy.context.selected_objects if obj != ps_obj][0]
|
||||
ps = ps_obj_evaluated.particle_systems[0] # Assume only 1 particle system is present.
|
||||
start_frame = bpy.context.scene.frame_start
|
||||
end_frame = bpy.context.scene.frame_end
|
||||
obj_list = create_objects_for_particles(ps, obj)
|
||||
match_and_keyframe_objects(ps, obj_list, start_frame, end_frame)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
42
operator_protools_export.py
Normal file
42
operator_protools_export.py
Normal file
@@ -0,0 +1,42 @@
|
||||
import bpy
|
||||
|
||||
from .intern import pro_tools
|
||||
|
||||
def filter_speakers(objs: list[bpy.types.Object]) -> list[bpy.types.Object]:
|
||||
return [s for s in objs if s.type == 'SPEAKER']
|
||||
|
||||
class SendToProTools(bpy.types.Operator):
|
||||
"Send Audio Objects to Pro Tools"
|
||||
|
||||
bl_idname = "object.pro_tools_live"
|
||||
bl_label = "Send Audio Objects to Pro Tools"
|
||||
|
||||
room_size: bpy.props.FloatProperty(
|
||||
name="Room Size",
|
||||
description="Distance from the lens to the front room boundary",
|
||||
default=1.0,
|
||||
min=0.001,
|
||||
step=1,
|
||||
unit='LENGTH'
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def poll(cls, context):
|
||||
return len(filter_speakers(context.selected_objects)) > 0 and \
|
||||
bpy.app.online_access and \
|
||||
context.scene.camera is not None
|
||||
|
||||
def invoke(self, context, event):
|
||||
wm = context.window_manager
|
||||
return wm.invoke_props_dialog(self, confirm_text="Send to Pro Tools")
|
||||
|
||||
def execute(self, context) -> set:
|
||||
print("Execute called...")
|
||||
if pro_tools.send_to_pro_tools(
|
||||
filter_speakers(context.selected_objects),
|
||||
self.room_size):
|
||||
self.report({'INFO'}, "Speaker objects sent to Pro Tools")
|
||||
return {'FINISHED'}
|
||||
else:
|
||||
self.report({'ERROR'}, "Could not connect to Pro Tools")
|
||||
return {'FINISHED'}
|
||||
@@ -1,58 +0,0 @@
|
||||
import bpy
|
||||
import os
|
||||
|
||||
def import_wav_files(filepath, pack, dir, fake):
|
||||
|
||||
def import_one(fp):
|
||||
sound = bpy.data.sounds.load(fp, check_existing=False)
|
||||
if pack:
|
||||
sound.pack()
|
||||
|
||||
if fake:
|
||||
sound.use_fake_user = True
|
||||
|
||||
if dir:
|
||||
the_dir = os.path.dirname(filepath)
|
||||
for child in os.listdir(the_dir):
|
||||
if child.endswith(".wav"):
|
||||
import_one(os.path.join(the_dir, child))
|
||||
|
||||
else:
|
||||
import_one(filepath)
|
||||
|
||||
return {'FINISHED'}
|
||||
|
||||
|
||||
from bpy_extras.io_utils import ImportHelper
|
||||
from bpy.props import StringProperty, BoolProperty, EnumProperty
|
||||
from bpy.types import Operator
|
||||
|
||||
|
||||
class ImportWav(Operator, ImportHelper):
|
||||
"""Import WAV audio files"""
|
||||
bl_idname = "import_test.wav_file_batch"
|
||||
bl_label = "Import WAV Files"
|
||||
|
||||
filename_ext = ".wav"
|
||||
|
||||
filter_glob: StringProperty(
|
||||
default="*.wav",
|
||||
options={'HIDDEN'},
|
||||
maxlen=255, # Max internal buffer length, longer would be clamped.
|
||||
)
|
||||
|
||||
fake: BoolProperty(
|
||||
name="Add Fake User",
|
||||
description="Add the Fake User to each of the sound files",
|
||||
default=True,
|
||||
)
|
||||
|
||||
all_in_directory: BoolProperty(
|
||||
name="All Files in Folder",
|
||||
description="Import every WAV file found in the folder as the selected file",
|
||||
default=False,
|
||||
)
|
||||
|
||||
def execute(self, _):
|
||||
return import_wav_files(filepath=self.filepath, pack=False, dir=self.all_in_directory, fake=self.fake)
|
||||
|
||||
@@ -4,14 +4,12 @@ certifi==2025.10.5
|
||||
charset-normalizer==3.4.4
|
||||
cython==3.2.0
|
||||
decorator==5.2.1
|
||||
ear==2.1.0
|
||||
executing==2.2.1
|
||||
fake-bpy-module-4-3==20250130
|
||||
idna==3.11
|
||||
ipython==9.7.0
|
||||
ipython-pygments-lexers==1.1.1
|
||||
jedi==0.19.2
|
||||
lxml==4.9.4
|
||||
mathutils==3.3.0
|
||||
matplotlib-inline==0.2.1
|
||||
multipledispatch==0.6.0
|
||||
@@ -29,7 +27,6 @@ pygments==2.19.2
|
||||
requests==2.32.5
|
||||
ruamel-yaml==0.18.16
|
||||
ruamel-yaml-clib==0.2.14
|
||||
scipy==1.16.3
|
||||
setuptools==78.1.0
|
||||
six==1.17.0
|
||||
stack-data==0.6.3
|
||||
Reference in New Issue
Block a user