remote: client: add video --fps option

The video modes reported by a video device aren't necessarily possible in
practice, e.g. because it is connected via USB 2.0 instead of USB 3.0.

To allow for an easy evaluation of video devices and how they're
connected, expose the newly added fps feature in USBVideoDriver as
--fps command line option.

Signed-off-by: Ahmad Fatoum <[email protected]>

Author: a3f

CHANGES.rst

@@ -13,6 +13,7 @@ New Features in 25.1
 
 - The `USBVideoDriver`'s ``stream`` method can now be called with ``fps=True``
   to embed an overlay with FPS statistics into the video stream.
+  This is exposed in ``labgrid-client video`` via the new ``--fps`` option.
 
 Breaking changes in 25.1
 ~~~~~~~~~~~~~~~~~~~~~~~~

contrib/completion/labgrid-client.bash

@@ -661,7 +661,7 @@ _labgrid_client_video()
 
     case "$cur" in
     -*)
-        COMPREPLY=( $(compgen -W "--quality --controls --name $_labgrid_shared_options" -- "$cur") )
+        COMPREPLY=( $(compgen -W "--quality --controls --fps --name $_labgrid_shared_options" -- "$cur") )
         ;;
     esac
 }

labgrid/remote/client.py

@@ -1313,6 +1313,7 @@ def telnet(self):
     def video(self):
         place = self.get_acquired_place()
         quality = self.args.quality
+        fps = self.args.fps
         controls = self.args.controls
         target = self._get_target(place)
         name = self.args.name
@@ -1342,7 +1343,7 @@ def video(self):
                 mark = "*" if default == name else " "
                 print(f"{mark} {name:<10s} {caps:s}")
         else:
-            res = drv.stream(quality, controls=controls)
+            res = drv.stream(quality, controls=controls, fps=fps)
             if res:
                 exc = InteractiveCommandError("gst-launch-1.0 error")
                 exc.exitcode = res
@@ -1972,6 +1973,7 @@ def main():
 
     subparser = subparsers.add_parser("video", help="start a video stream")
     subparser.add_argument("-q", "--quality", type=str, help="select a video quality (use 'list' to show options)")
+    subparser.add_argument("-f", "--fps", action='store_true', help="Overlay FPS statistics")
     subparser.add_argument(
         "-c", "--controls", type=str, help="configure v4l controls (such as 'focus_auto=0,focus_absolute=40')"
     )