spandsp  0.0.6
private/t30.h
Go to the documentation of this file.
1 /*
2  * SpanDSP - a series of DSP components for telephony
3  *
4  * private/t30.h - definitions for T.30 fax processing
5  *
6  * Written by Steve Underwood <steveu@coppice.org>
7  *
8  * Copyright (C) 2003 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_T30_H_)
29 #define _SPANDSP_PRIVATE_T30_H_
30 
31 /*!
32  T.30 FAX channel descriptor. This defines the state of a single working
33  instance of a T.30 FAX channel.
34 */
36 {
37  /*! \brief T.4 context for reading or writing image data. */
38  union
39  {
40  t4_rx_state_t rx;
41  t4_tx_state_t tx;
42  } t4;
43  /*! \brief The type of FAX operation currently in progress */
45 
46  /*! \brief True if behaving as the calling party */
48 
49  /*! \brief Internet aware FAX mode bit mask. */
50  int iaf;
51  /*! \brief A bit mask of the currently supported modem types. */
53  /*! \brief A bit mask of the currently supported image compression modes. */
55  /*! \brief A bit mask of the currently supported image resolutions. */
57  /*! \brief A bit mask of the currently supported image sizes. */
59  /*! \brief A bit mask of the currently supported T.30 special features. */
61  /*! \brief True is ECM mode handling is enabled. */
63  /*! \brief True if we are capable of retransmitting pages */
65 
66  /*! \brief The received DCS, formatted as an ASCII string, for inclusion
67  in the TIFF file. */
69  /*! \brief The text which will be used in FAX page header. No text results
70  in no header line. */
72  /*! \brief True for FAX page headers to overlay (i.e. replace) the beginning of the
73  page image. False for FAX page headers to add to the overall length of
74  the page. */
76  /*! \brief Use private timezone if true */
78  /*! \brief Optional per instance time zone for the FAX page header timestamp. */
80 
81  /*! \brief True if remote T.30 procedural interrupts are allowed. */
83 
84  /*! \brief The information fields received. */
86  /*! \brief The information fields to be transmitted. */
88  /*! \brief The country of origin of the remote machine, if known, else NULL. */
89  const char *country;
90  /*! \brief The vendor of the remote machine, if known, else NULL. */
91  const char *vendor;
92  /*! \brief The model of the remote machine, if known, else NULL. */
93  const char *model;
94 
95  /*! \brief A pointer to a callback routine to be called when phase B events
96  occur. */
98  /*! \brief An opaque pointer supplied in event B callbacks. */
100  /*! \brief A pointer to a callback routine to be called when phase D events
101  occur. */
103  /*! \brief An opaque pointer supplied in event D callbacks. */
105  /*! \brief A pointer to a callback routine to be called when phase E events
106  occur. */
108  /*! \brief An opaque pointer supplied in event E callbacks. */
110  /*! \brief A pointer to a callback routine to be called when frames are
111  exchanged. */
113  /*! \brief An opaque pointer supplied in real time frame callbacks. */
115 
116  /*! \brief A pointer to a callback routine to be called when document events
117  (e.g. end of transmitted document) occur. */
119  /*! \brief An opaque pointer supplied in document callbacks. */
121 
122  /*! \brief The handler for changes to the receive mode */
124  /*! \brief An opaque pointer passed to the handler for changes to the receive mode */
126  /*! \brief The handler for changes to the transmit mode */
128  /*! \brief An opaque pointer passed to the handler for changes to the transmit mode */
130 
131  /*! \brief The transmitted HDLC frame handler. */
133  /*! \brief An opaque pointer passed to the transmitted HDLC frame handler. */
135 
136  /*! \brief The DIS code for the minimum scan row time we require. This is usually 0ms,
137  but if we are trying to simulate another type of FAX machine, we may need a non-zero
138  value here. */
140 
141  /*! \brief The current T.30 phase. */
142  int phase;
143  /*! \brief The T.30 phase to change to when the current phase ends. */
145  /*! \brief The current state of the T.30 state machine. */
146  int state;
147  /*! \brief The step in sending a sequence of HDLC frames. */
148  int step;
149 
150  /*! \brief The preparation buffer for the DCS message to be transmitted. */
152  /*! \brief The length of the DCS message to be transmitted. */
153  int dcs_len;
154  /*! \brief The preparation buffer for DIS or DTC message to be transmitted. */
156  /*! \brief The length of the DIS or DTC message to be transmitted. */
158  /*! \brief The last DIS or DTC message received form the far end. */
160  /*! \brief The length of the last DIS or DTC message received form the far end. */
162  /*! \brief True if a valid DIS has been received from the far end. */
164 
165  /*! \brief True if the short training sequence should be used. */
167 
168  /*! \brief True if an image carrier appears to have been received, even if it did not successfully
169  train. */
171 
172  /*! \brief A count of the number of bits in the trainability test. This counts down to zero when
173  sending TCF, and counts up when receiving it. */
175  /*! \brief The current count of consecutive received zero bits, during the trainability test. */
177  /*! \brief The maximum consecutive received zero bits seen to date, during the trainability test. */
179 
180  /*! \brief The current fallback step for the fast message transfer modem. */
182  /*! \brief The subset of supported modems allowed at the current time, allowing for negotiation. */
184  /*! \brief True if a carrier is present. Otherwise false. */
186  /*! \brief True if a modem has trained correctly. */
188  /*! \brief True if a valid HDLC frame has been received in the current reception period. */
190 
191  /*! \brief Current reception mode. */
193  /*! \brief Current transmission mode. */
195 
196  /*! \brief T0 is the answer timeout when calling another FAX machine.
197  Placing calls is handled outside the FAX processing, but this timeout keeps
198  running until V.21 modulation is sent or received.
199  T1 is the remote terminal identification timeout (in audio samples). */
201  /*! \brief T2, T2A and T2B are the HDLC command timeouts.
202  T4, T4A and T4B are the HDLC response timeouts (in audio samples). */
204  /*! \brief A value specifying which of the possible timers is currently running in timer_t2_t4 */
206  /*! \brief Procedural interrupt timeout (in audio samples). */
207  int timer_t3;
208  /*! \brief This is only used in error correcting mode. */
209  int timer_t5;
210  /*! \brief This is only used in full duplex (e.g. ISDN) modes. */
211  int timer_t6;
212  /*! \brief This is only used in full duplex (e.g. ISDN) modes. */
213  int timer_t7;
214  /*! \brief This is only used in full duplex (e.g. ISDN) modes. */
215  int timer_t8;
216 
217  /*! \brief True once the far end FAX entity has been detected. */
219 
220  /*! \brief True once the end of procedure condition has been detected. */
222 
223  /*! \brief True if a local T.30 interrupt is pending. */
225  /*! \brief The image coding being used on the line. */
227  /*! \brief The image coding being used for output files. */
229  /*! \brief The current DCS message minimum scan time code. */
231  /*! \brief The X direction resolution of the current image, in pixels per metre. */
233  /*! \brief The Y direction resolution of the current image, in pixels per metre. */
235  /*! \brief The width of the current image, in pixels. */
237  /*! \brief Current number of retries of the action in progress. */
238  int retries;
239  /*! \brief True if error correcting mode is used. */
241  /*! \brief The number of HDLC frame retries, if error correcting mode is used. */
243  /*! \brief The current count of consecutive T30_PPR messages. */
245  /*! \brief The current count of consecutive T30_RNR messages. */
247  /*! \brief The number of octets to be used per ECM frame. */
249  /*! \brief The ECM partial page buffer. */
250  uint8_t ecm_data[256][260];
251  /*! \brief The lengths of the frames in the ECM partial page buffer. */
252  int16_t ecm_len[256];
253  /*! \brief A bit map of the OK ECM frames, constructed as a PPR frame. */
254  uint8_t ecm_frame_map[3 + 32];
255 
256  /*! \brief The current page number for receiving, in ECM or non-ECM mode. This is reset at the start of a call. */
258  /*! \brief The current page number for sending, in ECM or non-ECM mode. This is reset at the start of a call. */
260  /*! \brief The current block number, in ECM mode */
262  /*! \brief The number of frames in the current block number, in ECM mode */
264  /*! \brief The number of frames sent in the current burst of image transmission, in ECM mode */
266  /*! \brief The current ECM frame, during ECM transmission. */
268  /*! \brief True if we are at the end of an ECM page to se sent - i.e. there are no more
269  partial pages still to come. */
271 
272  /*! \brief The last result for a received non-ECM page - T30_MPS, T30_RTP, or T30_RTN. */
274 
275  /*! \brief The transmission step queued to follow the one in progress. */
277  /*! \brief The FCF for the next receive step. */
278  uint8_t next_rx_step;
279  /*! \brief Image file name for image reception. */
280  char rx_file[256];
281  /*! \brief The last page we are prepared accept for a received image file. -1 means no restriction. */
283  /*! \brief Image file name to be sent. */
284  char tx_file[256];
285  /*! \brief The first page to be sent from the image file. -1 means no restriction. */
287  /*! \brief The last page to be sent from the image file. -1 means no restriction. */
289  /*! \brief The current completion status. */
291 
292  /*! \brief the FCF2 field of the last PPS message we received. */
293  uint8_t last_pps_fcf2;
294  /*! \brief True if all frames of the current received ECM block are now OK */
296  /*! \brief A count of successfully received ECM frames, to assess progress as a basis for
297  deciding whether to continue error correction when PPRs keep repeating. */
299 
300  /*! \brief The number of RTP events */
302  /*! \brief The number of RTN events */
304 
305  /*! \brief Error and flow logging control */
307 };
308 
309 #endif
310 /*- End of file ------------------------------------------------------------*/
int far_dis_dtc_len
The length of the last DIS or DTC message received form the far end.
Definition: private/t30.h:161
int timer_t2_t4
T2, T2A and T2B are the HDLC command timeouts. T4, T4A and T4B are the HDLC response timeouts (in aud...
Definition: private/t30.h:203
uint8_t next_rx_step
The FCF for the next receive step.
Definition: private/t30.h:278
uint8_t dcs_frame[T30_MAX_DIS_DTC_DCS_LEN]
The preparation buffer for the DCS message to be transmitted.
Definition: private/t30.h:151
int remote_interrupts_allowed
True if remote T.30 procedural interrupts are allowed.
Definition: private/t30.h:82
int supported_compressions
A bit mask of the currently supported image compression modes.
Definition: private/t30.h:54
void() t30_real_time_frame_handler_t(t30_state_t *s, void *user_data, int direction, const uint8_t msg[], int len)
T.30 real time frame handler.
Definition: t30.h:191
t30_document_handler_t * document_handler
A pointer to a callback routine to be called when document events (e.g. end of transmitted document) ...
Definition: private/t30.h:118
const char * model
The model of the remote machine, if known, else NULL.
Definition: private/t30.h:93
char tx_file[256]
Image file name to be sent.
Definition: private/t30.h:284
int output_encoding
The image coding being used for output files.
Definition: private/t30.h:228
void * send_hdlc_user_data
An opaque pointer passed to the transmitted HDLC frame handler.
Definition: private/t30.h:134
int() t30_document_handler_t(t30_state_t *s, void *user_data, int status)
T.30 document handler.
Definition: t30.h:204
int timer_t0_t1
T0 is the answer timeout when calling another FAX machine. Placing calls is handled outside the FAX p...
Definition: private/t30.h:200
int current_fallback
The current fallback step for the fast message transfer modem.
Definition: private/t30.h:181
char header_info[T30_MAX_PAGE_HEADER_INFO+1]
The text which will be used in FAX page header. No text results in no header line.
Definition: private/t30.h:71
int calling_party
True if behaving as the calling party.
Definition: private/t30.h:47
int rx_stop_page
The last page we are prepared accept for a received image file. -1 means no restriction.
Definition: private/t30.h:282
int tx_page_number
The current page number for sending, in ECM or non-ECM mode. This is reset at the start of a call...
Definition: private/t30.h:259
Definition: private/t30.h:35
uint8_t min_scan_time_code
The current DCS message minimum scan time code.
Definition: private/t30.h:230
uint8_t ecm_data[256][260]
The ECM partial page buffer.
Definition: private/t30.h:250
void * real_time_frame_user_data
An opaque pointer supplied in real time frame callbacks.
Definition: private/t30.h:114
int ecm_frames
The number of frames in the current block number, in ECM mode.
Definition: private/t30.h:263
int next_tx_step
The transmission step queued to follow the one in progress.
Definition: private/t30.h:276
int16_t ecm_len[256]
The lengths of the frames in the ECM partial page buffer.
Definition: private/t30.h:252
t4_image_width_t image_width
The width of the current image, in pixels.
Definition: private/t30.h:236
int tx_stop_page
The last page to be sent from the image file. -1 means no restriction.
Definition: private/t30.h:288
int header_overlays_image
True for FAX page headers to overlay (i.e. replace) the beginning of the page image. False for FAX page headers to add to the overall length of the page.
Definition: private/t30.h:75
int supported_resolutions
A bit mask of the currently supported image resolutions.
Definition: private/t30.h:56
int rtp_events
The number of RTP events.
Definition: private/t30.h:301
uint8_t far_dis_dtc_frame[T30_MAX_DIS_DTC_DCS_LEN]
The last DIS or DTC message received form the far end.
Definition: private/t30.h:159
int timer_t7
This is only used in full duplex (e.g. ISDN) modes.
Definition: private/t30.h:213
t30_phase_e_handler_t * phase_e_handler
A pointer to a callback routine to be called when phase E events occur.
Definition: private/t30.h:107
int tcf_test_bits
A count of the number of bits in the trainability test. This counts down to zero when sending TCF...
Definition: private/t30.h:174
int ecm_block
The current block number, in ECM mode.
Definition: private/t30.h:261
int line_encoding
The image coding being used on the line.
Definition: private/t30.h:226
int short_train
True if the short training sequence should be used.
Definition: private/t30.h:166
int timer_t6
This is only used in full duplex (e.g. ISDN) modes.
Definition: private/t30.h:211
int() t30_phase_b_handler_t(t30_state_t *s, void *user_data, int result)
T.30 phase B callback handler.
Definition: t30.h:161
int local_dis_dtc_len
The length of the DIS or DTC message to be transmitted.
Definition: private/t30.h:157
char rx_dcs_string[T30_MAX_DIS_DTC_DCS_LEN *3+1]
The received DCS, formatted as an ASCII string, for inclusion in the TIFF file.
Definition: private/t30.h:68
int rx_ecm_block_ok
True if all frames of the current received ECM block are now OK.
Definition: private/t30.h:295
void() t30_phase_e_handler_t(t30_state_t *s, void *user_data, int completion_code)
T.30 phase E callback handler.
Definition: t30.h:180
int local_interrupt_pending
True if a local T.30 interrupt is pending.
Definition: private/t30.h:224
t30_set_handler_t * set_tx_type_handler
The handler for changes to the transmit mode.
Definition: private/t30.h:127
int y_resolution
The Y direction resolution of the current image, in pixels per metre.
Definition: private/t30.h:234
int rx_trained
True if a modem has trained correctly.
Definition: private/t30.h:187
#define T30_MAX_DIS_DTC_DCS_LEN
Definition: t30.h:142
t30_real_time_frame_handler_t * real_time_frame_handler
A pointer to a callback routine to be called when frames are exchanged.
Definition: private/t30.h:112
int last_rx_page_result
The last result for a received non-ECM page - T30_MPS, T30_RTP, or T30_RTN.
Definition: private/t30.h:273
int() t30_phase_d_handler_t(t30_state_t *s, void *user_data, int result)
T.30 phase D callback handler.
Definition: t30.h:171
uint8_t local_dis_dtc_frame[T30_MAX_DIS_DTC_DCS_LEN]
The preparation buffer for DIS or DTC message to be transmitted.
Definition: private/t30.h:155
int rtn_events
The number of RTN events.
Definition: private/t30.h:303
t30_exchanged_info_t rx_info
The information fields received.
Definition: private/t30.h:85
union t30_state_s::@57 t4
T.4 context for reading or writing image data.
int current_status
The current completion status.
Definition: private/t30.h:290
logging_state_t logging
Error and flow logging control.
Definition: private/t30.h:306
int current_permitted_modems
The subset of supported modems allowed at the current time, allowing for negotiation.
Definition: private/t30.h:183
int current_rx_type
Current reception mode.
Definition: private/t30.h:192
int image_carrier_attempted
True if an image carrier appears to have been received, even if it did not successfully train...
Definition: private/t30.h:170
char rx_file[256]
Image file name for image reception.
Definition: private/t30.h:280
t30_phase_d_handler_t * phase_d_handler
A pointer to a callback routine to be called when phase D events occur.
Definition: private/t30.h:102
int octets_per_ecm_frame
The number of octets to be used per ECM frame.
Definition: private/t30.h:248
void * set_rx_type_user_data
An opaque pointer passed to the handler for changes to the receive mode.
Definition: private/t30.h:125
int error_correcting_mode_retries
The number of HDLC frame retries, if error correcting mode is used.
Definition: private/t30.h:242
int operation_in_progress
The type of FAX operation currently in progress.
Definition: private/t30.h:44
int supported_modems
A bit mask of the currently supported modem types.
Definition: private/t30.h:52
int current_tx_type
Current transmission mode.
Definition: private/t30.h:194
int step
The step in sending a sequence of HDLC frames.
Definition: private/t30.h:148
int ppr_count
The current count of consecutive T30_PPR messages.
Definition: private/t30.h:244
int phase
The current T.30 phase.
Definition: private/t30.h:142
Definition: private/timezone.h:81
void * phase_e_user_data
An opaque pointer supplied in event E callbacks.
Definition: private/t30.h:109
#define T30_MAX_PAGE_HEADER_INFO
Definition: t30.h:146
int rx_signal_present
True if a carrier is present. Otherwise false.
Definition: private/t30.h:185
void * phase_b_user_data
An opaque pointer supplied in event B callbacks.
Definition: private/t30.h:99
int far_end_detected
True once the far end FAX entity has been detected.
Definition: private/t30.h:218
t4_image_width_t
Definition: t4_rx.h:124
int retries
Current number of retries of the action in progress.
Definition: private/t30.h:238
int ecm_allowed
True is ECM mode handling is enabled.
Definition: private/t30.h:62
void * phase_d_user_data
An opaque pointer supplied in event D callbacks.
Definition: private/t30.h:104
int x_resolution
The X direction resolution of the current image, in pixels per metre.
Definition: private/t30.h:232
int next_phase
The T.30 phase to change to when the current phase ends.
Definition: private/t30.h:144
void * set_tx_type_user_data
An opaque pointer passed to the handler for changes to the transmit mode.
Definition: private/t30.h:129
int ecm_at_page_end
True if we are at the end of an ECM page to se sent - i.e. there are no more partial pages still to c...
Definition: private/t30.h:270
Definition: private/logging.h:33
const char * country
The country of origin of the remote machine, if known, else NULL.
Definition: private/t30.h:89
int dcs_len
The length of the DCS message to be transmitted.
Definition: private/t30.h:153
int rx_page_number
The current page number for receiving, in ECM or non-ECM mode. This is reset at the start of a call...
Definition: private/t30.h:257
int timer_t5
This is only used in error correcting mode.
Definition: private/t30.h:209
uint8_t local_min_scan_time_code
The DIS code for the minimum scan row time we require. This is usually 0ms, but if we are trying to s...
Definition: private/t30.h:139
uint8_t ecm_frame_map[3+32]
A bit map of the OK ECM frames, constructed as a PPR frame.
Definition: private/t30.h:254
t30_send_hdlc_handler_t * send_hdlc_handler
The transmitted HDLC frame handler.
Definition: private/t30.h:132
int timer_t3
Procedural interrupt timeout (in audio samples).
Definition: private/t30.h:207
uint8_t last_pps_fcf2
the FCF2 field of the last PPS message we received.
Definition: private/t30.h:293
int timer_t2_t4_is
A value specifying which of the possible timers is currently running in timer_t2_t4.
Definition: private/t30.h:205
t30_phase_b_handler_t * phase_b_handler
A pointer to a callback routine to be called when phase B events occur.
Definition: private/t30.h:97
tz_t tz
Optional per instance time zone for the FAX page header timestamp.
Definition: private/t30.h:79
t30_set_handler_t * set_rx_type_handler
The handler for changes to the receive mode.
Definition: private/t30.h:123
void() t30_send_hdlc_handler_t(void *user_data, const uint8_t msg[], int len)
T.30 send HDLC handler.
Definition: t30.h:224
int error_correcting_mode
True if error correcting mode is used.
Definition: private/t30.h:240
int use_own_tz
Use private timezone if true.
Definition: private/t30.h:77
int end_of_procedure_detected
True once the end of procedure condition has been detected.
Definition: private/t30.h:221
int supported_t30_features
A bit mask of the currently supported T.30 special features.
Definition: private/t30.h:60
int ecm_current_tx_frame
The current ECM frame, during ECM transmission.
Definition: private/t30.h:267
int ecm_frames_this_tx_burst
The number of frames sent in the current burst of image transmission, in ECM mode.
Definition: private/t30.h:265
int iaf
Internet aware FAX mode bit mask.
Definition: private/t30.h:50
const char * vendor
The vendor of the remote machine, if known, else NULL.
Definition: private/t30.h:91
int tcf_most_zeros
The maximum consecutive received zero bits seen to date, during the trainability test.
Definition: private/t30.h:178
void() t30_set_handler_t(void *user_data, int type, int bit_rate, int short_train, int use_hdlc)
T.30 set a receive or transmit type handler.
Definition: t30.h:215
int ecm_progress
A count of successfully received ECM frames, to assess progress as a basis for deciding whether to co...
Definition: private/t30.h:298
int rx_frame_received
True if a valid HDLC frame has been received in the current reception period.
Definition: private/t30.h:189
int supported_image_sizes
A bit mask of the currently supported image sizes.
Definition: private/t30.h:58
int dis_received
True if a valid DIS has been received from the far end.
Definition: private/t30.h:163
Definition: private/t4_tx.h:35
void * document_user_data
An opaque pointer supplied in document callbacks.
Definition: private/t30.h:120
Definition: t30.h:473
int receiver_not_ready_count
The current count of consecutive T30_RNR messages.
Definition: private/t30.h:246
int retransmit_capable
True if we are capable of retransmitting pages.
Definition: private/t30.h:64
t30_exchanged_info_t tx_info
The information fields to be transmitted.
Definition: private/t30.h:87
int tx_start_page
The first page to be sent from the image file. -1 means no restriction.
Definition: private/t30.h:286
int timer_t8
This is only used in full duplex (e.g. ISDN) modes.
Definition: private/t30.h:215
int state
The current state of the T.30 state machine.
Definition: private/t30.h:146
int tcf_current_zeros
The current count of consecutive received zero bits, during the trainability test.
Definition: private/t30.h:176