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

t31.h File Reference

Go to the source code of this file.

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)
#define T31_MAX_HDLC_LEN   284
#define T31_T38_MAX_HDLC_LEN   260

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

 SPAN_DECLARE (void) t31_call_event(t31_state_t *s
 Cleanup a T.30 context if the call terminates.
 SPAN_DECLARE (int) t31_at_rx(t31_state_t *s
 Release a V.8 context.
 SPAN_DECLARE (logging_state_t *) t31_get_logging_state(t31_state_t *s)
 Get a pointer to the logging context associated with a T.31 context.
 SPAN_DECLARE (t38_core_state_t *) t31_get_t38_core_state(t31_state_t *s)
 SPAN_DECLARE (t31_state_t *) t31_init(t31_state_t *s
 Initialise a T.31 context.

Variables

int event
const char * t
const char int len
int16_t amp []
int16_t int max_len
int samples
int transmit_on_idle
int use_tep
int without_pacing
int t38_mode
at_tx_handler_t * at_tx_handler
at_tx_handler_t void * at_tx_user_data
at_tx_handler_t void t31_modem_control_handler_t * modem_control_handler
at_tx_handler_t void t31_modem_control_handler_t
void * 
modem_control_user_data
at_tx_handler_t void t31_modem_control_handler_t
void t38_tx_packet_handler_t * 
tx_t38_packet_handler
at_tx_handler_t void t31_modem_control_handler_t
void t38_tx_packet_handler_t
void * 
tx_t38_packet_user_data


Detailed Description


Typedef Documentation

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

SPAN_DECLARE t31_state_t  ) 
 

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.

SPAN_DECLARE logging_state_t  ) 
 

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

Get a pointer to the logging context associated with a FAX context.

Parameters:
s The FAX context.
Returns:
A pointer to the logging context, or NULL.

SPAN_DECLARE int   ) 
 

Release a V.8 context.

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.

SPAN_DECLARE void   ) 
 

Cleanup a T.30 context if the call terminates.

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.


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