homebridge-ring 12.0.0 → 12.1.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # homebridge-ring
 
+## 12.1.0
+
+### Minor Changes
+
+- [`7354a21`](https://github.com/dgreif/ring/commit/7354a21e23a75ba7b7f2e67098bf0816c75c3c42) Thanks [@dgreif](https://github.com/dgreif)! - Update dependencies
+
+### Patch Changes
+
+- Updated dependencies [[`7354a21`](https://github.com/dgreif/ring/commit/7354a21e23a75ba7b7f2e67098bf0816c75c3c42)]:
+  - ring-client-api@12.1.0
+
+## 12.0.1
+
+### Patch Changes
+
+- [`3604f30`](https://github.com/dgreif/ring/commit/3604f30b272f97968fd0f73368de720e33991555) Thanks [@dgreif](https://github.com/dgreif)! - Update dependencies
+
+- [#1307](https://github.com/dgreif/ring/pull/1307) [`c197ad1`](https://github.com/dgreif/ring/commit/c197ad14b106bbfaf9080112296a0ffd9136ec84) Thanks [@tsightler](https://github.com/tsightler)! - Update Opus processing to handle all possible bitrates and packet lengths which should fix audio issues over LTE/5G
+  Minor tweaks to AAC-ELD processing for slightly improved audio
+- Updated dependencies [[`3604f30`](https://github.com/dgreif/ring/commit/3604f30b272f97968fd0f73368de720e33991555)]:
+  - ring-client-api@12.0.1
+
 ## 12.0.0
 
 ### Breaking Changes

package/lib/camera-source.js

@@ -92,16 +92,16 @@ class StreamingSessionWrapper {
         }));
     }
     listenForAudioPackets(startStreamRequest) {
-        const { targetAddress, audio: { port: audioPort }, } = this.prepareStreamRequest, { audio: { codec: audioCodec, sample_rate: audioSampleRate }, } = startStreamRequest, 
+        const { targetAddress, audio: { port: audioPort }, } = this.prepareStreamRequest, { audio: { codec: audioCodec, sample_rate: audioSampleRate, packet_time: audioPacketTime, }, } = 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));
+        opusRepacketizer = new opus_repacketizer_1.OpusRepacketizer(audioPacketTime / 20), audioIntervalScale = ((audioSampleRate / 8) * audioPacketTime) / 20, 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));
+                rtp = opusRepacketizer.repacketize(rtp);
                 if (!rtp) {
                     return null;
                 }
@@ -123,7 +123,7 @@ class StreamingSessionWrapper {
                 // HAP requests, and the packet time is respected,
                 // opus 48khz will work just fine.
                 rtp.header.timestamp =
-                    (firstTimestamp + audioPacketCount * 180 * audioIntervalScale) %
+                    (firstTimestamp + audioPacketCount * 160 * audioIntervalScale) %
                         0xffffffff;
                 audioPacketCount++;
             }
@@ -141,7 +141,7 @@ class StreamingSessionWrapper {
     }
     async activate(request) {
         let sentVideo = false;
-        const { targetAddress, audio: { srtp_key: remoteAudioSrtpKey, srtp_salt: remoteAudioSrtpSalt }, video: { port: videoPort }, } = this.prepareStreamRequest, 
+        const { targetAddress, 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
@@ -177,9 +177,7 @@ class StreamingSessionWrapper {
                         '-frame_duration',
                         request.audio.packet_time,
                         '-application',
-                        'voip',
-                        '-vbr',
-                        'off',
+                        'lowdelay',
                     ]
                     : [
                         // AAC-eld specific
@@ -187,6 +185,10 @@ class StreamingSessionWrapper {
                         'libfdk_aac',
                         '-profile:a',
                         'aac_eld',
+                        '-eld_sbr:a',
+                        '1',
+                        '-eld_v2',
+                        '1',
                     ]),
                 // Shared options
                 '-flags',
@@ -206,26 +208,21 @@ class StreamingSessionWrapper {
                 '-f',
                 'rtp',
                 `rtp://127.0.0.1:${await this.repacketizeAudioSplitter
-                    .portPromise}?pkt_size=188`,
+                    .portPromise}?pkt_size=376`,
             ],
             video: false,
             output: [],
         });
         let cameraSpeakerActive = false;
-        // used to decrypt return audio from HomeKit to Ring
-        const remoteAudioSrtpOptions = {
-            srtpKey: remoteAudioSrtpKey,
-            srtpSalt: remoteAudioSrtpSalt,
-        }, audioSrtpSession = new werift_1.SrtpSession(getSessionConfig(remoteAudioSrtpOptions)), returnAudioTranscodedSplitter = new camera_utils_1.RtpSplitter(({ message }) => {
+        // used to send return audio from HomeKit to Ring
+        const returnAudioTranscodedSplitter = new camera_utils_1.RtpSplitter(({ message }) => {
             if (!cameraSpeakerActive) {
                 cameraSpeakerActive = true;
                 this.streamingSession.activateCameraSpeaker();
             }
-            // decrypt the message
+            // deserialize and send to Ring - werift will handle encryption and other header params
             try {
                 const rtp = werift_1.RtpPacket.deSerialize(message);
-                rtp.payload = audioSrtpSession.decrypt(rtp.payload);
-                // send to Ring - werift will handle encryption and other header params
                 this.streamingSession.sendAudioPacket(rtp);
             }
             catch (_) {
@@ -245,15 +242,13 @@ class StreamingSessionWrapper {
                     ? [
                         'libopus',
                         '-ac',
-                        1,
+                        '1',
                         '-ar',
                         '24k',
-                        '-vbr',
-                        'off',
                         '-b:a',
                         '24k',
                         '-application',
-                        'voip',
+                        'lowdelay',
                     ]
                     : ['pcm_mulaw', '-ac', 1, '-ar', '8k']),
                 '-flags',
@@ -303,7 +298,7 @@ class CameraSource {
                         [480, 360, 30],
                         [480, 270, 30],
                         [320, 240, 30],
-                        [320, 240, 15],
+                        [320, 240, 15], // Apple Watch requires this configuration
                         [320, 180, 30],
                     ],
                     codec: {

package/lib/opus-repacketizer.js

@@ -1,10 +1,10 @@
 "use strict";
 // OpusRepacketizer is borrowed from scrypted
-// Original source: https://github.com/koush/scrypted/blob/c13ba09889c3e0d9d3724cb7d49253c9d787fb97/plugins/homekit/src/types/camera/opus-repacketizer.ts
+// Original source: https://github.com/koush/scrypted/blob/3150a3033515a3886af1e6b35a0ba7432b63e02b/plugins/homekit/src/types/camera/opus-repacketizer.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpusRepacketizer = void 0;
 // https://datatracker.ietf.org/doc/html/rfc6716
-// INPUT
+// INPUT (for single frame sample, see RFC for other 4 code values)
 // 0                   1                   2                   3
 // 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -58,25 +58,104 @@ exports.OpusRepacketizer = void 0;
 class OpusRepacketizer {
     constructor(framesPerPacket) {
         this.framesPerPacket = framesPerPacket;
-        this.packets = [];
+        this.depacketized = [];
     }
     // repacketize a packet with a single frame into a packet with multiple frames.
     repacketize(packet) {
-        if (this.framesPerPacket === 1)
-            return packet;
-        if (packet.payload[0] & 0b00000011) {
-            throw new Error('expected opus packet with a single frame.');
+        const code = packet.payload[0] & 0b00000011;
+        let offset;
+        // see Frame Length Coding in RFC
+        const decodeFrameLength = () => {
+            let frameLength = packet.payload.readUInt8(offset);
+            if (frameLength >= 252) {
+                offset++;
+                frameLength += packet.payload.readUInt8(offset) * 4;
+            }
+            return frameLength;
+        };
+        // code 0: cbr, 1 packet
+        // code 1: cbr, 2 packets
+        // code 2: vbr, 2 packets
+        // code 3: cbr/vbr signaled, variable packets
+        if (code === 0) {
+            if (this.framesPerPacket === 1 && !this.depacketized.length)
+                return packet;
+            // depacketize by stripping off the config byte
+            this.depacketized.push(packet.payload.subarray(1));
         }
-        this.packets.push(packet);
-        if (this.packets.length !== this.framesPerPacket) {
-            return;
+        else if (code === 1) {
+            if (this.framesPerPacket === 2 && !this.depacketized.length)
+                return packet;
+            // depacketize by dividing the remaining payload into two equal sized frames
+            const remaining = packet.payload.length - 1;
+            if (remaining % 2) {
+                throw new Error('expected equal sized opus packets (code 1)');
+            }
+            const frameLength = remaining / 2;
+            this.depacketized.push(packet.payload.subarray(1, 1 + frameLength));
+            this.depacketized.push(packet.payload.subarray(1 + frameLength));
+        }
+        else if (code === 2) {
+            if (this.framesPerPacket === 2 && !this.depacketized.length)
+                return packet;
+            offset = 1;
+            // depacketize by dividing the remaining payload into two inequal sized frames
+            const frameLength = decodeFrameLength();
+            this.depacketized.push(packet.payload.subarray(offset, offset + frameLength));
+            this.depacketized.push(packet.payload.subarray(offset + frameLength));
         }
-        const first = this.packets[0], depacketized = this.packets.map((p) => p.payload.subarray(1));
-        this.packets = [];
-        let config = first.payload[0];
-        config |= 0b00000011;
-        const frameCount = 0b10000000 | this.framesPerPacket, newHeader = [config, frameCount];
-        // depacketize by stripping off the config byte
+        else if (code === 3) {
+            // code 3 packet will have a frame count and padding indicator, and whether the packets
+            // are equal size or not.
+            const frameCountByte = packet.payload[1], packetFrameCount = frameCountByte & 0b00111111, vbr = frameCountByte & 0b10000000;
+            if (this.framesPerPacket === packetFrameCount &&
+                !this.depacketized.length) {
+                return packet;
+            }
+            const paddingIndicator = frameCountByte & 0b01000000;
+            offset = 2;
+            let padding = 0;
+            if (paddingIndicator) {
+                padding = packet.payload.readUInt8(offset);
+                offset++;
+                if (padding === 255) {
+                    padding = 254 + packet.payload.readUInt8(offset);
+                    offset++;
+                }
+            }
+            if (!vbr) {
+                const remaining = packet.payload.length - offset - padding;
+                if (remaining % packetFrameCount) {
+                    throw new Error('expected equal sized opus packets (code 3)');
+                }
+                const frameLength = remaining / packetFrameCount;
+                for (let i = 0; i < packetFrameCount; i++) {
+                    const start = offset + i * frameLength, end = start + frameLength;
+                    this.depacketized.push(packet.payload.subarray(start, end));
+                }
+            }
+            else {
+                const frameLengths = [];
+                for (let i = 0; i < packetFrameCount; i++) {
+                    const frameLength = decodeFrameLength();
+                    frameLengths.push(frameLength);
+                }
+                for (let i = 0; i < packetFrameCount; i++) {
+                    const frameLength = frameLengths[i], start = offset;
+                    offset += frameLength;
+                    this.depacketized.push(packet.payload.subarray(start, offset));
+                }
+            }
+        }
+        if (this.depacketized.length < this.framesPerPacket)
+            return;
+        const depacketized = this.depacketized.slice(0, this.framesPerPacket);
+        this.depacketized = this.depacketized.slice(this.framesPerPacket);
+        // reuse the config and stereo indicator, but change the code to 3.
+        let toc = packet.payload[0];
+        toc |= 0b00000011;
+        // vbr | padding indicator | packet count
+        const frameCountByte = 0b10000000 | this.framesPerPacket, newHeader = [toc, frameCountByte];
         // M-1 length bytes
         newHeader.push(...depacketized.slice(0, -1).map((data) => data.length));
         const headerBuffer = Buffer.from(newHeader), payload = Buffer.concat([headerBuffer, ...depacketized]);

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "homebridge-ring",
-  "version": "12.0.0",
+  "displayName": "Ring",
+  "version": "12.1.0",
   "description": "Homebridge plugin for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "scripts": {
@@ -11,18 +12,18 @@
     "dev:run": "nodemon --watch . --watch ../ring-client-api/lib --exec 'RING_DEBUG=true homebridge -P ./ -U ../../.homebridge'"
   },
   "dependencies": {
-    "@homebridge/camera-utils": "^2.2.0",
-    "@homebridge/plugin-ui-utils": "^0.1.0",
-    "ring-client-api": "12.0.0",
-    "werift": "0.18.5"
+    "@homebridge/camera-utils": "^2.2.4",
+    "@homebridge/plugin-ui-utils": "^1.0.0",
+    "ring-client-api": "12.1.0",
+    "werift": "0.18.17"
   },
   "devDependencies": {
-    "concurrently": "^8.2.0",
+    "concurrently": "^8.2.2",
     "eslint-config-shared": "*",
-    "homebridge": "1.6.1",
-    "nodemon": "^3.0.1",
+    "homebridge": "1.7.0",
+    "nodemon": "^3.0.2",
     "tsconfig": "*",
-    "typescript": "5.1.6"
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": "^18 || ^20",