From ba4527658c218109386d2f4c73740dfbe08466dc Mon Sep 17 00:00:00 2001 From: Milan Zamazal Date: Sat, 4 Jun 2022 21:51:45 +0200 Subject: [PATCH] Initial commit --- .gitignore | 2 + LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++ pw-access.el | 205 ++++++++++++++++ pw-lib.el | 229 +++++++++++++++++ pw-ui.el | 236 ++++++++++++++++++ 5 files changed, 1346 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 pw-access.el create mode 100644 pw-lib.el create mode 100644 pw-ui.el diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..403a62a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.elc +*.eld diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/pw-access.el b/pw-access.el new file mode 100644 index 0000000..914c2e8 --- /dev/null +++ b/pw-access.el @@ -0,0 +1,205 @@ +;;; pw-access.el --- PipeWire access -*- lexical-binding: t -*- + +;; Copyright (C) 2022 Milan Zamazal + +;; COPYRIGHT NOTICE +;; +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. +;; +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. +;; +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;; A generic interface for communication with PipeWire (https://pipewire.org). +;; It abstracts communication with PipeWire to be backend independent. +;; Only functions from this module may communicate with PipeWire. +;; +;; Currently, pw-cli is used to talk to PipeWire. This is not optimal +;; because pw-cli doesn't seem to have documented output format and +;; the format changes accross PipeWire versions. But there seem to be +;; no better options currently. This module should allow switching to +;; other communication means easily, without any changes needed +;; outside this module, except for using a different communication +;; class. + +(require 'eieio) + +(defclass pw-accessor () + () + :documentation + "Base PipeWire interface class. +All PipeWire interfaces should derive from this class.") + +(cl-defgeneric pw-access-objects (class) + "Return all the objects currently reported by PipeWire. +It is a list of object data. Each of the elements has a form +(OBJECT-ID . INFO) where OBJECT-ID is a numeric OBJECT-ID as +reported by PipeWire and INFO is an association list of items +(NAME . VALUE) where NAME is a string item name as reported by +PipeWire and VALUE is the corresponding value. VALUE is a number for +object ids, a string otherwise. +A special entry with `type' symbol as its name contains the PipeWire +type of the objects, as a string (e.g. \"Device\", \"Node\", \"Port\", + \"Client\", ...).") + +(cl-defgeneric pw-access-properties (class node-id) + "Return properties of the given node. +NODE-ID is a numeric PipeWire Node id (other kinds of PipeWire objects +are not supported in this method). +Object properties may be, unlike object info items, settable. + +An assocation list is returned. Each list element is of the form +(PROPERTY . VALUE) where PROPERTY is a string name of the given +property. VALUE can be: + +- \"true\" or \"false\" for boolean values (t and nil are not used to + avoid confusion with nil representing invalid or unavailable value). +- A number for numeric values (ids, integers, floats). +- A string for string values. +- A list of elements of any of these types for arrays and structs.") + +(cl-defgeneric pw-access-set-properties (class node-id properties) + "Set PROPERTIES of the given node. +NODE-ID is a numeric PipeWire Node id (other kinds of PipeWire objects +are not supported in this method). +PROPERTIES is an association list in the same format as in +`pw-access-properties'. It needn't contain all the properties, just +the properties to be changed.") + +(cl-defgeneric pw-access-defaults (class) + "Return default sinks and sources. +An association lists is returned. Each list element is of the form +(KEY . NAME) where KEY is a string identifying the given kind of +default sink or source as reported by PipeWire and NAME is a string +name of the node assigned to the default.") + +(cl-defgeneric pw-access-set-default (class key node-name) + "Set default sink or source. +KEY is a string identifying the given kind of default sink or source +as reported in `pw-access-defaults' and NODE-NAME is a string name of +the node that should be assigned to KEY.") + +;; pw-cli interface + +(defvar pw-cli-command "pw-cli" + "pw-cli command to use.") + +(defvar pw-cli-metadata-command "pw-metadata" + "pw-metadata command to use.") + +(defclass pw-cli-accessor (pw-accessor) + () + :documentation + "pw-cli based interface to PipeWire. +Note this interface may not work with all PipeWire versions.") + +(defun pw-cli--command (command args) + (apply #'call-process command nil t nil args) + (goto-char (point-min))) + +(defun pw-cli--next-line () + (goto-char (line-beginning-position 2))) + +(defun pw-cli--parse-list () + (let ((objects '())) + (while (re-search-forward "^[\t]id \\([0-9]+\\), type PipeWire:Interface:\\(.*\\)/.*$" nil t) + (let ((id (string-to-number (match-string 1))) + (properties `((type . ,(match-string 2))))) + (pw-cli--next-line) + (while (looking-at "^ [\t][\t]\\([a-z.]+\\) = \"\\(.*\\)\"") + (let ((property (match-string 1)) + (value (match-string 2))) + (when (string-suffix-p ".id" property) + (setq value (string-to-number value))) + (push (cons property value) properties)) + (pw-cli--next-line)) + (push (cons id properties) objects))) + (nreverse objects))) + +(cl-defmethod pw-access-objects ((class pw-cli-accessor)) + (with-temp-buffer + (pw-cli--command pw-cli-command '("list-objects")) + (pw-cli--parse-list))) + +(defun pw-cli--read-property (&optional nesting) + (unless nesting + (setq nesting 0)) + (when (looking-at (concat (make-string (+ 6 (* 2 nesting)) ? ) + "\\([A-Za-z:]+\\) \\(.*\\)")) + (let ((type (match-string 1)) + (value (match-string 2))) + (pcase type + ("Bool" + (if (equal value "true") 'true 'false)) + ((or "Float" "Id" "Int") + (string-to-number value)) + ("String" + (substring value 1 -1)) + ((or "Array:" "Struct:") + (let ((array '()) + item) + (pw-cli--next-line) + (while (setq item (pw-cli--read-property (1+ nesting))) + (push item array) + (pw-cli--next-line)) + (nreverse array))))))) + +(defun pw-cli--parse-properties () + (pw-cli--next-line) + (let ((end (save-excursion + (or (and (re-search-forward "^ Object:" nil t) + (point)) + (point-max)))) + (properties '())) + (while (re-search-forward "^ Prop: key \\([A-Za-z:]+\\)" end t) + (pw-cli--next-line) + (let ((property (car (last (split-string (match-string 1) ":")))) + (value (pw-cli--read-property))) + (when value + (push (cons property value) properties)))) + properties)) + +(cl-defmethod pw-access-properties ((class pw-cli-accessor) node-id) + (with-temp-buffer + (pw-cli--command pw-cli-command `("enum-params" ,(number-to-string node-id) "Props")) + (pw-cli--parse-properties))) + +(defun pw-cli--format-property-value (value) + (if (consp value) + (concat "[ " (mapconcat #'pw-cli--format-property-value value ", ") " ]") + value)) + +(defun pw-cli--format-property (property) + (format "%s: %s" (car property) (pw-cli--format-property-value (cdr property)))) + +(cl-defmethod pw-access-set-properties ((class pw-cli-accessor) node-id properties) + (let* ((formatted (mapconcat #'pw-cli--format-property properties ", ")) + (props (concat "{ " formatted " }"))) + (call-process pw-cli-command nil pw-cli-command nil + "set-param" (number-to-string node-id) "Props" props))) + +(defun pw-cli--parse-metadata () + (let ((metadata '())) + (while (re-search-forward + "key:'\\([a-z.]+\\)'.*\\(value\\|\"name\"\\): ?['\"]\\([^'\"]+\\)['\"]" + nil t) + (push (cons (match-string 1) (match-string 3)) metadata)) + metadata)) + +(cl-defmethod pw-access-defaults ((class pw-cli-accessor)) + (with-temp-buffer + (pw-cli--command pw-cli-metadata-command '("0")) + (pw-cli--parse-metadata))) + +(cl-defmethod pw-access-set-default ((class pw-cli-accessor) property node-name) + (call-process pw-cli-metadata-command nil pw-cli-metadata-command nil + "0" property (format "{ \"name\": \"%s\" }" node-name))) + +(provide 'pw-access) diff --git a/pw-lib.el b/pw-lib.el new file mode 100644 index 0000000..adf79e2 --- /dev/null +++ b/pw-lib.el @@ -0,0 +1,229 @@ +;;; pw-lib.el --- PipeWire library -*- lexical-binding: t -*- + +;; Copyright (C) 2022 Milan Zamazal + +;; COPYRIGHT NOTICE +;; +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. +;; +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. +;; +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;; Backend-independent library to access PipeWire functionality. +;; It abstracts data returned from `pw-access' methods and provides +;; functions to work with them. +;; +;; pw-lib caches data retrieved from PipeWire and uses the cached +;; data. If The cache can be invalidated by calling `pw-lib-refresh'. + +(require 'cl-lib) +(require 'pw-access) + +(defvar pw-lib--accessor (pw-cli-accessor)) + +(defvar pw-lib--objects '()) + +(defun pw-lib-refresh () + "Clear cache of objects retrieved from PipeWire." + (setq pw-lib--objects (pw-access-objects pw-lib--accessor))) + +(defun pw-lib-objects (&optional type) + "Return a list of PipeWire objects. +TYPE is a string identifying PipeWire objects types (e.g. \"Device\", +\"Node\", \"Port\", \"Client\", ...). If specified, return only +objects of the given type. +The format of the list elements is unspecified, use pw-lib functions +to access their data. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (unless pw-lib--objects + (pw-lib-refresh)) + (let ((objects pw-lib--objects)) + (when type + (setq objects (cl-remove-if-not + #'(lambda (o) (string= (cdr (assq 'type (cdr o))) type)) + objects))) + objects)) + +(defun pw-lib-get-object (id) + "Return PipeWire object identified by ID. +If such an object doesn't exist, return nil. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (assoc id pw-lib--objects)) + +(defun pw-lib-object-id (object) + "Return id of the given PipeWire OBJECT." + (car object)) + +(defun pw-lib--object-info (object) + (cdr object)) + +(defun pw-lib-object-value (object key &optional default) + "Return PipeWire OBJECT value identified by KEY. +KEY is a string corresponding to a PipeWire value identifier. +If the given KEY doesn't exist in OBJECT, return DEFAULT." + (or (cdr (assoc key (pw-lib--object-info object))) + default)) + +(defun pw-lib-object-type (object) + "Return PipeWire type of OBJECT as a string. +E.g. \"Device\", \"Node\", \"Port\", \"Client\", ..." + (pw-lib-object-value object 'type)) + +(defun pw-lib--node (object) + (if (equal (pw-lib-object-type object) "Node") + object + (pw-lib-get-object (pw-lib-object-value object "node.id")))) + +(defun pw-lib--node-parameters (object-or-id) + (let* ((object (if (numberp object-or-id) + (pw-lib-get-object object-or-id) + object-or-id)) + (node (pw-lib--node object)) + (parameters (pw-lib-object-value node 'parameters))) + (unless parameters + (setq parameters (pw-access-properties pw-lib--accessor (pw-lib-object-id node))) + (setcdr node (cons (cons 'parameters parameters) + (cdr node)))) + parameters)) + +(defun pw-lib-default-nodes () + "Return assignments of PipeWire Nodes to default sinks and sources. +An association lists with elements of the form (KEY . ID) is +returned, where KEY is a string identifying the given kind of +default sink or source as reported by PipeWire and ID is the +corresponding PipeWire node numeric id. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (let ((defaults (pw-access-defaults pw-lib--accessor)) + (nodes (mapcar #'(lambda (o) + (cons (pw-lib-object-value o "node.name") (pw-lib-object-id o))) + (pw-lib-objects "Node")))) + (cl-remove-if-not #'cdr + (mapcar #'(lambda (d) + (cons (car d) (cdr (assoc (cdr d) nodes)))) + defaults)))) + +(defun pw-lib-bindings () + "Return bindings between PipeWire objects. +An association lists with elements of the form (PARENT . CHILD) is +returned where PARENT and CHILD are numeric ids of PipeWire objects. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (apply #'nconc (mapcar #'(lambda (o) + (let ((o-id (pw-lib-object-id o))) + (mapcar #'(lambda (p) + (cons o-id (cdr p))) + (cl-remove-if-not #'numberp (pw-lib--object-info o) + :key #'cdr)))) + (pw-lib-objects)))) + +(defun pw-lib-children (id bindings &optional type) + "Return child objects of the object identified by numeric PipeWire ID. +BINDINGS are object bindings as returned from `pw-lib-bindings'. +If a string TYPE is specified then only children of the given PipeWire +type are returned. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (let ((children (mapcar #'pw-lib-get-object + (mapcar #'car (cl-remove-if #'(lambda (b) (/= (cdr b) id)) bindings))))) + (when type + (setq children (cl-remove-if-not #'(lambda (o) (equal (pw-lib-object-type o) type)) + children))) + children)) + +(defun pw-lib-default-audio-sink () + "Return a PipeWire object that is the current default audio sink." + (pw-lib-get-object (cdr (assoc "default.audio.sink" (pw-lib-default-nodes))))) + +(defun pw-lib--volume-% (volume) + (when volume + (round (* 100 volume)))) + +(defun pw-lib--volume-float (volume) + (/ (float volume) 100)) + +(defun pw-lib--object-parameters (object) + (let* ((node-p (equal (pw-lib-object-type object) "Node")) + (parameters (pw-lib--node-parameters object)) + (monitor-p (unless node-p + (equal (pw-lib-object-value object "port.monitor") "true"))) + (node-id (pw-lib-object-id (pw-lib--node object))) + (port-id (unless node-p + (pw-lib-object-value object "port.id")))) + (list node-p parameters monitor-p node-id port-id))) + +(defun pw-lib-muted-p (object) + "Return whether the given PipeWire object is muted. +Applicable only to Nodes and Ports. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (cl-destructuring-bind (node-p parameters monitor-p node-id port-id) + (pw-lib--object-parameters object) + (eq (cdr (assoc (if monitor-p "monitorMute" "mute") parameters)) 'true))) + +(defun pw-lib-toggle-mute (object) + "Toggle mute status of the given PipeWire OBJECT. +Return the new boolean mute status of OBJECT. +Applicable only to Nodes and Ports. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (cl-destructuring-bind (node-p parameters monitor-p node-id port-id) + (pw-lib--object-parameters object) + (let* ((mute (not (pw-lib-muted-p object))) + (property (if monitor-p "monitorMute" "mute")) + (value (if mute "true" "false"))) + (pw-access-set-properties pw-lib--accessor node-id (list (cons property value))) + mute))) + +(defun pw-lib-volume (object) + "Return volume of the given PipeWire object. +The returned value is an integer in the range 0-100. +Applicable only to Nodes and Ports. +Note that PipeWire data is cached, if you need its up-to-date +version, call `pw-lib-refresh' first." + (cl-destructuring-bind (node-p parameters monitor-p node-id port-id) + (pw-lib--object-parameters object) + (pw-lib--volume-% + (if node-p + (cdr (assoc "volume" parameters)) + (nth port-id (cdr (assoc (if monitor-p "monitorVolumes" "channelVolumes") parameters))))))) + +(defun pw-lib-set-volume (volume object) + "Set the volume of PipeWire OBJECT to VOLUME. +VOLUME must be an integer in the range 0-100." + (cl-destructuring-bind (node-p parameters monitor-p node-id port-id) + (pw-lib--object-parameters object) + (let* ((property (cond + (node-p "volume") + (monitor-p "monitorVolumes") + (t "channelVolumes"))) + (float-volume (pw-lib--volume-float volume)) + (value (if node-p + float-volume + (let ((orig-value (cdr (assoc property parameters)))) + (cl-substitute float-volume nil orig-value + :test #'always :start port-id :count 1))))) + (pw-access-set-properties pw-lib--accessor node-id (list (cons property value)))))) + +(defun pw-lib-set-default (object stored-p) + "Set PipeWire OBJECT as the default sink or source. +If STORED-P is non-nil, set the stored default sink or source, +otherwise set the current default sink or source." + (let ((suffix (mapconcat #'downcase + (split-string (pw-lib-object-value object "media.class") "/") + ".")) + (prefix (if stored-p "default.configured." "default.")) + (node-name (pw-lib-object-value object "node.name"))) + (pw-access-set-default pw-lib--accessor (concat prefix suffix) node-name))) + +(provide 'pw-lib) diff --git a/pw-ui.el b/pw-ui.el new file mode 100644 index 0000000..b7d4bdc --- /dev/null +++ b/pw-ui.el @@ -0,0 +1,236 @@ +;;; pw-ui.el --- PipeWire user interface -*- lexical-binding: t -*- + +;; Copyright (C) 2022 Milan Zamazal + +;; COPYRIGHT NOTICE +;; +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. +;; +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. +;; +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;; PipeWire user interface based on pw-lib. +;; An interactive buffer can be displayed using `M-x pipewire'. +;; `pipewire-increase-volume', `pipewire-decrease-volume' and +;; `pipewire-toggle-muted' functions are also suitable to bind on the +;; multimedia keys. + +(require 'pw-lib) + +(defgroup pipewire () + "PipeWire user interface.") + +(defcustom pipewire-volume-step 5 + "How many percent points to add or subtract when changing volumes." + :type 'number + :group 'pipewire) + +(defface pipewire-label-face + '((t (:weight bold :overline t))) + "Face to use for PipeWire node group labels." + :group 'pipewire) + +(defface pipewire-default-object-face + '((t (:weight bold))) + "Face to use for PipeWire default sinks and sources." + :group 'pipewire) + +(defface pipewire-muted-face + '((t (:strike-through t))) + "Face to use for muted PipeWire sinks and sources." + :group 'pipewire) + +(defface pipewire-volume-face + '((t (:inverse-video t))) + "Face to use for displaying volumes of PipeWire objects." + :group 'pipewire) + +(defvar pipewire-buffer "*PipeWire*") + +(defun pw-ui--label (label) + (propertize (concat label ":") 'face 'pipewire-label-face)) + +(defun pw-ui--object-volume (object) + (propertize (pw-lib-volume object) 'face 'pipewire-volume-face)) + +(defun pw-ui--object-name (object) + (let* ((type (pw-lib-object-type object)) + (description-properties (if (equal type "Client") + '("application.name") + (let ((prefix (concat (downcase type) "."))) + (mapcar #'(lambda (suffix) (concat prefix suffix)) + '("description" "name")))))) + (or (cl-find-if #'identity + (mapcar #'(lambda (p) (pw-lib-object-value object p)) + description-properties)) + ""))) + +(defun pw-ui--object-label (object default-ids) + (let* ((id (pw-lib-object-id object)) + (type (pw-lib-object-type object)) + (text (format "%4s: %s" id (pw-ui--object-name object))) + (face (if (member id default-ids) 'pipewire-default-object-face 'default)) + (media-class (pw-lib-object-value object "media.class"))) + (when media-class + (setq text (format "%s (%s)" text media-class))) + (let ((volume-p (member type '("Node" "Port")))) + (when (and volume-p (pw-lib-muted-p object)) + (setq face `(:inherit (pipewire-muted-face ,face)))) + (let ((label (propertize text 'face face))) + (when volume-p + (let ((volume (pw-lib-volume object))) + (when volume + (setq label (concat label " " + (propertize (number-to-string volume) + 'face 'pipewire-volume-face)))))) + label)))) + +(defun pw-ui--insert-line (line object) + (insert (propertize line 'pw-object-id (pw-lib-object-id object)) "\n")) + +(defun pipewire-refresh (&optional ignore-auto noconfirm) + "Refresh PipeWire buffer." + (interactive) + (when (and (not (eq major-mode 'pipewire-mode)) + (not (equal (buffer-name) pipewire-buffer))) + (error "Not in a PipeWire buffer")) + (pw-lib-refresh) + (let ((inhibit-read-only t) + (bindings (pw-lib-bindings)) + (default-ids (mapcar #'cdr (pw-lib-default-nodes))) + (current-line (count-lines (point-min) (min (1+ (point)) (point-max))))) + (erase-buffer) + (insert (pw-ui--label "Devices") "\n") + (dolist (device (pw-lib-objects "Device")) + (pw-ui--insert-line (pw-ui--object-label device default-ids) device) + (dolist (node (pw-lib-children (pw-lib-object-id device) bindings "Node")) + (pw-ui--insert-line (concat " " (pw-ui--object-label node default-ids)) node) + (dolist (port (pw-lib-children (pw-lib-object-id node) bindings "Port")) + (pw-ui--insert-line (concat " " (pw-ui--object-label port default-ids)) port)))) + (insert (pw-ui--label "Clients") "\n") + (dolist (client (pw-lib-objects "Client")) + (pw-ui--insert-line (pw-ui--object-label client default-ids) client)) + (goto-char (point-min)) + (forward-line (1- current-line)))) + +(defun pw-ui--update (&optional message) + (when (get-buffer pipewire-buffer) + (with-current-buffer pipewire-buffer + (pipewire-refresh))) + (when message + (message message))) + +(defun pw-ui--current-object (&optional use-default-p allowed-types) + (let* ((id (get-text-property (point) 'pw-object-id)) + (object (when id (pw-lib-get-object id)))) + (when (and object + (not (null allowed-types)) + (not (member (pw-lib-object-type object) allowed-types))) + (setq object nil)) + (when (and use-default-p (not object)) + (setq object (pw-lib-default-audio-sink))) + object)) + +;;;###autoload +(defun pipewire-toggle-muted () + "Switch mute status of an audio output or input. +If on a Node or Port in a PipeWire buffer, apply it on the given +object. Otherwise apply it on the default audio sink." + (interactive) + (let* ((object (pw-ui--current-object t '("Node" "Port"))) + (muted-p (pw-lib-toggle-mute object))) + (pw-ui--update (format "%s %s" (pw-ui--object-name object) (if muted-p "muted" "unmuted"))))) + +;;;###autoload +(defun pipewire-set-volume (volume &optional object) + "Set volume of an audio output or input. +VOLUME must be a number in the range 0-100. +If OBJECT is given (only Nodes and Ports are allowed) or if on a Node +or Port in a PipeWire buffer, apply it on the given object. +Otherwise apply it on the default audio sink." + (interactive "nVolume: ") + (setq volume (max 0 (min 100 volume))) + (unless object + (setq object (pw-ui--current-object t '("Node" "Port")))) + (pw-lib-set-volume volume object) + (pw-ui--update (format "Volume %s for %s" volume (pw-ui--object-name object)))) + +(defun pw-ui--change-volume (step) + (let* ((object (pw-ui--current-object t '("Node" "Port"))) + (volume (pw-lib-volume object)) + (new-volume (max 0 (min 100 (+ volume step))))) + (pipewire-set-volume new-volume object))) + +;;;###autoload +(defun pipewire-increase-volume () + "Increase volume of an audio output or input. +The volume is increased by `pipewire-volume-step'. +If on a Node or Port in a PipeWire buffer, apply it on the given +object. Otherwise apply it on the default audio sink." + (interactive) + (pw-ui--change-volume pipewire-volume-step)) + +;;;###autoload +(defun pipewire-decrease-volume () + "Decrease volume of an audio output or input. +The volume is Decreased by `pipewire-volume-step'. +If on a Node or Port in a PipeWire buffer, apply it on the given +object. Otherwise apply it on the default audio sink." + (interactive) + (pw-ui--change-volume (- pipewire-volume-step))) + +;;;###autoload +(defun pipewire-set-default () + "Set default sink or source. +If on a Node in a PipeWire buffer, apply it on the given object. +Otherwise ask for the Node to set as the default Node." + (interactive) + (let ((object (or (pw-ui--current-object nil '("Node")) + (let* ((default-node-ids (mapcar #'cdr (pw-lib-default-nodes))) + (nodes (cl-remove-if + #'(lambda (n) (member (pw-lib-object-id n) default-node-ids)) + (pw-lib-objects "Node"))) + (node-mapping (mapcar #'(lambda (n) (cons (pw-ui--object-name n) + (pw-lib-object-id n))) + nodes)) + (node-name (completing-read "Default node: " node-mapping nil t))) + (pw-lib-get-object (cdr (assoc node-name node-mapping))))))) + (pw-lib-set-default object nil) + (pw-lib-set-default object t) + (pw-ui--update))) + +(defvar pipewire-mode-map + (let ((map (make-sparse-keymap))) + (define-key map "d" 'pipewire-set-default) + (define-key map "m" 'pipewire-toggle-muted) + (define-key map "v" 'pipewire-set-volume) + (define-key map "+" 'pipewire-increase-volume) + (define-key map "=" 'pipewire-increase-volume) + (define-key map "-" 'pipewire-decrease-volume) + map)) + +(define-derived-mode pipewire-mode special-mode "PW" + "Major mode for PipeWire user interface. +Selected PipeWire objects are displayed and basic operations may be +applied on some of them or the buffer: +\\{pipewire-mode-map}" + (set (make-local-variable 'revert-buffer-function) + 'pipewire-refresh)) + +;;;###autoload +(defun pipewire () + "Display a PipeWire buffer." + (interactive) + (switch-to-buffer pipewire-buffer) + (pipewire-refresh) + (pipewire-mode)) + +(provide 'pw-ui)