streamgrid=1.0.6 Add analytics storage in CSV format for streams (#23)

Author: RizwanMunawar

README.md

@@ -32,6 +32,9 @@ StreamGrid(sources=sources, model=model)
 
 # Inference on GPU
 StreamGrid(sources=sources, device="cuda")
+
+# Store stream results in CSV file
+StreamGrid(sources=sources, analytics=True)
 ```
 
 ### CLI (Command Line Interface)
@@ -47,6 +50,9 @@ streamgrid model=yolo11n.pt device=cpu save=True
 
 # Pass source
 streamgrid model=yolo11n.pt sources=["video1.mp4", "video2.mp4"]
+
+# Store Stream results in CSV file
+streamgrid model=yolo11n.pt analytics=True
 ```
 
 ## Performance (Beta, final benchmarks will be released soon)

streamgrid/__init__.py

@@ -1,6 +1,6 @@
 """StreamGrid - Ultra-fast multi-stream video display."""
 
-__version__ = "1.0.5"
+__version__ = "1.0.6"
 __all__ = ["StreamGrid"]
 
 import argparse

streamgrid/analytics.py

@@ -0,0 +1,35 @@
+import csv
+import time
+from datetime import datetime
+from pathlib import Path
+
+
+class StreamAnalytics:
+    """Simple analytics logger for StreamGrid."""
+
+    def __init__(self, output_file="streamgrid_analytics.csv"):
+        self.output_file = Path(output_file)
+        self.start_time = time.time()
+
+        # Create CSV with headers
+        with open(self.output_file, 'w', newline='') as f:
+            writer = csv.writer(f)
+            writer.writerow(['timestamp', 'stream_id', 'detections', 'fps'])
+
+        print(f"📊 Analytics: {self.output_file}")
+
+    def log(self, stream_id, detections=0, fps=0.0):
+        """Log frame data."""
+        with open(self.output_file, 'a', newline='') as f:
+            writer = csv.writer(f)
+            writer.writerow([
+                datetime.now().strftime('%H:%M:%S'),
+                stream_id,
+                detections,
+                round(fps, 1)
+            ])
+
+    def summary(self):
+        """Print summary."""
+        uptime = time.time() - self.start_time
+        print(f"📊 Runtime: {uptime:.1f}s | Data saved: {self.output_file}")

streamgrid/grid.py

@@ -9,6 +9,7 @@
 import requests
 from tqdm import tqdm
 from streamgrid.utils import LOGGER, get_optimal_grid_size
+from streamgrid.analytics import StreamAnalytics
 from ultralytics.utils.plotting import Annotator, colors
 
 
@@ -39,7 +40,7 @@ class StreamGrid:
         video_writer: OpenCV video writer object.
     """
 
-    def __init__(self, sources=None, model=None, save=True, device="cpu"):
+    def __init__(self, sources=None, model=None, save=True, device="cpu", analytics=False):
         """Initialize StreamGrid with video sources and configuration.
 
         Args:
@@ -48,6 +49,7 @@ def __init__(self, sources=None, model=None, save=True, device="cpu"):
             model (optional): YOLO model instance for object detection.
             save (bool, optional): Save output video. Output will be saved as "streamgrid_output_{N}_streams.mp4".
             device (str, optional): Wheather to run inference on GPU or CPU device.
+            analytics (bool, optional): Wheather to store streams results in CSV file.
         """
         # GitHub repository URLs for default videos
         self.GITHUB_ASSETS_BASE = "https://github.com/RizwanMunawar/streamgrid/releases/download/v1.0.0/"
@@ -111,6 +113,7 @@ def __init__(self, sources=None, model=None, save=True, device="cpu"):
         self.auto_shutdown = True  # Control auto-shutdown behavior
         self.shutdown_delay = 3.0  # Seconds to wait after streams end before shutdown
 
+        self.analytics = StreamAnalytics() if analytics else None  # Enable analytics storage.
         self.run()
 
     def get_default_videos(self):
@@ -324,6 +327,9 @@ def update_source(self, source_id, frame, yolo_results=None):
                 detections = len(yolo_results.boxes)
                 resized = self.draw_boxes(resized, yolo_results, frame.shape[:2])
 
+            if self.analytics:
+                self.analytics.log(source_id, detections, self.prediction_fps)
+
             # Store processed frame and statistics
             self.frames[source_id] = resized
             self.stats[source_id] = {'detections': detections, 'time': time.time()}
@@ -531,6 +537,8 @@ def stop(self):
         for i, thread in enumerate(self.stream_threads):  # Wait for threads to finish (with timeout)
             thread.join(timeout=0.5)
 
+        if self.analytics:
+            self.analytics.summary()
 
         if self.save and self.video_writer:
             self.video_writer.release()