Main Page | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

sig_tone.h File Reference

Go to the source code of this file.

Typedefs

typedef int(* sig_tone_func_t )(void *user_data, int what)
typedef sig_tone_descriptor_s sig_tone_descriptor_t
typedef sig_tone_tx_state_s sig_tone_tx_state_t
typedef 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 = 0x020, SIG_TONE_UPDATE_REQUEST = 0x100
}

Functions

 SPAN_DECLARE (int) sig_tone_rx(sig_tone_rx_state_t *s
 Release a V.8 context.
 SPAN_DECLARE (sig_tone_rx_state_t *) sig_tone_rx_init(sig_tone_rx_state_t *s
 Initialise a signaling tone context.
 SPAN_DECLARE (void) sig_tone_tx_set_mode(sig_tone_tx_state_t *s
 Cleanup a T.30 context if the call terminates.
 SPAN_DECLARE (sig_tone_tx_state_t *) sig_tone_tx_init(sig_tone_tx_state_t *s
 Initialise a signaling tone context.

Variables

int16_t amp []
int16_t int len
int tone_type
int sig_tone_func_t sig_update
int sig_tone_func_t void * user_data
int mode


Detailed Description


Typedef Documentation

typedef struct sig_tone_descriptor_s sig_tone_descriptor_t
 

Signaling tone descriptor. This defines the working state for a single instance of the transmit and receive sides of a signaling tone processor.


Enumeration Type Documentation

anonymous enum
 

Enumeration values:
SIG_TONE_2280HZ  European 2280Hz signaling tone
SIG_TONE_2600HZ  US 2600Hz signaling tone
SIG_TONE_2400HZ_2600HZ  US 2400Hz + 2600Hz signaling tones

anonymous enum
 

Enumeration values:
SIG_TONE_1_PRESENT  Signaling tone 1 is present
SIG_TONE_2_PRESENT  Signaling tone 2 is present
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.


Function Documentation

SPAN_DECLARE sig_tone_tx_state_t *   ) 
 

Initialise a signaling tone context.

Initialise a signaling tone transmitter context.

Parameters:
s The signaling tone context.
tone_type The type of signaling tone.
sig_update Callback function to handle signaling updates.
user_data An opaque pointer.
Returns:
A pointer to the signalling tone context, or NULL if there was a problem.

SPAN_DECLARE void   ) 
 

Cleanup a T.30 context if the call terminates.

Set the tone mode.

Parameters:
s The signaling tone context.
mode The new mode for the transmitted tones.

SPAN_DECLARE sig_tone_rx_state_t *   ) 
 

Initialise a signaling tone context.

Initialise a signaling tone receiver context.

Parameters:
s The signaling tone context.
tone_type The type of signaling tone.
sig_update Callback function to handle signaling updates.
user_data An opaque pointer.
Returns:
A pointer to the signalling tone context, or NULL if there was a problem.

SPAN_DECLARE int   ) 
 

Release a V.8 context.

Process a block of received audio samples.

Parameters:
s The signaling tone context.
amp The audio sample buffer.
len The number of samples in the buffer.
Returns:
The number of samples unprocessed.


Generated on Fri Aug 28 20:12:28 2009 for spandsp by  doxygen 1.3.9.1