]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/blobdiff - autorandr.py
Run xrandr disabling connected, but inactive outputs before any other xrandr commands
[deb_pkgs/autorandr.git] / autorandr.py
index e19e8648f36597b39a175cae56917a4ae065b5b7..5083c03c20486cb08e9ab7e459bb7a62403e5f96 100755 (executable)
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-# TODO Add virtual profiles common, horizontal, vertical
-#      This also requires to load all resolutions into the XrandrOutputs
 
 from __future__ import print_function
+import copy
 import getopt
 
 import binascii
@@ -33,20 +32,29 @@ import os
 import re
 import subprocess
 import sys
+from distutils.version import LooseVersion as Version
 
 from itertools import chain
+from collections import OrderedDict
+
+virtual_profiles = [
+    # (name, description, callback)
+    ("common", "Clone all connected outputs at the largest common resolution", None),
+    ("horizontal", "Stack all connected outputs horizontally at their largest resolution", None),
+    ("vertical", "Stack all connected outputs vertically at their largest resolution", None),
+]
 
 help_text = """
 Usage: autorandr [options]
 
--h, --help             get this small help
--c, --change           reload current setup
--s, --save <profile>   save your current setup to profile <profile>
--l, --load <profile>   load profile <profile>
+-h, --help              get this small help
+-c, --change            reload current setup
+-s, --save <profile>    save your current setup to profile <profile>
+-l, --load <profile>    load profile <profile>
 -d, --default <profile> make profile <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
@@ -63,7 +71,6 @@ Usage: autorandr [options]
  after a mode switch has taken place and can notify window managers.
 
  The following virtual configurations are available:
-     TODO
 """.strip()
 
 class XrandrOutput(object):
@@ -76,31 +83,68 @@ class XrandrOutput(object):
             disconnected |
             unknown\ connection |
             (?P<connected>connected)\s+                                                 # If connected:
+            (?:
             (?P<primary>primary\ )?                                                     # Might be primary screen
-            (?P<width>[0-9]+)x(?P<height>[0-9]+)                                        # Resolution
+            (?P<width>[0-9]+)x(?P<height>[0-9]+)                                        # Resolution (might be overridden below!)
             \+(?P<x>[0-9]+)\+(?P<y>[0-9]+)\s+                                           # Position
-            (?P<rotation>[^(]\S+)?                                                      # Has a value if the output is rotated
+            (?:\(0x[0-9a-fA-F]+\)\s+)?                                                  # XID
+            (?P<rotate>(?:normal|left|right|inverted))\s+                               # Rotation
+            (?:(?P<reflect>X\ 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<gamma>[0-9\.:\s]+) |                                             # Gamma value
             Transform: (?P<transform>[0-9\.\s]+) |                                      # Transformation matrix
             EDID: (?P<edid>[0-9a-f\s]+) |                                               # EDID of the output
-            (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)*                                       # Other properties
+            (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)*                                 # Other properties
         ))+
         \s*
-        (?:  [0-9]+x[0-9]+.+?\*current.+\s+h:.+\s+v:.+clock\s+(?P<rate>[0-9\.]+)Hz\s* | # Interesting (current) resolution: Extract rate
-          [0-9]+x[0-9]+.+\s+h:.+\s+v:.+\s*                                              # Other resolutions
-        )*
-        $
+        (?P<modes>(?:
+            (?P<mode_width>[0-9]+)x(?P<mode_height>[0-9]+).+?\*current.+\s+
+                h:.+\s+v:.+clock\s+(?P<rate>[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)
+        (?P<width>[0-9]+)x(?P<height>[0-9]+)
+        .*?(?P<preferred>\+preferred)?
+        \s+h:.+
+        \s+v:.+clock\s+(?P<rate>[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(XRANDR_13_DEFAULTS.items() + 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):
@@ -123,41 +167,85 @@ 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):
-        "Instanciate an XrandrOutput from the output of `xrandr --verbose'"
-        match_object = re.search(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
+        """Instanciate an XrandrOutput from the output of `xrandr --verbose'
+
+        This method also returns a list of modes supported by the output.
+        """
+        try:
+            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:
+            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." % len(remainder))
+            raise RuntimeError(("Parsing XRandR output failed, %d bytes left unmatched after regular expression,"
+                                "starting with ..'%s'.") % (len(remainder), 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 not match["rotation"]:
-                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"]
+            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())
 
-        return XrandrOutput(match["output"], edid, options)
+        return XrandrOutput(match["output"], edid, options), modes
 
     @classmethod
     def from_config_file(cls, edid_map, configuration):
@@ -167,17 +255,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"])
-                edid = edid_map[edid_map.keys()[fuzzy_edid_map.index(fuzzy_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"]
 
@@ -193,7 +284,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"
@@ -206,9 +327,16 @@ def parse_xrandr_output():
 
     # Split at output boundaries and instanciate an XrandrOutput per output
     split_xrandr_output = re.split("(?m)^([^ ]+ (?:(?:dis)?connected|unknown connection).*)$", xrandr_output)
-    outputs = { split_xrandr_output[i].split()[0]: XrandrOutput.from_xrandr_output("".join(split_xrandr_output[i:i+2])) for i in range(1, len(split_xrandr_output), 2) }
+    outputs = OrderedDict()
+    modes = OrderedDict()
+    for i in range(1, len(split_xrandr_output), 2):
+        output_name = split_xrandr_output[i].split()[0]
+        output, output_modes = XrandrOutput.from_xrandr_output("".join(split_xrandr_output[i:i+2]))
+        outputs[output_name] = output
+        if output_modes:
+            modes[output_name] = output_modes
 
-    return outputs
+    return outputs, modes
 
 def load_profiles(profile_path):
     "Load the stored profiles"
@@ -231,6 +359,10 @@ def load_profiles(profile_path):
             else:
                 buffer.append(line)
 
+        for output_name in list(config.keys()):
+            if config[output_name].edid is None:
+                del config[output_name]
+
         profiles[profile] = config
 
     return profiles
@@ -265,7 +397,7 @@ def output_configuration(configuration, config):
 
 def output_setup(configuration, setup):
     "Write a setup (fingerprint) file"
-    outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
+    outputs = sorted(configuration.keys())
     for output in outputs:
         if configuration[output].edid:
             print(output, configuration[output].edid, file=setup)
@@ -274,7 +406,6 @@ def save_configuration(profile_path, configuration):
     "Save a configuration into a profile"
     if not os.path.isdir(profile_path):
         os.makedirs(profile_path)
-    outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
     with open(os.path.join(profile_path, "config"), "w") as config:
         output_configuration(configuration, config)
     with open(os.path.join(profile_path, "setup"), "w") as setup:
@@ -291,10 +422,11 @@ def apply_configuration(configuration, dry_run=False):
     # Disable all unused outputs
     argv = base_argv[:]
     for output in outputs:
-        if not configuration[output].edid:
+        if not configuration[output].edid or "off" in configuration[output].options:
             argv += configuration[output].option_vector
-    if subprocess.call(argv) != 0:
-        return False
+    if argv != base_argv:
+        if subprocess.call(argv) != 0:
+            return False
 
     # Enable remaining outputs in pairs of two
     remaining_outputs = [ x for x in outputs if configuration[x].edid ]
@@ -302,9 +434,53 @@ def apply_configuration(configuration, dry_run=False):
         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
 
+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"
+    configuration = copy.deepcopy(configuration)
+    if profile_name == "common":
+        common_resolution = [ set(( ( mode["width"], mode["height"] ) for mode in output )) for output in modes.values() ]
+        common_resolution = reduce(lambda a, b: a & b, common_resolution[1:], common_resolution[0])
+        common_resolution = sorted(common_resolution, key=lambda a: int(a[0])*int(a[1]))
+        if common_resolution:
+            for output in configuration:
+                configuration[output].options = {}
+                if output in modes:
+                    configuration[output].options["mode"] = "%sx%s" % common_resolution[-1]
+                    configuration[output].options["pos"] = "0x0"
+                else:
+                    configuration[output].options["off"] = None
+    elif profile_name in ("horizontal", "vertical"):
+        shift = 0
+        if profile_name == "horizontal":
+            shift_index = "width"
+            pos_specifier = "%sx0"
+        else:
+            shift_index = "height"
+            pos_specifier = "0x%s"
+
+        for output in configuration:
+            configuration[output].options = {}
+            if output in modes:
+                mode = sorted(modes[output], key=lambda a: int(a["width"])*int(a["height"]) + (10**6 if a["preferred"] else 0))[-1]
+                configuration[output].options["mode"] = "%sx%s" % (mode["width"], mode["height"])
+                configuration[output].options["rate"] = mode["rate"]
+                configuration[output].options["pos"] = pos_specifier % shift
+                shift += int(mode[shift_index])
+            else:
+                configuration[output].options["off"] = None
+    return configuration
+
 def exit_help():
     "Print help and exit"
     print(help_text)
+    for profile in virtual_profiles:
+        print("  %-10s %s" % profile[:2])
     sys.exit(0)
 
 def exec_scripts(profile_path, script_name):
@@ -314,11 +490,30 @@ 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 = parse_xrandr_output()
+
+    try:
+        profiles = load_profiles(profile_path)
+    except OSError as e:
+        if e.errno == 2: # No such file or directory
+            profiles = {}
+        else:
+            raise e
+    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)
@@ -331,7 +526,14 @@ def main(argv):
     if "-s" in options:
         options["--save"] = options["-s"]
     if "--save" in options:
-        save_configuration(os.path.join(profile_path, options["--save"]), config)
+        if options["--save"] in ( x[0] for x in virtual_profiles ):
+            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)
         print("Saved current configuration as profile '%s'" % options["--save"])
         sys.exit(0)
 
@@ -345,17 +547,17 @@ def main(argv):
         options["--load"] = options["-l"]
     if "--load" in options:
         load_profile = options["--load"]
-
-    for profile_name in profiles.keys():
-        if profile_blocked(os.path.join(profile_path, profile_name)):
-            print("%s (blocked)" % profile_name)
-            continue
-        if detected_profile == profile_name:
-            print("%s (detected)" % profile_name)
-            if "-c" in options or "--change" in options:
-                load_profile = detected_profile
-        else:
-            print(profile_name)
+    else:
+        for profile_name in profiles.keys():
+            if profile_blocked(os.path.join(profile_path, profile_name)):
+                print("%s (blocked)" % profile_name)
+                continue
+            if detected_profile == profile_name:
+                print("%s (detected)" % profile_name)
+                if "-c" in options or "--change" in options:
+                    load_profile = detected_profile
+            else:
+                print(profile_name)
 
     if "-d" in options:
         options["--default"] = options["-d"]
@@ -363,16 +565,35 @@ def main(argv):
         load_profile = options["--default"]
 
     if load_profile:
-        profile = profiles[load_profile]
+        if load_profile in ( x[0] for x in virtual_profiles ):
+            profile = generate_virtual_profile(config, modes, load_profile)
+        else:
+            try:
+                profile = profiles[load_profile]
+            except KeyError:
+                print("Failed to load profile '%s':\nProfile not found" % load_profile, file=sys.stderr)
+                sys.exit(1)
+        add_unused_outputs(config, profile)
         if profile == config and not "-f" in options and not "--force" in options:
             print("Config already loaded")
             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(profile, True)
+            else:
+                exec_scripts(os.path.join(profile_path, load_profile), "preswitch")
+                apply_configuration(profile, False)
+                exec_scripts(os.path.join(profile_path, load_profile), "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)