koreader/frontend/document/koptdocument.lua

require "cache"
require "ui/geometry"
require "ui/screen"
require "ui/device"

KOPTOptions =  {
	{
	name="font_size",
	option_text="",
	items_text={"Aa","Aa","Aa","Aa","Aa","Aa","Aa","Aa","Aa","Aa"},
	text_font_size={14,16,20,23,26,30,34,38,42,46},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true, true, true, true, true, true, true, true},
	values={0.2, 0.3, 0.4, 0.6, 0.8, 1.0, 1.2, 1.6, 2.2, 2.8},
	default_value=DKOPTREADER_CONFIG_FONT_SIZE,
	show = true,
	draw_index = nil,},
	{
	name="text_wrap",
	option_text="Reflow",
	items_text={"on","off"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true},
	values={1, 0},
	default_value=DKOPTREADER_CONFIG_TEXT_WRAP,
	show = true,
	draw_index = nil,},
	{
	name="trim_page",
	option_text="Trim Page",
	items_text={"auto","manual"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true},
	values={1, 0},
	default_value=DKOPTREADER_CONFIG_TRIM_PAGE,
	show = true,
	draw_index = nil,},
	{
	name="detect_indent",
	option_text="Indentation",
	items_text={"enable","disable"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true},
	values={1, 0},
	default_value=DKOPTREADER_CONFIG_DETECT_INDENT,
	show = false,
	draw_index = nil,},
	{
	name="defect_size",
	option_text="Defect Size",
	items_text={"small","medium","large"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true},
	values={0.5, 1.0, 2.0},
	default_value=DKOPTREADER_CONFIG_DEFECT_SIZE,
	show = true,
	draw_index = nil,},
	{
	name="page_margin",
	option_text="Page Margin",
	items_text={"small","medium","large"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true},
	values={0.02, 0.06, 0.10},
	default_value=DKOPTREADER_CONFIG_PAGE_MARGIN,
	show = true,
	draw_index = nil,},
	{
	name="line_spacing",
	option_text="Line Spacing",
	items_text={"small","medium","large"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true},
	values={1.0, 1.2, 1.4},
	default_value=DKOPTREADER_CONFIG_LINE_SPACING,
	show = true,
	draw_index = nil,},
	{
	name="word_spacing",
	option_text="Word Spacing",
	items_text={"small","medium","large"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true},
	values={0.05, 0.15, 0.375},
	default_value=DKOPTREADER_CONFIG_WORD_SAPCING,
	show = true,
	draw_index = nil,},
	{
	name="multi_threads",
	option_text="Multi Threads",
	items_text={"on","off"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true},
	values={1, 0},
	default_value=DKOPTREADER_CONFIG_MULTI_THREADS,
	show = true,
	draw_index = nil,},
	{
	name="quality",
	option_text="Render Quality",
	items_text={"low","medium","high"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true},
	values={0.5, 0.8, 1.0},
	default_value=DKOPTREADER_CONFIG_RENDER_QUALITY,
	show = true,
	draw_index = nil,},
	{
	name="auto_straighten",
	option_text="Auto Straighten",
	items_text={"0","5","10"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true},
	values={0, 5, 10},
	default_value=DKOPTREADER_CONFIG_AUTO_STRAIGHTEN,
	show = true,
	draw_index = nil,},
	{
	name="justification",
	option_text="Justification",
	items_text={"auto","left","center","right","full"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true, true, true},
	values={-1,0,1,2,3},
	default_value=DKOPTREADER_CONFIG_JUSTIFICATION,
	show = true,
	draw_index = nil,},
	{
	name="max_columns",
	option_text="Columns",
	items_text={"1","2","3","4"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true, true},
	values={1,2,3,4},
	default_value=DKOPTREADER_CONFIG_MAX_COLUMNS,
	show = true,
	draw_index = nil,},
	{
	name="contrast",
	option_text="Contrast",
	items_text={"lightest","lighter","default","darker","darkest"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true, true, true},
	values={2.0, 1.5, 1.0, 0.5, 0.2},
	default_value=DKOPTREADER_CONFIG_CONTRAST,
	show = true,
	draw_index = nil,},
	{
	name="screen_rotation",
	option_text="Screen Rotation",
	items_text={"0","90","180","270"},
	current_item=nil,
	text_dirty=true,
	marker_dirty={true, true, true, true},
	values={0, 90, 180, 270},
	default_value=DKOPTREADER_CONFIG_SCREEN_ROTATION,
	show = true,
	draw_index = nil,},
}

-- 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,
	options = KOPTOptions,
	configurable = {
		font_size = 1.0,
		page_margin = 0.06,
		line_spacing = 1.2,
		word_spacing = 0.15,
		quality = 1.0,
		text_wrap = 1,
		defect_size = 1.0,
		trim_page = 0,
		detect_indent = 1,
		multi_threads = 0,
		auto_straighten = 0,
		justification = -1,
		max_columns = 2,
		contrast = 1.0,
		screen_rotation = 0,
	},
}

function KoptDocument:init()
	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
	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.."|"..zoom.."|"..rotation
	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.."|"..zoom.."|"..rotation.."|"..tostring(rect)
		size = rect
	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
	local page = self._document:openPage(pageno)
	local cached = Cache:check(kc_hash)
	if cached then
		page:rfdraw(cached.kctx, tile.bb)
		page:close()
		Cache:insert(hash, tile)
		return tile
	end
	DEBUG("Error: cannot render page before reflowing.")
end

DocumentRegistry:addProvider("pdf", "application/pdf", KoptDocument)
DocumentRegistry:addProvider("djvu", "application/djvu", KoptDocument)