Fri Feb 10 06:35:58 2012

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.

Data Structures

struct  ast_dsp_busy_pattern

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_FAXMODE_DETECT_SQUELCH   (1 << 2)
#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)
unsigned int ast_dsp_get_sample_rate (const struct ast_dsp *dsp)
 Retrieve the sample rate this DSP structure was created with.
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)
 Allocates a new dsp, assumes 8khz for internal sample rate.
struct ast_dsp * ast_dsp_new_with_rate (unsigned int sample_rate)
 Allocates a new dsp with a specific internal sample rate used during processing.
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, const struct ast_dsp_busy_pattern *cadence)
 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_silence_with_energy (struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence, int *frames_energy)
 Return non-zero if this is silence. Updates "totalsilence" with the total number of seconds of silence. Returns the average energy of the samples in the frame in frames_energy variable.
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 __ast_dsp_new(), analog_ss_thread(), ast_dsp_set_digitmode(), dahdi_hangup(), dahdi_new(), dahdi_setoption(), enable_dsp_detect(), mkintf(), my_dsp_set_digitmode(), and store_config().

#define DSP_DIGITMODE_MF   1

Detect MF digits

Definition at line 32 of file dsp.h.

Referenced by __ast_dsp_new(), analog_ss_thread(), ast_dsp_digitreset(), 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(), dahdi_setoption(), and store_config().

#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(), process_dahdi(), and store_config().

#define DSP_FAXMODE_DETECT_ALL   (DSP_FAXMODE_DETECT_CNG | DSP_FAXMODE_DETECT_CED)

Definition at line 49 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(), ast_dsp_process(), and fax_detect_new().

#define DSP_FAXMODE_DETECT_SQUELCH   (1 << 2)

Definition at line 48 of file dsp.h.

Referenced by ast_fax_detect_init(), and fax_detect_new().

#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(), sip_rtp_read(), and store_config().

#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(), fax_detect_new(), 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 55 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_DIALTONE   2

Definition at line 53 of file dsp.h.

Referenced by __ast_dsp_call_progress(), and dahdi_read().

#define DSP_TONE_STATE_HUNGUP   8

Definition at line 59 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_RINGING   1

Definition at line 52 of file dsp.h.

Referenced by __ast_dsp_call_progress(), and dahdi_read().

#define DSP_TONE_STATE_SILENCE   0

Definition at line 51 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_SPECIAL1   5

Definition at line 56 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_SPECIAL2   6

Definition at line 57 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_SPECIAL3   7

Definition at line 58 of file dsp.h.

Referenced by __ast_dsp_call_progress().

#define DSP_TONE_STATE_TALKING   3

Definition at line 54 of file dsp.h.

Referenced by __ast_dsp_call_progress().

Enumeration Type Documentation

enum threshold

Enumerator:
THRESHOLD_SILENCE 
THRESHOLD_MAX 

Definition at line 70 of file dsp.h.

00070                {
00071    /* Array offsets */
00072    THRESHOLD_SILENCE = 0,
00073    /* Always the last */
00074    THRESHOLD_MAX = 1,
00075 };

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 1178 of file dsp.c.

References ast_debug, ast_dsp::busy_cadence, BUSY_MAX, BUSY_MIN, BUSY_PAT_PERCENT, BUSY_PERCENT, ast_dsp::busycount, ast_dsp::busymaybe, DSP_HISTORY, ast_dsp::historicnoise, ast_dsp::historicsilence, ast_dsp_busy_pattern::length, MAX, and ast_dsp_busy_pattern::pattern.

Referenced by ast_dsp_process().

01179 {
01180    int res = 0, x;
01181 #ifndef BUSYDETECT_TONEONLY
01182    int avgsilence = 0, hitsilence = 0;
01183 #endif
01184    int avgtone = 0, hittone = 0;
01185 
01186    /* if we have a 4 length pattern, the way busymaybe is set doesn't help us. */
01187    if (dsp->busy_cadence.length != 4) {
01188       if (!dsp->busymaybe) {
01189          return res;
01190       }
01191    }
01192 
01193    for (x = DSP_HISTORY - dsp->busycount; x < DSP_HISTORY; x++) {
01194 #ifndef BUSYDETECT_TONEONLY
01195       avgsilence += dsp->historicsilence[x];
01196 #endif
01197       avgtone += dsp->historicnoise[x];
01198    }
01199 #ifndef BUSYDETECT_TONEONLY
01200    avgsilence /= dsp->busycount;
01201 #endif
01202    avgtone /= dsp->busycount;
01203    for (x = DSP_HISTORY - dsp->busycount; x < DSP_HISTORY; x++) {
01204 #ifndef BUSYDETECT_TONEONLY
01205       if (avgsilence > dsp->historicsilence[x]) {
01206          if (avgsilence - (avgsilence * BUSY_PERCENT / 100) <= dsp->historicsilence[x]) {
01207             hitsilence++;
01208          }
01209       } else {
01210          if (avgsilence + (avgsilence * BUSY_PERCENT / 100) >= dsp->historicsilence[x]) {
01211             hitsilence++;
01212          }
01213       }
01214 #endif
01215       if (avgtone > dsp->historicnoise[x]) {
01216          if (avgtone - (avgtone * BUSY_PERCENT / 100) <= dsp->historicnoise[x]) {
01217             hittone++;
01218          }
01219       } else {
01220          if (avgtone + (avgtone * BUSY_PERCENT / 100) >= dsp->historicnoise[x]) {
01221             hittone++;
01222          }
01223       }
01224    }
01225 #ifndef BUSYDETECT_TONEONLY
01226    if ((hittone >= dsp->busycount - 1) && (hitsilence >= dsp->busycount - 1) &&
01227        (avgtone >= BUSY_MIN && avgtone <= BUSY_MAX) &&
01228        (avgsilence >= BUSY_MIN && avgsilence <= BUSY_MAX)) {
01229 #else
01230    if ((hittone >= dsp->busycount - 1) && (avgtone >= BUSY_MIN && avgtone <= BUSY_MAX)) {
01231 #endif
01232 #ifdef BUSYDETECT_COMPARE_TONE_AND_SILENCE
01233       if (avgtone > avgsilence) {
01234          if (avgtone - avgtone*BUSY_PERCENT/100 <= avgsilence) {
01235             res = 1;
01236          }
01237       } else {
01238          if (avgtone + avgtone*BUSY_PERCENT/100 >= avgsilence) {
01239             res = 1;
01240          }
01241       }
01242 #else
01243       res = 1;
01244 #endif
01245    }
01246 
01247    /* If we have a 4-length pattern, we can go ahead and just check it in a different way. */
01248    if (dsp->busy_cadence.length == 4) {
01249       int x;
01250       int errors = 0;
01251       int errors_max = ((4 * dsp->busycount) / 100.0) * BUSY_PAT_PERCENT;
01252 
01253       for (x = DSP_HISTORY - (dsp->busycount); x < DSP_HISTORY; x += 2) {
01254          int temp_error;
01255          temp_error = abs(dsp->historicnoise[x] - dsp->busy_cadence.pattern[0]);
01256          if ((temp_error * 100) / dsp->busy_cadence.pattern[0] > BUSY_PERCENT) {
01257             errors++;
01258          }
01259 
01260          temp_error = abs(dsp->historicnoise[x + 1] - dsp->busy_cadence.pattern[2]);
01261          if ((temp_error * 100) / dsp->busy_cadence.pattern[2] > BUSY_PERCENT) {
01262             errors++;
01263          }
01264 
01265          temp_error = abs(dsp->historicsilence[x] - dsp->busy_cadence.pattern[1]);
01266          if ((temp_error * 100) / dsp->busy_cadence.pattern[1] > BUSY_PERCENT) {
01267             errors++;
01268          }
01269 
01270          temp_error = abs(dsp->historicsilence[x + 1] - dsp->busy_cadence.pattern[3]);
01271          if ((temp_error * 100) / dsp->busy_cadence.pattern[3] > BUSY_PERCENT) {
01272             errors++;
01273          }
01274       }
01275 
01276       ast_debug(5, "errors = %d  max = %d\n", errors, errors_max);
01277 
01278       if (errors <= errors_max) {
01279          return 1;
01280       }
01281    }
01282 
01283    /* If we know the expected busy tone length, check we are in the range */
01284    if (res && (dsp->busy_cadence.pattern[0] > 0)) {
01285       if (abs(avgtone - dsp->busy_cadence.pattern[0]) > MAX(dsp->busy_cadence.pattern[0]*BUSY_PAT_PERCENT/100, 20)) {
01286 #ifdef BUSYDETECT_DEBUG
01287          ast_debug(5, "busy detector: avgtone of %d not close enough to desired %d\n",
01288             avgtone, dsp->busy_cadence.pattern[0]);
01289 #endif
01290          res = 0;
01291       }
01292    }
01293 #ifndef BUSYDETECT_TONEONLY
01294    /* If we know the expected busy tone silent-period length, check we are in the range */
01295    if (res && (dsp->busy_cadence.pattern[1] > 0)) {
01296       if (abs(avgsilence - dsp->busy_cadence.pattern[1]) > MAX(dsp->busy_cadence.pattern[1]*BUSY_PAT_PERCENT/100, 20)) {
01297 #ifdef BUSYDETECT_DEBUG
01298       ast_debug(5, "busy detector: avgsilence of %d not close enough to desired %d\n",
01299          avgsilence, dsp->busy_cadence.pattern[1]);
01300 #endif
01301          res = 0;
01302       }
01303    }
01304 #endif
01305 #if !defined(BUSYDETECT_TONEONLY) && defined(BUSYDETECT_DEBUG)
01306    if (res) {
01307       ast_debug(5, "ast_dsp_busydetect detected busy, avgtone: %d, avgsilence %d\n", avgtone, avgsilence);
01308    } else {
01309       ast_debug(5, "busy detector: FAILED with avgtone: %d, avgsilence %d\n", avgtone, avgsilence);
01310    }
01311 #endif
01312    return res;
01313 }

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

Scans for progress indication in audio.

Definition at line 1099 of file dsp.c.

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

01100 {
01101    if (inf->frametype != AST_FRAME_VOICE) {
01102       ast_log(LOG_WARNING, "Can't check call progress of non-voice frames\n");
01103       return 0;
01104    }
01105    if (!ast_format_is_slinear(&inf->subclass.format)) {
01106       ast_log(LOG_WARNING, "Can only check call progress in signed-linear frames\n");
01107       return 0;
01108    }
01109    return __ast_dsp_call_progress(dsp, inf->data.ptr, inf->datalen / 2);
01110 }

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 1666 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().

01667 {
01668    int i;
01669 
01670    dsp->dtmf_began = 0;
01671    if (dsp->digitmode & DSP_DIGITMODE_MF) {
01672       mf_detect_state_t *s = &dsp->digit_state.td.mf;
01673       /* Reinitialise the detector for the next block */
01674       for (i = 0;  i < 6;  i++) {
01675          goertzel_reset(&s->tone_out[i]);
01676       }
01677       s->hits[4] = s->hits[3] = s->hits[2] = s->hits[1] = s->hits[0] = s->current_hit = 0;
01678       s->current_sample = 0;
01679    } else {
01680       dtmf_detect_state_t *s = &dsp->digit_state.td.dtmf;
01681       /* Reinitialise the detector for the next block */
01682       for (i = 0;  i < 4;  i++) {
01683          goertzel_reset(&s->row_out[i]);
01684          goertzel_reset(&s->col_out[i]);
01685       }
01686       s->lasthit = s->current_hit = 0;
01687       s->energy = 0.0;
01688       s->current_sample = 0;
01689       s->hits = 0;
01690       s->misses = 0;
01691    }
01692 
01693    dsp->digit_state.digits[0] = '\0';
01694    dsp->digit_state.current_digits = 0;
01695 }

void ast_dsp_free ( struct ast_dsp *  dsp  ) 

Definition at line 1639 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_faxdetect(), destroy_session(), disable_dsp_detect(), do_waiting(), handle_recordfile(), isAnsweringMachine(), mgcp_hangup(), my_all_subchannels_hungup(), my_dsp_set_digitmode(), record_exec(), set_softmix_bridge_data(), sip_rtp_read(), softmix_bridge_leave(), and unload_module().

01640 {
01641    ast_free(dsp);
01642 }

unsigned int ast_dsp_get_sample_rate ( const struct ast_dsp *  dsp  ) 

Retrieve the sample rate this DSP structure was created with.

Definition at line 1594 of file dsp.c.

References ast_dsp::sample_rate.

01595 {
01596    return dsp->sample_rate;
01597 }

int ast_dsp_get_tcount ( struct ast_dsp *  dsp  ) 

Get tcount (Threshold counter).

Definition at line 1759 of file dsp.c.

References ast_dsp::tcount.

Referenced by dahdi_read().

01760 {
01761    return dsp->tcount;
01762 }

int ast_dsp_get_threshold_from_settings ( enum threshold  which  ) 

Get silence threshold from dsp.conf.

Since:
1.6.1

Definition at line 1797 of file dsp.c.

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

01798 {
01799    return thresholds[which];
01800 }

int ast_dsp_get_tstate ( struct ast_dsp *  dsp  ) 

Get tstate (Tone State).

Definition at line 1754 of file dsp.c.

References ast_dsp::tstate.

Referenced by dahdi_read().

01755 {
01756    return dsp->tstate;
01757 }

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 1802 of file dsp.c.

References _dsp_init().

Referenced by main().

01803 {
01804    return _dsp_init(0);
01805 }

struct ast_dsp* ast_dsp_new ( void   )  [read]

Allocates a new dsp, assumes 8khz for internal sample rate.

Definition at line 1621 of file dsp.c.

References __ast_dsp_new(), and DEFAULT_SAMPLE_RATE.

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

01622 {
01623    return __ast_dsp_new(DEFAULT_SAMPLE_RATE);
01624 }

struct ast_dsp* ast_dsp_new_with_rate ( unsigned int  sample_rate  )  [read]

Allocates a new dsp with a specific internal sample rate used during processing.

Definition at line 1626 of file dsp.c.

References __ast_dsp_new().

Referenced by set_softmix_bridge_data().

01627 {
01628    return __ast_dsp_new(sample_rate);
01629 }

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 1371 of file dsp.c.

References ast_dsp_silence_noise_with_energy().

Referenced by do_waiting().

01372 {
01373    return ast_dsp_silence_noise_with_energy(dsp, f, totalnoise, NULL, 1);
01374 }

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 1377 of file dsp.c.

References __ast_dsp_call_progress(), __ast_dsp_silence_noise(), ast_channel::_softhangup, AST_ALAW, ast_channel_name(), 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_is_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, 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_subclass::format, ast_frame::frametype, ast_dsp::historicnoise, ast_dsp::historicsilence, ast_format::id, ast_frame_subclass::integer, ast_frame::len, len(), LOG_WARNING, mf_detect(), ast_dsp::mute_data, ast_dsp::mute_fragments, ast_frame::ptr, ast_dsp::sample_rate, ast_frame::src, fragment_t::start, ast_frame::subclass, and tone_detect().

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

01378 {
01379    int silence;
01380    int res;
01381    int digit = 0, fax_digit = 0;
01382    int x;
01383    short *shortdata;
01384    unsigned char *odata;
01385    int len;
01386    struct ast_frame *outf = NULL;
01387 
01388    if (!af) {
01389       return NULL;
01390    }
01391    if (af->frametype != AST_FRAME_VOICE) {
01392       return af;
01393    }
01394 
01395    odata = af->data.ptr;
01396    len = af->datalen;
01397    /* Make sure we have short data */
01398    if (ast_format_is_slinear(&af->subclass.format)) {
01399       shortdata = af->data.ptr;
01400       len = af->datalen / 2;
01401    } else {
01402       switch (af->subclass.format.id) {
01403       case AST_FORMAT_ULAW:
01404       case AST_FORMAT_TESTLAW:
01405          shortdata = alloca(af->datalen * 2);
01406          for (x = 0;x < len; x++) {
01407             shortdata[x] = AST_MULAW(odata[x]);
01408          }
01409          break;
01410       case AST_FORMAT_ALAW:
01411          shortdata = alloca(af->datalen * 2);
01412          for (x = 0; x < len; x++) {
01413             shortdata[x] = AST_ALAW(odata[x]);
01414          }
01415          break;
01416       default:
01417          /*Display warning only once. Otherwise you would get hundreds of warnings every second */
01418          if (dsp->display_inband_dtmf_warning)
01419             ast_log(LOG_WARNING, "Inband DTMF is not supported on codec %s. Use RFC2833\n", ast_getformatname(&af->subclass.format));
01420          dsp->display_inband_dtmf_warning = 0;
01421          return af;
01422       }
01423    }
01424 
01425    /* Initially we do not want to mute anything */
01426    dsp->mute_fragments = 0;
01427 
01428    /* Need to run the silence detection stuff for silence suppression and busy detection */
01429    if ((dsp->features & DSP_FEATURE_SILENCE_SUPPRESS) || (dsp->features & DSP_FEATURE_BUSY_DETECT)) {
01430       res = __ast_dsp_silence_noise(dsp, shortdata, len, &silence, NULL, NULL);
01431    }
01432 
01433    if ((dsp->features & DSP_FEATURE_SILENCE_SUPPRESS) && silence) {
01434       memset(&dsp->f, 0, sizeof(dsp->f));
01435       dsp->f.frametype = AST_FRAME_NULL;
01436       ast_frfree(af);
01437       return ast_frisolate(&dsp->f);
01438    }
01439    if ((dsp->features & DSP_FEATURE_BUSY_DETECT) && ast_dsp_busydetect(dsp)) {
01440       chan->_softhangup |= AST_SOFTHANGUP_DEV;
01441       memset(&dsp->f, 0, sizeof(dsp->f));
01442       dsp->f.frametype = AST_FRAME_CONTROL;
01443       dsp->f.subclass.integer = AST_CONTROL_BUSY;
01444       ast_frfree(af);
01445       ast_debug(1, "Requesting Hangup because the busy tone was detected on channel %s\n", ast_channel_name(chan));
01446       return ast_frisolate(&dsp->f);
01447    }
01448 
01449    if ((dsp->features & DSP_FEATURE_FAX_DETECT)) {
01450       if ((dsp->faxmode & DSP_FAXMODE_DETECT_CNG) && tone_detect(dsp, &dsp->cng_tone_state, shortdata, len)) {
01451          fax_digit = 'f';
01452       }
01453 
01454       if ((dsp->faxmode & DSP_FAXMODE_DETECT_CED) && tone_detect(dsp, &dsp->ced_tone_state, shortdata, len)) {
01455          fax_digit = 'e';
01456       }
01457    }
01458 
01459    if (dsp->features & (DSP_FEATURE_DIGIT_DETECT | DSP_FEATURE_BUSY_DETECT)) {
01460       if (dsp->digitmode & DSP_DIGITMODE_MF) {
01461          digit = mf_detect(dsp, &dsp->digit_state, shortdata, len, (dsp->digitmode & DSP_DIGITMODE_NOQUELCH) == 0, (dsp->digitmode & DSP_DIGITMODE_RELAXDTMF));
01462       } else {
01463          digit = dtmf_detect(dsp, &dsp->digit_state, shortdata, len, (dsp->digitmode & DSP_DIGITMODE_NOQUELCH) == 0, (dsp->digitmode & DSP_DIGITMODE_RELAXDTMF));
01464       }
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 / dsp->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             }
01536             break;
01537          default:
01538             ast_log(LOG_WARNING, "Don't know how to represent call progress message %d\n", res);
01539          }
01540       }
01541    } else if ((dsp->features & DSP_FEATURE_WAITDIALTONE)) {
01542       res = __ast_dsp_call_progress(dsp, shortdata, len);
01543    }
01544 
01545 done:
01546    /* Mute fragment of the frame */
01547    for (x = 0; x < dsp->mute_fragments; x++) {
01548       memset(shortdata + dsp->mute_data[x].start, 0, sizeof(int16_t) * (dsp->mute_data[x].end - dsp->mute_data[x].start));
01549    }
01550 
01551    switch (af->subclass.format.id) {
01552    case AST_FORMAT_ULAW:
01553       for (x = 0; x < len; x++) {
01554          odata[x] = AST_LIN2MU((unsigned short) shortdata[x]);
01555       }
01556       break;
01557    case AST_FORMAT_ALAW:
01558       for (x = 0; x < len; x++) {
01559          odata[x] = AST_LIN2A((unsigned short) shortdata[x]);
01560       }
01561       /* fall through */
01562    default:
01563       break;
01564    }
01565 
01566    if (outf) {
01567       if (chan) {
01568          ast_queue_frame(chan, af);
01569       }
01570       ast_frfree(af);
01571       return ast_frisolate(outf);
01572    } else {
01573       return af;
01574    }
01575 }

int ast_dsp_reload ( void   ) 

Reloads dsp settings from dsp.conf.

Since:
1.6.1

Definition at line 1807 of file dsp.c.

References _dsp_init().

01808 {
01809    return _dsp_init(1);
01810 }

void ast_dsp_reset ( struct ast_dsp *  dsp  ) 

Reset total silence count.

Definition at line 1697 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().

01698 {
01699    int x;
01700 
01701    dsp->totalsilence = 0;
01702    dsp->gsamps = 0;
01703    for (x = 0; x < 4; x++) {
01704       dsp->freqs[x].v2 = dsp->freqs[x].v3 = 0.0;
01705    }
01706    memset(dsp->historicsilence, 0, sizeof(dsp->historicsilence));
01707    memset(dsp->historicnoise, 0, sizeof(dsp->historicnoise));
01708    dsp->ringtimeout= 0;
01709 }

void ast_dsp_set_busy_count ( struct ast_dsp *  dsp,
int  cadences 
)

Set number of required cadences for busy.

Definition at line 1649 of file dsp.c.

References ast_dsp::busycount, and DSP_HISTORY.

Referenced by dahdi_new().

01650 {
01651    if (cadences < 4) {
01652       cadences = 4;
01653    }
01654    if (cadences > DSP_HISTORY) {
01655       cadences = DSP_HISTORY;
01656    }
01657    dsp->busycount = cadences;
01658 }

void ast_dsp_set_busy_pattern ( struct ast_dsp *  dsp,
const struct ast_dsp_busy_pattern *  cadence 
)

Set expected lengths of the busy tone.

Definition at line 1660 of file dsp.c.

References ast_debug, ast_dsp::busy_cadence, ast_dsp_busy_pattern::length, and ast_dsp_busy_pattern::pattern.

Referenced by dahdi_new().

01661 {
01662    dsp->busy_cadence = *cadence;
01663    ast_debug(1, "dsp busy pattern set to %d,%d,%d,%d\n", cadence->pattern[0], cadence->pattern[1], (cadence->length == 4) ? cadence->pattern[2] : 0, (cadence->length == 4) ? cadence->pattern[3] : 0);
01664 }

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

Set zone for doing progress detection.

Definition at line 1735 of file dsp.c.

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

Referenced by dahdi_new().

01736 {
01737    int x;
01738 
01739    for (x = 0; x < ARRAY_LEN(aliases); x++) {
01740       if (!strcasecmp(aliases[x].name, zone)) {
01741          dsp->progmode = aliases[x].mode;
01742          ast_dsp_prog_reset(dsp);
01743          return 0;
01744       }
01745    }
01746    return -1;
01747 }

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 1711 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, DSP_DIGITMODE_MUTEMAX, and ast_dsp::sample_rate.

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

01712 {
01713    int new;
01714    int old;
01715 
01716    old = dsp->digitmode & (DSP_DIGITMODE_DTMF | DSP_DIGITMODE_MF | DSP_DIGITMODE_MUTECONF | DSP_DIGITMODE_MUTEMAX);
01717    new = digitmode & (DSP_DIGITMODE_DTMF | DSP_DIGITMODE_MF | DSP_DIGITMODE_MUTECONF | DSP_DIGITMODE_MUTEMAX);
01718    if (old != new) {
01719       /* Must initialize structures if switching from MF to DTMF or vice-versa */
01720       ast_digit_detect_init(&dsp->digit_state, new & DSP_DIGITMODE_MF, dsp->sample_rate);
01721    }
01722    dsp->digitmode = digitmode;
01723    return 0;
01724 }

int ast_dsp_set_faxmode ( struct ast_dsp *  dsp,
int  faxmode 
)

Set fax mode.

Definition at line 1726 of file dsp.c.

References ast_fax_detect_init(), and ast_dsp::faxmode.

Referenced by fax_detect_new().

01727 {
01728    if (dsp->faxmode != faxmode) {
01729       dsp->faxmode = faxmode;
01730       ast_fax_detect_init(dsp);
01731    }
01732    return 0;
01733 }

void ast_dsp_set_features ( struct ast_dsp *  dsp,
int  features 
)

Select feature set.

Definition at line 1631 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(), fax_detect_new(), mgcp_new(), misdn_set_opt_exec(), my_handle_dtmf(), read_config(), sip_rtp_read(), and store_config().

01632 {
01633    dsp->features = features;
01634    if (!(features & DSP_FEATURE_DIGIT_DETECT)) {
01635       dsp->display_inband_dtmf_warning = 0;
01636    }
01637 }

void ast_dsp_set_threshold ( struct ast_dsp *  dsp,
int  threshold 
)

Set threshold value for silence.

Definition at line 1644 of file dsp.c.

References ast_dsp::threshold.

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

01645 {
01646    dsp->threshold = threshold;
01647 }

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 1366 of file dsp.c.

References ast_dsp_silence_noise_with_energy().

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

01367 {
01368    return ast_dsp_silence_noise_with_energy(dsp, f, totalsilence, NULL, 0);
01369 }

int ast_dsp_silence_with_energy ( struct ast_dsp *  dsp,
struct ast_frame *  f,
int *  totalsilence,
int *  frames_energy 
)

Return non-zero if this is silence. Updates "totalsilence" with the total number of seconds of silence. Returns the average energy of the samples in the frame in frames_energy variable.

Definition at line 1361 of file dsp.c.

References ast_dsp_silence_noise_with_energy().

Referenced by softmix_bridge_write().

01362 {
01363    return ast_dsp_silence_noise_with_energy(dsp, f, totalsilence, frames_energy, 0);
01364 }

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 1749 of file dsp.c.

References ast_dsp::mute_fragments.

Referenced by dahdi_read().

01750 {
01751    return (dsp->mute_fragments > 0);
01752 }

Generated on Fri Feb 10 06:35:58 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6