v22bis.h File Reference

Go to the source code of this file.

Classes

struct  v22bis_state_t

Defines

#define _V22BIS_H_
#define V22BIS_EQUALIZER_LEN   7
#define V22BIS_EQUALIZER_MASK   15
#define V22BIS_TX_FILTER_STEPS   9
#define V22BIS_RX_FILTER_STEPS   37

Functions

int v22bis_rx_restart (v22bis_state_t *s, int bit_rate)
 Reinitialise an existing V.22bis modem receive context.
int v22bis_rx (v22bis_state_t *s, const int16_t amp[], int len)
 Process a block of received V.22bis modem audio samples.
int v22bis_rx_equalizer_state (v22bis_state_t *s, complexf_t **coeffs)
 Get a snapshot of the current equalizer coefficients.
float v22bis_rx_carrier_frequency (v22bis_state_t *s)
float v22bis_rx_symbol_timing_correction (v22bis_state_t *s)
float v22bis_rx_signal_power (v22bis_state_t *s)
void v22bis_rx_set_qam_report_handler (v22bis_state_t *s, qam_report_handler_t *handler, void *user_data)
int v22bis_tx (v22bis_state_t *s, int16_t amp[], int len)
 Generate a block of V.22bis modem audio samples.
void v22bis_tx_power (v22bis_state_t *s, float power)
 Adjust a V.22bis modem transmit context's output power.
int v22bis_restart (v22bis_state_t *s, int bit_rate)
 Reinitialise an existing V.22bis modem context.
v22bis_state_tv22bis_init (v22bis_state_t *s, int bit_rate, int guard, int caller, get_bit_func_t get_bit, put_bit_func_t put_bit, void *user_data)
 Initialise a V.22bis modem context.
void v22bis_set_get_bit (v22bis_state_t *s, get_bit_func_t get_bit, void *user_data)
 Change the get_bit function associated with a V.22bis modem context.
void v22bis_set_put_bit (v22bis_state_t *s, put_bit_func_t put_bit, void *user_data)
 Change the put_bit function associated with a V.22bis modem context.

Variables

const complexf_t v22bis_constellation [16]


Detailed Description


Function Documentation

v22bis_state_t* v22bis_init ( v22bis_state_t s,
int  bit_rate,
int  guard,
int  caller,
get_bit_func_t  get_bit,
put_bit_func_t  put_bit,
void *  user_data 
)

Initialise a V.22bis modem context.

Initialise a V.22bis modem context. This must be called before the first use of the context, to initialise its contents.

Parameters:
s The modem context.
bit_rate The bit rate of the modem. Valid values are 1200 and 2400.
guard The guard tone option. 0 = none, 1 = 550Hz, 2 = 1800Hz.
caller TRUE if this is the calling modem.
get_bit The callback routine used to get the data to be transmitted.
put_bit The callback routine used to get the data to be transmitted.
user_data An opaque pointer, passed in calls to the get and put routines.
Returns:
A pointer to the modem context, or NULL if there was a problem.

int v22bis_restart ( v22bis_state_t s,
int  bit_rate 
)

Reinitialise an existing V.22bis modem context.

Reinitialise an existing V.22bis modem context, so it may be reused.

Parameters:
s The modem context.
bit_rate The bit rate of the modem. Valid values are 1200 and 2400.
Returns:
0 for OK, -1 for bad parameter.

int v22bis_rx ( v22bis_state_t s,
const int16_t  amp[],
int  len 
)

Process a block of received V.22bis modem audio samples.

Process a block of received V.22bis 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 v22bis_rx_carrier_frequency ( v22bis_state_t s  ) 

Get the current received carrier frequency.

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

int v22bis_rx_equalizer_state ( v22bis_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 v22bis_rx_restart ( v22bis_state_t s,
int  bit_rate 
)

Reinitialise an existing V.22bis modem receive context.

Reinitialise an existing V.22bis modem receive context.

Parameters:
s The modem context.
rate The bit rate of the modem. Valid values are 1200 and 2400.
Returns:
0 for OK, -1 for bad parameter

void v22bis_rx_set_qam_report_handler ( v22bis_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.

float v22bis_rx_signal_power ( v22bis_state_t s  ) 

Get a current received signal power.

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

float v22bis_rx_symbol_timing_correction ( v22bis_state_t s  ) 

Get the current symbol timing correction since startup.

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

void v22bis_set_get_bit ( v22bis_state_t s,
get_bit_func_t  get_bit,
void *  user_data 
)

Change the get_bit function associated with a V.22bis modem context.

Change the get_bit function associated with a V.2bis modem context.

Parameters:
s The modem context.
get_bit The callback routine used to get the data to be transmitted.
user_data An opaque pointer.

void v22bis_set_put_bit ( v22bis_state_t s,
put_bit_func_t  put_bit,
void *  user_data 
)

Change the put_bit function associated with a V.22bis modem context.

Change the get_bit function associated with a V.2bis modem context.

Parameters:
s The modem context.
put_bit The callback routine used to process the data received.
user_data An opaque pointer.

int v22bis_tx ( v22bis_state_t s,
int16_t  amp[],
int  len 
)

Generate a block of V.22bis modem audio samples.

Generate a block of V.22bis modem audio samples.

Parameters:
s The modem context.
amp The audio sample buffer.
len The number of samples to be generated.
Returns:
The number of samples actually generated.

void v22bis_tx_power ( v22bis_state_t s,
float  power 
)

Adjust a V.22bis modem transmit context's output power.

Adjust a V.22bis modem transmit context's power output.

Parameters:
s The modem context.
power The power level, in dBm0


Generated on Tue Jul 24 11:29:29 2007 for libspandsp by  doxygen 1.5.2