t38_terminal.h File Reference

Go to the source code of this file.

Classes
struct	t38_terminal_front_end_state_t
struct	t38_terminal_state_t
Defines
#define	_SPANDSP_T38_TERMINAL_H_
#define	T38_MAX_HDLC_LEN   260
Functions
int	t38_terminal_send_timeout (t38_terminal_state_t *s, int samples)
void	t38_terminal_set_config (t38_terminal_state_t *s, int without_pacing)
void	t38_terminal_set_tep_mode (t38_terminal_state_t *s, int use_tep)
	Select whether TEP time will be allowed for.
void	t38_terminal_set_fill_bit_removal (t38_terminal_state_t *s, int remove)
	Select whether non-ECM fill bits are to be removed during transmission.
t30_state_t *	t38_terminal_get_t30_state (t38_terminal_state_t *s)
	Get a pointer to the T.30 engine associated with a T.38 context.
t38_terminal_state_t *	t38_terminal_init (t38_terminal_state_t *s, int calling_party, t38_tx_packet_handler_t *tx_packet_handler, void *tx_packet_user_data)
	Initialise a termination mode T.38 context.
int	t38_terminal_release (t38_terminal_state_t *s)
	Release a T.38 context.
int	t38_terminal_free (t38_terminal_state_t *s)
	Free a T.38 context.

---

Detailed Description

---

Function Documentation

int t38_terminal_free

(

t38_terminal_state_t *

s

)

Free a T.38 context.

Free a a termination mode T.38 context.

Parameters:

s

The T.38 context.

Returns:

0 for OK, else -1.

References t38_terminal_state_t::t30, and t30_release().

t30_state_t* t38_terminal_get_t30_state

(

t38_terminal_state_t *

s

)

Get a pointer to the T.30 engine associated with a T.38 context.

Get a pointer to the T.30 engine associated with a termination mode T.38 context.

Parameters:

s

The T.38 context.

Returns:

A pointer to the T.30 context, or NULL.

References t38_terminal_state_t::t30.

t38_terminal_state_t* t38_terminal_init	(	t38_terminal_state_t *	s,
		int	calling_party,
		t38_tx_packet_handler_t *	tx_packet_handler,
		void *	tx_packet_user_data
	)

Initialise a termination mode T.38 context.

Parameters:

	s	The T.38 context.
	calling_party	TRUE if the context is for a calling party. FALSE if the context is for an answering party.
	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.

References t38_terminal_state_t::logging, t38_terminal_state_t::t30, t30_init(), t30_restart(), t30_set_iaf_mode(), and t30_set_supported_modems().

int t38_terminal_release

(

t38_terminal_state_t *

s

)

Release a T.38 context.

Release a termination mode T.38 context.

Parameters:

s

The T.38 context.

Returns:

0 for OK, else -1.

References t38_terminal_state_t::t30, and t30_release().

void t38_terminal_set_fill_bit_removal	(	t38_terminal_state_t *	s,
		int	remove
	)

Select whether non-ECM fill bits are to be removed during transmission.

Select whether non-ECM fill bits are to be removed during transmission.

Parameters:

	s	The T.38 context.
	remove	TRUE if fill bits are to be removed.

References t38_terminal_state_t::t30, T30_IAF_MODE_NO_FILL_BITS, t30_set_iaf_mode(), and t38_terminal_state_t::t38_fe.

void t38_terminal_set_tep_mode	(	t38_terminal_state_t *	s,
		int	use_tep
	)

Select whether TEP time will be allowed for.

Select whether the time for talker echo protection tone will be allowed for when sending.

Parameters:

	s	The T.38 context.
	use_tep	TRUE if TEP should be allowed for.

References t38_terminal_state_t::t38_fe.