2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
NiLuJe ead342926c Use popen_noshell as a static lib instead of an object file. Use CHOST
instead of HOST (and allow it to be set from the env), use $(MAKE)
instead of make to allow using the jobserver properly, and remove the
dash from commands where we do care about the return code (or inhibit
errors the usual way: rm -f instead of -rm)

Conflicts:

	Makefile
2012-10-02 20:52:49 -04:00
djvulibre@01a26bed05 update djvulibre and crengine to latest release 2012-04-17 11:01:40 +08:00
frontend handle file with no extension in filechooser 2012-09-17 20:36:39 -04:00
include included Linux kernel API header file for eink display 2011-11-16 15:59:37 +01:00
kite added shortcuts for Kite 2012-06-10 12:13:18 +02:00
kpvcrlib version: cr3.0.57-15 2012-09-26 09:43:31 +08:00
launchpad Fix input device closing, and fix lipc-wait-event handling (using 2012-10-02 20:48:43 -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 Use popen_noshell as a static lib instead of an object file. Use CHOST 2012-10-02 20:52:49 -04:00
resources add resource: info icon 2012-04-15 02:34:49 +02:00
test test file for djvu format 2012-06-05 15:23:58 +08:00
.gitignore Add a small makefile to build popen_noshell as a static lib 2012-10-02 20:49:19 -04:00
.gitmodules switch to LuaJIT-2.0 2012-06-10 12:26:12 +02:00
blitbuffer.c invertRect should handle negative x or y values 2012-09-27 12:42:26 +08: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 set crengine cache size in lua code 2012-09-17 20:10:43 -04:00
cre.h add: data from crengine 2012-03-29 00:16:00 +08:00
djvu.c Cleanup of djvu.c 2012-09-25 10:38:52 -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 bug fixes for shadow framebuffer implementation 2012-06-23 20:37:33 +08:00
einkfb.h implement K4 framebuffer support with shadow blitbuffer 2012-06-14 01:43:57 +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 Update the standalone testcase, too. 2012-10-02 20:49:04 -04:00
input.h remove dependency on <linux/input.h> 2012-07-15 02:35:01 +08:00
kpdfview.c Fix input device closing, and fix lipc-wait-event handling (using 2012-10-02 20:48:43 -04:00
Makefile Use popen_noshell as a static lib instead of an object file. Use CHOST 2012-10-02 20:52:49 -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 Comment out debug printf() in pdf.c 2012-09-30 03:42:31 +08:00
pdf.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
reader.lua Tidy up debug support. 2012-09-25 11:01:10 -04:00
README.md update README.md 2012-09-17 20:44:09 -04:00
slider_watcher.c Update the standalone testcase, too. 2012-10-02 20:49:04 -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"
    • automatically fetch thirdparty sources with Makefile:

      • make sure you have wget, unzip and git 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