9942e9838296e9a8eecef3d0b8c9475b81d19f8f
[lilass.git] / screen.py
1 #!/usr/bin/python3
2 # DSL - easy Display Setup for Laptops
3 # Copyright (C) 2012-2015 Ralf Jung <post@ralfj.de>
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
19 import re, subprocess
20 from enum import Enum
21
22 ## utility functions
23
24 # execute a process, return output as iterator, throw exception if there was an error
25 # you *must* iterate to the end if you use this!
26 def processOutputGen(*args):
27     with subprocess.Popen(args, stdout=subprocess.PIPE) as p:
28         for line in p.stdout:
29             yield line.decode("utf-8")
30     if p.returncode != 0:
31         raise Exception("Error executing "+str(args))
32 def processOutputIt(*args):
33     return list(processOutputGen(*args)) # list() iterates over the generator
34
35 ## the classes
36
37 class RelativeScreenPosition(Enum):
38     '''Represents the relative position of the external screen to the internal one'''
39     LEFT      = ("left of")
40     RIGHT     = ("right of")
41     ABOVE     = ("above")
42     BELOW     = ("below")
43     MIRROR    = ("same as")
44     def __init__(self, text):
45         # auto numbering
46         cls = self.__class__
47         self._value_ = len(cls.__members__)
48         self.text = text
49
50 class Resolution:
51     '''Represents a resolution of a screen'''
52     def __init__(self, width, height):
53         self.width = width
54         self.height = height
55     
56     def __eq__(self, other):
57         if not isinstance(other, Resolution):
58             return False
59         return self.width == other.width and self.height == other.height
60     
61     def __ne__(self, other):
62         return not self.__eq__(other)
63     
64     def __hash__(self):
65         return hash(("Resolution",self.width,self.height))
66     
67     def __str__(self):
68         # get ratio
69         ratio = int(round(16.0*self.height/self.width))
70         if ratio == 12: # 16:12 = 4:3
71             strRatio = '4:3'
72         elif ratio == 13: # 16:12.8 = 5:4
73             strRatio = '5:4'
74         else: # let's just hope this will never be 14 or more...
75             strRatio = '16:%d' % ratio
76         return '%dx%d (%s)' %(self.width, self.height, strRatio)
77     
78     def __repr__(self):
79         return 'screen.Resolution('+self.forXrandr()+')'
80     
81     def pixelCount(self):
82         return self.width * self.height
83     
84     def forXrandr(self):
85         return str(self.width)+'x'+str(self.height)
86
87
88 class ScreenSetup:
89     '''Represents a screen configuration (relative to some notion of an "internal" and an "external" screen): Which screens are enabled with which resolution, how
90        are they positioned, which is the primary screen.'''
91     def __init__(self, intResolution, extResolution, relPosition = None, extIsPrimary = True):
92         '''The resolutions can be None to disable the screen, instances of Resolution. The last two arguments only matter if both screens are enabled.'''
93         assert intResolution is None or isinstance(intResolution, Resolution)
94         assert extResolution is None or isinstance(extResolution, Resolution)
95         
96         self.intResolution = intResolution
97         self.extResolution = extResolution
98         self.relPosition = relPosition
99         self.extIsPrimary = extIsPrimary or self.intResolution is None # external is always primary if it is the only one
100     
101     def getInternalArgs(self):
102         if self.intResolution is None:
103             return ["--off"]
104         args = ["--mode", self.intResolution.forXrandr()] # set internal screen to desired resolution
105         if not self.extIsPrimary:
106             args.append('--primary')
107         return args
108     
109     def getExternalArgs(self, intName):
110         if self.extResolution is None:
111             return ["--off"]
112         args = ["--mode", self.extResolution.forXrandr()] # set external screen to desired resolution
113         if self.extIsPrimary:
114             args.append('--primary')
115         if self.intResolution is None:
116             return args
117         # set position
118         args += [{
119                 RelativeScreenPosition.LEFT  : '--left-of',
120                 RelativeScreenPosition.RIGHT : '--right-of',
121                 RelativeScreenPosition.ABOVE : '--above',
122                 RelativeScreenPosition.BELOW : '--below',
123                 RelativeScreenPosition.MIRROR: '--same-as',
124             }[self.relPosition], intName]
125         return args
126
127 class Connector:
128     def __init__(self, name=None):
129         self.name = name         # connector name, e.g. "HDMI1"
130         self.edid = None         # EDID string for the connector, or None if disconnected
131         self.resolutions = set() # list of Resolution objects, empty if disconnected
132     
133     def __str__(self):
134         return str(self.name)
135     
136     def __repr__(self):
137         return """<Connector "%s" EDID="%s" resolutions="%s">""" % (str(self.name), str(self.edid), ", ".join(str(r) for r in self.resolutions))
138     
139     def isConnected(self):
140         assert (self.edid is None) == (len(self.resolutions)==0)
141         return self.edid is not None
142     
143     def addResolution(self, resolution):
144         assert isinstance(resolution, Resolution)
145         self.resolutions.add(resolution)
146     
147     def appendToEdid(self, s):
148         if self.edid is None:
149             self.edid = s
150         else:
151             self.edid += s
152
153 class ScreenSituation:
154     connectors = [] # contains all the Connector objects
155     internalConnector = None # the internal Connector object (will be an enabled one)
156     externalConnector = None # the used external Connector object (an enabled one), or None
157     
158     '''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'''
159     def __init__(self, internalConnectorNames, externalConnectorNames = None):
160         '''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
161            just choose any remaining connector.'''
162         # which connectors are there?
163         self._getXrandrInformation()
164         for c in self.connectors:
165             print(repr(c))
166             print()
167         # figure out which is the internal connector
168         self.internalConnector = self._findAvailableConnector(internalConnectorNames)
169         if self.internalConnector is None:
170             raise Exception("Could not automatically find internal connector, please use (or fix) ~/.dsl.conf to specify it manually.")
171         print("Detected internal connector:",self.internalConnector)
172         # and the external one
173         if externalConnectorNames is None:
174             externalConnectorNames = map(lambda c: c.name, self.connectors)
175             externalConnectorNames = set(filter(lambda name: name != self.internalConnector.name, externalConnectorNames))
176         self.externalConnector = self._findAvailableConnector(externalConnectorNames)
177         if self.internalConnector == self.externalConnector:
178             raise Exception("Internal and external connector are the same. This must not happen. Please fix ~/.dsl.conf.");
179         print("Detected external connector:",self.externalConnector)
180     
181     # Run xrandr and fill the dict of connector names mapped to lists of available resolutions.
182     def _getXrandrInformation(self):
183         connector = None # current connector
184         readingEdid = False
185         for line in processOutputGen("xrandr", "-q", "--verbose"):
186             if readingEdid:
187                 m = re.match(r'^\s*([0-9a-f]+)\s*$', line)
188                 if m is not None:
189                     connector.appendToEdid(m.group(1))
190                     continue
191                 else:
192                     readingEdid = False
193                     # fallthrough to the rest of the loop for parsing of this line
194             # screen?
195             m = re.search(r'^Screen [0-9]+: ', line)
196             if m is not None: # ignore this line
197                 connector = None
198                 continue
199             # new connector?
200             m = re.search(r'^([\w\-]+) (dis)?connected ', line)
201             if m is not None:
202                 connector = Connector(m.group(1))
203                 assert not any(c.name == connector.name for c in self.connectors)
204                 self.connectors.append(connector)
205                 continue
206             # new resolution?
207             m = re.search(r'^\s*([\d]+)x([\d]+)', line)
208             if m is not None:
209                 resolution = Resolution(int(m.group(1)), int(m.group(2)))
210                 assert connector is not None
211                 connector.addResolution(resolution)
212                 continue
213             # EDID?
214             m = re.search(r'^\s*EDID:\s*$', line)
215             if m is not None:
216                 readingEdid = True
217                 continue
218             # unknown line
219             # not fatal, e.g. xrandr shows strange stuff when a display is enabled, but not connected
220             #print("Warning: Unknown xrandr line %s" % line)
221     
222     # return the first available connector from those listed in <tryConnectorNames>, skipping disabled connectors
223     def _findAvailableConnector(self, tryConnectorNames):
224         for c in filter(lambda c: c.name in tryConnectorNames and c.isConnected(), self.connectors):
225             return c
226         return None
227     
228     # return available internal resolutions
229     def internalResolutions(self):
230         return self.internalConnector.resolutions
231     
232     # return available external resolutions (or None, if there is no external screen connected)
233     def externalResolutions(self):
234         if self.externalConnector is None:
235             return None
236         return self.externalConnector.resolutions
237     
238     # return resolutions available for both internal and external screen
239     def commonResolutions(self):
240         internalRes = self.internalResolutions()
241         externalRes = self.externalResolutions()
242         assert externalRes is not None
243         return sorted(set(externalRes).intersection(internalRes), key=lambda r: -r.pixelCount())
244     
245     # compute the xrandr call
246     def forXrandr(self, setup):
247         # turn all screens off
248         connectorArgs = {} # maps connector names to xrand arguments
249         for c in self.connectors:
250             connectorArgs[c.name] = ["--off"]
251         # set arguments for the relevant ones
252         connectorArgs[self.internalConnector.name] = setup.getInternalArgs()
253         if self.externalConnector is not None:
254             connectorArgs[self.externalConnector.name] = setup.getExternalArgs(self.internalConnector.name)
255         else:
256             assert setup.extResolution is None, "There's no external screen to set a resolution for"
257         # now compose the arguments
258         call = ["xrandr"]
259         for name in connectorArgs:
260             call += ["--output", name] + connectorArgs[name]
261         return call
262