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