spandsp 0.0.6
fax_modems_state_s Struct Reference

#include <fax_modems.h>

Classes

struct  [struct].fast_modems

Public Attributes

int use_tep
int transmit_on_idle
hdlc_tx_state_t hdlc_tx
 An HDLC context used when transmitting HDLC messages.
hdlc_rx_state_t hdlc_rx
 An HDLC context used when receiving HDLC messages.
fsk_tx_state_t v21_tx
 A V.21 FSK modem context used when transmitting HDLC over V.21 messages.
fsk_rx_state_t v21_rx
 A V.21 FSK modem context used when receiving HDLC over V.21 messages.
struct  fast_modems
silence_gen_state_t silence_gen
 Used to insert timed silences.
modem_connect_tones_tx_state_t connect_tx
 CED or CNG generator.
modem_connect_tones_rx_state_t connect_rx
 CED or CNG detector.
dc_restore_state_t dc_restore
int current_rx_type
 The currently selected receiver type.
int current_tx_type
 The currently selected transmitter type.
int rx_signal_present
 TRUE if a carrier is present. Otherwise FALSE.
int rx_trained
 TRUE if a modem has trained correctly.
int rx_frame_received
 TRUE if an HDLC frame has been received correctly.
span_rx_handler_t * rx_handler
 The current receive signal handler.
span_rx_fillin_handler_t * rx_fillin_handler
 The current receive missing signal fill-in handler.
void * rx_user_data
span_tx_handler_t * tx_handler
 The current transmit signal handler.
void * tx_user_data
span_tx_handler_t * next_tx_handler
 The next transmit signal handler, for two stage transmit operations. E.g. a short silence followed by a modem signal.
void * next_tx_user_data
int tx_bit_rate
 The current bit rate of the transmitter.
int rx_bit_rate
 The current bit rate of the receiver.
int transmit
 If TRUE, transmission is in progress.
int audio_rx_log
 Audio logging file handle for received audio.
int audio_tx_log
 Audio logging file handle for transmitted audio.
logging_state_t logging
 Error and flow logging control.

Detailed Description

The set of modems needed for FAX, plus the auxilliary stuff, like tone generation.

Member Data Documentation

◆ audio_rx_log

int fax_modems_state_s::audio_rx_log

Audio logging file handle for received audio.

Referenced by fax_restart(), and t38_gateway_init().

◆ audio_tx_log

int fax_modems_state_s::audio_tx_log

Audio logging file handle for transmitted audio.

Referenced by fax_restart(), and t38_gateway_init().

◆ logging

logging_state_t fax_modems_state_s::logging

Error and flow logging control.

Referenced by fax_modems_get_logging_state().

◆ rx_handler

span_rx_handler_t* fax_modems_state_s::rx_handler

The current receive signal handler.

Referenced by faxtester_rx().

◆ rx_signal_present

int fax_modems_state_s::rx_signal_present

TRUE if a carrier is present. Otherwise FALSE.

Referenced by faxtester_rx().

◆ transmit_on_idle

int fax_modems_state_s::transmit_on_idle

If TRUE, transmit silence when there is nothing else to transmit. If FALSE return only the actual generated audio. Note that this only affects untimed silences. Timed silences (e.g. the 75ms silence between V.21 and a high speed modem) will alway be transmitted as silent audio.

Referenced by fax_set_transmit_on_idle(), faxtester_set_transmit_on_idle(), faxtester_tx(), t31_set_transmit_on_idle(), and t38_gateway_set_transmit_on_idle().

◆ tx_handler

span_tx_handler_t* fax_modems_state_s::tx_handler

The current transmit signal handler.

Referenced by faxtester_tx().

◆ use_tep

int fax_modems_state_s::use_tep

TRUE is talker echo protection should be sent for the image modems

Referenced by fax_set_tep_mode(), faxtester_set_tep_mode(), t31_set_tep_mode(), and t38_gateway_set_tep_mode().


The documentation for this struct was generated from the following file: