]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/blob - autorandr.py
Updated help texts with XDG directory
[deb_pkgs/autorandr.git] / autorandr.py
1 #!/usr/bin/env python
2 # encoding: utf-8
3 #
4 # autorandr.py
5 # Copyright (c) 2015, Phillip Berndt
6 #
7 # Autorandr rewrite in Python
8 #
9 # This script aims to be fully compatible with the original autorandr.
10 #
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.
15 #
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.
20 #
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/>.
23 #
24
25 from __future__ import print_function
26 import copy
27 import getopt
28
29 import binascii
30 import hashlib
31 import os
32 import re
33 import subprocess
34 import sys
35 from distutils.version import LooseVersion as Version
36
37 from itertools import chain
38 from collections import OrderedDict
39
40 virtual_profiles = [
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),
45 ]
46
47 help_text = """
48 Usage: autorandr [options]
49
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
59
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.
64
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
67  --default <profile>.
68
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.
73
74  The following virtual configurations are available:
75 """.strip()
76
77 class XrandrOutput(object):
78     "Represents an XRandR output"
79
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
84             disconnected |
85             unknown\ connection |
86             (?P<connected>connected)\s+                                                 # If connected:
87             (?:
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.
95         ).*
96         (?:\s*(?:                                                                       # Properties of the output
97             Gamma: (?P<gamma>[0-9\.:\s]+) |                                             # Gamma value
98             Transform: (?P<transform>[0-9\.\s]+) |                                      # Transformation matrix
99             EDID: (?P<edid>[0-9a-f\s]+) |                                               # EDID of the output
100             (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)*                                 # Other properties
101         ))+
102         \s*
103         (?P<modes>(?:
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
107         )*)
108     """
109
110     XRANDR_OUTPUT_MODES_REGEXP = """(?x)
111         (?P<width>[0-9]+)x(?P<height>[0-9]+)
112         .*?(?P<preferred>\+preferred)?
113         \s+h:.+
114         \s+v:.+clock\s+(?P<rate>[0-9\.]+)Hz
115     """
116
117     XRANDR_13_DEFAULTS = {
118         "transform": "1,0,0,0,1,0,0,0,1",
119     }
120
121     XRANDR_12_DEFAULTS = {
122         "reflect": "normal",
123         "rotate": "normal",
124         "gamma": "1.0:1.0:1.0",
125     }
126
127     XRANDR_DEFAULTS = dict(list(XRANDR_13_DEFAULTS.items()) + list(XRANDR_12_DEFAULTS.items()))
128
129     def __repr__(self):
130         return "<%s%s %s>" % (self.output, (" %s..%s" % (self.edid[:5], self.edid[-5:])) if self.edid else "", " ".join(self.option_vector))
131
132     @property
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:
136             return self.options
137         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)
143         return options
144
145     @property
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())], [])
149
150     @property
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())])
154
155     @property
156     def sort_key(self):
157         "Return a key to sort the outputs for xrandr invocation"
158         if not self.edid:
159             return -1
160         if "pos" in self.options:
161             x, y = map(float, self.options["pos"].split("x"))
162         else:
163             x, y = 0, 0
164         return x + 10000 * y
165
166     def __init__(self, output, edid, options):
167         "Instanciate using output name, edid and a dictionary of XRandR command line parameters"
168         self.output = output
169         self.edid = edid
170         self.options = options
171         self.remove_default_option_values()
172
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 }
177             return
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]
181
182     @classmethod
183     def from_xrandr_output(cls, xrandr_output):
184         """Instanciate an XrandrOutput from the output of `xrandr --verbose'
185
186         This method also returns a list of modes supported by the output.
187         """
188         try:
189             match_object = re.search(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
190         except:
191             raise RuntimeError("Parsing XRandR output failed, there is an error in the regular expression.")
192         if not match_object:
193             debug = debug_regexp(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
194             raise RuntimeError("Parsing XRandR output failed, the regular expression did not match: %s" % debug)
195         remainder = xrandr_output[len(match_object.group(0)):]
196         if remainder:
197             raise RuntimeError(("Parsing XRandR output failed, %d bytes left unmatched after regular expression,"
198                                 "starting with ..'%s'.") % (len(remainder), remainder[:10]))
199
200
201         match = match_object.groupdict()
202
203         modes = []
204         if match["modes"]:
205             modes = [ x.groupdict() for x in re.finditer(XrandrOutput.XRANDR_OUTPUT_MODES_REGEXP, match["modes"]) ]
206             if not modes:
207                 raise RuntimeError("Parsing XRandR output failed, couldn't find any display modes")
208
209         options = {}
210         if not match["connected"]:
211             options["off"] = None
212             edid = None
213         elif not match["width"]:
214             options["off"] = None
215             edid = "".join(match["edid"].strip().split())
216         else:
217             if match["mode_width"]:
218                 options["mode"] = "%sx%s" % (match["mode_width"], match["mode_height"])
219             else:
220                 if match["rotate"] not in ("left", "right"):
221                     options["mode"] = "%sx%s" % (match["width"], match["height"])
222                 else:
223                     options["mode"] = "%sx%s" % (match["height"], match["width"])
224             options["rotate"] = match["rotate"]
225             if match["primary"]:
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)
242             if match["gamma"]:
243                 gamma = match["gamma"].strip()
244                 options["gamma"] = gamma
245             if match["rate"]:
246                 options["rate"] = match["rate"]
247             edid = "".join(match["edid"].strip().split())
248
249         return XrandrOutput(match["output"], edid, options), modes
250
251     @classmethod
252     def from_config_file(cls, edid_map, configuration):
253         "Instanciate an XrandrOutput from the contents of a configuration file"
254         options = {}
255         for line in configuration.split("\n"):
256             if line:
257                 line = line.split(None, 1)
258                 options[line[0]] = line[1] if len(line) > 1 else None
259
260         edid = None
261
262         if options["output"] in edid_map:
263             edid = edid_map[options["output"]]
264         else:
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"]
275
276         return XrandrOutput(output, edid, options)
277
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
286
287     def __eq__(self, other):
288         return self.edid_equals(other) and self.output == other.output and self.options == other.options
289
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()
294         try:
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")
299
300     return xrandr_version.version
301
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"
304     try:
305         import regex
306         bounds = ( 0, len(string) )
307         while bounds[0] != bounds[1]:
308             half = int((bounds[0] + bounds[1]) / 2)
309             if half == bounds[0]:
310                 break
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]))
316     except ImportError:
317         pass
318     return "Debug information available if `regex' module is installed."
319
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")
325
326     # We are not interested in screens
327     xrandr_output = re.sub("(?m)^Screen [0-9].+", "", xrandr_output).strip()
328
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
337         if output_modes:
338             modes[output_name] = output_modes
339
340     return outputs, modes
341
342 def load_profiles(profile_path):
343     "Load the stored profiles"
344
345     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):
350             continue
351
352         edids = dict([ x.strip().split() for x in open(setup_name).readlines() ])
353
354         config = {}
355         buffer = []
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))
359                 buffer = [ line ]
360             else:
361                 buffer.append(line)
362
363         for output_name in list(config.keys()):
364             if config[output_name].edid is None:
365                 del config[output_name]
366
367         profiles[profile] = config
368
369     return profiles
370
371 def find_profile(current_config, profiles):
372     "Find a profile matching the currently connected outputs"
373     for profile_name, profile in profiles.items():
374         matches = True
375         for name, output in profile.items():
376             if not output.edid:
377                 continue
378             if name not in current_config or not output.edid_equals(current_config[name]):
379                 matches = False
380                 break
381         if not matches or any(( name not in profile.keys() for name in current_config.keys() if current_config[name].edid )):
382             continue
383         if matches:
384             return profile_name
385
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):
390         return False
391     return subprocess.call(script) == 0
392
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)
398
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)
405
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)
414
415 def apply_configuration(configuration, dry_run=False):
416     "Apply a configuration"
417     outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
418     if dry_run:
419         base_argv = [ "echo", "xrandr" ]
420     else:
421         base_argv = [ "xrandr" ]
422
423     # Disable all unused outputs
424     argv = base_argv[:]
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:
430             return False
431
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:
436             return False
437
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 })
443
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 = {}
454                 if output in modes:
455                     configuration[output].options["mode"] = "%sx%s" % common_resolution[-1]
456                     configuration[output].options["pos"] = "0x0"
457                 else:
458                     configuration[output].options["off"] = None
459     elif profile_name in ("horizontal", "vertical"):
460         shift = 0
461         if profile_name == "horizontal":
462             shift_index = "width"
463             pos_specifier = "%sx0"
464         else:
465             shift_index = "height"
466             pos_specifier = "0x%s"
467
468         for output in configuration:
469             configuration[output].options = {}
470             if output in modes:
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])
476             else:
477                 configuration[output].options["off"] = None
478     return configuration
479
480 def exit_help():
481     "Print help and exit"
482     print(help_text)
483     for profile in virtual_profiles:
484         print("  %-10s %s" % profile[:2])
485     sys.exit(0)
486
487 def exec_scripts(profile_path, script_name):
488     "Run userscripts"
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)
492
493 def main(argv):
494     try:
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:
497         print(str(e))
498         options = { "--help": True }
499
500     profile_dir = os.path.expanduser("~/.autorandr")
501     if not os.path.isdir(profile_dir):
502         profile_dir = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr")
503
504     profile_path = os.path.join(profile_dir, "profiles")
505
506     try:
507         profiles = load_profiles(profile_path)
508     except OSError as e:
509         if e.errno == 2: # No such file or directory
510             profiles = {}
511         else:
512             raise e
513     except Exception as e:
514         print("Failed to load profiles:\n%s" % str(e), file=sys.stderr)
515         sys.exit(1)
516
517     try:
518         config, modes = parse_xrandr_output()
519     except Exception as e:
520         print("Failed to parse current configuration from XRandR:\n%s" % str(e), file=sys.stderr)
521         sys.exit(1)
522
523     if "--fingerprint" in options:
524         output_setup(config, sys.stdout)
525         sys.exit(0)
526
527     if "--config" in options:
528         output_configuration(config, sys.stdout)
529         sys.exit(0)
530
531     if "-s" in options:
532         options["--save"] = options["-s"]
533     if "--save" in options:
534         if options["--save"] in ( x[0] for x in virtual_profiles ):
535             print("Cannot save current configuration as profile '%s':\nThis configuration name is a reserved virtual configuration." % options["--save"])
536             sys.exit(1)
537         try:
538             save_configuration(os.path.join(profile_path, options["--save"]), config)
539         except Exception as e:
540             print("Failed to save current configuration as profile '%s':\n%s" % (options["--save"], str(e)), file=sys.stderr)
541             sys.exit(1)
542         print("Saved current configuration as profile '%s'" % options["--save"])
543         sys.exit(0)
544
545     if "-h" in options or "--help" in options:
546         exit_help()
547
548     detected_profile = find_profile(config, profiles)
549     load_profile = False
550
551     if "-l" in options:
552         options["--load"] = options["-l"]
553     if "--load" in options:
554         load_profile = options["--load"]
555     else:
556         for profile_name in profiles.keys():
557             if profile_blocked(os.path.join(profile_path, profile_name)):
558                 print("%s (blocked)" % profile_name, file=sys.stderr)
559                 continue
560             if detected_profile == profile_name:
561                 print("%s (detected)" % profile_name, file=sys.stderr)
562                 if "-c" in options or "--change" in options:
563                     load_profile = detected_profile
564             else:
565                 print(profile_name, file=sys.stderr)
566
567     if "-d" in options:
568         options["--default"] = options["-d"]
569     if not load_profile and "--default" in options:
570         load_profile = options["--default"]
571
572     if load_profile:
573         if load_profile in ( x[0] for x in virtual_profiles ):
574             profile = generate_virtual_profile(config, modes, load_profile)
575         else:
576             try:
577                 profile = profiles[load_profile]
578             except KeyError:
579                 print("Failed to load profile '%s':\nProfile not found" % load_profile, file=sys.stderr)
580                 sys.exit(1)
581         add_unused_outputs(config, profile)
582         if profile == dict(config) and not "-f" in options and not "--force" in options:
583             print("Config already loaded", file=sys.stderr)
584             sys.exit(0)
585
586         try:
587             if "--dry-run" in options:
588                 apply_configuration(profile, True)
589             else:
590                 exec_scripts(os.path.join(profile_path, load_profile), "preswitch")
591                 apply_configuration(profile, False)
592                 exec_scripts(os.path.join(profile_path, load_profile), "postswitch")
593         except Exception as e:
594             print("Failed to apply profile '%s':\n%s" % (load_profile, str(e)), file=sys.stderr)
595             sys.exit(1)
596
597     sys.exit(0)
598
599 if __name__ == '__main__':
600     try:
601         main(sys.argv)
602     except Exception as e:
603         print("General failure. Please report this as a bug:\n%s" % (str(e),), file=sys.stderr)
604         sys.exit(1)