sip-lab 1.17.10 → 1.19.0

package/binding.gyp

@@ -14,9 +14,8 @@
             "src",
             "src/pjmedia/include",
             "src/pjmedia/include/pjmedia",
-            "src/pjmedia/include/chainlink",	
             "3rdParty/rapidjson/include",
-            "3rdParty/boost_1_51_0",
+            "3rdParty/boost_1_66_0",
             "3rdParty/spandsp/src",
             "<!@(node -p \"require('node-addon-api').include\")",
           ],
@@ -50,11 +49,11 @@
                 '-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-x86_64-unknown-linux-gnu',
+                '-l resample-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',
@@ -108,12 +107,8 @@
         'src/idmanager.cpp',
         'src/sip.cpp',
         'src/addon.cpp',
-        'src/pjmedia/src/chainlink/chainlink_dtmfdet.c',
-        'src/pjmedia/src/chainlink/chainlink_tonegen.c',
-        'src/pjmedia/src/chainlink/chainlink_wav_player.c',
-        'src/pjmedia/src/chainlink/chainlink_wav_writer.c',
-        'src/pjmedia/src/chainlink/chainlink_wire_port.c',
-        'src/pjmedia/src/chainlink/chainlink_fax.c',
+        'src/pjmedia/src/pjmedia/dtmfdet.c',
+        'src/pjmedia/src/pjmedia/fax_port.c',
       ],
     },
   ],

package/build_deps.sh

@@ -74,10 +74,10 @@ fi
 
 
 cd $START_DIR/3rdParty
-if [[ ! -d boost_1_51_0 ]]
+if [[ ! -d boost_1_66_0 ]]
 then
-    wget http://sourceforge.net/projects/boost/files/boost/1.51.0/boost_1_51_0.tar.bz2
-    tar xf boost_1_51_0.tar.bz2
+    wget https://downloads.sourceforge.net/project/boost/boost/1.66.0/boost_1_66_0.tar.bz2
+    tar xf boost_1_66_0.tar.bz2
 fi
 
 

package/package.json

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

package/samples/100_calls.js

@@ -1,4 +1,4 @@
-// This test creates 256 caller UDP SIP endpoints, 256 callee UDP SIP endpoines and makes one call between them, test dtmf and disconeects.
+// This test creates 100 caller UDP SIP endpoints, 100 callee UDP SIP endpoines and makes one call between them, test dtmf and disconnects.
 
 const sip = require ('../index.js')
 const Zeq = require('@mayama/zeq')

package/samples/multiple_audio_streams.js

@@ -0,0 +1,183 @@
+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)
+
+    const NUM_AUDIO_STREAMS = 8
+    const media = new Array(NUM_AUDIO_STREAMS).fill('audio').join(',')
+
+    const oc = sip.call.create(t1.id, {from_uri: 'sip:alice@test.com', to_uri: `sip:bob@${t2.address}:${t2.port}`, media: media})
+
+    // 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 2 streams
+    sip.call.respond(ic.id, {code: 200, reason: 'OK', media: media})
+
+    // 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(NUM_AUDIO_STREAMS)).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(NUM_AUDIO_STREAMS)).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)
+
+    await z.sleep(100) // wait for any unexpected events
+
+    console.log("Success")
+
+    sip.stop()
+}
+
+
+test()
+.catch(e => {
+    console.error(e)
+    process.exit(1)
+})
+

package/src/event_templates.cpp

@@ -49,7 +49,7 @@ int make_evt_dtmf(char *dest, int size, long call_id, int digits_len,
 
 int make_evt_call_ended(char *dest, int size, long call_id, int sip_msg_len,
                         const char *sip_msg) {
-  printf("make_evt_call_ended sip_msg_len=%i sip_msg=%x\n", sip_msg_len,
+  printf("make_evt_call_ended sip_msg_len=%i sip_msg=%s\n", sip_msg_len,
          sip_msg);
   if (!sip_msg || sip_msg == (char *)0xc000000000000) {
     // received invalid pointer to sip_msg so do not add the message to the
@@ -72,8 +72,8 @@ int make_evt_non_dialog_request(char *dest, int size, long transport_id,
                                 long request_id, int sip_msg_len,
                                 const char *sip_msg) {
   return snprintf(dest, size,
-                  "{\"event\": \"non_dialog_request\", \"request_id\": %i, "
-                  "\"transport_id\": %i}\n%.*s",
+                  "{\"event\": \"non_dialog_request\", \"request_id\": %li, "
+                  "\"transport_id\": %li}\n%.*s",
                   request_id, transport_id, sip_msg_len, sip_msg);
 }
 
@@ -85,7 +85,7 @@ int make_evt_internal_error(char *dest, int size, const char *msg) {
 int make_evt_reinvite(char *dest, int size, long call_id, int sip_msg_len,
                       char *sip_msg) {
   return snprintf(dest, size,
-                  "{\"event\": \"reinvite\", \"call_id\": %i}\n%.*s", call_id,
+                  "{\"event\": \"reinvite\", \"call_id\": %li}\n%.*s", call_id,
                   sip_msg_len, sip_msg);
 }
 

package/src/pjmedia/include/pjmedia/fax_port.h

@@ -0,0 +1,25 @@
+#ifndef __FAX_PORT_H__
+#define __FAX_PORT_H__
+
+#include <pjmedia/port.h>
+
+PJ_BEGIN_DECL
+
+PJ_DECL(pj_status_t) pjmedia_fax_port_create( pj_pool_t *pool,
+                unsigned clock_rate,
+                unsigned channel_count,
+                unsigned samples_per_frame,
+                unsigned bits_per_sample,
+                void (*cb)(pjmedia_port*,
+                    void *user_data,
+                    int result),
+                void *user_data,
+                int is_sender,
+                const char *file,
+                unsigned flags,
+                pjmedia_port **p_port);
+
+
+PJ_END_DECL
+
+#endif	/* __FAX_PORT_H__ */

package/src/pjmedia/src/pjmedia/dtmfdet.c

@@ -20,13 +20,15 @@
 
 #include <pjmedia/dtmfdet.h>
 #include <pjmedia/errno.h>
+#include <pjmedia/port.h>
 #include <pj/assert.h>
 #include <pj/pool.h>
 #include <pj/string.h>
 
 #include <spandsp.h>
+#include <spandsp/expose.h>
 
-#define SIGNATURE   PJMEDIA_PORT_SIGNATURE('d', 't', 'd', 't')
+#define SIGNATURE   PJMEDIA_SIGNATURE('d', 't', 'd', 't')
 #define THIS_FILE   "dtmfdet.c"
 
 #if 0
@@ -36,12 +38,12 @@
 #endif
 
 static pj_status_t dtmfdet_put_frame(pjmedia_port *this_port, 
-				  const pjmedia_frame *frame);
+				  pjmedia_frame *frame);
 static pj_status_t dtmfdet_on_destroy(pjmedia_port *this_port);
 
 struct dtmfdet
 {
-	pjmedia_port	base;
+	struct pjmedia_port	base;
 	dtmf_rx_state_t state;
     	void (*dtmf_cb)(pjmedia_port*, void*, char);
     	void *dtmf_cb_user_data;
@@ -106,13 +108,13 @@ PJ_DEF(pj_status_t) pjmedia_dtmfdet_create( pj_pool_t *pool,
 }
 
 static pj_status_t dtmfdet_put_frame(pjmedia_port *this_port, 
-				  const pjmedia_frame *frame)
+				  pjmedia_frame *frame)
 {
     if(frame->type != PJMEDIA_FRAME_TYPE_AUDIO) return PJ_SUCCESS;
 
     struct dtmfdet *dport = (struct dtmfdet*) this_port;
     dtmf_rx(&dport->state, (const pj_int16_t*)frame->buf,
-		dport->base.info.samples_per_frame);
+		PJMEDIA_PIA_SPF(&dport->base.info));
 
     return PJ_SUCCESS;
 

package/src/pjmedia/src/pjmedia/fax_port.c

@@ -0,0 +1,278 @@
+
+#include "fax_port.h"
+#include <pjmedia/errno.h>
+#include <pjmedia/port.h>
+#include <pj/assert.h>
+#include <pj/lock.h>
+#include <pj/pool.h>
+#include <pj/string.h>
+
+#include "siplab_constants.h"
+
+#define SPANDSP_EXPOSE_INTERNAL_STRUCTURES
+#include <spandsp.h>
+
+#define SIGNATURE   PJMEDIA_SIGNATURE('f', 'a', 'x', 'p')
+#define THIS_FILE   "fax_port.c"
+
+#if 0
+#   define TRACE_(expr)	PJ_LOG(4,expr)
+#else
+#   define TRACE_(expr)
+#endif
+
+#define FAX_DATA_CHUNK 320
+#define T38_DATA_CHUNK 160
+
+enum
+{
+    /*! No compression */
+    T30_SUPPORT_NO_COMPRESSION = 0x01,
+    /*! T.1 1D compression */
+    T30_SUPPORT_T4_1D_COMPRESSION = 0x02,
+    /*! T.4 2D compression */
+    T30_SUPPORT_T4_2D_COMPRESSION = 0x04,
+    /*! T.6 2D compression */
+    T30_SUPPORT_T6_COMPRESSION = 0x08,
+    /*! T.85 monochrome JBIG compression */
+    T30_SUPPORT_T85_COMPRESSION = 0x10,
+    /*! T.43 colour JBIG compression */
+    T30_SUPPORT_T43_COMPRESSION = 0x20,
+    /*! T.45 run length colour compression */
+    T30_SUPPORT_T45_COMPRESSION = 0x40,
+    /*! T.81 + T.30 Annex E colour JPEG compression */
+    T30_SUPPORT_T81_COMPRESSION = 0x80,
+    /*! T.81 + T.30 Annex K colour sYCC-JPEG compression */
+    T30_SUPPORT_SYCC_T81_COMPRESSION = 0x100,
+    /*! T.88 monochrome JBIG2 compression */
+    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, 
+				  pjmedia_frame *frame);
+static pj_status_t fax_on_destroy(pjmedia_port *this_port);
+
+struct fax_device
+{
+    struct pjmedia_port base;
+	fax_state_t fax;
+	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(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(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(void* user_data, int result)
+{
+	printf("fax phase_e_handler user_data=%p result=%i\n", user_data, result);
+
+    if (!user_data) {
+        printf("not user_data\n");    
+        return;
+    }
+
+    struct fax_device *fd = (struct fax_device*)user_data;
+	if(!fd->fax_cb) {
+        printf("not fax_cb\n");
+        return;
+    }
+
+    if(!fd->result_sent) {
+	    fd->fax_cb((pjmedia_port*)fd, fd->fax_cb_user_data, result);
+        fd->result_sent = true;
+    } 
+}
+
+static int document_handler(void* user_data, int result)
+{
+	printf("fax document_handler user_data=%p result=%i\n", user_data, result);
+
+    if (!user_data) return 0;
+
+    struct fax_device *fd = (struct fax_device*)user_data;
+	if(!fd->fax_cb) return 0;
+
+    if(!fd->result_sent) {
+	    fd->fax_cb((pjmedia_port*)fd, fd->fax_cb_user_data, result);
+        fd->result_sent = true;
+    } 
+
+    return 0;
+}
+
+PJ_DEF(pj_status_t) pjmedia_fax_port_create( pj_pool_t *pool,
+				unsigned clock_rate,
+				unsigned channel_count,
+				unsigned samples_per_frame,
+				unsigned bits_per_sample,
+				void (*cb)(pjmedia_port*, 
+					void *user_data, 
+					int result), 
+				void *user_data,
+				int is_sender,
+				const char *file,
+                unsigned flags,
+				pjmedia_port **p_port)
+{
+    struct fax_device *fd;
+    const pj_str_t name = pj_str("fax_device");
+
+    PJ_ASSERT_RETURN(pool && clock_rate && channel_count && 
+		     samples_per_frame && bits_per_sample == 16 && 
+		     p_port != NULL, PJ_EINVAL);
+
+    PJ_ASSERT_RETURN(pool && p_port, PJ_EINVAL);
+
+    fd = PJ_POOL_ZALLOC_T(pool, struct fax_device);
+    PJ_ASSERT_RETURN(pool != NULL, PJ_ENOMEM);
+
+    pjmedia_port_info_init(&fd->base.info, &name, SIGNATURE, clock_rate,
+			   channel_count, bits_per_sample, samples_per_frame);
+
+    fd->base.get_frame = &fax_get_frame;
+    fd->base.put_frame = &fax_put_frame;
+    fd->base.on_destroy = &fax_on_destroy;
+
+	fax_init(&fd->fax, is_sender);
+
+	t30_state_t *t30 = fax_get_t30_state(&fd->fax);
+
+	span_log_set_level(fax_get_logging_state(&fd->fax), SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | SPAN_LOG_FLOW);
+	span_log_set_level(t30_get_logging_state(t30), SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | SPAN_LOG_FLOW);
+
+	char ident[] = "fax_port";
+
+    t30_set_tx_ident(t30, ident);
+    t30_set_phase_b_handler(t30, &phase_b_handler, (void*)fd);
+    t30_set_phase_d_handler(t30, &phase_d_handler, (void*)fd);
+	t30_set_phase_e_handler(t30, &phase_e_handler, (void*)fd);
+    //printf("setting document_handler with user_data=%p\n", (void*)fd);
+	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);
+
+    if (status != PJ_SUCCESS) {
+		printf("failed to create lock\n");
+		return status;
+    }
+
+    if (is_sender)
+		t30_set_tx_file(t30,file,-1,-1);
+    else
+		t30_set_rx_file(t30,file,-1);
+
+    t30_set_ecm_capability(t30,1);
+    t30_set_supported_compressions(t30,T30_SUPPORT_T4_1D_COMPRESSION |
+        T30_SUPPORT_T4_2D_COMPRESSION | T30_SUPPORT_T6_COMPRESSION);
+
+    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;
+
+    TRACE_((THIS_FILE, "fax_device created: %u/%u/%u/%u", clock_rate, 
+	    channel_count, samples_per_frame, bits_per_sample));
+
+    *p_port = &fd->base; 
+    return PJ_SUCCESS;
+}
+
+// called when pjmedia needs data to be sent out
+static pj_status_t fax_get_frame(pjmedia_port *this_port,
+					pjmedia_frame *frame) {
+
+	//printf("ENTER fax_get_frame frame_size=%i\n", frame->size);
+
+	PJ_ASSERT_RETURN(this_port && frame, PJ_EINVAL);
+	//char *p = (char*)frame->buf; // TODO: remove
+
+	struct fax_device *fd = (struct fax_device*)this_port;
+    pj_lock_acquire(fd->lock);
+
+	int tx = 0;
+
+	if ((tx = fax_tx(&fd->fax, (int16_t *)frame->buf, frame->size/2)) < 0) {
+		printf("fax_tx reported an error\n");
+		pj_lock_release(fd->lock);
+		printf("EXIT fax_get_frame\n");
+		return PJ_FALSE;
+	}
+    pj_lock_release(fd->lock);
+
+    frame->type = PJMEDIA_FRAME_TYPE_AUDIO;
+    frame->timestamp.u64 = 0;
+
+	//printf("EXIT fax_get_frame\n");
+    return PJ_SUCCESS;
+}
+
+// called when pjmedia has received data
+static pj_status_t fax_put_frame(pjmedia_port *this_port, 
+				  pjmedia_frame *frame)
+{
+    if(frame->type != PJMEDIA_FRAME_TYPE_AUDIO) return PJ_SUCCESS;
+	//printf("ENTER fax_put_frame frame->buf=%x frame->size=%i\n", frame->buf, frame->size);
+
+    struct fax_device *fd = (struct fax_device*) this_port;
+    pj_lock_acquire(fd->lock);
+
+    unsigned int pos = 0;
+
+    while (pos < frame->size)
+    {
+		// feed the decoder with small chunks of data (16 bytes/ms)
+		int len = frame->size - pos;
+		if (len > FAX_DATA_CHUNK) len = FAX_DATA_CHUNK;
+
+		/* Pass the new incoming audio frame to the fax_rx function */
+		if (fax_rx(&fd->fax, (int16_t *)(frame->buf)+pos, len/2)) {
+			printf("fax_rx reported an error\n");
+			pj_lock_release(fd->lock);
+			printf("EXIT fax_put_frame\n");
+			return 0;
+		}
+
+		pos += len;
+    }
+
+	pj_lock_release(fd->lock);
+
+    return PJ_SUCCESS;
+}
+
+/*
+ * Destroy port.
+ */
+static pj_status_t fax_on_destroy(pjmedia_port *this_port)
+{
+	printf("fax_on_destroy\n");
+
+	struct fax_device *fd = (struct fax_device*)this_port;
+
+    fax_release(&fd->fax);
+
+	if(fd->lock) pj_lock_destroy(fd->lock);
+    return PJ_SUCCESS;
+}
+