Preparing for 0.5.0
[opus.git] / libcelt / celt.h
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2 */
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) == (int)0)), (int)(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
75 /** GET the frame size used in the current mode */
76 #define CELT_GET_FRAME_SIZE   1000
77 /** GET the lookahead used in the current mode */
78 #define CELT_GET_LOOKAHEAD    1001
79 /** GET the number of channels used in the current mode */
80 #define CELT_GET_NB_CHANNELS  1002
81
82 /** GET the bit-stream version for compatibility check */
83 #define CELT_GET_BITSTREAM_VERSION 2000
84
85
86 /** Contains the state of an encoder. One encoder state is needed for each 
87     stream. It is initialised once at the beginning of the stream. Do *not*
88     re-initialise the state for every frame.
89    @brief Encoder state
90  */
91 typedef struct CELTEncoder CELTEncoder;
92
93 /** State of the decoder. One decoder state is needed for each stream. It is
94     initialised once at the beginning of the stream. Do *not* re-initialise
95     the state for every frame */
96 typedef struct CELTDecoder CELTDecoder;
97
98 /** The mode contains all the information necessary to create an encoder. Both
99     the encoder and decoder need to be initialised with exactly the same mode,
100     otherwise the quality will be very bad */
101 typedef struct CELTMode CELTMode;
102
103
104 /** \defgroup codec Encoding and decoding */
105 /*  @{ */
106
107 /* Mode calls */
108
109 /** Creates a new mode struct. This will be passed to an encoder or decoder.
110     The mode MUST NOT BE DESTROYED until the encoders and decoders that use it
111     are destroyed as well.
112  @param Fs Sampling rate (32000 to 64000 Hz)
113  @param channels Number of channels
114  @param frame_size Number of samples (per channel) to encode in each packet (64 - 256)
115  @param lookahead Extra latency (in samples per channel) in addition to the frame size (between 32 and frame_size). The larger that value, the better the quality (at the expense of latency)
116  @param error Returned error code (if NULL, no error will be returned)
117  @return A newly created mode
118 */
119 EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
120
121 /** Destroys a mode struct. Only call this after all encoders and decoders
122     using this mode are destroyed as well.
123  @param mode Mode to be destroyed
124 */
125 EXPORT void celt_mode_destroy(CELTMode *mode);
126
127 /** Query information from a mode */
128 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
129
130 /* Encoder stuff */
131
132
133 /** Creates a new encoder state. Each stream needs its own encoder state (can't
134     be shared across simultaneous streams).
135  @param mode Contains all the information about the characteristics of the stream
136              (must be the same characteristics as used for the decoder)
137  @return Newly created encoder state.
138 */
139 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
140
141 /** Destroys a an encoder state.
142  @param st Encoder state to be destroyed
143  */
144 EXPORT void celt_encoder_destroy(CELTEncoder *st);
145
146 /** Encodes a frame of audio.
147  @param st Encoder state
148  @param pcm PCM audio in signed float format. There must be 
149  *          exactly frame_size samples per channel. The input data is 
150  *          overwritten by a copy of what the remote decoder would decode.
151  @param optional_synthesis If not NULL, the encoder copies the audio signal that
152  *                         the decoder would decode. It is the same as calling the
153  *                         decoder on the compressed data, just faster.
154  @param compressed The compressed data is written here
155  @param nbCompressedBytes Number of bytes to use for compressing the frame
156  *                        (can change from one frame to another)
157  @return Number of bytes written to "compressed". Should be the same as 
158  *       "nbCompressedBytes" unless the stream is VBR. If negative, an error
159  *       has occured (see error codes). It is IMPORTANT that the length returned
160  *       be somehow transmitted to the decoder. Otherwise, no decoding is possible.
161 */
162 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
163 /** Encodes a frame of audio.
164  @param st Encoder state
165  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
166  *          exactly frame_size samples per channel. The input data is 
167  *          overwritten by a copy of what the remote decoder would decode.
168  @param optional_synthesis If not NULL, the encoder copies the audio signal that
169  *                         the decoder would decode. It is the same as calling the
170  *                         decoder on the compressed data, just faster.
171  @param compressed The compressed data is written here
172  @param nbCompressedBytes Number of bytes to use for compressing the frame
173  *                        (can change from one frame to another)
174  @return Number of bytes written to "compressed". Should be the same as 
175  *       "nbCompressedBytes" unless the stream is VBR. If negative, an error
176  *       has occured (see error codes). It is IMPORTANT that the length returned
177  *       be somehow transmitted to the decoder. Otherwise, no decoding is possible.
178  */
179 EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
180
181 /** Query and set encoder parameters 
182  @param st Encoder state
183  @param request Parameter to change or query
184  @param value Pointer to a 32-bit int value
185  @return Error code
186 */
187 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
188
189 /* Decoder stuff */
190
191
192 /** Creates a new decoder state. Each stream needs its own decoder state (can't
193     be shared across simultaneous streams).
194  @param mode Contains all the information about the characteristics of the
195              stream (must be the same characteristics as used for the encoder)
196  @return Newly created decoder state.
197  */
198 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
199
200 /** Destroys a a decoder state.
201  @param st Decoder state to be destroyed
202  */
203 EXPORT void celt_decoder_destroy(CELTDecoder *st);
204
205 /** Decodes a frame of audio.
206  @param st Decoder state
207  @param data Compressed data produced by an encoder
208  @param len Number of bytes to read from "data". This MUST be exactly the number
209             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
210  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
211             returned here in float format. 
212  @return Error code.
213    */
214 EXPORT int celt_decode_float(CELTDecoder *st, unsigned char *data, int len, float *pcm);
215 /** Decodes a frame of audio.
216  @param st Decoder state
217  @param data Compressed data produced by an encoder
218  @param len Number of bytes to read from "data". This MUST be exactly the number
219             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
220  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
221             returned here in 16-bit PCM format (native endian). 
222  @return Error code.
223  */
224 EXPORT int celt_decode(CELTDecoder *st, unsigned char *data, int len, celt_int16_t *pcm);
225
226 /*  @} */
227
228
229 #ifdef __cplusplus
230 }
231 #endif
232
233 #endif /*CELT_H */