├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── figures ├── example.png ├── keyboard-shortcuts.png ├── layers.png └── starting-layers.png ├── onion_layers.py ├── template-1080p.xcf ├── template-720p.xcf └── tests.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | README.html 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | #GIMP_PLUGIN_DIR?=$(HOME)/.gimp-2.8/plugins 2 | GIMP_PLUGIN_DIR?=$(HOME)/.config/GIMP/2.10/plug-ins 3 | 4 | all: 5 | 6 | install: 7 | install -m755 onion_layers.py $(GIMP_PLUGIN_DIR) 8 | 9 | test: 10 | python2.7 tests.py 11 | 12 | .PHONY: all install test 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GIMP onion layers plug-in 2 | 3 | Onion layers is a plug-in for the [GIMP](https://www.gimp.org/) drawing 4 | program. It provides some convenient shortcuts for moving up and down the stack 5 | of frames when making hand-drawn animations, as well as some other useful 6 | functions. It's based on the concept called *onion layering*, where the frame 7 | you are currently working on is overlaid with the previous and next frames to 8 | aid in drawing. 9 | 10 | ![](figures/example.png) 11 | 12 | Currently it provides the following functions that can be assigned to keyboard 13 | shortcuts: 14 | 15 | * Switch to next/previous frame, optionally showing some neighboring frames. 16 | * Cycle through showing no neighboring frames, only next frame, only previous 17 | frame, or both next and previous frames. 18 | * Show all frames will full opacity. 19 | 20 | Some other useful functions when drawing animations where each frame consists 21 | of multiple layers are also included: 22 | 23 | * Copy a layer to all frames. 24 | * Add a new frame, taking the layers in the current one as a template. 25 | 26 | 27 | ## Installation 28 | 29 | To install the plug-in, copy the `onion_layers.py` file to your plug-in 30 | directory. This might be `[your home folder]/.gimp-[GIMP version]/plug-ins` or 31 | `[your home folder]/.config/GIMP/[GIMP version]/plug-ins`. Check "Edit -> 32 | Preferences -> Folders -> Plug-ins" if you're not sure. 33 | 34 | If you have GIMP 2.10 on Linux, running `make install` should do the right 35 | thing. The plug-in will likely not work on Windows as-is (patches would be welcome) 36 | 37 | The plug-in was developed for GIMP 2.10.8 and Python 2.7.16. It was known to 38 | work on 2.8 in the past. It might also work with older or newer versions of 39 | GIMP - feedback regarding that is welcome. 40 | 41 | 42 | ## Usage 43 | 44 | Functions provided by the plug-in can be found in the GIMP menu under "Filters 45 | -> Animation -> Onion layers". 46 | 47 | You want to assign keyboard shortcuts to them however. Go to "Edit -> Keyboard 48 | Shortcuts" and search for "onion". A good choice of shortcuts for previous/next 49 | frame functions are period and comma keys on a US keyboard. They shouldn't 50 | conflict with other GIMP shortcuts and match the frame skip shortcuts on some 51 | video players. 52 | 53 | Following shows the list of available functions as well as a suggestion on what 54 | keys to assign to them: 55 | 56 | ![](figures/keyboard-shortcuts.png) 57 | 58 | The plug-in assumes that each top-level layer or layer group represents one 59 | animation frame. You should have layers named consistently: top-level groups 60 | named "frame0000", "frame0100", etc. and then layers inside named using the same 61 | pattern. 62 | 63 | The layer on top of the stack is the *last* layer (same ordering is used for 64 | animated GIF functions that are built into GIMP). Hence frame numbers are 65 | typically shown in falling order in GIMP's Layers dialog. 66 | 67 | If you have background layers that are common to all frames, you can put 68 | [brackets] around their names and they will be ignored by this plug-in. This is 69 | consistent with how the [Export 70 | Layers](https://github.com/khalim19/gimp-plugin-export-layers) used to handle 71 | background layers. 72 | 73 | A good start is the setup shown below. You can also find some useful templates 74 | in the `template-720p.xcf` and `template-1080p.xcf` files included in the 75 | repository: 76 | 77 | ![](figures/starting-layers.png) 78 | 79 | "[bg]" contains the background, "frame0000" is the layer group representing 80 | the first frame of the animation and "sketch0000" is the first layer in that 81 | frame. Draw something on "sketch0000" and then add a new frame by presssing "C" 82 | (`python-fu-onion-add-frame`). This should add "frame0100" and "sketch0100". 83 | 84 | By numbering frames with 100, 200, 300, ... instead of 1, 2, 3, ... you can 85 | later insert inbetween frames without renaming all your key frames. This might 86 | help you if you've already inserted your keyframes into some video editing 87 | software. 88 | 89 | A file with more layers per frame may look like this. Each frame has an 90 | outline, a shading and a color layer: 91 | 92 | ![](figures/layers.png) 93 | 94 | 95 | ### Onion layer up/down functions 96 | 97 | The `python-fu-onion-down-ctx-auto-tint` and `python-fu-onion-up-ctx-auto-tint` 98 | functions change the visibility and opacity of top-level layers or groups one 99 | step up or down. 100 | 101 | The currently active frame will be given full opacity, frames one step above 102 | and below in the stack (if shown) will be given 25% opacity. They will also be 103 | slightly tinted green (next) and purple (previous). Other layers will be hidden. 104 | 105 | The active layer (the layer where the drawing tools have effect) will be 106 | changed accordingly as well, if you are using the recommended layer naming scheme. 107 | 108 | The tinting of layers is done by adding two layers to your image 109 | ("onion-tint-before", "onion-tint-after"). If you find that this makes GIMP too 110 | slow or you don't like tinting, you can use the identical functions without the 111 | "-tint" in their names. 112 | 113 | The `python-fu-onion-up` and `python-fu-onion-down` functions work in the same 114 | way, except that they force the neighboring frames not to be shown. This is 115 | sometimes useful to quickly reduce clutter. 116 | 117 | 118 | ### Selecting neighboring layer visibility 119 | 120 | The `python-fu-onion-cycle-ctx-tint` function will cycle through the four possible 121 | settings for the visibility of neighboring frames: 122 | 123 | * No neighboring frames shown, 124 | * both previous and next frames shown, 125 | * only next frame shown and 126 | * only previous frame shown. 127 | 128 | Display of neighboring frames gives best results when working on black outlines 129 | on transparent background. If you have frames colored-in, it's best to not show 130 | neighboring frames. 131 | 132 | The `python-fu-onion-cycle-ctx` function does the same thing, except it does 133 | not use tinting layers. 134 | 135 | 136 | ### Preparing frames for export 137 | 138 | The `python-fu-onion-show-all` can be used to reset the visibility and opacity 139 | of all layers. This is useful before exporting the layers using *Export 140 | Layers*, since otherwise some frames might get exported with reduced opacity. 141 | 142 | This function also cleans up the tinting layers. 143 | 144 | 145 | ### Other useful things 146 | 147 | `python-fu-onion-copy-layer` will copy currently active layer to all frames. It 148 | will rename the copies to keep the correct naming scheme. 149 | 150 | If a layer with such a name already exists in a frame, it will only copy over 151 | opacity and visibility. Hence this function is useful both to add a layer to 152 | all frames as well as quickly show or hide a layer in all frames. 153 | 154 | `python-fu-onion-add-frame` will add a new frame above (i.e. appearing after) 155 | the currently active one. The new frame will have a number between the two 156 | existing frames. It will also create blank layers inside the new group, taking 157 | the current frame as a template. 158 | 159 | If there is no space for a new number (i.e. frames already have consecutive 160 | numbers) it will refuse to do anything. You can renumber frames using 161 | `python-fu-onion-renumber-frames` to fix this. 162 | 163 | `python-fu-onion-copy-layer` and `python-fu-onion-add-frame` only work when 164 | frames are layer groups, not single frames. 165 | 166 | `python-fu-onion-convert-to-groups` will convert any top-level, non-background, 167 | bare layers into groups. This is useful after importing individual frames into 168 | GIMP using "File -> Open as Layers..." 169 | 170 | `python-fu-onion-enable-frame` and `python-fu-onion-disable-frame` will make 171 | the current frame a background layer and vice-versa. This is useful for quickly 172 | removing and re-adding frames from and to the onion stack. 173 | 174 | `python-fu-onion-renumber-frames` will renumber all your layers. Use this if 175 | you've run out of numbers for inbetweens. 176 | 177 | ## Known problems 178 | 179 | If `-up` and `-down` functions don't do anything, make sure that you have at 180 | least one top-level layer or group visible and at 100% opacity. 181 | 182 | Changing layer visibility and opacity clutters the undo history. Unfortunately 183 | there is no way for a plug-in to manipulate the undo history. The code makes 184 | sure to do its thing with as few undo steps as possible, but fundamentally this 185 | is a limitation of the GIMP plug-in interface. 186 | 187 | ## License 188 | 189 | GIMP onion layers plug-in is Copyright (C) 2022 Tomaž Šolc tomaz.solc@tablix.org 190 | 191 | This program is free software: you can redistribute it and/or modify it under 192 | the terms of the GNU General Public License as published by the Free Software 193 | Foundation, either version 3 of the License, or (at your option) any later 194 | version. 195 | 196 | This program is distributed in the hope that it will be useful, but WITHOUT ANY 197 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 198 | PARTICULAR PURPOSE. See the GNU General Public License for more details. 199 | 200 | You should have received a copy of the GNU General Public License along with 201 | this program. If not, see http://www.gnu.org/licenses/ 202 | -------------------------------------------------------------------------------- /figures/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/avian2/gimp-plugin-onion-layers/e1f2152688defcc76116fce3a5b94a28d9f02043/figures/example.png -------------------------------------------------------------------------------- /figures/keyboard-shortcuts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/avian2/gimp-plugin-onion-layers/e1f2152688defcc76116fce3a5b94a28d9f02043/figures/keyboard-shortcuts.png -------------------------------------------------------------------------------- /figures/layers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/avian2/gimp-plugin-onion-layers/e1f2152688defcc76116fce3a5b94a28d9f02043/figures/layers.png -------------------------------------------------------------------------------- /figures/starting-layers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/avian2/gimp-plugin-onion-layers/e1f2152688defcc76116fce3a5b94a28d9f02043/figures/starting-layers.png -------------------------------------------------------------------------------- /onion_layers.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import re 3 | import fcntl 4 | from contextlib import contextmanager 5 | import os 6 | 7 | NEXT_PREV_OPACITY = 25. 8 | 9 | DEFAULT_CONTEXTS = [ 10 | [ None, 100., None ], 11 | [ NEXT_PREV_OPACITY, 100., NEXT_PREV_OPACITY ], 12 | [ None, 100., NEXT_PREV_OPACITY ], 13 | [ NEXT_PREV_OPACITY, 100., None ], 14 | ] 15 | 16 | # This is a bit ugly, but if you press keyboard shortcuts faster than the 17 | # functions execute, you end up with two instances running in parallel. This 18 | # leads to annoying pop-ups with "Plug-In 'up, auto, tint' left image undo in 19 | # inconsistent state, closing open undo groups.". 20 | # 21 | # We can't use the usual threading.Lock since each function call runs in a 22 | # separate interpreter process that is forked by GIMP. 23 | # 24 | # So we do our own file locking here with fcntl. This bit is the only thing 25 | # that is incompatible with Windows, so if you're looking to fix that, replace 26 | # flocked() with a similar mechanism that works there and submit a pull 27 | # request. 28 | 29 | LOCK_DIR = os.environ.get('XDG_CACHE_HOME', os.path.join(os.environ['HOME'], '.cache')) 30 | LOCK_FILE = os.path.join(LOCK_DIR, 'gimp-plugin-onion-layers-lock') 31 | 32 | @contextmanager 33 | def flocked(): 34 | with open(LOCK_FILE, "w") as fd: 35 | try: 36 | fcntl.flock(fd, fcntl.LOCK_EX) 37 | yield 38 | finally: 39 | fcntl.flock(fd, fcntl.LOCK_UN) 40 | 41 | # see gimpshelf for persistent storage 42 | 43 | class Frame(object): 44 | TINT_COLORS = { 45 | 'before': (100, 48, 135), 46 | 'after': (83, 135, 48), 47 | } 48 | 49 | TINT_PREFIX = "onion-tint-" 50 | 51 | def __init__(self, layer): 52 | self.layer = layer 53 | self.opacity = None 54 | self.visible = None 55 | self.tint = None 56 | 57 | def apply(self, img): 58 | # we do it this way to prevent unnecessarily cluttering the undo history. 59 | # 60 | # AFIAK there is not way to manipulate the history from a plug-in. 61 | 62 | if (self.opacity is not None) and (self.layer.opacity != self.opacity): 63 | self.layer.opacity = self.opacity 64 | 65 | if (self.visible is not None) and (self.layer.visible != self.visible): 66 | self.layer.visible = self.visible 67 | 68 | # Comment this out if you don't like layer tinting 69 | self._apply_tint(img) 70 | 71 | @classmethod 72 | def clear_tints(cls, img): 73 | for tint in cls.TINT_COLORS.keys(): 74 | tint_layer = pdb.gimp_image_get_layer_by_name(img, cls.TINT_PREFIX + tint) 75 | if tint_layer is not None: 76 | tint_layer.visible = False 77 | 78 | def _create_tint_layer(self, img, name, color): 79 | # Note: tint layer must be RGBA to preseve alpha for underlying layers. 80 | # layer mode: addition 81 | tint_layer = pdb.gimp_layer_new(img, img.width, img.height, 1, name, 100, 7) 82 | pdb.gimp_image_insert_layer(img, tint_layer, self.layer, 0) 83 | c = pdb.gimp_context_get_foreground() 84 | pdb.gimp_context_set_foreground(color) 85 | pdb.gimp_edit_fill(tint_layer, 0) 86 | pdb.gimp_context_set_foreground(c) 87 | 88 | def _apply_tint(self, img): 89 | if not hasattr(self.layer, 'layers'): 90 | return 91 | 92 | if self.tint is None: 93 | return 94 | elif self.tint == "clean": 95 | # This will actually remove the tint layer compared to 96 | # just making it invisible. We use this when we want a 97 | # clean image. 98 | for layer in self.layer.layers: 99 | if self.TINT_PREFIX in layer.name: 100 | pdb.gimp_image_remove_layer(img, layer) 101 | else: 102 | tint_layer = pdb.gimp_image_get_layer_by_name(img, self.TINT_PREFIX + self.tint) 103 | 104 | if tint_layer is not None: 105 | # If a tint layer already exists somewhere in the image, we just 106 | # move it here. It's much faster than creating a new layer from scratch 107 | # and we only ever need two tint layers to exist simultaneously. 108 | pdb.gimp_image_reorder_item(img, tint_layer, self.layer, 0) 109 | tint_layer.visible = True 110 | else: 111 | self._create_tint_layer(img, self.TINT_PREFIX + self.tint, 112 | self.TINT_COLORS[self.tint]) 113 | 114 | def get_frames(img): 115 | for layer in img.layers: 116 | if layer.name.startswith('['): 117 | continue 118 | 119 | yield Frame(layer) 120 | 121 | class NumberedName(object): 122 | def __init__(self, name, num=None, width=None, is_mask=False): 123 | self.name = name 124 | self.num = num 125 | self.width = width 126 | self.is_mask = is_mask 127 | 128 | @classmethod 129 | def from_layer_name(cls, name): 130 | # if layer mask is active when a function is invoked, 131 | # the active layer name has " mask" appended. 132 | name_nomask = re.sub(r' mask$', '', name) 133 | 134 | is_mask = (name_nomask != name) 135 | 136 | g = re.search(r'(\d+)$', name_nomask) 137 | if g: 138 | num = int(g.group(1)) 139 | width = len(g.group(1)) 140 | else: 141 | num = None 142 | width = None 143 | 144 | name_nonum = re.sub(r'\d+$', '', name_nomask) 145 | 146 | return cls(name_nonum, num, width, is_mask) 147 | 148 | def get_new_frame_increment(self): 149 | if self.width >= 4: 150 | return 100 151 | elif self.width == 3: 152 | return 10 153 | else: 154 | return 1 155 | 156 | def to_string(self): 157 | if self.num is None: 158 | return self.name 159 | else: 160 | fmt = "%s%0" + str(self.width) + "d" 161 | return fmt % (self.name, self.num) 162 | 163 | def __repr__(self): 164 | return "NumberedName(name=%r, num=%r, width=%r, is_mask=%r)" % ( 165 | self.name, self.num, self.width, self.is_mask) 166 | 167 | class Context(object): 168 | SIZE = 1 169 | 170 | # context is an array of size (SIZE*2 + 1) that 171 | # stores opacity of SIZE frames in front of the 172 | # current frame and SIZE frames in back. 173 | # 174 | # visible index is the index of the current frame. 175 | def __init__(self, context, current_index): 176 | self.context = context 177 | self.current_index = current_index 178 | 179 | @classmethod 180 | def from_frames(cls, frames): 181 | N = len(frames) 182 | assert N > 0 183 | 184 | # Find the currently visible frame. 185 | i = None 186 | for j, frame in enumerate(frames): 187 | if frame.layer.visible and (frame.layer.opacity == 100.): 188 | i = j 189 | 190 | # If no visible frame was found, show first frame. 191 | if i is None: 192 | i = 0 193 | 194 | # Find which neighboring frames are also currently visible - 195 | # this is our desired context. 196 | 197 | context = [ None ] * (cls.SIZE*2 + 1) 198 | for c in range(-cls.SIZE, cls.SIZE + 1): 199 | # index into context 200 | j = c + cls.SIZE 201 | # frame 202 | k = (i + c) % N 203 | 204 | if frames[k].layer.visible: 205 | opacity = frames[k].layer.opacity 206 | # Since we're detecting the current frame 207 | # based on 100% opacity, it doesn't make 208 | # sense that any context frames would have 209 | # 100% opacity as well. 210 | # 211 | # This typically happens when you do 212 | # "up-ctx-auto" after "show-all" 213 | if (c != 0) and (opacity >= 99.): 214 | opacity = 99. 215 | 216 | context[j] = opacity 217 | 218 | return cls(context, i) 219 | 220 | def get_middle_number(a, b): 221 | c = (a + b) // 2 222 | if c == a or c == b: 223 | raise ValueError 224 | else: 225 | return c 226 | 227 | def sanitize_name(name): 228 | return NumberedName.from_layer_name(name).name 229 | 230 | def show_all(img, act_layer): 231 | img.undo_group_start() 232 | 233 | for frame in get_frames(img): 234 | frame.opacity = 100. 235 | frame.visible = True 236 | frame.tint = "clean" 237 | frame.apply(img) 238 | 239 | img.undo_group_end() 240 | 241 | def onion(*args, **kwargs): 242 | with flocked(): 243 | return onion_unsafe(*args, **kwargs) 244 | 245 | def onion_unsafe(img, act_layer, inc, contextobj=None, dryrun=False, do_tint=False): 246 | 247 | # Frames are either top-level layers or layer groups. 248 | frames = list(get_frames(img)) 249 | 250 | # If no frames were found, do nothing. 251 | N = len(frames) 252 | if N < 1: 253 | return 254 | 255 | if contextobj is None: 256 | contextobj = Context.from_frames(frames) 257 | 258 | if not dryrun: 259 | context = contextobj.context 260 | i = contextobj.current_index 261 | 262 | # Select the next or previous frame. 263 | i = (i + inc) % N 264 | contextobj.current_index = i 265 | 266 | # Change visibility of frames. 267 | for frame in frames: 268 | frame.visible = False 269 | 270 | assert (len(context) % 2) == 1 271 | 272 | # index into context 273 | for j in range(len(context)): 274 | # context offset 275 | c = j - (len(context) - 1) // 2 276 | # frame 277 | k = (i + c) % N 278 | 279 | if (context[j] is not None) and (k != i) and not frames[k].visible: 280 | frames[k].opacity = context[j] 281 | frames[k].visible = True 282 | 283 | if do_tint: 284 | if c < 0: 285 | frames[k].tint = "after" 286 | else: 287 | frames[k].tint = "before" 288 | 289 | frames[i].opacity = 100. 290 | frames[i].visible = True 291 | frames[i].tint = None 292 | 293 | img.undo_group_start() 294 | 295 | Frame.clear_tints(img) 296 | for frame in frames: 297 | frame.apply(img) 298 | 299 | img.undo_group_end() 300 | 301 | # Use some heuristic to change the active layer as well. 302 | if hasattr(frames[i].layer, 'layers'): 303 | n = sanitize_name(act_layer.name) 304 | 305 | for layer in frames[i].layer.layers: 306 | if sanitize_name(layer.name) == n: 307 | img.active_layer = layer 308 | if layer.mask is not None: 309 | layer.edit_mask = False 310 | break 311 | else: 312 | img.active_layer = frames[i].layer 313 | 314 | return contextobj 315 | 316 | def onion_up(img, layer): 317 | onion(img, layer, -1, [100.]) 318 | 319 | def onion_down(img, layer): 320 | onion(img, layer, 1, [100.]) 321 | 322 | def onion_up_ctx(img, layer): 323 | onion(img, layer, -1, [NEXT_PREV_OPACITY, 100., NEXT_PREV_OPACITY]) 324 | 325 | def onion_down_ctx(img, layer): 326 | onion(img, layer, 1, [NEXT_PREV_OPACITY, 100., NEXT_PREV_OPACITY]) 327 | 328 | def onion_up_ctx_auto(img, layer): 329 | onion(img, layer, -1, None) 330 | 331 | def onion_down_ctx_auto(img, layer): 332 | onion(img, layer, 1, None) 333 | 334 | def onion_up_ctx_auto_tint(img, layer): 335 | onion(img, layer, -1, None, do_tint=True) 336 | 337 | def onion_down_ctx_auto_tint(img, layer): 338 | onion(img, layer, 1, None, do_tint=True) 339 | 340 | def cycle_context(img, layer, do_tint=False): 341 | 342 | contextobj = onion(img, layer, 0, dryrun=True) 343 | 344 | try: 345 | current_default = DEFAULT_CONTEXTS.index(contextobj.context) 346 | except ValueError: 347 | current_default = -1 348 | 349 | current_default = (current_default + 1) % len(DEFAULT_CONTEXTS) 350 | 351 | contextobj.context = DEFAULT_CONTEXTS[current_default] 352 | 353 | onion(img, layer, 0, contextobj, do_tint=do_tint) 354 | 355 | def onion_cycle_context(img, layer): 356 | cycle_context(img, layer, do_tint=False) 357 | 358 | def onion_cycle_context_tint(img, layer): 359 | cycle_context(img, layer, do_tint=True) 360 | 361 | def onion_copy_layer(img, act_layer): 362 | frames = list(get_frames(img)) 363 | 364 | # If no frames were found, do nothing. 365 | N = len(frames) 366 | if N < 1: 367 | return 368 | 369 | # Find the location of the layer to copy in the current frame. 370 | act_loc = -1 371 | for frame in frames: 372 | if not hasattr(frame.layer, 'layers'): 373 | continue 374 | 375 | for i, layer in enumerate(frame.layer.layers): 376 | if layer.name == act_layer.name: 377 | act_loc = i 378 | break 379 | 380 | if act_loc != -1: 381 | break 382 | 383 | act_name = sanitize_name(act_layer.name) 384 | 385 | img.undo_group_start() 386 | 387 | for frame in frames: 388 | 389 | # If the frame is not a layer group, do nothing 390 | if not hasattr(frame.layer, 'layers'): 391 | continue 392 | 393 | for layer in frame.layer.layers: 394 | if sanitize_name(layer.name) == act_name: 395 | # This frame already has a copy. Just copy over 396 | # visibility and opacity. 397 | layer.visible = act_layer.visible 398 | layer.opacity = act_layer.opacity 399 | break 400 | else: 401 | # This frame doesn't have a copy. Make one. 402 | layer = act_layer.copy() 403 | 404 | # Copy over frame number 405 | g = re.search(r'(\d+)$', frame.layer.name) 406 | if g is not None: 407 | layer.name = sanitize_name(act_layer.name) + g.group(1) 408 | 409 | # If this frame has a tint layer, we should ignore it 410 | # when adding the new layer. Otherwise, the location 411 | # in the stack will be wrong. 412 | for i, layer2 in enumerate(frame.layer.layers): 413 | if frame.TINT_PREFIX in layer2.name: 414 | tint_loc = i 415 | break 416 | else: 417 | tint_loc = None 418 | 419 | if (tint_loc is not None) and (act_loc >= tint_loc): 420 | act_loc_add = 1 421 | else: 422 | act_loc_add = 0 423 | 424 | pdb.gimp_image_insert_layer(img, layer, frame.layer, act_loc + act_loc_add) 425 | 426 | # Without this, the active layer ends up the last copied layer. 427 | img.active_layer = act_layer 428 | 429 | img.undo_group_end() 430 | 431 | def renumber_frames(img): 432 | 433 | frames = list(get_frames(img)) 434 | 435 | def update_layer_name(layer, num, temp): 436 | nn = NumberedName.from_layer_name(layer.name) 437 | if nn.width < 4: 438 | nn.width = 4 439 | 440 | if nn.num is not None: 441 | if temp: 442 | nn.name = "temp-" + nn.name 443 | else: 444 | nn.name = re.sub(r'^temp-', '', nn.name) 445 | nn.num = num * nn.get_new_frame_increment() 446 | 447 | layer.name = nn.to_string() 448 | 449 | def do_renumber(temp): 450 | 451 | for n, frame in enumerate(frames): 452 | 453 | m = len(frames) - n 454 | 455 | update_layer_name(frame.layer, m, temp) 456 | 457 | if hasattr(frame.layer, 'layers'): 458 | for layer in frame.layer.layers: 459 | update_layer_name(layer, m, temp) 460 | 461 | 462 | do_renumber(temp=True) 463 | do_renumber(temp=False) 464 | 465 | def onion_add_frame(img, act_layer): 466 | frames = list(get_frames(img)) 467 | 468 | # remember current frame context 469 | contextobj = onion(img, act_layer, 0, dryrun=True) 470 | 471 | # If no frames were found, do nothing. 472 | N = len(frames) 473 | if N < 1: 474 | return 475 | 476 | # Get the top level layer (frame) from the currently active layer 477 | act_frame = act_layer 478 | while act_frame.parent is not None: 479 | act_frame = act_frame.parent 480 | 481 | # This only works if frames are layer groups 482 | if not hasattr(act_frame, 'layers'): 483 | return 484 | 485 | # Refuse to do anything if the currently active layer 486 | # is not visible. 487 | if frames[contextobj.current_index].layer != act_frame: 488 | return 489 | 490 | # We need to get item position from gimp in addition to 491 | # contextobj.current_index - there might be [background] 492 | # layers somewhere in between, so these two numbers might 493 | # not be equal. 494 | n = pdb.gimp_image_get_item_position(img, act_frame) 495 | 496 | # Get a name for the new frame - start with the name 497 | # of the current frame. 498 | new_frame_name = NumberedName.from_layer_name(act_frame.name) 499 | 500 | if contextobj.current_index <= 0: 501 | # Currently selected frame is the last frame 502 | new_frame_name.num += new_frame_name.get_new_frame_increment() 503 | else: 504 | frame_after = frames[contextobj.current_index-1] 505 | try: 506 | new_frame_name.num = get_middle_number( 507 | new_frame_name.num, 508 | NumberedName.from_layer_name(frame_after.layer.name).num 509 | ) 510 | except ValueError: 511 | # There's no space left... 512 | return 513 | 514 | img.undo_group_start() 515 | 516 | # hide the frame we're copying so that the new frame will be detected 517 | # as currently visible. 518 | act_frame.visible = False 519 | 520 | new_frame = pdb.gimp_layer_group_new(img) 521 | new_frame.name = new_frame_name.to_string() 522 | pdb.gimp_image_insert_layer(img, new_frame, None, n) 523 | 524 | for n, layer in enumerate(act_frame.layers): 525 | name = NumberedName.from_layer_name(layer.name) 526 | 527 | if name.num is None: 528 | continue 529 | name.num = new_frame_name.num 530 | 531 | new_layer = pdb.gimp_layer_new(img, img.width, img.height, 1, 532 | name.to_string(), layer.opacity, 0) 533 | 534 | pdb.gimp_image_insert_layer(img, new_layer, new_frame, n) 535 | 536 | # quick dirty check if tinting was used 537 | do_tint = (pdb.gimp_image_get_layer_by_name(img, "onion-tint-after") is not None) 538 | 539 | onion(img, act_layer, 0, contextobj, do_tint=do_tint) 540 | 541 | img.undo_group_end() 542 | 543 | def onion_enable_disable_frame(img, act_layer, enable): 544 | # Get the top level layer (frame) from the currently active layer 545 | act_frame = act_layer 546 | while act_frame.parent is not None: 547 | act_frame = act_frame.parent 548 | 549 | img.undo_group_start() 550 | 551 | if enable: 552 | act_frame.name = act_frame.name.replace('[', '').replace(']', '') 553 | else: 554 | act_frame.name = '[' + act_frame.name + ']' 555 | 556 | img.undo_group_end() 557 | 558 | def onion_enable_frame(img, act_layer): 559 | onion_enable_disable_frame(img, act_layer, True) 560 | 561 | def onion_disable_frame(img, act_layer): 562 | onion_enable_disable_frame(img, act_layer, False) 563 | 564 | # Gets the highest numbered frame, or a sane default 565 | # if no numbered frame was found. 566 | def get_last_numbered_name(frames): 567 | last_name = None 568 | 569 | for frame in frames: 570 | name = NumberedName.from_layer_name(frame.layer.name) 571 | if name.num is not None: 572 | if last_name is None: 573 | last_name = name 574 | else: 575 | if name.num > last_name.num: 576 | last_name = name 577 | 578 | if last_name is None: 579 | last_name = NumberedName('frame', 0, 4) 580 | 581 | return last_name 582 | 583 | def onion_convert_to_groups(img, act_layer): 584 | frames = list(get_frames(img)) 585 | 586 | # If no frames were found, do nothing. 587 | N = len(frames) 588 | if N < 1: 589 | return 590 | 591 | # We need to generate some frame names that 592 | # are not used elsewhere (we'll renumber later) 593 | new_frame_name = get_last_numbered_name(frames) 594 | new_frame_name.num += 1 595 | 596 | layer_name = 'imported' 597 | 598 | img.undo_group_start() 599 | 600 | has_new_frames = False 601 | for n, frame in enumerate(frames): 602 | # If the frame is layer and not a group, 603 | # create a new group and put it in. 604 | if not hasattr(frame.layer, 'layers'): 605 | new_frame = pdb.gimp_layer_group_new(img) 606 | new_frame.name = new_frame_name.to_string() 607 | 608 | pdb.gimp_image_insert_layer(img, new_frame, None, n) 609 | 610 | pdb.gimp_image_reorder_item(img, frame.layer, new_frame, 0) 611 | 612 | name = NumberedName(layer_name, new_frame_name.num, new_frame_name.width) 613 | frame.layer.name = name.to_string() 614 | 615 | has_new_frames = True 616 | new_frame_name.num += 1 617 | 618 | # Renumber frames if any new ones have been added 619 | if has_new_frames: 620 | renumber_frames(img) 621 | 622 | img.undo_group_end() 623 | 624 | def onion_renumber_frames(img, act_layer): 625 | img.undo_group_start() 626 | 627 | renumber_frames(img) 628 | 629 | img.undo_group_end() 630 | 631 | def start(): 632 | register( 633 | "python_fu_onion_up", 634 | "Onion up", 635 | "Move one onion layer up", 636 | "Tomaz Solc", 637 | "Open source (BSD 3-clause license)", 638 | "2022", 639 | "/Filters/Animation/Onion layers/up", 640 | "*", 641 | [], 642 | [], 643 | onion_up) 644 | 645 | register( 646 | "python_fu_onion_down", 647 | "Onion down", 648 | "Move one onion layer down", 649 | "Tomaz Solc", 650 | "GPLv3+", 651 | "2022", 652 | "/Filters/Animation/Onion layers/down", 653 | "*", 654 | [], 655 | [], 656 | onion_down) 657 | 658 | register( 659 | "python_fu_onion_up_ctx", 660 | "Onion up, contex", 661 | "Move one onion layer up, show next/prev frame", 662 | "Tomaz Solc", 663 | "GPLv3+", 664 | "2022", 665 | "/Filters/Animation/Onion layers/up, context", 666 | "*", 667 | [], 668 | [], 669 | onion_up_ctx) 670 | 671 | register( 672 | "python_fu_onion_down_ctx", 673 | "Onion down, context", 674 | "Move one onion layer down, show next/prev frame", 675 | "Tomaz Solc", 676 | "GPLv3+", 677 | "2022", 678 | "/Filters/Animation/Onion layers/down, context", 679 | "*", 680 | [], 681 | [], 682 | onion_down_ctx) 683 | 684 | register( 685 | "python_fu_onion_up_ctx_auto", 686 | "Onion up, auto context", 687 | "Move one onion layer up, retain current context", 688 | "Tomaz Solc", 689 | "GPLv3+", 690 | "2022", 691 | "/Filters/Animation/Onion layers/up, auto", 692 | "*", 693 | [], 694 | [], 695 | onion_up_ctx_auto) 696 | 697 | register( 698 | "python_fu_onion_down_ctx_auto", 699 | "Onion down, auto context", 700 | "Move one onion layer down, retain current context", 701 | "Tomaz Solc", 702 | "GPLv3+", 703 | "2022", 704 | "/Filters/Animation/Onion layers/down, auto", 705 | "*", 706 | [], 707 | [], 708 | onion_down_ctx_auto) 709 | 710 | register( 711 | "python_fu_onion_up_ctx_auto_tint", 712 | "Onion up, auto context, tint", 713 | "Move one onion layer up, retain current context. Next layer is shown with a green tint, previous layer is shown with a purple tint.", 714 | "Tomaz Solc", 715 | "GPLv3+", 716 | "2022", 717 | "/Filters/Animation/Onion layers/up, auto, tint", 718 | "*", 719 | [], 720 | [], 721 | onion_up_ctx_auto_tint) 722 | 723 | register( 724 | "python_fu_onion_down_ctx_auto_tint", 725 | "Onion down, auto context, tint", 726 | "Move one onion layer down, retain current context. Next layer is shown with a green tint, previous layer is shown with a purple tint.", 727 | "Tomaz Solc", 728 | "GPLv3+", 729 | "2022", 730 | "/Filters/Animation/Onion layers/down, auto, tint", 731 | "*", 732 | [], 733 | [], 734 | onion_down_ctx_auto_tint) 735 | 736 | register( 737 | "python_fu_onion_cycle_ctx", 738 | "Cycle through frame contexts", 739 | "Cycle through no, prev, next, prev/next contexts.", 740 | "Tomaz Solc", 741 | "GPLv3+", 742 | "2022", 743 | "/Filters/Animation/Onion layers/cycle context", 744 | "*", 745 | [], 746 | [], 747 | onion_cycle_context) 748 | 749 | register( 750 | "python_fu_onion_cycle_ctx_tint", 751 | "Cycle through frame contexts, with tinting enabled.", 752 | "Cycle through no, prev, next, prev/next contexts. Next layer is shown with a green tint, previous layer is shown with a purple tint.", 753 | "Tomaz Solc", 754 | "GPLv3+", 755 | "2022", 756 | "/Filters/Animation/Onion layers/cycle context, tint", 757 | "*", 758 | [], 759 | [], 760 | onion_cycle_context_tint) 761 | 762 | register( 763 | "python_fu_onion_show_all", 764 | "Show all frames", 765 | "Shows all frames with full opacity", 766 | "Tomaz Solc", 767 | "GPLv3+", 768 | "2022", 769 | "/Filters/Animation/Onion layers/Show all", 770 | "*", 771 | [], 772 | [], 773 | show_all) 774 | 775 | register( 776 | "python_fu_onion_copy_layer", 777 | "Copy layer to all frames", 778 | "Copy active layer to all frames. If layer already exists in that frame, copy opacity and visibility.", 779 | "Tomaz Solc", 780 | "GPLv3+", 781 | "2022", 782 | "/Filters/Animation/Onion layers/Copy layer", 783 | "*", 784 | [], 785 | [], 786 | onion_copy_layer) 787 | 788 | register( 789 | "python_fu_onion_add_frame", 790 | "Add a frame above current one", 791 | "Add a frame above current one, copying all the layers.", 792 | "Tomaz Solc", 793 | "GPLv3+", 794 | "2022", 795 | "/Filters/Animation/Onion layers/Add frame", 796 | "*", 797 | [], 798 | [], 799 | onion_add_frame) 800 | 801 | register( 802 | "python_fu_onion_enable_frame", 803 | "Make the current frame a cel frame", 804 | "Removes square brackets around the name of the currently active frame.", 805 | "Tomaz Solc", 806 | "GPLv3+", 807 | "2022", 808 | "/Filters/Animation/Onion layers/Enable frame", 809 | "*", 810 | [], 811 | [], 812 | onion_enable_frame) 813 | 814 | register( 815 | "python_fu_onion_disable_frame", 816 | "Make the current frame a background frame", 817 | "Puts square brackets around the name of the currently active frame.", 818 | "Tomaz Solc", 819 | "GPLv3+", 820 | "2022", 821 | "/Filters/Animation/Onion layers/Disable frame", 822 | "*", 823 | [], 824 | [], 825 | onion_disable_frame) 826 | 827 | register( 828 | "python_fu_onion_convert_to_groups", 829 | "Convert bare layers into groups", 830 | "Puts each layer on the top level into its own layer group.", 831 | "Tomaz Solc", 832 | "GPLv3+", 833 | "2022", 834 | "/Filters/Animation/Onion layers/Convert to groups", 835 | "*", 836 | [], 837 | [], 838 | onion_convert_to_groups) 839 | 840 | register( 841 | "python_fu_onion_renumber_frames", 842 | "Renumber all frames", 843 | "Updates the numbers in the names of all layers.", 844 | "Tomaz Solc", 845 | "GPLv3+", 846 | "2022", 847 | "/Filters/Animation/Onion layers/Renumber frames", 848 | "*", 849 | [], 850 | [], 851 | onion_renumber_frames) 852 | main() 853 | 854 | if __name__ == "__main__": 855 | from gimpfu import * 856 | 857 | start() 858 | -------------------------------------------------------------------------------- /template-1080p.xcf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/avian2/gimp-plugin-onion-layers/e1f2152688defcc76116fce3a5b94a28d9f02043/template-1080p.xcf -------------------------------------------------------------------------------- /template-720p.xcf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/avian2/gimp-plugin-onion-layers/e1f2152688defcc76116fce3a5b94a28d9f02043/template-720p.xcf -------------------------------------------------------------------------------- /tests.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from onion_layers import NumberedName, flocked, get_middle_number 4 | 5 | class TestNumberedName(unittest.TestCase): 6 | def test_parse(self): 7 | 8 | nn = NumberedName.from_layer_name("outline01") 9 | 10 | self.assertEqual(nn.name, "outline") 11 | self.assertEqual(nn.num, 1) 12 | self.assertEqual(nn.is_mask, False) 13 | self.assertEqual(nn.width, 2) 14 | 15 | s = nn.to_string() 16 | 17 | self.assertEqual(s, "outline01") 18 | 19 | def test_parse_no_number(self): 20 | 21 | nn = NumberedName.from_layer_name("foo") 22 | 23 | self.assertEqual(nn.name, "foo") 24 | self.assertEqual(nn.num, None) 25 | self.assertEqual(nn.is_mask, False) 26 | self.assertEqual(nn.width, None) 27 | 28 | s = nn.to_string() 29 | 30 | self.assertEqual(s, "foo") 31 | 32 | class TestGetMiddleNumber(unittest.TestCase): 33 | def test_basic(self): 34 | self.assertEqual(50, get_middle_number(0, 100)) 35 | self.assertEqual(150, get_middle_number(100, 200)) 36 | 37 | self.assertEqual(25, get_middle_number(0, 50)) 38 | self.assertEqual(12, get_middle_number(0, 25)) 39 | self.assertEqual(6, get_middle_number(0, 12)) 40 | self.assertEqual(3, get_middle_number(0, 6)) 41 | self.assertEqual(1, get_middle_number(0, 3)) 42 | 43 | self.assertEqual(1, get_middle_number(0, 2)) 44 | self.assertEqual(2, get_middle_number(1, 3)) 45 | self.assertEqual(3, get_middle_number(2, 4)) 46 | 47 | with self.assertRaises(ValueError): 48 | get_middle_number(0, 1) 49 | 50 | with self.assertRaises(ValueError): 51 | get_middle_number(1, 2) 52 | 53 | with self.assertRaises(ValueError): 54 | get_middle_number(2, 3) 55 | 56 | with self.assertRaises(ValueError): 57 | get_middle_number(1, 1) 58 | 59 | def test_one(self): 60 | for n in range(100): 61 | self.assertEqual(n+1, get_middle_number(n, n+2)) 62 | 63 | 64 | class TestFlocked(unittest.TestCase): 65 | def test_flock(self): 66 | with flocked(): 67 | pass 68 | 69 | if __name__ == "__main__": 70 | unittest.main(verbosity=2) 71 | --------------------------------------------------------------------------------