Big changes in both narrowband and wideband. Retrained LSP codebook,
[speexdsp.git] / libspeex / speex.h
1 /* Copyright (C) 2002 Jean-Marc Valin 
2    File: modes.h
3
4    Describes the different modes of the codec
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10    
11    This library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15    
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20 */
21
22 #ifndef SPEEX_MODES_H
23 #define SPEEX_MODES_H
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 #include "speex_bits.h"
30
31 struct SpeexMode;
32
33 typedef void *(*encoder_init_func)(struct SpeexMode *mode);
34 typedef void (*encoder_destroy_func)(void *st);
35 typedef void (*encode_func)(void *state, float *in, FrameBits *bits);
36 typedef void *(*decoder_init_func)(struct SpeexMode *mode);
37 typedef void (*decoder_destroy_func)(void *st);
38 typedef void (*decode_func)(void *state, FrameBits *bits, float *out);
39
40 /** Struct defining a Speex mode */ 
41 typedef struct SpeexMode {
42    void *mode;
43    encoder_init_func enc_init;
44    encoder_destroy_func enc_destroy;
45    encode_func enc;
46    decoder_init_func dec_init;
47    decoder_destroy_func dec_destroy;
48    decode_func dec;
49    int frameSize;
50 } SpeexMode;
51
52    /** Creates an encoder state ("object") from a mode */ 
53 void *encoder_init(SpeexMode *mode);
54
55    /** Destroy a Speex encoder state */
56 void encoder_destroy(void *state);
57
58    /** Encode a frame */
59 void encode(void *state, float *in, FrameBits *bits);
60
61    /** Creates a decoder state ("object") from a mode */ 
62 void *decoder_init(SpeexMode *mode);
63
64    /** Destroy a Speex decoder state */
65 void decoder_destroy(void *state);
66
67    /** Decode a frame */
68 void decode(void *state, FrameBits *bits, float *out);
69
70    /** Default narrowband mode */
71 extern SpeexMode speex_nb_mode;
72
73    /** Default wideband mode */
74 extern SpeexMode speex_wb_mode;
75
76
77 #ifdef __cplusplus
78 }
79 #endif
80
81
82 #endif