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