00001 /* 00002 * SpanDSP - a series of DSP components for telephony 00003 * 00004 * v27ter_rx.h - ITU V.27ter modem receive part 00005 * 00006 * Written by Steve Underwood <steveu@coppice.org> 00007 * 00008 * Copyright (C) 2003 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: v27ter_rx.h,v 1.53 2008/09/18 14:59:30 steveu Exp $ 00026 */ 00027 00028 /*! \file */ 00029 00030 #if !defined(_V27TER_RX_H_) 00031 #define _V27TER_RX_H_ 00032 00033 /*! \page v27ter_rx_page The V.27ter receiver 00034 00035 \section v27ter_rx_page_sec_1 What does it do? 00036 The V.27ter receiver implements the receive side of a V.27ter modem. This can operate 00037 at data rates of 4800 and 2400 bits/s. The audio input is a stream of 16 bit samples, 00038 at 8000 samples/second. The transmit and receive side of V.27ter modems operate 00039 independantly. V.27ter is mostly used for FAX transmission, where it provides the 00040 standard 4800 bits/s rate (the 2400 bits/s mode is not used for FAX). 00041 00042 \section v27ter_rx_page_sec_2 How does it work? 00043 V.27ter defines two modes of operation. One uses 8-PSK at 1600 baud, giving 4800bps. 00044 The other uses 4-PSK at 1200 baud, giving 2400bps. A training sequence is specified 00045 at the start of transmission, which makes the design of a V.27ter receiver relatively 00046 straightforward. 00047 */ 00048 00049 /* Target length for the equalizer is about 43 taps for 4800bps and 32 taps for 2400bps 00050 to deal with the worst stuff in V.56bis. */ 00051 #define V27TER_EQUALIZER_PRE_LEN 16 /* This much before the real event */ 00052 #define V27TER_EQUALIZER_POST_LEN 14 /* This much after the real event (must be even) */ 00053 00054 #define V27TER_RX_4800_FILTER_STEPS 27 00055 #define V27TER_RX_2400_FILTER_STEPS 27 00056 00057 #if V27TER_RX_4800_FILTER_STEPS > V27TER_RX_2400_FILTER_STEPS 00058 #define V27TER_RX_FILTER_STEPS V27TER_RX_4800_FILTER_STEPS 00059 #else 00060 #define V27TER_RX_FILTER_STEPS V27TER_RX_2400_FILTER_STEPS 00061 #endif 00062 00063 /*! 00064 V.27ter modem receive side descriptor. This defines the working state for a 00065 single instance of a V.27ter modem receiver. 00066 */ 00067 typedef struct 00068 { 00069 /*! \brief The bit rate of the modem. Valid values are 2400 and 4800. */ 00070 int bit_rate; 00071 /*! \brief The callback function used to put each bit received. */ 00072 put_bit_func_t put_bit; 00073 /*! \brief A user specified opaque pointer passed to the put_bit routine. */ 00074 void *put_bit_user_data; 00075 00076 /*! \brief The callback function used to report modem status changes. */ 00077 modem_rx_status_func_t status_handler; 00078 /*! \brief A user specified opaque pointer passed to the status function. */ 00079 void *status_user_data; 00080 00081 /*! \brief A callback function which may be enabled to report every symbol's 00082 constellation position. */ 00083 qam_report_handler_t qam_report; 00084 /*! \brief A user specified opaque pointer passed to the qam_report callback 00085 routine. */ 00086 void *qam_user_data; 00087 00088 /*! \brief The route raised cosine (RRC) pulse shaping filter buffer. */ 00089 #if defined(SPANDSP_USE_FIXED_POINT) 00090 int16_t rrc_filter[V27TER_RX_FILTER_STEPS]; 00091 #else 00092 float rrc_filter[V27TER_RX_FILTER_STEPS]; 00093 #endif 00094 /*! \brief Current offset into the RRC pulse shaping filter buffer. */ 00095 int rrc_filter_step; 00096 00097 /*! \brief The register for the training and data scrambler. */ 00098 unsigned int scramble_reg; 00099 /*! \brief A counter for the number of consecutive bits of repeating pattern through 00100 the scrambler. */ 00101 int scrambler_pattern_count; 00102 /*! \brief The current step in the table of BC constellation positions. */ 00103 int training_bc; 00104 /*! \brief TRUE if the previous trained values are to be reused. */ 00105 int old_train; 00106 /*! \brief The section of the training data we are currently in. */ 00107 int training_stage; 00108 /*! \brief A count of how far through the current training step we are. */ 00109 int training_count; 00110 /*! \brief A measure of how much mismatch there is between the real constellation, 00111 and the decoded symbol positions. */ 00112 float training_error; 00113 /*! \brief The value of the last signal sample, using the a simple HPF for signal power estimation. */ 00114 int16_t last_sample; 00115 /*! \brief >0 if a signal above the minimum is present. It may or may not be a V.27ter signal. */ 00116 int signal_present; 00117 /*! \brief Whether or not a carrier drop was detected and the signal delivery is pending. */ 00118 int carrier_drop_pending; 00119 /*! \brief A count of the current consecutive samples below the carrier off threshold. */ 00120 int low_samples; 00121 /*! \brief A highest magnitude sample seen. */ 00122 int16_t high_sample; 00123 00124 /*! \brief The position of the current symbol in the constellation, used for 00125 differential decoding. */ 00126 int constellation_state; 00127 00128 /*! \brief The current phase of the carrier (i.e. the DDS parameter). */ 00129 uint32_t carrier_phase; 00130 /*! \brief The update rate for the phase of the carrier (i.e. the DDS increment). */ 00131 int32_t carrier_phase_rate; 00132 /*! \brief The carrier update rate saved for reuse when using short training. */ 00133 int32_t carrier_phase_rate_save; 00134 #if defined(SPANDSP_USE_FIXED_POINTx) 00135 /*! \brief The proportional part of the carrier tracking filter. */ 00136 float carrier_track_p; 00137 /*! \brief The integral part of the carrier tracking filter. */ 00138 float carrier_track_i; 00139 #else 00140 /*! \brief The proportional part of the carrier tracking filter. */ 00141 float carrier_track_p; 00142 /*! \brief The integral part of the carrier tracking filter. */ 00143 float carrier_track_i; 00144 #endif 00145 00146 /*! \brief A power meter, to measure the HPF'ed signal power in the channel. */ 00147 power_meter_t power; 00148 /*! \brief The power meter level at which carrier on is declared. */ 00149 int32_t carrier_on_power; 00150 /*! \brief The power meter level at which carrier off is declared. */ 00151 int32_t carrier_off_power; 00152 00153 /*! \brief Current read offset into the equalizer buffer. */ 00154 int eq_step; 00155 /*! \brief Current write offset into the equalizer buffer. */ 00156 int eq_put_step; 00157 /*! \brief Symbol counter to the next equalizer update. */ 00158 int eq_skip; 00159 00160 /*! \brief The current half of the baud. */ 00161 int baud_half; 00162 00163 #if defined(SPANDSP_USE_FIXED_POINT) 00164 /*! \brief The scaling factor accessed by the AGC algorithm. */ 00165 int16_t agc_scaling; 00166 /*! \brief The previous value of agc_scaling, needed to reuse old training. */ 00167 int16_t agc_scaling_save; 00168 00169 /*! \brief The current delta factor for updating the equalizer coefficients. */ 00170 float eq_delta; 00171 /*! \brief The adaptive equalizer coefficients. */ 00172 /*complexi16_t*/ complexf_t eq_coeff[V27TER_EQUALIZER_PRE_LEN + 1 + V27TER_EQUALIZER_POST_LEN]; 00173 /*! \brief A saved set of adaptive equalizer coefficients for use after restarts. */ 00174 /*complexi16_t*/ complexf_t eq_coeff_save[V27TER_EQUALIZER_PRE_LEN + 1 + V27TER_EQUALIZER_POST_LEN]; 00175 /*! \brief The equalizer signal buffer. */ 00176 /*complexi16_t*/ complexf_t eq_buf[V27TER_EQUALIZER_PRE_LEN + 1 + V27TER_EQUALIZER_POST_LEN]; 00177 #else 00178 /*! \brief The scaling factor accessed by the AGC algorithm. */ 00179 float agc_scaling; 00180 /*! \brief The previous value of agc_scaling, needed to reuse old training. */ 00181 float agc_scaling_save; 00182 00183 /*! \brief The current delta factor for updating the equalizer coefficients. */ 00184 float eq_delta; 00185 /*! \brief The adaptive equalizer coefficients. */ 00186 complexf_t eq_coeff[V27TER_EQUALIZER_PRE_LEN + 1 + V27TER_EQUALIZER_POST_LEN]; 00187 /*! \brief A saved set of adaptive equalizer coefficients for use after restarts. */ 00188 complexf_t eq_coeff_save[V27TER_EQUALIZER_PRE_LEN + 1 + V27TER_EQUALIZER_POST_LEN]; 00189 /*! \brief The equalizer signal buffer. */ 00190 complexf_t eq_buf[V27TER_EQUALIZER_PRE_LEN + 1 + V27TER_EQUALIZER_POST_LEN]; 00191 #endif 00192 00193 /*! \brief Integration variable for damping the Gardner algorithm tests. */ 00194 int gardner_integrate; 00195 /*! \brief Current step size of Gardner algorithm integration. */ 00196 int gardner_step; 00197 /*! \brief The total symbol timing correction since the carrier came up. 00198 This is only for performance analysis purposes. */ 00199 int total_baud_timing_correction; 00200 00201 /*! \brief Starting phase angles for the coarse carrier aquisition step. */ 00202 int32_t start_angles[2]; 00203 /*! \brief History list of phase angles for the coarse carrier aquisition step. */ 00204 int32_t angles[16]; 00205 /*! \brief Error and flow logging control */ 00206 logging_state_t logging; 00207 } v27ter_rx_state_t; 00208 00209 #if defined(__cplusplus) 00210 extern "C" 00211 { 00212 #endif 00213 00214 /*! Initialise a V.27ter modem receive context. 00215 \brief Initialise a V.27ter modem receive context. 00216 \param s The modem context. 00217 \param bit_rate The bit rate of the modem. Valid values are 2400 and 4800. 00218 \param put_bit The callback routine used to put the received data. 00219 \param user_data An opaque pointer passed to the put_bit routine. 00220 \return A pointer to the modem context, or NULL if there was a problem. */ 00221 v27ter_rx_state_t *v27ter_rx_init(v27ter_rx_state_t *s, int bit_rate, put_bit_func_t put_bit, void *user_data); 00222 00223 /*! Reinitialise an existing V.27ter modem receive context. 00224 \brief Reinitialise an existing V.27ter modem receive context. 00225 \param s The modem context. 00226 \param bit_rate The bit rate of the modem. Valid values are 2400 and 4800. 00227 \param old_train TRUE if a previous trained values are to be reused. 00228 \return 0 for OK, -1 for bad parameter */ 00229 int v27ter_rx_restart(v27ter_rx_state_t *s, int bit_rate, int old_train); 00230 00231 /*! Free a V.27ter modem receive context. 00232 \brief Free a V.27ter modem receive context. 00233 \param s The modem context. 00234 \return 0 for OK */ 00235 int v27ter_rx_free(v27ter_rx_state_t *s); 00236 00237 /*! Change the put_bit function associated with a V.27ter modem receive context. 00238 \brief Change the put_bit function associated with a V.27ter modem receive context. 00239 \param s The modem context. 00240 \param put_bit The callback routine used to handle received bits. 00241 \param user_data An opaque pointer. */ 00242 void v27ter_rx_set_put_bit(v27ter_rx_state_t *s, put_bit_func_t put_bit, void *user_data); 00243 00244 /*! Change the modem status report function associated with a V.27ter modem receive context. 00245 \brief Change the modem status report function associated with a V.27ter modem receive context. 00246 \param s The modem context. 00247 \param handler The callback routine used to report modem status changes. 00248 \param user_data An opaque pointer. */ 00249 void v27ter_rx_set_modem_status_handler(v27ter_rx_state_t *s, modem_rx_status_func_t handler, void *user_data); 00250 00251 /*! Process a block of received V.27ter modem audio samples. 00252 \brief Process a block of received V.27ter modem audio samples. 00253 \param s The modem context. 00254 \param amp The audio sample buffer. 00255 \param len The number of samples in the buffer. 00256 \return The number of samples unprocessed. 00257 */ 00258 int v27ter_rx(v27ter_rx_state_t *s, const int16_t amp[], int len); 00259 00260 /*! Get a snapshot of the current equalizer coefficients. 00261 \brief Get a snapshot of the current equalizer coefficients. 00262 \param coeffs The vector of complex coefficients. 00263 \return The number of coefficients in the vector. */ 00264 int v27ter_rx_equalizer_state(v27ter_rx_state_t *s, complexf_t **coeffs); 00265 00266 /*! Get the current received carrier frequency. 00267 \param s The modem context. 00268 \return The frequency, in Hertz. */ 00269 float v27ter_rx_carrier_frequency(v27ter_rx_state_t *s); 00270 00271 /*! Get the current symbol timing correction since startup. 00272 \param s The modem context. 00273 \return The correction. */ 00274 float v27ter_rx_symbol_timing_correction(v27ter_rx_state_t *s); 00275 00276 /*! Get a current received signal power. 00277 \param s The modem context. 00278 \return The signal power, in dBm0. */ 00279 float v27ter_rx_signal_power(v27ter_rx_state_t *s); 00280 00281 /*! Set the power level at which the carrier detection will cut in 00282 \param s The modem context. 00283 \param cutoff The signal cutoff power, in dBm0. */ 00284 void v27ter_rx_signal_cutoff(v27ter_rx_state_t *s, float cutoff); 00285 00286 /*! Set a handler routine to process QAM status reports 00287 \param s The modem context. 00288 \param handler The handler routine. 00289 \param user_data An opaque pointer passed to the handler routine. */ 00290 void v27ter_rx_set_qam_report_handler(v27ter_rx_state_t *s, qam_report_handler_t handler, void *user_data); 00291 00292 #if defined(__cplusplus) 00293 } 00294 #endif 00295 00296 #endif 00297 /*- End of file ------------------------------------------------------------*/