spandsp 0.0.6
v22bis.h
Go to the documentation of this file.
00001 /*
00002  * SpanDSP - a series of DSP components for telephony
00003  *
00004  * v22bis.h - ITU V.22bis modem
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  * $Id: v22bis.h,v 1.46 2009/11/04 15:52:06 steveu Exp $
00026  */
00027 
00028 /*! \file */
00029 
00030 /*! \page v22bis_page The V.22bis modem
00031 \section v22bis_page_sec_1 What does it do?
00032 The V.22bis modem is a duplex modem for general data use on the PSTN, at rates
00033 of 1200 and 2400 bits/second. It is a compatible extension of the V.22 modem,
00034 which is a 1200 bits/second only design. It is a band-split design, using carriers
00035 of 1200Hz and 2400Hz. It is the fastest PSTN modem in general use which does not
00036 use echo-cancellation.
00037 
00038 \section v22bis__page_sec_2 How does it work?
00039 V.22bis uses 4PSK modulation at 1200 bits/second or 16QAM modulation at 2400
00040 bits/second. At 1200bps the symbols are so long that a fixed compromise equaliser
00041 is sufficient to recover the 4PSK signal reliably. At 2400bps an adaptive
00042 equaliser is necessary.
00043 
00044 The V.22bis training sequence includes sections which allow the modems to determine
00045 if the far modem can support (or is willing to support) 2400bps operation. The
00046 modems will automatically use 2400bps if both ends are willing to use that speed,
00047 or 1200bps if one or both ends to not acknowledge that 2400bps is OK.
00048 */
00049 
00050 #if !defined(_SPANDSP_V22BIS_H_)
00051 #define _SPANDSP_V22BIS_H_
00052 
00053 enum
00054 {
00055     V22BIS_GUARD_TONE_NONE,
00056     V22BIS_GUARD_TONE_550HZ,
00057     V22BIS_GUARD_TONE_1800HZ
00058 };
00059 
00060 /*!
00061     V.22bis modem descriptor. This defines the working state for a single instance
00062     of a V.22bis modem.
00063 */
00064 typedef struct v22bis_state_s v22bis_state_t;
00065 
00066 extern const complexf_t v22bis_constellation[16];
00067 
00068 #if defined(__cplusplus)
00069 extern "C"
00070 {
00071 #endif
00072 
00073 /*! Process a block of received V.22bis modem audio samples.
00074     \brief Process a block of received V.22bis modem audio samples.
00075     \param s The modem context.
00076     \param amp The audio sample buffer.
00077     \param len The number of samples in the buffer.
00078     \return The number of samples unprocessed. */
00079 SPAN_DECLARE_NONSTD(int) v22bis_rx(v22bis_state_t *s, const int16_t amp[], int len);
00080 
00081 /*! Fake processing of a missing block of received V.22bis modem audio samples.
00082     (e.g due to packet loss).
00083     \brief Fake processing of a missing block of received V.22bis modem audio samples.
00084     \param s The modem context.
00085     \param len The number of samples to fake.
00086     \return The number of samples unprocessed. */
00087 SPAN_DECLARE(int) v22bis_rx_fillin(v22bis_state_t *s, int len);
00088 
00089 /*! Get a snapshot of the current equalizer coefficients.
00090     \brief Get a snapshot of the current equalizer coefficients.
00091     \param coeffs The vector of complex coefficients.
00092     \return The number of coefficients in the vector. */
00093 SPAN_DECLARE(int) v22bis_rx_equalizer_state(v22bis_state_t *s, complexf_t **coeffs);
00094 
00095 /*! Get the current received carrier frequency.
00096     \param s The modem context.
00097     \return The frequency, in Hertz. */
00098 SPAN_DECLARE(float) v22bis_rx_carrier_frequency(v22bis_state_t *s);
00099 
00100 /*! Get the current symbol timing correction since startup.
00101     \param s The modem context.
00102     \return The correction. */
00103 SPAN_DECLARE(float) v22bis_rx_symbol_timing_correction(v22bis_state_t *s);
00104 
00105 /*! Get a current received signal power.
00106     \param s The modem context.
00107     \return The signal power, in dBm0. */
00108 SPAN_DECLARE(float) v22bis_rx_signal_power(v22bis_state_t *s);
00109 
00110 /*! Set the power level at which the carrier detection will cut in
00111     \param s The modem context.
00112     \param cutoff The signal cutoff power, in dBm0. */
00113 SPAN_DECLARE(void) v22bis_rx_signal_cutoff(v22bis_state_t *s, float cutoff);
00114 
00115 /*! Set a handler routine to process QAM status reports
00116     \param s The modem context.
00117     \param handler The handler routine.
00118     \param user_data An opaque pointer passed to the handler routine. */
00119 SPAN_DECLARE(void) v22bis_rx_set_qam_report_handler(v22bis_state_t *s, qam_report_handler_t handler, void *user_data);
00120 
00121 /*! Generate a block of V.22bis modem audio samples.
00122     \brief Generate a block of V.22bis modem audio samples.
00123     \param s The modem context.
00124     \param amp The audio sample buffer.
00125     \param len The number of samples to be generated.
00126     \return The number of samples actually generated. */
00127 SPAN_DECLARE_NONSTD(int) v22bis_tx(v22bis_state_t *s, int16_t amp[], int len);
00128 
00129 /*! Adjust a V.22bis modem transmit context's power output.
00130     \brief Adjust a V.22bis modem transmit context's output power.
00131     \param s The modem context.
00132     \param power The power level, in dBm0 */
00133 SPAN_DECLARE(void) v22bis_tx_power(v22bis_state_t *s, float power);
00134 
00135 /*! Reinitialise an existing V.22bis modem context, so it may be reused.
00136     \brief Reinitialise an existing V.22bis modem context.
00137     \param s The modem context.
00138     \param bit_rate The bit rate of the modem. Valid values are 1200 and 2400.
00139     \return 0 for OK, -1 for bad parameter. */
00140 SPAN_DECLARE(int) v22bis_restart(v22bis_state_t *s, int bit_rate);
00141 
00142 /*! Request a retrain for a V.22bis modem context. A rate change may also be requested.
00143     \brief Request a retrain for a V.22bis modem context.
00144     \param s The modem context.
00145     \param bit_rate The bit rate of the modem. Valid values are 1200 and 2400.
00146     \return 0 for OK, -1 for request rejected. */
00147 SPAN_DECLARE(int) v22bis_request_retrain(v22bis_state_t *s, int bit_rate);
00148 
00149 /*! Request a loopback 2 for a V.22bis modem context.
00150     \brief Request a loopback 2 for a V.22bis modem context.
00151     \param s The modem context.
00152     \param enable TRUE to enable loopback, or FALSE to disable it.
00153     \return 0 for OK, -1 for request reject. */
00154 SPAN_DECLARE(int) v22bis_remote_loopback(v22bis_state_t *s, int enable);
00155 
00156 /*! Report the current operating bit rate of a V.22bis modem context.
00157     \brief Report the current operating bit rate of a V.22bis modem context
00158     \param s The modem context. */
00159 SPAN_DECLARE(int) v22bis_current_bit_rate(v22bis_state_t *s);
00160 
00161 /*! Initialise a V.22bis modem context. This must be called before the first
00162     use of the context, to initialise its contents.
00163     \brief Initialise a V.22bis modem context.
00164     \param s The modem context.
00165     \param bit_rate The bit rate of the modem. Valid values are 1200 and 2400.
00166     \param guard The guard tone option. 0 = none, 1 = 550Hz, 2 = 1800Hz.
00167     \param calling_party TRUE if this is the calling modem.
00168     \param get_bit The callback routine used to get the data to be transmitted.
00169     \param put_bit The callback routine used to get the data to be transmitted.
00170     \param user_data An opaque pointer, passed in calls to the get and put routines.
00171     \return A pointer to the modem context, or NULL if there was a problem. */
00172 SPAN_DECLARE(v22bis_state_t *) v22bis_init(v22bis_state_t *s,
00173                                            int bit_rate,
00174                                            int guard,
00175                                            int calling_party,
00176                                            get_bit_func_t get_bit,
00177                                            void *get_bit_user_data,
00178                                            put_bit_func_t put_bit,
00179                                            void *put_bit_user_data);
00180 
00181 /*! Release a V.22bis modem receive context.
00182     \brief Release a V.22bis modem receive context.
00183     \param s The modem context.
00184     \return 0 for OK */
00185 SPAN_DECLARE(int) v22bis_release(v22bis_state_t *s);
00186 
00187 /*! Free a V.22bis modem receive context.
00188     \brief Free a V.22bis modem receive context.
00189     \param s The modem context.
00190     \return 0 for OK */
00191 SPAN_DECLARE(int) v22bis_free(v22bis_state_t *s);
00192 
00193 /*! Get the logging context associated with a V.22bis modem context.
00194     \brief Get the logging context associated with a V.22bis modem context.
00195     \param s The modem context.
00196     \return A pointer to the logging context */
00197 SPAN_DECLARE(logging_state_t *) v22bis_get_logging_state(v22bis_state_t *s);
00198 
00199 /*! Change the get_bit function associated with a V.22bis modem context.
00200     \brief Change the get_bit function associated with a V.22bis modem context.
00201     \param s The modem context.
00202     \param get_bit The callback routine used to get the data to be transmitted.
00203     \param user_data An opaque pointer. */
00204 SPAN_DECLARE(void) v22bis_set_get_bit(v22bis_state_t *s, get_bit_func_t get_bit, void *user_data);
00205 
00206 /*! Change the get_bit function associated with a V.22bis modem context.
00207     \brief Change the put_bit function associated with a V.22bis modem context.
00208     \param s The modem context.
00209     \param put_bit The callback routine used to process the data received.
00210     \param user_data An opaque pointer. */
00211 SPAN_DECLARE(void) v22bis_set_put_bit(v22bis_state_t *s, put_bit_func_t put_bit, void *user_data);
00212 
00213 /*! Change the modem status report function associated with a V.22bis modem receive context.
00214     \brief Change the modem status report function associated with a V.22bis modem receive context.
00215     \param s The modem context.
00216     \param handler The callback routine used to report modem status changes.
00217     \param user_data An opaque pointer. */
00218 SPAN_DECLARE(void) v22bis_set_modem_status_handler(v22bis_state_t *s, modem_rx_status_func_t handler, void *user_data);
00219 
00220 #if defined(__cplusplus)
00221 }
00222 #endif
00223 
00224 #endif
00225 /*- End of file ------------------------------------------------------------*/