Implements CELT_SET_LOSS_PERC
[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) - (const CELTMode**)(ptr)))
54 #define _celt_check_int_ptr(ptr) ((ptr) + ((ptr) - (int*)(ptr)))
55
56 /* Error codes */
57 /** No error */
58 #define CELT_OK                0
59 /** An (or more) invalid argument (e.g. out of range) */
60 #define CELT_BAD_ARG          -1
61 /** The mode struct passed is invalid */
62 #define CELT_BUFFER_TOO_SMALL -2
63 /** An internal error was detected */
64 #define CELT_INTERNAL_ERROR   -3
65 /** The data passed (e.g. compressed data to decoder) is corrupted */
66 #define CELT_CORRUPTED_DATA   -4
67 /** Invalid/unsupported request number */
68 #define CELT_UNIMPLEMENTED    -5
69 /** An encoder or decoder structure is invalid or already freed */
70 #define CELT_INVALID_STATE    -6
71 /** Memory allocation has failed */
72 #define CELT_ALLOC_FAIL       -7
73
74
75 /* Encoder/decoder Requests */
76
77 #define CELT_SET_COMPLEXITY_REQUEST    2
78 /** Controls the complexity from 0-10 (int) */
79 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
80
81 #define CELT_SET_PREDICTION_REQUEST    4
82 /** Controls the use of interframe prediction.
83     0=Independent frames
84     1=Short term interframe prediction allowed
85     2=Long term prediction allowed
86  */
87 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, _celt_check_int(x)
88
89 #define CELT_SET_BITRATE_REQUEST    6
90 /** Set the target VBR rate in bits per second(int); 0=CBR (default) */
91 #define CELT_SET_BITRATE(x) CELT_SET_BITRATE_REQUEST, _celt_check_int(x)
92
93 #define CELT_RESET_STATE_REQUEST        8
94 /** Reset the encoder/decoder memories to zero*/
95 #define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
96
97 #define CELT_SET_VBR_CONSTRAINT_REQUEST 10
98 #define CELT_SET_VBR_CONSTRAINT(x)       CELT_SET_VBR_CONSTRAINT_REQUEST, _celt_check_int(x)
99
100 #define CELT_SET_VBR_REQUEST 12
101 #define CELT_SET_VBR(x)       CELT_SET_VBR_REQUEST, _celt_check_int(x)
102
103 #define CELT_SET_INPUT_CLIPPING_REQUEST    14
104 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, _celt_check_int(x)
105
106 #define CELT_GET_AND_CLEAR_ERROR_REQUEST   15
107 #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, _celt_check_int_ptr(x)
108
109 #define CELT_GET_LOOKAHEAD_REQUEST   17
110 #define CELT_GET_LOOKAHEAD(x) CELT_GET_LOOKAHEAD_REQUEST, _celt_check_int_ptr(x)
111
112 #define CELT_SET_CHANNELS_REQUEST    18
113 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, _celt_check_int(x)
114
115 #define CELT_SET_LOSS_PERC_REQUEST    20
116 #define CELT_SET_LOSS_PERC(x) CELT_SET_LOSS_PERC_REQUEST, _celt_check_int(x)
117
118 /* Internal */
119 #define CELT_SET_START_BAND_REQUEST    10000
120 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, _celt_check_int(x)
121
122 #define CELT_SET_END_BAND_REQUEST    10001
123 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, _celt_check_int(x)
124
125
126
127 /** Contains the state of an encoder. One encoder state is needed 
128     for each stream. It is initialised once at the beginning of the
129     stream. Do *not* re-initialise the state for every frame.
130    @brief Encoder state
131  */
132 typedef struct CELTEncoder CELTEncoder;
133
134 /** State of the decoder. One decoder state is needed for each stream.
135     It is initialised once at the beginning of the stream. Do *not*
136     re-initialise the state for every frame */
137 typedef struct CELTDecoder CELTDecoder;
138
139 /** The mode contains all the information necessary to create an
140     encoder. Both the encoder and decoder need to be initialised
141     with exactly the same mode, otherwise the quality will be very 
142     bad */
143 typedef struct CELTMode CELTMode;
144
145
146 /** \defgroup codec Encoding and decoding */
147 /*  @{ */
148
149 /* Mode calls */
150
151 /** Creates a new mode struct. This will be passed to an encoder or 
152     decoder. The mode MUST NOT BE DESTROYED until the encoders and 
153     decoders that use it are destroyed as well.
154  @param Fs Sampling rate (32000 to 96000 Hz)
155  @param frame_size Number of samples (per channel) to encode in each 
156                    packet (even values; 64 - 512)
157  @param error Returned error code (if NULL, no error will be returned)
158  @return A newly created mode
159 */
160 EXPORT CELTMode *celt_mode_create(celt_int32 Fs, int frame_size, int *error);
161
162 /** Destroys a mode struct. Only call this after all encoders and 
163     decoders using this mode are destroyed as well.
164  @param mode Mode to be destroyed
165 */
166 EXPORT void celt_mode_destroy(CELTMode *mode);
167
168 /* Encoder stuff */
169
170 EXPORT int celt_encoder_get_size(int channels);
171
172 EXPORT int celt_encoder_get_size_custom(const CELTMode *mode, int channels);
173
174 /** Creates a new encoder state. Each stream needs its own encoder 
175     state (can't be shared across simultaneous streams).
176  @param channels Number of channels
177  @param error Returns an error code
178  @return Newly created encoder state.
179 */
180 EXPORT CELTEncoder *celt_encoder_create(int sampling_rate, int channels, int *error);
181
182 /** Creates a new encoder state. Each stream needs its own encoder
183     state (can't be shared across simultaneous streams).
184  @param mode Contains all the information about the characteristics of
185  *  the stream (must be the same characteristics as used for the 
186  *  decoder)
187  @param channels Number of channels
188  @param error Returns an error code
189  @return Newly created encoder state.
190 */
191 EXPORT CELTEncoder *celt_encoder_create_custom(const CELTMode *mode, int channels, int *error);
192
193 EXPORT CELTEncoder *celt_encoder_init(CELTEncoder *st, int sampling_rate, int channels, int *error);
194
195 EXPORT CELTEncoder *celt_encoder_init_custom(CELTEncoder *st, const CELTMode *mode, int channels, int *error);
196
197 /** Destroys a an encoder state.
198  @param st Encoder state to be destroyed
199  */
200 EXPORT void celt_encoder_destroy(CELTEncoder *st);
201
202 /** Encodes a frame of audio.
203  @param st Encoder state
204  @param pcm PCM audio in float format, with a normal range of ±1.0.
205  *          Samples with a range beyond ±1.0 are supported but will
206  *          be clipped by decoders using the integer API and should
207  *          only be used if it is known that the far end supports
208  *          extended dynmaic range. There must be exactly
209  *          frame_size samples per channel.
210  @param compressed The compressed data is written here. This may not alias pcm or
211  *                 optional_synthesis.
212  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
213  *          (can change from one frame to another)
214  @return Number of bytes written to "compressed". Will be the same as
215  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
216  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
217  *       the length returned be somehow transmitted to the decoder. Otherwise, no
218  *       decoding is possible.
219 */
220 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
221
222 /** Encodes a frame of audio.
223  @param st Encoder state
224  @param pcm PCM audio in signed 16-bit format (native endian). There must be
225  *          exactly frame_size samples per channel.
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(CELTEncoder *st, const celt_int16 *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
237
238 /** Query and set encoder parameters 
239  @param st Encoder state
240  @param request Parameter to change or query
241  @param value Pointer to a 32-bit int value
242  @return Error code
243 */
244 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
245
246 /* Decoder stuff */
247
248 EXPORT int celt_decoder_get_size(int channels);
249
250 EXPORT int celt_decoder_get_size_custom(const CELTMode *mode, int channels);
251
252 /** Creates a new decoder state. Each stream needs its own decoder state (can't
253     be shared across simultaneous streams).
254  @param mode Contains all the information about the characteristics of the
255              stream (must be the same characteristics as used for the encoder)
256  @param channels Number of channels
257  @param error Returns an error code
258  @return Newly created decoder state.
259  */
260 EXPORT CELTDecoder *celt_decoder_create(int sampling_rate, int channels, int *error);
261
262 /** Creates a new decoder state. Each stream needs its own decoder state (can't
263     be shared across simultaneous streams).
264  @param mode Contains all the information about the characteristics of the
265              stream (must be the same characteristics as used for the encoder)
266  @param channels Number of channels
267  @param error Returns an error code
268  @return Newly created decoder state.
269  */
270 EXPORT CELTDecoder *celt_decoder_create_custom(const CELTMode *mode, int channels, int *error);
271
272 EXPORT CELTDecoder *celt_decoder_init(CELTDecoder *st, int sampling_rate, int channels, int *error);
273
274 EXPORT CELTDecoder *celt_decoder_init_custom(CELTDecoder *st, const CELTMode *mode, int channels, int *error);
275
276 /** Destroys a a decoder state.
277  @param st Decoder state to be destroyed
278  */
279 EXPORT void celt_decoder_destroy(CELTDecoder *st);
280
281 /** Decodes a frame of audio.
282  @param st Decoder state
283  @param data Compressed data produced by an encoder
284  @param len Number of bytes to read from "data". This MUST be exactly the number
285             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
286  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
287             returned here in float format. 
288  @return Error code.
289    */
290 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size);
291
292 /** Decodes a frame of audio.
293  @param st Decoder state
294  @param data Compressed data produced by an encoder
295  @param len Number of bytes to read from "data". This MUST be exactly the number
296             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
297  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
298             returned here in 16-bit PCM format (native endian). 
299  @return Error code.
300  */
301 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16 *pcm, int frame_size);
302
303 /** Query and set decoder parameters
304    @param st Decoder state
305    @param request Parameter to change or query
306    @param value Pointer to a 32-bit int value
307    @return Error code
308  */
309 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
310
311
312 /** Returns the English string that corresponds to an error code
313  * @param error Error code (negative for an error, 0 for success
314  * @return Constant string (must NOT be freed)
315  */
316 EXPORT const char *celt_strerror(int error);
317
318 /*  @} */
319
320
321 #ifdef __cplusplus
322 }
323 #endif
324
325 #endif /*CELT_H */