homebridge-ring 11.0.7 → 11.1.0

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [11.1.0](https://github.com/dgreif/ring/compare/v11.0.7...v11.1.0) (2022-08-21)
+
+
+### Features
+
+* **homebridge:** allow cameras to be unbridged ([7302298](https://github.com/dgreif/ring/commit/73022983eed59e6af4bfdf0d8f1ee9d8ee8f6953))
+* **homebridge:** use opus transcoding for unbridge cameras ([e9eb7a4](https://github.com/dgreif/ring/commit/e9eb7a4940ce7d01dee920593af3bdd12e25fa1a))
+
+
+### Bug Fixes
+
+* **homebridge:** add unbridgeCameras option to ui schema ([e97047d](https://github.com/dgreif/ring/commit/e97047df7d959caee95f958a3a6aed5537f93f58))
+* update dependencies ([20584cd](https://github.com/dgreif/ring/commit/20584cdb6fe3d9fa9fd598a1bec612cfe37e3e82))
+* update dependencies ([6f98cdf](https://github.com/dgreif/ring/commit/6f98cdf48895daf3217890b6631a6dbb2ccd340f))
+
 ### [11.0.7](https://github.com/dgreif/ring/compare/v11.0.6...v11.0.7) (2022-07-10)
 
 

package/README.md

@@ -72,6 +72,7 @@ Only include an optional parameter if you actually need it.  Default behavior wi
 
 | Option                       | Default                                                             | Explanation                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | ---------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `unbridgeCameras`            | `false`                                                             | if `true`, all Ring Cameras we be treated as external accessories, which generally leads to better performance. This means they each need to be individually added to HomeKit. WARNING: If your cameras are already bridged, they will be deleted from HomeKit when you enable this option, and you will need to reconfigure any associated automations or HomeKit settings                                                                                                                                                                             |
 | `alarmOnEntryDelay`          | `false`                                                             | if `true`, HomeKit will register a delayed entry event as a triggered alarm.  There are some households where this is a nice feature as a heads up if you have other people who enter your house and you want an alert so that you can disable the alarm for them before it actually goes off. This works well if you automatically arm/disarm on leave/arrive (see setup instructions below)                                                                                                                                                           |
 | `beamDurationSeconds`        | `60` for light groups, previous from Ring app for individual lights | Ring smart lighting has a default behavior of only staying on for 60 seconds when you turn on a light via the Ring app.  To force a duration when the light is turned on from HomeKit, set this option to a specific number of seconds. If this option is not set, the lights will use the duration from the previous time the light was turned on in the Ring app. For light groups, this will default to 60 seconds. The maximum value is `32767`, which is ~9.1 hours.                                                                               |
 | `hideDeviceIds`              | `[]`                                                                | Allows you to hide specific devices by an array of ids.  The id for each device is logged when homebridge starts.                                                                                                                                                                                                                                                                                                                                                                                                                                       |

package/config.schema.json

@@ -16,6 +16,11 @@
         "description": "Click \"Generate New Refresh Token\" above to change accounts or if your refresh token has expired",
         "placeholder": "Refresh Token"
       },
+      "unbridgeCameras": {
+        "title": "Unbridge Cameras",
+        "type": "boolean",
+        "description": "If enabled, all Ring Cameras we be treated as external accessories, which generally leads to better performance. This means they each need to be individually added to HomeKit. WARNING: If your cameras are already bridged, they will be deleted from HomeKit when you enable this option, and you will need to reconfigure any associated automations or HomeKit settings"
+      },
       "alarmOnEntryDelay": {
         "title": "Alarm on Entry Delay",
         "type": "boolean",
@@ -74,15 +79,11 @@
         "oneOf": [
           {
             "title": "Home",
-            "enum": [
-              "some"
-            ]
+            "enum": ["some"]
           },
           {
             "title": "Away",
-            "enum": [
-              "all"
-            ]
+            "enum": ["all"]
           }
         ]
       },
@@ -156,6 +157,7 @@
       "title": "Optional Configuration",
       "expandable": true,
       "items": [
+        "unbridgeCameras",
         "alarmOnEntryDelay",
         "hideLightGroups",
         "hideDoorbellSwitch",

package/lib/homebridge/camera-source.d.ts

@@ -2,10 +2,11 @@ import { RingCamera } from '../api';
 import { CameraStreamingDelegate, PrepareStreamCallback, PrepareStreamRequest, SnapshotRequest, SnapshotRequestCallback, StreamingRequest, StreamRequestCallback } from 'homebridge';
 export declare class CameraSource implements CameraStreamingDelegate {
     private ringCamera;
+    private useOpus;
     controller: import("homebridge").CameraController;
     private sessions;
     private cachedSnapshot?;
-    constructor(ringCamera: RingCamera);
+    constructor(ringCamera: RingCamera, useOpus?: boolean);
     private previousLoadSnapshotPromise?;
     loadSnapshot(imageUuid?: string): Promise<any>;
     fn: number;

package/lib/homebridge/camera-source.js

@@ -10,6 +10,7 @@ const fs_1 = require("fs");
 const util_2 = require("util");
 const ffmpeg_1 = require("../api/ffmpeg");
 const werift_1 = require("werift");
+const opus_repacketizer_1 = require("./opus-repacketizer");
 const readFileAsync = (0, util_2.promisify)(fs_1.readFile), cameraOfflinePath = require.resolve('../../media/camera-offline.jpg'), snapshotsBlockedPath = require.resolve('../../media/snapshots-blocked.jpg');
 function getDurationSeconds(start) {
     return (Date.now() - start) / 1000;
@@ -37,6 +38,7 @@ class StreamingSessionWrapper {
         this.videoSrtp = (0, camera_utils_1.generateSrtpOptions)();
         this.audioSplitter = new camera_utils_1.RtpSplitter();
         this.videoSplitter = new camera_utils_1.RtpSplitter();
+        this.repacketizeAudioSplitter = new camera_utils_1.RtpSplitter();
         this.libfdkAacInstalledPromise = (0, camera_utils_1.doesFfmpegSupportCodec)('libfdk_aac', (0, ffmpeg_1.getFfmpegPath)())
             .then((supported) => {
             if (!supported) {
@@ -89,9 +91,57 @@ class StreamingSessionWrapper {
                 .catch(util_1.logError);
         }));
     }
+    listenForAudioPackets(startStreamRequest) {
+        const { targetAddress, audio: { port: audioPort }, } = this.prepareStreamRequest, { audio: { codec: audioCodec, sample_rate: audioSampleRate }, } = startStreamRequest, 
+        // Repacketize the audio stream after it's been transcoded
+        opusRepacketizer = new opus_repacketizer_1.OpusRepacketizer(1), audioIntervalScale = audioSampleRate / 8, audioSrtpSession = new werift_1.SrtpSession(getSessionConfig(this.audioSrtp));
+        let firstTimestamp, audioPacketCount = 0;
+        this.repacketizeAudioSplitter.addMessageHandler(({ message }) => {
+            let rtp = werift_1.RtpPacket.deSerialize(message);
+            if (audioCodec === "OPUS" /* AudioStreamingCodecType.OPUS */) {
+                // borrowed from scrypted
+                // Original source: https://github.com/koush/scrypted/blob/c13ba09889c3e0d9d3724cb7d49253c9d787fb97/plugins/homekit/src/types/camera/camera-streaming-srtp-sender.ts#L124-L143
+                rtp = opusRepacketizer.repacketize(werift_1.RtpPacket.deSerialize(message));
+                if (!rtp) {
+                    return null;
+                }
+                if (!firstTimestamp) {
+                    firstTimestamp = rtp.header.timestamp;
+                }
+                // from HAP spec:
+                // RTP Payload Format for Opus Speech and Audio Codec RFC 7587 with an exception
+                // that Opus audio RTP Timestamp shall be based on RFC 3550.
+                // RFC 3550 indicates that PCM audio based with a sample rate of 8k and a packet
+                // time of 20ms would have a monotonic interval of 8k / (1000 / 20) = 160.
+                // So 24k audio would have a monotonic interval of (24k / 8k) * 160 = 480.
+                // HAP spec also states that it may request packet times of 20, 30, 40, or 60.
+                // In practice, HAP has been seen to request 20 on LAN and 60 over LTE.
+                // So the RTP timestamp must scale accordingly.
+                // Further investigation indicates that HAP doesn't care about the actual sample rate at all,
+                // that's merely a suggestion. When encoding Opus, it can seemingly be an arbitrary sample rate,
+                // audio will work so long as the rtp timestamps are created properly: which is a construct of the sample rate
+                // HAP requests, and the packet time is respected,
+                // opus 48khz will work just fine.
+                rtp.header.timestamp =
+                    (firstTimestamp + audioPacketCount * 180 * audioIntervalScale) %
+                        0xffffffff;
+                audioPacketCount++;
+            }
+            // encrypt the packet
+            const encryptedPacket = audioSrtpSession.encrypt(rtp.payload, rtp.header);
+            // send the encrypted packet to HomeKit
+            this.audioSplitter
+                .send(encryptedPacket, {
+                port: audioPort,
+                address: targetAddress,
+            })
+                .catch(util_1.logError);
+            return null;
+        });
+    }
     async activate(request) {
         let sentVideo = false;
-        const { targetAddress, audio: { port: audioPort, srtp_key: remoteAudioSrtpKey, srtp_salt: remoteAudioSrtpSalt, }, video: { port: videoPort }, } = this.prepareStreamRequest, 
+        const { targetAddress, audio: { srtp_key: remoteAudioSrtpKey, srtp_salt: remoteAudioSrtpSalt }, video: { port: videoPort }, } = this.prepareStreamRequest, 
         // use to encrypt Ring video to HomeKit
         videoSrtpSession = new werift_1.SrtpSession(getSessionConfig(this.videoSrtp));
         // Set up packet forwarding for video stream
@@ -119,20 +169,23 @@ class StreamingSessionWrapper {
             audio: [
                 '-map',
                 '0:a',
-                // OPUS specific - it works, but audio is very choppy
-                // '-acodec',
-                // 'libopus',
-                // '-vbr',
-                // 'on',
-                // '-frame_duration',
-                // 20,
-                // '-application',
-                // 'lowdelay',
-                // AAC-eld specific
-                '-acodec',
-                'libfdk_aac',
-                '-profile:a',
-                'aac_eld',
+                ...(request.audio.codec === "OPUS" /* AudioStreamingCodecType.OPUS */
+                    ? [
+                        // OPUS specific - it works, but audio is very choppy
+                        '-acodec',
+                        'libopus',
+                        '-frame_duration',
+                        request.audio.packet_time,
+                        '-application',
+                        'lowdelay',
+                    ]
+                    : [
+                        // AAC-eld specific
+                        '-acodec',
+                        'libfdk_aac',
+                        '-profile:a',
+                        'aac_eld',
+                    ]),
                 // Shared options
                 '-flags',
                 '+global_header',
@@ -150,11 +203,8 @@ class StreamingSessionWrapper {
                 this.audioSsrc,
                 '-f',
                 'rtp',
-                '-srtp_out_suite',
-                'AES_CM_128_HMAC_SHA1_80',
-                '-srtp_out_params',
-                (0, camera_utils_1.encodeSrtpOptions)(this.audioSrtp),
-                `srtp://${targetAddress}:${audioPort}?pkt_size=188`,
+                `rtp://127.0.0.1:${await this.repacketizeAudioSplitter
+                    .portPromise}?pkt_size=188`,
             ],
             video: false,
             output: [],
@@ -180,15 +230,16 @@ class StreamingSessionWrapper {
                 // deSerialize will sometimes fail, but the errors can be ignored
             }
             return null;
-        }), usingOpus = await this.streamingSession.isUsingOpus, returnAudioTranscoder = new camera_utils_1.ReturnAudioTranscoder({
+        }), isRingUsingOpus = await this.streamingSession.isUsingOpus, returnAudioTranscoder = new camera_utils_1.ReturnAudioTranscoder({
             prepareStreamRequest: this.prepareStreamRequest,
+            startStreamRequest: request,
             incomingAudioOptions: {
                 ssrc: this.audioSsrc,
                 rtcpPort: 0, // we don't care about rtcp for incoming audio
             },
             outputArgs: [
                 '-acodec',
-                ...(usingOpus
+                ...(isRingUsingOpus
                     ? ['libopus', '-ac', 2, '-ar', '48k']
                     : ['pcm_mulaw', '-ac', 1, '-ar', '8k']),
                 '-flags',
@@ -209,18 +260,21 @@ class StreamingSessionWrapper {
             returnAudioTranscoder.stop();
             returnAudioTranscodedSplitter.close();
         });
+        this.listenForAudioPackets(request);
         await returnAudioTranscoder.start();
         await transcodingPromise;
     }
     stop() {
         this.audioSplitter.close();
+        this.repacketizeAudioSplitter.close();
         this.videoSplitter.close();
         this.streamingSession.stop();
     }
 }
 class CameraSource {
-    constructor(ringCamera) {
+    constructor(ringCamera, useOpus = false) {
         this.ringCamera = ringCamera;
+        this.useOpus = useOpus;
         this.controller = new hap_1.hap.CameraController({
             cameraStreamCount: 10,
             delegate: this,
@@ -244,12 +298,28 @@ class CameraSource {
                     },
                 },
                 audio: {
-                    codecs: [
-                        {
-                            type: "AAC-eld" /* AudioStreamingCodecType.AAC_ELD */,
-                            samplerate: 16 /* AudioStreamingSamplerate.KHZ_16 */,
-                        },
-                    ],
+                    codecs: this.useOpus
+                        ? [
+                            {
+                                type: "OPUS" /* AudioStreamingCodecType.OPUS */,
+                                // required by watch
+                                samplerate: 8 /* AudioStreamingSamplerate.KHZ_8 */,
+                            },
+                            {
+                                type: "OPUS" /* AudioStreamingCodecType.OPUS */,
+                                samplerate: 16 /* AudioStreamingSamplerate.KHZ_16 */,
+                            },
+                            {
+                                type: "OPUS" /* AudioStreamingCodecType.OPUS */,
+                                samplerate: 24 /* AudioStreamingSamplerate.KHZ_24 */,
+                            },
+                        ]
+                        : [
+                            {
+                                type: "AAC-eld" /* AudioStreamingCodecType.AAC_ELD */,
+                                samplerate: 16 /* AudioStreamingSamplerate.KHZ_16 */,
+                            },
+                        ],
                 },
             },
         });

package/lib/homebridge/camera.js

@@ -13,7 +13,7 @@ class Camera extends base_data_accessory_1.BaseDataAccessory {
         this.accessory = accessory;
         this.logger = logger;
         this.config = config;
-        this.cameraSource = new camera_source_1.CameraSource(this.device);
+        this.cameraSource = new camera_source_1.CameraSource(this.device, this.config.unbridgeCameras);
         if (!hap_1.hap.CameraController) {
             const error = 'HAP CameraController not found.  Please make sure you are on homebridge version 1.0.0 or newer';
             logger.error(error);

package/lib/homebridge/config.d.ts

@@ -3,6 +3,7 @@ import { API } from 'homebridge';
 export interface RingPlatformConfig extends RingApiOptions {
     alarmOnEntryDelay?: boolean;
     beamDurationSeconds?: number;
+    ffmpegPath?: string;
     hideLightGroups?: boolean;
     hideDoorbellSwitch?: boolean;
     hideCameraLight?: boolean;
@@ -12,10 +13,10 @@ export interface RingPlatformConfig extends RingApiOptions {
     hideAlarmSirenSwitch?: boolean;
     hideUnsupportedServices?: boolean;
     hideDeviceIds?: string[];
+    nightModeBypassFor: AlarmMode;
     onlyDeviceTypes?: string[];
     showPanicButtons?: boolean;
-    nightModeBypassFor: AlarmMode;
-    ffmpegPath?: string;
+    unbridgeCameras?: boolean;
 }
 export declare function updateHomebridgeConfig(homebridge: API, update: (config: string) => string): boolean;
 export declare function getSystemId(homebridge: API): string;

package/lib/homebridge/homebridge-ui/public/asset-manifest.json

@@ -1,17 +1,17 @@
 {
   "files": {
-    "main.js": "./static/js/main.adeecae1.chunk.js",
-    "main.js.map": "./static/js/main.adeecae1.chunk.js.map",
-    "runtime-main.js": "./static/js/runtime-main.401a8c6e.js",
-    "runtime-main.js.map": "./static/js/runtime-main.401a8c6e.js.map",
-    "static/js/2.fe3feb44.chunk.js": "./static/js/2.fe3feb44.chunk.js",
-    "static/js/2.fe3feb44.chunk.js.map": "./static/js/2.fe3feb44.chunk.js.map",
+    "main.js": "./static/js/main.3d6c9caf.chunk.js",
+    "main.js.map": "./static/js/main.3d6c9caf.chunk.js.map",
+    "runtime-main.js": "./static/js/runtime-main.6cce355a.js",
+    "runtime-main.js.map": "./static/js/runtime-main.6cce355a.js.map",
+    "static/js/2.2785c6d1.chunk.js": "./static/js/2.2785c6d1.chunk.js",
+    "static/js/2.2785c6d1.chunk.js.map": "./static/js/2.2785c6d1.chunk.js.map",
     "index.html": "./index.html",
-    "static/js/2.fe3feb44.chunk.js.LICENSE.txt": "./static/js/2.fe3feb44.chunk.js.LICENSE.txt"
+    "static/js/2.2785c6d1.chunk.js.LICENSE.txt": "./static/js/2.2785c6d1.chunk.js.LICENSE.txt"
   },
   "entrypoints": [
-    "static/js/runtime-main.401a8c6e.js",
-    "static/js/2.fe3feb44.chunk.js",
-    "static/js/main.adeecae1.chunk.js"
+    "static/js/runtime-main.6cce355a.js",
+    "static/js/2.2785c6d1.chunk.js",
+    "static/js/main.3d6c9caf.chunk.js"
   ]
 }

package/lib/homebridge/homebridge-ui/public/index.html

@@ -1 +1 @@
-<div id="root"></div><script>!function(e){function r(r){for(var n,i,l=r[0],f=r[1],a=r[2],c=0,s=[];c<l.length;c++)i=l[c],Object.prototype.hasOwnProperty.call(o,i)&&o[i]&&s.push(o[i][0]),o[i]=0;for(n in f)Object.prototype.hasOwnProperty.call(f,n)&&(e[n]=f[n]);for(p&&p(r);s.length;)s.shift()();return u.push.apply(u,a||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,l=1;l<t.length;l++){var f=t[l];0!==o[f]&&(n=!1)}n&&(u.splice(r--,1),e=i(i.s=t[0]))}return e}var n={},o={1:0},u=[];function i(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,i),t.l=!0,t.exports}i.m=e,i.c=n,i.d=function(e,r,t){i.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},i.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.t=function(e,r){if(1&r&&(e=i(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(i.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)i.d(t,n,function(r){return e[r]}.bind(null,n));return t},i.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return i.d(r,"a",r),r},i.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},i.p="./";var l=this["webpackJsonphomebridge-ui"]=this["webpackJsonphomebridge-ui"]||[],f=l.push.bind(l);l.push=r,l=l.slice();for(var a=0;a<l.length;a++)r(l[a]);var p=f;t()}([])</script><script src="./static/js/2.fe3feb44.chunk.js"></script><script src="./static/js/main.adeecae1.chunk.js"></script>
+<div id="root"></div><script>!function(e){function r(r){for(var n,i,l=r[0],f=r[1],a=r[2],c=0,s=[];c<l.length;c++)i=l[c],Object.prototype.hasOwnProperty.call(o,i)&&o[i]&&s.push(o[i][0]),o[i]=0;for(n in f)Object.prototype.hasOwnProperty.call(f,n)&&(e[n]=f[n]);for(p&&p(r);s.length;)s.shift()();return u.push.apply(u,a||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,l=1;l<t.length;l++){var f=t[l];0!==o[f]&&(n=!1)}n&&(u.splice(r--,1),e=i(i.s=t[0]))}return e}var n={},o={1:0},u=[];function i(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,i),t.l=!0,t.exports}i.m=e,i.c=n,i.d=function(e,r,t){i.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},i.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.t=function(e,r){if(1&r&&(e=i(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(i.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)i.d(t,n,function(r){return e[r]}.bind(null,n));return t},i.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return i.d(r,"a",r),r},i.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},i.p="./";var l=this["webpackJsonphomebridge-ui"]=this["webpackJsonphomebridge-ui"]||[],f=l.push.bind(l);l.push=r,l=l.slice();for(var a=0;a<l.length;a++)r(l[a]);var p=f;t()}([])</script><script src="./static/js/2.2785c6d1.chunk.js"></script><script src="./static/js/main.3d6c9caf.chunk.js"></script>