v29rx.h File Reference

Go to the source code of this file.

Classes
struct	v29_rx_state_t
Defines
#define	_V29RX_H_
#define	V29_EQUALIZER_PRE_LEN   15
#define	V29_EQUALIZER_POST_LEN   15
#define	V29_EQUALIZER_MASK   63
#define	V29_RX_FILTER_STEPS   27
Typedefs
typedef void(	qam_report_handler_t )(void *user_data, const complexf_t *constel, const complexf_t *target, int symbol)
Functions
v29_rx_state_t *	v29_rx_init (v29_rx_state_t *s, int rate, put_bit_func_t put_bit, void *user_data)
	Initialise a V.29 modem receive context.
int	v29_rx_restart (v29_rx_state_t *s, int rate, int old_train)
	Reinitialise an existing V.29 modem receive context.
int	v29_rx_release (v29_rx_state_t *s)
	Release a V.29 modem receive context.
void	v29_rx_set_put_bit (v29_rx_state_t *s, put_bit_func_t put_bit, void *user_data)
	Change the put_bit function associated with a V.29 modem receive context.
int	v29_rx (v29_rx_state_t *s, const int16_t amp[], int len)
	Process a block of received V.29 modem audio samples.
int	v29_rx_equalizer_state (v29_rx_state_t *s, complexf_t **coeffs)
	Get a snapshot of the current equalizer coefficients.
float	v29_rx_carrier_frequency (v29_rx_state_t *s)
float	v29_rx_symbol_timing_correction (v29_rx_state_t *s)
float	v29_rx_signal_power (v29_rx_state_t *s)
void	v29_rx_signal_cutoff (v29_rx_state_t *s, float cutoff)
void	v29_rx_set_qam_report_handler (v29_rx_state_t *s, qam_report_handler_t *handler, void *user_data)

---

Detailed Description

---

Function Documentation

int v29_rx	(	v29_rx_state_t *	s,
		const int16_t	amp[],
		int	len
	)

Process a block of received V.29 modem audio samples.

Process a block of received V.29 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 v29_rx_carrier_frequency

(

v29_rx_state_t *

s

)

Get the current received carrier frequency.

Parameters:

s

The modem context.

Returns:

The frequency, in Hertz.

int v29_rx_equalizer_state	(	v29_rx_state_t *	s,
		complexf_t **	coeffs
	)

Get a snapshot of the current equalizer coefficients.

Get a snapshot of the current equalizer coefficients.

Parameters:

	s	The modem context.
	coeffs	The vector of complex coefficients.

Returns:

The number of coefficients in the vector.

v29_rx_state_t* v29_rx_init	(	v29_rx_state_t *	s,
		int	rate,
		put_bit_func_t	put_bit,
		void *	user_data
	)

Initialise a V.29 modem receive context.

Initialise a V.29 modem receive context.

Parameters:

	s	The modem context.
	rate	The bit rate of the modem. Valid values are 4800, 7200 and 9600.
	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 v29_rx_release

(

v29_rx_state_t *

s

)

Release a V.29 modem receive context.

Release a V.29 modem receive context.

Parameters:

s

The modem context.

Returns:

0 for OK

int v29_rx_restart	(	v29_rx_state_t *	s,
		int	rate,
		int	old_train
	)

Reinitialise an existing V.29 modem receive context.

Reinitialise an existing V.29 modem receive context.

Parameters:

	s	The modem context.
	rate	The bit rate of the modem. Valid values are 4800, 7200 and 9600.
	old_train	TRUE if a previous trained values are to be reused.

Returns:

0 for OK, -1 for bad parameter

void v29_rx_set_put_bit	(	v29_rx_state_t *	s,
		put_bit_func_t	put_bit,
		void *	user_data
	)

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

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

Parameters:

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

void v29_rx_set_qam_report_handler	(	v29_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 v29_rx_signal_cutoff	(	v29_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 v29_rx_signal_power

(

v29_rx_state_t *

s

)

Get the current received signal power.

Parameters:

s

The modem context.

Returns:

The signal power, in dBm0.

float v29_rx_symbol_timing_correction

(

v29_rx_state_t *

s

)

Get the current symbol timing correction since startup.

Parameters:

s

The modem context.

Returns:

The correction.

---