5 # Copyright (c) 2015, Phillip Berndt
7 # Autorandr rewrite in Python
9 # This script aims to be fully compatible with the original autorandr.
11 # This program is free software: you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation, either version 3 of the License, or
14 # (at your option) any later version.
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 from __future__ import print_function
35 from distutils.version import LooseVersion as Version
37 from itertools import chain
38 from collections import OrderedDict
41 # (name, description, callback)
42 ("common", "Clone all connected outputs at the largest common resolution", None),
43 ("horizontal", "Stack all connected outputs horizontally at their largest resolution", None),
44 ("vertical", "Stack all connected outputs vertically at their largest resolution", None),
48 Usage: autorandr [options]
50 -h, --help get this small help
51 -c, --change reload current setup
52 -s, --save <profile> save your current setup to profile <profile>
53 -l, --load <profile> load profile <profile>
54 -d, --default <profile> make profile <profile> the default profile
55 --force force (re)loading of a profile
56 --fingerprint fingerprint your current hardware setup
57 --config dump your current xrandr setup
58 --dry-run don't change anything, only print the xrandr commands
60 To prevent a profile from being loaded, place a script call "block" in its
61 directory. The script is evaluated before the screen setup is inspected, and
62 in case of it returning a value of 0 the profile is skipped. This can be used
63 to query the status of a docking station you are about to leave.
65 If no suitable profile can be identified, the current configuration is kept.
66 To change this behaviour and switch to a fallback configuration, specify
69 Another script called "postswitch" can be placed in the directory
70 ~/.config/autorandr (or ~/.autorandr if you have an old installation) as well
71 as in any profile directories: The scripts are executed after a mode switch
72 has taken place and can notify window managers.
74 The following virtual configurations are available:
77 class XrandrOutput(object):
78 "Represents an XRandR output"
80 # This regular expression is used to parse an output in `xrandr --verbose'
81 XRANDR_OUTPUT_REGEXP = """(?x)
82 ^(?P<output>[^ ]+)\s+ # Line starts with output name
83 (?: # Differentiate disconnected and connected in first line
86 (?P<connected>connected)\s+ # If connected:
88 (?P<primary>primary\ )? # Might be primary screen
89 (?P<width>[0-9]+)x(?P<height>[0-9]+) # Resolution (might be overridden below!)
90 \+(?P<x>[0-9]+)\+(?P<y>[0-9]+)\s+ # Position
91 (?:\(0x[0-9a-fA-F]+\)\s+)? # XID
92 (?P<rotate>(?:normal|left|right|inverted))\s+ # Rotation
93 (?:(?P<reflect>X\ and\ Y|X|Y)\ axis)? # Reflection
94 )? # .. but everything of the above only if the screen is in use.
96 (?:\s*(?: # Properties of the output
97 Gamma: (?P<gamma>[0-9\.: ]+) | # Gamma value
98 Transform: (?P<transform>(?:[\-0-9\. ]+\s+){3}) | # Transformation matrix
99 EDID: (?P<edid>\s*?(?:\\n\\t\\t[0-9a-f]+)+) | # EDID of the output
100 (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)* # Other properties
104 (?P<mode_width>[0-9]+)x(?P<mode_height>[0-9]+).+?\*current.+\s+
105 h:.+\s+v:.+clock\s+(?P<rate>[0-9\.]+)Hz\s* | # Interesting (current) resolution: Extract rate
106 [0-9]+x[0-9]+.+\s+h:.+\s+v:.+\s* # Other resolutions
110 XRANDR_OUTPUT_MODES_REGEXP = """(?x)
111 (?P<width>[0-9]+)x(?P<height>[0-9]+)
112 .*?(?P<preferred>\+preferred)?
114 \s+v:.+clock\s+(?P<rate>[0-9\.]+)Hz
117 XRANDR_13_DEFAULTS = {
118 "transform": "1,0,0,0,1,0,0,0,1",
121 XRANDR_12_DEFAULTS = {
124 "gamma": "1.0:1.0:1.0",
127 XRANDR_DEFAULTS = dict(list(XRANDR_13_DEFAULTS.items()) + list(XRANDR_12_DEFAULTS.items()))
130 return "<%s%s %s>" % (self.output, (" %s..%s" % (self.edid[:5], self.edid[-5:])) if self.edid else "", " ".join(self.option_vector))
133 def options_with_defaults(self):
134 "Return the options dictionary, augmented with the default values that weren't set"
135 if "off" in self.options:
138 if xrandr_version() >= Version("1.3"):
139 options.update(self.XRANDR_13_DEFAULTS)
140 if xrandr_version() >= Version("1.2"):
141 options.update(self.XRANDR_12_DEFAULTS)
142 options.update(self.options)
146 def option_vector(self):
147 "Return the command line parameters for XRandR for this instance"
148 return sum([["--%s" % option[0], option[1]] if option[1] else ["--%s" % option[0]] for option in chain((("output", self.output),), self.options_with_defaults.items())], [])
151 def option_string(self):
152 "Return the command line parameters in the configuration file format"
153 return "\n".join([ " ".join(option) if option[1] else option[0] for option in chain((("output", self.output),), self.options.items())])
157 "Return a key to sort the outputs for xrandr invocation"
160 if "pos" in self.options:
161 x, y = map(float, self.options["pos"].split("x"))
166 def __init__(self, output, edid, options):
167 "Instanciate using output name, edid and a dictionary of XRandR command line parameters"
170 self.options = options
171 self.remove_default_option_values()
173 def remove_default_option_values(self):
174 "Remove values from the options dictionary that are superflous"
175 if "off" in self.options and len(self.options.keys()) > 1:
176 self.options = { "off": None }
178 for option, default_value in self.XRANDR_DEFAULTS.items():
179 if option in self.options and self.options[option] == default_value:
180 del self.options[option]
183 def from_xrandr_output(cls, xrandr_output):
184 """Instanciate an XrandrOutput from the output of `xrandr --verbose'
186 This method also returns a list of modes supported by the output.
189 xrandr_output = xrandr_output.replace("\r\n", "\n")
190 match_object = re.search(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
192 raise RuntimeError("Parsing XRandR output failed, there is an error in the regular expression.")
194 debug = debug_regexp(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
195 raise RuntimeError("Parsing XRandR output failed, the regular expression did not match: %s" % debug)
196 remainder = xrandr_output[len(match_object.group(0)):]
198 raise RuntimeError(("Parsing XRandR output failed, %d bytes left unmatched after regular expression, "
199 "starting at byte %d with ..'%s'.") % (len(remainder), len(len(match_object.group(0))), remainder[:10]))
201 match = match_object.groupdict()
205 modes = [ x.groupdict() for x in re.finditer(XrandrOutput.XRANDR_OUTPUT_MODES_REGEXP, match["modes"]) ]
207 raise RuntimeError("Parsing XRandR output failed, couldn't find any display modes")
210 if not match["connected"]:
211 options["off"] = None
213 elif not match["width"]:
214 options["off"] = None
215 edid = "".join(match["edid"].strip().split())
217 if match["mode_width"]:
218 options["mode"] = "%sx%s" % (match["mode_width"], match["mode_height"])
220 if match["rotate"] not in ("left", "right"):
221 options["mode"] = "%sx%s" % (match["width"], match["height"])
223 options["mode"] = "%sx%s" % (match["height"], match["width"])
224 options["rotate"] = match["rotate"]
226 options["primary"] = None
227 if match["reflect"] == "X":
228 options["reflect"] = "x"
229 elif match["reflect"] == "Y":
230 options["reflect"] = "y"
231 elif match["reflect"] == "X and Y":
232 options["reflect"] = "xy"
233 options["pos"] = "%sx%s" % (match["x"], match["y"])
234 if match["transform"]:
235 transformation = ",".join(match["transform"].strip().split())
236 if transformation != "1.000000,0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000,1.000000":
237 options["transform"] = transformation
238 if not match["mode_width"]:
239 # TODO We'd need to apply the reverse transformation here. Let's see if someone complains, I doubt that this
240 # special case is actually required.
241 print("Warning: Output %s has a transformation applied. Could not determine correct mode!", file=sys.stderr)
243 gamma = match["gamma"].strip()
244 options["gamma"] = gamma
246 options["rate"] = match["rate"]
247 edid = "".join(match["edid"].strip().split())
249 return XrandrOutput(match["output"], edid, options), modes
252 def from_config_file(cls, edid_map, configuration):
253 "Instanciate an XrandrOutput from the contents of a configuration file"
255 for line in configuration.split("\n"):
257 line = line.split(None, 1)
258 options[line[0]] = line[1] if len(line) > 1 else None
262 if options["output"] in edid_map:
263 edid = edid_map[options["output"]]
265 # This fuzzy matching is for legacy autorandr that used sysfs output names
266 fuzzy_edid_map = [ re.sub("(card[0-9]+|-)", "", x) for x in edid_map.keys() ]
267 fuzzy_output = re.sub("(card[0-9]+|-)", "", options["output"])
268 if fuzzy_output in fuzzy_edid_map:
269 edid = edid_map[list(edid_map.keys())[fuzzy_edid_map.index(fuzzy_output)]]
270 elif "off" not in options:
271 raise RuntimeError("Failed to find an EDID for output `%s' in setup file, required as `%s' is not off in config file."
272 % (options["output"], options["output"]))
273 output = options["output"]
274 del options["output"]
276 return XrandrOutput(output, edid, options)
278 def edid_equals(self, other):
279 "Compare to another XrandrOutput's edid and on/off-state, taking legacy autorandr behaviour (md5sum'ing) into account"
280 if self.edid and other.edid:
281 if len(self.edid) == 32 and len(other.edid) != 32:
282 return hashlib.md5(binascii.unhexlify(other.edid)).hexdigest() == self.edid
283 if len(self.edid) != 32 and len(other.edid) == 32:
284 return hashlib.md5(binascii.unhexlify(self.edid)).hexdigest() == other.edid
285 return self.edid == other.edid
287 def __eq__(self, other):
288 return self.edid_equals(other) and self.output == other.output and self.options == other.options
290 def xrandr_version():
291 "Return the version of XRandR that this system uses"
292 if getattr(xrandr_version, "version", False) is False:
293 version_string = os.popen("xrandr -v").read()
295 version = re.search("xrandr program version\s+([0-9\.]+)", version_string).group(1)
296 xrandr_version.version = Version(version)
297 except AttributeError:
298 xrandr_version.version = Version("1.3.0")
300 return xrandr_version.version
302 def debug_regexp(pattern, string):
303 "Use the partial matching functionality of the regex module to display debug info on a non-matching regular expression"
306 bounds = ( 0, len(string) )
307 while bounds[0] != bounds[1]:
308 half = int((bounds[0] + bounds[1]) / 2)
309 if half == bounds[0]:
311 bounds = (half, bounds[1]) if regex.search(pattern, string[:half], partial=True) else (bounds[0], half - 1)
312 partial_length = bounds[0]
313 return ("Regular expression matched until position "
314 "%d, ..'%s', and did not match from '%s'.." % (partial_length, string[max(0, partial_length-20):partial_length],
315 string[partial_length:partial_length+10]))
318 return "Debug information available if `regex' module is installed."
320 def parse_xrandr_output():
321 "Parse the output of `xrandr --verbose' into a list of outputs"
322 xrandr_output = os.popen("xrandr -q --verbose").read()
323 if not xrandr_output:
324 raise RuntimeError("Failed to run xrandr")
326 # We are not interested in screens
327 xrandr_output = re.sub("(?m)^Screen [0-9].+", "", xrandr_output).strip()
329 # Split at output boundaries and instanciate an XrandrOutput per output
330 split_xrandr_output = re.split("(?m)^([^ ]+ (?:(?:dis)?connected|unknown connection).*)$", xrandr_output)
331 outputs = OrderedDict()
332 modes = OrderedDict()
333 for i in range(1, len(split_xrandr_output), 2):
334 output_name = split_xrandr_output[i].split()[0]
335 output, output_modes = XrandrOutput.from_xrandr_output("".join(split_xrandr_output[i:i+2]))
336 outputs[output_name] = output
338 modes[output_name] = output_modes
340 return outputs, modes
342 def load_profiles(profile_path):
343 "Load the stored profiles"
346 for profile in os.listdir(profile_path):
347 config_name = os.path.join(profile_path, profile, "config")
348 setup_name = os.path.join(profile_path, profile, "setup")
349 if not os.path.isfile(config_name) or not os.path.isfile(setup_name):
352 edids = dict([ x.strip().split() for x in open(setup_name).readlines() ])
356 for line in chain(open(config_name).readlines(), ["output"]):
357 if line[:6] == "output" and buffer:
358 config[buffer[0].strip().split()[-1]] = XrandrOutput.from_config_file(edids, "".join(buffer))
363 for output_name in list(config.keys()):
364 if config[output_name].edid is None:
365 del config[output_name]
367 profiles[profile] = config
371 def find_profile(current_config, profiles):
372 "Find a profile matching the currently connected outputs"
373 for profile_name, profile in profiles.items():
375 for name, output in profile.items():
378 if name not in current_config or not output.edid_equals(current_config[name]):
381 if not matches or any(( name not in profile.keys() for name in current_config.keys() if current_config[name].edid )):
386 def profile_blocked(profile_path):
387 "Check if a profile is blocked"
388 script = os.path.join(profile_path, "blocked")
389 if not os.access(script, os.X_OK | os.F_OK):
391 return subprocess.call(script) == 0
393 def output_configuration(configuration, config):
394 "Write a configuration file"
395 outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
396 for output in outputs:
397 print(configuration[output].option_string, file=config)
399 def output_setup(configuration, setup):
400 "Write a setup (fingerprint) file"
401 outputs = sorted(configuration.keys())
402 for output in outputs:
403 if configuration[output].edid:
404 print(output, configuration[output].edid, file=setup)
406 def save_configuration(profile_path, configuration):
407 "Save a configuration into a profile"
408 if not os.path.isdir(profile_path):
409 os.makedirs(profile_path)
410 with open(os.path.join(profile_path, "config"), "w") as config:
411 output_configuration(configuration, config)
412 with open(os.path.join(profile_path, "setup"), "w") as setup:
413 output_setup(configuration, setup)
415 def apply_configuration(configuration, dry_run=False):
416 "Apply a configuration"
417 outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
419 base_argv = [ "echo", "xrandr" ]
421 base_argv = [ "xrandr" ]
423 # Disable all unused outputs
425 for output in outputs:
426 if not configuration[output].edid or "off" in configuration[output].options:
427 argv += configuration[output].option_vector
428 if argv != base_argv:
429 if subprocess.call(argv) != 0:
432 # Enable remaining outputs in pairs of two
433 remaining_outputs = [ x for x in outputs if configuration[x].edid ]
434 for index in range(0, len(remaining_outputs), 2):
435 if subprocess.call((base_argv[:] + configuration[remaining_outputs[index]].option_vector + (configuration[remaining_outputs[index + 1]].option_vector if index < len(remaining_outputs) - 1 else []))) != 0:
438 def add_unused_outputs(source_configuration, target_configuration):
439 "Add outputs that are missing in target to target, in 'off' state"
440 for output_name, output in source_configuration.items():
441 if output_name not in target_configuration:
442 target_configuration[output_name] = XrandrOutput(output_name, output.edid, { "off": None })
444 def generate_virtual_profile(configuration, modes, profile_name):
445 "Generate one of the virtual profiles"
446 configuration = copy.deepcopy(configuration)
447 if profile_name == "common":
448 common_resolution = [ set(( ( mode["width"], mode["height"] ) for mode in output )) for output in modes.values() ]
449 common_resolution = reduce(lambda a, b: a & b, common_resolution[1:], common_resolution[0])
450 common_resolution = sorted(common_resolution, key=lambda a: int(a[0])*int(a[1]))
451 if common_resolution:
452 for output in configuration:
453 configuration[output].options = {}
455 configuration[output].options["mode"] = "%sx%s" % common_resolution[-1]
456 configuration[output].options["pos"] = "0x0"
458 configuration[output].options["off"] = None
459 elif profile_name in ("horizontal", "vertical"):
461 if profile_name == "horizontal":
462 shift_index = "width"
463 pos_specifier = "%sx0"
465 shift_index = "height"
466 pos_specifier = "0x%s"
468 for output in configuration:
469 configuration[output].options = {}
471 mode = sorted(modes[output], key=lambda a: int(a["width"])*int(a["height"]) + (10**6 if a["preferred"] else 0))[-1]
472 configuration[output].options["mode"] = "%sx%s" % (mode["width"], mode["height"])
473 configuration[output].options["rate"] = mode["rate"]
474 configuration[output].options["pos"] = pos_specifier % shift
475 shift += int(mode[shift_index])
477 configuration[output].options["off"] = None
481 "Print help and exit"
483 for profile in virtual_profiles:
484 print(" %-10s %s" % profile[:2])
487 def exec_scripts(profile_path, script_name):
489 for script in (os.path.join(profile_path, script_name), os.path.join(os.path.dirname(profile_path), script_name)):
490 if os.access(script, os.X_OK | os.F_OK):
491 subprocess.call(script)
495 options = dict(getopt.getopt(argv[1:], "s:l:d:cfh", [ "dry-run", "change", "default=", "save=", "load=", "force", "fingerprint", "config", "help" ])[0])
496 except getopt.GetoptError as e:
498 options = { "--help": True }
502 # Load profiles from each XDG config directory
503 for directory in os.environ.get("XDG_CONFIG_DIRS", "").split(":"):
504 system_profile_path = os.path.join(directory, "autorandr")
505 if os.path.isdir(system_profile_path):
506 profiles.update(load_profiles(system_profile_path))
507 # For the user's profiles, prefer the legacy ~/.autorandr if it already exists
508 # profile_path is also used later on to store configurations
509 profile_path = os.path.expanduser("~/.autorandr")
510 if not os.path.isdir(profile_path):
511 # Elsewise, follow the XDG specification
512 profile_path = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr")
513 if os.path.isdir(profile_path):
514 profiles.update(load_profiles(profile_path))
515 except Exception as e:
516 print("Failed to load profiles:\n%s" % str(e), file=sys.stderr)
520 config, modes = parse_xrandr_output()
521 except Exception as e:
522 print("Failed to parse current configuration from XRandR:\n%s" % str(e), file=sys.stderr)
525 if "--fingerprint" in options:
526 output_setup(config, sys.stdout)
529 if "--config" in options:
530 output_configuration(config, sys.stdout)
534 options["--save"] = options["-s"]
535 if "--save" in options:
536 if options["--save"] in ( x[0] for x in virtual_profiles ):
537 print("Cannot save current configuration as profile '%s':\nThis configuration name is a reserved virtual configuration." % options["--save"])
540 save_configuration(os.path.join(profile_path, options["--save"]), config)
541 except Exception as e:
542 print("Failed to save current configuration as profile '%s':\n%s" % (options["--save"], str(e)), file=sys.stderr)
544 print("Saved current configuration as profile '%s'" % options["--save"])
547 if "-h" in options or "--help" in options:
550 detected_profile = find_profile(config, profiles)
554 options["--load"] = options["-l"]
555 if "--load" in options:
556 load_profile = options["--load"]
558 for profile_name in profiles.keys():
559 if profile_blocked(os.path.join(profile_path, profile_name)):
560 print("%s (blocked)" % profile_name, file=sys.stderr)
562 if detected_profile == profile_name:
563 print("%s (detected)" % profile_name, file=sys.stderr)
564 if "-c" in options or "--change" in options:
565 load_profile = detected_profile
567 print(profile_name, file=sys.stderr)
570 options["--default"] = options["-d"]
571 if not load_profile and "--default" in options:
572 load_profile = options["--default"]
575 if load_profile in ( x[0] for x in virtual_profiles ):
576 profile = generate_virtual_profile(config, modes, load_profile)
579 profile = profiles[load_profile]
581 print("Failed to load profile '%s':\nProfile not found" % load_profile, file=sys.stderr)
583 add_unused_outputs(config, profile)
584 if profile == dict(config) and not "-f" in options and not "--force" in options:
585 print("Config already loaded", file=sys.stderr)
589 if "--dry-run" in options:
590 apply_configuration(profile, True)
592 exec_scripts(os.path.join(profile_path, load_profile), "preswitch")
593 apply_configuration(profile, False)
594 exec_scripts(os.path.join(profile_path, load_profile), "postswitch")
595 except Exception as e:
596 print("Failed to apply profile '%s':\n%s" % (load_profile, str(e)), file=sys.stderr)
601 if __name__ == '__main__':
604 except Exception as e:
605 print("General failure. Please report this as a bug:\n%s" % (str(e),), file=sys.stderr)