Merge pull request #23 from adafruit/pyvirtualdisplay-example

Pyvirtualdisplay example

examples/virtualdisplay.py

@@ -0,0 +1,64 @@
+#!/usr/bin/python3
+"""
+Display a (possibly scaled) X session to a matrix
+
+The display runs until the graphical program exits.
+
+The display doesn't get a keyboard or mouse, so you have to use a program that
+will get its input in some other way, such as from a gamepad.
+
+For help with commandline arguments, run `python virtualdisplay.py --help`
+
+This needs additional software to be installed (besides a graphical program to run). At a minimum you have to
+install a virtual display server program (xvfb) and the pyvirtualdisplay importable Python module:
+
+    $ sudo apt install -y xvfb
+    $ pip install pyvirtualdisplay
+
+Here's an example for running an emulator using a rom stored in "/tmp/snesrom.smc" on a virtual 128x128 panel made from 4 64x64 panels:
+
+    $ python virtualdisplay.py --pinout AdafruitMatrixHatBGR  --scale 2 --backend xvfb  --width 128 --height 128  --serpentine --num-address-lines 5 --num-planes 4  -- mednafen -snes.xscalefs 1 -snes.yscalefs 1 -snes.xres 128 -video.fs 1 -video.driver softfb  /tmp/snesrom.smc
+"""
+
+# To run a nice emulator:
+
+
+import shlex
+from subprocess import Popen
+
+import adafruit_blinka_raspberry_pi5_piomatter as piomatter
+import click
+import numpy as np
+import piomatter_click
+from pyvirtualdisplay.smartdisplay import SmartDisplay
+
+
+@click.command
+@click.option("--scale", type=float, help="The scale factor, larger numbers mean more virtual pixels",  default=1)
+@click.option("--backend", help="The pyvirtualdisplay backend to use",  default="xvfb")
+@click.option("--extra-args", help="Extra arguments to pass to the backend server",  default="")
+@click.option("--rfbport", help="The port number for the --backend xvnc",  default=None, type=int)
+@click.option("--use-xauth/--no-use-xauth", help="If a Xauthority file should be created",  default=False)
+@piomatter_click.standard_options
+@click.argument("command", nargs=-1)
+def main(scale, backend, use_xauth, extra_args, rfbport, width, height, serpentine, rotation, pinout, n_planes, n_addr_lines, command):
+    kwargs = {}
+    if backend == "xvnc":
+        kwargs['rfbport'] = rfbport
+    if extra_args:
+        kwargs['extra_args'] = shlex.split(extra_args)
+    print("xauth", use_xauth)
+    geometry = piomatter.Geometry(width=width, height=height, n_planes=n_planes, n_addr_lines=n_addr_lines, rotation=rotation)
+    framebuffer = np.zeros(shape=(geometry.height, geometry.width, 3), dtype=np.uint8)
+    matrix = piomatter.PioMatter(colorspace=piomatter.Colorspace.RGB888Packed, pinout=pinout, framebuffer=framebuffer, geometry=geometry)
+
+    with SmartDisplay(backend=backend, use_xauth=use_xauth, size=(round(width*scale),round(height*scale)), manage_global_env=False, **kwargs) as disp, Popen(command, env=disp.env()) as proc:
+            while proc.poll() is None:
+                img = disp.grab(autocrop=False)
+                if img is None:
+                    continue
+                img = img.resize((width, height))
+                framebuffer[:, :] = np.array(img)
+                matrix.show()
+if __name__ == '__main__':
+    main()

src/pymain.cpp

@@ -137,7 +137,7 @@ PYBIND11_MODULE(adafruit_blinka_raspberry_pi5_piomatter, m) {
                "Adafruit Matrix Bonnet or Matrix Hat with BGR color order")
         .value("AdafruitMatrixHat", Pinout::AdafruitMatrixBonnet,
                "Adafruit Matrix Bonnet or Matrix Hat")
-        .value("AdafruitMatrixHatBGR", Pinout::AdafruitMatrixBonnet,
+        .value("AdafruitMatrixHatBGR", Pinout::AdafruitMatrixBonnetBGR,
                "Adafruit Matrix Bonnet or Matrix Hat with BGR color order");
 
     py::enum_<Colorspace>(