diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e3ba621 --- /dev/null +++ b/README.md @@ -0,0 +1,273 @@ + + +
+ +# hathoris + +Simple, open-source, web interface & API for controlling your HiFi amplifier on Linux. + +
+ + + +

Main screen

+ +## About the Project + +Hathoris is a web interface and API for controlling an audio amplifier on Linux. It allows selecting audio sources, whether virtual (web radio, streaming, local or remote sources) or physical (S/PDIF, analog line-in, etc., depending on the hardware). It also provides advanced control over exposed sound card parameters, such as overall volume, stereo balance, and on some hardware, settings like treble, bass, and surround. + + +## Goals and Features + +Hathoris aims to provide a simple and accessible solution for controlling a HiFi amplifier over the network. The key features include: + +- **Easy sharing of HiFi equipment:** Allow multiple users in a household to control an amplifier over WiFi. + +- **Seamless integration:** Restore the simplicity of old HiFi systems while modernizing control. + +- **Support for multiple audio sources:** Handle both physical and virtual sources (S/PDIF input, ). + +- **Sound card/amplifier controls:** Use your browser or the API to remotely change the volume or any other parameters exposed by the sound card. + +- **Integration with multiple application:** Display the current track and/or control the underlying application (like [AirPlay](https://github.com/mikebrady/shairport-sync), [MPRIS2](https://mpris2.readthedocs.io/en/latest/) (Firefox, ...), [mpv](https://github.com/mpv-player/mpv), ...). + +- **Per input volume control:** Thanks to `pulseaudio`, every sink-inputs can be mixed at a given volume. + + +## Setup + +### Prerequisites + +Hathoris is compatible with any Linux distribution that has PulseAudio. It also requires: + +- `alsa-utils` is required to control sound card parameters, and to handle some physical sources. +- `mpv` and `yt-dlp` for managing virtual sources. +- A compatible amplifier or sound card (see the [Compatible Hardware](#compatible-hardware) section). + + +### Quick Installation Guide + +TODO: Add a quick installation guide. + + +### Build the Project + +To build the project: + + +1. Clone the repository: + +``` +git clone https://github.com/nemunaire/hathoris.git +cd hathoris +``` + +2. Build the frontend: + +``` +cd ui +npm install +npm run build +cd .. +``` + +3. Then, build the API (which embed the frontend): + +``` +go build +``` + + +## Configuration and Usage + +### Audio Sources + +- **Physical sources** are automatically detected when implemented in the code. +- **Application sources** like [shairport-sync](https://github.com/mikebrady/shairport-sync), a [pulseaudio/PipeWire tunnel](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/Modules/#module-tunnel-sinksource), [Firefox/Chrome/VLC/... and others MPRIS2 compatible softwares](https://mpris2.readthedocs.io/en/latest/).... +- **Virtual sources** are configured via a JSON file. (A web configuration interface is planned.) + +Here is an JSON with 2 virtual sources: + +```json +{ + "custom_sources": [ + { + "src": "mpv", + "kv": { + "file": "http://stream.syntheticfm.com:8040/stream", + "name": "Radio Synthetic FM" + } + }, + { + "src": "mpv", + "kv": { + "file": "https://youtube.com/channel/UCD-4g5w1h8xQpLaNS_ghU4g", + "name": "NewRetroWave", + "opts": [ + "--shuffle" + ] + } + } + ] +} +``` + +### API + +The web interface talks directly to the REST API, so everything that can be perform in the browser can also be performed with the API. + +The API is not yet documented, but a Swagger specification is planned soon. + + +#### Source Selection + +Here is a basic API call to start listening what's received on the S/PDIF port of the amplifier: + +``` +curl -X POST http://127.0.0.1:8080/api/sources/spdif/enable +``` + +Select a virtual source, as defined earlier: + +``` +curl -X POST http://127.0.0.1:8080/api/sources/mpv-0/enable +``` + +When enabling one source, any other active source is disabled beforehand. + + +#### Volume Control + +You can control the sound card volume (and any other parameter it exposes): + +``` +curl -X POST -d '[108]' http://127.0.0.1:8080/api/mixer/1/values +``` + +`1` corresponds to the ALSA `NumID`, given by `/api/mixer`: + +``` +curl http://127.0.0.1:8080/api/mixer' +[ + { + "NumID": 1, + "Name": "Digital Playback Volume", + "Type": "INTEGER", + "RW": true, + "Min": 0, + "Max": 207, + "DBScale": { + "Min": -103.5, + "Step": 0.5, + "Mute": 1 + }, + "values": [ + 144, + 144 + ] + }, + { + "NumID": 2, + "Name": "Analogue Playback Volume", + "Type": "INTEGER", + "RW": true, + "Min": 0, + "Max": 1, + "DBScale": { + "Min": -6, + "Step": 6 + }, + "values": [ + 1, + 1 + ] + }, + { + "NumID": 3, + "Name": "Analogue Playback Boost Volume", + "Type": "INTEGER", + "RW": true, + "Min": 0, + "Max": 1, + "DBScale": { + "Min": 0, + "Step": 0.8 + }, + "values": [ + 1, + 1 + ] + }, + { + "NumID": 4, + "Name": "Digital Playback Switch", + "Type": "BOOLEAN", + "RW": true, + "Min": 0, + "Max": 0, + "values": [ + true, + true + ] + }, + { + "NumID": 5, + "Name": "Deemphasis Switch", + "Type": "BOOLEAN", + "RW": true, + "Min": 0, + "Max": 0, + "values": [ + true + ] + }, + { + "NumID": 6, + "Name": "DSP Program", + "Type": "ENUMERATED", + "RW": true, + "Min": 0, + "Max": 0, + "values": [ + 0 + ], + "items": [ + "FIR interpolation with de-emphasis", + "Low latency IIR with de-emphasis", + "High attenuation with de-emphasis", + "Fixed process flow", + "Ringing-less low latency FIR" + ] + } +] +``` + + +## Compatible Hardware + +Hathoris has been tested on several hardware configurations, including: + +- [Voltastream AMP1](https://polyvection.com/news/flashback-how-voltastream-paved-our-way/) +- [Voltastream Zero](https://polyvection.com/news/flashback-how-voltastream-paved-our-way/) +- [Raspberry Pi with DigiAMP+](https://www.raspberrypi.com/products/digiamp-plus/) + +Additional compatible hardware may be added in the future (don't hesitate to contribute). + + +## Stack Tech + +- [![Go][Go-badge]][Go-url] - A statically typed, concurrent, and garbage collected language + +[Go-badge]: https://img.shields.io/badge/Go-00ADD8?style=for-the-badge&logo=go +[Go-url]: https://go.dev/ +- [![Svelte][Svelte-badge]][Svelte-url] - A high-performance reactive JavaScript UI library + +[Svelte-badge]: https://img.shields.io/badge/Svelte-FF3E00?style=for-the-badge&logo=svelte +[Svelte-url]: https://svelte.dev/ + + +## License and Contributions + +This project is licensed under the [GNU Affero General Public License 3.0](https://www.gnu.org/licenses/agpl-3.0.html). + +Contributions are welcome! The goal is to keep the project simple, efficient, and compatible with as much Linux hardware as possible. diff --git a/alsacontrol/cardcontrol.go b/alsacontrol/cardcontrol.go new file mode 100644 index 0000000..c64aaf8 --- /dev/null +++ b/alsacontrol/cardcontrol.go @@ -0,0 +1,215 @@ +package alsa + +import ( + "bufio" + "fmt" + "os/exec" + "sort" + "strconv" + "strings" +) + +type CardControl struct { + NumID int64 + Interface string + Name string + Type string + Access string + NValues int64 + Min int64 + Max int64 + Step int64 + DBScale CardControldBScale + Values []string + Items []string +} + +func (cc *CardControl) parseAmixerField(key, value string) (err error) { + switch key { + case "numid": + cc.NumID, err = strconv.ParseInt(value, 10, 64) + case "iface": + cc.Interface = value + case "name": + cc.Name = strings.TrimPrefix(strings.TrimSuffix(value, "'"), "'") + case "type": + cc.Type = value + case "access": + cc.Access = value + case "values": + cc.NValues, err = strconv.ParseInt(value, 10, 64) + case "min": + cc.Min, err = strconv.ParseInt(value, 10, 64) + case "max": + cc.Max, err = strconv.ParseInt(value, 10, 64) + case "step": + cc.Step, err = strconv.ParseInt(value, 10, 64) + } + + return +} + +func (cc *CardControl) ToCardControlState() *CardControlState { + ccs := &CardControlState{ + NumID: cc.NumID, + Type: cc.Type, + Name: cc.Name, + RW: strings.HasPrefix(cc.Access, "rw"), + Items: cc.Items, + } + + if cc.DBScale.Min != 0 || cc.DBScale.Step != 0 { + ccs.DBScale = &cc.DBScale + } + + // Convert values + for _, v := range cc.Values { + if cc.Type == "INTEGER" || cc.Type == "ENUMERATED" { + if tmp, err := strconv.ParseFloat(v, 10); err == nil { + ccs.Current = append(ccs.Current, tmp) + } + } else if cc.Type == "BOOLEAN" { + if v == "on" { + ccs.Current = append(ccs.Current, true) + } else { + ccs.Current = append(ccs.Current, false) + } + } + } + + ccs.Min = cc.Min + ccs.Max = cc.Max + + return ccs +} + +type CardControldBScale struct { + Min float64 + Step float64 + Mute int64 `json:",omitempty"` +} + +func (cc *CardControldBScale) parseAmixerField(key, value string) (err error) { + switch key { + case "min": + cc.Min, err = strconv.ParseFloat(strings.TrimSuffix(value, "dB"), 10) + case "step": + cc.Step, err = strconv.ParseFloat(strings.TrimSuffix(value, "dB"), 10) + case "mute": + cc.Mute, err = strconv.ParseInt(value, 10, 64) + } + + return +} + +type CardControlState struct { + NumID int64 + Name string + Type string + RW bool `json:"RW,omitempty"` + Min int64 + Max int64 + DBScale *CardControldBScale `json:",omitempty"` + Current []interface{} `json:"values,omitempty"` + Items []string `json:"items,omitempty"` +} + +func ParseAmixerContent(cardId string) ([]*CardControl, error) { + cardIdType := "-D" + if _, err := strconv.Atoi(cardId); err == nil { + cardIdType = "-c" + } + + cmd := exec.Command("amixer", cardIdType, cardId, "-M", "contents") + + stdout, err := cmd.StdoutPipe() + if err != nil { + return nil, err + } + if err := cmd.Start(); err != nil { + return nil, err + } + + var ret []*CardControl + + fscanner := bufio.NewScanner(stdout) + for fscanner.Scan() { + line := fscanner.Text() + + if strings.HasPrefix(line, " ; Item #") { + cc := ret[len(ret)-1] + cc.Items = append(cc.Items, strings.TrimSuffix(line[strings.Index(line, "'")+1:], "'")) + } else if strings.HasPrefix(line, " :") { + cc := ret[len(ret)-1] + line = strings.TrimPrefix(line, " : ") + + kv := strings.SplitN(line, "=", 2) + if kv[0] == "values" { + cc.Values = strings.Split(kv[1], ",") + } + } else if strings.HasPrefix(line, " |") || strings.HasPrefix(line, " |") { + cc := ret[len(ret)-1] + line = strings.TrimSpace(line) + if strings.HasPrefix(line, "| dBscale-") { + line = strings.TrimPrefix(line, "| dBscale-") + + fields := strings.Split(line, ",") + + var scale CardControldBScale + for _, field := range fields { + kv := strings.SplitN(field, "=", 2) + scale.parseAmixerField(kv[0], kv[1]) + } + cc.DBScale = scale + } + } else { + var cc *CardControl + + if strings.HasPrefix(line, "numid=") { + cc = &CardControl{} + ret = append(ret, cc) + } else { + cc = ret[len(ret)-1] + line = strings.TrimPrefix(line, " ; ") + } + + fields := strings.Split(line, ",") + + for _, field := range fields { + kv := strings.SplitN(field, "=", 2) + cc.parseAmixerField(kv[0], kv[1]) + } + } + } + + err = cmd.Wait() + + // Sort mixers by NumID + sort.Sort(ByNumID(ret)) + + return ret, err +} + +func (cc *CardControl) CsetAmixer(cardId string, values ...string) error { + opts := []string{ + "-c", + cardId, + "-M", + "cset", + fmt.Sprintf("numid=%d", cc.NumID), + } + opts = append(opts, strings.Join(values, ",")) + cmd := exec.Command("amixer", opts...) + + if err := cmd.Start(); err != nil { + return err + } + + return cmd.Wait() +} + +type ByNumID []*CardControl + +func (a ByNumID) Len() int { return len(a) } +func (a ByNumID) Swap(i, j int) { a[i], a[j] = a[j], a[i] } +func (a ByNumID) Less(i, j int) bool { return a[i].NumID < a[j].NumID } diff --git a/api/volume.go b/api/volume.go index f633c7e..bbb0141 100644 --- a/api/volume.go +++ b/api/volume.go @@ -1,16 +1,14 @@ package api import ( - "bufio" "flag" "fmt" "net/http" - "os/exec" "strconv" - "strings" "github.com/gin-gonic/gin" + "git.nemunai.re/nemunaire/hathoris/alsacontrol" "git.nemunai.re/nemunaire/hathoris/config" ) @@ -22,13 +20,13 @@ func init() { func declareVolumeRoutes(cfg *config.Config, router *gin.RouterGroup) { router.GET("/mixer", func(c *gin.Context) { - cnt, err := parseAmixerContent() + cnt, err := alsa.ParseAmixerContent(cardId) if err != nil { c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"errmsg": err.Error()}) return } - var ret []*CardControlState + var ret []*alsa.CardControlState for _, cc := range cnt { ret = append(ret, cc.ToCardControlState()) @@ -41,12 +39,12 @@ func declareVolumeRoutes(cfg *config.Config, router *gin.RouterGroup) { mixerRoutes.Use(MixerHandler) mixerRoutes.GET("", func(c *gin.Context) { - cc := c.MustGet("mixer").(*CardControl) + cc := c.MustGet("mixer").(*alsa.CardControl) c.JSON(http.StatusOK, cc.ToCardControlState()) }) mixerRoutes.POST("/values", func(c *gin.Context) { - cc := c.MustGet("mixer").(*CardControl) + cc := c.MustGet("mixer").(*alsa.CardControl) var valuesINT []interface{} @@ -73,7 +71,7 @@ func declareVolumeRoutes(cfg *config.Config, router *gin.RouterGroup) { } } - err = cc.CsetAmixer(values...) + err = cc.CsetAmixer(cardId, values...) if err != nil { c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"errmsg": fmt.Sprintf("Unable to set values: %s", err.Error())}) return @@ -84,7 +82,7 @@ func declareVolumeRoutes(cfg *config.Config, router *gin.RouterGroup) { } func MixerHandler(c *gin.Context) { - mixers, err := parseAmixerContent() + mixers, err := alsa.ParseAmixerContent(cardId) if err != nil { c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"errmsg": err.Error()}) return @@ -102,193 +100,3 @@ func MixerHandler(c *gin.Context) { c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"errmsg": "Mixer not found"}) } - -type CardControl struct { - NumID int64 - Interface string - Name string - Type string - Access string - NValues int64 - Min int64 - Max int64 - Step int64 - DBScale CardControldBScale - Values []string - Items []string -} - -func (cc *CardControl) parseAmixerField(key, value string) (err error) { - switch key { - case "numid": - cc.NumID, err = strconv.ParseInt(value, 10, 64) - case "iface": - cc.Interface = value - case "name": - cc.Name = strings.TrimPrefix(strings.TrimSuffix(value, "'"), "'") - case "type": - cc.Type = value - case "access": - cc.Access = value - case "values": - cc.NValues, err = strconv.ParseInt(value, 10, 64) - case "min": - cc.Min, err = strconv.ParseInt(value, 10, 64) - case "max": - cc.Max, err = strconv.ParseInt(value, 10, 64) - case "step": - cc.Step, err = strconv.ParseInt(value, 10, 64) - } - - return -} - -func (cc *CardControl) ToCardControlState() *CardControlState { - ccs := &CardControlState{ - NumID: cc.NumID, - Type: cc.Type, - Name: cc.Name, - RW: strings.HasPrefix(cc.Access, "rw"), - Items: cc.Items, - } - - if cc.DBScale.Min != 0 || cc.DBScale.Step != 0 { - ccs.DBScale = &cc.DBScale - } - - // Convert values - for _, v := range cc.Values { - if cc.Type == "INTEGER" || cc.Type == "ENUMERATED" { - if tmp, err := strconv.ParseFloat(v, 10); err == nil { - ccs.Current = append(ccs.Current, tmp) - } - } else if cc.Type == "BOOLEAN" { - if v == "on" { - ccs.Current = append(ccs.Current, true) - } else { - ccs.Current = append(ccs.Current, false) - } - } - } - - ccs.Min = cc.Min - ccs.Max = cc.Max - - return ccs -} - -type CardControldBScale struct { - Min float64 - Step float64 - Mute int64 `json:",omitempty"` -} - -func (cc *CardControldBScale) parseAmixerField(key, value string) (err error) { - switch key { - case "min": - cc.Min, err = strconv.ParseFloat(strings.TrimSuffix(value, "dB"), 10) - case "step": - cc.Step, err = strconv.ParseFloat(strings.TrimSuffix(value, "dB"), 10) - case "mute": - cc.Mute, err = strconv.ParseInt(value, 10, 64) - } - - return -} - -type CardControlState struct { - NumID int64 - Name string - Type string - RW bool `json:"RW,omitempty"` - Min int64 - Max int64 - DBScale *CardControldBScale `json:",omitempty"` - Current []interface{} `json:"values,omitempty"` - Items []string `json:"items,omitempty"` -} - -func parseAmixerContent() ([]*CardControl, error) { - cmd := exec.Command("amixer", "-c", cardId, "-M", "contents") - - stdout, err := cmd.StdoutPipe() - if err != nil { - return nil, err - } - if err := cmd.Start(); err != nil { - return nil, err - } - - var ret []*CardControl - - fscanner := bufio.NewScanner(stdout) - for fscanner.Scan() { - line := fscanner.Text() - - if strings.HasPrefix(line, " ; Item #") { - cc := ret[len(ret)-1] - cc.Items = append(cc.Items, strings.TrimSuffix(line[strings.Index(line, "'")+1:], "'")) - } else if strings.HasPrefix(line, " :") { - cc := ret[len(ret)-1] - line = strings.TrimPrefix(line, " : ") - - kv := strings.SplitN(line, "=", 2) - if kv[0] == "values" { - cc.Values = strings.Split(kv[1], ",") - } - } else if strings.HasPrefix(line, " |") || strings.HasPrefix(line, " |") { - cc := ret[len(ret)-1] - line = strings.TrimSpace(line) - if strings.HasPrefix(line, "| dBscale-") { - line = strings.TrimPrefix(line, "| dBscale-") - - fields := strings.Split(line, ",") - - var scale CardControldBScale - for _, field := range fields { - kv := strings.SplitN(field, "=", 2) - scale.parseAmixerField(kv[0], kv[1]) - } - cc.DBScale = scale - } - } else { - var cc *CardControl - - if strings.HasPrefix(line, "numid=") { - cc = &CardControl{} - ret = append(ret, cc) - } else { - cc = ret[len(ret)-1] - line = strings.TrimPrefix(line, " ; ") - } - - fields := strings.Split(line, ",") - - for _, field := range fields { - kv := strings.SplitN(field, "=", 2) - cc.parseAmixerField(kv[0], kv[1]) - } - } - } - - err = cmd.Wait() - return ret, err -} - -func (cc *CardControl) CsetAmixer(values ...string) error { - opts := []string{ - "-c", - cardId, - "-M", - "cset", - fmt.Sprintf("numid=%d", cc.NumID), - } - opts = append(opts, strings.Join(values, ",")) - cmd := exec.Command("amixer", opts...) - - if err := cmd.Start(); err != nil { - return err - } - - return cmd.Wait() -} diff --git a/assets/mainscreen.png b/assets/mainscreen.png new file mode 100644 index 0000000..1d21e81 Binary files /dev/null and b/assets/mainscreen.png differ diff --git a/sources/spdif/source.go b/sources/spdif/source.go index 2e086ff..b94e2a1 100644 --- a/sources/spdif/source.go +++ b/sources/spdif/source.go @@ -3,16 +3,21 @@ package spdif import ( "fmt" "io" + "log" "os" "os/exec" "path" + "strconv" + "time" + "git.nemunai.re/nemunaire/hathoris/alsacontrol" "git.nemunai.re/nemunaire/hathoris/sources" ) type SPDIFSource struct { processRec *exec.Cmd processPlay *exec.Cmd + endChan chan bool DeviceIn string DeviceOut string Bitrate int64 @@ -28,12 +33,16 @@ func init() { idfile := path.Join(thisdir, "id") if fd, err := os.Open(idfile); err == nil { if cnt, err := io.ReadAll(fd); err == nil && string(cnt) == "imxspdif\n" { - sources.SoundSources["imxspdif"] = &SPDIFSource{ - DeviceIn: "imxspdif", - DeviceOut: "is31ap2121", - Bitrate: 48000, - Channels: 2, - Format: "S24_LE", + sr, err := getCardSampleRate("imxspdif") + if err == nil { + sources.SoundSources["imxspdif"] = &SPDIFSource{ + endChan: make(chan bool, 1), + DeviceIn: "imxspdif", + DeviceOut: "is31ap2121", + Bitrate: sr, + Channels: 2, + Format: "S24_LE", + } } } fd.Close() @@ -44,6 +53,9 @@ func init() { } func (s *SPDIFSource) GetName() string { + if s.IsActive() { + return fmt.Sprintf("S/PDIF %.1f kHz", float32(s.Bitrate)/1000) + } return "S/PDIF" } @@ -63,6 +75,22 @@ func (s *SPDIFSource) Enable() error { s.processPlay.Process.Kill() } + // Update bitrate + sr, err := getCardSampleRate(s.DeviceIn) + if err != nil { + return err + } + // If no bitrate, asume soundcard is sleeping, try to wake up with a random bitrate + if sr == 0 { + sr = 44100 + } + s.Bitrate = sr + + // If no bitrate, asume soundcard is sleeping, try to wake up with a random bitrate + if sr == 0 { + sr = 44100 + } + pipeR, pipeW, err := os.Pipe() if err != nil { return err @@ -86,13 +114,15 @@ func (s *SPDIFSource) Enable() error { s.processPlay = nil }() - s.processRec = exec.Command("arecord", "-t", "wav", "-f", s.Format, fmt.Sprintf("-r%d", s.Bitrate), fmt.Sprintf("-c%d", s.Channels), "-D", "hw:"+s.DeviceIn, "-B0", "--buffer-size=512") + s.processRec = exec.Command("arecord", "-t", "wav", "-f", s.Format, fmt.Sprintf("-r%d", s.Bitrate), fmt.Sprintf("-c%d", s.Channels), "-D", "hw:"+s.DeviceIn, "-F0", "--period-size=512", "-B0", "--buffer-size=512") s.processRec.Stdout = pipeW if err := s.processRec.Start(); err != nil { s.processPlay.Process.Kill() return err } + go s.watchBitrate() + go func() { err := s.processRec.Wait() if err != nil { @@ -100,6 +130,7 @@ func (s *SPDIFSource) Enable() error { } pipeW.Close() + s.endChan <- true s.processRec = nil }() @@ -116,3 +147,75 @@ func (s *SPDIFSource) Disable() error { return nil } + +func getCardSampleRate(cardId string) (sr int64, err error) { + cc, err := alsa.ParseAmixerContent("hw:" + cardId) + if err != nil { + return 0, fmt.Errorf("unable to parse amixer content: %w", err) + } + + for _, c := range cc { + if len(c.Values) == 1 { + val, err := strconv.Atoi(c.Values[0]) + if c.Name == "RX Sample Rate" && err == nil { + return int64(val), nil + } + } + } + + return 0, fmt.Errorf("unable to find 'RX Sample Rate' control value") +} + +func (s *SPDIFSource) watchBitrate() { + ticker := time.NewTicker(time.Second) + + nbAt0 := 0 +loop: + for { + select { + case <-ticker.C: + sr, err := getCardSampleRate(s.DeviceIn) + if err == nil { + if sr == 0 { + nbAt0 += 1 + if nbAt0 >= 30 { + log.Printf("[SPDIF] Sample rate is at %d Hz for %d seconds, disabling", sr, nbAt0) + s.Disable() + + // Wait process exited + for { + if s.processPlay == nil && s.processRec == nil { + break + } + time.Sleep(100 * time.Millisecond) + } + } else if nbAt0 == 1 || nbAt0%5 == 0 { + log.Printf("[SPDIF] Sample rate is at %d Hz for %d seconds", sr, nbAt0) + } + } else { + nbAt0 = 0 + if s.Bitrate/10 != sr/10 { + log.Printf("[SPDIF] Sample rate changes from %d to %d Hz", s.Bitrate, sr) + s.Bitrate = sr + + s.Disable() + + // Wait process exited + for { + if s.processPlay == nil && s.processRec == nil { + break + } + time.Sleep(100 * time.Millisecond) + } + + s.Enable() + } + } + } + case <-s.endChan: + break loop + } + } + + ticker.Stop() +} diff --git a/ui/src/lib/components/Inputs.svelte b/ui/src/lib/components/Inputs.svelte index 691a494..7e215a9 100644 --- a/ui/src/lib/components/Inputs.svelte +++ b/ui/src/lib/components/Inputs.svelte @@ -20,12 +20,12 @@ {#if (showInactives && $inputsList.length === 0) || (!showInactives && $activeInputs.length === 0)}
  • - Aucune source active. + No active source.
    • {/if} {#each $inputsList as input, iid} - {#if showInactives || input.active} + {#if input.streams && (showInactives || input.active)} {#each Object.keys(input.streams) as idstream} {@const title = input.streams[idstream]}
  • diff --git a/ui/src/lib/components/SourceSelection.svelte b/ui/src/lib/components/SourceSelection.svelte index 276f0c8..4d05335 100644 --- a/ui/src/lib/components/SourceSelection.svelte +++ b/ui/src/lib/components/SourceSelection.svelte @@ -4,12 +4,15 @@ let activating_source = null; async function clickSource(src) { activating_source = src.id; - if (src.enabled) { - await src.deactivate(); - await sources.refresh(); - } else { - await src.activate(); - await sources.refresh(); + try { + if (src.enabled) { + await src.deactivate(); + await sources.refresh(); + } else { + await src.activate(); + await sources.refresh(); + } + } catch { } activating_source = null; } diff --git a/ui/src/routes/+layout.svelte b/ui/src/routes/+layout.svelte index bcdfca7..ade3fe5 100644 --- a/ui/src/routes/+layout.svelte +++ b/ui/src/routes/+layout.svelte @@ -32,7 +32,7 @@ {#if $activeSources.length === 0 && $activeInputs.length === 0}
    - Aucune source active pour l'instant. + No active audio source currently.
    {:else} @@ -43,7 +43,7 @@ {#if source.currentTitle} {source.currentTitle} @ {source.name} {:else} - {source.name} activée + {source.name} enabled {/if} @@ -53,14 +53,14 @@
    - {#if input.streams.length} + {#if input.streams && input.streams.length} {#each Object.keys(input.streams) as idstream} {@const title = input.streams[idstream]} {title} {/each} @ {input.name} {:else} - {input.name} activée + {input.name} enabled {/if}
    diff --git a/ui/src/routes/+page.svelte b/ui/src/routes/+page.svelte index ebb741d..fb58d00 100644 --- a/ui/src/routes/+page.svelte +++ b/ui/src/routes/+page.svelte @@ -52,7 +52,7 @@
    - Sources + Inputs