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