sig_tone_rx_state_s Struct Reference

#include <sig_tone.h>

Classes
struct	[struct].tone

Public Attributes
span_tone_report_func_t	sig_update
	The callback function used to handle signalling changes.
void *	user_data
	A user specified opaque pointer passed to the callback function.
const sig_tone_descriptor_t *	desc
	Tone descriptor.
int	current_rx_tone
	The current receive tone.
span_sample_timer_t	high_low_timer
	The timeout for switching from the high level to low level tone detector.
int	current_notch_filter
	???
struct	tone [3]
float	flat_z [2]
	The z's for the weighting/bandpass filter.
power_meter_t	flat_power
	The output power of the flat (unfiltered or flat filtered) path.
span_sample_timer_t	tone_persistence_timeout
	Persistence check for tone present.
int	last_sample_tone_present
	The tone pattern on the last audio sample.
int32_t	flat_detection_threshold
	The minimum reading from the power meter for detection in flat mode.
int32_t	sharp_detection_threshold
	The minimum reading from the power meter for detection in sharp mode.
int32_t	detection_ratio
	The minimum ratio between notched power and total power for detection.
bool	flat_mode
	True if in flat mode. False if in sharp mode.
bool	notch_enabled
	True if the notch filter is enabled in the media path.
span_sample_timer_t	flat_mode_timeout
	???
span_sample_timer_t	notch_insertion_timeout
	???
int	signalling_state
	???
span_sample_timer_t	signalling_state_duration
	???

Detailed Description

Signalling tone receive state

Member Data Documentation

current_notch_filter

int sig_tone_rx_state_s::current_notch_filter

???

Referenced by sig_tone_rx().

current_rx_tone

int sig_tone_rx_state_s::current_rx_tone

The current receive tone.

Referenced by sig_tone_rx(), and sig_tone_rx_set_mode().

desc

const sig_tone_descriptor_t* sig_tone_rx_state_s::desc

Tone descriptor.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

detection_ratio

int32_t sig_tone_rx_state_s::detection_ratio

The minimum ratio between notched power and total power for detection.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

flat_detection_threshold

int32_t sig_tone_rx_state_s::flat_detection_threshold

The minimum reading from the power meter for detection in flat mode.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

flat_mode

bool sig_tone_rx_state_s::flat_mode

True if in flat mode. False if in sharp mode.

Referenced by sig_tone_rx().

flat_mode_timeout

span_sample_timer_t sig_tone_rx_state_s::flat_mode_timeout

???

Referenced by sig_tone_rx().

flat_power

power_meter_t sig_tone_rx_state_s::flat_power

The output power of the flat (unfiltered or flat filtered) path.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

flat_z

float sig_tone_rx_state_s::flat_z[2]

The z's for the weighting/bandpass filter.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

last_sample_tone_present

int sig_tone_rx_state_s::last_sample_tone_present

The tone pattern on the last audio sample.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

notch_insertion_timeout

span_sample_timer_t sig_tone_rx_state_s::notch_insertion_timeout

???

Referenced by sig_tone_rx().

sharp_detection_threshold

int32_t sig_tone_rx_state_s::sharp_detection_threshold

The minimum reading from the power meter for detection in sharp mode.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

sig_update

span_tone_report_func_t sig_tone_rx_state_s::sig_update

The callback function used to handle signalling changes.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

signalling_state

int sig_tone_rx_state_s::signalling_state

???

Referenced by sig_tone_rx().

signalling_state_duration

span_sample_timer_t sig_tone_rx_state_s::signalling_state_duration

???

Referenced by sig_tone_rx().

tone_persistence_timeout

span_sample_timer_t sig_tone_rx_state_s::tone_persistence_timeout

Persistence check for tone present.

Referenced by sig_tone_rx().

user_data

void* sig_tone_rx_state_s::user_data

A user specified opaque pointer passed to the callback function.

Referenced by sig_tone_rx(), and sig_tone_rx_init().

---

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

• private/sig_tone.h