v29tx.h File Reference

Go to the source code of this file.

Defines

#define _SPANDSP_V29TX_H_
#define V29_TX_FILTER_STEPS   9

Typedefs

typedef struct v29_tx_state_s v29_tx_state_t

Functions

void v29_tx_power (v29_tx_state_t *s, float power)
 Adjust a V.29 modem transmit context's output power.
v29_tx_state_tv29_tx_init (v29_tx_state_t *s, int bit_rate, int tep, get_bit_func_t get_bit, void *user_data)
 Initialise a V.29 modem transmit context.
int v29_tx_restart (v29_tx_state_t *s, int bit_rate, int tep)
 Reinitialise an existing V.29 modem transmit context.
int v29_tx_release (v29_tx_state_t *s)
 Release a V.29 modem transmit context.
int v29_tx_free (v29_tx_state_t *s)
 Free a V.29 modem transmit context.
logging_state_tv29_tx_get_logging_state (v29_tx_state_t *s)
 Get the logging context associated with a V.29 modem transmit context.
void v29_tx_set_get_bit (v29_tx_state_t *s, get_bit_func_t get_bit, void *user_data)
 Change the get_bit function associated with a V.29 modem transmit context.
void v29_tx_set_modem_status_handler (v29_tx_state_t *s, modem_tx_status_func_t handler, void *user_data)
 Change the modem status report function associated with a V.29 modem transmit context.
int v29_tx (v29_tx_state_t *s, int16_t amp[], int len)
 Generate a block of V.29 modem audio samples.


Detailed Description


Define Documentation

#define V29_TX_FILTER_STEPS   9

The number of taps in the pulse shaping/bandpass filter

Referenced by v29_tx().


Typedef Documentation

V.29 modem transmit side descriptor. This defines the working state for a single instance of a V.29 modem transmitter.


Function Documentation

int v29_tx ( v29_tx_state_t s,
int16_t  amp[],
int  len 
)

Generate a block of V.29 modem audio samples.

Generate a block of V.29 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.

References dds_complexf(), dds_complexi(), complexf_t::im, complexf_t::re, V29_TRAINING_SHUTDOWN_END, and V29_TX_FILTER_STEPS.

int v29_tx_free ( v29_tx_state_t s  ) 

Free a V.29 modem transmit context.

Free a V.29 modem transmit context.

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

logging_state_t* v29_tx_get_logging_state ( v29_tx_state_t s  ) 

Get the logging context associated with a V.29 modem transmit context.

Get the logging context associated with a V.29 modem transmit context.

Parameters:
s The modem context.
Returns:
A pointer to the logging context

v29_tx_state_t* v29_tx_init ( v29_tx_state_t s,
int  bit_rate,
int  tep,
get_bit_func_t  get_bit,
void *  user_data 
)

Initialise a V.29 modem transmit context.

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

Parameters:
s The modem context.
bit_rate The bit rate of the modem. Valid values are 4800, 7200 and 9600.
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.

References CARRIER_NOMINAL_FREQ, dds_phase_ratef(), v29_tx_power(), and v29_tx_restart().

void v29_tx_power ( v29_tx_state_t s,
float  power 
)

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

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

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

Referenced by v29_tx_init().

int v29_tx_release ( v29_tx_state_t s  ) 

Release a V.29 modem transmit context.

Release a V.29 modem transmit context.

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

int v29_tx_restart ( v29_tx_state_t s,
int  bit_rate,
int  tep 
)

Reinitialise an existing V.29 modem transmit context.

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

Parameters:
s The modem context.
bit_rate The bit rate of the modem. Valid values are 4800, 7200 and 9600.
tep TRUE is the optional TEP tone is to be transmitted.
Returns:
0 for OK, -1 for bad parameter

References span_log(), V29_TRAINING_SEG_1, and V29_TRAINING_SEG_TEP.

Referenced by v29_tx_init().

void v29_tx_set_get_bit ( v29_tx_state_t s,
get_bit_func_t  get_bit,
void *  user_data 
)

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

Change the get_bit function associated with a V.29 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.

void v29_tx_set_modem_status_handler ( v29_tx_state_t s,
modem_tx_status_func_t  handler,
void *  user_data 
)

Change the modem status report function associated with a V.29 modem transmit context.

Change the modem status report function associated with a V.29 modem transmit context.

Parameters:
s The modem context.
handler The callback routine used to report modem status changes.
user_data An opaque pointer.


Generated on Tue Aug 4 03:36:26 2009 for spandsp by  doxygen 1.5.9