[TerrestrialBouquet] add plugin

configure.ac

@@ -678,6 +678,7 @@ lib/python/Plugins/SystemPlugins/SatelliteEquipmentControl/Makefile
 lib/python/Plugins/SystemPlugins/SatelliteEquipmentControl/meta/Makefile
 lib/python/Plugins/SystemPlugins/Satfinder/Makefile
 lib/python/Plugins/SystemPlugins/Satfinder/meta/Makefile
+lib/python/Plugins/SystemPlugins/TerrestrialBouquet/Makefile
 lib/python/Plugins/SystemPlugins/VideoClippingSetup/Makefile
 lib/python/Plugins/SystemPlugins/VideoEnhancement/Makefile
 lib/python/Plugins/SystemPlugins/VideoEnhancement/meta/Makefile

lib/python/Plugins/SystemPlugins/Makefile.am

@@ -3,7 +3,7 @@ installdir = $(pkglibdir)/python/Plugins/SystemPlugins
 SUBDIRS = PositionerSetup Satfinder \
 	VideoTune Hotplug OpentvZapper \
 	DefaultServicesScanner CommonInterfaceAssignment \
-	VideoClippingSetup \
+	VideoClippingSetup TerrestrialBouquet \
 	VideoEnhancement WirelessLan NetworkWizard ViX \
 	SABnzbdSetup FastScan SatelliteEquipmentControl DiseqcTester
 

lib/python/Plugins/SystemPlugins/TerrestrialBouquet/Makefile.am

@@ -0,0 +1,3 @@
+installdir = $(pkglibdir)/python/Plugins/SystemPlugins/TerrestrialBouquet
+
+install_PYTHON = *.py

lib/python/Plugins/SystemPlugins/TerrestrialBouquet/plugin.py

@@ -0,0 +1,197 @@
+from enigma import eDVBDB
+from Components.config import config, ConfigSubsection, ConfigYesNo, ConfigSelection
+from Plugins.Plugin import PluginDescriptor
+from Screens.MessageBox import MessageBox
+from Screens.Setup import Setup
+from Tools.BoundFunction import boundFunction
+from ServiceReference import ServiceReference
+from .providers import providers
+
+MODE_TV = 1
+MODE_RADIO = 2
+
+choices = [(k, providers[k].get("name", _("Other"))) for k in providers.keys()]
+config.plugins.terrestrialbouquet = ConfigSubsection()
+config.plugins.terrestrialbouquet.enabled = ConfigYesNo()
+config.plugins.terrestrialbouquet.providers = ConfigSelection(default=choices[0][0], choices=choices)
+config.plugins.terrestrialbouquet.makeradiobouquet = ConfigYesNo()
+config.plugins.terrestrialbouquet.skipduplicates = ConfigYesNo(True)
+
+class TerrestrialBouquet:
+	def __init__(self):
+		self.config = config.plugins.terrestrialbouquet
+		self.path = "/etc/enigma2"
+		self.lcndb = self.path + "/lcndb"
+		self.bouquetsIndexFilename = "bouquets.tv"
+		self.bouquetFilename = "userbouquet.TerrestrialBouquet.tv"
+		self.bouquetName = _('Terrestrial')
+		self.services = {}
+		self.VIDEO_ALLOWED_TYPES = [1, 17, 22, 25, 31, 32] + [4, 5, 24, 27]  # tv (live and NVOD)
+		self.AUDIO_ALLOWED_TYPES = [2, 10]
+
+	def getTerrestrials(self, mode):
+		terrestrials = {}
+		query = "1:7:%s:0:0:0:0:0:0:0:%s ORDER BY name" % (mode, " || ".join(["(type == %s)" % i for i in self.getAllowedTypes(mode)]))
+		if (servicelist := ServiceReference.list(ServiceReference(query))) is not None:
+			while (service := servicelist.getNext()) and service.valid():
+				if service.getUnsignedData(4) >> 16 == 0xeeee:  # filter (only terrestrial)
+					stype, sid, tsid, onid, ns = [int(x, 16) for x in service.toString().split(":",7)[2:7]]
+					name = ServiceReference.getServiceName(service)
+					terrestrials["%04x:%04x:%04x" % (onid, tsid, sid)] = {"name": name, "namespace": ns, "onid": onid, "tsid": tsid, "sid": sid, "type": stype}
+		return terrestrials
+
+	def getAllowedTypes(self, mode):
+		return self.VIDEO_ALLOWED_TYPES if mode == MODE_TV else self.AUDIO_ALLOWED_TYPES  # tv (live and NVOD) and radio allowed service types
+
+	def readLcnDb(self):
+		try:  # may not exist
+			f = open(self.lcndb)
+		except Exception as e:
+			return {}
+		LCNs = {}
+		for line in f:
+			line = line and line.strip().lower()
+			if line and len(line) == 38 and line.startswith("eeee"):
+				lcn, signal = tuple([int(x) for x in line[24:].split(":", 1)])
+				key = line[9:23]
+				LCNs[key] = {"lcn": lcn, "signal": signal}
+		return {k:v for k,v in sorted(list(LCNs.items()), key=lambda x: (x[1]["lcn"], abs(x[1]["signal"] - 65535)))}
+
+	def rebuild(self):
+		if not self.config.enabled.value:
+			return _("TerrestrialBouquet plugin is not enabled.")
+		msg = _("Try running a manual scan of terrestrial frequencies. If this fails maybe there is no lcn data available in your area.") 
+		self.services.clear()
+		if not (LCNs := self.readLcnDb()):
+			return self.lcndb + _("empty or missing.") + " " +  msg
+		for mode in (MODE_TV, MODE_RADIO):
+			terrestrials = self.getTerrestrials(mode)
+			for k in terrestrials:
+				if k in LCNs:
+					terrestrials[k] |= LCNs[k]
+			self.services |= terrestrials
+		self.services = {k:v for k,v in sorted(list(self.services.items()),key=lambda x: ("lcn" in x[1] and x[1]["lcn"] or 65535, "signal" in x[1] and abs(x[1]["signal"]-65536) or 65535))}
+		LCNsUsed = []  # duplicates (we are already ordered by highest signal strength)
+		for k in list(self.services.keys()):  # use list to avoid RuntimeError: dictionary changed size during iteration
+			if not "lcn" in self.services[k] or self.services[k]["lcn"] in LCNsUsed:
+				if self.config.skipduplicates.value:
+					del self.services[k]
+				else:
+					self.services[k]["duplicate"] = True
+			else:
+				LCNsUsed.append(self.services[k]["lcn"])
+		if not self.services:
+			return _("No corresponding terrestrial services found.") + " " +  msg
+		self.createBouquet()
+
+	def readBouquetIndex(self, mode):
+		try:  # may not exist
+			return open(self.path + "/%s%s" % (self.bouquetsIndexFilename[:-2], "tv" if mode == MODE_TV else "radio"), "r").read()
+		except Exception as e:
+			return ""
+
+	def writeBouquetIndex(self, bouquetIndexContent, mode):
+		bouquets_index_list = []
+		bouquets_index_list.append("#NAME Bouquets (%s)\n" % ("TV" if mode == MODE_TV else "Radio"))
+		bouquets_index_list.append("#SERVICE 1:7:1:0:0:0:0:0:0:0:FROM BOUQUET \"%s%s\" ORDER BY bouquet\n" % (self.bouquetFilename[:-2], "tv" if mode == MODE_TV else "radio"))
+		if bouquetIndexContent:
+			lines = bouquetIndexContent.split("\n", 1)
+			if lines[0][:6] != "#NAME ":
+				bouquets_index_list.append("%s\n" % lines[0])
+			if len(lines) > 1:
+				bouquets_index_list.append("%s" % lines[1])
+		bouquets_index = open(self.path + "/" + self.bouquetsIndexFilename[:-2] + ("tv" if mode == MODE_TV else "radio"), "w")
+		bouquets_index.write(''.join(bouquets_index_list))
+		bouquets_index.close()
+
+	def writeBouquet(self, mode):
+		allowed_service_types = not self.config.makeradiobouquet.value and self.VIDEO_ALLOWED_TYPES + self.AUDIO_ALLOWED_TYPES or self.getAllowedTypes(mode)
+		lcnindex = {v["lcn"]:k for k,v in self.services.items() if not v.get("duplicate") and v.get("lcn") and v.get("type") in allowed_service_types}
+		highestLCN = max(list(lcnindex.keys()))
+		duplicates = {} if self.config.skipduplicates.value else {i + 1 + highestLCN: v for i, v in enumerate(sorted([v for v in self.services.values() if v.get("duplicate") and v.get("type") in allowed_service_types], key=lambda x: x["name"].lower()))}
+		sections = providers[self.config.providers.value].get("sections", {})
+		active_sections = [max((x for x in list(sections.keys()) if int(x) <= key)) for key in list(lcnindex.keys())] if sections else []
+		bouquet_list = []
+		bouquet_list.append("#NAME %s\n" % self.bouquetName)
+		for number in range(1, (highestLCN + len(duplicates)) // 1000 * 1000 + 1001):   # ceil bouquet length to nearest 1000, range needs + 1
+			if number in active_sections:
+				bouquet_list.append(self.bouquetMarker(sections[number]))
+			if number in lcnindex:
+				bouquet_list.append(self.bouquetServiceLine(self.services[lcnindex[number]]))
+				if number == highestLCN and duplicates:
+					bouquet_list.append(self.bouquetMarker(_("Duplicates")))
+			elif number in duplicates:
+				bouquet_list.append(self.bouquetServiceLine(duplicates[number]))
+			else:
+				bouquet_list.append("#SERVICE 1:320:0:0:0:0:0:0:0:0:\n")  # bouquet spacer
+		bouquetFile = open(self.path + "/" + self.bouquetFilename[:-2] + ("tv" if mode == MODE_TV else "radio"), "w")
+		bouquetFile.write(''.join(bouquet_list))
+		bouquetFile.close()
+
+	def bouquetServiceLine(self, service):
+		return "#SERVICE 1:0:%x:%x:%x:%x:%x:0:0:0:\n" % (service["type"], service["sid"], service["tsid"], service["onid"], service["namespace"])
+
+	def bouquetMarker(self, text):
+		return "#SERVICE 1:64:0:0:0:0:0:0:0:0:\n#DESCRIPTION %s\n" % text
+
+	def createBouquet(self):
+		radio_services = [x for x in self.services.values() if x["type"] in self.AUDIO_ALLOWED_TYPES and "lcn" in x]
+		for mode in (MODE_TV, MODE_RADIO):
+			if mode == MODE_RADIO and (not radio_services or not self.config.makeradiobouquet.value):
+				break
+			bouquetIndexContent = self.readBouquetIndex(mode)
+			if '"' + self.bouquetFilename[:-2] + ("tv" if mode == MODE_TV else "radio") + '"' not in bouquetIndexContent: # only edit the index if bouquet file is not present
+				self.writeBouquetIndex(bouquetIndexContent, mode)
+			self.writeBouquet(mode)
+		eDVBDB.getInstance().reloadBouquets()
+
+
+class PluginSetup(Setup, TerrestrialBouquet):
+	def __init__(self, session):
+		TerrestrialBouquet.__init__(self)
+		Setup.__init__(self, session, blue_button={'function': self.startrebuild, 'helptext': _("Build/rebuild terrestrial bouquet now based on the last scan.")})
+		self.title = _("TerrestrialBouquet setup")
+		self.updatebluetext()
+
+	def createSetup(self):
+		configlist = []
+		indent = "- "
+		configlist.append((_("Enable terrestrial bouquet"), self.config.enabled, _("Enable creating a terrestrial bouquet based on LCN (logocal channel number) data.") + " " + _("This plugin depends on LCN data being broadcast by your local tansmitter.") + " " + _("Once configured the bouquet will be updated automatically when doing a manual scan.")))
+		if self.config.enabled.value:
+			configlist.append((indent + _("Region"), self.config.providers, _("Select your region.")))
+			configlist.append((indent + _("Create separate radio bouquet"), self.config.makeradiobouquet, _("Put radio services in a separate bouquet, not the main tv bouquet. This is required when the provider duplicates channel numbers for tv and radio.")))
+			configlist.append((indent + _("Skip duplicates"), self.config.skipduplicates, _("Do not add duplicated or non indexed channels to the bouquet.")))
+		self["config"].list = configlist
+
+	def changedEntry(self):
+		Setup.changedEntry(self)
+		self.updatebluetext()
+
+	def updatebluetext(self):
+		self["key_blue"].text = _("Rebuild bouquet") if self.config.enabled.value else ""
+
+	def startrebuild(self):
+		if self.config.enabled.value:
+			self.saveAll()
+			if msg := self.rebuild():
+				mb = self.session.open(MessageBox, msg, MessageBox.TYPE_ERROR)
+				mb.setTitle(_("TerrestrialBouquet Error"))
+			else:
+				mb = self.session.open(MessageBox, _("Terrestrial bouquet successfully rebuilt."), MessageBox.TYPE_INFO)
+				mb.setTitle(_("TerrestrialBouquet"))
+				self.closeRecursive()
+
+
+def PluginCallback(close, answer):
+	if close and answer:
+		close(True)
+
+def PluginMain(session, close=None, **kwargs):
+	session.openWithCallback(boundFunction(PluginCallback, close), PluginSetup)
+
+def PluginStart(menuid, **kwargs):
+	return menuid == "scan" and [(_("TerrestrialBouquet"), PluginMain, "PluginMain", 1)] or []
+
+def Plugins(**kwargs):
+	from Components.NimManager import nimmanager
+	return [PluginDescriptor(name=_("TerrestrialBouquet"), description=_("Create an ordered bouquet of terrestrial services based on LCN data from your local transmitter."), where=PluginDescriptor.WHERE_MENU, needsRestart=False, fnc=PluginStart),] if nimmanager.hasNimType("DVB-T") else []

lib/python/Plugins/SystemPlugins/TerrestrialBouquet/providers.py

@@ -0,0 +1,12 @@
+providers = {
+	"other":{},
+	"uk": {
+		"name": _("UK"),
+		"sections": {
+			1: _("Entertainment"),
+			100: _("High Definition"),
+			201: _("Children"),
+			230: _("News"),
+			260: _("BBC Interactive"),
+			670: _("Adult"),
+			700: _("Radio"),}}}

lib/python/Screens/ServiceScan.py

@@ -11,6 +11,7 @@
 from Components.config import config
 from Components.PluginComponent import plugins
 from Plugins.Plugin import PluginDescriptor
+from Tools.Directories import isPluginInstalled
 
 
 class ServiceScanSummary(Screen):
@@ -39,6 +40,12 @@ class ServiceScan(Screen):
 
 	def ok(self):
 		if self["scan"].isDone():
+			if "Terrestrial" in str(self.scanList) and isPluginInstalled("TerrestrialBouquet"):
+				try:
+					from Plugins.SystemPlugins.TerrestrialBouquet.plugin import TerrestrialBouquet
+					print("[ServiceScan] rebuilding terrestrial bouquet", TerrestrialBouquet().rebuild() or "was successful")
+				except Exception as e:
+					print(e)
 			if self.currentInfobar.__class__.__name__ == "InfoBar":
 				selectedService = self["servicelist"].getCurrentSelection()
 				if selectedService and self.currentServiceList is not None: