2
0
mirror of https://github.com/koreader/koreader synced 2024-11-16 06:12:56 +00:00
Go to file
2012-10-31 21:11:16 -04:00
djvulibre@01a26bed05 update djvulibre and crengine to latest release 2012-04-17 11:01:40 +08:00
frontend add multi-touch event definitions from linux/input.h 2012-10-21 01:25:48 +08:00
include add mxcfb.h header for v5 firmware eink support 2012-10-20 03:38:56 +08:00
kite New InfoMessage Concept 2012-10-02 21:03:56 -04:00
kpvcrlib fix getCurrentPageLinks segfault on links without target 2012-10-31 21:11:16 -04:00
launchpad Reimplement kpdf.sh changes from PR#348 after the PR#352 merge, and fix 2012-10-02 21:40:05 -04:00
luafilesystem@149e0fb8ec move third-party git checkouts into submodules #43 2012-03-07 17:19:52 +01:00
luajit-2.0@5bd133d6c8 switch to LuaJIT-2.0 2012-06-10 12:26:12 +02:00
mupdf@bdb6b688a2 update mupdf submodule to commit bdb6b688a238df56b2cf47fa17a08a4dd4b7a122 and small modification to source code to adapt to mupdf modifications 2012-03-24 17:47:52 +01:00
popen-noshell Don't patch popen-noshell twice 2012-10-02 20:56:58 -04:00
resources Recognize the files with ".jpeg" extension 2012-10-31 20:56:49 -04:00
test test file for djvu format 2012-06-05 15:23:58 +08:00
.gitignore Add git-rev file. 2012-10-31 20:33:33 -04:00
.gitmodules switch to LuaJIT-2.0 2012-06-10 12:26:12 +02:00
blitbuffer.c factored out blitting constraints check in a seperate function 2012-10-31 20:31:51 -04:00
blitbuffer.h refactored code a bit to avoid duplication 2011-12-02 22:28:48 +01:00
COPYING initial project, basic reader working 2011-11-14 18:30:16 +01:00
cre.cpp getSelections can be 0 2012-10-31 21:11:04 -04:00
cre.h add: data from crengine 2012-03-29 00:16:00 +08:00
djvu.c changed page number reading 2012-10-09 16:27:31 -04:00
djvu.h mod: fix typo in comments 2012-03-05 10:02:39 +08:00
drawcontext.c fix a Lua 5.0 syntax that was deprecated in 5.1 2012-03-19 19:11:32 +01:00
drawcontext.h separate DC out of pdf.c and djvu.c (cleanup) 2012-03-19 18:59:36 +01:00
einkfb.c add kindlePaperWhite support for einkfb module 2012-10-20 03:33:27 +08:00
einkfb.h add kindlePaperWhite support for einkfb module 2012-10-20 03:33:27 +08:00
ft.c fixed various bugs in pointer handling 2012-04-16 22:51:13 +02:00
ft.h added freetype text rendering (still buggy) 2011-12-01 01:35:53 +01:00
input.c rename slider event to fake_events again 2012-10-14 13:50:00 +08:00
input.h remove dependency on <linux/input.h> 2012-07-15 02:35:01 +08:00
kpdf.sh Reimplement kpdf.sh changes from PR#348 after the PR#352 merge, and fix 2012-10-02 21:40:05 -04:00
kpdfview.c Forgot to revert that too, useless now :). 2012-10-02 21:04:55 -04:00
Makefile fix getCurrentPageLinks segfault on links without target 2012-10-31 21:11:16 -04:00
mupdf.patch modification to take into account new version of mupdf 2012-04-16 00:10:41 +02:00
mupdfimg.c fixed missing return values 2012-06-10 12:26:23 +02:00
mupdfimg.h added interface to get blitbuffers from JPEG/PNG files 2012-04-14 22:32:05 +02:00
pdf.c Commented out debug-only function readable_fs(). 2012-10-31 20:36:19 -04:00
pdf.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
pic_jpeg.c Factor out JPEG support into a module 2012-10-31 20:54:24 -04:00
pic_jpeg.h Factor out JPEG support into a module 2012-10-31 20:54:24 -04:00
pic.c Cleanup of pic.c 2012-10-31 21:08:20 -04:00
reader.lua add comment for build version reading in the future 2012-10-09 16:14:09 -04:00
README.md Mention patch in the pre-requisites for building. 2012-10-06 22:55:41 +08:00
slider_watcher.c Kill a bit of cruft, explain the reasonning behind the kill/traps, and 2012-10-02 21:04:15 -04:00
util.c Get rid of the compilation warning. 2012-09-30 03:40:40 +08:00
util.h Correct the comment (the existing text was referring to a different file). 2012-09-17 20:09:06 -04:00
wtest.lua use getProvider and openDocument in reader.lua 2012-06-12 14:38:52 +08:00

KindlePDFViewer

This is a PDF viewer application, created for usage on the Kindle e-ink reader. It currently supports Kindle 2, DXG, 3 and 4, but not Touch. It's using the muPDF library (see http://mupdf.com/), djvulibre library, CREngine library 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:

  • fetch thirdparty sources

    • manually fetch all the thirdparty sources:

      • install muPDF sources into subfolder "mupdf"
      • install muPDF third-party sources (see muPDF homepage) into a new subfolder "mupdf/thirdparty"
      • install libDjvuLibre sources into subfolder "djvulibre"
      • install CREngine sources into subfolder "kpvcrlib/crengine"
      • install LuaJit sources into subfolder "luajit-2.0"
      • install popen_noshell sources into subfolder "popen-noshell"
    • automatically fetch thirdparty sources with Makefile:

      • make sure you have patch, wget, unzip, git and svn installed
      • run make fetchthirdparty.
  • adapt Makefile to your needs

  • run make thirdparty. This will build MuPDF (plus the libraries it depends on), libDjvuLibre, CREngine 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, or any directory path, as its first argument. Run reader.lua without arguments to see usage notes. The reader.lua script can also show a file chooser: it will do this when you call it with a directory (instead of a file) as first argument.

Device emulation

The code also features a device emulation. You need SDL headers and library for this. It allows to develop on a standard PC and saves precious development time. It might also compose the most unfriendly desktop PDF reader, depending on your view.

If you are using Ubuntu, simply install libsdl-dev1.2 package.

To build in "emulation mode", you need to run make like this: make clean cleanthirdparty EMULATE_READER=1 make thirdparty kpdfview

And run the emulator like this:

./reader.lua /PATH/TO/PDF.pdf

or:

./reader.lua /ANY/PATH

By default emulation will provide DXG resolution of 824*1200. It can be specified at compile time, this is example for Kindle 3:

EMULATE_READER_W=600 EMULATE_READER_H=800 EMULATE_READER=1 make kpdfview