X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=autorandr.py;h=64e9e22c7dc5315993c20abe69772cbe00b9318f;hb=14df4cb5f9b0073c690d7c6f03329ae038591369;hp=a5206c496c41d131205774d0959afab90bbcad35;hpb=67ca542b9c6d0d506997ad5683e61c4146b3a05a;p=deb_pkgs%2Fautorandr.git diff --git a/autorandr.py b/autorandr.py index a5206c4..64e9e22 100755 --- a/autorandr.py +++ b/autorandr.py @@ -4,7 +4,7 @@ # autorandr.py # Copyright (c) 2015, Phillip Berndt # -# Experimental autorandr rewrite in Python +# Autorandr rewrite in Python # # This script aims to be fully compatible with the original autorandr. # @@ -21,8 +21,6 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . # -# TODO Add virtual profiles common, horizontal, vertical -# This also requires to load all resolutions into the XrandrOutputs from __future__ import print_function import copy @@ -34,6 +32,7 @@ import os import re import subprocess import sys +from distutils.version import LooseVersion as Version from itertools import chain from collections import OrderedDict @@ -48,14 +47,14 @@ virtual_profiles = [ help_text = """ Usage: autorandr [options] --h, --help get this small help --c, --change reload current setup --s, --save save your current setup to profile --l, --load load profile +-h, --help get this small help +-c, --change reload current setup +-s, --save save your current setup to profile +-l, --load load profile -d, --default make profile the default profile ---force force (re)loading of a profile ---fingerprint fingerprint your current hardware setup ---config dump your current xrandr setup +--force force (re)loading of a profile +--fingerprint fingerprint your current hardware setup +--config dump your current xrandr setup --dry-run don't change anything, only print the xrandr commands To prevent a profile from being loaded, place a script call "block" in its @@ -67,9 +66,10 @@ Usage: autorandr [options] To change this behaviour and switch to a fallback configuration, specify --default . - Another script called "postswitch "can be placed in the directory - ~/.autorandr as well as in any profile directories: The scripts are executed - after a mode switch has taken place and can notify window managers. + Another script called "postswitch" can be placed in the directory + ~/.config/autorandr (or ~/.autorandr if you have an old installation) as well + as in any profile directories: The scripts are executed after a mode switch + has taken place and can notify window managers. The following virtual configurations are available: """.strip() @@ -84,25 +84,27 @@ class XrandrOutput(object): disconnected | unknown\ connection | (?Pconnected)\s+ # If connected: + (?: (?Pprimary\ )? # Might be primary screen - (?P[0-9]+)x(?P[0-9]+) # Resolution + (?P[0-9]+)x(?P[0-9]+) # Resolution (might be overridden below!) \+(?P[0-9]+)\+(?P[0-9]+)\s+ # Position (?:\(0x[0-9a-fA-F]+\)\s+)? # XID (?P(?:normal|left|right|inverted))\s+ # Rotation (?:(?PX\ and\ Y|X|Y)\ axis)? # Reflection + )? # .. but everything of the above only if the screen is in use. ).* (?:\s*(?: # Properties of the output - Gamma: (?P[0-9\.:\s]+) | # Gamma value - Transform: (?P[0-9\.\s]+) | # Transformation matrix - EDID: (?P[0-9a-f\s]+) | # EDID of the output + Gamma: (?P[0-9\.: ]+) | # Gamma value + Transform: (?P(?:[\-0-9\. ]+\s+){3}) | # Transformation matrix + EDID: (?P\s*?(?:\\n\\t\\t[0-9a-f]+)+) | # EDID of the output (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)* # Other properties ))+ \s* (?P(?: - [0-9]+x[0-9]+.+?\*current.+\s+h:.+\s+v:.+clock\s+(?P[0-9\.]+)Hz\s* | # Interesting (current) resolution: Extract rate + (?P[0-9]+)x(?P[0-9]+).+?\*current.+\s+ + h:.+\s+v:.+clock\s+(?P[0-9\.]+)Hz\s* | # Interesting (current) resolution: Extract rate [0-9]+x[0-9]+.+\s+h:.+\s+v:.+\s* # Other resolutions )*) - $ """ XRANDR_OUTPUT_MODES_REGEXP = """(?x) @@ -112,13 +114,38 @@ class XrandrOutput(object): \s+v:.+clock\s+(?P[0-9\.]+)Hz """ + XRANDR_13_DEFAULTS = { + "transform": "1,0,0,0,1,0,0,0,1", + } + + XRANDR_12_DEFAULTS = { + "reflect": "normal", + "rotate": "normal", + "gamma": "1.0:1.0:1.0", + } + + XRANDR_DEFAULTS = dict(list(XRANDR_13_DEFAULTS.items()) + list(XRANDR_12_DEFAULTS.items())) + def __repr__(self): return "<%s%s %s>" % (self.output, (" %s..%s" % (self.edid[:5], self.edid[-5:])) if self.edid else "", " ".join(self.option_vector)) + @property + def options_with_defaults(self): + "Return the options dictionary, augmented with the default values that weren't set" + if "off" in self.options: + return self.options + options = {} + if xrandr_version() >= Version("1.3"): + options.update(self.XRANDR_13_DEFAULTS) + if xrandr_version() >= Version("1.2"): + options.update(self.XRANDR_12_DEFAULTS) + options.update(self.options) + return options + @property def option_vector(self): "Return the command line parameters for XRandR for this instance" - return sum([["--%s" % option[0], option[1]] if option[1] else ["--%s" % option[0]] for option in chain((("output", self.output),), self.options.items())], []) + 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())], []) @property def option_string(self): @@ -141,6 +168,16 @@ class XrandrOutput(object): self.output = output self.edid = edid self.options = options + self.remove_default_option_values() + + def remove_default_option_values(self): + "Remove values from the options dictionary that are superflous" + if "off" in self.options and len(self.options.keys()) > 1: + self.options = { "off": None } + return + for option, default_value in self.XRANDR_DEFAULTS.items(): + if option in self.options and self.options[option] == default_value: + del self.options[option] @classmethod def from_xrandr_output(cls, xrandr_output): @@ -149,51 +186,62 @@ class XrandrOutput(object): This method also returns a list of modes supported by the output. """ try: + xrandr_output = xrandr_output.replace("\r\n", "\n") match_object = re.search(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output) except: raise RuntimeError("Parsing XRandR output failed, there is an error in the regular expression.") if not match_object: - raise RuntimeError("Parsing XRandR output failed, the regular expression did not match.") + debug = debug_regexp(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output) + raise RuntimeError("Parsing XRandR output failed, the regular expression did not match: %s" % debug) remainder = xrandr_output[len(match_object.group(0)):] if remainder: - raise RuntimeError("Parsing XRandR output failed, %d bytes left unmatched after regular expression." % len(remainder)) - + raise RuntimeError(("Parsing XRandR output failed, %d bytes left unmatched after regular expression, " + "starting at byte %d with ..'%s'.") % (len(remainder), len(len(match_object.group(0))), remainder[:10])) match = match_object.groupdict() modes = [] if match["modes"]: modes = [ x.groupdict() for x in re.finditer(XrandrOutput.XRANDR_OUTPUT_MODES_REGEXP, match["modes"]) ] + if not modes: + raise RuntimeError("Parsing XRandR output failed, couldn't find any display modes") options = {} if not match["connected"]: options["off"] = None edid = None + elif not match["width"]: + options["off"] = None + edid = "".join(match["edid"].strip().split()) else: - if match["rotate"] not in ("left", "right"): - options["mode"] = "%sx%s" % (match["width"], match["height"]) + if match["mode_width"]: + options["mode"] = "%sx%s" % (match["mode_width"], match["mode_height"]) else: - options["mode"] = "%sx%s" % (match["height"], match["width"]) + if match["rotate"] not in ("left", "right"): + options["mode"] = "%sx%s" % (match["width"], match["height"]) + else: + options["mode"] = "%sx%s" % (match["height"], match["width"]) options["rotate"] = match["rotate"] - options["reflect"] = "normal" - if "reflect" in match: - if match["reflect"] == "X": - options["reflect"] = "x" - elif match["reflect"] == "Y": - options["reflect"] = "y" - elif match["reflect"] == "X and Y": - options["reflect"] = "xy" + if match["primary"]: + options["primary"] = None + if match["reflect"] == "X": + options["reflect"] = "x" + elif match["reflect"] == "Y": + options["reflect"] = "y" + elif match["reflect"] == "X and Y": + options["reflect"] = "xy" options["pos"] = "%sx%s" % (match["x"], match["y"]) if match["transform"]: transformation = ",".join(match["transform"].strip().split()) if transformation != "1.000000,0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000,1.000000": options["transform"] = transformation - else: - options["transform"] = "none" + if not match["mode_width"]: + # TODO We'd need to apply the reverse transformation here. Let's see if someone complains, I doubt that this + # special case is actually required. + print("Warning: Output %s has a transformation applied. Could not determine correct mode!", file=sys.stderr) if match["gamma"]: gamma = match["gamma"].strip() - if gamma != "1.0:1.0:1.0": - options["gamma"] = gamma + options["gamma"] = gamma if match["rate"]: options["rate"] = match["rate"] edid = "".join(match["edid"].strip().split()) @@ -208,17 +256,20 @@ class XrandrOutput(object): if line: line = line.split(None, 1) options[line[0]] = line[1] if len(line) > 1 else None - if "off" in options: - edid = None + + edid = None + + if options["output"] in edid_map: + edid = edid_map[options["output"]] else: - if options["output"] in edid_map: - edid = edid_map[options["output"]] - else: - fuzzy_edid_map = [ re.sub("(card[0-9]+|-)", "", x) for x in edid_map.keys() ] - fuzzy_output = re.sub("(card[0-9]+|-)", "", options["output"]) - if fuzzy_output not in fuzzy_edid_map: - raise RuntimeError("Failed to find a corresponding output in config/setup for output `%s'" % options["output"]) + # This fuzzy matching is for legacy autorandr that used sysfs output names + fuzzy_edid_map = [ re.sub("(card[0-9]+|-)", "", x) for x in edid_map.keys() ] + fuzzy_output = re.sub("(card[0-9]+|-)", "", options["output"]) + if fuzzy_output in fuzzy_edid_map: edid = edid_map[list(edid_map.keys())[fuzzy_edid_map.index(fuzzy_output)]] + elif "off" not in options: + raise RuntimeError("Failed to find an EDID for output `%s' in setup file, required as `%s' is not off in config file." + % (options["output"], options["output"])) output = options["output"] del options["output"] @@ -234,7 +285,37 @@ class XrandrOutput(object): return self.edid == other.edid def __eq__(self, other): - return self.edid == other.edid and self.output == other.output and self.options == other.options + return self.edid_equals(other) and self.output == other.output and self.options == other.options + +def xrandr_version(): + "Return the version of XRandR that this system uses" + if getattr(xrandr_version, "version", False) is False: + version_string = os.popen("xrandr -v").read() + try: + version = re.search("xrandr program version\s+([0-9\.]+)", version_string).group(1) + xrandr_version.version = Version(version) + except AttributeError: + xrandr_version.version = Version("1.3.0") + + return xrandr_version.version + +def debug_regexp(pattern, string): + "Use the partial matching functionality of the regex module to display debug info on a non-matching regular expression" + try: + import regex + bounds = ( 0, len(string) ) + while bounds[0] != bounds[1]: + half = int((bounds[0] + bounds[1]) / 2) + if half == bounds[0]: + break + bounds = (half, bounds[1]) if regex.search(pattern, string[:half], partial=True) else (bounds[0], half - 1) + partial_length = bounds[0] + return ("Regular expression matched until position " + "%d, ..'%s', and did not match from '%s'.." % (partial_length, string[max(0, partial_length-20):partial_length], + string[partial_length:partial_length+10])) + except ImportError: + pass + return "Debug information available if `regex' module is installed." def parse_xrandr_output(): "Parse the output of `xrandr --verbose' into a list of outputs" @@ -279,24 +360,31 @@ def load_profiles(profile_path): else: buffer.append(line) - profiles[profile] = config + for output_name in list(config.keys()): + if config[output_name].edid is None: + del config[output_name] + + profiles[profile] = { "config": config, "path": os.path.join(profile_path, profile), "config-mtime": os.stat(config_name).st_mtime } return profiles -def find_profile(current_config, profiles): - "Find a profile matching the currently connected outputs" +def find_profiles(current_config, profiles): + "Find profiles matching the currently connected outputs" + detected_profiles = [] for profile_name, profile in profiles.items(): + config = profile["config"] matches = True - for name, output in profile.items(): + for name, output in config.items(): if not output.edid: continue if name not in current_config or not output.edid_equals(current_config[name]): matches = False break - if not matches or any(( name not in profile.keys() for name in current_config.keys() if current_config[name].edid )): + if not matches or any(( name not in config.keys() for name in current_config.keys() if current_config[name].edid )): continue if matches: - return profile_name + detected_profiles.append(profile_name) + return detected_profiles def profile_blocked(profile_path): "Check if a profile is blocked" @@ -327,6 +415,14 @@ def save_configuration(profile_path, configuration): with open(os.path.join(profile_path, "setup"), "w") as setup: output_setup(configuration, setup) +def update_mtime(filename): + "Update a file's mtime" + try: + os.utime(filename, None) + return True + except: + return False + def apply_configuration(configuration, dry_run=False): "Apply a configuration" outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key) @@ -337,17 +433,35 @@ def apply_configuration(configuration, dry_run=False): # Disable all unused outputs argv = base_argv[:] + disable_argv = [] for output in outputs: - if not configuration[output].edid: - argv += configuration[output].option_vector - if subprocess.call(argv) != 0: - return False + if not configuration[output].edid or "off" in configuration[output].options: + disable_argv += configuration[output].option_vector + if disable_argv: + if subprocess.call(base_argv + disable_argv) != 0: + # Disabling the outputs failed. Retry with the next command: + # Sometimes disabling of outputs fails due to an invalid RRSetScreenSize. + # This does not occur if simultaneously the primary screen is reset. + pass + else: + disable_argv = [] # Enable remaining outputs in pairs of two remaining_outputs = [ x for x in outputs if configuration[x].edid ] for index in range(0, len(remaining_outputs), 2): - 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: - return False + argv = base_argv[:] + if disable_argv: + argv += disable_argv + disable_argv = [] + argv += configuration[remaining_outputs[index]].option_vector + (configuration[remaining_outputs[index + 1]].option_vector if index < len(remaining_outputs) - 1 else []) + if subprocess.call(argv) != 0: + raise RuntimeError("Command failed: %s" % " ".join(argv)) + +def add_unused_outputs(source_configuration, target_configuration): + "Add outputs that are missing in target to target, in 'off' state" + for output_name, output in source_configuration.items(): + if output_name not in target_configuration: + target_configuration[output_name] = XrandrOutput(output_name, output.edid, { "off": None }) def generate_virtual_profile(configuration, modes, profile_name): "Generate one of the virtual profiles" @@ -399,11 +513,38 @@ def exec_scripts(profile_path, script_name): subprocess.call(script) def main(argv): - options = dict(getopt.getopt(argv[1:], "s:l:d:cfh", [ "dry-run", "change", "default=", "save=", "load=", "force", "fingerprint", "config", "help" ])[0]) + try: + options = dict(getopt.getopt(argv[1:], "s:l:d:cfh", [ "dry-run", "change", "default=", "save=", "load=", "force", "fingerprint", "config", "help" ])[0]) + except getopt.GetoptError as e: + print(str(e)) + options = { "--help": True } - profile_path = os.path.expanduser("~/.autorandr") - profiles = load_profiles(profile_path) - config, modes = parse_xrandr_output() + profiles = {} + try: + # Load profiles from each XDG config directory + for directory in os.environ.get("XDG_CONFIG_DIRS", "").split(":"): + system_profile_path = os.path.join(directory, "autorandr") + if os.path.isdir(system_profile_path): + profiles.update(load_profiles(system_profile_path)) + # For the user's profiles, prefer the legacy ~/.autorandr if it already exists + # profile_path is also used later on to store configurations + profile_path = os.path.expanduser("~/.autorandr") + if not os.path.isdir(profile_path): + # Elsewise, follow the XDG specification + profile_path = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr") + if os.path.isdir(profile_path): + profiles.update(load_profiles(profile_path)) + # Sort by descending mtime + profiles = OrderedDict(sorted(profiles.items(), key=lambda x: -x[1]["config-mtime"])) + except Exception as e: + print("Failed to load profiles:\n%s" % str(e), file=sys.stderr) + sys.exit(1) + + try: + config, modes = parse_xrandr_output() + except Exception as e: + print("Failed to parse current configuration from XRandR:\n%s" % str(e), file=sys.stderr) + sys.exit(1) if "--fingerprint" in options: output_setup(config, sys.stdout) @@ -417,16 +558,20 @@ def main(argv): options["--save"] = options["-s"] if "--save" in options: if options["--save"] in ( x[0] for x in virtual_profiles ): - print("Cannot save current configuration as profile '%s': This configuration name is a reserved virtual configuration." % options["--save"]) + print("Cannot save current configuration as profile '%s':\nThis configuration name is a reserved virtual configuration." % options["--save"]) + sys.exit(1) + try: + save_configuration(os.path.join(profile_path, options["--save"]), config) + except Exception as e: + print("Failed to save current configuration as profile '%s':\n%s" % (options["--save"], str(e)), file=sys.stderr) sys.exit(1) - save_configuration(os.path.join(profile_path, options["--save"]), config) print("Saved current configuration as profile '%s'" % options["--save"]) sys.exit(0) if "-h" in options or "--help" in options: exit_help() - detected_profile = find_profile(config, profiles) + detected_profiles = find_profiles(config, profiles) load_profile = False if "-l" in options: @@ -436,14 +581,14 @@ def main(argv): else: for profile_name in profiles.keys(): if profile_blocked(os.path.join(profile_path, profile_name)): - print("%s (blocked)" % profile_name) + print("%s (blocked)" % profile_name, file=sys.stderr) continue - if detected_profile == profile_name: - print("%s (detected)" % profile_name) - if "-c" in options or "--change" in options: - load_profile = detected_profile + if profile_name in detected_profiles: + print("%s (detected)" % profile_name, file=sys.stderr) + if ("-c" in options or "--change" in options) and not load_profile: + load_profile = profile_name else: - print(profile_name) + print(profile_name, file=sys.stderr) if "-d" in options: options["--default"] = options["-d"] @@ -452,18 +597,39 @@ def main(argv): if load_profile: if load_profile in ( x[0] for x in virtual_profiles ): - profile = generate_virtual_profile(config, modes, load_profile) + load_config = generate_virtual_profile(config, modes, load_profile) + scripts_path = os.path.join(profile_path, load_profile) else: - profile = profiles[load_profile] - if profile == config and not "-f" in options and not "--force" in options: - print("Config already loaded") + try: + profile = profiles[load_profile] + load_config = profile["config"] + scripts_path = profile["path"] + except KeyError: + print("Failed to load profile '%s':\nProfile not found" % load_profile, file=sys.stderr) + sys.exit(1) + if load_profile in detected_profiles and detected_profiles[0] != load_profile: + update_mtime(os.path.join(scripts_path, "config")) + add_unused_outputs(config, load_config) + if load_config == dict(config) and not "-f" in options and not "--force" in options: + print("Config already loaded", file=sys.stderr) sys.exit(0) - exec_scripts(os.path.join(profile_path, load_profile), "preswitch") - apply_configuration(profile, "--dry-run" in options) - exec_scripts(os.path.join(profile_path, load_profile), "postswitch") + try: + if "--dry-run" in options: + apply_configuration(load_config, True) + else: + exec_scripts(scripts_path, "preswitch") + apply_configuration(load_config, False) + exec_scripts(scripts_path, "postswitch") + except Exception as e: + print("Failed to apply profile '%s':\n%s" % (load_profile, str(e)), file=sys.stderr) + sys.exit(1) sys.exit(0) if __name__ == '__main__': - main(sys.argv) + try: + main(sys.argv) + except Exception as e: + print("General failure. Please report this as a bug:\n%s" % (str(e),), file=sys.stderr) + sys.exit(1)