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