sip-lab 1.12.3 → 1.12.6

package/README.md

@@ -20,14 +20,7 @@ TODO:
 
 This will require you to have some libraries installed. So do:
 ```
-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 libopus-dev libsdl2-dev libopencore-amrnb-dev libopencore-amrwb-dev libvo-amrwbenc-dev libboost-dev libspandsp-dev libpcap-dev libssl-dev uuid-dev
-```
-
-We will also support G729 codec by installing bcg729.
-
-There is a helper script that you can use:
-```
-./install_bcg729.sh
+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 libopus-dev libsdl2-dev libopencore-amrnb-dev libopencore-amrwb-dev libvo-amrwbenc-dev libboost-dev libtiff-dev libpcap-dev libssl-dev uuid-dev
 ```
 
 Then install sip-lab by doing:
@@ -56,21 +49,6 @@ It was originally developed with node v.10 and tested with v.12 and v16.13.1 and
 (it is known to not work with node v.8)
 
 
-Since running
-```
-npm install sip-lab
-```
-takes some time to fetch and build pjproject and the node addon for it, you could install sip-lab globally:
-
-```
-  npm install -g sip-lab
-```
-
-But if you do so, you will need to set NODE_PATH for node to find it by doing:
-```
-  export NODE_PATH=$(npm root --quiet -g)
-```
-
 ### About the code
 
 Although the code in written in *.cpp/*.hpp named files, this is not actually a C++ project.

package/binding.gyp

@@ -17,16 +17,18 @@
         'src/pjmedia/src/chainlink/chainlink_fax.c',
       ],
       'include_dirs': [
-        "pjproject/pjsip/include",
-        "pjproject/pjlib/include",
-        "pjproject/pjlib-util/include",
-        "pjproject/pjnath/include",
-        "pjproject/pjmedia/include",
+        "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",	
-        "rapidjson/include",
+        "3rdParty/rapidjson/include",
+        "3rdParty/spandsp/src",
         "<!@(node -p \"require('node-addon-api').include\")",
       ],
       "dependencies": [
@@ -48,14 +50,13 @@
       ],
       'link_settings': {
           'libraries': [
-            '-L ../pjproject/pjnath/lib',
-            '-L ../pjproject/pjlib/lib',
-            '-L ../pjproject/pjlib-util/lib',
-            '-L ../pjproject/third_party/lib',
-            '-L ../pjproject/pjmedia/lib',
-            '-L ../pjproject/pjsip/lib',
-            '-L ../pjproject/third_party/lib',
-            '-L ../bcg729/src',
+            '-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',
@@ -77,6 +78,8 @@
             '-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',
@@ -84,7 +87,7 @@
             '-luuid',
             '-lm',
             '-ldl',
-            '-lspandsp',
+            '-ltiff',
             '-lpcap',
             '-lrt',
             '-lpthread',
@@ -100,7 +103,6 @@
             '-lopencore-amrwb',
             '-lvo-amrwbenc',
             '-lspeex',
-            '-lbcg729',
           ],
       },
     },

package/include/siplab_constants.h

@@ -0,0 +1,6 @@
+#ifndef __SIPLAB_CONSTANTS_H__
+#define __SIPLAB_CONSTANTS_H__
+
+#define FAX_FLAG_TRANSMIT_ON_IDLE 1
+
+#endif /* __SIPLAB_CONSTANTS_H__ */

package/install.sh

@@ -4,8 +4,49 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
+
 START_DIR=`pwd`
 
+
+mkdir -p 3rdParty
+
+
+cd $START_DIR/3rdParty
+if [[ ! -d spandsp ]]
+then
+	commit=e59ca8fb8b1591e626e6a12fdc60a2ebe83435ed
+	git clone https://github.com/freeswitch/spandsp
+	cd spandsp
+	git checkout $commit
+	./bootstrap.sh
+	CFLAGS='-O -fPIC' ./configure --enable-shared
+    make
+fi
+
+
+cd $START_DIR/3rdParty
+if [[ ! -d rapidjson ]]
+then
+	git clone https://github.com/Tencent/rapidjson
+	cd rapidjson
+	git checkout 27c3a8dc0e2c9218fe94986d249a12b5ed838f1d
+fi
+
+
+cd $START_DIR/3rdParty
+if [[ ! -d bcg729 ]]
+then
+    git clone https://github.com/MayamaTakeshi/bcg729
+    cd bcg729
+    git checkout faaa895862165acde6df8add722ba4f85a25007d
+    cmake . 
+    make
+    mkdir -p lib
+    cp -f src/libbcg729.a lib
+fi
+
+
+cd $START_DIR/3rdParty
 if [[ ! -d pjproject ]]
 then
 	git clone https://github.com/pjsip/pjproject
@@ -21,21 +62,15 @@ then
 	export LDFLAGS +=
 EOF
 
-	./configure --with-bcg729
+    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
 
-cd $START_DIR
 
-if [[ ! -d rapidjson ]]
-then
-	git clone https://github.com/Tencent/rapidjson
-	cd rapidjson
-	git checkout 27c3a8dc0e2c9218fe94986d249a12b5ed838f1d
-fi
 
 cd $START_DIR
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.12.3",
+  "version": "1.12.6",
   "description": "",
   "main": "index.js",
   "engines": {
@@ -23,9 +23,9 @@
     "node-gyp": "^8.4.1"
   },
   "devDependencies": {
+    "@mayama/zeq": "^4.1.14",
     "data-matching": "^1.23.8",
     "sip-matching": "^1.3.13",
-    "string-matching": "^1.11.9",
-    "zester": "^4.1.1"
+    "string-matching": "^1.11.9"
   }
 }

package/samples/delayed_media.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 

package/samples/g729.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 

package/samples/register_subscribe.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 

package/samples/reinvite_and_dtmf.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 

package/samples/send_and_receive_fax.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 
@@ -89,8 +89,9 @@ async function test() {
     var in_file = 'samples/artifacts/this-is-never-ok.tiff'
     var out_file = "received.tiff"
 
-    sip.call.start_fax(oc.id, {is_sender: true, file: in_file})
-    sip.call.start_fax(ic.id, {is_sender: false, file: out_file})
+    // transmit_on_idle: true/true: OK, true/false: OK, false/true: OK, false/false: NG
+    sip.call.start_fax(oc.id, {is_sender: true, file: in_file, transmit_on_idle: false})
+    sip.call.start_fax(ic.id, {is_sender: false, file: out_file, transmit_on_idle: true})
 
     await z.wait([
         {

package/samples/simple.js

@@ -1,16 +1,16 @@
 // This test creates 2 UDP SIP endpoints, makes a call between them and disconeects.
 
 const sip = require ('../index.js')
-const Zester = require('zester')
+const Zeq = require('@mayama/zeq')
 const m = require('data-matching')
 const sip_msg = require('sip-matching')
 
-// here we create our Zester instance
-var z = new Zester()
+// here we create our Zeq instance
+var z = new Zeq()
 
 
 async function test() {
-    // here we set our zester instance to trap events generated by sip-lab event_source
+    // 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
@@ -57,7 +57,7 @@ async function test() {
             }),
         },
     ], 1000)
-    // Details about zester wait(list_of_events_to_wait_for, timeout_in_ms):
+    // 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.

package/samples/sip_cancel.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 

package/samples/tcp_and_extra_headers.js

@@ -1,6 +1,6 @@
 var sip = require ('../index.js')
-var Zester = require('zester')
-var z = new Zester()
+var Zeq = require('@mayama/zeq')
+var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
 
@@ -280,8 +280,8 @@ async function test() {
         },
     ], 2000)
 
-    sip.call.start_playing(oc.id, {file: '/home/takeshi/work/src/svn/brastel/SIP-Tools/trunk/sip-tester/yosemitesam.wav'})
-    sip.call.start_playing(ic.id, {file: '/home/takeshi/work/src/svn/brastel/SIP-Tools/trunk/sip-tester/yosemitesam.wav'})
+    sip.call.start_playing(oc.id, {file: 'samples/artifacts/yosemitesam.wav'})
+    sip.call.start_playing(ic.id, {file: 'samples/artifacts/yosemitesam.wav'})
 
     await z.sleep(2000)
 

package/src/Makefile

@@ -34,7 +34,7 @@ sip.o: sip.cpp sip.hpp
 	$(CC) -fPIC -c -o sip.o sip.cpp $(CPPFLAGS)
 
 sip.so: sip.o idmanager.o packetdumper.o event_templates.o chainlink
-	$(CC) -fPIC -shared -o sip.so sip.o idmanager.o packetdumper.o event_templates.o pjmedia/libchainlink.a -Wl,-E -lm -ldl -lspandsp -lpcap $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
+	$(CC) -fPIC -shared -o sip.so sip.o idmanager.o packetdumper.o event_templates.o pjmedia/libchainlink.a 3rdParty/spandsp/src/.libs/libspandsp.a -Wl,-E -lm -ldl -ltiff -lpcap $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
 
 clean:
 	rm -f *.o *.so

package/src/pjmedia/include/chainlink/chainlink_fax.h

@@ -16,6 +16,7 @@ PJ_DECL(pj_status_t) chainlink_fax_port_create( pj_pool_t *pool,
                 void *user_data,
                 int is_sender,
                 const char *file,
+                unsigned flags,
                 pjmedia_port **p_port);
 
 

package/src/pjmedia/src/chainlink/chainlink_fax.c

@@ -8,6 +8,8 @@
 #include <pj/pool.h>
 #include <pj/string.h>
 
+#include "siplab_constants.h"
+
 #define SPANDSP_EXPOSE_INTERNAL_STRUCTURES
 #include <spandsp.h>
 
@@ -23,7 +25,6 @@
 #define FAX_DATA_CHUNK 320
 #define T38_DATA_CHUNK 160
 
-
 enum
 {
     /*! No compression */
@@ -48,7 +49,6 @@ enum
     T30_SUPPORT_T88_COMPRESSION = 0x200
 };
 
-
 static pj_status_t fax_get_frame(pjmedia_port *this_port, 
 					pjmedia_frame *frame);
 static pj_status_t fax_put_frame(pjmedia_port *this_port, 
@@ -62,23 +62,24 @@ struct fax_device
 	void (*fax_cb)(pjmedia_port*, void*, int);
 	void *fax_cb_user_data;
 	int is_sender;
+    bool result_sent;
 
     pj_lock_t	       *lock;
 };
 
-static int phase_b_handler(t30_state_t* s, void* user_data, int result)
+static int phase_b_handler(void* user_data, int result)
 {
 	printf("fax phase_b_handler user_data=%p result=%i\n", user_data, result);
     return T30_ERR_OK;
 }
 
-static int phase_d_handler(t30_state_t* s, void* user_data, int result)
+static int phase_d_handler(void* user_data, int result)
 {
 	printf("fax phase_b_handler user_data=%p result=%i\n", user_data, result);
     return T30_ERR_OK;
 }
 
-static void phase_e_handler(t30_state_t* s, void* user_data, int result)
+static void phase_e_handler(void* user_data, int result)
 {
 	printf("fax phase_e_handler user_data=%p result=%i\n", user_data, result);
 
@@ -93,11 +94,13 @@ static void phase_e_handler(t30_state_t* s, void* user_data, int result)
         return;
     }
 
-    printf("sending result event\n");
-	fd->fax_cb((pjmedia_port*)fd, fd->fax_cb_user_data, result);
+    if(!fd->result_sent) {
+	    fd->fax_cb((pjmedia_port*)fd, fd->fax_cb_user_data, result);
+        fd->result_sent = true;
+    } 
 }
 
-static int document_handler(t30_state_t* s, void* user_data, int result)
+static int document_handler(void* user_data, int result)
 {
 	printf("fax document_handler user_data=%p result=%i\n", user_data, result);
 
@@ -106,7 +109,10 @@ static int document_handler(t30_state_t* s, void* user_data, int result)
     struct fax_device *fd = (struct fax_device*)user_data;
 	if(!fd->fax_cb) return 0;
 
-	//fd->fax_cb((pjmedia_port*)fd, fd->fax_cb_user_data, result);
+    if(!fd->result_sent) {
+	    fd->fax_cb((pjmedia_port*)fd, fd->fax_cb_user_data, result);
+        fd->result_sent = true;
+    } 
 
     return 0;
 }
@@ -122,6 +128,7 @@ PJ_DEF(pj_status_t) chainlink_fax_port_create( pj_pool_t *pool,
 				void *user_data,
 				int is_sender,
 				const char *file,
+                unsigned flags,
 				pjmedia_port **p_port)
 {
     struct fax_device *fd;
@@ -144,7 +151,6 @@ PJ_DEF(pj_status_t) chainlink_fax_port_create( pj_pool_t *pool,
     fd->link.port.on_destroy = &fax_on_destroy;
 
 	fax_init(&fd->fax, is_sender);
-	//fax_set_transmit_on_idle(&fd->fax,1);
 
 	t30_state_t *t30 = fax_get_t30_state(&fd->fax);
 
@@ -161,6 +167,7 @@ PJ_DEF(pj_status_t) chainlink_fax_port_create( pj_pool_t *pool,
 	t30_set_document_handler(t30, &document_handler, (void*)fd);
 
 	fd->is_sender = is_sender;
+    fd->result_sent = false;
 
 	pj_status_t status = pj_lock_create_simple_mutex(pool, "fax", &fd->lock);
 
@@ -178,7 +185,9 @@ PJ_DEF(pj_status_t) chainlink_fax_port_create( pj_pool_t *pool,
     t30_set_supported_compressions(t30,T30_SUPPORT_T4_1D_COMPRESSION |
         T30_SUPPORT_T4_2D_COMPRESSION | T30_SUPPORT_T6_COMPRESSION);
 
-	fax_set_transmit_on_idle(&fd->fax, 1);
+    if(flags & FAX_FLAG_TRANSMIT_ON_IDLE) {
+	    fax_set_transmit_on_idle(&fd->fax, 1);
+    }
 
     fd->fax_cb = cb;
     fd->fax_cb_user_data = user_data;

package/src/sip.cpp

@@ -36,6 +36,8 @@
 
 #include "rapidjson/document.h"
 
+#include "siplab_constants.h"
+
 using namespace rapidjson;
 using namespace std;
 
@@ -159,6 +161,23 @@ bool json_get_int_param(Document &document, const char *param, bool optional, in
     return true;
 }
 
+bool json_get_uint_param(Document &document, const char *param, bool optional, unsigned *dest) {
+    if(!document.HasMember(param)) {
+        if(optional) {
+            return true;
+        } 
+        set_error("Parameter %s is required", param);
+        return false;
+    }
+
+    if(!document[param].IsUint()) {
+        set_error("Parameter %s must be an unsigned integer", param);
+        return false;
+    }
+    *dest = document[param].GetUint();
+    return true;
+}
+
 bool json_get_bool_param(Document &document, const char *param, bool optional, bool *dest) {
     if(!document.HasMember(param)) {
         if(optional) {
@@ -478,7 +497,7 @@ bool prepare_tonegen(Call *c);
 bool prepare_wav_player(Call *c, const char *file);
 bool prepare_wav_writer(Call *c, const char *file); 
 
-bool prepare_fax(Call *c, bool is_sender, const char *file); 
+bool prepare_fax(Call *c, bool is_sender, const char *file, unsigned flags); 
 
 void prepare_error_event(ostringstream *oss, char *scope, char *details);
 //void prepare_pjsipcall_error_event(ostringstream *oss, char *scope, char *function, pj_status_t s);
@@ -2689,6 +2708,8 @@ int pjw_call_start_fax(long call_id, const char *json)
 
     bool is_sender;
     char *file;
+    unsigned flags = 0;
+    bool flag;
 
     char buffer[MAX_JSON_INPUT];
 
@@ -2723,6 +2744,15 @@ int pjw_call_start_fax(long call_id, const char *json)
         goto out;
     }
 
+
+    flag = false;
+    if(!json_get_bool_param(document, "transmit_on_idle", true, &flag)) {
+        goto out;
+    } else {
+        if(flag) flags |= FAX_FLAG_TRANSMIT_ON_IDLE;
+    }
+    
+
 	status = pjmedia_stream_get_port(call->med_stream,
 					&stream_port);
 	if(status != PJ_SUCCESS)
@@ -2731,7 +2761,7 @@ int pjw_call_start_fax(long call_id, const char *json)
         goto out;
 	}
 
-	if(!prepare_fax(call, is_sender, file)){
+	if(!prepare_fax(call, is_sender, file, flags)){
 		set_error("prepare_fax failed");
         goto out;
 	}
@@ -4326,7 +4356,7 @@ bool prepare_wav_writer(Call *c, const char *file) {
 }
 
 
-bool prepare_fax(Call *c, bool is_sender, const char *file) {
+bool prepare_fax(Call *c, bool is_sender, const char *file, unsigned flags) {
    pj_status_t status;
 
    chainlink *link = (chainlink*)c->fax;
@@ -4348,6 +4378,7 @@ bool prepare_fax(Call *c, bool is_sender, const char *file) {
                        c,
                        is_sender,
                        file,
+                       flags, 
                        (pjmedia_port**)&c->fax);
    if(status != PJ_SUCCESS) return false;
 

package/install_bcg729.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-if [[ ! -d bcg729 ]]
-then
-    git clone https://github.com/MayamaTakeshi/bcg729
-    cd bcg729
-    git checkout faaa895862165acde6df8add722ba4f85a25007d
-    cmake . 
-    make
-    sudo make install
-    sudo ldconfig
-fi
-
-echo success