2025-12-01
This commit is contained in:
@@ -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.
|
||||
|
||||
PlaySync
|
||||
Copyright (C) 2020 Blender
|
||||
|
||||
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:
|
||||
|
||||
PlaySync Copyright (C) 2020 Blender
|
||||
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,4 @@
|
||||
# Contact Sheet
|
||||
Blender add-on to create a [contact sheet](https://en.wikipedia.org/wiki/Contact_print) from sequence editor strips.
|
||||
|
||||
You can find the documentation [here](https://studio.blender.org/tools/addons/contactsheet).
|
||||
@@ -0,0 +1,57 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from . import (
|
||||
prefs,
|
||||
props,
|
||||
opsdata,
|
||||
ops,
|
||||
ui,
|
||||
geo,
|
||||
geo_seq,
|
||||
)
|
||||
from .log import LoggerFactory
|
||||
|
||||
logger = LoggerFactory.getLogger(__name__)
|
||||
|
||||
bl_info = {
|
||||
"name": "Contactsheet",
|
||||
"author": "Paul Golter",
|
||||
"description": "Blender addon to create a contactsheet from sequence editor strips",
|
||||
"blender": (3, 0, 0),
|
||||
"version": (0, 1, 2),
|
||||
"location": "Sequence Editor",
|
||||
"category": "Sequencer",
|
||||
}
|
||||
|
||||
_need_reload = "ops" in locals()
|
||||
|
||||
if _need_reload:
|
||||
import importlib
|
||||
|
||||
geo_seq = importlib.reload(geo_seq)
|
||||
geo = importlib.reload(geo)
|
||||
props = importlib.reload(props)
|
||||
prefs = importlib.reload(prefs)
|
||||
opsdata = importlib.reload(opsdata)
|
||||
ops = importlib.reload(ops)
|
||||
ui = importlib.reload(ui)
|
||||
|
||||
|
||||
def register():
|
||||
props.register()
|
||||
prefs.register()
|
||||
ops.register()
|
||||
ui.register()
|
||||
|
||||
|
||||
def unregister():
|
||||
ui.unregister()
|
||||
ops.unregister()
|
||||
prefs.unregister()
|
||||
props.unregister()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
register()
|
||||
@@ -0,0 +1,19 @@
|
||||
schema_version = "1.0.0"
|
||||
|
||||
id = "contactsheet"
|
||||
version = "0.1.2"
|
||||
name = "Contact Sheet"
|
||||
tagline = "Create a contact sheet from sequence editor strips"
|
||||
maintainer = "Blender Studio"
|
||||
type = "add-on"
|
||||
website = "https://studio.blender.org/tools/addons/contactsheet"
|
||||
tags = ["Sequencer"]
|
||||
|
||||
blender_version_min = "4.2.0"
|
||||
|
||||
license = [
|
||||
"SPDX:GPL-3.0-or-later",
|
||||
]
|
||||
copyright = [
|
||||
"2019-2025 Paul Golter & Blender Studio",
|
||||
]
|
||||
@@ -0,0 +1,78 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from typing import Dict, List
|
||||
|
||||
import bpy
|
||||
|
||||
|
||||
def _do_ranges_collide(range1: range, range2: range) -> bool:
|
||||
"""Whether the two ranges collide with each other ."""
|
||||
# Usual strip setup strip1(101, 120)|strip2(120, 130)|strip3(130, 140)
|
||||
# first and last frame can be the same for each strip.
|
||||
range2 = range(range2.start + 1, range2.stop - 1)
|
||||
|
||||
if not range1:
|
||||
return True # Empty range is subset of anything.
|
||||
|
||||
if not range2:
|
||||
return False # Non-empty range can't be subset of empty range.
|
||||
|
||||
if len(range1) > 1 and range1.step % range2.step:
|
||||
return False # Must have a single value or integer multiple step.
|
||||
|
||||
if range(range1.start + 1, range1.stop - 1) == range2:
|
||||
return True
|
||||
|
||||
if range2.start in range1 or range2[-1] in range1:
|
||||
return True
|
||||
|
||||
return range1.start in range2 or range1[-1] in range2
|
||||
|
||||
|
||||
def get_occupied_ranges(context: bpy.types.Context) -> Dict[str, List[range]]:
|
||||
"""
|
||||
Scans sequence editor and returns a dictionary. It contains a key for each channel
|
||||
and a list of ranges with the occupied frame ranges as values.
|
||||
"""
|
||||
# {'1': [(101, 213), (300, 320)]}.
|
||||
ranges: Dict[str, List[range]] = {}
|
||||
|
||||
# Populate ranges.
|
||||
for strip in context.scene.sequence_editor.sequences_all:
|
||||
ranges.setdefault(str(strip.channel), [])
|
||||
ranges[str(strip.channel)].append(
|
||||
range(strip.frame_final_start, strip.frame_final_end + 1)
|
||||
)
|
||||
|
||||
# Sort ranges tuple list.
|
||||
for channel in ranges:
|
||||
liste = ranges[channel]
|
||||
ranges[channel] = sorted(liste, key=lambda item: item.start)
|
||||
|
||||
return ranges
|
||||
|
||||
|
||||
def get_occupied_ranges_for_strips(sequences: List["bpy.types.Strip"]) -> List[range]:
|
||||
"""
|
||||
Scans input list of sequences and returns a list of ranges that represent the occupied frame ranges.
|
||||
"""
|
||||
ranges: List[range] = []
|
||||
|
||||
# Populate ranges.
|
||||
for strip in sequences:
|
||||
ranges.append(range(strip.frame_final_start, strip.frame_final_end + 1))
|
||||
|
||||
# Sort ranges tuple list.
|
||||
ranges.sort(key=lambda item: item.start)
|
||||
return ranges
|
||||
|
||||
|
||||
def is_range_occupied(range_to_check: range, occupied_ranges: List[range]) -> bool:
|
||||
for r in occupied_ranges:
|
||||
# Range(101, 150).
|
||||
if _do_ranges_collide(range_to_check, r):
|
||||
return True
|
||||
continue
|
||||
return False
|
||||
@@ -0,0 +1,800 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import annotations
|
||||
import math
|
||||
from typing import Union, Optional, List
|
||||
from enum import Enum
|
||||
|
||||
|
||||
class Align(Enum):
|
||||
"""
|
||||
Enum class that represents different alignment options.
|
||||
"""
|
||||
|
||||
NO = 1
|
||||
CENTER = 2
|
||||
TOP = 3
|
||||
BOTTOM = 4
|
||||
|
||||
|
||||
class Point:
|
||||
|
||||
"""
|
||||
Class that represents a point with 2 coordinates.
|
||||
"""
|
||||
|
||||
def __init__(self, x: int, y: int):
|
||||
self._x = int(x)
|
||||
self._y = int(y)
|
||||
|
||||
@property
|
||||
def x(self) -> int:
|
||||
return self._x
|
||||
|
||||
@property
|
||||
def y(self) -> int:
|
||||
return self._y
|
||||
|
||||
def __add__(self, other: Point):
|
||||
return Point(self.x + other.x, self.y + other.y)
|
||||
|
||||
def __iadd__(self, other: Point):
|
||||
self.x + other.x
|
||||
self.y + other.y
|
||||
return self
|
||||
|
||||
def __sub__(self, other: Point):
|
||||
return Point(self.x - other.x, self.y - other.y)
|
||||
|
||||
def __isub__(self, other: Point):
|
||||
self.x - other.x
|
||||
self.y - other.y
|
||||
return self
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"Point(x: {self.x}, y: {self.y})"
|
||||
|
||||
|
||||
class RectCoords:
|
||||
"""
|
||||
Class that represents the coordinates of a Rectangle.
|
||||
Instances of this class are returned by the Rectangle class.
|
||||
The individual coordinate can be retrieved with
|
||||
(x1, x2, y1, y2) or (top_left, top_right, bot_left, bot_right).
|
||||
"""
|
||||
|
||||
def __init__(self, x1: Point, x2: Point, y1: Point, y2: Point):
|
||||
self._x1 = x1
|
||||
self._x2 = x2
|
||||
self._y1 = y1
|
||||
self._y2 = y2
|
||||
|
||||
@property
|
||||
def x1(self) -> Point:
|
||||
return self._x1
|
||||
|
||||
@property
|
||||
def x2(self) -> Point:
|
||||
return self._x2
|
||||
|
||||
@property
|
||||
def y1(self) -> Point:
|
||||
return self._y1
|
||||
|
||||
@property
|
||||
def y2(self) -> Point:
|
||||
return self._y2
|
||||
|
||||
@property
|
||||
def top_left(self) -> Point:
|
||||
return self._x1
|
||||
|
||||
@property
|
||||
def top_right(self) -> Point:
|
||||
return self._x2
|
||||
|
||||
@property
|
||||
def bot_left(self) -> Point:
|
||||
return self._y1
|
||||
|
||||
@property
|
||||
def bot_right(self) -> Point:
|
||||
return self._y2
|
||||
|
||||
|
||||
class Rectangle:
|
||||
"""
|
||||
Class that represents a rectangle. It makes heavy use of private functions so
|
||||
this class can be easily re-implemented to work with Blender sequence strips.
|
||||
"""
|
||||
|
||||
def __init__(self, x: int, y: int, width: int, height: int):
|
||||
self._width: int = int(width)
|
||||
self._height: int = int(height)
|
||||
self._x: int = int(x)
|
||||
self._y: int = int(y)
|
||||
self._orig_width: int = self._width
|
||||
self._orig_height: int = self._height
|
||||
self._orig_x: int = self._x
|
||||
self._orig_y: int = self._y
|
||||
self._scale_x: float = 1.0
|
||||
self._scale_y: float = 1.0
|
||||
|
||||
# X.
|
||||
@property
|
||||
def x(self) -> int:
|
||||
return self._get_x()
|
||||
|
||||
def _get_x(self) -> int:
|
||||
return self._x
|
||||
|
||||
@x.setter
|
||||
def x(self, value: int) -> None:
|
||||
return self._set_x(value)
|
||||
|
||||
def _set_x(self, value: int) -> None:
|
||||
self._x = int(value)
|
||||
|
||||
@property
|
||||
def orig_x(self) -> int:
|
||||
return self._get_orig_x()
|
||||
|
||||
def _get_orig_x(self) -> int:
|
||||
return self._orig_x
|
||||
|
||||
# Y.
|
||||
@property
|
||||
def y(self) -> int:
|
||||
return self._get_y()
|
||||
|
||||
def _get_y(self) -> int:
|
||||
return self._y
|
||||
|
||||
@y.setter
|
||||
def y(self, value: int) -> None:
|
||||
return self._set_y(value)
|
||||
|
||||
def _set_y(self, value: int) -> None:
|
||||
self._y = int(value)
|
||||
|
||||
@property
|
||||
def orig_y(self) -> int:
|
||||
return self._get_orig_y()
|
||||
|
||||
def _get_orig_y(self) -> int:
|
||||
return self._orig_y
|
||||
|
||||
# Width.
|
||||
@property
|
||||
def width(self) -> int:
|
||||
return self._get_width()
|
||||
|
||||
def _get_width(self) -> int:
|
||||
return self._width
|
||||
|
||||
@width.setter
|
||||
def width(self, value: int) -> None:
|
||||
return self._set_width(value)
|
||||
|
||||
def _set_width(self, value: int) -> None:
|
||||
self._width = int(value)
|
||||
|
||||
@property
|
||||
def orig_width(self) -> int:
|
||||
return self._get_orig_width()
|
||||
|
||||
def _get_orig_width(self) -> int:
|
||||
return self._orig_width
|
||||
|
||||
# Height.
|
||||
@property
|
||||
def height(self) -> int:
|
||||
return self._get_height()
|
||||
|
||||
def _get_height(self) -> int:
|
||||
return self._height
|
||||
|
||||
@height.setter
|
||||
def height(self, value: int) -> None:
|
||||
return self._set_height(value)
|
||||
|
||||
def _set_height(self, value: int) -> None:
|
||||
self._height = int(value)
|
||||
|
||||
@property
|
||||
def orig_height(self) -> int:
|
||||
return self._get_orig_height()
|
||||
|
||||
def _get_orig_height(self) -> int:
|
||||
return self._orig_height
|
||||
|
||||
# Scale.
|
||||
|
||||
@property
|
||||
def scale_x(self):
|
||||
return self._get_scale_x()
|
||||
|
||||
def _get_scale_x(self):
|
||||
return self._scale_x
|
||||
|
||||
@scale_x.setter
|
||||
def scale_x(self, factor: float) -> None:
|
||||
return self._set_scale_x(factor)
|
||||
|
||||
def _set_scale_x(self, factor: float) -> None:
|
||||
new_width = self.width * float(factor)
|
||||
self.x += self.width / 2 - new_width / 2
|
||||
self.width = new_width
|
||||
|
||||
@property
|
||||
def scale_y(self):
|
||||
return self._get_scale_y()
|
||||
|
||||
def _get_scale_y(self):
|
||||
return self._scale_y
|
||||
|
||||
@scale_y.setter
|
||||
def scale_y(self, factor: float) -> None:
|
||||
return self._set_scale_y(factor)
|
||||
|
||||
def _set_scale_y(self, factor: float) -> None:
|
||||
new_height = self.height * float(factor)
|
||||
self.y += self.height / 2 - new_height / 2
|
||||
self.height = new_height
|
||||
|
||||
def scale(self, factor: float) -> None:
|
||||
self.scale_x *= factor
|
||||
self.scale_y *= factor
|
||||
|
||||
# Aspect.
|
||||
@property
|
||||
def aspect_ratio(self) -> float:
|
||||
return self.width / self.height
|
||||
|
||||
# Area.
|
||||
@property
|
||||
def area(self) -> int:
|
||||
return self.width * self.height
|
||||
|
||||
# Center.
|
||||
@property
|
||||
def center(self) -> Point:
|
||||
center_x = int(self.x + (0.5 * self.width))
|
||||
center_y = int(self.y + (0.5 * self.height))
|
||||
return Point(center_x, center_y)
|
||||
|
||||
# Position.
|
||||
@property
|
||||
def position(self) -> Point:
|
||||
return Point(self.x, self.y)
|
||||
|
||||
@position.setter
|
||||
def position(self, pos: Point) -> None:
|
||||
self.x = pos.x
|
||||
self.y = pos.y
|
||||
|
||||
# Coords.
|
||||
@property
|
||||
def coords(self) -> RectCoords:
|
||||
top_left = self.position
|
||||
top_right = Point(self.x + self.width, self.y)
|
||||
bot_left = Point(self.x, self.y + self.height)
|
||||
bot_right = Point(self.x + self.width, self.y + self.height)
|
||||
return RectCoords(top_left, top_right, bot_left, bot_right)
|
||||
|
||||
# Functions.
|
||||
def fit_to_rect(
|
||||
self,
|
||||
rect: Rectangle,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
keep_offset: bool = False,
|
||||
):
|
||||
# If self.aspect_ratio > rect.aspect_ratio:
|
||||
# -> fit self by width
|
||||
# else fit bei height.
|
||||
|
||||
# Width height.
|
||||
if keep_aspect:
|
||||
|
||||
# Fit by width.
|
||||
if self.aspect_ratio > rect.aspect_ratio:
|
||||
scale_fac = rect.width / self.width
|
||||
self.width = rect.width
|
||||
self.height = int(self.height * scale_fac)
|
||||
|
||||
# Fit by height.
|
||||
elif self.aspect_ratio < rect.aspect_ratio:
|
||||
scale_fac = rect.height / self.height
|
||||
self.height = rect.height
|
||||
self.width = int(self.width * scale_fac)
|
||||
|
||||
else:
|
||||
# Copy width and height.
|
||||
self.width = rect.width
|
||||
self.height = rect.height
|
||||
|
||||
# Position.
|
||||
if keep_offset:
|
||||
self.position += self.position - rect.position
|
||||
|
||||
else:
|
||||
self.position = rect.position
|
||||
|
||||
# Fit by width.
|
||||
if self.aspect_ratio > rect.aspect_ratio:
|
||||
if align == Align.NO:
|
||||
pass
|
||||
|
||||
if align == Align.CENTER:
|
||||
height_diff = rect.height - self.height
|
||||
self.y += int(height_diff / 2)
|
||||
|
||||
elif align == Align.TOP:
|
||||
self.y == rect.y
|
||||
|
||||
elif align == Align.BOTTOM:
|
||||
height_diff = rect.height - self.height
|
||||
self.y = rect.y + height_diff
|
||||
|
||||
# Fit by height.
|
||||
elif self.aspect_ratio < rect.aspect_ratio:
|
||||
width_diff = rect.width - self.width
|
||||
|
||||
if align == Align.NO:
|
||||
pass
|
||||
|
||||
if align == Align.CENTER:
|
||||
self.x += int(width_diff / 2)
|
||||
|
||||
elif align == Align.TOP:
|
||||
self.x == rect.x
|
||||
|
||||
elif align == Align.BOTTOM:
|
||||
self.x = rect.x + width_diff
|
||||
|
||||
def reset_transform(self):
|
||||
self.scale_x = 1
|
||||
self.scale_y = 1
|
||||
self.x = self.orig_x
|
||||
self.y = self.orig_y
|
||||
self.width = self.orig_width
|
||||
self.height = self.orig_height
|
||||
|
||||
def copy(self) -> Rectangle:
|
||||
return Rectangle(self.x, self.y, self.width, self.height)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"Rectangle(x: {self.x}, y: {self.y}, width: {self.width}, height: {self.height})"
|
||||
|
||||
@property
|
||||
def valid(self) -> bool:
|
||||
return bool(self.width and self.height)
|
||||
|
||||
|
||||
class NestedRectangle(Rectangle):
|
||||
"""
|
||||
A Class that inherits from Rectangle and holds a child inside. The child can be anything
|
||||
that supports the public interface of the Rectangle class. Can also be another instance of
|
||||
a NestedRectangle.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
x: int,
|
||||
y: int,
|
||||
width: int,
|
||||
height: int,
|
||||
child: Optional[Union[Rectangle, NestedRectangle]] = None,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
keep_offset: bool = False,
|
||||
):
|
||||
super().__init__(x, y, width, height)
|
||||
|
||||
# If child was not supplied on init make child same dimensions as parent.
|
||||
if child == None:
|
||||
child = Rectangle(0, 0, self.width, self.height)
|
||||
|
||||
self._child = child
|
||||
self._keep_aspect = keep_aspect
|
||||
self._align = align
|
||||
self._keep_offset = keep_offset
|
||||
self._child.fit_to_rect(
|
||||
self.get_rect(),
|
||||
keep_aspect=keep_aspect,
|
||||
align=align,
|
||||
keep_offset=keep_offset,
|
||||
)
|
||||
|
||||
def fit_to_rect(
|
||||
self,
|
||||
rect: Rectangle,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
keep_offset: bool = False,
|
||||
):
|
||||
super().fit_to_rect(
|
||||
rect, keep_aspect=keep_aspect, align=align, keep_offset=keep_offset
|
||||
)
|
||||
self.child.fit_to_rect(
|
||||
self.get_rect(),
|
||||
keep_aspect=keep_aspect,
|
||||
align=align,
|
||||
keep_offset=keep_offset,
|
||||
)
|
||||
|
||||
def get_rect(self) -> Rectangle:
|
||||
return Rectangle(self.x, self.y, self.width, self.height)
|
||||
|
||||
@property
|
||||
def child(self) -> Rectangle:
|
||||
return self._child
|
||||
|
||||
def set_child(
|
||||
self,
|
||||
child: Union[Rectangle, NestedRectangle],
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
keep_offset: bool = False,
|
||||
) -> None:
|
||||
|
||||
self._child = child
|
||||
self._child.fit_to_rect(
|
||||
self.get_rect(),
|
||||
keep_aspect=keep_aspect,
|
||||
align=align,
|
||||
keep_offset=keep_offset,
|
||||
)
|
||||
self._keep_aspect = keep_aspect
|
||||
self._align = align
|
||||
self._keep_offset = keep_offset
|
||||
|
||||
def copy(self) -> NestedRectangle:
|
||||
return NestedRectangle(
|
||||
self.x,
|
||||
self.y,
|
||||
self.width,
|
||||
self.height,
|
||||
self.child.copy(),
|
||||
keep_aspect=self._keep_aspect,
|
||||
align=self._align,
|
||||
)
|
||||
|
||||
def _set_x(self, value: int) -> None:
|
||||
offset = self.child.x - self._x
|
||||
self._x = int(value)
|
||||
self.child.x = int(value + offset)
|
||||
|
||||
def _set_y(self, value: int) -> None:
|
||||
offset = self.child.y - self._y
|
||||
self._y = int(value)
|
||||
self.child.y = int(value + offset)
|
||||
|
||||
def _set_width(self, value: int) -> None:
|
||||
self._width = int(value)
|
||||
self.child.fit_to_rect(
|
||||
self.get_rect(), self._keep_aspect, self._align, keep_offset=True
|
||||
)
|
||||
|
||||
def _set_height(self, value: int) -> None:
|
||||
self._height = int(value)
|
||||
self.child.fit_to_rect(
|
||||
self.get_rect(), self._keep_aspect, self._align, keep_offset=True
|
||||
)
|
||||
|
||||
def _set_scale_x(self, factor: float) -> None:
|
||||
super()._set_scale_x(factor)
|
||||
self.child.fit_to_rect(
|
||||
self.get_rect(),
|
||||
keep_aspect=self._keep_aspect,
|
||||
align=self._align,
|
||||
keep_offset=self._keep_offset,
|
||||
)
|
||||
|
||||
def _set_scale_y(self, factor: float) -> None:
|
||||
super()._set_scale_y(factor)
|
||||
self.child.fit_to_rect(
|
||||
self.get_rect(),
|
||||
keep_aspect=self._keep_aspect,
|
||||
align=self._align,
|
||||
keep_offset=self._keep_offset,
|
||||
)
|
||||
|
||||
@property
|
||||
def keep_aspect(self) -> bool:
|
||||
return self._keep_aspect
|
||||
|
||||
@keep_aspect.setter
|
||||
def keep_aspect(self, value: bool):
|
||||
self._keep_aspect = value
|
||||
|
||||
@property
|
||||
def align(self) -> Align:
|
||||
return self._align
|
||||
|
||||
@align.setter
|
||||
def align(self, value: Align) -> None:
|
||||
self._align = value
|
||||
|
||||
self.child.fit_to_rect(
|
||||
self.get_rect(),
|
||||
keep_aspect=self._keep_aspect,
|
||||
align=self._align,
|
||||
keep_offset=self._keep_offset,
|
||||
)
|
||||
|
||||
@property
|
||||
def keep_offset(self) -> bool:
|
||||
return self._keep_offset
|
||||
|
||||
@keep_offset.setter
|
||||
def keep_offset(self, value: bool):
|
||||
self._keep_offset = value
|
||||
|
||||
|
||||
class Cell(NestedRectangle):
|
||||
"""
|
||||
A Class that inherits from NestedRectangle and holds another NestedRectangle inside.
|
||||
It's specifically bound to this hierarchy so it works well inside the Grid Class.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
x: int,
|
||||
y: int,
|
||||
width: int,
|
||||
height: int,
|
||||
child: Optional[NestedRectangle] = None,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
):
|
||||
# If child was not supplied on init make child same dimensions as parent.
|
||||
if child == None:
|
||||
child = NestedRectangle(0, 0, width, height)
|
||||
|
||||
# Init self.
|
||||
super().__init__(
|
||||
x, y, width, height, child, keep_aspect=keep_aspect, align=align
|
||||
)
|
||||
|
||||
def copy(self) -> Cell:
|
||||
return Cell(
|
||||
self.x,
|
||||
self.y,
|
||||
self.width,
|
||||
self.height,
|
||||
self.child.copy(),
|
||||
keep_aspect=self._keep_aspect,
|
||||
align=self._align,
|
||||
)
|
||||
|
||||
def clear_content(self) -> None:
|
||||
self.set_child(NestedRectangle(0, 0, self.width, self.height))
|
||||
|
||||
|
||||
class Grid(Rectangle):
|
||||
def __init__(
|
||||
self,
|
||||
x: int,
|
||||
y: int,
|
||||
width: int,
|
||||
height: int,
|
||||
row_count: int,
|
||||
coll_count: int,
|
||||
cell_templ: Optional[Cell] = None,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
) -> None:
|
||||
|
||||
super().__init__(x, y, width, height)
|
||||
self._keep_aspect: bool = keep_aspect
|
||||
self._align: Align = align
|
||||
|
||||
# If cell_templ was not supplied on init make cell that has same dimensions as row / coll.
|
||||
if cell_templ == None:
|
||||
cell_templ: Cell = Cell(
|
||||
0, 0, int(self.height / row_count), int(self.width / coll_count)
|
||||
)
|
||||
|
||||
# Init rows, colls, cells.
|
||||
self.rows: List[Rectangle] = []
|
||||
self.colls: List[Rectangle] = []
|
||||
self.cells: List[List[Cell]] = []
|
||||
self._init_grid(
|
||||
row_count,
|
||||
coll_count,
|
||||
cell_templ,
|
||||
keep_aspect,
|
||||
align,
|
||||
)
|
||||
|
||||
def _init_grid(
|
||||
self,
|
||||
row_count: int,
|
||||
coll_count: int,
|
||||
cell_templ: Cell,
|
||||
keep_aspect: bool,
|
||||
align: Align,
|
||||
) -> None:
|
||||
|
||||
self._init_rows(row_count)
|
||||
self._init_colls(coll_count)
|
||||
self._init_cells(cell_templ, keep_aspect, align)
|
||||
|
||||
def _init_rows(self, row_count: int) -> None:
|
||||
row_height: int = int(self.height / row_count)
|
||||
self.rows = [
|
||||
Rectangle(self.x, self.y + (row_height * row_idx), self.width, row_height)
|
||||
for row_idx in range(row_count)
|
||||
]
|
||||
|
||||
def _init_colls(self, coll_count: int) -> None:
|
||||
coll_width: int = int(self.width / coll_count)
|
||||
self.colls = [
|
||||
Rectangle(self.x + (coll_width * coll_idx), self.y, coll_width, self.height)
|
||||
for coll_idx in range(coll_count)
|
||||
]
|
||||
|
||||
def _init_cells(self, cell_templ: Cell, keep_aspect: bool, align: Align) -> None:
|
||||
# TODO: cell.child.keep_aspect = keep_aspect.
|
||||
|
||||
self.cells.clear()
|
||||
# If cell_templ was supplied make sure it has the right dimension to fit in grid.
|
||||
cell_templ.width = self.coll_width
|
||||
cell_templ.height = self.row_height
|
||||
|
||||
for row_index, row in enumerate(self.rows):
|
||||
cell_y = row.y
|
||||
self.cells.append([])
|
||||
|
||||
for coll in self.colls:
|
||||
cell_x = coll.x
|
||||
|
||||
# Make copy to have each cell individual instance.
|
||||
cell_instance = cell_templ.copy()
|
||||
cell_instance.position = Point(cell_x, cell_y)
|
||||
self.cells[row_index].append(cell_instance)
|
||||
|
||||
@classmethod
|
||||
def from_content(
|
||||
csl,
|
||||
x: int,
|
||||
y: int,
|
||||
width: int,
|
||||
height: int,
|
||||
content: List[NestedRectangle],
|
||||
row_count: Optional[int] = None,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
) -> Grid:
|
||||
"""
|
||||
Creates a grid based of a content list. Calculates optimal amount of rows and colls.
|
||||
"""
|
||||
if not row_count:
|
||||
|
||||
# Calculate by how much images need to be scaled in order to fit.. (won't be perfect).
|
||||
available_area = width * height
|
||||
content_area_orig = content[0].child.area
|
||||
content_area = available_area / len(content)
|
||||
scale_factor = math.sqrt(content_area / content_area_orig)
|
||||
|
||||
content_size = (
|
||||
content[0].child.width * scale_factor,
|
||||
content[0].child.height * scale_factor,
|
||||
)
|
||||
|
||||
row_count = math.ceil(width / content_size[0])
|
||||
coll_count = math.ceil(len(content) / row_count)
|
||||
|
||||
else:
|
||||
# Row count should not be bigger as nr of cells.
|
||||
row_count = min(row_count, len(content))
|
||||
coll_count = math.ceil(len(content) / row_count) # 13 / 3 = 4.3 -> 4
|
||||
|
||||
grid = Grid(
|
||||
x,
|
||||
y,
|
||||
width,
|
||||
height,
|
||||
row_count,
|
||||
coll_count,
|
||||
keep_aspect=keep_aspect,
|
||||
align=align,
|
||||
)
|
||||
grid.place_content(content, keep_aspect=keep_aspect, align=align)
|
||||
return grid
|
||||
|
||||
def get_cells_for_row(self, row_index: int) -> List[Cell]:
|
||||
return self.cells[row_index]
|
||||
|
||||
def get_cell(self, row_index: int, coll_index: int) -> Cell:
|
||||
return self.cells[row_index][coll_index]
|
||||
|
||||
def get_cells_all(self) -> List[Cell]:
|
||||
cells: List[Cell] = []
|
||||
for row_idx in range(self.row_count()):
|
||||
cells.extend(self.get_cells_for_row(row_idx))
|
||||
return cells
|
||||
|
||||
@property
|
||||
def row_height(self) -> int:
|
||||
return int(self.height / self.row_count())
|
||||
|
||||
@property
|
||||
def coll_width(self) -> int:
|
||||
return int(self.width / self.coll_count())
|
||||
|
||||
def row_count(self) -> int:
|
||||
return len(self.rows)
|
||||
|
||||
def coll_count(self) -> int:
|
||||
return len(self.colls)
|
||||
|
||||
def place_content(
|
||||
self,
|
||||
content_list: List[NestedRectangle],
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
keep_offset: bool = False,
|
||||
clear_cells: bool = True,
|
||||
):
|
||||
"""
|
||||
Fills up all available cells with the content from given list.
|
||||
Will clear remaining empty cells.
|
||||
"""
|
||||
counter: int = 0
|
||||
for row_idx in range(self.row_count()):
|
||||
for cell in self.get_cells_for_row(row_idx):
|
||||
try:
|
||||
content = content_list[counter]
|
||||
except IndexError:
|
||||
if clear_cells:
|
||||
cell.clear_content()
|
||||
else:
|
||||
# Switch child of cell.
|
||||
cell.set_child(
|
||||
content,
|
||||
keep_aspect=keep_aspect,
|
||||
align=align,
|
||||
keep_offset=keep_offset,
|
||||
)
|
||||
|
||||
counter += 1
|
||||
|
||||
def place_content_in_cell(
|
||||
self,
|
||||
row_index: int,
|
||||
coll_index: int,
|
||||
content: NestedRectangle,
|
||||
keep_aspect: bool = True,
|
||||
align: Align = Align.CENTER,
|
||||
keep_offset: bool = False,
|
||||
):
|
||||
cell = self.get_cell(row_index, coll_index)
|
||||
# Switch child of cell.
|
||||
cell.set_child(
|
||||
content,
|
||||
keep_aspect=keep_aspect,
|
||||
align=align,
|
||||
keep_offset=keep_offset,
|
||||
)
|
||||
|
||||
def scale_content(self, factor: float):
|
||||
for cell in self.get_cells_all():
|
||||
cell.child.scale_x *= factor
|
||||
cell.child.scale_y *= factor
|
||||
|
||||
def scale_content_x(self, factor: float):
|
||||
for cell in self.get_cells_all():
|
||||
cell.child.scale_x *= factor
|
||||
|
||||
def scale_content_y(self, factor: float):
|
||||
for cell in self.get_cells_all():
|
||||
cell.child.scale_y *= factor
|
||||
|
||||
def reset_content_transforms(self):
|
||||
for cell in self.get_cells_all():
|
||||
cell.reset_transform()
|
||||
@@ -0,0 +1,128 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import List
|
||||
from pathlib import Path
|
||||
|
||||
import bpy
|
||||
|
||||
from .geo import Rectangle
|
||||
|
||||
|
||||
class SequenceRect(Rectangle):
|
||||
"""
|
||||
Class that represents a Blender sequence strip as a rectangle. It
|
||||
inherits from Rectangle class and implements the _ methods so the
|
||||
Rectangle public interface works as excpected.
|
||||
"""
|
||||
|
||||
valid_types: List[str] = ["MOVIE", "IMAGE"]
|
||||
|
||||
def __init__(self, sequence: "bpy.types.Strip"):
|
||||
|
||||
if sequence.type not in self.valid_types:
|
||||
raise ValueError(
|
||||
f"SequenceRect can only hold sequences of type {str(self.valid_types)}"
|
||||
)
|
||||
|
||||
self._sequence: "bpy.types.Strip" = sequence
|
||||
self._orig_x: int = sequence.transform.offset_x
|
||||
self._orig_y: int = sequence.transform.offset_y
|
||||
|
||||
@property
|
||||
def sequence(self) -> "bpy.types.Strip":
|
||||
return self._sequence
|
||||
|
||||
def _get_orig_width(self) -> int:
|
||||
return self.sequence.elements[0].orig_width
|
||||
|
||||
def _get_orig_height(self) -> int:
|
||||
return self.sequence.elements[0].orig_height
|
||||
|
||||
# X.
|
||||
def _get_x(self) -> int:
|
||||
return (
|
||||
self._canvas_x / 2 - (self.width / 2) + (self.sequence.transform.offset_x)
|
||||
)
|
||||
|
||||
def _set_x(self, value: int) -> None:
|
||||
# To origin.
|
||||
self.sequence.transform.offset_x = -(self._canvas_x / 2) + (self.width / 2)
|
||||
# Plus value.
|
||||
self.sequence.transform.offset_x += value
|
||||
|
||||
# Y.
|
||||
def _get_y(self) -> int:
|
||||
return (
|
||||
self._canvas_y / 2 - (self.height / 2) - (self.sequence.transform.offset_y)
|
||||
)
|
||||
|
||||
def _set_y(self, value: int) -> None:
|
||||
# Y in blender sqe goes up ^ + and down minus (confusing)
|
||||
# to origin.
|
||||
self.sequence.transform.offset_y = (self._canvas_y / 2) - (self.height / 2)
|
||||
# Minus value.
|
||||
self.sequence.transform.offset_y -= value
|
||||
|
||||
# Width.
|
||||
def _get_width(self) -> int:
|
||||
return self.orig_width * self.scale_x
|
||||
|
||||
def _set_width(self, value: int) -> None:
|
||||
scale_fac = value / self.orig_width
|
||||
self.scale_x = scale_fac
|
||||
|
||||
# Height.
|
||||
def _get_height(self) -> int:
|
||||
return self.orig_height * self.scale_y
|
||||
|
||||
def _set_height(self, value: int) -> None:
|
||||
scale_fac = value / self.orig_height
|
||||
self.scale_y = scale_fac
|
||||
|
||||
# Scale.
|
||||
|
||||
def _get_scale_x(self):
|
||||
return self.sequence.transform.scale_x
|
||||
|
||||
def _get_scale_y(self):
|
||||
return self.sequence.transform.scale_y
|
||||
|
||||
def _set_scale_x(self, factor: float) -> None:
|
||||
self.sequence.transform.scale_x = float(factor)
|
||||
|
||||
def _set_scale_y(self, factor: float) -> None:
|
||||
self.sequence.transform.scale_y = float(factor)
|
||||
|
||||
# Functions.
|
||||
def copy(self) -> SequenceRect:
|
||||
if self.sequence.type == "IMAGE":
|
||||
strip = bpy.context.scene.sequence_editor.sequences.new_image(
|
||||
self.sequence.name,
|
||||
Path(self.sequence.directory)
|
||||
.joinpath(self.sequence.elements[0].filename)
|
||||
.as_posix(),
|
||||
self.sequence.channel + 1,
|
||||
self.sequence.frame_final_start,
|
||||
)
|
||||
elif self.sequence.type == "MOVIE":
|
||||
strip = bpy.context.scene.sequence_editor.sequences.new_movie(
|
||||
self.sequence.name,
|
||||
self.sequence.file,
|
||||
self.sequence.channel + 1,
|
||||
self.sequence.frame_final_start,
|
||||
)
|
||||
|
||||
sequence_rect = SequenceRect(strip)
|
||||
sequence_rect.fit_to_rect(self)
|
||||
return sequence_rect
|
||||
|
||||
@property
|
||||
def _canvas_x(self):
|
||||
return bpy.context.scene.render.resolution_x
|
||||
|
||||
@property
|
||||
def _canvas_y(self):
|
||||
return bpy.context.scene.render.resolution_y
|
||||
@@ -0,0 +1,17 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
import logging
|
||||
|
||||
|
||||
class LoggerFactory:
|
||||
|
||||
"""
|
||||
Utility class to streamline logger creation
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
def getLogger(name=__name__):
|
||||
logger = logging.getLogger(name)
|
||||
return logger
|
||||
@@ -0,0 +1,266 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
import math
|
||||
from pathlib import Path
|
||||
from typing import Set, List
|
||||
|
||||
import bpy
|
||||
|
||||
from . import prefs, opsdata
|
||||
from .log import LoggerFactory
|
||||
from .geo_seq import SequenceRect
|
||||
from .geo import Grid, NestedRectangle
|
||||
|
||||
logger = LoggerFactory.getLogger(name=__name__)
|
||||
|
||||
|
||||
class CS_OT_make_contactsheet(bpy.types.Operator):
|
||||
"""
|
||||
This operator creates a contactsheet out of the selected sequence strips.
|
||||
The contactsheet will be created in a separate scene.
|
||||
"""
|
||||
|
||||
bl_idname = "contactsheet.make_contactsheet"
|
||||
bl_label = "Make Contact Sheet"
|
||||
bl_description = (
|
||||
"Creates a temporary scene and arranges the previously selected sequences in a grid. "
|
||||
"If no sequences were selected it takes a continuous row of the top most sequences"
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def poll(cls, context: bpy.types.Context) -> bool:
|
||||
return opsdata.poll_make_contactsheet(context)
|
||||
|
||||
def execute(self, context: bpy.types.Context) -> Set[str]:
|
||||
|
||||
addon_prefs = prefs.addon_prefs_get(context)
|
||||
|
||||
# Gather sequences to process.
|
||||
sequences = context.selected_sequences
|
||||
if not sequences:
|
||||
# If nothing selected take a continuous row of the top most sequences.
|
||||
sequences = opsdata.get_top_level_valid_strips_continuous(context)
|
||||
else:
|
||||
sequences = opsdata.get_valid_cs_sequences(sequences)
|
||||
|
||||
# Select sequences, will remove sequences later that are not selected.
|
||||
bpy.ops.sequencer.select_all(action="DESELECT")
|
||||
for s in sequences:
|
||||
s.select = True
|
||||
|
||||
row_count = None
|
||||
start_frame = 1
|
||||
|
||||
# Get contactsheet metadata.
|
||||
sqe_editor = opsdata.get_sqe_editor(context)
|
||||
orig_proxy_render_size = sqe_editor.spaces.active.proxy_render_size
|
||||
orig_use_proxies = sqe_editor.spaces.active.use_proxies
|
||||
|
||||
# Create new scene.
|
||||
scene_orig = bpy.context.scene
|
||||
bpy.ops.scene.new(type="FULL_COPY") # Changes active scene, makes copy.
|
||||
scene_tmp = bpy.context.scene
|
||||
scene_tmp.name = "contactsheet"
|
||||
logger.info("Created temporary scene for contactsheet: %s", scene_tmp.name)
|
||||
|
||||
# Save contactsheet metadata.
|
||||
sqe_editor = opsdata.get_sqe_editor(context)
|
||||
sqe_editor.spaces.active.proxy_render_size = "PROXY_25"
|
||||
sqe_editor.spaces.active.use_proxies = True
|
||||
scene_tmp.contactsheet.is_contactsheet = True
|
||||
scene_tmp.contactsheet.contactsheet_meta.scene = scene_orig
|
||||
scene_tmp.contactsheet.contactsheet_meta.use_proxies = orig_use_proxies
|
||||
scene_tmp.contactsheet.contactsheet_meta.proxy_render_size = (
|
||||
orig_proxy_render_size
|
||||
)
|
||||
|
||||
# Remove sequences in new scene that are not selected.
|
||||
seq_rm: List["bpy.types.Strip"] = [
|
||||
s for s in scene_tmp.sequence_editor.sequences_all if not s.select
|
||||
]
|
||||
for s in seq_rm:
|
||||
scene_tmp.sequence_editor.sequences.remove(s)
|
||||
|
||||
# Get all sequences in new scene and sort them.
|
||||
sequences = list(scene_tmp.sequence_editor.sequences_all)
|
||||
sequences.sort(key=lambda strip: (strip.frame_final_start, strip.channel))
|
||||
|
||||
# Place black color strip in channel 1.
|
||||
color_strip = context.scene.sequence_editor.sequences.new_effect(
|
||||
"background", "COLOR", 1, start_frame, frame_end=start_frame + 1
|
||||
)
|
||||
color_strip.color = (0, 0, 0)
|
||||
|
||||
# Create required number of Metadata Strips to workaround the limit of 32 channels.
|
||||
nr_of_metadata_strips = math.ceil(len(sequences) / 32)
|
||||
metadata_strips: List["bpy.types.Strip"] = []
|
||||
for i in range(nr_of_metadata_strips):
|
||||
channel = i + 2
|
||||
metadata_strip = context.scene.sequence_editor.sequences.new_meta(
|
||||
f"contactsheet_meta_{channel-1}", channel, start_frame
|
||||
)
|
||||
metadata_strips.append(metadata_strip)
|
||||
logger.debug("Created Metadata Strip: %s", metadata_strip.name)
|
||||
|
||||
# Move sequences in to Metadata Strips, place them on top of each other
|
||||
# make them start at the same frame.
|
||||
for idx, seq in enumerate(sequences):
|
||||
# Move to Metadata Strip.
|
||||
channel = idx + 1
|
||||
meta_index = math.floor(idx / 32)
|
||||
seq.move_to_meta(metadata_strips[meta_index])
|
||||
|
||||
# Set seq properties inside Metadata Strip.
|
||||
seq.channel = channel - ((meta_index) * 32)
|
||||
seq.frame_start = start_frame
|
||||
seq.blend_type = "ALPHA_OVER"
|
||||
|
||||
# Elongate all strips to the strip with the longest duration.
|
||||
tmp_sequences = sorted(sequences, key=lambda s: s.frame_final_end)
|
||||
tmp_sequences.insert(0, color_strip)
|
||||
max_end: int = tmp_sequences[-1].frame_final_end
|
||||
for strip in tmp_sequences:
|
||||
if strip.frame_final_end < max_end:
|
||||
strip.frame_final_end = max_end
|
||||
|
||||
# Clip the Metadata Strip frame end at max end and set alpha over.
|
||||
for strip in metadata_strips:
|
||||
strip.frame_start = start_frame
|
||||
strip.frame_final_end = max_end
|
||||
strip.blend_type = "ALPHA_OVER"
|
||||
|
||||
# Scene settings.
|
||||
# Change frame range and frame start.
|
||||
self.set_render_settings(context)
|
||||
self.set_output_path(context)
|
||||
self.set_sqe_area_settings(context)
|
||||
|
||||
# Create content list for grid.
|
||||
sqe_rects: List[SequenceRect] = [SequenceRect(seq) for seq in sequences]
|
||||
content: List[NestedRectangle] = [
|
||||
NestedRectangle(0, 0, srect.width, srect.height, child=srect)
|
||||
for srect in sqe_rects
|
||||
]
|
||||
|
||||
# Create grid.
|
||||
if context.scene.contactsheet.use_custom_rows:
|
||||
row_count = context.scene.contactsheet.rows
|
||||
|
||||
grid = Grid.from_content(
|
||||
0,
|
||||
0,
|
||||
context.scene.contactsheet.contactsheet_x,
|
||||
context.scene.contactsheet.contactsheet_y,
|
||||
content,
|
||||
row_count=row_count,
|
||||
)
|
||||
|
||||
grid.scale_content(addon_prefs.contactsheet_scale_factor)
|
||||
|
||||
return {"FINISHED"}
|
||||
|
||||
def set_sqe_area_settings(self, context: bpy.types.Context) -> None:
|
||||
sqe_editor = opsdata.get_sqe_editor(context)
|
||||
sqe_editor.spaces.active.proxy_render_size = "PROXY_25"
|
||||
sqe_editor.spaces.active.use_proxies = True
|
||||
|
||||
def set_render_settings(self, context: bpy.types.Context) -> None:
|
||||
opsdata.fit_frame_range_to_strips(context)
|
||||
context.scene.frame_current = context.scene.frame_start
|
||||
context.scene.render.resolution_x = context.scene.contactsheet.contactsheet_x
|
||||
context.scene.render.resolution_y = context.scene.contactsheet.contactsheet_y
|
||||
context.scene.render.image_settings.file_format = "PNG"
|
||||
context.scene.render.image_settings.color_mode = "RGB"
|
||||
context.scene.render.image_settings.color_depth = "8"
|
||||
context.scene.render.image_settings.compression = 15
|
||||
|
||||
def set_output_path(self, context: bpy.types.Context) -> None:
|
||||
addon_prefs = prefs.addon_prefs_get(context)
|
||||
cs_dir: Path = addon_prefs.contactsheet_dir_path
|
||||
output_path: str = ""
|
||||
|
||||
# File not saved and cs_dir not available.
|
||||
if not bpy.data.filepath and not cs_dir:
|
||||
logger.warning(
|
||||
"Failed to set output settings. Contactsheet Output Directory "
|
||||
"not defined in addon preferences and file not saved."
|
||||
)
|
||||
return
|
||||
|
||||
# File saved and cs_dir available.
|
||||
if cs_dir and bpy.data.filepath:
|
||||
output_path = cs_dir.joinpath(
|
||||
f"{Path(bpy.data.filepath).stem}_contactsheet.png"
|
||||
).as_posix()
|
||||
|
||||
# File not saved but cs_dir available.
|
||||
elif cs_dir:
|
||||
output_path = cs_dir.joinpath(f"contactsheet.png").as_posix()
|
||||
|
||||
# File saved but cs_dir not available.
|
||||
else:
|
||||
output_path = (
|
||||
Path(bpy.data.filepath)
|
||||
.parent.joinpath(f"{Path(bpy.data.filepath).stem}_contactsheet.png")
|
||||
.as_posix()
|
||||
)
|
||||
|
||||
# Set output path.
|
||||
context.scene.render.filepath = output_path
|
||||
|
||||
|
||||
class CS_OT_exit_contactsheet(bpy.types.Operator):
|
||||
bl_idname = "contactsheet.exit_contactsheet"
|
||||
bl_label = "Exit Contact Sheet"
|
||||
bl_description = (
|
||||
"Exits contactsheet scene, deletes it and "
|
||||
"return to original scene that was used to create the contactsheet"
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def poll(cls, context: bpy.types.Context) -> bool:
|
||||
return bool(context.scene.contactsheet.is_contactsheet)
|
||||
|
||||
def execute(self, context: bpy.types.Context) -> Set[str]:
|
||||
cs_scene = context.scene
|
||||
cs_scene_name = cs_scene.name
|
||||
|
||||
# Change active scene to orig scene.
|
||||
context.window.scene = context.scene.contactsheet.contactsheet_meta.scene
|
||||
|
||||
# Restore proxy settings from contactsheet.contactsheet_meta.
|
||||
sqe_editor = opsdata.get_sqe_editor(context)
|
||||
sqe_editor.spaces.active.proxy_render_size = (
|
||||
cs_scene.contactsheet.contactsheet_meta.proxy_render_size
|
||||
)
|
||||
sqe_editor.spaces.active.use_proxies = (
|
||||
cs_scene.contactsheet.contactsheet_meta.use_proxies
|
||||
)
|
||||
|
||||
# Remove contactsheet scene.
|
||||
bpy.data.scenes.remove(cs_scene)
|
||||
|
||||
self.report({"INFO"}, f"Exited and deleted scene: {cs_scene_name}")
|
||||
|
||||
return {"FINISHED"}
|
||||
|
||||
|
||||
# ----------------REGISTER--------------.
|
||||
|
||||
|
||||
classes = [
|
||||
CS_OT_make_contactsheet,
|
||||
CS_OT_exit_contactsheet,
|
||||
]
|
||||
|
||||
|
||||
def register():
|
||||
for cls in classes:
|
||||
bpy.utils.register_class(cls)
|
||||
|
||||
|
||||
def unregister():
|
||||
for cls in reversed(classes):
|
||||
bpy.utils.unregister_class(cls)
|
||||
@@ -0,0 +1,95 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from typing import Optional, List, Tuple
|
||||
|
||||
import bpy
|
||||
|
||||
from . import checksqe
|
||||
from .log import LoggerFactory
|
||||
|
||||
logger = LoggerFactory.getLogger(name=__name__)
|
||||
|
||||
|
||||
def get_valid_cs_sequences(
|
||||
sequence_list: List["bpy.types.Strip"],
|
||||
) -> List["bpy.types.Strip"]:
|
||||
"""
|
||||
Returns list of valid sequences out of input sequence list
|
||||
"""
|
||||
valid_sequences = [
|
||||
s for s in sequence_list if s.type in ["MOVIE", "IMAGE"] and not s.mute
|
||||
]
|
||||
return valid_sequences
|
||||
|
||||
|
||||
def get_sqe_editor(context: bpy.types.Context) -> Optional[bpy.types.Area]:
|
||||
sqe_editor = None
|
||||
|
||||
for area in context.screen.areas:
|
||||
if area.type == "SEQUENCE_EDITOR":
|
||||
sqe_editor = area
|
||||
|
||||
return sqe_editor
|
||||
|
||||
|
||||
def fit_frame_range_to_strips(
|
||||
context: bpy.types.Context, strips: Optional[List["bpy.types.Strip"]] = None
|
||||
) -> Tuple[int, int]:
|
||||
def get_sort_tuple(strip: "bpy.types.Strip") -> Tuple[int, int]:
|
||||
return (strip.frame_final_start, strip.frame_final_duration)
|
||||
|
||||
if not strips:
|
||||
strips = context.scene.sequence_editor.sequences_all
|
||||
|
||||
if not strips:
|
||||
return (0, 0)
|
||||
|
||||
strips = list(strips)
|
||||
strips.sort(key=get_sort_tuple)
|
||||
|
||||
context.scene.frame_start = strips[0].frame_final_start
|
||||
context.scene.frame_end = strips[-1].frame_final_end
|
||||
|
||||
return (context.scene.frame_start, context.scene.frame_end)
|
||||
|
||||
|
||||
def get_top_level_valid_strips_continuous(
|
||||
context: bpy.types.Context,
|
||||
) -> List["bpy.types.Strip"]:
|
||||
|
||||
sequences_tmp = get_valid_cs_sequences(
|
||||
list(context.scene.sequence_editor.sequences_all)
|
||||
)
|
||||
|
||||
sequences_tmp.sort(key=lambda s: (s.channel, s.frame_final_start), reverse=True)
|
||||
sequences: List["bpy.types.Strip"] = []
|
||||
|
||||
for strip in sequences_tmp:
|
||||
|
||||
occ_ranges = checksqe.get_occupied_ranges_for_strips(sequences)
|
||||
s_range = range(strip.frame_final_start, strip.frame_final_end + 1)
|
||||
|
||||
if not checksqe.is_range_occupied(s_range, occ_ranges):
|
||||
sequences.append(strip)
|
||||
|
||||
return sequences
|
||||
|
||||
|
||||
def poll_make_contactsheet(context: bpy.types.Context) -> bool:
|
||||
|
||||
if not context.scene.sequence_editor.sequences_all:
|
||||
return False
|
||||
|
||||
sequences = context.selected_sequences
|
||||
|
||||
if not sequences:
|
||||
valid_sequences = get_top_level_valid_strips_continuous(context)
|
||||
else:
|
||||
valid_sequences = get_valid_cs_sequences(sequences)
|
||||
|
||||
return bool(valid_sequences)
|
||||
|
||||
|
||||
# TODO: add function to actually get sequences, same structure in 3 places.
|
||||
@@ -0,0 +1,86 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
import os
|
||||
import bpy
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
import bpy
|
||||
|
||||
|
||||
def addon_prefs_get(context: bpy.types.Context) -> bpy.types.AddonPreferences:
|
||||
"""
|
||||
Shortcut to get addon preferences.
|
||||
"""
|
||||
if not context:
|
||||
context = bpy.context
|
||||
from . import __package__ as base_package
|
||||
if base_package.startswith('bl_ext'):
|
||||
# 4.2
|
||||
return context.preferences.addons[base_package].preferences
|
||||
else:
|
||||
return context.preferences.addons[base_package.split(".")[0]].preferences
|
||||
|
||||
|
||||
class CS_AddonPreferences(bpy.types.AddonPreferences):
|
||||
bl_idname = __package__
|
||||
|
||||
contactsheet_dir: bpy.props.StringProperty( # type: ignore
|
||||
name="Contactsheet Output Directory",
|
||||
description="The contactsheet scene will use this directory to compose the output filepath",
|
||||
default="",
|
||||
subtype="DIR_PATH",
|
||||
)
|
||||
|
||||
contactsheet_scale_factor: bpy.props.FloatProperty(
|
||||
name="Contactsheet Scale Factor",
|
||||
description="This value controls how much space there is between the individual cells of the contactsheet",
|
||||
min=0.1,
|
||||
max=1.0,
|
||||
step=5,
|
||||
default=0.9,
|
||||
)
|
||||
|
||||
def draw(self, context: bpy.types.Context) -> None:
|
||||
layout = self.layout
|
||||
box = layout.box()
|
||||
box.label(text="Filepaths", icon="FILEBROWSER")
|
||||
|
||||
# Contactsheet settings.
|
||||
box.row().prop(self, "contactsheet_dir")
|
||||
box.row().prop(self, "contactsheet_scale_factor")
|
||||
|
||||
@property
|
||||
def contactsheet_dir_path(self) -> Optional[Path]:
|
||||
if not self.is_contactsheet_dir_valid:
|
||||
return None
|
||||
return Path(os.path.abspath(bpy.path.abspath(self.contactsheet_dir)))
|
||||
|
||||
@property
|
||||
def is_contactsheet_dir_valid(self) -> bool:
|
||||
|
||||
# Check if file is saved.
|
||||
if not self.contactsheet_dir:
|
||||
return False
|
||||
|
||||
if not bpy.data.filepath and self.contactsheet_dir.startswith("//"):
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
# ---------REGISTER ----------.
|
||||
|
||||
classes = [CS_AddonPreferences]
|
||||
|
||||
|
||||
def register():
|
||||
for cls in classes:
|
||||
bpy.utils.register_class(cls)
|
||||
|
||||
|
||||
def unregister():
|
||||
for cls in reversed(classes):
|
||||
bpy.utils.unregister_class(cls)
|
||||
@@ -0,0 +1,72 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
import bpy
|
||||
|
||||
from .log import LoggerFactory
|
||||
|
||||
logger = LoggerFactory.getLogger(name=__name__)
|
||||
|
||||
|
||||
class CS_meta(bpy.types.PropertyGroup):
|
||||
scene: bpy.props.PointerProperty(type=bpy.types.Scene)
|
||||
use_proxies: bpy.props.BoolProperty()
|
||||
proxy_render_size: bpy.props.StringProperty(default="PROXY_100")
|
||||
|
||||
|
||||
class CS_property_group_scene(bpy.types.PropertyGroup):
|
||||
is_contactsheet: bpy.props.BoolProperty()
|
||||
|
||||
contactsheet_meta: bpy.props.PointerProperty(type=CS_meta)
|
||||
|
||||
rows: bpy.props.IntProperty(
|
||||
name="Rows",
|
||||
description="Controls how many rows should be used for the contactsheet",
|
||||
min=1,
|
||||
default=4,
|
||||
)
|
||||
|
||||
use_custom_rows: bpy.props.BoolProperty(
|
||||
name="Use custom amount of rows",
|
||||
description="Enables to overwrite the amount of rows for the contactsheet. Is otherwise calculated automatically",
|
||||
)
|
||||
|
||||
contactsheet_x: bpy.props.IntProperty(
|
||||
name="Resolution X",
|
||||
default=1920,
|
||||
min=100,
|
||||
description="X resolution of contactsheet",
|
||||
)
|
||||
contactsheet_y: bpy.props.IntProperty(
|
||||
name="Resolution Y",
|
||||
default=1080,
|
||||
min=100,
|
||||
description="Y resolution of contactsheet",
|
||||
)
|
||||
|
||||
|
||||
# ----------------REGISTER--------------.
|
||||
|
||||
classes = [
|
||||
CS_meta,
|
||||
CS_property_group_scene,
|
||||
]
|
||||
|
||||
|
||||
def register():
|
||||
|
||||
for cls in classes:
|
||||
bpy.utils.register_class(cls)
|
||||
|
||||
# Scene Properties.
|
||||
bpy.types.Scene.contactsheet = bpy.props.PointerProperty(
|
||||
name="Contactsheet",
|
||||
type=CS_property_group_scene,
|
||||
description="Metadata that is required for contactsheet",
|
||||
)
|
||||
|
||||
|
||||
def unregister():
|
||||
for cls in reversed(classes):
|
||||
bpy.utils.unregister_class(cls)
|
||||
@@ -0,0 +1,76 @@
|
||||
# SPDX-FileCopyrightText: 2021 Blender Studio Tools Authors
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
import bpy
|
||||
|
||||
from .ops import (
|
||||
CS_OT_make_contactsheet,
|
||||
CS_OT_exit_contactsheet,
|
||||
)
|
||||
from . import opsdata
|
||||
|
||||
|
||||
class CS_PT_contactsheet(bpy.types.Panel):
|
||||
""" """
|
||||
|
||||
bl_category = "Contactsheet"
|
||||
bl_label = "Contactsheet"
|
||||
bl_space_type = "SEQUENCE_EDITOR"
|
||||
bl_region_type = "UI"
|
||||
bl_order = 10
|
||||
|
||||
@classmethod
|
||||
def poll(cls, context: bpy.types.Context) -> bool:
|
||||
# Return opsdata.poll_make_contactsheet(context).
|
||||
return True
|
||||
|
||||
def draw(self, context: bpy.types.Context) -> None:
|
||||
layout = self.layout
|
||||
|
||||
# Handle case if scene is contactsheet.
|
||||
if context.scene.contactsheet.is_contactsheet:
|
||||
# Exit contact sheet.
|
||||
row = layout.row(align=True)
|
||||
row.operator(CS_OT_exit_contactsheet.bl_idname, icon="X")
|
||||
return
|
||||
|
||||
# Make contact sheet.
|
||||
row = layout.row(align=True)
|
||||
|
||||
sequences = context.selected_sequences
|
||||
if not sequences:
|
||||
valid_sequences = opsdata.get_top_level_valid_strips_continuous(context)
|
||||
else:
|
||||
valid_sequences = opsdata.get_valid_cs_sequences(sequences)
|
||||
|
||||
text = f"Make Contactsheet with {len(valid_sequences)} strips"
|
||||
|
||||
row.operator(CS_OT_make_contactsheet.bl_idname, icon="MESH_GRID", text=text)
|
||||
icon = "UNLOCKED" if context.scene.contactsheet.use_custom_rows else "LOCKED"
|
||||
row.prop(context.scene.contactsheet, "use_custom_rows", text="", icon=icon)
|
||||
|
||||
if context.scene.contactsheet.use_custom_rows:
|
||||
layout.row(align=True).prop(context.scene.contactsheet, "rows")
|
||||
|
||||
# Contact sheet resolution.
|
||||
row = layout.row(align=True)
|
||||
row.prop(context.scene.contactsheet, "contactsheet_x", text="X")
|
||||
row.prop(context.scene.contactsheet, "contactsheet_y", text="Y")
|
||||
|
||||
|
||||
# ----------------REGISTER--------------.
|
||||
|
||||
classes = [
|
||||
CS_PT_contactsheet,
|
||||
]
|
||||
|
||||
|
||||
def register():
|
||||
for cls in classes:
|
||||
bpy.utils.register_class(cls)
|
||||
|
||||
|
||||
def unregister():
|
||||
for cls in reversed(classes):
|
||||
bpy.utils.unregister_class(cls)
|
||||
Reference in New Issue
Block a user