v27ter_rx.h File Reference

Go to the source code of this file.

Classes

struct  v27ter_rx_state_t

Defines

#define _V27TER_RX_H_
#define V27TER_EQUALIZER_PRE_LEN   15
#define V27TER_EQUALIZER_POST_LEN   15
#define V27TER_EQUALIZER_MASK   63
#define V27TER_RX_4800_FILTER_STEPS   27
#define V27TER_RX_2400_FILTER_STEPS   27
#define V27TER_RX_FILTER_STEPS   V27TER_RX_2400_FILTER_STEPS

Functions

v27ter_rx_state_tv27ter_rx_init (v27ter_rx_state_t *s, int bit_rate, put_bit_func_t put_bit, void *user_data)
 Initialise a V.27ter modem receive context.
int v27ter_rx_restart (v27ter_rx_state_t *s, int bit_rate, int old_train)
 Reinitialise an existing V.27ter modem receive context.
int v27ter_rx_free (v27ter_rx_state_t *s)
 Free a V.27ter modem receive context.
void v27ter_rx_set_put_bit (v27ter_rx_state_t *s, put_bit_func_t put_bit, void *user_data)
 Change the put_bit function associated with a V.27ter modem receive context.
int v27ter_rx (v27ter_rx_state_t *s, const int16_t amp[], int len)
 Process a block of received V.27ter modem audio samples.
int v27ter_rx_equalizer_state (v27ter_rx_state_t *s, complexf_t **coeffs)
 Get a snapshot of the current equalizer coefficients.
float v27ter_rx_carrier_frequency (v27ter_rx_state_t *s)
float v27ter_rx_symbol_timing_correction (v27ter_rx_state_t *s)
float v27ter_rx_signal_power (v27ter_rx_state_t *s)
void v27ter_rx_signal_cutoff (v27ter_rx_state_t *s, float cutoff)
void v27ter_rx_set_qam_report_handler (v27ter_rx_state_t *s, qam_report_handler_t *handler, void *user_data)


Detailed Description


Function Documentation

int v27ter_rx v27ter_rx_state_t s,
const int16_t  amp[],
int  len
 

Process a block of received V.27ter modem audio samples.

Process a block of received V.27ter modem audio samples.

Parameters:
s The modem context.
amp The audio sample buffer.
len The number of samples in the buffer.
Returns:
The number of samples unprocessed.

float v27ter_rx_carrier_frequency v27ter_rx_state_t s  ) 
 

Get the current received carrier frequency.

Parameters:
s The modem context.
Returns:
The frequency, in Hertz.

int v27ter_rx_equalizer_state v27ter_rx_state_t s,
complexf_t **  coeffs
 

Get a snapshot of the current equalizer coefficients.

Get a snapshot of the current equalizer coefficients.

Parameters:
coeffs The vector of complex coefficients.
Returns:
The number of coefficients in the vector.

int v27ter_rx_free v27ter_rx_state_t s  ) 
 

Free a V.27ter modem receive context.

Free a V.27ter modem receive context.

Parameters:
s The modem context.
Returns:
0 for OK

v27ter_rx_state_t* v27ter_rx_init v27ter_rx_state_t s,
int  bit_rate,
put_bit_func_t  put_bit,
void *  user_data
 

Initialise a V.27ter modem receive context.

Initialise a V.27ter modem receive context.

Parameters:
s The modem context.
bit_rate The bit rate of the modem. Valid values are 2400 and 4800.
put_bit The callback routine used to put the received data.
user_data An opaque pointer passed to the put_bit routine.
Returns:
A pointer to the modem context, or NULL if there was a problem.

int v27ter_rx_restart v27ter_rx_state_t s,
int  bit_rate,
int  old_train
 

Reinitialise an existing V.27ter modem receive context.

Reinitialise an existing V.27ter modem receive context.

Parameters:
s The modem context.
bit_rate The bit rate of the modem. Valid values are 2400 and 4800.
old_train TRUE if a previous trained values are to be reused.
Returns:
0 for OK, -1 for bad parameter

void v27ter_rx_set_put_bit v27ter_rx_state_t s,
put_bit_func_t  put_bit,
void *  user_data
 

Change the put_bit function associated with a V.27ter modem receive context.

Change the put_bit function associated with a V.27ter modem receive context.

Parameters:
s The modem context.
put_bit The callback routine used to handle received bits.
user_data An opaque pointer.

void v27ter_rx_set_qam_report_handler v27ter_rx_state_t s,
qam_report_handler_t *  handler,
void *  user_data
 

Set a handler routine to process QAM status reports

Parameters:
s The modem context.
handler The handler routine.
user_data An opaque pointer passed to the handler routine.

void v27ter_rx_signal_cutoff v27ter_rx_state_t s,
float  cutoff
 

Set the power level at which the carrier detection will cut in

Parameters:
s The modem context.
cutoff The signal cutoff power, in dBm0.

float v27ter_rx_signal_power v27ter_rx_state_t s  ) 
 

Get a current received signal power.

Parameters:
s The modem context.
Returns:
The signal power, in dBm0.

float v27ter_rx_symbol_timing_correction v27ter_rx_state_t s  ) 
 

Get the current symbol timing correction since startup.

Parameters:
s The modem context.
Returns:
The correction.


Generated on Mon Apr 23 23:27:55 2012 for libspandsp by  doxygen 1.4.6