sip-lab 1.12.39 → 1.13.1

package/DEV.md

@@ -6,26 +6,42 @@ 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
+
 npm install
 ```
 
+Thne confirm it is working:
+```
+node samples/simple.js
+```
+
 #### To clean up (for a clean rebuild)
 ```
 npx node-gyp clean
 ```
 
+### To build the addon after changes in source files
+```
+npm run build
+```
+or force a full rebuild
+```
+npm run rebuild
+```
+
 #### To update pjproject, spandsp, bcg729 or rapidjson
 Just delete the corresponding library subfolder in subfolder 3drParty.
 
 
-Then temporarily change install.sh to not checkout a specific version (or checkout a desired commit)
+Then temporarily change build_deps.sh to not checkout a specific version (or checkout a desired commit)
 
 Then run
 ```
 npm install
 ```
 
-Then perform code changes and tests. When you are satisfied with them, update install.sh with the new commit id.
+Then perform code changes and tests. When you are satisfied with them, update build_deps.sh with the new commit IDs.
 
 #### prebuild binaries
 Previously we would do:
@@ -36,7 +52,7 @@ npx prebuildify --strip -t 15.0.0 -t 16.0.0 -t 17.0.0 -t 18.0.0
 ```
 However the above will build the addon to run on the current OS.
 
-Instead we will force the build on debian11 (using docker). So to this instead:
+Instead we will force the build on debian11 (using docker). So do this instead:
 ```
 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 --strip

package/README.md

@@ -10,18 +10,22 @@ It permits to:
   - send and receive DTMF inband/RFC2833/INFO.
   - play/record wav file on a call
   - send/receive fax (T.30 only)
+  - send/receive MRCPv2 messages (TCP only, no TLS)
 
 TODO:
-  - add suport for T.38 fax
-  - add support for WebRTC
   - add support for video playing/recording from/to file
+  - add support for T.38 fax
+  - add support for WebSocket
+  - add support for WebRTC
+  - add support for SRTP
+  - add support for MSRP
 
 ### Installation
 
-This is an node.js addon and it is known to work on Debian 11, Debian 10, Ubuntu 22.04 and Ubuntu 20.04.
+This is a node.js addon and it is known to work on Debian 11, Debian 10, Ubuntu 22.04 and Ubuntu 20.04.
 It is distributed with prebuild binaries for node.js 15.0.0 and above (but built for Debian 11. For other Debian versions or for Ubuntu a local built of the addon will be executed. Being the case, be patient as the build process will take several minutes to complete).
 
-To install it, first install some dependencies:
+To install it, first install some build dependencies (you might not need them if your are on Debian 11).
 ```
 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
 ```

package/binding.gyp

@@ -1,7 +1,102 @@
 {
   'targets': [
+    {
+      'target_name': 'all-settings',
+      'type': 'none',
+      'all_dependent_settings': {
+          'include_dirs': [
+            "3rdParty/pjproject/pjsip/include",
+            "3rdParty/pjproject/pjlib/include",
+            "3rdParty/pjproject/pjlib-util/include",
+            "3rdParty/pjproject/pjnath/include",
+            "3rdParty/pjproject/pjmedia/include",
+            "include",
+            "src",
+            "src/pjmedia/include",
+            "src/pjmedia/include/pjmedia",
+            "src/pjmedia/include/chainlink",	
+            "3rdParty/rapidjson/include",
+            "3rdParty/spandsp/src",
+            "<!@(node -p \"require('node-addon-api').include\")",
+          ],
+          'conditions': [
+            [ 'OS!="win"', {
+              'cflags_cc': [
+                '-g',
+                '-fexceptions',
+                '-Wno-maybe-uninitialized',
+                '-fPIC',
+              ],
+              'ldflags_cc': [
+                '-all-static',
+              ]
+              }
+            ]
+          ],
+          'link_settings': {
+              'libraries': [
+                '-L ../3rdParty/pjproject/pjnath/lib',
+                '-L ../3rdParty/pjproject/pjlib/lib',
+                '-L ../3rdParty/pjproject/pjlib-util/lib',
+                '-L ../3rdParty/pjproject/third_party/lib',
+                '-L ../3rdParty/pjproject/pjmedia/lib',
+                '-L ../3rdParty/pjproject/pjsip/lib',
+                '-L ../3rdParty/pjproject/third_party/lib',
+                '-l pjnath-x86_64-unknown-linux-gnu',
+                '-l ilbccodec-x86_64-unknown-linux-gnu',
+                '-l webrtc-x86_64-unknown-linux-gnu',
+                '-l yuv-x86_64-unknown-linux-gnu',
+                '-l speex-x86_64-unknown-linux-gnu',
+                '-l gsmcodec-x86_64-unknown-linux-gnu',
+                '-l g7221codec-x86_64-unknown-linux-gnu',
+                '-l resample-x86_64-unknown-linux-gnu',
+                '-l pjmedia-audiodev-x86_64-unknown-linux-gnu',
+                '-l pjmedia-codec-x86_64-unknown-linux-gnu',
+                '-l pjmedia-videodev-x86_64-unknown-linux-gnu',
+                '-l pjmedia-x86_64-unknown-linux-gnu',
+                '-l pjsdp-x86_64-unknown-linux-gnu',
+                '-l pjsip-x86_64-unknown-linux-gnu',
+                '-l pjsua2-x86_64-unknown-linux-gnu',
+                '-l pjsip-ua-x86_64-unknown-linux-gnu',
+                '-l pjsip-simple-x86_64-unknown-linux-gnu',
+                '-l pjsua-x86_64-unknown-linux-gnu',
+                '-l pj-x86_64-unknown-linux-gnu',
+                '-l pjlib-util-x86_64-unknown-linux-gnu',
+                '../3rdParty/spandsp/src/.libs/libspandsp.a',
+                '../3rdParty/bcg729/src/libbcg729.a',
+                '-lstdc++',
+                '-lopus',
+                '-lssl',
+                '-lcrypto',
+                '-luuid',
+                '-lm',
+                '-ldl',
+                '-ltiff',
+                '-lrt',
+                '-lpthread',
+                '-lasound',
+                '-lSDL2',
+                '-lavdevice',
+                '-lavformat',
+                '-lavcodec',
+                '-lswscale',
+                '-lavutil',
+                '-lv4l2',
+                '-lopencore-amrnb',
+                '-lopencore-amrwb',
+                '-lvo-amrwbenc',
+                '-lspeex',
+                '-l srtp-x86_64-unknown-linux-gnu',
+              ],
+          },
+       },
+    },
+
     {
       'target_name': 'addon',
+      'type': 'loadable_module', # this is default for node-gyp but gyp will complain if absent.
+      'dependencies': ['all-settings'],
+    
       'actions': [
         {
           'action_name': 'build_deps',
@@ -11,6 +106,7 @@
           'action': ['bash', './build_deps.sh'],
         },
       ],
+
       'sources': [
         'src/log.cpp',
         'src/event_templates.cpp',
@@ -24,91 +120,6 @@
         'src/pjmedia/src/chainlink/chainlink_wire_port.c',
         'src/pjmedia/src/chainlink/chainlink_fax.c',
       ],
-      'include_dirs': [
-        "3rdParty/pjproject/pjsip/include",
-        "3rdParty/pjproject/pjlib/include",
-        "3rdParty/pjproject/pjlib-util/include",
-        "3rdParty/pjproject/pjnath/include",
-        "3rdParty/pjproject/pjmedia/include",
-        "include",
-        "src",
-        "src/pjmedia/include",
-        "src/pjmedia/include/pjmedia",
-        "src/pjmedia/include/chainlink",	
-        "3rdParty/rapidjson/include",
-        "3rdParty/spandsp/src",
-        "<!@(node -p \"require('node-addon-api').include\")",
-      ],
-      'conditions': [
-        [ 'OS!="win"', {
-          'cflags_cc': [
-			'-g',
-            '-fexceptions',
-            '-Wno-maybe-uninitialized',
-            '-fPIC',
-          ],
-          'ldflags_cc': [
-            '-all-static',
-          ]
-          }
-        ]
-      ],
-      'link_settings': {
-          'libraries': [
-            '-L ../3rdParty/pjproject/pjnath/lib',
-            '-L ../3rdParty/pjproject/pjlib/lib',
-            '-L ../3rdParty/pjproject/pjlib-util/lib',
-            '-L ../3rdParty/pjproject/third_party/lib',
-            '-L ../3rdParty/pjproject/pjmedia/lib',
-            '-L ../3rdParty/pjproject/pjsip/lib',
-            '-L ../3rdParty/pjproject/third_party/lib',
-            '-l pjnath-x86_64-unknown-linux-gnu',
-            '-l ilbccodec-x86_64-unknown-linux-gnu',
-            '-l srtp-x86_64-unknown-linux-gnu',
-            '-l webrtc-x86_64-unknown-linux-gnu',
-            '-l yuv-x86_64-unknown-linux-gnu',
-            '-l speex-x86_64-unknown-linux-gnu',
-            '-l gsmcodec-x86_64-unknown-linux-gnu',
-            '-l g7221codec-x86_64-unknown-linux-gnu',
-            '-l resample-x86_64-unknown-linux-gnu',
-            '-l pjmedia-audiodev-x86_64-unknown-linux-gnu',
-            '-l pjmedia-codec-x86_64-unknown-linux-gnu',
-            '-l pjmedia-videodev-x86_64-unknown-linux-gnu',
-            '-l pjmedia-x86_64-unknown-linux-gnu',
-            '-l pjsdp-x86_64-unknown-linux-gnu',
-            '-l pjsip-x86_64-unknown-linux-gnu',
-            '-l pjsua2-x86_64-unknown-linux-gnu',
-            '-l pjsip-ua-x86_64-unknown-linux-gnu',
-            '-l pjsip-simple-x86_64-unknown-linux-gnu',
-            '-l pjsua-x86_64-unknown-linux-gnu',
-            '-l pj-x86_64-unknown-linux-gnu',
-            '-l pjlib-util-x86_64-unknown-linux-gnu',
-            '../3rdParty/spandsp/src/.libs/libspandsp.a',
-            '../3rdParty/bcg729/src/libbcg729.a',
-            '-lstdc++',
-            '-lopus',
-            '-lssl',
-            '-lcrypto',
-            '-luuid',
-            '-lm',
-            '-ldl',
-            '-ltiff',
-            '-lrt',
-            '-lpthread',
-            '-lasound',
-            '-lSDL2',
-            '-lavdevice',
-            '-lavformat',
-            '-lavcodec',
-            '-lswscale',
-            '-lavutil',
-            '-lv4l2',
-            '-lopencore-amrnb',
-            '-lopencore-amrwb',
-            '-lvo-amrwbenc',
-            '-lspeex',
-          ],
-      },
     },
-  ]
+  ],
 }

package/build_deps.sh

@@ -53,7 +53,9 @@ then
     cd pjproject
     #git checkout de3d744c2e1188b59bb907b6ee32ef83740ebc64
     #git checkout 33a3c9e0a5eb84426edef05a9aa98af17d8011c3 # required for bcg729
-    git checkout 797088ed133c98492519b7d042b75735f6f9388c # updated as part of #21
+    #git checkout 797088ed133c98492519b7d042b75735f6f9388c # updated as part of #21
+    #git checkout 651df5b50129b7c5a5feec8336dda4468d53d2b0 # updated to latest to see of crash issues improve
+    git checkout 043926a5846963a2c99378e8daa495230923eaab # update to try to solve ##49 (but issue remains)
 
     cat > user.mak <<EOF
     export CFLAGS += -fPIC -g
@@ -63,7 +65,6 @@ EOF
     sed -i -r 's/BCG729_LIBS="-lbcg729"/BCG729_LIBS=''/' aconfigure
     LIBS=`pwd`/../bcg729/src/libbcg729.a ./configure --with-bcg729=`pwd`/../bcg729
     cat > pjlib/include/pj/config_site.h <<EOF
-#define PJMEDIA_HAS_SRTP  0
 EOF
     make dep && make clean && make
 fi

package/index.js

@@ -48,6 +48,11 @@ addon.account = {
   unregister: addon.account_unregister,
 }
 
+addon.request = {
+  create: (t_id, params) => { return addon.request_create(t_id, JSON.stringify(params)) },
+  respond: (r_id, params) => { return addon.request_respond(r_id, JSON.stringify(params)) },
+}
+
 addon.call = {
   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)) },
@@ -55,16 +60,18 @@ addon.call = {
   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_record_wav: (c_id, params) => { return addon.call_start_record_wav(c_id, JSON.stringify(params)) },
+  start_play_wav: (c_id, params) => { return addon.call_start_play_wav(c_id, JSON.stringify(params)) },
+  stop_record_wav: (c_id, params) => { return addon.call_stop_record_wav(c_id, JSON.stringify(params ? params : {})) },
+  stop_play_wav: (c_id, params) => { return addon.call_stop_play_wav(c_id, JSON.stringify(params ? params : {})) },
   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: (c_id, params) => { return addon.call_refer(c_id, JSON.stringify(params)) },
+  stop_fax: (c_id, params) => { return addon.call_stop_fax(c_id, JSON.stringify(params ? params : {})) },
+  get_stream_stat: (c_id, params) => { return addon.call_get_stream_stat(c_id, JSON.stringify(params ? params : {})) },
+  //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,
+
+  send_mrcp_msg: (c_id, params) => { return addon.call_send_tcp_msg(c_id, JSON.stringify(params ? params : {})) },
 }
 
 addon.subscriber = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.12.39",
+  "version": "1.13.1",
   "description": "",
   "main": "index.js",
   "engines": {
@@ -8,6 +8,8 @@
   },
   "scripts": {
     "install": "node-gyp-build",
+    "build": "node-gyp build",
+    "rebuild": "node-gyp rebuild",
     "test": "./runtests"
   },
   "repository": {
@@ -19,10 +21,13 @@
   "gypfile": true,
   "homepage": "https://github.com/MayamaTakeshi/sip-lab",
   "dependencies": {
-    "@mayama/zeq": "^4.1.14",
+    "@mayama/zeq": "^4.1.17",
+    "mrcp": "^1.4.0",
+    "mrcp-matching": "^1.0.0",
     "node-addon-api": "^5.0.0",
     "node-gyp": "^9.3.0",
     "node-gyp-build": "^4.5.0",
+    "sdp-matching": "^1.2.0",
     "sip-matching": "^1.3.34"
   },
   "devDependencies": {

package/samples/16_audio_streams.js

@@ -0,0 +1,179 @@
+const sip = require ('../index.js')
+const Zeq = require('@mayama/zeq')
+const m = require('data-matching')
+const sip_msg = require('sip-matching')
+const _ = require('lodash')
+
+// here we create our Zeq instance
+var z = new Zeq()
+
+// here we are restricting codec to PCMU to avoid having the SDP to become too large
+sip.set_codecs('pcmu/8000/1:128')
+
+// here we asking for accumulated DTMF to be reported in case of no more digits after 500 ms
+sip.dtmf_aggregation_on(500)
+
+async function test() {
+    // here we set our Zeq instance to trap events generated by sip-lab event_source
+    z.trap_events(sip.event_source, 'event', (evt) => {
+        var e = evt.args[0]
+        return e
+    })
+
+    // here we start sip-lab
+    console.log(sip.start((data) => { console.log(data)} ))
+
+    // Here we create the SIP endpoints (transports).
+    // Since we don't specify the port, an available port will be allocated.
+    // Since we don't specify the type ('udp' or 'tcp' or 'tls'), 'udp' will be used by default.
+    const t1 = sip.transport.create({address: "127.0.0.1", type: 'tcp'})
+    const t2 = sip.transport.create({address: "127.0.0.1", type: 'tcp'})
+
+    // here we just print the transports
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    // make the call from t1 to t2 with 16 audio streams offering.
+    const oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`, media: 'audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio'})
+
+    // Here we will wait for the call to arrive at t2
+    // We will also get a '100 Trying' that is sent by sip-lab automatically
+    // We will wait for at most 1000ms. If all events don't arrive within 1000ms, an exception will be thrown and the test will fail due to timeout.
+    await z.wait([
+        {
+            event: "incoming_call",
+            call_id: m.collect("call_id"),
+            transport_id: t2.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: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
+                '$hdr(l)': '0',
+            }),
+        },
+    ], 1000)
+    // Details about zeq wait(list_of_events_to_wait_for, timeout_in_ms):
+    // The order of events in the list is irrelevant.
+    // What matters is that all events arrive within the specified timeout.
+    // When specifying events, you can be as detailed or succinct as you need.
+    // For example, the above event 'response' is waiting for a SIP '100 Trying' to arrive,
+    // but we are specifying things to match just to show that we can be very detailed when performing a match.
+    // But it could have been just like this:
+    //
+    //  {
+    //      event: 'response',
+    //      call_id: oc.id,
+    //      method: 'INVITE',
+    //      msg: sip_msg({
+    //          $rs: '100',
+    //      }),
+    //  }
+    // Regarding the function sip_msg() this is a special matching function provided by https://github.com/MayamaTakeshi/sip-matching that makes it 
+    // easy to match a SIP message using openser/kamailio/opensips pseudo-variables syntax.
+ 
+
+    // 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,
+    }
+
+    // Now we answer the call at t2 side and accept all 16 streams
+    sip.call.respond(ic.id, {code: 200, reason: 'OK', media: 'audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio,audio'})
+
+    // Then we wait for the '200 OK' at the t1 side
+    // We will also get event 'media_update' for both sides indicating media streams (RTP) were set up successfully
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+                '$(hdrcnt(VIA))': 1,
+                $fU: 'alice',
+                $fd: 'test.com',
+                $tU: 'bob',
+                '$hdr(content-type)': 'application/sdp',
+                $rb: '!{_}a=sendrecv',
+            }),
+        },
+        {
+            event: 'media_update',
+            call_id: oc.id,
+            status: 'ok',
+        },
+        {
+            event: 'media_update',
+            call_id: ic.id,
+            status: 'ok',
+        },
+    ], 1000)
+
+    sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
+
+    await z.wait(_.chain(_.range(16)).map(n => ({
+        event: 'dtmf',
+        call_id: ic.id,
+        digits: '1234',
+        mode: 0,
+        media_id: n,
+    })).value(), 3000)
+
+    sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
+
+    await z.wait(_.chain(_.range(16)).map(n => ({
+        event: 'dtmf',
+        call_id: oc.id,
+        digits: '4321',
+        mode: 1,
+        media_id: n,
+    })).value(), 3000)
+
+    // now we terminate the call from t1 side
+    sip.call.terminate(oc.id)
+
+    // and wait for termination events
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'BYE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+        {
+            event: 'call_ended',
+            call_id: oc.id,
+        },
+        {
+            event: 'call_ended',
+            call_id: ic.id,
+        },
+    ], 1000)
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+