Merge commit 'origin/master'
[opus.git] / libcelt / celt.h
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2    (C) 2008 Gregory Maxwell */
3 /**
4   @file celt.h
5   @brief Contains all the functions for encoding and decoding audio
6  */
7
8 /*
9    Redistribution and use in source and binary forms, with or without
10    modification, are permitted provided that the following conditions
11    are met:
12    
13    - Redistributions of source code must retain the above copyright
14    notice, this list of conditions and the following disclaimer.
15    
16    - Redistributions in binary form must reproduce the above copyright
17    notice, this list of conditions and the following disclaimer in the
18    documentation and/or other materials provided with the distribution.
19    
20    - Neither the name of the Xiph.org Foundation nor the names of its
21    contributors may be used to endorse or promote products derived from
22    this software without specific prior written permission.
23    
24    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
28    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37 #ifndef CELT_H
38 #define CELT_H
39
40 #include "celt_types.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 #if defined(__GNUC__) && defined(CELT_BUILD)
47 #define EXPORT __attribute__ ((visibility ("default")))
48 #elif defined(WIN32)
49 #define EXPORT __declspec(dllexport)
50 #else
51 #define EXPORT
52 #endif
53
54 #define _celt_check_int(x) (((void)((x) == (celt_int32_t)0)), (celt_int32_t)(x))
55 #define _celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (CELTMode**)(ptr)))
56
57 /* Error codes */
58 /** No error */
59 #define CELT_OK                0
60 /** An (or more) invalid argument (e.g. out of range) */
61 #define CELT_BAD_ARG          -1
62 /** The mode struct passed is invalid */
63 #define CELT_INVALID_MODE     -2
64 /** An internal error was detected */
65 #define CELT_INTERNAL_ERROR   -3
66 /** The data passed (e.g. compressed data to decoder) is corrupted */
67 #define CELT_CORRUPTED_DATA   -4
68 /** Invalid/unsupported request number */
69 #define CELT_UNIMPLEMENTED    -5
70 /** An encoder or decoder structure is invalid or already freed */
71 #define CELT_INVALID_STATE    -6
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 #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 #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 #define CELT_SET_VBR_RATE_REQUEST    6
88 /** Set the target VBR rate in bits per second(int); 0=CBR (default) */
89 #define CELT_SET_VBR_RATE(x) CELT_SET_VBR_RATE_REQUEST, _celt_check_int(x)
90 /** Reset the encoder/decoder memories to zero*/
91 #define CELT_RESET_STATE_REQUEST        8
92 #define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
93
94 /** GET the frame size used in the current mode */
95 #define CELT_GET_FRAME_SIZE   1000
96 /** GET the lookahead used in the current mode */
97 #define CELT_GET_LOOKAHEAD    1001
98 /** GET the number of channels used in the current mode */
99 #define CELT_GET_NB_CHANNELS  1002
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 channels Number of channels
136  @param frame_size Number of samples (per channel) to encode in each 
137                    packet (even values; 64 - 512)
138  @param error Returned error code (if NULL, no error will be returned)
139  @return A newly created mode
140 */
141 EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
142
143 /** Destroys a mode struct. Only call this after all encoders and 
144     decoders using this mode are destroyed as well.
145  @param mode Mode to be destroyed
146 */
147 EXPORT void celt_mode_destroy(CELTMode *mode);
148
149 /** Query information from a mode */
150 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
151
152 /* Encoder stuff */
153
154
155 /** Creates a new encoder state. Each stream needs its own encoder 
156     state (can't be shared across simultaneous streams).
157  @param mode Contains all the information about the characteristics of
158  *  the stream (must be the same characteristics as used for the 
159  *  decoder)
160  @return Newly created encoder state.
161 */
162 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
163
164 /** Destroys a an encoder state.
165  @param st Encoder state to be destroyed
166  */
167 EXPORT void celt_encoder_destroy(CELTEncoder *st);
168
169 /** Encodes a frame of audio.
170  @param st Encoder state
171  @param pcm PCM audio in float format, with a normal range of ±1.0. 
172  *          Samples with a range beyond ±1.0 are supported but will 
173  *          be clipped by decoders using the integer API and should 
174  *          only be used if it is known that the far end supports 
175  *          extended dynmaic range. There must be exactly
176  *          frame_size samples per channel. 
177  @param optional_synthesis If not NULL, the encoder copies the audio signal that
178  *          the decoder would decode. It is the same as calling the
179  *          decoder on the compressed data, just faster.
180  *          This may alias pcm. 
181  @param compressed The compressed data is written here. This may not alias pcm or
182  *                 optional_synthesis.
183  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
184  *          (can change from one frame to another)
185  @return Number of bytes written to "compressed". Will be the same as 
186  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
187  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
188  *       the length returned be somehow transmitted to the decoder. Otherwise, no
189  *       decoding is possible.
190 */
191 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
192
193 /** Encodes a frame of audio.
194  @param st Encoder state
195  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
196  *          exactly frame_size samples per channel. 
197  @param optional_synthesis If not NULL, the encoder copies the audio signal that
198  *                         the decoder would decode. It is the same as calling the
199  *                         decoder on the compressed data, just faster.
200  *                         This may alias pcm. 
201  @param compressed The compressed data is written here. This may not alias pcm or
202  *                         optional_synthesis.
203  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
204  *                        (can change from one frame to another)
205  @return Number of bytes written to "compressed". Will be the same as 
206  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
207  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
208  *       the length returned be somehow transmitted to the decoder. Otherwise, no
209  *       decoding is possible.
210  */
211 EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
212
213 /** Query and set encoder parameters 
214  @param st Encoder state
215  @param request Parameter to change or query
216  @param value Pointer to a 32-bit int value
217  @return Error code
218 */
219 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
220
221 /* Decoder stuff */
222
223
224 /** Creates a new decoder state. Each stream needs its own decoder state (can't
225     be shared across simultaneous streams).
226  @param mode Contains all the information about the characteristics of the
227              stream (must be the same characteristics as used for the encoder)
228  @return Newly created decoder state.
229  */
230 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
231
232 /** Destroys a a decoder state.
233  @param st Decoder state to be destroyed
234  */
235 EXPORT void celt_decoder_destroy(CELTDecoder *st);
236
237 /** Decodes a frame of audio.
238  @param st Decoder state
239  @param data Compressed data produced by an encoder
240  @param len Number of bytes to read from "data". This MUST be exactly the number
241             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
242  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
243             returned here in float format. 
244  @return Error code.
245    */
246 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm);
247
248 /** Decodes a frame of audio.
249  @param st Decoder state
250  @param data Compressed data produced by an encoder
251  @param len Number of bytes to read from "data". This MUST be exactly the number
252             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
253  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
254             returned here in 16-bit PCM format (native endian). 
255  @return Error code.
256  */
257 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16_t *pcm);
258
259 /** Query and set decoder parameters
260    @param st Decoder state
261    @param request Parameter to change or query
262    @param value Pointer to a 32-bit int value
263    @return Error code
264  */
265 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
266
267
268 /*  @} */
269
270
271 #ifdef __cplusplus
272 }
273 #endif
274
275 #endif /*CELT_H */