Merge pull request #1098 from dragos-oancea/amr_wb_frame_types_fix

[mod_amrwb] handle frame types SPEECH_LOST and NO_DATA. add unit test.

libs/esl/src/esl.c

@@ -1392,6 +1392,7 @@ ESL_DECLARE(esl_status_t) esl_recv_event(esl_handle_t *handle, int check_q, esl_
 		if (!esl_safe_strcasecmp(hval, "text/disconnect-notice") && revent->body) {
 			const char *dval = esl_event_get_header(revent, "content-disposition");
 			if (esl_strlen_zero(dval) || strcasecmp(dval, "linger")) {
+				free(revent->body);
 				goto fail;
 			}
 		}

src/mod/codecs/mod_amrwb/Makefile.am

@@ -20,3 +20,13 @@ else
 mod_amrwb_la_CFLAGS += -DAMRWB_PASSTHROUGH
 endif
 
+if HAVE_AMRWB
+noinst_PROGRAMS = test/test_amrwb
+
+test_test_amrwb_SOURCES = test/test_amrwb.c
+test_test_amrwb_CFLAGS = $(AM_CFLAGS) -I./ -I../ -DSWITCH_TEST_BASE_DIR_FOR_CONF=\"${abs_builddir}/test\" -DSWITCH_TEST_BASE_DIR_OVERRIDE=\"${abs_builddir}/test\" $(AMRWB_CFLAGS)
+test_test_amrwb_LDFLAGS = $(AM_LDFLAGS) -avoid-version -no-undefined $(freeswitch_LDFLAGS) $(switch_builddir)/libfreeswitch.la $(CORE_LIBS) $(APR_LIBS) $(AMRWB_LIBS)
+
+TESTS = $(noinst_PROGRAMS)
+endif
+

src/mod/codecs/mod_amrwb/amrwb_be.c

@@ -109,7 +109,7 @@ extern switch_bool_t switch_amrwb_unpack_be(unsigned char *encoded_buf, uint8_t
 	switch_amr_array_lshift(2, shift_buf, encoded_len - 1);
 	/* get frame size */
 	index = ((shift_tocs[0] >> 3) & 0x0f);
-	if (index > 10) {
+	if (index > 10 && index != 0xe && index != 0xf) {
 		return SWITCH_FALSE;
 	}
 	framesz = switch_amrwb_frame_sizes[index];

src/mod/codecs/mod_amrwb/mod_amrwb.c

@@ -91,11 +91,13 @@ static struct {
 	int debug;
 } globals;
 
-const int switch_amrwb_frame_sizes[] = {17, 23, 32, 36, 40, 46, 50, 58, 60, 5};
+const int switch_amrwb_frame_sizes[] = {17, 23, 32, 36, 40, 46, 50, 58, 60, 5, 0, 0, 0, 0, 1, 1};
 
 #define SWITCH_AMRWB_OUT_MAX_SIZE 61
 #define SWITCH_AMRWB_MODES 10 /* Silence Indicator (SID) included */
 
+#define invalid_frame_type (index > SWITCH_AMRWB_MODES && index != 0xe && index != 0xf) /* include SPEECH_LOST and NO_DATA*/
+
 static switch_bool_t switch_amrwb_unpack_oa(unsigned char *buf, uint8_t *tmp, int encoded_data_len)
 {
 	uint8_t *tocs;
@@ -107,7 +109,7 @@ static switch_bool_t switch_amrwb_unpack_oa(unsigned char *buf, uint8_t *tmp, in
 	index = ((tocs[0]>>3) & 0xf);
 	buf++; /* point to voice payload */
 
-	if (index > 10) {
+	if (invalid_frame_type) {
 		switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "AMRWB decoder (OA): Invalid TOC: 0x%x", index);
 		return SWITCH_FALSE;
 	}
@@ -144,7 +146,7 @@ static switch_bool_t switch_amrwb_info(switch_codec_t *codec, unsigned char *enc
 		encoded_buf++; /* CMR skip */
 		tocs = encoded_buf;
 		index = (tocs[0] >> 3) & 0x0f;
-		if (index > SWITCH_AMRWB_MODES) {
+		if (invalid_frame_type) {
 			switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(codec->session), SWITCH_LOG_ERROR, "AMRWB decoder (OA): Invalid TOC 0x%x\n", index);
 			return SWITCH_FALSE;
 		}
@@ -163,7 +165,7 @@ static switch_bool_t switch_amrwb_info(switch_codec_t *codec, unsigned char *enc
 		ft = shift_tocs[0] >> 3;
 		ft &= ~(1 << 5); /* Frame Type */
 		index = (shift_tocs[0] >> 3) & 0x0f;
-		if (index > SWITCH_AMRWB_MODES) {
+		if (invalid_frame_type) {
 			switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(codec->session), SWITCH_LOG_ERROR, "AMRWB decoder (BE): Invalid TOC 0x%x\n", index);
 			return SWITCH_FALSE;
 		}

src/mod/codecs/mod_amrwb/test/freeswitch.xml

@@ -0,0 +1,21 @@
+<document type="freeswitch/xml">
+
+  <section name="configuration" description="Various Configuration">
+    <configuration name="modules.conf" description="Modules">
+      <modules>
+        <load module="mod_loopback"/>
+        <load module="mod_amrwb"/>
+      </modules>
+    </configuration>
+  </section>
+
+  <section name="dialplan" description="Regex/XML Dialplan">
+    <context name="default">
+      <extension name="sample">
+        <condition>
+          <action application="info"/>
+        </condition>
+      </extension>
+    </context>
+  </section>
+</document>

src/mod/codecs/mod_amrwb/test/test_amrwb.c

@@ -0,0 +1,105 @@
+/*
+ * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ * Copyright (C) 2005-2021, Anthony Minessale II <anthm@freeswitch.org>
+ *
+ * Version: MPL 1.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ *
+ * The Initial Developer of the Original Code is
+ * Anthony Minessale II <anthm@freeswitch.org>
+ * Portions created by the Initial Developer are Copyright (C)
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * Dragos Oancea <dragos@signalwire.com>
+ *
+ *
+ * test_amrwb.c -- tests mod_amrwb
+ *
+ */
+
+#ifndef AMRWB_PASSTHROUGH
+#include <switch.h>
+#include <stdlib.h>
+
+#include <test/switch_test.h>
+FST_CORE_BEGIN(".")
+{
+	FST_SUITE_BEGIN(test_amrwb)
+	{
+		FST_SETUP_BEGIN()
+		{
+			fst_requires_module("mod_loopback");
+			fst_requires_module("mod_amrwb");
+		}
+		FST_SETUP_END()
+
+		FST_TEARDOWN_BEGIN()
+		{
+		}
+		FST_TEARDOWN_END()
+
+		FST_TEST_BEGIN(amrwb_decode) 
+		{
+			switch_codec_t read_codec = { 0 };
+			switch_status_t status;
+			switch_codec_settings_t codec_settings = {{ 0 }};
+			uint32_t flags = 0;
+			uint32_t rate;
+			/*amrwb frame types*/
+			static char no_data[] = "\x77\xc0";
+			static char speech_lost[] = "\x77\x00";
+			static char fail[] = "\x76\xc0";
+			/*decode*/
+			uint32_t decoded_len;
+			unsigned char decbuf[SWITCH_RECOMMENDED_BUFFER_SIZE] = { 0 };
+			switch_stream_handle_t stream = { 0 };
+
+			status = switch_core_codec_init(&read_codec,
+			"AMR-WB",
+			"mod_amrwb",
+			NULL,
+			16000,
+			20,
+			1, SWITCH_CODEC_FLAG_ENCODE | SWITCH_CODEC_FLAG_DECODE,
+			&codec_settings, fst_pool);
+			fst_check(status == SWITCH_STATUS_SUCCESS);
+
+			SWITCH_STANDARD_STREAM(stream);
+
+			switch_api_execute("amrwb_debug", "on", NULL, &stream);
+
+			switch_safe_free(stream.data);
+
+			/*NO DATA = 0xf*/
+			status = switch_core_codec_decode(&read_codec, NULL, &no_data, 2, 16000, &decbuf, &decoded_len, &rate, &flags);
+			fst_check(status == SWITCH_STATUS_SUCCESS);
+
+			/*SPEECH LOST = 0xe*/
+			status = switch_core_codec_decode(&read_codec, NULL, &speech_lost, 2, 16000, &decbuf, &decoded_len, &rate, &flags);
+			fst_check(status == SWITCH_STATUS_SUCCESS);
+
+			/*Invalid frame type*/
+			status = switch_core_codec_decode(&read_codec, NULL, &fail, 2, 16000, &decbuf, &decoded_len, &rate, &flags);
+			fst_check(status != SWITCH_STATUS_SUCCESS);
+
+			switch_core_codec_destroy(&read_codec);
+		}
+
+		FST_TEST_END()
+	}
+	FST_SUITE_END()
+}
+FST_CORE_END()
+#endif