├── .gitignore
├── LICENSE
├── README.md
└── restrict.py
/.gitignore:
--------------------------------------------------------------------------------
1 | *
2 |
3 | !.gitignore
4 | !restrict.py
5 | !LICENSE
6 | !README.md
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Restricted-WebM
2 |
3 | A script to produce WebMs within a certain file size limit.
4 |
5 | The goal is to automatically produce decent looking WebMs. Little to no user input or prior experience required.
6 |
7 | ## Usage
8 |
9 | ```
10 | Usage: restrict.py [OPTIONS] INPUT [INPUT]...
11 |
12 | Input:
13 | Absolute or relative path to a video/image
14 |
15 | Common options:
16 | -h, --help show help
17 | -q, --quiet suppress non-error output
18 | -v, --verbose print verbose information
19 | -a, --audio enable audio output
20 | -s, --size SIZE limit max. output file size in MB (def: 3)
21 | -f, --filters FILTERS use custom ffmpeg filters
22 | -p, --passes {1,2} specify number of passes (def: 2)
23 | -u, --undershoot RATIO specify undershoot ratio (def: 0.75)
24 | -i, --iterations ITER iterations for each bitrate mode (def: 3)
25 | -t, --threads THREADS enable multithreading
26 | -ss, --start TIME start encoding at the specified time
27 | -to, --end TIME end encoding at the specified time
28 | -fs, --force-stereo force stereo audio output
29 | -bf, --basic-format restrict output to one video/audio stream
30 |
31 | Subtitle options:
32 | --subtitles enable subtitle output
33 | --mkv-fallback allow usage of MKV for image-based subtitles
34 | --burn-subs discard soft subtitles after hardsubbing
35 |
36 | Advanced video options:
37 | --vp9 use VP9 instead of VP8
38 | --crf use constrained quality instead of VBR
39 | --no-qmax skip first bitrate mode (VBR with qmax)
40 | --no-cbr skip last bitrate mode (CBR with frame dropping)
41 | --bpp BPP set custom bpp threshold (def: 0.075)
42 | --transparency preserve input transparency
43 | --pix-fmt FORMAT choose color space (def: yuv420p)
44 | --min-height HEIGHT force min. output height (def: 240)
45 | --max-height HEIGHT force max. output height
46 | --min-fps FPS force min. frame rate (def: 24)
47 | --max-fps FPS force max. frame rate
48 |
49 | Advanced audio options:
50 | --opus use and allow Opus as audio codec
51 | --no-copy disable stream copying
52 | --force-copy force-copy compatible (!) audio streams
53 | --min-audio RATE force min. channel bitrate in Kbps (def: 24)
54 | --max-audio RATE force max. channel bitrate in Kbps
55 |
56 | Misc. options:
57 | --no-filter-firstpass disable user filters during the first pass
58 | --ffmpeg-verbosity LEVEL change FFmpeg command verbosity (def: stats)
59 | --debug only print ffmpeg commands
60 |
61 | All output will be saved in 'webm_done/'.
62 | 'webm_done/' is located in the same directory as the input.
63 | ```
64 |
65 | ## Requirements
66 |
67 | * Python >= 3.6
68 | * [FFmpeg (incl. ffprobe)](https://www.ffmpeg.org/)
69 |
70 | The FFmpeg and ffprobe executables must be in your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) or - Windows CMD only - in the same location as the script.
71 |
72 | ### Optional
73 | * [colorama](https://github.com/tartley/colorama) for colorized terminal output on Windows
74 |
75 | ## Examples
76 |
77 | The following examples showcase the most basic commands to create WebMs for 4chan (length limitations aren't addressed).
78 |
79 | #### Limit 3MB, no audio (for all boards except /b/)
80 |
81 | ```
82 | restrict.py INPUT [INPUT]...
83 | ```
84 |
85 | #### Limit 4MB, with audio (for /gif/)
86 |
87 | ```
88 | restrict.py -a -s 4 INPUT [INPUT]...
89 | ```
90 |
91 | #### Limit 6MB, with audio (for /wsg/)
92 |
93 | ```
94 | restrict.py -a -s 6 INPUT [INPUT]...
95 | ```
96 |
97 | ***
98 |
99 | For further information consult the [wiki](https://github.com/HelpSeeker/Restricted-WebM/wiki)!
100 |
--------------------------------------------------------------------------------
/restrict.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import argparse
4 | import json
5 | import os
6 | import subprocess
7 | import sys
8 | from textwrap import dedent, indent
9 |
10 | # ANSI escape codes don't work on Windows, unless the user jumps through
11 | # additional hoops (either by using 3rd-party software or enabling VT100
12 | # emulation with Windows 10)
13 | # colorama solves this issue by converting ANSI escape codes into the
14 | # appropriate win32 calls (only on Windows)
15 | # If colorama isn't available, disable colorized output on Windows
16 | colors = True
17 | try:
18 | import colorama
19 | colorama.init()
20 | except ModuleNotFoundError:
21 | if os.name == "nt":
22 | colors = False
23 |
24 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 | # Global constants
26 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 |
28 | class ExitCodes:
29 | """Store exit codes for non-successful execution."""
30 |
31 | DEP = 1 # missing required software
32 | OPT = 2 # invalid user-specified option
33 | RUN = 3 # misc. runtime error
34 | SIZE = 4 # failed to fit all videos into size range
35 | INT = 5 # early termination was requested by the user (i.e. Ctrl+C)
36 |
37 |
38 | class Colors:
39 | """Store ANSI escape codes for colorized output."""
40 |
41 | # https://en.wikipedia.org/wiki/ANSI_escape_code#Colors
42 | HEADER = '\033[1;36m' # Cyan (bold)
43 | FILE = '\033[35m' # Magenta
44 | INFO = '\033[32m' # Green
45 | ERROR = '\033[31m' # Red
46 | WARNING = '\033[33m' # Yellow
47 | SUCCESS = '\033[32m' # Green
48 | DEFAULT = '\033[39m' # Default foreground color
49 | BOLD = '\033[1m'
50 | RESET = '\033[0m'
51 |
52 | def disable(self):
53 | """Disable colorized output by removing escape codes."""
54 | self.HEADER = ''
55 | self.FILE = ''
56 | self.INFO = ''
57 | self.ERROR = ''
58 | self.WARNING = ''
59 | self.SUCCESS = ''
60 | self.DEFAULT = ''
61 | self.BOLD = ''
62 | self.RESET = ''
63 |
64 |
65 | # Create objects to hold constants
66 | status = ExitCodes()
67 | size_fail = False
68 | fgcolors = Colors()
69 | if not colors:
70 | fgcolors.disable()
71 |
72 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 | # Classes
74 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75 |
76 | class DefaultOptions:
77 | """Stores general options"""
78 |
79 | # Set output verbosity
80 | # 0 -> quiet mode (only warnings and errors)
81 | # 1 -> default mode (0 + basic progress information)
82 | # 2 -> verbose mode (0 + 1 + FFmpeg options + size info)
83 | VERBOSITY = 1
84 |
85 | # Enable audio output
86 | # Converts all available audio streams by default
87 | # Only has an effect, when the input comes with at least one audio stream
88 | AUDIO = False
89 |
90 | # Upper size limit in MB
91 | LIMIT = 3
92 |
93 | # FFmpeg filter string (https://ffmpeg.org/ffmpeg-filters.html)
94 | # Gets passed directly to FFmpeg (and will throw errors if wrong)
95 | F_USER = None
96 |
97 | # Number of passes to use during 1st and 2nd bitrate mode
98 | # (CBR will always be done with a single pass)
99 | # 1 -> only really useful for more consistent quality for very low bitrate
100 | # encodes or when converting GIFs while preserving transparency
101 | # 2 -> should always be preferred as libvpx doesn't offer effective
102 | # bitrate control for single pass encodes
103 | PASSES = 2
104 |
105 | # Lower size limit as percentage of the upper one
106 | # 0 to disable, >0.95 (or >0.9 with --crf) is discouraged
107 | UNDER = 0.75
108 |
109 | # How many attempts to make for each bitrate mode
110 | # This is an upper limit, the remaining attempts of a mode may be skipped
111 | # if the file size doesn't change enough (<1%)
112 | ITERS = 3
113 |
114 | # How many threads libvpx should use
115 | # FFmpeg discourages >16, but VP8 encoding doesn't scale well beyond 4-6
116 | THREADS = 1
117 |
118 | # How to trim the input video (same as FFmpeg's -ss and -to)
119 | # Values must be in seconds (int/float) or need to be passed to valid_time()
120 | # Negative time values aren't supported
121 | GLOBAL_START = None
122 | GLOBAL_END = None
123 |
124 | # Force 2 channels per audio stream
125 | # Useful to avoid wasting bitrate on surround sound or to use libopus
126 | # for otherwise unsupported channel configurations
127 | # IMPORTANT: Also force-converts mono input to stereo
128 | FORCE_STEREO = False
129 |
130 | # Limit the output to 1 video + 1 audio stream (no effect on subtitles)
131 | BASIC_FORMAT = False
132 |
133 | # Enable subtitle output
134 | # Input with image-based subtitles will be skipped by default
135 | SUBS = False
136 |
137 | # Use MKV as fallback container for input with image-based subtitles,
138 | # instead of skipping the files entirely
139 | # Has no effect if subtitle output is disabled
140 | MKV_FALLBACK = False
141 |
142 | # Map input subtitles, but disable subtitle output
143 | # Useful to prevent unnecessary soft subs in the output while hardsubbing
144 | BURN_SUBS = False
145 |
146 | # What video encoder to use
147 | # libvpx -> VP8
148 | # libvpv-vp9 -> VP9
149 | # AV1 (via libaom or libsvt_av1) isn't supported
150 | V_CODEC = "libvpx"
151 |
152 | # Use CQ (constrained quality) instead of classic VBR
153 | CRF = False
154 |
155 | # Skip 1st bitrate mode (VBR or CQ + min. quality)
156 | NO_QMAX = False
157 |
158 | # Skip 3rd bitrate mode (CBR; also allowed to drop frames)
159 | NO_CBR = False
160 |
161 | # Bits per pixel threshold (steers downscaling and frame rate reduction)
162 | # Personal recommendations for VP8:
163 | # < 0.01: bad quality
164 | # ~ 0.04: med quality
165 | # > 0.075: good quality
166 | BPP_THRESH = 0.075
167 |
168 | # Preserve input transparency
169 | # Overrides any value of pix_fmt with "yuva420p"
170 | TRANSPARENCY = False
171 |
172 | # Pixel format to use
173 | # See "ffmpeg -h encoder=libvpx(-vp9)" for a full list of supported values
174 | PIX_FMT = "yuv420p"
175 |
176 | # Min. height threshold for automatic downscaling
177 | # Has no influence on input that is already below the threshold
178 | MIN_HEIGHT = 240
179 |
180 | # Max. height threshold for automatic downscaling
181 | # Can be used to force-downscale, but has to be higher than min_height
182 | MAX_HEIGHT = None
183 |
184 | # Min. fps threshold for automatic frame rate reduction
185 | # Has no influence on input that is already below the threshold
186 | MIN_FPS = 24
187 |
188 | # Max. fps threshold for automatic frame rate reduction
189 | # Can be used to force a lower frame rate, but has to be higher than min_fps
190 | MAX_FPS = None
191 |
192 | # What audio encoder to use
193 | # libvorbis -> Vorbis
194 | # libopus -> Opus (fails on some surround sound configurations)
195 | # opus -> Opus (not tested, but it should work in theory)
196 | A_CODEC = "libvorbis"
197 |
198 | # Disable audio copying (i.e. always reencode all audio)
199 | NO_COPY = False
200 |
201 | # Copy audio streams regardless of their bitrate
202 | # Audio streams will still be reencoded in case of unsupported audio
203 | # formats, -ss or audio filters
204 | FORCE_COPY = False
205 |
206 | # Min. audio threshold for automatic audio bitrate selection
207 | # Represents the audio bitrate per channel (e.g. 24 -> 48Kbps for stereo)
208 | MIN_AUDIO = 24
209 |
210 | # Max. audio threshold for automatic audio bitrate selection
211 | # Represents the audio bitrate per channel (e.g. 80 -> 160Kbps for stereo)
212 | # Has to be higher than min_audio and >6 (limit for libvorbis)
213 | MAX_AUDIO = None
214 |
215 | # Disable user set filters during the 1st of a 2-pass encode
216 | # Useful when very demanding filters are used (e.g. nlmeans)
217 | # Has no influence on automatically used filters (scale and fps)
218 | NO_FILTER_FIRSTPASS = False
219 |
220 | # Set FFmpeg verbosity (ffmpeg -v/-loglevel)
221 | # Special option "stats" is a shortcut for "-v error -stats"
222 | FFMPEG_VERBOSITY = "stats"
223 |
224 | # Enable debug mode
225 | # Prints FFmpeg commands without executing them
226 | DEBUG = False
227 |
228 |
229 | class CustomArgumentParser(argparse.ArgumentParser):
230 | """Override ArgumentParser's automatic help text."""
231 |
232 | def format_help(self):
233 | """Return custom help text."""
234 | help_text = dedent(f"""\
235 | RestrictedWebM is a script to produce WebMs within a certain size range.
236 |
237 | Usage: {self.prog} [OPTIONS] INPUT [INPUT]...
238 |
239 | Input:
240 | Absolute or relative path to a video/image
241 |
242 | Common options:
243 | -h, --help show help
244 | -q, --quiet suppress non-error output
245 | -v, --verbose print verbose information
246 | -a, --audio enable audio output
247 | -s, --size SIZE limit max. output file size in MB (def: {self.get_default("limit")})
248 | -f, --filters FILTERS use custom ffmpeg filters
249 | -p, --passes {{1,2}} specify number of passes (def: {self.get_default("passes")})
250 | -u, --undershoot RATIO specify undershoot ratio (def: {self.get_default("under")})
251 | -i, --iterations ITER iterations for each bitrate mode (def: {self.get_default("iters")})
252 | -t, --threads THREADS enable multithreading
253 | -ss, --start TIME start encoding at the specified time
254 | -to, --end TIME end encoding at the specified time
255 | -fs, --force-stereo force stereo audio output
256 | -bf, --basic-format restrict output to one video/audio stream
257 |
258 | Subtitle options:
259 | --subtitles enable subtitle output
260 | --mkv-fallback allow usage of MKV for image-based subtitles
261 | --burn-subs discard soft subtitles after hardsubbing
262 |
263 | Advanced video options:
264 | --vp9 use VP9 instead of VP8
265 | --crf use constrained quality instead of VBR
266 | --no-qmax skip first bitrate mode (VBR with qmax)
267 | --no-cbr skip last bitrate mode (CBR with frame dropping)
268 | --bpp BPP set custom bpp threshold (def: {self.get_default("bpp_thresh")})
269 | --transparency preserve input transparency
270 | --pix-fmt FORMAT choose color space (def: {self.get_default("pix_fmt")})
271 | --min-height HEIGHT force min. output height (def: {self.get_default("min_height")})
272 | --max-height HEIGHT force max. output height
273 | --min-fps FPS force min. frame rate (def: {self.get_default("min_fps")})
274 | --max-fps FPS force max. frame rate
275 |
276 | Advanced audio options:
277 | --opus use and allow Opus as audio codec
278 | --no-copy disable stream copying
279 | --force-copy force-copy compatible (!) audio streams
280 | --min-audio RATE force min. channel bitrate in Kbps (def: {self.get_default("min_audio")})
281 | --max-audio RATE force max. channel bitrate in Kbps
282 |
283 | Misc. options:
284 | --no-filter-firstpass disable user filters during the first pass
285 | --ffmpeg-verbosity LEVEL change FFmpeg command verbosity (def: {self.get_default("ffmpeg_verbosity")})
286 | --debug only print ffmpeg commands
287 |
288 | All output will be saved in '{self.get_default("out_dir")}/'.
289 | '{self.get_default("out_dir")}/' is located in the same directory as the input.
290 |
291 | For more information visit:
292 | https://github.com/HelpSeeker/Restricted-WebM/wiki
293 | """)
294 |
295 | return help_text
296 |
297 |
298 | class FileInfo:
299 | """Gathers information about output settings"""
300 |
301 | def __init__(self, in_path):
302 | """Initialize all properties."""
303 | # Subtitle-related
304 | self.image_subs = out_image_subs(in_path)
305 |
306 | # Path-related
307 | self.input = in_path
308 | self.dir = os.path.join(os.path.dirname(self.input), opts.out_dir)
309 | ext = f"{'mkv' if self.image_subs else 'webm'}"
310 | self.name = os.path.splitext(os.path.basename(self.input))[0]
311 | self.output = os.path.join(self.dir, f"{self.name}.{ext}")
312 | self.temp = os.path.join(self.dir, f"{self.name}_{opts.suffix}.{ext}")
313 |
314 | command = [
315 | "ffprobe", "-v", "error", "-show_format", "-show_streams",
316 | "-print_format", "json", self.input
317 | ]
318 | info = subprocess.run(command, stdout=subprocess.PIPE, check=False).stdout
319 | info = json.loads(info)
320 |
321 | # Check input file for basic validity
322 | # Needs to be done here as the following steps could already fail
323 | self.valid = self.is_valid(info)
324 | if not self.valid:
325 | return
326 |
327 | # Duration-related
328 | try:
329 | self.in_dur = float(info['format']['duration'])
330 | except KeyError:
331 | self.in_dur = self.brute_input_duration()
332 | self.out_dur = self.calc_output_duration()
333 |
334 | # Audio-related
335 | a_streams = [s for s in info['streams'] if s['codec_type'] == "audio"]
336 | self.a_rate, self.a_list, self.a_sample = self.audio_properties(a_streams)
337 |
338 | # Video-related
339 | self.v_rate = self.init_video_bitrate()
340 |
341 | v_stream = info['streams'][0]
342 | self.in_height, self.in_fps, self.ratio = self.video_properties(v_stream)
343 | self.out_height = self.in_height
344 | self.out_fps = self.in_fps
345 |
346 | def is_valid(self, info):
347 | """Test for basic pitfalls that would lead to FFmpeg failure."""
348 | streams = [s['codec_type'] for s in info['streams']]
349 | if self.image_subs and not opts.mkv_fallback:
350 | err(f"{self.input}: "
351 | "Conversion of image-based subtitles not supported!")
352 | return False
353 | if streams[0] != "video":
354 | err(f"{self.input}: "
355 | "Unsupported stream order (first stream not video)!")
356 | return False
357 | if [s for s in streams[1:] if s == "video"]:
358 | err(f"{self.input}: "
359 | "Files with more than one video stream not supported!")
360 | return False
361 |
362 | return True
363 |
364 | def brute_input_duration(self):
365 | """Brute-force detect input duration for GIFs and other images."""
366 | # Encodes input as AVC (fast) and reads duration from the output
367 | ffmpeg = [
368 | "ffmpeg", "-y", "-v", "error", "-i", self.input, "-map", "0:v",
369 | "-c:v", "libx264", "-preset", "ultrafast", "-crf", "51",
370 | f"{self.name}_{opts.suffix}_.mkv"
371 | ]
372 | ffprobe = [
373 | "ffprobe", "-v", "error", "-show_format", "-show_streams",
374 | "-print_format", "json", f"{self.name}_{opts.suffix}.mkv"
375 | ]
376 |
377 | subprocess.run(ffmpeg, check=False)
378 | info = subprocess.run(ffprobe, stdout=subprocess.PIPE, check=False).stdout
379 | info = json.loads(info)
380 |
381 | return float(info['format']['duration'])
382 |
383 | def calc_output_duration(self):
384 | """Calculate output duration."""
385 | if not (opts.global_start or opts.global_end):
386 | return self.in_dur
387 |
388 | start = 0
389 | end = self.in_dur
390 | if opts.global_start and opts.global_start < end:
391 | start = opts.global_start
392 | if opts.global_end and opts.global_end < end:
393 | end = opts.global_end
394 |
395 | return round(end - start, 3)
396 |
397 | def audio_properties(self, streams):
398 | """Gather various audio properties (e.g. bitrate, sample rate)."""
399 | if not opts.audio:
400 | return (0, [], None)
401 |
402 | c_list = [int(s['channels']) if not opts.force_stereo else 2
403 | for s in streams]
404 | if opts.basic_format:
405 | del c_list[1:]
406 | channels = sum(c_list)
407 |
408 | # Formula was originally based on my experience with stereo audio
409 | # for 4MB WebMs, but was later changed to accommodate more bitrates
410 | # and channels
411 | factor = opts.max_size*8 \
412 | / (self.out_dur*channels*4*1000) \
413 | / opts.a_factor
414 | c_rate = choose_audio_bitrate(factor)
415 |
416 | b_list = [c*c_rate for c in c_list]
417 | bitrate = sum(b_list)
418 |
419 | # Downsample necessary for lower bitrates with libvorbis
420 | if c_rate <= 6:
421 | sample = 8000
422 | elif c_rate <= 12:
423 | sample = 12000
424 | elif c_rate <= 16:
425 | sample = 24000
426 | else:
427 | sample = None
428 |
429 | return (bitrate, b_list, sample)
430 |
431 | def video_properties(self, stream):
432 | """Gather various video properties (e.g. height, fps)."""
433 | # If user scale/fps filter -> test encode
434 | # Read the effect (i.e. changed resolution / frame rate) from output
435 | if opts.user_scale or opts.user_fps:
436 | ffmpeg = [
437 | "ffmpeg", "-y", "-v", "error", "-i", self.input, "-vframes", "1",
438 | "-filter_complex", opts.f_user, f"{self.name}_{opts.suffix}.mkv"
439 | ]
440 | ffprobe = [
441 | "ffprobe", "-v", "error", "-show_format", "-show_streams",
442 | "-print_format", "json", f"{self.name}_{opts.suffix}.mkv"
443 | ]
444 |
445 | subprocess.run(ffmpeg, check=False)
446 | info = subprocess.run(ffprobe, stdout=subprocess.PIPE, check=False).stdout
447 | info = json.loads(info)
448 | stream = info['streams'][0]
449 |
450 | h = int(stream['height'])
451 | w = int(stream['width'])
452 | ratio = w/h
453 | try:
454 | num, den = stream['r_frame_rate'].split("/")
455 | fps = int(num)/int(den)
456 | except ValueError:
457 | fps = stream['r_frame_rate']
458 |
459 | return (h, fps, ratio)
460 |
461 | def init_video_bitrate(self):
462 | """Initialize video bitrate to theoretical value."""
463 | bitrate = int(opts.max_size*8 / (self.out_dur*1000) - self.a_rate)
464 | if bitrate <= 0:
465 | bitrate = opts.fallback_bitrate
466 |
467 | return bitrate
468 |
469 | def update_video_bitrate(self, size):
470 | """Update video bitrate based on output file size."""
471 | # Size ratio dictates overall bitrate change, but audio bitrate is const
472 | # (v+a) = (v_old+a) * (max/curr)
473 | # v = v_old * (max/curr) + (max/curr - 1) * a
474 | a_offset = int((opts.max_size/size - 1) * self.a_rate)
475 | new_rate = int(self.v_rate * opts.max_size/size + a_offset)
476 | min_rate = int(self.v_rate * opts.min_bitrate_ratio)
477 | # Force min. decrease (% of last bitrate)
478 | if min_rate < new_rate < self.v_rate:
479 | bitrate = min_rate
480 | else:
481 | bitrate = new_rate
482 |
483 | if bitrate <= 0:
484 | bitrate = opts.fallback_bitrate
485 |
486 | self.v_rate = bitrate
487 |
488 | def update_filters(self):
489 | """Update filter values based on the current video bitrate."""
490 | if opts.user_scale and opts.user_fps:
491 | return
492 |
493 | # Perform frame rate drop
494 | if not opts.user_fps:
495 | possible_fps = [
496 | f for f in opts.fps_list
497 | if self.v_rate*1000 / (f*self.ratio*self.in_height**2)
498 | >= opts.bpp_thresh / 2
499 | ]
500 | if not possible_fps:
501 | possible_fps = [opts.min_fps]
502 | fps = possible_fps[0]
503 |
504 | # Enfore frame rate thresholds
505 | if fps < opts.min_fps:
506 | fps = opts.min_fps
507 | if opts.max_fps and fps > opts.max_fps:
508 | fps = opts.max_fps
509 | if fps > self.in_fps:
510 | fps = self.in_fps
511 | self.out_fps = fps
512 |
513 | # Perform downscale
514 | if not opts.user_scale:
515 | possible_heights = [
516 | h for h in range(self.in_height, 0, opts.height_reduction)
517 | if self.v_rate*1000 / (self.out_fps*self.ratio*h**2)
518 | >= opts.bpp_thresh
519 | ]
520 | if not possible_heights:
521 | possible_heights = [opts.min_height]
522 | height = possible_heights[0]
523 |
524 | # Enforce height thresholds
525 | if height < opts.min_height:
526 | height = opts.min_height
527 | if opts.max_height and height > opts.max_height:
528 | height = opts.max_height
529 | if height > self.in_height:
530 | height = self.in_height
531 | self.out_height = height
532 |
533 |
534 | class ConvertibleFile:
535 | """Assembles FFmpeg settings"""
536 |
537 | def __init__(self, info):
538 | """Initialize all properties"""
539 | self.info = info
540 | self.valid = self.info.valid
541 | if not self.valid:
542 | return
543 |
544 | # Verbosity-related
545 | if opts.ffmpeg_verbosity == "stats":
546 | self.verbosity = ["-v", "error", "-stats"]
547 | else:
548 | self.verbosity = ["-v", opts.ffmpeg_verbosity]
549 |
550 | # Trim/input-related
551 | self.input = ["-i", self.info.input]
552 | if opts.global_start and opts.global_start < self.info.in_dur:
553 | self.input = ["-ss", str(opts.global_start)] + self.input
554 | if opts.global_end and opts.global_end <= self.info.in_dur:
555 | self.input.extend(["-t", str(self.info.out_dur)])
556 |
557 | # Map-related
558 | self.map = ["-map", "0:v"]
559 | if opts.subs or opts.burn_subs:
560 | self.map.extend(["-map", "0:s?"])
561 | if opts.audio:
562 | a_streams = [
563 | ["-map", f"0:a:{i}?"]
564 | for i in range(len(self.info.a_list))
565 | if opts.audio and not (opts.basic_format and i > 0)
566 | ]
567 | for s in a_streams:
568 | self.map.extend(s)
569 |
570 | # Subtitle-related
571 | if opts.burn_subs:
572 | self.subs = ["-sn"]
573 | elif self.info.image_subs:
574 | self.subs = ["-c:s", "copy"]
575 | elif opts.subs:
576 | self.subs = ["-c:s", "webvtt"]
577 | else:
578 | self.subs = []
579 |
580 | # Audio-related
581 | self.audio = self.init_audio_flags()
582 |
583 | # These get updated before each encoding attempt
584 | self.video = []
585 | self.filter = []
586 |
587 | def init_audio_flags(self):
588 | """Initialize audio-related FFmpeg options."""
589 | audio = []
590 | a_streams = [i for i in range(len(self.info.a_list))
591 | if opts.audio and not (opts.basic_format and i > 0)]
592 | for s in a_streams:
593 | if audio_copy(self, s):
594 | audio.extend([f"-c:a:{s}", "copy"])
595 | elif opts.a_codec == "libopus" and opus_fallback(self.info.input, s):
596 | audio.extend([f"-c:a:{s}", opts.fallback_codec])
597 | audio.extend([f"-b:a:{s}", f"{self.info.a_list[s]}K"])
598 | else:
599 | audio.extend([f"-c:a:{s}", opts.a_codec])
600 | audio.extend([f"-b:a:{s}", f"{self.info.a_list[s]}K"])
601 |
602 | # -ac/-ar have no effect without audio encoding
603 | # there's no need for additional checks
604 | if opts.force_stereo:
605 | audio.extend(["-ac", "2"])
606 | if self.info.a_sample is not None:
607 | audio.extend(["-ar", str(self.info.a_sample)])
608 |
609 | return audio
610 |
611 | def update_video_flags(self, mode):
612 | """Update video-related FFmpeg options."""
613 | self.video = ["-c:v", opts.v_codec]
614 | self.video.extend(["-deadline", "good"])
615 | # -cpu-used defined in call_ffmpeg, since it depends on the pass
616 |
617 | # TO-DO:
618 | # Test how strong temporal filtering influences high quality encodes
619 | # Figure out how/why alpha channel support cuts short GIFs during 2-pass
620 | self.video.extend(["-pix_fmt", opts.pix_fmt])
621 |
622 | if opts.pix_fmt == "yuva420p":
623 | self.video.extend(["-auto-alt-ref", "0"])
624 | else:
625 | self.video.extend(["-auto-alt-ref", "1",
626 | "-lag-in-frames", "25",
627 | "-arnr-maxframes", "15",
628 | "-arnr-strength", "6"])
629 |
630 | self.video.extend(["-b:v", f"{self.info.v_rate}K"])
631 |
632 | if opts.crf and mode in (1, 2):
633 | self.video.extend(["-crf", str(opts.crf_value)])
634 |
635 | if mode == 1:
636 | self.video.extend(["-qmax", str(opts.min_quality)])
637 | elif mode == 3:
638 | self.video.extend(["-minrate:v", f"{self.info.v_rate}K",
639 | "-maxrate:v", f"{self.info.v_rate}K",
640 | "-bufsize", f"{self.info.v_rate*5}K",
641 | "-skip_threshold", "100"])
642 |
643 | self.video.extend(["-threads", str(opts.threads)])
644 |
645 | # This check isn't necessary, but it avoids command bloat
646 | if opts.v_codec == "libvpx-vp9" and opts.threads > 1:
647 | self.video.extend(["-tile-columns", "6",
648 | "-tile-rows", "2",
649 | "-row-mt", "1"])
650 |
651 | def update_filters_flags(self):
652 | """Update filter-related FFmpeg options."""
653 | f_scale = f"scale=-2:{self.info.out_height}:flags=lanczos"
654 | f_fps = f"fps={self.info.out_fps}"
655 |
656 | if self.info.out_height < self.info.in_height \
657 | and self.info.out_fps < self.info.in_fps:
658 | self.filter = ["-vf", f"{f_scale},{f_fps}"]
659 | elif self.info.out_height < self.info.in_height:
660 | self.filter = ["-vf", f_scale]
661 | elif self.info.out_fps < self.info.in_fps:
662 | self.filter = ["-vf", f_fps]
663 |
664 | def assemble_raw_command(self, ff_pass):
665 | """Assemble custom filter-applying FFmpeg command."""
666 | video = ["-c:v", "copy"]
667 | if opts.global_start or opts.f_video:
668 | video = ["-c:v", "rawvideo"]
669 |
670 | audio = ["-c:a", "copy"]
671 | if opts.global_start or opts.f_audio:
672 | audio = ["-c:a", "pcm_s16le"]
673 |
674 | if opts.no_filter_firstpass and opts.passes == 2 and ff_pass == 1:
675 | filters = []
676 | else:
677 | filters = ["-filter_complex", opts.f_user]
678 |
679 | command = ["ffmpeg", "-y", "-v", "error"]
680 | command.extend(self.input)
681 | command.extend(self.map)
682 | command.extend(video)
683 | command.extend(audio)
684 | command.extend(["-c:s", "copy"])
685 | command.extend(filters)
686 | command.extend(["-strict", "-2", "-f", "matroska", "-"])
687 |
688 | return command
689 |
690 | def assemble_command(self, mode, ff_pass):
691 | """Assemble final FFmpeg command, which creates the output file."""
692 | if opts.passes == 1 or mode == 3:
693 | output = ["-cpu-used", "0", self.info.temp]
694 | elif ff_pass == 1:
695 | output = ["-cpu-used", "5", "-passlogfile", self.info.name,
696 | "-pass", "1", "-f", "null", "-"]
697 | elif ff_pass == 2:
698 | output = ["-cpu-used", "0", "-passlogfile", self.info.name,
699 | "-pass", "2", self.info.temp]
700 |
701 | command = ["ffmpeg", "-y"]
702 | command.extend(self.verbosity)
703 | if opts.f_user:
704 | command.extend(["-i", "-", "-map", "0"])
705 | else:
706 | command.extend(self.input)
707 | command.extend(self.map)
708 | command.extend(self.video)
709 | command.extend(self.audio)
710 | command.extend(self.subs)
711 | command.extend(self.filter)
712 | command.extend(output)
713 |
714 | return command
715 |
716 |
717 | class FileConverter:
718 | """Handle the conversion process of a convertible file."""
719 |
720 | def __init__(self):
721 | """Initialize all properties."""
722 | self.curr_size = 0
723 | self.best_size = 0
724 | self.last_size = 0
725 |
726 | # Bitrate modes (not in technically accurate sense):
727 | # 1 -> VBR/CQ + qmax
728 | # 2 -> VBR/CQ
729 | # 3 -> CBR
730 |
731 | # Set first mode to use
732 | if opts.no_qmax:
733 | self.min_mode = 2
734 | else:
735 | self.min_mode = 1
736 | # Set last mode to use
737 | if opts.no_cbr:
738 | self.max_mode = 2
739 | else:
740 | self.max_mode = 3
741 | # Initialize mode tracker with the first mode
742 | self.mode = self.min_mode
743 |
744 | def update_size(self, video):
745 | """Update size information after an encoding attempt."""
746 | # Save size from previous attempt for later rel. difference check
747 | self.last_size = self.curr_size
748 | # Get current attempt size
749 | if opts.debug:
750 | try:
751 | user = float(input("\nOutput size in MB: "))
752 | except ValueError:
753 | # Use empty input as shortcut to end debug mode (simulate success)
754 | user = opts.limit
755 | self.curr_size = int(user*1024**2)
756 | else:
757 | self.curr_size = os.path.getsize(video.info.temp)
758 |
759 | # Test if current size is the best attempt yet
760 | # True, if
761 | # -> first try (no best size yet)
762 | # -> best try too large; smaller than best try (still tries to limit)
763 | # -> best try ok; bigger than best try and smaller than max size
764 | if not self.best_size \
765 | or self.curr_size < self.best_size and self.best_size > opts.max_size \
766 | or self.best_size < self.curr_size <= opts.max_size \
767 | and self.best_size < opts.max_size:
768 | self.best_size = self.curr_size
769 | if not opts.debug:
770 | os.replace(video.info.temp, video.info.output)
771 |
772 | def size_info(self):
773 | """Fetch info text about the currently saved file sizes."""
774 | if self.best_size > opts.max_size:
775 | color = fgcolors.ERROR
776 | elif self.best_size < opts.min_size:
777 | color = fgcolors.WARNING
778 | else:
779 | color = fgcolors.SUCCESS
780 |
781 | info = indent(dedent(f"""
782 | Curr. size: {round(self.curr_size/1024**2, 2)} MB
783 | Last size: {round(self.last_size/1024**2, 2)} MB
784 | Best try: {color}{round(self.best_size/1024**2, 2)}{fgcolors.DEFAULT} MB
785 | """), " ")
786 |
787 | return info
788 |
789 | def skip_mode(self):
790 | """Check for insufficient file size change."""
791 | diff = abs((self.curr_size-self.last_size) / self.last_size)
792 | return bool(diff < opts.skip_limit)
793 |
794 | def limit_size(self, video):
795 | """Limit output size to the given upper limit."""
796 | while self.mode <= self.max_mode:
797 | for i in range(1, opts.iters+1):
798 | # Reset bitrate for 1st attempt of a new mode
799 | if i == 1:
800 | video.info.v_rate = video.info.init_video_bitrate()
801 | else:
802 | video.info.update_video_bitrate(self.curr_size)
803 | video.info.update_filters()
804 | video.update_video_flags(self.mode)
805 | video.update_filters_flags()
806 |
807 | msg(f"Mode {fgcolors.INFO}{self.mode}{fgcolors.DEFAULT} (of 3) | "
808 | f"Attempt {fgcolors.INFO}{i}{fgcolors.DEFAULT} (of {opts.iters}) | "
809 | f"Height: {fgcolors.INFO}{video.info.out_height}{fgcolors.DEFAULT} | "
810 | f"FPS: {fgcolors.INFO}{video.info.out_fps}{fgcolors.DEFAULT}")
811 | msg(indent(dedent(f"""
812 | Video: {' '.join(video.video)}
813 | Filters: {' '.join(video.filter)}
814 | """), " "),
815 | level=2)
816 |
817 | call_ffmpeg(video, self.mode)
818 | self.update_size(video)
819 | msg(self.size_info(), level=2)
820 |
821 | # Skip remaining iters, if change too small (defaul: <1%)
822 | if i > 1 and self.skip_mode():
823 | break
824 | if self.best_size <= opts.max_size:
825 | return
826 |
827 | self.mode += 1
828 |
829 | def raise_size(self, video):
830 | """Raise output size above the given lower limit."""
831 | for i in range(1, opts.iters+1):
832 | # don't re-initialize; adjust the last bitrate from limit_size()
833 | video.info.update_video_bitrate(self.curr_size)
834 | video.info.update_filters()
835 | video.update_video_flags(self.mode)
836 | video.update_filters_flags()
837 |
838 | msg(f"Enhance Attempt {fgcolors.INFO}{i}{fgcolors.DEFAULT} (of {opts.iters}) | "
839 | f"Height: {fgcolors.INFO}{video.info.out_height}{fgcolors.DEFAULT} | "
840 | f"FPS: {fgcolors.INFO}{video.info.out_fps}{fgcolors.DEFAULT}")
841 | msg(indent(dedent(f"""
842 | Video: {' '.join(video.video)}
843 | Filters: {' '.join(video.filter)}
844 | """), " "),
845 | level=2)
846 |
847 | call_ffmpeg(video, self.mode)
848 | self.update_size(video)
849 | msg(self.size_info(), level=2)
850 |
851 | # Skip remaining iters, if change too small (defaul: <1%)
852 | if self.skip_mode():
853 | return
854 | if opts.min_size <= self.best_size <= opts.max_size:
855 | return
856 |
857 | def process(self, video):
858 | """Process (i.e. convert) a single input video."""
859 | global size_fail
860 |
861 | self.limit_size(video)
862 | if self.best_size > opts.max_size:
863 | err(f"{video.info.output}: Still too large", color=fgcolors.WARNING)
864 | size_fail = True
865 | return
866 | if self.best_size >= opts.min_size:
867 | return
868 |
869 | self.raise_size(video)
870 | if self.best_size < opts.min_size:
871 | err(f"{video.info.output}: Still too small", color=fgcolors.WARNING)
872 | size_fail = True
873 |
874 | def reset(self):
875 | """Reset instance variables after conversion."""
876 | self.curr_size = 0
877 | self.best_size = 0
878 | self.last_size = 0
879 | self.mode = self.min_mode
880 |
881 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
882 | # Functions
883 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
884 |
885 | def err(*args, level=0, color=fgcolors.ERROR, **kwargs):
886 | """Print to stderr."""
887 | if level <= opts.verbosity:
888 | sys.stderr.write(color)
889 | print(*args, file=sys.stderr, **kwargs)
890 | sys.stderr.write(fgcolors.RESET)
891 | sys.stdout.write(fgcolors.RESET)
892 |
893 |
894 | def msg(*args, level=1, color=fgcolors.DEFAULT, **kwargs):
895 | """Print to stdout based on verbosity level."""
896 | if level < opts.verbosity:
897 | # Print "lower-level" info bold in more verbose modes
898 | sys.stdout.write(fgcolors.BOLD)
899 | if level <= opts.verbosity:
900 | sys.stdout.write(color)
901 | print(*args, **kwargs)
902 | sys.stderr.write(fgcolors.RESET)
903 | sys.stdout.write(fgcolors.RESET)
904 |
905 |
906 | def check_prereq():
907 | """Test if all required software is installed."""
908 | reqs = ["ffmpeg", "ffprobe"]
909 |
910 | for r in reqs:
911 | try:
912 | subprocess.run([r], check=False,
913 | stdout=subprocess.DEVNULL,
914 | stderr=subprocess.DEVNULL)
915 | except FileNotFoundError:
916 | # Can't use err(), since opts isn't initialized yet
917 | print(f"Error: {r} not found!", file=sys.stderr)
918 | sys.exit(status.DEP)
919 |
920 |
921 | def positive_int(string):
922 | """Convert string provided by argparse to a positive int."""
923 | try:
924 | value = int(string)
925 | if value <= 0:
926 | raise ValueError
927 | except ValueError:
928 | error = f"invalid positive int value: {string}"
929 | raise argparse.ArgumentTypeError(error)
930 |
931 | return value
932 |
933 |
934 | def positive_float(string):
935 | """Convert string provided by argparse to a positive float."""
936 | try:
937 | value = float(string)
938 | if value <= 0:
939 | raise ValueError
940 | except ValueError:
941 | error = f"invalid positive float value: {string}"
942 | raise argparse.ArgumentTypeError(error)
943 |
944 | return value
945 |
946 |
947 | def valid_time(string):
948 | """Convert string provided by argparse to time in seconds."""
949 | # Just test validity with FFmpeg (reasonable fast even for >1h durations)
950 | command = ["ffmpeg", "-v", "quiet",
951 | "-f", "lavfi", "-i", "anullsrc",
952 | "-t", string, "-c", "copy",
953 | "-f", "null", "-"]
954 | try:
955 | subprocess.check_call(command)
956 | except subprocess.CalledProcessError:
957 | error = f"invalid FFmpeg time syntax: {string}"
958 | raise argparse.ArgumentTypeError(error)
959 |
960 | # Split into h, m and s
961 | time = [float(t) for t in string.split(":")]
962 | if len(time) == 3:
963 | sec = 3600*time[0] + 60*time[1] + time[2]
964 | elif len(time) == 2:
965 | sec = 60*time[0] + time[1]
966 | elif len(time) == 1:
967 | sec = time[0]
968 |
969 | if sec <= 0:
970 | error = f"invalid positive time value: {string}"
971 | raise argparse.ArgumentTypeError(error)
972 |
973 | return sec
974 |
975 |
976 | def valid_file(string):
977 | """Convert string provided by argparse to valid file path."""
978 | path = os.path.abspath(string)
979 | if not os.path.exists(path):
980 | error = f"file doesn't exist: {path}"
981 | raise argparse.ArgumentTypeError(error)
982 | if not os.path.isfile(path):
983 | error = f"not a regular file: {path}"
984 | raise argparse.ArgumentTypeError(error)
985 |
986 | return path
987 |
988 |
989 | def analyze_filters(filters):
990 | """Test user set filters"""
991 | if not filters:
992 | return (False, False)
993 |
994 | # existing filters let copy fail
995 | # only crude test; stream specifiers will let it fail as well
996 | command = ["ffmpeg", "-v", "quiet",
997 | "-f", "lavfi", "-i", "nullsrc",
998 | "-f", "lavfi", "-i", "anullsrc",
999 | "-t", "1", "-c:v", "copy",
1000 | "-filter_complex", filters,
1001 | "-f", "null", "-"]
1002 | try:
1003 | subprocess.check_call(command)
1004 | video = False
1005 | except subprocess.CalledProcessError:
1006 | video = True
1007 |
1008 | command = ["ffmpeg", "-v", "quiet",
1009 | "-f", "lavfi", "-i", "nullsrc",
1010 | "-f", "lavfi", "-i", "anullsrc",
1011 | "-t", "1", "-c:a", "copy",
1012 | "-filter_complex", filters,
1013 | "-f", "null", "-"]
1014 | try:
1015 | subprocess.check_call(command)
1016 | audio = False
1017 | except subprocess.CalledProcessError:
1018 | audio = True
1019 |
1020 | return (video, audio)
1021 |
1022 |
1023 | def parse_cli():
1024 | """Parse command line arguments."""
1025 | defaults = DefaultOptions()
1026 | parser = CustomArgumentParser(usage="%(prog)s [OPTIONS] INPUT [INPUT]...")
1027 |
1028 | # Input
1029 | parser.add_argument("files", nargs="+", type=valid_file)
1030 | # Common Options
1031 | verbosity = parser.add_mutually_exclusive_group()
1032 | verbosity.add_argument("-q", "--quiet", dest="verbosity", action="store_const",
1033 | const=0, default=defaults.VERBOSITY)
1034 | verbosity.add_argument("-v", "--verbose", dest="verbosity", action="store_const",
1035 | const=2, default=defaults.VERBOSITY)
1036 | parser.add_argument("-a", "--audio", action="store_true",
1037 | default=defaults.AUDIO)
1038 | parser.add_argument("-s", "--size", dest="limit", type=positive_float,
1039 | default=defaults.LIMIT)
1040 | parser.add_argument("-f", "--filters", dest="f_user",
1041 | default=defaults.F_USER)
1042 | parser.add_argument("-p", "--passes", type=int, default=defaults.PASSES,
1043 | choices=[1, 2])
1044 | parser.add_argument("-u", "--undershoot", dest="under", type=float,
1045 | default=defaults.UNDER)
1046 | parser.add_argument("-i", "--iterations", dest="iters", type=positive_int,
1047 | default=defaults.ITERS)
1048 | parser.add_argument("-t", "--threads", type=positive_int,
1049 | default=defaults.THREADS)
1050 | parser.add_argument("-ss", "--start", dest="global_start", type=valid_time,
1051 | default=defaults.GLOBAL_START)
1052 | parser.add_argument("-to", "--end", dest="global_end", type=valid_time,
1053 | default=defaults.GLOBAL_END)
1054 | parser.add_argument("-fs", "--force-stereo", action="store_true",
1055 | default=defaults.FORCE_STEREO)
1056 | parser.add_argument("-bf", "--basic-format", action="store_true",
1057 | default=defaults.BASIC_FORMAT)
1058 | # Subtitle Options
1059 | parser.add_argument("--subtitles", dest="subs", action="store_true",
1060 | default=defaults.SUBS)
1061 | parser.add_argument("--mkv-fallback", action="store_true",
1062 | default=defaults.MKV_FALLBACK)
1063 | parser.add_argument("--burn-subs", action="store_true",
1064 | default=defaults.BURN_SUBS)
1065 | # Advanced Video Options
1066 | parser.add_argument("--vp9", dest="v_codec", action="store_const",
1067 | const="libvpx-vp9", default=defaults.V_CODEC)
1068 | parser.add_argument("--crf", action="store_true", default=defaults.CRF)
1069 | parser.add_argument("--no-qmax", action="store_true",
1070 | default=defaults.NO_QMAX)
1071 | parser.add_argument("--no-cbr", action="store_true",
1072 | default=defaults.NO_CBR)
1073 | parser.add_argument("--bpp", dest="bpp_thresh", type=positive_float,
1074 | default=defaults.BPP_THRESH)
1075 | parser.add_argument("--transparency", action="store_true",
1076 | default=defaults.TRANSPARENCY)
1077 | parser.add_argument(
1078 | "--pix-fmt", default=defaults.PIX_FMT,
1079 | choices=[
1080 | "yuv420p", "yuva420p",
1081 | "yuv422p", "yuv440p", "yuv444p",
1082 | "yuv420p10le", "yuv422p10le", "yuv440p10le", "yuv444p10le",
1083 | "yuv420p12le", "yuv422p12le", "yuv440p12le", "yuv444p12le",
1084 | "gbrp", "gbrp10le", "gbrp12le",
1085 | ]
1086 | )
1087 | parser.add_argument("--min-height", type=positive_int,
1088 | default=defaults.MIN_HEIGHT)
1089 | parser.add_argument("--max-height", type=positive_int,
1090 | default=defaults.MAX_HEIGHT)
1091 | parser.add_argument("--min-fps", type=positive_float,
1092 | default=defaults.MIN_FPS)
1093 | parser.add_argument("--max-fps", type=positive_float,
1094 | default=defaults.MAX_FPS)
1095 | # Advanced Audio Options
1096 | parser.add_argument("--opus", dest="a_codec", action="store_const",
1097 | const="libopus", default=defaults.A_CODEC)
1098 | copy_action = parser.add_mutually_exclusive_group()
1099 | copy_action.add_argument("--no-copy", action="store_true",
1100 | default=defaults.NO_COPY)
1101 | copy_action.add_argument("--force-copy", action="store_true",
1102 | default=defaults.FORCE_COPY)
1103 | parser.add_argument("--min-audio", type=positive_int,
1104 | default=defaults.MIN_AUDIO)
1105 | parser.add_argument("--max-audio", type=positive_int,
1106 | default=defaults.MAX_AUDIO)
1107 | # Misc. Options
1108 | parser.add_argument("--no-filter-firstpass", action="store_true",
1109 | default=defaults.NO_FILTER_FIRSTPASS)
1110 | parser.add_argument(
1111 | "--ffmpeg-verbosity", default=defaults.FFMPEG_VERBOSITY,
1112 | choices=[
1113 | "quiet", "panic", "fatal",
1114 | "error", "warning", "info",
1115 | "verbose", "debug", "trace",
1116 | "stats",
1117 | ]
1118 | )
1119 | parser.add_argument("--debug", action="store_true", default=defaults.DEBUG)
1120 |
1121 | # Advanced User Options
1122 | parser.set_defaults(
1123 | fps_list=[60, 30, 25, 24, 22, 20, 18, 16, 14, 12, 10, 8, 6, 4, 2, 1],
1124 | audio_test_dur=60, # 0 for whole stream -> exact bitrate
1125 | fallback_bitrate=1, # Must be >0
1126 | height_reduction=-10, # Must be <0
1127 | min_quality=50,
1128 | crf_value=10,
1129 | min_bitrate_ratio=0.9,
1130 | skip_limit=0.01,
1131 | a_factor=5.5,
1132 | fallback_codec="libvorbis",
1133 | suffix="temp",
1134 | out_dir="webm_done",
1135 | )
1136 |
1137 | args = parser.parse_args()
1138 |
1139 | # Store size limits in Bytes
1140 | args.max_size = int(args.limit*1024**2)
1141 | args.min_size = int(args.limit*1024**2*args.under)
1142 | # Scan user filter-string for the scale and fps filter
1143 | args.user_scale = bool(args.f_user and "scale" in args.f_user)
1144 | args.user_fps = bool(args.f_user and "fps" in args.f_user)
1145 | # Set pixel format according to transparency flag
1146 | # Makes sure that --transparency overwrites --pix-fmt
1147 | if args.transparency:
1148 | args.pix_fmt = "yuva420p"
1149 | # Check type of applied user filters
1150 | args.f_video, args.f_audio = analyze_filters(args.f_user)
1151 |
1152 | return args
1153 |
1154 |
1155 | def additional_checks():
1156 | """Check for invalid options that aren't detected by argparse."""
1157 | # Warn againts excessive thread usage
1158 | if opts.threads > 6 and opts.v_codec == "libvpx":
1159 | err("VP8 encoding via libvpx doesn't scale well beyond 4-6 threads.",
1160 | color=fgcolors.WARNING)
1161 | if opts.threads > 16:
1162 | err("Using more than 16 threads is not recommended.",
1163 | color=fgcolors.WARNING)
1164 |
1165 | # Special integer checks
1166 | if opts.max_height and opts.max_height < opts.min_height:
1167 | err("Max. height can't be less than min. height!")
1168 | sys.exit(status.OPT)
1169 | elif opts.max_audio and opts.max_audio < 6:
1170 | err("Max. audio channel bitrate must be greater than 6 Kbps!")
1171 | sys.exit(status.OPT)
1172 | elif opts.max_audio and opts.max_audio < opts.min_audio:
1173 | err("Max. audio channel bitrate can't be less than min. audio channel bitrate!")
1174 | sys.exit(status.OPT)
1175 | # Special float checks
1176 | elif opts.global_start and opts.global_end and \
1177 | opts.global_end <= opts.global_start:
1178 | err("End time must be greater than start time!")
1179 | sys.exit(status.OPT)
1180 | elif not 0 <= opts.under <= 1:
1181 | err("Undershoot must be in range [0,1]!")
1182 | sys.exit(status.OPT)
1183 | elif opts.max_fps and opts.max_fps < 1 or opts.min_fps < 1:
1184 | err("Frame rates can't be less than 1!")
1185 | sys.exit(status.OPT)
1186 | elif opts.max_fps and opts.max_fps < opts.min_fps:
1187 | err("Max. frame rate can't be less than min. frame rate!")
1188 | sys.exit(status.OPT)
1189 |
1190 | vp8_pix_fmt = ["yuv420p", "yuva420p"]
1191 | if opts.v_codec == "libvpx" and opts.pix_fmt not in vp8_pix_fmt:
1192 | err(f"'{opts.pix_fmt}' isn't supported by VP8!")
1193 | err("See 'ffmpeg -h encoder=libvpx' for more infos.",
1194 | color=fgcolors.DEFAULT)
1195 | sys.exit(status.OPT)
1196 |
1197 |
1198 | def choose_audio_bitrate(factor):
1199 | """Choose audio bitrate per channel (based on personal experience)."""
1200 | if factor < 1:
1201 | bitrate = 6
1202 | elif factor < 2:
1203 | bitrate = 8
1204 | elif factor < 3:
1205 | bitrate = 12
1206 | elif factor < 4:
1207 | bitrate = 16
1208 | elif factor < 6:
1209 | bitrate = 24
1210 | elif factor < 8:
1211 | bitrate = 32
1212 | elif factor < 28:
1213 | bitrate = 48
1214 | elif factor < 72:
1215 | bitrate = 64
1216 | elif factor < 120:
1217 | bitrate = 80
1218 | else:
1219 | bitrate = 96
1220 |
1221 | if bitrate < opts.min_audio:
1222 | bitrate = opts.min_audio
1223 | if opts.max_audio and bitrate > opts.max_audio:
1224 | bitrate = opts.max_audio
1225 |
1226 | return bitrate
1227 |
1228 |
1229 | def print_options():
1230 | """Print all settings for verbose output"""
1231 | msg("\n### Settings for the current session ###\n",
1232 | level=2, color=fgcolors.HEADER)
1233 |
1234 | msg(dedent(f"""\
1235 | Paths:
1236 | Suffix for temporary files: {opts.suffix}
1237 | Destination directory name: {opts.out_dir}
1238 |
1239 | Size:
1240 | Max. size: {opts.limit} MB
1241 | Undershoot ratio: {opts.under}
1242 | Max. size: {opts.max_size} Bytes
1243 | Min. size: {opts.min_size} Bytes
1244 |
1245 | Trimming:
1246 | Start time: {f'{opts.global_start} sec' if opts.global_start else None}
1247 | End time: {f'{opts.global_end} sec' if opts.global_end else None}
1248 |
1249 | Video:
1250 | Encoder: {opts.v_codec}
1251 | Passes: {opts.passes}
1252 | Threads: {opts.threads}
1253 | Color space: {opts.pix_fmt}
1254 | Use CQ instead of VBR: {opts.crf}
1255 | CRF: {opts.crf_value}
1256 | qmax: {opts.min_quality}
1257 | Fallback bitrate: {opts.fallback_bitrate} Kbps
1258 | Skip VBR with min. quality: {opts.no_qmax}
1259 | Skip CBR: {opts.no_cbr}
1260 | Iterations/bitrate mode: {opts.iters}
1261 | Mode skip threshold: {opts.skip_limit}
1262 | Min. bitrate ratio: {opts.min_bitrate_ratio}
1263 |
1264 | Audio:
1265 | Audio output: {opts.audio}
1266 | Encoder: {opts.a_codec}
1267 | Fallback encoder: {opts.fallback_codec}
1268 | Force stereo: {opts.force_stereo}
1269 | Min. channel bitrate: {opts.min_audio} Kbps
1270 | Max. channel bitrate: {f'{opts.max_audio} Kbps' if opts.max_audio else None}
1271 | Stream copying disabled: {opts.no_copy}
1272 | Ignore bitrate for copying: {opts.force_copy}
1273 | Bitrate test duration: {f'{opts.audio_test_dur} sec' if opts.audio_test_dur else 'full duration'}
1274 | Audio factor: {opts.a_factor}
1275 |
1276 | Subtitles:
1277 | Subtitle support: {opts.subs or opts.burn_subs}
1278 | MKV as fallback: {opts.mkv_fallback}
1279 | Discard after hardsubbing: {opts.burn_subs}
1280 |
1281 | Filters:
1282 | User filters: {opts.f_user}
1283 | Contains video filters: {opts.f_video}
1284 | Contains audio filters: {opts.f_audio}
1285 | Omit during 1st pass: {opts.no_filter_firstpass}
1286 | BPP threshold: {opts.bpp_thresh} bpp
1287 | Min. height threshold: {opts.min_height}
1288 | Max. height threshold: {opts.max_height if opts.max_height else None}
1289 | Height reduction step: {opts.height_reduction}
1290 | Min. frame rate threshold: {opts.min_fps} fps
1291 | Max. frame rate threshold: {f'{opts.max_fps} fps' if opts.max_fps else None}
1292 | Possible frame rates: {', '.join([str(f) for f in opts.fps_list])}
1293 |
1294 | Misc.:
1295 | Only 1 video/audio stream: {opts.basic_format}
1296 | FFmpeg verbosity level: {opts.ffmpeg_verbosity}
1297 | Debug mode: {opts.debug}"""), level=2)
1298 |
1299 |
1300 | def resolve_path(in_path):
1301 | """Create output dir if non-existent."""
1302 | out_dir = os.path.join(os.path.dirname(in_path), opts.out_dir)
1303 | if not os.path.exists(out_dir):
1304 | os.mkdir(out_dir)
1305 |
1306 |
1307 | def audio_copy(video, stream):
1308 | """Decide if input audio stream should be copied"""
1309 | if opts.global_start or opts.f_audio or opts.no_copy:
1310 | return False
1311 |
1312 | # Shorter values speed up test, but only approximate avg. bitrate
1313 | # 0 will copy entire audio stream -> exact
1314 | copy_dur = []
1315 | if opts.audio_test_dur:
1316 | copy_dur = ["-t", str(opts.audio_test_dur)]
1317 |
1318 | command = ["ffmpeg", "-y", "-v", "error", "-i", video.info.input]
1319 | command.extend(copy_dur)
1320 | command.extend(["-map", f"0:a:{stream}", "-c", "copy",
1321 | os.path.join(video.info.dir, f"{video.info.name}_{opts.suffix}.mkv")])
1322 | subprocess.run(command, check=False)
1323 |
1324 | command = ["ffprobe", "-v", "error",
1325 | "-show_format", "-show_streams",
1326 | "-print_format", "json",
1327 | os.path.join(video.info.dir, f"{video.info.name}_{opts.suffix}.mkv")]
1328 | info = subprocess.run(command, stdout=subprocess.PIPE, check=False).stdout
1329 | info = json.loads(info)
1330 |
1331 | in_rate = int(info['format']['bit_rate'])
1332 | in_codec = info['streams'][0]['codec_name']
1333 | out_rate = video.info.a_list[stream]
1334 |
1335 | codecs = ["vorbis"]
1336 | if opts.a_codec == "libopus":
1337 | codecs.append("opus")
1338 |
1339 | # *1.05 since bitrate allocation is no exact business
1340 | if in_codec in codecs and (opts.force_copy or in_rate <= out_rate*1000*1.05):
1341 | return True
1342 |
1343 | return False
1344 |
1345 |
1346 | def opus_fallback(in_file, stream):
1347 | """Test if audio fallback encoder is necessary"""
1348 | if opts.force_stereo:
1349 | return False
1350 |
1351 | # Certain channel configurations will throw an error
1352 | # See: https://trac.ffmpeg.org/ticket/5718
1353 | command = ["ffmpeg", "-v", "quiet",
1354 | "-i", in_file, "-t", "1",
1355 | "-map", "0:a:" + str(stream),
1356 | "-c:a", "libopus", "-f", "null", "-"]
1357 |
1358 | try:
1359 | subprocess.check_call(command)
1360 | except subprocess.CalledProcessError:
1361 | return True
1362 |
1363 | return False
1364 |
1365 |
1366 | def out_image_subs(in_file):
1367 | """Test if output would include image-based subtitles"""
1368 | if not opts.subs or opts.burn_subs:
1369 | return False
1370 |
1371 | # FFmpeg only supports text->text and bitmap->bitmap conversions
1372 | # bitmap->text in general is a complex topic
1373 | command = ["ffmpeg", "-v", "quiet",
1374 | "-i", in_file, "-t", "1",
1375 | "-map", "0:s?", "-c:s", "webvtt",
1376 | "-f", "null", "-"]
1377 |
1378 | try:
1379 | subprocess.check_call(command)
1380 | except subprocess.CalledProcessError:
1381 | return True
1382 |
1383 | return False
1384 |
1385 |
1386 | def call_ffmpeg(video, mode):
1387 | """Run FFmpeg to create the output."""
1388 | # Print placeholder line, if FFmpeg output is suppressed
1389 | if opts.ffmpeg_verbosity not in ["info", "verbose", "debug", "trace", "stats"]:
1390 | msg("Converting...")
1391 |
1392 | for p in range(1, opts.passes+1):
1393 | if p < opts.passes and \
1394 | (mode == 3 or os.path.exists(f"{video.info.name}-0.log")):
1395 | continue
1396 |
1397 | if opts.debug:
1398 | if opts.f_user:
1399 | print(' '.join(video.assemble_raw_command(p)))
1400 | print(' '.join(video.assemble_command(mode, p)))
1401 | else:
1402 | if opts.f_user:
1403 | raw_pipe = subprocess.Popen(
1404 | video.assemble_raw_command(p),
1405 | stdout=subprocess.PIPE,
1406 | bufsize=10**8
1407 | )
1408 | subprocess.run(
1409 | video.assemble_command(mode, p),
1410 | stdin=raw_pipe.stdout,
1411 | check=False,
1412 | )
1413 | else:
1414 | subprocess.run(video.assemble_command(mode, p), check=False)
1415 |
1416 | # Always run 3rd mode (CBR) with only one pass
1417 | if mode == 3:
1418 | break
1419 |
1420 |
1421 | def clean(video):
1422 | """Clean leftover file in the workspace"""
1423 | base = os.path.join(video.info.dir, f"{video.info.name}_{opts.suffix}")
1424 | for f in [f"{base}.{ext}" for ext in ["webm", "mkv"]]:
1425 | if os.path.exists(f):
1426 | os.remove(f)
1427 | if opts.passes == 2 and os.path.exists(f"{video.info.name}-0.log"):
1428 | os.remove(f"{video.info.name}-0.log")
1429 |
1430 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1431 | # Main script
1432 | # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1433 |
1434 | def main():
1435 | """Main function body"""
1436 | print_options()
1437 |
1438 | msg("\n### Start conversion ###\n", level=2, color=fgcolors.HEADER)
1439 | restrictor = FileConverter()
1440 |
1441 | for i, path in enumerate(opts.files, start=1):
1442 | resolve_path(path)
1443 | video = ConvertibleFile(FileInfo(path))
1444 | if not video.valid:
1445 | clean(video)
1446 | continue
1447 |
1448 | msg(f"File {fgcolors.FILE}{i}{fgcolors.DEFAULT} (of {len(opts.files)}): "
1449 | f"{fgcolors.FILE}{video.info.input}{fgcolors.DEFAULT}")
1450 | msg(indent(dedent(f"""
1451 | Verbosity: {' '.join(video.verbosity)}
1452 | Input/trim: {' '.join(video.input)}
1453 | Mapping: {' '.join(video.map)}
1454 | Audio: {' '.join(video.audio)}
1455 | Subtitles: {' '.join(video.subs)}
1456 | Output: {video.info.output}
1457 | """), " "),
1458 | level=2)
1459 |
1460 | try:
1461 | restrictor.process(video)
1462 | restrictor.reset()
1463 | finally:
1464 | clean(video)
1465 |
1466 |
1467 | # Execute main function
1468 | if __name__ == '__main__':
1469 | check_prereq()
1470 | opts = parse_cli()
1471 | additional_checks()
1472 |
1473 | try:
1474 | main()
1475 | except KeyboardInterrupt:
1476 | err("\nUser Interrupt!", color=fgcolors.WARNING)
1477 | sys.exit(status.INT)
1478 |
1479 | msg("\n### Finished ###\n", level=2, color=fgcolors.HEADER)
1480 | if size_fail:
1481 | sys.exit(status.SIZE)
1482 | sys.exit(0)
1483 |
--------------------------------------------------------------------------------