v1.5.14

actions-user · actions-user · commit 6123232736e9 · 2024-11-14T16:30:01.000Z
diff --git a/README.md b/README.md
@@ -254,7 +254,7 @@ The `.env` [file](https://docs.docker.com/compose/environment-variables/set-envi
 
 ```bash
 echo "MY_VARIABLE=24" >  sio/conf/user.env
-echo "SIO_DOCKER_TAG=r240909" >  sio/conf/0009-debug.env
+echo "SIO_DOCKER_TAG=r241014" >  sio/conf/0009-debug.env
 ```
 
 And then update the services (create the .env file for docker-compose) by running:
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,5 +1,11 @@
 # Release Notes
 
+
+## v1.5.14
+
+- Update SIO to r241014
+- Add comments to config of StandaloneSIOWithExtension
+
 ## v1.5.13
 
 - ALPRDemo: improve UI experience, fix README typos
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v1.5.13
+v1.5.14
diff --git a/deployment-examples/ALPRDemo/docker-compose.yml b/deployment-examples/ALPRDemo/docker-compose.yml
@@ -23,7 +23,7 @@ services:
 
   # ========================= SIO ALPR Analytics =========================
   analytics_svc:
-    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r240909}${SIO_DOCKER_TAG_VARIANT}
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r241014}${SIO_DOCKER_TAG_VARIANT}
     restart: unless-stopped
     environment:
       # Location where SIO will place generated model engine files
diff --git a/deployment-examples/README.md b/deployment-examples/README.md
@@ -4,7 +4,10 @@ Sample deployments in this folder demonstrate how to accomplish specific tasks u
 
 The following samples are available:
 
+* `ALPRDemo` - an end-to-end sample for live stream and watched folder analytics, an analytics output consumer, simple database integration, and REST API for querying the generated results, and a wxPython UI for visualizing the output.
 * `ClientLib` - a collection of Python classes to use as base for sample client apps, and shell scripts for running those apps
 * `SighthoundRestApiGateway` - a deployment in which `VehicleAnalytics` pipeline is deployed with a REST API gateway in front of it, enabling image annotation API, with an optional UI front end.
+* `SIOOnDemandAnalytics` - folder watch/live stream monitoring deployed side-by-side, with a REST gateway in front of both.
+* `StandaloneSIOWithExtension` - demonstrates deployment of SIO without message bus integration, using pipeline extensions as a method for an alternative egress (to file/standard output or REST endpoint) and/or additional output filtering.
 * `VideoStreamsConsumer` - a deployment in which `VehicleAnalytics` pipeline consumes multiple video streams from live RTSP sources, and emits analytics output to AMQP broker deployed locally.
 * `VideoStreamsRecorder` - similar to `VideoStreamConsumer`, but also generates video recordings and images as part of its analytics output. `MCP` service is deployed for providing access to and managing the generated media
diff --git a/deployment-examples/SIOOnDemandAnalytics/docker-compose.yml b/deployment-examples/SIOOnDemandAnalytics/docker-compose.yml
@@ -17,7 +17,7 @@ services:
 
   # The actual analytics container
   analytics:
-    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r240909}${SIO_DOCKER_TAG_VARIANT-}
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r241014}${SIO_DOCKER_TAG_VARIANT-}
     restart: unless-stopped
     environment:
       # Location where SIO will place generated model engine files
diff --git a/deployment-examples/SighthoundRestApiGateway/docker-compose.yml b/deployment-examples/SighthoundRestApiGateway/docker-compose.yml
@@ -2,7 +2,7 @@ version: "3"
 services:
 
   analytics:
-    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r240909}${SIO_DOCKER_TAG_VARIANT-}
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r241014}${SIO_DOCKER_TAG_VARIANT-}
     restart: unless-stopped
     environment:
       # Location where SIO will place generated model engine files
diff --git a/deployment-examples/StandaloneSIOWithExtension/README.md b/deployment-examples/StandaloneSIOWithExtension/README.md
@@ -17,13 +17,13 @@ Ensure `./StandaloneSIOWithExtension/data/input` exists prior to starting the se
 Next, open a terminal, `cd` into the `./StandaloneSIOWithExtension/` folder, and run the following command to start the services:
 
 ```bash
-docker compose up -d
+docker compose -f docker-compose.yml up -d
 ```
 
 If you have an NVIDIA GPU installed and properly configured, you can run the following command instead to enable GPU acceleration:
 
 ```bash
-SIO_DOCKER_RUNTIME=nvidia docker compose up -d
+SIO_DOCKER_RUNTIME=nvidia docker compose -f docker-compose.yml up -d
 ```
 
 You can then deposit images and videos into `./StandaloneSIOWithExtension/data/input` and watch the output being printed as those are being procesed.
@@ -43,6 +43,16 @@ camera deployed in such non-deterministic way - thus assuming that monitoring th
 ensures we're not going to analyze objects outside of the bottom right quadrant ROI (`lp_roiFilter` accomplishes that), and won't analyze objects below size threshold (`vehicle_SizeFilter`
 and `lp_SizeFilter` filters accomplish that).
 
+To run this sample, replace `docker-compose.yml` with `docker-compose-rtsp.yml` in the commands above.
+
+## Running the REST gateway sample
+
+REST gateway sample is a variation of RTSP sample, where instead of a more elaborate post-processing of the results,
+they're being sent to a REST API endpoint for further processing.
+
+The sample includes a dummy REST API server.
+
+To run this sample, replace `docker-compose.yml` with `docker-compose-rest.yml` in the commands above.
 
 ## OS Compatibility
 
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/aggregatorExtension.py b/deployment-examples/StandaloneSIOWithExtension/config/analytics/aggregatorExtension.py
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/aggregatorExtensionConfig.json b/deployment-examples/StandaloneSIOWithExtension/config/analytics/aggregatorExtensionConfig.json
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/pipelines-rest-client.json b/deployment-examples/StandaloneSIOWithExtension/config/analytics/pipelines-rest-client.json
@@ -0,0 +1,46 @@
+{
+    "unifiedEU-US" : {
+        "pipeline"      : "./share/pipelines/VehicleAnalytics/VehicleAnalyticsRTSP.yaml",
+        "restartPolicy" : "restart",
+        "parameters" : {
+            "VIDEO_IN"  : "rtsp://live555_svc:554/Turn-02.mkv",
+            "boxFilterConfig" : "/config/analytics/boxFilter-rtsp.json",
+            "detectionModel" : "gen7es",
+            "lptFilter" : "['us']",
+            "mmcFilter" :  "['us']",
+            "lptMinConfidence" : "0.5",
+            "sourceId" : "fw-1",
+            "useTracker" : "true",
+
+            "_extensionModules" : "Specify extension and its corresponding configuration. Multiple may be separated with comma",
+            "extensionModules" : "/config/analytics/restGatewayExtension.py",
+            "extensionConfigurations" : "/config/analytics/restGatewayExtensionConfig.json",
+
+            "_lptPreferAccuracyToSpeed" : "This marginally improves accuracy. Not recommended for constrained/embedded systems",
+            "lptPreferAccuracyToSpeed" : "false",
+
+            "_maxQueueSize" : "Do not let the processing delay build up more than 1s",
+            "maxQueueSize" : "5",
+
+            "_fpsLimit" : "Normalize incoming frame rate to analyze to this fps",
+            "fpsLimit" : "5",
+
+            "_lptStabilizationDelay" : "Delay the result for up to this many frames to help it stabilize",
+            "lptStabilizationDelay" : "3",
+
+            "_updateOnlyOnChange" : "Only emit output when something changes about the object ...",
+            "updateOnlyOnChange" : "true",
+
+            "_updateOnImprovedScore" : "... but also include updates when score improves",
+            "updateOnImprovedScore" : "true",
+
+            "_lptSkipCarsWithoutLPs" : "Include information about vehicles, even if no LPs are associated with them",
+            "lptSkipCarsWithoutLPs" : "false",
+
+            "_debugSettings" : "Can set to something like 'log,json', if more information about the decision making is needed",
+            "debugSettings" : ""
+        },
+        "disabledParameters" : {
+        }
+    }
+}
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/pipelines-rtsp.json b/deployment-examples/StandaloneSIOWithExtension/config/analytics/pipelines-rtsp.json
@@ -11,8 +11,8 @@
             "lptMinConfidence" : "0.5",
             "sourceId" : "fw-1",
             "lptPreferAccuracyToSpeed" : "true",
-            "extensionModules" : "/config/analytics/extension.py",
-            "extensionConfigurations" : "/config/analytics/extensionConfig1.json",
+            "extensionModules" : "/config/analytics/aggregatorExtension.py",
+            "extensionConfigurations" : "/config/analytics/aggregatorExtensionConfig.json",
             "useTracker" : "true",
             "updateOnlyOnChange" : "true",
             "lptStabilizationDelay" : "5",
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/pipelines.json b/deployment-examples/StandaloneSIOWithExtension/config/analytics/pipelines.json
@@ -15,8 +15,8 @@
             "lptMinConfidence" : "0.5",
             "sourceId" : "fw-1",
             "lptPreferAccuracyToSpeed" : "true",
-            "extensionModules" : "/config/analytics/extension.py",
-            "extensionConfigurations" : "/config/analytics/extensionConfig1.json",
+            "extensionModules" : "/config/analytics/aggregatorExtension.py",
+            "extensionConfigurations" : "/config/analytics/aggregatorExtensionConfig.json",
             "useTracker" : "true",
             "updateOnlyOnChange" : "true",
             "lptStabilizationDelay" : "5",
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/restGatewayExtension.py b/deployment-examples/StandaloneSIOWithExtension/config/analytics/restGatewayExtension.py
@@ -0,0 +1,116 @@
+#
+# A sample extension to relay SIO output to REST API
+# The operation is performed asynchronously, to avoid holding up the pipeline on possible server delays
+#
+
+import sys
+import os
+import json
+import traceback
+import time
+import threading
+import requests
+import io
+from PIL import Image
+
+
+# ------------------------------------------------------------------------------------
+# Plugin
+#   - asynchronously POSTs SIO results to REST endpoint
+#   - aggregates results from multiple frames
+# ------------------------------------------------------------------------------------
+class SIOPlugin:
+    # -------------------------------------------------------------------------------
+    def __init__(self):
+        self.pendingOutputs = {}
+        self.mutex = threading.Lock()
+        self.data_event = threading.Event()
+        self.finalized = False
+        self.api_url = ""
+        self.thread = threading.Thread(target=self.run)
+        self.thread.start()
+
+    # -------------------------------------------------------------------------------
+    def postBatch(self, dataToPost):
+        items = len(dataToPost)
+        if items == 0:
+            return
+        files = {}
+
+        # Loop through each buffer and JSON blob, and add them to files with unique keys
+        for key in dataToPost:
+            # Add the image file to the files dictionary with a unique name
+            files[f'image_{key}'] = ('image.jpg', dataToPost[key][1], 'image/jpeg')
+            # Add the JSON data as a text file to the files dictionary with a unique name
+            files[f'json_{key}'] = (None, dataToPost[key][0], 'application/json')
+
+        # Send the POST request
+        print(f"Posting a batch of {items} outputs to {self.api_url}")
+        if self.api_url:
+            response = requests.post(self.api_url, files=files)
+
+            # Print response
+            if response.status_code != 200:
+                print(f"Failed to upload series. Status code: {response.status_code}")
+                print(response.text)
+
+
+    # -------------------------------------------------------------------------------
+    def run(self):
+        while not self.finalized:
+            self.data_event.wait()  # Wait for data to be deposited or stop signal
+            self.mutex.acquire()
+            dataToPost = self.pendingOutputs
+            self.pendingOutputs = {}
+            self.mutex.release()
+            self.data_event.clear()  # Clear the event until new data arrives
+
+            # POST the data
+            self.postBatch(dataToPost)
+
+    # -------------------------------------------------------------------------------
+    # Methods each SIOPlugin has to implement
+    # -------------------------------------------------------------------------------
+    # Prepare the module using provided configuration
+    def configure(self, configJsonPath):
+        try:
+            with open(configJsonPath) as configJsonFile:
+                config = json.load(configJsonFile)
+                self.api_url = config.get("restUri","")
+        except:
+            print(f"Failed to load extension module configuration from {configJsonPath}")
+            raise
+
+    # -------------------------------------------------------------------------------
+    # Process the output
+    def process(self, tick, frameDataStr, frame):
+        if not frameDataStr:
+            return frameDataStr
+
+        try:
+            message = json.loads(frameDataStr)
+            w = int(message.get("frameDimensions", {}).get("w", "0"))
+            h = int(message.get("frameDimensions", {}).get("h", "0"))
+
+            # save the image to blob
+            image = Image.frombytes("RGB", (w, h), frame)
+            jpg_buffer = io.BytesIO()
+            image.save(jpg_buffer, format="JPEG")
+            jpg_buffer.seek(0)
+
+            self.mutex.acquire()
+            self.pendingOutputs[tick] = (frameDataStr, jpg_buffer)
+            self.data_event.set()
+            self.mutex.release()
+        except:
+            print(f"Exception - \n{traceback.format_exc()}")
+
+        # always return the (potentially filtered or modified) output
+        return frameDataStr
+
+    # -------------------------------------------------------------------------------
+    # Finalize the module
+    def finalize(self):
+        self.finalized = True
+        self.data_event.set()       # Wake up the thread if it's waiting
+        self.thread.join()           # Wait for the thread to finish
diff --git a/deployment-examples/StandaloneSIOWithExtension/config/analytics/restGatewayExtensionConfig.json b/deployment-examples/StandaloneSIOWithExtension/config/analytics/restGatewayExtensionConfig.json
@@ -0,0 +1,4 @@
+{
+    "restUri" : "http://rest_svc:5000/upload"
+}
+
diff --git a/deployment-examples/StandaloneSIOWithExtension/docker-compose-rest-client.yml b/deployment-examples/StandaloneSIOWithExtension/docker-compose-rest-client.yml
@@ -0,0 +1,67 @@
+version: '2.3'
+services:
+
+  # By default pipelines.json will point to streams served by this container.
+  # If you point to your own cameras or streams, this container has no other
+  # function and can be disabled.
+  live555_svc:
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/live555:2.0.4-examples
+    container_name: sample-live555
+    restart: unless-stopped
+    ports:
+      - "8554:554"
+    volumes:
+      # A local folder we can drop videos into and have those references via RTSP URI
+      # Keep in mind, the videos need to be H264 MKV to be properly served by the server
+      - ${DEMO_VIDEO-./videos}:/mnt/data
+    networks:
+      - core_sighthound
+
+  analytics:
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r241014}${SIO_DOCKER_TAG_VARIANT}
+    restart: unless-stopped
+    environment:
+      # Location where SIO will place generated model engine files
+      - SIO_DATA_DIR=/data/.sio
+      # We need this to see output from Python extension module
+      - PYTHONUNBUFFERED=1
+    # Container runtime defaults to `runc` if SIO_DOCKER_RUNTIME not set. Use `nvidia` if GPU is installed.
+    runtime: ${SIO_DOCKER_RUNTIME-runc}
+    volumes:
+      # Read-only shared folder for data exchange with host / other containers.
+      # We'll use it for license, config files, etc.
+      - ./config:/config:ro
+      # Writable shared folder for data exchange with host
+      # We'll use it for storing the generated model files, data exchange folder, etc.
+      - ${HOME-./data}:/data
+    entrypoint:
+      - /sighthound/sio/bin/runPipelineSet
+      # Pipeline configuration file
+      - /config/analytics/pipelines-rest-client.json
+      # License at the path accessible in the container
+      - --license-path=/config/sighthound-license.json
+      # Log level (info, debug, trace)
+      - --log=${SIO_LOG_LEVEL-info}
+    depends_on:
+      # This dependency can be removed with live555 if no longer necessary.
+      - live555_svc
+      - rest_svc
+    networks:
+      - core_sighthound
+
+
+  rest_svc:
+    build:
+      context: util/RestStub
+      dockerfile: Dockerfile
+    restart: unless-stopped
+    networks:
+      core_sighthound:
+        aliases:
+          - rest_svc
+
+
+networks:
+  core_sighthound:
+    external: false
+    driver: bridge
diff --git a/deployment-examples/StandaloneSIOWithExtension/docker-compose-rtsp.yml b/deployment-examples/StandaloneSIOWithExtension/docker-compose-rtsp.yml
@@ -1,4 +1,4 @@
-version: "2.3"
+version: '2.3'
 services:
 
   # By default pipelines.json will point to streams served by this container.
@@ -17,7 +17,7 @@ services:
 
 
   analytics:
-    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r240909}${SIO_DOCKER_TAG_VARIANT}
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r241014}${SIO_DOCKER_TAG_VARIANT}
     restart: unless-stopped
     environment:
       # Location where SIO will place generated model engine files
diff --git a/deployment-examples/StandaloneSIOWithExtension/docker-compose.yml b/deployment-examples/StandaloneSIOWithExtension/docker-compose.yml
@@ -1,8 +1,8 @@
-version: "2.3"
+version: '2.3'
 services:
 
   analytics:
-    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r240909}${SIO_DOCKER_TAG_VARIANT}
+    image: us-central1-docker.pkg.dev/ext-edge-analytics/docker/sio:${SIO_RELEASE-r241014}${SIO_DOCKER_TAG_VARIANT}
     restart: unless-stopped
     environment:
       # Location where SIO will place generated model engine files
diff --git a/deployment-examples/StandaloneSIOWithExtension/util/RestStub/Dockerfile b/deployment-examples/StandaloneSIOWithExtension/util/RestStub/Dockerfile
@@ -0,0 +1,12 @@
+FROM python:3.9
+
+WORKDIR /usr/src/app
+COPY restServerStub.py /usr/src/app/
+RUN pip3 install flask pillow
+
+ENV PYTHONPATH=${PYTHONPATH}:/usr/src/app:/usr/src/app/common:/usr/src/app/lib
+ENV PYTHONUNBUFFERED=1
+
+
+
+ENTRYPOINT [ "python3", "/usr/src/app/restServerStub.py" ]
diff --git a/deployment-examples/StandaloneSIOWithExtension/util/RestStub/restServerStub.py b/deployment-examples/StandaloneSIOWithExtension/util/RestStub/restServerStub.py
diff --git a/deployment-examples/VideoStreamsConsumer/docker-compose.yml b/deployment-examples/VideoStreamsConsumer/docker-compose.yml
diff --git a/deployment-examples/VideoStreamsRecorder/docker-compose.yml b/deployment-examples/VideoStreamsRecorder/docker-compose.yml
diff --git a/docs/schemas/anypipe/anypipe.html b/docs/schemas/anypipe/anypipe.html
diff --git a/services/sio/conf/default.env b/services/sio/conf/default.env
