From 863276330b918b4785bbbf8874910c550602dc2c Mon Sep 17 00:00:00 2001 From: Kirill Primak Date: Mon, 17 Jun 2024 23:52:13 +0300 Subject: [PATCH] Initial PoC commit --- .clang-format | 103 ++++ .gitignore | 6 + LICENSE | 674 ++++++++++++++++++++ README.md | 22 + main.c | 716 ++++++++++++++++++++++ meson.build | 61 ++ protocols/meson.build | 41 ++ protocols/wlr-layer-shell-unstable-v1.xml | 407 ++++++++++++ protocols/wlr-screencopy-unstable-v1.xml | 232 +++++++ 9 files changed, 2262 insertions(+) create mode 100644 .clang-format create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 main.c create mode 100644 meson.build create mode 100644 protocols/meson.build create mode 100644 protocols/wlr-layer-shell-unstable-v1.xml create mode 100644 protocols/wlr-screencopy-unstable-v1.xml diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..9f4401d --- /dev/null +++ b/.clang-format @@ -0,0 +1,103 @@ +AlignAfterOpenBracket: DontAlign + +AlignArrayOfStructures: None + +AlignConsecutiveAssignments: None +AlignConsecutiveBitFields: None +AlignConsecutiveDeclarations: None +AlignConsecutiveMacros: None +AlignEscapedNewlines: DontAlign +AlignOperands: DontAlign +AlignTrailingComments: Never + +AllowAllArgumentsOnNextLine: true +AllowAllParametersOfDeclarationOnNextLine: true + +AllowShortBlocksOnASingleLine: Never +AllowShortCaseLabelsOnASingleLine: false +AllowShortEnumsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: Never +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: true + +BinPackArguments: true +BinPackParameters: true + +BitFieldColonSpacing: Both + +BracedInitializerIndentWidth: 4 + +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Attach +BreakBeforeTernaryOperators: true + +ColumnLimit: 100 + +ContinuationIndentWidth: 8 + +DisableFormat: false + +ForEachMacros: + - wl_list_for_each + - wl_list_for_each_reverse + - wl_list_for_each_safe + - wl_list_for_each_reverse_safe + +IncludeBlocks: Regroup +IncludeCategories: + - Regex: "^ + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and`show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..707de33 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# dulcepan + +A (WIP) screenshot tool. + +Discuss in [#eclairs on Libera.Chat]. + +[#eclairs on Libera.Chat]: https://web.libera.chat/#eclairs + +## Building + +```sh +meson setup build/ +ninja -C build/ +``` + +## License + +GPL-3.0-only + +See `LICENSE` for more information. + +Copyright © 2024 Kirill Primak diff --git a/main.c b/main.c new file mode 100644 index 0000000..23b3fc9 --- /dev/null +++ b/main.c @@ -0,0 +1,716 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "viewporter-protocol.h" +#include "wlr-layer-shell-unstable-v1-protocol.h" +#include "wlr-screencopy-unstable-v1-protocol.h" + +#define SWAPCHAIN_LEN 4 + +struct dp_swapchain_buffer { + struct wl_buffer *buffer; + void *data; + cairo_surface_t *cairo_surface; + cairo_t *cairo; + bool used; +}; + +struct dp_output { + uint32_t name; + struct wl_output *global; + + struct wl_surface *surface; + struct zwlr_layer_surface_v1 *layer_surface; + struct wp_viewport *viewport; + + struct wl_surface *ui_surface; + struct wl_subsurface *ui_subsurface; + struct wp_viewport *ui_viewport; + + int width, height; + int width_px, height_px; + + struct zwlr_screencopy_frame_v1 *frame; + bool frame_ready; + + struct wl_buffer *frame_buffer; + int32_t frame_stride; + uint32_t frame_format; + void *frame_data; + + bool configured; + + struct dp_swapchain_buffer swapchain[SWAPCHAIN_LEN]; + + struct wl_list link; +}; + +enum dp_status { + DP_RUNNING, + DP_SAVE, + DP_QUIT, +}; + +static enum dp_status status = DP_RUNNING; + +static struct wl_compositor *compositor = NULL; +static struct wl_subcompositor *subcompositor = NULL; +static struct wp_viewporter *viewporter = NULL; +static struct wl_shm *shm = NULL; +static struct zwlr_layer_shell_v1 *layer_shell = NULL; +static struct zwlr_screencopy_manager_v1 *screencopy_manager = NULL; +static struct wl_seat *seat = NULL; +static struct wl_keyboard *keyboard = NULL; +static struct wl_pointer *pointer = NULL; + +static struct wl_list outputs; + +static uint32_t seat_caps = false; + +static struct xkb_context *xkb_context = NULL; +static struct xkb_keymap *xkb_keymap = NULL; +static struct xkb_state *xkb_state = NULL; + +static struct dp_output *selected_output = NULL; +static int selected_x = 0; +static int selected_y = 0; +static int selected_width = 0; +static int selected_height = 0; + +static bool selecting_rect = false; + +static int select_start_x = 0; +static int select_start_y = 0; + +static struct dp_output *pointer_output = NULL; +static int pointer_x = 0; +static int pointer_y = 0; + +static bool save_on_select = false; + +static void die(const char *fmt, ...) { + va_list args; + va_start(args, fmt); + fprintf(stderr, "Fatal: "); + vfprintf(stderr, fmt, args); + fprintf(stderr, "\n"); + va_end(args); + exit(1); +} + +static void *xzalloc(size_t size) { + void *ptr = calloc(1, size); + if (ptr == NULL) { + die("allocation error"); + } + return ptr; +} + +static void sc_buffer_handle_release(void *data, struct wl_buffer *wl_buffer) { + struct dp_swapchain_buffer *sc_buffer = data; + sc_buffer->used = false; +} + +static const struct wl_buffer_listener sc_buffer_listener = { + .release = sc_buffer_handle_release, +}; + +static void fnv_1a_cont(uint64_t *h, const void *data, size_t len) { + const uint8_t *bytes = data; + for (size_t i = 0; i < len; i++) { + *h = (*h * 0x00000100000001B3) ^ bytes[i]; + } +} + +static void generate_name(char buffer[static 16]) { + uint64_t h = 0xcbf29ce484222325; + int pid = getpid(); + fnv_1a_cont(&h, &pid, sizeof(pid)); + struct timespec ts; + clock_gettime(CLOCK_REALTIME, &ts); + fnv_1a_cont(&h, &ts.tv_sec, sizeof(&ts.tv_sec)); + fnv_1a_cont(&h, &ts.tv_nsec, sizeof(&ts.tv_nsec)); + for (size_t i = 16; i-- > 0;) { + buffer[i] = "0123456789abcdef"[h & 0xF]; + h >>= 4; + } +} + +static struct wl_buffer *create_buffer( + int32_t width, int32_t height, int32_t stride, uint32_t format, void **data) { + int32_t size = stride * height; + + static const char template[] = "randfall-"; + char name[sizeof(template) + 16] = {0}; + memcpy(name, template, sizeof(template) - 1); + generate_name(&name[sizeof(template) - 1]); + + int fd = shm_open(name, O_RDWR | O_CREAT | O_EXCL, 0600); + if (fd < 0) { + die("shm_open() failed"); + } + shm_unlink(name); + + if (ftruncate(fd, (off_t)size) < 0) { + die("ftruncate() failed"); + } + + struct wl_shm_pool *pool = wl_shm_create_pool(shm, fd, (int32_t)size); + *data = mmap(NULL, (size_t)size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); + if (data == MAP_FAILED) { + die("mmap() failed"); + } + + struct wl_buffer *buffer = + wl_shm_pool_create_buffer(pool, 0, width, height, (int32_t)stride, format); + + wl_shm_pool_destroy(pool); + close(fd); + + return buffer; +} + +static void layer_surface_handle_configure(void *data, struct zwlr_layer_surface_v1 *layer_surface, + uint32_t serial, uint32_t width, uint32_t height) { + struct dp_output *output = data; + + if (output->configured && (output->width != (int)width || output->height != (int)height)) { + die("got unexpected layer surface configure size"); + } + + zwlr_layer_surface_v1_ack_configure(layer_surface, serial); + if (output->configured) { + wl_surface_commit(output->surface); + return; + } + + output->width = (int)width; + output->height = (int)height; + + output->configured = true; +} + +static void redraw(struct dp_output *output) { + struct dp_swapchain_buffer *sc_buffer = NULL; + for (size_t i = 0; i < SWAPCHAIN_LEN; i++) { + struct dp_swapchain_buffer *iter = &output->swapchain[i]; + if (!iter->used) { + sc_buffer = iter; + break; + } + } + if (sc_buffer == NULL) { + fprintf(stderr, "no free buffers in a swapchain\n"); + return; + } + sc_buffer->used = true; + + cairo_set_operator(sc_buffer->cairo, CAIRO_OPERATOR_SOURCE); + + cairo_set_source_rgba(sc_buffer->cairo, 0.5, 0.5, 0.5, 0.5); + cairo_paint(sc_buffer->cairo); + + if (output == selected_output) { + cairo_rectangle(sc_buffer->cairo, selected_x, selected_y, selected_width, selected_height); + cairo_set_line_width(sc_buffer->cairo, 4); + + cairo_set_source_rgba(sc_buffer->cairo, 1.0, 1.0, 1.0, 1.0); + cairo_stroke_preserve(sc_buffer->cairo); + cairo_set_source_rgba(sc_buffer->cairo, 0.0, 0.0, 0.0, 0.0); + cairo_fill(sc_buffer->cairo); + } + + wl_surface_attach(output->ui_surface, sc_buffer->buffer, 0, 0); + wl_surface_damage(output->ui_surface, 0, 0, output->width_px, output->height_px); + wl_surface_commit(output->ui_surface); +} + +static void select_whole(void) { + selected_x = 0; + selected_y = 0; + selected_width = selected_output->width_px; + selected_height = selected_output->height_px; +} + +static void set_selected_output(struct dp_output *output) { + if (output == selected_output) { + return; + } + struct dp_output *prev_selected_output = selected_output; + selected_output = output; + redraw(prev_selected_output); +} + +static void layer_surface_handle_closed(void *data, struct zwlr_layer_surface_v1 *layer_surface) { + die("a layer surface was closed"); +} + +static const struct zwlr_layer_surface_v1_listener layer_surface_listener = { + .configure = layer_surface_handle_configure, + .closed = layer_surface_handle_closed, +}; + +static void output_handle_geometry(void *data, struct wl_output *wl_output, int32_t x, int32_t y, + int32_t phys_width, int32_t phys_height, int32_t subpixel, const char *make, + const char *model, int32_t transform) { + // TODO: handle transform? +} + +static void output_handle_mode(void *data, struct wl_output *wl_output, uint32_t flags, + int32_t width, int32_t height, int32_t refresh) { + struct dp_output *output = data; + output->width_px = width; + output->height_px = height; +} + +static const struct wl_output_listener output_listener = { + .geometry = output_handle_geometry, + .mode = output_handle_mode, +}; + +static void seat_handle_capabilities(void *data, struct wl_seat *seat_, uint32_t caps) { + seat_caps = caps; +} + +static void seat_handle_name(void *data, struct wl_seat *seat_, const char *name) { + // Ignored +} + +static const struct wl_seat_listener seat_listener = { + .capabilities = seat_handle_capabilities, + .name = seat_handle_name, +}; + +static void keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard_, + enum wl_keyboard_keymap_format format, int32_t fd, uint32_t size) { + void *keymap_buffer; + size_t keymap_len; + + xkb_keymap_unref(xkb_keymap); + xkb_state_unref(xkb_state); + + switch (format) { + case WL_KEYBOARD_KEYMAP_FORMAT_NO_KEYMAP: + xkb_keymap = xkb_keymap_new_from_names(xkb_context, NULL, XKB_KEYMAP_COMPILE_NO_FLAGS); + break; + case WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1: + keymap_len = size - 1; + keymap_buffer = mmap(NULL, keymap_len, PROT_READ, MAP_PRIVATE, fd, 0); + if (keymap_buffer == MAP_FAILED) { + die("mmap() for a keymap failed"); + } + xkb_keymap = xkb_keymap_new_from_buffer(xkb_context, keymap_buffer, keymap_len, + XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS); + munmap(keymap_buffer, keymap_len); + close(fd); + break; + } + + xkb_state = xkb_state_new(xkb_keymap); +} + +static void keyboard_handle_enter(void *data, struct wl_keyboard *keyboard_, uint32_t serial, + struct wl_surface *surface, struct wl_array *mods) { + // Ignored +} + +static void keyboard_handle_leave( + void *data, struct wl_keyboard *keyboard_, uint32_t serial, struct wl_surface *surface) { + // Ignored +} + +static void keyboard_handle_key(void *data, struct wl_keyboard *keyboard_, uint32_t serial, + uint32_t time_msec, uint32_t key, enum wl_keyboard_key_state state) { + if (xkb_state == NULL) { + return; // Shouldn't happen + } + + if (state != WL_KEYBOARD_KEY_STATE_PRESSED) { + return; + } + + xkb_keysym_t keysym = xkb_state_key_get_one_sym(xkb_state, key + 8); + switch (keysym) { + case XKB_KEY_q: + status = DP_QUIT; + break; + case XKB_KEY_s: + status = DP_SAVE; + break; + case XKB_KEY_w: + select_whole(); + redraw(selected_output); + break; + case XKB_KEY_Tab: + set_selected_output(wl_container_of( + (selected_output->link.next != &outputs ? &selected_output->link : &outputs)->next, + selected_output, link)); + select_whole(); + redraw(selected_output); + break; + } +} + +static void keyboard_handle_modifiers(void *data, struct wl_keyboard *keyboard_, uint32_t serial, + uint32_t depressed, uint32_t latched, uint32_t locked, uint32_t group) { + if (xkb_state == NULL) { + return; // Shouldn't happen + } + xkb_state_update_mask(xkb_state, depressed, latched, locked, 0, 0, group); +} + +static const struct wl_keyboard_listener keyboard_listener = { + .keymap = keyboard_handle_keymap, + .enter = keyboard_handle_enter, + .leave = keyboard_handle_leave, + .key = keyboard_handle_key, + .modifiers = keyboard_handle_modifiers, +}; + +static void convert_pos(wl_fixed_t x, wl_fixed_t y, int *out_x, int *out_y) { + assert(pointer_output != NULL); + *out_x = (int)wl_fixed_to_double(x) * pointer_output->width_px / pointer_output->width; + *out_y = (int)wl_fixed_to_double(y) * pointer_output->height_px / pointer_output->height; +} + +static void pointer_handle_enter(void *data, struct wl_pointer *pointer_, uint32_t serial, + struct wl_surface *surface, wl_fixed_t sx, wl_fixed_t sy) { + pointer_output = wl_surface_get_user_data(surface); + assert(pointer_output != NULL); + convert_pos(sx, sy, &pointer_x, &pointer_y); +} + +static void pointer_handle_leave( + void *data, struct wl_pointer *pointer_, uint32_t serial, struct wl_surface *surface) { + pointer_output = NULL; + selecting_rect = false; +} + +static void pointer_handle_motion( + void *data, struct wl_pointer *pointer_, uint32_t serial, wl_fixed_t sx, wl_fixed_t sy) { + if (pointer_output == NULL) { + return; // Shouldn't happen + } + convert_pos(sx, sy, &pointer_x, &pointer_y); + + if (!selecting_rect) { + return; + } + if (pointer_x < select_start_x) { + selected_x = pointer_x; + selected_width = select_start_x - pointer_x; + } else { + selected_x = select_start_x; + selected_width = pointer_x - select_start_x; + } + if (pointer_y < select_start_y) { + selected_y = pointer_y; + selected_height = select_start_y - pointer_y; + } else { + selected_y = select_start_y; + selected_height = pointer_y - select_start_y; + } + redraw(selected_output); +} + +static void pointer_handle_button(void *data, struct wl_pointer *pointer_, uint32_t serial, + uint32_t time_msec, uint32_t button, enum wl_pointer_button_state state) { + if (pointer_output == NULL) { + return; // Shouldn't happen + } + if (state != WL_POINTER_BUTTON_STATE_PRESSED) { + selecting_rect = false; + if (save_on_select) { + status = DP_SAVE; + } + return; + } + + switch (button) { + case BTN_LEFT: + selecting_rect = true; + selected_x = pointer_x; + selected_y = pointer_y; + selected_width = 0; + selected_height = 0; + select_start_x = selected_x; + select_start_y = selected_y; + set_selected_output(pointer_output); + redraw(selected_output); + break; + case BTN_RIGHT: + set_selected_output(pointer_output); + select_whole(); + redraw(selected_output); + break; + } +} + +static void pointer_handle_axis(void *data, struct wl_pointer *pointer_, uint32_t time_msec, + enum wl_pointer_axis axis, wl_fixed_t value) { +} + +static const struct wl_pointer_listener pointer_listener = { + .enter = pointer_handle_enter, + .leave = pointer_handle_leave, + .motion = pointer_handle_motion, + .button = pointer_handle_button, + .axis = pointer_handle_axis, +}; + +static void frame_handle_buffer(void *data, struct zwlr_screencopy_frame_v1 *frame, uint32_t format, + uint32_t width, uint32_t height, uint32_t stride) { + // TODO +} + +static void frame_handle_flags(void *data, struct zwlr_screencopy_frame_v1 *frame, uint32_t flags) { + if (flags != 0) { + die("who the fuck uses Y_INVERT"); + } +} + +static void frame_handle_ready(void *data, struct zwlr_screencopy_frame_v1 *frame, + uint32_t tv_sec_hi, uint32_t tv_sec_lo, uint32_t tv_nsec) { + struct dp_output *output = data; + output->frame_ready = true; +} + +static void frame_handle_failed(void *data, struct zwlr_screencopy_frame_v1 *frame) { + die("frame copying has failed"); +} + +static const struct zwlr_screencopy_frame_v1_listener frame_listener = { + .buffer = frame_handle_buffer, + .flags = frame_handle_flags, + .ready = frame_handle_ready, + .failed = frame_handle_failed, +}; + +static void registry_handle_global(void *data, struct wl_registry *registry, uint32_t name, + const char *interface, uint32_t version) { + if (strcmp(interface, wl_compositor_interface.name) == 0) { + compositor = wl_registry_bind(registry, name, &wl_compositor_interface, 1); + } else if (strcmp(interface, wl_subcompositor_interface.name) == 0) { + subcompositor = wl_registry_bind(registry, name, &wl_subcompositor_interface, 1); + } else if (strcmp(interface, wp_viewporter_interface.name) == 0) { + viewporter = wl_registry_bind(registry, name, &wp_viewporter_interface, 1); + } else if (strcmp(interface, wl_shm_interface.name) == 0) { + shm = wl_registry_bind(registry, name, &wl_shm_interface, 1); + } else if (strcmp(interface, zwlr_layer_shell_v1_interface.name) == 0) { + layer_shell = wl_registry_bind(registry, name, &zwlr_layer_shell_v1_interface, 1); + } else if (strcmp(interface, zwlr_screencopy_manager_v1_interface.name) == 0) { + screencopy_manager = + wl_registry_bind(registry, name, &zwlr_screencopy_manager_v1_interface, 1); + } else if (strcmp(interface, wl_output_interface.name) == 0) { + struct dp_output *output = xzalloc(sizeof(*output)); + output->name = name; + output->global = wl_registry_bind(registry, name, &wl_output_interface, 1); + wl_output_add_listener(output->global, &output_listener, output); + + wl_list_insert(&outputs, &output->link); + } else if (strcmp(interface, wl_seat_interface.name) == 0) { + // No multiseat + if (seat == NULL) { + seat = wl_registry_bind(registry, name, &wl_seat_interface, 1); + wl_seat_add_listener(seat, &seat_listener, NULL); + } + } +} + +static void registry_handle_global_remove(void *data, struct wl_registry *registry, uint32_t name) { + struct dp_output *output; + wl_list_for_each (output, &outputs, link) { + if (output->name == name) { + die("an output was removed"); + } + } +} + +static const struct wl_registry_listener registry_listener = { + .global = registry_handle_global, + .global_remove = registry_handle_global_remove, +}; + +int main(void) { + struct wl_display *display = wl_display_connect(NULL); + if (display == NULL) { + die("failed to connect to a Wayland compositor"); + } + + xkb_context = xkb_context_new(XKB_CONTEXT_NO_FLAGS); + + wl_list_init(&outputs); + + struct wl_registry *registry = wl_display_get_registry(display); + wl_registry_add_listener(registry, ®istry_listener, NULL); + + // Collect globals + wl_display_roundtrip(display); + + if (compositor == NULL) { + die("the compositor has no wl_compositor"); + } else if (subcompositor == NULL) { + die("the compositor has no wl_subcompositor"); + } else if (viewporter == NULL) { + die("the compositor has no wp_viewporter"); + } else if (shm == NULL) { + die("the compositor has no wl_shm"); + } else if (layer_shell == NULL) { + die("the compositor has no zwlr_layer_shell_v1"); + } else if (screencopy_manager == NULL) { + die("the compositor has no zwlr_screencopy_manager_v1"); + } else if (seat == NULL) { + die("the compositor has no wl_seat"); + } + + if (wl_list_empty(&outputs)) { + die("no outputs found"); + } + + struct dp_output *output; + + // Get output/seat info + wl_display_roundtrip(display); + + if ((seat_caps & WL_SEAT_CAPABILITY_KEYBOARD) == 0) { + die("the seat has no keyboard capabilities"); + } + if ((seat_caps & WL_SEAT_CAPABILITY_POINTER) == 0) { + die("the seat has no pointer capabilities"); + } + + keyboard = wl_seat_get_keyboard(seat); + wl_keyboard_add_listener(keyboard, &keyboard_listener, NULL); + + pointer = wl_seat_get_pointer(seat); + wl_pointer_add_listener(pointer, &pointer_listener, NULL); + + wl_list_for_each (output, &outputs, link) { + output->frame = zwlr_screencopy_manager_v1_capture_output( + screencopy_manager, false, output->global); + zwlr_screencopy_frame_v1_add_listener(output->frame, &frame_listener, output); + } + + // Get formats + wl_display_roundtrip(display); + + // TODO: actually check formats + wl_list_for_each (output, &outputs, link) { + output->frame_format = WL_SHM_FORMAT_XBGR8888; + output->frame_stride = output->width_px * 4; + } + + wl_list_for_each (output, &outputs, link) { + output->frame_buffer = create_buffer(output->width_px, output->height_px, + output->frame_stride, output->frame_format, &output->frame_data); + zwlr_screencopy_frame_v1_copy(output->frame, output->frame_buffer); + } + + wl_list_for_each (output, &outputs, link) { + while (!output->frame_ready && wl_display_dispatch(display) != -1) { + // Wait + } + } + + // Init surfaces + wl_list_for_each (output, &outputs, link) { + output->surface = wl_compositor_create_surface(compositor); + output->layer_surface = zwlr_layer_shell_v1_get_layer_surface(layer_shell, output->surface, + output->global, ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY, "dulcepan"); + output->viewport = wp_viewporter_get_viewport(viewporter, output->surface); + + zwlr_layer_surface_v1_add_listener(output->layer_surface, &layer_surface_listener, output); + + zwlr_layer_surface_v1_set_anchor(output->layer_surface, + ZWLR_LAYER_SURFACE_V1_ANCHOR_TOP | ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM | + ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT | ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT); + zwlr_layer_surface_v1_set_keyboard_interactivity( + output->layer_surface, ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_EXCLUSIVE); + zwlr_layer_surface_v1_set_exclusive_zone(output->layer_surface, -1); + + output->ui_surface = wl_compositor_create_surface(compositor); + output->ui_subsurface = + wl_subcompositor_get_subsurface(subcompositor, output->ui_surface, output->surface); + output->ui_viewport = wp_viewporter_get_viewport(viewporter, output->ui_surface); + wl_subsurface_set_desync(output->ui_subsurface); + + wl_surface_set_user_data(output->surface, output); + wl_surface_set_user_data(output->ui_surface, output); + + for (size_t i = 0; i < SWAPCHAIN_LEN; i++) { + struct dp_swapchain_buffer *sc_buffer = &output->swapchain[i]; + int stride = output->width_px * 4; + sc_buffer->buffer = create_buffer(output->width_px, output->height_px, stride, + WL_SHM_FORMAT_ARGB8888, &sc_buffer->data); + sc_buffer->cairo_surface = cairo_image_surface_create_for_data(sc_buffer->data, + CAIRO_FORMAT_ARGB32, output->width_px, output->height_px, stride); + sc_buffer->cairo = cairo_create(sc_buffer->cairo_surface); + + wl_buffer_add_listener(sc_buffer->buffer, &sc_buffer_listener, sc_buffer); + } + + wl_surface_commit(output->surface); + } + + // Select the "first" output, whatever that is + selected_output = wl_container_of(outputs.next, selected_output, link); + select_whole(); + + wl_list_for_each (output, &outputs, link) { + while (!output->configured && wl_display_dispatch(display) != -1) { + // Wait + } + + wp_viewport_set_destination(output->viewport, output->width, output->height); + wp_viewport_set_destination(output->ui_viewport, output->width, output->height); + + wl_surface_attach(output->surface, output->frame_buffer, 0, 0); + wl_surface_commit(output->surface); + + redraw(output); + } + + while (wl_display_dispatch(display) != -1 && status == DP_RUNNING) { + // Wait + } + + if (status == DP_SAVE) { + if (selected_width == 0 || selected_height == 0) { + die("selected region is empty"); + } + + // TODO: work with compositor-provided formats + // TODO: actually figure out the byte ordering + // TODO: a better file format + + fprintf(stdout, "P6\n%d %d\n255\n", selected_width, selected_height); + char *data = selected_output->frame_data; + int stride = selected_output->width_px * 4; + for (int y = 0; y < selected_height; y++) { + int base = (selected_y + y) * stride; + for (int x = 0; x < selected_width; x++) { + int i = base + (selected_x + x) * 4; + fwrite(&data[i], 1, 3, stdout); + } + } + fflush(stdout); + } + + wl_registry_destroy(registry); + wl_display_disconnect(display); + + return 0; +} diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..96341a5 --- /dev/null +++ b/meson.build @@ -0,0 +1,61 @@ +project( + 'dulcepan', + 'c', + version: '0.1.0', + license: 'GPL-3.0-only', + default_options: [ + 'c_std=c11', + 'warning_level=3', + ], +) + +add_project_arguments( + [ + '-D_POSIX_C_SOURCE=200809L', + ], + language: 'c', +) + +cc = meson.get_compiler('c') + +add_project_arguments(cc.get_supported_arguments([ + '-Wconversion', + '-Wendif-labels', + '-Wimplicit-fallthrough=2', + '-Wlogical-op', + '-Wmissing-include-dirs', + '-Wmissing-prototypes', + '-Wold-style-definition', + '-Wpointer-arith', + '-Woverflow', + '-Wshadow', + '-Wstrict-aliasing=2', + '-Wstrict-prototypes', + '-Wundef', + + '-Wno-unused-parameter', +]), language: 'c') + +wayland_client = dependency('wayland-client') +wayland_protos = dependency('wayland-protocols') + +cairo = dependency('cairo') +xkbcommon = dependency('xkbcommon') + +subdir('protocols') + +src = files( + 'main.c', +) + +executable( + meson.project_name(), + src, + dependencies: [ + client_protos, + wayland_client, + cairo, + xkbcommon, + ], + install: true, +) diff --git a/protocols/meson.build b/protocols/meson.build new file mode 100644 index 0000000..a0c4ef2 --- /dev/null +++ b/protocols/meson.build @@ -0,0 +1,41 @@ +wl_protocol_dir = wayland_protos.get_variable('pkgdatadir') +wayland_scanner = find_program('wayland-scanner') + +wayland_scanner_code = generator( + wayland_scanner, + output: '@BASENAME@-protocol.c', + arguments: ['private-code', '@INPUT@', '@OUTPUT@'], +) + +wayland_scanner_client = generator( + wayland_scanner, + output: '@BASENAME@-protocol.h', + arguments: ['client-header', '@INPUT@', '@OUTPUT@'], +) + +client_protocols = [ + wl_protocol_dir / 'stable/viewporter/viewporter.xml', + wl_protocol_dir / 'stable/xdg-shell/xdg-shell.xml', # layer-shell dependency + wl_protocol_dir / 'staging/fractional-scale/fractional-scale-v1.xml', + 'wlr-layer-shell-unstable-v1.xml', + 'wlr-screencopy-unstable-v1.xml', +] + +client_protos_src = [] +client_protos_headers = [] + +foreach xml : client_protocols + client_protos_src += wayland_scanner_code.process(xml) + client_protos_headers += wayland_scanner_client.process(xml) +endforeach + +lib_client_protos = static_library( + 'client_protos', + client_protos_src + client_protos_headers, + dependencies: [wayland_client] +) + +client_protos = declare_dependency( + link_with: lib_client_protos, + sources: client_protos_headers, +) diff --git a/protocols/wlr-layer-shell-unstable-v1.xml b/protocols/wlr-layer-shell-unstable-v1.xml new file mode 100644 index 0000000..e9f27e4 --- /dev/null +++ b/protocols/wlr-layer-shell-unstable-v1.xml @@ -0,0 +1,407 @@ + + + + Copyright © 2017 Drew DeVault + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + the copyright holders not be used in advertising or publicity + pertaining to distribution of the software without specific, + written prior permission. The copyright holders make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN + AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + + + + + Clients can use this interface to assign the surface_layer role to + wl_surfaces. Such surfaces are assigned to a "layer" of the output and + rendered with a defined z-depth respective to each other. They may also be + anchored to the edges and corners of a screen and specify input handling + semantics. This interface should be suitable for the implementation of + many desktop shell components, and a broad number of other applications + that interact with the desktop. + + + + + Create a layer surface for an existing surface. This assigns the role of + layer_surface, or raises a protocol error if another role is already + assigned. + + Creating a layer surface from a wl_surface which has a buffer attached + or committed is a client error, and any attempts by a client to attach + or manipulate a buffer prior to the first layer_surface.configure call + must also be treated as errors. + + After creating a layer_surface object and setting it up, the client + must perform an initial commit without any buffer attached. + The compositor will reply with a layer_surface.configure event. + The client must acknowledge it and is then allowed to attach a buffer + to map the surface. + + You may pass NULL for output to allow the compositor to decide which + output to use. Generally this will be the one that the user most + recently interacted with. + + Clients can specify a namespace that defines the purpose of the layer + surface. + + + + + + + + + + + + + + + + + These values indicate which layers a surface can be rendered in. They + are ordered by z depth, bottom-most first. Traditional shell surfaces + will typically be rendered between the bottom and top layers. + Fullscreen shell surfaces are typically rendered at the top layer. + Multiple surfaces can share a single layer, and ordering within a + single layer is undefined. + + + + + + + + + + + + + This request indicates that the client will not use the layer_shell + object any more. Objects that have been created through this instance + are not affected. + + + + + + + An interface that may be implemented by a wl_surface, for surfaces that + are designed to be rendered as a layer of a stacked desktop-like + environment. + + Layer surface state (layer, size, anchor, exclusive zone, + margin, interactivity) is double-buffered, and will be applied at the + time wl_surface.commit of the corresponding wl_surface is called. + + Attaching a null buffer to a layer surface unmaps it. + + Unmapping a layer_surface means that the surface cannot be shown by the + compositor until it is explicitly mapped again. The layer_surface + returns to the state it had right after layer_shell.get_layer_surface. + The client can re-map the surface by performing a commit without any + buffer attached, waiting for a configure event and handling it as usual. + + + + + Sets the size of the surface in surface-local coordinates. The + compositor will display the surface centered with respect to its + anchors. + + If you pass 0 for either value, the compositor will assign it and + inform you of the assignment in the configure event. You must set your + anchor to opposite edges in the dimensions you omit; not doing so is a + protocol error. Both values are 0 by default. + + Size is double-buffered, see wl_surface.commit. + + + + + + + + Requests that the compositor anchor the surface to the specified edges + and corners. If two orthogonal edges are specified (e.g. 'top' and + 'left'), then the anchor point will be the intersection of the edges + (e.g. the top left corner of the output); otherwise the anchor point + will be centered on that edge, or in the center if none is specified. + + Anchor is double-buffered, see wl_surface.commit. + + + + + + + Requests that the compositor avoids occluding an area with other + surfaces. The compositor's use of this information is + implementation-dependent - do not assume that this region will not + actually be occluded. + + A positive value is only meaningful if the surface is anchored to one + edge or an edge and both perpendicular edges. If the surface is not + anchored, anchored to only two perpendicular edges (a corner), anchored + to only two parallel edges or anchored to all edges, a positive value + will be treated the same as zero. + + A positive zone is the distance from the edge in surface-local + coordinates to consider exclusive. + + Surfaces that do not wish to have an exclusive zone may instead specify + how they should interact with surfaces that do. If set to zero, the + surface indicates that it would like to be moved to avoid occluding + surfaces with a positive exclusive zone. If set to -1, the surface + indicates that it would not like to be moved to accommodate for other + surfaces, and the compositor should extend it all the way to the edges + it is anchored to. + + For example, a panel might set its exclusive zone to 10, so that + maximized shell surfaces are not shown on top of it. A notification + might set its exclusive zone to 0, so that it is moved to avoid + occluding the panel, but shell surfaces are shown underneath it. A + wallpaper or lock screen might set their exclusive zone to -1, so that + they stretch below or over the panel. + + The default value is 0. + + Exclusive zone is double-buffered, see wl_surface.commit. + + + + + + + Requests that the surface be placed some distance away from the anchor + point on the output, in surface-local coordinates. Setting this value + for edges you are not anchored to has no effect. + + The exclusive zone includes the margin. + + Margin is double-buffered, see wl_surface.commit. + + + + + + + + + + Types of keyboard interaction possible for layer shell surfaces. The + rationale for this is twofold: (1) some applications are not interested + in keyboard events and not allowing them to be focused can improve the + desktop experience; (2) some applications will want to take exclusive + keyboard focus. + + + + + This value indicates that this surface is not interested in keyboard + events and the compositor should never assign it the keyboard focus. + + This is the default value, set for newly created layer shell surfaces. + + This is useful for e.g. desktop widgets that display information or + only have interaction with non-keyboard input devices. + + + + + Request exclusive keyboard focus if this surface is above the shell surface layer. + + For the top and overlay layers, the seat will always give + exclusive keyboard focus to the top-most layer which has keyboard + interactivity set to exclusive. If this layer contains multiple + surfaces with keyboard interactivity set to exclusive, the compositor + determines the one receiving keyboard events in an implementation- + defined manner. In this case, no guarantee is made when this surface + will receive keyboard focus (if ever). + + For the bottom and background layers, the compositor is allowed to use + normal focus semantics. + + This setting is mainly intended for applications that need to ensure + they receive all keyboard events, such as a lock screen or a password + prompt. + + + + + This requests the compositor to allow this surface to be focused and + unfocused by the user in an implementation-defined manner. The user + should be able to unfocus this surface even regardless of the layer + it is on. + + Typically, the compositor will want to use its normal mechanism to + manage keyboard focus between layer shell surfaces with this setting + and regular toplevels on the desktop layer (e.g. click to focus). + Nevertheless, it is possible for a compositor to require a special + interaction to focus or unfocus layer shell surfaces (e.g. requiring + a click even if focus follows the mouse normally, or providing a + keybinding to switch focus between layers). + + This setting is mainly intended for desktop shell components (e.g. + panels) that allow keyboard interaction. Using this option can allow + implementing a desktop shell that can be fully usable without the + mouse. + + + + + + + Set how keyboard events are delivered to this surface. By default, + layer shell surfaces do not receive keyboard events; this request can + be used to change this. + + This setting is inherited by child surfaces set by the get_popup + request. + + Layer surfaces receive pointer, touch, and tablet events normally. If + you do not want to receive them, set the input region on your surface + to an empty region. + + Keyboard interactivity is double-buffered, see wl_surface.commit. + + + + + + + This assigns an xdg_popup's parent to this layer_surface. This popup + should have been created via xdg_surface::get_popup with the parent set + to NULL, and this request must be invoked before committing the popup's + initial state. + + See the documentation of xdg_popup for more details about what an + xdg_popup is and how it is used. + + + + + + + When a configure event is received, if a client commits the + surface in response to the configure event, then the client + must make an ack_configure request sometime before the commit + request, passing along the serial of the configure event. + + If the client receives multiple configure events before it + can respond to one, it only has to ack the last configure event. + + A client is not required to commit immediately after sending + an ack_configure request - it may even ack_configure several times + before its next surface commit. + + A client may send multiple ack_configure requests before committing, but + only the last request sent before a commit indicates which configure + event the client really is responding to. + + + + + + + This request destroys the layer surface. + + + + + + The configure event asks the client to resize its surface. + + Clients should arrange their surface for the new states, and then send + an ack_configure request with the serial sent in this configure event at + some point before committing the new surface. + + The client is free to dismiss all but the last configure event it + received. + + The width and height arguments specify the size of the window in + surface-local coordinates. + + The size is a hint, in the sense that the client is free to ignore it if + it doesn't resize, pick a smaller size (to satisfy aspect ratio or + resize in steps of NxM pixels). If the client picks a smaller size and + is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the + surface will be centered on this axis. + + If the width or height arguments are zero, it means the client should + decide its own window dimension. + + + + + + + + + The closed event is sent by the compositor when the surface will no + longer be shown. The output may have been destroyed or the user may + have asked for it to be removed. Further changes to the surface will be + ignored. The client should destroy the resource after receiving this + event, and create a new surface if they so choose. + + + + + + + + + + + + + + + + + + + + + + + Change the layer that the surface is rendered on. + + Layer is double-buffered, see wl_surface.commit. + + + + + + + + + Requests an edge for the exclusive zone to apply. The exclusive + edge will be automatically deduced from anchor points when possible, + but when the surface is anchored to a corner, it will be necessary + to set it explicitly to disambiguate, as it is not possible to deduce + which one of the two corner edges should be used. + + The edge must be one the surface is anchored to, otherwise the + invalid_exclusive_edge protocol error will be raised. + + + + + diff --git a/protocols/wlr-screencopy-unstable-v1.xml b/protocols/wlr-screencopy-unstable-v1.xml new file mode 100644 index 0000000..50b1b7d --- /dev/null +++ b/protocols/wlr-screencopy-unstable-v1.xml @@ -0,0 +1,232 @@ + + + + Copyright © 2018 Simon Ser + Copyright © 2019 Andri Yngvason + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + This protocol allows clients to ask the compositor to copy part of the + screen content to a client buffer. + + Warning! The protocol described in this file is experimental and + backward incompatible changes may be made. Backward compatible changes + may be added together with the corresponding interface version bump. + Backward incompatible changes are done by bumping the version number in + the protocol and interface names and resetting the interface version. + Once the protocol is to be declared stable, the 'z' prefix and the + version number in the protocol and interface names are removed and the + interface version number is reset. + + + + + This object is a manager which offers requests to start capturing from a + source. + + + + + Capture the next frame of an entire output. + + + + + + + + + Capture the next frame of an output's region. + + The region is given in output logical coordinates, see + xdg_output.logical_size. The region will be clipped to the output's + extents. + + + + + + + + + + + + + All objects created by the manager will still remain valid, until their + appropriate destroy request has been called. + + + + + + + This object represents a single frame. + + When created, a series of buffer events will be sent, each representing a + supported buffer type. The "buffer_done" event is sent afterwards to + indicate that all supported buffer types have been enumerated. The client + will then be able to send a "copy" request. If the capture is successful, + the compositor will send a "flags" followed by a "ready" event. + + For objects version 2 or lower, wl_shm buffers are always supported, ie. + the "buffer" event is guaranteed to be sent. + + If the capture failed, the "failed" event is sent. This can happen anytime + before the "ready" event. + + Once either a "ready" or a "failed" event is received, the client should + destroy the frame. + + + + + Provides information about wl_shm buffer parameters that need to be + used for this frame. This event is sent once after the frame is created + if wl_shm buffers are supported. + + + + + + + + + + Copy the frame to the supplied buffer. The buffer must have a the + correct size, see zwlr_screencopy_frame_v1.buffer and + zwlr_screencopy_frame_v1.linux_dmabuf. The buffer needs to have a + supported format. + + If the frame is successfully copied, a "flags" and a "ready" events are + sent. Otherwise, a "failed" event is sent. + + + + + + + + + + + + + + + + Provides flags about the frame. This event is sent once before the + "ready" event. + + + + + + + Called as soon as the frame is copied, indicating it is available + for reading. This event includes the time at which presentation happened + at. + + The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, + each component being an unsigned 32-bit value. Whole seconds are in + tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, + and the additional fractional part in tv_nsec as nanoseconds. Hence, + for valid timestamps tv_nsec must be in [0, 999999999]. The seconds part + may have an arbitrary offset at start. + + After receiving this event, the client should destroy the object. + + + + + + + + + This event indicates that the attempted frame copy has failed. + + After receiving this event, the client should destroy the object. + + + + + + Destroys the frame. This request can be sent at any time by the client. + + + + + + + Same as copy, except it waits until there is damage to copy. + + + + + + + This event is sent right before the ready event when copy_with_damage is + requested. It may be generated multiple times for each copy_with_damage + request. + + The arguments describe a box around an area that has changed since the + last copy request that was derived from the current screencopy manager + instance. + + The union of all regions received between the call to copy_with_damage + and a ready event is the total damage since the prior ready event. + + + + + + + + + + + Provides information about linux-dmabuf buffer parameters that need to + be used for this frame. This event is sent once after the frame is + created if linux-dmabuf buffers are supported. + + + + + + + + + This event is sent once after all buffer events have been sent. + + The client should proceed to create a buffer of one of the supported + types, and send a "copy" request. + + + +