commit 2973fd85d86e3dc76e337a0d7894428f727760f6 Author: Clement Ducarteron Date: Tue Mar 14 13:38:04 2023 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..98c602f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*pyc +__pycache__ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..308ffe3 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# VSE ToolBox + +In-House Video editing Tools + + + +**[Download latest](https://github.com/Pullusb/REPO_NAME/archive/master.zip)** + + + +--- + +## Description + +Quick usage description + +**tool action** : `SHORTCUT` + + +### Where ? + +Where is the stuff in UI or shortcut + diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..7283d56 --- /dev/null +++ b/__init__.py @@ -0,0 +1,55 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +bl_info = { + "name": "VSE ToolBox", + "description": "In-House Video editing Tools", + "author": "Samuel Bernou, Clement Ducarteron, Christophe Seux", + "version": (0, 1, 0), + "blender": (3, 4, 1), + "location": "Sequencer", + "warning": "", + "category": "Sequencer", +} + # "doc_url": "https://github.com/Pullusb/REPONAME", + # "tracker_url": "https://github.com/Pullusb/REPONAME/issues", + +import sys +from pathlib import Path +sys.modules['vse_toolbox'] = sys.modules.pop(Path(__file__).parent.name) + +from vse_toolbox import panels +from vse_toolbox import preferences +from vse_toolbox import properties +from vse_toolbox import operators + + +mods = ( + panels, + properties, + preferences, + operators, +) + +if 'bpy' in locals(): + import importlib + for mod in mods: + importlib.reload(mod) + +import bpy + +def register(): + if bpy.app.background: + return + + for mod in mods: + mod.register() + +def unregister(): + if bpy.app.background: + return + + for mod in reversed(mods): + mod.unregister() + +if __name__ == "__main__": + register() diff --git a/bl_utils.py b/bl_utils.py new file mode 100644 index 0000000..8f86fea --- /dev/null +++ b/bl_utils.py @@ -0,0 +1,45 @@ + +""" +Generic Blender functions +""" + +import bpy + +def get_settings(): + return bpy.context.window_manager.vsetb_settings + +def get_bl_cmd(blender=None, background=False, focus=True, blendfile=None, script=None, **kargs): + cmd = [str(blender)] if blender else [bpy.app.binary_path] + + if background: + cmd += ['--background'] + + if not focus and not background: + cmd += ['--no-window-focus'] + cmd += ['--window-geometry', '5000', '0', '10', '10'] + + cmd += ['--python-use-system-env'] + + if blendfile: + cmd += [str(blendfile)] + + if script: + cmd += ['--python', str(script)] + + if kargs: + cmd += ['--'] + for k, v in kargs.items(): + k = norm_arg(k) + v = norm_value(v) + + cmd += [k] + if isinstance(v, (tuple, list)): + cmd += v + else: + cmd += [v] + + return cmd + +def get_addon_prefs(): + addon_name = __package__.split('.')[0] + return bpy.context.preferences.addons[addon_name].preferences diff --git a/constants.py b/constants.py new file mode 100644 index 0000000..e95639e --- /dev/null +++ b/constants.py @@ -0,0 +1,10 @@ +import os +from pathlib import Path + +MODULE_DIR = Path(__file__).parent +TRACKERS_DIR = MODULE_DIR / 'resources' / 'trackers' +TRACKERS = [] +PROJECTS = [] +# TRACKER_URL = os.environ.get("TRACKER_URL", "") +# TRACKER_LOGIN = os.environ.get("TRACKER_LOGIN", "") +# TRACKER_PASSWORD = os.environ.get("TRACKER_PASSWORD", "") \ No newline at end of file diff --git a/file_utils.py b/file_utils.py new file mode 100644 index 0000000..820d988 --- /dev/null +++ b/file_utils.py @@ -0,0 +1,93 @@ +import importlib +import re +import subprocess +import sys +import unicodedata +from pathlib import Path + +def install_module(module_name, package_name=None): + '''Install a python module with pip or return it if already installed''' + try: + module = importlib.import_module(module_name) + except ModuleNotFoundError: + print(f'Installing Module {module_name} ....') + + subprocess.call([sys.executable, '-m', 'ensurepip']) + subprocess.call([sys.executable, '-m', 'pip', 'install', package_name or module_name]) + + module = importlib.import_module(module_name) + + return module + +def import_module_from_path(path): + from importlib import util + + try: + path = Path(path) + spec = util.spec_from_file_location(path.stem, str(path)) + mod = util.module_from_spec(spec) + + spec.loader.exec_module(mod) + + return mod + + except Exception as e: + print(f'Cannot import file {path}') + print(e) + +def norm_str(string, separator='_', format=str.lower, padding=0): + string = str(string) + string = string.replace('_', ' ') + string = string.replace('-', ' ') + string = re.sub('[ ]+', ' ', string) + string = re.sub('[ ]+\/[ ]+', '/', string) + string = string.strip() + + if format: + string = format(string) + + # Padd rightest number + string = re.sub(r'(\d+)(?!.*\d)', lambda x : x.group(1).zfill(padding), string) + + string = string.replace(' ', separator) + string = unicodedata.normalize('NFKD', string).encode('ASCII', 'ignore').decode("utf-8") + + return string + +def read_file(path): + '''Read a file with an extension in (json, yaml, yml, txt)''' + + exts = ('.json', '.yaml', '.yml', '.txt') + + if not path: + print('Try to read empty file') + + path = Path(path) + if not path.exists(): + print('File not exist', path) + return + + if path.suffix not in exts: + print(f'Cannot read file {path}, extension must be in {exts}') + return + + txt = path.read_text() + data = None + + if path.suffix.lower() in ('.yaml', '.yml'): + yaml = install_module('yaml') + try: + data = yaml.safe_load(txt) + except Exception: + print(f'Could not load yaml file {path}') + return + elif path.suffix.lower() == '.json': + try: + data = json.loads(txt) + except Exception: + print(f'Could not load json file {path}') + return + else: + data = txt + + return data \ No newline at end of file diff --git a/operators/__init__.py b/operators/__init__.py new file mode 100644 index 0000000..becfa5c --- /dev/null +++ b/operators/__init__.py @@ -0,0 +1,16 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +from vse_toolbox.operators import operators + +if 'bpy' in locals(): + import importlib + + importlib.reload(operators) + +import bpy + +def register(): + operators.register() + +def unregister(): + operators.unregister() \ No newline at end of file diff --git a/operators/operators.py b/operators/operators.py new file mode 100644 index 0000000..24cfeac --- /dev/null +++ b/operators/operators.py @@ -0,0 +1,307 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +import bpy +import importlib +import re +import vse_toolbox + +from bpy_extras.io_utils import ImportHelper +from bpy.props import ( + CollectionProperty, + BoolProperty, + EnumProperty, + IntProperty, + StringProperty, +) +from bpy.types import ( + Operator, +) +from pathlib import Path +from vse_toolbox.sequencer_utils import ( + get_shot_sequence, + get_strips, + import_edl, + rename_strips, + render_strips, + set_channels, +) +from vse_toolbox.bl_utils import get_addon_prefs, get_settings +from vse_toolbox.file_utils import install_module, norm_str + +class VSETB_OT_export_csv(Operator): + bl_idname = "sequencer.export_csv" + bl_label = "Set Scene" + bl_description = "Set Scene for Breakdown" + bl_options = {"REGISTER", "UNDO"} + + @classmethod + def poll(cls, context): + return True + + def execute(self, context): + self.report({'ERROR'}, f'Export not implemented yet.') + + return {"CANCELLED"} + + +class VSETB_OT_import(Operator): + bl_idname = "sequencer.import" + bl_label = "Set Scene" + bl_description = "Set Scene for Breakdown" + bl_options = {"REGISTER", "UNDO"} + + directory : StringProperty(subtype='DIR_PATH') + filepath: StringProperty( + name="File Path", + description="Filepath used for importing the file", + maxlen=1024, + subtype='FILE_PATH', + ) + files : CollectionProperty(type=bpy.types.OperatorFileListElement) + filter_glob: StringProperty( + default='*.edl;*.mov;*.wav', + options={'HIDDEN'} + ) + + @classmethod + def poll(cls, context): + return True + + def invoke(self, context, event): + context.window_manager.fileselect_add(self) + return {'RUNNING_MODAL'} + + def execute(self, context): + otio = install_module('opentimelineio') + for filepath in self.files: + filepath = Path(self.directory, filepath.name) + if filepath.suffix == '.edl': + edl = import_edl(filepath, adapter="cmx_3600") + print('edl: ', edl) + + return {"CANCELLED"} + + + +class VSETB_OT_load_projects(Operator): + bl_idname = "vse_toolbox.load_projects" + bl_label = "Load Projects" + bl_description = "Load Projects" + bl_options = {"REGISTER", "UNDO"} + + @classmethod + def poll(cls, context): + return True + + def execute(self, context): + settings = get_settings() + prefs = get_addon_prefs() + tracker = prefs.tracker + + settings.projects.clear() + tracker.connect() + + for project_data in tracker.get_projects(): + project = settings.projects.add() + project.name = project_data['name'] + project.id = project_data['id'] + + for episode_data in tracker.get_episodes(project_data): + episode = project.episodes.add() + episode.name = episode_data['name'] + episode.id = episode_data['id'] + + return {'FINISHED'} + + +class VSETB_OT_new_episode(Operator): + bl_idname = "vse_toolbox.new_episode" + bl_label = "New Epispde" + bl_description = "Add new Episode to Project" + bl_options = {"REGISTER", "UNDO"} + + episode_name : StringProperty(name="Episode Name", default="") + + @classmethod + def poll(cls, context): + return True + + def invoke(self, context, event): + scn = context.scene + settings = get_settings() + + return context.window_manager.invoke_props_dialog(self) + + def execute(self, context): + settings = get_settings() + prefs = get_addon_prefs() + tracker = prefs.tracker + + episode_name = settings.episode_template.format(index=int(self.episode_name)) + + print(self.episode_name) + print('episode_name: ', episode_name) + + episode = tracker.get_episode(episode_name) + if episode: + self.report({'ERROR'}, f'Episode {episode_name} already exists') + return {"CANCELLED"} + + tracker.new_episode(episode_name) + # tracker.get_episodes + tracker.update_project() + self.report({'INFO'}, f'Episode {episode_name} successfully created') + return {'FINISHED'} + + +class VSETB_OT_reload_addon(Operator): + bl_idname = "vse_toolbox.reload_addon" + bl_options = {"UNDO"} + bl_label = 'Reload VSE ToolBox Addon' + bl_description = 'Reload The VSE ToolBox Addon' + + def execute(self, context): + + print('Execute reload') + + vse_toolbox.unregister() + importlib.reload(vse_toolbox) + vse_toolbox.register() + + return {'FINISHED'} + + +class VSETB_OT_rename(Operator): + bl_idname = "sequencer.strips_rename" + bl_label = "Rename Strips" + bl_description = "Rename Strips" + bl_options = {"REGISTER", "UNDO"} + + template : StringProperty(name="Strip Template Name", default="") + increment : IntProperty(name="Name Increment", default=0) + channel_name : StringProperty(name="Channel Name", default="") + selected_only : BoolProperty(name="Selected Only", default=False) + start_number : IntProperty(name="Start Number", default=0, min=0) + by_sequence : BoolProperty( + name="Reset By Sequence", + description="Reset Start Number for each sequence", + default=False + ) + + @classmethod + def poll(cls, context): + return True + + def invoke(self, context, event): + scn = context.scene + settings = get_settings() + + return context.window_manager.invoke_props_dialog(self) + + def draw(self, context): + scn = context.scene + settings = get_settings() + + col = self.layout + col.use_property_split = True + col.prop(self, 'template') + col.prop(self, 'start_number') + if self.channel_name == 'Shots': + col.prop(self, 'by_sequence') + col.prop(self, 'selected_only') + + def execute(self, context): + scn = context.scene + strips = get_strips(channel=self.channel_name, selected_only=self.selected_only) + + rename_strips( + strips, self.template, + increment=self.increment, start_number=self.start_number, + by_sequence=self.by_sequence + ) + + return {"FINISHED"} + + +class VSETB_OT_render(Operator): + bl_idname = "sequencer.strips_render" + bl_label = "Render Shots Strips" + bl_description = "Render Shots Strips" + bl_options = {"REGISTER", "UNDO"} + + selected_only : BoolProperty(name="Selected Only", default=False) + + @classmethod + def poll(cls, context): + return True + + def invoke(self, context, event): + scn = context.scene + settings = get_settings() + + return context.window_manager.invoke_props_dialog(self) + + def draw(self, context): + scn = context.scene + settings = get_settings() + + col = self.layout + col.use_property_split = True + col.use_property_decorate = False + col.prop(settings, 'channels', text='Channel') + col.prop(self, 'selected_only') + + def execute(self, context): + scn = context.scene + strips = get_strips(channel=self.channel_name, selected_only=self.selected_only) + + render_strips(strips) + + return {"FINISHED"} + + +class VSETB_OT_set_scene(Operator): + bl_idname = "scene.set_scene" + bl_label = "Set Scene" + bl_description = "Set Scene for Breakdown" + bl_options = {"REGISTER", "UNDO"} + + @classmethod + def poll(cls, context): + return True + + def execute(self, context): + scn = context.scene + + set_channels() + movie = get_strips(channel='Movie') + if movie: + movie = movie[0] + movie.transform.scale_x = movie.transform.scale_y = 1 + elem = movie.strip_elem_from_frame(scn.frame_current) + scn.render.resolution_x = elem.orig_width + scn.render.resolution_y = elem.orig_height + else: + self.report({'INFO'}, f'Cannot set Resolution. No Movie Found.') + + return {"FINISHED"} + + +classes=( + VSETB_OT_export_csv, + VSETB_OT_import, + VSETB_OT_load_projects, + VSETB_OT_new_episode, + VSETB_OT_reload_addon, + VSETB_OT_rename, + VSETB_OT_render, + VSETB_OT_set_scene, +) + +def register(): + for cls in classes: + bpy.utils.register_class(cls) + +def unregister(): + for cls in reversed(classes): + bpy.utils.unregister_class(cls) \ No newline at end of file diff --git a/panels.py b/panels.py new file mode 100644 index 0000000..acab8fc --- /dev/null +++ b/panels.py @@ -0,0 +1,106 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +import bpy +from bpy.types import Panel +from vse_toolbox.bl_utils import get_addon_prefs, get_settings + +class VSETB_main: + bl_space_type = "SEQUENCE_EDITOR" + bl_region_type = "UI" + bl_category = "VSE ToolBox" + bl_label = "VSE ToolBox" + + +class VSETB_PT_main(VSETB_main, Panel): + + def draw_header(self, context): + layout = self.layout + row = layout.row() + row.operator('vse_toolbox.load_projects', icon='FILE_REFRESH', text='') + + def draw(self, context): + wm = context.window_manager + scn = context.scene + + settings = get_settings() + prefs = get_addon_prefs() + + project = settings.active_project + + layout = self.layout + col = layout.column() + row = col.row(align=True) + + row.operator('scene.set_scene', text='Set Scene', icon='SCENE_DATA') + row.prop(settings, 'toogle_prefs', text='', icon='PREFERENCES', toggle=True) + + if settings.toogle_prefs: + box = col.box() + box.use_property_split = True + box.use_property_decorate = False + + box.prop(settings, 'project_name', text='Projects') + + if project: + if project.episodes: + box.prop(project, 'episode_name', text='Episodes') + + box.prop(project, 'shot_template') + box.operator('vse_toolbox.new_episode', text='Add Episode', icon='IMPORT') + + # TODO FAIRE DES VRAIS OPS + row = col.row(align=True) + row.operator('sequencer.import', text='Import Edit', icon='IMPORT') + row.operator('sequencer.export_csv', text='Export', icon='EXPORT') + + op = col.operator('sequencer.strips_render', text='Render Strips', icon='RENDER_ANIMATION') + + +class VSETB_PT_rename(VSETB_main, Panel): + bl_label = "Rename Strips" + bl_parent_id = "VSETB_PT_main" + + def draw(self, context): + prefs = get_addon_prefs() + settings = get_settings() + project = settings.active_project + + if not project: + return + + episode = project.episode_name + + layout = self.layout + col = layout.column() + + col.use_property_split = True + + row = col.row() + shot_increment = project.shot_increment + shot_template = project.shot_template.format( + episode=episode, index=0 * shot_increment) + + row.separator() + + op = row.operator( + 'sequencer.strips_rename', text='Rename Shots', icon='SORTALPHA') + op.channel_name = 'Shots' + op.template = project.shot_template + op.increment = project.shot_increment + op.start_number = 10 + row.label(text=f'{shot_template}') + + +#-# REGISTER +classes=( + VSETB_PT_main, + VSETB_PT_rename, +) + +def register(): + for cls in classes: + bpy.utils.register_class(cls) + +def unregister(): + for cls in reversed(classes): + bpy.utils.unregister_class(cls) \ No newline at end of file diff --git a/preferences.py b/preferences.py new file mode 100644 index 0000000..815a102 --- /dev/null +++ b/preferences.py @@ -0,0 +1,135 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +import bpy +import inspect +import os + +from bpy.props import ( + BoolProperty, + EnumProperty, + FloatProperty, + IntProperty, + PointerProperty, + StringProperty, +) + +from bpy.types import ( + AddonPreferences, + PropertyGroup, +) +from vse_toolbox.bl_utils import get_addon_prefs, get_settings +from vse_toolbox.constants import ( + TRACKERS, + TRACKERS_DIR, +) +from vse_toolbox.file_utils import ( + import_module_from_path, + norm_str, + read_file, +) +from vse_toolbox.resources.trackers.kitsu import Kitsu + +def get_tracker_items(self, context): + return [(norm_str(a.name, format=str.upper), a.name, "", i) for i, a in enumerate(TRACKERS)] + +def load_trackers(): + from vse_toolbox.resources.trackers.tracker import Tracker + + TRACKERS.clear() + tracker_files = list(TRACKERS_DIR.glob('*.py')) + + for tracker_file in tracker_files: + if tracker_file.stem.startswith('_'): + continue + + mod = import_module_from_path(tracker_file) + for name, obj in inspect.getmembers(mod): + + if not inspect.isclass(obj): + continue + + if not Tracker in obj.__mro__: + continue + + if obj is Tracker or obj.name in (a.name for a in TRACKERS): + continue + + try: + print(f'Register Plugin {name}') + bpy.utils.register_class(obj) + setattr(Trackers, norm_str(obj.name), PointerProperty(type=obj)) + TRACKERS.append(obj) + except Exception as e: + print(f'Could not register library_type {name}') + print(e) + + +class Trackers(PropertyGroup): + def __iter__(self): + return (getattr(self, p) for p in self.bl_rna.properties.keys() if p not in ('rna_type', 'name')) + + +class VSETB_Prefs(AddonPreferences): + bl_idname = __package__ + + trackers : PointerProperty(type=Trackers) + expand_settings: BoolProperty(default=False) + + @property + def tracker(self): + return getattr(self.trackers, norm_str(get_settings().tracker_name)) + + def draw(self, context): + prefs = get_addon_prefs() + settings = get_settings() + + layout = self.layout + + col = layout.column(align=True) + box = col.box() + row = box.row(align=True) + icon = "DISCLOSURE_TRI_DOWN" if self.expand_settings else "DISCLOSURE_TRI_RIGHT" + row.prop(self, 'expand_settings', icon=icon, emboss=False, text='') + row.label(icon='PREFERENCES') + row.label(text='Settings') + subrow = row.row() + subrow.alignment = 'RIGHT' + subrow.operator("vse_toolbox.reload_addon", text='Reload Addon') + + if self.expand_settings: + box.prop(settings, 'tracker_name', text='Tracker') + self.tracker.draw_prefs(box) + + +classes=[ + Trackers, + VSETB_Prefs, +] + + +def register(): + for cls in classes: + bpy.utils.register_class(cls) + + load_trackers() + prefs = get_addon_prefs() + settings = get_settings() + + tracker_name = os.getenv('TRACKER_NAME') + + if tracker_name: + prefs['tracker_name'] = os.path.expandvars(norm_str(tracker_name, format=str.upper)) + tracker_prefs_file = os.getenv('TRACKER_PREFS') + + if tracker_prefs_file: + tracker_prefs = read_file(os.path.expandvars(tracker_prefs_file)) + tracker_data = tracker_prefs.get(norm_str(tracker_name), {}) + + for k, v in tracker_data.items(): + setattr(prefs.tracker, k, os.path.expandvars(v)) + +def unregister(): + for cls in reversed(classes + TRACKERS): + bpy.utils.unregister_class(cls) + + TRACKERS.clear() diff --git a/properties.py b/properties.py new file mode 100644 index 0000000..dade7e6 --- /dev/null +++ b/properties.py @@ -0,0 +1,138 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +import bpy +import os + +from bpy.props import ( + BoolProperty, + CollectionProperty, + EnumProperty, + IntProperty, + PointerProperty, + StringProperty, +) +from bpy.types import PropertyGroup +from pprint import pprint as pp +from vse_toolbox.bl_utils import get_addon_prefs, get_settings +from vse_toolbox.constants import TRACKERS +from vse_toolbox.file_utils import norm_str + +def get_episodes_items(self, context): + settings = get_settings() + + project = settings.active_project + if not project: + return [('NONE', 'None', '', 0)] + + episodes = project.episodes + if not episodes: + return [('NONE', 'None', '', 0)] + + return [(e, e, '', i) for i, e in enumerate(episodes.keys())] + +def get_project_items(self, context): + if not self.projects: + return [('NONE', 'None', '', 0)] + + return [(p, p, '', i) for i, p in enumerate(self.projects.keys())] + +def update_episodes(self, context): + settings = get_settings() + settings['episodes'] = 0 + +def get_tracker_items(self, context): + return [(norm_str(a.name, format=str.upper), a.name, "", i) for i, a in enumerate(TRACKERS)] + + +class Episode(PropertyGroup): + id : StringProperty(default='') + + @property + def active(self): + settings = get_settings() + return self.get(settings.project_name) + + +class Project(PropertyGroup): + id : StringProperty(default='') + + sequence_increment : IntProperty( + name="Sequence Increment", default=10, min=0, step=10) + + shot_increment : IntProperty( + name="Shot Increment", default=10, min=0, step=10) + + sequence_template : StringProperty( + name="Sequence Name", default="sq{index:03d}") + + episode_template : StringProperty( + name="Episode Name", default="e{index:03d}") + + shot_template : StringProperty( + name="Shot Name", default="{episode}_sh{index:04d}") + + episode_name : EnumProperty(items=get_episodes_items) + episodes : CollectionProperty(type=Episode) + +#FIXME Trouver une solution pour mettre des method dans les CollectionProperty +class Projects(PropertyGroup): + pass + # @property + # def active(self): + # settings = get_settings() + # return self.get(settings.project_name) + + +class VSETB_PGT_settings(PropertyGroup): + _projects = [] + + projects : CollectionProperty(type=Project) + project_name : EnumProperty(items=get_project_items, update=update_episodes) + tracker_name : EnumProperty(items=get_tracker_items) + toogle_prefs : BoolProperty(description='Toogle VSE ToolBox Preferences') + + channels : EnumProperty( + items=[ + ('AUDIO', 'Audio', '', 0), + ('MOVIE', 'Movie', '', 1), + ('SHOTS', 'Shots', '', 2), + ('SEQUENCES', 'Sequences', '', 3), + ] + ) + + sequence_channel_name : StringProperty( + name="Sequences Channel Name", default="Sequences") + + shot_channel_name : StringProperty( + name="Shot Channel Name", default="Shots") + + @property + def active_project(self): + settings = get_settings() + return settings.projects.get(settings.project_name) + + @property + def active_episode(self): + project = self.active_project + if project: + return project.episodes.get(project.episode_name) + +classes=( + Episode, + Project, + Projects, + VSETB_PGT_settings, +) + + +def register(): + for cls in classes: + bpy.utils.register_class(cls) + + bpy.types.WindowManager.vsetb_settings = PointerProperty(type=VSETB_PGT_settings) + +def unregister(): + for cls in reversed(classes): + bpy.utils.unregister_class(cls) + + del bpy.types.WindowManager.vsetb_settings diff --git a/resources/trackers/__init__.py b/resources/trackers/__init__.py new file mode 100644 index 0000000..ce88016 --- /dev/null +++ b/resources/trackers/__init__.py @@ -0,0 +1,11 @@ +from vse_toolbox.resources.trackers import tracker +from vse_toolbox.resources.trackers import kitsu + + +if 'bpy' in locals(): + import importlib + + importlib.reload(tracker) + importlib.reload(kitsu) + +import bpy \ No newline at end of file diff --git a/resources/trackers/kitsu.py b/resources/trackers/kitsu.py new file mode 100644 index 0000000..1994447 --- /dev/null +++ b/resources/trackers/kitsu.py @@ -0,0 +1,171 @@ + +import bpy +import os +import re +import urllib3 +import traceback +import time + +from bpy.props import PointerProperty, StringProperty +from pathlib import Path +from vse_toolbox.bl_utils import get_addon_prefs, get_settings +from vse_toolbox.file_utils import install_module, norm_str +from vse_toolbox.resources.trackers.tracker import Tracker + +gazu = install_module('gazu') + +class Kitsu(Tracker): + name = "Kitsu" + + url: StringProperty() + login: StringProperty() + password: StringProperty(subtype='PASSWORD') + + project_name = None + # episode_name = None + + def draw_prefs(self, layout): + layout.prop(self, 'url', text='Url') + layout.prop(self, 'login', text='Login') + layout.prop(self, 'password', text='Password') + + # @property + # def project(self): + # settings = get_settings() + + # return next( + # (p for p in settings._projects + # if norm_str(p['name']) == norm_str(settings.project_name)), {}) + + # @property + # def project_name(self): + # return self.project.get('name', '') + + # @property + # def all_episodes(self): + # return self.project.get('episodes', {}) + + # @property + # def episode_name(self): + # return self.episode.get('name', '') + + # @property + # def episode(self): + # settings = get_settings() + # return next( + # (e for e in self.project.get('episodes', {}) + # if norm_str(e['name']) == norm_str(settings.episode_template)), {}) + + def get_projects(self): + return gazu.project.all_open_projects() + + def get_episodes(self, project): + return gazu.shot.all_episodes_for_project(project) + + def get_episode(self, name): + return gazu.shot.get_episode_by_name(self.project, name) + + def new_episode(self, name): + return gazu.shot.new_episode(self.project, name) + + # def update_project(self): + # self.project['episode'] = tracker.get_episodes(p) + # return self.project + + def connect(self, url=None, login=None, password=None): + '''Connect to kitsu api using provided url, login and password''' + + urllib3.disable_warnings() + + if not self.url: + print(f'Kitsu Url: {self.url} is empty') + return + + url = self.url + if not url.endswith('/api'): + url += '/api' + + print(f'Info: Setting Host for kitsu {url}') + gazu.client.set_host(url) + + if not gazu.client.host_is_up(): + print('Error: Kitsu Host is down') + + try: + print(f'Info: Log in to kitsu as {self.login}') + res = gazu.log_in(self.login, self.password) + print(f'Info: Sucessfully login to Kitsu as {res["user"]["full_name"]}') + return res['user'] + except Exception as e: + print(f'Error: {traceback.format_exc()}') + + def get_asset_path(self, name, catalog, directory=None): + directory = directory or self.source_directory + return Path(directory, self.get_asset_relative_path(name, catalog)) + + def get_asset_info(self, data, asset_path): + modified = time.time_ns() + catalog = data['entity_type_name'].title() + asset_path = self.prop_rel_path(asset_path, 'source_directory') + + asset_info = dict( + filepath=asset_path, + modified=modified, + library_id=self.library.id, + assets=[dict( + catalog=catalog, + metadata=data.get('data', {}), + description=data['description'], + tags=[], + type=self.data_type, + name=data['name']) + ] + ) + + return asset_info + + def fetch(self): + """Gather in a list all assets found in the folder""" + print(f'Fetch Assets for {self.library.name}') + + self.connect() + + template_file = Template(self.template_file) + template_name = Template(self.template_name) + + project = gazu.client.fetch_first('projects', {'name': self.project_name}) + entity_types = gazu.client.fetch_all('entity-types') + entity_types_ids = {e['id']: e['name'] for e in entity_types} + + cache = self.read_cache() + + for asset_data in gazu.asset.all_assets_for_project(project): + asset_data['entity_type_name'] = entity_types_ids[asset_data.pop('entity_type_id')] + asset_name = asset_data['name'] + + asset_field_data = dict(asset_name=asset_name, type=asset_data['entity_type_name'], source_directory=self.source_directory) + + try: + asset_field_data.update(template_name.parse(asset_name)) + except Exception: + print(f'Warning: Could not parse {asset_name} with template {template_name}') + + asset_path = template_file.find(asset_field_data) + if not asset_path: + print(f'Warning: Could not find file for {template_file.format(asset_field_data)}') + continue + + + asset_path = self.prop_rel_path(asset_path, 'source_directory') + asset_cache_data = dict( + catalog=asset_data['entity_type_name'].title(), + metadata=asset_data.get('data', {}), + description=asset_data['description'], + tags=[], + type=self.data_type, + name=asset_data['name'] + ) + + cache.add_asset_cache(asset_cache_data, filepath=asset_path) + + return cache \ No newline at end of file diff --git a/resources/trackers/tracker.py b/resources/trackers/tracker.py new file mode 100644 index 0000000..4334387 --- /dev/null +++ b/resources/trackers/tracker.py @@ -0,0 +1,4 @@ +from bpy.types import PropertyGroup + +class Tracker(PropertyGroup): + pass \ No newline at end of file diff --git a/sequencer_utils.py b/sequencer_utils.py new file mode 100644 index 0000000..fa2f60f --- /dev/null +++ b/sequencer_utils.py @@ -0,0 +1,132 @@ +# SPDX-License-Identifier: GPL-2.0-or-later + +import bpy +import re + +from pathlib import Path +from vse_toolbox.bl_utils import get_settings + +def get_strips(channel=0, selected_only=False): + scn = bpy.context.scene + + if isinstance(channel, str): + channel = scn.sequence_editor.channels.keys().index(channel) + + strips = [s for s in scn.sequence_editor.sequences_all if s.channel==channel] + + if selected_only: + strips = [s for s in strips if s.select] + + return sorted(strips, key=lambda x : x.frame_final_start) + +def get_shot_sequence(shot): + sequences = get_strips(channel='Sequences') + return next((s.name for s in sequences if s.frame_final_start<=shot.frame_final_start {name}') + strip.name = name + + previous_sequence = sequence + strip_number += 1 + +def set_channels(): + scn = bpy.context.scene + settings = get_settings() + items = settings.rna_type.bl_rna.properties['channels'].enum_items + + for i, c in enumerate(items.keys(), start=1): + scn.sequence_editor.channels[i].name = c.title() + +def render_strips(strips): + for strip in strips: + print(strip.name) + +def import_edl(filepath, adapter="cmx_3600"): + import opentimelineio as otio + scn = bpy.context.scene + + sequences = scn.sequence_editor.sequences + + edl = Path(filepath) + + try: + timeline = otio.adapters.read_from_file( + str(edl), adapter, rate=scn.render.fps, ignore_timecode_mismatch=True) + except: + data = edl.read_text(encoding='latin-1') + timeline = otio.adapters.read_from_string( + data, adapter, rate=scn.render.fps, ignore_timecode_mismatch=True) + + scn.frame_start = ( + 0 if timeline.global_start_time is None else timeline.global_start_time + ) + scn.frame_end = otio.opentime.to_frames(timeline.duration()) - 1 + + for i, track in enumerate(timeline.tracks, 1): + for child in track.each_child(shallow_search=False): + frame_start = otio.opentime.to_frames( + child.range_in_parent().start_time) + + frame_end = otio.opentime.to_frames( + child.range_in_parent().duration) - 1 + try: + strip = sequences.new_effect( + name='', + type='COLOR', + channel=i, + frame_start=frame_start, + frame_end=frame_end, + ) + except Exception as e: + print('e: ', e) + continue + + """ + t = otio.adapters.read_from_file(edl, rate=C.scene.render.fps) + t.video_tracks() # Video Tracks du fichiers. C'est une liste. + Parcourir toutes les video_tracks ? + Trouver comment fait Felix David + """ + print('timeline: ', timeline) + + return timeline + +""" +def create_strip_effect(name, strip_type, channel, frame_start, frame_end): + strip = scn.sequence_editor.sequences.new_effect( + name=name, + type=strip_type, + channel=channel, + frame_start=frame_start, + frame_end=frame_end, + ) + + return strip +""" \ No newline at end of file