DTMF从2833到inband的方案

概述

freeswitch是一款简单好用的VOIP开源软交换平台。

之前的文章中介绍过通过dialplan拨号计划配置的方法，实现2833到inband的转换，但是实际生产环境中的场景会更复杂，无法预先在dialplan中设置好相关参数和函数。

环境

CentOS 7.9

freeswitch 1.10.7

问题描述

在与运营商的对接过程中，因为对传统PSTN线路的兼容，被叫侧并不是所有的号码都支持2833，B路响应的SDP中会没有rfc2833的媒体描述，也可能183SDP中支持2833，但是200SDP中不支持2833。

fs对于该场景并没有简单的配置方案，默认的处理逻辑会使用INFO消息来转发DTMF，但是运营商并不支持该方式。

所以，我们需要一种简单的配置即可实现的rfc2833到inband的DTMF转发模式。

默认流程

从SDP媒体协商的日志中看到，协商过程都是在“switch_core_media_negotiate_sdp”函数实现的。

fs默认的dtmf匹配流程如下，略过了正常的rfc2833过程。

1，检查B路响应SDP中的“telephone-event”并根据rate匹配一个最佳te。switch_core_media.c:5964。

2，如果没有匹配到最佳te，检查vars.xml中的“rtp_liberal_dtmf”配置为true，则直接使用本地te作为最佳te。switch_core_media.c:6003。

3，如果仍然没有最佳te，检查通道变量“rtp_info_when_no_2833”不是false，则使用INFO模式转发DTMF，否则设置B路的“dtmf_type”为none。

修改方案

修改后的dtmf匹配流程。

1，检查B路响应SDP中的“telephone-event”并根据rate匹配一个最佳te。switch_core_media.c:5964。

2，如果没有匹配到最佳te，检查vars.xml中的“rtp_liberal_dtmf”配置为true，则直接使用本地te作为最佳te。switch_core_media.c:6003。

3，如果有最佳te，走第4步，没有最佳te，走第5步。

4，在设置协商好的te payload之后，增加逻辑，如果在183的协商中已经设置了inband模式，后续的update协商中需要取消inband模式的函数设置。

5，检查通道变量“rtp_info_when_no_2833”不是false，则使用INFO模式转发DTMF。通道变量“rtp_info_when_no_2833”不是false，设置B路的“dtmf_type”为inband，设置B路通道变量“spandsp_dtmf_rx_filter_dialtone”为true，设置B路在answer后调用app函数“deduplicate_dtmf”和“spandsp_start_dtmf”，设置A路在answer后调用app函数“start_dtmf_generate”。

代码如下，switch_core_media.c:6009行开始，红色部分为修改代码。

if (best_te) {
    smh->mparams->te_rate = best_te_rate;

    if (smh->mparams->dtmf_type == DTMF_AUTO || smh->mparams->dtmf_type == DTMF_2833 ||
        switch_channel_test_flag(session->channel, CF_LIBERAL_DTMF)) {
        if (sdp_type == SDP_TYPE_REQUEST) {
            smh->mparams->te = smh->mparams->recv_te = (switch_payload_t) best_te;
            switch_channel_set_variable(session->channel, "dtmf_type", "rfc2833");
            smh->mparams->dtmf_type = DTMF_2833;
        } else {
            smh->mparams->te = (switch_payload_t) best_te;
            switch_channel_set_variable(session->channel, "dtmf_type", "rfc2833");
            smh->mparams->dtmf_type = DTMF_2833;
        }
    }

    if (a_engine->rtp_session) {
        switch_rtp_set_telephony_event(a_engine->rtp_session, smh->mparams->te);
        switch_channel_set_variable_printf(session->channel, "rtp_2833_send_payload", "%d", smh->mparams->te);
        switch_rtp_set_telephony_recv_event(a_engine->rtp_session, smh->mparams->recv_te);
        switch_channel_set_variable_printf(session->channel, "rtp_2833_recv_payload", "%d", smh->mparams->recv_te);
    }

    switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "%s Set 2833 dtmf send payload to %u recv payload to %u\n",
        switch_channel_get_name(session->channel), smh->mparams->te, smh->mparams->recv_te);

    //add by zr 20241018, for 2833 to inband, update method
    //如果在183的协商中已经设置了inband模式，后续的update协商中需要取消inband模式的函数设置
    if (switch_true(switch_channel_get_variable(session->channel, "inband_flag"))) 
    {
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "reset inband_flag and channel variables.\n");
        //B路
        switch_channel_set_variable(session->channel, "inband_flag", NULL);
        switch_channel_set_variable(session->channel, "spandsp_dtmf_rx_filter_dialtone", NULL);
        switch_channel_set_variable(session->channel, "execute_on_answer_101", NULL);
        switch_channel_set_variable(session->channel, "execute_on_answer_102", NULL);

        //A路，2833 to inband
        if( switch_core_session_get_partner(session, &other_session) == SWITCH_STATUS_SUCCESS )
        {
            switch_channel_set_variable(other_session->channel, "execute_on_answer_101", NULL);
            switch_core_session_rwunlock(other_session);
        }
    }
} else {
    /* by default, use SIP INFO if 2833 is not in the SDP */
    if (!switch_false(switch_channel_get_variable(channel, "rtp_info_when_no_2833"))) {
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "No 2833 in SDP.  Disable 2833 dtmf and switch to INFO\n");
        switch_channel_set_variable(session->channel, "dtmf_type", "info");
        smh->mparams->dtmf_type = DTMF_INFO;
        smh->mparams->recv_te = smh->mparams->te = 0;
    } else {
        // switch_channel_set_variable(session->channel, "dtmf_type", "none");
        // smh->mparams->dtmf_type = DTMF_NONE;
        // smh->mparams->recv_te = smh->mparams->te = 0;
        //add by zr 20241018, for 2833 to inband, update method
        switch_channel_set_variable(session->channel, "dtmf_type", "inband");
        smh->mparams->dtmf_type = DTMF_AUTO;
        smh->mparams->recv_te = smh->mparams->te = 0;
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "set inband_flag, No 2833 in SDP. Disable 2833 dtmf and switch to INBAND.\n");
        
        //TODO: add inband dtmf
        //A路，2833 to inband
        if( switch_core_session_get_partner(session, &other_session) == SWITCH_STATUS_SUCCESS )
        {
            switch_channel_set_variable(other_session->channel, "execute_on_answer_101", "start_dtmf_generate");
            switch_core_session_rwunlock(other_session);
        }

        //B路，inband to 2833
        switch_channel_set_variable(session->channel, "inband_flag", "true");
        switch_channel_set_variable(session->channel, "spandsp_dtmf_rx_filter_dialtone", "true");
        switch_channel_set_variable(session->channel, "execute_on_answer_101", "deduplicate_dtmf");
        switch_channel_set_variable(session->channel, "execute_on_answer_102", "spandsp_start_dtmf");
    }
}

代码编译安装后，修改fs配置，B路使用inband模式。

vars.xml

<X-PRE-PROCESS cmd="set" data="rtp_liberal_dtmf=false"/>

dialplan

上面的配置可以适配各种情况，当A路支持rfc2833，B路不支持2833的时候。

B路如果仍然希望使用2833则设置“rtp_liberal_dtmf”为true。

B路如果希望使用INFO模式则设置“rtp_liberal_dtmf”为fase，“rtp_info_when_no_2833”为true。

B路如果希望使用inband模式则设置“rtp_liberal_dtmf”为fase，“rtp_info_when_no_2833”为false。