Fixes post-filter for transitions between 2.5ms and other frame sizes
[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    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 #ifndef CELT_H
36 #define CELT_H
37
38 #include "celt_types.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #if defined(__GNUC__) && defined(CELT_BUILD)
45 #define EXPORT __attribute__ ((visibility ("default")))
46 #elif defined(WIN32)
47 #define EXPORT __declspec(dllexport)
48 #else
49 #define EXPORT
50 #endif
51
52 #define _celt_check_int(x) (((void)((x) == (celt_int32)0)), (celt_int32)(x))
53 #define _celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (CELTMode**)(ptr)))
54
55 /* Error codes */
56 /** No error */
57 #define CELT_OK                0
58 /** An (or more) invalid argument (e.g. out of range) */
59 #define CELT_BAD_ARG          -1
60 /** The mode struct passed is invalid */
61 #define CELT_INVALID_MODE     -2
62 /** An internal error was detected */
63 #define CELT_INTERNAL_ERROR   -3
64 /** The data passed (e.g. compressed data to decoder) is corrupted */
65 #define CELT_CORRUPTED_DATA   -4
66 /** Invalid/unsupported request number */
67 #define CELT_UNIMPLEMENTED    -5
68 /** An encoder or decoder structure is invalid or already freed */
69 #define CELT_INVALID_STATE    -6
70 /** Memory allocation has failed */
71 #define CELT_ALLOC_FAIL       -7
72
73 /* Requests */
74 #define CELT_GET_MODE_REQUEST    1
75 /** Get the CELTMode used by an encoder or decoder */
76 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
77
78 #define CELT_SET_COMPLEXITY_REQUEST    2
79 /** Controls the complexity from 0-10 (int) */
80 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
81
82 #define CELT_SET_PREDICTION_REQUEST    4
83 /** Controls the use of interframe prediction.
84     0=Independent frames
85     1=Short term interframe prediction allowed
86     2=Long term prediction allowed
87  */
88 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, _celt_check_int(x)
89
90 #define CELT_SET_BITRATE_REQUEST    6
91 /** Set the target VBR rate in bits per second(int); 0=CBR (default) */
92 #define CELT_SET_BITRATE(x) CELT_SET_BITRATE_REQUEST, _celt_check_int(x)
93
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_VBR_REQUEST 12
102 #define CELT_SET_VBR(x)       CELT_SET_VBR_REQUEST, _celt_check_int(x)
103
104 #define CELT_SET_INPUT_CLIPPING_REQUEST    14
105 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, _celt_check_int(x)
106
107 #define CELT_SET_START_BAND_REQUEST    10000
108 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, _celt_check_int(x)
109
110 #define CELT_SET_END_BAND_REQUEST    10001
111 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, _celt_check_int(x)
112
113 #define CELT_SET_CHANNELS_REQUEST    10002
114 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, _celt_check_int(x)
115
116 /** GET the lookahead used in the current mode */
117 #define CELT_GET_LOOKAHEAD    1001
118 /** GET the sample rate used in the current mode */
119 #define CELT_GET_SAMPLE_RATE  1003
120
121 /** GET the bit-stream version for compatibility check */
122 #define CELT_GET_BITSTREAM_VERSION 2000
123
124
125 /** Contains the state of an encoder. One encoder state is needed 
126     for each stream. It is initialised once at the beginning of the
127     stream. Do *not* re-initialise the state for every frame.
128    @brief Encoder state
129  */
130 typedef struct CELTEncoder CELTEncoder;
131
132 /** State of the decoder. One decoder state is needed for each stream.
133     It is initialised once at the beginning of the stream. Do *not*
134     re-initialise the state for every frame */
135 typedef struct CELTDecoder CELTDecoder;
136
137 /** The mode contains all the information necessary to create an
138     encoder. Both the encoder and decoder need to be initialised
139     with exactly the same mode, otherwise the quality will be very 
140     bad */
141 typedef struct CELTMode CELTMode;
142
143
144 /** \defgroup codec Encoding and decoding */
145 /*  @{ */
146
147 /* Mode calls */
148
149 /** Creates a new mode struct. This will be passed to an encoder or 
150     decoder. The mode MUST NOT BE DESTROYED until the encoders and 
151     decoders that use it are destroyed as well.
152  @param Fs Sampling rate (32000 to 96000 Hz)
153  @param frame_size Number of samples (per channel) to encode in each 
154                    packet (even values; 64 - 512)
155  @param error Returned error code (if NULL, no error will be returned)
156  @return A newly created mode
157 */
158 EXPORT CELTMode *celt_mode_create(celt_int32 Fs, int frame_size, int *error);
159
160 /** Destroys a mode struct. Only call this after all encoders and 
161     decoders using this mode are destroyed as well.
162  @param mode Mode to be destroyed
163 */
164 EXPORT void celt_mode_destroy(CELTMode *mode);
165
166 /** Query information from a mode */
167 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32 *value);
168
169 /* Encoder stuff */
170
171 EXPORT int celt_encoder_get_size(int channels);
172
173 EXPORT int celt_encoder_get_size_custom(const CELTMode *mode, int channels);
174
175 /** Creates a new encoder state. Each stream needs its own encoder 
176     state (can't be shared across simultaneous streams).
177  @param channels Number of channels
178  @param error Returns an error code
179  @return Newly created encoder state.
180 */
181 EXPORT CELTEncoder *celt_encoder_create(int sampling_rate, int channels, int *error);
182
183 /** Creates a new encoder state. Each stream needs its own encoder
184     state (can't be shared across simultaneous streams).
185  @param mode Contains all the information about the characteristics of
186  *  the stream (must be the same characteristics as used for the 
187  *  decoder)
188  @param channels Number of channels
189  @param error Returns an error code
190  @return Newly created encoder state.
191 */
192 EXPORT CELTEncoder *celt_encoder_create_custom(const CELTMode *mode, int channels, int *error);
193
194 EXPORT CELTEncoder *celt_encoder_init(CELTEncoder *st, int sampling_rate, int channels, int *error);
195
196 EXPORT CELTEncoder *celt_encoder_init_custom(CELTEncoder *st, const CELTMode *mode, int channels, int *error);
197
198 /** Destroys a an encoder state.
199  @param st Encoder state to be destroyed
200  */
201 EXPORT void celt_encoder_destroy(CELTEncoder *st);
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 maxCompressedBytes);
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 compressed The compressed data is written here. This may not alias pcm or
228  *                         optional_synthesis.
229  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
230  *                        (can change from one frame to another)
231  @return Number of bytes written to "compressed". Will be the same as
232  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
233  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
234  *       the length returned be somehow transmitted to the decoder. Otherwise, no
235  *       decoding is possible.
236  */
237 EXPORT int celt_encode(CELTEncoder *st, const celt_int16 *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
238
239 /** Query and set encoder parameters 
240  @param st Encoder state
241  @param request Parameter to change or query
242  @param value Pointer to a 32-bit int value
243  @return Error code
244 */
245 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
246
247 /* Decoder stuff */
248
249 EXPORT int celt_decoder_get_size(int channels);
250
251 EXPORT int celt_decoder_get_size_custom(const CELTMode *mode, int channels);
252
253 /** Creates a new decoder state. Each stream needs its own decoder state (can't
254     be shared across simultaneous streams).
255  @param mode Contains all the information about the characteristics of the
256              stream (must be the same characteristics as used for the encoder)
257  @param channels Number of channels
258  @param error Returns an error code
259  @return Newly created decoder state.
260  */
261 EXPORT CELTDecoder *celt_decoder_create(int sampling_rate, int channels, int *error);
262
263 /** Creates a new decoder state. Each stream needs its own decoder state (can't
264     be shared across simultaneous streams).
265  @param mode Contains all the information about the characteristics of the
266              stream (must be the same characteristics as used for the encoder)
267  @param channels Number of channels
268  @param error Returns an error code
269  @return Newly created decoder state.
270  */
271 EXPORT CELTDecoder *celt_decoder_create_custom(const CELTMode *mode, int channels, int *error);
272
273 EXPORT CELTDecoder *celt_decoder_init(CELTDecoder *st, int sampling_rate, int channels, int *error);
274
275 EXPORT CELTDecoder *celt_decoder_init_custom(CELTDecoder *st, const CELTMode *mode, int channels, int *error);
276
277 /** Destroys a a decoder state.
278  @param st Decoder state to be destroyed
279  */
280 EXPORT void celt_decoder_destroy(CELTDecoder *st);
281
282 /** Decodes a frame of audio.
283  @param st Decoder state
284  @param data Compressed data produced by an encoder
285  @param len Number of bytes to read from "data". This MUST be exactly the number
286             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
287  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
288             returned here in float format. 
289  @return Error code.
290    */
291 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size);
292
293 /** Decodes a frame of audio.
294  @param st Decoder state
295  @param data Compressed data produced by an encoder
296  @param len Number of bytes to read from "data". This MUST be exactly the number
297             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
298  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
299             returned here in 16-bit PCM format (native endian). 
300  @return Error code.
301  */
302 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16 *pcm, int frame_size);
303
304 /** Query and set decoder parameters
305    @param st Decoder state
306    @param request Parameter to change or query
307    @param value Pointer to a 32-bit int value
308    @return Error code
309  */
310 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
311
312
313 /** Returns the English string that corresponds to an error code
314  * @param error Error code (negative for an error, 0 for success
315  * @return Constant string (must NOT be freed)
316  */
317 EXPORT const char *celt_strerror(int error);
318
319 /*  @} */
320
321
322 #ifdef __cplusplus
323 }
324 #endif
325
326 #endif /*CELT_H */