diff --git a/.gitignore b/.gitignore index 58c93d16..a03fe99d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,3 @@ *.sw? *.*~ -*.in build/ -Makefile.in -aclocal.m4 -autom4te.cache/ -configure -depcomp -install-sh -missing diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index a12a965b..00000000 --- a/AUTHORS +++ /dev/null @@ -1,2 +0,0 @@ -Emeric Poupon first version of all files except from the boost directory. - diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed02..00000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - 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/ChangeLog b/ChangeLog deleted file mode 100644 index e69de29b..00000000 diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 8865734f..00000000 --- a/INSTALL +++ /dev/null @@ -1,368 +0,0 @@ -Installation Instructions -************************* - - Copyright (C) 1994-1996, 1999-2002, 2004-2016 Free Software -Foundation, Inc. - - Copying and distribution of this file, with or without modification, -are permitted in any medium without royalty provided the copyright -notice and this notice are preserved. This file is offered as-is, -without warranty of any kind. - -Basic Installation -================== - - Briefly, the shell command './configure && make && make install' -should configure, build, and install this package. The following -more-detailed instructions are generic; see the 'README' file for -instructions specific to this package. Some packages provide this -'INSTALL' file but do not implement all of the features documented -below. The lack of an optional feature in a given package is not -necessarily a bug. More recommendations for GNU packages can be found -in *note Makefile Conventions: (standards)Makefile Conventions. - - The 'configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a 'Makefile' in each directory of the package. -It may also create one or more '.h' files containing system-dependent -definitions. Finally, it creates a shell script 'config.status' that -you can run in the future to recreate the current configuration, and a -file 'config.log' containing compiler output (useful mainly for -debugging 'configure'). - - It can also use an optional file (typically called 'config.cache' and -enabled with '--cache-file=config.cache' or simply '-C') that saves the -results of its tests to speed up reconfiguring. Caching is disabled by -default to prevent problems with accidental use of stale cache files. - - If you need to do unusual things to compile the package, please try -to figure out how 'configure' could check whether to do them, and mail -diffs or instructions to the address given in the 'README' so they can -be considered for the next release. If you are using the cache, and at -some point 'config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file 'configure.ac' (or 'configure.in') is used to create -'configure' by a program called 'autoconf'. You need 'configure.ac' if -you want to change it or regenerate 'configure' using a newer version of -'autoconf'. - - The simplest way to compile this package is: - - 1. 'cd' to the directory containing the package's source code and type - './configure' to configure the package for your system. - - Running 'configure' might take a while. While running, it prints - some messages telling which features it is checking for. - - 2. Type 'make' to compile the package. - - 3. Optionally, type 'make check' to run any self-tests that come with - the package, generally using the just-built uninstalled binaries. - - 4. Type 'make install' to install the programs and any data files and - documentation. When installing into a prefix owned by root, it is - recommended that the package be configured and built as a regular - user, and only the 'make install' phase executed with root - privileges. - - 5. Optionally, type 'make installcheck' to repeat any self-tests, but - this time using the binaries in their final installed location. - This target does not install anything. Running this target as a - regular user, particularly if the prior 'make install' required - root privileges, verifies that the installation completed - correctly. - - 6. You can remove the program binaries and object files from the - source code directory by typing 'make clean'. To also remove the - files that 'configure' created (so you can compile the package for - a different kind of computer), type 'make distclean'. There is - also a 'make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - - 7. Often, you can also type 'make uninstall' to remove the installed - files again. In practice, not all packages have tested that - uninstallation works correctly, even though it is required by the - GNU Coding Standards. - - 8. Some packages, particularly those that use Automake, provide 'make - distcheck', which can by used by developers to test that all other - targets like 'make install' and 'make uninstall' work correctly. - This target is generally not run by end users. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the 'configure' script does not know about. Run './configure --help' -for details on some of the pertinent environment variables. - - You can give 'configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here is -an example: - - ./configure CC=c99 CFLAGS=-g LIBS=-lposix - - *Note Defining Variables::, for more details. - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you can use GNU 'make'. 'cd' to the -directory where you want the object files and executables to go and run -the 'configure' script. 'configure' automatically checks for the source -code in the directory that 'configure' is in and in '..'. This is known -as a "VPATH" build. - - With a non-GNU 'make', it is safer to compile the package for one -architecture at a time in the source code directory. After you have -installed the package for one architecture, use 'make distclean' before -reconfiguring for another architecture. - - On MacOS X 10.5 and later systems, you can create libraries and -executables that work on multiple system types--known as "fat" or -"universal" binaries--by specifying multiple '-arch' options to the -compiler but only a single '-arch' option to the preprocessor. Like -this: - - ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CPP="gcc -E" CXXCPP="g++ -E" - - This is not guaranteed to produce working output in all cases, you -may have to build one architecture at a time and combine the results -using the 'lipo' tool if you have problems. - -Installation Names -================== - - By default, 'make install' installs the package's commands under -'/usr/local/bin', include files under '/usr/local/include', etc. You -can specify an installation prefix other than '/usr/local' by giving -'configure' the option '--prefix=PREFIX', where PREFIX must be an -absolute file name. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option '--exec-prefix=PREFIX' to 'configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like '--bindir=DIR' to specify different values for particular -kinds of files. Run 'configure --help' for a list of the directories -you can set and what kinds of files go in them. In general, the default -for these options is expressed in terms of '${prefix}', so that -specifying just '--prefix' will affect all of the other directory -specifications that were not explicitly provided. - - The most portable way to affect installation locations is to pass the -correct locations to 'configure'; however, many packages provide one or -both of the following shortcuts of passing variable assignments to the -'make install' command line to change installation locations without -having to reconfigure or recompile. - - The first method involves providing an override variable for each -affected directory. For example, 'make install -prefix=/alternate/directory' will choose an alternate location for all -directory configuration variables that were expressed in terms of -'${prefix}'. Any directories that were specified during 'configure', -but not in terms of '${prefix}', must each be overridden at install time -for the entire installation to be relocated. The approach of makefile -variable overrides for each directory variable is required by the GNU -Coding Standards, and ideally causes no recompilation. However, some -platforms have known limitations with the semantics of shared libraries -that end up requiring recompilation when using this method, particularly -noticeable in packages that use GNU Libtool. - - The second method involves providing the 'DESTDIR' variable. For -example, 'make install DESTDIR=/alternate/directory' will prepend -'/alternate/directory' before all installation names. The approach of -'DESTDIR' overrides is not required by the GNU Coding Standards, and -does not work on platforms that have drive letters. On the other hand, -it does better at avoiding recompilation issues, and works well even -when some directory options were not specified in terms of '${prefix}' -at 'configure' time. - -Optional Features -================= - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving 'configure' the -option '--program-prefix=PREFIX' or '--program-suffix=SUFFIX'. - - Some packages pay attention to '--enable-FEATURE' options to -'configure', where FEATURE indicates an optional part of the package. -They may also pay attention to '--with-PACKAGE' options, where PACKAGE -is something like 'gnu-as' or 'x' (for the X Window System). The -'README' should mention any '--enable-' and '--with-' options that the -package recognizes. - - For packages that use the X Window System, 'configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the 'configure' options '--x-includes=DIR' and -'--x-libraries=DIR' to specify their locations. - - Some packages offer the ability to configure how verbose the -execution of 'make' will be. For these packages, running './configure ---enable-silent-rules' sets the default to minimal output, which can be -overridden with 'make V=1'; while running './configure ---disable-silent-rules' sets the default to verbose, which can be -overridden with 'make V=0'. - -Particular systems -================== - - On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC -is not installed, it is recommended to use the following options in -order to use an ANSI C compiler: - - ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" - -and if that doesn't work, install pre-built binaries of GCC for HP-UX. - - HP-UX 'make' updates targets which have the same time stamps as their -prerequisites, which makes it generally unusable when shipped generated -files such as 'configure' are involved. Use GNU 'make' instead. - - On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its '' header file. The option '-nodtk' can be used as a -workaround. If GNU CC is not installed, it is therefore recommended to -try - - ./configure CC="cc" - -and if that doesn't work, try - - ./configure CC="cc -nodtk" - - On Solaris, don't put '/usr/ucb' early in your 'PATH'. This -directory contains several dysfunctional programs; working variants of -these programs are available in '/usr/bin'. So, if you need '/usr/ucb' -in your 'PATH', put it _after_ '/usr/bin'. - - On Haiku, software installed for all users goes in '/boot/common', -not '/usr/local'. It is recommended to use the following options: - - ./configure --prefix=/boot/common - -Specifying the System Type -========================== - - There may be some features 'configure' cannot figure out -automatically, but needs to determine by the type of machine the package -will run on. Usually, assuming the package is built to be run on the -_same_ architectures, 'configure' can figure that out, but if it prints -a message saying it cannot guess the machine type, give it the -'--build=TYPE' option. TYPE can either be a short name for the system -type, such as 'sun4', or a canonical name which has the form: - - CPU-COMPANY-SYSTEM - -where SYSTEM can have one of these forms: - - OS - KERNEL-OS - - See the file 'config.sub' for the possible values of each field. If -'config.sub' isn't included in this package, then this package doesn't -need to know the machine type. - - If you are _building_ compiler tools for cross-compiling, you should -use the option '--target=TYPE' to select the type of system they will -produce code for. - - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with '--host=TYPE'. - -Sharing Defaults -================ - - If you want to set default values for 'configure' scripts to share, -you can create a site shell script called 'config.site' that gives -default values for variables like 'CC', 'cache_file', and 'prefix'. -'configure' looks for 'PREFIX/share/config.site' if it exists, then -'PREFIX/etc/config.site' if it exists. Or, you can set the -'CONFIG_SITE' environment variable to the location of the site script. -A warning: not all 'configure' scripts look for a site script. - -Defining Variables -================== - - Variables not defined in a site shell script can be set in the -environment passed to 'configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the 'configure' command line, using 'VAR=value'. For example: - - ./configure CC=/usr/local2/bin/gcc - -causes the specified 'gcc' to be used as the C compiler (unless it is -overridden in the site shell script). - -Unfortunately, this technique does not work for 'CONFIG_SHELL' due to an -Autoconf limitation. Until the limitation is lifted, you can use this -workaround: - - CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash - -'configure' Invocation -====================== - - 'configure' recognizes the following options to control how it -operates. - -'--help' -'-h' - Print a summary of all of the options to 'configure', and exit. - -'--help=short' -'--help=recursive' - Print a summary of the options unique to this package's - 'configure', and exit. The 'short' variant lists options used only - in the top level, while the 'recursive' variant lists options also - present in any nested packages. - -'--version' -'-V' - Print the version of Autoconf used to generate the 'configure' - script, and exit. - -'--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally 'config.cache'. FILE defaults to '/dev/null' to - disable caching. - -'--config-cache' -'-C' - Alias for '--cache-file=config.cache'. - -'--quiet' -'--silent' -'-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to '/dev/null' (any error - messages will still be shown). - -'--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - 'configure' can determine that directory automatically. - -'--prefix=DIR' - Use DIR as the installation prefix. *note Installation Names:: for - more details, including other options available for fine-tuning the - installation locations. - -'--no-create' -'-n' - Run the configure checks, but stop before creating any output - files. - -'configure' also accepts some other, not widely useful, options. Run -'configure --help' for more details. diff --git a/NEWS b/NEWS deleted file mode 100644 index e69de29b..00000000 diff --git a/README b/README deleted file mode 100644 index 96dc92fb..00000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -See README.md diff --git a/docroot/js/mediaplayer.js b/docroot/js/mediaplayer.js index 2d8353e9..78affb86 100644 --- a/docroot/js/mediaplayer.js +++ b/docroot/js/mediaplayer.js @@ -2,6 +2,12 @@ var LMS = LMS || {}; +const Mode = { + Transcode: 1, + File: 2, +} +Object.freeze(Mode); + LMS.mediaplayer = function () { var _root = {}; @@ -9,6 +15,7 @@ LMS.mediaplayer = function () { var _offset = 0; var _duration = 0; var _audioSrc; + var _mode = Mode.File; var _updateControls = function() { if (_elems.audio.paused) { @@ -125,11 +132,22 @@ LMS.mediaplayer = function () { if (!_elems.audio.hasAttribute("src")) return; - _offset = parseInt(_elems.seek.value, 10); - _elems.audio.src = _audioSrc + "&offset=" + _offset; - _elems.audio.load(); - _playTrack(); + let selectedOffset = parseInt(_elems.seek.value, 10); + switch (_mode) { + case Mode.Transcode: + _offset = selectedOffset; + _elems.audio.src = _audioSrc + "&offset=" + _offset; + _elems.audio.load(); + _elems.audio.currentTime = 0; + _playTrack(); + break; + + case Mode.File: + _elems.audio.currentTime = selectedOffset; + _playTrack(); + break; + } }); _elems.audio.addEventListener("play", _updateControls); @@ -175,6 +193,7 @@ LMS.mediaplayer = function () { _offset = 0; _duration = params.duration; _audioSrc = params.resource; + _mode = params.mode; _elems.seek.max = _duration; _elems.audio.src = _audioSrc; diff --git a/src/libs/auth/include/auth/IAuthTokenService.hpp b/src/libs/auth/include/auth/IAuthTokenService.hpp index f85148dd..1018b674 100644 --- a/src/libs/auth/include/auth/IAuthTokenService.hpp +++ b/src/libs/auth/include/auth/IAuthTokenService.hpp @@ -39,6 +39,7 @@ namespace Auth { class IAuthTokenService { public: + virtual ~IAuthTokenService() = default; // Auth Token services struct AuthTokenProcessResult diff --git a/src/libs/av/CMakeLists.txt b/src/libs/av/CMakeLists.txt index c2d03eb6..adb37766 100644 --- a/src/libs/av/CMakeLists.txt +++ b/src/libs/av/CMakeLists.txt @@ -2,6 +2,7 @@ add_library(lmsav SHARED impl/AvInfo.cpp impl/AvTranscoder.cpp + impl/AvTranscodeResourceHandler.cpp impl/AvTypes.cpp ) @@ -18,6 +19,7 @@ target_link_libraries(lmsav PUBLIC lmsutils avformat avutil + wt ) install(TARGETS lmsav DESTINATION lib) diff --git a/src/libs/av/impl/AvInfo.cpp b/src/libs/av/impl/AvInfo.cpp index e9b1bd8c..b8fc392a 100644 --- a/src/libs/av/impl/AvInfo.cpp +++ b/src/libs/av/impl/AvInfo.cpp @@ -235,6 +235,8 @@ guessMediaFileFormat(const std::filesystem::path& file) if (!format || !format->name) return {}; + LMS_LOG(AV, DEBUG) << "File '" << file.string() << "', formats = '" << format->name << "'"; + auto formats {StringUtils::splitString(format->name, ",")}; if (formats.size() > 1) LMS_LOG(AV, INFO) << "File '" << file.string() << "' reported several formats: '" << format->name << "'"; diff --git a/src/libs/av/impl/AvTranscodeResourceHandler.cpp b/src/libs/av/impl/AvTranscodeResourceHandler.cpp new file mode 100644 index 00000000..fbea1f2f --- /dev/null +++ b/src/libs/av/impl/AvTranscodeResourceHandler.cpp @@ -0,0 +1,59 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#include "AvTranscodeResourceHandler.hpp" + +namespace Av +{ + + std::unique_ptr + createTranscodeResourceHandler(const std::filesystem::path& trackPath, const TranscodeParameters& parameters) + { + return std::make_unique(trackPath, parameters); + } + + // TODO set some nice HTTP return code + + TranscodeResourceHandler::TranscodeResourceHandler(const std::filesystem::path& trackPath, const TranscodeParameters& parameters) + : _transcoder {trackPath, parameters} + { + _transcoder.start(); + } + + void + TranscodeResourceHandler::processRequest(const Wt::Http::Request& /*request*/, Wt::Http::Response& response) + { + response.setMimeType(_transcoder.getOutputMimeType()); + + if (!_transcoder.isComplete()) + { + std::vector buffer; + + _transcoder.process(buffer, _chunkSize); + response.out().write(reinterpret_cast(&buffer[0]), buffer.size()); + } + } + + bool + TranscodeResourceHandler::isFinished() const + { + return _transcoder.isComplete(); + } +} + diff --git a/src/libs/av/impl/AvTranscodeResourceHandler.hpp b/src/libs/av/impl/AvTranscodeResourceHandler.hpp new file mode 100644 index 00000000..351e6e45 --- /dev/null +++ b/src/libs/av/impl/AvTranscodeResourceHandler.hpp @@ -0,0 +1,45 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include "av/AvTranscoder.hpp" +#include "utils/IResourceHandler.hpp" + +namespace Av +{ + + class TranscodeResourceHandler final : public IResourceHandler + { + public: + TranscodeResourceHandler(const std::filesystem::path& trackPath, const TranscodeParameters& parameters); + + private: + + void processRequest(const Wt::Http::Request& request, Wt::Http::Response& reponse) override; + bool isFinished() const override; + + static constexpr std::size_t _chunkSize {262144}; + const std::filesystem::path _trackPath; + Transcoder _transcoder; + + }; +} + diff --git a/src/libs/av/impl/AvTranscoder.cpp b/src/libs/av/impl/AvTranscoder.cpp index f98b3771..fd6576f2 100644 --- a/src/libs/av/impl/AvTranscoder.cpp +++ b/src/libs/av/impl/AvTranscoder.cpp @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Emeric Poupon + * * This file is part of LMS. * @@ -30,7 +30,7 @@ namespace Av { -#define LMS_LOG_TRANSCODE(sev) LMS_LOG(TRANSCODE, sev) << "[" << _id << "] - " +#define LOG(sev) LMS_LOG(TRANSCODE, sev) << "[" << _id << "] - " static std::atomic globalId {}; static std::filesystem::path ffmpegPath; @@ -59,7 +59,7 @@ Transcoder::start() else if (!std::filesystem::is_regular_file( _filePath) ) return false; - LMS_LOG_TRANSCODE(INFO) << "Transcoding file '" << _filePath.string() << "'"; + LOG(INFO) << "Transcoding file '" << _filePath.string() << "'"; std::vector args; @@ -99,77 +99,57 @@ Transcoder::start() // Skip video flows (including covers) args.emplace_back("-vn"); + // Output bitrates + args.emplace_back("-b:a"); + args.emplace_back(std::to_string(_parameters.bitrate)); + // Codecs and formats - if (_parameters.encoding) + switch (_parameters.encoding) { - // Output bitrates - args.emplace_back("-b:a"); - args.emplace_back(std::to_string(_parameters.bitrate)); + case Encoding::MP3: + args.emplace_back("-f"); + args.emplace_back("mp3"); + break; - switch (*_parameters.encoding) - { - case Encoding::MP3: - args.emplace_back("-f"); - args.emplace_back("mp3"); - break; + case Encoding::OGG_OPUS: + args.emplace_back("-acodec"); + args.emplace_back("libopus"); + args.emplace_back("-f"); + args.emplace_back("ogg"); + break; - case Encoding::OGG_OPUS: - args.emplace_back("-acodec"); - args.emplace_back("libopus"); - args.emplace_back("-f"); - args.emplace_back("ogg"); - break; + case Encoding::MATROSKA_OPUS: + args.emplace_back("-acodec"); + args.emplace_back("libopus"); + args.emplace_back("-f"); + args.emplace_back("matroska"); + break; - case Encoding::MATROSKA_OPUS: - args.emplace_back("-acodec"); - args.emplace_back("libopus"); - args.emplace_back("-f"); - args.emplace_back("matroska"); - break; + case Encoding::OGG_VORBIS: + args.emplace_back("-acodec"); + args.emplace_back("libvorbis"); + args.emplace_back("-f"); + args.emplace_back("ogg"); + break; - case Encoding::OGG_VORBIS: - args.emplace_back("-acodec"); - args.emplace_back("libvorbis"); - args.emplace_back("-f"); - args.emplace_back("ogg"); - break; + case Encoding::WEBM_VORBIS: + args.emplace_back("-acodec"); + args.emplace_back("libvorbis"); + args.emplace_back("-f"); + args.emplace_back("webm"); + break; - case Encoding::WEBM_VORBIS: - args.emplace_back("-acodec"); - args.emplace_back("libvorbis"); - args.emplace_back("-f"); - args.emplace_back("webm"); - break; - - default: - return false; - } - - _outputMimeType = encodingToMimetype(*_parameters.encoding); - } - else - { - auto mediaFileFormat {guessMediaFileFormat(_filePath)}; - - if (!mediaFileFormat) - { - LMS_LOG(AV, ERROR) << "Cannot guess media file format for '" << _filePath.string() << "'"; + default: return false; - } - - args.emplace_back("-acodec"); - args.emplace_back("copy"); - args.emplace_back("-f"); - args.emplace_back(mediaFileFormat->format); - - _outputMimeType = mediaFileFormat->mimeType; } + _outputMimeType = encodingToMimetype(_parameters.encoding); + args.emplace_back("pipe:1"); - LMS_LOG_TRANSCODE(DEBUG) << "Dumping args (" << args.size() << ")"; + LOG(DEBUG) << "Dumping args (" << args.size() << ")"; for (const std::string& arg : args) - LMS_LOG_TRANSCODE(DEBUG) << "Arg = '" << arg << "'"; + LOG(DEBUG) << "Arg = '" << arg << "'"; // make sure only one thread is executing this part of code { @@ -183,18 +163,18 @@ Transcoder::start() _child->open(ffmpegPath.string(), args); if (!_child->is_open()) { - LMS_LOG_TRANSCODE(DEBUG) << "Exec failed!"; + LOG(DEBUG) << "Exec failed!"; return false; } if (_child->out().eof()) { - LMS_LOG_TRANSCODE(DEBUG) << "Early end of file!"; + LOG(DEBUG) << "Early end of file!"; return false; } } - LMS_LOG_TRANSCODE(DEBUG) << "Stream opened!"; + LOG(DEBUG) << "Stream opened!"; return true; } @@ -207,12 +187,12 @@ Transcoder::process(std::vector& output, std::size_t maxSize) if (_child->out().fail()) { - LMS_LOG_TRANSCODE(DEBUG) << "Stdout FAILED 2"; + LOG(DEBUG) << "Stdout FAILED 2"; } if (_child->out().eof()) { - LMS_LOG_TRANSCODE(DEBUG) << "Stdout ENDED 2"; + LOG(DEBUG) << "Stdout ENDED 2"; } output.resize(maxSize); @@ -223,12 +203,12 @@ Transcoder::process(std::vector& output, std::size_t maxSize) if (_child->out().fail()) { - LMS_LOG_TRANSCODE(DEBUG) << "Stdout FAILED"; + LOG(DEBUG) << "Stdout FAILED"; } if (_child->out().eof()) { - LMS_LOG_TRANSCODE(DEBUG) << "Stdout EOF!"; + LOG(DEBUG) << "Stdout EOF!"; _child->clear(); _isComplete = true; @@ -237,20 +217,20 @@ Transcoder::process(std::vector& output, std::size_t maxSize) _total += output.size(); - LMS_LOG_TRANSCODE(DEBUG) << "nb bytes = " << output.size() << ", total = " << _total; + LOG(DEBUG) << "nb bytes = " << output.size() << ", total = " << _total; } Transcoder::~Transcoder() { - LMS_LOG_TRANSCODE(DEBUG) << ", ~Transcoder called! Total produced bytes = " << _total; + LOG(DEBUG) << ", ~Transcoder called! Total produced bytes = " << _total; if (_child) { - LMS_LOG_TRANSCODE(DEBUG) << "Child still here!"; + LOG(DEBUG) << "Child still here!"; _child->rdbuf()->kill(SIGKILL); - LMS_LOG_TRANSCODE(DEBUG) << "Closing..."; + LOG(DEBUG) << "Closing..."; _child->rdbuf()->close(); - LMS_LOG_TRANSCODE(DEBUG) << "Closing DONE"; + LOG(DEBUG) << "Closing DONE"; } } diff --git a/src/libs/av/include/av/AvTranscodeResourceHandlerCreator.hpp b/src/libs/av/include/av/AvTranscodeResourceHandlerCreator.hpp new file mode 100644 index 00000000..041ebc91 --- /dev/null +++ b/src/libs/av/include/av/AvTranscodeResourceHandlerCreator.hpp @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include + +#include "utils/IResourceHandler.hpp" + +namespace Av +{ + struct TranscodeParameters; + + std::unique_ptr createTranscodeResourceHandler(const std::filesystem::path& trackPath, const TranscodeParameters& parameters); + +} + diff --git a/src/libs/av/include/av/AvTranscoder.hpp b/src/libs/av/include/av/AvTranscoder.hpp index efe02f9b..60093ebb 100644 --- a/src/libs/av/include/av/AvTranscoder.hpp +++ b/src/libs/av/include/av/AvTranscoder.hpp @@ -33,7 +33,7 @@ namespace Av { struct TranscodeParameters { - std::optional encoding; // If not set, no transcoding is performed + Encoding encoding; std::size_t bitrate {128000}; std::optional stream; // Id of the stream to be transcoded (auto detect by default) std::optional offset; diff --git a/src/libs/database/impl/User.cpp b/src/libs/database/impl/User.cpp index 6b980130..c471b40b 100644 --- a/src/libs/database/impl/User.cpp +++ b/src/libs/database/impl/User.cpp @@ -283,6 +283,16 @@ User::getStarredTracks() const return std::vector>(_starredTracks.begin(), _starredTracks.end()); } + +bool +User::checkBitrate(Database::Bitrate bitrate) const +{ + if (audioTranscodeAllowedBitrates.find(bitrate) == std::cend(audioTranscodeAllowedBitrates)) + return false; + + return static_cast(_maxAudioTranscodeBitrate) >= bitrate; +} + } // namespace Database diff --git a/src/libs/database/include/database/User.hpp b/src/libs/database/include/database/User.hpp index c6283b00..f1e0d255 100644 --- a/src/libs/database/include/database/User.hpp +++ b/src/libs/database/include/database/User.hpp @@ -170,6 +170,8 @@ class User : public Wt::Dbo::Dbo bool hasStarredTrack(Wt::Dbo::ptr track) const; std::vector> getStarredTracks() const; + bool checkBitrate(Bitrate bitrate) const; + template void persist(Action& a) { diff --git a/src/libs/metadata/include/metadata/IParser.hpp b/src/libs/metadata/include/metadata/IParser.hpp index 4a8b5362..abb12216 100644 --- a/src/libs/metadata/include/metadata/IParser.hpp +++ b/src/libs/metadata/include/metadata/IParser.hpp @@ -75,6 +75,8 @@ namespace MetaData class IParser { public: + virtual ~IParser() = default; + virtual std::optional parse(const std::filesystem::path& p, bool debug = false) = 0; void setClusterTypeNames(const std::set& clusterTypeNames) { _clusterTypeNames = clusterTypeNames; } diff --git a/src/libs/subsonic/CMakeLists.txt b/src/libs/subsonic/CMakeLists.txt index 0531b7bf..e5743a37 100644 --- a/src/libs/subsonic/CMakeLists.txt +++ b/src/libs/subsonic/CMakeLists.txt @@ -1,5 +1,7 @@ add_library(lmssubsonic SHARED + impl/ParameterParsing.cpp + impl/Stream.cpp impl/SubsonicId.cpp impl/SubsonicResource.cpp impl/SubsonicResponse.cpp diff --git a/src/libs/subsonic/impl/ParameterParsing.cpp b/src/libs/subsonic/impl/ParameterParsing.cpp new file mode 100644 index 00000000..dbfd0656 --- /dev/null +++ b/src/libs/subsonic/impl/ParameterParsing.cpp @@ -0,0 +1,43 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#include "ParameterParsing.hpp" + +namespace StringUtils +{ + template<> + std::optional + StringUtils::readAs(const std::string& str) + { + return API::Subsonic::IdFromString(str); + } + + template<> + std::optional + StringUtils::readAs(const std::string& str) + { + if (str == "true") + return true; + else if (str == "false") + return false; + + return {}; + } +} + diff --git a/src/libs/subsonic/impl/ParameterParsing.hpp b/src/libs/subsonic/impl/ParameterParsing.hpp new file mode 100644 index 00000000..4b503238 --- /dev/null +++ b/src/libs/subsonic/impl/ParameterParsing.hpp @@ -0,0 +1,99 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ +#pragma once + +#include + +#include "utils/String.hpp" +#include "SubsonicId.hpp" +#include "SubsonicResponse.hpp" + +namespace API::Subsonic +{ + + template + std::vector + getMultiParametersAs(const Wt::Http::ParameterMap& parameterMap, const std::string& paramName) + { + std::vector res; + + auto it = parameterMap.find(paramName); + if (it == parameterMap.end()) + return res; + + for (const std::string& param : it->second) + { + auto value {StringUtils::readAs(param)}; + if (!value) + throw BadParameterFormatGenericError {paramName}; + + res.emplace_back(std::move(*value)); + } + + return res; + } + + template + std::vector + getMandatoryMultiParametersAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param) + { + std::vector res {getMultiParametersAs(parameterMap, param)}; + if (res.empty()) + throw RequiredParameterMissingError {}; + + return res; + } + + template + std::optional + getParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param) + { + std::vector params {getMultiParametersAs(parameterMap, param)}; + + if (params.size() != 1) + return std::nullopt; + + return T { std::move(params.front()) }; + } + + template + T + getMandatoryParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param) + { + auto res {getParameterAs(parameterMap, param)}; + if (!res) + throw RequiredParameterMissingError {}; + + return *res; + } + + +} + +namespace StringUtils +{ + template<> + std::optional + StringUtils::readAs(const std::string& str); + + template<> + std::optional + StringUtils::readAs(const std::string& str); +} + diff --git a/src/libs/subsonic/impl/RequestContext.hpp b/src/libs/subsonic/impl/RequestContext.hpp new file mode 100644 index 00000000..ec10a226 --- /dev/null +++ b/src/libs/subsonic/impl/RequestContext.hpp @@ -0,0 +1,44 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include + +#include +#include + + +namespace Database +{ + class Session; +} + +namespace API::Subsonic +{ + + struct RequestContext + { + const Wt::Http::ParameterMap& parameters; + Database::Session& dbSession; + std::string userName; + }; + +} + diff --git a/src/libs/subsonic/impl/Stream.cpp b/src/libs/subsonic/impl/Stream.cpp new file mode 100644 index 00000000..e58f33cd --- /dev/null +++ b/src/libs/subsonic/impl/Stream.cpp @@ -0,0 +1,139 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#include "Stream.hpp" + +#include "av/AvTranscoder.hpp" +#include "av/AvTranscodeResourceHandlerCreator.hpp" +#include "av/AvTypes.hpp" +#include "database/Session.hpp" +#include "database/Track.hpp" +#include "database/User.hpp" +#include "utils/IResourceHandler.hpp" +#include "utils/FileResourceHandlerCreator.hpp" +#include "utils/Utils.hpp" +#include "ParameterParsing.hpp" +#include "SubsonicId.hpp" + +using namespace Database; + +namespace API::Subsonic::Stream +{ + +static +Av::Encoding +userTranscodeFormatToAvEncoding(AudioFormat format) +{ + switch (format) + { + case AudioFormat::MP3: return Av::Encoding::MP3; + case AudioFormat::OGG_OPUS: return Av::Encoding::OGG_OPUS; + case AudioFormat::MATROSKA_OPUS: return Av::Encoding::MATROSKA_OPUS; + case AudioFormat::OGG_VORBIS: return Av::Encoding::OGG_VORBIS; + case AudioFormat::WEBM_VORBIS: return Av::Encoding::WEBM_VORBIS; + default: return Av::Encoding::OGG_OPUS; + } +} + +struct StreamParameters +{ + std::filesystem::path trackPath; + std::optional transcodeParameters; +}; + + +static +StreamParameters +getStreamParameters(RequestContext& context) +{ + // Mandatory params + Id id {getMandatoryParameterAs(context.parameters, "id")}; + + // Optional params + std::optional maxBitRate {getParameterAs(context.parameters, "maxBitRate")}; + std::optional format {getParameterAs(context.parameters, "format")}; + + StreamParameters parameters; + + auto transaction {context.dbSession.createSharedTransaction()}; + + { + auto track {Track::getById(context.dbSession, id.value)}; + if (!track) + throw RequestedDataNotFoundError {}; + + parameters.trackPath = track->getPath(); + } + + { + const User::pointer user {User::getByLoginName(context.dbSession, context.userName)}; + if (!user) + throw UserNotAuthorizedError {}; + + // format = "raw" => no transcode. Other format values will be ignored + const bool transcode {(!format || (*format != "raw")) && user->getAudioTranscodeEnable()}; + if (transcode) + { + // "If set to zero, no limit is imposed" + if (!maxBitRate || *maxBitRate == 0) + maxBitRate = user->getAudioTranscodeBitrate() / 1000; + + *maxBitRate = clamp(*maxBitRate, std::size_t {48}, user->getMaxAudioTranscodeBitrate() / 1000); + + Av::TranscodeParameters transcodeParameters; + + transcodeParameters.bitrate = *maxBitRate * 1000; + transcodeParameters.encoding = userTranscodeFormatToAvEncoding(user->getAudioTranscodeFormat()); + + parameters.transcodeParameters = std::move(transcodeParameters); + } + } + + return parameters; +} + +void +handle(RequestContext& context, const Wt::Http::Request& request, Wt::Http::Response& response) +{ + std::shared_ptr resourceHandler; + + Wt::Http::ResponseContinuation *continuation = request.continuation(); + if (!continuation) + { + StreamParameters streamParameters {getStreamParameters(context)}; + if (streamParameters.transcodeParameters) + resourceHandler = Av::createTranscodeResourceHandler(streamParameters.trackPath, *streamParameters.transcodeParameters); + else + resourceHandler = createFileResourceHandler(streamParameters.trackPath); + } + else + { + resourceHandler = Wt::cpp17::any_cast>(continuation->data()); + } + + resourceHandler->processRequest(request, response); + if (!resourceHandler->isFinished()) + { + Wt::Http::ResponseContinuation *continuation = response.createContinuation(); + continuation->setData(resourceHandler); + } +} + +} + diff --git a/src/libs/subsonic/impl/Stream.hpp b/src/libs/subsonic/impl/Stream.hpp new file mode 100644 index 00000000..bf7fade3 --- /dev/null +++ b/src/libs/subsonic/impl/Stream.hpp @@ -0,0 +1,31 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include + +#include "RequestContext.hpp" + +namespace API::Subsonic::Stream +{ + void handle(RequestContext& context, const Wt::Http::Request& request, Wt::Http::Response& response); +} + diff --git a/src/libs/subsonic/impl/SubsonicId.hpp b/src/libs/subsonic/impl/SubsonicId.hpp index 02915a4c..91cc61bc 100644 --- a/src/libs/subsonic/impl/SubsonicId.hpp +++ b/src/libs/subsonic/impl/SubsonicId.hpp @@ -17,6 +17,8 @@ * along with LMS. If not, see . */ +#pragma once + #include #include "database/Types.hpp" diff --git a/src/libs/subsonic/impl/SubsonicResource.cpp b/src/libs/subsonic/impl/SubsonicResource.cpp index 056005c5..c09a4c98 100644 --- a/src/libs/subsonic/impl/SubsonicResource.cpp +++ b/src/libs/subsonic/impl/SubsonicResource.cpp @@ -19,15 +19,10 @@ #include "subsonic/SubsonicResource.hpp" #include -#include -#include -#include -#include #include #include "auth/IPasswordService.hpp" -#include "av/AvTranscoder.hpp" #include "cover/ICoverArtGrabber.hpp" #include "database/Artist.hpp" #include "database/Cluster.hpp" @@ -40,10 +35,13 @@ #include "database/User.hpp" #include "recommendation/IEngine.hpp" #include "utils/Logger.hpp" +#include "utils/Random.hpp" #include "utils/Service.hpp" #include "utils/String.hpp" #include "utils/Utils.hpp" -#include "SubsonicId.hpp" +#include "ParameterParsing.hpp" +#include "RequestContext.hpp" +#include "Stream.hpp" #include "SubsonicResponse.hpp" using namespace Database; @@ -65,25 +63,6 @@ namespace API::Subsonic namespace StringUtils { - template<> - std::optional - StringUtils::readAs(const std::string& str) - { - return API::Subsonic::IdFromString(str); - } - - template<> - std::optional - StringUtils::readAs(const std::string& str) - { - if (str == "true") - return true; - else if (str == "false") - return false; - - return {}; - } - template<> std::optional StringUtils::readAs(const std::string& str) @@ -122,21 +101,6 @@ namespace StringUtils namespace API::Subsonic { -struct ClientInfo -{ - std::string name; - std::string user; - std::string password; - ClientVersion version; -}; - -struct RequestContext -{ - const Wt::Http::ParameterMap& parameters; - Session& dbSession; - std::string userName; -}; - static std::string makeNameFilesystemCompatible(const std::string& name) @@ -144,62 +108,6 @@ makeNameFilesystemCompatible(const std::string& name) return StringUtils::replaceInString(name, "/", "_"); } -template -std::vector -getMultiParametersAs(const Wt::Http::ParameterMap& parameterMap, const std::string& paramName) -{ - std::vector res; - - auto it = parameterMap.find(paramName); - if (it == parameterMap.end()) - return res; - - for (const std::string& param : it->second) - { - auto value {StringUtils::readAs(param)}; - if (!value) - throw BadParameterFormatGenericError {paramName}; - - res.emplace_back(std::move(*value)); - } - - return res; -} - -template -std::vector -getMandatoryMultiParametersAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param) -{ - std::vector res {getMultiParametersAs(parameterMap, param)}; - if (res.empty()) - throw RequiredParameterMissingError {}; - - return res; -} - -template -std::optional -getParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param) -{ - std::vector params {getMultiParametersAs(parameterMap, param)}; - - if (params.size() != 1) - return {}; - - return T { std::move(params.front()) }; -} - -template -T -getMandatoryParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param) -{ - auto res {getParameterAs(parameterMap, param)}; - if (!res) - throw RequiredParameterMissingError {}; - - return *res; -} - static std::string decodePasswordIfNeeded(const std::string& password) @@ -216,6 +124,14 @@ decodePasswordIfNeeded(const std::string& password) return password; } +struct ClientInfo +{ + std::string name; + std::string user; + std::string password; + ClientVersion version; +}; + static ClientInfo getClientInfo(const Wt::Http::ParameterMap& parameters) @@ -238,14 +154,6 @@ getClientInfo(const Wt::Http::ParameterMap& parameters) return res; } -// MediaRetrievals -struct MediaRetrievalResult -{ - std::string mimeType; - std::vector data; - Wt::cpp17::any continuationData; -}; - SubsonicResource::SubsonicResource(Db& db) : _sessionPool {db} { @@ -470,22 +378,20 @@ releaseToResponseNode(const Release::pointer& release, Session& dbSession, const } else if (!artists.empty()) { - if (artists.size() > 1) - { - albumNode.setAttribute("artist", "Various Artists"); + albumNode.setAttribute("artist", getArtistNames(artists)); - if (!id3) - albumNode.setAttribute("parent", IdToString({Id::Type::Root})); - } - else + if (artists.size() == 1) { - albumNode.setAttribute("artist", artists.front()->getName()); - if (id3) albumNode.setAttribute("artistId", IdToString({Id::Type::Artist, artists.front().id()})); else albumNode.setAttribute("parent", IdToString({Id::Type::Artist, artists.front().id()})); } + else + { + if (!id3) + albumNode.setAttribute("parent", IdToString({Id::Type::Root})); + } } if (id3) @@ -1167,9 +1073,7 @@ handleGetSimilarSongsRequestCommon(RequestContext& context, bool id3) std::make_move_iterator(std::end(similarArtistTracks))); } - auto now {std::chrono::system_clock::now()}; - std::mt19937 randGenerator {static_cast(std::chrono::duration_cast(now.time_since_epoch()).count())}; - std::shuffle(std::begin(tracks), std::end(tracks), randGenerator); + Random::shuffleContainer(tracks); Response response {Response::createOkResponse()}; Response::Node& similarSongsNode {response.createNode(id3 ? "similarSongs2" : "similarSongs")}; @@ -1777,112 +1681,8 @@ handleNotImplemented(RequestContext&) } static -Av::Encoding -userTranscodeFormatToAvEncoding(AudioFormat format) -{ - switch (format) - { - case AudioFormat::MP3: return Av::Encoding::MP3; - case AudioFormat::OGG_OPUS: return Av::Encoding::OGG_OPUS; - case AudioFormat::MATROSKA_OPUS: return Av::Encoding::MATROSKA_OPUS; - case AudioFormat::OGG_VORBIS: return Av::Encoding::OGG_VORBIS; - case AudioFormat::WEBM_VORBIS: return Av::Encoding::WEBM_VORBIS; - default: return Av::Encoding::OGG_OPUS; - } -} - -static -std::shared_ptr -createTranscoder(RequestContext& context) -{ - // Mandatory params - Id id {getMandatoryParameterAs(context.parameters, "id")}; - - // Optional params - std::optional maxBitRate {getParameterAs(context.parameters, "maxBitRate")}; - std::optional format {getParameterAs(context.parameters, "format")}; - - Av::TranscodeParameters parameters {}; - parameters.stripMetadata = false; // Since it can be cached and some players read the metadata from the downloaded file - - std::filesystem::path trackPath; - { - auto transaction {context.dbSession.createSharedTransaction()}; - - { - auto track {Track::getById(context.dbSession, id.value)}; - if (!track) - throw RequestedDataNotFoundError {}; - - trackPath = track->getPath(); - } - - { - const User::pointer user {User::getByLoginName(context.dbSession, context.userName)}; - if (!user) - throw UserNotAuthorizedError {}; - - // format = "raw" => no transcode. Other format values will be ignored - const bool transcode {(!format || (format && *format != "raw")) && user->getAudioTranscodeEnable()}; - if (transcode) - { - // "If set to zero, no limit is imposed" - if (!maxBitRate || *maxBitRate == 0) - maxBitRate = user->getAudioTranscodeBitrate() / 1000; - - *maxBitRate = clamp(*maxBitRate, std::size_t {48}, user->getMaxAudioTranscodeBitrate() / 1000); - - parameters.bitrate = *maxBitRate * 1000; - parameters.encoding = userTranscodeFormatToAvEncoding(user->getAudioTranscodeFormat()); - } - } - } - - return std::make_shared(trackPath, parameters); -} - -static -MediaRetrievalResult -handleStream(RequestContext& context, Wt::Http::ResponseContinuation* continuation) -{ - MediaRetrievalResult res; - - // TODO store only weak ptrs and use a ring container to store shared_ptr? - std::shared_ptr transcoder; - - if (!continuation) - { - transcoder = createTranscoder(context); - transcoder->start(); - - res.mimeType = transcoder->getOutputMimeType(); - LMS_LOG(API_SUBSONIC, DEBUG) << "Mime type set to '" << transcoder->getOutputMimeType() << "'"; - } - else - { - transcoder = Wt::cpp17::any_cast>(continuation->data()); - } - - if (!transcoder) - throw InternalErrorGenericError {"Cannot create transcoder"}; - - if (!transcoder->isComplete()) - { - static constexpr std::size_t chunkSize {65536*4}; - res.data.reserve(chunkSize); - - transcoder->process(res.data, chunkSize); - } - - if (!transcoder->isComplete()) - res.continuationData = std::move(transcoder); - - return res; -} - -static -MediaRetrievalResult -handleGetCoverArt(RequestContext& context, Wt::Http::ResponseContinuation*) +void +handleGetCoverArt(RequestContext& context, const Wt::Http::Request& /*request*/, Wt::Http::Response& response) { // Mandatory params Id id {getMandatoryParameterAs(context.parameters, "id")}; @@ -1890,23 +1690,21 @@ handleGetCoverArt(RequestContext& context, Wt::Http::ResponseContinuation*) std::size_t size {getParameterAs(context.parameters, "size").value_or(256)}; size = clamp(size, std::size_t {32}, std::size_t {1024}); - MediaRetrievalResult res; - + std::vector data; switch (id.type) { case Id::Type::Track: - res.data = ServiceProvider::get()->getFromTrack(context.dbSession, id.value, CoverArt::Format::JPEG, size); + data = ServiceProvider::get()->getFromTrack(context.dbSession, id.value, CoverArt::Format::JPEG, size); break; case Id::Type::Release: - res.data = ServiceProvider::get()->getFromRelease(context.dbSession, id.value, CoverArt::Format::JPEG, size); + data = ServiceProvider::get()->getFromRelease(context.dbSession, id.value, CoverArt::Format::JPEG, size); break; default: throw BadParameterGenericError {"id"}; } - res.mimeType = CoverArt::formatToMimeType(CoverArt::Format::JPEG); - - return res; + response.out().write(reinterpret_cast(&data[0]), data.size()); + response.setMimeType(CoverArt::formatToMimeType(CoverArt::Format::JPEG)); } using RequestHandlerFunc = std::function; @@ -2022,12 +1820,12 @@ static std::unordered_map requestEntryPoints {"startScan", {handleNotImplemented, true}}, }; -using MediaRetrievalHandlerFunc = std::function; +using MediaRetrievalHandlerFunc = std::function; static std::unordered_map mediaRetrievalHandlers { // Media retrieval {"getCoverArt", handleGetCoverArt}, - {"stream", handleStream}, + {"stream", Stream::handle}, }; void @@ -2094,26 +1892,7 @@ SubsonicResource::handleRequest(const Wt::Http::Request &request, Wt::Http::Resp auto itStreamHandler {mediaRetrievalHandlers.find(requestPath)}; if (itStreamHandler != mediaRetrievalHandlers.end()) { - MediaRetrievalResult res {itStreamHandler->second(requestContext, request.continuation())}; - - if (!res.mimeType.empty()) - response.setMimeType(res.mimeType); - if (!res.data.empty()) - { - response.out().write(reinterpret_cast(&res.data[0]), res.data.size()); - if (!response.out()) - { - LMS_LOG(API_SUBSONIC, ERROR) << "Write failed!"; - return; - } - } - - if (res.continuationData.has_value()) - { - auto continuation {response.createContinuation()}; - continuation->setData(std::move(res.continuationData)); - } - + itStreamHandler->second(requestContext, request, response); LMS_LOG(API_SUBSONIC, DEBUG) << "Request " << requestId << " '" << requestPath << "' handled!"; return; } diff --git a/src/libs/subsonic/impl/SubsonicResponse.hpp b/src/libs/subsonic/impl/SubsonicResponse.hpp index f153e6f7..a88217ad 100644 --- a/src/libs/subsonic/impl/SubsonicResponse.hpp +++ b/src/libs/subsonic/impl/SubsonicResponse.hpp @@ -16,6 +16,7 @@ * You should have received a copy of the GNU General Public License * along with LMS. If not, see . */ +#pragma once #include #include diff --git a/src/libs/utils/CMakeLists.txt b/src/libs/utils/CMakeLists.txt index c468be2f..e3cd2e9e 100644 --- a/src/libs/utils/CMakeLists.txt +++ b/src/libs/utils/CMakeLists.txt @@ -1,6 +1,7 @@ add_library(lmsutils SHARED impl/Config.cpp + impl/FileResourceHandler.cpp impl/Logger.cpp impl/NetAddress.cpp impl/Path.cpp diff --git a/src/libs/utils/impl/FileResourceHandler.cpp b/src/libs/utils/impl/FileResourceHandler.cpp new file mode 100644 index 00000000..ad7ec8eb --- /dev/null +++ b/src/libs/utils/impl/FileResourceHandler.cpp @@ -0,0 +1,138 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#include "FileResourceHandler.hpp" + +#include + +#include "utils/Logger.hpp" + +std::unique_ptr +createFileResourceHandler(const std::filesystem::path& path) +{ + return std::make_unique(path); +} + + +FileResourceHandler::FileResourceHandler(const std::filesystem::path& path) +: _path {path} +{ +} + + +void +FileResourceHandler::processRequest(const Wt::Http::Request& request, Wt::Http::Response& response) +{ + ::uint64_t startByte {_offset}; + std::ifstream ifs {_path.string().c_str(), std::ios::in | std::ios::binary}; + + LMS_LOG(UTILS, DEBUG) << "startByte = " << startByte; + + if (startByte == 0) + { + if (!ifs) + { + LMS_LOG(UTILS, ERROR) << "Cannot open file stream for '" << _path.string() << "'"; + response.setStatus(404); + _isFinished = true; + return; + } + else + { + response.setStatus(200); + } + + ifs.seekg(0, std::ios::end); + const ::uint64_t fileSize {static_cast<::uint64_t>(ifs.tellg())}; + ifs.seekg(0, std::ios::beg); + + LMS_LOG(UTILS, DEBUG) << "fileSize = " << fileSize; + + const Wt::Http::Request::ByteRangeSpecifier ranges {request.getRanges(fileSize)}; + if (!ranges.isSatisfiable()) + { + std::ostringstream contentRange; + contentRange << "bytes */" << fileSize; + response.setStatus(416); // Requested range not satisfiable + response.addHeader("Content-Range", contentRange.str()); + + LMS_LOG(UTILS, DEBUG) << "Range not satisfiable"; + _isFinished = true; + return; + } + + if (ranges.size() == 1) + { + LMS_LOG(UTILS, DEBUG) << "Range requested = " << ranges[0].firstByte() << "/" << ranges[0].lastByte(); + + response.setStatus(206); + startByte = ranges[0].firstByte(); + _beyondLastByte = ranges[0].lastByte() + 1; + + std::ostringstream contentRange; + contentRange << "bytes " << startByte << "-" + << _beyondLastByte - 1 << "/" << fileSize; + + response.addHeader("Content-Range", contentRange.str()); + response.setContentLength(_beyondLastByte - startByte); + } + else + { + LMS_LOG(UTILS, DEBUG) << "No range requested"; + + _beyondLastByte = fileSize; + response.setContentLength(_beyondLastByte); + } + } + + ifs.seekg(static_cast(startByte)); + + std::vector buf; + buf.resize(_chunkSize); + + ::uint64_t restSize = _beyondLastByte - startByte; + ::uint64_t pieceSize = buf.size() > restSize ? restSize : buf.size(); + + ifs.read(&buf[0], pieceSize); + const ::uint64_t actualPieceSize {static_cast<::uint64_t>(ifs.gcount())}; + response.out().write(&buf[0], actualPieceSize); + + LMS_LOG(UTILS, DEBUG) << "Written " << actualPieceSize << " bytes"; + + LMS_LOG(UTILS, DEBUG) << "Progress: " << actualPieceSize << "/" << restSize; + if (ifs.good() && actualPieceSize < restSize) + { + _offset = startByte + actualPieceSize; + + LMS_LOG(UTILS, DEBUG) << "Job not complete! Next chunk offset = " << _offset; + } + else + { + _isFinished = true; + LMS_LOG(UTILS, DEBUG) << "Job complete!"; + } +} + +bool +FileResourceHandler::isFinished() const +{ + return _isFinished; +} + + diff --git a/src/libs/utils/impl/FileResourceHandler.hpp b/src/libs/utils/impl/FileResourceHandler.hpp new file mode 100644 index 00000000..befd3bdd --- /dev/null +++ b/src/libs/utils/impl/FileResourceHandler.hpp @@ -0,0 +1,43 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include "utils/IResourceHandler.hpp" + +class FileResourceHandler final : public IResourceHandler +{ + public: + FileResourceHandler(const std::filesystem::path& filePath); + + private: + + void processRequest(const Wt::Http::Request& request, Wt::Http::Response& response) override; + bool isFinished() const override; + + static constexpr std::size_t _chunkSize {262144}; + + std::filesystem::path _path; + ::uint64_t _beyondLastByte {}; + ::uint64_t _offset {}; + bool _isFinished {}; + +}; + diff --git a/src/libs/utils/impl/Logger.cpp b/src/libs/utils/impl/Logger.cpp index 602fdbc3..d19f79b3 100644 --- a/src/libs/utils/impl/Logger.cpp +++ b/src/libs/utils/impl/Logger.cpp @@ -37,6 +37,7 @@ const char* getModuleName(Module mod) case Module::RECOMMENDATION: return "RECOMMENDATION"; case Module::TRANSCODE: return "TRANSCODE"; case Module::UI: return "UI"; + case Module::UTILS: return "UTILS"; } return ""; } diff --git a/src/libs/utils/include/utils/FileResourceHandlerCreator.hpp b/src/libs/utils/include/utils/FileResourceHandlerCreator.hpp new file mode 100644 index 00000000..8f69e18a --- /dev/null +++ b/src/libs/utils/include/utils/FileResourceHandlerCreator.hpp @@ -0,0 +1,28 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include + +#include "utils/IResourceHandler.hpp" + +std::unique_ptr createFileResourceHandler(const std::filesystem::path& path); + diff --git a/src/libs/utils/include/utils/IConfig.hpp b/src/libs/utils/include/utils/IConfig.hpp index 6b62169b..2612f6f5 100644 --- a/src/libs/utils/include/utils/IConfig.hpp +++ b/src/libs/utils/include/utils/IConfig.hpp @@ -27,6 +27,8 @@ class IConfig { public: + virtual ~IConfig() = default; + // Default values are returned in case of setting not found virtual std::string getString(const std::string& setting, const std::string& def = "", const std::unordered_set& allowedValues = {}) = 0; virtual std::filesystem::path getPath(const std::string& setting, const std::filesystem::path& def = std::filesystem::path()) = 0; diff --git a/src/libs/utils/include/utils/IResourceHandler.hpp b/src/libs/utils/include/utils/IResourceHandler.hpp new file mode 100644 index 00000000..b3fb1a5e --- /dev/null +++ b/src/libs/utils/include/utils/IResourceHandler.hpp @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include + +// Helper class to serve a resource (must be saved as continuation data if not complete) +class IResourceHandler +{ + public: + virtual ~IResourceHandler() = default; + + virtual void processRequest(const Wt::Http::Request& request, Wt::Http::Response& response) = 0; + virtual bool isFinished() const = 0; +}; + diff --git a/src/libs/utils/include/utils/Logger.hpp b/src/libs/utils/include/utils/Logger.hpp index 9f5b2ec5..11789b17 100644 --- a/src/libs/utils/include/utils/Logger.hpp +++ b/src/libs/utils/include/utils/Logger.hpp @@ -49,6 +49,7 @@ enum class Module RECOMMENDATION, TRANSCODE, UI, + UTILS, }; const char* getModuleName(Module mod); @@ -77,6 +78,7 @@ class Log class Logger { public: + virtual ~Logger() = default; virtual void processLog(const Log& log) = 0; }; diff --git a/src/lms/CMakeLists.txt b/src/lms/CMakeLists.txt index d422a93b..6cdfdddc 100644 --- a/src/lms/CMakeLists.txt +++ b/src/lms/CMakeLists.txt @@ -29,8 +29,9 @@ add_executable(lms ui/explore/ReleaseView.cpp ui/explore/TracksInfoView.cpp ui/explore/TracksView.cpp + ui/resource/AudioFileResource.cpp + ui/resource/AudioTranscodeResource.cpp ui/resource/ImageResource.cpp - ui/resource/AudioResource.cpp ) target_include_directories(lms PRIVATE diff --git a/src/lms/ui/LmsApplication.cpp b/src/lms/ui/LmsApplication.cpp index 8a6dbcc2..1dfb5b30 100644 --- a/src/lms/ui/LmsApplication.cpp +++ b/src/lms/ui/LmsApplication.cpp @@ -44,8 +44,9 @@ #include "admin/DatabaseSettingsView.hpp" #include "admin/UserView.hpp" #include "admin/UsersView.hpp" +#include "resource/AudioFileResource.hpp" +#include "resource/AudioTranscodeResource.hpp" #include "resource/ImageResource.hpp" -#include "resource/AudioResource.hpp" #include "Auth.hpp" #include "LmsApplicationException.hpp" #include "MediaPlayer.hpp" @@ -400,7 +401,8 @@ void LmsApplication::createHome() { _imageResource = std::make_shared(); - _audioResource = std::make_shared(); + _audioTranscodeResource = std::make_shared(); + _audioFileResource = std::make_shared(); setConfirmCloseMessage(Wt::WString::tr("Lms.quit-confirm")); diff --git a/src/lms/ui/LmsApplication.hpp b/src/lms/ui/LmsApplication.hpp index cd0f04ca..474562d3 100644 --- a/src/lms/ui/LmsApplication.hpp +++ b/src/lms/ui/LmsApplication.hpp @@ -39,7 +39,8 @@ namespace Database { namespace UserInterface { -class AudioResource; +class AudioTranscodeResource; +class AudioFileResource; class Auth; class ImageResource; class LmsApplicationException; @@ -82,7 +83,8 @@ class LmsApplication : public Wt::WApplication // Session application data std::shared_ptr getImageResource() { return _imageResource; } - std::shared_ptr getAudioResource() { return _audioResource; } + std::shared_ptr getAudioTranscodeResource() { return _audioTranscodeResource; } + std::shared_ptr getAudioFileResource() { return _audioFileResource; } Database::Session& getDbSession() { return _dbSession;} Wt::Dbo::ptr getUser(); @@ -128,8 +130,9 @@ class LmsApplication : public Wt::WApplication Events _events; std::optional _userId; std::optional _userAuthStrong; + std::shared_ptr _audioTranscodeResource; + std::shared_ptr _audioFileResource; std::shared_ptr _imageResource; - std::shared_ptr _audioResource; }; diff --git a/src/lms/ui/MediaPlayer.cpp b/src/lms/ui/MediaPlayer.cpp index 8b376ad1..bd7d7f36 100644 --- a/src/lms/ui/MediaPlayer.cpp +++ b/src/lms/ui/MediaPlayer.cpp @@ -19,15 +19,16 @@ #include "MediaPlayer.hpp" -#include "av/AvInfo.hpp" #include "utils/Logger.hpp" #include "database/Artist.hpp" #include "database/Release.hpp" #include "database/Track.hpp" +#include "database/User.hpp" #include "resource/ImageResource.hpp" -#include "resource/AudioResource.hpp" +#include "resource/AudioTranscodeResource.hpp" +#include "resource/AudioFileResource.hpp" #include "utils/String.hpp" @@ -57,68 +58,72 @@ MediaPlayer::loadTrack(Database::IdType trackId, bool play) LMS_LOG(UI, DEBUG) << "Playing track ID = " << trackId; auto transaction {LmsApp->getDbSession().createSharedTransaction()}; + const auto track {Database::Track::getById(LmsApp->getDbSession(), trackId)}; + const std::string imgResourceMimeType {LmsApp->getImageResource()->getMimeType()}; - try + std::string resource; + bool transcode; + if (LmsApp->getUser()->getAudioTranscodeEnable()) { - const Av::MediaFile mediaFile {track->getPath()}; - - const std::string resource {LmsApp->getAudioResource()->getUrl(trackId)}; - const std::string imgResourceMimeType {LmsApp->getImageResource()->getMimeType()}; - - const auto artists {track->getArtists()}; - - std::ostringstream oss; - oss - << "var params = {" - << " resource: \"" << resource << "\"," - << " duration: " << std::chrono::duration_cast(track->getDuration()).count() << "," - << " title: \"" << StringUtils::jsEscape(track->getName()) << "\"," - << " artist: \"" << (!artists.empty() ? StringUtils::jsEscape(artists.front()->getName()) : "") << "\"," - << " release: \"" << (track->getRelease() ? StringUtils::jsEscape(track->getRelease()->getName()) : "") << "\"," - << " artwork: [" - << " { src: \"" << LmsApp->getImageResource()->getTrackUrl(trackId, 96) << "\", sizes: \"96x96\", type: \"" << imgResourceMimeType << "\" }," - << " { src: \"" << LmsApp->getImageResource()->getTrackUrl(trackId, 256) << "\", sizes: \"256x256\", type: \"" << imgResourceMimeType << "\" }," - << " { src: \"" << LmsApp->getImageResource()->getTrackUrl(trackId, 512) << "\", sizes: \"512x512\", type: \"" << imgResourceMimeType << "\" }," - << " ]" - << "};"; - oss << "LMS.mediaplayer.loadTrack(params, " << (play ? "true" : "false") << ")"; // true to autoplay - - LMS_LOG(UI, DEBUG) << "Running js = '" << oss.str() << "'"; - - _title->setTextFormat(Wt::TextFormat::Plain); - _title->setText(Wt::WString::fromUTF8(track->getName())); - - if (!artists.empty()) - { - _artist->setTextFormat(Wt::TextFormat::Plain); - _artist->setText(Wt::WString::fromUTF8(artists.front()->getName())); - _artist->setLink(LmsApp->createArtistLink(artists.front())); - } - else - { - _artist->setText(""); - _artist->setLink({}); - } - - if (track->getRelease()) - { - _release->setTextFormat(Wt::TextFormat::Plain); - _release->setText(Wt::WString::fromUTF8(track->getRelease()->getName())); - _release->setLink(LmsApp->createReleaseLink(track->getRelease())); - } - else - { - _release->setText(""); - _release->setLink({}); - } - - wApp->doJavaScript(oss.str()); + resource = LmsApp->getAudioTranscodeResource()->getUrlForUser(trackId, LmsApp->getUser()); + transcode = true; } - catch (Av::MediaFileException& e) + else { - LMS_LOG(UI, ERROR) << "MediaFileException: " << e.what(); + resource = LmsApp->getAudioFileResource()->getUrl(trackId); + transcode = false; } + + const auto artists {track->getArtists()}; + + std::ostringstream oss; + oss + << "var params = {" + << " mode: " << (transcode ? "Mode.Transcode" : "Mode.File") << "," + << " resource: \"" << resource << "\"," + << " duration: " << std::chrono::duration_cast(track->getDuration()).count() << "," + << " title: \"" << StringUtils::jsEscape(track->getName()) << "\"," + << " artist: \"" << (!artists.empty() ? StringUtils::jsEscape(artists.front()->getName()) : "") << "\"," + << " release: \"" << (track->getRelease() ? StringUtils::jsEscape(track->getRelease()->getName()) : "") << "\"," + << " artwork: [" + << " { src: \"" << LmsApp->getImageResource()->getTrackUrl(trackId, 96) << "\", sizes: \"96x96\", type: \"" << imgResourceMimeType << "\" }," + << " { src: \"" << LmsApp->getImageResource()->getTrackUrl(trackId, 256) << "\", sizes: \"256x256\", type: \"" << imgResourceMimeType << "\" }," + << " { src: \"" << LmsApp->getImageResource()->getTrackUrl(trackId, 512) << "\", sizes: \"512x512\", type: \"" << imgResourceMimeType << "\" }," + << " ]" + << "};"; + oss << "LMS.mediaplayer.loadTrack(params, " << (play ? "true" : "false") << ")"; // true to autoplay + + LMS_LOG(UI, DEBUG) << "Running js = '" << oss.str() << "'"; + + _title->setTextFormat(Wt::TextFormat::Plain); + _title->setText(Wt::WString::fromUTF8(track->getName())); + + if (!artists.empty()) + { + _artist->setTextFormat(Wt::TextFormat::Plain); + _artist->setText(Wt::WString::fromUTF8(artists.front()->getName())); + _artist->setLink(LmsApp->createArtistLink(artists.front())); + } + else + { + _artist->setText(""); + _artist->setLink({}); + } + + if (track->getRelease()) + { + _release->setTextFormat(Wt::TextFormat::Plain); + _release->setText(Wt::WString::fromUTF8(track->getRelease()->getName())); + _release->setLink(LmsApp->createReleaseLink(track->getRelease())); + } + else + { + _release->setText(""); + _release->setLink({}); + } + + wApp->doJavaScript(oss.str()); } void diff --git a/src/lms/ui/resource/AudioFileResource.cpp b/src/lms/ui/resource/AudioFileResource.cpp new file mode 100644 index 00000000..2a2fa5a6 --- /dev/null +++ b/src/lms/ui/resource/AudioFileResource.cpp @@ -0,0 +1,118 @@ +/* + * Copyright (C) 2020 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#include "AudioFileResource.hpp" + +#include +#include + +#include "av/AvInfo.hpp" +#include "database/Track.hpp" +#include "utils/FileResourceHandlerCreator.hpp" +#include "utils/Logger.hpp" +#include "utils/String.hpp" +#include "LmsApplication.hpp" + +namespace UserInterface { + +#define LOG(level) LMS_LOG(UI, level) << "Audio file resource: " + +AudioFileResource:: ~AudioFileResource() +{ + beingDeleted(); +} + +std::string +AudioFileResource::getUrl(Database::IdType trackId) const +{ + return url()+ "&trackid=" + std::to_string(trackId); +} + +static +std::optional +getTrackPathFromTrackId(Database::IdType trackId) +{ + // DbSession are not thread safe + Wt::WApplication::UpdateLock lock {LmsApp}; + + auto transaction {LmsApp->getDbSession().createSharedTransaction()}; + + const Database::Track::pointer track {Database::Track::getById(LmsApp->getDbSession(), trackId)}; + if (!track) + { + LOG(ERROR) << "Missing track"; + return std::nullopt; + } + + return track->getPath(); +} + +static +std::optional +getTrackPathFromURLArgs(const Wt::Http::Request& request) +{ + const std::string* trackIdParameter {request.getParameter("trackid")}; + if (!trackIdParameter) + { + LOG(ERROR) << "Missing trackid URL parameter!"; + return std::nullopt; + } + + const auto trackId {StringUtils::readAs(*trackIdParameter)}; + if (!trackId) + { + LOG(ERROR) << "Bad trackid URL parameter!"; + return std::nullopt; + } + + return getTrackPathFromTrackId(*trackId); +} + +void +AudioFileResource::handleRequest(const Wt::Http::Request& request, + Wt::Http::Response& response) +{ + std::shared_ptr fileResourceHandler; + + if (!request.continuation()) + { + auto trackPath {getTrackPathFromURLArgs(request)}; + if (!trackPath) + return; + + fileResourceHandler = createFileResourceHandler(*trackPath); + } + else + { + fileResourceHandler = Wt::cpp17::any_cast>(request.continuation()->data()); + } + + fileResourceHandler->processRequest(request, response); + + if (!fileResourceHandler->isFinished()) + { + auto* continuation {response.createContinuation()}; + continuation->setData(fileResourceHandler); + } +} + + +} // namespace UserInterface + + diff --git a/src/lms/ui/resource/AudioResource.hpp b/src/lms/ui/resource/AudioFileResource.hpp similarity index 80% rename from src/lms/ui/resource/AudioResource.hpp rename to src/lms/ui/resource/AudioFileResource.hpp index 66cd07a5..9e52a077 100644 --- a/src/lms/ui/resource/AudioResource.hpp +++ b/src/lms/ui/resource/AudioFileResource.hpp @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015 Emeric Poupon + * Copyright (C) 2020 Emeric Poupon * * This file is part of LMS. * @@ -19,28 +19,28 @@ #pragma once +#include #include -#include "av/AvTranscoder.hpp" - #include "database/Types.hpp" namespace UserInterface { -class AudioResource : public Wt::WResource +class AudioFileResource : public Wt::WResource { public: - ~AudioResource(); + ~AudioFileResource(); std::string getUrl(Database::IdType trackId) const; - void handleRequest(const Wt::Http::Request& request, - Wt::Http::Response& response); - private: - static const std::size_t _chunkSize = 65536*4; + static constexpr std::size_t _chunkSize {262144}; + + void handleRequest(const Wt::Http::Request& request, + Wt::Http::Response& response) override; + }; } // namespace UserInterface diff --git a/src/lms/ui/resource/AudioResource.cpp b/src/lms/ui/resource/AudioResource.cpp deleted file mode 100644 index 520ce7ed..00000000 --- a/src/lms/ui/resource/AudioResource.cpp +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Copyright (C) 2015 Emeric Poupon - * - * This file is part of LMS. - * - * LMS 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. - * - * LMS 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 LMS. If not, see . - */ - -#include "AudioResource.hpp" - -#include - -#include "utils/Logger.hpp" - -#include "database/Track.hpp" -#include "database/User.hpp" - -#include "LmsApplication.hpp" - -namespace UserInterface { - - -AudioResource:: ~AudioResource() -{ - beingDeleted(); -} - -std::string -AudioResource::getUrl(Database::IdType trackId) const -{ - return url()+ "&trackid=" + std::to_string(trackId); -} - -void -AudioResource::handleRequest(const Wt::Http::Request& request, - Wt::Http::Response& response) -{ - std::shared_ptr transcoder; - - // First, see if this request is for a continuation - Wt::Http::ResponseContinuation *continuation = request.continuation(); - if (continuation) - { - LMS_LOG(UI, DEBUG) << "Continuation! " << continuation ; - transcoder = Wt::cpp17::any_cast>(continuation->data()); - } - else - { - Database::IdType trackId; - Av::TranscodeParameters parameters {}; - parameters.stripMetadata = true; - - LMS_LOG(UI, DEBUG) << "First request: creating transcoder"; - try - { - auto trackIdStr = request.getParameter("trackid"); - if (!trackIdStr) - { - LMS_LOG(UI, ERROR) << "Missing trackid transcode parameter!"; - return; - } - trackId = std::stol(*request.getParameter("trackid")); - - auto offsetStr = request.getParameter("offset"); - parameters.offset = std::chrono::seconds(offsetStr ? std::stol(*offsetStr) : 0); - } - catch (std::exception &e) - { - LMS_LOG(UI, ERROR) << "Exception while handling URL parameters: " << e.what(); - return; - } - - // DbSession are not thread safe - { - Wt::WApplication::UpdateLock lock(LmsApp); - auto transaction {LmsApp->getDbSession().createSharedTransaction()}; - - const Database::Track::pointer track {Database::Track::getById(LmsApp->getDbSession(), trackId)}; - if (!track) - { - LMS_LOG(UI, ERROR) << "Missing track"; - return; - } - - if (LmsApp->getUser()->getAudioTranscodeEnable()) - { - parameters.bitrate = LmsApp->getUser()->getAudioTranscodeBitrate(); - - switch (LmsApp->getUser()->getAudioTranscodeFormat()) - { - case Database::AudioFormat::MP3: - parameters.encoding = Av::Encoding::MP3; - break; - case Database::AudioFormat::OGG_OPUS: - parameters.encoding = Av::Encoding::OGG_OPUS; - break; - case Database::AudioFormat::MATROSKA_OPUS: - parameters.encoding = Av::Encoding::MATROSKA_OPUS; - break; - case Database::AudioFormat::OGG_VORBIS: - parameters.encoding = Av::Encoding::OGG_VORBIS; - break; - case Database::AudioFormat::WEBM_VORBIS: - parameters.encoding = Av::Encoding::WEBM_VORBIS; - break; - default: - parameters.encoding = Av::Encoding::OGG_OPUS; - break; - } - } - else - parameters.bitrate = 0; - - transcoder = std::make_shared(track->getPath(), parameters); - } - - - if (!transcoder->start()) - { - LMS_LOG(UI, ERROR) << "Cannot start transcoder"; - return; - } - - LMS_LOG(UI, DEBUG) << "Transcoder started"; - - std::string mimeType {transcoder->getOutputMimeType()}; - response.setMimeType(mimeType); - LMS_LOG(UI, DEBUG) << "Mime type set to '" << mimeType << "'"; - - } - - if (!transcoder->isComplete()) - { - std::vector data; - data.reserve(_chunkSize); - - transcoder->process(data, _chunkSize); - - response.out().write(reinterpret_cast(&data[0]), data.size()); - LMS_LOG(UI, DEBUG) << "Written " << data.size() << " bytes! complete = " << (transcoder->isComplete() ? "true" : "false"); - - if (!response.out()) - { - LMS_LOG(UI, ERROR) << "Write failed!"; - } - } - - if (!transcoder->isComplete() && response.out()) - { - continuation = response.createContinuation(); - continuation->setData(transcoder); - } - else - LMS_LOG(UI, DEBUG) << "No more data!"; -} - -} // namespace UserInterface - - diff --git a/src/lms/ui/resource/AudioTranscodeResource.cpp b/src/lms/ui/resource/AudioTranscodeResource.cpp new file mode 100644 index 00000000..ece62937 --- /dev/null +++ b/src/lms/ui/resource/AudioTranscodeResource.cpp @@ -0,0 +1,224 @@ +/* + * Copyright (C) 2015 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#include "AudioTranscodeResource.hpp" + +#include + +#include "av/AvTranscoder.hpp" +#include "database/Track.hpp" +#include "database/User.hpp" +#include "utils/Logger.hpp" +#include "utils/String.hpp" + +#include "LmsApplication.hpp" + +#define LOG(level) LMS_LOG(UI, level) << "Audio transcode resource: " + +namespace StringUtils +{ + template <> + std::optional + readAs(const std::string& str) + { + + auto encodedFormat {readAs(str)}; + if (!encodedFormat) + return std::nullopt; + + Database::AudioFormat format {static_cast(*encodedFormat)}; + + // check + switch (static_cast(*encodedFormat)) + { + case Database::AudioFormat::MP3: + [[fallthrough]]; + case Database::AudioFormat::OGG_OPUS: + [[fallthrough]]; + case Database::AudioFormat::MATROSKA_OPUS: + [[fallthrough]]; + case Database::AudioFormat::OGG_VORBIS: + [[fallthrough]]; + case Database::AudioFormat::WEBM_VORBIS: + return format; + } + + LOG(ERROR) << "Cannot determine audio format from value '" << str << "'"; + + return std::nullopt; + } +} + +namespace UserInterface { + +AudioTranscodeResource:: ~AudioTranscodeResource() +{ + beingDeleted(); +} + +static +std::optional +AudioFormatToAvEncoding(Database::AudioFormat format) +{ + switch (format) + { + case Database::AudioFormat::MP3: return Av::Encoding::MP3; + case Database::AudioFormat::OGG_OPUS: return Av::Encoding::OGG_OPUS; + case Database::AudioFormat::MATROSKA_OPUS: return Av::Encoding::MATROSKA_OPUS; + case Database::AudioFormat::OGG_VORBIS: return Av::Encoding::OGG_VORBIS; + case Database::AudioFormat::WEBM_VORBIS: return Av::Encoding::WEBM_VORBIS; + } + + LOG(ERROR) << "Cannot convert from audio format to encoding"; + + return std::nullopt; +} + +std::string +AudioTranscodeResource::getUrlForUser(Database::IdType trackId, Database::User::pointer user) const +{ + std::string computedUrl {url() + "&trackid=" + std::to_string(trackId)}; + + computedUrl += "&format=" + std::to_string(static_cast(user->getAudioTranscodeFormat())); + computedUrl += "&bitrate=" + std::to_string(LmsApp->getUser()->getAudioTranscodeBitrate()); + + return computedUrl; +} + +template +std::optional +readParameterAs(const Wt::Http::Request& request, const std::string& parameterName) +{ + auto paramStr {request.getParameter(parameterName)}; + if (!paramStr) + { + LOG(DEBUG) << "Missing parameter '" << parameterName << "'"; + return std::nullopt; + } + + auto res {StringUtils::readAs(*paramStr)}; + if (!res) + LOG(ERROR) << "Cannot parse parameter '" << parameterName << "' from value '" << *paramStr << "'"; + + return res; +} + +void +AudioTranscodeResource::handleRequest(const Wt::Http::Request& request, + Wt::Http::Response& response) +{ + std::shared_ptr transcoder; + + // First, see if this request is for a continuation + Wt::Http::ResponseContinuation *continuation = request.continuation(); + if (continuation) + { + LOG(DEBUG) << "Continuation! " << continuation ; + transcoder = Wt::cpp17::any_cast>(continuation->data()); + } + else + { + LOG(DEBUG) << "First request: creating transcoder"; + + // mandatory parameters + auto trackId {readParameterAs(request, "trackid")}; + auto format {readParameterAs(request, "format")}; + auto bitrate {readParameterAs(request, "bitrate")}; + + if (!trackId || !format || !bitrate) + return; + + auto encoding {AudioFormatToAvEncoding(*format)}; + if (!encoding) + return; + + // optional parameter + auto offset {readParameterAs(request, "offset")}; + + std::filesystem::path trackPath; + { + // DbSession are not thread safe + Wt::WApplication::UpdateLock lock(LmsApp); + auto transaction {LmsApp->getDbSession().createSharedTransaction()}; + + const Database::Track::pointer track {Database::Track::getById(LmsApp->getDbSession(), *trackId)}; + if (!track) + { + LOG(ERROR) << "Missing track"; + return; + } + + trackPath = track->getPath(); + + if (!LmsApp->getUser()->checkBitrate(*bitrate)) + { + LOG(ERROR) << "Bitrate '" << *bitrate << "' is not allowed"; + return; + } + } + + Av::TranscodeParameters parameters {}; + parameters.stripMetadata = true; + parameters.encoding = *encoding; + parameters.bitrate = *bitrate; + parameters.offset = std::chrono::seconds {offset ? *offset : 0}; + + transcoder = std::make_shared(trackPath, parameters); + if (!transcoder->start()) + { + LOG(ERROR) << "Cannot start transcoder"; + return; + } + + LOG(DEBUG) << "Transcoder started"; + + std::string mimeType {transcoder->getOutputMimeType()}; + response.setMimeType(mimeType); + LOG(DEBUG) << "Mime type set to '" << mimeType << "'"; + + } + + if (!transcoder->isComplete()) + { + std::vector data; + data.reserve(_chunkSize); + + transcoder->process(data, _chunkSize); + + response.out().write(reinterpret_cast(&data[0]), data.size()); + LOG(DEBUG) << "Written " << data.size() << " bytes! complete = " << (transcoder->isComplete() ? "true" : "false"); + + if (!response.out()) + { + LOG(ERROR) << "Write failed!"; + } + } + + if (!transcoder->isComplete() && response.out()) + { + continuation = response.createContinuation(); + continuation->setData(transcoder); + } + else + LOG(DEBUG) << "No more data!"; +} + +} // namespace UserInterface + + diff --git a/src/lms/ui/resource/AudioTranscodeResource.hpp b/src/lms/ui/resource/AudioTranscodeResource.hpp new file mode 100644 index 00000000..fa5d2ed7 --- /dev/null +++ b/src/lms/ui/resource/AudioTranscodeResource.hpp @@ -0,0 +1,54 @@ +/* + * Copyright (C) 2015 Emeric Poupon + * + * This file is part of LMS. + * + * LMS 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. + * + * LMS 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 LMS. If not, see . + */ + +#pragma once + +#include +#include + +#include "database/Types.hpp" + +namespace Database +{ + class User; +} + +namespace UserInterface { + +class AudioTranscodeResource : public Wt::WResource +{ + public: + ~AudioTranscodeResource(); + + // Url depends on the user since settings are used in parameters + std::string getUrlForUser(Database::IdType trackId, Wt::Dbo::ptr user) const; + + void handleRequest(const Wt::Http::Request& request, + Wt::Http::Response& response); + + private: + + static constexpr std::size_t _chunkSize {262144}; +}; + +} // namespace UserInterface + + + + diff --git a/src/lms/ui/resource/ImageResource.cpp b/src/lms/ui/resource/ImageResource.cpp index 6abd1d42..03c059b9 100644 --- a/src/lms/ui/resource/ImageResource.cpp +++ b/src/lms/ui/resource/ImageResource.cpp @@ -31,6 +31,8 @@ #include "LmsApplication.hpp" +#define LOG(level) LMS_LOG(UI, level) << "Image resource: " + namespace UserInterface { ImageResource::~ImageResource() @@ -60,19 +62,30 @@ ImageResource::handleRequest(const Wt::Http::Request& request, Wt::Http::Respons // Mandatory parameter size if (!sizeStr) + { + LOG(DEBUG) << "no size provided!"; return; + } const auto size {StringUtils::readAs(*sizeStr)}; if (!size || *size > maxSize) + { + LOG(DEBUG) << "invalid size provided!"; return; + } std::vector cover; if (trackIdStr) { + LOG(DEBUG) << "Requested cover for track " << *trackIdStr << ", size = " << *size; + const auto trackId {StringUtils::readAs(*trackIdStr)}; if (!trackId) + { + LOG(DEBUG) << "track not found"; return; + } // DbSession are not thread safe { @@ -82,6 +95,8 @@ ImageResource::handleRequest(const Wt::Http::Request& request, Wt::Http::Respons } else if (releaseIdStr) { + LOG(DEBUG) << "Requested cover for release " << *releaseIdStr << ", size = " << *size; + const auto releaseId {StringUtils::readAs(*releaseIdStr)}; if (!releaseId) return; @@ -93,7 +108,10 @@ ImageResource::handleRequest(const Wt::Http::Request& request, Wt::Http::Respons } } else + { + LOG(DEBUG) << "No track or release provided"; return; + } response.setMimeType(getMimeType());