fsk.h File Reference

Go to the source code of this file.

Classes
struct	fsk_spec_t
struct	fsk_tx_state_t
struct	fsk_rx_state_t
Defines
#define	_SPANDSP_FSK_H_
#define	FSK_MAX_WINDOW_LEN   128
Enumerations
enum	{   FSK_V21CH1 = 0, FSK_V21CH2, FSK_V23CH1, FSK_V23CH2,   FSK_BELL103CH1, FSK_BELL103CH2, FSK_BELL202, FSK_WEITBRECHT }
Functions
fsk_tx_state_t *	fsk_tx_init (fsk_tx_state_t *s, const fsk_spec_t *spec, get_bit_func_t get_bit, void *user_data)
	Initialise an FSK modem transmit context.
void	fsk_tx_power (fsk_tx_state_t *s, float power)
	Adjust an FSK modem transmit context's power output.
void	fsk_tx_set_get_bit (fsk_tx_state_t *s, get_bit_func_t get_bit, void *user_data)
void	fsk_tx_set_modem_status_handler (fsk_tx_state_t *s, modem_tx_status_func_t handler, void *user_data)
	Change the modem status report function associated with an FSK modem transmit context.
int	fsk_tx (fsk_tx_state_t *s, int16_t *amp, int len)
	Generate a block of FSK modem audio samples.
float	fsk_rx_signal_power (fsk_rx_state_t *s)
void	fsk_rx_signal_cutoff (fsk_rx_state_t *s, float cutoff)
	Adjust an FSK modem receive context's carrier detect power threshold.
fsk_rx_state_t *	fsk_rx_init (fsk_rx_state_t *s, const fsk_spec_t *spec, int sync_mode, put_bit_func_t put_bit, void *user_data)
	Initialise an FSK modem receive context.
int	fsk_rx (fsk_rx_state_t *s, const int16_t *amp, int len)
	Process a block of received FSK modem audio samples.
void	fsk_rx_set_put_bit (fsk_rx_state_t *s, put_bit_func_t put_bit, void *user_data)
void	fsk_rx_set_modem_status_handler (fsk_rx_state_t *s, modem_rx_status_func_t handler, void *user_data)
	Change the modem status report function associated with an FSK modem receive context.
Variables
const fsk_spec_t	preset_fsk_specs []

---

Detailed Description

---

Function Documentation

int fsk_rx	(	fsk_rx_state_t *	s,
		const int16_t *	amp,
		int	len
	)

Process a block of received FSK modem audio samples.

Process a block of received FSK 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 fsk_rx_state_t::baud_inc, fsk_rx_state_t::baud_pll, fsk_rx_state_t::buf_ptr, fsk_rx_state_t::correlation_span, dds_complexi(), fsk_rx_state_t::dot, complexi_t::im, complexi32_t::im, fsk_rx_state_t::last_sample, fsk_rx_state_t::lastbit, fsk_rx_state_t::phase_acc, fsk_rx_state_t::phase_rate, fsk_rx_state_t::power, power_meter_update(), fsk_rx_state_t::put_bit, fsk_rx_state_t::put_bit_user_data, complexi_t::re, complexi32_t::re, fsk_rx_state_t::scaling_shift, SIG_STATUS_CARRIER_DOWN, SIG_STATUS_CARRIER_UP, fsk_rx_state_t::signal_present, fsk_rx_state_t::sync_mode, and fsk_rx_state_t::window.

Referenced by adsi_rx(), modem_connect_tones_rx(), and v8_rx().

fsk_rx_state_t* fsk_rx_init	(	fsk_rx_state_t *	s,
		const fsk_spec_t *	spec,
		int	sync_mode,
		put_bit_func_t	put_bit,
		void *	user_data
	)

Initialise an FSK modem receive context.

Initialise an FSK modem receive context.

Parameters:

	s	The modem context.
	spec	The specification of the modem tones and rate.
	sync_mode	TRUE for synchronous modem. FALSE for asynchronous mode.
	put_bit	The callback routine used to put the received data.
	user_data	An opaque pointer.

Returns:

A pointer to the modem context, or NULL if there was a problem.

References fsk_rx_state_t::baud_inc, fsk_rx_state_t::baud_pll, fsk_spec_t::baud_rate, fsk_rx_state_t::baud_rate, fsk_rx_state_t::correlation_span, dds_phase_rate(), fsk_spec_t::freq_one, fsk_spec_t::freq_zero, fsk_rx_signal_cutoff(), fsk_rx_state_t::last_sample, fsk_spec_t::min_level, fsk_rx_state_t::phase_acc, fsk_rx_state_t::phase_rate, fsk_rx_state_t::power, power_meter_init(), fsk_rx_state_t::put_bit, fsk_rx_state_t::put_bit_user_data, fsk_rx_state_t::scaling_shift, fsk_rx_state_t::signal_present, and fsk_rx_state_t::sync_mode.

Referenced by adsi_rx_init(), and modem_connect_tones_rx_init().

void fsk_rx_set_modem_status_handler	(	fsk_rx_state_t *	s,
		modem_rx_status_func_t	handler,
		void *	user_data
	)

Change the modem status report function associated with an FSK modem receive context.

Change the modem status report function associated with an FSK modem receive context.

Parameters:

	s	The modem context.
	handler	The callback routine used to report modem status changes.
	user_data	An opaque pointer.

References fsk_rx_state_t::status_handler, and fsk_rx_state_t::status_user_data.

void fsk_rx_signal_cutoff	(	fsk_rx_state_t *	s,
		float	cutoff
	)

Adjust an FSK modem receive context's carrier detect power threshold.

Adjust an FSK modem receive context's carrier detect power threshold.

Parameters:

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

References fsk_rx_state_t::carrier_off_power, fsk_rx_state_t::carrier_on_power, and power_meter_level_dbm0().

Referenced by fsk_rx_init(), and modem_connect_tones_rx_init().

float fsk_rx_signal_power

(

fsk_rx_state_t *

s

)

Get the current received signal power.

Parameters:

s

The modem context.

Returns:

The signal power, in dBm0.

References fsk_rx_state_t::power, and power_meter_current_dbm0().

int fsk_tx	(	fsk_tx_state_t *	s,
		int16_t *	amp,
		int	len
	)

Generate a block of FSK modem audio samples.

Generate a block of FSK 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 fsk_tx_state_t::baud_frac, fsk_tx_state_t::baud_inc, fsk_tx_state_t::current_phase_rate, dds_mod(), fsk_tx_state_t::get_bit, fsk_tx_state_t::get_bit_user_data, fsk_tx_state_t::phase_acc, fsk_tx_state_t::phase_rates, fsk_tx_state_t::scaling, fsk_tx_state_t::shutdown, SIG_STATUS_END_OF_DATA, SIG_STATUS_SHUTDOWN_COMPLETE, fsk_tx_state_t::status_handler, and fsk_tx_state_t::status_user_data.

Referenced by adsi_tx(), and v8_tx().

fsk_tx_state_t* fsk_tx_init	(	fsk_tx_state_t *	s,
		const fsk_spec_t *	spec,
		get_bit_func_t	get_bit,
		void *	user_data
	)

Initialise an FSK modem transmit context.

Initialise an FSK modem transmit context.

Parameters:

	s	The modem context.
	spec	The specification of the modem tones and rate.
	get_bit	The callback routine used to get the data to be transmitted.
	user_data	An opaque pointer.

Returns:

A pointer to the modem context, or NULL if there was a problem.

References fsk_tx_state_t::baud_frac, fsk_tx_state_t::baud_inc, fsk_spec_t::baud_rate, fsk_tx_state_t::baud_rate, fsk_tx_state_t::current_phase_rate, dds_phase_rate(), dds_scaling_dbm0(), fsk_spec_t::freq_one, fsk_spec_t::freq_zero, fsk_tx_state_t::get_bit, fsk_tx_state_t::get_bit_user_data, fsk_tx_state_t::phase_acc, fsk_tx_state_t::phase_rates, fsk_tx_state_t::scaling, fsk_tx_state_t::shutdown, and fsk_spec_t::tx_level.

Referenced by v8_rx().

void fsk_tx_power	(	fsk_tx_state_t *	s,
		float	power
	)

Adjust an FSK modem transmit context's power output.

Adjust an FSK modem transmit context's power output.

Parameters:

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

References dds_scaling_dbm0(), and fsk_tx_state_t::scaling.

void fsk_tx_set_modem_status_handler	(	fsk_tx_state_t *	s,
		modem_tx_status_func_t	handler,
		void *	user_data
	)

Change the modem status report function associated with an FSK modem transmit context.

Change the modem status report function associated with an FSK modem transmit context.

Parameters:

	s	The modem context.
	handler	The callback routine used to report modem status changes.
	user_data	An opaque pointer.

References fsk_tx_state_t::status_handler, and fsk_tx_state_t::status_user_data.