DisplayManX.lua

local ffi = require "ffi"
local bit = require "bit"
local lshift = bit.lshift
local rshift = bit.rshift
local band = bit.band
local bor = bit.bor
local bnot = bit.bnot

-- Display manager service API
local host = require "BcmHost"
local Native = host.bcm_host_lib

-- Initialize module
--Native.vc_dispman_init();

-- Call this instead of vc_dispman_init
--Native.vc_vchi_dispmanx_init (VCHI_INSTANCE_T initialise_instance, VCHI_CONNECTION_T **connections, uint32_t num_connections );

local ALIGN_UP = function(x,y)  
    return band((x + y-1), bnot(y-1))
end


--[=[
ffi.cdef[[

// Stop the service from being used
void vc_dispmanx_stop( void );


//xxx hack to get the image pointer from a resource handle, will be obsolete real soon
uint32_t vc_dispmanx_resource_get_image_handle( DISPMANX_RESOURCE_HANDLE_T res);


]]
--]=]

DisplayManX = {
	rect_set = function(rect, x_offset, y_offset, width, height )
		local result = Native.vc_dispmanx_rect_set( rect, x_offset, y_offset, width, height );
		return result == 0 or false, result;
	end,
	
	-- Miscellany
	-- Take a snapshot of a display in its current state.
	-- This call may block for a time; when it completes, the snapshot is ready.
	snapshot = function(display, snapshot_resource, transform)
		local result = Native.vc_dispmanx_snapshot( display, snapshot_resource, transform );
		return result == 0 or false, result
	end,

	-- Query the image formats supported in the VMCS build
	query_image_formats = function()
		local pformats = ffi.new("uint32_t [256]");
		local result = Native.vc_dispmanx_query_image_formats( pformats );
		if result == 0 then
			return pformats
		end

		return false, result
	end,

	resource_create = function(imgtype, width, height)
		local phandle = ffi.new("uint32_t[1]");
		local resource = Native.vc_dispmanx_resource_create( imgtype, width, height, phandle );
		
		if resource >0  then
			return resource
		end

		return false, resource
	end,

	-- Write the bitmap data to VideoCore memory
	resource_write_data = function(res, src_type, src_pitch, src_address, rect)
		local result = Native.vc_dispmanx_resource_write_data(res, src_type, src_pitch, src_address, rect );
	
		return result == 0 or false, result;
	end,
	
	resource_write_data_handle = function(res, src_type, src_pitch,handle, offset, rect )
		local result = Native.vc_dispmanx_resource_write_data_handle( res, src_type, src_pitch, handle, offset, rect );
	
		return result == 0 or false, result;
	end,
	
	resource_read_data = function(handle, p_rect,dst_address,dst_pitch)
		local result = Native.vc_dispmanx_resource_read_data(handle, p_rect,dst_address,dst_pitch );
		
		return result == 0 or false, result;
	end,
	
	-- Delete a resource
	resource_delete = function(res)
		local result = Native.vc_dispmanx_resource_delete( res );
		
		return result == 0 or false, result;
	end,

	-- Displays
	-- Opens a display on the given device
	display_open = function(device)
		device = device or DISPMANX_ID_MAIN_LCD
		local handle =  Native.vc_dispmanx_display_open( device );
		if handle == DISPMANX_NO_HANDLE then
			return false
		end

		return handle;
	end,

	-- Opens a display on the given device in the request mode
	display_open_mode = function(device, mode)
		local handle = Native.vc_dispmanx_display_open_mode( device, mode );
		return handle;
	end,

	-- Open an offscreen display
	display_open_offscreen = function(dest, orientation)
		local handle = Native.vc_dispmanx_display_open_offscreen( dest, orientation );
		return handle;
	end,


	-- Change the mode of a display
	reconfigure = function(display, mode)	
		local result = Native.vc_dispmanx_display_reconfigure( display, mode );
		return result == 0 or false, result
	end,

	-- Sets the desstination of the display to be the given resource
	set_destination = function(display, dest)
		local result = Native.vc_dispmanx_display_set_destination( display, dest );
		return result == 0 or false, result
	end,

	-- Set the background colour of the display
	set_background = function(update, display, red, green, blue)
		local result = Native.vc_dispmanx_display_set_background( update, display, red, green, blue );
		return result == 0 or false, result
	end,

	-- get the width, height, frame rate and aspect ratio of the display
	get_info = function(display)
		pinfo = ffi.new("DISPMANX_MODEINFO_T");
		local result = Native.vc_dispmanx_display_get_info( display, pinfo );
		if result ~= 0 then
			return false, result
		end

		return pinfo
	end,

	-- Closes a display
	display_close = function(display)
		local result = Native.vc_dispmanx_display_close( display );
		return result == 0 or false, result
	end,

	-- Updates
	-- Start a new update, DISPMANX_NO_HANDLE on error
	update_start = function(priority)	
		local result = Native.vc_dispmanx_update_start( priority );
		if result == DISPMANX_NO_HANDLE then
			return false, result
		end
		return result
	end,

	-- Ends an update
	update_submit = function(update, cb_func, cb_arg)
		local result = Native.vc_dispmanx_update_submit( update, cb_func, cb_arg );
		return result ==0 or false, result
	end,

	-- End an update and wait for it to complete
	update_submit_sync = function(update)
		local result = Native.vc_dispmanx_update_submit_sync(update);
		return result == 0 or false, result
	end,

	
	-- Element Management
	-- Add an element to a display as part of an update
	element_add = function(update, display,layer, dest_rect, src, src_rect, protection, alpha, clamp, transform)

		local handle = Native.vc_dispmanx_element_add ( update, display, layer, dest_rect, src,src_rect, protection, alpha, clamp, transform );

		return handle
	end,

	-- Change the source image of a display element
	element_change_source = function(update, element, src)
		local result = Native.vc_dispmanx_element_change_source( update, element,src );
		return result == 0 or false, result
	end,

	-- Change the layer number of a display element
	element_change_layer = function(update, element, layer)
		local result = Native.vc_dispmanx_element_change_layer ( update, element, layer );
		return result == 0 or false, result
	end,

	-- Signal that a region of the bitmap has been modified
	element_modified = function(update, element, rect)
		local result = Native.vc_dispmanx_element_modified( update, element, rect );
		return result == 0 or false, result
	end,

	-- Remove a display element from its display
	element_remove = function(update, element)
		local result = Native.vc_dispmanx_element_remove(update, element);
		return result == 0 or false, result
	end,

	-- New function added to VCHI to change attributes, set_opacity does not work there.
	element_change_attributes = function(update,element,change_flags,layer,opacity,dest_rect,src_rect,mask,transform)
		local result = Native.vc_dispmanx_element_change_attributes( update, 
                                                            element,
                                                            change_flags,
                                                            layer,
                                                            opacity,
                                                            dest_rect,
                                                            src_rect,
                                                            mask,
                                                            transform );
		return result == 0 or false, result
	end,
}


-- Class for updates
ffi.cdef[[
struct DMXUpdate {
	DISPMANX_UPDATE_HANDLE_T	Handle;
};

struct DMXDisplay {
	DISPMANX_DISPLAY_HANDLE_T	Handle;
};

struct DMXElement {
	DISPMANX_ELEMENT_HANDLE_T	Handle;
};



struct DMXResource {
	DISPMANX_RESOURCE_HANDLE_T	Handle;
	int32_t				Width;
	int32_t				Height;
	VC_IMAGE_TYPE_T			PixelFormat;
};		
]]


--[[
	The Display is the hook into the graphics
	system.  There may be a couple of displays
	connected to the device (composite, HDMI).

	There are a very few functions that operate
	on the display directly, such as setting the 
	background, and getting information.

	Perhaps the most important function is 
	AddElement, as this is how you get to display
	some graphics.
--]]
DMXDisplay = ffi.typeof("struct DMXDisplay");
DMXDisplay_mt = {
	__gc = function(self)
		print("GC: DMXDisplay");
		DisplayManX.display_close(self.Handle);
	end,

	__new = function(ct, screen)
		local handle, err = DisplayManX.display_open(screen);
		if not handle then
			return false, err
		end

		local obj = ffi.new(ct, handle)
		return obj;
	end,

	__index = {

		CreateElement = function(self, DestinationRect, resource, SourceRect, layer, protection, alpha, clamp, transform)

			local update,err = DMXUpdate(10);

			if not update then
				return false, err
			end
			
			layer = layer or 0;
			protection = protection or DISPMANX_PROTECTION_NONE;
			transform = transform or ffi.C.VC_IMAGE_ROT0;
			local resourcehandle
			if resource then 
				resourcehandle = resource.Handle
			else
				resourcehandle = 0
			end

			local elementHandle, err = DisplayManX.element_add(update.Handle,
				self.Handle,
				layer,
				DestinationRect,
				resourcehandle,
				SourceRect,
				protection,
				alpha,
				clamp,
				transform);

			if not elementHandle then
				return false, err
			end
			
			local element, err = DMXElement(elementHandle);
			local success, err = update:SubmitSync();

			if not success then
				return false, err
			end

			return element
		end,

		CreateView = function(self, width, height, x, y, level, pFormat, opacity)
			x = x or 0
			y = y or 0
			level = level or 0
			pFormat = pFormat or ffi.C.VC_IMAGE_RGB565
			
			resource = resource or DMXResource(width, height, pFormat);

			local view = DisplayManX.DMXView.new(self, x, y, width, height, layer, pFormat, resource, opacity)

			return view;
		end,

		GetInfo = function(self)
			return DisplayManX.get_info(self.Handle);
		end,

		GetSize = function(self)
			local info = self:GetInfo();
			return info.width, info.height;
		end,

		SetBackground = function(self, red, green, blue)
			local update, err = DMXUpdate(10);
			if not update then
				return nil, err
			end

			DisplayManX.set_background(update.Handle, self.Handle, red, green, blue)
			return update:SubmitSync();
		end,

		Snapshot = function(self, resource, transform)
			transform = transform or ffi.C.VC_IMAGE_ROT0;

			return DisplayManX.snapshot(self.Handle, resource.Handle, transform);
		end,
	},
}
ffi.metatype(DMXDisplay, DMXDisplay_mt);


--[[
	The essential display element.
	Elements are regions of the display where drawing
	occurs.  They might be thought of as the building
	blocks for a "Window".
--]]
DMXElement = ffi.typeof("struct DMXElement");
DMXElement_mt = {
	__gc = function(self)
		print("GC: DMXElement");
		self:Free();
	end,

	__new = function(ct, handle)
		-- Create the data structure
		local obj = ffi.new("struct DMXElement", handle);
		
		return obj;
	end,

	__index = {
		Free = function(self)
	
			if self.Handle == DISPMANX_NO_HANDLE then
				return true
			end

			local update = DMXUpdate(10);
			if update then
				DisplayManX.element_remove(update.Handle, self.Handle);
				update:SubmitSync();
				self.Handle = DISPMANX_NO_HANDLE;
			end
		end,


	},
}
ffi.metatype(DMXElement, DMXElement_mt);



DMXResource = ffi.typeof("struct DMXResource");
DMXResource_mt = {
	__gc = function(self)
		print("GC: DMXResource");
		DisplayManX.resource_delete(self.Handle);
	end,

	__new = function(ct, width, height, imgtype)
		imgtype = imgtype or ffi.C.VC_IMAGE_RGB565;
		local handle, err = DisplayManX.resource_create(imgtype, width, height);
		if not handle then
			return nil, err
		end

		local obj = ffi.new(ct, handle, width, height, imgtype);
		return obj;
	end,

	__index = {
		CopyImage = function(self, imgtype, pitch, image, dst_rect)
			return DisplayManX.resource_write_data(self.Handle, imgtype, pitch, image, dst_rect);
		end,

		CopyPixelBuffer = function(self, pbuff, x, y, width, height)
			local dst_rect = VC_RECT_T(x, y, width, height);
			return DisplayManX.resource_write_data(self.Handle, pbuff.PixelFormat, pbuff.Pitch, pbuff.Data, dst_rect);
		end,

		ReadPixelData = function(self, pixdata, p_rect)
			local p_rect = p_rect or VC_RECT_T(0,0,self.Width, self.Height);
			local pixdata = pixdata or self:CreateCompatiblePixmap(p_rect.width, p_rect.height);
 	
			local success, err = DisplayManX.resource_read_data (self.Handle, p_rect, pixdata.Data, pixdata.Pitch)

			if success then
				return pixdata;
			end

			return false, result;
		end,

		CreateCompatiblePixmap = function(self, width, height)
			width = width or self.Width;
			height = height or self.Height;

			return DisplayManX.DMXPixelData(width, height, self.PixelFormat);
		end,
	},
}
ffi.metatype(DMXResource, DMXResource_mt);


DMXUpdate = ffi.typeof("struct DMXUpdate");
DMXUpdate_mt = {
	__gc = function(self)

	end,

	__new = function(ct, priority)
		priority = priority or 10
		local handle, err = DisplayManX.update_start(priority);
		if not handle then 
			return nil, err
		end

		local obj = ffi.new(ct, handle);
		return obj;
	end,

	__index = {
		Submit = function(self, cb_func, cb_arg)
			return DisplayManX.update_submit(self.Handle, cb_func, cb_arg); 
		end,

		SubmitSync = function(self)
			return DisplayManX.update_submit_sync(self.Handle);
		end,

	},
}
ffi.metatype(DMXUpdate, DMXUpdate_mt);


-- Core data structures
DisplayManX.DMXUpdate = DMXUpdate;
DisplayManX.DMXDisplay = DMXDisplay;
DisplayManX.DMXResource = DMXResource;
DisplayManX.DMXElement = DMXElement;





--[[
	The contrived classes
--]]

ffi.cdef[[
struct DMXPixelData {
	void *		Data;
	VC_IMAGE_TYPE_T	PixelFormat;
	int32_t		Width;
	int32_t		Height;
	int32_t		Pitch;
};
]]

local pixelSizes = {
	[tonumber(ffi.C.VC_IMAGE_RGB565)] = 2,
	[tonumber(ffi.C.VC_IMAGE_RGB888)] = 3,
}

local DMXPixelData = ffi.typeof("struct DMXPixelData");
local DMXPixelData_mt = {

	__gc = function(self)
		print("GC: DMXPixelMatrix");
		if self.Data ~= nil then
			ffi.C.free(self.Data);
		end
	end,

	__new = function(ct, width, height, pformat)
		pformat = pformat or ffi.C.VC_IMAGE_RGB565
print("DMXPixelData(), pformat: ", pformat);
		local sizeofpixel = pixelSizes[tonumber(pformat)];

		local pitch = ALIGN_UP(width*sizeofpixel, 32);
		local aligned_height = ALIGN_UP(height, 16);
		local dataPtr = ffi.C.calloc(pitch * height, 1);
		return ffi.new(ct, dataPtr, pformat, width, height, pitch);
	end,
}
ffi.metatype(DMXPixelData, DMXPixelData_mt);





local DMXView = {}
local DMXView_mt = {
	__index = DMXView,
}

DMXView.new = function(display, x, y, width, height, layer, pformat, resource, opacity, show)
	x = x or 0
	y = y or 0
	layer = layer or 0
	pformat = pformat or ffi.C.VC_IMAGE_RGB565
	resource = resource or DMXResource(width, height, pformat);
	opacity = opacity or 1.0;
	show = show or true;

	local obj = {
		X = x;
		Y = y;
		Width = width;
		Height = height;
		Resource = resource;
		Layer = layer;
		Display = display;
		Opacity = opacity;
	}
	setmetatable(obj, DMXView_mt);

	if show then
		obj:Show();
	end

	return obj
end

DMXView.CopyPixelBuffer = function(self, pbuff, x, y, width, height)
	x = x or 0
	y = y or 0
	width = width or pbuff.Width;
	height = height or pbuff.Height;

	self.Resource:CopyPixelBuffer(pbuff, x, y, width, height)
end

DMXView.Hide = function(self)
	if (self.Surface) then
		self.Surface:Free();
	end

	self.Surface = nil;
	
	return true;
end

DMXView.Show = function(self)
	local dst_rect = VC_RECT_T(self.X, self.Y, self.Width, self.Height);
	local src_rect = VC_RECT_T( 0, 0, lshift(self.Width, 16), lshift(self.Height, 16) );

	local alpha = nil;
	if self.Opacity and self.Opacity >= 0 and self.Opacity < 1.0 then
		alpha = VC_DISPMANX_ALPHA_T( bor(ffi.C.DISPMANX_FLAGS_ALPHA_FROM_SOURCE, ffi.C.DISPMANX_FLAGS_ALPHA_FIXED_ALL_PIXELS), self.Opacity * 255, 0 );
	end
   	
	self.Surface = self.Display:CreateElement(dst_rect, self.Resource, src_rect, self.Layer, DISPMANX_PROTECTION_NONE, alpha);
end

--[[
	change_flags (bit 0 layer, bit 1 opacity, bit 2 dest rect, bit 3 src rect, bit 4 mask, bit 5 transform)
--]]

local CHANGE_SOURCE		= 0x01;
local CHANGE_DST_RECT		= 0x02;
local CHANGE_SRC_RECT		= 0x04;
local CHANGE_OPACITY 		= 0x08;

local CHANGE_MASK		= 0x10;
local CHANGE_LAYER	 	= 0x20;
local CHANGE_TRANSFORM		= 0x40;
local CHANGE_INSERT_ABOVE	= 0x80;

local CHANGE_FLAGS		= 0x100;
local CHANGE_NOTHING		= 0x200;

DMXView.MoveTo = function(self, x, y)
	local update = DMXUpdate(10);
	
	if not update then
		return false;
	end

--print("DMXView.MoveTo() - ", x, y, self.Width, self.Height);

	local dst_rect = VC_RECT_T(x, y, self.Width, self.Height);
	local src_rect = VC_RECT_T( 0, 0, lshift(self.Width, 16), lshift(self.Height, 16) );

	self.X = x;
	self.Y = y;
	local change_flags = bor(CHANGE_DST_RECT, CHANGE_SRC_RECT);
	local mask = 0;
	local transform = self.Transform or ffi.C.VC_IMAGE_ROT0;

--print("change_flags: ", change_flags);

	local success, err = DisplayManX.element_change_attributes(update.Handle, self.Surface.Handle,
		change_flags,
		self.Layer,
		self.Opacity,
		dst_rect, 
		src_rect,
		mask,
		transform);

	update:SubmitSync();
end





DisplayManX.DMXPixelData = DMXPixelData;
DisplayManX.DMXView = DMXView;


return DisplayManX