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