spandsp  3.0.0
t31.h File Reference

Go to the source code of this file.

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_free_space (t31_state_t *s)
 Return the amount of free space in the AT COMMAND BUFFER. More...
 
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. More...
 
int t31_rx_fillin (t31_state_t *s, int len)
 Fake processing of a missing block of received T.31 modem audio samples. More...
 
int t31_tx (t31_state_t *s, int16_t amp[], int max_len)
 Generate a block of T.31 modem audio samples. More...
 
int t31_t38_send_timeout (t31_state_t *s, int samples)
 
void t31_set_transmit_on_idle (t31_state_t *s, bool transmit_on_idle)
 Select whether silent audio will be sent when transmit is idle. More...
 
void t31_set_tep_mode (t31_state_t *s, bool use_tep)
 Select whether TEP mode will be used. More...
 
void t31_set_t38_config (t31_state_t *s, bool without_pacing)
 Select whether T.38 data will be paced. More...
 
void t31_set_mode (t31_state_t *s, bool t38_mode)
 Set audio or T.38 mode. More...
 
logging_state_tt31_get_logging_state (t31_state_t *s)
 Get a pointer to the logging context associated with a T.31 context. More...
 
at_state_tt31_get_at_state (t31_state_t *s)
 Get a pointer to the AT interpreter context associated with a T.31 context. More...
 
t38_core_state_tt31_get_t38_core_state (t31_state_t *s)
 Get a pointer to the T.38 core context associated with a T.31 context. More...
 
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. More...
 
int t31_release (t31_state_t *s)
 Release a T.31 context. More...
 
int t31_free (t31_state_t *s)
 Release a T.31 context. More...
 

Typedef Documentation

◆ t31_state_t

typedef struct t31_state_s t31_state_t

T.31 descriptor. This defines the working state for a single instance of a T.31 FAX modem.

Function Documentation

◆ t31_at_rx_free_space()

int t31_at_rx_free_space ( t31_state_t s)

Return the amount of free space in the AT COMMAND BUFFER.

Return the amount of free space in the AT COMMAND BUFFER.

Parameters
sThe T.31 modem context.
Returns
The number of bytes of free space.

References t31_state_s::in_bytes, t31_state_s::non_ecm_tx, and t31_state_s::out_bytes.

◆ t31_free()

int t31_free ( t31_state_t s)

Release a T.31 context.

Free a T.31 context.

Parameters
sThe T.31 context.
Returns
0 for OK

References t31_release().

◆ t31_get_at_state()

at_state_t* t31_get_at_state ( t31_state_t s)

Get a pointer to the AT interpreter context associated with a T.31 context.

Get a pointer to the AT interpreter context associated with a T.31 context.

Parameters
sThe T.31 context.
Returns
A pointer to the AT interpreter context, or NULL.

◆ t31_get_logging_state()

logging_state_t* t31_get_logging_state ( t31_state_t s)

Get a pointer to the logging context associated with a T.31 context.

Get a pointer to the logging context associated with a T.31 context.

Parameters
sThe T.31 context.
Returns
A pointer to the logging context, or NULL.

References t31_state_s::logging.

◆ t31_get_t38_core_state()

t38_core_state_t* t31_get_t38_core_state ( t31_state_t s)

Get a pointer to the T.38 core context associated with a T.31 context.

Get a pointer to the T.38 core context associated with a T.31 context.

Parameters
sThe T.31 context.
Returns
A pointer to the T.38 core context, or NULL.

References t31_t38_front_end_state_t::t38.

◆ t31_init()

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.

◆ t31_release()

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

Referenced by t31_free().

◆ t31_rx()

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.

◆ t31_rx_fillin()

int t31_rx_fillin ( t31_state_t s,
int  len 
)

Fake processing of a missing block of received T.31 modem audio samples.

Fake processing of a missing block of received T.31 modem audio samples (e.g due to packet loss).

Parameters
sThe T.31 modem context.
lenThe number of samples to fake.
Returns
The number of samples unprocessed.

References t31_state_s::call_samples.

◆ t31_set_mode()

void t31_set_mode ( t31_state_t s,
bool  t38_mode 
)

Set audio or T.38 mode.

Set audio or T.38 mode.

Parameters
sThe T.31 modem context.
t38_modeTrue for T.38 mode operation. False for audio mode operation.

◆ t31_set_t38_config()

void t31_set_t38_config ( t31_state_t s,
bool  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 DATA_END_TX_COUNT, DATA_TX_COUNT, INDICATOR_TX_COUNT, t31_t38_front_end_state_t::t38, T38_PACKET_CATEGORY_CONTROL_DATA, T38_PACKET_CATEGORY_CONTROL_DATA_END, T38_PACKET_CATEGORY_IMAGE_DATA, T38_PACKET_CATEGORY_IMAGE_DATA_END, T38_PACKET_CATEGORY_INDICATOR, t38_set_redundancy_control(), t31_t38_front_end_state_t::us_per_tx_chunk, and US_PER_TX_CHUNK.

◆ t31_set_tep_mode()

void t31_set_tep_mode ( t31_state_t s,
bool  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 used.

References fax_modems_state_s::use_tep.

◆ t31_set_transmit_on_idle()

void t31_set_transmit_on_idle ( t31_state_t s,
bool  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 fax_modems_state_s::transmit_on_idle.

◆ t31_tx()

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.