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