Go to the source code of this file.
Defines | |
#define | _SPANDSP_V22BIS_H_ |
#define | V22BIS_EQUALIZER_LEN 7 |
#define | V22BIS_EQUALIZER_MASK 15 |
#define | V22BIS_TX_FILTER_STEPS 9 |
#define | V22BIS_RX_FILTER_STEPS 37 |
Typedefs | |
typedef struct v22bis_state_s | v22bis_state_t |
Enumerations | |
enum | { V22BIS_GUARD_TONE_NONE, V22BIS_GUARD_TONE_550HZ, V22BIS_GUARD_TONE_1800HZ } |
Functions | |
int | v22bis_rx (v22bis_state_t *s, const int16_t amp[], int len) |
Process a block of received V.22bis modem audio samples. | |
int | v22bis_rx_fillin (v22bis_state_t *s, int len) |
Fake processing of a missing block of received V.22bis modem audio samples. | |
int | v22bis_rx_equalizer_state (v22bis_state_t *s, complexf_t **coeffs) |
Get a snapshot of the current equalizer coefficients. | |
float | v22bis_rx_carrier_frequency (v22bis_state_t *s) |
float | v22bis_rx_symbol_timing_correction (v22bis_state_t *s) |
float | v22bis_rx_signal_power (v22bis_state_t *s) |
void | v22bis_rx_signal_cutoff (v22bis_state_t *s, float cutoff) |
void | v22bis_rx_set_qam_report_handler (v22bis_state_t *s, qam_report_handler_t handler, void *user_data) |
int | v22bis_tx (v22bis_state_t *s, int16_t amp[], int len) |
Generate a block of V.22bis modem audio samples. | |
void | v22bis_tx_power (v22bis_state_t *s, float power) |
Adjust a V.22bis modem transmit context's output power. | |
int | v22bis_restart (v22bis_state_t *s, int bit_rate) |
Reinitialise an existing V.22bis modem context. | |
int | v22bis_request_retrain (v22bis_state_t *s, int bit_rate) |
Request a retrain for a V.22bis modem context. | |
int | v22bis_remote_loopback (v22bis_state_t *s, int enable) |
Request a loopback 2 for a V.22bis modem context. | |
int | v22bis_current_bit_rate (v22bis_state_t *s) |
Report the current operating bit rate of a V.22bis modem context. | |
v22bis_state_t * | v22bis_init (v22bis_state_t *s, int bit_rate, int guard, int caller, get_bit_func_t get_bit, void *get_bit_user_data, put_bit_func_t put_bit, void *put_bit_user_data) |
Initialise a V.22bis modem context. | |
int | v22bis_release (v22bis_state_t *s) |
Release a V.22bis modem receive context. | |
int | v22bis_free (v22bis_state_t *s) |
Free a V.22bis modem receive context. | |
logging_state_t * | v22bis_get_logging_state (v22bis_state_t *s) |
Get the logging context associated with a V.22bis modem context. | |
void | v22bis_set_get_bit (v22bis_state_t *s, get_bit_func_t get_bit, void *user_data) |
Change the get_bit function associated with a V.22bis modem context. | |
void | v22bis_set_put_bit (v22bis_state_t *s, put_bit_func_t put_bit, void *user_data) |
Change the put_bit function associated with a V.22bis modem context. | |
void | v22bis_set_modem_status_handler (v22bis_state_t *s, modem_rx_status_func_t handler, void *user_data) |
Change the modem status report function associated with a V.22bis modem receive context. | |
Variables | |
const complexf_t | v22bis_constellation [16] |
#define V22BIS_EQUALIZER_LEN 7 |
The number of steps to the left and to the right of the target position in the equalizer buffer.
Referenced by v22bis_rx_equalizer_state().
#define V22BIS_EQUALIZER_MASK 15 |
One less than a power of 2 >= (2*V22BIS_EQUALIZER_LEN + 1)
#define V22BIS_RX_FILTER_STEPS 37 |
The number of taps in the receive pulse shaping/bandpass filter
Referenced by v22bis_rx().
#define V22BIS_TX_FILTER_STEPS 9 |
The number of taps in the transmit pulse shaping filter
Referenced by v22bis_tx().
typedef struct v22bis_state_s v22bis_state_t |
V.22bis modem descriptor. This defines the working state for a single instance of a V.22bis modem.
int v22bis_current_bit_rate | ( | v22bis_state_t * | s | ) |
Report the current operating bit rate of a V.22bis modem context.
Report the current operating bit rate of a V.22bis modem context.
s | The modem context. |
int v22bis_free | ( | v22bis_state_t * | s | ) |
Free a V.22bis modem receive context.
Free a V.22bis modem receive context.
s | The modem context. |
logging_state_t* v22bis_get_logging_state | ( | v22bis_state_t * | s | ) |
Get the logging context associated with a V.22bis modem context.
Get the logging context associated with a V.22bis modem context.
s | The modem context. |
v22bis_state_t* v22bis_init | ( | v22bis_state_t * | s, | |
int | bit_rate, | |||
int | guard, | |||
int | caller, | |||
get_bit_func_t | get_bit, | |||
void * | get_bit_user_data, | |||
put_bit_func_t | put_bit, | |||
void * | put_bit_user_data | |||
) |
Initialise a V.22bis modem context.
Initialise a V.22bis modem context. This must be called before the first use of the context, to initialise its contents.
s | The modem context. | |
bit_rate | The bit rate of the modem. Valid values are 1200 and 2400. | |
guard | The guard tone option. 0 = none, 1 = 550Hz, 2 = 1800Hz. | |
caller | TRUE if this is the calling modem. | |
get_bit | The callback routine used to get the data to be transmitted. | |
put_bit | The callback routine used to get the data to be transmitted. | |
user_data | An opaque pointer, passed in calls to the get and put routines. |
References v22bis_restart(), and v22bis_tx_power().
int v22bis_release | ( | v22bis_state_t * | s | ) |
Release a V.22bis modem receive context.
Release a V.22bis modem receive context.
s | The modem context. |
int v22bis_remote_loopback | ( | v22bis_state_t * | s, | |
int | enable | |||
) |
Request a loopback 2 for a V.22bis modem context.
Request a loopback 2 for a V.22bis modem context.
s | The modem context. | |
enable | TRUE to enable loopback, or FALSE to disable it. |
int v22bis_request_retrain | ( | v22bis_state_t * | s, | |
int | bit_rate | |||
) |
Request a retrain for a V.22bis modem context.
Request a retrain for a V.22bis modem context. A rate change may also be requested.
s | The modem context. | |
bit_rate | The bit rate of the modem. Valid values are 1200 and 2400. |
int v22bis_restart | ( | v22bis_state_t * | s, | |
int | bit_rate | |||
) |
Reinitialise an existing V.22bis modem context.
Reinitialise an existing V.22bis modem context, so it may be reused.
s | The modem context. | |
bit_rate | The bit rate of the modem. Valid values are 1200 and 2400. |
References v22bis_rx_restart().
Referenced by v22bis_init(), and v22bis_rx().
int v22bis_rx | ( | v22bis_state_t * | s, | |
const int16_t | amp[], | |||
int | len | |||
) |
Process a block of received V.22bis modem audio samples.
Process a block of received V.22bis modem audio samples.
s | The modem context. | |
amp | The audio sample buffer. | |
len | The number of samples in the buffer. |
References PULSESHAPER_COEFF_SETS, v22bis_restart(), and V22BIS_RX_FILTER_STEPS.
float v22bis_rx_carrier_frequency | ( | v22bis_state_t * | s | ) |
Get the current received carrier frequency.
s | The modem context. |
int v22bis_rx_equalizer_state | ( | v22bis_state_t * | s, | |
complexf_t ** | coeffs | |||
) |
Get a snapshot of the current equalizer coefficients.
Get a snapshot of the current equalizer coefficients.
coeffs | The vector of complex coefficients. |
References V22BIS_EQUALIZER_LEN.
int v22bis_rx_fillin | ( | v22bis_state_t * | s, | |
int | len | |||
) |
Fake processing of a missing block of received V.22bis modem audio samples.
Fake processing of a missing block of received V.22bis modem audio samples. (e.g due to packet loss).
s | The modem context. | |
len | The number of samples to fake. |
void v22bis_rx_set_qam_report_handler | ( | v22bis_state_t * | s, | |
qam_report_handler_t | handler, | |||
void * | user_data | |||
) |
Set a handler routine to process QAM status reports
s | The modem context. | |
handler | The handler routine. | |
user_data | An opaque pointer passed to the handler routine. |
void v22bis_rx_signal_cutoff | ( | v22bis_state_t * | s, | |
float | cutoff | |||
) |
Set the power level at which the carrier detection will cut in
s | The modem context. | |
cutoff | The signal cutoff power, in dBm0. |
Referenced by v22bis_rx_restart().
float v22bis_rx_signal_power | ( | v22bis_state_t * | s | ) |
Get a current received signal power.
s | The modem context. |
float v22bis_rx_symbol_timing_correction | ( | v22bis_state_t * | s | ) |
Get the current symbol timing correction since startup.
s | The modem context. |
References PULSESHAPER_COEFF_SETS.
void v22bis_set_get_bit | ( | v22bis_state_t * | s, | |
get_bit_func_t | get_bit, | |||
void * | user_data | |||
) |
Change the get_bit function associated with a V.22bis modem context.
Change the get_bit function associated with a V.22bis modem context.
s | The modem context. | |
get_bit | The callback routine used to get the data to be transmitted. | |
user_data | An opaque pointer. |
void v22bis_set_modem_status_handler | ( | v22bis_state_t * | s, | |
modem_rx_status_func_t | handler, | |||
void * | user_data | |||
) |
Change the modem status report function associated with a V.22bis modem receive context.
Change the modem status report function associated with a V.22bis modem receive context.
s | The modem context. | |
handler | The callback routine used to report modem status changes. | |
user_data | An opaque pointer. |
void v22bis_set_put_bit | ( | v22bis_state_t * | s, | |
put_bit_func_t | put_bit, | |||
void * | user_data | |||
) |
Change the put_bit function associated with a V.22bis modem context.
Change the get_bit function associated with a V.22bis modem context.
s | The modem context. | |
put_bit | The callback routine used to process the data received. | |
user_data | An opaque pointer. |
int v22bis_tx | ( | v22bis_state_t * | s, | |
int16_t | amp[], | |||
int | len | |||
) |
Generate a block of V.22bis modem audio samples.
Generate a block of V.22bis modem audio samples.
s | The modem context. | |
amp | The audio sample buffer. | |
len | The number of samples to be generated. |
References V22BIS_TX_FILTER_STEPS.
void v22bis_tx_power | ( | v22bis_state_t * | s, | |
float | power | |||
) |
Adjust a V.22bis modem transmit context's output power.
Adjust a V.22bis modem transmit context's power output.
s | The modem context. | |
power | The power level, in dBm0 |
Referenced by v22bis_init().