Added extra credits. Adjusted indentation.

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@10643 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Eric des Courtis 2008-12-07 19:57:03 +00:00
parent d3852f3aee
commit b31df55196
1 changed files with 289 additions and 336 deletions

View File

@ -21,6 +21,16 @@
*
* Eric des Courtis <eric.des.courtis@benbria.com>
*
* Special thanks to the following companies for their help:
* - JohnnyVoIP
* - Magor Communications Corporation
*
* Special thanks to the following people for their help:
* - The FreeSWITCH Team
* - Matt Battig
* - Dean Swan
* - Lucas Cornelisse
* - Kevin Green
*
* mod_vmd.c -- Voicemail Detection Module
*
@ -108,24 +118,24 @@ SWITCH_MODULE_DEFINITION(mod_vmd, mod_vmd_load, NULL, NULL);
SWITCH_STANDARD_APP(vmd_start_function);
/* Type that holds state information about the beep */
typedef enum vmd_state{
typedef enum vmd_state {
BEEP_DETECTED, BEEP_NOT_DETECTED
} vmd_state_t;
/* Type that holds data for 5 points of discreet energy separation */
typedef struct vmd_point{
typedef struct vmd_point {
double freq;
double ampl;
} vmd_point_t;
/* Type that holds codec information */
typedef struct vmd_codec_info{
typedef struct vmd_codec_info {
int rate;
int channels;
} vmd_codec_info_t;
/* Type that holds session information pertinent to the vmd module */
typedef struct vmd_session_info{
typedef struct vmd_session_info {
/* State of the session */
vmd_state_t state;
/* Snapshot of DESA samples */
@ -143,12 +153,12 @@ typedef struct vmd_session_info{
switch_size_t timestamp;
} vmd_session_info_t;
static switch_bool_t process_data(vmd_session_info_t *vmd_info, switch_frame_t *frame);
static switch_bool_t vmd_callback(switch_media_bug_t *bug, void *user_data, switch_abc_type_t type);
static switch_bool_t process_data(vmd_session_info_t * vmd_info, switch_frame_t * frame);
static switch_bool_t vmd_callback(switch_media_bug_t * bug, void *user_data, switch_abc_type_t type);
static double freq_estimator(double *x);
static double ampl_estimator(double *x);
static void convert_pts(int16_t *i_pts, double *d_pts, int16_t max);
static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame);
static void convert_pts(int16_t * i_pts, double *d_pts, int16_t max);
static void find_beep(vmd_session_info_t * vmd_info, switch_frame_t * frame);
static double median(double *m, int n);
/*
@ -156,20 +166,18 @@ static double median(double *m, int n);
#define PRINT2(a, b) do{ switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, a, b); }while(0)
*/
static switch_bool_t vmd_callback(switch_media_bug_t *bug,
void *user_data,
switch_abc_type_t type)
static switch_bool_t vmd_callback(switch_media_bug_t * bug, void *user_data, switch_abc_type_t type)
{
vmd_session_info_t *vmd_info;
switch_codec_t *read_codec;
switch_frame_t *frame;
vmd_info = (vmd_session_info_t *)user_data;
if(vmd_info == NULL) {
vmd_info = (vmd_session_info_t *) user_data;
if (vmd_info == NULL) {
return SWITCH_FALSE;
}
switch(type){
switch (type) {
case SWITCH_ABC_TYPE_INIT:
read_codec = switch_core_session_get_read_codec(vmd_info->session);
@ -194,8 +202,7 @@ static switch_bool_t vmd_callback(switch_media_bug_t *bug,
return SWITCH_TRUE;
}
static switch_bool_t process_data(vmd_session_info_t *vmd_info,
switch_frame_t *frame)
static switch_bool_t process_data(vmd_session_info_t * vmd_info, switch_frame_t * frame)
{
uint32_t i;
unsigned int j;
@ -205,11 +212,11 @@ static switch_bool_t process_data(vmd_session_info_t *vmd_info,
switch_ssize_t len;
len = frame->samples * sizeof(int16_t);
data = (int16_t *)frame->data;
data = (int16_t *) frame->data;
for(max = (int16_t)abs(data[0]), i = 1; i < frame->samples; i++) {
if ((int16_t)abs(data[i]) > max) {
max = (int16_t)abs(data[i]);
for (max = (int16_t) abs(data[0]), i = 1; i < frame->samples; i++) {
if ((int16_t) abs(data[i]) > max) {
max = (int16_t) abs(data[i]);
}
}
@ -234,7 +241,7 @@ static switch_bool_t process_data(vmd_session_info_t *vmd_info,
}
*/
for(i = 0, j = vmd_info->pos; i < frame->samples; j++, j %= POINTS, i += 5) {
for (i = 0, j = vmd_info->pos; i < frame->samples; j++, j %= POINTS, i += 5) {
/* convert_pts(vmd_info->data + i, pts); */
convert_pts(data + i, pts, max);
vmd_info->points[j].freq = TO_HZ(freq_estimator(pts));
@ -246,7 +253,7 @@ static switch_bool_t process_data(vmd_session_info_t *vmd_info,
return SWITCH_TRUE;
}
static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame)
static void find_beep(vmd_session_info_t * vmd_info, switch_frame_t * frame)
{
int i;
int c;
@ -259,9 +266,9 @@ static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame)
switch_event_t *event_copy;
switch_channel_t *channel = switch_core_session_get_channel(vmd_info->session);
switch(vmd_info->state){
switch (vmd_info->state) {
case BEEP_DETECTED:
for(c = 0, i = 0; i < POINTS; j++, j %= POINTS, i++){
for (c = 0, i = 0; i < POINTS; j++, j %= POINTS, i++) {
vmd_info->timestamp++;
if (vmd_info->points[j].freq < TOLERANCE_T(vmd_info->beep_freq) &&
vmd_info->points[j].freq > TOLERANCE_B(vmd_info->beep_freq)) {
@ -282,9 +289,8 @@ static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame)
}
switch_event_add_header_string(event, SWITCH_STACK_BOTTOM, "Beep-Status", "stop");
switch_event_add_header(event, SWITCH_STACK_BOTTOM, "Beep-Time", "%d", (int)vmd_info->timestamp / POINTS);
switch_event_add_header(event, SWITCH_STACK_BOTTOM, "Unique-ID",
"%s", switch_core_session_get_uuid(vmd_info->session));
switch_event_add_header(event, SWITCH_STACK_BOTTOM, "Beep-Time", "%d", (int) vmd_info->timestamp / POINTS);
switch_event_add_header(event, SWITCH_STACK_BOTTOM, "Unique-ID", "%s", switch_core_session_get_uuid(vmd_info->session));
switch_event_add_header(event, SWITCH_STACK_BOTTOM, "Frequency", "%6.4lf", vmd_info->beep_freq);
switch_event_add_header_string(event, SWITCH_STACK_BOTTOM, "call-command", "vmd");
@ -295,11 +301,7 @@ static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame)
switch_core_session_queue_event(vmd_info->session, &event);
switch_event_fire(&event_copy);
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_INFO,
"<<< VMD - Beep Detected >>>\n"
);
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "<<< VMD - Beep Detected >>>\n");
switch_channel_set_variable(channel, "vmd_detect", "TRUE");
vmd_info->timestamp = 0;
@ -309,7 +311,7 @@ static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame)
case BEEP_NOT_DETECTED:
for(i = 0; i < POINTS; k++, k %= POINTS, i++){
for (i = 0; i < POINTS; k++, k %= POINTS, i++) {
m[i] = vmd_info->points[k].freq;
if (ISNAN(m[i])) {
m[i] = 0.0;
@ -317,27 +319,25 @@ static void find_beep(vmd_session_info_t *vmd_info, switch_frame_t *frame)
}
med = median(m, POINTS);
if (ISNAN(med)){
for(i = 0; i < POINTS; i++){
if (!ISNAN(m[i])){
if (ISNAN(med)) {
for (i = 0; i < POINTS; i++) {
if (!ISNAN(m[i])) {
med = m[i];
break;
}
}
}
for(c = 0, i = 0; i < POINTS; j++, j %= POINTS, i++){
if (vmd_info->points[j].freq < TOLERANCE_T(med) &&
vmd_info->points[j].freq > TOLERANCE_B(med)){
for (c = 0, i = 0; i < POINTS; j++, j %= POINTS, i++) {
if (vmd_info->points[j].freq < TOLERANCE_T(med) && vmd_info->points[j].freq > TOLERANCE_B(med)) {
if (vmd_info->points[j].ampl > MIN_AMPL &&
vmd_info->points[j].freq > MIN_FREQ &&
vmd_info->points[j].freq < MAX_FREQ){
vmd_info->points[j].freq > MIN_FREQ && vmd_info->points[j].freq < MAX_FREQ) {
c++;
}
}
}
if(c >= VALID){
if (c >= VALID) {
vmd_info->state = BEEP_DETECTED;
vmd_info->beep_freq = med;
vmd_info->timestamp = 0;
@ -360,30 +360,32 @@ static double median(double *m, int n)
double maxltguess;
double mingtguess;
min = max = m[0] ;
min = max = m[0];
for (i = 1; i < n; i++) {
if(m[i] < min) min = m[i];
if(m[i] > max) max = m[i];
if (m[i] < min)
min = m[i];
if (m[i] > max)
max = m[i];
}
for(;;) {
guess = ( min + max ) / 2;
for (;;) {
guess = (min + max) / 2;
less = 0;
greater = 0;
equal = 0;
maxltguess = min;
mingtguess = max;
for(i = 0; i < n; i++) {
for (i = 0; i < n; i++) {
if (m[i] < guess) {
less++;
if(m[i] > maxltguess) {
if (m[i] > maxltguess) {
maxltguess = m[i];
}
} else if (m[i] > guess) {
greater++;
if(m[i] < mingtguess) {
if (m[i] < mingtguess) {
mingtguess = m[i];
}
} else {
@ -391,7 +393,7 @@ static double median(double *m, int n)
}
}
if (less <= ( n + 1 ) / 2 && greater <= ( n + 1 ) / 2) {
if (less <= (n + 1) / 2 && greater <= (n + 1) / 2) {
break;
} else if (less > greater) {
max = maxltguess;
@ -400,9 +402,9 @@ static double median(double *m, int n)
}
}
if (less >= ( n + 1 ) / 2) {
if (less >= (n + 1) / 2) {
return maxltguess;
} else if (less + equal >= ( n + 1 ) / 2) {
} else if (less + equal >= (n + 1) / 2) {
return guess;
}
@ -410,12 +412,12 @@ static double median(double *m, int n)
}
/* Convert many points for Signed L16 to relative floating point */
static void convert_pts(int16_t *i_pts, double *d_pts, int16_t max)
static void convert_pts(int16_t * i_pts, double *d_pts, int16_t max)
{
int i;
for(i = 0; i < P; i++) {
for (i = 0; i < P; i++) {
/* Signed L16 to relative floating point conversion */
d_pts[i] = ((((double)(i_pts[i]) + (double)max) / (double)(2 * max)) - 0.5) * 2.0;
d_pts[i] = ((((double) (i_pts[i]) + (double) max) / (double) (2 * max)) - 0.5) * 2.0;
}
}
@ -427,20 +429,16 @@ double ampl_estimator(double *x)
freq_sq = freq_estimator(x);
freq_sq *= freq_sq;
return sqrt( PSI(x) / sin(freq_sq) );
return sqrt(PSI(x) / sin(freq_sq));
}
/* The DESA-2 algorithm */
double freq_estimator(double *x)
{
return 0.5 * acos(
(((x[2] * x[2]) - (x[0] * x[4]))
-
( (x[1] * x[1]) - (x[0] * x[2]))
-
( (x[3] * x[3]) - (x[2] * x[4])))
/
(2.0 * ((x[2] * x[2]) - (x[1] * x[3])))
return 0.5 * acos((((x[2] * x[2]) - (x[0] * x[4]))
- ((x[1] * x[1]) - (x[0] * x[2]))
- ((x[3] * x[3]) - (x[2] * x[4])))
/ (2.0 * ((x[2] * x[2]) - (x[1] * x[3])))
);
}
@ -451,20 +449,13 @@ SWITCH_MODULE_LOAD_FUNCTION(mod_vmd_load)
switch_application_interface_t *app_interface;
switch_api_interface_t *api_interface;
/* connect my internal structure to the blank pointer passed to me */
*module_interface =
switch_loadable_module_create_module_interface(pool, modname);
*module_interface = switch_loadable_module_create_module_interface(pool, modname);
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_NOTICE,
"Voicemail detection enabled\n"
);
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_NOTICE, "Voicemail detection enabled\n");
SWITCH_ADD_APP(app_interface, "vmd", "Detect beeps", "Detect voicemail beeps",
vmd_start_function, "[start] [stop]", SAF_NONE);
SWITCH_ADD_APP(app_interface, "vmd", "Detect beeps", "Detect voicemail beeps", vmd_start_function, "[start] [stop]", SAF_NONE);
SWITCH_ADD_API(api_interface, "vmd", "Detected voicemail beeps",
vmd_api_main, VMD_SYNTAX);
SWITCH_ADD_API(api_interface, "vmd", "Detected voicemail beeps", vmd_api_main, VMD_SYNTAX);
/* indicate that the module should continue to be loaded */
return SWITCH_STATUS_SUCCESS;
@ -479,34 +470,29 @@ SWITCH_STANDARD_APP(vmd_start_function)
vmd_session_info_t *vmd_info;
int i;
if (session == NULL) return;
if (session == NULL)
return;
channel = switch_core_session_get_channel(session);
/* Is this channel already set? */
bug = (switch_media_bug_t *) switch_channel_get_private(channel, "_vmd_");
/* If yes */
if (bug != NULL){
if (bug != NULL) {
/* If we have a stop remove audio bug */
if(strcasecmp(data, "stop") == 0){
if (strcasecmp(data, "stop") == 0) {
switch_channel_set_private(channel, "_vmd_", NULL);
switch_core_media_bug_remove(session, &bug);
return;
}
/* We have already started */
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_WARNING,
"Cannot run 2 at once on the same channel!\n"
);
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "Cannot run 2 at once on the same channel!\n");
return;
}
vmd_info = (vmd_session_info_t *)switch_core_session_alloc(
session,
sizeof(vmd_session_info_t)
vmd_info = (vmd_session_info_t *) switch_core_session_alloc(session, sizeof(vmd_session_info_t)
);
vmd_info->state = BEEP_NOT_DETECTED;
@ -516,26 +502,15 @@ SWITCH_STANDARD_APP(vmd_start_function)
vmd_info->data = NULL;
vmd_info->data_len = 0;
*/
for(i = 0; i < POINTS; i++){
for (i = 0; i < POINTS; i++) {
vmd_info->points[i].freq = 0.0;
vmd_info->points[i].ampl = 0.0;
}
status = switch_core_media_bug_add(
session,
vmd_callback,
vmd_info,
0,
SMBF_READ_REPLACE,
&bug
);
status = switch_core_media_bug_add(session, vmd_callback, vmd_info, 0, SMBF_READ_REPLACE, &bug);
if(status != SWITCH_STATUS_SUCCESS){
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_ERROR,
"Failure hooking to stream\n"
);
if (status != SWITCH_STATUS_SUCCESS) {
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Failure hooking to stream\n");
return;
}
@ -546,11 +521,7 @@ SWITCH_STANDARD_APP(vmd_start_function)
/* Called when the system shuts down */
SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_vmd_shutdown)
{
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_NOTICE,
"Voicemail detection disabled\n"
);
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_NOTICE, "Voicemail detection disabled\n");
return SWITCH_STATUS_SUCCESS;
}
@ -570,7 +541,7 @@ SWITCH_STANDARD_API(vmd_api_main)
int i;
/* No command? Display usage */
if(cmd == NULL){
if (cmd == NULL) {
stream->write_function(stream, "-USAGE: %s\n", VMD_SYNTAX);
return SWITCH_STATUS_SUCCESS;
}
@ -582,7 +553,7 @@ SWITCH_STANDARD_API(vmd_api_main)
/* If we don't have the expected number of parameters
* display usage */
if (argc != VMD_PARAMS){
if (argc != VMD_PARAMS) {
stream->write_function(stream, "-USAGE: %s\n", VMD_SYNTAX);
switch_safe_free(ccmd);
return SWITCH_STATUS_SUCCESS;
@ -608,9 +579,9 @@ SWITCH_STANDARD_API(vmd_api_main)
/* Is this channel already set? */
bug = (switch_media_bug_t *) switch_channel_get_private(channel, "_vmd_");
/* If yes */
if (bug != NULL){
if (bug != NULL) {
/* If we have a stop remove audio bug */
if(strcasecmp(command, "stop") == 0) {
if (strcasecmp(command, "stop") == 0) {
switch_channel_set_private(channel, "_vmd_", NULL);
switch_core_media_bug_remove(vmd_session, &bug);
switch_safe_free(ccmd);
@ -619,18 +590,14 @@ SWITCH_STANDARD_API(vmd_api_main)
}
/* We have already started */
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_WARNING,
"Cannot run 2 at once on the same channel!\n"
);
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "Cannot run 2 at once on the same channel!\n");
switch_safe_free(ccmd);
return SWITCH_STATUS_FALSE;
}
/* If we don't see the expected start exit */
if(strcasecmp(command, "start") != 0) {
if (strcasecmp(command, "start") != 0) {
switch_safe_free(ccmd);
stream->write_function(stream, "-USAGE: %s\n", VMD_SYNTAX);
return SWITCH_STATUS_FALSE;
@ -638,9 +605,7 @@ SWITCH_STANDARD_API(vmd_api_main)
/* Allocate memory attached to this FreeSWITCH session for
* use in the callback routine and to store state information */
vmd_info = (vmd_session_info_t *)switch_core_session_alloc(
vmd_session,
sizeof(vmd_session_info_t)
vmd_info = (vmd_session_info_t *) switch_core_session_alloc(vmd_session, sizeof(vmd_session_info_t)
);
/* Set initial values and states */
@ -652,29 +617,18 @@ SWITCH_STANDARD_API(vmd_api_main)
vmd_info->data_len = 0;
*/
for(i = 0; i < POINTS; i++) {
for (i = 0; i < POINTS; i++) {
vmd_info->points[i].freq = 0.0;
vmd_info->points[i].ampl = 0.0;
}
/* Add a media bug that allows me to intercept the
* reading leg of the audio stream */
status = switch_core_media_bug_add(
vmd_session,
vmd_callback,
vmd_info,
0,
SMBF_READ_REPLACE,
&bug
);
status = switch_core_media_bug_add(vmd_session, vmd_callback, vmd_info, 0, SMBF_READ_REPLACE, &bug);
/* If adding a media bug fails exit */
if (status != SWITCH_STATUS_SUCCESS) {
switch_log_printf(
SWITCH_CHANNEL_LOG,
SWITCH_LOG_ERROR,
"Failure hooking to stream\n"
);
switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Failure hooking to stream\n");
switch_safe_free(ccmd);
return SWITCH_STATUS_FALSE;
@ -701,4 +655,3 @@ SWITCH_STANDARD_API(vmd_api_main)
* For VIM:
* vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:
*/