sip-lab 1.28.12 → 1.30.0

package/DEV.md

@@ -80,6 +80,61 @@ npx prebuildify-cross -i mayamatakeshi/sip-lab-debian11:latest -t 15.0.0 -t 16.0
 ```
 Obs: however the above will fail if you are behind proxy (solution pending).
 
+#### Checking build using docker container
+
+A quick check of the build can be done this way:
+```
+docker run -it debian:bookworm-slim /bin/bash
+
+# then inside the container
+
+apt update
+apt install curl
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+. ~/.nvm/nvm.sh
+nvm i 19
+mkdir -p /root/tmp/t1
+cd /root/tmp/t1
+npm init -y
+apt install -y 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
+npm i sip-lab
+```
+
+Sample build:
+```
+root@636c5c5b0748:~/tmp/t2# nvm use 19
+Now using node v19.9.0 (npm v9.6.3)
+
+root@636c5c5b0748:~/tmp/t2# time npm i sip-lab
+npm WARN deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
+npm WARN deprecated @npmcli/move-file@2.0.1: This functionality has been moved to @npmcli/fs
+npm WARN deprecated npmlog@6.0.2: This package is no longer supported.
+npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
+npm WARN deprecated are-we-there-yet@3.0.1: This package is no longer supported.
+npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
+npm WARN deprecated glob@8.1.0: Glob versions prior to v9 are no longer supported
+npm WARN deprecated gauge@4.0.4: This package is no longer supported.
+
+added 165 packages, and audited 166 packages in 6m
+
+11 packages are looking for funding
+  run `npm fund` for details
+
+4 moderate severity vulnerabilities
+
+To address all issues, run:
+  npm audit fix
+
+Run `npm audit` for details.
+
+real	5m54.904s
+user	4m32.643s
+sys	0m54.272s
+
+```
+
+So it is taking aboult 6 minutes to build the addon on a docker container.
+
 #### Running tests
 ```
 npm test

package/README.md

@@ -25,8 +25,9 @@ TODO:
 
 ### Installation
 
-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 build of the addon will be executed. Being the case, be patient as the build process will take several minutes to complete). 
+This is a node.js addon and it is known to work on Debian 11.
+
+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)). 
 
 To install it, first install build dependencies:
 ```
@@ -47,6 +48,11 @@ 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
 

package/binding.gyp

@@ -119,6 +119,7 @@
         'src/sip.cpp',
         'src/addon.cpp',
         'src/pjmedia/src/pjmedia/dtmfdet.c',
+        'src/pjmedia/src/pjmedia/bfsk_det.c',
         'src/pjmedia/src/pjmedia/fax_port.c',
         'src/pjmedia/src/pjmedia/flite_port.c',
         'src/pjmedia/src/pjmedia/pocketsphinx_port.c',

package/build_deps.sh

@@ -56,7 +56,8 @@ then
     #git checkout 797088ed133c98492519b7d042b75735f6f9388c # updated as part of #21
     #git checkout 651df5b50129b7c5a5feec8336dda4468d53d2b0 # updated to latest to see of crash issues improve
     #git checkout 043926a5846963a2c99378e8daa495230923eaab # updated to try to solve #49 (but issue remains)
-    git checkout c36802585ddefb3ca477d1f6d773d179510c5412 # updated to try to solve #83 (but issue remains)
+    #git checkout c36802585ddefb3ca477d1f6d773d179510c5412 # updated to try to solve #83 (but issue remains)
+    git checkout 9543a1bcf50be721d030be99afeeb63bd8cf2013 # updated to latest commit to permit to report https://github.com/pjsip/pjproject/issues/4082
 
     cat > user.mak <<EOF
     export CFLAGS += -fPIC -g

package/index.js

@@ -58,6 +58,7 @@ addon.call = {
   respond: (c_id, params) => { return addon.call_respond(c_id, JSON.stringify(params)) },
   terminate: (c_id, params) => { return addon.call_terminate(c_id, JSON.stringify(params ? params : {})) },
   send_dtmf: (c_id, params) => { return addon.call_send_dtmf(c_id, JSON.stringify(params)) },
+  send_bfsk: (c_id, params) => { return addon.call_send_bfsk(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_record_wav: (c_id, params) => { return addon.call_start_record_wav(c_id, JSON.stringify(params)) },
@@ -69,6 +70,12 @@ addon.call = {
   start_speech_synth: (c_id, params) => { return addon.call_start_speech_synth(c_id, JSON.stringify(params)) },
   stop_speech_synth: (c_id, params) => { return addon.call_stop_speech_synth(c_id, JSON.stringify(params ? params : {})) },
 
+  start_inband_dtmf_detection: (c_id, params) => { return addon.call_start_inband_dtmf_detection(c_id, JSON.stringify(params ? params : {})) },
+  stop_inband_dtmf_detection: (c_id, params) => { return addon.call_stop_inband_dtmf_detection(c_id, JSON.stringify(params ? params : {})) },
+
+  start_bfsk_detection: (c_id, params) => { return addon.call_start_bfsk_detection(c_id, JSON.stringify(params ? params : {})) },
+  stop_bfsk_dtmf_detection: (c_id, params) => { return addon.call_stop_bfsk_detection(c_id, JSON.stringify(params ? params : {})) },
+
   start_speech_recog: (c_id, params) => { 
     var ps = {}
     if(params) {

package/package.json

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

package/samples/100_calls.js

@@ -92,6 +92,10 @@ async function test() {
         media_id: 0,
     })).value(), 50000)
 
+    ocs.forEach(oc => {
+        sip.call.start_inband_dtmf_detection(oc.id)
+    })
+
     z.store.ic_ids.forEach(ic_id => {
         sip.call.send_dtmf(ic_id, {digits: '4321', mode: 1})
     })

package/samples/16_audio_streams.js

@@ -100,6 +100,8 @@ async function test() {
         media_id: n,
     })).value(), 3000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
     await z.wait(_.chain(_.range(16)).map(n => ({

package/samples/183_session_progress.js

@@ -86,6 +86,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/delayed_media.js

@@ -107,6 +107,8 @@ async function test() {
 
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/four_audio_streams_two_refused.js

@@ -38,8 +38,8 @@ async function test() {
             type: "audio",
             port: 0, // it means not in use
         },
-	"audio",
-	{
+        "audio",
+        {
             type: "audio",
             port: 0, // it means not in use
         }
@@ -63,8 +63,8 @@ async function test() {
             type: "audio",
             port: 0, // it means not in use
         },
-	"audio",
-	{
+        "audio",
+        {
             type: "audio",
             port: 0, // it means not in use
         }
@@ -128,6 +128,9 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id, {media_id: 0})
+    sip.call.start_inband_dtmf_detection(oc.id, {media_id: 2})
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/mrcp_and_audio.simplified_media.js

@@ -118,6 +118,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/multiple_audio_streams.js

@@ -103,6 +103,8 @@ async function test() {
         media_id: n,
     })).value(), 3000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
     await z.wait(_.chain(_.range(NUM_AUDIO_STREAMS)).map(n => ({

package/samples/refuse_telephone_event.js

@@ -100,6 +100,9 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+    sip.call.start_inband_dtmf_detection(ic.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 1})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/reinvite_and_dtmf.js

@@ -111,6 +111,9 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+    sip.call.start_inband_dtmf_detection(ic.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/reinvite_audio_audio.js

@@ -88,6 +88,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/reinvite_with_hold_unhold.js

@@ -98,6 +98,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/rtp_and_srtp.js

@@ -89,6 +89,9 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+    sip.call.start_inband_dtmf_detection(ic.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 1})
     sip.call.send_dtmf(ic.id, {digits: '1234', mode: 1})
 

package/samples/rtp_and_srtp.rtp_refused.js

@@ -131,6 +131,9 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id, {media_id: 1})
+    sip.call.start_inband_dtmf_detection(ic.id, {media_id: 1})
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 1})
     sip.call.send_dtmf(ic.id, {digits: '1234', mode: 1})
 

package/samples/send_and_receive_bfsk.js.future

@@ -0,0 +1,171 @@
+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')
+
+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
+    })
+
+    //sip.set_codecs("pcmu/8000/1:128,pcma/8000/1:128,gsm/8000/1:128")
+    sip.set_codecs("pcma/8000/1:128")
+
+    console.log(sip.start((data) => { console.log(data)} ))
+
+    t1 = sip.transport.create({address: "127.0.0.1", type: 'udp'})
+    t2 = sip.transport.create({address: "127.0.0.1", type: 'udp'})
+
+    console.log("t1", t1)
+    console.log("t2", t2)
+
+    oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`})
+
+    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.store.call_id,
+        sip_call_id: z.store.sip_call_id,
+    }
+
+    sip.call.respond(ic.id, {code: 200, reason: 'OK'})
+
+    await z.wait([
+        {
+            event: 'response',
+            call_id: oc.id,
+            method: 'INVITE',
+            msg: sip_msg({
+                $rs: '200',
+                $rr: 'OK',
+            }),
+        },
+        {
+            event: 'media_update',
+            call_id: oc.id,
+            status: 'ok',
+            media: [
+              {
+                type: 'audio',
+                local: {
+                  port: 10000,
+                  mode: 'sendrecv'
+                },
+                remote: {
+                  port: 10002,
+                  mode: 'sendrecv'
+                },
+              },
+            ],
+        },
+        {
+            event: 'media_update',
+            call_id: ic.id,
+            status: 'ok',
+            media: [
+              {
+                type: 'audio',
+                local: {
+                  port: 10002,
+                  mode: 'sendrecv'
+                },
+                remote: {
+                  port: 10000,
+                  mode: 'sendrecv'
+                },
+              }
+            ],
+        },
+    ], 1000)
+
+    sip.call.start_record_wav(oc.id, {file: 'oc.wav'})
+    sip.call.start_record_wav(ic.id, {file: 'ic.wav'})
+
+    await z.sleep(100)
+
+    sip.call.start_bfsk_detection(oc.id, {freq_zero: 880, freq_one: 1280})
+    //sip.call.start_bfsk_detection(ic.id, {freq_zero: 880, freq_one: 1280})
+
+    oc_bits = '1010'
+    ic_bits = '1100'
+
+    sip.call.send_bfsk(ic.id, {bits: ic_bits, freq_zero: 880, freq_one: 1280})
+    //sip.call.send_bfsk(oc.id, {bits: oc_bits, freq_zero: 880, freq_one: 1280})
+
+    await z.wait([
+       {
+            event: 'bfsk',
+            call_id: ic.id,
+            bits: oc_bits,
+            media_id: 0
+       },
+       {
+            event: 'bfsk',
+            call_id: oc.id,
+            bits: ic_bits,
+            media_id: 0
+       },
+    ], 10000)
+
+    await z.sleep(1000)
+
+    sip.call.stop_record_wav(oc.id)
+    sip.call.stop_record_wav(ic.id)
+
+    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/srtp.js

@@ -81,6 +81,9 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+    sip.call.start_inband_dtmf_detection(ic.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 1})
     sip.call.send_dtmf(ic.id, {digits: '1234', mode: 1})
 

package/samples/tcp.js

@@ -85,6 +85,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_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/text_to_speech.js

@@ -87,6 +87,9 @@ 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_inband_dtmf_detection(oc.id)
+    sip.call.start_inband_dtmf_detection(ic.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 1})
     sip.call.send_dtmf(ic.id, {digits: '1234', mode: 1})
 

package/samples/two_audio_streams.js

@@ -95,6 +95,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
@@ -414,6 +416,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 

package/samples/two_audio_streams.port_zero.js

@@ -95,6 +95,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})
 
@@ -426,6 +428,8 @@ async function test() {
         },
     ], 1000)
 
+    sip.call.start_inband_dtmf_detection(oc.id)
+
     sip.call.send_dtmf(oc.id, {digits: '1234', mode: 0})
     sip.call.send_dtmf(ic.id, {digits: '4321', mode: 1})