add tests for parsing certain xrandr output; fix crash when screen doesn't have an...

[lilass.git] / screen.py

diff --git a/screen.py b/screen.py
index b0c657737403be53b1a05ec7b4edef227b76f19c..f0de7e908c56acff748d3824065648f6ec9dcd14 100644 (file)
--- a/screen.py
+++ b/screen.py
@@ -18,7 +18,6 @@
 
 import re, subprocess
 from enum import Enum
 
 import re, subprocess
 from enum import Enum

-from fractions import Fraction

 
 ## utility functions
 
 
 ## utility functions
 


@@ -33,6 +32,14 @@ def processOutputGen(*args):
 def processOutputIt(*args):
     return list(processOutputGen(*args)) # list() iterates over the generator
 
 def processOutputIt(*args):
     return list(processOutputGen(*args)) # list() iterates over the generator
 

+# for auto-config: common names of internal connectors
+def commonInternalConnectorNames():
+    commonInternalConnectorPrefixes = ['LVDS', 'eDP']
+    commonInternalConnectorSuffices = ['', '0', '1', '-0', '-1']
+    for prefix in commonInternalConnectorPrefixes:
+        for suffix in commonInternalConnectorSuffices:
+            yield prefix+suffix
+

 ## the classes
 
 class RelativeScreenPosition(Enum):
 ## the classes
 
 class RelativeScreenPosition(Enum):


@@ -45,8 +52,10 @@ class RelativeScreenPosition(Enum):
     def __init__(self, text):
         # auto numbering
         cls = self.__class__
     def __init__(self, text):
         # auto numbering
         cls = self.__class__

-        self._value_ = len(cls.__members__)
+        self._value_ = len(cls.__members__) + 1

         self.text = text
         self.text = text

+    def __str__(self):
+        return self.text

 
 class Resolution:
     '''Represents a resolution of a screen'''
 
 class Resolution:
     '''Represents a resolution of a screen'''


@@ -54,6 +63,24 @@ class Resolution:
         self.width = width
         self.height = height
     
         self.width = width
         self.height = height
     

+    @classmethod
+    def fromDatabase(cls, dbstr):
+        if dbstr is None:
+            return None
+        parts = dbstr.split("x")
+        if len(parts) != 2:
+            raise ValueError(xrandrstr)
+        return Resolution(*map(int,parts))
+    
+    def forDatabase(self):
+        return str(self.width)+'x'+str(self.height)
+    
+    def forXrandr(self):
+        return self.forDatabase()
+    
+    def toTuple(self):
+        return (self.width, self.height)
+    

     def __eq__(self, other):
         if not isinstance(other, Resolution):
             return False
     def __eq__(self, other):
         if not isinstance(other, Resolution):
             return False


@@ -67,8 +94,15 @@ class Resolution:
     
     def __str__(self):
         # get ratio
     
     def __str__(self):
         # get ratio

-        ratio = Fraction(self.width, self.height) # automatically divides by the gcd
-        strRatio = "%d:%d" % (ratio.numerator, ratio.denominator)
+        ratio = int(round(16.0*self.height/self.width))
+        if ratio == 11: # 16:10.66 = 3:2
+            strRatio = "3:2"
+        elif ratio == 12: # 16:12 = 4:3
+            strRatio = '4:3'
+        elif ratio == 13: # 16:12.8 = 5:4
+            strRatio = '5:4'
+        else: # let's just hope this will never be 14 or more...
+            strRatio = '16:%d' % ratio

         return '%dx%d (%s)' %(self.width, self.height, strRatio)
     
     def __repr__(self):
         return '%dx%d (%s)' %(self.width, self.height, strRatio)
     
     def __repr__(self):


@@ -76,9 +110,6 @@ class Resolution:
     
     def pixelCount(self):
         return self.width * self.height
     
     def pixelCount(self):
         return self.width * self.height

-    
-    def forXrandr(self):
-        return str(self.width)+'x'+str(self.height)

 
 
 class ScreenSetup:
 
 
 class ScreenSetup:


@@ -119,13 +150,22 @@ class ScreenSetup:
                 RelativeScreenPosition.MIRROR: '--same-as',
             }[self.relPosition], intName]
         return args
                 RelativeScreenPosition.MIRROR: '--same-as',
             }[self.relPosition], intName]
         return args

+    
+    def __str__(self):
+        if self.intResolution is None:
+            return "External display only, at "+str(self.extResolution)
+        if self.extResolution is None:
+            return "Internal display only, at "+str(self.intResolution)
+        return "External display %s at %s %s internal display %s at %s" % ("(primary)" if self.extIsPrimary else "", str(self.extResolution), str(self.relPosition), "" if self.extIsPrimary else "(primary)", str(self.intResolution))

 
 class Connector:
     def __init__(self, name=None):
         self.name = name # connector name, e.g. "HDMI1"
 
 class Connector:
     def __init__(self, name=None):
         self.name = name # connector name, e.g. "HDMI1"

-        self.edid = None # EDID string for the connector, or None if disconnected
-        self._resolutions = set() # list of Resolution objects, empty if disconnected
-        self.preferredResolution = None
+        self.edid = None # EDID string for the connector, or None if disconnected / unavailable
+        self._resolutions = set() # set of Resolution objects, empty if disconnected
+        self._preferredResolution = None
+        self.previousResolution = None
+        self.hasLastResolution = False

     
     def __str__(self):
         return str(self.name)
     
     def __str__(self):
         return str(self.name)


@@ -134,8 +174,8 @@ class Connector:
         return """<Connector "%s" EDID="%s" resolutions="%s">""" % (str(self.name), str(self.edid), ", ".join(str(r) for r in self.getResolutionList()))
     
     def isConnected(self):
         return """<Connector "%s" EDID="%s" resolutions="%s">""" % (str(self.name), str(self.edid), ", ".join(str(r) for r in self.getResolutionList()))
     
     def isConnected(self):

-        assert (self.edid is None) == (len(self._resolutions)==0)
-        return self.edid is not None
+        # It is very possible not to have an EDID even for a connected connector
+        return len(self._resolutions) > 0

     
     def addResolution(self, resolution):
         assert isinstance(resolution, Resolution)
     
     def addResolution(self, resolution):
         assert isinstance(resolution, Resolution)


@@ -147,23 +187,31 @@ class Connector:
         else:
             self.edid += s
     
         else:
             self.edid += s
     

+    def setPreferredResolution(self, resolution):
+        assert isinstance(resolution, Resolution) and resolution in self._resolutions
+        self._preferredResolution = resolution
+    
+    def getPreferredResolution(self):
+        if self._preferredResolution is not None:
+            return self._preferredResolution
+        return self.getResolutionList()[0] # prefer the largest resolution
+    

     def getResolutionList(self):
     def getResolutionList(self):

-        return sorted(self._resolutions, key=lambda r: (0 if r==self.preferredResolution else 1, -r.pixelCount()))
+        return sorted(self._resolutions, key=lambda r: -r.pixelCount())

 
 class ScreenSituation:
 
 class ScreenSituation:

-    connectors = [] # contains all the Connector objects
+    connectors = None # contains all the Connector objects

     internalConnector = None # the internal Connector object (will be an enabled one)
     externalConnector = None # the used external Connector object (an enabled one), or None
     internalConnector = None # the internal Connector object (will be an enabled one)
     externalConnector = None # the used external Connector object (an enabled one), or None

+    previousSetup = None # None or the ScreenSetup used the last time this external screen was connected

     
     '''Represents the "screen situation" a machine can be in: Which connectors exist, which resolutions do they have, what are the names for the internal and external screen'''
     
     '''Represents the "screen situation" a machine can be in: Which connectors exist, which resolutions do they have, what are the names for the internal and external screen'''

-    def __init__(self, internalConnectorNames, externalConnectorNames = None):
+    def __init__(self, internalConnectorNames, externalConnectorNames = None, xrandrSource = None):

         '''Both arguments are lists of connector names. The first one which exists and has a screen attached is chosen for that class. <externalConnectorNames> can be None to
            just choose any remaining connector.'''
         # which connectors are there?
         '''Both arguments are lists of connector names. The first one which exists and has a screen attached is chosen for that class. <externalConnectorNames> can be None to
            just choose any remaining connector.'''
         # which connectors are there?

-        self._getXrandrInformation()
-        for c in self.connectors:
-            print(repr(c))
-            print()
+        self.connectors = []
+        self._getXrandrInformation(xrandrSource)

         # figure out which is the internal connector
         self.internalConnector = self._findAvailableConnector(internalConnectorNames)
         if self.internalConnector is None:
         # figure out which is the internal connector
         self.internalConnector = self._findAvailableConnector(internalConnectorNames)
         if self.internalConnector is None:


@@ -179,10 +227,12 @@ class ScreenSituation:
         print("Detected external connector:",self.externalConnector)
     
     # Run xrandr and fill the dict of connector names mapped to lists of available resolutions.
         print("Detected external connector:",self.externalConnector)
     
     # Run xrandr and fill the dict of connector names mapped to lists of available resolutions.

-    def _getXrandrInformation(self):
+    def _getXrandrInformation(self, xrandrSource = None):

         connector = None # current connector
         readingEdid = False
         connector = None # current connector
         readingEdid = False

-        for line in processOutputGen("xrandr", "-q", "--verbose"):
+        if xrandrSource is None:
+            xrandrSource = processOutputGen("xrandr", "-q", "--verbose")
+        for line in xrandrSource:

             if readingEdid:
                 m = re.match(r'^\s*([0-9a-f]+)\s*$', line)
                 if m is not None:
             if readingEdid:
                 m = re.match(r'^\s*([0-9a-f]+)\s*$', line)
                 if m is not None:


@@ -200,8 +250,10 @@ class ScreenSituation:
             m = re.search(r'^([\w\-]+) (dis)?connected ', line)
             if m is not None:
                 connector = Connector(m.group(1))
             m = re.search(r'^([\w\-]+) (dis)?connected ', line)
             if m is not None:
                 connector = Connector(m.group(1))

-                assert not any(c.name == connector.name for c in self.connectors)
-                self.connectors.append(connector)
+                assert not any(c.name == connector.name for c in self.connectors), "Duplicate connector {}".format(connector.name)
+                if not connector.name.startswith("VIRTUAL"):
+                    # skip "VIRTUAL" connectors
+                    self.connectors.append(connector)

                 continue
             # new resolution?
             m = re.search(r'^\s*([\d]+)x([\d]+)', line)
                 continue
             # new resolution?
             m = re.search(r'^\s*([\d]+)x([\d]+)', line)


@@ -209,8 +261,8 @@ class ScreenSituation:
                 resolution = Resolution(int(m.group(1)), int(m.group(2)))
                 assert connector is not None
                 connector.addResolution(resolution)
                 resolution = Resolution(int(m.group(1)), int(m.group(2)))
                 assert connector is not None
                 connector.addResolution(resolution)

-                if '+preferred' in line:
-                    connector.preferredResolution = resolution
+                if re.search(r' [+]preferred\b', line):
+                    connector.setPreferredResolution(resolution)

                 continue
             # EDID?
             m = re.search(r'^\s*EDID:\s*$', line)
                 continue
             # EDID?
             m = re.search(r'^\s*EDID:\s*$', line)


@@ -218,8 +270,7 @@ class ScreenSituation:
                 readingEdid = True
                 continue
             # unknown line
                 readingEdid = True
                 continue
             # unknown line

-            # not fatal, e.g. xrandr shows strange stuff when a display is enabled, but not connected
-            #print("Warning: Unknown xrandr line %s" % line)
+            # not fatal, e.g. xrandr shows strange stuff when a display is enabled, but not connected; --verbose adds a whole lot of other weird stuff

     
     # return the first available connector from those listed in <tryConnectorNames>, skipping disabled connectors
     def _findAvailableConnector(self, tryConnectorNames):
     
     # return the first available connector from those listed in <tryConnectorNames>, skipping disabled connectors
     def _findAvailableConnector(self, tryConnectorNames):


@@ -227,21 +278,11 @@ class ScreenSituation:
             return c
         return None
     
             return c
         return None
     

-    # return available internal resolutions
-    def internalResolutions(self):
-        return self.internalConnector.getResolutionList()
-    
-    # return available external resolutions (or None, if there is no external screen connected)
-    def externalResolutions(self):
-        if self.externalConnector is None:
-            return None
-        return self.externalConnector.getResolutionList()
-    

     # return resolutions available for both internal and external screen
     def commonResolutions(self):
     # return resolutions available for both internal and external screen
     def commonResolutions(self):

-        internalRes = self.internalResolutions()
-        externalRes = self.externalResolutions()
-        assert externalRes is not None
+        assert self.externalConnector is not None, "Common resolutions may only be queried if there is an external screen connected."
+        internalRes = self.internalConnector.getResolutionList()
+        externalRes = self.externalConnector.getResolutionList()

         return sorted(set(externalRes).intersection(internalRes), key=lambda r: -r.pixelCount())
     
     # compute the xrandr call
         return sorted(set(externalRes).intersection(internalRes), key=lambda r: -r.pixelCount())
     
     # compute the xrandr call


@@ -262,3 +303,17 @@ class ScreenSituation:
             call += ["--output", name] + connectorArgs[name]
         return call
 
             call += ["--output", name] + connectorArgs[name]
         return call
 

+    def fetchDBInfo(self, db):
+        if self.externalConnector and self.externalConnector.edid:
+            self.previousSetup = db.getConfig(self.externalConnector.edid) # may also return None
+        else:
+            self.previousSetup = None
+        if self.previousSetup:
+            print("Known screen, previous setup:", self.previousSetup)
+            self.externalConnector.previousResolution = self.previousSetup.extResolution
+            self.internalConnector.previousResolution = self.previousSetup.intResolution
+    
+    def putDBInfo(self, db, setup):
+        if not self.externalConnector or not self.externalConnector.edid:
+            return
+        db.putConfig(self.externalConnector.edid, setup)