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