Add support for storing the rendered video in a video file

Add example gif to README.md

README.md

@@ -1,7 +1,9 @@
-## foosball-ai  
+## foosball-ai
 [![codecov](https://codecov.io/gh/DarwinsBuddy/foosball-ai/branch/main/graph/badge.svg?token=ACYNOG1WFW)](https://codecov.io/gh/DarwinsBuddy/foosball-ai)
 [![Tests](https://github.com/DarwinsBuddy/foosball-ai/actions/workflows/test.yml/badge.svg)](https://github.com/DarwinsBuddy/foosball-ai/actions/workflows/test.yml)
 
+![example gif of a tracked goal](https://github.com/DarwinsBuddy/foosball-ai/blob/main/misc/example.gif)
+
 This software is designed to take a camera feed or a video file as an input of a match played
 on a foosball table (🇦🇹 Wuzzler), track the ball and count goals.
 

foosball/__init__.py

@@ -45,6 +45,7 @@ def get_argparse():
                          "If no file present fallback to 'yellow'")
     ap.add_argument("-v", "--verbose", action='store_true', help="Verbose")
     ap.add_argument("-o", "--off", action='store_true', help="Disable ai")
+    ap.add_argument("-out", "--output", default=None, help="path to store (optional) a rendered video")
     ap.add_argument("-q", "--headless", action='store_true', help="Disable visualizations")
     ap.add_argument("-b", "--buffer", type=int, default=16, help="max track buffer size")
     ap.add_argument("-xp", "--xpad", type=int, default=50,

foosball/tracking/ai.py

@@ -3,6 +3,7 @@
 from queue import Empty
 
 from imutils.video import FPS
+from vidgear.gears import WriteGear
 
 from . import Tracking, get_ball_config, get_goal_config
 from .render import r_text, BLACK
@@ -28,6 +29,8 @@ def __init__(self, stream: Stream, dis, *args, **kwargs):
         self.ball_config = get_ball_config(self.kwargs.get('ball'))
         self.goals_config = get_goal_config()
 
+        self.output = None if kwargs.get('output') is None else WriteGear(kwargs.get('output'), logging=True)
+
         if self.calibration is not None:
             self.calibration_config = lambda: self.ball_config if self.calibration == 'ball' else self.goals_config
         self.detection_frame = None
@@ -102,6 +105,8 @@ def step_frame():
                     if not self.headless:
                         self.render_fps(f, fps)
                         self.display.show(f)
+                        if self.output is not None:
+                            self.output.write(f)
                         if self.calibration is not None:
                             self.render_calibration()
                         if self.display.render(callbacks=callbacks):