sip-lab 1.37.0 → 1.39.0

package/DEV.md

@@ -6,7 +6,7 @@ Basic tasks for development:
 
 #### To build
 ```
-sudo 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 libvo-amrwbenc-dev libboost-dev libtiff-dev libpcap-dev libssl-dev uuid-dev cmake
+sudo 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 libvo-amrwbenc-dev libboost-dev libtiff-dev libpcap-dev libssl-dev uuid-dev cmake flite-dev
 
 npm install
 ```
@@ -73,7 +73,7 @@ If it fails due to proxy problems, check if you have proxy configured in ~/.dock
 
 ```
 
-After the message is built you can pass them to prebuildify-cross:
+After the image is built you can pass them to prebuildify-cross:
 ```
 nvm use v16.13.1
 npx prebuildify-cross -i mayamatakeshi/sip-lab-debian11:latest -t 15.0.0 -t 16.0.0 -t 17.0.0 -t 18.0.0 -t 19.0.0 -t 20.0.0 -t 21.0.0 --strip

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.37.0",
+  "version": "1.39.0",
   "description": "",
   "main": "index.js",
   "engines": {
@@ -21,7 +21,7 @@
   "gypfile": true,
   "homepage": "https://github.com/MayamaTakeshi/sip-lab",
   "dependencies": {
-    "@mayama/zeq": "^4.21.0",
+    "@mayama/zeq": "^4.23.0",
     "data-matching": "^1.47.1",
     "mrcp": "^1.4.0",
     "mrcp-matching": "^1.3.0",

package/samples/100_calls.js

@@ -51,7 +51,7 @@ async function test() {
     })).value(), 50000)
 
     // Now we answer the calls
-    z.store.ic_ids.forEach(ic_id => { 
+    z.$ic_ids.forEach(ic_id => { 
         sip.call.respond(ic_id, {code: 200, reason: 'OK'})
     })
 
@@ -72,7 +72,7 @@ async function test() {
         status: 'ok',
     })).value())
     
-    events = events.concat(_.chain(z.store.ic_ids).map(ic_id => ({
+    events = events.concat(_.chain(z.$ic_ids).map(ic_id => ({
         event: 'media_update',
         call_id: ic_id,
         status: 'ok',
@@ -89,7 +89,7 @@ async function test() {
         sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     })
 
-    await z.wait(_.chain(z.store.ic_ids).map(ic_id => ({
+    await z.wait(_.chain(z.$ic_ids).map(ic_id => ({
         event: 'dtmf',
         call_id: ic_id,
         digits: '1234',
@@ -98,7 +98,7 @@ async function test() {
     })).value(), 50000)
 
     // now send inband DTMF digits
-    z.store.ic_ids.forEach(ic_id => {
+    z.$ic_ids.forEach(ic_id => {
         sip.call.send_dtmf(ic_id, {digits: '4321', mode: 1})
     })
 
@@ -131,7 +131,7 @@ async function test() {
         call_id: oc.id,
     })).value())
 
-    events = events.concat(_.chain(z.store.ic_ids).map(ic_id => ({
+    events = events.concat(_.chain(z.$ic_ids).map(ic_id => ({
         event: 'call_ended',
         call_id: ic_id,
     })).value())

package/samples/16_audio_streams.js

@@ -59,8 +59,8 @@ async function test() {
     // Here we store data for the incoming call
     // just to organize our code (not really needed)
     const ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     // Now we answer the call at t2 side and accept all 16 streams

package/samples/183_session_progress.js

@@ -42,8 +42,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 183, reason: 'Session Progress', media: 'audio,audio'})

package/samples/custom_call_id.js

@@ -66,8 +66,8 @@ async function test() {
  
 
     var ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {
@@ -111,7 +111,7 @@ async function test() {
         },
     })
 
-    delete z.store.call_id
+    delete z.$call_id
 
     await z.wait([
         {
@@ -141,8 +141,8 @@ async function test() {
     ], 1000)
  
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {

package/samples/delayed_media.js

@@ -41,8 +41,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK'})

package/samples/four_audio_streams_two_refused.js

@@ -53,8 +53,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK', media: [

package/samples/g729.js

@@ -47,8 +47,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK'})

package/samples/media_fields.js

@@ -106,8 +106,8 @@ async function test() {
     // Here we store data for the incoming call
     // just to organize our code (not really needed)
     const ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     // Now we answer the call at t2 side sending custom headers.

package/samples/mrcp_and_audio.js

@@ -87,8 +87,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {
@@ -163,7 +163,7 @@ async function test() {
         },
     ], 1000)
 
-    var mrcp_channel = z.store.mrcp_channel
+    var mrcp_channel = z.$mrcp_channel
     var request_id = 1;
     var msg = mrcp.builder.build_request('SPEAK', request_id, {'channel-identifier': mrcp_channel, 'content-type': 'application/xml'}, "<root>test</root>")
 

package/samples/mrcp_and_audio.no_rest_between_msgs.js

@@ -0,0 +1,254 @@
+var sip = require ('../index.js')
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
+var m = require('data-matching')
+var sip_msg = require('sip-matching')
+var sdp = require('sdp-matching')
+var mrcp = require('mrcp')
+var mrcp_msg = require('mrcp-matching')
+
+async function test() {
+    sip.set_log_level(9)
+
+    //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)} ))
+
+    var t1 = sip.transport.create({address: "127.0.0.1", type: 'udp'})
+    var t2 = sip.transport.create({address: "127.0.0.1", type: 'udp'})
+
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    var client_media = [
+        {
+            type: 'mrcp', 
+            fields: [
+                'a=setup:active',
+                'a=connection:new',
+                'a=resource:speechsynth',
+                'a=cmid:1',
+            ],
+        },
+        {
+            type: 'audio',
+            fields: [
+                'a=recvonly',
+                'a=mid:1',
+            ],
+        },
+    ]
+
+    var server_media = [
+        {
+            type: 'mrcp', 
+            fields: [
+                'a=setup:passive',
+                'a=connection:new',
+                'a=channel:32AECB234338@speechsynth',
+                'a=cmid:1',
+            ],
+        },        
+        {
+            type: 'audio',
+            fields: [
+                'a=sendonly',
+            ],
+        },
+    ]
+
+    oc = sip.call.create(t1.id, {
+        from_uri: 'sip:alice@test.com',
+        to_uri: `sip:bob@${t2.address}:${t2.port}`,
+        media: client_media,
+    })
+
+    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',
+                '$hdr(call-id)': m.collect('sip_call_id'),
+            }),
+        },
+    ], 1000)
+
+    ic = {
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {
+        code: 200,
+        reason: 'OK',
+        media: server_media,
+    })
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                '$hdr(content-type)': 'application/sdp',
+                $rb: sdp.jsonpath_matcher({
+                    '$.media[?(@.desc.type=="application")].val_attrs.channel': [m.collect('mrcp_channel')],
+                }),
+            }),
+        },
+        {
+            event: 'media_update',
+            call_id: oc.id,
+            status: 'ok',
+            media: [
+              {
+                type: 'mrcp',
+                local: {
+                  port: 9
+                },
+                remote: {
+                  port: m.collect('mrcp_server_port'),
+                },
+              },
+              {
+                type: 'audio',
+                local: {
+                  mode: 'recvonly'
+                },
+                remote: {
+                  mode: 'sendonly'
+                }
+              }
+            ],
+        },
+        {
+            event: 'media_update',
+            call_id: ic.id,
+            status: 'ok',
+            media: [
+              {
+                type: 'mrcp',
+                local: {
+                  port: m.collect('mrcp_server_port'),
+                },
+                remote: {
+                  port: 9
+                }
+              },
+              {
+                type: 'audio',
+                local: {
+                  mode: 'sendonly'
+                },
+                remote: {
+                  mode: 'recvonly'
+                }
+              }
+            ],
+        },
+    ], 1000)
+
+    var mrcp_channel = z.$mrcp_channel
+    var request_id = 1;
+    var msg = mrcp.builder.build_request('SPEAK', request_id, {'channel-identifier': mrcp_channel, 'content-type': 'application/xml'}, "<root>test</root>")
+
+    sip.call.send_mrcp_msg(oc.id, {msg})
+
+    await z.wait([
+        {
+            event: 'mrcp_msg',
+            call_id: ic.id,
+            msg: mrcp_msg({
+                type: 'request',
+                version: '2.0',
+                method: 'SPEAK',
+                request_id: 1,
+                headers: {
+                    'content-type': 'application/xml',
+                },
+                body: '<root>test</root>',
+            }),
+        },
+    ], 1000)
+
+    msg = mrcp.builder.build_response(request_id, 200, 'IN-PROGRESS', {'channel-identifier': mrcp_channel})
+    sip.call.send_mrcp_msg(ic.id, {msg})
+
+    msg = mrcp.builder.build_event('SPEAK-COMPLETE', request_id, 'COMPLETE', {'channel-identifier': mrcp_channel})
+    sip.call.send_mrcp_msg(ic.id, {msg})
+
+    await z.wait([
+        {
+            event: 'mrcp_msg',
+            call_id: oc.id,
+            msg: mrcp_msg({
+                type: 'response',
+                version: '2.0',
+                request_id: 1,
+                status_code: 200,
+                request_state: 'IN-PROGRESS',
+            }),
+        },
+        {
+            event: 'mrcp_msg',
+            call_id: oc.id,
+            msg: mrcp_msg({
+                type: 'event',
+                version: '2.0',
+                request_id: 1,
+                event_name: 'SPEAK-COMPLETE',
+                request_state: 'COMPLETE',
+            }),
+        },
+    ], 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()
+    process.exit(0)
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+

package/samples/mrcp_and_audio.simplified_media.js

@@ -44,8 +44,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK', media: 'mrcp,audio'})

package/samples/multiple_audio_streams.js

@@ -62,8 +62,8 @@ async function test() {
     // Here we store data for the incoming call
     // just to organize our code (not really needed)
     const ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     // Now we answer the call at t2 side and accept all 2 streams

package/samples/options.js

@@ -53,7 +53,7 @@ async function test() {
         },
     ], 1000)
 
-    sip.request.respond(z.store.uas_req_id, {code: 200, reason: 'OK', headers: {'X-SomeHeader1': 'ccc', 'X-SomeHeader2': 'ddd'}})
+    sip.request.respond(z.$uas_req_id, {code: 200, reason: 'OK', headers: {'X-SomeHeader1': 'ccc', 'X-SomeHeader2': 'ddd'}})
 
     await z.wait([
         {

package/samples/opus.narrowband.js

@@ -48,8 +48,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK'})

package/samples/pcma.js

@@ -48,8 +48,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK'})

package/samples/play_wav_and_speech_recog.bad_transcript.pcmu8000.js

@@ -53,8 +53,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {

package/samples/refer.js

@@ -56,8 +56,8 @@ async function test() {
     // Here we store data for the incoming call
     // just to organize our code (not really needed)
     const ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     // Now we answer the call at t2 side

package/samples/refuse_telephone_event.js

@@ -46,8 +46,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK'})

package/samples/register_no_expires.js

@@ -57,7 +57,7 @@ async function test() {
         },
     ], 1000)
 
-    sip.request.respond(z.store.req_id, {code: 200, reason: 'OK', headers: {Expires: '120'}})
+    sip.request.respond(z.$req_id, {code: 200, reason: 'OK', headers: {Expires: '120'}})
 
     await z.wait([
         {

package/samples/register_subscribe.js

@@ -57,7 +57,7 @@ async function test() {
         },
     ], 1000)
 
-    sip.request.respond(z.store.req_id, {code: 200, reason: 'OK', headers: {Expires: '60'}})
+    sip.request.respond(z.$req_id, {code: 200, reason: 'OK', headers: {Expires: '60'}})
 
     await z.wait([
         {
@@ -103,7 +103,7 @@ async function test() {
         },
     ], 1000)
 
-    var subscriber_id = z.store.subscriber_id
+    var subscriber_id = z.$subscriber_id
 
     await z.wait([
         {
@@ -130,7 +130,7 @@ async function test() {
     ], 1000)
 
     // Subscription-State expires will be computed by pjsip. It might not be the exact value of sub_expires due to latency so we give 2 seconds of tolerance
-    assert(z.store.sub_expires > (sub_expires - 2))
+    assert(z.$sub_expires > (sub_expires - 2))
 
     sip.subscriber.notify(subscriber_id, {
         content_type: 'application/dialog-info+xml',
@@ -155,7 +155,7 @@ async function test() {
     
     await z.sleep(100)
 
-    z.store.req_id = null
+    z.$req_id = null
 
     sip.account.unregister(a1)
 
@@ -174,7 +174,7 @@ async function test() {
         },
     ], 1000)
 
-    sip.request.respond(z.store.req_id, {code: 200, reason: 'OK', headers: {Expires: '0'}})
+    sip.request.respond(z.$req_id, {code: 200, reason: 'OK', headers: {Expires: '0'}})
 
     await z.wait([
         {

package/samples/reinvite_and_dtmf.js

@@ -46,8 +46,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     // force answer with pcma

package/samples/reinvite_audio_audio.js

@@ -44,8 +44,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK', media: 'audio,audio'})

package/samples/reinvite_with_hold_unhold.js

@@ -44,8 +44,8 @@ async function test() {
     ], 1000)
 
     ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK'})

package/samples/rtp_and_srtp.js

@@ -52,8 +52,8 @@ async function test() {
     ], 1000)
 
     const ic = {
-        id: z.store.call_id,
-        sip_call_id: z.store.sip_call_id,
+        id: z.$call_id,
+        sip_call_id: z.$sip_call_id,
     }
 
     sip.call.respond(ic.id, {code: 200, reason: 'OK', media: [