├── .gitignore ├── LICENSE ├── MANIFEST.in ├── Makefile ├── README.md ├── bpsrender ├── __init__.py ├── __main__.py ├── bscripts │ ├── mixdown.py │ ├── probe.py │ └── video.py ├── calls.py ├── commands.py ├── config.py ├── helpers.py └── setup.py ├── pyproject.toml └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | dist/ 13 | sdist/ 14 | var/ 15 | wheels/ 16 | *.egg-info/ 17 | .installed.cfg 18 | *.egg 19 | README.rst 20 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include bpsrender/bscripts/*.py 2 | include LICENSE 3 | include README.rst 4 | include bscripts 5 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all 2 | all: clean readme build upload 3 | 4 | .PHONY: build 5 | build: 6 | python3 setup.py sdist bdist_wheel 7 | 8 | clean: 9 | rm -rf ./bpsrender.egg-info 10 | rm -rf ./build 11 | rm -rf ./dist/* 12 | 13 | readme: 14 | pandoc README.md -o README.rst 15 | 16 | upload: 17 | twine upload dist/* 18 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Blender Power Sequencer Render - BPSRender # 2 | 3 | This is a [standalone python package](https://pypi.org/project/bpsrender/) as well as a command-line program you can use to speed up rendering [VSE projects](https://docs.blender.org/manual/en/dev/editors/vse/index.html) by spawning Blender processes in background in parallel. 4 | 5 | It is included with the [Blender Power Sequencer add-on](https://github.com/GDquest/Blender-power-sequencer). 6 | 7 | ![](https://i.imgur.com/BndLccL.gif) 8 | 9 | 10 | ## Install ## 11 | 12 | To install BPSRender as a standalone command line utility, use [PiPy](https://pypi.org/project/bpsrender/): `pip install [--user] bpsrender`. 13 | 14 | *You must have `$HOME/.local/bin` included in your `$PATH` environment variable on GNU/Linux if you're going to install the utility locally (using `--user` when executing `pip`).* 15 | 16 | 17 | ## Usage ## 18 | 19 | To read the help, after you installed BPSRender, type `bpsrender -h` in the shell: 20 | 21 | ``` 22 | usage: bpsrender [-h] [-o OUTPUT] [-w WORKERS] [-v] [--dry-run] [-s START] 23 | [-e END] [-m] [-c] [-d] [-j] 24 | blendfile 25 | 26 | Multi-process Blender VSE rendering - will attempt to create a folder called 27 | `render` inside of the folder containing `blendfile`. Insider `render` another 28 | folder called `parts` will be created for storing temporary files. These files 29 | will be joined together as the last step to produce the final render which 30 | will be stored inside `render` and it will have the same name as `blendfile` 31 | 32 | positional arguments: 33 | blendfile Blender project file to render. 34 | 35 | optional arguments: 36 | -h, --help show this help message and exit 37 | -o OUTPUT, --output OUTPUT 38 | Output folder (will contain a `bpsrender` temp folder 39 | forrendering parts). 40 | -w WORKERS, --workers WORKERS 41 | Number of workers in the pool (for video rendering). 42 | -v, --verbose Increase verbosity level (eg. -vvv). 43 | --dry-run Run the script without actual rendering or creating 44 | files and folders. For DEBUGGING purposes 45 | -s START, --start START 46 | Start frame 47 | -e END, --end END End frame 48 | -m, --mixdown-only ONLY render the audio MIXDOWN 49 | -c, --concatenate-only 50 | ONLY CONCATENATE the (already) available video chunks 51 | -d, --video-only ONLY render the VIDEO (implies --concatenate-only). 52 | -j, --join-only ONLY JOIN the mixdown with the video. This will 53 | produce the final render 54 | ``` 55 | 56 | ## External Dependencies ## 57 | 58 | BPSRender requires 59 | 60 | - `blender` 61 | - `ffmpeg` 62 | 63 | to be available in the `$PATH` environment variable in order to work. If BPSRender catches a missing dependency it throws a an error similar to this: 64 | 65 | ``` 66 | BPSRender couldn't find external dependencies: 67 | [v] blender: /home/razvan/.local/bin/blender 68 | [X] ffmpeg: NOT FOUND 69 | Check if you have them properly installed and available in the PATH environemnt variable. 70 | Exiting... 71 | ``` 72 | 73 | ## Tips ## 74 | 75 | Here are some tips about using BPSRender as a command line utility. 76 | 77 | ### Deleting the temporary folder after a successful render ### 78 | 79 | BPSRender creates a `bpsrender/` folder next to the `blendfile` it renders. There, it stores rendered video parts, the audio soundtrack from the project, and a text file to stitch the parts together. It does not automatically delete this folder at the moment. To do so, using the GNU/Linux shell, you can use these commands: 80 | 81 | ```shell 82 | bpsrender my_file.blend && rm -rf bpsrender 83 | ``` 84 | 85 | After the render finished successfully, this will delete the `bpsrender` folder. 86 | 87 | ### Rendering multiple projects with POSIX shells ### 88 | 89 | You can render many projects one after the other from the terminal using the `find` command: 90 | 91 | ```shell 92 | find . -name "*.blend" -exec bpsrender {} \; 93 | ``` 94 | 95 | ## Known Issues ## 96 | 97 | - [ ] CTRL-C interrupt leaves subprocesses running in the background 98 | - [ ] CTRL-C interrupt doesn't clean the folders yet 99 | -------------------------------------------------------------------------------- /bpsrender/__init__.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | 18 | -------------------------------------------------------------------------------- /bpsrender/__main__.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | """ 18 | Renders videos edited in Blender 3D's Video Sequence Editor using multiple CPU 19 | cores. Original script by Justin Warren: 20 | https://github.com/sciactive/pulverize/blob/master/pulverize.py 21 | Modified by sudopluto (Pranav Sharma), gdquest (Nathan Lovato) and 22 | razcore (Razvan Radulescu) 23 | 24 | Under GPLv3 license 25 | """ 26 | import argparse as ap 27 | import os.path as osp 28 | import sys 29 | from functools import partial 30 | 31 | from .calls import call 32 | from .config import CONFIG as C 33 | from .config import LOGGER 34 | from .helpers import BSError, ToolError, checktools, kickstart, prints 35 | from .setup import setup 36 | 37 | # https://github.com/mikeycal/the-video-editors-render-script-for-blender#configuring-the-script 38 | # there seems no easy way to grab the ram usage in a mulitplatform way 39 | # without writing platform dependent code, or by using a python module 40 | 41 | # Most popluar config is 4 cores, 8 GB ram, this is the default for the script 42 | # https://store.steampowered.com/hwsurvey/ 43 | 44 | 45 | def parse_arguments(cfg): 46 | """ 47 | Uses `argparse` to parse the command line arguments. 48 | 49 | Parameters 50 | ---------- 51 | cfg: dict 52 | Configuration dictionary. 53 | 54 | Returns 55 | ------- 56 | out: Namespace 57 | Command line arguments (normalized). 58 | """ 59 | p = ap.ArgumentParser( 60 | description="Multi-process Blender VSE rendering - will attempt to" 61 | " create a folder called `render` inside of the folder" 62 | " containing `blendfile`. Insider `render` another folder called" 63 | " `parts` will be created for storing temporary files. These files" 64 | " will be joined together as the last step to produce the final" 65 | " render which will be stored inside `render` and it will have the" 66 | " same name as `blendfile`" 67 | ) 68 | p.add_argument( 69 | "-o", 70 | "--output", 71 | default=".", 72 | help="Output folder (will contain a `bpsrender` temp folder for" "rendering parts).", 73 | ) 74 | p.add_argument( 75 | "-w", 76 | "--workers", 77 | type=int, 78 | default=cfg["cpu_count"], 79 | help="Number of workers in the pool (for video rendering).", 80 | ) 81 | p.add_argument( 82 | "-v", "--verbose", action="count", default=0, help="Increase verbosity level (eg. -vvv)." 83 | ) 84 | p.add_argument( 85 | "--dry-run", 86 | action="store_true", 87 | help=( 88 | "Run the script without actual rendering or creating files and" 89 | " folders. For DEBUGGING purposes" 90 | ), 91 | ) 92 | p.add_argument("-s", "--start", type=int, default=None, help="Start frame") 93 | p.add_argument("-e", "--end", type=int, default=None, help="End frame") 94 | p.add_argument( 95 | "-m", "--mixdown-only", action="store_true", help="ONLY render the audio MIXDOWN" 96 | ) 97 | p.add_argument( 98 | "-c", 99 | "--concatenate-only", 100 | action="store_true", 101 | help="ONLY CONCATENATE the (already) available video chunks", 102 | ) 103 | p.add_argument( 104 | "-d", 105 | "--video-only", 106 | action="store_true", 107 | help="ONLY render the VIDEO (implies --concatenate-only).", 108 | ) 109 | p.add_argument( 110 | "-j", 111 | "--join-only", 112 | action="store_true", 113 | help="ONLY JOIN the mixdown with the video. This will produce the" " final render", 114 | ) 115 | p.add_argument("blendfile", help="Blender project file to render.") 116 | 117 | clargs = p.parse_args() 118 | clargs.blendfile = osp.abspath(clargs.blendfile) 119 | clargs.output = osp.abspath(clargs.output) 120 | # --video-only implies --concatenate-only 121 | clargs.concatenate_only = clargs.concatenate_only or clargs.video_only 122 | # --dry-run implies maximum verbosity level 123 | clargs.verbose = 99999 if clargs.dry_run else clargs.verbose 124 | return clargs 125 | 126 | 127 | def main(): 128 | """ 129 | Script entry point. 130 | """ 131 | tools = ["blender", "ffmpeg"] 132 | try: 133 | clargs = parse_arguments(C) 134 | checktools(tools) 135 | cmds, kwargs = setup(C, clargs) 136 | kickstart(map(partial(call, C, clargs, **kwargs), cmds)) 137 | except (BSError, ToolError) as e: 138 | LOGGER.error(e) 139 | except KeyboardInterrupt: 140 | # TODO: add actual clean up code 141 | prints(C, "DirtyInterrupt. Exiting", s="\n\n", e="...") 142 | sys.exit() 143 | 144 | 145 | # this is so it can be ran as a module: `python3 -m bpsrender` (for testing) 146 | if __name__ == "__main__": 147 | main() 148 | -------------------------------------------------------------------------------- /bpsrender/bscripts/mixdown.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | import bpy 18 | import os.path as osp 19 | import sys 20 | 21 | if __name__ == "__main__": 22 | for strip in bpy.context.scene.sequence_editor.sequences_all: 23 | if strip.type == "META": 24 | continue 25 | if strip.type != "SOUND": 26 | strip.mute = True 27 | 28 | path = sys.argv[-1] 29 | ext = osp.splitext(path)[1][1:].upper() 30 | bpy.ops.sound.mixdown(filepath=path, check_existing=False, container=ext, codec=ext) 31 | -------------------------------------------------------------------------------- /bpsrender/bscripts/probe.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | import bpy 18 | 19 | EXT = { 20 | "AVI_JPEG": ".avi", 21 | "AVI_RAW": ".avi", 22 | "FFMPEG": {"MKV": ".mkv", "OGG": ".ogv", "QUICKTIME": ".mov", "AVI": ".avi", "MPEG4": ".mp4"}, 23 | } 24 | 25 | scene = bpy.context.scene 26 | 27 | ext = EXT.get(scene.render.image_settings.file_format, "UNDEFINED") 28 | if scene.render.image_settings.file_format == "FFMPEG": 29 | ext = ext[scene.render.ffmpeg.format] 30 | print("\nBPS:{} {} {}\n".format(scene.frame_start, scene.frame_end, ext)) 31 | -------------------------------------------------------------------------------- /bpsrender/bscripts/video.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | import bpy 18 | 19 | bpy.context.scene.render.ffmpeg.audio_codec = "NONE" 20 | -------------------------------------------------------------------------------- /bpsrender/calls.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | # IMPURE 18 | import multiprocessing as mp 19 | import os 20 | import signal as sig 21 | import subprocess as sp 22 | from functools import partial, reduce 23 | from itertools import chain, islice, starmap, tee 24 | from multiprocessing import Queue 25 | 26 | from tqdm import tqdm 27 | 28 | from .config import LOGGER 29 | from .helpers import BSError, checkblender, kickstart, printd, prints, printw 30 | 31 | 32 | def chunk_frames(cfg, clargs, cmds, **kwargs): 33 | """ 34 | Recover the chunk start/end frames from the constructed commands for the 35 | video step. This is necessary to preserve purity until later steps. 36 | 37 | Parameters 38 | ---------- 39 | cfg: dict 40 | Configuration dictionary. 41 | clargs: Namespace 42 | Command line arguments (normalized). 43 | cmds: iter(tuple) 44 | Iterator of commands to be passed to `subprocess`. 45 | kwargs: dict 46 | Dictionary with additional information from the setup step. 47 | 48 | Returns 49 | ------- 50 | out: iter(tuple) 51 | Start/end pairs of frames corresponding to the chunk commands created at 52 | the video step. 53 | """ 54 | out = map(lambda x: (x, islice(x, 1, None)), cmds) 55 | out = map(lambda x: zip(*x), out) 56 | out = map(lambda x: filter(lambda y: y[0] in ("-s", "-e"), x), out) 57 | out = map(lambda x: map(lambda y: int(y[1]), x), out) 58 | out = map(lambda x: reduce(lambda acc, y: acc + (y,), x, ()), out) 59 | return out 60 | 61 | 62 | def append_chunks_file(cfg, clargs, cmds, **kwargs): 63 | """ 64 | IMPURE 65 | Helper function for creating the chunks file that will be used by `ffmpeg` 66 | to concatenate the chunks into one video file. 67 | 68 | Parameters 69 | ---------- 70 | cfg: dict 71 | Configuration dictionary. 72 | clargs: Namespace 73 | Command line arguments (normalized). 74 | cmds: iter(tuple) 75 | Iterator of commands to be passed to `subprocess`. 76 | kwargs: dict 77 | MANDATORY w_frame_start, w_frame_end, ext 78 | Dictionary with additional information from the setup step. 79 | """ 80 | with open(kwargs["chunks_file_path"], "a") as f: 81 | for fs, fe in chunk_frames(cfg, clargs, cmds, **kwargs): 82 | f.write( 83 | "file '{rcp}{fs}-{fe}{ext}'\n".format( 84 | rcp=kwargs["render_chunk_path"].rstrip("#"), 85 | fs="{fs:0{frame_pad}d}".format(fs=fs, **cfg), 86 | fe="{fe:0{frame_pad}d}".format(fe=fe, **cfg), 87 | **kwargs 88 | ) 89 | ) 90 | 91 | 92 | def call_probe(cfg, clargs, cmds, **kwargs): 93 | """ 94 | IMPURE 95 | Probe `clargs.blendfile` for frame start, frame end and extension (for 96 | video only). 97 | 98 | Parameters 99 | ---------- 100 | cfg: dict 101 | Configuration dictionary. 102 | clargs: Namespace 103 | Command line arguments (normalized). 104 | cmds: iter(tuple) 105 | Iterator of commands to be passed to `subprocess`. 106 | kwargs: dict 107 | Dictionary with additional information from the setup step. 108 | 109 | Returns 110 | ------- 111 | out: dict 112 | Dictionary with info extracted from `clargs.blendfile`, namely: start 113 | frame, end frame and extension (only useful for video step). 114 | """ 115 | kwargs_p = {"stdout": sp.PIPE, "stderr": sp.STDOUT, "universal_newlines": True} 116 | 117 | printw(cfg, "Probing") 118 | printw(cfg, "Input(blend) @ {}".format(clargs.blendfile), s="") 119 | frame_start, frame_end, ext = (0, 0, "") 120 | if not clargs.dry_run: 121 | with sp.Popen(next(cmds), **kwargs_p) as cp: 122 | try: 123 | tmp = map(partial(checkblender, "PROBE", [cfg["probe_py"]], cp), cp.stdout) 124 | tmp = filter(lambda x: x.startswith("BPS"), tmp) 125 | tmp = map(lambda x: x[4:].strip().split(), tmp) 126 | frame_start, frame_end, ext = chain(*tmp) 127 | except BSError as e: 128 | LOGGER.error(e) 129 | except KeyboardInterrupt: 130 | raise 131 | finally: 132 | cp.terminate() 133 | returncode = cp.poll() 134 | if returncode != 0: 135 | raise sp.CalledProcessError(returncode, cp.args) 136 | frame_start = frame_start if clargs.start is None else clargs.start 137 | frame_end = frame_end if clargs.end is None else clargs.end 138 | out = { 139 | "frame_start": int(frame_start), 140 | "frame_end": int(frame_end), 141 | "frames_total": int(frame_end) - int(frame_start) + 1, 142 | "ext": ext, 143 | } 144 | if out["ext"] == "UNDEFINED": 145 | raise BSError("Video extension is {ext}. Stopping!".format(ext=ext)) 146 | printd(cfg, "Probing done") 147 | return out 148 | 149 | 150 | def call_mixdown(cfg, clargs, cmds, **kwargs): 151 | """ 152 | IMPURE 153 | Calls blender to render the audio mixdown. 154 | 155 | Parameters 156 | ---------- 157 | cfg: dict 158 | Configuration dictionary. 159 | clargs: Namespace 160 | Command line arguments (normalized). 161 | cmds: iter(tuple) 162 | Iterator of commands to be passed to `subprocess`. 163 | kwargs: dict 164 | MANDATORY render_mixdown_path 165 | Dictionary with additional information from the setup step. 166 | """ 167 | kwargs_p = {"stdout": sp.PIPE, "stderr": sp.STDOUT, "universal_newlines": True} 168 | 169 | printw(cfg, "Rendering mixdown") 170 | printw(cfg, "Output @ {}".format(kwargs["render_mixdown_path"]), s="") 171 | if not clargs.dry_run: 172 | with sp.Popen(next(cmds), **kwargs_p) as cp: 173 | try: 174 | tmp = map(partial(checkblender, "MIXDOWN", [cfg["mixdown_py"]], cp), cp.stdout) 175 | tmp = filter(lambda x: x.startswith("BPS"), tmp) 176 | tmp = map(lambda x: x[4:].strip().split(), tmp) 177 | kickstart(tmp) 178 | except BSError as e: 179 | LOGGER.error(e) 180 | except KeyboardInterrupt: 181 | raise 182 | finally: 183 | cp.terminate() 184 | returncode = cp.poll() 185 | if returncode != 0: 186 | raise sp.CalledProcessError(returncode, cp.args) 187 | printd(cfg, "Mixdown done") 188 | 189 | 190 | def call_chunk(cfg, clargs, queue, cmd, **kwargs): 191 | """ 192 | IMPURE 193 | Calls blender to render one chunk (which part is determined by `cmd`). 194 | 195 | Parameters 196 | ---------- 197 | cfg: dict 198 | Configuration dictionary. 199 | clargs: Namespace 200 | Command line arguments (normalized). 201 | cmd: tuple 202 | Tuple to be passed to `subprocess`. 203 | kwargs: dict 204 | Dictionary with additional information from the setup step. 205 | """ 206 | sig.signal(sig.SIGINT, sig.SIG_IGN) 207 | kwargs_p = {"stdout": sp.PIPE, "stderr": sp.STDOUT, "universal_newlines": True} 208 | 209 | if not clargs.dry_run: 210 | # can't use nice functional syntax if we want to simplify with `with` 211 | with sp.Popen(cmd, **kwargs_p) as cp: 212 | try: 213 | tmp = map( 214 | partial( 215 | checkblender, 216 | "VIDEO", 217 | [cfg["video_py"], "The encoder timebase is not set"], 218 | cp, 219 | ), 220 | cp.stdout, 221 | ) 222 | tmp = filter(lambda x: x.startswith("Append frame"), tmp) 223 | tmp = map(lambda x: x.split()[-1], tmp) 224 | tmp = map(int, tmp) 225 | tmp = map(lambda x: True, tmp) 226 | kickstart(map(queue.put, tmp)) 227 | queue.put(False) 228 | except BSError as e: 229 | LOGGER.error(e) 230 | 231 | 232 | def call_video(cfg, clargs, cmds, **kwargs): 233 | """ 234 | IMPURE 235 | Multi-process call to blender for rendering the (video) chunks. 236 | 237 | Parameters 238 | ---------- 239 | cfg: dict 240 | Configuration dictionary. 241 | clargs: Namespace 242 | Command line arguments (normalized). 243 | cmds: iter(tuple) 244 | Iterator of commands to be passed to `subprocess`. 245 | kwargs: dict 246 | Dictionary with additional information from the setup step. 247 | """ 248 | printw(cfg, "Rendering video (w/o audio)") 249 | printw(cfg, "Output @ {}".format(kwargs["render_chunk_path"]), s="") 250 | try: 251 | not clargs.dry_run and os.remove(kwargs["chunks_file_path"]) 252 | LOGGER.info("CALL-VIDEO: generating {}".format(kwargs["chunks_file_path"])) 253 | except OSError as e: 254 | LOGGER.info("CALL-VIDEO: skipping {}: {}".format(e.filename, e.strerror)) 255 | 256 | cmds, cmds_cf = tee(cmds) 257 | (not clargs.dry_run and append_chunks_file(cfg, clargs, cmds_cf, **kwargs)) 258 | # prepare queue/worker 259 | queues = queues_close = (Queue(),) * clargs.workers 260 | # prpare processes 261 | proc = starmap( 262 | lambda q, cmd: mp.Process(target=partial(call_chunk, cfg, clargs, **kwargs), args=(q, cmd)), 263 | zip(queues, cmds), 264 | ) 265 | # split iterator in 2 for later joining the processes and sum 266 | # one of them 267 | proc, proc_close = tee(proc) 268 | proc = map(lambda p: p.start(), proc) 269 | try: 270 | not clargs.dry_run and kickstart(proc) 271 | 272 | # communicate with processes through the queues and use tqdm to show a 273 | # simple terminal progress bar baesd on video total frames 274 | queues = map(lambda q: iter(q.get, False), queues) 275 | queues = chain(*queues) 276 | queues = tqdm(queues, total=kwargs["frame_end"] - kwargs["frame_start"] + 1, unit="frames") 277 | not clargs.dry_run and kickstart(queues) 278 | except KeyboardInterrupt: 279 | proc_close = map(lambda x: x.terminate(), proc_close) 280 | not clargs.dry_run and kickstart(proc_close) 281 | raise 282 | finally: 283 | # close and join processes and queues 284 | proc_close = map(lambda x: x.join(), proc_close) 285 | not clargs.dry_run and kickstart(proc_close) 286 | 287 | queues_close = map(lambda q: (q, q.close()), queues_close) 288 | queues_close = starmap(lambda q, _: q.join_thread(), queues_close) 289 | not clargs.dry_run and kickstart(queues_close) 290 | printd(cfg, "Video chunks rendering done") 291 | 292 | 293 | def call_concatenate(cfg, clargs, cmds, **kwargs): 294 | """ 295 | IMPURE 296 | Calls ffmpeg in order to concatenate the video chunks together. 297 | 298 | Parameters 299 | ---------- 300 | cfg: dict 301 | Configuration dictionary. 302 | clargs: Namespace 303 | Command line arguments (normalized). 304 | cmds: iter(tuple) 305 | Iterator of commands to be passed to `subprocess`. 306 | kwargs: dict 307 | MANDATORY: render_video_path 308 | Dictionary with additional information from the setup step. 309 | 310 | Note 311 | ---- 312 | It expects the video chunk files to already be available. 313 | """ 314 | kwargs_p = {"stdout": sp.DEVNULL, "stderr": sp.DEVNULL} 315 | printw(cfg, "Concatenating (video) chunks") 316 | printw(cfg, "Output @ {}".format(kwargs["render_video_path"]), s="") 317 | if not clargs.dry_run: 318 | with sp.Popen(next(cmds), **kwargs_p) as cp: 319 | try: 320 | returncode = cp.wait() 321 | if returncode != 0: 322 | raise sp.CalledProcessError(returncode, cp.args) 323 | except KeyboardInterrupt: 324 | raise 325 | finally: 326 | cp.terminate() 327 | printd(cfg, "Concatenating done") 328 | 329 | 330 | def call_join(cfg, clargs, cmds, **kwargs): 331 | """ 332 | IMPURE 333 | Calls ffmpeg for joining the audio mixdown and the video. 334 | 335 | Parameters 336 | ---------- 337 | cfg: dict 338 | Configuration dictionary. 339 | clargs: Namespace 340 | Command line arguments (normalized). 341 | cmds: iter(tuple) 342 | Iterator of commands to be passed to `subprocess`. 343 | kwargs: dict 344 | MANDATORY: render_audiovideo_path 345 | Dictionary with additional information from the setup step. 346 | 347 | Note 348 | ---- 349 | It expects the audio mixdown and video files to already be available. 350 | """ 351 | kwargs_p = {"stdout": sp.DEVNULL, "stderr": sp.DEVNULL} 352 | printw(cfg, "Joining audio/video") 353 | printw(cfg, "Output @ {}".format(kwargs["render_audiovideo_path"]), s="") 354 | if not clargs.dry_run: 355 | with sp.Popen(next(cmds), **kwargs_p) as cp: 356 | try: 357 | returncode = cp.wait() 358 | if returncode != 0: 359 | raise sp.CalledProcessError(returncode, cp.args) 360 | except KeyboardInterrupt: 361 | raise 362 | finally: 363 | cp.terminate() 364 | printd(cfg, "Joining done") 365 | 366 | 367 | def call(cfg, clargs, cmds, **kwargs): 368 | """ 369 | IMPURE 370 | Delegates work to appropriate `call_*` functions. 371 | 372 | Parameters 373 | ---------- 374 | cfg: dict 375 | Configuration dictionary. 376 | clargs: Namespace 377 | Command line arguments (normalized). 378 | cmds: iter(tuple) 379 | Iterator of commands to be passed to `subprocess` 380 | kwargs: dict 381 | MANDATORY: render_audiovideo_path 382 | Dictionary with additional information from the setup step. 383 | 384 | Returns 385 | ------- 386 | out: dict or None 387 | It passes on the output from the `call_*` functions. See `call_*` for 388 | specific details. 389 | 390 | Note 391 | ---- 392 | It tries to be smart and skip steps if child subprocesses give errors. 393 | Example if `--join-only` is passed, but the audio mixdown or video file 394 | aren't available on hard drive. 395 | """ 396 | calls = { 397 | "probe": call_probe, 398 | "mixdown": call_mixdown, 399 | "video": call_video, 400 | "concatenate": call_concatenate, 401 | "join": call_join, 402 | } 403 | try: 404 | out = calls[cmds[0]](cfg, clargs, cmds[1], **kwargs) 405 | return out 406 | except sp.CalledProcessError: 407 | prints( 408 | cfg, 409 | ("WARNING:{}: Something went wrong when calling" " command - SKIPPING").format(cmds[0]), 410 | ) 411 | -------------------------------------------------------------------------------- /bpsrender/commands.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | import math as m 18 | from collections import OrderedDict 19 | from itertools import chain, islice 20 | 21 | from .config import LOGGER 22 | 23 | 24 | def get_commands_probe(cfg, clargs, **kwargs): 25 | """ 26 | Create the command for probing the `clargs.blendfile`. 27 | 28 | Parameters 29 | ---------- 30 | cfg: dict 31 | Configuration dictionary. 32 | clargs: Namespace 33 | Command line arguments (normalized). 34 | kwargs: dict 35 | Dictionary with additional information from the setup step. 36 | 37 | Returns 38 | ------- 39 | out: iter(list) 40 | An iterator for which each element is a list to be sent to functions like 41 | `subprocess.run`. 42 | """ 43 | out = ( 44 | "blender", 45 | "--background", 46 | clargs.blendfile, 47 | "--python", 48 | kwargs["probe_py_normalized"], 49 | "--disable-autoexec", 50 | ) 51 | LOGGER.debug("CMD-PROBE: {cmd}".format(cmd=" ".join(out))) 52 | return iter((out,)) 53 | 54 | 55 | def get_commands_chunk(cfg, clargs, **kwargs): 56 | """ 57 | Create the command for rendering a (video) chunk from `clargs.blendfile`. 58 | 59 | Parameters 60 | ---------- 61 | cfg: dict 62 | Configuration dictionary. 63 | clargs: Namespace 64 | Command line arguments (normalized). 65 | kwargs: dict 66 | MANDATORY render_chunk_path, w_frame_start, w_frame_end 67 | Dictionary with additional information from the setup step. 68 | 69 | Returns 70 | ------- 71 | out: iter(list) 72 | An iterator for which each element is a list to be sent to functions like 73 | `subprocess.run`. 74 | """ 75 | out = ( 76 | "blender", 77 | "--background", 78 | clargs.blendfile, 79 | "--python", 80 | kwargs["video_py_normalized"], 81 | "--disable-autoexec", 82 | "--render-output", 83 | kwargs["render_chunk_path"], 84 | "-s", 85 | str(kwargs["w_frame_start"]), 86 | "-e", 87 | str(kwargs["w_frame_end"]), 88 | "--render-anim", 89 | ) 90 | LOGGER.debug( 91 | "CMD-CHUNK({w_frame_start}-{w_frame_end}): {cmd}".format(cmd=" ".join(out), **kwargs) 92 | ) 93 | return iter((out,)) 94 | 95 | 96 | def get_commands_video(cfg, clargs, **kwargs): 97 | """ 98 | Create the list of commands (one command per chunk) for rendering a video 99 | from `clargs.blendfile`. 100 | 101 | Parameters 102 | ---------- 103 | cfg: dict 104 | Configuration dictionary. 105 | clargs: Namespace 106 | Command line arguments (normalized). 107 | kwargs: dict 108 | MANDATORY chunk_file_path, frame_start, frame_end, frames_total 109 | Dictionary with additional information from the setup step. 110 | 111 | Returns 112 | ------- 113 | out: iter(tuple) 114 | An iterator for which each element is a tuple to be sent to functions like 115 | `subprocess.run`. 116 | """ 117 | LOGGER.debug("CMD-VIDEO:") 118 | chunk_length = int(m.floor(kwargs["frames_total"] / clargs.workers)) 119 | out = map(lambda w: (w, kwargs["frame_start"] + w * chunk_length), range(clargs.workers)) 120 | out = map( 121 | lambda x: ( 122 | x[1], 123 | x[1] + chunk_length - 1 if x[0] != clargs.workers - 1 else kwargs["frame_end"], 124 | ), 125 | out, 126 | ) 127 | out = map( 128 | lambda x: get_commands( 129 | cfg, clargs, "chunk", w_frame_start=x[0], w_frame_end=x[1], **kwargs 130 | ), 131 | out, 132 | ) 133 | out = map(lambda x: x[1], out) 134 | out = chain(*out) 135 | return tuple(out) 136 | 137 | 138 | def get_commands_mixdown(cfg, clargs, **kwargs): 139 | """ 140 | Create the command to render the mixdown from `clargs.blendfile`. 141 | 142 | Parameters 143 | ---------- 144 | cfg: dict 145 | Configuration dictionary. 146 | clargs: Namespace 147 | Command line arguments (normalized). 148 | kwargs: dict 149 | MANDATORY render_mixdown_path 150 | Dictionary with additional information from the setup step. 151 | 152 | Returns 153 | ------- 154 | out: iter(tuple) 155 | An iterator for which each element is a tuple to be sent to functions like 156 | `subprocess.run`. 157 | """ 158 | out = ( 159 | "blender --background {blendfile} --python {mixdown_py_normalized}" 160 | " --disable-autoexec -- {render_mixdown_path}".format(**cfg, **vars(clargs), **kwargs) 161 | ) 162 | out = ( 163 | "blender", 164 | "--background", 165 | clargs.blendfile, 166 | "--python", 167 | kwargs["mixdown_py_normalized"], 168 | "--disable-autoexec", 169 | "--", 170 | kwargs["render_mixdown_path"], 171 | ) 172 | LOGGER.debug("CMD-MIXDOWN: {cmd}".format(cmd=" ".join(out))) 173 | return iter((out,)) 174 | 175 | 176 | def get_commands_concatenate(cfg, clargs, **kwargs): 177 | """ 178 | Create the command to concatenate the available video chunks generated 179 | beforehand. 180 | 181 | Parameters 182 | ---------- 183 | cfg: dict 184 | Configuration dictionary. 185 | clargs: Namespace 186 | Command line arguments (normalized). 187 | kwargs: dict 188 | MANDATORY chunks_file_path, render_video_path 189 | Dictionary with additional information from the setup step. 190 | 191 | Returns 192 | ------- 193 | out: iter(tuple) 194 | An iterator for which each element is a tuple to be sent to functions like 195 | `subprocess.run`. 196 | """ 197 | out = ( 198 | "ffmpeg", 199 | "-stats", 200 | "-f", 201 | "concat", 202 | "-safe", 203 | "-0", 204 | "-i", 205 | kwargs["chunks_file_path"], 206 | "-c", 207 | "copy", 208 | "-y", 209 | kwargs["render_video_path"], 210 | ) 211 | LOGGER.debug("CMD-CONCATENATE: {cmd}".format(cmd=" ".join(out))) 212 | return iter((out,)) 213 | 214 | 215 | def get_commands_join(cfg, clargs, **kwargs): 216 | """ 217 | Create the command to join the available audio mixdown and video generated 218 | beforehand. 219 | 220 | Parameters 221 | ---------- 222 | cfg: dict 223 | Configuration dictionary. 224 | clargs: Namespace 225 | Command line arguments (normalized). 226 | kwargs: dict 227 | MANDATORY chunks_file_path, render_video_path 228 | Dictionary with additional information from the setup step. 229 | 230 | Returns 231 | ------- 232 | out: iter(tuple) 233 | An iterator for which each element is a tuple to be sent to functions like 234 | `subprocess.run`. 235 | """ 236 | out = ( 237 | "ffmpeg", 238 | "-stats", 239 | "-i", 240 | kwargs["render_video_path"], 241 | "-i", 242 | kwargs["render_mixdown_path"], 243 | "-map", 244 | "0:v:0", 245 | "-c:v", 246 | "copy", 247 | "-map", 248 | "1:a:0", 249 | "-c:a", 250 | "aac", 251 | "-b:a", 252 | "320k", 253 | "-y", 254 | kwargs["render_audiovideo_path"], 255 | ) 256 | LOGGER.debug("CMD-JOIN: {cmd}".format(cmd=" ".join(out))) 257 | return iter((out,)) 258 | 259 | 260 | def get_commands(cfg, clargs, what="", **kwargs): 261 | """ 262 | Delegates the creation of commands lists to appropriate functions based on 263 | `what` parameter. 264 | 265 | Parameters 266 | ---------- 267 | cfg: dict 268 | Configuration dictionary. 269 | clargs: Namespace 270 | Command line arguments (normalized). 271 | what: str (default = '') 272 | Determines the returned value (see: Returns[out]). 273 | kwargs: dict 274 | MANDATORY -- see individual functions for the list of mandatory keys 275 | Dictionary with additional information from the setup step. 276 | 277 | Returns 278 | ------- 279 | out: iter or (str, iter) 280 | |- what == '' is True 281 | An iterator with elements of the type (str) for determining the order in 282 | which to call the functions in the setup step. 283 | NOTE: it skipps the "internal use only" functions. 284 | |- else 285 | A tuple with the 1st element as a tag (the `what` parameter) and the 2nd 286 | element as the iterator of the actual commands. 287 | """ 288 | get_commands_f = OrderedDict( 289 | ( 290 | # internal use only 291 | ("probe", get_commands_probe), 292 | ("chunk", get_commands_chunk), 293 | # direct connection to command line arguments - in order of execution 294 | ("mixdown", get_commands_mixdown), 295 | ("video", get_commands_video), 296 | ("concatenate", get_commands_concatenate), 297 | ("join", get_commands_join), 298 | ) 299 | ) 300 | 301 | return ( 302 | islice(get_commands_f, 2, None) 303 | if what == "" 304 | else (what, get_commands_f[what](cfg, clargs, **kwargs)) 305 | ) 306 | 307 | 308 | def get_commands_all(cfg, clargs, **kwargs): 309 | """ 310 | Prepare the list of commands to be executed depending on the command line 311 | arguments. 312 | 313 | Parameters 314 | ---------- 315 | cfg: dict 316 | Configuration dictionary. 317 | clargs: Namespace 318 | Command line arguments (normalized). 319 | kwargs: dict 320 | MANDATORY -- see individual functions for the list of mandatory keys 321 | Dictionary with additional information from the setup step. 322 | 323 | Returns 324 | ------- 325 | out: iter((str, tuple)) 326 | An iterator for which each element is a (str, iter(tuple)). The string 327 | value is for tagging the iterator command list (2nd element) for filtering 328 | later based on the given command line arguments. 329 | """ 330 | end = "_only" 331 | out = filter(lambda x: x[0].endswith(end), vars(clargs).items()) 332 | out = map(lambda x: (x[0][: -len(end)], x[1]), out) 333 | order = list(get_commands(cfg, clargs)) 334 | out = sorted(out, key=lambda x: order.index(x[0])) 335 | out = ( 336 | map(lambda k: k[0], out) 337 | if all(map(lambda k: not k[1], out)) 338 | else map(lambda k: k[0], filter(lambda k: k[1], out)) 339 | ) 340 | out = map(lambda k: get_commands(cfg, clargs, k, **kwargs), out) 341 | return out 342 | -------------------------------------------------------------------------------- /bpsrender/config.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | import logging as lg 18 | import multiprocessing as mp 19 | import os.path as osp 20 | 21 | CONFIG = { 22 | "logger": "BPS", 23 | "cpu_count": min(int(mp.cpu_count() / 2), 6), 24 | "bs_path": osp.join(osp.dirname(osp.abspath(__file__)), "bscripts"), 25 | "frame_pad": 7, 26 | "parts_folder": "bpsrender", 27 | "chunks_file": "chunks.txt", 28 | "video_file": "video{}", 29 | "pre": {"work": "»", "done": "•", "skip": "~"}, 30 | "probe_py": "probe.py", 31 | "mixdown_py": "mixdown.py", 32 | "video_py": "video.py", 33 | } 34 | 35 | LOGGER = lg.getLogger(CONFIG["logger"]) 36 | LOGLEV = [lg.INFO, lg.DEBUG] 37 | LOGLEV = [None] + sorted(LOGLEV, reverse=True) 38 | -------------------------------------------------------------------------------- /bpsrender/helpers.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | from collections import deque 18 | from shutil import which 19 | 20 | 21 | class BSError(Exception): 22 | """ 23 | Custom Exception raised if Blender is called with a python script argument 24 | and gives error while trying to execute the script. 25 | """ 26 | 27 | pass 28 | 29 | 30 | class ToolError(Exception): 31 | """Raised if external dependencies aren't found on system. 32 | """ 33 | 34 | pass 35 | 36 | 37 | def checktools(tools): 38 | tools = [(t, which(t) or "") for t in tools] 39 | check = {"tools": tools, "test": all(map(lambda x: x[1], tools))} 40 | if not check["test"]: 41 | msg = ["BPSRender couldn't find external dependencies:"] 42 | msg += [ 43 | "[{check}] {tool}: {path}".format( 44 | check="v" if path is not "" else "X", tool=tool, path=path or "NOT FOUND" 45 | ) 46 | for tool, path in check["tools"] 47 | ] 48 | msg += [ 49 | ( 50 | "Check if you have them properly installed and available in the PATH" 51 | " environemnt variable." 52 | ), 53 | "Exiting...", 54 | ] 55 | raise ToolError("\n".join(msg)) 56 | 57 | 58 | def checkblender(what, search, cp, s): 59 | """ 60 | IMPURE 61 | Check Blender output for python script execution error. 62 | 63 | Parameters 64 | ---------- 65 | what: str 66 | A tag used in the exception message. 67 | search: iter(str) 68 | One or more string(s) to search for in Blender's output. 69 | cp: Popen 70 | Blender subprocess. 71 | s: PIPE 72 | Blender's output. 73 | 74 | Returns 75 | ------- 76 | out: PIPE 77 | The same pipe `s` is returned so that it can be iterated over on later 78 | steps. 79 | """ 80 | if not isinstance(search, list): 81 | search = [search] 82 | for search_item in search: 83 | if search_item in s: 84 | message = ( 85 | "Script {what} was not properly executed in" " Blender".format(what=what), 86 | "CMD: {cmd}".format(what=what, cmd=" ".join(cp.args)), 87 | "DUMP:".format(what=what), 88 | s, 89 | ) 90 | raise BSError("\n".join(message)) 91 | return s 92 | 93 | 94 | def printw(cfg, text, s="\n", e="...", p="", **kwargs): 95 | p = p or cfg["pre"]["work"] 96 | print("{s}{p} {}{e}".format(text, s=s, e=e, p=p), **kwargs) 97 | 98 | 99 | def printd(cfg, text, s="", e=".", p="", **kwargs): 100 | p = p or cfg["pre"]["done"] 101 | printw(cfg, text, s=s, e=e, p=p, **kwargs) 102 | 103 | 104 | def prints(cfg, text, s="", e=".", p="", **kwargs): 105 | p = p or cfg["pre"]["skip"] 106 | printw(cfg, text, s=s, e=e, p=p, **kwargs) 107 | 108 | 109 | def kickstart(it): 110 | deque(it, maxlen=0) 111 | -------------------------------------------------------------------------------- /bpsrender/setup.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | # IMPURE 18 | import logging as lg 19 | import os 20 | import os.path as osp 21 | from functools import reduce 22 | from itertools import starmap 23 | 24 | from .calls import call 25 | from .commands import get_commands, get_commands_all 26 | from .config import LOGGER, LOGLEV 27 | from .helpers import kickstart 28 | 29 | 30 | def setup_bspy(cfg, clargs, **kwargs): 31 | """ 32 | Normalize the names of the script to be ran in Blender for certain steps. 33 | Eg. the probe step depends on the script located in 34 | `bpsrender/cfg['probe_py']`. 35 | 36 | Parameters 37 | ---------- 38 | cfg: dict 39 | Configuration dictionary. 40 | clargs: Namespace 41 | Command line arguments (normalized). 42 | kwargs: dict 43 | 44 | Returns 45 | ------- 46 | out: dict 47 | Dictoinary to be used in call steps. 48 | """ 49 | out = filter(lambda x: x[0].endswith("_py"), cfg.items()) 50 | out = starmap(lambda k, v: ("{}_normalized".format(k), osp.join(cfg["bs_path"], v)), out) 51 | return dict(out) 52 | 53 | 54 | def setup_probe(cfg, clargs, **kwargs): 55 | """ 56 | IMPURE 57 | Call Blender and extract information that will be necessary for later 58 | steps. 59 | 60 | Parameters 61 | ---------- 62 | cfg: dict 63 | Configuration dictionary. 64 | clargs: Namespace 65 | Command line arguments (normalized). 66 | kwargs: dict 67 | MANDATORY -- see individual functions for the list of mandatory keys 68 | Dictionary with additional information from the previous setup step. 69 | 70 | Returns 71 | ------- 72 | out: dict 73 | Dictoinary to be used in call steps. 74 | """ 75 | return call(cfg, clargs, get_commands(cfg, clargs, "probe", **kwargs), **kwargs) 76 | 77 | 78 | def setup_paths(cfg, clargs, **kwargs): 79 | """ 80 | Figure out appropriate path locations to store output for parts and final 81 | render. 82 | 83 | Parameters 84 | ---------- 85 | cfg: dict 86 | Configuration dictionary. 87 | clargs: Namespace 88 | Command line arguments (normalized). 89 | kwargs: dict 90 | MANDATORY -- see individual functions for the list of mandatory keys 91 | Dictionary with additional information from the previous setup step. 92 | 93 | Returns 94 | ------- 95 | out: dict 96 | Dictionary storing all relevant information pertaining to folder and file 97 | paths. 98 | 99 | Note 100 | ---- 101 | It also creates the folder structure 'render/parts' where 102 | `clargs.blendfile` is stored on disk. 103 | """ 104 | render_parts_path = osp.join(clargs.output, cfg["parts_folder"]) 105 | name = osp.splitext(osp.basename(clargs.blendfile))[0] 106 | render_mixdown_path = osp.join(render_parts_path, "{}_m.flac".format(name)) 107 | render_chunk_path = osp.join(render_parts_path, "{}_c_{}".format(name, "#" * cfg["frame_pad"])) 108 | render_video_path = osp.join(render_parts_path, "{}_v{}".format(name, kwargs["ext"])) 109 | render_audiovideo_path = osp.join(clargs.output, "{}{}".format(name, kwargs["ext"])) 110 | chunks_file_path = osp.join(render_parts_path, cfg["chunks_file"]) 111 | 112 | out = { 113 | "render_path": clargs.output, 114 | "render_parts_path": render_parts_path, 115 | "chunks_file_path": chunks_file_path, 116 | "render_chunk_path": render_chunk_path, 117 | "render_video_path": render_video_path, 118 | "render_mixdown_path": render_mixdown_path, 119 | "render_audiovideo_path": render_audiovideo_path, 120 | } 121 | return out 122 | 123 | 124 | def setup_folders_hdd(cfg, clargs, **kwargs): 125 | """ 126 | IMPURE 127 | Prepares the folder structure `cfg['render']/cfg['parts']'`. 128 | 129 | Parameters 130 | ---------- 131 | cfg: dict 132 | Configuration dictionary. 133 | clargs: Namespace 134 | Command line arguments (normalized). 135 | kwargs: dict 136 | Dictionary with additional information from the previous setup step. 137 | 138 | Returns 139 | ------- 140 | out: (iter((str, iter(tuple))), dict) 141 | 1st element: see commands.py:get_commands_all 142 | 2nd elment: the keyword arguments used by calls.py:call 143 | """ 144 | # create folder structure if it doesn't exist already only if 145 | # appropriate command line arguments are given 146 | do_it = filter(lambda x: x[0].endswith("_only"), vars(clargs).items()) 147 | do_it = all(map(lambda x: not x[1], do_it)) 148 | do_it = not clargs.dry_run and clargs.video_only or clargs.mixdown_only or do_it 149 | do_it and os.makedirs(kwargs["render_parts_path"], exist_ok=True) 150 | return {} 151 | 152 | 153 | def setup(cfg, clargs): 154 | """ 155 | IMPURE -- setup_paths 156 | Prepares the folder structure 'render/parts', the appropriate command lists 157 | to be called and the keyword arguments to be passed to call functions 158 | (calls.py). 159 | 160 | Parameters 161 | ---------- 162 | cfg: dict 163 | Configuration dictionary. 164 | clargs: Namespace 165 | Command line arguments (normalized). 166 | kwargs: dict 167 | Dictionary with additional information from the previous setup step. 168 | 169 | Returns 170 | ------- 171 | out: (iter((str, iter(tuple))), dict) 172 | 1st element: see commands.py:get_commands_all 173 | 2nd elment: the keyword arguments used by calls.py:call 174 | """ 175 | setups_f = (setup_bspy, setup_probe, setup_paths, setup_folders_hdd) 176 | lg.basicConfig(level=LOGLEV[min(clargs.verbose, len(LOGLEV) - 1)]) 177 | 178 | kwargs = dict(reduce(lambda acc, sf: {**acc, **sf(cfg, clargs, **acc)}, setups_f, {})) 179 | 180 | LOGGER.info("Setup:") 181 | kickstart(starmap(lambda k, v: LOGGER.info("{}: {}".format(k, v)), kwargs.items())) 182 | return get_commands_all(cfg, clargs, **kwargs), kwargs 183 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | 3 | line-length=100 4 | include = '\.py$' 5 | exclude = ''' 6 | ( 7 | /( 8 | \.git 9 | )/ 10 | ) 11 | ''' -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (C) 2016-2019 by Razvan Radulescu, Nathan Lovato, and contributors 3 | # 4 | # This file is part of Power Sequencer. 5 | # 6 | # Power Sequencer is free software: you can redistribute it and/or modify it under the terms of the 7 | # GNU General Public License as published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # Power Sequencer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 11 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License along with Power Sequencer. If 15 | # not, see . 16 | # 17 | from setuptools import setup 18 | 19 | 20 | def readme(): 21 | with open("README.rst") as f: 22 | return f.read() 23 | 24 | 25 | if __name__ == "__main__": 26 | setup( 27 | name="bpsrender", 28 | version="0.1.40.post1", 29 | description="Blender Power Sequencer Renderer", 30 | long_description=readme(), 31 | classifiers=[ 32 | "Development Status :: 4 - Beta", 33 | "Environment :: Console", 34 | "Intended Audience :: End Users/Desktop", 35 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 36 | "Natural Language :: English", 37 | "Programming Language :: Python :: 3.3", 38 | "Programming Language :: Python :: 3.4", 39 | "Programming Language :: Python :: 3.5", 40 | "Programming Language :: Python :: 3.6", 41 | "Programming Language :: Python :: 3.7", 42 | "Topic :: Text Processing :: Linguistic", 43 | "Topic :: Multimedia :: Video", 44 | "Topic :: Utilities", 45 | ], 46 | url="https://gitlab.com/razcore/BPSRender", 47 | keywords="blender render parallel multiprocess speedup utility" " productivty", 48 | author="Răzvan C. Rădulescu", 49 | author_email="razcore.art@gmail.com", 50 | license="GPLv3", 51 | packages=["bpsrender"], 52 | install_requires=["tqdm"], 53 | zip_safe=False, 54 | entry_points={"console_scripts": ["bpsrender=bpsrender.__main__:main"]}, 55 | include_package_data=True, 56 | ) 57 | --------------------------------------------------------------------------------