v32bis.h File Reference

Go to the source code of this file.

Classes

struct v32bis_state_t

Functions

int v32bis_rx_restart (v32bis_state_t *s, int bit_rate)

Reinitialise an existing V.32bis modem receive context.

int v32bis_rx (v32bis_state_t *s, const int16_t amp[], int len)

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

int v32bis_equalizer_state (v32bis_state_t *s, complexf_t **coeffs)

Get a snapshot of the current equalizer coefficients.

float v32bis_rx_carrier_frequency (v32bis_state_t *s)

float v32bis_symbol_timing_correction (v32bis_state_t *s)

float v32bis_rx_signal_power (v32bis_state_t *s)

void v32bis_rx_signal_cutoff (v32bis_state_t *s, float cutoff)

void v32bis_set_qam_report_handler (v32bis_state_t *s, qam_report_handler_t *handler, void *user_data)

int v32bis_tx (v32bis_state_t *s, int16_t amp[], int len)

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

void v32bis_tx_power (v32bis_state_t *s, float power)

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

int v32bis_restart (v32bis_state_t *s, int bit_rate)

Reinitialise an existing V.32bis modem context.

v32bis_state_t * v32bis_init (v32bis_state_t *s, int bit_rate, int caller, get_bit_func_t get_bit, put_bit_func_t put_bit, void *user_data)

Initialise a V.32bis modem context.

int v32bis_free (v32bis_state_t *s)

Free a V.32bis modem receive context.

void v32bis_set_get_bit (v32bis_state_t *s, get_bit_func_t get_bit, void *user_data)

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

void v32bis_set_put_bit (v32bis_state_t *s, put_bit_func_t put_bit, void *user_data)

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

Variables

const complexf_t v32bis_constellation [16]

Detailed Description

Function Documentation

int v32bis_equalizer_state	(	v32bis_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 v17_rx_state_t::eq_coeff, and v32bis_state_t::rx.

int v32bis_free ( v32bis_state_t * s )

Free a V.32bis modem receive context.

Parameters:

s

The modem context.

Returns:: 0 for OK

v32bis_state_t* v32bis_init	(	v32bis_state_t *	s,
		int	bit_rate,
		int	caller,
		get_bit_func_t	get_bit,
		put_bit_func_t	put_bit,
		void *	user_data
	)

Initialise a V.32bis modem context.

Initialise a V.32bis 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 4800, 7200, 9600, 12000 and 14400.
	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 v17_rx_state_t::agc_scaling, v17_rx_state_t::agc_scaling_save, v32bis_state_t::bit_rate, v32bis_state_t::caller, v17_tx_state_t::carrier_phase_rate, v17_rx_state_t::carrier_phase_rate_save, dds_phase_ratef(), v17_tx_state_t::get_bit, v32bis_state_t::logging, v17_rx_state_t::put_bit, v32bis_state_t::rx, v32bis_state_t::tx, v32bis_restart(), v32bis_rx_signal_cutoff(), and v32bis_tx_power().

int v32bis_restart	(	v32bis_state_t *	s,
		int	bit_rate
	)

Reinitialise an existing V.32bis modem context.

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

Parameters:

	s	The modem context.
	bit_rate	The bit rate of the modem. Valid values are 4800, 7200, 9600, 12000 and 14400.

Returns:: 0 for OK, -1 for bad parameter

References v17_rx_state_t::agc_scaling, v17_rx_state_t::agc_scaling_save, v17_rx_state_t::angles, v17_rx_state_t::baud_half, v17_rx_state_t::baud_phase, v17_tx_state_t::baud_phase, v17_rx_state_t::bit_rate, v17_tx_state_t::bit_rate, v17_rx_state_t::bits_per_symbol, v17_tx_state_t::bits_per_symbol, v17_rx_state_t::carrier_drop_pending, v17_rx_state_t::carrier_phase, v17_tx_state_t::carrier_phase, v17_rx_state_t::carrier_phase_rate, v17_rx_state_t::carrier_phase_rate_save, v17_rx_state_t::carrier_track_i, v17_rx_state_t::carrier_track_p, v17_rx_state_t::constellation, v17_tx_state_t::constellation, v17_tx_state_t::constellation_state, v17_tx_state_t::convolution, v17_tx_state_t::current_get_bit, dds_frequencyf(), dds_phase_ratef(), v17_rx_state_t::diff, v17_tx_state_t::diff, v17_rx_state_t::distances, v17_rx_state_t::full_path_to_past_state_locations, v17_rx_state_t::high_sample, v17_tx_state_t::in_training, v17_rx_state_t::last_sample, v17_rx_state_t::logging, v17_rx_state_t::low_samples, v17_rx_state_t::past_state_locations, v17_rx_state_t::power, power_meter_init(), v17_rx_state_t::rrc_filter, v17_tx_state_t::rrc_filter, v17_rx_state_t::rrc_filter_step, v17_tx_state_t::rrc_filter_step, v32bis_state_t::rx, v17_rx_state_t::scramble_reg, v17_tx_state_t::scramble_reg, v17_rx_state_t::signal_present, v17_rx_state_t::space_map, span_log(), v17_rx_state_t::start_angles, v17_rx_state_t::symbol_sync_dc_filter, v17_rx_state_t::symbol_sync_high, v17_rx_state_t::symbol_sync_low, v17_rx_state_t::total_baud_timing_correction, v17_rx_state_t::training_count, v17_rx_state_t::training_error, v17_rx_state_t::training_stage, v17_tx_state_t::training_step, v17_rx_state_t::trellis_ptr, and v32bis_state_t::tx.

Referenced by v32bis_init(), and v32bis_rx().

int v32bis_rx	(	v32bis_state_t *	s,
		const int16_t	amp[],
		int	len
	)

Process a block of received V.32bis 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 v17_rx_state_t::agc_scaling, v17_rx_state_t::agc_scaling_save, v17_rx_state_t::bit_rate, v17_rx_state_t::carrier_drop_pending, v17_rx_state_t::carrier_phase, v17_rx_state_t::carrier_phase_rate, dds_advancef(), dds_lookup_complexf(), v17_rx_state_t::eq_put_step, v17_rx_state_t::high_sample, complexf_t::im, complexi_t::im, v17_rx_state_t::last_sample, v17_rx_state_t::low_samples, v17_rx_state_t::power, power_meter_init(), power_meter_update(), complexf_t::re, complexi_t::re, v17_rx_state_t::rrc_filter, v17_rx_state_t::rrc_filter_step, v32bis_state_t::rx, SIG_STATUS_CARRIER_DOWN, SIG_STATUS_CARRIER_UP, v17_rx_state_t::signal_present, v17_rx_state_t::symbol_sync_high, v17_rx_state_t::symbol_sync_low, v17_rx_state_t::training_stage, and v32bis_restart().

float v32bis_rx_carrier_frequency ( v32bis_state_t * s )

Get the current received carrier frequency.

Parameters:

s

The modem context.

Returns:: The frequency, in Hertz.

References v17_rx_state_t::carrier_phase_rate, dds_frequency(), and v32bis_state_t::rx.

int v32bis_rx_restart	(	v32bis_state_t *	s,
		int	bit_rate
	)

Reinitialise an existing V.32bis 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

void v32bis_rx_signal_cutoff	(	v32bis_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.

References v17_rx_state_t::carrier_off_power, v17_rx_state_t::carrier_on_power, power_meter_level_dbm0(), and v32bis_state_t::rx.

Referenced by v32bis_init().

float v32bis_rx_signal_power ( v32bis_state_t * s )

Get a current received signal power.

Parameters:

s

The modem context.

Returns:: The signal power, in dBm0.

References v17_rx_state_t::power, power_meter_current_dbm0(), and v32bis_state_t::rx.

void v32bis_set_get_bit	(	v32bis_state_t *	s,
		get_bit_func_t	get_bit,
		void *	user_data
	)

Change the get_bit function associated with a V.32bis 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 v17_tx_state_t::current_get_bit, v17_tx_state_t::get_bit, and v32bis_state_t::tx.

void v32bis_set_put_bit	(	v32bis_state_t *	s,
		put_bit_func_t	put_bit,
		void *	user_data
	)

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

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

Parameters:

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

References v17_rx_state_t::put_bit, and v32bis_state_t::rx.

void v32bis_set_qam_report_handler	(	v32bis_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 v17_rx_state_t::qam_report, v17_rx_state_t::qam_user_data, and v32bis_state_t::rx.

float v32bis_symbol_timing_correction ( v32bis_state_t * s )

Get the current symbol timing correction since startup.

Parameters:

s

The modem context.

Returns:: The correction.

References v32bis_state_t::rx, and v17_rx_state_t::total_baud_timing_correction.

int v32bis_tx	(	v32bis_state_t *	s,
		int16_t	amp[],
		int	len
	)

Generate a block of V.32bis 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 v17_tx_state_t::baud_phase, v17_tx_state_t::carrier_phase, v17_tx_state_t::carrier_phase_rate, dds_complexf(), dds_complexi(), v17_tx_state_t::gain, complexf_t::im, complexf_t::re, v17_tx_state_t::rrc_filter, v17_tx_state_t::rrc_filter_step, v17_tx_state_t::training_step, and v32bis_state_t::tx.

void v32bis_tx_power	(	v32bis_state_t *	s,
		float	power
	)

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

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

Parameters:

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

References v17_tx_state_t::gain, and v32bis_state_t::tx.

Referenced by v32bis_init().


Classes
struct	v32bis_state_t
Functions
int	v32bis_rx_restart (v32bis_state_t *s, int bit_rate)
	Reinitialise an existing V.32bis modem receive context.
int	v32bis_rx (v32bis_state_t *s, const int16_t amp[], int len)
	Process a block of received V.32bis modem audio samples.
int	v32bis_equalizer_state (v32bis_state_t s, complexf_t *coeffs)
	Get a snapshot of the current equalizer coefficients.
float	v32bis_rx_carrier_frequency (v32bis_state_t *s)
float	v32bis_symbol_timing_correction (v32bis_state_t *s)
float	v32bis_rx_signal_power (v32bis_state_t *s)
void	v32bis_rx_signal_cutoff (v32bis_state_t *s, float cutoff)
void	v32bis_set_qam_report_handler (v32bis_state_t s, qam_report_handler_t handler, void *user_data)
int	v32bis_tx (v32bis_state_t *s, int16_t amp[], int len)
	Generate a block of V.32bis modem audio samples.
void	v32bis_tx_power (v32bis_state_t *s, float power)
	Adjust a V.32bis modem transmit context's output power.
int	v32bis_restart (v32bis_state_t *s, int bit_rate)
	Reinitialise an existing V.32bis modem context.
v32bis_state_t *	v32bis_init (v32bis_state_t s, int bit_rate, int caller, get_bit_func_t get_bit, put_bit_func_t put_bit, void user_data)
	Initialise a V.32bis modem context.
int	v32bis_free (v32bis_state_t *s)
	Free a V.32bis modem receive context.
void	v32bis_set_get_bit (v32bis_state_t s, get_bit_func_t get_bit, void user_data)
	Change the get_bit function associated with a V.32bis modem context.
void	v32bis_set_put_bit (v32bis_state_t s, put_bit_func_t put_bit, void user_data)
	Change the put_bit function associated with a V.32bis modem context.
Variables
const complexf_t	v32bis_constellation [16]