diff --git a/LICENSE b/LICENSE index 94a9ed0..2b8e07a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,19 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +Copyright (c) 2012 Gavin Beatty + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile index c3c8c08..407d104 100644 --- a/Makefile +++ b/Makefile @@ -17,20 +17,17 @@ include dist.mk include man2txt.mk all: bin doc -bin: setup.py $(PROJECT) +bin: $(PROJECT) doc: doc/$(PROJECT).1 doc/$(PROJECT).1.html doc/$(PROJECT).txt clean: clean-bin clean-doc .PHONY: all bin doc clean $(PROJECT): $(PROJECT).py $(VERSION_DEP) - $(SED) -e "s/^# @VERSION@/__version__ = '$(VERSION)'/" \ + $(SED) -e "s/^__version__ = .*/__version__ = '$(VERSION)'/" \ $(PROJECT).py > $(PROJECT) @chmod +x $(PROJECT) -setup.py: setup.py.in - $(SED) -e "s/^# @VERSION@/ version='$(VERSION)',/" setup.py.in \ - > setup.py clean-bin: - $(RM) $(PROJECT) setup.py + $(RM) $(PROJECT) install-bin: @echo 'make install-doc to install documentation.' @echo 'To install the script, see README.markdown.' diff --git a/README.markdown b/README.markdown deleted file mode 100644 index 671fedd..0000000 --- a/README.markdown +++ /dev/null @@ -1,181 +0,0 @@ -mkvtomp4 -======== -Gavin Beatty - -mkvtomp4: Uses mpeg4ip or GPAC's MP4Box, mkvtoolnix and ffmpeg to convert -troublesome mkv files to mp4. -The conversion does not re-encode the video and only re-encodes the audio if -it doesn't use AAC codec (one can override this behaviour using -`--audio-codec`). -They will be playable on the Sony PS3. - -From the manual: - - NAME - mkvtomp4 - convert H.264 mkv files to mp4 files playable on the PS3 - - SYNOPSIS - mkvtomp4 [OPTIONS] [--] - - mkvtomp4 --correct-profile-only [--] - - DESCRIPTION - Uses mpeg4ip or GPACs MP4Box, mkvtoolnix and ffmpeg to convert - troublesome mkv files to mp4. The conversion does not re-encode the - video and only re-encodes the audio if it doesnt use AAC codec (one - can override this behaviour using --audio-codec). They will be playable - on the Sony PS3. - - We depend on: mkvtoolnix, mpeg4ip or GPACs MP4Box for the conversion. - ffmpeg is optional but required for audio transcoding. - - OPTIONS - --use-mp4creator or --use-mp4box - Specify which mp4 backend to use. mp4creator is the default. - - --audio-delay-ms= - When importing the audio track, delay by milliseconds. - e.g., --audio-delay-ms=1000 delays by 1 second. Not supported by - mp4creator. - - --audio-bitrate= - If/When converting audio, use the given bitrate. e.g., 128. - - --audio-channels= - If/When converting audio, use channels in the output. - e.g., 5.1. - - --audio-codec= - If/When converting audio, convert to . Default is libfaac. - This should be something supported by ffmpeg. - - -o, --output= - Put the completed mp4 into . - - --keep-temp-files - Keep all temporary files created while converting. - - -n, --dry-run - Dont run any commands, but print them in a shellquoted format that - can be safely copy-pasted by the user. - - --stop-before-extract-video - Exit before extracting video from . - - --stop-before-correct-profile - Exit before correcting profile of raw H.264 stream. - - --stop-before-extract-audio - Exit before extracting audio from . - - --stop-before-convert-audio - Exit before converting audio previously extracted. This will stop - even if the audio does not need to be converted. - - --stop-before-video-mp4 - Exit before adding the extracted video to the mp4 container. - - --stop-before-hinting-mp4 - Exit before hinting the mp4 file with the video track. - - --stop-before-audio-mp4 - Exit before adding the extracted (and possibly converted) audio to - the mp4 container. - - - The Matroska (.mkv) file you wish to convert. - - --correct-profile-only - Only correct the profile - - - The raw H.264 stream file that will have its profile corrected for - use on the PS3. - - EXIT STATUS - 0 on success and non-zero on failure. - - AUTHOR - Gavin Beatty - - RESOURCES - Website: http://code.google.com/p/mkvtomp4/ - - REPORTING BUGS - Please report all bugs and wishes to - - COPYING - mkvtomp4 Copyright (C) 2010 Gavin Beatty, - - Free use of this software is granted under the terms of the GNU General - Public License version 3, or at your option, any later version. - (GPLv3+) - - -Dependencies ------------- - -Tools: -* mkvtoolnix -* mpeg4ip or GPAC's MP4Box -* ffmpeg - -On Linux, use your package manager to install. -On Mac OS X, use MacPorts to install. -On Windows, go to the tools' individual websites and find windows binaries. - -Everything else is written using only fully cross-platform python, except: - -* pipes module. This means we depend on POSIX /bin/sh for the time being. - -If you want to help eliminate this dependency, help solve issue 0001. - - -License -------- - -mkvtomp4 Copyright 2010 Gavin Beatty . - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or (at -your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You can find the GNU General Public License at: -http://www.gnu.org/licenses/ - - -Install -------- - -Use setuptools in the usual way: - python setup.py build - sudo python setup.py install - -To install only for the current user: - python setup.py install --user - -For additional help: - python setup.py --help - - -Install documentation ---------------------- - -Default installation prefix is `/usr/local`: - sudo make install-docs - -Install to your own prefix: - make install-docs prefix=~/.local - - -Website -------- -http://code.google.com/p/mkvtomp4/ - - diff --git a/README.md b/README.md new file mode 100644 index 0000000..ef7916c --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +mkvtomp4 +======== +Gavin Beatty + + + +mkvtomp4: Uses mpeg4ip or GPAC's MP4Box, mkvtoolnix and ffmpeg to convert +troublesome mkv files to mp4. +The conversion does not re-encode the video and only re-encodes the audio if +it doesn't use AAC codec (one can override this behaviour using +`--audio-codec`). +They will be playable on the Sony PS3. + +Check the manual in `doc/mkvtomp4.1.txt`. + + +Dependencies +------------ + +Tools: +* mkvtoolnix +* mpeg4ip or GPAC's MP4Box +* ffmpeg + +On Linux, use your package manager to install. +On Mac OS X, use MacPorts to install. +On Windows, go to the tools' individual websites and find windows binaries. + +Everything else is written using only fully cross-platform python, except: + +* pipes module. This means we depend on POSIX /bin/sh for the time being. + +If you want to help eliminate this dependency, help solve issue 0001. + diff --git a/doc/mkvtomp4.1.txt b/doc/mkvtomp4.1.txt index 3a4ddd7..d536d90 100644 --- a/doc/mkvtomp4.1.txt +++ b/doc/mkvtomp4.1.txt @@ -114,9 +114,24 @@ Please report all bugs and wishes to COPYING ------- -mkvtomp4 Copyright \(C) 2010 Gavin Beatty, - -Free use of this software is granted under the terms of the GNU General Public -License version 3, or at your option, any later version. (GPLv3+) +mkvtomp4 Copyright \(c) 2012 Gavin Beatty, + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/mkvtomp4.py b/mkvtomp4.py index b69a7ff..ed6beaa 100644 --- a/mkvtomp4.py +++ b/mkvtomp4.py @@ -1,8 +1,14 @@ #!/usr/bin/python -"""Convert H.264 mkv files to mp4 files playable on the PS3.""" +"""Convert H.264 mkv files to mp4 files playable on the PS3, and "correct" the +MPEG4/ISO/AVC profile for use on the PS3.""" + + +__version__ = '1.3' + + +usage = 'usage: mkvtomp4 [options] [--] ' -# @VERSION@ import os import sys @@ -16,35 +22,13 @@ except ImportError: from StringIO import StringIO -class Options(object): - def __init__(self): - self.verbose = 0 - self.a_bitrate = '328' - self.a_channels = '5.1' - self.a_codec = 'libfaac' - self.a_delay = None - self.output = None - self.keep_temp_files = False - self.dry_run = False - self.correct_prof_only = False - self.stop_v_ex = False - self.stop_correct = False - self.stop_a_ex = False - self.stop_a_conv = False - self.stop_v_mp4 = False - self.stop_hint_mp4 = False - self.stop_a_mp4 = False - self.mp4 = 'mp4creator' def prin(*args, **kwargs): - fobj = kwargs.pop('fobj', None) + fobj = kwargs.get('fobj', None) if fobj is None: fobj = sys.stdout - sep = kwargs.pop('sep', ' ') - end = kwargs.pop('end', '\n') - if len(kwargs) != 0: - warning_print('prin: unknown kwargs given: %s' % kwargs) - + sep = kwargs.get('sep', ' ') + end = kwargs.get('end', '\n') if len(args) > 0: fobj.write(args[0]) if len(args) > 1: @@ -52,297 +36,306 @@ def prin(*args, **kwargs): fobj.write(sep + arg) fobj.write(end) -def error_print(*args, **kwargs): + +def eprint(*args, **kwargs): kwargs['fobj'] = sys.stderr prin("error:", *args, **kwargs) + def die(*args, **kwargs): - error_print(*args, **kwargs) + eprint(*args, **kwargs) sys.exit(1) -def warning_print(*args, **kwargs): + +def wprint(*args, **kwargs): kwargs['fobj'] = sys.stderr prin("warning:", *args, **kwargs) -def usage_print(fobj=None): - if fobj is None: - fobj = sys.stdout - prin('usage: mkvtomp4 [OPTIONS] [--] ', fobj=fobj) - -def version_print(**kwargs): - prin(__version__, **kwargs) -def verbose_print(level, *args, **kwargs): - local = kwargs.pop('verbose', 0) - global g_opts - if g_opts.verbose >= level or local >= level: +_verbosity = 0 +def vprint(level, *args, **kwargs): + global _verbosity + local = kwargs.get('verbosity', 0) + if _verbosity >= level or local >= level: prin('verbose:', *args, **kwargs) + +def onlykeys(d, keys): + newd = {} + for k in keys: + newd[k] = d[k] + return newd + + def __sq(one): squoted = pipes.quote(one) if squoted == '': return "''" return squoted -def sq(*args): + +def sq(args): return " ".join([__sq(x) for x in args]) -def command(*cmd, **kwargs): + +def command(cmd, **kwargs): verbose_kwargs = {} - verboos = kwargs.pop('verbose', None) - dry_run = kwargs.pop('dry_run', False) - if verboos is not None: - verbose_kwargs['verbose'] = verboos + verbosity = kwargs.get('verbosity', None) + if verbosity is not None: + verbose_kwargs['verbosity'] = verbosity if len(kwargs) != 0: - verbose_print(1, 'command: Popen kwargs: %s' % str(kwargs), **verbose_kwargs) - if dry_run: - prin(sq(*cmd)) + vprint(1, 'command: Popen kwargs: %s' % str(kwargs), **verbose_kwargs) + try: + vprint(1, 'command: %s' % str(cmd), **verbose_kwargs) + proc = sp.Popen(cmd, stdout=sp.PIPE, stderr=sp.PIPE, close_fds=True, **kwargs) + except OSError, e: + die('command failed:', str(e), ':', sq(cmd)) + chout, cherr = proc.communicate() + vprint(1, 'command: stdout:', chout, '\ncommand: stderr:', cherr) + if proc.returncode != 0: + die('failure: %s' % cherr, end='') + return chout + + +def dry_command(cmd, **opts): + if opts['dry_run']: + prin(sq(cmd)) else: - try: - verbose_print(1, 'command: %s' % str(cmd), **verbose_kwargs) - proc = sp.Popen(cmd, stdout=sp.PIPE, stderr=sp.PIPE, close_fds=True, **kwargs) - except OSError, e: - die('not found: %s' % str(e)) - chout, cherr = proc.communicate() - verbose_print(1, 'command: stdout:', chout, '\ncommand: stderr:', cherr) - if proc.returncode != 0: - die('failure: %s' % cherr, end='') - return chout - -def mp4_add_audio_optimize(mp4, audio, **kwargs): - if g_opts.mp4 == 'mp4creator': - command('mp4creator', '-c', audio, '-interleave', '-optimize', mp4 - , **kwargs) - elif g_opts.mp4 == 'mp4box': - delay = kwargs.pop('delay', None) - if delay is not None: - delay = ':delay='+delay - else: - delay = '' - command('MP4Box', '-add', audio+'#audio:trackID=2'+delay, mp4, **kwargs) - -def mp4_add_hint(mp4, **kwargs): - if g_opts.mp4 == 'mp4creator': - command('mp4creator', '-hint=1', mp4, **kwargs) - elif g_opts.mp4 == 'mp4box': - pass - -def mp4_add_video(mp4, video, fps, **kwargs): - if g_opts.mp4 == 'mp4creator': - command('mp4creator', '-c', video, '-rate', fps, mp4, **kwargs) - elif g_opts.mp4 == 'mp4box': - command('MP4Box', '-add', video+'#video:trackID=1', '-hint', '-fps', fps, mp4, **kwargs) - -def ffmpeg_convert_audio(old, new, **kwargs): - bitrate = kwargs.pop('bitrate', '128') - channels = kwargs.pop('channels', '2') - codec = kwargs.pop('codec', 'libfaac') - verboos = kwargs.get('verbose', 0) - if channels == '5.1': - channels = '6' + command(cmd, **opts) - if verboos > 1: - cmdlist = ['ffmpeg', '-v', str(verboos - 1)] - else: - cmdlist = ['ffmpeg'] - cmdlist.extend(['-i', old, '-ac', channels, '-acodec', codec - , '-ab', bitrate+'k', new]) - cmd = sq(*cmdlist) - dry_run = kwargs.pop('dry_run', False) - verbose_kwargs = {} - verbose_kwargs['verbose'] = kwargs.pop('verbose', 0) - verbose_print(1, 'command:', str(cmdlist), **verbose_kwargs) - if not dry_run: - os.system(cmd) - else: - prin(cmd) - -def convert_audio(old, new, **kwargs): - fixaudio = kwargs.pop('fixaudio', False) - keep_temp = kwargs.pop('keep_temp', False) - - if fixaudio: - try: - codec = kwargs.pop('codec') - ffmpeg_convert_audio(old, new+'.wav', codec='wav', **kwargs) - kwargs['codec'] = codec - ffmpeg_convert_audio(new+'.wav', new, **kwargs) - finally: - if not keep_temp: - try: - os.remove(new+'.wav') - except OSError: - pass - else: - ffmpeg_convert_audio(old, new, **kwargs) -def correct_profile(video, **kwargs): - if kwargs.get('dry_run', False): - prin(" ".join([sq(x) for x in (kwargs['argv0'], '--correct-profile-only', video)])) +def dry_system(cmd, **opts): + quoted = sq(cmd) + if opts['dry_run']: + prin(quoted) else: - level_string = struct.pack('b', int('29', 16)) - fobj = open(video, 'r+b') - try: - fobj.seek(7) - verbose_print(1, 'correcting profile:', video) - fobj.write(level_string) - finally: - fobj.close() - -def mkv_extract_track(mkv, out, track, **kwargs): - verboos = kwargs.get('verbose', 0) - cmd = ['mkvextract', 'tracks', mkv] - if verboos > 0: - cmd.extend(['-v']) - cmd.extend(["%s:%s" % (str(track), out)]) - command(*cmd, **kwargs) + os.system(quoted) + class MkvInfo(object): - track_no_re = None - track_type_re = None - codec_re = None - a_codec_re = None - v_codec_re = None - fps_re = None - def __init__(self, mkv): - if MkvInfo.track_no_re is None: - MkvInfo.track_no_re = re.compile(r'^\| \+ Track number: (\d+)$') - if MkvInfo.track_type_re is None: - MkvInfo.track_type_re = re.compile(r'^\| \+ Track type: (.*)$') - if MkvInfo.codec_re is None: - MkvInfo.codec_re = re.compile(r'^\| \+ Codec ID: (.*)$') - if MkvInfo.a_codec_re is None: - MkvInfo.a_codec_re = re.compile(r'^(A_)?(DTS|AAC|AC3)$') - if MkvInfo.v_codec_re is None: - MkvInfo.v_codec_re = re.compile(r'^(V_)?(MPEG4/ISO/AVC)$') - if MkvInfo.fps_re is None: - MkvInfo.fps_re = re.compile(r'^\| \+ Default duration: ' + _impl = None + + class _Impl: + def __init__(self): + self.track_no_re = re.compile(r'^\| \+ Track number: (\d+)$') + self.track_type_re = re.compile(r'^\| \+ Track type: (.*)$') + self.codec_re = re.compile(r'^\| \+ Codec ID: (.*)$') + self.a_codec_re = re.compile(r'^(A_)?(DTS|AAC|AC3)$') + self.v_codec_re = re.compile(r'^(V_)?(MPEG4/ISO/AVC)$') + self.fps_re = re.compile(r'^\| \+ Default duration: ' '\d+\.\d+ms \((\d+\.\d+) fps for a video track\)$') - self.track = {'audio': None, 'video':None} - infolines = command('mkvinfo', mkv, env={'LC_ALL':'C'}).split('\n') - + @classmethod + def info(cls, mkv): + if cls._impl is None: + cls._impl = cls._Impl() + i = {} + i['track'] = {'audio': None, 'video': None} + infolines = command(['mkvinfo', mkv], env={'LC_ALL':'C'}).split('\n') in_track_number = None in_track_type = None for line in infolines: - match = MkvInfo.track_no_re.search(line) + match = cls._impl.track_no_re.search(line) if match is not None: in_track_number = match.group(1) in_track_type = None - verbose_print(1, 'MkvInfo: in track number: %s' % in_track_number) + vprint(1, 'MkvInfo: in track number: %s' % in_track_number) continue if in_track_number is not None: - match = MkvInfo.track_type_re.search(line) + match = cls._impl.track_type_re.search(line) if match is not None: in_track_type = match.group(1) - verbose_print(1, 'MkvInfo: in track type: %s' % in_track_type) - self.track[in_track_type] = in_track_number + vprint(1, 'MkvInfo: in track type: %s' % in_track_type) + i['track'][in_track_type] = in_track_number if in_track_type != 'audio' and in_track_type != 'video': - warning_print('ignoring track type: %s' % in_track_type) + wprint('ignoring track type: %s' % in_track_type) if in_track_number is not None: - match = MkvInfo.codec_re.search(line) + match = cls._impl.codec_re.search(line) if match is not None: codec = match.group(1) # unrecognized track types shouldn't have codec_match := None codec_match = None if in_track_type == 'audio': - codec_match = MkvInfo.a_codec_re.search(codec) + codec_match = cls._impl.a_codec_re.search(codec) if codec_match is None: die('unrecognised codec: %s' % codec) elif in_track_type == 'video': - codec_match = MkvInfo.v_codec_re.search(codec) + codec_match = cls._impl.v_codec_re.search(codec) if codec_match is None: die('unrecognised codec: %s' % codec) if codec_match is not None: key = in_track_type + '_codec' - self.track[key] = codec_match.group(2) - verbose_print(1, 'MkvInfo: found %s: %s' % (key, self.track[key])) + i['track'][key] = codec_match.group(2) + vprint(1, 'MkvInfo: found %s: %s' % (key, i['track'][key])) if in_track_type == 'video': - match = MkvInfo.fps_re.search(line) + match = cls._impl.fps_re.search(line) if match is not None: - self.track['fps'] = match.group(1) - - if self.track.get('video', None) is None: + i['track']['fps'] = match.group(1) + if i['track'].get('video', None) is None: die('no video track found') - if self.track.get('audio', None) is None: + if i['track'].get('audio', None) is None: die('no audio track found') -# XXX update this old func -def mkv_split(mkv, pieces): - if pieces != 1: - split_size_MB = (((os.path.getsize(mkv) / pieces) + 1) / 1000) + 1 - command('mkvmerge', '-o', mkv, '--split', str(split_size_MB)) -def exit_if(bbool): - if bbool: - sys.exit(0) +def default_options(argv0): + return {'argv0': argv0 + ,'verbosity': 0 + ,'a_bitrate': '328' + ,'a_channels': '5.1' + ,'a_codec': 'libfaac' + ,'a_delay': None + ,'output': None + ,'keep_temp_files': False + ,'dry_run': False + ,'correct_prof_only': False + ,'stop_v_ex': False + ,'stop_correct': False + ,'stop_a_ex': False + ,'stop_a_conv': False + ,'stop_v_mp4': False + ,'stop_hint_mp4': False + ,'stop_a_mp4': False + ,'mp4': 'mp4creator' + } + + +def mp4_add_audio_optimize_cmd(mp4, audio, **kwargs): + if kwargs['mp4'] == 'mp4creator': + return ['mp4creator', '-c', audio, '-interleave', '-optimize', mp4] + elif kwargs['mp4'] == 'mp4box': + delay = kwargs.get('delay', None) + if delay is not None: + delay = ':delay='+delay + else: + delay = '' + return ['MP4Box', '-add', audio+'#audio:trackID=2'+delay, mp4] + + +def mp4_add_hint_cmd(mp4, **kwargs): + if kwargs['mp4'] == 'mp4creator': + return ['mp4creator', '-hint=1', mp4] + elif kwargs['mp4'] == 'mp4box': + return None -def real_main(mkv, argv0): - mkvinfo = MkvInfo(mkv) + +def mp4_add_video_cmd(mp4, video, fps, **kwargs): + if kwargs['mp4'] == 'mp4creator': + return ['mp4creator', '-c', video, '-rate', fps, mp4] + elif kwargs['mp4'] == 'mp4box': + return ['MP4Box', '-add', video+'#video:trackID=1', '-hint', '-fps', fps, mp4] + + +def ffmpeg_convert_audio_cmd(old, new, **kwargs): + bitrate = kwargs.get('bitrate', '128') + channels = kwargs.get('channels', '2') + codec = kwargs.get('codec', 'libfaac') + verbosity = kwargs.get('verbosity', 0) + if str(channels) == '5.1': + channels = '6' + if verbosity > 1: + cmd = ['ffmpeg', '-v', str(verbosity - 1)] + else: + cmd = ['ffmpeg'] + return cmd + ['-i', old, '-ac', str(channels), '-acodec', codec + ,'-ab', str(bitrate) + 'k', new + ] + + +def pretend_correct_rawmp4_profile(rawmp4, argv0): + prin(sq([argv0, '--correct-profile-only', rawmp4])) + + +def correct_rawmp4_profile(rawmp4): + level_string = struct.pack('b', int('29', 16)) + f = open(rawmp4, 'r+b') try: - video = mkv+'.h264' - exit_if(g_opts.stop_v_ex) - mkv_extract_track(mkv, video, mkvinfo.track['video'] - , dry_run=g_opts.dry_run, verbose=g_opts.verbose) + f.seek(7) + vprint(1, 'correcting profile:', rawmp4) + f.write(level_string) + finally: + f.close() - exit_if(g_opts.stop_correct) - correct_profile(video, argv0=argv0 - , dry_run=g_opts.dry_run, verbose=g_opts.verbose) - a_codec = mkvinfo.track['audio_codec'] - audio = mkv+'.'+a_codec.lower() - exit_if(g_opts.stop_a_ex) - mkv_extract_track(mkv, audio, mkvinfo.track['audio'] - , dry_run=g_opts.dry_run, verbose=g_opts.verbose) - exit_if(g_opts.stop_a_conv) - if a_codec != 'AAC': - audio, oldaudio = audio+'.aac', audio - convert_audio(oldaudio, audio - , codec=g_opts.a_codec, bitrate=g_opts.a_bitrate - , channels=g_opts.a_channels - , keep_temp=g_opts.keep_temp_files - , dry_run=g_opts.dry_run - , verbose=g_opts.verbose - ) - - if g_opts.output is None: - g_opts.output = os.path.splitext(mkv)[0]+'.mp4' - exit_if(g_opts.stop_v_mp4) - mp4_add_video(g_opts.output, video, fps=mkvinfo.track['fps'] - , dry_run=g_opts.dry_run - , verbose=g_opts.verbose - ) - exit_if(g_opts.stop_hint_mp4) - mp4_add_hint(g_opts.output, dry_run=g_opts.dry_run - , verbose=g_opts.verbose) - - exit_if(g_opts.stop_a_mp4) - mp4_add_audio_optimize(g_opts.output, audio, dry_run=g_opts.dry_run - , delay=g_opts.a_delay - , verbose=g_opts.verbose) +def dry_correct_rawmp4_profile(rawmp4, **opts): + if opts['dry_run']: + pretend_correct_rawmp4_profile(rawmp4, opts['argv0']) + else: + correct_rawmp4_profile(rawmp4, **opts) + + +def mkv_extract_track_cmd(mkv, out, track, verbosely=False): + v = [] + if verbosely: v = ['-v'] + return ['mkvextract', 'tracks', mkv] + v + [str(track) + ':' + out] + + +# XXX not used +#def mkv_split(mkv, pieces): +# if pieces != 1: +# split_size_MB = (((os.path.getsize(mkv) / pieces) + 1) / 1000) + 1 +# command(['mkvmerge', '-o', mkv, '--split', str(split_size_MB)]) + + +def exit_if(bbool, value=0): + if bbool: + sys.exit(value) + +def real_main(mkv, **opts): + mkvinfo = MkvInfo.info(mkv) + mkvtracks = mkvinfo['track'] + tempfiles = [] + try: + # Extract video + video = mkv+'.h264' + exit_if(opts['stop_v_ex']) + extract_cmd = mkv_extract_track_cmd(mkv, out=video, track=mkvtracks['video'], verbosely=(opts['verbosity'] > 0)) + tempfiles.append(video) + dry_command(extract_cmd, **opts) + exit_if(opts['stop_correct']) + # Correct profile + dry_correct_rawmp4_profile(video, **opts) + a_codec = mkvtracks['audio_codec'] + audio = mkv+'.'+a_codec.lower() + exit_if(opts['stop_a_ex']) + # Extract audio + extract_cmd = mkv_extract_track_cmd(mkv, out=audio, track=mkvtracks['audio'], verbosely=(opts['verbosity'] > 0)) + tempfiles.append(audio) + dry_command(extract_cmd, **opts) + exit_if(opts['stop_a_conv']) + # Convert audio + if str(a_codec).lower() != 'aac': + aacaudio, oldaudio = audio+'.aac', audio + audio_cmd = ffmpeg_convert_audio_cmd(oldaudio, aacaudio, **opts) + tempfiles.append(aacaudio) + dry_system(audio_cmd, **opts) + if opts['output'] is None: + opts['output'] = os.path.splitext(mkv)[0]+'.mp4' + exit_if(opts['stop_v_mp4']) + # Create mp4 container with video + mp4video_cmd = mp4_add_video_cmd(opts['output'], video, fps=mkvtracks['fps']) + dry_command(mp4video_cmd, **opts) + exit_if(opts['stop_hint_mp4']) + # Hint mp4 container + mp4hint_cmd = mp4_add_hint_cmd(opts['output'], **opts) + dry_command(mp4hint_cmd, **opts) + exit_if(opts['stop_a_mp4']) + # Add audio to mp4 container and optimize + mp4opt_cmd = mp4_add_audio_optimize_cmd(opts['output'], aacaudio, **opts) + dry_command(mp4opt_cmd, **opts) finally: - try: - if not g_opts.keep_temp_files: - try: - os.remove(video) - except OSError: - pass + if not opts['keep_temp_files']: + for f in tempfiles: try: - os.remove(audio) + os.remove(f) except OSError: pass - except Exception: - pass -def main(argv=None): - if argv is None: - argv = sys.argv - global g_opts - g_opts = Options() +def parseopts(argv=None): + opts = default_options(argv[0]) try: - opts, args = getopt.gnu_getopt(argv[1:] + options, arguments = getopt.gnu_getopt(argv[1:] , 'hvo:n' , ['help', 'usage', 'version', 'verbose' , 'use-mp4box', 'use-mp4creator' @@ -357,68 +350,68 @@ def main(argv=None): ]) except getopt.GetoptError, err: die(str(err)) - - for opt, optarg in opts: + for opt, optarg in options: if opt in ('-h', '--help', '--usage'): - usage_print() + prin(usage) sys.exit(0) elif opt == '--version': - version_print() + prin(__version__) sys.exit(0) elif opt in ('-v', '--verbose'): - g_opts.verbose = g_opts.verbose + 1 + opts['verbosity'] = opts['verbosity'] + 1 elif opt == '--use-mp4creator': - g_opts.mp4 = 'mp4creator' + opts['mp4'] = 'mp4creator' elif opt == '--use-mp4box': - g_opts.mp4 = 'mp4box' + opts['mp4'] = 'mp4box' elif opt == '--audio-delay-ms': - g_opts.a_delay = optarg + opts['a_delay'] = optarg elif opt == '--audio-bitrate': - g_opts.a_bitrate = optarg + opts['a_bitrate'] = optarg elif opt == '--audio-channels': - g_opts.a_channels = optarg + opts['a_channels'] = optarg elif opt == '--audio-codec': - g_opts.a_codec = optarg + opts['a_codec'] = optarg elif opt in ('-o', '--output'): - g_opts.output = optarg + opts['output'] = optarg elif opt == '--keep-temp-files': - g_opts.keep_temp_files = True + opts['keep_temp_files'] = True elif opt in ('-n', '--dry-run'): - g_opts.dry_run = True + opts['dry_run'] = True elif opt == '--correct-profile-only': - g_opts.correct_prof_only = True + opts['correct_prof_only'] = True elif opt == '--stop-before-extract-video': - g_opts.stop_v_ex = True + opts['stop_v_ex'] = True elif opt == '--stop-before-correct-profile': - g_opts.stop_correct = True + opts['stop_correct'] = True elif opt == '--stop-before-extract-audio': - g_opts.stop_a_ex = True + opts['stop_a_ex'] = True elif opt == '--stop-before-convert-audio': - g_opts.stop_a_conv = True + opts['stop_a_conv'] = True elif opt == '--stop-before-video-mp4': - g_opts.stop_v_mp4 = True + opts['stop_v_mp4'] = True elif opt == '--stop-before-hinting-mp4': - g_opts.stop_hint_mp4 = True + opts['stop_hint_mp4'] = True elif opt == '--stop-before-audio-mp4': - g_opts.stop_a_mp4 = True - - if len(args) == 0: - usage_io = StringIO() - usage_print(fobj=usage_io) - die(usage_io.getvalue(), end='') - elif len(args) > 1: - usage_print(fobj=sys.stderr) - if g_opts.a_delay is not None and g_opts.mp4 == 'mp4creator': - die("Cannot use --audio-delay-ms with mp4creator. Try --use-mp4box") + opts['stop_a_mp4'] = True + return opts, arguments - mkv = args[0] - if g_opts.correct_prof_only: - correct_profile(mkv, dry_run=g_opts.dry_run, argv0=argv[0]) - else: - real_main(mkv, argv0=argv[0]) +def main(argv=None): + if argv is None: + argv = sys.argv + opts, args = parseopts(argv) + if len(args) != 1: + die(usage) + if opts['a_delay'] is not None and opts['mp4'] == 'mp4creator': + die("Cannot use --audio-delay-ms with mp4creator. Try --use-mp4box") + try: + if opts['correct_prof_only']: + dry_correct_rawmp4_profile(args[0], **opts) + else: + real_main(args[0], **opts) + except Exception, e: + die('failed with exception:', str(e)) - return 0; if __name__ == "__main__": sys.exit(main()) diff --git a/setup.py.in b/setup.py similarity index 60% rename from setup.py.in rename to setup.py index 0cd0caf..2bfc10f 100644 --- a/setup.py.in +++ b/setup.py @@ -1,4 +1,3 @@ -#!/usr/bin/python """Convert H.264 mkv files to mp4 files playable on the PS3 @@ -7,7 +6,7 @@ """ from distutils.core import setup - +import mkvtomp4 # A list of classifiers can be found here: # http://pypi.python.org/pypi?%3Aaction=list_classifiers @@ -19,7 +18,7 @@ Topic :: Multimedia :: Sound/Audio :: Conversion Topic :: Multimedia :: Video :: Conversion Intended Audience :: End Users/Desktop -License :: OSI Approved :: GNU General Public License (GPL) +License :: OSI Approved :: MIT License Programming Language :: Python Operating System :: OS Independent """ @@ -35,20 +34,20 @@ def setup(**kwargs): doclines = __doc__.split("\n") -setup(name='mkvtomp4', - description=doclines[0], - long_description="\n".join(doclines[2:]), - author='Gavin Beatty', - author_email='gavinbeatty@gmail.com', - maintainer='Gavin Beatty', - maintainer_email='gavinbeatty@gmail.com', - license = "http://www.gnu.org/licenses/gpl-3.0.txt", - platforms=["any"], - classifiers=filter(None, classifiers.split("\n")), - url='http://code.google.com/p/mkvtomp4/', -# @VERSION@ - scripts=['mkvtomp4'], -# data_files=[('share/doc/mkvtomp4', ['README.markdown']) +setup(name='mkvtomp4' + ,description=doclines[0] + ,long_description="\n".join(doclines[2:]) + ,author='Gavin Beatty' + ,author_email='gavinbeatty@gmail.com' + ,maintainer='Gavin Beatty' + ,maintainer_email='gavinbeatty@gmail.com' + ,license = 'http://opensource.org/licenses/MIT' + ,platforms=["any"] + ,classifiers=filter(None, classifiers.split("\n")) + ,url='http://code.google.com/p/mkvtomp4/' + ,version=mkvtomp4.__version__ + ,scripts=['mkvtomp4'] +# ,data_files=[('share/doc/mkvtomp4', ['README.md']) # , ('share/man/man1', ['doc/mkvtomp4.1', 'doc/mkvtomp4.1.html']) # ] )