v17tx.h File Reference

Go to the source code of this file.

Classes

struct  v17_tx_state_t

Defines

#define _SPANDSP_V17TX_H_
#define V17_TX_FILTER_STEPS   9

Functions

void v17_tx_power (v17_tx_state_t *s, float power)
 Adjust a V.17 modem transmit context's output power.
v17_tx_state_tv17_tx_init (v17_tx_state_t *s, int rate, int tep, get_bit_func_t get_bit, void *user_data)
 Initialise a V.17 modem transmit context.
int v17_tx_restart (v17_tx_state_t *s, int rate, int tep, int short_train)
 Reinitialise an existing V.17 modem transmit context.
int v17_tx_release (v17_tx_state_t *s)
 Release a V.17 modem transmit context.
void v17_tx_set_get_bit (v17_tx_state_t *s, get_bit_func_t get_bit, void *user_data)
 Change the get_bit function associated with a V.17 modem transmit context.
int v17_tx (v17_tx_state_t *s, int16_t amp[], int len)
 Generate a block of V.17 modem audio samples.


Detailed Description


Function Documentation

int v17_tx ( v17_tx_state_t s,
int16_t  amp[],
int  len 
)

Generate a block of V.17 modem audio samples.

Generate a block of V.17 modem audio samples.

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

v17_tx_state_t* v17_tx_init ( v17_tx_state_t s,
int  rate,
int  tep,
get_bit_func_t  get_bit,
void *  user_data 
)

Initialise a V.17 modem transmit context.

Initialise a V.17 modem transmit context. This must be called before the first use of the context, to initialise its contents.

Parameters:
s The modem context.
rate The bit rate of the modem. Valid values are 7200, 9600, 12000 and 14400.
tep TRUE is the optional TEP tone is to be transmitted.
get_bit The callback routine used to get the data to be transmitted.
user_data An opaque pointer.
Returns:
A pointer to the modem context, or NULL if there was a problem.

void v17_tx_power ( v17_tx_state_t s,
float  power 
)

Adjust a V.17 modem transmit context's output power.

Adjust a V.17 modem transmit context's power output.

Parameters:
s The modem context.
power The power level, in dBm0

int v17_tx_release ( v17_tx_state_t s  ) 

Release a V.17 modem transmit context.

Release a V.17 modem transmit context.

Parameters:
s The modem context.
Returns:
0 for OK

int v17_tx_restart ( v17_tx_state_t s,
int  rate,
int  tep,
int  short_train 
)

Reinitialise an existing V.17 modem transmit context.

Reinitialise an existing V.17 modem transmit context, so it may be reused.

Parameters:
s The modem context.
rate The bit rate of the modem. Valid values are 7200, 9600, 12000 and 14400.
tep TRUE is the optional TEP tone is to be transmitted.
short_train TRUE if the short training sequence should be used.
Returns:
0 for OK, -1 for parameter error.

void v17_tx_set_get_bit ( v17_tx_state_t s,
get_bit_func_t  get_bit,
void *  user_data 
)

Change the get_bit function associated with a V.17 modem transmit context.

Change the get_bit function associated with a V.17 modem transmit context.

Parameters:
s The modem context.
get_bit The callback routine used to get the data to be transmitted.
user_data An opaque pointer.


Generated on Tue Jul 24 11:29:29 2007 for libspandsp by  doxygen 1.5.2