spandsp  0.0.6
private/fax_modems.h
Go to the documentation of this file.
1 /*
2  * SpanDSP - a series of DSP components for telephony
3  *
4  * private/fax_modems.h - definitions for the analogue modem set for fax processing
5  *
6  * Written by Steve Underwood <steveu@coppice.org>
7  *
8  * Copyright (C) 2008 Steve Underwood
9  *
10  * All rights reserved.
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU Lesser General Public License version 2.1,
14  * as published by the Free Software Foundation.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with this program; if not, write to the Free Software
23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  */
25 
26 /*! \file */
27 
28 #if !defined(_SPANDSP_PRIVATE_FAX_MODEMS_H_)
29 #define _SPANDSP_PRIVATE_FAX_MODEMS_H_
30 
31 /*!
32  The set of modems needed for FAX, plus the auxilliary stuff, like tone generation.
33 */
35 {
36  /*! TRUE is talker echo protection should be sent for the image modems */
37  int use_tep;
38 
39  /*! If TRUE, transmit silence when there is nothing else to transmit. If FALSE return only
40  the actual generated audio. Note that this only affects untimed silences. Timed silences
41  (e.g. the 75ms silence between V.21 and a high speed modem) will alway be transmitted as
42  silent audio. */
44 
45  /*! \brief An HDLC context used when transmitting HDLC messages. */
47  /*! \brief An HDLC context used when receiving HDLC messages. */
49  /*! \brief A V.21 FSK modem context used when transmitting HDLC over V.21
50  messages. */
52  /*! \brief A V.21 FSK modem context used when receiving HDLC over V.21
53  messages. */
55  /*! \brief A V.17 modem context used when sending FAXes at 7200bps, 9600bps
56  12000bps or 14400bps */
58  /*! \brief A V.29 modem context used when receiving FAXes at 7200bps, 9600bps
59  12000bps or 14400bps */
61  /*! \brief A V.29 modem context used when sending FAXes at 7200bps or
62  9600bps */
64  /*! \brief A V.29 modem context used when receiving FAXes at 7200bps or
65  9600bps */
67  /*! \brief A V.27ter modem context used when sending FAXes at 2400bps or
68  4800bps */
70  /*! \brief A V.27ter modem context used when receiving FAXes at 2400bps or
71  4800bps */
73  /*! \brief Used to insert timed silences. */
75  /*! \brief CED or CNG generator */
77  /*! \brief CED or CNG detector */
79  /*! \brief */
80  dc_restore_state_t dc_restore;
81 
82  /*! \brief The currently select receiver type */
84  /*! \brief The currently select transmitter type */
86 
87  /*! \brief TRUE if a carrier is present. Otherwise FALSE. */
89  /*! \brief TRUE if a modem has trained correctly. */
91  /*! \brief TRUE if an HDLC frame has been received correctly. */
93 
94  /*! The current receive signal handler */
95  span_rx_handler_t *rx_handler;
96  /*! The current receive missing signal fill-in handler */
97  span_rx_fillin_handler_t *rx_fillin_handler;
98  void *rx_user_data;
99 
100  /*! The current transmit signal handler */
101  span_tx_handler_t *tx_handler;
102  void *tx_user_data;
103 
104  /*! The next transmit signal handler, for two stage transmit operations.
105  E.g. a short silence followed by a modem signal. */
106  span_tx_handler_t *next_tx_handler;
107  void *next_tx_user_data;
108 
109  /*! The current bit rate of the transmitter. */
111  /*! The current bit rate of the receiver. */
113 
114  /*! If TRUE, transmission is in progress */
115  int transmit;
116  /*! \brief Audio logging file handle for received audio. */
118  /*! \brief Audio logging file handle for transmitted audio. */
120  /*! \brief Error and flow logging control */
122 };
123 
124 #endif
125 /*- End of file ------------------------------------------------------------*/
span_rx_fillin_handler_t * rx_fillin_handler
Definition: private/fax_modems.h:97
span_tx_handler_t * tx_handler
Definition: private/fax_modems.h:101
Definition: private/silence_gen.h:29
logging_state_t logging
Error and flow logging control.
Definition: private/fax_modems.h:121
Definition: private/v29rx.h:43
int transmit_on_idle
Definition: private/fax_modems.h:43
int use_tep
Definition: private/fax_modems.h:37
v27ter_rx_state_t v27ter_rx
A V.27ter modem context used when receiving FAXes at 2400bps or 4800bps.
Definition: private/fax_modems.h:72
int audio_rx_log
Audio logging file handle for received audio.
Definition: private/fax_modems.h:117
Definition: private/v29tx.h:36
int rx_frame_received
TRUE if an HDLC frame has been received correctly.
Definition: private/fax_modems.h:92
Definition: private/v17rx.h:54
Definition: private/hdlc.h:91
Definition: private/fsk.h:58
Definition: private/v17tx.h:38
v17_tx_state_t v17_tx
A V.17 modem context used when sending FAXes at 7200bps, 9600bps 12000bps or 14400bps.
Definition: private/fax_modems.h:57
int rx_signal_present
TRUE if a carrier is present. Otherwise FALSE.
Definition: private/fax_modems.h:88
Definition: private/fsk.h:33
span_rx_handler_t * rx_handler
Definition: private/fax_modems.h:95
int audio_tx_log
Audio logging file handle for transmitted audio.
Definition: private/fax_modems.h:119
v27ter_tx_state_t v27ter_tx
A V.27ter modem context used when sending FAXes at 2400bps or 4800bps.
Definition: private/fax_modems.h:69
silence_gen_state_t silence_gen
Used to insert timed silences.
Definition: private/fax_modems.h:74
int rx_trained
TRUE if a modem has trained correctly.
Definition: private/fax_modems.h:90
v29_tx_state_t v29_tx
A V.29 modem context used when sending FAXes at 7200bps or 9600bps.
Definition: private/fax_modems.h:63
int tx_bit_rate
Definition: private/fax_modems.h:110
Definition: dc_restore.h:57
Definition: private/fax_modems.h:34
v29_rx_state_t v29_rx
A V.29 modem context used when receiving FAXes at 7200bps or 9600bps.
Definition: private/fax_modems.h:66
Definition: private/modem_connect_tones.h:37
span_tx_handler_t * next_tx_handler
Definition: private/fax_modems.h:106
Definition: private/v27ter_tx.h:36
int transmit
Definition: private/fax_modems.h:115
v17_rx_state_t v17_rx
A V.29 modem context used when receiving FAXes at 7200bps, 9600bps 12000bps or 14400bps.
Definition: private/fax_modems.h:60
Definition: private/logging.h:33
hdlc_rx_state_t hdlc_rx
An HDLC context used when receiving HDLC messages.
Definition: private/fax_modems.h:48
Definition: private/modem_connect_tones.h:57
Definition: private/v27ter_rx.h:51
fsk_rx_state_t v21_rx
A V.21 FSK modem context used when receiving HDLC over V.21 messages.
Definition: private/fax_modems.h:54
hdlc_tx_state_t hdlc_tx
An HDLC context used when transmitting HDLC messages.
Definition: private/fax_modems.h:46
Definition: private/hdlc.h:32
int rx_bit_rate
Definition: private/fax_modems.h:112
modem_connect_tones_rx_state_t connect_rx
CED or CNG detector.
Definition: private/fax_modems.h:78
int current_tx_type
The currently select transmitter type.
Definition: private/fax_modems.h:85
int current_rx_type
The currently select receiver type.
Definition: private/fax_modems.h:83
fsk_tx_state_t v21_tx
A V.21 FSK modem context used when transmitting HDLC over V.21 messages.
Definition: private/fax_modems.h:51
modem_connect_tones_tx_state_t connect_tx
CED or CNG generator.
Definition: private/fax_modems.h:76