Main Page | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

adsi.h File Reference

Go to the source code of this file.

Defines

#define _SPANDSP_ADSI_H_
#define MCLASS_VISUAL_INDICATOR   0x0B
#define JCLIP_MDMF_CALLERID   0x40
#define CLIP_DTMF_HASH_TERMINATED   '#'
#define CLIP_DTMF_C_TERMINATED   'C'
#define CLIP_DTMF_HASH_CALLER_NUMBER   'A'
#define CLIP_DTMF_HASH_ABSENCE   'D'
#define CLIP_DTMF_HASH_UNSPECIFIED   0
#define CLIP_DTMF_C_CALLER_NUMBER   'A'
#define CLIP_DTMF_C_REDIRECT_NUMBER   'D'
#define CLIP_DTMF_C_ABSENCE   'B'

Typedefs

typedef adsi_tx_state_s adsi_tx_state_t
typedef adsi_rx_state_s adsi_rx_state_t

Enumerations

enum  {
  ADSI_STANDARD_NONE = 0, ADSI_STANDARD_CLASS = 1, ADSI_STANDARD_CLIP = 2, ADSI_STANDARD_ACLIP = 3,
  ADSI_STANDARD_JCLIP = 4, ADSI_STANDARD_CLIP_DTMF = 5, ADSI_STANDARD_TDD = 6
}
enum  { CLASS_SDMF_CALLERID = 0x04, CLASS_MDMF_CALLERID = 0x80, CLASS_SDMF_MSG_WAITING = 0x06, CLASS_MDMF_MSG_WAITING = 0x82 }
enum  {
  MCLASS_DATETIME = 0x01, MCLASS_CALLER_NUMBER = 0x02, MCLASS_DIALED_NUMBER = 0x03, MCLASS_ABSENCE1 = 0x04,
  MCLASS_REDIRECT = 0x05, MCLASS_QUALIFIER = 0x06, MCLASS_CALLER_NAME = 0x07, MCLASS_ABSENCE2 = 0x08,
  MCLASS_ALT_ROUTE = 0x09
}
enum  { CLIP_MDMF_CALLERID = 0x80, CLIP_MDMF_MSG_WAITING = 0x82, CLIP_MDMF_CHARGE_INFO = 0x86, CLIP_MDMF_SMS = 0x89 }
enum  {
  CLIP_DATETIME = 0x01, CLIP_CALLER_NUMBER = 0x02, CLIP_DIALED_NUMBER = 0x03, CLIP_ABSENCE1 = 0x04,
  CLIP_CALLER_NAME = 0x07, CLIP_ABSENCE2 = 0x08, CLIP_VISUAL_INDICATOR = 0x0B, CLIP_MESSAGE_ID = 0x0D,
  CLIP_COMPLEMENTARY_CALLER_NUMBER = 0x10, CLIP_CALLTYPE = 0x11, CLIP_NUM_MSG = 0x13, CLIP_TYPE_OF_FORWARDED_CALL = 0x15,
  CLIP_TYPE_OF_CALLING_USER = 0x16, CLIP_REDIR_NUMBER = 0x1A, CLIP_CHARGE = 0x20, CLIP_DURATION = 0x23,
  CLIP_ADD_CHARGE = 0x21, CLIP_DISPLAY_INFO = 0x50, CLIP_SERVICE_INFO = 0x55
}
enum  { ACLIP_SDMF_CALLERID = 0x04, ACLIP_MDMF_CALLERID = 0x80 }
enum  {
  ACLIP_DATETIME = 0x01, ACLIP_CALLER_NUMBER = 0x02, ACLIP_DIALED_NUMBER = 0x03, ACLIP_NUMBER_ABSENCE = 0x04,
  ACLIP_REDIRECT = 0x05, ACLIP_QUALIFIER = 0x06, ACLIP_CALLER_NAME = 0x07, ACLIP_NAME_ABSENCE = 0x08
}
enum  {
  JCLIP_CALLER_NUMBER = 0x02, JCLIP_CALLER_NUM_DES = 0x21, JCLIP_DIALED_NUMBER = 0x09, JCLIP_DIALED_NUM_DES = 0x22,
  JCLIP_ABSENCE = 0x04
}

Functions

 SPAN_DECLARE (adsi_rx_state_t *) adsi_rx_init(adsi_rx_state_t *s
 Initialise an ADSI receive context.
 SPAN_DECLARE (int) adsi_rx_release(adsi_rx_state_t *s)
 Receive a chunk of ADSI audio.
 SPAN_DECLARE (adsi_tx_state_t *) adsi_tx_init(adsi_tx_state_t *s
 Initialise an ADSI transmit context.
 SPAN_DECLARE (void) adsi_tx_set_preamble(adsi_tx_state_t *s
 Cleanup a T.30 context if the call terminates.
 SPAN_DECLARE (const char *) adsi_standard_to_str(int standard)
 Return a short name for an ADSI standard.

Variables

int standard
int put_msg_func_t put_msg
int put_msg_func_t void * user_data
const int16_t * amp
const int16_t int len
int preamble_len
int int preamble_ones_len
int int int postamble_ones_len
int int int int stop_bits
int16_t int max_len
const uint8_t * msg
const uint8_t int msg_len
const uint8_t int int pos
const uint8_t int int uint8_t * field_type
const uint8_t int int uint8_t
uint8_t const ** 
field_body
const uint8_t int int uint8_t
uint8_t const int * 
field_len


Detailed Description


Define Documentation

#define CLIP_DTMF_C_ABSENCE   'B'
 

Caller number absent: private/restricted (00) or not available (10)

#define CLIP_DTMF_C_CALLER_NUMBER   'A'
 

Caller number

#define CLIP_DTMF_C_REDIRECT_NUMBER   'D'
 

Diverting number

#define CLIP_DTMF_HASH_ABSENCE   'D'
 

Caller number absent: private (1), overseas (2) or not available (3)

#define CLIP_DTMF_HASH_CALLER_NUMBER   'A'
 

Caller number

#define CLIP_DTMF_HASH_TERMINATED   '#'
 

Definitions for CLIP-DTMF and its variants

#define CLIP_DTMF_HASH_UNSPECIFIED   0
 

Caller ID field with no explicit field type

#define JCLIP_MDMF_CALLERID   0x40
 

Multiple data message caller ID frame

#define MCLASS_VISUAL_INDICATOR   0x0B
 

Message waiting/not waiting


Typedef Documentation

typedef struct adsi_rx_state_s adsi_rx_state_t
 

ADSI receiver descriptor. This contains all the state information for an ADSI (caller ID, CLASS, CLIP, ACLIP, JCLIP) receive channel.

typedef struct adsi_tx_state_s adsi_tx_state_t
 

ADSI transmitter descriptor. This contains all the state information for an ADSI (caller ID, CLASS, CLIP, ACLIP) transmit channel.


Enumeration Type Documentation

anonymous enum
 

Definitions for CLASS (Custom Local Area Signaling Services)

Enumeration values:
CLASS_SDMF_CALLERID  Single data message caller ID
CLASS_MDMF_CALLERID  Multiple data message caller ID
CLASS_SDMF_MSG_WAITING  Single data message message waiting
CLASS_MDMF_MSG_WAITING  Multiple data message message waiting

anonymous enum
 

CLASS MDMF message IDs

Enumeration values:
MCLASS_DATETIME  Date and time (MMDDHHMM)
MCLASS_CALLER_NUMBER  Caller number
MCLASS_DIALED_NUMBER  Dialed number
MCLASS_ABSENCE1  Caller number absent: 'O' or 'P'
MCLASS_REDIRECT  Call forward: universal ('0'), on busy ('1'), or on unanswered ('2')
MCLASS_QUALIFIER  Long distance: 'L'
MCLASS_CALLER_NAME  Caller's name
MCLASS_ABSENCE2  Caller's name absent: 'O' or 'P'
MCLASS_ALT_ROUTE  Alternate route

anonymous enum
 

Definitions for CLIP (Calling Line Identity Presentation) (from ETS 300 659-1)

Enumeration values:
CLIP_MDMF_CALLERID  Multiple data message caller ID
CLIP_MDMF_MSG_WAITING  Multiple data message message waiting
CLIP_MDMF_CHARGE_INFO  Multiple data message charge information
CLIP_MDMF_SMS  Multiple data message SMS

anonymous enum
 

CLIP message IDs (from ETS 300 659-1)

Enumeration values:
CLIP_DATETIME  Date and time (MMDDHHMM)
CLIP_CALLER_NUMBER  Caller number (AKA calling line identity)
CLIP_DIALED_NUMBER  Dialed number (AKA called line identity)
CLIP_ABSENCE1  Caller number absent: 'O' or 'P' (AKA reason for absence of calling line identity)
CLIP_CALLER_NAME  Caller's name (AKA calling party name)
CLIP_ABSENCE2  Caller's name absent: 'O' or 'P' (AKA reason for absence of calling party name)
CLIP_VISUAL_INDICATOR  Visual indicator
CLIP_MESSAGE_ID  Message ID
CLIP_COMPLEMENTARY_CALLER_NUMBER  Complementary calling line identity
CLIP_CALLTYPE  Call type - voice call (1), ring-back-when-free call (2), calling name delivery (3) or msg waiting call(0x81)
CLIP_NUM_MSG  Number of messages
CLIP_TYPE_OF_FORWARDED_CALL  Type of forwarded call
CLIP_TYPE_OF_CALLING_USER  Type of calling user
CLIP_REDIR_NUMBER  Redirecting number
CLIP_CHARGE  Charge
CLIP_DURATION  Duration of the call
CLIP_ADD_CHARGE  Additional charge
CLIP_DISPLAY_INFO  Display information
CLIP_SERVICE_INFO  Service information

anonymous enum
 

Definitions for A-CLIP (Analog Calling Line Identity Presentation)

Enumeration values:
ACLIP_SDMF_CALLERID  Single data message caller ID frame
ACLIP_MDMF_CALLERID  Multiple data message caller ID frame

anonymous enum
 

A-CLIP MDM message IDs

Enumeration values:
ACLIP_DATETIME  Date and time (MMDDHHMM)
ACLIP_CALLER_NUMBER  Caller number
ACLIP_DIALED_NUMBER  Dialed number
ACLIP_NUMBER_ABSENCE  Caller number absent: 'O' or 'P'
ACLIP_REDIRECT  Call forward: universal, on busy, or on unanswered
ACLIP_QUALIFIER  Long distance call: 'L'
ACLIP_CALLER_NAME  Caller's name
ACLIP_NAME_ABSENCE  Caller's name absent: 'O' or 'P'

anonymous enum
 

J-CLIP MDM message IDs

Enumeration values:
JCLIP_CALLER_NUMBER  Caller number
JCLIP_CALLER_NUM_DES  Caller number data extension signal
JCLIP_DIALED_NUMBER  Dialed number
JCLIP_DIALED_NUM_DES  Dialed number data extension signal
JCLIP_ABSENCE  Caller number absent: 'C', 'O', 'P' or 'S'


Function Documentation

SPAN_DECLARE const char *   ) 
 

Return a short name for an ADSI standard.

Get the transmitted identifier associated with a T.30 context.

Parameters:
s The T.30 context.
id A pointer to the identifier.
Returns:
0 for OK, else -1.

SPAN_DECLARE void   ) 
 

Cleanup a T.30 context if the call terminates.

Parameters:
s The ADSI transmit context.
preamble_len The number of bits of preamble.
preamble_ones_len The number of bits of continuous one before a message.
postamble_ones_len The number of bits of continuous one after a message.
stop_bits The number of stop bits per character.

SPAN_DECLARE adsi_tx_state_t  ) 
 

Initialise an ADSI transmit context.

Parameters:
s The ADSI transmit context.
standard The code for the ADSI standard to be used.
Returns:
A pointer to the initialised context, or NULL if there was a problem.

SPAN_DECLARE int32_t   ) 
 

Receive a chunk of ADSI audio.

Compress a block of octets.

Parameters:
s The V.42bis context.
buf The data to be compressed.
len The length of the data buffer.
Returns:
0

SPAN_DECLARE adsi_rx_state_t  ) 
 

Initialise an ADSI receive context.

Parameters:
s The ADSI receive context.
standard The code for the ADSI standard to be used.
put_msg A callback routine called to deliver the received messages to the application.
user_data An opaque pointer for the callback routine.
Returns:
A pointer to the initialised context, or NULL if there was a problem.


Generated on Fri Aug 28 20:12:28 2009 for spandsp by  doxygen 1.3.9.1