modem_connect_tones.h File Reference

Go to the source code of this file.

Classes
struct	modem_connect_tones_tx_state_t
struct	modem_connect_tones_rx_state_t
Defines
#define	_SPANDSP_MODEM_CONNECT_TONES_H_
#define	MODEM_CONNECT_TONES_FAX_CED   MODEM_CONNECT_TONES_ANS
	FAX CED tone is the same as ANS tone.
Enumerations
enum	{   MODEM_CONNECT_TONES_NONE = 0, MODEM_CONNECT_TONES_FAX_CNG = 1, MODEM_CONNECT_TONES_ANS = 2, MODEM_CONNECT_TONES_ANS_PR = 3,   MODEM_CONNECT_TONES_ANSAM = 4, MODEM_CONNECT_TONES_ANSAM_PR = 5, MODEM_CONNECT_TONES_FAX_PREAMBLE = 6, MODEM_CONNECT_TONES_FAX_CED_OR_PREAMBLE = 7 }
Functions
modem_connect_tones_tx_state_t *	modem_connect_tones_tx_init (modem_connect_tones_tx_state_t *s, int tone_type)
	Initialise an instance of the modem connect tones generator.
int	modem_connect_tones_tx_free (modem_connect_tones_tx_state_t *s)
	Free an instance of the modem connect tones generator.
int	modem_connect_tones_tx (modem_connect_tones_tx_state_t *s, int16_t amp[], int len)
	Generate a block of modem connect tones samples.
int	modem_connect_tones_rx (modem_connect_tones_rx_state_t *s, const int16_t amp[], int len)
	Process a block of samples through an instance of the modem connect tones detector.
int	modem_connect_tones_rx_get (modem_connect_tones_rx_state_t *s)
	Test if a modem_connect tone has been detected.
modem_connect_tones_rx_state_t *	modem_connect_tones_rx_init (modem_connect_tones_rx_state_t *s, int tone_type, tone_report_func_t tone_callback, void *user_data)
	Initialise an instance of the modem connect tones detector.
int	modem_connect_tones_rx_free (modem_connect_tones_rx_state_t *s)
	Free an instance of the modem connect tones detector.
const char *	modem_connect_tone_to_str (int tone)

---

Detailed Description

---

Enumeration Type Documentation

anonymous enum

Enumerator:

MODEM_CONNECT_TONES_NONE	This is reported when a tone stops.
MODEM_CONNECT_TONES_FAX_CNG	CNG tone is a pure 1100Hz tone, in 0.5s bursts, with 3s silences in between. The bursts repeat for as long as is required.
MODEM_CONNECT_TONES_ANS	ANS tone is a pure continuous 2100Hz+-15Hz tone for 3.3s+-0.7s.
MODEM_CONNECT_TONES_ANS_PR	ANS with phase reversals tone is a 2100Hz+-15Hz tone for 3.3s+-0.7s, with a 180 degree phase jump every 450ms+-25ms.
MODEM_CONNECT_TONES_ANSAM	The ANSam tone is a version of ANS with 20% of 15Hz+-0.1Hz AM modulation, as per V.8.
MODEM_CONNECT_TONES_ANSAM_PR	The ANSam with phase reversals tone is a version of ANS_PR with 20% of 15Hz+-0.1Hz AM modulation, as per V.8.
MODEM_CONNECT_TONES_FAX_PREAMBLE	FAX preamble in a string of V.21 HDLC flag octets. This is only valid as a result of tone detection. It should not be specified as a tone type to transmit or receive.
MODEM_CONNECT_TONES_FAX_CED_OR_PREAMBLE	CED tone is the same as ANS tone. FAX preamble in a string of V.21 HDLC flag octets. This is only valid as a tone type to receive. It is never reported as a detected tone type. The report will either be for FAX preamble or CED/ANS tone.

---

Function Documentation

int modem_connect_tones_rx	(	modem_connect_tones_rx_state_t *	s,
		const int16_t	amp[],
		int	len
	)

Process a block of samples through an instance of the modem connect tones detector.

Parameters:

	s	The context.
	amp	An array of signal samples.
	len	The number of samples in the array.

Returns:

The number of unprocessed samples.

References modem_connect_tones_rx_state_t::channel_level, fsk_rx(), modem_connect_tones_rx_state_t::good_cycles, MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM_PR, MODEM_CONNECT_TONES_FAX_CED_OR_PREAMBLE, MODEM_CONNECT_TONES_FAX_CNG, MODEM_CONNECT_TONES_NONE, modem_connect_tones_rx_state_t::notch_level, modem_connect_tones_rx_state_t::tone_cycle_duration, modem_connect_tones_rx_state_t::tone_on, modem_connect_tones_rx_state_t::tone_present, modem_connect_tones_rx_state_t::tone_type, modem_connect_tones_rx_state_t::v21rx, modem_connect_tones_rx_state_t::z1, and modem_connect_tones_rx_state_t::z2.

Referenced by v8_rx().

int modem_connect_tones_rx_free

(

modem_connect_tones_rx_state_t *

s

)

Free an instance of the modem connect tones detector.

Parameters:

s

The context.

Returns:

0 for OK, else -1.

int modem_connect_tones_rx_get

(

modem_connect_tones_rx_state_t *

s

)

Test if a modem_connect tone has been detected.

Parameters:

s

The context.

Returns:

TRUE if tone is detected, else FALSE.

References modem_connect_tones_rx_state_t::hit, and MODEM_CONNECT_TONES_NONE.

Referenced by v8_rx().

modem_connect_tones_rx_state_t* modem_connect_tones_rx_init	(	modem_connect_tones_rx_state_t *	s,
		int	tone_type,
		tone_report_func_t	tone_callback,
		void *	user_data
	)

Initialise an instance of the modem connect tones detector.

Parameters:

	s	The context.
	tone_type	The type of connect tone being tested for.
	tone_callback	An optional callback routine, used to report tones
	user_data	An opaque pointer passed to the callback routine,

Returns:

A pointer to the context.

References modem_connect_tones_rx_state_t::callback_data, modem_connect_tones_rx_state_t::channel_level, modem_connect_tones_rx_state_t::flags_seen, modem_connect_tones_rx_state_t::framing_ok_announced, fsk_rx_init(), fsk_rx_signal_cutoff(), modem_connect_tones_rx_state_t::good_cycles, modem_connect_tones_rx_state_t::hit, MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM, MODEM_CONNECT_TONES_ANSAM_PR, MODEM_CONNECT_TONES_FAX_CED_OR_PREAMBLE, MODEM_CONNECT_TONES_NONE, modem_connect_tones_rx_state_t::notch_level, modem_connect_tones_rx_state_t::num_bits, modem_connect_tones_rx_state_t::raw_bit_stream, modem_connect_tones_rx_state_t::tone_callback, modem_connect_tones_rx_state_t::tone_cycle_duration, modem_connect_tones_rx_state_t::tone_on, modem_connect_tones_rx_state_t::tone_present, modem_connect_tones_rx_state_t::tone_type, modem_connect_tones_rx_state_t::v21rx, modem_connect_tones_rx_state_t::z1, and modem_connect_tones_rx_state_t::z2.

Referenced by v8_rx().

int modem_connect_tones_tx	(	modem_connect_tones_tx_state_t *	s,
		int16_t	amp[],
		int	len
	)

Generate a block of modem connect tones samples.

Parameters:

	s	The context.
	amp	An array of signal samples.
	len	The number of samples to generate.

Returns:

The number of samples generated.

References dds_mod(), modem_connect_tones_tx_state_t::duration_timer, modem_connect_tones_tx_state_t::hop_timer, modem_connect_tones_tx_state_t::level, modem_connect_tones_tx_state_t::mod_level, modem_connect_tones_tx_state_t::mod_phase, modem_connect_tones_tx_state_t::mod_phase_rate, MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM, MODEM_CONNECT_TONES_ANSAM_PR, MODEM_CONNECT_TONES_FAX_CNG, modem_connect_tones_tx_state_t::tone_phase, modem_connect_tones_tx_state_t::tone_phase_rate, and modem_connect_tones_tx_state_t::tone_type.

Referenced by v8_tx().

int modem_connect_tones_tx_free

(

modem_connect_tones_tx_state_t *

s

)

Free an instance of the modem connect tones generator.

Parameters:

s

The context.

Returns:

0 for OK, else -1.

modem_connect_tones_tx_state_t* modem_connect_tones_tx_init	(	modem_connect_tones_tx_state_t *	s,
		int	tone_type
	)

Initialise an instance of the modem connect tones generator.

Parameters:

s

The context.

References dds_phase_rate(), dds_scaling_dbm0(), modem_connect_tones_tx_state_t::duration_timer, modem_connect_tones_tx_state_t::hop_timer, modem_connect_tones_tx_state_t::level, modem_connect_tones_tx_state_t::mod_level, modem_connect_tones_tx_state_t::mod_phase, modem_connect_tones_tx_state_t::mod_phase_rate, MODEM_CONNECT_TONES_ANS, MODEM_CONNECT_TONES_ANS_PR, MODEM_CONNECT_TONES_ANSAM, MODEM_CONNECT_TONES_ANSAM_PR, MODEM_CONNECT_TONES_FAX_CNG, modem_connect_tones_tx_state_t::tone_phase, modem_connect_tones_tx_state_t::tone_phase_rate, and modem_connect_tones_tx_state_t::tone_type.

Referenced by v8_rx().