t31.h File Reference

Go to the source code of this file.

Classes

struct  t31_state_s

Defines

#define _SPANDSP_T31_H_
#define T31_TX_BUF_LEN   (4096)
#define T31_TX_BUF_HIGH_TIDE   (4096 - 1024)
#define T31_TX_BUF_LOW_TIDE   (1024)

Typedefs

typedef t31_state_s t31_state_t
typedef int( t31_modem_control_handler_t )(t31_state_t *s, void *user_data, int op, const char *num)

Functions

void t31_call_event (t31_state_t *s, int event)
int t31_at_rx (t31_state_t *s, const char *t, int len)
int t31_rx (t31_state_t *s, int16_t amp[], int len)
 Process a block of received T.31 modem audio samples.
int t31_tx (t31_state_t *s, int16_t amp[], int max_len)
 Generate a block of T.31 modem audio samples.
int t31_t38_send_timeout (t31_state_t *s, int samples)
void t31_set_transmit_on_idle (t31_state_t *s, int transmit_on_idle)
 Select whether silent audio will be sent when transmit is idle.
t31_state_tt31_init (t31_state_t *s, at_tx_handler_t *at_tx_handler, void *at_tx_user_data, t31_modem_control_handler_t *modem_control_handler, void *modem_control_user_data, t38_tx_packet_handler_t *tx_t38_packet_handler, void *tx_t38_packet_user_data)
 Initialise a T.31 context.
int t31_release (t31_state_t *s)
 Release a T.31 context.


Detailed Description


Function Documentation

t31_state_t* t31_init ( t31_state_t s,
at_tx_handler_t *  at_tx_handler,
void *  at_tx_user_data,
t31_modem_control_handler_t *  modem_control_handler,
void *  modem_control_user_data,
t38_tx_packet_handler_t *  tx_t38_packet_handler,
void *  tx_t38_packet_user_data 
)

Initialise a T.31 context.

Initialise a T.31 context. This must be called before the first use of the context, to initialise its contents.

Parameters:
s The T.31 context.
at_tx_handler A callback routine to handle AT interpreter channel output.
at_tx_user_data An opaque pointer passed in called to at_tx_handler.
modem_control_handler A callback routine to handle control of the modem (off-hook, etc).
modem_control_user_data An opaque pointer passed in called to modem_control_handler.
tx_t38_packet_handler ???
tx_t38_packet_user_data ???
Returns:
A pointer to the T.31 context.

int t31_release ( t31_state_t s  ) 

Release a T.31 context.

Release a T.31 context.

Parameters:
s The T.31 context.
Returns:
0 for OK

int t31_rx ( t31_state_t s,
int16_t  amp[],
int  len 
)

Process a block of received T.31 modem audio samples.

Process a block of received T.31 modem audio samples.

Parameters:
s The T.31 modem context.
amp The audio sample buffer.
len The number of samples in the buffer.
Returns:
The number of samples unprocessed.

void t31_set_transmit_on_idle ( t31_state_t s,
int  transmit_on_idle 
)

Select whether silent audio will be sent when transmit is idle.

Select whether silent audio will be sent when transmit is idle.

Parameters:
s The T.31 modem context.
transmit_on_idle TRUE if silent audio should be output when the transmitter is idle. FALSE to transmit zero length audio when the transmitter is idle. The default behaviour is FALSE.

int t31_tx ( t31_state_t s,
int16_t  amp[],
int  max_len 
)

Generate a block of T.31 modem audio samples.

Generate a block of T.31 modem audio samples.

Parameters:
s The T.31 modem context.
amp The audio sample buffer.
max_len The number of samples to be generated.
Returns:
The number of samples actually generated.


Generated on Tue Jul 24 11:29:29 2007 for libspandsp by  doxygen 1.5.2