KPV: a PDF reader for Kindle, based on muPDF, GPLv3

[chrox]

Originally Posted by eureka

As I see, chrox in Github issues is trying various methods for invoking KPV for supported file types. I think, it will be worth to him to know that system Reader booklet supports plugins. Enabled plugins are listed in reader_plugins.xml. In Kindle Touch this file is located in /opt/amazon/ebook/config/, but it looks like in PW it's embedded into /opt/amazon/ebook/lib/ReaderSDK-impl.jar (but still in a form of easily accessible text file).

I believe, that filetype-dependent part of system reader code is located in plugins that are defined in reader_plugins.xml.

yifanlu tried to reverse engineer plugin interface for 5.0.0 and implement it's own, invoked for EPUB files: https://github.com/yifanlu/KindleEPU...lu/kindle/epub. It could help, but code is in unfinished state.

(I can't post to Github right now, sorry.)

Yes. You are right. The native ReaderBooklet supports PDF, Mobi and Azw document types via a plugin mechanism just like Yifanlu's EPUBBook implementation. But as there are already standalone epub readers like CoolReader and Kindlepdfviewer for Kindle why bother re-implementing another one. What we want is just launching an external reader from native home screen and returning to home screen after we close the document. It's much easier to implement a booklet as a launcher than a real book viewer. And it's already done for Kindle Paperwhite. See the project KPVBooklet at https://github.com/chrox/KPVBooklet.

And there is a screenshot of the home screen after installing KPVBooklet.



Note that PDF, DJVU and EPUB documents can be directly opened with KPV while Mobi and AZW formats are handled by native amazon reader. The file types are registered not in the booklet plugin but in a sqlite database located at /var/local/appreg.db. More information can be found at https://github.com/hwhw/kindlepdfviewer/issues/653

[eureka]

Originally Posted by chrox

Yes. You are right. The native ReaderBooklet supports PDF, Mobi and Azw document types via a plugin mechanism just like Yifanlu's EPUBBook implementation. But as there are already standalone epub readers like CoolReader and Kindlepdfviewer for Kindle why bother re-implementing another one. What we want is just launching an external reader from native home screen and returning to home screen after we close the document. It's much easier to implement a booklet as a launcher than a real book viewer. And it's already done for Kindle Paperwhite. See the project KPVBooklet at https://github.com/chrox/KPVBooklet.

I didn't suggest to reimplement whole viewer as reader plugin, just launcher part (invoking KPV for various files). But it seems, current way is working good enough and, maybe, reader plugin infrastructure doesn't provide any gains for simple launcher, so congratulations!

[twobob]

Originally Posted by dave2008

Looks awesome Have you already put your code in public?

BTW, what do you mean by constant "pushes" gesture? Is it a special event generated by TS?

Hmm. Well basically after a a couple of seconds with the current implementation in gnuboy the "press" dies.

Public? I haven't but I can if you wanted to have a look. like I say needs some extra logic putting in there to make it "actually work" as expected but I did manage to convert the TS areas to the various "buttons"

[h1ro]

ok, I put KPVBooklet.jar into /opt/amazon/ebook/booklet/
but the next step I don't understand. What else do I have to do for installing this on the paperwhite? And how can I put the actual reader application on there manually?

[eureka]

@dave2008, I've compiled KPV with KT support from your repo (commit cc38d9e6) and run it with

/mnt/us/kindlepdfviewver/kpdf.sh /mnt/us/documents

Some patching was required:

Spoiler:

This patch is in public domain.

diff --git a/frontend/ui/device.lua b/frontend/ui/device.lua
index 915b604..454453a 100644
--- a/frontend/ui/device.lua
+++ b/frontend/ui/device.lua
@@ -67,7 +67,7 @@ end
 
 function Device:isTouchDevice()
 	local model = self:getModel()
-	return (model == "Kindle4") or (model == "KindlePaperWhite") or util.isEmulated()
+	return (model == "Kindle4") or (model == "KindlePaperWhite") or (model == "KindleTouch") or util.isEmulated()
 end
 
 function Device:intoScreenSaver()
diff --git a/frontend/ui/inputevent.lua b/frontend/ui/inputevent.lua
index efd2a58..a7b52f5 100644
--- a/frontend/ui/inputevent.lua
+++ b/frontend/ui/inputevent.lua
@@ -239,16 +239,20 @@ function Input:init()
 	else
 		input.open("fake_events")
 		local dev_mod = Device:getModel()
-		-- open event0 for all models
-		input.open("/dev/input/event0")
-		if dev_mod ~= "KindlePaperWhite" then
-			-- we don't have event1 in KindlePaperWhite
+		if dev_mod ~= "KindleTouch" then
+			-- event0 in KindleTouch is "WM8962 Beep Generator" (useless)
+			input.open("/dev/input/event0")
+		end
+		if dev_mod ~= "KindleTouch" and dev_mod ~= "KindlePaperWhite" then
+			-- event1 in KindleTouch is "imx-yoshi Headset" (useless)
+			-- and we don't have event1 in KindlePaperWhite
 			input.open("/dev/input/event1")
-		elseif dev_mod == "KindlePaperWhite" then
+		end
+		if dev_mod == "KindlePaperWhite" then
 			print("Auto-detected Kindle PaperWhite")
 		elseif dev_mod == "KindleTouch" then
-			input.open("/dev/input/event2")
-			input.open("/dev/input/event3")
+			input.open("/dev/input/event2") -- Home button
+			input.open("/dev/input/event3") -- touchscreen
 			print("Auto-detected Kindle Touch")
 		elseif dev_mod == "Kindle4" then
 			print("Auto-detected Kindle 4")

With this patch input events are intercepted and recognized (taps are taps with handler "onGesture", Home button is ["key"] = "Home" with handler "onKeyPress").

But, unfortunately, KPV interface isn't displayed on screen at all.

Here is my eips -i:

Spoiler:

[root@kindle kindlepdfviewer]# eips -i

Fixed framebuffer info
    id:              mxc_epdc_fb    smem_start:       0x75400000
    smem_len:            2179072    type:          PACKED_PIXELS
    type_aux:                  0    visual:   STATIC_PSEUDOCOLOR
    xpanstep:                  1    ypanstep:                  1
    ywrapstep:                 0    line_length:             608
    mmio_start:       0x00000000    mmio_len:                  0
    accel:                     0

Variable framebuffer info
    xres:                    600    yres:                    800
    xres_virtual:            608    yres_virtual:           3584
    xoffset:                   0    yoffset:                   0
    bits_per_pixel:            8    grayscale:                 1
    red.offset:                0    green.offset:              0
    red.length:                8    green.length:              8
    red.msb_right:             0    green.msb_right:           0
    blue.offset:               0    transp.offset:             0
    blue.length:               8    transp.length:             0
    blue.msb_right:            0    transp.msb_right:          0
    nonstd:                    0    activate:                128
    width:                    -1    height:                   -1
    accel_flags:               0    pixclock:           32000000
    left_margin:              17    right_margin:            172
    upper_margin:              4    lower_margin:             18
    hsync_len:                15    vsync_len:                 4
    sync:                      0    vmode:                     0
    rotate:                    1

EDIT: I have Kindle Tocuh 5.1.2
EDIT2: Output of strace eips '' has ioctl(3, 0x4048462e, 0xbed0baf8) = 0.

EDIT3: It works. So:

• einkfb.c should be updated. Kindle Touch has 8-bit framebuffer and 800x600 screen, but it requires kindlePWeinkUpdate(), not the kindle4einkUpdate()
• tap coordinates (both X and Y) reported by touchscreen input device have range 0-4095, so they should be adjusted to screen resolution (so that X will be in range 0-600 and Y will be in range 0-800).

[thomass]

Originally Posted by eureka

I've compiled KPV with KT support from your repo

[eureka]

Originally Posted by chrox

See the project KPVBooklet at https://github.com/chrox/KPVBooklet.

KPVBooklet works also on Kindle Touch 5.1.2 with the following patch (applied to commit aca92dabff):

Spoiler:

PHP Code:

diff --git a/src/com/github/chrox/kpvbooklet/KPVBooklet.java b/src/com/github/chrox/kpvbooklet/KPVBooklet.java
index 27c456a..6a9b7a2 100644
--- a/src/com/github/chrox/kpvbooklet/KPVBooklet.java
+++ b/src/com/github/chrox/kpvbooklet/KPVBooklet.java
@@ -8,7 +8,8 @@ import java.util.Date;
 import org.json.simple.JSONObject;
 import org.json.simple.JSONArray;
 
-import com.amazon.ebook.util.log.d;
+import com.amazon.ebook.util.log.Log;
+import com.amazon.ebook.util.log.LogSystem;
 import com.amazon.kindle.booklet.AbstractBooklet;
 import com.amazon.kindle.restricted.runtime.Framework;
 import com.amazon.kindle.restricted.content.catalog.ContentCatalog;
@@ -22,23 +23,23 @@ import com.amazon.kindle.restricted.content.catalog.ContentCatalog;
  */
 public class KPVBooklet extends AbstractBooklet {
 
-    private final d logger = d.CBb("KPVBooklet");
+    private final Log logger = LogSystem.getLog("KPVBooklet");
     private final String kpdfviewer = "/mnt/us/kindlepdfviewer/kpdf.sh";
     
     private Process kpdfviewerProcess;
     
     public KPVBooklet() {
-        logger.hmA("KPVBooklet");
+        logger.info("KPVBooklet");
     }
     
     public void start(URI contentURI) {
         String path = contentURI.getPath();
-        logger.hmA("Opening " + path + " with kindlepdfviewer...");
+        logger.info("Opening " + path + " with kindlepdfviewer...");
         String[] cmd = new String[] {kpdfviewer, path};
         try {
             kpdfviewerProcess = Runtime.getRuntime().exec(cmd);
         } catch (IOException e) {
-            logger.xIb(e.toString(), e);
+            logger.error(e.toString(), e);
         }
         
         Thread thread = new kpdfviewerWaitThread(path);
@@ -46,13 +47,13 @@ public class KPVBooklet extends AbstractBooklet {
     }
 
     public void stop() {
-        logger.hmA("stop()");
+        logger.info("stop()");
         // Stop kpdfviewer
         if (kpdfviewerProcess != null) {
             try {
                 killQuitProcess(kpdfviewerProcess);
             } catch (Exception e) {
-                logger.xIb(e.toString(), e);
+                logger.error(e.toString(), e);
             }
         }
         super.stop();
@@ -91,7 +92,7 @@ public class KPVBooklet extends AbstractBooklet {
                 // wait for kpdfviewer to finish
                 kpdfviewerProcess.waitFor();
             } catch (InterruptedException e) {
-                logger.xIb(e.toString(), e);
+                logger.error(e.toString(), e);
             }
             // update content catlog after kpdfviewer finished
             updateCC(content_path, 0.0f);
@@ -99,7 +100,7 @@ public class KPVBooklet extends AbstractBooklet {
             try {
                 Runtime.getRuntime().exec("lipc-set-prop com.lab126.appmgrd start app://com.lab126.booklet.home");
             } catch (IOException e) {
-                logger.xIb(e.toString(), e);
+                logger.error(e.toString(), e);
             }
         }
     }
@@ -120,7 +121,7 @@ public class KPVBooklet extends AbstractBooklet {
         String uuid = (String) value.get("uuid");
         String json_change = "{\"commands\":[{\"update\":{\"uuid\":\"" + uuid + "\",\"lastAccess\":" + lastAccess + ",\"percentFinished\":" + percentFinished + ",\"displayTags\":[\"" + tag + "\"]" + "}}],\"type\":\"ChangeRequest\",\"id\":1}";
         CCRequest("change", json_change);
-        logger.hmA("UpdateCC:file:" + path + ",lastAccess:" + lastAccess + ",percentFinished:" + percentFinished);
+        logger.info("UpdateCC:file:" + path + ",lastAccess:" + lastAccess + ",percentFinished:" + percentFinished);
     }
     
     /**
@@ -131,7 +132,7 @@ public class KPVBooklet extends AbstractBooklet {
      */
     private JSONObject CCRequest(String req_type, String req_json) {
         ContentCatalog CC = (ContentCatalog)Framework.getService(ContentCatalog.class);
-        JSONObject json = CC.eL(req_type, req_json, 200, 5);
+        JSONObject json = CC.D(req_type, req_json, 200, 5);
         return json;
     }
 } 


UPD I didn't find any traces of com.lab126.generic.extractor (or, at least, it isn't registered by default), so for displaying of file on Home screen, instead of writing into appreg.db :

INSERT INTO "associations" VALUES('com.lab126.generic.extractor','extractor','GL:*.djvu','true');

I've added entry in scanner configuration:

[root@kindle tmp]# mntroot rw
system: I mntroot:def:Making root filesystem writeable
[root@kindle tmp]# cp -r /etc/kdb/system/daemon/scanner/extractors/7 /etc/kdb/system/daemon/scanner/extractors/20
[root@kindle tmp]# sed -ie 's/txt/djvu/g' /etc/kdb/system/daemon/scanner/extractors/20/glob 
[root@kindle tmp]# mntroot ro
system: I mntroot:def:Making root filesystem read-only
[root@kindle tmp]# restart scanner

Directory 7 contains extractor for text files and 20 is a random big number out of range of system extractors number.

[chrox]

Originally Posted by h1ro

ok, I put KPVBooklet.jar into /opt/amazon/ebook/booklet/
but the next step I don't understand. What else do I have to do for installing this on the paperwhite? And how can I put the actual reader application on there manually?

The method in https://github.com/hwhw/kindlepdfviewer/issues/653 just provided a proof-of-concept way to launch external reader directly from home screen. As @eureka mentioned in the above post there probably is better way to associate additional file types with KPV. I hope we can find the best when we release the brand new version of KPV. For now if you really want to try KPVBooklet you can firstly backup the file /var/local/appreg.db and copy mimes.sql into /var/local and run 'sqlite3 appreg.db < mimes.sql'. Then you can restart framework to activate it.

[dave2008]

@h1ro

You also have to cross-compile your own KPV from the latest code base if you haven't done so. So far we don't have nightly build for the new KPV yet.

@twobob

Yeah, I would like to learn from your code when you think its ready You can send me a mail if you find it more convenient. (dave2008713 <AT> gmail)


@eureka

Wow, that's fast! I will apply your patch to the new_ui branch. Could you please send me your identity (name, email)? So I can put you as the commit author. Or it would even better if you just send a pull request via Github

The output from eips is indeed very helpful. I previously thought the framebuffer in KT is simillar to K4

I will be able to get some free time on Monday night. Then I will work on fixing the eink and tap coordinates stuff.

[eureka]

Originally Posted by dave2008

@eureka

Wow, that's fast! I will apply your patch to the new_ui branch. Could you please send me your identity (name, email)? So I can put you as the commit author. Or it would even better if you just send a pull request via Github

I place those changes into the public domain, so feel free to commit them under your own name.

Sorry for not using GiHtub. I totally understand it's usefulness and awsomeness and I promote it in general, but I'll try to avoid it for contributing into KPV as long as possible (for my personal reasons).

[dave2008]

Originally Posted by eureka

I place those changes into the public domain, so feel free to commit them under your own name.

Sorry for not using GiHtub. I totally understand it's usefulness and awsomeness and I promote it in general, but I'll try to avoid it for contributing into KPV as long as possible (for my personal reasons).

Alright, if you don't mind, I will just use your mobileread id then ;p

[aranwe]

are there somewhere compiled files for Kindle Touch? ... i don't have working cross-compiling setup and i would really like to try this
btw: Big thanks to everyone who helped to port this to KPW/K5 and to the original devs

[knc1]

Originally Posted by aranwe

are there somewhere compiled files for Kindle Touch? ... i don't have working cross-compiling setup and i would really like to try this
btw: Big thanks to everyone who helped to port this to KPW/K5 and to the original devs

For things on cross-compiling, look for the thread titled: DIY - KeK (filter by "tools" prefix).
Be sure to read both the top post and all the pages it links too.

[eureka]

Originally Posted by dave2008

The output from eips is indeed very helpful. I previously thought the framebuffer in KT is simillar to K4

BTW, upto 5.1.0 (not including 5.1.0), KT had slightly different screen update structure:

• old structure
• discovering of structure change

ioctl command value for updating also was different, I believe: 0x4040462e (or, at least, it's so in geekmaster's video player).

I don't think there are still owners of pre-5.1.0 devices, so it's just an interesting fact. But if you want to differentiate pre-5.1.0 devices: firmware version could be read from /etc/prettyversion.txt on device.

P.S. Oh, I see this "old" structure is already present in include/mxcfb.h as mxcfb_update_data.

[dave2008]

Aha, that makes sense now. I previously thought mxcfb_update_data is for KT, so I was somehow suprised to see kindlePWeinkUpdate works in your KT.

I probably won't support version before 5.1.0 for now, until any pre-5.1.0 user come here and complain ;p