Speex  1.2~beta4
Classes | Macros | Typedefs | Functions | Variables
speex.h File Reference

Describes the different modes of the codec. More...

#include "speex/speex_bits.h"
#include "speex/speex_types.h"
Include dependency graph for speex.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SpeexMode
 

Macros

#define SPEEX_SET_ENH   0
 
#define SPEEX_GET_ENH   1
 
#define SPEEX_GET_FRAME_SIZE   3
 
#define SPEEX_SET_QUALITY   4
 
#define SPEEX_SET_MODE   6
 
#define SPEEX_GET_MODE   7
 
#define SPEEX_SET_LOW_MODE   8
 
#define SPEEX_GET_LOW_MODE   9
 
#define SPEEX_SET_HIGH_MODE   10
 
#define SPEEX_GET_HIGH_MODE   11
 
#define SPEEX_SET_VBR   12
 
#define SPEEX_GET_VBR   13
 
#define SPEEX_SET_VBR_QUALITY   14
 
#define SPEEX_GET_VBR_QUALITY   15
 
#define SPEEX_SET_COMPLEXITY   16
 
#define SPEEX_GET_COMPLEXITY   17
 
#define SPEEX_SET_BITRATE   18
 
#define SPEEX_GET_BITRATE   19
 
#define SPEEX_SET_HANDLER   20
 
#define SPEEX_SET_USER_HANDLER   22
 
#define SPEEX_SET_SAMPLING_RATE   24
 
#define SPEEX_GET_SAMPLING_RATE   25
 
#define SPEEX_RESET_STATE   26
 
#define SPEEX_GET_RELATIVE_QUALITY   29
 
#define SPEEX_SET_VAD   30
 
#define SPEEX_GET_VAD   31
 
#define SPEEX_SET_ABR   32
 
#define SPEEX_GET_ABR   33
 
#define SPEEX_SET_DTX   34
 
#define SPEEX_GET_DTX   35
 
#define SPEEX_SET_SUBMODE_ENCODING   36
 
#define SPEEX_GET_SUBMODE_ENCODING   37
 
#define SPEEX_GET_LOOKAHEAD   39
 
#define SPEEX_SET_PLC_TUNING   40
 
#define SPEEX_GET_PLC_TUNING   41
 
#define SPEEX_SET_VBR_MAX_BITRATE   42
 
#define SPEEX_GET_VBR_MAX_BITRATE   43
 
#define SPEEX_SET_HIGHPASS   44
 
#define SPEEX_GET_HIGHPASS   45
 
#define SPEEX_GET_ACTIVITY   47
 
#define SPEEX_SET_PF   0
 
#define SPEEX_GET_PF   1
 
#define SPEEX_MODE_FRAME_SIZE   0
 
#define SPEEX_SUBMODE_BITS_PER_FRAME   1
 
#define SPEEX_LIB_GET_MAJOR_VERSION   1
 
#define SPEEX_LIB_GET_MINOR_VERSION   3
 
#define SPEEX_LIB_GET_MICRO_VERSION   5
 
#define SPEEX_LIB_GET_EXTRA_VERSION   7
 
#define SPEEX_LIB_GET_VERSION_STRING   9
 
#define SPEEX_NB_MODES   3
 
#define SPEEX_MODEID_NB   0
 
#define SPEEX_MODEID_WB   1
 
#define SPEEX_MODEID_UWB   2
 
#define speex_lib_get_mode(mode)   ((mode)==SPEEX_MODEID_NB ? &speex_nb_mode : speex_lib_get_mode (mode))
 

Typedefs

typedef void *(* encoder_init_func )(const struct SpeexMode *mode)
 
typedef void(* encoder_destroy_func )(void *st)
 
typedef int(* encode_func )(void *state, void *in, SpeexBits *bits)
 
typedef int(* encoder_ctl_func )(void *state, int request, void *ptr)
 
typedef void *(* decoder_init_func )(const struct SpeexMode *mode)
 
typedef void(* decoder_destroy_func )(void *st)
 
typedef int(* decode_func )(void *state, SpeexBits *bits, void *out)
 
typedef int(* decoder_ctl_func )(void *state, int request, void *ptr)
 
typedef int(* mode_query_func )(const void *mode, int request, void *ptr)
 
typedef struct SpeexMode SpeexMode
 

Functions

void * speex_encoder_init (const SpeexMode *mode)
 
void speex_encoder_destroy (void *state)
 
int speex_encode (void *state, float *in, SpeexBits *bits)
 
int speex_encode_int (void *state, spx_int16_t *in, SpeexBits *bits)
 
int speex_encoder_ctl (void *state, int request, void *ptr)
 
void * speex_decoder_init (const SpeexMode *mode)
 
void speex_decoder_destroy (void *state)
 
int speex_decode (void *state, SpeexBits *bits, float *out)
 
int speex_decode_int (void *state, SpeexBits *bits, spx_int16_t *out)
 
int speex_decoder_ctl (void *state, int request, void *ptr)
 
int speex_mode_query (const SpeexMode *mode, int request, void *ptr)
 
int speex_lib_ctl (int request, void *ptr)
 
const SpeexModespeex_lib_get_mode (int mode)
 

Variables

const SpeexMode speex_nb_mode
 
const SpeexMode speex_wb_mode
 
const SpeexMode speex_uwb_mode
 
const SpeexMode *const speex_mode_list [SPEEX_NB_MODES]
 

Detailed Description

Describes the different modes of the codec.