Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
[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_ALL  (DSP_FAXMODE_DETECT_CNG | DSP_FAXMODE_DETECT_CED)
49
50 #define DSP_TONE_STATE_SILENCE  0
51 #define DSP_TONE_STATE_RINGING  1
52 #define DSP_TONE_STATE_DIALTONE 2
53 #define DSP_TONE_STATE_TALKING  3
54 #define DSP_TONE_STATE_BUSY     4
55 #define DSP_TONE_STATE_SPECIAL1 5
56 #define DSP_TONE_STATE_SPECIAL2 6
57 #define DSP_TONE_STATE_SPECIAL3 7
58 #define DSP_TONE_STATE_HUNGUP   8
59
60 struct ast_dsp;
61
62 enum threshold {
63         /* Array offsets */
64         THRESHOLD_SILENCE = 0,
65         /* Always the last */
66         THRESHOLD_MAX = 1,
67 };
68
69 struct ast_dsp *ast_dsp_new(void);
70 void ast_dsp_free(struct ast_dsp *dsp);
71
72 /*! \brief Set threshold value for silence */
73 void ast_dsp_set_threshold(struct ast_dsp *dsp, int threshold);
74
75 /*! \brief Set number of required cadences for busy */
76 void ast_dsp_set_busy_count(struct ast_dsp *dsp, int cadences);
77
78 /*! \brief Set expected lengths of the busy tone */
79 void ast_dsp_set_busy_pattern(struct ast_dsp *dsp, int tonelength, int quietlength);
80
81 /*! \brief Scans for progress indication in audio */
82 int ast_dsp_call_progress(struct ast_dsp *dsp, struct ast_frame *inf);
83
84 /*! \brief Set zone for doing progress detection */
85 int ast_dsp_set_call_progress_zone(struct ast_dsp *dsp, char *zone);
86
87 /*! \brief Return AST_FRAME_NULL frames when there is silence, AST_FRAME_BUSY on
88    busies, and call progress, all dependent upon which features are enabled */
89 struct ast_frame *ast_dsp_process(struct ast_channel *chan, struct ast_dsp *dsp, struct ast_frame *inf);
90
91 /*! \brief Return non-zero if this is silence.  Updates "totalsilence" with the total
92    number of seconds of silence  */
93 int ast_dsp_silence(struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence);
94
95 /*!
96  * \brief Return non-zero if this is noise.  Updates "totalnoise" with the total
97  * number of seconds of noise
98  * \since 1.6.1
99  */
100 int ast_dsp_noise(struct ast_dsp *dsp, struct ast_frame *f, int *totalnoise);
101
102 /*! \brief Return non-zero if historically this should be a busy, request that
103   ast_dsp_silence has already been called */
104 int ast_dsp_busydetect(struct ast_dsp *dsp);
105
106 /*! \brief Return non-zero if DTMF hit was found */
107 int ast_dsp_digitdetect(struct ast_dsp *dsp, struct ast_frame *f);
108
109 /*! \brief Reset total silence count */
110 void ast_dsp_reset(struct ast_dsp *dsp);
111
112 /*! \brief Reset DTMF detector */
113 void ast_dsp_digitreset(struct ast_dsp *dsp);
114
115 /*! \brief Select feature set */
116 void ast_dsp_set_features(struct ast_dsp *dsp, int features);
117
118 /*! \brief Get pending DTMF/MF digits */
119 int ast_dsp_getdigits(struct ast_dsp *dsp, char *buf, int max);
120
121 /*! \brief Set digit mode
122  * \version 1.6.1 renamed from ast_dsp_digitmode to ast_dsp_set_digitmode
123  */
124 int ast_dsp_set_digitmode(struct ast_dsp *dsp, int digitmode);
125
126 /*! \brief Set fax mode */
127 int ast_dsp_set_faxmode(struct ast_dsp *dsp, int faxmode);
128
129 /*!
130  * \brief Returns true if DSP code was muting any fragment of the last processed frame.
131  * Muting (squelching) happens when DSP code removes DTMF/MF/generic tones from the audio
132  * \since 1.6.1
133  */
134 int ast_dsp_was_muted(struct ast_dsp *dsp);
135
136 /*! \brief Get tstate (Tone State) */
137 int ast_dsp_get_tstate(struct ast_dsp *dsp);
138
139 /*! \brief Get tcount (Threshold counter) */
140 int ast_dsp_get_tcount(struct ast_dsp *dsp);
141
142 /*!
143  * \brief Get silence threshold from dsp.conf
144  * \since 1.6.1
145  */
146 int ast_dsp_get_threshold_from_settings(enum threshold which);
147
148 /*!
149  * \brief Reloads dsp settings from dsp.conf
150  * \since 1.6.1
151  */
152 int ast_dsp_reload(void);
153
154 /*!
155  * \brief Load dsp settings from dsp.conf
156  * \since 1.6.1
157  */
158 int ast_dsp_init(void);
159
160 /*!
161  * \brief Hint that a frame from a dsp was freed
162  *
163  * This is called from ast_frame_free if AST_FRFLAG_FROM_DSP is set. This occurs
164  * because it is possible for the dsp to be freed while someone still holds a reference
165  * to the frame that is in that dsp. This has been known to happen when the dsp on a DAHDI
166  * channel detects a busy signal. The channel is hung up, and the application that read the
167  * frame to begin with still has a reference to the frame.
168  *
169  * \return nothing
170  */
171 void ast_dsp_frame_freed(struct ast_frame *fr);
172 #endif /* _ASTERISK_DSP_H */