callerid.h File Reference

Go to the source code of this file.

Defines
#define	MAX_CALLERID_SIZE   32000
#define	CID_PRIVATE_NAME   (1 << 0)
#define	CID_PRIVATE_NUMBER   (1 << 1)
#define	CID_UNKNOWN_NAME   (1 << 2)
#define	CID_UNKNOWN_NUMBER   (1 << 3)
#define	AST_LIN2X(a)   ((codec == AST_FORMAT_ALAW) ? (AST_LIN2A(a)) : (AST_LIN2MU(a)))
#define	AST_XLAW(a)   ((codec == AST_FORMAT_ALAW) ? (AST_ALAW(a)) : (AST_MULAW(a)))
#define	PUT_BYTE(a)
#define	PUT_AUDIO_SAMPLE(y)
#define	PUT_CLID_MARKMS
#define	PUT_CLID_BAUD(bit)
#define	PUT_CLID(byte)
Typedefs
typedef callerid_state	CIDSTATE
Functions
void	callerid_init (void)
	CallerID Initialization.
int	callerid_generate (unsigned char *buf, char *number, char *name, int flags, int callwaiting, int codec)
	Generates a CallerID FSK stream in ulaw format suitable for transmission.
callerid_state *	callerid_new (void)
	Create a callerID state machine.
int	callerid_feed (struct callerid_state *cid, unsigned char *ubuf, int samples, int codec)
	Read samples into the state machine.
void	callerid_get (struct callerid_state *cid, char **number, char **name, int *flags)
	Extract info out of callerID state machine. Flags are listed above.
void	callerid_free (struct callerid_state *cid)
	Free a callerID state.
int	ast_callerid_generate (unsigned char *buf, char *astcid, int codec)
	Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format).
int	vmwi_generate (unsigned char *buf, int active, int mdmf, int codec)
	Generate message waiting indicator.
int	ast_callerid_callwaiting_generate (unsigned char *buf, char *astcid, int codec)
	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).
int	ast_callerid_parse (char *instr, char **name, char **location)
	Destructively parse inbuf into name and location (or number).
int	ast_gen_cas (unsigned char *outbuf, int sas, int len, int codec)
	Generate a CAS (CPE Alert Signal) tone for 'n' samples.
void	ast_shrink_phone_number (char *n)
	Shrink a phone number in place to just digits (more accurately it just removes ()'s, .'s, and -'s...
int	ast_isphonenumber (char *n)
	Check if a string consists only of digits. Returns non-zero if so.
Variables
float	cid_dr [4]
float	cid_di [4]
float	clidsb

---

Define Documentation

#define AST_LIN2X (  a   )     ((codec == AST_FORMAT_ALAW) ? (AST_LIN2A(a)) : (AST_LIN2MU(a)))

Definition at line 27 of file callerid.h.

#define AST_XLAW (  a   )     ((codec == AST_FORMAT_ALAW) ? (AST_ALAW(a)) : (AST_MULAW(a)))

Definition at line 28 of file callerid.h. Referenced by callerid_feed().

#define CID_PRIVATE_NAME   (1 << 0)

Definition at line 22 of file callerid.h. Referenced by callerid_feed().

#define CID_PRIVATE_NUMBER   (1 << 1)

Definition at line 23 of file callerid.h. Referenced by callerid_feed(), and callerid_get().

#define CID_UNKNOWN_NAME   (1 << 2)

Definition at line 24 of file callerid.h. Referenced by callerid_feed(), callerid_get(), and callerid_new().

#define CID_UNKNOWN_NUMBER   (1 << 3)

Definition at line 25 of file callerid.h. Referenced by callerid_feed(), callerid_get(), and callerid_new().

#define MAX_CALLERID_SIZE   32000

Definition at line 20 of file callerid.h.

#define PUT_AUDIO_SAMPLE (  y   )

Value: do { \ int index = (short)(rint(8192.0 * (y))); \ *(buf++) = AST_LIN2X(index); \ bytes++; \ } while(0) Definition at line 176 of file callerid.h.

#define PUT_BYTE (  a   )

Value: do { \ *(buf++) = (a); \ bytes++; \ } while(0) Definition at line 171 of file callerid.h.

#define PUT_CLID (  byte   )

Definition at line 197 of file callerid.h. Referenced by callerid_generate(), and vmwi_generate().

#define PUT_CLID_BAUD (  bit   )

Definition at line 188 of file callerid.h.

#define PUT_CLID_MARKMS

Value: do { \ int x; \ for (x=0;x<8;x++) \ PUT_AUDIO_SAMPLE(callerid_getcarrier(&cr, &ci, 1)); \ } while(0) Definition at line 182 of file callerid.h. Referenced by callerid_generate(), and vmwi_generate().

---

Typedef Documentation

typedef struct callerid_state CIDSTATE

Definition at line 32 of file callerid.h.

---

Function Documentation

int ast_callerid_callwaiting_generate (  unsigned char *  buf, char *  astcid, int  codec )

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). See ast_callerid_generate for other details Definition at line 587 of file callerid.c. { return __ast_callerid_generate(buf, callerid, 1, codec); }

int ast_callerid_generate (  unsigned char *  buf, char *  astcid, int  codec )

Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format). Parameters: buf  buffer for output samples. See callerid_generate() for details regarding buffer. astcid  Asterisk format callerid string, taken from the callerid field of asterisk. codec  Asterisk codec (either AST_FORMAT_ALAW or AST_FORMAT_ULAW) Acts like callerid_generate except uses an asterisk format callerid string. Definition at line 582 of file callerid.c. { return __ast_callerid_generate(buf, callerid, 0, codec); }

int ast_callerid_parse (  char *  instr, char **  name, char **  location )

Destructively parse inbuf into name and location (or number). Parameters: inbuf  buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed. name  address of a pointer-to-char for the name value of the stream. location  address of a pointer-to-char for the phone number value of the stream. Parses callerid stream from inbuf and changes into useable form, outputed in name and location. Returns 0 on success, -1 on failure. Definition at line 516 of file callerid.c. References ast_isphonenumber(), and ast_shrink_phone_number(). Referenced by ast_cdr_init(), ast_cdr_setcid(), ast_cdr_update(), ast_privacy_check(), and ast_privacy_set(). { char *ns, *ne; char *ls, *le; char tmp[256]; /* Try for "name" <location> format or name <location> format */ if ((ls = strchr(instr, '<')) && (le = strchr(ls, '>'))) { /* Found the location */ *le = '\0'; *ls = '\0'; *location = ls + 1; if ((ns = strchr(instr, '\"')) && (ne = strchr(ns + 1, '\"'))) { /* Get name out of quotes */ *ns = '\0'; *ne = '\0'; *name = ns + 1; return 0; } else { /* Just trim off any trailing spaces */ *name = instr; while(strlen(instr) && (instr[strlen(instr) - 1] < 33)) instr[strlen(instr) - 1] = '\0'; /* And leading spaces */ while(**name && (**name < 33)) name++; return 0; } } else { strncpy(tmp, instr, sizeof(tmp)-1); ast_shrink_phone_number(tmp); if (ast_isphonenumber(tmp)) { /* Assume it's just a location */ *name = NULL; *location = instr; } else { /* Assume it's just a name. Make sure it's not quoted though */ *name = instr; while(*(*name) && ((*(*name) < 33) || (*(*name) == '\"'))) (*name)++; ne = *name + strlen(*name) - 1; while((ne > *name) && ((*ne < 33) || (*ne == '\"'))) { *ne = '\0'; ne--; } *location = NULL; } return 0; } return -1; }

int ast_gen_cas (  unsigned char *  outbuf, int  sas, int  len, int  codec )

Generate a CAS (CPE Alert Signal) tone for 'n' samples. Parameters: outbuf  Allocated buffer for data. Must be at least 2400 bytes unless no SAS is desired sas  Non-zero if CAS should be preceeded by SAS len  How many samples to generate. codec  Which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW) Returns -1 on error (if len is less than 2400), 0 on success. Definition at line 149 of file callerid.c. References casdi1, casdi2, casdr1, casdr2, sasdi, and sasdr. { int pos = 0; int saslen=2400; float cr1 = 1.0; float ci1 = 0.0; float cr2 = 1.0; float ci2 = 0.0; if (sendsas) { if (len < saslen) return -1; gen_tone(outbuf, saslen, codec, sasdr, sasdi, &cr1, &ci1); len -= saslen; pos += saslen; cr2 = cr1; ci2 = ci1; } gen_tones(outbuf + pos, len, codec, casdr1, casdi1, casdr2, casdi2, &cr1, &ci1, &cr2, &ci2); return 0; }

int ast_isphonenumber (  char *  n  )

Check if a string consists only of digits. Returns non-zero if so. Parameters: n  number to be checked. Returns 0 if n is a number, 1 if it's not. Definition at line 505 of file callerid.c. Referenced by ast_callerid_parse(). { int x; if (!n || !strlen(n)) return 0; for (x=0;n[x];x++) if (!strchr("0123456789*#", n[x])) return 0; return 1; }

void ast_shrink_phone_number (  char *  n  )

Shrink a phone number in place to just digits (more accurately it just removes ()'s, .'s, and -'s... Parameters: n  The number to be stripped/shrunk Returns nothing important Definition at line 496 of file callerid.c. Referenced by ast_callerid_parse(), ast_cdr_init(), ast_cdr_setcid(), ast_cdr_update(), ast_privacy_check(), and ast_privacy_set(). { int x,y=0; for (x=0;n[x];x++) if (!strchr("( )-.", n[x])) n[y++] = n[x]; n[y] = '\0'; }

int callerid_feed (  struct callerid_state *  cid, unsigned char *  ubuf, int  samples, int  codec )

Read samples into the state machine. Parameters: cid  Which state machine to act upon buffer  containing your samples samples  number of samples contained within the buffer. codec  which codec (AST_FORMAT_ALAW or AST_FORMAT_ULAW) Send received audio to the Caller*ID demodulator. Returns -1 on error, 0 for "needs more samples", and 1 if the CallerID spill reception is complete. Definition at line 170 of file callerid.c. References ast_log(), AST_XLAW, b, CID_PRIVATE_NAME, CID_PRIVATE_NUMBER, CID_UNKNOWN_NAME, CID_UNKNOWN_NUMBER, callerid_state::cksum, callerid_state::flags, free, fsk_serie(), callerid_state::fskd, callerid_state::len, LOG_ERROR, LOG_NOTICE, LOG_WARNING, malloc, callerid_state::name, callerid_state::number, callerid_state::oldlen, callerid_state::oldstuff, callerid_state::pos, callerid_state::rawdata, callerid_state::sawflag, and callerid_state::type. { int mylen = len; int olen; int b = 'X'; int res; int x; short *buf = malloc(2 * len + cid->oldlen); short *obuf = buf; if (!buf) { ast_log(LOG_WARNING, "Out of memory\n"); return -1; } memset(buf, 0, 2 * len + cid->oldlen); memcpy(buf, cid->oldstuff, cid->oldlen); mylen += cid->oldlen/2; for (x=0;x<len;x++) buf[x+cid->oldlen/2] = AST_XLAW(ubuf[x]); while(mylen >= 80) { olen = mylen; res = fsk_serie(&cid->fskd, buf, &mylen, &b); if (mylen < 0) { ast_log(LOG_ERROR, "fsk_serie made mylen < 0 (%d)\n", mylen); return -1; } buf += (olen - mylen); if (res < 0) { ast_log(LOG_NOTICE, "fsk_serie failed\n"); return -1; } if (res == 1) { /* Ignore invalid bytes */ if (b > 0xff) continue; switch(cid->sawflag) { case 0: /* Look for flag */ if (b == 'U') cid->sawflag = 2; break; case 2: /* Get lead-in */ if ((b == 0x04) || (b == 0x80)) { cid->type = b; cid->sawflag = 3; cid->cksum = b; } break; case 3: /* Get length */ /* Not a lead in. We're ready */ cid->sawflag = 4; cid->len = b; cid->pos = 0; cid->cksum += b; break; case 4: /* Retrieve message */ if (cid->pos >= 128) { ast_log(LOG_WARNING, "Caller ID too long???\n"); return -1; } cid->rawdata[cid->pos++] = b; cid->len--; cid->cksum += b; if (!cid->len) { cid->rawdata[cid->pos] = '\0'; cid->sawflag = 5; } break; case 5: /* Check checksum */ if (b != (256 - (cid->cksum & 0xff))) { ast_log(LOG_NOTICE, "Caller*ID failed checksum\n"); /* Try again */ cid->sawflag = 0; break; } strcpy(cid->number, ""); strcpy(cid->name, ""); /* If we get this far we're fine. */ if (cid->type == 0x80) { /* MDMF */ /* Go through each element and process */ for (x=0;x< cid->pos;) { switch(cid->rawdata[x++]) { case 1: /* Date */ break; case 2: /* Number */ case 3: /* Number (for Zebble) */ case 4: /* Number */ res = cid->rawdata[x]; if (res > 32) { ast_log(LOG_NOTICE, "Truncating long caller ID number from %d bytes to 32\n", cid->rawdata[x]); res = 32; } memcpy(cid->number, cid->rawdata + x + 1, res); /* Null terminate */ cid->number[res] = '\0'; break; case 7: /* Name */ case 8: /* Name */ res = cid->rawdata[x]; if (res > 32) { ast_log(LOG_NOTICE, "Truncating long caller ID name from %d bytes to 32\n", cid->rawdata[x]); res = 32; } memcpy(cid->name, cid->rawdata + x + 1, res); cid->name[res] = '\0'; break; case 22: /* Something French */ break; default: ast_log(LOG_NOTICE, "Unknown IE %d\n", cid->rawdata[x-1]); } x += cid->rawdata[x]; x++; } } else { /* SDMF */ strncpy(cid->number, cid->rawdata + 8, sizeof(cid->number)-1); } /* Update flags */ cid->flags = 0; if (!strcmp(cid->number, "P")) { strcpy(cid->number, ""); cid->flags |= CID_PRIVATE_NUMBER; } else if (!strcmp(cid->number, "O") || !strlen(cid->number)) { strcpy(cid->number, ""); cid->flags |= CID_UNKNOWN_NUMBER; } if (!strcmp(cid->name, "P")) { strcpy(cid->name, ""); cid->flags |= CID_PRIVATE_NAME; } else if (!strcmp(cid->name, "O") || !strlen(cid->name)) { strcpy(cid->name, ""); cid->flags |= CID_UNKNOWN_NAME; } return 1; break; default: ast_log(LOG_ERROR, "Dunno what to do with a digit in sawflag %d\n", cid->sawflag); } } } if (mylen) { memcpy(cid->oldstuff, buf, mylen * 2); cid->oldlen = mylen * 2; } else cid->oldlen = 0; free(obuf); return 0; }

void callerid_free (  struct callerid_state *  cid  )

Free a callerID state. Parameters: cid  This is the callerid_state state machine to free This function frees callerid_state cid. Definition at line 321 of file callerid.c. References free. { free(cid); }

int callerid_generate (  unsigned char *  buf, char *  number, char *  name, int  flags, int  callwaiting, int  codec )

Generates a CallerID FSK stream in ulaw format suitable for transmission. Parameters: 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. number  Use NULL for no number or "P" for "private" name  name to be used callwaiting  callwaiting flag codec  -- either AST_FORMAT_ULAW or AST_FORMAT_ALAW This function creates a stream of callerid (a callerid spill) data in ulaw format. It returns the size (in bytes) of the data (if it returns a size of 0, there is probably an error) Definition at line 454 of file callerid.c. References PUT_BYTE, PUT_CLID, and PUT_CLID_MARKMS. { int bytes=0; int x, sum; int len; /* Initial carriers (real/imaginary) */ float cr = 1.0; float ci = 0.0; float scont = 0.0; unsigned char msg[256]; len = callerid_genmsg(msg, sizeof(msg), number, name, flags); if (!callwaiting) { /* Wait a half a second */ for (x=0;x<4000;x++) PUT_BYTE(0x7f); /* Transmit 30 0x55's (looks like a square wave) for channel seizure */ for (x=0;x<30;x++) PUT_CLID(0x55); } /* Send 150ms of callerid marks */ for (x=0;x<150;x++) PUT_CLID_MARKMS; /* Send 0x80 indicating MDMF format */ PUT_CLID(0x80); /* Put length of whole message */ PUT_CLID(len); sum = 0x80 + strlen(msg); /* Put each character of message and update checksum */ for (x=0;x<len; x++) { PUT_CLID(msg[x]); sum += msg[x]; } /* Send 2's compliment of sum */ PUT_CLID(256 - (sum & 255)); /* Send 50 more ms of marks */ for (x=0;x<50;x++) PUT_CLID_MARKMS; return bytes; }

void callerid_get (  struct callerid_state *  cid, char **  number, char **  name, int *  flags )

Extract info out of callerID state machine. Flags are listed above. Parameters: cid  Callerid state machine to act upon number  Pass the address of a pointer-to-char (will contain the phone number) name  Pass the address of a pointer-to-char (will contain the name) flags  Pass the address of an int variable(will contain the various callerid flags) This function extracts a callerid string out of a callerid_state state machine. If no number is found, *number will be set to NULL. Likewise for the name. Flags can contain any of the following: Returns nothing. Definition at line 136 of file callerid.c. References CID_PRIVATE_NUMBER, CID_UNKNOWN_NAME, CID_UNKNOWN_NUMBER, callerid_state::flags, callerid_state::name, and callerid_state::number. { *flags = cid->flags; if (cid->flags & (CID_UNKNOWN_NAME | CID_PRIVATE_NUMBER)) *name = NULL; else *name = cid->name; if (cid->flags & (CID_UNKNOWN_NUMBER | CID_PRIVATE_NUMBER)) *number = NULL; else *number = cid->number; }

void callerid_init (  void   )

CallerID Initialization. Initializes the callerid system. Mostly stuff for inverse FFT Definition at line 94 of file callerid.c. References CALLERID_MARK, CALLERID_SPACE, CAS_FREQ1, CAS_FREQ2, casdi1, casdi2, casdr1, casdr2, cid_di, cid_dr, SAS_FREQ, sasdi, and sasdr. Referenced by main(). { /* Initialize stuff for inverse FFT */ cid_dr[0] = cos(CALLERID_SPACE * 2.0 * M_PI / 8000.0); cid_di[0] = sin(CALLERID_SPACE * 2.0 * M_PI / 8000.0); cid_dr[1] = cos(CALLERID_MARK * 2.0 * M_PI / 8000.0); cid_di[1] = sin(CALLERID_MARK * 2.0 * M_PI / 8000.0); sasdr = cos(SAS_FREQ * 2.0 * M_PI / 8000.0); sasdi = sin(SAS_FREQ * 2.0 * M_PI / 8000.0); casdr1 = cos(CAS_FREQ1 * 2.0 * M_PI / 8000.0); casdi1 = sin(CAS_FREQ1 * 2.0 * M_PI / 8000.0); casdr2 = cos(CAS_FREQ2 * 2.0 * M_PI / 8000.0); casdi2 = sin(CAS_FREQ2 * 2.0 * M_PI / 8000.0); }

struct callerid_state* callerid_new (  void   )

Create a callerID state machine. This function returns a malloc'd instance of the callerid_state data structure. Returns a pointer to a malloc'd callerid_state structure, or NULL on error. Definition at line 109 of file callerid.c. References ast_log(), CID_UNKNOWN_NAME, CID_UNKNOWN_NUMBER, LOG_WARNING, and malloc. { struct callerid_state *cid; cid = malloc(sizeof(struct callerid_state)); memset(cid, 0, sizeof(struct callerid_state)); if (cid) { cid->fskd.spb = 7; /* 1200 baud */ cid->fskd.hdlc = 0; /* Async */ cid->fskd.nbit = 8; /* 8 bits */ cid->fskd.nstop = 1; /* 1 stop bit */ cid->fskd.paridad = 0; /* No parity */ cid->fskd.bw=1; /* Filter 800 Hz */ cid->fskd.f_mark_idx = 2; /* 1200 Hz */ cid->fskd.f_space_idx = 3; /* 2200 Hz */ cid->fskd.pcola = 0; /* No clue */ cid->fskd.cont = 0; /* Digital PLL reset */ cid->fskd.x0 = 0.0; cid->fskd.state = 0; memset(cid->name, 0, sizeof(cid->name)); memset(cid->number, 0, sizeof(cid->number)); cid->flags = CID_UNKNOWN_NAME | CID_UNKNOWN_NUMBER; cid->pos = 0; } else ast_log(LOG_WARNING, "Out of memory\n"); return cid; }

int vmwi_generate (  unsigned char *  buf, int  active, int  mdmf, int  codec )

Generate message waiting indicator. Definition at line 395 of file callerid.c. References PUT_CLID, and PUT_CLID_MARKMS. { unsigned char msg[256]; int len=0; int sum; int x; int bytes = 0; float cr = 1.0; float ci = 0.0; float scont = 0.0; if (mdmf) { /* MDMF Message waiting */ msg[len++] = 0x82; /* Length is 3 */ msg[len++] = 3; /* IE is "Message Waiting Parameter" */ msg[len++] = 0xb; /* Length of IE is one */ msg[len++] = 1; /* Active or not */ if (active) msg[len++] = 0xff; else msg[len++] = 0x00; } else { /* SDMF Message waiting */ msg[len++] = 0x6; /* Length is 3 */ msg[len++] = 3; if (active) { msg[len++] = 0x42; msg[len++] = 0x42; msg[len++] = 0x42; } else { msg[len++] = 0x6f; msg[len++] = 0x6f; msg[len++] = 0x6f; } } sum = 0; for (x=0;x<len;x++) sum += msg[x]; sum = (256 - (sum & 255)); msg[len++] = sum; /* Transmit 30 0x55's (looks like a square wave) for channel seizure */ for (x=0;x<30;x++) PUT_CLID(0x55); /* Send 170ms of callerid marks */ for (x=0;x<170;x++) PUT_CLID_MARKMS; for (x=0;x<len;x++) { PUT_CLID(msg[x]); } /* Send 50 more ms of marks */ for (x=0;x<50;x++) PUT_CLID_MARKMS; return bytes; }

---

Variable Documentation

float cid_di[4]

Definition at line 154 of file callerid.h. Referenced by callerid_init().

float cid_dr[4]

Definition at line 153 of file callerid.h. Referenced by callerid_init().

float clidsb

Definition at line 155 of file callerid.h.

---