Eliminate some unreachable cases from the cwrs code and fixup the
[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 "opus_types.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #if defined(__GNUC__) && defined(CELT_BUILD)
45 #define CELT_EXPORT __attribute__ ((visibility ("default")))
46 #elif defined(WIN32)
47 #define CELT_EXPORT __declspec(dllexport)
48 #else
49 #define CELT_EXPORT
50 #endif
51
52 #define _celt_check_int(x) (((void)((x) == (opus_int32)0)), (opus_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 /* Encoder/decoder Requests */
75
76 #define CELT_SET_COMPLEXITY_REQUEST    2
77 /** Controls the complexity from 0-10 (int) */
78 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
79
80 #define CELT_SET_PREDICTION_REQUEST    4
81 /** Controls the use of interframe prediction.
82     0=Independent frames
83     1=Short term interframe prediction allowed
84     2=Long term prediction allowed
85  */
86 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, _celt_check_int(x)
87
88 #define CELT_SET_BITRATE_REQUEST    6
89 /** Set the target VBR rate in bits per second(int); 0=CBR (default) */
90 #define CELT_SET_BITRATE(x) CELT_SET_BITRATE_REQUEST, _celt_check_int(x)
91
92 #define CELT_RESET_STATE_REQUEST        8
93 /** Reset the encoder/decoder memories to zero*/
94 #define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
95
96 #define CELT_SET_VBR_CONSTRAINT_REQUEST 10
97 #define CELT_SET_VBR_CONSTRAINT(x)       CELT_SET_VBR_CONSTRAINT_REQUEST, _celt_check_int(x)
98
99 #define CELT_SET_VBR_REQUEST 12
100 #define CELT_SET_VBR(x)       CELT_SET_VBR_REQUEST, _celt_check_int(x)
101
102 #define CELT_SET_INPUT_CLIPPING_REQUEST    14
103 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, _celt_check_int(x)
104
105 #define CELT_GET_AND_CLEAR_ERROR_REQUEST   15
106 #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, _celt_check_int_ptr(x)
107
108 #define CELT_GET_LOOKAHEAD_REQUEST   17
109 #define CELT_GET_LOOKAHEAD(x) CELT_GET_LOOKAHEAD_REQUEST, _celt_check_int_ptr(x)
110
111 #define CELT_SET_CHANNELS_REQUEST    18
112 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, _celt_check_int(x)
113
114 #define CELT_SET_LOSS_PERC_REQUEST    20
115 #define CELT_SET_LOSS_PERC(x) CELT_SET_LOSS_PERC_REQUEST, _celt_check_int(x)
116
117 /* Internal */
118 #define CELT_SET_START_BAND_REQUEST    10000
119 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, _celt_check_int(x)
120
121 #define CELT_SET_END_BAND_REQUEST    10001
122 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, _celt_check_int(x)
123
124 /** Contains the state of an encoder. One encoder state is needed
125     for each stream. It is initialised once at the beginning of the
126     stream. Do *not* re-initialise the state for every frame.
127    @brief Encoder state
128  */
129 typedef struct CELTEncoder CELTEncoder;
130
131 /** State of the decoder. One decoder state is needed for each stream.
132     It is initialised once at the beginning of the stream. Do *not*
133     re-initialise the state for every frame */
134 typedef struct CELTDecoder CELTDecoder;
135
136 /** The mode contains all the information necessary to create an
137     encoder. Both the encoder and decoder need to be initialised
138     with exactly the same mode, otherwise the quality will be very
139     bad */
140 typedef struct CELTMode CELTMode;
141
142 /** \defgroup codec Encoding and decoding */
143 /*  @{ */
144
145 /* Mode calls */
146
147 /** Creates a new mode struct. This will be passed to an encoder or
148     decoder. The mode MUST NOT BE DESTROYED until the encoders and
149     decoders that use it are destroyed as well.
150  @param Fs Sampling rate (32000 to 96000 Hz)
151  @param frame_size Number of samples (per channel) to encode in each
152                    packet (even values; 64 - 512)
153  @param error Returned error code (if NULL, no error will be returned)
154  @return A newly created mode
155 */
156 CELT_EXPORT CELTMode *celt_mode_create(opus_int32 Fs, int frame_size, int *error);
157
158 /** Destroys a mode struct. Only call this after all encoders and
159     decoders using this mode are destroyed as well.
160  @param mode Mode to be destroyed
161 */
162 CELT_EXPORT void celt_mode_destroy(CELTMode *mode);
163
164 /* Encoder stuff */
165
166 CELT_EXPORT int celt_encoder_get_size(int channels);
167
168 CELT_EXPORT int celt_encoder_get_size_custom(const CELTMode *mode, int channels);
169
170 /** Creates a new encoder state. Each stream needs its own encoder
171     state (can't be shared across simultaneous streams).
172  @param channels Number of channels
173  @param error Returns an error code
174  @return Newly created encoder state.
175 */
176 CELT_EXPORT CELTEncoder *celt_encoder_create(int sampling_rate, int channels, int *error);
177
178 /** Creates a new encoder state. Each stream needs its own encoder
179     state (can't be shared across simultaneous streams).
180  @param mode Contains all the information about the characteristics of
181  *  the stream (must be the same characteristics as used for the
182  *  decoder)
183  @param channels Number of channels
184  @param error Returns an error code
185  @return Newly created encoder state.
186 */
187 CELT_EXPORT CELTEncoder *celt_encoder_create_custom(const CELTMode *mode, int channels, int *error);
188
189 CELT_EXPORT CELTEncoder *celt_encoder_init(CELTEncoder *st, int sampling_rate, int channels, int *error);
190
191 CELT_EXPORT CELTEncoder *celt_encoder_init_custom(CELTEncoder *st, const CELTMode *mode, int channels, int *error);
192
193 /** Destroys a an encoder state.
194  @param st Encoder state to be destroyed
195  */
196 CELT_EXPORT void celt_encoder_destroy(CELTEncoder *st);
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 CELT_EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
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 compressed The compressed data is written here. This may not alias pcm or
223  *                         optional_synthesis.
224  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
225  *                        (can change from one frame to another)
226  @return Number of bytes written to "compressed". Will be the same as
227  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
228  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
229  *       the length returned be somehow transmitted to the decoder. Otherwise, no
230  *       decoding is possible.
231  */
232 CELT_EXPORT int celt_encode(CELTEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
233
234 /** Query and set encoder parameters
235  @param st Encoder state
236  @param request Parameter to change or query
237  @param value Pointer to a 32-bit int value
238  @return Error code
239 */
240 CELT_EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
241
242 /* Decoder stuff */
243
244 CELT_EXPORT int celt_decoder_get_size(int channels);
245
246 CELT_EXPORT int celt_decoder_get_size_custom(const CELTMode *mode, int channels);
247
248 /** Creates a new decoder state. Each stream needs its own decoder state (can't
249     be shared across simultaneous streams).
250  @param mode Contains all the information about the characteristics of the
251              stream (must be the same characteristics as used for the encoder)
252  @param channels Number of channels
253  @param error Returns an error code
254  @return Newly created decoder state.
255  */
256 CELT_EXPORT CELTDecoder *celt_decoder_create(int sampling_rate, int channels, int *error);
257
258 /** Creates a new decoder state. Each stream needs its own decoder state (can't
259     be shared across simultaneous streams).
260  @param mode Contains all the information about the characteristics of the
261              stream (must be the same characteristics as used for the encoder)
262  @param channels Number of channels
263  @param error Returns an error code
264  @return Newly created decoder state.
265  */
266 CELT_EXPORT CELTDecoder *celt_decoder_create_custom(const CELTMode *mode, int channels, int *error);
267
268 CELT_EXPORT CELTDecoder *celt_decoder_init(CELTDecoder *st, int sampling_rate, int channels, int *error);
269
270 CELT_EXPORT CELTDecoder *celt_decoder_init_custom(CELTDecoder *st, const CELTMode *mode, int channels, int *error);
271
272 /** Destroys a a decoder state.
273  @param st Decoder state to be destroyed
274  */
275 CELT_EXPORT void celt_decoder_destroy(CELTDecoder *st);
276
277 /** Decodes a frame of audio.
278  @param st Decoder state
279  @param data Compressed data produced by an encoder
280  @param len Number of bytes to read from "data". This MUST be exactly the number
281             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
282  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
283             returned here in float format.
284  @return Error code.
285    */
286 CELT_EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size);
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 16-bit PCM format (native endian).
295  @return Error code.
296  */
297 CELT_EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, opus_int16 *pcm, int frame_size);
298
299 /** Query and set decoder parameters
300    @param st Decoder state
301    @param request Parameter to change or query
302    @param value Pointer to a 32-bit int value
303    @return Error code
304  */
305 CELT_EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
306
307 /** Returns the English string that corresponds to an error code
308  * @param error Error code (negative for an error, 0 for success
309  * @return Constant string (must NOT be freed)
310  */
311 CELT_EXPORT const char *celt_strerror(int error);
312
313 /*  @} */
314
315 #ifdef __cplusplus
316 }
317 #endif
318
319 #endif /*CELT_H */