sip-lab 1.34.2 → 1.34.4

package/README.md

@@ -1,44 +1,37 @@
-## sip-lab
+# sip-lab
 
-### Overview
+## Overview
 
-A nodejs module that helps to write functional tests for SIP systems (including media operations).
+A nodejs module that helps to write functional/integration tests for SIP systems (including media operations).
 It uses pjproject for SIP and media processing.
 
-It permits to:
-  - make audio calls using UDP, TCP and TLS transports
-  - send/receive DTMF inband/RFC2833/INFO.
-  - send/receive [BFSK](https://en.wikipedia.org/wiki/Frequency-shift_keying) bits.
-  - play/record audio on a call from/to a wav file
-  - send/receive fax (T.30 only)
-  - send/receive MRCPv2 messages (TCP only, no TLS)
-  - send/receive audio using SRTP
-  - do speech synth using flite
-  - do speech recog using pocketsphinx (but only works well with sampling rate of 16000)
-  - do speech synth/recog using [ws_speech_server](https://github.com/MayamaTakeshi/ws_speech_server) (this permits to use google/amazon/azure/etc speech services)
+## Documentation
 
-TODO:
-  - add support for video playing/recording from/to file
-  - add support for T.38 fax
-  - add support for SIP over WebSocket
-  - add support for WebRTC
-  - add support for MSRP
+See [Documentation](https://github.com/MayamaTakeshi/sip-lab/blob/master/DOC.md)
+
+## Installation
 
-### Installation
+The npm package is built for Debian 11 and this is the recommended distro.
 
-This is a node.js addon and it is known to work on Debian 11.
+You can use other debian/ubuntu version but they will require a build of dependencies that will take time (something like 7 minutes but this was measured on my slow PC).
 
-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 build of the addon will be executed. Being the case, be patient as the build process will take several minutes to complete (about 6 minutes on a docker container)). 
+First install apt packages:
 
-To install it, first install build dependencies:
 ```
 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 flite-dev cmake git wget
+
 ```
 
-Then install sip-lab (local build of the addon might be triggered here if this is not Debian 11):
+Then switch to node v19, switch to your node project folder and install sip-lab:
+
 ```
-npm install sip-lab
+nvm install 19
+nvm use 19
+cd YOUR_NODE_PROJECT_FOLDER
+npm i sip-lab
 ```
+Obs: once you install sip-lab, you can switch to other node versions like v20, v21.
+
 
 Then run some sample script from subfolder samples:
 ```
@@ -49,17 +42,7 @@ The above script has detailed comments.
 
 Please read it to undestand how to write your own test scripts.
 
-Notes:
-  - It will not work on Debian 10 as cmake version is older than required.
-  - It will work on Debian 12 but a build process will be required. But you need to build using node v19 or older. Building with node v20 or v21 will fail (https://github.com/MayamaTakeshi/sip-lab/issues/107). But once you have it built, you can switch to a newer version of node.
-
-So basically, if you stick with Debian 11 and any node version from 15 to 21, istallation should be smooth.
-
-### Documentation
-
-See [Documentation](https://github.com/MayamaTakeshi/sip-lab/blob/master/DOC.md)
-
-### Samples
+## Samples
 
 See general sample scripts in folder samples.
 
@@ -86,13 +69,13 @@ node node_modules/sip-lab/samples_extra/ws_speech_server.google.js
 ```
 
 
-### About the code
+## About the code
 
 Although the code in written in *.cpp/*.hpp named files, this is not actually a C++ project.
 
 It is mostly written in C using some C++ facilities.
 
-### Release Notes
+## Release Notes
 
 [ReleaseNotes](https://github.com/MayamaTakeshi/sip-lab/blob/master/RELEASE_NOTES.md)
 

package/package.json

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

package/samples/g729.js

@@ -80,8 +80,8 @@ async function test() {
     sip.call.start_record_wav(oc.id, {file: './oc.wav'})
     sip.call.start_record_wav(ic.id, {file: './ic.wav'})
 
-    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true, no_loop: true})
-    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true, no_loop: true})
+    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true, no_loop: true})
+    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true, no_loop: true})
 
     await z.wait([
         {
@@ -92,7 +92,7 @@ async function test() {
             event: 'end_of_file',
             call_id: ic.id,
         },
-    ], 3000)
+    ], 5000)
 
     sip.call.reinvite(oc.id)
 

package/samples/opus.narrowband.js

@@ -81,8 +81,8 @@ async function test() {
     sip.call.start_record_wav(oc.id, {file: './oc.wav'})
     sip.call.start_record_wav(ic.id, {file: './ic.wav'})
 
-    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true, no_loop: true})
-    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true, no_loop: true})
+    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true, no_loop: true})
+    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true, no_loop: true})
 
     await z.wait([
         {
@@ -93,7 +93,7 @@ async function test() {
             event: 'end_of_file',
             call_id: ic.id,
         },
-    ], 3000)
+    ], 5000)
 
     sip.call.reinvite(oc.id)
 

package/samples/simple.js

@@ -31,6 +31,8 @@ async function test() {
     console.log("t1", t1)
     console.log("t2", t2)
 
+    max_forwards = '18'
+
     // make the call from t1 to t2 with some custom heaaders
     const oc = sip.call.create(t1.id, {
         from_uri: 'sip:alice@test.com',
@@ -38,6 +40,7 @@ async function test() {
         headers: {
             'X-MyHeader1': 'abc',
             'X-MyHeader2': 'def',
+            'Max-Forwards': max_forwards,
         },
     })
 
@@ -56,6 +59,7 @@ async function test() {
                 $fd: 'test.com',
                 '$hdr(X-MyHeader1)': 'abc',
                 hdr_x_myheader2: 'def',
+                hdr_max_forwards: max_forwards,
             })
         },
         {

package/samples/start_play_wav_with_end_of_file_event.js

@@ -87,8 +87,8 @@ async function test() {
 
     await z.sleep(100)
 
-    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true})
-    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true})
+    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true})
+    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true})
 
     await z.sleep(500)
 
@@ -143,7 +143,7 @@ async function test() {
             event: 'end_of_file',
             call_id: oc.id,
         },
-    ], 2000)
+    ], 5000)
 
 
     sip.call.reinvite(ic.id)

package/samples/start_play_wav_with_no_loop.js

@@ -87,8 +87,8 @@ async function test() {
 
     await z.sleep(100)
 
-    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true, no_loop: true})
-    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/yosemitesam.wav', end_of_file_event: true, no_loop: true})
+    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true, no_loop: true})
+    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/hello_good_morning.wav', end_of_file_event: true, no_loop: true})
 
     sip.call.reinvite(oc.id)
 
@@ -183,7 +183,7 @@ async function test() {
             event: 'end_of_file',
             call_id: oc.id,
         },
-    ], 3000)
+    ], 5000)
 
     await z.sleep(3000) // we should not receive end_of_file events again
 

package/samples/tcp.js

@@ -312,8 +312,8 @@ async function test() {
         },
     ], 2000)
 
-    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/yosemitesam.wav'})
-    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/yosemitesam.wav'})
+    sip.call.start_play_wav(oc.id, {file: 'samples/artifacts/hello_good_morning.wav'})
+    sip.call.start_play_wav(ic.id, {file: 'samples/artifacts/hello_good_morning.wav'})
 
     await z.sleep(2000)
 

package/src/sip.cpp

@@ -8607,6 +8607,15 @@ pj_bool_t add_headers(pj_pool_t *pool, pjsip_tx_data *tdata,
       const char *value = itr->value.GetString();
 
       pj_str_t hname = pj_str((char *)name);
+
+      if (pj_stricmp2(&hname, "Max-Forwards") == 0) {
+          pjsip_max_fwd_hdr* max_fwd = (pjsip_max_fwd_hdr*)pjsip_msg_find_hdr(tdata->msg, PJSIP_H_MAX_FORWARDS, NULL);
+          if (max_fwd) {
+              max_fwd->ivalue = atoi(value);
+              continue;
+          }
+      }
+
       pjsip_hdr *hdr = (pjsip_hdr *)pjsip_parse_hdr(pool, &hname, (char *)value,
                                                       strlen(value), NULL);