diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/FiraSans-Bold.ttf b/FiraSans-Bold.ttf new file mode 100644 index 0000000..f03425a Binary files /dev/null and b/FiraSans-Bold.ttf differ diff --git a/FiraSans-Regular.ttf b/FiraSans-Regular.ttf new file mode 100644 index 0000000..0118749 Binary files /dev/null and b/FiraSans-Regular.ttf differ diff --git a/OFL.txt b/OFL.txt new file mode 100644 index 0000000..a978713 --- /dev/null +++ b/OFL.txt @@ -0,0 +1,92 @@ +Digitized data copyright 2012-2018: The Mozilla Foundation, Telefonica S.A., Carrois Corporate GbR and bBox Type GmbH. + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..01e587e --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +# ipmpv + +## Introduction + +This Python script is designed to turn your Linux machine into an IPTV player, using MPV for video playback, Pygame for an OSD, and Flask as a remote controllable GUI. + +It was designed with a Raspberry Pi using composite output in mind, some features may not work in all devices, but it's otherwise functional. + +## Setup + +You must provide your own IPTV list in the form of an M3U URL. Set the IPMPV_M3U_URL variable, run the "run.sh" script in an graphical session, access http://[your-machine-ip]:5000 in a web browser, and you're ready to go! + +I recommend using a Raspberry Pi 4, and transcoding the video streams to 480p, as video acceleration support does not seem to play well with this app yet. + +Video is stretched to fill the screen by default. Feel free to tweak the MPV settings in the script itself, a better way to change them is Coming Soon™ + +## Features + +- TV channel selection + +- Deinterlacing (can be slow in older Pis) + +- Low latency mode + +- Support for custom URL playback + +- Support for starting RetroArch, pairs well with the Pi for CRT retro gaming + +- Resolution switching for the Raspberry Pi's composite output + +## Requirements + +This application will only run on Linux under an X11 session. + +A Bash script is included to install the following in a virtual environment: + +- PyQT5 + +- Flask + +- Regex + +- Pillow + +- Requests + +- Python-MPV + +Additionally, the following applications and libraries are required to be installed in the host system: + +- Python >= 3.10 + +- libmpv + +- wmctl + +- (Optional) yt-dlp, for YouTube video playback + +- (RPI Specific) python3-pyqt5, it won't install via pip due to RAM constraints + +## Coming Soon + +### Short term + +- A way to change MPV settings without editing the script + +- Better support for the Pi's HDMI output, more resolution support + +### Long term + +- A recommended environment, perhaps in the form of a Pi .img + +- Docker image??? + +## License + +This software is licensed under the GNU General Public License v3. See COPYING. + +The Fira Sans font is licensed under the SIL Open Font License. See OFL.txt. Fira is a trademark of The Mozilla Corporation. diff --git a/main.py b/main.py old mode 100644 new mode 100755 index 73b85dd..4aaad62 --- a/main.py +++ b/main.py @@ -1,121 +1,834 @@ +#!/usr/bin/python +import sys import mpv import requests import flask import re -from flask import request +import subprocess +import os +import time +import threading +import io +import multiprocessing -XTEVE_M3U_URL = "http://tv.netpaws.cc/m3u/xteve.m3u" +from PIL import Image + +from flask import request +from flask import jsonify + +from PyQt5.QtWidgets import QApplication, QWidget, QLabel, QVBoxLayout, QHBoxLayout +from PyQt5.QtCore import Qt, QObject, QTimer, QRect, pyqtSignal, pyqtSlot +from PyQt5.QtGui import QPainter, QColor, QFont, QPen, QBrush, QPixmap, QPainterPath + +from multiprocessing import Queue + +import traceback + +os.environ["LC_ALL"] = "C" +os.environ["LANG"] = "C" + +is_wayland = "WAYLAND_DISPLAY" in os.environ + +to_qt_queue = Queue() +from_qt_queue = Queue() + +M3U_URL = os.environ.get('IPMPV_M3U_URL') + +class OsdWidget(QWidget): + def __init__(self, channel_info, width=600, height=165, close_time=5, corner_radius=15): + global is_wayland + super().__init__() + + self.channel_info = channel_info + self.orig_width = width + self.orig_height = height + self.close_time = close_time + self.corner_radius = corner_radius + self.video_codec = None + self.audio_codec = None + self.video_res = None + self.interlaced = None + + # Setup window + self.setWindowTitle("OSD") + self.setFixedSize(width, height) + + # Check if we're running on Wayland + self.is_wayland = is_wayland + + # Set appropriate window flags and size + if self.is_wayland: + # For Wayland, use fullscreen transparent approach + self.setWindowFlags( + Qt.FramelessWindowHint | + Qt.WindowStaysOnTopHint | + Qt.WindowDoesNotAcceptFocus + ) + + # Set fullscreen size + self.screen_geometry = QApplication.desktop().screenGeometry() + self.setFixedSize(self.screen_geometry.width(), self.screen_geometry.height()) + + # Calculate content positioning + self.content_x = (self.screen_geometry.width() - self.orig_width) // 2 + self.content_y = 20 # 20px from top + else: + # For X11, use the original approach + self.setWindowFlags( + Qt.FramelessWindowHint | + Qt.WindowStaysOnTopHint | + Qt.X11BypassWindowManagerHint | + Qt.Tool | + Qt.ToolTip + ) + self.setFixedSize(width, height) + self.content_x = 0 + self.content_y = 0 + + # Enable transparency + self.setAttribute(Qt.WA_TranslucentBackground) + + # Position window at the top center of the screen + self.position_window() + + # Load logo if available + self.logo_pixmap = None + if channel_info["logo"]: + self.load_logo() + + if self.is_wayland: + self.setAttribute(Qt.WA_TransparentForMouseEvents) + + def position_window(self): + if self.is_wayland: + # For Wayland, we just position at 0,0 (fullscreen) + self.move(0, 0) + + # Ensure window stays on top + self.stay_on_top_timer = QTimer(self) + self.stay_on_top_timer.timeout.connect(lambda: self.raise_()) + self.stay_on_top_timer.start(100) # Check every second + else: + # For X11, center at top + screen_geometry = QApplication.desktop().screenGeometry() + x = (screen_geometry.width() - self.orig_width) // 2 + y = 20 # 20px from top + self.setGeometry(x, y, self.orig_width, self.orig_height) + + # X11 specific window hints + self.setAttribute(Qt.WA_X11NetWmWindowTypeNotification) + QTimer.singleShot(100, lambda: self.move(x, y)) + QTimer.singleShot(500, lambda: self.move(x, y)) + + # Periodically ensure window stays on top + self.stay_on_top_timer = QTimer(self) + self.stay_on_top_timer.timeout.connect(lambda: self.raise_()) + self.stay_on_top_timer.start(1000) # Check every second + + def load_logo(self): + try: + response = requests.get(self.channel_info["logo"]) + if response.ok: + pixmap = QPixmap() + pixmap.loadFromData(response.content) + if not pixmap.isNull(): + self.logo_pixmap = pixmap.scaled(80, 80, Qt.KeepAspectRatio, Qt.SmoothTransformation) + self.update() # Trigger repaint + except Exception as e: + print(f"Failed to load logo: {e}") + + def paintEvent(self, event): + painter = QPainter(self) + painter.setRenderHint(QPainter.Antialiasing) + + if self.is_wayland: + # For Wayland, we're drawing the content in the right position on a fullscreen widget + self.draw_osd_content(painter, self.content_x, self.content_y) + else: + # For X11, we're drawing directly at (0,0) since the widget is already positioned + self.draw_osd_content(painter, 0, 0) + def draw_osd_content(self, painter, x_offset, y_offset): + # Create a path for rounded rectangle background + path = QPainterPath() + path.addRoundedRect( + x_offset, y_offset, + self.orig_width, self.orig_height, + self.corner_radius, self.corner_radius + ) + + # Fill the rounded rectangle with semi-transparent background + painter.setPen(Qt.NoPen) + painter.setBrush(QColor(0, 50, 100, 200)) # RGBA + painter.drawPath(path) + + # Setup text drawing + painter.setPen(QColor(255, 255, 255)) + + # Use Fira Sans as originally intended + try: + font = QFont("Fira Sans", 18) + font.setBold(True) + painter.setFont(font) + + # Draw channel name + painter.drawText(x_offset + 20, y_offset + 40, self.channel_info["name"]) + + font.setPointSize(14) + font.setBold(False) + painter.setFont(font) + + # Draw deinterlace status + painter.drawText(x_offset + 20, y_offset + 70, f"Deinterlacing {'on' if self.channel_info['deinterlace'] else 'off'}") + + # Draw latency mode + painter.drawText(x_offset + 20, y_offset + 100, f"{'Low' if self.channel_info['low_latency'] else 'High'} latency") + + # Draw codec badges if available + if self.video_codec: + self.draw_badge(painter, self.video_codec, x_offset + 80, y_offset + self.orig_height - 40) + if self.audio_codec: + self.draw_badge(painter, self.audio_codec, x_offset + 140, y_offset + self.orig_height - 40) + if self.video_res: + self.draw_badge(painter, f"{self.video_res}{self.interlaced if self.interlaced is not None else ''}", x_offset + 20, y_offset + self.orig_height - 40) + # Draw logo if available + if self.logo_pixmap: + painter.drawPixmap(x_offset + self.orig_width - 100, y_offset + 20, self.logo_pixmap) + + except Exception as e: + print(f"Error in painting: {e}") + import traceback + traceback.print_exc() + + def draw_badge(self, painter, text, x, y): + # Save current painter state + painter.save() + + # Draw rounded badge + painter.setPen(QPen(QColor(255, 255, 255, 255), 2)) + painter.setBrush(Qt.NoBrush) + + # Use QPainterPath for consistent rounded corners + badge_path = QPainterPath() + badge_path.addRoundedRect(x, y, 48, 20, 7, 7) + painter.drawPath(badge_path) + + # Draw text + painter.setPen(QColor(255, 255, 255)) + font = painter.font() + font.setBold(True) + font.setPointSize(8) + painter.setFont(font) + + # Center text in badge + font_metrics = painter.fontMetrics() + text_width = font_metrics.width(text) + text_height = font_metrics.height() + + # We need to use integer coordinates for drawText, not floats + text_x = int(x + (48 - text_width) / 2) + text_y = int(y + text_height) + + # Use the int, int, string version of drawText + painter.drawText(text_x, text_y, text) + + # Restore painter state + painter.restore() + + def update_codecs(self, video_codec, audio_codec, video_res, interlaced): + if video_codec: + self.video_codec = video_codec + if audio_codec: + self.audio_codec = audio_codec + if video_res: + self.video_res = video_res + if interlaced is not None: + self.interlaced = f"{'i' if interlaced else 'p'}" + self.update() # Trigger repaint + + def close_widget(self): + # Stop any active timers + if hasattr(self, 'stay_on_top_timer') and self.stay_on_top_timer.isActive(): + self.stay_on_top_timer.stop() + # Close the widget + self.hide() + + def start_close_timer(self, seconds=5): + """ + Starts a timer to close the widget after the specified number of seconds. + + Parameters: + seconds (int): Number of seconds before closing the widget (default: 3) + """ + # Cancel any existing close timer + if hasattr(self, 'close_timer') and self.close_timer.isActive(): + self.close_timer.stop() + + # Create and start a new timer + self.close_timer = QTimer(self) + self.close_timer.setSingleShot(True) + self.close_timer.timeout.connect(self.close_widget) + self.close_timer.start(seconds * 1000) # Convert seconds to milliseconds + +osd = None + +def qt_process(): + """Run Qt application in a separate process""" + from PyQt5.QtWidgets import QApplication + from PyQt5.QtCore import QTimer + + app = QApplication(sys.argv) + osd = None + + # Check the queue periodically for commands + + def check_queue(): + global osd + if not to_qt_queue.empty(): + command = to_qt_queue.get() + if command['action'] == 'show_osd': + if osd is not None: + osd.close_widget() + # Create new OSD + osd = OsdWidget(command['channel_info']) + osd.show() + elif command['action'] == 'start_close': + if osd is not None: + osd.start_close_timer() + elif command['action'] == 'close_osd': + if osd is not None: + osd.close_widget() + osd = None + elif command['action'] == 'update_codecs': + if osd is not None: + osd.update_codecs(command['vcodec'], command['acodec'], command['video_res'], command['interlaced']) + # Schedule next check + QTimer.singleShot(100, check_queue) + + # Start the queue check + check_queue() + + # Run Qt event loop + app.exec_() def get_channels(): - response = requests.get(XTEVE_M3U_URL) - lines = response.text.splitlines() - - channels = [] - regex = re.compile(r'tvg-logo="(.*?)".*?group-title="(.*?)"', re.IGNORECASE) + if M3U_URL: + response = requests.get(M3U_URL) + else: + print("Error: IPMPV_M3U_URL not set. Please set this environment variable to the URL of your IPTV list, in M3U format.") + exit(1) + lines = response.text.splitlines() + + channels = [] + regex = re.compile(r'tvg-logo="(.*?)".*?group-title="(.*?)"', re.IGNORECASE) - for i in range(len(lines)): - if lines[i].startswith("#EXTINF"): - match = regex.search(lines[i]) - logo = match.group(1) if match else "" - group = match.group(2) if match else "Other" - name = lines[i].split(",")[-1] - url = lines[i + 1] + for i in range(len(lines)): + if lines[i].startswith("#EXTINF"): + match = regex.search(lines[i]) + logo = match.group(1) if match else "" + group = match.group(2) if match else "Other" + name = lines[i].split(",")[-1] + url = lines[i + 1] - channels.append({"name": name, "url": url, "logo": logo, "group": group}) + channels.append({"name": name, "url": url, "logo": logo, "group": group}) - return channels + return channels + +def get_current_resolution(): + global is_wayland + try: + if is_wayland: + wlr_randr_env = os.environ.copy() + wlr_randr_env["WAYLAND_DISPLAY"] = "wayland-1" + output = subprocess.check_output(["wlr-randr"], universal_newlines=True, env=wlr_randr_env) + if "Composite-1" in output.split("\n")[0]: + for line in output.split("\n"): + if "720x480" in line and "current" in line: + return "480i" + elif "720x240" in line and "current" in line: + return "240p" + elif "720x576" in line and "current" in line: + return "576i" + elif "720x288" in line and "current" in line: + return "288p" + else: + xrandr_env = os.environ.copy() + xrandr_env["DISPLAY"] = ":0" + output = subprocess.check_output(["xrandr"], universal_newlines=True, env=xrandr_env) + for line in output.split("\n"): + if "Composite-1" in line: + if "720x480" in line: + return "480i" + elif "720x240" in line: + return "240p" + elif "720x576" in line: + return "576i" + elif "720x288" in line: + return "288p" + except subprocess.CalledProcessError: + if is_wayland: + print("Error: Cannot get display resolution. Is this a wl-roots compatible compositor?") + else: + print("Error: Cannot get display resolution. Is an X session running?") + except FileNotFoundError: + if is_wayland: + print("Error: Could not find wlr-randr, resolution will be unknown") + else: + print("Error: Could not find xrandr, resolution will be unknown") + return "UNK" + +def error_check(loglevel, component, message): + global player + print(f"[{loglevel}] {component}: {message}") + if loglevel == 'error' and (component == 'ffmpeg' or component == 'cplayer') and 'Failed' in message: + player.loadfile("./nosignal.png") + to_qt_queue.put({ + 'action': 'start_close' + }) player = mpv.MPV( - vo='gpu', - demuxer_lavf_o='reconnect=1', - deinterlace='yes', - keepaspect = 'no', - geometry = '100%:100%' + # it's a bit weird that i have to use the logs to get errors, + # but catch_errors is apparently broken + log_handler = error_check, + vo = 'gpu', + hwdec = 'auto-safe', + demuxer_lavf_o = 'reconnect=1', + deinterlace = 'no', + keepaspect = 'no', + geometry = '100%:100%', + fullscreen = 'yes', + loop_playlist = 'inf' ) +deinterlace = False channels = get_channels() -current_index = 0 +current_index = None +retroarch_p = None +resolution = get_current_resolution() +low_latency = False +vcodec = None +acodec = None +video_res = None +interlaced = None + +@player.property_observer('video-format') +def video_codec_observer(name, value): + global vcodec, acodec + if value: + vcodec = value.upper() + +@player.property_observer('audio-codec-name') +def audio_codec_observer(name, value): + global acodec, vcodec + if value: + acodec = value.upper() def play_channel(index): - global current_index - current_index = index % len(channels) - print(f"Playing {channels[current_index]["url"]}") - player.play(channels[current_index]["url"]) + global current_index, vcodec, acodec, video_res, interlaced + print(f"\n=== Starting channel change to index {index} ===") + + to_qt_queue.put({ + 'action': 'close_osd' + }) + print("Closed OSD") + + vcodec = None + acodec = None + current_index = index % len(channels) + print(f"Playing channel: {channels[current_index]['name']} ({channels[current_index]['url']})") + + try: + player.loadfile("./novideo.png") + player.wait_until_playing() + + channel_info = { + "name": channels[current_index]["name"], + "deinterlace": deinterlace, + "low_latency": low_latency, + "logo": channels[current_index]["logo"] + } + + to_qt_queue.put({ + 'action': 'show_osd', + 'channel_info': channel_info + }) + + player.loadfile(channels[current_index]['url']) + time.sleep(0.5) + player.wait_until_playing() -play_channel(current_index) + video_params = player.video_params + video_frame_info = player.video_frame_info + if video_params and video_frame_info: + video_res = video_params.get('h') + interlaced = video_frame_info.get('interlaced') + to_qt_queue.put({ + 'action': 'update_codecs', + 'vcodec': vcodec, + 'acodec': acodec, + 'video_res': video_res, + 'interlaced': interlaced + }) + + to_qt_queue.put({ + 'action': 'start_close', + }) + + except Exception as e: + print(f"\033[91mError in play_channel: {str(e)}\033[0m") + traceback.print_exc() -# Flask web server app = flask.Flask(__name__) +# Flask routes here @app.route("/") def index(): - grouped_channels = {} - for channel in channels: - grouped_channels.setdefault(channel["group"], []).append(channel) + grouped_channels = {} + for channel in channels: + grouped_channels.setdefault(channel["group"], []).append(channel) + + flat_channel_list = [channel for channel in channels] - html = f""" - - - IPTV Remote - - - -

IPTV Remote

-

Current Channel: {channels[current_index]['name']}

- - -

All Channels

-
- """ - - flat_channel_list = [channel for group in grouped_channels.values() for channel in group] + html = f""" + + + IPMPV + + + +

Welcome to IPMPV

+

Current Channel: {channels[current_index]['name'] if current_index is not None else "None"}

+ + """ +# +# - for group, ch_list in grouped_channels.items(): - html += f'
{group}' - for channel in ch_list: - index = flat_channel_list.index(channel) # Get correct global index - html += f''' -
- - -
- ''' - html += '
' + global deinterlace + global low_latency + deinterlace_state = "ON" if deinterlace else "OFF" + retroarch_state = "ON" if retroarch_p and retroarch_p.poll() is None else "OFF" + html += f""" + + + +

Toggle OSD

+ + """ + html += f""" +

Play Custom URL

+ +

All Channels

+
+ """ + + for group, ch_list in grouped_channels.items(): + html += f'
{group}' + for channel in ch_list: + index = flat_channel_list.index(channel) # Get correct global index + html += f''' +
+ + +
+ ''' + html += '
' - html += """ -
- - - - """ + html += """ +
+ + + + """ - return html + return html + +def is_valid_url(url): + return re.match(r"^(https?|rtmp|rtmps|udp|tcp):\/\/[\w\-]+(\.[\w\-]+)*(:\d+)?([\/?].*)?$", url) is not None + +@app.route("/play_custom") +def play_custom(): + global current_index + current_index = None + url = request.args.get("url") + + if not url or not is_valid_url(url): + return jsonify(success=False, error="Invalid or unsupported URL") + + player.loadfile(url) + return jsonify(success=True) + +@app.route("/hide_osd") +def hide_osd(): + to_qt_queue.put({ + 'action': 'close_osd', + }) + return "", 204 + +@app.route("/show_osd") +def show_osd(): + if current_index is not None: + channel_info = { + "name": channels[current_index]["name"], + "deinterlace": deinterlace, + "low_latency": low_latency, + "logo": channels[current_index]["logo"] + } + to_qt_queue.put({ + 'action': 'show_osd', + 'channel_info': channel_info + }) + to_qt_queue.put({ + 'action': 'update_codecs', + 'vcodec': vcodec, + 'acodec': acodec, + 'video_res': video_res, + 'interlaced': interlaced + }) + return "", 204 @app.route("/channel") def switch_channel(): - index = int(request.args.get("index", current_index)) - play_channel(index) - return "", 204 + index = int(request.args.get("index", current_index)) + play_channel(index) + return "", 204 + +@app.route("/toggle_deinterlace") +def toggle_deinterlace(): + global deinterlace + deinterlace = not deinterlace + if deinterlace: + player['vf'] = 'yadif=0' + else: + player['vf'] = '' + return jsonify(state=deinterlace) + +@app.route("/stop_player") +def stop_player(): + global current_index + global osd + current_index = None + to_qt_queue.put({ + 'action': 'close_osd', + }) + player.stop() + return "", 204 + +@app.route("/toggle_retroarch") +def toggle_retroarch(): + global retroarch_p + retroarch_pid = subprocess.run(["pgrep", "-fx", "retroarch"], stdout=subprocess.PIPE).stdout.strip() + if retroarch_pid: + print("Retroarch already open. Trying to close it.") + subprocess.run(["kill", retroarch_pid]) + retroarch_p.terminate() + return jsonify(state=False) + else: + print("Launching RetroArch") + retroarch_env = os.environ.copy() + retroarch_env["MESA_GL_VERSION_OVERRIDE"] = "3.3" + retroarch_env["DISPLAY"] = ":0" + retroarch_p = subprocess.Popen(["/usr/bin/flatpak","run","org.libretro.RetroArch"], env=retroarch_env) + return jsonify(state=True) + +@app.route("/toggle_latency") +def toggle_latency(): + global low_latency + low_latency = not low_latency + player['audio-buffer'] = '0' if low_latency else '0.2' + player['vd-lavc-threads'] = '1' if low_latency else '0' + player['cache-pause'] = 'no' if low_latency else 'yes' + player['demuxer-lavf-o'] = 'reconnect=1,fflags=+nobuffer' if low_latency else 'reconnect=1' + player['demuxer-lavf-probe-info'] = 'nostreams' if low_latency else 'auto' + player['demuxer-lavf-analyzeduration'] = '0.1' if low_latency else '0' + player['video-sync'] = 'audio' + player['interpolation'] = 'no' + player['video-latency-hacks'] = 'yes' if low_latency else 'no' + player['stream-buffer-size'] = '4k' if low_latency else '128k' + print("JSON: ",jsonify(state=low_latency)) + return jsonify(state=low_latency) + +@app.route("/toggle_resolution") +def toggle_resolution(): + global resolution,is_wayland + new_res = "" + if is_wayland: + if resolution == "480i": + new_res = "720x240" + elif resolution == "240p": + new_res = "720x480" + elif resolution == "576i": + new_res = "720x288" + elif resolution == "288p": + new_res = "720x576" + + else: + if resolution == "480i": + new_res = "720x240" + elif resolution == "240p": + new_res = "720x480i" + elif resolution == "576i": + new_res = "720x288" + elif resolution == "288p": + new_res = "720x576i" + + if new_res: + if is_wayland: + wlr_randr_env = os.environ.copy() + wlr_randr_env["DISPLAY"] = ":0" + subprocess.run(["wlr-randr", "--output", "Composite-1", "--mode", new_res], check=False, env=wlr_randr_env) + resolution = get_current_resolution() + else: + xrandr_env = os.environ.copy() + xrandr_env["DISPLAY"] = ":0" + subprocess.run(["wlr-randr", "--output", "Composite-1", "--mode", new_res], check=False, env=xrandr_env) + resolution = get_current_resolution() + + return jsonify(res=get_current_resolution()) if __name__ == "__main__": - app.run(host="0.0.0.0", port=5000) \ No newline at end of file + # Start Qt process + qt_proc = multiprocessing.Process(target=qt_process) + qt_proc.daemon = True + qt_proc.start() + + # Start Flask in main thread + app.run(host="0.0.0.0", port=5000) diff --git a/nosignal.png b/nosignal.png new file mode 100644 index 0000000..ab3c431 Binary files /dev/null and b/nosignal.png differ diff --git a/novideo.png b/novideo.png new file mode 100644 index 0000000..1fdbdb6 Binary files /dev/null and b/novideo.png differ diff --git a/readme.md b/readme.md deleted file mode 100644 index 62841ab..0000000 --- a/readme.md +++ /dev/null @@ -1,2 +0,0 @@ -# impmv -A small IPTV player for your Raspberry Pi. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0a05fe8 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +flask +Pillow +mpv +PyQt5 +requests diff --git a/run.sh b/run.sh new file mode 100755 index 0000000..54b97a3 --- /dev/null +++ b/run.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# Check if virtual environment already exists +if [ -d "./.venv" ]; then + echo "Virtual environment already exists." +else + echo "Creating virtual environment..." + python -m venv --system-site-packages ./.venv +fi + +# Activate the virtual environment +source ./.venv/bin/activate + +# Install required packages +pip install -r requirements.txt + +# Run the application +echo "Starting..." +python main.py