78c9a74ac6c4216f8e2ce9b89250f7aad80ce680
[asterisk/asterisk.git] / include / asterisk / dsp.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Convenient Signal Processing routines
21  */
22
23 #ifndef _ASTERISK_DSP_H
24 #define _ASTERISK_DSP_H
25
26 #define DSP_FEATURE_SILENCE_SUPPRESS    (1 << 0)
27 #define DSP_FEATURE_BUSY_DETECT         (1 << 1)
28 #define DSP_FEATURE_DIGIT_DETECT        (1 << 3)
29 #define DSP_FEATURE_FAX_DETECT          (1 << 4)
30
31 #define DSP_DIGITMODE_DTMF                      0                               /*!< Detect DTMF digits */
32 #define DSP_DIGITMODE_MF                        1                               /*!< Detect MF digits */
33
34 #define DSP_DIGITMODE_NOQUELCH          (1 << 8)                /*!< Do not quelch DTMF from in-band */
35 #define DSP_DIGITMODE_MUTECONF          (1 << 9)                /*!< Mute conference */
36 #define DSP_DIGITMODE_MUTEMAX           (1 << 10)               /*!< Delay audio by a frame to try to extra quelch */
37 #define DSP_DIGITMODE_RELAXDTMF         (1 << 11)               /*!< "Radio" mode (relaxed DTMF) */
38
39 #define DSP_PROGRESS_TALK               (1 << 16)               /*!< Enable talk detection */
40 #define DSP_PROGRESS_RINGING            (1 << 17)               /*!< Enable calling tone detection */
41 #define DSP_PROGRESS_BUSY               (1 << 18)               /*!< Enable busy tone detection */
42 #define DSP_PROGRESS_CONGESTION         (1 << 19)               /*!< Enable congestion tone detection */
43 #define DSP_FEATURE_CALL_PROGRESS       (DSP_PROGRESS_TALK | DSP_PROGRESS_RINGING | DSP_PROGRESS_BUSY | DSP_PROGRESS_CONGESTION)
44 #define DSP_FEATURE_WAITDIALTONE        (1 << 20)               /*!< Enable dial tone detection */
45
46 #define DSP_FAXMODE_DETECT_CNG  (1 << 0)
47 #define DSP_FAXMODE_DETECT_CED  (1 << 1)
48 #define DSP_FAXMODE_DETECT_V21  (1 << 2)
49 #define DSP_FAXMODE_DETECT_ALL  (DSP_FAXMODE_DETECT_CNG | DSP_FAXMODE_DETECT_CED | DSP_FAXMODE_DETECT_V21)
50
51 #define DSP_TONE_STATE_SILENCE  0
52 #define DSP_TONE_STATE_RINGING  1
53 #define DSP_TONE_STATE_DIALTONE 2
54 #define DSP_TONE_STATE_TALKING  3
55 #define DSP_TONE_STATE_BUSY     4
56 #define DSP_TONE_STATE_SPECIAL1 5
57 #define DSP_TONE_STATE_SPECIAL2 6
58 #define DSP_TONE_STATE_SPECIAL3 7
59 #define DSP_TONE_STATE_HUNGUP   8
60
61 struct ast_dsp;
62
63 struct ast_dsp_busy_pattern {
64         /*! Number of elements. */
65         int length;
66         /*! Pattern elements in on/off time durations. */
67         int pattern[4];
68 };
69
70 enum threshold {
71         /* Array offsets */
72         THRESHOLD_SILENCE = 0,
73         /* Always the last */
74         THRESHOLD_MAX = 1,
75 };
76
77 /*! \brief Allocates a new dsp with a specific internal sample rate used
78  * during processing. */
79 struct ast_dsp *ast_dsp_new_with_rate(unsigned int sample_rate);
80
81 /*! \brief Allocates a new dsp, assumes 8khz for internal sample rate */
82 struct ast_dsp *ast_dsp_new(void);
83
84 void ast_dsp_free(struct ast_dsp *dsp);
85
86 /*! \brief Retrieve the sample rate this DSP structure was
87  * created with */
88 unsigned int ast_dsp_get_sample_rate(const struct ast_dsp *dsp);
89
90 /*! \brief Set threshold value for silence */
91 void ast_dsp_set_threshold(struct ast_dsp *dsp, int threshold);
92
93 /*! \brief Set number of required cadences for busy */
94 void ast_dsp_set_busy_count(struct ast_dsp *dsp, int cadences);
95
96 /*! \brief Set expected lengths of the busy tone */
97 void ast_dsp_set_busy_pattern(struct ast_dsp *dsp, const struct ast_dsp_busy_pattern *cadence);
98
99 /*! \brief Scans for progress indication in audio */
100 int ast_dsp_call_progress(struct ast_dsp *dsp, struct ast_frame *inf);
101
102 /*! \brief Set zone for doing progress detection */
103 int ast_dsp_set_call_progress_zone(struct ast_dsp *dsp, char *zone);
104
105 /*! \brief Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on
106    busies, and call progress, all dependent upon which features are enabled */
107 struct ast_frame *ast_dsp_process(struct ast_channel *chan, struct ast_dsp *dsp, struct ast_frame *inf);
108
109 /*! \brief Return non-zero if this is silence.  Updates "totalsilence" with the total
110    number of seconds of silence  */
111 int ast_dsp_silence(struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence);
112
113 /*! \brief Return non-zero if this is silence.  Updates "totalsilence" with the total
114    number of seconds of silence. Returns the average energy of the samples in the frame
115    in frames_energy variable. */
116 int ast_dsp_silence_with_energy(struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence, int *frames_energy);
117
118 /*!
119  * \brief Return non-zero if this is noise.  Updates "totalnoise" with the total
120  * number of seconds of noise
121  * \since 1.6.1
122  */
123 int ast_dsp_noise(struct ast_dsp *dsp, struct ast_frame *f, int *totalnoise);
124
125 /*! \brief Return non-zero if historically this should be a busy, request that
126   ast_dsp_silence has already been called */
127 int ast_dsp_busydetect(struct ast_dsp *dsp);
128
129 /*! \brief Return non-zero if DTMF hit was found */
130 int ast_dsp_digitdetect(struct ast_dsp *dsp, struct ast_frame *f);
131
132 /*! \brief Reset total silence count */
133 void ast_dsp_reset(struct ast_dsp *dsp);
134
135 /*! \brief Reset DTMF detector */
136 void ast_dsp_digitreset(struct ast_dsp *dsp);
137
138 /*! \brief Select feature set */
139 void ast_dsp_set_features(struct ast_dsp *dsp, int features);
140
141 /*! \brief Get pending DTMF/MF digits */
142 int ast_dsp_getdigits(struct ast_dsp *dsp, char *buf, int max);
143
144 /*! \brief Set digit mode
145  * \version 1.6.1 renamed from ast_dsp_digitmode to ast_dsp_set_digitmode
146  */
147 int ast_dsp_set_digitmode(struct ast_dsp *dsp, int digitmode);
148
149 /*! \brief Set fax mode */
150 int ast_dsp_set_faxmode(struct ast_dsp *dsp, int faxmode);
151
152 /*!
153  * \brief Returns true if DSP code was muting any fragment of the last processed frame.
154  * Muting (squelching) happens when DSP code removes DTMF/MF/generic tones from the audio
155  * \since 1.6.1
156  */
157 int ast_dsp_was_muted(struct ast_dsp *dsp);
158
159 /*! \brief Get tstate (Tone State) */
160 int ast_dsp_get_tstate(struct ast_dsp *dsp);
161
162 /*! \brief Get tcount (Threshold counter) */
163 int ast_dsp_get_tcount(struct ast_dsp *dsp);
164
165 /*!
166  * \brief Get silence threshold from dsp.conf
167  * \since 1.6.1
168  */
169 int ast_dsp_get_threshold_from_settings(enum threshold which);
170
171 /*!
172  * \brief Reloads dsp settings from dsp.conf
173  * \since 1.6.1
174  */
175 int ast_dsp_reload(void);
176
177 /*!
178  * \brief Load dsp settings from dsp.conf
179  * \since 1.6.1
180  */
181 int ast_dsp_init(void);
182
183 #endif /* _ASTERISK_DSP_H */