spandsp  0.0.6
t31.h
Go to the documentation of this file.
00001 /*
00002  * SpanDSP - a series of DSP components for telephony
00003  *
00004  * t31.h - A T.31 compatible class 1 FAX modem interface.
00005  *
00006  * Written by Steve Underwood <steveu@coppice.org>
00007  *
00008  * Copyright (C) 2004 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 
00026 /*! \file */
00027 
00028 #if !defined(_SPANDSP_T31_H_)
00029 #define _SPANDSP_T31_H_
00030 
00031 /*! \page t31_page T.31 Class 1 FAX modem protocol handling
00032 \section t31_page_sec_1 What does it do?
00033 The T.31 class 1 FAX modem modules implements a class 1 interface to the FAX
00034 modems in spandsp.
00035 
00036 \section t31_page_sec_2 How does it work?
00037 */
00038 
00039 /*!
00040     T.31 descriptor. This defines the working state for a single instance of
00041     a T.31 FAX modem.
00042 */
00043 typedef struct t31_state_s t31_state_t;
00044 
00045 typedef int (t31_modem_control_handler_t)(t31_state_t *s, void *user_data, int op, const char *num);
00046 
00047 #define T31_TX_BUF_LEN          (4096)
00048 #define T31_TX_BUF_HIGH_TIDE    (4096 - 1024)
00049 #define T31_TX_BUF_LOW_TIDE     (1024)
00050 #define T31_MAX_HDLC_LEN        284
00051 #define T31_T38_MAX_HDLC_LEN    260
00052 
00053 #if defined(__cplusplus)
00054 extern "C"
00055 {
00056 #endif
00057 
00058 SPAN_DECLARE(void) t31_call_event(t31_state_t *s, int event);
00059 
00060 SPAN_DECLARE(int) t31_at_rx(t31_state_t *s, const char *t, int len);
00061 
00062 /*! Process a block of received T.31 modem audio samples.
00063     \brief Process a block of received T.31 modem audio samples.
00064     \param s The T.31 modem context.
00065     \param amp The audio sample buffer.
00066     \param len The number of samples in the buffer.
00067     \return The number of samples unprocessed. */
00068 SPAN_DECLARE_NONSTD(int) t31_rx(t31_state_t *s, int16_t amp[], int len);
00069 
00070 /*! Fake processing of a missing block of received T.31 modem audio samples
00071     (e.g due to packet loss).
00072     \brief Fake processing of a missing block of received T.31 modem audio samples.
00073     \param s The T.31 modem context.
00074     \param len The number of samples to fake.
00075     \return The number of samples unprocessed. */
00076 SPAN_DECLARE_NONSTD(int) t31_rx_fillin(t31_state_t *s, int len);
00077 
00078 /*! Generate a block of T.31 modem audio samples.
00079     \brief Generate a block of T.31 modem audio samples.
00080     \param s The T.31 modem context.
00081     \param amp The audio sample buffer.
00082     \param max_len The number of samples to be generated.
00083     \return The number of samples actually generated.
00084 */
00085 SPAN_DECLARE_NONSTD(int) t31_tx(t31_state_t *s, int16_t amp[], int max_len);
00086 
00087 SPAN_DECLARE(int) t31_t38_send_timeout(t31_state_t *s, int samples);
00088 
00089 /*! Select whether silent audio will be sent when transmit is idle.
00090     \brief Select whether silent audio will be sent when transmit is idle.
00091     \param s The T.31 modem context.
00092     \param transmit_on_idle TRUE if silent audio should be output when the transmitter is
00093            idle. FALSE to transmit zero length audio when the transmitter is idle. The default
00094            behaviour is FALSE.
00095 */
00096 SPAN_DECLARE(void) t31_set_transmit_on_idle(t31_state_t *s, int transmit_on_idle);
00097 
00098 /*! Select whether TEP mode will be used (or time allowed for it (when transmitting).
00099     \brief Select whether TEP mode will be used.
00100     \param s The T.31 modem context.
00101     \param use_tep TRUE if TEP is to be ised.
00102 */
00103 SPAN_DECLARE(void) t31_set_tep_mode(t31_state_t *s, int use_tep);
00104 
00105 /*! Select whether T.38 data will be paced as it is transmitted.
00106     \brief Select whether T.38 data will be paced.
00107     \param s The T.31 modem context.
00108     \param without_pacing TRUE if data is to be sent as fast as possible. FALSE if it is
00109            to be paced.
00110 */
00111 SPAN_DECLARE(void) t31_set_t38_config(t31_state_t *s, int without_pacing);
00112 
00113 SPAN_DECLARE(void) t31_set_mode(t31_state_t *s, int t38_mode);
00114 
00115 /*! Get a pointer to the logging context associated with a T.31 context.
00116     \brief Get a pointer to the logging context associated with a T.31 context.
00117     \param s The T.31 context.
00118     \return A pointer to the logging context, or NULL.
00119 */
00120 SPAN_DECLARE(logging_state_t *) t31_get_logging_state(t31_state_t *s);
00121 
00122 SPAN_DECLARE(t38_core_state_t *) t31_get_t38_core_state(t31_state_t *s);
00123 
00124 /*! Initialise a T.31 context. This must be called before the first
00125     use of the context, to initialise its contents.
00126     \brief Initialise a T.31 context.
00127     \param s The T.31 context.
00128     \param at_tx_handler A callback routine to handle AT interpreter channel output.
00129     \param at_tx_user_data An opaque pointer passed in called to at_tx_handler.
00130     \param modem_control_handler A callback routine to handle control of the modem (off-hook, etc).
00131     \param modem_control_user_data An opaque pointer passed in called to modem_control_handler.
00132     \param tx_t38_packet_handler ???
00133     \param tx_t38_packet_user_data ???
00134     \return A pointer to the T.31 context. */
00135 SPAN_DECLARE(t31_state_t *) t31_init(t31_state_t *s,
00136                                      at_tx_handler_t *at_tx_handler,
00137                                      void *at_tx_user_data,
00138                                      t31_modem_control_handler_t *modem_control_handler,
00139                                      void *modem_control_user_data,
00140                                      t38_tx_packet_handler_t *tx_t38_packet_handler,
00141                                      void *tx_t38_packet_user_data);
00142 
00143 /*! Release a T.31 context.
00144     \brief Release a T.31 context.
00145     \param s The T.31 context.
00146     \return 0 for OK */
00147 SPAN_DECLARE(int) t31_release(t31_state_t *s);
00148 
00149 /*! Free a T.31 context.
00150     \brief Release a T.31 context.
00151     \param s The T.31 context.
00152     \return 0 for OK */
00153 SPAN_DECLARE(int) t31_free(t31_state_t *s);
00154 
00155 #if defined(__cplusplus)
00156 }
00157 #endif
00158 
00159 #endif
00160 /*- End of file ------------------------------------------------------------*/