modem_connect_tones_rx_state_s Struct Reference

#include <modem_connect_tones.h>

Public Attributes
int	tone_type
	The tone type being detected.
bool	real_time_reports
span_tone_report_func_t	tone_callback
	Callback routine, using to report detection of the tone.
void *	callback_data
	An opaque pointer passed to tone_callback.
float	znotch_1
	The notch filter state.
float	znotch_2
float	z15hz_1
	The 15Hz AM filter state.
float	z15hz_2
int32_t	notch_level
	The in notch power estimate.
int32_t	channel_level
	The total channel power estimate.
int32_t	am_level
	The 15Hz AM power estimate.
int	chunk_remainder
	Sample counter for the small chunks of samples, after which a test is conducted.
int	tone_present
	The code for the tone currently confirmed present in the audio.
int	tone_on
int	tone_cycle_duration
	A millisecond counter, to time the duration of tone sections.
int	good_cycles
	A count of the number of good cycles of tone reversal seen.
int	hit
	The confirmed tone code.
fsk_rx_state_t	v21rx
	A V.21 FSK modem context used when searching for FAX preamble.
unsigned int	raw_bit_stream
	The raw (stuffed) bit stream buffer.
int	num_bits
	The current number of bits in the octet in progress.
int	flags_seen
	Number of consecutive flags seen so far.
bool	framing_ok_announced
	True if framing OK has been announced.

Detailed Description

Modem connect tones receiver descriptor. This defines the state of a single working instance of the tone detector.

Member Data Documentation

am_level

int32_t modem_connect_tones_rx_state_s::am_level

The 15Hz AM power estimate.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

callback_data

void* modem_connect_tones_rx_state_s::callback_data

An opaque pointer passed to tone_callback.

Referenced by modem_connect_tones_rx_init().

channel_level

int32_t modem_connect_tones_rx_state_s::channel_level

The total channel power estimate.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

flags_seen

int modem_connect_tones_rx_state_s::flags_seen

Number of consecutive flags seen so far.

Referenced by modem_connect_tones_rx_init().

framing_ok_announced

bool modem_connect_tones_rx_state_s::framing_ok_announced

True if framing OK has been announced.

Referenced by modem_connect_tones_rx_init().

good_cycles

int modem_connect_tones_rx_state_s::good_cycles

A count of the number of good cycles of tone reversal seen.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

hit

int modem_connect_tones_rx_state_s::hit

The confirmed tone code.

Referenced by modem_connect_tones_rx_get(), and modem_connect_tones_rx_init().

notch_level

int32_t modem_connect_tones_rx_state_s::notch_level

The in notch power estimate.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

num_bits

int modem_connect_tones_rx_state_s::num_bits

The current number of bits in the octet in progress.

Referenced by modem_connect_tones_rx_init().

raw_bit_stream

unsigned int modem_connect_tones_rx_state_s::raw_bit_stream

The raw (stuffed) bit stream buffer.

Referenced by modem_connect_tones_rx_init().

tone_callback

span_tone_report_func_t modem_connect_tones_rx_state_s::tone_callback

Callback routine, using to report detection of the tone.

Referenced by modem_connect_tones_rx_init().

tone_cycle_duration

int modem_connect_tones_rx_state_s::tone_cycle_duration

A millisecond counter, to time the duration of tone sections.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

tone_present

int modem_connect_tones_rx_state_s::tone_present

The code for the tone currently confirmed present in the audio.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

tone_type

int modem_connect_tones_rx_state_s::tone_type

The tone type being detected.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

v21rx

fsk_rx_state_t modem_connect_tones_rx_state_s::v21rx

A V.21 FSK modem context used when searching for FAX preamble.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

z15hz_1

float modem_connect_tones_rx_state_s::z15hz_1

The 15Hz AM filter state.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

znotch_1

float modem_connect_tones_rx_state_s::znotch_1

The notch filter state.

Referenced by modem_connect_tones_rx(), and modem_connect_tones_rx_init().

---

The documentation for this struct was generated from the following file:

• private/modem_connect_tones.h