ringcentral-softphone 0.7.0 → 0.8.0

package/README.md

@@ -35,56 +35,31 @@ const softphone = new Softphone({
   password: process.env.SIP_INFO_PASSWORD,
   authorizationId: process.env.SIP_INFO_AUTHORIZATION_ID,
 });
-softphone.enableDebugMode(); // optional, print all SIP messages
-const main = async () => {
-  await softphone.register();
-  // inbound call
-  softphone.on('invite', async (inviteMessage) => {
-    // answer the call
-    const callSession = await softphone.answer(inviteMessage);
-    // receive audio
-    const writeStream = fs.createWriteStream(`${callSession.callId}.raw`, { flags: 'a' });
-    callSession.on('audioPacket', (rtpPacket: RtpPacket) => {
-      writeStream.write(rtpPacket.payload);
-    });
-     // either you or the peer hang up
-    callSession.on('disposed', () => {
-      writeStream.close();
-    });
-    // receive DTMF
-    callSession.on('dtmf', (digit) => {
-      console.log('dtmf', digit);
-    });
-  });
-};
-main();
 ```
 
-For a complete example, see [src/index.ts](src/index.ts)
+For complete examples, see [demos/](demos/)
 
 
 ## Supported features
 
 - inbound call
 - outbound call
-- inbund DTMF 
+- inbound DTMF 
 - outbound DTMF
 - reject inbound call
 - cancel outbound call
 - hang up ongoing call
-- receive remote autio stream
+- receive remote audio stream
+- outbound call caller ID
 
 
-## How to test
-
-Make a phone call to you device's number.
-
-There will be audio stream coming in. And you can also get the DTMF digits the caller pressed.
+## Notes
 
+### Audio formats
 
-## Notes
+The codec is "PCMU/8000", bit rate 8, which mean 8 bits per sample, sample rate 8000, which means 8000 samples per second.
 
-### How to play saved audio file
+You may play saved audio by the following commands:
 
 ```
 ffplay -autoexit -f mulaw -ar 8000 test.raw
@@ -100,13 +75,14 @@ play -b 8 -r 8000 -e mu-law test.raw
 ## Todo
 
 - Try other payload types, such as OPUS
-- support callerId
+  - tried OPUS/16000, but the received packets are quite small and cannot be played
 - do not hard code `domain` and `outboundProxy`
-- send audio to remote peer
+  - I tried `sip10.ringcentral.com:5096` as `outboundProxy`, it requires TLS instead of TCP
+  - I made TLS work, however for inbound call there is not INVITE message coming in, for outbound call "488 Not Acceptable Here"
 - check the code of PJSIP and refactor the code.
-- Let user check the call info, such as who is calling, who is being called, etc.
+- Let developer check the call info, such as who is calling, who is being called, etc.
 
 
 ## Dev Notes
 
-- We don't need to explicitly tell remote server our local RTP port vis SIP SDP message. We will have to send a RTP message to the remote server first, so the remote server knows our IP and port. So the port number in SDP message could be fake.
+- We don't need to explicitly tell remote server our local RTP port via SIP SDP message. We will have to send a RTP message to the remote server first, so the remote server knows our IP and port. So the port number in SDP message could be fake.

package/demos/inbound-call.ts

@@ -0,0 +1,52 @@
+import fs from 'fs';
+import type { RtpPacket } from 'werift-rtp';
+
+import Softphone from '../src/softphone';
+// import waitFor from 'wait-for-async';
+
+const softphone = new Softphone({
+  username: process.env.SIP_INFO_USERNAME,
+  password: process.env.SIP_INFO_PASSWORD,
+  authorizationId: process.env.SIP_INFO_AUTHORIZATION_ID,
+});
+softphone.enableDebugMode(); // print all SIP messages
+
+const main = async () => {
+  await softphone.register();
+  // detect inbound call
+  softphone.on('invite', async (inviteMessage) => {
+    // decline the call
+    // await waitFor({ interval: 1000 });
+    // await softphone.decline(inviteMessage);
+
+    // answer the call
+    const callSession = await softphone.answer(inviteMessage);
+
+    // receive audio
+    const writeStream = fs.createWriteStream(`${callSession.callId}.raw`, { flags: 'a' });
+    callSession.on('audioPacket', (rtpPacket: RtpPacket) => {
+      writeStream.write(rtpPacket.payload);
+    });
+
+    // either you or the peer hang up
+    callSession.once('disposed', () => {
+      writeStream.close();
+    });
+
+    // receive DTMF
+    callSession.on('dtmf', (digit) => {
+      console.log('dtmf', digit);
+    });
+
+    // // send DTMF
+    // await waitFor({ interval: 2000 });
+    // callSession.sendDTMF('1');
+    // await waitFor({ interval: 2000 });
+    // callSession.sendDTMF('#');
+
+    // // hang up the call
+    // await waitFor({ interval: 5000 });
+    // callSession.hangup();
+  });
+};
+main();

package/demos/outbound-call.ts

@@ -0,0 +1,58 @@
+import fs from 'fs';
+import type { RtpPacket } from 'werift-rtp';
+import waitFor from 'wait-for-async';
+
+import Softphone from '../src/softphone';
+
+const softphone = new Softphone({
+  username: process.env.SIP_INFO_USERNAME,
+  password: process.env.SIP_INFO_PASSWORD,
+  authorizationId: process.env.SIP_INFO_AUTHORIZATION_ID,
+});
+softphone.enableDebugMode(); // print all SIP messages
+
+const main = async () => {
+  await softphone.register();
+  await waitFor({ interval: 1000 });
+  // callee format sample: 16506668888, country code is required, otherwise behavior is undefined
+  const callSession = await softphone.call(
+    parseInt(process.env.CALLEE_FOR_TESTING!, 10),
+    // parseInt(process.env.RINGCENTRAL_CALLER_ID!, 10), // Optionally, you can specify callerId as the second parameter
+  );
+
+  // callee answers the call
+  callSession.once('answered', () => {
+    // receive audio
+    const writeStream = fs.createWriteStream(`${callSession.callId}.raw`, { flags: 'a' });
+    callSession.on('audioPacket', (rtpPacket: RtpPacket) => {
+      writeStream.write(rtpPacket.payload);
+    });
+    // either you or the peer hang up
+    callSession.once('disposed', () => {
+      writeStream.close();
+    });
+
+    // send audio
+    callSession.streamAudio(fs.readFileSync('demos/test.raw'));
+
+    // receive DTMF
+    callSession.on('dtmf', (digit) => {
+      console.log('dtmf', digit);
+    });
+
+    // // send DTMF
+    // await waitFor({ interval: 2000 });
+    // callSession.sendDTMF('1');
+    // await waitFor({ interval: 2000 });
+    // callSession.sendDTMF('#');
+
+    // // hang up the call
+    // await waitFor({ interval: 5000 });
+    // callSession.hangup();
+  });
+
+  // // cancel the call (before the peer answers)
+  // await waitFor({ interval: 8000 });
+  // callSession.cancel();
+};
+main();

package/dist/demos/inbound-call.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/demos/inbound-call.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const softphone_1 = __importDefault(require("../src/softphone"));
+// import waitFor from 'wait-for-async';
+const softphone = new softphone_1.default({
+    username: process.env.SIP_INFO_USERNAME,
+    password: process.env.SIP_INFO_PASSWORD,
+    authorizationId: process.env.SIP_INFO_AUTHORIZATION_ID,
+});
+softphone.enableDebugMode(); // print all SIP messages
+const main = () => __awaiter(void 0, void 0, void 0, function* () {
+    yield softphone.register();
+    // detect inbound call
+    softphone.on('invite', (inviteMessage) => __awaiter(void 0, void 0, void 0, function* () {
+        // decline the call
+        // await waitFor({ interval: 1000 });
+        // await softphone.decline(inviteMessage);
+        // answer the call
+        const callSession = yield softphone.answer(inviteMessage);
+        // receive audio
+        const writeStream = fs_1.default.createWriteStream(`${callSession.callId}.raw`, { flags: 'a' });
+        callSession.on('audioPacket', (rtpPacket) => {
+            writeStream.write(rtpPacket.payload);
+        });
+        // either you or the peer hang up
+        callSession.once('disposed', () => {
+            writeStream.close();
+        });
+        // receive DTMF
+        callSession.on('dtmf', (digit) => {
+            console.log('dtmf', digit);
+        });
+        // // send DTMF
+        // await waitFor({ interval: 2000 });
+        // callSession.sendDTMF('1');
+        // await waitFor({ interval: 2000 });
+        // callSession.sendDTMF('#');
+        // // hang up the call
+        // await waitFor({ interval: 5000 });
+        // callSession.hangup();
+    }));
+});
+main();
+//# sourceMappingURL=inbound-call.js.map

package/dist/demos/inbound-call.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbound-call.js","sourceRoot":"","sources":["../../demos/inbound-call.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,4CAAoB;AAGpB,iEAAyC;AACzC,wCAAwC;AAExC,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC;IAC9B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;IACvC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;IACvC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,yBAAyB;CACvD,CAAC,CAAC;AACH,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,yBAAyB;AAEtD,MAAM,IAAI,GAAG,GAAS,EAAE;IACtB,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC3B,sBAAsB;IACtB,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAO,aAAa,EAAE,EAAE;QAC7C,mBAAmB;QACnB,qCAAqC;QACrC,0CAA0C;QAE1C,kBAAkB;QAClB,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE1D,gBAAgB;QAChB,MAAM,WAAW,GAAG,YAAE,CAAC,iBAAiB,CAAC,GAAG,WAAW,CAAC,MAAM,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACtF,WAAW,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,SAAoB,EAAE,EAAE;YACrD,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,iCAAiC;QACjC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;YAChC,WAAW,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,eAAe;QACf,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,eAAe;QACf,qCAAqC;QACrC,6BAA6B;QAC7B,qCAAqC;QACrC,6BAA6B;QAE7B,sBAAsB;QACtB,qCAAqC;QACrC,wBAAwB;IAC1B,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AACF,IAAI,EAAE,CAAC"}

package/dist/demos/outbound-call.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/demos/outbound-call.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const wait_for_async_1 = __importDefault(require("wait-for-async"));
+const softphone_1 = __importDefault(require("../src/softphone"));
+const softphone = new softphone_1.default({
+    username: process.env.SIP_INFO_USERNAME,
+    password: process.env.SIP_INFO_PASSWORD,
+    authorizationId: process.env.SIP_INFO_AUTHORIZATION_ID,
+});
+softphone.enableDebugMode(); // print all SIP messages
+const main = () => __awaiter(void 0, void 0, void 0, function* () {
+    yield softphone.register();
+    yield (0, wait_for_async_1.default)({ interval: 1000 });
+    // callee format sample: 16506668888, country code is required, otherwise behavior is undefined
+    const callSession = yield softphone.call(parseInt(process.env.CALLEE_FOR_TESTING, 10));
+    // callee answers the call
+    callSession.once('answered', () => {
+        // receive audio
+        const writeStream = fs_1.default.createWriteStream(`${callSession.callId}.raw`, { flags: 'a' });
+        callSession.on('audioPacket', (rtpPacket) => {
+            writeStream.write(rtpPacket.payload);
+        });
+        // either you or the peer hang up
+        callSession.once('disposed', () => {
+            writeStream.close();
+        });
+        // send audio
+        callSession.streamAudio(fs_1.default.readFileSync('demos/test.raw'));
+        // receive DTMF
+        callSession.on('dtmf', (digit) => {
+            console.log('dtmf', digit);
+        });
+        // // send DTMF
+        // await waitFor({ interval: 2000 });
+        // callSession.sendDTMF('1');
+        // await waitFor({ interval: 2000 });
+        // callSession.sendDTMF('#');
+        // // hang up the call
+        // await waitFor({ interval: 5000 });
+        // callSession.hangup();
+    });
+    // // cancel the call (before the peer answers)
+    // await waitFor({ interval: 8000 });
+    // callSession.cancel();
+});
+main();
+//# sourceMappingURL=outbound-call.js.map

package/dist/demos/outbound-call.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbound-call.js","sourceRoot":"","sources":["../../demos/outbound-call.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,4CAAoB;AAEpB,oEAAqC;AAErC,iEAAyC;AAEzC,MAAM,SAAS,GAAG,IAAI,mBAAS,CAAC;IAC9B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;IACvC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;IACvC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,yBAAyB;CACvD,CAAC,CAAC;AACH,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,yBAAyB;AAEtD,MAAM,IAAI,GAAG,GAAS,EAAE;IACtB,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC3B,MAAM,IAAA,wBAAO,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAClC,+FAA+F;IAC/F,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,IAAI,CACtC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAmB,EAAE,EAAE,CAAC,CAE9C,CAAC;IAEF,0BAA0B;IAC1B,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;QAChC,gBAAgB;QAChB,MAAM,WAAW,GAAG,YAAE,CAAC,iBAAiB,CAAC,GAAG,WAAW,CAAC,MAAM,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACtF,WAAW,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,SAAoB,EAAE,EAAE;YACrD,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QACH,iCAAiC;QACjC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;YAChC,WAAW,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,aAAa;QACb,WAAW,CAAC,WAAW,CAAC,YAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAE3D,eAAe;QACf,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,eAAe;QACf,qCAAqC;QACrC,6BAA6B;QAC7B,qCAAqC;QACrC,6BAA6B;QAE7B,sBAAsB;QACtB,qCAAqC;QACrC,wBAAwB;IAC1B,CAAC,CAAC,CAAC;IAEH,+CAA+C;IAC/C,qCAAqC;IACrC,wBAAwB;AAC1B,CAAC,CAAA,CAAC;AACF,IAAI,EAAE,CAAC"}

package/dist/src/call-session/inbound.d.ts

@@ -0,0 +1,8 @@
+import { type InboundMessage } from '../sip-message';
+import type Softphone from '../softphone';
+import CallSession from '.';
+declare class InboundCallSession extends CallSession {
+    constructor(softphone: Softphone, inviteMessage: InboundMessage);
+    answer(): Promise<void>;
+}
+export default InboundCallSession;

package/dist/src/call-session/inbound.js

@@ -0,0 +1,48 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sip_message_1 = require("../sip-message");
+const utils_1 = require("../utils");
+const _1 = __importDefault(require("."));
+class InboundCallSession extends _1.default {
+    constructor(softphone, inviteMessage) {
+        super(softphone, inviteMessage);
+        this.localPeer = inviteMessage.headers.To;
+        this.remotePeer = inviteMessage.headers.From;
+    }
+    answer() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const answerSDP = `
+v=0
+o=- ${(0, utils_1.randomInt)()} 0 IN IP4 127.0.0.1
+s=rc-softphone-ts
+c=IN IP4 127.0.0.1
+t=0 0
+m=audio ${(0, utils_1.randomInt)()} RTP/AVP 0 101
+a=rtpmap:0 PCMU/8000
+a=rtpmap:101 telephone-event/8000
+a=fmtp:101 0-15
+a=sendrecv
+a=ssrc:${(0, utils_1.randomInt)()} cname:${(0, utils_1.uuid)()}
+`.trim();
+            const newMessage = new sip_message_1.ResponseMessage(this.sipMessage, 200, {
+                'Content-Type': 'application/sdp',
+            }, answerSDP);
+            this.softphone.send(newMessage);
+            this.startLocalServices();
+        });
+    }
+}
+exports.default = InboundCallSession;
+//# sourceMappingURL=inbound.js.map

package/dist/src/call-session/inbound.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbound.js","sourceRoot":"","sources":["../../../src/call-session/inbound.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAsE;AACtE,oCAA2C;AAE3C,yCAA4B;AAE5B,MAAM,kBAAmB,SAAQ,UAAW;IAC1C,YAAmB,SAAoB,EAAE,aAA6B;QACpE,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEY,MAAM;;YACjB,MAAM,SAAS,GAAG;;MAEhB,IAAA,iBAAS,GAAE;;;;UAIP,IAAA,iBAAS,GAAE;;;;;SAKZ,IAAA,iBAAS,GAAE,UAAU,IAAA,YAAI,GAAE;CACnC,CAAC,IAAI,EAAE,CAAC;YACL,MAAM,UAAU,GAAG,IAAI,6BAAe,CACpC,IAAI,CAAC,UAAU,EACf,GAAG,EACH;gBACE,cAAc,EAAE,iBAAiB;aAClC,EACD,SAAS,CACV,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAEhC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,CAAC;KAAA;CACF;AAED,kBAAe,kBAAkB,CAAC"}

package/dist/src/call-session/index.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import EventEmitter from 'events';
+import dgram from 'dgram';
+import { type InboundMessage } from '../sip-message';
+import type Softphone from '../softphone';
+declare abstract class CallSession extends EventEmitter {
+    softphone: Softphone;
+    sipMessage: InboundMessage;
+    socket: dgram.Socket;
+    localPeer: string;
+    remotePeer: string;
+    remoteIP: string;
+    remotePort: number;
+    disposed: boolean;
+    constructor(softphone: Softphone, sipMessage: InboundMessage);
+    get callId(): string;
+    send(data: string | Buffer): void;
+    hangup(): Promise<void>;
+    sendDTMF(char: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '*' | '#'): Promise<void>;
+    streamAudio(input: Buffer): Promise<void>;
+    protected startLocalServices(): Promise<void>;
+    private dispose;
+}
+export default CallSession;

package/dist/src/call-session/index.js

@@ -0,0 +1,156 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const events_1 = __importDefault(require("events"));
+const dgram_1 = __importDefault(require("dgram"));
+const werift_rtp_1 = require("werift-rtp");
+const sip_message_1 = require("../sip-message");
+const utils_1 = require("../utils");
+const dtmf_1 = __importDefault(require("../dtmf"));
+class CallSession extends events_1.default {
+    constructor(softphone, sipMessage) {
+        super();
+        this.disposed = false;
+        this.softphone = softphone;
+        this.sipMessage = sipMessage;
+        this.remoteIP = this.sipMessage.body.match(/c=IN IP4 ([\d.]+)/)[1];
+        this.remotePort = parseInt(this.sipMessage.body.match(/m=audio (\d+) /)[1], 10);
+    }
+    get callId() {
+        return this.sipMessage.headers['Call-Id'];
+    }
+    send(data) {
+        this.socket.send(data, this.remotePort, this.remoteIP);
+    }
+    hangup() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestMessage = new sip_message_1.RequestMessage(`BYE sip:${this.softphone.sipInfo.domain} SIP/2.0`, {
+                'Call-Id': this.callId,
+                From: this.localPeer,
+                To: this.remotePeer,
+                Via: `SIP/2.0/TCP ${this.softphone.fakeDomain};branch=${(0, utils_1.uuid)()}`,
+            });
+            this.softphone.send(requestMessage);
+        });
+    }
+    sendDTMF(char) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const timestamp = Math.floor(Date.now() / 1000);
+            let sequenceNumber = timestamp % 65536;
+            const rtpHeader = new werift_rtp_1.RtpHeader({
+                version: 2,
+                padding: false,
+                paddingSize: 0,
+                extension: false,
+                marker: false,
+                payloadOffset: 12,
+                payloadType: 101,
+                sequenceNumber,
+                timestamp,
+                ssrc: (0, utils_1.randomInt)(),
+                csrcLength: 0,
+                csrc: [],
+                extensionProfile: 48862,
+                extensionLength: undefined,
+                extensions: [],
+            });
+            for (const payload of dtmf_1.default.charToPayloads(char)) {
+                rtpHeader.sequenceNumber = sequenceNumber++;
+                const rtpPacket = new werift_rtp_1.RtpPacket(rtpHeader, payload);
+                this.send(rtpPacket.serialize());
+            }
+        });
+    }
+    // buffer is the content of a audio file, it is supposed to be PCMU/8000 encoded.
+    // The audio should be playable by command: ffplay -autoexit -f mulaw -ar 8000 test.raw
+    streamAudio(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let buffer = input;
+            let sequenceNumber = (0, utils_1.randomInt)();
+            let timestamp = (0, utils_1.randomInt)();
+            const ssrc = (0, utils_1.randomInt)();
+            const sendPacket = () => {
+                if (buffer.length >= 160) {
+                    const temp = buffer.subarray(0, 160);
+                    buffer = buffer.subarray(160);
+                    const rtpPacket = new werift_rtp_1.RtpPacket(new werift_rtp_1.RtpHeader({
+                        version: 2,
+                        padding: false,
+                        paddingSize: 0,
+                        extension: false,
+                        marker: false,
+                        payloadOffset: 12,
+                        payloadType: 0,
+                        sequenceNumber,
+                        timestamp,
+                        ssrc,
+                        csrcLength: 0,
+                        csrc: [],
+                        extensionProfile: 48862,
+                        extensionLength: undefined,
+                        extensions: [],
+                    }), temp);
+                    if (this.disposed) {
+                        return;
+                    }
+                    this.send(rtpPacket.serialize());
+                    sequenceNumber += 1;
+                    timestamp += 160; // inbound audio use this time interval, in my opinion, it should be 20
+                }
+                setTimeout(() => sendPacket(), 20);
+            };
+            sendPacket();
+        });
+    }
+    startLocalServices() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.socket = dgram_1.default.createSocket('udp4');
+            this.socket.on('message', (message) => {
+                const rtpPacket = werift_rtp_1.RtpPacket.deSerialize(message);
+                this.emit('rtpPacket', rtpPacket);
+                if (rtpPacket.header.payloadType === 101) {
+                    this.emit('dtmfPacket', rtpPacket);
+                    const char = dtmf_1.default.payloadToChar(rtpPacket.payload);
+                    if (char) {
+                        this.emit('dtmf', char);
+                    }
+                }
+                else {
+                    this.emit('audioPacket', rtpPacket);
+                }
+            });
+            this.socket.bind();
+            // send a message to remote server so that it knows where to reply
+            this.send('hello');
+            const byeHandler = (inboundMessage) => {
+                if (inboundMessage.headers['Call-Id'] !== this.callId) {
+                    return;
+                }
+                if (inboundMessage.headers.CSeq.endsWith(' BYE')) {
+                    this.softphone.off('message', byeHandler);
+                    this.dispose();
+                }
+            };
+            this.softphone.on('message', byeHandler);
+        });
+    }
+    dispose() {
+        this.disposed = true;
+        this.emit('disposed');
+        this.socket.removeAllListeners();
+        this.socket.close();
+    }
+}
+exports.default = CallSession;
+//# sourceMappingURL=index.js.map

package/dist/src/call-session/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/call-session/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,kDAA0B;AAC1B,2CAAkD;AAElD,gDAAqE;AAErE,oCAA2C;AAC3C,mDAA2B;AAE3B,MAAe,WAAY,SAAQ,gBAAY;IAU7C,YAAmB,SAAoB,EAAE,UAA0B;QACjE,KAAK,EAAE,CAAC;QAHH,aAAQ,GAAG,KAAK,CAAC;QAItB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAE,CAAC,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAEM,IAAI,CAAC,IAAqB;QAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAEY,MAAM;;YACjB,MAAM,cAAc,GAAG,IAAI,4BAAc,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,UAAU,EAAE;gBAC5F,SAAS,EAAE,IAAI,CAAC,MAAM;gBACtB,IAAI,EAAE,IAAI,CAAC,SAAS;gBACpB,EAAE,EAAE,IAAI,CAAC,UAAU;gBACnB,GAAG,EAAE,eAAe,IAAI,CAAC,SAAS,CAAC,UAAU,WAAW,IAAA,YAAI,GAAE,EAAE;aACjE,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;KAAA;IAEY,QAAQ,CAAC,IAA2E;;YAC/F,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;YAChD,IAAI,cAAc,GAAG,SAAS,GAAG,KAAK,CAAC;YACvC,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC;gBAC9B,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,CAAC;gBACd,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,KAAK;gBACb,aAAa,EAAE,EAAE;gBACjB,WAAW,EAAE,GAAG;gBAChB,cAAc;gBACd,SAAS;gBACT,IAAI,EAAE,IAAA,iBAAS,GAAE;gBACjB,UAAU,EAAE,CAAC;gBACb,IAAI,EAAE,EAAE;gBACR,gBAAgB,EAAE,KAAK;gBACvB,eAAe,EAAE,SAAS;gBAC1B,UAAU,EAAE,EAAE;aACf,CAAC,CAAC;YACH,KAAK,MAAM,OAAO,IAAI,cAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,SAAS,CAAC,cAAc,GAAG,cAAc,EAAE,CAAC;gBAC5C,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBACpD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;KAAA;IAED,iFAAiF;IACjF,uFAAuF;IAC1E,WAAW,CAAC,KAAa;;YACpC,IAAI,MAAM,GAAG,KAAK,CAAC;YACnB,IAAI,cAAc,GAAG,IAAA,iBAAS,GAAE,CAAC;YACjC,IAAI,SAAS,GAAG,IAAA,iBAAS,GAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAA,iBAAS,GAAE,CAAC;YACzB,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;oBACzB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;oBACrC,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;oBAC9B,MAAM,SAAS,GAAG,IAAI,sBAAS,CAC7B,IAAI,sBAAS,CAAC;wBACZ,OAAO,EAAE,CAAC;wBACV,OAAO,EAAE,KAAK;wBACd,WAAW,EAAE,CAAC;wBACd,SAAS,EAAE,KAAK;wBAChB,MAAM,EAAE,KAAK;wBACb,aAAa,EAAE,EAAE;wBACjB,WAAW,EAAE,CAAC;wBACd,cAAc;wBACd,SAAS;wBACT,IAAI;wBACJ,UAAU,EAAE,CAAC;wBACb,IAAI,EAAE,EAAE;wBACR,gBAAgB,EAAE,KAAK;wBACvB,eAAe,EAAE,SAAS;wBAC1B,UAAU,EAAE,EAAE;qBACf,CAAC,EACF,IAAI,CACL,CAAC;oBACF,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAClB,OAAO;oBACT,CAAC;oBACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC;oBACjC,cAAc,IAAI,CAAC,CAAC;oBACpB,SAAS,IAAI,GAAG,CAAC,CAAC,uEAAuE;gBAC3F,CAAC;gBACD,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;YACrC,CAAC,CAAC;YACF,UAAU,EAAE,CAAC;QACf,CAAC;KAAA;IAEe,kBAAkB;;YAChC,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBACpC,MAAM,SAAS,GAAG,sBAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBAClC,IAAI,SAAS,CAAC,MAAM,CAAC,WAAW,KAAK,GAAG,EAAE,CAAC;oBACzC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;oBACnC,MAAM,IAAI,GAAG,cAAI,CAAC,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;oBACnD,IAAI,IAAI,EAAE,CAAC;wBACT,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC1B,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACnB,kEAAkE;YAClE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEnB,MAAM,UAAU,GAAG,CAAC,cAA8B,EAAE,EAAE;gBACpD,IAAI,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;oBACtD,OAAO;gBACT,CAAC;gBACD,IAAI,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBACjD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;oBAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,CAAC;YACH,CAAC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEO,OAAO;QACb,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtB,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;CACF;AAED,kBAAe,WAAW,CAAC"}

package/dist/src/call-session/outbound.d.ts

@@ -0,0 +1,9 @@
+import { type InboundMessage } from '../sip-message';
+import type Softphone from '../softphone';
+import CallSession from '.';
+declare class OutboundCallSession extends CallSession {
+    constructor(softphone: Softphone, answerMessage: InboundMessage);
+    init(): Promise<void>;
+    cancel(): Promise<void>;
+}
+export default OutboundCallSession;

package/dist/src/call-session/outbound.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sip_message_1 = require("../sip-message");
+const _1 = __importDefault(require("."));
+const utils_1 = require("../utils");
+class OutboundCallSession extends _1.default {
+    constructor(softphone, answerMessage) {
+        super(softphone, answerMessage);
+        this.localPeer = answerMessage.headers.From;
+        this.remotePeer = answerMessage.headers.To;
+        this.init();
+    }
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // wait for user to answer the call
+            const answerHandler = (message) => {
+                if (message.headers.CSeq === this.sipMessage.headers.CSeq) {
+                    this.softphone.off('message', answerHandler);
+                    this.emit('answered');
+                }
+            };
+            this.softphone.on('message', answerHandler);
+            this.once('answered', () => __awaiter(this, void 0, void 0, function* () { return this.startLocalServices(); }));
+        });
+    }
+    cancel() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestMessage = new sip_message_1.RequestMessage(`CANCEL ${(0, utils_1.extractAddress)(this.remotePeer)} SIP/2.0`, {
+                'Call-Id': this.callId,
+                From: this.localPeer,
+                To: (0, utils_1.withoutTag)(this.remotePeer),
+                Via: this.sipMessage.headers.Via,
+                CSeq: this.sipMessage.headers.CSeq.replace(' INVITE', ' CANCEL'),
+            });
+            this.softphone.send(requestMessage);
+        });
+    }
+}
+exports.default = OutboundCallSession;
+//# sourceMappingURL=outbound.js.map

package/dist/src/call-session/outbound.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbound.js","sourceRoot":"","sources":["../../../src/call-session/outbound.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAqE;AAErE,yCAA4B;AAC5B,oCAAsD;AAEtD,MAAM,mBAAoB,SAAQ,UAAW;IAC3C,YAAmB,SAAoB,EAAE,aAA6B;QACpE,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC;QAC5C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAEY,IAAI;;YACf,mCAAmC;YACnC,MAAM,aAAa,GAAG,CAAC,OAAuB,EAAE,EAAE;gBAChD,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;oBAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;oBAC7C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAE5C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAS,EAAE,gDAAC,OAAA,IAAI,CAAC,kBAAkB,EAAE,CAAA,GAAA,CAAC,CAAC;QAC/D,CAAC;KAAA;IAEY,MAAM;;YACjB,MAAM,cAAc,GAAG,IAAI,4BAAc,CAAC,UAAU,IAAA,sBAAc,EAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;gBAC7F,SAAS,EAAE,IAAI,CAAC,MAAM;gBACtB,IAAI,EAAE,IAAI,CAAC,SAAS;gBACpB,EAAE,EAAE,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,CAAC;gBAC/B,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG;gBAChC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC;aACjE,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;KAAA;CACF;AAED,kBAAe,mBAAmB,CAAC"}