libspandsp 0.0.4

t31.h File Reference

Go to the source code of this file.

Classes

struct  t31_state_s

Defines

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

Typedefs

typedef struct 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.
void t31_set_tep_mode (t31_state_t *s, int use_tep)
 Select whether TEP mode will be used.
void t31_set_t38_config (t31_state_t *s, int without_pacing)
 Select whether T.38 data will be paced.
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:
sThe T.31 context.
at_tx_handlerA callback routine to handle AT interpreter channel output.
at_tx_user_dataAn opaque pointer passed in called to at_tx_handler.
modem_control_handlerA callback routine to handle control of the modem (off-hook, etc).
modem_control_user_dataAn 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.

References at_init(), t31_state_s::call_samples, at_state_s::dte_inactivity_timeout, t31_state_s::logging, power_meter_init(), power_meter_level_dbm0(), queue_init(), QUEUE_READ_ATOMIC, QUEUE_WRITE_ATOMIC, t31_state_s::rx_handler, t31_state_s::rx_power, at_state_s::rx_signal_present, at_state_s::rx_trained, t31_state_s::silence_awaited, silence_gen(), t31_state_s::silence_gen, silence_gen_init(), t31_state_s::silence_heard, t31_set_t38_config(), t31_state_s::tx_handler, t31_state_s::v17_rx, v17_rx_init(), t31_state_s::v17_tx, v17_tx_init(), t31_state_s::v27ter_rx, v27ter_rx_init(), t31_state_s::v27ter_tx, v27ter_tx_init(), t31_state_s::v29_rx, v29_rx_init(), v29_rx_signal_cutoff(), t31_state_s::v29_tx, and v29_tx_init().

int t31_release ( t31_state_t s)

Release a T.31 context.

Release a T.31 context.

Parameters:
sThe 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:
sThe T.31 modem context.
ampThe audio sample buffer.
lenThe number of samples in the buffer.
Returns:
The number of samples unprocessed.

References t31_state_s::call_samples, power_meter_update(), t31_state_s::rx_handler, t31_state_s::rx_power, and t31_state_s::silence_heard.

void t31_set_t38_config ( t31_state_t s,
int  without_pacing 
)

Select whether T.38 data will be paced.

Select whether T.38 data will be paced as it is transmitted.

Parameters:
sThe T.31 modem context.
without_pacingTRUE if data is to be sent as fast as possible. FALSE if it is to be paced.

References t31_state_s::data_end_tx_count, and t31_state_s::indicator_tx_count.

Referenced by t31_init().

void t31_set_tep_mode ( t31_state_t s,
int  use_tep 
)

Select whether TEP mode will be used.

Select whether TEP mode will be used (or time allowed for it (when transmitting).

Parameters:
sThe T.31 modem context.
use_tepTRUE if TEP is to be ised.

References t31_state_s::use_tep.

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:
sThe T.31 modem context.
transmit_on_idleTRUE 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.

References t31_state_s::transmit_on_idle.

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:
sThe T.31 modem context.
ampThe audio sample buffer.
max_lenThe number of samples to be generated.
Returns:
The number of samples actually generated.

References AT_MODEM_CONTROL_HANGUP, t31_state_s::transmit_on_idle, and t31_state_s::tx_handler.