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