diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..26f6a86 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,49 @@ +Music Player Daemon - http://www.musicpd.org +Copyright 2003-2025 The Music Player Daemon Project + +The following people have contributed code to MPD: + + Warren Dukes + Avuton Olrich + Max Kellermann + Laszlo Ashin + Viliam Mateicka + Eric Wollesen + Thomas Jansen + Romain Bignon + David Guibert + Jochen Keil + Jeffrey Middleton + Sean McNamara + Niklas Hofer + Jim Ramsay + Guus Sliepen + J. Alexander Treuman + Eric Wong + José Anarch + Patrik Weiskircher + Nick Welch + Jonathan Neuschäfer + Anton Khirnov + Simon Kagstrom + Denis Krjuchkov + Jurgen Kramer + Jean-Francois Dockes + Yue Wang + Matthew Leon Grinshpun + Dimitris Papastamos + Florian Schlichting + François Revol + Jacob Vosmaer + Thomas Guillem + Andrew Basterfield + Bart Nagel + Christian Kröner + Christopher Zimmermann + John Regan + Joshua Wise + Ryan Walklin + Stefan Roellin + Stefano Miccoli + Steven O'Brien + Thomas Zander diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d511905 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d511905 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/LICENSES/BSD-2-Clause.txt b/LICENSES/BSD-2-Clause.txt new file mode 100644 index 0000000..5f662b3 --- /dev/null +++ b/LICENSES/BSD-2-Clause.txt @@ -0,0 +1,9 @@ +Copyright (c) + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/LICENSES/GPL-2.0-or-later.txt b/LICENSES/GPL-2.0-or-later.txt new file mode 100644 index 0000000..17cb286 --- /dev/null +++ b/LICENSES/GPL-2.0-or-later.txt @@ -0,0 +1,117 @@ +GNU GENERAL PUBLIC LICENSE +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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. + +We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. + + c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. + +3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. + +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 convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. + + one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author + + 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 2 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. + +signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice diff --git a/LICENSES/ISC.txt b/LICENSES/ISC.txt new file mode 100644 index 0000000..b9c199c --- /dev/null +++ b/LICENSES/ISC.txt @@ -0,0 +1,8 @@ +ISC License: + +Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC") +Copyright (c) 1995-2003 by Internet Software Consortium + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENSES/LGPL-2.1-only.txt b/LICENSES/LGPL-2.1-only.txt new file mode 100644 index 0000000..c9aa530 --- /dev/null +++ b/LICENSES/LGPL-2.1-only.txt @@ -0,0 +1,175 @@ +GNU LESSER GENERAL PUBLIC LICENSE + +Version 2.1, February 1999 + +Copyright (C) 1991, 1999 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] + +Preamble + +The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. + +This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. + +When we speak of free software, we are referring to freedom of use, 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 this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. + +To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. + +For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. + +We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. + +To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. + +Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. + +Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. + +When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. + +We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. + +For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. + +In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. + +Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. + +The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". + +A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. + +The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) + +"Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. + +Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. + +1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. + +You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. + +(For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. + +3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. + +Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. + +This option is useful when you wish to copy part of the code of the Library into a program that is not a library. + +4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. + +If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. + +5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. + +However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. + +When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. + +If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) + +Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. + +6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. + +You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: + + a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. + + e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. + +For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. + +It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. + +7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. + + b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. + +8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. + +9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. + +10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. + +11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. + +12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. + +13. The Free Software Foundation may publish revised and/or new versions of the Lesser 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 Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. + +14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. + +NO WARRANTY + +15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Libraries + +If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). + +To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. + + one line to give the library's name and an idea of what it does. + Copyright (C) year name of author + + This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. + + This library 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 Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: + +Yoyodyne, Inc., hereby disclaims all copyright interest in +the library `Frob' (a library for tweaking knobs) written +by James Random Hacker. + +signature of Ty Coon, 1 April 1990 +Ty Coon, President of Vice +That's all there is to it! diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..e08e9fc --- /dev/null +++ b/NEWS @@ -0,0 +1,2906 @@ +ver 0.25 (not yet released) +* protocol + - implement "window" parameter for command "list" +* output + - pipewire: add option "reconnect_stream" +* switch to C++23 +* require Meson 1.2 + +ver 0.24.5 (not yet released) + +ver 0.24.4 (2025/05/20) +* protocol + - fix stuck "getfingerprint" with io_uring +* decoder + - mpg123: support Icy stream tags + - mpg123: use libid3tag to parse stream tags +* tags + - id3: fix assertion failure with broken AIFF/RIFF ID3 chunks +* output + - fix resuming playback after it was paused by "single" mode + - alsa: fix compiler warning with alsa-lib 1.2.14 + +ver 0.24.3 (2025/04/09) +* input + - qobuz: use nlohmann_json instead of yajl +* playlist + - soundcloud: remove defunct plugin +* decoder + - ffmpeg: support WMA + - mpg123: fix trailing space in tag values +* tags + - libid3tag: fix Meson subproject configure error + - libid3tag: add missing zlib dependency to Meson subproject +* output + - oss: fix error "Resource temporarily unavailable" + - shout: fix hang on activating shout output + - snapcast: use nlohmann_json instead of yajl to generate JSON tags +* Linux + - allow using io_uring on Linux kernels older than 6.0 +* Windows + - fix cross build on Linux when WINE is not installed +* DSD: support channel conversion + +ver 0.24.2 (2025/03/26) +* input + - io_uring: fix stuck seek after I/O error +* decoder + - flac: enable chained Ogg decoding +* player + - fix stalled playback after queue modification + - fix deadlock with "single" mode +* Linux: fix build failure with ancient kernel headers + +ver 0.24.1 (2025/03/21) +* input + - curl: fix malformed "Range" header +* output + - sndio: fix rounding error in volume calculation +* log: include year in time stamp +* Linux + - add configure-time check for openat2() + - fix use-after-free bug on io_uring shutdown +* macOS + - implement standard directories + - fix command-line parser errors +* fix build failure in the "id3tag" Meson subproject +* doc: use "sphinx_rtd_theme" only if it is installed + +ver 0.24 (2025/03/11) +* protocol + - new command "searchcount" (case-insensitive "count") + - "playlistfind"/"playlistsearch" have "sort" and "window" parameters + - allow range in "playlistmove" + - "save" can append to or replace an existing playlist + - filter "prio" (for "playlistfind"/"playlistsearch") + - limit "player" idle events to the current partition + - operator "starts_with" + - show PCRE support in "config" response + - apply Unicode normalization to case-insensitive filter expressions + - stickers on playlists and some tag types + - new commands "stickernames", "stickertypes", "stickernamestypes", "playlistlength", "searchplaylist", "protocol" + - new "search"/"find" filter "added-since" + - allow range in listplaylist and listplaylistinfo + - "sticker find" supports sort and window parameter and new sticker compare operators "eq", "lt", "gt", "contains" and "starts_with" + - consume only idle flags that were subscribed to + - volume command is no longer deprecated + - new "available" and "reset" subcommands for tagtypes + - searching stored playlists respond now with song position + - new sticker subcommand "inc" and "dec" +* database + - attribute "added" shows when each song was added to the database + - proxy: require MPD 0.21 or later + - proxy: require libmpdclient 2.15 or later +* archive + - add option to disable archive plugins in mpd.conf +* storage + - curl: optimize database update + - nfs: require libnfs 4.0 or later + - nfs: support libnfs 6 (API version 2) + - nfs: support libnfs URL arguments +* input + - alsa: limit ALSA buffer time to 2 seconds + - alsa: set up a channel map + - alsa: support the alsa-lib 1.2.11 API + - alsa: add option "close_on_pause" + - curl: add "connect_timeout" configuration +* decoder + - ffmpeg: require FFmpeg 4.0 or later + - ffmpeg: query supported demuxers at runtime + - hybrid_dsd: remove + - mpg123: prefer over "mad" + - mpg123: support streaming + - opus: implement bitrate calculation + - sidplay: require libsidplayfp (drop support for the original sidplay) + - wavpack: require libwavpack version 5 + - fix MixRamp bug +* resampler + - soxr: require libsoxr 0.1.2 or later +* player + - add option "mixramp_analyzer" to scan MixRamp tags on-the-fly + - "one-shot" consume mode +* tags + - new tags "TitleSort", "Mood", "ShowMovement" +* output + - add option "always_off" + - alsa: require alsa-lib 1.1 or later + - pipewire: map tags "Date" and "Comment" +* switch to C++20 + - GCC 12 or clang 14 (or newer) recommended +* static partition configuration +* Windows + - build with libsamplerate + - remove JACK DLL support +* remove Haiku support +* remove Boost dependency +* require libfmt 9 or later +* documentation: switch to sphinx-rtd-theme +* require Meson 1.0 + +ver 0.23.17 (2025/01/29) +* protocol + - "albumart" tries to send larger chunks if available + - explicitly disallow "idle" and "noidle" in command lists +* storage + - nfs: require libnfs 4.0 or later +* database + - inotify: trigger update after symlink was created +* decoder + - ffmpeg: prefer over sndfile and audiofile for its DTS-WAV support +* support libfmt 11.1 + +ver 0.23.16 (2024/12/03) +* database + - fix integer overflows with 64-bit inode numbers +* filter + - ffmpeg: fix for filters producing no output +* support libfmt 11 +* support ICU 76 + +ver 0.23.15 (2023/12/20) +* decoder + - ffmpeg: fix build failure with FFmpeg 6.1 +* output + - alsa: limit buffer time to 2 seconds + +ver 0.23.14 (2023/10/08) +* decoder + - flac: fix scanning files with non-ASCII names on Windows + - mad: fix calculation of LAME peak values +* mixer + - wasapi: fix problem setting volume +* more libfmt 10 fixes +* fix auto-detected systemd unit directory +* Android + - require Android 7 or newer + +ver 0.23.13 (2023/05/22) +* input + - curl: fix busy loop after connection failed + - curl: hide "404" log messages for non-existent ".mpdignore" files +* archive + - zzip: fix crash bug +* database + - simple: reveal hidden songs after deleting containing CUE +* decoder + - ffmpeg: reorder to a lower priority than "gme" + - gme: require GME 0.6 or later +* output + - pipewire: fix corruption bug due to missing lock +* Linux + - shut down if parent process dies in --no-daemon mode + - determine systemd unit directories via pkg-config +* support libfmt 10 + +ver 0.23.12 (2023/01/17) +* input + - curl: require CURL 7.55.0 or later +* decoder + - mad: fix integer underflow with very small files +* tags + - fix crash bug due to race condition +* output + - pipewire: adjust to PipeWire 0.3.64 API change +* fix build failures with GCC 13 + +ver 0.23.11 (2022/11/28) +* database + - simple: move default database to ~/.cache/mpd/db from ~/.cache/mpd.db + - simple: default "cache_directory" to ~/.cache/mpd/mounts +* macOS: fix build failure "no archive members specified" +* Windows + - fix crash bug (stack buffer overflow) after I/O errors + - fix path traversal bug because backslash was allowed in playlist names +* Android/Windows + - update OpenSSL to 3.0.7 + - re-enable CURL's verbose error strings + +ver 0.23.10 (2022/10/14) +* storage + - curl: fix file time stamps +* decoder + - ffmpeg: fix libfmt 9 compiler warning +* encoder + - flac: fix failure when libFLAC is built without Ogg support +* output + - alsa: fix crash bug +* Windows + - log to stdout by default, don't require "log_file" setting + +ver 0.23.9 (2022/08/18) +* input + - cdio_paranoia: add options "mode" and "skip" +* decoder + - ffmpeg: support FFmpeg 5.1 +* filter + - replay gain: fix delayed volume display with handler=mixer +* output + - pipewire: set app icon +* fix bogus volume levels with multiple partitions +* improve iconv detection +* macOS: fix macOS 10 build problem (0.23.8 regression) +* Android + - load mpd.conf from app data directory + +ver 0.23.8 (2022/07/09) +* storage + - curl: fix crash if web server does not understand WebDAV +* input + - cdio_paranoia: fix crash if no drive was found + - cdio_paranoia: faster cancellation + - cdio_paranoia: don't scan for replay gain tags + - pipewire: fix playback of very short tracks + - pipewire: drop all buffers before manual song change + - pipewire: fix stuttering after manual song change + - snapcast: fix busy loop while paused + - snapcast: fix stuttering after resuming playback +* mixer + - better error messages + - alsa: fix setting volume before playback starts + - pipewire: fix crash bug + - pipewire: fix volume change events with PipeWire 0.3.53 + - pipewire: don't force initial volume=100% +* support libfmt 9 + +ver 0.23.7 (2022/05/09) +* database + - upnp: support pupnp 1.14 +* decoder + - ffmpeg: fix HLS seeking + - opus: fix missing song length on high-latency files +* output + - shout: require at least libshout 2.4.0 +* mixer + - pipewire: fix volume restore + - software: update volume of disabled outputs +* support libiconv + +ver 0.23.6 (2022/03/14) +* protocol + - support filename "cover.webp" for "albumart" command + - support "readcomments" and "readpicture" on CUE tracks +* decoder + - ffmpeg: fix end-of-file check (update stuck at empty files) + - opus: fix "readpicture" on Opus files +* output + - pipewire: fix crash bug if setting volume before playback starts + - wasapi: fix resume after pause + +ver 0.23.5 (2021/12/01) +* protocol + - support relative offsets for "searchadd" + - fix "searchaddpl" bug (bogus error "Bad position") +* database + - upnp: fix crash bug +* tags + - fix MixRamp support +* migrate to PCRE2 +* GCC 12 build fixes + +ver 0.23.4 (2021/11/11) +* protocol + - add optional position parameter to "searchaddpl" +* decoder + - ffmpeg: support libavcodec 59 +* output + - alsa: add option "thesycon_dsd_workaround" to work around device bug +* fix crash on debug builds if startup fails +* systemd + - remove "RuntimeDirectory" directive because it caused problems + - ignore the "pid_file" setting if started as systemd service +* Windows + - enable the "openmpt" decoder plugin + +ver 0.23.3 (2021/10/31) +* protocol + - add optional position parameter to "add" and "playlistadd" + - allow range in "playlistdelete" +* database + - fix scanning files with question mark in the name + - inotify: fix use-after-free bug +* output + - alsa: add option "stop_dsd_silence" to work around DSD DAC noise +* macOS: fix libfmt related build failure +* systemd: add "RuntimeDirectory" directive + +ver 0.23.2 (2021/10/22) +* protocol + - fix "albumart" timeout bug +* input + - nfs: fix playback bug +* output + - pipewire: send artist and title to PipeWire + - pipewire: DSD support +* neighbor + - mention failed plugin name in error message +* player + - fix cross-fade regression +* fix crash with libfmt versions older than 7 + +ver 0.23.1 (2021/10/19) +* protocol + - use decimal notation instead of scientific notation + - "load" supports relative positions +* output + - emit "mixer" idle event when replay gain changes volume + - pipewire: emit "mixer" idle events on external volume change + - pipewire: attempt to change the graph sample rate + - snapcast: fix time stamp bug which caused "Failed to get chunk" +* fix libfmt linker problems +* fix broken password authentication + +ver 0.23 (2021/10/14) +* protocol + - new command "getvol" + - show the audio format in "playlistinfo" + - support "listfiles" with arbitrary storage plugins + - support relative positions in "addid" + - fix relative positions in "move" and "moveid" + - add "position" parameter to "findadd" and "searchadd" + - add position parameter to "load" +* database + - proxy: require MPD 0.20 or later + - proxy: require libmpdclient 2.11 or later + - proxy: split search into chunks to avoid exceeding the output buffer + - simple: add option to hide CUE target songs + - upnp: support libnpupnp instead of libupnp +* archive + - zzip, iso9660: ignore file names which are invalid UTF-8 +* decoder + - openmpt: new plugin + - wavpack: fix WVC file support +* player + - do not cross-fade songs shorter than 20 seconds +* output + - oss: support DSD over PCM + - pipewire: new plugin + - snapcast: new plugin +* tags + - new tags "ComposerSort", "Ensemble", "Movement", "MovementNumber", and "Location" +* split permission "player" from "control" +* add option "host_permissions" +* new build-time dependency: libfmt + +ver 0.22.11 (2021/08/24) +* protocol + - fix "albumart" crash +* filter + - ffmpeg: pass "channel_layout" instead of "channels" to buffersrc + - ffmpeg: fix "av_buffersink_get_frame() failed: Resource temporarily unavailable" + - ffmpeg: support double-precision samples (by converting to single precision) +* Android + - build with NDK r23 + - playlist_directory defaults to "/sdcard/Android/data/org.musicpd/files/playlists" + +ver 0.22.10 (2021/08/06) +* protocol + - support "albumart" for virtual tracks in CUE sheets +* database + - simple: fix crash bug + - simple: fix absolute paths in CUE "as_directory" entries + - simple: prune CUE entries from database for non-existent songs +* input + - curl: fix crash bug after stream with Icy metadata was closed by peer + - tidal: remove defunct unmaintained plugin +* tags + - fix crash caused by bug in TagBuilder and a few potential reference leaks +* output + - httpd: fix missing tag after seeking into a new song + - oss: fix channel order of multi-channel files +* mixer + - alsa: fix yet more rounding errors + +ver 0.22.9 (2021/06/23) +* database + - simple: load all .mpdignore files of all parent directories +* tags + - fix "readcomments" and "readpicture" on remote files with ID3 tags +* decoder + - ffmpeg: support the tags "sort_album", "album-sort", "artist-sort" + - ffmpeg: fix build failure with FFmpeg 3.4 +* Android + - fix auto-start on boot in Android 8 or later +* Windows + - fix build failure with SQLite + +ver 0.22.8 (2021/05/22) +* fix crash bug in "albumart" command (0.22.7 regression) + +ver 0.22.7 (2021/05/19) +* protocol + - don't use glibc extension to parse time stamps + - optimize the "albumart" command +* input + - curl: send user/password in the first request, save one roundtrip +* decoder + - ffmpeg: fix build problem with FFmpeg 3.4 + - gme: support RSN files +* storage + - curl: don't use glibc extension +* database + - simple: fix database corruption bug +* output + - fix crash when pausing with multiple partitions + - jack: enable on Windows + - httpd: send header "Access-Control-Allow-Origin: *" + - wasapi: add algorithm for finding usable audio format + - wasapi: use default device only if none was configured + - wasapi: add DoP support + +ver 0.22.6 (2021/02/16) +* fix missing tags on songs in queue + +ver 0.22.5 (2021/02/15) +* protocol + - error for malformed ranges instead of ignoring silently + - better error message for open-ended range with "move" +* database + - simple: fix missing CUE sheet metadata in "addid" command +* tags + - id: translate TPE3 to Conductor, not Performer +* archive + - iso9660: another fix for unaligned reads +* output + - httpd: error handling on Windows improved + - pulse: fix deadlock with "always_on" +* Windows: + - enable https:// support (via Schannel) +* Android + - work around "Permission denied" on mpd.conf + +ver 0.22.4 (2021/01/21) +* protocol + - add command "binarylimit" to allow larger chunk sizes + - fix "readpicture" on 32 bit machines + - show duration and tags of songs in virtual playlist (CUE) folders +* storage + - curl: fix several WebDAV protocol bugs +* decoder + - dsdiff: apply padding to odd-sized chunks +* filter + - ffmpeg: detect the output sample format +* output + - moveoutput: fix always_on and tag lost on move +* Android + - enable https:// support (via OpenSSL) + +ver 0.22.3 (2020/11/06) +* playlist + - add option "as_directory", making CUE file expansion optional +* storage + - curl: fix crash bug +* filter + - fix garbage after "Audio format not supported by filter" message + - ffmpeg: support planar output + - ffmpeg: support sample formats other than 16 bit + +ver 0.22.2 (2020/10/28) +* database + - simple: purge songs and virtual directories for unavailable plugins + on update +* input + - qobuz/tidal: fix protocol errors due to newlines in error messages + - smbclient: disable by default due to libsmbclient crash bug +* playlist + - soundcloud: fix protocol errors due to newlines in error messages +* state_file: save on shutdown + +ver 0.22.1 (2020/10/17) +* decoder + - opus: apply the OpusHead output gain even if there is no EBU R128 tag + - opus: fix track/album ReplayGain fallback +* output + - alsa: don't deadlock when the ALSA driver is buggy + - jack, pulse: reduce the delay when stopping or pausing playback +* playlist + - cue: fix two crash bugs +* state_file: fix the state_file_interval setting + +ver 0.22 (2020/09/23) +* protocol + - "findadd"/"searchadd"/"searchaddpl" support the "sort" and + "window" parameters + - add command "readpicture" to download embedded pictures + - command "moveoutput" moves an output between partitions + - command "delpartition" deletes a partition + - show partition name in "status" response +* tags + - new tags "Grouping" (for ID3 "TIT1"), "Work" and "Conductor" +* input + - curl: support "charset" parameter in URI fragment + - ffmpeg: allow partial reads + - io_uring: new plugin for local files on Linux (using liburing) + - smbclient: close unused SMB/CIFS connections +* database + - upnp: drop support for libupnp versions older than 1.8 +* playlist + - cue: integrate contents in database +* decoder + - ffmpeg: support RTSP + - mad: remove option "gapless", always do gapless + - sidplay: add option "default_genre" + - sidplay: map SID name field to "Album" tag + - sidplay: add support for new song length format with libsidplayfp 2.0 + - vorbis, opus: improve seeking accuracy +* playlist + - flac: support reading CUE sheets from remote FLAC files +* filter + - ffmpeg: new plugin based on FFmpeg's libavfilter library + - hdcd: new plugin based on FFmpeg's "af_hdcd" for HDCD playback + - volume: convert S16 to S24 to preserve quality and reduce dithering noise + - dsd: add integer-only DSD to PCM converter +* output + - jack: add option "auto_destination_ports" + - jack: report error details + - pulse: add option "media_role" + - solaris: support S8 and S32 +* lower the real-time priority from 50 to 40 +* switch to C++17 + - GCC 8 or clang 5 (or newer) recommended + +ver 0.21.26 (2020/09/21) +* database + - inotify: obey ".mpdignore" files +* output + - osx: fix crash bug + - sles: support floating point samples +* archive + - bzip2: fix crash on corrupt bzip2 file + - bzip2: flush output at end of input file + - iso9660: fix unaligned reads + - iso9660: support seeking + - zzip: fix crash on corrupt ZIP file +* decoder + - ffmpeg: remove "rtsp://" from the list of supported protocols + - ffmpeg: add "hls+http://" to the list of supported protocols + - opus: support the gain value from the Opus header + - sndfile: fix lost samples at end of file +* fix "single" mode bug after resuming playback +* the default log_level is "default", not "info" + +ver 0.21.25 (2020/07/06) +* protocol: + - fix crash when using "rangeid" while playing +* database + - simple: automatically scan new mounts + - upnp: fix compatibility with Plex DLNA +* storage + - fix disappearing mounts after mounting twice + - udisks: fix reading ".mpdignore" +* input + - file: detect premature end of file + - smbclient: don't send credentials to MPD clients +* decoder + - opus: apply pre-skip and end trimming + - opus: fix memory leak + - opus: fix crash bug + - vorbis: fix crash bug +* output + - osx: improve sample rate selection + - osx: fix noise while stopping +* neighbor + - upnp: fix crash during shutdown +* Windows/Android: + - fix Boost detection after breaking change in Meson 0.54 + +ver 0.21.24 (2020/06/10) +* protocol + - "tagtypes" requires no permissions +* database + - simple: fix crash when mounting twice +* decoder + - modplug: fix Windows build failure + - wildmidi: attempt to detect WildMidi using pkg-config + - wildmidi: fix Windows build failure +* player + - don't restart current song if seeking beyond end +* Android + - enable the decoder plugins GME, ModPlug and WildMidi + - fix build failure with Android NDK r21 +* Windows + - fix stream playback + - enable the decoder plugins GME, ModPlug and WildMidi + - work around Meson bug breaking the Windows build with GCC 10 +* fix unit test failure + +ver 0.21.23 (2020/04/23) +* protocol + - add tag fallback for AlbumSort +* storage + - curl: fix corrupt "href" values in the presence of XML entities + - curl: unescape "href" values +* input + - nfs: fix crash bug + - nfs: fix freeze bug on reconnect +* decoder + - gme: adapt to API change in the upcoming version 0.7.0 +* output + - alsa: implement channel mapping for 5.0 and 7.0 +* player + - drain outputs at end of song in "single" mode +* Windows + - fix case insensitive search + +ver 0.21.22 (2020/04/02) +* database + - simple: optimize startup +* input + - curl: fix streaming errors on Android +* playlist + - rss: support MIME type application/xml +* mixer + - android: new mixer plugin for "sles" output +* Android + - TV support +* Windows + - fix time zone offset check +* fix build failures with uClibc-ng + +ver 0.21.21 (2020/03/19) +* configuration + - fix bug in "metadata_to_use" setting +* playlist + - asx, xspf: fix corrupt tags in the presence of XML entities +* archive + - iso9660: skip empty file names to work around libcdio bug +* decoder + - gme: ignore empty tags +* output + - solaris: port to NetBSD +* raise default "max_connections" value to 100 + +ver 0.21.20 (2020/02/16) +* decoder + - audiofile, ffmpeg, sndfile: handle MIME type "audio/wav" + - ffmpeg: fix playback of AIFF and TTA + - vorbis, opus: fix seeking in small files +* fix backwards seeking on ARM (and other non-x86 CPUs) + +ver 0.21.19 (2020/01/17) +* configuration + - allow overriding top-level settings in includes +* output + - pulse: obey Pulse's maximum sample rate (fixes DSD128 playback) +* fix build failure with clang 10 +* fix build failure with Android NDK r20 + +ver 0.21.18 (2019/12/24) +* protocol + - work around Mac OS X bug in the ISO 8601 parser +* output + - alsa: fix hang bug with ALSA "null" outputs +* storage + - curl: fix crash bug +* drop support for CURL versions older than 7.32.0 +* reduce unnecessary CPU wakeups + +ver 0.21.17 (2019/12/16) +* protocol + - relax the ISO 8601 parser: allow omitting field separators, the + time of day and the "Z" suffix +* archive + - zzip: improve error reporting +* outputs + - jack: mark ports as terminal + - shout: declare metadata as UTF-8 +* fix build failure with -Ddatabase=false + +ver 0.21.16 (2019/10/16) +* queue + - fix relative destination offset when moving a range +* storage + - curl: request the "resourcetype" property to fix database update + - curl: URL-encode more paths + - curl: follow redirects for collections without trailing slash +* update + - fix crash when music_directory is not a directory +* fix build with iconv() instead of ICU + +ver 0.21.15 (2019/09/25) +* decoder + - dsdiff, dsf: fix displayed bit rate + - mpcdec: fix bogus ReplayGain values +* output + - solaris: fix build with glibc 2.30 + +ver 0.21.14 (2019/08/21) +* decoder + - sidplay: show track durations in database + - sidplay: convert tag values from Windows-1252 charset + - sidplay: strip text from "Date" tag +* player + - fix crash after song change + - fix seek position after restarting the decoder +* protocol + - include command name in error responses + +ver 0.21.13 (2019/08/06) +* input + - cdio_paranoia: require libcdio-paranoia 10.2+0.93+1 +* decoder + - mad: fix crackling sound (0.21.12 regression) +* output + - jack: improved Windows compatibility + +ver 0.21.12 (2019/08/03) +* decoder + - mad: update bit rate after seeking + - mad: fix several bugs preventing the plugin from decoding the last frame + - opus: ignore case in replay gain tag names + - opus, vorbis: decode the "end of stream" packet +* output + - jack: fix mono-to-stereo conversion +* player + - don't restart unseekable song after failed seek attempt +* Windows + - support backslash in relative URIs loaded from playlists + +ver 0.21.11 (2019/07/03) +* input + - tidal: deprecated because Tidal has changed the protocol +* decoder + - wildmidi: log error if library initialization fails +* output + - alsa: fix busy loop while draining + - alsa: fix missing drain call + - alsa: improve xrun-avoiding silence generator + - alsa: log when generating silence due to slow decoder + - alsa, osx: fix distortions with DSD_U32 and DoP on 32 bit CPUs +* protocol + - fix "list" with multiple "group" levels + +ver 0.21.10 (2019/06/05) +* decoder + - opus: fix duplicate tags +* output + - httpd: reject some well-known URIs +* fix crash bug (0.21.9 regression) + +ver 0.21.9 (2019/05/20) +* input + - buffer: fix deadlock bug +* Android + - fix crash on ARMv7 + - request storage permission on Android 6+ +* fix spurious "single" mode bug + +ver 0.21.8 (2019/04/23) +* input + - smbclient: download to buffer instead of throttling transfer +* output + - httpd: add missing mutex lock + - httpd: fix use-after-free bug +* playlist + - soundcloud: fix "Unsupported URI scheme" (0.21.6 regression) +* fix Bonjour bug +* fix build failure with GCC 9 +* fix build failure with -Ddatabase=false +* systemd: add user socket unit +* doc: "list file" is deprecated + +ver 0.21.7 (2019/04/03) +* input + - qobuz/tidal: scan tags when loading a playlist +* require Meson 0.49.0 for native libgcrypt-config support +* fix build failure with -Dlocal_socket=false +* Haiku + - fix build + - add version info + +ver 0.21.6 (2019/03/17) +* protocol + - allow loading playlists specified as absolute filesystem paths + - fix negated filter expressions with multiple tag values + - fix "list" with filter expression + - omit empty playlist names in "listplaylists" +* input + - cdio_paranoia: fix build failure due to missing #include +* decoder + - opus: fix replay gain when there are no other tags + - opus: fix seeking to beginning of song + - vorbis: fix Tremor conflict resulting in crash +* output + - pulse: work around error with unusual channel count + - osx: fix build failure +* playlist + - flac: fix use-after-free bug +* support abstract sockets on Linux +* Windows + - remove the unused libwinpthread-1.dll dependency +* Android + - enable SLES power saving mode + +ver 0.21.5 (2019/02/22) +* protocol + - fix deadlock in "albumart" command + - fix "tagtypes disable" command +* database + - simple: fix assertion failure + - fix assertion failures with mount points +* storage + - udisks: fix "AlreadyMounted" error + - udisks: use relative path from mount URI + - fix memory leak +* input + - buffer: fix crash bug when playing remote WAV file +* tags + - ape: map "Album Artist" +* output + - shout: add support for TLS +* mixer + - pulse: add "scale_volume" setting + +ver 0.21.4 (2019/01/04) +* database + - inotify: fix crash bug "terminate called after throwing ..." + - upnp: implement "list ... group" +* output + - httpd: declare protocol "HTTP/1.1" instead of "ICY" +* remove libwrap support +* Windows + - fix "Failed to accept connection: unknown error" +* fix Haiku build + +ver 0.21.3 (2018/11/16) +* output + - alsa: fix crash bug + - alsa: fix stuttering at start of playback + - alsa: fix discarded samples at end of song + - alsa: clear error after reopening device +* log: default to journal if MPD was started as systemd service + +ver 0.21.2 (2018/11/12) +* protocol + - operator "=~" matches a regular expression + - operator "contains" matches substrings +* decoder + - ffmpeg: require FFmpeg 3.1 or later + - ffmpeg: fix broken sound with certain codecs +* output + - alsa: fix high CPU usage with dmix + - httpd: fix three crash bugs +* mixer + - alsa: fix more rounding errors +* fix zlib support + +ver 0.21.1 (2018/11/04) +* protocol + - allow escaping quotes in filter expressions + - operator "==" never searches substrings in filter expressions +* decoder + - ffmpeg: fix build failure with non-standard FFmpeg installation path + - flac: fix linker failure when building without FLAC support +* encoder + - vorbis: fix linker failure when building without Vorbis decoder +* fix build failure on Linux-PowerPC +* fix build failure on FreeBSD +* eliminate DLL dependencies on Windows +* add warning about buggy Boost version 1.67 +* require Meson 0.47.2 because a Meson 0.47.1 bug breaks our build + +ver 0.21 (2018/10/31) +* configuration + - add "include" directive, allows including config files + - incremental "metadata_to_use" setting +* protocol + - "tagtypes" can be used to hide tags + - "find" and "search" can sort + - "outputs" prints the plugin name + - "outputset" sets runtime attributes + - close connection when client sends HTTP request + - new filter syntax for "find"/"search" etc. with negation +* database + - simple: scan audio formats + - proxy: require libmpdclient 2.9 + - proxy: forward `sort` and `window` to server +* player + - hard-code "buffer_before_play" to 1 second, independent of audio format + - "one-shot" single mode +* input + - curl: download to buffer instead of throttling transfer + - qobuz: new plugin to play Qobuz streams + - tidal: new plugin to play Tidal streams +* tags + - new tags "OriginalDate", "MUSICBRAINZ_WORKID" +* decoder + - ffmpeg: require at least version 11.12 + - gme: try loading m3u sidecar files + - hybrid_dsd: new decoder plugin + - mad: move "gapless_mp3_playback" setting to "decoder" block + - mikmod: require at least version 3.2 + - pcm: support audio/L24 (RFC 3190) + - sidplay: support basic and kernal rom (libsidplayfp) +* resampler + - soxr: flush resampler at end of song +* output + - alsa: non-blocking mode + - alsa: change "dop" and "allowed_formats" settings at runtime + - ao: fix crash bug due to partial frames + - shout: support the Shine encoder plugin + - sndio: remove support for the broken RoarAudio sndio emulation + - osx: initial support for DSD over PCM + - roar: removed + - httpd_output: support for unix sockets +* mixer + - sndio: new mixer plugin +* encoder + - opus: support for sending metadata using ogg stream chaining +* listen on $XDG_RUNTIME_DIR/mpd/socket by default +* append hostname to Zeroconf service name +* systemd watchdog support +* require GCC 6 +* build with Meson instead of autotools +* use GTest instead of cppunit + +ver 0.20.23 (2018/10/29) +* protocol + - emit "player" idle event when restarting the current song +* fix broken float to s32 conversion +* new clang crash bug workaround + +ver 0.20.22 (2018/10/23) +* protocol + - add tag fallbacks for AlbumArtistSort, ArtistSort + - fix empty string filter on fallback tags + - "count group ..." can print an empty group + - fix broken command "list ... group" +* storage + - curl: URL-encode paths +* decoder + - fluidsynth: adapt to API change in version 2.0 +* Android + - now runs as a service + - add button to start/stop MPD + - add option to auto-start on boot +* work around clang bug leading to crash +* install the SVG icon + +ver 0.20.21 (2018/08/17) +* database + - proxy: add "password" setting + - proxy: support tags "ArtistSort", "AlbumArtistSort", "AlbumSort" + - simple: allow .mpdignore comments only at start of line +* output + - httpd: remove broken DLNA support code +* playlist + - cue: support file type declaration "FLAC" (non-standard) +* URI schemes are case insensitive +* Android, Windows + - enable the "curl" storage plugin + +ver 0.20.20 (2018/05/22) +* protocol + - fix "modified-since" filter regression +* output + - pulse: cork stream when paused due to "single" mode +* decoder + - dsdiff, dsf: support more MIME types + - dsdiff, dsf: allow 4 MB ID3 tags + - opus: support R128_ALBUM_GAIN tag +* Android, Windows + - enable the "proxy" database plugin + +ver 0.20.19 (2018/04/26) +* protocol + - validate absolute seek time, reject negative values +* database + - proxy: fix "search already in progress" errors + - proxy: implement "list ... group" +* input + - mms: fix lockup bug and a crash bug +* decoder + - ffmpeg: fix av_register_all() deprecation warning (FFmpeg 4.0) +* player + - fix spurious "Not seekable" error when switching radio streams +* macOS: fix crash bug + +ver 0.20.18 (2018/02/24) +* input + - curl: allow authentication methods other than "Basic" +* decoder + - flac: improve seeking precision +* fix gapless CUE song transitions +* Android, Windows + - enable the NFS storage plugin + +ver 0.20.17 (2018/02/11) +* output + - alsa: fix crash bug with 8 channels +* mixer + - alsa: fix rounding error at volume 0 +* fix real-time and idle scheduling with Musl +* Android + - fix compatibility with Android 4.0 + +ver 0.20.16 (2018/02/03) +* output + - pulse: fix crash during auto-detection +* database + - simple: fix search within mount points + - upnp: enable IPv6 +* archive + - iso9660: libcdio 2.0 compatibility +* fix crash in debug build on Haiku and other operating systems + +ver 0.20.15 (2018/01/05) +* queue: fix crash after seek failure +* resampler + - soxr: clear internal state after manual song change +* state file + - make mount point restore errors non-fatal + - fix crash when restoring mounts with incompatible database plugin +* Android + - build without Ant + - fix for SIGSYS crash + +ver 0.20.14 (2018/01/01) +* database + - simple: fix file corruption in the presence of mount points +* archive + - bz2: fix deadlock + - reduce lock contention, fixing lots of xrun problems +* fix Solaris build failure + +ver 0.20.13 (2017/12/18) +* output + - osx: set up ring buffer to hold at least 100ms +* mixer + - alsa: fix rounding errors +* database + - simple: don't purge mount points on update/rescan + - simple: fix "mount" bug caused by bad compiler optimization + - simple: fix "lsinfo" into mount points + - upnp: work around libupnp 1.6.24 API breakage +* queue: fix spuriously misplaced prioritized songs +* save and restore mountpoints within the state file +* include Windows cross-build script in source tarball +* fix Windows build failures + +ver 0.20.12 (2017/11/25) +* database + - upnp: adapt to libupnp 1.8 API changes +* input + - cdio_paranoia, ffmpeg, file, smbclient: reduce lock contention, + fixing lots of xrun problems + - curl: fix seeking +* decoder + - ffmpeg: fix GCC 8 warning + - vorbis: fix Tremor support +* player + - log message when decoder is too slow +* encoder + - vorbis: default to quality 3 +* output + - fix hanging playback with soxr resampler + - httpd: flush encoder after tag; fixes corrupt Vorbis stream + +ver 0.20.11 (2017/10/18) +* storage + - curl: support Content-Type application/xml +* decoder + - ffmpeg: more reliable song duration + - gme: fix track numbering +* improve random song order when switching songs manually +* fix case insensitive search without libicu +* fix Unicode file names in playlists on Windows +* fix endless loop when accessing malformed file names in ZIP files + +ver 0.20.10 (2017/08/24) +* decoder + - ffmpeg: support MusicBrainz ID3v2 tags +* tags + - aiff: fix FORM chunk size endianness (is big-endian) +* mixer + - osx: add a mixer for OSX. +* fix crash when resuming playback before decoder is ready +* fix crash on Windows + +ver 0.20.9 (2017/06/04) +* decoder + - ffmpeg: support *.adx +* fix byte order detection on FreeBSD/aarch64 +* fix more random crashes when compiled with clang + +ver 0.20.8 (2017/05/19) +* output + - osx: fix build failure due to missing "noexcept" +* playlist + - m3u: support MIME type `audio/mpegurl` +* fix build failure with GCC 4.x + +ver 0.20.7 (2017/05/15) +* database + - simple: fix false positive directory loop detection with NFS +* enforce a reasonable minimum audio_buffer_size setting +* cap buffer_before_play at 80% to prevent deadlock +* fix random crashes when compiled with clang + +ver 0.20.6 (2017/03/10) +* input + - curl: fix headers after HTTP redirect to Shoutcast server +* decoder + - ffmpeg: re-enable as fallback + - mpcdec: fix crash (division by zero) after seeking + - sidplay: make compatible with libsidplayfp < 1.8 +* fix stream tags after automatic song change +* workaround for GCC 4.9.4 / libstdc++ bug (build failure) + +ver 0.20.5 (2017/02/20) +* tags + - id3: fix memory leak on corrupt ID3 tags +* decoder + - sidplay: don't require libsidutils when building with libsidplayfp +* output + - httpd: fix two buffer overflows in IcyMetaData length calculation +* mixer + - alsa: fix crash bug + +ver 0.20.4 (2017/02/01) +* input + - nfs: fix freeze after reconnect +* output + - sndio: work around a libroar C++ incompatibility +* workaround for GCC 4.9 "constexpr" bug +* fix FreeBSD build failure + +ver 0.20.3 (2017/01/25) +* protocol + - "playlistadd" creates new playlist if it does not exist, as documented +* database + - proxy: fix error "terminate called after throwing ..." + - proxy: make connect errors during startup non-fatal +* neighbor + - upnp: fix premature expiry +* replay gain: don't reset ReplayGain levels when unpausing playback +* silence surround channels when converting from stereo +* use shortcuts such as "dsd64" in log messages + +ver 0.20.2 (2017/01/15) +* input + - alsa: fix crash bug + - alsa: fix buffer overruns +* decoder + - flac: add options "probesize" and "analyzeduration" +* resampler + - libsamplerate: reset state after seeking +* output + - fix static noise after changing to a different audio format + - alsa: fix the DSD_U32 sample rate + - alsa: fix the DSD_U32 byte order + - alsa: support DSD_U16 + - recorder: fix error "Failed to create : No such file or directory" +* playlist + - cue: fix skipping songs + +ver 0.20.1 (2017/01/09) +* input + - curl: fix crash bug + - curl: fix freeze bug +* decoder + - wavpack: fix crash bug +* storage + - curl: new storage plugin for WebDAV (work in progress) +* mixer + - alsa: normalize displayed volume according to human perception +* fix crash with volume_normalization enabled + +ver 0.20 (2017/01/04) +* protocol + - "commands" returns playlist commands only if playlist_directory configured + - "search"/"find" have a "window" parameter + - report song duration with milliseconds precision + - "sticker find" can match sticker values + - drop the "file:///" prefix for absolute file paths + - add range parameter to command "plchanges" and "plchangesposid" + - send verbose error message to client +* input + - curl: fix memory leak +* tags + - ape, ogg: drop support for non-standard tag "album artist" + affected filetypes: vorbis, flac, opus & all files with ape2 tags + (most importantly some mp3s) + - id3: remove the "id3v1_encoding" setting; by definition, all ID3v1 tags + are ISO-Latin-1 + - ape: support APE replay gain on remote files + - read ID3 tags from NFS/SMB +* decoder + - improved error logging + - report I/O errors to clients + - ffmpeg: support ReplayGain and MixRamp + - ffmpeg: support stream tags + - gme: add option "accuracy" + - gme: provide the TRACK tag + - gme: faster scanning + - mad: reduce memory usage while scanning tags + - mpcdec: read the bit rate + - pcm: support audio/L16 (RFC 2586) and audio/x-mpd-float + - sidplay: faster scanning + - wavpack: large file support + - wavpack: support DSD (WavPack 5) + - wavpack: archive support +* playlist + - cue: don't skip pregap + - embcue: fix last track + - flac: new plugin which reads the "CUESHEET" metadata block +* output + - alsa: fix multi-channel order + - alsa: remove option "use_mmap" + - alsa: support DSD_U32 + - alsa: disable DoP if it fails + - jack: reduce CPU usage + - pulse: set channel map to WAVE-EX + - recorder: record tags + - recorder: allow dynamic file names + - sndio: new output plugin +* mixer + - null: new plugin +* resampler + - new block "resampler" in configuration file + replacing the old "samplerate_converter" setting + - soxr: allow multi-threaded resampling +* player + - reset song priority on playback + - reduce xruns +* write database and state file atomically +* always write UTF-8 to the log file. +* remove dependency on GLib +* support libsystemd (instead of the older libsystemd-daemon) +* database + - proxy: add TCP keepalive option +* update + - apply .mpdignore matches to subdirectories +* switch the code base to C++14 + - GCC 4.9 or clang 3.4 (or newer) recommended + +ver 0.19.21 (2016/12/13) +* decoder + - ffmpeg: fix crash bug +* fix unit test failure after recent "setprio" change +* systemd: add user unit + +ver 0.19.20 (2016/12/09) +* protocol + - "setprio" re-enqueues old song if priority has been raised +* decoder + - ffmpeg: ignore empty packets + - pcm: fix corruption bug with partial frames (after short read) + - sidplay: fix playback speed with libsidplayfp +* output + - winmm: fix 8 bit playback +* fix gcc 7.0 -Wimplicit-fallthrough +* systemd: paranoid security settings + +ver 0.19.19 (2016/08/23) +* decoder + - ffmpeg: bug fix for FFmpeg 3.1 support + - wildmidi: support libWildMidi 0.4 +* output + - pulse: support 32 bit, 24 bit and floating point playback +* support non-x86 NetBSD +* fix clang 3.9 warnings + +ver 0.19.18 (2016/08/05) +* decoder + - ffmpeg: fix crash with older FFmpeg versions (< 3.0) + - ffmpeg: log detailed error message + - ffmpeg: support FFmpeg 3.1 + - sidplay: detect libsidplay2 with pkg-config + - sidplay: log detailed error message + - sidplay: read the "date" tag + - sidplay: allow building with libsidplayfp instead of libsidplay2 +* output + - shout: recognize setting "encoder" instead of "encoding" +* fix memory leak after stream failure +* fix build failure with Boost 1.61 +* require gcc 4.7 or newer + +ver 0.19.17 (2016/07/09) +* decoder + - flac: fix assertion failure while seeking + - flac: fix stream duration indicator + - fix seek problems in several plugins +* fix spurious seek error "Failed to allocate silence buffer" +* replay gain: fix "replay_gain_handler mixer" setting +* DSD: use 0x69 as silence pattern +* fix use-after-free bug on "close" and "kill" + +ver 0.19.16 (2016/06/13) +* faster seeking +* fix system include path order +* add missing DocBook file to tarball + +ver 0.19.15 (2016/04/30) +* decoder + - ffmpeg: support FFmpeg 3.0 + - ffmpeg: use as fallback instead of "mad" if no plugin matches + - opus: support bigger OpusTags packets +* fix more build failures on non-glibc builds due to constexpr Mutex +* fix build failure due to missing include +* fix unit test on Alpha + +ver 0.19.14 (2016/03/18) +* decoder + - dsdiff: fix off-by-one buffer overflow + - opus: limit tag size to 64 kB +* archive + - iso9660: fix buffer overflow +* fix quadratic runtime bug in the tag pool +* fix build failures on non-glibc builds due to constexpr Mutex + +ver 0.19.13 (2016/02/23) +* tags + - aiff, riff: fix ID3 chunk padding +* decoder + - ffmpeg: support the TAK codec +* fix disappearing duration of remote songs during playback +* initialize supplementary groups with glibc 2.19+ + +ver 0.19.12 (2015/12/15) +* fix assertion failure on malformed UTF-8 tag +* fix build failure on non-Linux systems +* fix LimitRTTIME in systemd unit file + +ver 0.19.11 (2015/10/27) +* tags + - ape: fix buffer overflow +* decoder + - ffmpeg: fix crash due to wrong avio_alloc_context() call + - gme: don't loop forever, fall back to GME's default play length +* encoder + - flac: fix crash with 32 bit playback +* mixer + - fix mixer lag after enabling/disabling output + +ver 0.19.10 (2015/06/21) +* input + - curl: fix deadlock on small responses + - smbclient: fix DFF playback +* decoder + - ffmpeg: improve seeking accuracy + - fix stuck stream tags +* encoder + - opus: fix bogus granulepos +* output + - fix failure to open device right after booting +* neighbor + - nfs: fix deadlock when connecting +* fix "single" mode breakage due to queue edits + +ver 0.19.9 (2015/02/06) +* decoder + - dsdiff, dsf: raise ID3 tag limit to 1 MB +* playlist: fix loading duplicate tag types from state file +* despotify: remove defunct plugin +* fix clock integer overflow on OS X +* fix gcc 5.0 warnings +* fix build failure with uClibc +* fix build failure on non-POSIX operating systems +* fix dependency issue on parallel Android build +* fix database/state file saving on Windows + +ver 0.19.8 (2015/01/14) +* input + - curl: fix bug after rewinding from end-of-file + - mms: reduce delay at the beginning of playback +* decoder + - dsdiff, dsf: allow ID3 tags larger than 4 kB + - ffmpeg: support interleaved floating point +* fix clang 3.6 warnings +* fix build failure on NetBSD + +ver 0.19.7 (2014/12/17) +* input + - nfs: fix crash while canceling a failing file open operation + - nfs: fix memory leak on connection failure + - nfs: fix reconnect after mount failure + - nfs: implement mount timeout (60 seconds) +* storage + - nfs: implement I/O timeout (60 seconds) +* playlist + - embcue: fix filename suffix detection + - don't skip non-existent songs in "listplaylist" +* decoder + - ffmpeg: fix time stamp underflow +* fix memory allocator bug on Windows + +ver 0.19.6 (2014/12/08) +* decoder + - ffmpeg: support FFmpeg 2.5 +* fix build failure with musl +* android + - update libFLAC to 1.3.1 + - update FFmpeg to 2.5 + +ver 0.19.5 (2014/11/26) +* input + - nfs: fix crash on connection failure +* archive + - zzip: fix crash after seeking +* decoder + - dsdiff, dsf, opus: fix deadlock while seeking + - mp4v2: remove because of incompatible license + +ver 0.19.4 (2014/11/18) +* protocol + - workaround for buggy clients that send "add /" +* decoder + - ffmpeg: support opus + - opus: add MIME types audio/ogg and application/ogg +* fix crash on failed filename charset conversion +* fix local socket detection from uid=0 (root) + +ver 0.19.3 (2014/11/11) +* protocol + - fix "(null)" result string to "list" when AlbumArtist is disabled +* database + - upnp: fix breakage due to malformed URIs +* input + - curl: another fix for redirected streams +* decoder + - audiofile: fix crash while playing streams + - audiofile: fix bit rate calculation + - ffmpeg: support opus + - opus: fix bogus duration on streams + - opus: support chained streams + - opus: improved error logging +* fix distorted audio with soxr resampler +* fix build failure on Mac OS X with non-Apple compilers + +ver 0.19.2 (2014/11/02) +* input + - curl: fix redirected streams +* playlist + - don't allow empty playlist name + - m3u: don't ignore unterminated last line + - m3u: recognize the file suffix ".m3u8" +* decoder + - ignore URI query string for plugin detection + - faad: remove workaround for ancient libfaad2 ABI bug + - ffmpeg: recognize MIME type audio/aacp + - mad: fix negative replay gain values +* output + - fix memory leak after filter initialization error + - fall back to PCM if given DSD sample rate is not supported +* fix assertion failure on unsupported PCM conversion +* auto-disable plugins that require GLib when --disable-glib is used + +ver 0.19.1 (2014/10/19) +* input + - mms: fix deadlock bug +* playlist + - extm3u: fix Extended M3U detection + - m3u, extm3u, cue: fix truncated lines +* fix build failure on Mac OS X +* add missing file systemd/mpd.socket to tarball + +ver 0.19 (2014/10/10) +* protocol + - new commands "addtagid", "cleartagid", "listfiles", "listmounts", + "listneighbors", "mount", "rangeid", "unmount" + - "lsinfo" and "readcomments" allowed for remote files + - "listneighbors" lists file servers on the local network + - "playlistadd" supports file:/// + - "idle" with unrecognized event name fails + - "list" on album artist falls back to the artist tag + - "list" and "count" allow grouping + - new "search"/"find" filter "modified-since" + - "seek*" allows fractional position + - close connection after syntax error +* database + - proxy: forward "idle" events + - proxy: forward the "update" command + - proxy: copy "Last-Modified" from remote directories + - simple: compress the database file using gzip + - upnp: new plugin + - cancel the update on shutdown +* storage + - music_directory can point to a remote file server + - nfs: new plugin + - smbclient: new plugin +* playlist + - cue: fix bogus duration of the last track + - cue: restore CUE tracks from state file + - soundcloud: use https instead of http + - soundcloud: add default API key +* archive + - read tags from songs in an archive +* input + - alsa: new input plugin + - curl: options "verify_peer" and "verify_host" + - ffmpeg: update offset after seeking + - ffmpeg: improved error messages + - mms: non-blocking I/O + - nfs: new input plugin + - smbclient: new input plugin +* filter + - volume: improved software volume dithering +* decoder: + - vorbis, flac, opus: honor DESCRIPTION= tag in Xiph-based files as a comment to the song + - audiofile: support scanning remote files + - audiofile: log libaudiofile errors + - dsdiff, dsf: report bit rate + - dsdiff, dsf: implement seeking + - dsf: support DSD512 + - dsf: support multi-channel files + - dsf: fix big-endian bugs + - dsf: fix noise at end of malformed file + - mpg123: support ID3v2, ReplayGain and MixRamp + - sndfile: support scanning remote files + - sndfile: support tags "comment", "album", "track", "genre" + - sndfile: native floating point playback + - sndfile: optimized 16 bit playback + - mp4v2: support playback of MP4 files. +* encoder: + - shine: new encoder plugin +* output + - alsa: support native DSD playback + - alsa: rename "DSD over USB" to "DoP" + - osx: fix hang after (un)plugging headphones +* threads: + - the update thread runs at "idle" priority + - the output thread runs at "real-time" priority + - increase kernel timer slack on Linux + - name each thread (for debugging) +* configuration + - allow playlist directory without music directory + - use XDG to auto-detect "music_directory" and "db_file" +* add tags "AlbumSort", "MUSICBRAINZ_RELEASETRACKID" +* disable global Latin-1 fallback for tag values +* new resampler option using libsoxr +* ARM NEON optimizations +* install systemd unit for socket activation +* Android port + +ver 0.18.23 (2015/02/06) +* despotify: remove defunct plugin +* fix clock integer overflow on OS X +* fix gcc 5.0 warnings + +ver 0.18.22 (2015/01/14) +* fix clang 3.6 warnings + +ver 0.18.21 (2014/12/17) +* playlist + - embcue: fix filename suffix detection +* decoder + - ffmpeg: fix time stamp underflow + +ver 0.18.20 (2014/12/08) +* decoder + - ffmpeg: support FFmpeg 2.5 +* fix build failure with musl + +ver 0.18.19 (2014/11/26) +* archive + - zzip: fix crash after seeking + +ver 0.18.18 (2014/11/18) +* decoder + - ffmpeg: support opus +* fix crash on failed filename charset conversion +* fix local socket detection from uid=0 (root) + +ver 0.18.17 (2014/11/02) +* playlist + - don't allow empty playlist name + - m3u: recognize the file suffix ".m3u8" +* decoder + - ignore URI query string for plugin detection + - faad: remove workaround for ancient libfaad2 ABI bug + - ffmpeg: recognize MIME type audio/aacp + +ver 0.18.16 (2014/09/26) +* fix DSD breakage due to typo in configure.ac + +ver 0.18.15 (2014/09/26) +* command + - list: reset used size after the list has been processed +* fix MixRamp +* work around build failure on NetBSD + +ver 0.18.14 (2014/09/11) +* protocol + - fix range parser bug on certain 32 bit architectures +* decoder + - audiofile: fix crash after seeking + - ffmpeg: fix crash with ffmpeg/libav version 11 + - fix assertion failure after seeking + +ver 0.18.13 (2014/08/31) +* protocol + - don't change song on "seekcur" in random mode + +* decoder + - dsdiff, dsf: fix endless loop on malformed file + - ffmpeg: support ffmpeg/libav version 11 + - gme: fix song duration +* output + - alsa: fix endless loop at end of file in dsd_usb mode +* fix state file saver +* fix build failure on Darwin + +ver 0.18.12 (2014/07/30) +* database + - proxy: fix build failure with libmpdclient 2.2 + - proxy: fix add/search and other commands with libmpdclient < 2.9 +* decoder + - audiofile: improve responsiveness + - audiofile: fix WAV stream playback + - dsdiff, dsf: fix stream playback + - dsdiff: fix metadata parser bug (uninitialized variables) + - faad: estimate song duration for remote files + - sndfile: improve responsiveness +* randomize next song when enabling "random" mode while not playing +* randomize next song when adding to single-song queue + +ver 0.18.11 (2014/05/12) +* decoder + - opus: fix missing song length on high-latency files +* fix race condition when using GLib event loop (non-Linux) + +ver 0.18.10 (2014/04/10) +* decoder + - ffmpeg: fix seeking bug + - ffmpeg: handle unknown stream start time + - gme: fix memory leak + - sndfile: work around libsndfile bug on partial read +* don't interrupt playback when current song gets deleted + +ver 0.18.9 (2014/03/02) +* protocol + - "findadd" requires the "add" permission +* output + - alsa: improved workaround for noise after manual song change +* decoder + - vorbis: fix linker failure when libvorbis/libogg are static +* encoder + - vorbis: fix another linker failure +* output + - pipe: fix hanging child process due to blocked signals +* fix build failure due to missing signal.h include + +ver 0.18.8 (2014/02/07) +* decoder + - ffmpeg: support libav v10_alpha1 +* encoder + - vorbis: fix linker failure +* output + - roar: documentation +* more robust Icy-Metadata parser +* fix Solaris build failure + +ver 0.18.7 (2014/01/13) +* playlist + - pls: fix crash after parser error + - soundcloud: fix build failure with libyajl 2.0.1 +* decoder + - faad: fix memory leak + - mpcdec: reject libmpcdec SV7 in configure script +* daemon: don't initialize supplementary groups when already running + as the configured user + +ver 0.18.6 (2013/12/24) +* input + - cdio_paranoia: support libcdio-paranoia 0.90 +* tags + - riff: recognize upper-case "ID3" chunk name +* decoder + - ffmpeg: use relative timestamps +* output + - openal: fix build failure on Mac OS X + - osx: fix build failure +* mixer + - alsa: fix build failure with uClibc +* fix replay gain during cross-fade +* accept files without metadata + +ver 0.18.5 (2013/11/23) +* configuration + - fix crash when db_file is configured without music_directory + - fix crash on "stats" without db_file/music_directory +* database + - proxy: auto-reload statistics + - proxy: provide "db_update" in "stats" response +* input + - curl: work around stream resume bug (fixed in libcurl 7.32.0) +* decoder + - fluidsynth: auto-detect by default +* clip 24 bit data from libsamplerate +* fix ia64, mipsel and other little-endian architectures +* fix build failures due to missing includes +* fix build failure with static libmpdclient + +ver 0.18.4 (2013/11/13) +* decoder + - dsdiff: fix byte order bug +* fix build failures due to missing includes +* libc++ compatibility + +ver 0.18.3 (2013/11/08) +* fix stuck MPD after song change (0.18.2 regression) + +ver 0.18.2 (2013/11/07) +* protocol: + - "close" flushes the output buffer +* input: + - cdio_paranoia: add setting "default_byte_order" + - curl: fix bug with redirected streams +* playlist: + - pls: fix reversed song order +* decoder: + - audiofile: require libaudiofile 0.3 due to API breakage + - dsf: enable DSD128 +* enable buffering when starting playback (regression fix) +* fix build failures due to missing includes +* fix big-endian support + +ver 0.18.1 (2013/11/04) +* protocol: + - always ignore whitespace at the end of the line +* networking: + - log UNIX domain path names instead of "localhost" + - open listener sockets in the order they were configured + - don't abort if IPv6 is not available +* output: + - alsa: avoid endless loop in Raspberry Pi workaround +* filter: + - autoconvert: fix "volume_normalization" with mp3 files +* add missing files to source tarball + +ver 0.18 (2013/10/31) +* configuration: + - allow tilde paths for socket + - default filesystem charset is UTF-8 instead of ISO-8859-1 + - increase default buffer size to 4 MB +* protocol: + - new command "readcomments" lists arbitrary file tags + - new command "toggleoutput" + - "find"/"search" with "any" does not match file name + - "search" and "find" with base URI (keyword "base") + - search for album artist falls back to the artist tag + - re-add the "volume" command +* input: + - curl: enable https + - soup: plugin removed +* playlist: + - lastfm: remove defunct Last.fm support +* decoder: + - adplug: new decoder plugin using libadplug + - dsf: don't play junk at the end of the "data" chunk + - ffmpeg: drop support for pre-0.8 ffmpeg + - flac: require libFLAC 1.2 or newer + - flac: support FLAC files inside archives + - opus: new decoder plugin for the Opus codec + - vorbis: skip 16 bit quantisation, provide float samples + - mikmod: add "loop" configuration parameter + - modplug: add "loop_count" configuration parameter + - mp4ff: obsolete plugin removed +* encoder: + - opus: new encoder plugin for the Opus codec + - vorbis: accept floating point input samples +* output: + - new option "tags" may be used to disable sending tags to output + - alsa: workaround for noise after manual song change + - ffado: remove broken plugin + - httpd: support HEAD requests + - mvp: remove obsolete plugin + - osx: disabled by default because it's unmaintained and unsupported +* improved decoder/output error reporting +* eliminate timer wakeup on idle MPD +* fix unresponsive MPD while waiting for stream +* port of the source code to C++11 + +ver 0.17.6 (2013/10/14) +* mixer: + - alsa: fix busy loop when USB sound device gets unplugged +* decoder: + - modplug: fix build with Debian package 1:0.8.8.4-4 +* stored playlists: + - fix loading playlists with references to local files + - obey filesystem_charset for URLs + +ver 0.17.5 (2013/08/04) +* protocol: + - fix "playlistadd" with URI + - fix "move" relative to current when there is no current song +* decoder: + - ffmpeg: support "application/flv" + - mikmod: adapt to libmikmod 3.2 +* configure.ac: + - detect system "ar" + +ver 0.17.4 (2013/04/08) +* protocol: + - allow to omit END in ranges (START:END) + - don't emit IDLE_PLAYER before audio format is known +* decoder: + - ffmpeg: support float planar audio (ffmpeg 1.1) + - ffmpeg: fix AVFrame allocation +* player: + - implement missing "idle" events on output errors +* clock: fix build failure + +ver 0.17.3 (2013/01/06) +* output: + - osx: fix pops during playback + - recorder: fix I/O error check + - shout: fix memory leak in error handler + - recorder, shout: support Ogg packets that span more than one page +* decoder: + - ffmpeg: ignore negative time stamps + - ffmpeg: support planar audio +* playlist: + - cue: fix memory leak + - cue: fix CUE files with only one track + +ver 0.17.2 (2012/09/30) +* protocol: + - fix crash in local file check +* decoder: + - fluidsynth: remove throttle (requires libfluidsynth 1.1) + - fluidsynth: stop playback at end of file + - fluidsynth: check MIDI file format while scanning + - fluidsynth: add sample rate setting + - wavpack: support all APEv2 tags +* output: + - httpd: use monotonic clock, avoid hiccups after system clock adjustment + - httpd: fix throttling bug after resuming playback +* playlist: + - cue: map "PERFORMER" to "artist" or "album artist" +* mapper: fix non-UTF8 music directory name +* mapper: fix potential crash in file permission check +* playlist: fix use-after-free bug +* playlist: fix memory leak +* state_file: save song priorities +* player: disable cross-fading in "single" mode +* update: fix unsafe readlink() usage +* configure.ac: + - don't auto-detect the vorbis encoder when Tremor is enabled + +ver 0.17.1 (2012/07/31) +* protocol: + - require appropriate permissions for searchadd{,pl} +* tags: + - aiff: support the AIFC format + - ape: check for ID3 if no usable APE tag was found +* playlist: + - cue: support file types "MP3", "AIFF" +* output: + - fix noisy playback with conversion and software volume + +ver 0.17 (2012/06/27) +* protocol: + - support client-to-client communication + - "update" and "rescan" need only "CONTROL" permission + - new command "seekcur" for simpler seeking within current song + - new command "config" dumps location of music directory + - add range parameter to command "load" + - print extra "playlist" object for embedded CUE sheets + - new commands "searchadd", "searchaddpl" +* input: + - cdio_paranoia: new input plugin to play audio CDs + - curl: enable CURLOPT_NETRC + - curl: non-blocking I/O + - soup: new input plugin based on libsoup +* tags: + - RVA2: support separate album/track replay gain +* decoder: + - mpg123: implement seeking + - ffmpeg: drop support for pre-0.5 ffmpeg + - ffmpeg: support WebM + - oggflac: delete this obsolete plugin + - dsdiff: new decoder plugin +* output: + - alsa: support DSD-over-USB (dCS suggested standard) + - httpd: support for streaming to a DLNA client + - openal: improve buffer cancellation + - osx: allow user to specify other audio devices + - osx: implement 32 bit playback + - shout: add possibility to set url + - roar: new output plugin for RoarAudio + - winmm: fail if wrong device specified instead of using default device +* mixer: + - alsa: listen for external volume changes +* playlist: + - allow references to songs outside the music directory + - new CUE parser, without libcue + - soundcloud: new plugin for accessing soundcloud.com +* state_file: add option "restore_paused" +* cue: show CUE track numbers +* allow port specification in "bind_to_address" settings +* support floating point samples +* systemd socket activation +* improve --version output +* WIN32: fix renaming of stored playlists with non-ASCII names + + +ver 0.16.8 (2012/04/04) +* fix for libsamplerate assertion failure +* decoder: + - vorbis (and others): fix seeking at startup + - ffmpeg: read the "year" tag +* encoder: + - vorbis: generate end-of-stream packet before tag + - vorbis: generate end-of-stream packet when playback ends +* output: + - jack: check for connection failure before starting playback + - jack: workaround for libjack1 crash bug + - osx: fix stuttering due to buffering bug +* fix endless loop in text file reader +* update: skip symlinks in path that is to be updated + + +ver 0.16.7 (2012/02/04) +* input: + - ffmpeg: support libavformat 0.7 +* decoder: + - ffmpeg: support libavformat 0.8, libavcodec 0.9 + - ffmpeg: support all MPD tags +* output: + - httpd: fix excessive buffering + - openal: force 16 bit playback, as 8 bit doesn't work + - osx: remove sleep call from render callback + - osx: clear render buffer when there's not enough data +* fix moving after current song + + +ver 0.16.6 (2011/12/01) +* decoder: + - fix assertion failure when resuming streams + - ffmpeg: work around bogus channel count +* encoder: + - flac, null, wave: fix buffer corruption bug + - wave: support packed 24 bit samples +* mapper: fix the bogus "not a directory" error message +* mapper: check "x" and "r" permissions on music directory +* log: print reason for failure +* event_pipe: fix WIN32 regression +* define WINVER in ./configure +* WIN32: autodetect filesystem encoding + + +ver 0.16.5 (2011/10/09) +* configure.ac + - disable assertions in the non-debugging build + - show solaris plugin result correctly + - add option --enable-solaris-output +* pcm_format: fix 32-to-24 bit conversion (the "silence" bug) +* input: + - rewind: reduce heap usage +* decoder: + - ffmpeg: higher precision timestamps + - ffmpeg: don't require key frame for seeking + - fix CUE track seeking +* output: + - openal: auto-fallback to mono if channel count is unsupported +* player: + - make seeking to CUE track more reliable + - the "seek" command works when MPD is stopped + - restore song position from state file (bug fix) + - fix crash that sometimes occurred when audio device fails on startup + - fix absolute path support in playlists +* WIN32: close sockets properly +* install systemd service file if systemd is available + + +ver 0.16.4 (2011/09/01) +* don't abort configure when avahi is not found +* auto-detect libmad without pkg-config +* fix memory leaks +* don't resume playback when seeking to another song while paused +* apply follow_inside_symlinks to absolute symlinks +* fix playback discontinuation after seeking +* input: + - curl: limit the receive buffer size + - curl: implement a hard-coded timeout of 10 seconds +* decoder: + - ffmpeg: workaround for semantic API change in recent ffmpeg versions + - flac: validate the sample rate when scanning the tag + - wavpack: obey all decoder commands, stop at CUE track border +* encoder: + - vorbis: don't send end-of-stream on flush +* output: + - alsa: fix SIGFPE when alsa announces a period size of 0 + - httpd: don't warn on client disconnect + - osx: don't drain the buffer when closing + - pulse: fix deadlock when resuming the stream + - pulse: fix deadlock when the stream was suspended + + +ver 0.16.3 (2011/06/04) +* fix assertion failure in audio format mask parser +* fix NULL pointer dereference in playlist parser +* fix playlist files in base music directory +* database: allow directories with just playlists +* decoder: + - ffmpeg: support libavcodec 0.7 + + +ver 0.16.2 (2011/03/18) +* configure.ac: + - fix bashism in tremor test +* decoder: + - tremor: fix configure test + - gme: detect end of song +* encoder: + - vorbis: reset the Ogg stream after flush +* output: + - httpd: fix uninitialized variable + - httpd: include sys/socket.h + - oss: AFMT_S24_PACKED is little-endian + - oss: disable 24 bit playback on FreeBSD + + +ver 0.16.1 (2011/01/09) +* audio_check: fix parameter in prototype +* add void casts to suppress "result unused" warnings (clang) +* input: + - ffado: disable by default +* decoder: + - mad: work around build failure on Solaris + - resolve modplug vs. libsndfile cflags/headers conflict +* output: + - solaris: add missing parameter to open_cloexec() cal + - osx: fix up audio format first, then apply it to device +* player_thread: discard empty chunks while cross-fading +* player_thread: fix assertion failure due to early seek +* output_thread: fix double lock + + +ver 0.16 (2010/12/11) +* protocol: + - send song modification time to client + - added "update" idle event + - removed the deprecated "volume" command + - added the "findadd" command + - range support for "delete" + - "previous" really plays the previous song + - "addid" with negative position is deprecated + - "load" supports remote playlists (extm3u, pls, asx, xspf, lastfm://) + - allow changing replay gain mode on-the-fly + - omitting the range end is possible + - "update" checks if the path is malformed +* archive: + - iso: renamed plugin to "iso9660" + - zip: renamed plugin to "zzip" +* input: + - lastfm: obsolete plugin removed + - ffmpeg: new input plugin using libavformat's "avio" library +* tags: + - added tags "ArtistSort", "AlbumArtistSort" + - id3: revised "performer" tag support + - id3: support multiple values + - ape: MusicBrainz tags + - ape: support multiple values +* decoders: + - don't try a plugin twice (MIME type & suffix) + - don't fall back to "mad" unless no plugin matches + - ffmpeg: support multiple tags + - ffmpeg: convert metadata to generic format + - ffmpeg: implement the libavutil log callback + - sndfile: new decoder plugin based on libsndfile + - flac: moved CUE sheet support to a playlist plugin + - flac: support streams without STREAMINFO block + - mikmod: sample rate is configurable + - mpg123: new decoder plugin based on libmpg123 + - sidplay: support sub-tunes + - sidplay: implemented songlength database + - sidplay: support seeking + - sidplay: play monaural SID tunes in mono + - sidplay: play mus, str, prg, x00 files + - wavpack: activate 32 bit support + - wavpack: allow more than 2 channels + - mp4ff: rename plugin "mp4" to "mp4ff" +* encoders: + - twolame: new encoder plugin based on libtwolame + - flac: new encoder plugin based on libFLAC + - wave: new encoder plugin for PCM WAV format +* output: + - recorder: new output plugin for recording radio streams + - alsa: don't recover on CANCEL + - alsa: fill period buffer with silence before draining + - openal: new output plugin + - pulse: announce "media.role=music" + - pulse: renamed context to "Music Player Daemon" + - pulse: connect to server on MPD startup, implement pause + - jack: require libjack 0.100 + - jack: don't disconnect during pause + - jack: connect to server on MPD startup + - jack: added options "client_name", "server_name" + - jack: clear ring buffers before activating + - jack: renamed option "ports" to "destination_ports" + - jack: support more than two audio channels + - httpd: bind port when output is enabled + - httpd: added name/genre/website configuration + - httpd: implement "pause" + - httpd: bind_to_address support (including IPv6) + - oss: 24 bit support via OSS4 + - win32: new output plugin for Windows Wave + - shout, httpd: more responsive to control commands + - wildcards allowed in audio_format configuration + - consistently lock audio output objects +* player: + - drain audio outputs at the end of the playlist +* mixers: + - removed support for legacy mixer configuration + - reimplemented software volume as mixer+filter plugin + - per-device software/hardware mixer setting +* commands: + - added new "status" line with more precise "elapsed time" +* update: + - automatically update the database with Linux inotify + - support .mpdignore files in the music directory + - sort songs by album name first, then disc/track number + - rescan after metadata_to_use change +* normalize: upgraded to AudioCompress 2.0 + - automatically convert to 16 bit samples +* replay gain: + - reimplemented as a filter plugin + - fall back to track gain if album gain is unavailable + - optionally use hardware mixer to apply replay gain + - added mode "auto" + - parse replay gain from APE tags +* log unused/unknown block parameters +* removed the deprecated "error_file" option +* save state when stopped +* renamed option "--stdout" to "--stderr" +* removed options --create-db and --no-create-db +* state_file: save only if something has changed +* database: eliminated maximum line length +* log: redirect stdout/stderr to /dev/null if syslog is used +* set the close-on-exec flag on all file descriptors +* pcm_volume, pcm_mix: implemented 32 bit support +* support packed 24 bit samples +* CUE sheet support +* support for MixRamp tags +* obey $(sysconfdir) for default mpd.conf location +* build with large file support by default +* added test suite ("make check") +* require GLib 2.12 +* added libwrap support +* make single mode 'sticky' + + +ver 0.15.17 (2011/??/??) +* encoder: + - vorbis: reset the Ogg stream after flush +* decoders: + - vorbis: fix tremor support + + +ver 0.15.16 (2011/03/13) +* output: + - ao: initialize the ao_sample_format struct + - jack: fix crash with mono playback +* encoders: + - lame: explicitly configure the output sample rate +* update: log all file permission problems + + +ver 0.15.15 (2010/11/08) +* input: + - rewind: fix assertion failure +* output: + - shout: artist comes first in stream title + + +ver 0.15.14 (2010/11/06) +* player_thread: fix assertion failure due to wrong music pipe on seek +* output_thread: fix assertion failure due to race condition in OPEN +* input: + - rewind: fix double free bug +* decoders: + - mp4ff, ffmpeg: add extension ".m4b" (audio book) + + +ver 0.15.13 (2010/10/10) +* output_thread: fix race condition after CANCEL command +* output: + - httpd: fix random data in stream title + - httpd: MIME type audio/ogg for Ogg Vorbis +* input: + - rewind: update MIME not only once + - rewind: enable for MMS + + +ver 0.15.12 (2010/07/20) +* input: + - curl: remove assertion after curl_multi_fdset() +* tags: + - rva2: set "gain", not "peak" +* decoders: + - wildmidi: support version 0.2.3 + + +ver 0.15.11 (2010/06/14) +* tags: + - ape: support album artist +* decoders: + - mp4ff: support tags "album artist", "albumartist", "band" + - mikmod: fix memory leak + - vorbis: handle uri==NULL + - ffmpeg: fix memory leak + - ffmpeg: free AVFormatContext on error + - ffmpeg: read more metadata + - ffmpeg: fix libavformat 0.6 by using av_open_input_stream() +* playlist: emit IDLE_OPTIONS when resetting single mode +* listen: make get_remote_uid() work on BSD + + +ver 0.15.10 (2010/05/30) +* input: + - mms: fix memory leak in error handler + - mms: initialize the "eof" attribute +* decoders: + - mad: properly calculate ID3 size without libid3tag + + +ver 0.15.9 (2010/03/21) +* decoders: + - mad: fix crash when seeking at end of song + - mpcdec: fix negative shift on fixed-point samples + - mpcdec: fix replay gain formula with v8 +* playlist: fix single+repeat in random mode +* player: postpone song tags during cross-fade + + +ver 0.15.8 (2010/01/17) +* input: + - curl: allow rewinding with Icy-Metadata +* decoders: + - ffmpeg, flac, vorbis: added more flac/vorbis MIME types + - ffmpeg: enabled libavformat's file name extension detection +* dbUtils: return empty tag value only if no value was found +* decoder_thread: fix CUE track playback +* queue: don't repeat current song in consume mode + + +ver 0.15.7 (2009/12/27) +* archive: + - close archive when stream is closed + - iso, zip: fixed memory leak in destructor +* input: + - file: don't fall back to parent directory + - archive: fixed memory leak in error handler +* tags: + - id3: fix ID3v1 charset conversion +* decoders: + - eliminate jitter after seek failure + - ffmpeg: don't try to force stereo + - wavpack: allow fine-grained seeking +* mixer: explicitly close all mixers on shutdown +* mapper: fix memory leak when playlist_directory is not set +* mapper: apply filesystem_charset to playlists +* command: verify playlist name in the "rm" command +* database: return multiple tag values per song + + +ver 0.15.6 (2009/11/18) +* input: + - lastfm: fixed variable name in GLib<2.16 code path + - input/mms: require libmms 0.4 +* archive: + - zzip: require libzzip 0.13 +* tags: + - id3: allow 4 MB RIFF/AIFF tags +* decoders: + - ffmpeg: convert metadata + - ffmpeg: align the output buffer + - oggflac: rewind stream after FLAC detection + - flac: fixed CUE seeking range check + - flac: fixed NULL pointer dereference in CUE code +* output_thread: check again if output is open on PAUSE +* update: delete ignored symlinks from database +* database: increased maximum line length to 32 kB +* sticker: added fallback for sqlite3_prepare_v2() + + +ver 0.15.5 (2009/10/18) +* input: + - curl: don't abort if a packet has only metadata + - curl: fixed endless loop during buffering +* tags: + - riff, aiff: fixed "limited range" gcc warning +* decoders: + - flac: fixed two memory leaks in the CUE tag loader +* decoder_thread: change the fallback decoder name to "mad" +* output_thread: check again if output is open on CANCEL +* update: fixed memory leak during container scan + + +ver 0.15.4 (2009/10/03) +* decoders: + - vorbis: revert "faster tag scanning with ov_test_callback()" + - faad: skip assertion failure on large ID3 tags + - ffmpeg: use the "artist" tag if "author" is not present +* output: + - osx: fix the OS X 10.6 build + + +ver 0.15.3 (2009/08/29) +* decoders: + - vorbis: faster tag scanning with ov_test_callback() +* output: + - fix stuttering due to uninitialized variable +* update: don't re-read unchanged container files + + +ver 0.15.2 (2009/08/15) +* tags: + - ape: check the tag size (fixes integer underflow) + - ape: added protection against large memory allocations +* decoders: + - mad: skip ID3 frames when libid3tag is disabled + - flac: parse all replaygain tags + - flac: don't allocate cuesheet twice (memleak) +* output: + - shout: fixed stuck pause bug + - shout: minimize the unpause latency +* update: free empty path string (memleak) +* update: free temporary string in container scan (memleak) +* directory: free empty directories after removing them (memleak) + + +ver 0.15.1 (2009/07/15) +* decoders: + - flac: fix assertion failure in tag_free() call +* output: + - httpd: include sys/types.h (fixes Mac OS X) +* commands: + - don't resume playback when stopping during pause +* database: fixed NULL pointer dereference after charset change +* log: fix double free() bug during shutdown + + +ver 0.15 (2009/06/23) +* input: + - parse Icy-Metadata + - added support for the MMS protocol + - hide HTTP password in playlist + - lastfm: new input plugin for last.fm radio (experimental and incomplete!) + - curl: moved proxy settings to "input" block +* tags: + - support the "album artist" tag + - support MusicBrainz tags + - parse RVA2 tags in mp3 files + - parse ID3 tags in AIFF/RIFF/WAV files + - ffmpeg: support new metadata API + - ffmpeg: added support for the tags comment, genre, year +* decoders: + - audiofile: streaming support added + - audiofile: added 24 bit support + - modplug: another MOD plugin, based on libmodplug + - mikmod disabled by default, due to severe security issues in libmikmod + - sidplay: new decoder plugin for C64 SID (using libsidplay2) + - fluidsynth: new decoder plugin for MIDI files (using libfluidsynth, + experimental due to shortcomings in libfluidsynth) + - wildmidi: another decoder plugin for MIDI files (using libwildmidi) + - flac: parse stream tags + - mpcdec: support the new libmpcdec SV8 API + - added configuration option to disable decoder plugins + - flac: support embedded cuesheets + - ffmpeg: updated list of supported formats +* audio outputs: + - added option to disable audio outputs by default + - wait 10 seconds before reopening after play failure + - shout: enlarged buffer size to 32 kB + - null: allow disabling synchronization + - mvp: fall back to stereo + - mvp: fall back to 16 bit audio samples + - mvp: check for reopen errors + - mvp: fixed default device detection + - pipe: new audio output plugin which runs a command + - alsa: better period_time default value for high sample rates + - solaris: new audio output plugin for Solaris /dev/audio + - httpd: new audio output plugin for web based streaming, similar to icecast + but built in. +* commands: + - "playlistinfo" and "move" supports a range now + - added "sticker database", command "sticker", which allows clients + to implement features like "song rating" + - added "consume" command which removes a song after play + - added "single" command, if activated, stops playback after current song or + repeats the song if "repeat" is active. +* mixers: + - rewritten mixer code to support multiple mixers + - new pulseaudio mixer + - alsa: new mixer_index option supports choosing between multiple + identically-named controls on a device. +* Add audio archive extraction support: + - bzip2 + - iso9660 + - zip +* the option "error_file" was removed, all messages are logged into + "log_file" +* support logging to syslog +* fall back to XDG music directory if no music_directory is configured +* failure to read the state file is non-fatal +* --create-db starts the MPD daemon instead of exiting +* playlist_directory and music_directory are optional +* playlist: recalculate the queued song after random is toggled +* playlist: don't unpause on delete +* pause when all audio outputs fail to play +* daemon: ignore "user" setting if already running as that user +* listen: fix broken client IP addresses in log +* listen: bind failure on secondary address is non-fatal +* 24/32 bit audio support +* print available protocols in --version +* fill buffer after seeking +* choose the fallback resampler at runtime +* steps taken towards win32 compatibility +* require glib 2.6 or greater +* built-in documentation using doxygen and docbook + + +ver 0.14.2 (2009/02/13) +* configure.ac: + - define HAVE_FFMPEG after all checks +* decoders: + - ffmpeg: added support for the tags comment, genre, year + - ffmpeg: don't warn of empty packet output + - ffmpeg: check if the time stamp is valid + - ffmpeg: fixed seek integer overflow + - ffmpeg: enable WAV streaming + - ffmpeg: added TTA support + - wavpack: pass NULL if the .wvc file fails to open + - mikmod: call MikMod_Exit() only in the finish() method + - aac: fix stream metadata +* audio outputs: + - jack: allocate ring buffers before connecting + - jack: clear "shutdown" flag on reconnect + - jack: reduced sleep time to 1ms + - shout: fixed memory leak in the mp3 encoder + - shout: switch to blocking mode + - shout: use libshout's synchronization + - shout: don't postpone metadata + - shout: clear buffer before calling the encoder +* mapper: remove trailing slashes from music_directory +* player: set player error when output device fails +* update: recursively purge deleted directories +* update: free deleted subdirectories + +ver 0.14.1 (2009/01/17) +* decoders: + - mp4: support the writer/composer tag + - id3: strip leading and trailing whitespace from ID3 tags + - oggvorbis: fix tremor support + - oggvorbis: disable seeking on remote files +* audio outputs: + - jack: allocate default port names (fixes a crash) +* update: + - refresh stats after update + - save the database even if it is empty +* input_curl: + - use select() to eliminate busy loop during connect + - honour http_proxy_* config directives + - fix assertion failure on "connection refused" + - fix assertion failure with empty HTTP responses +* corrected the sample calculation in the fallback resampler +* log: automatically append newline +* fix setenv() conflict on Solaris +* configure.ac: check for pkg-config before using it +* fix minor memory leak in decoder_tag() +* fix cross-fading bug: it used to play some chunks of the new song twice +* playlist + - fix assertion failure during playlist load + - implement Fisher-Yates shuffle properly + - safely search the playlist for deleted song +* use custom PRNG for volume dithering (speedup) +* detect libid3tag without pkg-config + +ver 0.14 (2008/12/25) +* audio outputs: + - wait 10 seconds before reopening a failed device + - fifo: new plugin + - null: new plugin + - shout: block while trying to connect instead of failing + - shout: new timeout parameter + - shout: support mp3 encoding and the shoutcast protocol + - shout: send silence during pause, so clients don't get disconnected +* decoders: + - ffmpeg: new plugin + - wavpack: new plugin + - aac: stream support added + - mod: disabled by default due to critical bugs in all libmikmod versions +* commands: + - "addid" takes optional second argument to specify position + - "idle" notifies the client when a notable change occurs +* Zeroconf support using Bonjour +* New zeroconf_enabled option so that Zeroconf support can be disabled +* Stop the player/decode processes when not playing to allow the CPU to sleep +* Fix a bug where closing an ALSA dmix device could cause MPD to hang +* Support for reading ReplayGain from LAME tags on MP3s +* MPD is now threaded, which greatly improves performance and stability +* memory usage reduced by merging duplicate tags in the database +* support connecting via unix domain socket +* allow authenticated local users to add any local file to the playlist +* 24 bit audio support +* optimized PCM conversions and dithering +* much code has been replaced by using GLib +* the HTTP client has been replaced with libcurl +* symbolic links in the music directory can be disabled; the default + is to ignore symlinks pointing outside the music directory + +ver 0.13.0 (2007/5/28) +* New JACK audio output +* Support for "file" as an alternative to "filename" in search, find, and list +* FLAC 1.1.3 API support +* New playlistadd command for adding to stored playlists +* New playlistclear command for clearing stored playlists +* Fix a bug where "find any" and "list any" wouldn't return any results +* Make "list any" return an error instead of no results and an OK +* New gapless_mp3_playback option to disable gapless MP3 playback +* Support for seeking HTTP streams +* Zeroconf support using Avahi +* libsamplerate support for high quality audio resampling +* ID3v2 "Original Artist/Performer" tag support +* New playlistsearch command for searching the playlist (similar to "search") +* New playlistfind command for finding songs in the playlist (similar to "find") +* libmikmod 3.2.0 beta support +* New tagtypes command for retrieving a list of available tag types +* Fix a bug where no ACK was returned if loading a playlist failed +* Fix a bug where db_update in stats would be 0 after initial database creation +* New count command for getting stats on found songs (similar to "find") +* New playlistmove command for moving songs in stored playlists +* New playlistdelete command for deleting songs from stored playlists +* New rename command for renaming stored playlists +* Increased default buffer_before_play from 0% to 10% to prevent skipping +* Lots of bug fixes, cleaned up code, and performance improvements + +ver 0.12.2 (2007/3/20) +* Fix a bug where clients could cause MPD to segfault + +ver 0.12.1 (2006/10/10) +* Fix segfault when scanning an MP3 that has a Xing tag with 0 frames +* Fix segfault when there's no audio output specified and one can't be detected +* Fix handling of escaping in quotes +* Allow a quality of -1 to be specified for shout outputs +* A few minor cleanups + +ver 0.12.0 (2006/9/22) +* New audio output code which supports: + * A plugin-like architecture + * Non-libao ("native") outputs: + * ALSA + * OSS + * OS X + * Media MVP + * PulseAudio + * Shout (Icecast or Shoutcast) + * Playing through multiple outputs at once + * Enabling/disabling outputs while MPD is running + * Saving output state (enabled/disabled) to the state_file +* OggFLAC support +* Musepack support +* Gapless MP3 playback +* MP3 ReplayGain support (using ID3v2 tags only) +* Support for MP2 files if MP3 support is enabled +* Composer, Performer, Comment, and Disc metadata support +* New outputs command for listing available audio outputs +* New enableoutput and disableoutput commands for enabling/disabling outputs +* New plchangesposid command for a stripped down version of plchanges +* New addid command for adding to the playlist and returning a song ID +* New commands and notcommands commands for checking available commands +* Can now specify any supported metadata type or "any" in search, find, and list +* New volume_normalization parameter for enabling Audio Compress normalization +* New metadata_to_use parameter for choosing supported metadata types +* New pid_file parameter for saving the MPD process ID to the specified file +* The db_file parameter is now required +* The port parameter is now optional (defaults to 6600) +* Can specify bind_to_address multiple times +* New --kill argument for killing MPD if pid_file is specified +* Removed --update-db argument (use the update function in your client instead) +* New mpdconf.example +* New mpd.conf man page +* Removed bundled libmad and libid3tag +* Lots of bug fixes, cleaned up code, and performance improvements + +ver 0.11.5 (2004/11/1) +1) New id3v1_encoding config option to configure the id3v1 tag encoding (patch +from dottedmag) +2) Strip '\r' from m3u playlists (thank you windows) +3) Use random() instead of rand() for playlist randomizing +4) Fix a bug trying skipping some commented lines in m3u playlist files +5) Fix a bug when fetching metadata from streams that may cause certain +weirdnesses +6) Fix a bug where replaygain preamp was used on files w/o replaygain tags +7) Fix a busy loop when trying to prebuffer a nonexistant or missing stream +8) Fix a bug in forgetting to remove leading ' ' in content-type for http +streams +9) Check for ice-name in http headers +10) Be sure the strip all '\n' chars in tags +11) Set $HOME env variable when setuid'ing, this should fix the /root/.mcop +errors triggered by arts/libao + +ver 0.11.4 (2004/7/26) +1) Fixed a segfault when decoding mp3's with corrupt id3v2 tags +2) Fixed a memory leak when encountering id3v2 tags in mp3 decoder + +ver 0.11.3 (2004/7/21) +1) Add support for http authentication for streams +2) Added replaygain pre-amp support +3) Better error handling for fread() in inputStream_file +4) Fixed a bug so that when a freeAllInterfaces is called, it sets +max_interface_connections to 0. This prevents potential segfaults and other +nastiness for forked processes, like the player and update-er (do to +interfacePrintWithFD()). +5) Allow blockingWrite() to handle errors more gracefully (for example, if the +disc is full, and thus the write() fails or can't be completed, we just skip +this write() and continue, instead of getting stuck in an infinite loop until +the write() becomes successful) +6) Updated mpdconf.example from sbh/avuton +7) If "user" is specified, then convert ~ in paths to the user's home path +specified by "user" config paramter (not the actual current user running mpd). + +ver 0.11.2 (2004/7/5) +1) Work around in computing total time for mp3's whose first valid mpeg frame is +not layer III +2) Fix mp3 and mp4 decoders when seeking past the end of the file +3) Fix replaygain for flac and vorbis +4) Fix memory leaks in flac decoder (from normalperson) +5) Fix Several other bugs in playlist.c and directory.c (from normalperson) + +ver 0.11.1 (2004/6/24) +1) Fix a bug that caused "popping" at the beginning of mp3's +2) Fix playlistid command +3) Fix move commands so they don't mess up the song id's +4) Added support for HTTP Proxy +5) Detect and skip recursive links in the music directory +6) Fix addPathToDB() so updating on a specific path doesn't exist correctly adds +the parent directories to the DB + +ver 0.11.0 (2004/6/18) +1) Support for playing mp3 and Ogg Vorbis streams +2) Non-blocking Update +3) Replaygain support for Ogg Vorbis and FLAC (by Eric Moore aka AliasMrJones) +4) audio_output_format option that allows for all audio output to be converted +to a format compatible with any sound card +5) Own routines for to always support UTF-8 <-> ISO-8859-1 conversion +6) Added "Id" and "Pos" metadata for songs in playlist +7) Added commands: plchanges, currentsong, playid, seekid, playlistid, moveid, +swapid, deleteid +8) UTF-8 validation of all tags +9) Update specific files/directories (for fast, incremental updating) +10) Added ACK error codes +11) Mod file support +12) Added command_list_ok_begin +13) Play after stop resumes from last position in the playlist +14) Play while pause resumes playback +15) Better signal handling by mackstann +16) Cleanup decoder interface (now called InputPlugins) +17) --create-db no long starts the daemon +18) --no-daemon outputs to log files +19) --stdout sends output to stdout/stderr +20) Default port is now 6600 +21) Lots of other cleanups and Bugfixes + +ver 0.10.4 (2004/5/26) +1) Fix configure problems on OpenBSD with langinfo and iconv +2) Fix an infinte loop when writing to an interface and it has expired +3) Fix a segfault in decoding flac's +4) Ingore CRC stuff in mp3's since some encoders did not compute the CRC +correctly +5) Fix a segfault in processing faulty mp4 metadata + +ver 0.10.3 (2004/4/2) +1) Fix a segfault when a blanck line is sent from a client +2) Fix for loading playlists on platforms where char is unsigned +3) When pausing, release audio device after we say pause is successful (this +makes pause appear to not lag) +4) When returning errors for unknown types by player, be sure to copy the +filename +5) add --disable-alsa for disabling alsa mixer support +6) Use select() for a portable usleep() +7) For alsa mixer, default to "Master' element, not first element + +ver 0.10.2 (2004/3/25) +1) Add suport for AAC +2) Substitute '\n' with ' ' in tag info +3) Remove empty directories from db +4) Resume from current position in song when using state file +5) Pause now closes the music device, and reopens it on resuming +6) Fix unnecessary big endian byte swapping +7) If locale is "C" or "POSIX", then use ISO-8859-1 as the fs charset +8) Fix a bug where alsa mixer wasn't detecting volume changes +9) For alsa and software mixer, show volume to be the same as it was set (even +if its not the exact volume) +10) Report bitrate for wave files +11) Compute song length of CBR mp3's more accurately + +ver 0.10.1 (2004/3/7) +1) Check to see if we need to add "-lm" when linking mpd +2) Fix issues with skipping bad frames in an mp3 (this way we get the correct +samplerate and such) +3) Fix crossfading bug with ogg's +4) Updated libmad and libid3tag included w/ source to 0.15.1b + +ver 0.10.0 (2004/3/3) +1) Use UTF-8 for all client communications +2) Crossfading support +3) Password Authentication (all in plaintext) +4) Software mixer +5) Buffer Size is configurable +6) Reduced Memory consumption (use directory tree for search and find) +7) Bitrate support for Flac +8) setvol command (deprecates volume command) +9) add command takes directories +10) Path's in config file now work with ~ +11) Add samplerate,bits, and channels to status +12) Reenable playTime in stats display +13) Fix a segfault when doing: add "" +14) Fix a segfault with flac vorbis comments simply being "=" +15) Fix a segfault/bug in queueNextSong with repeat+random +16) Fix a bug, where one process may segfault, and cause more processes to spawn +w/o killing ones that lost their parent. +17) Fix a bug when the OSS device was unable to fetch the current volume, +it would close the device (when it maybe previously closed by the exact same +code) +18) command.c cleanup by mackstann +19) directory.c and command.c cleanup by tw-nym + +ver 0.9.4 (2004/1/21) +1) Fix a bug where updated tag info wasn't being detected +2) Set the default audio write size to 1024 bytes (should decrease cpu load a +bit on some machines). +3) Make audio write size configurable via "audio_write_size" config option +4) Tweak output buffer size for connections by detecting the kernel output +buffer size. + +ver 0.9.3 (2003/10/31) +1) Store total time/length of songs in db and display in *info commands +2) Display instantaneous bitrate in status command +3) Add Wave Support using libaudiofile (Patch from normalperson) +4) Command code cleanup (Patch from tw-nym) +5) Optimize listing of playlists (10-100x faster) +6) Optimize interface output (write in 4kB chunks instead of on every '\n') +7) Fix bug that prevented rm command from working +8) Fix bug where deleting current song skips the next song +9) Use iconv to convert vorbis comments from UTF-8 to Latin1 + +ver 0.9.2 (2003/10/6) +1) Fix FreeBSD Compilation Problems +2) Fix bug in move command +3) Add mixer_control options to configure which mixer control/device mpd +controls +4) Randomize on play -1 +5) Fix a bug in toggling repeat off and at the end of the playlist + +ver 0.9.1 (2003/9/30) +1) Fix a statement in the middle of declarations in listen.c, causes error for +gcc 2.7 + +ver 0.9.0 (2003/9/30) +1) Random play mode +2) Alsa Mixer Support +3) Save and Restore "state" +4) Default config file locations (.mpdconf and /etc/mpd.conf) +5) Make db file locations configurable +6) Move songs around in the playlist +7) Gapless playback +8) Use Xing tags for mp3's +9) Remove stop_on_error +10) Seeking support +11) Playlists can be loaded and deleted from subdirectories +12) Complete rewrite of player layer (fork()'s only once, opens and closes +audio device as needed). +13) Eliminate use and dependence of SIGIO +14) IPv6 support +15) Solaris compilations fixes +16) Support for different log levels +17) Timestamps for log entries +18) "user" config parameter for setuid (patch from Nagilum) +19) Other misc features and bug fixes + +ver 0.8.7 (2003/9/3) +1) Fix a memory leak. When closing a interface, was called close() on the fd +instead of calling fclose() on the fp that was opened with fdopen(). + +ver 0.8.6 (2003/8/25) +1) Fix a memory leak when a buffered existed, and a connection was unexpectedly +closed, and i wasn't free'ing the buffer apropriatly. + +ver 0.8.5 (2003/8/17) +1) Fix a bug where an extra end of line is returned when attempting to play a +non existing file. This causes parsing errors for clients. + +ver 0.8.4 (2003/8/13) +1) Fix a bug where garbage is returned with errors in "list" command + +ver 0.8.3 (2003/8/12) +1) Fix a compilation error on older linux systems +2) Fix a bug in searching by title +3) Add "list" command +4) Add config options for specifying libao driver/plugin and options +5) Add config option to specify which address to bind to +6) Add support for loading and saving absolute pathnames in saved playlists +7) Playlist no longer creates duplicate entries for song data (more me +efficient) +8) Songs deleted from the db are now removed for the playlist as well + +ver 0.8.2 (2003/7/22) +1) Increased the connection que for listen() from 0 to 5 +2) Cleanup configure makefiles so that mpd uses MPD_LIBS and MPD_CFLAGS +rather than LIBS and CFLAGS +3) Put a cap on the number of commands per command list +4) Put a cap on the maximum number of buffered output lines +5) Get rid of TIME_WAIT/EADDRINUSE socket problem +6) Use asynchronious IO (i.e. trigger SIGIO instead so we can sleep in +select() calls longer) + +ver 0.8.1 (2003/7/11) +1) FreeBSD fixes +2) Fix for rare segfault when updating +3) Fix bug where client was being hungup on when done playing current song +4) Fix bug when playing flac's where it incorrectly reports an error +5) Make stop playlist on error configurable +6) Configure checks for installed libmad and libid3tag and uses those if found +7) Use buffer->finished in *_decode's instead of depending on catching signals + +ver 0.8.0 (2003/7/6) +1) Flac support +2) Make playlist max length configurable +3) New backward compatible status (backward compatible for 0.8.0 on) +4) listall command now can take a directory as an argument +5) Buffer rewritten to use shared memory instead of sockets +6) Playlist adding done using db +7) Add sort to list, and use binary search for finding +8) New "stats" command +9) Command list (for faster adding of large batches of files) +10) Add buffered chunks before play +11) Useful error reporting to clients (part of status command) +12) Use libid3tag for reading id3 tags (more stable) +13) Non-blocking output to clients +14) Fix bug when removing items from directory +15) Fix bug when playing mono mp3's +16) Fix bug when attempting to delete files when using samba +17) Lots of other bug fixes I can't remember + +ver 0.7.0 (2003/6/20) +1) use mad instead of mpg123 for mp3 decoding +2) volume support +3) repeate playlist support +4) use autoconf/automake (i.e. "configure") +5) configurable max connections + +ver 0.6.2 (2003/6/11) +1) Buffer support for ogg +2) new config file options: "connection_timeout" and "mpg123_ignore_junk" +3) new commands: "next", "previous", and "listall" +Thanks to Niklas Hofer for "next" and "previous" patches! +4) Search by filename +5) bug fix for pause when playing mp3's + +ver 0.6.1 (2003/5/29) +1) Add conf file support +2) Fix a bug when doing mp3stop (do wait3(NULL,WNOHANG|WUNTRACED,NULL)) +3) Fix a bug when fork'ing, fflush file buffers before forking so the +child doesn't print the same stuff in the buffer. + +ver 0.6.0 (2003/5/25) +1) Add ogg vorbis support +2) Fix two bugs relating to tables, one for search by title, and one where we +freed the tables before directories, causing a segfault +3) The info command has been removed. + +ver 0.5.0-0.5.2 +Initial release(s). Support for MP3 via mpg123 diff --git a/android/.gitignore b/android/.gitignore new file mode 100644 index 0000000..377b2bf --- /dev/null +++ b/android/.gitignore @@ -0,0 +1,24 @@ +*.iml +.gradle +/local.properties +## ignoring .idea completely +# until a good reason emerges not to +/.idea +##-- +## moved the following into .idea/.gitignore +#/.idea/caches +#/.idea/libraries +#/.idea/modules.xml +#/.idea/workspace.xml +#/.idea/navEditor.xml +#/.idea/assetWizardSettings.xml +## -- +.DS_Store +/build +/captures +.externalNativeBuild +.cxx +local.properties +# both were used: different spelling +app/src/main/jnilibs/ +app/src/main/jniLibs/ diff --git a/android/PrivacyPolicy.rst b/android/PrivacyPolicy.rst new file mode 100644 index 0000000..775983c --- /dev/null +++ b/android/PrivacyPolicy.rst @@ -0,0 +1,8 @@ +MPD for Android Privacy Policy +============================== + +Music Player Daemon is an open source project currently maintained by +`Max Kellermann `__. + +Music Player Daemon does not access, collect, use or share any +personal or sensitive user data. diff --git a/android/README.md b/android/README.md new file mode 100644 index 0000000..44d93b2 --- /dev/null +++ b/android/README.md @@ -0,0 +1,49 @@ +# Android + +Notes and resources for MPD android maintainers. + +## Build + +See [Compiling for Android](https://github.com/MusicPlayerDaemon/MPD/blob/45cb098cd765af12316f8dca5635ef10a852e013/doc/user.rst#compiling-for-android) + +## Android studio + +### Version control + +git ignoring .idea directory completely until a good reason emerges not to + +* [How to manage projects under Version Control Systems (jetbrains.com)](https://intellij-support.jetbrains.com/hc/en-us/articles/206544839-How-to-manage-projects-under-Version-Control-Systems) + +* [gradle.xml should work like workspace.xml? (jetbrains.com)](https://youtrack.jetbrains.com/issue/IDEA-55923) + +### Native libraries + +* [Include prebuilt native libraries (developer.android.com)](https://developer.android.com/studio/projects/gradle-external-native-builds#jniLibs) + +## Permissions + +### Files access + +The required permission depends on android SDK version: + + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) + Manifest.permission.READ_MEDIA_AUDIO + else + Manifest.permission.READ_EXTERNAL_STORAGE + +### Permission request + +[Request runtime permissions](https://developer.android.com/training/permissions/requesting) + +Since Android 6.0 (API level 23): + +Android will ignore permission request and will not show the request dialog +if the user's action implies "don't ask again." +This leaves the app in a crippled state and the user confused. +Google says "don't try to convince the user", so it returns false for `shouldShowRequestPermissionRationale`. + +To help the user proceed, we show the `Request permission` button only if `shouldShowRequestPermissionRationale == true` +because there's a good chance the permission request dialog will not be ignored. + +If `shouldShowRequestPermissionRationale == false` we instead show the "rationale" message and a button to open +the app info dialog where the user can explicitly grand the permission. \ No newline at end of file diff --git a/android/app/.gitignore b/android/app/.gitignore new file mode 100644 index 0000000..42afabf --- /dev/null +++ b/android/app/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/android/app/build.gradle.kts b/android/app/build.gradle.kts new file mode 100644 index 0000000..bcf84c3 --- /dev/null +++ b/android/app/build.gradle.kts @@ -0,0 +1,128 @@ +plugins { + id("com.google.devtools.ksp") + alias(libs.plugins.android.application) + alias(libs.plugins.jetbrains.kotlin.android) + alias(libs.plugins.dagger.hilt.android) +} + +android { + namespace = "org.musicpd" + compileSdk = 35 + + defaultConfig { + applicationId = "org.musicpd" + minSdk = 24 + targetSdk = 34 + versionCode = 1 + versionName = "1.0" + vectorDrawables { + useSupportLibrary = true + } + } + + buildFeatures { + aidl = true + compose = true + } + + composeOptions { + kotlinCompilerExtensionVersion = "1.5.10" + } + + buildTypes { + debug { + isMinifyEnabled = false + } + release { + isMinifyEnabled = true + proguardFiles( + getDefaultProguardFile("proguard-android-optimize.txt"), + "proguard-rules.pro" + ) + } + } + // flavors + flavorDimensions += "base" + productFlavors { + create("fail-test") { + // To test System.loadLibrary("mpd") failure + // exclude the native lib from the package + packaging { + jniLibs { + // it appears the 'excludes' is applied to all flavors + // even if it's only inside this flavor. + // this filters by task name to apply the exclusion only + // for this flavor name. + // (clearing the 'abiFilters' will only create a universal apk + // with all of the abi versions) + gradle.startParameter.getTaskNames().forEach { task -> + if (task.contains("fail-test", ignoreCase = true)) { + println("NOTICE: excluding libmpd.so from package $task for testing") + excludes += "**/libmpd.so" + } + } + } + } + } + create("arm64-v8a") { + ndk { + // ABI to include in package + //noinspection ChromeOsAbiSupport + abiFilters += listOf("arm64-v8a") + } + } + create("x86_64") { + ndk { + // ABI to include in package + abiFilters += listOf("x86_64") + } + } + create("universal") { + ndk { + // ABI to include in package + abiFilters += listOf("arm64-v8a", "x86_64") + } + } + } + compileOptions { + sourceCompatibility = JavaVersion.VERSION_1_9 + targetCompatibility = JavaVersion.VERSION_1_9 + } + kotlinOptions { + jvmTarget = JavaVersion.VERSION_1_9.toString() + } + packaging { + resources { + excludes += "/META-INF/{AL2.0,LGPL2.1}" + } + } +} + +dependencies { + implementation(libs.androidx.lifecycle.runtime.ktx) + implementation(platform(libs.androidx.compose.bom)) + + implementation(libs.androidx.material3) + implementation(libs.androidx.activity.compose) + implementation(libs.androidx.material.icons.extended) + implementation(libs.androidx.lifecycle.viewmodel.compose) + implementation(libs.androidx.lifecycle.runtime.compose) + implementation(libs.androidx.navigation.compose) + + implementation(libs.compose.settings.ui.m3) + implementation(libs.compose.settings.storage.preferences) + implementation(libs.accompanist.permissions) + + implementation(libs.hilt.android) + ksp(libs.dagger.compiler) + ksp(libs.hilt.compiler) + + implementation(libs.androidx.media3.session) + + // Android Studio Preview support + implementation(libs.androidx.ui.tooling.preview) + debugImplementation(libs.androidx.ui.tooling) + debugImplementation(libs.androidx.ui.test.manifest) + + implementation(libs.androidx.appcompat) +} diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..7cdbb5e --- /dev/null +++ b/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/android/app/src/main/aidl/org/musicpd/IMain.aidl b/android/app/src/main/aidl/org/musicpd/IMain.aidl new file mode 100644 index 0000000..4eaf577 --- /dev/null +++ b/android/app/src/main/aidl/org/musicpd/IMain.aidl @@ -0,0 +1,13 @@ +package org.musicpd; +import org.musicpd.IMainCallback; + +interface IMain +{ + void start(); + void stop(); + void setPauseOnHeadphonesDisconnect(boolean enabled); + void setWakelockEnabled(boolean enabled); + boolean isRunning(); + void registerCallback(IMainCallback cb); + void unregisterCallback(IMainCallback cb); +} diff --git a/android/app/src/main/aidl/org/musicpd/IMainCallback.aidl b/android/app/src/main/aidl/org/musicpd/IMainCallback.aidl new file mode 100644 index 0000000..21e435d --- /dev/null +++ b/android/app/src/main/aidl/org/musicpd/IMainCallback.aidl @@ -0,0 +1,8 @@ +package org.musicpd; + +interface IMainCallback +{ + void onStarted(); + void onStopped(); + void onError(String error); +} diff --git a/android/app/src/main/ic_launcher-playstore.png b/android/app/src/main/ic_launcher-playstore.png new file mode 100644 index 0000000..9c27e1a Binary files /dev/null and b/android/app/src/main/ic_launcher-playstore.png differ diff --git a/android/app/src/main/java/org/musicpd/AutomationReceiver.kt b/android/app/src/main/java/org/musicpd/AutomationReceiver.kt new file mode 100644 index 0000000..c1a31dc --- /dev/null +++ b/android/app/src/main/java/org/musicpd/AutomationReceiver.kt @@ -0,0 +1,24 @@ +package org.musicpd + +import android.content.BroadcastReceiver +import android.content.Context +import android.content.Intent + +class AutomationReceiver : BroadcastReceiver() { + override fun onReceive(context: Context, intent: Intent) { + + when(intent.action) { + "org.musicpd.action.StartService" -> { + val wakelock = Preferences.getBoolean( + context, + Preferences.KEY_WAKELOCK, false + ) + Main.startService(context, wakelock) + } + "org.musicpd.action.StopService" -> { + context.startService(Intent(context, Main::class.java) + .setAction(Main.SHUTDOWN_ACTION)) + } + } + } +} diff --git a/android/app/src/main/java/org/musicpd/Bridge.java b/android/app/src/main/java/org/musicpd/Bridge.java new file mode 100644 index 0000000..24b50f8 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/Bridge.java @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +// Copyright The Music Player Daemon Project + +package org.musicpd; + +import android.content.Context; + +/** + * Bridge to native code. + */ +public class Bridge { + + /* used by jni */ + public interface LogListener { + public void onLog(int priority, String msg); + } + + public static native void run(Context context, LogListener logListener); + public static native void shutdown(); + public static native void pause(); + public static native void playPause(); + public static native void playNext(); + public static native void playPrevious(); +} diff --git a/android/app/src/main/java/org/musicpd/Loader.kt b/android/app/src/main/java/org/musicpd/Loader.kt new file mode 100644 index 0000000..2d89d43 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/Loader.kt @@ -0,0 +1,45 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +// Copyright The Music Player Daemon Project +package org.musicpd + +import android.content.Context +import android.os.Build +import android.util.Log + +object Loader { + private const val TAG = "Loader" + + private var loaded: Boolean = false + private var error: String? = null + private val failReason: String get() = error ?: "" + + val isLoaded: Boolean get() = loaded + + init { + load() + } + + private fun load() { + if (loaded) return + loaded = try { + error = null + System.loadLibrary("mpd") + Log.i(TAG, "mpd lib loaded") + true + } catch (e: Throwable) { + error = e.message ?: e.javaClass.simpleName + Log.e(TAG, "failed to load mpd lib: $failReason") + false + } + } + + fun loadFailureMessage(context: Context): String { + return context.getString( + R.string.mpd_load_failure_message, + Build.SUPPORTED_ABIS.joinToString(), + Build.PRODUCT, + Build.FINGERPRINT, + failReason + ) + } +} diff --git a/android/app/src/main/java/org/musicpd/MPDApplication.kt b/android/app/src/main/java/org/musicpd/MPDApplication.kt new file mode 100644 index 0000000..94d8709 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/MPDApplication.kt @@ -0,0 +1,9 @@ +package org.musicpd + +import android.app.Application +import dagger.hilt.android.HiltAndroidApp + +@HiltAndroidApp +class MPDApplication : Application() { + +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/MPDPlayer.java b/android/app/src/main/java/org/musicpd/MPDPlayer.java new file mode 100644 index 0000000..9e51f3d --- /dev/null +++ b/android/app/src/main/java/org/musicpd/MPDPlayer.java @@ -0,0 +1,76 @@ +package org.musicpd; + +import android.annotation.SuppressLint; +import android.os.Looper; + +import androidx.annotation.NonNull; +import androidx.media3.common.Player; +import androidx.media3.common.SimpleBasePlayer; +import androidx.media3.common.util.UnstableApi; + +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; + +import java.util.Arrays; +import java.util.List; + +@UnstableApi +public class MPDPlayer extends SimpleBasePlayer { + + List placeholderItems; + public MPDPlayer(Looper looper) { + super(looper); + + // Dummy items to let us receive next and previous commands + MediaItemData item0 = new MediaItemData.Builder(0) + .build(); + MediaItemData item1 = new MediaItemData.Builder(1) + .build(); + MediaItemData item2 = new MediaItemData.Builder(2) + .build(); + MediaItemData[] items = new MediaItemData[] { item0, item1, item2 }; + + placeholderItems = Arrays.asList(items); + } + + @NonNull + @Override + protected State getState() { + Commands commands = new Commands.Builder().addAll( + COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM, + COMMAND_SEEK_TO_NEXT_MEDIA_ITEM, + COMMAND_PLAY_PAUSE + ).build(); + + return new State.Builder() + .setAvailableCommands(commands) + .setPlaybackState(Player.STATE_READY) + .setPlaylist(placeholderItems) + .setCurrentMediaItemIndex(1) + .build(); + } + + @NonNull + @Override + protected ListenableFuture handleSetPlayWhenReady(boolean playWhenReady) { + Bridge.playPause(); + return Futures.immediateVoidFuture(); + } + + @NonNull + @SuppressLint("SwitchIntDef") + @Override + protected ListenableFuture handleSeek(int mediaItemIndex, long positionMs, int seekCommand) { + switch (seekCommand) { + case COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM: + case COMMAND_SEEK_TO_PREVIOUS: + Bridge.playPrevious(); + break; + case COMMAND_SEEK_TO_NEXT_MEDIA_ITEM: + case COMMAND_SEEK_TO_NEXT: + Bridge.playNext(); + break; + } + return Futures.immediateVoidFuture(); + } +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/Main.kt b/android/app/src/main/java/org/musicpd/Main.kt new file mode 100644 index 0000000..b7037fe --- /dev/null +++ b/android/app/src/main/java/org/musicpd/Main.kt @@ -0,0 +1,326 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +// Copyright The Music Player Daemon Project +package org.musicpd + +import android.app.Notification +import android.app.NotificationManager +import android.app.PendingIntent +import android.app.Service +import android.content.BroadcastReceiver +import android.content.Context +import android.content.Intent +import android.content.IntentFilter +import android.media.AudioManager +import android.os.Build +import android.os.IBinder +import android.os.Looper +import android.os.PowerManager +import android.os.PowerManager.WakeLock +import android.os.RemoteCallbackList +import android.os.RemoteException +import android.util.Log +import androidx.annotation.OptIn +import androidx.core.app.ServiceCompat +import androidx.media3.common.util.UnstableApi +import androidx.media3.session.MediaSession +import dagger.hilt.android.AndroidEntryPoint +import org.musicpd.Bridge.LogListener +import org.musicpd.data.LoggingRepository +import java.lang.reflect.Constructor +import javax.inject.Inject + +@AndroidEntryPoint +class Main : Service(), Runnable { + companion object { + private const val TAG = "Main" + private const val WAKELOCK_TAG = "mpd:wakelockmain" + + private const val MAIN_STATUS_ERROR = -1 + private const val MAIN_STATUS_STOPPED = 0 + private const val MAIN_STATUS_STARTED = 1 + + private const val MSG_SEND_STATUS = 0 + + const val SHUTDOWN_ACTION: String = "org.musicpd.action.ShutdownMPD" + + /* + * start Main service without any callback + */ + @JvmStatic + fun startService(context: Context, wakelock: Boolean) { + val intent = Intent(context, Main::class.java) + .putExtra("wakelock", wakelock) + + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) /* in Android 8+, we need to use this method + or else we'll get "IllegalStateException: + app is in background" */ + context.startForegroundService(intent) + else context.startService(intent) + } + } + + private lateinit var mpdApp: MPDApplication + private lateinit var mpdLoader: Loader + + private var mThread: Thread? = null + private var mStatus = MAIN_STATUS_STOPPED + private var mAbort = false + private var mError: String? = null + private val mCallbacks = RemoteCallbackList() + private val mBinder: IBinder = MainStub(this) + private var mPauseOnHeadphonesDisconnect = false + private var mWakelock: WakeLock? = null + + private var mMediaSession: MediaSession? = null + + @JvmField + @Inject + var logging: LoggingRepository? = null + + internal class MainStub(private val mService: Main) : IMain.Stub() { + override fun start() { + mService.start() + } + + override fun stop() { + mService.stop() + } + + override fun setPauseOnHeadphonesDisconnect(enabled: Boolean) { + mService.setPauseOnHeadphonesDisconnect(enabled) + } + + override fun setWakelockEnabled(enabled: Boolean) { + mService.setWakelockEnabled(enabled) + } + + override fun isRunning(): Boolean { + return mService.isRunning + } + + override fun registerCallback(cb: IMainCallback) { + mService.registerCallback(cb) + } + + override fun unregisterCallback(cb: IMainCallback) { + mService.unregisterCallback(cb) + } + } + + override fun onCreate() { + super.onCreate() + mpdLoader = Loader + } + + @Synchronized + private fun sendMessage( + @Suppress("SameParameterValue") what: Int, + arg1: Int, + arg2: Int, + obj: Any? + ) { + var i = mCallbacks.beginBroadcast() + while (i > 0) { + i-- + val cb = mCallbacks.getBroadcastItem(i) + try { + when (what) { + MSG_SEND_STATUS -> when (arg1) { + MAIN_STATUS_ERROR -> cb.onError(obj as String?) + MAIN_STATUS_STOPPED -> cb.onStopped() + MAIN_STATUS_STARTED -> cb.onStarted() + } + } + } catch (ignored: RemoteException) { + } + } + mCallbacks.finishBroadcast() + } + + private val mLogListener = LogListener { priority, msg -> + logging?.addLogItem(priority, msg) + } + + override fun onBind(intent: Intent): IBinder { + return mBinder + } + + override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int { + if (intent?.action == SHUTDOWN_ACTION) { + stop() + } else { + start() + if (intent?.getBooleanExtra( + "wakelock", + false + ) == true + ) setWakelockEnabled(true) + } + return START_REDELIVER_INTENT + } + + override fun run() { + synchronized(this) { + if (mAbort) return + setStatus(MAIN_STATUS_STARTED, null) + } + Bridge.run(this, mLogListener) + setStatus(MAIN_STATUS_STOPPED, null) + } + + @Synchronized + private fun setStatus(status: Int, error: String?) { + mStatus = status + mError = error + sendMessage(MSG_SEND_STATUS, mStatus, 0, mError) + } + + private fun createNotificationBuilderWithChannel(): Notification.Builder? { + val notificationManager = getSystemService(NOTIFICATION_SERVICE) as? NotificationManager + ?: return null + + val id = "org.musicpd" + val name = "MPD service" + val importance = 3 /* NotificationManager.IMPORTANCE_DEFAULT */ + + try { + val ncClass = Class.forName("android.app.NotificationChannel") + val ncCtor = ncClass.getConstructor( + String::class.java, + CharSequence::class.java, + Int::class.javaPrimitiveType + ) + val nc = ncCtor.newInstance(id, name, importance) + + val nmCreateNotificationChannelMethod = + NotificationManager::class.java.getMethod("createNotificationChannel", ncClass) + nmCreateNotificationChannelMethod.invoke(notificationManager, nc) + + val nbCtor: Constructor<*> = Notification.Builder::class.java.getConstructor( + Context::class.java, String::class.java + ) + return nbCtor.newInstance(this, id) as Notification.Builder + } catch (e: Exception) { + Log.e(TAG, "error creating the NotificationChannel", e) + return null + } + } + + @OptIn(markerClass = [UnstableApi::class]) + private fun start() { + if (mThread != null) return + + val filter = IntentFilter() + filter.addAction(AudioManager.ACTION_AUDIO_BECOMING_NOISY) + registerReceiver(object : BroadcastReceiver() { + override fun onReceive(context: Context, intent: Intent) { + if (!mPauseOnHeadphonesDisconnect) return + if (intent.action === AudioManager.ACTION_AUDIO_BECOMING_NOISY) pause() + } + }, filter) + + val mainIntent = Intent(this, MainActivity::class.java) + mainIntent.setAction("android.intent.action.MAIN") + mainIntent.addCategory("android.intent.category.LAUNCHER") + val contentIntent = PendingIntent.getActivity( + this, 0, + mainIntent, PendingIntent.FLAG_CANCEL_CURRENT or PendingIntent.FLAG_IMMUTABLE + ) + + val nBuilder: Notification.Builder? + if (Build.VERSION.SDK_INT >= 26 /* Build.VERSION_CODES.O */) { + nBuilder = createNotificationBuilderWithChannel() + if (nBuilder == null) return + } else nBuilder = Notification.Builder(this) + + val notification = + nBuilder.setContentTitle(getText(R.string.notification_title_mpd_running)) + .setContentText(getText(R.string.notification_text_mpd_running)) + .setSmallIcon(R.drawable.notification_icon) + .setContentIntent(contentIntent) + .build() + + if (mpdLoader.isLoaded) { + mThread = Thread(this).apply { start() } + } + + val player = MPDPlayer(Looper.getMainLooper()) + mMediaSession = MediaSession.Builder(this, player).build() + + startForeground(R.string.notification_title_mpd_running, notification) + startService(Intent(this, Main::class.java)) + } + + private fun stop() { + mMediaSession?.let { + it.release() + mMediaSession = null + } + mThread?.let { thread -> + if (thread.isAlive) { + synchronized(this) { + if (mStatus == MAIN_STATUS_STARTED) Bridge.shutdown() + else mAbort = true + } + } + try { + thread.join() + mThread = null + mAbort = false + } catch (ie: InterruptedException) { + Log.e(TAG, "failed to join", ie) + } + } + setWakelockEnabled(false) + ServiceCompat.stopForeground(this, ServiceCompat.STOP_FOREGROUND_REMOVE) + stopSelf() + } + + private fun pause() { + if (mThread?.isAlive == true) { + synchronized(this) { + if (mStatus == MAIN_STATUS_STARTED) Bridge.pause() + } + } + } + + private fun setPauseOnHeadphonesDisconnect(enabled: Boolean) { + mPauseOnHeadphonesDisconnect = enabled + } + + private fun setWakelockEnabled(enabled: Boolean) { + if (enabled) { + val wakeLock = + mWakelock ?: run { + val pm = getSystemService(POWER_SERVICE) as PowerManager + pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, WAKELOCK_TAG).also { + mWakelock = it + } + } + wakeLock.acquire(10 * 60 * 1000L /*10 minutes*/) + Log.d(TAG, "Wakelock acquired") + } else { + mWakelock?.let { + it.release() + mWakelock = null + } + Log.d(TAG, "Wakelock released") + } + } + + private val isRunning: Boolean + get() = mThread?.isAlive == true + + private fun registerCallback(cb: IMainCallback?) { + if (cb != null) { + mCallbacks.register(cb) + sendMessage(MSG_SEND_STATUS, mStatus, 0, mError) + } + } + + private fun unregisterCallback(cb: IMainCallback?) { + if (cb != null) { + mCallbacks.unregister(cb) + } + } +} diff --git a/android/app/src/main/java/org/musicpd/MainActivity.kt b/android/app/src/main/java/org/musicpd/MainActivity.kt new file mode 100644 index 0000000..de5ae80 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/MainActivity.kt @@ -0,0 +1,57 @@ +package org.musicpd + +import android.os.Bundle +import androidx.activity.ComponentActivity +import androidx.activity.compose.setContent +import androidx.activity.viewModels +import androidx.compose.material3.MaterialTheme +import androidx.core.view.WindowCompat +import dagger.hilt.android.AndroidEntryPoint +import org.musicpd.ui.MPDApp +import org.musicpd.ui.SettingsViewModel + +@AndroidEntryPoint +class MainActivity : ComponentActivity() { + private val settingsViewModel: SettingsViewModel by viewModels() + + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + WindowCompat.setDecorFitsSystemWindows(window, false) + setContent { + MaterialTheme { + MPDApp(settingsViewModel = settingsViewModel) + } + } + } + + private fun connectClient() { + val client = MainServiceClient(this, object : MainServiceClient.Callback { + override fun onStopped() { + settingsViewModel.updateStatus("", false) + } + + override fun onStarted() { + settingsViewModel.updateStatus("MPD Service Started", true) + } + + override fun onError(error: String) { + settingsViewModel.removeClient() + settingsViewModel.updateStatus(error, false) + connectClient() + } + }) + + settingsViewModel.setClient(client) + } + + override fun onStart() { + //mFirstRun = false + connectClient() + super.onStart() + } + + override fun onStop() { + settingsViewModel.removeClient() + super.onStop() + } +} diff --git a/android/app/src/main/java/org/musicpd/MainServiceClient.java b/android/app/src/main/java/org/musicpd/MainServiceClient.java new file mode 100644 index 0000000..e943649 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/MainServiceClient.java @@ -0,0 +1,157 @@ +package org.musicpd; + +import android.content.ComponentName; +import android.content.Context; +import android.content.Intent; +import android.content.ServiceConnection; +import android.os.IBinder; +import android.os.RemoteException; + + +/* + * Client that bind the Main Service in order to send commands and receive callback + */ +public class MainServiceClient { + + private static final String REMOTE_ERROR = "MPD process was killed"; + + public interface Callback { + public void onStarted(); + public void onStopped(); + public void onError(String error); + } + + private boolean mBound = false; + private final Context mContext; + private Callback mCallback; + private IMain mIMain = null; + + private final IMainCallback.Stub mICallback = new IMainCallback.Stub() { + + @Override + public void onStopped() throws RemoteException { + mCallback.onStopped(); + } + + @Override + public void onStarted() throws RemoteException { + mCallback.onStarted(); + } + + @Override + public void onError(String error) throws RemoteException { + mCallback.onError(error); + } + }; + + private final ServiceConnection mServiceConnection = new ServiceConnection() { + + @Override + public void onServiceConnected(ComponentName name, IBinder service) { + synchronized (this) { + mIMain = IMain.Stub.asInterface(service); + try { + if (mCallback != null) + mIMain.registerCallback(mICallback); + } catch (RemoteException e) { + if (mCallback != null) + mCallback.onError(REMOTE_ERROR); + } + } + } + + @Override + public void onServiceDisconnected(ComponentName name) { + if (mCallback != null) + mCallback.onError(REMOTE_ERROR); + } + }; + + public MainServiceClient(Context context, Callback cb) throws IllegalArgumentException { + if (context == null) + throw new IllegalArgumentException("Context can't be null"); + mContext = context; + mCallback = cb; + mBound = mContext.bindService(new Intent(mContext, Main.class), mServiceConnection, Context.BIND_AUTO_CREATE); + } + + public boolean start() { + synchronized (this) { + if (mIMain != null) { + try { + mIMain.start(); + return true; + } catch (RemoteException e) { + } + } + return false; + } + } + + public boolean stop() { + synchronized (this) { + if (mIMain != null) { + try { + mIMain.stop(); + return true; + } catch (RemoteException e) { + } + } + return false; + } + } + + public boolean setPauseOnHeadphonesDisconnect(boolean enabled) { + synchronized (this) { + if (mIMain != null) { + try { + mIMain.setPauseOnHeadphonesDisconnect(enabled); + return true; + } catch (RemoteException e) { + } + } + return false; + } + } + + public boolean setWakelockEnabled(boolean enabled) { + synchronized (this) { + if (mIMain != null) { + try { + mIMain.setWakelockEnabled(enabled); + return true; + } catch (RemoteException e) { + } + } + return false; + } + } + + public boolean isRunning() { + synchronized (this) { + if (mIMain != null) { + try { + return mIMain.isRunning(); + } catch (RemoteException e) { + } + } + return false; + } + } + + public void release() { + if (mBound) { + synchronized (this) { + if (mIMain != null && mICallback != null) { + try { + if (mCallback != null) + mIMain.unregisterCallback(mICallback); + } catch (RemoteException e) { + } + } + } + mBound = false; + mContext.unbindService(mServiceConnection); + } + } +} diff --git a/android/app/src/main/java/org/musicpd/NetworkUtil.java b/android/app/src/main/java/org/musicpd/NetworkUtil.java new file mode 100644 index 0000000..7f664ca --- /dev/null +++ b/android/app/src/main/java/org/musicpd/NetworkUtil.java @@ -0,0 +1,34 @@ +package org.musicpd; + +import android.content.Context; +import android.net.ConnectivityManager; +import android.net.LinkAddress; +import android.net.LinkProperties; + +import androidx.annotation.Nullable; + +import java.net.Inet4Address; +import java.net.InetAddress; +import java.util.List; + +public class NetworkUtil { + + @Nullable + public static String getDeviceIPV4Address(Context context) { + ConnectivityManager connectivityManager = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE); + LinkProperties linkProperties = connectivityManager.getLinkProperties(connectivityManager.getActiveNetwork()); + if (linkProperties != null) { + List linkAddresses = linkProperties.getLinkAddresses(); + for (LinkAddress address : linkAddresses) { + if (!address.getAddress().isLinkLocalAddress() && !address.getAddress().isLoopbackAddress()) { + InetAddress address1 = address.getAddress(); + if (address1 instanceof Inet4Address) { + return address1.getHostAddress(); + } + } + } + } + + return null; + } +} diff --git a/android/app/src/main/java/org/musicpd/Preferences.java b/android/app/src/main/java/org/musicpd/Preferences.java new file mode 100644 index 0000000..61eca83 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/Preferences.java @@ -0,0 +1,34 @@ +package org.musicpd; + +import static android.content.Context.MODE_PRIVATE; + +import android.content.Context; +import android.content.SharedPreferences; + +public class Preferences { + private static final String TAG = "Settings"; + + public static final String KEY_RUN_ON_BOOT ="run_on_boot"; + public static final String KEY_WAKELOCK ="wakelock"; + public static final String KEY_PAUSE_ON_HEADPHONES_DISCONNECT ="pause_on_headphones_disconnect"; + + public static SharedPreferences get(Context context) { + return context.getSharedPreferences(TAG, MODE_PRIVATE); + } + + public static void putBoolean(Context context, String key, boolean value) { + final SharedPreferences prefs = get(context); + + if (prefs == null) + return; + final SharedPreferences.Editor editor = prefs.edit(); + editor.putBoolean(key, value); + editor.apply(); + } + + public static boolean getBoolean(Context context, String key, boolean defValue) { + final SharedPreferences prefs = get(context); + + return prefs != null ? prefs.getBoolean(key, defValue) : defValue; + } +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/Receiver.java b/android/app/src/main/java/org/musicpd/Receiver.java new file mode 100644 index 0000000..92a6513 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/Receiver.java @@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +// Copyright The Music Player Daemon Project + +package org.musicpd; + +import android.content.BroadcastReceiver; +import android.content.Context; +import android.content.Intent; +import android.util.Log; + +import java.util.Set; + +public class Receiver extends BroadcastReceiver { + + private static final Set BOOT_ACTIONS = Set.of( + "android.intent.action.BOOT_COMPLETED", + "android.intent.action.QUICKBOOT_POWERON" + ); + + @Override + public void onReceive(Context context, Intent intent) { + Log.d("Receiver", "onReceive: " + intent); + if (BOOT_ACTIONS.contains(intent.getAction())) { + if (Preferences.getBoolean(context, + Preferences.KEY_RUN_ON_BOOT, + false)) { + final boolean wakelock = + Preferences.getBoolean(context, + Preferences.KEY_WAKELOCK, false); + Main.startService(context, wakelock); + } + } + } +} diff --git a/android/app/src/main/java/org/musicpd/data/LoggingRepository.kt b/android/app/src/main/java/org/musicpd/data/LoggingRepository.kt new file mode 100644 index 0000000..9e5dd90 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/data/LoggingRepository.kt @@ -0,0 +1,34 @@ +package org.musicpd.data + +import android.util.Log +import kotlinx.coroutines.flow.MutableStateFlow +import kotlinx.coroutines.flow.StateFlow +import javax.inject.Inject +import javax.inject.Singleton + +private const val MAX_LOGS = 500 + +@Singleton +class LoggingRepository @Inject constructor() { + + private val _logItemFLow = MutableStateFlow(listOf()) + val logItemFLow: StateFlow> = _logItemFLow + + fun addLogItem(priority: Int, message: String) { + if (_logItemFLow.value.size > MAX_LOGS) { + _logItemFLow.value = _logItemFLow.value.drop(1) + } + + val priorityString: String = when (priority) { + Log.DEBUG -> "D" + Log.ERROR -> "E" + Log.INFO -> "I" + Log.VERBOSE -> "V" + Log.WARN -> "W" + else -> "" + } + + _logItemFLow.value = _logItemFLow.value + ("$priorityString/$message") + } + +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/ui/LogScreen.kt b/android/app/src/main/java/org/musicpd/ui/LogScreen.kt new file mode 100644 index 0000000..d766688 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/ui/LogScreen.kt @@ -0,0 +1,79 @@ +package org.musicpd.ui + +import androidx.compose.foundation.layout.Box +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.lazy.LazyColumn +import androidx.compose.foundation.lazy.items +import androidx.compose.foundation.lazy.rememberLazyListState +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.filled.VerticalAlignBottom +import androidx.compose.material3.FloatingActionButton +import androidx.compose.material3.Icon +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.runtime.LaunchedEffect +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.remember +import androidx.compose.runtime.snapshotFlow +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.text.font.FontFamily +import androidx.compose.ui.tooling.preview.Preview +import androidx.compose.ui.unit.dp +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.launch + +@Composable +fun LogView(messages: List) { + val lazyListState = rememberLazyListState() + + var userScrolled = remember { mutableStateOf(false) } + + LaunchedEffect(lazyListState) { + snapshotFlow { lazyListState.isScrollInProgress } + .collect { + if (it) { + userScrolled.value = true + } + } + } + + Box(Modifier.fillMaxSize()) { + LazyColumn( + Modifier.padding(4.dp), + lazyListState + ) { + items(messages) { message -> + Text(text = message, fontFamily = FontFamily.Monospace) + } + CoroutineScope(Dispatchers.Main).launch { + lazyListState.scrollToItem(messages.count(), 0) + } + } + + if (lazyListState.canScrollForward) { + FloatingActionButton( + onClick = { + userScrolled.value = false + CoroutineScope(Dispatchers.Main).launch { + lazyListState.scrollToItem(messages.count(), 0) + } + }, + modifier = Modifier.padding(16.dp).align(Alignment.BottomEnd) + ) { + Icon(Icons.Filled.VerticalAlignBottom, "Scroll to bottom icon") + } + } + } +} + +@Preview +@Composable +fun LogViewPreview() { + val data = listOf("test", + "test2", + "test3") + LogView(data) +} diff --git a/android/app/src/main/java/org/musicpd/ui/MainScreen.kt b/android/app/src/main/java/org/musicpd/ui/MainScreen.kt new file mode 100644 index 0000000..5c538f2 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/ui/MainScreen.kt @@ -0,0 +1,109 @@ +package org.musicpd.ui + +import androidx.compose.foundation.layout.padding +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.automirrored.filled.List +import androidx.compose.material.icons.filled.Home +import androidx.compose.material.icons.filled.Settings +import androidx.compose.material3.Icon +import androidx.compose.material3.NavigationBar +import androidx.compose.material3.NavigationBarItem +import androidx.compose.material3.Scaffold +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.runtime.getValue +import androidx.compose.ui.Modifier +import androidx.compose.ui.graphics.vector.ImageVector +import androidx.lifecycle.compose.collectAsStateWithLifecycle +import androidx.lifecycle.viewmodel.compose.viewModel +import androidx.navigation.NavController +import androidx.navigation.NavHostController +import androidx.navigation.compose.NavHost +import androidx.navigation.compose.composable +import androidx.navigation.compose.currentBackStackEntryAsState +import androidx.navigation.compose.rememberNavController + +enum class Screen { + HOME, + LOGS, + SETTINGS, +} +sealed class NavigationItem(val route: String, val label: String, val icon: ImageVector) { + data object Home : NavigationItem( + Screen.HOME.name, + "Home", + Icons.Default.Home + ) + data object Logs : NavigationItem( + Screen.LOGS.name, + "Logs", + Icons.AutoMirrored.Filled.List) + data object Settings : NavigationItem( + Screen.SETTINGS.name, + "Settings", + Icons.Default.Settings) +} + +@Composable +fun MPDApp( + navController: NavHostController = rememberNavController(), + settingsViewModel: SettingsViewModel = viewModel() +) { + Scaffold( + topBar = { + + }, + bottomBar = { + BottomNavigationBar(navController) + }, + ) { innerPadding -> + NavHost( + navController = navController, + startDestination = NavigationItem.Home.route, + modifier = Modifier.padding(innerPadding) + ) { + composable(NavigationItem.Home.route) { + StatusScreen(settingsViewModel) + } + composable(NavigationItem.Logs.route) { + LogView(settingsViewModel.getLogs().collectAsStateWithLifecycle().value) + } + composable(NavigationItem.Settings.route) { + MPDSettings(settingsViewModel) + } + } + } +} + +@Composable +fun BottomNavigationBar(navController: NavController) { + val navBackStackEntry by navController.currentBackStackEntryAsState() + val currentRoute = navBackStackEntry?.destination?.route + + val items = listOf( + NavigationItem.Home, + NavigationItem.Logs, + NavigationItem.Settings, + ) + + NavigationBar { + items.forEach { item -> + NavigationBarItem( + icon = { + Icon( + imageVector = item.icon, + contentDescription = null + ) + }, + label = { Text (item.label) }, + onClick = { + navController.navigate(item.route) { + popUpTo(navController.graph.startDestinationId) + launchSingleTop = true + } + }, + selected = currentRoute == item.route, + ) + } + } +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/ui/NetworkAddress.kt b/android/app/src/main/java/org/musicpd/ui/NetworkAddress.kt new file mode 100644 index 0000000..fd387ca --- /dev/null +++ b/android/app/src/main/java/org/musicpd/ui/NetworkAddress.kt @@ -0,0 +1,39 @@ +package org.musicpd.ui + +import android.app.Application +import androidx.compose.foundation.layout.Arrangement +import androidx.compose.foundation.layout.Row +import androidx.compose.foundation.layout.Spacer +import androidx.compose.foundation.layout.fillMaxWidth +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.layout.size +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.filled.Wifi +import androidx.compose.material3.Icon +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.unit.dp +import org.musicpd.NetworkUtil + +@Composable +fun NetworkAddress() { + val address = NetworkUtil.getDeviceIPV4Address(LocalContext.current) + val padding = 4.dp + Row( + Modifier + .padding(padding) + .fillMaxWidth(), + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.Center + ) { + Icon( + imageVector = Icons.Default.Wifi, + contentDescription = "Wifi") + Spacer(Modifier.size(padding)) + Text(text = address ?: "") + } +} + diff --git a/android/app/src/main/java/org/musicpd/ui/SettingsScreen.kt b/android/app/src/main/java/org/musicpd/ui/SettingsScreen.kt new file mode 100644 index 0000000..2ae0db9 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/ui/SettingsScreen.kt @@ -0,0 +1,77 @@ +package org.musicpd.ui + +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.filled.BatteryAlert +import androidx.compose.material.icons.filled.Headphones +import androidx.compose.material.icons.filled.PowerSettingsNew +import androidx.compose.material3.Icon +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.ui.Modifier +import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.res.stringResource +import com.alorma.compose.settings.storage.preferences.rememberPreferenceBooleanSettingState +import com.alorma.compose.settings.ui.SettingsSwitch +import org.musicpd.Preferences +import org.musicpd.R + +@Composable +fun MPDSettings(settingsViewModel: SettingsViewModel) { + val context = LocalContext.current + + Column(Modifier.fillMaxSize()) { + SettingsOptions( + onBootChanged = { newValue -> + if (newValue) { + settingsViewModel.startMPD(context) + } + }, + onWakeLockChanged = { newValue -> + settingsViewModel.setWakelockEnabled(newValue) + }, + onHeadphonesChanged = { newValue -> + settingsViewModel.setPauseOnHeadphonesDisconnect(newValue) + } + ) + } +} + +@Composable +fun SettingsOptions( + onBootChanged: (Boolean) -> Unit, + onWakeLockChanged: (Boolean) -> Unit, + onHeadphonesChanged: (Boolean) -> Unit +) { + val bootState = rememberPreferenceBooleanSettingState( + key = Preferences.KEY_RUN_ON_BOOT, + defaultValue = false + ) + val wakelockState = + rememberPreferenceBooleanSettingState(key = Preferences.KEY_WAKELOCK, defaultValue = false) + val headphoneState = rememberPreferenceBooleanSettingState( + key = Preferences.KEY_PAUSE_ON_HEADPHONES_DISCONNECT, + defaultValue = false + ) + + SettingsSwitch( + icon = { Icon(imageVector = Icons.Default.PowerSettingsNew, contentDescription = "Power") }, + title = { Text(text = stringResource(R.string.checkbox_run_on_boot)) }, + onCheckedChange = onBootChanged, + state = bootState + ) + SettingsSwitch( + icon = { Icon(imageVector = Icons.Default.BatteryAlert, contentDescription = "Battery") }, + title = { Text(text = stringResource(R.string.checkbox_wakelock)) }, + onCheckedChange = onWakeLockChanged, + state = wakelockState + ) + SettingsSwitch( + icon = { Icon(imageVector = Icons.Default.Headphones, contentDescription = "Headphones") }, + title = { Text(text = stringResource(R.string.checkbox_pause_on_headphones_disconnect)) }, + onCheckedChange = onHeadphonesChanged, + state = headphoneState + ) + +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/ui/SettingsViewModel.kt b/android/app/src/main/java/org/musicpd/ui/SettingsViewModel.kt new file mode 100644 index 0000000..c6f06ef --- /dev/null +++ b/android/app/src/main/java/org/musicpd/ui/SettingsViewModel.kt @@ -0,0 +1,73 @@ +package org.musicpd.ui + +import android.content.Context +import androidx.lifecycle.ViewModel +import dagger.hilt.android.lifecycle.HiltViewModel +import kotlinx.coroutines.flow.MutableStateFlow +import kotlinx.coroutines.flow.StateFlow +import kotlinx.coroutines.flow.asStateFlow +import org.musicpd.Loader +import org.musicpd.MainServiceClient +import org.musicpd.Preferences +import org.musicpd.data.LoggingRepository +import javax.inject.Inject + + +@HiltViewModel +class SettingsViewModel @Inject constructor( + private var loggingRepository: LoggingRepository +) : ViewModel() { + private var mClient: MainServiceClient? = null + val mpdLoader = Loader + + data class StatusUiState( + val statusMessage: String = "", + val running: Boolean = false + ) + + private val _statusUIState = MutableStateFlow(StatusUiState()) + val statusUIState: StateFlow = _statusUIState.asStateFlow() + + fun getLogs(): StateFlow> { + return loggingRepository.logItemFLow + } + + fun updateStatus(message: String, running: Boolean) { + _statusUIState.value = StatusUiState(message, running) + } + + fun setClient(client: MainServiceClient) { + mClient = client + } + + fun removeClient() { + mClient?.release() + mClient = null + } + + fun startMPD(context: Context) { + mClient?.start() + if (Preferences.getBoolean( + context, + Preferences.KEY_WAKELOCK, false + ) + ) mClient?.setWakelockEnabled(true) + if (Preferences.getBoolean( + context, + Preferences.KEY_PAUSE_ON_HEADPHONES_DISCONNECT, false + ) + ) mClient?.setPauseOnHeadphonesDisconnect(true) + } + + fun stopMPD() { + mClient?.stop() + } + + fun setWakelockEnabled(enabled: Boolean) { + mClient?.setWakelockEnabled(enabled) + } + + fun setPauseOnHeadphonesDisconnect(enabled: Boolean) { + mClient?.setPauseOnHeadphonesDisconnect(enabled) + } +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/ui/StatusScreen.kt b/android/app/src/main/java/org/musicpd/ui/StatusScreen.kt new file mode 100644 index 0000000..cbd56a4 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/ui/StatusScreen.kt @@ -0,0 +1,188 @@ +package org.musicpd.ui + +import android.Manifest +import android.content.Context +import android.os.Build +import android.util.TypedValue +import androidx.annotation.AttrRes +import androidx.annotation.ColorInt +import androidx.compose.foundation.layout.Arrangement +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.Row +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.fillMaxWidth +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.text.selection.SelectionContainer +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.filled.Circle +import androidx.compose.material3.Button +import androidx.compose.material3.Icon +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.OutlinedButton +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.runtime.collectAsState +import androidx.compose.runtime.getValue +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.alpha +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.res.stringResource +import androidx.compose.ui.unit.dp +import com.google.accompanist.permissions.ExperimentalPermissionsApi +import com.google.accompanist.permissions.PermissionState +import com.google.accompanist.permissions.isGranted +import com.google.accompanist.permissions.rememberPermissionState +import com.google.accompanist.permissions.shouldShowRationale +import org.musicpd.R +import org.musicpd.utils.openAppSettings + +@OptIn(ExperimentalPermissionsApi::class) +@Composable +fun StatusScreen(settingsViewModel: SettingsViewModel) { + val storagePermissionState = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) { + rememberPermissionState( + Manifest.permission.READ_MEDIA_AUDIO + ) + } else { + rememberPermissionState( + Manifest.permission.READ_EXTERNAL_STORAGE + ) + } + + Column( + Modifier + .padding(4.dp) + .fillMaxSize(), + horizontalAlignment = Alignment.CenterHorizontally, + verticalArrangement = Arrangement.Center + ) { + NetworkAddress() + ServerStatus(settingsViewModel, storagePermissionState) + AudioMediaPermission(storagePermissionState) + MPDLoaderStatus(settingsViewModel) + } +} + +@ColorInt +fun getThemeColorAttribute(context: Context, @AttrRes attr: Int): Int { + val value = TypedValue() + if (context.theme.resolveAttribute(attr, value, true)) { + return value.data + } + return android.graphics.Color.BLACK +} + +@OptIn(ExperimentalPermissionsApi::class) +@Composable +fun ServerStatus(settingsViewModel: SettingsViewModel, storagePermissionState: PermissionState) { + val context = LocalContext.current + + val statusUiState by settingsViewModel.statusUIState.collectAsState() + + Column { + Row( + Modifier + .padding(4.dp) + .fillMaxWidth(), + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.SpaceEvenly + ) { + Row(verticalAlignment = Alignment.CenterVertically) { + Icon( + imageVector = Icons.Default.Circle, + contentDescription = "", + tint = Color( + getThemeColorAttribute( + context, + if (statusUiState.running) R.attr.appColorPositive else R.attr.appColorNegative + ) + ), + modifier = Modifier + .padding(end = 8.dp) + .alpha(0.6f) + ) + Text(text = stringResource(id = if (statusUiState.running) R.string.running else R.string.stopped)) + } + Button( + onClick = { + if (statusUiState.running) + settingsViewModel.stopMPD() + else + settingsViewModel.startMPD(context) + }, + enabled = settingsViewModel.mpdLoader.isLoaded + && storagePermissionState.status.isGranted + ) { + Text( + text = stringResource(id = if (statusUiState.running) R.string.stopMPD else R.string.startMPD) + ) + } + } + Row( + Modifier + .padding(4.dp) + .fillMaxWidth(), + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.SpaceEvenly + ) { + Text(text = statusUiState.statusMessage) + } + } +} + +@OptIn(ExperimentalPermissionsApi::class) +@Composable +fun AudioMediaPermission(storagePermissionState: PermissionState) { + val permissionStatus = storagePermissionState.status + if (!permissionStatus.isGranted) { + val context = LocalContext.current + Column( + Modifier + .padding(4.dp) + .fillMaxWidth(), + horizontalAlignment = Alignment.CenterHorizontally, + verticalArrangement = Arrangement.Center + ) { + Text( + stringResource(id = R.string.external_files_permission_request), + Modifier.padding(16.dp) + ) + if (storagePermissionState.status.shouldShowRationale) { + Button(onClick = { + storagePermissionState.launchPermissionRequest() + }) { + Text("Request permission") + } + } else { + OutlinedButton( + onClick = { + openAppSettings(context, context.packageName) + }, + Modifier.padding(16.dp) + ) { + Text( + stringResource(id = R.string.title_open_app_info), + color = MaterialTheme.colorScheme.secondary + ) + } + } + } + } +} + +@Composable +fun MPDLoaderStatus(settingsViewModel: SettingsViewModel) { + val loader = settingsViewModel.mpdLoader + if (!loader.isLoaded) { + val context = LocalContext.current + SelectionContainer { + Text( + loader.loadFailureMessage(context), + Modifier.padding(16.dp), + color = MaterialTheme.colorScheme.error + ) + } + } +} \ No newline at end of file diff --git a/android/app/src/main/java/org/musicpd/utils/IntentUtils.kt b/android/app/src/main/java/org/musicpd/utils/IntentUtils.kt new file mode 100644 index 0000000..b9a7512 --- /dev/null +++ b/android/app/src/main/java/org/musicpd/utils/IntentUtils.kt @@ -0,0 +1,32 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +// Copyright The Music Player Daemon Project +package org.musicpd.utils + +import android.content.ActivityNotFoundException +import android.content.Context +import android.content.Intent +import android.net.Uri +import android.provider.Settings +import android.util.Log + +private const val TAG = "IntentUtils" + +fun openAppSettings( + context: Context, + packageName: String +) { + try { + context.startActivity(Intent().apply { + setAction(Settings.ACTION_APPLICATION_DETAILS_SETTINGS) + setData(Uri.parse("package:$packageName")) + addCategory(Intent.CATEGORY_DEFAULT) + addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY) + addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS) + }) + } catch (e: ActivityNotFoundException) { + Log.e( + TAG, + "failed to open app settings for package: $packageName", e + ) + } +} diff --git a/android/app/src/main/res/drawable/baseline_wifi_24.xml b/android/app/src/main/res/drawable/baseline_wifi_24.xml new file mode 100644 index 0000000..dabd1f1 --- /dev/null +++ b/android/app/src/main/res/drawable/baseline_wifi_24.xml @@ -0,0 +1,5 @@ + + + diff --git a/android/app/src/main/res/drawable/ic_banner_foreground.xml b/android/app/src/main/res/drawable/ic_banner_foreground.xml new file mode 100644 index 0000000..42bded0 --- /dev/null +++ b/android/app/src/main/res/drawable/ic_banner_foreground.xml @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/android/app/src/main/res/drawable/ic_launcher_foreground.xml b/android/app/src/main/res/drawable/ic_launcher_foreground.xml new file mode 100644 index 0000000..d62cbb5 --- /dev/null +++ b/android/app/src/main/res/drawable/ic_launcher_foreground.xml @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/android/app/src/main/res/drawable/notification_icon.png b/android/app/src/main/res/drawable/notification_icon.png new file mode 100644 index 0000000..e77d87a Binary files /dev/null and b/android/app/src/main/res/drawable/notification_icon.png differ diff --git a/android/app/src/main/res/layout/custom_notification_gb.xml b/android/app/src/main/res/layout/custom_notification_gb.xml new file mode 100644 index 0000000..92a6036 --- /dev/null +++ b/android/app/src/main/res/layout/custom_notification_gb.xml @@ -0,0 +1,22 @@ + + + + + diff --git a/android/app/src/main/res/mipmap-anydpi-v26/ic_banner.xml b/android/app/src/main/res/mipmap-anydpi-v26/ic_banner.xml new file mode 100644 index 0000000..a0a0dec --- /dev/null +++ b/android/app/src/main/res/mipmap-anydpi-v26/ic_banner.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 0000000..7353dbd --- /dev/null +++ b/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 0000000..7353dbd --- /dev/null +++ b/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/android/app/src/main/res/mipmap-hdpi/ic_banner.png b/android/app/src/main/res/mipmap-hdpi/ic_banner.png new file mode 100644 index 0000000..6932f1f Binary files /dev/null and b/android/app/src/main/res/mipmap-hdpi/ic_banner.png differ diff --git a/android/app/src/main/res/mipmap-hdpi/ic_launcher.webp b/android/app/src/main/res/mipmap-hdpi/ic_launcher.webp new file mode 100644 index 0000000..a6f593b Binary files /dev/null and b/android/app/src/main/res/mipmap-hdpi/ic_launcher.webp differ diff --git a/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp b/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp new file mode 100644 index 0000000..d421470 Binary files /dev/null and b/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp differ diff --git a/android/app/src/main/res/mipmap-mdpi/ic_banner.png b/android/app/src/main/res/mipmap-mdpi/ic_banner.png new file mode 100644 index 0000000..23982b0 Binary files /dev/null and b/android/app/src/main/res/mipmap-mdpi/ic_banner.png differ diff --git a/android/app/src/main/res/mipmap-mdpi/ic_launcher.webp b/android/app/src/main/res/mipmap-mdpi/ic_launcher.webp new file mode 100644 index 0000000..b23f353 Binary files /dev/null and b/android/app/src/main/res/mipmap-mdpi/ic_launcher.webp differ diff --git a/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp b/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp new file mode 100644 index 0000000..4e3388e Binary files /dev/null and b/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp differ diff --git a/android/app/src/main/res/mipmap-xhdpi/ic_banner.png b/android/app/src/main/res/mipmap-xhdpi/ic_banner.png new file mode 100644 index 0000000..3d0c2fc Binary files /dev/null and b/android/app/src/main/res/mipmap-xhdpi/ic_banner.png differ diff --git a/android/app/src/main/res/mipmap-xhdpi/ic_launcher.webp b/android/app/src/main/res/mipmap-xhdpi/ic_launcher.webp new file mode 100644 index 0000000..7c4cbb4 Binary files /dev/null and b/android/app/src/main/res/mipmap-xhdpi/ic_launcher.webp differ diff --git a/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp b/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp new file mode 100644 index 0000000..a40719a Binary files /dev/null and b/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp differ diff --git a/android/app/src/main/res/mipmap-xxhdpi/ic_banner.png b/android/app/src/main/res/mipmap-xxhdpi/ic_banner.png new file mode 100644 index 0000000..03fc518 Binary files /dev/null and b/android/app/src/main/res/mipmap-xxhdpi/ic_banner.png differ diff --git a/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp b/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp new file mode 100644 index 0000000..be1eb31 Binary files /dev/null and b/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp differ diff --git a/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp b/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp new file mode 100644 index 0000000..2fd0829 Binary files /dev/null and b/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp differ diff --git a/android/app/src/main/res/mipmap-xxxhdpi/ic_banner.png b/android/app/src/main/res/mipmap-xxxhdpi/ic_banner.png new file mode 100644 index 0000000..30887f8 Binary files /dev/null and b/android/app/src/main/res/mipmap-xxxhdpi/ic_banner.png differ diff --git a/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp b/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp new file mode 100644 index 0000000..0297013 Binary files /dev/null and b/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp differ diff --git a/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp b/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp new file mode 100644 index 0000000..72ea5bc Binary files /dev/null and b/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp differ diff --git a/android/app/src/main/res/values/ic_banner_background.xml b/android/app/src/main/res/values/ic_banner_background.xml new file mode 100644 index 0000000..15db34b --- /dev/null +++ b/android/app/src/main/res/values/ic_banner_background.xml @@ -0,0 +1,4 @@ + + + #FFFFFF + \ No newline at end of file diff --git a/android/app/src/main/res/values/ic_launcher_background.xml b/android/app/src/main/res/values/ic_launcher_background.xml new file mode 100644 index 0000000..c5d5899 --- /dev/null +++ b/android/app/src/main/res/values/ic_launcher_background.xml @@ -0,0 +1,4 @@ + + + #FFFFFF + \ No newline at end of file diff --git a/android/app/src/main/res/values/strings.xml b/android/app/src/main/res/values/strings.xml new file mode 100644 index 0000000..6c47fa0 --- /dev/null +++ b/android/app/src/main/res/values/strings.xml @@ -0,0 +1,25 @@ + + + + MPD + Music Player Daemon is running + Touch for MPD options. + MPD is running + MPD is not running + Run MPD automatically on boot + Prevent suspend when MPD is running (Wakelock) + Pause MPD when headphones disconnect + MPD requires access to external files to play local music. Please grant the permission. + Open app info + "Failed to load the native MPD library. +Report this problem to us, and include the following information: +SUPPORTED_ABIS=%1$s +PRODUCT=%2$s +FINGERPRINT=%3$s +error=%4$s" + + Stopped + Running + Stop MPD + Start MPD + diff --git a/android/app/src/main/res/values/themes.xml b/android/app/src/main/res/values/themes.xml new file mode 100644 index 0000000..d53aa8c --- /dev/null +++ b/android/app/src/main/res/values/themes.xml @@ -0,0 +1,21 @@ + + + #F44336 + #B71C1C + #81C784 + #388E3C + + @color/red_900 + @color/red_500 + + @color/green_700 + @color/green_300 + + + + + + \ No newline at end of file diff --git a/android/build.gradle.kts b/android/build.gradle.kts new file mode 100644 index 0000000..4452473 --- /dev/null +++ b/android/build.gradle.kts @@ -0,0 +1,7 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. +plugins { + id("com.google.devtools.ksp") version "1.9.22-1.0.16" apply false + alias(libs.plugins.android.application) apply false + alias(libs.plugins.jetbrains.kotlin.android) apply false + alias(libs.plugins.dagger.hilt.android) apply false +} \ No newline at end of file diff --git a/android/build.py b/android/build.py new file mode 100755 index 0000000..c8d9507 --- /dev/null +++ b/android/build.py @@ -0,0 +1,82 @@ +#!/usr/bin/env -S python3 -u + +import os, os.path +import shutil +import sys, subprocess + +if len(sys.argv) < 4: + print("Usage: build.py SDK_PATH NDK_PATH ABI [configure_args...]", file=sys.stderr) + sys.exit(1) + +sdk_path = sys.argv[1] +ndk_path = sys.argv[2] +android_abi = sys.argv[3] +configure_args = sys.argv[4:] + +if not os.path.isfile(os.path.join(sdk_path, 'licenses', 'android-sdk-license')): + print("SDK not found in", sdk_path, file=sys.stderr) + sys.exit(1) + +if not os.path.isdir(ndk_path): + print("NDK not found in", ndk_path, file=sys.stderr) + sys.exit(1) + +# the path to the MPD sources +mpd_path = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]) or '.', '..')) +sys.path[0] = os.path.join(mpd_path, 'python') + +# output directories +from build.dirs import lib_path, tarball_path, src_path +from build.toolchain import AndroidNdkToolchain + +# a list of third-party libraries to be used by MPD on Android +from build.libs import * +thirdparty_libs = [ + libmodplug, + wildmidi, + gme, + ffmpeg, + libnfs, +] + +# build the third-party libraries +for x in thirdparty_libs: + toolchain = AndroidNdkToolchain(mpd_path, lib_path, + tarball_path, src_path, + ndk_path, android_abi, + use_cxx=x.use_cxx) + if not x.is_installed(toolchain): + x.build(toolchain) + +# configure and build MPD +toolchain = AndroidNdkToolchain(mpd_path, lib_path, + tarball_path, src_path, + ndk_path, android_abi, + use_cxx=True) + +configure_args += [ + '-Dandroid_sdk=' + sdk_path, + '-Dandroid_ndk=' + ndk_path, + '-Dandroid_abi=' + android_abi, + '-Dandroid_strip=' + toolchain.strip, + '-Dopenssl:asm=disabled', + '-Dwrap_mode=forcefallback' +] + +from build.meson import configure as run_meson +run_meson(toolchain, mpd_path, '.', configure_args) + +ninja = shutil.which("ninja") +subprocess.check_call([ninja], env=toolchain.env) + +subprocess.check_call([ninja, 'install'], env=toolchain.env) + +print(""" +------------------------------------- +## To build the android app: +# cd ../../android +# ./gradlew assemble{}Debug +## or, for a universal apk (includes both arm64-v8a and x86_64) +# ./gradlew assembleUniversalDebug +------------------------------------- +""".format(android_abi.capitalize())) \ No newline at end of file diff --git a/android/custom_rules.xml b/android/custom_rules.xml new file mode 100644 index 0000000..68db465 --- /dev/null +++ b/android/custom_rules.xml @@ -0,0 +1,11 @@ + + + + + + + + + diff --git a/android/gdb.sh b/android/gdb.sh new file mode 100755 index 0000000..5e576c7 --- /dev/null +++ b/android/gdb.sh @@ -0,0 +1,54 @@ +#!/bin/sh + +# This script need the following modification in ANDROID_NDK in order to attach +# to the good :main pid +#--- a/prebuilt/linux-x86_64/bin/ndk-gdb.py +#+++ b/prebuilt/linux-x86_64/bin/ndk-gdb.py +#@@ -669,7 +669,7 @@ +# log("Sleeping for {} seconds.".format(args.delay)) +# time.sleep(args.delay) +# +#- pids = gdbrunner.get_pids(device, pkg_name) +#+ pids = gdbrunner.get_pids(device, pkg_name + ":main") +# if len(pids) == 0: +# error("Failed to find running process '{}'".format(pkg_name)) +# if len(pids) > 1: + +SCRIPT_PATH=$(dirname $0) +BUILD_PATH="`pwd`" +TMP_PATH="$BUILD_PATH/gdb" +NDK_GDB_ARGS="--force" +ANDROID_NDK=$1 + +if [ ! -f $ANDROID_NDK/source.properties ];then + echo "usage: $0 ANDROID_NDK" + exit 1 +fi + +if [ ! -f $BUILD_PATH/libmpd.so ];then + echo "This script need to be executed from the android build directory" + exit 1 +fi + +rm -rf "$TMP_PATH" +mkdir -p "$TMP_PATH" + +ANDROID_MANIFEST="$SCRIPT_PATH/AndroidManifest.xml" +ABI=`ls "$BUILD_PATH/android/apk/apk/lib" --sort=time | head -n 1` + +if [ ! -f "$ANDROID_MANIFEST" -o "$ABI" = "" ]; then + echo "Invalid manifest/ABI, did you try building first ?" + exit 1 +fi + +mkdir -p "$TMP_PATH"/jni +touch "$TMP_PATH"/jni/Android.mk +echo "APP_ABI := $ABI" > "$TMP_PATH"/jni/Application.mk + +DEST=obj/local/$ABI +mkdir -p "$TMP_PATH/$DEST" + +cp "$BUILD_PATH/libmpd.so" "$TMP_PATH/$DEST" +cp "$ANDROID_MANIFEST" "$TMP_PATH" + +(cd "$TMP_PATH" && bash $ANDROID_NDK/ndk-gdb $NDK_GDB_ARGS) diff --git a/android/gradle.properties b/android/gradle.properties new file mode 100644 index 0000000..a03b354 --- /dev/null +++ b/android/gradle.properties @@ -0,0 +1,21 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app's APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true +# Enables namespacing of each library's R class so that its R class includes only the +# resources declared in the library itself and none from the library's dependencies, +# thereby reducing the size of the R class for that library +android.nonTransitiveRClass=true diff --git a/android/gradle/libs.versions.toml b/android/gradle/libs.versions.toml new file mode 100644 index 0000000..0800b21 --- /dev/null +++ b/android/gradle/libs.versions.toml @@ -0,0 +1,41 @@ +[versions] +androidGradlePlugin = "8.5.2" +accompanistPermissions = "0.33.2-alpha" +activityCompose = "1.10.0" +appcompat = "1.7.0" +composeBom = "2025.01.01" +composeSettingsStoragePreferences = "1.0.3" +composeSettingsUiM3 = "1.0.3" +daggerCompiler = "2.49" +hiltAndroid = "2.49" +hiltCompiler = "2.49" +lifecycleRuntimeKtx = "2.8.7" +media3Session = "1.5.1" +navigationCompose = "2.8.6" +kotlin = "1.9.22" + +[libraries] +accompanist-permissions = { module = "com.google.accompanist:accompanist-permissions", version.ref = "accompanistPermissions" } +androidx-activity-compose = { module = "androidx.activity:activity-compose", version.ref = "activityCompose" } +androidx-appcompat = { module = "androidx.appcompat:appcompat", version.ref = "appcompat" } +androidx-compose-bom = { module = "androidx.compose:compose-bom", version.ref = "composeBom" } +androidx-lifecycle-runtime-compose = { module = "androidx.lifecycle:lifecycle-runtime-compose", version.ref = "lifecycleRuntimeKtx" } +androidx-lifecycle-runtime-ktx = { module = "androidx.lifecycle:lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" } +androidx-lifecycle-viewmodel-compose = { module = "androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "lifecycleRuntimeKtx" } +androidx-material-icons-extended = { module = "androidx.compose.material:material-icons-extended" } +androidx-material3 = { module = "androidx.compose.material3:material3" } +androidx-media3-session = { module = "androidx.media3:media3-session", version.ref = "media3Session" } +androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "navigationCompose" } +androidx-ui-test-manifest = { module = "androidx.compose.ui:ui-test-manifest" } +androidx-ui-tooling = { module = "androidx.compose.ui:ui-tooling" } +androidx-ui-tooling-preview = { module = "androidx.compose.ui:ui-tooling-preview" } +compose-settings-storage-preferences = { module = "com.github.alorma:compose-settings-storage-preferences", version.ref = "composeSettingsStoragePreferences" } +compose-settings-ui-m3 = { module = "com.github.alorma:compose-settings-ui-m3", version.ref = "composeSettingsUiM3" } +dagger-compiler = { module = "com.google.dagger:dagger-compiler", version.ref = "daggerCompiler" } +hilt-android = { module = "com.google.dagger:hilt-android", version.ref = "hiltAndroid" } +hilt-compiler = { module = "com.google.dagger:hilt-compiler", version.ref = "hiltCompiler" } + +[plugins] +android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" } +jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" } +dagger-hilt-android = { id = "com.google.dagger.hilt.android", version.ref = "hiltAndroid" } \ No newline at end of file diff --git a/android/gradle/wrapper/gradle-wrapper.jar b/android/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c Binary files /dev/null and b/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ba1b46d --- /dev/null +++ b/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sun Dec 17 15:00:03 CST 2023 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/android/gradlew b/android/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/android/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/android/gradlew.bat b/android/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/android/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/android/include/meson.build b/android/include/meson.build new file mode 100644 index 0000000..af9f57e --- /dev/null +++ b/android/include/meson.build @@ -0,0 +1,21 @@ +javac = find_program('javac') + +bridge_header = custom_target( + 'org_musicpd_Bridge.h', + output: 'org_musicpd_Bridge.h', + input: [ + '../app/src/main/java/org/musicpd/Bridge.java', + ], + command: [ + javac, + '-source', '1.8', '-target', '1.8', + '-Xlint:-options', + '-cp', join_paths(android_sdk_platform_dir, 'android.jar'), + + # not interested in *.class, we only want the JNI header + '-d', '@PRIVATE_DIR@', + + '-h', '@OUTDIR@', + '@INPUT@', + ], +) diff --git a/android/meson.build b/android/meson.build new file mode 100644 index 0000000..89f7b1b --- /dev/null +++ b/android/meson.build @@ -0,0 +1,17 @@ +android_package = 'org.musicpd' +android_package_path = join_paths(android_package.split('.')) + +android_ndk = get_option('android_ndk') +android_sdk = get_option('android_sdk') +android_abi = get_option('android_abi') + +android_sdk_build_tools_version = '34.0.0' +android_sdk_platform = 'android-34' + +android_build_tools_dir = join_paths(android_sdk, 'build-tools', android_sdk_build_tools_version) +android_sdk_platform_dir = join_paths(android_sdk, 'platforms', android_sdk_platform) + + +android_gradlew = join_paths(meson.current_source_dir(), 'gradlew') + +subdir('include') diff --git a/android/settings.gradle.kts b/android/settings.gradle.kts new file mode 100644 index 0000000..c86ae33 --- /dev/null +++ b/android/settings.gradle.kts @@ -0,0 +1,18 @@ +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + } +} + +rootProject.name = "MPD" +include(":app") + \ No newline at end of file diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css new file mode 100644 index 0000000..a0c3027 --- /dev/null +++ b/doc/_static/css/custom.css @@ -0,0 +1,3 @@ +/* + * css to override sphinx theme + */ \ No newline at end of file diff --git a/doc/client.rst b/doc/client.rst new file mode 100644 index 0000000..f49b951 --- /dev/null +++ b/doc/client.rst @@ -0,0 +1,66 @@ +Client Developer's Manual +######################### + +Introduction +************ + +MPD is a music player without a user interface. The user interface +will be provided by independent clients, which connect to MPD over +socket connections (TCP or local sockets). + +This chapter describes how to develop a client. + +Before you develop a new client, consider joining an existing client +project. There are many clients, but few are mature; we need fewer, +but better clients. + +Client Libraries +**************** + +There are many libraries which help with connecting to MPD. If you +develop a MPD client, use a library instead of reinventing the wheel. +The MPD website has a list of libraries: https://www.musicpd.org/libs/ + + +Connecting to MPD +***************** + +Do not hard-code your client to connect to ``localhost:6600``. +Instead, use the defaults of the client library. For example, with +:program:`libmpdclient`, don't do:: + + c = mpd_connection_new("localhost", 6600, 30000); + +Instead, do:: + + c = mpd_connection_new(NULL, 0, 0); + +This way, the library can choose the best defaults, maybe derived from +environment variables, so all MPD clients use the same settings. + +If you need to reimplement those defaults (or if you are developing a +client library), this is a good set of addresses to attempt to connect +to: + +- if the environment variable :envvar:`MPD_HOST` is set: + ``$MPD_HOST:$MPD_PORT`` (:envvar:`MPD_PORT` defaulting to 6600) +- if the environment variable :envvar:`XDG_RUNTIME_DIR` is set: + ``$XDG_RUNTIME_DIR/mpd/socket`` +- :file:`/run/mpd/socket` +- ``localhost:$MPD_PORT`` (:envvar:`MPD_PORT` defaulting to 6600) + +Environment Variables +********************* + +The following environment variables should be obeyed by all clients +(preferably by the client library): + +- :envvar:`MPD_HOST`: the host (or local socket path) to connect to; + on Linux, this may start with a ``@`` to connect to an abstract + socket. To use a password with MPD, set :envvar:`MPD_HOST` to + ``password@host`` (then abstract socket requires double ``@``: + ``password@@socket``). +- :envvar:`MPD_PORT`: the port number; defaults to 6600. +- :envvar:`MPD_TIMEOUT`: timeout for connecting to MPD and for waiting + for MPD's response in seconds. A good default is 30 seconds. + diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..156a33f --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,239 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.intersphinx'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Music Player Daemon' +copyright = '2003-2025 The Music Player Daemon Project' +author = 'Max Kellermann' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +with open('../meson.build') as f: + import re + version = re.match(r"project\([^\)]*\bversion:\s*'([^']+)'", + f.read(4096)).group(1) +# The full version, including alpha/beta/rc tags. +release = version + '~git' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +try: + __import__(html_theme) +except ModuleNotFoundError: + import sys + print(f"Warning: Sphinx theme {html_theme!r} not available, falling back to the default theme", file=sys.stderr) + del html_theme + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} +html_theme_options = { + 'navigation_depth': -1, + 'sticky_navigation': False, + 'includehidden': True, + 'prev_next_buttons_location': 'both', + 'github_url': "https://github.com/MusicPlayerDaemon/" +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +# html_title = '' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +html_css_files = [ + 'css/custom.css', +] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' +man_pages = [ + ('mpd.1', 'mpd', 'MPD documentation', [author], 1), + ('mpd.conf.5', 'mpd.conf', 'mpd.conf documentation', [author], 5) +] diff --git a/doc/developer.rst b/doc/developer.rst new file mode 100644 index 0000000..f1d6d1f --- /dev/null +++ b/doc/developer.rst @@ -0,0 +1,149 @@ +Developer's Manual +################## + +Introduction +************ + +This is a guide for those who wish to hack on the MPD source code. MPD is an open project, and we are always happy about contributions. So far, more than 150 people have contributed patches. This document is work in progress. Most of it may be incomplete yet. Please help! + +Code Style +********** + +* indent with tabs (width 8) +* don't write CPP when you can write C++: use inline functions and constexpr instead of macros +* comment your code, document your APIs +* the code should be C++23 compliant, and must compile with :program:`GCC` 12 and :program:`clang` 14 +* all code must be exception-safe +* classes and functions names use CamelCase; variables are lower-case with words separated by underscore + +Some example code: + +.. code-block:: c + + int + Foo(const char *abc, int xyz) + { + if (abc == nullptr) { + LogWarning("Foo happened!"); + return -1; + } + + return xyz; + } + + +Error handling +============== + +If an error occurs, throw a C++ exception, preferably derived from +:code:`std::runtime_error`. The function's API documentation should +mention that. If a function cannot throw exceptions, add +:code:`noexcept` to its prototype. + +Some parts of MPD use callbacks to report completion; the handler +classes usually have an "error" callback which receives a +:code:`std::exception_ptr` +(e.g. :code:`BufferedSocket::OnSocketError()`). Wrapping errors in +:code:`std::exception_ptr` allows propagating details about the error +across thread boundaries to the entity which is interested in handling +it (e.g. giving the MPD client details about an I/O error caught by +the decoder thread). + +Out-of-memory errors (i.e. :code:`std::bad_alloc`) do not need to be +handled. Some operating systems such as Linux do not report +out-of-memory to userspace, and instead kill a process to recover. +Even if we know we are out of memory, there is little we can do except +for aborting the process quickly. Any other attempts to give back +memory may cause page faults on the way which make the situation +worse. + +Error conditions which are caused by a bug do not need to be handled +at runtime; instead, use :code:`assert()` to detect them in debug +builds. + + +git Branches +************ + +There are two active branches in the git repository: + +- the "unstable" branch called ``master`` where new features are + merged. This will become the next major release eventually. +- the "stable" branch (currently called ``v0.24.x``) where only bug + fixes are merged. + +Once :program:`MPD` 0.25 is released, a new branch called ``v0.25.x`` +will be created for 0.25 bug-fix releases; after that, ``v0.24.x`` +will eventually cease to be maintained. + +After bug fixes have been added to the "stable" branch, it will be +merged into ``master``. This ensures that all known bugs are fixed in +all active branches. + + +Hacking The Source +****************** + +MPD sources are managed in a git repository on +`Github `_. + +Always write your code against the latest git: + +.. code-block:: none + + git clone https://github.com/MusicPlayerDaemon/MPD.git + +If you already have a clone, update it: + +.. code-block:: none + + git pull --rebase https://github.com/MusicPlayerDaemon/MPD.git master + +You can do without :code:`--rebase`, but we recommend that you rebase +your repository on the "master" repository all the time. + +Configure with the option :code:`--werror`. Enable as many plugins as +possible, to be sure that you don't break any disabled code. + +Don't mix several changes in one single patch. Create a separate patch for every change. Tools like :program:`stgit` help you with that. This way, we can review your patches more easily, and we can pick the patches we like most first. + +Basic stgit usage +================= + +stgit allows you to create a set of patches and refine all of them: you can go back to any patch at any time, and re-edit it (both the code and the commit message). You can reorder patches and insert new patches at any position. It encourages creating separate patches for tiny changes. + +stgit needs to be initialized on a git repository: + +.. code-block:: sh + + stg init + +Before you edit the code, create a patch: + +.. code-block:: sh + + stg new my-patch-name + +stgit now asks you for the commit message. + +Now edit the code. Once you're finished, you have to "refresh" the patch, i.e. your edits are incorporated into the patch you have created: + +.. code-block:: sh + + stg refresh + +You may now continue editing the same patch, and refresh it as often as you like. Create more patches, edit and refresh them. + +To view the list of patches, type stg series. To go back to a specific patch, type stg goto my-patch-name; now you can re-edit it (don't forget stg refresh when you're finished with that patch). + +When the whole patch series is finished, convert stgit patches to git commits: + +.. code-block:: sh + + stg commit + +Submitting Patches +****************** + +Submit pull requests on GitHub: +https://github.com/MusicPlayerDaemon/MPD/pulls diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in new file mode 100644 index 0000000..5b8e72e --- /dev/null +++ b/doc/doxygen.conf.in @@ -0,0 +1,2428 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = MPD + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @VERSION@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/api + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = @abs_top_srcdir@/src/ + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @abs_top_srcdir@/src/ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h \ + *.hxx + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = NO + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NONE + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /