ring-client-api 11.0.0 → 11.0.2-beta.1

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 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.0.2-beta.1](https://github.com/dgreif/ring/compare/v11.0.2-beta.0...v11.0.2-beta.1) (2022-05-21)
+
+
+### Bug Fixes
+
+* **api:** prevent duplicate events from `onCallEnded` ([75696d5](https://github.com/dgreif/ring/commit/75696d510969f706248a0f83e98fb1c99fc07213)), closes [#941](https://github.com/dgreif/ring/issues/941)
+* handle pcmu return audio ([ce29fb5](https://github.com/dgreif/ring/commit/ce29fb5638bc488c515518a0fadcaca900ebe750)), closes [#930](https://github.com/dgreif/ring/issues/930)
+
+### [11.0.2-beta.0](https://github.com/dgreif/ring/compare/v11.0.1...v11.0.2-beta.0) (2022-05-21)
+
+
+### Bug Fixes
+
+* handle pcmu audio streams for incoming audio ([06f6ff1](https://github.com/dgreif/ring/commit/06f6ff10ce7c8f2b05b1a12b8f244daa200fa9ab)), closes [#930](https://github.com/dgreif/ring/issues/930)
+
+### [11.0.1](https://github.com/dgreif/ring/compare/v11.0.0...v11.0.1) (2022-05-17)
+
+
+### Bug Fixes
+
+* update webrtc package ([63d003c](https://github.com/dgreif/ring/commit/63d003c1517c158663d230e6daf911c7fc765c55)), closes [#930](https://github.com/dgreif/ring/issues/930)
+
 ## [11.0.0](https://github.com/dgreif/ring/compare/v10.0.0...v11.0.0) (2022-05-08)
 
 

package/lib/api/streaming/peer-connection.d.ts

@@ -1,4 +1,4 @@
-import { ConnectionState, MediaStreamTrack, RTCIceCandidate, RtcpPacket, RtpPacket } from '@koush/werift';
+import { ConnectionState, MediaStreamTrack, RTCIceCandidate, RtcpPacket, RtpPacket } from 'werift';
 import { Observable, ReplaySubject, Subject } from 'rxjs';
 export interface BasicPeerConnection {
     createOffer(): Promise<{
@@ -27,11 +27,11 @@ export declare class WeriftPeerConnection implements BasicPeerConnection {
     onConnectionState: ReplaySubject<"failed" | "closed" | "connected" | "connecting" | "new" | "disconnected">;
     returnAudioTrack: MediaStreamTrack;
     constructor();
-    createOffer(): Promise<import("@koush/werift").RTCSessionDescription>;
+    createOffer(): Promise<import("werift").RTCSessionDescription>;
     createAnswer(offer: {
         type: 'offer';
         sdp: string;
-    }): Promise<import("@koush/werift").RTCSessionDescription>;
+    }): Promise<import("werift").RTCSessionDescription>;
     acceptAnswer(answer: {
         type: 'answer';
         sdp: string;

package/lib/api/streaming/peer-connection.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WeriftPeerConnection = void 0;
-const werift_1 = require("@koush/werift");
+const werift_1 = require("werift");
 const rxjs_1 = require("rxjs");
 const util_1 = require("../util");
 const debug = false, ringIceServers = [
@@ -31,6 +31,12 @@ class WeriftPeerConnection {
                         clockRate: 48000,
                         channels: 2,
                     }),
+                    new werift_1.RTCRtpCodecParameters({
+                        mimeType: 'audio/PCMU',
+                        clockRate: 8000,
+                        channels: 1,
+                        payloadType: 0,
+                    }),
                 ],
                 video: [
                     new werift_1.RTCRtpCodecParameters({

package/lib/api/streaming/streaming-connection-base.d.ts

@@ -1,7 +1,7 @@
 import { BasicPeerConnection } from './peer-connection';
 import { Subscribed } from '../subscribed';
 import { WebSocket } from 'ws';
-import { RtpPacket } from '@koush/werift';
+import { RtpPacket } from 'werift';
 import { ReplaySubject, Subject } from 'rxjs';
 export interface StreamingConnectionOptions {
     createPeerConnection?: () => BasicPeerConnection;

package/lib/api/streaming/streaming-session.d.ts

@@ -1,4 +1,4 @@
-import { RtpPacket } from '@koush/werift';
+import { RtpPacket } from 'werift';
 import { ReplaySubject, Subject } from 'rxjs';
 import { RingEdgeConnection } from './ring-edge-connection';
 import { WebrtcConnection } from './webrtc-connection';
@@ -15,10 +15,12 @@ export declare class StreamingSession extends Subscribed {
     private readonly camera;
     private connection;
     readonly onCallEnded: ReplaySubject<void>;
+    private readonly onUsingOpus;
     readonly onVideoRtp: Subject<RtpPacket>;
     readonly onAudioRtp: Subject<RtpPacket>;
     private readonly audioSplitter;
     private readonly videoSplitter;
+    private readonly returnAudioSplitter;
     constructor(camera: RingCamera, connection: RingEdgeConnection | WebrtcConnection);
     private bindToConnection;
     activated: boolean;
@@ -26,7 +28,12 @@ export declare class StreamingSession extends Subscribed {
     cameraSpeakerActivated: boolean;
     activateCameraSpeaker(): Promise<void>;
     reservePort(bufferPorts?: number): Promise<number>;
+    get isUsingOpus(): Promise<boolean>;
     startTranscoding(ffmpegOptions: FfmpegOptions): Promise<void>;
+    transcodeReturnAudio(ffmpegOptions: {
+        input: SpawnInput[];
+    }): Promise<void>;
+    private hasEnded;
     private callEnded;
     stop(): void;
     sendAudioPacket(rtp: RtpPacket): void;

package/lib/api/streaming/streaming-session.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamingSession = void 0;
+const werift_1 = require("werift");
 const camera_utils_1 = require("@homebridge/camera-utils");
 const rxjs_1 = require("rxjs");
 const ffmpeg_1 = require("../ffmpeg");
@@ -21,26 +22,31 @@ class StreamingSession extends subscribed_1.Subscribed {
         this.camera = camera;
         this.connection = connection;
         this.onCallEnded = new rxjs_1.ReplaySubject(1);
+        this.onUsingOpus = new rxjs_1.ReplaySubject(1);
         this.onVideoRtp = new rxjs_1.Subject();
         this.onAudioRtp = new rxjs_1.Subject();
         this.audioSplitter = new camera_utils_1.RtpSplitter();
         this.videoSplitter = new camera_utils_1.RtpSplitter();
+        this.returnAudioSplitter = new camera_utils_1.RtpSplitter();
         this.activated = false;
         this.cameraSpeakerActivated = false;
+        this.hasEnded = false;
         this.bindToConnection(connection);
     }
     bindToConnection(connection) {
-        this.addSubscriptions(connection.onAudioRtp.subscribe(this.onAudioRtp), connection.onVideoRtp.subscribe(this.onVideoRtp));
+        this.addSubscriptions(connection.onAudioRtp.subscribe(this.onAudioRtp), connection.onVideoRtp.subscribe(this.onVideoRtp), connection.onCallAnswered.subscribe((sdp) => {
+            this.onUsingOpus.next(sdp.toLocaleLowerCase().includes(' opus/'));
+        }));
     }
     async activate() {
-        if (this.activated) {
+        if (this.activated || this.hasEnded) {
             return;
         }
         this.activated = true;
         await this.connection.activate();
     }
     async activateCameraSpeaker() {
-        if (this.cameraSpeakerActivated) {
+        if (this.cameraSpeakerActivated || this.hasEnded) {
             return;
         }
         this.cameraSpeakerActivated = true;
@@ -50,19 +56,25 @@ class StreamingSession extends subscribed_1.Subscribed {
         const ports = await (0, camera_utils_1.reservePorts)({ count: bufferPorts + 1 });
         return ports[0];
     }
+    get isUsingOpus() {
+        return (0, rxjs_1.firstValueFrom)(this.onUsingOpus);
+    }
     async startTranscoding(ffmpegOptions) {
-        const videoPort = await this.reservePort(1), audioPort = await this.reservePort(1), transcodeVideoStream = ffmpegOptions.video !== false, ffmpegInputArguments = [
+        if (this.hasEnded) {
+            return;
+        }
+        const videoPort = await this.reservePort(1), audioPort = await this.reservePort(1), transcodeVideoStream = ffmpegOptions.video !== false, ringSdp = await (0, rxjs_1.firstValueFrom)(this.connection.onCallAnswered), usingOpus = await this.isUsingOpus, ffmpegInputArguments = [
             '-hide_banner',
             '-protocol_whitelist',
             'pipe,udp,rtp,file,crypto',
-            '-acodec',
-            'libopus',
+            // Ring will answer with either opus or pcmu
+            ...(usingOpus ? ['-acodec', 'libopus'] : []),
             '-f',
             'sdp',
             ...(ffmpegOptions.input || []),
             '-i',
             'pipe:',
-        ], ringSdp = await (0, rxjs_1.firstValueFrom)(this.connection.onCallAnswered), inputSdp = getCleanSdp(ringSdp, transcodeVideoStream)
+        ], inputSdp = getCleanSdp(ringSdp, transcodeVideoStream)
             .replace(/m=audio \d+/, `m=audio ${audioPort}`)
             .replace(/m=video \d+/, `m=video ${videoPort}`), ff = new camera_utils_1.FfmpegProcess({
             ffmpegArgs: ffmpegInputArguments.concat(...(ffmpegOptions.audio || ['-acodec', 'aac']), ...(transcodeVideoStream
@@ -97,17 +109,61 @@ class StreamingSession extends subscribed_1.Subscribed {
         // Activate the stream now that ffmpeg is ready to receive
         await this.activate();
     }
+    async transcodeReturnAudio(ffmpegOptions) {
+        if (this.hasEnded) {
+            return;
+        }
+        const audioOutForwarder = new camera_utils_1.RtpSplitter(({ message }) => {
+            const rtp = werift_1.RtpPacket.deSerialize(message);
+            this.connection.sendAudioPacket(rtp);
+            return null;
+        }), usingOpus = await this.isUsingOpus, ff = new camera_utils_1.FfmpegProcess({
+            ffmpegArgs: [
+                '-hide_banner',
+                '-protocol_whitelist',
+                'pipe,udp,rtp,file,crypto',
+                '-re',
+                '-i',
+                ...ffmpegOptions.input,
+                '-acodec',
+                ...(usingOpus
+                    ? ['libopus', '-ac', 2, '-ar', '48k']
+                    : ['pcm_mulaw', '-ac', 1, '-ar', '8k']),
+                '-flags',
+                '+global_header',
+                '-f',
+                'rtp',
+                `rtp://127.0.0.1:${await audioOutForwarder.portPromise}`,
+            ],
+            ffmpegPath: (0, ffmpeg_1.getFfmpegPath)(),
+            exitCallback: () => this.callEnded(),
+            logLabel: `Return Audio (${this.camera.name})`,
+            logger: {
+                error: util_1.logError,
+                info: util_1.logDebug,
+            },
+        });
+        this.onCallEnded.subscribe(() => ff.stop());
+    }
     callEnded() {
+        if (this.hasEnded) {
+            return;
+        }
+        this.hasEnded = true;
         this.unsubscribe();
         this.onCallEnded.next();
         this.connection.stop();
         this.audioSplitter.close();
         this.videoSplitter.close();
+        this.returnAudioSplitter.close();
     }
     stop() {
         this.callEnded();
     }
     sendAudioPacket(rtp) {
+        if (this.hasEnded) {
+            return;
+        }
         this.connection.sendAudioPacket(rtp);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "11.0.0",
+  "version": "11.0.2-beta.1",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/api/index.js",
   "bin": {
@@ -15,12 +15,12 @@
     "lint": "eslint '**/*.ts' --fix",
     "build": "rm -rf lib && tsc --declaration",
     "build-quick": "rm -rf lib && esbuild ./{api,examples,homebridge}/*.ts ./api/streaming/*.ts --target=es2017 --format=cjs --outdir=lib",
-    "example": "node -r @swc-node/register ./lib/examples/example.js",
-    "api-example": "node -r @swc-node/register ./lib/examples/api-example.js",
-    "record-example": "node -r @swc-node/register ./lib/examples/record-example.js",
-    "return-audio-example": "node -r @swc-node/register ./lib/examples/return-audio-example.js",
-    "stream-example": "node -r @swc-node/register ./lib/examples/stream-example.js",
-    "browser-example": "node -r @swc-node/register ./lib/examples/browser-example.js",
+    "example": "node -r @swc-node/register ./examples/example.ts",
+    "api-example": "node -r @swc-node/register ./examples/api-example.ts",
+    "record-example": "node -r @swc-node/register ./examples/record-example.ts",
+    "return-audio-example": "node -r @swc-node/register ./examples/return-audio-example.ts",
+    "stream-example": "node -r @swc-node/register ./examples/stream-example.ts",
+    "browser-example": "node -r @swc-node/register ./examples/browser-example.ts",
     "auth-cli": "npm run build-quick && ./ring-auth-cli.js",
     "device-data-cli": "npm run build-quick && ./ring-device-data-cli.js",
     "hb": "npm run build-quick && ./build/package-homebridge.sh && homebridge -P ./release-homebridge -U ./.homebridge",
@@ -58,33 +58,33 @@
     "@eneris/push-receiver": "^3.0.1",
     "@homebridge/camera-utils": "^2.1.0",
     "@homebridge/plugin-ui-utils": "^0.0.19",
-    "@koush/werift": "0.14.5-beta9",
+    "werift": "^0.15.1",
     "@types/socket.io-client": "1.4.36",
     "colors": "^1.4.0",
     "debug": "^4.3.4",
     "got": "^11.8.3",
     "rxjs": "^7.5.5",
     "socket.io-client": "^2.4.0",
-    "systeminformation": "^5.11.14",
+    "systeminformation": "^5.11.15",
     "uuid": "^8.3.2",
     "ws": "^8.6.0"
   },
   "devDependencies": {
     "@swc-node/register": "^1.5.1",
     "@types/debug": "4.1.7",
-    "@types/jest": "27.5.0",
-    "@types/node": "17.0.31",
+    "@types/jest": "27.5.1",
+    "@types/node": "17.0.34",
     "@types/uuid": "8.3.4",
     "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0",
-    "concurrently": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "5.25.0",
+    "@typescript-eslint/parser": "5.25.0",
+    "concurrently": "^7.2.0",
     "conventional-github-releaser": "3.1.5",
-    "dotenv": "16.0.0",
-    "esbuild": "^0.14.38",
-    "eslint": "8.14.0",
+    "dotenv": "16.0.1",
+    "esbuild": "^0.14.39",
+    "eslint": "8.15.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "26.1.5",
+    "eslint-plugin-jest": "26.2.2",
     "eslint-plugin-prettier": "4.0.0",
     "express": "4.18.1",
     "homebridge": "1.4.1",
@@ -92,8 +92,8 @@
     "prettier": "2.6.2",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
-    "standard-version": "9.3.2",
-    "ts-jest": "28.0.1",
+    "standard-version": "9.5.0",
+    "ts-jest": "28.0.2",
     "typescript": "4.6.4"
   },
   "engines": {