videoanalysis: make sharp optional

koush · Mar 29, 2023 · 4529872 · 4529872
1 parent fa86c31
commit 4529872
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 10 deletions.
diff --git a/plugins/objectdetector/package-lock.json b/plugins/objectdetector/package-lock.json
diff --git a/plugins/objectdetector/package.json b/plugins/objectdetector/package.json
@@ -1,6 +1,6 @@
 {
    "name": "@scrypted/objectdetector",
-   "version": "0.0.119",
+   "version": "0.0.120",
    "description": "Scrypted Video Analysis Plugin. Installed alongside a detection service like OpenCV or TensorFlow.",
    "author": "Scrypted",
    "license": "Apache-2.0",

diff --git a/plugins/objectdetector/src/ffmpeg-videoframes.ts b/plugins/objectdetector/src/ffmpeg-videoframes.ts
@@ -1,12 +1,32 @@
 import { Deferred } from "@scrypted/common/src/deferred";
+import { addVideoFilterArguments } from "@scrypted/common/src/ffmpeg-helpers";
 import { ffmpegLogInitialOutput, safeKillFFmpeg, safePrintFFmpegArguments } from "@scrypted/common/src/media-helpers";
 import { readLength, readLine } from "@scrypted/common/src/read-stream";
-import { addVideoFilterArguments } from "@scrypted/common/src/ffmpeg-helpers";
 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 type sharp from 'sharp';
 import { Readable } from 'stream';
 
+export let sharpLib: (input?:
+    | Buffer
+    | Uint8Array
+    | Uint8ClampedArray
+    | Int8Array
+    | Uint16Array
+    | Int16Array
+    | Uint32Array
+    | Int32Array
+    | Float32Array
+    | Float64Array
+    | string,
+    options?: sharp.SharpOptions) => sharp.Sharp;
+try {
+    sharpLib = require('sharp');
+}
+catch (e) {
+    console.warn('Sharp failed to load. FFmpeg Frame Generator will not function properly.')
+}
+
 async function createVipsMediaObject(image: VipsImage): Promise<VideoFrame & MediaObject> {
     const ret = await sdk.mediaManager.createMediaObject(image, ScryptedMimeTypes.Image, {
         format: null,
@@ -76,7 +96,20 @@ class VipsImage implements Image {
             resolveWithObject: true,
         });
 
-        const newImage = sharp(data, {
+        const sharpLib = require('sharp') as (input?:
+            | Buffer
+            | Uint8Array
+            | Uint8ClampedArray
+            | Int8Array
+            | Uint16Array
+            | Int16Array
+            | Uint32Array
+            | Int32Array
+            | Float32Array
+            | Float64Array
+            | string,
+            options?) => sharp.Sharp;
+        const newImage = sharpLib(data, {
             raw: info,
         });
 
@@ -177,7 +210,7 @@ export class FFmpegVideoFrameGenerator extends ScryptedDeviceBase implements Vid
                 const raw = await frameDeferred.promise;
                 const { width, height, data } = raw;
 
-                const image = sharp(data, {
+                const image = sharpLib(data, {
                     raw: {
                         width,
                         height,

diff --git a/plugins/objectdetector/src/main.ts b/plugins/objectdetector/src/main.ts
@@ -4,7 +4,7 @@ import crypto from 'crypto';
 import { AutoenableMixinProvider } from "../../../common/src/autoenable-mixin-provider";
 import { SettingsMixinDeviceBase } from "../../../common/src/settings-mixin";
 import { DenoisedDetectionState } from './denoise';
-import { FFmpegVideoFrameGenerator } from './ffmpeg-videoframes';
+import { FFmpegVideoFrameGenerator, sharpLib } from './ffmpeg-videoframes';
 import { serverSupportsMixinEventMasking } from './server-version';
 import { sleep } from './sleep';
 import { getAllDevices, safeParseJson } from './util';
@@ -820,9 +820,9 @@ class ObjectDetectionPlugin extends AutoenableMixinProvider implements Settings,
           {
             name: 'FFmpeg Frame Generator',
             type: ScryptedDeviceType.Builtin,
-            interfaces: [
+            interfaces: sharpLib ? [
               ScryptedInterface.VideoFrameGenerator,
-            ],
+            ] : [],
             nativeId: 'ffmpeg',
           }
         ]