Version 0.3.0 from FTP
[asterisk/asterisk.git] / include / asterisk / callerid.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * CallerID (and other GR30) Generation support 
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  * Includes code and algorithms from the Zapata library.
14  *
15  */
16
17 #ifndef _CALLERID_H
18 #define _CALLERID_H
19
20 #define MAX_CALLERID_SIZE 32000
21
22 #define CID_PRIVATE_NAME                (1 << 0)
23 #define CID_PRIVATE_NUMBER              (1 << 1)
24 #define CID_UNKNOWN_NAME                (1 << 2)
25 #define CID_UNKNOWN_NUMBER              (1 << 3)
26
27 #define AST_LIN2X(a) ((codec == AST_FORMAT_ALAW) ? (AST_LIN2A(a)) : (AST_LIN2MU(a)))
28 #define AST_XLAW(a) ((codec == AST_FORMAT_ALAW) ? (AST_ALAW(a)) : (AST_MULAW(a)))
29
30
31 struct callerid_state;
32 typedef struct callerid_state CIDSTATE;
33
34 //! CallerID Initialization
35 /*!
36  * Initializes the callerid system.  Mostly stuff for inverse FFT
37  */
38 extern void callerid_init(void);
39
40 //! Generates a CallerID FSK stream in ulaw format suitable for transmission.
41 /*!
42  * \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.
43  * \param number Use NULL for no number or "P" for "private"
44  * \param name name to be used
45  * \param callwaiting callwaiting flag
46  * \param codec -- either AST_FORMAT_ULAW or AST_FORMAT_ALAW
47  * This function creates a stream of callerid (a callerid spill) data in ulaw format. It returns the size
48  * (in bytes) of the data (if it returns a size of 0, there is probably an error)
49 */
50 extern int callerid_generate(unsigned char *buf, char *number, char *name, int flags, int callwaiting, int codec);
51
52 //! Create a callerID state machine
53 /*!
54  * This function returns a malloc'd instance of the callerid_state data structure.
55  * Returns a pointer to a malloc'd callerid_state structure, or NULL on error.
56  */
57 extern struct callerid_state *callerid_new(void);
58
59 //! Read samples into the state machine.
60 /*!
61  * \param cid Which state machine to act upon
62  * \param buffer containing your samples
63  * \param samples number of samples contained within the buffer.
64  * \param codec which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW)
65  *
66  * Send received audio to the Caller*ID demodulator.
67  * Returns -1 on error, 0 for "needs more samples", 
68  * and 1 if the CallerID spill reception is complete.
69  */
70 extern int callerid_feed(struct callerid_state *cid, unsigned char *ubuf, int samples, int codec);
71
72 //! Extract info out of callerID state machine.  Flags are listed above
73 /*!
74  * \param cid Callerid state machine to act upon
75  * \param number Pass the address of a pointer-to-char (will contain the phone number)
76  * \param name Pass the address of a pointer-to-char (will contain the name)
77  * \param flags Pass the address of an int variable(will contain the various callerid flags)
78  *
79  * This function extracts a callerid string out of a callerid_state state machine.
80  * If no number is found, *number will be set to NULL.  Likewise for the name.
81  * Flags can contain any of the following:
82  * 
83  * Returns nothing.
84  */
85 void callerid_get(struct callerid_state *cid, char **number, char **name, int *flags);
86
87 //! Free a callerID state
88 /*!
89  * \param cid This is the callerid_state state machine to free
90  * This function frees callerid_state cid.
91  */
92 extern void callerid_free(struct callerid_state *cid);
93
94 //! Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format)
95 /*!
96  * \param buf buffer for output samples. See callerid_generate() for details regarding buffer.
97  * \param astcid Asterisk format callerid string, taken from the callerid field of asterisk.
98  * \param codec Asterisk codec (either AST_FORMAT_ALAW or AST_FORMAT_ULAW)
99  *
100  * Acts like callerid_generate except uses an asterisk format callerid string.
101  */
102 extern int ast_callerid_generate(unsigned char *buf, char *astcid, int codec);
103
104 //! Generate message waiting indicator 
105 extern int vmwi_generate(unsigned char *buf, int active, int mdmf, int codec);
106
107 //! Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format) but in a format suitable for Call Waiting(tm)'s Caller*ID(tm)
108 /*!
109  * See ast_callerid_generate for other details
110  */
111 extern int ast_callerid_callwaiting_generate(unsigned char *buf, char *astcid, int codec);
112
113 //! Destructively parse inbuf into name and location (or number)
114 /*!
115  * \param inbuf buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed.
116  * \param name address of a pointer-to-char for the name value of the stream.
117  * \param location address of a pointer-to-char for the phone number value of the stream.
118  * Parses callerid stream from inbuf and changes into useable form, outputed in name and location.
119  * Returns 0 on success, -1 on failure.
120  */
121 extern int ast_callerid_parse(char *instr, char **name, char **location);
122
123 //! Generate a CAS (CPE Alert Signal) tone for 'n' samples
124 /*!
125  * \param outbuf Allocated buffer for data.  Must be at least 2400 bytes unless no SAS is desired
126  * \param sas Non-zero if CAS should be preceeded by SAS
127  * \param len How many samples to generate.
128  * \param codec Which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW)
129  * Returns -1 on error (if len is less than 2400), 0 on success.
130  */
131 extern int ast_gen_cas(unsigned char *outbuf, int sas, int len, int codec);
132
133 //! Shrink a phone number in place to just digits (more accurately it just removes ()'s, .'s, and -'s...
134 /*!
135  * \param n The number to be stripped/shrunk
136  * Returns nothing important
137  */
138 extern void ast_shrink_phone_number(char *n);
139
140 //! Check if a string consists only of digits.  Returns non-zero if so
141 /*!
142  * \param n number to be checked.
143  * Returns 0 if n is a number, 1 if it's not.
144  */
145 extern int ast_isphonenumber(char *n);
146
147
148 /*
149  * Caller*ID and other GR-30 compatible generation
150  * routines (used by ADSI for example)
151  */
152
153 extern float cid_dr[4];
154 extern float cid_di[4];
155 extern float clidsb;
156
157 static inline float callerid_getcarrier(float *cr, float *ci, int bit)
158 {
159         /* Move along.  There's nothing to see here... */
160         float t;
161         t = *cr * cid_dr[bit] - *ci * cid_di[bit];
162         *ci = *cr * cid_di[bit] + *ci * cid_dr[bit];
163         *cr = t;
164         
165         t = 2.0 - (*cr * *cr + *ci * *ci);
166         *cr *= t;
167         *ci *= t;
168         return *cr;
169 }       
170
171 #define PUT_BYTE(a) do { \
172         *(buf++) = (a); \
173         bytes++; \
174 } while(0)
175
176 #define PUT_AUDIO_SAMPLE(y) do { \
177         int index = (short)(rint(8192.0 * (y))); \
178         *(buf++) = AST_LIN2X(index); \
179         bytes++; \
180 } while(0)
181         
182 #define PUT_CLID_MARKMS do { \
183         int x; \
184         for (x=0;x<8;x++) \
185                 PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, 1)); \
186 } while(0)
187
188 #define PUT_CLID_BAUD(bit) do { \
189         while(scont < clidsb) { \
190                 PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, bit)); \
191                 scont += 1.0; \
192         } \
193         scont -= clidsb; \
194 } while(0)
195
196
197 #define PUT_CLID(byte) do { \
198         int z; \
199         unsigned char b = (byte); \
200         PUT_CLID_BAUD(0);       /* Start bit */ \
201         for (z=0;z<8;z++) { \
202                 PUT_CLID_BAUD(b & 1); \
203                 b >>= 1; \
204         } \
205         PUT_CLID_BAUD(1);       /* Stop bit */ \
206 } while(0);     
207
208
209 #endif