8bf27158b59bd65182084bdfcdae0c5368fd8eb5
[asterisk/asterisk.git] / include / asterisk / callerid.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 CallerID (and other GR30) management and generation
21  * Includes code and algorithms from the Zapata library.
22  *
23  * \ref CID
24  *
25  */
26
27 /*!
28  * \page CID Caller ID names and numbers
29  *
30  * Caller ID names are currently 8 bit characters, propably
31  * ISO8859-1, depending on what your channel drivers handle.
32  *
33  * IAX2 and SIP caller ID names are UTF8
34  * On ISDN Caller ID names are 7 bit, Almost ASCII
35  * (See http://www.zytrax.com/tech/ia5.html )
36  *
37  * \note Asterisk does not currently support SIP utf8 caller ID names or caller ID's.
38  *
39  * \par See also
40  *      \arg \ref callerid.c
41  *      \arg \ref callerid.h
42  *      \arg \ref Def_CallerPres
43  */
44
45 #ifndef _ASTERISK_CALLERID_H
46 #define _ASTERISK_CALLERID_H
47
48 #define MAX_CALLERID_SIZE 32000
49
50 #define CID_PRIVATE_NAME                (1 << 0)
51 #define CID_PRIVATE_NUMBER              (1 << 1)
52 #define CID_UNKNOWN_NAME                (1 << 2)
53 #define CID_UNKNOWN_NUMBER              (1 << 3)
54 #define CID_MSGWAITING                  (1 << 4)
55 #define CID_NOMSGWAITING                (1 << 5)
56
57 #define CID_SIG_BELL    1
58 #define CID_SIG_V23     2
59 #define CID_SIG_DTMF    3
60 #define CID_SIG_V23_JP  4
61 #define CID_SIG_SMDI    5
62
63 #define CID_START_RING  1
64 #define CID_START_POLARITY 2
65 #define CID_START_POLARITY_IN 3
66
67
68 #define AST_LIN2X(a) ((codec == AST_FORMAT_ALAW) ? (AST_LIN2A(a)) : (AST_LIN2MU(a)))
69 #define AST_XLAW(a) ((codec == AST_FORMAT_ALAW) ? (AST_ALAW(a)) : (AST_MULAW(a)))
70
71
72 struct callerid_state;
73 typedef struct callerid_state CIDSTATE;
74
75 /*! \brief CallerID Initialization
76  * \par
77  * Initializes the callerid system.  Mostly stuff for inverse FFT
78  */
79 void callerid_init(void);
80
81 /*! \brief Generates a CallerID FSK stream in ulaw format suitable for transmission.
82  * \param buf Buffer to use. If "buf" is supplied, it will use that buffer instead of allocating its own.  "buf" must be at least 32000 bytes in size of you want to be sure you don't have an overrun.
83  * \param number Use NULL for no number or "P" for "private"
84  * \param name name to be used
85  * \param flags passed flags
86  * \param callwaiting callwaiting flag
87  * \param codec -- either AST_FORMAT_ULAW or AST_FORMAT_ALAW
88  * This function creates a stream of callerid (a callerid spill) data in ulaw format.
89  * \return It returns the size
90  * (in bytes) of the data (if it returns a size of 0, there is probably an error)
91 */
92 int callerid_generate(unsigned char *buf, const char *number, const char *name, int flags, int callwaiting, int codec);
93
94 /*! \brief Create a callerID state machine
95  * \param cid_signalling Type of signalling in use
96  *
97  * This function returns a malloc'd instance of the callerid_state data structure.
98  * \return Returns a pointer to a malloc'd callerid_state structure, or NULL on error.
99  */
100 struct callerid_state *callerid_new(int cid_signalling);
101
102 /*! \brief Read samples into the state machine.
103  * \param cid Which state machine to act upon
104  * \param ubuf containing your samples
105  * \param samples number of samples contained within the buffer.
106  * \param codec which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW)
107  *
108  * Send received audio to the Caller*ID demodulator.
109  * \return Returns -1 on error, 0 for "needs more samples",
110  * and 1 if the CallerID spill reception is complete.
111  */
112 int callerid_feed(struct callerid_state *cid, unsigned char *ubuf, int samples, int codec);
113
114 /*! \brief Read samples into the state machine.
115  * \param cid Which state machine to act upon
116  * \param ubuf containing your samples
117  * \param samples number of samples contained within the buffer.
118  * \param codec which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW)
119  *
120  * Send received audio to the Caller*ID demodulator (for japanese style lines).
121  * \return Returns -1 on error, 0 for "needs more samples",
122  * and 1 if the CallerID spill reception is complete.
123  */
124 int callerid_feed_jp(struct callerid_state *cid, unsigned char *ubuf, int samples, int codec);
125
126 /*! \brief Extract info out of callerID state machine.  Flags are listed above
127  * \param cid Callerid state machine to act upon
128  * \param number Pass the address of a pointer-to-char (will contain the phone number)
129  * \param name Pass the address of a pointer-to-char (will contain the name)
130  * \param flags Pass the address of an int variable(will contain the various callerid flags)
131  *
132  * This function extracts a callerid string out of a callerid_state state machine.
133  * If no number is found, *number will be set to NULL.  Likewise for the name.
134  * Flags can contain any of the following:
135  *
136  * \return Returns nothing.
137  */
138 void callerid_get(struct callerid_state *cid, char **number, char **name, int *flags);
139
140 /*! Get and parse DTMF-based callerid  */
141 /*!
142  * \param cidstring The actual transmitted string.
143  * \param number The cid number is returned here.
144  * \param flags The cid flags are returned here.
145  * This function parses DTMF callerid.
146  */
147 void callerid_get_dtmf(char *cidstring, char *number, int *flags);
148
149 /*! \brief Free a callerID state
150  * \param cid This is the callerid_state state machine to free
151  * This function frees callerid_state cid.
152  */
153 void callerid_free(struct callerid_state *cid);
154
155 /*! \brief Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format)
156  * \param buf buffer for output samples. See callerid_generate() for details regarding buffer.
157  * \param name Caller-ID Name
158  * \param number Caller-ID Number
159  * \param codec Asterisk codec (either AST_FORMAT_ALAW or AST_FORMAT_ULAW)
160  *
161  * Acts like callerid_generate except uses an asterisk format callerid string.
162  */
163 int ast_callerid_generate(unsigned char *buf, const char *name, const char *number, int codec);
164
165 /*! \brief Generate message waiting indicator  (stutter tone) */
166 int vmwi_generate(unsigned char *buf, int active, int mdmf, int codec);
167
168 /*! \brief Generate Caller-ID spill but in a format suitable for Call Waiting(tm)'s Caller*ID(tm)
169  * See ast_callerid_generate() for other details
170  */
171 int ast_callerid_callwaiting_generate(unsigned char *buf, const char *name, const char *number, int codec);
172
173 /*! \brief Destructively parse inbuf into name and location (or number)
174  * Parses callerid stream from inbuf and changes into useable form, outputed in name and location.
175  * \param instr buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed.
176  * \param name address of a pointer-to-char for the name value of the stream.
177  * \param location address of a pointer-to-char for the phone number value of the stream.
178  * \return Returns 0 on success, -1 on failure.
179  */
180 int ast_callerid_parse(char *instr, char **name, char **location);
181
182 /*! Generate a CAS (CPE Alert Signal) tone for 'n' samples */
183 /*!
184  * \param outbuf Allocated buffer for data.  Must be at least 2400 bytes unless no SAS is desired
185  * \param sas Non-zero if CAS should be preceeded by SAS
186  * \param len How many samples to generate.
187  * \param codec Which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW)
188  * \return Returns -1 on error (if len is less than 2400), 0 on success.
189  */
190 int ast_gen_cas(unsigned char *outbuf, int sas, int len, int codec);
191
192 /*! \brief Shrink a phone number in place to just digits (more accurately it just removes ()'s, .'s, and -'s... */
193 /*!
194  * \param n The number to be stripped/shrunk
195  * \return Returns nothing important
196  */
197 void ast_shrink_phone_number(char *n);
198
199 /*! \brief Check if a string consists only of digits and + \#
200     \param n number to be checked.
201     \return Returns 0 if n is a number, 1 if it's not.
202  */
203 int ast_isphonenumber(const char *n);
204
205 /*! \brief Check if a string consists only of digits and and + \# ( ) - .
206         (meaning it can be cleaned with ast_shrink_phone_number)
207     \param exten The extension (or URI) to be checked.
208     \return Returns 0 if n is a number, 1 if it's not.
209  */
210 int ast_is_shrinkable_phonenumber(const char *exten);
211
212 int ast_callerid_split(const char *src, char *name, int namelen, char *num, int numlen);
213
214 char *ast_callerid_merge(char *buf, int bufsiz, const char *name, const char *num, const char *unknown);
215
216 /*
217  * Caller*ID and other GR-30 compatible generation
218  * routines (used by ADSI for example)
219  */
220
221 extern float cid_dr[4];
222 extern float cid_di[4];
223 extern float clidsb;
224
225 static inline float callerid_getcarrier(float *cr, float *ci, int bit)
226 {
227         /* Move along.  There's nothing to see here... */
228         float t;
229         t = *cr * cid_dr[bit] - *ci * cid_di[bit];
230         *ci = *cr * cid_di[bit] + *ci * cid_dr[bit];
231         *cr = t;
232
233         t = 2.0 - (*cr * *cr + *ci * *ci);
234         *cr *= t;
235         *ci *= t;
236         return *cr;
237 }
238
239 #define PUT_BYTE(a) do { \
240         *(buf++) = (a); \
241         bytes++; \
242 } while(0)
243
244 #define PUT_AUDIO_SAMPLE(y) do { \
245         int index = (short)(rint(8192.0 * (y))); \
246         *(buf++) = AST_LIN2X(index); \
247         bytes++; \
248 } while(0)
249
250 #define PUT_CLID_MARKMS do { \
251         int x; \
252         for (x=0;x<8;x++) \
253                 PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, 1)); \
254 } while(0)
255
256 #define PUT_CLID_BAUD(bit) do { \
257         while(scont < clidsb) { \
258                 PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, bit)); \
259                 scont += 1.0; \
260         } \
261         scont -= clidsb; \
262 } while(0)
263
264
265 #define PUT_CLID(byte) do { \
266         int z; \
267         unsigned char b = (byte); \
268         PUT_CLID_BAUD(0);       /* Start bit */ \
269         for (z=0;z<8;z++) { \
270                 PUT_CLID_BAUD(b & 1); \
271                 b >>= 1; \
272         } \
273         PUT_CLID_BAUD(1);       /* Stop bit */ \
274 } while(0)
275
276 /* Various defines and bits for handling PRI- and SS7-type restriction */
277
278 #define AST_PRES_NUMBER_TYPE                            0x03
279 #define AST_PRES_USER_NUMBER_UNSCREENED                 0x00
280 #define AST_PRES_USER_NUMBER_PASSED_SCREEN              0x01
281 #define AST_PRES_USER_NUMBER_FAILED_SCREEN              0x02
282 #define AST_PRES_NETWORK_NUMBER                         0x03
283
284 #define AST_PRES_RESTRICTION                            0x60
285 #define AST_PRES_ALLOWED                                0x00
286 #define AST_PRES_RESTRICTED                             0x20
287 #define AST_PRES_UNAVAILABLE                            0x40
288 #define AST_PRES_RESERVED                               0x60
289
290 #define AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED \
291         AST_PRES_USER_NUMBER_UNSCREENED + AST_PRES_ALLOWED
292
293 #define AST_PRES_ALLOWED_USER_NUMBER_PASSED_SCREEN \
294         AST_PRES_USER_NUMBER_PASSED_SCREEN + AST_PRES_ALLOWED
295
296 #define AST_PRES_ALLOWED_USER_NUMBER_FAILED_SCREEN \
297         AST_PRES_USER_NUMBER_FAILED_SCREEN + AST_PRES_ALLOWED
298
299 #define AST_PRES_ALLOWED_NETWORK_NUMBER \
300         AST_PRES_NETWORK_NUMBER + AST_PRES_ALLOWED
301
302 #define AST_PRES_PROHIB_USER_NUMBER_NOT_SCREENED \
303         AST_PRES_USER_NUMBER_UNSCREENED + AST_PRES_RESTRICTED
304
305 #define AST_PRES_PROHIB_USER_NUMBER_PASSED_SCREEN \
306         AST_PRES_USER_NUMBER_PASSED_SCREEN + AST_PRES_RESTRICTED
307
308 #define AST_PRES_PROHIB_USER_NUMBER_FAILED_SCREEN \
309         AST_PRES_USER_NUMBER_FAILED_SCREEN + AST_PRES_RESTRICTED
310
311 #define AST_PRES_PROHIB_NETWORK_NUMBER \
312         AST_PRES_NETWORK_NUMBER + AST_PRES_RESTRICTED
313
314 #define AST_PRES_NUMBER_NOT_AVAILABLE \
315         AST_PRES_NETWORK_NUMBER + AST_PRES_UNAVAILABLE
316
317 int ast_parse_caller_presentation(const char *data);
318 const char *ast_describe_caller_presentation(int data);
319 const char *ast_named_caller_presentation(int data);
320
321 /*! \page Def_CallerPres Caller ID Presentation
322
323         Caller ID presentation values are used to set properties to a
324         caller ID in PSTN networks, and as RPID value in SIP transactions.
325
326         The following values are available to use:
327         \arg \b Defined value, text string in config file, explanation
328
329         \arg \b AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED, "allowed_not_screened", Presentation Allowed, Not Screened,
330         \arg \b AST_PRES_ALLOWED_USER_NUMBER_PASSED_SCREEN, "allowed_passed_screen", Presentation Allowed, Passed Screen,
331         \arg \b AST_PRES_ALLOWED_USER_NUMBER_FAILED_SCREEN, "allowed_failed_screen", Presentation Allowed, Failed Screen,
332         \arg \b AST_PRES_ALLOWED_NETWORK_NUMBER, "allowed", Presentation Allowed, Network Number,
333         \arg \b AST_PRES_PROHIB_USER_NUMBER_NOT_SCREENED, "prohib_not_screened", Presentation Prohibited, Not Screened,
334         \arg \b AST_PRES_PROHIB_USER_NUMBER_PASSED_SCREEN, "prohib_passed_screen", Presentation Prohibited, Passed Screen,
335         \arg \b AST_PRES_PROHIB_USER_NUMBER_FAILED_SCREEN, "prohib_failed_screen", Presentation Prohibited, Failed Screen,
336         \arg \b AST_PRES_PROHIB_NETWORK_NUMBER, "prohib", Presentation Prohibited, Network Number,
337
338         \par References
339         \arg \ref callerid.h Definitions
340         \arg \ref callerid.c Functions
341         \arg \ref CID Caller ID names and numbers
342 */
343
344
345 #endif /* _ASTERISK_CALLERID_H */