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