Started work on discontinuous transmission (DTX)
[speexdsp.git] / libspeex / speex.h
1 /* Copyright (C) 2002 Jean-Marc Valin*/
2 /**
3   @file speex.h
4   @brief Describes the different modes of the codec
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34 */
35
36 #ifndef SPEEX_H
37 #define SPEEX_H
38
39 #include "speex_bits.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /* Values allowed for *ctl() requests */
46
47 /** Set enhancement on/off (decoder only) */
48 #define SPEEX_SET_ENH 0
49 /** Get enhancement state (decoder only) */
50 #define SPEEX_GET_ENH 1
51
52 /*Would be SPEEX_SET_FRAME_SIZE, but it's (currently) invalid*/
53 /** Obtain frame size used by encoder/decoder */
54 #define SPEEX_GET_FRAME_SIZE 3
55
56 /** Set quality value */
57 #define SPEEX_SET_QUALITY 4
58 /** Get current quality setting */
59 #define SPEEX_GET_QUALITY 5
60
61 /** Set sub-mode to use */
62 #define SPEEX_SET_MODE 6
63 /** Get current sub-mode in use */
64 #define SPEEX_GET_MODE 7
65
66 /** Set low-band sub-mode to use (wideband only)*/
67 #define SPEEX_SET_LOW_MODE 8
68 /** Get current low-band mode in use (wideband only)*/
69 #define SPEEX_GET_LOW_MODE 9
70
71 /** Set high-band sub-mode to use (wideband only)*/
72 #define SPEEX_SET_HIGH_MODE 10
73 /** Get current high-band mode in use (wideband only)*/
74 #define SPEEX_GET_HIGH_MODE 11
75
76 /** Set VBR on (1) or off (0) */
77 #define SPEEX_SET_VBR 12
78 /** Get VBR status (1 for on, 0 for off) */
79 #define SPEEX_GET_VBR 13
80
81 /** Set quality value for VBR encoding (0-10) */
82 #define SPEEX_SET_VBR_QUALITY 14
83 /** Get current quality value for VBR encoding (0-10) */
84 #define SPEEX_GET_VBR_QUALITY 15
85
86 /** Set complexity of the encoder (0-10) */
87 #define SPEEX_SET_COMPLEXITY 16
88 /** Get current complexity of the encoder (0-10) */
89 #define SPEEX_GET_COMPLEXITY 17
90
91 /** Set bit-rate used by the encoder (or lower) */
92 #define SPEEX_SET_BITRATE 18
93 /** Get current bit-rate used by the encoder or decoder */
94 #define SPEEX_GET_BITRATE 19
95
96 /**Define a handler function for in-band Speex request*/
97 #define SPEEX_SET_HANDLER 20
98
99 /**Define a handler function for in-band user-defined request*/
100 #define SPEEX_SET_USER_HANDLER 22
101
102 #define SPEEX_SET_SAMPLING_RATE 24
103 #define SPEEX_GET_SAMPLING_RATE 25
104
105 #define SPEEX_RESET_STATE 26
106
107 #define SPEEX_GET_RELATIVE_QUALITY 29
108
109 #define SPEEX_SET_VAD 30
110 #define SPEEX_GET_VAD 31
111
112 #define SPEEX_SET_ABR 32
113 #define SPEEX_GET_ABR 33
114
115 #define SPEEX_SET_DTX 34
116 #define SPEEX_GET_DTX 35
117
118
119    /* Used internally, not to be used in applications */
120 #define SPEEX_GET_PI_GAIN 100
121 #define SPEEX_GET_EXC     101
122 #define SPEEX_GET_INNOV   102
123
124
125 /* Preserving compatibility:*/
126 /** Equivalent to SPEEX_SET_ENH */
127 #define SPEEX_SET_PF 0
128 /** Equivalent to SPEEX_GET_ENH */
129 #define SPEEX_GET_PF 1
130
131
132 /* Values allowed for mode queries */
133 /** Query the frame size of a mode */
134 #define SPEEX_MODE_FRAME_SIZE 0
135
136 /** Query the size of an encoded frame for a particular sub-mode */
137 #define SPEEX_SUBMODE_BITS_PER_FRAME 1
138
139
140 /** Number of defined modes in Speex */
141 #define SPEEX_NB_MODES 3
142
143 struct SpeexMode;
144
145
146 /* Prototypes for mode function pointers */
147
148 /** Encoder state initialization function */
149 typedef void *(*encoder_init_func)(struct SpeexMode *mode);
150
151 /** Encoder state destruction function */
152 typedef void (*encoder_destroy_func)(void *st);
153
154 /** Main encoding function */
155 typedef void (*encode_func)(void *state, float *in, SpeexBits *bits);
156
157 /** Function for controlling the encoder options */
158 typedef void (*encoder_ctl_func)(void *state, int request, void *ptr);
159
160 /** Decoder state initialization function */
161 typedef void *(*decoder_init_func)(struct SpeexMode *mode);
162
163 /** Decoder state destruction function */
164 typedef void (*decoder_destroy_func)(void *st);
165
166 /** Main decoding function */
167 typedef int  (*decode_func)(void *state, SpeexBits *bits, float *out);
168
169 /** Function for controlling the decoder options */
170 typedef void (*decoder_ctl_func)(void *state, int request, void *ptr);
171
172
173 /** Query function for a mode */
174 typedef void (*mode_query_func)(void *mode, int request, void *ptr);
175
176 /** Struct defining a Speex mode */ 
177 typedef struct SpeexMode {
178    /** Pointer to the low-level mode data */
179    void *mode;
180
181    /** Pointer to the mode query function */
182    mode_query_func query;
183    
184    /** The name of the mode (you should not rely on this to identify the mode)*/
185    char *modeName;
186
187    /**ID of the mode*/
188    int modeID;
189
190    /**Version number of the bitstream (incremented every time we break
191     bitstream compatibility*/
192    int bitstream_version;
193
194    /** Pointer to encoder initialization function */
195    encoder_init_func enc_init;
196
197    /** Pointer to encoder destruction function */
198    encoder_destroy_func enc_destroy;
199
200    /** Pointer to frame encoding function */
201    encode_func enc;
202
203    /** Pointer to decoder initialization function */
204    decoder_init_func dec_init;
205
206    /** Pointer to decoder destruction function */
207    decoder_destroy_func dec_destroy;
208
209    /** Pointer to frame decoding function */
210    decode_func dec;
211
212    /** ioctl-like requests for encoder */
213    encoder_ctl_func enc_ctl;
214
215    /** ioctl-like requests for decoder */
216    decoder_ctl_func dec_ctl;
217
218 } SpeexMode;
219
220 /**
221  * Returns a handle to a newly created Speex encoder state structure. For now, 
222  * the "mode" arguent can be &nb_mode or &wb_mode . In the future, more modes 
223  * may be added. Note that for now if you have more than one channels to 
224  * encode, you need one state per channel.
225  *
226  * @param mode The mode to use (either speex_nb_mode or speex_wb.mode) 
227  * @return A newly created encoder
228  */
229 void *speex_encoder_init(SpeexMode *mode);
230
231 /** Frees all resources associated to an existing Speex encoder state. 
232  * @param state Encoder state to be destroyed */
233 void speex_encoder_destroy(void *state);
234
235 /** Uses an existing encoder state to encode one frame of speech pointed to by
236     "in". The encoded bit-stream is saved in "bits".
237  @param state Encoder state
238  @param in Frame that will be encoded with a +-2^16 range
239  @param bits Bit-stream where the data will be written
240  */
241 void speex_encode(void *state, float *in, SpeexBits *bits);
242
243 /** Used like the ioctl function to control the encoder parameters
244  *
245  * @param state Encoder state
246  * @param request ioctl-type request (one of the SPEEX_* macros)
247  * @param ptr Data exchanged to-from function
248  */
249 void speex_encoder_ctl(void *state, int request, void *ptr);
250
251
252 /** Returns a handle to a newly created decoder state structure. For now, 
253  * the mode arguent can be &nb_mode or &wb_mode . In the future, more modes
254  * may be added.  Note that for now if you have more than one channels to
255  * decode, you need one state per channel.
256  *
257  * @param mode Speex mode (one of speex_nb_mode or speex_wb_mode)
258  * @return A newly created decoder state
259  */ 
260 void *speex_decoder_init(SpeexMode *mode);
261
262 /** Frees all resources associated to an existing decoder state.
263  *
264  * @param state State to be destroyed
265  */
266 void speex_decoder_destroy(void *state);
267
268 /** Uses an existing decoder state to decode one frame of speech from
269  * bit-stream bits. The output speech is saved written to out.
270  *
271  * @param state Decoder state
272  * @param bits Bit-stream from which to decode the frame (NULL if the packet was lost)
273  * @param out Where to write the decoded frame
274  * @return return status (0 for no error, -1 for end of stream, -2 other)
275  */
276 int speex_decode(void *state, SpeexBits *bits, float *out);
277
278 /** Used like the ioctl function to control the encoder parameters
279  *
280  * @param state Decoder state
281  * @param request ioctl-type request (one of the SPEEX_* macros)
282  * @param ptr Data exchanged to-from function
283  */
284 void speex_decoder_ctl(void *state, int request, void *ptr);
285
286
287 /** Query function for mode information
288  *
289  * @param mode Speex mode
290  * @param request ioctl-type request (one of the SPEEX_* macros)
291  * @param ptr Data exchanged to-from function
292  */
293 void speex_mode_query(SpeexMode *mode, int request, void *ptr);
294
295
296 /** Default narrowband mode */
297 extern SpeexMode speex_nb_mode;
298
299 /** Default wideband mode */
300 extern SpeexMode speex_wb_mode;
301
302 /** Default "ultra-wideband" mode */
303 extern SpeexMode speex_uwb_mode;
304
305 /** List of all modes availavle */
306 extern SpeexMode *speex_mode_list[SPEEX_NB_MODES];
307
308 #ifdef __cplusplus
309 }
310 #endif
311
312
313 #endif