sip-lab 1.8.0 → 1.11.0

package/README.md

@@ -5,6 +5,12 @@
 A nodejs module that helps to write functional tests for SIP systems (including media operations).
 It uses pjproject for SIP and media processing.
 
+It permits to:
+  - send and receive DTMF inband/RFC2833/INFO.
+  - play/record wav file on a call
+  - send/receive fax (T.30 only)
+
+
 ### Installation
 
 This will require for you to have some libraries installed. So do:
@@ -24,26 +30,34 @@ Then install sip-lab by doing:
   npm install sip-lab
 ```
 
-However, since it takes a long time to fetch and build pjproject and the node addon for it, you could install sip-lab globally:
+To test from within this repo just build and install by doing:
 ```
-  npm install -g sip-lab
+  npm install -g node-gyp
+  npm install --unsafe-perm
 ```
-
-But if you do so, you will need to set NODE_PATH for node to find it by doing:
+And run some sample script from subfolder samples:
 ```
-  export NODE_PATH=$(npm root --quiet -g)
+  node samples/simple.js
 ```
 
-To test from within this repo just run:
+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 is known to not work with node v.8)
+
+
+Since running
 ```
-  npm install -g node-gyp
-  npm install --unsafe-perm
+npm install sip-lab
+```
+takes some time to fetch and build pjproject and the node addon for it, you could install sip-lab globally:
 
-  node samples/simple.js
+```
+  npm install -g sip-lab
 ```
 
-The module is known to work properly in Ubuntu 18.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 is known to not work with node v.8)
+But if you do so, you will need to set NODE_PATH for node to find it by doing:
+```
+  export NODE_PATH=$(npm root --quiet -g)
+```
 
 

package/binding.gyp

@@ -14,6 +14,7 @@
         'src/pjmedia/src/chainlink/chainlink_wav_player.c',
         'src/pjmedia/src/chainlink/chainlink_wav_writer.c',
         'src/pjmedia/src/chainlink/chainlink_wire_port.c',
+        'src/pjmedia/src/chainlink/chainlink_fax.c',
       ],
       'include_dirs': [
         "pjproject/pjsip/include",

package/index.js

@@ -59,6 +59,8 @@ addon.call = {
   start_playing: addon.call_start_play_wav,
   stop_recording: addon.call_stop_record_wav,
   stop_playing: addon.call_stop_play_wav,
+  start_fax: addon.call_start_fax,
+  stop_fax: addon.call_stop_fax,
   get_stream_stat: addon.call_get_stream_stat,
   refer: addon.call_refer,
   get_info: addon.call_get_info,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.8.0",
+  "version": "1.11.0",
   "description": "",
   "main": "index.js",
   "engines": {

package/samples/g729.js

@@ -182,8 +182,6 @@ async function test() {
         },
     ], 1000)
 
-    await z.sleep(1000)
-
     console.log("Success")
 
     sip.stop()

package/samples/late_negotiation.js

@@ -208,8 +208,6 @@ async function test() {
         },
     ], 500)
 
-    await z.sleep(100)
-
     sip.call.reinvite(oc.id, false, flags)
 
     await z.wait([
@@ -275,8 +273,6 @@ async function test() {
         },
     ], 1000)
 
-    await z.sleep(1000)
-
     console.log("Success")
 
     sip.stop()

package/samples/reinvite_and_dtmf.js

@@ -0,0 +1,291 @@
+var sip = require ('../index.js')
+var Zester = require('zester')
+var z = new Zester()
+var m = require('data-matching')
+var sip_msg = require('sip-matching')
+
+async function test() {
+    //sip.set_log_level(6)
+    sip.dtmf_aggregation_on(500)
+
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    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)
+
+    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')
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+                '$(hdrcnt(via))': 1,
+                '$hdr(call-id)': m.collect('sip_call_id'),
+                $fU: 'a',
+                $fd: 't',
+                $tU: 'b',
+                '$hdr(l)': '0',
+            }),
+        },
+    ], 1000)
+
+    ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, 200, 'OK')
+
+    await z.wait([
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                '$(hdrcnt(VIA))': 1,
+                $fU: 'a',
+                $fd: 't',
+                $tU: 'b',
+                '$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)
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+        {
+            event: 'dtmf',
+            call_id: oc.id,
+            digits: '4321',
+            mode: 1,
+        },
+    ], 2000)
+
+
+    sip.call.reinvite(oc.id, true, 0)
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                $rb: '!{_}a=recvonly',
+            }),
+        },
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendonly',
+            remote_mode: 'recvonly',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'recvonly',
+            remote_mode: 'sendonly',
+        },
+    ], 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
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+    ], 2000)
+
+    sip.call.reinvite(ic.id, false, 0)
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: ic.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                $rb: '!{_}a=sendonly',
+            }),
+        },
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendonly',
+            remote_mode: 'recvonly',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'recvonly',
+            remote_mode: 'sendonly',
+        },
+    ], 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
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+    ], 2000)
+
+    sip.call.send_request(oc.id, 'INFO')
+
+    await z.wait([
+        {
+            event: 'request',
+            call_id: ic.id,
+            msg: sip_msg({
+                $rm: 'INFO',
+            }),
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INFO',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+    ], 500)
+
+    sip.call.reinvite(oc.id, false, 0)
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                $rb: '!{_}a=sendrecv',
+            }),
+        },
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+    ], 500)
+
+    sip.call.send_dtmf(oc.id, '1234', 0)
+    sip.call.send_dtmf(ic.id, '4321', 1)
+
+    await z.wait([
+        {
+            event: 'dtmf',
+            call_id: ic.id,
+            digits: '1234',
+            mode: 0,
+        },
+        {
+            event: 'dtmf',
+            call_id: oc.id,
+            digits: '4321',
+            mode: 1,
+        },
+    ], 2000)
+
+    sip.call.terminate(oc.id)
+
+    await z.wait([
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+    ], 1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+

package/samples/send_and_receive_fax.js

@@ -0,0 +1,143 @@
+var sip = require ('../index.js')
+var Zester = require('zester')
+var z = new Zester()
+var m = require('data-matching')
+var sip_msg = require('sip-matching')
+
+async function test() {
+    //sip.set_log_level(6)
+    sip.dtmf_aggregation_on(500)
+
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    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)
+
+    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')
+
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '100',
+                $rr: 'Trying',
+                '$(hdrcnt(via))': 1,
+                '$hdr(call-id)': m.collect('sip_call_id'),
+                $fU: 'a',
+                $fd: 't',
+                $tU: 'b',
+                '$hdr(l)': '0',
+            }),
+        },
+    ], 1000)
+
+    ic = {
+        id: z.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, 200, 'OK')
+
+    await z.wait([
+        {
+            event: 'media_status',
+            call_id: oc.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'media_status',
+            call_id: ic.id,
+            status: 'setup_ok',
+            local_mode: 'sendrecv',
+            remote_mode: 'sendrecv',
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                '$(hdrcnt(VIA))': 1,
+                $fU: 'a',
+                $fd: 't',
+                $tU: 'b',
+                '$hdr(content-type)': 'application/sdp',
+                $rb: '!{_}a=sendrecv',
+            }),
+        },
+    ], 1000)
+
+    await z.sleep(1000)
+
+    var is_sender = true
+
+    sip.call.start_fax(oc.id, is_sender, 'samples/fax_doc.tiff')
+    await z.sleep(100)
+    sip.call.start_fax(ic.id, !is_sender, 'received.tiff')
+
+    await z.wait([
+        {
+            event: 'fax_result',
+            call_id: oc.id,
+            result: 0,
+        },
+        {
+            event: 'fax_result',
+            call_id: ic.id,
+            result: 0,
+        },
+    ], 60 * 1000)
+
+    sip.call.terminate(oc.id)
+
+    await z.wait([
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+    ], 1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+