00001 /* 00002 * SpanDSP - a series of DSP components for telephony 00003 * 00004 * t38_core.h - An implementation of T.38, less the packet exchange part 00005 * 00006 * Written by Steve Underwood <steveu@coppice.org> 00007 * 00008 * Copyright (C) 2005 Steve Underwood 00009 * 00010 * All rights reserved. 00011 * 00012 * This program is free software; you can redistribute it and/or modify 00013 * it under the terms of the GNU Lesser General Public License version 2.1, 00014 * as published by the Free Software Foundation. 00015 * 00016 * This program is distributed in the hope that it will be useful, 00017 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00019 * GNU Lesser General Public License for more details. 00020 * 00021 * You should have received a copy of the GNU Lesser General Public 00022 * License along with this program; if not, write to the Free Software 00023 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00024 * 00025 * $Id: t38_core.h,v 1.29 2008/09/04 14:40:05 steveu Exp $ 00026 */ 00027 00028 /*! \file */ 00029 00030 #if !defined(_SPANDSP_T38_CORE_H_) 00031 #define _SPANDSP_T38_CORE_H_ 00032 00033 /*! \page t38_core_page T.38 real time FAX over IP message handling 00034 There are two ITU recommendations which address sending FAXes over IP networks. T.37 specifies a 00035 method of encapsulating FAX images in e-mails, and transporting them to the recipient (an e-mail 00036 box, or another FAX machine) in a store-and-forward manner. T.38 defines a protocol for 00037 transmitting a FAX across an IP network in real time. The core T.38 modules implements the basic 00038 message handling for the T.38, real time, FAX over IP (FoIP) protocol. 00039 00040 The T.38 protocol can operate between: 00041 - Internet-aware FAX terminals, which connect directly to an IP network. The T.38 terminal module 00042 extends this module to provide a complete T.38 terminal. 00043 - FAX gateways, which allow traditional PSTN FAX terminals to communicate through the Internet. 00044 The T.38 gateway module extends this module to provide a T.38 gateway. 00045 - A combination of terminals and gateways. 00046 00047 T.38 is the only standardised protocol which exists for real-time FoIP. Reliably transporting a 00048 FAX between PSTN FAX terminals, through an IP network, requires use of the T.38 protocol at FAX 00049 gateways. VoIP connections are not robust for modem use, including FAX modem use. Most use low 00050 bit rate codecs, which cannot convey the modem signals accurately. Even when high bit rate 00051 codecs are used, VoIP connections suffer dropouts and timing adjustments, which modems cannot 00052 tolerate. In a LAN environment the dropout rate may be very low, but the timing adjustments which 00053 occur in VoIP connections still make modem operation unreliable. T.38 FAX gateways deal with the 00054 delays, timing jitter, and packet loss experienced in packet networks, and isolate the PSTN FAX 00055 terminals from these as far as possible. In addition, by sending FAXes as image data, rather than 00056 digitised audio, they reduce the required bandwidth of the IP network. 00057 00058 \section t38_core_page_sec_1 What does it do? 00059 00060 \section t38_core_page_sec_2 How does it work? 00061 00062 Timing differences and jitter between two T.38 entities can be a serious problem, if one of those 00063 entities is a PSTN gateway. 00064 00065 Flow control for non-ECM image data takes advantage of several features of the T.30 specification. 00066 First, an unspecified number of 0xFF octets may be sent at the start of transmission. This means we 00067 can add endless extra 0xFF bytes at this point, without breaking the T.30 spec. In practice, we 00068 cannot add too many, or we will affect the timing tolerance of the T.30 protocol by delaying the 00069 response at the end of each image. Secondly, just before an end of line (EOL) marker we can pad 00070 with zero bits. Again, the number is limited only by need to avoid upsetting the timing of the 00071 step following the non-ECM data. 00072 */ 00073 00074 /*! T.38 indicator types */ 00075 enum t30_indicator_types_e 00076 { 00077 T38_IND_NO_SIGNAL = 0, 00078 T38_IND_CNG, 00079 T38_IND_CED, 00080 T38_IND_V21_PREAMBLE, 00081 T38_IND_V27TER_2400_TRAINING, 00082 T38_IND_V27TER_4800_TRAINING, 00083 T38_IND_V29_7200_TRAINING, 00084 T38_IND_V29_9600_TRAINING, 00085 T38_IND_V17_7200_SHORT_TRAINING, 00086 T38_IND_V17_7200_LONG_TRAINING, 00087 T38_IND_V17_9600_SHORT_TRAINING, 00088 T38_IND_V17_9600_LONG_TRAINING, 00089 T38_IND_V17_12000_SHORT_TRAINING, 00090 T38_IND_V17_12000_LONG_TRAINING, 00091 T38_IND_V17_14400_SHORT_TRAINING, 00092 T38_IND_V17_14400_LONG_TRAINING, 00093 T38_IND_V8_ANSAM, 00094 T38_IND_V8_SIGNAL, 00095 T38_IND_V34_CNTL_CHANNEL_1200, 00096 T38_IND_V34_PRI_CHANNEL, 00097 T38_IND_V34_CC_RETRAIN, 00098 T38_IND_V33_12000_TRAINING, 00099 T38_IND_V33_14400_TRAINING 00100 }; 00101 00102 /*! T.38 data types */ 00103 enum t38_data_types_e 00104 { 00105 T38_DATA_NONE = -1, 00106 T38_DATA_V21 = 0, 00107 T38_DATA_V27TER_2400, 00108 T38_DATA_V27TER_4800, 00109 T38_DATA_V29_7200, 00110 T38_DATA_V29_9600, 00111 T38_DATA_V17_7200, 00112 T38_DATA_V17_9600, 00113 T38_DATA_V17_12000, 00114 T38_DATA_V17_14400, 00115 T38_DATA_V8, 00116 T38_DATA_V34_PRI_RATE, 00117 T38_DATA_V34_CC_1200, 00118 T38_DATA_V34_PRI_CH, 00119 T38_DATA_V33_12000, 00120 T38_DATA_V33_14400 00121 }; 00122 00123 /*! T.38 data field types */ 00124 enum t38_field_types_e 00125 { 00126 T38_FIELD_HDLC_DATA = 0, 00127 T38_FIELD_HDLC_SIG_END, 00128 T38_FIELD_HDLC_FCS_OK, 00129 T38_FIELD_HDLC_FCS_BAD, 00130 T38_FIELD_HDLC_FCS_OK_SIG_END, 00131 T38_FIELD_HDLC_FCS_BAD_SIG_END, 00132 T38_FIELD_T4_NON_ECM_DATA, 00133 T38_FIELD_T4_NON_ECM_SIG_END, 00134 T38_FIELD_CM_MESSAGE, 00135 T38_FIELD_JM_MESSAGE, 00136 T38_FIELD_CI_MESSAGE, 00137 T38_FIELD_V34RATE 00138 }; 00139 00140 /*! T.38 field classes */ 00141 enum t38_field_classes_e 00142 { 00143 T38_FIELD_CLASS_NONE = 0, 00144 T38_FIELD_CLASS_HDLC, 00145 T38_FIELD_CLASS_NON_ECM 00146 }; 00147 00148 /*! T.38 message types */ 00149 enum t38_message_types_e 00150 { 00151 T38_TYPE_OF_MSG_T30_INDICATOR = 0, 00152 T38_TYPE_OF_MSG_T30_DATA 00153 }; 00154 00155 /*! T.38 transport types */ 00156 enum t38_transport_types_e 00157 { 00158 T38_TRANSPORT_UDPTL = 0, 00159 T38_TRANSPORT_RTP, 00160 T38_TRANSPORT_TCP 00161 }; 00162 00163 #define T38_RX_BUF_LEN 2048 00164 #define T38_TX_BUF_LEN 16384 00165 00166 /*! T.38 data field */ 00167 typedef struct 00168 { 00169 int field_type; 00170 const uint8_t *field; 00171 int field_len; 00172 } t38_data_field_t; 00173 00174 typedef struct t38_core_state_s t38_core_state_t; 00175 00176 typedef int (t38_tx_packet_handler_t)(t38_core_state_t *s, void *user_data, const uint8_t *buf, int len, int count); 00177 00178 typedef int (t38_rx_indicator_handler_t)(t38_core_state_t *s, void *user_data, int indicator); 00179 typedef int (t38_rx_data_handler_t)(t38_core_state_t *s, void *user_data, int data_type, int field_type, const uint8_t *buf, int len); 00180 typedef int (t38_rx_missing_handler_t)(t38_core_state_t *s, void *user_data, int rx_seq_no, int expected_seq_no); 00181 00182 /*! 00183 Core T.38 state, common to all modes of T.38. 00184 */ 00185 struct t38_core_state_s 00186 { 00187 /*! Handler routine to transmit IFP packets generated by the T.38 protocol engine */ 00188 t38_tx_packet_handler_t *tx_packet_handler; 00189 /*! An opaque pointer passed to tx_packet_handler */ 00190 void *tx_packet_user_data; 00191 00192 /*! Handler routine to process received indicator packets */ 00193 t38_rx_indicator_handler_t *rx_indicator_handler; 00194 /*! Handler routine to process received data packets */ 00195 t38_rx_data_handler_t *rx_data_handler; 00196 /*! Handler routine to process the missing packet condition */ 00197 t38_rx_missing_handler_t *rx_missing_handler; 00198 /*! An opaque pointer passed to any of the above receive handling routines */ 00199 void *rx_user_data; 00200 00201 /*! NOTE - Bandwidth reduction shall only be done on suitable Phase C data, i.e., MH, MR 00202 and - in the case of transcoding to JBIG - MMR. MMR and JBIG require reliable data 00203 transport such as that provided by TCP. When transcoding is selected, it shall be 00204 applied to every suitable page in a call. */ 00205 00206 /*! Method 1: Local generation of TCF (required for use with TCP). 00207 Method 2: Transfer of TCF is required for use with UDP (UDPTL or RTP). 00208 Method 2 is not recommended for use with TCP. */ 00209 int data_rate_management_method; 00210 00211 /*! The emitting gateway may indicate a preference for either UDP/UDPTL, or 00212 UDP/RTP, or TCP for transport of T.38 IFP Packets. The receiving device 00213 selects the transport protocol. */ 00214 int data_transport_protocol; 00215 00216 /*! Indicates the capability to remove and insert fill bits in Phase C, non-ECM 00217 data to reduce bandwidth in the packet network. */ 00218 int fill_bit_removal; 00219 00220 /*! Indicates the ability to convert to/from MMR from/to the line format to 00221 improve the compression of the data, and reduce the bandwidth, in the 00222 packet network. */ 00223 int mmr_transcoding; 00224 00225 /*! Indicates the ability to convert to/from JBIG to reduce bandwidth. */ 00226 int jbig_transcoding; 00227 00228 /*! For UDP (UDPTL or RTP) modes, this option indicates the maximum 00229 number of octets that can be stored on the remote device before an overflow 00230 condition occurs. It is the responsibility of the transmitting application to 00231 limit the transfer rate to prevent an overflow. The negotiated data rate 00232 should be used to determine the rate at which data is being removed from 00233 the buffer. */ 00234 int max_buffer_size; 00235 00236 /*! This option indicates the maximum size of a UDPTL packet or the 00237 maximum size of the payload within an RTP packet that can be accepted by 00238 the remote device. */ 00239 int max_datagram_size; 00240 00241 /*! This is the version number of ITU-T Rec. T.38. New versions shall be 00242 compatible with previous versions. */ 00243 int t38_version; 00244 00245 /*! The fastest data rate supported by the T.38 channel. */ 00246 int fastest_image_data_rate; 00247 00248 /*! \brief The number of times an indicator packet will be sent. Numbers greater than one 00249 will increase reliability for UDP transmission. Zero is valid, to suppress all 00250 indicator packets for TCP transmission. */ 00251 int indicator_tx_count; 00252 00253 /*! \brief The number of times a data packet which does not end transmission will be sent. 00254 Numbers greater than one will increase reliability for UDP transmission. Zero 00255 is not valid. */ 00256 int data_tx_count; 00257 00258 /*! \brief The number of times a data packet which ends transmission will be sent. Numbers 00259 greater than one will increase reliability for UDP transmission. Zero is not valid. */ 00260 int data_end_tx_count; 00261 00262 /*! TRUE if IFP packet sequence numbers are relevant. For some transports, like TPKT 00263 over TCP they are not relevent. */ 00264 int check_sequence_numbers; 00265 00266 /*! The sequence number for the next packet to be transmitted */ 00267 int tx_seq_no; 00268 /*! The sequence number expected in the next received packet */ 00269 int rx_expected_seq_no; 00270 00271 /*! The current receive indicator - i.e. the last indicator received */ 00272 int current_rx_indicator; 00273 /*! The current receive data type - i.e. the last data type received */ 00274 int current_rx_data_type; 00275 /*! The current receive field type - i.e. the last field_type received */ 00276 int current_rx_field_type; 00277 /*! The current transmit indicator - i.e. the last indicator transmitted */ 00278 int current_tx_indicator; 00279 /*! The bit rate for V.34 operation */ 00280 int v34_rate; 00281 00282 /*! A count of missing receive packets. This count might not be accurate if the 00283 received packet numbers jump wildly. */ 00284 int missing_packets; 00285 00286 logging_state_t logging; 00287 }; 00288 00289 #if defined(__cplusplus) 00290 extern "C" 00291 { 00292 #endif 00293 00294 /*! \brief Convert the code for an indicator to a short text name. 00295 \param indicator The type of indicator. 00296 \return A pointer to a short text name for the indicator. */ 00297 const char *t38_indicator_to_str(int indicator); 00298 00299 /*! \brief Convert the code for a type of data to a short text name. 00300 \param data_type The data type. 00301 \return A pointer to a short text name for the data type. */ 00302 const char *t38_data_type_to_str(int data_type); 00303 00304 /*! \brief Convert the code for a type of data field to a short text name. 00305 \param field_type The field type. 00306 \return A pointer to a short text name for the field type. */ 00307 const char *t38_field_type_to_str(int field_type); 00308 00309 /*! \brief Convert the code for a CM profile code to text description. 00310 \param profile The profile code from a CM message. 00311 \return A pointer to a short text description of the profile. */ 00312 const char *t38_cm_profile_to_str(int profile); 00313 00314 /*! \brief Convert a JM message code to text description. 00315 \param data The data field of the message. 00316 \param len The length of the data field. 00317 \return A pointer to a short text description of the profile. */ 00318 const char *t38_jm_to_str(const uint8_t *data, int len); 00319 00320 /*! \brief Convert a V34rate message to an actual bit rate. 00321 \param data The data field of the message. 00322 \param len The length of the data field. 00323 \return The bit rate, or -1 for a bad message. */ 00324 int t38_v34rate_to_bps(const uint8_t *data, int len); 00325 00326 /*! \brief Send an indicator packet 00327 \param s The T.38 context. 00328 \param indicator The indicator to send. 00329 \param count The number of copies of the packet to send. 00330 \return ??? */ 00331 int t38_core_send_indicator(t38_core_state_t *s, int indicator, int count); 00332 00333 /*! \brief Send a data packet 00334 \param s The T.38 context. 00335 \param data_type The packet's data type. 00336 \param field_type The packet's field type. 00337 \param field The message data content for the packet. 00338 \param field_len The length of the message data, in bytes. 00339 \param count The number of copies of the packet to send. 00340 \return ??? */ 00341 int t38_core_send_data(t38_core_state_t *s, int data_type, int field_type, const uint8_t field[], int field_len, int count); 00342 00343 /*! \brief Send a data packet 00344 \param s The T.38 context. 00345 \param data_type The packet's data type. 00346 \param field The list of fields. 00347 \param fields The number of fields in the list. 00348 \param count The number of copies of the packet to send. 00349 \return ??? */ 00350 int t38_core_send_data_multi_field(t38_core_state_t *s, int data_type, const t38_data_field_t field[], int fields, int count); 00351 00352 /*! \brief Process a received T.38 IFP packet. 00353 \param s The T.38 context. 00354 \param buf The packet contents. 00355 \param len The length of the packet contents. 00356 \param seq_no The packet sequence number. 00357 \return 0 for OK, else -1. */ 00358 int t38_core_rx_ifp_packet(t38_core_state_t *s, const uint8_t *buf, int len, uint16_t seq_no); 00359 00360 /*! Set the method to be used for data rate management, as per the T.38 spec. 00361 \param s The T.38 context. 00362 \param method 1 for pass TCF across the T.38 link, 2 for handle TCF locally. 00363 */ 00364 void t38_set_data_rate_management_method(t38_core_state_t *s, int method); 00365 00366 /*! Set the data transport protocol. 00367 \param s The T.38 context. 00368 \param data_transport_protocol UDPTL, RTP or TPKT. 00369 */ 00370 void t38_set_data_transport_protocol(t38_core_state_t *s, int data_transport_protocol); 00371 00372 /*! Set the non-ECM fill bit removal mode. 00373 \param s The T.38 context. 00374 \param fill_bit_removal TRUE to remove fill bits across the T.38 link, else FALSE. 00375 */ 00376 void t38_set_fill_bit_removal(t38_core_state_t *s, int fill_bit_removal); 00377 00378 /*! Set the MMR transcoding mode. 00379 \param s The T.38 context. 00380 \param mmr_transcoding TRUE to transcode to MMR across the T.38 link, else FALSE. 00381 */ 00382 void t38_set_mmr_transcoding(t38_core_state_t *s, int mmr_transcoding); 00383 00384 /*! Set the JBIG transcoding mode. 00385 \param s The T.38 context. 00386 \param jbig_transcoding TRUE to transcode to JBIG across the T.38 link, else FALSE. 00387 */ 00388 void t38_set_jbig_transcoding(t38_core_state_t *s, int jbig_transcoding); 00389 00390 void t38_set_max_buffer_size(t38_core_state_t *s, int max_buffer_size); 00391 00392 void t38_set_max_datagram_size(t38_core_state_t *s, int max_datagram_size); 00393 00394 int t38_get_fastest_image_data_rate(t38_core_state_t *s); 00395 00396 /*! Set the T.38 version to be emulated. 00397 \param s The T.38 context. 00398 \param t38_version Version number, as in the T.38 spec. 00399 */ 00400 void t38_set_t38_version(t38_core_state_t *s, int t38_version); 00401 00402 /* Set the sequence number handling option. 00403 \param s The T.38 context. 00404 \param check TRUE to check sequence numbers, and handle gaps reasonably. FALSE 00405 for no sequence number processing (e.g. for TPKT over TCP transport). 00406 */ 00407 void t38_set_sequence_number_handling(t38_core_state_t *s, int check); 00408 00409 t38_core_state_t *t38_core_init(t38_core_state_t *s, 00410 t38_rx_indicator_handler_t *rx_indicator_handler, 00411 t38_rx_data_handler_t *rx_data_handler, 00412 t38_rx_missing_handler_t *rx_missing_handler, 00413 void *rx_user_data, 00414 t38_tx_packet_handler_t tx_packet_handler, 00415 void *tx_packet_user_data); 00416 00417 #if defined(__cplusplus) 00418 } 00419 #endif 00420 00421 #endif 00422 /*- End of file ------------------------------------------------------------*/