00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * 00008 * See http://www.asterisk.org for more information about 00009 * the Asterisk project. Please do not directly contact 00010 * any of the maintainers of this project for assistance; 00011 * the project provides a web site, mailing lists and IRC 00012 * channels for your use. 00013 * 00014 * This program is free software, distributed under the terms of 00015 * the GNU General Public License Version 2. See the LICENSE file 00016 * at the top of the source tree. 00017 */ 00018 00019 /*! \file 00020 * \brief CallerID (and other GR30) management and generation 00021 * Includes code and algorithms from the Zapata library. 00022 * 00023 * \ref CID 00024 * 00025 */ 00026 00027 /*! 00028 * \page CID Caller ID names and numbers 00029 * 00030 * Caller ID names are currently 8 bit characters, propably 00031 * ISO8859-1, depending on what your channel drivers handle. 00032 * 00033 * IAX2 and SIP caller ID names are UTF8 00034 * On ISDN Caller ID names are 7 bit, Almost ASCII 00035 * (See http://www.zytrax.com/tech/ia5.html ) 00036 * 00037 * \note Asterisk does not currently support SIP utf8 caller ID names or caller ID's. 00038 * 00039 * \par See also 00040 * \arg \ref callerid.c 00041 * \arg \ref callerid.h 00042 * \arg \ref Def_CallerPres 00043 */ 00044 00045 #ifndef _ASTERISK_CALLERID_H 00046 #define _ASTERISK_CALLERID_H 00047 00048 #define MAX_CALLERID_SIZE 32000 00049 00050 #define CID_PRIVATE_NAME (1 << 0) 00051 #define CID_PRIVATE_NUMBER (1 << 1) 00052 #define CID_UNKNOWN_NAME (1 << 2) 00053 #define CID_UNKNOWN_NUMBER (1 << 3) 00054 #define CID_MSGWAITING (1 << 4) 00055 #define CID_NOMSGWAITING (1 << 5) 00056 00057 #define CID_SIG_BELL 1 00058 #define CID_SIG_V23 2 00059 #define CID_SIG_DTMF 3 00060 #define CID_SIG_V23_JP 4 00061 #define CID_SIG_SMDI 5 00062 00063 #define CID_START_RING 1 00064 #define CID_START_POLARITY 2 00065 #define CID_START_POLARITY_IN 3 00066 00067 00068 #define AST_LIN2X(a) ((codec == AST_FORMAT_ALAW) ? (AST_LIN2A(a)) : (AST_LIN2MU(a))) 00069 #define AST_XLAW(a) ((codec == AST_FORMAT_ALAW) ? (AST_ALAW(a)) : (AST_MULAW(a))) 00070 00071 00072 struct callerid_state; 00073 typedef struct callerid_state CIDSTATE; 00074 00075 /*! \brief CallerID Initialization 00076 * \par 00077 * Initializes the callerid system. Mostly stuff for inverse FFT 00078 */ 00079 void callerid_init(void); 00080 00081 /*! \brief Generates a CallerID FSK stream in ulaw format suitable for transmission. 00082 * \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. 00083 * \param number Use NULL for no number or "P" for "private" 00084 * \param name name to be used 00085 * \param flags passed flags 00086 * \param callwaiting callwaiting flag 00087 * \param codec -- either AST_FORMAT_ULAW or AST_FORMAT_ALAW 00088 * This function creates a stream of callerid (a callerid spill) data in ulaw format. 00089 * \return It returns the size 00090 * (in bytes) of the data (if it returns a size of 0, there is probably an error) 00091 */ 00092 int callerid_generate(unsigned char *buf, const char *number, const char *name, int flags, int callwaiting, int codec); 00093 00094 /*! \brief Create a callerID state machine 00095 * \param cid_signalling Type of signalling in use 00096 * 00097 * This function returns a malloc'd instance of the callerid_state data structure. 00098 * \return Returns a pointer to a malloc'd callerid_state structure, or NULL on error. 00099 */ 00100 struct callerid_state *callerid_new(int cid_signalling); 00101 00102 /*! \brief Read samples into the state machine. 00103 * \param cid Which state machine to act upon 00104 * \param ubuf containing your samples 00105 * \param samples number of samples contained within the buffer. 00106 * \param codec which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW) 00107 * 00108 * Send received audio to the Caller*ID demodulator. 00109 * \return Returns -1 on error, 0 for "needs more samples", 00110 * and 1 if the CallerID spill reception is complete. 00111 */ 00112 int callerid_feed(struct callerid_state *cid, unsigned char *ubuf, int samples, int codec); 00113 00114 /*! \brief Read samples into the state machine. 00115 * \param cid Which state machine to act upon 00116 * \param ubuf containing your samples 00117 * \param samples number of samples contained within the buffer. 00118 * \param codec which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW) 00119 * 00120 * Send received audio to the Caller*ID demodulator (for japanese style lines). 00121 * \return Returns -1 on error, 0 for "needs more samples", 00122 * and 1 if the CallerID spill reception is complete. 00123 */ 00124 int callerid_feed_jp(struct callerid_state *cid, unsigned char *ubuf, int samples, int codec); 00125 00126 /*! \brief Extract info out of callerID state machine. Flags are listed above 00127 * \param cid Callerid state machine to act upon 00128 * \param number Pass the address of a pointer-to-char (will contain the phone number) 00129 * \param name Pass the address of a pointer-to-char (will contain the name) 00130 * \param flags Pass the address of an int variable(will contain the various callerid flags) 00131 * 00132 * This function extracts a callerid string out of a callerid_state state machine. 00133 * If no number is found, *number will be set to NULL. Likewise for the name. 00134 * Flags can contain any of the following: 00135 * 00136 * \return Returns nothing. 00137 */ 00138 void callerid_get(struct callerid_state *cid, char **number, char **name, int *flags); 00139 00140 /*! Get and parse DTMF-based callerid */ 00141 /*! 00142 * \param cidstring The actual transmitted string. 00143 * \param number The cid number is returned here. 00144 * \param flags The cid flags are returned here. 00145 * This function parses DTMF callerid. 00146 */ 00147 void callerid_get_dtmf(char *cidstring, char *number, int *flags); 00148 00149 /*! \brief Free a callerID state 00150 * \param cid This is the callerid_state state machine to free 00151 * This function frees callerid_state cid. 00152 */ 00153 void callerid_free(struct callerid_state *cid); 00154 00155 /*! \brief Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format) 00156 * \param buf buffer for output samples. See callerid_generate() for details regarding buffer. 00157 * \param name Caller-ID Name 00158 * \param number Caller-ID Number 00159 * \param codec Asterisk codec (either AST_FORMAT_ALAW or AST_FORMAT_ULAW) 00160 * 00161 * Acts like callerid_generate except uses an asterisk format callerid string. 00162 */ 00163 int ast_callerid_generate(unsigned char *buf, const char *name, const char *number, int codec); 00164 00165 /*! \brief Generate message waiting indicator (stutter tone) */ 00166 int vmwi_generate(unsigned char *buf, int active, int mdmf, int codec); 00167 00168 /*! \brief Generate Caller-ID spill but in a format suitable for Call Waiting(tm)'s Caller*ID(tm) 00169 * See ast_callerid_generate() for other details 00170 */ 00171 int ast_callerid_callwaiting_generate(unsigned char *buf, const char *name, const char *number, int codec); 00172 00173 /*! \brief Destructively parse inbuf into name and location (or number) 00174 * Parses callerid stream from inbuf and changes into useable form, outputed in name and location. 00175 * \param instr buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed. 00176 * \param name address of a pointer-to-char for the name value of the stream. 00177 * \param location address of a pointer-to-char for the phone number value of the stream. 00178 * \return Returns 0 on success, -1 on failure. 00179 */ 00180 int ast_callerid_parse(char *instr, char **name, char **location); 00181 00182 /*! Generate a CAS (CPE Alert Signal) tone for 'n' samples */ 00183 /*! 00184 * \param outbuf Allocated buffer for data. Must be at least 2400 bytes unless no SAS is desired 00185 * \param sas Non-zero if CAS should be preceeded by SAS 00186 * \param len How many samples to generate. 00187 * \param codec Which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW) 00188 * \return Returns -1 on error (if len is less than 2400), 0 on success. 00189 */ 00190 int ast_gen_cas(unsigned char *outbuf, int sas, int len, int codec); 00191 00192 /*! \brief Shrink a phone number in place to just digits (more accurately it just removes ()'s, .'s, and -'s... */ 00193 /*! 00194 * \param n The number to be stripped/shrunk 00195 * \return Returns nothing important 00196 */ 00197 void ast_shrink_phone_number(char *n); 00198 00199 /*! \brief Check if a string consists only of digits and + \# 00200 \param n number to be checked. 00201 \return Returns 0 if n is a number, 1 if it's not. 00202 */ 00203 int ast_isphonenumber(const char *n); 00204 00205 /*! \brief Check if a string consists only of digits and and + \# ( ) - . 00206 (meaning it can be cleaned with ast_shrink_phone_number) 00207 \param exten The extension (or URI) to be checked. 00208 \return Returns 0 if n is a number, 1 if it's not. 00209 */ 00210 int ast_is_shrinkable_phonenumber(const char *exten); 00211 00212 int ast_callerid_split(const char *src, char *name, int namelen, char *num, int numlen); 00213 00214 char *ast_callerid_merge(char *buf, int bufsiz, const char *name, const char *num, const char *unknown); 00215 00216 /* 00217 * Caller*ID and other GR-30 compatible generation 00218 * routines (used by ADSI for example) 00219 */ 00220 00221 extern float cid_dr[4]; 00222 extern float cid_di[4]; 00223 extern float clidsb; 00224 00225 static inline float callerid_getcarrier(float *cr, float *ci, int bit) 00226 { 00227 /* Move along. There's nothing to see here... */ 00228 float t; 00229 t = *cr * cid_dr[bit] - *ci * cid_di[bit]; 00230 *ci = *cr * cid_di[bit] + *ci * cid_dr[bit]; 00231 *cr = t; 00232 00233 t = 2.0 - (*cr * *cr + *ci * *ci); 00234 *cr *= t; 00235 *ci *= t; 00236 return *cr; 00237 } 00238 00239 #define PUT_BYTE(a) do { \ 00240 *(buf++) = (a); \ 00241 bytes++; \ 00242 } while(0) 00243 00244 #define PUT_AUDIO_SAMPLE(y) do { \ 00245 int index = (short)(rint(8192.0 * (y))); \ 00246 *(buf++) = AST_LIN2X(index); \ 00247 bytes++; \ 00248 } while(0) 00249 00250 #define PUT_CLID_MARKMS do { \ 00251 int x; \ 00252 for (x=0;x<8;x++) \ 00253 PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, 1)); \ 00254 } while(0) 00255 00256 #define PUT_CLID_BAUD(bit) do { \ 00257 while(scont < clidsb) { \ 00258 PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, bit)); \ 00259 scont += 1.0; \ 00260 } \ 00261 scont -= clidsb; \ 00262 } while(0) 00263 00264 00265 #define PUT_CLID(byte) do { \ 00266 int z; \ 00267 unsigned char b = (byte); \ 00268 PUT_CLID_BAUD(0); /* Start bit */ \ 00269 for (z=0;z<8;z++) { \ 00270 PUT_CLID_BAUD(b & 1); \ 00271 b >>= 1; \ 00272 } \ 00273 PUT_CLID_BAUD(1); /* Stop bit */ \ 00274 } while(0) 00275 00276 /* Various defines and bits for handling PRI- and SS7-type restriction */ 00277 00278 #define AST_PRES_NUMBER_TYPE 0x03 00279 #define AST_PRES_USER_NUMBER_UNSCREENED 0x00 00280 #define AST_PRES_USER_NUMBER_PASSED_SCREEN 0x01 00281 #define AST_PRES_USER_NUMBER_FAILED_SCREEN 0x02 00282 #define AST_PRES_NETWORK_NUMBER 0x03 00283 00284 #define AST_PRES_RESTRICTION 0x60 00285 #define AST_PRES_ALLOWED 0x00 00286 #define AST_PRES_RESTRICTED 0x20 00287 #define AST_PRES_UNAVAILABLE 0x40 00288 #define AST_PRES_RESERVED 0x60 00289 00290 #define AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED \ 00291 AST_PRES_USER_NUMBER_UNSCREENED + AST_PRES_ALLOWED 00292 00293 #define AST_PRES_ALLOWED_USER_NUMBER_PASSED_SCREEN \ 00294 AST_PRES_USER_NUMBER_PASSED_SCREEN + AST_PRES_ALLOWED 00295 00296 #define AST_PRES_ALLOWED_USER_NUMBER_FAILED_SCREEN \ 00297 AST_PRES_USER_NUMBER_FAILED_SCREEN + AST_PRES_ALLOWED 00298 00299 #define AST_PRES_ALLOWED_NETWORK_NUMBER \ 00300 AST_PRES_NETWORK_NUMBER + AST_PRES_ALLOWED 00301 00302 #define AST_PRES_PROHIB_USER_NUMBER_NOT_SCREENED \ 00303 AST_PRES_USER_NUMBER_UNSCREENED + AST_PRES_RESTRICTED 00304 00305 #define AST_PRES_PROHIB_USER_NUMBER_PASSED_SCREEN \ 00306 AST_PRES_USER_NUMBER_PASSED_SCREEN + AST_PRES_RESTRICTED 00307 00308 #define AST_PRES_PROHIB_USER_NUMBER_FAILED_SCREEN \ 00309 AST_PRES_USER_NUMBER_FAILED_SCREEN + AST_PRES_RESTRICTED 00310 00311 #define AST_PRES_PROHIB_NETWORK_NUMBER \ 00312 AST_PRES_NETWORK_NUMBER + AST_PRES_RESTRICTED 00313 00314 #define AST_PRES_NUMBER_NOT_AVAILABLE \ 00315 AST_PRES_NETWORK_NUMBER + AST_PRES_UNAVAILABLE 00316 00317 int ast_parse_caller_presentation(const char *data); 00318 const char *ast_describe_caller_presentation(int data); 00319 const char *ast_named_caller_presentation(int data); 00320 00321 /*! \page Def_CallerPres Caller ID Presentation 00322 00323 Caller ID presentation values are used to set properties to a 00324 caller ID in PSTN networks, and as RPID value in SIP transactions. 00325 00326 The following values are available to use: 00327 \arg \b Defined value, text string in config file, explanation 00328 00329 \arg \b AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED, "allowed_not_screened", Presentation Allowed, Not Screened, 00330 \arg \b AST_PRES_ALLOWED_USER_NUMBER_PASSED_SCREEN, "allowed_passed_screen", Presentation Allowed, Passed Screen, 00331 \arg \b AST_PRES_ALLOWED_USER_NUMBER_FAILED_SCREEN, "allowed_failed_screen", Presentation Allowed, Failed Screen, 00332 \arg \b AST_PRES_ALLOWED_NETWORK_NUMBER, "allowed", Presentation Allowed, Network Number, 00333 \arg \b AST_PRES_PROHIB_USER_NUMBER_NOT_SCREENED, "prohib_not_screened", Presentation Prohibited, Not Screened, 00334 \arg \b AST_PRES_PROHIB_USER_NUMBER_PASSED_SCREEN, "prohib_passed_screen", Presentation Prohibited, Passed Screen, 00335 \arg \b AST_PRES_PROHIB_USER_NUMBER_FAILED_SCREEN, "prohib_failed_screen", Presentation Prohibited, Failed Screen, 00336 \arg \b AST_PRES_PROHIB_NETWORK_NUMBER, "prohib", Presentation Prohibited, Network Number, 00337 00338 \par References 00339 \arg \ref callerid.h Definitions 00340 \arg \ref callerid.c Functions 00341 \arg \ref CID Caller ID names and numbers 00342 */ 00343 00344 00345 #endif /* _ASTERISK_CALLERID_H */