sip-lab 1.34.1 → 1.34.3

package/README.md

@@ -2,43 +2,36 @@
 
 ### 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)
-
-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
+### Documentation
+
+See [Documentation](https://github.com/MayamaTakeshi/sip-lab/blob/master/DOC.md)
 
 ### Installation
 
-This is a node.js addon and it is known to work on Debian 11.
+The npm package is built for Debian 11 and this is the recommended distro.
+
+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,12 +42,6 @@ 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.
-
 ### Samples
 
 See general sample scripts in folder samples.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.34.1",
+  "version": "1.34.3",
   "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/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)