Added options to configure width, height and framerate into the addon

settings interface.

Author: StefanRvO

addon.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<addon id="script.service.hyperion" name="Hyperion ambilight" version="1.0.0" provider-name="poljvd|tvdzwan">
+<addon id="script.service.hyperion" name="Hyperion ambilight" version="1.0.1" provider-name="poljvd|tvdzwan">
   <requires>
     <import addon="xbmc.python" version="2.1.0"/>
   </requires>
@@ -11,6 +11,6 @@
 	<website>https://github.com/tvdzwan/hyperion/wiki</website>
 	<source>https://github.com/poljvd/script.service.hyperion</source>
 	<forum></forum>
-	<email></email>    
+	<email></email>
   </extension>
 </addon>

changelog.txt

@@ -1,2 +1,3 @@
 1.0.0
 - initial addon release
+- Added option to set framerate and capture size

resources/language/English/strings.xml

@@ -7,7 +7,10 @@
 	<string id="32005">Hyperion priority</string>
 	<string id="32006">Reconnect timeout (s)</string>
 	<string id="32007">Enable when on screensaver</string>
-	
+	<string id="32008">Width of capture</string>
+	<string id="32009">Height of capture</string>
+	<string id="32010">Framerate</string>
 	<string id="32100">Unable to connect to Hyperion</string>
 	<string id="32101">Unable to send image to Hyperion</string>
+
 </strings>

resources/lib/settings.py

@@ -1,6 +1,6 @@
 '''
     XBMC video capturer for Hyperion
-	
+
 	Copyright (c) 2013 Hyperion Team
 
 	Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,7 +29,7 @@
 class MyMonitor (xbmc.Monitor):
 	'''Class to capture changes in settings and screensaver state
 	'''
-	
+
 	def __init__(self, settings):
 		xbmc.Monitor.__init__(self)
 		self.__settings = settings
@@ -38,35 +38,35 @@ def __init__(self, settings):
 
 	def onAbortRequested(self):
 		self.__settings.abort = False
-		
+
 	def onSettingsChanged(self):
 		self.__settings.readSettings()
-	  
+
 	def onScreensaverDeactivated(self):
 		self.__settings.screensaver = False
-	  
-	def onScreensaverActivated(self):    
+
+	def onScreensaverActivated(self):
 		self.__settings.screensaver = True
 
-		
+
 class Settings:
 	'''Class which contains all addon settings and xbmc state items of interest
 	'''
-	
+
 	def __init__(self):
 		'''Constructor
 		'''
 		self.rev = 0
 		self.__monitor = MyMonitor(self)
 		self.__player = xbmc.Player()
 		self.readSettings()
-		
+
 	def __del__(self):
 		'''Destructor
 		'''
 		del self.__monitor
 		del self.__player
-		
+
 	def readSettings(self):
 		'''(Re-)read all settings
 		'''
@@ -78,9 +78,13 @@ def readSettings(self):
 		self.port = int(addon.getSetting("hyperion_port"))
 		self.priority = int(addon.getSetting("hyperion_priority"))
 		self.timeout = int(addon.getSetting("reconnect_timeout"))
+		self.capture_width = int(addon.getSetting("capture_width"))
+		self.capture_height = int(addon.getSetting("capture_height"))
+		self.framerate = int(addon.getSetting("framerate"))
+
 		self.showErrorMessage = True
 		self.rev += 1
-		
+
 	def grabbing(self):
 		'''Check if we grabbing is requested based on the current state and settings
 		'''

resources/lib/state.py

@@ -1,6 +1,6 @@
 '''
     XBMC video capturer for Hyperion
-	
+
 	Copyright (c) 2013 Hyperion Team
 
 	Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,22 +27,19 @@
 from hyperion.Hyperion import Hyperion
 from misc import log
 from misc import notify
-X_SIZE = 300
-Y_SIZE = 300
-SLEEP_PER_FRAME = 30
 
 class DisconnectedState:
 	'''
 	Default state class when disconnected from the Hyperion server
 	'''
-	
+
 	def __init__(self, settings):
 		'''Constructor
 			- settings: Settings structure
 		'''
 		log("Entering disconnected state")
 		self.__settings = settings
-		
+
 	def execute(self):
 		'''Execute the state
 			- return: The new state to execute
@@ -51,7 +48,7 @@ def execute(self):
 		if not self.__settings.grabbing():
 			xbmc.sleep(500)
 			return self
-			
+
 		# we are enabled and want to advance to the connected state
 		try:
 			nextState = ConnectedState(self.__settings)
@@ -61,10 +58,10 @@ def execute(self):
 			if self.__settings.showErrorMessage:
 				notify(xbmcaddon.Addon().getLocalizedString(32100))
 				self.__settings.showErrorMessage = False
-				
+
 			# continue in the error state
 			return ErrorState(self.__settings)
-			
+
 class ConnectedState:
 	'''
 	State class when connected to Hyperion and grabbing video
@@ -82,14 +79,14 @@ def __init__(self, settings):
 		self.__captureState = None
 		self.__data = None
 		self.__useLegacyApi = True
-		
+
 		# try to connect to hyperion
 		self.__hyperion = Hyperion(self.__settings.address, self.__settings.port)
-		
+
 		# create the capture object
 		self.__capture = xbmc.RenderCapture()
-		self.__capture.capture(X_SIZE, Y_SIZE)
-		
+		self.__capture.capture(self.__settings.capture_width, self.__settings.capture_height)
+
 	def __del__(self):
 		'''Destructor
 		'''
@@ -98,7 +95,7 @@ def __del__(self):
 		del self.__captureState
 		del self.__data
 		del self.__useLegacyApi
-		
+
 	def execute(self):
 		'''Execute the state
 			- return: The new state to execute
@@ -107,7 +104,7 @@ def execute(self):
 		if not self.__settings.grabbing():
 			# return to the disconnected state
 			return DisconnectedState(self.__settings)
-		
+
 		# check the xbmc API Version
 		try:
 			self.__capture.getCaptureState()
@@ -129,51 +126,51 @@ def execute(self):
 		if startReadOut:
 			if self.__useLegacyApi:
 				self.__data = self.__capture.getImage()
-				
-			# retrieve image data and reformat into rgb format			
+
+			# retrieve image data and reformat into rgb format
 			if self.__capture.getImageFormat() == 'ARGB':
 				del self.__data[0::4]
 			elif self.__capture.getImageFormat() == 'BGRA':
 				del self.__data[3::4]
 				self.__data[0::3], self.__data[2::3] = self.__data[2::3], self.__data[0::3]
-				
+
 			try:
 				#send image to hyperion
 				self.__hyperion.sendImage(self.__capture.getWidth(), self.__capture.getHeight(), str(self.__data), self.__settings.priority, 500)
 			except Exception, e:
 				# unable to send image. notify and go to the error state
 				notify(xbmcaddon.Addon().getLocalizedString(32101))
 				return ErrorState(self.__settings)
-				
+
 		if self.__useLegacyApi:
 			if self.__captureState != xbmc.CAPTURE_STATE_WORKING:
 				#the current capture is processed or it has failed, we request a new one
-				self.__capture.capture(X_SIZE, Y_SIZE)
-				
-		#limit the maximum number of frames sent to hyperion		
-		xbmc.sleep(SLEEP_PER_FRAME)
-			
+				self.__capture.capture(self.__settings.capture_width, self.__settings.capture_height)
+
+		#limit the maximum number of frames sent to hyperion
+		xbmc.sleep( int(1. / self.__settings.framerate) * 1000 )
+
 		return self
-			
+
 class ErrorState:
 	'''
 	State class which is activated upon an error
 	'''
-	
+
 	def __init__(self, settings):
 		'''Constructor
 			- settings: Settings structure
 		'''
 		log("Entering error state")
 		self.__settings = settings
-		
+
 	def execute(self):
 		'''Execute the state
 			- return: The new state to execute
 		'''
 		# take note of the current revision of the settings
 		rev = self.__settings.rev
-		
+
 		#stay in error state for the specified timeout or until the settings have been changed
 		i = 0
 		while (i < self.__settings.timeout) and (rev == self.__settings.rev):
@@ -182,6 +179,6 @@ def execute(self):
 			else:
 				xbmc.sleep(1000)
 			i += 1
-		
+
 		# continue in the disconnected state
 		return DisconnectedState(self.__settings)

resources/settings.xml

@@ -7,5 +7,8 @@
 		<setting id="hyperion_port" type="number" label="32004" default="19445" />
 		<setting id="hyperion_priority" type="number" label="32005" default="900" />
 		<setting id="reconnect_timeout" type="number" label="32006" default="30" />
+		<setting id="capture_width" type="number" label="32008" default="64" />
+		<setting id="capture_height" type="number" label="32009" default="64" />
+		<setting id="framerate" type="number" label="32010" default="20" />
 	</category>
 </settings>