sip-lab 1.11.2 → 1.12.1

package/README.md

@@ -6,14 +6,19 @@ A nodejs module that helps to write functional tests for SIP systems (including
 It uses pjproject for SIP and media processing.
 
 It permits to:
+  - make audio calls using UDP, TCP and TLS transports
   - send and receive DTMF inband/RFC2833/INFO.
   - play/record wav file on a call
   - send/receive fax (T.30 only)
 
+TODO:
+  - add suport for T.38 fax
+  - add support for WebRTC
+  - add support for video playing/recording from/to file
 
 ### Installation
 
-This will require for you to have some libraries installed. So do:
+This will require you to have some libraries installed. So do:
 ```
 apt install build-essential automake autoconf libtool libspeex-dev libopus-dev libsdl2-dev libavdevice-dev libswscale-dev libv4l-dev libopencore-amrnb-dev libopencore-amrwb-dev libvo-amrwbenc-dev libopus-dev libsdl2-dev libopencore-amrnb-dev libopencore-amrwb-dev libvo-amrwbenc-dev libboost-dev libspandsp-dev libpcap-dev libssl-dev uuid-dev
 ```
@@ -33,7 +38,7 @@ Then install sip-lab by doing:
 To test from within this repo just build and install by doing:
 ```
   npm install -g node-gyp
-  npm install --unsafe-perm
+  npm install
 ```
 And run some sample script from subfolder samples:
 ```
@@ -41,7 +46,7 @@ And run some sample script from subfolder samples:
 ```
 
 The module is known to work properly in Ubuntu 18.04.4, Ubuntu 20.04.4, Debian 8 and Debian 10 (and it is expected to work in Debian 9).
-It was originally developed with node v.10 and tested with v.12 and it is expected to work with latest versions of node.
+It was originally developed with node v.10 and tested with v.12 and v16.13.1 and it is expected to work with latest versions of node.
 (it is known to not work with node v.8)
 
 

package/binding.gyp

@@ -26,6 +26,7 @@
         "src/pjmedia/include",
         "src/pjmedia/include/pjmedia",
         "src/pjmedia/include/chainlink",	
+        "rapidjson/include",
         "<!@(node -p \"require('node-addon-api').include\")",
       ],
       "dependencies": [

package/index.js

@@ -39,32 +39,42 @@ addon.stop = () => {
 }
 
 addon.transport = {
-  create: addon.transport_create,
+  create: (params) => { return addon.transport_create(JSON.stringify(params)) },
 }
 
 addon.account = {
-  create: addon.account_create,
-  register: addon.account_register,
+  create: (t_id, params) => { return addon.account_create(t_id, JSON.stringify(params)) },
+  register: (a_id, params) => { return addon.account_register(a_id, JSON.stringify(params ? params : {})) },
   unregister: addon.account_unregister,
 }
 
 addon.call = {
-  create: addon.call_create,
-  respond: addon.call_respond,
-  terminate: addon.call_terminate,
-  send_dtmf: addon.call_send_dtmf,
-  reinvite: addon.call_reinvite,
-  send_request: addon.call_send_request,
-  start_recording: addon.call_start_record_wav,
-  start_playing: addon.call_start_play_wav,
+  create: (t_id, params) => { return addon.call_create(t_id, JSON.stringify(params)) },
+  respond: (c_id, params) => { return addon.call_respond(c_id, JSON.stringify(params)) },
+  terminate: (c_id, params) => { return addon.call_terminate(c_id, JSON.stringify(params ? params : {})) },
+  send_dtmf: (c_id, params) => { return addon.call_send_dtmf(c_id, JSON.stringify(params)) },
+  reinvite: (c_id, params) => { return addon.call_reinvite(c_id, JSON.stringify(params ? params : {})) },
+  send_request: (c_id, params) => { return addon.call_send_request(c_id, JSON.stringify(params)) },
+  start_recording: (c_id, params) => { return addon.call_start_record_wav(c_id, JSON.stringify(params)) },
+  start_playing: (c_id, params) => { return addon.call_start_play_wav(c_id, JSON.stringify(params)) },
   stop_recording: addon.call_stop_record_wav,
   stop_playing: addon.call_stop_play_wav,
-  start_fax: addon.call_start_fax,
+  start_fax: (c_id, params) => { return addon.call_start_fax(c_id, JSON.stringify(params)) },
   stop_fax: addon.call_stop_fax,
   get_stream_stat: addon.call_get_stream_stat,
-  refer: addon.call_refer,
+  refer: (c_id, params) => { return addon.call_refer(c_id, JSON.stringify(params)) },
   get_info: addon.call_get_info,
   gen_string_replaces: addon.call_gen_string_replaces,
 }
 
+addon.subscriber = {
+    notify: (s_id, params) => { return addon.notify(s_id, JSON.stringify(params)) },
+    notify_xfer: (s_id, params) => { return addon.notify_xfer(s_id, JSON.stringify(params)) },
+}
+
+addon.subscription = {
+    create: (t_id, params) => { return addon.subscription_create(t_id, JSON.stringify(params)) },
+    subscribe: (s_id, params) => { return addon.subscription_subscribe(s_id, JSON.stringify(params)) },
+}
+
 module.exports = addon;

package/install.sh

@@ -4,6 +4,8 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
+START_DIR=`pwd`
+
 if [[ ! -d pjproject ]]
 then
 	git clone https://github.com/pjsip/pjproject
@@ -24,10 +26,19 @@ EOF
 #define PJMEDIA_HAS_SRTP  0
 EOF
 	make dep && make clean && make
+fi
+
+cd $START_DIR
 
-	cd ..
+if [[ ! -d rapidjson ]]
+then
+	git clone https://github.com/Tencent/rapidjson
+	cd rapidjson
+	git checkout 27c3a8dc0e2c9218fe94986d249a12b5ed838f1d
 fi
 
+cd $START_DIR
+
 node-gyp configure
 
 node-gyp build

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.11.2",
+  "version": "1.12.1",
   "description": "",
   "main": "index.js",
   "engines": {
@@ -18,6 +18,7 @@
   "gypfile": true,
   "homepage": "https://github.com/MayamaTakeshi/sip-lab",
   "dependencies": {
+    "-": "^0.0.1",
     "node-addon-api": "^1.7.2",
     "node-gyp": "^8.4.1"
   },

package/samples/{late_negotiation.js → delayed_media.js}

@@ -15,15 +15,13 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
 
-    flags = 1 // late negotiation
-
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`, delayed_media: true})
 
     await z.wait([
         {
@@ -39,9 +37,9 @@ async function test() {
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
                 '$hdr(call-id)': m.collect('sip_call_id'),
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(l)': '0',
             }),
         },
@@ -52,7 +50,7 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    sip.call.respond(ic.id, 200, 'OK')
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
 
     await z.wait([
         {
@@ -77,17 +75,17 @@ async function test() {
                 $rs: '200',
                 $rr: 'OK',
                 '$(hdrcnt(VIA))': 1,
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(content-type)': 'application/sdp',
                 $rb: '!{_}a=sendrecv',
             }),
         },
     ], 1000)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1)
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
     await z.wait([
         {
@@ -105,7 +103,7 @@ async function test() {
     ], 2000)
 
 
-    sip.call.reinvite(oc.id, true, flags)
+    sip.call.reinvite(oc.id, {hold: true, delayed_media: true})
 
     await z.wait([
         {
@@ -134,8 +132,8 @@ async function test() {
         },
     ], 500)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1) // This will not generate event 'dtmf'
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1}) // This will not generate event 'dtmf'
 
     await z.wait([
         {
@@ -146,7 +144,7 @@ async function test() {
         },
     ], 2000)
 
-    sip.call.reinvite(ic.id, false, flags)
+    sip.call.reinvite(ic.id, {hold: false, delayed_media: true})
 
     await z.wait([
         {
@@ -175,8 +173,8 @@ async function test() {
         },
     ], 500)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1) // This will not generate event 'dtmf'
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1}) // This will not generate event 'dtmf'
 
     await z.wait([
         {
@@ -187,7 +185,7 @@ async function test() {
         },
     ], 2000)
 
-    sip.call.send_request(oc.id, 'INFO')
+    sip.call.send_request(oc.id, {method: 'INFO'})
 
     await z.wait([
         {
@@ -208,7 +206,7 @@ async function test() {
         },
     ], 500)
 
-    sip.call.reinvite(oc.id, false, flags)
+    sip.call.reinvite(oc.id, {hold: false, delayed_media: true})
 
     await z.wait([
         {
@@ -238,8 +236,8 @@ async function test() {
     ], 500)
 
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1) // This will not generate event 'dtmf'
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1}) // This will not generate event 'dtmf'
 
     await z.wait([
         {
@@ -250,7 +248,6 @@ async function test() {
         },
     ], 2000)
 
-
     sip.call.terminate(oc.id)
 
     await z.wait([

package/samples/g729.js

@@ -17,8 +17,8 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
@@ -27,7 +27,7 @@ async function test() {
 
     flags = 0
 
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`})
 
     await z.wait([
         {
@@ -43,9 +43,9 @@ async function test() {
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
                 '$hdr(call-id)': m.collect('sip_call_id'),
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(l)': '0',
             }),
         },
@@ -56,7 +56,7 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    sip.call.respond(ic.id, 200, 'OK')
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
 
     await z.wait([
         {
@@ -81,16 +81,16 @@ async function test() {
                 $rs: '200',
                 $rr: 'OK',
                 '$(hdrcnt(VIA))': 1,
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(content-type)': 'application/sdp',
                 $rb: '!{_}a=sendrecv',
             }),
         },
     ], 1000)
 
-    sip.call.reinvite(oc.id, true, 0)
+    sip.call.reinvite(oc.id, {hold: true})
 
     await z.wait([
         {

package/samples/register_subscribe.js

@@ -15,18 +15,27 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
 
-    var server = `${t2.ip}:${t2.port}`
+    var server = `${t2.address}:${t2.port}`
     var domain = 'test1.com'
 
-    var a1 = sip.account.create(t1.id, domain, server, 'user1', 'pass1')
+    var a1 = sip.account.create(t1.id, {
+        domain, 
+        server,
+        username: 'user1',
+        password: 'pass1',
+        headers: {
+            'X-MyHeader1': 'aaa',
+            'X-MyHeader2': 'bbb',
+        },
+    })
 
-    sip.account.register(a1, true)
+    sip.account.register(a1, {auto_register: true})
 
     await z.wait([
         {
@@ -37,6 +46,8 @@ async function test() {
                 $fd: domain,
                 $tU: 'user1',
                 $td: domain,
+                '$hdr(X-MyHeader1)': 'aaa',
+                '$hdr(X-MyHeader2)': 'bbb',
             }),
         },
     ], 1000)
@@ -53,9 +64,21 @@ async function test() {
         },
     ], 1000)
 
-    const s1 = sip.subscription_create(t1.id, 'dialog', 'application/dialog-info+xml', '<sip:user1@test1.com>', '<sip:user1@test1.com>', 'sip:park1@test1.com', `sip:${server}`, 'test1.com', 'user1', 'user1')
+    const s1 = sip.subscription.create(t1.id, {
+            event: 'dialog',
+            accept: 'application/dialog-info+xml',
+            from_uri: '<sip:user1@test1.com>',
+            to_uri: '<sip:user1@test1.com>',
+            request_uri: 'sip:park1@test1.com',
+            proxy_uri: `sip:${server}`,
+            auth: {
+                realm: 'test1.com',
+                username: 'user1',
+                password: 'user1',
+            },
+    })
 
-    sip.subscription_subscribe(s1, 120)
+    sip.subscription.subscribe(s1, {expires: 120})
 
     await z.wait([
         {

package/samples/reinvite_and_dtmf.js

@@ -15,15 +15,13 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
 
-    flags = 0
-
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`})
 
     await z.wait([
         {
@@ -39,9 +37,9 @@ async function test() {
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
                 '$hdr(call-id)': m.collect('sip_call_id'),
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(l)': '0',
             }),
         },
@@ -52,7 +50,7 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    sip.call.respond(ic.id, 200, 'OK')
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
 
     await z.wait([
         {
@@ -77,17 +75,17 @@ async function test() {
                 $rs: '200',
                 $rr: 'OK',
                 '$(hdrcnt(VIA))': 1,
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(content-type)': 'application/sdp',
                 $rb: '!{_}a=sendrecv',
             }),
         },
     ], 1000)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1)
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
     await z.wait([
         {
@@ -105,7 +103,7 @@ async function test() {
     ], 2000)
 
 
-    sip.call.reinvite(oc.id, true, 0)
+    sip.call.reinvite(oc.id, {hold: true})
 
     await z.wait([
         {
@@ -134,8 +132,8 @@ async function test() {
         },
     ], 500)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1) // this will not generate event 'dtmf' as the call is on hold
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1}) // this will not generate event 'dtmf' as the call is on hold
 
     await z.wait([
         {
@@ -146,7 +144,7 @@ async function test() {
         },
     ], 2000)
 
-    sip.call.reinvite(ic.id, false, 0)
+    sip.call.reinvite(ic.id, {hold: false})
 
     await z.wait([
         {
@@ -175,8 +173,8 @@ async function test() {
         },
     ], 500)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1) // this will not generate event 'dtmf' as the call is on hold
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1}) // this will not generate event 'dtmf' as the call is on hold
 
     await z.wait([
         {
@@ -187,7 +185,7 @@ async function test() {
         },
     ], 2000)
 
-    sip.call.send_request(oc.id, 'INFO')
+    sip.call.send_request(oc.id, {method: 'INFO'})
 
     await z.wait([
         {
@@ -208,7 +206,7 @@ async function test() {
         },
     ], 500)
 
-    sip.call.reinvite(oc.id, false, 0)
+    sip.call.reinvite(oc.id, {hold: false})
 
     await z.wait([
         {
@@ -237,8 +235,8 @@ async function test() {
         },
     ], 500)
 
-    sip.call.send_dtmf(oc.id, '1234', 0)
-    sip.call.send_dtmf(ic.id, '4321', 1)
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
     await z.wait([
         {

package/samples/send_and_receive_fax.js

@@ -15,15 +15,13 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
 
-    flags = 0
-
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    oc = sip.call.create(t1.id, {from_uri: 'sip:a@t', to_uri: 'sip:b@127.0.0.1:5092'})
 
     await z.wait([
         {
@@ -52,7 +50,7 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    sip.call.respond(ic.id, 200, 'OK')
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
 
     await z.wait([
         {
@@ -88,13 +86,11 @@ async function test() {
 
     await z.sleep(1000)
 
-    var is_sender = true
-
     var in_file = 'samples/artifacts/this-is-never-ok.tiff'
     var out_file = "received.tiff"
 
-    sip.call.start_fax(oc.id, is_sender, in_file)
-    sip.call.start_fax(ic.id, !is_sender, out_file)
+    sip.call.start_fax(oc.id, {is_sender: true, file: in_file})
+    sip.call.start_fax(ic.id, {is_sender: false, file: out_file})
 
     await z.wait([
         {
@@ -131,7 +127,7 @@ async function test() {
         },
     ], 1000)
 
-    console.log(`Success. Fax was transmitted as ${in_file} and received as ${out_file}`)
+    console.log(`Success. Fax file ${in_file} was transmitted and received as ${out_file}`)
 
     sip.stop()
 }

package/samples/simple.js

@@ -15,15 +15,13 @@ async function test() {
 
     console.log(sip.start((data) => { console.log(data)} ))
 
-    t1 = sip.transport.create("127.0.0.1", 5090, 1)
-    t2 = sip.transport.create("127.0.0.1", 5092, 1)
+    t1 = sip.transport.create({address: "127.0.0.1", port: 5090, type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", port: 5092, type: 'udp'})
 
     console.log("t1", t1)
     console.log("t2", t2)
 
-    flags = 0
-
-    oc = sip.call.create(t1.id, flags, 'sip:a@t', 'sip:b@127.0.0.1:5092')
+    oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`})
 
     await z.wait([
         {
@@ -39,9 +37,9 @@ async function test() {
                 $rr: 'Trying',
                 '$(hdrcnt(via))': 1,
                 '$hdr(call-id)': m.collect('sip_call_id'),
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(l)': '0',
             }),
         },
@@ -52,7 +50,7 @@ async function test() {
         sip_call_id: z.store.sip_call_id,
     }
 
-    sip.call.respond(ic.id, 200, 'OK')
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
 
     await z.wait([
         {
@@ -77,9 +75,9 @@ async function test() {
                 $rs: '200',
                 $rr: 'OK',
                 '$(hdrcnt(VIA))': 1,
-                $fU: 'a',
-                $fd: 't',
-                $tU: 'b',
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
                 '$hdr(content-type)': 'application/sdp',
                 $rb: '!{_}a=sendrecv',
             }),