Dynamic allocation before VBR
[opus.git] / libcelt / celt.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008 Gregory Maxwell 
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /**
6   @file celt.h
7   @brief Contains all the functions for encoding and decoding audio
8  */
9
10 /*
11    Redistribution and use in source and binary forms, with or without
12    modification, are permitted provided that the following conditions
13    are met:
14    
15    - Redistributions of source code must retain the above copyright
16    notice, this list of conditions and the following disclaimer.
17    
18    - Redistributions in binary form must reproduce the above copyright
19    notice, this list of conditions and the following disclaimer in the
20    documentation and/or other materials provided with the distribution.
21    
22    - Neither the name of the Xiph.org Foundation nor the names of its
23    contributors may be used to endorse or promote products derived from
24    this software without specific prior written permission.
25    
26    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
30    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 #ifndef CELT_H
40 #define CELT_H
41
42 #include "celt_types.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 #if defined(__GNUC__) && defined(CELT_BUILD)
49 #define EXPORT __attribute__ ((visibility ("default")))
50 #elif defined(WIN32)
51 #define EXPORT __declspec(dllexport)
52 #else
53 #define EXPORT
54 #endif
55
56 #define _celt_check_int(x) (((void)((x) == (celt_int32)0)), (celt_int32)(x))
57 #define _celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (CELTMode**)(ptr)))
58
59 /* Error codes */
60 /** No error */
61 #define CELT_OK                0
62 /** An (or more) invalid argument (e.g. out of range) */
63 #define CELT_BAD_ARG          -1
64 /** The mode struct passed is invalid */
65 #define CELT_INVALID_MODE     -2
66 /** An internal error was detected */
67 #define CELT_INTERNAL_ERROR   -3
68 /** The data passed (e.g. compressed data to decoder) is corrupted */
69 #define CELT_CORRUPTED_DATA   -4
70 /** Invalid/unsupported request number */
71 #define CELT_UNIMPLEMENTED    -5
72 /** An encoder or decoder structure is invalid or already freed */
73 #define CELT_INVALID_STATE    -6
74 /** Memory allocation has failed */
75 #define CELT_ALLOC_FAIL       -7
76
77 /* Requests */
78 #define CELT_GET_MODE_REQUEST    1
79 /** Get the CELTMode used by an encoder or decoder */
80 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
81 #define CELT_SET_COMPLEXITY_REQUEST    2
82 /** Controls the complexity from 0-10 (int) */
83 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
84 #define CELT_SET_PREDICTION_REQUEST    4
85 /** Controls the use of interframe prediction.
86     0=Independent frames
87     1=Short term interframe prediction allowed
88     2=Long term prediction allowed
89  */
90 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, _celt_check_int(x)
91 #define CELT_SET_VBR_RATE_REQUEST    6
92 /** Set the target VBR rate in bits per second(int); 0=CBR (default) */
93 #define CELT_SET_VBR_RATE(x) CELT_SET_VBR_RATE_REQUEST, _celt_check_int(x)
94 /** Reset the encoder/decoder memories to zero*/
95 #define CELT_RESET_STATE_REQUEST        8
96 #define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
97
98 #define CELT_SET_START_BAND_REQUEST    10000
99 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, _celt_check_int(x)
100
101 #define CELT_SET_END_BAND_REQUEST    10001
102 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, _celt_check_int(x)
103
104 /** GET the lookahead used in the current mode */
105 #define CELT_GET_LOOKAHEAD    1001
106 /** GET the sample rate used in the current mode */
107 #define CELT_GET_SAMPLE_RATE  1003
108
109 /** GET the bit-stream version for compatibility check */
110 #define CELT_GET_BITSTREAM_VERSION 2000
111
112
113 /** Contains the state of an encoder. One encoder state is needed 
114     for each stream. It is initialised once at the beginning of the
115     stream. Do *not* re-initialise the state for every frame.
116    @brief Encoder state
117  */
118 typedef struct CELTEncoder CELTEncoder;
119
120 /** State of the decoder. One decoder state is needed for each stream.
121     It is initialised once at the beginning of the stream. Do *not*
122     re-initialise the state for every frame */
123 typedef struct CELTDecoder CELTDecoder;
124
125 /** The mode contains all the information necessary to create an
126     encoder. Both the encoder and decoder need to be initialised
127     with exactly the same mode, otherwise the quality will be very 
128     bad */
129 typedef struct CELTMode CELTMode;
130
131
132 /** \defgroup codec Encoding and decoding */
133 /*  @{ */
134
135 /* Mode calls */
136
137 /** Creates a new mode struct. This will be passed to an encoder or 
138     decoder. The mode MUST NOT BE DESTROYED until the encoders and 
139     decoders that use it are destroyed as well.
140  @param Fs Sampling rate (32000 to 96000 Hz)
141  @param frame_size Number of samples (per channel) to encode in each 
142                    packet (even values; 64 - 512)
143  @param error Returned error code (if NULL, no error will be returned)
144  @return A newly created mode
145 */
146 EXPORT CELTMode *celt_mode_create(celt_int32 Fs, int frame_size, int *error);
147
148 /** Destroys a mode struct. Only call this after all encoders and 
149     decoders using this mode are destroyed as well.
150  @param mode Mode to be destroyed
151 */
152 EXPORT void celt_mode_destroy(CELTMode *mode);
153
154 /** Query information from a mode */
155 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32 *value);
156
157 /* Encoder stuff */
158
159 EXPORT int celt_encoder_get_size(const CELTMode *mode, int channels);
160
161 /** Creates a new encoder state. Each stream needs its own encoder 
162     state (can't be shared across simultaneous streams).
163  @param mode Contains all the information about the characteristics of
164  *  the stream (must be the same characteristics as used for the 
165  *  decoder)
166  @param channels Number of channels
167  @param error Returns an error code
168  @return Newly created encoder state.
169 */
170 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode, int channels, int *error);
171
172 EXPORT CELTEncoder *celt_encoder_init(CELTEncoder *st, const CELTMode *mode, int channels, int *error);
173
174 /** Destroys a an encoder state.
175  @param st Encoder state to be destroyed
176  */
177 EXPORT void celt_encoder_destroy(CELTEncoder *st);
178
179 /** Encodes a frame of audio.
180  @param st Encoder state
181  @param pcm PCM audio in float format, with a normal range of ±1.0. 
182  *          Samples with a range beyond ±1.0 are supported but will 
183  *          be clipped by decoders using the integer API and should 
184  *          only be used if it is known that the far end supports 
185  *          extended dynmaic range. There must be exactly
186  *          frame_size samples per channel. 
187  @param optional_resynthesis If not NULL, the encoder copies the audio signal that
188  *          the decoder would decode. It is the same as calling the
189  *          decoder on the compressed data, just faster.
190  *          This may alias pcm. 
191  @param compressed The compressed data is written here. This may not alias pcm or
192  *                 optional_synthesis.
193  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
194  *          (can change from one frame to another)
195  @return Number of bytes written to "compressed". Will be the same as 
196  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
197  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
198  *       the length returned be somehow transmitted to the decoder. Otherwise, no
199  *       decoding is possible.
200 */
201 EXPORT int celt_encode_resynthesis_float(CELTEncoder *st, const float *pcm, float *optional_resynthesis, int frame_size, unsigned char *compressed, int nbCompressedBytes);
202
203 /** Encodes a frame of audio.
204  @param st Encoder state
205  @param pcm PCM audio in float format, with a normal range of ±1.0.
206  *          Samples with a range beyond ±1.0 are supported but will
207  *          be clipped by decoders using the integer API and should
208  *          only be used if it is known that the far end supports
209  *          extended dynmaic range. There must be exactly
210  *          frame_size samples per channel.
211  @param compressed The compressed data is written here. This may not alias pcm or
212  *                 optional_synthesis.
213  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
214  *          (can change from one frame to another)
215  @return Number of bytes written to "compressed". Will be the same as
216  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
217  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
218  *       the length returned be somehow transmitted to the decoder. Otherwise, no
219  *       decoding is possible.
220 */
221 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes);
222
223 /** Encodes a frame of audio.
224  @param st Encoder state
225  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
226  *          exactly frame_size samples per channel. 
227  @param optional_resynthesis If not NULL, the encoder copies the audio signal that
228  *                         the decoder would decode. It is the same as calling the
229  *                         decoder on the compressed data, just faster.
230  *                         This may alias pcm. 
231  @param compressed The compressed data is written here. This may not alias pcm or
232  *                         optional_synthesis.
233  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
234  *                        (can change from one frame to another)
235  @return Number of bytes written to "compressed". Will be the same as 
236  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
237  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
238  *       the length returned be somehow transmitted to the decoder. Otherwise, no
239  *       decoding is possible.
240  */
241 EXPORT int celt_encode_resynthesis(CELTEncoder *st, const celt_int16 *pcm, celt_int16 *optional_resynthesis, int frame_size, unsigned char *compressed, int nbCompressedBytes);
242
243 /** Encodes a frame of audio.
244  @param st Encoder state
245  @param pcm PCM audio in signed 16-bit format (native endian). There must be
246  *          exactly frame_size samples per channel.
247  @param compressed The compressed data is written here. This may not alias pcm or
248  *                         optional_synthesis.
249  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
250  *                        (can change from one frame to another)
251  @return Number of bytes written to "compressed". Will be the same as
252  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
253  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
254  *       the length returned be somehow transmitted to the decoder. Otherwise, no
255  *       decoding is possible.
256  */
257 EXPORT int celt_encode(CELTEncoder *st, const celt_int16 *pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes);
258
259 /** Query and set encoder parameters 
260  @param st Encoder state
261  @param request Parameter to change or query
262  @param value Pointer to a 32-bit int value
263  @return Error code
264 */
265 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
266
267 /* Decoder stuff */
268
269 EXPORT int celt_decoder_get_size(const CELTMode *mode, int channels);
270
271 /** Creates a new decoder state. Each stream needs its own decoder state (can't
272     be shared across simultaneous streams).
273  @param mode Contains all the information about the characteristics of the
274              stream (must be the same characteristics as used for the encoder)
275  @param channels Number of channels
276  @param error Returns an error code
277  @return Newly created decoder state.
278  */
279 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode, int channels, int *error);
280
281 EXPORT CELTDecoder *celt_decoder_init(CELTDecoder *st, const CELTMode *mode, int channels, int *error);
282
283 /** Destroys a a decoder state.
284  @param st Decoder state to be destroyed
285  */
286 EXPORT void celt_decoder_destroy(CELTDecoder *st);
287
288 /** Decodes a frame of audio.
289  @param st Decoder state
290  @param data Compressed data produced by an encoder
291  @param len Number of bytes to read from "data". This MUST be exactly the number
292             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
293  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
294             returned here in float format. 
295  @return Error code.
296    */
297 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size);
298
299 /** Decodes a frame of audio.
300  @param st Decoder state
301  @param data Compressed data produced by an encoder
302  @param len Number of bytes to read from "data". This MUST be exactly the number
303             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
304  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
305             returned here in 16-bit PCM format (native endian). 
306  @return Error code.
307  */
308 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16 *pcm, int frame_size);
309
310 /** Query and set decoder parameters
311    @param st Decoder state
312    @param request Parameter to change or query
313    @param value Pointer to a 32-bit int value
314    @return Error code
315  */
316 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
317
318
319 /** Returns the English string that corresponds to an error code
320  * @param error Error code (negative for an error, 0 for success
321  * @return Constant string (must NOT be freed)
322  */
323 EXPORT const char *celt_strerror(int error);
324
325 /*  @} */
326
327
328 #ifdef __cplusplus
329 }
330 #endif
331
332 #endif /*CELT_H */