VBR support. VBR API and VBR support in celtenc.
[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
56 /* Error codes */
57 /** No error */
58 #define CELT_OK                0
59 /** An (or more) invalid argument (e.g. out of range) */
60 #define CELT_BAD_ARG          -1
61 /** The mode struct passed is invalid */
62 #define CELT_INVALID_MODE     -2
63 /** An internal error was detected */
64 #define CELT_INTERNAL_ERROR   -3
65 /** The data passed (e.g. compressed data to decoder) is corrupted */
66 #define CELT_CORRUPTED_DATA   -4
67 /** Invalid/unsupported request number */
68 #define CELT_UNIMPLEMENTED    -5
69
70 /* Requests */
71 #define CELT_SET_COMPLEXITY_REQUEST    2
72 /** Controls the complexity from 0-10 (int) */
73 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
74 #define CELT_SET_LTP_REQUEST    4
75 /** Activate or deactivate the use of the long term predictor (PITCH) from 0 or 1 (int) */
76 #define CELT_SET_LTP(x) CELT_SET_LTP_REQUEST, _celt_check_int(x)
77 #define CELT_SET_VBR_RATE_REQUEST    6
78 /** Set the target VBR rate in bits per second (int); 0=CBR (default) */
79 #define CELT_SET_VBR_RATE(x) CELT_SET_VBR_RATE_REQUEST, _celt_check_int(x)
80
81 /** GET the frame size used in the current mode */
82 #define CELT_GET_FRAME_SIZE   1000
83 /** GET the lookahead used in the current mode */
84 #define CELT_GET_LOOKAHEAD    1001
85 /** GET the number of channels used in the current mode */
86 #define CELT_GET_NB_CHANNELS  1002
87
88 /** GET the bit-stream version for compatibility check */
89 #define CELT_GET_BITSTREAM_VERSION 2000
90
91
92 /** Contains the state of an encoder. One encoder state is needed for each 
93     stream. It is initialised once at the beginning of the stream. Do *not*
94     re-initialise the state for every frame.
95    @brief Encoder state
96  */
97 typedef struct CELTEncoder CELTEncoder;
98
99 /** State of the decoder. One decoder state is needed for each stream. It is
100     initialised once at the beginning of the stream. Do *not* re-initialise
101     the state for every frame */
102 typedef struct CELTDecoder CELTDecoder;
103
104 /** The mode contains all the information necessary to create an encoder. Both
105     the encoder and decoder need to be initialised with exactly the same mode,
106     otherwise the quality will be very bad */
107 typedef struct CELTMode CELTMode;
108
109
110 /** \defgroup codec Encoding and decoding */
111 /*  @{ */
112
113 /* Mode calls */
114
115 /** Creates a new mode struct. This will be passed to an encoder or decoder.
116     The mode MUST NOT BE DESTROYED until the encoders and decoders that use it
117     are destroyed as well.
118  @param Fs Sampling rate (32000 to 96000 Hz)
119  @param channels Number of channels
120  @param frame_size Number of samples (per channel) to encode in each packet (even values; 64 - 512)
121  @param lookahead Extra latency (in samples per channel) in addition to the frame size (between 32 and frame_size). 
122  @param error Returned error code (if NULL, no error will be returned)
123  @return A newly created mode
124 */
125 EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
126
127 /** Destroys a mode struct. Only call this after all encoders and decoders
128     using this mode are destroyed as well.
129  @param mode Mode to be destroyed
130 */
131 EXPORT void celt_mode_destroy(CELTMode *mode);
132
133 /** Query information from a mode */
134 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
135
136 /* Encoder stuff */
137
138
139 /** Creates a new encoder state. Each stream needs its own encoder state (can't
140     be shared across simultaneous streams).
141  @param mode Contains all the information about the characteristics of the stream
142              (must be the same characteristics as used for the decoder)
143  @return Newly created encoder state.
144 */
145 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
146
147 /** Destroys a an encoder state.
148  @param st Encoder state to be destroyed
149  */
150 EXPORT void celt_encoder_destroy(CELTEncoder *st);
151
152 /** Encodes a frame of audio.
153  @param st Encoder state
154  @param pcm PCM audio in float format, with a normal range of ±1.0. 
155  *          Samples with a range beyond ±1.0 are supported but will be clipped by 
156  *          decoders using the integer API and should only be used if it is known that
157  *          the far end supports extended dynmaic range. There must be exactly
158  *          frame_size samples per channel. 
159  @param optional_synthesis If not NULL, the encoder copies the audio signal that
160  *                         the decoder would decode. It is the same as calling the
161  *                         decoder on the compressed data, just faster.
162  *                         This may alias pcm. 
163  @param compressed The compressed data is written here. This may not alias pcm or
164  *                         optional_synthesis.
165  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
166  *                        (can change from one frame to another)
167  @return Number of bytes written to "compressed". Will be the same as 
168  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
169  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
170  *       the length returned be somehow transmitted to the decoder. Otherwise, no
171  *       decoding is possible.
172 */
173 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
174
175 /** Encodes a frame of audio.
176  @param st Encoder state
177  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
178  *          exactly 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(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
194
195 /** Query and set encoder parameters 
196  @param st Encoder state
197  @param request Parameter to change or query
198  @param value Pointer to a 32-bit int value
199  @return Error code
200 */
201 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
202
203 /* Decoder stuff */
204
205
206 /** Creates a new decoder state. Each stream needs its own decoder state (can't
207     be shared across simultaneous streams).
208  @param mode Contains all the information about the characteristics of the
209              stream (must be the same characteristics as used for the encoder)
210  @return Newly created decoder state.
211  */
212 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
213
214 /** Destroys a a decoder state.
215  @param st Decoder state to be destroyed
216  */
217 EXPORT void celt_decoder_destroy(CELTDecoder *st);
218
219 /** Decodes a frame of audio.
220  @param st Decoder state
221  @param data Compressed data produced by an encoder
222  @param len Number of bytes to read from "data". This MUST be exactly the number
223             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
224  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
225             returned here in float format. 
226  @return Error code.
227    */
228 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm);
229
230 /** Decodes a frame of audio.
231  @param st Decoder state
232  @param data Compressed data produced by an encoder
233  @param len Number of bytes to read from "data". This MUST be exactly the number
234             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
235  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
236             returned here in 16-bit PCM format (native endian). 
237  @return Error code.
238  */
239 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16_t *pcm);
240
241 /*  @} */
242
243
244 #ifdef __cplusplus
245 }
246 #endif
247
248 #endif /*CELT_H */