use inject dtmf only for webrtc clients (https://github.com/jambonz/sbc-inbound/issues/222)

.gitignore

@@ -34,7 +34,5 @@ build/Release
 node_modules
 
 .DS_Store
-.vscode
 
 examples/*
-CLAUDE.md

README.md

@@ -29,19 +29,9 @@ Configuration is provided via environment variables:
 |JAMBONES_RTPENGINES| commans-separated list of ip:ng-port for rtpengines (e.g. '172.31.32.10:22222')|yes|
 |JAMBONES_TIME_SERIES_HOST| influxdb host |yes|
 |JAMBONES_RECORD_ALL_CALLS| enable auto record calls |no|
-|JAMBONES_CODEC_OFFER_WITH_ORDER| comma-separated codec list to use as the outbound offer toward the carrier; the original codecs from the feature server are stripped first (e.g. `'opus,PCMU,PCMA,telephone-event'`) |no|
-|JAMBONES_CODEC_TRANSCODE| comma-separated codec list that rtpengine should add to the outbound offer and transcode on the fly when the carrier selects them — used to support codecs the feature server does not speak (e.g. `'AMR-WB/16000'`). Requires an rtpengine build that includes the corresponding codec module. |no|
-|JAMBONES_ACCEPT_AND_TRANSCODE| comma-separated codec list to accept on the outbound leg and transcode to PCMU/PCMA toward the feature server |no|
-|JAMBONES_ACCEPT_G729| if set, accept G.729 on the outbound leg and transcode to PCMU/PCMA (shorthand for `JAMBONES_ACCEPT_AND_TRANSCODE=g729`) |no|
 |K8S| service running as kubernetes service |no|
 |K8S_RTPENGINE_SERVICE_NAME| rtpengine service name(required for K8S) |no|
 
-#### Codec transcoding notes
-
-`JAMBONES_CODEC_OFFER_WITH_ORDER` and `JAMBONES_CODEC_TRANSCODE` can be combined. When both are set, rtpengine first strips the original codecs from the SDP, then adds the codecs listed in `JAMBONES_CODEC_OFFER_WITH_ORDER` to the offer, and finally adds the codecs from `JAMBONES_CODEC_TRANSCODE` with transcoding enabled. When only `JAMBONES_CODEC_TRANSCODE` is set, the original codecs from the feature server are kept in the offer and the transcode codecs are appended.
-
-Codecs that require licensed or optional rtpengine modules (AMR, AMR-WB, G.729, etc.) only work if rtpengine was compiled with support for them. Carrier-specific fmtp parameters (for example, `octet-align=1` for AMR-WB) can be appended to the codec name as needed (e.g. `AMR-WB/16000;octet-align=1`).
-
 ### running under pm2
 Typically, this application runs under [pm2](https://pm2.io) using an [ecosystem.config.js](https://pm2.keymetrics.io/docs/usage/application-declaration/) file similar to this:
 ```js

data/srtp-transcoding.json

@@ -4,7 +4,7 @@
     "ICE": "force",
     "SDES": "off",
     "flags": ["generate mid", "SDES-no", "port latching"],
-    "rtcp-mux": ["offer"]
+    "rtcp-mux": ["require"]  
   },
   "teams": {
     "transport-protocol": "RTP/SAVP",

lib/call-session.js

@@ -1,4 +1,5 @@
 const Emitter = require('events');
+const sdpTransform = require('sdp-transform');
 const SrsClient = require('@jambonz/siprec-client-utils');
 const {
   makeRtpEngineOpts,
@@ -8,7 +9,7 @@ const {
   makeFullMediaReleaseKey,
   makePartnerFullMediaReleaseKey,
   isValidDomainOrIP,
-  removeVideoSdp,
+  removeVideoSdp
 } = require('./utils');
 const { MediaPath } = require('./constants.json');
 const {forwardInDialogRequests} = require('drachtio-fn-b2b-sugar');
@@ -94,6 +95,18 @@ const initCdr = (req, invite) => {
   };
 };
 
+const updateRtpEngineFlags = (sdp, opts) => {
+  try {
+    const parsed = sdpTransform.parse(sdp);
+    const codec = parsed.media[0].rtp[0].codec;
+    if (['PCMU', 'PCMA'].includes(codec)) {
+      opts.flags.push(`codec-accept-${codec}`);
+      opts.flags.push('codec-accept-telephone-event');
+    }
+  } catch {}
+  return opts;
+};
+
 class CallSession extends Emitter {
   constructor(logger, req, res) {
     super();
@@ -110,7 +123,6 @@ class CallSession extends Emitter {
     this.decrKey = req.srf.locals.realtimeDbHelpers.decrKey;
     this.addKey = req.srf.locals.realtimeDbHelpers.addKey;
     this.retrieveKey = req.srf.locals.realtimeDbHelpers.retrieveKey;
-    this.retrieveHash = req.srf.locals.realtimeDbHelpers.retrieveHash;
 
     const {
       lookupOutboundCarrierForAccount,
@@ -237,24 +249,6 @@ class CallSession extends Emitter {
         this.logger.info(`sending call to registered user ${destUri}`);
       }
       else if (this.req.locals.target === 'forward') {
-        /* the feature-server sets X-Jambonz-SRTP (from the dial verb's srtpEncryption
-           option) to request encrypted media on a per-call basis */
-        const srtpMode = this.req.get('X-Jambonz-SRTP');
-        if (srtpMode) {
-          /* SDES (RTP/SAVP): pass teams=true to select the SDES srtp profile, matching
-             the proven carrier tls/srtp path above. This offers a=crypto to the target
-             (what SIP endpoints such as LiveKit expect), not DTLS-SRTP. */
-          this.logger.info({uri: this.req.uri, srtpMode},
-            'using SRTP (SDES) for forwarded call per X-Jambonz-SRTP');
-          this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, true, false, true);
-          encryptedMedia = true;
-        }
-        else if (process.env.JAMBONES_SIPS_FORWARD_SRTP && this.req.uri.startsWith('sips:')) {
-          /* legacy global opt-in for sips: forwards (uses the DTLS srtp profile) */
-          this.logger.info({uri: this.req.uri}, 'using SRTP/TLS for forwarded sips: call');
-          this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, true, false, false);
-          encryptedMedia = true;
-        }
         uris = [{
           private_network: await isPrivateVoipNetwork(this.req.uri),
           uri: this.req.uri
@@ -370,8 +364,7 @@ class CallSession extends Emitter {
                  * like a rare use case -- encryption is usually an all or nothing requirement.
                  */
                 this.logger.info({u}, `using SRTP for outbound call, pad crypto: ${o.pad_crypto ? 'yes' : 'no'}`);
-                // eslint-disable-next-line max-len
-                this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, true, o.pad_crypto, true, o.remove_ice, o.dtls_off);
+                this.rtpEngineOpts = makeRtpEngineOpts(this.req, false, true, o.pad_crypto, true);
                 encryptedMedia = true;
               }
             });
@@ -403,13 +396,13 @@ class CallSession extends Emitter {
       const toPublic = uris.some((u) => u.private_network === false);
       let isOfferUpdatedToPrivate = toPrivate && !toPublic;
 
-      const opts = {
+      const opts = updateRtpEngineFlags(this.req.body, {
         ...this.rtpEngineOpts.common,
         ...this.rtpEngineOpts.uac.mediaOpts,
         'from-tag': this.rtpEngineOpts.uas.tag,
         direction:  ['private', toPublic ? 'public' : 'private'],
         sdp: this.req.body
-      };
+      });
       let response = await this.offer(opts);
       this.logger.debug({offer: opts, response}, 'initial offer to rtpengine');
       if ('ok' !== response.result) {
@@ -505,27 +498,23 @@ class CallSession extends Emitter {
         }
         else {
           const uri = parseUri(this.req.uri);
-          /* RFC 3261 8.1.1.8: a sips Request-URI requires a sips Contact */
-          const scheme = uri.scheme === 'sips' ? 'sips' : 'sip';
           hdrs = {
             ...hdrs,
             'From': createBLegFromHeader({
               logger: this.logger,
               req: this.req,
-              scheme,
               transport: uri.params.transport,
               ...(private_network && {host: this.privateSipAddress})
             }),
             'Contact': createBLegFromHeader({
               logger: this.logger,
               req: this.req,
-              scheme,
               transport: uri.params.transport,
               ...(private_network && {host: this.privateSipAddress})
             })
           };
           const p = proxy ? ` via ${proxy}` : '';
-          this.logger.info({uri, p}, `sending INVITE${p}`);
+          this.logger.info({uri, p}, `sending INVITE to ${uri}${p}`);
         }
 
         /* now launch an outbound call attempt */
@@ -548,7 +537,6 @@ class CallSession extends Emitter {
               '-X-Preferred-From-Host',
               '-X-Jambonz-FS-UUID',
               '-X-Voip-Carrier-Sid',
-              '-X-Jambonz-SRTP',
               '-X-SIP-Proxy'
             ],
             proxyResponseHeaders: [
@@ -566,17 +554,12 @@ class CallSession extends Emitter {
             localSdpB: response.sdp,
             localSdpA: async(sdp, res) => {
               this.rtpEngineOpts.uac.tag = res.getParsedHeader('To').params.tag;
-
               const opts = {
                 ...this.rtpEngineOpts.common,
                 ...this.rtpEngineOpts.uas.mediaOpts,
                 'from-tag': this.rtpEngineOpts.uas.tag,
                 'to-tag': this.rtpEngineOpts.uac.tag,
-                flags: [
-                  'single codec',
-                  'inject DTMF',
-                  'reuse codecs',
-                ],
+                flags: ['single codec'],
                 sdp
               };
               const response = await this.answer(opts);
@@ -683,21 +666,7 @@ class CallSession extends Emitter {
         }
       }
     } catch (err) {
-      if ('abandoned' !== err.message) this.logger.error({err}, `Error setting up outbound call to: ${uris}`);
-
-      /* the call count was incremented on 'init' but we bailed out before connecting (e.g. caller
-         hung up before the B leg answered), so we must decrement it here - no failure response is
-         sent on this path, so the res.once('end') safety net in middleware would not fire.
-         nudgeCallCounts is a no-op if the count was already decremented elsewhere. */
-      const {writeCallCount, writeCallCountSP, writeCallCountApp} = this.req.srf.locals;
-      nudgeCallCounts(this.req, 'failure', {
-        service_provider_sid: this.service_provider_sid,
-        account_sid: this.account_sid,
-        application_sid: this.application_sid,
-        callId: this.req.locals.callId
-      }, this.decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
-        .catch((err) => this.logger.error(err, 'Error decrementing call counts'));
-
+      if ('abandonded' !== err.message) this.logger.error({err}, `Error setting up outbound call to: ${uris}`);
       this.emit('failed');
       this.srf.endSession(this.req);
       this.rtpEngineResource.destroy();
@@ -762,13 +731,10 @@ class CallSession extends Emitter {
         if (this.req.locals.cdr) {
           const now = Date.now();
           const day = new Date();
-          // eslint-disable-next-line max-len
-          const {hasRecording = false} = await this.retrieveHash(`call:${this.account_sid}:${this.req.locals.cdr.call_sid}`) ?? {};
-          const recordAllCalls = this.req.locals.record_all_calls || hasRecording;
-          const record_format = this.req.locals.account.record_format || 'mp3';
+          const recordAllCalls = this.req.locals.record_all_calls;
           let recording_url = `/Accounts/${this.account_sid}/RecentCalls/${this.req.locals.cdr.call_sid}/record`;
           recording_url += `/${day.getFullYear()}/${(day.getMonth() + 1).toString().padStart(2, '0')}`;
-          recording_url += `/${day.getDate().toString().padStart(2, '0')}/${record_format}`;
+          recording_url += `/${day.getDate().toString().padStart(2, '0')}/${recordAllCalls}`;
           this.writeCdrs({...this.req.locals.cdr,
             terminated_at: now,
             termination_reason: dlg.type === 'uas' ? 'caller hungup' : 'called party hungup',
@@ -924,14 +890,8 @@ Duration=${payload.duration} `
         process.env.JAMBONES_ACCEPT_G729 ? 'g729' : '';
       offerMedia = { ...offerMedia, ...(acceptCodecs && dlg.type === 'uac' &&
         { codec: { mask: acceptCodecs, transcode: 'pcmu,pcma' } })};
-      answerMedia = { ...answerMedia, ...((process.env.JAMBONES_CODEC_OFFER_WITH_ORDER ||
-        process.env.JAMBONES_CODEC_TRANSCODE) && dlg.type === 'uac' &&
-        { codec: {
-          ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER &&
-            { offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','), strip: 'all' }),
-          ...(process.env.JAMBONES_CODEC_TRANSCODE &&
-            { transcode: process.env.JAMBONES_CODEC_TRANSCODE.split(',') })
-        }})};
+      answerMedia = { ...answerMedia, ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER && dlg.type === 'uac' &&
+        { codec: {offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','), strip: 'all' }})};
       let opts = {
         ...this.rtpEngineOpts.common,
         ...offerMedia,
@@ -1256,6 +1216,7 @@ Duration=${payload.duration} `
         ...(req.has('X-Retain-Call-Sid') && {'X-Retain-Call-Sid': req.get('X-Retain-Call-Sid')}),
         ...(req.has('X-Account-Sid') && {'X-Account-Sid': req.get('X-Account-Sid')})
       };
+
       const uac = await this.srf.createUAC(referTo.uri, {localSdp: dlg.local.sdp, headers});
       this.uas = uac;
       uac.type = 'uas';
@@ -1264,23 +1225,19 @@ Duration=${payload.duration} `
       uac.on('info', this._onInfo.bind(this, uac));
       uac.on('modify', this._onReinvite.bind(this, uac));
       uac.on('refer', this._onFeatureServerTransfer.bind(this, uac));
-      uac.on('destroy', async() => {
+      uac.on('destroy', () => {
         this.logger.info('call ended with normal termination');
         this.rtpEngineResource.destroy();
         this.activeCallIds.delete(this.req.get('Call-ID'));
         if (this.activeCallIds.size === 0) this.idleEmitter.emit('idle');
         uac.other.destroy();
-        this._stopRecording();
         if (this.req.locals.cdr) {
           const now = Date.now();
           const day = new Date();
-          // eslint-disable-next-line max-len
-          const {hasRecording = false} = await this.retrieveHash(`call:${this.account_sid}:${this.req.locals.cdr.call_sid}`) ?? {} ;
-          const recordAllCalls = this.req.locals.record_all_calls || hasRecording;
-          const record_format = this.req.locals.account.record_format || 'mp3';
+          const recordAllCalls = this.req.locals.record_all_calls;
           let recording_url = `/Accounts/${this.account_sid}/RecentCalls/${this.req.locals.cdr.call_sid}/record`;
           recording_url += `/${day.getFullYear()}/${(day.getMonth() + 1).toString().padStart(2, '0')}`;
-          recording_url += `/${day.getDate().toString().padStart(2, '0')}/${record_format}`;
+          recording_url += `/${day.getDate().toString().padStart(2, '0')}/${recordAllCalls}`;
           this.writeCdrs({...this.req.locals.cdr,
             terminated_at: now,
             termination_reason: 'caller hungup',

lib/utils.js

@@ -5,8 +5,7 @@ const CIDRMatcher = require('cidr-matcher');
 const dns = require('dns');
 const sdpTransform = require('sdp-transform');
 
-// eslint-disable-next-line max-len
-function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams, remove_ice = false, dtls_off = false) {
+function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams) {
   const from = req.getParsedHeader('from');
   const rtpCopy = JSON.parse(JSON.stringify(rtpCharacteristics));
   const srtpCopy = JSON.parse(JSON.stringify(srtpCharacteristics));
@@ -17,19 +16,11 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams
   }
 
   const srtpOpts = teams ? srtpCopy['teams'] : srtpCopy['default'];
+  const dstOpts = dstIsUsingSrtp ? srtpOpts : rtpCopy;
+  const srcOpts = srcIsUsingSrtp ? srtpOpts : rtpCopy;
 
-  if (remove_ice) {
-    srtpOpts.ICE = 'remove';
-  }
-  if (dtls_off) {
-    srtpOpts.DTLS = 'off';
-  }
-
-  const dstOpts = JSON.parse(JSON.stringify(dstIsUsingSrtp ? srtpOpts : rtpCopy));
-  const srcOpts = JSON.parse(JSON.stringify(srcIsUsingSrtp ? srtpOpts : rtpCopy));
-
-  /** Allow feature server to send DTMF to the call excepts call from/to teams */
-  if (!teams) {
+  /** Allow rtpengine to inject DTMF on calls from webrtc only (this disables kernel forwarding) */
+  if (!teams && (dstIsUsingSrtp || process.env.JAMBONES_RTPENGINE_INJECT_DTMF_ALWAYS)) {
     if (!dstOpts.flags.includes('inject DTMF')) {
       dstOpts.flags.push('inject DTMF');
     }
@@ -50,20 +41,6 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams
     'replace': ['origin', 'session-connection'],
     'record call': process.env.JAMBONES_RECORD_ALL_CALLS ? 'yes' : 'no'
   };
-
-  const codec = {
-    accept: ['PCMU', 'PCMA', 'telephone-event'],
-    ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER &&
-      {
-        offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','),
-        strip: 'all'
-      }),
-    ...(process.env.JAMBONES_CODEC_TRANSCODE &&
-      {
-        transcode: process.env.JAMBONES_CODEC_TRANSCODE.split(',')
-      }),
-  };
-
   return {
     common,
     uas: {
@@ -74,7 +51,8 @@ function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, padCrypto, teams
       tag: null,
       mediaOpts: {
         ...dstOpts,
-        codec,
+        ...(process.env.JAMBONES_CODEC_OFFER_WITH_ORDER &&
+          { codec: { offer: process.env.JAMBONES_CODEC_OFFER_WITH_ORDER.split(','), strip: 'all' } }),
       }
     }
   };
@@ -371,7 +349,6 @@ const removeVideoSdp = (sdp) => {
   parsedSdp.media = parsedSdp.media.filter((media) => media.type !== 'video');
   return sdpTransform.write(parsedSdp);
 };
-
 module.exports = {
   makeRtpEngineOpts,
   selectHostPort,
@@ -387,5 +364,5 @@ module.exports = {
   makeFullMediaReleaseKey,
   makePartnerFullMediaReleaseKey,
   isValidDomainOrIP,
-  removeVideoSdp,
+  removeVideoSdp
 };

package.json

@@ -1,9 +1,9 @@
 {
   "name": "sbc-outbound",
-  "version": "0.9.11",
+  "version": "0.9.5",
   "main": "app.js",
   "engines": {
-    "node": ">= 20.0.0"
+    "node": ">= 18.0.0"
   },
   "keywords": [
     "sip",
@@ -31,7 +31,7 @@
     "@jambonz/db-helpers": "^0.9.18",
     "@jambonz/http-health-check": "^0.0.1",
     "@jambonz/mw-registrar": "0.2.7",
-    "@jambonz/realtimedb-helpers": "^0.8.21",
+    "@jambonz/realtimedb-helpers": "^0.8.13",
     "@jambonz/rtpengine-utils": "^0.4.4",
     "@jambonz/siprec-client-utils": "^0.2.10",
     "@jambonz/stats-collector": "^0.1.10",
@@ -39,7 +39,7 @@
     "cidr-matcher": "^2.1.1",
     "debug": "^4.4.3",
     "drachtio-fn-b2b-sugar": "^0.2.1",
-    "drachtio-srf": "^5.0.21",
+    "drachtio-srf": "^5.0.12",
     "express": "^4.21.2",
     "pino": "^10.1.0",
     "sdp-transform": "^2.15.0"
@@ -48,7 +48,7 @@
     "bent": "^7.3.12",
     "eslint": "^9.17.0",
     "eslint-plugin-promise": "^7.2.1",
-    "nyc": "^17.1.0",
-    "tape": "^5.9.0"
+    "nyc": "^15.1.0",
+    "tape": "^5.7.5"
   }
 }