fax.h File Reference

Go to the source code of this file.

Classes
struct	fax_state_s
Typedefs
typedef fax_state_s	fax_state_t
typedef void()	fax_flush_handler_t (fax_state_t *s, void *user_data, int which)
Functions
int	fax_rx (fax_state_t *s, int16_t *amp, int len)
	Apply T.30 receive processing to a block of audio samples.
int	fax_tx (fax_state_t *s, int16_t *amp, int max_len)
	Apply T.30 transmit processing to generate a block of audio samples.
void	fax_set_flush_handler (fax_state_t *s, fax_flush_handler_t *handler, void *user_data)
void	fax_set_transmit_on_idle (fax_state_t *s, int transmit_on_idle)
	Select whether silent audio will be sent when FAX transmit is idle.
void	fax_set_tep_mode (fax_state_t *s, int use_tep)
	Select whether TEP will be sent for the image modems.
int	fax_init (fax_state_t *s, int calling_party)
	Initialise a FAX context.
int	fax_release (fax_state_t *s)
	Release a FAX context.

---

Detailed Description

---

Function Documentation

int fax_init (  fax_state_t *  s, int  calling_party )

Initialise a FAX context. Initialise a FAX context. Parameters: s  The FAX context. calling_party  TRUE if the context is for a calling party. FALSE if the context is for an answering party. Returns: 0 for OK, else -1.

int fax_release (  fax_state_t *  s  )

Release a FAX context. Release a FAX context. Parameters: s  The FAX context.

int fax_rx (  fax_state_t *  s, int16_t *  amp, int  len )

Apply T.30 receive processing to a block of audio samples. Apply T.30 receive processing to a block of audio samples. Parameters: s  The FAX context. amp  The audio sample buffer. len  The number of samples in the buffer. Returns: The number of samples unprocessed. This should only be non-zero if the software has reached the end of the FAX call.

void fax_set_tep_mode (  fax_state_t *  s, int  use_tep )

Select whether TEP will be sent for the image modems. Select whether talker echo protection tone will be sent for the image modems. Parameters: s  The FAX context. use_tep  TRUE if TEP should be sent.

void fax_set_transmit_on_idle (  fax_state_t *  s, int  transmit_on_idle )

Select whether silent audio will be sent when FAX transmit is idle. Select whether silent audio will be sent when FAX transmit is idle. Parameters: s  The FAX context. transmit_on_idle  TRUE if silent audio should be output when the FAX transmitter is idle. FALSE to transmit zero length audio when the FAX transmitter is idle. The default behaviour is FALSE.

int fax_tx (  fax_state_t *  s, int16_t *  amp, int  max_len )

Apply T.30 transmit processing to generate a block of audio samples. Apply T.30 transmit processing to generate a block of audio samples. Parameters: s  The FAX context. amp  The audio sample buffer. max_len  The number of samples to be generated. Returns: The number of samples actually generated. This will be zero when there is nothing to send.

---