prerelease

* add OnOff to SecuritySystem accessory as a switch

* BFS to reorder devices + merge and skip devices

* add some comments

* more safety checks

* embarrassing moment where I forgot this isn't BFS

.github/workflows/test.yml

@@ -0,0 +1,60 @@
+name: Test
+
+on:
+  push:
+    branches: ["main"]
+    paths: ["docker/**", ".github/workflows/test.yml"]
+  pull_request:
+    paths: ["docker/**", ".github/workflows/test.yml"]
+  workflow_dispatch:
+  
+jobs:
+  test_linux_local:
+    name: Test Linux local installation
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        
+      - name: Run install script
+        run: |
+          cat ./docker/install-scrypted-dependencies-linux.sh | sudo SERVICE_USER=$USER bash
+          
+      - name: Test server is running
+        run: |
+          systemctl status scrypted.service
+          curl -k --retry 20 --retry-all-errors --retry-max-time 600 https://localhost:10443/
+          
+  test_mac_local:
+    name: Test Mac local installation
+    runs-on: macos-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        
+      - name: Run install script
+        run: |
+          mkdir -p ~/.scrypted
+          bash ./docker/install-scrypted-dependencies-mac.sh
+          
+      - name: Test server is running
+        run: |
+          curl -k --retry 20 --retry-all-errors --retry-max-time 600 https://localhost:10443/
+          
+  test_windows_local:
+    name: Test Windows local installation
+    runs-on: windows-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        
+      - name: Run install script
+        run: |
+          .\docker\install-scrypted-dependencies-win.ps1
+          
+      - name: Test server is running
+        run: |
+          curl -k --retry 20 --retry-all-errors --retry-max-time 600 https://localhost:10443/

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "plugins/homekit/HAP-NodeJS"]
-	path = external/HAP-NodeJS
-	url = ../../koush/HAP-NodeJS
 [submodule "plugins/unifi-protect/src/unifi-protect"]
 	path = external/unifi-protect
 	url = ../../koush/unifi-protect.git

common/src/rtsp-server.ts

@@ -13,6 +13,7 @@ import { readLength, readLine } from './read-stream';
 import { MSection, parseSdp } from './sdp-utils';
 import { sleep } from './sleep';
 import { StreamChunk, StreamParser, StreamParserOptions } from './stream-parser';
+import { URL } from 'url';
 
 const REQUIRED_WWW_AUTHENTICATE_KEYS = ['realm', 'nonce'];
 
@@ -580,7 +581,7 @@ export class RtspClient extends RtspBase {
         const username = decodeURIComponent(authedUrl.username);
         const password = decodeURIComponent(authedUrl.password);
 
-        const strippedUrl = new URL(url);
+        const strippedUrl = new URL(url.toString());
         strippedUrl.username = '';
         strippedUrl.password = '';
 

common/test/rtsp-proxy.ts

@@ -0,0 +1,56 @@
+import net from 'net';
+import { listenZero } from '../src/listen-cluster';
+import { RtspClient, RtspServer } from '../src/rtsp-server';
+
+async function main() {
+    const server = net.createServer(async serverSocket => {
+        const client = new RtspClient('rtsp://localhost:57594/911db962087f904d');
+        await client.options();
+        const describeResponse = await client.describe();
+        const sdp = describeResponse.body.toString();
+        const server = new RtspServer(serverSocket, sdp, true);
+        const setupResponse = await server.handlePlayback();
+        if (setupResponse !== 'play') {
+            serverSocket.destroy();
+            client.client.destroy();
+            return;
+        }
+        console.log('playback handled');
+
+        let channel = 0;
+        for (const track of Object.keys(server.setupTracks)) {
+            const setupTrack = server.setupTracks[track];
+            await client.setup({
+                // type: 'udp',
+
+                type: 'tcp',
+                port: channel,
+
+                path: setupTrack.control,
+                onRtp(rtspHeader, rtp) {
+                    server.sendTrack(setupTrack.control, rtp, false);
+                },
+            });
+
+            channel += 2;
+        }
+
+
+        await client.play();
+        console.log('client playing');
+        await client.readLoop();
+    });
+
+    let port: number;
+    if (false) {
+        port = await listenZero(server);
+    }
+    else {
+        port = 5555;
+        server.listen(5555)
+    }
+
+    console.log(`rtsp://127.0.0.1:${port}`);
+}
+
+main();

docker/Dockerfile.full

@@ -7,7 +7,9 @@
 # install script.
 ################################################################
 ARG BUILDPACK_DEPS_BASE="bullseye"
-FROM buildpack-deps:${BUILDPACK_DEPS_BASE} as header
+FROM debian:${BUILDPACK_DEPS_BASE} as header
+
+RUN apt-get update && apt-get -y install curl wget
 
 # switch to nvm?
 ARG NODE_VERSION=18
@@ -31,37 +33,48 @@ RUN apt-get -y install \
     build-essential \
     cmake \
     gcc \
+    libcairo2-dev \
     libgirepository1.0-dev \
-    libglib2.0-dev \
+    libvips \
     pkg-config
 
-# ffmpeg
+# these are necessary for pillow-simd, additional on disk size is small
+# but could consider removing this.
 RUN apt-get -y install \
-    ffmpeg
+    libjpeg-dev zlib1g-dev
 
 # gstreamer native https://gstreamer.freedesktop.org/documentation/installing/on-linux.html?gi-language=c#install-gstreamer-on-ubuntu-or-debian
 RUN apt-get -y install \
-    gstreamer1.0-tools libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav gstreamer1.0-alsa \
+    gstreamer1.0-tools gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-libav gstreamer1.0-alsa \
     gstreamer1.0-vaapi
 
 # python native
 RUN apt-get -y install \
     python3 \
     python3-dev \
-    python3-gi \
     python3-gst-1.0 \
-    python3-matplotlib \
-    python3-numpy \
-    python3-opencv \
-    python3-pil \
     python3-pip \
     python3-setuptools \
-    python3-skimage \
     python3-wheel
 
+# armv7l does not have wheels for any of these
+# and compile times would forever, if it works at all.
+RUN if [ "$(uname -m)" = "armv7l" ]; \
+    then \
+        apt-get -y install \
+        python3-matplotlib \
+        python3-numpy \
+        python3-opencv \
+        python3-pil \
+        python3-skimage; \
+    fi
+
 # python pip
 RUN python3 -m pip install --upgrade pip
-RUN python3 -m pip install aiofiles debugpy typing_extensions typing psutil
+# pyvips is broken on x86 due to mismatch ffi
+# https://stackoverflow.com/questions/62658237/it-seems-that-the-version-of-the-libffi-library-seen-at-runtime-is-different-fro
+RUN pip install --force-reinstall --no-binary :all: cffi
+RUN python3 -m pip install aiofiles debugpy typing_extensions psutil
 
 ################################################################
 # End section generated from template/Dockerfile.full.header
@@ -76,6 +89,10 @@ ENV SCRYPTED_CAN_RESTART="true"
 ENV SCRYPTED_VOLUME="/server/volume"
 ENV SCRYPTED_INSTALL_PATH="/server"
 
+# changing this forces pip and npm to perform reinstalls.
+# if this base image changes, this version must be updated.
+ENV SCRYPTED_BASE_VERSION=20230322
+
 ################################################################
 # End section generated from template/Dockerfile.full.footer
 ################################################################

docker/Dockerfile.lite

@@ -1,5 +1,7 @@
 ARG BUILDPACK_DEPS_BASE="bullseye"
-FROM buildpack-deps:${BUILDPACK_DEPS_BASE} as header
+FROM debian:${BUILDPACK_DEPS_BASE} as header
+
+RUN apt-get update && apt-get -y install curl wget
 
 # switch to nvm?
 ARG NODE_VERSION=18
@@ -15,31 +17,29 @@ RUN apt-get -y update
 # base development stuff
 RUN apt-get -y install \
     build-essential \
+    cmake \
     gcc \
+    libcairo2-dev \
     libgirepository1.0-dev \
-    libglib2.0-dev \
     pkg-config
 
-# ffmpeg
-RUN apt-get -y install \
-    ffmpeg
-ENV SCRYPTED_FFMPEG_PATH=ffmpeg
-
 # python native
 RUN apt-get -y install \
     python3 \
     python3-dev \
-    python3-gi \
     python3-pip \
     python3-setuptools \
     python3-wheel
 
-
 # python pip
 RUN python3 -m pip install --upgrade pip
-RUN python3 -m pip install aiofiles debugpy typing_extensions typing psutil
+RUN python3 -m pip install aiofiles debugpy typing_extensions psutil
 
 ENV SCRYPTED_DOCKER_SERVE="true"
 ENV SCRYPTED_CAN_RESTART="true"
 ENV SCRYPTED_VOLUME="/server/volume"
 ENV SCRYPTED_INSTALL_PATH="/server"
+
+# changing this forces pip and npm to perform reinstalls.
+# if this base image changes, this version must be updated.
+ENV SCRYPTED_BASE_VERSION=20230322

docker/Dockerfile.nvidia

@@ -0,0 +1,22 @@
+FROM koush/18-bullseye-full.s6
+
+WORKDIR /
+
+# Install miniconda
+ENV CONDA_DIR /opt/conda
+RUN wget --quiet https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda.sh && \
+     /bin/bash ~/miniconda.sh -b -p /opt/conda
+# Put conda in path so we can use conda activate
+ENV PATH=$CONDA_DIR/bin:$PATH
+
+RUN conda install -c conda-forge cudatoolkit=11.2.2 cudnn=8.1.0
+ENV CONDA_PREFIX=/opt/conda
+ENV LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CONDA_PREFIX/lib/
+
+# this is a copy pasta, seems to need a reinstall.
+# python pip
+RUN python3 -m pip install --upgrade pip
+# pyvips is broken on x86 due to mismatch ffi
+# https://stackoverflow.com/questions/62658237/it-seems-that-the-version-of-the-libffi-library-seen-at-runtime-is-different-fro
+RUN python3 -m pip install --force-reinstall --no-binary :all: cffi
+RUN python3 -m pip install aiofiles debugpy typing_extensions psutil

docker/Dockerfile.thin

@@ -1,5 +1,7 @@
 ARG BUILDPACK_DEPS_BASE="bullseye"
-FROM buildpack-deps:${BUILDPACK_DEPS_BASE} as header
+FROM debian:${BUILDPACK_DEPS_BASE} as header
+
+RUN apt-get update && apt-get -y install curl wget
 
 # switch to nvm?
 ARG NODE_VERSION=18
@@ -12,19 +14,11 @@ RUN apt-get -y upgrade
 RUN apt-get -y install software-properties-common apt-utils
 RUN apt-get -y update
 
-# base development stuff
-RUN apt-get -y install \
-    build-essential \
-    gcc \
-    libglib2.0-dev \
-    pkg-config
-
-# ffmpeg
-RUN apt-get -y install \
-    ffmpeg
-ENV SCRYPTED_FFMPEG_PATH=ffmpeg
-
 ENV SCRYPTED_DOCKER_SERVE="true"
 ENV SCRYPTED_CAN_RESTART="true"
 ENV SCRYPTED_VOLUME="/server/volume"
 ENV SCRYPTED_INSTALL_PATH="/server"
+
+# changing this forces pip and npm to perform reinstalls.
+# if this base image changes, this version must be updated.
+ENV SCRYPTED_BASE_VERSION=20230322

docker/docker-build-nvidia.sh

@@ -0,0 +1,3 @@
+./docker-build.sh
+
+docker build -t koush/scrypted:18-bullseye-full.nvidia -f Dockerfile.nvidia

docker/docker-compose.yml

@@ -54,6 +54,11 @@ services:
             #   target: /nvr
             #   volume:
             #     nocopy: true
+
+            # uncomment the following lines to expose Avahi, an mDNS advertiser.
+            # make sure Avahi is running on the host machine, otherwise this will not work.
+            # - /var/run/dbus:/var/run/dbus
+            # - /var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket
         # logging is noisy and will unnecessarily wear on flash storage.
         # scrypted has per device in memory logging that is preferred.
         logging:

docker/install-scrypted-dependencies-mac.sh

@@ -40,13 +40,16 @@ echo "Installing Scrypted dependencies..."
 RUN_IGNORE xcode-select --install
 RUN brew update
 RUN_IGNORE brew install node@18
-# needed by scrypted-ffmpeg
-RUN_IGNORE brew install sdl2
+# snapshot plugin and others
+RUN brew install libvips
+# dlib
+RUN brew install cmake
 # gstreamer plugins
 RUN_IGNORE brew install gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly
 # gst python bindings
 RUN_IGNORE brew install gst-python
 # python image library
+# todo: consider removing this
 RUN_IGNORE brew install pillow
 
 ### HACK WORKAROUND
@@ -58,6 +61,7 @@ brew unpin gst-plugins-ugly
 brew unpin gst-plugins-good
 brew unpin gst-plugins-base
 brew unpin gst-plugins-bad
+brew unpin gst-libav
 
 brew unlink gstreamer
 brew unlink gst-python
@@ -65,6 +69,7 @@ brew unlink gst-plugins-ugly
 brew unlink gst-plugins-good
 brew unlink gst-plugins-base
 brew unlink gst-plugins-bad
+brew unlink gst-libav
 
 curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a6579fe887bc0fa1c0ce682eb01c8/Formula/gstreamer.rb && brew install ./gstreamer.rb
 curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a6579fe887bc0fa1c0ce682eb01c8/Formula/gst-python.rb && brew install ./gst-python.rb
@@ -72,6 +77,7 @@ curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a657
 curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a6579fe887bc0fa1c0ce682eb01c8/Formula/gst-plugins-good.rb && brew install ./gst-plugins-good.rb
 curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a6579fe887bc0fa1c0ce682eb01c8/Formula/gst-plugins-base.rb && brew install ./gst-plugins-base.rb
 curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a6579fe887bc0fa1c0ce682eb01c8/Formula/gst-plugins-bad.rb && brew install ./gst-plugins-bad.rb
+curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/49a8667f0c1a6579fe887bc0fa1c0ce682eb01c8/Formula/gst-libav.rb && brew install ./gst-libav.rb
 
 brew pin gstreamer
 brew pin gst-python
@@ -79,6 +85,7 @@ brew pin gst-plugins-ugly
 brew pin gst-plugins-good
 brew pin gst-plugins-base
 brew pin gst-plugins-bad
+brew pin gst-libav
 
 ### END HACK WORKAROUND
 
@@ -102,7 +109,11 @@ then
 fi
 
 RUN python$PYTHON_VERSION -m pip install --upgrade pip
-RUN python$PYTHON_VERSION -m pip install aiofiles debugpy typing_extensions typing opencv-python psutil
+if [ "$PYTHON_VERSION" != "3.10" ]
+then
+    RUN python$PYTHON_VERSION -m pip install typing
+fi
+RUN python$PYTHON_VERSION -m pip install aiofiles debugpy typing_extensions opencv-python psutil
 
 echo "Installing Scrypted Launch Agent..."
 

docker/template/Dockerfile.full.footer

@@ -8,6 +8,10 @@ ENV SCRYPTED_CAN_RESTART="true"
 ENV SCRYPTED_VOLUME="/server/volume"
 ENV SCRYPTED_INSTALL_PATH="/server"
 
+# changing this forces pip and npm to perform reinstalls.
+# if this base image changes, this version must be updated.
+ENV SCRYPTED_BASE_VERSION=20230322
+
 ################################################################
 # End section generated from template/Dockerfile.full.footer
 ################################################################

docker/template/Dockerfile.full.header

@@ -4,7 +4,9 @@
 # install script.
 ################################################################
 ARG BUILDPACK_DEPS_BASE="bullseye"
-FROM buildpack-deps:${BUILDPACK_DEPS_BASE} as header
+FROM debian:${BUILDPACK_DEPS_BASE} as header
+
+RUN apt-get update && apt-get -y install curl wget
 
 # switch to nvm?
 ARG NODE_VERSION=18
@@ -28,37 +30,48 @@ RUN apt-get -y install \
     build-essential \
     cmake \
     gcc \
+    libcairo2-dev \
     libgirepository1.0-dev \
-    libglib2.0-dev \
+    libvips \
     pkg-config
 
-# ffmpeg
+# these are necessary for pillow-simd, additional on disk size is small
+# but could consider removing this.
 RUN apt-get -y install \
-    ffmpeg
+    libjpeg-dev zlib1g-dev
 
 # gstreamer native https://gstreamer.freedesktop.org/documentation/installing/on-linux.html?gi-language=c#install-gstreamer-on-ubuntu-or-debian
 RUN apt-get -y install \
-    gstreamer1.0-tools libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav gstreamer1.0-alsa \
+    gstreamer1.0-tools gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-libav gstreamer1.0-alsa \
     gstreamer1.0-vaapi
 
 # python native
 RUN apt-get -y install \
     python3 \
     python3-dev \
-    python3-gi \
     python3-gst-1.0 \
-    python3-matplotlib \
-    python3-numpy \
-    python3-opencv \
-    python3-pil \
     python3-pip \
     python3-setuptools \
-    python3-skimage \
     python3-wheel
 
+# armv7l does not have wheels for any of these
+# and compile times would forever, if it works at all.
+RUN if [ "$(uname -m)" = "armv7l" ]; \
+    then \
+        apt-get -y install \
+        python3-matplotlib \
+        python3-numpy \
+        python3-opencv \
+        python3-pil \
+        python3-skimage; \
+    fi
+
 # python pip
 RUN python3 -m pip install --upgrade pip
-RUN python3 -m pip install aiofiles debugpy typing_extensions typing psutil
+# pyvips is broken on x86 due to mismatch ffi
+# https://stackoverflow.com/questions/62658237/it-seems-that-the-version-of-the-libffi-library-seen-at-runtime-is-different-fro
+RUN pip install --force-reinstall --no-binary :all: cffi
+RUN python3 -m pip install aiofiles debugpy typing_extensions psutil
 
 ################################################################
 # End section generated from template/Dockerfile.full.header

plugins/alexa/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/alexa",
-   "version": "0.2.0",
+   "version": "0.2.3",
    "scripts": {
       "scrypted-setup-project": "scrypted-setup-project",
       "prescrypted-setup-project": "scrypted-package-json",
@@ -39,6 +39,6 @@
    },
    "devDependencies": {
       "@types/node": "^18.4.2",
-      "@scrypted/sdk": "^0.2.70"
+      "@scrypted/sdk": "../../sdk"
    }
 }

plugins/alexa/src/types/camera/handlers.ts

@@ -17,6 +17,13 @@ export class AlexaSignalingSession implements RTCSignalingSession {
                 sdp: this.directive.payload.offer.value,
             },
             disableTrickle: true,
+            disableTurn: true,
+            // this could be a low resolution screen, no way of knowning, so never send a 1080p stream
+            screen: {
+                devicePixelRatio: 1,
+                width: 1280,
+                height: 720
+            }
         }
     }
 

plugins/arlo/package-lock.json

@@ -1,19 +1,19 @@
 {
    "name": "@scrypted/arlo",
-   "version": "0.6.7",
+   "version": "0.7.0",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/arlo",
-         "version": "0.6.7",
+         "version": "0.7.0",
          "devDependencies": {
             "@scrypted/sdk": "file:../../sdk"
          }
       },
       "../../sdk": {
          "name": "@scrypted/sdk",
-         "version": "0.2.78",
+         "version": "0.2.85",
          "dev": true,
          "license": "ISC",
          "dependencies": {

plugins/arlo/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/arlo",
-   "version": "0.6.7",
+   "version": "0.7.0",
    "description": "Arlo Plugin for Scrypted",
    "keywords": [
       "scrypted",

plugins/arlo/src/arlo_plugin/arlo/arlo_async.py

@@ -709,3 +709,29 @@ class Arlo(object):
             trigger,
             callback,
         )
+
+    def SirenOn(self, basestation):
+        return self.Notify(basestation, {
+            "action": "set",
+            "resource": "siren",
+            "publishResponse": True,
+            "properties": {
+                "sirenState": "on",
+                "duration": 300,
+                "volume": 8,
+                "pattern": "alarm"
+            }
+        })
+
+    def SirenOff(self, basestation):
+        return self.Notify(basestation, {
+            "action": "set",
+            "resource": "siren",
+            "publishResponse": True,
+            "properties": {
+                "sirenState": "off",
+                "duration": 300,
+                "volume": 8,
+                "pattern": "alarm"
+            }
+        })

plugins/arlo/src/arlo_plugin/basestation.py

@@ -0,0 +1,44 @@
+from scrypted_sdk import ScryptedDeviceBase
+from scrypted_sdk.types import DeviceProvider, ScryptedInterface, ScryptedDeviceType
+
+from .device_base import ArloDeviceBase
+from .siren import ArloSiren
+
+
+class ArloBasestation(ArloDeviceBase, DeviceProvider):
+    siren: ArloSiren = None
+
+    def get_applicable_interfaces(self) -> list:
+        return [ScryptedInterface.DeviceProvider.value]
+
+    def get_device_type(self) -> str:
+        return ScryptedDeviceType.DeviceProvider.value
+
+    def get_builtin_child_device_manifests(self) -> list:
+        return [
+            {
+                "info": {
+                    "model": f"{self.arlo_device['modelId']} {self.arlo_device['properties'].get('hwVersion', '')}".strip(),
+                    "manufacturer": "Arlo",
+                    "firmware": self.arlo_device.get("firmwareVersion"),
+                    "serialNumber": self.arlo_device["deviceId"],
+                },
+                "nativeId": f'{self.arlo_device["deviceId"]}.siren',
+                "name": f'{self.arlo_device["deviceName"]} Siren',
+                "interfaces": [ScryptedInterface.OnOff.value],
+                "type": ScryptedDeviceType.Siren.value,
+                "providerNativeId": self.nativeId,
+            }
+        ]
+
+    async def getDevice(self, nativeId: str) -> ScryptedDeviceBase:
+        if not nativeId.startswith(self.nativeId):
+            # must be a camera, so get it from the provider
+            return await self.provider.getDevice(nativeId)
+
+        if nativeId.endswith("siren"):
+            if not self.siren:
+                self.siren = ArloSiren(nativeId, self.arlo_device, self.arlo_basestation, self.provider)
+            return self.siren
+
+        return None

plugins/arlo/src/arlo_plugin/camera.py

@@ -1,47 +1,30 @@
 import asyncio
 import json
 import threading
+import time
 
 import scrypted_arlo_go
 
 import scrypted_sdk
-from scrypted_sdk import ScryptedDeviceBase
-from scrypted_sdk.types import Settings, Camera, VideoCamera, MotionSensor, Battery, ScryptedMimeTypes, ScryptedInterface
+from scrypted_sdk.types import Settings, Camera, VideoCamera, MotionSensor, Battery, MediaObject, ScryptedMimeTypes, ScryptedInterface, ScryptedDeviceType
 
+from .device_base import ArloDeviceBase
+from .provider import ArloProvider
 from .child_process import HeartbeatChildProcess
-from .logging import ScryptedDeviceLoggerMixin
 from .util import BackgroundTaskMixin
 
 
-class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor, Battery, ScryptedDeviceLoggerMixin, BackgroundTaskMixin):
-    timeout = 30
-    nativeId = None
-    arlo_device = None
-    arlo_basestation = None
-    provider = None
+class ArloCamera(ArloDeviceBase, Settings, Camera, VideoCamera, MotionSensor, Battery):
+    timeout: int = 30
+    intercom_session = None
 
-    def __init__(self, nativeId, arlo_device, arlo_basestation, provider):
-        super().__init__(nativeId=nativeId)
+    def __init__(self, nativeId: str, arlo_device: dict, arlo_basestation: dict, provider: ArloProvider) -> None:
+        super().__init__(nativeId=nativeId, arlo_device=arlo_device, arlo_basestation=arlo_basestation, provider=provider)
 
-        self.logger_name = nativeId
-
-        self.nativeId = nativeId
-        self.arlo_device = arlo_device
-        self.arlo_basestation = arlo_basestation
-        self.provider = provider
-        self.logger.setLevel(self.provider.get_current_log_level())
-
-        self.intercom_session = None
-
-        self.stop_subscriptions = False
         self.start_motion_subscription()
         self.start_battery_subscription()
 
-    def __del__(self):
-        self.stop_subscriptions = True
-        self.cancel_pending_tasks()
-
-    def start_motion_subscription(self):
+    def start_motion_subscription(self) -> None:
         def callback(motionDetected):
             self.motionDetected = motionDetected
             return self.stop_subscriptions
@@ -50,7 +33,7 @@ class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor
             self.provider.arlo.SubscribeToMotionEvents(self.arlo_basestation, self.arlo_device, callback)
         )
 
-    def start_battery_subscription(self):
+    def start_battery_subscription(self) -> None:
         def callback(batteryLevel):
             self.batteryLevel = batteryLevel
             return self.stop_subscriptions
@@ -82,15 +65,18 @@ class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor
 
         return list(results)
 
+    def get_device_type(self) -> str:
+        return ScryptedDeviceType.Camera.value
+
     @property
-    def webrtc_emulation(self):
+    def webrtc_emulation(self) -> bool:
         if self.storage:
-            return self.storage.getItem("webrtc_emulation")
+            return True if self.storage.getItem("webrtc_emulation") else False
         else:
             return False
 
     @property
-    def two_way_audio(self):
+    def two_way_audio(self) -> bool:
         if self.storage:
             val = self.storage.getItem("two_way_audio")
             if val is None:
@@ -99,7 +85,7 @@ class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor
         else:
             return True
 
-    async def getSettings(self):
+    async def getSettings(self) -> list:
         if self._can_push_to_talk():
             return [
                 {
@@ -120,15 +106,15 @@ class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor
             ]
         return []
 
-    async def putSetting(self, key, value):
+    async def putSetting(self, key, value) -> None:
         if key in ["webrtc_emulation", "two_way_audio"]:
             self.storage.setItem(key, value == "true")
             await self.provider.discoverDevices()
 
-    async def getPictureOptions(self):
+    async def getPictureOptions(self) -> list:
         return []
 
-    async def takePicture(self, options=None):
+    async def takePicture(self, options: dict = None) -> MediaObject:
         self.logger.info("Taking picture")
 
         real_device = await scrypted_sdk.systemManager.api.getDeviceById(self.getScryptedProperty("id"))
@@ -145,7 +131,7 @@ class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor
 
         return await scrypted_sdk.mediaManager.createMediaObject(str.encode(pic_url), ScryptedMimeTypes.Url.value)
 
-    async def getVideoStreamOptions(self):
+    async def getVideoStreamOptions(self) -> list:
         return [
             {
                 "id": 'default',
@@ -163,16 +149,29 @@ class ArloCamera(ScryptedDeviceBase, Settings, Camera, VideoCamera, MotionSensor
             }
         ]
 
-    async def _getVideoStreamURL(self):
+    async def _getVideoStreamURL(self) -> str:
         self.logger.info("Requesting stream")
         rtsp_url = await asyncio.wait_for(self.provider.arlo.StartStream(self.arlo_basestation, self.arlo_device), timeout=self.timeout)
         self.logger.debug(f"Got stream URL at {rtsp_url}")
         return rtsp_url
 
-    async def getVideoStream(self, options=None):
+    async def getVideoStream(self, options: dict = None) -> MediaObject:
         self.logger.debug("Entered getVideoStream")
         rtsp_url = await self._getVideoStreamURL()
-        return await scrypted_sdk.mediaManager.createMediaObject(str.encode(rtsp_url), ScryptedMimeTypes.Url.value)
+
+        mso = (await self.getVideoStreamOptions())[0]
+        mso['refreshAt'] = round(time.time() * 1000) + 30 * 60 * 1000
+
+        ffmpeg_input = {
+            'url': rtsp_url,
+            'container': 'rtsp',
+            'mediaStreamOptions': mso,
+            'inputArguments': [
+                '-f', 'rtsp',
+                '-i', rtsp_url,
+            ]
+        }
+        return await scrypted_sdk.mediaManager.createFFmpegMediaObject(ffmpeg_input)
 
     async def startRTCSignalingSession(self, scrypted_session):
         try:
@@ -330,7 +329,7 @@ class ArloCameraRTCSignalingSession(BackgroundTaskMixin):
             self.logger.info("Initializing push to talk")
 
             session_id, ice_servers = self.provider.arlo.StartPushToTalk(self.arlo_basestation, self.arlo_device)
-            self.logger.debug(f"Received ice servers: {[ice['url'] for ice in ice_servers]}") 
+            self.logger.debug(f"Received ice servers: {[ice['url'] for ice in ice_servers]}")
 
             cfg = scrypted_arlo_go.WebRTCConfiguration(
                 ICEServers=scrypted_arlo_go.Slice_webrtc_ICEServer([
@@ -372,7 +371,7 @@ class ArloCameraRTCSignalingSession(BackgroundTaskMixin):
                 self.logger.debug("Starting audio track forwarder")
                 self.scrypted_pc.ForwardAudioTo(self.arlo_pc)
                 self.logger.debug("Started audio track forwarder")
-            
+
             self.sdp_answered = False
 
             offer = self.arlo_pc.CreateOffer()

plugins/arlo/src/arlo_plugin/device_base.py

@@ -0,0 +1,59 @@
+from scrypted_sdk import ScryptedDeviceBase
+
+from .logging import ScryptedDeviceLoggerMixin
+from .util import BackgroundTaskMixin
+from .provider import ArloProvider
+
+class ArloDeviceBase(ScryptedDeviceBase, ScryptedDeviceLoggerMixin, BackgroundTaskMixin):
+    nativeId: str = None
+    arlo_device: dict = None
+    arlo_basestation: dict = None
+    provider: ArloProvider = None
+    stop_subscriptions: bool = False
+
+    def __init__(self, nativeId: str, arlo_device: dict, arlo_basestation: dict, provider: ArloProvider) -> None:
+        super().__init__(nativeId=nativeId)
+
+        self.logger_name = nativeId
+
+        self.nativeId = nativeId
+        self.arlo_device = arlo_device
+        self.arlo_basestation = arlo_basestation
+        self.provider = provider
+        self.logger.setLevel(self.provider.get_current_log_level())
+
+    def __del__(self):
+        self.stop_subscriptions = True
+        self.cancel_pending_tasks()
+
+    def get_applicable_interfaces(self) -> list:
+        """Returns the list of Scrypted interfaces that applies to this device."""
+        return []
+
+    def get_device_type(self) -> str:
+        """Returns the Scrypted device type that applies to this device."""
+        return ""
+
+    def get_device_manifest(self) -> dict:
+        """Returns the Scrypted device manifest representing this device."""
+        parent = None
+        if self.arlo_device.get("parentId") and self.arlo_device["parentId"] != self.arlo_device["deviceId"]:
+            parent = self.arlo_device["parentId"]
+
+        return {
+            "info": {
+                "model": f"{self.arlo_device['modelId']} {self.arlo_device['properties'].get('hwVersion', '')}".strip(),
+                "manufacturer": "Arlo",
+                "firmware": self.arlo_device.get("firmwareVersion"),
+                "serialNumber": self.arlo_device["deviceId"],
+            },
+            "nativeId": self.arlo_device["deviceId"],
+            "name": self.arlo_device["deviceName"],
+            "interfaces": self.get_applicable_interfaces(),
+            "type": self.get_device_type(),
+            "providerNativeId": parent,
+        }
+
+    def get_builtin_child_device_manifests(self) -> list:
+        """Returns the list of child device manifests representing hardware features built into this device."""
+        return []

plugins/arlo/src/arlo_plugin/doorbell.py

@@ -1,29 +1,29 @@
 from scrypted_sdk.types import BinarySensor, ScryptedInterface
 
 from .camera import ArloCamera
+from .provider import ArloProvider
 
 
 class ArloDoorbell(ArloCamera, BinarySensor):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+    def __init__(self, nativeId: str, arlo_device: dict, arlo_basestation: dict, provider: ArloProvider) -> None:
+        super().__init__(nativeId=nativeId, arlo_device=arlo_device, arlo_basestation=arlo_basestation, provider=provider)
 
         self.start_doorbell_subscription()
 
-    def start_doorbell_subscription(self):
+    def start_doorbell_subscription(self) -> None:
         def callback(doorbellPressed):
             self.binaryState = doorbellPressed
             return self.stop_subscriptions
- 
+
         self.register_task(
             self.provider.arlo.SubscribeToDoorbellEvents(self.arlo_basestation, self.arlo_device, callback)
         )
 
-    def get_applicable_interfaces(self):
+    def get_applicable_interfaces(self) -> list:
         camera_interfaces = super().get_applicable_interfaces()
         camera_interfaces.append(ScryptedInterface.BinarySensor.value)
 
-        model_id = self.arlo_device['properties']['modelId'].lower()
+        model_id = self.arlo_device['modelId'].lower()
         if model_id.startswith("avd1001"):
             camera_interfaces.remove(ScryptedInterface.Battery.value)
         return camera_interfaces
-        

plugins/arlo/src/arlo_plugin/logging.py

@@ -1,5 +1,4 @@
 import logging
-import sys
 
 
 class ScryptedDeviceLoggingWrapper(logging.Handler):
@@ -20,7 +19,7 @@ def createScryptedLogger(scrypted_device, name):
 
     logger.setLevel(logging.INFO)
 
-    # configure logger to output to scrypted's log stream 
+    # configure logger to output to scrypted's log stream
     sh = ScryptedDeviceLoggingWrapper(scrypted_device)
 
     # log formatting

plugins/arlo/src/arlo_plugin/provider.py

@@ -14,9 +14,7 @@ from scrypted_sdk.types import Settings, DeviceProvider, DeviceDiscovery, Scrypt
 from .arlo import Arlo
 from .arlo.arlo_async import change_stream_class
 from .arlo.logging import logger as arlo_lib_logger
-from .camera import ArloCamera
-from .doorbell import ArloDoorbell
-from .logging import ScryptedDeviceLoggerMixin 
+from .logging import ScryptedDeviceLoggerMixin
 from .util import BackgroundTaskMixin
 
 
@@ -37,7 +35,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
 
     mfa_strategy_choices = ["Manual", "IMAP"]
 
-    def __init__(self, nativeId=None):
+    def __init__(self, nativeId: str = None) -> None:
         super().__init__(nativeId=nativeId)
         self.logger_name = "provider"
 
@@ -60,28 +58,28 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         asyncio.get_event_loop().call_soon(load, self)
         self.create_task(self.onDeviceEvent(ScryptedInterface.Settings.value, None))
 
-    def print(self, *args, **kwargs):
+    def print(self, *args, **kwargs) -> None:
         """Overrides the print() from ScryptedDeviceBase to avoid double-printing in the main plugin console."""
         print(*args, **kwargs)
 
     @property
-    def arlo_username(self):
+    def arlo_username(self) -> str:
         return self.storage.getItem("arlo_username")
 
     @property
-    def arlo_password(self):
+    def arlo_password(self) -> str:
         return self.storage.getItem("arlo_password")
 
     @property
-    def arlo_auth_headers(self):
+    def arlo_auth_headers(self) -> str:
         return self.storage.getItem("arlo_auth_headers")
 
     @property
-    def arlo_user_id(self):
+    def arlo_user_id(self) -> str:
         return self.storage.getItem("arlo_user_id")
 
     @property
-    def arlo_transport(self):
+    def arlo_transport(self) -> str:
         transport = self.storage.getItem("arlo_transport")
         if transport is None or transport not in ArloProvider.arlo_transport_choices:
             transport = "SSE"
@@ -89,7 +87,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         return transport
 
     @property
-    def plugin_verbosity(self):
+    def plugin_verbosity(self) -> str:
         verbosity = self.storage.getItem("plugin_verbosity")
         if verbosity is None or verbosity not in ArloProvider.plugin_verbosity_choices:
             verbosity = "Normal"
@@ -97,7 +95,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         return verbosity
 
     @property
-    def mfa_strategy(self):
+    def mfa_strategy(self) -> str:
         strategy = self.storage.getItem("mfa_strategy")
         if strategy is None or strategy not in ArloProvider.mfa_strategy_choices:
             strategy = "Manual"
@@ -105,7 +103,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         return strategy
 
     @property
-    def refresh_interval(self):
+    def refresh_interval(self) -> int:
         interval = self.storage.getItem("refresh_interval")
         if interval is None:
             interval = 90
@@ -113,11 +111,11 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         return int(interval)
 
     @property
-    def imap_mfa_host(self):
+    def imap_mfa_host(self) -> str:
         return self.storage.getItem("imap_mfa_host")
 
     @property
-    def imap_mfa_port(self):
+    def imap_mfa_port(self) -> int:
         port = self.storage.getItem("imap_mfa_port")
         if port is None:
             port = 993
@@ -125,23 +123,23 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         return int(port)
 
     @property
-    def imap_mfa_username(self):
+    def imap_mfa_username(self) -> str:
         return self.storage.getItem("imap_mfa_username")
 
     @property
-    def imap_mfa_password(self):
+    def imap_mfa_password(self) -> str:
         return self.storage.getItem("imap_mfa_password")
 
     @property
-    def imap_mfa_interval(self):
+    def imap_mfa_interval(self) -> int:
         interval = self.storage.getItem("imap_mfa_interval")
         if interval is None:
-            interval = 7 
+            interval = 7
             self.storage.setItem("imap_mfa_interval", interval)
         return int(interval)
 
     @property
-    def arlo(self):
+    def arlo(self) -> Arlo:
         if self._arlo is not None:
             if self._arlo_mfa_complete_auth is not None:
                 if self._arlo_mfa_code == "":
@@ -149,7 +147,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
 
                 self.logger.info("Completing Arlo MFA...")
                 self._arlo_mfa_complete_auth(self._arlo_mfa_code)
-                self._arlo_mfa_complete_auth = None 
+                self._arlo_mfa_complete_auth = None
                 self._arlo_mfa_code = None
                 self.logger.info("Arlo MFA done")
 
@@ -162,7 +160,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
 
         if not self.arlo_username or not self.arlo_password:
             return None
-            
+
         self.logger.info("Trying to initialize Arlo client...")
         try:
             self._arlo = Arlo(self.arlo_username, self.arlo_password)
@@ -183,7 +181,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
             self._arlo_mfa_code = None
             return None
 
-    async def do_arlo_setup(self):
+    async def do_arlo_setup(self) -> None:
         try:
             await self.discoverDevices()
             await self.arlo.Subscribe([
@@ -204,7 +202,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         except Exception as e:
             traceback.print_exc()
 
-    def invalidate_arlo_client(self):
+    def invalidate_arlo_client(self) -> None:
         if self._arlo is not None:
             self._arlo.Unsubscribe()
         self._arlo = None
@@ -213,10 +211,10 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         self.storage.setItem("arlo_auth_headers", "")
         self.storage.setItem("arlo_user_id", "")
 
-    def get_current_log_level(self):
+    def get_current_log_level(self) -> int:
         return ArloProvider.plugin_verbosity_choices[self.plugin_verbosity]
 
-    def propagate_verbosity(self):
+    def propagate_verbosity(self) -> None:
         self.print(f"Setting plugin verbosity to {self.plugin_verbosity}")
         log_level = self.get_current_log_level()
         self.logger.setLevel(log_level)
@@ -224,11 +222,11 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
             device.logger.setLevel(log_level)
         arlo_lib_logger.setLevel(log_level)
 
-    def propagate_transport(self):
+    def propagate_transport(self) -> None:
         self.print(f"Setting plugin transport to {self.arlo_transport}")
         change_stream_class(self.arlo_transport)
 
-    def initialize_imap(self):
+    def initialize_imap(self) -> None:
         if not self.imap_mfa_host or not self.imap_mfa_port or \
             not self.imap_mfa_username or not self.imap_mfa_password or \
             not self.imap_mfa_interval:
@@ -245,7 +243,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
             res, _ = self.imap.select(mailbox="INBOX", readonly=True)
             if res.lower() != "ok":
                 raise Exception(f"IMAP failed to fetch INBOX: {res}")
-            
+
             # fetch existing arlo emails so we skip them going forward
             res, self.imap_skip_emails = self.imap.search(None, "FROM", "do_not_reply@arlo.com")
             if res.lower() != "ok":
@@ -258,14 +256,14 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
             self.imap_signal = asyncio.Queue()
             self.create_task(self.imap_relogin_loop())
 
-    def exit_imap(self):
+    def exit_imap(self) -> None:
         if self.imap_signal:
             self.imap_signal.put_nowait(None)
         self.imap_signal = None
         self.imap_skip_emails = None
         self.imap = None
 
-    async def imap_relogin_loop(self):
+    async def imap_relogin_loop(self) -> None:
         imap_signal = self.imap_signal
         self.logger.info(f"Starting IMAP refresh loop {id(imap_signal)}")
         while True:
@@ -368,7 +366,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
                 self.logger.info(f"Exiting IMAP refresh loop {id(imap_signal)}")
                 return
 
-    async def getSettings(self):
+    async def getSettings(self) -> list:
         results = [
             {
                 "group": "General",
@@ -447,7 +445,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
                     "value": self.imap_mfa_interval,
                 }
             ])
-        
+
         results.extend([
             {
                 "group": "General",
@@ -479,7 +477,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
 
         return results
 
-    async def putSetting(self, key, value):
+    async def putSetting(self, key, value) -> None:
         if not self.validate_setting(key, value):
             await self.onDeviceEvent(ScryptedInterface.Settings.value, None)
             return
@@ -525,7 +523,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
             _ = self.arlo
         await self.onDeviceEvent(ScryptedInterface.Settings.value, None)
 
-    def validate_setting(self, key, val):
+    def validate_setting(self, key: str, val: str) -> bool:
         if key == "refresh_interval":
             try:
                 val = int(val)
@@ -555,7 +553,7 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
                 return False
         return True
 
-    async def discoverDevices(self, duration=0):
+    async def discoverDevices(self, duration: int = 0) -> None:
         if not self.arlo:
             raise Exception("Arlo client not connected, cannot discover devices")
 
@@ -564,70 +562,109 @@ class ArloProvider(ScryptedDeviceBase, Settings, DeviceProvider, DeviceDiscovery
         self.arlo_basestations = {}
         self.scrypted_devices = {}
 
+        camera_devices = []
+        provider_to_device_map = {}
+
         basestations = self.arlo.GetDevices(['basestation', 'siren'])
         for basestation in basestations:
-            self.arlo_basestations[basestation["deviceId"]] = basestation
+            nativeId = basestation["deviceId"]
+
+            if nativeId in self.arlo_basestations:
+                self.logger.info(f"Skipping basestation {nativeId} as it already exists")
+                continue
+            self.arlo_basestations[nativeId] = basestation
+
+            device = await self.getDevice(nativeId)
+            scrypted_interfaces = device.get_applicable_interfaces()
+            manifest = device.get_device_manifest()
+            self.logger.debug(f"Interfaces for {nativeId} ({basestation['modelId']}): {scrypted_interfaces}")
+
+            # for basestations, we want to add them to the top level DeviceProvider
+            provider_to_device_map.setdefault(None, []).append(manifest)
+
+            # add any builtin child devices
+            provider_to_device_map.setdefault(nativeId, []).extend(device.get_builtin_child_device_manifests())
+
+            # we also want to trickle discover them so they are added without deleting all existing
+            # root level devices - this is for backward compatibility
+            await scrypted_sdk.deviceManager.onDeviceDiscovered(manifest)
         self.logger.info(f"Discovered {len(basestations)} basestations")
 
-        devices = []
         cameras = self.arlo.GetDevices(['camera', "arloq", "arloqs", "doorbell"])
         for camera in cameras:
             if camera["deviceId"] != camera["parentId"] and camera["parentId"] not in self.arlo_basestations:
                 self.logger.info(f"Skipping camera {camera['deviceId']} because its basestation was not found")
                 continue
 
-            if camera["deviceId"] == camera["parentId"]:
-                self.arlo_basestations[camera["deviceId"]] = camera
-
             nativeId = camera["deviceId"]
+            if nativeId in self.arlo_cameras:
+                self.logger.info(f"Skipping camera {nativeId} as it already exists")
+                continue
             self.arlo_cameras[nativeId] = camera
 
-            scrypted_interfaces = (await self.getDevice(nativeId)).get_applicable_interfaces()
+            device = await self.getDevice(nativeId)
+            scrypted_interfaces = device.get_applicable_interfaces()
+            manifest = device.get_device_manifest()
             self.logger.debug(f"Interfaces for {nativeId} ({camera['modelId']}): {scrypted_interfaces}")
 
-            device = {
-                "info": {
-                    "model": f"{camera['properties']['modelId']} ({camera['properties'].get('hwVersion', '')})".strip(),
-                    "manufacturer": "Arlo",
-                    "firmware": camera.get("firmwareVersion"),
-                    "serialNumber": camera["deviceId"],
-                },
-                "nativeId": camera["deviceId"],
-                "name": camera["deviceName"],
-                "interfaces": scrypted_interfaces,
-                "type": ScryptedDeviceType.Camera.value,
-                "providerNativeId": self.nativeId,
-            }
+            if camera["deviceId"] == camera["parentId"]:
+                # these are standalone cameras with no basestation, so they act as their
+                # own basestation
+                self.arlo_basestations[camera["deviceId"]] = camera
+                provider_to_device_map.setdefault(None, []).append(manifest)
+            else:
+                provider_to_device_map.setdefault(camera["parentId"], []).append(manifest)
 
-            devices.append(device)
+            # add any builtin child devices
+            provider_to_device_map.setdefault(nativeId, []).extend(device.get_builtin_child_device_manifests())
 
-        await scrypted_sdk.deviceManager.onDevicesChanged({
-            "devices": devices,
-        })
+            camera_devices.append(manifest)
 
-        if len(cameras) != len(devices):
-            self.logger.info(f"Discovered {len(cameras)} cameras, but only {len(devices)} are usable")
+        if len(cameras) != len(camera_devices):
+            self.logger.info(f"Discovered {len(cameras)} cameras, but only {len(camera_devices)} are usable")
         else:
             self.logger.info(f"Discovered {len(cameras)} cameras")
 
-    async def getDevice(self, nativeId):
+        for provider_id in provider_to_device_map.keys():
+            if provider_id is None:
+                continue
+            await scrypted_sdk.deviceManager.onDevicesChanged({
+                "devices": provider_to_device_map[provider_id],
+                "providerNativeId": provider_id,
+            })
+
+        # ensure devices at the root match all that was discovered
+        await scrypted_sdk.deviceManager.onDevicesChanged({
+            "devices": provider_to_device_map[None]
+        })
+
+    async def getDevice(self, nativeId: str) -> ScryptedDeviceBase:
         ret = self.scrypted_devices.get(nativeId, None)
         if ret is None:
-            ret = self.create_camera(nativeId)
+            ret = self.create_device(nativeId)
             if ret is not None:
                 self.scrypted_devices[nativeId] = ret
         return ret
 
-    def create_camera(self, nativeId):
-        if nativeId not in self.arlo_cameras:
-            return None
-        arlo_camera = self.arlo_cameras[nativeId]
+    def create_device(self, nativeId: str) -> ScryptedDeviceBase:
+        from .camera import ArloCamera
+        from .doorbell import ArloDoorbell
+        from .basestation import ArloBasestation
 
-        if arlo_camera["parentId"] not in self.arlo_basestations:
+        if nativeId not in self.arlo_cameras and nativeId not in self.arlo_basestations:
             return None
-        arlo_basestation = self.arlo_basestations[arlo_camera["parentId"]]
 
-        if arlo_camera["deviceType"] == "doorbell":
-            return ArloDoorbell(nativeId, arlo_camera, arlo_basestation, self)
+        arlo_device = self.arlo_cameras.get(nativeId)
+        if not arlo_device:
+            # this is a basestation, so build the basestation object
+            arlo_device = self.arlo_basestations[nativeId]
+            return ArloBasestation(nativeId, arlo_device, arlo_device, self)
+
+        if arlo_device["parentId"] not in self.arlo_basestations:
+            return None
+        arlo_basestation = self.arlo_basestations[arlo_device["parentId"]]
+
+        if arlo_device["deviceType"] == "doorbell":
+            return ArloDoorbell(nativeId, arlo_device, arlo_basestation, self)
         else:
-            return ArloCamera(nativeId, arlo_camera, arlo_basestation, self)
+            return ArloCamera(nativeId, arlo_device, arlo_basestation, self)

plugins/arlo/src/arlo_plugin/siren.py

@@ -0,0 +1,17 @@
+from scrypted_sdk.types import OnOff, ScryptedInterface
+
+from .device_base import ArloDeviceBase
+
+
+class ArloSiren(ArloDeviceBase, OnOff):
+
+    def get_applicable_interfaces(self) -> list:
+        return [ScryptedInterface.OnOff.value]
+
+    async def turnOn(self) -> None:
+        self.logger.info("Turning on")
+        self.provider.arlo.SirenOn(self.arlo_device)
+
+    async def turnOff(self) -> None:
+        self.logger.info("Turning off")
+        self.provider.arlo.SirenOff(self.arlo_device)

plugins/bticino/package.json

@@ -1,50 +1,49 @@
-{
-   "name": "@scrypted/bticino",
-   "version": "0.0.5",
-   "scripts": {
-      "scrypted-setup-project": "scrypted-setup-project",
-      "prescrypted-setup-project": "scrypted-package-json",
-      "build": "scrypted-webpack",
-      "prepublishOnly": "NODE_ENV=production scrypted-webpack",
-      "prescrypted-vscode-launch": "scrypted-webpack",
-      "scrypted-vscode-launch": "scrypted-deploy-debug",
-      "scrypted-deploy-debug": "scrypted-deploy-debug",
-      "scrypted-debug": "scrypted-debug",
-      "scrypted-deploy": "scrypted-deploy",
-      "scrypted-readme": "scrypted-readme",
-      "scrypted-package-json": "scrypted-package-json"
-   },
-   "keywords": [
-      "scrypted",
-      "plugin",
-      "sip"
-   ],
-   "scrypted": {
-      "name": "BTicino SIP Plugin",
-      "type": "DeviceProvider",
-      "interfaces": [
-         "DeviceProvider",
-         "DeviceCreator"
-      ],
-      "pluginDependencies": [
-         "@scrypted/prebuffer-mixin",
-         "@scrypted/pam-diff",
-         "@scrypted/snapshot"
-      ]
-   },
-   "dependencies": {
-      "@homebridge/camera-utils": "^2.0.4",
-      "rxjs": "^7.5.5",
-      "sdp": "^3.0.3",
-      "sip": "0.0.6",
-      "stun": "^2.1.0",
-      "ts-node": "^10.9.1",
-      "uuid": "^8.3.2"
-   },
-   "devDependencies": {
-      "@scrypted/common": "file:../../common",
-      "@scrypted/sdk": "file:../../sdk",
-      "@types/node": "^16.9.6",
-      "@types/uuid": "^8.3.4"
-   }
-}
+{
+   "name": "@scrypted/bticino",
+   "version": "0.0.7",
+   "scripts": {
+      "scrypted-setup-project": "scrypted-setup-project",
+      "prescrypted-setup-project": "scrypted-package-json",
+      "build": "scrypted-webpack",
+      "prepublishOnly": "cross-env NODE_ENV=production scrypted-webpack",
+      "prescrypted-vscode-launch": "scrypted-webpack",
+      "scrypted-vscode-launch": "scrypted-deploy-debug",
+      "scrypted-deploy-debug": "scrypted-deploy-debug",
+      "scrypted-debug": "scrypted-debug",
+      "scrypted-deploy": "scrypted-deploy",
+      "scrypted-readme": "scrypted-readme",
+      "scrypted-package-json": "scrypted-package-json"
+   },
+   "keywords": [
+      "scrypted",
+      "plugin",
+      "sip"
+   ],
+   "scrypted": {
+      "name": "BTicino SIP Plugin",
+      "type": "DeviceProvider",
+      "interfaces": [
+         "DeviceProvider",
+         "DeviceCreator"
+      ],
+      "pluginDependencies": [
+         "@scrypted/prebuffer-mixin",
+         "@scrypted/pam-diff",
+         "@scrypted/snapshot"
+      ]
+   },
+   "dependencies": {
+      "@slyoldfox/sip": "^0.0.6-1",
+      "sdp": "^3.0.3",
+      "stun": "^2.1.0",
+      "uuid": "^8.3.2"
+   },
+   "devDependencies": {
+      "@scrypted/common": "file:../../common",
+      "@scrypted/sdk": "file:../../sdk",
+      "@types/node": "^16.9.6",
+      "@types/uuid": "^8.3.4",
+      "cross-env": "^7.0.3",
+      "ts-node": "^10.9.1"
+   }
+}

plugins/bticino/src/bticino-camera.ts

@@ -0,0 +1,407 @@
+import { closeQuiet, createBindZero, listenZeroSingleClient } from '@scrypted/common/src/listen-cluster';
+import { sleep } from '@scrypted/common/src/sleep';
+import { RtspServer } from '@scrypted/common/src/rtsp-server';
+import { addTrackControls } from '@scrypted/common/src/sdp-utils';
+import sdk, { BinarySensor, Camera, DeviceProvider, FFmpegInput, HttpRequest, HttpRequestHandler, HttpResponse, Intercom, MediaObject, MediaStreamUrl, PictureOptions, ResponseMediaStreamOptions, ScryptedDevice, ScryptedDeviceBase, ScryptedMimeTypes, Setting, Settings, SettingValue, VideoCamera, VideoClip, VideoClipOptions, VideoClips } from '@scrypted/sdk';
+import { SipCallSession } from '../../sip/src/sip-call-session';
+import { RtpDescription } from '../../sip/src/rtp-utils';
+import { VoicemailHandler } from './bticino-voicemailHandler';
+import { CompositeSipMessageHandler } from '../../sip/src/compositeSipMessageHandler';
+import { SipHelper } from './sip-helper';
+import child_process, { ChildProcess } from 'child_process';
+import dgram from 'dgram';
+import { BticinoStorageSettings } from './storage-settings';
+import { BticinoSipPlugin } from './main';
+import { BticinoSipLock } from './bticino-lock';
+import { ffmpegLogInitialOutput, safeKillFFmpeg, safePrintFFmpegArguments } from '@scrypted/common/src/media-helpers';
+import { PersistentSipManager } from './persistent-sip-manager';
+import { InviteHandler } from './bticino-inviteHandler';
+import { SipRequest } from '../../sip/src/sip-manager';
+
+import { get } from 'http'
+
+const STREAM_TIMEOUT = 65000;
+const { mediaManager } = sdk;
+
+export class BticinoSipCamera extends ScryptedDeviceBase implements DeviceProvider, Intercom, Camera, VideoCamera, Settings, BinarySensor, HttpRequestHandler, VideoClips {
+
+    private session: SipCallSession
+    private remoteRtpDescription: RtpDescription
+    private audioOutForwarder: dgram.Socket
+    private audioOutProcess: ChildProcess
+    private currentMedia: FFmpegInput | MediaStreamUrl
+    private currentMediaMimeType: string
+    private refreshTimeout: NodeJS.Timeout
+    public requestHandlers: CompositeSipMessageHandler = new CompositeSipMessageHandler()
+    public incomingCallRequest : SipRequest
+    private settingsStorage: BticinoStorageSettings = new BticinoStorageSettings( this )
+    public voicemailHandler : VoicemailHandler = new VoicemailHandler(this)
+    private inviteHandler : InviteHandler = new InviteHandler(this)
+    //TODO: randomize this
+    private keyAndSalt : string = "/qE7OPGKp9hVGALG2KcvKWyFEZfSSvm7bYVDjT8X"
+    //private decodedSrtpOptions : SrtpOptions = decodeSrtpOptions( this.keyAndSalt )
+    private persistentSipManager : PersistentSipManager
+    public doorbellWebhookUrl : string
+    public doorbellLockWebhookUrl : string
+
+    constructor(nativeId: string, public provider: BticinoSipPlugin) {
+        super(nativeId)
+        
+        this.requestHandlers.add( this.voicemailHandler ).add( this.inviteHandler )
+        this.persistentSipManager = new PersistentSipManager( this );
+        (async() => {
+            this.doorbellWebhookUrl = await this.doorbellWebhookEndpoint()
+            this.doorbellLockWebhookUrl = await this.doorbellLockWebhookEndpoint()
+        })();
+    }
+
+    getVideoClips(options?: VideoClipOptions): Promise<VideoClip[]> {
+       return new Promise<VideoClip[]>(  (resolve,reject ) => {
+            let c300x = SipHelper.getIntercomIp(this)
+            if( !c300x ) return []
+            get(`http://${c300x}:8080/videoclips?raw=true&startTime=${options.startTime/1000}&endTime=${options.endTime/1000}`, (res) => {
+            let rawData = '';
+            res.on('data', (chunk) => { rawData += chunk; });
+            res.on('end', () => {
+                try {
+                    const parsedData : [] = JSON.parse(rawData);
+                    let videoClips : VideoClip[] = []
+                    parsedData.forEach( (item) => {
+                        let videoClip : VideoClip = {
+                            id: item['file'],
+                            startTime: parseInt(item['info']['UnixTime']) * 1000,
+                            duration: item['info']['Duration'] * 1000,
+                            //description: item['info']['Date'],
+                            thumbnailId: item['file']
+
+                        }
+                        videoClips.push( videoClip )
+                    } )
+                    return  resolve(videoClips)
+                } catch (e) {
+                    reject(e.message)
+                    console.error(e.message);
+                }
+                })
+            });                    
+        });
+    }
+
+    getVideoClip(videoId: string): Promise<MediaObject> {
+        let c300x = SipHelper.getIntercomIp(this)
+        const url = `http://${c300x}:8080/voicemail?msg=${videoId}/aswm.avi&raw=true`;
+        return mediaManager.createMediaObjectFromUrl(url);        
+    }
+    getVideoClipThumbnail(thumbnailId: string): Promise<MediaObject> {
+        let c300x = SipHelper.sipOptions(this)
+        const url = `http://${c300x}:8080/voicemail?msg=${thumbnailId}/aswm.jpg&raw=true`;
+        return mediaManager.createMediaObjectFromUrl(url);        
+    }
+
+    removeVideoClips(...videoClipIds: string[]): Promise<void> {
+        //TODO
+        throw new Error('Method not implemented.')
+    }
+
+    sipUnlock(): Promise<void> {
+        this.log.i("unlocking C300X door ")
+        return this.persistentSipManager.enable().then( (sipCall) => {
+            sipCall.message( '*8*19*20##' )
+            .then( () =>
+                sleep(1000)
+                    .then( () => sipCall.message( '*8*20*20##' ) )
+            )
+        } )
+    }
+
+    getAswmStatus() : Promise<void> {
+        return this.persistentSipManager.enable().then( (sipCall) => {
+            sipCall.message( "GetAswmStatus!" )
+        } )        
+    }
+
+    async takePicture(option?: PictureOptions): Promise<MediaObject> {
+        throw new Error("The SIP doorbell camera does not provide snapshots. Install the Snapshot Plugin if snapshots are available via an URL.");
+    }
+
+    async getPictureOptions(): Promise<PictureOptions[]> {
+        return
+    }
+
+    getSettings(): Promise<Setting[]> {
+        return this.settingsStorage.getSettings()
+    }
+ 
+    putSetting(key: string, value: SettingValue): Promise<void> {
+        return this.settingsStorage.putSetting(key, value)
+    }    
+
+    async startIntercom(media: MediaObject): Promise<void> {
+        if (!this.session)
+            throw new Error("not in call");
+
+        this.stopIntercom();
+
+        const ffmpegInput: FFmpegInput = JSON.parse((await mediaManager.convertMediaObjectToBuffer(media, ScryptedMimeTypes.FFmpegInput)).toString());
+
+        const audioOutForwarder = await createBindZero()
+        this.audioOutForwarder = audioOutForwarder.server
+        audioOutForwarder.server.on('message', message => {
+            if( this.session )
+                this.session.audioSplitter.send(message, 40004, this.remoteRtpDescription.address)
+            return null
+        });
+
+        const args = ffmpegInput.inputArguments.slice();
+        args.push(
+            '-vn', '-dn', '-sn',
+            '-acodec', 'speex',
+            '-flags', '+global_header',
+            '-ac', '1',
+            '-ar', '8k',
+            '-f', 'rtp',
+            //'-srtp_out_suite', 'AES_CM_128_HMAC_SHA1_80',
+            //'-srtp_out_params', encodeSrtpOptions(this.decodedSrtpOptions),
+            `rtp://127.0.0.1:${audioOutForwarder.port}?pkt_size=188`,
+        );
+
+        this.console.log("===========================================")
+        safePrintFFmpegArguments( this.console, args )
+        this.console.log("===========================================")
+
+        const cp = child_process.spawn(await mediaManager.getFFmpegPath(), args);
+        ffmpegLogInitialOutput(this.console, cp)
+        this.audioOutProcess = cp;
+        cp.on('exit', () => this.console.log('two way audio ended'));
+        this.session.onCallEnded.subscribe(() => {
+            closeQuiet(audioOutForwarder.server);
+            safeKillFFmpeg(cp)
+        });
+    }
+
+    async stopIntercom(): Promise<void> {
+        closeQuiet(this.audioOutForwarder)
+        this.audioOutProcess?.kill('SIGKILL')
+        this.audioOutProcess = undefined
+        this.audioOutForwarder = undefined
+    }
+
+    resetStreamTimeout() {
+        this.log.d('starting/refreshing stream')
+        clearTimeout(this.refreshTimeout)
+        this.refreshTimeout = setTimeout(() => this.stopSession(), STREAM_TIMEOUT)
+    }
+
+    hasActiveCall() {
+        return this.session;
+    }
+
+    stopSession() {
+        if (this.session) {
+            this.log.d('ending sip session')
+            this.session.stop()
+            this.session = undefined
+        }
+    }
+
+    async getVideoStream(options?: ResponseMediaStreamOptions): Promise<MediaObject> {
+        if( !SipHelper.sipOptions( this ) ) {
+            // Bail out fast when no options are set and someone enables prebuffering
+            throw new Error('Please configure from/to/domain settings')
+        }
+
+        if (options?.metadata?.refreshAt) {
+            if (!this.currentMedia?.mediaStreamOptions)
+                throw new Error("no stream to refresh");
+
+            const currentMedia = this.currentMedia
+            currentMedia.mediaStreamOptions.refreshAt = Date.now() + STREAM_TIMEOUT;
+            currentMedia.mediaStreamOptions.metadata = {
+                refreshAt: currentMedia.mediaStreamOptions.refreshAt
+            };
+            this.resetStreamTimeout()
+            return mediaManager.createMediaObject(currentMedia, this.currentMediaMimeType)
+        }
+
+        this.stopSession();
+
+
+        const { clientPromise: playbackPromise, port: playbackPort, url: clientUrl } = await listenZeroSingleClient()
+
+        const playbackUrl = clientUrl
+
+        playbackPromise.then(async (client) => {
+            client.setKeepAlive(true, 10000)
+            let sip: SipCallSession
+            try {
+                let rtsp: RtspServer;
+                const cleanup = () => {
+                    client.destroy();
+                    if (this.session === sip)
+                        this.session = undefined
+                    try {
+                        this.log.d('cleanup(): stopping sip session.')
+                        sip.stop()
+                    }
+                    catch (e) {
+                    }
+                    rtsp?.destroy()
+                }
+
+                client.on('close', cleanup)
+                client.on('error', cleanup)
+
+                let sipOptions = SipHelper.sipOptions( this )
+
+                sip = await this.persistentSipManager.session( sipOptions );
+                // Validate this sooner
+                if( !sip ) return Promise.reject("Cannot create session")
+                
+                sip.onCallEnded.subscribe(cleanup)
+
+                // Call the C300X
+                this.remoteRtpDescription = await sip.callOrAcceptInvite(
+                    ( audio ) => {
+                    return [
+                        //TODO: Payload types are hardcoded
+                        `m=audio 65000 RTP/SAVP 110`,
+                        `a=rtpmap:110 speex/8000`,
+                        `a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${this.keyAndSalt}`,
+                    ]
+                }, ( video ) => {
+                    if( false ) {
+                        //TODO: implement later
+                        return [
+                            `m=video 0 RTP/SAVP 0`
+                        ]
+                    } else {
+                        return [
+                            //TODO: Payload types are hardcoded
+                            `m=video 65002 RTP/SAVP 96`,
+                            `a=rtpmap:96 H264/90000`,
+                            `a=fmtp:96 profile-level-id=42801F`,
+                            `a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${this.keyAndSalt}`,
+                            'a=recvonly'                        
+                        ]
+                    }
+                }, this.incomingCallRequest );
+
+                this.incomingCallRequest = undefined
+
+                //let sdp: string = replacePorts(this.remoteRtpDescription.sdp, 0, 0 )
+                let sdp : string = [ 
+                    "v=0",
+                    "m=audio 5000 RTP/AVP 110",
+                    "c=IN IP4 127.0.0.1",
+                    "a=rtpmap:110 speex/8000/1",
+                    "m=video 5002 RTP/AVP 96",
+                    "c=IN IP4 127.0.0.1",
+                    "a=rtpmap:96 H264/90000",
+                ].join('\r\n')
+                //sdp = sdp.replaceAll(/a=crypto\:1.*/g, '')
+                //sdp = sdp.replaceAll(/RTP\/SAVP/g, 'RTP\/AVP')
+                //sdp = sdp.replaceAll('\r\n\r\n', '\r\n')
+                sdp = addTrackControls(sdp)
+                sdp = sdp.split('\n').filter(line => !line.includes('a=rtcp-mux')).join('\n')
+                if( sipOptions.debugSip )
+                    this.log.d('SIP: Updated SDP:\n' + sdp);
+
+                client.write(sdp)
+                client.end()
+
+                this.session = sip
+            }
+            catch (e) {
+                this.console.error(e)
+                sip?.stop()
+                throw e;
+            }
+        });
+
+        this.resetStreamTimeout();
+
+        const mediaStreamOptions = Object.assign(this.getSipMediaStreamOptions(), {
+            refreshAt: Date.now() + STREAM_TIMEOUT,
+        });
+
+        const ffmpegInput: FFmpegInput = {
+            url: undefined,
+            container: 'sdp',
+            mediaStreamOptions,
+            inputArguments: [
+                '-f', 'sdp',
+                '-i', playbackUrl,
+            ],
+        };
+        this.currentMedia = ffmpegInput;
+        this.currentMediaMimeType = ScryptedMimeTypes.FFmpegInput;
+
+        return mediaManager.createFFmpegMediaObject(ffmpegInput);
+    }
+
+    getSipMediaStreamOptions(): ResponseMediaStreamOptions {
+        return {
+            id: 'sip',
+            name: 'SIP',
+            // this stream is NOT scrypted blessed due to wackiness in the h264 stream.
+            // tool: "scrypted",
+            container: 'sdp',
+            audio: {
+                // this is a hint to let homekit, et al, know that it's speex audio and needs transcoding.
+                codec: 'speex',
+            },
+            source: 'cloud', // to disable prebuffering
+            userConfigurable: false,
+        };
+    }
+
+    async getVideoStreamOptions(): Promise<ResponseMediaStreamOptions[]> {
+        return [
+            this.getSipMediaStreamOptions(),
+        ]
+    }
+
+    async getDevice(nativeId: string) : Promise<BticinoSipLock> {
+        return new BticinoSipLock(this)
+    }
+
+    async releaseDevice(id: string, nativeId: string): Promise<void> {
+    }    
+
+    reset() {
+        this.console.log("Reset the incoming call request")
+        this.incomingCallRequest = undefined
+        this.binaryState = false
+    }    
+
+    public async onRequest(request: HttpRequest, response: HttpResponse): Promise<void> {
+        if (request.url.endsWith('/pressed')) {
+            this.binaryState = true
+            setTimeout( () => {
+                // Assumption that flexisip only holds this call active for 20 seconds ... might be revised
+                this.reset()
+            }, 20 * 1000 )            
+            response.send('Success', {
+                code: 200,
+            });
+        } else {
+            response.send('Unsupported operation', {
+                code: 400,
+            });
+        }
+    }        
+
+    private async doorbellWebhookEndpoint(): Promise<string> {
+        let webhookUrl = await sdk.endpointManager.getLocalEndpoint( this.nativeId, { insecure: false, public: true });
+        let endpoints = ["/pressed"]
+        this.console.log( webhookUrl + " , endpoints: " + endpoints.join(' - ') )
+        return `${webhookUrl}`;
+    }
+
+    private async doorbellLockWebhookEndpoint(): Promise<string> {
+        let webhookUrl = await sdk.endpointManager.getLocalEndpoint(this.nativeId + '-lock', { insecure: false, public: true });
+        let endpoints = ["/lock", "/unlock", "/unlocked", "/locked"]
+        this.console.log( webhookUrl + " -> endpoints: " + endpoints.join(' - ') )
+        return `${webhookUrl}`;
+    }  
+}

plugins/bticino/src/bticino-inviteHandler.ts

@@ -0,0 +1,32 @@
+import { SipRequestHandler, SipRequest } from "../../sip/src/sip-manager"
+import { BticinoSipCamera } from "./bticino-camera"
+import { stringifyUri } from '@slyoldfox/sip'
+
+export class InviteHandler extends SipRequestHandler {
+    constructor( private sipCamera : BticinoSipCamera ) {
+        super()
+        this.sipCamera.binaryState = false
+    }
+
+    handle(request: SipRequest) {
+        //TODO: restrict this to call from:c300x@ AND to:alluser@ ?
+        if( request.method == 'CANCEL' ) {
+            let reason = request.headers["reason"] ? ( ' - ' + request.headers["reason"] ) : ''
+            this.sipCamera.console.log('CANCEL voice call from: ' + stringifyUri( request.headers.from.uri ) + ' to: ' + stringifyUri( request.headers.to.uri ) + reason )
+            this.sipCamera?.reset()
+        }
+        if( request.method === 'INVITE' ) {
+            this.sipCamera.console.log("INCOMING voice call from: " + stringifyUri( request.headers.from.uri ) + ' to: ' + stringifyUri( request.headers.to.uri ) )
+
+            this.sipCamera.binaryState = true
+            this.sipCamera.incomingCallRequest = request
+
+            setTimeout( () => {
+                // Assumption that flexisip only holds this call active for 20 seconds ... might be revised
+                this.sipCamera?.reset()
+            }, 20 * 1000 )
+        }
+    }
+
+
+}

plugins/bticino/src/bticino-lock.ts

@@ -0,0 +1,56 @@
+import sdk, { ScryptedDeviceBase, Lock, LockState, HttpRequest, HttpResponse, HttpRequestHandler } from "@scrypted/sdk";
+import { BticinoSipCamera } from "./bticino-camera";
+
+export class BticinoSipLock extends ScryptedDeviceBase implements Lock, HttpRequestHandler {
+    private timeout : NodeJS.Timeout
+
+    constructor(public camera: BticinoSipCamera) {
+        super( camera.nativeId + "-lock")
+    }
+
+    lock(): Promise<void> {
+        if( !this.timeout ) {
+           this.timeout = setTimeout(() => {
+            this.lockState = LockState.Locked
+            this.timeout = undefined
+           } , 3000);
+        } else {
+            this.camera.console.log("Still attempting previous locking ...")
+        }        
+        return
+    }
+
+    unlock(): Promise<void> {
+        this.lockState = LockState.Unlocked
+        this.lock()
+        return this.camera.sipUnlock()
+    }
+
+    public async onRequest(request: HttpRequest, response: HttpResponse): Promise<void> {
+        if (request.url.endsWith('/unlocked')) {
+            this.lockState = LockState.Unlocked
+            response.send('Success', {
+                code: 200,
+            });
+        } else if( request.url.endsWith('/locked') ) {
+            this.lockState = LockState.Locked
+            response.send('Success', {
+                code: 200,
+            });
+        } else if( request.url.endsWith('/lock') ) {
+            this.lock();
+            response.send('Success', {
+                code: 200,
+            });
+        } else if( request.url.endsWith('/unlock') ) {
+            this.unlock();
+            response.send('Success', {
+                code: 200,
+            });                        
+        } else {
+            response.send('Unsupported operation', {
+                code: 400,
+            });
+        }
+    }    
+}

plugins/bticino/src/bticino-voicemailHandler.ts

@@ -0,0 +1,69 @@
+import { SipRequestHandler, SipRequest } from "../../sip/src/sip-manager"
+import { BticinoSipCamera } from "./bticino-camera"
+
+export class VoicemailHandler extends SipRequestHandler {
+    private timeout : NodeJS.Timeout
+    
+    constructor( private sipCamera : BticinoSipCamera ) {
+        super()
+        setTimeout( () => {
+            // Delay a bit an run in a different thread in case this fails
+            this.checkVoicemail()
+        }, 10000 )
+    }
+
+    checkVoicemail() {
+        if( !this.sipCamera )
+            return
+        if( this.isEnabled() ) {
+            this.sipCamera.console.debug("Checking answering machine, cameraId: " + this.sipCamera.id )
+            this.sipCamera.getAswmStatus().catch( e => this.sipCamera.console.error(e) )
+        } else {
+            this.sipCamera.console.debug("Answering machine check not enabled, cameraId: " + this.sipCamera.id )
+        }
+        //TODO: make interval customizable, now every 5 minutes
+        this.timeout = setTimeout( () => this.checkVoicemail() , 5 * 60 * 1000 )
+    }
+
+    cancelVoicemailCheck() {
+        if( this.timeout ) {
+            clearTimeout(this.timeout)
+        }
+    }
+
+    handle(request: SipRequest) {
+        if( this.isEnabled() ) {
+            const lastVoicemailMessageTimestamp : number = Number.parseInt( this.sipCamera.storage.getItem('lastVoicemailMessageTimestamp') ) || -1
+            const message : string = request.content.toString()
+            if( message.startsWith('*#8**40*0*0*1176*0*2##') ) {
+                this.sipCamera.console.debug("Handling incoming answering machine reply")
+                const messages : string[] = message.split(';')
+                let lastMessageTimestamp : number = 0
+                let countNewMessages : number = 0
+                messages.forEach( (message, index) => {
+                    if( index > 0 ) {
+                        const parts = message.split('|')
+                        if( parts.length == 4 ) {
+                            let messageTimestamp = Number.parseInt( parts[2] )
+                            if( messageTimestamp > lastVoicemailMessageTimestamp )
+                                countNewMessages++
+                            if( index == messages.length-2 ) 
+                                lastMessageTimestamp = messageTimestamp
+                        }
+                    }
+                } )
+                if( (lastVoicemailMessageTimestamp == null && lastMessageTimestamp > 0) ||
+                 ( lastVoicemailMessageTimestamp != null && lastMessageTimestamp > lastVoicemailMessageTimestamp ) ) {
+                    this.sipCamera.log.a(`You have ${countNewMessages} new voicemail messages.`)
+                    this.sipCamera.storage.setItem('lastVoicemailMessageTimestamp', lastMessageTimestamp.toString())
+                 } else {
+                    this.sipCamera.console.debug("No new messages since: " + lastVoicemailMessageTimestamp + " lastMessage: " + lastMessageTimestamp)
+                 }
+            }
+        }
+    }
+
+    isEnabled() : boolean {
+        return this.sipCamera?.storage?.getItem('notifyVoicemail')?.toLocaleLowerCase() === 'true' || false
+    }
+}  

plugins/bticino/src/main.ts

@@ -1,379 +1,97 @@
-import { listenZeroSingleClient } from '@scrypted/common/src/listen-cluster';
-import { SipMessageHandler, SipCall, SipOptions, SipRequest } from '../../sip/src/sip-call';
-import { RtspServer } from '@scrypted/common/src/rtsp-server';
-import { addTrackControls, parseSdp, replacePorts } from '@scrypted/common/src/sdp-utils';
-import { StorageSettings } from '@scrypted/sdk/storage-settings';
-import sdk, { BinarySensor, Camera, DeviceCreator, DeviceCreatorSettings, DeviceProvider, FFmpegInput, Intercom, MediaObject, MediaStreamUrl, PictureOptions, ResponseMediaStreamOptions, ScryptedDeviceBase, ScryptedDeviceType, ScryptedInterface, ScryptedMimeTypes, Setting, Settings, SettingValue, VideoCamera } from '@scrypted/sdk';
-import { SipSession } from '../../sip/src/sip-session';
-import { isStunMessage, getPayloadType, getSequenceNumber, isRtpMessagePayloadType } from '../../sip/src/rtp-utils';
-import { randomBytes } from 'crypto';
-
-const STREAM_TIMEOUT = 50000;
-const SIP_EXPIRATION_DEFAULT = 3600;
-const { deviceManager, mediaManager } = sdk;
-
-export class SipCamera extends ScryptedDeviceBase implements Intercom, Camera, VideoCamera, Settings, BinarySensor {
-    session: SipSession;
-    currentMedia: FFmpegInput | MediaStreamUrl;
-    currentMediaMimeType: string;
-    refreshTimeout: NodeJS.Timeout;
-    messageHandler: SipMessageHandler;
-
-    constructor(nativeId: string, public provider: SipCamProvider) {
-        super(nativeId);
-        let logger = this.log;
-        this.messageHandler = new class extends SipMessageHandler {
-                handle( request: SipRequest ) {
-                    // TODO: implement netatmo.onPresence handling?
-                    // {"jsonrpc":"2.0","method":"netatmo.onPresence","params":[{"persons":[]}]}
-                    logger.d("remote message: " + request.content );
-                }
-            }()
-        }
-
-    async takePicture(option?: PictureOptions): Promise<MediaObject> {
-        throw new Error("The SIP doorbell camera does not provide snapshots. Install the Snapshot Plugin if snapshots are available via an URL.");
-    }
-
-    async getPictureOptions(): Promise<PictureOptions[]> {
-        return;
-    }
-
-    settingsStorage = new StorageSettings(this, {
-        sipfrom: {
-            title: 'SIP From: URI',
-            type: 'string',
-            value: this.storage.getItem('sipfrom'),
-            description: 'SIP URI From field: Using the IP address of your server you will be calling from. Also the user and IP you added in /etc/flexisip/users/route_ext.conf on the intercom.',
-            placeholder: 'user@192.168.0.111',
-            multiple: false,
-        },
-        sipto: {
-            title: 'SIP To: URI',
-            type: 'string',
-            description: 'SIP URI To field: Must look like c300x@IP;transport=udp;rport and UDP transport is the only one supported right now.',
-            placeholder: 'c300x@192.168.0.2[:5060];transport=udp;rport',
-        },
-        sipdomain: {
-            title: 'SIP domain',
-            type: 'string',
-            description: 'SIP domain: The internal BTicino domain, usually has the following format: 2048362.bs.iotleg.com',
-            placeholder: '2048362.bs.iotleg.com',
-        },
-        sipexpiration: {
-            title: 'SIP UA expiration',
-            type: 'number',
-            range: [60, SIP_EXPIRATION_DEFAULT],
-            description: 'SIP UA expiration: How long the UA should remain active before expiring. Use 3600.',
-            placeholder: '3600',
-        },
-        sipdebug: {
-            title: 'SIP debug logging',
-            type: 'boolean',
-            description: 'Enable SIP debugging',
-            placeholder: 'true or false',
-        },
-    });
-
-    getSettings(): Promise<Setting[]> {
-        return this.settingsStorage.getSettings();
-    }
- 
-    putSetting(key: string, value: SettingValue): Promise<void> {
-        return this.settingsStorage.putSetting(key, value);
-    }    
-
-    async startIntercom(media: MediaObject): Promise<void> {
-        this.log.d( "TODO: startIntercom" + media );
-    }
-
-    async stopIntercom(): Promise<void> {
-        this.log.d( "TODO: stopIntercom" );
-    }
-
-    resetStreamTimeout() {
-        this.log.d('starting/refreshing stream');
-        clearTimeout(this.refreshTimeout);
-        this.refreshTimeout = setTimeout(() => this.stopSession(), STREAM_TIMEOUT);
-    }
-
-    stopSession() {
-        if (this.session) {
-            this.log.d('ending sip session');
-            this.session.stop();
-            this.session = undefined;
-        }
-    }
-
-    async getVideoStream(options?: ResponseMediaStreamOptions): Promise<MediaObject> {
-        if (options?.metadata?.refreshAt) {
-            if (!this.currentMedia?.mediaStreamOptions)
-                throw new Error("no stream to refresh");
-
-            const currentMedia = this.currentMedia;
-            currentMedia.mediaStreamOptions.refreshAt = Date.now() + STREAM_TIMEOUT;
-            currentMedia.mediaStreamOptions.metadata = {
-                refreshAt: currentMedia.mediaStreamOptions.refreshAt
-            };
-            this.resetStreamTimeout();
-            return mediaManager.createMediaObject(currentMedia, this.currentMediaMimeType);
-        }
-
-        this.stopSession();
-
-
-        const { clientPromise: playbackPromise, port: playbackPort, url: clientUrl } = await listenZeroSingleClient();
-
-        const playbackUrl = `rtsp://127.0.0.1:${playbackPort}`;
-
-        playbackPromise.then(async (client) => {
-            client.setKeepAlive(true, 10000);
-            let sip: SipSession;
-            try {
-                let rtsp: RtspServer;
-                const cleanup = () => {
-                    client.destroy();
-                    if (this.session === sip)
-                        this.session = undefined;
-                    try {
-                        this.log.d('cleanup(): stopping sip session.');
-                        sip.stop();
-                    }
-                    catch (e) {
-                    }
-                    rtsp?.destroy();
-                }
-
-                client.on('close', cleanup);
-                client.on('error', cleanup);
-
-                const from = this.storage.getItem('sipfrom')?.trim();
-                const to = this.storage.getItem('sipto')?.trim();
-                const localIp = from?.split(':')[0].split('@')[1];
-                const localPort = parseInt(from?.split(':')[1]) || 5060;
-                const domain = this.storage.getItem('sipdomain')?.trim();
-                const expiration : string = this.storage.getItem('sipuaexpiration')?.trim() || '3600';
-                const sipdebug : boolean = this.storage.getItem('sipdebug')?.toLocaleLowerCase() === 'true' || false;
-
-                if (!from || !to || !localIp || !localPort || !domain || !expiration ) {
-                    this.log.e('Error: SIP From/To/Domain URIs not specified!');
-                    return;
-                }        
-
-                //TODO settings
-                let sipOptions : SipOptions = { 
-                    from: "sip:" + from,
-                    to: "sip:" + to, 
-                    domain: domain,
-                    expire: Number.parseInt( expiration ),
-                    localIp,
-                    localPort,
-                    shouldRegister: true,
-                    debugSip: sipdebug,
-                    messageHandler: this.messageHandler
-                 };
-                sip = await SipSession.createSipSession(console, "Bticino", sipOptions);
-                
-                sip.onCallEnded.subscribe(cleanup);
-
-                // Call the C300X
-                let remoteRtpDescription = await sip.call(
-                    ( audio ) => {
-                    return [
-                        'a=DEVADDR:20', // Needed for bt_answering_machine (bticino specific)
-                        `m=audio ${audio.port} RTP/SAVP 97`,
-                        `a=rtpmap:97 speex/8000`,
-                        `a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:/qE7OPGKp9hVGALG2KcvKWyFEZfSSvm7bYVDjT8X`,
-                    ]
-                }, ( video ) => {
-                    return [
-                        `m=video ${video.port} RTP/SAVP 97`,
-                        `a=rtpmap:97 H264/90000`,
-                        `a=fmtp:97 profile-level-id=42801F`,
-                        `a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:/qE7OPGKp9hVGALG2KcvKWyFEZfSSvm7bYVDjT8X`,
-                        'a=recvonly'                        
-                    ]
-                } );
-                if( sipOptions.debugSip )
-                    this.log.d('SIP: Received remote SDP:\n' + remoteRtpDescription.sdp)
-
-                let sdp: string = replacePorts( remoteRtpDescription.sdp, 0, 0 );
-                sdp = addTrackControls(sdp);
-                sdp = sdp.split('\n').filter(line => !line.includes('a=rtcp-mux')).join('\n');
-                if( sipOptions.debugSip )
-                    this.log.d('SIP: Updated SDP:\n' + sdp);
-
-                let vseq = 0;
-                let vseen = 0;
-                let vlost = 0;
-                let aseq = 0;
-                let aseen = 0;
-                let alost = 0;  
-
-                rtsp = new RtspServer(client, sdp, true);
-                const parsedSdp = parseSdp(rtsp.sdp);
-                const videoTrack = parsedSdp.msections.find(msection => msection.type === 'video').control;
-                const audioTrack = parsedSdp.msections.find(msection => msection.type === 'audio').control;
-                if( sipOptions.debugSip ) {
-                    rtsp.console = this.console;
-                }
-                
-                await rtsp.handlePlayback();
-                sip.videoSplitter.on('message', message => {
-                    if (!isStunMessage(message)) {
-                        const isRtpMessage = isRtpMessagePayloadType(getPayloadType(message));
-                        if (!isRtpMessage)
-                            return;
-                        vseen++;
-                        rtsp.sendTrack(videoTrack, message, !isRtpMessage);
-                        const seq = getSequenceNumber(message);
-                        if (seq !== (vseq + 1) % 0x0FFFF)
-                            vlost++;
-                        vseq = seq;
-                    }
-                });
-
-                sip.videoRtcpSplitter.on('message', message => {
-                    rtsp.sendTrack(videoTrack, message, true);
-                });
-                
-                sip.audioSplitter.on('message', message => {
-                    if (!isStunMessage(message)) {
-                        const isRtpMessage = isRtpMessagePayloadType(getPayloadType(message));
-                        if (!isRtpMessage)
-                            return;
-                        aseen++;
-                        rtsp.sendTrack(audioTrack, message, !isRtpMessage);
-                        const seq = getSequenceNumber(message);
-                        if (seq !== (aseq + 1) % 0x0FFFF)
-                            alost++;
-                        aseq = seq;
-                    }
-                });
-
-                sip.audioRtcpSplitter.on('message', message => {
-                    rtsp.sendTrack(audioTrack, message, true);
-                });
-
-                this.session = sip;
-
-                try {
-                    await rtsp.handleTeardown();
-                    this.log.d('rtsp client ended');
-                }
-                catch (e) {
-                    this.log.e('rtsp client ended ungracefully' + e);
-                }
-                finally {
-                    cleanup();
-                }
-            }
-            catch (e) {
-                sip?.stop();
-                throw e;
-            }
-        });
-
-        this.resetStreamTimeout();
-
-        const mediaStreamOptions = Object.assign(this.getSipMediaStreamOptions(), {
-            refreshAt: Date.now() + STREAM_TIMEOUT,
-        });
-
-        const mediaStreamUrl: MediaStreamUrl = {
-            url: playbackUrl,
-            mediaStreamOptions,
-        };
-        this.currentMedia = mediaStreamUrl;
-        this.currentMediaMimeType = ScryptedMimeTypes.MediaStreamUrl;
-
-        return mediaManager.createMediaObject(mediaStreamUrl, ScryptedMimeTypes.MediaStreamUrl);
-    }
-
-    getSipMediaStreamOptions(): ResponseMediaStreamOptions {
-        return {
-            id: 'sip',
-            name: 'SIP',
-            // this stream is NOT scrypted blessed due to wackiness in the h264 stream.
-            // tool: "scrypted",
-            container: 'sdp',
-            audio: {
-                // this is a hint to let homekit, et al, know that it's speex audio and needs transcoding.
-                codec: 'speex',
-            },
-            source: 'local',
-            userConfigurable: false,
-        };
-    }
-
-    async getVideoStreamOptions(): Promise<ResponseMediaStreamOptions[]> {
-        return [
-            this.getSipMediaStreamOptions(),
-        ]
-    }
-}
-
-export class SipCamProvider extends ScryptedDeviceBase implements DeviceProvider, DeviceCreator {
-
-    devices = new Map<string, any>();
-
-    constructor(nativeId?: string) {
-        super(nativeId);
-
-        for (const camId of deviceManager.getNativeIds()) {
-            if (camId)
-                this.getDevice(camId);
-        }
-    }
-
-    async releaseDevice(id: string, nativeId: string): Promise<void> {
-    }
-
-    async createDevice(settings: DeviceCreatorSettings): Promise<string> {
-        const nativeId = randomBytes(4).toString('hex');
-        const name = settings.newCamera.toString();
-        await this.updateDevice(nativeId, name);
-        return nativeId;
-    }
-
-    async getCreateDeviceSettings(): Promise<Setting[]> {
-        return [
-            {
-                key: 'newCamera',
-                title: 'Add Camera',
-                placeholder: 'Camera name, e.g.: Back Yard Camera, Baby Camera, etc',
-            }
-        ]
-    }
-
-    updateDevice(nativeId: string, name: string) {
-        return deviceManager.onDeviceDiscovered({
-            nativeId,
-            name,
-            interfaces: [
-                ScryptedInterface.Camera,
-                ScryptedInterface.VideoCamera,
-                ScryptedInterface.Settings,
-                ScryptedInterface.Intercom,
-                ScryptedInterface.BinarySensor
-            ],
-            type: ScryptedDeviceType.Doorbell,
-        });
-    }
-
-    getDevice(nativeId: string) {
-        let ret = this.devices.get(nativeId);
-        if (!ret) {
-            ret = this.createCamera(nativeId);
-            if (ret)
-                this.devices.set(nativeId, ret);
-        }
-        return ret;
-    }
-
-    createCamera(nativeId: string): SipCamera {
-        return new SipCamera(nativeId, this);
-    }
-}
-
-export default new SipCamProvider();
+import sdk, { Device, DeviceCreator, DeviceCreatorSettings, DeviceProvider, LockState, ScryptedDeviceBase, ScryptedDeviceType, ScryptedInterface, Setting } from '@scrypted/sdk'
+import { randomBytes } from 'crypto'
+import { BticinoSipCamera } from './bticino-camera'
+
+const { systemManager, deviceManager } = sdk
+
+export class BticinoSipPlugin extends ScryptedDeviceBase implements DeviceProvider, DeviceCreator {
+
+    devices = new Map<string, BticinoSipCamera>()
+
+    async getCreateDeviceSettings(): Promise<Setting[]> {
+        return [
+            {
+                key: 'newCamera',
+                title: 'Add Camera',
+                placeholder: 'Camera name, e.g.: Back Yard Camera, Baby Camera, etc',
+            }
+        ]
+    }
+
+    async createDevice(settings: DeviceCreatorSettings): Promise<string> {
+        const nativeId = randomBytes(4).toString('hex')
+        const name = settings.newCamera?.toString()
+        const camera = await this.updateDevice(nativeId, name)
+
+        const device: Device = {
+            providerNativeId: nativeId,
+            info: {
+                //model: `${camera.model} (${camera.data.kind})`,
+                manufacturer: 'BticinoPlugin',
+                //firmware: camera.data.firmware_version,
+                //serialNumber: camera.data.device_id
+            },
+            nativeId: nativeId + '-lock',
+            name: name + ' Lock',
+            type: ScryptedDeviceType.Lock,
+            interfaces: [ScryptedInterface.Lock, ScryptedInterface.HttpRequestHandler],
+        }
+
+        const ret = await deviceManager.onDevicesChanged({
+            providerNativeId: nativeId,
+            devices: [device],
+        })
+
+        let sipCamera : BticinoSipCamera = await this.getDevice(nativeId)
+        let foo : BticinoSipCamera = systemManager.getDeviceById<BticinoSipCamera>(sipCamera.id)
+
+        let lock = await sipCamera.getDevice(undefined)
+        lock.lockState = LockState.Locked
+
+        return nativeId
+    }
+
+    updateDevice(nativeId: string, name: string) {
+        return deviceManager.onDeviceDiscovered({
+            nativeId,
+            info: {
+                //model: `${camera.model} (${camera.data.kind})`,
+                manufacturer: 'BticinoSipPlugin',
+                //firmware: camera.data.firmware_version,
+                //serialNumber: camera.data.device_id
+            },
+            name,
+            interfaces: [
+                ScryptedInterface.Camera,
+                ScryptedInterface.VideoCamera,
+                ScryptedInterface.Settings,
+                ScryptedInterface.Intercom,
+                ScryptedInterface.BinarySensor,
+                ScryptedDeviceType.DeviceProvider,
+                ScryptedInterface.HttpRequestHandler,
+                ScryptedInterface.VideoClips
+            ],
+            type: ScryptedDeviceType.Doorbell,
+        })
+    }
+
+    async getDevice(nativeId: string): Promise<any> {
+        if (!this.devices.has(nativeId)) {
+            const camera = new BticinoSipCamera(nativeId, this)
+            this.devices.set(nativeId, camera)
+        }
+        return this.devices.get(nativeId)
+    }
+
+    async releaseDevice(id: string, nativeId: string): Promise<void> {
+        let camera = this.devices.get(nativeId)
+        if( camera ) {
+            camera.voicemailHandler.cancelVoicemailCheck()
+            if( this.devices.delete( nativeId ) ) {
+                this.console.log("Removed device from list: " + id + " / " + nativeId )   
+            }
+        }
+    }
+}
+
+export default new BticinoSipPlugin()

plugins/bticino/src/persistent-sip-manager.ts

@@ -0,0 +1,71 @@
+import { SipCallSession } from "../../sip/src/sip-call-session";
+import { BticinoSipCamera } from "./bticino-camera";
+import { SipHelper } from "./sip-helper";
+import { SipManager, SipOptions } from "../../sip/src/sip-manager";
+
+/**
+ * This class registers itself with the SIP server as a contact for a user account.
+ * The registration expires after the expires time in sipOptions is reached.
+ * The sip session will re-register itself after the expires time is reached.
+ */
+const CHECK_INTERVAL : number = 10 * 1000
+export class PersistentSipManager {
+    
+    private sipManager : SipManager
+    private lastRegistration : number = 0
+    private expireInterval : number = 0
+
+    constructor( private camera : BticinoSipCamera ) {
+        // Give it a second and run in seperate thread to avoid failure on creation for from/to/domain check
+        setTimeout( () => this.enable() , CHECK_INTERVAL )
+    }
+
+    async enable() : Promise<SipManager> {
+        if( this.sipManager ) {
+            return this.sipManager
+        } else { 
+            return this.register()
+        }
+    }
+
+    private async register() : Promise<SipManager> {
+        let now = Date.now()
+        try {
+            let sipOptions : SipOptions = SipHelper.sipOptions( this.camera )
+            if( Number.isNaN( sipOptions.expire ) ||  sipOptions.expire <= 0 || sipOptions.expire > 3600 ) {
+                sipOptions.expire = 300
+            }
+            if( this.expireInterval == 0 ) {
+                this.expireInterval = (sipOptions.expire * 1000) - 10000
+            }
+
+            if( !this.camera.hasActiveCall() && now - this.lastRegistration >= this.expireInterval )  {
+                let sipOptions : SipOptions = SipHelper.sipOptions( this.camera )
+
+                this.sipManager?.destroy()
+                this.sipManager = new SipManager(this.camera.console, sipOptions )
+                await this.sipManager.register()
+
+                this.lastRegistration = now
+
+                return this.sipManager;
+            }
+        } catch(e) {
+            this.camera.console.error("Error enabling persistent SIP manager: " + e )
+            // Try again in a minute
+            this.lastRegistration = now + (60 * 1000) - this.expireInterval
+            throw e
+        } finally {
+            setTimeout( () => this.register(), CHECK_INTERVAL )      
+        }
+    }
+
+    async session( sipOptions: SipOptions ) : Promise<SipCallSession> {
+        let sm = await this.enable()
+        return SipCallSession.createCallSession(this.camera.console, "Bticino", sipOptions, sm )
+    }
+
+    reloadSipOptions() {
+        this.sipManager?.setSipOptions( null )
+    }
+}

plugins/bticino/src/sip-helper.ts

@@ -0,0 +1,59 @@
+import { SipOptions } from "../../sip/src/sip-manager";
+import { BticinoSipCamera } from "./bticino-camera";
+import crypto from 'crypto';
+
+export class SipHelper {
+    public static sipOptions( camera : BticinoSipCamera ) : SipOptions {
+        // Might be removed soon?
+        if( camera.storage.getItem('sipto') && camera.storage.getItem('sipto').toString().indexOf(';') > 0 ) {
+            camera.storage.setItem('sipto', camera.storage.getItem('sipto').toString().split(';')[0] )
+        }
+        const from = camera.storage.getItem('sipfrom')?.trim()
+        const to = camera.storage.getItem('sipto')?.trim()
+        const localIp = from?.split(':')[0].split('@')[1]
+        // Although this might not occur directly, each camera should run on its own port
+        // Might need to use a random free port here (?)
+        const localPort = parseInt(from?.split(':')[1]) || 5060
+        const domain = camera.storage.getItem('sipdomain')?.trim()
+        const expiration : string = camera.storage.getItem('sipexpiration')?.trim() || '600'
+        const sipdebug : boolean = camera.storage.getItem('sipdebug')?.toLocaleLowerCase() === 'true' || false
+
+        if (!from || !to || !localIp || !localPort || !domain || !expiration ) {
+            camera.log.e('Error: SIP From/To/Domain URIs not specified!')
+            throw new Error('SIP From/To/Domain URIs not specified!')
+        }        
+
+        return { 
+            from: "sip:" + from,
+            //TCP is more reliable for large messages, also see useTcp=true below
+            to: "sip:" + to + ";transport=tcp",
+            domain: domain,
+            expire: Number.parseInt( expiration ),
+            localIp,
+            localPort,
+            debugSip: sipdebug,
+            gruuInstanceId: SipHelper.getGruuInstanceId(camera),
+            useTcp: true,
+            sipRequestHandler: camera.requestHandlers
+
+         } 
+    }    
+    
+    public static getIntercomIp( camera : BticinoSipCamera ): string {
+        let to = camera.storage.getItem('sipto')?.trim();
+        if( to  ) {
+            return to.split('@')[1];
+        }
+        return
+    }
+
+    public static getGruuInstanceId( camera : BticinoSipCamera ): string {
+        let md5 = camera.storage.getItem('md5hash')
+        if( !md5 ) {
+            md5 = crypto.createHash('md5').update( camera.nativeId ).digest("hex")
+            md5 = md5.substring(0, 8) + '-' + md5.substring(8, 12) + '-' + md5.substring(12,16) + '-' + md5.substring(16, 32)
+            camera.storage.setItem('md5has', md5)
+        }
+        return md5
+    }    
+}

plugins/bticino/src/storage-settings.ts

@@ -0,0 +1,78 @@
+import { Setting, SettingValue } from '@scrypted/sdk';
+import { StorageSettings } from '@scrypted/sdk/storage-settings';
+import { BticinoSipCamera } from './bticino-camera';
+
+export class BticinoStorageSettings {
+    private storageSettings
+    
+    constructor(camera : BticinoSipCamera) {
+        this.storageSettings = new StorageSettings( camera, {
+            sipfrom: {
+                title: 'SIP From: URI',
+                type: 'string',
+                value: camera.storage.getItem('sipfrom'),
+                description: 'SIP URI From field: Using the IP address of your server you will be calling from.',
+                placeholder: 'user@192.168.0.111',
+                multiple: false,
+            },
+            sipto: {
+                title: 'SIP To: URI',
+                type: 'string',
+                description: 'SIP URI To field: Must look like c300x@192.168.0.2',
+                placeholder: 'c300x@192.168.0.2',
+            },
+            sipdomain: {
+                title: 'SIP domain',
+                type: 'string',
+                description: 'SIP domain - tshe internal BTicino domain, usually has the following format: 2048362.bs.iotleg.com',
+                placeholder: '2048362.bs.iotleg.com',
+            },
+            sipexpiration: {
+                title: 'SIP UA expiration',
+                type: 'number',
+                range: [60, 3600],
+                description: 'How long the UA should remain active before expiring and having to re-register (in seconds)',
+                defaultValue: 600,
+                placeholder: '600',
+            },
+            sipdebug: {
+                title: 'SIP debug logging',
+                type: 'boolean',
+                description: 'Enable SIP debugging',
+                placeholder: 'true or false',
+            },     
+            notifyVoicemail: {
+                title: 'Notify on new voicemail messages',
+                type: 'boolean',
+                description: 'Enable voicemail alerts',
+                placeholder: 'true or false',
+            },   
+            doorbellWebhookUrl: {
+                title: 'Doorbell Sensor Webhook',
+                type: 'string',
+                readonly: true,
+                mapGet: () => {
+                    return camera.doorbellWebhookUrl;
+                },
+                description: 'Incoming doorbell sensor webhook url.',
+            },
+            doorbellLockWebhookUrl: {
+                title: 'Doorbell Lock Webhook',
+                type: 'string',
+                readonly: true,
+                mapGet: () => {
+                    return camera.doorbellLockWebhookUrl;
+                },
+                description: 'Incoming doorbell sensor webhook url.',
+            }            
+        });
+    }
+
+    getSettings(): Promise<Setting[]> {
+        return this.storageSettings.getSettings();
+    }
+ 
+    putSetting(key: string, value: SettingValue): Promise<void> {
+        return this.storageSettings.putSetting(key, value);
+    }       
+}

plugins/core/package-lock.json

@@ -1,12 +1,12 @@
 {
    "name": "@scrypted/core",
-   "version": "0.1.102",
+   "version": "0.1.103",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/core",
-         "version": "0.1.102",
+         "version": "0.1.103",
          "license": "Apache-2.0",
          "dependencies": {
             "@scrypted/common": "file:../../common",

plugins/core/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/core",
-   "version": "0.1.102",
+   "version": "0.1.103",
    "description": "Scrypted Core plugin. Provides the UI, websocket, and engine.io APIs.",
    "author": "Scrypted",
    "license": "Apache-2.0",

plugins/coreml/download_models.sh

@@ -1,20 +0,0 @@
-#!/bin/sh
-#    Copyright 2019 Google LLC
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        https://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-
-rm -rf all_models
-mkdir -p all_models
-cd all_models
-wget https://github.com/koush/coreml-survival-guide/raw/master/MobileNetV2%2BSSDLite/ObjectDetection/ObjectDetection/MobileNetV2_SSDLite.mlmodel
-wget https://raw.githubusercontent.com/koush/coreml-survival-guide/master/MobileNetV2%2BSSDLite/coco_labels.txt

plugins/coreml/fs/MobileNetV2_SSDLite.mlmodel

@@ -1 +0,0 @@
-../all_models/MobileNetV2_SSDLite.mlmodel

plugins/coreml/fs/coco_labels.txt

@@ -1 +0,0 @@
-../all_models/coco_labels.txt

plugins/coreml/package-lock.json

@@ -1,12 +1,12 @@
 {
    "name": "@scrypted/coreml",
-   "version": "0.0.24",
+   "version": "0.1.5",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/coreml",
-         "version": "0.0.24",
+         "version": "0.1.5",
          "devDependencies": {
             "@scrypted/sdk": "file:../../sdk"
          }

plugins/coreml/package.json

@@ -41,5 +41,5 @@
    "devDependencies": {
       "@scrypted/sdk": "file:../../sdk"
    },
-   "version": "0.0.24"
+   "version": "0.1.5"
 }

plugins/coreml/src/coreml/__init__.py

@@ -6,6 +6,10 @@ from predict import PredictPlugin, Prediction, Rectangle
 import coremltools as ct
 import os
 from PIL import Image
+import asyncio
+import concurrent.futures
+
+predictExecutor = concurrent.futures.ThreadPoolExecutor(2, "CoreML-Predict")
 
 def parse_label_contents(contents: str):
     lines = contents.splitlines()
@@ -25,17 +29,19 @@ class CoreMLPlugin(PredictPlugin, scrypted_sdk.BufferConverter, scrypted_sdk.Set
     def __init__(self, nativeId: str | None = None):
         super().__init__(MIME_TYPE, nativeId=nativeId)
 
-        modelPath = os.path.join(os.environ['SCRYPTED_PLUGIN_VOLUME'], 'zip', 'unzipped', 'fs', 'MobileNetV2_SSDLite.mlmodel')
-        self.model = ct.models.MLModel(modelPath)
+        labelsFile = self.downloadFile('https://raw.githubusercontent.com/koush/coreml-survival-guide/master/MobileNetV2%2BSSDLite/coco_labels.txt', 'coco_labels.txt')
+        modelFile = self.downloadFile('https://github.com/koush/coreml-survival-guide/raw/master/MobileNetV2%2BSSDLite/ObjectDetection/ObjectDetection/MobileNetV2_SSDLite.mlmodel', 'MobileNetV2_SSDLite.mlmodel')
+        
+        self.model = ct.models.MLModel(modelFile)
         
         self.modelspec = self.model.get_spec()
         self.inputdesc = self.modelspec.description.input[0]
         self.inputheight = self.inputdesc.type.imageType.height
         self.inputwidth = self.inputdesc.type.imageType.width
 
-        labels_contents = scrypted_sdk.zip.open(
-            'fs/coco_labels.txt').read().decode('utf8')
+        labels_contents = open(labelsFile, 'r').read()
         self.labels = parse_label_contents(labels_contents)
+        self.loop = asyncio.get_event_loop()
 
     # width, height, channels
     def get_input_details(self) -> Tuple[int, int, int]:
@@ -44,8 +50,12 @@ class CoreMLPlugin(PredictPlugin, scrypted_sdk.BufferConverter, scrypted_sdk.Set
     def get_input_size(self) -> Tuple[float, float]:
         return (self.inputwidth, self.inputheight)
 
-    def detect_once(self, input: Image.Image, settings: Any, src_size, cvss):
-        out_dict = self.model.predict({'image': input, 'confidenceThreshold': .2 })
+    async def detect_once(self, input: Image.Image, settings: Any, src_size, cvss):
+        # run in executor if this is the plugin loop
+        if asyncio.get_event_loop() is self.loop:
+            out_dict = await asyncio.get_event_loop().run_in_executor(predictExecutor, lambda: self.model.predict({'image': input, 'confidenceThreshold': .2 }))
+        else:
+            out_dict = self.model.predict({'image': input, 'confidenceThreshold': .2 })
 
         coordinatesList = out_dict['coordinates']
 

plugins/coreml/src/requirements.txt

@@ -3,3 +3,8 @@ Pillow>=5.4.1
 PyGObject>=3.30.4
 coremltools~=6.1
 av>=10.0.0; sys_platform != 'linux' or platform_machine == 'x86_64' or platform_machine == 'aarch64'
+
+# sort_oh
+scipy
+filterpy
+numpy

plugins/eufy/package-lock.json

@@ -33,6 +33,7 @@
          }
       },
       "../../packages/h264-repacketizer": {
+         "name": "@scrypted/h264-repacketizer",
          "version": "0.0.6",
          "license": "ISC",
          "devDependencies": {
@@ -43,7 +44,7 @@
       },
       "../../sdk": {
          "name": "@scrypted/sdk",
-         "version": "0.2.84",
+         "version": "0.2.85",
          "license": "ISC",
          "dependencies": {
             "@babel/preset-typescript": "^7.18.6",

plugins/eufy/src/main.ts

@@ -2,7 +2,7 @@ import { listenSingleRtspClient } from '@scrypted/common/src/rtsp-server';
 import { addTrackControls, parseSdp } from '@scrypted/common/src/sdp-utils';
 import sdk, { Battery, Camera, Device, DeviceProvider, FFmpegInput, MediaObject, MotionSensor, RequestMediaStreamOptions, RequestPictureOptions, ResponseMediaStreamOptions, ResponsePictureOptions, ScryptedDeviceBase, ScryptedDeviceType, ScryptedInterface, Setting, Settings, SettingValue, VideoCamera } from '@scrypted/sdk';
 import { StorageSettings } from '@scrypted/sdk/storage-settings';
-import eufy, { CaptchaOptions, EufySecurity } from 'eufy-security-client';
+import eufy, { CaptchaOptions, EufySecurity, P2PClientProtocol, P2PConnectionType } from 'eufy-security-client';
 import { startRtpForwarderProcess } from '../../webrtc/src/rtp-forwarders';
 
 import { Deferred } from '@scrypted/common/src/deferred';
@@ -11,17 +11,14 @@ import { LocalLivestreamManager } from './stream';
 
 const { deviceManager, mediaManager, systemManager } = sdk;
 
-class EufyCamera extends ScryptedDeviceBase implements Camera, VideoCamera, Battery, MotionSensor {
+class EufyCamera extends ScryptedDeviceBase implements VideoCamera, MotionSensor {
   client: EufySecurity;
   device: eufy.Camera;
-  livestreamManager: LocalLivestreamManager
 
   constructor(nativeId: string, client: EufySecurity, device: eufy.Camera) {
     super(nativeId);
     this.client = client;
     this.device = device;
-    this.livestreamManager = new LocalLivestreamManager(this.client, this.device, this.console);
-    this.batteryLevel = this.device.getBatteryValue() as number;
     this.setupMotionDetection();
   }
 
@@ -37,31 +34,6 @@ class EufyCamera extends ScryptedDeviceBase implements Camera, VideoCamera, Batt
     this.device.on('radar motion detected', handle);
   }
 
-  async takePicture(options?: RequestPictureOptions): Promise<MediaObject> {
-    // if this stream is prebuffered, its safe to use the prebuffer to generate an image
-    const realDevice = systemManager.getDeviceById<VideoCamera>(this.id);
-    try {
-        const msos = await realDevice.getVideoStreamOptions();
-        const prebuffered: RequestMediaStreamOptions = msos.find(mso => mso.prebuffer);
-        if (prebuffered) {
-            prebuffered.refresh = false;
-            return realDevice.getVideoStream(prebuffered);
-        }
-    } catch (e) {}
-
-    // try to fetch the cloud image if one exists
-    const url = this.device.getLastCameraImageURL();
-    if (url) {
-      return mediaManager.createMediaObjectFromUrl(url.toString());
-    }
-
-    throw new Error("snapshot unavailable");
-  }
-
-  getPictureOptions(): Promise<ResponsePictureOptions[]> {
-    return;
-  }
-
   getVideoStream(options?: ResponseMediaStreamOptions): Promise<MediaObject> {
     return this.createVideoStream(options);
   }
@@ -80,15 +52,32 @@ class EufyCamera extends ScryptedDeviceBase implements Camera, VideoCamera, Batt
         },
         tool: 'scrypted',
         userConfigurable: false,
-      }
+      },
+      {
+        container: 'rtsp',
+        id: 'p2p-low',
+        name: 'P2P (Low Resolution)',
+        video: {
+          codec: 'h264',
+          width: 1280,
+          height: 720,
+        },
+        audio: {
+          codec: 'aac',
+        },
+        tool: 'scrypted',
+        userConfigurable: false,
+      },
     ];
   }
 
   async createVideoStream(options?: ResponseMediaStreamOptions): Promise<MediaObject> {
+    const livestreamManager = new LocalLivestreamManager(options.id, this.client, this.device, this.console);
+
     const kill = new Deferred<void>();
     kill.promise.finally(() => {
       this.console.log('video stream exited');
-      this.livestreamManager.stopLocalLiveStream();
+      livestreamManager.stopLocalLiveStream();
     });
 
     const rtspServer = await listenSingleRtspClient();
@@ -138,7 +127,7 @@ class EufyCamera extends ScryptedDeviceBase implements Camera, VideoCamera, Batt
           await rtsp.handlePlayback();
         });
 
-        const proxyStream = await this.livestreamManager.getLocalLivestream();
+        const proxyStream = await livestreamManager.getLocalLivestream();
         proxyStream.videostream.pipe(process.cp.stdio[4] as Writable);
         proxyStream.audiostream.pipe((process.cp.stdio as any)[5] as Writable);
       }
@@ -240,14 +229,13 @@ class EufyPlugin extends ScryptedDeviceBase implements DeviceProvider, Settings
       password: this.storageSettings.values.password,
       country: this.storageSettings.values.country,
       language: 'en',
-      p2pConnectionSetup: 2,
+      p2pConnectionSetup: P2PConnectionType.QUICKEST,
       pollingIntervalMinutes: 10,
       eventDurationSeconds: 10
     }
     this.client = await EufySecurity.initialize(config);
     this.client.on('device added', this.deviceAdded.bind(this));
     this.client.on('station added', this.stationAdded.bind(this));
-
     this.client.on('tfa request', () => {
       this.log.a('Login failed: 2FA is enabled, check your email or texts for your code, then enter it into the Two Factor Code setting to conplete login.');
     });
@@ -277,7 +265,6 @@ class EufyPlugin extends ScryptedDeviceBase implements DeviceProvider, Settings
     const nativeId = eufyDevice.getSerial();
 
     const interfaces = [
-      ScryptedInterface.Camera,
       ScryptedInterface.VideoCamera
     ];
     if (eufyDevice.hasBattery())

plugins/eufy/src/stream.ts

@@ -1,7 +1,7 @@
 // Based off of https://github.com/homebridge-eufy-security/plugin/blob/master/src/plugin/controller/LocalLivestreamManager.ts
 
+import { Camera, CommandData, CommandName, CommandType, Device, DeviceType, EufySecurity, isGreaterEqualMinVersion, P2PClientProtocol, ParamType, Station, StreamMetadata, VideoCodec } from 'eufy-security-client';
 import { EventEmitter, Readable } from 'stream';
-import { Station, Device, StreamMetadata, Camera, EufySecurity } from 'eufy-security-client';
 
 type StationStream = {
   station: Station;
@@ -19,28 +19,39 @@ export class LocalLivestreamManager extends EventEmitter {
   private livestreamStartedAt: number | null;
   private livestreamIsStarting = false;
   
+  private readonly id: string;
   private readonly client: EufySecurity;
   private readonly device: Camera;
   
-  constructor(client: EufySecurity, device: Camera, console: Console) {    
+  private station: Station;
+  private p2pSession: P2PClientProtocol;
+  
+  constructor(id: string, client: EufySecurity, device: Camera, console: Console) {    
     super();
 
+    this.id = id;
     this.console = console;
     this.client = client;
     this.device = device;
+    
+    this.client.getStation(this.device.getStationSerial()).then( (station) => {
+      this.station = station;
+      this.p2pSession = new P2PClientProtocol(station.getRawStation(), this.client.getApi(), station.getIPAddress());
+      this.p2pSession.on("livestream started", (channel: number, metadata: StreamMetadata, videostream: Readable, audiostream: Readable) => {
+        this.onStationLivestreamStart(station, device, metadata, videostream, audiostream);
+      });
+      this.p2pSession.on("livestream stopped", (channel: number) => {
+        this.onStationLivestreamStop(station, device);
+      });
+      this.p2pSession.on("livestream error", (channel: number, error: Error) => {
+        this.stopLivestream();
+      });
+    });
 
     this.stationStream = null;
     this.livestreamStartedAt = null;
 
     this.initialize();
-
-    this.client.on('station livestream stop', (station: Station, device: Device) => {
-      this.onStationLivestreamStop(station, device);
-    });
-    this.client.on('station livestream start',
-      (station: Station, device: Device, metadata: StreamMetadata, videostream: Readable, audiostream: Readable) => {
-        this.onStationLivestreamStart(station, device, metadata, videostream, audiostream);
-      });
   }
 
   private initialize() {
@@ -55,10 +66,10 @@ export class LocalLivestreamManager extends EventEmitter {
   }
 
   public async getLocalLivestream(): Promise<StationStream> {
-    this.console.debug(this.device.getName(), 'New instance requests livestream.');
+    this.console.debug(this.device.getName(), this.id, 'New instance requests livestream.');
     if (this.stationStream) {
       const runtime = (Date.now() - this.livestreamStartedAt!) / 1000;
-      this.console.debug(this.device.getName(), 'Using livestream that was started ' + runtime + ' seconds ago.');
+      this.console.debug(this.device.getName(), this.id, 'Using livestream that was started ' + runtime + ' seconds ago.');
       return this.stationStream;
     } else {
       return await this.startAndGetLocalLiveStream();
@@ -67,17 +78,17 @@ export class LocalLivestreamManager extends EventEmitter {
   
   private async startAndGetLocalLiveStream(): Promise<StationStream> {
     return new Promise((resolve, reject) => {
-      this.console.debug(this.device.getName(), 'Start new station livestream (P2P Session)...');
+      this.console.debug(this.device.getName(), this.id, 'Start new station livestream...');
       if (!this.livestreamIsStarting) { // prevent multiple stream starts from eufy station
         this.livestreamIsStarting = true;
-        this.client.startStationLivestream(this.device.getSerial());
+        this.startStationLivestream();
       } else {
-        this.console.debug(this.device.getName(), 'stream is already starting. waiting...');
+        this.console.debug(this.device.getName(), this.id, 'stream is already starting. waiting...');
       }
 
       this.once('livestream start', async () => {
         if (this.stationStream !== null) {
-          this.console.debug(this.device.getName(), 'New livestream started.');
+          this.console.debug(this.device.getName(), this.id, 'New livestream started.');
           this.livestreamIsStarting = false;
           resolve(this.stationStream);
         } else {
@@ -87,15 +98,102 @@ export class LocalLivestreamManager extends EventEmitter {
     });
   }
 
+  private async startStationLivestream(videoCodec: VideoCodec = VideoCodec.H264): Promise<void> {
+    const commandData: CommandData = {
+        name: CommandName.DeviceStartLivestream,
+        value: videoCodec
+    };
+    this.console.debug(this.device.getName(), this.id, `Sending start livestream command to station ${this.station.getSerial()}`);
+    const rsa_key = this.p2pSession.getRSAPrivateKey();
+
+    if (this.device.isSoloCameras() || this.device.getDeviceType() === DeviceType.FLOODLIGHT_CAMERA_8423 || this.device.isWiredDoorbellT8200X()) {
+        this.console.debug(this.device.getName(), this.id, `Using CMD_DOORBELL_SET_PAYLOAD (1) for station ${this.station.getSerial()} (main_sw_version: ${this.station.getSoftwareVersion()})`);
+        await this.p2pSession.sendCommandWithStringPayload({
+            commandType: CommandType.CMD_DOORBELL_SET_PAYLOAD,
+            value: JSON.stringify({
+                "commandType": ParamType.COMMAND_START_LIVESTREAM,
+                "data": {
+                    "accountId": this.station.getRawStation().member.admin_user_id,
+                    "encryptkey": rsa_key?.exportKey("components-public").n.slice(1).toString("hex"),
+                    "streamtype": videoCodec
+                }
+            }),
+            channel: this.device.getChannel()
+        }, {
+            command: commandData
+        });
+    } else if (this.device.isWiredDoorbell() || (this.device.isFloodLight() && this.device.getDeviceType() !== DeviceType.FLOODLIGHT) || this.device.isIndoorCamera() || (this.device.getSerial().startsWith("T8420") && isGreaterEqualMinVersion("2.0.4.8", this.station.getSoftwareVersion()))) {
+        this.console.debug(this.device.getName(), this.id, `Using CMD_DOORBELL_SET_PAYLOAD (2) for station ${this.station.getSerial()} (main_sw_version: ${this.station.getSoftwareVersion()})`);
+        await this.p2pSession.sendCommandWithStringPayload({
+            commandType: CommandType.CMD_DOORBELL_SET_PAYLOAD,
+            value: JSON.stringify({
+                "commandType": ParamType.COMMAND_START_LIVESTREAM,
+                "data": {
+                    "account_id": this.station.getRawStation().member.admin_user_id,
+                    "encryptkey": rsa_key?.exportKey("components-public").n.slice(1).toString("hex"),
+                    "streamtype": videoCodec
+                }
+            }),
+            channel: this.device.getChannel()
+        }, {
+            command: commandData
+        });
+    } else {
+        if ((Device.isIntegratedDeviceBySn(this.station.getSerial()) || !isGreaterEqualMinVersion("2.0.9.7", this.station.getSoftwareVersion())) && (!this.station.getSerial().startsWith("T8420") || !isGreaterEqualMinVersion("1.0.0.25", this.station.getSoftwareVersion()))) {
+            this.console.debug(this.device.getName(), this.id, `Using CMD_START_REALTIME_MEDIA for station ${this.station.getSerial()} (main_sw_version: ${this.station.getSoftwareVersion()})`);
+            await this.p2pSession.sendCommandWithInt({
+                commandType: CommandType.CMD_START_REALTIME_MEDIA,
+                value: this.device.getChannel(),
+                strValue: rsa_key?.exportKey("components-public").n.slice(1).toString("hex"),
+                channel: this.device.getChannel()
+            }, {
+                command: commandData
+            });
+        } else {
+            this.console.debug(this.device.getName(), this.id, `Using CMD_SET_PAYLOAD for station ${this.station.getSerial()} (main_sw_version: ${this.station.getSoftwareVersion()})`);
+            await this.p2pSession.sendCommandWithStringPayload({
+                commandType: CommandType.CMD_SET_PAYLOAD,
+                value: JSON.stringify({
+                    "account_id": this.station.getRawStation().member.admin_user_id,
+                    "cmd": CommandType.CMD_START_REALTIME_MEDIA,
+                    "mValue3": CommandType.CMD_START_REALTIME_MEDIA,
+                    "payload": {
+                        "ClientOS": "Android",
+                        "key": rsa_key?.exportKey("components-public").n.slice(1).toString("hex"),
+                        "streamtype": videoCodec === VideoCodec.H264 ? 1 : 2,
+                    }
+                }),
+                channel: this.device.getChannel()
+            }, {
+                command: commandData
+            });
+        }
+    }
+  }
+
   public stopLocalLiveStream(): void {
-    this.console.debug(this.device.getName(), 'Stopping station livestream.');
-    this.client.stopStationLivestream(this.device.getSerial());
+    this.console.debug(this.device.getName(), this.id, 'Stopping station livestream.');
+    this.stopLivestream();
     this.initialize();
   }
 
+  private async stopLivestream(): Promise<void> {
+    const commandData: CommandData = {
+        name: CommandName.DeviceStopLivestream
+    };
+    this.console.debug(this.device.getName(), this.id, `Sending stop livestream command to station ${this.station.getSerial()}`);
+    await this.p2pSession.sendCommandWithInt({
+        commandType: CommandType.CMD_STOP_REALTIME_MEDIA,
+        value: this.device.getChannel(),
+        channel: this.device.getChannel()
+    }, {
+        command: commandData
+    });
+}
+
   private onStationLivestreamStop(station: Station, device: Device) {
     if (device.getSerial() === this.device.getSerial()) {
-      this.console.info(station.getName() + ' station livestream for ' + device.getName() + ' has stopped.');
+      this.console.info(this.id + ' - ' + station.getName() + ' station livestream for ' + device.getName() + ' has stopped.');
       this.initialize();
     }
   }
@@ -111,17 +209,17 @@ export class LocalLivestreamManager extends EventEmitter {
       if (this.stationStream) {
         const diff = (Date.now() - this.stationStream.createdAt) / 1000;
         if (diff < 5) {
-          this.console.warn(this.device.getName(), 'Second livestream was started from station. Ignore.');
+          this.console.warn(this.device.getName(), this.id,  'Second livestream was started from station. Ignore.');
           return;
         }
       }
       this.initialize(); // important to prevent unwanted behaviour when the eufy station emits the 'livestream start' event multiple times
 
-      this.console.info(station.getName() + ' station livestream (P2P session) for ' + device.getName() + ' has started.');
+      this.console.info(this.id + ' - ' + station.getName() + ' station livestream (P2P session) for ' + device.getName() + ' has started.');
       this.livestreamStartedAt = Date.now();
       const createdAt = Date.now();
       this.stationStream = {station, device, metadata, videostream, audiostream, createdAt};
-      this.console.debug(this.device.getName(), 'Stream metadata: ' + JSON.stringify(this.stationStream.metadata));
+      this.console.debug(this.device.getName(), this.id, 'Stream metadata: ' + JSON.stringify(this.stationStream.metadata));
       
       this.emit('livestream start');
     }

plugins/homekit/README.md

@@ -49,3 +49,36 @@ This is always a issue with the network setup.
 This almost always due to your camera bitrate being too high for remote streaming through Apple's servers. Workarounds:
 1) Use a lower bitrate substream for Remote Streaming.
 2) Enable Transcoding on Remote Streaming.
+
+
+### mDNS Advertiser Options
+
+Scypted uses mDNS-based to make your accessories discoverable by Apple devices.
+There are 3 mDNS Advertisers that Scrypted can interface with to advertise itself on the local network.
+
+
+#### Ciao
+
+Ciao is the default advertiser that scypted uses.
+
+For non-Linux users, `ciao` should provide the best experience. It fixes a lot of the deficiencies of the `bonjour` advertiser. However, you might experience issues in the following two scenarios.
+
+##### Network Interface Selection
+Ciao tries to be aware of multiple network interfaces. 
+On startup, it tries to evaluate which network interfaces to advertise on by default.
+In certain circumstances, ciao is unable to properly determine the set of valid network interfaces (e.g., when dealing with virtual network interfaces on containerised environments).
+
+##### Multiple Advertisers
+On some systems, there is already a mDNS advertiser stack running (e.g. avahi on linux). There might be issues running multiple mDNS advertisers on the same host.
+
+#### Bonjour
+
+Bonjour is a legacy advertiser. It is not as efficient in terms of system resource usage and network traffic when compared to the other options.
+
+#### Avahi (Linux Only)
+Avahi is a mDNS advertiser that is installed by default on many linux distributions.
+
+For Linux users, Avahi should provide the best experience.
+Note that your system must have the `avahi-daemon` and `dbus` services installed and running for this option to work.
+
+If using Scypted through `docker compose`, be sure to uncomment the volume mounts to expose Avahi to the container.

plugins/homekit/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/homekit",
-   "version": "1.2.13",
+   "version": "1.2.20",
    "description": "HomeKit Plugin for Scrypted",
    "scripts": {
       "scrypted-setup-project": "scrypted-setup-project",
@@ -35,18 +35,17 @@
    },
    "dependencies": {
       "@koush/werift-src": "file:../../external/werift",
-      "check-disk-space": "^3.3.0",
-      "hap-nodejs": "file:../../external/HAP-NodeJS",
+      "check-disk-space": "^3.3.1",
+      "hap-nodejs": "^0.11.0",
       "lodash": "^4.17.21",
-      "mkdirp": "^1.0.4"
+      "mkdirp": "^2.1.5"
    },
    "devDependencies": {
       "@scrypted/common": "file:../../common",
       "@scrypted/sdk": "file:../../sdk",
-      "@types/debug": "^4.1.5",
-      "@types/lodash": "^4.14.168",
-      "@types/mkdirp": "^1.0.2",
-      "@types/node": "^18.11.18",
-      "@types/url-parse": "^1.4.3"
+      "@types/debug": "^4.1.7",
+      "@types/lodash": "^4.14.191",
+      "@types/node": "^18.15.5",
+      "@types/url-parse": "^1.4.8"
    }
 }

plugins/homekit/src/hap-utils.ts

@@ -8,34 +8,6 @@ import { Categories, EventedHTTPServer, HAPStorage } from './hap';
 import { randomPinCode } from './pincode';
 import './types';
 
-class HAPLocalStorage {
-    initSync() {
-
-    }
-    getItem(key: string): any {
-        const data = localStorage.getItem(key);
-        if (!data)
-            return;
-        return JSON.parse(data);
-    }
-    setItemSync(key: string, value: any) {
-        localStorage.setItem(key, JSON.stringify(value));
-    }
-    removeItemSync(key: string) {
-        localStorage.removeItem(key);
-    }
-
-    persistSync() {
-
-    }
-}
-
-// HAP storage seems to be global?
-export function initializeHapStorage() {
-    HAPStorage.setStorage(new HAPLocalStorage());
-}
-
-
 export function createHAPUUID() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
         var r = Math.random() * 16 | 0, v = c == 'x' ? r : (r & 0x3 | 0x8);

plugins/homekit/src/hap.ts

@@ -1,14 +1,14 @@
-export * from 'hap-nodejs/src/lib/definitions'; // must be loaded before Characteristic and Service class
-export * from 'hap-nodejs/src/lib/Accessory';
-export * as uuid from 'hap-nodejs/src/lib/util/uuid';
-export * from 'hap-nodejs/src/lib/Characteristic';
-export * from 'hap-nodejs/src/lib/camera';
-export * from 'hap-nodejs/src/lib/camera/RecordingManagement';
-export * from 'hap-nodejs/src/lib/model/ControllerStorage';
-export * from 'hap-nodejs/src/lib/util/eventedhttp';
-export * from 'hap-nodejs/src/lib/controller/CameraController';
-export * from 'hap-nodejs/src/lib/datastream/DataStreamServer';
-export * from 'hap-nodejs/src/lib/Service';
-export * from 'hap-nodejs/src/types';
-export * from 'hap-nodejs/src/lib/model/HAPStorage';
-export * from 'hap-nodejs/src/lib/Bridge';
+export * from 'hap-nodejs/dist/lib/definitions'; // must be loaded before Characteristic and Service class
+export * from 'hap-nodejs/dist/lib/Accessory';
+export * as uuid from 'hap-nodejs/dist/lib/util/uuid';
+export * from 'hap-nodejs/dist/lib/Characteristic';
+export * from 'hap-nodejs/dist/lib/camera';
+export * from 'hap-nodejs/dist/lib/camera/RecordingManagement';
+export * from 'hap-nodejs/dist/lib/model/ControllerStorage';
+export * from 'hap-nodejs/dist/lib/util/eventedhttp';
+export * from 'hap-nodejs/dist/lib/controller/CameraController';
+export * from 'hap-nodejs/dist/lib/datastream/DataStreamServer';
+export * from 'hap-nodejs/dist/lib/Service';
+export * from 'hap-nodejs/dist/types';
+export * from 'hap-nodejs/dist/lib/model/HAPStorage';
+export * from 'hap-nodejs/dist/lib/Bridge';

plugins/homekit/src/main.ts

@@ -6,18 +6,53 @@ import { getAddressOverride } from "./address-override";
 import { maybeAddBatteryService } from './battery';
 import { CameraMixin, canCameraMixin } from './camera-mixin';
 import { SnapshotThrottle, supportedTypes } from './common';
-import { Accessory, Bridge, Categories, Characteristic, ControllerStorage, MDNSAdvertiser, PublishInfo, Service } from './hap';
-import { createHAPUsernameStorageSettingsDict, getHAPUUID, getRandomPort as createRandomPort, initializeHapStorage, logConnections, typeToCategory } from './hap-utils';
+import { HAPStorage, Accessory, Bridge, Categories, Characteristic, ControllerStorage, MDNSAdvertiser, PublishInfo, Service } from './hap';
+import { createHAPUsernameStorageSettingsDict, getHAPUUID, getRandomPort as createRandomPort, logConnections, typeToCategory } from './hap-utils';
 import { HomekitMixin, HOMEKIT_MIXIN } from './homekit-mixin';
 import { addAccessoryDeviceInfo } from './info';
 import { randomPinCode } from './pincode';
 import './types';
 import { VIDEO_CLIPS_NATIVE_ID } from './types/camera/camera-recording-files';
+import { reorderDevicesByProvider } from './util';
 import { VideoClipsMixinProvider } from './video-clips-provider';
 
+const hapStorage: Storage = {
+    get length() {
+        return localStorage.length;
+    },
+    clear: function (): void {
+        return localStorage.clear();
+    },
+    key: function (index: number): string {
+        return localStorage.key(index);
+    },
+    removeItem: function (key: string): void {
+        return localStorage.removeItem(key);
+    },
+    getItem(key: string): any {
+        const data = localStorage.getItem(key);
+        if (!data)
+            return;
+        return JSON.parse(data);
+    },
+    setItem(key: string, value: any) {
+        localStorage.setItem(key, JSON.stringify(value));
+    },
+    setItemSync(key: string, value: any) {
+        localStorage.setItem(key, JSON.stringify(value));
+    },
+    removeItemSync(key: string) {
+        localStorage.removeItem(key);
+    },
+    persistSync() {
+    }
+}
+HAPStorage.storage = () => {
+    return hapStorage;
+}
+
 const { systemManager, deviceManager } = sdk;
 
-initializeHapStorage();
 const includeToken = 4;
 
 export class HomeKitPlugin extends ScryptedDeviceBase implements MixinProvider, Settings, DeviceProvider {
@@ -75,6 +110,7 @@ export class HomeKitPlugin extends ScryptedDeviceBase implements MixinProvider,
             description: 'The last home hub to request a recording. Internally used to determine if a streaming request is coming from remote wifi.',
         },
     });
+    mergedDevices = new Set<string>();
 
     constructor() {
         super();
@@ -137,6 +173,7 @@ export class HomeKitPlugin extends ScryptedDeviceBase implements MixinProvider,
 
     async start() {
         this.log.clearAlerts();
+        this.mergedDevices = new Set<string>();
 
         let defaultIncluded: any;
         try {
@@ -147,10 +184,27 @@ export class HomeKitPlugin extends ScryptedDeviceBase implements MixinProvider,
         }
 
         const plugins = await systemManager.getComponent('plugins');
-
         const accessoryIds = new Set<string>();
+        const deviceIds = Object.keys(systemManager.getSystemState());
 
-        for (const id of Object.keys(systemManager.getSystemState())) {
+        // when creating accessories in order, some DeviceProviders may merge in
+        // their child devices (and report back which devices are merged via
+        // this.mergedDevices)
+        // we need to ensure that the iteration processes DeviceProviders before
+        // their children, so a reordering is necessary
+        const reorderedDeviceIds = reorderDevicesByProvider(deviceIds);
+
+        // safety checks in case something went wrong
+        if (deviceIds.length !== reorderedDeviceIds.length) {
+            throw Error(`error in device reordering, expected ${deviceIds.length} devices but only got ${reorderedDeviceIds.length}!`);
+        }
+        const uniqueDeviceIds = new Set<string>(deviceIds);
+        const uniqueReorderedIds = new Set<string>(reorderedDeviceIds);
+        if (uniqueDeviceIds.size !== uniqueReorderedIds.size) {
+            throw Error(`error in device reordering, expected ${uniqueDeviceIds.size} unique devices but only got ${uniqueReorderedIds.size} entries!`);
+        }
+
+        for (const id of reorderedDeviceIds) {
             const device = systemManager.getDeviceById<Online>(id);
             const supportedType = supportedTypes[device.type];
             if (!supportedType?.probe(device))
@@ -172,6 +226,11 @@ export class HomeKitPlugin extends ScryptedDeviceBase implements MixinProvider,
                 continue;
             }
 
+            if (this.mergedDevices.has(device.id)) {
+                this.console.log(`${device.name} was merged into an existing Homekit accessory and will not be exposed independently`)
+                continue;
+            }
+
             this.console.log('adding', device.name);
 
             const accessory = await supportedType.getAccessory(device, this);
@@ -294,9 +353,10 @@ export class HomeKitPlugin extends ScryptedDeviceBase implements MixinProvider,
             bind,
         };
 
-        this.bridge.publish(publishInfo, true);
-        this.storageSettings.values.qrCode = this.bridge.setupURI();
-        logConnections(this.console, this.bridge, this.seenConnections);
+        this.bridge.publish(publishInfo, true).then(() => {
+            this.storageSettings.values.qrCode = this.bridge.setupURI();
+            logConnections(this.console, this.bridge, this.seenConnections);
+        });
 
         systemManager.listen(async (eventSource, eventDetails, eventData) => {
             if (eventDetails.eventInterface !== ScryptedInterface.ScryptedDevice)

plugins/homekit/src/types/camera.ts

@@ -1,12 +1,13 @@
+import { Deferred } from '@scrypted/common/src/deferred';
 import sdk, { AudioSensor, Camera, Intercom, MotionSensor, ObjectsDetected, OnOff, ScryptedDevice, ScryptedDeviceType, ScryptedInterface, VideoCamera, VideoCameraConfiguration } from '@scrypted/sdk';
 import { defaultObjectDetectionContactSensorTimeout } from '../camera-mixin';
-import { addSupportedType, bindCharacteristic, DummyDevice,  } from '../common';
-import { AudioRecordingCodec, AudioRecordingCodecType, AudioRecordingSamplerate, AudioStreamingCodec, AudioStreamingCodecType, AudioStreamingSamplerate, CameraController, CameraRecordingDelegate, CameraRecordingOptions, CameraStreamingOptions, Characteristic, CharacteristicEventTypes, DataStreamConnection, H264Level, H264Profile, OccupancySensor, RecordingManagement, Service, SRTPCryptoSuites, VideoCodecType, WithUUID } from '../hap';
+import { addSupportedType, bindCharacteristic, DummyDevice } from '../common';
+import { AudioRecordingCodec, AudioRecordingCodecType, AudioRecordingSamplerate, AudioStreamingCodec, AudioStreamingCodecType, AudioStreamingSamplerate, CameraController, CameraRecordingConfiguration, CameraRecordingDelegate, CameraRecordingOptions, CameraStreamingOptions, Characteristic, CharacteristicEventTypes, H264Level, H264Profile, MediaContainerType, OccupancySensor, RecordingPacket, Service, SRTPCryptoSuites, VideoCodecType, WithUUID } from '../hap';
+import type { HomeKitPlugin } from '../main';
 import { handleFragmentsRequests, iframeIntervalSeconds } from './camera/camera-recording';
 import { createCameraStreamingDelegate } from './camera/camera-streaming';
 import { FORCE_OPUS } from './camera/camera-utils';
 import { makeAccessory } from './common';
-import type { HomeKitPlugin } from '../main';
 
 const { deviceManager, systemManager } = sdk;
 
@@ -62,7 +63,6 @@ addSupportedType({
         const streamingOptions: CameraStreamingOptions = {
             video: {
                 codec: {
-                    type: VideoCodecType.H264,
                     levels: [H264Level.LEVEL3_1, H264Level.LEVEL3_2, H264Level.LEVEL4_0],
                     profiles: [H264Profile.MAIN],
                 },
@@ -98,15 +98,30 @@ addSupportedType({
         const detectAudio = storage.getItem('detectAudio') === 'true';
         const needAudioMotionService = device.interfaces.includes(ScryptedInterface.AudioSensor) && detectAudio;
         const linkedMotionSensor = storage.getItem('linkedMotionSensor');
+        const isRecordingEnabled = !!linkedMotionSensor || device.interfaces.includes(ScryptedInterface.MotionSensor) || needAudioMotionService
 
-        const storageKeySelectedRecordingConfiguration = 'selectedRecordingConfiguration';
-
-        if (linkedMotionSensor || device.interfaces.includes(ScryptedInterface.MotionSensor) || needAudioMotionService) {
+        let configuration: CameraRecordingConfiguration;
+        const openRecordingStreams = new Map<number, Deferred<any>>();
+        if (isRecordingEnabled) {
             recordingDelegate = {
-                handleFragmentsRequests(connection: DataStreamConnection): AsyncGenerator<Buffer, void, unknown> {
-                    const configuration = RecordingManagement.parseSelectedConfiguration(storage.getItem(storageKeySelectedRecordingConfiguration))
-                    return handleFragmentsRequests(connection, device, configuration, console, homekitPlugin)
-                }
+                updateRecordingConfiguration(newConfiguration: CameraRecordingConfiguration ) {
+                    configuration = newConfiguration;
+                },
+                handleRecordingStreamRequest(streamId: number): AsyncGenerator<RecordingPacket> {
+                    const ret = handleFragmentsRequests(streamId, device, configuration, console, homekitPlugin);
+                    const d = new Deferred<any>();
+                    d.promise.then(reason => {
+                        ret.throw(new Error(reason.toString()));
+                        openRecordingStreams.delete(streamId);
+                    });
+                    openRecordingStreams.set(streamId, d);
+                    return ret;
+                },
+                closeRecordingStream(streamId, reason) {
+                    openRecordingStreams.get(streamId)?.resolve(reason);
+                },
+                updateRecordingActive(active) {
+                },
             };
 
             const recordingCodecs: AudioRecordingCodec[] = [];
@@ -146,23 +161,17 @@ addSupportedType({
             // ensureHasWidthResolution(recordingResolutions, 1280, 720);
             // ensureHasWidthResolution(recordingResolutions, 1920, 1080);
 
-            const h265Support = storage.getItem('h265Support') === 'true';
-            const codecType = h265Support ? VideoCodecType.H265 : VideoCodecType.H264
-
             recordingOptions = {
-                motionService: true,
                 prebufferLength: numberPrebufferSegments * iframeIntervalSeconds * 1000,
-                eventTriggerOptions: 0x01,
-                mediaContainerConfigurations: [
+                mediaContainerConfiguration: [
                     {
-                        type: 0,
+                        type: MediaContainerType.FRAGMENTED_MP4,
                         fragmentLength: iframeIntervalSeconds * 1000,
                     }
                 ],
-
                 video: {
-                    codec: {
-                        type: codecType,
+                    type: VideoCodecType.H264,
+                    parameters: {
                         levels: [H264Level.LEVEL3_1, H264Level.LEVEL3_2, H264Level.LEVEL4_0],
                         profiles: [H264Profile.BASELINE, H264Profile.MAIN, H264Profile.HIGH],
                     },
@@ -183,10 +192,13 @@ addSupportedType({
             cameraStreamCount: 8,
             delegate,
             streamingOptions,
-            recording: {
+            recording: !isRecordingEnabled ? undefined : {
                 options: recordingOptions,
                 delegate: recordingDelegate,
-            }
+            },
+            sensors: {
+                motion: isRecordingEnabled,
+            },
         });
 
         accessory.configureController(controller);
@@ -214,26 +226,21 @@ addSupportedType({
                 const property = `characteristic-v2-${characteristic.UUID}`
                 service.getCharacteristic(characteristic)
                     .on(CharacteristicEventTypes.GET, callback => callback(null, storage.getItem(property) === 'true' ? 1 : 0))
+                    .removeOnSet()
                     .on(CharacteristicEventTypes.SET, (value, callback) => {
                         callback();
                         storage.setItem(property, (!!value).toString());
                     });
             }
 
-            persistBooleanCharacteristic(recordingManagement.getService(), Characteristic.Active);
-            persistBooleanCharacteristic(recordingManagement.getService(), Characteristic.RecordingAudioActive);
-            persistBooleanCharacteristic(controller.cameraOperatingModeService, Characteristic.EventSnapshotsActive);
-            persistBooleanCharacteristic(controller.cameraOperatingModeService, Characteristic.HomeKitCameraActive);
-            persistBooleanCharacteristic(controller.cameraOperatingModeService, Characteristic.PeriodicSnapshotsActive);
-
             if (!device.interfaces.includes(ScryptedInterface.OnOff)) {
-                persistBooleanCharacteristic(controller.cameraOperatingModeService, Characteristic.CameraOperatingModeIndicator);
+                persistBooleanCharacteristic(recordingManagement.operatingModeService, Characteristic.CameraOperatingModeIndicator);
             }
             else {
-                const indicator = controller.cameraOperatingModeService.getCharacteristic(Characteristic.CameraOperatingModeIndicator);
+                const indicator = recordingManagement.operatingModeService.getCharacteristic(Characteristic.CameraOperatingModeIndicator);
                 const linkStatusIndicator = storage.getItem('statusIndicator') === 'true';
                 const property = `characteristic-v2-${Characteristic.CameraOperatingModeIndicator.UUID}`
-                bindCharacteristic(device, ScryptedInterface.OnOff, controller.cameraOperatingModeService, Characteristic.CameraOperatingModeIndicator, () => {
+                bindCharacteristic(device, ScryptedInterface.OnOff, recordingManagement.operatingModeService, Characteristic.CameraOperatingModeIndicator, () => {
                     if (!linkStatusIndicator)
                         return storage.getItem(property) === 'true' ? 1 : 0;
 
@@ -250,16 +257,6 @@ addSupportedType({
                         device.turnOff();
                 });
             }
-
-            recordingManagement.getService().getCharacteristic(Characteristic.SelectedCameraRecordingConfiguration)
-                .on(CharacteristicEventTypes.GET, callback => {
-                    callback(null, storage.getItem(storageKeySelectedRecordingConfiguration) || '');
-                })
-                .on(CharacteristicEventTypes.SET, (value, callback) => {
-                    // prepare recording here if necessary.
-                    storage.setItem(storageKeySelectedRecordingConfiguration, value.toString());
-                    callback();
-                });
         }
 
 

plugins/homekit/src/types/camera/camera-recording.ts

@@ -11,7 +11,7 @@ import mkdirp from 'mkdirp';
 import net from 'net';
 import { Duplex, Readable, Writable } from 'stream';
 import { } from '../../common';
-import { AudioRecordingCodecType, AudioRecordingSamplerateValues, CameraRecordingConfiguration, DataStreamConnection } from '../../hap';
+import { AudioRecordingCodecType, CameraRecordingConfiguration, DataStreamConnection, RecordingPacket } from '../../hap';
 import type { HomeKitPlugin } from "../../main";
 import { getCameraRecordingFiles, HksvVideoClip, VIDEO_CLIPS_NATIVE_ID } from './camera-recording-files';
 import { checkCompatibleCodec, FORCE_OPUS, transcodingDebugModeWarning } from './camera-utils';
@@ -33,6 +33,14 @@ const allowedNaluTypes = [
     NAL_TYPE_DELIMITER,
 ];
 
+const AudioRecordingSamplerateValues = {
+    0: 8,
+    1: 16,
+    2: 24,
+    3: 32,
+    4: 44.1,
+    5: 48,
+};
 
 async function checkMp4StartsWithKeyFrame(console: Console, mp4: Buffer) {
     const cp = child_process.spawn(await mediaManager.getFFmpegPath(), [
@@ -90,19 +98,19 @@ async function checkMp4StartsWithKeyFrame(console: Console, mp4: Buffer) {
     }
 }
 
-export async function* handleFragmentsRequests(connection: DataStreamConnection, device: ScryptedDevice & VideoCamera & MotionSensor & AudioSensor,
-    configuration: CameraRecordingConfiguration, console: Console, homekitPlugin: HomeKitPlugin): AsyncGenerator<Buffer, void, unknown> {
+export async function* handleFragmentsRequests(streamId: number, device: ScryptedDevice & VideoCamera & MotionSensor & AudioSensor,
+    configuration: CameraRecordingConfiguration, console: Console, homekitPlugin: HomeKitPlugin): AsyncGenerator<RecordingPacket> {
 
-    homekitPlugin.storageSettings.values.lastKnownHomeHub = connection.remoteAddress;
+    // homekitPlugin.storageSettings.values.lastKnownHomeHub = connection.remoteAddress;
 
-    console.log(device.name, 'recording session starting', connection.remoteAddress, configuration);
+    // console.log(device.name, 'recording session starting', connection.remoteAddress, configuration);
 
     const storage = deviceManager.getMixinStorage(device.id, undefined);
     const debugMode = getDebugMode(storage);
     const saveRecordings = debugMode.recording;
 
     // request more than needed, and determine what to do with the fragments after receiving them.
-    const prebuffer = configuration.mediaContainerConfiguration.prebufferLength * 2.5;
+    const prebuffer = configuration.prebufferLength * 2.5;
 
     const media = await device.getVideoStream({
         destination: 'remote-recorder',
@@ -153,7 +161,7 @@ export async function* handleFragmentsRequests(connection: DataStreamConnection,
                 width: configuration.videoCodec.resolution[0],
                 height: configuration.videoCodec.resolution[1],
                 fps: configuration.videoCodec.resolution[2],
-                max_bit_rate: configuration.videoCodec.bitrate,
+                max_bit_rate: configuration.videoCodec.parameters.bitRate,
             }
         }
 
@@ -210,7 +218,7 @@ export async function* handleFragmentsRequests(connection: DataStreamConnection,
             const videoRecordingFilter = `scale=w='min(${configuration.videoCodec.resolution[0]},iw)':h=-2`;
             addVideoFilterArguments(videoArgs, videoRecordingFilter);
             videoArgs.push(
-                '-b:v', `${configuration.videoCodec.bitrate}k`,
+                '-b:v', `${configuration.videoCodec.parameters.bitRate}k`,
                 "-bufsize", (2 * request.video.max_bit_rate).toString() + "k",
                 "-maxrate", request.video.max_bit_rate.toString() + "k",
                 // used to use this but switched to group of picture (gop) instead.
@@ -267,11 +275,13 @@ export async function* handleFragmentsRequests(connection: DataStreamConnection,
         safeKillFFmpeg(cp);
     }
 
+    let isLast = false;
     console.log(`motion recording started`);
     const { socket, cp, generator } = session;
     const videoTimeout = setTimeout(() => {
         console.error('homekit secure video max duration reached');
-        cleanupPipes();
+        isLast = true;
+        setTimeout(cleanupPipes, 10000);
     }, maxVideoDuration);
 
     let pending: Buffer[] = [];
@@ -328,7 +338,14 @@ export async function* handleFragmentsRequests(connection: DataStreamConnection,
                 saveFragment(i, fragment);
                 pending = [];
                 console.log(`motion fragment #${++i} sent. size:`, fragment.length);
-                yield fragment;
+                const wasLast = isLast;
+                const recordingPacket: RecordingPacket = {
+                    data: fragment,
+                    isLast,
+                }
+                yield recordingPacket;
+                if (wasLast)
+                    break;
             }
         }
         console.log(`motion recording finished`);

plugins/homekit/src/types/camera/camera-streaming.ts

@@ -158,33 +158,33 @@ export function createCameraStreamingDelegate(device: ScryptedDevice & VideoCame
                 // may not be reachable.
                 // Return the incoming address, assuming the sanity checks pass. Otherwise, fall through
                 // to the HAP-NodeJS implementation.
-                let check: string;
-                if (request.addressVersion === 'ipv4') {
-                    const localAddress = request.connection.localAddress;
-                    if (v4Regex.exec(localAddress)) {
-                        check = localAddress;
-                    }
-                    else if (v4v6Regex.exec(localAddress)) {
-                        // if this is a v4 over v6 address, parse it out.
-                        check = localAddress.substring('::ffff:'.length);
-                    }
-                }
-                else if (request.addressVersion === 'ipv6' && !v4Regex.exec(request.connection.localAddress)) {
-                    check = request.connection.localAddress;
-                }
+                // let check: string;
+                // if (request.addressVersion === 'ipv4') {
+                //     const localAddress = request.connection.localAddress;
+                //     if (v4Regex.exec(localAddress)) {
+                //         check = localAddress;
+                //     }
+                //     else if (v4v6Regex.exec(localAddress)) {
+                //         // if this is a v4 over v6 address, parse it out.
+                //         check = localAddress.substring('::ffff:'.length);
+                //     }
+                // }
+                // else if (request.addressVersion === 'ipv6' && !v4Regex.exec(request.connection.localAddress)) {
+                //     check = request.connection.localAddress;
+                // }
 
-                // ignore the IP if it is APIPA (Automatic Private IP Addressing)
-                if (check?.startsWith('169.')) {
-                    check = undefined;
-                }
+                // // ignore the IP if it is APIPA (Automatic Private IP Addressing)
+                // if (check?.startsWith('169.')) {
+                //     check = undefined;
+                // }
 
-                // sanity check this address.
-                if (check) {
-                    const infos = os.networkInterfaces()[request.connection.networkInterface];
-                    if (infos && infos.find(info => info.address === check)) {
-                        response.addressOverride = check;
-                    }
-                }
+                // // sanity check this address.
+                // if (check) {
+                //     const infos = os.networkInterfaces()[request.connection.networkInterface];
+                //     if (infos && infos.find(info => info.address === check)) {
+                //         response.addressOverride = check;
+                //     }
+                // }
             }
 
             console.log('source address', response.addressOverride, videoPort, audioPort);

plugins/homekit/src/types/common.ts

@@ -1,9 +1,10 @@
-import sdk, { Fan, AirQuality, AirQualitySensor, CO2Sensor, NOXSensor, PM10Sensor, PM25Sensor, ScryptedDevice, ScryptedInterface, VOCSensor, FanMode, OnOff } from "@scrypted/sdk";
+import sdk, { Fan, AirQuality, AirQualitySensor, CO2Sensor, NOXSensor, PM10Sensor, PM25Sensor, ScryptedDevice, ScryptedInterface, VOCSensor, FanMode, OnOff, DeviceProvider, ScryptedDeviceType } from "@scrypted/sdk";
 import { bindCharacteristic } from "../common";
 import { Accessory, Characteristic, CharacteristicEventTypes, Service, uuid } from '../hap';
 import type { HomeKitPlugin } from "../main";
+import { getService as getOnOffService } from "./onoff-base";
 
-const { deviceManager } = sdk;
+const { deviceManager, systemManager } = sdk;
 
 export function makeAccessory(device: ScryptedDevice, homekitPlugin: HomeKitPlugin, suffix?: string): Accessory {
     const mixinStorage = deviceManager.getMixinStorage(device.id, homekitPlugin.nativeId);
@@ -11,6 +12,12 @@ export function makeAccessory(device: ScryptedDevice, homekitPlugin: HomeKitPlug
     return new Accessory(device.name, uuid.generate(resetId + device.id + (suffix ? '-' + suffix : '')));
 }
 
+export function getChildDevices(device: ScryptedDevice & DeviceProvider): ScryptedDevice[] {
+    const ids = Object.keys(systemManager.getSystemState());
+    const allDevices = ids.map(id => systemManager.getDeviceById(id));
+    return allDevices.filter(d => d.providerId == device.id);
+}
+
 export function addAirQualitySensor(device: ScryptedDevice & AirQualitySensor & PM10Sensor & PM25Sensor & VOCSensor & NOXSensor, accessory: Accessory): Service {
     if (!device.interfaces.includes(ScryptedInterface.AirQualitySensor))
         return undefined;
@@ -34,7 +41,7 @@ export function addAirQualitySensor(device: ScryptedDevice & AirQualitySensor &
     const airQualityService = accessory.addService(Service.AirQualitySensor);
     bindCharacteristic(device, ScryptedInterface.AirQualitySensor, airQualityService, Characteristic.AirQuality,
         () => airQualityToHomekit(device.airQuality));
-    
+
     if (device.interfaces.includes(ScryptedInterface.PM10Sensor)) {
         bindCharacteristic(device, ScryptedInterface.PM10Sensor, airQualityService, Characteristic.PM10Density,
             () => device.pm10Density || 0);
@@ -157,4 +164,32 @@ export function addFan(device: ScryptedDevice & Fan & OnOff, accessory: Accessor
     }
 
     return service;
+}
+
+/*
+ * addChildSirens looks for siren-type child devices of the given device provider
+ * and merges them as switches to the accessory represented by the device provider.
+ *
+ * Returns the services created as well as all of the child siren devices which have
+ * been merged.
+ */
+export function addChildSirens(device: ScryptedDevice & DeviceProvider, accessory: Accessory): { services: Service[], devices: (ScryptedDevice & OnOff)[] } {
+    if (!device.interfaces.includes(ScryptedInterface.DeviceProvider))
+        return undefined;
+
+    const children = getChildDevices(device);
+    const sirenDevices = [];
+    const services = children.map((child: ScryptedDevice & OnOff) => {
+        if (child.type !== ScryptedDeviceType.Siren || !child.interfaces.includes(ScryptedInterface.OnOff))
+            return undefined;
+
+        const onOffService = getOnOffService(child, accessory, Service.Switch)
+        sirenDevices.push(child);
+        return onOffService;
+    });
+
+    return {
+        services: services.filter(service => !!service),
+        devices: sirenDevices,
+    };
 }

plugins/homekit/src/types/onoff-base.ts

@@ -8,9 +8,7 @@ export function probe(device: DummyDevice): boolean {
     return device.interfaces.includes(ScryptedInterface.OnOff);
 }
 
-export function getAccessory(device: ScryptedDevice & OnOff, homekitPlugin: HomeKitPlugin, serviceType: any): { accessory: Accessory, service: Service } | undefined {
-    const accessory = makeAccessory(device, homekitPlugin);
-
+export function getService(device: ScryptedDevice & OnOff, accessory: Accessory, serviceType: any): Service {
     const service = accessory.addService(serviceType, device.name);
     service.getCharacteristic(Characteristic.On)
         .on(CharacteristicEventTypes.SET, (value: CharacteristicValue, callback: CharacteristicSetCallback) => {
@@ -22,7 +20,12 @@ export function getAccessory(device: ScryptedDevice & OnOff, homekitPlugin: Home
         })
 
     bindCharacteristic(device, ScryptedInterface.OnOff, service, Characteristic.On, () => !!device.on);
+    return service;
+}
 
+export function getAccessory(device: ScryptedDevice & OnOff, homekitPlugin: HomeKitPlugin, serviceType: any): { accessory: Accessory, service: Service } | undefined {
+    const accessory = makeAccessory(device, homekitPlugin);
+    const service = getService(device, accessory, serviceType);
     return {
         accessory,
         service,

plugins/homekit/src/types/security.ts

@@ -1,7 +1,7 @@
-import { SecuritySystem, SecuritySystemMode, SecuritySystemObstruction, ScryptedDevice, ScryptedDeviceType, ScryptedInterface } from '@scrypted/sdk';
+import { SecuritySystem, SecuritySystemMode, SecuritySystemObstruction, ScryptedDevice, ScryptedDeviceType, ScryptedInterface, DeviceProvider } from '@scrypted/sdk';
 import { addSupportedType, bindCharacteristic, DummyDevice } from '../common';
 import { Characteristic, CharacteristicEventTypes, CharacteristicSetCallback, CharacteristicValue, Service } from '../hap';
-import { makeAccessory } from './common';
+import { makeAccessory, addChildSirens } from './common';
 import type { HomeKitPlugin } from "../main";
 
 addSupportedType({
@@ -44,7 +44,7 @@ addSupportedType({
 
             return Characteristic.SecuritySystemCurrentState.DISARMED;
         }
-        
+
         function toTargetState(mode: SecuritySystemMode) {
             switch(mode) {
                 case SecuritySystemMode.AwayArmed:
@@ -71,7 +71,7 @@ addSupportedType({
 
         bindCharacteristic(device, ScryptedInterface.SecuritySystem, service, Characteristic.SecuritySystemCurrentState,
             () => toCurrentState(device.securitySystemState?.mode, device.securitySystemState?.triggered));
-        
+
         bindCharacteristic(device, ScryptedInterface.SecuritySystem, service, Characteristic.SecuritySystemTargetState,
             () => toTargetState(device.securitySystemState?.mode));
 
@@ -89,6 +89,14 @@ addSupportedType({
         bindCharacteristic(device, ScryptedInterface.SecuritySystem, service, Characteristic.SecuritySystemAlarmType,
             () => !!device.securitySystemState?.triggered);
 
+        if (device.interfaces.includes(ScryptedInterface.DeviceProvider)) {
+            const { devices } = addChildSirens(device as ScryptedDevice as ScryptedDevice & DeviceProvider, accessory);
+
+            // ensure child devices are skipped by the rest of homekit by
+            // reporting that they've been merged
+            devices.map(device => homekitPlugin.mergedDevices.add(device.id));
+        }
+
         return accessory;
     },
 });

plugins/homekit/src/types/thermostat.ts

@@ -108,18 +108,6 @@ addSupportedType({
             () => Math.max(device.thermostatSetpoint || 0, 10));
 
         if (device.thermostatAvailableModes.includes(ThermostatMode.HeatCool)) {
-            service.getCharacteristic(Characteristic.CoolingThresholdTemperature).setProps({
-                minStep: minStep, // 0.1
-                minValue: minSetTemp, // default = 10, change to 9C or 50F (10C)
-                maxValue: maxSetTemp // default = 35, change to 32C or 90F (32.2222C)
-            });
-
-            service.getCharacteristic(Characteristic.HeatingThresholdTemperature).setProps({
-                minStep: minStep, // 0.1
-                minValue: minSetTemp, // default = 0, change to 9C or 50F (10C)
-                maxValue: maxSetTemp // default = 25, change to 32C or 90F (32.2222C)
-            });
-
             service.getCharacteristic(Characteristic.HeatingThresholdTemperature)
                 .on(CharacteristicEventTypes.SET, (value: CharacteristicValue, callback: CharacteristicSetCallback) => {
                     callback();
@@ -137,6 +125,19 @@ addSupportedType({
 
             bindCharacteristic(device, ScryptedInterface.TemperatureSetting, service, Characteristic.CoolingThresholdTemperature,
                 () => Math.max(device.thermostatSetpointHigh || 0, 10));
+
+            // sets props after binding initial state to avoid warnings in logs
+            service.getCharacteristic(Characteristic.CoolingThresholdTemperature).setProps({
+                minStep: minStep, // 0.1
+                minValue: minSetTemp, // default = 10, change to 9C or 50F (10C)
+                maxValue: maxSetTemp // default = 35, change to 32C or 90F (32.2222C)
+            });
+
+            service.getCharacteristic(Characteristic.HeatingThresholdTemperature).setProps({
+                minStep: minStep, // 0.1
+                minValue: minSetTemp, // default = 0, change to 9C or 50F (10C)
+                maxValue: maxSetTemp // default = 25, change to 32C or 90F (32.2222C)
+            });
         }
 
         bindCharacteristic(device, ScryptedInterface.Thermometer, service, Characteristic.TemperatureDisplayUnits,

plugins/homekit/src/util.ts

@@ -0,0 +1,42 @@
+import sdk, { ScryptedInterface } from '@scrypted/sdk';
+
+const { systemManager } = sdk;
+
+/*
+ * flattenDeviceTree performs a modified DFS tree traversal of the given
+ * device mapping to produce a list of device ids. deviceId is the node
+ * of the tree currently being processed, where null is the root of the
+ * tree.
+ */
+function flattenDeviceTree(deviceMap: Map<string, string[]>, deviceId: string): string[] {
+    const result: string[] = [];
+    if (!deviceMap.has(deviceId)) // no children
+        return result;
+
+    const children = deviceMap.get(deviceId);
+    result.push(...children);
+    children.map(child =>  result.push(...flattenDeviceTree(deviceMap, child)))
+    return result;
+}
+
+/*
+ * reorderDevicesByProvider returns a new ordering of the provided deviceIds
+ * where it is guaranteed that DeviceProviders are listed before their children.
+ */
+export function reorderDevicesByProvider(deviceIds: string[]): string[] {
+    const providerDeviceIdMap = new Map<string, string[]>();
+
+    deviceIds.map(deviceId => {
+        const device = systemManager.getDeviceById(deviceId);
+
+        // when provider id is equal to device id, this is a root-level device/plugin
+        const providerId = device.providerId !== device.id ? device.providerId : null;
+        if (providerDeviceIdMap.has(providerId)) {
+            providerDeviceIdMap.get(providerId).push(device.id);
+        } else {
+            providerDeviceIdMap.set(providerId, [device.id]);
+        }
+    });
+
+    return flattenDeviceTree(providerDeviceIdMap, null);
+}

plugins/mqtt/src/main.ts

@@ -1,24 +1,19 @@
-// https://developer.scrypted.app/#getting-started
-// package.json contains the metadata (name, interfaces) about this device
-// under the "scrypted" key.
-import { Settings, Setting, DeviceProvider, ScryptedDeviceBase, ScryptedInterface, ScryptedDeviceType, Scriptable, ScriptSource, ScryptedInterfaceDescriptors, MixinProvider, ScryptedDevice, EventListenerRegister, DeviceCreator, DeviceCreatorSettings } from '@scrypted/sdk';
-import sdk from '@scrypted/sdk';
-import { monacoEvalDefaults } from './monaco';
-import { scryptedEval } from './scrypted-eval';
-import { MqttClient, MqttClientPublishOptions, MqttSubscriptions } from './api/mqtt-client';
+import { createScriptDevice, ScriptDeviceImpl, tsCompile } from '@scrypted/common/src/eval/scrypted-eval';
+import sdk, { DeviceCreator, DeviceCreatorSettings, DeviceProvider, EventListenerRegister, MixinProvider, Scriptable, ScriptSource, ScryptedDevice, ScryptedDeviceBase, ScryptedDeviceType, ScryptedInterface, ScryptedInterfaceDescriptors, Setting, Settings } from '@scrypted/sdk';
 import aedes, { AedesOptions } from 'aedes';
-import net from 'net';
-import ws from 'websocket-stream';
+import fs from 'fs';
 import http from 'http';
+import { Client, connect } from 'mqtt';
+import net from 'net';
+import path from 'path';
+import ws from 'websocket-stream';
+import { SettingsMixinDeviceBase, SettingsMixinDeviceOptions } from "../../../common/src/settings-mixin";
+import { MqttClient, MqttClientPublishOptions, MqttSubscriptions } from './api/mqtt-client';
 import { MqttDeviceBase } from './api/mqtt-device-base';
 import { MqttAutoDiscoveryProvider } from './autodiscovery/autodiscovery';
-import { SettingsMixinDeviceBase, SettingsMixinDeviceOptions } from "../../../common/src/settings-mixin";
-import { connect, Client } from 'mqtt';
+import { monacoEvalDefaults } from './monaco';
 import { isPublishable } from './publishable-types';
-import { createScriptDevice, ScriptDeviceImpl } from '@scrypted/common/src/eval/scrypted-eval';
-import fs from 'fs';
-import path from 'path';
-import { randomBytes } from 'crypto';
+import { scryptedEval } from './scrypted-eval';
 
 export function filterExample(filename: string) {
     return fs.readFileSync(`examples/${filename}`).toString()
@@ -533,4 +528,11 @@ class MqttProvider extends ScryptedDeviceBase implements DeviceProvider, Setting
     }
 }
 
-export default new MqttProvider();
+export default MqttProvider;
+
+
+export async function fork() {
+    return {
+        tsCompile,
+    }
+}

plugins/mqtt/src/publishable-types.ts

@@ -1,6 +1,13 @@
 import { ScryptedDeviceType, ScryptedInterface } from "@scrypted/sdk";
 
 export function isPublishable(type: ScryptedDeviceType, interfaces: string[]): boolean {
+    switch (type) {
+        case ScryptedDeviceType.API:
+        case ScryptedDeviceType.Builtin:
+        case ScryptedDeviceType.DataSource:
+        case ScryptedDeviceType.Unknown:
+            return false;
+    }
     const set = new Set(interfaces);
     set.delete(ScryptedInterface.ObjectDetection);
     set.delete(ScryptedInterface.DeviceDiscovery);
@@ -15,6 +22,7 @@ export function isPublishable(type: ScryptedDeviceType, interfaces: string[]): b
     set.delete(ScryptedInterface.BufferConverter);
     set.delete(ScryptedInterface.ScryptedPlugin);
     set.delete(ScryptedInterface.OauthClient);
+    set.delete(ScryptedInterface.OauthClient);
     set.delete(ScryptedInterface.LauncherApplication);
     return !!set.size;
 }

plugins/objectdetector/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/objectdetector",
-   "version": "0.0.102",
+   "version": "0.0.113",
    "description": "Scrypted Video Analysis Plugin. Installed alongside a detection service like OpenCV or TensorFlow.",
    "author": "Scrypted",
    "license": "Apache-2.0",
@@ -36,9 +36,16 @@
       "type": "API",
       "interfaces": [
          "Settings",
-         "MixinProvider"
+         "MixinProvider",
+         "DeviceProvider"
       ],
-      "realfs": true
+      "realfs": true,
+      "pluginDependencies": [
+         "@scrypted/python-codecs"
+      ]
+   },
+   "optionalDependencies": {
+      "sharp": "^0.31.3"
    },
    "dependencies": {
       "@scrypted/common": "file:../../common",
@@ -52,6 +59,6 @@
       "@types/lodash": "^4.14.175",
       "@types/node": "^14.17.11",
       "@types/semver": "^7.3.13",
-      "ts-node": "^10.9.1"
+      "@types/sharp": "^0.31.1"
    }
 }

plugins/objectdetector/src/ffmpeg-videoframes.ts

@@ -0,0 +1,193 @@
+import { Deferred } from "@scrypted/common/src/deferred";
+import { ffmpegLogInitialOutput, safeKillFFmpeg } from "@scrypted/common/src/media-helpers";
+import { readLength, readLine } from "@scrypted/common/src/read-stream";
+import sdk, { FFmpegInput, Image, ImageOptions, MediaObject, ScryptedDeviceBase, ScryptedMimeTypes, VideoFrame, VideoFrameGenerator, VideoFrameGeneratorOptions } from "@scrypted/sdk";
+import child_process from 'child_process';
+import sharp from 'sharp';
+import { Readable } from 'stream';
+
+async function createVipsMediaObject(image: VipsImage): Promise<VideoFrame & MediaObject> {
+    const ret = await sdk.mediaManager.createMediaObject(image, ScryptedMimeTypes.Image, {
+        format: null,
+        timestamp: 0,
+        width: image.width,
+        height: image.height,
+        toBuffer: (options: ImageOptions) => image.toBuffer(options),
+        toImage: async (options: ImageOptions) => {
+            const newImage = await image.toVipsImage(options);
+            return createVipsMediaObject(newImage);
+        }
+    });
+
+    return ret;
+}
+
+interface RawFrame {
+    width: number;
+    height: number;
+    data: Buffer;
+}
+
+class VipsImage implements Image {
+    constructor(public image: sharp.Sharp, public width: number, public height: number) {
+    }
+
+    toImageInternal(options: ImageOptions) {
+        const transformed = this.image.clone();
+        if (options?.crop) {
+            transformed.extract({
+                left: Math.floor(options.crop.left),
+                top: Math.floor(options.crop.top),
+                width: Math.floor(options.crop.width),
+                height: Math.floor(options.crop.height),
+            });
+        }
+        if (options?.resize) {
+            transformed.resize(typeof options.resize.width === 'number' ? Math.floor(options.resize.width) : undefined, typeof options.resize.height === 'number' ? Math.floor(options.resize.height) : undefined, {
+                fit: "fill",
+                kernel: 'cubic',
+            });
+        }
+
+        return transformed;
+    }
+
+    async toBuffer(options: ImageOptions) {
+        const transformed = this.toImageInternal(options);
+        if (options?.format === 'rgb') {
+            transformed.removeAlpha().toFormat('raw');
+        }
+        else if (options?.format === 'jpg') {
+            transformed.toFormat('jpg');
+        }
+        return transformed.toBuffer();
+    }
+
+    async toVipsImage(options: ImageOptions) {
+        const transformed = this.toImageInternal(options);
+        const { info, data } = await transformed.raw().toBuffer({
+            resolveWithObject: true,
+        });
+
+        const newImage = sharp(data, {
+            raw: info,
+        });
+
+        const newMetadata = await newImage.metadata();
+        const newVipsImage = new VipsImage(newImage, newMetadata.width, newMetadata.height);
+        return newVipsImage;
+    }
+
+    async toImage(options: ImageOptions) {
+        if (options.format)
+            throw new Error('format can only be used with toBuffer');
+        const newVipsImage = await this.toVipsImage(options);
+        return createVipsMediaObject(newVipsImage);
+    }
+}
+
+export class FFmpegVideoFrameGenerator extends ScryptedDeviceBase implements VideoFrameGenerator {
+    async *generateVideoFramesInternal(mediaObject: MediaObject, options?: VideoFrameGeneratorOptions, filter?: (videoFrame: VideoFrame & MediaObject) => Promise<boolean>): AsyncGenerator<VideoFrame & MediaObject, any, unknown> {
+        const ffmpegInput = await sdk.mediaManager.convertMediaObjectToJSON<FFmpegInput>(mediaObject, ScryptedMimeTypes.FFmpegInput);
+        const args = [
+            '-hide_banner',
+            //'-hwaccel', 'auto',
+            ...ffmpegInput.inputArguments,
+            '-vcodec', 'pam',
+            '-pix_fmt', 'rgb24',
+            '-f', 'image2pipe',
+            'pipe:3',
+        ];
+
+        const cp = child_process.spawn(await sdk.mediaManager.getFFmpegPath(), args, {
+            stdio: ['pipe', 'pipe', 'pipe', 'pipe'],
+        });
+        ffmpegLogInitialOutput(this.console, cp);
+
+        let finished = false;
+        let frameDeferred: Deferred<RawFrame>;
+
+        const reader = async () => {
+            try {
+
+                const readable = cp.stdio[3] as Readable;
+                const headers = new Map<string, string>();
+                while (!finished) {
+                    const line = await readLine(readable);
+                    if (line !== 'ENDHDR') {
+                        const [key, value] = line.split(' ');
+                        headers[key] = value;
+                        continue;
+                    }
+
+
+                    if (headers['TUPLTYPE'] !== 'RGB')
+                        throw new Error(`Unexpected TUPLTYPE in PAM stream: ${headers['TUPLTYPE']}`);
+
+                    const width = parseInt(headers['WIDTH']);
+                    const height = parseInt(headers['HEIGHT']);
+                    if (!width || !height)
+                        throw new Error('Invalid dimensions in PAM stream');
+
+                    const length = width * height * 3;
+                    headers.clear();
+                    const data = await readLength(readable, length);
+
+                    if (frameDeferred) {
+                        const f = frameDeferred;
+                        frameDeferred = undefined;
+                        f.resolve({
+                            width,
+                            height,
+                            data,
+                        });
+                    }
+                    else {
+                        // this.console.warn('skipped frame');
+                    }
+                }
+            }
+            catch (e) {
+            }
+            finally {
+                this.console.log('finished reader');
+                finished = true;
+                frameDeferred?.reject(new Error('frame generator finished'));
+            }
+        }
+
+        try {
+            reader();
+            while (!finished) {
+                frameDeferred = new Deferred();
+                const raw = await frameDeferred.promise;
+                const { width, height, data } = raw;
+
+                const image = sharp(data, {
+                    raw: {
+                        width,
+                        height,
+                        channels: 3,
+                    }
+                });
+                const vipsImage = new VipsImage(image, width, height);
+                const mo = await createVipsMediaObject(vipsImage);
+                yield mo;
+                vipsImage.image.destroy();
+                vipsImage.image = undefined;
+            }
+        }
+        catch (e) {
+        }
+        finally {
+            this.console.log('finished generator');
+            finished = true;
+            safeKillFFmpeg(cp);
+        }
+    }
+
+
+    async generateVideoFrames(mediaObject: MediaObject, options?: VideoFrameGeneratorOptions, filter?: (videoFrame: VideoFrame & MediaObject) => Promise<boolean>): Promise<AsyncGenerator<VideoFrame & MediaObject, any, unknown>> {
+        return this.generateVideoFramesInternal(mediaObject, options, filter);
+    }
+}

plugins/objectdetector/src/main.ts

@@ -1,10 +1,11 @@
-import sdk, { VideoFrameGenerator, Camera, DeviceState, EventListenerRegister, MediaObject, MixinDeviceBase, MixinProvider, MotionSensor, ObjectDetection, ObjectDetectionCallbacks, ObjectDetectionModel, ObjectDetectionResult, ObjectDetectionTypes, ObjectDetector, ObjectsDetected, ScryptedDevice, ScryptedDeviceType, ScryptedInterface, ScryptedNativeId, Setting, Settings, SettingValue, VideoCamera } from '@scrypted/sdk';
+import sdk, { Camera, DeviceProvider, DeviceState, EventListenerRegister, MediaObject, MediaStreamDestination, MixinDeviceBase, MixinProvider, MotionSensor, ObjectDetection, ObjectDetectionCallbacks, ObjectDetectionModel, ObjectDetectionResult, ObjectDetectionTypes, ObjectDetector, ObjectsDetected, ScryptedDevice, ScryptedDeviceType, ScryptedInterface, ScryptedMimeTypes, ScryptedNativeId, Setting, Settings, SettingValue, VideoCamera, VideoFrame, VideoFrameGenerator } from '@scrypted/sdk';
 import { StorageSettings } from '@scrypted/sdk/storage-settings';
 import crypto from 'crypto';
 import cloneDeep from 'lodash/cloneDeep';
 import { AutoenableMixinProvider } from "../../../common/src/autoenable-mixin-provider";
 import { SettingsMixinDeviceBase } from "../../../common/src/settings-mixin";
 import { DenoisedDetectionEntry, DenoisedDetectionState, denoiseDetections } from './denoise';
+import { FFmpegVideoFrameGenerator } from './ffmpeg-videoframes';
 import { serverSupportsMixinEventMasking } from './server-version';
 import { sleep } from './sleep';
 import { getAllDevices, safeParseJson } from './util';
@@ -50,6 +51,22 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
   detections = new Map<string, MediaObject>();
   cameraDevice: ScryptedDevice & Camera & VideoCamera & MotionSensor & ObjectDetector;
   storageSettings = new StorageSettings(this, {
+    newPipeline: {
+      title: 'Video Pipeline',
+      description: 'Configure how frames are provided to the video analysis pipeline.',
+      onGet: async () => {
+        const choices = [
+          'Default',
+          ...getAllDevices().filter(d => d.interfaces.includes(ScryptedInterface.VideoFrameGenerator)).map(d => d.name),
+        ];
+        if (!this.hasMotionType)
+          choices.push('Snapshot');
+        return {
+          choices,
+        }
+      },
+      defaultValue: 'Default',
+    },
     motionSensorSupplementation: {
       title: 'Built-In Motion Sensor',
       description: `This camera has a built in motion sensor. Using ${this.objectDetection.name} may be unnecessary and will use additional CPU. Replace will ignore the built in motion sensor. Filter will verify the motion sent by built in motion sensor. The Default is ${BUILTIN_MOTION_SENSOR_REPLACE}.`,
@@ -59,6 +76,10 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
         BUILTIN_MOTION_SENSOR_REPLACE,
       ],
       defaultValue: "Default",
+      onPut: () => {
+        this.endObjectDetection();
+        this.maybeStartMotionDetection();
+      }
     },
     captureMode: {
       title: 'Capture Mode',
@@ -128,7 +149,7 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
   analyzeStop = 0;
   lastDetectionInput = 0;
 
-  constructor(public plugin: ObjectDetectionPlugin, mixinDevice: VideoCamera & Camera & MotionSensor & ObjectDetector & Settings, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: { [key: string]: any }, providerNativeId: string, public objectDetection: ObjectDetection & ScryptedDevice, modelName: string, group: string, public hasMotionType: boolean, public settings: Setting[]) {
+  constructor(public plugin: ObjectDetectionPlugin, mixinDevice: VideoCamera & Camera & MotionSensor & ObjectDetector & Settings, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: { [key: string]: any }, providerNativeId: string, public objectDetection: ObjectDetection & ScryptedDevice, public model: ObjectDetectionModel, group: string, public hasMotionType: boolean, public settings: Setting[]) {
     super({
       mixinDevice, mixinDeviceState,
       mixinProviderNativeId: providerNativeId,
@@ -139,7 +160,7 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
     });
 
     this.cameraDevice = systemManager.getDeviceById<Camera & VideoCamera & MotionSensor & ObjectDetector>(this.id);
-    this.detectionId = modelName + '-' + this.cameraDevice.id;
+    this.detectionId = model.name + '-' + this.cameraDevice.id;
 
     this.bindObjectDetection();
     this.register();
@@ -157,7 +178,7 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
       if (this.hasMotionType) {
         // force a motion detection restart if it quit
         if (this.motionSensorSupplementation === BUILTIN_MOTION_SENSOR_REPLACE)
-          await this.startVideoDetection();
+          await this.startStreamAnalysis();
         return;
       }
     }, this.storageSettings.values.detectionInterval * 1000);
@@ -210,7 +231,7 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
       return;
     if (this.motionSensorSupplementation !== BUILTIN_MOTION_SENSOR_REPLACE)
       return;
-    await this.startVideoDetection();
+    await this.startStreamAnalysis();
   }
 
   endObjectDetection() {
@@ -296,7 +317,7 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
             return;
           if (!this.detectorRunning)
             this.console.log('built in motion sensor started motion, starting video detection.');
-          await this.startVideoDetection();
+          await this.startStreamAnalysis();
           return;
         }
 
@@ -408,7 +429,6 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
 
     if (retainImage && mediaObject) {
       this.lastDetectionInput = now;
-      this.console.log('retaining detection image');
       this.setDetection(detection, mediaObject);
     }
 
@@ -473,23 +493,74 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
     if (this.detectorRunning)
       return;
 
-    const stream = await this.cameraDevice.getVideoStream({
-      destination: 'local-recorder',
-      // ask rebroadcast to mute audio, not needed.
-      audio: null,
-    });
-
     this.detectorRunning = true;
     this.analyzeStop = Date.now() + this.getDetectionDuration();
 
-    const videoFrameGenerator = this.newPipeline as VideoFrameGenerator;
+    const newPipeline = this.newPipeline;
+    let generator: () => Promise<AsyncGenerator<VideoFrame & MediaObject>>;
+    if (newPipeline === 'Snapshot' && !this.hasMotionType) {
+      const self = this;
+      generator = async () => (async function* gen() {
+        try {
+          while (self.detectorRunning) {
+            const now = Date.now();
+            const sleeper = async () => {
+              const diff = now + 1100 - Date.now();
+              if (diff > 0)
+                await sleep(diff);
+            };
+            let image: MediaObject & VideoFrame;
+            try {
+              const mo = await self.cameraDevice.takePicture({
+                reason: 'event',
+              });
+              image = await sdk.mediaManager.convertMediaObject(mo, ScryptedMimeTypes.Image);
+            }
+            catch (e) {
+              self.console.error('Video analysis snapshot failed. Will retry in a moment.');
+              await sleeper();
+              continue;
+            }
 
+            // self.console.log('yield')
+            yield image;
+            // self.console.log('done yield')
+            await sleeper();
+          }
+        }
+        finally {
+          self.console.log('Snapshot generation finished.');
+        }
+      })();
+    }
+    else {
+      const destination: MediaStreamDestination = this.hasMotionType ? 'low-resolution' : 'local-recorder';
+      const videoFrameGenerator = systemManager.getDeviceById<VideoFrameGenerator>(newPipeline);
+      this.console.log('decoder:', videoFrameGenerator.name);
+      if (!videoFrameGenerator)
+        throw new Error('invalid VideoFrameGenerator');
+      const stream = await this.cameraDevice.getVideoStream({
+        destination,
+        // ask rebroadcast to mute audio, not needed.
+        audio: null,
+      });
+
+      generator = async () => videoFrameGenerator.generateVideoFrames(stream, {
+        resize: this.model?.inputSize ? {
+          width: this.model.inputSize[0],
+          height: this.model.inputSize[1],
+        } : undefined,
+        format: this.model?.inputFormat,
+      });
+    }
+
+    const start = Date.now();
+    let detections = 0;
     try {
-      const start = Date.now();
-      let detections = 0;
       for await (const detected
-        of await this.objectDetection.generateObjectDetections(await videoFrameGenerator.generateVideoFrames(stream), {
+        of await this.objectDetection.generateObjectDetections(await generator(), {
           settings: this.getCurrentSettings(),
+          sourceId: this.id,
         })) {
         if (!this.detectorRunning) {
           break;
@@ -529,10 +600,17 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
           // this.console.log('image saved', detected.detected.detections);
         }
         this.reportObjectDetections(detected.detected);
+        if (this.hasMotionType) {
+          await sleep(250);
+        }
         // this.handleDetectionEvent(detected.detected);
       }
     }
+    catch (e) {
+      this.console.error('video pipeline ended with error', e);
+    }
     finally {
+      this.console.log('video pipeline analysis ended, dps:', detections / (Date.now() - start) * 1000);
       this.endObjectDetection();
     }
   }
@@ -610,6 +688,19 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
     }
   }
 
+  normalizeBox(boundingBox: [number, number, number, number], inputDimensions: [number, number]) {
+    let [x, y, width, height] = boundingBox;
+    let x2 = x + width;
+    let y2 = y + height;
+    // the zones are point paths in percentage format
+    x = x * 100 / inputDimensions[0];
+    y = y * 100 / inputDimensions[1];
+    x2 = x2 * 100 / inputDimensions[0];
+    y2 = y2 * 100 / inputDimensions[1];
+    const box = [[x, y], [x2, y], [x2, y2], [x, y2]];
+    return box;
+  }
+
   getDetectionDuration() {
     // when motion type, the detection interval is a keepalive reset.
     // the duration needs to simply be an arbitrarily longer time.
@@ -626,15 +717,7 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
         continue;
 
       o.zones = []
-      let [x, y, width, height] = o.boundingBox;
-      let x2 = x + width;
-      let y2 = y + height;
-      // the zones are point paths in percentage format
-      x = x * 100 / detection.inputDimensions[0];
-      y = y * 100 / detection.inputDimensions[1];
-      x2 = x2 * 100 / detection.inputDimensions[0];
-      y2 = y2 * 100 / detection.inputDimensions[1];
-      const box = [[x, y], [x2, y], [x2, y2], [x, y2]];
+      const box = this.normalizeBox(o.boundingBox, detection.inputDimensions);
 
       let included: boolean;
       for (const [zone, zoneValue] of Object.entries(this.zones)) {
@@ -674,6 +757,14 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
         }
       }
 
+      // if this is a motion sensor and there are no inclusion zones set up,
+      // use a default inclusion zone that crops the top and bottom to
+      // prevents errant motion from the on screen time changing every second.
+      if (this.hasMotionType && included === undefined) {
+        const defaultInclusionZone = [[0, 10], [100, 10], [100, 90], [0, 90]];
+        included = polygonOverlap(box, defaultInclusionZone);
+      }
+
       // if there are inclusion zones and this object
       // was not in any of them, filter it out.
       if (included === false)
@@ -801,6 +892,8 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
     if (!detection.detectionId)
       detection.detectionId = crypto.randomBytes(4).toString('hex');
 
+    this.console.log('retaining detection image');
+
     const { detectionId } = detection;
     this.detections.set(detectionId, detectionInput);
     setTimeout(() => {
@@ -849,8 +942,22 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
   }
 
   get newPipeline() {
-    return this.plugin.storageSettings.values.newPipeline;
-  } 
+    if (!this.plugin.storageSettings.values.newPipeline)
+      return;
+
+    const newPipeline = this.storageSettings.values.newPipeline;
+    if (!newPipeline)
+      return newPipeline;
+    if (newPipeline === 'Snapshot')
+      return newPipeline;
+    const pipelines = getAllDevices().filter(d => d.interfaces.includes(ScryptedInterface.VideoFrameGenerator));
+    const webcodec = pipelines.find(p => p.nativeId === 'webcodec');
+    const gstreamer = pipelines.find(p => p.nativeId === 'gstreamer');
+    const libav = pipelines.find(p => p.nativeId === 'libav');
+    const ffmpeg = pipelines.find(p => p.nativeId === 'ffmpeg');
+    const use = pipelines.find(p => p.name === newPipeline) || webcodec || gstreamer || libav || ffmpeg;
+    return use.id;
+  }
 
   async getMixinSettings(): Promise<Setting[]> {
     const settings: Setting[] = [];
@@ -872,7 +979,8 @@ class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera
     }
 
     this.storageSettings.settings.motionSensorSupplementation.hide = !this.hasMotionType || !this.mixinDeviceInterfaces.includes(ScryptedInterface.MotionSensor);
-    this.storageSettings.settings.captureMode.hide = this.hasMotionType || !!this.newPipeline;
+    this.storageSettings.settings.captureMode.hide = this.hasMotionType || !!this.plugin.storageSettings.values.newPipeline;
+    this.storageSettings.settings.newPipeline.hide = this.hasMotionType || !this.plugin.storageSettings.values.newPipeline;
     this.storageSettings.settings.detectionDuration.hide = this.hasMotionType;
     this.storageSettings.settings.detectionTimeout.hide = this.hasMotionType;
     this.storageSettings.settings.motionDuration.hide = !this.hasMotionType;
@@ -1123,7 +1231,7 @@ class ObjectDetectorMixin extends MixinDeviceBase<ObjectDetection> implements Mi
 
     const settings = this.model.settings;
 
-    const ret = new ObjectDetectionMixin(this.plugin, mixinDevice, mixinDeviceInterfaces, mixinDeviceState, this.mixinProviderNativeId, objectDetection, this.model.name, group, hasMotionType, settings);
+    const ret = new ObjectDetectionMixin(this.plugin, mixinDevice, mixinDeviceInterfaces, mixinDeviceState, this.mixinProviderNativeId, objectDetection, this.model, group, hasMotionType, settings);
     this.currentMixins.add(ret);
     return ret;
   }
@@ -1134,15 +1242,14 @@ class ObjectDetectorMixin extends MixinDeviceBase<ObjectDetection> implements Mi
   }
 }
 
-class ObjectDetectionPlugin extends AutoenableMixinProvider implements Settings {
+class ObjectDetectionPlugin extends AutoenableMixinProvider implements Settings, DeviceProvider {
   currentMixins = new Set<ObjectDetectorMixin>();
 
   storageSettings = new StorageSettings(this, {
     newPipeline: {
       title: 'New Video Pipeline',
       description: 'WARNING! DO NOT ENABLE: Use the new video pipeline. Leave blank to use the legacy pipeline.',
-      type: 'device',
-      deviceFilter: `interfaces.includes('${ScryptedInterface.VideoFrameGenerator}')`,
+      type: 'boolean',
     },
     activeMotionDetections: {
       title: 'Active Motion Detection Sessions',
@@ -1166,6 +1273,29 @@ class ObjectDetectionPlugin extends AutoenableMixinProvider implements Settings
 
   constructor(nativeId?: ScryptedNativeId) {
     super(nativeId);
+
+    process.nextTick(() => {
+      sdk.deviceManager.onDevicesChanged({
+        devices: [
+          {
+            name: 'FFmpeg Frame Generator',
+            type: ScryptedDeviceType.Builtin,
+            interfaces: [
+              ScryptedInterface.VideoFrameGenerator,
+            ],
+            nativeId: 'ffmpeg',
+          }
+        ]
+      })
+    })
+  }
+
+  async getDevice(nativeId: string): Promise<any> {
+    if (nativeId === 'ffmpeg')
+      return new FFmpegVideoFrameGenerator('ffmpeg');
+  }
+
+  async releaseDevice(id: string, nativeId: string): Promise<void> {
   }
 
   getSettings(): Promise<Setting[]> {

plugins/onvif/package-lock.json

@@ -1,12 +1,12 @@
 {
    "name": "@scrypted/onvif",
-   "version": "0.0.117",
+   "version": "0.0.118",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/onvif",
-         "version": "0.0.117",
+         "version": "0.0.118",
          "license": "Apache",
          "dependencies": {
             "@koush/axios-digest-auth": "^0.8.5",

plugins/onvif/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/onvif",
-   "version": "0.0.117",
+   "version": "0.0.118",
    "description": "ONVIF Camera Plugin for Scrypted",
    "author": "Scrypted",
    "license": "Apache",

plugins/onvif/src/onvif-ptz.ts

@@ -1,7 +1,7 @@
 import { DeviceState, MixinDeviceBase, MixinDeviceOptions, MixinProvider, PanTiltZoom, PanTiltZoomCommand, PanTiltZoomMovement, ScryptedDeviceBase, ScryptedDeviceType, ScryptedInterface, Setting, Settings, SettingValue } from "@scrypted/sdk";
 import { StorageSettings } from "@scrypted/sdk/storage-settings";
 import { connectCameraAPI } from "./onvif-api";
-import {SettingsMixinDeviceBase, SettingsMixinDeviceOptions} from '../../../common/src/settings-mixin';
+import { SettingsMixinDeviceBase, SettingsMixinDeviceOptions } from '../../../common/src/settings-mixin';
 
 export class OnvifPtzMixin extends SettingsMixinDeviceBase<Settings> implements PanTiltZoom, Settings {
     storageSettings = new StorageSettings(this, {
@@ -55,9 +55,9 @@ export class OnvifPtzMixin extends SettingsMixinDeviceBase<Settings> implements
             };
         }
 
-        if (command.movement === PanTiltZoomMovement.Relative) {
+        if (command.movement === PanTiltZoomMovement.Absolute) {
             return new Promise<void>((r, f) => {
-                client.cam.relativeMove({
+                client.cam.absoluteMove({
                     x: command.pan,
                     y: command.tilt,
                     zoom: command.zoom,
@@ -69,9 +69,10 @@ export class OnvifPtzMixin extends SettingsMixinDeviceBase<Settings> implements
                 })
             })
         }
-        else if (command.movement === PanTiltZoomMovement.Absolute) {
+        else {
+            // relative movement is default.
             return new Promise<void>((r, f) => {
-                client.cam.absoluteMove({
+                client.cam.relativeMove({
                     x: command.pan,
                     y: command.tilt,
                     zoom: command.zoom,

plugins/opencv/.npmignore

@@ -9,3 +9,4 @@ dist/*.js
 dist/*.txt
 __pycache__
 all_models
+.venv

plugins/opencv/.vscode/settings.json

@@ -16,6 +16,6 @@
 
     "scrypted.pythonRemoteRoot": "${config:scrypted.serverRoot}/volume/plugin.zip",
     "python.analysis.extraPaths": [
-        "./node_modules/@scrypted/sdk/scrypted_python"
+        "./node_modules/@scrypted/sdk/types/scrypted_python"
     ]
 }

plugins/opencv/package-lock.json

@@ -1,50 +1,52 @@
 {
    "name": "@scrypted/opencv",
-   "version": "0.0.64",
+   "version": "0.0.69",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/opencv",
-         "version": "0.0.64",
+         "version": "0.0.69",
          "devDependencies": {
             "@scrypted/sdk": "file:../../sdk"
          }
       },
       "../../sdk": {
          "name": "@scrypted/sdk",
-         "version": "0.1.17",
+         "version": "0.2.85",
          "dev": true,
          "license": "ISC",
          "dependencies": {
-            "@babel/preset-typescript": "^7.16.7",
+            "@babel/preset-typescript": "^7.18.6",
             "adm-zip": "^0.4.13",
             "axios": "^0.21.4",
-            "babel-loader": "^8.2.3",
+            "babel-loader": "^9.1.0",
             "babel-plugin-const-enum": "^1.1.0",
             "esbuild": "^0.15.9",
             "ncp": "^2.0.0",
             "raw-loader": "^4.0.2",
             "rimraf": "^3.0.2",
             "tmp": "^0.2.1",
-            "webpack": "^5.74.0",
+            "ts-loader": "^9.4.2",
+            "typescript": "^4.9.4",
+            "webpack": "^5.75.0",
             "webpack-bundle-analyzer": "^4.5.0"
          },
          "bin": {
+            "scrypted-changelog": "bin/scrypted-changelog.js",
             "scrypted-debug": "bin/scrypted-debug.js",
             "scrypted-deploy": "bin/scrypted-deploy.js",
             "scrypted-deploy-debug": "bin/scrypted-deploy-debug.js",
             "scrypted-package-json": "bin/scrypted-package-json.js",
-            "scrypted-readme": "bin/scrypted-readme.js",
             "scrypted-setup-project": "bin/scrypted-setup-project.js",
             "scrypted-webpack": "bin/scrypted-webpack.js"
          },
          "devDependencies": {
-            "@types/node": "^16.11.1",
+            "@types/node": "^18.11.18",
             "@types/stringify-object": "^4.0.0",
             "stringify-object": "^3.3.0",
             "ts-node": "^10.4.0",
-            "typedoc": "^0.23.15"
+            "typedoc": "^0.23.21"
          }
       },
       "../sdk": {
@@ -59,12 +61,12 @@
       "@scrypted/sdk": {
          "version": "file:../../sdk",
          "requires": {
-            "@babel/preset-typescript": "^7.16.7",
-            "@types/node": "^16.11.1",
+            "@babel/preset-typescript": "^7.18.6",
+            "@types/node": "^18.11.18",
             "@types/stringify-object": "^4.0.0",
             "adm-zip": "^0.4.13",
             "axios": "^0.21.4",
-            "babel-loader": "^8.2.3",
+            "babel-loader": "^9.1.0",
             "babel-plugin-const-enum": "^1.1.0",
             "esbuild": "^0.15.9",
             "ncp": "^2.0.0",
@@ -72,9 +74,11 @@
             "rimraf": "^3.0.2",
             "stringify-object": "^3.3.0",
             "tmp": "^0.2.1",
+            "ts-loader": "^9.4.2",
             "ts-node": "^10.4.0",
-            "typedoc": "^0.23.15",
-            "webpack": "^5.74.0",
+            "typedoc": "^0.23.21",
+            "typescript": "^4.9.4",
+            "webpack": "^5.75.0",
             "webpack-bundle-analyzer": "^4.5.0"
          }
       }

plugins/opencv/package.json

@@ -36,5 +36,5 @@
    "devDependencies": {
       "@scrypted/sdk": "file:../../sdk"
    },
-   "version": "0.0.64"
+   "version": "0.0.69"
 }

plugins/opencv/src/opencv/__init__.py

@@ -3,6 +3,7 @@ from time import sleep
 from detect import DetectionSession, DetectPlugin
 from typing import Any, List, Tuple
 import numpy as np
+import asyncio
 import cv2
 import imutils
 Gst = None
@@ -10,7 +11,7 @@ try:
     from gi.repository import Gst
 except:
     pass
-from scrypted_sdk.types import ObjectDetectionModel, ObjectDetectionResult, ObjectsDetected, Setting
+from scrypted_sdk.types import ObjectDetectionModel, ObjectDetectionResult, ObjectsDetected, Setting, VideoFrame
 from PIL import Image
 
 class OpenCVDetectionSession(DetectionSession):
@@ -93,6 +94,9 @@ class OpenCVPlugin(DetectPlugin):
 
     def get_pixel_format(self):
         return self.pixelFormat
+    
+    def get_input_format(self) -> str:
+        return 'gray'
 
     def parse_settings(self, settings: Any):
         area = defaultArea
@@ -106,7 +110,8 @@ class OpenCVPlugin(DetectPlugin):
             blur = int(settings.get('blur', blur))
         return area, threshold, interval, blur
 
-    def detect(self, detection_session: OpenCVDetectionSession, frame, settings: Any, src_size, convert_to_src_size) -> ObjectsDetected:
+    def detect(self, detection_session: OpenCVDetectionSession, frame, src_size, convert_to_src_size) -> ObjectsDetected:
+        settings = detection_session.settings
         area, threshold, interval, blur = self.parse_settings(settings)
 
         # see get_detection_input_size on undocumented size requirements for GRAY8
@@ -119,10 +124,15 @@ class OpenCVPlugin(DetectPlugin):
         detection_session.curFrame = cv2.GaussianBlur(
             gray, (blur, blur), 0, dst=detection_session.curFrame)
 
+        detections: List[ObjectDetectionResult] = []
+        detection_result: ObjectsDetected = {}
+        detection_result['detections'] = detections
+        detection_result['inputDimensions'] = src_size
+
         if detection_session.previous_frame is None:
             detection_session.previous_frame = detection_session.curFrame
             detection_session.curFrame = None
-            return
+            return detection_result
 
         detection_session.frameDelta = cv2.absdiff(
             detection_session.previous_frame, detection_session.curFrame, dst=detection_session.frameDelta)
@@ -138,10 +148,6 @@ class OpenCVPlugin(DetectPlugin):
             detection_session.dilated, cv2.RETR_EXTERNAL, cv2.CHAIN_APPROX_SIMPLE)
         contours = imutils.grab_contours(fcontours)
 
-        detections: List[ObjectDetectionResult] = []
-        detection_result: ObjectsDetected = {}
-        detection_result['detections'] = detections
-        detection_result['inputDimensions'] = src_size
 
         for c in contours:
             x, y, w, h = cv2.boundingRect(c)
@@ -163,6 +169,9 @@ class OpenCVPlugin(DetectPlugin):
                 detections.append(detection)
 
         return detection_result
+    
+    def get_input_details(self) -> Tuple[int, int, int]:
+        return (300, 300, 1)
 
     def get_detection_input_size(self, src_size):
         # The initial implementation of this plugin used BGRA
@@ -197,23 +206,58 @@ class OpenCVPlugin(DetectPlugin):
             detection_session.cap = None
         return super().end_session(detection_session)
 
-    def run_detection_image(self, detection_session: DetectionSession, image: Image.Image, settings: Any, src_size, convert_to_src_size) -> Tuple[ObjectsDetected, Any]:
+    async def run_detection_image(self, detection_session: DetectionSession, image: Image.Image, settings: Any, src_size, convert_to_src_size) -> Tuple[ObjectsDetected, Any]:
         # todo
         raise Exception('can not run motion detection on image')
+    
+    async def run_detection_videoframe(self, videoFrame: VideoFrame, detection_session: OpenCVDetectionSession) -> ObjectsDetected:
+        width = videoFrame.width
+        height = videoFrame.height
 
-    def run_detection_avframe(self, detection_session: DetectionSession, avframe, settings: Any, src_size, convert_to_src_size) -> Tuple[ObjectsDetected, Any]:
+        aspectRatio = width / height
+        
+        # dont bother resizing if its already fairly small
+        if width <= 640 and height < 640:
+            scale = 1
+            resize = None
+        else:
+            if aspectRatio > 1:
+                scale = height / 300
+                height = 300
+                width = int(300 * aspectRatio)
+            else:
+                width = 300
+                height = int(300 / aspectRatio)
+                scale = width / 300
+            resize = {
+                'width': width,
+                'height': height,
+            }
+
+        buffer = await videoFrame.toBuffer({
+            'resize': resize,
+        })
+
+        def convert_to_src_size(point, normalize = False):
+            return point[0] * scale, point[1] * scale, True
+        mat = np.ndarray((height, width, self.pixelFormatChannelCount), buffer=buffer, dtype=np.uint8)
+        detections = self.detect(
+            detection_session, mat, (width, height), convert_to_src_size)
+        return detections
+
+    async def run_detection_avframe(self, detection_session: DetectionSession, avframe, settings: Any, src_size, convert_to_src_size) -> Tuple[ObjectsDetected, Any]:
         if avframe.format.name != 'yuv420p' and avframe.format.name != 'yuvj420p':
             mat = avframe.to_ndarray(format='gray8')
         else:
             mat = np.ndarray((avframe.height, avframe.width, self.pixelFormatChannelCount), buffer=avframe.planes[0], dtype=np.uint8)
         detections = self.detect(
-            detection_session, mat, settings, src_size, convert_to_src_size)
+            detection_session, mat, src_size, convert_to_src_size)
         if not detections or not len(detections['detections']):
-            self.detection_sleep(settings)
+            await self.detection_sleep(settings)
             return None, None
         return detections, None
 
-    def run_detection_gstsample(self, detection_session: OpenCVDetectionSession, gst_sample, settings: Any, src_size, convert_to_src_size) -> ObjectsDetected:
+    async def run_detection_gstsample(self, detection_session: OpenCVDetectionSession, gst_sample, settings: Any, src_size, convert_to_src_size) -> ObjectsDetected:
         buf = gst_sample.get_buffer()
         caps = gst_sample.get_caps()
         # can't trust the width value, compute the stride
@@ -230,24 +274,24 @@ class OpenCVPlugin(DetectPlugin):
                 buffer=info.data,
                 dtype=np.uint8)
             detections = self.detect(
-                detection_session, mat, settings, src_size, convert_to_src_size)
+                detection_session, mat, src_size, convert_to_src_size)
             # no point in triggering empty events.
         finally:
             buf.unmap(info)
 
         if not detections or not len(detections['detections']):
-            self.detection_sleep(settings)
+            await self.detection_sleep(settings)
             return None, None
         return detections, None
 
     def create_detection_session(self):
         return OpenCVDetectionSession()
 
-    def detection_sleep(self, settings: Any):
+    async def detection_sleep(self, settings: Any):
         area, threshold, interval, blur = self.parse_settings(settings)
         # it is safe to block here because gstreamer creates a queue thread
-        sleep(interval / 1000)
+        await asyncio.sleep(interval / 1000)
 
-    def detection_event_notified(self, settings: Any):
-        self.detection_sleep(settings)
-        return super().detection_event_notified(settings)
+    async def detection_event_notified(self, settings: Any):
+        await self.detection_sleep(settings)
+        return await super().detection_event_notified(settings)

plugins/opencv/src/requirements.txt

@@ -1,6 +1,11 @@
 # plugin
 numpy>=1.16.2
-Pillow>=5.4.1
+# pillow for anything not intel linux
+Pillow>=5.4.1; sys_platform != 'linux' or platform_machine != 'x86_64'
+pillow-simd; sys_platform == 'linux' and platform_machine == 'x86_64'
 PyGObject>=3.30.4; sys_platform != 'win32'
-av>=10.0.0; sys_platform != 'linux' or platform_machine == 'x86_64' or platform_machine == 'aarch64'
 imutils>=0.5.0
+# not available on armhf
+av>=10.0.0; sys_platform != 'linux' or platform_machine == 'x86_64' or platform_machine == 'aarch64'
+# not available on armhf
+opencv-python; sys_platform != 'linux' or platform_machine == 'x86_64' or platform_machine == 'aarch64'

plugins/pam-diff/package-lock.json

@@ -1,12 +1,12 @@
 {
    "name": "@scrypted/pam-diff",
-   "version": "0.0.16",
+   "version": "0.0.17",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/pam-diff",
-         "version": "0.0.16",
+         "version": "0.0.17",
          "hasInstallScript": true,
          "dependencies": {
             "@types/node": "^16.6.1",

plugins/pam-diff/package.json

@@ -43,5 +43,5 @@
    "devDependencies": {
       "@scrypted/sdk": "file:../../sdk"
    },
-   "version": "0.0.16"
+   "version": "0.0.17"
 }

plugins/pam-diff/src/main.ts

@@ -1,11 +1,10 @@
-import { ObjectDetectionResult, FFmpegInput, MediaObject, ObjectDetection, ObjectDetectionCallbacks, ObjectDetectionModel, ObjectDetectionSession, ObjectsDetected, ScryptedDeviceBase, ScryptedInterface, ScryptedMimeTypes } from '@scrypted/sdk';
-import sdk from '@scrypted/sdk';
-import { ffmpegLogInitialOutput, safeKillFFmpeg, safePrintFFmpegArguments } from "../../../common/src/media-helpers";
-
+import sdk, { FFmpegInput, MediaObject, ObjectDetection, ObjectDetectionCallbacks, ObjectDetectionGeneratorResult, ObjectDetectionGeneratorSession, ObjectDetectionModel, ObjectDetectionResult, ObjectDetectionSession, ObjectsDetected, ScryptedDeviceBase, ScryptedInterface, ScryptedMimeTypes, VideoFrame } from '@scrypted/sdk';
 import child_process, { ChildProcess } from 'child_process';
+import { ffmpegLogInitialOutput, safeKillFFmpeg, safePrintFFmpegArguments } from "../../../common/src/media-helpers";
 
 import PD from 'pam-diff';
 import P2P from 'pipe2pam';
+import { PassThrough, Writable } from 'stream';
 
 const { mediaManager } = sdk;
 
@@ -51,6 +50,101 @@ class PamDiff extends ScryptedDeviceBase implements ObjectDetection {
         pds.timeout = setTimeout(() => this.endSession(id), duration);
     }
 
+    async * generateObjectDetectionsInternal(videoFrames: AsyncGenerator<VideoFrame, any, unknown>, session: ObjectDetectionGeneratorSession): AsyncGenerator<ObjectDetectionGeneratorResult, any, unknown> {
+        videoFrames = await sdk.connectRPCObject(videoFrames);
+
+        const width = 640;
+        const height = 360;
+        const p2p: Writable = new P2P();
+        const pt = new PassThrough();
+        const pamDiff = new PD({
+            difference: parseInt(session.settings?.difference) || defaultDifference,
+            percent: parseInt(session.settings?.percent) || defaultPercentage,
+            response: session?.settings?.motionAsObjects ? 'blobs' : 'percent',
+        });
+        pt.pipe(p2p).pipe(pamDiff);
+
+        const queued: ObjectsDetected[] = [];
+        pamDiff.on('diff', async (data: any) => {
+            const trigger = data.trigger[0];
+            // console.log(trigger.blobs.length);
+            const { blobs } = trigger;
+
+            const detections: ObjectDetectionResult[] = [];
+            if (blobs?.length) {
+                for (const blob of blobs) {
+                    detections.push(
+                        {
+                            className: 'motion',
+                            score: 1,
+                            boundingBox: [blob.minX, blob.minY, blob.maxX - blob.minX, blob.maxY - blob.minY],
+                        }
+                    )
+                }
+            }
+            else {
+                detections.push(
+                    {
+                        className: 'motion',
+                        score: trigger.percent / 100,
+                    }
+                )
+            }
+            const event: ObjectsDetected = {
+                timestamp: Date.now(),
+                running: true,
+                inputDimensions: [width, height],
+                detections,
+            }
+            queued.push(event);
+        });
+
+
+        for await (const videoFrame of videoFrames) {
+            const header = `P7
+WIDTH ${width}
+HEIGHT ${height}
+DEPTH 3
+MAXVAL 255
+TUPLTYPE RGB
+ENDHDR
+`;
+
+            const buffer = await videoFrame.toBuffer({
+                resize: {
+                    width,
+                    height,
+                },
+                format: 'rgb',
+            });
+            pt.write(Buffer.from(header));
+            pt.write(buffer);
+
+            if (!queued.length) {
+                yield {
+                    __json_copy_serialize_children: true,
+                    videoFrame,
+                    detected: {
+                        timestamp: Date.now(),
+                        detections: [],
+                    }
+                }
+            }
+            while (queued.length) {
+                yield {
+                    __json_copy_serialize_children: true,
+                    detected: queued.pop(),
+                    videoFrame,
+                };
+            }
+        }
+    }
+
+
+    async generateObjectDetections(videoFrames: AsyncGenerator<VideoFrame, any, unknown>, session: ObjectDetectionGeneratorSession): Promise<AsyncGenerator<ObjectDetectionGeneratorResult, any, unknown>> {
+        return this.generateObjectDetectionsInternal(videoFrames, session);
+    }
+
     async detectObjects(mediaObject: MediaObject, session?: ObjectDetectionSession, callbacks?: ObjectDetectionCallbacks): Promise<ObjectsDetected> {
         if (mediaObject && mediaObject.mimeType?.startsWith('image/'))
             throw new Error('can not run motion detection on image')
@@ -209,6 +303,8 @@ class PamDiff extends ScryptedDeviceBase implements ObjectDetection {
         return {
             name: '@scrypted/pam-diff',
             classes: ['motion'],
+            inputFormat: 'rgb',
+            inputSize: [640, 360],
             settings: [
                 {
                     title: 'Motion Difference',
@@ -229,4 +325,4 @@ class PamDiff extends ScryptedDeviceBase implements ObjectDetection {
     }
 }
 
-export default new PamDiff();
+export default PamDiff;

plugins/python-codecs/.vscode/settings.json

@@ -1,9 +1,13 @@
 
 {
     // docker installation
-    // "scrypted.debugHost": "koushik-thin",
+    // "scrypted.debugHost": "koushik-ubuntu",
     // "scrypted.serverRoot": "/server",
 
+    // windows installation
+    // "scrypted.debugHost": "koushik-windows",
+    // "scrypted.serverRoot": "C:\\Users\\koush\\.scrypted",
+
     // pi local installation
     // "scrypted.debugHost": "192.168.2.119",
     // "scrypted.serverRoot": "/home/pi/.scrypted",

plugins/python-codecs/package-lock.json

@@ -1,12 +1,12 @@
 {
    "name": "@scrypted/python-codecs",
-   "version": "0.0.23",
+   "version": "0.1.18",
    "lockfileVersion": 3,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/python-codecs",
-         "version": "0.0.23",
+         "version": "0.1.18",
          "devDependencies": {
             "@scrypted/sdk": "file:../../sdk"
          }

plugins/python-codecs/package.json

@@ -1,6 +1,7 @@
 {
    "name": "@scrypted/python-codecs",
-   "description": "Scrypted Python Codecs",
+   "version": "0.1.18",
+   "description": "Python Codecs for Scrypted",
    "keywords": [
       "scrypted",
       "plugin",
@@ -24,11 +25,10 @@
       "runtime": "python",
       "type": "API",
       "interfaces": [
-         "VideoFrameGenerator"
+         "DeviceProvider"
       ]
    },
    "devDependencies": {
       "@scrypted/sdk": "file:../../sdk"
-   },
-   "version": "0.0.23"
+   }
 }

plugins/python-codecs/src/gst_generator.py

@@ -0,0 +1,136 @@
+import concurrent.futures
+import threading
+import asyncio
+from queue import Queue
+
+try:
+    import gi
+    gi.require_version('Gst', '1.0')
+    gi.require_version('GstBase', '1.0')
+
+    from gi.repository import GLib, GObject, Gst
+    GObject.threads_init()
+    Gst.init(None)
+except:
+    pass
+
+class Callback:
+    def __init__(self, callback) -> None:
+        if callback:
+            self.loop = asyncio.get_running_loop()
+            self.callback = callback
+        else:
+            self.loop = None
+            self.callback = None
+
+def createPipelineIterator(pipeline: str):
+    pipeline = '{pipeline} ! queue leaky=downstream max-size-buffers=0 ! appsink name=appsink emit-signals=true sync=false max-buffers=-1 drop=true'.format(pipeline=pipeline)
+    print(pipeline)
+    gst = Gst.parse_launch(pipeline)
+    bus = gst.get_bus()
+
+    def on_bus_message(bus, message):
+        t = str(message.type)
+        # print(t)
+        if t == str(Gst.MessageType.EOS):
+            finish()
+        elif t == str(Gst.MessageType.WARNING):
+            err, debug = message.parse_warning()
+            print('Warning: %s: %s\n' % (err, debug))
+        elif t == str(Gst.MessageType.ERROR):
+            err, debug = message.parse_error()
+            print('Error: %s: %s\n' % (err, debug))
+            finish()
+
+    def stopGst():
+        bus.remove_signal_watch()
+        bus.disconnect(watchId)
+        gst.set_state(Gst.State.NULL)
+
+    def finish():
+        nonlocal hasFinished
+        hasFinished = True
+        callback = Callback(None)
+        callbackQueue.put(callback)
+        if not asyncFuture.done():
+            asyncFuture.set_result(None)
+        if not finished.done():
+            finished.set_result(None)
+
+    watchId = bus.connect('message', on_bus_message)
+    bus.add_signal_watch()
+
+    finished = concurrent.futures.Future()
+    finished.add_done_callback(lambda _: threading.Thread(target=stopGst, name="StopGst").start())
+    hasFinished = False
+
+    appsink = gst.get_by_name('appsink')
+    callbackQueue = Queue()
+    asyncFuture = asyncio.Future()
+
+    async def gen():
+        try:      
+            while True:
+                nonlocal asyncFuture
+                asyncFuture = asyncio.Future()
+                yieldFuture = asyncio.Future()
+                async def asyncCallback(sample):
+                    asyncFuture.set_result(sample)
+                    await yieldFuture
+                callbackQueue.put(Callback(asyncCallback))
+                sample = await asyncFuture
+                if not sample:
+                    yieldFuture.set_result(None)
+                    break
+                try:
+                    yield sample
+                finally:
+                    yieldFuture.set_result(None)
+        finally:
+            finish()
+            print('gstreamer finished')
+
+
+    def on_new_sample(sink, preroll):
+        nonlocal hasFinished
+
+        sample = sink.emit('pull-preroll' if preroll else 'pull-sample')
+
+        callback: Callback = callbackQueue.get()
+        if not callback.callback or hasFinished:
+            hasFinished = True
+            if callback.callback:
+                asyncio.run_coroutine_threadsafe(callback.callback(None), loop = callback.loop)
+            return Gst.FlowReturn.OK
+
+        future = asyncio.run_coroutine_threadsafe(callback.callback(sample), loop = callback.loop)
+        try:
+            future.result()
+        except:
+            pass
+        return Gst.FlowReturn.OK
+
+    appsink.connect('new-preroll', on_new_sample, True)
+    appsink.connect('new-sample', on_new_sample, False)
+
+    gst.set_state(Gst.State.PLAYING)
+    return gst, gen
+
+def mainThread():
+    async def asyncMain():
+        gst, gen = createPipelineIterator('rtspsrc location=rtsp://localhost:59668/18cc179a814fd5b3 ! rtph264depay ! h264parse ! vtdec_hw ! videoconvert ! video/x-raw')
+        i = 0
+        async for sample in gen():
+            print('sample')
+            i = i + 1
+            if i == 10:
+                break
+
+    loop = asyncio.new_event_loop()
+    asyncio.ensure_future(asyncMain(), loop = loop)
+    loop.run_forever()
+
+if __name__ == "__main__":
+    threading.Thread(target = mainThread).start()
+    mainLoop = GLib.MainLoop()
+    mainLoop.run()

plugins/python-codecs/src/gstreamer.py

@@ -1,132 +1,113 @@
-import concurrent.futures
-import threading
-import asyncio
-from queue import Queue
+from gst_generator import createPipelineIterator
+from util import optional_chain
+import scrypted_sdk
+from typing import Any
+from urllib.parse import urlparse
+import vipsimage
+import pilimage
+import platform
 
+Gst = None
 try:
     import gi
     gi.require_version('Gst', '1.0')
     gi.require_version('GstBase', '1.0')
 
-    from gi.repository import GLib, GObject, Gst
-    GObject.threads_init()
-    Gst.init(None)
+    from gi.repository import Gst
 except:
     pass
 
-class Callback:
-    def __init__(self, callback) -> None:
-        self.loop = asyncio.get_running_loop()
-        self.callback = callback
+async def generateVideoFramesGstreamer(mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None, h264Decoder: str = None) -> scrypted_sdk.VideoFrame:
+    ffmpegInput: scrypted_sdk.FFmpegInput = await scrypted_sdk.mediaManager.convertMediaObjectToJSON(mediaObject, scrypted_sdk.ScryptedMimeTypes.FFmpegInput.value)
+    container = ffmpegInput.get('container', None)
+    videosrc = ffmpegInput.get('url')
+    videoCodec = optional_chain(ffmpegInput, 'mediaStreamOptions', 'video', 'codec')
 
-def createPipelineIterator(pipeline: str):
-    pipeline = '{pipeline} ! queue leaky=downstream max-size-buffers=0 ! appsink name=appsink emit-signals=true sync=false max-buffers=-1 drop=true'.format(pipeline=pipeline)
-    print(pipeline)
-    gst = Gst.parse_launch(pipeline)
-    bus = gst.get_bus()
+    if videosrc.startswith('tcp://'):
+        parsed_url = urlparse(videosrc)
+        videosrc = 'tcpclientsrc port=%s host=%s' % (
+            parsed_url.port, parsed_url.hostname)
+        if container == 'mpegts':
+            videosrc += ' ! tsdemux'
+        elif container == 'sdp':
+            videosrc += ' ! sdpdemux'
+        else:
+            raise Exception('unknown container %s' % container)
+    elif videosrc.startswith('rtsp'):
+        videosrc = 'rtspsrc buffer-mode=0 location=%s protocols=tcp latency=0 is-live=false' % videosrc
+        if videoCodec == 'h264':
+            videosrc += ' ! rtph264depay ! h264parse'
 
-    def on_bus_message(bus, message):
-        t = str(message.type)
-        # print(t)
-        if t == str(Gst.MessageType.EOS):
-            finish()
-        elif t == str(Gst.MessageType.WARNING):
-            err, debug = message.parse_warning()
-            print('Warning: %s: %s\n' % (err, debug))
-        elif t == str(Gst.MessageType.ERROR):
-            err, debug = message.parse_error()
-            print('Error: %s: %s\n' % (err, debug))
-            finish()
+    videocaps = 'video/x-raw'
+    # if options and options.get('resize'):
+    #     videocaps = 'videoscale ! video/x-raw,width={width},height={height}'.format(width=options['resize']['width'], height=options['resize']['height'])
 
-    def stopGst():
-        bus.remove_signal_watch()
-        bus.disconnect(watchId)
-        gst.set_state(Gst.State.NULL)
+    format = options and options.get('format')
+    # I420 is a cheap way to get gray out of an h264 stream without color conversion.
+    if format == 'gray':
+        format = 'I420'
+        bands = 1
+    else:
+        format = 'RGB'
+        bands = 3
+    
+    videocaps += ',format={format}'.format(format=format)
 
-    def finish():
-        nonlocal hasFinished
-        hasFinished = True
-        callback = Callback(None)
-        callbackQueue.put(callback)
-        if not asyncFuture.done():
-            asyncFuture.set_result(None)
-        if not finished.done():
-            finished.set_result(None)
+    decoder = None
+    def setDecoderClearDefault(value: str):
+        nonlocal decoder
+        decoder = value
+        if decoder == 'Default':
+            decoder = None
 
-    watchId = bus.connect('message', on_bus_message)
-    bus.add_signal_watch()
+    setDecoderClearDefault(None)
 
-    finished = concurrent.futures.Future()
-    finished.add_done_callback(lambda _: threading.Thread(target=stopGst, name="StopGst").start())
-    hasFinished = False
+    if videoCodec == 'h264':
+        setDecoderClearDefault(h264Decoder)
 
-    appsink = gst.get_by_name('appsink')
-    callbackQueue = Queue()
-    asyncFuture = asyncio.Future()
+        if not decoder:
+            # hw acceleration is "safe" to use on mac, but not
+            # on other hosts where it may crash.
+            # defaults must be safe.
+            if platform.system() == 'Darwin':
+                decoder = 'vtdec_hw'
+            else:
+                decoder = 'avdec_h264'
+    else:
+        # decodebin may pick a hardware accelerated decoder, which isn't ideal
+        # so use a known software decoder for h264 and decodebin for anything else.
+        decoder = 'decodebin'
 
-    async def gen():
-        try:      
-            while True:
-                nonlocal asyncFuture
-                asyncFuture = asyncio.Future()
-                yieldFuture = asyncio.Future()
-                async def asyncCallback(sample):
-                    asyncFuture.set_result(sample)
-                    await yieldFuture
-                callbackQueue.put(Callback(asyncCallback))
-                sample = await asyncFuture
-                if not sample:
-                    yieldFuture.set_result(None)
-                    break
-                try:
-                    yield sample
-                finally:
-                    yieldFuture.set_result(None)
-        finally:
-            finish()
-            print('gstreamer finished')
+    videosrc += ' ! {decoder} ! queue leaky=downstream max-size-buffers=0 ! videoconvert ! {videocaps}'.format(decoder=decoder, videocaps=videocaps)
 
+    gst, gen = createPipelineIterator(videosrc)
+    async for gstsample in gen():
+        caps = gstsample.get_caps()
+        height = caps.get_structure(0).get_value('height')
+        width = caps.get_structure(0).get_value('width')
+        gst_buffer = gstsample.get_buffer()
+        result, info = gst_buffer.map(Gst.MapFlags.READ)
+        if not result:
+            continue
 
-    def on_new_sample(sink, preroll):
-        nonlocal hasFinished
-
-        sample = sink.emit('pull-preroll' if preroll else 'pull-sample')
-
-        callback: Callback = callbackQueue.get()
-        if not callback.callback or hasFinished:
-            hasFinished = True
-            if callback.callback:
-                asyncio.run_coroutine_threadsafe(callback.callback(None), loop = callback.loop)
-            return Gst.FlowReturn.OK
-
-        future = asyncio.run_coroutine_threadsafe(callback.callback(sample), loop = callback.loop)
         try:
-            future.result()
-        except:
-            pass
-        return Gst.FlowReturn.OK
-
-    appsink.connect('new-preroll', on_new_sample, True)
-    appsink.connect('new-sample', on_new_sample, False)
-
-    gst.set_state(Gst.State.PLAYING)
-    return gst, gen
-
-def mainThread():
-    async def asyncMain():
-        gst, gen = createPipelineIterator('rtspsrc location=rtsp://localhost:59668/18cc179a814fd5b3 ! rtph264depay ! h264parse ! vtdec_hw ! videoconvert ! video/x-raw')
-        i = 0
-        async for sample in gen():
-            print('sample')
-            i = i + 1
-            if i == 10:
-                break
-
-    loop = asyncio.new_event_loop()
-    asyncio.ensure_future(asyncMain(), loop = loop)
-    loop.run_forever()
-
-if __name__ == "__main__":
-    threading.Thread(target = mainThread).start()
-    mainLoop = GLib.MainLoop()
-    mainLoop.run()
+            if vipsimage.pyvips:
+                vips = vipsimage.new_from_memory(info.data, width, height, bands)
+                vipsImage = vipsimage.VipsImage(vips)
+                try:
+                    mo = await vipsimage.createVipsMediaObject(vipsImage)
+                    yield mo
+                finally:
+                    vipsImage.vipsImage = None
+                    vips.invalidate()
+            else:
+                pil = pilimage.new_from_memory(info.data, width, height, bands)
+                pilImage = pilimage.PILImage(pil)
+                try:
+                    mo = await pilimage.createPILMediaObject(pilImage)
+                    yield mo
+                finally:
+                    pilImage.pilImage = None
+                    pil.close()
+        finally:
+            gst_buffer.unmap(info)

plugins/python-codecs/src/libav.py

@@ -0,0 +1,60 @@
+import time
+from gst_generator import createPipelineIterator
+import scrypted_sdk
+from typing import Any
+import vipsimage
+import pilimage
+
+av = None
+try:
+    import av
+    av.logging.set_level(av.logging.PANIC) 
+except:
+    pass
+
+async def generateVideoFramesLibav(mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
+    ffmpegInput: scrypted_sdk.FFmpegInput = await scrypted_sdk.mediaManager.convertMediaObjectToJSON(mediaObject, scrypted_sdk.ScryptedMimeTypes.FFmpegInput.value)
+    videosrc = ffmpegInput.get('url')
+    container = av.open(videosrc)
+    # none of this stuff seems to work. might be libav being slow with rtsp.
+    # container.no_buffer = True
+    # container.gen_pts = False
+    # container.options['-analyzeduration'] = '0'
+    # container.options['-probesize'] = '500000'
+    stream = container.streams.video[0]
+    # stream.codec_context.thread_count = 1
+    # stream.codec_context.low_delay = True
+    # stream.codec_context.options['-analyzeduration'] = '0'
+    # stream.codec_context.options['-probesize'] = '500000'
+
+    start = 0
+    try:
+        for idx, frame in enumerate(container.decode(stream)):
+            now = time.time()
+            if not start:
+                start = now
+            elapsed = now - start
+            if (frame.time or 0) < elapsed - 0.500:
+                # print('too slow, skipping frame')
+                continue
+            # print(frame)
+            if vipsimage.pyvips:
+                vips = vipsimage.pyvips.Image.new_from_array(frame.to_ndarray(format='rgb24'))
+                vipsImage = vipsimage.VipsImage(vips)
+                try:
+                    mo = await vipsimage.createVipsMediaObject(vipsImage)
+                    yield mo
+                finally:
+                    vipsImage.vipsImage = None
+                    vips.invalidate()
+            else:
+                pil = frame.to_image()
+                pilImage = pilimage.PILImage(pil)
+                try:
+                    mo = await pilimage.createPILMediaObject(pilImage)
+                    yield mo
+                finally:
+                    pilImage.pilImage = None
+                    pil.close()
+    finally:
+        container.close()

plugins/python-codecs/src/main.py

@@ -1,165 +1,144 @@
-from gstreamer import createPipelineIterator
 import asyncio
-from util import optional_chain
 import scrypted_sdk
-from typing import Any
-from urllib.parse import urlparse
-import pyvips
-import threading
-import traceback
-import concurrent.futures
+from scrypted_sdk import Setting, SettingValue
+from typing import Any, List
+import gstreamer
+import libav
+import vipsimage
+import pilimage
 
+Gst = None
 try:
-    import gi
-    gi.require_version('Gst', '1.0')
-    gi.require_version('GstBase', '1.0')
-
     from gi.repository import Gst
 except:
     pass
 
-vipsExecutor = concurrent.futures.ThreadPoolExecutor(max_workers=2, thread_name_prefix="vips")
+av = None
+try:
+    import av
+except:
+    pass
 
-async def to_thread(f):
-    loop = asyncio.get_running_loop()
-    return await loop.run_in_executor(vipsExecutor, f)
+class LibavGenerator(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.VideoFrameGenerator):
+    async def generateVideoFrames(self, mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
+        worker = scrypted_sdk.fork()
+        forked: CodecFork = await worker.result
+        return await forked.generateVideoFramesLibav(mediaObject, options, filter)
 
-class VipsImage(scrypted_sdk.VideoFrame):
-    def __init__(self, vipsImage: pyvips.Image) -> None:
-        super().__init__()
-        self.vipsImage = vipsImage
-        self.width = vipsImage.width
-        self.height = vipsImage.height
-
-    async def toBuffer(self, options: scrypted_sdk.ImageOptions = None) -> bytearray:
-        vipsImage: VipsImage = await self.toVipsImage(options)
-
-        if not options or not options.get('format', None):
-            def format():
-                return memoryview(vipsImage.vipsImage.write_to_memory())
-            return await to_thread(format)
-        elif options['format'] == 'rgb':
-            def format():
-                if vipsImage.vipsImage.hasalpha():
-                    rgb = vipsImage.vipsImage.extract_band(0, vipsImage.vipsImage.bands - 1)
-                else:
-                    rgb = vipsImage.vipsImage
-                mem = memoryview(rgb.write_to_memory())
-                return mem
-            return await to_thread(format)
-
-        return await to_thread(lambda: vipsImage.vipsImage.write_to_buffer('.' + options['format']))
-
-    async def toVipsImage(self, options: scrypted_sdk.ImageOptions = None):
-       return await to_thread(lambda: toVipsImage(self, options))
-
-    async def toImage(self, options: scrypted_sdk.ImageOptions = None) -> Any:
-        if options and options.get('format', None):
-            raise Exception('format can only be used with toBuffer')
-        newVipsImage = await self.toVipsImage(options)
-        return await createVipsMediaObject(newVipsImage)
-
-def toVipsImage(vipsImageWrapper: VipsImage, options: scrypted_sdk.ImageOptions = None) -> VipsImage:
-    vipsImage = vipsImageWrapper.vipsImage
-    if not vipsImage:
-        raise Exception('Video Frame has been invalidated')
-    options = options or {}
-    crop = options.get('crop')
-    if crop:
-        vipsImage = vipsImage.crop(int(crop['left']), int(crop['top']), int(crop['width']), int(crop['height']))
-        
-    resize = options.get('resize')
-    if resize:
-        xscale = None
-        if resize.get('width'):
-            xscale = resize['width'] / vipsImage.width 
-            scale = xscale
-        yscale = None
-        if resize.get('height'):
-            yscale = resize['height'] / vipsImage.height
-            scale = yscale
-
-        if xscale and yscale:
-            scale = min(yscale, xscale)
-
-        xscale = xscale or yscale
-        yscale = yscale or xscale
-        vipsImage = vipsImage.resize(xscale, vscale=yscale, kernel='linear')
-
-    return VipsImage(vipsImage)
-
-async def createVipsMediaObject(image: VipsImage):
-    ret = await scrypted_sdk.mediaManager.createMediaObject(image, scrypted_sdk.ScryptedMimeTypes.Image.value, {
-        'width': image.width,
-        'height': image.height,
-        'toBuffer': lambda options = None: image.toBuffer(options),
-        'toImage': lambda options = None: image.toImage(options),
-    })
-    return ret
-
-class PythonCodecs(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.VideoFrameGenerator):
+class GstreamerGenerator(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.VideoFrameGenerator, scrypted_sdk.Settings):
+    async def generateVideoFrames(self, mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
+        worker = scrypted_sdk.fork()
+        forked: CodecFork = await worker.result
+        return await forked.generateVideoFramesGstreamer(mediaObject, options, filter, self.storage.getItem('h264Decoder'))
+    
+    async def getSettings(self) -> List[Setting]:
+        return [
+            {
+                'key': 'h264Decoder',
+                'title': 'H264 Decoder',
+                'description': 'The Gstreamer pipeline to use to decode H264 video.',
+                'value': self.storage.getItem('h264Decoder') or 'Default',
+                'choices': [
+                    'Default',
+                    'decodebin',
+                    'vtdec_hw',
+                    'nvh264dec',
+                    'vaapih264dec',
+                ],
+                'combobox': True,
+            }
+        ]
+    
+    async def putSetting(self, key: str, value: SettingValue) -> None:
+        self.storage.setItem(key, value)
+        await scrypted_sdk.deviceManager.onDeviceEvent(self.nativeId, scrypted_sdk.ScryptedInterface.Settings.value, None)
+    
+class PythonCodecs(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.DeviceProvider):
     def __init__(self, nativeId = None):
         super().__init__(nativeId)
 
-    async def generateVideoFrames(self, mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
-        worker = scrypted_sdk.fork()
-        forked = await worker.result
-        return await forked.generateVideoFrames(mediaObject, options, filter)
+        asyncio.ensure_future(self.initialize())
+
+    async def initialize(self):
+        manifest: scrypted_sdk.DeviceManifest = {
+            'devices': [],
+        }
+        if Gst:
+            gstDevice: scrypted_sdk.Device = {
+                'name': 'Gstreamer',
+                'nativeId': 'gstreamer',
+                'interfaces': [
+                    scrypted_sdk.ScryptedInterface.VideoFrameGenerator.value,
+                    scrypted_sdk.ScryptedInterface.Settings.value,
+                ],
+                'type': scrypted_sdk.ScryptedDeviceType.API.value,
+            }
+            manifest['devices'].append(gstDevice)
+
+        if av:
+            avDevice: scrypted_sdk.Device = {
+                'name': 'Libav',
+                'nativeId': 'libav',
+                'interfaces': [
+                    scrypted_sdk.ScryptedInterface.VideoFrameGenerator.value,
+                ],
+                'type': scrypted_sdk.ScryptedDeviceType.API.value,
+            }
+            manifest['devices'].append(avDevice)
+
+        manifest['devices'].append({
+            'name': 'Image Reader',
+            'type': scrypted_sdk.ScryptedDeviceType.Builtin.value,
+            'nativeId': 'reader',
+            'interfaces': [
+                scrypted_sdk.ScryptedInterface.BufferConverter.value,
+            ]
+        })
+
+        manifest['devices'].append({
+            'name': 'Image Writer',
+            'type': scrypted_sdk.ScryptedDeviceType.Builtin.value,
+            'nativeId': 'writer',
+            'interfaces': [
+                scrypted_sdk.ScryptedInterface.BufferConverter.value,
+            ]
+        })
+
+        await scrypted_sdk.deviceManager.onDevicesChanged(manifest)
+
+    def getDevice(self, nativeId: str) -> Any:
+        if nativeId == 'gstreamer':
+            return GstreamerGenerator('gstreamer')
+        if nativeId == 'libav':
+            return LibavGenerator('libav')
+        
+        if vipsimage.pyvips:
+            if nativeId == 'reader':
+                return vipsimage.ImageReader('reader')
+            if nativeId == 'writer':
+                return vipsimage.ImageWriter('writer')
+        else:
+            if nativeId == 'reader':
+                return pilimage.ImageReader('reader')
+            if nativeId == 'writer':
+                return pilimage.ImageWriter('writer')
 
 def create_scrypted_plugin():
     return PythonCodecs()
 
-
-async def generateVideoFrames(mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
-    ffmpegInput: scrypted_sdk.FFmpegInput = await scrypted_sdk.mediaManager.convertMediaObjectToJSON(mediaObject, scrypted_sdk.ScryptedMimeTypes.FFmpegInput.value)
-    container = ffmpegInput.get('container', None)
-    videosrc = ffmpegInput.get('url')
-    videoCodec = optional_chain(ffmpegInput, 'mediaStreamOptions', 'video', 'codec')
-
-    if videosrc.startswith('tcp://'):
-        parsed_url = urlparse(videosrc)
-        videosrc = 'tcpclientsrc port=%s host=%s' % (
-            parsed_url.port, parsed_url.hostname)
-        if container == 'mpegts':
-            videosrc += ' ! tsdemux'
-        elif container == 'sdp':
-            videosrc += ' ! sdpdemux'
-        else:
-            raise Exception('unknown container %s' % container)
-    elif videosrc.startswith('rtsp'):
-        videosrc = 'rtspsrc buffer-mode=0 location=%s protocols=tcp latency=0 is-live=false' % videosrc
-        if videoCodec == 'h264':
-            videosrc += ' ! rtph264depay ! h264parse'
-
-    videosrc += ' ! decodebin ! queue leaky=downstream max-size-buffers=0 ! videoconvert ! video/x-raw,format=RGB'
-
-    gst, gen = createPipelineIterator(videosrc)
-    async for gstsample in gen():
-        caps = gstsample.get_caps()
-        height = caps.get_structure(0).get_value('height')
-        width = caps.get_structure(0).get_value('width')
-        gst_buffer = gstsample.get_buffer()
-        result, info = gst_buffer.map(Gst.MapFlags.READ)
-        if not result:
-            continue
-
-        try:
-            # pyvips.Image.new_from_memory(info.data, width, height, 3, pyvips.BandFormat.UCHAR)
-            vips = pyvips.Image.new_from_memory(info.data, width, height, 3, pyvips.BandFormat.UCHAR)
-            vipsImage = VipsImage(vips)
-            try:
-                mo = await createVipsMediaObject(VipsImage(vips))
-                yield mo
-            finally:
-                vipsImage.vipsImage.invalidate()
-                vipsImage.vipsImage = None
-        finally:
-            gst_buffer.unmap(info)
-
 class CodecFork:
-    async def generateVideoFrames(self, mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
+    async def generateVideoFramesGstreamer(self, mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None, h264Decoder: str = None) -> scrypted_sdk.VideoFrame:
         try:
-            async for data in generateVideoFrames(mediaObject, options, filter):
+            async for data in gstreamer.generateVideoFramesGstreamer(mediaObject, options, filter, h264Decoder):
+                yield data
+        finally:
+            import os
+            os._exit(os.EX_OK)
+            pass
+
+    async def generateVideoFramesLibav(self, mediaObject: scrypted_sdk.MediaObject, options: scrypted_sdk.VideoFrameGeneratorOptions = None, filter: Any = None) -> scrypted_sdk.VideoFrame:
+        try:
+            async for data in libav.generateVideoFramesLibav(mediaObject, options, filter):
                 yield data
         finally:
             import os

plugins/python-codecs/src/pilimage.py

@@ -0,0 +1,114 @@
+import scrypted_sdk
+from typing import Any
+from thread import to_thread
+import io
+
+try:
+    from PIL import Image
+except:
+    # Image = None
+    pass
+
+class PILImage(scrypted_sdk.VideoFrame):
+    def __init__(self, pilImage: Image.Image) -> None:
+        super().__init__()
+        self.pilImage = pilImage
+        self.width = pilImage.width
+        self.height = pilImage.height
+
+    async def toBuffer(self, options: scrypted_sdk.ImageOptions = None) -> bytearray:
+        pilImage: PILImage = await self.toPILImage(options)
+
+        if not options or not options.get('format', None):
+            def format():
+                bytesArray = io.BytesIO()
+                pilImage.pilImage.save(bytesArray, format='JPEG')
+                return bytesArray.getvalue()
+            return await to_thread(format)
+        elif options['format'] == 'rgb':
+            def format():
+                rgb = pilImage.pilImage
+                if rgb.format == 'RGBA':
+                    rgb = rgb.convert('RGB')
+                return rgb.tobytes()
+            return await to_thread(format)
+
+        return await to_thread(lambda: pilImage.pilImage.write_to_buffer('.' + options['format']))
+
+    async def toPILImage(self, options: scrypted_sdk.ImageOptions = None):
+       return await to_thread(lambda: toPILImage(self, options))
+
+    async def toImage(self, options: scrypted_sdk.ImageOptions = None) -> Any:
+        if options and options.get('format', None):
+            raise Exception('format can only be used with toBuffer')
+        newPILImage = await self.toPILImage(options)
+        return await createPILMediaObject(newPILImage)
+
+def toPILImage(pilImageWrapper: PILImage, options: scrypted_sdk.ImageOptions = None) -> PILImage:
+    pilImage = pilImageWrapper.pilImage
+    if not pilImage:
+        raise Exception('Video Frame has been invalidated')
+    options = options or {}
+    crop = options.get('crop')
+    if crop:
+        pilImage = pilImage.crop((int(crop['left']), int(crop['top']), int(crop['left']) + int(crop['width']), int(crop['top']) + int(crop['height'])))
+        
+    resize = options.get('resize')
+    if resize:
+        width = resize.get('width')
+        if width:
+            xscale = resize['width'] / pilImage.width 
+            height = pilImage.height * xscale
+
+        height = resize.get('height')
+        if height:
+            yscale = resize['height'] / pilImage.height
+            if not width:
+                width = pilImage.width * yscale
+
+        pilImage = pilImage.resize((width, height), resample=Image.Resampling.BILINEAR)
+
+    return PILImage(pilImage)
+
+async def createPILMediaObject(image: PILImage):
+    ret = await scrypted_sdk.mediaManager.createMediaObject(image, scrypted_sdk.ScryptedMimeTypes.Image.value, {
+        'format': None,
+        'width': image.width,
+        'height': image.height,
+        'toBuffer': lambda options = None: image.toBuffer(options),
+        'toImage': lambda options = None: image.toImage(options),
+    })
+    return ret
+
+class ImageReader(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.BufferConverter):
+    def __init__(self, nativeId: str):
+        super().__init__(nativeId)
+
+        self.fromMimeType = 'image/*'
+        self.toMimeType = scrypted_sdk.ScryptedMimeTypes.Image.value
+
+    async def convert(self, data: Any, fromMimeType: str, toMimeType: str, options: scrypted_sdk.MediaObjectOptions = None) -> Any:
+        pil = Image.open(io.BytesIO(data))
+        return await createPILMediaObject(PILImage(pil))
+
+class ImageWriter(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.BufferConverter):
+    def __init__(self, nativeId: str):
+        super().__init__(nativeId)
+
+        self.fromMimeType = scrypted_sdk.ScryptedMimeTypes.Image.value
+        self.toMimeType = 'image/*'
+
+    async def convert(self, data: scrypted_sdk.VideoFrame, fromMimeType: str, toMimeType: str, options: scrypted_sdk.MediaObjectOptions = None) -> Any:
+        return await data.toBuffer({
+            format: 'jpg',
+        })
+
+def new_from_memory(data, width: int, height: int, bands: int):
+    data = bytes(data)
+    if bands == 4:
+        return Image.frombuffer('RGBA', (width, height), data)
+    if bands == 3:
+        return Image.frombuffer('RGB', (width, height), data)
+    if bands == 1:
+        return Image.frombuffer('L', (width, height), data)
+    raise Exception('cant handle bands')

plugins/python-codecs/src/requirements.txt

@@ -2,4 +2,9 @@
 PyGObject>=3.30.4; sys_platform != 'win32'
 # libav doesnt work on arm7
 av>=10.0.0; sys_platform != 'linux' or platform_machine == 'x86_64' or platform_machine == 'aarch64'
-pyvips
+pyvips; sys_platform != 'win32'
+
+# in case pyvips fails to load, use a pillow fallback.
+# pillow for anything not intel linux, pillow-simd is available on x64 linux
+Pillow>=5.4.1; sys_platform != 'linux' or platform_machine != 'x86_64'
+pillow-simd; sys_platform == 'linux' and platform_machine == 'x86_64'

plugins/python-codecs/src/thread.py

@@ -0,0 +1,10 @@
+import asyncio
+from typing import Any
+import concurrent.futures
+
+# vips is already multithreaded, but needs to be kicked off the python asyncio thread.
+toThreadExecutor = concurrent.futures.ThreadPoolExecutor(max_workers=2, thread_name_prefix="image")
+
+async def to_thread(f):
+    loop = asyncio.get_running_loop()
+    return await loop.run_in_executor(toThreadExecutor, f)

plugins/python-codecs/src/vipsimage.py

@@ -0,0 +1,110 @@
+import scrypted_sdk
+from typing import Any
+try:
+    import pyvips
+    from pyvips import Image
+except:
+    Image = None
+    pyvips = None
+    pass
+from thread import to_thread
+
+class VipsImage(scrypted_sdk.VideoFrame):
+    def __init__(self, vipsImage: Image) -> None:
+        super().__init__()
+        self.vipsImage = vipsImage
+        self.width = vipsImage.width
+        self.height = vipsImage.height
+
+    async def toBuffer(self, options: scrypted_sdk.ImageOptions = None) -> bytearray:
+        vipsImage: VipsImage = await self.toVipsImage(options)
+
+        if not options or not options.get('format', None):
+            def format():
+                return memoryview(vipsImage.vipsImage.write_to_memory())
+            return await to_thread(format)
+        elif options['format'] == 'rgb':
+            def format():
+                if vipsImage.vipsImage.hasalpha():
+                    rgb = vipsImage.vipsImage.extract_band(0, n=vipsImage.vipsImage.bands - 1)
+                else:
+                    rgb = vipsImage.vipsImage
+                mem = memoryview(rgb.write_to_memory())
+                return mem
+            return await to_thread(format)
+
+        return await to_thread(lambda: vipsImage.vipsImage.write_to_buffer('.' + options['format']))
+
+    async def toVipsImage(self, options: scrypted_sdk.ImageOptions = None):
+       return await to_thread(lambda: toVipsImage(self, options))
+
+    async def toImage(self, options: scrypted_sdk.ImageOptions = None) -> Any:
+        if options and options.get('format', None):
+            raise Exception('format can only be used with toBuffer')
+        newVipsImage = await self.toVipsImage(options)
+        return await createVipsMediaObject(newVipsImage)
+
+def toVipsImage(vipsImageWrapper: VipsImage, options: scrypted_sdk.ImageOptions = None) -> VipsImage:
+    vipsImage = vipsImageWrapper.vipsImage
+    if not vipsImage:
+        raise Exception('Video Frame has been invalidated')
+    options = options or {}
+    crop = options.get('crop')
+    if crop:
+        vipsImage = vipsImage.crop(int(crop['left']), int(crop['top']), int(crop['width']), int(crop['height']))
+        
+    resize = options.get('resize')
+    if resize:
+        xscale = None
+        if resize.get('width'):
+            xscale = resize['width'] / vipsImage.width 
+            scale = xscale
+        yscale = None
+        if resize.get('height'):
+            yscale = resize['height'] / vipsImage.height
+            scale = yscale
+
+        if xscale and yscale:
+            scale = min(yscale, xscale)
+
+        xscale = xscale or yscale
+        yscale = yscale or xscale
+        vipsImage = vipsImage.resize(xscale, vscale=yscale, kernel='linear')
+
+    return VipsImage(vipsImage)
+
+async def createVipsMediaObject(image: VipsImage):
+    ret = await scrypted_sdk.mediaManager.createMediaObject(image, scrypted_sdk.ScryptedMimeTypes.Image.value, {
+        'format': None,
+        'width': image.width,
+        'height': image.height,
+        'toBuffer': lambda options = None: image.toBuffer(options),
+        'toImage': lambda options = None: image.toImage(options),
+    })
+    return ret
+
+class ImageReader(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.BufferConverter):
+    def __init__(self, nativeId: str):
+        super().__init__(nativeId)
+
+        self.fromMimeType = 'image/*'
+        self.toMimeType = scrypted_sdk.ScryptedMimeTypes.Image.value
+
+    async def convert(self, data: Any, fromMimeType: str, toMimeType: str, options: scrypted_sdk.MediaObjectOptions = None) -> Any:
+        vips = Image.new_from_buffer(data, '')
+        return await createVipsMediaObject(VipsImage(vips))
+
+class ImageWriter(scrypted_sdk.ScryptedDeviceBase, scrypted_sdk.BufferConverter):
+    def __init__(self, nativeId: str):
+        super().__init__(nativeId)
+
+        self.fromMimeType = scrypted_sdk.ScryptedMimeTypes.Image.value
+        self.toMimeType = 'image/*'
+
+    async def convert(self, data: scrypted_sdk.VideoFrame, fromMimeType: str, toMimeType: str, options: scrypted_sdk.MediaObjectOptions = None) -> Any:
+        return await data.toBuffer({
+            format: 'jpg',
+        })
+
+def new_from_memory(data, width: int, height: int, bands: int):
+    return Image.new_from_memory(data, width, height, bands, pyvips.BandFormat.UCHAR)

plugins/remote/package-lock.json

@@ -19,23 +19,23 @@
       },
       "../../packages/client": {
          "name": "@scrypted/client",
-         "version": "1.1.39",
+         "version": "1.1.43",
          "license": "ISC",
          "dependencies": {
-            "@scrypted/types": "^0.2.65",
+            "@scrypted/types": "^0.2.76",
             "axios": "^0.25.0",
-            "engine.io-client": "^6.2.2",
+            "engine.io-client": "^6.4.0",
             "rimraf": "^3.0.2"
          },
          "devDependencies": {
             "@types/ip": "^1.1.0",
-            "@types/node": "^17.0.17",
-            "typescript": "^4.7.4"
+            "@types/node": "^18.14.2",
+            "typescript": "^4.9.5"
          }
       },
       "../../sdk": {
          "name": "@scrypted/sdk",
-         "version": "0.2.70",
+         "version": "0.2.85",
          "license": "ISC",
          "dependencies": {
             "@babel/preset-typescript": "^7.18.6",

plugins/remote/src/main.ts

@@ -55,13 +55,17 @@ class ScryptedRemoteInstance extends ScryptedDeviceBase implements DeviceProvide
         },
     });
 
+    fromMimeType: string = ""
+    toMimeType: string = ""
+
     constructor(nativeId: string) {
         super(nativeId);
         this.clearTryDiscoverDevices();
 
 
         this.fromMimeType = 'x-scrypted-remote/x-media-object-' + this.id;
-        this.toMimeType = ScryptedMimeTypes.MediaObject;
+        this.toMimeType = '*';
+        sdk.mediaManager.addConverter(this);
     }
 
 
@@ -193,9 +197,11 @@ class ScryptedRemoteInstance extends ScryptedDeviceBase implements DeviceProvide
         });
 
         this.client.onClose = () => {
-            this.console.log('client killed')
+            this.console.log('client killed, reconnecting in 60s');
+            setTimeout(async () => await this.clearTryDiscoverDevices(), 60000);
         }
 
+        /* bjia56: since the MediaObject conversion isn't completely implemented, disable this for now
         const { rpcPeer } = this.client;
         const map = new WeakMap<RemoteMediaObject, MediaObject>();
         rpcPeer.nameDeserializerMap.set('MediaObject', {
@@ -215,11 +221,13 @@ class ScryptedRemoteInstance extends ScryptedDeviceBase implements DeviceProvide
                 return rmo;
             },
         });
+        */
+
         this.console.log(`Connected to remote Scrypted server. Remote server version: ${this.client.serverVersion}`)
     }
 
     async convert(data: RemoteMediaObject, fromMimeType: string, toMimeType: string, options?: MediaObjectOptions): Promise<any> {
-        if (toMimeType === 'x-scrypted-remote/x-media-object')
+        if (toMimeType.startsWith('x-scrypted-remote/x-media-object'))
             return data;
         let ret = await this.client.mediaManager.convertMediaObject(data, toMimeType);
         if (toMimeType === ScryptedMimeTypes.FFmpegInput) {
@@ -298,9 +306,9 @@ class ScryptedRemoteInstance extends ScryptedDeviceBase implements DeviceProvide
 
         // first register the top level devices, then register the remaining
         // devices by provider id
-        await deviceManager.onDevicesChanged(<DeviceManifest>{
-            devices: providerDeviceMap.get(this.nativeId),
-            providerNativeId: this.nativeId,
+        // top level devices are discovered one by one to avoid clobbering
+        providerDeviceMap.get(this.nativeId).map(async device => {
+            await deviceManager.onDeviceDiscovered(device);
         });
         for (let [providerNativeId, devices] of providerDeviceMap) {
             await deviceManager.onDevicesChanged(<DeviceManifest>{

plugins/reolink/package-lock.json

@@ -1,12 +1,12 @@
 {
    "name": "@scrypted/reolink",
-   "version": "0.0.16",
+   "version": "0.0.17",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/reolink",
-         "version": "0.0.16",
+         "version": "0.0.17",
          "license": "Apache",
          "dependencies": {
             "@koush/axios-digest-auth": "^0.8.5",

plugins/reolink/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/reolink",
-   "version": "0.0.16",
+   "version": "0.0.17",
    "description": "Reolink Plugin for Scrypted",
    "author": "Scrypted",
    "license": "Apache",

plugins/reolink/src/main.ts

@@ -196,7 +196,7 @@ class ReolinkProider extends RtspProvider {
                 throw e;
             }
         }
-        settings.newCamera ||= 'Hikvision Camera';
+        settings.newCamera ||= 'Reolink Camera';
 
         nativeId = await super.createDevice(settings, nativeId);
 

plugins/ring/README.md

@@ -9,7 +9,9 @@ Do not enable prebuffer on Ring cameras and doorbells.
   * The persistent live stream will drain the battery faster than it can charge.
   * The persistent live stream will also count against ISP bandwidth limits.
 
-## Supported Cameras
+## Supported Devices
+
+### Cameras
 - Ring Video Doorbell Wired, Pro, Pro 2, 4, 3, 2nd Gen
 - Ring Floodlight Cam Wired Plus
 - Ring Floodlight Cam Wired Pro
@@ -17,6 +19,22 @@ Do not enable prebuffer on Ring cameras and doorbells.
 - Ring Indoor Cam
 - Ring Stick-Up Cam (Wired and Battery)
 
+### Other Devices
+- Security Panel
+- Location Modes
+- Contact Sensor
+- Retrofit Alarm Zones
+- Tilt Sensor
+- Glassbreak Sensor
+- Motion Sensor
+- Outdoor Motion Sensor
+- Flood / Freeze Sensor
+- Water Sensor
+- Mailbox Sensor
+- Smart Locks
+- Ring Smart Lights (Flood/Path/Step/Spot Lights, Bulbs, Transformer)
+- Lights, Switches & Outlets
+
 ## Problems and Solutions
 
 I can see artifacts in HKSV recordings

plugins/ring/package-lock.json

@@ -1,17 +1,17 @@
 {
    "name": "@scrypted/ring",
-   "version": "0.0.98",
+   "version": "0.0.106",
    "lockfileVersion": 3,
    "requires": true,
    "packages": {
       "": {
          "name": "@scrypted/ring",
-         "version": "0.0.98",
+         "version": "0.0.106",
          "dependencies": {
             "@koush/ring-client-api": "file:../../external/ring-client-api",
             "@scrypted/common": "file:../../common",
             "@scrypted/sdk": "file:../../sdk",
-            "@types/node": "^18.14.5",
+            "@types/node": "^18.15.3",
             "axios": "^1.3.4",
             "rxjs": "^7.8.0"
          },
@@ -49,7 +49,7 @@
       },
       "../../sdk": {
          "name": "@scrypted/sdk",
-         "version": "0.2.82",
+         "version": "0.2.85",
          "license": "ISC",
          "dependencies": {
             "@babel/preset-typescript": "^7.18.6",
@@ -148,9 +148,9 @@
          }
       },
       "node_modules/@types/node": {
-         "version": "18.14.5",
-         "resolved": "https://registry.npmjs.org/@types/node/-/node-18.14.5.tgz",
-         "integrity": "sha512-CRT4tMK/DHYhw1fcCEBwME9CSaZNclxfzVMe7GsO6ULSwsttbj70wSiX6rZdIjGblu93sTJxLdhNIT85KKI7Qw=="
+         "version": "18.15.3",
+         "resolved": "https://registry.npmjs.org/@types/node/-/node-18.15.3.tgz",
+         "integrity": "sha512-p6ua9zBxz5otCmbpb5D3U4B5Nanw6Pk3PPyX05xnxbB/fRv71N7CPmORg7uAD5P70T0xmx1pzAx/FUfa5X+3cw=="
       },
       "node_modules/@types/responselike": {
          "version": "1.0.0",

plugins/ring/package.json

@@ -36,7 +36,7 @@
       "@koush/ring-client-api": "file:../../external/ring-client-api",
       "@scrypted/common": "file:../../common",
       "@scrypted/sdk": "file:../../sdk",
-      "@types/node": "^18.14.5",
+      "@types/node": "^18.15.3",
       "axios": "^1.3.4",
       "rxjs": "^7.8.0"
    },
@@ -44,5 +44,5 @@
       "got": "11.8.6",
       "socket.io-client": "^2.5.0"
    },
-   "version": "0.0.98"
+   "version": "0.0.106"
 }