sig_tone.h File Reference

Go to the source code of this file.

Classes

struct  sig_tone_descriptor_t
struct  sig_tone_state_t

Defines

#define _SIG_TONE_H_
#define SIG_TONE_1_PRESENT   0x001
#define SIG_TONE_2_PRESENT   0x004
#define SIG_TONE_TX_PASSTHROUGH   0x010
#define SIG_TONE_RX_PASSTHROUGH   0x020
#define SIG_TONE_UPDATE_REQUEST   0x100

Typedefs

typedef int(*) sig_tone_func_t (void *user_data, int what)

Enumerations

enum  { SIG_TONE_2280HZ = 1, SIG_TONE_2600HZ, SIG_TONE_2400HZ_2600HZ }

Functions

sig_tone_state_t * sig_tone_init (sig_tone_state_t *s, int tone_type, sig_tone_func_t sig_update, void *user_data)
 Initialise a signaling tone context.
int sig_tone_rx (sig_tone_state_t *s, int16_t amp[], int len)
 Process a block of received audio samples.
int sig_tone_tx (sig_tone_state_t *s, int16_t amp[], int len)
 Generate a block of signaling tone audio samples.


Detailed Description


Function Documentation

sig_tone_state_t* sig_tone_init ( sig_tone_state_t *  s,
int  tone_type,
sig_tone_func_t  sig_update,
void *  user_data 
)

Initialise a signaling tone context.

Initialise a signaling tone 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.

int sig_tone_rx ( sig_tone_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 signaling tone context.
amp The audio sample buffer.
len The number of samples in the buffer.
Returns:
The number of samples unprocessed.

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

Generate a block of signaling tone audio samples.

Generate a block of signaling tone audio samples.

Parameters:
s The signaling tone context.
amp The audio sample buffer.
len The number of samples to be generated.
Returns:
The number of samples actually generated.


Generated on Fri Nov 10 09:40:24 2006 for libspandsp by  doxygen 1.5.1