Version 0.3.0 from FTP
[asterisk/asterisk.git] / include / asterisk / dsp.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Convenient Signal Processing routines
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_DSP_H
15 #define _ASTERISK_DSP_H
16
17 #define DSP_FEATURE_SILENCE_SUPPRESS (1 << 0)
18 #define DSP_FEATURE_BUSY_DETECT      (1 << 1)
19 #define DSP_FEATURE_CALL_PROGRESS    (1 << 2)
20 #define DSP_FEATURE_DTMF_DETECT          (1 << 3)
21
22 #define DSP_DIGITMODE_DTMF                      0                               /* Detect DTMF digits */
23 #define DSP_DIGITMODE_MF                        1                               /* Detect MF digits */
24
25 #define DSP_DIGITMODE_NOQUELCH          (1 << 8)                /* Do not quelch DTMF from in-band */
26 #define DSP_DIGITMODE_MUTECONF          (1 << 9)                /* Mute conference */
27 #define DSP_DIGITMODE_MUTEMAX           (1 << 10)               /* Delay audio by a frame to try to extra quelch */
28 #define DSP_DIGITMODE_RELAXDTMF         (1 << 11)               /* "Radio" mode (relaxed DTMF) */
29
30 struct ast_dsp;
31
32 struct ast_dsp *ast_dsp_new(void);
33 void ast_dsp_free(struct ast_dsp *dsp);
34 /* Set threshold value for silence */
35 void ast_dsp_set_threshold(struct ast_dsp *dsp, int threshold);
36
37 /* Set number of required cadences for busy */
38 void ast_dsp_set_busy_count(struct ast_dsp *dsp, int cadences);
39
40 /* Scans for progress indication in audio */
41 int ast_dsp_call_progress(struct ast_dsp *dsp, struct ast_frame *inf);
42
43 /* Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on 
44    busies, and call progress, all dependent upon which features are enabled */
45 struct ast_frame *ast_dsp_process(struct ast_channel *chan, struct ast_dsp *dsp, struct ast_frame *inf, int needlock);
46
47 /* Return non-zero if this is silence.  Updates "totalsilence" with the total
48    number of seconds of silence  */
49 int ast_dsp_silence(struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence);
50
51 /* Return non-zero if historically this should be a busy, request that
52   ast_dsp_silence has already been called */
53 int ast_dsp_busydetect(struct ast_dsp *dsp);
54
55 /* Return non-zero if DTMF hit was found */
56 int ast_dsp_digitdetect(struct ast_dsp *dsp, struct ast_frame *f);
57
58 /* Reset total silence count */
59 void ast_dsp_reset(struct ast_dsp *dsp);
60
61 /* Reset DTMF detector */
62 void ast_dsp_digitreset(struct ast_dsp *dsp);
63
64 /* Select feature set */
65 void ast_dsp_set_features(struct ast_dsp *dsp, int features);
66
67 /* Get pending DTMF/MF digits */
68 int ast_dsp_getdigits(struct ast_dsp *dsp, char *buf, int max);
69
70 /* Set digit mode */
71 int ast_dsp_digitmode(struct ast_dsp *dsp, int digitmode);
72
73 #endif