@babblevoice/babble-drachtio-callmanager 2.1.2 → 2.2.1

package/index.js

@@ -12,7 +12,8 @@ const default_options = {
   "rfc2833": true,  /* Enable RFC 2833 - DTMF */
   "late": false,  /* Late negotiation */
   "registrar": false, /* our registrar object or falsey */
-  "referauthrequired": true
+  "referauthrequired": true,
+  "ignoreipv6candidates": true /* ipv6 does not work in projectrtp */
 }
 
 /**

package/lib/call.js

@@ -11,6 +11,8 @@ const callstore = require( "./store.js" )
 
 const sipauth = require( "@babblevoice/babble-drachtio-auth" )
 
+const ipv6regex = /^(?:(?:[a-fA-F\d]{1,4}:){7}(?:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){6}(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|:[a-fA-F\d]{1,4}|:)|(?:[a-fA-F\d]{1,4}:){5}(?::(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,2}|:)|(?:[a-fA-F\d]{1,4}:){4}(?:(?::[a-fA-F\d]{1,4}){0,1}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,3}|:)|(?:[a-fA-F\d]{1,4}:){3}(?:(?::[a-fA-F\d]{1,4}){0,2}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,4}|:)|(?:[a-fA-F\d]{1,4}:){2}(?:(?::[a-fA-F\d]{1,4}){0,3}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,5}|:)|(?:[a-fA-F\d]{1,4}:){1}(?:(?::[a-fA-F\d]{1,4}){0,4}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,6}|:)|(?::(?:(?::[a-fA-F\d]{1,4}){0,5}:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}|(?::[a-fA-F\d]{1,4}){1,7}|:)))(?:%[0-9a-zA-Z]{1,})?$/gm
+
 /*
 Enum for different reasons for hangup.
 */
@@ -910,8 +912,15 @@ class call {
   static async _parsesdpcandidates( target, sdp ) {
 
     if( Array.isArray( sdp.media[ 0 ].candidates ) ) {
-      const candidates = sdp.media[ 0 ].candidates
+      let candidates = sdp.media[ 0 ].candidates
       if( 0 < candidates.length ) {
+        if( callmanager.options.ignoreipv6candidates ) {
+          candidates = candidates.filter( ( c ) => { 
+            const ismatch = ipv6regex.test( c.ip )
+            return !ismatch
+          } )
+        }
+        
         candidates.sort( ( l, r ) => { return r.priority - l.priority } )
         target.port = candidates[ 0 ].port
 
@@ -1356,9 +1365,7 @@ class call {
         .setconnectionaddress( this.channels.audio.local.address )
         .setaudioport( this.channels.audio.local.port )
 
-      if( this.options.rfc2833 ) {
-        this.sdp.local.addcodecs( "2833" )
-      }
+      this.#checkandadd2833()
 
       if( this._iswebrtc ) {
         this.sdp.local.addssrc( this.channels.audio.local.ssrc )
@@ -1379,13 +1386,13 @@ class call {
       if( !this.selectedcodec ) {
         return this.hangup( hangupcodes.INCOMPATIBLE_DESTINATION )
       }
+
+      this.sdp.remote.select( this.selectedcodec )
       
       const remoteaudio = this.sdp.remote.getaudio()
       if( !remoteaudio ) {
         return this.hangup( hangupcodes.INCOMPATIBLE_DESTINATION )
       }
-
-      this.sdp.remote.select( this.selectedcodec )
       
       await call._parsesdpcandidates( remoteaudio, this.sdp.remote.sdp )
 
@@ -2494,6 +2501,20 @@ class call {
 
   }
 
+  /**
+   * If we have remote sdp we have to check they support 2833 before we add backand our options permit it.
+   * If we have no remote sdp then we only check our options.
+   */
+  #checkandadd2833() {
+    if( this.sdp.remote ) {
+      if( this.options.rfc2833 && this.sdp.remote.has( "2833" ) ) {
+        this.sdp.local.addcodecs( "2833" )
+      }
+    } else if( this.options.rfc2833 ) {
+      this.sdp.local.addcodecs( "2833" )
+    }
+  }
+
   /**
    * 
    */
@@ -2508,9 +2529,7 @@ class call {
       this.sdp.local.setaudioport( this.channels.audio.local.port )
         .setconnectionaddress( this.channels.audio.local.address )
 
-      if( this.options.rfc2833 ) {
-        this.sdp.local.addcodecs( "2833" )
-      }
+      this.#checkandadd2833()
 
       /* DTLS is only supported ( outbound ) on websocket connections */
       this.sip.contact = this.options.contact

package/lib/sdp.js

@@ -417,6 +417,30 @@ class sdp {
     return this
   }
 
+  /**
+   * Gets a list of codecs (that we support) and return as an array of strings.
+   * @param { string } type 
+   * @returns { array< string > } array of codec names in the format [ "pcma" ]
+   */
+  #codecs( type = "audio" ) {
+
+    const audio = this.getmedia( type )
+
+    /* work out an array of codecs on this side in the format of [ "pcma", "pcmu" ] */
+    const ourcodecs = []
+    for( const pt of audio.payloads ) {
+      if( undefined === codecconv[ pt ] ) continue
+      if( 97 == pt ) {
+        if( -1 == getconfigforpt( audio, 97 ).indexOf( "mode=30" ) )
+          ourcodecs.push( codecconv[ pt ] )
+      } else {
+        ourcodecs.push( codecconv[ pt ] )
+      }
+    }
+
+    return ourcodecs
+  }
+
   /*
   Only allow CODECs supported by both sides.
   other can be:
@@ -436,23 +460,7 @@ class sdp {
 
     /* ensure other side is on the format [ "pcma", "pcmu" ] */
     other = alltocodecname( other )
-
-    let audio = []
-    for( const m of this.sdp.media ) {
-      if( "audio" == m.type ) audio = m
-    }
-
-    /* work out an array of codecs on this side in the format of [ "pcma", "pcmu" ] */
-    const ourcodecs = []
-    for( const pt of audio.payloads ) {
-      if( undefined === codecconv[ pt ] ) continue
-      if( 97 == pt ) {
-        if( -1 == getconfigforpt( audio, 97 ).indexOf( "mode=30" ) )
-          ourcodecs.push( codecconv[ pt ] )
-      } else {
-        ourcodecs.push( codecconv[ pt ] )
-      }
-    }
+    const ourcodecs = this.#codecs()
 
     /* intersection */
     let retval = other.filter( value => ourcodecs.includes( value ) )
@@ -469,6 +477,23 @@ class sdp {
     return full
   }
 
+  /**
+   * See other param in intersection. Confirms that we have 
+   * support for at least one of the codecs in codecs
+   * @param { array< string > | string } codecs 
+   */
+  has( codecs ) {
+
+    const ourcodecs = this.#codecs()
+    codecs = alltocodecname( codecs )
+
+    /* intersection */
+    if( undefined === codecs.find( value => ourcodecs.includes( value ) ) ) return false
+
+    return true
+
+  }
+
   toString() {
 
     /* We need to convert payloads back to string to stop a , being added */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "2.1.2",
+  "version": "2.2.1",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {

package/test/interface/sdp.js

@@ -1,8 +1,9 @@
 
 
 const expect = require( "chai" ).expect
-const sdp = require( "../../lib/sdp.js" )
-const call = require( "../../lib/call.js" )
+const sdp = require( "../../lib/sdp" )
+const call = require( "../../lib/call" )
+const callmanager = require( "../../index" )
 
 describe( "sdp", function() {
 
@@ -643,4 +644,133 @@ a=rtcp-mux`
     expect( bvdesktopinvite200sdpobj.intersection( ourcodecs, true ) ).to.equal( "g722" )
     expect( magrathea200sdpobj.intersection( ourcodecs, true ) ).to.equal( "pcma" )
   } )
+
+  it( "outbound example - inc ipv6", async () => {
+
+    const sdpstr = `v=0
+o=- 7873703533563891424 2 IN IP4 127.0.0.1
+s=-
+t=0 0
+a=group:BUNDLE 0
+a=extmap-allow-mixed
+a=msid-semantic: WMS a46039f4-1857-410e-b1cc-215c09878068
+m=audio 41645 UDP/TLS/RTP/SAVPF 111 63 9 0 8 13 110 126
+c=IN IP4 86.169.150.38
+a=rtcp:9 IN IP4 0.0.0.0
+a=candidate:532873972 1 udp 2122131711 2a00:23c6:e093:a801:6722:f7bb:aeeb:5e04 39087 typ host generation 0 network-id 4 network-cost 10
+a=candidate:226183667 1 udp 1685987071 86.169.150.38 41645 typ srflx raddr 172.17.0.1 rport 41645 generation 0 network-id 2
+a=ice-ufrag:c97P
+a=ice-pwd:sK0NGVPIIx4/qEX+tCVW5dzH
+a=ice-options:trickle
+a=fingerprint:sha-256 0F:37:28:0F:66:1B:7E:D5:36:A4:EB:2D:D4:A8:6E:33:69:31:3B:D4:7B:71:0B:DE:41:09:D1:6C:1E:56:02:1C
+a=setup:actpass
+a=mid:0
+a=extmap:1 urn:ietf:params:rtp-hdrext:ssrc-audio-level
+a=extmap:2 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time
+a=extmap:3 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01
+a=extmap:4 urn:ietf:params:rtp-hdrext:sdes:mid
+a=sendrecv
+a=msid:a46039f4-1857-410e-b1cc-215c09878068 ce8c9c25-2ea0-4079-aaa5-54f771d53310
+a=rtcp-mux
+a=rtpmap:111 opus/48000/2
+a=rtcp-fb:111 transport-cc
+a=fmtp:111 minptime=10;useinbandfec=1
+a=rtpmap:63 red/48000/2
+a=fmtp:63 111/111
+a=rtpmap:9 G722/8000
+a=rtpmap:0 PCMU/8000
+a=rtpmap:8 PCMA/8000
+a=rtpmap:13 CN/8000
+a=rtpmap:110 telephone-event/48000
+a=rtpmap:126 telephone-event/8000
+a=ssrc:222390620 cname:q7Is0hRbTrTbcMJM
+a=ssrc:222390620 msid:a46039f4-1857-410e-b1cc-215c09878068 ce8c9c25-2ea0-4079-aaa5-54f771d53310
+    `
+    callmanager.callmanager( { srf: { use: () => {} } } )
+    const sdpobj = sdp.create( sdpstr )
+    const target = {}
+    await call._parsesdpcandidates( target, sdpobj.sdp )
+    sdpobj.intersection( "g722", true )
+
+    /* our default is to ignore IPv6 addresses (until projectrtp supports it) */
+    expect( target.port ).to.equal( 41645 )
+    expect( target.address ).to.equal( "86.169.150.38" )
+
+    
+  } )
+
+  it( "codec has", async () => {
+
+    const sdpwith2833 = `v=0
+o=- 4317 0 IN IP4 127.0.0.1
+s=project
+c=IN IP4 13.42.100.66
+t=0 0
+a=msid-semantic: WMS 136f9ec7464dca67065c81da42013e84
+m=audio 10036 UDP/TLS/RTP/SAVPF 9 101
+a=rtpmap:9 G722/8000
+a=rtpmap:101 telephone-event/8000
+a=fmtp:101 0-16
+a=setup:passive
+a=msid:136f9ec7464dca67065c81da42013e84 ff8ebd1be43cdf5170974bf0d1efb772
+a=ptime:20
+a=sendrecv
+a=ice-ufrag:50cf0e6109bad2be
+a=ice-pwd:9Tbl7U92hrzTUluayFbRPYh9
+a=fingerprint:sha-256 12:31:FB:95:BB:00:1A:D8:24:94:71:21:CE:05:57:8F:47:1E:5E:C5:43:41:19:3F:2A:B8:8C:92:07:BB:BC:56
+a=candidate:1 1 udp 255 13.42.100.66 10036 typ host generation 0
+a=ssrc:3127369874 cname:97016b88e9a33a3b465b15cff21fec35
+a=ssrc:3127369874 msid:136f9ec7464dca67065c81da42013e84 ff8ebd1be43cdf5170974bf0d1efb772
+a=ssrc:3127369874 mslabel:136f9ec7464dca67065c81da42013e84
+a=ssrc:3127369874 label:ff8ebd1be43cdf5170974bf0d1efb772
+a=rtcp-mux`
+
+    const sdpwithout2833 = `v=0
+o=- 4316 0 IN IP4 127.0.0.1
+s=project
+c=IN IP4 18.170.39.61
+t=0 0
+m=audio 10038 RTP/AVP 9 97 0 8
+a=rtpmap:9 G722/8000
+a=rtpmap:97 ilbc/8000
+a=rtpmap:0 PCMU/8000
+a=rtpmap:8 PCMA/8000
+a=fmtp:97 mode=20
+a=ptime:20
+a=sendrecv`
+
+    const noilbc30 = `v=0
+o=Z 1608292844058 1 IN IP4 192.168.0.141
+s=Z
+c=IN IP4 192.168.0.141
+t=0 0
+m=audio 56802 RTP/AVP 8 0 9 106 101 98 97
+a=rtpmap:106 opus/48000/2
+a=fmtp:106 minptime=20; cbr=1; maxaveragebitrate=40000; useinbandfec=1
+a=rtpmap:101 telephone-event/8000
+a=fmtp:101 0-16
+a=rtpmap:98 telephone-event/48000
+a=fmtp:98 0-16
+a=rtpmap:97 iLBC/8000
+a=fmtp:97 mode=30
+a=sendrecv`
+
+    const sdpwith2833obj = sdp.create( sdpwith2833 )
+    const sdpwithout2833obj = sdp.create( sdpwithout2833 )
+    const noilbc30obj = sdp.create( noilbc30 )
+    
+    expect( sdpwith2833obj.has( "2833" ) ).to.be.true
+    expect( sdpwith2833obj.has( "pcmu" ) ).to.be.false
+    expect( sdpwith2833obj.has( "pcma" ) ).to.be.false
+
+
+    expect( sdpwithout2833obj.has( "2833" ) ).to.be.false
+    expect( sdpwithout2833obj.has( "g722" ) ).to.be.true
+    expect( sdpwithout2833obj.has( "ilbc" ) ).to.be.true
+
+    expect( noilbc30obj.has( "ilbc" ) ).to.be.false
+    expect( noilbc30obj.has( "2833" ) ).to.be.true
+    expect( noilbc30obj.has( "g722" ) ).to.be.true
+
+  } )
 } )