t38_gateway.h File Reference

Go to the source code of this file.

Classes
struct	t38_gateway_state_t
Defines
#define	_SPANDSP_T38_GATEWAY_H_
#define	T38_RX_BUF_LEN   2048
#define	T38_NON_ECM_TX_BUF_LEN   16384
#define	T38_TX_HDLC_BUFS   256
#define	T38_MAX_HDLC_LEN   260
Functions
t38_gateway_state_t *	t38_gateway_init (t38_gateway_state_t *s, t38_tx_packet_handler_t *tx_packet_handler, void *tx_packet_user_data)
	Initialise a gateway mode T.38 context.
int	t38_gateway_rx (t38_gateway_state_t *s, int16_t amp[], int len)
	Process a block of received FAX audio samples.
int	t38_gateway_tx (t38_gateway_state_t *s, int16_t amp[], int max_len)
	Generate a block of FAX audio samples.
void	t38_gateway_set_ecm_capability (t38_gateway_state_t *s, int ecm_allowed)
	Control whether error correcting mode (ECM) is allowed.
void	t38_gateway_set_transmit_on_idle (t38_gateway_state_t *s, int transmit_on_idle)
void	t38_gateway_set_supported_modems (t38_gateway_state_t *s, int supported_modems)
void	t38_gateway_set_nsx_suppression (t38_gateway_state_t *s, int suppress_nsx)

---

Detailed Description

---

Function Documentation

t38_gateway_state_t* t38_gateway_init	(	t38_gateway_state_t *	s,
		t38_tx_packet_handler_t *	tx_packet_handler,
		void *	tx_packet_user_data
	)

Initialise a gateway mode T.38 context.

Parameters:

	s	The T.38 context.
	tx_packet_handler	A callback routine to encapsulate and transmit T.38 packets.
	tx_packet_user_data	An opaque pointer passed to the tx_packet_handler routine.

Returns:

A pointer to the termination mode T.38 context, or NULL if there was a problem.

int t38_gateway_rx	(	t38_gateway_state_t *	s,
		int16_t	amp[],
		int	len
	)

Process a block of received FAX audio samples.

Process a block of received FAX audio samples.

Parameters:

	s	The T.38 context.
	amp	The audio sample buffer.
	len	The number of samples in the buffer.

Returns:

The number of samples unprocessed.

void t38_gateway_set_ecm_capability	(	t38_gateway_state_t *	s,
		int	ecm_allowed
	)

Control whether error correcting mode (ECM) is allowed.

Control whether error correcting mode (ECM) is allowed.

Parameters:

	s	The T.38 context.
	ecm_allowed	TRUE is ECM is to be allowed.

int t38_gateway_tx	(	t38_gateway_state_t *	s,
		int16_t	amp[],
		int	max_len
	)

Generate a block of FAX audio samples.

Generate a block of FAX audio samples.

Parameters:

	s	The T.38 context.
	amp	The audio sample buffer.
	max_len	The number of samples to be generated.

Returns:

The number of samples actually generated.

---