commit 0c24e3c7e0b8fd4a8e6d82b8df6f2f0004fb4d77 Author: HW Date: Mon Nov 14 18:30:16 2011 +0100 initial project, basic reader working diff --git a/COPYING b/COPYING new file mode 100644 index 000000000..94a9ed024 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.TXT b/README.TXT new file mode 100644 index 000000000..5647158e0 --- /dev/null +++ b/README.TXT @@ -0,0 +1,44 @@ +KindlePDFViewer +=============== + +This is a PDF viewer application, created for usage on the Kindle e-ink reader. +It is currently restricted to 4bpp inverse grayscale displays. It's using the +muPDF library (see http://mupdf.com/) and its UI is scripted using Lua (see +http://www.lua.org/). + +The application is licensed under the GPLv3 (see COPYING file). + + +Building +======== + +Follow these steps: + +- install muPDF sources into subfolder "mupdf" +- install muPDF third-party sources (see muPDF homepage) into a new subfolder + "mupdf/thirdparty" + +- install Lua sources into subfolder "lua" + +=> note that there's a make target to do this. You need wget, unzip and git + installed. Then just run "make fetchthirdparty". + +- adapt Makefile to your needs + +- run "make thirdparty". This will build MuPDF (plus the libraries it depends + on) and Lua. + +- run "make". This will build the kpdfview application + + +Running +======= + +The user interface (or what's there yet) is scripted in Lua. See "reader.lua". +It uses the Linux feature to run scripts by using a corresponding line at its +start. +So you might just call that script. Note that the script and the kpdfview +binary currently must be in the same directory. +You would then just call reader.lua, giving the document file path as its first +argument. + diff --git a/blitbuffer.c b/blitbuffer.c new file mode 100644 index 000000000..35faa1c3a --- /dev/null +++ b/blitbuffer.c @@ -0,0 +1,58 @@ +/* + KindlePDFViewer: buffer for blitting muPDF data to framebuffer (blitbuffer) + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ + +#include "blitbuffer.h" + +static int newBlitBuffer(lua_State *L) { + int w = luaL_checkint(L, 1); + int h = luaL_checkint(L, 2); + BlitBuffer *bb = (BlitBuffer*) lua_newuserdata(L, sizeof(BlitBuffer) + (w * h * BLITBUFFER_BYTESPP) - 1); + luaL_getmetatable(L, "blitbuffer"); + lua_setmetatable(L, -2); + + bb->w = w; + bb->h = h; + return 1; +} + +static int freeBlitBuffer(lua_State *L) { + BlitBuffer *bb = (BlitBuffer*) luaL_checkudata(L, 1, "blitbuffer"); + + // lua will free the memory for the buffer itself + return 0; +} + +static const struct luaL_reg blitbuffer_func[] = { + {"new", newBlitBuffer}, + {NULL, NULL} +}; + +static const struct luaL_reg blitbuffer_meth[] = { + {"free", freeBlitBuffer}, + {NULL, NULL} +}; + +int luaopen_blitbuffer(lua_State *L) { + luaL_newmetatable(L, "blitbuffer"); + lua_pushstring(L, "__index"); + lua_pushvalue(L, -2); + lua_settable(L, -3); + luaL_register(L, NULL, blitbuffer_meth); + luaL_register(L, "blitbuffer", blitbuffer_func); + return 1; +} diff --git a/blitbuffer.h b/blitbuffer.h new file mode 100644 index 000000000..ea3a0105c --- /dev/null +++ b/blitbuffer.h @@ -0,0 +1,35 @@ +/* + KindlePDFViewer: buffer for blitting muPDF data to framebuffer (blitbuffer) + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#ifndef _BLITBUFFER_H +#define _BLITBUFFER_H + +#include +#include +#include +#include + +typedef struct BlitBuffer { + int w; + int h; + uint8_t data[1]; +} BlitBuffer; +#define BLITBUFFER_BYTESPP 2 + +int luaopen_blitbuffer(lua_State *L); + +#endif diff --git a/einkfb.c b/einkfb.c new file mode 100644 index 000000000..cfb26e632 --- /dev/null +++ b/einkfb.c @@ -0,0 +1,249 @@ +/* + KindlePDFViewer: eink framebuffer access + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#include +#include +#include +#include +//#include +#include "blitbuffer.h" + +#include "einkfb.h" + +static int openFrameBuffer(lua_State *L) { + const char *fb_device = luaL_checkstring(L, 1); + FBInfo *fb = (FBInfo*) lua_newuserdata(L, sizeof(FBInfo)); + + luaL_getmetatable(L, "einkfb"); + lua_setmetatable(L, -2); + +#ifdef EMULATE_EINKFB + fb->finfo.type = FB_TYPE_PACKED_PIXELS; + fb->finfo.smem_len = EMULATE_EINKFB_W * EMULATE_EINKFB_H; + fb->finfo.line_length = EMULATE_EINKFB_W; + fb->vinfo.xres = EMULATE_EINKFB_W; + fb->vinfo.yres = EMULATE_EINKFB_H; + fb->data = malloc(fb->finfo.smem_len); + if(fb->data == NULL) { + return luaL_error(L, "cannot claim memory for emulated framebuffer data"); + } + fb->fd = open(EMULATE_EINKFB_FILE, O_WRONLY|O_APPEND); +#else + /* open framebuffer */ + fb->fd = open(fb_device, O_RDWR); + if (fb->fd == -1) { + return luaL_error(L, "cannot open framebuffer %s", + fb_device); + } + + /* initialize data structures */ + memset(&fb->finfo, 0, sizeof(fb->finfo)); + memset(&fb->vinfo, 0, sizeof(fb->vinfo)); + + /* Get fixed screen information */ + if (ioctl(fb->fd, FBIOGET_FSCREENINFO, &fb->finfo)) { + return luaL_error(L, "cannot get screen info"); + } + + if (fb->finfo.type != FB_TYPE_PACKED_PIXELS) { + return luaL_error(L, "video type %x not supported", + fb->finfo.type); + } + + if (ioctl(fb->fd, FBIOGET_VSCREENINFO, &fb->vinfo)) { + return luaL_error(L, "cannot get variable screen info"); + } + + if (!fb->vinfo.grayscale) { + return luaL_error(L, "only grayscale is supported but framebuffer says it isn't"); + } + + if (fb->vinfo.bits_per_pixel != 4) { + return luaL_error(L, "only 4bpp is supported for now, got %d bpp", + fb->vinfo.bits_per_pixel); + } + + if (fb->vinfo.xres <= 0 || fb->vinfo.yres <= 0) { + return luaL_error(L, "invalid resolution %dx%d.\n", + fb->vinfo.xres, fb->vinfo.yres); + } + + /* mmap the framebuffer */ + fb->data = mmap(0, fb->finfo.smem_len, + PROT_READ | PROT_WRITE, MAP_SHARED, fb->fd, 0); + if(fb->data == MAP_FAILED) { + return luaL_error(L, "cannot mmap framebuffer"); + } +#endif + + return 1; +} + +static int getSize(lua_State *L) { + FBInfo *fb = (FBInfo*) luaL_checkudata(L, 1, "einkfb"); + lua_pushinteger(L, fb->vinfo.xres); + lua_pushinteger(L, fb->vinfo.yres); + return 2; +} + +static int closeFrameBuffer(lua_State *L) { + FBInfo *fb = (FBInfo*) luaL_checkudata(L, 1, "einkfb"); + munmap(fb->data, fb->finfo.smem_len); + close(fb->fd); + return 0; +} + +static int blitFullToFrameBuffer(lua_State *L) { + FBInfo *fb = (FBInfo*) luaL_checkudata(L, 1, "einkfb"); + BlitBuffer *bb = (BlitBuffer*) luaL_checkudata(L, 2, "blitbuffer"); + + if(bb->w != fb->vinfo.xres || bb->h != fb->vinfo.yres) { + return luaL_error(L, "blitbuffer size must be framebuffer size!"); + } + +#ifndef EMULATE_EINKFB + uint8_t *fbptr = (uint8_t*)fb->data; +#else + uint8_t *fbptr = (uint8_t*)fb->data; +#endif + uint32_t *bbptr = (uint32_t*)bb->data; + + int c = fb->vinfo.xres * fb->vinfo.yres / 2; + + while(c--) { +#ifndef EMULATE_EINKFB + *fbptr = (((*bbptr & 0x00F00000) >> 20) | (*bbptr & 0x000000F0)) ^ 0xFF; + fbptr++; +#else + *fbptr = *bbptr & 0x000000F0; + fbptr++; + *fbptr = (*bbptr & 0x00F00000) >> 16; + fbptr++; +#endif + bbptr++; + } + return 0; +} + +static int blitToFrameBuffer(lua_State *L) { + FBInfo *fb = (FBInfo*) luaL_checkudata(L, 1, "einkfb"); + BlitBuffer *bb = (BlitBuffer*) luaL_checkudata(L, 2, "blitbuffer"); + int xdest = luaL_checkint(L, 3) & 0x7FFFFFFE; + int ydest = luaL_checkint(L, 4); + int xoffs = luaL_checkint(L, 5) & 0x7FFFFFFE; + int yoffs = luaL_checkint(L, 6); + int w = luaL_checkint(L, 7); + int h = luaL_checkint(L, 8); + int x, y; + + // check bounds + if(yoffs >= bb->h) { + return 0; + } else if(yoffs + h > bb->w) { + h = bb->h - yoffs; + } + if(ydest >= fb->vinfo.yres) { + return 0; + } else if(ydest + h > fb->vinfo.yres) { + h = fb->vinfo.yres - ydest; + } + if(xoffs >= bb->w) { + return 0; + } else if(xoffs + w > bb->w) { + w = bb->w - xoffs; + } + if(xdest >= fb->vinfo.xres) { + return 0; + } else if(xdest + w > fb->vinfo.xres) { + w = fb->vinfo.xres - xdest; + } + + w = (w+1) / 2; // we'll always do two pixels at once for now + +#ifndef EMULATE_EINKFB + uint8_t *fbptr = (uint8_t*)(fb->data + + ydest * fb->finfo.line_length + + xdest / 2); +#else + uint8_t *fbptr = (uint8_t*)(fb->data + + ydest * fb->finfo.line_length + + xdest); +#endif + uint32_t *bbptr = (uint32_t*)(bb->data + + yoffs * bb->w * BLITBUFFER_BYTESPP + + xoffs * BLITBUFFER_BYTESPP); + + for(y = 0; y < h; y++) { + for(x = 0; x < w; x++) { +#ifndef EMULATE_EINKFB + fbptr[x] = (((bbptr[x] & 0x00F00000) >> 20) | (bbptr[x] & 0x000000F0)) ^ 0xFF; +#else + fbptr[x*2] = bbptr[x] & 0x000000F0; + fbptr[x*2+1] = (bbptr[x] & 0x00F00000) >> 16; +#endif + } + fbptr += fb->finfo.line_length; + bbptr += (bb->w / 2); + } + return 0; +} + +static int einkUpdate(lua_State *L) { + FBInfo *fb = (FBInfo*) luaL_checkudata(L, 1, "einkfb"); + // for Kindle e-ink display + int fxtype = luaL_optint(L, 2, 0); +#ifndef EMULATE_EINKFB + update_area_t myarea; + myarea.x1 = luaL_optint(L, 3, 0); + myarea.y1 = luaL_optint(L, 4, 0); + myarea.x2 = luaL_optint(L, 5, fb->vinfo.xres); + myarea.y2 = luaL_optint(L, 6, fb->vinfo.yres); + myarea.buffer = NULL; + myarea.which_fx = fxtype ? fx_update_partial : fx_update_full; + ioctl(fb->fd, FBIO_EINK_UPDATE_DISPLAY_AREA, &myarea); +#else + if(fb->fd != -1) { + write(fb->fd, fb->data, fb->finfo.smem_len); + } +#endif + return 0; +} + +static const struct luaL_reg einkfb_func[] = { + {"open", openFrameBuffer}, + {NULL, NULL} +}; + +static const struct luaL_reg einkfb_meth[] = { + {"close", closeFrameBuffer}, + {"refresh", einkUpdate}, + {"getSize", getSize}, + {"blitFrom", blitToFrameBuffer}, + {"blitFullFrom", blitFullToFrameBuffer}, + {NULL, NULL} +}; + +int luaopen_einkfb(lua_State *L) { + luaL_newmetatable(L, "einkfb"); + lua_pushstring(L, "__index"); + lua_pushvalue(L, -2); + lua_settable(L, -3); + luaL_register(L, NULL, einkfb_meth); + luaL_register(L, "einkfb", einkfb_func); + + return 1; +} diff --git a/einkfb.h b/einkfb.h new file mode 100644 index 000000000..8b8609670 --- /dev/null +++ b/einkfb.h @@ -0,0 +1,44 @@ +/* + KindlePDFViewer: eink framebuffer access + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#ifndef _PDF_EINKFB_H +#define _PDF_EINKFB_H + +#include +#ifdef EMULATE_EINKFB +#include +//#define EMULATE_EINKFB_W 824 +//#define EMULATE_EINKFB_H 1200 +//#define EMULATE_EINKFB_FILE "/tmp/displayfifo" +#else +#include +#endif + +#include +#include +#include + +typedef struct FBInfo { + int fd; + void *data; + struct fb_fix_screeninfo finfo; + struct fb_var_screeninfo vinfo; +} FBInfo; + +int luaopen_einkfb(lua_State *L); + +#endif diff --git a/input.c b/input.c new file mode 100644 index 000000000..27f477b72 --- /dev/null +++ b/input.c @@ -0,0 +1,122 @@ +/* + KindlePDFViewer: input abstraction for Lua + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#include +#include +#include +#include +#include "input.h" + +#define NUM_FDS 3 +int inputfds[3] = { -1, -1, -1 }; + +static int openInputDevice(lua_State *L) { + int i; + const char* inputdevice = luaL_checkstring(L, 1); + + for(i=0; i: %d", inputdevice, errno); + } + } + } + return luaL_error(L, "no free slot for new input device <%s>", inputdevice); +} + +static int closeInputDevices(lua_State *L) { + int i; + for(i=0; i nfds) + nfds = inputfds[i] + 1; + } + + num = select(nfds, &fds, NULL, NULL, &timeout); + if(num < 0) { + return luaL_error(L, "Waiting for input failed: %d\n", errno); + } + + lua_newtable(L); + j=1; + + for(i=0; i + + 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 . +*/ +#ifndef _PDF_INPUT_H +#define _PDF_INPUT_H + +#include +#include +#include + +int luaopen_input(lua_State *L); + +#endif + diff --git a/kpdfview.c b/kpdfview.c new file mode 100644 index 000000000..cb6400535 --- /dev/null +++ b/kpdfview.c @@ -0,0 +1,69 @@ +/* + KindlePDFViewer + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#include +#include +#include + +#include +#include +#include + +#include "blitbuffer.h" +#include "pdf.h" +#include "einkfb.h" +#include "input.h" + +lua_State *L; + +int main(int argc, char **argv) { + int i, err; + + if(argc < 2) { + fprintf(stderr, "needs config file as first argument.\n"); + return -1; + } + + /* set up Lua state */ + L = lua_open(); + if(L) { + luaL_openlibs(L); + + luaopen_blitbuffer(L); + luaopen_einkfb(L); + luaopen_pdf(L); + luaopen_input(L); + luaopen_util(L); + + lua_newtable(L); + for(i=2; i < argc; i++) { + lua_pushstring(L, argv[i]); + lua_rawseti(L, -2, i-1); + } + lua_setglobal(L, "ARGV"); + + if(luaL_dofile(L, argv[1])) { + fprintf(stderr, "lua config error: %s\n", lua_tostring(L, -1)); + lua_close(L); + L=NULL; + return -1; + } + } + + return 0; +} + diff --git a/pdf.c b/pdf.c new file mode 100644 index 000000000..0e3290d9b --- /dev/null +++ b/pdf.c @@ -0,0 +1,293 @@ +/* + KindlePDFViewer: MuPDF abstraction for Lua + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#include +#include + +#include "blitbuffer.h" +#include "pdf.h" + +typedef struct PdfDocument { + fz_glyph_cache *glyphcache; + pdf_xref *xref; + int pages; +} PdfDocument; + +typedef struct PdfPage { + int num; +#ifdef USE_DISPLAY_LIST + fz_display_list *list; +#endif + pdf_page *page; + PdfDocument *doc; +} PdfPage; + +typedef struct DrawContext { + int rotate; + double zoom; + int offset_x; + int offset_y; +} DrawContext; + +static int openDocument(lua_State *L) { + fz_error error; + const char *filename = luaL_checkstring(L, 1); + const char *password = luaL_checkstring(L, 2); + PdfDocument *doc = (PdfDocument*) lua_newuserdata(L, sizeof(PdfDocument)); + + luaL_getmetatable(L, "pdfdocument"); + lua_setmetatable(L, -2); + + fz_accelerate(); + doc->glyphcache = fz_new_glyph_cache(); + + error = pdf_open_xref(&doc->xref, filename, password); + if(error) { + return luaL_error(L, "cannot open PDF file <%s>", filename); + } + error = pdf_load_page_tree(doc->xref); + if(error) { + return luaL_error(L, "cannot load page tree in file <%s>", filename); + } + doc->pages = pdf_count_pages(doc->xref); + return 1; +} + +static int getNumberOfPages(lua_State *L) { + PdfDocument *doc = (PdfDocument*) luaL_checkudata(L, 1, "pdfdocument"); + lua_pushinteger(L, doc->pages); + return 1; +} + +static int newDrawContext(lua_State *L) { + int rotate = luaL_optint(L, 1, 0); + double zoom = luaL_optnumber(L, 2, (double) 1.0); + int offset_x = luaL_optint(L, 3, 0); + int offset_y = luaL_optint(L, 4, 0); + + DrawContext *dc = (DrawContext*) lua_newuserdata(L, sizeof(DrawContext)); + dc->rotate = rotate; + dc->zoom = zoom; + dc->offset_x = offset_x; + dc->offset_y = offset_y; + + luaL_getmetatable(L, "drawcontext"); + lua_setmetatable(L, -2); + + return 1; +} + +static int dcSetOffset(lua_State *L) { + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 1, "drawcontext"); + dc->offset_x = luaL_checkint(L, 2); + dc->offset_y = luaL_checkint(L, 3); + return 0; +} + +static int dcGetOffset(lua_State *L) { + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 1, "drawcontext"); + lua_pushinteger(L, dc->offset_x); + lua_pushinteger(L, dc->offset_y); + return 2; +} + +static int dcSetRotate(lua_State *L) { + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 1, "drawcontext"); + dc->rotate = luaL_checkint(L, 2); + return 0; +} + +static int dcSetZoom(lua_State *L) { + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 1, "drawcontext"); + dc->zoom = luaL_checknumber(L, 2); + return 0; +} + +static int dcGetRotate(lua_State *L) { + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 1, "drawcontext"); + lua_pushinteger(L, dc->rotate); + return 1; +} + +static int dcGetZoom(lua_State *L) { + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 1, "drawcontext"); + lua_pushnumber(L, dc->zoom); + return 1; +} + +static int openPage(lua_State *L) { + fz_error error; + fz_device *dev; + + PdfDocument *doc = (PdfDocument*) luaL_checkudata(L, 1, "pdfdocument"); + + int pageno = luaL_checkint(L, 2); + + if(pageno < 1 || pageno > doc->pages) { + return luaL_error(L, "cannot open page #%d, out of range (1-%d)", pageno, doc->pages); + } + + PdfPage *page = (PdfPage*) lua_newuserdata(L, sizeof(PdfPage)); + + luaL_getmetatable(L, "pdfpage"); + lua_setmetatable(L, -2); + + error = pdf_load_page(&page->page, doc->xref, pageno - 1); + if(error) { + return luaL_error(L, "cannot open page #%d, errval=%x", pageno, error); + } + + page->doc = doc; + +#ifdef USE_DISPLAY_LIST + page->list = fz_new_display_list(); + dev = fz_new_list_device(page->list); + error = pdf_run_page(doc->xref, page->page, dev, fz_identity); + pdf_free_page(page->page); + fz_free_device(dev); + if (error) { + fz_free_display_list(page->list); + return luaL_error(L, "cannot make displaylist for page %d, errval=%x", pageno, error); + } +#endif + + return 1; +} + +static int getPageSize(lua_State *L) { + fz_matrix ctm; + fz_rect bbox; + PdfPage *page = (PdfPage*) luaL_checkudata(L, 1, "pdfpage"); + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 2, "drawcontext"); + + ctm = fz_translate(0, -page->page->mediabox.y1); + ctm = fz_concat(ctm, fz_scale(dc->zoom, -dc->zoom)); + ctm = fz_concat(ctm, fz_rotate(page->page->rotate)); + ctm = fz_concat(ctm, fz_rotate(dc->rotate)); + bbox = fz_transform_rect(ctm, page->page->mediabox); + + lua_pushnumber(L, bbox.x1-bbox.x0); + lua_pushnumber(L, bbox.y1-bbox.y0); + + return 2; +} + +static int closePage(lua_State *L) { + PdfPage *page = (PdfPage*) luaL_checkudata(L, 1, "pdfpage"); +#ifdef USE_DISPLAY_LIST + fz_free_display_list(page->list); +#endif + //fz_free_glyph_cache(page->doc->glyphcache); + //page->doc->glyphcache = fz_new_glyph_cache(); + pdf_free_page(page->page); + + pdf_age_store(page->doc->xref->store, 2); +} + +static int drawPage(lua_State *L) { + fz_pixmap *pix; + fz_device *dev; + fz_matrix ctm; + fz_bbox bbox; + fz_bbox rect; + + PdfPage *page = (PdfPage*) luaL_checkudata(L, 1, "pdfpage"); + DrawContext *dc = (DrawContext*) luaL_checkudata(L, 2, "drawcontext"); + BlitBuffer *bb = (BlitBuffer*) luaL_checkudata(L, 3, "blitbuffer"); + rect.x0 = luaL_checkint(L, 4); + rect.y0 = luaL_checkint(L, 5); + rect.x1 = rect.x0 + bb->w; + rect.y1 = rect.y0 + bb->h; + pix = fz_new_pixmap_with_rect_and_data(fz_device_gray, rect, bb->data); + fz_clear_pixmap_with_color(pix, 0xff); + + ctm = fz_translate(-page->page->mediabox.x0, -page->page->mediabox.y1); + ctm = fz_concat(ctm, fz_scale(dc->zoom, -dc->zoom)); + ctm = fz_concat(ctm, fz_rotate(page->page->rotate)); + ctm = fz_concat(ctm, fz_rotate(dc->rotate)); + ctm = fz_concat(ctm, fz_translate(dc->offset_x, dc->offset_y)); + bbox = fz_round_rect(fz_transform_rect(ctm, page->page->mediabox)); + dev = fz_new_draw_device(page->doc->glyphcache, pix); +#ifdef USE_DISPLAY_LIST +#ifdef MUPDF_TRACE + fz_device *tdev; + tdev = fz_new_trace_device(); + fz_execute_display_list(page->list, tdev, ctm, bbox); + fz_free_device(tdev); +#endif + fz_execute_display_list(page->list, dev, ctm, bbox); +#else + pdf_run_page(page->doc->xref, page->page, dev, ctm); +#endif + + fz_free_device(dev); + fz_drop_pixmap(pix); + + return 0; +} + +static const struct luaL_reg pdf_func[] = { + {"openDocument", openDocument}, + {"newDC", newDrawContext}, + {NULL, NULL} +}; + +static const struct luaL_reg pdfdocument_meth[] = { + {"openPage", openPage}, + {"getPages", getNumberOfPages}, + {NULL, NULL} +}; + +static const struct luaL_reg pdfpage_meth[] = { + {"getSize", getPageSize}, + {"close", closePage}, + {"draw", drawPage}, + {NULL, NULL} +}; + +static const struct luaL_reg drawcontext_meth[] = { + {"setRotate", dcSetRotate}, + {"getRotate", dcGetRotate}, + {"setZoom", dcSetZoom}, + {"getZoom", dcGetZoom}, + {"setOffset", dcSetOffset}, + {"getOffset", dcGetOffset}, + {NULL, NULL} +}; + +int luaopen_pdf(lua_State *L) { + luaL_newmetatable(L, "pdfdocument"); + lua_pushstring(L, "__index"); + lua_pushvalue(L, -2); + lua_settable(L, -3); + luaL_register(L, NULL, pdfdocument_meth); + lua_pop(L, 1); + luaL_newmetatable(L, "pdfpage"); + lua_pushstring(L, "__index"); + lua_pushvalue(L, -2); + lua_settable(L, -3); + luaL_register(L, NULL, pdfpage_meth); + lua_pop(L, 1); + luaL_newmetatable(L, "drawcontext"); + lua_pushstring(L, "__index"); + lua_pushvalue(L, -2); + lua_settable(L, -3); + luaL_register(L, NULL, drawcontext_meth); + lua_pop(L, 1); + luaL_register(L, "pdf", pdf_func); + return 1; +} diff --git a/pdf.h b/pdf.h new file mode 100644 index 000000000..9d68375c3 --- /dev/null +++ b/pdf.h @@ -0,0 +1,26 @@ +/* + KindlePDFViewer: MuPDF abstraction for Lua + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#ifndef _PDF_H +#define _PDF_H + +#include +#include +#include + +int luaopen_pdf(lua_State *L); +#endif diff --git a/reader.lua b/reader.lua new file mode 100755 index 000000000..799c4a3f3 --- /dev/null +++ b/reader.lua @@ -0,0 +1,186 @@ +#!./kpdfview +--[[ + KindlePDFViewer: a reader implementation + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +]]-- + +input.open("/dev/input/event0") +input.open("/dev/input/event1") + +KEY_PAGE_UP = 109 +KEY_PAGE_DOWN = 124 + +KEY_BACK = 91 +KEY_MENU = 139 + +-- DPad: +KEY_UP = 122 +KEY_DOWN = 123 +KEY_LEFT = 105 +KEY_RIGHT = 106 +KEY_BTN = 92 + +if ARGV[1] == nil then + print("needs PDF filename as first argument.") +end +if ARGV[2] == nil then + ARGV[2] = "" +end + +rcount = 5 +rcountmax = 5 + +globalzoom = -1 + +doc = pdf.openDocument(ARGV[1], ARGV[2]) + +print("pdf has "..doc:getPages().." pages.") + +fb = einkfb.open("/dev/fb0") +width, height = fb:getSize() + +nulldc = pdf.newDC() + +cache = { + { age = 0, no = 0, bb = blitbuffer.new(width, height), dc = pdf.newDC(), page = nil }, + { age = 0, no = 0, bb = blitbuffer.new(width, height), dc = pdf.newDC(), page = nil }, + { age = 0, no = 0, bb = blitbuffer.new(width, height), dc = pdf.newDC(), page = nil } +} +function freecache() + for i = 1, #cache do + if cache[i].page ~= nil then + print("freeing slot="..i.." oldpage="..cache[i].no) + cache[i].page:close() + cache[i].page = nil + end + end +end +function checkcache(no) + for i = 1, #cache do + if cache[i].no == no then + print("cache hit: slot="..i.." page="..no) + return i + end + end + print("cache miss") + return nil +end +function cacheslot() + freeslot = nil + while freeslot == nil do + for i = 1, #cache do + if cache[i].age > 0 then + print("aging slot="..i) + cache[i].age = cache[i].age - 1 + else + if cache[i].page ~= nil then + print("freeing slot="..i.." oldpage="..cache[i].no) + cache[i].page:close() + cache[i].page = nil + end + freeslot = i + end + end + end + print("returning free slot="..freeslot) + return freeslot +end + +function draworcache(no) + local slot = checkcache(no) + if slot == nil then + slot = cacheslot() + cache[slot].no = no + cache[slot].age = #cache + cache[slot].page = doc:openPage(no) + setzoom(slot) + print("drawing page="..no.." to slot="..slot) + cache[slot].page:draw(cache[slot].dc, cache[slot].bb, 0, 0) + end + return slot +end + +function setzoom(cacheslot) + local pwidth, pheight = cache[cacheslot].page:getSize(nulldc) + + -- default zoom: fit to page + local zoom = width / pwidth + local offset_x = 0 + local offset_y = (height - (zoom * pheight)) / 2 + if height / pheight < zoom then + zoom = height / pheight + offset_x = (width - (zoom * pwidth)) / 2 + offset_y = 0 + end + + cache[cacheslot].dc:setZoom(zoom) + cache[cacheslot].dc:setOffset(offset_x, offset_y) +end + +function show(no) + local slot = draworcache(no) + fb:blitFullFrom(cache[slot].bb) + if rcount == rcountmax then + print("full refresh") + rcount = 1 + fb:refresh(0) + else + print("partial refresh") + rcount = rcount + 1 + fb:refresh(1) + end +end + +function goto(no) + if no < 1 or no > doc:getPages() then + return + end + pageno = no + show(no) + if no < doc:getPages() then + -- always pre-cache next page + draworcache(no+1) + end +end + +function mainloop() + while 1 do + local events = input.waitForEvent() + for _, ev in ipairs(events) do + if ev.type == 1 and (ev.value == 1 or ev.value == 2) then + local secs, usecs = util.gettime() + if ev.code == KEY_PAGE_DOWN then + print(cache) + goto(pageno + 1) + print(cache) + elseif ev.code == KEY_PAGE_UP then + print(cache) + goto(pageno - 1) + print(cache) + elseif ev.code == KEY_BACK then + return + end + local nsecs, nusecs = util.gettime() + local dur = (nsecs - secs) * 1000000 + nusecs - usecs + print("E: T="..ev.type.." V="..ev.value.." C="..ev.code.." DUR="..dur) + end + end + end +end + +goto(1) + +mainloop() diff --git a/util.c b/util.c new file mode 100644 index 000000000..4a63997b1 --- /dev/null +++ b/util.c @@ -0,0 +1,39 @@ +/* + KindlePDFViewer: miscellaneous utility functions for Lua + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ + +#include + +#include "util.h" + +static int gettime(lua_State *L) { + struct timeval tv; + gettimeofday(&tv, NULL); + lua_pushinteger(L, tv.tv_sec); + lua_pushinteger(L, tv.tv_usec); + return 2; +} + +static const struct luaL_reg util_func[] = { + {"gettime", gettime}, + {NULL, NULL} +}; + +int luaopen_util(lua_State *L) { + luaL_register(L, "util", util_func); + return 1; +} diff --git a/util.h b/util.h new file mode 100644 index 000000000..e18c5f092 --- /dev/null +++ b/util.h @@ -0,0 +1,27 @@ +/* + KindlePDFViewer: buffer for blitting muPDF data to framebuffer (blitbuffer) + Copyright (C) 2011 Hans-Werner Hilse + + 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 . +*/ +#ifndef _UTIL_H +#define _UTIL_H + +#include +#include +#include + +int luaopen_util(lua_State *L); + +#endif