More ABR work...
[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
116    /* Used internally, not to be used in applications */
117 #define SPEEX_GET_PI_GAIN 100
118 #define SPEEX_GET_EXC     101
119 #define SPEEX_GET_INNOV   102
120
121
122 /* Preserving compatibility:*/
123 /** Equivalent to SPEEX_SET_ENH */
124 #define SPEEX_SET_PF 0
125 /** Equivalent to SPEEX_GET_ENH */
126 #define SPEEX_GET_PF 1
127
128
129 /* Values allowed for mode queries */
130 /** Query the frame size of a mode */
131 #define SPEEX_MODE_FRAME_SIZE 0
132
133 /** Query the size of an encoded frame for a particular sub-mode */
134 #define SPEEX_SUBMODE_BITS_PER_FRAME 1
135
136
137 /** Number of defined modes in Speex */
138 #define SPEEX_NB_MODES 3
139
140 struct SpeexMode;
141
142
143 /* Prototypes for mode function pointers */
144
145 /** Encoder state initialization function */
146 typedef void *(*encoder_init_func)(struct SpeexMode *mode);
147
148 /** Encoder state destruction function */
149 typedef void (*encoder_destroy_func)(void *st);
150
151 /** Main encoding function */
152 typedef void (*encode_func)(void *state, float *in, SpeexBits *bits);
153
154 /** Function for controlling the encoder options */
155 typedef void (*encoder_ctl_func)(void *state, int request, void *ptr);
156
157 /** Decoder state initialization function */
158 typedef void *(*decoder_init_func)(struct SpeexMode *mode);
159
160 /** Decoder state destruction function */
161 typedef void (*decoder_destroy_func)(void *st);
162
163 /** Main decoding function */
164 typedef int  (*decode_func)(void *state, SpeexBits *bits, float *out);
165
166 /** Function for controlling the decoder options */
167 typedef void (*decoder_ctl_func)(void *state, int request, void *ptr);
168
169
170 /** Query function for a mode */
171 typedef void (*mode_query_func)(void *mode, int request, void *ptr);
172
173 /** Struct defining a Speex mode */ 
174 typedef struct SpeexMode {
175    /** Pointer to the low-level mode data */
176    void *mode;
177
178    /** Pointer to the mode query function */
179    mode_query_func query;
180    
181    /** The name of the mode (you should not rely on this to identify the mode)*/
182    char *modeName;
183
184    /**ID of the mode*/
185    int modeID;
186
187    /**Version number of the bitstream (incremented every time we break
188     bitstream compatibility*/
189    int bitstream_version;
190
191    /** Pointer to encoder initialization function */
192    encoder_init_func enc_init;
193
194    /** Pointer to encoder destruction function */
195    encoder_destroy_func enc_destroy;
196
197    /** Pointer to frame encoding function */
198    encode_func enc;
199
200    /** Pointer to decoder initialization function */
201    decoder_init_func dec_init;
202
203    /** Pointer to decoder destruction function */
204    decoder_destroy_func dec_destroy;
205
206    /** Pointer to frame decoding function */
207    decode_func dec;
208
209    /** ioctl-like requests for encoder */
210    encoder_ctl_func enc_ctl;
211
212    /** ioctl-like requests for decoder */
213    decoder_ctl_func dec_ctl;
214
215 } SpeexMode;
216
217 /**
218  * Returns a handle to a newly created Speex encoder state structure. For now, 
219  * the "mode" arguent can be &nb_mode or &wb_mode . In the future, more modes 
220  * may be added. Note that for now if you have more than one channels to 
221  * encode, you need one state per channel.
222  *
223  * @param mode The mode to use (either speex_nb_mode or speex_wb.mode) 
224  * @return A newly created encoder
225  */
226 void *speex_encoder_init(SpeexMode *mode);
227
228 /** Frees all resources associated to an existing Speex encoder state. 
229  * @param state Encoder state to be destroyed */
230 void speex_encoder_destroy(void *state);
231
232 /** Uses an existing encoder state to encode one frame of speech pointed to by
233     "in". The encoded bit-stream is saved in "bits".
234  @param state Encoder state
235  @param in Frame that will be encoded with a +-2^16 range
236  @param bits Bit-stream where the data will be written
237  */
238 void speex_encode(void *state, float *in, SpeexBits *bits);
239
240 /** Used like the ioctl function to control the encoder parameters
241  *
242  * @param state Encoder state
243  * @param request ioctl-type request (one of the SPEEX_* macros)
244  * @param ptr Data exchanged to-from function
245  */
246 void speex_encoder_ctl(void *state, int request, void *ptr);
247
248
249 /** Returns a handle to a newly created decoder state structure. For now, 
250  * the mode arguent can be &nb_mode or &wb_mode . In the future, more modes
251  * may be added.  Note that for now if you have more than one channels to
252  * decode, you need one state per channel.
253  *
254  * @param mode Speex mode (one of speex_nb_mode or speex_wb_mode)
255  * @return A newly created decoder state
256  */ 
257 void *speex_decoder_init(SpeexMode *mode);
258
259 /** Frees all resources associated to an existing decoder state.
260  *
261  * @param state State to be destroyed
262  */
263 void speex_decoder_destroy(void *state);
264
265 /** Uses an existing decoder state to decode one frame of speech from
266  * bit-stream bits. The output speech is saved written to out.
267  *
268  * @param state Decoder state
269  * @param bits Bit-stream from which to decode the frame (NULL if the packet was lost)
270  * @param out Where to write the decoded frame
271  * @return return status (0 for no error, -1 for end of stream, -2 other)
272  */
273 int speex_decode(void *state, SpeexBits *bits, float *out);
274
275 /** Used like the ioctl function to control the encoder parameters
276  *
277  * @param state Decoder state
278  * @param request ioctl-type request (one of the SPEEX_* macros)
279  * @param ptr Data exchanged to-from function
280  */
281 void speex_decoder_ctl(void *state, int request, void *ptr);
282
283
284 /** Query function for mode information
285  *
286  * @param mode Speex mode
287  * @param request ioctl-type request (one of the SPEEX_* macros)
288  * @param ptr Data exchanged to-from function
289  */
290 void speex_mode_query(SpeexMode *mode, int request, void *ptr);
291
292
293 /** Default narrowband mode */
294 extern SpeexMode speex_nb_mode;
295
296 /** Default wideband mode */
297 extern SpeexMode speex_wb_mode;
298
299 /** Default "ultra-wideband" mode */
300 extern SpeexMode speex_uwb_mode;
301
302 /** List of all modes availavle */
303 extern SpeexMode *speex_mode_list[SPEEX_NB_MODES];
304
305 #ifdef __cplusplus
306 }
307 #endif
308
309
310 #endif