2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
Tigran Aivazian 8ab0e7fcb8 Force the use of bash.
On some distributions (e.g. Ubuntu) the shell used for scripts is dash,
not bash and we explicitly rely on bash's features in the Makefile, so
we must guarantee that we are running with bash (not dash or anything
else).
2012-10-10 21:04:47 +01:00
djvulibre@01a26bed05 update djvulibre and crengine to latest release 2012-04-17 11:01:40 +08:00
include included Linux kernel API header file for eink display 2011-11-16 15:59:37 +01:00
kite New InfoMessage Concept 2012-10-03 00:45:45 +02:00
kpvcrlib version: cr3.0.57-15 2012-09-25 21:54:04 +02:00
launchpad Reimplement kpdf.sh changes from PR#348 after the PR#352 merge, and fix 2012-10-03 03:02:41 +02: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-03 01:49:55 +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-03 00:34:42 +02:00
resources Initial commit of picviewer. 2012-10-08 16:39:03 +01:00
test added test file for ZOOM_FIT_TO_CONTENT_WIDTH_PAN 2012-04-09 16:36:22 +02:00
.gitignore Ignore untracked popen_noshell stuff 2012-10-02 23:33:59 +02:00
.gitmodules switch to LuaJIT-2.0 2012-06-03 01:49:55 +02:00
alt_getopt.lua better argument parsing and option for gamma correction 2011-11-16 17:13:08 +01:00
blitbuffer.c factored out blitting constraints check in a seperate function 2012-10-10 17:58:31 +02:00
blitbuffer.h refactored code a bit to avoid duplication 2011-12-02 22:28:48 +01:00
commands.lua New InfoMessage Concept 2012-10-03 00:45:45 +02:00
COPYING initial project, basic reader working 2011-11-14 18:30:16 +01:00
cre.cpp Small typo that wasted millions of instructions. 2012-10-04 08:26:08 +01:00
cre.h add: data from crengine 2012-03-29 00:16:00 +08:00
crereader.lua Rename dim_overlap -> show_overlap_enable 2012-10-08 14:59:32 +01:00
dialog.lua Enable TTS for the emulator. 2012-10-06 10:10:03 +01:00
djvu.c changed page number reading 2012-10-09 18:00:19 +02:00
djvu.h mod: fix typo in comments 2012-03-05 10:02:39 +08:00
djvureader.lua Merge pull request #397 from tigran123/djvu-validate 2012-10-09 13:17:54 -07: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 remove dependency on <linux/fb.h> 2012-06-09 21:56:19 +08:00
einkfb.h remove dependency on <linux/fb.h> 2012-06-09 21:56:19 +08:00
extentions.lua Initial commit of picviewer. 2012-10-08 16:39:03 +01:00
filechooser.lua Merge pull request #383 from tigran123/rendertext 2012-10-07 07:28:31 -07:00
filehistory.lua Switch to new InfoMessage API from NuPogodi. 2012-10-05 10:59:37 +01:00
fileinfo.lua Bugfix: count books like BOOK.PDF and BOOK.DJVU 2012-10-08 12:04:52 +01:00
filesearcher.lua Improvements to filesearcher from NuPogodi 2012-10-05 11:17:18 +01:00
font.lua New InfoMessage Concept 2012-10-03 00:45:45 +02: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
graphics.lua faster refresh path for the cursor 2012-05-28 19:45:08 +02:00
helppage.lua Don't use Home to exit Help page. 2012-10-05 17:36:43 +01:00
image.lua bugfix/typo 2012-04-15 23:39:53 +02:00
input.c We don't need you, either, in EMU... 2012-10-03 15:36:05 +02:00
input.h remove dependency on <linux/input.h> 2012-06-11 02:49:45 +08:00
inputbox.lua New InfoMessage Concept 2012-10-03 00:45:45 +02:00
keys.lua add usb charging events 2012-06-07 22:00:09 +08:00
kpdf.sh Reimplement kpdf.sh changes from PR#348 after the PR#352 merge, and fix 2012-10-03 03:02:41 +02:00
kpdfview.c Initial commit of picviewer. 2012-10-08 16:39:03 +01:00
Makefile Force the use of bash. 2012-10-10 21:04:47 +01: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-03 01:51:05 +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-29 10:07:04 +01:00
pdf.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
pdfreader.lua getPageLinks implementation for mupdf #72 2012-09-24 17:49:03 +02:00
pic.c Support only grayscale images for now. 2012-10-10 13:15:16 +01:00
pic.h Fix the leftover from the old name jpg.h 2012-10-08 23:00:28 +01:00
picviewer.lua Use the local copy of the global G_width variable. 2012-10-10 13:55:38 +01:00
reader.lua Initial commit of picviewer. 2012-10-08 16:39:03 +01:00
README.md Mention patch in the pre-requisites for building. 2012-10-06 13:17:21 +01:00
rendertext.lua Revert "Undo some of my changes to rendertext.lua" 2012-10-10 17:32:23 +01:00
screen.lua New InfoMessage Concept 2012-10-03 00:45:45 +02:00
selectmenu.lua Don't use kerning for monospaced fonts. 2012-10-06 20:46:19 +01:00
settings.lua show reneding page_indicator only in debug mode 2012-10-03 00:16:45 +02:00
slider_watcher.c Kill a bit of cruft, explain the reasonning behind the kill/traps, and 2012-10-03 01:17:21 +02:00
unireader.lua "page links" -> "page links shortcut keys" 2012-10-10 21:14:02 +02:00
util.c Get rid of the compilation warning. 2012-09-25 14:46:47 +01:00
util.h Correct the comment (the existing text was referring to a different file). 2012-09-08 22:21:26 +01:00
widget.lua Pass the boolean kerning to renderUtf8Text() 2012-10-07 11:27:55 +01:00

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:

  • 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