homebridge-unifi-protect
Version:
Homebridge UniFi Protect plugin providing complete HomeKit integration for the entire UniFi Protect ecosystem with full support for most features including HomeKit Secure Video, multiple controllers, blazing fast performance, and much more.
165 lines • 9.28 kB
JavaScript
/* Copyright(C) 2019-2025, HJD (https://github.com/hjdhjd). All rights reserved.
*
* protect-livestream.ts: Protect livestream API manager.
*/
import { FfmpegLivestreamProcess, sleep } from "homebridge-plugin-utils";
import { PROTECT_HKSV_SEGMENT_RESOLUTION } from "./settings.js";
const LIVESTREAM_TIMEOUT = 3500;
const LIVESTREAM_RESTART_INTERVAL = 10;
export class LivestreamManager {
eventHandlers;
livestreams;
protectCamera;
restartDelay;
restarting;
subscriberCount;
segmentTimer;
startTime;
// Create an instance.
constructor(protectCamera) {
this.eventHandlers = {};
this.livestreams = {};
this.protectCamera = protectCamera;
this.restartDelay = {};
this.restarting = {};
this.segmentTimer = {};
this.startTime = {};
this.subscriberCount = {};
}
// Utility to return an index into our livestream connection pool.
getIndex(rtspEntry) {
// If we're using a secondary lens, the channel must always be 0 when using the livestream API.
const channel = (rtspEntry.lens === undefined) ? rtspEntry.channel.id : 0;
const lens = rtspEntry.lens;
return { channel: channel, index: channel.toString() + ((lens !== undefined) ? "." + lens.toString() : ""), lens: lens };
}
// Retrieve a connection to the livestream API for a given channel.
acquire(rtspEntry) {
const { index } = this.getIndex(rtspEntry);
// Let's see if we have an existing livestream already open and reuse it if we can.
if (this.livestreams[index]) {
return this.livestreams[index];
}
// Create a new livestream instance.
this.subscriberCount[index] = 0;
if (this.protectCamera.hasFeature("Debug.Video.HKSV.UseRtsp") && this.protectCamera.stream.hksv?.recordingConfiguration) {
return this.livestreams[index] = new FfmpegLivestreamProcess(this.protectCamera.stream.ffmpegOptions, this.protectCamera.stream.hksv.recordingConfiguration, { codec: this.protectCamera.ufp.videoCodec, enableAudio: this.protectCamera.stream.hksv.isAudioActive, url: rtspEntry.url });
}
return this.livestreams[index] = this.protectCamera.nvr.ufpApi.createLivestream();
}
// Restarting status.
isRestarting(rtspEntry) {
return this.restarting[this.getIndex(rtspEntry).index];
}
// Shutdown all our connections.
shutdown() {
// Cleanup all the listeners and shutdown our livestreams.
Object.values(this.segmentTimer).map(timer => clearTimeout(timer));
Object.values(this.livestreams).map(livestream => livestream.removeAllListeners() && livestream.stop());
this.eventHandlers = {};
this.livestreams = {};
this.restartDelay = {};
this.restarting = {};
this.segmentTimer = {};
this.startTime = {};
this.subscriberCount = {};
}
// Access the livestream API, registering as a consumer.
async start(rtspEntry, segmentLength = PROTECT_HKSV_SEGMENT_RESOLUTION) {
const { channel, index, lens } = this.getIndex(rtspEntry);
// If we don't have a livestream configured for this channel, we're done. We could just create it here, but given we listen to events on livestream listeners, this
// is a safer option to ensure that we've acquired a livestream endpoint before trying to start it.
if (!this.livestreams[index]) {
return false;
}
// Start the livestream if this is the first run. We set this to reattempt establishing the livestream up to three times due to occasional controller glitches.
if (!this.subscriberCount[index]) {
if (this.protectCamera.hasFeature("Debug.Video.HKSV.UseRtsp")) {
this.livestreams[index].segmentLength = segmentLength;
this.livestreams[index].start();
}
else if (!(await this.livestreams[index].start(this.protectCamera.ufp.id, channel, { lens, requestId: this.protectCamera.name + ":" + index, segmentLength }))) {
this.protectCamera.log.error("Unable to access the Protect livestream API: this is typically due to the Protect controller or camera rebooting.");
// Something went wrong in communicating with the controller.
return false;
}
}
// Keep track of any issues in the livestream.
if (!this.subscriberCount[index]) {
this.restartDelay[index] = LIVESTREAM_RESTART_INTERVAL;
this.restarting[index] = false;
this.startTime[index] = Date.now();
// Configure a restart event for the livestream API session so we can restart the session in case of problems.
this.livestreams[index].on("restart", this.eventHandlers[index + ".restart"] = async (retryRestart = false) => {
// If we have a restart inflight and this restart trigger isn't internally triggered, we're done.
if (this.restarting[index] && !retryRestart) {
return;
}
this.restarting[index] = true;
// Clear out any existing timer.
if (this.segmentTimer[index]) {
clearTimeout(this.segmentTimer[index]);
}
this.livestreams[index].stop();
// If either the controller is offline/throttled or the camera isn't connected, let's retry again in a minute.
if (!this.protectCamera.ufpApi.bootstrap || this.protectCamera.ufpApi.isThrottled || !this.protectCamera.isOnline) {
this.segmentTimer[index] = setTimeout(() => this.livestreams[index].emit("restart", true), 60 * 1000);
return;
}
this.protectCamera.log.warn("Reconnecting to the %s.", this.protectCamera.hasFeature("Debug.Video.HKSV.UseRtsp") ? "RTSP stream" : "livestream API");
// Wait before we try to reconnect to the livestream. This accounts for reboots and other potential connection issues that can occur.
await sleep((((Math.random() * 3) + this.restartDelay[index]) * 1000));
if (this.protectCamera.hasFeature("Debug.Video.HKSV.UseRtsp")) {
this.livestreams[index].segmentLength = segmentLength;
this.livestreams[index].start();
}
else {
await this.livestreams[index].start(this.protectCamera.ufp.id, channel, { lens, requestId: this.protectCamera.name + ":" + index, segmentLength });
}
this.startTime[index] = Date.now();
// Check on the state of our livestream API session regularly.
this.segmentTimer[index] = setTimeout(() => this.livestreams[index].emit("restart"), LIVESTREAM_TIMEOUT);
// Increase our backoff interval in case we've got a stuck livestream websocket on the Protect controller or the camera is offline.
this.restartDelay[index] = Math.min(this.restartDelay[index] + (LIVESTREAM_RESTART_INTERVAL / 2), LIVESTREAM_RESTART_INTERVAL * 3);
// We're done with this restart attempt.
this.restarting[index] = false;
});
// Set a regular heartbeat for the livestream API.
this.livestreams[index].on("segment", this.eventHandlers[index] = () => {
// Clear out any existing timer.
if (this.segmentTimer[index]) {
clearTimeout(this.segmentTimer[index]);
// Make sure we've got a good livestream before we reset our delay.
if ((Date.now() - this.startTime[index]) > (60 * 1000)) {
this.restartDelay[index] = LIVESTREAM_RESTART_INTERVAL;
}
}
// Check on the state of our livestream API session regularly.
this.segmentTimer[index] = setTimeout(() => this.livestreams[index].emit("restart"), LIVESTREAM_TIMEOUT);
});
// Set an initial timer in case we have an issue with the livestream API at startup.
this.segmentTimer[index] = setTimeout(() => this.livestreams[index].emit("restart"), LIVESTREAM_TIMEOUT);
}
// Increment our consumer count.
this.subscriberCount[index]++;
return true;
}
// End a livestream API connection once all the consumers of the livestream are done.
stop(rtspEntry) {
const { index } = this.getIndex(rtspEntry);
// If we have open livestreams, we don't want to close the livestream session.
if (--this.subscriberCount[index] > 0) {
return;
}
// End our livestream API connection.
this.livestreams[index].stop();
// Cleanup our listeners.
this.livestreams[index].off("restart", this.eventHandlers[index + ".restart"]);
this.livestreams[index].off("segment", this.eventHandlers[index]);
if (this.segmentTimer[index]) {
clearTimeout(this.segmentTimer[index]);
}
this.subscriberCount[index] = 0;
}
}
//# sourceMappingURL=protect-livestream.js.map