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_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_symbol_timing_correction (v22bis_state_t *s)

float v22bis_rx_signal_power (v22bis_state_t *s)

void v22bis_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_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.

int v22bis_free (v22bis_state_t *s)

Free a V.22bis modem receive 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

int v22bis_equalizer_state	(	v22bis_state_t *	s,
		complexf_t **	coeffs
	)

Get a snapshot of the current equalizer coefficients.

Parameters:

coeffs

The vector of complex coefficients.

Returns:: The number of coefficients in the vector.

References v22bis_state_t::eq_coeff, and v22bis_state_t::rx.

int v22bis_free ( v22bis_state_t * s )

Free a V.22bis modem receive context.

Parameters:

s

The modem context.

Returns:: 0 for OK

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.

References v22bis_state_t::bit_rate, v22bis_state_t::caller, v22bis_state_t::carrier_phase_rate, dds_phase_ratef(), v22bis_state_t::get_bit, v22bis_state_t::guard_level, v22bis_state_t::guard_phase_rate, v22bis_state_t::logging, v22bis_state_t::put_bit, v22bis_state_t::tx, v22bis_state_t::user_data, v22bis_restart(), and v22bis_tx_power().

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.

References v22bis_rx_restart().

Referenced by v22bis_init().

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

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.

References v22bis_state_t::agc_scaling, v22bis_state_t::bit_rate, v22bis_state_t::caller, v22bis_state_t::carrier_phase, v22bis_state_t::carrier_phase_rate, dds_complexf(), v22bis_state_t::eq_put_step, complexf_t::im, power_meter_update(), v22bis_state_t::put_bit, complexf_t::re, v22bis_state_t::rrc_filter, v22bis_state_t::rrc_filter_step, v22bis_state_t::rx, v22bis_state_t::rx_power, SIG_STATUS_CARRIER_DOWN, SIG_STATUS_CARRIER_UP, v22bis_state_t::signal_present, v22bis_state_t::training, v22bis_state_t::user_data, and v22bis_rx_restart().

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.

References v22bis_state_t::carrier_phase_rate, dds_frequencyf(), and v22bis_state_t::rx.

int v22bis_rx_restart	(	v22bis_state_t *	s,
		int	bit_rate
	)

Reinitialise an existing V.22bis modem receive context.

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

References v22bis_state_t::agc_scaling, v22bis_state_t::baud_phase, v22bis_state_t::bit_rate, v22bis_state_t::caller, v22bis_state_t::carrier_off_power, v22bis_state_t::carrier_on_power, v22bis_state_t::carrier_phase, v22bis_state_t::carrier_phase_rate, v22bis_state_t::carrier_track_i, v22bis_state_t::carrier_track_p, v22bis_state_t::constellation_state, dds_phase_ratef(), v22bis_state_t::detected_unscrambled_ones, v22bis_state_t::detected_unscrambled_zeros, v22bis_state_t::gardner_integrate, v22bis_state_t::gardner_step, power_meter_init(), power_meter_level_dbm0(), v22bis_state_t::rrc_filter, v22bis_state_t::rrc_filter_step, v22bis_state_t::rx, v22bis_state_t::rx_power, v22bis_state_t::scramble_reg, v22bis_state_t::scrambler_pattern_count, v22bis_state_t::signal_present, v22bis_state_t::sixteen_way_decisions, v22bis_state_t::training, and v22bis_state_t::training_count.

Referenced by v22bis_restart(), and v22bis_rx().

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.

References power_meter_current_dbm0(), v22bis_state_t::rx, and v22bis_state_t::rx_power.

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.

Parameters:

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

References v22bis_state_t::get_bit, and v22bis_state_t::user_data.

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.22bis modem context.

Parameters:

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

References v22bis_state_t::put_bit, and v22bis_state_t::user_data.

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

References v22bis_state_t::qam_report, v22bis_state_t::qam_user_data, and v22bis_state_t::rx.

float v22bis_symbol_timing_correction ( v22bis_state_t * s )

Get the current symbol timing correction since startup.

Parameters:

s

The modem context.

Returns:: The correction.

References v22bis_state_t::rx, and v22bis_state_t::total_baud_timing_correction.

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

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.

References v22bis_state_t::baud_phase, v22bis_state_t::carrier_phase, v22bis_state_t::carrier_phase_rate, dds_complexf(), dds_modf(), v22bis_state_t::gain, v22bis_state_t::guard_level, v22bis_state_t::guard_phase, v22bis_state_t::guard_phase_rate, complexf_t::im, complexf_t::re, v22bis_state_t::rrc_filter, v22bis_state_t::rrc_filter_step, v22bis_state_t::shutdown, and v22bis_state_t::tx.

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

References v22bis_state_t::gain, and v22bis_state_t::tx.

Referenced by v22bis_init().


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_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_symbol_timing_correction (v22bis_state_t *s)
float	v22bis_rx_signal_power (v22bis_state_t *s)
void	v22bis_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_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.
int	v22bis_free (v22bis_state_t *s)
	Free a V.22bis modem receive 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]