sig_tone.h File Reference

Go to the source code of this file.

Typedefs
typedef struct sig_tone_tx_state_s	sig_tone_tx_state_t
typedef struct sig_tone_rx_state_s	sig_tone_rx_state_t
Enumerations
enum	{ SIG_TONE_2280HZ = 1, SIG_TONE_2600HZ, SIG_TONE_2400HZ_2600HZ }
enum	{   SIG_TONE_1_PRESENT = 0x001, SIG_TONE_1_CHANGE = 0x002, SIG_TONE_2_PRESENT = 0x004, SIG_TONE_2_CHANGE = 0x008,   SIG_TONE_TX_PASSTHROUGH = 0x010, SIG_TONE_RX_PASSTHROUGH = 0x040, SIG_TONE_RX_FILTER_TONE = 0x080, SIG_TONE_TX_UPDATE_REQUEST = 0x100,   SIG_TONE_RX_UPDATE_REQUEST = 0x200 }
Functions
int	sig_tone_rx (sig_tone_rx_state_t *s, int16_t amp[], int len)
	Process a block of received audio samples.
void	sig_tone_rx_set_mode (sig_tone_rx_state_t *s, int mode, int duration)
	Set the receive mode.
sig_tone_rx_state_t *	sig_tone_rx_init (sig_tone_rx_state_t *s, int tone_type, tone_report_func_t sig_update, void *user_data)
	Initialise a signalling tone context.
int	sig_tone_rx_release (sig_tone_rx_state_t *s)
	Release a signalling tone receiver context.
int	sig_tone_rx_free (sig_tone_rx_state_t *s)
	Free a signalling tone receiver context.
int	sig_tone_tx (sig_tone_tx_state_t *s, int16_t amp[], int len)
	Generate a block of signalling tone audio samples.
void	sig_tone_tx_set_mode (sig_tone_tx_state_t *s, int mode, int duration)
	Set the tone mode.
sig_tone_tx_state_t *	sig_tone_tx_init (sig_tone_tx_state_t *s, int tone_type, tone_report_func_t sig_update, void *user_data)
	Initialise a signalling tone context.
int	sig_tone_tx_release (sig_tone_tx_state_t *s)
	Release a signalling tone transmitter context.
int	sig_tone_tx_free (sig_tone_tx_state_t *s)
	Free a signalling tone transmitter context.

---

Detailed Description

---

Enumeration Type Documentation

anonymous enum

Enumerator:

SIG_TONE_2280HZ	European 2280Hz signalling tone. Tone 1 is 2280Hz. Tone 2 is not used.
SIG_TONE_2600HZ	US 2600Hz signalling tone. Tone 1 is 2600Hz. Tone 2 is not used.
SIG_TONE_2400HZ_2600HZ	US 2400Hz + 2600Hz signalling tones. Tone 1 is 2600Hz. Tone 2 is 2400Hz.

anonymous enum

Enumerator:

SIG_TONE_1_PRESENT	Signalling tone 1 is present
SIG_TONE_1_CHANGE	Signalling tone 1 has changed state (ignored when setting tx mode)
SIG_TONE_2_PRESENT	Signalling tone 2 is present
SIG_TONE_2_CHANGE	Signalling tone 2 has changed state (ignored when setting tx mode)
SIG_TONE_TX_PASSTHROUGH	The media signal is passing through. Tones might be added to it.
SIG_TONE_RX_PASSTHROUGH	The media signal is passing through. Tones might be extracted from it, if detected.
SIG_TONE_RX_FILTER_TONE	Force filtering of the signalling tone, whether signalling is being detected or not. This is mostly useful for test purposes.
SIG_TONE_TX_UPDATE_REQUEST	Request an update of the transmit status, upon timeout of the previous status.
SIG_TONE_RX_UPDATE_REQUEST	Request an update of the receiver status, upon timeout of the previous status.

---

Function Documentation

int sig_tone_rx	(	sig_tone_rx_state_t *	s,
		int16_t	amp[],
		int	len
	)

Process a block of received audio samples.

Process a block of received audio samples.

Parameters:

s	The signalling tone context.
amp	The audio sample buffer.
len	The number of samples in the buffer.

Returns:

The number of samples unprocessed.

References power_meter_update(), SIG_TONE_1_CHANGE, SIG_TONE_1_PRESENT, SIG_TONE_2_CHANGE, SIG_TONE_2_PRESENT, SIG_TONE_RX_FILTER_TONE, and SIG_TONE_RX_PASSTHROUGH.

int sig_tone_rx_free

(

sig_tone_rx_state_t *

s

)

Free a signalling tone receiver context.

Free a signalling tone receiver context.

Parameters:

s	The signalling tone context.

Returns:

0 for OK

sig_tone_rx_state_t* sig_tone_rx_init	(	sig_tone_rx_state_t *	s,
		int	tone_type,
		tone_report_func_t	sig_update,
		void *	user_data
	)

Initialise a signalling tone context.

Initialise a signalling tone receiver context.

Parameters:

s	The signalling tone context.
tone_type	The type of signalling tone.
sig_update	Callback function to handle signalling updates.
user_data	An opaque pointer.

Returns:

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

References power_meter_init(), and power_meter_level_dbm0().

int sig_tone_rx_release

(

sig_tone_rx_state_t *

s

)

Release a signalling tone receiver context.

Release a signalling tone receiver context.

Parameters:

s	The signalling tone context.

Returns:

0 for OK

void sig_tone_rx_set_mode	(	sig_tone_rx_state_t *	s,
		int	mode,
		int	duration
	)

Set the receive mode.

Set the receive mode.

Parameters:

s	The signalling tone context.
mode	The new mode for the receiver.
duration	The duration for this mode, before an update is requested. A duration of zero means forever.

int sig_tone_tx	(	sig_tone_tx_state_t *	s,
		int16_t	amp[],
		int	len
	)

Generate a block of signalling tone audio samples.

Generate a block of signalling tone audio samples.

Parameters:

s	The signalling tone context.
amp	The audio sample buffer.
len	The number of samples to be generated.

Returns:

The number of samples actually generated.

References dds_mod(), SIG_TONE_1_PRESENT, SIG_TONE_2_PRESENT, SIG_TONE_TX_PASSTHROUGH, and SIG_TONE_TX_UPDATE_REQUEST.

int sig_tone_tx_free

(

sig_tone_tx_state_t *

s

)

Free a signalling tone transmitter context.

Free a signalling tone transmitter context.

Parameters:

s	The signalling tone context.

Returns:

0 for OK

sig_tone_tx_state_t* sig_tone_tx_init	(	sig_tone_tx_state_t *	s,
		int	tone_type,
		tone_report_func_t	sig_update,
		void *	user_data
	)

Initialise a signalling tone context.

Initialise a signalling tone transmitter context.

Parameters:

s	The signalling tone context.
tone_type	The type of signalling tone.
sig_update	Callback function to handle signalling updates.
user_data	An opaque pointer.

Returns:

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

References dds_phase_rate(), and dds_scaling_dbm0().

int sig_tone_tx_release

(

sig_tone_tx_state_t *

s

)

Release a signalling tone transmitter context.

Release a signalling tone transmitter context.

Parameters:

s	The signalling tone context.

Returns:

0 for OK

void sig_tone_tx_set_mode	(	sig_tone_tx_state_t *	s,
		int	mode,
		int	duration
	)

Set the tone mode.

Set the tone mode.

Parameters:

s	The signalling tone context.
mode	The new mode for the transmitted tones.
duration	The duration for this mode, before an update is requested. A duration of zero means forever.

References SIG_TONE_1_PRESENT, and SIG_TONE_2_PRESENT.