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