Files
scrypted/plugins/objectdetector/src/main.ts

1228 lines
42 KiB
TypeScript

import { Deferred } from '@scrypted/common/src/deferred';
import { sleep } from '@scrypted/common/src/sleep';
import sdk, { Camera, DeviceCreator, DeviceCreatorSettings, DeviceProvider, DeviceState, EventListenerRegister, MediaObject, MediaStreamDestination, MixinDeviceBase, MixinProvider, MotionSensor, ObjectDetection, ObjectDetectionModel, ObjectDetectionTypes, ObjectDetectionZone, ObjectDetector, ObjectsDetected, Point, ScryptedDevice, ScryptedDeviceType, ScryptedInterface, ScryptedNativeId, Setting, SettingValue, Settings, VideoCamera, VideoFrame, VideoFrameGenerator, WritableDeviceState } from '@scrypted/sdk';
import { StorageSettings } from '@scrypted/sdk/storage-settings';
import crypto from 'crypto';
import { AutoenableMixinProvider } from "../../../common/src/autoenable-mixin-provider";
import { SettingsMixinDeviceBase } from "../../../common/src/settings-mixin";
import { CpuTimer } from './cpu-timer';
import { FFmpegVideoFrameGenerator } from './ffmpeg-videoframes';
import { insidePolygon, normalizeBox, polygonOverlap } from './polygon';
import { SMART_MOTIONSENSOR_PREFIX, SmartMotionSensor, createObjectDetectorStorageSetting } from './smart-motionsensor';
import { getAllDevices, safeParseJson } from './util';
const { systemManager } = sdk;
const defaultPostMotionAnalysisDuration = 20;
const defaultMotionDuration = 30;
const BUILTIN_MOTION_SENSOR_ASSIST = 'Assist';
const BUILTIN_MOTION_SENSOR_REPLACE = 'Replace';
const objectDetectionPrefix = `${ScryptedInterface.ObjectDetection}:`;
type ClipPath = Point[];
type Zones = { [zone: string]: ClipPath };
interface ZoneInfo {
exclusion?: boolean;
filterMode?: 'include' | 'exclude' | 'observe';
type?: 'Intersect' | 'Contain';
classes?: string[];
scoreThreshold?: number;
secondScoreThreshold?: number;
}
type ZoneInfos = { [zone: string]: ZoneInfo };
class ObjectDetectionMixin extends SettingsMixinDeviceBase<VideoCamera & Camera & MotionSensor & ObjectDetector> implements ObjectDetector, Settings {
motionListener: EventListenerRegister;
motionMixinListener: EventListenerRegister;
detections = new Map<string, MediaObject>();
cameraDevice: ScryptedDevice & Camera & VideoCamera & MotionSensor & ObjectDetector;
storageSettings = new StorageSettings(this, {
zones: {
title: 'Zones',
type: 'string',
description: 'Enter the name of a new zone or delete an existing zone.',
multiple: true,
combobox: true,
choices: [],
},
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}.`,
choices: [
'Default',
BUILTIN_MOTION_SENSOR_ASSIST,
BUILTIN_MOTION_SENSOR_REPLACE,
],
defaultValue: "Default",
onPut: () => {
this.endObjectDetection();
this.maybeStartDetection();
}
},
postMotionAnalysisDuration: {
title: 'Post Motion Analysis Duration',
subgroup: 'Advanced',
description: 'The duration in seconds to analyze video after motion ends.',
type: 'number',
defaultValue: defaultPostMotionAnalysisDuration,
},
motionDuration: {
title: 'Motion Duration',
description: 'The duration in seconds to wait to reset the motion sensor.',
type: 'number',
defaultValue: defaultMotionDuration,
},
newPipeline: {
subgroup: 'Advanced',
title: 'Decoder',
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),
];
return {
choices,
}
},
onPut: () => {
this.endObjectDetection();
this.maybeStartDetection();
},
defaultValue: 'Default',
},
});
motionTimeout: NodeJS.Timeout;
detectionIntervalTimeout: NodeJS.Timeout;
zones = this.getZones();
zoneInfos = this.getZoneInfos();
detectionStartTime: number;
analyzeStop: number;
detectorSignal = new Deferred<void>().resolve();
released = false;
// settings: Setting[];
get detectorRunning() {
return !this.detectorSignal.finished;
}
constructor(public plugin: ObjectDetectionPlugin, mixinDevice: VideoCamera & Camera & MotionSensor & ObjectDetector & Settings, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: WritableDeviceState, providerNativeId: string, public objectDetection: ObjectDetection & ScryptedDevice, public model: ObjectDetectionModel, group: string, public hasMotionType: boolean) {
super({
mixinDevice, mixinDeviceState,
mixinProviderNativeId: providerNativeId,
mixinDeviceInterfaces,
group,
groupKey: "objectdetectionplugin:" + objectDetection.id,
mixinStorageSuffix: objectDetection.id,
});
this.cameraDevice = systemManager.getDeviceById<Camera & VideoCamera & MotionSensor & ObjectDetector>(this.id);
this.bindObjectDetection();
this.register();
// ensure motion sensors stay alive. plugin will manage object detection throttling.
if (this.hasMotionType) {
this.detectionIntervalTimeout = setInterval(async () => {
if (this.released)
return;
this.maybeStartDetection();
}, 60000);
}
this.storageSettings.settings.zones.mapGet = () => Object.keys(this.zones);
this.storageSettings.settings.zones.onGet = async () => {
return {
group,
choices: Object.keys(this.zones),
}
}
}
clearMotionTimeout() {
clearTimeout(this.motionTimeout);
this.motionTimeout = undefined;
}
resetMotionTimeout() {
this.clearMotionTimeout();
this.motionTimeout = setTimeout(() => {
this.console.log('Motion timed out.');
this.motionDetected = false;
// if (this.motionSensorSupplementation === BUILTIN_MOTION_SENSOR_ASSIST) {
// this.console.log(`${this.objectDetection.name} timed out confirming motion, stopping video detection.`)
// this.endObjectDetection();
// }
}, this.storageSettings.values.motionDuration * 1000);
}
getCurrentSettings() {
const settings = this.model.settings;
if (!settings)
return { id : this.id };
const ret: { [key: string]: any } = {};
for (const setting of settings) {
let value: any;
if (setting.multiple) {
value = safeParseJson(this.storage.getItem(setting.key));
if (!value?.length)
value = undefined;
}
else {
value = this.storage.getItem(setting.key);
}
value ||= setting.value;
ret[setting.key] = value;
}
if (this.hasMotionType)
ret['motionAsObjects'] = true;
return {
...ret,
id: this.id,
};
}
maybeStartDetection() {
if (!this.hasMotionType) {
// object detection may be restarted if there are slots available.
if (this.cameraDevice.motionDetected && this.plugin.canStartObjectDetection(this)) {
this.startPipelineAnalysis();
return true;
}
return;
}
// motion sensor should only be started when in replace mode
if (this.motionSensorSupplementation === BUILTIN_MOTION_SENSOR_REPLACE)
this.startPipelineAnalysis();
}
endObjectDetection() {
this.detectorSignal.resolve();
}
bindObjectDetection() {
if (this.hasMotionType)
this.motionDetected = false;
this.endObjectDetection();
this.maybeStartDetection();
}
async register() {
if (!this.hasMotionType) {
this.motionListener = this.cameraDevice.listen(ScryptedInterface.MotionSensor, async () => {
if (!this.cameraDevice.motionDetected) {
// const minimumEndTme = this.detectionStartTime + this.storageSettings.values.minimumDetectionDuration * 1000;
// const sleepTime = minimumEndTme - Date.now();
const sleepTime = this.storageSettings.values.postMotionAnalysisDuration * 1000;
if (sleepTime > 0) {
this.console.log('Motion stopped. Waiting additional time for minimum detection duration:', sleepTime);
await sleep(sleepTime);
if (this.motionDetected) {
this.console.log('Motion resumed during wait. Continuing detection.');
return;
}
}
if (this.detectorRunning) {
// allow anaysis due to user request.
if (this.analyzeStop > Date.now())
return;
this.console.log('Motion stopped, stopping detection.')
this.endObjectDetection();
}
return;
}
this.maybeStartDetection();
});
return;
}
if (this.hasMotionType) {
this.motionMixinListener = this.cameraDevice.listen({
event: ScryptedInterface.MotionSensor,
mixinId: this.id,
}, async (source, details, data) => {
if (this.motionSensorSupplementation !== BUILTIN_MOTION_SENSOR_ASSIST)
return;
if (data) {
if (this.motionDetected)
return;
if (!this.detectorRunning)
this.console.log('Built in motion sensor started motion, starting video detection.');
this.startPipelineAnalysis();
return;
}
this.clearMotionTimeout();
if (this.detectorRunning) {
this.console.log('Built in motion sensor ended motion, stopping video detection.')
this.endObjectDetection();
}
if (this.motionDetected)
this.motionDetected = false;
});
}
}
startPipelineAnalysis() {
if (!this.detectorSignal.finished || this.released)
return;
const signal = this.detectorSignal = new Deferred();
this.detectionStartTime = Date.now();
if (!this.hasMotionType)
this.plugin.objectDetectionStarted(this.name, this.console);
const options = {};
const session = crypto.randomBytes(4).toString('hex');
const typeName = this.hasMotionType ? 'motion' : 'object';
this.console.log(`Video Analysis ${typeName} detection session ${session} started.`);
this.runPipelineAnalysisLoop(signal, options)
.catch(e => {
this.console.error('Video Analysis ended with error', e);
}).finally(() => {
if (!this.hasMotionType)
this.plugin.objectDetectionEnded(this.console);
this.console.log(`Video Analysis ${typeName} detection session ${session} ended.`);
signal.resolve();
});
}
async runPipelineAnalysisLoop(signal: Deferred<void>, options: {
suppress?: boolean,
}) {
await this.updateModel();
while (!signal.finished) {
if (options.suppress) {
this.console.log('Resuming motion processing after active motion timeout.');
}
const shouldSleep = await this.runPipelineAnalysis(signal, options);
options.suppress = true;
if (!shouldSleep || signal.finished)
return;
this.console.log('Suspending motion processing during active motion timeout.');
this.resetMotionTimeout();
// sleep until a moment before motion duration to start peeking again
// to have an opporunity to reset the motion timeout.
await sleep(this.storageSettings.values.motionDuration * 1000 - 4000);
}
}
async createFrameGenerator(frameGenerator: string,
options: {
suppress?: boolean,
}, updatePipelineStatus: (status: string) => void): Promise<AsyncGenerator<VideoFrame, any, unknown> | MediaObject> {
const destination: MediaStreamDestination = this.hasMotionType ? 'low-resolution' : 'local-recorder';
updatePipelineStatus('getVideoStream');
const stream = await this.cameraDevice.getVideoStream({
prebuffer: this.model.prebuffer,
destination,
// ask rebroadcast to mute audio, not needed.
audio: null,
});
if (this.model.decoder) {
if (!options?.suppress)
this.console.log(this.objectDetection.name, '(with builtin decoder)');
return stream;
}
const videoFrameGenerator = systemManager.getDeviceById<VideoFrameGenerator>(frameGenerator);
if (!videoFrameGenerator)
throw new Error('invalid VideoFrameGenerator');
if (!options?.suppress)
this.console.log(videoFrameGenerator.name, '+', this.objectDetection.name);
updatePipelineStatus('generateVideoFrames');
try {
return await videoFrameGenerator.generateVideoFrames(stream, {
queue: 0,
fps: this.hasMotionType ? 4 : undefined,
// this seems to be unused now?
resize: this.model?.inputSize ? {
width: this.model.inputSize[0],
height: this.model.inputSize[1],
} : undefined,
// this seems to be unused now?
format: this.model?.inputFormat,
});
}
finally {
updatePipelineStatus('waiting first result');
}
}
async runPipelineAnalysis(signal: Deferred<void>, options: {
suppress?: boolean,
}) {
const start = Date.now();
let lastStatusTime = Date.now();
let lastStatus = 'starting';
const updatePipelineStatus = (status: string) => {
lastStatus = status;
lastStatusTime = Date.now();
}
const interval = setInterval(() => {
if (Date.now() - lastStatusTime > 30000) {
signal.resolve();
this.console.error('VideoAnalysis is hung and will terminate:', lastStatus);
}
}, 30000);
signal.promise.finally(() => clearInterval(interval));
const currentDetections = new Map<string, number>();
let lastReport = 0;
updatePipelineStatus('waiting result');
const zones: ObjectDetectionZone[] = [];
for (const detectorMixin of this.plugin.currentMixins.values()) {
for (const mixin of detectorMixin.currentMixins.values()) {
if (mixin.id !== this.id)
continue;
for (const [key, zone] of Object.entries(mixin.zones)) {
const zi = mixin.zoneInfos[key];
if (!zone?.length || zone?.length < 3 || zi?.filterMode === 'observe')
continue;
const odz: ObjectDetectionZone = {
classes: mixin.hasMotionType ? ['motion'] : zi?.classes,
exclusion: zi?.filterMode ? zi?.filterMode === 'exclude' : zi?.exclusion,
path: zone,
type: zi?.type,
}
zones.push(odz);
}
}
}
let longObjectDetectionWarning = false;
const frameGenerator = this.model.decoder ? undefined : this.getFrameGenerator();
for await (const detected of
await sdk.connectRPCObject(
await this.objectDetection.generateObjectDetections(
await this.createFrameGenerator(
frameGenerator,
options,
updatePipelineStatus), {
settings: {
...this.getCurrentSettings(),
analyzeMode: !!this.analyzeStop,
frameGenerator,
},
sourceId: this.id,
zones,
}))) {
if (signal.finished) {
break;
}
// stop when analyze period ends.
if (!this.hasMotionType && this.analyzeStop && Date.now() > this.analyzeStop) {
this.analyzeStop = undefined;
break;
}
if (!longObjectDetectionWarning && !this.hasMotionType && Date.now() - start > 5 * 60 * 1000) {
longObjectDetectionWarning = true;
this.console.warn('Camera has been performing object detection for 5 minutes due to persistent motion. This may adversely affect system performance. Read the Optimizing System Performance guide for tips and tricks. https://github.com/koush/nvr.scrypted.app/wiki/Optimizing-System-Performance')
}
// apply the zones to the detections and get a shallow copy list of detections after
// exclusion zones have applied
const originalDetections = detected.detected.detections;
const zonedDetections = this.applyZones(detected.detected);
detected.detected.detections = zonedDetections;
// this.console.warn('dps', detections / (Date.now() - start) * 1000);
if (!this.hasMotionType) {
this.plugin.trackDetection();
// const numZonedDetections = zonedDetections.filter(d => d.className !== 'motion').length;
// const numOriginalDetections = originalDetections.filter(d => d.className !== 'motion').length;
// if (numZonedDetections !== numOriginalDetections)
// this.console.log('Zone filtered detections:', numZonedDetections - numOriginalDetections);
for (const d of detected.detected.detections) {
currentDetections.set(d.className, Math.max(currentDetections.get(d.className) || 0, d.score));
}
const now = Date.now();
if (now > lastReport + 10000) {
const found = [...currentDetections.entries()].map(([className, score]) => `${className} (${score})`);
if (!found.length)
found.push('[no detections]');
this.console.log(`[${Math.round((now - start) / 100) / 10}s] Detected:`, ...found);
currentDetections.clear();
lastReport = now;
}
}
if (detected.detected.detectionId) {
updatePipelineStatus('creating jpeg');
// const start = Date.now();
let { image } = detected.videoFrame;
image = await sdk.connectRPCObject(image);
const jpeg = await image.toBuffer({
format: 'jpg',
});
const mo = await sdk.mediaManager.createMediaObject(jpeg, 'image/jpeg');
// this.console.log('retain took', Date.now() -start);
this.setDetection(detected.detected, mo);
// this.console.log('image saved', detected.detected.detections);
}
const motionFound = this.reportObjectDetections(detected.detected);
if (this.hasMotionType) {
// if motion is detected, stop processing and exit loop allowing it to sleep.
if (motionFound) {
// however, when running in analyze mode, continue to allow viewing motion boxes for test purposes.
if (!this.analyzeStop || Date.now() > this.analyzeStop) {
this.analyzeStop = undefined;
clearInterval(interval);
return true;
}
}
await sleep(250);
}
updatePipelineStatus('waiting result');
// this.handleDetectionEvent(detected.detected);
}
}
applyZones(detection: ObjectsDetected) {
// determine zones of the objects, if configured.
if (!detection.detections)
return [];
let copy = detection.detections.slice();
for (const o of detection.detections) {
if (!o.boundingBox)
continue;
const box = normalizeBox(o.boundingBox, detection.inputDimensions);
let included: boolean;
// need a way to explicitly include package zone.
if (o.zones)
included = true;
else
o.zones = [];
for (const [zone, zoneValue] of Object.entries(this.zones)) {
if (zoneValue.length < 3) {
// this.console.warn(zone, 'Zone is unconfigured, skipping.');
continue;
}
const zoneInfo = this.zoneInfos[zone];
const exclusion = zoneInfo?.filterMode ? zoneInfo.filterMode === 'exclude' : zoneInfo?.exclusion;
// track if there are any inclusion zones
if (!exclusion && !included && zoneInfo?.filterMode !== 'observe')
included = false;
let match = false;
if (zoneInfo?.type === 'Contain') {
match = insidePolygon(box[0] as Point, zoneValue) &&
insidePolygon(box[1], zoneValue) &&
insidePolygon(box[2], zoneValue) &&
insidePolygon(box[3], zoneValue);
}
else {
match = polygonOverlap(box, zoneValue);
}
const classes = zoneInfo?.classes?.length ? zoneInfo?.classes : this.model?.classes || [];
if (match && classes.length) {
match = classes.includes(o.className);
}
if (match) {
o.zones.push(zone);
if (zoneInfo?.filterMode !== 'observe') {
if (exclusion && match) {
copy = copy.filter(c => c !== o);
break;
}
included = true;
}
}
}
// 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: ClipPath = [[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)
copy = copy.filter(c => c !== o);
}
return copy;
}
reportObjectDetections(detection: ObjectsDetected) {
let motionFound = false;
if (this.hasMotionType) {
motionFound = !!detection.detections?.find(d => d.className === 'motion');
if (motionFound) {
if (!this.motionDetected)
this.motionDetected = true;
const areas = detection.detections.filter(d => d.className === 'motion' && d.score !== 1).map(d => d.score)
if (areas.length)
this.console.log('detection areas', areas);
}
}
this.onDeviceEvent(ScryptedInterface.ObjectDetector, detection);
return motionFound;
}
setDetection(detection: ObjectsDetected, detectionInput: MediaObject) {
if (!detection.detectionId)
detection.detectionId = crypto.randomBytes(4).toString('hex');
this.console.log('retaining detection image', ...detection.detections);
const { detectionId } = detection;
this.detections.set(detectionId, detectionInput);
setTimeout(() => {
this.detections.delete(detectionId);
}, 2000);
}
async getNativeObjectTypes(): Promise<ObjectDetectionTypes> {
if (this.mixinDeviceInterfaces.includes(ScryptedInterface.ObjectDetector))
return this.mixinDevice.getObjectTypes();
return {};
}
async getObjectTypes(): Promise<ObjectDetectionTypes> {
const ret = await this.getNativeObjectTypes();
if (!ret.classes)
ret.classes = [];
ret.classes.push(...(await this.objectDetection.getDetectionModel(this.getCurrentSettings())).classes);
return ret;
}
async getDetectionInput(detectionId: any): Promise<MediaObject> {
const detection = this.detections.get(detectionId);
if (detection)
return detection;
if (this.mixinDeviceInterfaces.includes(ScryptedInterface.ObjectDetector))
return this.mixinDevice.getDetectionInput(detectionId);
throw new Error('Detection not found. It may have expired.');
}
get motionSensorSupplementation() {
if (!this.interfaces.includes(ScryptedInterface.MotionSensor))
return BUILTIN_MOTION_SENSOR_REPLACE;
const supp = this.storage.getItem('motionSensorSupplementation');
switch (supp) {
case BUILTIN_MOTION_SENSOR_REPLACE:
return BUILTIN_MOTION_SENSOR_REPLACE;
case BUILTIN_MOTION_SENSOR_ASSIST:
return BUILTIN_MOTION_SENSOR_ASSIST;
}
// if (this.mixinDeviceInterfaces?.includes(ScryptedInterface.MotionSensor))
// return BUILTIN_MOTION_SENSOR_ASSIST;
return BUILTIN_MOTION_SENSOR_REPLACE;
}
getFrameGenerator() {
let frameGenerator = this.storageSettings.values.newPipeline as string;
if (frameGenerator === 'Default')
frameGenerator = this.plugin.storageSettings.values.defaultDecoder || 'Default';
const pipelines = getAllDevices().filter(d => d.interfaces.includes(ScryptedInterface.VideoFrameGenerator));
const webcodec = process.env.SCRYPTED_INSTALL_ENVIRONMENT === 'electron' ? sdk.systemManager.getDeviceById('@scrypted/electron-core', 'webcodec') : undefined;
const webassembly = sdk.systemManager.getDeviceById('@scrypted/nvr', 'decoder') || undefined;
const gstreamer = sdk.systemManager.getDeviceById('@scrypted/python-codecs', 'gstreamer') || undefined;
const libav = sdk.systemManager.getDeviceById('@scrypted/python-codecs', 'libav') || undefined;
const ffmpeg = sdk.systemManager.getDeviceById('@scrypted/objectdetector', 'ffmpeg') || undefined;
const use = pipelines.find(p => p.name === frameGenerator) || webcodec || webassembly || gstreamer || libav || ffmpeg;
return use.id;
}
async updateModel() {
try {
this.model = await this.objectDetection.getDetectionModel(this.getCurrentSettings());
}
catch (e) {
}
}
async getMixinSettings(): Promise<Setting[]> {
const settings: Setting[] = [];
await this.updateModel();
const modelSettings = this.model.settings;
if (modelSettings) {
settings.push(...modelSettings.map(setting => {
let value: any;
if (setting.multiple) {
value = safeParseJson(this.storage.getItem(setting.key));
if (!value?.length)
value = undefined;
}
else {
value = this.storage.getItem(setting.key);
}
value ||= setting.value;
return Object.assign({}, setting, {
placeholder: setting.placeholder?.toString(),
value,
} as Setting);
}));
}
this.storageSettings.settings.motionSensorSupplementation.hide = !this.hasMotionType || !this.mixinDeviceInterfaces.includes(ScryptedInterface.MotionSensor);
this.storageSettings.settings.postMotionAnalysisDuration.hide = this.hasMotionType;
this.storageSettings.settings.motionDuration.hide = !this.hasMotionType;
settings.push(...await this.storageSettings.getSettings());
for (const [name, value] of Object.entries(this.zones)) {
const zi = this.zoneInfos[name];
const subgroup = `Zone: ${name}`;
settings.push({
subgroup,
key: `zone-${name}`,
title: `Open Zone Editor`,
type: 'clippath',
value: JSON.stringify(value),
});
// settings.push({
// subgroup,
// key: `zoneinfo-exclusion-${name}`,
// title: `Exclusion Zone`,
// description: 'Detections in this zone will be excluded.',
// type: 'boolean',
// value: zi?.exclusion,
// });
settings.push({
subgroup,
key: `zoneinfo-filterMode-${name}`,
title: `Filter Mode`,
description: 'The filter mode used by this zone. The Default is include. Zones set to observe will not affect filtering and can be used for automations.',
choices: [
'Default',
'include',
'exclude',
'observe',
],
value: zi?.filterMode || (zi?.exclusion ? 'exclude' : undefined) || 'Default',
});
settings.push({
subgroup,
key: `zoneinfo-type-${name}`,
title: `Zone Type`,
description: 'An Intersect zone will match objects that are partially or fully inside the zone. A Contain zone will only match objects that are fully inside the zone.',
choices: [
'Intersect',
'Contain',
],
value: zi?.type || 'Intersect',
});
if (!this.hasMotionType) {
const classes = this.model.classes;
settings.push(
{
subgroup,
key: `zoneinfo-classes-${name}`,
title: `Detection Classes`,
description: 'The detection classes to match inside this zone.',
choices: classes || [],
value: zi?.classes?.length ? zi?.classes : classes || [],
multiple: true,
},
);
}
}
settings.push(
{
title: 'Analyze',
description: 'Analyzes the video stream for 1 minute. Results will be shown in the Console.',
key: 'analyzeButton',
type: 'button',
},
);
return settings;
}
getZones(): Zones {
try {
return JSON.parse(this.storage.getItem('zones'));
}
catch (e) {
return {};
}
}
getZoneInfos(): ZoneInfos {
try {
return JSON.parse(this.storage.getItem('zoneInfos'));
}
catch (e) {
return {};
}
}
async putMixinSetting(key: string, value: string | number | boolean | string[] | number[]): Promise<void> {
let vs = value?.toString();
if (key === 'zones') {
const newZones: Zones = {};
const newZoneInfos: ZoneInfos = {};
for (const name of value as string[]) {
newZones[name] = this.zones[name] || [];
newZoneInfos[name] = this.zoneInfos[name];
}
this.zones = newZones;
this.zoneInfos = newZoneInfos;
this.storage.setItem('zones', JSON.stringify(newZones));
this.storage.setItem('zoneInfos', JSON.stringify(newZoneInfos));
return;
}
if (key.startsWith('zone-')) {
const zoneName = key.substring('zone-'.length);
if (this.zones[zoneName]) {
this.zones[zoneName] = JSON.parse(vs);
this.storage.setItem('zones', JSON.stringify(this.zones));
}
return;
}
if (key.startsWith('zoneinfo-')) {
const [zkey, zoneName] = key.substring('zoneinfo-'.length).split('-');
this.zoneInfos[zoneName] ||= {};
this.zoneInfos[zoneName][zkey] = value;
this.storage.setItem('zoneInfos', JSON.stringify(this.zoneInfos));
return;
}
if (this.storageSettings.settings[key]) {
return this.storageSettings.putSetting(key, value);
}
if (value && this.model.settings?.find(s => s.key === key)?.multiple) {
vs = JSON.stringify(value);
}
if (key === 'analyzeButton') {
this.startPipelineAnalysis();
this.analyzeStop = Date.now() + 60000;
}
else {
const settings = this.getCurrentSettings();
if (settings && key in settings) {
this.storage.setItem(key, vs);
settings[key] = value;
}
this.bindObjectDetection();
}
}
async release() {
this.released = true;
super.release();
this.clearMotionTimeout();
clearInterval(this.detectionIntervalTimeout);
this.motionListener?.removeListener();
this.motionMixinListener?.removeListener();
this.endObjectDetection();
}
}
class ObjectDetectorMixin extends MixinDeviceBase<ObjectDetection> implements MixinProvider {
currentMixins = new Set<ObjectDetectionMixin>();
constructor(mixinDevice: ObjectDetection, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: WritableDeviceState, public plugin: ObjectDetectionPlugin, public model: ObjectDetectionModel) {
super({ mixinDevice, mixinDeviceInterfaces, mixinDeviceState, mixinProviderNativeId: plugin.nativeId });
// trigger mixin creation. todo: fix this to not be stupid hack.
for (const id of Object.keys(systemManager.getSystemState())) {
const device = systemManager.getDeviceById<VideoCamera & Settings>(id);
if (!device.mixins?.includes(this.id))
continue;
device.probe();
}
}
async canMixin(type: ScryptedDeviceType, interfaces: string[]): Promise<string[]> {
const hasMotionType = this.model.classes.includes('motion');
const prefix = `${objectDetectionPrefix}${hasMotionType}`;
const thisPrefix = `${prefix}:${this.id}`;
const found = interfaces.find(iface => iface.startsWith(prefix) && iface !== thisPrefix);
if (found)
return;
// this.console.log('found', found);
if ((type === ScryptedDeviceType.Camera || type === ScryptedDeviceType.Doorbell) && (interfaces.includes(ScryptedInterface.VideoCamera) || interfaces.includes(ScryptedInterface.Camera))) {
const ret: string[] = [
ScryptedInterface.ObjectDetector,
ScryptedInterface.Settings,
thisPrefix,
];
const model = await this.mixinDevice.getDetectionModel();
if (model.classes?.includes('motion')) {
ret.push(
ScryptedInterface.MotionSensor,
);
}
return ret;
}
}
async getMixin(mixinDevice: any, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: WritableDeviceState) {
let objectDetection = systemManager.getDeviceById<ObjectDetection>(this.id);
const hasMotionType = this.model.classes.includes('motion');
const group = hasMotionType ? 'Motion Detection' : 'Object Detection';
const model = await objectDetection.getDetectionModel({ id: mixinDeviceState.id });
// const group = objectDetection.name.replace('Plugin', '').trim();
const ret = new ObjectDetectionMixin(this.plugin, mixinDevice, mixinDeviceInterfaces, mixinDeviceState, this.mixinProviderNativeId, objectDetection, model, group, hasMotionType);
this.currentMixins.add(ret);
return ret;
}
async releaseMixin(id: string, mixinDevice: ObjectDetectionMixin) {
this.currentMixins.delete(mixinDevice);
return mixinDevice?.release();
}
release(): void {
super.release();
for (const m of this.currentMixins) {
m.release();
}
this.currentMixins.clear();
}
}
interface ObjectDetectionStatistics {
dps: number;
sampleTime: number;
}
export class ObjectDetectionPlugin extends AutoenableMixinProvider implements Settings, DeviceProvider, DeviceCreator {
currentMixins = new Set<ObjectDetectorMixin>();
objectDetectionStatistics = new Map<number, ObjectDetectionStatistics>();
statsSnapshotTime: number;
statsSnapshotDetections: number;
statsSnapshotConcurrent = 0;
storageSettings = new StorageSettings(this, {
activeMotionDetections: {
title: 'Active Motion Detection Sessions',
multiple: true,
readonly: true,
onGet: async () => {
const motionDetections = [...this.currentMixins.values()]
.map(d => [...d.currentMixins.values()].filter(dd => dd.hasMotionType)).flat();
const choices = motionDetections.map(dd => dd.name);
const value = motionDetections.filter(c => c.detectorRunning).map(dd => dd.name);
return {
choices,
value,
}
},
mapGet: () => {
const motion = [...this.currentMixins.values()]
.map(d => [...d.currentMixins.values()].filter(dd => dd.hasMotionType)).flat();
const value = motion.filter(c => c.detectorRunning).map(dd => dd.name);
return value;
},
},
activeObjectDetections: {
title: 'Active Object Detection Sessions',
multiple: true,
readonly: true,
onGet: async () => {
const objectDetections = [...this.currentMixins.values()]
.map(d => [...d.currentMixins.values()].filter(dd => !dd.hasMotionType)).flat();
const choices = objectDetections.map(dd => dd.name);
const value = objectDetections.filter(c => c.detectorRunning).map(dd => dd.name);
return {
choices,
value,
}
},
mapGet: () => {
const motion = [...this.currentMixins.values()]
.map(d => [...d.currentMixins.values()].filter(dd => !dd.hasMotionType)).flat();
const value = motion.filter(c => c.detectorRunning).map(dd => dd.name);
return value;
},
},
defaultDecoder: {
group: 'Advanced',
onGet: async () => {
const choices = [
'Default',
...getAllDevices().filter(d => d.interfaces.includes(ScryptedInterface.VideoFrameGenerator)).map(d => d.name),
];
return {
choices,
}
},
defaultValue: 'Default',
},
developerMode: {
group: 'Advanced',
title: 'Developer Mode',
description: 'Developer mode enables usage of the raw detector object detectors. Using raw object detectors (ie, outside of Scrypted NVR) can cause severe performance degradation.',
type: 'boolean',
},
});
devices = new Map<string, any>();
cpuTimer = new CpuTimer();
cpuUsage = 0;
pruneOldStatistics() {
const now = Date.now();
for (const [k, v] of this.objectDetectionStatistics.entries()) {
// purge the stats every hour
if (Date.now() - v.sampleTime > 60 * 60 * 1000)
this.objectDetectionStatistics.delete(k);
}
}
trackDetection() {
this.statsSnapshotDetections++;
}
canStartObjectDetection(mixin: ObjectDetectionMixin) {
const runningDetections = this.runningObjectDetections;
// already running
if (runningDetections.find(o => o.id === mixin.id))
return false;
// always allow 2 cameras to push past cpu throttling
if (runningDetections.length < 2)
return true;
const cpuPerDetector = this.cpuUsage / runningDetections.length;
const cpuPercent = Math.round(this.cpuUsage * 100);
if (cpuPerDetector * (runningDetections.length + 1) > .9) {
const [first] = runningDetections;
if (Date.now() - first.detectionStartTime > 30000) {
first.console.warn(`CPU is at capacity: ${cpuPercent} with ${runningDetections.length} cameras. Ending object detection to process activity on ${mixin.name}.`);
first.endObjectDetection();
mixin.console.warn(`CPU is at capacity: ${cpuPercent} with ${runningDetections.length} cameras. Ending object detection on ${first.name} to process activity.`);
return true;
}
mixin.console.warn(`CPU is at capacity: ${cpuPercent} with ${runningDetections.length} cameras. Not starting object detection to continue processing recent activity on ${first.name}.`);
return false;
}
// CPU capacity is fine
return true;
}
get runningObjectDetections() {
const runningDetections = [...this.currentMixins.values()]
.map(d => [...d.currentMixins.values()].filter(dd => !dd.hasMotionType)).flat()
.filter(c => c.detectorRunning)
.sort((a, b) => a.detectionStartTime - b.detectionStartTime);
return runningDetections;
}
objectDetectionStarted(name: string, console: Console) {
this.resetStats(console);
this.statsSnapshotConcurrent++;
}
objectDetectionEnded(console: Console) {
this.resetStats(console);
this.statsSnapshotConcurrent--;
}
resetStats(console: Console) {
const now = Date.now();
const concurrentSessions = this.statsSnapshotConcurrent;
if (concurrentSessions) {
const duration = now - this.statsSnapshotTime;
const stats: ObjectDetectionStatistics = {
sampleTime: now,
dps: this.statsSnapshotDetections / (duration / 1000),
};
// ignore short sessions and sessions with no detections (busted?).
if (duration > 10000 && this.statsSnapshotDetections)
this.objectDetectionStatistics.set(concurrentSessions, stats);
this.pruneOldStatistics();
const str = `video analysis, ${concurrentSessions} camera(s), dps: ${Math.round(stats.dps * 10) / 10} (${this.statsSnapshotDetections}/${Math.round(duration / 1000)})`;
this.console.log(str);
console?.log(str);
}
this.statsSnapshotDetections = 0;
this.statsSnapshotTime = now;
}
constructor(nativeId?: ScryptedNativeId) {
super(nativeId, 'v5');
process.nextTick(() => {
sdk.deviceManager.onDeviceDiscovered({
name: 'FFmpeg Frame Generator',
type: ScryptedDeviceType.Builtin,
interfaces: [
ScryptedInterface.VideoFrameGenerator,
],
nativeId: 'ffmpeg',
})
});
setInterval(() => {
this.cpuUsage = this.cpuTimer.sample();
// this.console.log('cpu usage', Math.round(this.cpuUsage * 100));
const runningDetections = this.runningObjectDetections;
let allowStart = 2;
// always allow 2 cameras to push past cpu throttling
if (runningDetections.length > 2) {
const cpuPerDetector = this.cpuUsage / runningDetections.length;
allowStart = Math.ceil(1 / cpuPerDetector) - runningDetections.length;
if (allowStart <= 0)
return;
}
const idleDetectors = [...this.currentMixins.values()]
.map(d => [...d.currentMixins.values()].filter(dd => !dd.hasMotionType)).flat()
.filter(c => !c.detectorRunning);
for (const notRunning of idleDetectors) {
if (notRunning.maybeStartDetection()) {
allowStart--;
if (allowStart <= 0)
return;
}
}
}, 10000)
}
async getDevice(nativeId: string): Promise<any> {
let ret: any;
if (nativeId === 'ffmpeg')
ret = this.devices.get(nativeId) || new FFmpegVideoFrameGenerator('ffmpeg');
if (nativeId?.startsWith(SMART_MOTIONSENSOR_PREFIX))
ret = this.devices.get(nativeId) || new SmartMotionSensor(this, nativeId);
if (ret)
this.devices.set(nativeId, ret);
return ret;
}
async releaseDevice(id: string, nativeId: string): Promise<void> {
if (nativeId?.startsWith(SMART_MOTIONSENSOR_PREFIX)) {
const smart = this.devices.get(nativeId) as SmartMotionSensor;
smart?.detectionListener?.removeListener();
}
}
getSettings(): Promise<Setting[]> {
return this.storageSettings.getSettings();
}
putSetting(key: string, value: SettingValue): Promise<void> {
return this.storageSettings.putSetting(key, value);
}
async canMixin(type: ScryptedDeviceType, interfaces: string[]): Promise<string[]> {
if (!interfaces.includes(ScryptedInterface.ObjectDetection))
return;
if (!this.storageSettings.values.developerMode && !interfaces.includes(ScryptedInterface.ObjectDetectionGenerator))
return;
return [ScryptedInterface.MixinProvider];
}
async getMixin(mixinDevice: ObjectDetection, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: WritableDeviceState): Promise<any> {
const model = await mixinDevice.getDetectionModel();
const ret = new ObjectDetectorMixin(mixinDevice, mixinDeviceInterfaces, mixinDeviceState, this, model);
this.currentMixins.add(ret);
return ret;
}
async releaseMixin(id: string, mixinDevice: ObjectDetectorMixin): Promise<void> {
// what does this mean to make a mixin provider no longer available?
// just ignore it until reboot?
this.currentMixins.delete(mixinDevice);
return mixinDevice?.release();
}
async getCreateDeviceSettings(): Promise<Setting[]> {
return [
createObjectDetectorStorageSetting(),
];
}
async createDevice(settings: DeviceCreatorSettings): Promise<string> {
const nativeId = SMART_MOTIONSENSOR_PREFIX + crypto.randomBytes(8).toString('hex');
const objectDetector = sdk.systemManager.getDeviceById(settings.objectDetector as string);
let name = objectDetector.name || 'New';
name += ' Smart Motion Sensor'
const id = await sdk.deviceManager.onDeviceDiscovered({
nativeId,
name,
type: ScryptedDeviceType.Sensor,
interfaces: [
ScryptedInterface.Camera,
ScryptedInterface.MotionSensor,
ScryptedInterface.Settings,
ScryptedInterface.Readme,
]
});
const sensor = new SmartMotionSensor(this, nativeId);
sensor.storageSettings.values.objectDetector = objectDetector?.id;
return id;
}
}
export default ObjectDetectionPlugin;