Apply band caps to the band allocation table.
[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_VBR_CONSTRAINT_REQUEST 10
99 #define CELT_SET_VBR_CONSTRAINT(x)       CELT_SET_VBR_CONSTRAINT_REQUEST, _celt_check_int(x)
100
101 #define CELT_SET_START_BAND_REQUEST    10000
102 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, _celt_check_int(x)
103
104 #define CELT_SET_END_BAND_REQUEST    10001
105 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, _celt_check_int(x)
106
107 /** GET the lookahead used in the current mode */
108 #define CELT_GET_LOOKAHEAD    1001
109 /** GET the sample rate used in the current mode */
110 #define CELT_GET_SAMPLE_RATE  1003
111
112 /** GET the bit-stream version for compatibility check */
113 #define CELT_GET_BITSTREAM_VERSION 2000
114
115
116 /** Contains the state of an encoder. One encoder state is needed 
117     for each stream. It is initialised once at the beginning of the
118     stream. Do *not* re-initialise the state for every frame.
119    @brief Encoder state
120  */
121 typedef struct CELTEncoder CELTEncoder;
122
123 /** State of the decoder. One decoder state is needed for each stream.
124     It is initialised once at the beginning of the stream. Do *not*
125     re-initialise the state for every frame */
126 typedef struct CELTDecoder CELTDecoder;
127
128 /** The mode contains all the information necessary to create an
129     encoder. Both the encoder and decoder need to be initialised
130     with exactly the same mode, otherwise the quality will be very 
131     bad */
132 typedef struct CELTMode CELTMode;
133
134
135 /** \defgroup codec Encoding and decoding */
136 /*  @{ */
137
138 /* Mode calls */
139
140 /** Creates a new mode struct. This will be passed to an encoder or 
141     decoder. The mode MUST NOT BE DESTROYED until the encoders and 
142     decoders that use it are destroyed as well.
143  @param Fs Sampling rate (32000 to 96000 Hz)
144  @param frame_size Number of samples (per channel) to encode in each 
145                    packet (even values; 64 - 512)
146  @param error Returned error code (if NULL, no error will be returned)
147  @return A newly created mode
148 */
149 EXPORT CELTMode *celt_mode_create(celt_int32 Fs, int frame_size, int *error);
150
151 /** Destroys a mode struct. Only call this after all encoders and 
152     decoders using this mode are destroyed as well.
153  @param mode Mode to be destroyed
154 */
155 EXPORT void celt_mode_destroy(CELTMode *mode);
156
157 /** Query information from a mode */
158 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32 *value);
159
160 /* Encoder stuff */
161
162 EXPORT int celt_encoder_get_size(int channels);
163
164 EXPORT int celt_encoder_get_size_custom(const CELTMode *mode, int channels);
165
166 /** Creates a new encoder state. Each stream needs its own encoder 
167     state (can't be shared across simultaneous streams).
168  @param channels Number of channels
169  @param error Returns an error code
170  @return Newly created encoder state.
171 */
172 EXPORT CELTEncoder *celt_encoder_create(int sampling_rate, int channels, int *error);
173
174 /** Creates a new encoder state. Each stream needs its own encoder
175     state (can't be shared across simultaneous streams).
176  @param mode Contains all the information about the characteristics of
177  *  the stream (must be the same characteristics as used for the 
178  *  decoder)
179  @param channels Number of channels
180  @param error Returns an error code
181  @return Newly created encoder state.
182 */
183 EXPORT CELTEncoder *celt_encoder_create_custom(const CELTMode *mode, int channels, int *error);
184
185 EXPORT CELTEncoder *celt_encoder_init(CELTEncoder *st, int sampling_rate, int channels, int *error);
186
187 EXPORT CELTEncoder *celt_encoder_init_custom(CELTEncoder *st, const CELTMode *mode, int channels, int *error);
188
189 /** Destroys a an encoder state.
190  @param st Encoder state to be destroyed
191  */
192 EXPORT void celt_encoder_destroy(CELTEncoder *st);
193
194 /** Encodes a frame of audio.
195  @param st Encoder state
196  @param pcm PCM audio in float format, with a normal range of ±1.0.
197  *          Samples with a range beyond ±1.0 are supported but will
198  *          be clipped by decoders using the integer API and should
199  *          only be used if it is known that the far end supports
200  *          extended dynmaic range. There must be exactly
201  *          frame_size samples per channel.
202  @param compressed The compressed data is written here. This may not alias pcm or
203  *                 optional_synthesis.
204  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
205  *          (can change from one frame to another)
206  @return Number of bytes written to "compressed". Will be the same as
207  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
208  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
209  *       the length returned be somehow transmitted to the decoder. Otherwise, no
210  *       decoding is possible.
211 */
212 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes);
213
214 /** Encodes a frame of audio.
215  @param st Encoder state
216  @param pcm PCM audio in signed 16-bit format (native endian). There must be
217  *          exactly frame_size samples per channel.
218  @param compressed The compressed data is written here. This may not alias pcm or
219  *                         optional_synthesis.
220  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
221  *                        (can change from one frame to another)
222  @return Number of bytes written to "compressed". Will be the same as
223  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
224  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
225  *       the length returned be somehow transmitted to the decoder. Otherwise, no
226  *       decoding is possible.
227  */
228 EXPORT int celt_encode(CELTEncoder *st, const celt_int16 *pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes);
229
230 /** Query and set encoder parameters 
231  @param st Encoder state
232  @param request Parameter to change or query
233  @param value Pointer to a 32-bit int value
234  @return Error code
235 */
236 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
237
238 /* Decoder stuff */
239
240 EXPORT int celt_decoder_get_size(int channels);
241
242 EXPORT int celt_decoder_get_size_custom(const CELTMode *mode, int channels);
243
244 /** Creates a new decoder state. Each stream needs its own decoder state (can't
245     be shared across simultaneous streams).
246  @param mode Contains all the information about the characteristics of the
247              stream (must be the same characteristics as used for the encoder)
248  @param channels Number of channels
249  @param error Returns an error code
250  @return Newly created decoder state.
251  */
252 EXPORT CELTDecoder *celt_decoder_create(int sampling_rate, int channels, int *error);
253
254 /** Creates a new decoder state. Each stream needs its own decoder state (can't
255     be shared across simultaneous streams).
256  @param mode Contains all the information about the characteristics of the
257              stream (must be the same characteristics as used for the encoder)
258  @param channels Number of channels
259  @param error Returns an error code
260  @return Newly created decoder state.
261  */
262 EXPORT CELTDecoder *celt_decoder_create_custom(const CELTMode *mode, int channels, int *error);
263
264 EXPORT CELTDecoder *celt_decoder_init(CELTDecoder *st, int sampling_rate, int channels, int *error);
265
266 EXPORT CELTDecoder *celt_decoder_init_custom(CELTDecoder *st, const CELTMode *mode, int channels, int *error);
267
268 /** Destroys a a decoder state.
269  @param st Decoder state to be destroyed
270  */
271 EXPORT void celt_decoder_destroy(CELTDecoder *st);
272
273 /** Decodes a frame of audio.
274  @param st Decoder state
275  @param data Compressed data produced by an encoder
276  @param len Number of bytes to read from "data". This MUST be exactly the number
277             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
278  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
279             returned here in float format. 
280  @return Error code.
281    */
282 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size);
283
284 /** Decodes a frame of audio.
285  @param st Decoder state
286  @param data Compressed data produced by an encoder
287  @param len Number of bytes to read from "data". This MUST be exactly the number
288             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
289  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
290             returned here in 16-bit PCM format (native endian). 
291  @return Error code.
292  */
293 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16 *pcm, int frame_size);
294
295 /** Query and set decoder parameters
296    @param st Decoder state
297    @param request Parameter to change or query
298    @param value Pointer to a 32-bit int value
299    @return Error code
300  */
301 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
302
303
304 /** Returns the English string that corresponds to an error code
305  * @param error Error code (negative for an error, 0 for success
306  * @return Constant string (must NOT be freed)
307  */
308 EXPORT const char *celt_strerror(int error);
309
310 /*  @} */
311
312
313 #ifdef __cplusplus
314 }
315 #endif
316
317 #endif /*CELT_H */