Fri Apr 15 20:39:49 2016

Asterisk developer's documentation

dsp.h File Reference

Convenient Signal Processing routines. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define DSP_DIGITMODE_DTMF   0
#define DSP_DIGITMODE_MF   1
#define DSP_DIGITMODE_MUTECONF   (1 << 9)
#define DSP_DIGITMODE_MUTEMAX   (1 << 10)
#define DSP_DIGITMODE_NOQUELCH   (1 << 8)
#define DSP_DIGITMODE_RELAXDTMF   (1 << 11)
#define DSP_FAXMODE_DETECT_ALL   (DSP_FAXMODE_DETECT_CNG | DSP_FAXMODE_DETECT_CED)
#define DSP_FAXMODE_DETECT_CED   (1 << 1)
#define DSP_FAXMODE_DETECT_CNG   (1 << 0)
#define DSP_FEATURE_BUSY_DETECT   (1 << 1)
#define DSP_FEATURE_CALL_PROGRESS   (DSP_PROGRESS_TALK | DSP_PROGRESS_RINGING | DSP_PROGRESS_BUSY | DSP_PROGRESS_CONGESTION)
#define DSP_FEATURE_DIGIT_DETECT   (1 << 3)
#define DSP_FEATURE_FAX_DETECT   (1 << 4)
#define DSP_FEATURE_SILENCE_SUPPRESS   (1 << 0)
#define DSP_FEATURE_WAITDIALTONE   (1 << 20)
#define DSP_PROGRESS_BUSY   (1 << 18)
#define DSP_PROGRESS_CONGESTION   (1 << 19)
#define DSP_PROGRESS_RINGING   (1 << 17)
#define DSP_PROGRESS_TALK   (1 << 16)
#define DSP_TONE_STATE_BUSY   4
#define DSP_TONE_STATE_DIALTONE   2
#define DSP_TONE_STATE_HUNGUP   8
#define DSP_TONE_STATE_RINGING   1
#define DSP_TONE_STATE_SILENCE   0
#define DSP_TONE_STATE_SPECIAL1   5
#define DSP_TONE_STATE_SPECIAL2   6
#define DSP_TONE_STATE_SPECIAL3   7
#define DSP_TONE_STATE_TALKING   3

Enumerations

enum  threshold { THRESHOLD_SILENCE = 0, THRESHOLD_MAX = 1 }

Functions

int ast_dsp_busydetect (struct ast_dsp *dsp)
 Return non-zero if historically this should be a busy, request that ast_dsp_silence has already been called.
int ast_dsp_call_progress (struct ast_dsp *dsp, struct ast_frame *inf)
 Scans for progress indication in audio.
int ast_dsp_digitdetect (struct ast_dsp *dsp, struct ast_frame *f)
 Return non-zero if DTMF hit was found.
void ast_dsp_digitreset (struct ast_dsp *dsp)
 Reset DTMF detector.
void ast_dsp_free (struct ast_dsp *dsp)
int ast_dsp_get_tcount (struct ast_dsp *dsp)
 Get tcount (Threshold counter).
int ast_dsp_get_threshold_from_settings (enum threshold which)
 Get silence threshold from dsp.conf.
int ast_dsp_get_tstate (struct ast_dsp *dsp)
 Get tstate (Tone State).
int ast_dsp_getdigits (struct ast_dsp *dsp, char *buf, int max)
 Get pending DTMF/MF digits.
int ast_dsp_init (void)
 Load dsp settings from dsp.conf.
struct ast_dsp * ast_dsp_new (void)
int ast_dsp_noise (struct ast_dsp *dsp, struct ast_frame *f, int *totalnoise)
 Return non-zero if this is noise. Updates "totalnoise" with the total number of seconds of noise.
struct ast_frame * ast_dsp_process (struct ast_channel *chan, struct ast_dsp *dsp, struct ast_frame *inf)
 Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on busies, and call progress, all dependent upon which features are enabled.
int ast_dsp_reload (void)
 Reloads dsp settings from dsp.conf.
void ast_dsp_reset (struct ast_dsp *dsp)
 Reset total silence count.
void ast_dsp_set_busy_count (struct ast_dsp *dsp, int cadences)
 Set number of required cadences for busy.
void ast_dsp_set_busy_pattern (struct ast_dsp *dsp, int tonelength, int quietlength)
 Set expected lengths of the busy tone.
int ast_dsp_set_call_progress_zone (struct ast_dsp *dsp, char *zone)
 Set zone for doing progress detection.
int ast_dsp_set_digitmode (struct ast_dsp *dsp, int digitmode)
 Set digit mode.
int ast_dsp_set_faxmode (struct ast_dsp *dsp, int faxmode)
 Set fax mode.
void ast_dsp_set_features (struct ast_dsp *dsp, int features)
 Select feature set.
void ast_dsp_set_threshold (struct ast_dsp *dsp, int threshold)
 Set threshold value for silence.
int ast_dsp_silence (struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence)
 Return non-zero if this is silence. Updates "totalsilence" with the total number of seconds of silence.
int ast_dsp_was_muted (struct ast_dsp *dsp)
 Returns true if DSP code was muting any fragment of the last processed frame. Muting (squelching) happens when DSP code removes DTMF/MF/generic tones from the audio.

Detailed Description

Convenient Signal Processing routines.

Definition in file dsp.h.

Define Documentation

#define DSP_DIGITMODE_DTMF   0

Detect DTMF digits

Definition at line 31 of file dsp.h.

Referenced by analog_ss_thread(), ast_dsp_new(), ast_dsp_set_digitmode(), dahdi_hangup(), dahdi_new(), dahdi_setoption(), enable_dsp_detect(), mkintf(), and my_dsp_set_digitmode().

#define DSP_DIGITMODE_MF   1

Detect MF digits

Definition at line 32 of file dsp.h.

Referenced by analog_ss_thread(), ast_dsp_digitreset(), ast_dsp_new(), ast_dsp_process(), ast_dsp_set_digitmode(), and my_dsp_set_digitmode().

#define DSP_DIGITMODE_MUTECONF   (1 << 9)

Mute conference

Definition at line 35 of file dsp.h.

Referenced by ast_dsp_set_digitmode(), and dahdi_setoption().

#define DSP_DIGITMODE_MUTEMAX   (1 << 10)

Delay audio by a frame to try to extra quelch

Definition at line 36 of file dsp.h.

Referenced by ast_dsp_set_digitmode(), and dahdi_setoption().

#define DSP_DIGITMODE_NOQUELCH   (1 << 8)

Do not quelch DTMF from in-band

Definition at line 34 of file dsp.h.

Referenced by ast_dsp_process(), and mgcp_new().

#define DSP_DIGITMODE_RELAXDTMF   (1 << 11)

"Radio" mode (relaxed DTMF)

Definition at line 37 of file dsp.h.

Referenced by ast_dsp_process(), dahdi_setoption(), enable_dsp_detect(), and process_dahdi().

#define DSP_FAXMODE_DETECT_ALL   (DSP_FAXMODE_DETECT_CNG | DSP_FAXMODE_DETECT_CED)

Definition at line 48 of file dsp.h.

#define DSP_FAXMODE_DETECT_CED   (1 << 1)

Definition at line 47 of file dsp.h.

Referenced by ast_dsp_process().

#define DSP_FAXMODE_DETECT_CNG   (1 << 0)

Definition at line 46 of file dsp.h.

Referenced by ast_dsp_new(), and ast_dsp_process().

#define DSP_FEATURE_BUSY_DETECT   (1 << 1)

Definition at line 27 of file dsp.h.

Referenced by ast_dsp_process(), and dahdi_new().

#define DSP_FEATURE_CALL_PROGRESS   (DSP_PROGRESS_TALK | DSP_PROGRESS_RINGING | DSP_PROGRESS_BUSY | DSP_PROGRESS_CONGESTION)

Definition at line 43 of file dsp.h.

Referenced by __ast_dsp_call_progress(), ast_dsp_process(), and dahdi_new().

#define DSP_FEATURE_DIGIT_DETECT   (1 << 3)

Definition at line 28 of file dsp.h.

Referenced by __oh323_new(), ast_dsp_process(), ast_dsp_set_features(), dahdi_new(), disable_dtmf_detect(), enable_dsp_detect(), enable_dtmf_detect(), mgcp_new(), misdn_set_opt_exec(), read_config(), and sip_rtp_read().

#define DSP_FEATURE_FAX_DETECT   (1 << 4)

Definition at line 29 of file dsp.h.

Referenced by ast_dsp_process(), dahdi_handle_dtmf(), dahdi_new(), dahdi_queryoption(), dahdi_setoption(), enable_dsp_detect(), misdn_set_opt_exec(), my_handle_dtmf(), and read_config().

#define DSP_FEATURE_SILENCE_SUPPRESS   (1 << 0)

Definition at line 26 of file dsp.h.

Referenced by ast_dsp_new(), and ast_dsp_process().

#define DSP_FEATURE_WAITDIALTONE   (1 << 20)

Enable dial tone detection

Definition at line 44 of file dsp.h.

Referenced by ast_dsp_process(), dahdi_new(), and dahdi_read().

#define DSP_PROGRESS_BUSY   (1 << 18)

Enable busy tone detection

Definition at line 41 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_PROGRESS_CONGESTION   (1 << 19)

Enable congestion tone detection

Definition at line 42 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_PROGRESS_RINGING   (1 << 17)

Enable calling tone detection

Definition at line 40 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_PROGRESS_TALK   (1 << 16)

Enable talk detection

Definition at line 39 of file dsp.h.

Referenced by __ast_dsp_call_progress(), and dahdi_new().

#define DSP_TONE_STATE_BUSY   4

Definition at line 54 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_DIALTONE   2

Definition at line 52 of file dsp.h.

Referenced by __ast_dsp_call_progress(), and dahdi_read().

#define DSP_TONE_STATE_HUNGUP   8

Definition at line 58 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_RINGING   1

Definition at line 51 of file dsp.h.

Referenced by __ast_dsp_call_progress(), and dahdi_read().

#define DSP_TONE_STATE_SILENCE   0

Definition at line 50 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_SPECIAL1   5

Definition at line 55 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_SPECIAL2   6

Definition at line 56 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_SPECIAL3   7

Definition at line 57 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_TALKING   3

Definition at line 53 of file dsp.h.

Referenced by __ast_dsp_call_progress().

Enumeration Type Documentation

enum threshold
Enumerator:
THRESHOLD_SILENCE 
THRESHOLD_MAX 

Definition at line 62 of file dsp.h.

00062                {
00063    /* Array offsets */
00064    THRESHOLD_SILENCE = 0,
00065    /* Always the last */
00066    THRESHOLD_MAX = 1,
00067 };

Function Documentation

int ast_dsp_busydetect ( struct ast_dsp *  dsp  ) 

Return non-zero if historically this should be a busy, request that ast_dsp_silence has already been called.

Definition at line 1247 of file dsp.c.

References ast_debug, BUSY_MAX, BUSY_MIN, BUSY_PAT_PERCENT, BUSY_PERCENT, ast_dsp::busy_quietlength, ast_dsp::busy_tonelength, ast_dsp::busycount, ast_dsp::busymaybe, DSP_HISTORY, ast_dsp::historicnoise, ast_dsp::historicsilence, and MAX.

Referenced by ast_dsp_process().

01248 {
01249    int res = 0, x;
01250 #ifndef BUSYDETECT_TONEONLY
01251    int avgsilence = 0, hitsilence = 0;
01252 #endif
01253    int avgtone = 0, hittone = 0;
01254    if (!dsp->busymaybe) {
01255       return res;
01256    }
01257    for (x = DSP_HISTORY - dsp->busycount; x < DSP_HISTORY; x++) {
01258 #ifndef BUSYDETECT_TONEONLY
01259       avgsilence += dsp->historicsilence[x];
01260 #endif
01261       avgtone += dsp->historicnoise[x];
01262    }
01263 #ifndef BUSYDETECT_TONEONLY
01264    avgsilence /= dsp->busycount;
01265 #endif
01266    avgtone /= dsp->busycount;
01267    for (x = DSP_HISTORY - dsp->busycount; x < DSP_HISTORY; x++) {
01268 #ifndef BUSYDETECT_TONEONLY
01269       if (avgsilence > dsp->historicsilence[x]) {
01270          if (avgsilence - (avgsilence * BUSY_PERCENT / 100) <= dsp->historicsilence[x]) {
01271             hitsilence++;
01272          }
01273       } else {
01274          if (avgsilence + (avgsilence * BUSY_PERCENT / 100) >= dsp->historicsilence[x]) {
01275             hitsilence++;
01276          }
01277       }
01278 #endif
01279       if (avgtone > dsp->historicnoise[x]) {
01280          if (avgtone - (avgtone * BUSY_PERCENT / 100) <= dsp->historicnoise[x]) {
01281             hittone++;
01282          }
01283       } else {
01284          if (avgtone + (avgtone * BUSY_PERCENT / 100) >= dsp->historicnoise[x]) {
01285             hittone++;
01286          }
01287       }
01288    }
01289 #ifndef BUSYDETECT_TONEONLY
01290    if ((hittone >= dsp->busycount - 1) && (hitsilence >= dsp->busycount - 1) && 
01291        (avgtone >= BUSY_MIN && avgtone <= BUSY_MAX) && 
01292        (avgsilence >= BUSY_MIN && avgsilence <= BUSY_MAX)) {
01293 #else
01294    if ((hittone >= dsp->busycount - 1) && (avgtone >= BUSY_MIN && avgtone <= BUSY_MAX)) {
01295 #endif
01296 #ifdef BUSYDETECT_COMPARE_TONE_AND_SILENCE
01297       if (avgtone > avgsilence) {
01298          if (avgtone - avgtone*BUSY_PERCENT/100 <= avgsilence) {
01299             res = 1;
01300          }
01301       } else {
01302          if (avgtone + avgtone*BUSY_PERCENT/100 >= avgsilence) {
01303             res = 1;
01304          }
01305       }
01306 #else
01307       res = 1;
01308 #endif
01309    }
01310    /* If we know the expected busy tone length, check we are in the range */
01311    if (res && (dsp->busy_tonelength > 0)) {
01312       if (abs(avgtone - dsp->busy_tonelength) > MAX(dsp->busy_tonelength*BUSY_PAT_PERCENT/100, 20)) {
01313 #ifdef BUSYDETECT_DEBUG
01314          ast_debug(5, "busy detector: avgtone of %d not close enough to desired %d\n",
01315             avgtone, dsp->busy_tonelength);
01316 #endif
01317          res = 0;
01318       }
01319    }
01320 #ifndef BUSYDETECT_TONEONLY
01321    /* If we know the expected busy tone silent-period length, check we are in the range */
01322    if (res && (dsp->busy_quietlength > 0)) {
01323       if (abs(avgsilence - dsp->busy_quietlength) > MAX(dsp->busy_quietlength*BUSY_PAT_PERCENT/100, 20)) {
01324 #ifdef BUSYDETECT_DEBUG
01325       ast_debug(5, "busy detector: avgsilence of %d not close enough to desired %d\n",
01326          avgsilence, dsp->busy_quietlength);
01327 #endif
01328          res = 0;
01329       }
01330    }
01331 #endif
01332 #if !defined(BUSYDETECT_TONEONLY) && defined(BUSYDETECT_DEBUG)
01333    if (res) {
01334       ast_debug(5, "ast_dsp_busydetect detected busy, avgtone: %d, avgsilence %d\n", avgtone, avgsilence);
01335    } else {
01336       ast_debug(5, "busy detector: FAILED with avgtone: %d, avgsilence %d\n", avgtone, avgsilence);
01337    }
01338 #endif
01339    return res;
01340 }

int ast_dsp_call_progress ( struct ast_dsp *  dsp,
struct ast_frame *  inf 
)

Scans for progress indication in audio.

Definition at line 1171 of file dsp.c.

References __ast_dsp_call_progress(), AST_FORMAT_SLINEAR, AST_FRAME_VOICE, ast_log(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, ast_frame::frametype, LOG_WARNING, ast_frame::ptr, and ast_frame::subclass.

01172 {
01173    if (inf->frametype != AST_FRAME_VOICE) {
01174       ast_log(LOG_WARNING, "Can't check call progress of non-voice frames\n");
01175       return 0;
01176    }
01177    if (inf->subclass.codec != AST_FORMAT_SLINEAR) {
01178       ast_log(LOG_WARNING, "Can only check call progress in signed-linear frames\n");
01179       return 0;
01180    }
01181    return __ast_dsp_call_progress(dsp, inf->data.ptr, inf->datalen / 2);
01182 }

int ast_dsp_digitdetect ( struct ast_dsp *  dsp,
struct ast_frame *  f 
)

Return non-zero if DTMF hit was found.

void ast_dsp_digitreset ( struct ast_dsp *  dsp  ) 

Reset DTMF detector.

Definition at line 1650 of file dsp.c.

References dtmf_detect_state_t::col_out, digit_detect_state_t::current_digits, dtmf_detect_state_t::current_hit, mf_detect_state_t::current_hit, dtmf_detect_state_t::current_sample, mf_detect_state_t::current_sample, ast_dsp::digit_state, ast_dsp::digitmode, digit_detect_state_t::digits, DSP_DIGITMODE_MF, digit_detect_state_t::dtmf, ast_dsp::dtmf_began, dtmf_detect_state_t::energy, goertzel_reset(), dtmf_detect_state_t::hits, mf_detect_state_t::hits, dtmf_detect_state_t::lasthit, digit_detect_state_t::mf, dtmf_detect_state_t::misses, dtmf_detect_state_t::row_out, digit_detect_state_t::td, and mf_detect_state_t::tone_out.

Referenced by analog_ss_thread(), and my_dsp_reset_and_flush_digits().

01651 {
01652    int i;
01653    
01654    dsp->dtmf_began = 0;
01655    if (dsp->digitmode & DSP_DIGITMODE_MF) {
01656       mf_detect_state_t *s = &dsp->digit_state.td.mf;
01657       /* Reinitialise the detector for the next block */
01658       for (i = 0;  i < 6;  i++) {
01659          goertzel_reset(&s->tone_out[i]);
01660       }
01661       s->hits[4] = s->hits[3] = s->hits[2] = s->hits[1] = s->hits[0] = s->current_hit = 0;
01662       s->current_sample = 0;
01663    } else {
01664       dtmf_detect_state_t *s = &dsp->digit_state.td.dtmf;
01665       /* Reinitialise the detector for the next block */
01666       for (i = 0;  i < 4;  i++) {
01667          goertzel_reset(&s->row_out[i]);
01668          goertzel_reset(&s->col_out[i]);
01669       }
01670       s->lasthit = s->current_hit = 0;
01671       s->energy = 0.0;
01672       s->current_sample = 0;
01673       s->hits = 0;
01674       s->misses = 0;
01675    }
01676 
01677    dsp->digit_state.digits[0] = '\0';
01678    dsp->digit_state.current_digits = 0;
01679 }

void ast_dsp_free ( struct ast_dsp *  dsp  ) 

Definition at line 1622 of file dsp.c.

References ast_free.

Referenced by __ast_play_and_record(), __oh323_destroy(), analog_ss_thread(), background_detect_exec(), chan_list_destructor(), cleanup_connection(), conf_run(), dahdi_hangup(), destroy_endpoint(), destroy_session(), disable_dsp_detect(), do_waiting(), handle_recordfile(), isAnsweringMachine(), mgcp_hangup(), my_all_subchannels_hungup(), my_dsp_set_digitmode(), record_exec(), and sip_rtp_read().

01623 {
01624    ast_free(dsp);
01625 }

int ast_dsp_get_tcount ( struct ast_dsp *  dsp  ) 

Get tcount (Threshold counter).

Definition at line 1743 of file dsp.c.

References ast_dsp::tcount.

Referenced by dahdi_read().

01744 {
01745    return dsp->tcount;
01746 }

int ast_dsp_get_threshold_from_settings ( enum threshold  which  ) 

Get silence threshold from dsp.conf.

Since:
1.6.1

Definition at line 1836 of file dsp.c.

Referenced by actual_load_config(), app_exec(), ast_record_review(), conf_run(), do_waiting(), handle_recordfile(), load_config(), record_exec(), and setup_privacy_args().

01837 {
01838    return thresholds[which];
01839 }

int ast_dsp_get_tstate ( struct ast_dsp *  dsp  ) 

Get tstate (Tone State).

Definition at line 1738 of file dsp.c.

References ast_dsp::tstate.

Referenced by dahdi_read().

01739 {
01740    return dsp->tstate;
01741 }

int ast_dsp_getdigits ( struct ast_dsp *  dsp,
char *  buf,
int  max 
)

Get pending DTMF/MF digits.

int ast_dsp_init ( void   ) 

Load dsp settings from dsp.conf.

Since:
1.6.1

Definition at line 1841 of file dsp.c.

References _dsp_init().

Referenced by main().

01842 {
01843    return _dsp_init(0);
01844 }

struct ast_dsp* ast_dsp_new ( void   )  [read]

Definition at line 1593 of file dsp.c.

References ast_calloc, ast_digit_detect_init(), ast_dsp_prog_reset(), ast_fax_detect_init(), ast_dsp::busycount, DEFAULT_THRESHOLD, ast_dsp::digit_state, ast_dsp::digitmode, ast_dsp::display_inband_dtmf_warning, DSP_DIGITMODE_DTMF, DSP_DIGITMODE_MF, DSP_FAXMODE_DETECT_CNG, DSP_FEATURE_SILENCE_SUPPRESS, DSP_HISTORY, ast_dsp::faxmode, ast_dsp::features, and ast_dsp::threshold.

Referenced by __ast_play_and_record(), __oh323_new(), background_detect_exec(), conf_run(), dahdi_new(), do_waiting(), enable_dsp_detect(), fax_session_new(), handle_recordfile(), isAnsweringMachine(), mgcp_new(), misdn_set_opt_exec(), my_dsp_set_digitmode(), read_config(), and record_exec().

01594 {
01595    struct ast_dsp *dsp;
01596    
01597    if ((dsp = ast_calloc(1, sizeof(*dsp)))) {      
01598       dsp->threshold = DEFAULT_THRESHOLD;
01599       dsp->features = DSP_FEATURE_SILENCE_SUPPRESS;
01600       dsp->busycount = DSP_HISTORY;
01601       dsp->digitmode = DSP_DIGITMODE_DTMF;
01602       dsp->faxmode = DSP_FAXMODE_DETECT_CNG;
01603       /* Initialize digit detector */
01604       ast_digit_detect_init(&dsp->digit_state, dsp->digitmode & DSP_DIGITMODE_MF);
01605       dsp->display_inband_dtmf_warning = 1;
01606       /* Initialize initial DSP progress detect parameters */
01607       ast_dsp_prog_reset(dsp);
01608       /* Initialize fax detector */
01609       ast_fax_detect_init(dsp);
01610    }
01611    return dsp;
01612 }

int ast_dsp_noise ( struct ast_dsp *  dsp,
struct ast_frame *  f,
int *  totalnoise 
)

Return non-zero if this is noise. Updates "totalnoise" with the total number of seconds of noise.

Since:
1.6.1

Definition at line 1360 of file dsp.c.

References __ast_dsp_silence_noise(), AST_FORMAT_SLINEAR, AST_FRAME_VOICE, ast_log(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, ast_frame::frametype, len(), LOG_WARNING, ast_frame::ptr, and ast_frame::subclass.

Referenced by do_waiting().

01361 {
01362        short *s;
01363        int len;
01364 
01365        if (f->frametype != AST_FRAME_VOICE) {
01366                ast_log(LOG_WARNING, "Can't calculate noise on a non-voice frame\n");
01367                return 0;
01368        }
01369        if (f->subclass.codec != AST_FORMAT_SLINEAR) {
01370                ast_log(LOG_WARNING, "Can only calculate noise on signed-linear frames :(\n");
01371                return 0;
01372        }
01373        s = f->data.ptr;
01374        len = f->datalen/2;
01375        return __ast_dsp_silence_noise(dsp, s, len, NULL, totalnoise);
01376 }

struct ast_frame* ast_dsp_process ( struct ast_channel *  chan,
struct ast_dsp *  dsp,
struct ast_frame *  inf 
) [read]

Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on busies, and call progress, all dependent upon which features are enabled.

Definition at line 1379 of file dsp.c.

References __ast_dsp_call_progress(), __ast_dsp_silence_noise(), ast_channel::_softhangup, AST_ALAW, ast_alloca, AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_HANGUP, AST_CONTROL_RINGING, ast_debug, ast_dsp_busydetect(), AST_FORMAT_ALAW, AST_FORMAT_SLINEAR, AST_FORMAT_TESTLAW, AST_FORMAT_ULAW, AST_FRAME_CONTROL, AST_FRAME_DTMF, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_NULL, AST_FRAME_VOICE, ast_frfree, ast_frisolate(), ast_getformatname(), AST_LIN2A, AST_LIN2MU, ast_log(), AST_MULAW, ast_queue_frame(), AST_SOFTHANGUP_DEV, ast_dsp::ced_tone_state, ast_dsp::cng_tone_state, ast_frame_subclass::codec, digit_detect_state_t::current_digits, ast_frame::data, ast_frame::datalen, ast_dsp::digit_state, digit_detect_state_t::digitlen, ast_dsp::digitmode, digit_detect_state_t::digits, ast_dsp::display_inband_dtmf_warning, DSP_DIGITMODE_MF, DSP_DIGITMODE_NOQUELCH, DSP_DIGITMODE_RELAXDTMF, DSP_FAXMODE_DETECT_CED, DSP_FAXMODE_DETECT_CNG, DSP_FEATURE_BUSY_DETECT, DSP_FEATURE_CALL_PROGRESS, DSP_FEATURE_DIGIT_DETECT, DSP_FEATURE_FAX_DETECT, DSP_FEATURE_SILENCE_SUPPRESS, DSP_FEATURE_WAITDIALTONE, ast_dsp::dtmf_began, dtmf_detect(), fragment_t::end, ast_dsp::f, ast_dsp::faxmode, ast_dsp::features, ast_frame::frametype, ast_dsp::historicnoise, ast_dsp::historicsilence, ast_frame_subclass::integer, ast_frame::len, len(), LOG_WARNING, mf_detect(), ast_dsp::mute_data, ast_dsp::mute_fragments, ast_frame::ptr, SAMPLE_RATE, ast_frame::src, fragment_t::start, ast_frame::subclass, and tone_detect().

Referenced by dahdi_read(), mgcp_rtp_read(), oh323_rtp_read(), process_ast_dsp(), and sip_rtp_read().

01380 {
01381    int silence;
01382    int res;
01383    int digit = 0, fax_digit = 0;
01384    int x;
01385    short *shortdata;
01386    unsigned char *odata;
01387    int len;
01388    struct ast_frame *outf = NULL;
01389 
01390    if (!af) {
01391       return NULL;
01392    }
01393    if (af->frametype != AST_FRAME_VOICE) {
01394       return af;
01395    }
01396 
01397    odata = af->data.ptr;
01398    len = af->datalen;
01399    /* Make sure we have short data */
01400    switch (af->subclass.codec) {
01401    case AST_FORMAT_SLINEAR:
01402       shortdata = af->data.ptr;
01403       len = af->datalen / 2;
01404       break;
01405    case AST_FORMAT_ULAW:
01406    case AST_FORMAT_TESTLAW:
01407       shortdata = ast_alloca(af->datalen * 2);
01408       for (x = 0;x < len; x++) {
01409          shortdata[x] = AST_MULAW(odata[x]);
01410       }
01411       break;
01412    case AST_FORMAT_ALAW:
01413       shortdata = ast_alloca(af->datalen * 2);
01414       for (x = 0; x < len; x++) {
01415          shortdata[x] = AST_ALAW(odata[x]);
01416       }
01417       break;
01418    default:
01419       /*Display warning only once. Otherwise you would get hundreds of warnings every second */
01420       if (dsp->display_inband_dtmf_warning)
01421          ast_log(LOG_WARNING, "Inband DTMF is not supported on codec %s. Use RFC2833\n", ast_getformatname(af->subclass.codec));
01422       dsp->display_inband_dtmf_warning = 0;
01423       return af;
01424    }
01425 
01426    /* Initially we do not want to mute anything */
01427    dsp->mute_fragments = 0;
01428 
01429    /* Need to run the silence detection stuff for silence suppression and busy detection */
01430    if ((dsp->features & DSP_FEATURE_SILENCE_SUPPRESS) || (dsp->features & DSP_FEATURE_BUSY_DETECT)) {
01431       res = __ast_dsp_silence_noise(dsp, shortdata, len, &silence, NULL);
01432    }
01433 
01434    if ((dsp->features & DSP_FEATURE_SILENCE_SUPPRESS) && silence) {
01435       memset(&dsp->f, 0, sizeof(dsp->f));
01436       dsp->f.frametype = AST_FRAME_NULL;
01437       ast_frfree(af);
01438       return ast_frisolate(&dsp->f);
01439    }
01440    if ((dsp->features & DSP_FEATURE_BUSY_DETECT) && ast_dsp_busydetect(dsp)) {
01441       chan->_softhangup |= AST_SOFTHANGUP_DEV;
01442       memset(&dsp->f, 0, sizeof(dsp->f));
01443       dsp->f.frametype = AST_FRAME_CONTROL;
01444       dsp->f.subclass.integer = AST_CONTROL_BUSY;
01445       ast_frfree(af);
01446       ast_debug(1, "Requesting Hangup because the busy tone was detected on channel %s\n", chan->name);
01447       return ast_frisolate(&dsp->f);
01448    }
01449 
01450    if ((dsp->features & DSP_FEATURE_FAX_DETECT)) {
01451       if ((dsp->faxmode & DSP_FAXMODE_DETECT_CNG) && tone_detect(dsp, &dsp->cng_tone_state, shortdata, len)) {
01452          fax_digit = 'f';
01453       }
01454 
01455       if ((dsp->faxmode & DSP_FAXMODE_DETECT_CED) && tone_detect(dsp, &dsp->ced_tone_state, shortdata, len)) {
01456          fax_digit = 'e';
01457       }
01458    }
01459 
01460    if (dsp->features & (DSP_FEATURE_DIGIT_DETECT | DSP_FEATURE_BUSY_DETECT)) {
01461       if (dsp->digitmode & DSP_DIGITMODE_MF)
01462          digit = mf_detect(dsp, &dsp->digit_state, shortdata, len, (dsp->digitmode & DSP_DIGITMODE_NOQUELCH) == 0, (dsp->digitmode & DSP_DIGITMODE_RELAXDTMF));
01463       else
01464          digit = dtmf_detect(dsp, &dsp->digit_state, shortdata, len, (dsp->digitmode & DSP_DIGITMODE_NOQUELCH) == 0, (dsp->digitmode & DSP_DIGITMODE_RELAXDTMF));
01465 
01466       if (dsp->digit_state.current_digits) {
01467          int event = 0, event_len = 0;
01468          char event_digit = 0;
01469 
01470          if (!dsp->dtmf_began) {
01471             /* We have not reported DTMF_BEGIN for anything yet */
01472 
01473             if (dsp->features & DSP_FEATURE_DIGIT_DETECT) {
01474                event = AST_FRAME_DTMF_BEGIN;
01475                event_digit = dsp->digit_state.digits[0];
01476             }
01477             dsp->dtmf_began = 1;
01478 
01479          } else if (dsp->digit_state.current_digits > 1 || digit != dsp->digit_state.digits[0]) {
01480             /* Digit changed. This means digit we have reported with DTMF_BEGIN ended */
01481             if (dsp->features & DSP_FEATURE_DIGIT_DETECT) {
01482                event = AST_FRAME_DTMF_END;
01483                event_digit = dsp->digit_state.digits[0];
01484                event_len = dsp->digit_state.digitlen[0] * 1000 / SAMPLE_RATE;
01485             }
01486             memmove(&dsp->digit_state.digits[0], &dsp->digit_state.digits[1], dsp->digit_state.current_digits);
01487             memmove(&dsp->digit_state.digitlen[0], &dsp->digit_state.digitlen[1], dsp->digit_state.current_digits * sizeof(dsp->digit_state.digitlen[0]));
01488             dsp->digit_state.current_digits--;
01489             dsp->dtmf_began = 0;
01490 
01491             if (dsp->features & DSP_FEATURE_BUSY_DETECT) {
01492                /* Reset Busy Detector as we have some confirmed activity */ 
01493                memset(dsp->historicsilence, 0, sizeof(dsp->historicsilence));
01494                memset(dsp->historicnoise, 0, sizeof(dsp->historicnoise));
01495                ast_debug(1, "DTMF Detected - Reset busydetector\n");
01496             }
01497          }
01498 
01499          if (event) {
01500             memset(&dsp->f, 0, sizeof(dsp->f));
01501             dsp->f.frametype = event;
01502             dsp->f.subclass.integer = event_digit;
01503             dsp->f.len = event_len;
01504             outf = &dsp->f;
01505             goto done;
01506          }
01507       }
01508    }
01509 
01510    if (fax_digit) {
01511       /* Fax was detected - digit is either 'f' or 'e' */
01512 
01513       memset(&dsp->f, 0, sizeof(dsp->f));
01514       dsp->f.frametype = AST_FRAME_DTMF;
01515       dsp->f.subclass.integer = fax_digit;
01516       outf = &dsp->f;
01517       goto done;
01518    }
01519 
01520    if ((dsp->features & DSP_FEATURE_CALL_PROGRESS)) {
01521       res = __ast_dsp_call_progress(dsp, shortdata, len);
01522       if (res) {
01523          switch (res) {
01524          case AST_CONTROL_ANSWER:
01525          case AST_CONTROL_BUSY:
01526          case AST_CONTROL_RINGING:
01527          case AST_CONTROL_CONGESTION:
01528          case AST_CONTROL_HANGUP:
01529             memset(&dsp->f, 0, sizeof(dsp->f));
01530             dsp->f.frametype = AST_FRAME_CONTROL;
01531             dsp->f.subclass.integer = res;
01532             dsp->f.src = "dsp_progress";
01533             if (chan) 
01534                ast_queue_frame(chan, &dsp->f);
01535             break;
01536          default:
01537             ast_log(LOG_WARNING, "Don't know how to represent call progress message %d\n", res);
01538          }
01539       }
01540    } else if ((dsp->features & DSP_FEATURE_WAITDIALTONE)) {
01541       res = __ast_dsp_call_progress(dsp, shortdata, len);
01542    }
01543 
01544 done:
01545    /* Mute fragment of the frame */
01546    for (x = 0; x < dsp->mute_fragments; x++) {
01547       memset(shortdata + dsp->mute_data[x].start, 0, sizeof(int16_t) * (dsp->mute_data[x].end - dsp->mute_data[x].start));
01548    }
01549 
01550    switch (af->subclass.codec) {
01551    case AST_FORMAT_SLINEAR:
01552       break;
01553    case AST_FORMAT_ULAW:
01554       for (x = 0; x < len; x++) {
01555          odata[x] = AST_LIN2MU((unsigned short) shortdata[x]);
01556       }
01557       break;
01558    case AST_FORMAT_ALAW:
01559       for (x = 0; x < len; x++) {
01560          odata[x] = AST_LIN2A((unsigned short) shortdata[x]);
01561       }
01562       break;
01563    }
01564 
01565    if (outf) {
01566       if (chan) {
01567          ast_queue_frame(chan, af);
01568       }
01569       ast_frfree(af);
01570       return ast_frisolate(outf);
01571    } else {
01572       return af;
01573    }
01574 }

int ast_dsp_reload ( void   ) 

Reloads dsp settings from dsp.conf.

Since:
1.6.1

Definition at line 1846 of file dsp.c.

References _dsp_init().

01847 {
01848    return _dsp_init(1);
01849 }

void ast_dsp_reset ( struct ast_dsp *  dsp  ) 

Reset total silence count.

Definition at line 1681 of file dsp.c.

References ast_dsp::freqs, ast_dsp::gsamps, ast_dsp::historicnoise, ast_dsp::historicsilence, ast_dsp::ringtimeout, ast_dsp::totalsilence, goertzel_state_t::v2, and goertzel_state_t::v3.

Referenced by debug_check_frame_for_silence().

01682 {
01683    int x;
01684    
01685    dsp->totalsilence = 0;
01686    dsp->gsamps = 0;
01687    for (x = 0; x < 4; x++) {
01688       dsp->freqs[x].v2 = dsp->freqs[x].v3 = 0.0;
01689    }
01690    memset(dsp->historicsilence, 0, sizeof(dsp->historicsilence));
01691    memset(dsp->historicnoise, 0, sizeof(dsp->historicnoise));  
01692    dsp->ringtimeout= 0;
01693 }

void ast_dsp_set_busy_count ( struct ast_dsp *  dsp,
int  cadences 
)

Set number of required cadences for busy.

Definition at line 1632 of file dsp.c.

References ast_dsp::busycount, and DSP_HISTORY.

Referenced by dahdi_new().

01633 {
01634    if (cadences < 4) {
01635       cadences = 4;
01636    }
01637    if (cadences > DSP_HISTORY) {
01638       cadences = DSP_HISTORY;
01639    }
01640    dsp->busycount = cadences;
01641 }

void ast_dsp_set_busy_pattern ( struct ast_dsp *  dsp,
int  tonelength,
int  quietlength 
)

Set expected lengths of the busy tone.

Definition at line 1643 of file dsp.c.

References ast_debug, ast_dsp::busy_quietlength, and ast_dsp::busy_tonelength.

Referenced by dahdi_new().

01644 {
01645    dsp->busy_tonelength = tonelength;
01646    dsp->busy_quietlength = quietlength;
01647    ast_debug(1, "dsp busy pattern set to %d,%d\n", tonelength, quietlength);
01648 }

int ast_dsp_set_call_progress_zone ( struct ast_dsp *  dsp,
char *  zone 
)

Set zone for doing progress detection.

Definition at line 1719 of file dsp.c.

References aliases, ARRAY_LEN, ast_dsp_prog_reset(), progalias::mode, name, and ast_dsp::progmode.

Referenced by dahdi_new().

01720 {
01721    int x;
01722    
01723    for (x = 0; x < ARRAY_LEN(aliases); x++) {
01724       if (!strcasecmp(aliases[x].name, zone)) {
01725          dsp->progmode = aliases[x].mode;
01726          ast_dsp_prog_reset(dsp);
01727          return 0;
01728       }
01729    }
01730    return -1;
01731 }

int ast_dsp_set_digitmode ( struct ast_dsp *  dsp,
int  digitmode 
)

Set digit mode.

Version:
1.6.1 renamed from ast_dsp_digitmode to ast_dsp_set_digitmode

Definition at line 1695 of file dsp.c.

References ast_digit_detect_init(), ast_dsp::digit_state, ast_dsp::digitmode, DSP_DIGITMODE_DTMF, DSP_DIGITMODE_MF, DSP_DIGITMODE_MUTECONF, and DSP_DIGITMODE_MUTEMAX.

Referenced by analog_ss_thread(), dahdi_hangup(), dahdi_new(), dahdi_setoption(), enable_dsp_detect(), mgcp_new(), mkintf(), and my_dsp_set_digitmode().

01696 {
01697    int new;
01698    int old;
01699    
01700    old = dsp->digitmode & (DSP_DIGITMODE_DTMF | DSP_DIGITMODE_MF | DSP_DIGITMODE_MUTECONF | DSP_DIGITMODE_MUTEMAX);
01701    new = digitmode & (DSP_DIGITMODE_DTMF | DSP_DIGITMODE_MF | DSP_DIGITMODE_MUTECONF | DSP_DIGITMODE_MUTEMAX);
01702    if (old != new) {
01703       /* Must initialize structures if switching from MF to DTMF or vice-versa */
01704       ast_digit_detect_init(&dsp->digit_state, new & DSP_DIGITMODE_MF);
01705    }
01706    dsp->digitmode = digitmode;
01707    return 0;
01708 }

int ast_dsp_set_faxmode ( struct ast_dsp *  dsp,
int  faxmode 
)

Set fax mode.

Definition at line 1710 of file dsp.c.

References ast_fax_detect_init(), and ast_dsp::faxmode.

01711 {
01712    if (dsp->faxmode != faxmode) {
01713       ast_fax_detect_init(dsp);
01714    }
01715    dsp->faxmode = faxmode;
01716    return 0;
01717 }

void ast_dsp_set_features ( struct ast_dsp *  dsp,
int  features 
)

Select feature set.

Definition at line 1614 of file dsp.c.

References ast_dsp::display_inband_dtmf_warning, DSP_FEATURE_DIGIT_DETECT, and ast_dsp::features.

Referenced by __oh323_new(), dahdi_handle_dtmf(), dahdi_new(), dahdi_read(), dahdi_setoption(), disable_dtmf_detect(), enable_dsp_detect(), enable_dtmf_detect(), mgcp_new(), misdn_set_opt_exec(), my_handle_dtmf(), read_config(), and sip_rtp_read().

01615 {
01616    dsp->features = features;
01617    if (!(features & DSP_FEATURE_DIGIT_DETECT)) {
01618       dsp->display_inband_dtmf_warning = 0;
01619    }
01620 }

void ast_dsp_set_threshold ( struct ast_dsp *  dsp,
int  threshold 
)

Set threshold value for silence.

Definition at line 1627 of file dsp.c.

References ast_dsp::threshold.

Referenced by __ast_play_and_record(), do_waiting(), fax_session_new(), handle_recordfile(), isAnsweringMachine(), and record_exec().

01628 {
01629    dsp->threshold = threshold;
01630 }

int ast_dsp_silence ( struct ast_dsp *  dsp,
struct ast_frame *  f,
int *  totalsilence 
)

Return non-zero if this is silence. Updates "totalsilence" with the total number of seconds of silence.

Definition at line 1342 of file dsp.c.

References __ast_dsp_silence_noise(), AST_FORMAT_SLINEAR, AST_FRAME_VOICE, ast_log(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, ast_frame::frametype, len(), LOG_WARNING, ast_frame::ptr, and ast_frame::subclass.

Referenced by __ast_play_and_record(), background_detect_exec(), conf_run(), debug_check_frame_for_silence(), do_waiting(), handle_recordfile(), isAnsweringMachine(), and record_exec().

01343 {
01344    short *s;
01345    int len;
01346    
01347    if (f->frametype != AST_FRAME_VOICE) {
01348       ast_log(LOG_WARNING, "Can't calculate silence on a non-voice frame\n");
01349       return 0;
01350    }
01351    if (f->subclass.codec != AST_FORMAT_SLINEAR) {
01352       ast_log(LOG_WARNING, "Can only calculate silence on signed-linear frames :(\n");
01353       return 0;
01354    }
01355    s = f->data.ptr;
01356    len = f->datalen/2;
01357    return __ast_dsp_silence_noise(dsp, s, len, totalsilence, NULL);
01358 }

int ast_dsp_was_muted ( struct ast_dsp *  dsp  ) 

Returns true if DSP code was muting any fragment of the last processed frame. Muting (squelching) happens when DSP code removes DTMF/MF/generic tones from the audio.

Since:
1.6.1

Definition at line 1733 of file dsp.c.

References ast_dsp::mute_fragments.

Referenced by dahdi_read().

01734 {
01735    return (dsp->mute_fragments > 0);
01736 }

Generated on 15 Apr 2016 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1