fax.c File Reference

#include <inttypes.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include <fcntl.h>
#include <time.h>
#include <tiffio.h>
#include "spandsp/telephony.h"
#include "spandsp/logging.h"
#include "spandsp/queue.h"
#include "spandsp/dc_restore.h"
#include "spandsp/power_meter.h"
#include "spandsp/complex.h"
#include "spandsp/tone_generate.h"
#include "spandsp/async.h"
#include "spandsp/hdlc.h"
#include "spandsp/silence_gen.h"
#include "spandsp/fsk.h"
#include "spandsp/v29rx.h"
#include "spandsp/v29tx.h"
#include "spandsp/v27ter_rx.h"
#include "spandsp/v27ter_tx.h"
#include "spandsp/v17rx.h"
#include "spandsp/v17tx.h"
#include "spandsp/t4.h"
#include "spandsp/t30_fcf.h"
#include "spandsp/t35.h"
#include "spandsp/t30.h"
#include "spandsp/t30_api.h"
#include "spandsp/t30_logging.h"
#include "spandsp/fax.h"

Defines

#define HDLC_FRAMING_OK_THRESHOLD   5

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_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.
fax_state_tfax_init (fax_state_t *s, int calling_party)
 Initialise a FAX context.
int fax_release (fax_state_t *s)
 Release a FAX context.
int fax_free (fax_state_t *s)
 Free a FAX context.
void fax_set_flush_handler (fax_state_t *s, fax_flush_handler_t *handler, void *user_data)

Detailed Description


Function Documentation

int fax_free ( fax_state_t s  ) 

Free a FAX context.

Free a FAX context.

Parameters:
s The FAX context.
Returns:
0 for OK, else -1.

References t30_release(), and fax_state_s::t30_state.

fax_state_t* 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:
A pointer to the FAX context, or NULL if there was a problem.

References fsk_rx_init(), fsk_rx_signal_cutoff(), fsk_tx_init(), hdlc_rx_init(), hdlc_rx_put_bit(), hdlc_tx_get_bit(), hdlc_tx_init(), fax_state_s::logging, silence_gen_init(), t30_hdlc_accept(), t30_init(), t30_non_ecm_get_bit(), t30_non_ecm_put_bit(), t30_restart(), t30_set_supported_modems(), fax_state_s::t30_state, v17_rx_init(), v17_tx_init(), v27ter_rx_init(), v27ter_tx_init(), v29_rx_init(), v29_rx_signal_cutoff(), and v29_tx_init().

int fax_release ( fax_state_t s  ) 

Release a FAX context.

Release a FAX context.

Parameters:
s The FAX context.
Returns:
0 for OK, else -1.

References t30_release(), and fax_state_s::t30_state.

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.

References fax_state_s::dc_restore, fax_state_s::fax_audio_rx_log, fax_state_s::rx_handler, fax_state_s::rx_user_data, fax_state_s::t30_state, and t30_timer_update().

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.

References fax_state_s::use_tep.

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.

References fax_state_s::transmit_on_idle.

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.

References fax_state_s::current_tx_type, fax_state_s::fax_audio_tx_log, t30_front_end_status(), fax_state_s::t30_state, fax_state_s::transmit, fax_state_s::transmit_on_idle, fax_state_s::tx_handler, and fax_state_s::tx_user_data.


Generated on Sat Aug 28 11:57:23 2010 for libspandsp by  doxygen 1.5.5