v27ter_rx.h

Go to the documentation of this file.
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.61 2009/07/09 13:52:09 steveu Exp $
00026  */
00027 
00028 /*! \file */
00029 
00030 #if !defined(_SPANDSP_V27TER_RX_H_)
00031 #define _SPANDSP_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 /*!
00050     V.27ter modem receive side descriptor. This defines the working state for a
00051     single instance of a V.27ter modem receiver.
00052 */
00053 typedef struct v27ter_rx_state_s v27ter_rx_state_t;
00054 
00055 #if defined(__cplusplus)
00056 extern "C"
00057 {
00058 #endif
00059 
00060 /*! Initialise a V.27ter modem receive context.
00061     \brief Initialise a V.27ter modem receive context.
00062     \param s The modem context.
00063     \param bit_rate The bit rate of the modem. Valid values are 2400 and 4800.
00064     \param put_bit The callback routine used to put the received data.
00065     \param user_data An opaque pointer passed to the put_bit routine.
00066     \return A pointer to the modem context, or NULL if there was a problem. */
00067 SPAN_DECLARE(v27ter_rx_state_t *) v27ter_rx_init(v27ter_rx_state_t *s, int bit_rate, put_bit_func_t put_bit, void *user_data);
00068 
00069 /*! Reinitialise an existing V.27ter modem receive context.
00070     \brief Reinitialise an existing V.27ter modem receive context.
00071     \param s The modem context.
00072     \param bit_rate The bit rate of the modem. Valid values are 2400 and 4800.
00073     \param old_train TRUE if a previous trained values are to be reused.
00074     \return 0 for OK, -1 for bad parameter */
00075 SPAN_DECLARE(int) v27ter_rx_restart(v27ter_rx_state_t *s, int bit_rate, int old_train);
00076 
00077 /*! Release a V.27ter modem receive context.
00078     \brief Release a V.27ter modem receive context.
00079     \param s The modem context.
00080     \return 0 for OK */
00081 SPAN_DECLARE(int) v27ter_rx_release(v27ter_rx_state_t *s);
00082 
00083 /*! Free a V.27ter modem receive context.
00084     \brief Free a V.27ter modem receive context.
00085     \param s The modem context.
00086     \return 0 for OK */
00087 SPAN_DECLARE(int) v27ter_rx_free(v27ter_rx_state_t *s);
00088 
00089 /*! Get the logging context associated with a V.27ter modem receive context.
00090     \brief Get the logging context associated with a V.27ter modem receive context.
00091     \param s The modem context.
00092     \return A pointer to the logging context */
00093 SPAN_DECLARE(logging_state_t *) v27ter_rx_get_logging_state(v27ter_rx_state_t *s);
00094 
00095 /*! Change the put_bit function associated with a V.27ter modem receive context.
00096     \brief Change the put_bit function associated with a V.27ter modem receive context.
00097     \param s The modem context.
00098     \param put_bit The callback routine used to handle received bits.
00099     \param user_data An opaque pointer. */
00100 SPAN_DECLARE(void) v27ter_rx_set_put_bit(v27ter_rx_state_t *s, put_bit_func_t put_bit, void *user_data);
00101 
00102 /*! Change the modem status report function associated with a V.27ter modem receive context.
00103     \brief Change the modem status report function associated with a V.27ter modem receive context.
00104     \param s The modem context.
00105     \param handler The callback routine used to report modem status changes.
00106     \param user_data An opaque pointer. */
00107 SPAN_DECLARE(void) v27ter_rx_set_modem_status_handler(v27ter_rx_state_t *s, modem_rx_status_func_t handler, void *user_data);
00108 
00109 /*! Process a block of received V.27ter modem audio samples.
00110     \brief Process a block of received V.27ter modem audio samples.
00111     \param s The modem context.
00112     \param amp The audio sample buffer.
00113     \param len The number of samples in the buffer.
00114     \return The number of samples unprocessed.
00115 */
00116 SPAN_DECLARE_NONSTD(int) v27ter_rx(v27ter_rx_state_t *s, const int16_t amp[], int len);
00117 
00118 /*! Fake processing of a missing block of received V.27ter modem audio samples.
00119     (e.g due to packet loss).
00120     \brief Fake processing of a missing block of received V.27ter modem audio samples.
00121     \param s The modem context.
00122     \param len The number of samples to fake.
00123     \return The number of samples unprocessed.
00124 */
00125 SPAN_DECLARE(int) v27ter_rx_fillin(v27ter_rx_state_t *s, int len);
00126 
00127 /*! Get a snapshot of the current equalizer coefficients.
00128     \brief Get a snapshot of the current equalizer coefficients.
00129     \param coeffs The vector of complex coefficients.
00130     \return The number of coefficients in the vector. */
00131 SPAN_DECLARE(int) v27ter_rx_equalizer_state(v27ter_rx_state_t *s, complexf_t **coeffs);
00132 
00133 /*! Get the current received carrier frequency.
00134     \param s The modem context.
00135     \return The frequency, in Hertz. */
00136 SPAN_DECLARE(float) v27ter_rx_carrier_frequency(v27ter_rx_state_t *s);
00137 
00138 /*! Get the current symbol timing correction since startup.
00139     \param s The modem context.
00140     \return The correction. */
00141 SPAN_DECLARE(float) v27ter_rx_symbol_timing_correction(v27ter_rx_state_t *s);
00142 
00143 /*! Get a current received signal power.
00144     \param s The modem context.
00145     \return The signal power, in dBm0. */
00146 SPAN_DECLARE(float) v27ter_rx_signal_power(v27ter_rx_state_t *s);
00147 
00148 /*! Set the power level at which the carrier detection will cut in
00149     \param s The modem context.
00150     \param cutoff The signal cutoff power, in dBm0. */
00151 SPAN_DECLARE(void) v27ter_rx_signal_cutoff(v27ter_rx_state_t *s, float cutoff);
00152 
00153 /*! Set a handler routine to process QAM status reports
00154     \param s The modem context.
00155     \param handler The handler routine.
00156     \param user_data An opaque pointer passed to the handler routine. */
00157 SPAN_DECLARE(void) v27ter_rx_set_qam_report_handler(v27ter_rx_state_t *s, qam_report_handler_t handler, void *user_data);
00158 
00159 #if defined(__cplusplus)
00160 }
00161 #endif
00162 
00163 #endif
00164 /*- End of file ------------------------------------------------------------*/

Generated on Tue Jan 11 14:08:45 2011 for spandsp by  doxygen 1.4.7