v8.h File Reference

Go to the source code of this file.

Classes

struct  v8_state_t

Defines

#define _V8_H_
#define V8_MOD_V17   (1 << 0)
#define V8_MOD_V21   (1 << 1)
#define V8_MOD_V22   (1 << 2)
#define V8_MOD_V23HALF   (1 << 3)
#define V8_MOD_V23   (1 << 4)
#define V8_MOD_V26BIS   (1 << 5)
#define V8_MOD_V26TER   (1 << 6)
#define V8_MOD_V27TER   (1 << 7)
#define V8_MOD_V29   (1 << 8)
#define V8_MOD_V32   (1 << 9)
#define V8_MOD_V34HALF   (1 << 10)
#define V8_MOD_V34   (1 << 11)
#define V8_MOD_V90   (1 << 12)
#define V8_MOD_V92   (1 << 13)
#define V8_MOD_FAILED   (1 << 15)

Typedefs

typedef void( v8_result_handler_t )(void *user_data, int result)

Functions

v8_state_t * v8_init (v8_state_t *s, int caller, int available_modulations, v8_result_handler_t *result_handler, void *user_data)
 Initialise a V.8 context.
int v8_release (v8_state_t *s)
 Release a V.8 context.
int v8_tx (v8_state_t *s, int16_t *amp, int max_len)
 Generate a block of V.8 audio samples.
int v8_rx (v8_state_t *s, const int16_t *amp, int len)
 Process a block of received V.8 audio samples.
void v8_log_supported_modulations (v8_state_t *s, int modulation_schemes)
 Log the list of supported modulations.
void v8_log_selected_modulation (v8_state_t *s, int modulation_scheme)
 Log the selected modulation.


Detailed Description


Function Documentation

v8_state_t* v8_init ( v8_state_t *  s,
int  caller,
int  available_modulations,
v8_result_handler_t *  result_handler,
void *  user_data 
)

Initialise a V.8 context.

Initialise a V.8 context.

Parameters:
s The V.8 context.
caller TRUE if caller mode, else answerer mode.
available_modulations A bitwise list of the modulation schemes to be advertised as available here.
result_handler The callback routine used to handle the results of negotiation.
user_data An opaque pointer passed to the result_handler routine.
Returns:
A pointer to the V.8 context, or NULL if there was a problem.

void v8_log_selected_modulation ( v8_state_t *  s,
int  modulation_scheme 
)

Log the selected modulation.

Log the selected modulation.

Parameters:
s The V.8 context.
modulation_scheme The selected modulation.

void v8_log_supported_modulations ( v8_state_t *  s,
int  modulation_schemes 
)

Log the list of supported modulations.

Log the list of supported modulations.

Parameters:
s The V.8 context.
modulation_schemes The list of supported modulations.

int v8_release ( v8_state_t *  s  ) 

Release a V.8 context.

Release a V.8 context.

Parameters:
s The V.8 context.
Returns:
0 for OK.

int v8_rx ( v8_state_t *  s,
const int16_t *  amp,
int  len 
)

Process a block of received V.8 audio samples.

Process a block of received V.8 audio samples.

Parameters:
s The V.8 context.
amp The audio sample buffer.
len The number of samples in the buffer.

int v8_tx ( v8_state_t *  s,
int16_t *  amp,
int  max_len 
)

Generate a block of V.8 audio samples.

Generate a block of V.8 audio samples.

Parameters:
s The V.8 context.
amp The audio sample buffer.
max_len The number of samples to be generated.
Returns:
The number of samples actually generated.


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