diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 6eaa424..0000000 --- a/LICENSE +++ /dev/null @@ -1,690 +0,0 @@ -Jellies and Jams - a jellyfin client built into mpv - -Copyright (c) 2024 squibid - -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. - ------ - - 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/README.md b/README.md deleted file mode 100644 index fda11ce..0000000 --- a/README.md +++ /dev/null @@ -1,66 +0,0 @@ -# JnJ - Jellies and Jams -A jellyfin client built into mpv -## Configuring -Every option in JnJ may be configured via a script-message. Example: -```lua -local mp = require("mp") -local utils = require("mp.utils") - --- action keybind -mp.commandv("script-message", "jnj-bind-toggle", "Ctrl+j") -mp.commandv("script-message", "jnj-bind-enter", "l") -mp.commandv("script-message", "jnj-bind-leave", "h") -mp.commandv("script-message", "jnj-bind-down", "j") -mp.commandv("script-message", "jnj-bind-up", "k") -mp.commandv("script-message", "jnj-bind-toggle-played", "m") -mp.commandv("script-message", "jnj-bind-toggle-favorite", "s") - --- send user login info (this should be done through a script message to ensure --- other scripts cannot leach your password from the script-message -mp.commandv("script-message-to", "jellies_and_jams" "jnj-set-settings", - utils.format_json({ - url = 'http://localhost:8096', - username = 'username', - password = 'password' - })) -``` - -### Available actions -- jnj-set-settings -- jnj-bind-toggle -- jnj-bind-open -- jnj-bind-close -- jnj-bind-leave -- jnj-bind-down -- jnj-bind-up -- jnj-bind-toggle-played -- jnj-bind-toggle-favorite -- jnj-bind-top -- jnj-bind-bottom -- jnj-bind-pagedown -- jnj-bind-pageup - -`jnj-bind-*` takes a keybind as their only argument - -`jnj-set-settings` takes a json formatted string of the following structure: -```json -{ - "url":"", - "username":"", - "password":"", - "header":{ - "prefix": "jellyfin/", - "separator":"/", - "contents":[ - ["watched", " ","favorite"," ","runtime"], - ["stars"," ","rating"," ","release"] - ] - }, - "client":{ - "name":"Jellyfin Lua Client", - "device":"Mpv", - "version":"1.1" - } -} -``` -All filled in values are provided by default, but may be changed by the user. diff --git a/main.lua b/main.lua index b12807f..b83c450 100644 --- a/main.lua +++ b/main.lua @@ -1,402 +1,172 @@ -local mp = require('mp') -local msg = require('mp.msg') -local utils = require('mp.utils') +local mp = require("mp") +local msg = require("mp.msg") +local utils = require("mp.utils") -local jf = require("utils.jellyfin") +local list = require("src.list") +local auth = require("src.auth") +local api = require("src.api") +local cache = require("src.cache") +local tree = require("src.utils.tree") --- require mpv scroll list library -package.path = mp.command_native({"expand-path", "~~/script-modules/?.lua;"}) - ..package.path -local lok, list = pcall(require, "scroll-list") -if not lok then - msg.info("Install: https://github.com/CogentRedTester/mpv-scroll-list") - return 1 -end +---@type auth +local jf = nil --- make an instance of the list -local original_open = list.open -function list:open() - original_open(self) -end +-- keeps track of all the info available +local state = { + ---@type tree the currently selected node in the tree + pos = nil, + ---@type tree the head of the tree + tree = nil, -local settings = { - url = '', - username = '', - password = '', - header = { - prefix = "jellyfin/", - separator = "/", - contents = { - { "watched", " ", "favorite", " ", "runtime" }, - { "stars", " ", "rating", " ", "release" } - } - }, - client = { - name = 'Jellyfin Lua Client', - device = 'Mpv', - version = '1.1' - } + -- when we're navigating (in the middle of loading) we shouldn't allow more + -- navigations + navigating = false } ---- table containing all info about the runtime ----@type table -local rt = { - authenticated = false, -- are we connected to the server - user = {}, +-- create the main list +local l = list:new() +l:update() +local timer = l:set_fade_animation(0.02, "Authenticating") - library = jf.library(), -- current library - title = jf.library(), -- current movie or show - season = jf.library(), -- current season of show - - video = jf.video(), -- current video (movie/episode) - nextup = jf.video(), -- next video - - -- our menu to render - menu = { - items = {} -- contains table of strings to display (with ass styling) - } -} - ---- draw list to screen ----@param items table list of elements to draw to the screen -local function redraw_list(items) - -- clear out the render list - list.list = {} - - -- style each line - for i = 1, #items do - local item = {} - item.style = "" - - if items[i].UserData then - -- if the user has started watching it make it blue - if items[i].UserData.PlayedPercentage then - if items[i].UserData.PlayedPercentage > 0 then - item.style = [[{\c&Hdca400&}]]..item.style - end - -- if the user has finished watching it make it green - elseif items[i].UserData.Played then - item.style = [[{\c&H33ff66&}]]..item.style - end - end - item.style = [[{\c&Hffffff&}]]..item.style - item.ass = rt.menu.items[i].Name - list:insert(item) - end - - list:update() -end - -function list:format_header_string() - ---@type string - local header - - -- shorten the selected item - local sel = rt.menu.items[list.selected] - - -- setup topheading - if not rt.library.id then - header = settings.header.prefix - elseif not rt.title.id then - header = settings.header.prefix..rt.library.name..settings.header.separator - elseif not rt.season.id then - header = settings.header.prefix..rt.library.name..settings.header.separator - ..rt.title.name - else - header = settings.header.prefix..rt.library.name..settings.header.separator - ..rt.title.name..settings.header.separator..rt.season.name - end - - -- generate x subheadings based on user config - for i, v in pairs(settings.header.contents) do - -- if no selected item exit - if not rt.menu.items or not sel then - goto finish - end - - -- if this isn't the first line or the last line add a newline symbol and - -- reset colors - if i == 1 or i <= #settings.header.contents then - header = header..[[\N\h{\q2\fs20\c&Hffffff&}]] - end - - for _, c in pairs(v) do - if not sel or not sel.UserData then - goto continue - end - - if type(c) == "function" then - header = header..c(rt.menu.items, list.selected) - elseif c == "watched" then - if sel.UserData.PlayedPercentage then - if sel.UserData.PlayedPercentage > 0 then - header = header..[[{\c&Hdca400&}]].. - math.floor(sel.UserData.PlayedPercentage)..[[%{\c&Hffffff&}]] - end - elseif sel.UserData.Played then - header = header..[[{\c&H33ff66&}✔️{\c&Hffffff&}]] - elseif sel.UserData.UnplayedItemCount then - header = header..[[{\c&Hdca400&}]]..sel.UserData.UnplayedItemCount.. - [[{\c&Hffffff&}]] - else - header = header..[[{\c&H444444&}✔️{\c&Hffffff&}]] - end - - elseif c == "favorite" then - if sel.UserData.IsFavorite then - header = header..[[{\c&H0000ff&}♥️{\c&Hffffff&}]] - else - header = header..[[{\c&H444444&}♥️{\c&Hffffff&}]] - end - - elseif c == "runtime" then - if sel.RunTimeTicks then - ---@type number - local hour - local min = math.floor(sel.RunTimeTicks / 600000000) - - if min >= 60 then - hour = math.floor(min / 60) - min = min - math.floor(min / 60) * 60 - header = header..hour.."h "..min.."m" - else - header = header..min.."m" - end - end - - elseif c == "stars" then - if sel.CommunityRating then - local stars = math.floor(sel.CommunityRating * 10 + 0.5) / 10 - - header = header..[[{\c&H00ffff}★]]..stars..[[{\c&Hffffff&}]] - end - - elseif c == "rating" then - if sel.OfficialRating then - header = header..[[{\c&Hffffff}[]]..sel.OfficialRating.. - [[]{\c&Hffffff&}]] - end - - elseif c == "release" then - if sel.ProductionYear then - header = header..sel.ProductionYear - end - - elseif c == "entries" then - header = header..#rt.menu.items - else - header = header..c - end - end - ::continue:: - end - - ::finish:: - return header -end - ---- change position in jellyfin -local function enter() - local sel = rt.menu.items[list.selected] - if not sel then +coroutine.wrap(function() + -- attempt to authenticate with the server + jf = auth:new( + "http://192.168.50.159:8096", + "zachary", + "qwerty1" + ) + if not jf.available then + timer:kill() + l:log({ + style = [[{\c&H0000ff&}]], + ass = string.format( + "The jellyfin server at '%s' is not available", + jf.url + ) + }) + mp.add_timeout(5, function() + l:close() + end) return end - if sel.IsFolder == false then - msg.trace("selected a video") + -- we've connected kill the auth animation and clear the list + timer:kill() + l:set() - rt.video.id = sel.Id - - -- start playing the movie - jf.play() - else - if not rt.library.id then - msg.trace("selected a library") - - rt.library.id = sel.Id - rt.library.name = sel.Name - rt.library.pos = list.selected - elseif not rt.title.id then - msg.trace("selected a movie") - - rt.title.id = sel.Id - rt.title.name = sel.Name - rt.title.pos = list.selected - elseif not rt.season.id then - msg.trace("selected a season") - - rt.season.id = sel.Id - rt.season.name = sel.Name - rt.season.pos = list.selected - end - - list.selected = 1 - end -end - ---- helper to addkeys to the list view ----@param keys string keybind ----@param name string action name ----@param fn function callback ----@param opts? table options -local function addkey(keys, name, fn, opts) - opts = opts or { repeatable = true } - local i = 1 - for key in keys:gmatch("%S+") do - table.insert(list.keybinds, { key, name..i, fn, opts }) - i = i + 1 - end -end - ---- wrapper to safely open the list -local function openlist() - -- setup jellyfin api on first open - if type(jf.setup) ~= "boolean" then - jf.setup(list, rt, settings) - - -- mark jellyfin api as setup by replacing function with a boolean - jf.setup = true - end - - -- authenticate with the server based on users settings - rt.authenticated = jf.authenticate() - if not rt.authenticated then + if not jf.authenticated then + l:log({ + style = [[{\c&H0000ff&}]], + ass = "Failed to authenticate with jellyfin server. Check your credentials.", + }) + mp.add_timeout(5, function() + l:close() + end) return end - -- refresh the list - rt.menu.items = jf.getpos() - redraw_list(rt.menu.items) + msg.trace("Welcome to jellyfin. Everything's working so far.") + -- show the first list + state.tree = tree:new(cache:new(nil, function(self) + return api.async_request(self, "head", l, jf, "/Items/", { method = "GET" }) + end)) + state.pos = state.tree - -- open the list - list:open() -end + l:set(api.items_to_list(state.pos.data:get().items)) + l.selected = 1 + l:update() +end)() --- wrapper to safely close the list -local function closelist() - rt.authenticated = false - list:close() -end - --- register script message for users so they may define keybinds -mp.register_script_message("jnj-bind-open", function(key) - mp.add_key_binding(key, 'JNJ-BIND-OPEN', openlist) -end) - -mp.register_script_message("jnj-bind-close", function(key) - addkey(key, 'close', closelist) -end) - -mp.register_script_message("jnj-bind-toggle", function(key) - mp.add_key_binding(key, 'JNJ-BIND-TOGGLE', function() - if list.hidden then - openlist() - else - closelist() - end - end) -end) - -mp.register_script_message("jnj-bind-enter", function(key) - addkey(key, 'enter', function() - enter() - - local items = jf.getpos() - if not items then - return - end - - rt.menu.items = items - redraw_list(rt.menu.items) - end) -end) - -mp.register_script_message("jnj-bind-leave", function(key) - addkey(key, 'leave', function() - if not rt.library.id then - -- do nothing we're already in the root - elseif not rt.title.id then - rt.library.id = nil - list.selected = rt.library.pos - elseif not rt.season.id then - rt.title.id = nil - list.selected = rt.title.pos - else - rt.season.id = nil - list.selected = rt.season.pos - end - - local items = jf.getpos() - if not items then - return - end - - rt.menu.items = items - redraw_list(rt.menu.items) - end) -end) - -mp.register_script_message("jnj-bind-down", function(key) - addkey(key, 'down', function() - list:scroll_down() - end) -end) - -mp.register_script_message("jnj-bind-up", function(key) - addkey(key, 'up', function() - list:scroll_up() - end) -end) - - -mp.register_script_message("jnj-bind-pagedown", function(key) - addkey(key, 'pageup', function() - list:move_pagedown() - end) -end) - -mp.register_script_message("jnj-bind-pageup", function(key) - addkey(key, 'pagedown', function() - list:move_pageup() - end) -end) - -mp.register_script_message("jnj-bind-top", function(key) - addkey(key, 'top', function() - list:move_begin() - end) -end) - -mp.register_script_message("jnj-bind-bottom", function(key) - addkey(key, 'bottom', function() - list:move_end() - end) -end) - -mp.register_script_message("jnj-bind-toggle-played", function(key) - addkey(key, 'bottom', function() - if rt.menu.items[list.selected] and rt.menu.items[list.selected].Id and - not rt.menu.items[list.selected].isFolder then - jf.setplayed(not rt.menu.items[list.selected].UserData.Played) - redraw_list(rt.menu.items) - end - end) -end) - -mp.register_script_message("jnj-bind-toggle-favorite", function(key) - addkey(key, 'bottom', function() - if rt.menu.items[list.selected] and rt.menu.items[list.selected].Id and - not rt.menu.items[list.selected].isFolder then - jf.setfavorite(not rt.menu.items[list.selected].UserData.IsFavorite) - redraw_list(rt.menu.items) - end - end) -end) - --- add script message for users to provide their settings via json -mp.register_script_message("jnj-set-settings", function(json) - local user_settings = utils.parse_json(json) - for i, v in pairs(user_settings) do - settings[i] = v +-- add keys +l:addkey("k", "up", function() + if state.navigating then + return end + l:up() +end) +l:addkey("j", "down", function() + if state.navigating then + return + end + l:down() +end) +l:addkey("l", "enter", function() + if state.navigating then + return + end + state.navigating = true + coroutine.resume(coroutine.create(function() + if #state.pos.data:get().items < 1 then + state.navigating = false + return + end + + local cur_item = state.pos.data:get().items[l.selected] + if cur_item.MediaType == "Video" then + print(cur_item.Name) + -- TODO: handle playing videos + state.navigating = false + return + end + + local new_pos = nil + for _, child in ipairs(state.pos.children) do + if child.data:get().id == cur_item.Name then + new_pos = child + break + end + end + + if not new_pos then + new_pos = tree:new(cache:new(nil, function(self) + return api.async_request(self, cur_item.Name, l, jf, "/Items/", { + method = "GET", + paramaters = { + ["parentId"] = cur_item.Id, + ["sortBy"] = "SortName" + } + }) + end)) + state.pos:addchild(new_pos) + end + + state.pos.data.data.selected = l.selected + state.pos = new_pos + l:set(api.items_to_list(state.pos.data:get().items)) + l.selected = state.pos.data:get().selected + l:update() + state.navigating = false + end)) +end) +l:addkey("h", "leave", function() + if state.navigating then + return + end + state.navigating = true + + if not state.pos.parent then + state.navigating = false + return + end + + state.pos.data.data.selected = l.selected + state.pos = state.pos.parent + + coroutine.resume(coroutine.create(function() + l:set(api.items_to_list(state.pos.data:get().items)) + l.selected = state.pos.data:get().selected + l:update() + state.navigating = false + end)) +end) +l:addkey("esc", "close", function() l:close() end) +mp.add_key_binding("Ctrl+j", "open", function() + coroutine.resume(coroutine.create(function() + if not l.open then + if not jf:ping() then + print("hi") + end + l:update() + end + end)) end) diff --git a/src/api.lua b/src/api.lua new file mode 100644 index 0000000..33db92c --- /dev/null +++ b/src/api.lua @@ -0,0 +1,42 @@ +-- Convert jellyfin api results into data we can use + +local api = {} + +--- turn items from the jellyfin api into a list +---@param items table +---@return list.item[] +function api.items_to_list(items) + local list = {} + + for _, item in ipairs(items) do + table.insert(list, { + ass = item.Name + }) + end + + return list +end + +--- create an async request for the cache +---@param cache cache the cache that this sets +---@param id string the id of the item +---@param list list the displayed list +---@param auth auth +---@param endpoint string the jellyfin api endpoint to hit +---@param opts auth.request.Opts? options for the api request +---@return any +function api.async_request(cache, id, list, auth, endpoint, opts) + local timer = list:set_fade_animation(0.02, "Loading") + local result = auth:request(endpoint, opts or {}) + timer:kill() + + ---@type cache.list + local data = { + id = id, + selected = (cache.data or {}).selected or 1, + items = result.json.Items + } + return data +end + +return api diff --git a/src/auth.lua b/src/auth.lua new file mode 100644 index 0000000..c35b37a --- /dev/null +++ b/src/auth.lua @@ -0,0 +1,140 @@ +local msg = require('mp.msg') +local utils = require("mp.utils") + +local curl = require("src.utils.curl") +local misc = require("src.utils.misc") + +---@class auth.request.Opts +---@field data table? additional json data as a lua table +---@field paramaters table? additonal paramaters in a key value table +---@field method curl.methods + +---@class auth +---@field authenticated boolean +---@field url string url of the jellyfin server +---@field available boolean is the server running? +---@field access_token string the token to access other endpoints +---@field user_id string the user id to access other endpoints +local auth = {} + +--- authenticate a user with a jellyfin server +---@param username string +---@param password string +---@return auth +function auth:new(url, username, password) + local co = coroutine.running() + + ---@type auth + ---@diagnostic disable-next-line: missing-fields + local o = {} + + setmetatable(o, self) + self.__index = self + + o.url = url + + -- ensure the jellyfin server is running + curl.request_async({ + o.url.."/System/Ping", + "-H", "accept: application/json" + }, "GET", function(result) + local ok, err = coroutine.resume(co, result) + if not ok then + msg.error("Coroutine resume error: "..tostring(err)) + end + end) + + local result = coroutine.yield() + if not result or result.code ~= 200 then + return nil + end + + -- if it's running attempt to authenticate + self.available = true + curl.request_async({ + url.."/Users/AuthenticateByName", + "-H", "accept: application/json", + "-H", "content-type: application/json", + "-H", 'x-emby-authorization: ' + ..'MediaBrowser Client="mpv", ' + ..'Device="lua", ' + ..'DeviceId="1", ' + ..'Version="1.0"', + "-d", utils.format_json({ username = username, Pw = password }), + }, "POST", function(result) + local ok, err = coroutine.resume(co, result) + if not ok then + msg.error("Coroutine resume error: "..tostring(err)) + end + end) + + result = coroutine.yield() + if not result or result.code ~= 200 then + o.authenticated = false + msg.fatal(utils.to_string(result)) + return nil + end + + o.access_token = result.json.AccessToken + o.user_id = result.json.SessionInfo.UserId + o.authenticated = true + + return o +end + +--- ensure that we're still authenticated with the server +---@return boolean authenticated +function auth:ping() + local result = self:request("/Users/Me", { method = "GET" }) + if not result then + self.available = false + msg.fatal(utils.to_string(result)) + return false + elseif result.code ~= 200 then + self.authenticated = false + msg.fatal(utils.to_string(result)) + return false + end + return true +end + +--- hit an endpoint that requires auth +---@param endpoint string +---@param opts auth.request.Opts +---@return curl.response +function auth:request(endpoint, opts) + opts = opts or {} + local params = "" + local co = coroutine.running() + + -- take a table of paramaters and convert them into a string for curl + if opts.paramaters then + for key, val in pairs(opts.paramaters) do + params = params.."&"..key.."="..val + end + end + + -- construct the request + local request = { + misc.join_path(self.url, endpoint.."?userID="..self.user_id..params), + "-H", "accept: application/json", + "-H", "content-type: application/json", + "-H", "Authorization: MediaBrowser Token=\""..self.access_token.."\"" + } + + -- append any json data + if opts.data then + table.insert(request, utils.format_json(opts.data)) + end + + curl.request_async(request, opts.method, function(result) + local ok, err = coroutine.resume(co, result) + if not ok then + msg.error("Coroutine resume error: "..tostring(err)) + end + end) + + return coroutine.yield() +end + +return auth diff --git a/src/cache.lua b/src/cache.lua new file mode 100644 index 0000000..4c1ee84 --- /dev/null +++ b/src/cache.lua @@ -0,0 +1,54 @@ +---@class cache.list +---@field id string +---@field selected number +---@field items list.item[] + +---@class cache +---@field data any the data to cache +---@field private creation number time created +---@field source fun(self):any how to get the data +local cache = {} + +--- create a new cache +---@generic T +---@param data T data to cache +---@param source (fun(self?):T)? if set will auto fetch every 5 minutes :get is called +---@return cache +function cache:new(data, source) + ---@type cache + ---@diagnostic disable-next-line: missing-fields + local o = {} + + setmetatable(o, self) + self.__index = self + + o:set(data) + if source then + o.source = source + end + + return o +end + +--- forcefully set the data +---@generic T +---@param data T +function cache:set(data) + if not data then + return + end + self.data = data + self.creation = os.time() +end + +--- get the data +---@generic T +---@return T data +function cache:get() + if self.source and (not self.creation or os.time() - self.creation >= 300) then + self:set(self.source(self)) + end + return self.data +end + +return cache diff --git a/src/list.lua b/src/list.lua new file mode 100644 index 0000000..581aa98 --- /dev/null +++ b/src/list.lua @@ -0,0 +1,181 @@ +local mp = require("mp") +local msg = require("mp.msg") + +local misc = require("src.utils.misc") + +---@class list.item +---@field ass string +---@field style string + +---@class list +---@field open boolean is the list open +---@field header string default header +---@field default_style string default ass styling for each item +---@field osd table mpv osd overlay table +---@field items list.item[] +---@field selected number index representing which item in items is selected +---@field keybinds table[] a list of keybinds to be applied +---@field max_items number the maximum number of items which can fit on the screen +local list = {} + +--- create a new list +---@return list list +function list:new() + ---@type list + ---@diagnostic disable-next-line: missing-fields + local o = {} + + setmetatable(o, self) + self.__index = self + + o.header = [[{\c&HC35CAA&}J{\c&HC66691&}e{\c&HCA7079&}l{\c&HCD7A61&}l{\c&HD18548&}y{\c&HD48F30&}f{\c&HD89918&}i{\c&HDCA400&}n]] + o.default_style = [[{\r\fs23\fnmonospace}]] + + o.osd = mp.create_osd_overlay("ass-events") + o.osd.data = "" + o.selected = 1 + o.keybinds = {} + o.max_items = 26 + + return o +end + +--- small wrapper around the list to set all items and redraw immediately +---@param items list.item[]? +function list:set(items) + self.items = items or {} + self:update() +end + +--- display text fading in and out +---@param rate number time between each step +---@param text string +---@return table timer +function list:set_fade_animation(rate, text) + self.selected = 0 + local opacity, direction = 255, -1 + local function load_animation() + opacity = opacity + direction * 10 + if opacity >= 255 then + opacity = 255 + direction = -1 + elseif opacity <= 0 then + opacity = 0 + direction = 1 + end + self:set({{ + style = string.format( + [[{\alpha%s&}{\c&Hffffff&}]], + string.format("&H%02X&", 255 - math.floor(opacity)) + ), + ass = text, + }}) + end + return misc.mpv_timer(rate, load_animation, text) +end + +--- small wrapper around list:set to log the text provided +---@param item list.item +function list:log(item) + self.selected = 0 + msg.fatal(item.ass) + self:set({ item }) +end + +--- draw the list to the screen +function list:update() + self.open = true + + -- add all keybinds when we open the ui + for _, v in ipairs(self.keybinds) do + mp.add_forced_key_binding(v[1], "dynamic/"..self.osd.id.."/"..v[2], v[3], v[4]) + end + + ---@type list.item[] + local scrolled_items = {} + local selected = self.selected + if self.selected > (self.max_items / 2) then + if (#self.items - self.selected) > (self.max_items / 2) then + scrolled_items = { table.unpack( + self.items or {}, + self.selected - (self.max_items / 2) + 1 + ) } + selected = (self.max_items / 2) + else + scrolled_items = { table.unpack( + self.items or {}, + (#self.items - self.max_items) + 1 + ) } + selected = (self.max_items / 2) + (((self.max_items / 2) + self.selected) + - #self.items) + end + else + scrolled_items = self.items or {} + end + + -- put all the items in the list + self.osd.data = [[{\r\fnmonospace}]]..self.header..[[\N]] + for i, item in ipairs(scrolled_items) do + -- if self.selected <= 0 then there should be no selection indicators drawn + if self.selected > 0 then + if i == selected then + self.osd.data = self.osd.data..self.default_style..[[● ]] + else + self.osd.data = self.osd.data..self.default_style..[[○ ]] + end + else + self.osd.data = self.osd.data..self.default_style + end + self.osd.data = self.osd.data + ..(item.style or [[{\c&Hffffff&}]]) + ..item.ass + if self.items[i + 1] then + self.osd.data = self.osd.data..[[{\r}\N]] + end + end + self.osd:update() +end + +--- close the list +function list:close() + -- remove all the keybinds + for _,v in ipairs(self.keybinds) do + mp.remove_key_binding("dynamic/"..self.osd.id.."/"..v[2]) + end + + -- close the list + self.osd:remove() + self.open = false +end + +--- go up +function list:up() + if self.selected > 1 then + self.selected = self.selected - 1 + self:update() + end +end + +--- go down +function list:down() + if self.selected < #self.items then + self.selected = self.selected + 1 + self:update() + end +end + +--- helper to addkeys to the list view +---@param keys string keybind +---@param name string action name +---@param fn function callback +---@param opts? table options +function list:addkey(keys, name, fn, opts) + opts = opts or { repeatable = true } + local i = 1 + for key in keys:gmatch("%S+") do + table.insert(self.keybinds, { key, name..i, fn, opts }) + i = i + 1 + end +end + +return list diff --git a/src/utils/curl.lua b/src/utils/curl.lua new file mode 100644 index 0000000..efb76a4 --- /dev/null +++ b/src/utils/curl.lua @@ -0,0 +1,94 @@ +local mp = require('mp') +local utils = require('mp.utils') +local msg = require('mp.msg') + +---@alias curl.methods "GET"|"POST"|"DELETE"|"HEAD" + +---@class curl.response +---@field code number +---@field json table + +local curl = {} + +--- generate a curl command +---@param cmd table|string list of curl args +---@param method curl.methods? +---@return table command +local function gen_curl(cmd, method) + if type(cmd) == "string" then + cmd = { cmd } + end + + table.insert(cmd, 1, '%{http_code}') + table.insert(cmd, 1, "-w") + if method then + table.insert(cmd, 1, method) + table.insert(cmd, 1, "-X") + end + table.insert(cmd, 1, "0.5") + table.insert(cmd, 1, "--connect-timeout") + table.insert(cmd, 1, "curl") + + return cmd +end + +--- run a curl request +---@param cmd table|string list of curl args +---@param method curl.methods? +---@return curl.response? +function curl.request(cmd, method) + local r = mp.command_native({ + name = "subprocess", + capture_stdout = true, + capture_stderr = true, + playback_only = false, + args = gen_curl(cmd, method) + }) + + local json, err, code = utils.parse_json(r.stdout, true) + if not json then + msg.error(string.format("failed to parse json: %s", err)) + return + end + + ---@type curl.response + return { + code = tonumber(code) or 404, + json = json + } +end + +--- run a curl request async +---@param cmd table|string list of curl args +---@param method curl.methods? +---@param callback function(result: curl.response?) +function curl.request_async(cmd, method, callback) + mp.command_native_async({ + name = "subprocess", + capture_stdout = true, + capture_stderr = true, + playback_only = false, + args = gen_curl(cmd, method) + }, function(success, result, error) + if not success then + msg.error("curl failed: "..(error or "unknown error")) + callback(nil) + return + end + + if not result.stdout then + msg.error("curl didn't return any data") + callback(nil) + return + end + local json, err, code = utils.parse_json(result.stdout, true) + if not json then + msg.error(string.format("failed to parse json: %s", err)) + callback(result.stdout) + return + end + callback(--[[@type curl.response]]{ code = tonumber(code) or 404, json = json }) + end) +end + +return curl diff --git a/src/utils/misc.lua b/src/utils/misc.lua new file mode 100644 index 0000000..3508078 --- /dev/null +++ b/src/utils/misc.lua @@ -0,0 +1,31 @@ +local misc = {} + +--- join paths +---@vararg string paths +---@return string joined +function misc.join_path(...) + local path = table.concat({ ... }, '/') + return (path:gsub('//+', '/')) +end + +--- run a mp.add_periodic_timer without having to make a wrapper function +---@param interval number interval in seconds +---@param func function +---@vararg any args for func +---@return table timer +function misc.mpv_timer(interval, func, ...) + local args = { ... } + local wrapper = function() + func(table.unpack(args)) + end + return mp.add_periodic_timer(interval, wrapper) +end + +--- convert seconds jellyfin ticks +---@param s number seconds +---@return number ticks +function misc.seconds2ticks(s) + return s * 10000000 +end + +return misc diff --git a/src/utils/tree.lua b/src/utils/tree.lua new file mode 100644 index 0000000..f188091 --- /dev/null +++ b/src/utils/tree.lua @@ -0,0 +1,58 @@ +---@class tree +---@field parent tree +---@field children tree[] +---@field data any +local tree = {} + +--- create a new tree node +---@generic T +---@param data T +---@param parent tree? +---@return tree +function tree:new(data, parent) + ---@type tree + ---@diagnostic disable-next-line: missing-fields + local o = {} + + setmetatable(o, self) + self.__index = self + + o.data = data + if parent then + o:reparent(parent) + end + o.children = {} + + return o +end + +--- change your parent +---@param parent tree +function tree:reparent(parent) + if self.parent then + self.parent:removechild(self) + end + + self.parent = parent +end + +--- add a child +---@param child tree +function tree:addchild(child) + table.insert(self.children, child) + child:reparent(self) +end + +--- remove a child +---@param child tree +function tree:removechild(child) + if self.children then + for i, v in ipairs(self.children) do + if v == child then + return table.remove(self.children, i) + end + end + end +end + +return tree diff --git a/test/test.sh b/test/test.sh new file mode 100755 index 0000000..c832db8 --- /dev/null +++ b/test/test.sh @@ -0,0 +1,2 @@ +#!/bin/sh +MPV_HOME=mpv mpv --force-window=immediate --idle --script=.. diff --git a/utils/curl.lua b/utils/curl.lua deleted file mode 100644 index 532d0bd..0000000 --- a/utils/curl.lua +++ /dev/null @@ -1,41 +0,0 @@ -local mp = require('mp') -local utils = require('mp.utils') -local msg = require('mp.msg') - -local M = {} - ---- run a curl request ----@param cmd table list of curl args ----@param method? string ----@return table? json, number? httpcode -function M.request(cmd, method) - if type(cmd) == "string" then - cmd = { cmd } - end - - table.insert(cmd, 1, '%{http_code}') - table.insert(cmd, 1, "-w") - if method then - table.insert(cmd, 1, method) - table.insert(cmd, 1, "-X") - end - table.insert(cmd, 1, "curl") - - local r = mp.command_native({ - name = "subprocess", - capture_stdout = true, - capture_stderr = true, - playback_only = false, - args = cmd - }) - - local json, err, code = utils.parse_json(r.stdout, true) - if not json then - msg.error(string.format("failed to parse json: %s", err)) - return - end - - return json, tonumber(code) -end - -return M diff --git a/utils/jellyfin.lua b/utils/jellyfin.lua deleted file mode 100644 index 1cb30e5..0000000 --- a/utils/jellyfin.lua +++ /dev/null @@ -1,497 +0,0 @@ -local mp = require('mp') -local utils = require('mp.utils') -local msg = require('mp.msg') - -local curl = require("utils.curl") - -local M = {} - ---- refrence to runtime table ----@type table -local rt = {} - ---- refrence to settings table ----@type table -local settings = {} - ---- refrence to list table ----@type table -local list = {} - ---- user id + apikey ----@type string -local user_api - ---- function which returns a library table (a struct) ----@return table library -function M.library() - return { - --- library id - ---@type string|nil - id = nil, - - --- name of library - ---@type string - name = "", - - --- position in library - ---@type number - pos = 1 - } -end - ----table of generic actions on http return codes ----@type table -local http = { - [401] = function() - msg.trace("return code 401 encoutered retrying authentication") - rt.authenticated = M.authenticate() - if not rt.authenticated then - msg.trace("authentication failed, good luck") - end - end, - [403] = function() - msg.trace("return code 403 encoutered retrying authentication") - rt.authenticated = M.authenticate() - if not rt.authenticated then - msg.trace("authentication failed, good luck") - end - end -} - ---- function which returns a video table (a struct) ----@return table video -function M.video() - return { - --- id of video - ---@type string|nil - id = nil, - - --- progress through video in seconds - ---@type number - time = 0 - } -end - ---- return jellyfin ticks ----@param s number seconds ----@return number ticks -function M.seconds2ticks(s) - return s * 10000000 -end - ---- setup jellyfin api ----@param _rt table runtime ----@param _settings table settings -function M.setup(_list, _rt, _settings) - list = _list - rt = _rt - settings = _settings - - msg.trace("initialized the jellyfin api") -end - ---- attempt to authenticate the user with their specified server ----@return boolean authenticated true if successfully authenticated -function M.authenticate() - local result, code = curl.request({ - settings.url.."/Users/AuthenticateByName", - "-H", "accept: application/json", - "-H", "content-type: application/json", - "-H", 'x-emby-authorization: MediaBrowser Client="' - ..settings.client.name..'", Device="'..settings.client.device - ..'", DeviceId="1", Version="'..settings.client.version..'"', - "-d", '{"username":"'..settings.username..'","Pw":"'..settings.password - ..'"}', - }) - - -- failed to get anything - if not result and not code then - msg.error(string.format( - "failed to connect to jellyfin server at: %s, no response", settings.url)) - return false - elseif not result and code then - msg.error(string.format( - "failed to connect to jellyfin server at: %s, error code %s", - settings.url, code)) - return false - end - - msg.trace(string.format("successfully connected to %s", settings.url)) - - -- load the userinfo table into the runtime table - rt.user = result - - if not rt.user then - msg.error(string.format("something weird happened: %s", utils.to_string(result))) - -- something has gone wrong, this could mean that we have not authenticated correctly - return false - end - - -- populate user api string - user_api = "?api_key="..rt.user.AccessToken.."&userID="..rt.user.User.Id - - return true -end - ---- get the current position in the library ----@return table ret new list to display -function M.getpos() - ---@type table - local ret, libraries, items, seasons, episodes - ---@type number? - local code - - -- If you're not in a library you're on the homepage - if not rt.library.id then - libraries, code = curl.request(settings.url.."/Items"..user_api, "GET") - - ret = libraries.Items - -- If you're not viewing a movie or show you're viewing a library - elseif not rt.title.id then - items, code = curl.request(settings.url.."/Items"..user_api.."&parentId=".. - rt.library.id.."&sortBy=SortName", "GET") - - ret = items.Items - - -- if you're not viewing a season of a show you're viewing a list of seasons - elseif not rt.season.id then - seasons, code = curl.request(settings.url.."/Items"..user_api.. - "&parentId="..rt.title.id, "GET") - - ret = seasons.Items - - -- you're viewing a list of episodes in a season - else - episodes, code = curl.request(settings.url.."/Items"..user_api.. - "&parentId="..rt.season.id, "GET") - - ret = episodes.Items - end - - if code == 200 then - msg.trace("successfully retrieved information at position") - elseif code == 401 then - msg.error("Unauthorizied to get information at position") - elseif code == 403 then - msg.error("Forbidden from getting information at position") - end - - return ret -end - ---- play file based on rt.video.id -function M.play() - msg.trace(string.format("playing movie with id %s", rt.video.id)) - - local ok, err = mp.commandv("loadfile", settings.url.."/Videos/"..rt.video.id - .."/stream"..user_api.."&static=true") - - if not ok then - return - end - - mp.set_property("force-media-title", rt.menu.items[list.selected].Name) - - -- we started playing this file - local _, code curl.request(settings.url.."/PlayingItems/"..rt.video.id..user_api.. - "&canSeek=true", "POST") - - if code == 204 then - msg.trace("play start recorded on server") - elseif code == 401 then - msg.error("Unauthorizied to report playback start") - elseif code == 403 then - msg.error("Forbidden from get reporting playback start") - end - - -- try some generic actions that may help. wrapped in pcall so nothing stupid - -- can happen (fingers crossed) - pcall(http[code]) - - -- close ui after playback starts - list:close() - - --- callback when the file has been loaded - local function file_loaded() - if rt.menu.items[list.selected].UserData.PlayedPercentage then - mp.commandv("seek", - rt.menu.items[list.selected].UserData.PlayedPercentage, - "absolute-percent") - end - - M.reportplayback() - - -- unregister event - mp.unregister_event(file_loaded) - end - - -- when the file has loaded seek to last positon if there is one - mp.register_event("file-loaded", file_loaded) -end - ---- set current item's played status ----@param bool boolean played -function M.setplayed(bool) - ---@type number? - local code - ---@type string? - local ret - - -- if no item selected leave - if not rt.menu.items[list.selected].Id then - return - end - - if bool == true then - -- if the video isn't already played set it played - if rt.menu.items[list.selected].UserData.Played == false then - ret, code = curl.request(settings.url.."/UserPlayedItems/" - ..rt.menu.items[list.selected].Id..user_api, "POST") - end - elseif bool == false then - -- if the video isn't unplayed set it to unplayed - if rt.menu.items[list.selected].UserData.Played == true then - ret, code = curl.request(settings.url.."/UserPlayedItems/" - ..rt.menu.items[list.selected].Id..user_api, "DELETE") - end - end - - -- check if the server has recieved the request and update accordingly - if not code then - msg.error(string.format("couldn't mark item '%s' as played", - rt.menu.items[list.selected].Name)) - return - elseif code == 200 then - msg.trace("new user data recieved updating info") - rt.menu.items[list.selected].UserData = ret - elseif code == 401 then - msg.error("unauthorizied to get user data") - elseif code == 403 then - msg.error("forbidden from getting user data") - elseif code == 404 then - msg.error(string.format("item not found on %s", - rt.menu.items[list.selected].Name)) - end - - -- try some generic actions that may help. wrapped in pcall so nothing - -- stupid can happen (fingers crossed) - pcall(http[code]) -end - ---- set current items favorite status ----@param bool boolean favorite -function M.setfavorite(bool) - ---@type number? - local code - ---@type string? - local ret - - -- if no item selected leave - if not rt.menu.items[list.selected].Id then - return - end - - if bool == true then - -- if the video isn't already favorite set it as a favorite - if rt.menu.items[list.selected].UserData.IsFavorite == false then - ret, code = curl.request(settings.url.."/UserFavoriteItems/" - ..rt.menu.items[list.selected].Id..user_api, "POST") - end - elseif bool == false then - -- if the video isn't a favorite unfavorite it - if rt.menu.items[list.selected].UserData.IsFavorite == true then - ret, code = curl.request(settings.url.."/UserFavoriteItems/" - ..rt.menu.items[list.selected].Id..user_api, "DELETE") - end - end - - -- check if the server has recieved the request and update accordingly - if not code then - msg.error(string.format("couldn't mark item '%s' as favorite", - rt.menu.items[list.selected].Name)) - return - elseif code == 200 then - msg.trace("new user data recieved updating info") - rt.menu.items[list.selected].UserData = ret - elseif code == 401 then - msg.error("unauthorizied to get user data") - elseif code == 403 then - msg.error("forbidden from getting user data") - end - - -- try some generic actions that may help. wrapped in pcall so nothing - -- stupid can happen (fingers crossed) - pcall(http[code]) -end - ---- start playback reporting -function M.reportplayback() - --- table of events used to keep the server up to date with what's happening - --- on the client - ---@type table - local A = {} - - --- last percent that we reported to the server - ---@type number - local last_reported_percent - - --- listen to an event and run a callback on change - ---@param property string mpv native property to listen to - ---@param callback function function callback - local function listen(property, callback) - A[#A + 1] = { - property = property, - callback = callback - } - end - - local function elapsedticks() - local timepos = mp.get_property_native("time-pos") - if not timepos then - return nil - end - - -- convert the elapsed seconds to ticks (not sure what ticks are I just - -- know that 1 seconds is equal to 10,000,000 ticks) - return M.seconds2ticks(math.floor(timepos)) - end - - local function paused() - if mp.get_property_native("pause") then - return "true" - else - return "false" - end - end - - listen("percent-pos", function(name) - local value = mp.get_property_native(name) - if not value then - return - end - - local percent = math.floor(value) - - if percent ~= last_reported_percent then - local ticks = elapsedticks() - if not ticks then - msg.trace("failed to report playback time to the server: unable to get time-pos") - return - end - - -- send off percent position to the server - local _, code = curl.request(settings.url.."/Users/"..rt.user.User.Id.. - "/PlayingItems/"..rt.video.id.."/Progress/?api_key=".. - rt.user.AccessToken.."&positionTicks="..ticks.."&isPaused="..paused(), - "POST") - - if code == 204 then - msg.trace("playback percent recorded on server") - elseif code == 401 then - msg.error("Unauthorizied to report playback percent") - elseif code == 403 then - msg.error("Forbidden from get reporting playback percent") - end - - -- try some generic actions that may help. wrapped in pcall so nothing - -- stupid can happen (fingers crossed) - pcall(http[code]) - - -- set our last reported percent to the current percent - last_reported_percent = percent - - msg.trace(string.format("reported %s%% as last known position to the server", - last_reported_percent)) - end - end) - - listen("pause", function(name) - ---@type number? - local code - local value = paused() - local ticks = elapsedticks() - if not ticks then - msg.trace("reported pause may be inaccurate: failed to get time-pos") - - -- fallback to just sending a pause without the current position if we're - -- unable to get the current position - _, code = curl.request(settings.url.."/Users/"..rt.user.User.Id.. - "/PlayingItems/"..rt.video.id.."/Progress/?api_key=".. - rt.user.AccessToken.."&isPaused="..value, "POST") - - goto error - end - - -- send pause with the current position - _, code = curl.request(settings.url.."/Users/"..rt.user.User.Id.. - "/PlayingItems/"..rt.video.id.."/Progress/?api_key=".. - rt.user.AccessToken.."&isPaused="..value.."&positionTicks="..ticks, - "POST") - - ::error:: - - if code == 204 then - msg.trace("pause recorded on server") - elseif code == 401 then - msg.error("Unauthorizied to report pause") - elseif code == 403 then - msg.error("Forbidden from get reporting pause") - end - - -- try some generic actions that may help. wrapped in pcall so nothing - -- stupid can happen (fingers crossed) - pcall(http[code]) - end) - - local function endfile(info) - ---@type number? - local code - local ticks = elapsedticks() - if not ticks then - -- fallback to just telling the server we stopped watching without the - -- current position if we're unable to get the current position - _, code = curl.request(settings.url.."/Users/"..rt.user.User.Id.. - "/PlayingItems/"..rt.video.id.."?api_key="..rt.user.AccessToken, - "DELETE") - - msg.trace("reported stopping time may be inaccurate: failed to get time-pos") - else - _, code = curl.request(settings.url.."/Users/"..rt.user.User.Id.. - "/PlayingItems/"..rt.video.id.."?api_key="..rt.user.AccessToken.. - "&positionTicks="..ticks, "DELETE") - - msg.trace("reported stopping time successfully") - end - - if code == 204 then - msg.trace("play end recorded on server") - elseif code == 401 then - msg.error("Unauthorizied to report play end") - elseif code == 403 then - msg.error("Forbidden from get reporting play end") - end - - -- try some generic actions that may help. wrapped in pcall so nothing - -- stupid can happen (fingers crossed) - pcall(http[code]) - - msg.trace(string.format("ending reason: %s", info.reason)) - - -- unregister all events for the video - mp.unregister_event(endfile) - for _, val in pairs(A) do - mp.unobserve_property(val.callback) - end - end - - -- register end file event - mp.register_event("end-file", endfile) - - -- register all listeners - for _, val in pairs(A) do - mp.observe_property(val.property, "native", val.callback) - end -end - -return M