mirror of https://github.com/koreader/koreader
use koptinterface to reflow text in pdf/djvu readers
chrox
11 years ago
parent
e525264b01
commit
349bcb996e
@ -1,249 +0,0 @@
|
||||
require "cache"
|
||||
require "ui/geometry"
|
||||
require "ui/screen"
|
||||
require "ui/device"
|
||||
require "ui/reader/readerconfig"
|
||||
|
||||
Configurable = {}
|
||||
|
||||
function Configurable:hash(sep)
|
||||
local hash = ""
|
||||
local excluded = {multi_threads = true,}
|
||||
for key,value in pairs(self) do
|
||||
if type(value) == "number" and not excluded[key] then
|
||||
hash = hash..sep..value
|
||||
end
|
||||
end
|
||||
return hash
|
||||
end
|
||||
|
||||
function Configurable:loadDefaults()
|
||||
for i=1,#KOPTOptions do
|
||||
local options = KOPTOptions[i].options
|
||||
for j=1,#KOPTOptions[i].options do
|
||||
local key = KOPTOptions[i].options[j].name
|
||||
self[key] = KOPTOptions[i].options[j].default_value
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
function Configurable:loadSettings(settings, prefix)
|
||||
for key,value in pairs(self) do
|
||||
if type(value) == "number" then
|
||||
saved_value = settings:readSetting(prefix..key)
|
||||
self[key] = (saved_value == nil) and self[key] or saved_value
|
||||
--Debug("Configurable:loadSettings", "key", key, "saved value", saved_value,"Configurable.key", self[key])
|
||||
end
|
||||
end
|
||||
--Debug("loaded config:", dump(Configurable))
|
||||
end
|
||||
|
||||
function Configurable:saveSettings(settings, prefix)
|
||||
for key,value in pairs(self) do
|
||||
if type(value) == "number" then
|
||||
settings:saveSetting(prefix..key, value)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- Any document processed by K2pdfopt is called a koptdocument
|
||||
KoptDocument = Document:new{
|
||||
_document = false,
|
||||
-- muPDF manages its own additional cache
|
||||
mupdf_cache_size = 5 * 1024 * 1024,
|
||||
djvulibre_cache_size = nil,
|
||||
dc_null = DrawContext.new(),
|
||||
screen_size = Screen:getSize(),
|
||||
screen_dpi = Device:getModel() == "KindlePaperWhite" and 212 or 167,
|
||||
configurable = Configurable,
|
||||
}
|
||||
|
||||
function KoptDocument:init()
|
||||
self.configurable:loadDefaults()
|
||||
self.file_type = string.lower(string.match(self.file, ".+%.([^.]+)") or "")
|
||||
if self.file_type == "pdf" then
|
||||
local ok
|
||||
ok, self._document = pcall(pdf.openDocument, self.file, self.mupdf_cache_size)
|
||||
if not ok then
|
||||
self.error_message = self.doc -- will contain error message
|
||||
return
|
||||
end
|
||||
self.is_open = true
|
||||
self.info.has_pages = true
|
||||
self.info.configurable = true
|
||||
if self._document:needsPassword() then
|
||||
self.is_locked = true
|
||||
else
|
||||
self:_readMetadata()
|
||||
end
|
||||
|
||||
elseif self.file_type == "djvu" then
|
||||
if not validDjvuFile(self.file) then
|
||||
self.error_message = "Not a valid DjVu file"
|
||||
return
|
||||
end
|
||||
|
||||
local ok
|
||||
ok, self._document = pcall(djvu.openDocument, self.file, self.djvulibre_cache_size)
|
||||
if not ok then
|
||||
self.error_message = self.doc -- will contain error message
|
||||
return
|
||||
end
|
||||
self.is_open = true
|
||||
self.info.has_pages = true
|
||||
self.info.configurable = true
|
||||
self:_readMetadata()
|
||||
end
|
||||
end
|
||||
|
||||
function KoptDocument:unlock(password)
|
||||
if not self._document:authenticatePassword(password) then
|
||||
self._document:close()
|
||||
return false, "wrong password"
|
||||
end
|
||||
self.is_locked = false
|
||||
return self:_readMetadata()
|
||||
end
|
||||
|
||||
-- check DjVu magic string to validate
|
||||
function validDjvuFile(filename)
|
||||
f = io.open(filename, "r")
|
||||
if not f then return false end
|
||||
local magic = f:read(8)
|
||||
f:close()
|
||||
if not magic or magic ~= "AT&TFORM" then return false end
|
||||
return true
|
||||
end
|
||||
|
||||
function KoptDocument:getUsedBBox(pageno)
|
||||
if self.file_type == "pdf" then
|
||||
local hash = "pgubbox|"..self.file.."|"..pageno
|
||||
local cached = Cache:check(hash)
|
||||
if cached then
|
||||
return cached.ubbox
|
||||
end
|
||||
local page = self._document:openPage(pageno)
|
||||
local used = {}
|
||||
used.x0, used.y0, used.x1, used.y1 = page:getUsedBBox()
|
||||
local pwidth, pheight = page:getSize(self.dc_null)
|
||||
if used.x1 == 0 then used.x1 = pwidth end
|
||||
if used.y1 == 0 then used.y1 = pheight end
|
||||
-- clamp to page BBox
|
||||
if used.x0 < 0 then used.x0 = 0 end;
|
||||
if used.y0 < 0 then used.y0 = 0 end;
|
||||
if used.x1 > pwidth then used.x1 = pwidth end
|
||||
if used.y1 > pheight then used.y1 = pheight end
|
||||
--@TODO give size for cacheitem? 02.12 2012 (houqp)
|
||||
Cache:insert(hash, CacheItem:new{
|
||||
ubbox = used,
|
||||
})
|
||||
page:close()
|
||||
DEBUG("UsedBBox", used)
|
||||
return used
|
||||
elseif self.file_type == "djvu" then
|
||||
-- djvu does not support usedbbox, so fake it.
|
||||
local used = {}
|
||||
local native_dim = self:getNativePageDimensions(pageno)
|
||||
used.x0, used.y0, used.x1, used.y1 = 0, 0, native_dim.w, native_dim.h
|
||||
return used
|
||||
end
|
||||
end
|
||||
|
||||
-- get reflow context
|
||||
function KoptDocument:getKOPTContext(pageno)
|
||||
local kc = KOPTContext.new()
|
||||
kc:setTrim(self.configurable.trim_page)
|
||||
kc:setWrap(self.configurable.text_wrap)
|
||||
kc:setIndent(self.configurable.detect_indent)
|
||||
kc:setRotate(self.configurable.screen_rotation)
|
||||
kc:setColumns(self.configurable.max_columns)
|
||||
kc:setDeviceDim(self.screen_size.w, self.screen_size.h)
|
||||
kc:setDeviceDPI(self.screen_dpi)
|
||||
kc:setStraighten(self.configurable.auto_straighten)
|
||||
kc:setJustification(self.configurable.justification)
|
||||
kc:setZoom(self.configurable.font_size)
|
||||
kc:setMargin(self.configurable.page_margin)
|
||||
kc:setQuality(self.configurable.quality)
|
||||
kc:setContrast(self.configurable.contrast)
|
||||
kc:setDefectSize(self.configurable.defect_size)
|
||||
kc:setLineSpacing(self.configurable.line_spacing)
|
||||
kc:setWordSpacing(self.configurable.word_spacing)
|
||||
local bbox = self:getUsedBBox(pageno)
|
||||
kc:setBBox(bbox.x0, bbox.y0, bbox.x1, bbox.y1)
|
||||
return kc
|
||||
end
|
||||
|
||||
-- calculates page dimensions
|
||||
function KoptDocument:getPageDimensions(pageno, zoom, rotation)
|
||||
-- check cached page size
|
||||
local hash = "kctx|"..self.file.."|"..pageno.."|"..self.configurable:hash('|')
|
||||
local cached = Cache:check(hash)
|
||||
if not cached then
|
||||
local kc = self:getKOPTContext(pageno)
|
||||
local page = self._document:openPage(pageno)
|
||||
-- reflow page
|
||||
page:reflow(kc, 0)
|
||||
page:close()
|
||||
local fullwidth, fullheight = kc:getPageDim()
|
||||
DEBUG("page::reflowPage:", "fullwidth:", fullwidth, "fullheight:", fullheight)
|
||||
local page_size = Geom:new{ w = fullwidth, h = fullheight }
|
||||
-- cache reflowed page size and kc
|
||||
Cache:insert(hash, CacheItem:new{ kctx = kc })
|
||||
return page_size
|
||||
end
|
||||
--DEBUG("Found cached koptcontex on page", pageno, cached)
|
||||
local fullwidth, fullheight = cached.kctx:getPageDim()
|
||||
local page_size = Geom:new{ w = fullwidth, h = fullheight }
|
||||
return page_size
|
||||
end
|
||||
|
||||
function KoptDocument:renderPage(pageno, rect, zoom, rotation, render_mode)
|
||||
self.render_mode = render_mode
|
||||
local hash = "renderpg|"..self.file.."|"..pageno.."|"..self.configurable:hash('|')
|
||||
local page_size = self:getPageDimensions(pageno, zoom, rotation)
|
||||
-- this will be the size we actually render
|
||||
local size = page_size
|
||||
-- we prefer to render the full page, if it fits into cache
|
||||
if not Cache:willAccept(size.w * size.h / 2) then
|
||||
-- whole page won't fit into cache
|
||||
DEBUG("rendering only part of the page")
|
||||
-- TODO: figure out how to better segment the page
|
||||
if not rect then
|
||||
DEBUG("aborting, since we do not have a specification for that part")
|
||||
-- required part not given, so abort
|
||||
return
|
||||
end
|
||||
-- only render required part
|
||||
hash = "renderpg|"..self.file.."|"..pageno.."|"..self.configurable:hash('|').."|"..tostring(rect)
|
||||
size = rect
|
||||
end
|
||||
|
||||
local cached = Cache:check(hash)
|
||||
if cached then return cached end
|
||||
|
||||
-- prepare cache item with contained blitbuffer
|
||||
local tile = CacheItem:new{
|
||||
size = size.w * size.h / 2 + 64, -- estimation
|
||||
excerpt = size,
|
||||
pageno = pageno,
|
||||
bb = Blitbuffer.new(size.w, size.h)
|
||||
}
|
||||
|
||||
-- draw to blitbuffer
|
||||
local kc_hash = "kctx|"..self.file.."|"..pageno.."|"..self.configurable:hash('|')
|
||||
local page = self._document:openPage(pageno)
|
||||
local cached = Cache:check(kc_hash)
|
||||
if cached then
|
||||
page:rfdraw(cached.kctx, tile.bb)
|
||||
page:close()
|
||||
DEBUG("cached hash", hash)
|
||||
if not Cache:check(hash) then
|
||||
Cache:insert(hash, tile)
|
||||
end
|
||||
return tile
|
||||
end
|
||||
DEBUG("Error: cannot render page before reflowing.")
|
||||
end
|
||||
|
||||
DocumentRegistry:addProvider("pdf", "application/pdf", KoptDocument)
|
||||
DocumentRegistry:addProvider("djvu", "application/djvu", KoptDocument)
|
||||
@ -0,0 +1,113 @@
|
||||
require "cache"
|
||||
require "ui/geometry"
|
||||
require "ui/screen"
|
||||
require "ui/device"
|
||||
require "ui/reader/readerconfig"
|
||||
|
||||
KoptInterface = {}
|
||||
|
||||
-- get reflow context
|
||||
function KoptInterface:getKOPTContext(doc, pageno)
|
||||
local kc = KOPTContext.new()
|
||||
kc:setTrim(doc.configurable.trim_page)
|
||||
kc:setWrap(doc.configurable.text_wrap)
|
||||
kc:setIndent(doc.configurable.detect_indent)
|
||||
kc:setRotate(doc.configurable.screen_rotation)
|
||||
kc:setColumns(doc.configurable.max_columns)
|
||||
kc:setDeviceDim(doc.screen_size.w, doc.screen_size.h)
|
||||
kc:setDeviceDPI(doc.screen_dpi)
|
||||
kc:setStraighten(doc.configurable.auto_straighten)
|
||||
kc:setJustification(doc.configurable.justification)
|
||||
kc:setZoom(doc.configurable.font_size)
|
||||
kc:setMargin(doc.configurable.page_margin)
|
||||
kc:setQuality(doc.configurable.quality)
|
||||
kc:setContrast(doc.configurable.contrast)
|
||||
kc:setDefectSize(doc.configurable.defect_size)
|
||||
kc:setLineSpacing(doc.configurable.line_spacing)
|
||||
kc:setWordSpacing(doc.configurable.word_spacing)
|
||||
local bbox = doc:getUsedBBox(pageno)
|
||||
kc:setBBox(bbox.x0, bbox.y0, bbox.x1, bbox.y1)
|
||||
return kc
|
||||
end
|
||||
|
||||
-- calculates page dimensions
|
||||
function KoptInterface:getPageDimensions(doc, pageno, zoom, rotation)
|
||||
-- check cached page size
|
||||
local hash = "kctx|"..doc.file.."|"..pageno.."|"..doc.configurable:hash('|')
|
||||
local cached = Cache:check(hash)
|
||||
if not cached then
|
||||
local kc = self:getKOPTContext(doc, pageno)
|
||||
local page = doc._document:openPage(pageno)
|
||||
-- reflow page
|
||||
page:reflow(kc, 0)
|
||||
page:close()
|
||||
local fullwidth, fullheight = kc:getPageDim()
|
||||
DEBUG("page::reflowPage:", "fullwidth:", fullwidth, "fullheight:", fullheight)
|
||||
local page_size = Geom:new{ w = fullwidth, h = fullheight }
|
||||
-- cache reflowed page size and kc
|
||||
Cache:insert(hash, CacheItem:new{ kctx = kc })
|
||||
return page_size
|
||||
end
|
||||
--DEBUG("Found cached koptcontex on page", pageno, cached)
|
||||
local fullwidth, fullheight = cached.kctx:getPageDim()
|
||||
local page_size = Geom:new{ w = fullwidth, h = fullheight }
|
||||
return page_size
|
||||
end
|
||||
|
||||
function KoptInterface:renderPage(doc, pageno, rect, zoom, rotation, render_mode)
|
||||
doc.render_mode = render_mode
|
||||
local hash = "renderpg|"..doc.file.."|"..pageno.."|"..doc.configurable:hash('|')
|
||||
local page_size = self:getPageDimensions(doc, pageno, zoom, rotation)
|
||||
-- this will be the size we actually render
|
||||
local size = page_size
|
||||
-- we prefer to render the full page, if it fits into cache
|
||||
if not Cache:willAccept(size.w * size.h / 2) then
|
||||
-- whole page won't fit into cache
|
||||
DEBUG("rendering only part of the page")
|
||||
-- TODO: figure out how to better segment the page
|
||||
if not rect then
|
||||
DEBUG("aborting, since we do not have a specification for that part")
|
||||
-- required part not given, so abort
|
||||
return
|
||||
end
|
||||
-- only render required part
|
||||
hash = "renderpg|"..doc.file.."|"..pageno.."|"..doc.configurable:hash('|').."|"..tostring(rect)
|
||||
size = rect
|
||||
end
|
||||
|
||||
local cached = Cache:check(hash)
|
||||
if cached then return cached end
|
||||
|
||||
-- prepare cache item with contained blitbuffer
|
||||
local tile = CacheItem:new{
|
||||
size = size.w * size.h / 2 + 64, -- estimation
|
||||
excerpt = size,
|
||||
pageno = pageno,
|
||||
bb = Blitbuffer.new(size.w, size.h)
|
||||
}
|
||||
|
||||
-- draw to blitbuffer
|
||||
local kc_hash = "kctx|"..doc.file.."|"..pageno.."|"..doc.configurable:hash('|')
|
||||
local page = doc._document:openPage(pageno)
|
||||
local cached = Cache:check(kc_hash)
|
||||
if cached then
|
||||
page:rfdraw(cached.kctx, tile.bb)
|
||||
page:close()
|
||||
DEBUG("cached hash", hash)
|
||||
if not Cache:check(hash) then
|
||||
Cache:insert(hash, tile)
|
||||
end
|
||||
return tile
|
||||
end
|
||||
DEBUG("Error: cannot render page before reflowing.")
|
||||
end
|
||||
|
||||
function KoptInterface:drawPage(doc, target, x, y, rect, pageno, zoom, rotation, render_mode)
|
||||
local tile = self:renderPage(doc, pageno, rect, zoom, rotation, render_mode)
|
||||
DEBUG("now painting", tile, rect)
|
||||
target:blitFrom(tile.bb,
|
||||
x, y,
|
||||
rect.x - tile.excerpt.x,
|
||||
rect.y - tile.excerpt.y,
|
||||
rect.w, rect.h)
|
||||
end
|
||||
Loading…
Reference in New Issue