diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-10-22 20:47:49 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-10-22 20:48:13 +0200 |
| commit | 6aeb2443f562c9b879009137c4aa92cfd592a93e (patch) | |
| tree | b8e1a7028b0472fbd88019a2b9325024038443e3 | |
| parent | Fix Python 3.7 compatility (diff) | |
| download | pylibcoopgamma-6aeb2443f562c9b879009137c4aa92cfd592a93e.tar.gz pylibcoopgamma-6aeb2443f562c9b879009137c4aa92cfd592a93e.tar.bz2 pylibcoopgamma-6aeb2443f562c9b879009137c4aa92cfd592a93e.tar.xz | |
Change license, flat file hier, do not use gpp, join .py and .pyx, simpler makefile1.1.2
Signed-off-by: Mattias Andrée <maandree@kth.se>
| -rw-r--r-- | .gitignore | 15 | ||||
| -rw-r--r-- | COPYING | 15 | ||||
| -rw-r--r-- | DEPENDENCIES | 2 | ||||
| -rw-r--r-- | LICENSE | 683 | ||||
| -rw-r--r-- | Makefile | 144 | ||||
| -rw-r--r-- | README | 1 | ||||
| -rw-r--r-- | config.mk | 16 | ||||
| -rw-r--r-- | include-libcoopgamma.h | 10 | ||||
| -rw-r--r-- | libcoopgamma.pyx (renamed from src/libcoopgamma_native.pyx.gpp) | 1289 | ||||
| -rw-r--r-- | src/include-libcoopgamma.h | 28 | ||||
| -rw-r--r-- | src/libcoopgamma.py | 1205 | ||||
| -rwxr-xr-x | test (renamed from src/test) | 20 |
12 files changed, 1283 insertions, 2145 deletions
@@ -1,14 +1,9 @@ -bin/ -obj/ -\#*\# +*\#* *~ -__pycache__/ -*.bak -*.sw[op] *.o -*.out *.su *.so -*.gch -*.py[co] -src/*_native_*.c +*.pyc +*.pyo +*.c +__pycache__/ diff --git a/COPYING b/COPYING deleted file mode 100644 index 3730db6..0000000 --- a/COPYING +++ /dev/null @@ -1,15 +0,0 @@ -pylibcoopgamma -- Python library for interfacing with cooperative gamma servers -Copyright (C) 2016 Mattias Andrée (maandree@kth.se) - -This library 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 library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this library. If not, see <http://www.gnu.org/licenses/>. diff --git a/DEPENDENCIES b/DEPENDENCIES index d065d47..090ee1a 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -15,11 +15,9 @@ BUILD DEPENDENCIES: cython coreutils pkg-config - gpp INSTALL DEPENDENCIES: make coreutils - @@ -1,674 +1,15 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 +ISC License - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +© 2016, 2019 Mattias Andrée <maandree@kth.se> - Preamble +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. - The 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. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 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 <http://www.gnu.org/licenses/>. - -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: - - <program> Copyright (C) <year> <name of author> - 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 -<http://www.gnu.org/licenses/>. - - 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 -<http://www.gnu.org/philosophy/why-not-lgpl.html>. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. @@ -1,136 +1,34 @@ -PREFIX = /usr -LIBDIR = $(PREFIX)/lib -DATADIR = $(PREFIX)/share -LICENSEDIR = $(DATADIR)/licenses +.POSIX: -PKGNAME = pylibcoopgamma +CONFIGFILE = config.mk +include $(CONFIGFILE) -GPP = gpp -CYTHON = cython -PKGCONFIG = pkg-config -PYTHON = python3 +all: libcoopgamma.so +libcoopgamma.o: libcoopgamma.c include-libcoopgamma.h -PY_MAJOR = $(shell $(PYTHON) --version | cut -d ' ' -f 2 | cut -d . -f 1) -PY_MINOR = $(shell $(PYTHON) --version | cut -d ' ' -f 2 | cut -d . -f 2) -PY_VER = $(PY_MAJOR)$(PY_MINOR) -PY_VERSION = $(PY_MAJOR).$(PY_MINOR) +.pyx.c: + if ! $(CYTHON) -3 -v $<; then rm -f -- $@; false; fi -PYTHONDIR = $(LIBDIR)/python$(PY_VERSION) +.c.o: + $(CC) -fPIC -c -o $@ $< $(CFLAGS) $(CPPFLAGS) -OPTIMISE = -O2 -LIBS = python$(PY_MAJOR) +.o.so: + $(CC) -shared -o $@ $< $(LDFLAGS) -CC_FLAGS = $$($(PKGCONFIG) --cflags $(LIBS)) -std=c99 $(OPTIMISE) -fPIC $(CFLAGS) $(CPPFLAGS) -LD_FLAGS = $$($(PKGCONFIG) --libs $(LIBS)) -lcoopgamma -std=c99 $(OPTIMISE) -shared $(LDFLAGS) +check: libcoopgamma.so + ./test -ifeq ($(shell test $(PY_VER) -ge 35 ; echo $$?),0) -PY_OPT2_EXT = opt-2.pyc -else -PY_OPT2_EXT = pyo -endif - - - -.PHONY: all -all: base - -.PHONY: base -base: lib - -.PHONY: lib -lib: compiled optimised native - -.PHONY: compiled -compiled: src/__pycache__/libcoopgamma.cpython-$(PY_VER).pyc - -.PHONY: optimised -optimised: src/__pycache__/libcoopgamma.cpython-$(PY_VER).$(PY_OPT2_EXT) - -.PHONY: so-files -native: bin/libcoopgamma_native.so - -obj/libcoopgamma_native.pyx: src/libcoopgamma_native.pyx.gpp - @mkdir -p obj - $(GPP) -s '$$$$' -i src/libcoopgamma_native.pyx.gpp -o $@ - -obj/%.c: obj/%.pyx - if ! $(CYTHON) -3 -v $< ; then rm $@ ; false ; fi - -obj/%.o: obj/%.c src/*.h - $(CC) $(CC_FLAGS) -iquote"src" -c -o $@ $< - -bin/%.so: obj/%.o - @mkdir -p bin - $(CC) $(LD_FLAGS) -o $@ $^ - -src/__pycache__/%.cpython-$(PY_VER).pyc: src/%.py - $(PYTHON) -m compileall $< - -src/__pycache__/%.cpython-$(PY_VER).$(PY_OPT2_EXT): src/%.py - $(PYTHON) -OO -m compileall $< - - - -.PHONY: install -install: install-base - -.PHONY: install-all -install-all: install-base - -.PHONY: install-base -install-base: install-lib install-copyright - -.PHONY: install-lib -install-lib: install-source install-compiled install-optimised install-native - -.PHONY: install-source -install-source: src/libcoopgamma.py - mkdir -p -- "$(DESTDIR)$(PYTHONDIR)" - cp $^ -- "$(DESTDIR)$(PYTHONDIR)" - -.PHONY: install-compiled -install-compiled: src/__pycache__/libcoopgamma.cpython-$(PY_VER).pyc - mkdir -p -- "$(DESTDIR)$(PYTHONDIR)/__pycache__" - cp $^ -- "$(DESTDIR)$(PYTHONDIR)/__pycache__" - -.PHONY: install-optimised -install-optimised: src/__pycache__/libcoopgamma.cpython-$(PY_VER).$(PY_OPT2_EXT) - mkdir -p -- "$(DESTDIR)$(PYTHONDIR)/__pycache__" - cp $^ -- "$(DESTDIR)$(PYTHONDIR)/__pycache__" - -.PHONY: install-native -install-native: bin/libcoopgamma_native.so +install: libcoopgamma.so mkdir -p -- "$(DESTDIR)$(PYTHONDIR)" - cp $^ -- "$(DESTDIR)$(PYTHONDIR)" + cp -- libcoopgamma.so "$(DESTDIR)$(PYTHONDIR)" -.PHONY: install-copyright -install-copyright: install-copying install-license - -.PHONY: install-copying -install-copying: COPYING - mkdir -p -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - cp $^ -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -.PHONY: install-license -install-license: LICENSE - mkdir -p -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - cp $^ -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - - - -.PHONY: uninstall uninstall: - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/COPYING" - -rmdir -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -rm -- "$(DESTDIR)$(PYTHONDIR)/__pycache__/libcoopgamma.cpython-$(PY_VER).$(PY_OPT2_EXT)" - -rm -- "$(DESTDIR)$(PYTHONDIR)/__pycache__/libcoopgamma.cpython-$(PY_VER).pyc" - -rm -- "$(DESTDIR)$(PYTHONDIR)/libcoopgamma.py" - -rm -- "$(DESTDIR)$(PYTHONDIR)/libcoopgamma_native.so" - + -rm -- "$(DESTDIR)$(PYTHONDIR)/libcoopgamma.so" - -.PHONY: clean clean: - -rm -r obj bin src/__pycache__ + -rm -rf -- __pycache__/ *.pyc *.pyo *.c *.o *.su *.so + +.SUFFIXES: +.SUFFIXES: .so .o .c .pyx +.PHONY: all check install uninstall clean @@ -10,4 +10,3 @@ SEE ALSO libcoopgamma(7) Full documentation available locally via the command help in python(1). - diff --git a/config.mk b/config.mk new file mode 100644 index 0000000..610ba13 --- /dev/null +++ b/config.mk @@ -0,0 +1,16 @@ +PREFIX = /usr + +PY_MAJOR = $$($(PYTHON) --version 2>&1 | cut -d ' ' -f 2 | cut -d . -f 1) +PY_MINOR = $$($(PYTHON) --version 2>&1 | cut -d ' ' -f 2 | cut -d . -f 2) +PY_VER = $(PY_MAJOR)$(PY_MINOR) +PY_VERSION = $(PY_MAJOR).$(PY_MINOR) + +PYTHONDIR = $(PREFIX)/lib/python$(PY_VERSION) + +CYTHON = cython +PKGCONFIG = pkg-config +PYTHON = python3 + +CPPFLAGS = +CFLAGS = -std=c99 -Wall $$($(PKGCONFIG) --cflags python$(PY_MAJOR)) -O2 +LDFLAGS = $$($(PKGCONFIG) --libs python$(PY_MAJOR)) -lcoopgamma diff --git a/include-libcoopgamma.h b/include-libcoopgamma.h new file mode 100644 index 0000000..0171df4 --- /dev/null +++ b/include-libcoopgamma.h @@ -0,0 +1,10 @@ +/* See LICENSE file for copyright and license details. */ +#include <libcoopgamma.h> + +#define fclass class +#define u_red_size u8.red_size +#define u_green_size u8.green_size +#define u_blue_size u8.blue_size +#define u_red u8.red +#define u_green u8.green +#define u_blue u8.blue diff --git a/src/libcoopgamma_native.pyx.gpp b/libcoopgamma.pyx index eee05ec..57a53a4 100644 --- a/src/libcoopgamma_native.pyx.gpp +++ b/libcoopgamma.pyx @@ -1,21 +1,5 @@ # -*- python -*- -''' -pylibcoopgamma -- Python library for interfacing with cooperative gamma servers -Copyright (C) 2016 Mattias Andrée (maandree@kth.se) - -This library 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 library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this library. If not, see <http://www.gnu.org/licenses/>. -''' +# See LICENSE file for copyright and license details. cimport cython from libc.stddef cimport size_t @@ -23,6 +7,7 @@ from libc.stdlib cimport calloc, malloc, free from libc.stdint cimport int64_t, uint8_t, uint16_t, uint32_t, uint64_t, intptr_t from libc.errno cimport errno +import enum as _enum ctypedef int libcoopgamma_support_t @@ -90,13 +75,6 @@ cdef extern from "include-libcoopgamma.h": # and `.blue_size` are undefined libcoopgamma_support_t supported # The data type and bit-depth of the ramp stops -$$<cpp <<EOF | tail -n 1 | sed '/#/d' -#include <limits.h> -#if INT_MAX != LONG_MAX - int padding__ -#endif -EOF -$$> size_t red_size # The number of stops in the red ramp size_t green_size @@ -138,13 +116,6 @@ $$> # The CRTC for which the the current filters shall returned int coalesce # Whether to coalesce all filters into one gamma ramp triplet -$$<cpp <<EOF | tail -n 1 | sed '/#/d' -#include <limits.h> -#if INT_MAX != LONG_MAX - int padding__ -#endif -EOF -$$> ctypedef struct libcoopgamma_queried_filter_t: # Stripped down version of `libcoopgamma_filter` which only contains @@ -176,13 +147,6 @@ $$> # and `.filters->priority` is undefined. libcoopgamma_depth_t depth # The data type and bit-depth of the ramp stops -$$<cpp <<EOF | tail -n 1 | sed '/#/d' -#include <limits.h> -#if INT_MAX != LONG_MAX - int padding__ -#endif -EOF -$$> ctypedef struct libcoopgamma_error_t: # Error message from coopgamma server @@ -792,7 +756,7 @@ operation without disconnection from the server -def libcoopgamma_native_get_methods(): +def _libcoopgamma_native_get_methods(): ''' List all recognised adjustment method @@ -818,7 +782,7 @@ def libcoopgamma_native_get_methods(): return ret -def libcoopgamma_native_get_method_and_site(method : str, site : str): +def _libcoopgamma_native_get_method_and_site(method : str, site : str): ''' Get the adjustment method and site @@ -866,7 +830,7 @@ def libcoopgamma_native_get_method_and_site(method : str, site : str): free(rcssite) -def libcoopgamma_native_get_pid_file(method : str, site : str): +def _libcoopgamma_native_get_pid_file(method : str, site : str): ''' Get the PID file of the coopgamma server @@ -904,7 +868,7 @@ def libcoopgamma_native_get_pid_file(method : str, site : str): return int(errno) -def libcoopgamma_native_get_socket_file(method : str, site : str): +def _libcoopgamma_native_get_socket_file(method : str, site : str): ''' Get the socket file of the coopgamma server @@ -943,7 +907,7 @@ def libcoopgamma_native_get_socket_file(method : str, site : str): return int(errno) -def libcoopgamma_native_context_create(): +def _libcoopgamma_native_context_create(): ''' Create an instance of `libcoopgamma_context_t` @@ -963,7 +927,7 @@ def libcoopgamma_native_context_create(): return (True, int(<intptr_t><void*>this)) -def libcoopgamma_native_context_free(address : int): +def _libcoopgamma_native_context_free(address : int): ''' Disconnect and free an instance of a `libcoopgamma_context_t` @@ -974,7 +938,7 @@ def libcoopgamma_native_context_free(address : int): free(this) -def libcoopgamma_native_context_marshal(address : int): +def _libcoopgamma_native_context_marshal(address : int): ''' Marshal a `libcoopgamma_context_t` into a buffer @@ -994,7 +958,7 @@ def libcoopgamma_native_context_marshal(address : int): free(buf) -def libcoopgamma_native_context_unmarshal(buf : bytes): +def _libcoopgamma_native_context_unmarshal(buf : bytes): ''' Unmarshal a `libcoopgamma_context_t` from a buffer @@ -1032,7 +996,7 @@ def libcoopgamma_native_context_unmarshal(buf : bytes): free(bs) -def libcoopgamma_native_context_set_fd(address : int, fd : int): +def _libcoopgamma_native_context_set_fd(address : int, fd : int): ''' Set the field for socket file descriptor in a `libcoopgamma_context_t` @@ -1043,7 +1007,7 @@ def libcoopgamma_native_context_set_fd(address : int, fd : int): this.fd = fd -def libcoopgamma_native_async_context_create(): +def _libcoopgamma_native_async_context_create(): ''' Create an instance of `libcoopgamma_context_t` @@ -1063,7 +1027,7 @@ def libcoopgamma_native_async_context_create(): return (True, int(<intptr_t><void*>this)) -def libcoopgamma_native_async_context_free(address : int): +def _libcoopgamma_native_async_context_free(address : int): ''' Free an instance of a `libcoopgamma_async_context_t` @@ -1074,7 +1038,7 @@ def libcoopgamma_native_async_context_free(address : int): free(this) -def libcoopgamma_native_async_context_marshal(address : int): +def _libcoopgamma_native_async_context_marshal(address : int): ''' Marshal a `libcoopgamma_async_context_t` into a buffer @@ -1095,7 +1059,7 @@ def libcoopgamma_native_async_context_marshal(address : int): return ret -def libcoopgamma_native_async_context_unmarshal(buf : bytes): +def _libcoopgamma_native_async_context_unmarshal(buf : bytes): ''' Unmarshal a `libcoopgamma_async_context_t` from a buffer @@ -1133,7 +1097,7 @@ def libcoopgamma_native_async_context_unmarshal(buf : bytes): free(bs) -def libcoopgamma_native_connect(method : str, site : str, address : int): +def _libcoopgamma_native_connect(method : str, site : str, address : int): ''' Connect to a coopgamma server, and start it if necessary @@ -1170,7 +1134,7 @@ def libcoopgamma_native_connect(method : str, site : str, address : int): free(csite) -def libcoopgamma_native_set_nonblocking(address : int, nonblocking : bool): +def _libcoopgamma_native_set_nonblocking(address : int, nonblocking : bool): ''' By default communication is blocking, this function can be used to switch between blocking and nonblocking @@ -1192,7 +1156,7 @@ def libcoopgamma_native_set_nonblocking(address : int, nonblocking : bool): return 0 -def libcoopgamma_native_flush(address : int): +def _libcoopgamma_native_flush(address : int): ''' Send all pending outbound data @@ -1211,7 +1175,7 @@ def libcoopgamma_native_flush(address : int): return 0 -def libcoopgamma_native_synchronise(address : int, pending : list): +def _libcoopgamma_native_synchronise(address : int, pending : list): ''' Wait for the next message to be received @@ -1238,7 +1202,7 @@ def libcoopgamma_native_synchronise(address : int, pending : list): return (True, <int>selected) -def libcoopgamma_native_skip_message(address : int): +def _libcoopgamma_native_skip_message(address : int): ''' Tell the library that you will not be parsing a receive message @@ -1247,7 +1211,7 @@ def libcoopgamma_native_skip_message(address : int): libcoopgamma_skip_message(<libcoopgamma_context_t*><void*><intptr_t>address) -def libcoopgamma_native_get_crtcs_send(address : int, async_ctx : int): +def _libcoopgamma_native_get_crtcs_send(address : int, async_ctx : int): ''' List all available CRTC:s, send request part @@ -1262,7 +1226,7 @@ def libcoopgamma_native_get_crtcs_send(address : int, async_ctx : int): return 0 -def libcoopgamma_native_get_crtcs_recv(address : int, async_ctx : int): +def _libcoopgamma_native_get_crtcs_recv(address : int, async_ctx : int): ''' List all available CRTC:s, receive response part @@ -1288,7 +1252,7 @@ def libcoopgamma_native_get_crtcs_recv(address : int, async_ctx : int): return ret -def libcoopgamma_native_get_crtcs_sync(address : int): +def _libcoopgamma_native_get_crtcs_sync(address : int): ''' List all available CRTC:s, synchronous version @@ -1319,7 +1283,7 @@ def libcoopgamma_native_get_crtcs_sync(address : int): return ret -def libcoopgamma_native_get_gamma_info_send(crtc : str, address : int, async_ctx : int): +def _libcoopgamma_native_get_gamma_info_send(crtc : str, address : int, async_ctx : int): ''' Retrieve information about a CRTC:s gamma ramps, send request part @@ -1348,7 +1312,7 @@ def libcoopgamma_native_get_gamma_info_send(crtc : str, address : int, async_ctx return 0 -def libcoopgamma_native_get_gamma_info_recv(address : int, async_ctx : int): +def _libcoopgamma_native_get_gamma_info_recv(address : int, async_ctx : int): ''' Retrieve information about a CRTC:s gamma ramps, receive response part @@ -1383,7 +1347,7 @@ def libcoopgamma_native_get_gamma_info_recv(address : int, async_ctx : int): return ret -def libcoopgamma_native_get_gamma_info_sync(crtc : str, address : int): +def _libcoopgamma_native_get_gamma_info_sync(crtc : str, address : int): ''' Retrieve information about a CRTC:s gamma ramps, synchronous version @@ -1428,7 +1392,7 @@ def libcoopgamma_native_get_gamma_info_sync(crtc : str, address : int): return ret -def libcoopgamma_native_get_gamma_send(query, address : int, async_ctx : int): +def _libcoopgamma_native_get_gamma_send(query, address : int, async_ctx : int): ''' Retrieve the current gamma ramp adjustments, send request part @@ -1461,7 +1425,7 @@ def libcoopgamma_native_get_gamma_send(query, address : int, async_ctx : int): return 0 -def libcoopgamma_native_get_gamma_recv(address : int, async_ctx : int): +def _libcoopgamma_native_get_gamma_recv(address : int, async_ctx : int): ''' Retrieve the current gamma ramp adjustments, receive response part @@ -1549,7 +1513,7 @@ def libcoopgamma_native_get_gamma_recv(address : int, async_ctx : int): return ret -def libcoopgamma_native_get_gamma_sync(query, address : int): +def _libcoopgamma_native_get_gamma_sync(query, address : int): ''' Retrieve the current gamma ramp adjustments, synchronous version @@ -1656,7 +1620,7 @@ def libcoopgamma_native_get_gamma_sync(query, address : int): return ret -def libcoopgamma_native_copy_ramps(intptr_t dest_address, src, libcoopgamma_depth_t depth): +def _libcoopgamma_native_copy_ramps(intptr_t dest_address, src, libcoopgamma_depth_t depth): ''' Copy a Python ramp-trio into C ramp-trio @@ -1766,7 +1730,7 @@ def libcoopgamma_native_copy_ramps(intptr_t dest_address, src, libcoopgamma_dept dest.u_blue = <void*>bd -def libcoopgamma_native_set_gamma_send(filtr, address : int, async_ctx : int): +def _libcoopgamma_native_set_gamma_send(filtr, address : int, async_ctx : int): ''' Apply, update, or remove a gamma ramp adjustment, send request part @@ -1797,7 +1761,7 @@ def libcoopgamma_native_set_gamma_send(filtr, address : int, async_ctx : int): flr.ramps.u_blue = NULL try: if filtr.ramps is not None: - libcoopgamma_native_copy_ramps(<intptr_t><void*>&(flr.ramps), filtr.ramps, flr.depth) + _libcoopgamma_native_copy_ramps(<intptr_t><void*>&(flr.ramps), filtr.ramps, flr.depth) flr.crtc = <char*>malloc(len(crtc_bs) * sizeof(char)) if flr.crtc is NULL: return int(errno) @@ -1817,7 +1781,7 @@ def libcoopgamma_native_set_gamma_send(filtr, address : int, async_ctx : int): return 0 -def libcoopgamma_native_set_gamma_recv(address : int, async_ctx : int): +def _libcoopgamma_native_set_gamma_recv(address : int, async_ctx : int): ''' Apply, update, or remove a gamma ramp adjustment, receive response part @@ -1839,7 +1803,7 @@ def libcoopgamma_native_set_gamma_recv(address : int, async_ctx : int): return None -def libcoopgamma_native_set_gamma_sync(filtr, address : int): +def _libcoopgamma_native_set_gamma_sync(filtr, address : int): ''' Apply, update, or remove a gamma ramp adjustment, synchronous version @@ -1873,7 +1837,7 @@ def libcoopgamma_native_set_gamma_sync(filtr, address : int): flr.ramps.u_blue = NULL try: if filtr.ramps is not None: - libcoopgamma_native_copy_ramps(<intptr_t><void*>&(flr.ramps), filtr.ramps, flr.depth) + _libcoopgamma_native_copy_ramps(<intptr_t><void*>&(flr.ramps), filtr.ramps, flr.depth) flr.crtc = <char*>malloc(len(crtc_bs) * sizeof(char)) if flr.crtc is NULL: return int(errno) @@ -1896,3 +1860,1186 @@ def libcoopgamma_native_set_gamma_sync(filtr, address : int): free(flr.ramps.u_red) return None + +class Support(_enum.IntEnum): + ''' + Values used to indicate the support for gamma adjustments + + @value NO=0 Gamma adjustments are not supported + @value MAYBE=1 Don't know whether gamma adjustments are supported + @value YES=2 Gamma adjustments are supported + ''' + NO = 0 + MAYBE = 1 + YES = 2 + + @staticmethod + def str(v): + ''' + Get string representation of a value + + @param v:int The value, must be value of the enum + @return :str Human-readable string representation of the value + ''' + if v == Support.NO: + return 'no' + if v == Support.YES: + return 'yes' + if v == Support.MAYBE: + return 'maybe' + raise ValueError() + + +class Depth(_enum.IntEnum): + ''' + Values used to tell which datatype is used for the gamma ramp stops + + The values will always be the number of bits for integral types, and + negative for floating-point types + + @value UINT8=8 Unsigned 8-bit integer + @value UINT16=16 Unsigned 16-bit integer + @value UINT32=32 Unsigned 32-bit integer + @value UINT64=64 Unsigned 64-bit integer + @value FLOAT<0 Single-precision floating-point + @value DOUBLE<0 Double-precision floating-point + ''' + UINT8 = 8 + UINT16 = 16 + UINT32 = 32 + UINT64 = 64 + FLOAT = -1 + DOUBLE = -2 + + @staticmethod + def str(v): + ''' + Get string representation of a value + + @param v:int The value, must be value of the enum + @return :str Human-readable string representation of the value + ''' + if v == Depth.UINT8: + return '8-bits' + if v == Depth.UINT16: + return '16-bits' + if v == Depth.UINT32: + return '32-bits' + if v == Depth.UINT64: + return '64-bits' + if v == Depth.FLOAT: + return 'single-precision floating-point' + if v == Depth.DOUBLE: + return 'double-precision floating-point' + raise ValueError() + + +class Lifespan(_enum.IntEnum): + ''' + Values used to tell when a filter should be removed + + @value REMOVE=0 Remove the filter now + @value UNTIL_DEATH>0 Remove the filter when disconnecting from the coopgamma server + @value UNTIL_REMOVAL>0 Only remove the filter when it is explicitly requested + ''' + REMOVE = 0 + UNTIL_DEATH = 1 + UNTIL_REMOVAL = 2 + + @staticmethod + def str(v): + ''' + Get string representation of a value + + @param v:int The value, must be value of the enum + @return :str Human-readable string representation of the value + ''' + if v == Lifespan.REMOVE: + return 'remove' + if v == Lifespan.UNTIL_DEATH: + return 'until death' + if v == Lifespan.UNTIL_REMOVAL: + return 'until removal' + raise ValueError() + + +class Colourspace(_enum.IntEnum): + ''' + Colourspaces + + @value UNKNOWN=0 The colourspace is unknown + @value SRGB>0 sRGB (Standard RGB) + @value RGB>0 RGB other than sRGB + @value NON_RGB>0 Non-RGB multicolour + @value GREY>0 Monochrome, greyscale, or some other singlecolour scale + ''' + UNKNOWN = 0 + SRGB = 1 + RGB = 2 + NON_RGB = 3 + GREY = 4 + + @staticmethod + def str(v): + ''' + Get string representation of a value + + @param v:int The value, must be value of the enum + @return :str Human-readable string representation of the value + ''' + if v == Colourspace.UNKNOWN: + return 'unknown' + if v == Colourspace.SRGB: + return 'sRGB' + if v == Colourspace.RGB: + return 'RGB' + if v == Colourspace.NON_RGB: + return 'non-RGB' + if v == Colourspace.GREY: + return 'greyscale' + raise ValueError() + + +class Ramps: + ''' + Gamma ramp structure + + @variable red:list<int> The red gamma ramp + @variable green:list<int> The green gamma ramp + @variable blue:list<int> The blue gamma ramp + ''' + def __init__(self, red, green, blue): + ''' + Constructor + + @param red:int The number of stops in the red ramp + @param green:int The number of stops in the green ramp + @param blue:int The number of stops in the blue ramp + + -- or -- + + @param red:list<int> The red gamma ramp + @param green:list<int> The green gamma ramp + @param blue:list<int> The blue gamma ramp + ''' + if isinstance(red, list): + self.red = list(red) + self.green = list(green) + self.blue = list(blue) + else: + self.red = [0] * red + self.green = [0] * green + self.blue = [0] * blue + + def clone(self): + ''' + Create a copy of the instance + ''' + return Ramps(self.red, self.green, self.blue) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.red, self.green, self.blue) + return 'libcoopgamma.Ramps(%s)' % ', '.join(repr(p) for p in params) + + +class Filter: + ''' + Data set to the coopgamma server to apply, update, or remove a filter + + @variable priority:int The priority of the filter, higher priority + is applied first. The gamma correction should + have priority 0. This is a signed 64-bit integer. + @variable crtc:str The CRTC for which this filter shall be applied + @variable fclass:str Identifier for the filter. + The syntax must be "${PACKAGE_NAME}::${COMMAND_NAME}::${RULE}". + @variable lifespan:Lifespan When shall the filter be removed? + If this member's value is `LIBCOOPGAMMA_REMOVE`, + only `.crtc` and `.class` need also be defined. + @variable depth:Depth The data type and bit-depth of the ramp stops + @variable ramps:Ramps The gamma ramp adjustments of the filter + ''' + def __init__(self, priority = None, crtc = None, fclass = None, lifespan = None, depth = None, ramps = None): + ''' + Constructor + + @param priority:int The priority of the filter, higher priority + is applied first. The gamma correction should + have priority 0. This is a signed 64-bit integer. + @param crtc:str The CRTC for which this filter shall be applied + @param fclass:str Identifier for the filter. + The syntax must be "${PACKAGE_NAME}::${COMMAND_NAME}::${RULE}". + @param lifespan:Lifespan When shall the filter be removed? + If this member's value is `LIBCOOPGAMMA_REMOVE`, + only `.crtc` and `.class` need also be defined. + @param depth:Depth The data type and bit-depth of the ramp stops + @param ramps:Ramps The gamma ramp adjustments of the filter + ''' + self.priority = priority + self.crtc = crtc + self.fclass = fclass + self.lifespan = lifespan + self.depth = depth + self.ramps = ramps + + def clone(self, shallow = False): + ''' + Create a copy of the instance + + @param shallow:bool Create a shallow copy? + ''' + ramps = self.ramps if shallow else self.ramps.clone() + return Filter(self.priority, self.crtc, self.fclass, self.lifespan, self.depth, ramps) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.priority, self.crtc, self.fclass, self.lifespan, self.depth, self.ramps) + return 'libcoopgamma.Filter(%s)' % ', '.join(repr(p) for p in params) + + +class GamutPoint: + ''' + The x- and y-values (CIE xyY) of a colour + + @variable x_raw:int The x-value (CIE xyY) multiplied by 1024 + @variable y_raw:int The y-value (CIE xyY) multiplied by 1024 + @variable x:int The x-value (CIE xyY) + @variable y:int The y-value (CIE xyY) + ''' + def __init__(self, x, y): + ''' + Constructor + + @param x:int The x-value (CIE xyY) multiplied by 1024 + @param y:int The y-value (CIE xyY) multiplied by 1024 + ''' + self.x_raw, self.x = x, x / 1024 + self.y_raw, self.y = y, y / 1024 + + def clone(self): + ''' + Create a copy of the instance + ''' + return GamutPoint(self.x_raw, self.y_raw) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.x_raw, self.y_raw) + return 'libcoopgamma.GamutPoint(%s)' % ', '.join(repr(p) for p in params) + + def __str__(self): + ''' + Get human-readable string representation of instance + + @return :str Human-readable string representation of instance + ''' + return '(%f, %f)' % (self.x, self.y) + + +class Gamut: + ''' + The values of the monitor's colour stimuli + + @variable red:GamutPoint The red stimuli + @variable green:GamutPoint The green stimuli + @variable blue:GamutPoint The blue stimuli + @variable white:GamutPoint The default whitepoint + ''' + def __init__(self, red = None, green = None, blue = None, white = None): + ''' + Constructor + + @param red:GamutPoint|(int, int) The red stimuli + @param green:GamutPoint|(int, int) The green stimuli + @param blue:GamutPoint|(int, int) The blue stimuli + @param white:GamutPoint|(int, int) The default whitepoint + ''' + self.red = GamutPoint(*red) if isinstance(red, tuple) else red + self.green = GamutPoint(*green) if isinstance(green, tuple) else green + self.blue = GamutPoint(*blue) if isinstance(blue, tuple) else blue + self.white = GamutPoint(*white) if isinstance(white, tuple) else white + + def clone(self, shallow = True): + ''' + Create a copy of the instance + + @param shallow:bool Create a shallow copy? + ''' + if shallow: + return Gamut(self.red, self.green, self.blue, self.white) + return Gamut(self.red.clone(), self.green.clone(), self.blue.clone(), self.white.clone()) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (repr(self.red), repr(self.green), repr(self.blue), repr(self.white)) + return 'libcoopgamma.Gamut(%s)' % ', '.join(repr(p) for p in params) + + +class CRTCInfo: + ''' + Gamma ramp meta information for a CRTC + + @variable cooperative:bool Is cooperative gamma server running? + @variable depth:Depth? The data type and bit-depth of the ramp stops + @variable supported:Support Is gamma adjustments supported on the CRTC? + If not, `depth`, `red_size`, `green_size`, + and `blue_size` are undefined + @variable red_size:int? The number of stops in the red ramp + @variable green_size:int? The number of stops in the green ramp + @variable blue_size:int? The number of stops in the blue ramp + @variable colourspace:Colourspace The monitor's colourspace + @variable gamut:Gamut? Measurements of the monitor's colourspace, + `None` if the this information is unavailable. + If this is not `None`, but the colourspace + is not RGB (or sRGB), there is something + wrong. Always check the colourspace. + ''' + def __init__(self, cooperative = None, depth = None, supported = None, red_size = None, + green_size = None, blue_size = None, colourspace = None, gamut = None): + ''' + Constructor + + @param cooperative:bool Is cooperative gamma server running? + @param depth:Depth? The data type and bit-depth of the ramp stops + @param supported:Support Is gamma adjustments supported on the CRTC? + If not, `depth`, `red_size`, `green_size`, + and `blue_size` are undefined + @param red_size:int? The number of stops in the red ramp + @param green_size:int? The number of stops in the green ramp + @param blue_size:int? The number of stops in the blue ramp + @param colourspace:Colourspace The monitor's colourspace + @param gamut:Gamut|tuple? Measurements of the monitor's colourspace, + `None` if the this information is unavailable + ''' + self.cooperative = cooperative + self.depth = depth + self.supported = supported + self.red_size = red_size + self.green_size = green_size + self.blue_size = blue_size + self.colourspace = colourspace + if gamut is None or isinstance(gamut, Gamut): + self.gamut = gamut + else: + self.gamut = Gamut(*gamut) + + def make_ramps(self): + ''' + Construct a `Ramps` instances for this CRTC + + @return :Ramps An instance of `Ramps` with same a number of ramp stops + matching this CRTC + ''' + return Ramps(self.red_size, self.green_size, self.blue_size) + + def clone(self, shallow = True): + ''' + Create a copy of the instance + + @param shallow:bool Create a shallow copy? + ''' + return CRTCInfo(self.cooperative, self.depth, self.supported, self.red_size, + self.green_size, self.blue_size, self.colourspace, + self.gamut if shallow else self.gamut.clone()) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.cooperative, self.depth, self.supported, self.red_size, + self.green_size, self.blue_size, self.colourspace, self.gamut) + return 'libcoopgamma.CRTCInfo(%s)' % ', '.join(repr(p) for p in params) + + +class FilterQuery: + ''' + Data sent to the coopgamma server when requestng the current filter table + + @variable high_priority:int Do no return filters with higher priority than + this value. This is a signed 64-bit integer. + @variable low_priority:int Do no return filters with lower priority than + this value. This is a signed 64-bit integer. + @variable crtc:str The CRTC for which the the current filters shall returned + @variable coalesce:bool Whether to coalesce all filters into one gamma ramp triplet + ''' + def __init__(self, high_priority = 9223372036854775807, + low_priority = -9223372036854775808, crtc = None, coalesce = False): + ''' + Constructor + + @param high_priority:int Do no return filters with higher priority than + this value. This is a signed 64-bit integer. + @param low_priority:int Do no return filters with lower priority than + this value. This is a signed 64-bit integer. + @param crtc:str The CRTC for which the the current filters shall returned + @param coalesce:bool Whether to coalesce all filters into one gamma ramp triplet + ''' + self.high_priority = high_priority + self.low_priority = low_priority + self.crtc = crtc + self.coalesce = coalesce + + def clone(self): + ''' + Create a copy of the instance + ''' + return FilterQuery(self.high_priority, self.low_priority, self.crtc, self.coalesce) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.high_priority, self.low_priority, self.crtc, self.coalesce) + return 'libcoopgamma.FilterQuery(%s)' % ', '.join(repr(p) for p in params) + + +class QueriedFilter: + ''' + Stripped down version of `Filter` which only contains the + information returned in response to "Command: get-gamma" + + @variable priority:int The filter's priority. This is a signed 64-bit integer. + @variable fclass:str The filter's class + @variable ramps:Ramps The gamma ramp adjustments of the filter + ''' + def __init__(self, priority = None, fclass = None, ramps = None): + ''' + Constructor + + @param priority:int The filter's priority. This is a signed 64-bit integer. + @param fclass:str The filter's class + @param ramps:Ramps|tuple The gamma ramp adjustments of the filter + ''' + self.priority = priority + self.fclass = fclass + self.ramps = None + if ramps is not None: + self.ramps = Ramps(*ramps) if isinstance(ramps, tuple) else ramps + + def clone(self, shallow = False): + ''' + Create a copy of the instance + + @param shallow:bool Create a sallow copy? + ''' + ramps = self.ramps if shallow else self.ramps.clone() + return QueriedFilter(self.priority, self.fclass, ramps) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.priority, self.fclass, self.ramps) + return 'libcoopgamma.QueriedFilter(%s)' % ', '.join(repr(p) for p in params) + + +class FilterTable: + ''' + Response type for "Command: get-gamma": a list of applied filters + and meta-information that was necessary for decoding the response + + @variable red_size:int The number of stops in the red ramp + @variable green_size:int The number of stops in the green ramp + @variable blue_size:int The number of stops in the blue ramp + @variable depth:Depth The data type and bit-depth of the ramp stops + @variable filters:list<QueriedFilter> The filters, should be ordered by priority + in descending order, lest there is something + wrong with the coopgamma server. + If filter coalition was requested, there will + be exactly one filter and `filters[0].class` + and `filters[0].priority` are undefined. + ''' + def __init__(self, red_size = None, green_size = None, blue_size = None, depth = None, filters = None): + ''' + Constructor + + @param red_size:int The number of stops in the red ramp + @param green_size:int The number of stops in the green ramp + @param blue_size:int The number of stops in the blue ramp + @param depth:Depth The data type and bit-depth of the ramp stops + @param filters:list<QueriedFilter|tuple> The filters, should be ordered by priority + in descending order, lest there is something + wrong with the coopgamma server. + If filter coalition was requested, there will + be exactly one filter and `filters[0].class` + and `filters[0].priority` are undefined. + ''' + self.red_size = red_size + self.green_size = green_size + self.blue_size = blue_size + self.depth = depth + if filters is None: + self.filters + else: + self.filters = list(QueriedFilter(*f) if isinstance(f, tuple) else f for f in filters) + + def make_ramps(self): + ''' + Construct a `Ramps` instances for this CRTC + + @return :Ramps An instance of `Ramps` with same a number of ramp stops + matching this CRTC + ''' + return Ramps(self.red_size, self.green_size, self.blue_size) + + def clone(self, shallow = False): + ''' + Create a copy of the instance + + @param shallow:bool Create a sallow copy? + ''' + filters = list(self.filters) if shallow else [f.clone() for f in self.filters] + return FilterTable(self.red_size, self.green_size, self.blue_size, self.depth, filters) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.red_size, self.green_size, self.blue_size, self.depth, self.filters) + return 'libcoopgamma.FilterTable(%s)' % ', '.join(repr(p) for p in params) + + +class ErrorReport: + ''' + Error message from coopgamma server + + @variable number:int The error code. If `.custom` is false, 0 indicates success, + otherwise, 0 indicates that no error code has been assigned. + @variable custom:bool Is this a custom error? + @variable server_side:bool Did the error occur on the server-side? + @variable description:str? Error message, can be `None` if `custom` is false + ''' + def __init__(self, number = None, custom = None, server_side = None, description = None): + ''' + Constructor + + @param number:int The error code. If `.custom` is false, 0 indicates success, + otherwise, 0 indicates that no error code has been assigned. + @param custom:bool Is this a custom error? + @param server_side:bool Did the error occur on the server-side? + @param description:str? Error message, can be `None` if `custom` is false + ''' + self.number = number + self.custom = custom + self.server_side = server_side + self.description = description + + def clone(self): + ''' + Create a copy of the instance + ''' + return ErrorReport(self.number, self.custom, self.server_side, self.description) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + params = (self.number, self.custom, self.server_side, self.description) + return 'libcoopgamma.ErrorReport(%s)' % ', '.join(repr(p) for p in params) + + @staticmethod + def create_error(error): + ''' + Create an instance of a subclass of `Exception` + + @param error Error information + ''' + if isinstance(error, int): + import os + return OSError(error, os.strerror(error)) + error = ErrorReport(*error) + if not error.custom and not error.server_side: + import os + return OSError(error.number, os.strerror(error.number)) + else: + return LibcoopgammaError(error) + + +class LibcoopgammaError(Exception): + ''' + libcoopgamma error class + + @variable error:ErrorReport Error information + ''' + def __init__(self, error): + ''' + Constructor + + @param error:ErrorReport Error information + ''' + self.error = error + + def __str__(self): + ''' + Return description and error number as a string + + @return :str Description and error number + ''' + if self.error.description is not None: + if self.error.number != 0: + return '%s (#%i)' % (self.error.description, self.error.number) + else: + return '%s' % self.error.description + else: + return '#%i' % self.error.number + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + return 'libcoopgamma.LibcoopgammaError(%s)' % repr(self.error) + + +class IncompatibleDowngradeError(Exception): + ''' + Unmarshalled state from a newer version, that is not supported, of libcoopgamma + ''' + def __init__(self): + ''' + Constructor + ''' + pass + + def __str__(self): + ''' + Return descriptor of the error + + @return :str Descriptor of the error + ''' + return 'Incompatible downgrade error' + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + return 'libcoopgamma.IncompatibleDowngradeError()' + + +class IncompatibleUpgradeError(Exception): + ''' + Unmarshalled state from an older version, that is no longer supported, of libcoopgamma + ''' + def __init__(self): + ''' + Constructor + ''' + pass + + def __str__(self): + ''' + Return descriptor of the error + + @return :str Descriptor of the error + ''' + return 'Incompatible downgrade error' + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + return 'libcoopgamma.IncompatibleUpgradeErrorError()' + + +class ServerInitialisationError(Exception): + ''' + coopgamma server failed to initialise, reason unknown + ''' + def __init__(self): + ''' + Constructor + ''' + pass + + def __str__(self): + ''' + Return descriptor of the error + + @return :str Descriptor of the error + ''' + return 'Server initialisation error' + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + return 'libcoopgamma.ServerInitialisationError()' + + +class Context: + ''' + Library state + + Use of this structure is not thread-safe, create + one instance per thread that uses this structure + + @variable fd:int File descriptor for the socket + ''' + def __init__(self, fd = -1, buf = None): + ''' + Constructor + + @param fd:int File descriptor for the socket + @param buf:bytes? Buffer to unmarshal + ''' + self.address = None + self.fd = fd + if buf is None: + (successful, value) = _libcoopgamma_native_context_create() + if not successful: + raise ErrorReport.create_error(value) + else: + (error, value) = _libcoopgamma_native_context_unmarshal(buf) + if error < 0: + raise ErrorReport.create_error(value) + elif error == 1: + raise IncompatibleDowngradeError() + elif error == 2: + raise IncompatibleUpgradeError() + self.address = value + + def __del__(self): + ''' + Destructor + ''' + if self.address is not None: + _libcoopgamma_native_context_free(self.address) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + data = _libcoopgamma_native_context_marshal(self.address) + if isinstance(data, int): + raise ErrorReport.create_error(data) + params = (self.fd, data) + return 'libcoopgamma.Context(%s)' % ', '.join(repr(p) for p in params) + + def connect(self, method = None, site = None): + ''' + Connect to a coopgamma server, and start it if necessary + + Use `del` keyword to disconnect + + SIGCHLD must not be ignored or blocked + + All other methods in this class requires that this + method has been called successfully + + @param method:int|str? The adjustment method, `None` for automatic + @param site:str? The site, `None` for automatic + ''' + if method is not None and isinstance(method, int): + method = str(method) + (successful, value) = _libcoopgamma_native_connect(method, site, self.address) + if not successful: + if value == 0: + raise ServerInitialisationError() + else: + raise ErrorReport.create_error(value) + self.fd = value + + def detach(self): + ''' + After calling this function, communication with the + server is impossible, but the connection is not + closed and the when the instance is destroyed the + connection will remain + ''' + _libcoopgamma_native_context_set_fd(self.address, -1) + + def attach(self): + ''' + Undoes the action of `detach` + ''' + _libcoopgamma_native_context_set_fd(self.address, self.fd) + + def set_nonbreaking(self, nonbreaking): + ''' + By default communication is blocking, this function + can be used to switch between blocking and nonblocking + + After setting the communication to nonblocking, `flush`, `synchronise` and + and request-sending functions can fail with EAGAIN and EWOULDBLOCK. It is + safe to continue with `flush` (for `flush` it selfand equest-sending functions) + or `synchronise` just like EINTR failure. + + @param nonblocking:bool Nonblocking mode? + ''' + error = _libcoopgamma_native_set_nonblocking(self.address, nonbreaking) + if error != 0: + raise ErrorReport.create_error(error) + + def flush(self): + ''' + Send all pending outbound data + + If this function or another function that sends a request to the server fails + with EINTR, call this function to complete the transfer. The `async_ctx` parameter + will always be in a properly configured state if a function fails with EINTR. + ''' + error = _libcoopgamma_native_flush(self.address) + if error != 0: + raise ErrorReport.create_error(error) + + def synchronise(self, pending): + ''' + Wait for the next message to be received + + @param pending:list<AsyncContext> Information for each pending request + @return :int? The index of the element in `pending` which corresponds + to the first inbound message, note that this only means + that the message is not for any of the other request, + if the message is corrupt any of the listed requests can + be selected even if it is not for any of the requests. + Functions that parse the message will detect such corruption. + `None` if the message is ignored, which happens if + corresponding AsyncContext is not listed. + ''' + pending = [p.address for p in pending] + (successful, value) = _libcoopgamma_native_synchronise(self.address, pending) + if not successful: + if value == 0: + return None + else: + raise ErrorReport.create_error(value) + else: + return value + + def skip_message(self): + ''' + Tell the library that you will not be parsing a receive message + ''' + _libcoopgamma_native_skip_message(self.address) + + def get_crtcs_send(self, async_ctx): + ''' + List all available CRTC:s, send request part + + @param async_ctx:AsyncContext Slot for information about the request that is + needed to identify and parse the response + ''' + + error = _libcoopgamma_native_get_crtcs_send(self.address, async_ctx.address) + if error != 0: + raise ErrorReport.create_error(error) + + def get_crtcs_recv(self, async_ctx): + ''' + List all available CRTC:s, receive response part + + @param async_ctx:AsyncContext Information about the request + @return :list<str> A list of names. You should only free the outer + pointer, inner pointers are subpointers of the + outer pointer and cannot be freed. + ''' + ret = _libcoopgamma_native_get_crtcs_recv(self.address, async_ctx.address) + if isinstance(ret, int): + raise ErrorReport.create_error(ret) + return ret + + def get_crtcs_sync(self): + ''' + List all available CRTC:s, synchronous version + + This is a synchronous request function, as such, you have to ensure that + communication is blocking (default), and that there are not asynchronous + requests waiting, it also means that EINTR:s are silently ignored and + there no wait to cancel the operation without disconnection from the server + + @return :list<str> A list of names. You should only free the outer pointer, inner + pointers are subpointers of the outer pointer and cannot be freed. + ''' + ret = _libcoopgamma_native_get_crtcs_sync(self.address) + if isinstance(ret, int): + raise ErrorReport.create_error(ret) + return ret + + def get_gamma_info_send(self, crtc, async_ctx): + ''' + Retrieve information about a CRTC:s gamma ramps, send request part + + @param crtc:str The name of the CRT + @param async_ctx:AsyncContext Slot for information about the request that is + needed to identify and parse the response + ''' + error = _libcoopgamma_native_get_gamma_info_send(crtc, self.address, async_ctx.address) + if error != 0: + raise ErrorReport.create_error(error) + + def get_gamma_info_recv(self, async_ctx): + ''' + Retrieve information about a CRTC:s gamma ramps, receive response part + + @param async_ctx:AsyncContext Information about the request + @return :CRTCInfo Information about the CRTC + ''' + value = _libcoopgamma_native_get_gamma_info_recv(self.address, async_ctx.address) + if isinstance(value, int): + raise ErrorReport.create_error(value) + (successful, value) = value + if not successful: + raise ErrorReport.create_error(value) + return CRTCInfo(*value) + + def get_gamma_info_sync(self, crtc): + ''' + Retrieve information about a CRTC:s gamma ramps, synchronous version + + This is a synchronous request function, as such, you have to ensure that + communication is blocking (default), and that there are not asynchronous + requests waiting, it also means that EINTR:s are silently ignored and + there no wait to cancel the operation without disconnection from the server + + @param crtc:str The name of the CRT + @return :CRTCInfo Information about the CRTC + ''' + value = _libcoopgamma_native_get_gamma_info_sync(crtc, self.address) + if isinstance(value, int): + raise ErrorReport.create_error(value) + (successful, value) = value + if not successful: + raise ErrorReport.create_error(value) + return CRTCInfo(*value) + + def get_gamma_send(self, query, async_ctx): + ''' + Retrieve the current gamma ramp adjustments, send request part + + @param query:FilterQuery The query to send + @param async_ctx:AsyncContext Slot for information about the request that is + needed to identify and parse the response + ''' + error = _libcoopgamma_native_get_gamma_send( + query, self.address, async_ctx.address) + if error != 0: + raise ErrorReport.create_error(error) + + def get_gamma_recv(self, async_ctx): + ''' + Retrieve the current gamma ramp adjustments, receive response part + + @param async_ctx:AsyncContext Information about the request + @return :FilterTable Filter table + ''' + value = _libcoopgamma_native_get_gamma_recv(self.address, async_ctx.address) + if isinstance(value, int): + raise ErrorReport.create_error(value) + (successful, value) = value + if not successful: + raise ErrorReport.create_error(value) + return FilterTable(*value) + + def get_gamma_sync(self, query): + ''' + Retrieve the current gamma ramp adjustments, synchronous version + + This is a synchronous request function, as such, you have to ensure that + communication is blocking (default), and that there are not asynchronous + requests waiting, it also means that EINTR:s are silently ignored and + there no wait to cancel the operation without disconnection from the server + + @param query:FilterQuery The query to send + @return :FilterTable Filter table + ''' + value = _libcoopgamma_native_get_gamma_sync(query, self.address) + if isinstance(value, int): + raise ErrorReport.create_error(value) + (successful, value) = value + if not successful: + raise ErrorReport.create_error(value) + return FilterTable(*value) + + def set_gamma_send(self, filtr, async_ctx): + ''' + Apply, update, or remove a gamma ramp adjustment, send request part + + @param filtr:Filter The filter to apply, update, or remove, gamma ramp + meta-data must match the CRTC's + @param async_ctx:AsyncContext Slot for information about the request that is + needed to identify and parse the response + ''' + error = _libcoopgamma_native_set_gamma_send(filtr, self.address, async_ctx.address) + if error != 0: + raise ErrorReport.create_error(error) + + def set_gamma_recv(self, async_ctx): + ''' + Apply, update, or remove a gamma ramp adjustment, receive response part + + @param async_ctx:AsyncContext Information about the request + ''' + error = _libcoopgamma_native_set_gamma_recv(self.address, async_ctx.address) + if error is not None: + raise ErrorReport.create_error(error) + + def set_gamma_sync(self, filtr): + ''' + Apply, update, or remove a gamma ramp adjustment, synchronous version + + This is a synchronous request function, as such, you have to ensure that + communication is blocking (default), and that there are not asynchronous + requests waiting, it also means that EINTR:s are silently ignored and + there no wait to cancel the operation without disconnection from the server + + @param filtr:Filter The filter to apply, update, or remove, + gamma ramp meta-data must match the CRTC's + ''' + error = _libcoopgamma_native_set_gamma_sync(filtr, self.address) + if error is not None: + raise ErrorReport.create_error(error) + + +class AsyncContext: + ''' + Information necessary to identify and parse a response from the server + ''' + def __init__(self, buf = None): + ''' + Constructor + + @param buf:bytes? Buffer to unmarshal + ''' + self.address = None + if buf is None: + (successful, value) = _libcoopgamma_native_async_context_create() + if not successful: + raise ErrorReport.create_error(value) + else: + (error, value) = _libcoopgamma_native_async_context_unmarshal(buf) + if error < 0: + raise ErrorReport.create_error(value) + elif error == 1: + raise IncompatibleDowngradeError() + elif error == 2: + raise IncompatibleUpgradeError() + self.address = value + + def __del__(self): + ''' + Destructor + ''' + if self.address is not None: + _libcoopgamma_native_async_context_free(self.address) + + def __repr__(self): + ''' + Create a parsable string representation of the instance + + @return :str Parsable representation of the instance + ''' + data = _libcoopgamma_native_async_context_marshal(self.address) + if isinstance(data, int): + raise ErrorReport.create_error(data) + return 'libcoopgamma.AsyncContext(%s)' % repr(data) + + +def get_methods(): + ''' + List all recognised adjustment method + + SIGCHLD must not be ignored or blocked + + @return :list<str> A list of names. You should only free the outer pointer, inner + pointers are subpointers of the outer pointer and cannot be freed. + ''' + ret = _libcoopgamma_native_get_methods() + if isinstance(ret, int): + raise ErrorReport.create_error(ret) + return ret + + +def get_method_and_site(method = None, site = None): + ''' + Get the adjustment method and site + + SIGCHLD must not be ignored or blocked + + @param method:int|str? The adjustment method, `None` for automatic + @param site:str? The site, `None` for automatic + @return :(:str, :str?) The selected adjustment method and the selected the + selected site. If the adjustment method only supports + one site or if `site` is `None` and no site can be + selected automatically, the selected site (the second + element in the returned tuple) will be `None`. + ''' + if method is not None: + method = str(method) + ret = _libcoopgamma_native_get_method_and_site(method, site) + if isinstance(ret, int): + raise ErrorReport.create_error(ret) + return ret + + +def get_pid_file(method = None, site = None): + ''' + Get the PID file of the coopgamma server + + SIGCHLD must not be ignored or blocked + + @param method:int|str? The adjustment method, `None` for automatic + @param site:str? The site, `None` for automatic + @return :str? The pathname of the server's PID file. + `None` if the server does not use PID files. + ''' + if method is not None: + method = str(method) + ret = _libcoopgamma_native_get_pid_file(method, site) + if ret is not None and isinstance(ret, int): + raise ErrorReport.create_error(ret) + return ret + + +def get_socket_file(method = None, site = None): + ''' + Get the socket file of the coopgamma server + + SIGCHLD must not be ignored or blocked + + @param method:int|str? The adjustment method, `None` for automatic + @param site:str? The site, `None` for automatic + @return :str? The pathname of the server's socket, `None` if the server does have + its own socket, which is the case when communicating with a server + in a multi-server display server like mds + ''' + if method is not None: + method = str(method) + ret = _libcoopgamma_native_get_socket_file(method, site) + if ret is not None and isinstance(ret, int): + raise ErrorReport.create_error(ret) + return ret diff --git a/src/include-libcoopgamma.h b/src/include-libcoopgamma.h deleted file mode 100644 index 5150bf3..0000000 --- a/src/include-libcoopgamma.h +++ /dev/null @@ -1,28 +0,0 @@ -/** - * pylibcoopgamma -- Python library for interfacing with cooperative gamma servers - * Copyright (C) 2016 Mattias Andrée (maandree@kth.se) - * - * This library 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 library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this library. If not, see <http://www.gnu.org/licenses/>. - */ -#include <libcoopgamma.h> - - -#define fclass class -#define u_red_size u8.red_size -#define u_green_size u8.green_size -#define u_blue_size u8.blue_size -#define u_red u8.red -#define u_green u8.green -#define u_blue u8.blue - diff --git a/src/libcoopgamma.py b/src/libcoopgamma.py deleted file mode 100644 index 37856c1..0000000 --- a/src/libcoopgamma.py +++ /dev/null @@ -1,1205 +0,0 @@ -# -*- python -*- -''' -pylibcoopgamma -- Python library for interfacing with cooperative gamma servers -Copyright (C) 2016 Mattias Andrée (maandree@kth.se) - -This library 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 library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this library. If not, see <http://www.gnu.org/licenses/>. -''' - -import enum, libcoopgamma_native - - -class Support(enum.IntEnum): - ''' - Values used to indicate the support for gamma adjustments - - @value NO=0 Gamma adjustments are not supported - @value MAYBE=1 Don't know whether gamma adjustments are supported - @value YES=2 Gamma adjustments are supported - ''' - NO = 0 - MAYBE = 1 - YES = 2 - - @staticmethod - def str(v): - ''' - Get string representation of a value - - @param v:int The value, must be value of the enum - @return :str Human-readable string representation of the value - ''' - if v == Support.NO: - return 'no' - if v == Support.YES: - return 'yes' - if v == Support.MAYBE: - return 'maybe' - raise ValueError() - - -class Depth(enum.IntEnum): - ''' - Values used to tell which datatype is used for the gamma ramp stops - - The values will always be the number of bits for integral types, and - negative for floating-point types - - @value UINT8=8 Unsigned 8-bit integer - @value UINT16=16 Unsigned 16-bit integer - @value UINT32=32 Unsigned 32-bit integer - @value UINT64=64 Unsigned 64-bit integer - @value FLOAT<0 Single-precision floating-point - @value DOUBLE<0 Double-precision floating-point - ''' - UINT8 = 8 - UINT16 = 16 - UINT32 = 32 - UINT64 = 64 - FLOAT = -1 - DOUBLE = -2 - - @staticmethod - def str(v): - ''' - Get string representation of a value - - @param v:int The value, must be value of the enum - @return :str Human-readable string representation of the value - ''' - if v == Depth.UINT8: - return '8-bits' - if v == Depth.UINT16: - return '16-bits' - if v == Depth.UINT32: - return '32-bits' - if v == Depth.UINT64: - return '64-bits' - if v == Depth.FLOAT: - return 'single-precision floating-point' - if v == Depth.DOUBLE: - return 'double-precision floating-point' - raise ValueError() - - -class Lifespan(enum.IntEnum): - ''' - Values used to tell when a filter should be removed - - @value REMOVE=0 Remove the filter now - @value UNTIL_DEATH>0 Remove the filter when disconnecting from the coopgamma server - @value UNTIL_REMOVAL>0 Only remove the filter when it is explicitly requested - ''' - REMOVE = 0 - UNTIL_DEATH = 1 - UNTIL_REMOVAL = 2 - - @staticmethod - def str(v): - ''' - Get string representation of a value - - @param v:int The value, must be value of the enum - @return :str Human-readable string representation of the value - ''' - if v == Lifespan.REMOVE: - return 'remove' - if v == Lifespan.UNTIL_DEATH: - return 'until death' - if v == Lifespan.UNTIL_REMOVAL: - return 'until removal' - raise ValueError() - - -class Colourspace(enum.IntEnum): - ''' - Colourspaces - - @value UNKNOWN=0 The colourspace is unknown - @value SRGB>0 sRGB (Standard RGB) - @value RGB>0 RGB other than sRGB - @value NON_RGB>0 Non-RGB multicolour - @value GREY>0 Monochrome, greyscale, or some other singlecolour scale - ''' - UNKNOWN = 0 - SRGB = 1 - RGB = 2 - NON_RGB = 3 - GREY = 4 - - @staticmethod - def str(v): - ''' - Get string representation of a value - - @param v:int The value, must be value of the enum - @return :str Human-readable string representation of the value - ''' - if v == Colourspace.UNKNOWN: - return 'unknown' - if v == Colourspace.SRGB: - return 'sRGB' - if v == Colourspace.RGB: - return 'RGB' - if v == Colourspace.NON_RGB: - return 'non-RGB' - if v == Colourspace.GREY: - return 'greyscale' - raise ValueError() - - -class Ramps: - ''' - Gamma ramp structure - - @variable red:list<int> The red gamma ramp - @variable green:list<int> The green gamma ramp - @variable blue:list<int> The blue gamma ramp - ''' - def __init__(self, red, green, blue): - ''' - Constructor - - @param red:int The number of stops in the red ramp - @param green:int The number of stops in the green ramp - @param blue:int The number of stops in the blue ramp - - -- or -- - - @param red:list<int> The red gamma ramp - @param green:list<int> The green gamma ramp - @param blue:list<int> The blue gamma ramp - ''' - if isinstance(red, list): - self.red = list(red) - self.green = list(green) - self.blue = list(blue) - else: - self.red = [0] * red - self.green = [0] * green - self.blue = [0] * blue - - def clone(self): - ''' - Create a copy of the instance - ''' - return Ramps(self.red, self.green, self.blue) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.red, self.green, self.blue) - return 'libcoopgamma.Ramps(%s)' % ', '.join(repr(p) for p in params) - - -class Filter: - ''' - Data set to the coopgamma server to apply, update, or remove a filter - - @variable priority:int The priority of the filter, higher priority - is applied first. The gamma correction should - have priority 0. This is a signed 64-bit integer. - @variable crtc:str The CRTC for which this filter shall be applied - @variable fclass:str Identifier for the filter. - The syntax must be "${PACKAGE_NAME}::${COMMAND_NAME}::${RULE}". - @variable lifespan:Lifespan When shall the filter be removed? - If this member's value is `LIBCOOPGAMMA_REMOVE`, - only `.crtc` and `.class` need also be defined. - @variable depth:Depth The data type and bit-depth of the ramp stops - @variable ramps:Ramps The gamma ramp adjustments of the filter - ''' - def __init__(self, priority = None, crtc = None, fclass = None, lifespan = None, depth = None, ramps = None): - ''' - Constructor - - @param priority:int The priority of the filter, higher priority - is applied first. The gamma correction should - have priority 0. This is a signed 64-bit integer. - @param crtc:str The CRTC for which this filter shall be applied - @param fclass:str Identifier for the filter. - The syntax must be "${PACKAGE_NAME}::${COMMAND_NAME}::${RULE}". - @param lifespan:Lifespan When shall the filter be removed? - If this member's value is `LIBCOOPGAMMA_REMOVE`, - only `.crtc` and `.class` need also be defined. - @param depth:Depth The data type and bit-depth of the ramp stops - @param ramps:Ramps The gamma ramp adjustments of the filter - ''' - self.priority = priority - self.crtc = crtc - self.fclass = fclass - self.lifespan = lifespan - self.depth = depth - self.ramps = ramps - - def clone(self, shallow = False): - ''' - Create a copy of the instance - - @param shallow:bool Create a shallow copy? - ''' - ramps = self.ramps if shallow else self.ramps.clone() - return Filter(self.priority, self.crtc, self.fclass, self.lifespan, self.depth, ramps) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.priority, self.crtc, self.fclass, self.lifespan, self.depth, self.ramps) - return 'libcoopgamma.Filter(%s)' % ', '.join(repr(p) for p in params) - - -class GamutPoint: - ''' - The x- and y-values (CIE xyY) of a colour - - @variable x_raw:int The x-value (CIE xyY) multiplied by 1024 - @variable y_raw:int The y-value (CIE xyY) multiplied by 1024 - @variable x:int The x-value (CIE xyY) - @variable y:int The y-value (CIE xyY) - ''' - def __init__(self, x, y): - ''' - Constructor - - @param x:int The x-value (CIE xyY) multiplied by 1024 - @param y:int The y-value (CIE xyY) multiplied by 1024 - ''' - self.x_raw, self.x = x, x / 1024 - self.y_raw, self.y = y, y / 1024 - - def clone(self): - ''' - Create a copy of the instance - ''' - return GamutPoint(self.x_raw, self.y_raw) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.x_raw, self.y_raw) - return 'libcoopgamma.GamutPoint(%s)' % ', '.join(repr(p) for p in params) - - def __str__(self): - ''' - Get human-readable string representation of instance - - @return :str Human-readable string representation of instance - ''' - return '(%f, %f)' % (self.x, self.y) - - -class Gamut: - ''' - The values of the monitor's colour stimuli - - @variable red:GamutPoint The red stimuli - @variable green:GamutPoint The green stimuli - @variable blue:GamutPoint The blue stimuli - @variable white:GamutPoint The default whitepoint - ''' - def __init__(self, red = None, green = None, blue = None, white = None): - ''' - Constructor - - @param red:GamutPoint|(int, int) The red stimuli - @param green:GamutPoint|(int, int) The green stimuli - @param blue:GamutPoint|(int, int) The blue stimuli - @param white:GamutPoint|(int, int) The default whitepoint - ''' - self.red = GamutPoint(*red) if isinstance(red, tuple) else red - self.green = GamutPoint(*green) if isinstance(green, tuple) else green - self.blue = GamutPoint(*blue) if isinstance(blue, tuple) else blue - self.white = GamutPoint(*white) if isinstance(white, tuple) else white - - def clone(self, shallow = True): - ''' - Create a copy of the instance - - @param shallow:bool Create a shallow copy? - ''' - if shallow: - return Gamut(self.red, self.green, self.blue, self.white) - return Gamut(self.red.clone(), self.green.clone(), self.blue.clone(), self.white.clone()) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (repr(self.red), repr(self.green), repr(self.blue), repr(self.white)) - return 'libcoopgamma.Gamut(%s)' % ', '.join(repr(p) for p in params) - - -class CRTCInfo: - ''' - Gamma ramp meta information for a CRTC - - @variable cooperative:bool Is cooperative gamma server running? - @variable depth:Depth? The data type and bit-depth of the ramp stops - @variable supported:Support Is gamma adjustments supported on the CRTC? - If not, `depth`, `red_size`, `green_size`, - and `blue_size` are undefined - @variable red_size:int? The number of stops in the red ramp - @variable green_size:int? The number of stops in the green ramp - @variable blue_size:int? The number of stops in the blue ramp - @variable colourspace:Colourspace The monitor's colourspace - @variable gamut:Gamut? Measurements of the monitor's colourspace, - `None` if the this information is unavailable. - If this is not `None`, but the colourspace - is not RGB (or sRGB), there is something - wrong. Always check the colourspace. - ''' - def __init__(self, cooperative = None, depth = None, supported = None, red_size = None, - green_size = None, blue_size = None, colourspace = None, gamut = None): - ''' - Constructor - - @param cooperative:bool Is cooperative gamma server running? - @param depth:Depth? The data type and bit-depth of the ramp stops - @param supported:Support Is gamma adjustments supported on the CRTC? - If not, `depth`, `red_size`, `green_size`, - and `blue_size` are undefined - @param red_size:int? The number of stops in the red ramp - @param green_size:int? The number of stops in the green ramp - @param blue_size:int? The number of stops in the blue ramp - @param colourspace:Colourspace The monitor's colourspace - @param gamut:Gamut|tuple? Measurements of the monitor's colourspace, - `None` if the this information is unavailable - ''' - self.cooperative = cooperative - self.depth = depth - self.supported = supported - self.red_size = red_size - self.green_size = green_size - self.blue_size = blue_size - self.colourspace = colourspace - if gamut is None or isinstance(gamut, Gamut): - self.gamut = gamut - else: - self.gamut = Gamut(*gamut) - - def make_ramps(self): - ''' - Construct a `Ramps` instances for this CRTC - - @return :Ramps An instance of `Ramps` with same a number of ramp stops - matching this CRTC - ''' - return Ramps(self.red_size, self.green_size, self.blue_size) - - def clone(self, shallow = True): - ''' - Create a copy of the instance - - @param shallow:bool Create a shallow copy? - ''' - return CRTCInfo(self.cooperative, self.depth, self.supported, self.red_size, - self.green_size, self.blue_size, self.colourspace, - self.gamut if shallow else self.gamut.clone()) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.cooperative, self.depth, self.supported, self.red_size, - self.green_size, self.blue_size, self.colourspace, self.gamut) - return 'libcoopgamma.CRTCInfo(%s)' % ', '.join(repr(p) for p in params) - - -class FilterQuery: - ''' - Data sent to the coopgamma server when requestng the current filter table - - @variable high_priority:int Do no return filters with higher priority than - this value. This is a signed 64-bit integer. - @variable low_priority:int Do no return filters with lower priority than - this value. This is a signed 64-bit integer. - @variable crtc:str The CRTC for which the the current filters shall returned - @variable coalesce:bool Whether to coalesce all filters into one gamma ramp triplet - ''' - def __init__(self, high_priority = 9223372036854775807, - low_priority = -9223372036854775808, crtc = None, coalesce = False): - ''' - Constructor - - @param high_priority:int Do no return filters with higher priority than - this value. This is a signed 64-bit integer. - @param low_priority:int Do no return filters with lower priority than - this value. This is a signed 64-bit integer. - @param crtc:str The CRTC for which the the current filters shall returned - @param coalesce:bool Whether to coalesce all filters into one gamma ramp triplet - ''' - self.high_priority = high_priority - self.low_priority = low_priority - self.crtc = crtc - self.coalesce = coalesce - - def clone(self): - ''' - Create a copy of the instance - ''' - return FilterQuery(self.high_priority, self.low_priority, self.crtc, self.coalesce) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.high_priority, self.low_priority, self.crtc, self.coalesce) - return 'libcoopgamma.FilterQuery(%s)' % ', '.join(repr(p) for p in params) - - -class QueriedFilter: - ''' - Stripped down version of `Filter` which only contains the - information returned in response to "Command: get-gamma" - - @variable priority:int The filter's priority. This is a signed 64-bit integer. - @variable fclass:str The filter's class - @variable ramps:Ramps The gamma ramp adjustments of the filter - ''' - def __init__(self, priority = None, fclass = None, ramps = None): - ''' - Constructor - - @param priority:int The filter's priority. This is a signed 64-bit integer. - @param fclass:str The filter's class - @param ramps:Ramps|tuple The gamma ramp adjustments of the filter - ''' - self.priority = priority - self.fclass = fclass - self.ramps = None - if ramps is not None: - self.ramps = Ramps(*ramps) if isinstance(ramps, tuple) else ramps - - def clone(self, shallow = False): - ''' - Create a copy of the instance - - @param shallow:bool Create a sallow copy? - ''' - ramps = self.ramps if shallow else self.ramps.clone() - return QueriedFilter(self.priority, self.fclass, ramps) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.priority, self.fclass, self.ramps) - return 'libcoopgamma.QueriedFilter(%s)' % ', '.join(repr(p) for p in params) - - -class FilterTable: - ''' - Response type for "Command: get-gamma": a list of applied filters - and meta-information that was necessary for decoding the response - - @variable red_size:int The number of stops in the red ramp - @variable green_size:int The number of stops in the green ramp - @variable blue_size:int The number of stops in the blue ramp - @variable depth:Depth The data type and bit-depth of the ramp stops - @variable filters:list<QueriedFilter> The filters, should be ordered by priority - in descending order, lest there is something - wrong with the coopgamma server. - If filter coalition was requested, there will - be exactly one filter and `filters[0].class` - and `filters[0].priority` are undefined. - ''' - def __init__(self, red_size = None, green_size = None, blue_size = None, depth = None, filters = None): - ''' - Constructor - - @param red_size:int The number of stops in the red ramp - @param green_size:int The number of stops in the green ramp - @param blue_size:int The number of stops in the blue ramp - @param depth:Depth The data type and bit-depth of the ramp stops - @param filters:list<QueriedFilter|tuple> The filters, should be ordered by priority - in descending order, lest there is something - wrong with the coopgamma server. - If filter coalition was requested, there will - be exactly one filter and `filters[0].class` - and `filters[0].priority` are undefined. - ''' - self.red_size = red_size - self.green_size = green_size - self.blue_size = blue_size - self.depth = depth - if filters is None: - self.filters - else: - self.filters = list(QueriedFilter(*f) if isinstance(f, tuple) else f for f in filters) - - def make_ramps(self): - ''' - Construct a `Ramps` instances for this CRTC - - @return :Ramps An instance of `Ramps` with same a number of ramp stops - matching this CRTC - ''' - return Ramps(self.red_size, self.green_size, self.blue_size) - - def clone(self, shallow = False): - ''' - Create a copy of the instance - - @param shallow:bool Create a sallow copy? - ''' - filters = list(self.filters) if shallow else [f.clone() for f in self.filters] - return FilterTable(self.red_size, self.green_size, self.blue_size, self.depth, filters) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.red_size, self.green_size, self.blue_size, self.depth, self.filters) - return 'libcoopgamma.FilterTable(%s)' % ', '.join(repr(p) for p in params) - - -class ErrorReport: - ''' - Error message from coopgamma server - - @variable number:int The error code. If `.custom` is false, 0 indicates success, - otherwise, 0 indicates that no error code has been assigned. - @variable custom:bool Is this a custom error? - @variable server_side:bool Did the error occur on the server-side? - @variable description:str? Error message, can be `None` if `custom` is false - ''' - def __init__(self, number = None, custom = None, server_side = None, description = None): - ''' - Constructor - - @param number:int The error code. If `.custom` is false, 0 indicates success, - otherwise, 0 indicates that no error code has been assigned. - @param custom:bool Is this a custom error? - @param server_side:bool Did the error occur on the server-side? - @param description:str? Error message, can be `None` if `custom` is false - ''' - self.number = number - self.custom = custom - self.server_side = server_side - self.description = description - - def clone(self): - ''' - Create a copy of the instance - ''' - return ErrorReport(self.number, self.custom, self.server_side, self.description) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - params = (self.number, self.custom, self.server_side, self.description) - return 'libcoopgamma.ErrorReport(%s)' % ', '.join(repr(p) for p in params) - - @staticmethod - def create_error(error): - ''' - Create an instance of a subclass of `Exception` - - @param error Error information - ''' - if isinstance(error, int): - import os - return OSError(error, os.strerror(error)) - error = ErrorReport(*error) - if not error.custom and not error.server_side: - import os - return OSError(error.number, os.strerror(error.number)) - else: - return LibcoopgammaError(error) - - -class LibcoopgammaError(Exception): - ''' - libcoopgamma error class - - @variable error:ErrorReport Error information - ''' - def __init__(self, error): - ''' - Constructor - - @param error:ErrorReport Error information - ''' - self.error = error - - def __str__(self): - ''' - Return description and error number as a string - - @return :str Description and error number - ''' - if self.error.description is not None: - if self.error.number != 0: - return '%s (#%i)' % (self.error.description, self.error.number) - else: - return '%s' % self.error.description - else: - return '#%i' % self.error.number - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - return 'libcoopgamma.LibcoopgammaError(%s)' % repr(self.error) - - -class IncompatibleDowngradeError(Exception): - ''' - Unmarshalled state from a newer version, that is not supported, of libcoopgamma - ''' - def __init__(self): - ''' - Constructor - ''' - pass - - def __str__(self): - ''' - Return descriptor of the error - - @return :str Descriptor of the error - ''' - return 'Incompatible downgrade error' - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - return 'libcoopgamma.IncompatibleDowngradeError()' - - -class IncompatibleUpgradeError(Exception): - ''' - Unmarshalled state from an older version, that is no longer supported, of libcoopgamma - ''' - def __init__(self): - ''' - Constructor - ''' - pass - - def __str__(self): - ''' - Return descriptor of the error - - @return :str Descriptor of the error - ''' - return 'Incompatible downgrade error' - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - return 'libcoopgamma.IncompatibleUpgradeErrorError()' - - -class ServerInitialisationError(Exception): - ''' - coopgamma server failed to initialise, reason unknown - ''' - def __init__(self): - ''' - Constructor - ''' - pass - - def __str__(self): - ''' - Return descriptor of the error - - @return :str Descriptor of the error - ''' - return 'Server initialisation error' - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - return 'libcoopgamma.ServerInitialisationError()' - - -class Context: - ''' - Library state - - Use of this structure is not thread-safe, create - one instance per thread that uses this structure - - @variable fd:int File descriptor for the socket - ''' - def __init__(self, fd = -1, buf = None): - ''' - Constructor - - @param fd:int File descriptor for the socket - @param buf:bytes? Buffer to unmarshal - ''' - self.address = None - self.fd = fd - if buf is None: - (successful, value) = libcoopgamma_native.libcoopgamma_native_context_create() - if not successful: - raise ErrorReport.create_error(value) - else: - (error, value) = libcoopgamma_native.libcoopgamma_native_context_unmarshal(buf) - if error < 0: - raise ErrorReport.create_error(value) - elif error == 1: - raise IncompatibleDowngradeError() - elif error == 2: - raise IncompatibleUpgradeError() - self.address = value - - def __del__(self): - ''' - Destructor - ''' - if self.address is not None: - libcoopgamma_native.libcoopgamma_native_context_free(self.address) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - data = libcoopgamma_native.libcoopgamma_native_context_marshal(self.address) - if isinstance(data, int): - raise ErrorReport.create_error(data) - params = (self.fd, data) - return 'libcoopgamma.Context(%s)' % ', '.join(repr(p) for p in params) - - def connect(self, method = None, site = None): - ''' - Connect to a coopgamma server, and start it if necessary - - Use `del` keyword to disconnect - - SIGCHLD must not be ignored or blocked - - All other methods in this class requires that this - method has been called successfully - - @param method:int|str? The adjustment method, `None` for automatic - @param site:str? The site, `None` for automatic - ''' - if method is not None and isinstance(method, int): - method = str(method) - (successful, value) = libcoopgamma_native.libcoopgamma_native_connect(method, site, self.address) - if not successful: - if value == 0: - raise ServerInitialisationError() - else: - raise ErrorReport.create_error(value) - self.fd = value - - def detach(self): - ''' - After calling this function, communication with the - server is impossible, but the connection is not - closed and the when the instance is destroyed the - connection will remain - ''' - libcoopgamma_native.libcoopgamma_native_context_set_fd(self.address, -1) - - def attach(self): - ''' - Undoes the action of `detach` - ''' - libcoopgamma_native.libcoopgamma_native_context_set_fd(self.address, self.fd) - - def set_nonbreaking(self, nonbreaking): - ''' - By default communication is blocking, this function - can be used to switch between blocking and nonblocking - - After setting the communication to nonblocking, `flush`, `synchronise` and - and request-sending functions can fail with EAGAIN and EWOULDBLOCK. It is - safe to continue with `flush` (for `flush` it selfand equest-sending functions) - or `synchronise` just like EINTR failure. - - @param nonblocking:bool Nonblocking mode? - ''' - error = libcoopgamma_native.libcoopgamma_native_set_nonblocking(self.address, nonbreaking) - if error != 0: - raise ErrorReport.create_error(error) - - def flush(self): - ''' - Send all pending outbound data - - If this function or another function that sends a request to the server fails - with EINTR, call this function to complete the transfer. The `async_ctx` parameter - will always be in a properly configured state if a function fails with EINTR. - ''' - error = libcoopgamma_native.libcoopgamma_native_flush(self.address) - if error != 0: - raise ErrorReport.create_error(error) - - def synchronise(self, pending): - ''' - Wait for the next message to be received - - @param pending:list<AsyncContext> Information for each pending request - @return :int? The index of the element in `pending` which corresponds - to the first inbound message, note that this only means - that the message is not for any of the other request, - if the message is corrupt any of the listed requests can - be selected even if it is not for any of the requests. - Functions that parse the message will detect such corruption. - `None` if the message is ignored, which happens if - corresponding AsyncContext is not listed. - ''' - pending = [p.address for p in pending] - (successful, value) = libcoopgamma_native.libcoopgamma_native_synchronise(self.address, pending) - if not successful: - if value == 0: - return None - else: - raise ErrorReport.create_error(value) - else: - return value - - def skip_message(self): - ''' - Tell the library that you will not be parsing a receive message - ''' - libcoopgamma_native.libcoopgamma_native_skip_message(self.address) - - def get_crtcs_send(self, async_ctx): - ''' - List all available CRTC:s, send request part - - @param async_ctx:AsyncContext Slot for information about the request that is - needed to identify and parse the response - ''' - - error = libcoopgamma_native.libcoopgamma_native_get_crtcs_send(self.address, async_ctx.address) - if error != 0: - raise ErrorReport.create_error(error) - - def get_crtcs_recv(self, async_ctx): - ''' - List all available CRTC:s, receive response part - - @param async_ctx:AsyncContext Information about the request - @return :list<str> A list of names. You should only free the outer - pointer, inner pointers are subpointers of the - outer pointer and cannot be freed. - ''' - ret = libcoopgamma_native.libcoopgamma_native_get_crtcs_recv(self.address, async_ctx.address) - if isinstance(ret, int): - raise ErrorReport.create_error(ret) - return ret - - def get_crtcs_sync(self): - ''' - List all available CRTC:s, synchronous version - - This is a synchronous request function, as such, you have to ensure that - communication is blocking (default), and that there are not asynchronous - requests waiting, it also means that EINTR:s are silently ignored and - there no wait to cancel the operation without disconnection from the server - - @return :list<str> A list of names. You should only free the outer pointer, inner - pointers are subpointers of the outer pointer and cannot be freed. - ''' - ret = libcoopgamma_native.libcoopgamma_native_get_crtcs_sync(self.address) - if isinstance(ret, int): - raise ErrorReport.create_error(ret) - return ret - - def get_gamma_info_send(self, crtc, async_ctx): - ''' - Retrieve information about a CRTC:s gamma ramps, send request part - - @param crtc:str The name of the CRT - @param async_ctx:AsyncContext Slot for information about the request that is - needed to identify and parse the response - ''' - error = libcoopgamma_native.libcoopgamma_native_get_gamma_info_send(crtc, self.address, async_ctx.address) - if error != 0: - raise ErrorReport.create_error(error) - - def get_gamma_info_recv(self, async_ctx): - ''' - Retrieve information about a CRTC:s gamma ramps, receive response part - - @param async_ctx:AsyncContext Information about the request - @return :CRTCInfo Information about the CRTC - ''' - value = libcoopgamma_native.libcoopgamma_native_get_gamma_info_recv(self.address, async_ctx.address) - if isinstance(value, int): - raise ErrorReport.create_error(value) - (successful, value) = value - if not successful: - raise ErrorReport.create_error(value) - return CRTCInfo(*value) - - def get_gamma_info_sync(self, crtc): - ''' - Retrieve information about a CRTC:s gamma ramps, synchronous version - - This is a synchronous request function, as such, you have to ensure that - communication is blocking (default), and that there are not asynchronous - requests waiting, it also means that EINTR:s are silently ignored and - there no wait to cancel the operation without disconnection from the server - - @param crtc:str The name of the CRT - @return :CRTCInfo Information about the CRTC - ''' - value = libcoopgamma_native.libcoopgamma_native_get_gamma_info_sync(crtc, self.address) - if isinstance(value, int): - raise ErrorReport.create_error(value) - (successful, value) = value - if not successful: - raise ErrorReport.create_error(value) - return CRTCInfo(*value) - - def get_gamma_send(self, query, async_ctx): - ''' - Retrieve the current gamma ramp adjustments, send request part - - @param query:FilterQuery The query to send - @param async_ctx:AsyncContext Slot for information about the request that is - needed to identify and parse the response - ''' - error = libcoopgamma_native.libcoopgamma_native_get_gamma_send( - query, self.address, async_ctx.address) - if error != 0: - raise ErrorReport.create_error(error) - - def get_gamma_recv(self, async_ctx): - ''' - Retrieve the current gamma ramp adjustments, receive response part - - @param async_ctx:AsyncContext Information about the request - @return :FilterTable Filter table - ''' - value = libcoopgamma_native.libcoopgamma_native_get_gamma_recv(self.address, async_ctx.address) - if isinstance(value, int): - raise ErrorReport.create_error(value) - (successful, value) = value - if not successful: - raise ErrorReport.create_error(value) - return FilterTable(*value) - - def get_gamma_sync(self, query): - ''' - Retrieve the current gamma ramp adjustments, synchronous version - - This is a synchronous request function, as such, you have to ensure that - communication is blocking (default), and that there are not asynchronous - requests waiting, it also means that EINTR:s are silently ignored and - there no wait to cancel the operation without disconnection from the server - - @param query:FilterQuery The query to send - @return :FilterTable Filter table - ''' - value = libcoopgamma_native.libcoopgamma_native_get_gamma_sync(query, self.address) - if isinstance(value, int): - raise ErrorReport.create_error(value) - (successful, value) = value - if not successful: - raise ErrorReport.create_error(value) - return FilterTable(*value) - - def set_gamma_send(self, filtr, async_ctx): - ''' - Apply, update, or remove a gamma ramp adjustment, send request part - - @param filtr:Filter The filter to apply, update, or remove, gamma ramp - meta-data must match the CRTC's - @param async_ctx:AsyncContext Slot for information about the request that is - needed to identify and parse the response - ''' - error = libcoopgamma_native.libcoopgamma_native_set_gamma_send(filtr, self.address, async_ctx.address) - if error != 0: - raise ErrorReport.create_error(error) - - def set_gamma_recv(self, async_ctx): - ''' - Apply, update, or remove a gamma ramp adjustment, receive response part - - @param async_ctx:AsyncContext Information about the request - ''' - error = libcoopgamma_native.libcoopgamma_native_set_gamma_recv(self.address, async_ctx.address) - if error is not None: - raise ErrorReport.create_error(error) - - def set_gamma_sync(self, filtr): - ''' - Apply, update, or remove a gamma ramp adjustment, synchronous version - - This is a synchronous request function, as such, you have to ensure that - communication is blocking (default), and that there are not asynchronous - requests waiting, it also means that EINTR:s are silently ignored and - there no wait to cancel the operation without disconnection from the server - - @param filtr:Filter The filter to apply, update, or remove, - gamma ramp meta-data must match the CRTC's - ''' - error = libcoopgamma_native.libcoopgamma_native_set_gamma_sync(filtr, self.address) - if error is not None: - raise ErrorReport.create_error(error) - - -class AsyncContext: - ''' - Information necessary to identify and parse a response from the server - ''' - def __init__(self, buf = None): - ''' - Constructor - - @param buf:bytes? Buffer to unmarshal - ''' - self.address = None - if buf is None: - (successful, value) = libcoopgamma_native.libcoopgamma_native_async_context_create() - if not successful: - raise ErrorReport.create_error(value) - else: - (error, value) = libcoopgamma_native.libcoopgamma_native_async_context_unmarshal(buf) - if error < 0: - raise ErrorReport.create_error(value) - elif error == 1: - raise IncompatibleDowngradeError() - elif error == 2: - raise IncompatibleUpgradeError() - self.address = value - - def __del__(self): - ''' - Destructor - ''' - if self.address is not None: - libcoopgamma_native.libcoopgamma_native_async_context_free(self.address) - - def __repr__(self): - ''' - Create a parsable string representation of the instance - - @return :str Parsable representation of the instance - ''' - data = libcoopgamma_native.libcoopgamma_native_async_context_marshal(self.address) - if isinstance(data, int): - raise ErrorReport.create_error(data) - return 'libcoopgamma.AsyncContext(%s)' % repr(data) - - -def get_methods(): - ''' - List all recognised adjustment method - - SIGCHLD must not be ignored or blocked - - @return :list<str> A list of names. You should only free the outer pointer, inner - pointers are subpointers of the outer pointer and cannot be freed. - ''' - ret = libcoopgamma_native.libcoopgamma_native_get_methods() - if isinstance(ret, int): - raise ErrorReport.create_error(ret) - return ret - - -def get_method_and_site(method = None, site = None): - ''' - Get the adjustment method and site - - SIGCHLD must not be ignored or blocked - - @param method:int|str? The adjustment method, `None` for automatic - @param site:str? The site, `None` for automatic - @return :(:str, :str?) The selected adjustment method and the selected the - selected site. If the adjustment method only supports - one site or if `site` is `None` and no site can be - selected automatically, the selected site (the second - element in the returned tuple) will be `None`. - ''' - if method is not None: - method = str(method) - ret = libcoopgamma_native.libcoopgamma_native_get_method_and_site(method, site) - if isinstance(ret, int): - raise ErrorReport.create_error(ret) - return ret - - -def get_pid_file(method = None, site = None): - ''' - Get the PID file of the coopgamma server - - SIGCHLD must not be ignored or blocked - - @param method:int|str? The adjustment method, `None` for automatic - @param site:str? The site, `None` for automatic - @return :str? The pathname of the server's PID file. - `None` if the server does not use PID files. - ''' - if method is not None: - method = str(method) - ret = libcoopgamma_native.libcoopgamma_native_get_pid_file(method, site) - if ret is not None and isinstance(ret, int): - raise ErrorReport.create_error(ret) - return ret - - -def get_socket_file(method = None, site = None): - ''' - Get the socket file of the coopgamma server - - SIGCHLD must not be ignored or blocked - - @param method:int|str? The adjustment method, `None` for automatic - @param site:str? The site, `None` for automatic - @return :str? The pathname of the server's socket, `None` if the server does have - its own socket, which is the case when communicating with a server - in a multi-server display server like mds - ''' - if method is not None: - method = str(method) - ret = libcoopgamma_native.libcoopgamma_native_get_socket_file(method, site) - if ret is not None and isinstance(ret, int): - raise ErrorReport.create_error(ret) - return ret - @@ -1,21 +1,5 @@ #!/usr/bin/env python3 -''' -pylibcoopgamma -- Python library for interfacing with cooperative gamma servers -Copyright (C) 2016 Mattias Andrée (maandree@kth.se) - -This library 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 library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this library. If not, see <http://www.gnu.org/licenses/>. -''' +# See LICENSE file for copyright and license details. import os, sys, time, errno, select @@ -26,7 +10,6 @@ import libcoopgamma cg = libcoopgamma if len(sys.argv) == 1: - print('\033[1m%s:\033[m' % 'Methods') for m in cg.get_methods(): print(m) @@ -373,4 +356,3 @@ while any(unsynced): time.sleep(0.5) del g - |