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